src/Module/BaseSearch.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module;
  23
  24 use Friendica\BaseModule;
  25 use Friendica\Content\Pager;
  26 use Friendica\Core\Renderer;
  27 use Friendica\Core\Search;
  28 use Friendica\DI;
  29 use Friendica\Model;
  30 use Friendica\Network\HTTPException;
  31 use Friendica\Object\Search\ContactResult;
  32 use Friendica\Object\Search\ResultList;
  33 use Friendica\Util\Network;
  34
  35 /**
  36  * Base class for search modules
  37  */
  38 class BaseSearch extends BaseModule
  39 {
  40         /**
  41          * Performs a contact search with an optional prefix
  42          *
  43          * @param string $search Search query
  44          * @param string $prefix A optional prefix (e.g. @ or !) for searching
  45          *
  46          * @return string
  47          * @throws HTTPException\InternalServerErrorException
  48          * @throws \ImagickException
  49          */
  50         public static function performContactSearch($search, $prefix = '')
  51         {
  52                 $config = DI::config();
  53
  54                 $type = Search::TYPE_ALL;
  55
  56                 $localSearch = $config->get('system', 'poco_local_search');
  57
  58                 $search = $prefix . $search;
  59
  60                 if (!$search) {
  61                         return '';
  62                 }
  63
  64                 $header = '';
  65
  66                 if (strpos($search, '@') === 0) {
  67                         $search  = substr($search, 1);
  68                         $type    = Search::TYPE_PEOPLE;
  69                         $header  = DI::l10n()->t('People Search - %s', $search);
  70
  71                         if (strrpos($search, '@') > 0) {
  72                                 $results = Search::getContactsFromProbe(Network::convertToIdn($search));
  73                         }
  74                 }
  75
  76                 if (strpos($search, '!') === 0) {
  77                         $search = substr($search, 1);
  78                         $type   = Search::TYPE_FORUM;
  79                         $header = DI::l10n()->t('Forum Search - %s', $search);
  80                 }
  81
  82                 $search = Network::convertToIdn($search);
  83
  84                 if (DI::mode()->isMobile()) {
  85                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
  86                                 DI::config()->get('system', 'itemspage_network_mobile'));
  87                 } else {
  88                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
  89                                 DI::config()->get('system', 'itemspage_network'));
  90                 }
  91
  92                 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
  93
  94                 if ($localSearch && empty($results)) {
  95                         $pager->setItemsPerPage(80);
  96                         $results = Search::getContactsFromLocalDirectory($search, $type, $pager->getStart(), $pager->getItemsPerPage());
  97                 } elseif (Search::getGlobalDirectory() && empty($results)) {
  98                         $results = Search::getContactsFromGlobalDirectory($search, $type, $pager->getPage());
  99                         $pager->setItemsPerPage($results->getItemsPage());
 100                 }
 101
 102                 return self::printResult($results, $pager, $header);
 103         }
 104
 105         /**
 106          * Prints a human readable search result
 107          *
 108          * @param ResultList $results
 109          * @param Pager      $pager
 110          * @param string     $header
 111          *
 112          * @return string The result
 113          * @throws HTTPException\InternalServerErrorException
 114          * @throws \ImagickException
 115          */
 116         protected static function printResult(ResultList $results, Pager $pager, $header = '')
 117         {
 118                 if ($results->getTotal() == 0) {
 119                         notice(DI::l10n()->t('No matches'));
 120                         return '';
 121                 }
 122
 123                 $entries = [];
 124                 foreach ($results->getResults() as $result) {
 125
 126                         // in case the result is a contact result, add a contact-specific entry
 127                         if ($result instanceof ContactResult) {
 128                                 $contact = Model\Contact::getByURLForUser($result->getUrl(), local_user());
 129                                 if (!empty($contact)) {
 130                                         $entries[] = Contact::getContactTemplateVars($contact);
 131                                 }
 132                         }
 133                 }
 134
 135                 $tpl = Renderer::getMarkupTemplate('viewcontact_template.tpl');
 136                 return Renderer::replaceMacros($tpl, [
 137                         'title'     => $header,
 138                         '$contacts' => $entries,
 139                         '$paginate' => $pager->renderFull($results->getTotal()),
 140                 ]);
 141         }
 142 }