Rewrote 'we' word a little, rewrote mail order to use SQL_INSERTID() instead of anoth...
[mailer.git] / inc / request-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 02/28/2009 *
4  * ===================                          Last change: 02/28/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : request-functions.php                            *
8  * -------------------------------------------------------------------- *
9  * Short description : Special functions for request handling           *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Spezialle Funktionen fuer die Anfragebehandlung  *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
20  * For more information visit: http://mxchange.org                      *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Initialize the request elements
44 function initRequest () {
45         $GLOBALS['raw_request']['get']  = (array) $_GET;
46         $GLOBALS['raw_request']['post'] = (array) $_POST;
47 }
48
49 // Wrapper for elements in $_GET
50 function getRequestElement ($element) {
51         // By default no element is there
52         $value = NULL;
53
54         // Is the element cached or there?
55         if (isset($GLOBALS['cache_request']['get'][$element])) {
56                 // Then use the cache
57                 $value = $GLOBALS['cache_request']['get'][$element];
58         } elseif (isGetRequestElementSet($element)) {
59                 // Then get it directly
60                 $value = SQL_ESCAPE($GLOBALS['raw_request']['get'][$element]);
61
62                 // Store it in cache
63                 $GLOBALS['cache_request']['get'][$element] = $value;
64         } // END - if
65
66         // Return value
67         return $value;
68 }
69
70 // Checks if an element in $_GET exists
71 function isGetRequestElementSet ($element, $subElement = '') {
72         if (empty($subElement)) {
73                 return ((isset($GLOBALS['raw_request']['get'][$element])) && ('' . ($GLOBALS['raw_request']['get'][$element] . '') != ''));
74         } else {
75                 return ((isset($GLOBALS['raw_request']['get'][$element][$subElement])) && ('' . ($GLOBALS['raw_request']['get'][$element][$subElement] . '') != ''));
76         }
77 }
78
79 // Removes an element from $_GET
80 function unsetGetRequestElement ($element) {
81         unset($GLOBALS['cache_request']['get'][$element]);
82         unset($GLOBALS['raw_request']['get'][$element]);
83 }
84
85 // Getter for whole $_GET array
86 function getRequestArray () {
87         return $GLOBALS['raw_request']['get'];
88 }
89
90 // Counts entries in $_GET or returns false if not an array
91 function countRequestGet () {
92         // By default this is not an array
93         $count = false;
94
95         // Get the array
96         $GET = getRequestArray();
97
98         // Is it an array?
99         if (is_array($GET)) {
100                 // Then count it
101                 $count = count($GET);
102         } // END - if
103
104         // Return value
105 }
106
107 // Setter for element in $_GET
108 function setGetRequestElement ($element, $value) {
109         // Escape both
110         $element = SQL_ESCAPE($element);
111         $value   = SQL_ESCAPE($value);
112
113         // Set in $_GET
114         $GLOBALS['raw_request']['get'][$element] = $value;
115
116         // Update cache
117         $GLOBALS['cache_request']['get'][$element] = $value;
118 }
119
120 // Wrapper for elements in $_POST
121 function postRequestElement ($element, $subElement = NULL) {
122         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . gettype($element) . ']=' . $element . ',subElement[' . gettype($subElement) . ']=' . $subElement . ' - ENTERED!');
123         // By default no element is there
124         $value = NULL;
125
126         // Is the element in cache?
127         if (isset($GLOBALS['cache_request']['post'][$element][$subElement])) {
128                 // Then use it
129                 $value = $GLOBALS['cache_request']['post'][$element][$subElement];
130                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . gettype($element) . ']=' . $element . ',subElement[' . gettype($subElement) . ']=' . $subElement . ',value[' . gettype($value) . ']=' . $value . ' - CACHE!');
131         } elseif (isPostRequestElementSet($element)) {
132                 // Then use it
133                 $value = $GLOBALS['raw_request']['post'][$element];
134
135                 // Is $subElement set?
136                 if ((!is_null($subElement)) && (isPostRequestElementSet($element, $subElement))) {
137                         // Then use this
138                         $value = SQL_ESCAPE($value[$subElement]);
139                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ',subElement=' . $subElement . ' - SUB!');
140                 } elseif (!is_array($value)) {
141                         // Escape it here
142                         $value = SQL_ESCAPE($value);
143                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ' - REGULAR!');
144                 }
145
146                 // Set it in cache
147                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element=' . $element . ',subElement=' . $subElement . ',value=' . $value.' - ADDED!');
148                 $GLOBALS['cache_request']['post'][$element][$subElement] = $value;
149         } // END - if
150
151         // Return value
152         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'element[' . gettype($element) . ']=' . $element . ',subElement[' . gettype($subElement) . ']=' . $subElement . ',value[' . gettype($value) . ']=' . $value . ' - EXIT!');
153         return $value;
154 }
155
156 // Checks if an element in $_POST exists
157 function isPostRequestElementSet ($element, $subElement = NULL) {
158         /*
159          * Always check that $element is a string and that $subElement is NULL or
160          * a string as numerical indexes are not wanted in POST data (in this
161          * project).
162          */
163         assert(is_string($element) && ((is_null($subElement)) || (is_string($subElement))));
164
165         // Is a sub element set?
166         if (is_null($subElement)) {
167                 // No, then only check $element
168                 return ((isset($GLOBALS['raw_request']['post'][$element])) && ((is_array($GLOBALS['raw_request']['post'][$element])) || (('' . $GLOBALS['raw_request']['post'][$element] . '') != '')));
169         } else {
170                 // Yes, then check both together
171                 return ((isset($GLOBALS['raw_request']['post'][$element][$subElement])) && (('' . $GLOBALS['raw_request']['post'][$element][$subElement] . '') != ''));
172         }
173 }
174
175 // Removes an element from $_POST
176 function unsetPostRequestElement ($element) {
177         unset($GLOBALS['raw_request']['post'][$element]);
178         unset($GLOBALS['cache_request']['post'][$element]);
179 }
180
181 // Getter for whole $_POST array
182 function postRequestArray () {
183         return $GLOBALS['raw_request']['post'];
184 }
185
186 // Setter for whole $_POST array
187 function setPostRequestArray ($postData) {
188         $GLOBALS['raw_request']['post'] = $postData;
189 }
190
191 // Counts entries in $_POST or returns false if not an array
192 function countRequestPost () {
193         // By default this is not an array
194         $count = false;
195
196         // Get the array
197         $postData = postRequestArray();
198
199         // Is it an array?
200         if (is_array($postData)) {
201                 // Then count it
202                 $count = count($postData);
203         } // END - if
204
205         // Return value
206         return $count;
207 }
208
209 // Setter for element in $_POST
210 function setPostRequestElement ($element, $value) {
211         // Is $element or $value an array?
212         if (is_array($element)) {
213                 // Set array
214                 $eval = "\$GLOBALS['raw_request']['post']['";
215
216                 // Add all entries
217                 $eval .= implode("']['", $element);
218
219                 // Finish eval() command
220                 $eval .= sprintf("'] = \"%s\";", SQL_ESCAPE($value));
221
222                 // And run it
223                 eval($eval);
224         } elseif (is_array($value)) {
225                 // Escape element
226                 $element = SQL_ESCAPE($element);
227
228                 // Value is an array so set it directly
229                 $GLOBALS['raw_request']['post'][$element] = $value;
230         } else {
231                 // Escape both
232                 $element = SQL_ESCAPE($element);
233                 $value   = SQL_ESCAPE($value);
234
235                 // Set regular entry
236                 $GLOBALS['raw_request']['post'][$element] = $value;
237         }
238
239         // Update cache
240         $GLOBALS['cache_request']['post'][$element][null] = $value;
241 }
242
243 // Checks whether a form was sent. If so, the $_POST['ok'] element must be set
244 function isFormSent ($requestParameter = 'ok') {
245         // Simply wrap it!
246         return isPostRequestElementSet($requestParameter);
247 }
248
249 // Getter for request URI
250 function getRequestUri () {
251         // Is it not set?
252         if (!isset($_SERVER['REQUEST_URI'])) {
253                 // Return empty string
254                 return '';
255         } // END - if
256
257         // Return it
258         return $_SERVER['REQUEST_URI'];
259 }
260
261 // Add all GET parameters to a string (without leading sign)
262 function addAllGetRequestParameters () {
263         // Init variable
264         $return = '';
265
266         // Now add all parameters
267         foreach (getRequestArray() as $key => $value) {
268                 // Add it secured
269                 $return .= SQL_ESCAPE($key) . '=' . SQL_ESCAPE($value) . '&amp;';
270         } // END - foreach
271
272         // Remove trailing &amp;
273         $return = substr($return, 0, -5);
274
275         // Return it
276         return $return;
277 }
278
279 // [EOF]
280 ?>