Merge pull request #311 from dawnbreak/docu

Some documentation and whitespaces at line endings.

1 files changed, 325 insertions, 223 deletions

diff --git a/include/zot.php b/include/zot.php
index 28a2e8957..3c7413b5c 100644
--- a/include/zot.php
+++ b/include/zot.php
@@ -32,6 +32,7 @@ require_once('include/hubloc.php');
  */
 function zot_new_uid($channel_nick) {
 	$rawstr = z_root() . '/' . $channel_nick . '.' . mt_rand();
+
 	return(base64url_encode(hash('whirlpool', $rawstr, true), true));
 }
 
@@ -40,8 +41,9 @@ function zot_new_uid($channel_nick) {
  *
  * Generates a portable hash identifier for the channel identified by $guid and
  * signed with $guid_sig.
- * This ID is portable across the network but MUST be calculated locally by
- * verifying the signature and can not be trusted as an identity.
+ *
+ * @note This ID is portable across the network but MUST be calculated locally
+ * by verifying the signature and can not be trusted as an identity.
  *
  * @param string $guid
  * @param string $guid_sig
@@ -116,7 +118,7 @@ function zot_build_packet($channel, $type = 'notify', $recipients = null, $remot
 			'guid_sig' => base64url_encode(rsa_sign($channel['channel_guid'],$channel['channel_prvkey'])),
 			'url' => z_root(),
 			'url_sig' => base64url_encode(rsa_sign(z_root(),$channel['channel_prvkey']))
-		), 
+		),
 		'callback' => '/post',
 		'version' => ZOT_REVISION
 	);
