#include <Tree.h>

Inheritance diagram for Acl::Tree:

Collaboration diagram for Acl::Tree:

Public Types
using	Pointer = RefCount< Node >

Public Member Functions
template<class ActionToStringConverter >
SBufList	treeDump (const char *name, ActionToStringConverter converter) const

Answer	winningAction () const
	Returns the corresponding action after a successful tree match.

Answer	lastAction () const
	what action to use if no nodes matched

void	add (Acl::Node *rule, const Answer &action)
	appends and takes control over the rule with a given action

void	add (Acl::Node *rule)
	same as InnerNode::add()

char const *	typeString () const override

void	parse () override
	parses node representation in squid.conf; dies on failures

bool	resumeMatchingAt (ACLChecklist *checklist, Acl::Nodes::const_iterator pos) const
	Resumes matching (suspended by an async call) at the given position.

Nodes::size_type	childrenCount () const
	the number of children nodes

void	prepareForUse () override

bool	empty () const override

SBufList	dump () const override

size_t	lineParse ()

void *	operator new (size_t)

void	operator delete (void *)

void	context (const SBuf &aName, const char *configuration)
	sets user-specified ACL name and squid.conf context

bool	matches (ACLChecklist *checklist) const

void	parseFlags ()
	configures Acl::Node options, throwing on configuration errors

virtual bool	isProxyAuth () const

virtual bool	valid () const

int	cacheMatchAcl (dlink_list cache, ACLChecklist )

virtual int	matchForCache (ACLChecklist *checklist)

void	dumpWhole (const char *directiveName, std::ostream &)

Static Public Member Functions
static void	ParseNamedAcl (ConfigParser &, NamedAcls *&)
	parses acl directive parts that follow directive name (i.e. "acl")

static void	Initialize ()

static Acl::Node *	FindByName (const SBuf &)
	A configured ACL with a given name or nil.

Public Attributes
SBuf	name

char *	cfgline = nullptr

Protected Types
typedef std::vector< Answer >	Actions
	if not empty, contains actions corresponding to InnerNode::nodes

Protected Member Functions
bool	bannedAction (ACLChecklist *, Nodes::const_iterator) const override
	Acl::OrNode API.

Answer	actionAt (const Nodes::size_type pos) const
	computes action that corresponds to the position of the matched rule

int	match (ACLChecklist *checklist) override
	Matches the actual data in checklist against this Acl::Node.

Protected Attributes
Actions	actions

Nodes::const_iterator	lastMatch_

Nodes	nodes
	children of this intermediate node

Private Member Functions
	MEMPROXY_CLASS (Tree)

int	doMatch (ACLChecklist *checklist, Nodes::const_iterator start) const override

virtual bool	requiresAle () const
	whether our (i.e. shallow) match() requires checklist to have a AccessLogEntry

virtual bool	requiresRequest () const
	whether our (i.e. shallow) match() requires checklist to have a request

virtual bool	requiresReply () const
	whether our (i.e. shallow) match() requires checklist to have a reply

virtual const Acl::Options &	options ()

virtual const Acl::Options &	lineOptions ()

Static Private Member Functions
static void	ParseNamed (ConfigParser &, NamedAcls &, const SBuf &name)
	parses acl directive parts that follow aclname

Detailed Description

An ORed set of rules at the top of the ACL expression tree with support for optional rule actions.

Definition at line 22 of file Tree.h.

Member Typedef Documentation

◆ Actions

typedef std::vector<Answer> Acl::Tree::Actions

protected

Definition at line 48 of file Tree.h.

◆ Pointer

using Acl::Node::Pointer = RefCount<Node>

inherited

Definition at line 29 of file Node.h.

Member Function Documentation

◆ actionAt()

Acl::Answer Acl::Tree::actionAt ( const Nodes::size_type pos ) const

protected

Definition at line 30 of file Tree.cc.

References ACCESS_ALLOWED, and assert.

Referenced by winningAction().

◆ add() [1/2]

void Acl::Tree::add ( Acl::Node * rule )

Definition at line 51 of file Tree.cc.

References Acl::InnerNode::add(), and assert.

◆ add() [2/2]

void Acl::Tree::add	(	Acl::Node *	rule,
		const Answer &	action
	)

Definition at line 42 of file Tree.cc.

References Acl::InnerNode::add(), and assert.

Referenced by aclParseAclList().

◆ bannedAction()

bool Acl::Tree::bannedAction	(	ACLChecklist *	checklist,
		Nodes::const_iterator	node
	)		const

