From c2efb2a7052aea52c2ab73f0fce8e91d4d7e0601 Mon Sep 17 00:00:00 2001
From: Paul Borgermans <paul.borgermans@gmail.com>
Date: Mon, 13 Apr 2015 00:56:54 +0200
Subject: [PATCH] Initial version of query plugin mechanism

---
 classes/queryplugins/ezfquerysearchplugin.php | 26 ++++++++++++++
 classes/queryplugins/ezftestqueryplugin.php   | 34 +++++++++++++++++++
 search/plugins/ezsolr/ezsolr.php              | 25 ++++++++++++++
 settings/ezfind.ini                           |  6 +++-
 4 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 classes/queryplugins/ezfquerysearchplugin.php
 create mode 100644 classes/queryplugins/ezftestqueryplugin.php

diff --git a/classes/queryplugins/ezfquerysearchplugin.php b/classes/queryplugins/ezfquerysearchplugin.php
new file mode 100644
index 00000000..89a5d7cc
--- /dev/null
+++ b/classes/queryplugins/ezfquerysearchplugin.php
@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * File containing Search Query Plugin Interface
+ *
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ * @version //autogentag//
+ * @package ezfind
+ */
+
+/**
+ * Description of ezfQuerySearchPlugin.
+ * Interface that Query PLugins should implement.
+ * The plugin code checks for the correct implementation.
+ *
+ */
+interface ezfQuerySearchPlugin
+{
+    /**
+     * @var array $queryParams
+     */
+    public function modify( &$queryParams );
+}
+
+?>
diff --git a/classes/queryplugins/ezftestqueryplugin.php b/classes/queryplugins/ezftestqueryplugin.php
new file mode 100644
index 00000000..7255802e
--- /dev/null
+++ b/classes/queryplugins/ezftestqueryplugin.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ * @version //autogentag//
+ */
+
+/**
+ * Description of ezftestqueryplugin
+ *
+ * This test plugin simply looks up if the string 'article' is present in the query
+ * provided by the user and if so, adds a class filter to type article
+ *
+ * @author paul
+ *
+ */
+class ezfTestQueryPlugin implements ezfQuerySearchPlugin
+{
+
+    /**
+     *
+     * @param mixed $queryParams
+     */
+    public function modify( &$queryParams )
+    {
+        if ( strpos( $queryParams['q'], 'article' ) !== FALSE )
+        {
+            $queryParams['fq'][]='meta_class_identifier_ms:article';
+            //remove the filter value from the query string
+            $queryParams['q'] = str_ireplace('article', '', $queryParams['q']);
+        }
+    }
+}
diff --git a/search/plugins/ezsolr/ezsolr.php b/search/plugins/ezsolr/ezsolr.php
index 19c2ae31..32d416cb 100644
--- a/search/plugins/ezsolr/ezsolr.php
+++ b/search/plugins/ezsolr/ezsolr.php
@@ -1021,6 +1021,31 @@ function search( $searchText, $params = array(), $searchTypes = array() )
 
             eZDebug::createAccumulator( 'Engine time', 'eZ Find' );
             eZDebug::accumulatorStart( 'Engine time' );
+
+            // Since 2015-04-12 PBo : query time plugins
+            $generalSearchPlugins = $this->FindINI->variable('QueryPlugins', 'Search');
+            if (!empty($generalSearchPlugins))
+            {
+                foreach ($generalSearchPlugins as $pluginClassString)
+                {
+                    if (!class_exists($pluginClassString))
+                    {
+                        eZDebug::writeError("Unable to find the PHP class '$pluginClassString' defined for query time plugins for eZ Find", __METHOD__);
+                        continue;
+                    }
+                    $plugin = new $pluginClassString;
+                    if ($plugin instanceof ezfQuerySearchPlugin)
+                    {
+                        $plugin->modify( $queryParams );
+                    }
+                    else
+                    {
+                        eZDebug::writeError("Provided plugin '$pluginClassString' is not of the correct type: ezfQuerySearchPlugin", __METHOD__);
+                        continue;
+                    }
+                }
+            }
+
             $resultArray = $coreToUse->rawSearch( $queryParams );
             eZDebug::accumulatorStop( 'Engine time' );
         }
diff --git a/settings/ezfind.ini b/settings/ezfind.ini
index 8ef3cb06..7bfda0b5 100644
--- a/settings/ezfind.ini
+++ b/settings/ezfind.ini
@@ -330,4 +330,8 @@ FiltersList[geodist]=eZFindGeoDistExtendedAttributeFilter
 
 [QueryBoost]
 RawBoostQueries[]
-#RawBoostQueries[]=meta_class_identifier_ms:folder^10
\ No newline at end of file
+#RawBoostQueries[]=meta_class_identifier_ms:folder^10
+
+[QueryPlugins]
+Search[]
+//Search[]=ezfTestQueryPlugin