src/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 'BIFE/Link.php';
  34 require_once 'Image/Transform.php';
  35
  36 // +X2C Class 20 :Thumbs
  37 /**
  38  * Photo album widget. [TODO: Make a better explanation]
  39  *
  40  * @package BIFE_Album
  41  * @access public
  42  */
  43 class BIFE_Album_Thumbs extends BIFE_Widget {
  44     // ~X2C
  45
  46     // +X2C Operation 22
  47     /**
  48      * Constructor.
  49      *
  50      * @param  array $attrs Attributes.
  51      *
  52      * @return void
  53      * @access public
  54      */
  55     function BIFE_Album_Thumbs($attrs) // ~X2C
  56     {
  57         $this->__construct($attrs);
  58     }
  59     // -X2C
  60
  61     // +X2C Operation 57
  62     /**
  63      * Constructor.
  64      *
  65      * @param  array $attrs Attributes.
  66      *
  67      * @return void
  68      * @access public
  69      */
  70     function __construct($attrs) // ~X2C
  71     {
  72         // TODO - get defaults from an INI file.
  73         $defaults = array(
  74             'DIR'           => '.',
  75             'RECURSIVE'     => true,
  76             'THUMBSFORMAT'  => 'jpeg',
  77             'THUMBSDIR'     => '.thumbs',
  78             'EXTENSIONS'    => 'png,jpg,jpeg,PNG,JPG,JPEG',
  79             'MAXROWS'       => 0,
  80             'COLUMNS'       => 4,
  81             'LINK-BIFE'     => 'photo.xbf',
  82             'LINK-URL'      => '',
  83         );
  84         $attrs = array_merge($defaults, $attrs);
  85         $attrs['EXTENSIONS'] = explode(',', $attrs['EXTENSIONS']);
  86         parent::__construct($attrs);
  87     }
  88     // -X2C
  89
  90     // +X2C Operation 23
  91     /**
  92      * Renders the widget.
  93      *
  94      * @param  HTML_Template_HIT &$template Template to use to render the widget.
  95      *
  96      * @return string
  97      * @access public
  98      */
  99     function render(&$template) // ~X2C
 100     {
 101         $template->pushGroup('album');
 102         $list = $this->getList();
 103         $tot  = count($list);
 104         $rows = ceil($tot / $this->attrs['COLUMNS']);
 105         for ($row = 0; $row < $rows; $row++) {
 106             for ($col = 0; $col < $this->attrs['COLUMNS']; $col++) {
 107                 $cur = $row * $this->attrs['COLUMNS'] + $col;
 108                 if ($photo = @$list[$cur]) {
 109                     if (is_null($photo['THUMB'])) {
 110                         $photo['THUMB'] = $this->makeThumb($photo['FILE']);
 111                     }
 112                     $photo['URL'] = BIFE_Link::getURL(
 113                         array(
 114                             'BIFE'                  => $this->attrs['LINK-BIFE'],
 115                             'URL'                   => $this->attrs['LINK-URL'],
 116                             'DATA-BIFE_ALBUM_FILE'  => $photo['FILE'],
 117                         )
 118                     );
 119                     $cell = $template->parse('item', $photo);
 120                 } else {
 121                     $cell = $template->parse('empty');
 122                 }
 123                 $template->parseBuffered('cell', 'CONTENTS', $cell);
 124             }
 125             $template->parseBuffered('row', 'CONTENTS',
 126                 $template->popBuffer('cell'));
 127         }
 128         $out = $template->parse('body', array(
 129             'DESC'     => $this->getDescription(),
 130             'CONTENTS' => $template->popBuffer('row')));
 131         $template->popGroup();
 132         return $out;
 133     }
 134     // -X2C
 135
 136     // +X2C Operation 95
 137     /**
 138      * Gets a list of photos with their descriptions and thumbnails.
 139 Returns an array of associative arrays with this keys:
 140 <ul>
 141 <li><b>file:</b> Photo filename.</li>
 142 <li><b>desc:</b> Photo Description.</li>
 143 <li><b>thumb:</b> Photo thumbnail filename.</li>
 144 </ul>
 145      *
 146      * @return array
 147      * @access protected
 148      */
 149     function getList() // ~X2C
 150     {
 151         $root = $this->attrs['DIR'];
 152         $exts = $this->attrs['EXTENSIONS'];
 153         $format = $this->attrs['THUMBSFORMAT'];
 154         $return = array();
 155         $d = dir($root);
 156         if ($d) {
 157             while (($file = $d->read()) !== false) {
 158                 list($path, $name, $ext) = $this->splitFilename("$root/$file");
 159                 if (is_readable("$root/$file") and in_array($ext, $exts)) {
 160                     $thumb = $this->getThumbFilename("$root/$file");
 161                     $return[] = array(
 162                         'FILE'  => "$root/$file",
 163                         'DESC'  => $name,
 164                         'THUMB' => is_readable($thumb) ? $thumb : null,
 165                     );
 166                 }
 167             }
 168             $d->close();
 169         }
 170         return $return;
 171     }
 172     // -X2C
 173
 174     // +X2C Operation 97
 175     /**
 176      * Creates an image thumbnail, returning his filename.
 177      *
 178      * @param  string $filename Filename of the image to create the thumb.
 179      * @param  int $size Maximum thumbnail size.
 180      *
 181      * @return string
 182      * @access protected
 183      */
 184     function makeThumb($filename, $size = 100) // ~X2C
 185     {
 186         $format = $this->attrs['THUMBSFORMAT'];
 187         $thumb = $this->getThumbFilename($filename);
 188         list($path, $name, $ext) = $this->splitFilename($thumb);
 189         $img =& Image_Transform::factory('GD');
 190         $img->load($filename);
 191         // If image is larger than the maximum size, we resize it.
 192         if ($img->img_x > $size or $img->img_y > $size ) {
 193             if (!@is_dir($path) and !@mkdir($path)) {
 194                 return null;
 195             }
 196             if (PEAR::isError($img)) {
 197                 return null;
 198             }
 199             if (!$img->scale($size)) {
 200                 return null;
 201             }
 202         }
 203         $img->save("$path/$name.$format", $format);
 204         $img->free();
 205
 206         return $thumb;
 207     }
 208     // -X2C
 209
 210     // +X2C Operation 98
 211     /**
 212      * Returns the filename of an image thumb.
 213      *
 214      * @param  string $filename Filename of the image to get the thumb name.
 215      *
 216      * @return string
 217      * @access protected
 218      */
 219     function getThumbFilename($filename) // ~X2C
 220     {
 221         $root = $this->attrs['DIR'];
 222         $format = $this->attrs['THUMBSFORMAT'];
 223         $thumbsdir = $this->attrs['THUMBSDIR'];
 224
 225         list($path, $name, $ext) = $this->splitFilename($filename);
 226
 227         return "$root/$thumbsdir/$name.$format";
 228     }
 229     // -X2C
 230
 231     // +X2C Operation 102
 232     /**
 233      * Returns the description of the album.
 234      *
 235      * @return string
 236      * @access protected
 237      */
 238     function getDescription() // ~X2C
 239     {
 240         $root = $this->attrs['DIR'];
 241         return @join('', file($file));
 242     }
 243     // -X2C
 244
 245     // +X2C Operation 100
 246     /**
 247      * Splits a filename returning an array with the path, name and extension.
 248      *
 249      * @param  string $filename Filename to split.
 250      *
 251      * @return array
 252      * @access public
 253      * @static
 254      */
 255     function splitFilename($filename) // ~X2C
 256     {
 257         $path = explode('/', $filename);
 258         $file = array_pop($path);
 259         $ext  = '';
 260         if (strstr($file, '.')) {
 261             preg_match('|([^/]+?)(\.([^\.]*))?$|', $file, $m);
 262             $file = @$m[1] . ((@$m[2] == '.' ) ? '.' : '');
 263             $ext  = @$m[3];
 264         }
 265         $dir = count($path) ? join('/', $path) : '';
 266         return array($dir, $file, $ext);
 267     }
 268     // -X2C
 269
 270 } // -X2C Class :Thumbs
 271
 272 ?>