ajax.php
6.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<?php
/**
* @package Joomla.Site
* @subpackage com_ajax
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
/*
* References
* Support plugins in your component
* - https://docs.joomla.org/Special:MyLanguage/Supporting_plugins_in_your_component
*
* Best way for JSON output
* - https://groups.google.com/d/msg/joomla-dev-cms/WsC0nA9Fixo/Ur-gPqpqh-EJ
*/
/** @var \Joomla\CMS\Application\CMSApplication $app */
$app = JFactory::getApplication();
$app->allowCache(false);
// JInput object
$input = $app->input;
// Requested format passed via URL
$format = strtolower($input->getWord('format'));
// Initialize default response and module name
$results = null;
$parts = null;
// Check for valid format
if (!$format)
{
$results = new InvalidArgumentException(JText::_('COM_AJAX_SPECIFY_FORMAT'), 404);
}
/*
* Module support.
*
* modFooHelper::getAjax() is called where 'foo' is the value
* of the 'module' variable passed via the URL
* (i.e. index.php?option=com_ajax&module=foo).
*
*/
elseif ($input->get('module'))
{
$module = $input->get('module');
$table = JTable::getInstance('extension');
$moduleId = $table->find(array('type' => 'module', 'element' => 'mod_' . $module));
if ($moduleId && $table->load($moduleId) && $table->enabled)
{
$helperFile = JPATH_BASE . '/modules/mod_' . $module . '/helper.php';
if (strpos($module, '_'))
{
$parts = explode('_', $module);
}
elseif (strpos($module, '-'))
{
$parts = explode('-', $module);
}
if ($parts)
{
$class = 'Mod';
foreach ($parts as $part)
{
$class .= ucfirst($part);
}
$class .= 'Helper';
}
else
{
$class = 'Mod' . ucfirst($module) . 'Helper';
}
$method = $input->get('method') ?: 'get';
if (is_file($helperFile))
{
JLoader::register($class, $helperFile);
if (method_exists($class, $method . 'Ajax'))
{
// Load language file for module
$basePath = JPATH_BASE;
$lang = JFactory::getLanguage();
$lang->load('mod_' . $module, $basePath, null, false, true)
|| $lang->load('mod_' . $module, $basePath . '/modules/mod_' . $module, null, false, true);
try
{
$results = call_user_func($class . '::' . $method . 'Ajax');
}
catch (Exception $e)
{
$results = $e;
}
}
// Method does not exist
else
{
$results = new LogicException(JText::sprintf('COM_AJAX_METHOD_NOT_EXISTS', $method . 'Ajax'), 404);
}
}
// The helper file does not exist
else
{
$results = new RuntimeException(JText::sprintf('COM_AJAX_FILE_NOT_EXISTS', 'mod_' . $module . '/helper.php'), 404);
}
}
// Module is not published, you do not have access to it, or it is not assigned to the current menu item
else
{
$results = new LogicException(JText::sprintf('COM_AJAX_MODULE_NOT_ACCESSIBLE', 'mod_' . $module), 404);
}
}
/*
* Plugin support by default is based on the "Ajax" plugin group.
* An optional 'group' variable can be passed via the URL.
*
* The plugin event triggered is onAjaxFoo, where 'foo' is
* the value of the 'plugin' variable passed via the URL
* (i.e. index.php?option=com_ajax&plugin=foo)
*
*/
elseif ($input->get('plugin'))
{
$group = $input->get('group', 'ajax');
JPluginHelper::importPlugin($group);
$plugin = ucfirst($input->get('plugin'));
$dispatcher = JEventDispatcher::getInstance();
try
{
$results = $dispatcher->trigger('onAjax' . $plugin);
}
catch (Exception $e)
{
$results = $e;
}
}
/*
* Template support.
*
* tplFooHelper::getAjax() is called where 'foo' is the value
* of the 'template' variable passed via the URL
* (i.e. index.php?option=com_ajax&template=foo).
*
*/
elseif ($input->get('template'))
{
$template = $input->get('template');
$table = JTable::getInstance('extension');
$templateId = $table->find(array('type' => 'template', 'element' => $template));
if ($templateId && $table->load($templateId) && $table->enabled)
{
$basePath = ($table->client_id) ? JPATH_ADMINISTRATOR : JPATH_SITE;
$helperFile = $basePath . '/templates/' . $template . '/helper.php';
if (strpos($template, '_'))
{
$parts = explode('_', $template);
}
elseif (strpos($template, '-'))
{
$parts = explode('-', $template);
}
if ($parts)
{
$class = 'Tpl';
foreach ($parts as $part)
{
$class .= ucfirst($part);
}
$class .= 'Helper';
}
else
{
$class = 'Tpl' . ucfirst($template) . 'Helper';
}
$method = $input->get('method') ?: 'get';
if (is_file($helperFile))
{
JLoader::register($class, $helperFile);
if (method_exists($class, $method . 'Ajax'))
{
// Load language file for template
$lang = JFactory::getLanguage();
$lang->load('tpl_' . $template, $basePath, null, false, true)
|| $lang->load('tpl_' . $template, $basePath . '/templates/' . $template, null, false, true);
try
{
$results = call_user_func($class . '::' . $method . 'Ajax');
}
catch (Exception $e)
{
$results = $e;
}
}
// Method does not exist
else
{
$results = new LogicException(JText::sprintf('COM_AJAX_METHOD_NOT_EXISTS', $method . 'Ajax'), 404);
}
}
// The helper file does not exist
else
{
$results = new RuntimeException(JText::sprintf('COM_AJAX_FILE_NOT_EXISTS', 'tpl_' . $template . '/helper.php'), 404);
}
}
// Template is not assigned to the current menu item
else
{
$results = new LogicException(JText::sprintf('COM_AJAX_TEMPLATE_NOT_ACCESSIBLE', 'tpl_' . $template), 404);
}
}
// Return the results in the desired format
switch ($format)
{
// JSONinzed
case 'json' :
echo new JResponseJson($results, null, false, $input->get('ignoreMessages', true, 'bool'));
break;
// Handle as raw format
default :
// Output exception
if ($results instanceof Exception)
{
// Log an error
JLog::add($results->getMessage(), JLog::ERROR);
// Set status header code
$app->setHeader('status', $results->getCode(), true);
// Echo exception type and message
$out = get_class($results) . ': ' . $results->getMessage();
}
// Output string/ null
elseif (is_scalar($results))
{
$out = (string) $results;
}
// Output array/ object
else
{
$out = implode((array) $results);
}
echo $out;
break;
}