inc/ajax-functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 09/17/2011 *
   4  * ===================                          Last change: 09/17/2011 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : ajax-functions.php                               *
   8  * -------------------------------------------------------------------- *
   9  * Short description : AJAX-related functions                           *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : AJAX-bezogene Funktionen                         *
  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 // Init ajax request
  44 function initAjax () {
  45         // Init AJAX reply array
  46         $GLOBALS['ajax_reply'] = array(
  47                 // Raw content
  48                 'reply_content' => NULL,
  49         );
  50
  51         // Set content type (mostly JSON)
  52         setContentType('application/json');
  53
  54         // By default nothing is found/valid
  55         setHttpStatus('204 No Content');
  56
  57         // Set username
  58         setUsername('{--USERNAME_AJAX--}');
  59
  60         // In installation phase load ajax_installer.php
  61         if (isInstallationPhase()) {
  62                 // Load it
  63                 loadIncludeOnce('inc/ajax/ajax_installer.php');
  64         } // END - if
  65 }
  66
  67 // Setter for AJAX reply content
  68 function setAjaxReplyContent ($content) {
  69         // Log message
  70         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . strlen($content));
  71
  72         // Set it, but with URL encoding
  73         $GLOBALS['ajax_reply']['reply_content'] = urlencode(doFinalCompilation($content, FALSE));
  74 }
  75
  76 /**
  77  * Checks whether the AJAX access level was valid. This function doesn't need
  78  * caching in $GLOBALS[__FUNCTION__] because it will be called only once.
  79  */
  80 function isAjaxRequestLevelValid () {
  81         // By default nothing is valid
  82         $isValid = FALSE;
  83
  84         // Switch on the 'level' value
  85         switch (postRequestElement('level')) {
  86                 case 'install': // Installation phase level
  87                         // Simply check for it
  88                         $isValid = isInstallationPhase();
  89                         break;
  90
  91                 case 'admin': // Admin area
  92                         // Load admin includes
  93                         loadIncludeOnce('inc/modules/admin/admin-inc.php');
  94                         loadIncludeOnce('inc/ajax/ajax_admin.php');
  95
  96                         // Determine correct 'what' value
  97                         $what = determineWhat();
  98
  99                         // Get action value
 100                         $action = getActionFromModuleWhat('admin', $what);
 101
 102                         // Check condition
 103                         $isValid = ((isAdmin()) && (isAdminAllowedAccessMenu($action, $what)));
 104                         break;
 105
 106                 default: // Unsupported level (please report this!)
 107                         logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported AJAX request access level ' . postRequestElement('level') . ' detected. Please report this, it means this part is not finished.');
 108                         break;
 109         } // END - switch
 110
 111         // Return validation result
 112         return $isValid;
 113 }
 114
 115 // Processes the AJAX request by generating a call-back on given 'level' value
 116 function processAjaxRequest () {
 117         // Generate the call-back function name
 118         $callbackName = 'doAjaxProcess' . capitalizeUnderscoreString(postRequestElement('level'));
 119
 120         // Is the call-back function there?
 121         if (!function_exists($callbackName)) {
 122                 // This shall not happen
 123                 reportBug(__FUNCTION__, __LINE__, 'AJAX call-back ' . $callbackName . ' does not exist.');
 124         } // END - if
 125
 126         // Call the function
 127         call_user_func($callbackName);
 128 }
 129
 130 // Send AJAX content
 131 function sendAjaxContent () {
 132         // Is the status fine or template not found (404)?
 133         if (isAjaxHttpStatusAccepted()) {
 134                 // Then output the JSON
 135                 outputHtml(json_encode($GLOBALS['ajax_reply'], JSON_FORCE_OBJECT));
 136         } // END - if
 137 }
 138
 139 // Checks whether the HTTP status is accepted
 140 function isAjaxHttpStatusAccepted () {
 141         // Is it accepted?
 142         $isAccepted = in_array(strtoupper(getHttpStatus()), array('200 OK', '404 NOT FOUND'));
 143
 144         // Return it
 145         return $isAccepted;
 146 }
 147
 148 // [EOF]
 149 ?>