@@ -2,8 +2,12 @@ /** * Plugin Configuration File * - * Include it in your app's core.php or bootstrap.php - * then customize configuration values if you need to. + * In order to make the plugin work you must include this file + * within either your app’s `core.php` or `bootstrap.php`. + * + * To overwrite defaults you'll define constants before including this file, + * and overwrite other settings selectively with `Configure::write()` + * calls after including it. * * Copyright (c) 2007-2009 David Persson * @@ -21,106 +25,111 @@ * @since media 0.50 */ /** - * An absolute (slash terminated) path to a directory holding media files + * Directory paths + * + * Each constant is defined with a value which is + * an absolute (slash terminated) path to a directory holding media files. * - * E.g.: /var/www/example.org/htdocs/app/webroot/media/ + * Example: + * `'/var/www/example.org/htdocs/app/webroot/media/'` */ - if (!defined('MEDIA')) { - define('MEDIA', WWW_ROOT . 'media' . DS); - } - if (!defined('MEDIA_STATIC')) { - define('MEDIA_STATIC', MEDIA . 'static' . DS); - } - if (!defined('MEDIA_FILTER')) { - define('MEDIA_FILTER', MEDIA . 'filter' . DS); - } - if (!defined('MEDIA_TRANSFER')) { - define('MEDIA_TRANSFER', MEDIA . 'transfer' . DS); - } -/* - * Either a (slash terminated) complete URL or an path fragment relative to your webroot +if (!defined('MEDIA')) { + define('MEDIA', WWW_ROOT . 'media' . DS); +} +if (!defined('MEDIA_STATIC')) { + define('MEDIA_STATIC', MEDIA . 'static' . DS); +} +if (!defined('MEDIA_FILTER')) { + define('MEDIA_FILTER', MEDIA . 'filter' . DS); +} +if (!defined('MEDIA_TRANSFER')) { + define('MEDIA_TRANSFER', MEDIA . 'transfer' . DS); +} +/** + * URL paths + * + * Each constant is defined with a value which is + * either a (slash terminated) complete URL or an path fragment relative to your webroot. * - * In case the corresponding directory isn't served define the constant with a value of `false` + * In case the corresponding directory isn't served use `false` as a value. * - * E.g.: http://www.example.org/app/media/ - * E.g.: media/ - * E.g.: false + * Examples: + * `'http://www.example.org/app/media/'` + * `'media/'` + * `false` */ - if (!defined('MEDIA_URL')) { - define('MEDIA_URL', 'media/'); - } - if (!defined('MEDIA_STATIC_URL')) { - define('MEDIA_STATIC_URL', MEDIA_URL . 'static/'); - } - if (!defined('MEDIA_FILTER_URL')) { - define('MEDIA_FILTER_URL', MEDIA_URL . 'filter/'); - } - if (!defined('MEDIA_TRANSFER_URL')) { - define('MEDIA_TRANSFER_URL', MEDIA_URL . 'transfer/'); - } +if (!defined('MEDIA_URL')) { + define('MEDIA_URL', 'media/'); +} +if (!defined('MEDIA_STATIC_URL')) { + define('MEDIA_STATIC_URL', MEDIA_URL . 'static/'); +} +if (!defined('MEDIA_FILTER_URL')) { + define('MEDIA_FILTER_URL', MEDIA_URL . 'filter/'); +} +if (!defined('MEDIA_TRANSFER_URL')) { + define('MEDIA_TRANSFER_URL', MEDIA_URL . 'transfer/'); +} /** * MIME type detection by file extension * - * engine - null for autodetection or core - * db - absolute path to a glob db file in freedesktop, apache, or php format - * (required for core) + * Options: + * engine - `null` for autodetection or `'core'` + * db - Absolute path to a glob db file in freedesktop, apache, or php format + * (required for core engine) */ - Configure::write('Mime.glob', array( - 'engine' => null, - 'db' => null, - )); +Configure::write('Mime.glob', array( + 'engine' => null, + 'db' => null, +)); /** * MIME type detection by file content * - * engine - null for autodetection or core, fileinfo, mime_magic - * db - absolute path to a glob db file in freedesktop, apache, or php format - * (optional for the fileinfo and mime_magic engine, required for core) + * Options: + * engine - `null` for autodetection or `'core'`, `'fileinfo'`, `'mime_magic'` + * db - Absolute path to a glob db file in freedesktop, apache, or php format + * (optional for the fileinfo and mime_magic engine, required for core engine) */ - Configure::write('Mime.magic', array( - 'engine' => null, - 'db' => null, - )); +Configure::write('Mime.magic', array( + 'engine' => null, + 'db' => null, +)); /** - * Media filters + * Filters and versions * - * A filter is a set of instructions. - * Each instruction represents a call to a method of the Medium class. + * For each medium type a set of filters keyed by version name is configured. + * A filter is a set of instructions which are processed by the Medium class. */ - Configure::write('Media.filter.audio', array( - 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), - 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), - ) - ); - Configure::write('Media.filter.css', array( - 'c' => array('compress'), - ) - ); - Configure::write('Media.filter.document', array( - 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), - 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), - 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), - ) - ); - Configure::write('Media.filter.generic', array()); - Configure::write('Media.filter.image', array( - 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), - 'xs' => array('convert' => 'image/png', 'zoomCrop' => array(32, 32)), - 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), - 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), - 'l' => array('convert' => 'image/png', 'fit' => array(450, 450)), - 'xl' => array('convert' => 'image/png', 'fit' => array(680, 440)), - ) - ); - Configure::write('Media.filter.icon', array()); - Configure::write('Media.filter.js', array( - 'c' => array('compress'), - ) - ); - Configure::write('Media.filter.text', array()); - Configure::write('Media.filter.video', array( - 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), - 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), - 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), - ) - ); +Configure::write('Media.filter.audio', array( + 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), + 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), +)); +Configure::write('Media.filter.css', array( + 'c' => array('compress'), +)); +Configure::write('Media.filter.document', array( + 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), + 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), + 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), +)); +Configure::write('Media.filter.generic', array()); +Configure::write('Media.filter.image', array( + 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), + 'xs' => array('convert' => 'image/png', 'zoomCrop' => array(32, 32)), + 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), + 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), + 'l' => array('convert' => 'image/png', 'fit' => array(450, 450)), + 'xl' => array('convert' => 'image/png', 'fit' => array(680, 440)), + ) +); +Configure::write('Media.filter.icon', array()); +Configure::write('Media.filter.js', array( + 'c' => array('compress'), +)); +Configure::write('Media.filter.text', array()); +Configure::write('Media.filter.video', array( + 'xxs' => array('convert' => 'image/png', 'zoomCrop' => array(16, 16)), + 's' => array('convert' => 'image/png', 'fitCrop' => array(100, 100)), + 'm' => array('convert' => 'image/png', 'fit' => array(300, 300)), +)); ?> config/core.php @@ -23,26 +23,41 @@ * @subpackage media.config.sql */ class MediaSchema extends CakeSchema { - +/** + * before + * + * @param array $event + * @access public + */ function before($event = array()) { return true; } - +/** + * after + * + * @param array $event + * @access public + */ function after($event = array()) { } - +/** + * attachments + * + * @var array + * @access public + */ var $attachments = array( - 'id' => array('type' => 'integer', 'null' => false, 'default' => NULL, 'key' => 'primary', 'extra' => 'auto_increment', 'length' => 10), - 'model' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), - 'foreign_key' => array('type' => 'integer', 'null' => false, 'default' => NULL, 'length' => 10), - 'dirname' => array('type' => 'string', 'null' => true, 'default' => NULL, 'length' => 255), - 'basename' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), - 'checksum' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), - 'group' => array('type' => 'string', 'null' => true, 'default' => NULL, 'length' => 255), - 'alternative' => array('type' => 'string', 'null' => true, 'default' => NULL,'length' => 50), - 'created' => array('type' => 'datetime', 'null' => true, 'default' => NULL), - 'modified' => array('type' => 'datetime', 'null' => true, 'default' => NULL), - 'indexes' => array('PRIMARY' => array('column' => 'id', 'unique' => 1)) - ); + 'id' => array('type' => 'integer', 'null' => false, 'default' => NULL, 'key' => 'primary', 'extra' => 'auto_increment', 'length' => 10), + 'model' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), + 'foreign_key' => array('type' => 'integer', 'null' => false, 'default' => NULL, 'length' => 10), + 'dirname' => array('type' => 'string', 'null' => true, 'default' => NULL, 'length' => 255), + 'basename' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), + 'checksum' => array('type' => 'string', 'null' => false, 'default' => NULL, 'length' => 255), + 'group' => array('type' => 'string', 'null' => true, 'default' => NULL, 'length' => 255), + 'alternative' => array('type' => 'string', 'null' => true, 'default' => NULL,'length' => 50), + 'created' => array('type' => 'datetime', 'null' => true, 'default' => NULL), + 'modified' => array('type' => 'datetime', 'null' => true, 'default' => NULL), + 'indexes' => array('PRIMARY' => array('column' => 'id', 'unique' => 1)) + ); } ?> \ No newline at end of file config/sql/media.php @@ -22,5 +22,6 @@ * @package media * @subpackage media.controllers */ -class MediaAppController extends AppController {} +class MediaAppController extends AppController { +} ?> \ No newline at end of file media_app_controller.php @@ -22,5 +22,6 @@ * @package media * @subpackage media.models */ -class MediaAppModel extends AppModel {} +class MediaAppModel extends AppModel { +} ?> \ No newline at end of file media_app_model.php @@ -29,36 +29,38 @@ class Attachment extends MediaAppModel { * Name of model * * @var string + * @access public */ var $name = 'Attachment'; /** * Name of table to use * * @var mixed + * @access public */ var $useTable = 'attachments'; /** * actsAs property * * @var array + * @access public */ var $actsAs = array( - 'Media.Polymorphic' => array( - 'classField' => 'model', - 'foreignKey' => 'foreign_key', - ), - 'Media.Transfer' => array( - 'trustClient' => false, - 'destinationFile' => ':Medium.short::DS::Source.basename:', - 'baseDirectory' => MEDIA_TRANSFER, - 'createDirectory' => true, - ), - 'Media.Media' => array( - 'metadataLevel' => 2, - 'makeVersions' => true, - 'filterDirectory' => MEDIA_FILTER, - ), - ); + 'Media.Polymorphic' => array( + 'classField' => 'model', + 'foreignKey' => 'foreign_key', + ), + 'Media.Transfer' => array( + 'trustClient' => false, + 'destinationFile' => ':Medium.short::DS::Source.basename:', + 'baseDirectory' => MEDIA_TRANSFER, + 'createDirectory' => true, + ), + 'Media.Media' => array( + 'metadataLevel' => 2, + 'makeVersions' => true, + 'filterDirectory' => MEDIA_FILTER, + )); /** * Validation rules for file and alternative fields * @@ -70,50 +72,49 @@ class Attachment extends MediaAppModel { * try commenting the mimeType rule or providing less strict * settings for single rules. * - * checkExtension and checkMimeType take both a blacklist and + * `checkExtension()` and `checkMimeType()` take both a blacklist and * a whitelist. If you are on windows make sure that you addtionally - * specify the 'tmp' extension in case you are using a whitelist. + * specify the `'tmp'` extension in case you are using a whitelist. * * @var array + * @access public */ var $validate = array( - 'file' => array( - 'resource' => array('rule' => 'checkResource'), - 'access' => array('rule' => 'checkAccess'), - 'location' => array('rule' => array('checkLocation', array(':MEDIA:', '/tmp/'))), - 'permission' => array('rule' => array('checkPermission', '*')), - 'size' => array('rule' => array('checkSize', '5M')), - 'pixels' => array('rule' => array('checkPixels', '1600x1600')), - 'extension' => array('rule' => array('checkExtension', - array( - 'bin', 'class', 'dll', 'dms', 'exe', 'lha', - 'lzh', 'so', 'as', 'asp', 'sh', 'java', 'js', - 'lisp', 'lua', 'pl', 'pm', 'php', 'py', 'pyc', - 'vb', 'bas', 'jar', - ), - '*' + 'file' => array( + 'resource' => array('rule' => 'checkResource'), + 'access' => array('rule' => 'checkAccess'), + 'location' => array('rule' => array('checkLocation', array(':MEDIA:', '/tmp/'))), + 'permission' => array('rule' => array('checkPermission', '*')), + 'size' => array('rule' => array('checkSize', '5M')), + 'pixels' => array('rule' => array('checkPixels', '1600x1600')), + 'extension' => array('rule' => array('checkExtension', + array( + 'bin', 'class', 'dll', 'dms', 'exe', 'lha', + 'lzh', 'so', 'as', 'asp', 'sh', 'java', 'js', + 'lisp', 'lua', 'pl', 'pm', 'php', 'py', 'pyc', + 'vb', 'bas', 'jar', ), + '*' ), - 'mimeType' => array('rule' => array('checkMimeType', false, '*')), - ), - 'alternative' => array( - 'rule' => 'checkRepresent', - 'on' => 'create', - 'required' => false, - 'allowEmpty' => true, - ), - ); - + ), + 'mimeType' => array('rule' => array('checkMimeType', false, '*')), + ), + 'alternative' => array( + 'rule' => 'checkRepresent', + 'on' => 'create', + 'required' => false, + 'allowEmpty' => true, + )); /** * beforeMake Callback * - * Called from within MediaBehavior::make + * Called from within `MediaBehavior::make()` * * $process an array with the following contents: * overwrite - If the destination file should be overwritten if it exists * directory - The destination directory (guranteed to exist) - * name - Medium name of $file (e.g. 'Image') - * version - The version requested to be processed (e.g. 'xl') + * name - Medium name of $file (e.g. `'Image'`) + * version - The version requested to be processed (e.g. `'xl'`) * instructions - An array containing which names of methods to be called * * @param string $file Absolute path to the source file models/attachment.php @@ -56,12 +56,12 @@ class MediaBehavior extends ModelBehavior { * @var array */ var $_defaultSettings = array( - 'metadataLevel' => 1, - 'baseDirectory' => MEDIA, - 'makeVersions' => true, - 'filterDirectory' => MEDIA_FILTER, - 'createDirectory' => true, - ); + 'metadataLevel' => 1, + 'baseDirectory' => MEDIA, + 'makeVersions' => true, + 'filterDirectory' => MEDIA_FILTER, + 'createDirectory' => true, + ); /** * Holds cached metadata keyed by model alias * @@ -72,11 +72,11 @@ class MediaBehavior extends ModelBehavior { /** * Setup * - * @param object $model + * @param Model $Model * @param array $config See defaultSettings for configuration options * @return void */ - function setup(&$model, $config = null) { + function setup(&$Model, $config = null) { if (!is_array($config)) { $config = array(); } @@ -92,308 +92,327 @@ class MediaBehavior extends ModelBehavior { } /* Interact with Transfer Behavior */ - if (isset($model->Behaviors->Transfer)) { - $transferSettings = $model->Behaviors->Transfer->settings[$model->alias]; + if (isset($Model->Behaviors->Transfer)) { + $transferSettings = $Model->Behaviors->Transfer->settings[$Model->alias]; $config['baseDirectory'] = dirname($transferSettings['baseDirectory']) . DS; $config['createDirectory'] = $transferSettings['createDirectory']; } - $this->settings[$model->alias] = $config + $this->_defaultSettings; - $this->__cached[$model->alias] = Cache::read('media_metadata_' . $model->alias, '_cake_core_'); + $this->settings[$Model->alias] = $config + $this->_defaultSettings; + $this->__cached[$Model->alias] = Cache::read('media_metadata_' . $Model->alias, '_cake_core_'); } /** * Callback * - * @param object $model + * Requires `file` field to be present if a record is created. + * + * Handles deletion of a record and corresponding file if the `delete` field is + * present and has not a value of either `null` or `'0'.` + * + * Prevents `dirname`, `basename`, `checksum` and `delete` fields to be written to + * database. + * + * Parses contents of the `file` field if present and generates a normalized path + * relative to the path set in the `baseDirectory` option. + * + * @param Model $Model * @return boolean */ - function beforeSave(&$model) { - if (!$model->exists()) { - /* Clear all data if we are going to create a record and the file field is missing */ - if (!isset($model->data[$model->alias]['file'])) { - unset($model->data[$model->alias]); + function beforeSave(&$Model) { + if (!$Model->exists()) { + if (!isset($Model->data[$Model->alias]['file'])) { + unset($Model->data[$Model->alias]); return true; } } else { - /* Handle deletion request */ - if (isset($model->data[$model->alias]['delete']) && $model->data[$model->alias]['delete'] !== '0') { - $model->delete(); - unset($model->data[$model->alias]); + if (isset($Model->data[$Model->alias]['delete']) + && $Model->data[$Model->alias]['delete'] !== '0') { + $Model->delete(); + unset($Model->data[$Model->alias]); return true; } } - /* Ensure that no bad fields sneaked into the to-be-saved data */ - $blacklist = array('dirname', 'basename', 'checksum', 'delete'); - $whitelist = array('id', 'file', 'model', 'foreign_key', 'created', 'modified', 'alternative'); + $blacklist = array( + 'dirname', 'basename', 'checksum', 'delete' + ); + $whitelist = array( + 'id', 'file', 'model', 'foreign_key', + 'created', 'modified', 'alternative' + ); - foreach ($model->data[$model->alias] as $key => $value) { + foreach ($Model->data[$Model->alias] as $key => $value) { if (in_array($key, $whitelist)) { - continue(1); + continue; } if (in_array($key, $blacklist)) { - unset($model->data[$model->alias][$key]); + unset($Model->data[$Model->alias][$key]); } } - extract($this->settings[$model->alias]); + extract($this->settings[$Model->alias]); - if (isset($model->data[$model->alias]['file'])) { - $File = new File($model->data[$model->alias]['file']); - unset($model->data[$model->alias]['file']); + if (isset($Model->data[$Model->alias]['file'])) { + $File = new File($Model->data[$Model->alias]['file']); + unset($Model->data[$Model->alias]['file']); - /* Convert directory separators to / and remove trailing slash */ - $dirname = substr( - str_replace(array($baseDirectory, DS), array(null, '/'), - Folder::slashTerm($File->Folder->pwd())), - 0, -1 - ); + /* `baseDirectory` may equal the file's directory or use backslashes */ + $dirname = substr(str_replace( + str_replace('\\', '/', $baseDirectory), + null, + str_replace('\\', '/', Folder::slashTerm($File->Folder->pwd())) + ), 0, -1); $result = array( - 'checksum' => $File->md5(), - 'dirname' => $dirname, - 'basename' => $File->name, - ); + 'checksum' => $File->md5(), + 'dirname' => $dirname, + 'basename' => $File->name, + ); - $model->data[$model->alias] = array_merge($model->data[$model->alias],$result); + $Model->data[$Model->alias] = array_merge($Model->data[$Model->alias], $result); } return true; } /** * Callback * - * @param object $model - * @param bool $created - * @return bool + * Triggers `make()` if both `dirname` and `basename` fields are present. + * Otherwise skips and returns `true` to continue the save operation. + * + * @param Model $Model + * @param boolean $created + * @return boolean */ - function afterSave(&$model, $created) { - extract($this->settings[$model->alias]); + function afterSave(&$Model, $created) { + extract($this->settings[$Model->alias]); if (!$created || !$makeVersions) { return true; } - if (!isset($model->data[$model->alias]['dirname']) || !isset($model->data[$model->alias]['basename'])) { - return true; /* Do not fail */ - } + $item =& $Model->data[$Model->alias]; - return $this->make($model, $model->data[$model->alias]['dirname'] . DS . $model->data[$model->alias]['basename']); + if (!isset($item['dirname'], $item['basename'])) { + return true; + } + return $this->make($Model, $item['dirname'] . DS . $item['basename']); } /** - * Adds metadata of each medium to results + * Callback * - * @param object $model + * Adds metadata of corresponding file to each result. + * + * If the corresponding file of a result is not readable it is removed + * from the results array, as it is inconsistent. This can be fixed + * by calling `cake media sync` from the command line. + * + * @param Model $Model * @param array $results - * @param bool $primary + * @param boolean $primary * @return array */ - function afterFind(&$model, $results, $primary = false) { + function afterFind(&$Model, $results, $primary = false) { if (empty($results)) { return $results; } - - extract($this->settings[$model->alias]); + extract($this->settings[$Model->alias]); foreach ($results as $key => &$result) { - if (!isset($result[$model->alias]['dirname']) || !isset($result[$model->alias]['basename'])) { - continue(1); /* Needed in certain situations like a pre-delete */ + /* Needed during a pre deletion phase */ + if (!isset($result[$Model->alias]['dirname'], $result[$Model->alias]['basename'])) { + continue; } + $file = $result[$Model->alias]['dirname'] . DS . $result[$Model->alias]['basename']; - /* Retrieve metadata */ - $metadata = $this->metadata( - $model, - $result[$model->alias]['dirname'] - . DS . $result[$model->alias]['basename'], - $metadataLevel - ); + $metadata = $this->metadata($Model, $file, $metadataLevel); + /* `metadata()` checks if the file is readable */ if ($metadata === false) { - /* file is not readable, which means this record is inconsitent */ unset($results[$key]); - continue(1); + continue; } - - $result[$model->alias] = array_merge($result[$model->alias], $metadata); + $result[$Model->alias] = array_merge($result[$Model->alias], $metadata); } - return $results; } /** - * Deletes file corresponding to record + * Callback + * + * Deletes file corresponding to record as well as generated versions of that file. * - * @param object $model - * @param bool $cascade - * @return bool + * If the file couldn't be deleted the callback won't stop the + * delete operation to continue to delete the record. + * + * @param Model $Model + * @param boolean $cascade + * @return boolean */ - function beforeDelete(&$model, $cascade = true) { - extract($this->settings[$model->alias]); - - $result = $model->find( - 'first', - array( - 'conditions' => array('id' => $model->id), - 'fields' => array('dirname', 'basename'), - 'recursive' => -1, - ) - ); + function beforeDelete(&$Model, $cascade = true) { + extract($this->settings[$Model->alias]); + + $query = array( + 'conditions' => array('id' => $Model->id), + 'fields' => array('dirname', 'basename'), + 'recursive' => -1, + ); + $result = $Model->find('first', $query); if (empty($result)) { return false; /* Record did not pass verification? */ } - $File = new File($baseDirectory - . $result[$model->alias]['dirname'] - . DS . $result[$model->alias]['basename']); + $file = $baseDirectory; + $file .= $result[$Model->alias]['dirname']; + $file .= DS . $result[$Model->alias]['basename']; + $File = new File($file); $Folder = new Folder($filterDirectory); + list($versions, ) = $Folder->ls(); foreach ($versions as $version) { - $Folder->cd( - $filterDirectory - . $version - . DS . $result[$model->alias]['dirname'] . DS - ); - + $Folder->cd($filterDirectory . $version . DS . $result[$Model->alias]['dirname'] . DS); $basenames = $Folder->find($File->name() . '\..*'); if (count($basenames) > 1) { - trigger_error('MediaBehavior::beforeDelete - Ambiguous filename ' . $File->name() . ' in ' . $Folder->pwd() . '.', E_USER_NOTICE); - continue(1); + $message = "MediaBehavior::beforeDelete - Ambiguous filename "; + $message .= "`" . $File->name() . "` in `" . $Folder->pwd() . "`."; + trigger_error($message, E_USER_NOTICE); + continue; } elseif (!isset($basenames[0])) { - continue(1); + continue; } $FilterFile = new File($Folder->pwd() . $basenames[0]); $FilterFile->delete(); } - $File->delete(); - return true; /* Always delete record */ + return true; } /** - * Parses instruction sets and invokes Medium::make for a file + * Parses instruction sets and invokes `Medium::make()` for a file * - * @param object $model - * @param string $file Path to a file relative to MEDIA or an absolute path to a file - * @return bool + * @param Model $Model + * @param string $file Path to a file relative to `baseDirectory` or an absolute path to a file + * @return boolean */ - function make(&$model, $file, $overwrite = false) { - extract($this->settings[$model->alias]); + function make(&$Model, $file, $overwrite = false) { + extract($this->settings[$Model->alias]); - $file = str_replace(array('/', '\\'), DS, is_file($file) ? $file : $baseDirectory . $file); - $File = new File($file); + list($file, $relativeFile) = $this->_file($Model, $file); + + $relativeDirectory = DS . rtrim(dirname($relativeFile), '.'); - $name = Medium::name($File->pwd()); + $name = Medium::name($file); $filter = Configure::read('Media.filter.' . strtolower($name)); - $hasCallback = method_exists($model, 'beforeMake'); + + $hasCallback = method_exists($Model, 'beforeMake'); foreach ($filter as $version => $instructions) { - $directory = rtrim($filterDirectory . $version . DS - . dirname(str_replace($baseDirectory, '', $file)), '.'); + $directory = Folder::slashTerm($filterDirectory . $version . $relativeDirectory); $Folder = new Folder($directory, $createDirectory); if (!$Folder->pwd()) { - trigger_error("MediaBehavior::make - Directory '{$directory}'" - . " could not be created or is not writable." - . " Please check your permissions.", - E_USER_WARNING); - continue(1); + $message = "MediaBehavior::make - Directory `{$directory}` "; + $message .= "could not be created or is not writable. "; + $message .= "Please check the permissions."; + trigger_error($message, E_USER_WARNING); + continue; } if ($hasCallback) { $process = compact('overwrite', 'directory', 'name', 'version', 'instructions'); - if ($model->beforeMake($file, $process)) { - continue(1); + if ($Model->beforeMake($file, $process)) { + continue; } } - if (!$Medium = Medium::make($File->pwd(), $instructions)) { - trigger_error("MediaBehavior::make - Failed to make version {$version} of medium.", - E_USER_WARNING); - continue(1); + if (!$Medium = Medium::make($file, $instructions)) { + $message = "MediaBehavior::make - Failed to make version `{$version}` "; + $message .= "of file `{$file}`. "; + trigger_error($message, E_USER_WARNING); + continue; } - $Medium->store($Folder->pwd() . DS . $File->name, $overwrite); + $Medium->store($directory . basename($file), $overwrite); } return true; } + /** * Retrieve (cached) metadata of a file * - * @param object $model - * @param string $file Path to a file relative to baseDirectory or an absolute path to a file - * @param int $level level of amount of info to add, 0 disable, 1 for basic, 2 for detailed info + * @param Model $Model + * @param string $file Path to a file relative to `baseDirectory` or an absolute path to a file + * @param integer $level level of amount of info to add, `0` disable, `1` for basic, `2` for detailed info * @return mixed Array with results or false if file is not readable */ - function metadata(&$model, $file, $level = 1) { + function metadata(&$Model, $file, $level = 1) { if ($level < 1) { return array(); } - extract($this->settings[$model->alias]); + extract($this->settings[$Model->alias]); - if (is_file($file)) { - $File = new File($file); - } else { - $File = new File($baseDirectory . $file); - } - if (!$File->exists() || !$File->readable()) { + list($file,) = $this->_file($Model, $file); + $File = new File($file); + + if (!$File->readable()) { return false; } $checksum = $File->md5(); - if (isset($this->__cached[$model->alias][$checksum])) { - $data = $this->__cached[$model->alias][$checksum]; + if (isset($this->__cached[$Model->alias][$checksum])) { + $data = $this->__cached[$Model->alias][$checksum]; } if ($level > 0 && !isset($data[1])) { $data[1] = array( - 'size' => $File->size(), - 'mime_type' => MimeType::guessType($File->pwd()), - 'checksum' => $checksum, - ); + 'size' => $File->size(), + 'mime_type' => MimeType::guessType($File->pwd()), + 'checksum' => $checksum, + ); } if ($level > 1 && !isset($data[2])) { $Medium = Medium::factory($File->pwd()); if ($Medium->name === 'Audio') { $data[2] = array( - 'artist' => $Medium->artist(), - 'album' => $Medium->album(), - 'title' => $Medium->title(), - 'track' => $Medium->track(), - 'year' => $Medium->year(), - 'length' => $Medium->duration(), - 'quality' => $Medium->quality(), - 'sampling_rate' => $Medium->samplingRate(), - 'bitrate' => $Medium->bitrate(), - ); + 'artist' => $Medium->artist(), + 'album' => $Medium->album(), + 'title' => $Medium->title(), + 'track' => $Medium->track(), + 'year' => $Medium->year(), + 'length' => $Medium->duration(), + 'quality' => $Medium->quality(), + 'sampling_rate' => $Medium->samplingRate(), + 'bitrate' => $Medium->bitrate(), + ); } elseif ($Medium->name === 'Image') { $data[2] = array( - 'width' => $Medium->width(), - 'height' => $Medium->height(), - 'ratio' => $Medium->ratio(), - 'quality' => $Medium->quality(), - 'megapixel' => $Medium->megapixel(), - ); + 'width' => $Medium->width(), + 'height' => $Medium->height(), + 'ratio' => $Medium->ratio(), + 'quality' => $Medium->quality(), + 'megapixel' => $Medium->megapixel(), + ); } elseif ($Medium->name === 'Text') { $data[2] = array( - 'characters' => $Medium->characters(), - 'syllables' => $Medium->syllables(), - 'sentences' => $Medium->sentences(), - 'words' => $Medium->words(), - 'flesch_score' => $Medium->fleschScore(), - 'lexical_density' => $Medium->lexicalDensity(), - ); + 'characters' => $Medium->characters(), + 'syllables' => $Medium->syllables(), + 'sentences' => $Medium->sentences(), + 'words' => $Medium->words(), + 'flesch_score' => $Medium->fleschScore(), + 'lexical_density' => $Medium->lexicalDensity(), + ); } elseif ($Medium->name === 'Video') { $data[2] = array( - 'title' => $Medium->title(), - 'year' => $Medium->year(), - 'length' => $Medium->duration(), - 'width' => $Medium->width(), - 'height' => $Medium->height(), - 'ratio' => $Medium->ratio(), - 'quality' => $Medium->quality(), - 'bitrate' => $Medium->bitrate(), - ); + 'title' => $Medium->title(), + 'year' => $Medium->year(), + 'length' => $Medium->duration(), + 'width' => $Medium->width(), + 'height' => $Medium->height(), + 'ratio' => $Medium->ratio(), + 'quality' => $Medium->quality(), + 'bitrate' => $Medium->bitrate(), + ); } else { $data[2] = array(); } @@ -402,26 +421,41 @@ class MediaBehavior extends ModelBehavior { for ($i = $level, $result = array(); $i > 0; $i--) { $result = array_merge($result, $data[$i]); } - $this->__cached[$model->alias][$checksum] = $data; + $this->__cached[$Model->alias][$checksum] = $data; return Set::filter($result); } /** * Checks if an alternative text is given only if a file is submitted * - * @param unknown_type $model + * @param unknown_type $Model * @param unknown_type $field * @return unknown */ - function checkRepresent(&$model, $field) { - if (!isset($model->data[$model->alias]['file'])) { + function checkRepresent(&$Model, $field) { + if (!isset($Model->data[$Model->alias]['file'])) { return true; } - $value = current($field); + $value = current($field); /* empty() limitation */ return !empty($value); - if (!empty($value)) { - return true; + } +/** + * Returns relative and absolute path to a file + * + * @param Model $Model + * @param string$file + * @return array + */ + function _file(&$Model, $file) { + extract($this->settings[$Model->alias]); + + if (!is_file($file)) { + $file = ltrim($file, DS); + $relativeFile = $file; + $file = $baseDirectory . $file; + } else { + $relativeFile = str_replace($baseDirectory, null, $file); } - return false; + return array($file, $relativeFile); } } ?> models/behaviors/media.php @@ -47,7 +47,7 @@ class TransferBehavior extends ModelBehavior { * * trustClient * false - - * true - Trust the mime type submitted together with an upload + * true - Trust the MIME type submitted together with an upload * * destinationFile * A path (withouth leading slash) relative to `baseDirectory`. @@ -78,34 +78,34 @@ class TransferBehavior extends ModelBehavior { * @var array */ var $_defaultSettings = array( - 'trustClient' => false, - 'destinationFile' => ':Medium.short::DS::Source.basename:', - 'baseDirectory' => MEDIA_TRANSFER, - 'createDirectory' => true, - ); + 'trustClient' => false, + 'destinationFile' => ':Medium.short::DS::Source.basename:', + 'baseDirectory' => MEDIA_TRANSFER, + 'createDirectory' => true, + ); /** * Default runtime * * @var array */ var $_defaultRuntime = array( - 'source' => null, - 'temporary' => null, - 'destination' => null, - 'isReady' => false, - 'hasPerformed' => false, - 'markers' => array(), - ); + 'source' => null, + 'temporary' => null, + 'destination' => null, + 'isReady' => false, + 'hasPerformed' => false, + 'markers' => array(), + ); /** * Setup * * Merges default settings with provided config and sets default validation options * - * @param object $model + * @param Model $Model * @param array $config @see _defaultSettings for configuration options * @return void */ - function setup(&$model, $config = null) { + function setup(&$Model, $config = null) { if (!is_array($config)) { $config = array(); } @@ -114,7 +114,7 @@ class TransferBehavior extends ModelBehavior { if (isset($config['destinationFile']) && preg_match('/:(MEDIA|APP|TMP|WEBROOT)+/', $config['destinationFile'])) { $message = "TransferBehavior::setup - "; - $message .= "The syntax of the `destinationFile` options has been changed. "; + $message .= "The syntax of the `destinationFile` option has been changed. "; $message .= "It should hold a relative path only. "; $message .= "See also the `baseDirectory' option."; trigger_error($message, E_USER_NOTICE); @@ -123,165 +123,150 @@ class TransferBehavior extends ModelBehavior { } /* If present validation rules get some sane default values */ - if (isset($model->validate['file'])) { + if (isset($Model->validate['file'])) { $default = array('allowEmpty' => true, 'required' => false, 'last' => true); - foreach ($model->validate['file'] as &$rule) { + foreach ($Model->validate['file'] as &$rule) { $rule = array_merge($default, $rule); } } - $this->settings[$model->alias] = $config + $this->_defaultSettings; - $this->runtime[$model->alias] = $this->_defaultRuntime; + $this->settings[$Model->alias] = $config + $this->_defaultSettings; + $this->runtime[$Model->alias] = $this->_defaultRuntime; } /** * Run before any or if validation occurs * - * @param object $model - * @return bool true + * Triggers `prepare()` setting source, temporary and destination to + * enable validation rules to check the transfer. If that fails + * invalidates the model. + * + * @param Model $Model + * @return boolean */ - function beforeValidate(&$model) { - /* - * Try to set source(,temporary) and destination - * enabling validation rules to check transfer - */ - if ($this->prepare($model) === false) { - $model->invalidate('file', 'error'); // preparation error + function beforeValidate(&$Model) { + if ($this->prepare($Model) === false) { + $Model->invalidate('file', 'error'); return false; } - - // ... - return true; } /** - * Triggers beforeEnter, performs transfer + * Triggers `prepare()` and performs transfer + * + * If transfer is unsuccessful save operation will abort. * - * @param object $model - * @return bool + * @param Model $Model + * @return boolean */ - function beforeSave(&$model) { - $preparation = $this->prepare($model); + function beforeSave(&$Model) { + $preparation = $this->prepare($Model); if ($preparation === false) { - /* Malformed-nonblank resource or other error: Implies not ready */ - /* Failing hard here can be circumvented by using provided validations */ return false; } if ($preparation === null) { - /* Blank resource or file field not present: Nothing to transfer */ - if (array_key_exists('file', $model->data[$model->alias])) { - unset($model->data[$model->alias]['file']); + if (array_key_exists('file', $Model->data[$Model->alias])) { + unset($Model->data[$Model->alias]['file']); } return true; } + extract($this->runtime[$Model->alias], EXTR_SKIP); + extract($this->settings[$Model->alias], EXTR_SKIP); - extract($this->runtime[$model->alias], EXTR_SKIP); - extract($this->settings[$model->alias], EXTR_SKIP); - - /* - * Transfer is finally launched here because this way - * we're sure that we don't create a zombie record on failure - */ - if (!$this->perform($model)) { /* uses source, etc. from runtime */ + if (!$this->perform($Model)) { /* uses source, etc. from runtime */ return false; } - - $model->data[$model->alias]['file'] = $destination['dirname'] . DS . $destination['basename']; - - return $model->data[$model->alias]; + $Model->data[$Model->alias]['file'] = $destination['dirname'] . DS . $destination['basename']; + return $Model->data[$Model->alias]; } /** - * Triggered before beforeValidation and before beforeSave or upon user request + * Triggered by `beforeValidate`, `beforeSave` or upon user request * - * Prepares runtime for being used by the execute method + * Prepares runtime for being used by `perform()` * - * @param object $model + * @param Model $Model * @param string $file Optionally provide a valid transfer resource to be used as source * @return mixed true if transfer is ready to be performed, false on error, null if no data was found */ - function prepare(&$model, $file = null) { - if (isset($model->data[$model->alias]['file'])) { - $file = $model->data[$model->alias]['file']; + function prepare(&$Model, $file = null) { + if (isset($Model->data[$Model->alias]['file'])) { + $file = $Model->data[$Model->alias]['file']; } if (empty($file)) { return null; } - if ($this->runtime[$model->alias]['hasPerformed']) { - $this->reset($model); + if ($this->runtime[$Model->alias]['hasPerformed']) { + $this->reset($Model); } - if ($this->runtime[$model->alias]['isReady']) { + if ($this->runtime[$Model->alias]['isReady']) { return true; } - /* Extract runtime after reset to get default values */ - extract($this->settings[$model->alias], EXTR_SKIP); - extract($this->runtime[$model->alias], EXTR_SKIP); + /* Extraction must happen after reset */ + extract($this->settings[$Model->alias], EXTR_SKIP); + extract($this->runtime[$Model->alias], EXTR_SKIP); if (TransferValidation::blank($file)) { /* Set explicitly null enabling allowEmpty in rules act upon emptiness */ - return $model->data[$model->alias]['file'] = null; + return $Model->data[$Model->alias]['file'] = null; } - if ($source = $this->_source($model, $file)) { - $this->runtime[$model->alias]['source'] = $source; + if ($source = $this->_source($Model, $file)) { + $this->runtime[$Model->alias]['source'] = $source; } else { return false; } + /* Temporary is optional and can fail */ if ($source['type'] !== 'file-local') { - /* Temporary is allowed to fail silently */ - $temporary = $this->runtime[$model->alias]['temporary'] = $this->_temporary($model, $file); + $temporary = $this->runtime[$Model->alias]['temporary'] = $this->_temporary($Model, $file); } - /* - * Fill Markers to enable substitution in destinationFile - * Add more markers here if you need them in your path - */ - $this->_addMarker($model, 'DS', DS); + $this->_addMarker($Model, 'DS', DS); - $this->_addMarker($model, 'uuid', String::uuid()); - $this->_addMarker($model, 'unixTimestamp', time()); - $this->_addMarker($model, 'year', date('Y')); - $this->_addMarker($model, 'month', date('m')); - $this->_addMarker($model, 'day', date('d')); + $this->_addMarker($Model, 'uuid', String::uuid()); + $this->_addMarker($Model, 'unixTimestamp', time()); + $this->_addMarker($Model, 'year', date('Y')); + $this->_addMarker($Model, 'month', date('m')); + $this->_addMarker($Model, 'day', date('d')); - $filename = $this->_addMarker($model, 'Source.filename', $source['filename'], true); - $extension = $this->_addMarker($model, 'Source.extension', $source['extension'], true); - $this->_addMarker($model, 'Source.basename', empty($extension) ? $filename : $filename . '.' . $extension); - $this->_addMarker($model, 'Source.mimeType', $source['mimeType'], true); - $this->_addMarker($model, 'Source.type', $source['type']); + $filename = $this->_addMarker($Model, 'Source.filename', $source['filename'], true); + $extension = $this->_addMarker($Model, 'Source.extension', $source['extension'], true); + $this->_addMarker($Model, 'Source.basename', empty($extension) ? $filename : $filename . '.' . $extension); + $this->_addMarker($Model, 'Source.mimeType', $source['mimeType'], true); + $this->_addMarker($Model, 'Source.type', $source['type']); - /* Figure out medium type and map it */ - $this->_addMarker($model, 'Medium.name', strtolower(Medium::name($source['file'], $source['mimeType']))); - $this->_addMarker($model, 'Medium.short', Medium::short($source['file'], $source['mimeType'])); + $this->_addMarker($Model, 'Medium.name', strtolower(Medium::name($source['file'], $source['mimeType']))); + $this->_addMarker($Model, 'Medium.short', Medium::short($source['file'], $source['mimeType'])); - if (isset($model->data[$model->alias])) { /* Needed for tableless Models */ - $this->_addMarker($model, $model->alias . '.', $model->data[$model->alias], true); - $this->_addMarker($model, 'Model.', $model->data[$model->alias], true); + /* Needed for tableless Models */ + if (isset($Model->data[$Model->alias])) { + $this->_addMarker($Model, $Model->alias . '.', $Model->data[$Model->alias], true); + $this->_addMarker($Model, 'Model.', $Model->data[$Model->alias], true); } - $this->_addMarker($model, 'Model.name', $model->name); - $this->_addMarker($model, 'Model.alias', $model->alias); + $this->_addMarker($Model, 'Model.name', $Model->name); + $this->_addMarker($Model, 'Model.alias', $Model->alias); - /* Destination */ - $file = $baseDirectory . $this->_replaceMarker($model, $destinationFile); + $file = $baseDirectory . $this->_replaceMarker($Model, $destinationFile); - if ($destination = $this->_destination($model, $file)) { - $this->runtime[$model->alias]['destination'] = $destination; + if ($destination = $this->_destination($Model, $file)) { + $this->runtime[$Model->alias]['destination'] = $destination; } else { return false; } - /* Do error checks */ if ($source == $destination || $temporary == $destination) { return false; } $Folder = new Folder($destination['dirname'], $createDirectory); + if (!$Folder->pwd()) { - trigger_error('TransferBehavior::prepare - Directory \'' . $destination['dirname'] . '\' could not be created or is not writable. Please check your permissions.', E_USER_WARNING); + $message = "TransferBehavior::prepare - Directory `{$destination['dirname']}` could "; + $message .= "not be created or is not writable. Please check the permissions."; + trigger_error($message, E_USER_WARNING); return false; } - - return $this->runtime[$model->alias]['isReady'] = true; /* Ready ! */ + return $this->runtime[$Model->alias]['isReady'] = true; } /** * Parse data to be used as source @@ -290,13 +275,13 @@ class TransferBehavior extends ModelBehavior { * @return mixed Array with parsed results on success, false on error * @todo evaluate errors in file uploads */ - function _source(&$model, $data) { + function _source(&$Model, $data) { if (TransferValidation::fileUpload($data)) { - return array_merge($this->info($model, $data), array('error' => $data['error'])); + return array_merge($this->info($Model, $data), array('error' => $data['error'])); } elseif (MediaValidation::file($data)) { - return $this->info($model, $data); + return $this->info($Model, $data); } elseif (TransferValidation::url($data, array('scheme' => 'http'))) { - return $this->info($model, $data); + return $this->info($Model, $data); } return false; } @@ -306,11 +291,15 @@ class TransferBehavior extends ModelBehavior { * @param mixed Path to file in local FS or file-upload array * @return mixed Array with parsed results on success, false on error */ - function _temporary(&$model, $data) { - if (TransferValidation::fileUpload($data) && TransferValidation::uploadedFile($data['tmp_name'])) { - return array_merge($this->info($model, $data['tmp_name']), array('error' => $data['error'])); + function _temporary(&$Model, $data) { + if (TransferValidation::fileUpload($data) + && TransferValidation::uploadedFile($data['tmp_name'])) { + return array_merge( + $this->info($Model, $data['tmp_name']), + array('error' => $data['error']) + ); } elseif (MediaValidation::file($data)) { - return $this->info($model, $data); + return $this->info($Model, $data); } return false; } @@ -320,41 +309,45 @@ class TransferBehavior extends ModelBehavior { * @param mixed Path to file in local FS * @return mixed Array with parsed results on success, false on error */ - function _destination(&$model, $data) { - if (MediaValidation::file($data , false)) { /* Destination file may not exist yet */ + function _destination(&$Model, $data) { + /* Destination file may not exist yet */ + if (MediaValidation::file($data , false)) { if (!$data = $this->_alternativeFile($data)) { - $this->log('TransferBehavior::_destination - Exceeded # of max. tries while finding alt. name for \'' . basename($data) . '\''); + $message = "TransferBehavior::_destination - "; + $message .= "Exceeded number of max. tries while finding alt. name "; + $message .= "for `" . basename($data) . "`"; + trigger_error($message, E_USER_NOTICE); return false; } - return $this->info($model, $data); + return $this->info($Model, $data); } return false; } /** * Performs a transfer * - * @param object $model + * @param Model $Model * @param array $source * @param array $temporary * @param array $destination - * @return bool true on success, false on failure + * @return boolean true on success, false on failure */ - function perform(&$model) { - $source = $this->runtime[$model->alias]['source']; - $temporary = $this->runtime[$model->alias]['temporary']; - $destination = $this->runtime[$model->alias]['destination']; + function perform(&$Model) { + $source = $this->runtime[$Model->alias]['source']; + $temporary = $this->runtime[$Model->alias]['temporary']; + $destination = $this->runtime[$Model->alias]['destination']; $typeChain = implode('>>', array($source['type'], $temporary['type'], $destination['type'])); $fileChain = implode('>>', array($source['file'], $temporary['file'], $destination['file'])); if ($typeChain === 'file-upload-remote>>uploaded-file-local>>file-local') { - return $this->runtime[$model->alias]['hasPerformed'] = move_uploaded_file($temporary['file'], $destination['file']); + return $this->runtime[$Model->alias]['hasPerformed'] = move_uploaded_file($temporary['file'], $destination['file']); } if ($typeChain === 'file-local>>>>file-local') { - return $this->runtime[$model->alias]['hasPerformed'] = copy($source['file'], $destination['file']); + return $this->runtime[$Model->alias]['hasPerformed'] = copy($source['file'], $destination['file']); } if ($typeChain === 'file-local>>file-local>>file-local') { - return $this->runtime[$model->alias]['hasPerformed'] = copy($source['file'], $temporary['file']) && rename($temporary['file'], $destination['file']); + return $this->runtime[$Model->alias]['hasPerformed'] = copy($source['file'], $temporary['file']) && rename($temporary['file'], $destination['file']); } if ($source['type'] === 'http-url-remote') { if(!class_exists('HttpSocket')) { @@ -365,39 +358,39 @@ class TransferBehavior extends ModelBehavior { $Socket->request(array('method' => 'GET', 'uri' => $source['file'])); if (!empty($Socket->error) || $Socket->response['status']['code'] != 200) { - return $this->runtime[$model->alias]['hasPerformed'] = false; + return $this->runtime[$Model->alias]['hasPerformed'] = false; } } if ($typeChain === 'http-url-remote>>>>file-local') { - return $this->runtime[$model->alias]['hasPerformed'] = file_put_contents($destination['file'], $Socket->response['body']); + return $this->runtime[$Model->alias]['hasPerformed'] = file_put_contents($destination['file'], $Socket->response['body']); } if($typeChain === 'http-url-remote>>file-local>>file-local') { - return $this->runtime[$model->alias]['hasPerformed'] = file_put_contents($temporary['file'], $Socket->response['body']) && rename($temporary['file'], $destination['file']); + return $this->runtime[$Model->alias]['hasPerformed'] = file_put_contents($temporary['file'], $Socket->response['body']) && rename($temporary['file'], $destination['file']); } - return $this->runtime[$model->alias]['hasPerformed'] = false; + return $this->runtime[$Model->alias]['hasPerformed'] = false; } /** * Resets runtime property * - * @param object $model + * @param Model $Model * @return void */ - function reset(&$model) { - $this->runtime[$model->alias]['source'] = null; - $this->runtime[$model->alias]['temporary'] = null; - $this->runtime[$model->alias]['destination'] = null; - $this->runtime[$model->alias]['isReady'] = false; - $this->runtime[$model->alias]['hasPerformed'] = false; - $this->runtime[$model->alias]['markers'] = array(); + function reset(&$Model) { + $this->runtime[$Model->alias]['source'] = null; + $this->runtime[$Model->alias]['temporary'] = null; + $this->runtime[$Model->alias]['destination'] = null; + $this->runtime[$Model->alias]['isReady'] = false; + $this->runtime[$Model->alias]['hasPerformed'] = false; + $this->runtime[$Model->alias]['markers'] = array(); } /** * Convenience method which (if available) returns absolute path to last transferred file * - * @param object $model + * @param Model $Model * @return mixed */ - function getLastTransferredFile(&$model) { - extract($this->runtime[$model->alias], EXTR_SKIP); + function getLastTransferredFile(&$Model) { + extract($this->runtime[$Model->alias], EXTR_SKIP); if ($hasPerformed) { return $destination['file']; @@ -409,23 +402,23 @@ class TransferBehavior extends ModelBehavior { * * @see TransferBehavior::source * - * @param object $model + * @param Model $Model * @param array $field - * @return bool + * @return boolean */ - function checkResource(&$model, $field) { + function checkResource(&$Model, $field) { return TransferValidation::resource(current($field)); } /** * Checks if sufficient permissions are set to access the resource * Source must be readable, temporary read or writable, destination writable * - * @param object $model + * @param Model $Model * @param array $field - * @return bool + * @return boolean */ - function checkAccess(&$model, $field) { - extract($this->runtime[$model->alias]); + function checkAccess(&$Model, $field) { + extract($this->runtime[$Model->alias]); if (MediaValidation::file($source['file'], true)) { if (!MediaValidation::access($source['file'], 'r')) { @@ -436,7 +429,6 @@ class TransferBehavior extends ModelBehavior { return false; } } - if (!empty($temporary)) { if (MediaValidation::file($temporary['file'], true)) { if (!MediaValidation::access($temporary['file'], 'r')) { @@ -448,7 +440,6 @@ class TransferBehavior extends ModelBehavior { } } } - if (!MediaValidation::access($destination['dirname'], 'w')) { return false; } @@ -457,21 +448,21 @@ class TransferBehavior extends ModelBehavior { /** * Checks if resource is located within given locations * - * @param object $model + * @param Model $Model * @param array $field * @param mixed $allow True or * allows any location, an array containing absolute paths to locations - * @return bool + * @return boolean */ - function checkLocation(&$model, $field, $allow = true) { - extract($this->runtime[$model->alias]); - $allow = $this->_replaceMarker($model, $allow); + function checkLocation(&$Model, $field, $allow = true) { + extract($this->runtime[$Model->alias]); + $allow = $this->_replaceMarker($Model, $allow); foreach (array('source', 'temporary', 'destination') as $type) { if ($type == 'temporary' && empty($$type)) { - continue(1); + continue; } if ($type == 'source' && ${$type}['type'] == 'file-upload-remote') { - continue(1); + continue; } if (!MediaValidation::location(${$type}['file'], $allow)) { return false; @@ -482,17 +473,19 @@ class TransferBehavior extends ModelBehavior { /** * Checks if provided or potentially dangerous permissions are set * - * @param object $model + * @param Model $Model * @param array $field - * @param mixed $match True to check for potentially dangerous permissions, a string containing the 4-digit octal value of the permissions to check for an exact match, false to allow any permissions - * @return bool + * @param mixed $match True to check for potentially dangerous permissions, + * a string containing the 4-digit octal value of the permissions to check for an exact match, + * false to allow any permissions + * @return boolean */ - function checkPermission(&$model, $field, $match = true) { - extract($this->runtime[$model->alias]); + function checkPermission(&$Model, $field, $match = true) { + extract($this->runtime[$Model->alias]); foreach (array('source', 'temporary') as $type) { if ($type == 'temporary' && empty($$type)) { - continue(1); + continue; } if (!MediaValidation::permission(${$type}['permission'], $match)) { return false; @@ -504,20 +497,20 @@ class TransferBehavior extends ModelBehavior { * Checks if resource doesn't exceed provided size * * Please note that the size will always be checked against - * limitations set in php.ini for post_max_size and upload_max_filesize - * even if $max is set to false + * limitations set in `php.ini` for `post_max_size` and `upload_max_filesize` + * even if $max is set to false. * - * @param object $model + * @param Model $Model * @param array $field * @param mixed $max String (e.g. 8M) containing maximum allowed size, false allows any size - * @return bool + * @return boolean */ - function checkSize(&$model, $field, $max = false) { - extract($this->runtime[$model->alias]); + function checkSize(&$Model, $field, $max = false) { + extract($this->runtime[$Model->alias]); foreach (array('source', 'temporary') as $type) { if ($type == 'temporary' && empty($$type)) { - continue(1); + continue; } if (!MediaValidation::size(${$type}['size'], $max)) { return false; @@ -532,17 +525,17 @@ class TransferBehavior extends ModelBehavior { * the image gets resized later. You can calculate the amount of memory used * like this: width * height * 4 + overhead * - * @param object $model + * @param Model $Model * @param array $field * @param mixed $max String (e.g. 40000 or 200x100) containing maximum allowed amount of pixels - * @return bool + * @return boolean */ - function checkPixels(&$model, $field, $max = false) { - extract($this->runtime[$model->alias]); + function checkPixels(&$Model, $field, $max = false) { + extract($this->runtime[$Model->alias]); foreach (array('source', 'temporary') as $type) { /* pixels value is optional */ if(($type == 'temporary' && empty($$type)) || !isset(${$type}['pixels'])) { - continue(1); + continue; } if(!MediaValidation::pixels(${$type}['pixels'], $max)) { return false; @@ -553,18 +546,22 @@ class TransferBehavior extends ModelBehavior { /** * Checks if resource has (not) one of given extensions * - * @param object $model + * @param Model $Model * @param array $field - * @param mixed $deny True or * blocks any extension, an array containing extensions (w/o leading dot) selectively blocks, false blocks no extension - * @param mixed $allow True or * allows any extension, an array containing extensions (w/o leading dot) selectively allows, false allows no extension - * @return bool + * @param mixed $deny True or * blocks any extension, + * an array containing extensions (w/o leading dot) selectively blocks, + * false blocks no extension + * @param mixed $allow True or * allows any extension, + * an array containing extensions (w/o leading dot) selectively allows, + * false allows no extension + * @return boolean */ - function checkExtension(&$model, $field, $deny = false, $allow = true) { - extract($this->runtime[$model->alias]); + function checkExtension(&$Model, $field, $deny = false, $allow = true) { + extract($this->runtime[$Model->alias]); foreach (array('source', 'temporary', 'destination') as $type) { if (($type == 'temporary' && empty($$type)) || !isset(${$type}['extension'])) { - continue(1); + continue; } if (!MediaValidation::extension(${$type}['extension'], $deny, $allow)) { return false; @@ -573,17 +570,21 @@ class TransferBehavior extends ModelBehavior { return true; } /** - * Checks if resource has (not) one of given mime types + * Checks if resource has (not) one of given MIME types * - * @param object $model + * @param Model $Model * @param array $field - * @param mixed $deny True or * blocks any mime type, an array containing mime types selectively blocks, false blocks no mime type - * @param mixed $allow True or * allows any extension, an array containing extensions selectively allows, false allows no mime type - * @return bool + * @param mixed $deny True or * blocks any MIME type, + * an array containing MIME types selectively blocks, + * false blocks no MIME type + * @param mixed $allow True or * allows any extension, + * an array containing extensions selectively allows, + * false allows no MIME type + * @return boolean */ - function checkMimeType(&$model, $field, $deny = false, $allow = true) { - extract($this->runtime[$model->alias]); - extract($this->settings[$model->alias], EXTR_SKIP); + function checkMimeType(&$Model, $field, $deny = false, $allow = true) { + extract($this->runtime[$Model->alias]); + extract($this->settings[$Model->alias], EXTR_SKIP); foreach (array('source', 'temporary') as $type) { /* @@ -595,11 +596,13 @@ class TransferBehavior extends ModelBehavior { * ------|----------|---------------------------- * false | x/x,null | x/x,null | null */ + /* Temporary is optional */ if ($type === 'temporary' && empty($$type)) { - continue(1); // some transfers dont use a temporary + continue; } + /* With `trustClient` set to `false` we don't necessarily have a MIME type */ if (!isset(${$type}['mimeType']) && !$trustClient) { - continue(1); // with trustClient set to false we don't necessarily have a MIME type + continue; } if (!MediaValidation::mimeType(${$type}['mimeType'], $deny, $allow)) { return false; @@ -611,42 +614,41 @@ class TransferBehavior extends ModelBehavior { * Gather/Return information about a resource * * @param mixed $resource Path to file in local FS, URL or file-upload array - * @param string $what scheme,host,port,file,mime type,size,permission,dirname,basename,filename,extension or type + * @param string $what scheme, host, port, file, MIME type, size, permission, + * dirname, basename, filename, extension or type * @return mixed */ - function info(&$model, $resource, $what = null) { - extract($this->settings[$model->alias], EXTR_SKIP); + function info(&$Model, $resource, $what = null) { + extract($this->settings[$Model->alias], EXTR_SKIP); $defaultResource = array( - 'scheme' => null, - 'host' => null, - 'port' => null, - 'file' => null, - 'mimeType' => null, - 'size' => null, - 'pixels' => null, - 'permisssion' => null, - 'dirname' => null, - 'basename' => null, - 'filename' => null, - 'extension' => null, - 'type' => null, - ); - - /* HTTP Url */ - /* Currently http is supported only */ + 'scheme' => null, + 'host' => null, + 'port' => null, + 'file' => null, + 'mimeType' => null, + 'size' => null, + 'pixels' => null, + 'permisssion' => null, + 'dirname' => null, + 'basename' => null, + 'filename' => null, + 'extension' => null, + 'type' => null, + ); + + /* Currently HTTP is supported only */ if (TransferValidation::url($resource, array('scheme' => 'http'))) { $resource = array_merge( - $defaultResource, - pathinfo(parse_url($resource, PHP_URL_PATH)), - array( - 'scheme' => parse_url($resource, PHP_URL_SCHEME), - 'host' => parse_url($resource, PHP_URL_HOST), - 'port' => parse_url($resource, PHP_URL_PORT), - 'file' => $resource, - 'type' => 'http-url-remote', - ) - ); + $defaultResource, + pathinfo(parse_url($resource, PHP_URL_PATH)), + array( + 'scheme' => parse_url($resource, PHP_URL_SCHEME), + 'host' => parse_url($resource, PHP_URL_HOST), + 'port' => parse_url($resource, PHP_URL_PORT), + 'file' => $resource, + 'type' => 'http-url-remote', + )); if (!class_exists('HttpSocket')) { App::import('Core', 'HttpSocket'); @@ -656,26 +658,22 @@ class TransferBehavior extends ModelBehavior { if (empty($Socket->error) && $Socket->response['status']['code'] == 200) { $resource = array_merge( - $resource, - array( - 'size' => $Socket->response['header']['Content-Length'], - 'mimeType' => $trustClient ? $Socket->response['header']['Content-Type'] : null, - 'permission' => '0004' - ) - ); + $resource, + array( + 'size' => $Socket->response['header']['Content-Length'], + 'mimeType' => $trustClient ? $Socket->response['header']['Content-Type'] : null, + 'permission' => '0004' + )); } - - /* File */ } elseif (MediaValidation::file($resource, false)) { $resource = array_merge( - $defaultResource, - pathinfo($resource), - array( - 'file' => $resource, - 'host' => 'localhost', - 'mimeType' => MimeType::guessType($resource, array('paranoid' => !$trustClient)), - ) - ); + $defaultResource, + pathinfo($resource), + array( + 'file' => $resource, + 'host' => 'localhost', + 'mimeType' => MimeType::guessType($resource, array('paranoid' => !$trustClient)), + )); if (TransferValidation::uploadedFile($resource['file'])) { $resource['type'] = 'uploaded-file-local'; @@ -685,36 +683,31 @@ class TransferBehavior extends ModelBehavior { if (is_readable($resource['file'])) { /* - * Because there is not good way to determine if resource is an image + * Because there is not better way to determine if resource is an image * first, we suppress a warning that would be thrown here otherwise. */ list($width, $height) = @getimagesize($resource['file']); $resource = array_merge( - $resource, - array( - 'size' => filesize($resource['file']), - 'permission' => substr(sprintf('%o', fileperms($resource['file'])), -4), - 'pixels' => $width * $height, - ) - ); + $resource, + array( + 'size' => filesize($resource['file']), + 'permission' => substr(sprintf('%o', fileperms($resource['file'])), -4), + 'pixels' => $width * $height, + )); } - - /* File Upload */ } elseif (TransferValidation::fileUpload($resource)) { $resource = array_merge( - $defaultResource, - pathinfo($resource['name']), - array( - 'file' => $resource['name'], - 'host' => env('REMOTE_ADDR'), - 'size' => $resource['size'], - 'mimeType' => $trustClient ? $resource['type'] : null, - 'permission' => '0004', - 'type' => 'file-upload-remote', - ) - ); - + $defaultResource, + pathinfo($resource['name']), + array( + 'file' => $resource['name'], + 'host' => env('REMOTE_ADDR'), + 'size' => $resource['size'], + 'mimeType' => $trustClient ? $resource['type'] : null, + 'permission' => '0004', + 'type' => 'file-upload-remote', + )); } else { return null; } @@ -730,11 +723,12 @@ class TransferBehavior extends ModelBehavior { * Finds an alternative filename for an already existing file * * @param string $file Absolute path to file in local FS - * @param int $tries Number of tries + * @param integer $tries Number of tries * @return mixed A string if an alt. name was found, false if number of tries were exceeded */ function _alternativeFile($file, $tries = 100) { extract(pathinfo($file), EXTR_SKIP); + $newFilename = $filename; $Folder = new Folder($dirname); @@ -759,17 +753,17 @@ class TransferBehavior extends ModelBehavior { /** * Adds and/or overwrites marker(s)/replacement(s) * - * @param object $model + * @param Model $Model * @param string $marker The name of the marker, or the prefix for mapped markers * @param string $replacement String or an array mapping markers to replacements */ - function _addMarker(&$model, $marker, $replacement = null, $slugify = false) { + function _addMarker(&$Model, $marker, $replacement = null, $slugify = false) { if (is_array($replacement)) { foreach ($replacement as $subMarker => $subReplacement) { if (is_array($subReplacement)) { - continue(1); + continue; } - $this->_addMarker($model, $marker . $subMarker, $subReplacement, $slugify); + $this->_addMarker($Model, $marker . $subMarker, $subReplacement, $slugify); } return true; } @@ -777,21 +771,20 @@ class TransferBehavior extends ModelBehavior { if ($slugify) { $replacement = strtolower(Inflector::slug($replacement, '_')); } - - return $this->runtime[$model->alias]['markers'][$marker] = $replacement; + return $this->runtime[$Model->alias]['markers'][$marker] = $replacement; } /** * Replace with constants and dynamic replacements * - * @param object $model + * @param Model $Model * @param mixed $subject Array holding multiple strings or a single string - * @param bool $safe Make result safe for e.g. filenames + * @param boolean $safe Make result safe for e.g. filenames * @return string */ - function _replaceMarker(&$model, $subject) { + function _replaceMarker(&$Model, $subject) { if(is_array($subject)) { foreach ($subject as $s) { - $result[] = $this->_replaceMarker($model, $s); + $result[] = $this->_replaceMarker($Model, $s); } return $result; } @@ -800,11 +793,20 @@ class TransferBehavior extends ModelBehavior { return $subject; } - $markers = Set::filter($this->runtime[$model->alias]['markers']); - $subject = String::insert($subject, $markers, array('before' => ':', 'after' => ':', 'clean' => true, 'replacement' => 'unknown_marker')); + $markers = Set::filter($this->runtime[$Model->alias]['markers']); + $subject = String::insert($subject, $markers, array( + 'before' => ':', 'after' => ':', + 'clean' => true, + 'replacement' => 'unknown_marker' + )); if (strpos($subject, 'unknown_marker') !== false) { - trigger_error('TransferBehavior::_replaceMarker - Failed to replace all markers of subject \'' . $subject . '\'. Did you setup the Behavior correctly? Check the configuration you provided for TransferBehavior in your \'' . $model->name . '\' model.', E_USER_WARNING); + $message = "TransferBehavior::_replaceMarker - "; + $message .= "Failed to replace all markers of subject `{$subject}`. "; + $message .= "Did you setup the behavior correctly? "; + $message .= "Check the configuration you provided for TransferBehavior "; + $message .= "in your `{$Model->name}` model."; + trigger_error($message, E_USER_WARNING); return false; } return $subject; models/behaviors/transfer.php @@ -47,30 +47,34 @@ class AttachmentTestCase extends CakeTestCase { $Model = ClassRegistry::init('Movie'); $assoc = array( - 'Attachment' => array( - 'className' => 'Media.Attachment', - 'foreignKey' => 'foreign_key', - 'conditions' => array('model' => 'Movie'), - 'dependent' => true, - ), - ); + 'Attachment' => array( + 'className' => 'Media.Attachment', + 'foreignKey' => 'foreign_key', + 'conditions' => array('model' => 'Movie'), + 'dependent' => true, + )); $Model->bindModel(array('hasOne' => $assoc), false); $Model->Attachment->Behaviors->attach('Media.Polymorphic', array( 'classField' => 'model', - 'foreignKey' => 'foreign_key')); + 'foreignKey' => 'foreign_key' + )); $Model->Attachment->Behaviors->attach('Media.Transfer', array( - 'destinationFile' => ':TMP:test_suite:DS::Source.basename:')); + 'baseDirectory' => TMP, + 'destinationFile' => 'test_suite:DS::Source.basename:' + )); $Model->Attachment->Behaviors->attach('Media.Media', array( - 'base' => $this->TestFolder->pwd())); + 'baseDirectory' => TMP, + 'filterDirectory' => $this->TestFolder->pwd() . 'filter' . DS + )); $file = $this->TestData->getFile(array('image-jpg.jpg' => 'ta.jpg')); $data = array( - 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), - 'Attachment' => array('file' => $file, 'model' => 'Movie') - ); + 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), + 'Attachment' => array('file' => $file, 'model' => 'Movie') + ); $Model->create(); $this->assertTrue($Model->saveAll($data, array('validate' => 'first'))); @@ -79,15 +83,15 @@ class AttachmentTestCase extends CakeTestCase { $result = $Model->find('first', array('conditions' => array('title' => 'Weekend'))); $expected = array( - 'id' => 1, - 'model' => 'Movie', - 'foreign_key' => 4, - 'dirname' => null, - 'basename' => 'ta.jpg', - 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', - 'group' => null, - 'alternative' => null, - ); + 'id' => 1, + 'model' => 'Movie', + 'foreign_key' => 4, + 'dirname' => 'tmp/test_suite', + 'basename' => 'ta.jpg', + 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', + 'group' => null, + 'alternative' => null, + ); $this->assertEqual($result['Attachment'], $expected); unlink($file); } @@ -96,13 +100,12 @@ class AttachmentTestCase extends CakeTestCase { $Model = ClassRegistry::init('Movie'); $assoc = array( - 'Attachment' => array( - 'className' => 'Media.Attachment', - 'foreignKey' => 'foreign_key', - 'conditions' => array('model' => 'Movie'), - 'dependent' => true, - ), - ); + 'Attachment' => array( + 'className' => 'Media.Attachment', + 'foreignKey' => 'foreign_key', + 'conditions' => array('model' => 'Movie'), + 'dependent' => true, + )); $Model->bindModel(array('hasMany' => $assoc), false); $Model->Attachment->Behaviors->attach('Media.Polymorphic', array( @@ -110,20 +113,23 @@ class AttachmentTestCase extends CakeTestCase { 'foreignKey' => 'foreign_key')); $Model->Attachment->Behaviors->attach('Media.Transfer', array( - 'destinationFile' => ':TMP:test_suite:DS::Source.basename:')); + 'baseDirectory' => TMP, + 'destinationFile' => 'test_suite:DS::Source.basename:' + )); $Model->Attachment->Behaviors->attach('Media.Media', array( - 'base' => $this->TestFolder->pwd())); + 'baseDirectory' => TMP, + 'filterDirectory' => $this->TestFolder->pwd() . 'filter' . DS + )); $fileA = $this->TestData->getFile(array('image-jpg.jpg' => 'ta.jpg')); $fileB = $this->TestData->getFile(array('image-png.png' => 'tb.png')); $data = array( - 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), - 'Attachment' => array( - array('file' => $fileA, 'model' => 'Movie'), - array('file' => $fileB, 'model' => 'Movie') - ) - ); + 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), + 'Attachment' => array( + array('file' => $fileA, 'model' => 'Movie'), + array('file' => $fileB, 'model' => 'Movie') + )); $Model->create(); $result = $Model->saveAll($data, array('validate' => 'first')); @@ -134,26 +140,25 @@ class AttachmentTestCase extends CakeTestCase { $result = $Model->find('first', array('conditions' => array('title' => 'Weekend'))); $expected = array( 0 => array( - 'id' => 1, - 'model' => 'Movie', - 'foreign_key' => 4, - 'dirname' => null, - 'basename' => 'ta.jpg', - 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', - 'group' => null, - 'alternative' => null, - ), + 'id' => 1, + 'model' => 'Movie', + 'foreign_key' => 4, + 'dirname' => 'tmp/test_suite', + 'basename' => 'ta.jpg', + 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', + 'group' => null, + 'alternative' => null, + ), 1 => array( - 'id' => 2, - 'model' => 'Movie', - 'foreign_key' => 4, - 'dirname' => null, - 'basename' => 'tb.png', - 'checksum' => '7f9af648b511f2c83b1744f42254983f', - 'group' => null, - 'alternative' => null, - ) - ); + 'id' => 2, + 'model' => 'Movie', + 'foreign_key' => 4, + 'dirname' => 'tmp/test_suite', + 'basename' => 'tb.png', + 'checksum' => '7f9af648b511f2c83b1744f42254983f', + 'group' => null, + 'alternative' => null, + )); $this->assertEqual($result['Attachment'], $expected); } @@ -161,59 +166,64 @@ class AttachmentTestCase extends CakeTestCase { $Model = ClassRegistry::init('Movie'); $assoc = array( - 'Poster' => array( - 'className' => 'Media.Attachment', - 'foreignKey' => 'foreign_key', - 'conditions' => array('model' => 'Movie', 'Poster.group' => 'poster'), - 'dependent' => true, - ) - ); + 'Poster' => array( + 'className' => 'Media.Attachment', + 'foreignKey' => 'foreign_key', + 'conditions' => array('model' => 'Movie', 'Poster.group' => 'poster'), + 'dependent' => true, + )); $Model->bindModel(array('hasOne' => $assoc), false); $Model->Poster->Behaviors->attach('Media.Polymorphic', array( - 'classField' => 'model', - 'foreignKey' => 'foreign_key')); + 'classField' => 'model', + 'foreignKey' => 'foreign_key' + )); $Model->Poster->Behaviors->attach('Media.Transfer', array( - 'destinationFile' => ':TMP:test_suite:DS:poster:DS::Source.basename:')); + 'baseDirectory' => TMP, + 'destinationFile' => 'test_suite:DS:poster:DS::Source.basename:' + )); $Model->Poster->Behaviors->attach('Media.Media', array( - 'base' => $this->TestFolder->pwd())); + 'baseDirectory' => TMP, + 'filterDirectory' => $this->TestFolder->pwd() . 'filter' . DS + )); $assoc = array( - 'Photo' => array( - 'className' => 'Media.Attachment', - 'foreignKey' => 'foreign_key', - 'conditions' => array('model' => 'Movie', 'Photo.group' => 'photo'), - 'dependent' => true, - ), - ); + 'Photo' => array( + 'className' => 'Media.Attachment', + 'foreignKey' => 'foreign_key', + 'conditions' => array('model' => 'Movie', 'Photo.group' => 'photo'), + 'dependent' => true, + )); $Model->bindModel(array('hasMany' => $assoc), false); $Model->Photo->Behaviors->attach('Media.Polymorphic', array( 'classField' => 'model', - 'foreignKey' => 'foreign_key')); + 'foreignKey' => 'foreign_key' + )); $Model->Photo->Behaviors->attach('Media.Transfer', array( - 'destinationFile' => ':TMP:test_suite:DS:photo:DS::Source.basename:')); + 'baseDirectory' => TMP, + 'destinationFile' => 'test_suite:DS:photo:DS::Source.basename:' + )); $Model->Photo->Behaviors->attach('Media.Media', array( - 'base' => $this->TestFolder->pwd())); + 'baseDirectory' => TMP, + 'filterDirectory' => $this->TestFolder->pwd() . 'filter' . DS + )); $fileA = $this->TestData->getFile(array('image-jpg.jpg' => 'ta.jpg')); $fileB = $this->TestData->getFile(array('image-png.png' => 'tb.png')); $fileC = $this->TestData->getFile(array('image-png.png' => 'tc.png')); $data = array( - 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), - 'Poster' => array( - 'file' => $fileA, 'model' => 'Movie', 'group' => 'poster', - ), - 'Photo' => array( - array('file' => $fileB, 'model' => 'Movie', 'group' => 'photo'), - array('file' => $fileC, 'model' => 'Movie', 'group' => 'photo'), - ) - ); + 'Movie' => array('title' => 'Weekend', 'director' => 'Jean-Luc Godard'), + 'Poster' => array('file' => $fileA, 'model' => 'Movie', 'group' => 'poster'), + 'Photo' => array( + array('file' => $fileB, 'model' => 'Movie', 'group' => 'photo'), + array('file' => $fileC, 'model' => 'Movie', 'group' => 'photo'), + )); $Model->create(); $result = $Model->saveAll($data, array('validate' => 'first')); @@ -231,38 +241,36 @@ class AttachmentTestCase extends CakeTestCase { ), 'Actor' => array(), 'Poster' => array( - 'id' => 1, + 'id' => 1, + 'model' => 'Movie', + 'foreign_key' => 4, + 'dirname' => 'tmp/test_suite/poster', + 'basename' => 'ta.jpg', + 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', + 'group' => 'poster', + 'alternative' => null, + ), + 'Photo' => array( + 0 => array( + 'id' => 2, 'model' => 'Movie', 'foreign_key' => 4, - 'dirname' => 'poster', - 'basename' => 'ta.jpg', - 'checksum' => '1920c29e7fbe4d1ad2f9173ef4591133', - 'group' => 'poster', + 'dirname' => 'tmp/test_suite/photo', + 'basename' => 'tb.png', + 'checksum' => '7f9af648b511f2c83b1744f42254983f', + 'group' => 'photo', 'alternative' => null, ), - 'Photo' => array( - 0 => array( - 'id' => 2, - 'model' => 'Movie', - 'foreign_key' => 4, - 'dirname' => 'photo', - 'basename' => 'tb.png', - 'checksum' => '7f9af648b511f2c83b1744f42254983f', - 'group' => 'photo', - 'alternative' => null, - ), 1 => array( - 'id' => 3, - 'model' => 'Movie', - 'foreign_key' => 4, - 'dirname' => 'photo', - 'basename' => 'tc.png', - 'checksum' => '7f9af648b511f2c83b1744f42254983f', - 'group' => 'photo', - 'alternative' => null, - ) - ), - ); + 'id' => 3, + 'model' => 'Movie', + 'foreign_key' => 4, + 'dirname' => 'tmp/test_suite/photo', + 'basename' => 'tc.png', + 'checksum' => '7f9af648b511f2c83b1744f42254983f', + 'group' => 'photo', + 'alternative' => null, + ))); $this->assertEqual($result, $expected); } } tests/cases/models/attachment.test.php @@ -44,19 +44,22 @@ class MediaBehaviorTestCase extends CakeTestCase { $this->TestData = new TestData(); $this->file0 = $this->TestData->getFile(array( - 'image-png.png' => $this->TmpFolder->pwd() . 'static/img/image-png.png')); + 'image-png.png' => $this->TmpFolder->pwd() . 'static/img/image-png.png' + )); $this->file1 = $this->TestData->getFile(array( - 'image-jpg.jpg' => $this->TmpFolder->pwd() . 'static/img/image-jpg.jpg')); + 'image-jpg.jpg' => $this->TmpFolder->pwd() . 'static/img/image-jpg.jpg' + )); $this->file2 = $this->TestData->getFile(array( - 'text-plain.txt' => $this->TmpFolder->pwd() . 'static/txt/text-plain.txt')); + 'text-plain.txt' => $this->TmpFolder->pwd() . 'static/txt/text-plain.txt' + )); $this->_behaviorSettings = array( - 'baseDirectory' => $this->TmpFolder->pwd(), - 'makeVersions' => false, - 'createDirectory' => false, - 'filterDirectory' => $this->TmpFolder->pwd() . 'filter' . DS, - 'metadataLevel' => 1 - ); + 'baseDirectory' => $this->TmpFolder->pwd(), + 'makeVersions' => false, + 'createDirectory' => false, + 'filterDirectory' => $this->TmpFolder->pwd() . 'filter' . DS, + 'metadataLevel' => 1 + ); $this->_mediaConfig = Configure::read('Media'); } @@ -93,19 +96,23 @@ class MediaBehaviorTestCase extends CakeTestCase { $Model->Behaviors->attach('Media.Media', $this->_behaviorSettings); $file = $this->TestData->getFile(array( - 'application-pdf.pdf' => $this->TmpFolder->pwd() . 'static/doc/application-pdf.pdf')); + 'application-pdf.pdf' => $this->TmpFolder->pwd() . 'static/doc/application-pdf.pdf' + )); $item = array('file' => $file); $Model->create(); $result = $Model->save($item); $this->assertTrue($result); $result = $Model->findById(5); - $expected = array ('Song' => array ('id' => '5', - 'dirname' => 'static/doc', - 'basename' => 'application-pdf.pdf', - 'checksum' => 'f7ee91cffd90881f3d719e1bab1c4697', - 'size' => 13903, - 'mime_type' => 'application/pdf')); + $expected = array( + 'Song' => array ( + 'id' => '5', + 'dirname' => 'static/doc', + 'basename' => 'application-pdf.pdf', + 'checksum' => 'f7ee91cffd90881f3d719e1bab1c4697', + 'size' => 13903, + 'mime_type' => 'application/pdf' + )); $this->assertEqual($expected, $result); } @@ -138,15 +145,14 @@ class MediaBehaviorTestCase extends CakeTestCase { ) ); $expected[] = array( - $file, - array( - 'overwrite' => false, - 'directory' => $this->TmpFolder->pwd() . 'filter' . DS . 'm' . DS, - 'name' => 'Image', - 'version' => 'm', - 'instructions' => array('convert' => 'image/png', 'fit' => array(10, 10)) - ) - ); + $file, + array( + 'overwrite' => false, + 'directory' => $this->TmpFolder->pwd() . 'filter' . DS . 'm' . DS, + 'name' => 'Image', + 'version' => 'm', + 'instructions' => array('convert' => 'image/png', 'fit' => array(10, 10)) + )); $Model->make($file); $this->assertEqual($Model->beforeMakeArgs, $expected); tests/cases/models/behaviors/media.test.php @@ -38,10 +38,6 @@ class MediaValidationTest extends CakeTestCase { $result = MediaValidation::mimeType($check); $this->assertTrue($result); - $check = 'text/x-php'; - $result = MediaValidation::mimeType($check); - $this->assertFalse($result); - $check = 'image/png'; $result = MediaValidation::mimeType($check,array('image/png')); $this->assertFalse($result); @@ -72,10 +68,6 @@ class MediaValidationTest extends CakeTestCase { $result = MediaValidation::extension($check, false, array('tar.gz')); $this->assertFalse($result); - $check = 'php'; - $result = MediaValidation::extension($check); - $this->assertFalse($result); - $check = 'png'; $result = MediaValidation::extension($check, array('png')); $this->assertFalse($result); tests/cases/vendors/media_validation.test.php @@ -25,14 +25,18 @@ App::import('Core', 'Validation'); */ class MediaValidation extends Validation { /** - * Checks if mime type is (not) one of given mime types + * Checks if MIME type is (not) one of given MIME types * * @param string $check Mime type to check e.g. image/jpeg - * @param mixed $deny True or * blocks any mime type, an array containing mime types selectively blocks, false blocks no mime type - * @param mixed $allow True or * allows any extension, an array containing extensions selectively allows, false allows no mime type - * @return bool + * @param mixed $deny True or * blocks any MIME type, + * an array containing MIME types selectively blocks, + * false blocks no MIME type + * @param mixed $allow True or * allows any extension, + * an array containing extensions selectively allows, + * false allows no MIME type + * @return boolean */ - function mimeType($check, $deny = array('application/octet-stream', 'text/x-php'), $allow = true) { + function mimeType($check, $deny = false, $allow = true) { if (!is_string($check) || !preg_match('/^[-\w.\+]+\/[-\w.\+]+$/', $check)) { return false; } @@ -49,12 +53,16 @@ class MediaValidation extends Validation { /** * Checks if extension is (not) one of given extensions * - * @param string $check Extension to check (w/o leading dot) - * @param mixed $deny True or * blocks any extension, an array containing extensions (w/o leading dot) selectively blocks, false blocks no extension - * @param mixed $allow True or * allows any extension, an array containing extensions (w/o leading dot) selectively allows, false allows no extension - * @return bool + * @param string $check Extension to check (without leading dot) + * @param mixed $deny True or * blocks any extension, + * an array containing extensions (without a leading dot) selectively blocks, + * false blocks no extension + * @param mixed $allow True or * allows any extension, + * an array containing extensions (without leading dot) selectively allows, + * false allows no extension + * @return boolean */ - function extension($check, $deny = array('bin', 'class', 'dll', 'dms', 'exe', 'lha', 'lzh', 'so', 'as', 'asp', 'sh', 'java', 'js', 'lisp', 'lua', 'pl', 'pm', 'php', 'py', 'pyc', 'vb', 'bas'), $allow = true) { + function extension($check, $deny = false, $allow = true) { if (!is_string($check) || !preg_match('/^[\w0-9]+(\.[\w0-9]+)?$/', $check)) { return false; } @@ -72,12 +80,12 @@ class MediaValidation extends Validation { * Checks if size is within limits * * Please note that the size will always be checked against - * limitations set in php.ini for post_max_size and upload_max_filesize - * even if $max is set to false + * limitations set in `php.ini` for `post_max_size` and `upload_max_filesize` + * even if $max is set to false. * - * @param int $check Size to check in bytes + * @param integer $check Size to check in bytes * @param mixed $max String (e.g. 8M) containing maximum allowed size, false allows any size - * @return bool + * @return boolean */ function size($check, $max = false) { if (!$check = self::_toComputableSize($check)) { @@ -110,7 +118,7 @@ class MediaValidation extends Validation { * * @param mixed $check Pixels to check e.g 200x200 or 40000 * @param mixed $max String (e.g. 40000 or 200x100) containing maximum allowed amount of pixels - * @return bool + * @return boolean */ function pixels($check, $max = false) { if (strpos($check, 'x') !== false) { @@ -127,8 +135,9 @@ class MediaValidation extends Validation { * Checks if path is within given locations * * @param string $check Absolute path - * @param mixed $allow True or * allows any location, an array containing absolute paths to locations - * @return bool + * @param mixed $allow True or * allows any location, + * an array containing absolute paths to locations + * @return boolean */ function location($check, $allow = false) { $allow = self::_normalize($allow); @@ -160,22 +169,22 @@ class MediaValidation extends Validation { foreach ($allow as $path) { if (!Folder::isAbsolute($path) || Validation::url($path)) { - continue(1); + continue; } if ($Check->inPath($path)) { return true; } } } - return false; } /** * Checks if read/write permissions are set * - * @param string $check 4-digit octal representation of file permissions, or absolute path to a file/directory + * @param string $check 4-digit octal representation of file permissions, + * or absolute path to a file or directory * @param string $type Permission r, w or rw - * @return bool + * @return boolean */ function access($check, $type = 'r') { if (self::file($check, true) || self::folder($check, true)) { @@ -196,15 +205,16 @@ class MediaValidation extends Validation { return false; } } - return true; } /** * Checks if provided or potentially dangerous permissions are set * * @param string $check - * @param mixed $match True to check for potentially dangerous permissions, a string containing the 4-digit octal value of the permissions to check for an exact match, false to allow any permissions - * @return bool + * @param mixed $match True to check for potentially dangerous permissions, + * a string containing the 4-digit octal value of the permissions to check for an exact match, + * false to allow any permissions + * @return boolean */ function permission($check, $match = true) { $match = self::_normalize($match); @@ -221,7 +231,6 @@ class MediaValidation extends Validation { if (is_numeric($match) && $check != $match) { return false; } - return true; } /** @@ -229,8 +238,8 @@ class MediaValidation extends Validation { * Please note, that directoires are not treated as files in strict mode * * @param string $file Absolute path to file - * @param bool $strict Enable checking for actual existence of file - * @return bool + * @param boolean $strict Enable checking for actual existence of file + * @return boolean */ function file($check, $strict = true) { if (!is_string($check)) { @@ -242,7 +251,6 @@ class MediaValidation extends Validation { if (strpos($check, DS) === false) { return false; } - return true; } /** @@ -250,8 +258,8 @@ class MediaValidation extends Validation { * Used mainly for $allow/$deny parameter contents * * @param string $check Absolute path to directory - * @param bool $strict Enable checking for actual existence of directory - * @return bool + * @param boolean $strict Enable checking for actual existence of directory + * @return boolean */ function folder($check, $strict = true) { if (!is_string($check)) { @@ -260,7 +268,6 @@ class MediaValidation extends Validation { if (!is_dir($check) && $strict === true) { return false; } - return true; } /** @@ -295,13 +302,13 @@ class MediaValidation extends Validation { } } /** - * Parse php.ini style size strings + * Parse `php.ini` style size strings * - * Slightly modified version of ini_get_size() + * Slightly modified version of `ini_get_size()` * @link posted at http://www.php.net/features.file-upload * @author djcassis gmail com * - * @param string $sizeString Php.ini style size string e.g. 16M + * @param string $sizeString `php.ini` style size string e.g. `'16M'` * @return int Size in bytes */ function _toComputableSize($sizeString) { @@ -313,19 +320,18 @@ class MediaValidation extends Validation { } $sizeUnit = strtoupper(substr($sizeString, -1)); - $size = (int) substr($sizeString, 0, -1); + $size = (integer)substr($sizeString, 0, -1); switch ($sizeUnit) { - case 'Y' : $size *= 1024; // Yotta - case 'Z' : $size *= 1024; // Zetta - case 'E' : $size *= 1024; // Exa - case 'P' : $size *= 1024; // Peta - case 'T' : $size *= 1024; // Tera - case 'G' : $size *= 1024; // Giga - case 'M' : $size *= 1024; // Mega - case 'K' : $size *= 1024; // kilo + case 'Y': $size *= 1024; /* Yotta */ + case 'Z': $size *= 1024; /* Zetta */ + case 'E': $size *= 1024; /* Exa */ + case 'P': $size *= 1024; /* Peta */ + case 'T': $size *= 1024; /* Tera */ + case 'G': $size *= 1024; /* Giga */ + case 'M': $size *= 1024; /* Mega */ + case 'K': $size *= 1024; /* Kilo */ } - return $size; } } vendors/media_validation.php @@ -24,19 +24,18 @@ */ class BasicImageMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'image/jpeg', - 'image/gif', - 'image/png', - 'image/tiff', - 'image/xbm', - 'image/wbmp', - 'image/ms-bmp', - 'image/xpm', - 'image/ico', - 'image/psd', - ), - ); + 'mimeTypes' => array( + 'image/jpeg', + 'image/gif', + 'image/png', + 'image/tiff', + 'image/xbm', + 'image/wbmp', + 'image/ms-bmp', + 'image/xpm', + 'image/ico', + 'image/psd', + )); function initialize(&$Medium) { if (!isset($Medium->file)) { vendors/medium/adapter/basic_image.php @@ -23,11 +23,6 @@ * @subpackage media.libs.medium.adapter */ class BasicTextMediumAdapter extends MediumAdapter { - /** - * Enter description here... - * - * @var unknown_type - */ var $require = array('mimeTypes' => array('text/plain')); function initialize(&$Medium) { @@ -36,11 +31,7 @@ class BasicTextMediumAdapter extends MediumAdapter { } return true; } -/** - * Enter description here... - * - * @return unknown - */ + function characters(&$Medium) { return filesize($Medium->file); } vendors/medium/adapter/basic_text.php @@ -26,15 +26,15 @@ class FfmpegAudioMediumAdapter extends MediumAdapter { var $require = array( 'mimeTypes' => array( - 'audio/mpeg', - /* Ffmpeg Extension can't read meta info other than ID3! */ - 'audio/ms-wma', - 'audio/realaudio', - 'audio/wav', - 'audio/ogg', - /* Some Ogg files may have 'application/octet-stream' mime type. */ - 'application/octet-stream', - ), + 'audio/mpeg', + /* Ffmpeg Extension can't read meta info other than ID3! */ + 'audio/ms-wma', + 'audio/realaudio', + 'audio/wav', + 'audio/ogg', + /* Some Ogg files may have 'application/octet-stream' MIME type. */ + 'application/octet-stream', + ), 'extensions' => array('ffmpeg'), ); @@ -86,6 +86,5 @@ class FfmpegAudioMediumAdapter extends MediumAdapter { function bitrate(&$Medium) { return $Medium->objects['ffmpeg_movie']->getBitRate(); } - } ?> vendors/medium/adapter/ffmpeg_audio.php @@ -25,17 +25,17 @@ */ class FfmpegVideoMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'video/mpeg', - 'video/mswmv', - 'video/msasf', - 'video/msvideo', - 'video/quicktime', - 'video/flv', - 'video/ogg', - ), - 'extensions' => array('ffmpeg', 'gd'), - ); + 'mimeTypes' => array( + 'video/mpeg', + 'video/mswmv', + 'video/msasf', + 'video/msvideo', + 'video/quicktime', + 'video/flv', + 'video/ogg', + ), + 'extensions' => array('ffmpeg', 'gd'), + ); function initialize(&$Medium) { if (isset($Medium->objects['ffmpeg_movie'])) { @@ -47,12 +47,11 @@ class FfmpegVideoMediumAdapter extends MediumAdapter { } $Medium->objects['ffmpeg_movie'] = new ffmpeg_movie($Medium->file); - return true; } function convert(&$Medium, $mimeType) { - if(Medium::name(null, $mimeType) === 'Image') { + if (Medium::name(null, $mimeType) === 'Image') { $randomFrame = rand(1, $Medium->objects['ffmpeg_movie']->getFrameCount() - 1); $resource = $Medium->objects['ffmpeg_movie']->getFrame($randomFrame)->toGDImage(); vendors/medium/adapter/ffmpeg_video.php @@ -24,44 +24,49 @@ */ class GdMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array('image/gd'), /* Gets dynamically set in constructor */ - 'extensions' => array('gd'), - ); + 'mimeTypes' => array('image/gd'), /* Gets dynamically set in constructor */ + 'extensions' => array('gd'), + ); + var $_Image; + var $_formatMap = array( - 'image/jpeg' => 'jpeg', - 'image/gif' => 'gif', - 'image/png' => 'png', - 'image/gd' => 'gd', - 'image/vnd.wap.wbmp' => 'wbmp', - 'image/xbm' => 'xbm', - ); + 'image/jpeg' => 'jpeg', + 'image/gif' => 'gif', + 'image/png' => 'png', + 'image/gd' => 'gd', + 'image/vnd.wap.wbmp' => 'wbmp', + 'image/xbm' => 'xbm', + ); + var $_format; + var $_compression; + var $_pngFilter; function compatible(&$Medium) { $types = imageTypes(); - if($types & IMG_GIF) { + if ($types & IMG_GIF) { $this->require['mimeTypes'][] = 'image/gif'; } - if($types & IMG_JPG) { + if ($types & IMG_JPG) { $this->require['mimeTypes'][] = 'image/jpeg'; } - if($types & IMG_PNG) { + if ($types & IMG_PNG) { $this->require['mimeTypes'][] = 'image/png'; } - if($types & IMG_WBMP) { + if ($types & IMG_WBMP) { $this->require['mimeTypes'][] = 'image/wbmp'; } - if($types & IMG_XPM) { + if ($types & IMG_XPM) { $this->require['mimeTypes'][] = 'image/xpm'; } return parent::compatible($Medium); } function initialize(&$Medium) { - $this->_format = $this->_formatMap[$Medium->mimeType]; // could be a problem here... + $this->_format = $this->_formatMap[$Medium->mimeType]; if (isset($Medium->resources['gd'])) { return true; @@ -70,7 +75,10 @@ class GdMediumAdapter extends MediumAdapter { return false; } - $Medium->resources['gd'] = call_user_func_array('imageCreateFrom' . $this->_format, array($Medium->file)); + $Medium->resources['gd'] = call_user_func_array( + 'imageCreateFrom' . $this->_format, + array($Medium->file + )); if (!$this->_isResource($Medium->resources['gd'])) { return false; @@ -79,7 +87,6 @@ class GdMediumAdapter extends MediumAdapter { if (imageIsTrueColor($Medium->resources['gd'])) { imageSaveAlpha($Medium->resources['gd'], true); } - return true; } @@ -109,7 +116,6 @@ class GdMediumAdapter extends MediumAdapter { } break; } - return call_user_func_array('image' . $this->_format, $args); } @@ -123,12 +129,12 @@ class GdMediumAdapter extends MediumAdapter { function compress(&$Medium, $value) { switch ($Medium->mimeType) { case 'image/jpeg': - $this->_compression = intval(100 - ($value * 10)); + $this->_compression = (integer)(100 - ($value * 10)); break; case 'image/png': if (version_compare(PHP_VERSION, '5.1.2', '>=')) { - $this->_compression = intval($value); + $this->_compression = (integer)$value; } if (version_compare(PHP_VERSION, '5.1.3', '>=')) { $filter = ($value * 10) % 10; @@ -138,7 +144,7 @@ class GdMediumAdapter extends MediumAdapter { 2 => PNG_FILTER_UP, 3 => PNG_FILTER_AVG, 4 => PNG_FILTER_PAETH, - ); + ); if (array_key_exists($filter, $map)) { $this->_pngFilter = $map[$filter]; @@ -158,19 +164,33 @@ class GdMediumAdapter extends MediumAdapter { } function crop(&$Medium, $left, $top, $width, $height) { - $left = intval($left); - $top = intval($top); - $width = intval($width); - $height = intval($height); + $left = (integer)$left; + $top = (integer)$top; + $width = (integer)$width; + $height = (integer)$height; $Image = imageCreateTrueColor($width, $height); if ($this->_isTransparent($Medium->resources['gd'])) { $Image = $this->_copyTransparency($Medium->resources['gd'], $Image); - imageCopyResized($Image, $Medium->resources['gd'], 0, 0, $left, $top, $width, $height, $width, $height); + imageCopyResized( + $Image, + $Medium->resources['gd'], + 0, 0, + $left, $top, + $width, $height, + $width, $height + ); } else { imageSaveAlpha($Image, true); - imageCopyResampled($Image, $Medium->resources['gd'], 0, 0, $left, $top, $width, $height, $width, $height); + imageCopyResampled( + $Image, + $Medium->resources['gd'], + 0, 0, + $left, $top, + $width, $height, + $width, $height + ); } if ($this->_isResource($Image)) { $Medium->resources['gd'] = $Image; @@ -180,17 +200,31 @@ class GdMediumAdapter extends MediumAdapter { } function resize(&$Medium, $width, $height) { - $width = intval($width); - $height = intval($height); + $width = (integer)$width; + $height = (integer)$height; $Image = imageCreateTrueColor($width, $height); if ($this->_isTransparent($Medium->resources['gd'])) { $Image = $this->_copyTransparency($Medium->resources['gd'], $Image); - imageCopyResized($Image, $Medium->resources['gd'], 0, 0, 0, 0, $width, $height, $this->width($Medium), $this->height($Medium)); + imageCopyResized( + $Image, + $Medium->resources['gd'], + 0, 0, + 0, 0, + $width, $height, + $this->width($Medium), $this->height($Medium) + ); } else { imageSaveAlpha($Image, true); - imageCopyResampled($Image, $Medium->resources['gd'], 0, 0, 0, 0, $width, $height, $this->width($Medium), $this->height($Medium)); + imageCopyResampled( + $Image, + $Medium->resources['gd'], + 0, 0, + 0, 0, + $width, $height, + $this->width($Medium), $this->height($Medium) + ); } if ($this->_isResource($Image)) { $Medium->resources['gd'] = $Image; @@ -200,21 +234,35 @@ class GdMediumAdapter extends MediumAdapter { } function cropAndResize(&$Medium, $cropLeft, $cropTop, $cropWidth, $cropHeight, $resizeWidth, $resizeHeight) { - $cropLeft = intval($cropLeft); - $cropTop = intval($cropTop); - $cropWidth = intval($cropWidth); - $cropHeight = intval($cropHeight); - $resizeWidth = intval($resizeWidth); - $resizeHeight = intval($resizeHeight); + $cropLeft = (integer)$cropLeft; + $cropTop = (integer)$cropTop; + $cropWidth = (integer)$cropWidth; + $cropHeight = (integer)$cropHeight; + $resizeWidth = (integer)$resizeWidth; + $resizeHeight = (integer)$resizeHeight; $Image = imageCreateTrueColor($resizeWidth, $resizeHeight); if ($this->_isTransparent($Medium->resources['gd'])) { $Image = $this->_copyTransparency($Medium->resources['gd'], $Image); - imageCopyResized($Image, $Medium->resources['gd'], 0, 0, $cropLeft, $cropTop, $resizeWidth, $resizeHeight, $cropWidth, $cropHeight); + imageCopyResized( + $Image, + $Medium->resources['gd'], + 0, 0, + $cropLeft, $cropTop, + $resizeWidth, $resizeHeight, + $cropWidth, $cropHeight + ); } else { imageSaveAlpha($Image, true); - imageCopyResampled($Image, $Medium->resources['gd'], 0, 0, $cropLeft, $cropTop, $resizeWidth, $resizeHeight, $cropWidth, $cropHeight); + imageCopyResampled( + $Image, + $Medium->resources['gd'], + 0, 0, + $cropLeft, $cropTop, + $resizeWidth, $resizeHeight, + $cropWidth, $cropHeight + ); } if ($this->_isResource($Image)) { $Medium->resources['gd'] = $Image; vendors/medium/adapter/gd.php @@ -61,7 +61,7 @@ class Getid3AudioMediumAdapter extends MediumAdapter { 'audio/cda', /* * This is a reminder since audio Medium shouldn't have 'application/octet-stream' - * mime type. + * MIME type. * * LA (Lossless Audio), OptimFROG, TTA, LiteWave, * RKAU, AVR (Audio Visual Research) and some Ogg files. @@ -94,7 +94,6 @@ class Getid3AudioMediumAdapter extends MediumAdapter { getid3_lib::CopyTagsToComments($Object->info); $Medium->objects['getID3'] =& $Object; - return true; } vendors/medium/adapter/getid3_audio.php @@ -25,28 +25,27 @@ */ class Getid3VideoMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'video/matroska', - 'video/ms-wmv', - 'video/ms-asf', - 'video/ms-video', - 'video/mpeg', - 'video/quicktime', - 'video/avi', - 'video/mp4', - 'video/flv', - 'video/real-video', - 'video/vnd.rn-realvideo', - 'video/pn-realvideo', - 'video/pn-multirate-realvideo', - 'video/nsv', - /* Will not be used since video Medium can't have application/... mime type */ - 'application/shockwave-flash', - ), - 'imports' => array( - array('type' => 'Vendor', 'name'=> 'getID3', 'file' => 'getid3/getid3.php') - ), - ); + 'mimeTypes' => array( + 'video/matroska', + 'video/ms-wmv', + 'video/ms-asf', + 'video/ms-video', + 'video/mpeg', + 'video/quicktime', + 'video/avi', + 'video/mp4', + 'video/flv', + 'video/real-video', + 'video/vnd.rn-realvideo', + 'video/pn-realvideo', + 'video/pn-multirate-realvideo', + 'video/nsv', + /* Will not be used since video Medium can't have application/... MIME type */ + 'application/shockwave-flash', + ), + 'imports' => array( + array('type' => 'Vendor', 'name'=> 'getID3', 'file' => 'getid3/getid3.php') + )); function initialize(&$Medium) { if (isset($Medium->objects['getID3'])) { @@ -65,7 +64,6 @@ class Getid3VideoMediumAdapter extends MediumAdapter { } $Medium->objects['getID3'] =& $Object; - return true; } vendors/medium/adapter/getid3_video.php @@ -25,39 +25,39 @@ */ class ImagickMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( /* readable */ - 'image/jpeg', - 'image/gif', - 'image/png', - 'image/tiff', - 'image/wpg', - 'image/xbm', - 'image/xcf', - 'image/wbmp', - 'image/ms-bmp', - 'image/pcx', - 'image/quicktime', - 'image/svg', - 'image/xpm', - 'image/ico', - 'image/psd', - 'application/pdf', - ), - 'extensions' => array('imagick'), - ); + 'mimeTypes' => array( /* readable */ + 'image/jpeg', + 'image/gif', + 'image/png', + 'image/tiff', + 'image/wpg', + 'image/xbm', + 'image/xcf', + 'image/wbmp', + 'image/ms-bmp', + 'image/pcx', + 'image/quicktime', + 'image/svg', + 'image/xpm', + 'image/ico', + 'image/psd', + 'application/pdf', + ), + 'extensions' => array('imagick'), + ); var $_formatMap = array( /* writable */ - 'image/jpeg' => 'jpeg', - 'image/gif' => 'gif', - 'image/png' => 'png', - 'image/tiff' => 'tiff', - 'image/wbmp' => 'wbmp', - 'image/ms-bmp' => 'bmp', - 'image/pcx' => 'pcx', - 'image/ico' => 'ico', - 'image/xbm' => 'xbm', - 'image/psd' => 'psd', - ); + 'image/jpeg' => 'jpeg', + 'image/gif' => 'gif', + 'image/png' => 'png', + 'image/tiff' => 'tiff', + 'image/wbmp' => 'wbmp', + 'image/ms-bmp' => 'bmp', + 'image/pcx' => 'pcx', + 'image/ico' => 'ico', + 'image/xbm' => 'xbm', + 'image/psd' => 'psd', + ); function initialize(&$Medium) { if (isset($Medium->objects['Imagick'])) { @@ -73,7 +73,6 @@ class ImagickMediumAdapter extends MediumAdapter { } catch (Exception $E) { return false; } - return true; } @@ -109,7 +108,6 @@ class ImagickMediumAdapter extends MediumAdapter { if ($Medium->name === 'Document') { // application/pdf -> image return Medium::factory($Medium->objects['Imagick'], $mimeType); } - return true; } @@ -121,11 +119,11 @@ class ImagickMediumAdapter extends MediumAdapter { break; case 'image/png': $type = Imagick::COMPRESSION_ZIP; - $value = intval($value); // FIXME correct ? + $value = (integer)$value; // FIXME correct ? break; case 'image/jpeg': $type = Imagick::COMPRESSION_JPEG; - $value = intval(100 - ($value * 10)); + $value = (integer)(100 - ($value * 10)); break; default: return true; @@ -139,10 +137,10 @@ class ImagickMediumAdapter extends MediumAdapter { } function crop(&$Medium, $left, $top, $width, $height) { - $left = intval($left); - $top = intval($top); - $width = intval($width); - $height = intval($height); + $left = (integer)$left; + $top = (integer)$top; + $width = (integer)$width; + $height = (integer)$height; try { return $Medium->objects['Imagick']->cropImage($width, $height, $left, $top); @@ -152,8 +150,8 @@ class ImagickMediumAdapter extends MediumAdapter { } function resize(&$Medium, $width, $height) { - $width = intval($width); - $height = intval($height); + $width = (integer)$width; + $height = (integer)$height; try { return $Medium->objects['Imagick']->resizeImage($width, $height, Imagick::FILTER_LANCZOS, 1); vendors/medium/adapter/imagick.php @@ -25,38 +25,38 @@ */ class ImagickShellMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( /* readable */ - 'image/jpeg', - 'image/gif', - 'image/png', - 'image/tiff', - 'image/wpg', - 'image/xbm', - 'image/xcf', - 'image/wbmp', - 'image/ms-bmp', - 'image/pcx', - 'image/quicktime', - 'image/svg', - 'image/xpm', - 'image/ico', - 'image/psd', - ), - 'commands' => array('convert', 'identify'), - ); + 'mimeTypes' => array( /* readable */ + 'image/jpeg', + 'image/gif', + 'image/png', + 'image/tiff', + 'image/wpg', + 'image/xbm', + 'image/xcf', + 'image/wbmp', + 'image/ms-bmp', + 'image/pcx', + 'image/quicktime', + 'image/svg', + 'image/xpm', + 'image/ico', + 'image/psd', + ), + 'commands' => array('convert', 'identify'), + ); var $_formatMap = array( /* writable */ - 'image/jpeg' => 'jpeg', - 'image/gif' => 'gif', - 'image/png' => 'png', - 'image/tiff' => 'tiff', - 'image/wbmp' => 'wbmp', - 'image/ms-bmp' => 'bmp', - 'image/pcx' => 'pcx', - 'image/ico' => 'ico', - 'image/xbm' => 'xbm', - 'image/psd' => 'psd', - ); + 'image/jpeg' => 'jpeg', + 'image/gif' => 'gif', + 'image/png' => 'png', + 'image/tiff' => 'tiff', + 'image/wbmp' => 'wbmp', + 'image/ms-bmp' => 'bmp', + 'image/pcx' => 'pcx', + 'image/ico' => 'ico', + 'image/xbm' => 'xbm', + 'image/psd' => 'psd', + ); var $_temporaryFormat = 'png'; var $_compressionType; @@ -78,24 +78,22 @@ class ImagickShellMediumAdapter extends MediumAdapter { $Medium->files['temporary'] = TMP . uniqid('medium_'); } - return $this->_execute(':command: :source: :format:::destination:', - array( - 'command' => 'convert', - 'source' => $Medium->file, - 'destination' => $Medium->files['temporary'], - 'format' => $this->_temporaryFormat, - ) - ); + return $this->_execute(':command: :source: :format:::destination:', array( + 'command' => 'convert', + 'source' => $Medium->file, + 'destination' => $Medium->files['temporary'], + 'format' => $this->_temporaryFormat + )); } function store(&$Medium, $file) { $args = array( - 'command' => 'convert', - 'source' => $Medium->files['temporary'], - 'sourceFormat' => $this->_temporaryFormat, - 'destination' => $file, - 'format' => $this->_formatMap[$Medium->mimeType], - ); + 'command' => 'convert', + 'source' => $Medium->files['temporary'], + 'sourceFormat' => $this->_temporaryFormat, + 'destination' => $file, + 'format' => $this->_formatMap[$Medium->mimeType], + ); if (isset($this->_compressionType)) { $args['compress'] = $this->_compressionType; @@ -130,7 +128,6 @@ class ImagickShellMediumAdapter extends MediumAdapter { return Medium::factory(array('temporary' => $temporary), $mimeType); } - return true; } @@ -141,41 +138,37 @@ class ImagickShellMediumAdapter extends MediumAdapter { break; case 'image/png': $this->_compressionType = 'ZIP'; - $this->_compression = intval($value); + $this->_compression = (integer)$value; $this->_pngFilter = ($value * 10) % 10; break; case 'image/jpeg': $this->_compressionType = 'JPEG'; - $this->_compression = intval(100 - ($value * 10)); + $this->_compression = (integer)(100 - ($value * 10)); break; } return true; } function crop(&$Medium, $left, $top, $width, $height) { - return $this->_execute(':command: -crop :width:x:height:+:left:+:top: :source: :destination:', - array( - 'command' => 'convert', - 'width' => intval($width), - 'height' => intval($height), - 'left' => intval($left), - 'top' => intval($top), - 'source' => $Medium->files['temporary'], - 'destination' => $Medium->files['temporary'], - ) - ); + return $this->_execute(':command: -crop :width:x:height:+:left:+:top: :source: :destination:', array( + 'command' => 'convert', + 'width' => (integer)$width, + 'height' => (integer)$height, + 'left' => (integer)$left, + 'top' => (integer)$top, + 'source' => $Medium->files['temporary'], + 'destination' => $Medium->files['temporary'], + )); } function resize(&$Medium, $width, $height) { - return $this->_execute(':command: -geometry :width:x:height:! :source: :destination:', - array( - 'command' => 'convert', - 'width' => intval($width), - 'height' => intval($height), - 'source' => $Medium->files['temporary'], - 'destination' => $Medium->files['temporary'], - ) - ); + return $this->_execute(':command: -geometry :width:x:height:! :source: :destination:', array( + 'command' => 'convert', + 'width' => (integer)$width, + 'height' => (integer)$height, + 'source' => $Medium->files['temporary'], + 'destination' => $Medium->files['temporary'], + )); } function cropAndResize(&$Medium, $cropLeft, $cropTop, $cropWidth, $cropHeight, $resizeWidth, $resizeHeight) { @@ -200,21 +193,17 @@ class ImagickShellMediumAdapter extends MediumAdapter { } function width(&$Medium) { - return $this->_execute(':command: -format %w :file:', - array( - 'command' => 'identify', - 'file' => $Medium->files['temporary'], - ) - ); + return $this->_execute(':command: -format %w :file:', array( + 'command' => 'identify', + 'file' => $Medium->files['temporary'], + )); } function height(&$Medium) { - return $this->_execute(':command: -format %h :file:', - array( - 'command' => 'identify', - 'file' => $Medium->files['temporary'], - ) - ); + return $this->_execute(':command: -format %h :file:', array( + 'command' => 'identify', + 'file' => $Medium->files['temporary'], + )); } } ?> vendors/medium/adapter/imagick_shell.php @@ -1,4 +1,4 @@ - <?php +<?php /** * Jsmin Medium Adapter File * @@ -24,11 +24,10 @@ * @link http://code.google.com/p/jsmin-php/ */ class JsminMediumAdapter extends MediumAdapter { - var $require = array( - 'mimeTypes' => array('application/javascript'), - 'imports' => array(array('type' => 'Vendor', 'name'=> 'JSMin', 'file' => 'jsmin.php')), - ); + 'mimeTypes' => array('application/javascript'), + 'imports' => array(array('type' => 'Vendor', 'name'=> 'JSMin', 'file' => 'jsmin.php')), + ); function initialize(&$Medium) { if (isset($Medium->contents['raw'])) { @@ -38,7 +37,6 @@ class JsminMediumAdapter extends MediumAdapter { if (!isset($Medium->file)) { return false; } - return $Medium->contents['raw'] = file_get_contents($Medium->file); } vendors/medium/adapter/jsmin.php @@ -25,13 +25,10 @@ */ class PearMp3MediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'audio/mpeg' - ), - 'imports' => array( - array('type' => 'Vendor','name'=> 'MP3_Id','file' => 'MP3/Id.php') - ), - ); + 'mimeTypes' => array('audio/mpeg'), + 'imports' => array( + array('type' => 'Vendor','name'=> 'MP3_Id','file' => 'MP3/Id.php') + )); function initialize(&$Medium) { if (isset($Medium->objects['MP3_Id'])) { @@ -47,7 +44,6 @@ class PearMp3MediumAdapter extends MediumAdapter { $Object->study(); $Medium->objects['MP3_Id'] =& $Object; - return true; } vendors/medium/adapter/pear_mp3.php @@ -25,13 +25,10 @@ */ class PearOggAudioMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'audio/ogg' - ), - 'imports' => array( - array('type' => 'Vendor','name'=> 'File_Ogg','file' => 'File/Ogg.php') - ), - ); + 'mimeTypes' => array('audio/ogg'), + 'imports' => array( + array('type' => 'Vendor','name'=> 'File_Ogg','file' => 'File/Ogg.php') + )); function initialize(&$Medium) { if (isset($Medium->objects['File_Ogg_Vorbis'])) { @@ -55,7 +52,6 @@ class PearOggAudioMediumAdapter extends MediumAdapter { } $Medium->objects['File_Ogg_Vorbis'] =& $Object; - return true; } vendors/medium/adapter/pear_ogg_audio.php @@ -25,13 +25,10 @@ */ class PearOggVideoMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array( - 'video/ogg' - ), - 'imports' => array( - array('type' => 'Vendor', 'name' => 'File_Ogg', 'file' => 'File/Ogg.php') - ), - ); + 'mimeTypes' => array('video/ogg'), + 'imports' => array( + array('type' => 'Vendor', 'name' => 'File_Ogg', 'file' => 'File/Ogg.php') + )); function initialize(&$Medium) { if (isset($Medium->objects['File_Ogg_Theora'])) { @@ -55,7 +52,6 @@ class PearOggVideoMediumAdapter extends MediumAdapter { } $Medium->objects['File_Ogg_Theora'] = $Object; - return true; } vendors/medium/adapter/pear_ogg_video.php @@ -25,9 +25,10 @@ */ class PearTextMediumAdapter extends MediumAdapter { var $require = array( - 'mimeTypes' => array('text/plain'), - 'imports' => array(array('type' => 'Vendor','name' => 'Text_Statistics','file' => 'Text/Statistics.php')), - ); + 'mimeTypes' => array('text/plain'), + 'imports' => array( + array('type' => 'Vendor','name' => 'Text_Statistics','file' => 'Text/Statistics.php') + )); function initialize(&$Medium) { if (isset($Medium->objects['Text_Statistics'])) { @@ -45,7 +46,6 @@ class PearTextMediumAdapter extends MediumAdapter { } $Medium->objects['Text_Statistics'] = @new Text_Statistics($Medium->contents['raw']); - return true; } @@ -69,7 +69,7 @@ class PearTextMediumAdapter extends MediumAdapter { } function lexicalDensity() { - return round(($this->_Text->uniqWords / $this->_Text->numWords) * 100,0); + return round(($this->_Text->uniqWords / $this->_Text->numWords) * 100, 0); } } ?> \ No newline at end of file vendors/medium/adapter/pear_text.php @@ -24,93 +24,84 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class AudioMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('Getid3Audio', 'FfmpegAudio', 'PearMp3', 'PearOggAudio'); - - /** - * Artist stored in medium metadata - * - * @return mixed String if metadata info exists, else null - */ +/** + * Artist stored in medium metadata + * + * @return mixed String if metadata info exists, else null + */ function artist() { return trim($this->Adapters->dispatchMethod($this, 'artist')); } - - /** - * Title stored in medium metadata - * - * @return mixed String if metadata info exists, else null - */ +/** + * Title stored in medium metadata + * + * @return mixed String if metadata info exists, else null + */ function title() { return trim($this->Adapters->dispatchMethod($this, 'title')); } - - /** - * Album name stored in medium metadata - * - * @return mixed String if metadata info exists, else null - */ +/** + * Album name stored in medium metadata + * + * @return mixed String if metadata info exists, else null + */ function album() { return trim($this->Adapters->dispatchMethod($this, 'album')); } - - /** - * Year stored in medium metadata - * - * @return mixed Integer if metadata info exists, else null - */ +/** + * Year stored in medium metadata + * + * @return mixed Integer if metadata info exists, else null + */ function year() { return (integer)$this->Adapters->dispatchMethod($this, 'year'); } - - /** - * Track number stored in medium metadata - * - * @return mixed Integer if metadata info exists, else null - */ +/** + * Track number stored in medium metadata + * + * @return mixed Integer if metadata info exists, else null + */ function track() { return (integer)$this->Adapters->dispatchMethod($this, 'track'); } - - /** - * Duration in seconds - * - * @return integer - */ +/** + * Duration in seconds + * + * @return integer + */ function duration() { return (integer)$this->Adapters->dispatchMethod($this, 'duration'); } - - /** - * Current sampling rate of medium - * - * @url http://en.wikipedia.org/wiki/Sampling_rate - * @return integer - */ +/** + * Current sampling rate of medium + * + * @url http://en.wikipedia.org/wiki/Sampling_rate + * @return integer + */ function samplingRate() { return (integer)$this->Adapters->dispatchMethod($this, 'samplingRate'); } - - /** - * Current bitrate of medium - * - * @url http://en.wikipedia.org/wiki/Bit_rate - * @return integer - */ +/** + * Current bitrate of medium + * + * @url http://en.wikipedia.org/wiki/Bit_rate + * @return integer + */ function bitrate() { return (integer)$this->Adapters->dispatchMethod($this, 'bitrate'); } - - /** - * Determines the quality of the medium by - * taking bitrate into account - * - * @return integer A number indicating quality between 1 (worst) and 5 (best) - */ +/** + * Determines the quality of the medium by + * taking bitrate into account + * + * @return integer A number indicating quality between 1 (worst) and 5 (best) + */ function quality() { if (!$bitrate = $this->bitrate()) { return null; @@ -132,7 +123,6 @@ class AudioMedium extends Medium { * ($qualityMax - $qualityMin) + $qualityMin; } - return (integer)round($quality); } } vendors/medium/audio.php @@ -24,25 +24,25 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class CssMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('CssTidy', 'BasicText'); - /** - * Number of characters - * - * @return integer - */ +/** + * Number of characters + * + * @return integer + */ function characters() { - return $this->Adapters->dispatchMethod($this, 'characters'); + return (integer)$this->Adapters->dispatchMethod($this, 'characters'); } - /** - * Compresses contents. of the medium - * - * @return string - */ +/** + * Compresses contents. of the medium + * + * @return string + */ function compress() { return $this->Adapters->dispatchMethod($this, 'compress'); } vendors/medium/css.php @@ -24,33 +24,33 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class DocumentMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('Imagick', 'ImagickShell'); - /** - * Current width of medium - * - * @return int - */ +/** + * Current width of medium + * + * @return integer + */ function width() { - return $this->Adapters->dispatchMethod($this, 'width'); + return (integer)$this->Adapters->dispatchMethod($this, 'width'); } - /** - * Current height of medium - * - * @return int - */ +/** + * Current height of medium + * + * @return integer + */ function height() { - return $this->Adapters->dispatchMethod($this, 'height'); + return (integer)$this->Adapters->dispatchMethod($this, 'height'); } - /** - * Determines a (known) ratio of medium - * - * @return mixed if String if $known is true or float if false - */ +/** + * Determines a (known) ratio of medium + * + * @return mixed if String if $known is true or float if false + */ function ratio($known = true) { if (!$known) { return $this->width() / $this->height(); vendors/medium/document.php @@ -23,5 +23,6 @@ App::import('Vendor', 'Media.Medium'); * @package media * @subpackage media.libs.medium */ -class GenericMedium extends Medium {} +class GenericMedium extends Medium { +} ?> \ No newline at end of file vendors/medium/generic.php @@ -25,5 +25,6 @@ if (!class_exists('ImageMedium')) { * @package media * @subpackage media.libs.medium */ -class IconMedium extends ImageMedium {} +class IconMedium extends ImageMedium { +} ?> \ No newline at end of file vendors/medium/icon.php @@ -24,30 +24,30 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class ImageMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('BasicImage', 'Imagick', 'Gd', 'ImagickShell'); - /** - * Alias for fitInside - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Alias for fitInside + * + * @param integer $width + * @param integer $height + * @return boolean + */ function fit($width, $height) { return $this->fitInside($width, $height); } - /** - * Resizes medium proportionally - * keeping both sides within given dimensions - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Resizes medium proportionally + * keeping both sides within given dimensions + * + * @param integer $width + * @param integer $height + * @return boolean + */ function fitInside($width, $height) { $rx = $this->width() / $width; $ry = $this->height() / $height; @@ -61,17 +61,17 @@ class ImageMedium extends Medium { $width = $this->width() / $r; $height = $this->height() / $r; - $args = $this->_normalizeDimensions($width, $height, 'maximum'); // maximum ??? + $args = $this->_normalizeDimensions($width, $height, 'maximum'); /* maximum ?? */ return $this->Adapters->dispatchMethod($this, 'resize', $args); } - /** - * Resizes medium proportionally - * keeping smaller side within corresponding dimensions - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Resizes medium proportionally + * keeping smaller side within corresponding dimensions + * + * @param integer $width + * @param integer $height + * @return boolean + */ function fitOutside($width, $height) { $rx = $this->width() / $width; $ry = $this->height() / $height; @@ -88,35 +88,35 @@ class ImageMedium extends Medium { $args = $this->_normalizeDimensions($width, $height, 'ratio'); return $this->Adapters->dispatchMethod($this, 'resize', $args); } - /** - * Crops medium to provided dimensions - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Crops medium to provided dimensions + * + * @param integer $width + * @param integer $height + * @return boolean + */ function crop($width, $height) { list($width, $height) = $this->_normalizeDimensions($width, $height, 'maximum'); list($left, $top) = $this->_boxify($width, $height); return $this->Adapters->dispatchMethod($this, 'crop', array($left, $top, $width, $height)); } - /** - * Alias for zoomFit - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Alias for zoomFit + * + * @param integer $width + * @param integer $height + * @return boolean + */ function zoom($width, $height) { return $this->zoomFit($width, $height); } - /** - * Enlarges medium proportionally by factor 2 - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * Enlarges medium proportionally by factor 2 + * + * @param integer $width + * @param integer $height + * @return boolean + */ function zoomFit($width, $height) { $factor = 2; @@ -125,15 +125,15 @@ class ImageMedium extends Medium { return $this->fitOutside($width, $height); } - /** - * First crops an area (given by dimensions and enlarged by factor 2) - * out of the center of the medium, then resizes that cropped - * area to given dimensions - * - * @param int $width - * @param int $height - * @return bool - */ +/** + * First crops an area (given by dimensions and enlarged by factor 2) + * out of the center of the medium, then resizes that cropped + * area to given dimensions + * + * @param integer $width + * @param integer $height + * @return boolean + */ function zoomCrop($width, $height, $gravity = 'center') { $factor = 2; @@ -141,17 +141,21 @@ class ImageMedium extends Medium { list($zoomLeft, $zoomTop) = $this->_boxify($zoomWidth, $zoomHeight, $gravity); list($width, $height) = array($zoomWidth / $factor, $zoomHeight / $factor); - return $this->Adapters->dispatchMethod($this, 'cropAndResize', array($zoomLeft, $zoomTop, $zoomWidth, $zoomHeight, $width, $height)); + return $this->Adapters->dispatchMethod( + $this, + 'cropAndResize', + array($zoomLeft, $zoomTop, $zoomWidth, $zoomHeight, $width, $height) + ); } - /** - * First resizes medium so that it fills out the given dimensions, - * then cuts off overlapping parts - * - * @param int $width - * @param int $height - * @param string $align - * @return bool - */ +/** + * First resizes medium so that it fills out the given dimensions, + * then cuts off overlapping parts + * + * @param integer $width + * @param integer $height + * @param string $align + * @return boolean + */ function fitCrop($width, $height, $gravity = 'center') { $rx = $this->width() / $width; $ry = $this->height() / $height; @@ -169,45 +173,46 @@ class ImageMedium extends Medium { list($left, $top) = $this->_boxify($width, $height, $gravity); return $this->Adapters->dispatchMethod($this, 'crop', array($left, $top, $width, $height)); } - /** - * Current width of medium - * - * @return int - */ +/** + * Current width of medium + * + * @return integer + */ function width() { - return $this->Adapters->dispatchMethod($this, 'width'); + return (integer)$this->Adapters->dispatchMethod($this, 'width'); } - /** - * Current height of medium - * - * @return int - */ +/** + * Current height of medium + * + * @return integer + */ function height() { - return $this->Adapters->dispatchMethod($this, 'height'); + return (integer)$this->Adapters->dispatchMethod($this, 'height'); } - /** - * Selects compression type and filters than compresses the medium - * according to provided value - * - * Compressing may result in lossy quality for e.g. jpeg but - * not for png images. The decimal place denotes the type of filter - * used and the number as a whole the (rounded) compression value. - * - * @param float $value Zero for no compression at all or a value between 0 and 9.9999999 (highest compression); defaults to 1.5 - * @return bool - */ +/** + * Selects compression type and filters than compresses the medium + * according to provided value + * + * Compressing may result in lossy quality for e.g. jpeg but + * not for png images. The decimal place denotes the type of filter + * used and the number as a whole the (rounded) compression value. + * + * @param float $value Zero for no compression at all or a value between 0 and 9.9999999 + * (highest compression); defaults to 1.5 + * @return boolean + */ function compress($value = 1.5) { if ($value < 0 || $value >= 10) { return false; } return $this->Adapters->dispatchMethod($this, 'compress', array(floatval($value))); } - /** - * Determines the quality of the medium by - * taking amount of megapixels into account - * - * @return integer A number indicating quality between 1 (worst) and 5 (best) - */ +/** + * Determines the quality of the medium by + * taking amount of megapixels into account + * + * @return integer A number indicating quality between 1 (worst) and 5 (best) + */ function quality() { $megapixel = $this->megapixel(); @@ -227,36 +232,36 @@ class ImageMedium extends Medium { * ($qualityMax - $qualityMin) + $qualityMin; } - - return intval(round($quality)); + return (integer)round($quality); } - /** - * Determines a (known) ratio of medium - * - * @return mixed String if $known is true or float if false - */ +/** + * Determines a (known) ratio of medium + * + * @return mixed String if $known is true or float if false + */ function ratio($known = true) { if (!$known) { return $this->width() / $this->height(); } return $this->_knownRatio($this->width(), $this->height()); } - /** - * Determines megapixels of medium - * - * @return integer - */ +/** + * Determines megapixels of medium + * + * @return integer + */ function megapixel() { - return intval($this->width() * $this->height() / 1000000); + return (integer)($this->width() * $this->height() / 1000000); } - /** - * Normalizes dimensions - * - * @param int $width - * @param int $height - * @param int $set Either "ratio" or "maximum" Maximum replaces sizes execeeding limits with medium's corresponding size - * @return array An array containing width and height - */ +/** + * Normalizes dimensions + * + * @param integer $width + * @param integer $height + * @param integer $set Either "ratio" or "maximum" Maximum replaces sizes execeeding limits + * with medium's corresponding size + * @return array An array containing width and height + */ function _normalizeDimensions($width, $height, $set = 'ratio') { if ($width > $this->width()) { $width = null; @@ -287,17 +292,16 @@ class ImageMedium extends Medium { $height = $ratio * $this->height(); } } - return array($width, $height); } - /** - * Calculates a box coordinates - * - * @param int $width - * @param int $height - * @param string $align Currently "center" is supported only - * @return array An array containing left and top coordinates - */ +/** + * Calculates a box coordinates + * + * @param integer $width + * @param integer $height + * @param string $align Currently "center" is supported only + * @return array An array containing left and top coordinates + */ function _boxify($width, $height, $gravity = 'center') { if ($width > $this->width()) { $left = 0; @@ -310,7 +314,6 @@ class ImageMedium extends Medium { } else { $top = ($this->height() - $height) / 2; } - return array($left, $top); } } vendors/medium/image.php @@ -24,26 +24,26 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class JsMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ - var $adapters = array(/* 'JavascriptPacker', */ 'Jsmin', 'BasicText'); - /** - * Number of characters - * - * @return integer - */ +/** + * Compatible adapters + * + * @var array + */ + var $adapters = array('Jsmin', 'BasicText'); +/** + * Number of characters + * + * @return integer + */ function characters() { - return $this->Adapters->dispatchMethod($this, 'characters'); + return (integer)$this->Adapters->dispatchMethod($this, 'characters'); } - /** - * Compresses contents. of the medium - * - * @return string - */ - function compress() { +/** + * Compresses contents. of the medium + * + * @return string + */ + function compress() { return $this->Adapters->dispatchMethod($this, 'compress'); } } vendors/medium/js.php @@ -85,41 +85,41 @@ class Medium extends Object { */ var $mimeType; /** - * Mapping mime type (part) to medium name + * Mapping MIME type (part) to medium name * * @var array */ static $_mimeTypesToNames = array( - 'image/icon' => 'Icon', - 'application/pdf' => 'Document', - 'application/msword' => 'Document', - 'text/css' => 'Css', - 'text/javascript' => 'Js', - 'text/code' => 'Generic', - 'text/rtf' => 'Document', - 'text/plain' => 'Text', - 'image/' => 'Image', - 'audio/' => 'Audio', - 'video/' => 'Video', - 'text/' => 'Generic', - '/' => 'Generic', - ); + 'image/icon' => 'Icon', + 'application/pdf' => 'Document', + 'application/msword' => 'Document', + 'text/css' => 'Css', + 'text/javascript' => 'Js', + 'text/code' => 'Generic', + 'text/rtf' => 'Document', + 'text/plain' => 'Text', + 'image/' => 'Image', + 'audio/' => 'Audio', + 'video/' => 'Video', + 'text/' => 'Generic', + '/' => 'Generic', + ); /** * Mapping medium name to short medium name * * @var array */ static $_namesToShort = array( - 'Audio' => 'aud', - 'Css' => 'css', - 'Document' => 'doc', - 'Generic' => 'gen', - 'Icon' => 'ico', - 'Image' => 'img', - 'Js' => 'js', - 'Text' => 'txt', - 'Video' => 'vid', - ); + 'Audio' => 'aud', + 'Css' => 'css', + 'Document' => 'doc', + 'Generic' => 'gen', + 'Icon' => 'ico', + 'Image' => 'img', + 'Js' => 'js', + 'Text' => 'txt', + 'Video' => 'vid', + ); /** * Constructor * @@ -132,7 +132,8 @@ class Medium extends Object { * array of absolute paths to files * * @param mixed $file See description above - * @param string $mimeType A valid mime type, provide if autodetection fails upon $file or to save the cost for an extra MimeType::detectType call + * @param string $mimeType A valid MIME type, provide if autodetection fails upon $file + * or to save the cost for an extra MimeType::detectType call */ function __construct($file, $mimeType = null) { if (is_resource($file)) { @@ -170,8 +171,10 @@ class Medium extends Object { } /** * Destructor + * * Deletes temporary files * + * @return void */ function __destruct() { if (isset($this->files['temporary']) && file_exists($this->files['temporary'])) { @@ -183,6 +186,7 @@ class Medium extends Object { * * @param string $method * @param array $args + * @return void */ function __call($method, $args) { } @@ -205,14 +209,16 @@ class Medium extends Object { $class = $name . 'Medium'; if (!class_exists($class)) { - App::import('Vendor', 'Media.' . $class, array('file' => 'medium' . DS . strtolower($name) . '.php')); + App::import('Vendor', 'Media.' . $class, array( + 'file' => 'medium' . DS . strtolower($name) . '.php' + )); } $Object = new $class($file, $mimeType); return $Object; } /** - * Determines medium name for a file or mime type + * Determines medium name for a file or MIME type * * In the case of there are no arguments passed to this method * the values of $_mimeTypesToNames are returned @@ -238,7 +244,7 @@ class Medium extends Object { return 'Generic'; } /** - * Determines medium short name for a file or mime type + * Determines medium short name for a file or MIME type * * In the case of there are no arguments passed to this method * the values of $_nameToShort are returned @@ -281,14 +287,18 @@ class Medium extends Object { } if (!method_exists($Medium, $method)) { - trigger_error('Medium::make - Invalid instruction ' . get_class($Medium) . '::' . $method . '().', E_USER_WARNING); + $message = "Medium::make - Invalid instruction "; + $message .= "`" . get_class($Medium) . "::{$method}()`."; + trigger_error($message, E_USER_WARNING); return false; } $result = call_user_func_array(array($Medium, $method), $args); if ($result === false) { - trigger_error('Medium::make - Instruction ' . get_class($Medium) . '::' . $method . '() failed.', E_USER_WARNING); + $message = "Medium::make - Instruction "; + $message .= "`" . get_class($Medium) . "::{$method}()` failed."; + trigger_error($message, E_USER_WARNING); return false; } elseif (is_a($result, 'Medium')) { $Medium = $result; @@ -310,7 +320,8 @@ class Medium extends Object { $File->delete(); } if ($File->exists()) { - trigger_error("Medium::store - File '{$file}' already exists.", E_USER_NOTICE); + $message = "Medium::store - File `{$file}` already exists."; + trigger_error($message, E_USER_NOTICE); return false; } @@ -332,7 +343,7 @@ class Medium extends Object { * Convert * * @param string $mimeType - * @return bool|object false on error or a Medium object on success + * @return boolean|object false on error or a Medium object on success */ function convert($mimeType) { $result = $this->Adapters->dispatchMethod($this, 'convert', array($mimeType)); @@ -346,7 +357,6 @@ class Medium extends Object { if (is_a($result, 'Medium')) { return $result; } - return $this; } /** @@ -362,20 +372,20 @@ class Medium extends Object { } $knownRatios = array( - '1:1.294' => 1/1.294, - '1:1.545' => 1/1.1545, - '4:3' => 4/3, - '1.375:1' => 1.375, - '3:2' => 3/2, - '16:9' => 16/9, - '1.85:1' => 1.85, - '1.96:1' => 1.96, - '2.35:1' => 2.35, - '√2:1' => pow(2, 1/2), /* dina4 quer */ - '1:√2' => 1 / (pow(2, 1/2)), /* dina4 hoch */ - 'Φ:1' => (1 + pow(5,1/2)) / 2, /* goldener schnitt */ - '1:Φ' => 1 / ((1 + pow(5,1/2)) / 2), /* goldener schnitt */ - ); + '1:1.294' => 1/1.294, + '1:1.545' => 1/1.1545, + '4:3' => 4/3, + '1.375:1' => 1.375, + '3:2' => 3/2, + '16:9' => 16/9, + '1.85:1' => 1.85, + '1.96:1' => 1.96, + '2.35:1' => 2.35, + '√2:1' => pow(2, 1/2), /* dina4 quer */ + '1:√2' => 1 / (pow(2, 1/2)), /* dina4 hoch */ + 'Φ:1' => (1 + pow(5,1/2)) / 2, /* goldener schnitt */ + '1:Φ' => 1 / ((1 + pow(5,1/2)) / 2), /* goldener schnitt */ + ); foreach ($knownRatios as $knownRatioName => &$knownRatio) { $knownRatio = abs(($width / $height) - $knownRatio); @@ -447,8 +457,10 @@ class MediumAdapterCollection extends Object { $class = $adapter . 'MediumAdapter'; $file = 'medium' . DS . 'adapter' . DS . Inflector::underscore($adapter) . '.php'; - if (!class_exists($class) && !App::import('Vendor', 'Media.' . $class, array('file' => $file))) { - $this->__errors[] = "MediumAdapterCollection::attach() - Adapter $adapter not found!"; + if (!class_exists($class) + && !App::import('Vendor', 'Media.' . $class, array('file' => $file))) { + $message = "MediumAdapterCollection::attach() - Adapter `{$adapter}` not found!"; + $this->__errors[] = $message; return false; } @@ -465,7 +477,7 @@ class MediumAdapterCollection extends Object { $this->_attached = array_diff($this->_attached, (array)$name); $this->_initialized = array_diff($this->_initialized, (array)$name); $this->_overlay($this->_initialized); - $this->__messages[] = "MediumCollection::detach() - Removed {$name}MediumAdapter."; + $this->__messages[] = "MediumCollection::detach() - Removed `{$name}MediumAdapter`."; } /** * Calls a method of an adapter providing it @@ -480,33 +492,49 @@ class MediumAdapterCollection extends Object { if (isset($this->__methods[$method])) { list($method, $name) = $this->__methods[$method]; - $this->__messages[] = "MediumCollection::dispatchMethod() - Calling {$name}MediumAdapter::{$method}()."; + + $message = "MediumCollection::dispatchMethod() - "; + $message .= "Calling `{$name}MediumAdapter::{$method}()`."; + $this->__messages[] = $message; + return $this->{$name}->dispatchMethod($method, $params); } foreach ($this->_attached as $adapter) { - if (!method_exists($this->{$adapter}, $method)) { // optional - continue(1); + if (!method_exists($this->{$adapter}, $method)) { /* optional */ + continue; } if (!$this->_initialized($adapter)) { if ($this->_initialize($Medium, $adapter)) { - $this->__messages[] = "MediumCollection::dispatchMethod() - Initialized {$adapter}MediumAdapter."; + $message = "MediumCollection::dispatchMethod() - "; + $message .= "Initialized `{$adapter}MediumAdapter`."; + $this->__messages[] = $message; + $this->_overlay($adapter); } else { - $this->__errors[] = 'MediumCollection::dispatchMethod() - Adapter ' . $adapter . ' failed to initialize.'; + $message = "MediumCollection::dispatchMethod() - "; + $message .= "Adapter `{$adapter}` failed to initialize."; + $this->__errors[] = $message; + $this->detach($adapter); - continue(1); + continue; } } if (isset($this->__methods[$method])) { list($method, $name) = $this->__methods[$method]; - $this->__messages[] = "MediumCollection::dispatchMethod() - Calling {$adapter}MediumAdapter::{$method}()."; + + $message = "MediumCollection::dispatchMethod() - "; + $message .= "Calling `{$adapter}MediumAdapter::{$method}()`."; + $this->__messages[] = $message; + return $this->{$name}->dispatchMethod($method, $params); } } - $this->__errors[] = "MediumCollection::dispatchMethod() - Method {$method} not found in any attached adapter"; + $message = "MediumCollection::dispatchMethod() - "; + $message .= "Method `{$method}` not found in any attached adapter"; + $this->__errors[] = $message; } /** * Checks if $adapter is compatible and initializes it with $Medium @@ -525,9 +553,7 @@ class MediumAdapterCollection extends Object { if (!$this->{$adapter}->compatible($Medium) || !$this->{$adapter}->initialize($Medium)) { return false; } - $this->_initialized[] = $adapter; - return true; } /** @@ -602,18 +628,17 @@ class MediumAdapter extends Object { */ function compatible(&$Medium) { $default = array( - /* sourceFile must have one out of given mime types */ - 'mimeTypes' => array(), - /* PHP extensions which must be loaded */ - 'extensions' => array(), - /* Functions that must exist */ - 'functions' => array(), - /* Files that are required */ - 'imports' => array(), - /* System commands which must be whichable */ - 'commands' => array(), - ); - + /* sourceFile must have one out of given MIME types */ + 'mimeTypes' => array(), + /* PHP extensions which must be loaded */ + 'extensions' => array(), + /* Functions that must exist */ + 'functions' => array(), + /* Files that are required */ + 'imports' => array(), + /* System commands which must be whichable */ + 'commands' => array(), + ); $require = array_merge($default, $this->require); if (!empty($require['mimeTypes'])) { @@ -665,7 +690,9 @@ class MediumAdapter extends Object { if (!$data['command'] = $this->_which($data['command'])) { return false; } - $line = String::insert($string, $data, array('before' => ':', 'after' => ':', 'clean' => true)); + $line = String::insert($string, $data, array( + 'before' => ':', 'after' => ':', 'clean' => true + )); exec(escapeshellcmd($line) , $output, $return); return $return !== 0 ? false : (empty($output) ? true : array_pop($output)); } vendors/medium/medium.php @@ -24,78 +24,71 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class TextMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('PearText', 'BasicText'); - - /** - * Number of characters - * - * @return int - */ +/** + * Number of characters + * + * @return integer + */ function characters() { return $this->Adapters->dispatchMethod($this, 'characters'); - } - - /** - * Flesch Score - * - * @return float - */ + } +/** + * Flesch Score + * + * @return float + */ function fleschScore() { return round($this->Adapters->dispatchMethod($this, 'fleschScore'), 2); } - - /** - * Lexical Density in percent - * - * 40- 50 low (easy to read) - * 60- 70 high (hard to read) - * - * @link http://www.usingenglish.com/glossary/lexical-density-test.html - * @return int - */ +/** + * Lexical Density in percent + * + * 40- 50 low (easy to read) + * 60- 70 high (hard to read) + * + * @link http://www.usingenglish.com/glossary/lexical-density-test.html + * @return integer + */ function lexicalDensity() { return $this->Adapters->dispatchMethod($this, 'lexicalDensity'); } - - /** - * Number of sentences - * - * @return int - */ +/** + * Number of sentences + * + * @return integer + */ function sentences() { return $this->Adapters->dispatchMethod($this, 'sentences'); } - - /** - * Number of syllables - * - * @return int - */ +/** + * Number of syllables + * + * @return integer + */ function syllables() { return $this->Adapters->dispatchMethod($this, 'syllables'); } - - /** - * Truncate to given amount of characters - * - * @param int $characters - * @return string - */ +/** + * Truncate to given amount of characters + * + * @param integer $characters + * @return string + */ function truncate($characters) { return $this->Adapters->dispatchMethod($this, 'truncate', array($characters)); } - - /** - * Number of words - * - * @param bool $unique - * @return int - */ +/** + * Number of words + * + * @param boolean $unique + * @return integer + */ function words($unique = false) { return $this->Adapters->dispatchMethod($this, 'words', array($unique)); } vendors/medium/text.php @@ -24,65 +24,59 @@ App::import('Vendor', 'Media.Medium'); * @subpackage media.libs.medium */ class VideoMedium extends Medium { - /** - * Compatible adapters - * - * @var array - */ +/** + * Compatible adapters + * + * @var array + */ var $adapters = array('Getid3Video', 'FfmpegVideo', 'PearOggVideo'); - - /** - * Title stored in medium metadata - * - * @return mixed String if metadata info exists, else null - */ +/** + * Title stored in medium metadata + * + * @return mixed String if metadata info exists, else null + */ function title() { return trim($this->Adapters->dispatchMethod($this, 'title')); } - - /** - * Year stored in medium metadata - * - * @return mixed Integer if metadata info exists, else null - */ +/** + * Year stored in medium metadata + * + * @return mixed Integer if metadata info exists, else null + */ function year() { return (integer)$this->Adapters->dispatchMethod($this, 'year'); } - - /** - * Current height of medium - * - * @return integer - */ +/** + * Current height of medium + * + * @return integer + */ function height() { return (integer)$this->Adapters->dispatchMethod($this, 'height'); } - - /** - * Current width of medium - * - * @return integer - */ +/** + * Current width of medium + * + * @return integer + */ function width() { return (integer)$this->Adapters->dispatchMethod($this, 'width'); } - - /** - * Current bitrate of medium - * - * @url http://en.wikipedia.org/wiki/Bit_rate - * @return integer - */ +/** + * Current bitrate of medium + * + * @url http://en.wikipedia.org/wiki/Bit_rate + * @return integer + */ function bitrate() { return (integer)$this->Adapters->dispatchMethod($this, 'bitrate'); } - - /** - * Determines the quality of the medium by - * taking definition and bitrate into account - * - * @return integer A number indicating quality between 1 (worst) and 5 (best) - */ +/** + * Determines the quality of the medium by + * taking definition and bitrate into account + * + * @return integer A number indicating quality between 1 (worst) and 5 (best) + */ function quality() { $definition = $this->width() * $this->height(); $bitrate = $this->bitrate(); @@ -121,15 +115,13 @@ class VideoMedium extends Medium { } else { $quality = ($quality + $qualityMax * $bitrateCoef) / ($bitrateCoef + 1); } - return (integer)round($quality); } - - /** - * Determines a (known) ratio of medium - * - * @return mixed String if $known is true or float if false - */ +/** + * Determines a (known) ratio of medium + * + * @return mixed String if $known is true or float if false + */ function ratio($known = true) { $width = $this->width(); $height = $this->height(); @@ -143,6 +135,5 @@ class VideoMedium extends Medium { } return $this->_knownRatio($width, $height); } - } ?> vendors/medium/video.php @@ -20,7 +20,7 @@ uses('file'); /** * Mime Glob Class * - * Detection of a file's MIME Type by it's extension + * Detection of a file's MIME type by it's extension * supporting several database formats. * * @package media @@ -37,8 +37,8 @@ class MimeGlob extends Object { /** * Constructor * - * @param mixed $file - * @access private + * @param mixed $db + * @access public */ function __construct($db) { $this->__read($db); @@ -47,7 +47,6 @@ class MimeGlob extends Object { * Determine the format of given database * * @param mixed $db - * @static */ function format($db) { if (empty($db)) { @@ -78,12 +77,12 @@ class MimeGlob extends Object { return null; } /** - * Analyzes a filename and determines the mime type + * Analyzes a filename and determines the MIME type * - * @param string $file Path to a file, basename of a file or in reverse mode a mime type - * @param array $options An array holding options - * @return mixed A string containing the mime type of the file or false if mime type - * could not be determined, in reverse mode the pattern corresponding to the given mime type + * @param string $file Path to a file, basename of a file or in reverse mode a MIME type + * @param boolean $reverse Enable/disable reverse searching + * @return mixed A string containing the MIME type of the file or false if MIME type + * could not be determined, in reverse mode the pattern corresponding to the given MIME type * @access public */ function analyze($file, $reverse = false) { @@ -132,24 +131,24 @@ class MimeGlob extends Object { $line = trim(fgets($File->handle)); if (empty($line) || $line{0} === '#') { - continue(1); + continue; } $line = explode(':', $line); - if(count($line) > 2) { + if (count($line) > 2) { $priority = array_shift($line); } else { $priority = null; } if (!preg_match('/(\*\.)?[a-zA-Z0-9\.]+$|/', $line[1])) { - continue(1); + continue; } $this->register(array( - 'mime_type' => array_shift($line), - 'pattern' => str_replace('*.', null, array_shift($line)), - 'priority' => $priority - )); + 'mime_type' => array_shift($line), + 'pattern' => str_replace('*.', null, array_shift($line)), + 'priority' => $priority + )); } } elseif ($format === 'Apache Module mod_mime') { $File = new File($db); @@ -159,7 +158,7 @@ class MimeGlob extends Object { $line = trim(fgets($File->handle)); if (empty($line) || $line{0} === '#') { - continue(1); + continue; } $line = preg_split('/\s+/', $line); @@ -184,8 +183,6 @@ class MimeGlob extends Object { * ) * * @param array $item A valid glob item - * @param integer $priority A value between 0 and 100. - * Low numbers should be used for more generic types and higher values for specific subtypes. * @return boolean True if item has successfully been registered, false if not * @access public */ @@ -193,9 +190,9 @@ class MimeGlob extends Object { foreach ((array)$item['pattern'] as $pattern) { if (isset($this->_items[$pattern])) { $this->_items[$pattern] = array_unique(array_merge( - $this->_items[$pattern], - array($item['mime_type']) - )); + $this->_items[$pattern], + array($item['mime_type']) + )); } else { $this->_items[$pattern] = array($item['mime_type']); } @@ -226,7 +223,7 @@ class MimeGlob extends Object { * @param string $name The basename of a file * @param array $items * @param boolean $caseSensitive - * @return array Matched mime types keyed by patterns + * @return array Matched MIME types keyed by patterns * @access private */ function __test($name, $items, $caseSensitive = true) { vendors/mime_glob.php @@ -20,8 +20,8 @@ uses('file'); /** * Mime Magic Class * - * Detection of a file's MIME Type by it's contents. - * An implementation of the mime magic functionality in pure PHP + * Detection of a file's MIME type by it's contents. + * An implementation of the MIME magic functionality in pure PHP * supporting several database formats. * * @package media @@ -38,18 +38,19 @@ class MimeMagic extends Object { /** * Constructor * - * @param mixed $file - * @access private + * @param mixed $db + * @access public */ function __construct($db) { $this->__read($db); } /** - * Analyzes a files contents and determines the file's mime type + * Analyzes a files contents and determines the file's MIME type * * @param string $file An absolute path to a file * @param array $options An array holding options - * @return mixed A string containing the mime type of the file or false if mime type could not be determined + * @return mixed A string containing the MIME type of the file + * or false if MIME type could not be determined * @access public */ function analyze($file, $options = array()) { @@ -61,18 +62,16 @@ class MimeMagic extends Object { foreach ($this->_items as $priority => $items) { if ($priority < $minPriority || $priority > $maxPriority) { - continue(1); + continue; } $filtered = array_merge($filtered, $items); } - return $this->__test($file, $filtered); } /** * Determine the format of given database * * @param mixed $db - * @static */ function format($db) { if (empty($db)) { @@ -110,14 +109,16 @@ class MimeMagic extends Object { * * @param array $item A valid magic item * @param integer $indent The nesting depth of the item - * @param integer $priority A value between 0 and 100. Low numbers should be used for more generic types and higher values for specific subtypes. + * @param integer $priority A value between 0 and 100. + * Low numbers should be used for more generic types and higher values for specific subtypes. * @return boolean True if item has successfully been registered, false if not * @access public */ function register($item, $indent = 0, $priority = 50) { static $keys = array(); - if (!is_array($item) || !isset($item['offset'], $item['value'], $item['range_length'], $item['value_length'])) { + if (!is_array($item) + || !isset($item['offset'], $item['value'], $item['range_length'], $item['value_length'])) { return false; } @@ -174,7 +175,8 @@ class MimeMagic extends Object { * - Apache Module mod_mime_magic * - PHP file containing variables formatted like: $data[0] = array(item, item, item, ...) * - * @param mixed $file An absolute path to a magic file in apache, freedesktop or a filename (without .php) of a file in the configs/ dir in CakePHP format + * @param mixed $file An absolute path to a magic file in apache, freedesktop + * or a filename (without .php) of a file in the configs/ dir in CakePHP format * @return mixed A format string or null if format could not be determined * @access private * @link http://httpd.apache.org/docs/2.2/en/mod/mod_mime_magic.html @@ -209,27 +211,29 @@ class MimeMagic extends Object { $chars = array(0 => $chars[1], 1 => null); } - while (!feof($File->handle) && !($chars[0] === "\n" && (ctype_digit($chars[1]) || $chars[1] === '>' || $chars[1] === '['))) { + while (!feof($File->handle) && !($chars[0] === "\n" + && (ctype_digit($chars[1]) || $chars[1] === '>' || $chars[1] === '['))) { $line .= $chars[0]; $chars = array(0 => $chars[1], 1 => $File->read(1)); } if (preg_match('/' . $sectionRegex . '/', $line, $matches)) { $section = array( - 'priority' => $matches[1], - 'mime_type' => $matches[2] - ); + 'priority' => $matches[1], + 'mime_type' => $matches[2] + ); } elseif (preg_match('/' . $itemRegex . '/', $line, $matches)) { $indent = empty($matches[1]) ? 0 : intval($matches[1]); $wordSize = empty($matches[6]) ? 1 : intval($matches[6]); $item = array( - 'offset' => intval($matches[2]), - 'value_length' => current(unpack('n', $matches[3])), - 'value' => $this->__formatValue($matches[4], $wordSize), - 'mask' => empty($matches[5]) ? null : $this->__formatValue($matches[5], $wordSize),// default: all "one" bits - 'range_length' => empty($matches[7]) ? 1 : intval($matches[7]), - 'mime_type' => $section['mime_type'], - ); + 'offset' => intval($matches[2]), + 'value_length' => current(unpack('n', $matches[3])), + 'value' => $this->__formatValue($matches[4], $wordSize), + /* default: all `one` bits */ + 'mask' => empty($matches[5]) ? null : $this->__formatValue($matches[5], $wordSize), + 'range_length' => empty($matches[7]) ? 1 : intval($matches[7]), + 'mime_type' => $section['mime_type'], + ); $this->register($item, $indent, $section['priority']); } } @@ -243,23 +247,23 @@ class MimeMagic extends Object { $line = trim(fgets($File->handle)); if (empty($line) || $line{0} === '#') { - continue(1); + continue; } $line = preg_replace('/(?!\B)\040+/', "\t", $line); if (!preg_match('/' . $itemRegex . '/', $line, $matches)) { - continue(1); + continue; } $item = array( - 'offset' => intval($matches[2]), - 'value' => $this->__formatValue($matches[4], $matches[3], true), - 'mask' => null, - 'range_length' => 0, - 'mime_type' => empty($matches[5]) ? null : $matches[5], - 'encoding' => empty($matches[6]) ? null : $matches[6], - ); + 'offset' => intval($matches[2]), + 'value' => $this->__formatValue($matches[4], $matches[3], true), + 'mask' => null, + 'range_length' => 0, + 'mime_type' => empty($matches[5]) ? null : $matches[5], + 'encoding' => empty($matches[6]) ? null : $matches[6], + ); $item['value_length'] = strlen($item['value']); $this->register($item, strlen($matches[1]), 80); } @@ -272,7 +276,7 @@ class MimeMagic extends Object { * * @param string $file Absolute path to a file * @param array $items - * @return mixed A string containing the mime type of the file or false if no pattern matched + * @return mixed A string containing the MIME type of the file or false if no pattern matched * @access private */ function __test($file, $items) { @@ -296,7 +300,7 @@ class MimeMagic extends Object { * * @param object $File An instance of the File class * @param array $item A magic item - * @return mixed A string containing the mime type of the file or false if no pattern matched + * @return mixed A string containing the MIME type of the file or false if no pattern matched * @access private */ function __testRecursive(&$File, $item) { @@ -323,7 +327,8 @@ class MimeMagic extends Object { * Format a value for testing * * @param mixed $value Value to format - * @param mixed $type String containing the datatype of the value or an integer indicating the word size of the value + * @param mixed $type String containing the datatype of the value + * or an integer indicating the word size of the value * @param boolean $binary Whether the value is a binary value or not * @param boolean $unEscape If set to true and value is not binary strips slashes from string values * @return mixed On success the formatted binary value or the input value @@ -366,7 +371,10 @@ class MimeMagic extends Object { return pack('d', $value); case 'string': if ($unEscape) { - $value = strtr($value, array('\ ' => ' ', '\<' => '<', '\>' => '>', '\\\r' => '\r', '\\\n' => '\n')); + $value = strtr($value, array( + '\ ' => ' ', '\<' => '<', '\>' => '>', + '\\\r' => '\r', '\\\n' => '\n' + )); } return preg_replace('/\\\\([0-9]{1,3})/e', 'chr($1);', $value); case 'beshort': vendors/mime_magic.php @@ -20,8 +20,8 @@ uses('file'); /** * Mime Type Class * - * Detection of a file's MIME Type by it's contents and/or extension. - * This is the main interface for MIME Type detection wrapping + * Detection of a file's MIME type by it's contents and/or extension. + * This is the main interface for MIME type detection wrapping * (native) magic and glob mechanisms. * * @package media @@ -32,14 +32,14 @@ class MimeType extends Object { * Magic * * @var mixed An instance of the MimeMagic or finfo class or a string containing 'mime_magic' - * @access public + * @access private */ var $__magic; /** * Glob * * @var object An instance of the MimeGlob class - * @access public + * @access private */ var $__glob; /** @@ -62,7 +62,8 @@ class MimeType extends Object { * Change configuration during runtime * * @param string $property Either "magic" or "glob" - * @param array $config Config specifying engine and db e.g. array('engine' => 'fileinfo', 'db' => '/etc/magic') + * @param array $config Config specifying engine and db + * e.g. array('engine' => 'fileinfo', 'db' => '/etc/magic') */ function config($property = 'magic', $config = array()) { $_this =& MimeType::getInstance(); @@ -74,22 +75,23 @@ class MimeType extends Object { } } /** - * Guesses the extension (suffix) for an existing file or a mime type + * Guesses the extension (suffix) for an existing file or a MIME type * - * @param string $mimetype A mime type or an absolute path to file + * @param string $file A MIME type or an absolute path to file * @param array $options Currently not used - * @return mixed A string with the first matching extension (w/o leading dot), false if nothing matched + * @return mixed A string with the first matching extension (w/o leading dot), + * false if nothing matched * @access public */ function guessExtension($file, $options = array()) { $_this =& MimeType::getInstance(); $globMatch = array(); $preferred = array( - 'bz2', 'css', 'doc', 'html', 'jpg', - 'mpeg', 'mp3', 'ogg', 'php', 'ps', - 'rm', 'ra', 'rv', 'swf', 'tar', - 'tiff', 'txt', 'xhtml', 'xml', - ); + 'bz2', 'css', 'doc', 'html', 'jpg', + 'mpeg', 'mp3', 'ogg', 'php', 'ps', + 'rm', 'ra', 'rv', 'swf', 'tar', + 'tiff', 'txt', 'xhtml', 'xml', + ); if (is_file($file)) { $mimeType = $_this->guessType($file); @@ -110,11 +112,10 @@ class MimeType extends Object { if (count($preferMatch) === 1) { return array_shift($preferMatch); } - return null; } /** - * Guesses the mime type of the file + * Guesses the MIME type of the file * * Empty results are currently not handled: * application/x-empty @@ -122,11 +123,11 @@ class MimeType extends Object { * * @param string $file * @param options $options Valid options are: - * - "paranoid" If set to true only then content for the file is used for detection - * - "simplify" If set to true resulting mime type will be simplified - * - "properties" Used for simplification, defaults to false - * - "experimental" Used for simplification, defaults to false - * @return mixed string with mime type on success + * - `'paranoid'` If set to true only then content for the file is used for detection + * - `'simplify'` If set to true resulting MIME type will be simplified + * - `'properties'` Used for simplification, defaults to false + * - `'experimental'` Used for simplification, defaults to false + * @return mixed string with MIME type on success * @access public */ function guessType($file, $options = array()) { @@ -136,12 +137,11 @@ class MimeType extends Object { $options = array('simplify' => $options); } $default = array( - 'paranoid' => false, - 'simplify' => false, - 'properties' => false, - 'experimental' => false, - ); - + 'paranoid' => false, + 'simplify' => false, + 'properties' => false, + 'experimental' => false, + ); extract(array_merge($default, $options), EXTR_SKIP); $magicMatch = $globMatch = array(); @@ -149,7 +149,6 @@ class MimeType extends Object { if (is_a($_this->__glob, 'MimeGlob')) { $globMatch = $_this->__glob->analyze($file); } - if (count($globMatch) === 1) { return MimeType::simplify(array_shift($globMatch), $properties, $experimental); } @@ -191,7 +190,7 @@ class MimeType extends Object { return null; } /** - * Simplifies a mime type string + * Simplifies a MIME type string * * @param string $mimeType * @param boolean If true removes properties @@ -215,7 +214,7 @@ class MimeType extends Object { /** * Sets magic property * - * @param array Configuration settings to take into account + * @param array $config Configuration settings to take into account * @return void */ function __loadMagic($config = array()) { @@ -257,7 +256,7 @@ class MimeType extends Object { /** * Sets glob property * - * @param array Configuration settings to take into account + * @param array $config Configuration settings to take into account * @return void */ function __loadGlob($config = array()) { @@ -299,10 +298,9 @@ class MimeType extends Object { $searchPaths = array( 'mime_' . $type . '.php' => array(CONFIGS), 'mime_' . $type . '.db' => array_merge( - Configure::read('vendorPaths'), - array(dirname(__FILE__) . DS) - ), - ); + Configure::read('vendorPaths'), + array(dirname(__FILE__) . DS) + )); foreach ($searchPaths as $basename => $paths) { foreach ($paths as $path) { vendors/mime_type.php @@ -26,8 +26,26 @@ Configure::write('Cache.disable', true); * @subpackage media.shells */ class MediaShell extends Shell { +/** + * Tasks + * + * @var string + * @access public + */ var $tasks = array('Sync', 'Make', 'Collect'); +/** + * Verbose mode + * + * @var boolean + * @access public + */ var $verbose = false; +/** + * Quiet mode + * + * @var boolean + * @access public + */ var $quiet = false; /** * Width of shell in number of characters per line @@ -36,18 +54,18 @@ class MediaShell extends Shell { */ var $width = 80; /** - * startup + * Startup * * @access public * @return void */ - function startup() { + function startup() { $this->verbose = isset($this->params['verbose']); $this->quiet = isset($this->params['quiet']); parent::startup(); } /** - * _welcome + * Welcome * * @access protected * @return void @@ -59,12 +77,12 @@ class MediaShell extends Shell { $this->hr(); } /** - * main + * Main * * @access public * @return void */ - function main() { + function main() { $this->out('[I]nitialize Media Directory'); $this->out('[P]rotect Transfer Directory'); $this->out('[S]ynchronize'); @@ -120,7 +138,7 @@ class MediaShell extends Shell { MEDIA_STATIC => Medium::short(), MEDIA_TRANSFER => Medium::short(), MEDIA_FILTER => Medium::short(), - ); + ); foreach ($dirs as $dir => $subDirs) { if (is_dir($dir)) { @@ -386,7 +404,7 @@ class MediaShell extends Shell { /** * Overridden to allow Stop messages * - * @param int $status + * @param integer $status * @access protected * @return void */ vendors/shells/media.php @@ -86,11 +86,11 @@ class CollectTask extends MediaShell { foreach ($this->_map as $old => $new) { $message = sprintf( - '%-38s %s %38s', - $this->shortPath($old), - $this->_link ? '<-' : '->', - $this->shortPath($new) - ); + '%-38s %s %38s', + $this->shortPath($old), + $this->_link ? '<-' : '->', + $this->shortPath($new) + ); $this->out($message); } @@ -124,10 +124,10 @@ class CollectTask extends MediaShell { } $paths = array_merge( - Configure::read('vendorPaths'), - array(WWW_ROOT), - $pluginVendorPaths - ); + Configure::read('vendorPaths'), + array(WWW_ROOT), + $pluginVendorPaths + ); foreach ($paths as $key => $path) { $message = sprintf('Would you like to collect files from %s?', $this->shortPath($path)); vendors/shells/tasks/collect.php @@ -170,9 +170,11 @@ class SyncTask extends MediaShell { list($this->__fsMap, $this->__dbMap) = $this->_generateMaps(); foreach ($this->__dbMap as $dbItem) { - $message = sprintf('%-60s -> %s/%s', - $this->shortPath($dbItem['file']), - $this->_Model->name, $dbItem['id']); + $message = sprintf( + '%-60s -> %s/%s', + $this->shortPath($dbItem['file']), + $this->_Model->name, $dbItem['id'] + ); $this->out(); $this->out($message); @@ -209,9 +211,12 @@ class SyncTask extends MediaShell { list($this->__fsMap, $this->__dbMap) = $this->_generateMaps(); foreach ($this->__fsMap as $fsItem) { - $message = sprintf('%-60s <- %s/%s', - $this->shortPath($fsItem['file']), - $this->_Model->name, '?'); + $message = sprintf( + '%-60s <- %s/%s', + $this->shortPath($fsItem['file']), + $this->_Model->name, + '?' + ); $this->out(); $this->out($message); @@ -253,7 +258,6 @@ class SyncTask extends MediaShell { if ($this->_fixWithAlternative()) { return true; } - if ($this->_fixDeleteRecord()) { return true; } @@ -278,9 +282,9 @@ class SyncTask extends MediaShell { if ($input == 'y') { $data = array( - 'id' => $this->__dbItem['id'], - 'checksum' => $this->__File->md5(), - ); + 'id' => $this->__dbItem['id'], + 'checksum' => $this->__File->md5(), + ); $this->_Model->save($data); $this->out('Corrected checksum'); return true; @@ -323,8 +327,10 @@ class SyncTask extends MediaShell { if (!$this->__alternativeFile) { return false; } - $message = sprintf('This file has an identical checksum: %s', - $this->shortPath($this->__alternativeFile)); + $message = sprintf( + 'This file has an identical checksum: %s', + $this->shortPath($this->__alternativeFile) + ); $this->out($message); $input = $this->in('Select this file and update record?', 'y,n', $this->_answer); @@ -333,10 +339,10 @@ class SyncTask extends MediaShell { } $data = array( - 'id' => $this->__dbItem['id'], - 'dirname' => dirname(str_replace($this->_baseDirectory, '', $this->__alternativeFile)), - 'basename' => basename($this->__alternativeFile), - ); + 'id' => $this->__dbItem['id'], + 'dirname' => dirname(str_replace($this->_baseDirectory, '', $this->__alternativeFile)), + 'basename' => basename($this->__alternativeFile), + ); $this->_Model->save($data); $this->out('Corrected dirname and basename'); return true; vendors/shells/tasks/sync.php @@ -29,7 +29,7 @@ class TransferValidation extends MediaValidation { * Checks if subject is transferable * * @param mixed $check Path to file in local FS, URL or file-upload array - * @return bool + * @return boolean */ function resource($check) { if (TransferValidation::fileUpload($check) @@ -38,41 +38,36 @@ class TransferValidation extends MediaValidation { || TransferValidation::url($check)) { return !TransferValidation::blank($check); } - return false; } /** * Checks if resource is not blank or empty * * @param mixed $check Array or string - * @return bool + * @return boolean */ function blank($check) { if (empty($check)) { return true; } - if (TransferValidation::fileUpload($check) && $check['error'] == UPLOAD_ERR_NO_FILE) { return true; } - if (is_string($check) && Validation::blank($check)) { return true; } - return false; } /** * Identifies a file upload array * * @param mixed $check - * @return bool + * @return boolean */ function fileUpload($check) { if (!is_array($check)) { return false; } - if (!array_key_exists('name',$check) || !array_key_exists('type',$check) || !array_key_exists('tmp_name',$check) @@ -80,7 +75,6 @@ class TransferValidation extends MediaValidation { || !array_key_exists('size',$check)) { return false; } - return true; } /** vendors/transfer_validation.php @@ -2,7 +2,7 @@ /** * Attachments Element File * - * Element listing associated Attachments of the View's Model + * Element listing associated attachments of the view's model * Add, delete (detach) an Attachment * * Copyright (c) 2007-2009 David Persson views/elements/attachments.ctp @@ -37,42 +37,40 @@ class MediumHelper extends AppHelper { * @var array */ var $tags = array( - 'object' => '<object%s>%s%s</object>', - 'param' => '<param%s/>', - 'csslink' => '<link type="text/css" rel="stylesheet" href="%s" %s/>', - 'javascriptlink' => '<script type="text/javascript" src="%s"></script>', - 'rsslink' => '<link type="application/rss+xml" rel="alternate" href="%s" title="%s"/>', // v2 - ); + 'object' => '<object%s>%s%s</object>', + 'param' => '<param%s/>', + 'csslink' => '<link type="text/css" rel="stylesheet" href="%s" %s/>', + 'javascriptlink' => '<script type="text/javascript" src="%s"></script>', + 'rsslink' => '<link type="application/rss+xml" rel="alternate" href="%s" title="%s"/>', /* v2 */ + ); /** * Configuration settings for this helper * * @var array */ var $settings = array( - 'map' => array( - 'static' => array(MEDIA_STATIC => MEDIA_STATIC_URL), - 'transfer' => array(MEDIA_TRANSFER => MEDIA_TRANSFER_URL), - 'filter' => array(MEDIA_FILTER => MEDIA_FILTER_URL) - ), - 'directories' => array( - ), - 'urls' => array( - ), - 'versions' => array('xxs', 'xs', 's', 'm', 'l', 'xl', 'xxl', 'c'), - 'extensions' => array( - 'aud' => array('mp3', 'ogg', 'aif', 'wma', 'wav'), - 'css' => array('css'), - 'doc' => array('odt', 'rtf', 'pdf', 'doc', 'png', 'jpg', 'jpeg'), - 'gen' => array(), - 'ico' => array('ico', 'png', 'gif', 'jpg', 'jpeg'), - 'img' => array('png', 'jpg', 'jpeg' , 'gif'), - 'js' => array('js'), - 'txt' => array('txt'), - 'vid' => array('avi', 'mpg', 'qt', 'mov', 'ogg', 'wmv', - 'png', 'jpg', 'jpeg', 'gif', 'mp3', 'ogg', - 'aif', 'wma', 'wav'), - ) - ); + 'map' => array( + 'static' => array(MEDIA_STATIC => MEDIA_STATIC_URL), + 'transfer' => array(MEDIA_TRANSFER => MEDIA_TRANSFER_URL), + 'filter' => array(MEDIA_FILTER => MEDIA_FILTER_URL) + ), + 'directories' => array( ), + 'urls' => array(), + 'versions' => array('xxs', 'xs', 's', 'm', 'l', 'xl', 'xxl', 'c'), + 'extensions' => array( + 'aud' => array('mp3', 'ogg', 'aif', 'wma', 'wav'), + 'css' => array('css'), + 'doc' => array('odt', 'rtf', 'pdf', 'doc', 'png', 'jpg', 'jpeg'), + 'gen' => array(), + 'ico' => array('ico', 'png', 'gif', 'jpg', 'jpeg'), + 'img' => array('png', 'jpg', 'jpeg' , 'gif'), + 'js' => array('js'), + 'txt' => array('txt'), + 'vid' => array( + 'avi', 'mpg', 'qt', 'mov', 'ogg', 'wmv', + 'png', 'jpg', 'jpeg', 'gif', 'mp3', 'ogg', + 'aif', 'wma', 'wav' + ))); /** * Holds cached paths * @@ -83,6 +81,9 @@ class MediumHelper extends AppHelper { * Constructor * * Sets up cache and merges user supplied settings with default settings + * + * @param array $settings + * @return void */ function __construct($settings = array()) { $this->settings = array_merge($this->settings, $settings); @@ -99,6 +100,8 @@ class MediumHelper extends AppHelper { * Destructor * * Updates cache + * + * @return void */ function __destruct() { Cache::write('media_found', $this->__cached, '_cake_core_'); @@ -107,7 +110,7 @@ class MediumHelper extends AppHelper { * Output filtering * * @param string $content - * @param bool $inline True to return content, false to add content to scripts_for_layout + * @param boolean $inline True to return content, false to add content to `scripts_for_layout` * @return mixed String if inline is true or null */ function output($content, $inline = true) { @@ -119,28 +122,30 @@ class MediumHelper extends AppHelper { $View->addScript($content); } /** - * Turns a file into a (routed) url string + * Turns a file path into a (routed) URL * * Reimplemented method from Helper * - * @param string $file Absolut path or relative (to MEDIA) path to file - * @param array $options For future usage - * @return arrays + * @param string $path Absolute or partial path to a file + * @param boolean $full + * @return string */ - function url($url = null, $full = false) { - if (is_array($url) || strpos($url, '://') !== false) { - return parent::url($url, $full); + function url($path = null, $full = false) { + if (is_array($path) || strpos($path, '://') !== false) { + return parent::url($path, $full); } - if (!$url = $this->webroot($url)) { + if (!$path = $this->webroot($path)) { return null; } - return $full ? FULL_BASE_URL . $url : $url; + return $full ? FULL_BASE_URL . $path : $path; } /** - * Enter description here... + * Webroot + * + * Reimplemented method from Helper * - * @param unknown_type $path - * @return unknown + * @param string $path Absolute or partial path to a file + * @return mixed */ function webroot($path) { if (!$file = $this->file($path)) { @@ -162,19 +167,18 @@ class MediumHelper extends AppHelper { return $this->webroot . str_replace(DS, '/', $path); } /** - * Display a file inline + * Generates markup to render a file inline * - * @param string $file + * @param string $path Absolute or partial path to a file * @param array $options restrict: embed to display certain medium types only * @return string - * */ function embed($path, $options = array()) { $default = array( 'restrict' => array(), 'background' => '#000000', - 'autoplay' => false, // also: autostart - 'controls' => false, // also: controller + 'autoplay' => false, /* aka `autostart` */ + 'controls' => false, /* aka `controller` */ 'branding' => false, 'alt' => null, 'width' => null, @@ -237,166 +241,168 @@ class MediumHelper extends AppHelper { case 'image/jpeg': case 'image/png': $attributes = array_merge($attributes, array( - 'alt' => $alt, - 'width' => $width, - 'height' => $height, - )); + 'alt' => $alt, + 'width' => $width, + 'height' => $height, + )); if (strpos($path, 'ico/') !== false) { $attributes = $this->addClass($attributes, 'icon'); } - return sprintf($this->Html->tags['image'], $url, $this->_parseAttributes($attributes)); - + return sprintf( + $this->Html->tags['image'], + $url, + $this->_parseAttributes($attributes) + ); /* Windows Media */ - case 'video/x-ms-wmv': // official + case 'video/x-ms-wmv': /* official */ case 'video/x-ms-asx': case 'video/x-msvideo': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - 'classid' => 'clsid:6BF52A52-394A-11d3-B153-00C04F79FAA6', - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + 'classid' => 'clsid:6BF52A52-394A-11d3-B153-00C04F79FAA6', + )); $parameters = array( - 'src' => $url, - 'autostart' => $autoplay, - 'controller' => $controls, - 'pluginspage' => 'http://www.microsoft.com/Windows/MediaPlayer/', - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'autostart' => $autoplay, + 'controller' => $controls, + 'pluginspage' => 'http://www.microsoft.com/Windows/MediaPlayer/', + ); + break; /* RealVideo */ case 'application/vnd.rn-realmedia': case 'video/vnd.rn-realvideo': case 'audio/vnd.rn-realaudio': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - 'classid' => 'clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA', - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + 'classid' => 'clsid:CFCDAA03-8BE4-11cf-B84B-0020AFBBCCFA', + )); $parameters = array( - 'src' => $url, - 'autostart' => $autoplay, - 'controls' => isset($controls) ? 'ControlPanel' : null, - 'console' => 'video' . uniqid(), - 'loop' => $loop, - 'bgcolor' => $background, - 'nologo' => $branding ? false : true, - 'nojava' => true, - 'center' => true, - 'backgroundcolor' => $background, - 'pluginspage' => 'http://www.real.com/player/', - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'autostart' => $autoplay, + 'controls' => isset($controls) ? 'ControlPanel' : null, + 'console' => 'video' . uniqid(), + 'loop' => $loop, + 'bgcolor' => $background, + 'nologo' => $branding ? false : true, + 'nojava' => true, + 'center' => true, + 'backgroundcolor' => $background, + 'pluginspage' => 'http://www.real.com/player/', + ); + break; /* QuickTime */ case 'video/quicktime': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - 'classid' => 'clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B', - 'codebase' => 'http://www.apple.com/qtactivex/qtplugin.cab', - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + 'classid' => 'clsid:02BF25D5-8C17-4B23-BC80-D3488ABDDC6B', + 'codebase' => 'http://www.apple.com/qtactivex/qtplugin.cab', + )); $parameters = array( - 'src' => $url, - 'autoplay' => $autoplay, - 'controller' => $controls, - 'bgcolor' => substr($background, 1), - 'showlogo' => $branding, - 'pluginspage' => 'http://www.apple.com/quicktime/download/', - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'autoplay' => $autoplay, + 'controller' => $controls, + 'bgcolor' => substr($background, 1), + 'showlogo' => $branding, + 'pluginspage' => 'http://www.apple.com/quicktime/download/', + ); + break; /* Mpeg */ case 'video/mpeg': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + )); $parameters = array( - 'src' => $url, - 'autostart' => $autoplay, - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'autostart' => $autoplay, + ); + break; /* Flashy Flash */ case 'application/x-shockwave-flash': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - 'classid' => 'clsid:D27CDB6E-AE6D-11cf-96B8-444553540000', - 'codebase' => 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab', - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + 'classid' => 'clsid:D27CDB6E-AE6D-11cf-96B8-444553540000', + 'codebase' => 'http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab', + )); $parameters = array( - 'movie' => $url, - 'wmode' => 'transparent', - 'bgcolor' => $background, - 'FlashVars' => 'playerMode=embedded', - 'quality' => 'best', - 'scale' => 'noScale', - 'salign' => 'TL', - 'pluginspage' => 'http://www.adobe.com/go/getflashplayer', - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'movie' => $url, + 'wmode' => 'transparent', + 'bgcolor' => $background, + 'FlashVars' => 'playerMode=embedded', + 'quality' => 'best', + 'scale' => 'noScale', + 'salign' => 'TL', + 'pluginspage' => 'http://www.adobe.com/go/getflashplayer', + ); + break; case 'application/pdf': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + )); $parameters = array( - 'src' => $url, - 'toolbar' => $controls, // 1 or 0 vvditovvv - 'scrollbar' => $controls, - 'navpanes' => $controls, - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'toolbar' => $controls, /* 1 or 0 */ + 'scrollbar' => $controls, /* 1 or 0 */ + 'navpanes' => $controls, + ); + break; case 'audio/x-wav': case 'audio/mpeg': - case 'audio/ogg': // must use application/ogg instead? + case 'audio/ogg': /* must use application/ogg instead? */ case 'audio/x-midi': $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + )); $parameters = array( - 'src' => $url, - 'autoplay' => $autoplay, - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); - + 'src' => $url, + 'autoplay' => $autoplay, + ); + break; default: $attributes = array_merge($attributes, array( - 'type' => $mimeType, - 'width' => $width, - 'height' => $height, - 'data' => $url, - )); + 'type' => $mimeType, + 'width' => $width, + 'height' => $height, + 'data' => $url, + )); $parameters = array( - 'src' => $url, - ); - return sprintf($this->tags['object'], $this->_parseAttributes($attributes), $this->_parseParameters($parameters), $alt); + 'src' => $url, + ); + break; } + return sprintf( + $this->tags['object'], + $this->_parseAttributes($attributes), + $this->_parseParameters($parameters), + $alt + ); } /** - * Enter description here... + * Generates markup to link to file * - * @param unknown_type $url - * @param unknown_type $options - * @return unknown + * @param string $path Absolute or partial path to a file + * @param array $options + * @return mixed */ function link($path, $options = array()) { $default = array( @@ -439,26 +445,28 @@ class MediumHelper extends AppHelper { $Medium = Medium::factory($file, $mimeType); - if (!empty($options['restrict']) && !in_array(strtolower($Medium->name), (array) $options['restrict'])) { + if (!empty($options['restrict']) + && !in_array(strtolower($Medium->name), (array) $options['restrict'])) { return null; } unset($options['restrict']); switch ($mimeType) { case 'text/css': - $out = sprintf($this->tags['csslink'], $url, $this->_parseAttributes($options, null, '', ' ')); + $out = sprintf( + $this->tags['csslink'], + $url, + $this->_parseAttributes($options, null, '', ' ') + ); return $this->output($out, $inline); - case 'application/javascript': case 'application/x-javascript': $out = sprintf($this->tags['javascriptlink'], $url); return $this->output($out, $inline); - case 'application/rss+xml': $options = array_merge($defaultRss,$options); $out = sprintf($this->tags['rsslink'], $url, $options['title']); return $this->output($out, $inline); - default: return $this->Html->link(basename($file), $url); } @@ -466,8 +474,8 @@ class MediumHelper extends AppHelper { /** * Get MIME type for a path * - * @param string $path - * @return mixed + * @param string|array $path Absolute or partial path to a file + * @return string|boolean */ function mimeType($path) { if ($file = $this->file($path)) { @@ -478,8 +486,8 @@ class MediumHelper extends AppHelper { /** * Get size of file * - * @param string $path - * @return mixed False on error or integer + * @param string|array $path Absolute or partial path to a file + * @return integer|boolean False on error or integer */ function size($path) { if ($file = $this->file($path)) { @@ -488,7 +496,7 @@ class MediumHelper extends AppHelper { return false; } /** - * Resolves a fragmented path + * Resolves partial path * * Examples: * css/cake.generic >>> MEDIA_STATIC/css/cake.generic.css @@ -553,8 +561,10 @@ class MediumHelper extends AppHelper { $short = current(array_intersect(Medium::short(), $parts)); if (!$short) { - trigger_error('MediumHelper::file - You must provide a medium directory (e.g. img).', - E_USER_NOTICE); + $message = "MediumHelper::file - "; + $message .= "You've provided a partial path without a medium directory (e.g. img) "; + $message .= " which is required to resolve the path."; + trigger_error($message, E_USER_NOTICE); return false; } @@ -573,10 +583,10 @@ class MediumHelper extends AppHelper { return false; } /** - * Enter description here... + * Generates `param` tags * - * @param unknown_type $options - * @return unknown + * @param array $options + * @return string */ function _parseParameters($options) { $parameters = array(); @@ -588,7 +598,10 @@ class MediumHelper extends AppHelper { } elseif ($value === false) { $value = 'false'; } - $parameters[] = sprintf($this->tags['param'], $this->_parseAttributes(array('name' => $key, 'value' => $value))); + $parameters[] = sprintf( + $this->tags['param'], + $this->_parseAttributes(array('name' => $key, 'value' => $value)) + ); } return implode("\n", $parameters); } views/helpers/medium.php vendors/medium/adapter/javascript_packer.php 40e31e0bea01cc95b1d841ac43f55ee5402e7234 David Persson davidpersson@gmx.de http://github.com/davidpersson/media/commit/357b4296f543e873126e6e7af0fdec956c7f9cca 357b4296f543e873126e6e7af0fdec956c7f9cca 2009-05-27T18:21:21-07:00 2009-05-27T14:51:25-07:00 Updating docblocks and formatting Removing JavascriptPacker adatper Updating path login in Media Behavior Updating tests Fixing attachment model test broken in previous commit 5662f58b21853e08b943851df8f7e40acbba0155 David Persson davidpersson@gmx.de