- md5
- 4806f91bc9d319682aab970fb87bc62e
- sha1
- 6f7a6e4f25de2f018f5564c63d55e492488c4547
- sha256
- d9ccc7d701a0eba436852b6d0e6f2bf02479da2e922e929348012165f853139c
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
<?php
/**
* @package Joomla.Administrator
* @subpackage com_finder
*
* @copyright Copyright (C) 2005 - 2020 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Component\Finder\Administrator\Controller;
\defined('_JEXEC') or die;
use Joomla\CMS\Application\SiteApplication;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Document\FactoryInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Log\Log;
use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Session\Session;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Response\Response;
/**
* Indexer controller class for Finder.
*
* @since 2.5
*/
class IndexerController extends BaseController
{
/**
* Method to start the indexer.
*
* @return void
*
* @since 2.5
*/
public function start()
{
$params = ComponentHelper::getParams('com_finder');
if ($params->get('enable_logging', '0'))
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
Log::addLogger($options);
}
// Log the start
try
{
Log::add('Starting the indexer', Log::INFO);
}
catch (\RuntimeException $exception)
{
// Informational log only
}
// We don't want this form to be cached.
$this->app->allowCache(false);
// Check for a valid token. If invalid, send a 403 with the error message.
Session::checkToken('request') or static::sendResponse(new \Exception(Text::_('JINVALID_TOKEN_NOTICE'), 403));
// Put in a buffer to silence noise.
ob_start();
// Reset the indexer state.
Indexer::resetState();
// Import the finder plugins.
PluginHelper::importPlugin('finder');
// Add the indexer language to \JS
Text::script('COM_FINDER_AN_ERROR_HAS_OCCURRED');
Text::script('COM_FINDER_NO_ERROR_RETURNED');
// Start the indexer.
try
{
// Trigger the onStartIndex event.
$this->app->triggerEvent('onStartIndex');
// Get the indexer state.
$state = Indexer::getState();
$state->start = 1;
// Send the response.
static::sendResponse($state);
}
// Catch an exception and return the response.
catch (\Exception $e)
{
static::sendResponse($e);
}
}
/**
* Method to run the next batch of content through the indexer.
*
* @return void
*
* @since 2.5
*/
public function batch()
{
$params = ComponentHelper::getParams('com_finder');
if ($params->get('enable_logging', '0'))
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
Log::addLogger($options);
}
// Log the start
try
{
Log::add('Starting the indexer batch process', Log::INFO);
}
catch (\RuntimeException $exception)
{
// Informational log only
}
// We don't want this form to be cached.
$this->app->allowCache(false);
// Check for a valid token. If invalid, send a 403 with the error message.
Session::checkToken('request') or static::sendResponse(new \Exception(Text::_('JINVALID_TOKEN_NOTICE'), 403));
// Put in a buffer to silence noise.
ob_start();
// Remove the script time limit.
@set_time_limit(0);
// Get the indexer state.
$state = Indexer::getState();
// Reset the batch offset.
$state->batchOffset = 0;
// Update the indexer state.
Indexer::setState($state);
// Import the finder plugins.
PluginHelper::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 Factory::getDocument();
$lang = Factory::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 = Factory::getContainer()->get(FactoryInterface::class)->createDocument('html', $attributes);
// TODO: Why is this document fetched and immediately overwritten?
$doc = Factory::getDocument();
// Swap the documents.
$doc = $html;
// Get the admin application.
$admin = clone Factory::getApplication();
// Get the site app.
$site = Factory::getContainer()->get(SiteApplication::class);
// Swap the app.
$app = Factory::getApplication();
// TODO: Why is the app fetched and immediately overwritten?
$app = $site;
// Start the indexer.
try
{
// Trigger the onBeforeIndex event.
Factory::getApplication()->triggerEvent('onBeforeIndex');
// Trigger the onBuildIndex event.
Factory::getApplication()->triggerEvent('onBuildIndex');
// Get the indexer state.
$state = Indexer::getState();
$state->start = 0;
$state->complete = 0;
// Swap the documents back.
$doc = $raw;
// Swap the applications back.
$app = $admin;
// Log batch completion and memory high-water mark.
try
{
Log::add('Batch completed, peak memory usage: ' . number_format(memory_get_peak_usage(true)) . ' bytes', Log::INFO);
}
catch (\RuntimeException $exception)
{
// Informational log only
}
// Send the response.
static::sendResponse($state);
}
// Catch an exception and return the response.
catch (\Exception $e)
{
// Swap the documents back.
$doc = $raw;
// Send the response.
static::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.
$this->app->allowCache(false);
// Check for a valid token. If invalid, send a 403 with the error message.
Session::checkToken('request') or static::sendResponse(new \Exception(Text::_('JINVALID_TOKEN_NOTICE'), 403));
// Put in a buffer to silence noise.
ob_start();
// Import the finder plugins.
PluginHelper::importPlugin('finder');
try
{
// Optimize the index
$indexer = new Indexer;
$indexer->optimize();
// Get the indexer state.
$state = Indexer::getState();
$state->start = 0;
$state->complete = 1;
// Send the response.
static::sendResponse($state);
}
// Catch an exception and return the response.
catch (\Exception $e)
{
static::sendResponse($e);
}
}
/**
* Method to handle a send a \JSON response. The body parameter
* can be an \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)
{
$app = Factory::getApplication();
$params = ComponentHelper::getParams('com_finder');
if ($params->get('enable_logging', '0'))
{
$options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
$options['text_file'] = 'indexer.php';
Log::addLogger($options);
}
// Send the assigned error code if we are catching an exception.
if ($data instanceof \Exception)
{
try
{
Log::add($data->getMessage(), Log::ERROR);
}
catch (\RuntimeException $exception)
{
// Informational log only
}
$app->setHeader('status', $data->getCode());
}
// Create the response object.
$response = new Response($data);
// Add the buffer.
$response->buffer = \JDEBUG ? ob_get_contents() : ob_end_clean();
// Send the JSON response.
echo json_encode($response);
}
}
No other release has this exact content. See every version of this file.