Subversion Repositories oidplus

<?php

/*

 * OIDplus 2.0

 * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

namespace ViaThinkSoft\OIDplus;

// phpcs:disable PSR1.Files.SideEffects

\defined('INSIDE_OIDPLUS') or die;

// phpcs:enable PSR1.Files.SideEffects

class OIDplusPagePublicSearch extends OIDplusPagePluginPublic {

        /**

         * @param bool $html

         * @return void

         * @throws OIDplusException

         */

        public function init(bool $html=true) {

                OIDplus::config()->prepareConfigKey('search_min_term_length', 'Minimum length of a search term', '3', OIDplusConfig::PROTECTION_EDITABLE, function($value) {

                        if (!is_numeric($value) || ($value < 0)) {

                                throw new OIDplusException(_L('Please enter a valid value.'));

                        }

                });

        }

        /**

         * @param array $params

         * @param bool $is_searching

         * @return void

         */

        private function prepareSearchParams(array &$params, bool $is_searching) {

                $params['term'] = isset($params['term']) ? trim($params['term']) : '';

                $params['namespace'] = isset($params['namespace']) ? trim($params['namespace']) : '';

                // Default criteria selection:

                if ($is_searching) {

                        $params['search_title'] = isset($params['search_title']) && $params['search_title'];

                        $params['search_description'] = isset($params['search_description']) && $params['search_description'];

                        $params['search_asn1id'] = isset($params['search_asn1id']) && $params['search_asn1id'];

                        $params['search_iri'] = isset($params['search_iri']) && $params['search_iri'];

                } else {

                        $params['search_title'] = true;

                        $params['search_description'] = false;

                        $params['search_asn1id'] = true;

                        $params['search_iri'] = true;

                }

        }

        /**

         * @param string $html

         * @param string $term

         * @return string

         */

        private function highlight_match(string $html, string $term): string {

                return str_replace(htmlentities($term), '<font color="red">'.htmlentities($term).'</font>', $html);

        }

        /**

         * @param array $params

         * @return string

         * @throws OIDplusException

         */

        private function doSearch(array $params): string {

                $output = '';

                // Note: The SQL collation defines if search is case sensitive or case insensitive

                $min_length = OIDplus::config()->getValue('search_min_term_length');

                $this->prepareSearchParams($params, true);

                if (strlen($params['term']) == 0) {

                        $output .= '<p><font color="red">'._L('Error: You must enter a search term.').'</font></p>';

                } else if (strlen($params['term']) < $min_length) {

                        $output .= '<p><font color="red">'._L('Error: Search term minimum length is %1 characters.',$min_length).'</font></p>';

                } else {

                        // TODO: case insensitive comparison (or should we leave that to the DBMS?)

                        if ($params['namespace'] == 'oidplus:ra') {

                                $output .= '<h2>'._L('Search results for RA %1','<font color="red">'.htmlentities($params['term']).'</font>').'</h2>';

                                $sql_where = array(); $prep_where = array();

                                $sql_where[] = "email like ?";   $prep_where[] = '%'.$params['term'].'%';

                                $sql_where[] = "ra_name like ?"; $prep_where[] = '%'.$params['term'].'%';

                                if (count($sql_where) == 0) $sql_where[] = '1=0';

                                $res = OIDplus::db()->query("select * from ###ra where (".implode(' or ', $sql_where).")", $prep_where);

                                $count = 0;

                                while ($row = $res->fetch_object()) {

                                        $email = str_replace('@', '&', $row->email);

                                        $output .= '<p><a '.OIDplus::gui()->link('oidplus:rainfo$'.str_replace('@','&',$email)).'>'.$this->highlight_match(htmlentities($email),$params['term']).'</a>: <b>'.$this->highlight_match(htmlentities($row->ra_name??''),$params['term']).'</b></p>';

                                        $count++;

                                }

                                if ($count == 0) {

                                        $output .= '<p>'._L('Nothing found').'</p>';

                                }

                        } else {

                                $output .= '<h2>'._L('Search results for %1 (%2)','<font color="red">'.htmlentities($params['term']).'</font>',htmlentities($params['namespace'])).'</h2>';

                                $sql_where = array(); $prep_where = array();

                                $sql_where[] = "id like ?"; $prep_where[] = '%'.$params['term'].'%'; // TODO: should we rather do findFitting(), so we can e.g. find GUIDs with different notation?

                                if ($params["search_title"])       { $sql_where[] = "title like ?";       $prep_where[] = '%'.$params['term'].'%'; }

                                if ($params["search_description"]) { $sql_where[] = "description like ?"; $prep_where[] = '%'.$params['term'].'%'; }

                                if ($params["search_asn1id"]) {

                                        $res = OIDplus::db()->query("select * from ###asn1id where name like ?", array('%'.$params['term'].'%'));

                                        while ($row = $res->fetch_object()) {

                                                $sql_where[] = "id = ?"; $prep_where[] = $row->oid;

                                        }

                                }

                                if ($params["search_iri"]) {

                                        $res = OIDplus::db()->query("select * from ###iri where name like ?", array('%'.$params['term'].'%'));

                                        while ($row = $res->fetch_object()) {

                                                $sql_where[] = "id = ?"; $prep_where[] = $row->oid;

                                        }

                                }

                                if (count($sql_where) == 0) $sql_where[] = '1=0';

                                array_unshift($prep_where, $params['namespace'].':%');

                                $res = OIDplus::db()->query("select * from ###objects where id like ? and (".implode(' or ', $sql_where).")", $prep_where);

                                $count = 0;

                                while ($row = $res->fetch_object()) {

                                        $output .= '<p><a '.OIDplus::gui()->link($row->id).'>'.$this->highlight_match(htmlentities($row->id),$params['term']).'</a>';

                                        $asn1ids = array();

                                        $res2 = OIDplus::db()->query("select name from ###asn1id where oid = ?", array($row->id));

                                        while ($row2 = $res2->fetch_object()) {

                                                $asn1ids[] = $row2->name;

                                        }

                                        if (count($asn1ids) > 0) {

                                                $asn1ids = implode(', ', $asn1ids);

                                                $output .= ' ('.$this->highlight_match(htmlentities($asn1ids),$params['term']).')';

                                        }

                                        if (htmlentities($row->title) != '') $output .= ': <b>'.$this->highlight_match(htmlentities($row->title??''),$params['term']).'</b></p>';

                                        $count++;

                                }

                                if ($count == 0) {

                                        $output .= '<p>'._L('Nothing found').'</p>';

                                }

                        }

                }

                return $output;

        }

        /**

         * @param array $params

         * @return array

         * @throws OIDplusException

         */

        private function action_Search(array $params): array {

                $ret = $this->doSearch($params);

                return array("status" => 0, "output" => $ret);

        }

        /**

         * @param string $actionID

         * @param array $params

         * @return array

         * @throws OIDplusException

         */

        public function action(string $actionID, array $params): array {

                if ($actionID == 'search') {

                        return $this->action_Search($params);

                } else {

                        return parent::action($actionID, $params);

                }

        }

        /**

         * @param string $id

         * @param array $out

         * @param bool $handled

         * @return void

         * @throws OIDplusException

         */

        public function gui(string $id, array &$out, bool &$handled) {

                if (explode('$',$id)[0] == 'oidplus:search') {

                        $handled = true;

                        $out['title'] = _L('Search');

                        $out['icon'] = file_exists(__DIR__.'/img/main_icon.png') ? OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon.png' : '';

                        $out['text'] = '';

                        try {

                                $params = $_POST;

                                $this->prepareSearchParams($params, isset($params['search']));

                                $out['text'] .= '<form id="searchForm" action="?goto=oidplus%3Asearch" method="POST">

                                                 <input type="hidden" name="search" value="1">

                                                 '._L('Search for').': <input type="text" id="term" name="term" value="'.htmlentities($params['term']).'"><br><br>

                                                 <script>

                                                 function searchNsSelect(ns) {

                                                     $("#search_options_oid")[0].style.display = (ns == "oid") ? "block" : "none";

                                                     $("#search_options_object")[0].style.display = (ns == "oidplus:ra") ? "none" : "block";

                                                     $("#search_options_ra")[0].style.display = (ns == "oidplus:ra") ? "block" : "none";

                                                 }

                                                 $( document ).ready(function() {

                                                     searchNsSelect($("#namespace")[0].value);

                                                 });

                                                 </script>

                                                 '._L('Search in').': <select name="namespace" id="namespace" onchange="searchNsSelect(this.value);"><br><br>';

                                foreach (OIDplus::getEnabledObjectTypes() as $ot) {

                                        $out['text'] .= '<option value="'.htmlentities($ot::ns()).'"'.(($params['namespace'] == $ot::ns()) ? ' selected' : '').'>'.htmlentities($ot::objectTypeTitle()).'</option>';

                                }

                                $out['text'] .= '<option value="oidplus:ra"'.(($params['namespace'] == 'oidplus:ra') ? ' selected' : '').'>'._L('Registration Authority').'</option>

                                                 </select><br><br>

                                <div id="search_options_ra">

                                <!-- TODO: RA specific selection criterias -->

                                </div>

                                <div id="search_options_object">

                                            <input type="checkbox" name="search_title" id="search_title" value="1"'.($params["search_title"] ? ' checked' : '').'> <label for="search_title">'._L('Search in field "Title"').'</label><br>

                                            <input type="checkbox" name="search_description" id="search_description" value="1"'.($params["search_description"] ? ' checked' : '').'> <label for="search_description">'._L('Search in field "Description"').'</label><br>

                                <div id="search_options_oid">

                                    <input type="checkbox" name="search_asn1id" id="search_asn1id" value="1"'.($params["search_asn1id"] ? ' checked' : '').'> <label for="search_asn1id">'._L('Search in field "ASN.1 identifier" (only OIDs)').'</label><br>

                                    <input type="checkbox" name="search_iri" id="search_iri" value="1"'.($params["search_iri"] ? ' checked' : '').'> <label for="search_iri">'._L('Search in field "Unicode label" (only OIDs)').'</label><br>

                                </div>

                                </div>

                                 <br>

                                <input type="submit" value="'._L('Search').'" onclick="return OIDplusPagePublicSearch.search_button_click()">

                                </form>';

                                $out['text'] .= '<div id="search_output">'; // will be filled with either AJAX or staticly (HTML form submit)

                                if (isset($params['search'])) {

                                        // Search with NoJS/HTML

                                        $out['text'] .= $this->doSearch($params);

                                }

                                $out['text'] .= '</div>';

                        } catch (\Exception $e) {

                                $htmlmsg = $e instanceof OIDplusException ? $e->getHtmlMessage() : htmlentities($e->getMessage());

                                $out['text'] = _L('Error: %1',$htmlmsg);

                        }

                }

        }

        /**

         * @param array $out

         * @return void

         */

        public function publicSitemap(array &$out) {

                $out[] = 'oidplus:search';

        }

        /**

         * @param array $json

         * @param string|null $ra_email

         * @param bool $nonjs

         * @param string $req_goto

         * @return bool

         * @throws OIDplusException

         */

        public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {

                if (file_exists(__DIR__.'/img/main_icon16.png')) {

                        $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png';

                } else {

                        $tree_icon = null; // default icon (folder)

                }

                $json[] = array(

                        'id' => 'oidplus:search',

                        'icon' => $tree_icon,

                        'text' => _L('Search')

                );

                return true;

        }

        /**

         * @param string $request

         * @return array|false

         */

        public function tree_search(string $request) {

                return false;

        }

}