Node.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_ACL_NODE_H
#define SQUID_SRC_ACL_NODE_H
 
#include "acl/forward.h"
#include "acl/Options.h"
#include "dlink.h"
#include "sbuf/SBuf.h"
 
class ConfigParser;
 
namespace Acl {
 
class Node: public RefCountable
{
 
public:
    using Pointer = RefCount<Node>;
 
    void *operator new(size_t);
    void operator delete(void *);
 
    static void ParseNamedAcl(ConfigParser &, NamedAcls *&);
 
    static void Initialize();
 
    static Acl::Node *FindByName(const SBuf &);
 
    Node();
    Node(Node &&) = delete;  // no copying of any kind
    virtual ~Node();
 
    void context(const SBuf &aName, const char *configuration);
 
    bool matches(ACLChecklist *checklist) const;
 
    void parseFlags();
 
    virtual void parse() = 0;
    virtual char const *typeString() const = 0;
    virtual bool isProxyAuth() const;
    virtual SBufList dump() const = 0;
    virtual bool empty() const = 0;
    virtual bool valid() const;
 
    int cacheMatchAcl(dlink_list *cache, ACLChecklist *);
    virtual int matchForCache(ACLChecklist *checklist);
 
    virtual void prepareForUse() {}
 
    // TODO: Find a way to make options() and this method constant
    void dumpWhole(const char *directiveName, std::ostream &);
 
    SBuf name;
 
    char *cfgline = nullptr;
 
private:
    virtual int match(ACLChecklist *checklist) = 0;  // XXX: missing const
 
    virtual bool requiresAle() const;
    virtual bool requiresRequest() const;
    virtual bool requiresReply() const;
 
    // TODO: Rename to globalOptions(); these are not the only supported options
    virtual const Acl::Options &options() { return Acl::NoOptions(); }
 
    virtual const Acl::Options &lineOptions() { return Acl::NoOptions(); }
 
    static void ParseNamed(ConfigParser &, NamedAcls &, const SBuf &name);
};
 
} // namespace Acl
 
#endif /* SQUID_SRC_ACL_NODE_H */