From 839895e434830d579ac142fd1f8c8103ed5e78e0 Mon Sep 17 00:00:00 2001
From: rabuzarus <>
Date: Fri, 25 Dec 2015 17:26:04 +0100
Subject: [PATCH] identity.php - code cleanup + doxygen

---
 include/identity.php | 927 +++++++++++++++++++++----------------------
 include/plugin.php   |   2 +-
 2 files changed, 464 insertions(+), 465 deletions(-)

diff --git a/include/identity.php b/include/identity.php
index d87d891a5c..a9d0963e6c 100644
--- a/include/identity.php
+++ b/include/identity.php
@@ -9,12 +9,8 @@ require_once("mod/proxy.php");
 
 /**
  *
- * Function : profile_load
- * @parameter App    $a
- * @parameter string $nickname
- * @parameter int    $profile
+ * @brief Loads a profile into the page sidebar.
  *
- * Summary: Loads a profile into the page sidebar.
  * The function requires a writeable copy of the main App structure, and the nickname
  * of a registered local account.
  *
@@ -26,103 +22,107 @@ require_once("mod/proxy.php");
  * Profile information is placed in the App structure for later retrieval.
  * Honours the owner's chosen theme for display.
  *
- * IMPORTANT: Should only be run in the _init() functions of a module. That ensures that
- * the theme is chosen before the _init() function of a theme is run, which will usually
- * load a lot of theme-specific content
+ * @attention Should only be run in the _init() functions of a module. That ensures that
+ *      the theme is chosen before the _init() function of a theme is run, which will usually
+ *      load a lot of theme-specific content
  *
+ * @param App $a
+ * @param string $nickname
+ * @param int $profile
+ * @param array $profiledata
  */
