]> git.mxchange.org Git - friendica.git/commitdiff
ping.php: Ensure data structure consistency
authorHypolite Petovan <ben.lort@gmail.com>
Wed, 23 Nov 2016 02:11:22 +0000 (21:11 -0500)
committerHypolite Petovan <ben.lort@gmail.com>
Wed, 23 Nov 2016 02:11:22 +0000 (21:11 -0500)
- Formatting
- Documentation

mod/ping.php

index 407ec4c229992b8e9f80e3c698b3f953ab3418ac..7ef2231080f1bc5ea35c4b1f7b80039f17253bec 100644 (file)
@@ -6,15 +6,89 @@ require_once('include/group.php');
 require_once('mod/proxy.php');
 require_once('include/xml.php');
 
-function ping_init(&$a) {
-
+/**
+ * @brief Outputs the counts and the lists of various notifications
+ *
+ * The output format can be controlled via the GET parameter 'format'. It can be
+ * - xml (deprecated legacy default)
+ * - json (outputs JSONP with the 'callback' GET parameter)
+ *
+ * Expected JSON structure:
+ * {
+ *             "result": {
+ *                     "intro": 0,
+ *                     "mail": 0,
+ *                     "net": 0,
+ *                     "home": 0,
+ *                     "register": 0,
+ *                     "all-events": 0,
+ *                     "all-events-today": 0,
+ *                     "events": 0,
+ *                     "events-today": 0,
+ *                     "birthdays": 0,
+ *                     "birthdays-today": 0,
+ *                     "groups": [ ],
+ *                     "forums": [ ],
+ *                     "notify": 0,
+ *                     "notifications": [ ],
+ *                     "sysmsgs": {
+ *                             "notice": [ ],
+ *                             "info": [ ]
+ *                     }
+ *             }
+ *     }
+ *
+ * @param App $a The Friendica App instance
+ */
+function ping_init(App $a)
+{
        $format = 'xml';
 
        if (isset($_GET['format']) && $_GET['format'] == 'json') {
                $format = 'json';
        }
 
-       if (local_user()){
+       $tags          = array();
+       $comments      = array();
+       $likes         = array();
+       $dislikes      = array();
+       $friends       = array();
+       $posts         = array();
+       $regs          = array();
+       $mails         = array();
+       $notifications = array();
+
+       $intro_count    = 0;
+       $mail_count     = 0;
+       $home_count     = 0;
+       $network_count  = 0;
+       $register_count = 0;
+       $sysnotify_count = 0;
+       $groups_unseen  = array();
+       $forums_unseen  = array();
+
+       $all_events       = 0;
+       $all_events_today = 0;
+       $events           = 0;
+       $events_today     = 0;
+       $birthdays        = 0;
+       $birthdays_today  = 0;
+
+       $data = array();
+       $data['intro']    = $intro_count;
+       $data['mail']     = $mail_count;
+       $data['net']      = $network_count;
+       $data['home']     = $home_count;
+       $data['register'] = $register_count;
+
+       $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 (false && local_user()){
                // Different login session than the page that is calling us.
                if (intval($_GET['uid']) && intval($_GET['uid']) != local_user()) {
 
@@ -37,26 +111,11 @@ function ping_init(&$a) {
                }
 
                $notifs = ping_get_notifications(local_user());
-               $sysnotify = 0; // we will update this in a moment
-
-               $tags     = array();
-               $comments = array();
-               $likes    = array();
-               $dislikes = array();
-               $friends  = array();
-               $posts    = array();
-               $regs     = array();
-               $mails    = array();
-
-               $home = 0;
-               $network = 0;
-               $groups_unseen = array();
-               $forums_unseen = array();
-
-               $r = q("SELECT `item`.`id`,`item`.`parent`, `item`.`verb`, `item`.`wall`, `item`.`author-name`,
+
+               $items_unseen = q("SELECT `item`.`id`, `item`.`parent`, `item`.`verb`, `item`.`wall`, `item`.`author-name`,
                                `item`.`contact-id`, `item`.`author-link`, `item`.`author-avatar`, `item`.`created`, `item`.`object`,
-                               `pitem`.`author-name` as `pname`, `pitem`.`author-link` as `plink`
-                               FROM `item` INNER JOIN `item` as `pitem` ON  `pitem`.`id`=`item`.`parent`
+                               `pitem`.`author-name` AS `pname`, `pitem`.`author-link` AS `plink`
+                               FROM `item` INNER JOIN `item` AS `pitem` ON  `pitem`.`id` = `item`.`parent`
                                WHERE `item`.`unseen` = 1 AND `item`.`visible` = 1 AND
                                 `item`.`deleted` = 0 AND `item`.`uid` = %d AND `pitem`.`parent` != 0
                                AND `item`.`contact-id` != %d
@@ -64,22 +123,21 @@ function ping_init(&$a) {
                        intval(local_user()), intval(local_user())
                );
 
-               if (dbm::is_result($r)) {
-
-                       $arr = array('items' => $r);
+               if (dbm::is_result($items_unseen)) {
+                       $arr = array('items' => $items_unseen);
                        call_hooks('network_ping', $arr);
 
-                       foreach ($r as $it) {
-                               if ($it['wall']) {
-                                       $home++;
+                       foreach ($items_unseen as $item) {
+                               if ($item['wall']) {
+                                       $home_count++;
                                } else {
                                        $network++;
                                }
                        }
                }
 
-               if ($network) {
-                       if (intval(feature_enabled(local_user(),'groups'))) {
+               if ($network_count) {
+                       if (intval(feature_enabled(local_user(), 'groups'))) {
                                // Find out how unseen network posts are spread across groups
                                $group_counts = groups_count_unseen();
                                if (dbm::is_result($group_counts)) {
@@ -91,7 +149,7 @@ function ping_init(&$a) {
                                }
                        }
 
-                       if (intval(feature_enabled(local_user(),'forumlist_widget'))) {
+                       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) {
@@ -106,13 +164,13 @@ function ping_init(&$a) {
                $intros1 = q("SELECT  `intro`.`id`, `intro`.`datetime`,
                        `fcontact`.`name`, `fcontact`.`url`, `fcontact`.`photo`
                        FROM `intro` LEFT JOIN `fcontact` ON `intro`.`fid` = `fcontact`.`id`
-                       WHERE `intro`.`uid` = %d  AND `intro`.`blocked` = 0 AND `intro`.`ignore` = 0 AND `intro`.`fid`!=0",
+                       WHERE `intro`.`uid` = %d  AND `intro`.`blocked` = 0 AND `intro`.`ignore` = 0 AND `intro`.`fid` != 0",
                        intval(local_user())
                );
                $intros2 = q("SELECT `intro`.`id`, `intro`.`datetime`,
                        `contact`.`name`, `contact`.`url`, `contact`.`photo`
                        FROM `intro` LEFT JOIN `contact` ON `intro`.`contact-id` = `contact`.`id`
-                       WHERE `intro`.`uid` = %d  AND `intro`.`blocked` = 0 AND `intro`.`ignore` = 0 AND `intro`.`contact-id`!=0",
+                       WHERE `intro`.`uid` = %d  AND `intro`.`blocked` = 0 AND `intro`.`ignore` = 0 AND `intro`.`contact-id` != 0",
                        intval(local_user())
                );
 
@@ -128,7 +186,9 @@ function ping_init(&$a) {
                $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");
+                       $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) {
                                $register = $regs[0]['total'];
                        }
@@ -136,26 +196,19 @@ function ping_init(&$a) {
                        $register = 0;
                }
 
-               $all_events = 0;
-               $all_events_today = 0;
-               $events = 0;
-               $events_today = 0;
-               $birthdays = 0;
-               $birthdays_today = 0;
-
-               $ev = q("SELECT count(`event`.`id`) as total, type, start, adjust FROM `event`
+               $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 ",
                        intval(local_user()),
-                       dbesc(datetime_convert('UTC','UTC','now + 7 days')),
-                       dbesc(datetime_convert('UTC','UTC','now'))
+                       dbesc(datetime_convert('UTC', 'UTC', 'now + 7 days')),
+                       dbesc(datetime_convert('UTC', 'UTC', 'now'))
                );
 
                if (dbm::is_result($ev)) {
                        $all_events = intval($ev[0]['total']);
 
                        if ($all_events) {
-                               $str_now = datetime_convert('UTC',$a->timezone,'now','Y-m-d');
+                               $str_now = datetime_convert('UTC', $a->timezone, 'now', 'Y-m-d');
                                foreach($ev as $x) {
                                        $bd = false;
                                        if ($x['type'] === 'birthday') {
@@ -165,7 +218,7 @@ function ping_init(&$a) {
                                        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)
                                                        $birthdays_today ++;
@@ -176,8 +229,7 @@ function ping_init(&$a) {
                        }
                }
 
-               $data = array();
-               $data['intro']    = $intro;
+               $data['intro']    = $intro_count;
                $data['mail']     = $mail_count;
                $data['net']      = $network;
                $data['home']     = $home;
@@ -291,12 +343,12 @@ function ping_init(&$a) {
        $sysmsgs = array();
        $sysmsgs_info = array();
 
-       if (x($_SESSION,'sysmsg')) {
+       if (x($_SESSION, 'sysmsg')) {
                $sysmsgs = $_SESSION['sysmsg'];
                unset($_SESSION['sysmsg']);
        }
 
-       if (x($_SESSION,'sysmsg_info')) {
+       if (x($_SESSION, 'sysmsg_info')) {
                $sysmsgs_info = $_SESSION['sysmsg_info'];
                unset($_SESSION['sysmsg_info']);
        }
@@ -338,14 +390,14 @@ function ping_init(&$a) {
  * @param int $uid User id
  * @return array Associative array of notifications
  */
-function ping_get_notifications($uid) {
-
-       $result = array();
-       $offset = 0;
-       $seen = false;
+function ping_get_notifications($uid)
+{
+       $result  = array();
+       $offset  = 0;
+       $seen    = false;
        $seensql = "NOT";
-       $order = "DESC";
-       $quit = false;
+       $order   = "DESC";
+       $quit    = false;
 
        $a = get_app();
 
@@ -420,39 +472,42 @@ function ping_get_notifications($uid) {
  * @param array $notifs Complete list of notification
  * @param array $sysmsgs List of system notice messages
  * @param array $sysmsgs_info List of system info messages
+ * @param int $groups_unseen Number of unseen group items
+ * @param int $forums_unseen Number of unseen forum items
  * @return array XML-transform ready data array
  */
-function ping_format_xml_data($data, $sysnotify, $notifs, $sysmsgs, $sysmsgs_info, $groups_unseen, $forums_unseen) {
+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']
+       foreach($notifs as $key => $notif) {
+               $notifications[$key . ':note'] = $notif['message'];
+
+               $notifications[$key . ':@attributes'] = array(
+                       'id'        => $notif['id'],
+                       'href'      => $notif['href'],
+                       'name'      => $notif['name'],
+                       'url'       => $notif['url'],
+                       'photo'     => $notif['photo'],
+                       'date'      => $notif['date'],
+                       'seen'      => $notif['seen'],
+                       'timestamp' => $notif['timestamp']
                );
        }
 
        $sysmsg = array();
        foreach ($sysmsgs as $key => $m){
-               $sysmsg[$key . ":notice"] = $m;
+               $sysmsg[$key . ':notice'] = $m;
        }
        foreach ($sysmsgs_info as $key => $m){
-               $sysmsg[$key . ":info"] = $m;
+               $sysmsg[$key . ':info'] = $m;
        }
 
-       $data["notif"] = $notifications;
-       $data["@attributes"] = array("count" => $sysnotify + $data["intro"] + $data["mail"] + $data["register"]);
-       $data["sysmsgs"] = $sysmsg;
+       $data['notif'] = $notifications;
+       $data['@attributes'] = array('count' => $sysnotify_count + $data['intro'] + $data['mail'] + $data['register']);
+       $data['sysmsgs'] = $sysmsg;
 
-       if ($data["register"] == 0) {
-               unset($data["register"]);
+       if ($data['register'] == 0) {
+               unset($data['register']);
        }
 
        $groups = array();
@@ -474,4 +529,4 @@ function ping_format_xml_data($data, $sysnotify, $notifs, $sysmsgs, $sysmsgs_inf
        }
 
        return $data;
-}
\ No newline at end of file
+}