]> git.mxchange.org Git - mailer.git/blob - inc/request-functions.php
Missing wrapper for admin_menu_javascript added
[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 - 2011 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         if (is_null($subElement)) {
159                 return ((isset($GLOBALS['raw_request']['post'][$element])) && (('' . $GLOBALS['raw_request']['post'][$element] . '') != ''));
160         } else {
161                 return ((isset($GLOBALS['raw_request']['post'][$element][$subElement])) && (('' . $GLOBALS['raw_request']['post'][$element][$subElement] . '') != ''));
162         }
163 }
164
165 // Removes an element from $_POST
166 function unsetPostRequestElement ($element) {
167         unset($GLOBALS['raw_request']['post'][$element]);
168         unset($GLOBALS['cache_request']['post'][$element]);
169 }
170
171 // Getter for whole $_POST array
172 function postRequestArray () {
173         return $GLOBALS['raw_request']['post'];
174 }
175
176 // Setter for whole $_POST array
177 function setPostRequestArray ($postData) {
178         $GLOBALS['raw_request']['post'] = $postData;
179 }
180
181 // Counts entries in $_POST or returns false if not an array
182 function countRequestPost () {
183         // By default this is not an array
184         $count = false;
185
186         // Get the array
187         $postData = postRequestArray();
188
189         // Is it an array?
190         if (is_array($postData)) {
191                 // Then count it
192                 $count = count($postData);
193         } // END - if
194
195         // Return value
196         return $count;
197 }
198
199 // Setter for element in $_POST
200 function setPostRequestElement ($element, $value) {
201         // Is $element or $value an array?
202         if (is_array($element)) {
203                 // Set array
204                 $eval = "\$GLOBALS['raw_request']['post']['";
205
206                 // Add all entries
207                 $eval .= implode("']['", $element);
208
209                 // Finish eval() command
210                 $eval .= sprintf("'] = \"%s\";", SQL_ESCAPE($value));
211
212                 // And run it
213                 eval($eval);
214         } elseif (is_array($value)) {
215                 // Escape element
216                 $element = SQL_ESCAPE($element);
217
218                 // Value is an array so set it directly
219                 $GLOBALS['raw_request']['post'][$element] = $value;
220         } else {
221                 // Escape both
222                 $element = SQL_ESCAPE($element);
223                 $value   = SQL_ESCAPE($value);
224
225                 // Set regular entry
226                 $GLOBALS['raw_request']['post'][$element] = $value;
227         }
228
229         // Update cache
230         $GLOBALS['cache_request']['post'][$element][null] = $value;
231 }
232
233 // Checks wether a form was sent. If so, the $_POST['ok'] element must be set
234 function isFormSent ($requestParameter = 'ok') {
235         // Simply wrap it!
236         return isPostRequestElementSet($requestParameter);
237 }
238
239 // Checks if 'content_type' is set
240 function isContentTypeSet () {
241         return isset($GLOBALS['content_type']);
242 }
243
244 // Setter for content type
245 function setContentType ($contentType) {
246         $GLOBALS['content_type'] = (string) $contentType;
247 }
248
249 // Getter for content type
250 function getContentType () {
251         return $GLOBALS['content_type'];
252 }
253
254 // Getter for request URI
255 function getRequestUri () {
256         return $_SERVER['REQUEST_URI'];
257 }
258
259 // Add all GET parameters to a string (without leading sign)
260 function addAllGetRequestParameters () {
261         // Init variable
262         $return = '';
263
264         // Now add all parameters
265         foreach (getRequestArray() as $key => $value) {
266                 // Add it secured
267                 $return .= SQL_ESCAPE($key) . '=' . SQL_ESCAPE($value) . '&amp;';
268         } // END - foreach
269
270         // Remove trailing &amp;
271         $return = substr($return, 0, -5);
272
273         // Return it
274         return $return;
275 }
276
277 // [EOF]
278 ?>