Merge branch 'embedphotos' into 'dev'

Try to fix some warnings in Zotlabs\Module\Embedphotos.

See merge request hubzilla/core!1481

Zotlabs/Module/Embedphotos.php

@@ -3,8 +3,10 @@
 namespace Zotlabs\Module;
 
 /**
- * @brief
+ * @brief Embedphoto endpoint.
  *
+ * Provide an AJAX endpoint to fill the embedPhotoModal with folders and photos
+ * selection.
  */
 class Embedphotos extends \Zotlabs\Web\Controller {
 
@@ -13,42 +15,42 @@ class Embedphotos extends \Zotlabs\Web\Controller {
 	}
 
 	/**
+	 * @brief This is the POST destination for the embedphotos button.
 	 *
-	 * This is the POST destination for the embedphotos button
+	 * @return string A JSON string.
-	 *
 	 */
-	function post() {
+	public function post() {
 		if (argc() > 1 && argv(1) === 'album') {
 			// API: /embedphotos/album
-			$name = (x($_POST,'name') ? $_POST['name'] : null );
+			$name = (x($_POST, 'name') ? $_POST['name'] : null );
-			if(!$name) {
+			if (!$name) {
 				json_return_and_die(array('errormsg' => 'Error retrieving album', 'status' => false));
 			}
 			$album = $this->embedphotos_widget_album(array('channel' => \App::get_channel(), 'album' => $name));
 			json_return_and_die(array('status' => true, 'content' => $album));
 		}
-		if(argc() > 1 && argv(1) === 'albumlist') {
+		if (argc() > 1 && argv(1) === 'albumlist') {
 			// API: /embedphotos/albumlist
-			$album_list = $this->embedphotos_album_list($a);
+			$album_list = $this->embedphotos_album_list();
 			json_return_and_die(array('status' => true, 'albumlist' => $album_list));
 		}
-		if(argc() > 1 && argv(1) === 'photolink') {
+		if (argc() > 1 && argv(1) === 'photolink') {
 			// API: /embedphotos/photolink
-			$href = (x($_POST,'href') ? $_POST['href'] : null );
+			$href = (x($_POST, 'href') ? $_POST['href'] : null );
-			if(!$href) {
+			if (!$href) {
 				json_return_and_die(array('errormsg' => 'Error retrieving link ' . $href, 'status' => false));
 			}
-			$resource_id = array_pop(explode("/", $href));
+			$resource_id = array_pop(explode('/', $href));
 			$r = q("SELECT obj from item where resource_type = 'photo' and resource_id = '%s' limit 1",
 				dbesc($resource_id)
 			);
-			if(!$r) {
+			if (!$r) {
 				json_return_and_die(array('errormsg' => 'Error retrieving resource ' . $resource_id, 'status' => false));
 			}
 			$obj = json_decode($r[0]['obj'], true);
-			if(x($obj,'body')) {
+			if (x($obj, 'body')) {
 				$photolink = $obj['body'];
-			} elseif (x($obj,'bbcode')) {
+			} elseif (x($obj, 'bbcode')) {
 				$photolink = $obj['bbcode'];
 			} else {
 				json_return_and_die(array('errormsg' => 'Error retrieving resource ' . $resource_id, 'status' => false));
@@ -58,48 +60,51 @@ class Embedphotos extends \Zotlabs\Web\Controller {
 	}
 
 	/**
-	 * Copied from include/widgets.php::widget_album() with a modification to get the profile_uid from
+	 * @brief Get photos from an album.
-	 * the input array as in widget_item()
 	 *
-	 * @param array $args
+	 * @see \\Zotlabs\\Widget\\Album::widget()
-	 * @return string with HTML
+	 *
+	 * @param array $args associative array with
+	 *  * \e array \b channel
+	 *  * \e string \b album
+	 * @return string with HTML code from 'photo_album.tpl'
 	 */
-	function embedphotos_widget_album($args) {
+	protected function embedphotos_widget_album($args) {
-
 		$channel_id = 0;
-		if(array_key_exists('channel', $args))
+
+		if (array_key_exists('channel', $args)) {
 			$channel = $args['channel'];
-		$channel_id = intval($channel['channel_id']);
+			$channel_id = intval($channel['channel_id']);
-		if(! $channel_id)
+		}
+		if (! $channel_id)
 			$channel_id = \App::$profile_uid;
-		if(! $channel_id)
+		if (! $channel_id)
 			return '';
 
-		$owner_uid = $channel_id;
 		require_once('include/security.php');
 		$sql_extra = permissions_sql($channel_id);
 
-		if(! perm_is_allowed($channel_id,get_observer_hash(),'view_storage'))
+		if (! perm_is_allowed($channel_id, get_observer_hash(), 'view_storage'))
 			return '';
 
-		if($args['album'])
+		if (isset($args['album']))
 			$album = (($args['album'] === '/') ? '' : $args['album']);
-		if($args['title'])
+		if (isset($args['title']))
 			$title = $args['title'];
 
 		/**
-		 * This may return incorrect permissions if you have multiple directories of the same name.
+		 * @note This may return incorrect permissions if you have multiple directories of the same name.
 		 * It is a limitation of the photo table using a name for a photo album instead of a folder hash
 		 */
-		if($album) {
+		if ($album) {
 			require_once('include/attach.php');
 			$x = q("select hash from attach where filename = '%s' and uid = %d limit 1",
 				dbesc($album),
-				intval($owner_uid)
+				intval($channel_id)
 			);
-			if($x) {
+			if ($x) {
-				$y = attach_can_view_folder($owner_uid,get_observer_hash(),$x[0]['hash']);
+				$y = attach_can_view_folder($channel_id, get_observer_hash(), $x[0]['hash']);
-				if(! $y)
+				if (! $y)
 					return '';
 			}
 		}
@@ -110,30 +115,33 @@ class Embedphotos extends \Zotlabs\Web\Controller {
 				(SELECT resource_id, max(imgscale) imgscale FROM photo WHERE uid = %d AND album = '%s' AND imgscale <= 4 AND photo_usage IN ( %d, %d ) $sql_extra GROUP BY resource_id) ph
 				ON (p.resource_id = ph.resource_id AND p.imgscale = ph.imgscale)
 				ORDER BY created $order",
-				intval($owner_uid),
+				intval($channel_id),
 				dbesc($album),
 				intval(PHOTO_NORMAL),
 				intval(PHOTO_PROFILE)
 		);
 
-		$photos = array();
+		$photos = [];
-		if(count($r)) {
+		if (count($r)) {
 			$twist = 'rotright';
-			foreach($r as $rr) {
+			foreach ($r as $rr) {
-				if($twist == 'rotright')
+				if ($twist == 'rotright')
 					$twist = 'rotleft';
 				else
 					$twist = 'rotright';
 
+				$ph = photo_factory('');
+				$phototypes = $ph->supportedTypes();
+
 				$ext = $phototypes[$rr['mimetype']];
 
 				$imgalt_e = $rr['filename'];
 				$desc_e = $rr['description'];
 
-				$imagelink = (z_root() . '/photos/' . \App::$data['channel']['channel_address'] . '/image/' . $rr['resource_id']
+				$imagelink = (z_root() . '/photos/' . $channel['channel_address'] . '/image/' . $rr['resource_id']
 					. (($_GET['order'] === 'posted') ? '?f=&order=posted' : ''));
 
-				$photos[] = array(
+				$photos[] = [
 						'id' => $rr['id'],
 						'twist' => ' ' . $twist . rand(2,4),
 						'link' => $imagelink,
@@ -143,35 +151,43 @@ class Embedphotos extends \Zotlabs\Web\Controller {
 						'desc'=> $desc_e,
 						'ext' => $ext,
 						'hash'=> $rr['resource_id'],
-						'unknown' => t('Unknown')
+						'unknown' => t('Unknown'),
-					);
+				];
 			}
 		}
 
 		$tpl = get_markup_template('photo_album.tpl');
-		$o .= replace_macros($tpl, array(
+		$o = replace_macros($tpl, [
 			'$photos' => $photos,
 			'$album' => (($title) ? $title : $album),
 			'$album_id' => rand(),
-			'$album_edit' => array(t('Edit Album'), $album_edit),
+			'$album_edit' => array(t('Edit Album'), false),
 			'$can_post' => false,
 			'$upload' => array(t('Upload'), z_root() . '/photos/' . \App::$profile['channel_address'] . '/upload/' . bin2hex($album)),
 			'$order' => false,
-			'$upload_form' => $upload_form,
+			'$upload_form' => '',
-			'$no_fullscreen_btn' => true
+			'$no_fullscreen_btn' => true,
-		));
+		]);
 
 		return $o;
 	}
 
-	function embedphotos_album_list($a) {
+	/**
+	 * @brief Get albums observer is allowed to see.
+	 *
+	 * @see photos_albums_list()
+	 *
+	 * @return NULL|array
+	 */
+	protected function embedphotos_album_list() {
 		require_once('include/photos.php');
 		$p = photos_albums_list(\App::get_channel(), \App::get_observer());
-		if($p['success']) {
+
+		if ($p['success']) {
 			return $p['albums'];
-		} else {
-			return null;
 		}
+
+		return null;
 	}
 
 }