src/ExternalACL.h

   1 /*
   2  * $Id: ExternalACL.h,v 1.10 2008/02/26 21:49:34 amosjeffries Exp $
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  *
  32  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34 #ifndef SQUID_EXTERNALACL_H
  35 #define SQUID_EXTERNALACL_H
  36
  37 #include "ACLChecklist.h"
  38
  39 class external_acl;
  40
  41 class ExternalACLLookup : public ACLChecklist::AsyncState
  42 {
  43
  44 public:
  45     static ExternalACLLookup *Instance();
  46     virtual void checkForAsync(ACLChecklist *)const;
  47
  48 private:
  49     static ExternalACLLookup instance_;
  50     static void LookupDone(void *data, void *result);
  51 };
  52
  53 /** \todo CLEANUP: kill this typedef. */
  54 typedef struct _external_acl_data external_acl_data;
  55
  56 #include "ACL.h"
  57
  58 class ACLExternal : public ACL
  59 {
  60
  61 public:
  62     MEMPROXY_CLASS(ACLExternal);
  63
  64     static void ExternalAclLookup(ACLChecklist * ch, ACLExternal *, EAH * callback, void *callback_data);
  65
  66
  67     ACLExternal(char const *);
  68     ACLExternal(ACLExternal const &);
  69     ~ACLExternal();
  70     ACLExternal&operator=(ACLExternal const &);
  71
  72     virtual ACL *clone()const;
  73     virtual char const *typeString() const;
  74     virtual void parse();
  75     virtual int match(ACLChecklist *checklist);
  76     /* This really should be dynamic based on the external class defn */
  77     virtual bool requiresRequest() const {return true;}
  78
  79     /* when requiresRequest is made dynamic, review this too */
  80     //    virtual bool requiresReply() const {return true;}
  81     virtual bool isProxyAuth() const;
  82     virtual wordlist *dump() const;
  83     virtual bool valid () const;
  84     virtual bool empty () const;
  85
  86 protected:
  87     static Prototype RegistryProtoype;
  88     static ACLExternal RegistryEntry_;
  89     external_acl_data *data;
  90     char const *class_;
  91 };
  92
  93 MEMPROXY_CLASS_INLINE(ACLExternal);
  94
  95 #endif /* SQUID_EXTERNALACL_H */