4 * @file mod/dfrn_request.php
5 * @brief Module: dfrn_request
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
13 require_once('include/enotify.php');
14 require_once('include/Scrape.php');
15 require_once('include/Probe.php');
16 require_once('include/group.php');
18 function dfrn_request_init(&$a) {
23 profile_load($a,$which);
29 * Function: dfrn_request_post
32 * Handles multiple scenarios.
35 * Clicking 'submit' on a friend request page.
38 * Following Scenario 1, we are brought back to our home site
39 * in order to link our friend request with our own server cell.
40 * After logging in, we click 'submit' to approve the linkage.
43 function dfrn_request_post(&$a) {
45 if(($a->argc != 2) || (! count($a->profile))) {
46 logger('Wrong count of argc or profiles: argc=' . $a->argc . ',profile()=' . count($a->profile));
51 if(x($_POST, 'cancel')) {
58 * Scenario 2: We've introduced ourself to another cell, then have been returned to our own cell
59 * to confirm the request, and then we've clicked submit (perhaps after logging in).
60 * That brings us here:
64 if((x($_POST,'localconfirm')) && ($_POST['localconfirm'] == 1)) {
67 * Ensure this is a valid request
70 if(local_user() && ($a->user['nickname'] == $a->argv[1]) && (x($_POST,'dfrn_url'))) {
73 $dfrn_url = notags(trim($_POST['dfrn_url']));
74 $aes_allow = (((x($_POST,'aes_allow')) && ($_POST['aes_allow'] == 1)) ? 1 : 0);
75 $confirm_key = ((x($_POST,'confirm_key')) ? $_POST['confirm_key'] : "");
76 $hidden = ((x($_POST,'hidden-contact')) ? intval($_POST['hidden-contact']) : 0);
77 $contact_record = null;
84 * Lookup the contact based on their URL (which is the only unique thing we have at the moment)
87 $r = q("SELECT * FROM `contact` WHERE `uid` = %d AND `nurl` = '%s' AND NOT `self` LIMIT 1",
89 dbesc(normalise_link($dfrn_url))
93 if(strlen($r[0]['dfrn-id'])) {
96 * We don't need to be here. It has already happened.
99 notice( t("This introduction has already been accepted.") . EOL );
103 $contact_record = $r[0];
106 if(is_array($contact_record)) {
107 $r = q("UPDATE `contact` SET `ret-aes` = %d, hidden = %d WHERE `id` = %d",
110 intval($contact_record['id'])
116 * Scrape the other site's profile page to pick up the dfrn links, key, fn, and photo
119 $parms = Probe::profile($dfrn_url);
121 if(! count($parms)) {
122 notice( t('Profile location is not valid or does not contain profile information.') . EOL );
127 notice( t('Warning: profile location has no identifiable owner name.') . EOL );
128 if(! x($parms,'photo'))
129 notice( t('Warning: profile location has no profile photo.') . EOL );
130 $invalid = Probe::valid_dfrn($parms);
132 notice( sprintf( tt("%d required parameter was not found at the given location",
133 "%d required parameters were not found at the given location",
134 $invalid), $invalid) . EOL );
139 $dfrn_request = $parms['dfrn-request'];
141 $photo = $parms["photo"];
143 // Escape the entire array
149 * Create a contact record on our site for the other person
152 $r = q("INSERT INTO `contact` ( `uid`, `created`,`url`, `nurl`, `addr`, `name`, `nick`, `photo`, `site-pubkey`,
153 `request`, `confirm`, `notify`, `poll`, `poco`, `network`, `aes_allow`, `hidden`, `blocked`, `pending`)
154 VALUES ( %d, '%s', '%s', '%s', '%s', '%s' , '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, %d, %d)",
155 intval(local_user()),
158 dbesc(normalise_link($dfrn_url)),
164 $parms['dfrn-request'],
165 $parms['dfrn-confirm'],
166 $parms['dfrn-notify'],
178 info( t("Introduction complete.") . EOL);
181 $r = q("SELECT `id`, `network` FROM `contact` WHERE `uid` = %d AND `url` = '%s' AND `site-pubkey` = '%s' LIMIT 1",
182 intval(local_user()),
184 $parms['key'] // this was already escaped
187 $def_gid = get_default_group(local_user(), $r[0]["network"]);
189 group_add_member(local_user(), '', $r[0]['id'], $def_gid);
192 update_contact_avatar($photo, local_user(), $r[0]["id"], true);
194 $forwardurl = $a->get_baseurl()."/contacts/".$r[0]['id'];
196 $forwardurl = $a->get_baseurl()."/contacts";
199 * Allow the blocked remote notification to complete
202 if(is_array($contact_record))
203 $dfrn_request = $contact_record['request'];
205 if(strlen($dfrn_request) && strlen($confirm_key))
206 $s = fetch_url($dfrn_request . '?confirm_key=' . $confirm_key);
208 // (ignore reply, nothing we can do it failed)
210 // Old: goaway(zrl($dfrn_url));
212 return; // NOTREACHED
218 // invalid/bogus request
220 notice( t('Unrecoverable protocol error.') . EOL );
222 return; // NOTREACHED
229 * We are the requestee. A person from a remote cell has made an introduction
230 * on our profile web page and clicked submit. We will use their DFRN-URL to
231 * figure out how to contact their cell.
233 * Scrape the originating DFRN-URL for everything we need. Create a contact record
234 * and an introduction to show our user next time he/she logs in.
235 * Finally redirect back to the requestor so that their site can record the request.
236 * If our user (the requestee) later confirms this request, a record of it will need
237 * to exist on the requestor's cell in order for the confirmation process to complete..
239 * It's possible that neither the requestor or the requestee are logged in at the moment,
240 * and the requestor does not yet have any credentials to the requestee profile.
242 * Who is the requestee? We've already loaded their profile which means their nickname should be
243 * in $a->argv[1] and we should have their complete info in $a->profile.
247 if(! (is_array($a->profile) && count($a->profile))) {
248 notice( t('Profile unavailable.') . EOL);
252 $nickname = $a->profile['nickname'];
253 $notify_flags = $a->profile['notify-flags'];
254 $uid = $a->profile['uid'];
255 $maxreq = intval($a->profile['maxreq']);
256 $contact_record = null;
263 if( x($_POST,'dfrn_url')) {
266 * Block friend request spam
270 $r = q("SELECT * FROM `intro` WHERE `datetime` > '%s' AND `uid` = %d",
271 dbesc(datetime_convert('UTC','UTC','now - 24 hours')),
274 if(count($r) > $maxreq) {
275 notice( sprintf( t('%s has received too many connection requests today.'), $a->profile['name']) . EOL);
276 notice( t('Spam protection measures have been invoked.') . EOL);
277 notice( t('Friends are advised to please try again in 24 hours.') . EOL);
284 * Cleanup old introductions that remain blocked.
285 * Also remove the contact record, but only if there is no existing relationship
286 * Do not remove email contacts as these may be awaiting email verification
289 $r = q("SELECT `intro`.*, `intro`.`id` AS `iid`, `contact`.`id` AS `cid`, `contact`.`rel`
290 FROM `intro` LEFT JOIN `contact` on `intro`.`contact-id` = `contact`.`id`
291 WHERE `intro`.`blocked` = 1 AND `contact`.`self` = 0
292 AND `contact`.`network` != '%s'
293 AND `intro`.`datetime` < UTC_TIMESTAMP() - INTERVAL 30 MINUTE ",
299 q("DELETE FROM `contact` WHERE `id` = %d",
303 q("DELETE FROM `intro` WHERE `id` = %d",
311 * Cleanup any old email intros - which will have a greater lifetime
314 $r = q("SELECT `intro`.*, `intro`.`id` AS `iid`, `contact`.`id` AS `cid`, `contact`.`rel`
315 FROM `intro` LEFT JOIN `contact` on `intro`.`contact-id` = `contact`.`id`
316 WHERE `intro`.`blocked` = 1 AND `contact`.`self` = 0
317 AND `contact`.`network` = '%s'
318 AND `intro`.`datetime` < UTC_TIMESTAMP() - INTERVAL 3 DAY ",
324 q("DELETE FROM `contact` WHERE `id` = %d",
328 q("DELETE FROM `intro` WHERE `id` = %d",
334 $email_follow = (x($_POST,'email_follow') ? intval($_POST['email_follow']) : 0);
335 $real_name = (x($_POST,'realname') ? notags(trim($_POST['realname'])) : '');
337 $url = trim($_POST['dfrn_url']);
339 notice( t("Invalid locator") . EOL );
347 if(! validate_email($url)) {
348 notice( t('Invalid email address.') . EOL);
353 $name = ($realname) ? $realname : $addr;
354 $nick = substr($addr,0,strpos($addr,'@'));
355 $url = 'http://' . substr($addr,strpos($addr,'@') + 1);
356 $nurl = normalise_url($host);
357 $poll = 'email ' . random_string();
358 $notify = 'smtp ' . random_string();
359 $network = NETWORK_MAIL2;
360 $rel = CONTACT_IS_FOLLOWER;
362 $mail_disabled = ((function_exists('imap_open') && (! get_config('system','imap_disabled'))) ? 0 : 1);
363 if(get_config('system','dfrn_only'))
366 if(! $mail_disabled) {
368 $r = q("SELECT * FROM `mailacct` WHERE `uid` = %d LIMIT 1",
373 notice( t('This account has not been configured for email. Request failed.') . EOL);
378 $r = q("insert into contact ( uid, created, addr, name, nick, url, nurl, poll, notify, blocked, pending, network, rel )
379 values( %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', %d ) ",
381 dbesc(datetime_convert()),
395 $r = q("SELECT `id`, `network` FROM `contact` WHERE `poll` = '%s' AND `uid` = %d LIMIT 1",
400 $contact_id = $r[0]['id'];
402 $def_gid = get_default_group($uid, $r[0]["network"]);
403 if (intval($def_gid))
404 group_add_member($uid, '', $contact_id, $def_gid);
406 $photo = avatar_img($addr);
408 $r = q("UPDATE `contact` SET
414 `avatar-date` = '%s',
421 dbesc(datetime_convert()),
422 dbesc(datetime_convert()),
423 dbesc(datetime_convert()),
428 // contact is created. Now create an introduction
430 $hash = random_string();
432 $r = q("insert into intro ( uid, `contact-id`, knowyou, note, hash, datetime, blocked )
433 values( %d , %d, %d, '%s', '%s', '%s', %d ) ",
436 ((x($_POST,'knowyou') && ($_POST['knowyou'] == 1)) ? 1 : 0),
437 dbesc(notags(trim($_POST['dfrn-request-message']))),
439 dbesc(datetime_convert()),
443 // Next send an email verify form to the requestor.
446 // Detect the network
447 $data = probe_url($url);
448 $network = $data["network"];
450 // Canonicalise email-style profile locator
451 $url = Probe::webfinger_dfrn($url,$hcard);
453 if (substr($url,0,5) === 'stat:') {
455 // Every time we detect the remote subscription we define this as OStatus.
456 // We do this even if it is not OStatus.
457 // we only need to pass this through another section of the code.
458 if ($network != NETWORK_DIASPORA)
459 $network = NETWORK_OSTATUS;
461 $url = substr($url,5);
463 $network = NETWORK_DFRN;
466 logger('dfrn_request: url: ' . $url . ',network=' . $network, LOGGER_DEBUG);
468 if($network === NETWORK_DFRN) {
469 $ret = q("SELECT * FROM `contact` WHERE `uid` = %d AND `url` = '%s' AND `self` = 0 LIMIT 1",
475 if(strlen($ret[0]['issued-id'])) {
476 notice( t('You have already introduced yourself here.') . EOL );
479 elseif($ret[0]['rel'] == CONTACT_IS_FRIEND) {
480 notice( sprintf( t('Apparently you are already friends with %s.'), $a->profile['name']) . EOL);
484 $contact_record = $ret[0];
485 $parms = array('dfrn-request' => $ret[0]['request']);
489 $issued_id = random_string();
491 if(is_array($contact_record)) {
492 // There is a contact record but no issued-id, so this
493 // is a reciprocal introduction from a known contact
494 $r = q("UPDATE `contact` SET `issued-id` = '%s' WHERE `id` = %d",
496 intval($contact_record['id'])
500 if(! validate_url($url)) {
501 notice( t('Invalid profile URL.') . EOL);
502 goaway($a->get_baseurl() . '/' . $a->cmd);
503 return; // NOTREACHED
506 if(! allowed_url($url)) {
507 notice( t('Disallowed profile URL.') . EOL);
508 goaway($a->get_baseurl() . '/' . $a->cmd);
509 return; // NOTREACHED
513 require_once('include/Scrape.php');
515 $parms = Probe::profile(($hcard) ? $hcard : $url);
517 if(! count($parms)) {
518 notice( t('Profile location is not valid or does not contain profile information.') . EOL );
519 goaway($a->get_baseurl() . '/' . $a->cmd);
523 notice( t('Warning: profile location has no identifiable owner name.') . EOL );
524 if(! x($parms,'photo'))
525 notice( t('Warning: profile location has no profile photo.') . EOL );
526 $invalid = Probe::valid_dfrn($parms);
528 notice( sprintf( tt("%d required parameter was not found at the given location",
529 "%d required parameters were not found at the given location",
530 $invalid), $invalid) . EOL );
537 $parms['url'] = $url;
538 $parms['issued-id'] = $issued_id;
539 $photo = $parms["photo"];
542 $r = q("INSERT INTO `contact` ( `uid`, `created`, `url`, `nurl`, `addr`, `name`, `nick`, `issued-id`, `photo`, `site-pubkey`,
543 `request`, `confirm`, `notify`, `poll`, `poco`, `network`, `blocked`, `pending` )
544 VALUES ( %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d )",
546 dbesc(datetime_convert()),
548 dbesc(normalise_link($url)),
555 $parms['dfrn-request'],
556 $parms['dfrn-confirm'],
557 $parms['dfrn-notify'],
565 // find the contact record we just created
567 $r = q("SELECT `id` FROM `contact`
568 WHERE `uid` = %d AND `url` = '%s' AND `issued-id` = '%s' LIMIT 1",
574 $contact_record = $r[0];
575 update_contact_avatar($photo, $uid, $contact_record["id"], true);
581 notice( t('Failed to update contact record.') . EOL );
585 $hash = random_string() . (string) time(); // Generate a confirm_key
587 if(is_array($contact_record)) {
588 $ret = q("INSERT INTO `intro` ( `uid`, `contact-id`, `blocked`, `knowyou`, `note`, `hash`, `datetime`)
589 VALUES ( %d, %d, 1, %d, '%s', '%s', '%s' )",
591 intval($contact_record['id']),
592 ((x($_POST,'knowyou') && ($_POST['knowyou'] == 1)) ? 1 : 0),
593 dbesc(notags(trim($_POST['dfrn-request-message']))),
595 dbesc(datetime_convert())
599 // This notice will only be seen by the requestor if the requestor and requestee are on the same server.
602 info( t('Your introduction has been sent.') . EOL );
604 // "Homecoming" - send the requestor back to their site to record the introduction.
606 $dfrn_url = bin2hex($a->get_baseurl() . '/profile/' . $nickname);
607 $aes_allow = ((function_exists('openssl_encrypt')) ? 1 : 0);
609 goaway($parms['dfrn-request'] . "?dfrn_url=$dfrn_url"
610 . '&dfrn_version=' . DFRN_PROTOCOL_VERSION
611 . '&confirm_key=' . $hash
612 . (($aes_allow) ? "&aes_allow=1" : "")
615 // END $network === NETWORK_DFRN
616 } elseif (($network != NETWORK_PHANTOM) AND ($url != "")) {
620 * Substitute our user's feed URL into $url template
621 * Send the subscriber home to subscribe
625 // Diaspora needs the uri in the format user@domain.tld
626 // Diaspora will support the remote subscription in a future version
627 if ($network == NETWORK_DIASPORA) {
628 $uri = $nickname.'@'.$a->get_hostname();
631 $uri .= '/'.$a->get_path();
633 $uri = urlencode($uri);
635 $uri = $a->get_baseurl().'/profile/'.$nickname;
637 $url = str_replace('{uri}', $uri, $url);
640 // END $network != NETWORK_PHANTOM
642 notice(t("Remote subscription can't be done for your network. Please subscribe directly on your system.").EOL);
650 function dfrn_request_content(&$a) {
652 if(($a->argc != 2) || (! count($a->profile)))
656 // "Homecoming". Make sure we're logged in to this site as the correct user. Then offer a confirm button
657 // to send us to the post section to record the introduction.
659 if(x($_GET,'dfrn_url')) {
662 info( t("Please login to confirm introduction.") . EOL );
663 /* setup the return URL to come back to this page if they use openid */
664 $_SESSION['return_url'] = $a->query_string;
668 // Edge case, but can easily happen in the wild. This person is authenticated,
669 // but not as the person who needs to deal with this request.
671 if ($a->user['nickname'] != $a->argv[1]) {
672 notice( t("Incorrect identity currently logged in. Please login to <strong>this</strong> profile.") . EOL);
676 $dfrn_url = notags(trim(hex2bin($_GET['dfrn_url'])));
677 $aes_allow = (((x($_GET,'aes_allow')) && ($_GET['aes_allow'] == 1)) ? 1 : 0);
678 $confirm_key = (x($_GET,'confirm_key') ? $_GET['confirm_key'] : "");
680 // Checking fastlane for validity
681 if (x($_SESSION, "fastlane") AND (normalise_link($_SESSION["fastlane"]) == normalise_link($dfrn_url))) {
682 $_POST["dfrn_url"] = $dfrn_url;
683 $_POST["confirm_key"] = $confirm_key;
684 $_POST["localconfirm"] = 1;
685 $_POST["hidden-contact"] = 0;
686 $_POST["submit"] = t('Confirm');
688 dfrn_request_post($a);
691 return; // NOTREACHED
694 $tpl = get_markup_template("dfrn_req_confirm.tpl");
695 $o = replace_macros($tpl,array(
696 '$dfrn_url' => $dfrn_url,
697 '$aes_allow' => (($aes_allow) ? '<input type="hidden" name="aes_allow" value="1" />' : "" ),
698 '$hidethem' => t('Hide this contact'),
699 '$hidechecked' => '',
700 '$confirm_key' => $confirm_key,
701 '$welcome' => sprintf( t('Welcome home %s.'), $a->user['username']),
702 '$please' => sprintf( t('Please confirm your introduction/connection request to %s.'), $dfrn_url),
703 '$submit' => t('Confirm'),
704 '$uid' => $_SESSION['uid'],
705 '$nickname' => $a->user['nickname'],
706 'dfrn_rawurl' => $_GET['dfrn_url']
711 elseif((x($_GET,'confirm_key')) && strlen($_GET['confirm_key'])) {
713 // we are the requestee and it is now safe to send our user their introduction,
714 // We could just unblock it, but first we have to jump through a few hoops to
715 // send an email, or even to find out if we need to send an email.
717 $intro = q("SELECT * FROM `intro` WHERE `hash` = '%s' LIMIT 1",
718 dbesc($_GET['confirm_key'])
723 $r = q("SELECT `contact`.*, `user`.* FROM `contact` LEFT JOIN `user` ON `contact`.`uid` = `user`.`uid`
724 WHERE `contact`.`id` = %d LIMIT 1",
725 intval($intro[0]['contact-id'])
728 $auto_confirm = false;
731 if(($r[0]['page-flags'] != PAGE_NORMAL) && ($r[0]['page-flags'] != PAGE_PRVGROUP))
732 $auto_confirm = true;
734 if(! $auto_confirm) {
737 'type' => NOTIFY_INTRO,
738 'notify_flags' => $r[0]['notify-flags'],
739 'language' => $r[0]['language'],
740 'to_name' => $r[0]['username'],
741 'to_email' => $r[0]['email'],
742 'uid' => $r[0]['uid'],
743 'link' => $a->get_baseurl() . '/notifications/intros',
744 'source_name' => ((strlen(stripslashes($r[0]['name']))) ? stripslashes($r[0]['name']) : t('[Name Withheld]')),
745 'source_link' => $r[0]['url'],
746 'source_photo' => $r[0]['photo'],
747 'verb' => ACTIVITY_REQ_FRIEND,
753 require_once('mod/dfrn_confirm.php');
755 'uid' => $r[0]['uid'],
756 'node' => $r[0]['nickname'],
757 'dfrn_id' => $r[0]['issued-id'],
758 'intro_id' => $intro[0]['id'],
759 'duplex' => (($r[0]['page-flags'] == PAGE_FREELOVE) ? 1 : 0),
760 'activity' => intval(get_pconfig($r[0]['uid'],'system','post_newfriend'))
762 dfrn_confirm_post($a,$handsfree);
767 if(! $auto_confirm) {
769 // If we are auto_confirming, this record will have already been nuked
770 // in dfrn_confirm_post()
772 $r = q("UPDATE `intro` SET `blocked` = 0 WHERE `hash` = '%s'",
773 dbesc($_GET['confirm_key'])
779 return; // NOTREACHED
784 * Normal web request. Display our user's introduction form.
787 if((get_config('system','block_public')) && (! local_user()) && (! remote_user())) {
788 if(! get_config('system','local_block')) {
789 notice( t('Public access denied.') . EOL);
796 * Try to auto-fill the profile address
799 // At first look if an address was provided
800 // Otherwise take the local address
801 if (x($_GET,'addr') AND ($_GET['addr'] != ""))
802 $myaddr = hex2bin($_GET['addr']);
803 elseif (x($_GET,'address') AND ($_GET['address'] != ""))
804 $myaddr = $_GET['address'];
805 elseif(local_user()) {
806 if(strlen($a->path)) {
807 $myaddr = $a->get_baseurl() . '/profile/' . $a->user['nickname'];
810 $myaddr = $a->user['nickname'] . '@' . substr(z_root(), strpos(z_root(),'://') + 3 );
812 } else // last, try a zrl
813 $myaddr = get_my_url();
815 $target_addr = $a->profile['nickname'] . '@' . substr(z_root(), strpos(z_root(),'://') + 3 );
820 * The auto_request form only has the profile address
821 * because nobody is going to read the comments and
822 * it doesn't matter if they know you or not.
826 if($a->profile['page-flags'] == PAGE_NORMAL)
827 $tpl = get_markup_template('dfrn_request.tpl');
829 $tpl = get_markup_template('auto_request.tpl');
831 $page_desc = t("Please enter your 'Identity Address' from one of the following supported communications networks:");
833 // see if we are allowed to have NETWORK_MAIL2 contacts
835 $mail_disabled = ((function_exists('imap_open') && (! get_config('system','imap_disabled'))) ? 0 : 1);
836 if(get_config('system','dfrn_only'))
839 if(! $mail_disabled) {
840 $r = q("SELECT * FROM `mailacct` WHERE `uid` = %d LIMIT 1",
841 intval($a->profile['uid'])
847 // "coming soon" is disabled for now
848 //$emailnet = (($mail_disabled) ? '' : t("<strike>Connect as an email follower</strike> \x28Coming soon\x29"));
851 $invite_desc = sprintf(
852 t('If you are not yet a member of the free social web, <a href="%s/siteinfo">follow this link to find a public Friendica site and join us today</a>.'),
856 $o = replace_macros($tpl,array(
857 '$header' => t('Friend/Connection Request'),
858 '$desc' => t('Examples: jojo@demo.friendica.com, http://demo.friendica.com/profile/jojo, testuser@identi.ca'),
859 '$pls_answer' => t('Please answer the following:'),
860 '$does_know_you' => array('knowyou', sprintf(t('Does %s know you?'),$a->profile['name']), false, '', array(t('No'),t('Yes'))),
861 /*'$does_know' => sprintf( t('Does %s know you?'),$a->profile['name']),
864 '$add_note' => t('Add a personal note:'),
865 '$page_desc' => $page_desc,
866 '$friendica' => t('Friendica'),
867 '$statusnet' => t('StatusNet/Federated Social Web'),
868 '$diaspora' => t('Diaspora'),
869 '$diasnote' => sprintf (t(' - please do not use this form. Instead, enter %s into your Diaspora search bar.'),$target_addr),
870 '$your_address' => t('Your Identity Address:'),
871 '$invite_desc' => $invite_desc,
872 '$emailnet' => $emailnet,
873 '$submit' => t('Submit Request'),
874 '$cancel' => t('Cancel'),
875 '$nickname' => $a->argv[1],
876 '$name' => $a->profile['name'],
882 return; // Somebody is fishing.