]> git.mxchange.org Git - friendica.git/blobdiff - mod/ping.php
Merge pull request #2949 from silke/vagrant-1604
[friendica.git] / mod / ping.php
index f2e57430d2d6ac14488be6cd7e363eb9632fbf52..407ec4c229992b8e9f80e3c698b3f953ab3418ac 100644 (file)
@@ -3,37 +3,50 @@ require_once("include/datetime.php");
 require_once('include/bbcode.php');
 require_once('include/ForumManager.php');
 require_once('include/group.php');
-require_once("mod/proxy.php");
+require_once('mod/proxy.php');
+require_once('include/xml.php');
 
 function ping_init(&$a) {
 
-       header("Content-type: text/xml");
+       $format = 'xml';
 
-       echo "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>
-               <result>";
-
-       $xmlhead="<"."?xml version='1.0' encoding='UTF-8' ?".">";
-
-       if(local_user()){
+       if (isset($_GET['format']) && $_GET['format'] == 'json') {
+               $format = 'json';
+       }
 
+       if (local_user()){
                // Different login session than the page that is calling us.
-
-               if(intval($_GET['uid']) && intval($_GET['uid']) != local_user()) {
-                       echo '<invalid>1</invalid></result>';
+               if (intval($_GET['uid']) && intval($_GET['uid']) != local_user()) {
+
+                       $data = array('result' => array('invalid' => 1));
+
+                       if ($format == 'json') {
+                               if (isset($_GET['callback'])) {
+                                       // JSONP support
+                                       header("Content-type: application/javascript");
+                                       echo $_GET['callback'] . '(' . json_encode($data) . ')';
+                               } else {
+                                       header("Content-type: application/json");
+                                       echo json_encode($data);
+                               }
+                       } else {
+                               header("Content-type: text/xml");
+                               echo xml::from_array($data, $xml);
+                       }
                        killme();
                }
 
                $notifs = ping_get_notifications(local_user());
                $sysnotify = 0; // we will update this in a moment
 
-               $tags = array();
+               $tags     = array();
                $comments = array();
-               $likes = array();
+               $likes    = array();
                $dislikes = array();
-               $friends = array();
-               $posts = array();
-               $regs = array();
-               $mails = array();
+               $friends  = array();
+               $posts    = array();
+               $regs     = array();
+               $mails    = array();
 
                $home = 0;
                $network = 0;
@@ -51,54 +64,42 @@ function ping_init(&$a) {
                        intval(local_user()), intval(local_user())
                );
 
-               if(dbm::is_result($r)) {
+               if (dbm::is_result($r)) {
 
                        $arr = array('items' => $r);
                        call_hooks('network_ping', $arr);
 
                        foreach ($r as $it) {
-
-                               if($it['wall'])
-                                       $home ++;
-                               else
-                                       $network ++;
-
-                               switch($it['verb']){
-                                       case ACTIVITY_TAG:
-                                               $obj = parse_xml_string($xmlhead.$it['object']);
-                                               $it['tname'] = $obj->content;
-                                               $tags[] = $it;
-                                               break;
-                                       case ACTIVITY_LIKE:
-                                               $likes[] = $it;
-                                               break;
-                                       case ACTIVITY_DISLIKE:
-                                               $dislikes[] = $it;
-                                               break;
-                                       case ACTIVITY_FRIEND:
-                                               $obj = parse_xml_string($xmlhead.$it['object']);
-                                               $it['fname'] = $obj->title;
-                                               $friends[] = $it;
-                                               break;
-                                       default:
-                                               if ($it['parent']!=$it['id']) {
-                                                       $comments[] = $it;
-                                               } else {
-                                                       if(! $it['wall'])
-                                                               $posts[] = $it;
-                                               }
+                               if ($it['wall']) {
+                                       $home++;
+                               } else {
+                                       $network++;
                                }
                        }
                }
 
-               if($network) {
-                       if(intval(feature_enabled(local_user(),'groups'))) {
+               if ($network) {
+                       if (intval(feature_enabled(local_user(),'groups'))) {
                                // Find out how unseen network posts are spread across groups
-                               $groups_unseen = groups_count_unseen();
+                               $group_counts = groups_count_unseen();
+                               if (dbm::is_result($group_counts)) {
+                                       foreach ($group_counts as $group_count) {
+                                               if ($group_count['count'] > 0) {
+                                                       $groups_unseen[] = $group_count;
+                                               }
+                                       }
+                               }
                        }
 
-                       if(intval(feature_enabled(local_user(),'forumlist_widget'))) {
-                               $forums_unseen = ForumManager::count_unseen_items();
+                       if (intval(feature_enabled(local_user(),'forumlist_widget'))) {
+                               $forum_counts = ForumManager::count_unseen_items();
+                               if (dbm::is_result($forums_counts)) {
+                                       foreach ($forums_counts as $forum_count) {
+                                               if ($forum_count['count'] > 0) {
+                                                       $forums_unseen[] = $forum_count;
+                                               }
+                                       }
+                               }
                        }
                }
 
@@ -124,14 +125,15 @@ function ping_init(&$a) {
                        intval(local_user()),
                        dbesc($myurl)
                );
-               $mail = count($mails);
+               $mail_count = count($mails);
 
                if ($a->config['register_policy'] == REGISTER_APPROVE && is_site_admin()){
                        $regs = q("SELECT `contact`.`name`, `contact`.`url`, `contact`.`micro`, `register`.`created`, COUNT(*) as `total` FROM `contact` RIGHT JOIN `register` ON `register`.`uid`=`contact`.`uid` WHERE `contact`.`self`=1");
-                       if($regs)
+                       if ($regs) {
                                $register = $regs[0]['total'];
+                       }
                } else {
-                       $register = "0";
+                       $register = 0;
                }
 
                $all_events = 0;
@@ -141,7 +143,6 @@ function ping_init(&$a) {
                $birthdays = 0;
                $birthdays_today = 0;
 
-
                $ev = q("SELECT count(`event`.`id`) as total, type, start, adjust FROM `event`
                        WHERE `event`.`uid` = %d AND `start` < '%s' AND `finish` > '%s' and `ignore` = 0
                        ORDER BY `start` ASC ",
@@ -150,23 +151,23 @@ function ping_init(&$a) {
                        dbesc(datetime_convert('UTC','UTC','now'))
                );
 
-               if(dbm::is_result($ev)) {
+               if (dbm::is_result($ev)) {
                        $all_events = intval($ev[0]['total']);
 
-                       if($all_events) {
+                       if ($all_events) {
                                $str_now = datetime_convert('UTC',$a->timezone,'now','Y-m-d');
                                foreach($ev as $x) {
                                        $bd = false;
-                                       if($x['type'] === 'birthday') {
+                                       if ($x['type'] === 'birthday') {
                                                $birthdays ++;
                                                $bd = true;
                                        }
                                        else {
                                                $events ++;
                                        }
-                                       if(datetime_convert('UTC',((intval($x['adjust'])) ? $a->timezone : 'UTC'), $x['start'],'Y-m-d') === $str_now) {
+                                       if (datetime_convert('UTC',((intval($x['adjust'])) ? $a->timezone : 'UTC'), $x['start'],'Y-m-d') === $str_now) {
                                                $all_events_today ++;
-                                               if($bd)
+                                               if ($bd)
                                                        $birthdays_today ++;
                                                else
                                                        $events_today ++;
@@ -175,133 +176,71 @@ function ping_init(&$a) {
                        }
                }
 
-
-               /**
-                * return xml from notification array
-                *
-                * @param array $n Notification array:
-                *              'href' => notification link
-                *              'name' => subject name
-                *              'url' => subject url
-                *              'photo' => subject photo
-                *              'date' => notification date
-                *              'seen' => bool true/false
-                *              'message' => notification message. "{0}" will be replaced by subject name
-                **/
-               function xmlize($n){
-
-                       $contact = get_contact_details_by_url($n['url']);
-                       if (isset($contact["micro"]))
-                               $n['photo'] = proxy_url($contact["micro"], false, PROXY_SIZE_MICRO);
-                       else
-                               $n['photo'] = proxy_url($n['photo'], false, PROXY_SIZE_MICRO);
-
-                       $n['message'] = html_entity_decode($n['message'], ENT_COMPAT | ENT_HTML401, "UTF-8");
-                       $n['name'] = html_entity_decode($n['name'], ENT_COMPAT | ENT_HTML401, "UTF-8");
-
-                       // Are the nofications calles from the regular process or via the friendica app?
-                       $regularnotifications = (intval($_GET['uid']) AND intval($_GET['_']));
-
-                       $a = get_app();
-
-                       if ($a->is_friendica_app() OR !$regularnotifications)
-                               $n['message'] = str_replace("{0}", $n['name'], $n['message']);
-
-                       $local_time = datetime_convert('UTC',date_default_timezone_get(),$n['date']);
-
-                       call_hooks('ping_xmlize', $n);
-                       $notsxml = '<note id="%d" href="%s" name="%s" url="%s" photo="%s" date="%s" seen="%s" timestamp="%s" >%s</note>'."\n";
-                       return sprintf ( $notsxml, intval($n['id']),
-                               xmlify($n['href']), xmlify(xmlify($n['name'])), xmlify($n['url']), xmlify($n['photo']),
-                               xmlify(relative_date($n['date'])), xmlify($n['seen']), xmlify(strtotime($local_time)),
-                               xmlify($n['message'])
-                       );
-               }
-
-               echo "<intro>$intro</intro>
-                               <mail>$mail</mail>
-                               <net>$network</net>
-                               <home>$home</home>\r\n";
-               if ($register!=0) echo "<register>$register</register>";
-
-               if ( dbm::is_result($groups_unseen) ) {
-                       echo '<groups>';
-                       foreach ($groups_unseen as $it)
-                               if ($it['count'] > 0)
-                                       echo '<group id="'.$it['id'].'">'.$it['count']."</group>";
-
-                       echo "</groups>";
-               }
-
-               if ( dbm::is_result($forums_unseen) ) {
-                       echo '<forums>';
-                       foreach ($forums_unseen as $it)
-                               if ($it['count'] > 0)
-                                       echo '<forum id="'.$it['id'].'">'.$it['count']."</forum>";
-
-                       echo "</forums>";
-               }
-
-               echo "<all-events>$all_events</all-events>
-                       <all-events-today>$all_events_today</all-events-today>
-                       <events>$events</events>
-                       <events-today>$events_today</events-today>
-                       <birthdays>$birthdays</birthdays>
-                       <birthdays-today>$birthdays_today</birthdays-today>\r\n";
-
-
-               if (dbm::is_result($notifs) && (! $sysnotify)) {
-                       foreach ($notifs as $zz) {
-                               if($zz['seen'] == 0)
+               $data = array();
+               $data['intro']    = $intro;
+               $data['mail']     = $mail_count;
+               $data['net']      = $network;
+               $data['home']     = $home;
+               $data['register'] = $register;
+
+               $data['all-events']       = $all_events;
+               $data['all-events-today'] = $all_events_today;
+               $data['events']           = $events;
+               $data['events-today']     = $events_today;
+               $data['birthdays']        = $birthdays;
+               $data['birthdays-today']  = $birthdays_today;
+
+               if (dbm::is_result($notifs) && !$sysnotify) {
+                       foreach ($notifs as $notif) {
+                               if ($notif['seen'] == 0) {
                                        $sysnotify ++;
+                               }
                        }
                }
 
-               echo '  <notif count="'. ($sysnotify + $intro + $mail + $register) .'">';
-
                // merge all notification types in one array
-               if ( dbm::is_result($intros) ) {
-                       foreach ($intros as $i) {
-                               $n = array(
-                                       'href' => $a->get_baseurl().'/notifications/intros/'.$i['id'],
-                                       'name' => $i['name'],
-                                       'url' => $i['url'],
-                                       'photo' => $i['photo'],
-                                       'date' => $i['datetime'],
-                                       'seen' => false,
-                                       'message' => t("{0} wants to be your friend"),
+               if (dbm::is_result($intros)) {
+                       foreach ($intros as $intro) {
+                               $notif = array(
+                                       'href'    => $a->get_baseurl() . '/notifications/intros/' . $intro['id'],
+                                       'name'    => $intro['name'],
+                                       'url'     => $intro['url'],
+                                       'photo'   => $intro['photo'],
+                                       'date'    => $intro['datetime'],
+                                       'seen'    => false,
+                                       'message' => t('{0} wants to be your friend'),
                                );
-                               $notifs[] = $n;
+                               $notifs[] = $notif;
                        }
                }
 
-               if ( dbm::is_result($mails) ) {
-                       foreach ($mails as $i) {
-                               $n = array(
-                                       'href' => $a->get_baseurl().'/message/'.$i['id'],
-                                       'name' => $i['from-name'],
-                                       'url' => $i['from-url'],
-                                       'photo' => $i['from-photo'],
-                                       'date' => $i['created'],
-                                       'seen' => false,
-                                       'message' => t("{0} sent you a message"),
+               if (dbm::is_result($mails)) {
+                       foreach ($mails as $mail) {
+                               $notif = array(
+                                       'href'    => $a->get_baseurl() . '/message/' . $mail['id'],
+                                       'name'    => $mail['from-name'],
+                                       'url'     => $mail['from-url'],
+                                       'photo'   => $mail['from-photo'],
+                                       'date'    => $mail['created'],
+                                       'seen'    => false,
+                                       'message' => t('{0} sent you a message'),
                                );
-                               $notifs[] = $n;
+                               $notifs[] = $notif;
                        }
                }
 
-               if ( dbm::is_result($regs) ) {
-                       foreach ($regs as $i) {
-                               $n = array(
-                                       'href' => $a->get_baseurl().'/admin/users/',
-                                       'name' => $i['name'],
-                                       'url' => $i['url'],
-                                       'photo' => $i['micro'],
-                                       'date' => $i['created'],
-                                       'seen' => false,
-                                       'message' => t("{0} requested registration"),
+               if (dbm::is_result($regs)) {
+                       foreach ($regs as $reg) {
+                               $notif = array(
+                                       'href'    => $a->get_baseurl() . '/admin/users/',
+                                       'name'    => $reg['name'],
+                                       'url'     => $reg['url'],
+                                       'photo'   => $reg['micro'],
+                                       'date'    => $reg['created'],
+                                       'seen'    => false,
+                                       'message' => t('{0} requested registration'),
                                );
-                               $notifs[] = $n;
+                               $notifs[] = $notif;
                        }
                }
 
@@ -316,37 +255,89 @@ function ping_init(&$a) {
                };
                usort($notifs, $sort_function);
 
-               if( dbm::is_result($notifs) ) {
-                       foreach($notifs as $n) {
-                               echo xmlize($n);
-                       }
-               }
+               if (dbm::is_result($notifs)) {
+                       // Are the nofications called from the regular process or via the friendica app?
+                       $regularnotifications = (intval($_GET['uid']) AND intval($_GET['_']));
 
+                       foreach ($notifs as $notif) {
+                               if ($a->is_friendica_app() OR !$regularnotifications) {
+                                       $notif['message'] = str_replace("{0}", $notif['name'], $notif['message']);
+                               }
 
-               echo "  </notif>";
-       }
-       echo " <sysmsgs>";
+                               $contact = get_contact_details_by_url($notif['url']);
+                               if (isset($contact['micro'])) {
+                                       $notif['photo'] = proxy_url($contact['micro'], false, PROXY_SIZE_MICRO);
+                               } else {
+                                       $notif['photo'] = proxy_url($notif['photo'], false, PROXY_SIZE_MICRO);
+                               }
 
-       if(x($_SESSION,'sysmsg')){
-               foreach ($_SESSION['sysmsg'] as $m){
-                       echo "<notice>".xmlify($m)."</notice>";
+                               $local_time = datetime_convert('UTC', date_default_timezone_get(), $notif['date']);
+
+                               $notifications[] = array(
+                                       'id'        => $notif['id'],
+                                       'href'      => $notif['href'],
+                                       'name'      => $notif['name'],
+                                       'url'       => $notif['url'],
+                                       'photo'     => $notif['photo'],
+                                       'date'      => relative_date($notif['date']),
+                                       'message'   => $notif['message'],
+                                       'seen'      => $notif['seen'],
+                                       'timestamp' => strtotime($local_time)
+                               );
+                       }
                }
+       }
+
+       $sysmsgs = array();
+       $sysmsgs_info = array();
+
+       if (x($_SESSION,'sysmsg')) {
+               $sysmsgs = $_SESSION['sysmsg'];
                unset($_SESSION['sysmsg']);
        }
-       if(x($_SESSION,'sysmsg_info')){
-               foreach ($_SESSION['sysmsg_info'] as $m){
-                       echo "<info>".xmlify($m)."</info>";
-               }
+
+       if (x($_SESSION,'sysmsg_info')) {
+               $sysmsgs_info = $_SESSION['sysmsg_info'];
                unset($_SESSION['sysmsg_info']);
        }
 
-       echo " </sysmsgs>";
-       echo"</result>
-       ";
+       if ($format == 'json') {
+               $data['groups'] = $groups_unseen;
+               $data['forums'] = $forums_unseen;
+               $data['notify'] = $sysnotify + $intro + $mail_count + $register;
+               $data['notifications'] = $notifications;
+               $data['sysmsgs'] = array(
+                       'notice' => $sysmsgs,
+                       'info' => $sysmsgs_info
+               );
+
+               $json_payload = json_encode(array("result" => $data));
+
+               if (isset($_GET['callback'])) {
+                       // JSONP support
+                       header("Content-type: application/javascript");
+                       echo $_GET['callback'] . '(' . $json_payload . ')';
+               } else {
+                       header("Content-type: application/json");
+                       echo $json_payload;
+               }
+       } else {
+               // Legacy slower XML format output
+               $data = ping_format_xml_data($data, $sysnotify, $notifications, $sysmsgs, $sysmsgs_info, $groups_unseen, $forums_unseen);
+
+               header("Content-type: text/xml");
+               echo xml::from_array(array("result" => $data), $xml);
+       }
 
        killme();
 }
 
+/**
+ * @brief Retrieves the notifications array for the given user ID
+ *
+ * @param int $uid User id
+ * @return array Associative array of notifications
+ */
 function ping_get_notifications($uid) {
 
        $result = array();
@@ -375,46 +366,112 @@ function ping_get_notifications($uid) {
                        $seensql = "";
                        $order = "DESC";
                        $offset = 0;
-               } elseif (!$r)
+               } elseif (!$r) {
                        $quit = true;
-               else
+               } else {
                        $offset += 50;
-
+               }
 
                foreach ($r AS $notification) {
-                       if (is_null($notification["visible"]))
+                       if (is_null($notification["visible"])) {
                                $notification["visible"] = true;
+                       }
 
-                       if (is_null($notification["spam"]))
+                       if (is_null($notification["spam"])) {
                                $notification["spam"] = 0;
+                       }
 
-                       if (is_null($notification["deleted"]))
+                       if (is_null($notification["deleted"])) {
                                $notification["deleted"] = 0;
+                       }
 
-                       $notification["message"] = strip_tags(bbcode($notification["msg"]));
-                       $notification["name"] = strip_tags(bbcode($notification["name"]));
-
-                       // Replace the name with {0} but ensure to make that only once
-                       // The {0} is used later and prints the name in bold.
-
-                       if ($notification['name'] != "")
-                               $pos = strpos($notification["message"],$notification['name']);
-                       else
-                               $pos = false;
-
-                       if ($pos !== false)
-                               $notification["message"] = substr_replace($notification["message"],"{0}",$pos,strlen($notification["name"]));
+                       if ($notification["msg_cache"]) {
+                               $notification["name"] = $notification["name_cache"];
+                               $notification["message"] = $notification["msg_cache"];
+                       } else {
+                               $notification["name"] = strip_tags(bbcode($notification["name"]));
+                               $notification["message"] = format_notification_message($notification["name"], strip_tags(bbcode($notification["msg"])));
+
+                               q("UPDATE `notify` SET `name_cache` = '%s', `msg_cache` = '%s' WHERE `id` = %d",
+                                       dbesc($notification["name"]),
+                                       dbesc($notification["message"]),
+                                       intval($notification["id"])
+                               );
+                       }
 
-                       $notification['href'] = $a->get_baseurl() . '/notify/view/' . $notification['id'];
+                       $notification["href"] = $a->get_baseurl() . "/notify/view/" . $notification["id"];
 
                        if ($notification["visible"] AND !$notification["spam"] AND
                                !$notification["deleted"] AND !is_array($result[$notification["parent"]])) {
                                $result[$notification["parent"]] = $notification;
                        }
                }
-
        } while ((count($result) < 50) AND !$quit);
 
-
        return($result);
 }
+
+/**
+ * @brief Backward-compatible XML formatting for ping.php output
+ * @deprecated
+ *
+ * @param array $data The initial ping data array
+ * @param int $sysnotify Number of unseen system notifications
+ * @param array $notifs Complete list of notification
+ * @param array $sysmsgs List of system notice messages
+ * @param array $sysmsgs_info List of system info messages
+ * @return array XML-transform ready data array
+ */
+function ping_format_xml_data($data, $sysnotify, $notifs, $sysmsgs, $sysmsgs_info, $groups_unseen, $forums_unseen) {
+       $notifications = array();
+       foreach($notifs as $key => $n) {
+               $notifications[$key . ":note"] = $n['message'];
+
+               $notifications[$key . ":@attributes"] = array(
+                       "id" => $n["id"],
+                       "href" => $n['href'],
+                       "name" => $n['name'],
+                       "url" => $n['url'],
+                       "photo" => $n['photo'],
+                       "date" => $n['date'],
+                       "seen" => $n['seen'],
+                       "timestamp" => $n['timestamp']
+               );
+       }
+
+       $sysmsg = array();
+       foreach ($sysmsgs as $key => $m){
+               $sysmsg[$key . ":notice"] = $m;
+       }
+       foreach ($sysmsgs_info as $key => $m){
+               $sysmsg[$key . ":info"] = $m;
+       }
+
+       $data["notif"] = $notifications;
+       $data["@attributes"] = array("count" => $sysnotify + $data["intro"] + $data["mail"] + $data["register"]);
+       $data["sysmsgs"] = $sysmsg;
+
+       if ($data["register"] == 0) {
+               unset($data["register"]);
+       }
+
+       $groups = array();
+       if (count($groups_unseen)) {
+               foreach ($groups_unseen as $key => $item) {
+                       $groups[$key . ':group'] = $item['count'];
+                       $groups[$key . ':@attributes'] = array('id' => $item['id']);
+               }
+               $data['groups'] = $groups;
+       }
+
+       $forums = array();
+       if (count($forums_unseen)) {
+               foreach ($forums_unseen as $key => $item) {
+                       $forums[$count . ':forum'] = $item['count'];
+                       $forums[$count . ':@attributes'] = array('id' => $item['id']);
+               }
+               $data['forums'] = $forums;
+       }
+
+       return $data;
+}
\ No newline at end of file