[TASK] Update Doxyfile and fix Doxygen errors.

Updated Doxyfile to include new folders.
Add a list for @hooks tags.
Fixed some parsing problems for Doxygen.

1 files changed, 95 insertions, 112 deletions

diff --git a/Zotlabs/Module/Ping.php b/Zotlabs/Module/Ping.php
index b145bd2ed..c385201ce 100644
--- a/Zotlabs/Module/Ping.php
+++ b/Zotlabs/Module/Ping.php
@@ -1,32 +1,27 @@
 <?php
-namespace Zotlabs\Module;
 
-/**
- * @file mod/ping.php
- *
- */
+namespace Zotlabs\Module;
 
 require_once('include/bbcode.php');
 
-
 /**
- * @brief do several updates when pinged.
- *
- * This function does several tasks. Whenever called it checks for new messages,
- * introductions, notifications, etc. and returns a json with the results.
+ * @brief Ping Controller.
  *
- * @param App &$a
- * @result JSON
  */
-
-
 class Ping extends \Zotlabs\Web\Controller {
 
+	/**
+	 * @brief do several updates when pinged.
+	 *
+	 * This function does several tasks. Whenever called it checks for new messages,
+	 * introductions, notifications, etc. and returns a json with the results.
+	 *
+	 * @result JSON
+	 */
 	function init() {
-	
 		$result = array();
 		$notifs = array();
-	
+
 		$result['notify'] = 0;
 		$result['home'] = 0;
 		$result['network'] = 0;
@@ -41,45 +36,45 @@ class Ping extends \Zotlabs\Web\Controller {
 		$result['all_events_today'] = 0;
 		$result['notice'] = array();
 		$result['info'] = array();
-	
+
 		$t0 = dba_timer();
-	
+
 		header("content-type: application/json");
-	
+
 		$vnotify = false;
-	
+
 		$item_normal = item_normal();
-	
-		if(local_channel())  {
+
+		if(local_channel()) {
 			$vnotify = get_pconfig(local_channel(),'system','vnotify');
 			$evdays = intval(get_pconfig(local_channel(),'system','evdays'));
 			$ob_hash = get_observer_hash();
 		}
-	
+
 		// if unset show all visual notification types
 		if($vnotify === false)
 			$vnotify = (-1);
 		if($evdays < 1)
 			$evdays = 3;
-	
+
 		/**
 		 * If you have several windows open to this site and switch to a different channel
-		 * in one of them, the others may get into a confused state showing you a page or options 
+		 * in one of them, the others may get into a confused state showing you a page or options
 		 * on that page which were only valid under the old identity. You session has changed.
 		 * Therefore we send a notification of this fact back to the browser where it is picked up
 		 * in javascript and which reloads the page it is on so that it is valid under the context
-		 * of the now current channel. 
+		 * of the now current channel.
 		 */
-	
+
 		$result['invalid'] = ((intval($_GET['uid'])) && (intval($_GET['uid']) != local_channel()) ? 1 : 0);
-	
+
 		/**
 		 * Send all system messages (alerts) to the browser.
 		 * Some are marked as informational and some represent
 		 * errors or serious notifications. These typically
 		 * will popup on the current page (no matter what page it is)
 		 */
-	
+
 		if(x($_SESSION, 'sysmsg')){
 			foreach ($_SESSION['sysmsg'] as $m){
 				$result['notice'][] = array('message' => $m);
@@ -96,17 +91,16 @@ class Ping extends \Zotlabs\Web\Controller {
 			$result['info'] = array();
 		if(! ($vnotify & VNOTIFY_ALERT))
 			$result['notice'] = array();
-	
-	
+
 		if(\App::$install) {
 			echo json_encode($result);
 			killme();
 		}
-	
+
 		/**
 		 * Update chat presence indication (if applicable)
 		 */
-	
+
 		if(get_observer_hash() && (! $result['invalid'])) {
 			$r = q("select cp_id, cp_room from chatpresence where cp_xchan = '%s' and cp_client = '%s' and cp_room = 0 limit 1",
 				dbesc(get_observer_hash()),
@@ -114,7 +108,7 @@ class Ping extends \Zotlabs\Web\Controller {
 			);
 			$basic_presence = false;
 			if($r) {
-				$basic_presence = true;	
+				$basic_presence = true;
 				q("update chatpresence set cp_last = '%s' where cp_id = %d",
 					dbesc(datetime_convert()),
 					intval($r[0]['cp_id'])
@@ -130,40 +124,39 @@ class Ping extends \Zotlabs\Web\Controller {
 				);
 			}
 		}
-	
+
 		/**
 		 * Chatpresence continued... if somebody hasn't pinged recently, they've most likely left the page
 		 * and shouldn't count as online anymore. We allow an expection for bots.
 		 */
-	
+
 		q("delete from chatpresence where cp_last < %s - INTERVAL %s and cp_client != 'auto' ",
 			db_utcnow(), db_quoteinterval('3 MINUTE')
-		); 
-	
+		);
+
 		if((! local_channel()) || ($result['invalid'])) {
 			echo json_encode($result);
 			killme();
 		}
-	
+
 		/**
 		 * Everything following is only permitted under the context of a locally authenticated site member.
 		 */
-	
-	
+
 		/**
 		 * Handle "mark all xyz notifications read" requests.
 		 */
-	
+
 		// mark all items read
 		if(x($_REQUEST, 'markRead') && local_channel()) {
 			switch($_REQUEST['markRead']) {
 				case 'network':
-					$r = q("update item set item_unseen = 0 where item_unseen = 1 and uid = %d", 
+					$r = q("update item set item_unseen = 0 where item_unseen = 1 and uid = %d",
 						intval(local_channel())
 					);
 					break;
 				case 'home':
-					$r = q("update item set item_unseen = 0 where item_unseen = 1 and item_wall = 1  and uid = %d", 
+					$r = q("update item set item_unseen = 0 where item_unseen = 1 and item_wall = 1  and uid = %d",
 						intval(local_channel())
 					);
 					break;
@@ -188,21 +181,18 @@ class Ping extends \Zotlabs\Web\Controller {
 					break;
 			}
 		}
-	
+
 		if(x($_REQUEST, 'markItemRead') && local_channel()) {
-			$r = q("update item set item_unseen = 0 where parent = %d and uid = %d", 
+			$r = q("update item set item_unseen = 0 where parent = %d and uid = %d",
 				intval($_REQUEST['markItemRead']),
 				intval(local_channel())
 			);
 		}
-	
-	
-	
+
 		/**
 		 * URL ping/something will return detail for "something", e.g. a json list with which to populate a notification
 		 * dropdown menu.
 		 */
-	
 		if(argc() > 1 && argv(1) === 'notify') {
 			$t = q("select count(*) as total from notify where uid = %d and seen = 0",
 				intval(local_channel())
@@ -212,8 +202,7 @@ class Ping extends \Zotlabs\Web\Controller {
 					and seen = 0 order by created desc limit 50",
 					intval(local_channel())
 				);
-			}
-			else {
+			} else {
 				$z1 = q("select * from notify where uid = %d
 					and seen = 0 order by created desc limit 50",
 					intval(local_channel())
@@ -225,62 +214,62 @@ class Ping extends \Zotlabs\Web\Controller {
 				);
 				$z = array_merge($z1,$z2);
 			}
-	
+
 			if(count($z)) {
 				foreach($z as $zz) {
 					$notifs[] = array(
-						'notify_link' => z_root() . '/notify/view/' . $zz['id'], 
+						'notify_link' => z_root() . '/notify/view/' . $zz['id'],
 						'name' => $zz['xname'],
 						'url' => $zz['url'],
 						'photo' => $zz['photo'],
-						'when' => relative_date($zz['created']), 
-						'hclass' => (($zz['seen']) ? 'notify-seen' : 'notify-unseen'), 
+						'when' => relative_date($zz['created']),
+						'hclass' => (($zz['seen']) ? 'notify-seen' : 'notify-unseen'),
 						'message' => strip_tags(bbcode($zz['msg']))
 					);
 				}
 			}
-	
+
 			echo json_encode(array('notify' => $notifs));
 			killme();
 		}
-	
+
 		if(argc() > 1 && argv(1) === 'messages') {
 			$channel = \App::get_channel();
-			$t = q("select mail.*, xchan.* from mail left join xchan on xchan_hash = from_xchan 
-				where channel_id = %d and mail_seen = 0 and mail_deleted = 0 
+			$t = q("select mail.*, xchan.* from mail left join xchan on xchan_hash = from_xchan
+				where channel_id = %d and mail_seen = 0 and mail_deleted = 0
 				and from_xchan != '%s' order by created desc limit 50",
 				intval(local_channel()),
 				dbesc($channel['channel_hash'])
 			);
-	
+
 			if($t) {
 				foreach($t as $zz) {
 					$notifs[] = array(
-						'notify_link' => z_root() . '/mail/' . $zz['id'], 
+						'notify_link' => z_root() . '/mail/' . $zz['id'],
 						'name' => $zz['xchan_name'],
 						'url' => $zz['xchan_url'],
 						'photo' => $zz['xchan_photo_s'],
-						'when' => relative_date($zz['created']), 
-						'hclass' => (intval($zz['mail_seen']) ? 'notify-seen' : 'notify-unseen'), 
+						'when' => relative_date($zz['created']),
+						'hclass' => (intval($zz['mail_seen']) ? 'notify-seen' : 'notify-unseen'),
 						'message' => t('sent you a private message'),
 					);
 				}
 			}
-	
+
 			echo json_encode(array('notify' => $notifs));
 			killme();
 		}
-	
+
 		if(argc() > 1 && (argv(1) === 'network' || argv(1) === 'home')) {
 			$result = array();
-	
+
 			$r = q("SELECT * FROM item
 				WHERE item_unseen = 1 and uid = %d $item_normal
 				and author_xchan != '%s' ORDER BY created DESC limit 300",
 				intval(local_channel()),
 				dbesc($ob_hash)
 			);
-	
+
 			if($r) {
 				xchan_query($r);
 				foreach($r as $item) {
@@ -289,18 +278,18 @@ class Ping extends \Zotlabs\Web\Controller {
 					$result[] = \Zotlabs\Lib\Enotify::format($item);
 				}
 			}
-	//		logger('ping (network||home): ' . print_r($result, true), LOGGER_DATA);
+//			logger('ping (network||home): ' . print_r($result, true), LOGGER_DATA);
 			echo json_encode(array('notify' => $result));
 			killme();
 		}
-	
+
 		if(argc() > 1 && (argv(1) === 'intros')) {
 			$result = array();
-	
+
 			$r = q("SELECT * FROM abook left join xchan on abook.abook_xchan = xchan.xchan_hash where abook_channel = %d and abook_pending = 1 and abook_self = 0 and abook_ignored = 0 and xchan_deleted = 0 and xchan_orphan = 0 ORDER BY abook_created DESC LIMIT 50",
 				intval(local_channel())
 			);
-	
+
 			if($r) {
 				foreach($r as $rr) {
 					$result[] = array(
@@ -308,8 +297,8 @@ class Ping extends \Zotlabs\Web\Controller {
 						'name' => $rr['xchan_name'],
 						'url' => $rr['xchan_url'],
 						'photo' => $rr['xchan_photo_s'],
-						'when' => relative_date($rr['abook_created']), 
-						'hclass' => ('notify-unseen'), 
+						'when' => relative_date($rr['abook_created']),
+						'hclass' => ('notify-unseen'),
 						'message' => t('added your channel')
 					);
 				}
@@ -318,12 +307,12 @@ class Ping extends \Zotlabs\Web\Controller {
 			echo json_encode(array('notify' => $result));
 			killme();
 		}
-	
+
 		if(argc() > 1 && (argv(1) === 'all_events')) {
 			$bd_format = t('g A l F d') ; // 8 AM Friday January 18
-	
+
 			$result = array();
-	
+
 			$r = q("SELECT * FROM event left join xchan on event_xchan = xchan_hash
 				WHERE event.uid = %d AND dtstart < '%s' AND dtstart > '%s' and dismissed = 0
 				and etype in ( 'event', 'birthday' )
@@ -332,26 +321,25 @@ class Ping extends \Zotlabs\Web\Controller {
 				dbesc(datetime_convert('UTC', date_default_timezone_get(), 'now + ' . intval($evdays) . ' days')),
 				dbesc(datetime_convert('UTC', date_default_timezone_get(), 'now - 1 days'))
 			);
-	
+
 			if($r) {
 				foreach($r as $rr) {
 					if($rr['adjust'])
 						$md = datetime_convert('UTC', date_default_timezone_get(), $rr['dtstart'], 'Y/m');
 					else
 						$md = datetime_convert('UTC', 'UTC', $rr['dtstart'], 'Y/m');
-	
+
 					$strt = datetime_convert('UTC', (($rr['adjust']) ? date_default_timezone_get() : 'UTC'), $rr['dtstart']);
 					$today = ((substr($strt, 0, 10) === datetime_convert('UTC', date_default_timezone_get(), 'now', 'Y-m-d')) ? true : false);
-					
 					$when = day_translate(datetime_convert('UTC', (($rr['adjust']) ? date_default_timezone_get() : 'UTC'), $rr['dtstart'], $bd_format)) . (($today) ?  ' ' . t('[today]') : '');
-	
+
 					$result[] = array(
-						'notify_link' => z_root() . '/events', // FIXME this takes you to an edit page and it may not be yours, we really want to just view the single event  --> '/events/event/' . $rr['event_hash'],
+						'notify_link' => z_root() . '/events', /// @FIXME this takes you to an edit page and it may not be yours, we really want to just view the single event  --> '/events/event/' . $rr['event_hash'],
 						'name'        => $rr['xchan_name'],
 						'url'         => $rr['xchan_url'],
 						'photo'       => $rr['xchan_photo_s'],
 						'when'        => $when,
-						'hclass'       => ('notify-unseen'), 
+						'hclass'       => ('notify-unseen'),
 						'message'     => t('posted an event')
 					);
 				}
@@ -360,13 +348,10 @@ class Ping extends \Zotlabs\Web\Controller {
 			echo json_encode(array('notify' => $result));
 			killme();
 		}
-	
-	
-	
+
 		/**
 		 * Normal ping - just the counts, no detail
 		 */
-	
 		if($vnotify & VNOTIFY_SYSTEM) {
 			$t = q("select count(*) as total from notify where uid = %d and seen = 0",
 				intval(local_channel())
@@ -374,9 +359,9 @@ class Ping extends \Zotlabs\Web\Controller {
 			if($t)
 				$result['notify'] = intval($t[0]['total']);
 		}
-	
+
 		$t1 = dba_timer();
-	
+
 		if($vnotify & (VNOTIFY_NETWORK|VNOTIFY_CHANNEL)) {
 			$r = q("SELECT id, item_wall FROM item
 				WHERE item_unseen = 1 and uid = %d
@@ -385,11 +370,11 @@ class Ping extends \Zotlabs\Web\Controller {
 				intval(local_channel()),
 				dbesc($ob_hash)
 			);
-	
-			if($r) {	
+
+			if($r) {
 				$arr = array('items' => $r);
 				call_hooks('network_ping', $arr);
-		
+
 				foreach ($r as $it) {
 					if(intval($it['item_wall']))
 						$result['home'] ++;
@@ -402,24 +387,23 @@ class Ping extends \Zotlabs\Web\Controller {
 			$result['network'] = 0;
 		if(! ($vnotify & VNOTIFY_CHANNEL))
 			$result['home'] = 0;
-	
-	
+
 		$t2 = dba_timer();
-	
+
 		if($vnotify & VNOTIFY_INTRO) {
 			$intr = q("SELECT COUNT(abook.abook_id) AS total FROM abook left join xchan on abook.abook_xchan = xchan.xchan_hash where abook_channel = %d and abook_pending = 1 and abook_self = 0 and abook_ignored = 0 and xchan_deleted = 0 and xchan_orphan = 0 ",
 				intval(local_channel())
 			);
-	
+
 			$t3 = dba_timer();
-	
+
 			if($intr)
 				$result['intros'] = intval($intr[0]['total']);
 		}
-	
+
 		$t4 = dba_timer();
 		$channel = \App::get_channel();
-	
+
 		if($vnotify & VNOTIFY_MAIL) {
 			$mails = q("SELECT count(id) as total from mail
 				WHERE channel_id = %d AND mail_seen = 0 and from_xchan != '%s' ",
@@ -429,7 +413,7 @@ class Ping extends \Zotlabs\Web\Controller {
 			if($mails)
 				$result['mail'] = intval($mails[0]['total']);
 		}
-		
+
 		if($vnotify & VNOTIFY_REGISTER) {
 			if (\App::$config['system']['register_policy'] == REGISTER_APPROVE && is_site_admin()) {
 				$regs = q("SELECT count(account_id) as total from account where (account_flags & %d) > 0",
@@ -438,10 +422,10 @@ class Ping extends \Zotlabs\Web\Controller {
 				if($regs)
 					$result['register'] = intval($regs[0]['total']);
 			}
-		} 
-	
+		}
+
 		$t5 = dba_timer();
-	
+
 		if($vnotify & (VNOTIFY_EVENT|VNOTIFY_EVENTTODAY|VNOTIFY_BIRTHDAY)) {
 			$events = q("SELECT etype, dtstart, adjust FROM event
 				WHERE event.uid = %d AND dtstart < '%s' AND dtstart > '%s' and dismissed = 0
@@ -451,10 +435,10 @@ class Ping extends \Zotlabs\Web\Controller {
 					dbesc(datetime_convert('UTC', date_default_timezone_get(), 'now + ' . intval($evdays) . ' days')),
 					dbesc(datetime_convert('UTC', date_default_timezone_get(), 'now - 1 days'))
 			);
-	
+
 			if($events) {
 				$result['all_events'] = count($events);
-	
+
 				if($result['all_events']) {
 					$str_now = datetime_convert('UTC', date_default_timezone_get(), 'now', 'Y-m-d');
 					foreach($events as $x) {
@@ -483,16 +467,15 @@ class Ping extends \Zotlabs\Web\Controller {
 			$result['all_events_today'] = $result['events_today'] = 0;
 		if(! ($vnotify & VNOTIFY_BIRTHDAY))
 			$result['birthdays'] = 0;
-	
-	
+
 		$x = json_encode($result);
-		
+
 		$t6 = dba_timer();
-	
-	//	logger('ping timer: ' . sprintf('%01.4f %01.4f %01.4f %01.4f %01.4f %01.4f',$t6 - $t5, $t5 - $t4, $t4 - $t3, $t3 - $t2, $t2 - $t1, $t1 - $t0));
-	
+
+//		logger('ping timer: ' . sprintf('%01.4f %01.4f %01.4f %01.4f %01.4f %01.4f',$t6 - $t5, $t5 - $t4, $t4 - $t3, $t3 - $t2, $t2 - $t1, $t1 - $t0));
+
 		echo $x;
 		killme();
 	}
-	
+
 }