From: sakamocchi <o-takashi@sakamocchi.jp>
Date: Sat, 19 May 2012 11:46:56 +0000 (+0900)
Subject: MERGE: リビジョン1864。Mediaクラス、MediaObjectクラスのコード整理。
X-Git-Url: http://git.osdn.net/view?p=nucleus-jp%2Fnucleus-next.git;a=commitdiff_plain;h=cdf76f53cd9afbf9386ad1f6943cab8e3d01072d

MERGE: リビジョン1864。Mediaクラス、MediaObjectクラスのコード整理。

Revision 1864:
code cleanup for Media class and MediaObject class
http://nucleuscms.svn.sourceforge.net/viewvc/nucleuscms?view=revision&revision=1864
---

diff --git a/nucleus/libs/MEDIA.php b/nucleus/libs/MEDIA.php
index 4fffced..0195d2d 100644
--- a/nucleus/libs/MEDIA.php
+++ b/nucleus/libs/MEDIA.php
@@ -14,24 +14,22 @@
  *
  * @license http://nucleuscms.org/license.txt GNU General Public License
  * @copyright Copyright (C) 2002-2012 The Nucleus Group
- * @version $Id: MEDIA.php 1525 2011-06-21 10:20:19Z sakamocchi $
+ * @version $Id: MEDIA.php 1864 2012-05-19 11:39:44Z sakamocchi $
  */
 
-define('PRIVATE_COLLECTION', 'Private Collection');
-define('READ_ONLY_MEDIA_FOLDER', '(Read Only)');
+define('PRIVATE_COLLECTION', 		'Private Collection');
+define('READ_ONLY_MEDIA_FOLDER',	'(Read Only)');
 
