src/Core/Search.php

   1 <?php
   2
   3 namespace Friendica\Core;
   4
   5 use Friendica\BaseObject;
   6 use Friendica\Database\DBA;
   7 use Friendica\Model\Contact;
   8 use Friendica\Network\HTTPException;
   9 use Friendica\Network\Probe;
  10 use Friendica\Object\Search\ContactResult;
  11 use Friendica\Object\Search\ResultList;
  12 use Friendica\Protocol\PortableContact;
  13 use Friendica\Util\Network;
  14 use Friendica\Util\Strings;
  15
  16 /**
  17  * Specific class to perform searches for different systems. Currently:
  18  * - Probe for contacts
  19  * - Search in the local directory
  20  * - Search in the global directory
  21  */
  22 class Search extends BaseObject
  23 {
  24         const DEFAULT_DIRECTORY = 'https://dir.friendica.social';
  25
  26         const TYPE_PEOPLE = 0;
  27         const TYPE_FORUM  = 1;
  28         const TYPE_ALL    = 2;
  29
  30         /**
  31          * Search a user based on his/her profile address
  32          * pattern: @username@domain.tld
  33          *
  34          * @param string $user The user to search for
  35          *
  36          * @return ResultList
  37          * @throws HTTPException\InternalServerErrorException
  38          * @throws \ImagickException
  39          */
  40         public static function getContactsFromProbe($user)
  41         {
  42                 $emptyResultList = new ResultList(1, 0, 1);
  43
  44                 if ((filter_var($user, FILTER_VALIDATE_EMAIL) && Network::isEmailDomainValid($user)) ||
  45                     (substr(Strings::normaliseLink($user), 0, 7) == "http://")) {
  46
  47                         /// @todo Possibly use "getIdForURL" instead?
  48                         $user_data = Probe::uri($user);
  49                         if (empty($user_data)) {
  50                                 return $emptyResultList;
  51                         }
  52
  53                         if (!in_array($user_data["network"], Protocol::FEDERATED)) {
  54                                 return $emptyResultList;
  55                         }
  56
  57                         // Ensure that we do have a contact entry
  58                         Contact::getIdForURL(defaults($user_data, 'url', ''));
  59
  60                         $contactDetails = Contact::getDetailsByURL(defaults($user_data, 'url', ''), local_user());
  61                         $itemUrl        = defaults($contactDetails, 'addr', defaults($user_data, 'url', ''));
  62
  63                         $result = new ContactResult(
  64                                 defaults($user_data, 'name', ''),
  65                                 defaults($user_data, 'addr', ''),
  66                                 $itemUrl,
  67                                 defaults($user_data, 'url', ''),
  68                                 defaults($user_data, 'photo', ''),
  69                                 defaults($user_data, 'network', ''),
  70                                 defaults($contactDetails, 'id', 0),
  71                                 0,
  72                                 defaults($user_data, 'tags', '')
  73                         );
  74
  75                         return new ResultList(1, 1, 1, [$result]);
  76                 } else {
  77                         return $emptyResultList;
  78                 }
  79         }
  80
  81         /**
  82          * Search in the global directory for occurrences of the search string
  83          *
  84          * @see https://github.com/friendica/friendica-directory/blob/master/docs/Protocol.md#search
  85          *
  86          * @param string $search
  87          * @param int    $type specific type of searching
  88          * @param int    $page
  89          *
  90          * @return ResultList
  91          * @throws HTTPException\InternalServerErrorException
  92          */
  93         public static function getContactsFromGlobalDirectory($search, $type = self::TYPE_ALL, $page = 1)
  94         {
  95                 $config = self::getApp()->getConfig();
  96                 $server = $config->get('system', 'directory', self::DEFAULT_DIRECTORY);
  97
  98                 $searchUrl = $server . '/search';
  99
 100                 switch ($type) {
 101                         case self::TYPE_FORUM:
 102                                 $searchUrl .= '/forum';
 103                                 break;
 104                         case self::TYPE_PEOPLE:
 105                                 $searchUrl .= '/people';
 106                                 break;
 107                 }
 108                 $searchUrl .= '?q=' . urlencode($search);
 109
 110                 if ($page > 1) {
 111                         $searchUrl .= '&page=' . $page;
 112                 }
 113
 114                 $resultJson = Network::fetchUrl($searchUrl, false, 0, 'application/json');
 115
 116                 $results = json_decode($resultJson, true);
 117
 118                 $resultList = new ResultList(
 119                         defaults($results, 'page', 1),
 120                         defaults($results, 'count', 0),
 121                         defaults($results, 'itemsperpage', 30)
 122                 );
 123
 124                 $profiles = defaults($results, 'profiles', []);
 125
 126                 foreach ($profiles as $profile) {
 127                         $contactDetails = Contact::getDetailsByURL(defaults($profile, 'profile_url', ''), local_user());
 128                         $itemUrl        = defaults($contactDetails, 'addr', defaults($profile, 'profile_url', ''));
 129
 130                         $result = new ContactResult(
 131                                 defaults($profile, 'name', ''),
 132                                 defaults($profile, 'addr', ''),
 133                                 $itemUrl,
 134                                 defaults($profile, 'profile_url', ''),
 135                                 defaults($profile, 'photo', ''),
 136                                 Protocol::DFRN,
 137                                 defaults($contactDetails, 'cid', 0),
 138                                 0,
 139                                 defaults($profile, 'tags', ''));
 140
 141                         $resultList->addResult($result);
 142                 }
 143
 144                 return $resultList;
 145         }
 146
 147         /**
 148          * Search in the local database for occurrences of the search string
 149          *
 150          * @param string $search
 151          * @param int    $type
 152          * @param int    $start
 153          * @param int    $itemPage
 154          *
 155          * @return ResultList
 156          * @throws HTTPException\InternalServerErrorException
 157          */
 158         public static function getContactsFromLocalDirectory($search, $type = self::TYPE_ALL, $start = 0, $itemPage = 80)
 159         {
 160                 $config = self::getApp()->getConfig();
 161
 162                 $diaspora = $config->get('system', 'diaspora_enabled') ? Protocol::DIASPORA : Protocol::DFRN;
 163                 $ostatus  = !$config->get('system', 'ostatus_disabled') ? Protocol::OSTATUS : Protocol::DFRN;
 164
 165                 $wildcard = Strings::escapeHtml('%' . $search . '%');
 166
 167                 $count = DBA::count('gcontact', [
 168                         'NOT `hide`
 169                         AND `network` IN (?, ?, ?, ?)
 170                         AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
 171                         AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
 172                                 OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
 173                         AND `community` = ?',
 174                         Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
 175                         $wildcard, $wildcard, $wildcard,
 176                         $wildcard, $wildcard, $wildcard,
 177                         ($type === self::TYPE_FORUM),
 178                 ]);
 179
 180                 $resultList = new ResultList($start, $itemPage, $count);
 181
 182                 if (empty($count)) {
 183                         return $resultList;
 184                 }
 185
 186                 $data = DBA::select('gcontact', ['nurl'], [
 187                         'NOT `hide`
 188                         AND `network` IN (?, ?, ?, ?)
 189                         AND ((`last_contact` >= `last_failure`) OR (`updated` >= `last_failure`))
 190                         AND (`url` LIKE ? OR `name` LIKE ? OR `location` LIKE ?
 191                                 OR `addr` LIKE ? OR `about` LIKE ? OR `keywords` LIKE ?)
 192                         AND `community` = ?',
 193                         Protocol::ACTIVITYPUB, Protocol::DFRN, $ostatus, $diaspora,
 194                         $wildcard, $wildcard, $wildcard,
 195                         $wildcard, $wildcard, $wildcard,
 196                         ($type === self::TYPE_FORUM),
 197                 ], [
 198                         'group_by' => ['nurl', 'updated'],
 199                         'limit'    => [$start, $itemPage],
 200                         'order'    => ['updated' => 'DESC']
 201                 ]);
 202
 203                 if (!DBA::isResult($data)) {
 204                         return $resultList;
 205                 }
 206
 207                 while ($row = DBA::fetch($data)) {
 208                         if (PortableContact::alternateOStatusUrl($row["nurl"])) {
 209                                 continue;
 210                         }
 211
 212                         $urlParts = parse_url($row["nurl"]);
 213
 214                         // Ignore results that look strange.
 215                         // For historic reasons the gcontact table does contain some garbage.
 216                         if (!empty($urlParts['query']) || !empty($urlParts['fragment'])) {
 217                                 continue;
 218                         }
 219
 220                         $contact = Contact::getDetailsByURL($row["nurl"], local_user());
 221
 222                         if ($contact["name"] == "") {
 223                                 $contact["name"] = end(explode("/", $urlParts["path"]));
 224                         }
 225
 226                         $result = new ContactResult(
 227                                 $contact["name"],
 228                                 $contact["addr"],
 229                                 $contact["addr"],
 230                                 $contact["url"],
 231                                 $contact["photo"],
 232                                 $contact["network"],
 233                                 $contact["cid"],
 234                                 $contact["zid"],
 235                                 $contact["keywords"]
 236                         );
 237
 238                         $resultList->addResult($result);
 239                 }
 240
 241                 DBA::close($data);
 242
 243                 // Add found profiles from the global directory to the local directory
 244                 Worker::add(PRIORITY_LOW, 'DiscoverPoCo', "dirsearch", urlencode($search));
 245
 246                 return $resultList;
 247         }
 248 }