]> git.mxchange.org Git - friendica.git/blob - src/Model/Contact.php
Issue 4655: Avoid multiplicated contact requests from the same account
[friendica.git] / src / Model / Contact.php
1 <?php
2 /**
3  * @file src/Model/Contact.php
4  */
5 namespace Friendica\Model;
6
7 use Friendica\BaseObject;
8 use Friendica\Core\Addon;
9 use Friendica\Core\Config;
10 use Friendica\Core\L10n;
11 use Friendica\Core\PConfig;
12 use Friendica\Core\System;
13 use Friendica\Core\Worker;
14 use Friendica\Database\DBM;
15 use Friendica\Model\Photo;
16 use Friendica\Model\Profile;
17 use Friendica\Network\Probe;
18 use Friendica\Protocol\DFRN;
19 use Friendica\Protocol\Diaspora;
20 use Friendica\Protocol\OStatus;
21 use Friendica\Protocol\PortableContact;
22 use Friendica\Protocol\Salmon;
23 use Friendica\Util\DateTimeFormat;
24 use Friendica\Util\Network;
25 use Friendica\Object\Image;
26 use dba;
27
28 require_once 'boot.php';
29 require_once 'include/dba.php';
30 require_once 'include/text.php';
31
32 /**
33  * @brief functions for interacting with a contact
34  */
35 class Contact extends BaseObject
36 {
37         /**
38          * @brief Returns a list of contacts belonging in a group
39          *
40          * @param int $gid
41          * @return array
42          */
43         public static function getByGroupId($gid)
44         {
45                 $return = [];
46                 if (intval($gid)) {
47                         $stmt = dba::p('SELECT `group_member`.`contact-id`, `contact`.*
48                                 FROM `contact`
49                                 INNER JOIN `group_member`
50                                         ON `contact`.`id` = `group_member`.`contact-id`
51                                 WHERE `gid` = ?
52                                 AND `contact`.`uid` = ?
53                                 AND NOT `contact`.`self`
54                                 AND NOT `contact`.`blocked`
55                                 AND NOT `contact`.`pending`
56                                 ORDER BY `contact`.`name` ASC',
57                                 $gid,
58                                 local_user()
59                         );
60                         if (DBM::is_result($stmt)) {
61                                 $return = dba::inArray($stmt);
62                         }
63                 }
64
65                 return $return;
66         }
67
68         /**
69          * @brief Returns the count of OStatus contacts in a group
70          *
71          * @param int $gid
72          * @return int
73          */
74         public static function getOStatusCountByGroupId($gid)
75         {
76                 $return = 0;
77                 if (intval($gid)) {
78                         $contacts = dba::fetch_first('SELECT COUNT(*) AS `count`
79                                 FROM `contact`
80                                 INNER JOIN `group_member`
81                                         ON `contact`.`id` = `group_member`.`contact-id`
82                                 WHERE `gid` = ?
83                                 AND `contact`.`uid` = ?
84                                 AND `contact`.`network` = ?
85                                 AND `contact`.`notify` != ""',
86                                 $gid,
87                                 local_user(),
88                                 NETWORK_OSTATUS
89                         );
90                         $return = $contacts['count'];
91                 }
92
93                 return $return;
94         }
95
96         /**
97          * Creates the self-contact for the provided user id
98          *
99          * @param int $uid
100          * @return bool Operation success
101          */
102         public static function createSelfFromUserId($uid)
103         {
104                 // Only create the entry if it doesn't exist yet
105                 if (dba::exists('contact', ['uid' => $uid, 'self' => true])) {
106                         return true;
107                 }
108
109                 $user = dba::selectFirst('user', ['uid', 'username', 'nickname'], ['uid' => $uid]);
110                 if (!DBM::is_result($user)) {
111                         return false;
112                 }
113
114                 $return = dba::insert('contact', [
115                         'uid'         => $user['uid'],
116                         'created'     => DateTimeFormat::utcNow(),
117                         'self'        => 1,
118                         'name'        => $user['username'],
119                         'nick'        => $user['nickname'],
120                         'photo'       => System::baseUrl() . '/photo/profile/' . $user['uid'] . '.jpg',
121                         'thumb'       => System::baseUrl() . '/photo/avatar/'  . $user['uid'] . '.jpg',
122                         'micro'       => System::baseUrl() . '/photo/micro/'   . $user['uid'] . '.jpg',
123                         'blocked'     => 0,
124                         'pending'     => 0,
125                         'url'         => System::baseUrl() . '/profile/' . $user['nickname'],
126                         'nurl'        => normalise_link(System::baseUrl() . '/profile/' . $user['nickname']),
127                         'addr'        => $user['nickname'] . '@' . substr(System::baseUrl(), strpos(System::baseUrl(), '://') + 3),
128                         'request'     => System::baseUrl() . '/dfrn_request/' . $user['nickname'],
129                         'notify'      => System::baseUrl() . '/dfrn_notify/'  . $user['nickname'],
130                         'poll'        => System::baseUrl() . '/dfrn_poll/'    . $user['nickname'],
131                         'confirm'     => System::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
132                         'poco'        => System::baseUrl() . '/poco/'         . $user['nickname'],
133                         'name-date'   => DateTimeFormat::utcNow(),
134                         'uri-date'    => DateTimeFormat::utcNow(),
135                         'avatar-date' => DateTimeFormat::utcNow(),
136                         'closeness'   => 0
137                 ]);
138
139                 return $return;
140         }
141
142         /**
143          * Updates the self-contact for the provided user id
144          *
145          * @param int $uid
146          * @param boolean $update_avatar Force the avatar update
147          */
148         public static function updateSelfFromUserID($uid, $update_avatar = false)
149         {
150                 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'gender', 'avatar',
151                         'xmpp', 'contact-type', 'forum', 'prv', 'avatar-date', 'nurl'];
152                 $self = dba::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
153                 if (!DBM::is_result($self)) {
154                         return;
155                 }
156
157                 $fields = ['nickname', 'page-flags', 'account-type'];
158                 $user = dba::selectFirst('user', $fields, ['uid' => $uid]);
159                 if (!DBM::is_result($user)) {
160                         return;
161                 }
162
163                 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
164                         'country-name', 'gender', 'pub_keywords', 'xmpp'];
165                 $profile = dba::selectFirst('profile', $fields, ['uid' => $uid, 'is-default' => true]);
166                 if (!DBM::is_result($profile)) {
167                         return;
168                 }
169
170                 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
171                         'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
172                         'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
173                         'gender' => $profile['gender'], 'avatar' => $profile['photo'],
174                         'contact-type' => $user['account-type'], 'xmpp' => $profile['xmpp']];
175
176                 $avatar = dba::selectFirst('photo', ['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
177                 if (DBM::is_result($avatar)) {
178                         if ($update_avatar) {
179                                 $fields['avatar-date'] = DateTimeFormat::utcNow();
180                         }
181
182                         // Creating the path to the avatar, beginning with the file suffix
183                         $types = Image::supportedTypes();
184                         if (isset($types[$avatar['type']])) {
185                                 $file_suffix = $types[$avatar['type']];
186                         } else {
187                                 $file_suffix = 'jpg';
188                         }
189
190                         // We are adding a timestamp value so that other systems won't use cached content
191                         $timestamp = strtotime($fields['avatar-date']);
192
193                         $prefix = System::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
194                         $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
195
196                         $fields['photo'] = $prefix . '4' . $suffix;
197                         $fields['thumb'] = $prefix . '5' . $suffix;
198                         $fields['micro'] = $prefix . '6' . $suffix;
199                 } else {
200                         // We hadn't found a photo entry, so we use the default avatar
201                         $fields['photo'] = System::baseUrl() . '/images/person-175.jpg';
202                         $fields['thumb'] = System::baseUrl() . '/images/person-80.jpg';
203                         $fields['micro'] = System::baseUrl() . '/images/person-48.jpg';
204                 }
205
206                 $fields['forum'] = $user['page-flags'] == PAGE_COMMUNITY;
207                 $fields['prv'] = $user['page-flags'] == PAGE_PRVGROUP;
208
209                 $update = false;
210
211                 foreach ($fields as $field => $content) {
212                         if ($self[$field] != $content) {
213                                 $update = true;
214                         }
215                 }
216
217                 if ($update) {
218                         $fields['name-date'] = DateTimeFormat::utcNow();
219                         dba::update('contact', $fields, ['id' => $self['id']]);
220
221                         // Update the public contact as well
222                         dba::update('contact', $fields, ['uid' => 0, 'nurl' => $self['nurl']]);
223
224                         // Update the profile
225                         $fields = ['photo' => System::baseUrl() . '/photo/profile/' .$uid . '.jpg',
226                                 'thumb' => System::baseUrl() . '/photo/avatar/' . $uid .'.jpg'];
227                         dba::update('profile', $fields, ['uid' => $uid, 'is-default' => true]);
228                 }
229         }
230
231         /**
232          * @brief Marks a contact for removal
233          *
234          * @param int $id contact id
235          * @return null
236          */
237         public static function remove($id)
238         {
239                 // We want just to make sure that we don't delete our "self" contact
240                 $contact = dba::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
241                 if (!DBM::is_result($contact) || !intval($contact['uid'])) {
242                         return;
243                 }
244
245                 $archive = PConfig::get($contact['uid'], 'system', 'archive_removed_contacts');
246                 if ($archive) {
247                         dba::update('contact', ['archive' => true, 'network' => 'none', 'writable' => false], ['id' => $id]);
248                         return;
249                 }
250
251                 dba::delete('contact', ['id' => $id]);
252
253                 // Delete the rest in the background
254                 Worker::add(PRIORITY_LOW, 'RemoveContact', $id);
255         }
256
257         /**
258          * @brief Sends an unfriend message. Does not remove the contact
259          *
260          * @param array $user    User unfriending
261          * @param array $contact Contact unfriended
262          * @return void
263          */
264         public static function terminateFriendship(array $user, array $contact)
265         {
266                 if (in_array($contact['network'], [NETWORK_OSTATUS, NETWORK_DFRN])) {
267                         // create an unfollow slap
268                         $item = [];
269                         $item['verb'] = NAMESPACE_OSTATUS . "/unfollow";
270                         $item['follow'] = $contact["url"];
271                         $slap = OStatus::salmon($item, $user);
272
273                         if (!empty($contact['notify'])) {
274                                 Salmon::slapper($user, $contact['notify'], $slap);
275                         }
276                 } elseif ($contact['network'] == NETWORK_DIASPORA) {
277                         Diaspora::sendUnshare($user, $contact);
278                 }
279         }
280
281         /**
282          * @brief Marks a contact for archival after a communication issue delay
283          *
284          * Contact has refused to recognise us as a friend. We will start a countdown.
285          * If they still don't recognise us in 32 days, the relationship is over,
286          * and we won't waste any more time trying to communicate with them.
287          * This provides for the possibility that their database is temporarily messed
288          * up or some other transient event and that there's a possibility we could recover from it.
289          *
290          * @param array $contact contact to mark for archival
291          * @return null
292          */
293         public static function markForArchival(array $contact)
294         {
295                 // Contact already archived or "self" contact? => nothing to do
296                 if ($contact['archive'] || $contact['self']) {
297                         return;
298                 }
299
300                 if ($contact['term-date'] <= NULL_DATE) {
301                         dba::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
302
303                         if ($contact['url'] != '') {
304                                 dba::update('contact', ['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', normalise_link($contact['url']), NULL_DATE]);
305                         }
306                 } else {
307                         /* @todo
308                          * We really should send a notification to the owner after 2-3 weeks
309                          * so they won't be surprised when the contact vanishes and can take
310                          * remedial action if this was a serious mistake or glitch
311                          */
312
313                         /// @todo Check for contact vitality via probing
314                         $archival_days = Config::get('system', 'archival_days', 32);
315
316                         $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
317                         if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
318                                 /* Relationship is really truly dead. archive them rather than
319                                  * delete, though if the owner tries to unarchive them we'll start
320                                  * the whole process over again.
321                                  */
322                                 dba::update('contact', ['archive' => 1], ['id' => $contact['id']]);
323
324                                 if ($contact['url'] != '') {
325                                         dba::update('contact', ['archive' => 1], ['nurl' => normalise_link($contact['url']), 'self' => false]);
326                                 }
327                         }
328                 }
329         }
330
331         /**
332          * @brief Cancels the archival countdown
333          *
334          * @see Contact::markForArchival()
335          *
336          * @param array $contact contact to be unmarked for archival
337          * @return null
338          */
339         public static function unmarkForArchival(array $contact)
340         {
341                 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], NULL_DATE];
342                 $exists = dba::exists('contact', $condition);
343
344                 // We don't need to update, we never marked this contact for archival
345                 if (!$exists) {
346                         return;
347                 }
348
349                 // It's a miracle. Our dead contact has inexplicably come back to life.
350                 $fields = ['term-date' => NULL_DATE, 'archive' => false];
351                 dba::update('contact', $fields, ['id' => $contact['id']]);
352
353                 if (!empty($contact['url'])) {
354                         dba::update('contact', $fields, ['nurl' => normalise_link($contact['url'])]);
355                 }
356
357                 if (!empty($contact['batch'])) {
358                         $condition = ['batch' => $contact['batch'], 'contact-type' => ACCOUNT_TYPE_RELAY];
359                         dba::update('contact', $fields, $condition);
360                 }
361         }
362
363         /**
364          * @brief Get contact data for a given profile link
365          *
366          * The function looks at several places (contact table and gcontact table) for the contact
367          * It caches its result for the same script execution to prevent duplicate calls
368          *
369          * @param string $url     The profile link
370          * @param int    $uid     User id
371          * @param array  $default If not data was found take this data as default value
372          *
373          * @return array Contact data
374          */
375         public static function getDetailsByURL($url, $uid = -1, array $default = [])
376         {
377                 static $cache = [];
378
379                 if ($url == '') {
380                         return $default;
381                 }
382
383                 if ($uid == -1) {
384                         $uid = local_user();
385                 }
386
387                 if (isset($cache[$url][$uid])) {
388                         return $cache[$url][$uid];
389                 }
390
391                 $ssl_url = str_replace('http://', 'https://', $url);
392
393                 // Fetch contact data from the contact table for the given user
394                 $s = dba::p("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
395                         `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
396                 FROM `contact` WHERE `nurl` = ? AND `uid` = ?", normalise_link($url), $uid);
397                 $r = dba::inArray($s);
398
399                 // Fetch contact data from the contact table for the given user, checking with the alias
400                 if (!DBM::is_result($r)) {
401                         $s = dba::p("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
402                                 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
403                         FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = ?", normalise_link($url), $url, $ssl_url, $uid);
404                         $r = dba::inArray($s);
405                 }
406
407                 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
408                 if (!DBM::is_result($r)) {
409                         $s = dba::p("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
410                         `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
411                         FROM `contact` WHERE `nurl` = ? AND `uid` = 0", normalise_link($url));
412                         $r = dba::inArray($s);
413                 }
414
415                 // Fetch the data from the contact table with "uid=0" (which is filled automatically) - checked with the alias
416                 if (!DBM::is_result($r)) {
417                         $s = dba::p("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
418                         `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
419                         FROM `contact` WHERE `alias` IN (?, ?, ?) AND `uid` = 0", normalise_link($url), $url, $ssl_url);
420                         $r = dba::inArray($s);
421                 }
422
423                 // Fetch the data from the gcontact table
424                 if (!DBM::is_result($r)) {
425                         $s = dba::p("SELECT 0 AS `id`, 0 AS `cid`, `id` AS `gid`, 0 AS `zid`, 0 AS `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, '' AS `xmpp`,
426                         `keywords`, `gender`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, `community` AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`
427                         FROM `gcontact` WHERE `nurl` = ?", normalise_link($url));
428                         $r = dba::inArray($s);
429                 }
430
431                 if (DBM::is_result($r)) {
432                         // If there is more than one entry we filter out the connector networks
433                         if (count($r) > 1) {
434                                 foreach ($r as $id => $result) {
435                                         if ($result["network"] == NETWORK_STATUSNET) {
436                                                 unset($r[$id]);
437                                         }
438                                 }
439                         }
440
441                         $profile = array_shift($r);
442
443                         // "bd" always contains the upcoming birthday of a contact.
444                         // "birthday" might contain the birthday including the year of birth.
445                         if ($profile["birthday"] > '0001-01-01') {
446                                 $bd_timestamp = strtotime($profile["birthday"]);
447                                 $month = date("m", $bd_timestamp);
448                                 $day = date("d", $bd_timestamp);
449
450                                 $current_timestamp = time();
451                                 $current_year = date("Y", $current_timestamp);
452                                 $current_month = date("m", $current_timestamp);
453                                 $current_day = date("d", $current_timestamp);
454
455                                 $profile["bd"] = $current_year . "-" . $month . "-" . $day;
456                                 $current = $current_year . "-" . $current_month . "-" . $current_day;
457
458                                 if ($profile["bd"] < $current) {
459                                         $profile["bd"] = ( ++$current_year) . "-" . $month . "-" . $day;
460                                 }
461                         } else {
462                                 $profile["bd"] = '0001-01-01';
463                         }
464                 } else {
465                         $profile = $default;
466                 }
467
468                 if (($profile["photo"] == "") && isset($default["photo"])) {
469                         $profile["photo"] = $default["photo"];
470                 }
471
472                 if (($profile["name"] == "") && isset($default["name"])) {
473                         $profile["name"] = $default["name"];
474                 }
475
476                 if (($profile["network"] == "") && isset($default["network"])) {
477                         $profile["network"] = $default["network"];
478                 }
479
480                 if (($profile["thumb"] == "") && isset($profile["photo"])) {
481                         $profile["thumb"] = $profile["photo"];
482                 }
483
484                 if (($profile["micro"] == "") && isset($profile["thumb"])) {
485                         $profile["micro"] = $profile["thumb"];
486                 }
487
488                 if ((($profile["addr"] == "") || ($profile["name"] == "")) && ($profile["gid"] != 0)
489                         && in_array($profile["network"], [NETWORK_DFRN, NETWORK_DIASPORA, NETWORK_OSTATUS])
490                 ) {
491                         Worker::add(PRIORITY_LOW, "UpdateGContact", $profile["gid"]);
492                 }
493
494                 // Show contact details of Diaspora contacts only if connected
495                 if (($profile["cid"] == 0) && ($profile["network"] == NETWORK_DIASPORA)) {
496                         $profile["location"] = "";
497                         $profile["about"] = "";
498                         $profile["gender"] = "";
499                         $profile["birthday"] = '0001-01-01';
500                 }
501
502                 $cache[$url][$uid] = $profile;
503
504                 return $profile;
505         }
506
507         /**
508          * @brief Get contact data for a given address
509          *
510          * The function looks at several places (contact table and gcontact table) for the contact
511          *
512          * @param string $addr The profile link
513          * @param int    $uid  User id
514          *
515          * @return array Contact data
516          */
517         public static function getDetailsByAddr($addr, $uid = -1)
518         {
519                 static $cache = [];
520
521                 if ($addr == '') {
522                         return [];
523                 }
524
525                 if ($uid == -1) {
526                         $uid = local_user();
527                 }
528
529                 // Fetch contact data from the contact table for the given user
530                 $r = q("SELECT `id`, `id` AS `cid`, 0 AS `gid`, 0 AS `zid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
531                         `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, `self`
532                         FROM `contact` WHERE `addr` = '%s' AND `uid` = %d",
533                         dbesc($addr),
534                         intval($uid)
535                 );
536                 // Fetch the data from the contact table with "uid=0" (which is filled automatically)
537                 if (!DBM::is_result($r)) {
538                         $r = q("SELECT `id`, 0 AS `cid`, `id` AS `zid`, 0 AS `gid`, `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, `xmpp`,
539                                 `keywords`, `gender`, `photo`, `thumb`, `micro`, `forum`, `prv`, (`forum` | `prv`) AS `community`, `contact-type`, `bd` AS `birthday`, 0 AS `self`
540                                 FROM `contact` WHERE `addr` = '%s' AND `uid` = 0",
541                                 dbesc($addr)
542                         );
543                 }
544
545                 // Fetch the data from the gcontact table
546                 if (!DBM::is_result($r)) {
547                         $r = q("SELECT 0 AS `id`, 0 AS `cid`, `id` AS `gid`, 0 AS `zid`, 0 AS `uid`, `url`, `nurl`, `alias`, `network`, `name`, `nick`, `addr`, `location`, `about`, '' AS `xmpp`,
548                                 `keywords`, `gender`, `photo`, `photo` AS `thumb`, `photo` AS `micro`, `community` AS `forum`, 0 AS `prv`, `community`, `contact-type`, `birthday`, 0 AS `self`
549                                 FROM `gcontact` WHERE `addr` = '%s'",
550                                 dbesc($addr)
551                         );
552                 }
553
554                 if (!DBM::is_result($r)) {
555                         $data = Probe::uri($addr);
556
557                         $profile = self::getDetailsByURL($data['url'], $uid);
558                 } else {
559                         $profile = $r[0];
560                 }
561
562                 return $profile;
563         }
564
565         /**
566          * @brief Returns the data array for the photo menu of a given contact
567          *
568          * @param array $contact contact
569          * @param int   $uid     optional, default 0
570          * @return array
571          */
572         public static function photoMenu(array $contact, $uid = 0)
573         {
574                 // @todo Unused, to be removed
575                 $a = get_app();
576
577                 $contact_url = '';
578                 $pm_url = '';
579                 $status_link = '';
580                 $photos_link = '';
581                 $posts_link = '';
582                 $contact_drop_link = '';
583                 $poke_link = '';
584
585                 if ($uid == 0) {
586                         $uid = local_user();
587                 }
588
589                 if ($contact['uid'] != $uid) {
590                         if ($uid == 0) {
591                                 $profile_link = Profile::zrl($contact['url']);
592                                 $menu = ['profile' => [L10n::t('View Profile'), $profile_link, true]];
593
594                                 return $menu;
595                         }
596
597                         // Look for our own contact if the uid doesn't match and isn't public
598                         $contact_own = dba::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
599                         if (DBM::is_result($contact_own)) {
600                                 return self::photoMenu($contact_own, $uid);
601                         } else {
602                                 $profile_link = Profile::zrl($contact['url']);
603                                 $connlnk = 'follow/?url=' . $contact['url'];
604                                 $menu = [
605                                         'profile' => [L10n::t('View Profile'), $profile_link, true],
606                                         'follow' => [L10n::t('Connect/Follow'), $connlnk, true]
607                                 ];
608
609                                 return $menu;
610                         }
611                 }
612
613                 $sparkle = false;
614                 if (($contact['network'] === NETWORK_DFRN) && !$contact['self']) {
615                         $sparkle = true;
616                         $profile_link = System::baseUrl() . '/redir/' . $contact['id'];
617                 } else {
618                         $profile_link = $contact['url'];
619                 }
620
621                 if ($profile_link === 'mailbox') {
622                         $profile_link = '';
623                 }
624
625                 if ($sparkle) {
626                         $status_link = $profile_link . '?url=status';
627                         $photos_link = $profile_link . '?url=photos';
628                         $profile_link = $profile_link . '?url=profile';
629                 }
630
631                 if (in_array($contact['network'], [NETWORK_DFRN, NETWORK_DIASPORA]) && !$contact['self']) {
632                         $pm_url = System::baseUrl() . '/message/new/' . $contact['id'];
633                 }
634
635                 if (($contact['network'] == NETWORK_DFRN) && !$contact['self']) {
636                         $poke_link = System::baseUrl() . '/poke/?f=&c=' . $contact['id'];
637                 }
638
639                 $contact_url = System::baseUrl() . '/contacts/' . $contact['id'];
640
641                 $posts_link = System::baseUrl() . '/contacts/' . $contact['id'] . '/posts';
642
643                 if (!$contact['self']) {
644                         $contact_drop_link = System::baseUrl() . '/contacts/' . $contact['id'] . '/drop?confirm=1';
645                 }
646
647                 /**
648                  * Menu array:
649                  * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
650                  */
651                 $menu = [
652                         'status'  => [L10n::t("View Status")  , $status_link      , true],
653                         'profile' => [L10n::t("View Profile") , $profile_link     , true],
654                         'photos'  => [L10n::t("View Photos")  , $photos_link      , true],
655                         'network' => [L10n::t("Network Posts"), $posts_link       , false],
656                         'edit'    => [L10n::t("View Contact") , $contact_url      , false],
657                         'drop'    => [L10n::t("Drop Contact") , $contact_drop_link, false],
658                         'pm'      => [L10n::t("Send PM")      , $pm_url           , false],
659                         'poke'    => [L10n::t("Poke")         , $poke_link        , false],
660                 ];
661
662                 $args = ['contact' => $contact, 'menu' => &$menu];
663
664                 Addon::callHooks('contact_photo_menu', $args);
665
666                 $menucondensed = [];
667
668                 foreach ($menu as $menuname => $menuitem) {
669                         if ($menuitem[1] != '') {
670                                 $menucondensed[$menuname] = $menuitem;
671                         }
672                 }
673
674                 return $menucondensed;
675         }
676
677         /**
678          * @brief Returns ungrouped contact count or list for user
679          *
680          * Returns either the total number of ungrouped contacts for the given user
681          * id or a paginated list of ungrouped contacts.
682          *
683          * @param int $uid   uid
684          * @param int $start optional, default 0
685          * @param int $count optional, default 0
686          *
687          * @return array
688          */
689         public static function getUngroupedList($uid, $start = 0, $count = 0)
690         {
691                 if (!$count) {
692                         $r = q(
693                                 "SELECT COUNT(*) AS `total`
694                                  FROM `contact`
695                                  WHERE `uid` = %d
696                                  AND NOT `self`
697                                  AND NOT `blocked`
698                                  AND NOT `pending`
699                                  AND `id` NOT IN (
700                                         SELECT DISTINCT(`contact-id`)
701                                         FROM `group_member`
702                                         WHERE `uid` = %d
703                                 )",
704                                 intval($uid),
705                                 intval($uid)
706                         );
707
708                         return $r;
709                 }
710
711                 $r = q(
712                         "SELECT *
713                         FROM `contact`
714                         WHERE `uid` = %d
715                         AND NOT `self`
716                         AND NOT `blocked`
717                         AND NOT `pending`
718                         AND `id` NOT IN (
719                                 SELECT DISTINCT(`contact-id`)
720                                 FROM `group_member`
721                                 INNER JOIN `group` ON `group`.`id` = `group_member`.`gid`
722                                 WHERE `group`.`uid` = %d
723                         )
724                         LIMIT %d, %d",
725                         intval($uid),
726                         intval($uid),
727                         intval($start),
728                         intval($count)
729                 );
730
731                 return $r;
732         }
733
734         /**
735          * @brief Fetch the contact id for a given URL and user
736          *
737          * First lookup in the contact table to find a record matching either `url`, `nurl`,
738          * `addr` or `alias`.
739          *
740          * If there's no record and we aren't looking for a public contact, we quit.
741          * If there's one, we check that it isn't time to update the picture else we
742          * directly return the found contact id.
743          *
744          * Second, we probe the provided $url whether it's http://server.tld/profile or
745          * nick@server.tld. We quit if we can't get any info back.
746          *
747          * Third, we create the contact record if it doesn't exist
748          *
749          * Fourth, we update the existing record with the new data (avatar, alias, nick)
750          * if there's any updates
751          *
752          * @param string  $url       Contact URL
753          * @param integer $uid       The user id for the contact (0 = public contact)
754          * @param boolean $no_update Don't update the contact
755          *
756          * @return integer Contact ID
757          */
758         public static function getIdForURL($url, $uid = 0, $no_update = false)
759         {
760                 logger("Get contact data for url " . $url . " and user " . $uid . " - " . System::callstack(), LOGGER_DEBUG);
761
762                 $contact_id = 0;
763
764                 if ($url == '') {
765                         return 0;
766                 }
767
768                 /// @todo Verify if we can't use Contact::getDetailsByUrl instead of the following
769                 // We first try the nurl (http://server.tld/nick), most common case
770                 $contact = dba::selectFirst('contact', ['id', 'avatar', 'avatar-date'], ['nurl' => normalise_link($url), 'uid' => $uid]);
771
772                 // Then the addr (nick@server.tld)
773                 if (!DBM::is_result($contact)) {
774                         $contact = dba::selectFirst('contact', ['id', 'avatar', 'avatar-date'], ['addr' => $url, 'uid' => $uid]);
775                 }
776
777                 // Then the alias (which could be anything)
778                 if (!DBM::is_result($contact)) {
779                         // The link could be provided as http although we stored it as https
780                         $ssl_url = str_replace('http://', 'https://', $url);
781                         $condition = ['`alias` IN (?, ?, ?) AND `uid` = ?', $url, normalise_link($url), $ssl_url, $uid];
782                         $contact = dba::selectFirst('contact', ['id', 'avatar', 'avatar-date'], $condition);
783                 }
784
785                 if (DBM::is_result($contact)) {
786                         $contact_id = $contact["id"];
787
788                         // Update the contact every 7 days
789                         $update_contact = ($contact['avatar-date'] < DateTimeFormat::utc('now -7 days'));
790
791                         // We force the update if the avatar is empty
792                         if (!x($contact, 'avatar')) {
793                                 $update_contact = true;
794                         }
795
796                         if (!$update_contact || $no_update) {
797                                 return $contact_id;
798                         }
799                 } elseif ($uid != 0) {
800                         // Non-existing user-specific contact, exiting
801                         return 0;
802                 }
803
804                 $data = Probe::uri($url, "", $uid);
805
806                 // Last try in gcontact for unsupported networks
807                 if (!in_array($data["network"], [NETWORK_DFRN, NETWORK_OSTATUS, NETWORK_DIASPORA, NETWORK_PUMPIO, NETWORK_MAIL])) {
808                         if ($uid != 0) {
809                                 return 0;
810                         }
811
812                         // Get data from the gcontact table
813                         $gcontact = dba::selectFirst('gcontact', ['name', 'nick', 'url', 'photo', 'addr', 'alias', 'network'], ['nurl' => normalise_link($url)]);
814                         if (!DBM::is_result($gcontact)) {
815                                 return 0;
816                         }
817
818                         $data = array_merge($data, $gcontact);
819                 }
820
821                 if (!$contact_id && ($data["alias"] != '') && ($data["alias"] != $url)) {
822                         $contact_id = self::getIdForURL($data["alias"], $uid, true);
823                 }
824
825                 $url = $data["url"];
826                 if (!$contact_id) {
827                         dba::insert('contact', [
828                                 'uid'       => $uid,
829                                 'created'   => DateTimeFormat::utcNow(),
830                                 'url'       => $data["url"],
831                                 'nurl'      => normalise_link($data["url"]),
832                                 'addr'      => $data["addr"],
833                                 'alias'     => $data["alias"],
834                                 'notify'    => $data["notify"],
835                                 'poll'      => $data["poll"],
836                                 'name'      => $data["name"],
837                                 'nick'      => $data["nick"],
838                                 'photo'     => $data["photo"],
839                                 'keywords'  => $data["keywords"],
840                                 'location'  => $data["location"],
841                                 'about'     => $data["about"],
842                                 'network'   => $data["network"],
843                                 'pubkey'    => $data["pubkey"],
844                                 'rel'       => CONTACT_IS_SHARING,
845                                 'priority'  => $data["priority"],
846                                 'batch'     => $data["batch"],
847                                 'request'   => $data["request"],
848                                 'confirm'   => $data["confirm"],
849                                 'poco'      => $data["poco"],
850                                 'name-date' => DateTimeFormat::utcNow(),
851                                 'uri-date'  => DateTimeFormat::utcNow(),
852                                 'avatar-date' => DateTimeFormat::utcNow(),
853                                 'writable'  => 1,
854                                 'blocked'   => 0,
855                                 'readonly'  => 0,
856                                 'pending'   => 0]
857                         );
858
859                         $s = dba::select('contact', ['id'], ['nurl' => normalise_link($data["url"]), 'uid' => $uid], ['order' => ['id'], 'limit' => 2]);
860                         $contacts = dba::inArray($s);
861                         if (!DBM::is_result($contacts)) {
862                                 return 0;
863                         }
864
865                         $contact_id = $contacts[0]["id"];
866
867                         // Update the newly created contact from data in the gcontact table
868                         $gcontact = dba::selectFirst('gcontact', ['location', 'about', 'keywords', 'gender'], ['nurl' => normalise_link($data["url"])]);
869                         if (DBM::is_result($gcontact)) {
870                                 // Only use the information when the probing hadn't fetched these values
871                                 if ($data['keywords'] != '') {
872                                         unset($gcontact['keywords']);
873                                 }
874                                 if ($data['location'] != '') {
875                                         unset($gcontact['location']);
876                                 }
877                                 if ($data['about'] != '') {
878                                         unset($gcontact['about']);
879                                 }
880                                 dba::update('contact', $gcontact, ['id' => $contact_id]);
881                         }
882
883                         if (count($contacts) > 1 && $uid == 0 && $contact_id != 0 && $data["url"] != "") {
884                                 dba::delete('contact', ["`nurl` = ? AND `uid` = 0 AND `id` != ? AND NOT `self`",
885                                         normalise_link($data["url"]), $contact_id]);
886                         }
887                 }
888
889                 self::updateAvatar($data["photo"], $uid, $contact_id);
890
891                 $fields = ['url', 'nurl', 'addr', 'alias', 'name', 'nick', 'keywords', 'location', 'about', 'avatar-date', 'pubkey'];
892                 $contact = dba::selectFirst('contact', $fields, ['id' => $contact_id]);
893
894                 // This condition should always be true
895                 if (!DBM::is_result($contact)) {
896                         return $contact_id;
897                 }
898
899                 $updated = ['addr' => $data['addr'],
900                         'alias' => $data['alias'],
901                         'url' => $data['url'],
902                         'nurl' => normalise_link($data['url']),
903                         'name' => $data['name'],
904                         'nick' => $data['nick']];
905
906                 // Only fill the pubkey if it was empty before. We have to prevent identity theft.
907                 if (!empty($contact['pubkey'])) {
908                         unset($contact['pubkey']);
909                 } else {
910                         $updated['pubkey'] = $data['pubkey'];
911                 }
912
913                 if ($data['keywords'] != '') {
914                         $updated['keywords'] = $data['keywords'];
915                 }
916                 if ($data['location'] != '') {
917                         $updated['location'] = $data['location'];
918                 }
919                 if ($data['about'] != '') {
920                         $updated['about'] = $data['about'];
921                 }
922
923                 if (($data["addr"] != $contact["addr"]) || ($data["alias"] != $contact["alias"])) {
924                         $updated['uri-date'] = DateTimeFormat::utcNow();
925                 }
926                 if (($data["name"] != $contact["name"]) || ($data["nick"] != $contact["nick"])) {
927                         $updated['name-date'] = DateTimeFormat::utcNow();
928                 }
929
930                 $updated['avatar-date'] = DateTimeFormat::utcNow();
931
932                 dba::update('contact', $updated, ['id' => $contact_id], $contact);
933
934                 return $contact_id;
935         }
936
937         /**
938          * @brief Checks if the contact is blocked
939          *
940          * @param int $cid contact id
941          *
942          * @return boolean Is the contact blocked?
943          */
944         public static function isBlocked($cid)
945         {
946                 if ($cid == 0) {
947                         return false;
948                 }
949
950                 $blocked = dba::selectFirst('contact', ['blocked'], ['id' => $cid]);
951                 if (!DBM::is_result($blocked)) {
952                         return false;
953                 }
954                 return (bool) $blocked['blocked'];
955         }
956
957         /**
958          * @brief Checks if the contact is hidden
959          *
960          * @param int $cid contact id
961          *
962          * @return boolean Is the contact hidden?
963          */
964         public static function isHidden($cid)
965         {
966                 if ($cid == 0) {
967                         return false;
968                 }
969
970                 $hidden = dba::selectFirst('contact', ['hidden'], ['id' => $cid]);
971                 if (!DBM::is_result($hidden)) {
972                         return false;
973                 }
974                 return (bool) $hidden['hidden'];
975         }
976
977         /**
978          * @brief Returns posts from a given contact url
979          *
980          * @param string $contact_url Contact URL
981          *
982          * @return string posts in HTML
983          */
984         public static function getPostsFromUrl($contact_url)
985         {
986                 $a = self::getApp();
987
988                 require_once 'include/conversation.php';
989
990                 // There are no posts with "uid = 0" with connector networks
991                 // This speeds up the query a lot
992                 $r = q("SELECT `network`, `id` AS `author-id`, `contact-type` FROM `contact`
993                         WHERE `contact`.`nurl` = '%s' AND `contact`.`uid` = 0",
994                         dbesc(normalise_link($contact_url))
995                 );
996
997                 if (!DBM::is_result($r)) {
998                         return '';
999                 }
1000
1001                 if (in_array($r[0]["network"], [NETWORK_DFRN, NETWORK_DIASPORA, NETWORK_OSTATUS, ""])) {
1002                         $sql = "(`item`.`uid` = 0 OR (`item`.`uid` = %d AND NOT `item`.`global`))";
1003                 } else {
1004                         $sql = "`item`.`uid` = %d";
1005                 }
1006
1007                 $author_id = intval($r[0]["author-id"]);
1008
1009                 $contact = ($r[0]["contact-type"] == ACCOUNT_TYPE_COMMUNITY ? 'owner-id' : 'author-id');
1010
1011                 $r = q(item_query() . " AND `item`.`" . $contact . "` = %d AND " . $sql .
1012                         " AND `item`.`verb` = '%s' ORDER BY `item`.`created` DESC LIMIT %d, %d",
1013                         intval($author_id), intval(local_user()), dbesc(ACTIVITY_POST),
1014                         intval($a->pager['start']), intval($a->pager['itemspage'])
1015                 );
1016
1017                 $o = conversation($a, $r, 'contact-posts', false);
1018
1019                 $o .= alt_pager($a, count($r));
1020
1021                 return $o;
1022         }
1023
1024         /**
1025          * @brief Returns the account type name
1026          *
1027          * The function can be called with either the user or the contact array
1028          *
1029          * @param array $contact contact or user array
1030          * @return string
1031          */
1032         public static function getAccountType(array $contact)
1033         {
1034                 // There are several fields that indicate that the contact or user is a forum
1035                 // "page-flags" is a field in the user table,
1036                 // "forum" and "prv" are used in the contact table. They stand for PAGE_COMMUNITY and PAGE_PRVGROUP.
1037                 // "community" is used in the gcontact table and is true if the contact is PAGE_COMMUNITY or PAGE_PRVGROUP.
1038                 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == PAGE_COMMUNITY))
1039                         || (isset($contact['page-flags']) && (intval($contact['page-flags']) == PAGE_PRVGROUP))
1040                         || (isset($contact['forum']) && intval($contact['forum']))
1041                         || (isset($contact['prv']) && intval($contact['prv']))
1042                         || (isset($contact['community']) && intval($contact['community']))
1043                 ) {
1044                         $type = ACCOUNT_TYPE_COMMUNITY;
1045                 } else {
1046                         $type = ACCOUNT_TYPE_PERSON;
1047                 }
1048
1049                 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1050                 if (isset($contact["contact-type"])) {
1051                         $type = $contact["contact-type"];
1052                 }
1053
1054                 if (isset($contact["account-type"])) {
1055                         $type = $contact["account-type"];
1056                 }
1057
1058                 switch ($type) {
1059                         case ACCOUNT_TYPE_ORGANISATION:
1060                                 $account_type = L10n::t("Organisation");
1061                                 break;
1062                         case ACCOUNT_TYPE_NEWS:
1063                                 $account_type = L10n::t('News');
1064                                 break;
1065                         case ACCOUNT_TYPE_COMMUNITY:
1066                                 $account_type = L10n::t("Forum");
1067                                 break;
1068                         default:
1069                                 $account_type = "";
1070                                 break;
1071                 }
1072
1073                 return $account_type;
1074         }
1075
1076         /**
1077          * @brief Blocks a contact
1078          *
1079          * @param int $uid
1080          * @return bool
1081          */
1082         public static function block($uid)
1083         {
1084                 $return = dba::update('contact', ['blocked' => true], ['id' => $uid]);
1085
1086                 return $return;
1087         }
1088
1089         /**
1090          * @brief Unblocks a contact
1091          *
1092          * @param int $uid
1093          * @return bool
1094          */
1095         public static function unblock($uid)
1096         {
1097                 $return = dba::update('contact', ['blocked' => false], ['id' => $uid]);
1098
1099                 return $return;
1100         }
1101
1102         /**
1103          * @brief Updates the avatar links in a contact only if needed
1104          *
1105          * @param string $avatar Link to avatar picture
1106          * @param int    $uid    User id of contact owner
1107          * @param int    $cid    Contact id
1108          * @param bool   $force  force picture update
1109          *
1110          * @return array Returns array of the different avatar sizes
1111          */
1112         public static function updateAvatar($avatar, $uid, $cid, $force = false)
1113         {
1114                 $contact = dba::selectFirst('contact', ['avatar', 'photo', 'thumb', 'micro', 'nurl'], ['id' => $cid]);
1115                 if (!DBM::is_result($contact)) {
1116                         return false;
1117                 } else {
1118                         $data = [$contact["photo"], $contact["thumb"], $contact["micro"]];
1119                 }
1120
1121                 if (($contact["avatar"] != $avatar) || $force) {
1122                         $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1123
1124                         if ($photos) {
1125                                 dba::update(
1126                                         'contact',
1127                                         ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()],
1128                                         ['id' => $cid]
1129                                 );
1130
1131                                 // Update the public contact (contact id = 0)
1132                                 if ($uid != 0) {
1133                                         $pcontact = dba::selectFirst('contact', ['id'], ['nurl' => $contact['nurl'], 'uid' => 0]);
1134                                         if (DBM::is_result($pcontact)) {
1135                                                 self::updateAvatar($avatar, 0, $pcontact['id'], $force);
1136                                         }
1137                                 }
1138
1139                                 return $photos;
1140                         }
1141                 }
1142
1143                 return $data;
1144         }
1145
1146         /**
1147          * @param integer $id contact id
1148          * @return boolean
1149          */
1150         public static function updateFromProbe($id)
1151         {
1152                 /*
1153                   Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
1154                   This will reliably kill your communication with Friendica contacts.
1155                  */
1156
1157                 $fields = ['url', 'nurl', 'addr', 'alias', 'batch', 'notify', 'poll', 'poco', 'network'];
1158                 $contact = dba::selectFirst('contact', $fields, ['id' => $id]);
1159                 if (!DBM::is_result($contact)) {
1160                         return false;
1161                 }
1162
1163                 $ret = Probe::uri($contact["url"]);
1164
1165                 // If Probe::uri fails the network code will be different
1166                 if ($ret["network"] != $contact["network"]) {
1167                         return false;
1168                 }
1169
1170                 $update = false;
1171
1172                 // make sure to not overwrite existing values with blank entries
1173                 foreach ($ret as $key => $val) {
1174                         if (isset($contact[$key]) && ($contact[$key] != "") && ($val == "")) {
1175                                 $ret[$key] = $contact[$key];
1176                         }
1177
1178                         if (isset($contact[$key]) && ($ret[$key] != $contact[$key])) {
1179                                 $update = true;
1180                         }
1181                 }
1182
1183                 if (!$update) {
1184                         return true;
1185                 }
1186
1187                 dba::update(
1188                         'contact', [
1189                                 'url'    => $ret['url'],
1190                                 'nurl'   => normalise_link($ret['url']),
1191                                 'addr'   => $ret['addr'],
1192                                 'alias'  => $ret['alias'],
1193                                 'batch'  => $ret['batch'],
1194                                 'notify' => $ret['notify'],
1195                                 'poll'   => $ret['poll'],
1196                                 'poco'   => $ret['poco']
1197                         ],
1198                         ['id' => $id]
1199                 );
1200
1201                 // Update the corresponding gcontact entry
1202                 PortableContact::lastUpdated($ret["url"]);
1203
1204                 return true;
1205         }
1206
1207         /**
1208          * Takes a $uid and a url/handle and adds a new contact
1209          * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
1210          * dfrn_request page.
1211          *
1212          * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
1213          *
1214          * Returns an array
1215          * $return['success'] boolean true if successful
1216          * $return['message'] error text if success is false.
1217          *
1218          * @brief Takes a $uid and a url/handle and adds a new contact
1219          * @param int    $uid
1220          * @param string $url
1221          * @param bool   $interactive
1222          * @param string $network
1223          * @return boolean|string
1224          */
1225         public static function createFromProbe($uid, $url, $interactive = false, $network = '')
1226         {
1227                 $result = ['cid' => -1, 'success' => false, 'message' => ''];
1228
1229                 $a = get_app();
1230
1231                 // remove ajax junk, e.g. Twitter
1232                 $url = str_replace('/#!/', '/', $url);
1233
1234                 if (!Network::isUrlAllowed($url)) {
1235                         $result['message'] = L10n::t('Disallowed profile URL.');
1236                         return $result;
1237                 }
1238
1239                 if (Network::isUrlBlocked($url)) {
1240                         $result['message'] = L10n::t('Blocked domain');
1241                         return $result;
1242                 }
1243
1244                 if (!$url) {
1245                         $result['message'] = L10n::t('Connect URL missing.');
1246                         return $result;
1247                 }
1248
1249                 $arr = ['url' => $url, 'contact' => []];
1250
1251                 Addon::callHooks('follow', $arr);
1252
1253                 if (empty($arr)) {
1254                         $result['message'] = L10n::t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
1255                         return $result;
1256                 }
1257
1258                 if (x($arr['contact'], 'name')) {
1259                         $ret = $arr['contact'];
1260                 } else {
1261                         $ret = Probe::uri($url, $network, $uid, false);
1262                 }
1263
1264                 if (($network != '') && ($ret['network'] != $network)) {
1265                         logger('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
1266                         return result;
1267                 }
1268
1269                 // check if we already have a contact
1270                 // the poll url is more reliable than the profile url, as we may have
1271                 // indirect links or webfinger links
1272
1273                 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `poll` IN ('%s', '%s') AND `network` = '%s' AND NOT `pending` LIMIT 1",
1274                         intval($uid),
1275                         dbesc($ret['poll']),
1276                         dbesc(normalise_link($ret['poll'])),
1277                         dbesc($ret['network'])
1278                 );
1279
1280                 if (!DBM::is_result($r)) {
1281                         $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `nurl` = '%s' AND `network` = '%s' AND NOT `pending` LIMIT 1",
1282                                 intval($uid),
1283                                 dbesc(normalise_link($url)),
1284                                 dbesc($ret['network'])
1285                         );
1286                 }
1287
1288                 if (($ret['network'] === NETWORK_DFRN) && !DBM::is_result($r)) {
1289                         if ($interactive) {
1290                                 if (strlen($a->path)) {
1291                                         $myaddr = bin2hex(System::baseUrl() . '/profile/' . $a->user['nickname']);
1292                                 } else {
1293                                         $myaddr = bin2hex($a->user['nickname'] . '@' . $a->get_hostname());
1294                                 }
1295
1296                                 goaway($ret['request'] . "&addr=$myaddr");
1297
1298                                 // NOTREACHED
1299                         }
1300                 } elseif (Config::get('system', 'dfrn_only') && ($ret['network'] != NETWORK_DFRN)) {
1301                         $result['message'] = L10n::t('This site is not configured to allow communications with other networks.') . EOL;
1302                         $result['message'] != L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
1303                         return $result;
1304                 }
1305
1306                 // This extra param just confuses things, remove it
1307                 if ($ret['network'] === NETWORK_DIASPORA) {
1308                         $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
1309                 }
1310
1311                 // do we have enough information?
1312
1313                 if (!((x($ret, 'name')) && (x($ret, 'poll')) && ((x($ret, 'url')) || (x($ret, 'addr'))))) {
1314                         $result['message'] .= L10n::t('The profile address specified does not provide adequate information.') . EOL;
1315                         if (!x($ret, 'poll')) {
1316                                 $result['message'] .= L10n::t('No compatible communication protocols or feeds were discovered.') . EOL;
1317                         }
1318                         if (!x($ret, 'name')) {
1319                                 $result['message'] .= L10n::t('An author or name was not found.') . EOL;
1320                         }
1321                         if (!x($ret, 'url')) {
1322                                 $result['message'] .= L10n::t('No browser URL could be matched to this address.') . EOL;
1323                         }
1324                         if (strpos($url, '@') !== false) {
1325                                 $result['message'] .= L10n::t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
1326                                 $result['message'] .= L10n::t('Use mailto: in front of address to force email check.') . EOL;
1327                         }
1328                         return $result;
1329                 }
1330
1331                 if ($ret['network'] === NETWORK_OSTATUS && Config::get('system', 'ostatus_disabled')) {
1332                         $result['message'] .= L10n::t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
1333                         $ret['notify'] = '';
1334                 }
1335
1336                 if (!$ret['notify']) {
1337                         $result['message'] .= L10n::t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
1338                 }
1339
1340                 $writeable = ((($ret['network'] === NETWORK_OSTATUS) && ($ret['notify'])) ? 1 : 0);
1341
1342                 $subhub = (($ret['network'] === NETWORK_OSTATUS) ? true : false);
1343
1344                 $hidden = (($ret['network'] === NETWORK_MAIL) ? 1 : 0);
1345
1346                 if (in_array($ret['network'], [NETWORK_MAIL, NETWORK_DIASPORA])) {
1347                         $writeable = 1;
1348                 }
1349
1350                 if (DBM::is_result($r)) {
1351                         // update contact
1352                         $new_relation = (($r[0]['rel'] == CONTACT_IS_FOLLOWER) ? CONTACT_IS_FRIEND : CONTACT_IS_SHARING);
1353
1354                         $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
1355                         dba::update('contact', $fields, ['id' => $r[0]['id']]);
1356                 } else {
1357                         $new_relation = ((in_array($ret['network'], [NETWORK_MAIL])) ? CONTACT_IS_FRIEND : CONTACT_IS_SHARING);
1358
1359                         // create contact record
1360                         dba::insert('contact', [
1361                                 'uid'     => $uid,
1362                                 'created' => DateTimeFormat::utcNow(),
1363                                 'url'     => $ret['url'],
1364                                 'nurl'    => normalise_link($ret['url']),
1365                                 'addr'    => $ret['addr'],
1366                                 'alias'   => $ret['alias'],
1367                                 'batch'   => $ret['batch'],
1368                                 'notify'  => $ret['notify'],
1369                                 'poll'    => $ret['poll'],
1370                                 'poco'    => $ret['poco'],
1371                                 'name'    => $ret['name'],
1372                                 'nick'    => $ret['nick'],
1373                                 'network' => $ret['network'],
1374                                 'pubkey'  => $ret['pubkey'],
1375                                 'rel'     => $new_relation,
1376                                 'priority'=> $ret['priority'],
1377                                 'writable'=> $writeable,
1378                                 'hidden'  => $hidden,
1379                                 'blocked' => 0,
1380                                 'readonly'=> 0,
1381                                 'pending' => 0,
1382                                 'subhub'  => $subhub
1383                         ]);
1384                 }
1385
1386                 $contact = dba::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
1387                 if (!DBM::is_result($contact)) {
1388                         $result['message'] .= L10n::t('Unable to retrieve contact information.') . EOL;
1389                         return $result;
1390                 }
1391
1392                 $contact_id = $contact['id'];
1393                 $result['cid'] = $contact_id;
1394
1395                 Group::addMember(User::getDefaultGroup($uid, $contact["network"]), $contact_id);
1396
1397                 // Update the avatar
1398                 self::updateAvatar($ret['photo'], $uid, $contact_id);
1399
1400                 // pull feed and consume it, which should subscribe to the hub.
1401
1402                 Worker::add(PRIORITY_HIGH, "OnePoll", $contact_id, "force");
1403
1404                 $r = q("SELECT `contact`.*, `user`.* FROM `contact` INNER JOIN `user` ON `contact`.`uid` = `user`.`uid`
1405                         WHERE `user`.`uid` = %d AND `contact`.`self` LIMIT 1",
1406                         intval($uid)
1407                 );
1408
1409                 if (DBM::is_result($r)) {
1410                         if (in_array($contact['network'], [NETWORK_OSTATUS, NETWORK_DFRN])) {
1411                                 // create a follow slap
1412                                 $item = [];
1413                                 $item['verb'] = ACTIVITY_FOLLOW;
1414                                 $item['follow'] = $contact["url"];
1415                                 $slap = OStatus::salmon($item, $r[0]);
1416                                 if (!empty($contact['notify'])) {
1417                                         Salmon::slapper($r[0], $contact['notify'], $slap);
1418                                 }
1419                         } elseif ($contact['network'] == NETWORK_DIASPORA) {
1420                                 $ret = Diaspora::sendShare($a->user, $contact);
1421                                 logger('share returns: ' . $ret);
1422                         }
1423                 }
1424
1425                 $result['success'] = true;
1426                 return $result;
1427         }
1428
1429         public static function updateSslPolicy($contact, $new_policy)
1430         {
1431                 $ssl_changed = false;
1432                 if ((intval($new_policy) == SSL_POLICY_SELFSIGN || $new_policy === 'self') && strstr($contact['url'], 'https:')) {
1433                         $ssl_changed = true;
1434                         $contact['url']     =   str_replace('https:', 'http:', $contact['url']);
1435                         $contact['request'] =   str_replace('https:', 'http:', $contact['request']);
1436                         $contact['notify']  =   str_replace('https:', 'http:', $contact['notify']);
1437                         $contact['poll']    =   str_replace('https:', 'http:', $contact['poll']);
1438                         $contact['confirm'] =   str_replace('https:', 'http:', $contact['confirm']);
1439                         $contact['poco']    =   str_replace('https:', 'http:', $contact['poco']);
1440                 }
1441
1442                 if ((intval($new_policy) == SSL_POLICY_FULL || $new_policy === 'full') && strstr($contact['url'], 'http:')) {
1443                         $ssl_changed = true;
1444                         $contact['url']     =   str_replace('http:', 'https:', $contact['url']);
1445                         $contact['request'] =   str_replace('http:', 'https:', $contact['request']);
1446                         $contact['notify']  =   str_replace('http:', 'https:', $contact['notify']);
1447                         $contact['poll']    =   str_replace('http:', 'https:', $contact['poll']);
1448                         $contact['confirm'] =   str_replace('http:', 'https:', $contact['confirm']);
1449                         $contact['poco']    =   str_replace('http:', 'https:', $contact['poco']);
1450                 }
1451
1452                 if ($ssl_changed) {
1453                         $fields = ['url' => $contact['url'], 'request' => $contact['request'],
1454                                         'notify' => $contact['notify'], 'poll' => $contact['poll'],
1455                                         'confirm' => $contact['confirm'], 'poco' => $contact['poco']];
1456                         dba::update('contact', $fields, ['id' => $contact['id']]);
1457                 }
1458
1459                 return $contact;
1460         }
1461
1462         public static function addRelationship($importer, $contact, $datarray, $item, $sharing = false) {
1463                 $url = notags(trim($datarray['author-link']));
1464                 $name = notags(trim($datarray['author-name']));
1465                 $photo = notags(trim($datarray['author-avatar']));
1466                 $nick = '';
1467
1468                 if (is_object($item)) {
1469                         $rawtag = $item->get_item_tags(NAMESPACE_ACTIVITY,'actor');
1470                         if ($rawtag && $rawtag[0]['child'][NAMESPACE_POCO]['preferredUsername'][0]['data']) {
1471                                 $nick = $rawtag[0]['child'][NAMESPACE_POCO]['preferredUsername'][0]['data'];
1472                         }
1473                 } else {
1474                         $nick = $item;
1475                 }
1476
1477                 if (is_array($contact)) {
1478                         if (($contact['rel'] == CONTACT_IS_SHARING)
1479                                 || ($sharing && $contact['rel'] == CONTACT_IS_FOLLOWER)) {
1480                                 dba::update('contact', ['rel' => CONTACT_IS_FRIEND, 'writable' => true],
1481                                                 ['id' => $contact['id'], 'uid' => $importer['uid']]);
1482                         }
1483                         // send email notification to owner?
1484                 } else {
1485                         if (dba::exists('contact', ['nurl' => normalise_link($url), 'uid' => $importer['uid'], 'pending' => true])) {
1486                                 logger('ignoring duplicated connection request from pending contact ' . $url);
1487                                 return;
1488                         }
1489
1490                         // create contact record
1491                         q("INSERT INTO `contact` (`uid`, `created`, `url`, `nurl`, `name`, `nick`, `photo`, `network`, `rel`,
1492                                 `blocked`, `readonly`, `pending`, `writable`)
1493                                 VALUES (%d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, 0, 0, 1, 1)",
1494                                 intval($importer['uid']),
1495                                 dbesc(DateTimeFormat::utcNow()),
1496                                 dbesc($url),
1497                                 dbesc(normalise_link($url)),
1498                                 dbesc($name),
1499                                 dbesc($nick),
1500                                 dbesc($photo),
1501                                 dbesc(NETWORK_OSTATUS),
1502                                 intval(CONTACT_IS_FOLLOWER)
1503                         );
1504
1505                         $contact_record = [
1506                                 'id' => dba::lastInsertId(),
1507                                 'network' => NETWORK_OSTATUS
1508                         ];
1509                         Contact::updateAvatar($photo, $importer["uid"], $contact_record["id"], true);
1510
1511                         /// @TODO Encapsulate this into a function/method
1512                         $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
1513                         $user = dba::selectFirst('user', $fields, ['uid' => $importer['uid']]);
1514                         if (DBM::is_result($user) && !in_array($user['page-flags'], [PAGE_SOAPBOX, PAGE_FREELOVE, PAGE_COMMUNITY])) {
1515                                 // create notification
1516                                 $hash = random_string();
1517
1518                                 if (is_array($contact_record)) {
1519                                         dba::insert('intro', ['uid' => $importer['uid'], 'contact-id' => $contact_record['id'],
1520                                                                 'blocked' => false, 'knowyou' => false,
1521                                                                 'hash' => $hash, 'datetime' => DateTimeFormat::utcNow()]);
1522                                 }
1523
1524                                 Group::addMember(User::getDefaultGroup($importer['uid'], $contact_record["network"]), $contact_record['id']);
1525
1526                                 if (($user['notify-flags'] & NOTIFY_INTRO) &&
1527                                         in_array($user['page-flags'], [PAGE_NORMAL])) {
1528
1529                                         notification([
1530                                                 'type'         => NOTIFY_INTRO,
1531                                                 'notify_flags' => $user['notify-flags'],
1532                                                 'language'     => $user['language'],
1533                                                 'to_name'      => $user['username'],
1534                                                 'to_email'     => $user['email'],
1535                                                 'uid'          => $user['uid'],
1536                                                 'link'             => System::baseUrl() . '/notifications/intro',
1537                                                 'source_name'  => ((strlen(stripslashes($contact_record['name']))) ? stripslashes($contact_record['name']) : L10n::t('[Name Withheld]')),
1538                                                 'source_link'  => $contact_record['url'],
1539                                                 'source_photo' => $contact_record['photo'],
1540                                                 'verb'         => ($sharing ? ACTIVITY_FRIEND : ACTIVITY_FOLLOW),
1541                                                 'otype'        => 'intro'
1542                                         ]);
1543
1544                                 }
1545                         } elseif (DBM::is_result($user) && in_array($user['page-flags'], [PAGE_SOAPBOX, PAGE_FREELOVE, PAGE_COMMUNITY])) {
1546                                 q("UPDATE `contact` SET `pending` = 0 WHERE `uid` = %d AND `url` = '%s' AND `pending` LIMIT 1",
1547                                                 intval($importer['uid']),
1548                                                 dbesc($url)
1549                                 );
1550                         }
1551                 }
1552         }
1553
1554         public static function removeFollower($importer, $contact, array $datarray = [], $item = "") {
1555
1556                 if (($contact['rel'] == CONTACT_IS_FRIEND) || ($contact['rel'] == CONTACT_IS_SHARING)) {
1557                         dba::update('contact', ['rel' => CONTACT_IS_SHARING], ['id' => $contact['id']]);
1558                 } else {
1559                         Contact::remove($contact['id']);
1560                 }
1561         }
1562
1563         public static function removeSharer($importer, $contact, array $datarray = [], $item = "") {
1564
1565                 if (($contact['rel'] == CONTACT_IS_FRIEND) || ($contact['rel'] == CONTACT_IS_FOLLOWER)) {
1566                         dba::update('contact', ['rel' => CONTACT_IS_FOLLOWER], ['id' => $contact['id']]);
1567                 } else {
1568                         Contact::remove($contact['id']);
1569                 }
1570         }
1571
1572         /**
1573          * @brief Create a birthday event.
1574          *
1575          * Update the year and the birthday.
1576          */
1577         public static function updateBirthdays()
1578         {
1579                 // This only handles foreign or alien networks where a birthday has been provided.
1580                 // In-network birthdays are handled within local_delivery
1581
1582                 $r = q("SELECT * FROM `contact` WHERE `bd` != '' AND `bd` > '0001-01-01' AND SUBSTRING(`bd`, 1, 4) != `bdyear` ");
1583                 if (DBM::is_result($r)) {
1584                         foreach ($r as $rr) {
1585                                 logger('update_contact_birthday: ' . $rr['bd']);
1586
1587                                 $nextbd = DateTimeFormat::utcNow('Y') . substr($rr['bd'], 4);
1588
1589                                 /*
1590                                  * Add new birthday event for this person
1591                                  *
1592                                  * $bdtext is just a readable placeholder in case the event is shared
1593                                  * with others. We will replace it during presentation to our $importer
1594                                  * to contain a sparkle link and perhaps a photo.
1595                                  */
1596
1597                                 // Check for duplicates
1598                                 $s = q("SELECT `id` FROM `event` WHERE `uid` = %d AND `cid` = %d AND `start` = '%s' AND `type` = '%s' LIMIT 1",
1599                                         intval($rr['uid']), intval($rr['id']), dbesc(DateTimeFormat::utc($nextbd)), dbesc('birthday'));
1600
1601                                 if (DBM::is_result($s)) {
1602                                         continue;
1603                                 }
1604
1605                                 $bdtext = L10n::t('%s\'s birthday', $rr['name']);
1606                                 $bdtext2 = L10n::t('Happy Birthday %s', ' [url=' . $rr['url'] . ']' . $rr['name'] . '[/url]');
1607
1608                                 q("INSERT INTO `event` (`uid`,`cid`,`created`,`edited`,`start`,`finish`,`summary`,`desc`,`type`,`adjust`)
1609                                 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%d' ) ", intval($rr['uid']), intval($rr['id']),
1610                                         dbesc(DateTimeFormat::utcNow()), dbesc(DateTimeFormat::utcNow()), dbesc(DateTimeFormat::utc($nextbd)),
1611                                         dbesc(DateTimeFormat::utc($nextbd . ' + 1 day ')), dbesc($bdtext), dbesc($bdtext2), dbesc('birthday'),
1612                                         intval(0)
1613                                 );
1614
1615
1616                                 // update bdyear
1617                                 q("UPDATE `contact` SET `bdyear` = '%s', `bd` = '%s' WHERE `uid` = %d AND `id` = %d", dbesc(substr($nextbd, 0, 4)),
1618                                         dbesc($nextbd), intval($rr['uid']), intval($rr['id'])
1619                                 );
1620                         }
1621                 }
1622         }
1623
1624         /**
1625          * Remove the unavailable contact ids from the provided list
1626          *
1627          * @param array $contact_ids Contact id list
1628          */
1629         public static function pruneUnavailable(array &$contact_ids)
1630         {
1631                 if (empty($contact_ids)) {
1632                         return;
1633                 }
1634
1635                 $str = dbesc(implode(',', $contact_ids));
1636
1637                 $stmt = dba::p("SELECT `id` FROM `contact` WHERE `id` IN ( " . $str . ") AND `blocked` = 0 AND `pending` = 0 AND `archive` = 0");
1638
1639                 $return = [];
1640                 while($contact = dba::fetch($stmt)) {
1641                         $return[] = $contact['id'];
1642                 }
1643
1644                 dba::close($stmt);
1645
1646                 $contact_ids = $return;
1647         }
1648 }