<?php
// vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
// +--------------------------------------------------------------------+
// |                       BIFE - Buil It FastEr                        |
// +--------------------------------------------------------------------+
// | This file is part of BIFE.                                         |
// |                                                                    |
// | BIFE is free software; you can redistribute it and/or modify it    |
// | under the terms of the GNU General Public License as published by  |
// | the Free Software Foundation; either version 2 of the License, or  |
// | (at your option) any later version.                                |
// |                                                                    |
// | BIFE is distributed in the hope that it will be useful, but        |
// | WITHOUT ANY WARRANTY; without even the implied warranty of         |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   |
// | General Public License for more details.                           |
// |                                                                    |
// | You should have received a copy of the GNU General Public License  |
// | along with Hooks; if not, write to the Free Software Foundation,   |
// | Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA      |
// +--------------------------------------------------------------------+
// | Created: Wed May 17 18:16:54 ART 2003                              |
// | Authors: Leandro Lucarella <luca@lugmen.org.ar>                    |
// +--------------------------------------------------------------------+
//
// $Id$
//

// +X2C includes
require_once 'BIFE/Widget.php';
// ~X2C

// +X2C Class 20 :Album
/**
 * Photo album widget. [TODO: Make a better explanation]
 *
 * @access public
 */
class BIFE_Album extends BIFE_Widget {
    /**
     * Attributes.
     *
     * @var    array $attrs
     * @access public
     */
    var $attrs;

    // ~X2C

    // +X2C Operation 22
    /**
     * Constructor.
     *
     * @param  array $attrs Attributes.
     *
     * @return void
     * @access public
     */
    function BIFE_Album($attrs) // ~X2C
    {
        $this->__construct($attrs);
    }
    // -X2C

    // +X2C Operation 57
    /**
     * Constructor.
     *
     * @param  array $attrs Attributes.
     *
     * @return void
     * @access public
     */
    function __construct($attrs) // ~X2C
    {
        // TODO - get defaults from an INI file.
        $defaults = array(
            'DIR'           => '.',
            'RECURSIVE'     => true,
            'THUMBSFORMAT'  => 'jpeg',
            'THUMBSDIR'     => '.thumbs',
            'EXTENSIONS'    => 'png,jpg,jpeg,PNG,JPG,JPEG',
            'SELECTED'      => '',
            'MAXROWS'       => 0,
            'COLUMNS'       => 4,
        );
        $this->attrs = array_merge($defaults, $attrs);
        $this->attrs['EXTENSIONS'] = explode(',', $this->attrs['EXTENSIONS']);
    }
    // -X2C

    // +X2C Operation 23
    /**
     * Renders the widget.
     *
     * @param  HTML_Template_Sigma &$template Template to use to render the widget.
     *
     * @return string
     * @access public
     */
    function render(&$template) // ~X2C
    {
        $template->loadTemplateFile('bife_album.html');
        $template->addBlockFile('ITEMS', 'ITEM', 'bife_album_item.html');
        $root = $this->attrs['DIR'];
        $list = $this->getList();
        $tot  = count($list);
        $rows = ceil($tot / $this->attrs['COLUMNS']);
        for ($row = 0; $row < $rows; $row++) {
            for ($col = 0; $col < $this->attrs['COLUMNS']; $col++) {
                $cur = $row * $this->attrs['COLUMNS'] + $col;
                if ($photo = @$list[$cur]) {
                    $selected = ($photo['file'] === $this->attrs['SELECTED']);
                    if (is_null($photo['thumb'])) {
                        $photo['thumb'] = $this->makeThumb($photo['file']);
                    }
                    // FIXME - Si no se pudo crear el thumb, devuelve null
                    // (ver si se agrega otro template para indicar error
                    // o algo asi).
                    $template->setVariable(
                        array(
                            'PHOTO' => $photo['file'],
                            'DESC'  => $photo['desc'],
                            'THUMB' => $photo['thumb'],
                        )
                    );
                    $template->parse('ITEM');
                } else {
                    if (!@$empty) {
                        $template->replaceBlockFile('ITEM',
                            'bife_album_emptyitem.html', true);
                        $empty = true;
                    }
                    $template->touchBlock('ITEM');
                    $template->parse('ITEM');
                }
            }
            $template->parse('FILA');
        }
        $template->setVariable('DESC', $this->getDescription());
        return $template->get();
    }
    // -X2C