overrideprotectedvirtual

Reimplemented from Acl::OrNode.

Definition at line 59 of file Tree.cc.

References assert, and ACLChecklist::bannedAction().

◆ cacheMatchAcl()

int Acl::Node::cacheMatchAcl	(	dlink_list *	cache,
		ACLChecklist *	checklist
	)

inherited

Definition at line 401 of file Acl.cc.

References acl_proxy_auth_match_cache::acl_data, dlink_node::data, debugs, dlinkAddTail(), dlink_list::head, acl_proxy_auth_match_cache::link, acl_proxy_auth_match_cache::matchrv, and dlink_node::next.

Referenced by ACLProxyAuth::matchProxyAuth().

◆ childrenCount()

Nodes::size_type Acl::InnerNode::childrenCount ( ) const

inlineinherited

Definition at line 29 of file InnerNode.h.

References Acl::InnerNode::nodes.

Referenced by aclParseAccessLine(), and Acl::AllOf::parse().

◆ context()

void Acl::Node::context	(	const SBuf &	aName,
		const char *	configuration
	)

inherited

Definition at line 220 of file Acl.cc.

References safe_free, and xstrdup.

Referenced by aclParseAccessLine(), aclParseAclList(), Acl::AllOf::parse(), and ParseAclWithAction().

◆ doMatch()

int Acl::OrNode::doMatch	(	ACLChecklist *	checklist,
		Nodes::const_iterator	start
	)		const

overrideprivatevirtualinherited

checks whether the nodes match, starting with the given one kids determine what a match means for their type of intermediate nodes

Implements Acl::InnerNode.

Definition at line 105 of file BoolOps.cc.

References ACLChecklist::keepMatching(), and ACLChecklist::matchChild().

◆ dump()

SBufList Acl::InnerNode::dump ( ) const

overridevirtualinherited

Implements Acl::Node.

Reimplemented in Acl::NotNode.

Definition at line 81 of file InnerNode.cc.

◆ dumpWhole()

void Acl::Node::dumpWhole	(	const char *	directiveName,
		std::ostream &	os
	)

inherited

Prints aggregated "acl" (or similar) directive configuration, including the given directive name, ACL name, ACL type, and ACL parameters. The printed parameters are collected from all same-name "acl" directives.

Definition at line 371 of file Acl.cc.

References asList().

◆ empty()

bool Acl::InnerNode::empty ( ) const

overridevirtualinherited

Implements Acl::Node.

Definition at line 30 of file InnerNode.cc.

Referenced by aclParseAccessLine().

◆ FindByName()

Acl::Node * Acl::Node::FindByName ( const SBuf & name )

staticinherited

Definition at line 159 of file Acl.cc.

References assert, Config, debugs, and SquidConfig::namedAcls.

Referenced by aclIsProxyAuth(), Acl::InnerNode::lineParse(), parse_ftp_epsv(), and TestACLMaxUserIP::testParseLine().

◆ Initialize()

void Acl::Node::Initialize ( )

staticinherited

Definition at line 471 of file Acl.cc.

References Config, debugs, and SquidConfig::namedAcls.

Referenced by serverConnectionsOpen().

◆ isProxyAuth()

bool Acl::Node::isProxyAuth ( ) const

virtualinherited

Reimplemented in ACLProxyAuth, and ACLExternal.

Definition at line 354 of file Acl.cc.

◆ lastAction()

Acl::Answer Acl::Tree::lastAction ( ) const

Definition at line 21 of file Tree.cc.

References ACCESS_DUNNO.

Referenced by ACLChecklist::calcImplicitAnswer().

◆ lineOptions()

virtual const Acl::Options & Acl::Node::lineOptions ( )

inlineprivatevirtualinherited

Returns: (linked) "line" Options supported by this Acl::Node

See also: Acl::Node::options()

Definition at line 102 of file Node.h.

References Acl::NoOptions().

◆ lineParse()

size_t Acl::InnerNode::lineParse ( )

inherited

parses a [ [!]acl1 [!]acl2... ] sequence, appending to nodes

Returns: the number of parsed ACL names

Definition at line 44 of file InnerNode.cc.

References config_input_line, DBG_CRITICAL, debugs, Acl::Node::FindByName(), self_destruct(), ConfigParser::strtokFile(), and xstrdup.

Referenced by aclParseAccessLine(), aclParseAclList(), Acl::AllOf::parse(), and ParseAclWithAction().

