Merge branch 'release/3.2.0'

Author: rhukster

CHANGELOG.md

@@ -1,3 +1,15 @@
+# v3.2.0
+## 06/08/2020
+
+1. [](#new)
+    * Added support for CLI `bin/plugin index` to index only a single language (`--language=en`)
+1. [](#improved)
+    * Renamed CLI classes to avoid class name conflicts
+1. [](#bugfix)
+    * Fixed non-routable and non-published pages showing up in search results
+    * Fixed indexing in multi-language sites
+    * Use CLI command directly in scheduler command to work [#95](https://github.com/trilbymedia/grav-plugin-tntsearch/issues/95) 
+
 # v3.1.1
 ## 02/12/2020
 

blueprints.yaml

@@ -1,5 +1,7 @@
 name: TNT Search
-version: 3.1.1
+slug: tntsearch
+type: plugin
+version: 3.2.0
 testing: false
 description: Powerful indexed-based full text search engine powered by TNTSearch
 icon: binoculars

classes/GravConnector.php

@@ -48,25 +48,24 @@ public function query($query)
             $counter++;
             $process = $default_process;
             $header = $page->header();
-            $route = $page->route();
+            $url = $page->url();
 
             if (isset($header->tntsearch['process'])) {
                 $process = $header->tntsearch['process'];
             }
 
             // Only process what's configured
             if (!$process) {
-                echo("Skipped {$counter} {$route}\n");
+                echo("Skipped {$counter} {$url}\n");
                 continue;
             }
 
             try {
                 $fields = $gtnt->indexPageData($page);
                 $results[] = (array) $fields;
-                $display_route = $fields->display_route ?? $route;
-                echo("Added   {$counter} {$display_route}\n");
+                echo("Added   {$counter} {$url}\n");
             } catch (\Exception $e) {
-                echo("Skipped {$counter} {$route} - {$e->getMessage()}\n");
+                echo("Skipped {$counter} {$url} - {$e->getMessage()}\n");
                 continue;
             }
         }

classes/GravTNTSearch.php

@@ -301,6 +301,12 @@ public function indexPageData($page)
         $header = (array) $page->header();
         $redirect = (bool) $page->redirect();
 
+        if (!$page->published()) {
+            throw new \RuntimeException('not published...');
+        }
+        if (!$page->routable()) {
+            throw new \RuntimeException('not routable...');
+        }
         if ($redirect || (isset($header['tntsearch']['index']) && $header['tntsearch']['index'] === false )) {
             throw new \RuntimeException('redirect only...');
         }
@@ -312,10 +318,6 @@ public function indexPageData($page)
         $fields->name = $page->title();
         $fields->content = static::getCleanContent($page);
 
-        if ($this->language) {
-            $fields->display_route = '/' . $this->language . $route;
-        }
-
         Grav::instance()->fireEvent('onTNTSearchIndex', new Event(['page' => $page, 'fields' => $fields]));
 
         return $fields;

cli/IndexerCommand.php renamed to cli/TNTSearchIndexerCommand.php

@@ -10,7 +10,7 @@
  *
  * @package Grav\Plugin\Console
  */
-class IndexerCommand extends ConsoleCommand
+class TNTSearchIndexerCommand extends ConsoleCommand
 {
     /**
      * @var array
@@ -37,7 +37,18 @@ protected function configure()
     {
         $this
             ->setName('index')
-            ->addOption('alt', null, InputOption::VALUE_NONE, 'alternative output')
+            ->addOption(
+                'alt',
+                null,
+                InputOption::VALUE_NONE,
+                'alternative output'
+            )
+            ->addOption(
+                'language',
+                'l',
+                InputOption::VALUE_OPTIONAL,
+                'optional language to index (multi-language sites only)'
+            )
             ->setDescription('TNTSearch Indexer')
             ->setHelp('The <info>index command</info> re-indexes the search engine');
     }
@@ -47,32 +58,41 @@ protected function configure()
      */
     protected function serve()
     {
+        $langCode = $this->input->getOption('language');
+
+        error_reporting(1);
+        $this->setLanguage($langCode);
         $this->initializePages();
 
         $alt_output = $this->input->getOption('alt') ? true : false;
 
         if ($alt_output) {
-            $this->doIndex($alt_output);
+            $output = $this->doIndex($langCode);
+            $this->output->write($output);
+            $this->output->writeln('');
         } else {
             $this->output->writeln('');
             $this->output->writeln('<magenta>Re-indexing</magenta>');
             $this->output->writeln('');
             $start = microtime(true);
-            $this->doIndex($alt_output);
+            $output = $this->doIndex($langCode);
+            $this->output->write($output);
+            $this->output->writeln('');
             $end =  number_format(microtime(true) - $start,1);
             $this->output->writeln('');
             $this->output->writeln('Indexed in ' . $end . 's');
         }
     }
 
-    private function doIndex($alt_output = false)
+    /**
+     * @param string|null $langCode
+     * @return string
+     */
+    private function doIndex(string $langCode = null): string
     {
-        error_reporting(1);
-
-        [$status, $msg, $output] = TNTSearchPlugin::indexJob();
+        [,,$output] = TNTSearchPlugin::indexJob($langCode);
 
-        $this->output->write($output);
-        $this->output->writeln('');
+        return $output;
     }
 }
 

cli/QueryCommand.php renamed to cli/TNTSearchQueryCommand.php

@@ -11,7 +11,7 @@
  *
  * @package Grav\Plugin\Console
  */
-class QueryCommand extends ConsoleCommand
+class TNTSearchQueryCommand extends ConsoleCommand
 {
     /**
      * @var array

tntsearch.php

@@ -110,7 +110,7 @@ public function onSchedulerInitialized(Event $e): void
             $scheduler = $e['scheduler'];
             $at = $this->config->get('plugins.tntsearch.scheduled_index.at');
             $logs = $this->config->get('plugins.tntsearch.scheduled_index.logs');
-            $job = $scheduler->addFunction('Grav\Plugin\TNTSearchPlugin::indexJob', [], 'tntsearch-index');
+            $job = $scheduler->addCommand('bin/plugin tntsearch index', [], 'tntsearch-index');
             $job->at($at);
             $job->output($logs);
             $job->backlink('/plugins/tntsearch');
@@ -434,7 +434,11 @@ public static function getSearchObjectType($options = [])
         throw new \RuntimeException('Search class: ' . $type . ' does not exist');
     }
 
-    public static function indexJob()
+    /**
+     * @param string|null $langCode
+     * @return array
+     */
+    public static function indexJob(string $langCode = null)
     {
         $grav = Grav::instance();
         $grav['debugger']->enabled(false);
@@ -445,15 +449,34 @@ public static function indexJob()
             $pages->enablePages();
         }
 
+        ob_start();
+
         /** @var Language $language */
         $language = $grav['language'];
+        $langEnabled = $language->enabled();
 
-        ob_start();
+        // TODO: can be removed when Grav minimum >= v1.6.22
+        $hasReset = method_exists($pages, 'reset');
+        if (!$hasReset && !$langCode) {
+            $langCode = $language->getActive();
+        }
 
-        if ($language->enabled()) {
-            foreach ($language->getLanguages() as $lang) {
-                $language->init();
-                $language->setActive($lang);
+        if ($langCode && (!$langEnabled || !$language->validate($langCode))) {
+            $langCode = null;
+        }
+
+        $langCodes = $langCode ? [$langCode] : $language->getLanguages();
+        if ($langCodes) {
+            foreach ($langCodes as $lang) {
+                if ($lang !== $language->getActive()) {
+                    $language->init();
+                    $language->setActive($lang);
+
+                    // TODO: $hasReset test can be removed (keep reset!) when Grav minimum >= v1.6.22
+                    if ($hasReset) {
+                        $pages->reset();
+                    }
+                }
 
                 echo "\nLanguage: {$lang}\n";