cgiedit.h

   1 #ifndef CGIEDIT_H_INCLUDED
   2 #define CGIEDIT_H_INCLUDED
   3 #define CGIEDIT_H_VERSION "$Id: cgiedit.h,v 1.6 2002/03/24 13:25:43 swa Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/cgiedit.h,v $
   7  *
   8  * Purpose     :  CGI-based actionsfile editor.
   9  *
  10  *                Functions declared include:
  11  *
  12  *
  13  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  14  *                Privoxy team. http://www.privoxy.org/
  15  *
  16  *                Based on the Internet Junkbuster originally written
  17  *                by and Copyright (C) 1997 Anonymous Coders and
  18  *                Junkbusters Corporation.  http://www.junkbusters.com
  19  *
  20  *                This program is free software; you can redistribute it
  21  *                and/or modify it under the terms of the GNU General
  22  *                Public License as published by the Free Software
  23  *                Foundation; either version 2 of the License, or (at
  24  *                your option) any later version.
  25  *
  26  *                This program is distributed in the hope that it will
  27  *                be useful, but WITHOUT ANY WARRANTY; without even the
  28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  29  *                PARTICULAR PURPOSE.  See the GNU General Public
  30  *                License for more details.
  31  *
  32  *                The GNU General Public License should be included with
  33  *                this file.  If not, you can view it at
  34  *                http://www.gnu.org/copyleft/gpl.html
  35  *                or write to the Free Software Foundation, Inc., 59
  36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  37  *
  38  * Revisions   :
  39  *    $Log: cgiedit.h,v $
  40  *    Revision 1.6  2002/03/24 13:25:43  swa
  41  *    name change related issues
  42  *
  43  *    Revision 1.5  2002/01/22 23:24:48  jongfoster
  44  *    Adding edit-actions-section-swap
  45  *
  46  *    Revision 1.4  2001/11/13 00:28:51  jongfoster
  47  *    Adding new CGIs for use by non-JavaScript browsers:
  48  *      edit-actions-url-form
  49  *      edit-actions-add-url-form
  50  *      edit-actions-remove-url-form
  51  *
  52  *    Revision 1.3  2001/10/23 21:48:19  jongfoster
  53  *    Cleaning up error handling in CGI functions - they now send back
  54  *    a HTML error page and should never cause a FATAL error.  (Fixes one
  55  *    potential source of "denial of service" attacks).
  56  *
  57  *    CGI actions file editor that works and is actually useful.
  58  *
  59  *    Ability to toggle JunkBuster remotely using a CGI call.
  60  *
  61  *    You can turn off both the above features in the main configuration
  62  *    file, e.g. if you are running a multi-user proxy.
  63  *
  64  *    Revision 1.2  2001/10/14 22:12:49  jongfoster
  65  *    New version of CGI-based actionsfile editor.
  66  *    Major changes, including:
  67  *    - Completely new file parser and file output routines
  68  *    - edit-actions CGI renamed edit-actions-for-url
  69  *    - All CGIs now need a filename parameter, except for...
  70  *    - New CGI edit-actions which doesn't need a filename,
  71  *      to allow you to start the editor up.
  72  *    - edit-actions-submit now works, and now automatically
  73  *      redirects you back to the main edit-actions-list handler.
  74  *
  75  *    Revision 1.1  2001/09/16 15:47:37  jongfoster
  76  *    First version of CGI-based edit interface.  This is very much a
  77  *    work-in-progress, and you can't actually use it to edit anything
  78  *    yet.  You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
  79  *    to have any effect.
  80  *
  81  *
  82  **********************************************************************/
  83 \f
  84
  85 #include "project.h"
  86
  87 #ifdef __cplusplus
  88 extern "C" {
  89 #endif
  90
  91 /*
  92  * CGI functions
  93  */
  94 #ifdef FEATURE_CGI_EDIT_ACTIONS
  95 extern jb_err cgi_edit_actions        (struct client_state *csp,
  96                                        struct http_response *rsp,
  97                                        const struct map *parameters);
  98 extern jb_err cgi_edit_actions_for_url(struct client_state *csp,
  99                                        struct http_response *rsp,
 100                                        const struct map *parameters);
 101 extern jb_err cgi_edit_actions_list   (struct client_state *csp,
 102                                        struct http_response *rsp,
 103                                        const struct map *parameters);
 104 extern jb_err cgi_edit_actions_submit (struct client_state *csp,
 105                                        struct http_response *rsp,
 106                                        const struct map *parameters);
 107 extern jb_err cgi_edit_actions_url    (struct client_state *csp,
 108                                        struct http_response *rsp,
 109                                        const struct map *parameters);
 110 extern jb_err cgi_edit_actions_url_form(struct client_state *csp,
 111                                         struct http_response *rsp,
 112                                         const struct map *parameters);
 113 extern jb_err cgi_edit_actions_add_url(struct client_state *csp,
 114                                        struct http_response *rsp,
 115                                        const struct map *parameters);
 116 extern jb_err cgi_edit_actions_add_url_form(struct client_state *csp,
 117                                             struct http_response *rsp,
 118                                             const struct map *parameters);
 119 extern jb_err cgi_edit_actions_remove_url    (struct client_state *csp,
 120                                               struct http_response *rsp,
 121                                               const struct map *parameters);
 122 extern jb_err cgi_edit_actions_remove_url_form(struct client_state *csp,
 123                                             struct http_response *rsp,
 124                                             const struct map *parameters);
 125 extern jb_err cgi_edit_actions_section_remove(struct client_state *csp,
 126                                               struct http_response *rsp,
 127                                               const struct map *parameters);
 128 extern jb_err cgi_edit_actions_section_add   (struct client_state *csp,
 129                                               struct http_response *rsp,
 130                                               const struct map *parameters);
 131 extern jb_err cgi_edit_actions_section_swap  (struct client_state *csp,
 132                                               struct http_response *rsp,
 133                                               const struct map *parameters);
 134 extern jb_err cgi_toggle(struct client_state *csp,
 135                          struct http_response *rsp,
 136                          const struct map *parameters);
 137 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
 138
 139
 140 /* Revision control strings from this header and associated .c file */
 141 extern const char cgiedit_rcs[];
 142 extern const char cgiedit_h_rcs[];
 143
 144 #ifdef __cplusplus
 145 } /* extern "C" */
 146 #endif
 147
 148 #endif /* ndef CGI_H_INCLUDED */
 149
 150 /*
 151   Local Variables:
 152   tab-width: 3
 153   end:
 154 */