src/ExternalACL.h

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