clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ping.php: Ensure data structure consistency 

- Formatting
- Documentation
This commit is contained in:
Hypolite Petovan 2016-11-22 21:11:22 -05:00
parent 61afd71897
commit 58e03c5155
1 changed files with 131 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

207
mod/ping.php
View File

@ -6,15 +6,89 @@ require_once('include/group.php');
require_once('mod/proxy.php'); require_once('mod/proxy.php');
require_once('include/xml.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'; $format = 'xml';
if (isset($_GET['format']) && $_GET['format'] == 'json') { if (isset($_GET['format']) && $_GET['format'] == 'json') {
$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. // Different login session than the page that is calling us.
if (intval($_GET['uid']) && intval($_GET['uid']) != local_user()) { if (intval($_GET['uid']) && intval($_GET['uid']) != local_user()) {
@ -37,26 +111,11 @@ function ping_init(&$a) {
} }
$notifs = ping_get_notifications(local_user()); $notifs = ping_get_notifications(local_user());
$sysnotify = 0; // we will update this in a moment
$tags = array(); $items_unseen = q("SELECT `item`.`id`, `item`.`parent`, `item`.`verb`, `item`.`wall`, `item`.`author-name`,
$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`,
`item`.`contact-id`, `item`.`author-link`, `item`.`author-avatar`, `item`.`created`, `item`.`object`, `item`.`contact-id`, `item`.`author-link`, `item`.`author-avatar`, `item`.`created`, `item`.`object`,
`pitem`.`author-name` as `pname`, `pitem`.`author-link` as `plink` `pitem`.`author-name` AS `pname`, `pitem`.`author-link` AS `plink`
FROM `item` INNER JOIN `item` as `pitem` ON `pitem`.`id`=`item`.`parent` FROM `item` INNER JOIN `item` AS `pitem` ON `pitem`.`id` = `item`.`parent`
WHERE `item`.`unseen` = 1 AND `item`.`visible` = 1 AND WHERE `item`.`unseen` = 1 AND `item`.`visible` = 1 AND
`item`.`deleted` = 0 AND `item`.`uid` = %d AND `pitem`.`parent` != 0 `item`.`deleted` = 0 AND `item`.`uid` = %d AND `pitem`.`parent` != 0
AND `item`.`contact-id` != %d AND `item`.`contact-id` != %d
@ -64,22 +123,21 @@ function ping_init(&$a) {
intval(local_user()), intval(local_user()) intval(local_user()), intval(local_user())
); );
if (dbm::is_result($r)) { if (dbm::is_result($items_unseen)) {
$arr = array('items' => $items_unseen);
$arr = array('items' => $r);
call_hooks('network_ping', $arr); call_hooks('network_ping', $arr);
foreach ($r as $it) { foreach ($items_unseen as $item) {
if ($it['wall']) { if ($item['wall']) {
$home++; $home_count++;
} else { } else {
$network++; $network++;
} }
} }
} }
if ($network) { if ($network_count) {
if (intval(feature_enabled(local_user(),'groups'))) { if (intval(feature_enabled(local_user(), 'groups'))) {
// Find out how unseen network posts are spread across groups // Find out how unseen network posts are spread across groups
$group_counts = groups_count_unseen(); $group_counts = groups_count_unseen();
if (dbm::is_result($group_counts)) { 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(); $forum_counts = ForumManager::count_unseen_items();
if (dbm::is_result($forums_counts)) { if (dbm::is_result($forums_counts)) {
foreach ($forums_counts as $forum_count) { foreach ($forums_counts as $forum_count) {
@ -106,13 +164,13 @@ function ping_init(&$a) {
$intros1 = q("SELECT `intro`.`id`, `intro`.`datetime`, $intros1 = q("SELECT `intro`.`id`, `intro`.`datetime`,
`fcontact`.`name`, `fcontact`.`url`, `fcontact`.`photo` `fcontact`.`name`, `fcontact`.`url`, `fcontact`.`photo`
FROM `intro` LEFT JOIN `fcontact` ON `intro`.`fid` = `fcontact`.`id` 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()) intval(local_user())
); );
$intros2 = q("SELECT `intro`.`id`, `intro`.`datetime`, $intros2 = q("SELECT `intro`.`id`, `intro`.`datetime`,
`contact`.`name`, `contact`.`url`, `contact`.`photo` `contact`.`name`, `contact`.`url`, `contact`.`photo`
FROM `intro` LEFT JOIN `contact` ON `intro`.`contact-id` = `contact`.`id` 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()) intval(local_user())
); );
@ -128,7 +186,9 @@ function ping_init(&$a) {
$mail_count = count($mails); $mail_count = count($mails);
if ($a->config['register_policy'] == REGISTER_APPROVE && is_site_admin()){ 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) { if ($regs) {
$register = $regs[0]['total']; $register = $regs[0]['total'];
} }
@ -136,26 +196,19 @@ function ping_init(&$a) {
$register = 0; $register = 0;
} }
$all_events = 0; $ev = q("SELECT count(`event`.`id`) AS total, type, start, adjust FROM `event`
$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`
WHERE `event`.`uid` = %d AND `start` < '%s' AND `finish` > '%s' and `ignore` = 0 WHERE `event`.`uid` = %d AND `start` < '%s' AND `finish` > '%s' and `ignore` = 0
ORDER BY `start` ASC ", ORDER BY `start` ASC ",
intval(local_user()), intval(local_user()),
dbesc(datetime_convert('UTC','UTC','now + 7 days')), dbesc(datetime_convert('UTC', 'UTC', 'now + 7 days')),
dbesc(datetime_convert('UTC','UTC','now')) dbesc(datetime_convert('UTC', 'UTC', 'now'))
); );
if (dbm::is_result($ev)) { if (dbm::is_result($ev)) {
$all_events = intval($ev[0]['total']); $all_events = intval($ev[0]['total']);
if ($all_events) { 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) { foreach($ev as $x) {
$bd = false; $bd = false;
if ($x['type'] === 'birthday') { if ($x['type'] === 'birthday') {
@ -165,7 +218,7 @@ function ping_init(&$a) {
else { else {
$events ++; $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 ++; $all_events_today ++;
if ($bd) if ($bd)
$birthdays_today ++; $birthdays_today ++;
@ -176,8 +229,7 @@ function ping_init(&$a) {
} }
} }
$data = array(); $data['intro'] = $intro_count;
$data['intro'] = $intro;
$data['mail'] = $mail_count; $data['mail'] = $mail_count;
$data['net'] = $network; $data['net'] = $network;
$data['home'] = $home; $data['home'] = $home;
@ -291,12 +343,12 @@ function ping_init(&$a) {
$sysmsgs = array(); $sysmsgs = array();
$sysmsgs_info = array(); $sysmsgs_info = array();
if (x($_SESSION,'sysmsg')) { if (x($_SESSION, 'sysmsg')) {
$sysmsgs = $_SESSION['sysmsg']; $sysmsgs = $_SESSION['sysmsg'];
unset($_SESSION['sysmsg']); unset($_SESSION['sysmsg']);
} }
if (x($_SESSION,'sysmsg_info')) { if (x($_SESSION, 'sysmsg_info')) {
$sysmsgs_info = $_SESSION['sysmsg_info']; $sysmsgs_info = $_SESSION['sysmsg_info'];
unset($_SESSION['sysmsg_info']); unset($_SESSION['sysmsg_info']);
} }
@ -338,14 +390,14 @@ function ping_init(&$a) {
* @param int $uid User id * @param int $uid User id
* @return array Associative array of notifications * @return array Associative array of notifications
*/ */
function ping_get_notifications($uid) { function ping_get_notifications($uid)
{
$result = array(); $result = array();
$offset = 0; $offset = 0;
$seen = false; $seen = false;
$seensql = "NOT"; $seensql = "NOT";
$order = "DESC"; $order = "DESC";
$quit = false; $quit = false;
$a = get_app(); $a = get_app();
@ -420,39 +472,42 @@ function ping_get_notifications($uid) {
* @param array $notifs Complete list of notification * @param array $notifs Complete list of notification
* @param array $sysmsgs List of system notice messages * @param array $sysmsgs List of system notice messages
* @param array $sysmsgs_info List of system info 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 * @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(); $notifications = array();
foreach($notifs as $key => $n) { foreach($notifs as $key => $notif) {
$notifications[$key . ":note"] = $n['message']; $notifications[$key . ':note'] = $notif['message'];
$notifications[$key . ":@attributes"] = array( $notifications[$key . ':@attributes'] = array(
"id" => $n["id"], 'id' => $notif['id'],
"href" => $n['href'], 'href' => $notif['href'],
"name" => $n['name'], 'name' => $notif['name'],
"url" => $n['url'], 'url' => $notif['url'],
"photo" => $n['photo'], 'photo' => $notif['photo'],
"date" => $n['date'], 'date' => $notif['date'],
"seen" => $n['seen'], 'seen' => $notif['seen'],
"timestamp" => $n['timestamp'] 'timestamp' => $notif['timestamp']
); );
} }
$sysmsg = array(); $sysmsg = array();
foreach ($sysmsgs as $key => $m){ foreach ($sysmsgs as $key => $m){
$sysmsg[$key . ":notice"] = $m; $sysmsg[$key . ':notice'] = $m;
} }
foreach ($sysmsgs_info as $key => $m){ foreach ($sysmsgs_info as $key => $m){
$sysmsg[$key . ":info"] = $m; $sysmsg[$key . ':info'] = $m;
} }
$data["notif"] = $notifications; $data['notif'] = $notifications;
$data["@attributes"] = array("count" => $sysnotify + $data["intro"] + $data["mail"] + $data["register"]); $data['@attributes'] = array('count' => $sysnotify_count + $data['intro'] + $data['mail'] + $data['register']);
$data["sysmsgs"] = $sysmsg; $data['sysmsgs'] = $sysmsg;
if ($data["register"] == 0) { if ($data['register'] == 0) {
unset($data["register"]); unset($data['register']);
} }
$groups = array(); $groups = array();
@ -474,4 +529,4 @@ function ping_format_xml_data($data, $sysnotify, $notifs, $sysmsgs, $sysmsgs_inf
} }
return $data; return $data;
} }