Firesphere/silverstripe-solr-search

<?php
/**
 * Class ClearDirtyClasses|Firesphere\SolrSearch\Tasks\ClearDirtyClasses Clear out classes that were not
 * succesfully updated or deleted in Solr.
 *
 * Any classes that failed to index properly or be removed properly need to be cleaned out regularly
 * This task takes care of doing this. It can be run directly via /dev/tasks, or via a queued job
 *
 * @package Firesphere\Solr\Search
 * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
 * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
 */

namespace Firesphere\SolrSearch\Tasks;

use Exception;
use Firesphere\SolrSearch\Helpers\SolrLogger;
use Firesphere\SolrSearch\Models\DirtyClass;
use Firesphere\SolrSearch\Services\SolrCoreService;
use Firesphere\SolrSearch\Traits\LoggerTrait;
use ReflectionException;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Dev\BuildTask;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\ValidationException;
use Solarium\Exception\HttpException;

/**
 * Class ClearDirtyClasses Clear out classes that were not succesfully updated or deleted in Solr.
 *
 * Any classes that failed to index properly or be removed properly need to be cleaned out regularly
 * This task takes care of doing this. It can be run directly via /dev/tasks, or via a queued job
 *
 * @package Firesphere\Solr\Search
 */
class ClearDirtyClassesTask extends BuildTask
{
    use LoggerTrait;

    /**
     * @var string URLSegment
     */
    private static $segment = 'SolrClearDirtyClasses';
    /**
     * @var string Title
     */
    protected $title = 'Fix broken items in the Solr cores';
    /**
     * @var string Description
     */
    protected $description = 'Clear out classes that are marked as dirty on Solr.';

    /**
     * Clean up Dirty Classes in the index
     *
     * When there are dirty classes to update or delete, the run will attempt to clean up.
     * Dirty classes happen when changes to classes are not successfully updated in Solr
     *
     * @param HTTPRequest $request
     * @return void
     * @throws HTTPException
     * @throws ReflectionException
     * @throws ValidationException
     */
    public function run($request)
    {
        /** @var DataList|DirtyClass $dirtyObjectList */
        $dirtyObjectList = DirtyClass::get();
        /** @var SolrCoreService $service */
        $service = new SolrCoreService();
        foreach ($dirtyObjectList as $dirtyObject) {
            $dirtyClasses = $this->getDirtyClasses($dirtyObject);
            try {
                $service->updateItems($dirtyClasses, $dirtyObject->Type);
                $dirtyObject->delete();
            } catch (Exception $exception) {
                // @codeCoverageIgnoreStart
                $this->getLogger()->error($exception->getMessage());
                continue;
                // @codeCoverageIgnoreEnd
            }
        }
        /** @var SolrLogger $solrLogger */
        $solrLogger = new SolrLogger();
        $solrLogger->saveSolrLog('Index');
    }

    /**
     * Get the objects that need to be deleted or updated as a list
     *
     * @param DirtyClass $dirtyObject
     * @return ArrayList|DataList
     */
    private function getDirtyClasses($dirtyObject)
    {
        /** @var string $dirtyClass */
        $dirtyClass = $dirtyObject->Class;
        $ids = json_decode($dirtyObject->IDs, true);
        $dirtyClasses = ArrayList::create();
        if ($dirtyObject->Type === SolrCoreService::UPDATE_TYPE && count($ids)) {
            $dirtyClasses = $dirtyClass::get()->byIDs($ids);
        }
        if ($dirtyObject->Type === SolrCoreService::DELETE_TYPE) {
            $this->createDeleteList($ids, $dirtyClass, $dirtyClasses);
        }

        return $dirtyClasses;
    }

    /**
     * Create an ArrayList of the dirty items to be deleted from Solr
     * Uses the given class name to generate stub objects
     *
     * @param array $items
     * @param string $dirtyClass
     * @param ArrayList $dirtyClasses
     */
    private function createDeleteList($items, $dirtyClass, &$dirtyClasses)
    {
        /** @var ArrayList $deletions */
        foreach ($items as $item) {
            $dirtyItem = $dirtyClass::create(['ClassName' => $dirtyClass, 'ID' => $item]);
            $dirtyClasses->push($dirtyItem);
        }
    }
}