#include <Notes.h>

Inheritance diagram for Notes:

Collaboration diagram for Notes:

Public Types
typedef RefCount< Notes >	Pointer

typedef std::vector< SBuf >	Keys
	unordered annotation names

typedef std::vector< Note::Pointer >	NotesList

typedef NotesList::iterator	iterator
	iterates over the notes list

typedef NotesList::const_iterator	const_iterator
	iterates over the notes list

Public Member Functions
	Notes (const char aDescr, const Keys extraReservedKeys=nullptr, bool allowFormatted=true)

	Notes ()=default

	~Notes () override

	Notes (const Notes &)=delete

Notes &	operator= (const Notes &)=delete

Note::Pointer	parse (ConfigParser &parser)
	Parses a notes line and returns a pointer to the parsed Note object.

void	parseKvPair ()
	Parses an annotate line with "key=value" or "key+=value" formats.

void	printAsNoteDirectives (StoreEntry , const char directiveName) const
	Prints notes using "note" squid.conf directive format, one directive per stored note.

void	clean ()
	clean the notes list

iterator	begin ()
	points to the first argument

iterator	end ()
	points to the end of list

bool	empty () const

void	printAsAnnotationAclParameters (std::ostream &) const

void	updateNotePairs (NotePairsPointer pairs, const CharacterSet *delimiters, const AccessLogEntryPointer &al)

Private Member Functions
void	banReservedKey (const SBuf &key, const Keys &banned) const
	Makes sure the given key is not on the given list of banned names.

void	validateKey (const SBuf &key) const

Note::Pointer	add (const SBuf &noteKey)

Note::Pointer	find (const SBuf &noteKey)

Static Private Member Functions
static const Notes::Keys &	ReservedKeys ()
	always prohibited key names

Private Attributes
NotesList	notes
	The Note::Pointer objects array list.

const char *	descr = nullptr
	identifies note source in error messages

Keys	reservedKeys
	a list of additional prohibited key names

bool	formattedValues = false
	whether to expand quoted logformat codes

Detailed Description

Used to store a notes configuration list.

Definition at line 113 of file Notes.h.

Member Typedef Documentation

◆ const_iterator

typedef NotesList::const_iterator Notes::const_iterator

Definition at line 120 of file Notes.h.

◆ iterator

typedef NotesList::iterator Notes::iterator

Definition at line 119 of file Notes.h.

◆ Keys

typedef std::vector<SBuf> Notes::Keys

Definition at line 117 of file Notes.h.

◆ NotesList

typedef std::vector<Note::Pointer> Notes::NotesList

Definition at line 118 of file Notes.h.

◆ Pointer

typedef RefCount<Notes> Notes::Pointer

Definition at line 116 of file Notes.h.

Constructor & Destructor Documentation

◆ Notes() [1/3]

Notes::Notes	(	const char *	aDescr,
		const Keys *	extraReservedKeys = `nullptr`,
		bool	allowFormatted = `true`
	)

explicit

Definition at line 158 of file Notes.cc.

References reservedKeys.

◆ Notes() [2/3]

Notes::Notes ( )

default

◆ ~Notes()

Notes::~Notes ( )

inlineoverride

Definition at line 124 of file Notes.h.

References notes.

◆ Notes() [3/3]

Notes::Notes ( const Notes & )

delete

Member Function Documentation

◆ add()

Note::Pointer Notes::add ( const SBuf & noteKey )

private

Adds a note to the notes list and returns a pointer to the related Note object. If the note key already exists in list, returns a pointer to the existing object. If keyLen is not provided, the noteKey is assumed null-terminated.

Definition at line 167 of file Notes.cc.

References find(), and notes.

Referenced by parse(), and parseKvPair().

◆ banReservedKey()

void Notes::banReservedKey	(	const SBuf &	key,
		const Keys &	banned
	)		const

private

Definition at line 185 of file Notes.cc.

References descr, Here, and ToSBuf().

Referenced by validateKey().

◆ begin()

iterator Notes::begin ( )

inline

Definition at line 141 of file Notes.h.

References notes.

◆ clean()

void Notes::clean ( )

inline

Definition at line 138 of file Notes.h.

References notes.

Referenced by free_note().

◆ empty()

bool Notes::empty ( ) const

inline

Returns: true if the notes list is empty

Definition at line 145 of file Notes.h.

References notes.

