<?php
/**
* SeekQuarry/Yioop --
* Open Source Pure PHP Search Engine, Crawler, and Indexer
*
* Copyright (C) 2009 - 2019 Chris Pollett chris@pollett.org
*
* LICENSE:
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* END LICENSE
*
* @author Chris Pollett chris@pollett.org
* @license https://www.gnu.org/licenses/ GPL3
* @link https://www.seekquarry.com/
* @copyright 2009 - 2019
* @filesource
*/
namespace seekquarry\yioop\views;
use seekquarry\yioop as B;
use seekquarry\yioop\configs as C;
use seekquarry\yioop\library\CrawlConstants;
use seekquarry\yioop\library\UrlParser;
/**
* Web page used to present search results
* It is also contains the search box for
* people to types searches into
*
* @author Chris Pollett
*/
class SearchView extends View implements CrawlConstants
{
/** This view is drawn on a web layout
* @var string
*/
public $layout = "web";
/**
* Represent extension of Git urls
*/
const GIT_EXTENSION = ".git";
/**
* Number of decimals for search result scores
*/
const SCORE_PRECISION = 4;
/**
* Draws the main landing pages as well as search result pages
*
* @param array $data PAGES contains all the summaries of web pages
* returned by the current query, $data also contains information
* about how the the query took to process and the total number
* of results, how to fetch the next results, etc.
*
*/
public function renderView($data)
{
$data['LAND'] = (!isset($data['PAGES']) && !isset($data['MORE']) &&
!isset($data['TRENDING']))
? 'landing-' : '';
if (C\SIGNIN_LINK || C\SUBSEARCH_LINK) {?>
<div class="<?= $data['LAND'] ?>top-bar"><?php
$this->element("subsearch")->render($data);
$this->element("signin")->render($data);
?>
</div>
<?php
}
$logged_in = isset($data["ADMIN"]) && $data["ADMIN"];
$query_parts = [];
if ($logged_in) {
$query_parts[C\CSRF_TOKEN] = $data[C\CSRF_TOKEN];
}
$logo = C\BASE_URL . C\LOGO;
$is_landing = (!isset($data['PAGES']) && !isset($data['MORE']) &&
!isset($data['TRENDING']));
if ($is_landing) { ?>
<div class="landing">
<?php
} else if ($_SERVER["MOBILE"]) {
$logo = C\BASE_URL .C\M_LOGO;
}
?>
<h1 class="logo"><a href="<?= C\BASE_URL ?><?php if ($logged_in) {
e("?".http_build_query($query_parts));
} ?>"><img
src="<?php e($logo); ?>" alt="<?= tl('search_view_title')
?>"
/></a>
</h1>
<?php
if (isset($data['PAGES']) || isset($data['MORE']) ||
isset($data['TRENDING'])){ ?>
<div class="serp">
<?php
}
?>
<div class="search-box">
<form id="search-form" method="get" action="<?=C\BASE_URL ?>"
onsubmit="processSubmit()">
<p>
<?php if (isset($data["SUBSEARCH"]) && $data["SUBSEARCH"] != "") {
?><input type="hidden" name="s" value="<?=
$data['SUBSEARCH'] ?>" />
<?php } ?>
<?php if ($logged_in) { ?>
<input id="csrf-token" type="hidden" name="<?= C\CSRF_TOKEN ?>"
value="<?= $data[C\CSRF_TOKEN] ?>" />
<?php } ?>
<input id="its-value" type="hidden" name="its" value="<?=
$data['its'] ?>" />
<input type="search" <?php if (C\WORD_SUGGEST) { ?>
autocomplete="off" onkeyup="onTypeTerm(event, this)"
<?php } ?>
title="<?= tl('search_view_input_label') ?>"
id="query-field" name="q" value="<?php
if (isset($data['QUERY']) && !isset($data['NO_QUERY'])) {
e(urldecode($data['QUERY']));} ?>"
placeholder="<?= tl('search_view_input_placeholder') ?>"/>
<button class="button-box" type="submit"><img
src='<?=C\BASE_URL ?>resources/search-button.png'
alt='<?= tl('search_view_search') ?>'/></button>
</p>
</form>
</div>
<div id="suggest-dropdown">
<ul id="suggest-results" class="suggest-list">
</ul>
</div>
<?php
if (isset($data['PAGES']) && !isset($data['MORE']) &&
!isset($data['TRENDING'])) {
?></div><?php
$this->renderSearchResults($data);
} else if (isset($data['MORE']) && !isset($data['TRENDING'])) {
$top ="";
if (!$_SERVER["MOBILE"]) {
$top = "class='medium-top more-options'";
} else {
$top = "class='more-options'";
}
e("</div><div $top>");
$this->element("moreoptions")->render($data);
e("</div>");
} else if (isset($data['TRENDING'])) {
$this->element("trending")->render($data);
}
?>
<div class="landing-footer">
<div class="center"><b><?php
if (isset($data['INDEX_INFO'])) {
e($data['INDEX_INFO']);
} else {
e(tl('search_view_no_index_set'));
} ?></b>
</div><?php $this->element("footer")->render($data);?>
</div>
<?php
if ($is_landing) { ?>
</div>
<div class='landing-spacer'></div>
<?php
}
}
/**
* Used to draw the results of a query to the Yioop Search Engine
*
* @param array $data an associative array containing a PAGES field needed
* to render search result
*/
public function renderSearchResults($data)
{
$is_landing = (!isset($data['PAGES']) && !isset($data['MORE']));
$logged_in = isset($data["ADMIN"]) && $data["ADMIN"];
$token = ($logged_in) ? $data[C\CSRF_TOKEN] : "";
$token_string = ($logged_in) ? C\CSRF_TOKEN . "=". $data[C\CSRF_TOKEN] .
"&" : "";
$token_string_amp = ($logged_in) ?
C\CSRF_TOKEN . "=" . $data[C\CSRF_TOKEN]."&" : "";
?>
<div <?php if (C\WORD_SUGGEST) {
e('id="spell-check"');
} ?> class="spell"><span class="hidden" > </span></div>
<h2 class="serp-stats"><?php
if ($_SERVER["MOBILE"]) {
} else {
$num_results = min($data['TOTAL_ROWS'],
$data['LIMIT'] + $data['RESULTS_PER_PAGE']);
$limit = min($data['LIMIT'] + 1, $num_results);
?> <?= tl('search_view_calculated',
number_format($data['ELAPSED_TIME'], 5)) ?> <?=
tl('search_view_results', $limit, $num_results,
$data['TOTAL_ROWS']) ?><?php
}
?></h2>
<?php
if ((!$is_landing) && in_array(C\AD_LOCATION, ['top', 'both'] ) &&
!empty($data['TOP_ADSCRIPT'])) {
?>
<div class="top-adscript"><?= $data['TOP_ADSCRIPT'] ?></div>
<?php
} ?>
<?php
if (!$is_landing && !$_SERVER["MOBILE"] &&
in_array(C\AD_LOCATION, ['side', 'both'] ) &&
!empty($data['SIDE_ADSCRIPT']) ) { ?>
<div class="side-adscript"><?= $data['SIDE_ADSCRIPT'] ?></div>
<?php
} ?>
<div class="serp-body" >
<div class="serp-results"><?php
if (!$is_landing) {
$this->element("displayadvertisement")->render($data);
}
if (!empty($data['BEST_ANSWER'])) {
?><div id="best-answer" class="echo-link">
<?= $data['BEST_ANSWER']; ?>
</div><?php
}
foreach ($data['PAGES'] as $page) {
if (isset($page[self::URL])) {
if (substr($page[self::URL], 0, 4) == "url|") {
$url_parts = explode("|", $page[self::URL]);
$url = $url_parts[1];
$link_url = $url;
$title = (empty($page[self::TITLE]) ||
$page[self::TITLE] == $url) ?
UrlParser::simplifyUrl($url, 60) :
$page[self::TITLE];
$subtitle = "title='" . $page[self::URL] . "'";
} else {
$url = $page[self::URL];
if (substr($url, 0, 7) == "record:") {
$link_url = "?" . $token_string .
"a=cache&q=" . $data['QUERY'].
"&arg=" . urlencode($url) . "&its=".
$page[self::CRAWL_TIME];
} else {
$link_url = $url;
}
$title = mb_convert_encoding($page[self::TITLE],
"UTF-8", "UTF-8");
if (strlen(trim($title)) == 0) {
$title = UrlParser::simplifyUrl($url, 60);
}
$subtitle = "";
}
} else {
$url = "";
$link_url = $url;
$title = isset($page[self::TITLE]) ? $page[self::TITLE] : "";
$subtitle = "";
}
?><div class='result'>
<?php
if (in_array("images", $data["SUBSEARCHES"])) {
$image_subsearch = true;
} else {
$image_subsearch = false;
}
$subsearch = (isset($data["SUBSEARCH"])) ? $data["SUBSEARCH"] :
"";
$base_query = "?" . $token_string_amp.
"c=search";
if (isset($page['IMAGES'])) {
$this->helper("images")->render($page['IMAGES'],
$base_query . "&q={$data['QUERY']}", $subsearch,
$image_subsearch);
e( "</div>");
continue;
} else if (isset($page['FEED'])) {
$this->helper("feeds")->render($page['FEED'],
$token, $data['QUERY'], $subsearch,
$data['OPEN_IN_TABS']);
e( "</div>");
continue;
}
?>
<h2>
<?php
if (strpos($link_url, self::GIT_EXTENSION)) { ?>
<a href="?<?= $token_string_amp
?>a=cache&q=<?= $data['QUERY']
?>&arg=<?= urlencode($url) ?>&its=<?=
$page[self::CRAWL_TIME] ?>&repository=git"
rel='nofollow'>
<?php } else { ?>
<a href="<?= htmlentities($link_url) ?>" rel="nofollow" <?php
if ($data["OPEN_IN_TABS"]) { ?>
target="_blank" rel="noopener"<?php
}?> >
<?php
}
$is_video = false;
$is_image = false;
if (isset($page[self::THUMB]) && $page[self::THUMB] != 'null'
&& $page[self::THUMB] != 'NULL') {
if (empty($page[self::IS_VIDEO])) {
?><img src="<?= $page[self::THUMB] ?>"
alt="<?=title ?>" /><?php
$is_video = false;
$is_image = true;
} else {
$is_video = true;
}
}
if (!$is_image) {
e($title);
if (isset($page[self::TYPE])) {
$this->helper("filetype")->render($page[self::TYPE]);
}
}
?></a>
</h2>
<?php if ($is_video) {
$this->helper("videourl")->render($link_url, $page[self::THUMB],
$data["OPEN_IN_TABS"]);
}
if (!$_SERVER["MOBILE"] && isset($page[self::WORD_CLOUD]) &&
is_array($page[self::WORD_CLOUD])) { ?>
<p><span class="echo-link" <?=$subtitle ?>><?=
UrlParser::simplifyUrl($url, 40)." "
?></span>
<?php
if (isset($page['ANSWER'])) {
$answer = $page['ANSWER'];?>
<span class="echo-link" <?=$subtitle ?>>
<?php e("<span class='word-cloud-spacer'>".
tl('search_view_possible_answer')."</span>"); ?>
<?=$answer." "?>
</span><?php
}
$cloud = $page[self::WORD_CLOUD];
?>
<?php
$i = 1;
if (!empty($cloud)) {
e("<span class='word-cloud-spacer'>".
tl('search_view_word_cloud')."</span>");
$len = 0;
foreach ($cloud as $word) {
$len += strlen($word);
if ($len > 40) {
break;
}
?><span class="word-cloud">
<a class='word-cloud-<?= $i ?>' href="?<?=
$token_string_amp?>its=<?= $data['its']
?>&q=<?=$word ?>"><?=
$this->helper("displayresults")->render($word)
?></a></span><?php
$i++;
}
}
} else { ?>
<p><span class="echo-link" <?=$subtitle ?>><?=
UrlParser::simplifyUrl($url, 100)." "
?></span><?php
}?></p>
<?php if (!isset($page[self::ROBOT_METAS]) ||
!in_array("NOSNIPPET", $page[self::ROBOT_METAS])) {
$description = isset($page[self::DESCRIPTION]) ?
$page[self::DESCRIPTION] : "";
$description = ltrim(mb_convert_encoding($description,
"UTF-8", "UTF-8"), C\PUNCT);
e("<p>".$this->helper("displayresults")->
render($description)."</p>");
}?>
<p class="serp-links-score"><?php
$aux_link_flag = false;
if (isset($page[self::TYPE]) && $page[self::TYPE] != "link") {
if (C\CACHE_LINK && (!isset($page[self::ROBOT_METAS]) ||
!(in_array("NOARCHIVE", $page[self::ROBOT_METAS]) ||
in_array("NONE", $page[self::ROBOT_METAS])))) {
$aux_link_flag = true;
?>
<a href="?<?=$token_string_amp ?>a=cache&q=<?=
$data['QUERY'] ?>&arg=<?=urlencode($url)
?>&its=<?= $page[self::CRAWL_TIME] ?>" rel='nofollow'>
<?php
if ($page[self::TYPE] == "text/html" ||
stristr($page[self::TYPE], "image")) {
e(tl('search_view_cache'));
} else {
e(tl('search_view_as_text'));
}
?></a>.
<?php
}
if (C\SIMILAR_LINK) {
$aux_link_flag = true;
?>
<a href="?<?=$token_string_amp
?>a=related&arg=<?=urlencode($url)
?>&its=<?= $page[self::CRAWL_TIME]?>" rel='nofollow'><?=
tl('search_view_similar') ?></a>.
<?php
}
if (C\IN_LINK) {
$aux_link_flag = true;
?>
<a href="?<?= $token_string_amp ?>q=<?=
urlencode("link:".$url) ?>&its=<?=
$page[self::CRAWL_TIME] ?>" rel='nofollow'><?=
tl('search_view_inlink') ?></a>.
<?php
}
if (C\IP_LINK && isset($page[self::IP_ADDRESSES])){
foreach ($page[self::IP_ADDRESSES] as $address) {?>
<a href="?<?=$token_string_amp
?>q=<?=urlencode('ip:' . $address)
?>&its=<?=$data['its'] ?>" rel='nofollow'>IP:<?=
$address ?></a>. <?php
}
}
?>
<?php
}
if ($_SERVER["MOBILE"] && $aux_link_flag) {e("<br />");}
if ((!C\nsdefined("RESULT_SCORE") || C\RESULT_SCORE)
&& isset($page[self::SCORE])) {
?><span title="<?php
e(tl('search_view_rank',
number_format($page[self::DOC_RANK], 2)) . "\n");
e(tl('search_view_relevancy',
number_format($page[self::RELEVANCE], 2) ) . "\n");
e(tl('search_view_proximity',
number_format($page[self::PROXIMITY], 2) ) . "\n");
if (isset($page[self::USER_RANKS])) {
foreach ($page[self::USER_RANKS] as $label => $score) {
e($label . ":" . number_format($score, 2) . "\n");
}
}
?>" ><?=tl('search_view_score',number_format($page[self::SCORE],
self::SCORE_PRECISION))?></span><?php
}
?>
</p>
</div>
<?php
} //end foreach
$this->helper("pagination")->render(
"?" . http_build_query($data['PAGING_QUERY'], '', '&'),
$data['LIMIT'], $data['RESULTS_PER_PAGE'], $data['TOTAL_ROWS']);
?>
</div>
</div>
<?php
}
}