include/dfrn.php

   1 <?php
   2 /**
   3  * @file include/dfrn.php
   4  * @brief The implementation of the dfrn protocol
   5  *
   6  * https://github.com/friendica/friendica/wiki/Protocol
   7  */
   8
   9 require_once('include/items.php');
  10 require_once('include/Contact.php');
  11 require_once('include/ostatus.php');
  12
  13 /**
  14  * @brief This class contain functions to create and send DFRN XML files
  15  *
  16  */
  17 class dfrn {
  18
  19         /**
  20          * @brief Generates the atom entries for delivery.php
  21          *
  22          * This function is used whenever content is transmitted via DFRN.
  23          *
  24          * @param array $items Item elements
  25          * @param array $owner Owner record
  26          *
  27          * @return string DFRN entries
  28          */
  29         function entries($items,$owner) {
  30
  31                 $doc = new DOMDocument('1.0', 'utf-8');
  32                 $doc->formatOutput = true;
  33
  34                 $root = self::add_header($doc, $owner, "dfrn:owner", "", false);
  35
  36                 if(! count($items))
  37                         return trim($doc->saveXML());
  38
  39                 foreach($items as $item) {
  40                         $entry = self::entry($doc, "text", $item, $owner, $item["entry:comment-allow"], $item["entry:cid"]);
  41                         $root->appendChild($entry);
  42                 }
  43
  44                 return(trim($doc->saveXML()));
  45         }
  46
  47         /**
  48          * @brief Generate an atom feed for the given user
  49          *
  50          * This function is called when another server is pulling data from the user feed.
  51          *
  52          * @param string $dfrn_id DFRN ID from the requesting party
  53          * @param string $owner_nick Owner nick name
  54          * @param string $last_update Date of the last update
  55          * @param int $direction Can be -1, 0 or 1.
  56          *
  57          * @return string DFRN feed entries
  58          */
  59         function feed($dfrn_id, $owner_nick, $last_update, $direction = 0) {
  60
  61                 $a = get_app();
  62
  63                 $sitefeed    = ((strlen($owner_nick)) ? false : true); // not yet implemented, need to rewrite huge chunks of following logic
  64                 $public_feed = (($dfrn_id) ? false : true);
  65                 $starred     = false;   // not yet implemented, possible security issues
  66                 $converse    = false;
  67
  68                 if($public_feed && $a->argc > 2) {
  69                         for($x = 2; $x < $a->argc; $x++) {
  70                                 if($a->argv[$x] == 'converse')
  71                                         $converse = true;
  72                                 if($a->argv[$x] == 'starred')
  73                                         $starred = true;
  74                                 if($a->argv[$x] === 'category' && $a->argc > ($x + 1) && strlen($a->argv[$x+1]))
  75                                         $category = $a->argv[$x+1];
  76                         }
  77                 }
  78
  79
  80
  81                 // default permissions - anonymous user
  82
  83                 $sql_extra = " AND `item`.`allow_cid` = '' AND `item`.`allow_gid` = '' AND `item`.`deny_cid`  = '' AND `item`.`deny_gid`  = '' ";
  84
  85                 $r = q("SELECT `contact`.*, `user`.`uid` AS `user_uid`, `user`.`nickname`, `user`.`timezone`, `user`.`page-flags`
  86                         FROM `contact` INNER JOIN `user` ON `user`.`uid` = `contact`.`uid`
  87                         WHERE `contact`.`self` = 1 AND `user`.`nickname` = '%s' LIMIT 1",
  88                         dbesc($owner_nick)
  89                 );
  90
  91                 if(! count($r))
  92                         killme();
  93
  94                 $owner = $r[0];
  95                 $owner_id = $owner['user_uid'];
  96                 $owner_nick = $owner['nickname'];
  97
  98                 $sql_post_table = "";
  99                 $visibility = "";
 100
 101                 if(! $public_feed) {
 102
 103                         $sql_extra = '';
 104                         switch($direction) {
 105                                 case (-1):
 106                                         $sql_extra = sprintf(" AND `issued-id` = '%s' ", dbesc($dfrn_id));
 107                                         $my_id = $dfrn_id;
 108                                         break;
 109                                 case 0:
 110                                         $sql_extra = sprintf(" AND `issued-id` = '%s' AND `duplex` = 1 ", dbesc($dfrn_id));
 111                                         $my_id = '1:' . $dfrn_id;
 112                                         break;
 113                                 case 1:
 114                                         $sql_extra = sprintf(" AND `dfrn-id` = '%s' AND `duplex` = 1 ", dbesc($dfrn_id));
 115                                         $my_id = '0:' . $dfrn_id;
 116                                         break;
 117                                 default:
 118                                         return false;
 119                                         break; // NOTREACHED
 120                         }
 121
 122                         $r = q("SELECT * FROM `contact` WHERE `blocked` = 0 AND `pending` = 0 AND `contact`.`uid` = %d $sql_extra LIMIT 1",
 123                                 intval($owner_id)
 124                         );
 125
 126                         if(! count($r))
 127                                 killme();
 128
 129                         $contact = $r[0];
 130                         require_once('include/security.php');
 131                         $groups = init_groups_visitor($contact['id']);
 132
 133                         if(count($groups)) {
 134                                 for($x = 0; $x < count($groups); $x ++)
 135                                         $groups[$x] = '<' . intval($groups[$x]) . '>' ;
 136                                 $gs = implode('|', $groups);
 137                         } else
 138                                 $gs = '<<>>' ; // Impossible to match
 139
 140                         $sql_extra = sprintf("
 141                                 AND ( `allow_cid` = '' OR     `allow_cid` REGEXP '<%d>' )
 142                                 AND ( `deny_cid`  = '' OR NOT `deny_cid`  REGEXP '<%d>' )
 143                                 AND ( `allow_gid` = '' OR     `allow_gid` REGEXP '%s' )
 144                                 AND ( `deny_gid`  = '' OR NOT `deny_gid`  REGEXP '%s')
 145                         ",
 146                                 intval($contact['id']),
 147                                 intval($contact['id']),
 148                                 dbesc($gs),
 149                                 dbesc($gs)
 150                         );
 151                 }
 152
 153                 if($public_feed)
 154                         $sort = 'DESC';
 155                 else
 156                         $sort = 'ASC';
 157
 158                 $date_field = "`changed`";
 159                 $sql_order = "`item`.`parent` ".$sort.", `item`.`created` ASC";
 160
 161                 if(! strlen($last_update))
 162                         $last_update = 'now -30 days';
 163
 164                 if(isset($category)) {
 165                         $sql_post_table = sprintf("INNER JOIN (SELECT `oid` FROM `term` WHERE `term` = '%s' AND `otype` = %d AND `type` = %d AND `uid` = %d ORDER BY `tid` DESC) AS `term` ON `item`.`id` = `term`.`oid` ",
 166                                         dbesc(protect_sprintf($category)), intval(TERM_OBJ_POST), intval(TERM_CATEGORY), intval($owner_id));
 167                         //$sql_extra .= file_tag_file_query('item',$category,'category');
 168                 }
 169
 170                 if($public_feed) {
 171                         if(! $converse)
 172                                 $sql_extra .= " AND `contact`.`self` = 1 ";
 173                 }
 174
 175                 $check_date = datetime_convert('UTC','UTC',$last_update,'Y-m-d H:i:s');
 176
 177                 //      AND ( `item`.`edited` > '%s' OR `item`.`changed` > '%s' )
 178                 //      dbesc($check_date),
 179
 180                 $r = q("SELECT STRAIGHT_JOIN `item`.*, `item`.`id` AS `item_id`,
 181                         `contact`.`name`, `contact`.`network`, `contact`.`photo`, `contact`.`url`,
 182                         `contact`.`name-date`, `contact`.`uri-date`, `contact`.`avatar-date`,
 183                         `contact`.`thumb`, `contact`.`dfrn-id`, `contact`.`self`,
 184                         `contact`.`id` AS `contact-id`, `contact`.`uid` AS `contact-uid`,
 185                         `sign`.`signed_text`, `sign`.`signature`, `sign`.`signer`
 186                         FROM `item` $sql_post_table
 187                         INNER JOIN `contact` ON `contact`.`id` = `item`.`contact-id`
 188                         AND `contact`.`blocked` = 0 AND `contact`.`pending` = 0
 189                         LEFT JOIN `sign` ON `sign`.`iid` = `item`.`id`
 190                         WHERE `item`.`uid` = %d AND `item`.`visible` = 1 and `item`.`moderated` = 0 AND `item`.`parent` != 0
 191                         AND ((`item`.`wall` = 1) $visibility) AND `item`.$date_field > '%s'
 192                         $sql_extra
 193                         ORDER BY $sql_order LIMIT 0, 300",
 194                         intval($owner_id),
 195                         dbesc($check_date),
 196                         dbesc($sort)
 197                 );
 198
 199                 // Will check further below if this actually returned results.
 200                 // We will provide an empty feed if that is the case.
 201
 202                 $items = $r;
 203
 204                 $doc = new DOMDocument('1.0', 'utf-8');
 205                 $doc->formatOutput = true;
 206
 207                 $alternatelink = $owner['url'];
 208
 209                 if(isset($category))
 210                         $alternatelink .= "/category/".$category;
 211
 212                 if ($public_feed)
 213                         $author = "dfrn:owner";
 214                 else
 215                         $author = "author";
 216
 217                 $root = self::add_header($doc, $owner, $author, $alternatelink, true);
 218
 219                 // This hook can't work anymore
 220                 //      call_hooks('atom_feed', $atom);
 221
 222                 if(! count($items)) {
 223                         $atom = trim($doc->saveXML());
 224
 225                         call_hooks('atom_feed_end', $atom);
 226
 227                         return $atom;
 228                 }
 229
 230                 foreach($items as $item) {
 231
 232                         // prevent private email from leaking.
 233                         if($item['network'] === NETWORK_MAIL)
 234                                 continue;
 235
 236                         // public feeds get html, our own nodes use bbcode
 237
 238                         if($public_feed) {
 239                                 $type = 'html';
 240                                 // catch any email that's in a public conversation and make sure it doesn't leak
 241                                 if($item['private'])
 242                                         continue;
 243                         } else
 244                                 $type = 'text';
 245
 246                         $entry = self::entry($doc, $type, $item, $owner, true);
 247                         $root->appendChild($entry);
 248
 249                 }
 250
 251                 $atom = trim($doc->saveXML());
 252
 253                 call_hooks('atom_feed_end', $atom);
 254
 255                 return $atom;
 256         }
 257
 258         /**
 259          * @brief Create XML text for DFRN mails
 260          *
 261          * @param array $item message elements
 262          * @param array $owner Owner record
 263          *
 264          * @return string DFRN mail
 265          */
 266         function mail($item, $owner) {
 267                 $doc = new DOMDocument('1.0', 'utf-8');
 268                 $doc->formatOutput = true;
 269
 270                 $root = self::add_header($doc, $owner, "dfrn:owner", "", false);
 271
 272                 $mail = $doc->createElement("dfrn:mail");
 273                 $sender = $doc->createElement("dfrn:sender");
 274
 275                 xml_add_element($doc, $sender, "dfrn:name", $owner['name']);
 276                 xml_add_element($doc, $sender, "dfrn:uri", $owner['url']);
 277                 xml_add_element($doc, $sender, "dfrn:avatar", $owner['thumb']);
 278
 279                 $mail->appendChild($sender);
 280
 281                 xml_add_element($doc, $mail, "dfrn:id", $item['uri']);
 282                 xml_add_element($doc, $mail, "dfrn:in-reply-to", $item['parent-uri']);
 283                 xml_add_element($doc, $mail, "dfrn:sentdate", datetime_convert('UTC', 'UTC', $item['created'] . '+00:00' , ATOM_TIME));
 284                 xml_add_element($doc, $mail, "dfrn:subject", $item['title']);
 285                 xml_add_element($doc, $mail, "dfrn:content", $item['body']);
 286
 287                 $root->appendChild($mail);
 288
 289                 return(trim($doc->saveXML()));
 290         }
 291
 292         /**
 293          * @brief Create XML text for DFRN friend suggestions
 294          *
 295          * @param array $item suggestion elements
 296          * @param array $owner Owner record
 297          *
 298          * @return string DFRN suggestions
 299          */
 300         function fsuggest($item, $owner) {
 301                 $doc = new DOMDocument('1.0', 'utf-8');
 302                 $doc->formatOutput = true;
 303
 304                 $root = self::add_header($doc, $owner, "dfrn:owner", "", false);
 305
 306                 $suggest = $doc->createElement("dfrn:suggest");
 307
 308                 xml_add_element($doc, $suggest, "dfrn:url", $item['url']);
 309                 xml_add_element($doc, $suggest, "dfrn:name", $item['name']);
 310                 xml_add_element($doc, $suggest, "dfrn:photo", $item['photo']);
 311                 xml_add_element($doc, $suggest, "dfrn:request", $item['request']);
 312                 xml_add_element($doc, $suggest, "dfrn:note", $item['note']);
 313
 314                 $root->appendChild($suggest);
 315
 316                 return(trim($doc->saveXML()));
 317         }
 318
 319         /**
 320          * @brief Create XML text for DFRN relocations
 321          *
 322          * @param array $owner Owner record
 323          * @param int $uid User ID
 324          *
 325          * @return string DFRN relocations
 326          */
 327         function relocate($owner, $uid) {
 328
 329                 /* get site pubkey. this could be a new installation with no site keys*/
 330                 $pubkey = get_config('system','site_pubkey');
 331                 if(! $pubkey) {
 332                         $res = new_keypair(1024);
 333                         set_config('system','site_prvkey', $res['prvkey']);
 334                         set_config('system','site_pubkey', $res['pubkey']);
 335                 }
 336
 337                 $rp = q("SELECT `resource-id` , `scale`, type FROM `photo`
 338                                 WHERE `profile` = 1 AND `uid` = %d ORDER BY scale;", $uid);
 339                 $photos = array();
 340                 $ext = Photo::supportedTypes();
 341
 342                 foreach($rp as $p)
 343                         $photos[$p['scale']] = app::get_baseurl().'/photo/'.$p['resource-id'].'-'.$p['scale'].'.'.$ext[$p['type']];
 344
 345                 unset($rp, $ext);
 346
 347                 $doc = new DOMDocument('1.0', 'utf-8');
 348                 $doc->formatOutput = true;
 349
 350                 $root = self::add_header($doc, $owner, "dfrn:owner", "", false);
 351
 352                 $relocate = $doc->createElement("dfrn:relocate");
 353
 354                 xml_add_element($doc, $relocate, "dfrn:url", $owner['url']);
 355                 xml_add_element($doc, $relocate, "dfrn:name", $owner['name']);
 356                 xml_add_element($doc, $relocate, "dfrn:photo", $photos[4]);
 357                 xml_add_element($doc, $relocate, "dfrn:thumb", $photos[5]);
 358                 xml_add_element($doc, $relocate, "dfrn:micro", $photos[6]);
 359                 xml_add_element($doc, $relocate, "dfrn:request", $owner['request']);
 360                 xml_add_element($doc, $relocate, "dfrn:confirm", $owner['confirm']);
 361                 xml_add_element($doc, $relocate, "dfrn:notify", $owner['notify']);
 362                 xml_add_element($doc, $relocate, "dfrn:poll", $owner['poll']);
 363                 xml_add_element($doc, $relocate, "dfrn:sitepubkey", get_config('system','site_pubkey'));
 364
 365                 $root->appendChild($relocate);
 366
 367                 return(trim($doc->saveXML()));
 368         }
 369
 370         /**
 371          * @brief Adds the header elements for the DFRN protocol
 372          *
 373          * @param object $doc XML document
 374          * @param array $owner Owner record
 375          * @param string $authorelement Element name for the author
 376          * @param string $alternatelink link to profile or category
 377          * @param bool $public Is it a header for public posts?
 378          *
 379          * @return object XML root object
 380          */
 381         private function add_header($doc, $owner, $authorelement, $alternatelink = "", $public = false) {
 382
 383                 if ($alternatelink == "")
 384                         $alternatelink = $owner['url'];
 385
 386                 $root = $doc->createElementNS(NS_ATOM, 'feed');
 387                 $doc->appendChild($root);
 388
 389                 $root->setAttribute("xmlns:thr", NS_THR);
 390                 $root->setAttribute("xmlns:at", "http://purl.org/atompub/tombstones/1.0");
 391                 $root->setAttribute("xmlns:media", NS_MEDIA);
 392                 $root->setAttribute("xmlns:dfrn", "http://purl.org/macgirvin/dfrn/1.0");
 393                 $root->setAttribute("xmlns:activity", NS_ACTIVITY);
 394                 $root->setAttribute("xmlns:georss", NS_GEORSS);
 395                 $root->setAttribute("xmlns:poco", NS_POCO);
 396                 $root->setAttribute("xmlns:ostatus", NS_OSTATUS);
 397                 $root->setAttribute("xmlns:statusnet", NS_STATUSNET);
 398
 399                 //xml_add_element($doc, $root, "id", app::get_baseurl()."/profile/".$owner["nick"]);
 400                 xml_add_element($doc, $root, "id", app::get_baseurl()."/profile/".$owner["nick"]);
 401                 xml_add_element($doc, $root, "title", $owner["name"]);
 402
 403                 $attributes = array("uri" => "https://friendi.ca", "version" => FRIENDICA_VERSION."-".DB_UPDATE_VERSION);
 404                 xml_add_element($doc, $root, "generator", FRIENDICA_PLATFORM, $attributes);
 405
 406                 $attributes = array("rel" => "license", "href" => "http://creativecommons.org/licenses/by/3.0/");
 407                 xml_add_element($doc, $root, "link", "", $attributes);
 408
 409                 $attributes = array("rel" => "alternate", "type" => "text/html", "href" => $alternatelink);
 410                 xml_add_element($doc, $root, "link", "", $attributes);
 411
 412                 ostatus_hublinks($doc, $root);
 413
 414                 if ($public) {
 415                         $attributes = array("rel" => "salmon", "href" => app::get_baseurl()."/salmon/".$owner["nick"]);
 416                         xml_add_element($doc, $root, "link", "", $attributes);
 417
 418                         $attributes = array("rel" => "http://salmon-protocol.org/ns/salmon-replies", "href" => app::get_baseurl()."/salmon/".$owner["nick"]);
 419                         xml_add_element($doc, $root, "link", "", $attributes);
 420
 421                         $attributes = array("rel" => "http://salmon-protocol.org/ns/salmon-mention", "href" => app::get_baseurl()."/salmon/".$owner["nick"]);
 422                         xml_add_element($doc, $root, "link", "", $attributes);
 423                 }
 424
 425                 if ($owner['page-flags'] == PAGE_COMMUNITY)
 426                         xml_add_element($doc, $root, "dfrn:community", 1);
 427
 428                 xml_add_element($doc, $root, "updated", datetime_convert("UTC", "UTC", "now", ATOM_TIME));
 429
 430                 $author = self::add_author($doc, $owner, $authorelement, $public);
 431                 $root->appendChild($author);
 432
 433                 return $root;
 434         }
 435
 436         /**
 437          * @brief Adds the author element in the header for the DFRN protocol
 438          *
 439          * @param object $doc XML document
 440          * @param array $owner Owner record
 441          * @param string $authorelement Element name for the author
 442          *
 443          * @return object XML author object
 444          */
 445         private function add_author($doc, $owner, $authorelement, $public) {
 446
 447                 $author = $doc->createElement($authorelement);
 448
 449                 $namdate = datetime_convert('UTC', 'UTC', $owner['name-date'].'+00:00' , ATOM_TIME);
 450                 $uridate = datetime_convert('UTC', 'UTC', $owner['uri-date'].'+00:00', ATOM_TIME);
 451                 $picdate = datetime_convert('UTC', 'UTC', $owner['avatar-date'].'+00:00', ATOM_TIME);
 452
 453                 $attributes = array("dfrn:updated" => $namdate);
 454                 xml_add_element($doc, $author, "name", $owner["name"], $attributes);
 455
 456                 $attributes = array("dfrn:updated" => $namdate);
 457                 xml_add_element($doc, $author, "uri", app::get_baseurl().'/profile/'.$owner["nickname"], $attributes);
 458
 459                 $attributes = array("dfrn:updated" => $namdate);
 460                 xml_add_element($doc, $author, "dfrn:handle", $owner["addr"], $attributes);
 461
 462                 $attributes = array("rel" => "photo", "type" => "image/jpeg", "dfrn:updated" => $picdate,
 463                                         "media:width" => 175, "media:height" => 175, "href" => $owner['photo']);
 464                 xml_add_element($doc, $author, "link", "", $attributes);
 465
 466                 $attributes = array("rel" => "avatar", "type" => "image/jpeg", "dfrn:updated" => $picdate,
 467                                         "media:width" => 175, "media:height" => 175, "href" => $owner['photo']);
 468                 xml_add_element($doc, $author, "link", "", $attributes);
 469
 470                 $birthday = feed_birthday($owner['user_uid'], $owner['timezone']);
 471
 472                 if ($birthday)
 473                         xml_add_element($doc, $author, "dfrn:birthday", $birthday);
 474
 475                 // The following fields will only be generated if this isn't for a public feed
 476                 if ($public)
 477                         return $author;
 478
 479                 // Only show contact details when we are allowed to
 480                 $r = q("SELECT `profile`.`about`, `profile`.`name`, `profile`.`homepage`, `user`.`nickname`, `user`.`timezone`,
 481                                 `profile`.`locality`, `profile`.`region`, `profile`.`country-name`, `profile`.`pub_keywords`, `profile`.`dob`
 482                         FROM `profile`
 483                                 INNER JOIN `user` ON `user`.`uid` = `profile`.`uid`
 484                                 WHERE `profile`.`is-default` AND NOT `user`.`hidewall` AND `user`.`uid` = %d",
 485                         intval($owner['user_uid']));
 486                 if ($r) {
 487                         $profile = $r[0];
 488                         xml_add_element($doc, $author, "poco:displayName", $profile["name"]);
 489                         xml_add_element($doc, $author, "poco:updated", $namdate);
 490
 491                         if (trim($profile["dob"]) != "0000-00-00")
 492                                 xml_add_element($doc, $author, "poco:birthday", "0000-".date("m-d", strtotime($profile["dob"])));
 493
 494                         xml_add_element($doc, $author, "poco:note", $profile["about"]);
 495                         xml_add_element($doc, $author, "poco:preferredUsername", $profile["nickname"]);
 496
 497                         $savetz = date_default_timezone_get();
 498                         date_default_timezone_set($profile["timezone"]);
 499                         xml_add_element($doc, $author, "poco:utcOffset", date("P"));
 500                         date_default_timezone_set($savetz);
 501
 502                         if (trim($profile["homepage"]) != "") {
 503                                 $urls = $doc->createElement("poco:urls");
 504                                 xml_add_element($doc, $urls, "poco:type", "homepage");
 505                                 xml_add_element($doc, $urls, "poco:value", $profile["homepage"]);
 506                                 xml_add_element($doc, $urls, "poco:primary", "true");
 507                                 $author->appendChild($urls);
 508                         }
 509
 510                         if (trim($profile["pub_keywords"]) != "") {
 511                                 $keywords = explode(",", $profile["pub_keywords"]);
 512
 513                                 foreach ($keywords AS $keyword)
 514                                         xml_add_element($doc, $author, "poco:tags", trim($keyword));
 515
 516                         }
 517
 518                         /// @todo When we are having the XMPP address in the profile we should propagate it here
 519                         $xmpp = "";
 520                         if (trim($xmpp) != "") {
 521                                 $ims = $doc->createElement("poco:ims");
 522                                 xml_add_element($doc, $ims, "poco:type", "xmpp");
 523                                 xml_add_element($doc, $ims, "poco:value", $xmpp);
 524                                 xml_add_element($doc, $ims, "poco:primary", "true");
 525                                 $author->appendChild($ims);
 526                         }
 527
 528                         if (trim($profile["locality"].$profile["region"].$profile["country-name"]) != "") {
 529                                 $element = $doc->createElement("poco:address");
 530
 531                                 xml_add_element($doc, $element, "poco:formatted", formatted_location($profile));
 532
 533                                 if (trim($profile["locality"]) != "")
 534                                         xml_add_element($doc, $element, "poco:locality", $profile["locality"]);
 535
 536                                 if (trim($profile["region"]) != "")
 537                                         xml_add_element($doc, $element, "poco:region", $profile["region"]);
 538
 539                                 if (trim($profile["country-name"]) != "")
 540                                         xml_add_element($doc, $element, "poco:country", $profile["country-name"]);
 541
 542                                 $author->appendChild($element);
 543                         }
 544                 }
 545
 546                 return $author;
 547         }
 548
 549         /**
 550          * @brief Adds the author elements in the "entry" elements of the DFRN protocol
 551          *
 552          * @param object $doc XML document
 553          * @param string $element Element name for the author
 554          * @param string $contact_url Link of the contact
 555          * @param array $items Item elements
 556          *
 557          * @return object XML author object
 558          */
 559         private function add_entry_author($doc, $element, $contact_url, $item) {
 560
 561                 $contact = get_contact_details_by_url($contact_url, $item["uid"]);
 562
 563                 $author = $doc->createElement($element);
 564                 xml_add_element($doc, $author, "name", $contact["name"]);
 565                 xml_add_element($doc, $author, "uri", $contact["url"]);
 566                 xml_add_element($doc, $author, "dfrn:handle", $contact["addr"]);
 567
 568                 /// @Todo
 569                 /// - Check real image type and image size
 570                 /// - Check which of these boths elements we should use
 571                 $attributes = array(
 572                                 "rel" => "photo",
 573                                 "type" => "image/jpeg",
 574                                 "media:width" => 80,
 575                                 "media:height" => 80,
 576                                 "href" => $contact["photo"]);
 577                 xml_add_element($doc, $author, "link", "", $attributes);
 578
 579                 $attributes = array(
 580                                 "rel" => "avatar",
 581                                 "type" => "image/jpeg",
 582                                 "media:width" => 80,
 583                                 "media:height" => 80,
 584                                 "href" => $contact["photo"]);
 585                 xml_add_element($doc, $author, "link", "", $attributes);
 586
 587                 return $author;
 588         }
 589
 590         /**
 591          * @brief Adds the activity elements
 592          *
 593          * @param object $doc XML document
 594          * @param string $element Element name for the activity
 595          * @param string $activity activity value
 596          *
 597          * @return object XML activity object
 598          */
 599         private function create_activity($doc, $element, $activity) {
 600
 601                 if($activity) {
 602                         $entry = $doc->createElement($element);
 603
 604                         $r = parse_xml_string($activity, false);
 605                         if(!$r)
 606                                 return false;
 607                         if($r->type)
 608                                 xml_add_element($doc, $entry, "activity:object-type", $r->type);
 609                         if($r->id)
 610                                 xml_add_element($doc, $entry, "id", $r->id);
 611                         if($r->title)
 612                                 xml_add_element($doc, $entry, "title", $r->title);
 613                         if($r->link) {
 614                                 if(substr($r->link,0,1) === '<') {
 615                                         if(strstr($r->link,'&') && (! strstr($r->link,'&amp;')))
 616                                                 $r->link = str_replace('&','&amp;', $r->link);
 617
 618                                         $r->link = preg_replace('/\<link(.*?)\"\>/','<link$1"/>',$r->link);
 619
 620                                         $data = parse_xml_string($r->link, false);
 621                                         foreach ($data->attributes() AS $parameter => $value)
 622                                                 $attributes[$parameter] = $value;
 623                                 } else
 624                                         $attributes = array("rel" => "alternate", "type" => "text/html", "href" => $r->link);
 625
 626                                 xml_add_element($doc, $entry, "link", "", $attributes);
 627                         }
 628                         if($r->content)
 629                                 xml_add_element($doc, $entry, "content", bbcode($r->content), array("type" => "html"));
 630
 631                         return $entry;
 632                 }
 633
 634                 return false;
 635         }
 636
 637         /**
 638          * @brief Adds the elements for attachments
 639          *
 640          * @param object $doc XML document
 641          * @param object $root XML root
 642          * @param array $item Item element
 643          *
 644          * @return object XML attachment object
 645          */
 646         private function get_attachment($doc, $root, $item) {
 647                 $arr = explode('[/attach],',$item['attach']);
 648                 if(count($arr)) {
 649                         foreach($arr as $r) {
 650                                 $matches = false;
 651                                 $cnt = preg_match('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|',$r,$matches);
 652                                 if($cnt) {
 653                                         $attributes = array("rel" => "enclosure",
 654                                                         "href" => $matches[1],
 655                                                         "type" => $matches[3]);
 656
 657                                         if(intval($matches[2]))
 658                                                 $attributes["length"] = intval($matches[2]);
 659
 660                                         if(trim($matches[4]) != "")
 661                                                 $attributes["title"] = trim($matches[4]);
 662
 663                                         xml_add_element($doc, $root, "link", "", $attributes);
 664                                 }
 665                         }
 666                 }
 667         }
 668
 669         /**
 670          * @brief Adds the "entry" elements for the DFRN protocol
 671          *
 672          * @param object $doc XML document
 673          * @param string $type "text" or "html"
 674          * @param array $item Item element
 675          * @param array $owner Owner record
 676          * @param bool $comment Trigger the sending of the "comment" element
 677          * @param int $cid Contact ID of the recipient
 678          *
 679          * @return object XML entry object
 680          */
 681         private function entry($doc, $type, $item, $owner, $comment = false, $cid = 0) {
 682
 683                 $mentioned = array();
 684
 685                 if(!$item['parent'])
 686                         return;
 687
 688                 if($item['deleted']) {
 689                         $attributes = array("ref" => $item['uri'], "when" => datetime_convert('UTC','UTC',$item['edited'] . '+00:00',ATOM_TIME));
 690                         return xml_create_element($doc, "at:deleted-entry", "", $attributes);
 691                 }
 692
 693                 $entry = $doc->createElement("entry");
 694
 695                 if($item['allow_cid'] || $item['allow_gid'] || $item['deny_cid'] || $item['deny_gid'])
 696                         $body = fix_private_photos($item['body'],$owner['uid'],$item,$cid);
 697                 else
 698                         $body = $item['body'];
 699
 700                 if ($type == 'html') {
 701                         $htmlbody = $body;
 702
 703                         if ($item['title'] != "")
 704                                 $htmlbody = "[b]".$item['title']."[/b]\n\n".$htmlbody;
 705
 706                         $htmlbody = bbcode($htmlbody, false, false, 7);
 707                 }
 708
 709                 $author = self::add_entry_author($doc, "author", $item["author-link"], $item);
 710                 $entry->appendChild($author);
 711
 712                 $dfrnowner = self::add_entry_author($doc, "dfrn:owner", $item["owner-link"], $item);
 713                 $entry->appendChild($dfrnowner);
 714
 715                 if(($item['parent'] != $item['id']) || ($item['parent-uri'] !== $item['uri']) || (($item['thr-parent'] !== '') && ($item['thr-parent'] !== $item['uri']))) {
 716                         $parent = q("SELECT `guid` FROM `item` WHERE `id` = %d", intval($item["parent"]));
 717                         $parent_item = (($item['thr-parent']) ? $item['thr-parent'] : $item['parent-uri']);
 718                         $attributes = array("ref" => $parent_item, "type" => "text/html",
 719                                                 "href" => app::get_baseurl().'/display/'.$parent[0]['guid'],
 720                                                 "dfrn:diaspora_guid" => $parent[0]['guid']);
 721                         xml_add_element($doc, $entry, "thr:in-reply-to", "", $attributes);
 722                 }
 723
 724                 xml_add_element($doc, $entry, "id", $item["uri"]);
 725                 xml_add_element($doc, $entry, "title", $item["title"]);
 726
 727                 xml_add_element($doc, $entry, "published", datetime_convert("UTC","UTC",$item["created"]."+00:00",ATOM_TIME));
 728                 xml_add_element($doc, $entry, "updated", datetime_convert("UTC","UTC",$item["edited"]."+00:00",ATOM_TIME));
 729
 730                 xml_add_element($doc, $entry, "dfrn:env", base64url_encode($body, true));
 731                 xml_add_element($doc, $entry, "content", (($type === 'html') ? $htmlbody : $body), array("type" => $type));
 732
 733                 xml_add_element($doc, $entry, "link", "", array("rel" => "alternate", "type" => "text/html",
 734                                                                 "href" => app::get_baseurl()."/display/".$item["guid"]));
 735
 736                 // "comment-allow" is some old fashioned stuff for old Friendica versions.
 737                 // It is included in the rewritten code for completeness
 738                 if ($comment)
 739                         xml_add_element($doc, $entry, "dfrn:comment-allow", intval($item['last-child']));
 740
 741                 if($item['location'])
 742                         xml_add_element($doc, $entry, "dfrn:location", $item['location']);
 743
 744                 if($item['coord'])
 745                         xml_add_element($doc, $entry, "georss:point", $item['coord']);
 746
 747                 if(($item['private']) || strlen($item['allow_cid']) || strlen($item['allow_gid']) || strlen($item['deny_cid']) || strlen($item['deny_gid']))
 748                         xml_add_element($doc, $entry, "dfrn:private", (($item['private']) ? $item['private'] : 1));
 749
 750                 if($item['extid'])
 751                         xml_add_element($doc, $entry, "dfrn:extid", $item['extid']);
 752
 753                 if($item['bookmark'])
 754                         xml_add_element($doc, $entry, "dfrn:bookmark", "true");
 755
 756                 if($item['app'])
 757                         xml_add_element($doc, $entry, "statusnet:notice_info", "", array("local_id" => $item['id'], "source" => $item['app']));
 758
 759                 xml_add_element($doc, $entry, "dfrn:diaspora_guid", $item["guid"]);
 760
 761                 // The signed text contains the content in Markdown, the sender handle and the signatur for the content
 762                 // It is needed for relayed comments to Diaspora.
 763                 if($item['signed_text']) {
 764                         $sign = base64_encode(json_encode(array('signed_text' => $item['signed_text'],'signature' => $item['signature'],'signer' => $item['signer'])));
 765                         xml_add_element($doc, $entry, "dfrn:diaspora_signature", $sign);
 766                 }
 767
 768                 xml_add_element($doc, $entry, "activity:verb", construct_verb($item));
 769
 770                 if ($item['object-type'] != "")
 771                         xml_add_element($doc, $entry, "activity:object-type", $item['object-type']);
 772                 elseif ($item['id'] == $item['parent'])
 773                         xml_add_element($doc, $entry, "activity:object-type", ACTIVITY_OBJ_NOTE);
 774                 else
 775                         xml_add_element($doc, $entry, "activity:object-type", ACTIVITY_OBJ_COMMENT);
 776
 777                 $actobj = self::create_activity($doc, "activity:object", $item['object']);
 778                 if ($actobj)
 779                         $entry->appendChild($actobj);
 780
 781                 $actarg = self::create_activity($doc, "activity:target", $item['target']);
 782                 if ($actarg)
 783                         $entry->appendChild($actarg);
 784
 785                 $tags = item_getfeedtags($item);
 786
 787                 if(count($tags)) {
 788                         foreach($tags as $t)
 789                                 if (($type != 'html') OR ($t[0] != "@"))
 790                                         xml_add_element($doc, $entry, "category", "", array("scheme" => "X-DFRN:".$t[0].":".$t[1], "term" => $t[2]));
 791                 }
 792
 793                 if(count($tags))
 794                         foreach($tags as $t)
 795                                 if ($t[0] == "@")
 796                                         $mentioned[$t[1]] = $t[1];
 797
 798                 foreach ($mentioned AS $mention) {
 799                         $r = q("SELECT `forum`, `prv` FROM `contact` WHERE `uid` = %d AND `nurl` = '%s'",
 800                                 intval($owner["uid"]),
 801                                 dbesc(normalise_link($mention)));
 802                         if ($r[0]["forum"] OR $r[0]["prv"])
 803                                 xml_add_element($doc, $entry, "link", "", array("rel" => "mentioned",
 804                                                                                         "ostatus:object-type" => ACTIVITY_OBJ_GROUP,
 805                                                                                         "href" => $mention));
 806                         else
 807                                 xml_add_element($doc, $entry, "link", "", array("rel" => "mentioned",
 808                                                                                         "ostatus:object-type" => ACTIVITY_OBJ_PERSON,
 809                                                                                         "href" => $mention));
 810                 }
 811
 812                 self::get_attachment($doc, $entry, $item);
 813
 814                 return $entry;
 815         }
 816
 817         /**
 818          * @brief Delivers the atom content to the contacts
 819          *
 820          * @param array $owner Owner record
 821          * @param array $contactr Contact record of the receiver
 822          * @param string $atom Content that will be transmitted
 823          * @param bool $dissolve (to be documented)
 824          *
 825          * @return int Deliver status. -1 means an error.
 826          */
 827         function deliver($owner,$contact,$atom, $dissolve = false) {
 828
 829                 $a = get_app();
 830
 831                 $idtosend = $orig_id = (($contact['dfrn-id']) ? $contact['dfrn-id'] : $contact['issued-id']);
 832
 833                 if($contact['duplex'] && $contact['dfrn-id'])
 834                         $idtosend = '0:' . $orig_id;
 835                 if($contact['duplex'] && $contact['issued-id'])
 836                         $idtosend = '1:' . $orig_id;
 837
 838
 839                 $rino = get_config('system','rino_encrypt');
 840                 $rino = intval($rino);
 841                 // use RINO1 if mcrypt isn't installed and RINO2 was selected
 842                 if ($rino==2 and !function_exists('mcrypt_create_iv')) $rino=1;
 843
 844                 logger("Local rino version: ". $rino, LOGGER_DEBUG);
 845
 846                 $ssl_val = intval(get_config('system','ssl_policy'));
 847                 $ssl_policy = '';
 848
 849                 switch($ssl_val){
 850                         case SSL_POLICY_FULL:
 851                                 $ssl_policy = 'full';
 852                                 break;
 853                         case SSL_POLICY_SELFSIGN:
 854                                 $ssl_policy = 'self';
 855                                 break;
 856                         case SSL_POLICY_NONE:
 857                         default:
 858                                 $ssl_policy = 'none';
 859                                 break;
 860                 }
 861
 862                 $url = $contact['notify'] . '&dfrn_id=' . $idtosend . '&dfrn_version=' . DFRN_PROTOCOL_VERSION . (($rino) ? '&rino='.$rino : '');
 863
 864                 logger('dfrn_deliver: ' . $url);
 865
 866                 $xml = fetch_url($url);
 867
 868                 $curl_stat = $a->get_curl_code();
 869                 if(! $curl_stat)
 870                         return(-1); // timed out
 871
 872                 logger('dfrn_deliver: ' . $xml, LOGGER_DATA);
 873
 874                 if(! $xml)
 875                         return 3;
 876
 877                 if(strpos($xml,'<?xml') === false) {
 878                         logger('dfrn_deliver: no valid XML returned');
 879                         logger('dfrn_deliver: returned XML: ' . $xml, LOGGER_DATA);
 880                         return 3;
 881                 }
 882
 883                 $res = parse_xml_string($xml);
 884
 885                 if((intval($res->status) != 0) || (! strlen($res->challenge)) || (! strlen($res->dfrn_id)))
 886                         return (($res->status) ? $res->status : 3);
 887
 888                 $postvars     = array();
 889                 $sent_dfrn_id = hex2bin((string) $res->dfrn_id);
 890                 $challenge    = hex2bin((string) $res->challenge);
 891                 $perm         = (($res->perm) ? $res->perm : null);
 892                 $dfrn_version = (float) (($res->dfrn_version) ? $res->dfrn_version : 2.0);
 893                 $rino_remote_version = intval($res->rino);
 894                 $page         = (($owner['page-flags'] == PAGE_COMMUNITY) ? 1 : 0);
 895
 896                 logger("Remote rino version: ".$rino_remote_version." for ".$contact["url"], LOGGER_DEBUG);
 897
 898                 if($owner['page-flags'] == PAGE_PRVGROUP)
 899                         $page = 2;
 900
 901                 $final_dfrn_id = '';
 902
 903                 if($perm) {
 904                         if((($perm == 'rw') && (! intval($contact['writable'])))
 905                                 || (($perm == 'r') && (intval($contact['writable'])))) {
 906                                 q("update contact set writable = %d where id = %d",
 907                                         intval(($perm == 'rw') ? 1 : 0),
 908                                         intval($contact['id'])
 909                                 );
 910                                 $contact['writable'] = (string) 1 - intval($contact['writable']);
 911                         }
 912                 }
 913
 914                 if(($contact['duplex'] && strlen($contact['pubkey']))
 915                         || ($owner['page-flags'] == PAGE_COMMUNITY && strlen($contact['pubkey']))
 916                         || ($contact['rel'] == CONTACT_IS_SHARING && strlen($contact['pubkey']))) {
 917                         openssl_public_decrypt($sent_dfrn_id,$final_dfrn_id,$contact['pubkey']);
 918                         openssl_public_decrypt($challenge,$postvars['challenge'],$contact['pubkey']);
 919                 } else {
 920                         openssl_private_decrypt($sent_dfrn_id,$final_dfrn_id,$contact['prvkey']);
 921                         openssl_private_decrypt($challenge,$postvars['challenge'],$contact['prvkey']);
 922                 }
 923
 924                 $final_dfrn_id = substr($final_dfrn_id, 0, strpos($final_dfrn_id, '.'));
 925
 926                 if(strpos($final_dfrn_id,':') == 1)
 927                         $final_dfrn_id = substr($final_dfrn_id,2);
 928
 929                 if($final_dfrn_id != $orig_id) {
 930                         logger('dfrn_deliver: wrong dfrn_id.');
 931                         // did not decode properly - cannot trust this site
 932                         return 3;
 933                 }
 934
 935                 $postvars['dfrn_id']      = $idtosend;
 936                 $postvars['dfrn_version'] = DFRN_PROTOCOL_VERSION;
 937                 if($dissolve)
 938                         $postvars['dissolve'] = '1';
 939
 940
 941                 if((($contact['rel']) && ($contact['rel'] != CONTACT_IS_SHARING) && (! $contact['blocked'])) || ($owner['page-flags'] == PAGE_COMMUNITY)) {
 942                         $postvars['data'] = $atom;
 943                         $postvars['perm'] = 'rw';
 944                 } else {
 945                         $postvars['data'] = str_replace('<dfrn:comment-allow>1','<dfrn:comment-allow>0',$atom);
 946                         $postvars['perm'] = 'r';
 947                 }
 948
 949                 $postvars['ssl_policy'] = $ssl_policy;
 950
 951                 if($page)
 952                         $postvars['page'] = $page;
 953
 954
 955                 if($rino>0 && $rino_remote_version>0 && (! $dissolve)) {
 956                         logger('rino version: '. $rino_remote_version);
 957
 958                         switch($rino_remote_version) {
 959                                 case 1:
 960                                         // Deprecated rino version!
 961                                         $key = substr(random_string(),0,16);
 962                                         $data = aes_encrypt($postvars['data'],$key);
 963                                         break;
 964                                 case 2:
 965                                         // RINO 2 based on php-encryption
 966                                         try {
 967                                                 $key = Crypto::createNewRandomKey();
 968                                         } catch (CryptoTestFailed $ex) {
 969                                                 logger('Cannot safely create a key');
 970                                                 return -1;
 971                                         } catch (CannotPerformOperation $ex) {
 972                                                 logger('Cannot safely create a key');
 973                                                 return -1;
 974                                         }
 975                                         try {
 976                                                 $data = Crypto::encrypt($postvars['data'], $key);
 977                                         } catch (CryptoTestFailed $ex) {
 978                                                 logger('Cannot safely perform encryption');
 979                                                 return -1;
 980                                         } catch (CannotPerformOperation $ex) {
 981                                                 logger('Cannot safely perform encryption');
 982                                                 return -1;
 983                                         }
 984                                         break;
 985                                 default:
 986                                         logger("rino: invalid requested verision '$rino_remote_version'");
 987                                         return -1;
 988                         }
 989
 990                         $postvars['rino'] = $rino_remote_version;
 991                         $postvars['data'] = bin2hex($data);
 992
 993                         #logger('rino: sent key = ' . $key, LOGGER_DEBUG);
 994
 995
 996                         if($dfrn_version >= 2.1) {
 997                                 if(($contact['duplex'] && strlen($contact['pubkey']))
 998                                         || ($owner['page-flags'] == PAGE_COMMUNITY && strlen($contact['pubkey']))
 999                                         || ($contact['rel'] == CONTACT_IS_SHARING && strlen($contact['pubkey'])))
1000
1001                                         openssl_public_encrypt($key,$postvars['key'],$contact['pubkey']);
1002                                 else
1003                                         openssl_private_encrypt($key,$postvars['key'],$contact['prvkey']);
1004
1005                         } else {
1006                                 if(($contact['duplex'] && strlen($contact['prvkey'])) || ($owner['page-flags'] == PAGE_COMMUNITY))
1007                                         openssl_private_encrypt($key,$postvars['key'],$contact['prvkey']);
1008                                 else
1009                                         openssl_public_encrypt($key,$postvars['key'],$contact['pubkey']);
1010
1011                         }
1012
1013                         logger('md5 rawkey ' . md5($postvars['key']));
1014
1015                         $postvars['key'] = bin2hex($postvars['key']);
1016                 }
1017
1018
1019                 logger('dfrn_deliver: ' . "SENDING: " . print_r($postvars,true), LOGGER_DATA);
1020
1021                 $xml = post_url($contact['notify'],$postvars);
1022
1023                 logger('dfrn_deliver: ' . "RECEIVED: " . $xml, LOGGER_DATA);
1024
1025                 $curl_stat = $a->get_curl_code();
1026                 if((! $curl_stat) || (! strlen($xml)))
1027                         return(-1); // timed out
1028
1029                 if(($curl_stat == 503) && (stristr($a->get_curl_headers(),'retry-after')))
1030                         return(-1);
1031
1032                 if(strpos($xml,'<?xml') === false) {
1033                         logger('dfrn_deliver: phase 2: no valid XML returned');
1034                         logger('dfrn_deliver: phase 2: returned XML: ' . $xml, LOGGER_DATA);
1035                         return 3;
1036                 }
1037
1038                 if($contact['term-date'] != '0000-00-00 00:00:00') {
1039                         logger("dfrn_deliver: $url back from the dead - removing mark for death");
1040                         require_once('include/Contact.php');
1041                         unmark_for_death($contact);
1042                 }
1043
1044                 $res = parse_xml_string($xml);
1045
1046                 return $res->status;
1047         }
1048 }