3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Protocol;
24 use Friendica\Content\Text\BBCode;
25 use Friendica\Core\Logger;
26 use Friendica\Core\Protocol;
27 use Friendica\Database\DBA;
29 use Friendica\Model\APContact;
30 use Friendica\Model\Contact;
31 use Friendica\Model\GServer;
32 use Friendica\Model\Post;
33 use Friendica\Model\Search;
34 use Friendica\Model\Tag;
35 use Friendica\Util\DateTimeFormat;
36 use Friendica\Util\Strings;
39 * Base class for relay handling
44 * Check if a post is wanted
48 * @param int $authorid
50 * @return boolean "true" is the post is wanted by the system
52 public static function isSolicitedPost(array $tags, string $body, int $authorid, string $url, string $network = '')
54 $config = DI::config();
56 $scope = $config->get('system', 'relay_scope');
58 if ($scope == SR_SCOPE_NONE) {
59 Logger::info('Server does not accept relay posts - rejected', ['network' => $network, 'url' => $url]);
63 if (Contact::isBlocked($authorid)) {
64 Logger::info('Author is blocked - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
68 if (Contact::isHidden($authorid)) {
69 Logger::info('Author is hidden - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
77 if ($scope == SR_SCOPE_TAGS) {
78 $server_tags = $config->get('system', 'relay_server_tags');
79 $tagitems = explode(',', mb_strtolower($server_tags));
80 foreach ($tagitems as $tag) {
81 $systemTags[] = trim($tag, '# ');
84 if ($config->get('system', 'relay_user_tags')) {
85 $userTags = Search::getUserTags();
89 $tagList = array_unique(array_merge($systemTags, $userTags));
91 $deny_tags = $config->get('system', 'relay_deny_tags');
92 $tagitems = explode(',', mb_strtolower($deny_tags));
93 foreach ($tagitems as $tag) {
94 $tag = trim($tag, '# ');
98 if (!empty($tagList) || !empty($denyTags)) {
99 $content = mb_strtolower(BBCode::toPlaintext($body, false));
101 foreach ($tags as $tag) {
102 $tag = mb_strtolower($tag);
103 if (in_array($tag, $denyTags)) {
104 Logger::info('Unwanted hashtag found - rejected', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
108 if (in_array($tag, $tagList)) {
109 Logger::info('Subscribed hashtag found - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
113 // We check with "strpos" for performance issues. Only when this is true, the regular expression check is used
114 // RegExp is taken from here: https://medium.com/@shiba1014/regex-word-boundaries-with-unicode-207794f6e7ed
115 if ((strpos($content, $tag) !== false) && preg_match('/(?<=[\s,.:;"\']|^)' . preg_quote($tag, '/') . '(?=[\s,.:;"\']|$)/', $content)) {
116 Logger::info('Subscribed hashtag found in content - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
122 if ($scope == SR_SCOPE_ALL) {
123 Logger::info('Server accept all posts - accepted', ['network' => $network, 'url' => $url]);
127 Logger::info('No matching hashtags found - rejected', ['network' => $network, 'url' => $url]);
132 * Update or insert a relay contact
134 * @param array $gserver Global server record
135 * @param array $fields Optional network specific fields
138 public static function updateContact(array $gserver, array $fields = [])
140 if (in_array($gserver['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
141 $system = APContact::getByURL($gserver['url'] . '/friendica');
142 if (!empty($system['sharedinbox'])) {
143 Logger::info('Sucessfully probed for relay contact', ['server' => $gserver['url']]);
144 $id = Contact::updateFromProbeByURL($system['url']);
145 Logger::info('Updated relay contact', ['server' => $gserver['url'], 'id' => $id]);
150 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
151 $old = DBA::selectFirst('contact', [], $condition);
152 if (!DBA::isResult($old)) {
153 $condition = ['uid' => 0, 'nurl' => Strings::normaliseLink($gserver['url'])];
154 $old = DBA::selectFirst('contact', [], $condition);
155 if (DBA::isResult($old)) {
156 $fields['gsid'] = $gserver['id'];
157 $fields['contact-type'] = Contact::TYPE_RELAY;
158 Logger::info('Assigning missing data for relay contact', ['server' => $gserver['url'], 'id' => $old['id']]);
160 } elseif (empty($fields)) {
161 Logger::info('No content to update, quitting', ['server' => $gserver['url']]);
165 if (DBA::isResult($old)) {
166 $fields['updated'] = DateTimeFormat::utcNow();
168 Logger::info('Update relay contact', ['server' => $gserver['url'], 'id' => $old['id'], 'fields' => $fields]);
169 Contact::update($fields, ['id' => $old['id']], $old);
171 $default = ['created' => DateTimeFormat::utcNow(),
172 'name' => 'relay', 'nick' => 'relay', 'url' => $gserver['url'],
173 'nurl' => Strings::normaliseLink($gserver['url']),
174 'network' => Protocol::DIASPORA, 'uid' => 0,
175 'batch' => $gserver['url'] . '/receive/public',
176 'rel' => Contact::FOLLOWER, 'blocked' => false,
177 'pending' => false, 'writable' => true,
178 'gsid' => $gserver['id'],
179 'baseurl' => $gserver['url'], 'contact-type' => Contact::TYPE_RELAY];
181 $fields = array_merge($default, $fields);
183 Logger::info('Create relay contact', ['server' => $gserver['url'], 'fields' => $fields]);
184 Contact::insert($fields);
189 * Mark the relay contact of the given contact for archival
190 * This is called whenever there is a communication issue with the server.
191 * It avoids sending stuff to servers who don't exist anymore.
192 * The relay contact is a technical contact entry that exists once per server.
194 * @param array $contact of the relay contact
196 public static function markForArchival(array $contact)
198 if (!empty($contact['contact-type']) && ($contact['contact-type'] == Contact::TYPE_RELAY)) {
199 // This is already the relay contact, we don't need to fetch it
200 $relay_contact = $contact;
201 } elseif (empty($contact['baseurl'])) {
202 if (!empty($contact['batch'])) {
203 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => Contact::TYPE_RELAY];
204 $relay_contact = DBA::selectFirst('contact', [], $condition);
209 $gserver = ['id' => $contact['gsid'] ?: GServer::getID($contact['baseurl'], true),
210 'url' => $contact['baseurl'], 'network' => $contact['network']];
211 $relay_contact = self::getContact($gserver, []);
214 if (!empty($relay_contact)) {
215 Logger::info('Relay contact will be marked for archival', ['id' => $relay_contact['id'], 'url' => $relay_contact['url']]);
216 Contact::markForArchival($relay_contact);
221 * Return a list of servers that we serve via the direct relay
223 * @param integer $item_id id of the item that is sent
224 * @param array $contacts Previously fetched contacts
225 * @param array $networks Networks of the relay servers
227 * @return array of relay servers
228 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
230 public static function getDirectRelayList(int $item_id)
234 if (!DI::config()->get("system", "relay_directly", false)) {
238 // We distribute our stuff based on the parent to ensure that the thread will be complete
239 $parent = Post::selectFirst(['uri-id'], ['id' => $item_id]);
240 if (!DBA::isResult($parent)) {
244 // Servers that want to get all content
245 $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'all']);
246 while ($server = DBA::fetch($servers)) {
247 $serverlist[$server['id']] = $server;
249 DBA::close($servers);
251 // All tags of the current post
252 $tags = DBA::select('tag-view', ['name'], ['uri-id' => $parent['uri-id'], 'type' => Tag::HASHTAG]);
254 while ($tag = DBA::fetch($tags)) {
255 $taglist[] = $tag['name'];
259 // All servers who wants content with this tag
261 if (!empty($taglist)) {
262 $tagserver = DBA::select('gserver-tag', ['gserver-id'], ['tag' => $taglist]);
263 while ($server = DBA::fetch($tagserver)) {
264 $tagserverlist[] = $server['gserver-id'];
266 DBA::close($tagserver);
269 // All adresses with the given id
270 if (!empty($tagserverlist)) {
271 $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'tags', 'id' => $tagserverlist]);
272 while ($server = DBA::fetch($servers)) {
273 $serverlist[$server['id']] = $server;
275 DBA::close($servers);
280 // Now we are collecting all relay contacts
281 foreach ($serverlist as $gserver) {
282 // We don't send messages to ourselves
283 if (Strings::compareLink($gserver['url'], DI::baseUrl())) {
286 $contact = self::getContact($gserver);
287 if (empty($contact)) {
296 * Return a list of relay servers
298 * @param array $fields Field list
302 public static function getList($fields = []):array
304 return DBA::selectToArray('apcontact', $fields,
305 ["`type` = ? AND `url` IN (SELECT `url` FROM `contact` WHERE `uid` = ? AND `rel` = ?)", 'Application', 0, Contact::FRIEND]);
309 * Return a contact for a given server address or creates a dummy entry
311 * @param array $gserver Global server record
312 * @param array $fields Fieldlist
313 * @return array with the contact
316 private static function getContact(array $gserver, array $fields = ['batch', 'id', 'url', 'name', 'network', 'protocol', 'archive', 'blocked'])
318 // Fetch the relay contact
319 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
320 $contact = DBA::selectFirst('contact', $fields, $condition);
321 if (DBA::isResult($contact)) {
322 if ($contact['archive'] || $contact['blocked']) {
327 self::updateContact($gserver);
329 $contact = DBA::selectFirst('contact', $fields, $condition);
330 if (DBA::isResult($contact)) {
335 // It should never happen that we arrive here