ErrorDetailManager.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_SRC_SSL_ERRORDETAILMANAGER_H
#define SQUID_SRC_SSL_ERRORDETAILMANAGER_H
 
#include "base/RefCount.h"
#include "HttpRequest.h"
#include "sbuf/SBuf.h"
#include "ssl/support.h"
 
#include <map>
 
class HttpRequest;
 
namespace Ssl
{
 
class ErrorDetailEntry
{
public:
    ErrorDetailEntry(const SBuf &aName, const HttpHeader &);
 
    SBuf name; 
    SBuf detail; 
    SBuf descr; 
};
 
class ErrorDetailsList : public RefCountable
{
public:
    typedef RefCount<ErrorDetailsList> Pointer;
 
    const ErrorDetailEntry *findRecord(Security::ErrorCode) const;
 
    SBuf errLanguage; 
    typedef std::map<Security::ErrorCode, ErrorDetailEntry> ErrorDetails;
    ErrorDetails theList; 
};
 
class ErrorDetailsManager
{
public:
    ErrorDetailsManager();
 
    static ErrorDetailsManager &GetInstance(); 
    static void Shutdown(); 
 
    const ErrorDetailEntry *findDetail(Security::ErrorCode value, const HttpRequest::Pointer &request) const;
 
    const ErrorDetailEntry *findDefaultDetail(Security::ErrorCode) const;
 
private:
    ErrorDetailsList::Pointer getCachedDetails(const char *lang) const;
    void cacheDetails(const ErrorDetailsList::Pointer &errorDetails) const;
 
    using Cache = std::map<SBuf, ErrorDetailsList::Pointer>;
    mutable Cache cache; 
    ErrorDetailsList::Pointer theDefaultErrorDetails; 
 
    static ErrorDetailsManager *TheDetailsManager;
};
 
void errorDetailInitialize();
void errorDetailClean();
} //namespace Ssl
#endif /* SQUID_SRC_SSL_ERRORDETAILMANAGER_H */