manages error detail templates More...

Inheritance diagram for Ssl::ErrorDetailFile:
Collaboration diagram for Ssl::ErrorDetailFile:

Public Member Functions

 ErrorDetailFile (ErrorDetailsList::Pointer const details)
bool loaded () const
 return true if the data loaded from disk without any problem More...
bool loadDefault ()
bool loadFor (const HttpRequest *request)
bool loadFromFile (const char *path)
const char * language ()
 The language used for the template. More...

Public Attributes

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

Protected Member Functions

bool tryLoadTemplate (const char *lang)

Protected Attributes

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

virtual bool parse (const char *buf, int len, bool eof)
 Used to parse (if parsing required) the template data . More...

Private Attributes

MemBuf buf
ErrorDetailsList::Pointer theDetails

Detailed Description

Definition at line 30 of file

Constructor & Destructor Documentation

◆ ErrorDetailFile()

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

Definition at line 33 of file

References buf, MemBuf::init(), and theDetails.

Member Function Documentation

◆ language()

const char* TemplateFile::language ( )

◆ loadDefault()

bool TemplateFile::loadDefault ( )

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

test error_directory configured location

test error_default_language location

Definition at line 257 of file

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

Referenced by Ssl::ErrorDetailsManager::ErrorDetailsManager(), and errorInitialize().

◆ loaded()

bool TemplateFile::loaded ( ) const

◆ loadFor()

bool TemplateFile::loadFor ( const HttpRequest request)

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 414 of file

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

Referenced by ErrorState::BuildContent(), and Ssl::ErrorDetailsManager::getErrorDetail().

◆ loadFromFile()

bool TemplateFile::loadFromFile ( const char *  path)

Load the file given by "path". It uses the "parse()" method. On success return true and sets the "defined" member

Definition at line 319 of file

References buf, DBG_CRITICAL, debugs, FD_READ_METHOD, file_close(), file_open(), len, TemplateFile::loaded(), MYNAME, O_TEXT, TemplateFile::parse(), TemplateFile::silent, TCP_RESET, TemplateFile::templateCode, TemplateFile::wasLoaded, and xstrerr().

Referenced by errorInitialize(), TemplateFile::loadDefault(), and TemplateFile::tryLoadTemplate().

◆ parse()

◆ tryLoadTemplate()

bool TemplateFile::tryLoadTemplate ( const char *  lang)

Try to load the "page_name" template for a given language "lang" from squid errors directory

true on success false otherwise

Definition at line 294 of file

References assert, debugs, DEFAULT_SQUID_ERROR_DIR, HERE(), TemplateFile::loadFromFile(), MAXPATHLEN, TemplateFile::templateName, and String::termedBuf().

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

Member Data Documentation

◆ buf

MemBuf Ssl::ErrorDetailFile::buf

Definition at line 39 of file

Referenced by ErrorDetailFile(), and parse().

◆ errLanguage

String TemplateFile::errLanguage

Definition at line 291 of file errorpage.h.

Referenced by TemplateFile::loadFor().

◆ silent

bool TemplateFile::silent

Definition at line 277 of file errorpage.h.

Referenced by TemplateFile::loadFromFile().

◆ templateCode

err_type TemplateFile::templateCode

Definition at line 293 of file errorpage.h.

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

◆ templateName

String TemplateFile::templateName

Definition at line 292 of file errorpage.h.

Referenced by TemplateFile::loadDefault(), and TemplateFile::tryLoadTemplate().

◆ theDetails

ErrorDetailsList::Pointer Ssl::ErrorDetailFile::theDetails

Definition at line 40 of file

Referenced by ErrorDetailFile(), and parse().

◆ wasLoaded

bool TemplateFile::wasLoaded

Definition at line 290 of file errorpage.h.

Referenced by TemplateFile::loadFromFile().

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






Web Site Translations