modules/album/BIFE/Album/Thumbs.php

   1 <?php
   2 // vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
   3 // +--------------------------------------------------------------------+
   4 // |                       BIFE - Buil It FastEr                        |
   5 // +--------------------------------------------------------------------+
   6 // | This file is part of BIFE.                                         |
   7 // |                                                                    |
   8 // | BIFE is free software; you can redistribute it and/or modify it    |
   9 // | under the terms of the GNU General Public License as published by  |
  10 // | the Free Software Foundation; either version 2 of the License, or  |
  11 // | (at your option) any later version.                                |
  12 // |                                                                    |
  13 // | BIFE is distributed in the hope that it will be useful, but        |
  14 // | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  15 // | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   |
  16 // | General Public License for more details.                           |
  17 // |                                                                    |
  18 // | You should have received a copy of the GNU General Public License  |
  19 // | along with Hooks; if not, write to the Free Software Foundation,   |
  20 // | Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA      |
  21 // +--------------------------------------------------------------------+
  22 // | Created: Wed May 17 18:16:54 ART 2003                              |
  23 // | Authors: Leandro Lucarella <luca@lugmen.org.ar>                    |
  24 // +--------------------------------------------------------------------+
  25 //
  26 // $Id$
  27 //
  28
  29 // +X2C includes
  30 require_once 'BIFE/Widget.php';
  31 // ~X2C
  32
  33 require_once 'Image/Transform.php';
  34
  35 // +X2C Class 20 :Thumbs
  36 /**
  37  * Photo album widget. [TODO: Make a better explanation]
  38  *
  39  * @access public
  40  */
  41 class BIFE_Album_Thumbs extends BIFE_Widget {
  42     // ~X2C
  43
  44     // +X2C Operation 22
  45     /**
  46      * Constructor.
  47      *
  48      * @param  array $attrs Attributes.
  49      *
  50      * @return void
  51      * @access public
  52      */
  53     function BIFE_Album_Thumbs($attrs) // ~X2C
  54     {
  55         $this->__construct($attrs);
  56     }
  57     // -X2C
  58
  59     // +X2C Operation 57
  60     /**
  61      * Constructor.
  62      *
  63      * @param  array $attrs Attributes.
  64      *
  65      * @return void
  66      * @access public
  67      */
  68     function __construct($attrs) // ~X2C
  69     {
  70         // TODO - get defaults from an INI file.
  71         $defaults = array(
  72             'DIR'           => '.',
  73             'RECURSIVE'     => true,
  74             'THUMBSFORMAT'  => 'jpeg',
  75             'THUMBSDIR'     => '.thumbs',
  76             'EXTENSIONS'    => 'png,jpg,jpeg,PNG,JPG,JPEG',
  77             'MAXROWS'       => 0,
  78             'COLUMNS'       => 4,
  79             'LINK-BIFE'     => 'photo.xbf',
  80             'LINK-URL'      => '',
  81         );
  82         $attrs = array_merge($defaults, $attrs);
  83         $attrs['EXTENSIONS'] = explode(',', $attrs['EXTENSIONS']);
  84         parent::__construct($attrs);
  85     }
  86     // -X2C
  87
  88     // +X2C Operation 23
  89     /**
  90      * Renders the widget.
  91      *
  92      * @param  HTML_Template_HIT &$template Template to use to render the widget.
  93      *
  94      * @return string
  95      * @access public
  96      */
  97     function render(&$template) // ~X2C
  98     {
  99         $template->pushGroup('album');
 100         $list = $this->getList();
 101         $tot  = count($list);
 102         $rows = ceil($tot / $this->attrs['COLUMNS']);
 103         for ($row = 0; $row < $rows; $row++) {
 104             for ($col = 0; $col < $this->attrs['COLUMNS']; $col++) {
 105                 $cur = $row * $this->attrs['COLUMNS'] + $col;
 106                 if ($photo = @$list[$cur]) {
 107                     if (is_null($photo['THUMB'])) {
 108                         $photo['THUMB'] = $this->makeThumb($photo['FILE']);
 109                     }
 110                     $photo['URL'] = BIFE_Link::getURL(
 111                         array(
 112                             'BIFE'                  => $this->attrs['LINK-BIFE'],
 113                             'URL'                   => $this->attrs['LINK-URL'],
 114                             'DATA-BIFE_ALBUM_FILE'  => $photo['FILE'],
 115                         )
 116                     );
 117                     $cell = $template->parse('item', $photo);
 118                 } else {
 119                     $cell = $template->parse('empty');
 120                 }
 121                 $template->parseBuffered('cell', 'CONTENTS', $cell);
 122             }
 123             $template->parseBuffered('row', 'CONTENTS',
 124                 $template->popBuffer('cell'));
 125         }
 126         $out = $template->parse('body', array(
 127             'DESC'     => $this->getDescription(),
 128             'CONTENTS' => $template->popBuffer('row')));
 129         $template->popGroup();
 130         return $out;
 131     }
 132     // -X2C
 133
 134     // +X2C Operation 95
 135     /**
 136      * Gets a list of photos with their descriptions and thumbnails.
 137 Returns an array of associative arrays with this keys:
 138 <ul>
 139 <li><b>file:</b> Photo filename.</li>
 140 <li><b>desc:</b> Photo Description.</li>
 141 <li><b>thumb:</b> Photo thumbnail filename.</li>
 142 </ul>
 143      *
 144      * @return array
 145      * @access protected
 146      */
 147     function getList() // ~X2C
 148     {
 149         $root = $this->attrs['DIR'];
 150         $exts = $this->attrs['EXTENSIONS'];
 151         $format = $this->attrs['THUMBSFORMAT'];
 152         $return = array();
 153         $d = dir($root);
 154         if ($d) {
 155             while (($file = $d->read()) !== false) {
 156                 list($path, $name, $ext) = $this->splitFilename("$root/$file");
 157                 if (is_readable("$root/$file") and in_array($ext, $exts)) {
 158                     $thumb = $this->getThumbFilename("$root/$file");
 159                     $return[] = array(
 160                         'FILE'  => "$root/$file",
 161                         'DESC'  => $name,
 162                         'THUMB' => is_readable($thumb) ? $thumb : null,
 163                     );
 164                 }
 165             }
 166             $d->close();
 167         }
 168         return $return;
 169     }
 170     // -X2C
 171
 172     // +X2C Operation 97
 173     /**
 174      * Creates an image thumbnail, returning his filename.
 175      *
 176      * @param  string $filename Filename of the image to create the thumb.
 177      * @param  int $size Maximum thumbnail size.
 178      *
 179      * @return string
 180      * @access protected
 181      */
 182     function makeThumb($filename, $size = 100) // ~X2C
 183     {
 184         $format = $this->attrs['THUMBSFORMAT'];
 185         $thumb = $this->getThumbFilename($filename);
 186         list($path, $name, $ext) = $this->splitFilename($thumb);
 187         $img =& Image_Transform::factory('GD');
 188         $img->load($filename);
 189         // If image is larger than the maximum size, we resize it.
 190         if ($img->img_x > $size or $img->img_y > $size ) {
 191             if (!@is_dir($path) and !@mkdir($path)) {
 192                 return null;
 193             }
 194             if (PEAR::isError($img)) {
 195                 return null;
 196             }
 197             if (!$img->scale($size)) {
 198                 return null;
 199             }
 200         }
 201         $img->save("$path/$name.$format", $format);
 202         $img->free();
 203
 204         return $thumb;
 205     }
 206     // -X2C
 207
 208     // +X2C Operation 98
 209     /**
 210      * Returns the filename of an image thumb.
 211      *
 212      * @param  string $filename Filename of the image to get the thumb name.
 213      *
 214      * @return string
 215      * @access protected
 216      */
 217     function getThumbFilename($filename) // ~X2C
 218     {
 219         $root = $this->attrs['DIR'];
 220         $format = $this->attrs['THUMBSFORMAT'];
 221         $thumbsdir = $this->attrs['THUMBSDIR'];
 222
 223         list($path, $name, $ext) = $this->splitFilename($filename);
 224
 225         return "$root/$thumbsdir/$name.$format";
 226     }
 227     // -X2C
 228
 229     // +X2C Operation 102
 230     /**
 231      * Returns the description of the album.
 232      *
 233      * @return string
 234      * @access protected
 235      */
 236     function getDescription() // ~X2C
 237     {
 238         $root = $this->attrs['DIR'];
 239         return @join('', file($file));
 240     }
 241     // -X2C
 242
 243     // +X2C Operation 100
 244     /**
 245      * Splits a filename returning an array with the path, name and extension.
 246      *
 247      * @param  string $filename Filename to split.
 248      *
 249      * @return array
 250      * @access public
 251      * @static
 252      */
 253     function splitFilename($filename) // ~X2C
 254     {
 255         $path = explode('/', $filename);
 256         $file = array_pop($path);
 257         $ext  = '';
 258         if (strstr($file, '.')) {
 259             preg_match('|([^/]+?)(\.([^\.]*))?$|', $file, $m);
 260             $file = @$m[1] . ((@$m[2] == '.' ) ? '.' : '');
 261             $ext  = @$m[3];
 262         }
 263         $dir = count($path) ? join('/', $path) : '';
 264         return array($dir, $file, $ext);
 265     }
 266     // -X2C
 267
 268 } // -X2C Class :Thumbs
 269
 270 ?>