ErrorDetailManager.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef _SQUID_SSL_ERRORDETAILMANAGER_H
#define _SQUID_SSL_ERRORDETAILMANAGER_H
 
#include "base/RefCount.h"
#include "HttpRequest.h"
#include "SquidString.h"
#include "ssl/support.h"
 
#include <map>
#include <string>
 
class HttpRequest;
 
namespace Ssl
{
 
class ErrorDetailEntry
{
public:
    Security::ErrorCode error_no = 0; 
    String name; 
    String detail; 
    String descr;  
};
 
class ErrorDetailsList : public RefCountable
{
public:
    typedef RefCount<ErrorDetailsList> Pointer;
    bool getRecord(Security::ErrorCode value, ErrorDetailEntry &entry);
    const char *getErrorDescr(Security::ErrorCode value); 
    const char *getErrorDetail(Security::ErrorCode value); 
 
    String errLanguage; 
    typedef std::map<Security::ErrorCode, ErrorDetailEntry> ErrorDetails;
    ErrorDetails theList; 
};
 
class ErrorDetailsManager
{
public:
    ErrorDetailsManager();
 
    static ErrorDetailsManager &GetInstance(); 
    static void Shutdown(); 
 
    bool getErrorDetail(Security::ErrorCode value, const HttpRequest::Pointer &request, ErrorDetailEntry &entry);
    const char *getDefaultErrorDescr(Security::ErrorCode value); 
    const char *getDefaultErrorDetail(Security::ErrorCode value); 
 
private:
    ErrorDetailsList::Pointer getCachedDetails(const char *lang);
    void cacheDetails(ErrorDetailsList::Pointer &errorDetails);
 
    typedef std::map<std::string, ErrorDetailsList::Pointer> Cache;
    Cache cache; 
    ErrorDetailsList::Pointer theDefaultErrorDetails; 
 
    static ErrorDetailsManager *TheDetailsManager;
};
 
void errorDetailInitialize();
void errorDetailClean();
} //namespace Ssl
#endif