<?php
// vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
// +--------------------------------------------------------------------+
// |                               Hooks                                |
// +--------------------------------------------------------------------+
// | This file is part of Hooks.                                        |
// |                                                                    |
// | Hooks 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.                                |
// |                                                                    |
// | Hooks 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: lun ene  6 17:22:31 ART 2003                              |
// | Authors: Leandro Lucarella <luca@lugmen.org.ar>                    |
// +--------------------------------------------------------------------+
//
// $Id$
//

/**
 * General file utilities functions.
 *
 * This is a group of static functions for getting file info and other
 * stuff.
 *
 * @package Hooks
 * @author  Leandro Lucarella <luca@lugmen.org.ar>
 * @version $Rev$
 * @since   rev 122
 * @access  public
 */
class File_Util {

    /**
     * Splits a filename into path, filename and extension.
     *
     * @param  string $file Filename to split.
     *
     * @return array  Array where the first element (index 0) is the
     *                path, the second is the name and the third is the
     *                extension.
     *
     * @access public
     * @since  rev 122
     */
    function splitFilename($file)
    {
        $path = preg_split('|/|', $file);
        $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);
    }

    /**
     * Tells if a file is readable looking in the include path.
     *
     * @param  string $file Name of the file to look for.
     *
     * @return bool   True if file is readable, false if not.
     *
     * @access public
     * @since  rev 122
     */
    function isReadableInclude($file)
    {
        list($dir, $page, $ext) = File_Util::splitFilename($file);
        if (is_readable($file)) {
            return true;
        }
        $include_path = array_unique(preg_split('/:/', ini_get('include_path')));
        foreach ($include_path as $path) {
            if (is_readable("$path/$file")) {
                return true;
            }
        }
        return false;
    }

    /**
     * Gets the last modification date/time for a file.
     *
     * @param  string $file   Name of the file to get the last modification
     *                        date/time.
     * @param  string $format Format (see strftime).
     *
     * @return string Formated string with the last modification
     *                date/time.
     *
     * @see    strftime()
     * @access public
     * @since  rev 142
     */
    function lastModified($file, $format = '%c')
    {
        return strftime($format, filemtime($file));
    }

}

// This is a workarround to live until PHP 4.3 is out and we can use the
// native get_file_contents() function. We don't care about
// $use_include_file option.
function file_get_contents($file, $use_include_file = false)
{
    if (@is_readable($file)) {
        $var = join('', file($file));
    } else {
        $var = '';
    }
    return $var;
}

?>