manages error detail templates More...

Inheritance diagram for Ssl::ErrorDetailFile:

Collaboration diagram for Ssl::ErrorDetailFile:

[legend]

Public Member Functions
	ErrorDetailFile (ErrorDetailsList::Pointer const details)

bool	loaded () const
	return true if the data loaded from disk without any problem More...

void	loadDefault ()

bool	loadFor (const HttpRequest *request)

bool	loadFromFile (const char *path)

const char *	language ()
	The language used for the template. More...

Public Attributes
SBuf	filename
	where the template was loaded from More...

bool	silent
	Whether to print error messages on cache.log file or not. It is user defined. More...

Protected Member Functions
virtual void	setDefault ()
	recover from loadDefault() failure to load or parse() a template More...

bool	tryLoadTemplate (const char *lang)

Protected Attributes
SBuf	template_
	raw template contents More...

bool	wasLoaded
	True if the template data read from disk without any problem. More...

String	errLanguage
	The error language of the template. More...

String	templateName
	The name of the template. More...

err_type	templateCode
	The internal code for this template. More...

Private Member Functions
bool	parse () override
	post-process the loaded template More...

Private Attributes
ErrorDetailsList::Pointer	theDetails

Detailed Description

Definition at line 52 of file ErrorDetailManager.cc.

Constructor & Destructor Documentation

◆ ErrorDetailFile()

Ssl::ErrorDetailFile::ErrorDetailFile ( ErrorDetailsList::Pointer const details )

inlineexplicit

Definition at line 55 of file ErrorDetailManager.cc.

References theDetails.

Member Function Documentation

◆ language()

const char * TemplateFile::language ( )

inlineinherited

Definition at line 313 of file errorpage.h.

References TemplateFile::errLanguage, and String::termedBuf().

Referenced by ErrorState::buildBody(), and Ssl::ErrorDetailsManager::findDetail().

◆ loadDefault()

void TemplateFile::loadDefault ( )

inherited

Load the page_name template from a file which probably exist at: (a) admin specified custom directory (error_directory) (b) default language translation directory (error_default_language) (c) English sub-directory where errors should ALWAYS exist If all of the above fail, setDefault() is called.

test error_directory configured location

test error_default_language location

Definition at line 356 of file errorpage.cc.

References Config, DBG_CRITICAL, debugs, SquidConfig::errorDefaultLanguage, SquidConfig::errorDirectory, TemplateFile::loaded(), TemplateFile::loadFromFile(), MAXPATHLEN, TemplateFile::setDefault(), TCP_RESET, TemplateFile::templateCode, TemplateFile::templateName, String::termedBuf(), TemplateFile::tryLoadTemplate(), and TemplateFile::wasLoaded.

Referenced by Ssl::ErrorDetailsManager::ErrorDetailsManager().

◆ loaded()

bool TemplateFile::loaded ( ) const

inlineinherited

Definition at line 287 of file errorpage.h.

References TemplateFile::wasLoaded.

Referenced by TemplateFile::loadDefault(), TemplateFile::loadFor(), and TemplateFile::loadFromFile().

◆ loadFor()

bool TemplateFile::loadFor ( const HttpRequest * request )

inherited

Load an error template for a given HTTP request. This function examines the Accept-Language header and select the first available template. If the default template selected (eg because of a "Accept-Language: *"), or not available template found this function return false.

Definition at line 519 of file errorpage.cc.

References Http::ACCEPT_LANGUAGE, Config, DBG_IMPORTANT, debugs, TemplateFile::errLanguage, SquidConfig::errorLogMissingLanguages, HttpHeader::getList(), Http::Message::header, TemplateFile::loaded(), strHdrAcptLangGetItem(), and TemplateFile::tryLoadTemplate().