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