src/Model/Term.php

   1 <?php
   2 /**
   3  * @file src/Model/Term
   4  */
   5 namespace Friendica\Model;
   6
   7 use Friendica\Core\System;
   8 use Friendica\Database\DBA;
   9
  10 require_once 'boot.php';
  11 require_once 'include/conversation.php';
  12 require_once 'include/dba.php';
  13
  14 class Term
  15 {
  16         public static function tagTextFromItemId($itemid)
  17         {
  18                 $tag_text = '';
  19                 $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_HASHTAG, TERM_MENTION]];
  20                 $tags = DBA::select('term', [], $condition);
  21                 while ($tag = DBA::fetch($tags)) {
  22                         if ($tag_text != '') {
  23                                 $tag_text .= ',';
  24                         }
  25
  26                         if ($tag['type'] == 1) {
  27                                 $tag_text .= '#';
  28                         } else {
  29                                 $tag_text .= '@';
  30                         }
  31                         $tag_text .= '[url=' . $tag['url'] . ']' . $tag['term'] . '[/url]';
  32                 }
  33                 return $tag_text;
  34         }
  35
  36         public static function tagArrayFromItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
  37         {
  38                 $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type];
  39                 $tags = DBA::select('term', ['type', 'term', 'url'], $condition);
  40                 if (!DBA::isResult($tags)) {
  41                         return [];
  42                 }
  43
  44                 return DBA::toArray($tags);
  45         }
  46
  47         public static function fileTextFromItemId($itemid)
  48         {
  49                 $file_text = '';
  50                 $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_FILE, TERM_CATEGORY]];
  51                 $tags = DBA::select('term', [], $condition);
  52                 while ($tag = DBA::fetch($tags)) {
  53                         if ($tag['type'] == TERM_CATEGORY) {
  54                                 $file_text .= '<' . $tag['term'] . '>';
  55                         } else {
  56                                 $file_text .= '[' . $tag['term'] . ']';
  57                         }
  58                 }
  59                 return $file_text;
  60         }
  61
  62         public static function insertFromTagFieldByItemId($itemid, $tags)
  63         {
  64                 $profile_base = System::baseUrl();
  65                 $profile_data = parse_url($profile_base);
  66                 $profile_path = defaults($profile_data, 'path', '');
  67                 $profile_base_friendica = $profile_data['host'] . $profile_path . '/profile/';
  68                 $profile_base_diaspora = $profile_data['host'] . $profile_path . '/u/';
  69
  70                 $fields = ['guid', 'uid', 'id', 'edited', 'deleted', 'created', 'received', 'title', 'body', 'parent'];
  71                 $message = Item::selectFirst($fields, ['id' => $itemid]);
  72                 if (!DBA::isResult($message)) {
  73                         return;
  74                 }
  75
  76                 $message['tag'] = $tags;
  77
  78                 // Clean up all tags
  79                 self::deleteByItemId($itemid);
  80
  81                 if ($message['deleted']) {
  82                         return;
  83                 }
  84
  85                 $taglist = explode(',', $message['tag']);
  86
  87                 $tags_string = '';
  88                 foreach ($taglist as $tag) {
  89                         if ((substr(trim($tag), 0, 1) == '#') || (substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
  90                                 $tags_string .= ' ' . trim($tag);
  91                         } else {
  92                                 $tags_string .= ' #' . trim($tag);
  93                         }
  94                 }
  95
  96                 $data = ' ' . $message['title'] . ' ' . $message['body'] . ' ' . $tags_string . ' ';
  97
  98                 // ignore anything in a code block
  99                 $data = preg_replace('/\[code\](.*?)\[\/code\]/sm', '', $data);
 100
 101                 $tags = [];
 102
 103                 $pattern = '/\W\#([^\[].*?)[\s\'".,:;\?!\[\]\/]/ism';
 104                 if (preg_match_all($pattern, $data, $matches)) {
 105                         foreach ($matches[1] as $match) {
 106                                 $tags['#' . $match] = '';
 107                         }
 108                 }
 109
 110                 $pattern = '/\W([\#@!])\[url\=(.*?)\](.*?)\[\/url\]/ism';
 111                 if (preg_match_all($pattern, $data, $matches, PREG_SET_ORDER)) {
 112                         foreach ($matches as $match) {
 113
 114                                 if (($match[1] == '@') || ($match[1] == '!')) {
 115                                         $contact = Contact::getDetailsByURL($match[2], 0);
 116                                         if (!empty($contact['addr'])) {
 117                                                 $match[3] = $contact['addr'];
 118                                         }
 119
 120                                         if (!empty($contact['url'])) {
 121                                                 $match[2] = $contact['url'];
 122                                         }
 123                                 }
 124
 125                                 $tags[$match[1] . trim($match[3], ',.:;[]/\"?!')] = $match[2];
 126                         }
 127                 }
 128
 129                 foreach ($tags as $tag => $link) {
 130                         if (substr(trim($tag), 0, 1) == '#') {
 131                                 // try to ignore #039 or #1 or anything like that
 132                                 if (ctype_digit(substr(trim($tag), 1))) {
 133                                         continue;
 134                                 }
 135
 136                                 // try to ignore html hex escapes, e.g. #x2317
 137                                 if ((substr(trim($tag), 1, 1) == 'x' || substr(trim($tag), 1, 1) == 'X') && ctype_digit(substr(trim($tag), 2))) {
 138                                         continue;
 139                                 }
 140
 141                                 $type = TERM_HASHTAG;
 142                                 $term = substr($tag, 1);
 143                                 $link = '';
 144                         } elseif ((substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
 145                                 $type = TERM_MENTION;
 146
 147                                 $contact = Contact::getDetailsByURL($link, 0);
 148                                 if (!empty($contact['name'])) {
 149                                         $term = $contact['name'];
 150                                 } else {
 151                                         $term = substr($tag, 1);
 152                                 }
 153                         } else { // This shouldn't happen
 154                                 $type = TERM_HASHTAG;
 155                                 $term = $tag;
 156                                 $link = '';
 157                         }
 158
 159                         if (DBA::exists('term', ['uid' => $message['uid'], 'otype' => TERM_OBJ_POST, 'oid' => $itemid, 'url' => $link])) {
 160                                 continue;
 161                         }
 162
 163                         if ($message['uid'] == 0) {
 164                                 $global = true;
 165                                 DBA::update('term', ['global' => true], ['otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
 166                         } else {
 167                                 $global = DBA::exists('term', ['uid' => 0, 'otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
 168                         }
 169
 170                         DBA::insert('term', [
 171                                 'uid'      => $message['uid'],
 172                                 'oid'      => $itemid,
 173                                 'otype'    => TERM_OBJ_POST,
 174                                 'type'     => $type,
 175                                 'term'     => $term,
 176                                 'url'      => $link,
 177                                 'guid'     => $message['guid'],
 178                                 'created'  => $message['created'],
 179                                 'received' => $message['received'],
 180                                 'global'   => $global
 181                         ]);
 182
 183                         // Search for mentions
 184                         if (((substr($tag, 0, 1) == '@') || (substr($tag, 0, 1) == '!')) && (strpos($link, $profile_base_friendica) || strpos($link, $profile_base_diaspora))) {
 185                                 $users = q("SELECT `uid` FROM `contact` WHERE self AND (`url` = '%s' OR `nurl` = '%s')", $link, $link);
 186                                 foreach ($users AS $user) {
 187                                         if ($user['uid'] == $message['uid']) {
 188                                                 /// @todo This function is called frim Item::update - so we mustn't call that function here
 189                                                 DBA::update('item', ['mention' => true], ['id' => $itemid]);
 190                                                 DBA::update('thread', ['mention' => true], ['iid' => $message['parent']]);
 191                                         }
 192                                 }
 193                         }
 194                 }
 195         }
 196
 197         /**
 198          * @param integer $itemid item id
 199          * @return void
 200          */
 201         public static function insertFromFileFieldByItemId($itemid, $files)
 202         {
 203                 $message = Item::selectFirst(['uid', 'deleted'], ['id' => $itemid]);
 204                 if (!DBA::isResult($message)) {
 205                         return;
 206                 }
 207
 208                 // Clean up all tags
 209                 DBA::delete('term', ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_FILE, TERM_CATEGORY]]);
 210
 211                 if ($message["deleted"]) {
 212                         return;
 213                 }
 214
 215                 $message['file'] = $files;
 216
 217                 if (preg_match_all("/\[(.*?)\]/ism", $message["file"], $files)) {
 218                         foreach ($files[1] as $file) {
 219                                 DBA::insert('term', [
 220                                         'uid' => $message["uid"],
 221                                         'oid' => $itemid,
 222                                         'otype' => TERM_OBJ_POST,
 223                                         'type' => TERM_FILE,
 224                                         'term' => $file
 225                                 ]);
 226                         }
 227                 }
 228
 229                 if (preg_match_all("/\<(.*?)\>/ism", $message["file"], $files)) {
 230                         foreach ($files[1] as $file) {
 231                                 DBA::insert('term', [
 232                                         'uid' => $message["uid"],
 233                                         'oid' => $itemid,
 234                                         'otype' => TERM_OBJ_POST,
 235                                         'type' => TERM_CATEGORY,
 236                                         'term' => $file
 237                                 ]);
 238                         }
 239                 }
 240         }
 241
 242         /**
 243          * Sorts an item's tags into mentions, hashtags and other tags. Generate personalized URLs by user and modify the
 244          * provided item's body with them.
 245          *
 246          * @param array $item
 247          * @return array
 248          */
 249         public static function populateTagsFromItem(&$item)
 250         {
 251                 $return = [
 252                         'tags' => [],
 253                         'hashtags' => [],
 254                         'mentions' => [],
 255                 ];
 256
 257                 $searchpath = System::baseUrl() . "/search?tag=";
 258
 259                 $taglist = DBA::select(
 260                         'term',
 261                         ['type', 'term', 'url'],
 262                         ["`otype` = ? AND `oid` = ? AND `type` IN (?, ?)", TERM_OBJ_POST, $item['id'], TERM_HASHTAG, TERM_MENTION],
 263                         ['order' => ['tid']]
 264                 );
 265
 266                 while ($tag = DBA::fetch($taglist)) {
 267                         if ($tag['url'] == '') {
 268                                 $tag['url'] = $searchpath . rawurlencode($tag['term']);
 269                         }
 270
 271                         $orig_tag = $tag['url'];
 272
 273                         $author = ['uid' => 0, 'id' => $item['author-id'],
 274                                 'network' => $item['author-network'], 'url' => $item['author-link']];
 275                         $tag['url'] = Contact::magicLinkByContact($author, $tag['url']);
 276
 277                         if ($tag['type'] == TERM_HASHTAG) {
 278                                 if ($orig_tag != $tag['url']) {
 279                                         $item['body'] = str_replace($orig_tag, $tag['url'], $item['body']);
 280                                 }
 281
 282                                 $return['hashtags'][] = '#<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
 283                                 $prefix = '#';
 284                         } elseif ($tag['type'] == TERM_MENTION) {
 285                                 $return['mentions'][] = '@<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
 286                                 $prefix = '@';
 287                         }
 288
 289                         $return['tags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
 290                 }
 291                 DBA::close($taglist);
 292
 293                 return $return;
 294         }
 295
 296         /**
 297          * Delete all tags from an item
 298          * @param int itemid - choose from which item the tags will be removed
 299          * @param array type - items type. default is [TERM_HASHTAG, TERM_MENTION]
 300          */
 301         public static function deleteByItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
 302         {
 303                 if (empty($itemid)) {
 304                         return;
 305                 }
 306
 307                 // Clean up all tags
 308                 DBA::delete('term', ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type]);
 309
 310         }
 311 }