File Source for ImageManager.php

<?php
/**
* ImageManager, list images, directories, and thumbnails.
* @author $Author: Wei Zhuo $
* @version $Id: ImageManager.php 27 2004-04-01 08:31:57Z Wei Zhuo $
* @package ImageManager
*/
require_once('Files.php');
/**
* ImageManager Class.
* @author $Author: Wei Zhuo $
* @version $Id: ImageManager.php 27 2004-04-01 08:31:57Z Wei Zhuo $
*/
class ImageManager
{
/**
* Configuration array.
*/
var $config;
/**
* Array of directory information.
*/
var $dirs;
/**
* Constructor. Create a new Image Manager instance.
* @param array $config configuration array, see config.inc.php
*/
function ImageManager($config)
{
$this->config = $config;
}
/**
* Get the base directory.
* @return string base dir, see config.inc.php
*/
function getBaseDir()
{
Return $this->config['base_dir'];
}
/**
* Get the base URL.
* @return string base url, see config.inc.php
*/
function getBaseURL()
{
Return $this->config['base_url'];
}
function isValidBase()
{
return is_dir($this->getBaseDir());
}
/**
* Get the tmp file prefix.
* @return string tmp file prefix.
*/
function getTmpPrefix()
{
Return $this->config['tmp_prefix'];
}
/**
* Get the sub directories in the base dir.
* Each array element contain
* the relative path (relative to the base dir) as key and the
* full path as value.
* @return array of sub directries
* <code>array('path name' => 'full directory path', ...)</code>
*/
function getDirs()
{
if(is_null($this->dirs))
{
$dirs = $this->_dirs($this->getBaseDir(),'/');
ksort($dirs);
$this->dirs = $dirs;
}
return $this->dirs;
}
/**
* Recursively travese the directories to get a list
* of accessable directories.
* @param string $base the full path to the current directory
* @param string $path the relative path name
* @return array of accessiable sub-directories
* <code>array('path name' => 'full directory path', ...)</code>
*/
function _dirs($base, $path)
{
$base = Files::fixPath($base);
$dirs = array();
if($this->isValidBase() == false)
return $dirs;
$d = @dir($base);
while (false !== ($entry = $d->read()))
{
//If it is a directory, and it doesn't start with
// a dot, and if is it not the thumbnail directory
if(is_dir($base.$entry)
&& substr($entry,0,1) != '.'
&& $this->isThumbDir($entry) == false)
{
$relative = Files::fixPath($path.$entry);
$fullpath = Files::fixPath($base.$entry);
$dirs[$relative] = $fullpath;
$dirs = array_merge($dirs, $this->_dirs($fullpath, $relative));
}
}
$d->close();
Return $dirs;
}
/**
* Get all the files and directories of a relative path.
* @param string $path relative path to be base path.
* @return array of file and path information.
* <code>array(0=>array('relative'=>'fullpath',...), 1=>array('filename'=>fileinfo array(),...)</code>
* fileinfo array: <code>array('url'=>'full url',
* 'relative'=>'relative to base',
* 'fullpath'=>'full file path',
* 'image'=>imageInfo array() false if not image,
* 'stat' => filestat)</code>
*/
function getFiles($path)
{
$files = array();
$dirs = array();
if($this->isValidBase() == false)
return array($files,$dirs);
$path = Files::fixPath($path);
$base = Files::fixPath($this->getBaseDir());
$fullpath = Files::makePath($base,$path);
$d = @dir($fullpath);
while (false !== ($entry = $d->read()))
{
//not a dot file or directory
if(substr($entry,0,1) != '.')
{
if(is_dir($fullpath.$entry)
&& $this->isThumbDir($entry) == false)
{
$relative = Files::fixPath($path.$entry);
$full = Files::fixPath($fullpath.$entry);
$count = $this->countFiles($full);
$dirs[$relative] = array('fullpath'=>$full,'entry'=>$entry,'count'=>$count);
}
else if(is_file($fullpath.$entry) && $this->isThumb($entry)==false && $this->isTmpFile($entry) == false)
{
$img = $this->getImageInfo($fullpath.$entry);
if(!(!is_array($img)&&$this->config['validate_images']))
{
$file['url'] = Files::makePath($this->config['base_url'],$path).$entry;
$file['relative'] = $path.$entry;
$file['fullpath'] = $fullpath.$entry;
$file['image'] = $img;
$file['stat'] = stat($fullpath.$entry);
$files[$entry] = $file;
}
}
}
}
$d->close();
ksort($dirs);
ksort($files);
Return array($dirs, $files);
}
/**
* Count the number of files and directories in a given folder
* minus the thumbnail folders and thumbnails.
*/
function countFiles($path)
{
$total = 0;
if(is_dir($path))
{
$d = @dir($path);
while (false !== ($entry = $d->read()))
{
//echo $entry."<br>";
if(substr($entry,0,1) != '.'
&& $this->isThumbDir($entry) == false
&& $this->isTmpFile($entry) == false
&& $this->isThumb($entry) == false)
{
$total++;
}
}
$d->close();
}
return $total;
}
/**
* Get image size information.
* @param string $file the image file
* @return array of getImageSize information,
* false if the file is not an image.
*/
function getImageInfo($file)
{
Return @getImageSize($file);
}
/**
* Check if the file contains the thumbnail prefix.
* @param string $file filename to be checked
* @return true if the file contains the thumbnail prefix, false otherwise.
*/
function isThumb($file)
{
$len = strlen($this->config['thumbnail_prefix']);
if(substr($file,0,$len)==$this->config['thumbnail_prefix'])
Return true;
else
Return false;
}
/**
* Check if the given directory is a thumbnail directory.
* @param string $entry directory name
* @return true if it is a thumbnail directory, false otherwise
*/
function isThumbDir($entry)
{
if($this->config['thumbnail_dir'] == false
|| strlen(trim($this->config['thumbnail_dir'])) == 0)
Return false;
else
Return ($entry == $this->config['thumbnail_dir']);
}
/**
* Check if the given file is a tmp file.
* @param string $file file name
* @return boolean true if it is a tmp file, false otherwise
*/
function isTmpFile($file)
{
$len = strlen($this->config['tmp_prefix']);
if(substr($file,0,$len)==$this->config['tmp_prefix'])
Return true;
else
Return false;
}
/**
* For a given image file, get the respective thumbnail filename
* no file existence check is done.
* @param string $fullpathfile the full path to the image file
* @return string of the thumbnail file
*/
function getThumbName($fullpathfile)
{
$path_parts = pathinfo($fullpathfile);
$thumbnail = $this->config['thumbnail_prefix'].$path_parts['basename'];
if($this->config['safe_mode'] == true
|| strlen(trim($this->config['thumbnail_dir'])) == 0)
{
Return Files::makeFile($path_parts['dirname'],$thumbnail);
}
else
{
if(strlen(trim($this->config['thumbnail_dir'])) > 0)
{
$path = Files::makePath($path_parts['dirname'],$this->config['thumbnail_dir']);
if(!is_dir($path))
Files::createFolder($path);
Return Files::makeFile($path,$thumbnail);
}
else //should this ever happen?
{
//error_log('ImageManager: Error in creating thumbnail name');
}
}
}
/**
* Similar to getThumbName, but returns the URL, base on the
* given base_url in config.inc.php
* @param string $relative the relative image file name,
* relative to the base_dir path
* @return string the url of the thumbnail
*/
function getThumbURL($relative)
{
$path_parts = pathinfo($relative);
$thumbnail = $this->config['thumbnail_prefix'].$path_parts['basename'];
if($path_parts['dirname']=='\\') $path_parts['dirname']='/';
if($this->config['safe_mode'] == true
|| strlen(trim($this->config['thumbnail_dir'])) == 0)
{
Return Files::makeFile($this->getBaseURL(),$thumbnail);
}
else
{
if(strlen(trim($this->config['thumbnail_dir'])) > 0)
{
$path = Files::makePath($path_parts['dirname'],$this->config['thumbnail_dir']);
$url_path = Files::makePath($this->getBaseURL(), $path);
Return Files::makeFile($url_path,$thumbnail);
}
else //should this ever happen?
{
//error_log('ImageManager: Error in creating thumbnail url');
}
}
}
/**
* Check if the given path is part of the subdirectories
* under the base_dir.
* @param string $path the relative path to be checked
* @return boolean true if the path exists, false otherwise
*/
function validRelativePath($path)
{
$dirs = $this->getDirs();
if($path == '/')
Return true;
//check the path given in the url against the
//list of paths in the system.
for($i = 0; $i < count($dirs); $i++)
{
$key = key($dirs);
//we found the path
if($key == $path)
Return true;
next($dirs);
}
Return false;
}
/**
* Process uploaded files, assumes the file is in
* $_FILES['upload'] and $_POST['dir'] is set.
* The dir must be relative to the base_dir and exists.
* If 'validate_images' is set to true, only file with
* image dimensions will be accepted.
* @return null
*/
function processUploads()
{
if($this->isValidBase() == false)
return;
$relative = null;
if(isset($_POST['dir']))
$relative = rawurldecode($_POST['dir']);
else
return;
//check for the file, and must have valid relative path
if(isset($_FILES['upload']) && $this->validRelativePath($relative))
{
$upload_result=$this->_processFiles($relative, $_FILES['upload']);
return $upload_result;
}
}
/**
* Insert the uploaded picture in the database.
* @param string $relative The path in the document images folder
* @param array $file the uploaded file from $_FILES
* @param String $file_name the correct file name (generated by the function Files::copyFile).
*/
function _insertPictureInDatabase($relative, $file, $file_name){
$image_name=utf8_decode($file_name);
$image_name= strtr($image_name,"��","aaaaaaaaaaaaooooooooooooeeeeeeeecciiiiiiiiuuuuuuuuynn");
$image_name=Files::escape($image_name);
$image_size=$file["size"];
$path = "/images/".substr($relative,1);
include(api_get_path(LIBRARY_PATH)."fileUpload.lib.php");
$doc_id = add_document($_course, $path.$image_name, 'file', $image_size, $image_name);
api_item_property_update($_course, TOOL_DOCUMENT, $doc_id, 'DocumentCreated', $_user['user_id']);
}
function _deletePictureInDatabase($relative){
$path = "/images/".substr($relative,1);
$dbDocumentTable = Database::get_course_table(TABLE_DOCUMENT);
$dbItemPropertyTable = Database::get_course_table(TABLE_ITEM_PROPERTY);
//Select the id of the picture to delete
$sql="SELECT id FROM ".$dbDocumentTable." WHERE path='".$path."'";
$result=api_sql_query($sql);
$image_id=mysql_result($result,0,0);
//Delete the picture in the documents table
$sql="DELETE FROM ".$dbDocumentTable." WHERE id='".$image_id."'";
$result=api_sql_query($sql);
//Delete the picture in the item_property table
$sql="DELETE FROM ".$dbItemPropertyTable." WHERE ref='".$image_id."'";
$result=api_sql_query($sql);
}
/**
* Process upload files. The file must be an
* uploaded file. If 'validate_images' is set to
* true, only images will be processed. Any duplicate
* file will be renamed. See Files::copyFile for details
* on renaming.
* @param string $relative the relative path where the file
* should be copied to.
* @param array $file the uploaded file from $_FILES
* @return boolean true if the file was processed successfully,
* false otherwise
*/
function _processFiles($relative, $file)
{
if($file['error']!=0)
{
Return false;
}
if(!is_file($file['tmp_name']))
{
Return false;
}
if(!is_uploaded_file($file['tmp_name']))
{
Files::delFile($file['tmp_name']);
Return false;
}
if($this->config['validate_images'] == true)
{
$imgInfo = @getImageSize($file['tmp_name']);
if(!is_array($imgInfo))
{
Files::delFile($file['tmp_name']);
Return false;
}
}
//now copy the file
$path = Files::makePath($this->getBaseDir(),$relative);
$result = Files::copyFile($file['tmp_name'], $path, $file['name']);
//no copy error
if(!is_int($result))
{
Files::delFile($file['tmp_name']);
global $_course;
//Check if we are in a course context. Otherwise it should mean that we're
//uploading a file in the generic image upload folder, not into a course, so
//we don't need to record it into the database.
//In any case, if $_course['dbName'] is not defined, the database insertion
//will fail, so we don't loose anything compared to what we have now.
if(!empty($_course['dbName']))
{
$this->_insertPictureInDatabase($relative, $_FILES['upload'],$result);
}
Return $result;
}
//delete tmp files.
Files::delFile($file['tmp_name']);
Return false;
}
/**
* Get the URL of the relative file.
* basically appends the relative file to the
* base_url given in config.inc.php
* @param string $relative a file the relative to the base_dir
* @return string the URL of the relative file.
*/
function getFileURL($relative)
{
Return Files::makeFile($this->getBaseURL(),$relative);
}
/**
* Get the fullpath to a relative file.
* @param string $relative the relative file.
* @return string the full path, .ie. the base_dir + relative.
*/
function getFullPath($relative)
{
Return Files::makeFile($this->getBaseDir(),$relative);;
}
/**
* Get the default thumbnail.
* @return string default thumbnail, empty string if
* the thumbnail doesn't exist.
*/
function getDefaultThumb()
{
if(is_file($this->config['default_thumbnail']))
Return $this->config['default_thumbnail'];
else
Return '';
}
/**
* Get the thumbnail url to be displayed.
* If the thumbnail exists, and it is up-to-date
* the thumbnail url will be returns. If the
* file is not an image, a default image will be returned.
* If it is an image file, and no thumbnail exists or
* the thumbnail is out-of-date (i.e. the thumbnail
* modified time is less than the original file)
* then a thumbs.php?img=filename.jpg is returned.
* The thumbs.php url will generate a new thumbnail
* on the fly. If the image is less than the dimensions
* of the thumbnails, the image will be display instead.
* @param string $relative the relative image file.
* @return string the url of the thumbnail, be it
* actually thumbnail or a script to generate the
* thumbnail on the fly.
*/
function getThumbnail($relative)
{
$fullpath = Files::makeFile($this->getBaseDir(),$relative);
//not a file???
if(!is_file($fullpath))
Return $this->getDefaultThumb();
$imgInfo = @getImageSize($fullpath);
//not an image
if(!is_array($imgInfo))
Return $this->getDefaultThumb();
//the original image is smaller than thumbnails,
//so just return the url to the original image.
if ($imgInfo[0] <= $this->config['thumbnail_width']
&& $imgInfo[1] <= $this->config['thumbnail_height'])
Return $this->getFileURL($relative);
$thumbnail = $this->getThumbName($fullpath);
//check for thumbnails, if exists and
// it is up-to-date, return the thumbnail url
if(is_file($thumbnail))
{
if(filemtime($thumbnail) >= filemtime($fullpath))
Return $this->getThumbURL($relative);
}
//well, no thumbnail was found, so ask the thumbs.php
//to generate the thumbnail on the fly.
Return 'thumbs.php?img='.rawurlencode($relative).'&uploadPath='.$_GET['uploadPath'];
}
/**
* Delete and specified files.
* @return boolean true if delete, false otherwise
*/
function deleteFiles()
{
if(!empty($_GET['delf'])){
$this->_delFile(rawurldecode($_GET['delf']));
$this->_deletePictureInDatabase(rawurldecode($_GET['delf']));
}
}
/**
* Delete and specified directories.
* @return boolean true if delete, false otherwise
*/
function deleteDirs()
{
if(isset($_GET['deld']))
return $this->_delDir(rawurldecode($_GET['deld']));
else
Return false;
}
/**
* Delete the relative file, and any thumbnails.
* @param string $relative the relative file.
* @return boolean true if deleted, false otherwise.
*/
function _delFile($relative)
{
$fullpath = Files::makeFile($this->getBaseDir(),$relative);
//check that the file is an image
if($this->config['validate_images'] == true)
{
if(!is_array($this->getImageInfo($fullpath)))
return false; //hmmm not an Image!!???
}
$thumbnail = $this->getThumbName($fullpath);
if(Files::delFile($fullpath))
Return Files::delFile($thumbnail);
else
Return false;
}
/**
* Delete directories recursively.
* @param string $relative the relative path to be deleted.
* @return boolean true if deleted, false otherwise.
*/
function _delDir($relative)
{
$fullpath = Files::makePath($this->getBaseDir(),$relative);
if($this->countFiles($fullpath) <= 0)
return Files::delFolder($fullpath,true); //delete recursively.
else
Return false;
}
/**
* Create new directories.
* If in safe_mode, nothing happens.
* @return boolean true if created, false otherwise.
*/
function processNewDir()
{
if($this->config['safe_mode'] == true)
Return false;
if(isset($_GET['newDir']) && isset($_GET['dir']))
{
$newDir = rawurldecode($_GET['newDir']);
$dir = rawurldecode($_GET['dir']);
$path = Files::makePath($this->getBaseDir(),$dir);
$fullpath = Files::makePath($path, Files::escape($newDir));
if(is_dir($fullpath))
Return false;
Return Files::createFolder($fullpath);
}
}
/**
* Do some graphic library method checkings
* @param string $library the graphics library, GD, NetPBM, or IM.
* @param string $method the method to check.
* @return boolean true if able, false otherwise.
*/
function validGraphicMethods($library,$method)
{
switch ($library)
{
case 'GD':
return $this->_checkGDLibrary($method);
break;
case 'NetPBM':
return $this->_checkNetPBMLibrary($method);
break;
case 'IM':
return $this->_checkIMLibrary($method);
}
return false;
}
function _checkIMLibrary($method)
{
//ImageMagick goes throught 1 single executable
if(is_file(Files::fixPath(IMAGE_TRANSFORM_LIB_PATH).'convert'))
return true;
else
return false;
}
/**
* Check the GD library functionality.
* @param string $library the graphics library, GD, NetPBM, or IM.
* @return boolean true if able, false otherwise.
*/
function _checkGDLibrary($method)
{
$errors = array();
switch($method)
{
case 'create':
$errors['createjpeg'] = function_exists('imagecreatefromjpeg');
$errors['creategif'] = function_exists('imagecreatefromgif');
$errors['createpng'] = function_exists('imagecreatefrompng');
break;
case 'modify':
$errors['create'] = function_exists('ImageCreateTrueColor') || function_exists('ImageCreate');
$errors['copy'] = function_exists('ImageCopyResampled') || function_exists('ImageCopyResized');
break;
case 'save':
$errors['savejpeg'] = function_exists('imagejpeg');
$errors['savegif'] = function_exists('imagegif');
$errors['savepng'] = function_exists('imagepng');
break;
}
return $errors;
}
}
?>

Source for file ImageManager.php