<?php
/**
- * @file src/Model/Term
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Model;
-use Friendica\Core\System;
use Friendica\Database\DBA;
+/**
+ * Class Term
+ *
+ * This Model class handles term table interactions.
+ * This tables stores relevant terms related to posts, photos and searches, like hashtags, mentions and
+ * user-applied categories.
+ */
class Term
{
- public static function tagTextFromItemId($itemid)
- {
- $tag_text = '';
- $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_HASHTAG, TERM_MENTION]];
- $tags = DBA::select('term', [], $condition);
- while ($tag = DBA::fetch($tags)) {
- if ($tag_text != '') {
- $tag_text .= ',';
- }
-
- if ($tag['type'] == 1) {
- $tag_text .= '#';
- } else {
- $tag_text .= '@';
- }
- $tag_text .= '[url=' . $tag['url'] . ']' . $tag['term'] . '[/url]';
- }
- return $tag_text;
- }
-
- public static function tagArrayFromItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
- {
- $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type];
- $tags = DBA::select('term', ['type', 'term', 'url'], $condition);
- if (!DBA::isResult($tags)) {
- return [];
- }
+ const UNKNOWN = 0;
+ const CATEGORY = 3;
+ const FILE = 5;
- return DBA::toArray($tags);
- }
+ const OBJECT_TYPE_POST = 1;
- public static function fileTextFromItemId($itemid)
+ /**
+ * Generates the legacy item.file field string from an item ID.
+ * Includes only file and category terms.
+ *
+ * @param int $item_id
+ * @return string
+ * @throws \Exception
+ */
+ public static function fileTextFromItemId($item_id)
{
$file_text = '';
- $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_FILE, TERM_CATEGORY]];
- $tags = DBA::select('term', [], $condition);
- while ($tag = DBA::fetch($tags)) {
- if ($tag['type'] == TERM_CATEGORY) {
+
+ $condition = ['otype' => self::OBJECT_TYPE_POST, 'oid' => $item_id, 'type' => [self::FILE, self::CATEGORY]];
+ $tags = DBA::selectToArray('term', ['type', 'term', 'url'], $condition);
+ foreach ($tags as $tag) {
+ if ($tag['type'] == self::CATEGORY) {
$file_text .= '<' . $tag['term'] . '>';
} else {
$file_text .= '[' . $tag['term'] . ']';
}
}
- return $file_text;
- }
-
- public static function insertFromTagFieldByItemId($itemid, $tags)
- {
- $profile_base = System::baseUrl();
- $profile_data = parse_url($profile_base);
- $profile_path = defaults($profile_data, 'path', '');
- $profile_base_friendica = $profile_data['host'] . $profile_path . '/profile/';
- $profile_base_diaspora = $profile_data['host'] . $profile_path . '/u/';
-
- $fields = ['guid', 'uid', 'id', 'edited', 'deleted', 'created', 'received', 'title', 'body', 'parent'];
- $message = Item::selectFirst($fields, ['id' => $itemid]);
- if (!DBA::isResult($message)) {
- return;
- }
-
- $message['tag'] = $tags;
-
- // Clean up all tags
- self::deleteByItemId($itemid);
-
- if ($message['deleted']) {
- return;
- }
-
- $taglist = explode(',', $message['tag']);
-
- $tags_string = '';
- foreach ($taglist as $tag) {
- if ((substr(trim($tag), 0, 1) == '#') || (substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
- $tags_string .= ' ' . trim($tag);
- } else {
- $tags_string .= ' #' . trim($tag);
- }
- }
-
- $data = ' ' . $message['title'] . ' ' . $message['body'] . ' ' . $tags_string . ' ';
-
- // ignore anything in a code block
- $data = preg_replace('/\[code\](.*?)\[\/code\]/sm', '', $data);
-
- $tags = [];
-
- $pattern = '/\W\#([^\[].*?)[\s\'".,:;\?!\[\]\/]/ism';
- if (preg_match_all($pattern, $data, $matches)) {
- foreach ($matches[1] as $match) {
- $tags['#' . $match] = '';
- }
- }
-
- $pattern = '/\W([\#@!])\[url\=(.*?)\](.*?)\[\/url\]/ism';
- if (preg_match_all($pattern, $data, $matches, PREG_SET_ORDER)) {
- foreach ($matches as $match) {
- if (($match[1] == '@') || ($match[1] == '!')) {
- $contact = Contact::getDetailsByURL($match[2], 0);
- if (!empty($contact['addr'])) {
- $match[3] = $contact['addr'];
- }
-
- if (!empty($contact['url'])) {
- $match[2] = $contact['url'];
- }
- }
-
- $tags[$match[1] . trim($match[3], ',.:;[]/\"?!')] = $match[2];
- }
- }
-
- foreach ($tags as $tag => $link) {
- if (substr(trim($tag), 0, 1) == '#') {
- // try to ignore #039 or #1 or anything like that
- if (ctype_digit(substr(trim($tag), 1))) {
- continue;
- }
-
- // try to ignore html hex escapes, e.g. #x2317
- if ((substr(trim($tag), 1, 1) == 'x' || substr(trim($tag), 1, 1) == 'X') && ctype_digit(substr(trim($tag), 2))) {
- continue;
- }
-
- $type = TERM_HASHTAG;
- $term = substr($tag, 1);
- $link = '';
- } elseif ((substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
- $type = TERM_MENTION;
-
- $contact = Contact::getDetailsByURL($link, 0);
- if (!empty($contact['name'])) {
- $term = $contact['name'];
- } else {
- $term = substr($tag, 1);
- }
- } else { // This shouldn't happen
- $type = TERM_HASHTAG;
- $term = $tag;
- $link = '';
- }
-
- if (DBA::exists('term', ['uid' => $message['uid'], 'otype' => TERM_OBJ_POST, 'oid' => $itemid, 'term' => $term])) {
- continue;
- }
-
- if ($message['uid'] == 0) {
- $global = true;
- DBA::update('term', ['global' => true], ['otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
- } else {
- $global = DBA::exists('term', ['uid' => 0, 'otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
- }
-
- DBA::insert('term', [
- 'uid' => $message['uid'],
- 'oid' => $itemid,
- 'otype' => TERM_OBJ_POST,
- 'type' => $type,
- 'term' => $term,
- 'url' => $link,
- 'guid' => $message['guid'],
- 'created' => $message['created'],
- 'received' => $message['received'],
- 'global' => $global
- ]);
-
- // Search for mentions
- if (((substr($tag, 0, 1) == '@') || (substr($tag, 0, 1) == '!')) && (strpos($link, $profile_base_friendica) || strpos($link, $profile_base_diaspora))) {
- $users = q("SELECT `uid` FROM `contact` WHERE self AND (`url` = '%s' OR `nurl` = '%s')", $link, $link);
- foreach ($users AS $user) {
- if ($user['uid'] == $message['uid']) {
- /// @todo This function is called frim Item::update - so we mustn't call that function here
- DBA::update('item', ['mention' => true], ['id' => $itemid]);
- DBA::update('thread', ['mention' => true], ['iid' => $message['parent']]);
- }
- }
- }
- }
+ return $file_text;
}
/**
- * @param integer $itemid item id
+ * Inserts new terms for the provided item ID based on the legacy item.file field BBCode content.
+ * Deletes all previous file terms for the same item ID.
+ *
+ * @param integer $item_id item id
* @param $files
* @return void
* @throws \Exception
*/
- public static function insertFromFileFieldByItemId($itemid, $files)
+ public static function insertFromFileFieldByItemId($item_id, $files)
{
- $message = Item::selectFirst(['uid', 'deleted'], ['id' => $itemid]);
+ $message = Item::selectFirst(['uid', 'deleted'], ['id' => $item_id]);
if (!DBA::isResult($message)) {
return;
}
// Clean up all tags
- DBA::delete('term', ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => [TERM_FILE, TERM_CATEGORY]]);
+ DBA::delete('term', ['otype' => self::OBJECT_TYPE_POST, 'oid' => $item_id, 'type' => [self::FILE, self::CATEGORY]]);
if ($message["deleted"]) {
return;
foreach ($files[1] as $file) {
DBA::insert('term', [
'uid' => $message["uid"],
- 'oid' => $itemid,
- 'otype' => TERM_OBJ_POST,
- 'type' => TERM_FILE,
+ 'oid' => $item_id,
+ 'otype' => self::OBJECT_TYPE_POST,
+ 'type' => self::FILE,
'term' => $file
]);
}
foreach ($files[1] as $file) {
DBA::insert('term', [
'uid' => $message["uid"],
- 'oid' => $itemid,
- 'otype' => TERM_OBJ_POST,
- 'type' => TERM_CATEGORY,
+ 'oid' => $item_id,
+ 'otype' => self::OBJECT_TYPE_POST,
+ 'type' => self::CATEGORY,
'term' => $file
]);
}
}
}
-
- /**
- * Sorts an item's tags into mentions, hashtags and other tags. Generate personalized URLs by user and modify the
- * provided item's body with them.
- *
- * @param array $item
- * @return array
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- * @throws \ImagickException
- */
- public static function populateTagsFromItem(&$item)
- {
- $return = [
- 'tags' => [],
- 'hashtags' => [],
- 'mentions' => [],
- ];
-
- $searchpath = System::baseUrl() . "/search?tag=";
-
- $taglist = DBA::select(
- 'term',
- ['type', 'term', 'url'],
- ["`otype` = ? AND `oid` = ? AND `type` IN (?, ?)", TERM_OBJ_POST, $item['id'], TERM_HASHTAG, TERM_MENTION],
- ['order' => ['tid']]
- );
-
- while ($tag = DBA::fetch($taglist)) {
- if ($tag['url'] == '') {
- $tag['url'] = $searchpath . rawurlencode($tag['term']);
- }
-
- $orig_tag = $tag['url'];
-
- $author = ['uid' => 0, 'id' => $item['author-id'],
- 'network' => $item['author-network'], 'url' => $item['author-link']];
- $tag['url'] = Contact::magicLinkByContact($author, $tag['url']);
-
- $prefix = '';
- if ($tag['type'] == TERM_HASHTAG) {
- if ($orig_tag != $tag['url']) {
- $item['body'] = str_replace($orig_tag, $tag['url'], $item['body']);
- }
-
- $return['hashtags'][] = '#<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
- $prefix = '#';
- } elseif ($tag['type'] == TERM_MENTION) {
- $return['mentions'][] = '@<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
- $prefix = '@';
- }
-
- $return['tags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
- }
- DBA::close($taglist);
-
- return $return;
- }
-
- /**
- * Delete all tags from an item
- *
- * @param int itemid - choose from which item the tags will be removed
- * @param array $type
- * @throws \Exception
- */
- public static function deleteByItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
- {
- if (empty($itemid)) {
- return;
- }
-
- // Clean up all tags
- DBA::delete('term', ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type]);
-
- }
}