-/**
-  * Represents the media objects for a certain member
-  */
 class Media
 {
 	/**
+	 * Media::getCollectionList()
 	 * Gets the list of collections available to the currently logged
 	 * in member
 	 *
 	 * @returns array of dirname => display name
 	 */
-	public function getCollectionList($exceptReadOnly = false)
+	static public function getCollectionList($exceptReadOnly = FALSE)
 	{
 		global $member, $DIR_MEDIA;
 		
@@ -39,237 +37,321 @@ class Media
 		
 		// add private directory for member
 		$collections[$member->getID()] = PRIVATE_COLLECTION;
-
+		
 		// add global collections
-		if (!is_dir($DIR_MEDIA)) return $collections;
-
+		if ( !is_dir($DIR_MEDIA) )
+		{
+			return $collections;
+		}
+		
 		$dirhandle = opendir($DIR_MEDIA);
-		while ($dirname = readdir($dirhandle)) {
+		while ( $dirname = readdir($dirhandle) )
+		{
 			// only add non-numeric (numeric=private) dirs
-			if (@is_dir($DIR_MEDIA . $dirname) &&
+			if ( @is_dir($DIR_MEDIA . $dirname) &&
 				($dirname != '.') &&
 				($dirname != '..') &&
 				($dirname != 'CVS') &&
-				(!is_numeric($dirname)))  {
-				if (@is_writable($DIR_MEDIA . $dirname))
+				(!is_numeric($dirname)) )
+				{
+				if ( @is_writable($DIR_MEDIA . $dirname) )
+				{
 					$collections[$dirname] = $dirname;
-				else if ($exceptReadOnly == false)
+				}
+				else if ( $exceptReadOnly == FALSE )
+				{
 					$collections[$dirname] = $dirname . ' ' . READ_ONLY_MEDIA_FOLDER;
+				}
 			}
 		}
 		closedir($dirhandle);
-
+		
 		return $collections;
-
 	}
-
+	
 	/**
-	  * Returns an array of MediaObject objects for a certain collection
-	  *
-	  * @param $collection
-	  *		name of the collection
-	  * @param $filter
-	  *		filter on filename (defaults to none)
-	  */
-	function getMediaListByCollection($collection, $filter = '') {
-		global $DIR_MEDIA;
-
+	 * Media::getMediaListByCollection()
+	 * Returns an array of MediaObject objects for a certain collection
+	 *
+	 * @param	string	$collection	name of the collection
+	 * @param	string	$filter		filter on filename (defaults to none)
+	 * @return	void
+	 */
+	static public function getMediaListByCollection($collection, $filter = '')
+	{
+		global $CONF, $DIR_MEDIA;
+		
 		$filelist = array();
-
+		
 		// 1. go through all objects and add them to the filelist
-
 		$mediadir = $DIR_MEDIA . $collection . '/';
-
+		
 		// return if dir does not exist
-		if (!is_dir($mediadir)) return $filelist;
-
+		if ( !is_dir($mediadir) )
+		{
+			return $filelist;
+		}
+		
 		$dirhandle = opendir($mediadir);
-		while ($filename = readdir($dirhandle)) {
+		while ( $filename = readdir($dirhandle) )
+		{
 			// only add files that match the filter
-			if (!@is_dir($filename) && Media::checkFilter($filename, $filter))
+			if ( !@is_dir($filename) && self::checkFilter($filename, $filter) )
+			{
 				array_push($filelist, new MediaObject($collection, $filename, filemtime($mediadir . $filename)));
+			}
 		}
 		closedir($dirhandle);
-
+		
 		// sort array so newer files are shown first
-		usort($filelist, 'sort_media');
-
+		usort($filelist,  array(__CLASS__, 'sort_media'));
+		
 		return $filelist;
 	}
-
-	function checkFilter($strText, $strFilter) {
-		if ($strFilter == '')
+	
+	/**
+	 * Media::checkFilter()
+	 * 
+	 * @param	string	$strText
+	 * @param	string	$strFilter
+	 * @return	boolean
+	 */
+	static public function checkFilter($strText, $strFilter)
+	{
+		if ( $strFilter == '' )
+		{
 			return 1;
+		}
 		else
+		{
 			return is_integer(i18n::strpos(strtolower($strText), strtolower($strFilter)));
+		}
 	}
-
+	
 	/**
-	  * checks if a collection exists with the given name, and if it's
-	  * allowed for the currently logged in member to upload files to it
-	  */
-	function isValidCollection($collectionName, $exceptReadOnly = false) {
+	 * Media::isValidCollection()
+	 * checks if a collection exists with the given name, and if it's
+	 * allowed for the currently logged in member to upload files to it
+	 * 
+	 * @param	string	$collectionName
+	 * @param	string	$exceptReadOnly
+	 * @return	boolean
+	 */
+	static public function isValidCollection($collectionName, $exceptReadOnly = FALSE)
+	{
 		global $member, $DIR_MEDIA;
-
+		
 		// allow creating new private directory
-		if ($collectionName === (string)$member->getID())
-			return true;
-			
-		$collections = Media::getCollectionList($exceptReadOnly);
+		if ( $collectionName === (string)$member->getID() )
+		{
+			return TRUE;
+		}
+		
+		$collections = self::getCollectionList($exceptReadOnly);
 		$dirname = $collections[$collectionName];
-		if ($dirname == NULL || $dirname === PRIVATE_COLLECTION)
-			return false;  
-
+		
+		if ( $dirname == NULL || $dirname === PRIVATE_COLLECTION )
+		{
+			return FALSE;
+		}
+		
 		// other collections should exist and be writable
 		$collectionDir = $DIR_MEDIA . $collectionName;
-		if ($exceptReadOnly)
-			return (@is_dir($collectionDir) && @is_writable($collectionDir));
-
+		if ( $exceptReadOnly )
+		{
+			return ( @is_dir($collectionDir) && @is_writable($collectionDir) );
+		}
+		
 		// other collections should exist
 		return @is_dir($collectionDir);
-       }
-
+	}
+	
 	/**
-	  * Adds an uploaded file to the media archive
-	  *
-	  * @param collection
-	  *		collection
-	  * @param uploadfile
-	  *		the postFileInfo(..) array
-	  * @param filename
-	  *		the filename that should be used to save the file as
-	  *		(date prefix should be already added here)
-	  */
-	function addMediaObject($collection, $uploadfile, $filename) {
+	 * Media::addMediaObject()
+	 * Adds an uploaded file to the media archive
+	 *
+	 * @param	string	$collection	collection
+	 * @param	array	$uploadfile	the postFileInfo(..) array
+	 * @param	string	$filename	the filename that should be used to save the file as
+	 * 								(date prefix should be already added here)
+	 * @return	string	blank if success, message if failed
+	 */
+	static public function addMediaObject($collection, $uploadfile, $filename)
+	{
 		global $DIR_MEDIA, $manager;
-
+		
 		// clean filename of characters that may cause trouble in a filename using cleanFileName() function from globalfunctions.php
 		$filename = cleanFileName($filename);
+		
 		// should already have tested for allowable types before calling this method. This will only catch files with no extension at all
-		if ($filename === false) 
+		if ( $filename === FALSE )
+		{
 			return _ERROR_BADFILETYPE;
+		}
 		
 		// trigger PreMediaUpload event
 		$manager->notify('PreMediaUpload',array('collection' => &$collection, 'uploadfile' => $uploadfile, 'filename' => &$filename));
-
+		
 		// don't allow uploads to unknown or forbidden collections
-		$exceptReadOnly = true;
-		if (!Media::isValidCollection($collection,$exceptReadOnly))
+		$exceptReadOnly = TRUE;
+		if ( !self::isValidCollection($collection,$exceptReadOnly) )
+		{
 			return _ERROR_DISALLOWED;
-
+		}
+		
 		// check dir permissions (try to create dir if it does not exist)
 		$mediadir = $DIR_MEDIA . $collection;
-
+		
 		// try to create new private media directories if needed
-		if (!@is_dir($mediadir) && is_numeric($collection)) {
+		if ( !@is_dir($mediadir) && is_numeric($collection) )
+		{
 			$oldumask = umask(0000);
-			if (!@mkdir($mediadir, 0777))
+			if ( !@mkdir($mediadir, 0777) )
+			{
 				return _ERROR_BADPERMISSIONS;
+			}
 			umask($oldumask);
 		}
-
+		
 		// if dir still not exists, the action is disallowed
-		if (!@is_dir($mediadir))
+		if ( !@is_dir($mediadir) )
+		{
 			return _ERROR_DISALLOWED;
-
-		if (!is_writeable($mediadir))
+		}
+		
+		if ( !is_writeable($mediadir) )
+		{
 			return _ERROR_BADPERMISSIONS;
-
+		}
+		
 		// add trailing slash (don't add it earlier since it causes mkdir to fail on some systems)
 		$mediadir .= '/';
-
-		if (file_exists($mediadir . $filename))
+		
+		if ( file_exists($mediadir . $filename) )
+		{
 			return _ERROR_UPLOADDUPLICATE;
-
+		}
+		
 		// move file to directory
-		if (is_uploaded_file($uploadfile)) {
-			if (!@move_uploaded_file($uploadfile, $mediadir . $filename))
+		if ( is_uploaded_file($uploadfile) )
+		{
+			if ( !@move_uploaded_file($uploadfile, $mediadir . $filename) )
+			{
 				return _ERROR_UPLOADMOVEP;
-		} else {
-			if (!copy($uploadfile, $mediadir . $filename))
+			}
+		}
+		else
+		{
+			if ( !copy($uploadfile, $mediadir . $filename) )
+			{
 				return _ERROR_UPLOADCOPY ;
+			}
 		}
-
+		
 		// chmod uploaded file
 		$oldumask = umask(0000);
 		@chmod($mediadir . $filename, 0644);
 		umask($oldumask);
-
+		
 		$manager->notify('PostMediaUpload',array('collection' => $collection, 'mediadir' => $mediadir, 'filename' => $filename));
-
+		
 		return '';
-
 	}
-
+	
 	/**
+	 * Media::addMediaObjectRaw()
 	 * Adds an uploaded file to the media dir.
-	 *
-	 * @param $collection
-	 *		collection to use
-	 * @param $filename
-	 *		the filename that should be used to save the file as
-	 *		(date prefix should be already added here)
-	 * @param &$data
-	 *		File data (binary)
-	 *
+	 * 
 	 * NOTE: does not check if $collection is valid.
+	 * 
+	 * @param	string	$collection	collection to use
+	 * @param	string	$filename	the filename that should be used to save the file
+	 * 								as (date prefix should be already added here)
+	 * @param	&$data	File data (binary)
+	 * @return	string	blank if success, message if failed
 	 */
-	function addMediaObjectRaw($collection, $filename, &$data) {
+	static public function addMediaObjectRaw($collection, $filename, &$data)
+	{
 		global $DIR_MEDIA;
-
+		
 		// check dir permissions (try to create dir if it does not exist)
 		$mediadir = $DIR_MEDIA . $collection;
-
+		
 		// try to create new private media directories if needed
-		if (!@is_dir($mediadir) && is_numeric($collection)) {
+		if ( !@is_dir($mediadir) && is_numeric($collection) )
+		{
 			$oldumask = umask(0000);
-			if (!@mkdir($mediadir, 0777))
+			if ( !@mkdir($mediadir, 0777) )
+			{
 				return _ERROR_BADPERMISSIONS;
+			}
 			umask($oldumask);
 		}
-
+		
 		// if dir still not exists, the action is disallowed
-		if (!@is_dir($mediadir))
+		if ( !@is_dir($mediadir) )
+		{
 			return _ERROR_DISALLOWED;
-
-		if (!is_writeable($mediadir))
+		}
+		
+		if ( !is_writeable($mediadir) )
+		{
 			return _ERROR_BADPERMISSIONS;
-
+		}
+		
 		// add trailing slash (don't add it earlier since it causes mkdir to fail on some systems)
 		$mediadir .= '/';
-
-		if (file_exists($mediadir . $filename))
+		
+		if ( file_exists($mediadir . $filename) )
+		{
 			return _ERROR_UPLOADDUPLICATE;
-
+		}
+		
 		// create file
 		$fh = @fopen($mediadir . $filename, 'wb');
-		if (!$fh)
+		if ( !$fh )
+		{
 			return _ERROR_UPLOADFAILED;
+		}
 		$ok = @fwrite($fh, $data);
 		@fclose($fh);
-		if (!$ok)
+		if ( !$ok )
+		{
 			return _ERROR_UPLOADFAILED;
-
+		}
+		
 		// chmod uploaded file
 		$oldumask = umask(0000);
 		@chmod($mediadir . $filename, 0644);
 		umask($oldumask);
-
+		
 		return '';
-
 	}
-
+	
+	/**
+	 * Media::sort_media()
+	 * User-defined sort method to sort an array of MediaObjects
+	 * 
+	 * @param	object	$a
+	 * @param	object	$b
+	 * @return	boolean
+	 */
+	static private function sort_media($a, $b)
+	{
+		if ($a->timestamp == $b->timestamp) return 0;
+		return ($a->timestamp > $b->timestamp) ? -1 : 1;
+	}
 }
 
 /**
-  * Represents the characteristics of one single media-object
-  *
-  * Description of properties:
-  *  - filename: filename, without paths
-  *  - timestamp: last modification (unix timestamp)
-  *  - collection: collection to which the file belongs (can also be a owner ID, for private collections)
-  *  - private: true if the media belongs to a private member collection
-  */
+ * Represents the characteristics of one single media-object
+ *
+ * Description of properties:
+ *  - filename: filename, without paths
+ *  - timestamp: last modification (unix timestamp)
+ *  - collection: collection to which the file belongs (can also be a owner ID, for private collections)
+ *  - private: true if the media belongs to a private member collection
+ */
 class MediaObject
 {
 	public $private;
@@ -286,11 +368,3 @@ class MediaObject
 		return;
 	}
 }
-
-/**
-  * User-defined sort method to sort an array of MediaObjects
-  */
-function sort_media($a, $b) {
-	if ($a->timestamp == $b->timestamp) return 0;
-	return ($a->timestamp > $b->timestamp) ? -1 : 1;
-}