2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 09/17/2011 *
4 * =================== Last change: 09/17/2011 *
6 * -------------------------------------------------------------------- *
7 * File : ajax-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : AJAX-related functions *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : AJAX-bezogene Funktionen *
12 * -------------------------------------------------------------------- *
13 * Copyright (c) 2003 - 2009 by Roland Haeder *
14 * Copyright (c) 2009 - 2013 by Mailer Developer Team *
15 * For more information visit: http://mxchange.org *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program; if not, write to the Free Software *
29 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
31 ************************************************************************/
33 // Some security stuff...
34 if (!defined('__SECURITY')) {
39 function initAjax () {
40 // Init AJAX reply array
41 $GLOBALS['ajax_reply'] = array(
43 'reply_content' => NULL,
46 // Init call-back debug information
47 $GLOBALS['ajax_callback_function'] = NULL;
49 // Set content type (mostly JSON)
50 setContentType('application/json');
52 // By default nothing is found/valid
53 setHttpStatus('204 No Content');
56 setUsername('{--USERNAME_AJAX--}');
58 // In installation phase load ajax_installer.php
61 loadIncludeOnce('inc/ajax/ajax_installer.php');
65 // Setter for AJAX reply content
66 function setAjaxReplyContent ($content) {
68 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . strlen($content));
70 // Set it, but with URL encoding
71 $GLOBALS['ajax_reply']['reply_content'] = urlencode(doFinalCompilation($content, FALSE));
75 * Checks whether the AJAX access level was valid. This function doesn't need
76 * caching in $GLOBALS[__FUNCTION__] because it will be called only once.
78 function isValidAjaxRequestLevel () {
79 // By default nothing is valid
82 // Switch on the 'level' value
83 switch (postRequestElement('level')) {
84 case 'install': // Installation phase level
85 // Simply check for it
86 $isValid = isInstaller();
89 case 'admin': // Admin area
90 // Load admin includes
91 loadIncludeOnce('inc/modules/admin/admin-inc.php');
92 loadIncludeOnce('inc/ajax/ajax_admin.php');
94 // Determine correct 'what' value
95 $what = determineWhat();
98 $action = getActionFromModuleWhat('admin', $what);
101 $isValid = ((isAdmin()) && (isAdminAllowedAccessMenu($action, $what)));
104 default: // Unsupported level (please report this!)
105 logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported AJAX request access level ' . postRequestElement('level') . ' detected. Please report this, it means this part is not finished.');
109 // Return validation result
113 // Processes the AJAX request by generating a call-back on given 'level' value
114 function processAjaxRequest () {
115 // Generate the call-back function name
116 $callbackName = 'doAjaxProcess' . capitalizeUnderscoreString(postRequestElement('level'));
118 // Is the call-back function there?
119 if (!function_exists($callbackName)) {
120 // This shall not happen
121 reportBug(__FUNCTION__, __LINE__, 'AJAX call-back ' . $callbackName . ' does not exist.');
125 call_user_func($callbackName);
129 function sendAjaxContent ($forceOutput = FALSE) {
130 // Is the status fine or template not found (404)?
131 if ((isAjaxHttpStatusAccepted()) || ($forceOutput === TRUE)) {
132 // Then output the JSON
133 outputHtml(encodeJson($GLOBALS['ajax_reply']));
137 // Checks whether the HTTP status is accepted
138 function isAjaxHttpStatusAccepted () {
140 $isAccepted = in_array(strtoupper(getHttpStatus()), array('200 OK', '404 NOT FOUND'));