File zp-extensions/class-AnyFile.php

  1: <?php
  2: /**
  3:  *
  4:  * Use this plugin to handle filetypes as "images" that are not otherwise provided for by Zenphoto.
  5:  *
  6:  * Default thumbnail images may be created in the <var>%USER_PLUGIN_FOLDER%/class-AnyFile</var> folder. The naming convention is
  7:  * <i>suffix</i><var>Default.png</var>. If no such file is found, the class object default thumbnail will be used.
  8:  *
  9:  * The plugin is an extension of <var>TextObject</var>. For more details see the <i>class-textobject</i> plugin.
 10:  *
 11:  * @author Stephen Billard (sbillard)
 12:  * @package plugins
 13:  * @subpackage media
 14:  *
 15:  */
 16: $plugin_is_filter = 990 | CLASS_PLUGIN;
 17: $plugin_description = gettext('Provides a means for handling arbitrary file types. (No rendering provided!)');
 18: $plugin_author = "Stephen Billard (sbillard)";
 19: 
 20: 
 21: foreach (get_AnyFile_suffixes() as $suffix) {
 22:     Gallery::addImageHandler($suffix, 'AnyFile');
 23: }
 24: $option_interface = 'AnyFile_Options';
 25: 
 26: /**
 27:  * Option class for textobjects objects
 28:  *
 29:  */
 30: class AnyFile_Options {
 31: 
 32:     /**
 33:      * Standard option interface
 34:      *
 35:      * @return array
 36:      */
 37:     function getOptionsSupported() {
 38:         return array(gettext('Watermark default images')     => array('key'  => 'AnyFile_watermark_default_images', 'type' => OPTION_TYPE_CHECKBOX,
 39:                                         'desc' => gettext('Check to place watermark image on default thumbnail images.')),
 40:                         gettext('Handled files')                         => array('key'  => 'AnyFile_file_list', 'type' => OPTION_TYPE_CUSTOM,
 41:                                         'desc' => gettext('File suffixes to be handled.')),
 42:                         gettext('Add file suffix')                   => array('key'  => 'AnyFile_file_new', 'type' => OPTION_TYPE_TEXTBOX,
 43:                                         'desc' => gettext('Add a file suffix to be handled by the plugin'))
 44:         );
 45:     }
 46: 
 47:     function handleOption($option, $currentValue) {
 48:         $list = get_AnyFile_suffixes();
 49:         ?>
 50:         <ul class="customchecklist">
 51:             <?php
 52:             generateUnorderedListFromArray($list, $list, 'AnyFile_file_list_', false, false, false);
 53:             ?>
 54:         </ul>
 55:         <?php
 56:     }
 57: 
 58:     function handleOptionSave($themename, $themealbum) {
 59:         $mysetoptions = array();
 60:         foreach ($_POST as $key => $option) {
 61:             if (strpos($key, 'AnyFile_file_list_') === 0) {
 62:                 $mysetoptions[] = str_replace('AnyFile_file_list_', '', $key);
 63:                 purgeOption($key);
 64:             }
 65:         }
 66:         if ($_POST['AnyFile_file_new']) {
 67:             $mysetoptions[] = sanitize($_POST['AnyFile_file_new']);
 68:             $suffix = getOption('AnyFile_file_new');
 69:             purgeOption('AnyFile_file_new');
 70:         }
 71:         setOption('AnyFileSuffixList', serialize($mysetoptions));
 72:         return false;
 73:     }
 74: 
 75: }
 76: 
 77: function get_AnyFile_suffixes() {
 78:     $mysetoptions = array();
 79:     return getSerializedArray(getOption('AnyFileSuffixList'));
 80: }
 81: 
 82: require_once(dirname(__FILE__) . '/class-textobject/class-textobject_core.php');
 83: 
 84: class AnyFile extends TextObject {
 85: 
 86:     /**
 87:      * creates a WEBdocs (image standin)
 88:      *
 89:      * @param object $album the owner album
 90:      * @param string $filename the filename of the text file
 91:      * @return TextObject
 92:      */
 93:     function __construct($album, $filename, $quiet = false) {
 94: 
 95:         $this->watermark = getOption('AnyFile_watermark');
 96:         $this->watermarkDefault = getOption('AnyFile_watermark_default_images');
 97: 
 98:         $this->common_instantiate($album, $filename, $quiet);
 99:     }
100: 
101:     /**
102:      * Returns the image file name for the thumbnail image.
103:      *
104:      * @param string $path override path
105:      *
106:      * @return s
107:      */
108:     function getThumbImageFile($path = NULL) {
109:         global $_zp_gallery;
110:         if (is_null($path)) {
111:             $path = SERVERPATH;
112:         }
113:         if (is_null($this->objectsThumb)) {
114:             $img = '/' . getSuffix($this->filename) . 'Default.png';
115:             $imgfile = $path . '/' . THEMEFOLDER . '/' . internalToFilesystem($_zp_gallery->getCurrentTheme()) . '/images/' . $img;
116:             if (!file_exists($imgfile)) {
117:                 $imgfile = $path . "/" . USER_PLUGIN_FOLDER . '/' . substr(basename(__FILE__), 0, -4) . $img;
118:                 if (!file_exists($imgfile)) {
119:                     $imgfile = $path . "/" . ZENFOLDER . '/' . PLUGIN_FOLDER . '/' . substr(basename(__FILE__), 0, -4) . '/anyFileDefault.png';
120:                 }
121:             }
122:         } else {
123:             $imgfile = ALBUM_FOLDER_SERVERPATH . internalToFilesystem($this->imagefolder) . '/' . $this->objectsThumb;
124:         }
125:         return $imgfile;
126:     }
127: 
128:     /**
129:      * Returns the content of the text file
130:      *
131:      * @param int $w optional width
132:      * @param int $h optional height
133:      * @return string
134:      */
135:     function getContent($w = NULL, $h = NULL) {
136:         $this->updateDimensions();
137:         if (is_null($w))
138:             $w = $this->getWidth();
139:         if (is_null($h))
140:             $h = $this->getHeight();
141:         /*
142:          * just return the thumbnail as we do not know how to
143:          * render the file.
144:          */
145:         return '<img src="' . html_encode(pathurlencode($this->getThumb())) . '">';
146:     }
147: 
148: }
149: ?>
Packages

Classes

Exceptions

Functions