Referenced by accessLogInit(), ACLAnnotationData::dump(), and ACLAnnotationData::empty().

◆ end()

iterator Notes::end ( )

inline

Definition at line 143 of file Notes.h.

References notes.

◆ find()

Note::Pointer Notes::find ( const SBuf & noteKey )

private

Definition at line 176 of file Notes.cc.

References notes.

Referenced by add(), and parseKvPair().

◆ operator=()

Notes & Notes::operator= ( const Notes & )

delete

◆ parse()

Note::Pointer Notes::parse ( ConfigParser & parser )

Definition at line 210 of file Notes.cc.

References aclParseAclList(), add(), SBuf::append(), SBuf::c_str(), descr, ConfigParser::DisableMacros(), ConfigParser::EnableMacros(), fatalf(), formattedValues, ConfigParser::LastTokenWasQuoted(), ConfigParser::NextQuotedToken(), ConfigParser::NextToken(), and validateKey().

Referenced by parse_note().

◆ parseKvPair()

void Notes::parseKvPair ( )

Definition at line 231 of file Notes.cc.

References add(), assert, DBG_CRITICAL, debugs, descr, fatalf(), find(), formattedValues, ConfigParser::LastTokenWasQuoted(), Note::Value::mhAppend, Note::Value::mhReplace, ConfigParser::NextKvPair(), and validateKey().

Referenced by ACLAnnotationData::parse().

◆ printAsAnnotationAclParameters()

void Notes::printAsAnnotationAclParameters ( std::ostream & os ) const

print notes using "annotate_transaction acl parameters" format, one key=value parameter per note

Definition at line 270 of file Notes.cc.

References notes.

Referenced by ACLAnnotationData::dump().

◆ printAsNoteDirectives()

void Notes::printAsNoteDirectives	(	StoreEntry *	entry,
		const char *	directiveName
	)		const

Definition at line 263 of file Notes.cc.

References notes.

Referenced by dump_note().

◆ ReservedKeys()

const Notes::Keys & Notes::ReservedKeys ( )

staticprivate

Definition at line 137 of file Notes.cc.

References keys.

Referenced by validateKey().

◆ updateNotePairs()

void Notes::updateNotePairs	(	NotePairsPointer	pairs,
		const CharacterSet *	delimiters,
		const AccessLogEntryPointer &	al
	)

Definition at line 256 of file Notes.cc.

References notes.

Referenced by ACLAnnotationData::annotate().

◆ validateKey()

void Notes::validateKey ( const SBuf & key ) const

private

Verifies that the key is not reserved (fatal error) and does not contain special characters (non-fatal error).

Definition at line 192 of file Notes.cc.

References CharacterSet::ALPHA, banReservedKey(), DBG_CRITICAL, debugs, CharacterSet::DIGIT, SBuf::findFirstNotOf(), SBuf::npos, reservedKeys, and ReservedKeys().

Referenced by parse(), and parseKvPair().

Member Data Documentation

◆ descr

const char* Notes::descr = nullptr

private

Definition at line 169 of file Notes.h.

Referenced by banReservedKey(), parse(), and parseKvPair().

◆ formattedValues

bool Notes::formattedValues = false

private

Definition at line 172 of file Notes.h.

Referenced by parse(), and parseKvPair().

◆ notes

NotesList Notes::notes

private

Definition at line 168 of file Notes.h.

Referenced by ~Notes(), add(), begin(), clean(), empty(), end(), find(), printAsAnnotationAclParameters(), printAsNoteDirectives(), and updateNotePairs().

◆ reservedKeys

Keys Notes::reservedKeys

private

Definition at line 171 of file Notes.h.

Referenced by Notes(), and validateKey().

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

squid/src/Notes.h
squid/src/Notes.cc

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ Keys

◆ NotesList

◆ Pointer

Constructor & Destructor Documentation

◆ Notes() [1/3]

◆ Notes() [2/3]

◆ ~Notes()

◆ Notes() [3/3]

Member Function Documentation

◆ add()

◆ banReservedKey()

◆ begin()

◆ clean()

◆ empty()

◆ end()

◆ find()

◆ operator=()

◆ parse()

◆ parseKvPair()

◆ printAsAnnotationAclParameters()

◆ printAsNoteDirectives()

◆ ReservedKeys()

◆ updateNotePairs()

◆ validateKey()

Member Data Documentation

◆ descr

◆ formattedValues

◆ notes

◆ reservedKeys