use Friendica\Core\System;
use Friendica\Database\DBA;
+use Friendica\Util\Strings;
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 .= ',';
- }
+ const UNKNOWN = 0;
+ const HASHTAG = 1;
+ const MENTION = 2;
+ const CATEGORY = 3;
+ const PCATEGORY = 4;
+ const FILE = 5;
+ const SAVEDSEARCH = 6;
+ const CONVERSATION = 7;
+ const IMPLICIT_MENTION = 8;
+ const EXCLUSIVE_MENTION = 9;
+
+ const TAG_CHARACTER = [
+ self::HASHTAG => '#',
+ self::MENTION => '@',
+ self::IMPLICIT_MENTION => '%',
+ self::EXCLUSIVE_MENTION => '!',
+ ];
+
+ const OBJECT_TYPE_POST = 1;
+ const OBJECT_TYPE_PHOTO = 2;
- if ($tag['type'] == 1) {
- $tag_text .= '#';
- } else {
- $tag_text .= '@';
- }
- $tag_text .= '[url=' . $tag['url'] . ']' . $tag['term'] . '[/url]';
+ /**
+ * Generates the legacy item.tag field comma-separated BBCode string from an item ID.
+ * Includes only hashtags, implicit and explicit mentions.
+ *
+ * @param int $item_id
+ * @return string
+ * @throws \Exception
+ */
+ public static function tagTextFromItemId($item_id)
+ {
+ $tag_list = [];
+ $tags = self::tagArrayFromItemId($item_id, [self::HASHTAG, self::MENTION, self::IMPLICIT_MENTION]);
+ foreach ($tags as $tag) {
+ $tag_list[] = self::TAG_CHARACTER[$tag['type']] . '[url=' . $tag['url'] . ']' . $tag['term'] . '[/url]';
}
- return $tag_text;
+
+ return implode(',', $tag_list);
}
- public static function tagArrayFromItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
+ /**
+ * Retrieves the terms from the provided type(s) associated with the provided item ID.
+ *
+ * @param int $item_id
+ * @param int|array $type
+ * @return array
+ * @throws \Exception
+ */
+ public static function tagArrayFromItemId($item_id, $type = [self::HASHTAG, self::MENTION])
{
- $condition = ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type];
+ $condition = ['otype' => self::OBJECT_TYPE_POST, 'oid' => $item_id, 'type' => $type];
$tags = DBA::select('term', ['type', 'term', 'url'], $condition);
if (!DBA::isResult($tags)) {
return [];
return DBA::toArray($tags);
}
- 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) {
+ $tags = self::tagArrayFromItemId($item_id, [self::FILE, self::CATEGORY]);
+ 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)
+ /**
+ * Inserts new terms for the provided item ID based on the legacy item.tag field BBCode content.
+ * Deletes all previous tag terms for the same item ID.
+ * Sets both the item.mention and thread.mentions field flags if a mention concerning the item UID is found.
+ *
+ * @param int $item_id
+ * @param string $tag_str
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ public static function insertFromTagFieldByItemId($item_id, $tag_str)
{
$profile_base = System::baseUrl();
$profile_data = parse_url($profile_base);
$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)) {
+ $item = Item::selectFirst($fields, ['id' => $item_id]);
+ if (!DBA::isResult($item)) {
return;
}
- $message['tag'] = $tags;
+ $item['tag'] = $tag_str;
// Clean up all tags
- self::deleteByItemId($itemid);
+ self::deleteByItemId($item_id);
- if ($message['deleted']) {
+ if ($item['deleted']) {
return;
}
- $taglist = explode(',', $message['tag']);
+ $taglist = explode(',', $item['tag']);
$tags_string = '';
foreach ($taglist as $tag) {
- if ((substr(trim($tag), 0, 1) == '#') || (substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
+ if (Strings::startsWith($tag, self::TAG_CHARACTER)) {
$tags_string .= ' ' . trim($tag);
} else {
$tags_string .= ' #' . trim($tag);
}
}
- $data = ' ' . $message['title'] . ' ' . $message['body'] . ' ' . $tags_string . ' ';
+ $data = ' ' . $item['title'] . ' ' . $item['body'] . ' ' . $tags_string . ' ';
// ignore anything in a code block
$data = preg_replace('/\[code\](.*?)\[\/code\]/sm', '', $data);
}
}
- $pattern = '/\W([\#@!])\[url\=(.*?)\](.*?)\[\/url\]/ism';
+ $pattern = '/\W([\#@!%])\[url\=(.*?)\](.*?)\[\/url\]/ism';
if (preg_match_all($pattern, $data, $matches, PREG_SET_ORDER)) {
foreach ($matches as $match) {
- if (($match[1] == '@') || ($match[1] == '!')) {
+ if (in_array($match[1], [
+ self::TAG_CHARACTER[self::MENTION],
+ self::TAG_CHARACTER[self::IMPLICIT_MENTION],
+ self::TAG_CHARACTER[self::EXCLUSIVE_MENTION]
+ ])) {
$contact = Contact::getDetailsByURL($match[2], 0);
if (!empty($contact['addr'])) {
$match[3] = $contact['addr'];
}
}
- $tags[$match[1] . trim($match[3], ',.:;[]/\"?!')] = $match[2];
+ $tags[$match[2]] = $match[1] . trim($match[3], ',.:;[]/\"?!');
}
}
- foreach ($tags as $tag => $link) {
- if (substr(trim($tag), 0, 1) == '#') {
+ foreach ($tags as $link => $tag) {
+ if (self::isType($tag, self::HASHTAG)) {
// try to ignore #039 or #1 or anything like that
if (ctype_digit(substr(trim($tag), 1))) {
continue;
continue;
}
- $type = TERM_HASHTAG;
+ $type = self::HASHTAG;
$term = substr($tag, 1);
$link = '';
- } elseif ((substr(trim($tag), 0, 1) == '@') || (substr(trim($tag), 0, 1) == '!')) {
- $type = TERM_MENTION;
+ } elseif (self::isType($tag, self::MENTION, self::EXCLUSIVE_MENTION, self::IMPLICIT_MENTION)) {
+ if (self::isType($tag, self::MENTION, self::EXCLUSIVE_MENTION)) {
+ $type = self::MENTION;
+ } else {
+ $type = self::IMPLICIT_MENTION;
+ }
$contact = Contact::getDetailsByURL($link, 0);
if (!empty($contact['name'])) {
$term = substr($tag, 1);
}
} else { // This shouldn't happen
- $type = TERM_HASHTAG;
+ $type = self::HASHTAG;
$term = $tag;
$link = '';
}
- if (DBA::exists('term', ['uid' => $message['uid'], 'otype' => TERM_OBJ_POST, 'oid' => $itemid, 'term' => $term])) {
+ if (DBA::exists('term', ['uid' => $item['uid'], 'otype' => self::OBJECT_TYPE_POST, 'oid' => $item_id, 'term' => $term, 'type' => $type])) {
continue;
}
- if ($message['uid'] == 0) {
+ if ($item['uid'] == 0) {
$global = true;
- DBA::update('term', ['global' => true], ['otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
+ DBA::update('term', ['global' => true], ['otype' => self::OBJECT_TYPE_POST, 'guid' => $item['guid']]);
} else {
- $global = DBA::exists('term', ['uid' => 0, 'otype' => TERM_OBJ_POST, 'guid' => $message['guid']]);
+ $global = DBA::exists('term', ['uid' => 0, 'otype' => self::OBJECT_TYPE_POST, 'guid' => $item['guid']]);
}
DBA::insert('term', [
- 'uid' => $message['uid'],
- 'oid' => $itemid,
- 'otype' => TERM_OBJ_POST,
+ 'uid' => $item['uid'],
+ 'oid' => $item_id,
+ 'otype' => self::OBJECT_TYPE_POST,
'type' => $type,
'term' => $term,
'url' => $link,
- 'guid' => $message['guid'],
- 'created' => $message['created'],
- 'received' => $message['received'],
+ 'guid' => $item['guid'],
+ 'created' => $item['created'],
+ 'received' => $item['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);
+ if (self::isType($tag, self::MENTION, self::EXCLUSIVE_MENTION)
+ && (
+ strpos($link, $profile_base_friendica) !== false
+ || strpos($link, $profile_base_diaspora) !== false
+ )
+ ) {
+ $users_stmt = DBA::p("SELECT `uid` FROM `contact` WHERE self AND (`url` = ? OR `nurl` = ?)", $link, $link);
+ $users = DBA::toArray($users_stmt);
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']]);
+ if ($user['uid'] == $item['uid']) {
+ /// @todo This function is called from Item::update - so we mustn't call that function here
+ DBA::update('item', ['mention' => true], ['id' => $item_id]);
+ DBA::update('thread', ['mention' => true], ['iid' => $item['parent']]);
}
}
}
}
/**
- * @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
]);
}
'tags' => [],
'hashtags' => [],
'mentions' => [],
+ 'implicit_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],
+ ['otype' => self::OBJECT_TYPE_POST, 'oid' => $item['id'], 'type' => [self::HASHTAG, self::MENTION, self::IMPLICIT_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']];
-
- $prefix = '';
- if ($tag['type'] == TERM_HASHTAG) {
- $tag['url'] = Contact::magicLinkByContact($author, $tag['url']);
- if ($orig_tag != $tag['url']) {
- $item['body'] = str_replace($orig_tag, $tag['url'], $item['body']);
- }
+ $prefix = self::TAG_CHARACTER[$tag['type']];
+ switch($tag['type']) {
+ case self::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) {
- $tag['url'] = Contact::magicLink($tag['url']);
- $return['mentions'][] = '@<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
- $prefix = '@';
+ $return['hashtags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
+ $return['tags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
+ break;
+ case self::MENTION:
+ $tag['url'] = Contact::magicLink($tag['url']);
+ $return['mentions'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
+ $return['tags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
+ break;
+ case self::IMPLICIT_MENTION:
+ $return['implicit_mentions'][] = $prefix . $tag['term'];
+ break;
}
-
- $return['tags'][] = $prefix . '<a href="' . $tag['url'] . '" target="_blank">' . $tag['term'] . '</a>';
}
DBA::close($taglist);
}
/**
- * Delete all tags from an item
+ * Delete tags of the specific type(s) from an item
*
- * @param int itemid - choose from which item the tags will be removed
- * @param array $type
+ * @param int $item_id
+ * @param int|array $type
* @throws \Exception
*/
- public static function deleteByItemId($itemid, $type = [TERM_HASHTAG, TERM_MENTION])
+ public static function deleteByItemId($item_id, $type = [self::HASHTAG, self::MENTION, self::IMPLICIT_MENTION])
{
- if (empty($itemid)) {
+ if (empty($item_id)) {
return;
}
// Clean up all tags
- DBA::delete('term', ['otype' => TERM_OBJ_POST, 'oid' => $itemid, 'type' => $type]);
+ DBA::delete('term', ['otype' => self::OBJECT_TYPE_POST, 'oid' => $item_id, 'type' => $type]);
+ }
+
+ /**
+ * Check if the provided tag is of one of the provided term types.
+ *
+ * @param string $tag
+ * @param int ...$types
+ * @return bool
+ */
+ public static function isType($tag, ...$types)
+ {
+ $tag_chars = [];
+ foreach ($types as $type) {
+ if (isset(self::TAG_CHARACTER[$type])) {
+ $tag_chars[] = self::TAG_CHARACTER[$type];
+ }
+ }
+ return Strings::startsWith($tag, $tag_chars);
}
}
projects / friendica.git / commitdiff