Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 366 lines (303 sloc) 8.921 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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
<?php
/**
* @package Joomla.Administrator
* @subpackage com_finder
*
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/

defined('_JEXEC') or die;

// Register dependent classes.
JLoader::register('FinderIndexer', JPATH_COMPONENT_ADMINISTRATOR . '/helpers/indexer/indexer.php');

/**
* Indexer controller class for Finder.
*
* @package Joomla.Administrator
* @subpackage com_finder
* @since 2.5
*/
class FinderControllerIndexer extends JController
{
/**
* Method to start the indexer.
*
* @return void
*
* @since 2.5
*/
public function start()
{
static $log;

if ($log == null)
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
$log = JLog::addLogger($options);
}

// Log the start
JLog::add('Starting the indexer', JLog::INFO);

// We don't want this form to be cached.
header('Pragma: no-cache');
header('Cache-Control: no-cache');
header('Expires: -1');

// Check for a valid token. If invalid, send a 403 with the error message.
JRequest::checkToken('request') or $this->sendResponse(new Exception(JText::_('JINVALID_TOKEN'), 403));

// Put in a buffer to silence noise.
ob_start();

// Reset the indexer state.
FinderIndexer::resetState();

// Import the finder plugins.
JPluginHelper::importPlugin('finder');

// Add the indexer language to JS
JText::script('COM_FINDER_AN_ERROR_HAS_OCCURRED');
JText::script('COM_FINDER_NO_ERROR_RETURNED');

// Start the indexer.
try
{
// Trigger the onStartIndex event.
JDispatcher::getInstance()->trigger('onStartIndex');

// Get the indexer state.
$state = FinderIndexer::getState();
$state->start = 1;

// Send the response.
$this->sendResponse($state);
}
// Catch an exception and return the response.
catch (Exception $e)
{
$this->sendResponse($e);
}
}

/**
* Method to run the next batch of content through the indexer.
*
* @return void
*
* @since 2.5
*/
public function batch()
{
static $log;

if ($log == null)
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
$log = JLog::addLogger($options);
}

// Log the start
JLog::add('Starting the indexer batch process', JLog::INFO);

// We don't want this form to be cached.
header('Pragma: no-cache');
header('Cache-Control: no-cache');
header('Expires: -1');

// Check for a valid token. If invalid, send a 403 with the error message.
JRequest::checkToken('request') or $this->sendResponse(new Exception(JText::_('JINVALID_TOKEN'), 403));

// Put in a buffer to silence noise.
ob_start();

// Remove the script time limit.
@set_time_limit(0);

// Get the indexer state.
$state = FinderIndexer::getState();

// Reset the batch offset.
$state->batchOffset = 0;

// Update the indexer state.
FinderIndexer::setState($state);

// Import the finder plugins.
JPluginHelper::importPlugin('finder');

/*
* We are going to swap out the raw document object with an HTML document
* in order to work around some plugins that don't do proper environment
* checks before trying to use HTML document functions.
*/
$raw = clone(JFactory::getDocument());
$lang = JFactory::getLanguage();

// Get the document properties.
$attributes = array (
'charset' => 'utf-8',
'lineend' => 'unix',
'tab' => ' ',
'language' => $lang->getTag(),
'direction' => $lang->isRTL() ? 'rtl' : 'ltr'
);

// Get the HTML document.
$html = JDocument::getInstance('html', $attributes);
$doc = JFactory::getDocument();

// Swap the documents.
$doc = $html;

// Get the admin application.
$admin = clone(JFactory::getApplication());

// Get the site app.
include_once JPATH_SITE . '/includes/application.php';
$site = JApplication::getInstance('site');

// Swap the app.
$app = JFactory::getApplication();
$app = $site;

// Start the indexer.
try
{
// Trigger the onBeforeIndex event.
JDispatcher::getInstance()->trigger('onBeforeIndex');

// Trigger the onBuildIndex event.
JDispatcher::getInstance()->trigger('onBuildIndex');

// Get the indexer state.
$state = FinderIndexer::getState();
$state->start = 0;
$state->complete = 0;

// Swap the documents back.
$doc = $raw;

// Swap the applications back.
$app = $admin;

// Send the response.
$this->sendResponse($state);
}
// Catch an exception and return the response.
catch (Exception $e)
{
// Swap the documents back.
$doc = $raw;

// Send the response.
$this->sendResponse($e);
}
}

