4 * @file mod/dfrn_request.php
7 * Purpose: Handles communication associated with the issuance of
10 * @see PDF with dfrn specs: https://github.com/friendica/friendica/blob/master/spec/dfrn2.pdf
11 * You also find a graphic which describes the confirmation process at
12 * https://github.com/friendica/friendica/blob/master/spec/dfrn2_contact_request.png
16 use Friendica\Core\Logger;
17 use Friendica\Core\Protocol;
18 use Friendica\Core\Renderer;
19 use Friendica\Core\Search;
20 use Friendica\Core\System;
21 use Friendica\Core\Session;
22 use Friendica\Database\DBA;
24 use Friendica\Model\Contact;
25 use Friendica\Model\Group;
26 use Friendica\Model\Notify\Type;
27 use Friendica\Model\Profile;
28 use Friendica\Model\User;
29 use Friendica\Module\Security\Login;
30 use Friendica\Network\Probe;
31 use Friendica\Protocol\Activity;
32 use Friendica\Util\DateTimeFormat;
33 use Friendica\Util\Network;
34 use Friendica\Util\Strings;
36 function dfrn_request_init(App $a)
40 Profile::load($a, $which);
47 * Function: dfrn_request_post
50 * Handles multiple scenarios.
53 * Clicking 'submit' on a friend request page.
56 * Following Scenario 1, we are brought back to our home site
57 * in order to link our friend request with our own server cell.
58 * After logging in, we click 'submit' to approve the linkage.
61 * @throws ImagickException
62 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
64 function dfrn_request_post(App $a)
66 if ($a->argc != 2 || empty($a->profile)) {
67 Logger::log('Wrong count of argc or profiles: argc=' . $a->argc . ', profile()=' . count($a->profile ?? []));
71 if (!empty($_POST['cancel'])) {
72 DI::baseUrl()->redirect();
76 * Scenario 2: We've introduced ourself to another cell, then have been returned to our own cell
77 * to confirm the request, and then we've clicked submit (perhaps after logging in).
78 * That brings us here:
80 if (!empty($_POST['localconfirm']) && ($_POST['localconfirm'] == 1)) {
81 // Ensure this is a valid request
82 if (local_user() && ($a->user['nickname'] == $a->argv[1]) && !empty($_POST['dfrn_url'])) {
83 $dfrn_url = Strings::escapeTags(trim($_POST['dfrn_url']));
84 $aes_allow = !empty($_POST['aes_allow']);
85 $confirm_key = $_POST['confirm_key'] ?? '';
86 $hidden = (!empty($_POST['hidden-contact']) ? intval($_POST['hidden-contact']) : 0);
87 $contact_record = null;
91 if (!empty($dfrn_url)) {
92 // Lookup the contact based on their URL (which is the only unique thing we have at the moment)
93 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `nurl` = '%s' AND NOT `self` LIMIT 1",
95 DBA::escape(Strings::normaliseLink($dfrn_url))
98 if (DBA::isResult($r)) {
99 if (strlen($r[0]['dfrn-id'])) {
100 // We don't need to be here. It has already happened.
101 notice(DI::l10n()->t("This introduction has already been accepted.") . EOL);
104 $contact_record = $r[0];
108 if (is_array($contact_record)) {
109 $r = q("UPDATE `contact` SET `ret-aes` = %d, hidden = %d WHERE `id` = %d",
112 intval($contact_record['id'])
115 // Scrape the other site's profile page to pick up the dfrn links, key, fn, and photo
116 $parms = Probe::profile($dfrn_url);
118 if (!count($parms)) {
119 notice(DI::l10n()->t('Profile location is not valid or does not contain profile information.') . EOL);
122 if (empty($parms['fn'])) {
123 notice(DI::l10n()->t('Warning: profile location has no identifiable owner name.') . EOL);
125 if (empty($parms['photo'])) {
126 notice(DI::l10n()->t('Warning: profile location has no profile photo.') . EOL);
128 $invalid = Probe::validDfrn($parms);
130 notice(DI::l10n()->tt("%d required parameter was not found at the given location", "%d required parameters were not found at the given location", $invalid) . EOL);
135 $dfrn_request = $parms['dfrn-request'];
137 $photo = $parms["photo"];
139 // Escape the entire array
140 DBA::escapeArray($parms);
142 // Create a contact record on our site for the other person
143 $r = q("INSERT INTO `contact` ( `uid`, `created`,`url`, `nurl`, `addr`, `name`, `nick`, `photo`, `site-pubkey`,
144 `request`, `confirm`, `notify`, `poll`, `network`, `aes_allow`, `hidden`, `blocked`, `pending`)
145 VALUES ( %d, '%s', '%s', '%s', '%s', '%s' , '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, %d, %d)",
146 intval(local_user()),
147 DateTimeFormat::utcNow(),
148 DBA::escape($dfrn_url),
149 DBA::escape(Strings::normaliseLink($dfrn_url)),
155 $parms['dfrn-request'],
156 $parms['dfrn-confirm'],
157 $parms['dfrn-notify'],
159 DBA::escape(Protocol::DFRN),
168 info(DI::l10n()->t("Introduction complete.") . EOL);
171 $r = q("SELECT `id`, `network` FROM `contact` WHERE `uid` = %d AND `url` = '%s' AND `site-pubkey` = '%s' LIMIT 1",
172 intval(local_user()),
173 DBA::escape($dfrn_url),
174 $parms['key'] ?? '' // Potentially missing
176 if (DBA::isResult($r)) {
177 Group::addMember(User::getDefaultGroup(local_user(), $r[0]["network"]), $r[0]['id']);
180 Contact::updateAvatar($photo, local_user(), $r[0]["id"], true);
183 $forward_path = "contact/" . $r[0]['id'];
185 $forward_path = "contact";
188 // Allow the blocked remote notification to complete
189 if (is_array($contact_record)) {
190 $dfrn_request = $contact_record['request'];
193 if (!empty($dfrn_request) && strlen($confirm_key)) {
194 Network::fetchUrl($dfrn_request . '?confirm_key=' . $confirm_key);
197 // (ignore reply, nothing we can do it failed)
198 DI::baseUrl()->redirect($forward_path);
199 return; // NOTREACHED
203 // invalid/bogus request
204 notice(DI::l10n()->t('Unrecoverable protocol error.') . EOL);
205 DI::baseUrl()->redirect();
206 return; // NOTREACHED
213 * We are the requestee. A person from a remote cell has made an introduction
214 * on our profile web page and clicked submit. We will use their DFRN-URL to
215 * figure out how to contact their cell.
217 * Scrape the originating DFRN-URL for everything we need. Create a contact record
218 * and an introduction to show our user next time he/she logs in.
219 * Finally redirect back to the requestor so that their site can record the request.
220 * If our user (the requestee) later confirms this request, a record of it will need
221 * to exist on the requestor's cell in order for the confirmation process to complete..
223 * It's possible that neither the requestor or the requestee are logged in at the moment,
224 * and the requestor does not yet have any credentials to the requestee profile.
226 * Who is the requestee? We've already loaded their profile which means their nickname should be
227 * in $a->argv[1] and we should have their complete info in $a->profile.
230 if (empty($a->profile['uid'])) {
231 notice(DI::l10n()->t('Profile unavailable.') . EOL);
235 $nickname = $a->profile['nickname'];
236 $uid = $a->profile['uid'];
237 $maxreq = intval($a->profile['maxreq']);
238 $contact_record = null;
244 if (!empty($_POST['dfrn_url'])) {
245 // Block friend request spam
247 $r = q("SELECT * FROM `intro` WHERE `datetime` > '%s' AND `uid` = %d",
248 DBA::escape(DateTimeFormat::utc('now - 24 hours')),
251 if (DBA::isResult($r) && count($r) > $maxreq) {
252 notice(DI::l10n()->t('%s has received too many connection requests today.', $a->profile['name']) . EOL);
253 notice(DI::l10n()->t('Spam protection measures have been invoked.') . EOL);
254 notice(DI::l10n()->t('Friends are advised to please try again in 24 hours.') . EOL);
259 /* Cleanup old introductions that remain blocked.
260 * Also remove the contact record, but only if there is no existing relationship
262 $r = q("SELECT `intro`.*, `intro`.`id` AS `iid`, `contact`.`id` AS `cid`, `contact`.`rel`
263 FROM `intro` LEFT JOIN `contact` on `intro`.`contact-id` = `contact`.`id`
264 WHERE `intro`.`blocked` = 1 AND `contact`.`self` = 0
265 AND `intro`.`datetime` < UTC_TIMESTAMP() - INTERVAL 30 MINUTE "
267 if (DBA::isResult($r)) {
268 foreach ($r as $rr) {
270 DBA::delete('contact', ['id' => $rr['cid'], 'self' => false]);
272 DBA::delete('intro', ['id' => $rr['iid']]);
276 $url = trim($_POST['dfrn_url']);
278 notice(DI::l10n()->t("Invalid locator") . EOL);
284 // Detect the network
285 $data = Probe::uri($url);
286 $network = $data["network"];
288 // Canonicalise email-style profile locator
289 $url = Probe::webfingerDfrn($url, $hcard);
291 if (substr($url, 0, 5) === 'stat:') {
292 // Every time we detect the remote subscription we define this as OStatus.
293 // We do this even if it is not OStatus.
294 // we only need to pass this through another section of the code.
295 if ($network != Protocol::DIASPORA) {
296 $network = Protocol::OSTATUS;
299 $url = substr($url, 5);
301 $network = Protocol::DFRN;
304 Logger::log('dfrn_request: url: ' . $url . ',network=' . $network, Logger::DEBUG);
306 if ($network === Protocol::DFRN) {
307 $ret = q("SELECT * FROM `contact` WHERE `uid` = %d AND `url` = '%s' AND `self` = 0 LIMIT 1",
312 if (DBA::isResult($ret)) {
313 if (strlen($ret[0]['issued-id'])) {
314 notice(DI::l10n()->t('You have already introduced yourself here.') . EOL);
316 } elseif ($ret[0]['rel'] == Contact::FRIEND) {
317 notice(DI::l10n()->t('Apparently you are already friends with %s.', $a->profile['name']) . EOL);
320 $contact_record = $ret[0];
321 $parms = ['dfrn-request' => $ret[0]['request']];
325 $issued_id = Strings::getRandomHex();
327 if (is_array($contact_record)) {
328 // There is a contact record but no issued-id, so this
329 // is a reciprocal introduction from a known contact
330 $r = q("UPDATE `contact` SET `issued-id` = '%s' WHERE `id` = %d",
331 DBA::escape($issued_id),
332 intval($contact_record['id'])
335 $url = Network::isUrlValid($url);
337 notice(DI::l10n()->t('Invalid profile URL.') . EOL);
338 DI::baseUrl()->redirect(DI::args()->getCommand());
339 return; // NOTREACHED
342 if (!Network::isUrlAllowed($url)) {
343 notice(DI::l10n()->t('Disallowed profile URL.') . EOL);
344 DI::baseUrl()->redirect(DI::args()->getCommand());
345 return; // NOTREACHED
348 if (Network::isUrlBlocked($url)) {
349 notice(DI::l10n()->t('Blocked domain') . EOL);
350 DI::baseUrl()->redirect(DI::args()->getCommand());
351 return; // NOTREACHED
354 $parms = Probe::profile(($hcard) ? $hcard : $url);
356 if (!count($parms)) {
357 notice(DI::l10n()->t('Profile location is not valid or does not contain profile information.') . EOL);
358 DI::baseUrl()->redirect(DI::args()->getCommand());
360 if (empty($parms['fn'])) {
361 notice(DI::l10n()->t('Warning: profile location has no identifiable owner name.') . EOL);
363 if (empty($parms['photo'])) {
364 notice(DI::l10n()->t('Warning: profile location has no profile photo.') . EOL);
366 $invalid = Probe::validDfrn($parms);
368 notice(DI::l10n()->tt("%d required parameter was not found at the given location", "%d required parameters were not found at the given location", $invalid) . EOL);
374 $parms['url'] = $url;
375 $parms['issued-id'] = $issued_id;
376 $photo = $parms["photo"];
378 DBA::escapeArray($parms);
379 $r = q("INSERT INTO `contact` ( `uid`, `created`, `url`, `nurl`, `addr`, `name`, `nick`, `issued-id`, `photo`, `site-pubkey`,
380 `request`, `confirm`, `notify`, `poll`, `network`, `blocked`, `pending` )
381 VALUES ( %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d )",
383 DBA::escape(DateTimeFormat::utcNow()),
385 DBA::escape(Strings::normaliseLink($url)),
392 $parms['dfrn-request'],
393 $parms['dfrn-confirm'],
394 $parms['dfrn-notify'],
396 DBA::escape(Protocol::DFRN),
401 // find the contact record we just created
403 $r = q("SELECT `id` FROM `contact`
404 WHERE `uid` = %d AND `url` = '%s' AND `issued-id` = '%s' LIMIT 1",
409 if (DBA::isResult($r)) {
410 $contact_record = $r[0];
411 Contact::updateAvatar($photo, $uid, $contact_record["id"], true);
416 notice(DI::l10n()->t('Failed to update contact record.') . EOL);
420 $hash = Strings::getRandomHex() . (string) time(); // Generate a confirm_key
422 if (is_array($contact_record)) {
423 q("INSERT INTO `intro` ( `uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
424 VALUES ( %d, %d, 1, %d, '%s', '%s', '%s' )",
426 intval($contact_record['id']),
427 intval(!empty($_POST['knowyou'])),
428 DBA::escape(Strings::escapeTags(trim($_POST['dfrn-request-message'] ?? ''))),
430 DBA::escape(DateTimeFormat::utcNow())
434 // This notice will only be seen by the requestor if the requestor and requestee are on the same server.
436 info(DI::l10n()->t('Your introduction has been sent.') . EOL);
439 // "Homecoming" - send the requestor back to their site to record the introduction.
440 $dfrn_url = bin2hex(DI::baseUrl()->get() . '/profile/' . $nickname);
441 $aes_allow = ((function_exists('openssl_encrypt')) ? 1 : 0);
443 System::externalRedirect($parms['dfrn-request'] . "?dfrn_url=$dfrn_url"
444 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
445 . '&confirm_key=' . $hash
446 . (($aes_allow) ? "&aes_allow=1" : "")
449 // END $network === Protocol::DFRN
450 } elseif (($network != Protocol::PHANTOM) && ($url != "")) {
452 /* Substitute our user's feed URL into $url template
453 * Send the subscriber home to subscribe
455 // Diaspora needs the uri in the format user@domain.tld
456 // Diaspora will support the remote subscription in a future version
457 if ($network == Protocol::DIASPORA) {
458 $uri = urlencode($a->profile['addr']);
460 $uri = urlencode($a->profile['url']);
463 $url = str_replace('{uri}', $uri, $url);
464 System::externalRedirect($url);
466 // END $network != Protocol::PHANTOM
468 notice(DI::l10n()->t("Remote subscription can't be done for your network. Please subscribe directly on your system.") . EOL);
474 function dfrn_request_content(App $a)
476 if ($a->argc != 2 || empty($a->profile)) {
480 // "Homecoming". Make sure we're logged in to this site as the correct user. Then offer a confirm button
481 // to send us to the post section to record the introduction.
482 if (!empty($_GET['dfrn_url'])) {
484 info(DI::l10n()->t("Please login to confirm introduction.") . EOL);
485 /* setup the return URL to come back to this page if they use openid */
486 return Login::form();
489 // Edge case, but can easily happen in the wild. This person is authenticated,
490 // but not as the person who needs to deal with this request.
491 if ($a->user['nickname'] != $a->argv[1]) {
492 notice(DI::l10n()->t("Incorrect identity currently logged in. Please login to <strong>this</strong> profile.") . EOL);
493 return Login::form();
496 $dfrn_url = Strings::escapeTags(trim(hex2bin($_GET['dfrn_url'])));
497 $aes_allow = !empty($_GET['aes_allow']);
498 $confirm_key = $_GET['confirm_key'] ?? '';
500 // Checking fastlane for validity
501 if (!empty($_SESSION['fastlane']) && (Strings::normaliseLink($_SESSION["fastlane"]) == Strings::normaliseLink($dfrn_url))) {
502 $_POST["dfrn_url"] = $dfrn_url;
503 $_POST["confirm_key"] = $confirm_key;
504 $_POST["localconfirm"] = 1;
505 $_POST["hidden-contact"] = 0;
506 $_POST["submit"] = DI::l10n()->t('Confirm');
508 dfrn_request_post($a);
513 $tpl = Renderer::getMarkupTemplate("dfrn_req_confirm.tpl");
514 $o = Renderer::replaceMacros($tpl, [
515 '$dfrn_url' => $dfrn_url,
516 '$aes_allow' => (($aes_allow) ? '<input type="hidden" name="aes_allow" value="1" />' : "" ),
517 '$hidethem' => DI::l10n()->t('Hide this contact'),
518 '$confirm_key' => $confirm_key,
519 '$welcome' => DI::l10n()->t('Welcome home %s.', $a->user['username']),
520 '$please' => DI::l10n()->t('Please confirm your introduction/connection request to %s.', $dfrn_url),
521 '$submit' => DI::l10n()->t('Confirm'),
522 '$uid' => $_SESSION['uid'],
523 '$nickname' => $a->user['nickname'],
524 'dfrn_rawurl' => $_GET['dfrn_url']
527 } elseif (!empty($_GET['confirm_key'])) {
528 // we are the requestee and it is now safe to send our user their introduction,
529 // We could just unblock it, but first we have to jump through a few hoops to
530 // send an email, or even to find out if we need to send an email.
531 $intro = q("SELECT * FROM `intro` WHERE `hash` = '%s' LIMIT 1",
532 DBA::escape($_GET['confirm_key'])
535 if (DBA::isResult($intro)) {
536 $r = q("SELECT `contact`.*, `user`.* FROM `contact` LEFT JOIN `user` ON `contact`.`uid` = `user`.`uid`
537 WHERE `contact`.`id` = %d LIMIT 1",
538 intval($intro[0]['contact-id'])
541 $auto_confirm = false;
543 if (DBA::isResult($r)) {
544 if ($r[0]['page-flags'] != User::PAGE_FLAGS_NORMAL && $r[0]['page-flags'] != User::PAGE_FLAGS_PRVGROUP) {
545 $auto_confirm = true;
548 if (!$auto_confirm) {
550 'type' => Type::INTRO,
551 'notify_flags' => $r[0]['notify-flags'],
552 'language' => $r[0]['language'],
553 'to_name' => $r[0]['username'],
554 'to_email' => $r[0]['email'],
555 'uid' => $r[0]['uid'],
556 'link' => DI::baseUrl() . '/notifications/intros',
557 'source_name' => ((strlen(stripslashes($r[0]['name']))) ? stripslashes($r[0]['name']) : DI::l10n()->t('[Name Withheld]')),
558 'source_link' => $r[0]['url'],
559 'source_photo' => $r[0]['photo'],
560 'verb' => Activity::REQ_FRIEND,
566 require_once 'mod/dfrn_confirm.php';
568 'uid' => $r[0]['uid'],
569 'node' => $r[0]['nickname'],
570 'dfrn_id' => $r[0]['issued-id'],
571 'intro_id' => $intro[0]['id'],
572 'duplex' => (($r[0]['page-flags'] == User::PAGE_FLAGS_FREELOVE) ? 1 : 0),
574 dfrn_confirm_post($a, $handsfree);
578 if (!$auto_confirm) {
580 // If we are auto_confirming, this record will have already been nuked
581 // in dfrn_confirm_post()
583 q("UPDATE `intro` SET `blocked` = 0 WHERE `hash` = '%s'",
584 DBA::escape($_GET['confirm_key'])
591 // Normal web request. Display our user's introduction form.
592 if (DI::config()->get('system', 'block_public') && !Session::isAuthenticated()) {
593 if (!DI::config()->get('system', 'local_block')) {
594 notice(DI::l10n()->t('Public access denied.') . EOL);
599 // Try to auto-fill the profile address
600 // At first look if an address was provided
601 // Otherwise take the local address
602 if (!empty($_GET['addr'])) {
603 $myaddr = hex2bin($_GET['addr']);
604 } elseif (!empty($_GET['address'])) {
605 $myaddr = $_GET['address'];
606 } elseif (local_user()) {
607 if (strlen(DI::baseUrl()->getUrlPath())) {
608 $myaddr = DI::baseUrl() . '/profile/' . $a->user['nickname'];
610 $myaddr = $a->user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
614 $myaddr = Profile::getMyURL();
617 $target_addr = $a->profile['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
619 /* The auto_request form only has the profile address
620 * because nobody is going to read the comments and
621 * it doesn't matter if they know you or not.
623 if ($a->profile['page-flags'] == User::PAGE_FLAGS_NORMAL) {
624 $tpl = Renderer::getMarkupTemplate('dfrn_request.tpl');
626 $tpl = Renderer::getMarkupTemplate('auto_request.tpl');
629 $o = Renderer::replaceMacros($tpl, [
630 '$header' => DI::l10n()->t('Friend/Connection Request'),
631 '$page_desc' => DI::l10n()->t('Enter your Webfinger address (user@domain.tld) or profile URL here. If this isn\'t supported by your system (for example it doesn\'t work with Diaspora), you have to subscribe to <strong>%s</strong> directly on your system', $target_addr),
632 '$invite_desc' => DI::l10n()->t('If you are not yet a member of the free social web, <a href="%s">follow this link to find a public Friendica node and join us today</a>.', Search::getGlobalDirectory() . '/servers'),
633 '$your_address' => DI::l10n()->t('Your Webfinger address or profile URL:'),
634 '$pls_answer' => DI::l10n()->t('Please answer the following:'),
635 '$submit' => DI::l10n()->t('Submit Request'),
636 '$cancel' => DI::l10n()->t('Cancel'),
638 '$request' => 'dfrn_request/' . $a->argv[1],
639 '$name' => $a->profile['name'],
640 '$myaddr' => $myaddr,
642 '$does_know_you' => ['knowyou', DI::l10n()->t('%s knows you', $a->profile['name'])],
643 '$addnote_field' => ['dfrn-request-message', DI::l10n()->t('Add a personal note:')],