]> git.mxchange.org Git - friendica.git/blob - src/Model/APContact.php
Merge pull request #7930 from MrPetovan/task/7887-api-followers-request
[friendica.git] / src / Model / APContact.php
1 <?php
2
3 /**
4  * @file src/Model/APContact.php
5  */
6
7 namespace Friendica\Model;
8
9 use Friendica\BaseObject;
10 use Friendica\Content\Text\HTML;
11 use Friendica\Core\Logger;
12 use Friendica\Core\Config;
13 use Friendica\Database\DBA;
14 use Friendica\Protocol\ActivityPub;
15 use Friendica\Util\Network;
16 use Friendica\Util\JsonLD;
17 use Friendica\Util\DateTimeFormat;
18 use Friendica\Util\Strings;
19
20 class APContact extends BaseObject
21 {
22         /**
23          * Resolves the profile url from the address by using webfinger
24          *
25          * @param string $addr profile address (user@domain.tld)
26          * @param string $url profile URL. When set then we return "true" when this profile url can be found at the address
27          * @return string|boolean url
28          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
29          */
30         private static function addrToUrl($addr, $url = null)
31         {
32                 $addr_parts = explode('@', $addr);
33                 if (count($addr_parts) != 2) {
34                         return false;
35                 }
36
37                 $xrd_timeout = Config::get('system', 'xrd_timeout');
38
39                 $webfinger = 'https://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
40
41                 $curlResult = Network::curl($webfinger, false, ['timeout' => $xrd_timeout, 'accept_content' => 'application/jrd+json,application/json']);
42                 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
43                         $webfinger = Strings::normaliseLink($webfinger);
44
45                         $curlResult = Network::curl($webfinger, false, ['timeout' => $xrd_timeout, 'accept_content' => 'application/jrd+json,application/json']);
46
47                         if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
48                                 return false;
49                         }
50                 }
51
52                 $data = json_decode($curlResult->getBody(), true);
53
54                 if (empty($data['links'])) {
55                         return false;
56                 }
57
58                 foreach ($data['links'] as $link) {
59                         if (!empty($url) && !empty($link['href']) && ($link['href'] == $url)) {
60                                 return true;
61                         }
62
63                         if (empty($link['href']) || empty($link['rel']) || empty($link['type'])) {
64                                 continue;
65                         }
66
67                         if (empty($url) && ($link['rel'] == 'self') && ($link['type'] == 'application/activity+json')) {
68                                 return $link['href'];
69                         }
70                 }
71
72                 return false;
73         }
74
75         /**
76          * Fetches a profile from a given url
77          *
78          * @param string  $url    profile url
79          * @param boolean $update true = always update, false = never update, null = update when not found or outdated
80          * @return array profile array
81          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
82          * @throws \ImagickException
83          */
84         public static function getByURL($url, $update = null)
85         {
86                 if (empty($url)) {
87                         return [];
88                 }
89
90                 $fetched_contact = false;
91
92                 if (empty($update)) {
93                         if (is_null($update)) {
94                                 $ref_update = DateTimeFormat::utc('now - 1 month');
95                         } else {
96                                 $ref_update = DBA::NULL_DATETIME;
97                         }
98
99                         $apcontact = DBA::selectFirst('apcontact', [], ['url' => $url]);
100                         if (!DBA::isResult($apcontact)) {
101                                 $apcontact = DBA::selectFirst('apcontact', [], ['alias' => $url]);
102                         }
103
104                         if (!DBA::isResult($apcontact)) {
105                                 $apcontact = DBA::selectFirst('apcontact', [], ['addr' => $url]);
106                         }
107
108                         if (DBA::isResult($apcontact) && ($apcontact['updated'] > $ref_update) && !empty($apcontact['pubkey'])) {
109                                 return $apcontact;
110                         }
111
112                         if (!is_null($update)) {
113                                 return DBA::isResult($apcontact) ? $apcontact : [];
114                         }
115
116                         if (DBA::isResult($apcontact)) {
117                                 $fetched_contact = $apcontact;
118                         }
119                 }
120
121                 if (empty(parse_url($url, PHP_URL_SCHEME))) {
122                         $url = self::addrToUrl($url);
123                         if (empty($url)) {
124                                 return $fetched_contact;
125                         }
126                 }
127
128                 $data = ActivityPub::fetchContent($url);
129                 if (empty($data)) {
130                         return $fetched_contact;
131                 }
132
133                 $compacted = JsonLD::compact($data);
134
135                 if (empty($compacted['@id'])) {
136                         return $fetched_contact;
137                 }
138
139                 $apcontact = [];
140                 $apcontact['url'] = $compacted['@id'];
141                 $apcontact['uuid'] = JsonLD::fetchElement($compacted, 'diaspora:guid', '@value');
142                 $apcontact['type'] = str_replace('as:', '', JsonLD::fetchElement($compacted, '@type'));
143                 $apcontact['following'] = JsonLD::fetchElement($compacted, 'as:following', '@id');
144                 $apcontact['followers'] = JsonLD::fetchElement($compacted, 'as:followers', '@id');
145                 $apcontact['inbox'] = JsonLD::fetchElement($compacted, 'ldp:inbox', '@id');
146                 self::unarchiveInbox($apcontact['inbox'], false);
147
148                 $apcontact['outbox'] = JsonLD::fetchElement($compacted, 'as:outbox', '@id');
149
150                 $apcontact['sharedinbox'] = '';
151                 if (!empty($compacted['as:endpoints'])) {
152                         $apcontact['sharedinbox'] = JsonLD::fetchElement($compacted['as:endpoints'], 'as:sharedInbox', '@id');
153                         self::unarchiveInbox($apcontact['sharedinbox'], true);
154                 }
155
156                 $apcontact['nick'] = JsonLD::fetchElement($compacted, 'as:preferredUsername', '@value') ?? '';
157                 $apcontact['name'] = JsonLD::fetchElement($compacted, 'as:name', '@value');
158
159                 if (empty($apcontact['name'])) {
160                         $apcontact['name'] = $apcontact['nick'];
161                 }
162
163                 $apcontact['about'] = HTML::toBBCode(JsonLD::fetchElement($compacted, 'as:summary', '@value'));
164
165                 $apcontact['photo'] = JsonLD::fetchElement($compacted, 'as:icon', '@id');
166                 if (is_array($apcontact['photo']) || !empty($compacted['as:icon']['as:url']['@id'])) {
167                         $apcontact['photo'] = JsonLD::fetchElement($compacted['as:icon'], 'as:url', '@id');
168                 }
169
170                 $apcontact['alias'] = JsonLD::fetchElement($compacted, 'as:url', '@id');
171                 if (is_array($apcontact['alias'])) {
172                         $apcontact['alias'] = JsonLD::fetchElement($compacted['as:url'], 'as:href', '@id');
173                 }
174
175                 // Quit if none of the basic values are set
176                 if (empty($apcontact['url']) || empty($apcontact['inbox']) || empty($apcontact['type'])) {
177                         return $fetched_contact;
178                 }
179
180                 // Quit if this doesn't seem to be an account at all
181                 if (!in_array($apcontact['type'], ActivityPub::ACCOUNT_TYPES)) {
182                         return $fetched_contact;
183                 }
184
185                 $parts = parse_url($apcontact['url']);
186                 unset($parts['scheme']);
187                 unset($parts['path']);
188
189                 if (!empty($apcontact['nick'])) {
190                         $apcontact['addr'] = $apcontact['nick'] . '@' . str_replace('//', '', Network::unparseURL($parts));
191                 } else {
192                         $apcontact['addr'] = '';
193                 }
194
195                 if (!empty($compacted['w3id:publicKey'])) {
196                         $apcontact['pubkey'] = trim(JsonLD::fetchElement($compacted['w3id:publicKey'], 'w3id:publicKeyPem', '@value'));
197                 }
198
199                 $apcontact['manually-approve'] = (int)JsonLD::fetchElement($compacted, 'as:manuallyApprovesFollowers');
200
201                 if (!empty($compacted['as:generator'])) {
202                         $apcontact['baseurl'] = JsonLD::fetchElement($compacted['as:generator'], 'as:url', '@id');
203                         $apcontact['generator'] = JsonLD::fetchElement($compacted['as:generator'], 'as:name', '@value');
204                 }
205
206                 if (!empty($apcontact['following'])) {
207                         $data = ActivityPub::fetchContent($apcontact['following']);
208                         if (!empty($data)) {
209                                 if (!empty($data['totalItems'])) {
210                                         $apcontact['following_count'] = $data['totalItems'];
211                                 }
212                         }
213                 }
214
215                 if (!empty($apcontact['followers'])) {
216                         $data = ActivityPub::fetchContent($apcontact['followers']);
217                         if (!empty($data)) {
218                                 if (!empty($data['totalItems'])) {
219                                         $apcontact['followers_count'] = $data['totalItems'];
220                                 }
221                         }
222                 }
223
224                 if (!empty($apcontact['outbox'])) {
225                         $data = ActivityPub::fetchContent($apcontact['outbox']);
226                         if (!empty($data)) {
227                                 if (!empty($data['totalItems'])) {
228                                         $apcontact['statuses_count'] = $data['totalItems'];
229                                 }
230                         }
231                 }
232
233                 // To-Do
234
235                 // Unhandled
236                 // tag, attachment, image, nomadicLocations, signature, featured, movedTo, liked
237
238                 // Unhandled from Misskey
239                 // sharedInbox, isCat
240
241                 // Unhandled from Kroeg
242                 // kroeg:blocks, updated
243
244                 $parts = parse_url($apcontact['url']);
245                 unset($parts['path']);
246                 $baseurl = Network::unparseURL($parts);
247
248                 // Check if the address is resolvable or the profile url is identical with the base url of the system
249                 if (self::addrToUrl($apcontact['addr'], $apcontact['url']) || Strings::compareLink($apcontact['url'], $baseurl)) {
250                         $apcontact['baseurl'] = $baseurl;
251                 } else {
252                         $apcontact['addr'] = null;
253                 }
254
255                 if (empty($apcontact['baseurl'])) {
256                         $apcontact['baseurl'] = null;
257                 }
258
259                 if ($apcontact['url'] == $apcontact['alias']) {
260                         $apcontact['alias'] = null;
261                 }
262
263                 $apcontact['updated'] = DateTimeFormat::utcNow();
264
265                 DBA::update('apcontact', $apcontact, ['url' => $url], true);
266
267                 // We delete the old entry when the URL is changed
268                 if (($url != $apcontact['url']) && DBA::exists('apcontact', ['url' => $url]) && DBA::exists('apcontact', ['url' => $apcontact['url']])) {
269                         DBA::delete('apcontact', ['url' => $url]);
270                 }
271
272                 Logger::log('Updated profile for ' . $url, Logger::DEBUG);
273
274                 return $apcontact;
275         }
276
277         /**
278          * Unarchive inboxes
279          *
280          * @param string $url inbox url
281          */
282         private static function unarchiveInbox($url, $shared)
283         {
284                 if (empty($url)) {
285                         return;
286                 }
287
288                 $now = DateTimeFormat::utcNow();
289
290                 $fields = ['archive' => false, 'success' => $now, 'shared' => $shared];
291
292                 if (!DBA::exists('inbox-status', ['url' => $url])) {
293                         $fields = array_merge($fields, ['url' => $url, 'created' => $now]);
294                         DBA::insert('inbox-status', $fields);
295                 } else {
296                         DBA::update('inbox-status', $fields, ['url' => $url]);
297                 }
298         }
299 }