Bladeren bron

Move mod/search to src/Module/Search/Index

- Update BaseSeachModule not to depend on a single query string parameter
tags/2019.12
Hypolite Petovan 9 maanden geleden
bovenliggende
commit
1e737ae888
5 gewijzigde bestanden met toevoegingen van 207 en 198 verwijderingen
  1. +0
    -194
      mod/search.php
  2. +4
    -3
      src/Module/BaseSearchModule.php
  3. +4
    -1
      src/Module/Search/Directory.php
  4. +198
    -0
      src/Module/Search/Index.php
  5. +1
    -0
      static/routes.config.php

+ 0
- 194
mod/search.php Bestand weergeven

@@ -1,194 +0,0 @@
<?php
/**
* @file mod/search.php
*/

use Friendica\App;
use Friendica\Content\Nav;
use Friendica\Content\Pager;
use Friendica\Content\Text\HTML;
use Friendica\Core\Cache;
use Friendica\Core\Config;
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Session;
use Friendica\Core\Renderer;
use Friendica\Database\DBA;
use Friendica\Model\Item;
use Friendica\Module\BaseSearchModule;
use Friendica\Util\Strings;

function search_init(App $a) {
$search = (!empty($_GET['q']) ? Strings::escapeTags(trim(rawurldecode($_GET['q']))) : '');

if (local_user()) {
/// @todo Check if there is a case at all that "aside" is prefilled here
if (!isset($a->page['aside'])) {
$a->page['aside'] = '';
}

$a->page['aside'] .= \Friendica\Content\Widget\SavedSearches::getHTML('search?q=' . $search, $search);
}
}

function search_content(App $a) {
if (Config::get('system','block_public') && !Session::isAuthenticated()) {
notice(L10n::t('Public access denied.') . EOL);
return;
}

if (Config::get('system','local_search') && !Session::isAuthenticated()) {
$e = new \Friendica\Network\HTTPException\ForbiddenException(L10n::t("Only logged in users are permitted to perform a search."));
$e->httpdesc = L10n::t("Public access denied.");
throw $e;
}

if (Config::get('system','permit_crawling') && !Session::isAuthenticated()) {
// Default values:
// 10 requests are "free", after the 11th only a call per minute is allowed

$free_crawls = intval(Config::get('system','free_crawls'));
if ($free_crawls == 0)
$free_crawls = 10;

$crawl_permit_period = intval(Config::get('system','crawl_permit_period'));
if ($crawl_permit_period == 0)
$crawl_permit_period = 10;

$remote = $_SERVER["REMOTE_ADDR"];
$result = Cache::get("remote_search:".$remote);
if (!is_null($result)) {
$resultdata = json_decode($result);
if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
throw new \Friendica\Network\HTTPException\TooManyRequestsException(L10n::t("Only one search per minute is permitted for not logged in users."));
}
Cache::set("remote_search:".$remote, json_encode(["time" => time(), "accesses" => $resultdata->accesses + 1]), Cache::HOUR);
} else
Cache::set("remote_search:".$remote, json_encode(["time" => time(), "accesses" => 1]), Cache::HOUR);
}

Nav::setSelected('search');

$search = (!empty($_REQUEST['q']) ? Strings::escapeTags(trim(rawurldecode($_REQUEST['q']))) : '');

$tag = false;
if (!empty($_GET['tag'])) {
$tag = true;
$search = (!empty($_GET['tag']) ? '#' . Strings::escapeTags(trim(rawurldecode($_GET['tag']))) : '');
}

// contruct a wrapper for the search header
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate("content_wrapper.tpl"),[
'name' => "search-header",
'$title' => L10n::t("Search"),
'$title_size' => 3,
'$content' => HTML::search($search,'search-box',false)
]);

if (strpos($search,'#') === 0) {
$tag = true;
$search = substr($search,1);
}
if (strpos($search,'@') === 0) {
return BaseSearchModule::performSearch();
}
if (strpos($search,'!') === 0) {
return BaseSearchModule::performSearch();
}

if (parse_url($search, PHP_URL_SCHEME) != '') {
$id = Item::fetchByLink($search);
if (!empty($id)) {
$item = Item::selectFirst(['guid'], ['id' => $id]);
if (DBA::isResult($item)) {
$a->internalRedirect('display/' . $item['guid']);
}
}
}

if (!empty($_GET['search-option']))
switch($_GET['search-option']) {
case 'fulltext':
break;
case 'tags':
$tag = true;
break;
case 'contacts':
return BaseSearchModule::performSearch('@');
case 'forums':
return BaseSearchModule::performSearch('!');
}

if (!$search)
return $o;

if (Config::get('system','only_tag_search'))
$tag = true;

// Here is the way permissions work in the search module...
// Only public posts can be shown
// OR your own posts if you are a logged in member
// No items will be shown if the member has a blocked profile wall.

$pager = new Pager($a->query_string);