/**
* Method to optimize the index and perform any necessary cleanup.
*
* @return void
*
* @since 2.5
*/
public function optimize()
{
// We don't want this form to be cached.
header('Pragma: no-cache');
header('Cache-Control: no-cache');
header('Expires: -1');

// Check for a valid token. If invalid, send a 403 with the error message.
JRequest::checkToken('request') or $this->sendResponse(new Exception(JText::_('JINVALID_TOKEN'), 403));

// Put in a buffer to silence noise.
ob_start();

// Import the finder plugins.
JPluginHelper::importPlugin('finder');

try
{
// Optimize the index.
FinderIndexer::optimize();

// Get the indexer state.
$state = FinderIndexer::getState();
$state->start = 0;
$state->complete = 1;

// Send the response.
$this->sendResponse($state);
}
// Catch an exception and return the response.
catch (Exception $e)
{
$this->sendResponse($e);
}
}

/**
* Method to handle a send a JSON response. The body parameter
* can be a Exception object for when an error has occurred or
* a JObject for a good response.
*
* @param mixed $data JObject on success, Exception on error. [optional]
*
* @return void
*
* @since 2.5
*/
public static function sendResponse($data = null)
{
static $log;

if ($log == null)
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
$log = JLog::addLogger($options);
}

$backtrace = null;

// Send the assigned error code if we are catching an exception.
if ($data instanceof Exception)
{
JLog::add($data->getMessage(), JLog::ERROR);
JResponse::setHeader('status', $data->getCode());
JResponse::sendHeaders();
}

// Create the response object.
$response = new FinderIndexerResponse($data);

// Add the buffer.
$response->buffer = JDEBUG ? ob_get_contents() : ob_end_clean();

// Send the JSON response.
echo json_encode($response);

// Close the application.
JFactory::getApplication()->close();
}
}

/**
* Finder Indexer JSON Response Class
*
* @package Joomla.Administrator
* @subpackage com_finder
* @since 2.5
*/
class FinderIndexerResponse
{
/**
* Class Constructor
*
* @param mixed $state The processing state for the indexer
*
* @since 2.5
*/
public function __construct($state)
{
static $log;

if ($log == null)
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
$log = JLog::addLogger($options);
}

// The old token is invalid so send a new one.
$this->token = JFactory::getSession()->getFormToken();

// Check if we are dealing with an error.
if ($state instanceof Exception)
{
// Log the error
JLog::add($state->getMessage(), JLog::ERROR);

// Prepare the error response.
$this->error = true;
$this->header = JText::_('COM_FINDER_INDEXER_HEADER_ERROR');
$this->message = $state->getMessage();
}
else
{
// Prepare the response data.
$this->batchSize = (int) $state->batchSize;
$this->batchOffset = (int) $state->batchOffset;
$this->totalItems = (int) $state->totalItems;

$this->startTime = $state->startTime;
$this->endTime = JFactory::getDate()->toSQL();

$this->start = !empty($state->start) ? (int) $state->start : 0;
$this->complete = !empty($state->complete) ? (int) $state->complete : 0;

// Set the appropriate messages.
if ($this->totalItems <= 0 && $this->complete)
{
$this->header = JText::_('COM_FINDER_INDEXER_HEADER_COMPLETE');
$this->message = JText::_('COM_FINDER_INDEXER_MESSAGE_COMPLETE');
}
elseif ($this->totalItems <= 0)
{
$this->header = JText::_('COM_FINDER_INDEXER_HEADER_OPTIMIZE');
$this->message = JText::_('COM_FINDER_INDEXER_MESSAGE_OPTIMIZE');
}
else
{
$this->header = JText::_('COM_FINDER_INDEXER_HEADER_RUNNING');
$this->message = JText::_('COM_FINDER_INDEXER_MESSAGE_RUNNING');
}
}
}
}

// Register the error handler.
JError::setErrorHandling(E_ALL, 'callback', array('FinderControllerIndexer', 'sendResponse'));
Something went wrong with that request. Please try again.