    // +X2C Operation 95
    /**
     * Gets a list of photos with their descriptions and thumbnails.
Returns an array of associative arrays with this keys:
<ul>
<li><b>file:</b> Photo filename.</li>
<li><b>desc:</b> Photo Description.</li>
<li><b>thumb:</b> Photo thumbnail filename.</li>
</ul>
     *
     * @return array
     * @access protected
     */
    function getList() // ~X2C
    {
        $root = $this->attrs['DIR'];
        $exts = $this->attrs['EXTENSIONS'];
        $format = $this->attrs['THUMBSFORMAT'];
        $return = array();
        
        $d = dir($root);
        while (($file = $d->read()) !== false) {
            list($path, $name, $ext) = $this->splitFilename("$root/$file");
            if (is_readable("$root/$file") and in_array($ext, $exts)) {
                $thumb = $this->getThumbFilename("$root/$file");
                $return[] = array(
                    'file'  => "$root/$file",
                    'desc'  => $name,
                    'thumb' => is_readable($thumb) ? $thumb : null,
                );
            }		
        }
        $d->close();

        return $return;
    }
    // -X2C

    // +X2C Operation 97
    /**
     * Creates an image thumbnail, returning his filename.
     *
     * @param  string $filename Filename of the image to create the thumb.
     * @param  int $size Maximum thumbnail size.
     *
     * @return string
     * @access protected
     */
    function makeThumb($filename, $size = 100) // ~X2C
    {
        $format = $this->attrs['THUMBSFORMAT'];
        $thumb = $this->getThumbFilename($filename);
        list($path, $name, $ext) = $this->splitFilename($thumb);
        $img =& Image_Transform::factory('GD');
        $img->load($filename);
        // If image is larger than the maximum size, we resize it.
        if ($img->img_x > $size or $img->img_y > $size ) {
            if (!@is_dir($path) and !@mkdir($path)) {
                return null;
            }
            if (PEAR::isError($img)) {
                return null;
            }
            if (!$img->scale($size)) {
                return null;
            }
        }
        $img->save("$path/$name.$format", $format);
        $img->free();

        return $thumb;
    }
    // -X2C

    // +X2C Operation 98
    /**
     * Returns the filename of an image thumb.
     *
     * @param  string $filename Filename of the image to get the thumb name.
     *
     * @return string
     * @access protected
     */
    function getThumbFilename($filename) // ~X2C
    {
        $root = $this->attrs['DIR'];
        $format = $this->attrs['THUMBSFORMAT'];
        $thumbsdir = $this->attrs['THUMBSDIR'];

        list($path, $name, $ext) = $this->splitFilename($filename);

        return "$root/$thumbsdir/$name.$format";
    }
    // -X2C

    // +X2C Operation 102
    /**
     * Returns the description of the album.
     *
     * @return string
     * @access protected
     */
    function getDescription() // ~X2C
    {
        $root = $this->attrs['DIR'];
        return @join('', file($file));
    }
    // -X2C

    // +X2C Operation 100
    /**
     * Splits a filename returning an array with the path, name and extension.
     *
     * @param  string $filename Filename to split.
     *
     * @return array
     * @access public
     * @static
     */
    function splitFilename($filename) // ~X2C
    {
        $path = explode('/', $filename);
        $file = array_pop($path);
        $ext  = '';
        if (strstr($file, '.')) {
            preg_match('|([^/]+?)(\.([^\.]*))?$|', $file, $m);
            $file = @$m[1] . ((@$m[2] == '.' ) ? '.' : '');
            $ext  = @$m[3];
        }
        $dir = count($path) ? join('/', $path) : '';
        return array($dir, $file, $ext);
    }
    // -X2C

} // -X2C Class :Album

?>