From 96deae43faed34878da136846257e531c3133f46 Mon Sep 17 00:00:00 2001
From: zotlabs <mike@macgirvin.com>
Date: Thu, 17 Jan 2019 11:47:55 -0800
Subject: this should fix the rest of the event stuff

---
 include/event.php | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

(limited to 'include')

diff --git a/include/event.php b/include/event.php
index a34250e7a..fdb9e1415 100644
--- a/include/event.php
+++ b/include/event.php
@@ -6,6 +6,10 @@
 
 use Sabre\VObject;
 
+use Ramsey\Uuid\Uuid;
+use Ramsey\Uuid\Exception\UnsatisfiedDependencyException;
+
+
 require_once('include/bbcode.php');
 
 /**
@@ -463,8 +467,13 @@ function event_store_event($arr) {
 			$hash = $arr['external_id'];
 		elseif(array_key_exists('event_hash',$arr))
 			$hash = $arr['event_hash'];
-		else
-			$hash = random_string() . '@' . App::get_hostname();
+		else {
+			try {
+				$hash = Uuid::uuid4()->toString();
+			} catch (UnsatisfiedDependencyException $e) {
+				$hash = random_string(48);
+			}
+		}
 
 		$r = q("INSERT INTO event ( uid,aid,event_xchan,event_hash,created,edited,dtstart,dtend,summary,description,location,etype,
 			adjust,nofinish, event_status, event_status_date, event_percent, event_repeat, event_sequence, event_priority, event_vdata, allow_cid,allow_gid,deny_cid,deny_gid)
@@ -1126,8 +1135,8 @@ function event_store_item($arr, $event) {
 		}
 
 		if(! $arr['mid']) {
-			$arr['uuid'] = item_message_id();
-			$arr['mid'] = z_root() . '/item/' . $arr['uuid'];
+			$arr['uuid'] = $event['event_hash'];
+			$arr['mid'] = z_root() . '/event/' . $event['event_hash'];
 		}
 
 		$item_arr['aid']             = $z[0]['channel_account_id'];
-- 
cgit v1.2.3


From 66f443fd00d3da9df0104e9ed2485d902767fe41 Mon Sep 17 00:00:00 2001
From: Max Kostikov <max@kostikov.co>
Date: Tue, 22 Jan 2019 16:23:44 +0100
Subject: Skip tags detection in URL

---
 include/text.php | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'include')

diff --git a/include/text.php b/include/text.php
index 3cc21e4ce..7d253e3d7 100644
--- a/include/text.php
+++ b/include/text.php
@@ -825,6 +825,9 @@ function get_tags($s) {
 
 	// ignore anything in [color= ], because it may contain color codes which are mistaken for tags
 	$s = preg_replace('/\[color=(.*?)\]/sm','',$s);
+	
+	// skip anchors in URL
+	$s = preg_replace('/\[url=(.*?)\]/sm','',$s);
 
 	// match any double quoted tags
 
-- 
cgit v1.2.3


From ae538a225942e61256db246431bb9c6f902ba7fa Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Tue, 22 Jan 2019 23:25:30 +0100
Subject: Correct parameter in include/text.php prepare_text()

Also extend documentation.
---
 include/text.php | 61 +++++++++++++++++++++++++++++++-------------------------
 1 file changed, 34 insertions(+), 27 deletions(-)

(limited to 'include')

diff --git a/include/text.php b/include/text.php
index 26cb61977..d03d36741 100644
--- a/include/text.php
+++ b/include/text.php
@@ -983,7 +983,7 @@ function contact_block() {
 
 				// There is no setting to discover if you are bi-directionally connected
 				// Use the ability to post comments as an indication that this relationship is more
-				// than wishful thinking; even though soapbox channels and feeds will disable it. 
+				// than wishful thinking; even though soapbox channels and feeds will disable it.
 
 				if(! intval(get_abconfig(App::$profile['uid'],$rr['xchan_hash'],'their_perms','post_comments'))) {
 					$rr['oneway'] = true;
@@ -1109,19 +1109,19 @@ function linkify($s, $me = false) {
  * @returns string
  */
 function sslify($s) {
-	
+
 	// Local photo cache
 	$str = array(
 		'body' => $s,
 		'uid' => local_channel()
 	);
 	call_hooks('cache_body_hook', $str);
-	
+
 	$s = $str['body'];
 
 	if (strpos(z_root(),'https:') === false)
 		return $s;
-	
+
 	// By default we'll only sslify img tags because media files will probably choke.
 	// You can set sslify_everything if you want - but it will likely white-screen if it hits your php memory limit.
 	// The downside is that http: media files will likely be blocked by your browser
@@ -1452,7 +1452,7 @@ function theme_attachments(&$item) {
 		foreach($arr as $r) {
 
 			$icon = getIconFromType($r['type']);
-			
+
 			if($r['title'])
 				$label = urldecode(htmlspecialchars($r['title'], ENT_COMPAT, 'UTF-8'));
 
@@ -1729,17 +1729,24 @@ function prepare_binary($item) {
 
 
 /**
- * @brief Given a text string, convert from bbcode to html and add smilie icons.
+ * @brief Given a text string, convert from content_type to HTML.
  *
- * @param string $text
- * @param string $content_type (optional) default text/bbcode
- * @param boolean $cache (optional) default false
+ * Take a text in plain text, html, markdown, bbcode, PDL or PHP and prepare
+ * it to return HTML.
+ *
+ * In bbcode this function will add smilie icons.
  *
+ * @param string $text
+ * @param string $content_type (optional)
+ *  default 'text/bbcode', other values are 'text/plain', 'text/html',
+ *  'text/markdown', 'application/x-pdl', 'application/x-php'
+ * @param boolean|array $opts (optional)
+ *  default false, otherwise configuration array for bbcode()
  * @return string
+ *  The parsed $text as prepared HTML.
  */
 function prepare_text($text, $content_type = 'text/bbcode', $opts = false) {
 
-
 	switch($content_type) {
 		case 'text/plain':
 			$s = escape_tags($text);
@@ -1779,8 +1786,8 @@ function prepare_text($text, $content_type = 'text/bbcode', $opts = false) {
 		default:
 			require_once('include/bbcode.php');
 
-			if(stristr($text,'[nosmile]'))
-				$s = bbcode($text, [ 'cache' => $cache ]);
+			if(stristr($text, '[nosmile]'))
+				$s = bbcode($text, ((is_array($opts)) ? $opts : [] ));
 			else
 				$s = smilies(bbcode($text, ((is_array($opts)) ? $opts : [] )));
 
@@ -2140,7 +2147,7 @@ function legal_webbie($s) {
 		return '';
 
 	// WARNING: This regex may not work in a federated environment.
-	// You will probably want something like 
+	// You will probably want something like
 	// preg_replace('/([^a-z0-9\_])/','',strtolower($s));
 
 	$r = preg_replace('/([^a-z0-9\-\_])/','',strtolower($s));
@@ -2240,7 +2247,7 @@ function ids_to_querystr($arr,$idx = 'id',$quote = false) {
 
 /**
  * @brief array_elm_to_str($arr,$elm,$delim = ',') extract unique individual elements from an array of arrays and return them as a string separated by a delimiter
- * similar to ids_to_querystr, but allows a different delimiter instead of a db-quote option 
+ * similar to ids_to_querystr, but allows a different delimiter instead of a db-quote option
  * empty elements (evaluated after trim()) are ignored.
  * @param $arr array
  * @param $elm array key to extract from sub-array
@@ -2666,7 +2673,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 		// get the channel name
 		// First extract the name or name fragment we are going to replace
 
-		$name = substr($tag,(($exclusive) ? 2 : 1)); 
+		$name = substr($tag,(($exclusive) ? 2 : 1));
 		$newname = $name; // make a copy that we can mess with
 		$tagcid = 0;
 
@@ -2709,7 +2716,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 			// select anybody by full hubloc_addr
 
 			if((! $r) && strpos($newname,'@')) {
-				$r = q("SELECT * FROM xchan left join hubloc on xchan_hash = hubloc_hash 
+				$r = q("SELECT * FROM xchan left join hubloc on xchan_hash = hubloc_hash
 					WHERE hubloc_addr = '%s' LIMIT 1",
 						dbesc($newname)
 				);
@@ -2730,7 +2737,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 		// $r is set if we found something
 
 		$channel = App::get_channel();
- 
+
 		if($r) {
 			$profile = $r[0]['xchan_url'];
 			$newname = $r[0]['xchan_name'];
@@ -2875,7 +2882,7 @@ function getIconFromType($type) {
 		'video/x-matroska' => 'fa-file-video-o'
 	);
 
-	$catMap = [ 
+	$catMap = [
 		'application' => 'fa-file-code-o',
 		'multipart'   => 'fa-folder',
 		'audio'       => 'fa-file-audio-o',
@@ -2883,7 +2890,7 @@ function getIconFromType($type) {
 		'text'        => 'fa-file-text-o',
 		'image'       => 'fa=file-picture-o',
 		'message'     => 'fa-file-text-o'
-	]; 
+	];
 
 
 	$iconFromType = '';
@@ -2893,7 +2900,7 @@ function getIconFromType($type) {
 	}
 	else {
 		$parts = explode('/',$type);
-		if($parts[0] && $catMap[$parts[0]]) { 
+		if($parts[0] && $catMap[$parts[0]]) {
 			$iconFromType = $catMap[$parts[0]];
 		}
 	}
@@ -3149,7 +3156,7 @@ function flatten_array_recursive($arr) {
  * @param string $lang Which language should be highlighted
  * @return string
  *     Important: The returned text has the text pattern 'http' translated to '%eY9-!' which should be converted back
- * after further processing. This was done to prevent oembed links from occurring inside code blocks. 
+ * after further processing. This was done to prevent oembed links from occurring inside code blocks.
  * See include/bbcode.php
  */
 function text_highlight($s, $lang) {
@@ -3383,7 +3390,7 @@ function unique_multidim_array($array, $key) {
     $temp_array = array();
     $i = 0;
     $key_array = array();
-   
+
     foreach($array as $val) {
         if (!in_array($val[$key], $key_array)) {
             $key_array[$i] = $val[$key];
@@ -3411,7 +3418,7 @@ function get_forum_channels($uid) {
 			intval($uid)
 		);
 
-		if($x2) { 
+		if($x2) {
 			$xf = ids_to_querystr($x2,'xchan',true);
 
 			// private forums
@@ -3424,7 +3431,7 @@ function get_forum_channels($uid) {
 		}
 	}
 
-	$sql_extra = (($xf) ? " and ( xchan_hash in (" . $xf . ") or xchan_pubforum = 1 ) " : " and xchan_pubforum = 1 "); 
+	$sql_extra = (($xf) ? " and ( xchan_hash in (" . $xf . ") or xchan_pubforum = 1 ) " : " and xchan_pubforum = 1 ");
 
 	$r = q("select abook_id, xchan_hash, xchan_name, xchan_url, xchan_addr, xchan_photo_s from abook left join xchan on abook_xchan = xchan_hash where xchan_deleted = 0 and abook_channel = %d and abook_pending = 0 and abook_ignored = 0 and abook_blocked = 0 and abook_archived = 0 $sql_extra order by xchan_name",
 		intval($uid)
@@ -3460,14 +3467,14 @@ function print_array($arr, $level = 0) {
 					$o .= $tabs . '[' . $k . '] => ' . print_array($v, $level + 1) . "\n";
 				}
 				else {
-					$o .= $tabs . '[' . $k . '] => ' . print_val($v) . ",\n";  
+					$o .= $tabs . '[' . $k . '] => ' . print_val($v) . ",\n";
 				}
 			}
 		}
 		$o .= substr($tabs,0,-1) . ']' . (($level) ? ',' : ';' ). "\n";
 		return $o;
 	}
-	
+
 }
 
 function print_val($v) {
@@ -3494,7 +3501,7 @@ function array_path_exists($str,$arr) {
 			}
 			else {
 				return false;
-			}			
+			}
 		}
 		return true;
 	}
-- 
cgit v1.2.3


From 13e0151cd2569832588cc9a973bcf40d850edd53 Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Fri, 18 Jan 2019 22:17:10 +0100
Subject: Correct and extend Doxygen comments.

Correct some documentation errors for Doxygen and add
more comments.
Document some undefined variables with @FIXME.
---
 include/attach.php    |  60 +++++++++++++--------
 include/feedutils.php |  20 ++++---
 include/help.php      |  30 ++++++-----
 include/import.php    |   9 ++--
 include/items.php     |  30 ++++++-----
 include/plugin.php    |  17 +++---
 include/text.php      | 147 +++++++++++++++++++++++++++++++++-----------------
 include/zot.php       |  22 ++++----
 8 files changed, 205 insertions(+), 130 deletions(-)

(limited to 'include')

diff --git a/include/attach.php b/include/attach.php
index dd718aa14..17a47d9ac 100644
--- a/include/attach.php
+++ b/include/attach.php
@@ -137,7 +137,7 @@ function z_mime_content_type($filename) {
  * @param string $hash (optional)
  * @param string $filename (optional)
  * @param string $filetype (optional)
- * @return associative array with:
+ * @return array Associative array with:
  *  * \e boolean \b success
  *  * \e int|boolean \b results amount of found results, or false
  *  * \e string \b message with error messages if any
@@ -176,15 +176,17 @@ function attach_count_files($channel_id, $observer, $hash = '', $filename = '',
 /**
  * @brief Returns a list of files/attachments.
  *
- * @param $channel_id
- * @param $observer
- * @param $hash (optional)
- * @param $filename (optional)
- * @param $filetype (optional)
- * @param $orderby
- * @param $start
- * @param $entries
- * @return associative array with:
+ * @param int $channel_id
+ * @param string $observer
+ * @param string $hash (optional)
+ * @param string $filename (optional)
+ * @param string $filetype (optional)
+ * @param string $orderby (optional)
+ * @param int $start (optional)
+ * @param int $entries (optional)
+ * @param string $since (optional)
+ * @param string $until (optional)
+ * @return array an associative array with:
  *  * \e boolean \b success
  *  * \e array|boolean \b results array with results, or false
  *  * \e string \b message with error messages if any
@@ -1428,8 +1430,17 @@ function attach_delete($channel_id, $resource, $is_photo = 0) {
 
 	if(! $r) {
 		attach_drop_photo($channel_id,$resource);
-                $arr = ['channel_id' => $channel_id, 'resource' => $resource, 'is_photo'=>$is_photo];
-                call_hooks("attach_delete",$arr);
+		$arr = ['channel_id' => $channel_id, 'resource' => $resource, 'is_photo' => $is_photo];
+
+		/**
+		 * @hooks attach_delete
+		 *   Called when deleting an attachment from channel.
+		 *   * \e int \b channel_id - the channel_id
+		 *   * \e string \b resource
+		 *   * \e int \b is_photo
+		 */
+		call_hooks('attach_delete', $arr);
+
 		return;
 	}
 
@@ -1488,8 +1499,15 @@ function attach_delete($channel_id, $resource, $is_photo = 0) {
 		intval($channel_id)
 	);
 
-        $arr = ['channel_id' => $channel_id, 'resource' => $resource, 'is_photo'=>$is_photo];
-        call_hooks("attach_delete",$arr);
+	$arr = ['channel_id' => $channel_id, 'resource' => $resource, 'is_photo' => $is_photo];
+	/**
+	 * @hooks attach_delete
+	 *   Called when deleting an attachment from channel.
+	 *   * \e int \b channel_id - the channel_id
+	 *   * \e string \b resource
+	 *   * \e int \b is_photo
+	 */
+	call_hooks('attach_delete', $arr);
 
 	file_activity($channel_id, $object, $object['allow_cid'], $object['allow_gid'], $object['deny_cid'], $object['deny_gid'], 'update', true);
 
@@ -1868,7 +1886,7 @@ function file_activity($channel_id, $object, $allow_cid, $allow_gid, $deny_cid,
  * @param int $channel_id
  * @param string $hash
  * @param string $url
- * @return array An associative array for the specified file.
+ * @return array Associative array for the specified file.
  */
 function get_file_activity_object($channel_id, $hash, $url) {
 
@@ -2110,7 +2128,7 @@ function attach_export_data($channel, $resource_id, $deleted = false) {
 
 	if($attach_ptr['is_photo']) {
 
-		// This query could potentially result in a few megabytes of data use.  
+		// This query could potentially result in a few megabytes of data use.
 
 		$r = q("select * from photo where resource_id = '%s' and uid = %d order by imgscale asc",
 			dbesc($resource_id),
@@ -2352,7 +2370,7 @@ function attach_move($channel_id, $resource_id, $new_folder_hash) {
 
 	$filename = $r[0]['filename'];
 
-	// don't do duplicate check unless our parent folder has changed. 
+	// don't do duplicate check unless our parent folder has changed.
 
 	if($r[0]['folder'] !== $new_folder_hash) {
 
@@ -2468,7 +2486,7 @@ function attach_move($channel_id, $resource_id, $new_folder_hash) {
 
 
 /**
- * Used to generate a select input box of all your folders 
+ * Used to generate a select input box of all your folders
  */
 
 
@@ -2551,10 +2569,10 @@ function attach_syspaths($channel_id,$attach_hash) {
 
 /**
  * in earlier releases we did not fill in os_path and display_path in the attach DB structure.
- * (It was not needed or used). Going forward we intend to make use of these fields. 
+ * (It was not needed or used). Going forward we intend to make use of these fields.
  * A cron task checks for empty values (as older attachments may have arrived at our site
- * in a clone operation) and executes attach_syspaths() to generate these field values and correct 
- * the attach table entry. The operation is limited to 100 DB entries at a time so as not to 
+ * in a clone operation) and executes attach_syspaths() to generate these field values and correct
+ * the attach table entry. The operation is limited to 100 DB entries at a time so as not to
  * overload the system in any cron run. Eventually it will catch up with old attach structures
  * and switch into maintenance mode to correct any that might arrive in clone packets from older
  * sites.
diff --git a/include/feedutils.php b/include/feedutils.php
index afbe4229e..5e52828c3 100644
--- a/include/feedutils.php
+++ b/include/feedutils.php
@@ -261,13 +261,13 @@ function construct_activity_target($item) {
  * @param SimplePie $item
  * @return array $author
  */
-
 function get_atom_author($feed, $item) {
 
 	$author = [];
 
 	$found_author = $item->get_author();
 	if($found_author) {
+		/// @FIXME $rawauthor is undefined here
 		if($rawauthor) {
 			if($rawauthor[0]['child'][NAMESPACE_POCO]['displayName'][0]['data'])
 				$author['full_name'] = unxmlify($rawauthor[0]['child'][NAMESPACE_POCO]['displayName'][0]['data']);
@@ -398,10 +398,10 @@ function get_atom_author($feed, $item) {
 			'author' => $author
 	];
 	/**
-	 * @hooks parse_atom
+	 * @hooks parse_atom_author
 	 *    * \e SimplePie \b feed - The original SimplePie feed
 	 *    * \e SimplePie \b item
-	 *    * \e array \b result - the result array that will also get returned
+	 *    * \e array \b author - the result array that will also get returned
 	 */
 	call_hooks('parse_atom_author', $arr);
 
@@ -416,10 +416,8 @@ function get_atom_author($feed, $item) {
  *
  * @param SimplePie $feed
  * @param SimplePie $item
- * @param[out] array $author
  * @return array Associative array with the parsed item data
  */
-
 function get_atom_elements($feed, $item) {
 
 	require_once('include/html2bbcode.php');
@@ -669,10 +667,10 @@ function get_atom_elements($feed, $item) {
 			$termterm = notags(trim(unxmlify($term)));
 
 			// Mastodon auto generates an nsfw category tag for any 'content-warning' message.
-			// Most people use CW and use both summary/content as a spoiler and we honour that 
-			// construct so the post will already be collapsed. The generated tag is almost 
+			// Most people use CW and use both summary/content as a spoiler and we honour that
+			// construct so the post will already be collapsed. The generated tag is almost
 			// always wrong and even if it isn't we would already be doing the right thing.
-	
+
 			if($mastodon && $termterm === 'nsfw' && $summary && $res['body'])
 				continue;
 
@@ -1336,7 +1334,7 @@ function consume_feed($xml, $importer, &$contact, $pass = 0) {
 						if( ! \Zotlabs\Lib\MessageFilter::evaluate($datarray,get_config('system','pubstream_incl'),get_config('system','pubstream_excl'))) {
 							continue;
 						}
-					}	
+					}
 
 					if(! post_is_importable($datarray, $contact))
 						continue;
@@ -1492,7 +1490,7 @@ function consume_feed($xml, $importer, &$contact, $pass = 0) {
 					if( ! \Zotlabs\Lib\MessageFilter::evaluate($datarray,get_config('system','pubstream_incl'),get_config('system','pubstream_excl'))) {
 						continue;
 					}
-				}	
+				}
 
 				if(! post_is_importable($datarray, $contact))
 					continue;
@@ -1900,7 +1898,7 @@ function atom_entry($item, $type, $author, $owner, $comment = false, $cid = 0, $
 
 	$body = $item['body'];
 
-	if($summary) 
+	if($summary)
 		$body = preg_replace('|^(.*?)\[summary\](.*?)\[/summary\](.*?)$|ism','$1$3',$item['body']);
 
 	if($compat)
diff --git a/include/help.php b/include/help.php
index 61dbc7bb3..e82fa96da 100644
--- a/include/help.php
+++ b/include/help.php
@@ -7,9 +7,10 @@ use \Michelf\MarkdownExtra;
  * @brief
  *
  * @param string $path
- * @return string|unknown
+ * @param string  $suffix (optional) default null
+ * @return string
  */
-function get_help_fullpath($path,$suffix=null) {
+function get_help_fullpath($path, $suffix = null) {
 
         $docroot = (\App::$override_helproot) ? \App::$override_helproot : 'doc/';
         $docroot = (substr($docroot,-1)!='/') ? $docroot .= '/' : $docroot;
@@ -49,8 +50,8 @@ function get_help_fullpath($path,$suffix=null) {
 /**
  * @brief
  *
- * @param string $tocpath
- * @return string|unknown
+ * @param string $tocpath (optional) default false
+ * @return string
  */
 function get_help_content($tocpath = false) {
 
@@ -171,16 +172,20 @@ function preg_callback_help_include($matches) {
 }
 
 /**
- * @brief
+ * @brief Determines help language.
+ *
+ * If the language was specified in the URL, override the language preference
+ * of the browser. Default to English if both of these are absent.
  *
- * @return boolean|array
+ * @return array Associative array with:
+ *  * \e string \b language -  2-letter ISO 639-1 code ("en")
+ *  * \e boolean \b from_url - true if language from URL overrides browser default
  */
 function determine_help_language() {
 	$lang_detect = new Text_LanguageDetect();
 	// Set this mode to recognize language by the short code like "en", "ru", etc.
 	$lang_detect->setNameMode(2);
-	// If the language was specified in the URL, override the language preference
-	// of the browser. Default to English if both of these are absent.
+
 	if($lang_detect->languageExists(argv(1))) {
 		$lang = argv(1);
 		$from_url = true;
@@ -211,10 +216,10 @@ function find_doc_file($s) {
 }
 
 /**
- * @brief
+ * @brief Search in doc files.
  *
- * @param string $s
- * @return number|mixed|unknown|boolean
+ * @param string $s The search string to search for
+ * @return array
  */
 function search_doc_files($s) {
 
@@ -275,7 +280,6 @@ function doc_rank_sort($s1, $s2) {
  *
  * @return string
  */
-
 function load_context_help() {
 
 	$path = App::$cmd;
@@ -305,7 +309,7 @@ function load_context_help() {
  * @brief
  *
  * @param string $s
- * @return void|boolean[]|number[]|string[]|unknown[]
+ * @return void|array
  */
 function store_doc_file($s) {
 
diff --git a/include/import.php b/include/import.php
index 3bd8b4105..f391400bd 100644
--- a/include/import.php
+++ b/include/import.php
@@ -12,6 +12,7 @@ require_once('include/perm_upgrade.php');
  * @param array $channel
  * @param int $account_id
  * @param int $seize
+ * @param string $newname (optional)
  * @return boolean|array
  */
 function import_channel($channel, $account_id, $seize, $newname = '') {
@@ -650,7 +651,7 @@ function import_items($channel, $items, $sync = false, $relocate = null) {
 			// preserve conversations you've been involved in from being expired
 
 			$stored = $item_result['item'];
-			if((is_array($stored)) && ($stored['id'] != $stored['parent']) 
+			if((is_array($stored)) && ($stored['id'] != $stored['parent'])
 				&& ($stored['author_xchan'] === $channel['channel_hash'])) {
 				retain_item($stored['item']['parent']);
 			}
@@ -672,7 +673,7 @@ function import_items($channel, $items, $sync = false, $relocate = null) {
 /**
  * @brief Sync items to channel.
  *
- * @see import_items
+ * @see import_items()
  *
  * @param array $channel where to import to
  * @param array $items
@@ -1049,7 +1050,7 @@ function import_mail($channel, $mails, $sync = false) {
 /**
  * @brief Synchronise mails.
  *
- * @see import_mail
+ * @see import_mail()
  * @param array $channel
  * @param array $mails
  */
@@ -1337,7 +1338,7 @@ function sync_files($channel, $files) {
 
 							if($str)
 								$str .= ",";
-							
+
 							$str .= " " . TQUOT . $k . TQUOT . " = '" . (($k === 'content') ? dbescbin($v) : dbesc($v)) . "' ";
 						}
 						$r = dbq("update photo set " . $str . " where id = " . intval($exists[0]['id']) );
diff --git a/include/items.php b/include/items.php
index e5f2be003..ed6fee597 100755
--- a/include/items.php
+++ b/include/items.php
@@ -25,7 +25,7 @@ require_once('include/permissions.php');
  *
  * @param array $item
  * @param[out] boolean $private_envelope
- * @param boolean $include_groups 
+ * @param boolean $include_groups
  * @return array containing the recipients
  */
 function collect_recipients($item, &$private_envelope,$include_groups = true) {
@@ -97,9 +97,9 @@ function collect_recipients($item, &$private_envelope,$include_groups = true) {
 		if(array_key_exists('public_policy',$item) && $item['public_policy'] !== 'self') {
 
 			$hookinfo = [
-				'recipients' => [], 
-				'item' => $item, 
-				'private_envelope' => $private_envelope, 
+				'recipients' => [],
+				'item' => $item,
+				'private_envelope' => $private_envelope,
 				'include_groups' => $include_groups
 			];
 
@@ -410,7 +410,7 @@ function post_activity_item($arr, $allow_code = false, $deliver = true) {
 
 
 	if(! $arr['mid']) {
-		$arr['uuid']         = ((x($arr,'uuid')) ? $arr['uuid'] : item_message_id()); 
+		$arr['uuid']         = ((x($arr,'uuid')) ? $arr['uuid'] : item_message_id());
 	}
 	$arr['mid']          = ((x($arr,'mid')) ? $arr['mid'] : z_root() . '/item/' . $arr['uuid']);
 	$arr['parent_mid']   = ((x($arr,'parent_mid')) ? $arr['parent_mid'] : $arr['mid']);
@@ -2400,15 +2400,15 @@ function item_update_parent_commented($item) {
 
 	$update_parent = true;
 
-	// update the commented timestamp on the parent 
+	// update the commented timestamp on the parent
 	// - unless this is a moderated comment or a potential clone of an older item
-	// which we don't wish to bring to the surface. As the queue only holds deliveries 
-	// for 3 days, it's suspected of being an older cloned item if the creation time 
+	// which we don't wish to bring to the surface. As the queue only holds deliveries
+	// for 3 days, it's suspected of being an older cloned item if the creation time
 	//is older than that.
 
 	if(intval($item['item_blocked']) === ITEM_MODERATED)
 		$update_parent = false;
- 
+
 	if($item['created'] < datetime_convert('','','now - 4 days'))
 		$update_parent = false;
 
@@ -3004,7 +3004,9 @@ function tgroup_check($uid, $item) {
  * @param array $channel
  * @param array $item
  * @param int $item_id
- * @param boolean $parent
+ * @param array $parent
+ * @param boolean $edit (optional) default false
+ * @return void
  */
 function start_delivery_chain($channel, $item, $item_id, $parent, $edit = false) {
 
@@ -3039,7 +3041,7 @@ function start_delivery_chain($channel, $item, $item_id, $parent, $edit = false)
 		}
 
 		// This will change the author to the post owner. Useful for RSS feeds which are to be syndicated
-		// to federated platforms which can't verify the identity of the author. 
+		// to federated platforms which can't verify the identity of the author.
 		// This MAY cause you to run afoul of copyright law.
 
 		$rewrite_author = intval(get_abconfig($channel['channel_id'],$item['owner_xchan'],'system','rself'));
@@ -3552,7 +3554,7 @@ function item_expire($uid,$days,$comment_days = 7) {
 
 	if(! $comment_days)
 		$comment_days = 7;
-	
+
 	// $expire_network_only = save your own wall posts
 	// and just expire conversations started by others
 	// do not enable this until we can pass bulk delete messages through zot
@@ -4892,7 +4894,7 @@ function copy_of_pubitem($channel,$mid) {
 		dbesc($mid),
 		intval($syschan['channel_id'])
 	);
-		
+
 	if($r) {
 		$items = fetch_post_tags($r,true);
 		foreach($items as $rv) {
@@ -4918,5 +4920,5 @@ function copy_of_pubitem($channel,$mid) {
 
 		}
 	}
-	return $result;		
+	return $result;
 }
diff --git a/include/plugin.php b/include/plugin.php
index ec14fd945..c789ad522 100755
--- a/include/plugin.php
+++ b/include/plugin.php
@@ -7,13 +7,15 @@
 
 
 /**
- * @brief Handle errors in plugin calls
+ * @brief Handle errors in plugin calls.
  *
  * @param string $plugin name of the addon
- * @param string $error_text text of error
- * @param bool $uninstall uninstall plugin
+ * @param string $notice UI visible text of error
+ * @param string $log technical error message for logging
+ * @param bool $uninstall (optional) default false
+ *   uninstall plugin on error
  */
-function handleerrors_plugin($plugin,$notice,$log,$uninstall=false){
+function handleerrors_plugin($plugin, $notice, $log, $uninstall = false){
 	logger("Addons: [" . $plugin . "] Error: ".$log, LOGGER_ERROR);
 	if ($notice != '') {
 			notice("[" . $plugin . "] Error: ".$notice, LOGGER_ERROR);
@@ -23,7 +25,7 @@ function handleerrors_plugin($plugin,$notice,$log,$uninstall=false){
 		$idx = array_search($plugin, \App::$plugins);
 		unset(\App::$plugins[$idx]);
 		uninstall_plugin($plugin);
-		set_config("system","addon", implode(", ",\App::$plugins));
+		set_config("system", "addon", implode(", ", \App::$plugins));
 	}
 }
 
@@ -381,8 +383,6 @@ function unregister_hook($hook, $file, $function) {
  * array in their theme_init() and use this to customise the app behaviour.
  * use insert_hook($hookname,$function_name) to do this.
  */
-
-
 function load_hooks() {
 
 	App::$hooks = [];
@@ -1085,10 +1085,11 @@ function get_markup_template($s, $root = '') {
 }
 
 /**
- * @brief
+ * @brief Test if a folder exists.
  *
  * @param string $folder
  * @return boolean|string
+ *   False if folder does not exist, or canonicalized absolute pathname
  */
 function folder_exists($folder) {
 	// Get canonicalized absolute pathname
diff --git a/include/text.php b/include/text.php
index 6ac04f435..925c8e997 100644
--- a/include/text.php
+++ b/include/text.php
@@ -41,12 +41,12 @@ function replace_macros($s, $r) {
 
 	$t = App::template_engine();
 
-        try {
-	        $output = $t->replace_macros($arr['template'], $arr['params']);
-        } catch (Exception $e) {
-                logger("Unable to render template: ".$e->getMessage());
-                $output = "<h3>ERROR: there was an error creating the output.</h3>";
-        }
+	try {
+		$output = $t->replace_macros($arr['template'], $arr['params']);
+	} catch (Exception $e) {
+		logger('Unable to render template: ' . $e->getMessage());
+		$output = '<h3>ERROR: there was an error creating the output.</h3>';
+	}
 
 	return $output;
 }
@@ -539,7 +539,14 @@ function paginate(&$a) {
 	return $o;
 }
 
-
+/**
+ * @brief
+ *
+ * @param int $i
+ * @param string $more
+ * @param string $less
+ * @return string Parsed HTML from template 'alt_pager.tpl'
+ */
 function alt_pager($i, $more = '', $less = '') {
 
 	if(! $more)
@@ -810,7 +817,7 @@ function activity_match($haystack,$needle) {
  * and strip the period from any tags which end with one.
  *
  * @param string $s
- * @return Returns array of tags found, or empty array.
+ * @return array Returns an array of tags found, or empty array.
  */
 function get_tags($s) {
 	$ret = array();
@@ -825,7 +832,7 @@ function get_tags($s) {
 
 	// ignore anything in [color= ], because it may contain color codes which are mistaken for tags
 	$s = preg_replace('/\[color=(.*?)\]/sm','',$s);
-	
+
 	// skip anchors in URL
 	$s = preg_replace('/\[url=(.*?)\]/sm','',$s);
 
@@ -900,6 +907,7 @@ function tag_sort_length($a,$b) {
 function total_sort($a,$b) {
 	if($a['total'] == $b['total'])
 		return 0;
+
 	return(($b['total'] > $a['total']) ? 1 : (-1));
 }
 
@@ -1004,9 +1012,15 @@ function contact_block() {
 		'$micropro' => $micropro,
 	));
 
-	$arr = array('contacts' => $r, 'output' => $o);
-
+	$arr = ['contacts' => $r, 'output' => $o];
+	/**
+	 * @hooks contact_block_end
+	 *   Called at the end of contact_block(), but can not manipulate the output.
+	 *   * \e array \b contacts - Result array from database
+	 *   * \e string \b output - the generated output
+	 */
 	call_hooks('contact_block_end', $arr);
+
 	return $o;
 }
 
@@ -1108,16 +1122,20 @@ function linkify($s, $me = false) {
  * to a local redirector which uses https and which redirects to the selected content
  *
  * @param string $s
- * @param int $uid
  * @returns string
  */
 function sslify($s) {
 
 	// Local photo cache
-	$str = array(
+	$str = [
 		'body' => $s,
 		'uid' => local_channel()
-	);
+	];
+	/**
+	 * @hooks cache_body_hook
+	 *   * \e string \b body The content to parse and also the return value
+	 *   * \e int|bool \b uid
+	 */
 	call_hooks('cache_body_hook', $str);
 
 	$s = $str['body'];
@@ -1222,7 +1240,11 @@ function get_mood_verbs() {
 /**
  * @brief Function to list all smilies, both internal and from addons.
  *
- * @return Returns array with keys 'texts' and 'icons'
+ * @param boolean $default_only (optional) default false
+ *   true will prevent that plugins can add smilies
+ * @return array Returns an associative array with:
+ *   * \e array \b texts
+ *   * \e array \b icons
  */
 function list_smilies($default_only = false) {
 
@@ -1300,6 +1322,11 @@ function list_smilies($default_only = false) {
 	if($default_only)
 		return $params;
 
+	/**
+	 * @hooks smile
+	 *   * \e array \b texts - default values and also return value
+	 *   * \e array \b icons - default values and also return value
+	 */
 	call_hooks('smilie', $params);
 
 	return $params;
@@ -1625,6 +1652,10 @@ function generate_named_map($location) {
 
 function prepare_body(&$item,$attach = false,$opts = false) {
 
+	/**
+	 * @hooks prepare_body_init
+	 *   * \e array \b item
+	 */
 	call_hooks('prepare_body_init', $item);
 
 	$s = '';
@@ -1656,13 +1687,19 @@ function prepare_body(&$item,$attach = false,$opts = false) {
 
 	$event = (($item['obj_type'] === ACTIVITY_OBJ_EVENT) ? format_event_obj($item['obj']) : false);
 
-	$prep_arr = array(
+	$prep_arr = [
 		'item' => $item,
 		'html' => $event ? $event['content'] : $s,
 		'event' => $event['header'],
 		'photo' => $photo
-	);
-
+	];
+	/**
+	 * @hooks prepare_body
+	 *   * \e array \b item
+	 *   * \e string \b html - the parsed HTML to return
+	 *   * \e string \b event - the event header to return
+	 *   * \e string \b photo - the photo to return
+	 */
 	call_hooks('prepare_body', $prep_arr);
 
 	$s = $prep_arr['html'];
@@ -2249,19 +2286,24 @@ function ids_to_querystr($arr,$idx = 'id',$quote = false) {
 }
 
 /**
- * @brief array_elm_to_str($arr,$elm,$delim = ',') extract unique individual elements from an array of arrays and return them as a string separated by a delimiter
- * similar to ids_to_querystr, but allows a different delimiter instead of a db-quote option
- * empty elements (evaluated after trim()) are ignored.
- * @param $arr array
- * @param $elm array key to extract from sub-array
- * @param $delim string default ','
- * @param $each filter function to apply to each element before evaluation, default is 'trim'.
+ * @brief Extract unique individual elements from an array of arrays and return
+ * them as a string separated by a delimiter.
+ *
+ * Similar to ids_to_querystr, but allows a different delimiter instead of a
+ * db-quote option empty elements (evaluated after trim()) are ignored.
+ *
+ * @see ids_to_querystr()
+ *
+ * @param array $arr
+ * @param string $elm key to extract from sub-array
+ * @param string $delim (optional) default ','
+ * @param string $each (optional) default is 'trim'
+ *   Filter function to apply to each element before evaluation.
  * @returns string
  */
-
-function array_elm_to_str($arr,$elm,$delim = ',',$each = 'trim') {
-
+function array_elm_to_str($arr, $elm, $delim = ',', $each = 'trim') {
 	$tmp = [];
+
 	if($arr && is_array($arr)) {
 		foreach($arr as $x) {
 			if(is_array($x) && array_key_exists($elm,$x)) {
@@ -2272,7 +2314,8 @@ function array_elm_to_str($arr,$elm,$delim = ',',$each = 'trim') {
 			}
 		}
 	}
-	return implode($delim,$tmp);
+
+	return implode($delim, $tmp);
 }
 
 function trim_and_unpunify($s) {
@@ -2496,9 +2539,9 @@ function design_tools() {
 }
 
 /**
- * @brief Creates website portation tools menu
+ * @brief Creates website portation tools menu.
  *
- * @return string
+ * @return string Parsed HTML code from template 'website_portation_tools.tpl'
  */
 function website_portation_tools() {
 
@@ -2511,7 +2554,7 @@ function website_portation_tools() {
 		$sys = true;
 	}
 
-	return replace_macros(get_markup_template('website_portation_tools.tpl'), array(
+	return replace_macros(get_markup_template('website_portation_tools.tpl'), [
 		'$title'               => t('Import'),
 		'$import_label'        => t('Import website...'),
 		'$import_placeholder'  => t('Select folder to import'),
@@ -2528,7 +2571,7 @@ function website_portation_tools() {
 		'$cloud_export_desc'   => t('/path/to/export/folder'),
 		'$cloud_export_hint'   => t('Enter a path to a cloud files destination.'),
 		'$cloud_export_select' => t('Specify folder'),
-	));
+	]);
 }
 
 /**
@@ -2991,9 +3034,9 @@ function item_url_replace($channel,&$item,$old,$new,$oldnick = '') {
 			json_url_replace('/' . $oldnick . '/' ,'/' . $channel['channel_address'] . '/' ,$item['target']);
 	}
 
-    $x = preg_replace("/".preg_quote($old,'/')."\/(search|\w+\/".$channel['channel_address'].")/", $new.'/${1}', $item['body']);
-    if($x) {
-        $item['body'] = $x;
+	$x = preg_replace("/".preg_quote($old,'/')."\/(search|\w+\/".$channel['channel_address'].")/", $new.'/${1}', $item['body']);
+	if($x) {
+		$item['body'] = $x;
 		$item['sig'] = base64url_encode(rsa_sign($item['body'],$channel['channel_prvkey']));
 		$item['item_verified']  = 1;
 	}
@@ -3103,7 +3146,13 @@ function pdl_selector($uid, $current='') {
 		intval($uid)
 	);
 
-	$arr = array('channel_id' => $uid, 'current' => $current, 'entries' => $r);
+	$arr = ['channel_id' => $uid, 'current' => $current, 'entries' => $r];
+	/**
+	 * @hooks pdl_selector
+	 *   * \e int \b channel_id
+	 *   * \e string \b current
+	 *   * \e array \b entries - Result from database query
+	 */
 	call_hooks('pdl_selector', $arr);
 
 	$entries = $arr['entries'];
@@ -3178,7 +3227,6 @@ function text_highlight($s, $lang) {
 			'language' => $lang,
 			'success' => false
 	];
-
 	/**
 	 * @hooks text_highlight
 	 *   * \e string \b text
@@ -3379,13 +3427,17 @@ function punify($s) {
 
 }
 
-// Be aware that unpunify will only convert domain names and not pathnames
-
+/**
+ * Be aware that unpunify() will only convert domain names and not pathnames.
+ *
+ * @param string $s
+ * @return string
+ */
 function unpunify($s) {
 	require_once('vendor/simplepie/simplepie/idn/idna_convert.class.php');
 	$x = new idna_convert(['encoding' => 'utf8']);
-	return $x->decode($s);
 
+	return $x->decode($s);
 }
 
 
@@ -3521,12 +3573,11 @@ function array_path_exists($str,$arr) {
  */
 function new_uuid() {
 
-    try {
-        $hash = Uuid::uuid4()->toString();
-    } catch (UnsatisfiedDependencyException $e) {
-        $hash = random_string(48);
-    }
+	try {
+		$hash = Uuid::uuid4()->toString();
+	} catch (UnsatisfiedDependencyException $e) {
+		$hash = random_string(48);
+	}
 
-    return $hash;
+	return $hash;
 }
-
diff --git a/include/zot.php b/include/zot.php
index bc2187f91..3b089831b 100644
--- a/include/zot.php
+++ b/include/zot.php
@@ -174,7 +174,7 @@ function zot_build_packet($channel, $type = 'notify', $recipients = null, $remot
  *   packet type: one of 'ping', 'pickup', 'purge', 'refresh', 'keychange', 'force_refresh', 'notify', 'auth_check'
  * @param array $recipients
  *   envelope information, array ( 'guid' => string, 'guid_sig' => string ); empty for public posts
- * @param string msg
+ * @param string $msg
  *   optional message
  * @param string $remote_key
  *   optional public site key of target hub used to encrypt entire packet
@@ -1829,7 +1829,7 @@ function process_delivery($sender, $arr, $deliveries, $relay, $public = false, $
 		else {
 			$arr['item_wall'] = 0;
 		}
-		
+
 
                 if ((! $tag_delivery) && (! $local_public)) {
                         $allowed = (perm_is_allowed($channel['channel_id'],$sender['hash'],$perm));
@@ -1843,7 +1843,7 @@ function process_delivery($sender, $arr, $deliveries, $relay, $public = false, $
                                         $allowed = can_comment_on_post($d['hash'],$parent[0]);
                                 }
                         }
-        
+
                         if (! $allowed) {
 			        logger("permission denied for delivery to channel {$channel['channel_id']} {$channel['channel_address']}");
 			        $DR->update('permission denied');
@@ -2330,7 +2330,7 @@ function process_mail_delivery($sender, $arr, $deliveries) {
 
 		if(! perm_is_allowed($channel['channel_id'],$sender['hash'],'post_mail')) {
 
-			/* 
+			/*
 			 * Always allow somebody to reply if you initiated the conversation. It's anti-social
 			 * and a bit rude to send a private message to somebody and block their ability to respond.
 			 * If you are being harrassed and want to put an end to it, delete the conversation.
@@ -2358,7 +2358,7 @@ function process_mail_delivery($sender, $arr, $deliveries) {
 		);
 		if($r) {
 			if(intval($arr['mail_recalled'])) {
-                msg_drop($r[0]['id'], $channel['channel_id'], $r[0]['conv_guid']);
+				msg_drop($r[0]['id'], $channel['channel_id'], $r[0]['conv_guid']);
 				$DR->update('mail recalled');
 				$result[] = $DR->get();
 				logger('mail_recalled');
@@ -3247,7 +3247,7 @@ function build_sync_packet($uid = 0, $packet = null, $groups_changed = false) {
 
 	$channel = $r[0];
 
-	// don't provide these in the export 
+	// don't provide these in the export
 
 	unset($channel['channel_active']);
 	unset($channel['channel_password']);
@@ -3616,7 +3616,7 @@ function process_channel_sync_delivery($sender, $arr, $deliveries) {
 
 			if(array_key_exists('channel_pageflags',$arr['channel']) && intval($arr['channel']['channel_pageflags'])) {
 				// Several pageflags are site-specific and cannot be sync'd.
-				// Only allow those bits which are shareable from the remote and then 
+				// Only allow those bits which are shareable from the remote and then
 				// logically OR with the local flags
 
 				$arr['channel']['channel_pageflags'] = $arr['channel']['channel_pageflags'] & (PAGE_HIDDEN|PAGE_AUTOCONNECT|PAGE_APPLICATION|PAGE_PREMIUM|PAGE_ADULT);
@@ -4974,9 +4974,9 @@ function zot_reply_pickup($data) {
 	// It's possible that we have more than 100 messages waiting to be sent.
 
 	// See if there are any more messages in the queue.
-        $x = q("select * from outq where outq_posturl = '%s' order by outq_created limit 1",
-		dbesc($data['callback'])
-        );
+	$x = q("select * from outq where outq_posturl = '%s' order by outq_created limit 1",
+			dbesc($data['callback'])
+	);
 
 	// If so, kick off a new delivery notification for the next batch
 	if ($x) {
@@ -5057,7 +5057,7 @@ function zot_reply_auth_check($data,$encrypted_packet) {
 	}
 
 	// There should be exactly one recipient, the original auth requestor
-
+	/// @FIXME $recipients is undefined here.
 	$ret['message'] .= 'recipients ' . print_r($recipients,true) . EOL;
 
 	if ($data['recipients']) {
-- 
cgit v1.2.3


From 728788e3b9ce351b7eab0fba00e97ba59215e975 Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Sat, 26 Jan 2019 00:47:39 +0100
Subject: Extend documentation.

---
 include/contact_widgets.php | 40 ++++++++++++++++------------------------
 1 file changed, 16 insertions(+), 24 deletions(-)

(limited to 'include')

diff --git a/include/contact_widgets.php b/include/contact_widgets.php
index a105bca19..6ad276b00 100644
--- a/include/contact_widgets.php
+++ b/include/contact_widgets.php
@@ -7,14 +7,14 @@ function findpeople_widget() {
 	if(get_config('system','invitation_only')) {
 		$x = get_pconfig(local_channel(),'system','invites_remaining');
 		if($x || is_site_admin()) {
-			App::$page['aside'] .= '<div class="side-link" id="side-invite-remain">' 
-			. sprintf( tt('%d invitation available','%d invitations available',$x), $x) 
-			. '</div>' . $inv;
+			App::$page['aside'] .= '<div class="side-link" id="side-invite-remain">'
+			. sprintf( tt('%d invitation available','%d invitations available',$x), $x)
+			. '</div>';
 		}
 	}
 
 	$advanced_search = ((local_channel() && feature_enabled(local_channel(),'advanced_dirsearch')) ? t('Advanced') : false);
- 
+
 	return replace_macros(get_markup_template('peoplefind.tpl'),array(
 		'$findpeople' => t('Find Channels'),
 		'$desc' => t('Enter name or interest'),
@@ -22,7 +22,7 @@ function findpeople_widget() {
 		'$hint' => t('Examples: Robert Morgenstein, Fishing'),
 		'$findthem' => t('Find'),
 		'$suggest' => t('Channel Suggestions'),
-		'$similar' => '', // FIXME and uncomment when mod/match working // t('Similar Interests'),
+		'$similar' => '', /// @FIXME fixme and uncomment when mod/match working // t('Similar Interests'),
 		'$random' => t('Random Profile'),
 		'$inv' => t('Invite Friends'),
 		'$advanced_search' => $advanced_search,
@@ -56,12 +56,11 @@ function fileas_widget($baseurl,$selected = '') {
 		'$all' => t('Everything'),
 		'$terms' => $terms,
 		'$base' => $baseurl,
-
 	));
 }
 
 function categories_widget($baseurl,$selected = '') {
-	
+
 	if(! feature_enabled(App::$profile['profile_uid'],'categories'))
 		return '';
 
@@ -100,14 +99,13 @@ function categories_widget($baseurl,$selected = '') {
 			'$all' => t('Everything'),
 			'$terms' => $terms,
 			'$base' => $baseurl,
-
 		));
 	}
 	return '';
 }
 
 function cardcategories_widget($baseurl,$selected = '') {
-	
+
 	if(! feature_enabled(App::$profile['profile_uid'],'categories'))
 		return '';
 
@@ -128,7 +126,7 @@ function cardcategories_widget($baseurl,$selected = '') {
 				$item_normal
 				$sql_extra
 				order by term.term asc",
-		intval(App::$profile['profile_uid']),
+			intval(App::$profile['profile_uid']),
 			intval(TERM_CATEGORY),
 			intval(TERM_OBJ_POST),
 			dbesc(App::$profile['channel_hash'])
@@ -144,15 +142,15 @@ function cardcategories_widget($baseurl,$selected = '') {
 			'$all' => t('Everything'),
 			'$terms' => $terms,
 			'$base' => $baseurl,
-
 		));
 	}
+
 	return '';
 }
 
 
 function articlecategories_widget($baseurl,$selected = '') {
-	
+
 	if(! feature_enabled(App::$profile['profile_uid'],'categories'))
 		return '';
 
@@ -173,7 +171,7 @@ function articlecategories_widget($baseurl,$selected = '') {
 				$item_normal
 				$sql_extra
 				order by term.term asc",
-		intval(App::$profile['profile_uid']),
+			intval(App::$profile['profile_uid']),
 			intval(TERM_CATEGORY),
 			intval(TERM_OBJ_POST),
 			dbesc(App::$profile['channel_hash'])
@@ -189,17 +187,14 @@ function articlecategories_widget($baseurl,$selected = '') {
 			'$all' => t('Everything'),
 			'$terms' => $terms,
 			'$base' => $baseurl,
-
 		));
 	}
+
 	return '';
 }
 
 
 
-
-
-
 function common_friends_visitor_widget($profile_uid,$cnt = 25) {
 
 	if(local_channel() == $profile_uid)
@@ -218,17 +213,14 @@ function common_friends_visitor_widget($profile_uid,$cnt = 25) {
 		return;
 
 	$r = common_friends($profile_uid,$observer_hash,0,$cnt,true);
-	
-	return replace_macros(get_markup_template('remote_friends_common.tpl'), array(
+
+	return replace_macros(get_markup_template('remote_friends_common.tpl'), [
 		'$desc'     => t('Common Connections'),
 		'$base'     => z_root(),
 		'$uid'      => $profile_uid,
-		'$cid'      => $observer,
 		'$linkmore' => (($t > $cnt) ? 'true' : ''),
 		'$more'     => sprintf( t('View all %d common connections'), $t),
-		'$items'    => $r
-	)); 
+		'$items'    => $r,
+	]);
 
 };
-
-
-- 
cgit v1.2.3


From b15421826d91d7344ad28a16f0be047c191d5ec4 Mon Sep 17 00:00:00 2001
From: zotlabs <mike@macgirvin.com>
Date: Tue, 29 Jan 2019 15:14:49 -0800
Subject: cache embeds in the background on initial storage rather than on
 first access

---
 include/items.php | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'include')

diff --git a/include/items.php b/include/items.php
index ed6fee597..1fe98c119 100755
--- a/include/items.php
+++ b/include/items.php
@@ -2048,6 +2048,11 @@ function item_store($arr, $allow_exec = false, $deliver = true) {
 
 	item_update_parent_commented($arr);
 
+
+	if(strpos($arr['body'],'[embed]') !== false) {
+		Master::Summon([ 'Cache_embeds', $current_post ]);
+	}
+
 	// If _creating_ a deleted item, don't propagate it further or send out notifications.
 	// We need to store the item details just in case the delete came in before the original post,
 	// so that we have an item in the DB that's marked deleted and won't store a fresh post
@@ -2384,6 +2389,13 @@ function item_store_update($arr, $allow_exec = false, $deliver = true) {
 	 */
 	call_hooks('item_stored_update',$arr);
 
+	if(strpos($arr['body'],'[embed]') !== false) {
+		Master::Summon([ 'Cache_embeds', $orig_post_id ]);
+	}
+
+
+
+
 	if($deliver) {
 		send_status_notifications($orig_post_id,$arr);
 		tag_deliver($uid,$orig_post_id);
-- 
cgit v1.2.3


From 6462c83f69969e1b3a945292a4a9e8df7e730936 Mon Sep 17 00:00:00 2001
From: Max Kostikov <max@kostikov.co>
Date: Fri, 1 Feb 2019 15:47:51 +0100
Subject: Prevent Hubzilla usage for SEO backlinks

---
 include/text.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'include')

diff --git a/include/text.php b/include/text.php
index 7d253e3d7..b6a1004c2 100644
--- a/include/text.php
+++ b/include/text.php
@@ -1093,7 +1093,7 @@ function searchbox($s,$id='search-box',$url='/search',$save = false) {
  * @return string
  */
 function linkify($s, $me = false) {
-	$s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\pL\:\/\-\?\&\;\.\=\_\@\~\#\'\%\$\!\+\,\@]*)/u", (($me) ? ' <a href="$1" rel="me" >$1</a>' : ' <a href="$1" >$1</a>'), $s);
+	$s = preg_replace("/(https?\:\/\/[a-zA-Z0-9\pL\:\/\-\?\&\;\.\=\_\@\~\#\'\%\$\!\+\,\@]*)/u", (($me) ? ' <a href="$1" rel="me nofollow" >$1</a>' : ' <a href="$1" >$1</a>'), $s);
 	$s = preg_replace("/\<(.*?)(src|href)=(.*?)\&amp\;(.*?)\>/ism",'<$1$2=$3&$4>',$s);
 
 	return($s);
-- 
cgit v1.2.3


From 708d2881217a3a66d5ff64a33365e0cb96353962 Mon Sep 17 00:00:00 2001
From: "DM42.Net (Matt Dent)" <dentm42@dm42.net>
Date: Fri, 1 Feb 2019 00:12:45 -0500
Subject: Add filter hooks and the ability to add buttons to the default status
 editor

---
 include/conversation.php | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

(limited to 'include')

diff --git a/include/conversation.php b/include/conversation.php
index 041994b90..e2dd02ffc 100644
--- a/include/conversation.php
+++ b/include/conversation.php
@@ -1328,7 +1328,7 @@ function hz_status_editor($a, $x, $popup = false) {
 	
 	$tpl = get_markup_template('jot-header.tpl');
 
-	App::$page['htmlhead'] .= replace_macros($tpl, array(
+	$tplmacros = [
 		'$baseurl' => z_root(),
 		'$editselect' => (($plaintext) ? 'none' : '/(profile-jot-text|prvmail-text)/'),
 		'$pretext' => ((x($x,'pretext')) ? $x['pretext'] : ''),
@@ -1349,7 +1349,10 @@ function hz_status_editor($a, $x, $popup = false) {
 		'$nocomment_disabled' => t('Comments disabled'),
 		'$auto_save_draft' => $feature_auto_save_draft,
 		'$reset' => $reset
-	));
+	];
+
+	call_hooks('jot_header_tpl_filter',$tplmacros);	
+	App::$page['htmlhead'] .= replace_macros($tpl, $tplmacros);
 
 	$tpl = get_markup_template('jot.tpl');
 
@@ -1389,7 +1392,7 @@ function hz_status_editor($a, $x, $popup = false) {
 	$sharebutton = (x($x,'button') ? $x['button'] : t('Share'));
 	$placeholdtext = (x($x,'content_label') ? $x['content_label'] : $sharebutton);
 
-	$o .= replace_macros($tpl, array(
+	$tplmacros = [
 		'$return_path' => ((x($x, 'return_path')) ? $x['return_path'] : App::$query_string),
 		'$action' =>  z_root() . '/item',
 		'$share' => $sharebutton,
@@ -1463,9 +1466,15 @@ function hz_status_editor($a, $x, $popup = false) {
 		'$bbcode' => ((x($x, 'bbcode')) ? $x['bbcode'] : false),
 		'$parent' => ((array_key_exists('parent',$x) && $x['parent']) ? $x['parent'] : 0),
 		'$reset' => $reset,
-		'$is_owner' => ((local_channel() && (local_channel() == $x['profile_uid'])) ? true : false)
-	));
+		'$is_owner' => ((local_channel() && (local_channel() == $x['profile_uid'])) ? true : false),
+		'$custommoretoolsdropdown' => '',
+		'$custommoretoolsbuttons' => '',
+		'$customsubmitright' => []
+	];
+
+	call_hooks('jot_tpl_filter',$tplmacros);
 
+	$o .= replace_macros($tpl, $tplmacros);
 	if ($popup === true) {
 		$o = '<div id="jot-popup" style="display:none">' . $o . '</div>';
 	}
-- 
cgit v1.2.3


From 8ff9a9ff08db1a6e821b9d74c0a58e8ced174d9b Mon Sep 17 00:00:00 2001
From: zotlabs <mike@macgirvin.com>
Date: Sun, 3 Feb 2019 16:53:49 -0800
Subject: fix linkify_tags() so it works with xchans across multiple protocols,
 also some fixes to activity parsing from upstream.

---
 include/items.php   |   2 +-
 include/message.php |   2 +-
 include/photos.php  |   2 +-
 include/text.php    | 162 ++++++++++++++++++++++++++++++++++------------------
 4 files changed, 108 insertions(+), 60 deletions(-)

(limited to 'include')

diff --git a/include/items.php b/include/items.php
index 1fe98c119..76ae79e6f 100755
--- a/include/items.php
+++ b/include/items.php
@@ -4561,7 +4561,7 @@ function set_linkified_perms($linkified, &$str_contact_allow, &$str_group_allow,
 	$first_access_tag = true;
 
 	foreach($linkified as $x) {
-		$access_tag = $x['access_tag'];
+		$access_tag = $x['success']['access_tag'];
 		if(($access_tag) && (! $parent_item)) {
 			logger('access_tag: ' . $tag . ' ' . print_r($access_tag,true), LOGGER_DATA);
 			if ($first_access_tag && (! get_pconfig($profile_uid,'system','no_private_mention_acl_override'))) {
diff --git a/include/message.php b/include/message.php
index 936c01631..037c59c60 100644
--- a/include/message.php
+++ b/include/message.php
@@ -44,7 +44,7 @@ function send_message($uid = 0, $recipient = '', $body = '', $subject = '', $rep
 
 
 	$body = cleanup_bbcode($body);
-	$results = linkify_tags($a, $body, $uid);
+	$results = linkify_tags($body, $uid);
 
 	if(! $raw) {
 		if(preg_match_all("/\[attachment\](.*?)\[\/attachment\]/",((strpos($body,'[/crypt]')) ? $_POST['media_str'] : $body),$match)) {
diff --git a/include/photos.php b/include/photos.php
index ae51703e0..44406e0b0 100644
--- a/include/photos.php
+++ b/include/photos.php
@@ -356,7 +356,7 @@ function photo_upload($channel, $observer, $args) {
 
 	$large_photos = feature_enabled($channel['channel_id'], 'large_photos');
 
-	linkify_tags($a, $args['body'], $channel_id);
+	linkify_tags($args['body'], $channel_id);
 
 	if($large_photos) {
 		$scale = 1;
diff --git a/include/text.php b/include/text.php
index 925c8e997..d94196662 100644
--- a/include/text.php
+++ b/include/text.php
@@ -2631,8 +2631,9 @@ function extra_query_args() {
  * @param boolean $in_network default true
  * @return boolean true if replaced, false if not replaced
  */
-function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $in_network = true) {
+function handle_tag(&$body, &$str_tags, $profile_uid, $tag, $in_network = true) {
 
+	$channel = App::get_channel();
 	$replaced = false;
 	$r = null;
 	$match = array();
@@ -2688,21 +2689,20 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 
 			$str_tags .= $newtag;
 		}
-		return [
-			'replaced' => $replaced,
-			'termtype' => $termtype,
-			'term'     => $basetag,
-			'url'      => $url,
-			'contact'  => []
-		];
-
+		return [ [
+			'replaced'   => $replaced,
+			'termtype'   => $termtype,
+			'term'       => $basetag,
+			'url'        => $url,
+			'contact'    => [],
+			'access_tag' => '',
+		]];
 	}
 
 	// END hashtags
 
 	// BEGIN mentions
 
-
 	if ( in_array($termtype, [ TERM_MENTION, TERM_FORUM ] )) {
 
 		// The @! tag and !! tag will alter permissions
@@ -2713,7 +2713,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 		$exclusive = (((strpos(substr($tag,1), '!') === 0) && $in_network) ? true : false);
 
 		//is it already replaced?
-		if(strpos($tag,'[zrl=') || strpos($tag,'[url='))
+		if(strpos($tag,"[zrl=") || strpos($tag,"[url="))
 			return $replaced;
 
 		// get the channel name
@@ -2731,7 +2731,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 			$newname = substr($name,1);
 			$newname = substr($newname,0,-1);
 
-			$r = q("select * from xchan where xchan_addr = '%s' or xchan_url = '%s' limit 1",
+			$r = q("select * from xchan where xchan_addr = '%s' or xchan_url = '%s'",
 				dbesc($newname),
 				dbesc($newname)
 			);
@@ -2754,7 +2754,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 			// select someone from this user's contacts by name
 
 			$r = q("SELECT * FROM abook left join xchan on abook_xchan = xchan_hash
-				WHERE xchan_name = '%s' AND abook_channel = %d LIMIT 1",
+				WHERE xchan_name = '%s' AND abook_channel = %d ",
 					dbesc($newname),
 					intval($profile_uid)
 			);
@@ -2763,7 +2763,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 
 			if((! $r) && strpos($newname,'@')) {
 				$r = q("SELECT * FROM xchan left join hubloc on xchan_hash = hubloc_hash
-					WHERE hubloc_addr = '%s' LIMIT 1",
+					WHERE hubloc_addr = '%s' ",
 						dbesc($newname)
 				);
 			}
@@ -2772,7 +2772,7 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 
 			if(! $r) {
 				$r = q("SELECT * FROM abook left join xchan on abook_xchan = xchan_hash
-					WHERE xchan_addr like ('%s') AND abook_channel = %d LIMIT 1",
+					WHERE xchan_addr like ('%s') AND abook_channel = %d ",
 						dbesc(((strpos($newname,'@')) ? $newname : $newname . '@%')),
 						intval($profile_uid)
 				);
@@ -2780,17 +2780,62 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 
 		}
 
-		// $r is set if we found something
 
-		$channel = App::get_channel();
+
+
+
+		$fn_results = [];
+		$access_tag = EMPTY_STR;
+
+
+		// $r is set if we found something
 
 		if($r) {
-			$profile = $r[0]['xchan_url'];
-			$newname = $r[0]['xchan_name'];
-			// add the channel's xchan_hash to $access_tag if exclusive
-			if($exclusive) {
-				$access_tag .= 'cid:' . $r[0]['xchan_hash'];
+			foreach($r as $xc) {
+				$profile = $xc['xchan_url'];
+				$newname = $xc['xchan_name'];
+				// add the channel's xchan_hash to $access_tag if exclusive
+				if($exclusive) {
+					$access_tag = 'cid:' . $xc['xchan_hash'];
+				}
+
+				// if there is a url for this channel
+
+				if(isset($profile)) {
+					$replaced = true;
+					//create profile link
+					$profile = str_replace(',','%2c',$profile);
+					$url = $profile;
+					if($termtype === TERM_FORUM) {
+						$newtag = '!' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
+						$body = str_replace('!' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
+					}
+					else {
+						// ( $termtype === TERM_MENTION )
+						$newtag = '@' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
+						$body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
+					}
+
+					// append tag to str_tags
+					if(! stristr($str_tags,$newtag)) {
+						if(strlen($str_tags))
+							$str_tags .= ',';
+						$str_tags .= $newtag;
+					}
+				}
+			
+
+				$fn_results[] =  [
+					'replaced'   => $replaced,
+					'termtype'   => $termtype,
+					'term'       => $newname,
+					'url'        => $url,
+					'access_tag' => $access_tag,
+					'contact'    => (($r) ? $xc : []),
+				];
+
 			}
+
 		}
 		else {
 
@@ -2802,7 +2847,6 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 			// weird - as all the other tags are linked to something.
 
 			if(local_channel() && local_channel() == $profile_uid) {
-				require_once('include/group.php');
 				$grp = group_byname($profile_uid,$name);
 
 				if($grp) {
@@ -2819,58 +2863,62 @@ function handle_tag($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $i
 					}
 				}
 			}
-		}
 
-		// if there is a url for this channel
 
-		if(isset($profile)) {
-			$replaced = true;
-			//create profile link
-			$profile = str_replace(',','%2c',$profile);
-			$url = $profile;
-			if($termtype === TERM_FORUM) {
-				$newtag = '!' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
-				$body = str_replace('!' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
-			}
-			else {
-				// ( $termtype === TERM_MENTION )
-				$newtag = '@' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
-				$body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
-			}
+			// if there is a url for this channel
 
-			// append tag to str_tags
-			if(! stristr($str_tags,$newtag)) {
-				if(strlen($str_tags))
-					$str_tags .= ',';
-				$str_tags .= $newtag;
+			if(isset($profile)) {
+				$replaced = true;
+				//create profile link
+				$profile = str_replace(',','%2c',$profile);
+				$url = $profile;
+				if($termtype === TERM_FORUM) {
+					$newtag = '!' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
+					$body = str_replace('!' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
+				}
+				else {
+					// ( $termtype === TERM_MENTION )
+					$newtag = '@' . (($exclusive) ? '!' : '') . '[zrl=' . $profile . ']' . $newname	. '[/zrl]';
+					$body = str_replace('@' . (($exclusive) ? '!' : '') . $name, $newtag, $body);
+				}
+
+				// append tag to str_tags
+				if(! stristr($str_tags,$newtag)) {
+					if(strlen($str_tags))
+						$str_tags .= ',';
+					$str_tags .= $newtag;
+				}
 			}
+
+			$fn_results[] = [
+				'replaced'   => $replaced,
+				'termtype'   => $termtype,
+				'term'       => $newname,
+				'url'        => $url,
+				'access_tag' => $access_tag,
+				'contact'    => [],
+			];
 		}
 	}
+	
+	return $fn_results;
 
-	return [
-		'replaced' => $replaced,
-		'termtype' => $termtype,
-		'term'     => $newname,
-		'url'      => $url,
-		'contact'  => (($r) ? $r[0] : [])
-	];
 }
 
-function linkify_tags($a, &$body, $uid, $in_network = true) {
+function linkify_tags(&$body, $uid, $in_network = true) {
 	$str_tags = EMPTY_STR;
-	$tagged = [];
 	$results = [];
 
 	$tags = get_tags($body);
 
 	if(count($tags)) {
 		foreach($tags as $tag) {
-			$access_tag = '';
 
-			$success = handle_tag($a, $body, $access_tag, $str_tags, ($uid) ? $uid : App::$profile_uid , $tag, $in_network);
+			$success = handle_tag($body, $str_tags, ($uid) ? $uid : App::$profile_uid , $tag, $in_network);
 
-			$results[] = array('success' => $success, 'access_tag' => $access_tag);
-			if($success['replaced']) $tagged[] = $tag;
+			foreach($success as $handled_tag) {
+				$results[] = [ 'success' => $handled_tag ];
+			}
 		}
 	}
 
-- 
cgit v1.2.3


From 92e6c21210b71acb2e1071171fa8cd7e76640f7b Mon Sep 17 00:00:00 2001
From: zotlabs <mike@macgirvin.com>
Date: Thu, 7 Feb 2019 14:13:13 -0800
Subject: add missing zot6 conversation completion (required for message
 repeats)

---
 include/items.php | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'include')

diff --git a/include/items.php b/include/items.php
index 76ae79e6f..a14e3db3a 100755
--- a/include/items.php
+++ b/include/items.php
@@ -7,6 +7,7 @@
 use Zotlabs\Lib\Enotify;
 use Zotlabs\Lib\MarkdownSoap;
 use Zotlabs\Lib\MessageFilter;
+use Zotlabs\Lib\ThreadListener;
 use Zotlabs\Lib\IConfig;
 use Zotlabs\Access\PermissionLimits;
 use Zotlabs\Access\AccessList;
@@ -141,6 +142,22 @@ function collect_recipients($item, &$private_envelope,$include_groups = true) {
 //				$recipients[] = $sys['xchan_hash'];
 		}
 
+
+		// Forward to thread listeners, *unless* there is even a remote hint that the item
+		// might have some privacy attached. This could be (for instance) an ActivityPub DM
+		// in the middle of a public thread. Unless we can guarantee beyond all doubt that
+		// this is public, don't allow it to go to thread listeners.
+
+		if(! intval($item['item_private'])) {
+			$r = ThreadListener::fetch_by_target($item['parent_mid']);
+			if($r) {
+				foreach($r as $rv) {
+					$recipients[] = $rv['portable_id'];
+				}
+			}
+		}
+
+
 		// Add the authors of any posts in this thread, if they are known to us.
 		// This is specifically designed to forward wall-to-wall posts to the original author,
 		// in case they aren't a connection but have permission to write on our wall.
@@ -3867,6 +3884,8 @@ function delete_item_lowlevel($item, $stage = DROPITEM_NORMAL, $force = false) {
 		intval(TERM_OBJ_POST)
 	);
 
+	ThreadListener::delete_by_target($item['mid']);
+
 	/** @FIXME remove notifications for this item */
 
 	return true;
-- 
cgit v1.2.3


From 5ab917f606aa8221b50e39b9ff0b5182d271fe51 Mon Sep 17 00:00:00 2001
From: Mario Vavti <mario@mariovavti.com>
Date: Thu, 14 Feb 2019 11:06:52 +0100
Subject: affinity tool fixes

---
 include/features.php | 8 --------
 1 file changed, 8 deletions(-)

(limited to 'include')

diff --git a/include/features.php b/include/features.php
index 05ce3db32..35a4c0dd4 100644
--- a/include/features.php
+++ b/include/features.php
@@ -360,14 +360,6 @@ function get_features($filtered = true, $level = (-1)) {
 				get_config('feature_lock','personal_tab')
 			],
 
-			[
-				'affinity',       
-				t('Affinity Tool'),			    
-				t('Filter stream activity by depth of relationships'),
-				false,
-				get_config('feature_lock','affinity')
-			],
-
 			[
 				'suggest',    	
 				t('Suggest Channels'),			
-- 
cgit v1.2.3


From d70bba28065fb3105543ef40d91f6db839d35e0f Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Fri, 1 Feb 2019 00:21:01 +0100
Subject: Clean up and documentation in photo_drive.

---
 include/photo/photo_driver.php | 513 ++++++++++++++++++++++-------------------
 1 file changed, 271 insertions(+), 242 deletions(-)

(limited to 'include')

diff --git a/include/photo/photo_driver.php b/include/photo/photo_driver.php
index 5c8ed9bdc..718bf875b 100644
--- a/include/photo/photo_driver.php
+++ b/include/photo/photo_driver.php
@@ -1,18 +1,30 @@
-<?php /** @file */
+<?php
 
+/**
+ * @brief Return a photo_driver object.
+ *
+ * Use this factory when manipulating images.
+ *
+ * Return a photo driver object implementing ImageMagick or GD.
+ *
+ * @param string $data Image data
+ * @param string $type
+ * @return null|photo_driver
+ *   NULL if unsupported image type or failure, otherwise photo driver object
+ */
 function photo_factory($data, $type = null) {
 	$ph = null;
+	$m = null;
 
-
-	$unsupported_types = array(
+	$unsupported_types = [
 		'image/bmp',
 		'image/vnd.microsoft.icon',
 		'image/tiff',
-		'image/svg+xml'
-	);
+		'image/svg+xml',
+	];
 
-	if($type && in_array(strtolower($type),$unsupported_types)) {
-		logger('photo_factory: unsupported image type');
+	if($type && in_array(strtolower($type), $unsupported_types)) {
+		logger('Unsupported image type ' . $type);
 		return null;
 	}
 
@@ -21,29 +33,30 @@ function photo_factory($data, $type = null) {
 	if(class_exists('Imagick') && !$ignore_imagick) {
 		$v = Imagick::getVersion();
 		preg_match('/ImageMagick ([0-9]+\.[0-9]+\.[0-9]+)/', $v['versionString'], $m);
-		if(version_compare($m[1],'6.6.7') >= 0) {
+		if(version_compare($m[1], '6.6.7') >= 0) {
 			require_once('include/photo/photo_imagick.php');
-			$ph = new photo_imagick($data,$type);
-		}
-		else {
+			$ph = new photo_imagick($data, $type);
+		} else {
 			// earlier imagick versions have issues with scaling png's
 			// don't log this because it will just fill the logfile.
-			// leave this note here so those who are looking for why 
+			// leave this note here so those who are looking for why
 			// we aren't using imagick can find it
 		}
 	}
 
 	if(! $ph) {
 		require_once('include/photo/photo_gd.php');
-		$ph = new photo_gd($data,$type);
+		$ph = new photo_gd($data, $type);
 	}
 
 	return $ph;
 }
 
 
-
-
+/**
+ * @brief Abstract photo driver class.
+ *
+ */
 abstract class photo_driver {
 
 	protected $image;
@@ -79,12 +92,12 @@ abstract class photo_driver {
 
 	public function __construct($data, $type='') {
 		$this->types = $this->supportedTypes();
-		if (! array_key_exists($type,$this->types)){
-			$type='image/jpeg';
+		if (! array_key_exists($type, $this->types)){
+			$type = 'image/jpeg';
 		}
 		$this->type = $type;
 		$this->valid = false;
-		$this->load($data,$type);
+		$this->load($data, $type);
 	}
 
 	public function __destruct() {
@@ -99,12 +112,14 @@ abstract class photo_driver {
 	public function getWidth() {
 		if(!$this->is_valid())
 			return FALSE;
+
 		return $this->width;
 	}
 
 	public function getHeight() {
 		if(!$this->is_valid())
 			return FALSE;
+
 		return $this->height;
 	}
 
@@ -112,6 +127,7 @@ abstract class photo_driver {
 	public function saveImage($path) {
 		if(!$this->is_valid())
 			return FALSE;
+
 		return (file_put_contents($path, $this->imageString()) ? true : false);
 	}
 
@@ -131,12 +147,14 @@ abstract class photo_driver {
 	}
 
 	/**
-	 * @brief scale image
-	 * int $max maximum pixel size in either dimension
-	 * boolean $float_height - if true allow height to float to any length on tall images, 
-	 *     constraining only the width
+	 * @brief Scale image to max pixel size in either dimension.
+	 *
+	 * @param int $max maximum pixel size in either dimension
+	 * @param boolean $float_height (optional)
+	 *   if true allow height to float to any length on tall images, constraining
+	 *   only the width
+	 *  @return boolean|void false on failure, otherwise void
 	 */
-
 	public function scaleImage($max, $float_height = true) {
 		if(!$this->is_valid())
 			return FALSE;
@@ -203,7 +221,6 @@ abstract class photo_driver {
 		if(!$this->is_valid())
 			return FALSE;
 
-
 		$width = $this->width;
 		$height = $this->height;
 
@@ -241,33 +258,39 @@ abstract class photo_driver {
 		$this->doScaleImage($dest_width,$dest_height);
 	}
 
-
+	/**
+	 * @brief Scales image to a square.
+	 *
+	 * @param int $dim Pixel of squre image
+	 * @return boolean|void false on failure, otherwise void
+	 */
 	public function scaleImageSquare($dim) {
 		if(!$this->is_valid())
 			return FALSE;
-		$this->doScaleImage($dim,$dim);
-	}
 
+		$this->doScaleImage($dim, $dim);
+	}
 
 	/**
-	 * @brief reads exif data from filename
+	 * @brief reads exif data from filename.
+	 *
+	 * @param string $filename
+	 * @return boolean|array
 	 */
-
 	public function exif($filename) {
 
-
-		if((! function_exists('exif_read_data')) 
+		if((! function_exists('exif_read_data'))
 			|| (! in_array($this->getType(), [ 'image/jpeg' , 'image/tiff'] ))) {
 			return false;
 		}
 
 		/*
 		 * PHP 7.2 allows you to use a stream resource, which should reduce/avoid
-		 * memory exhaustion on large images. 
+		 * memory exhaustion on large images.
 		 */
 
-		if(version_compare(PHP_VERSION,'7.2.0') >= 0) {
-			$f = @fopen($filename,'rb');
+		if(version_compare(PHP_VERSION, '7.2.0') >= 0) {
+			$f = @fopen($filename, 'rb');
 		}
 		else {
 			$f = $filename;
@@ -281,21 +304,23 @@ abstract class photo_driver {
 	}
 
 	/**
-	 * @brief orients current image based on exif orientation information
+	 * @brief Orients current image based on exif orientation information.
+	 *
+	 * @param array $exif
+	 * @return boolean true if oriented, otherwise false
 	 */
-
 	public function orient($exif) {
 
 		if(! ($this->is_valid() && $exif)) {
 			return false;
 		}
 
-		$ort = ((array_key_exists('IFD0',$exif)) ? $exif['IFD0']['Orientation'] : $exif['Orientation']);
+		$ort = ((array_key_exists('IFD0', $exif)) ? $exif['IFD0']['Orientation'] : $exif['Orientation']);
 
 		if(! $ort) {
 			return false;
 		}
-		
+
 		switch($ort) {
 			case 1: // nothing
 				break;
@@ -319,7 +344,7 @@ abstract class photo_driver {
 				$this->flip();
 				$this->rotate(-90);
 				break;
-			case 8:	// 90 rotate left
+			case 8: // 90 rotate left
 				$this->rotate(90);
 				break;
 			default:
@@ -329,15 +354,21 @@ abstract class photo_driver {
 		return true;
 	}
 
-
+	/**
+	 * @brief Save photo to database.
+	 *
+	 * @param array $arr
+	 * @param boolean $skipcheck (optional) default false
+	 * @return boolean|array
+	 */
 	public function save($arr, $skipcheck = false) {
 
 		if(! ($skipcheck || $this->is_valid())) {
-			logger('attempt to store invalid photo.');
+			logger('Attempt to store invalid photo.');
 			return false;
 		}
 
-		$p = array();
+		$p = [];
 
 		$p['aid'] = ((intval($arr['aid'])) ? intval($arr['aid']) : 0);
 		$p['uid'] = ((intval($arr['uid'])) ? intval($arr['uid']) : 0);
@@ -351,11 +382,11 @@ abstract class photo_driver {
 		$p['allow_gid'] = (($arr['allow_gid']) ? $arr['allow_gid'] : '');
 		$p['deny_cid'] = (($arr['deny_cid']) ? $arr['deny_cid'] : '');
 		$p['deny_gid'] = (($arr['deny_gid']) ? $arr['deny_gid'] : '');
-		$p['edited'] = (($arr['edited']) ? $arr['edited'] : datetime_convert()); 
+		$p['edited'] = (($arr['edited']) ? $arr['edited'] : datetime_convert());
 		$p['title'] = (($arr['title']) ? $arr['title'] : '');
 		$p['description'] = (($arr['description']) ? $arr['description'] : '');
 		$p['photo_usage'] = intval($arr['photo_usage']);
-		$p['os_storage'] = intval($arr['os_storage']);			
+		$p['os_storage'] = intval($arr['os_storage']);
 		$p['os_path'] = $arr['os_path'];
 		$p['os_syspath'] = ((array_key_exists('os_syspath',$arr)) ? $arr['os_syspath'] : '');
 		$p['display_path'] = (($arr['display_path']) ? $arr['display_path'] : '');
@@ -364,7 +395,7 @@ abstract class photo_driver {
 		$p['expires'] = (($arr['expires']) ? $arr['expires'] : gmdate('Y-m-d H:i:s', time() + get_config('system','photo_cache_time', 86400)));
 
 		if(! intval($p['imgscale']))
-			logger('save: ' . print_r($arr,true), LOGGER_DATA);
+			logger('save: ' . print_r($arr, true), LOGGER_DATA);
 
 		$x = q("select id, created from photo where resource_id = '%s' and uid = %d and xchan = '%s' and imgscale = %d limit 1",
 				dbesc($p['resource_id']),
@@ -372,7 +403,7 @@ abstract class photo_driver {
 				dbesc($p['xchan']),
 				intval($p['imgscale'])
 		);
-		
+
 		if($x) {
 			$p['created'] = (($x['created']) ? $x['created'] : $p['edited']);
 			$r = q("UPDATE photo set
@@ -388,7 +419,7 @@ abstract class photo_driver {
 				height = %d,
 				width = %d,
 				content = '%s',
-				os_storage = %d, 
+				os_storage = %d,
 				filesize = %d,
 				imgscale = %d,
 				photo_usage = %d,
@@ -463,33 +494,36 @@ abstract class photo_driver {
 				dbescdate($p['expires'])
 			);
 		}
-		logger('photo save ' . $p['imgscale'] . ' returned ' . intval($r));
+		logger('Photo save ' . $p['imgscale'] . ' returned ' . intval($r));
+
 		return $r;
 	}
 
 }
 
-
-
 /**
- * Guess image mimetype from filename or from Content-Type header
+ * @brief Guess image mimetype from filename or from Content-Type header.
  *
- * @arg $filename string Image filename
- * @arg $headers string Headers to check for Content-Type (from curl request)
+ * @param string $filename
+ *   Image filename
+ * @param string $headers (optional)
+ *   Headers to check for Content-Type (from curl request)
+ * @return null|string Guessed mimetype
  */
-
 function guess_image_type($filename, $headers = '') {
 //	logger('Photo: guess_image_type: '.$filename . ($headers?' from curl headers':''), LOGGER_DEBUG);
 	$type = null;
-	if ($headers) {
-		$hdrs=array();
-		$h = explode("\n",$headers);
+	$m = null;
+
+	if($headers) {
+		$hdrs = [];
+		$h = explode("\n", $headers);
 		foreach ($h as $l) {
-			list($k,$v) = array_map("trim", explode(":", trim($l), 2));
+			list($k,$v) = array_map('trim', explode(':', trim($l), 2));
 			$hdrs[strtolower($k)] = $v;
 		}
-		logger('Curl headers: '.var_export($hdrs, true), LOGGER_DEBUG);
-		if (array_key_exists('content-type', $hdrs)) {
+		logger('Curl headers: ' .var_export($hdrs, true), LOGGER_DEBUG);
+		if(array_key_exists('content-type', $hdrs)) {
 			$ph = photo_factory('');
 			$types = $ph->supportedTypes();
 
@@ -498,13 +532,13 @@ function guess_image_type($filename, $headers = '') {
 		}
 	}
 
-	if (is_null($type)){
+	if(is_null($type)){
 		$ignore_imagick = get_config('system', 'ignore_imagick');
 		// Guessing from extension? Isn't that... dangerous?
 		if(class_exists('Imagick') && file_exists($filename) && is_readable($filename) && !$ignore_imagick) {
 			$v = Imagick::getVersion();
 			preg_match('/ImageMagick ([0-9]+\.[0-9]+\.[0-9]+)/', $v['versionString'], $m);
-			if(version_compare($m[1],'6.6.7') >= 0) {
+			if(version_compare($m[1], '6.6.7') >= 0) {
 				/**
 				 * Well, this not much better,
 				 * but at least it comes from the data inside the image,
@@ -516,7 +550,7 @@ function guess_image_type($filename, $headers = '') {
 			else {
 				// earlier imagick versions have issues with scaling png's
 				// don't log this because it will just fill the logfile.
-				// leave this note here so those who are looking for why 
+				// leave this note here so those who are looking for why
 				// we aren't using imagick can find it
 			}
 		}
@@ -551,33 +585,36 @@ function guess_image_type($filename, $headers = '') {
 
 	}
 	logger('Photo: guess_image_type: filename = ' . $filename . ' type = ' . $type, LOGGER_DEBUG);
-	return $type;
 
+	return $type;
 }
 
-
-function delete_thing_photo($url,$ob_hash) {
+/**
+ * @brief Delete thing photo from database.
+ *
+ * @param string $url
+ * @param string $ob_hash
+ * @return void
+ */
+function delete_thing_photo($url, $ob_hash) {
 
 	$hash = basename($url);
-	$hash = substr($hash,0,strpos($hash,'-'));
+	$hash = substr($hash, 0, strpos($hash, '-'));
 
-	// hashes should be 32 bytes. 
+	// hashes should be 32 bytes.
 
 	if((! $ob_hash) || (strlen($hash) < 16))
-		return;	
+		return;
 
-	$r = q("delete from photo where xchan = '%s' and photo_usage = %d and resource_id = '%s'",
+	q("delete from photo where xchan = '%s' and photo_usage = %d and resource_id = '%s'",
 		dbesc($ob_hash),
 		intval(PHOTO_THING),
 		dbesc($hash)
 	);
-	
 }
 
-
-
 /**
- * @brief fetches an photo from external site and prepares its miniatures.
+ * @brief Fetches a photo from external site and prepares its miniatures.
  *
  * @param string $photo
  *    external URL to fetch base image
@@ -596,223 +633,215 @@ function delete_thing_photo($url,$ob_hash) {
  * * \e boolean \b 4 => TRUE if fetch failure
  * * \e string \b 5 => modification date
  */
+function import_xchan_photo($photo, $xchan, $thing = false, $force = false) {
+	$modified = '';
+	$o = null;
+
+	$flags = (($thing) ? PHOTO_THING : PHOTO_XCHAN);
+	$album = (($thing) ? 'Things' : 'Contact Photos');
+
+	logger('Updating channel photo from ' . $photo . ' for ' . $xchan, LOGGER_DEBUG);
+
+	if($thing) {
+		$hash = photo_new_resource();
+	} else {
+		$r = q("select resource_id, edited, mimetype from photo where xchan = '%s' and photo_usage = %d and imgscale = 4 limit 1", dbesc($xchan), intval(PHOTO_XCHAN));
+		if($r) {
+			$hash = $r[0]['resource_id'];
+			$modified = $r[0]['edited'];
+			$type = $r[0]['mimetype'];
+		} else {
+			$hash = photo_new_resource();
+		}
+	}
 
-function import_xchan_photo($photo,$xchan,$thing = false,$force = false) {
-
-        $modified = '';
-
-        $flags = (($thing) ? PHOTO_THING : PHOTO_XCHAN);
-        $album = (($thing) ? 'Things' : 'Contact Photos');
-
-        logger('import_xchan_photo: updating channel photo from ' . $photo . ' for ' . $xchan, LOGGER_DEBUG);
-
-        if($thing) {
-                $hash = photo_new_resource();
-        }
-        else {
-                $r = q("select resource_id, edited, mimetype from photo where xchan = '%s' and photo_usage = %d and imgscale = 4 limit 1",
-                        dbesc($xchan),
-                        intval(PHOTO_XCHAN)
-                );
-                if($r) {
-                        $hash = $r[0]['resource_id'];
-                        $modified = $r[0]['edited'];
-                        $type = $r[0]['mimetype'];
-                }
-                else {
-                        $hash = photo_new_resource();
-                }
-        }
-
-        $photo_failure = false;
-        $img_str = '';
-
-        if($photo) {
-                $filename = basename($photo);
-
-                if($force || $modified == '') {
-                        $result = z_fetch_url($photo,true);
-                }
-                else {
-                        $h = array('headers' => array("If-Modified-Since: " . gmdate("D, d M Y H:i:s", strtotime($modified . "Z")) . " GMT"));
-                        $result = z_fetch_url($photo,true,0,$h);
-                }
-
-                if($result['success']) {
-                        $img_str = $result['body'];
-                        $type = guess_image_type($photo, $result['header']);
-                        $modified = gmdate('Y-m-d H:i:s', (preg_match('/last-modified: (.+) \S+/i', $result['header'], $o) ? strtotime($o[1] . 'Z') : time()));
-                        if(is_null($type))
-                                $photo_failure = true;
-                }
-                elseif($result['return_code'] == 304) {
-                        $photo = z_root() . '/photo/' . $hash . '-4';
-                        $thumb = z_root() . '/photo/' . $hash . '-5';
-                        $micro = z_root() . '/photo/' . $hash . '-6';
-                }
-                else {
-                        $photo_failure = true;
-                }
-
-        }
-        else
-                $photo_failure = true;
-
-        if(! $photo_failure && $result['return_code'] != 304) {
-                $img = photo_factory($img_str, $type);
-                if($img->is_valid()) {
-                        $width = $img->getWidth();
-                        $height = $img->getHeight();
-
-                        if($width && $height) {
-                                if(($width / $height) > 1.2) {
-                                        // crop out the sides
-                                        $margin = $width - $height;
-                                        $img->cropImage(300,($margin / 2),0,$height,$height);
-                                }
-                                elseif(($height / $width) > 1.2) {
-                                        // crop out the bottom
-                                        $margin = $height - $width;
-                                        $img->cropImage(300,0,0,$width,$width);
-
-                                }
-                                else {
-                                        $img->scaleImageSquare(300);
-                                }
-
-                        }
-                        else
-                                $photo_failure = true;
-
-                        $p = array(
-							'xchan' => $xchan,
-							'resource_id' => $hash,
-							'filename' => basename($photo),
-							'album' => $album,
-							'photo_usage' => $flags,
-							'imgscale' => 4,
-							'edited' => $modified
-						);
-
-                        $r = $img->save($p);
-
-                        if($r === false)
-                                $photo_failure = true;
-
-                        $img->scaleImage(80);
-                        $p['imgscale'] = 5;
-
-                        $r = $img->save($p);
-
-                        if($r === false)
-                                $photo_failure = true;
-
-                        $img->scaleImage(48);
-                        $p['imgscale'] = 6;
-
-                        $r = $img->save($p);
-
-                        if($r === false)
-                                $photo_failure = true;
-
-                        $photo = z_root() . '/photo/' . $hash . '-4';
-                        $thumb = z_root() . '/photo/' . $hash . '-5';
-                        $micro = z_root() . '/photo/' . $hash . '-6';
-                }
-                else {
-                        logger('import_xchan_photo: invalid image from ' . $photo);
-                        $photo_failure = true;
-                }
-        }
-        if($photo_failure) {
-                $default = get_default_profile_photo();
-                $photo = z_root() . '/' . $default;
-                $thumb = z_root() . '/' . get_default_profile_photo(80);
-                $micro = z_root() . '/' . get_default_profile_photo(48);
-                $type = 'image/png';
-                $modified = gmdate('Y-m-d H:i:s', filemtime($default));
-        }
-
-		logger('HTTP code: ' . $result['return_code'] . '; modified: ' . $modified . '; failure: ' . ($photo_failure ? 'yes' : 'no') . '; URL: ' . $photo, LOGGER_DEBUG);
-        return(array($photo,$thumb,$micro,$type,$photo_failure,$modified));
-
-}
-
-function import_channel_photo_from_url($photo,$aid,$uid) {
+	$photo_failure = false;
+	$img_str = '';
 
 	if($photo) {
-		$filename = basename($photo);
 
-		$result = z_fetch_url($photo,true);
+		if($force || $modified == '') {
+			$result = z_fetch_url($photo, true);
+		} else {
+			$h = [
+					'headers' => [
+							'If-Modified-Since: ' . gmdate('D, d M Y H:i:s', strtotime($modified . 'Z')) . ' GMT'
+					]
+			];
+			$result = z_fetch_url($photo, true, 0, $h);
+		}
 
 		if($result['success']) {
 			$img_str = $result['body'];
 			$type = guess_image_type($photo, $result['header']);
+			$modified = gmdate('Y-m-d H:i:s', (preg_match('/last-modified: (.+) \S+/i', $result['header'], $o) ? strtotime($o[1] . 'Z') : time()));
+			if(is_null($type))
+				$photo_failure = true;
+		} elseif($result['return_code'] == 304) {
+			$photo = z_root() . '/photo/' . $hash . '-4';
+			$thumb = z_root() . '/photo/' . $hash . '-5';
+			$micro = z_root() . '/photo/' . $hash . '-6';
+		} else {
+			$photo_failure = true;
+		}
+	} else {
+		$photo_failure = true;
+	}
 
-            if(is_null($type))
-                    $photo_failure = true;
+	if(!$photo_failure && $result['return_code'] != 304) {
+		$img = photo_factory($img_str, $type);
+		if($img->is_valid()) {
+			$width = $img->getWidth();
+			$height = $img->getHeight();
+
+			if($width && $height) {
+				if(($width / $height) > 1.2) {
+					// crop out the sides
+					$margin = $width - $height;
+					$img->cropImage(300, ($margin / 2), 0, $height, $height);
+				} elseif(($height / $width) > 1.2) {
+					// crop out the bottom
+					$margin = $height - $width;
+					$img->cropImage(300, 0, 0, $width, $width);
+				} else {
+					$img->scaleImageSquare(300);
+				}
+			} else {
+				$photo_failure = true;
+			}
+
+			$p = [
+					'xchan' => $xchan,
+					'resource_id' => $hash,
+					'filename' => basename($photo),
+					'album' => $album,
+					'photo_usage' => $flags,
+					'imgscale' => 4,
+					'edited' => $modified,
+			];
+
+			$r = $img->save($p);
+			if($r === false)
+				$photo_failure = true;
+
+			$img->scaleImage(80);
+			$p['imgscale'] = 5;
+			$r = $img->save($p);
+			if($r === false)
+				$photo_failure = true;
+
+			$img->scaleImage(48);
+			$p['imgscale'] = 6;
+			$r = $img->save($p);
+			if($r === false)
+				$photo_failure = true;
+
+			$photo = z_root() . '/photo/' . $hash . '-4';
+			$thumb = z_root() . '/photo/' . $hash . '-5';
+			$micro = z_root() . '/photo/' . $hash . '-6';
+		} else {
+			logger('Invalid image from ' . $photo);
+			$photo_failure = true;
 		}
 	}
-	else {
-		$photo_failure = true;
+	if($photo_failure) {
+		$default = get_default_profile_photo();
+		$photo = z_root() . '/' . $default;
+		$thumb = z_root() . '/' . get_default_profile_photo(80);
+		$micro = z_root() . '/' . get_default_profile_photo(48);
+		$type = 'image/png';
+		$modified = gmdate('Y-m-d H:i:s', filemtime($default));
 	}
 
-	import_channel_photo($img_str,$type,$aid,$uid);
+	logger('HTTP code: ' . $result['return_code'] . '; modified: ' . $modified
+			. '; failure: ' . ($photo_failure ? 'yes' : 'no') . '; URL: ' . $photo, LOGGER_DEBUG);
 
-	return $type;
+	return(array($photo,$thumb,$micro,$type,$photo_failure,$modified));
 }
 
+/**
+  * @brief Import channel photo from a URL.
+ *
+ * @param string $photo URL to a photo
+ * @param int $aid
+ * @param int $uid channel_id
+ * @return null|string Guessed image mimetype or null.
+ */
+function import_channel_photo_from_url($photo, $aid, $uid) {
+	$type = null;
 
-function import_channel_photo($photo,$type,$aid,$uid) {
+	if($photo) {
+		$result = z_fetch_url($photo, true);
+
+		if($result['success']) {
+			$img_str = $result['body'];
+			$type = guess_image_type($photo, $result['header']);
 
-	logger('import_channel_photo: importing channel photo for ' . $uid, LOGGER_DEBUG);
+			import_channel_photo($img_str, $type, $aid, $uid);
+		}
+	}
 
-	$hash = photo_new_resource();
+	return $type;
+}
 
-	$photo_failure = false;
+/**
+ * @brief Import a channel photo and prepare its miniatures.
+ *
+ * @param string $photo Image data
+ * @param string $type
+ * @param int $aid
+ * @param int $uid channel_id
+ * @return boolean|string false on failure, otherwise resource_id of photo
+ */
+function import_channel_photo($photo, $type, $aid, $uid) {
 
+	logger('Importing channel photo for ' . $uid, LOGGER_DEBUG);
 
+	$photo_failure = false;
+	$hash = photo_new_resource();
 	$filename = $hash;
 
 	$img = photo_factory($photo, $type);
 	if($img->is_valid()) {
 
+		// config array for image save method
+		$p = [
+				'aid' => $aid,
+				'uid' => $uid,
+				'resource_id' => $hash,
+				'filename' => $filename,
+				'album' => t('Profile Photos'),
+				'photo_usage' => PHOTO_PROFILE,
+				'imgscale' => 4,
+		];
+
+		// photo size
 		$img->scaleImageSquare(300);
-
-		$p = array('aid' => $aid, 'uid' => $uid, 'resource_id' => $hash, 'filename' => $filename, 'album' => t('Profile Photos'), 'photo_usage' => PHOTO_PROFILE, 'imgscale' => 4);
-
 		$r = $img->save($p);
-
 		if($r === false)
 			$photo_failure = true;
 
+		// thumb size
 		$img->scaleImage(80);
 		$p['imgscale'] = 5;
-
 		$r = $img->save($p);
-
 		if($r === false)
 			$photo_failure = true;
 
+		// micro size
 		$img->scaleImage(48);
 		$p['imgscale'] = 6;
-
 		$r = $img->save($p);
-
 		if($r === false)
 			$photo_failure = true;
 
-	}
-	else {
-		logger('import_channel_photo: invalid image.');
+	} else {
+		logger('Invalid image.');
 		$photo_failure = true;
 	}
 
-	//return(($photo_failure)? false : true);
-
 	if($photo_failure)
 		return false;
 	else
 		return $hash;
-
 }
-- 
cgit v1.2.3


From e6dadb215e9e08491ae57ab851960a0973d3f704 Mon Sep 17 00:00:00 2001
From: Klaus Weidenbach <Klaus.Weidenbach@gmx.net>
Date: Tue, 5 Feb 2019 23:03:03 +0100
Subject: Refactor photo_driver to use namespaces.

Add simple UnitTest, but it is not yet very meaningful.
---
 include/photo/photo_driver.php  | 470 +---------------------------------------
 include/photo/photo_gd.php      | 162 --------------
 include/photo/photo_imagick.php | 213 ------------------
 3 files changed, 12 insertions(+), 833 deletions(-)
 delete mode 100644 include/photo/photo_gd.php
 delete mode 100644 include/photo/photo_imagick.php

(limited to 'include')

diff --git a/include/photo/photo_driver.php b/include/photo/photo_driver.php
index 718bf875b..c11580bdc 100644
--- a/include/photo/photo_driver.php
+++ b/include/photo/photo_driver.php
@@ -1,15 +1,19 @@
 <?php
 
+use Zotlabs\Photo\PhotoDriver;
+use Zotlabs\Photo\PhotoGd;
+use Zotlabs\Photo\PhotoImagick;
+
 /**
- * @brief Return a photo_driver object.
+ * @brief Return a PhotoDriver object.
  *
  * Use this factory when manipulating images.
  *
  * Return a photo driver object implementing ImageMagick or GD.
  *
  * @param string $data Image data
- * @param string $type
- * @return null|photo_driver
+ * @param string $type Mimetype
+ * @return null|PhotoDriver
  *   NULL if unsupported image type or failure, otherwise photo driver object
  */
 function photo_factory($data, $type = null) {
@@ -34,8 +38,7 @@ function photo_factory($data, $type = null) {
 		$v = Imagick::getVersion();
 		preg_match('/ImageMagick ([0-9]+\.[0-9]+\.[0-9]+)/', $v['versionString'], $m);
 		if(version_compare($m[1], '6.6.7') >= 0) {
-			require_once('include/photo/photo_imagick.php');
-			$ph = new photo_imagick($data, $type);
+			$ph = new PhotoImagick($data, $type);
 		} else {
 			// earlier imagick versions have issues with scaling png's
 			// don't log this because it will just fill the logfile.
@@ -45,462 +48,13 @@ function photo_factory($data, $type = null) {
 	}
 
 	if(! $ph) {
-		require_once('include/photo/photo_gd.php');
-		$ph = new photo_gd($data, $type);
+		$ph = new PhotoGd($data, $type);
 	}
 
 	return $ph;
 }
 
 
-/**
- * @brief Abstract photo driver class.
- *
- */
-abstract class photo_driver {
-
-	protected $image;
-	protected $width;
-	protected $height;
-	protected $valid;
-	protected $type;
-	protected $types;
-
-	abstract function supportedTypes();
-
-	abstract function load($data,$type);
-
-	abstract function destroy();
-
-	abstract function setDimensions();
-
-	abstract function getImage();
-
-	abstract function doScaleImage($new_width,$new_height);
-
-	abstract function rotate($degrees);
-
-	abstract function flip($horiz = true, $vert = false);
-
-	abstract function cropImage($max,$x,$y,$w,$h);
-
-	abstract function cropImageRect($maxx,$maxy,$x,$y,$w,$h);
-
-	abstract function imageString();
-
-	abstract function clearexif();
-
-	public function __construct($data, $type='') {
-		$this->types = $this->supportedTypes();
-		if (! array_key_exists($type, $this->types)){
-			$type = 'image/jpeg';
-		}
-		$this->type = $type;
-		$this->valid = false;
-		$this->load($data, $type);
-	}
-
-	public function __destruct() {
-		if($this->is_valid())
-			$this->destroy();
-	}
-
-	public function is_valid() {
-		return $this->valid;
-	}
-
-	public function getWidth() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return $this->width;
-	}
-
-	public function getHeight() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return $this->height;
-	}
-
-
-	public function saveImage($path) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return (file_put_contents($path, $this->imageString()) ? true : false);
-	}
-
-
-	public function getType() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return $this->type;
-	}
-
-	public function getExt() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return $this->types[$this->getType()];
-	}
-
-	/**
-	 * @brief Scale image to max pixel size in either dimension.
-	 *
-	 * @param int $max maximum pixel size in either dimension
-	 * @param boolean $float_height (optional)
-	 *   if true allow height to float to any length on tall images, constraining
-	 *   only the width
-	 *  @return boolean|void false on failure, otherwise void
-	 */
-	public function scaleImage($max, $float_height = true) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$width = $this->width;
-		$height = $this->height;
-
-		$dest_width = $dest_height = 0;
-
-		if((! $width)|| (! $height))
-			return FALSE;
-
-		if($width > $max && $height > $max) {
-
-			// very tall image (greater than 16:9)
-			// constrain the width - let the height float.
-
-			if(((($height * 9) / 16) > $width) && ($float_height)) {
-				$dest_width = $max;
-	 			$dest_height = intval(( $height * $max ) / $width);
-			}
-
-			// else constrain both dimensions
-
-			elseif($width > $height) {
-				$dest_width = $max;
-				$dest_height = intval(( $height * $max ) / $width);
-			}
-			else {
-				$dest_width = intval(( $width * $max ) / $height);
-				$dest_height = $max;
-			}
-		}
-		else {
-			if( $width > $max ) {
-				$dest_width = $max;
-				$dest_height = intval(( $height * $max ) / $width);
-			}
-			else {
-				if( $height > $max ) {
-
-					// very tall image (greater than 16:9)
-					// but width is OK - don't do anything
-
-					if(((($height * 9) / 16) > $width) && ($float_height)) {
-						$dest_width = $width;
-	 					$dest_height = $height;
-					}
-					else {
-						$dest_width = intval(( $width * $max ) / $height);
-						$dest_height = $max;
-					}
-				}
-				else {
-					$dest_width = $width;
-					$dest_height = $height;
-				}
-			}
-		}
-		$this->doScaleImage($dest_width,$dest_height);
-	}
-
-	public function scaleImageUp($min) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$width = $this->width;
-		$height = $this->height;
-
-		$dest_width = $dest_height = 0;
-
-		if((! $width)|| (! $height))
-			return FALSE;
-
-		if($width < $min && $height < $min) {
-			if($width > $height) {
-				$dest_width = $min;
-				$dest_height = intval(( $height * $min ) / $width);
-			}
-			else {
-				$dest_width = intval(( $width * $min ) / $height);
-				$dest_height = $min;
-			}
-		}
-		else {
-			if( $width < $min ) {
-				$dest_width = $min;
-				$dest_height = intval(( $height * $min ) / $width);
-			}
-			else {
-				if( $height < $min ) {
-					$dest_width = intval(( $width * $min ) / $height);
-					$dest_height = $min;
-				}
-				else {
-					$dest_width = $width;
-					$dest_height = $height;
-				}
-			}
-		}
-		$this->doScaleImage($dest_width,$dest_height);
-	}
-
-	/**
-	 * @brief Scales image to a square.
-	 *
-	 * @param int $dim Pixel of squre image
-	 * @return boolean|void false on failure, otherwise void
-	 */
-	public function scaleImageSquare($dim) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->doScaleImage($dim, $dim);
-	}
-
-	/**
-	 * @brief reads exif data from filename.
-	 *
-	 * @param string $filename
-	 * @return boolean|array
-	 */
-	public function exif($filename) {
-
-		if((! function_exists('exif_read_data'))
-			|| (! in_array($this->getType(), [ 'image/jpeg' , 'image/tiff'] ))) {
-			return false;
-		}
-
-		/*
-		 * PHP 7.2 allows you to use a stream resource, which should reduce/avoid
-		 * memory exhaustion on large images.
-		 */
-
-		if(version_compare(PHP_VERSION, '7.2.0') >= 0) {
-			$f = @fopen($filename, 'rb');
-		}
-		else {
-			$f = $filename;
-		}
-
-		if($f) {
-			return @exif_read_data($f,null,true);
-		}
-
-		return false;
-	}
-
-	/**
-	 * @brief Orients current image based on exif orientation information.
-	 *
-	 * @param array $exif
-	 * @return boolean true if oriented, otherwise false
-	 */
-	public function orient($exif) {
-
-		if(! ($this->is_valid() && $exif)) {
-			return false;
-		}
-
-		$ort = ((array_key_exists('IFD0', $exif)) ? $exif['IFD0']['Orientation'] : $exif['Orientation']);
-
-		if(! $ort) {
-			return false;
-		}
-
-		switch($ort) {
-			case 1: // nothing
-				break;
-			case 2: // horizontal flip
-				$this->flip();
-				break;
-			case 3: // 180 rotate left
-				$this->rotate(180);
-				break;
-			case 4: // vertical flip
-				$this->flip(false, true);
-				break;
-			case 5: // vertical flip + 90 rotate right
-				$this->flip(false, true);
-				$this->rotate(-90);
-				break;
-			case 6: // 90 rotate right
-				$this->rotate(-90);
-				break;
-			case 7: // horizontal flip + 90 rotate right
-				$this->flip();
-				$this->rotate(-90);
-				break;
-			case 8: // 90 rotate left
-				$this->rotate(90);
-				break;
-			default:
-				break;
-		}
-
-		return true;
-	}
-
-	/**
-	 * @brief Save photo to database.
-	 *
-	 * @param array $arr
-	 * @param boolean $skipcheck (optional) default false
-	 * @return boolean|array
-	 */
-	public function save($arr, $skipcheck = false) {
-
-		if(! ($skipcheck || $this->is_valid())) {
-			logger('Attempt to store invalid photo.');
-			return false;
-		}
-
-		$p = [];
-
-		$p['aid'] = ((intval($arr['aid'])) ? intval($arr['aid']) : 0);
-		$p['uid'] = ((intval($arr['uid'])) ? intval($arr['uid']) : 0);
-		$p['xchan'] = (($arr['xchan']) ? $arr['xchan'] : '');
-		$p['resource_id'] = (($arr['resource_id']) ? $arr['resource_id'] : '');
-		$p['filename'] = (($arr['filename']) ? $arr['filename'] : '');
-		$p['mimetype'] = (($arr['mimetype']) ? $arr['mimetype'] : $this->getType());
-		$p['album'] = (($arr['album']) ? $arr['album'] : '');
-		$p['imgscale'] = ((intval($arr['imgscale'])) ? intval($arr['imgscale']) : 0);
-		$p['allow_cid'] = (($arr['allow_cid']) ? $arr['allow_cid'] : '');
-		$p['allow_gid'] = (($arr['allow_gid']) ? $arr['allow_gid'] : '');
-		$p['deny_cid'] = (($arr['deny_cid']) ? $arr['deny_cid'] : '');
-		$p['deny_gid'] = (($arr['deny_gid']) ? $arr['deny_gid'] : '');
-		$p['edited'] = (($arr['edited']) ? $arr['edited'] : datetime_convert());
-		$p['title'] = (($arr['title']) ? $arr['title'] : '');
-		$p['description'] = (($arr['description']) ? $arr['description'] : '');
-		$p['photo_usage'] = intval($arr['photo_usage']);
-		$p['os_storage'] = intval($arr['os_storage']);
-		$p['os_path'] = $arr['os_path'];
-		$p['os_syspath'] = ((array_key_exists('os_syspath',$arr)) ? $arr['os_syspath'] : '');
-		$p['display_path'] = (($arr['display_path']) ? $arr['display_path'] : '');
-		$p['width'] = (($arr['width']) ? $arr['width'] : $this->getWidth());
-		$p['height'] = (($arr['height']) ? $arr['height'] : $this->getHeight());
-		$p['expires'] = (($arr['expires']) ? $arr['expires'] : gmdate('Y-m-d H:i:s', time() + get_config('system','photo_cache_time', 86400)));
-
-		if(! intval($p['imgscale']))
-			logger('save: ' . print_r($arr, true), LOGGER_DATA);
-
-		$x = q("select id, created from photo where resource_id = '%s' and uid = %d and xchan = '%s' and imgscale = %d limit 1",
-				dbesc($p['resource_id']),
-				intval($p['uid']),
-				dbesc($p['xchan']),
-				intval($p['imgscale'])
-		);
-
-		if($x) {
-			$p['created'] = (($x['created']) ? $x['created'] : $p['edited']);
-			$r = q("UPDATE photo set
-				aid = %d,
-				uid = %d,
-				xchan = '%s',
-				resource_id = '%s',
-				created = '%s',
-				edited = '%s',
-				filename = '%s',
-				mimetype = '%s',
-				album = '%s',
-				height = %d,
-				width = %d,
-				content = '%s',
-				os_storage = %d,
-				filesize = %d,
-				imgscale = %d,
-				photo_usage = %d,
-				title = '%s',
-				description = '%s',
-				os_path = '%s',
-				display_path = '%s',
-				allow_cid = '%s',
-				allow_gid = '%s',
-				deny_cid = '%s',
-				deny_gid = '%s',
-				expires = '%s'
-				where id = %d",
-
-				intval($p['aid']),
-				intval($p['uid']),
-				dbesc($p['xchan']),
-				dbesc($p['resource_id']),
-				dbescdate($p['created']),
-				dbescdate($p['edited']),
-				dbesc(basename($p['filename'])),
-				dbesc($p['mimetype']),
-				dbesc($p['album']),
-				intval($p['height']),
-				intval($p['width']),
-				(intval($p['os_storage']) ? dbescbin($p['os_syspath']) : dbescbin($this->imageString())),
-				intval($p['os_storage']),
-				(intval($p['os_storage']) ? @filesize($p['os_syspath']) : strlen($this->imageString())),
-				intval($p['imgscale']),
-				intval($p['photo_usage']),
-				dbesc($p['title']),
-				dbesc($p['description']),
-				dbesc($p['os_path']),
-				dbesc($p['display_path']),
-				dbesc($p['allow_cid']),
-				dbesc($p['allow_gid']),
-				dbesc($p['deny_cid']),
-				dbesc($p['deny_gid']),
-				dbescdate($p['expires']),
-				intval($x[0]['id'])
-			);
-		}
-		else {
-			$p['created'] = (($arr['created']) ? $arr['created'] : $p['edited']);
-			$r = q("INSERT INTO photo
-				( aid, uid, xchan, resource_id, created, edited, filename, mimetype, album, height, width, content, os_storage, filesize, imgscale, photo_usage, title, description, os_path, display_path, allow_cid, allow_gid, deny_cid, deny_gid, expires )
-				VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', %d, %d, %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s' )",
-				intval($p['aid']),
-				intval($p['uid']),
-				dbesc($p['xchan']),
-				dbesc($p['resource_id']),
-				dbescdate($p['created']),
-				dbescdate($p['edited']),
-				dbesc(basename($p['filename'])),
-				dbesc($p['mimetype']),
-				dbesc($p['album']),
-				intval($p['height']),
-				intval($p['width']),
-				(intval($p['os_storage']) ? dbescbin($p['os_syspath']) : dbescbin($this->imageString())),
-				intval($p['os_storage']),
-				(intval($p['os_storage']) ? @filesize($p['os_syspath']) : strlen($this->imageString())),
-				intval($p['imgscale']),
-				intval($p['photo_usage']),
-				dbesc($p['title']),
-				dbesc($p['description']),
-				dbesc($p['os_path']),
-				dbesc($p['display_path']),
-				dbesc($p['allow_cid']),
-				dbesc($p['allow_gid']),
-				dbesc($p['deny_cid']),
-				dbesc($p['deny_gid']),
-				dbescdate($p['expires'])
-			);
-		}
-		logger('Photo save ' . $p['imgscale'] . ' returned ' . intval($r));
-
-		return $r;
-	}
-
-}
-
 /**
  * @brief Guess image mimetype from filename or from Content-Type header.
  *
@@ -519,7 +73,7 @@ function guess_image_type($filename, $headers = '') {
 		$hdrs = [];
 		$h = explode("\n", $headers);
 		foreach ($h as $l) {
-			list($k,$v) = array_map('trim', explode(':', trim($l), 2));
+			list($k, $v) = array_map('trim', explode(':', trim($l), 2));
 			$hdrs[strtolower($k)] = $v;
 		}
 		logger('Curl headers: ' .var_export($hdrs, true), LOGGER_DEBUG);
@@ -566,7 +120,7 @@ function guess_image_type($filename, $headers = '') {
 			}
 		}
 
-		if(is_null($type) && (strpos($filename,'http') === false)) {
+		if(is_null($type) && (strpos($filename, 'http') === false)) {
 			$size = getimagesize($filename);
 			$ph = photo_factory('');
 			$types = $ph->supportedTypes();
@@ -756,7 +310,7 @@ function import_xchan_photo($photo, $xchan, $thing = false, $force = false) {
 	logger('HTTP code: ' . $result['return_code'] . '; modified: ' . $modified
 			. '; failure: ' . ($photo_failure ? 'yes' : 'no') . '; URL: ' . $photo, LOGGER_DEBUG);
 
-	return(array($photo,$thumb,$micro,$type,$photo_failure,$modified));
+	return([$photo, $thumb, $micro, $type, $photo_failure, $modified]);
 }
 
 /**
diff --git a/include/photo/photo_gd.php b/include/photo/photo_gd.php
deleted file mode 100644
index e98ac2827..000000000
--- a/include/photo/photo_gd.php
+++ /dev/null
@@ -1,162 +0,0 @@
-<?php /** @file */
-
-
-require_once('include/photo/photo_driver.php');
-
-
-class photo_gd extends photo_driver {
-
-	function supportedTypes() {
-		$t = array();
-		$t['image/jpeg'] ='jpg';
-		if (imagetypes() & IMG_PNG) $t['image/png'] = 'png';
-		if (imagetypes() & IMG_GIF) $t['image/gif'] = 'gif';
-		return $t;
-
-	}
-
-	function load($data, $type) {
-		$this->valid = false;
-		if(! $data)
-			return;
-
-		$this->image = @imagecreatefromstring($data);
-		if($this->image !== FALSE) {
-			$this->valid  = true;
-			$this->setDimensions();
-			imagealphablending($this->image, false);
-			imagesavealpha($this->image, true);
-		}
-	}
-
-	function setDimensions() {
-		$this->width  = imagesx($this->image);
-		$this->height = imagesy($this->image);
-	}
-
-
-	public function clearexif() {
-		return;
-	}
-
-
-	public function destroy() {
-		if($this->is_valid()) {
-			imagedestroy($this->image);
-		}
-	}
-
-	public function getImage() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		return $this->image;
-	}
-
-	public function doScaleImage($dest_width,$dest_height) {
-
-		$dest = imagecreatetruecolor( $dest_width, $dest_height );
-		$width = imagesx($this->image);
-		$height = imagesy($this->image);
-
-		imagealphablending($dest, false);
-		imagesavealpha($dest, true);
-		if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
-		imagecopyresampled($dest, $this->image, 0, 0, 0, 0, $dest_width, $dest_height, $width, $height);
-		if($this->image)
-			imagedestroy($this->image);
-		$this->image = $dest;
-		$this->setDimensions();
-	}
-
-	public function rotate($degrees) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image  = imagerotate($this->image,$degrees,0);
-		$this->setDimensions();
-	}
-
-	public function flip($horiz = true, $vert = false) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$w = imagesx($this->image);
-		$h = imagesy($this->image);
-		$flipped = imagecreate($w, $h);
-		if($horiz) {
-			for ($x = 0; $x < $w; $x++) {
-				imagecopy($flipped, $this->image, $x, 0, $w - $x - 1, 0, 1, $h);
-			}
-		}
-		if($vert) {
-			for ($y = 0; $y < $h; $y++) {
-				imagecopy($flipped, $this->image, 0, $y, 0, $h - $y - 1, $w, 1);
-			}
-		}
-		$this->image = $flipped;
-		$this->setDimensions(); // Shouldn't really be necessary
-	}
-
-	public function cropImage($max,$x,$y,$w,$h) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$dest = imagecreatetruecolor( $max, $max );
-		imagealphablending($dest, false);
-		imagesavealpha($dest, true);
-		if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
-		imagecopyresampled($dest, $this->image, 0, 0, $x, $y, $max, $max, $w, $h);
-		if($this->image)
-			imagedestroy($this->image);
-		$this->image = $dest;
-		$this->setDimensions();
-	}
-
-	public function cropImageRect($maxx,$maxy,$x,$y,$w,$h) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$dest = imagecreatetruecolor( $maxx, $maxy );
-		imagealphablending($dest, false);
-		imagesavealpha($dest, true);
-		if ($this->type=='image/png') imagefill($dest, 0, 0, imagecolorallocatealpha($dest, 0, 0, 0, 127)); // fill with alpha
-		imagecopyresampled($dest, $this->image, 0, 0, $x, $y, $maxx, $maxy, $w, $h);
-		if($this->image)
-			imagedestroy($this->image);
-		$this->image = $dest;
-		$this->setDimensions();
-	}
-
-
-
-	public function imageString() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$quality = FALSE;
-
-		ob_start();
-
-		switch($this->getType()){
-			case "image/png":
-				$quality = get_config('system','png_quality');
-				if((! $quality) || ($quality > 9))
-					$quality = PNG_QUALITY;
-				imagepng($this->image,NULL, $quality);
-				break;
-			case "image/jpeg":
-			default:
-				$quality = get_config('system','jpeg_quality');
-				if((! $quality) || ($quality > 100))
-					$quality = JPEG_QUALITY;
-				imagejpeg($this->image,NULL,$quality);
-				break;
-		}
-		$string = ob_get_contents();
-		ob_end_clean();
-
-		return $string;
-	}
-
-}
diff --git a/include/photo/photo_imagick.php b/include/photo/photo_imagick.php
deleted file mode 100644
index cb3ad27fb..000000000
--- a/include/photo/photo_imagick.php
+++ /dev/null
@@ -1,213 +0,0 @@
-<?php /** @file */
-
-
-require_once('include/photo/photo_driver.php');
-
-
-class photo_imagick extends photo_driver {
-
-
-	function supportedTypes() {
-		return array(
-			'image/jpeg' => 'jpg',
-			'image/png' => 'png',
-			'image/gif' => 'gif'
-		);
-	}
-
-	public function get_FormatsMap() {
-		return array(
-			'image/jpeg' => 'JPG',
-			'image/png' => 'PNG',
-			'image/gif' => 'GIF'
-		);
-	}
-
-
-	function load($data, $type) {
-		$this->valid = false;
-		$this->image = new Imagick();
-
-		if(! $data)
-			return;
-
-		try {
-			$this->image->readImageBlob($data);
-		}
-		catch (Exception $e) {
-			logger('imagick readImageBlob() exception:' . print_r($e,true));
-			return;
-		}
-
-		/**
-		 * Setup the image to the format it will be saved to
-		 */
-
-		$map = $this->get_FormatsMap();
-		$format = $map[$type];
-
-		if($this->image) {
-			$this->image->setFormat($format);
-
-			// Always coalesce, if it is not a multi-frame image it won't hurt anyway
-			$this->image = $this->image->coalesceImages();
-
-
-			$this->valid = true;
-			$this->setDimensions();
-
-			/**
-			 * setup the compression here, so we'll do it only once
-			 */
-			switch($this->getType()) {
-				case "image/png":
-					$quality = get_config('system','png_quality');
-					if((! $quality) || ($quality > 9))
-						$quality = PNG_QUALITY;
-					/**
-					 * From http://www.imagemagick.org/script/command-line-options.php#quality:
-					 *
-					 * 'For the MNG and PNG image formats, the quality value sets
-					 * the zlib compression level (quality / 10) and filter-type (quality % 10).
-					 * The default PNG "quality" is 75, which means compression level 7 with adaptive PNG filtering,
-					 * unless the image has a color map, in which case it means compression level 7 with no PNG filtering'
-					 */
-					$quality = $quality * 10;
-					$this->image->setCompressionQuality($quality);
-					break;
-				case "image/jpeg":
-					$quality = get_config('system','jpeg_quality');
-					if((! $quality) || ($quality > 100))
-						$quality = JPEG_QUALITY;
-					$this->image->setCompressionQuality($quality);
-				default:
-					break;
-
-			}
-		}
-	}
-
-	public function destroy() {
-		if($this->is_valid()) {
-			$this->image->clear();
-			$this->image->destroy();
-		}
-	}
-
-
-	public function setDimensions() {
-		$this->width = $this->image->getImageWidth();
-		$this->height = $this->image->getImageHeight();
-	}
-
-
-	public function clearexif() {
-
-		$profiles = $this->image->getImageProfiles("icc", true);
-
-		$this->image->stripImage();
-
-		if(!empty($profiles)) {
-    		$this->image->profileImage("icc", $profiles['icc']);
-		}
-	}
-
-
-
-	public function getImage() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image = $this->image->deconstructImages();
-		return $this->image;
-	}
-
-	public function doScaleImage($dest_width,$dest_height) {
-
-		/**
-		 * If it is not animated, there will be only one iteration here,
-		 * so don't bother checking
-		 */
-		// Don't forget to go back to the first frame
-		$this->image->setFirstIterator();
-		do {
-			$this->image->scaleImage($dest_width, $dest_height);
-		} while ($this->image->nextImage());
-
-		$this->setDimensions();
-	}
-
-	public function rotate($degrees) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image->setFirstIterator();
-		do {
-			// ImageMagick rotates in the opposite direction of imagerotate()
-			$this->image->rotateImage(new ImagickPixel(), -$degrees); 
-		} while ($this->image->nextImage());
-
-		$this->setDimensions();
-	}
-
-	public function flip($horiz = true, $vert = false) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image->setFirstIterator();
-		do {
-			if($horiz) $this->image->flipImage();
-			if($vert) $this->image->flopImage();
-		} while ($this->image->nextImage());
-
-		$this->setDimensions(); // Shouldn't really be necessary
-	}
-
-	public function cropImage($max,$x,$y,$w,$h) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image->setFirstIterator();
-		do {
-			$this->image->cropImage($w, $h, $x, $y);
-			/**
-			 * We need to remove the canvas,
-			 * or the image is not resized to the crop:
-			 * http://php.net/manual/en/imagick.cropimage.php#97232
-			 */
-			$this->image->setImagePage(0, 0, 0, 0);
-		} while ($this->image->nextImage());
-
-		$this->doScaleImage($max,$max);
-	}
-
-	public function cropImageRect($maxx,$maxy,$x,$y,$w,$h) {
-		if(!$this->is_valid())
-			return FALSE;
-
-		$this->image->setFirstIterator();
-		do {
-			$this->image->cropImage($w, $h, $x, $y);
-			/**
-			 * We need to remove the canvas,
-			 * or the image is not resized to the crop:
-			 * http://php.net/manual/en/imagick.cropimage.php#97232
-			 */
-			$this->image->setImagePage(0, 0, 0, 0);
-		} while ($this->image->nextImage());
-
-		$this->doScaleImage($maxx,$maxy);
-	}
-
-	public function imageString() {
-		if(!$this->is_valid())
-			return FALSE;
-
-		/* Clean it */
-		$this->image = $this->image->deconstructImages();
-		return $this->image->getImagesBlob();
-	}
-
-
-
-}
-- 
cgit v1.2.3


From cfcbaf33afa2cee1f458a20fe6c3fd4e76999cd5 Mon Sep 17 00:00:00 2001
From: "M.Dent" <dentm42@dm42.net>
Date: Mon, 18 Feb 2019 22:40:19 -0500
Subject: Fix: post_activity_item returns success => true even on failure.

---
 include/items.php | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'include')

diff --git a/include/items.php b/include/items.php
index a14e3db3a..30e758add 100755
--- a/include/items.php
+++ b/include/items.php
@@ -486,6 +486,8 @@ function post_activity_item($arr, $allow_code = false, $deliver = true) {
 		 */
 		call_hooks('post_local_end', $ret['activity']);
 	}
+	else
+		return $ret;
 
 	if($post_id && $deliver) {
 		Master::Summon([ 'Notifier','activity',$post_id ]);
-- 
cgit v1.2.3