]> git.mxchange.org Git - mailer.git/blob - inc/ajax-functions.php
47db96ca0bfdf4bf6d6992bc06064cee0e2fd1a7
[mailer.git] / 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         // Set it, but with URL encoding
70         $GLOBALS['ajax_reply']['reply_content'] = urlencode(doFinalCompilation($content, false));
71 }
72
73 /**
74  * Checks whether the AJAX access level was valid. This function doesn't need
75  * caching in $GLOBALS[__FUNCTION__] because it will be called only once.
76  */
77 function isAjaxRequestLevelValid () {
78         // By default nothing is valid
79         $isValid = false;
80
81         // Switch on the 'level' value
82         switch (postRequestElement('level')) {
83                 case 'install': // Installation phase level
84                         // Simply check for it
85                         $isValid = isInstallationPhase();
86                         break;
87
88                 case 'admin': // Admin area
89                         // Load admin includes
90                         loadIncludeOnce('inc/modules/admin/admin-inc.php');
91                         loadIncludeOnce('inc/ajax/ajax_admin.php');
92
93                         // Determine correct 'what' value
94                         $what = determineWhat();
95
96                         // Get action value
97                         $action = getActionFromModuleWhat('admin', $what);
98
99                         // Check condition
100                         $isValid = ((isAdmin()) && (isAdminAllowedAccessMenu($action, $what)));
101                         break;
102
103                 default: // Unsupported level (please report this!)
104                         logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported AJAX request access level ' . postRequestElement('level') . ' detected. Please report this, it means this part is not finished.');
105                         break;
106         } // END - switch
107
108         // Return validation result
109         return $isValid;
110 }
111
112 // Processes the AJAX request by generating a call-back on given 'level' value
113 function processAjaxRequest () {
114         // Generate the call-back function name
115         $callbackName = 'doAjaxProcess' . capitalizeUnderscoreString(postRequestElement('level'));
116
117         // Is the call-back function there?
118         if (!function_exists($callbackName)) {
119                 // This shall not happen
120                 reportBug(__FUNCTION__, __LINE__, 'AJAX call-back ' . $callbackName . ' does not exist.');
121         } // END - if
122
123         // Call the function
124         call_user_func($callbackName);
125 }
126
127 // Send AJAX content
128 function sendAjaxContent () {
129         // Is the status fine or template not found (404)?
130         if ((getHttpStatus() == '200 OK') || (getHttpStatus() == '404 NOT FOUND')) {
131                 // Then output the JSON
132                 outputHtml(json_encode($GLOBALS['ajax_reply'], JSON_FORCE_OBJECT));
133         } // END - if
134 }
135
136 // [EOF]
137 ?>