Pony.fm/app/Traits/IndexedInElasticsearchTrait.php

<?php

/**
 * Pony.fm - A community for pony fan music.
 * Copyright (C) 2016 Feld0
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace Poniverse\Ponyfm\Traits;

use Config;
use Elasticsearch;
use Elasticsearch\Common\Exceptions\Missing404Exception;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Poniverse\Ponyfm\Contracts\Searchable;
use Poniverse\Ponyfm\Jobs\UpdateSearchIndexForEntity;

/**
 * Class IndexedInElasticsearch
 *
 * Classes using this trait must declare the `$elasticsearchType` property and
 * implement the `Searchable` interface.
 *
 * @package Poniverse\Ponyfm\Traits
 */
trait IndexedInElasticsearchTrait
{
    use DispatchesJobs;

    // These two functions are from the Searchable interface. They're included
    // here, without being implemented, to assist IDE's when editing this trait.
    public abstract function toElasticsearch():array;
    public abstract function shouldBeIndexed():bool;


    // Laravel automatically runs this method based on the trait's name. #magic
    public static function bootIndexedInElasticsearchTrait()
    {
        static::saved(function (Searchable $entity) {
            $entity->updateElasticsearchEntry();
        });

        static::deleted(function (Searchable $entity) {
            $entity->updateElasticsearchEntry();
        });
    }

    /**
     * @param bool $includeBody set to false when deleting documents
     * @return array
     */
    private function getElasticsearchParameters(bool $includeBody = true)
    {
        $parameters = [
            'index' => Config::get('ponyfm.elasticsearch_index'),
            'type'  => $this->elasticsearchType,
            'id'    => $this->id,
        ];

        if ($includeBody) {
            $parameters['body'] = $this->toElasticsearch();
        }

        return $parameters;
    }

    private function createOrUpdateElasticsearchEntry()
    {
        Elasticsearch::connection()->index($this->getElasticsearchParameters());
    }

    private function deleteElasticsearchEntry()
    {
        try {
            Elasticsearch::connection()->delete($this->getElasticsearchParameters(false));
        } catch (Missing404Exception $e) {
            // If the entity we're trying to delete isn't indexed in Elasticsearch,
            // that's fine.
        }
    }

    /**
     * Asynchronously updates the Elasticsearch entry.
     * When in doubt, this is the method to use.
     */
    public function updateElasticsearchEntry()
    {
        $job = (new UpdateSearchIndexForEntity($this))->onQueue(Config::get('ponyfm.indexing_queue'));
        $this->dispatch($job);
    }

    /**
     * Synchronously updates the Elasticsearch entry. This should only be
     * called from the UpdateSearchIndexForEntity job.
     */
    public function updateElasticsearchEntrySynchronously()
    {
        if ($this->shouldBeIndexed()) {
            $this->createOrUpdateElasticsearchEntry();
        } else {
            $this->deleteElasticsearchEntry();
        }
    }
}