◆ match()

int Acl::InnerNode::match ( ACLChecklist * checklist )

overrideprotectedvirtualinherited

Implements Acl::Node.

Definition at line 90 of file InnerNode.cc.

◆ matches()

bool Acl::Node::matches ( ACLChecklist * checklist ) const

inherited

Orchestrates matching checklist against the Acl::Node using match(), after checking preconditions and while providing debugging.

Returns: true if and only if there was a successful match. Updates the checklist state on match, async, and failure.

Definition at line 189 of file Acl.cc.

References ACLChecklist::asyncInProgress(), DBG_IMPORTANT, debugs, ACLChecklist::hasAle(), ACLChecklist::hasReply(), ACLChecklist::hasRequest(), ACLChecklist::setLastCheckedName(), and ACLChecklist::verifyAle().

Referenced by ACLChecklist::matchAndFinish().

◆ matchForCache()

int Acl::Node::matchForCache ( ACLChecklist * checklist )

virtualinherited

Reimplemented in ACLProxyAuth.

Definition at line 383 of file Acl.cc.

References fatal().

◆ MEMPROXY_CLASS()

Acl::Tree::MEMPROXY_CLASS ( Tree )

private

◆ operator delete()

void Acl::Node::operator delete ( void * )

inherited

Definition at line 153 of file Acl.cc.

References fatal().

◆ operator new()

void * Acl::Node::operator new ( size_t )

inherited

Definition at line 147 of file Acl.cc.

References fatal().

◆ options()

virtual const Acl::Options & Acl::Node::options ( )

inlineprivatevirtualinherited

Returns: (linked) 'global' Options supported by this Acl::Node

Reimplemented in Acl::DestinationDomainCheck, ACLDestinationIP, Acl::AnnotationCheck, Acl::ServerNameCheck, and ACLMaxUserIP.

Definition at line 98 of file Node.h.

References Acl::NoOptions().

◆ parse()

void Acl::OrNode::parse ( )

overridevirtualinherited

Implements Acl::Node.

Definition at line 127 of file BoolOps.cc.

References assert.

◆ parseFlags()

void Acl::Node::parseFlags ( )

inherited

Definition at line 360 of file Acl.cc.

References Acl::ParseFlags().

◆ ParseNamed()

void Acl::Node::ParseNamed	(	ConfigParser &	parser,
		NamedAcls &	namedAcls,
		const SBuf &	name
	)

staticprivateinherited

Definition at line 253 of file Acl.cc.

References Assure, SBuf::cmp(), config_input_line, DBG_CRITICAL, DBG_IMPORTANT, DBG_PARSE_NOTE, debugs, ConfigParser::destruct(), fatalf(), HttpPortList, Acl::Make(), and ConfigParser::NextToken().

◆ ParseNamedAcl()

void Acl::Node::ParseNamedAcl	(	ConfigParser &	parser,
		NamedAcls *&	namedAcls
	)

staticinherited

Definition at line 229 of file Acl.cc.

References CallParser(), DBG_CRITICAL, debugs, ConfigParser::destruct(), RefCount< C >::Make(), and ConfigParser::NextToken().

Referenced by parse_acl(), and TestACLMaxUserIP::testParseLine().

◆ prepareForUse()

void Acl::InnerNode::prepareForUse ( )

overridevirtualinherited

Reimplemented from Acl::Node.

Definition at line 23 of file InnerNode.cc.

References Acl::InnerNode::nodes.

◆ requiresAle()

bool Acl::Node::requiresAle ( ) const

privatevirtualinherited

Reimplemented in ACLExternal.

Definition at line 443 of file Acl.cc.

◆ requiresReply()

bool Acl::Node::requiresReply ( ) const

privatevirtualinherited

Reimplemented in Acl::HttpRepHeaderCheck, ACLHTTPStatus, and Acl::ReplyHeaderCheck< header >.

Definition at line 449 of file Acl.cc.

◆ requiresRequest()

bool Acl::Node::requiresRequest ( ) const

privatevirtualinherited

Reimplemented in Acl::DestinationDomainCheck, ACLExtUser, Acl::HierCodeCheck, Acl::HttpReqHeaderCheck, Acl::MethodCheck, Acl::NoteCheck, Acl::ProtocolCheck, Acl::RequestHeaderCheck< header >, Acl::ServerNameCheck, Acl::TransactionInitiator, Acl::UrlCheck, Acl::UrlLoginCheck, Acl::UrlPathCheck, Acl::UrlPortCheck, ACLMaxUserIP, ACLProxyAuth, and ACLExternal.

