source: main/trunk/greenstone2/runtime-src/src/recpt/cgiutils.h@ 30465

Last change on this file since 30465 was 30465, checked in by kjdon, 5 years ago

fixes for depositor. when getting the post ata and putting it together into form data, need to escape cgi args special characters

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 4.5 KB
Line 
1/**********************************************************************
2 *
3 * cgiutils.h -- general cgi utilities
4 * Copyright (C) 1999 The New Zealand Digital Library Project
5 *
6 * A component of the Greenstone digital library software
7 * from the New Zealand Digital Library Project at the
8 * University of Waikato, New Zealand.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 *
24 *********************************************************************/
25
26
27#ifndef CGIUTILS_H
28#define CGIUTILS_H
29
30#include "gsdlconf.h"
31#include "text_t.h"
32#include "cgiargs.h"
33
34// parse data obtained through a CGI POST request
35text_t parse_post_data (text_t &content_type, text_t &raw_post_data,
36 fileupload_tmap &fileuploads, const text_t &gsdlhome);
37
38// convert %xx and + to their appropriate equivalents
39void decode_cgi_arg (text_t &argstr);
40// convert &,%,+,=,space to encoded versions so that post args can be put together into a get style string
41void cgi_safe_post_arg(text_t &argstr);
42
43// split up the cgi arguments
44void split_cgi_args (const cgiargsinfoclass &argsinfo, text_t argstr,
45 cgiargsclass &args);
46
47// url-decode selected chars of a given string
48void unsafe_cgi_arg(const text_t &chars_to_decode, text_t &str);
49
50text_t encode_commas (const text_t &intext);
51text_t decode_commas (const text_t &intext);
52
53// turns any '-' in a cgi argument into "(-)"
54// set utf8 to true if input is in utf-8, otherwise expects input in unicode
55text_t minus_safe (const text_t &intext, bool utf8);
56
57// returns the encoded version of a cgi argument
58// the original text should be in utf8
59text_t cgi_safe_utf8 (const text_t &intext);
60// the original text should be in unicode
61text_t cgi_safe_unicode (const text_t &intext);
62
63// check_save_conf_str checks the configuration string for
64// the saved args and makes sure it does not conflict with
65// the information about the arguments. If an error is encountered
66// it will return false and the program should not produce any
67// output.
68bool check_save_conf_str (const text_t &saveconf,
69 const cgiargsinfoclass &argsinfo,
70 ostream &logout);
71
72// create_save_conf_str will create a configuration string
73// based on the information in argsinfo. This method of configuration
74// is not recomended as small changes can produce large changes in
75// the resulting configuration string (for instance a totally different
76// ordering). Only arguments which "must" be saved are included in
77// the resulting string.
78text_t create_save_conf_str (const cgiargsinfoclass &argsinfo,
79 ostream &logout);
80
81// expand_compress_args will expand the compressed arguments based
82// on compressconf placing the results in args if they are not
83// already defined. If it encounters an error it will return false
84// and output more information to logout.
85bool expand_save_args (const cgiargsinfoclass &argsinfo,
86 const text_t &saveconf,
87 cgiargsclass &args,
88 ostream &logout);
89
90// adds the default values for those arguments which have not
91// been specified
92void add_default_args (const cgiargsinfoclass &argsinfo,
93 cgiargsclass &args,
94 ostream &logout);
95
96void add_fileupload_args (const cgiargsinfoclass &argsinfo,
97 cgiargsclass &args,
98 fileupload_tmap &fileuploads,
99 ostream &logout);
100
101// compress_save_args will compress the arguments and return
102// them in compressed_args. If an error was encountered
103// compressed_args will be set to to "", an error will be
104// written to logout, and the function will return false.
105bool compress_save_args (const cgiargsinfoclass &argsinfo,
106 const text_t &saveconf,
107 cgiargsclass &args,
108 text_t &compressed_args,
109 outconvertclass &outconvert,
110 ostream &logout);
111
112// args_tounicode converts any arguments which are not in unicode
113// to unicode using inconvert
114void args_tounicode (cgiargsclass &args, inconvertclass &inconvert);
115
116text_t gsdl_getenv (const text_t &name, text_tmap &fcgienv);
117
118#endif
Note: See TracBrowser for help on using the repository browser.