moved classes into classes directory

2 files changed, 535 insertions, 0 deletions

diff --git a/classes/TidypicsAlbum.php b/classes/TidypicsAlbum.php
new file mode 100644
index 000000000..e178acd5d
--- /dev/null
+++ b/classes/TidypicsAlbum.php
@@ -0,0 +1,243 @@
+<?php
+/**
+ * Tidypics Album class
+ *
+ * @package TidypicsAlbum
+ */
+
+
+class TidypicsAlbum extends ElggObject {
+	protected function initialise_attributes() {
+		parent::initialise_attributes();
+
+		$this->attributes['subtype'] = "album";
+	}
+
+	public function __construct($guid = null) {
+		parent::__construct($guid);
+	}
+
+	/**
+	 * Delete album
+	 *
+	 * @return bool
+	 */
+	public function delete() {
+
+		$this->deleteImages();
+		$this->deleteAlbumDir();
+		
+		return parent::delete();
+	}
+
+	/**
+	 * Get an array of image objects
+	 *
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array
+	 */
+	public function getImages($limit, $offset=0) {
+		$imageList = $this->getImageList();
+		if ($offset > count($imageList)) {
+			return array();
+		}
+
+		$imageList = array_slice($imageList, $offset, $limit);
+		
+		$images = array();
+		foreach ($imageList as $guid) {
+			$images[] = get_entity($guid);
+		}
+		return $images;
+	}
+
+	/**
+	 * View a list of images
+	 *
+	 * @param int $limit
+	 * @param int $offset
+	 * @return string
+	 */
+	public function viewImages($limit, $offset=0) {
+		$images = $this->getImages($limit, $offset);
+		if (count($images) == 0) {
+			return '';
+		}
+
+		$count = $this->getSize();
+
+		return elgg_view_entity_list($images, $count, $offset, $limit, false, false, true);
+	}
+
+	/**
+	 * Get the GUID of the album cover
+	 * 
+	 * @return int
+	 */
+	public function getCoverImageGuid() {
+		if ($this->getSize() == 0) {
+			return 0;
+		}
+
+		$guid = $this->cover;
+		$imageList = $this->getImageList();
+		if (!in_array($guid, $imageList)) {
+			// select random photo to be cover
+			$index = array_rand($imageList, 1);
+			$guid = $imageList[$index];
+			$this->cover = $guid;
+		}
+		return $guid;
+	}
+
+	/**
+	 * Set the GUID for the album cover
+	 *
+	 * @param int $guid
+	 * @return bool
+	 */
+	public function setCoverImageGuid($guid) {
+		$imageList = $this->getImageList();
+		if (!in_array($guid, $imageList)) {
+			return false;
+		}
+		$this->cover = $guid;
+		return true;
+	}
+
+	/**
+	 * Get the number of photos in the album
+	 *
+	 * @return int
+	 */
+	public function getSize() {
+		return count($this->getImageList());
+	}
+
+	/**
+	 * Returns an order list of image guids
+	 * 
+	 * @return array
+	 */
+	public function getImageList() {
+		$listString = $this->orderedImages;
+		if (!$listString) {
+			return array();
+		}
+		$list = unserialize($listString);
+		return $list;
+	}
+
+	/**
+	 * Sets the album image order
+	 *
+	 * @param array $list An indexed array of image guids 
+	 */
+	public function setImageList($list) {
+		$listString = serialize($list);
+		$this->orderedImages = $listString;
+	}
+
+	/**
+	 * Add new images to the front of the image list
+	 *
+	 * @param array $list An indexed array of image guids
+	 */
+	public function prependImageList($list) {
+		$currentList = $this->getImageList();
+		$list = array_merge($list, $currentList);
+		$this->setImageList($list);
+	}
+
+	/**
+	 * Get the GUID of the image before the current one
+	 *
+	 * @param int $currentGuid
+	 * @return int
+	 */
+	public function getPreviousImageGuid($currentGuid) {
+		$imageList = $this->getImageList();
+		$key = array_search($currentGuid, $imageList);
+		if ($key === FALSE) {
+			return 0;
+		}
+		$key--;
+		if ($key < 0) {
+			return 0;
+		}
+		return $imageList[$key];
+	}
+
+	/**
+	 * Get the GUID of the image after the current one
+	 *
+	 * @param int $currentGuid
+	 * @return int
+	 */
+	public function getNextImageGuid($currentGuid) {
+		$imageList = $this->getImageList();
+		$key = array_search($currentGuid, $imageList);
+		if ($key === FALSE) {
+			return 0;
+		}
+		$key++;
+		if ($key >= count($imageList)) {
+			return 0;
+		}
+		return $imageList[$key];
+	}
+
+	/**
+	 * Remove an image from the album list
+	 *
+	 * @param int $imageGuid
+	 * @return bool
+	 */
+	public function removeImage($imageGuid)  {
+		$imageList = $this->getImageList();
+		$key = array_search($imageGuid, $imageList);
+		if ($key === FALSE) {
+			return FALSE;
+		}
+		
+		unset($imageList[$key]);
+		$this->setImageList($imageList);
+
+		return TRUE;
+	}
+
+	protected function deleteImages() {
+		// get all the images from this album as long as less than 999 images
+		$images = elgg_get_entities(array(
+			"type=" => "object",
+			"subtype" => "image",
+			"container_guid" => $this->guid,
+			"limit" => ELGG_ENTITIES_NO_VALUE,
+		));
+		if ($images) {
+			foreach ($images as $image) {
+				if ($image) {
+					$image->delete();
+				}
+			}
+		}
+	}
+
+	protected function deleteAlbumDir() {
+		$tmpfile = new ElggFile();
+		$tmpfile->setFilename('image/' . $this->guid . '/._tmp_del_tidypics_album_');
+		$tmpfile->subtype = 'image';
+		$tmpfile->owner_guid = $this->owner_guid;
+		$tmpfile->container_guid = $this->guid;
+		$tmpfile->open("write");
+		$tmpfile->write('');
+		$tmpfile->close();
+		$tmpfile->save();
+		$albumdir = eregi_replace('/._tmp_del_tidypics_album_', '', $tmpfile->getFilenameOnFilestore());
+		$tmpfile->delete();
+		if (is_dir($albumdir)) {
+			rmdir($albumdir);
+		}
+	}
+}
diff --git a/classes/TidypicsImage.php b/classes/TidypicsImage.php
new file mode 100644
index 000000000..531d54912
--- /dev/null
+++ b/classes/TidypicsImage.php
@@ -0,0 +1,292 @@
+<?php
+/**
+ * Tidypics Image class
+ *
+ * @package TidypicsImage
+ */
+
+
+class TidypicsImage extends ElggFile {
+	protected function initialise_attributes() {
+		parent::initialise_attributes();
+
+		$this->attributes['subtype'] = "image";
+	}
+
+	public function __construct($guid = null) {
+		parent::__construct($guid);
+	}
+
+	/**
+	 * delete image
+	 *
+	 * @return bool
+	 */
+	public function delete() {
+
+		// check if batch should be deleted
+		$batch = elgg_get_entities_from_relationship(array(
+			'relationship' => 'belongs_to_batch',
+			'relationship_guid' => $this->guid,
+			'inverse_relationship' => false,
+		));
+		if ($batch) {
+			$batch = $batch[0];
+			$count = elgg_get_entities_from_relationship(array(
+				'relationship' => 'belongs_to_batch',
+				'relationship_guid' => $batch->guid,
+				'inverse_relationship' => true,
+				'count' => true,
+			));
+			if ($count == 1) {
+				// last image so delete batch
+				$batch->delete();
+			}
+		}
+
+		$album = get_entity($this->container_guid);
+		if ($album) {
+			$album->removeImage($this->guid);
+		}
+
+		$this->removeThumbnails();
+
+		// update quota
+		$owner = $this->getOwnerEntity();
+		$owner->image_repo_size = (int)$owner->image_repo_size - $this->size();
+
+		return parent::delete();
+	}
+
+	/**
+	 * Set the internal filenames
+	 * 
+	 * @warning container needs to be set first
+	 */
+	public function setOriginalFilename($originalName) {
+		$prefix = "image/" . $this->container_guid . "/";
+		$filestorename = elgg_strtolower(time() . $originalName);
+		$this->setFilename($prefix . $filestorename);
+		$this->originalfilename = $originalName;
+	}
+
+	/**
+	 * Save the uploaded image
+	 *
+	 * @warning filename needs to be set first
+	 * 
+	 * @param string $uploadedFilename name of the uploaded file
+	 * @param int $size
+	 */
+	public function saveImageFile($uploadedFilename, $size) {
+
+		// we need to make sure the directory for the album exists
+		// @note for group albums, the photos are distributed among the users
+		$dir = tp_get_img_dir() . $this->getContainer();
+		if (!file_exists($dir)) {
+			mkdir($dir, 0755, true);
+		}
+
+		$filename = $this->getFilenameOnFilestore();
+
+		$result = move_uploaded_file($uploadedFilename, $filename);
+		if (!$result) {
+			return false;
+		}
+
+		$owner = $this->getOwnerEntity();
+		$owner->image_repo_size = (int)$owner->image_repo_size + $size;
+
+		return true;
+	}
+
+	/**
+	 * Save the image thumbnails
+	 *
+	 * @warning container guid and filename must be set
+	 * 
+	 * @param string $imageLib
+	 */
+	public function saveThumbnails($imageLib) {
+		include_once dirname(dirname(__FILE__)) . "/lib/resize.php";
+		
+		$prefix = "image/" . $this->container_guid . "/";
+		$filename = $this->getFilename();
+		$filename = substr($filename, strrpos($filename, '/') + 1);
+		
+		if ($imageLib == 'ImageMagick') {
+			// ImageMagick command line
+			if (tp_create_im_cmdline_thumbnails($this, $prefix, $filename) != true) {
+				trigger_error('Tidypics warning: failed to create thumbnails - ImageMagick command line', E_USER_WARNING);
+			}
+		} else if ($imageLib == 'ImageMagickPHP') {
+			// imagick php extension
+			if (tp_create_imagick_thumbnails($this, $prefix, $filename) != true) {
+				trigger_error('Tidypics warning: failed to create thumbnails - ImageMagick PHP', E_USER_WARNING);
+			}
+		} else {
+			if (tp_create_gd_thumbnails($this, $prefix, $filename) != true) {
+				trigger_error('Tidypics warning: failed to create thumbnails - GD', E_USER_WARNING);
+			}
+		}
+	}
+
+	/**
+	 * Extract EXIF Data from image
+	 *
+	 * @warning image file must be saved first
+	 */
+	public function extractExifData() {
+		include_once dirname(dirname(__FILE__)) . "/lib/exif.php";
+		td_get_exif($this);
+	}
+	
+	/**
+	 * Has the photo been tagged with "in this photo" tags
+	 *
+	 * @return true/false
+	 */
+	public function isPhotoTagged() {
+		$num_tags = count_annotations($this->getGUID(), 'object', 'image', 'phototag');
+		if ($num_tags > 0) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+	/**
+	 * Get an array of photo tag information
+	 *
+	 * @return array of json representations of the tags and the tag link text
+	 */
+	public function getPhotoTags() {
+		global $CONFIG;
+
+		// get tags as annotations
+		$photo_tags = get_annotations($this->getGUID(), 'object', 'image', 'phototag');
+		if (!$photo_tags) {
+			// no tags or user doesn't have permission to tags, so return
+			return false;
+		}
+
+		$photo_tags_json = "[";
+		foreach ($photo_tags as $p) {
+			$photo_tag = unserialize($p->value);
+
+			// create link to page with other photos tagged with same tag
+			$phototag_text = $photo_tag->value;
+			$phototag_link = $CONFIG->wwwroot . 'search/?tag=' . $phototag_text . '&amp;subtype=image&amp;object=object';
+			if ($photo_tag->type === 'user') {
+				$user = get_entity($photo_tag->value);
+				if ($user) {
+					$phototag_text = $user->name;
+				} else {
+					$phototag_text = "unknown user";
+				}
+
+				$phototag_link = $CONFIG->wwwroot . "pg/photos/tagged/" . $photo_tag->value;
+			}
+
+			if (isset($photo_tag->x1)) {
+				// hack to handle format of Pedro Prez's tags - ugh
+				$photo_tag->coords = "\"x1\":\"{$photo_tag->x1}\",\"y1\":\"{$photo_tag->y1}\",\"width\":\"{$photo_tag->width}\",\"height\":\"{$photo_tag->height}\"";
+				$photo_tags_json .= '{' . $photo_tag->coords . ',"text":"' . $phototag_text . '","id":"' . $p->id . '"},';
+			} else {
+				$photo_tags_json .= '{' . $photo_tag->coords . ',"text":"' . $phototag_text . '","id":"' . $p->id . '"},';
+			}
+
+			// prepare variable arrays for tagging view
+			$photo_tag_links[$p->id] = array('text' => $phototag_text, 'url' => $phototag_link);
+		}
+
+		$photo_tags_json = rtrim($photo_tags_json,',');
+		$photo_tags_json .= ']';
+
+		$ret_data = array('json' => $photo_tags_json, 'links' => $photo_tag_links);
+		return $ret_data;
+	}
+
+	/**
+	 * Get the view information for this image
+	 *
+	 * @param $viewer_guid the guid of the viewer (0 if not logged in)
+	 * @return array with number of views, number of unique viewers, and number of views for this viewer
+	 */
+	public function getViews($viewer_guid) {
+		$views = get_annotations($this->getGUID(), "object", "image", "tp_view", "", 0, 99999);
+		if ($views) {
+			$total_views = count($views);
+
+			if ($this->owner_guid == $viewer_guid) {
+				// get unique number of viewers
+				foreach ($views as $view) {
+					$diff_viewers[$view->owner_guid] = 1;
+				}
+				$unique_viewers = count($diff_viewers);
+			}
+			else if ($viewer_guid) {
+				// get the number of times this user has viewed the photo
+				$my_views = 0;
+				foreach ($views as $view) {
+					if ($view->owner_guid == $viewer_guid) {
+						$my_views++;
+					}
+				}
+			}
+
+			$view_info = array("total" => $total_views, "unique" => $unique_viewers, "mine" => $my_views);
+		}
+		else {
+			$view_info = array("total" => 0, "unique" => 0, "mine" => 0);
+		}
+
+		return $view_info;
+	}
+
+	/**
+	 * Add a tidypics view annotation to this image
+	 *
+	 * @param $viewer_guid
+	 * @return none
+	 */
+	public function addView($viewer_guid) {
+		if ($viewer_guid != $this->owner_guid && tp_is_person()) {
+			create_annotation($this->getGUID(), "tp_view", "1", "integer", $viewer_guid, ACCESS_PUBLIC);
+		}
+	}
+
+	/**
+	 * Remove thumbnails - usually in preparation for deletion
+	 *
+	 * The thumbnails are not actually ElggObjects so we create
+	 * temporary objects to delete them.
+	 */
+	protected function removeThumbnails() {
+		$thumbnail = $this->thumbnail;
+		$smallthumb = $this->smallthumb;
+		$largethumb = $this->largethumb;
+
+		//delete standard thumbnail image
+		if ($thumbnail) {
+			$delfile = new ElggFile();
+			$delfile->owner_guid = $this->getOwner();
+			$delfile->setFilename($thumbnail);
+			$delfile->delete();
+		}
+		//delete small thumbnail image
+		if ($smallthumb) {
+			$delfile = new ElggFile();
+			$delfile->owner_guid = $this->getOwner();
+			$delfile->setFilename($smallthumb);
+			$delfile->delete();
+		}
+		//delete large thumbnail image
+		if ($largethumb) {
+			$delfile = new ElggFile();
+			$delfile->owner_guid = $this->getOwner();
+			$delfile->setFilename($largethumb);
+			$delfile->delete();
+		}
+	}
+}