if ($tag) {
Logger::log("Start tag search for '".$search."'", Logger::DEBUG);

$condition = ["(`uid` = 0 OR (`uid` = ? AND NOT `global`))
AND `otype` = ? AND `type` = ? AND `term` = ?",
local_user(), TERM_OBJ_POST, TERM_HASHTAG, $search];
$params = ['order' => ['received' => true],
'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
$terms = DBA::select('term', ['oid'], $condition, $params);

$itemids = [];
while ($term = DBA::fetch($terms)) {
$itemids[] = $term['oid'];
}
DBA::close($terms);

if (!empty($itemids)) {
$params = ['order' => ['id' => true]];
$items = Item::selectForUser(local_user(), [], ['id' => $itemids], $params);
$r = Item::inArray($items);
} else {
$r = [];
}
} else {
Logger::log("Start fulltext search for '".$search."'", Logger::DEBUG);

$condition = ["(`uid` = 0 OR (`uid` = ? AND NOT `global`))
AND `body` LIKE CONCAT('%',?,'%')",
local_user(), $search];
$params = ['order' => ['id' => true],
'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
$items = Item::selectForUser(local_user(), [], $condition, $params);
$r = Item::inArray($items);
}

if (!DBA::isResult($r)) {
info(L10n::t('No results.') . EOL);
return $o;
}


if ($tag) {
$title = L10n::t('Items tagged with: %s', $search);
} else {
$title = L10n::t('Results for: %s', $search);
}

$o .= Renderer::replaceMacros(Renderer::getMarkupTemplate("section_title.tpl"),[
'$title' => $title
]);

Logger::log("Start Conversation for '".$search."'", Logger::DEBUG);
$o .= conversation($a, $r, $pager, 'search', false, false, 'commented', local_user());

$o .= $pager->renderMinimal(count($r));

Logger::log("Done '".$search."'", Logger::DEBUG);

return $o;
}

+ 4
- 3
src/Module/BaseSearchModule.php Bestand weergeven

@@ -23,13 +23,14 @@ class BaseSearchModule extends BaseModule
/**
* Performs a search with an optional prefix
*
* @param string $search Search query
* @param string $prefix A optional prefix (e.g. @ or !) for searching
*
* @return string
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function performSearch($prefix = '')
public static function performSearch($search, $prefix = '')
{
$a = self::getApp();
$config = $a->getConfig();
@@ -38,7 +39,7 @@ class BaseSearchModule extends BaseModule

$localSearch = $config->get('system', 'poco_local_search');

$search = $prefix . Strings::escapeTags(trim(defaults($_REQUEST, 'search', '')));
$search = $prefix . $search;

if (!$search) {
return '';
@@ -62,7 +63,7 @@ class BaseSearchModule extends BaseModule
$header = L10n::t('Forum Search - %s', $search);
}

$pager = new Pager($a->query_string);
$pager = new Pager(self::getArgs()->getQueryString());

if ($localSearch && empty($results)) {
$pager->setItemsPerPage(80);


+ 4
- 1
src/Module/Search/Directory.php Bestand weergeven

@@ -6,6 +6,7 @@ use Friendica\Content\Widget;
use Friendica\Core\L10n;
use Friendica\Module\BaseSearchModule;
use Friendica\Module\Login;
use Friendica\Util\Strings;

/**
* Directory search module
@@ -19,6 +20,8 @@ class Directory extends BaseSearchModule
return Login::form();
}

$search = Strings::escapeTags(trim(rawurldecode($_REQUEST['search'] ?? '')));

$a = self::getApp();

if (empty($a->page['aside'])) {
@@ -28,6 +31,6 @@ class Directory extends BaseSearchModule
$a->page['aside'] .= Widget::findPeople();
$a->page['aside'] .= Widget::follow();

return self::performSearch();
return self::performSearch($search);
}
}

+ 198
- 0
src/Module/Search/Index.php Bestand weergeven

@@ -0,0 +1,198 @@
<?php

namespace Friendica\Module\Search;

use Friendica\Content\Nav;
use Friendica\Content\Pager;
use Friendica\Content\Text\HTML;
use Friendica\Content\Widget;
use Friendica\Core\Cache;
use Friendica\Core\Cache\Cache as CacheClass;
use Friendica\Core\Config;
use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\Core\Session;
use Friendica\Database\DBA;
use Friendica\Model\Item;
use Friendica\Model\Term;
use Friendica\Module\BaseSearchModule;
use Friendica\Network\HTTPException;
use Friendica\Util\Strings;

class Index extends BaseSearchModule
{
public static function content()
{
$search = (!empty($_GET['q']) ? Strings::escapeTags(trim(rawurldecode($_GET['q']))) : '');

if (Config::get('system', 'block_public') && !Session::isAuthenticated()) {
throw new HTTPException\ForbiddenException(L10n::t('Public access denied.'));
}

if (Config::get('system', 'local_search') && !Session::isAuthenticated()) {
$e = new HTTPException\ForbiddenException(L10n::t('Only logged in users are permitted to perform a search.'));
$e->httpdesc = L10n::t('Public access denied.');
throw $e;
}

if (Config::get('system', 'permit_crawling') && !Session::isAuthenticated()) {
// Default values:
// 10 requests are "free", after the 11th only a call per minute is allowed

$free_crawls = intval(Config::get('system', 'free_crawls'));
if ($free_crawls == 0)
$free_crawls = 10;

$crawl_permit_period = intval(Config::get('system', 'crawl_permit_period'));
if ($crawl_permit_period == 0)
$crawl_permit_period = 10;

$remote = $_SERVER['REMOTE_ADDR'];
$result = Cache::get('remote_search:' . $remote);
if (!is_null($result)) {
$resultdata = json_decode($result);
if (($resultdata->time > (time() - $crawl_permit_period)) && ($resultdata->accesses > $free_crawls)) {
throw new HTTPException\TooManyRequestsException(L10n::t('Only one search per minute is permitted for not logged in users.'));
}
Cache::set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => $resultdata->accesses + 1]), CacheClass::HOUR);
} else {
Cache::set('remote_search:' . $remote, json_encode(['time' => time(), 'accesses' => 1]), CacheClass::HOUR);
}
}

if (local_user()) {
self::getApp()->page['aside'] .= Widget\SavedSearches::getHTML('search?q=' . $search, $search);
}

Nav::setSelected('search');

$tag = false;
if (!empty($_GET['tag'])) {
$tag = true;
$search = '#' . Strings::escapeTags(trim(rawurldecode($_GET['tag'])));
}

// contruct a wrapper for the search header
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate('content_wrapper.tpl'), [
'name' => 'search-header',
'$title' => L10n::t('Search'),
'$title_size' => 3,
'$content' => HTML::search($search, 'search-box', false)
]);

if (strpos($search, '#') === 0) {
$tag = true;
$search = substr($search, 1);
}

if (strpos($search, '@') === 0 || strpos($search, '!') === 0) {
return self::performSearch($search);
}

if (parse_url($search, PHP_URL_SCHEME) != '') {
$id = Item::fetchByLink($search);
if (!empty($id)) {
$item = Item::selectFirst(['guid'], ['id' => $id]);
if (DBA::isResult($item)) {
self::getApp()->internalRedirect('display/' . $item['guid']);
}
}
}

if (!empty($_GET['search-option'])) {
switch ($_GET['search-option']) {
case 'fulltext':
break;
case 'tags':
$tag = true;
break;
case 'contacts':
return self::performSearch($search, '@');
case 'forums':
return self::performSearch($search, '!');
}
}

if (!$search) {
return $o;
}

$tag = $tag || Config::get('system', 'only_tag_search');

// Here is the way permissions work in the search module...
// Only public posts can be shown
// OR your own posts if you are a logged in member
// No items will be shown if the member has a blocked profile wall.

$pager = new Pager(self::getArgs()->getQueryString());

if ($tag) {
Logger::info('Start tag search for "' . $search . '"');

$condition = [
"(`uid` = 0 OR (`uid` = ? AND NOT `global`))
AND `otype` = ? AND `type` = ? AND `term` = ?",
local_user(), Term::OBJECT_TYPE_POST, Term::HASHTAG, $search
];
$params = [
'order' => ['received' => true],
'limit' => [$pager->getStart(), $pager->getItemsPerPage()]
];
$terms = DBA::select('term', ['oid'], $condition, $params);

$itemids = [];
while ($term = DBA::fetch($terms)) {
$itemids[] = $term['oid'];
}

DBA::close($terms);

if (!empty($itemids)) {
$params = ['order' => ['id' => true]];
$items = Item::selectForUser(local_user(), [], ['id' => $itemids], $params);
$r = Item::inArray($items);
} else {
$r = [];
}
} else {
Logger::info('Start fulltext search for "' . $search . '"');

$condition = [
"(`uid` = 0 OR (`uid` = ? AND NOT `global`))
AND `body` LIKE CONCAT('%',?,'%')",
local_user(), $search
];
$params = [
'order' => ['id' => true],
'limit' => [$pager->getStart(), $pager->getItemsPerPage()]
];
$items = Item::selectForUser(local_user(), [], $condition, $params);
$r = Item::inArray($items);
}

if (!DBA::isResult($r)) {
info(L10n::t('No results.'));
return $o;
}

if ($tag) {
$title = L10n::t('Items tagged with: %s', $search);
} else {
$title = L10n::t('Results for: %s', $search);
}

$o .= Renderer::replaceMacros(Renderer::getMarkupTemplate('section_title.tpl'), [
'$title' => $title
]);

Logger::info('Start Conversation for "' . $search . '"');
$o .= conversation(self::getApp(), $r, $pager, 'search', false, false, 'commented', local_user());

$o .= $pager->renderMinimal(count($r));

Logger::info('Done "'.$search.'"');

return $o;
}
}

+ 1
- 0
static/routes.config.php Bestand weergeven

@@ -189,6 +189,7 @@ return [
],

'/search' => [
'[/]' => [Module\Search\Index::class, [R::GET]],
'/acl' => [Module\Search\Acl::class, [R::GET, R::POST]],
'/saved/add/{term}' => [Module\Search\Saved::class, [R::GET]],
'/saved/remove/{term}' => [Module\Search\Saved::class, [R::GET]],


Laden…
Annuleren
Opslaan