@@ -124,11 +126,12 @@ function zot_build_packet($channel, $type = 'notify', $recipients = null, $remot
 	if ($recipients) {
 		for ($x = 0; $x < count($recipients); $x ++)
 			unset($recipients[$x]['hash']);
+
 		$data['recipients'] = $recipients;
 	}
 
 	if ($secret) {
-		$data['secret'] = $secret; 
+		$data['secret'] = $secret;
 		$data['secret_sig'] = base64url_encode(rsa_sign($secret,$channel['channel_prvkey']));
 	}
 
@@ -195,7 +198,7 @@ function zot_finger($webbie, $channel = null, $autofallback = true) {
 	// The webbie we were called with may not, so it might not be found
 	// unless we query for hubloc_addr instead of xchan_addr
 
-	$r = q("select xchan.*, hubloc.* from xchan 
+	$r = q("select xchan.*, hubloc.* from xchan
 			left join hubloc on xchan_hash = hubloc_hash
 			where xchan_addr = '%s' and (hubloc_flags & %d) > 0 limit 1",
 		dbesc($xchan_addr),
@@ -257,19 +260,19 @@ function zot_finger($webbie, $channel = null, $autofallback = true) {
  * @brief Refreshes after permission changed or friending, etc.
  *
  * zot_refresh is typically invoked when somebody has changed permissions of a channel and they are notified
- * to fetch new permissions via a finger/discovery operation. This may result in a new connection 
- * (abook entry) being added to a local channel and it may result in auto-permissions being granted. 
+ * to fetch new permissions via a finger/discovery operation. This may result in a new connection
+ * (abook entry) being added to a local channel and it may result in auto-permissions being granted.
  *
  * Friending in zot is accomplished by sending a refresh packet to a specific channel which indicates a
  * permission change has been made by the sender which affects the target channel. The hub controlling
  * the target channel does targetted discovery (a zot-finger request requesting permissions for the local
  * channel). These are decoded here, and if necessary and abook structure (addressbook) is created to store
- * the permissions assigned to this channel. 
+ * the permissions assigned to this channel.
  *
- * Initially these abook structures are created with a 'pending' flag, so that no reverse permissions are 
- * implied until this is approved by the owner channel. A channel can also auto-populate permissions in 
+ * Initially these abook structures are created with a 'pending' flag, so that no reverse permissions are
+ * implied until this is approved by the owner channel. A channel can also auto-populate permissions in
  * return and send back a refresh packet of its own. This is used by forum and group communication channels
- * so that friending and membership in the channel's "club" is automatic. 
+ * so that friending and membership in the channel's "club" is automatic.
  *
  * @param array $them => xchan structure of sender
  * @param array $channel => local channel structure of target recipient, required for "friending" operations
@@ -376,7 +379,7 @@ function zot_refresh($them, $channel = null, $force = false) {
 					if($k === 'connected') {
 						$connected_set = intval($v);
 						continue;
-					}	
+					}
 					if(($v) && (array_key_exists($k,$global_perms))) {
 						$their_perms = $their_perms | intval($global_perms[$k][1]);
 					}
@@ -389,7 +392,7 @@ function zot_refresh($them, $channel = null, $force = false) {
 				intval(ABOOK_FLAG_SELF)
 			);
 
-			if(array_key_exists('profile',$j) && array_key_exists('next_birthday',$j['profile'])) {	
+			if(array_key_exists('profile',$j) && array_key_exists('next_birthday',$j['profile'])) {
 				$next_birthday = datetime_convert('UTC','UTC',$j['profile']['next_birthday']);
 			}
 			else {
@@ -398,9 +401,9 @@ function zot_refresh($them, $channel = null, $force = false) {
 
 			if($r) {
 
-				// if the dob is the same as what we have stored (disregarding the year), keep the one 
+				// if the dob is the same as what we have stored (disregarding the year), keep the one
 				// we have as we may have updated the year after sending a notification; and resetting
-				// to the one we just received would cause us to create duplicated events. 
+				// to the one we just received would cause us to create duplicated events.
 
 				if(substr($r[0]['abook_dob'],5) == substr($next_birthday,5))
 					$next_birthday = $r[0]['abook_dob'];
@@ -408,7 +411,7 @@ function zot_refresh($them, $channel = null, $force = false) {
 				$current_abook_connected = (($r[0]['abook_flags'] & ABOOK_FLAG_UNCONNECTED) ? 0 : 1);
 
 				$y = q("update abook set abook_their_perms = %d, abook_dob = '%s'
-					where abook_xchan = '%s' and abook_channel = %d 
+					where abook_xchan = '%s' and abook_channel = %d
 					and not (abook_flags & %d) > 0 ",
 					intval($their_perms),
 					dbescdate($next_birthday),
@@ -420,11 +423,11 @@ function zot_refresh($them, $channel = null, $force = false) {
 //				if(($connected_set === 0 || $connected_set === 1) && ($connected_set !== $current_abook_unconnected)) {
 
 					// if they are in your address book but you aren't in theirs, and/or this does not
-					// match your current connected state setting, toggle it. 
+					// match your current connected state setting, toggle it.
 					/** @FIXME uncoverted to postgres */
 					/** @FIXME when this was enabled, all contacts became unconnected. Currently disabled intentionally */
 //					$y1 = q("update abook set abook_flags = (abook_flags ^ %d)
-//						where abook_xchan = '%s' and abook_channel = %d 
+//						where abook_xchan = '%s' and abook_channel = %d
 //						and not (abook_flags & %d) limit 1",
 //						intval(ABOOK_FLAG_UNCONNECTED),
 //						dbesc($x['hash']),
@@ -438,7 +441,7 @@ function zot_refresh($them, $channel = null, $force = false) {
 				else {
 					// if we were just granted read stream permission and didn't have it before, try to pull in some posts
 					if((! ($r[0]['abook_their_perms'] & PERMS_R_STREAM)) && ($their_perms & PERMS_R_STREAM))
-						proc_run('php','include/onepoll.php',$r[0]['abook_id']); 
+						proc_run('php','include/onepoll.php',$r[0]['abook_id']);
 				}
 			}
 			else {
@@ -450,7 +453,7 @@ function zot_refresh($them, $channel = null, $force = false) {
 				}
 				if(! $default_perms)
 					$default_perms = intval(get_pconfig($channel['channel_id'],'system','autoperms'));
-				
+
 
 				// Keep original perms to check if we need to notify them
 				$previous_perms = get_all_perms($channel['channel_id'],$x['hash']);
@@ -493,23 +496,24 @@ function zot_refresh($them, $channel = null, $force = false) {
 					if($new_connection) {
 						require_once('include/enotify.php');
 						notification(array(
-							'type'         => NOTIFY_INTRO,
-							'from_xchan'   => $x['hash'],
-							'to_xchan'     => $channel['channel_hash'],
-							'link'         => z_root() . '/connedit/' . $new_connection[0]['abook_id'],
+							'type'       => NOTIFY_INTRO,
+							'from_xchan' => $x['hash'],
+							'to_xchan'   => $channel['channel_hash'],
+							'link'       => z_root() . '/connedit/' . $new_connection[0]['abook_id'],
 						));
 					}
 
 					if($new_connection && ($their_perms & PERMS_R_STREAM)) {
 						if(($channel['channel_w_stream'] & PERMS_PENDING)
 							|| (! ($new_connection[0]['abook_flags'] & ABOOK_FLAG_PENDING)) )
-							proc_run('php','include/onepoll.php',$new_connection[0]['abook_id']); 
+							proc_run('php','include/onepoll.php',$new_connection[0]['abook_id']);
 					}
 				}
 			}
 		}
 		return true;
 	}
+
 	return false;
 }
 
@@ -521,7 +525,7 @@ function zot_refresh($them, $channel = null, $force = false) {
  * This function looks these up to see if the channel is known and therefore
  * previously verified. If not, we will need to verify it.
  *
- * @param array $arr an assoziative array which must contain:
+ * @param array $arr an associative array which must contain:
  *  * \e string \b guid => guid of conversant
  *  * \e string \b guid_sig => guid signed with conversant's private key
  *  * \e string \b url => URL of the origination hub of this communication
@@ -549,8 +553,8 @@ function zot_gethub($arr) {
 			return null;
 		}
 
-		$r = q("select * from hubloc 
-				where hubloc_guid = '%s' and hubloc_guid_sig = '%s' 
+		$r = q("select * from hubloc
+				where hubloc_guid = '%s' and hubloc_guid_sig = '%s'
 				and hubloc_url = '%s' and hubloc_url_sig = '%s'
 				limit 1",
 			dbesc($arr['guid']),
@@ -564,24 +568,25 @@ function zot_gethub($arr) {
 		}
 	}
 	logger('zot_gethub: not found: ' . print_r($arr,true), LOGGER_DEBUG);
+
 	return null;
 }
 
 /**
  * @brief Registers an unknown hup.
  *
- * A communication has been received which has an unknown (to us) sender. 
+ * A communication has been received which has an unknown (to us) sender.
  * Perform discovery based on our calculated hash of the sender at the
  * origination address. This will fetch the discovery packet of the sender,
  * which contains the public key we need to verify our guid and url signatures.
  *
- * @param array $arr an assoziative array which must contain:
+ * @param array $arr an associative array which must contain:
  *  * \e string \b guid => guid of conversant
  *  * \e string \b guid_sig => guid signed with conversant's private key
  *  * \e string \b url => URL of the origination hub of this communication
  *  * \e string \b url_sig => URL signed with conversant's private key
  *
- * @returns array an assoziative array with:
+ * @returns array an associative array with
  *  * \b success boolean true or false
  *  * \b message (optional) error string only if success is false
  */
@@ -604,8 +609,8 @@ function zot_register_hub($arr) {
 		if($x['success']) {
 			$record = json_decode($x['body'],true);
 
-			/* 
-			 * We now have a key - only continue registration if our signatures are valid 
+			/*
+			 * We now have a key - only continue registration if our signatures are valid
 			 * AND the guid and guid sig in the returned packet match those provided in
 			 * our current communication.
 			 */
@@ -621,7 +626,7 @@ function zot_register_hub($arr) {
 			}
 			else {
 				logger('zot_register_hub: failure to verify returned packet.');
-			}			
+			}
 		}
 	}
 
@@ -639,7 +644,7 @@ function zot_register_hub($arr) {
  *      this typically occurs once a month for each channel as part of a scheduled ping to notify the directory
  *      that the channel still exists
  * @param array $ud_arr
- *    If set [typically by update_directory_entry()] indicates a specific update table row and more particularly 
+ *    If set [typically by update_directory_entry()] indicates a specific update table row and more particularly
  *    contains a particular address (ud_addr) which needs to be updated in that table.
  *
  * @return associative array
@@ -651,7 +656,7 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 	call_hooks('import_xchan', $arr);
 
 	$ret = array('success' => false);
-	$dirmode = intval(get_config('system','directory_mode')); 
+	$dirmode = intval(get_config('system','directory_mode'));
 
 	$changed = false;
 	$what = '';
@@ -697,7 +702,7 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 		// if we import an entry from a site that's not ours and either or both of us is off the grid - hide the entry.
 		/** @TODO: check if we're the same directory realm, which would mean we are allowed to see it */
 
-		$dirmode = get_config('system','directory_mode'); 
+		$dirmode = get_config('system','directory_mode');
 
 		if((($arr['site']['directory_mode'] === 'standalone') || ($dirmode & DIRECTORY_MODE_STANDALONE)) && ($arr['site']['url'] != z_root()))
 			$arr['searchable'] = false;
@@ -725,14 +730,14 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 		if($pubforum_changed)
 			$new_flags = $r[0]['xchan_flags'] ^ XCHAN_FLAGS_PUBFORUM;
 
-		if(($r[0]['xchan_name_date'] != $arr['name_updated']) 
-			|| ($r[0]['xchan_connurl'] != $arr['connections_url']) 
+		if(($r[0]['xchan_name_date'] != $arr['name_updated'])
+			|| ($r[0]['xchan_connurl'] != $arr['connections_url'])
 			|| ($r[0]['xchan_flags'] != $new_flags)
 			|| ($r[0]['xchan_addr'] != $arr['address'])
 			|| ($r[0]['xchan_follow'] != $arr['follow_url'])
-			|| ($r[0]['xchan_connpage'] != $arr['connect_url']) 
+			|| ($r[0]['xchan_connpage'] != $arr['connect_url'])
 			|| ($r[0]['xchan_url'] != $arr['url'])) {
-			$r = q("update xchan set xchan_name = '%s', xchan_name_date = '%s', xchan_connurl = '%s', xchan_follow = '%s', 
+			$r = q("update xchan set xchan_name = '%s', xchan_name_date = '%s', xchan_connurl = '%s', xchan_follow = '%s',
 				xchan_connpage = '%s', xchan_flags = %d,
 				xchan_addr = '%s', xchan_url = '%s' where xchan_hash = '%s'",
 				dbesc(($arr['name']) ? $arr['name'] : '-'),
@@ -754,8 +759,9 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 	} else {
 		$import_photos = true;
 
-		if((($arr['site']['directory_mode'] === 'standalone') || ($dirmode & DIRECTORY_MODE_STANDALONE))
-&& ($arr['site']['url'] != z_root()))
+		if((($arr['site']['directory_mode'] === 'standalone')
+				|| ($dirmode & DIRECTORY_MODE_STANDALONE))
+				&& ($arr['site']['url'] != z_root()))
 			$arr['searchable'] = false;
 
 		$hidden = (1 - intval($arr['searchable']));
@@ -822,7 +828,7 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 		if ($photos) {
 			if ($photos[4]) {
 				// importing the photo failed somehow. Leave the photo_date alone so we can try again at a later date.
-				// This often happens when somebody joins the matrix with a bad cert. 
+				// This often happens when somebody joins the matrix with a bad cert.
 				$r = q("update xchan set xchan_photo_l = '%s', xchan_photo_m = '%s', xchan_photo_s = '%s', xchan_photo_mimetype = '%s'
 					where xchan_hash = '%s'",
 					dbesc($photos[0]),
@@ -847,7 +853,7 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 		}
 	}
 
-	// what we are missing for true hub independence is for any changes in the primary hub to 
+	// what we are missing for true hub independence is for any changes in the primary hub to
 	// get reflected not only in the hublocs, but also to update the URLs and addr in the appropriate xchan
 
 	$s = sync_locations($arr, $arr);
@@ -870,19 +876,18 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 
 	$other_realm = false;
 	$realm = get_directory_realm();
-	if(array_key_exists('site',$arr) 
-		&& array_key_exists('realm',$arr['site']) 
+	if(array_key_exists('site',$arr)
+		&& array_key_exists('realm',$arr['site'])
 		&& (strpos($arr['site']['realm'],$realm) === false))
 		$other_realm = true;
 
 	if($dirmode != DIRECTORY_MODE_NORMAL) {
 
 		// We're some kind of directory server. However we can only add directory information
-		// if the entry is in the same realm (or is a sub-realm). Sub-realms are denoted by 
-		// including the parent realm in the name. e.g. 'RED_GLOBAL:foo' would allow an entry to 
+		// if the entry is in the same realm (or is a sub-realm). Sub-realms are denoted by
+		// including the parent realm in the name. e.g. 'RED_GLOBAL:foo' would allow an entry to
 		// be in directories for the local realm (foo) and also the RED_GLOBAL realm.
 
-
 		if(array_key_exists('profile',$arr) && is_array($arr['profile']) && (! $other_realm)) {
 			$profile_changed = import_directory_profile($xchan_hash,$arr['profile'],$address,$ud_flags, 1);
 			if($profile_changed) {
@@ -910,7 +915,7 @@ function import_xchan($arr,$ud_flags = UPDATE_FLAGS_UPDATED, $ud_arr = null) {
 	}
 
 	if(($changed) || ($ud_flags == UPDATE_FLAGS_FORCED)) {
-		$guid = random_string() . '@' . get_app()->get_hostname();		
+		$guid = random_string() . '@' . get_app()->get_hostname();
 		update_modtime($xchan_hash,$guid,$address,$ud_flags);
 		logger('import_xchan: changed: ' . $what,LOGGER_DEBUG);
 	}
@@ -987,7 +992,7 @@ function zot_process_response($hub, $arr, $outq) {
  *
  * We received a notification packet (in mod/post.php) that a message is waiting for us, and we've verified the sender.
  * Now send back a pickup message, using our message tracking ID ($arr['secret']), which we will sign with our site private key.
- * The entire pickup message is encrypted with the remote site's public key. 
+ * The entire pickup message is encrypted with the remote site's public key.
  * If everything checks out on the remote end, we will receive back a packet containing one or more messages,
  * which will be processed and delivered before this function ultimately returns.
  *
@@ -1028,8 +1033,8 @@ function zot_fetch($arr) {
 
 /**
  * @brief Process incoming array of messages.
- * 
- * Process an incoming array of messages which were obtained via pickup, and 
+ *
+ * Process an incoming array of messages which were obtained via pickup, and
  * import, update, delete as directed.
  *
  * The message types handled here are 'activity' (e.g. posts), 'mail' ,
@@ -1051,14 +1056,14 @@ function zot_fetch($arr) {
  */
 function zot_import($arr, $sender_url) {
 
-	$data = json_decode($arr['body'],true);
+	$data = json_decode($arr['body'], true);
 
 	if(! $data) {
 		logger('zot_import: empty body');
 		return array();
 	}
 
-	if(array_key_exists('iv',$data)) {
+	if(array_key_exists('iv', $data)) {
 		$data = json_decode(crypto_unencapsulate($data,get_config('system','prvkey')),true);
 	}
 
@@ -1081,7 +1086,7 @@ function zot_import($arr, $sender_url) {
 
 			logger('zot_import: notify: ' . print_r($i['notify'],true), LOGGER_DATA);
 
-			$hub = zot_gethub($i['notify']['sender']);			
+			$hub = zot_gethub($i['notify']['sender']);
 			if((! $hub) || ($hub['hubloc_url'] != $sender_url)) {
 				logger('zot_import: potential forgery: wrong site for sender: ' . $sender_url . ' != ' . print_r($i['notify'],true));
 				continue;
@@ -1117,16 +1122,16 @@ function zot_import($arr, $sender_url) {
 					continue;
 				}
 
-				// It's a specifically targetted post. If we were sent a public_scope hint (likely), 
-				// get rid of it so that it doesn't get stored and cause trouble. 
+				// It's a specifically targetted post. If we were sent a public_scope hint (likely),
+				// get rid of it so that it doesn't get stored and cause trouble.
 
-				if(($i) && is_array($i) && array_key_exists('message',$i) && is_array($i['message']) 
+				if(($i) && is_array($i) && array_key_exists('message',$i) && is_array($i['message'])
 					&& $i['message']['type'] === 'activity' && array_key_exists('public_scope',$i['message']))
 					unset($i['message']['public_scope']);
 
 				$deliveries = $r;
 
-				// We found somebody on this site that's in the recipient list. 
+				// We found somebody on this site that's in the recipient list.
 
 			}
 			else {
@@ -1151,12 +1156,12 @@ function zot_import($arr, $sender_url) {
 				}
 
 				// if the scope is anything but 'public' we're going to store it as private regardless
-				// of the private flag on the post. 
+				// of the private flag on the post.
 
-				if($i['message'] && array_key_exists('public_scope',$i['message']) 
+				if($i['message'] && array_key_exists('public_scope',$i['message'])
 					&& $i['message']['public_scope'] !== 'public') {
 
-					if(! array_key_exists('flags',$i['message'])) 
+					if(! array_key_exists('flags',$i['message']))
 						$i['message']['flags'] = array();
 					if(! in_array('private',$i['message']['flags']))
 						$i['message']['flags'][] = 'private';
@@ -1223,7 +1228,7 @@ function zot_import($arr, $sender_url) {
 
 					logger('Channel sync received: ' . print_r($arr,true), LOGGER_DATA);
 					logger('Channel sync recipients: ' . print_r($deliveries,true), LOGGER_DATA);
-					
+
 					$result = process_channel_sync_delivery($i['notify']['sender'],$arr,$deliveries);
 				}
 				elseif($i['message']['type'] === 'location') {
@@ -1231,7 +1236,7 @@ function zot_import($arr, $sender_url) {
 
 					logger('Location message received: ' . print_r($arr,true), LOGGER_DATA);
 					logger('Location message recipients: ' . print_r($deliveries,true), LOGGER_DATA);
-					
+
 					$result = process_location_delivery($i['notify']['sender'],$arr,$deliveries);
 				}
 			}
@@ -1244,19 +1249,18 @@ function zot_import($arr, $sender_url) {
 	return $return;
 }
 
-
-// A public message with no listed recipients can be delivered to anybody who
-// has PERMS_NETWORK for that type of post, PERMS_AUTHED (in-network senders are
-// by definition authenticated) or PERMS_SITE and is one the same
-// site, or PERMS_SPECIFIC and the sender is a contact who is granted 
-// permissions via their connection permissions in the address book.
-// Here we take a given message and construct a list of hashes of everybody
-// on the site that we should try and deliver to.
-// Some of these will be rejected, but this gives us a place to start.
-
 /**
  * @brief
  *
+ * A public message with no listed recipients can be delivered to anybody who
+ * has PERMS_NETWORK for that type of post, PERMS_AUTHED (in-network senders are
+ * by definition authenticated) or PERMS_SITE and is one the same site,
+ * or PERMS_SPECIFIC and the sender is a contact who is granted permissions via
+ * their connection permissions in the address book.
+ * Here we take a given message and construct a list of hashes of everybody
+ * on the site that we should try and deliver to.
+ * Some of these will be rejected, but this gives us a place to start.
+ *
  * @param array $msg
  * @return NULL|array
  */
@@ -1281,24 +1285,24 @@ function public_recips($msg) {
 			// notes (below) from when I got this section of code working. You would think that
 			// we only have to find those with the requisite stream or comment permissions,
 			// depending on whether this is a top-level post or a comment - but you would be wrong.
- 
+
 			// ... so public_recips and allowed_public_recips is working so much better
-			// than before, but was still not quite right. We seem to be getting all the right 
-			// results for top-level posts now, but comments aren't getting through on channels 
+			// than before, but was still not quite right. We seem to be getting all the right
+			// results for top-level posts now, but comments aren't getting through on channels
 			// for which we've allowed them to send us their stream, but not comment on our posts.
-			// The reason is we were seeing if they could comment - and we only need to do that if 
+			// The reason is we were seeing if they could comment - and we only need to do that if
 			// we own the post. If they own the post, we only need to check if they can send us their stream.
 
 			// if this is a comment and it wasn't sent by the post owner, check to see who is allowing them to comment.
-			// We should have one specific recipient and this step shouldn't be needed unless somebody stuffed up 
+			// We should have one specific recipient and this step shouldn't be needed unless somebody stuffed up
 			// their software. We may need this step to protect us from bad guys intentionally stuffing up their software.
 			// If it is sent by the post owner, we don't need to do this. We only need to see who is receiving the
 			// owner's stream (which was already set above) - as they control the comment permissions, not us.
 
-			// Note that by doing this we introduce another bug because some public forums have channel_w_stream 
+			// Note that by doing this we introduce another bug because some public forums have channel_w_stream
 			// permissions set to themselves only. We also need in this function to add these public forums to the
-			// public recipient list based on if they are tagged or not and have tag permissions. This is complicated 
-			// by the fact that this activity doesn't have the public forum tag. It's the parent activity that 
+			// public recipient list based on if they are tagged or not and have tag permissions. This is complicated
+			// by the fact that this activity doesn't have the public forum tag. It's the parent activity that
 			// contains the tag. we'll solve that further below.
 
 			if($msg['notify']['sender']['guid_sig'] != $msg['message']['owner']['guid_sig']) {
@@ -1320,17 +1324,18 @@ function public_recips($msg) {
 	// First find those channels who are accepting posts from anybody, or at least
 	// something greater than just their connections.
 
-	if($msg['notify']['sender']['url'] === z_root())
-		$sql = " where (( " . $col . " & " . intval(PERMS_NETWORK) . " ) > 0  
-					or (  " . $col . " & " . intval(PERMS_SITE) . " ) > 0 
-					or (  " . $col . " & " . intval(PERMS_PUBLIC) . ") > 0 
+	if($msg['notify']['sender']['url'] === z_root()) {
+		$sql = " where (( " . $col . " & " . intval(PERMS_NETWORK) . " ) > 0
+					or (  " . $col . " & " . intval(PERMS_SITE) . " ) > 0
+					or (  " . $col . " & " . intval(PERMS_PUBLIC) . ") > 0
 					or (  " . $col . " & " . intval(PERMS_AUTHED)  . ") > 0 ) ";
-	else
-		$sql = " where (( " . $col . " & " . intval(PERMS_NETWORK) . " ) > 0  
-					or (  " . $col . " & " . intval(PERMS_PUBLIC) . ") > 0 
+	} else {
+		$sql = " where (( " . $col . " & " . intval(PERMS_NETWORK) . " ) > 0
+					or (  " . $col . " & " . intval(PERMS_PUBLIC) . ") > 0
 					or (  " . $col . " & " . intval(PERMS_AUTHED) . ") > 0 ) ";
+	}
 
-	$r = q("select channel_hash as hash from channel $sql or channel_hash = '%s' 
+	$r = q("select channel_hash as hash from channel $sql or channel_hash = '%s'
 		and ( channel_pageflags & " . intval(PAGE_REMOVED) . " ) = 0 ",
 		dbesc($msg['notify']['sender']['hash'])
 	);
@@ -1341,13 +1346,13 @@ function public_recips($msg) {
 	// Now we have to get a bit dirty. Find every channel that has the sender in their connections (abook)
 	// and is allowing this sender at least at a high level.
 
-	$x = q("select channel_hash as hash from channel left join abook on abook_channel = channel_id 
-		where abook_xchan = '%s' and ( channel_pageflags & " . intval(PAGE_REMOVED) . " ) = 0 
-		and (( " . $col . " & " . intval(PERMS_SPECIFIC) . " ) > 0  and ( abook_my_perms & " . intval($field) . " ) > 0 ) 
-		OR   ( " . $col . " & " . intval(PERMS_PENDING) . " ) > 0 
+	$x = q("select channel_hash as hash from channel left join abook on abook_channel = channel_id
+		where abook_xchan = '%s' and ( channel_pageflags & " . intval(PAGE_REMOVED) . " ) = 0
+		and (( " . $col . " & " . intval(PERMS_SPECIFIC) . " ) > 0  and ( abook_my_perms & " . intval($field) . " ) > 0 )
+		OR   ( " . $col . " & " . intval(PERMS_PENDING) . " ) > 0
 		OR  (( " . $col . " & " . intval(PERMS_CONTACTS) . " ) > 0 and ( abook_flags & " . intval(ABOOK_FLAG_PENDING) . " ) = 0 ) ",
 		dbesc($msg['notify']['sender']['hash'])
-	); 
+	);
 
 	if(! $x)
 		$x = array();
@@ -1386,7 +1391,7 @@ function public_recips($msg) {
 	}
 	else {
 		// This is a comment. We need to find any parent with ITEM_UPLINK set. But in fact, let's just return
-		// everybody that stored a copy of the parent. This way we know we're covered. We'll check the 
+		// everybody that stored a copy of the parent. This way we know we're covered. We'll check the
 		// comment permissions when we deliver them.
 
 		if($msg['message']['message_top']) {
@@ -1395,7 +1400,7 @@ function public_recips($msg) {
 				intval(ITEM_UPLINK)
 			);
 			if($z)
-				$r = array_merge($r,$z); 
+				$r = array_merge($r,$z);
 		}
 	}
 
@@ -1404,7 +1409,7 @@ function public_recips($msg) {
 
 	if($r) {
 		$uniq = array();
-		
+
 		foreach($r as $rr) {
 			if(! in_array($rr['hash'],$uniq))
 				$uniq[] = $rr['hash'];
@@ -1419,9 +1424,18 @@ function public_recips($msg) {
 	return $r;
 }
 
-// This is the second part of the above function. We'll find all the channels willing to accept public posts from us,
-// then match them against the sender privacy scope and see who in that list that the sender is allowing.
-
+/**
+ * @brief
+ *
+ * This is the second part of public_recipes().
+ * We'll find all the channels willing to accept public posts from us, then
+ * match them against the sender privacy scope and see who in that list that
+ * the sender is allowing.
+ *
+ * @see public_recipes()
+ * @param array $msg
+ * @return array
+ */
 function allowed_public_recips($msg) {
 
 	logger('allowed_public_recips: ' . print_r($msg,true),LOGGER_DATA);
@@ -1431,8 +1445,8 @@ function allowed_public_recips($msg) {
 
 	// Mail won't have a public scope.
 	// in fact, it's doubtful mail will ever get here since it almost universally
-	// has a recipient, but in fact we don't require this, so it's technically 
-	// possible to send mail to anybody that's listening.  
+	// has a recipient, but in fact we don't require this, so it's technically
+	// possible to send mail to anybody that's listening.
 
 	$recips = public_recips($msg);
 
@@ -1483,12 +1497,21 @@ function allowed_public_recips($msg) {
 	return array();
 }
 
-
-function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$request = false) {
+/**
+ * @brief
+ *
+ * @param array $sender
+ * @param array $arr
+ * @param array $deliveries
+ * @param boolean $relay
+ * @param boolean $public (optional) default false
+ * @param boolean $request (optional) default false
+ * @return array
+ */
+function process_delivery($sender, $arr, $deliveries, $relay, $public = false, $request = false) {
 
 	$result = array();
 
-
 	// We've validated the sender. Now make sure that the sender is the owner or author
 
 	if(! $public) {
@@ -1505,7 +1528,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 		);
 
 		if(! $r) {
-			$result[] = array($d['hash'],'recipients not found');
+			$result[] = array($d['hash'], 'recipients not found');
 			continue;
 		}
 
@@ -1513,7 +1536,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 
 		// allow public postings to the sys channel regardless of permissions, but not
 		// for comments travelling upstream. Wait and catch them on the way down.
-		// They may have been blocked by the owner. 
+		// They may have been blocked by the owner.
 
 		if(($channel['channel_pageflags'] & PAGE_SYSTEM) && (! $arr['item_private']) && (! $relay)) {
 			$local_public = true;
@@ -1557,7 +1580,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 			// We are only going to accept comments from this sender if the comment has the same route as the top-level-post,
 			// this is so that permissions mismatches between senders apply to the entire conversation
 			// As a side effect we will also do a preliminary check that we have the top-level-post, otherwise
-			// processing it is pointless. 
+			// processing it is pointless.
 
 			$r = q("select route, id from item where mid = '%s' and uid = %d limit 1",
 				dbesc($arr['parent_mid']),
@@ -1566,21 +1589,21 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 			if(! $r) {
 				$result[] = array($d['hash'],'comment parent not found',$channel['channel_name'] . ' <' . $channel['channel_address'] . '@' . get_app()->get_hostname() . '>',$arr['mid']);
 
-				// We don't seem to have a copy of this conversation or at least the parent 
+				// We don't seem to have a copy of this conversation or at least the parent
 				// - so request a copy of the entire conversation to date.
-				// Don't do this if it's a relay post as we're the ones who are supposed to 
+				// Don't do this if it's a relay post as we're the ones who are supposed to
 				// have the copy and we don't want the request to loop.
 				// Also don't do this if this comment came from a conversation request packet.
 				// It's possible that comments are allowed but posting isn't and that could
-				// cause a conversation fetch loop. We can detect these packets since they are 
-				// delivered via a 'notify' packet type that has a message_id element in the 
-				// initial zot packet (just like the corresponding 'request' packet type which 
+				// cause a conversation fetch loop. We can detect these packets since they are
+				// delivered via a 'notify' packet type that has a message_id element in the
+				// initial zot packet (just like the corresponding 'request' packet type which
 				// makes the request).
 				// We'll also check the send_stream permission - because if it isn't allowed,
 				// the top level post is unlikely to be imported and
-				// this is just an exercise in futility.   
+				// this is just an exercise in futility.
 
-				if((! $relay) && (! $request) && (! $local_public) 
+				if((! $relay) && (! $request) && (! $local_public)
 					&& perm_is_allowed($channel['channel_id'],$sender['hash'],'send_stream')) {
 					proc_run('php', 'include/notifier.php', 'request', $channel['channel_id'], $sender['hash'], $arr['parent_mid']);
 				}
@@ -1598,7 +1621,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 				// sent it to us originally. Ignore it if it came from another source
 				// (with potentially different permissions).
 				// only compare the last hop since it could have arrived at the last location any number of ways.
-				// Always accept empty routes and firehose items (route contains 'undefined') . 
+				// Always accept empty routes and firehose items (route contains 'undefined') .
 
 				$existing_route = explode(',', $r[0]['route']);
 				$routes = count($existing_route);
@@ -1610,7 +1633,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 					$last_hop = '';
 					$last_prior_route = '';
 				}
-				
+
 				if(in_array('undefined',$existing_route) || $last_hop == 'undefined' || $sender['hash'] == 'undefined')
 					$last_hop = '';
 
@@ -1623,7 +1646,7 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 					continue;
 				}
 
-				// we'll add sender['hash'] onto this when we deliver it. $last_prior_route now has the previously stored route 
+				// we'll add sender['hash'] onto this when we deliver it. $last_prior_route now has the previously stored route
 				// *except* for the sender['hash'] which would've been the last hop before it got to us.
 
 				$arr['route'] = $last_prior_route;
@@ -1661,11 +1684,11 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 			// We already have this post.
 			$item_id = $r[0]['id'];
 			if($r[0]['item_restrict'] & ITEM_DELETED) {
-				// It was deleted locally. 
+				// It was deleted locally.
 				$result[] = array($d['hash'],'update ignored',$channel['channel_name'] . ' <' . $channel['channel_address'] . '@' . get_app()->get_hostname() . '>',$arr['mid']);
 				continue;
-			}			
-			// Maybe it has been edited? 
+			}
+			// Maybe it has been edited?
 			elseif($arr['edited'] > $r[0]['edited']) {
 				$arr['id'] = $r[0]['id'];
 				$arr['uid'] = $channel['channel_id'];
@@ -1676,8 +1699,8 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 			}
 			else {
 				$result[] = array($d['hash'],'update ignored',$channel['channel_name'] . ' <' . $channel['channel_address'] . '@' . get_app()->get_hostname() . '>',$arr['mid']);
-				// We need this line to ensure wall-to-wall comments are relayed (by falling through to the relay bit), 
-				// and at the same time not relay any other relayable posts more than once, because to do so is very wasteful. 
+				// We need this line to ensure wall-to-wall comments are relayed (by falling through to the relay bit),
+				// and at the same time not relay any other relayable posts more than once, because to do so is very wasteful.
 				if(! ($r[0]['item_flags'] & ITEM_ORIGIN))
 					continue;
 			}
@@ -1689,8 +1712,8 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 			// if it's a sourced post, call the post_local hooks as if it were
 			// posted locally so that crosspost connectors will be triggered.
 
-			if(check_item_source($arr['uid'],$arr))
-				call_hooks('post_local',$arr);
+			if(check_item_source($arr['uid'], $arr))
+				call_hooks('post_local', $arr);
 
 			$item_result = item_store($arr);
 			$item_id = 0;
@@ -1713,17 +1736,27 @@ function process_delivery($sender,$arr,$deliveries,$relay,$public = false,$reque
 	}
 
 	if(! $deliveries)
-		$result[] = array('','no recipients','',$arr['mid']);
+		$result[] = array('', 'no recipients', '', $arr['mid']);
 
-	logger('process_delivery: local results: ' . print_r($result,true), LOGGER_DEBUG);
+	logger('process_delivery: local results: ' . print_r($result, true), LOGGER_DEBUG);
 
 	return $result;
 }
 
+/**
+ * @brief
+ *
+ * @param array $sender an associative array with
+ *   * \e string \b hash a xchan_hash
+ * @param array $arr an associative array
+ *   * \e int \b verb
+ *   * \e int \b obj_type
+ *   * \e int \b mid
+ * @param int $uid
+ */
+function remove_community_tag($sender, $arr, $uid) {
 
-function remove_community_tag($sender,$arr,$uid) {
-
-	if(! (activity_match($arr['verb'],ACTIVITY_TAG) && ($arr['obj_type'] == ACTIVITY_OBJ_TAGTERM)))
+	if(! (activity_match($arr['verb'], ACTIVITY_TAG) && ($arr['obj_type'] == ACTIVITY_OBJ_TAGTERM)))
 		return;
 
 	logger('remove_community_tag: invoked');
@@ -1780,7 +1813,15 @@ function remove_community_tag($sender,$arr,$uid) {
 	);
 }
 
-function update_imported_item($sender,$item,$uid) {
+/**
+ * @brief Just calls item_store_update() and logs result.
+ *
+ * @see item_store_update()
+ * @param array $sender (unused)
+ * @param array $item
+ * @param int $uid (unused)
+ */
+function update_imported_item($sender, $item, $uid) {
 
 	$x = item_store_update($item);
 	if(! $x['item_id'])
@@ -1793,9 +1834,10 @@ function update_imported_item($sender,$item,$uid) {
  * @brief Deletes an imported item.
  *
  * @param array $sender
+ *   * \e string \b hash a xchan_hash
  * @param array $item
  * @param int $uid
- * @param unknown $relay
+ * @param boolean $relay
  * @return boolean|int post_id
  */
 function delete_imported_item($sender, $item, $uid, $relay) {
@@ -1819,9 +1861,9 @@ function delete_imported_item($sender, $item, $uid, $relay) {
 	} else {
 
 		// perhaps the item is still in transit and the delete notification got here before the actual item did. Store it with the deleted flag set.
-		// item_store() won't try to deliver any notifications or start delivery chains if this flag is set. 
+		// item_store() won't try to deliver any notifications or start delivery chains if this flag is set.
 		// This means we won't end up with potentially even more delivery threads trying to push this delete notification.
-		// But this will ensure that if the (undeleted) original post comes in at a later date, we'll reject it because it will have an older timestamp.  
+		// But this will ensure that if the (undeleted) original post comes in at a later date, we'll reject it because it will have an older timestamp.
 
 		logger('delete received for non-existent item - storing item data.');
 
@@ -1846,10 +1888,10 @@ function delete_imported_item($sender, $item, $uid, $relay) {
 
 			// This is a bit hackish, but may have to suffice until the notification/delivery loop is optimised
 			// a bit further. We're going to strip the ITEM_ORIGIN on this item if it's a comment, because
-			// it was already deleted, and we're already relaying, and this ensures that no other process or 
+			// it was already deleted, and we're already relaying, and this ensures that no other process or
 			// code path downstream can relay it again (causing a loop). Since it's already gone it's not coming
 			// back, and we aren't going to (or shouldn't at any rate) delete it again in the future - so losing
-			// this information from the metadata should have no other discernible impact. 
+			// this information from the metadata should have no other discernible impact.
 
 			if (($r[0]['id'] != $r[0]['parent']) && ($r[0]['item_flags'] & ITEM_ORIGIN)) {
 				q("update item set item_flags = %d where id = %d and uid = %d",
@@ -1858,7 +1900,7 @@ function delete_imported_item($sender, $item, $uid, $relay) {
 					intval($r[0]['uid'])
 				);
 			}
-		} 
+		}
 
 		require_once('include/items.php');
 
@@ -1872,7 +1914,7 @@ function delete_imported_item($sender, $item, $uid, $relay) {
 	return $post_id;
 }
 
-function process_mail_delivery($sender,$arr,$deliveries) {
+function process_mail_delivery($sender, $arr, $deliveries) {
 
 	$result = array();
 
@@ -1898,7 +1940,7 @@ function process_mail_delivery($sender,$arr,$deliveries) {
 			$result[] = array($d['hash'],'permission denied',$channel['channel_name'],$arr['mid']);
 			continue;
 		}
-	
+
 		$r = q("select id from mail where mid = '%s' and channel_id = %d limit 1",
 			dbesc($arr['mid']),
 			intval($channel['channel_id'])
@@ -1923,13 +1965,20 @@ function process_mail_delivery($sender,$arr,$deliveries) {
 			$arr['channel_id'] = $channel['channel_id'];
 			$item_id = mail_store($arr);
 			$result[] = array($d['hash'],'mail delivered',$channel['channel_name'],$arr['mid']);
-
 		}
 	}
+
 	return $result;
 }
 
-function process_rating_delivery($sender,$arr) {
+/**
+ * @brief Processes delivery of rating.
+ *
+ * @param array $sender
+ *   * \e string \b hash a xchan_hash
+ * @param array $arr
+ */
+function process_rating_delivery($sender, $arr) {
 
 	logger('process_rating_delivery: ' . print_r($arr,true));
 
@@ -1948,8 +1997,8 @@ function process_rating_delivery($sender,$arr) {
 	$r = q("select * from xlink where xlink_xchan = '%s' and xlink_link = '%s' and xlink_static = 1 limit 1",
 		dbesc($sender['hash']),
 		dbesc($arr['target'])
-	);	
-	
+	);
+
 	if($r) {
 		if($r[0]['xlink_updated'] >= $arr['edited']) {
 			logger('rating message duplicate');
@@ -1979,8 +2028,16 @@ function process_rating_delivery($sender,$arr) {
 	}
 }
 
-
-function process_profile_delivery($sender,$arr,$deliveries) {
+/**
+ * @brief Processes delivery of profile.
+ *
+ * @see import_directory_profile()
+ * @param array $sender an associative array
+ *   * \e string \b hash a xchan_hash
+ * @param array $arr
+ * @param array $deliveries (unused)
+ */
+function process_profile_delivery($sender, $arr, $deliveries) {
 
 	logger('process_profile_delivery', LOGGER_DEBUG);
 
@@ -1988,7 +2045,7 @@ function process_profile_delivery($sender,$arr,$deliveries) {
 			dbesc($sender['hash'])
 	);
 	if($r)
-		import_directory_profile($sender['hash'],$arr,$r[0]['xchan_addr'], UPDATE_FLAGS_UPDATED, 0);
+		import_directory_profile($sender['hash'], $arr, $r[0]['xchan_addr'], UPDATE_FLAGS_UPDATED, 0);
 }
 
 function process_location_delivery($sender,$arr,$deliveries) {
@@ -2001,23 +2058,31 @@ function process_location_delivery($sender,$arr,$deliveries) {
 	);
 	if($r)
 		$sender['key'] = $r[0]['xchan_pubkey'];
+
 	if(array_key_exists('locations',$arr) && $arr['locations']) {
 		$x = sync_locations($sender,$arr,true);
 		logger('process_location_delivery: results: ' . print_r($x,true), LOGGER_DEBUG);
 		if($x['changed']) {
-			$guid = random_string() . '@' . get_app()->get_hostname();		
+			$guid = random_string() . '@' . get_app()->get_hostname();
 			update_modtime($sender['hash'],$sender['guid'],$arr['locations'][0]['address'],UPDATE_FLAGS_UPDATED);
 		}
 	}
 }
 
-
-function sync_locations($sender,$arr,$absolute = false) {
+/**
+ * @brief Synchronises locations.
+ *
+ * @param array $sender
+ * @param array $arr
+ * @param boolean $absolute (optional) default false
+ * @return array
+ */
+function sync_locations($sender, $arr, $absolute = false) {
 
 	$ret = array();
 
 	if($arr['locations']) {
-		
+
 		$xisting = q("select hubloc_id, hubloc_url, hubloc_sitekey from hubloc where hubloc_hash = '%s'",
 			dbesc($sender['hash'])
 		);
@@ -2045,7 +2110,7 @@ function sync_locations($sender,$arr,$absolute = false) {
 			}
 
 			for($x = 0; $x < count($xisting); $x ++) {
-				if(($xisting[$x]['hubloc_url'] === $location['url']) 
+				if(($xisting[$x]['hubloc_url'] === $location['url'])
 					&& ($xisting[$x]['hubloc_sitekey'] === $location['sitekey'])) {
 					$xisting[$x]['updated'] = true;
 				}
@@ -2061,7 +2126,7 @@ function sync_locations($sender,$arr,$absolute = false) {
 			if(strpos($location['address'],'/') !== false)
 				$location['address'] = substr($location['address'],0,strpos($location['address'],'/'));
 
-			// match as many fields as possible in case anything at all changed. 
+			// match as many fields as possible in case anything at all changed.
 
 			$r = q("select * from hubloc where hubloc_hash = '%s' and hubloc_guid = '%s' and hubloc_guid_sig = '%s' and hubloc_url = '%s' and hubloc_url_sig = '%s' and hubloc_host = '%s' and hubloc_addr = '%s' and hubloc_callback = '%s' and hubloc_sitekey = '%s' ",
 				dbesc($sender['hash']),
@@ -2090,7 +2155,7 @@ function sync_locations($sender,$arr,$absolute = false) {
 					);
 					$current_site = true;
 				}
-				
+
 				// If it is the site we're currently talking to, and it's marked offline,
 				// either we have some bad information - or the thing came back to life.
 
@@ -2110,7 +2175,7 @@ function sync_locations($sender,$arr,$absolute = false) {
 						intval(XCHAN_FLAGS_ORPHAN),
 						dbesc($sender['hash'])
 					);
-				} 
+				}
 
 				// Remove pure duplicates
 				if(count($r) > 1) {
@@ -2175,7 +2240,7 @@ function sync_locations($sender,$arr,$absolute = false) {
 				continue;
 			}
 
-			// Existing hubs are dealt with. Now let's process any new ones. 
+			// Existing hubs are dealt with. Now let's process any new ones.
 			// New hub claiming to be primary. Make it so by removing any existing primaries.
 
 			if(intval($location['primary'])) {
@@ -2244,9 +2309,9 @@ function sync_locations($sender,$arr,$absolute = false) {
  * @brief Returns an array with all known distinct hubs for this channel.
  *
  * @see zot_get_hublocs()
- * @param array $channel an assoziative array which must contain
+ * @param array $channel an associative array which must contain
  *  * \e string \b channel_hash the hash of the channel
- * @return array an array with assoziated arrays
+ * @return array an array with associative arrays
  */
 function zot_encode_locations($channel) {
 	$ret = array();
@@ -2272,10 +2337,9 @@ function zot_encode_locations($channel) {
 	return $ret;
 }
 
-
 /**
  * @brief Imports a directory profile.
- * 
+ *
  * @param string $hash
  * @param array $profile
  * @param string $addr
@@ -2319,7 +2383,7 @@ function import_directory_profile($hash, $profile, $addr, $ud_flags = UPDATE_FLA
 	$arr['xprof_keywords'] = implode(' ',$clean);
 
 	// Self censored, make it so
-	// These are not translated, so the German "erwachsenen" keyword will not censor the directory profile. Only the English form - "adult".   
+	// These are not translated, so the German "erwachsenen" keyword will not censor the directory profile. Only the English form - "adult".
 
 
 	if (in_arrayi('nsfw', $clean) || in_arrayi('adult', $clean)) {
@@ -2333,7 +2397,7 @@ function import_directory_profile($hash, $profile, $addr, $ud_flags = UPDATE_FLA
 		dbesc($hash)
 	);
 
-	if ($arr['xprof_age'] > 150) 
+	if ($arr['xprof_age'] > 150)
 		$arr['xprof_age'] = 150;
 	if ($arr['xprof_age'] < 0)
 		$arr['xprof_age'] = 0;
@@ -2348,21 +2412,21 @@ function import_directory_profile($hash, $profile, $addr, $ud_flags = UPDATE_FLA
 			}
 		}
 		if ($update) {
-			q("update xprof set 
-				xprof_desc = '%s', 
-				xprof_dob = '%s', 
-				xprof_age = %d, 
-				xprof_gender = '%s', 
-				xprof_marital = '%s', 
-				xprof_sexual = '%s', 
-				xprof_locale = '%s', 
-				xprof_region = '%s', 
-				xprof_postcode = '%s', 
-				xprof_country = '%s', 
-				xprof_about = '%s', 
-				xprof_homepage = '%s', 
-				xprof_hometown = '%s', 
-				xprof_keywords = '%s' 
+			q("update xprof set
+				xprof_desc = '%s',
+				xprof_dob = '%s',
+				xprof_age = %d,
+				xprof_gender = '%s',
+				xprof_marital = '%s',
+				xprof_sexual = '%s',
+				xprof_locale = '%s',
+				xprof_region = '%s',
+				xprof_postcode = '%s',
+				xprof_country = '%s',
+				xprof_about = '%s',
+				xprof_homepage = '%s',
+				xprof_hometown = '%s',
+				xprof_keywords = '%s'
 				where xprof_hash = '%s'",
 				dbesc($arr['xprof_desc']),
 				dbesc($arr['xprof_dob']),
@@ -2412,7 +2476,13 @@ function import_directory_profile($hash, $profile, $addr, $ud_flags = UPDATE_FLA
 	return $d['update'];
 }
 
-function import_directory_keywords($hash,$keywords) {
+/**
+ * @brief
+ *
+ * @param string $hash
+ * @param array $keywords
+ */
+function import_directory_keywords($hash, $keywords) {
 
 	$existing = array();
 	$r = q("select * from xtag where xtag_hash = '%s'",
@@ -2426,31 +2496,39 @@ function import_directory_keywords($hash,$keywords) {
 
 	$clean = array();
 	foreach($keywords as $kw) {
-		$kw = trim(htmlspecialchars($kw,ENT_COMPAT,'UTF-8',false));
-		$kw = trim($kw,',');
+		$kw = trim(htmlspecialchars($kw,ENT_COMPAT, 'UTF-8', false));
+		$kw = trim($kw, ',');
 		$clean[] = $kw;
 	}
 
 	foreach($existing as $x) {
-		if(! in_array($x,$clean))
+		if(! in_array($x, $clean))
 			$r = q("delete from xtag where xtag_hash = '%s' and xtag_term = '%s'",
 				dbesc($hash),
 				dbesc($x)
 			);
 	}
 	foreach($clean as $x) {
-		if(! in_array($x,$existing))
+		if(! in_array($x, $existing)) {
 			$r = q("insert into xtag ( xtag_hash, xtag_term) values ( '%s' ,'%s' )",
 				dbesc($hash),
 				dbesc($x)
 			);
+		}
 	}
 }
 
+/**
+ * @brief
+ *
+ * @param string $hash
+ * @param string $guid
+ * @param string $addr
+ * @param int $flags (optional) default 0
+ */
+function update_modtime($hash, $guid, $addr, $flags = 0) {
 
-function update_modtime($hash,$guid,$addr,$flags = 0) {
-
-	$dirmode = intval(get_config('system','directory_mode'));
+	$dirmode = intval(get_config('system', 'directory_mode'));
 
 	if($dirmode == DIRECTORY_MODE_NORMAL)
 		return;
@@ -2473,12 +2551,18 @@ function update_modtime($hash,$guid,$addr,$flags = 0) {
 	}
 }
 
-
-function import_site($arr,$pubkey) {
+/**
+ * @brief
+ *
+ * @param array $arr
+ * @param string $pubkey
+ * @return boolean true if updated or inserted
+ */
+function import_site($arr, $pubkey) {
 	if( (! is_array($arr)) || (! $arr['url']) || (! $arr['url_sig']))
 		return false;
 
-	if(! rsa_verify($arr['url'],base64url_decode($arr['url_sig']),$pubkey)) {
+	if(! rsa_verify($arr['url'], base64url_decode($arr['url_sig']), $pubkey)) {
 		logger('import_site: bad url_sig');
 		return false;
 	}
@@ -2545,11 +2629,11 @@ function import_site($arr,$pubkey) {
 	// Downgrade any others claiming to be primary. As they have
 	// flubbed up this badly already, don't let them be directory servers at all.
 
-	if(($site_directory === DIRECTORY_MODE_PRIMARY) 
-		&& ($site_realm === get_directory_realm()) 
-		&& ($arr['url'] != get_directory_primary())) {
+	if(($site_directory === DIRECTORY_MODE_PRIMARY)
+			&& ($site_realm === get_directory_realm())
+			&& ($arr['url'] != get_directory_primary())) {
 		$site_directory = DIRECTORY_MODE_NORMAL;
-	} 
+	}
 
 	if($exists) {
 		if(($siterecord['site_flags'] != $site_directory)
@@ -2614,8 +2698,11 @@ function import_site($arr,$pubkey) {
 /**
  * Send a zot packet to all hubs where this channel is duplicated, refreshing
  * such things as personal settings, channel permissions, address book updates, etc.
+ *
+ * @param int $uid
+ * @param array $packet (optional) default null
+ * @param boolean $groups_changed (optional) default false
  */
-
 function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 
 	$a = get_app();
@@ -2623,7 +2710,7 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 	logger('build_sync_packet');
 
 	if($packet)
-		logger('packet: ' . print_r($packet,true),LOGGER_DATA);
+		logger('packet: ' . print_r($packet, true),LOGGER_DATA);
 
 	if(! $uid)
 		$uid = local_channel();
@@ -2651,6 +2738,7 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 	foreach($h as $x) {
 		if($x['hubloc_host'] == $a->get_hostname())
 			continue;
+
 		$synchubs[] = $x;
 	}
 
@@ -2708,10 +2796,9 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 		);
 		if($r)
 			$info['collection_members'] = $r;
-			
 	}
 
-	$interval = ((get_config('system','delivery_interval') !== false) 
+	$interval = ((get_config('system','delivery_interval') !== false)
 			? intval(get_config('system','delivery_interval')) : 2 );
 
 
@@ -2733,13 +2820,21 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 			dbesc(json_encode($info))
 		);
 
-		proc_run('php','include/deliver.php',$hash);
+		proc_run('php', 'include/deliver.php', $hash);
 		if($interval)
 			@time_sleep_until(microtime(true) + (float) $interval);
 	}
 }
 
-function process_channel_sync_delivery($sender,$arr,$deliveries) {
+/**
+ * @brief
+ *
+ * @param array $sender
+ * @param array $arr
+ * @param array $deliveries
+ * @return array
+ */
+function process_channel_sync_delivery($sender, $arr, $deliveries) {
 
 	/** @FIXME this will sync red structures (channel, pconfig and abook). Eventually we need to make this application agnostic. */
 
@@ -2784,7 +2879,7 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 			}
 			if(count($clean)) {
 				foreach($clean as $k => $v) {
-					$r = dbq("UPDATE channel set " . dbesc($k) . " = '" . dbesc($v) 
+					$r = dbq("UPDATE channel set " . dbesc($k) . " = '" . dbesc($v)
 						. "' where channel_id = " . intval($channel['channel_id']) );
 				}
 			}
@@ -2813,7 +2908,7 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 				if($abook['abook_xchan'] && $abook['entry_deleted']) {
 					logger('process_channel_sync_delivery: removing abook entry for ' . $abook['abook_xchan']);
 					require_once('include/Contact.php');
-					
+
 					$r = q("select abook_id, abook_flags from abook where abook_xchan = '%s' and abook_channel = %d and not ( abook_flags & %d )>0 limit 1",
 						dbesc($abook['abook_xchan']),
 						intval($channel['channel_id']),
@@ -2893,8 +2988,8 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 					foreach($clean as $k => $v) {
 						if($k == 'abook_dob')
 							$v = dbescdate($v);
-							
-						$r = dbq("UPDATE abook set " . dbesc($k) . " = '" . dbesc($v) 
+
+						$r = dbq("UPDATE abook set " . dbesc($k) . " = '" . dbesc($v)
 						. "' where abook_xchan = '" . dbesc($clean['abook_xchan']) . "' and abook_channel = " . intval($channel['channel_id']));
 					}
 				}
@@ -2917,8 +3012,8 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 						}
 					}
 					if($found) {
-						if(($y['name'] != $cl['name']) 
-							|| ($y['visible'] != $cl['visible']) 
+						if(($y['name'] != $cl['name'])
+							|| ($y['visible'] != $cl['visible'])
 							|| ($y['deleted'] != $cl['deleted'])) {
 							q("update groups set name = '%s', visible = %d, deleted = %d where hash = '%s' and uid = %d",
 								dbesc($cl['name']),
@@ -2959,10 +3054,10 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 								break;
 							}
 						}
-						if(! $found_local) {			
+						if(! $found_local) {
 							q("delete from group_member where gid = %d",
 								intval($y['id'])
-							);  
+							);
 							q("update groups set deleted = 1 where id = %d and uid = %d",
 								intval($y['id']),
 								intval($channel['channel_id'])
@@ -2979,15 +3074,17 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 
 			// now sync the members
 
-			if(array_key_exists('collection_members',$arr) && 
-				is_array($arr['collection_members']) && count($arr['collection_members'])) {
+			if(array_key_exists('collection_members', $arr)
+					&& is_array($arr['collection_members'])
+					&& count($arr['collection_members'])) {
 
 				// first sort into groups keyed by the group hash
 				$members = array();
 				foreach($arr['collection_members'] as $cm) {
 					if(! array_key_exists($cm['collection'],$members))
 						$members[$cm['collection']] = array();
-					$members[$cm['collection']][] = $cm['member'];	
+
+					$members[$cm['collection']][] = $cm['member'];
 				}
 
 				// our group list is already synchronised
@@ -3074,7 +3171,7 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 				}
 				if(count($clean)) {
 					foreach($clean as $k => $v) {
-						$r = dbq("UPDATE profile set " . dbesc($k) . " = '" . dbesc($v) 
+						$r = dbq("UPDATE profile set " . dbesc($k) . " = '" . dbesc($v)
 						. "' where profile_guid = '" . dbesc($profile['profile_guid']) . "' and uid = " . intval($channel['channel_id']));
 					}
 				}
@@ -3087,8 +3184,15 @@ function process_channel_sync_delivery($sender,$arr,$deliveries) {
 	return $result;
 }
 
-// We probably should make rpost discoverable.
-
+/**
+ * @brief Returns path to /rpost
+ *
+ * @todo We probably should make rpost discoverable.
+ *
+ * @param array $observer
+ *   * \e string \b xchan_url
+ * @return string
+ */
 function get_rpost_path($observer) {
 	if(! $observer)
 		return '';
@@ -3098,7 +3202,6 @@ function get_rpost_path($observer) {
 	return $parsed['scheme'] . '://' . $parsed['host'] . (($parsed['port']) ? ':' . $parsed['port'] : '') . '/rpost?f=';
 }
 
-
 /**
  * @brief
  *
@@ -3127,7 +3230,6 @@ function import_author_zot($x) {
 	return false;
 }
 
-
 /**
  * @brief Process a message request.
  *
@@ -3136,10 +3238,10 @@ function import_author_zot($x) {
  * for that packet. We will create a message_list array of the entire conversation starting with
  * the missing parent and invoke delivery to the sender of the packet.
  *
- * include/deliver.php (for local delivery) and mod/post.php (for web delivery) detect the existence of 
- * this 'message_list' at the destination and split it into individual messages which are 
- * processed/delivered in order.  
- *  
+ * include/deliver.php (for local delivery) and mod/post.php (for web delivery) detect the existence of
+ * this 'message_list' at the destination and split it into individual messages which are
+ * processed/delivered in order.
+ *
  * Called from mod/post.php
  *
  * @param array $data
@@ -3181,7 +3283,7 @@ function zot_process_message_request($data) {
 	if ($messages) {
 		$env_recips = null;
 
-		$r = q("select hubloc_guid, hubloc_url, hubloc_sitekey, hubloc_network, hubloc_flags, hubloc_callback, hubloc_host 
+		$r = q("select hubloc_guid, hubloc_url, hubloc_sitekey, hubloc_network, hubloc_flags, hubloc_callback, hubloc_host
 			from hubloc where hubloc_hash = '%s' and not (hubloc_flags & %d)>0
 			and not (hubloc_status & %d)>0 ",
 			dbesc($sender_hash),
@@ -3208,8 +3310,8 @@ function zot_process_message_request($data) {
 			 */
 
 			$n = zot_build_packet($c[0],'notify',$env_recips,(($private) ? $hub['hubloc_sitekey'] : null),$hash,array('message_id' => $data['message_id']));
-			q("insert into outq ( outq_hash, outq_account, outq_channel, outq_driver, outq_posturl, outq_async, 
-				outq_created, outq_updated, outq_notify, outq_msg ) 
+			q("insert into outq ( outq_hash, outq_account, outq_channel, outq_driver, outq_posturl, outq_async,
+				outq_created, outq_updated, outq_notify, outq_msg )
 				values ( '%s', %d, %d, '%s', '%s', %d, '%s', '%s', '%s', '%s' )",
 				dbesc($hash),
 				intval($c[0]['channel_account_id']),