AccessCheck.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_ADAPTATION_ACCESSCHECK_H
#define SQUID_SRC_ADAPTATION_ACCESSCHECK_H
 
#include "acl/Acl.h"
#include "adaptation/Elements.h"
#include "adaptation/forward.h"
#include "adaptation/Initiator.h"
#include "adaptation/ServiceFilter.h"
#include "base/AsyncJob.h"
#include "log/forward.h"
 
class HttpRequest;
class HttpReply;
class ACLFilledChecklist;
 
namespace Adaptation
{
 
class AccessRule;
 
// checks adaptation_access rules to find a matching adaptation service
class AccessCheck: public virtual AsyncJob
{
    CBDATA_CHILD(AccessCheck);
 
public:
    typedef void AccessCheckCallback(ServiceGroupPointer group, void *data);
 
    // use this to start async ACL checks; returns true if started
    static bool Start(Method method, VectPoint vp, HttpRequest *req,
                      HttpReply *, const AccessLogEntryPointer &, Adaptation::Initiator *);
 
protected:
    // use Start to start adaptation checks
    AccessCheck(const ServiceFilter &aFilter, Adaptation::Initiator *);
    ~AccessCheck() override;
 
private:
    const ServiceFilter filter;
    CbcPointer<Adaptation::Initiator> theInitiator; 
 
    typedef int Candidate;
    typedef std::vector<Candidate> Candidates;
    Candidates candidates;
    Candidate topCandidate() const { return *candidates.begin(); }
    ServiceGroupPointer topGroup() const; // may return nil
 
    void callBack(const ServiceGroupPointer &g);
    bool isCandidate(AccessRule &r);
 
public:
    void checkCandidates();
    static void AccessCheckCallbackWrapper(Acl::Answer, void*);
    void noteAnswer(Acl::Answer answer);
 
protected:
    // AsyncJob API
    void start() override;
    bool doneAll() const override { return false; } 
 
    bool usedDynamicRules();
    void check();
};
 
} // namespace Adaptation
 
#endif /* SQUID_SRC_ADAPTATION_ACCESSCHECK_H */