primo commit

components/com_finder/src/View/Search/FeedView.php

@@ -0,0 +1,94 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  com_finder
+ *
+ * @copyright   (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Finder\Site\View\Search;
+
+use Joomla\CMS\Document\Feed\FeedItem;
+use Joomla\CMS\Factory;
+use Joomla\CMS\HTML\HTMLHelper;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
+use Joomla\CMS\Router\Route;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Search feed view class for the Finder package.
+ *
+ * @since  2.5
+ */
+class FeedView extends BaseHtmlView
+{
+    /**
+     * Method to display the view.
+     *
+     * @param   string  $tpl  A template file to load. [optional]
+     *
+     * @return  void
+     *
+     * @since   2.5
+     */
+    public function display($tpl = null)
+    {
+        // Get the application
+        $app = Factory::getApplication();
+
+        // Adjust the list limit to the feed limit.
+        $app->getInput()->set('limit', $app->get('feed_limit'));
+
+        // Get view data.
+        $state   = $this->get('State');
+        $params  = $state->get('params');
+        $query   = $this->get('Query');
+        $results = $this->get('Items');
+        $total   = $this->get('Total');
+
+        // If the feed has been disabled, we want to bail out here
+        if ($params->get('show_feed_link', 1) == 0) {
+            throw new \Exception(Text::_('JGLOBAL_RESOURCE_NOT_FOUND'), 404);
+        }
+
+        // Push out the query data.
+        $explained = HTMLHelper::_('query.explained', $query);
+
+        // Set the document title.
+        $this->setDocumentTitle($params->get('page_title', ''));
+
+        // Configure the document description.
+        if (!empty($explained)) {
+            $this->getDocument()->setDescription(html_entity_decode(strip_tags($explained), ENT_QUOTES, 'UTF-8'));
+        }
+
+        // Set the document link.
+        $this->getDocument()->link = Route::_($query->toUri());
+
+        // If we don't have any results, we are done.
+        if (empty($results)) {
+            return;
+        }
+
+        // Convert the results to feed entries.
+        foreach ($results as $result) {
+            // Convert the result to a feed entry.
+            $item              = new FeedItem();
+            $item->title       = $result->title;
+            $item->link        = Route::_($result->route);
+            $item->description = $result->description;
+
+            // Use Unix date to cope for non-english languages
+            $item->date        = (int) $result->start_date ? HTMLHelper::_('date', $result->start_date, 'U') : $result->indexdate;
+
+            // Loads item info into RSS array
+            $this->getDocument()->addItem($item);
+        }
+    }
+}

components/com_finder/src/View/Search/HtmlView.php

@@ -0,0 +1,366 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  com_finder
+ *
+ * @copyright   (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Finder\Site\View\Search;
+
+use Joomla\CMS\Event\Finder\ResultEvent;
+use Joomla\CMS\Factory;
+use Joomla\CMS\HTML\HTMLHelper;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\MVC\View\GenericDataException;
+use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
+use Joomla\CMS\Pagination\Pagination;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\CMS\Profiler\Profiler;
+use Joomla\CMS\Router\Route;
+use Joomla\CMS\Router\SiteRouterAwareInterface;
+use Joomla\CMS\Router\SiteRouterAwareTrait;
+use Joomla\CMS\Uri\Uri;
+use Joomla\Component\Finder\Administrator\Indexer\Query;
+use Joomla\Component\Finder\Site\Helper\FinderHelper;
+use Joomla\Filesystem\Path;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Search HTML view class for the Finder package.
+ *
+ * @since  2.5
+ */
+class HtmlView extends BaseHtmlView implements SiteRouterAwareInterface
+{
+    use SiteRouterAwareTrait;
+
+    /**
+     * The query indexer object
+     *
+     * @var    Query
+     *
+     * @since  4.0.0
+     */
+    protected $query;
+
+    /**
+     * The page parameters
+     *
+     * @var  \Joomla\Registry\Registry|null
+     */
+    protected $params = null;
+
+    /**
+     * The model state
+     *
+     * @var  \Joomla\Registry\Registry
+     */
+    protected $state;
+
+    /**
+     * The logged in user
+     *
+     * @var  \Joomla\CMS\User\User|null
+     */
+    protected $user = null;
+
+    /**
+     * The suggested search query
+     *
+     * @var   string|false
+     *
+     * @since 4.0.0
+     */
+    protected $suggested = false;
+
+    /**
+     * The explained (human-readable) search query
+     *
+     * @var   string|null
+     *
+     * @since 4.0.0
+     */
+    protected $explained = null;
+
+    /**
+     * The page class suffix
+     *
+     * @var    string
+     *
+     * @since  4.0.0
+     */
+    protected $pageclass_sfx = '';
+
+    /**
+     * An array of results
+     *
+     * @var    array
+     *
+     * @since  3.8.0
+     */
+    protected $results;
+
+    /**
+     * The total number of items
+     *
+     * @var    integer
+     *
+     * @since  3.8.0
+     */
+    protected $total;
+
+    /**
+     * The pagination object
+     *
+     * @var    Pagination
+     *
+     * @since  3.8.0
+     */
+    protected $pagination;
+
+    /**
+     * Method to display the view.
+     *
+     * @param   string  $tpl  A template file to load. [optional]
+     *
+     * @return  void
+     *
+     * @since   2.5
+     */
+    public function display($tpl = null)
+    {
+        $app          = Factory::getApplication();
+        $this->params = $app->getParams();
+
+        // Get view data.
+        $this->state = $this->get('State');
+        $this->query = $this->get('Query');
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderQuery') : null;
+        $this->results = $this->get('Items');
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderResults') : null;
+        $this->sortOrderFields = $this->get('sortOrderFields');
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderSortOrderFields') : null;
+        $this->total = $this->get('Total');
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderTotal') : null;
+        $this->pagination = $this->get('Pagination');
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderPagination') : null;
+
+        // Flag indicates to not add limitstart=0 to URL
+        $this->pagination->hideEmptyLimitstart = true;
+
+        $input = $app->getInput()->get;
+
+        // Add additional parameters
+        $queryParameterList = [
+            'f'  => 'int',
+            't'  => 'array',
+            'q'  => 'string',
+            'l'  => 'cmd',
+            'd1' => 'string',
+            'd2' => 'string',
+            'w1' => 'string',
+            'w2' => 'string',
+            'o'  => 'word',
+            'od' => 'word',
+        ];
+
+        foreach ($queryParameterList as $parameter => $filter) {
+            $value = $input->get($parameter, null, $filter);
+
+            if (\is_null($value)) {
+                continue;
+            }
+
+            $this->pagination->setAdditionalUrlParam($parameter, $value);
+        }
+
+        // Check for errors.
+        if (\count($errors = $this->get('Errors'))) {
+            throw new GenericDataException(implode("\n", $errors), 500);
+        }
+
+        // Configure the pathway.
+        if (!empty($this->query->input)) {
+            $app->getPathway()->addItem($this->escape($this->query->input));
+        }
+
+        // Check for a double quote in the query string.
+        if (strpos($this->query->input, '"')) {
+            $router = $this->getSiteRouter();
+
+            // Fix the q variable in the URL.
+            if ($router->getVar('q') !== $this->query->input) {
+                $router->setVar('q', $this->query->input);
+            }
+        }
+
+        // Run an event on each result item
+        if (\is_array($this->results)) {
+            $dispatcher = $this->getDispatcher();
+
+            // Import Finder plugins
+            PluginHelper::importPlugin('finder', null, true, $dispatcher);
+
+            foreach ($this->results as $result) {
+                $dispatcher->dispatch('onFinderResult', new ResultEvent('onFinderResult', [
+                    'subject' => $result,
+                    'query'   => $this->query,
+                ]));
+            }
+        }
+
+        // Log the search
+        FinderHelper::logSearch($this->query, $this->total);
+
+        // Push out the query data.
+        $this->suggested = HTMLHelper::_('query.suggested', $this->query);
+        $this->explained = HTMLHelper::_('query.explained', $this->query);
+
+        // Escape strings for HTML output
+        $this->pageclass_sfx = htmlspecialchars($this->params->get('pageclass_sfx', ''));
+
+        // Check for layout override only if this is not the active menu item
+        // If it is the active menu item, then the view and category id will match
+        $active = $app->getMenu()->getActive();
+
+        if (isset($active->query['layout'])) {
+            // We need to set the layout in case this is an alternative menu item (with an alternative layout)
+            $this->setLayout($active->query['layout']);
+        }
+
+        $this->prepareDocument();
+
+        \JDEBUG ? Profiler::getInstance('Application')->mark('beforeFinderLayout') : null;
+
+        parent::display($tpl);
+
+        \JDEBUG ? Profiler::getInstance('Application')->mark('afterFinderLayout') : null;
+    }
+
+    /**
+     * Method to get hidden input fields for a get form so that control variables
+     * are not lost upon form submission
+     *
+     * @return  string  A string of hidden input form fields
+     *
+     * @since   2.5
+     */
+    protected function getFields()
+    {
+        $fields = null;
+
+        // Get the URI.
+        $uri = Uri::getInstance(Route::_($this->query->toUri()));
+        $uri->delVar('q');
+        $uri->delVar('o');
+        $uri->delVar('t');
+        $uri->delVar('d1');
+        $uri->delVar('d2');
+        $uri->delVar('w1');
+        $uri->delVar('w2');
+        $elements = $uri->getQuery(true);
+
+        // Create hidden input elements for each part of the URI.
+        foreach ($elements as $n => $v) {
+            if (\is_scalar($v)) {
+                $fields .= '<input type="hidden" name="' . $n . '" value="' . $v . '">';
+            }
+        }
+
+        return $fields;
+    }
+
+    /**
+     * Method to get the layout file for a search result object.
+     *
+     * @param   string  $layout  The layout file to check. [optional]
+     *
+     * @return  string  The layout file to use.
+     *
+     * @since   2.5
+     */
+    protected function getLayoutFile($layout = null)
+    {
+        // Create and sanitize the file name.
+        $file = $this->_layout . '_' . preg_replace('/[^A-Z0-9_\.-]/i', '', $layout);
+
+        // Check if the file exists.
+        $filetofind = $this->_createFileName('template', ['name' => $file]);
+        $exists     = Path::find($this->_path['template'], $filetofind);
+
+        return ($exists ? $layout : 'result');
+    }
+
+    /**
+     * Prepares the document
+     *
+     * @return  void
+     *
+     * @since   2.5
+     */
+    protected function prepareDocument()
+    {
+        $app   = Factory::getApplication();
+
+        // Because the application sets a default page title,
+        // we need to get it from the menu item itself
+        $menu = $app->getMenu()->getActive();
+
+        if ($menu) {
+            $this->params->def('page_heading', $this->params->get('page_title', $menu->title));
+        } else {
+            $this->params->def('page_heading', Text::_('COM_FINDER_DEFAULT_PAGE_TITLE'));
+        }
+
+        $this->setDocumentTitle($this->params->get('page_title', ''));
+
+        if ($layout = $this->params->get('article_layout')) {
+            $this->setLayout($layout);
+        }
+
+        // Configure the document meta-description.
+        if (!empty($this->explained)) {
+            $explained = $this->escape(html_entity_decode(strip_tags($this->explained), ENT_QUOTES, 'UTF-8'));
+            $this->getDocument()->setDescription($explained);
+        } elseif ($this->params->get('menu-meta_description')) {
+            $this->getDocument()->setDescription($this->params->get('menu-meta_description'));
+        }
+
+        if ($this->params->get('robots')) {
+            $this->getDocument()->setMetaData('robots', $this->params->get('robots'));
+        }
+
+        // Check for OpenSearch
+        if ($this->params->get('opensearch', 1)) {
+            $ostitle = $this->params->get(
+                'opensearch_name',
+                Text::_('COM_FINDER_OPENSEARCH_NAME') . ' ' . $app->get('sitename')
+            );
+            $this->getDocument()->addHeadLink(
+                Uri::getInstance()->toString(['scheme', 'host', 'port']) . Route::_('index.php?option=com_finder&view=search&format=opensearch'),
+                'search',
+                'rel',
+                ['title' => $ostitle, 'type' => 'application/opensearchdescription+xml']
+            );
+        }
+
+        // Add feed link to the document head.
+        if ($this->params->get('show_feed_link', 1) == 1) {
+            // Add the RSS link.
+            $props = ['type' => 'application/rss+xml', 'title' => htmlspecialchars($this->getDocument()->getTitle())];
+            $route = Route::_($this->query->toUri() . '&format=feed&type=rss');
+            $this->getDocument()->addHeadLink($route, 'alternate', 'rel', $props);
+
+            // Add the ATOM link.
+            $props = ['type' => 'application/atom+xml', 'title' => htmlspecialchars($this->getDocument()->getTitle())];
+            $route = Route::_($this->query->toUri() . '&format=feed&type=atom');
+            $this->getDocument()->addHeadLink($route, 'alternate', 'rel', $props);
+        }
+    }
+}

components/com_finder/src/View/Search/OpensearchView.php

@@ -0,0 +1,89 @@
+<?php
+
+/**
+ * @package     Joomla.Site
+ * @subpackage  com_finder
+ *
+ * @copyright   (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Finder\Site\View\Search;
+
+use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Document\Opensearch\OpensearchUrl;
+use Joomla\CMS\Factory;
+use Joomla\CMS\MVC\View\AbstractView;
+use Joomla\CMS\Router\Route;
+use Joomla\CMS\Uri\Uri;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * OpenSearch View class for Finder
+ *
+ * @since  2.5
+ */
+class OpensearchView extends AbstractView
+{
+    /**
+     * Method to display the view.
+     *
+     * @param   string  $tpl  A template file to load. [optional]
+     *
+     * @return  void
+     *
+     * @since   2.5
+     */
+    public function display($tpl = null)
+    {
+        $app = Factory::getApplication();
+
+        $params = ComponentHelper::getParams('com_finder');
+        $this->getDocument()->setShortName($params->get('opensearch_name', $app->get('sitename', '')));
+        $this->getDocument()->setDescription($params->get('opensearch_description', $app->get('MetaDesc', '')));
+
+        // Prevent any output when OpenSearch Support is disabled
+        if (!$params->get('opensearch', 1)) {
+            return;
+        }
+
+        // Add the URL for the search
+        $searchUri      = 'index.php?option=com_finder&view=search&q={searchTerms}';
+        $suggestionsUri = 'index.php?option=com_finder&task=suggestions.opensearchsuggest&format=json&q={searchTerms}';
+        $baseUrl        = Uri::getInstance()->toString(['host', 'port', 'scheme']);
+        $active         = $app->getMenu()->getActive();
+
+        if ($active->component == 'com_finder') {
+            $searchUri .= '&Itemid=' . $active->id;
+            $suggestionsUri .= '&Itemid=' . $active->id;
+        }
+
+        // Add the HTML result view
+        $htmlSearch           = new OpensearchUrl();
+        $htmlSearch->template = $baseUrl . Route::_($searchUri, false);
+        $this->getDocument()->addUrl($htmlSearch);
+
+        // Add the RSS result view
+        $htmlSearch           = new OpensearchUrl();
+        $htmlSearch->template = $baseUrl . Route::_($searchUri . '&format=feed&type=rss', false);
+        $htmlSearch->type     = 'application/rss+xml';
+        $this->getDocument()->addUrl($htmlSearch);
+
+        // Add the Atom result view
+        $htmlSearch           = new OpensearchUrl();
+        $htmlSearch->template = $baseUrl . Route::_($searchUri . '&format=feed&type=atom', false);
+        $htmlSearch->type     = 'application/atom+xml';
+        $this->getDocument()->addUrl($htmlSearch);
+
+        // Add suggestions URL
+        if ($params->get('show_autosuggest', 1)) {
+            $htmlSearch           = new OpensearchUrl();
+            $htmlSearch->template = $baseUrl . Route::_($suggestionsUri, false);
+            $htmlSearch->type     = 'application/x-suggestions+json';
+            $this->getDocument()->addUrl($htmlSearch);
+        }
+    }
+}