+function profile_load(&$a, $nickname, $profile = 0, $profiledata = array()) {
 
-if(! function_exists('profile_load')) {
-	function profile_load(&$a, $nickname, $profile = 0, $profiledata = array()) {
+	$user = q("SELECT `uid` FROM `user` WHERE `nickname` = '%s' LIMIT 1",
+		dbesc($nickname)
+	);
 
-		$user = q("SELECT `uid` FROM `user` WHERE `nickname` = '%s' LIMIT 1",
-			dbesc($nickname)
-		);
-
-		if(!$user && count($user) && !count($profiledata)) {
-			logger('profile error: ' . $a->query_string, LOGGER_DEBUG);
-			notice( t('Requested account is not available.') . EOL );
-			$a->error = 404;
-			return;
-		}
+	if(!$user && count($user) && !count($profiledata)) {
+		logger('profile error: ' . $a->query_string, LOGGER_DEBUG);
+		notice( t('Requested account is not available.') . EOL );
+		$a->error = 404;
+		return;
+	}
 
-		$pdata = get_profiledata_by_nick($nickname, $user[0]['uid'], $profile);
+	$pdata = get_profiledata_by_nick($nickname, $user[0]['uid'], $profile);
 
-		if(($pdata === false) || (!count($pdata)) && !count($profiledata)) {
-			logger('profile error: ' . $a->query_string, LOGGER_DEBUG);
-			notice( t('Requested profile is not available.') . EOL );
-			$a->error = 404;
-			return;
-		}
+	if(($pdata === false) || (!count($pdata)) && !count($profiledata)) {
+		logger('profile error: ' . $a->query_string, LOGGER_DEBUG);
+		notice( t('Requested profile is not available.') . EOL );
+		$a->error = 404;
+		return;
+	}
 
-		// fetch user tags if this isn't the default profile
+	// fetch user tags if this isn't the default profile
 
-		if(!$pdata['is-default']) {
-			$x = q("SELECT `pub_keywords` FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
-					intval($pdata['profile_uid'])
-			);
-			if($x && count($x))
-				$pdata['pub_keywords'] = $x[0]['pub_keywords'];
-		}
+	if(!$pdata['is-default']) {
+		$x = q("SELECT `pub_keywords` FROM `profile` WHERE `uid` = %d AND `is-default` = 1 LIMIT 1",
+				intval($pdata['profile_uid'])
+		);
+		if($x && count($x))
+			$pdata['pub_keywords'] = $x[0]['pub_keywords'];
+	}
 
-		$a->profile = $pdata;
-		$a->profile_uid = $pdata['profile_uid'];
+	$a->profile = $pdata;
+	$a->profile_uid = $pdata['profile_uid'];
 
-		$a->profile['mobile-theme'] = get_pconfig($a->profile['profile_uid'], 'system', 'mobile_theme');
-		$a->profile['network'] = NETWORK_DFRN;
+	$a->profile['mobile-theme'] = get_pconfig($a->profile['profile_uid'], 'system', 'mobile_theme');
+	$a->profile['network'] = NETWORK_DFRN;
 
-		$a->page['title'] = $a->profile['name'] . " @ " . $a->config['sitename'];
+	$a->page['title'] = $a->profile['name'] . " @ " . $a->config['sitename'];
 
 //		if (!$profiledata)
 //			$_SESSION['theme'] = $a->profile['theme'];
 
-		$_SESSION['mobile-theme'] = $a->profile['mobile-theme'];
+	$_SESSION['mobile-theme'] = $a->profile['mobile-theme'];
 
-		/**
-		 * load/reload current theme info
-		 */
+	/*
+	 * load/reload current theme info
+	 */
 
-		$a->set_template_engine(); // reset the template engine to the default in case the user's theme doesn't specify one
+	$a->set_template_engine(); // reset the template engine to the default in case the user's theme doesn't specify one
 
-		$theme_info_file = "view/theme/".current_theme()."/theme.php";
-		if (file_exists($theme_info_file)){
-			require_once($theme_info_file);
-		}
+	$theme_info_file = "view/theme/".current_theme()."/theme.php";
+	if (file_exists($theme_info_file)){
+		require_once($theme_info_file);
+	}
 
-		if(! (x($a->page,'aside')))
-			$a->page['aside'] = '';
+	if(! (x($a->page,'aside')))
+		$a->page['aside'] = '';
 
-		if(local_user() && local_user() == $a->profile['uid'] && $profiledata) {
-			$a->page['aside'] .= replace_macros(get_markup_template('profile_edlink.tpl'),array(
-				'$editprofile' => t('Edit profile'),
-				'$profid' => $a->profile['id']
-			));
-		}
+	if(local_user() && local_user() == $a->profile['uid'] && $profiledata) {
+		$a->page['aside'] .= replace_macros(get_markup_template('profile_edlink.tpl'),array(
+			'$editprofile' => t('Edit profile'),
+			'$profid' => $a->profile['id']
+		));
+	}
 
-		$block = (((get_config('system','block_public')) && (! local_user()) && (! remote_user())) ? true : false);
+	$block = (((get_config('system','block_public')) && (! local_user()) && (! remote_user())) ? true : false);
 
-		// To-Do:
-		// By now, the contact block isn't shown, when a different profile is given
-		// But: When this profile was on the same server, then we could display the contacts
-		if ($profiledata)
-			$a->page['aside'] .= profile_sidebar($profiledata, true);
-		else
-			$a->page['aside'] .= profile_sidebar($a->profile, $block);
+	/**
+	 * @todo
+	 * By now, the contact block isn't shown, when a different profile is given
+	 * But: When this profile was on the same server, then we could display the contacts
+	 */
+	if ($profiledata)
+		$a->page['aside'] .= profile_sidebar($profiledata, true);
+	else
+		$a->page['aside'] .= profile_sidebar($a->profile, $block);
 
-		/*if(! $block)
-		 $a->page['aside'] .= contact_block();*/
+	/*if(! $block)
+	 $a->page['aside'] .= contact_block();*/
 
-		return;
-	}
+	return;
 }
 
 
 /**
  * @brief Get all profil data of a local user
- *	If the viewer is an authenticated remote viewer, the profile displayed is the
- *	one that has been configured for his/her viewing in the Contact manager.
- *	Passing a non-zero profile ID can also allow a preview of a selected profile
- *	by the owner
+ * 
+ * If the viewer is an authenticated remote viewer, the profile displayed is the
+ * one that has been configured for his/her viewing in the Contact manager.
+ * Passing a non-zero profile ID can also allow a preview of a selected profile
+ * by the owner
  * 
  * @param string $nickname
  * @param int $uid
@@ -170,247 +170,243 @@ function get_profiledata_by_nick($nickname, $uid = 0, $profile = 0) {
 
 
 /**
- *
- * Function: profile_sidebar
- *
- * Formats a profile for display in the sidebar.
+ * @brief Formats a profile for display in the sidebar.
+ * 
  * It is very difficult to templatise the HTML completely
  * because of all the conditional logic.
- *
- * @parameter: array $profile
- *
- * Returns HTML string stuitable for sidebar inclusion
- * Exceptions: Returns empty string if passed $profile is wrong type or not populated
- *
+ * 
+ * @param array $profile
+ * @param int $block
+ * 
+ * @return HTML string stuitable for sidebar inclusion
+ * 
+ * @note Returns empty string if passed $profile is wrong type or not populated
  */
-if(! function_exists('profile_sidebar')) {
-	function profile_sidebar($profile, $block = 0) {
-		$a = get_app();
+function profile_sidebar($profile, $block = 0) {
+	$a = get_app();
 
-		$o = '';
-		$location = false;
-		$address = false;
+	$o = '';
+	$location = false;
+	$address = false;
 //		$pdesc = true;
 
-		if((! is_array($profile)) && (! count($profile)))
-			return $o;
+	if((! is_array($profile)) && (! count($profile)))
+		return $o;
 
-		$profile['picdate'] = urlencode($profile['picdate']);
+	$profile['picdate'] = urlencode($profile['picdate']);
 
-		if (($profile['network'] != "") AND ($profile['network'] != NETWORK_DFRN)) {
-			$profile['network_name'] = format_network_name($profile['network'],$profile['url']);
-		} else
-			$profile['network_name'] = "";
+	if (($profile['network'] != "") AND ($profile['network'] != NETWORK_DFRN)) {
+		$profile['network_name'] = format_network_name($profile['network'],$profile['url']);
+	} else
+		$profile['network_name'] = "";
 
-		call_hooks('profile_sidebar_enter', $profile);
+	call_hooks('profile_sidebar_enter', $profile);
 
 
-		// don't show connect link to yourself
-		$connect = (($profile['uid'] != local_user()) ? t('Connect')  : False);
+	// don't show connect link to yourself
+	$connect = (($profile['uid'] != local_user()) ? t('Connect')  : False);
 
-		// don't show connect link to authenticated visitors either
-		if(remote_user() && count($_SESSION['remote'])) {
-			foreach($_SESSION['remote'] as $visitor) {
-				if($visitor['uid'] == $profile['uid']) {
-					$connect = false;
-					break;
-				}
+	// don't show connect link to authenticated visitors either
+	if(remote_user() && count($_SESSION['remote'])) {
+		foreach($_SESSION['remote'] as $visitor) {
+			if($visitor['uid'] == $profile['uid']) {
+				$connect = false;
+				break;
 			}
 		}
+	}
 
-		// Is the local user already connected to that user?
-		if ($connect AND local_user()) {
-			if (isset($profile["url"]))
-				$profile_url = normalise_link($profile["url"]);
-			else
-				$profile_url = normalise_link($a->get_baseurl()."/profile/".$profile["nickname"]);
-
-			$r = q("SELECT * FROM `contact` WHERE NOT `pending` AND `uid` = %d AND `nurl` = '%s'",
-				local_user(), $profile_url);
-			if (count($r))
-				$connect = false;
-		}
+	// Is the local user already connected to that user?
+	if ($connect AND local_user()) {
+		if (isset($profile["url"]))
+			$profile_url = normalise_link($profile["url"]);
+		else
+			$profile_url = normalise_link($a->get_baseurl()."/profile/".$profile["nickname"]);
 
-		if ($connect AND ($profile['network'] != NETWORK_DFRN) AND !isset($profile['remoteconnect']))
+		$r = q("SELECT * FROM `contact` WHERE NOT `pending` AND `uid` = %d AND `nurl` = '%s'",
+			local_user(), $profile_url);
+		if (count($r))
 			$connect = false;
+	}
 
-		if (isset($profile['remoteconnect']))
-			$remoteconnect = $profile['remoteconnect'];
+	if ($connect AND ($profile['network'] != NETWORK_DFRN) AND !isset($profile['remoteconnect']))
+		$connect = false;
 
-		if ($connect AND ($profile['network'] == NETWORK_DFRN) AND !isset($remoteconnect))
-			$subscribe_feed = t("Atom feed");
-		else
-			$subscribe_feed = false;
+	if (isset($profile['remoteconnect']))
+		$remoteconnect = $profile['remoteconnect'];
 
-		if(get_my_url() && $profile['unkmail'] && ($profile['uid'] != local_user()))
-			$wallmessage = t('Message');
-		else
-			$wallmessage = false;
-
-		// show edit profile to yourself
-		if ($profile['uid'] == local_user() && feature_enabled(local_user(),'multi_profiles')) {
-			$profile['edit'] = array($a->get_baseurl(). '/profiles', t('Profiles'),"", t('Manage/edit profiles'));
-			$r = q("SELECT * FROM `profile` WHERE `uid` = %d",
-					local_user());
-
-			$profile['menu'] = array(
-				'chg_photo' => t('Change profile photo'),
-				'cr_new' => t('Create New Profile'),
-				'entries' => array(),
-			);
+	if ($connect AND ($profile['network'] == NETWORK_DFRN) AND !isset($remoteconnect))
+		$subscribe_feed = t("Atom feed");
+	else
+		$subscribe_feed = false;
 
-			if(count($r)) {
+	if(get_my_url() && $profile['unkmail'] && ($profile['uid'] != local_user()))
+		$wallmessage = t('Message');
+	else
+		$wallmessage = false;
 
-				foreach($r as $rr) {
-					$profile['menu']['entries'][] = array(
-						'photo' => $rr['thumb'],
-						'id' => $rr['id'],
-						'alt' => t('Profile Image'),
-						'profile_name' => $rr['profile-name'],
-						'isdefault' => $rr['is-default'],
-						'visibile_to_everybody' =>  t('visible to everybody'),
-						'edit_visibility' => t('Edit visibility'),
+	// show edit profile to yourself
+	if ($profile['uid'] == local_user() && feature_enabled(local_user(),'multi_profiles')) {
+		$profile['edit'] = array($a->get_baseurl(). '/profiles', t('Profiles'),"", t('Manage/edit profiles'));
+		$r = q("SELECT * FROM `profile` WHERE `uid` = %d",
+				local_user());
 
-					);
-				}
+		$profile['menu'] = array(
+			'chg_photo' => t('Change profile photo'),
+			'cr_new' => t('Create New Profile'),
+			'entries' => array(),
+		);
+
+		if(count($r)) {
 
+			foreach($r as $rr) {
+				$profile['menu']['entries'][] = array(
+					'photo' => $rr['thumb'],
+					'id' => $rr['id'],
+					'alt' => t('Profile Image'),
+					'profile_name' => $rr['profile-name'],
+					'isdefault' => $rr['is-default'],
+					'visibile_to_everybody' =>  t('visible to everybody'),
+					'edit_visibility' => t('Edit visibility'),
 
+				);
 			}
-		}
-		if ($profile['uid'] == local_user() && !feature_enabled(local_user(),'multi_profiles')) {
-			$profile['edit'] = array($a->get_baseurl(). '/profiles/'.$profile['id'], t('Edit profile'),"", t('Edit profile'));
-			$profile['menu'] = array(
-				'chg_photo' => t('Change profile photo'),
-				'cr_new' => null,
-				'entries' => array(),
-			);
-		}
 
-		// check if profile is a forum
-		if((intval($profile['page-flags']) == PAGE_COMMUNITY)
-				|| (intval($profile['page-flags']) == PAGE_PRVGROUP)
-				|| (intval($profile['forum']))
-				|| (intval($profile['prv']))
-				|| (intval($profile['community'])))
-			$account_type = t('Forum');
-		else
-			$account_type = "";
 
-		if((x($profile,'address') == 1)
-				|| (x($profile,'locality') == 1)
-				|| (x($profile,'region') == 1)
-				|| (x($profile,'postal-code') == 1)
-				|| (x($profile,'country-name') == 1))
-			$location = t('Location:');
+		}
+	}
+	if ($profile['uid'] == local_user() && !feature_enabled(local_user(),'multi_profiles')) {
+		$profile['edit'] = array($a->get_baseurl(). '/profiles/'.$profile['id'], t('Edit profile'),"", t('Edit profile'));
+		$profile['menu'] = array(
+			'chg_photo' => t('Change profile photo'),
+			'cr_new' => null,
+			'entries' => array(),
+		);
+	}
 
-		$gender = ((x($profile,'gender') == 1) ? t('Gender:') : False);
+	// check if profile is a forum
+	if((intval($profile['page-flags']) == PAGE_COMMUNITY)
+			|| (intval($profile['page-flags']) == PAGE_PRVGROUP)
+			|| (intval($profile['forum']))
+			|| (intval($profile['prv']))
+			|| (intval($profile['community'])))
+		$account_type = t('Forum');
+	else
+		$account_type = "";
 
+	if((x($profile,'address') == 1)
+			|| (x($profile,'locality') == 1)
+			|| (x($profile,'region') == 1)
+			|| (x($profile,'postal-code') == 1)
+			|| (x($profile,'country-name') == 1))
+		$location = t('Location:');
 
-		$marital = ((x($profile,'marital') == 1) ?  t('Status:') : False);
+	$gender = ((x($profile,'gender') == 1) ? t('Gender:') : False);
 
-		$homepage = ((x($profile,'homepage') == 1) ?  t('Homepage:') : False);
 
-		$about = ((x($profile,'about') == 1) ?  t('About:') : False);
+	$marital = ((x($profile,'marital') == 1) ?  t('Status:') : False);
 
-		if(($profile['hidewall'] || $block) && (! local_user()) && (! remote_user())) {
-			$location = $pdesc = $gender = $marital = $homepage = $about = False;
-		}
+	$homepage = ((x($profile,'homepage') == 1) ?  t('Homepage:') : False);
 
-		$firstname = ((strpos($profile['name'],' '))
-				? trim(substr($profile['name'],0,strpos($profile['name'],' '))) : $profile['name']);
-		$lastname = (($firstname === $profile['name']) ? '' : trim(substr($profile['name'],strlen($firstname))));
-
-		$diaspora = array(
-			'guid' => $profile['guid'],
-			'podloc' => $a->get_baseurl(),
-			'searchable' => (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false' ),
-			'nickname' => $profile['nickname'],
-			'fullname' => $profile['name'],
-			'firstname' => $firstname,
-			'lastname' => $lastname,
-			'photo300' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/300/' . $profile['uid'] . '.jpg'),
-			'photo100' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/100/' . $profile['uid'] . '.jpg'),
-			'photo50' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/50/'  . $profile['uid'] . '.jpg'),
-		);
+	$about = ((x($profile,'about') == 1) ?  t('About:') : False);
 
-		if (!$block){
-			$contact_block = contact_block();
-
-			if(is_array($a->profile) AND !$a->profile['hide-friends']) {
-				$r = q("SELECT `gcontact`.`updated` FROM `contact` INNER JOIN `gcontact` WHERE `gcontact`.`nurl` = `contact`.`nurl` AND `self` AND `uid` = %d LIMIT 1",
-					intval($a->profile['uid']));
-				if(count($r))
-					$updated =  date("c", strtotime($r[0]['updated']));
-
-				$r = q("SELECT COUNT(*) AS `total` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 AND `pending` = 0 AND `hidden` = 0 AND `archive` = 0
-						AND `network` IN ('%s', '%s', '%s', '')",
-					intval($profile['uid']),
-					dbesc(NETWORK_DFRN),
-					dbesc(NETWORK_DIASPORA),
-					dbesc(NETWORK_OSTATUS)
-				);
-				if(count($r))
-					$contacts = intval($r[0]['total']);
-			}
-		}
+	if(($profile['hidewall'] || $block) && (! local_user()) && (! remote_user())) {
+		$location = $pdesc = $gender = $marital = $homepage = $about = False;
+	}
 
-		$p = array();
-		foreach($profile as $k => $v) {
-			$k = str_replace('-','_',$k);
-			$p[$k] = $v;
+	$firstname = ((strpos($profile['name'],' '))
+			? trim(substr($profile['name'],0,strpos($profile['name'],' '))) : $profile['name']);
+	$lastname = (($firstname === $profile['name']) ? '' : trim(substr($profile['name'],strlen($firstname))));
+
+	$diaspora = array(
+		'guid' => $profile['guid'],
+		'podloc' => $a->get_baseurl(),
+		'searchable' => (($profile['publish'] && $profile['net-publish']) ? 'true' : 'false' ),
+		'nickname' => $profile['nickname'],
+		'fullname' => $profile['name'],
+		'firstname' => $firstname,
+		'lastname' => $lastname,
+		'photo300' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/300/' . $profile['uid'] . '.jpg'),
+		'photo100' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/100/' . $profile['uid'] . '.jpg'),
+		'photo50' => $a->get_cached_avatar_image($a->get_baseurl() . '/photo/custom/50/'  . $profile['uid'] . '.jpg'),
+	);
+
+	if (!$block){
+		$contact_block = contact_block();
+
+		if(is_array($a->profile) AND !$a->profile['hide-friends']) {
+			$r = q("SELECT `gcontact`.`updated` FROM `contact` INNER JOIN `gcontact` WHERE `gcontact`.`nurl` = `contact`.`nurl` AND `self` AND `uid` = %d LIMIT 1",
+				intval($a->profile['uid']));
+			if(count($r))
+				$updated =  date("c", strtotime($r[0]['updated']));
+
+			$r = q("SELECT COUNT(*) AS `total` FROM `contact` WHERE `uid` = %d AND `self` = 0 AND `blocked` = 0 AND `pending` = 0 AND `hidden` = 0 AND `archive` = 0
+					AND `network` IN ('%s', '%s', '%s', '')",
+				intval($profile['uid']),
+				dbesc(NETWORK_DFRN),
+				dbesc(NETWORK_DIASPORA),
+				dbesc(NETWORK_OSTATUS)
+			);
+			if(count($r))
+				$contacts = intval($r[0]['total']);
 		}
+	}
+
+	$p = array();
+	foreach($profile as $k => $v) {
+		$k = str_replace('-','_',$k);
+		$p[$k] = $v;
+	}
 
-		if (isset($p["about"]))
-			$p["about"] = bbcode($p["about"]);
+	if (isset($p["about"]))
+		$p["about"] = bbcode($p["about"]);
 
-		if (isset($p["location"]))
-			$p["location"] = bbcode($p["location"]);
+	if (isset($p["location"]))
+		$p["location"] = bbcode($p["location"]);
 
-		if (isset($p["photo"]))
-			$p["photo"] = proxy_url($p["photo"], false, PROXY_SIZE_SMALL);
+	if (isset($p["photo"]))
+		$p["photo"] = proxy_url($p["photo"], false, PROXY_SIZE_SMALL);
 
-		if($a->theme['template_engine'] === 'internal')
-			$location = template_escape($location);
+	if($a->theme['template_engine'] === 'internal')
+		$location = template_escape($location);
 
-		$tpl = get_markup_template('profile_vcard.tpl');
-		$o .= replace_macros($tpl, array(
-			'$profile' => $p,
-			'$connect'  => $connect,
-			'$remoteconnect'  => $remoteconnect,
-			'$subscribe_feed' => $subscribe_feed,
-			'$wallmessage' => $wallmessage,
-			'$account_type' => $account_type,
-			'$location' => $location,
-			'$gender'   => $gender,
+	$tpl = get_markup_template('profile_vcard.tpl');
+	$o .= replace_macros($tpl, array(
+		'$profile' => $p,
+		'$connect'  => $connect,
+		'$remoteconnect'  => $remoteconnect,
+		'$subscribe_feed' => $subscribe_feed,
+		'$wallmessage' => $wallmessage,
+		'$account_type' => $account_type,
+		'$location' => $location,
+		'$gender'   => $gender,
 //			'$pdesc'	=> $pdesc,
-			'$marital'  => $marital,
-			'$homepage' => $homepage,
-			'$about' => $about,
-			'$network' =>  t('Network:'),
-			'$contacts' => $contacts,
-			'$updated' => $updated,
-			'$diaspora' => $diaspora,
-			'$contact_block' => $contact_block,
-		));
+		'$marital'  => $marital,
+		'$homepage' => $homepage,
+		'$about' => $about,
+		'$network' =>  t('Network:'),
+		'$contacts' => $contacts,
+		'$updated' => $updated,
+		'$diaspora' => $diaspora,
+		'$contact_block' => $contact_block,
+	));
 
 
-		$arr = array('profile' => &$profile, 'entry' => &$o);
+	$arr = array('profile' => &$profile, 'entry' => &$o);
 
-		call_hooks('profile_sidebar', $arr);
+	call_hooks('profile_sidebar', $arr);
 
-		return $o;
-	}
+	return $o;
 }
 
 
-if(! function_exists('get_birthdays')) {
-	function get_birthdays() {
+function get_birthdays() {
 
-		$a = get_app();
-		$o = '';
+	$a = get_app();
+	$o = '';
 
-		if(! local_user() || $a->is_mobile || $a->is_tablet)
-			return $o;
+	if(! local_user() || $a->is_mobile || $a->is_tablet)
+		return $o;
 
 //		$mobile_detect = new Mobile_Detect();
 //		$is_mobile = $mobile_detect->isMobile() || $mobile_detect->isTablet();
@@ -418,84 +414,82 @@ if(! function_exists('get_birthdays')) {
 //		if($is_mobile)
 //			return $o;
 
-		$bd_format = t('g A l F d') ; // 8 AM Friday January 18
-		$bd_short = t('F d');
+	$bd_format = t('g A l F d') ; // 8 AM Friday January 18
+	$bd_short = t('F d');
+
+	$r = q("SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
+			INNER JOIN `contact` ON `contact`.`id` = `event`.`cid`
+			WHERE `event`.`uid` = %d AND `type` = 'birthday' AND `start` < '%s' AND `finish` > '%s'
+			ORDER BY `start` ASC ",
+			intval(local_user()),
+			dbesc(datetime_convert('UTC','UTC','now + 6 days')),
+			dbesc(datetime_convert('UTC','UTC','now'))
+	);
+
+	if($r && count($r)) {
+		$total = 0;
+		$now = strtotime('now');
+		$cids = array();
+
+		$istoday = false;
+		foreach($r as $rr) {
+			if(strlen($rr['name']))
+				$total ++;
+			if((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now))
+				$istoday = true;
+		}
+		$classtoday = $istoday ? ' birthday-today ' : '';
+		if($total) {
+			foreach($r as &$rr) {
+				if(! strlen($rr['name']))
+					continue;
 
-		$r = q("SELECT `event`.*, `event`.`id` AS `eid`, `contact`.* FROM `event`
-				INNER JOIN `contact` ON `contact`.`id` = `event`.`cid`
-				WHERE `event`.`uid` = %d AND `type` = 'birthday' AND `start` < '%s' AND `finish` > '%s'
-				ORDER BY `start` ASC ",
-				intval(local_user()),
-				dbesc(datetime_convert('UTC','UTC','now + 6 days')),
-				dbesc(datetime_convert('UTC','UTC','now'))
-		);
+				// avoid duplicates
 
-		if($r && count($r)) {
-			$total = 0;
-			$now = strtotime('now');
-			$cids = array();
+				if(in_array($rr['cid'],$cids))
+					continue;
+				$cids[] = $rr['cid'];
+
+				$today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
+				$sparkle = '';
+				$url = $rr['url'];
+				if($rr['network'] === NETWORK_DFRN) {
+					$sparkle = " sparkle";
+					$url = $a->get_baseurl() . '/redir/'  . $rr['cid'];
+				}
 
-			$istoday = false;
-			foreach($r as $rr) {
-				if(strlen($rr['name']))
-					$total ++;
-				if((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now))
-					$istoday = true;
-			}
-			$classtoday = $istoday ? ' birthday-today ' : '';
-			if($total) {
-				foreach($r as &$rr) {
-					if(! strlen($rr['name']))
-						continue;
-
-					// avoid duplicates
-
-					if(in_array($rr['cid'],$cids))
-						continue;
-					$cids[] = $rr['cid'];
-
-					$today = (((strtotime($rr['start'] . ' +00:00') < $now) && (strtotime($rr['finish'] . ' +00:00') > $now)) ? true : false);
-					$sparkle = '';
-					$url = $rr['url'];
-					if($rr['network'] === NETWORK_DFRN) {
-						$sparkle = " sparkle";
-						$url = $a->get_baseurl() . '/redir/'  . $rr['cid'];
-					}
-
-					$rr['link'] = $url;
-					$rr['title'] = $rr['name'];
-					$rr['date'] = day_translate(datetime_convert('UTC', $a->timezone, $rr['start'], $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ?  ' ' . t('[today]') : '');
-					$rr['startime'] = Null;
-					$rr['today'] = $today;
+				$rr['link'] = $url;
+				$rr['title'] = $rr['name'];
+				$rr['date'] = day_translate(datetime_convert('UTC', $a->timezone, $rr['start'], $rr['adjust'] ? $bd_format : $bd_short)) . (($today) ?  ' ' . t('[today]') : '');
+				$rr['startime'] = Null;
+				$rr['today'] = $today;
 
-				}
 			}
 		}
-		$tpl = get_markup_template("birthdays_reminder.tpl");
-		return replace_macros($tpl, array(
-			'$baseurl' => $a->get_baseurl(),
-			'$classtoday' => $classtoday,
-			'$count' => $total,
-			'$event_reminders' => t('Birthday Reminders'),
-			'$event_title' => t('Birthdays this week:'),
-			'$events' => $r,
-			'$lbr' => '{',  // raw brackets mess up if/endif macro processing
-			'$rbr' => '}'
-
-		));
 	}
+	$tpl = get_markup_template("birthdays_reminder.tpl");
+	return replace_macros($tpl, array(
+		'$baseurl' => $a->get_baseurl(),
+		'$classtoday' => $classtoday,
+		'$count' => $total,
+		'$event_reminders' => t('Birthday Reminders'),
+		'$event_title' => t('Birthdays this week:'),
+		'$events' => $r,
+		'$lbr' => '{',  // raw brackets mess up if/endif macro processing
+		'$rbr' => '}'
+
+	));
 }
 
 
-if(! function_exists('get_events')) {
-	function get_events() {
+function get_events() {
 
-		require_once('include/bbcode.php');
+	require_once('include/bbcode.php');
 
-		$a = get_app();
+	$a = get_app();
 
-		if(! local_user() || $a->is_mobile || $a->is_tablet)
-			return $o;
+	if(! local_user() || $a->is_mobile || $a->is_tablet)
+		return $o;
 
 
 //		$mobile_detect = new Mobile_Detect();
@@ -504,69 +498,68 @@ if(! function_exists('get_events')) {
 //		if($is_mobile)
 //			return $o;
 
-		$bd_format = t('g A l F d') ; // 8 AM Friday January 18
-		$bd_short = t('F d');
-
-		$r = q("SELECT `event`.* FROM `event`
-				WHERE `event`.`uid` = %d AND `type` != 'birthday' AND `start` < '%s' AND `start` >= '%s'
-				ORDER BY `start` ASC ",
-				intval(local_user()),
-				dbesc(datetime_convert('UTC','UTC','now + 7 days')),
-				dbesc(datetime_convert('UTC','UTC','now - 1 days'))
-		);
-
-		if($r && count($r)) {
-			$now = strtotime('now');
-			$istoday = false;
-			foreach($r as $rr) {
-				if(strlen($rr['name']))
-					$total ++;
-
-				$strt = datetime_convert('UTC',$rr['convert'] ? $a->timezone : 'UTC',$rr['start'],'Y-m-d');
-				if($strt === datetime_convert('UTC',$a->timezone,'now','Y-m-d'))
-					$istoday = true;
-			}
-			$classtoday = (($istoday) ? 'event-today' : '');
+	$bd_format = t('g A l F d') ; // 8 AM Friday January 18
+	$bd_short = t('F d');
+
+	$r = q("SELECT `event`.* FROM `event`
+			WHERE `event`.`uid` = %d AND `type` != 'birthday' AND `start` < '%s' AND `start` >= '%s'
+			ORDER BY `start` ASC ",
+			intval(local_user()),
+			dbesc(datetime_convert('UTC','UTC','now + 7 days')),
+			dbesc(datetime_convert('UTC','UTC','now - 1 days'))
+	);
+
+	if($r && count($r)) {
+		$now = strtotime('now');
+		$istoday = false;
+		foreach($r as $rr) {
+			if(strlen($rr['name']))
+				$total ++;
+
+			$strt = datetime_convert('UTC',$rr['convert'] ? $a->timezone : 'UTC',$rr['start'],'Y-m-d');
+			if($strt === datetime_convert('UTC',$a->timezone,'now','Y-m-d'))
+				$istoday = true;
+		}
+		$classtoday = (($istoday) ? 'event-today' : '');
 
-			$skip = 0;
+		$skip = 0;
 
-			foreach($r as &$rr) {
-				$title = strip_tags(html_entity_decode(bbcode($rr['summary']),ENT_QUOTES,'UTF-8'));
+		foreach($r as &$rr) {
+			$title = strip_tags(html_entity_decode(bbcode($rr['summary']),ENT_QUOTES,'UTF-8'));
 
-				if(strlen($title) > 35)
-					$title = substr($title,0,32) . '... ';
+			if(strlen($title) > 35)
+				$title = substr($title,0,32) . '... ';
 
-				$description = substr(strip_tags(bbcode($rr['desc'])),0,32) . '... ';
-				if(! $description)
-					$description = t('[No description]');
+			$description = substr(strip_tags(bbcode($rr['desc'])),0,32) . '... ';
+			if(! $description)
+				$description = t('[No description]');
 
-				$strt = datetime_convert('UTC',$rr['convert'] ? $a->timezone : 'UTC',$rr['start']);
+			$strt = datetime_convert('UTC',$rr['convert'] ? $a->timezone : 'UTC',$rr['start']);
 
-				if(substr($strt,0,10) < datetime_convert('UTC',$a->timezone,'now','Y-m-d')) {
-					$skip++;
-					continue;
-				}
+			if(substr($strt,0,10) < datetime_convert('UTC',$a->timezone,'now','Y-m-d')) {
+				$skip++;
+				continue;
+			}
 
-				$today = ((substr($strt,0,10) === datetime_convert('UTC',$a->timezone,'now','Y-m-d')) ? true : false);
+			$today = ((substr($strt,0,10) === datetime_convert('UTC',$a->timezone,'now','Y-m-d')) ? true : false);
 
-				$rr['title'] = $title;
-				$rr['description'] = $desciption;
-				$rr['date'] = day_translate(datetime_convert('UTC', $rr['adjust'] ? $a->timezone : 'UTC', $rr['start'], $bd_format)) . (($today) ?  ' ' . t('[today]') : '');
-				$rr['startime'] = $strt;
-				$rr['today'] = $today;
-			}
+			$rr['title'] = $title;
+			$rr['description'] = $desciption;
+			$rr['date'] = day_translate(datetime_convert('UTC', $rr['adjust'] ? $a->timezone : 'UTC', $rr['start'], $bd_format)) . (($today) ?  ' ' . t('[today]') : '');
+			$rr['startime'] = $strt;
+			$rr['today'] = $today;
 		}
-
-		$tpl = get_markup_template("events_reminder.tpl");
-		return replace_macros($tpl, array(
-			'$baseurl' => $a->get_baseurl(),
-			'$classtoday' => $classtoday,
-			'$count' => count($r) - $skip,
-			'$event_reminders' => t('Event Reminders'),
-			'$event_title' => t('Events this week:'),
-			'$events' => $r,
-		));
 	}
+
+	$tpl = get_markup_template("events_reminder.tpl");
+	return replace_macros($tpl, array(
+		'$baseurl' => $a->get_baseurl(),
+		'$classtoday' => $classtoday,
+		'$count' => count($r) - $skip,
+		'$event_reminders' => t('Event Reminders'),
+		'$event_title' => t('Events this week:'),
+		'$events' => $r,
+	));
 }
 
 function advanced_profile(&$a) {
@@ -669,91 +662,89 @@ function advanced_profile(&$a) {
 	return '';
 }
 
-if(! function_exists('profile_tabs')){
-	function profile_tabs($a, $is_owner=False, $nickname=Null){
-		//echo "<pre>"; var_dump($a->user); killme();
-
-		if (is_null($nickname))
-			$nickname  = $a->user['nickname'];
-
-		if(x($_GET,'tab'))
-			$tab = notags(trim($_GET['tab']));
-
-		$url = $a->get_baseurl() . '/profile/' . $nickname;
-
-		$tabs = array(
-			array(
-				'label'=>t('Status'),
-				'url' => $url,
-				'sel' => ((!isset($tab)&&$a->argv[0]=='profile')?'active':''),
-				'title' => t('Status Messages and Posts'),
-				'id' => 'status-tab',
-				'accesskey' => 'm',
-			),
-			array(
-				'label' => t('Profile'),
-				'url' 	=> $url.'/?tab=profile',
-				'sel'	=> ((isset($tab) && $tab=='profile')?'active':''),
-				'title' => t('Profile Details'),
-				'id' => 'profile-tab',
-				'accesskey' => 'r',
-			),
-			array(
-				'label' => t('Photos'),
-				'url'	=> $a->get_baseurl() . '/photos/' . $nickname,
-				'sel'	=> ((!isset($tab)&&$a->argv[0]=='photos')?'active':''),
-				'title' => t('Photo Albums'),
-				'id' => 'photo-tab',
-				'accesskey' => 'h',
-			),
-			array(
-				'label' => t('Videos'),
-				'url'	=> $a->get_baseurl() . '/videos/' . $nickname,
-				'sel'	=> ((!isset($tab)&&$a->argv[0]=='videos')?'active':''),
-				'title' => t('Videos'),
-				'id' => 'video-tab',
-				'accesskey' => 'v',
-			),
-		);
-
-		if ($is_owner){
-			if ($a->theme_events_in_profile)
-				$tabs[] = array(
-					'label' => t('Events'),
-					'url'	=> $a->get_baseurl() . '/events',
-					'sel' 	=>((!isset($tab)&&$a->argv[0]=='events')?'active':''),
-					'title' => t('Events and Calendar'),
-					'id' => 'events-tab',
-					'accesskey' => 'e',
-				);
+function profile_tabs($a, $is_owner=False, $nickname=Null){
+	//echo "<pre>"; var_dump($a->user); killme();
+
+	if (is_null($nickname))
+		$nickname  = $a->user['nickname'];
+
+	if(x($_GET,'tab'))
+		$tab = notags(trim($_GET['tab']));
+
+	$url = $a->get_baseurl() . '/profile/' . $nickname;
+
+	$tabs = array(
+		array(
+			'label'=>t('Status'),
+			'url' => $url,
+			'sel' => ((!isset($tab)&&$a->argv[0]=='profile')?'active':''),
+			'title' => t('Status Messages and Posts'),
+			'id' => 'status-tab',
+			'accesskey' => 'm',
+		),
+		array(
+			'label' => t('Profile'),
+			'url' 	=> $url.'/?tab=profile',
+			'sel'	=> ((isset($tab) && $tab=='profile')?'active':''),
+			'title' => t('Profile Details'),
+			'id' => 'profile-tab',
+			'accesskey' => 'r',
+		),
+		array(
+			'label' => t('Photos'),
+			'url'	=> $a->get_baseurl() . '/photos/' . $nickname,
+			'sel'	=> ((!isset($tab)&&$a->argv[0]=='photos')?'active':''),
+			'title' => t('Photo Albums'),
+			'id' => 'photo-tab',
+			'accesskey' => 'h',
+		),
+		array(
+			'label' => t('Videos'),
+			'url'	=> $a->get_baseurl() . '/videos/' . $nickname,
+			'sel'	=> ((!isset($tab)&&$a->argv[0]=='videos')?'active':''),
+			'title' => t('Videos'),
+			'id' => 'video-tab',
+			'accesskey' => 'v',
+		),
+	);
+
+	if ($is_owner){
+		if ($a->theme_events_in_profile)
 			$tabs[] = array(
-				'label' => t('Personal Notes'),
-				'url'	=> $a->get_baseurl() . '/notes',
-				'sel' 	=>((!isset($tab)&&$a->argv[0]=='notes')?'active':''),
-				'title' => t('Only You Can See This'),
-				'id' => 'notes-tab',
-				'accesskey' => 't',
+				'label' => t('Events'),
+				'url'	=> $a->get_baseurl() . '/events',
+				'sel' 	=>((!isset($tab)&&$a->argv[0]=='events')?'active':''),
+				'title' => t('Events and Calendar'),
+				'id' => 'events-tab',
+				'accesskey' => 'e',
 			);
-		}
+		$tabs[] = array(
+			'label' => t('Personal Notes'),
+			'url'	=> $a->get_baseurl() . '/notes',
+			'sel' 	=>((!isset($tab)&&$a->argv[0]=='notes')?'active':''),
+			'title' => t('Only You Can See This'),
+			'id' => 'notes-tab',
+			'accesskey' => 't',
+		);
+	}
 
-		if ((! $is_owner) && ((count($a->profile)) || (! $a->profile['hide-friends']))) {
-			$tabs[] = array(
-				'label' => t('Contacts'),
-				'url'	=> $a->get_baseurl() . '/viewcontacts/' . $nickname,
-				'sel'	=> ((!isset($tab)&&$a->argv[0]=='viewcontacts')?'active':''),
-				'title' => t('Contacts'),
-				'id' => 'viewcontacts-tab',
-				'accesskey' => 'k',
-			);
-		}
+	if ((! $is_owner) && ((count($a->profile)) || (! $a->profile['hide-friends']))) {
+		$tabs[] = array(
+			'label' => t('Contacts'),
+			'url'	=> $a->get_baseurl() . '/viewcontacts/' . $nickname,
+			'sel'	=> ((!isset($tab)&&$a->argv[0]=='viewcontacts')?'active':''),
+			'title' => t('Contacts'),
+			'id' => 'viewcontacts-tab',
+			'accesskey' => 'k',
+		);
+	}
 
-		$arr = array('is_owner' => $is_owner, 'nickname' => $nickname, 'tab' => (($tab) ? $tab : false), 'tabs' => $tabs);
-		call_hooks('profile_tabs', $arr);
+	$arr = array('is_owner' => $is_owner, 'nickname' => $nickname, 'tab' => (($tab) ? $tab : false), 'tabs' => $tabs);
+	call_hooks('profile_tabs', $arr);
 
-		$tpl = get_markup_template('common_tabs.tpl');
+	$tpl = get_markup_template('common_tabs.tpl');
 
-		return replace_macros($tpl,array('$tabs' => $arr['tabs']));
-	}
+	return replace_macros($tpl,array('$tabs' => $arr['tabs']));
 }
 
 function get_my_url() {
@@ -799,12 +790,20 @@ function zrl($s,$force = false) {
 	return $s;
 }
 
-// Used from within PCSS themes to set theme parameters. If there's a
-// puid request variable, that is the "page owner" and normally their theme
-// settings take precedence; unless a local user sets the "always_my_theme"
-// system pconfig, which means they don't want to see anybody else's theme
-// settings except their own while on this site.
-
+/**
+ * @brief Get the user ID of the page owner
+ *
+ * Used from within PCSS themes to set theme parameters. If there's a
+ * puid request variable, that is the "page owner" and normally their theme
+ * settings take precedence; unless a local user sets the "always_my_theme"
+ * system pconfig, which means they don't want to see anybody else's theme
+ * settings except their own while on this site.
+ *
+ * @return int user ID
+ * 
+ * @note Returns local_user instead of user ID if "always_my_theme"
+ *      is set to true
+ */
 function get_theme_uid() {
 	$uid = (($_REQUEST['puid']) ? intval($_REQUEST['puid']) : 0);
 	if(local_user()) {
diff --git a/include/plugin.php b/include/plugin.php
index 965b823b02..2cb94b3504 100644
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @file include/identity.php
+ * @file include/plugin.php
  * 
  * @brief Some functions to handle addons and themes.
  */
-- 
2.39.5