bludit/bl-plugins/search/plugin.php

212 lines
5.3 KiB
PHP
Raw Normal View History

2018-10-01 16:34:28 +02:00
<?php
class pluginSearch extends Plugin {
private $pagesFound = array();
private $numberOfItems = 0;
public function init()
{
// Fields and default values for the database of this plugin
$this->dbFields = array(
'label'=>'Search',
'wordsToCachePerPage'=>800
2018-10-01 16:34:28 +02:00
);
}
public function form()
{
global $L;
$html = '<div class="alert alert-primary" role="alert">';
$html .= $this->description();
$html .= '</div>';
$html .= '<div>';
2018-10-01 16:50:04 +02:00
$html .= '<label>'.$L->get('Label').'</label>';
$html .= '<input name="label" type="text" value="'.$this->getValue('label').'">';
$html .= '<span class="tip">'.$L->get('This title is almost always used in the sidebar of the site').'</span>';
2018-10-01 16:34:28 +02:00
$html .= '</div>';
return $html;
}
// HTML for sidebar
public function siteSidebar()
{
2018-10-14 12:54:42 +02:00
global $L;
2018-10-01 16:34:28 +02:00
$html = '<div class="plugin plugin-search">';
$html .= '<h2 class="plugin-label">'.$this->getValue('label').'</h2>';
$html .= '<div class="plugin-content">';
2018-10-02 00:13:47 +02:00
$html .= '<input type="text" id="plugin-search-input" /> ';
2018-10-14 12:54:42 +02:00
$html .= '<input type="button" value="'.$L->get('Search').'" onClick="javascript: window.open(\''.DOMAIN_BASE.'search/\' + document.getElementById(\'plugin-search-input\').value, \'_self\');" />';
$html .= '</div>';
2018-10-01 16:34:28 +02:00
$html .= '</div>';
return $html;
}
public function install($position=0)
{
parent::install($position);
return $this->createCache();
}
2018-10-01 16:50:04 +02:00
// Method called when the user click on button save in the settings of the plugin
2018-10-01 16:34:28 +02:00
public function post()
{
parent::post();
$this->createCache();
}
public function afterPageCreate()
{
$this->createCache();
}
public function afterPageModify()
{
$this->createCache();
}
public function afterPageDelete()
{
$this->createCache();
}
public function beforeAll()
{
// Check if the URL match with the webhook
$webhook = 'search';
if ($this->webhook($webhook, false, false)) {
global $site;
global $url;
// Change the whereAmI to avoid load pages in the rule 69.pages
// This is only for performance propose
$url->setWhereAmI('search');
// Get the string to search from the URL
$stringToSearch = $this->webhook($webhook, true, false);
$stringToSearch = trim($stringToSearch, '/');
// Search the string in the cache and get all pages with matches
$list = $this->search($stringToSearch);
$this->numberOfItems = count($list);
// Split the content in pages
// The first page number is 1, so the real is 0
$realPageNumber = $url->pageNumber() - 1;
$itemsPerPage = $site->itemsPerPage();
$chunks = array_chunk($list, $itemsPerPage);
if (isset($chunks[$realPageNumber])) {
$this->pagesFound = $chunks[$realPageNumber];
}
}
}
public function paginator()
{
$webhook = 'search';
if ($this->webhook($webhook, false, false)) {
// Get the pre-defined variable from the rule 99.paginator.php
// Is necessary to change this variable to fit the paginator with the result from the search
global $numberOfItems;
$numberOfItems = $this->numberOfItems;
}
}
public function beforeSiteLoad()
{
$webhook = 'search';
if ($this->webhook($webhook, false, false)) {
global $url;
// Get the pre-defined variable from the rule 69.pages.php
// We change the content to show in the website
global $content;
$content = array();
foreach ($this->pagesFound as $pageKey) {
try {
$page = new Page($pageKey);
array_push($content, $page);
} catch (Exception $e) {
// continue
}
}
}
}
// Generate the cache file
2018-10-02 00:13:47 +02:00
// This function is necessary to call it when you create, edit or remove content
2018-10-01 16:34:28 +02:00
private function createCache()
{
2018-10-02 00:13:47 +02:00
// Get all pages published
2018-10-01 16:34:28 +02:00
global $pages;
2018-10-02 00:13:47 +02:00
$list = $pages->getList($pageNumber = 1, $numberOfItems = -1, $onlyPublished = true);
2018-10-01 16:34:28 +02:00
$cache = array();
foreach ($list as $pageKey) {
$page = buildPage($pageKey);
// Process content
2018-10-02 00:13:47 +02:00
$words = $this->getValue('wordsToCachePerPage') * 5; // Asumming avg of characters per word is 5
2018-10-01 16:34:28 +02:00
$content = $page->content();
$content = Text::removeHTMLTags($content);
2018-10-02 00:13:47 +02:00
$content = Text::truncate($content, $words, '');
2018-10-01 16:34:28 +02:00
2018-10-02 00:13:47 +02:00
// Include the page to the cache
2018-10-01 16:34:28 +02:00
$cache[$pageKey]['title'] = $page->title();
2018-10-02 00:13:47 +02:00
$cache[$pageKey]['description'] = $page->description();
2018-10-01 16:34:28 +02:00
$cache[$pageKey]['content'] = $content;
$cache[$pageKey]['key'] = $pageKey;
}
// Generate JSON file with the cache
$json = json_encode($cache);
return file_put_contents($this->cacheFile(), $json, LOCK_EX);
}
2018-10-02 00:13:47 +02:00
// Returns the absolute path of the cache file
2018-10-01 16:34:28 +02:00
private function cacheFile()
{
return $this->workspace().'cache.json';
}
// Search text inside the cache
2018-10-02 00:13:47 +02:00
// Returns an array with the pages keys related to the text
// The array is sorted by score
2018-10-01 16:34:28 +02:00
private function search($text)
{
2018-10-02 00:13:47 +02:00
// Read the cache file
2018-10-01 16:34:28 +02:00
$json = file_get_contents($this->cacheFile());
$cache = json_decode($json, true);
$found = array();
foreach ($cache as $page) {
$score = 0;
if (Text::stringContains($page['title'], $text, false)) {
$score += 10;
}
2018-10-02 00:13:47 +02:00
if (Text::stringContains($page['description'], $text, false)) {
$score += 7;
}
2018-10-01 16:34:28 +02:00
if (Text::stringContains($page['content'], $text, false)) {
2018-10-02 00:13:47 +02:00
$score += 5;
2018-10-01 16:34:28 +02:00
}
if ($score>0) {
2018-10-02 00:13:47 +02:00
$found[$page['key']] = $score;
2018-10-01 16:34:28 +02:00
}
}
2018-10-02 00:13:47 +02:00
// Sort array by the score, from max to min
arsort($found);
// Returns only the keys of the array contained the page key
return array_keys($found);
2018-10-01 16:34:28 +02:00
}
2018-10-14 12:54:42 +02:00
}