Definition at line 455 of file Acl.cc.

◆ resumeMatchingAt()

bool Acl::InnerNode::resumeMatchingAt	(	ACLChecklist *	checklist,
		Acl::Nodes::const_iterator	pos
	)		const

inherited

Definition at line 96 of file InnerNode.cc.

References ACLChecklist::asyncInProgress(), and debugs.

Referenced by ACLChecklist::matchAndFinish(), and ACLChecklist::matchChild().

◆ treeDump()

template<class ActionToStringConverter >

SBufList Acl::Tree::treeDump	(	const char *	name,
		ActionToStringConverter	converter
	)		const

inline

dumps <name, action, rule, new line> tuples the supplied converter maps action.kind to a string

Definition at line 60 of file Tree.h.

References actions, SBuf::begin(), SBuf::end(), Acl::InnerNode::nodes, SBuf::push_back(), and text.

Referenced by Security::KeyLog::dump(), dump_http_upgrade_request_protocols(), dump_on_unsupported_protocol(), and Note::printAsNoteDirective().

◆ typeString()

char const * Acl::OrNode::typeString ( ) const

overridevirtualinherited

Implements Acl::Node.

Definition at line 93 of file BoolOps.cc.

◆ valid()

bool Acl::Node::valid ( ) const

virtualinherited

Reimplemented in ACLMaxConnection, ACLRandom, Acl::ServerNameCheck, ACLMaxUserIP, ACLProxyAuth, and ACLExternal.

Definition at line 183 of file Acl.cc.

◆ winningAction()

Acl::Answer Acl::Tree::winningAction ( ) const

Definition at line 15 of file Tree.cc.

References actionAt(), Acl::OrNode::lastMatch_, and Acl::InnerNode::nodes.

Referenced by ACLChecklist::matchAndFinish().

Member Data Documentation

◆ actions

Actions Acl::Tree::actions

protected

Definition at line 49 of file Tree.h.

Referenced by treeDump().

◆ cfgline

char* Acl::Node::cfgline = nullptr

inherited

Definition at line 83 of file Node.h.

◆ lastMatch_

Nodes::const_iterator Acl::OrNode::lastMatch_

mutableprotectedinherited

Definition at line 72 of file BoolOps.h.

Referenced by winningAction().

◆ name

SBuf Acl::Node::name

inherited

Either aclname parameter from the explicitly configured acl directive or a label generated for an internal ACL tree node. All Node objects corresponding to one Squid configuration have unique names. See also: context() and FindByName().

Definition at line 81 of file Node.h.

Referenced by Acl::NotNode::NotNode(), aclDestroyAccessList(), Acl::AnnotateClientCheck::match(), Acl::AnnotateTransactionCheck::match(), Acl::SourceDomainCheck::match(), ACLDestinationIP::match(), ACLRandom::match(), ACLExternal::parse(), and ACLMaxConnection::prepareForUse().

◆ nodes

Nodes Acl::InnerNode::nodes

protectedinherited

Definition at line 51 of file InnerNode.h.

Referenced by Acl::InnerNode::childrenCount(), Acl::InnerNode::prepareForUse(), treeDump(), and winningAction().

The documentation for this class was generated from the following files:

squid/src/acl/Tree.h
squid/src/acl/Tree.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Actions

◆ Pointer

Member Function Documentation

◆ actionAt()

◆ add() [1/2]

◆ add() [2/2]

◆ bannedAction()

◆ cacheMatchAcl()

◆ childrenCount()

◆ context()

◆ doMatch()

◆ dump()

◆ dumpWhole()

◆ empty()

◆ FindByName()

◆ Initialize()

◆ isProxyAuth()

◆ lastAction()

◆ lineOptions()

◆ lineParse()

◆ match()

◆ matches()

◆ matchForCache()

◆ MEMPROXY_CLASS()

◆ operator delete()

◆ operator new()

◆ options()

◆ parse()

◆ parseFlags()

◆ ParseNamed()

◆ ParseNamedAcl()

◆ prepareForUse()

◆ requiresAle()

◆ requiresReply()

◆ requiresRequest()

◆ resumeMatchingAt()

◆ treeDump()

◆ typeString()

◆ valid()

◆ winningAction()

Member Data Documentation

◆ actions

◆ cfgline

◆ lastMatch_

◆ name

◆ nodes