<?php
/**
* @brief Background Task: Rebuild Tag Cache
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @subpackage Converter
* @since 12 October 2016
*/
namespace IPS\convert\extensions\core\Queue;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Background Task
*/
class _RebuildTagCache
{
/**
* @brief Number of content items to rebuild per cycle
*/
public $rebuild = 200;
/**
* Parse data before queuing
*
* @param array $data
* @return array
*/
public function preQueueData( $data )
{
$classname = $data['class'];
\IPS\Log::debug( "Getting preQueueData for " . $classname, 'rebuildTagCache' );
try
{
$data['count'] = $classname::db()->select( 'MAX(' . $classname::$databasePrefix . $classname::$databaseColumnId . ')', $classname::$databaseTable )->first();
$data['realCount'] = $classname::db()->select( 'COUNT(*)', $classname::$databaseTable )->first();
/* We're going to use the < operator, so we need to ensure the most recent item is rebuilt */
$data['runPid'] = $data['count'] + 1;
}
catch( \Exception $ex )
{
throw new \OutOfRangeException;
}
\IPS\Log::debug( "PreQueue count for " . $classname . " is " . $data['count'], 'rebuildTagCache' );
if( $data['count'] == 0 )
{
return null;
}
$data['indexed'] = 0;
return $data;
}
/**
* Run Background Task
*
* @param mixed $data Data as it was passed to \IPS\Task::queue()
* @param int $offset Offset
* @return int|null New offset or NULL if complete
* @throws \IPS\Task\Queue\OutOfRangeException Indicates offset doesn't exist and thus task is complete
*/
public function run( &$data, $offset )
{
$classname = $data['class'];
$exploded = explode( '\\', $classname );
if ( !class_exists( $classname ) or !\IPS\Application::appIsEnabled( $exploded[1] ) OR !in_array( 'IPS\Content\Tags', class_implements( $classname ) ) )
{
throw new \IPS\Task\Queue\OutOfRangeException;
}
/* Intentionally no try/catch as it means app doesn't exist */
try
{
$app = \IPS\convert\App::load( $data['app'] );
}
catch( \OutOfRangeException $e )
{
throw new \IPS\Task\Queue\OutOfRangeException;
}
\IPS\Log::debug( "Running " . $classname . ", with an offset of " . $offset, 'rebuildTagCache' );
$select = $classname::db()->select( '*', $classname::$databaseTable, array( array( $classname::$databasePrefix . $classname::$databaseColumnId . ' < ?', $data['runPid'] ) ), $classname::$databasePrefix . $classname::$databaseColumnId . ' DESC', array( 0, $this->rebuild ) );
$iterator = new \IPS\Patterns\ActiveRecordIterator( $select, $classname );
$last = NULL;
foreach( $iterator as $item )
{
$idColumn = $classname::$databaseColumnId;
/* Is this converted content? */
try
{
/* Just checking, we don't actually need anything */
$app->checkLink( $item->$idColumn, $data['link'] );
}
catch( \OutOfRangeException $e )
{
$last = $item->$idColumn;
continue;
}
$tags = array();
$tags['prefix'] = $item->prefix();
foreach( $item->tags() AS $val )
{
$tags[] = $val;
}
$item->setTags( $tags, \IPS\Member::load( $item->mapped('author') ) );
$last = $item->$idColumn;
$data['indexed']++;
}
/* Store the runPid for the next iteration of this Queue task. This allows the progress bar to show correctly. */
$data['runPid'] = $last;
if( $last === NULL )
{
throw new \IPS\Task\Queue\OutOfRangeException;
}
/* Return the number rebuilt so far, so that the rebuild progress bar text makes sense */
return $data['indexed'];
}
/**
* Get Progress
*
* @param mixed $data Data as it was passed to \IPS\Task::queue()
* @param int $offset Offset
* @return array( 'text' => 'Doing something...', 'complete' => 50 ) Text explaining task and percentage complete
* @throws \OutOfRangeException Indicates offset doesn't exist and thus task is complete
*/
public function getProgress( $data, $offset )
{
$class = $data['class'];
$exploded = explode( '\\', $class );
if ( !class_exists( $class ) or !\IPS\Application::appIsEnabled( $exploded[1] ) )
{
throw new \OutOfRangeException;
}
return array( 'text' => \IPS\Member::loggedIn()->language()->addToStack( 'queue_rebuilding_tag_cache', FALSE, array( 'sprintf' => array( \IPS\Member::loggedIn()->language()->addToStack( $class::$title . '_pl', FALSE, array( 'strtolower' => TRUE ) ) ) ) ), 'complete' => $data['realCount'] ? ( round( 100 / $data['realCount'] * $data['indexed'], 2 ) ) : 100 );
}
}