xref: /plugin/elasticsearch/cli.php (revision 6b2832ed319839ed98cd429980aaab6d4306c91b)

<?php

use dokuwiki\Extension\CLIPlugin;
use splitbrain\phpcli\Options;

/**
 * DokuWiki Plugin elasticsearch (CLI Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr <gohr@cosmocode.de>
 */
class cli_plugin_elasticsearch extends CLIPlugin
{
    /** @var helper_plugin_elasticsearch_client */
    protected $hlp;

    /**
     * Initialize helper plugin
     */
    public function __construct()
    {
        parent::__construct();
        $this->hlp = plugin_load('helper', 'elasticsearch_client');
    }

    /**
     * Register options and arguments on the given $options object
     *
     * @param Options $options
     * @return void
     * @throws \splitbrain\phpcli\Exception
     */
    protected function setup(Options $options)
    {
        $options->setHelp('Manage the elastic search index');

        $options->registerCommand('index', 'Index all pages and/or media in the wiki');
        $options->registerOption(
            'only',
            'Which document type to index: pages or media',
            'o',
            'pages OR media',
            'index'
        );

        $options->registerCommand(
            'createindex',
            'Create index named "' . $this->hlp->getConf('indexname') . '" and all required field mappings.'
        );
        $options->registerOption('clear', 'Remove existing index if any', 'c', false, 'createindex');
    }

    /**
     * Your main program
     *
     * Arguments and options have been parsed when this is run
     *
     * @param Options $options
     * @return void
     */
    protected function main(Options $options)
    {
        // manually initialize auth system
        // see https://github.com/splitbrain/dokuwiki/issues/2823
        global $AUTH_ACL;
        if (!$AUTH_ACL) auth_setup();

        $cmd = $options->getCmd();
        switch ($cmd) {
            case 'createindex':
                try {
                    $this->hlp->createIndex($options->getOpt('clear'));
                    $this->success('Index created');
                } catch (\Exception $e) {
                    $this->error($e->getMessage());
                }
                break;
            case 'index':
                if ($options->getOpt('only') !== 'media') {
                    $this->indexAllPages();
                }
                if ($options->getOpt('only') !== 'pages') {
                    $this->indexAllMedia();
                }
                break;
            default:
                $this->error('No command provided');
                exit(1);
        }
    }

    /**
     * Index all the pages
     */
    protected function indexAllPages()
    {
        global $conf;
        global $ID;

        /** @var action_plugin_elasticsearch_indexing $act */
        $act = plugin_load('action', 'elasticsearch_indexing');

        $data = [];
        search($data, $conf['datadir'], 'search_allpages', ['skipacl' => true]);
        $pages = count($data);
        $n     = 0;
        foreach ($data as $val) {
            $ID = $val['id'];
            $n++;
            $this->info(sprintf("Indexing page %s (%d of %d)\n", $ID, $n, $pages));
            try {
                $act->indexPage($ID);
            } catch (Throwable $e) {
                $this->error("$ID indexing error: " . $e->getMessage());
                $this->debug($e->getTraceAsString());
            }
        }
    }

    /**
     * Index all media
     */
    protected function indexAllMedia()
    {
        global $conf;

        /** @var action_plugin_elasticsearch_indexing $act */
        $act = plugin_load('action', 'elasticsearch_indexing');

        $data = [];
        search($data, $conf['mediadir'], 'search_media', ['skipacl' => true]);
        $media = count($data);
        $n     = 0;
        foreach ($data as $val) {
            $id = $val['id'];
            $n++;
            $this->info(sprintf("Indexing media %s (%d of %d)\n", $id, $n, $media));

            $act->indexFile($id);
        }
    }
}