<?php

/**

 * Project:     Smarty: the PHP compiling template engine

 * File:        smarty_internal_utility.php

 * SVN:         $Id: $

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 *

 * This library 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * For questions, help, comments, discussion, etc., please join the

 * Smarty mailing list. Send a blank e-mail to

 * smarty-discussion-subscribe@googlegroups.com

 *

 * @link http://www.smarty.net/

 * @copyright 2008 New Digital Group, Inc.

 * @author Monte Ohrt <monte at ohrt dot com>

 * @author Uwe Tews

 * @package Smarty

 * @subpackage PluginsInternal

 * @version 3-SVN$Rev: 3286 $

 */

/**

 * Utility class

 *

 * @package Smarty

 * @subpackage Security

 */

class Smarty_Internal_Utility {

    /**

     * private constructor to prevent calls creation of new instances

     */

    private final function __construct()

    {

        // intentionally left blank

    }

    /**

     * Compile all template files

     *

     * @param string $extension     template file name extension

     * @param bool   $force_compile force all to recompile

     * @param int    $time_limit    set maximum execution time

     * @param int    $max_errors    set maximum allowed errors

     * @param Smarty $smarty        Smarty instance

     * @return integer number of template files compiled

     */

    public static function compileAllTemplates($extention, $force_compile, $time_limit, $max_errors, Smarty $smarty)

    {

        // switch off time limit

        if (function_exists('set_time_limit')) {

            @set_time_limit($time_limit);

        }

        $smarty->force_compile = $force_compile;

        $_count = 0;

        $_error_count = 0;

        // loop over array of template directories

        foreach($smarty->getTemplateDir() as $_dir) {

            $_compileDirs = new RecursiveDirectoryIterator($_dir);

            $_compile = new RecursiveIteratorIterator($_compileDirs);

            foreach ($_compile as $_fileinfo) {

                if (substr(basename($_file->getPathname()),0,1) == '.' || strpos($_fileinfo, '.svn') !== false) continue;

                $_file = $_fileinfo->getFilename();

                if (!substr_compare($_file, $extention, - strlen($extention)) == 0) continue;

                if ($_fileinfo->getPath() == substr($_dir, 0, -1)) {

                   $_template_file = $_file;

                } else {

                   $_template_file = substr($_fileinfo->getPath(), strlen($_dir)) . DS . $_file;

                }

                echo '<br>', $_dir, '---', $_template_file;

                flush();

                $_start_time = microtime(true);

                try {

                    $_tpl = $smarty->createTemplate($_template_file,null,null,null,false);

                    if ($_tpl->mustCompile()) {

                        $_tpl->compileTemplateSource();

                        $_count++;

                        echo ' compiled in  ', microtime(true) - $_start_time, ' seconds';

                        flush();

                    } else {

                        echo ' is up to date';

                        flush();

                    }

                }

                catch (Exception $e) {

                    echo 'Error: ', $e->getMessage(), "<br><br>";

                    $_error_count++;

                }

                // free memory

                $smarty->template_objects = array();

                $_tpl->smarty->template_objects = array();

                $_tpl = null;

                if ($max_errors !== null && $_error_count == $max_errors) {

                    echo '<br><br>too many errors';

                    exit();

                }

            }

        }

        return $_count;

    }

    /**

     * Compile all config files

     *

     * @param string $extension     config file name extension

     * @param bool   $force_compile force all to recompile

     * @param int    $time_limit    set maximum execution time

     * @param int    $max_errors    set maximum allowed errors

     * @param Smarty $smarty        Smarty instance

     * @return integer number of config files compiled

     */

    public static function compileAllConfig($extention, $force_compile, $time_limit, $max_errors, Smarty $smarty)

    {

        // switch off time limit

        if (function_exists('set_time_limit')) {

            @set_time_limit($time_limit);

        }

        $smarty->force_compile = $force_compile;

        $_count = 0;

        $_error_count = 0;

        // loop over array of template directories

        foreach($smarty->getConfigDir() as $_dir) {

            $_compileDirs = new RecursiveDirectoryIterator($_dir);

            $_compile = new RecursiveIteratorIterator($_compileDirs);

            foreach ($_compile as $_fileinfo) {

                if (substr(basename($_fileinfo->getPathname()),0,1) == '.' || strpos($_fileinfo, '.svn') !== false) continue;

                $_file = $_fileinfo->getFilename();

                if (!substr_compare($_file, $extention, - strlen($extention)) == 0) continue;

                if ($_fileinfo->getPath() == substr($_dir, 0, -1)) {

                    $_config_file = $_file;

                } else {

                    $_config_file = substr($_fileinfo->getPath(), strlen($_dir)) . DS . $_file;

                }

                echo '<br>', $_dir, '---', $_config_file;

                flush();

                $_start_time = microtime(true);

                try {

                    $_config = new Smarty_Internal_Config($_config_file, $smarty);

                    if ($_config->mustCompile()) {

                        $_config->compileConfigSource();

                        $_count++;

                        echo ' compiled in  ', microtime(true) - $_start_time, ' seconds';

                        flush();

                    } else {

                        echo ' is up to date';

                        flush();

                    }

                }

                catch (Exception $e) {

                    echo 'Error: ', $e->getMessage(), "<br><br>";

                    $_error_count++;

                }

                if ($max_errors !== null && $_error_count == $max_errors) {

                    echo '<br><br>too many errors';

                    exit();

                }

            }

        }

        return $_count;

    }

    /**

     * Delete compiled template file

     *

     * @param string  $resource_name template name

     * @param string  $compile_id    compile id

     * @param integer $exp_time      expiration time

     * @param Smarty  $smarty        Smarty instance

     * @return integer number of template files deleted

     */

    public static function clearCompiledTemplate($resource_name, $compile_id, $exp_time, Smarty $smarty)

    {

        $_compile_dir = $smarty->getCompileDir();

        $_compile_id = isset($compile_id) ? preg_replace('![^\w\|]+!', '_', $compile_id) : null;

        $_dir_sep = $smarty->use_sub_dirs ? DS : '^';

        if (isset($resource_name)) {

            $_save_stat = $smarty->caching;

            $smarty->caching = false;

            $tpl = new $smarty->template_class($resource_name, $smarty);

            $smarty->caching = $_save_stat;

            // remove from template cache

            $tpl->source; // have the template registered before unset()

            if ($smarty->allow_ambiguous_resources) {

                $_templateId = $tpl->source->unique_resource . $tpl->cache_id . $tpl->compile_id;

            } else {

                $_templateId = $smarty->joined_template_dir . '#' . $resource_name . $tpl->cache_id . $tpl->compile_id;

            }

            if (isset($_templateId[150])) {

                $_templateId = sha1($_templateId);

            }

            unset($smarty->template_objects[$_templateId]);

            if ($tpl->source->exists) {

                 $_resource_part_1 = basename(str_replace('^', '/', $tpl->compiled->filepath));

                 $_resource_part_1_length = strlen($_resource_part_1);

            } else {

                return 0;

            }

            $_resource_part_2 = str_replace('.php','.cache.php',$_resource_part_1);

            $_resource_part_2_length = strlen($_resource_part_2);

        }

        $_dir = $_compile_dir;

        if ($smarty->use_sub_dirs && isset($_compile_id)) {

            $_dir .= $_compile_id . $_dir_sep;

        }

        if (isset($_compile_id)) {

            $_compile_id_part = $_compile_dir . $_compile_id . $_dir_sep;

            $_compile_id_part_length = strlen($_compile_id_part);

        }

        $_count = 0;

        try {

            $_compileDirs = new RecursiveDirectoryIterator($_dir);

        // NOTE: UnexpectedValueException thrown for PHP >= 5.3

        } catch (Exception $e) {

            return 0;

        }

        $_compile = new RecursiveIteratorIterator($_compileDirs, RecursiveIteratorIterator::CHILD_FIRST);

        foreach ($_compile as $_file) {

            if (substr(basename($_file->getPathname()), 0, 1) == '.' || strpos($_file, '.svn') !== false)

                continue;

            $_filepath = (string) $_file;

            if ($_file->isDir()) {

                if (!$_compile->isDot()) {

                    // delete folder if empty

                    @rmdir($_file->getPathname());

                }

            } else {

                $unlink = false;

                if ((!isset($_compile_id) || (isset($_filepath[$_compile_id_part_length]) && !strncmp($_filepath, $_compile_id_part, $_compile_id_part_length)))

                    && (!isset($resource_name)

                        || (isset($_filepath[$_resource_part_1_length])

                            && substr_compare($_filepath, $_resource_part_1, -$_resource_part_1_length, $_resource_part_1_length) == 0)

                        || (isset($_filepath[$_resource_part_2_length])

                            && substr_compare($_filepath, $_resource_part_2, -$_resource_part_2_length, $_resource_part_2_length) == 0))) {

                    if (isset($exp_time)) {

                        if (time() - @filemtime($_filepath) >= $exp_time) {

                            $unlink = true;

                        }

                    } else {

                        $unlink = true;

                    }

                }

                if ($unlink && @unlink($_filepath)) {

                    $_count++;

                }

            }

        }

        // clear compiled cache

        Smarty_Resource::$sources = array();

        Smarty_Resource::$compileds = array();

        return $_count;

    }

    /**

     * Return array of tag/attributes of all tags used by an template

     *

     * @param Smarty_Internal_Template $templae template object

     * @return array of tag/attributes

     */

    public static function getTags(Smarty_Internal_Template $template)

    {

        $template->smarty->get_used_tags = true;

        $template->compileTemplateSource();

        return $template->used_tags;

    }

    /**

     * diagnose Smarty setup

     *

     * If $errors is secified, the diagnostic report will be appended to the array, rather than being output.

     *

     * @param Smarty $smarty  Smarty instance to test

     * @param array  $errors array to push results into rather than outputting them

     * @return bool status, true if everything is fine, false else

     */

    public static function testInstall(Smarty $smarty, &$errors=null)

    {

        $status = true;

        if ($errors === null) {

            echo "<PRE>\n";

            echo "Smarty Installation test...\n";

            echo "Testing template directory...\n";

        }

        $_stream_resolve_include_path = function_exists('stream_resolve_include_path');

        // test if all registered template_dir are accessible

        foreach($smarty->getTemplateDir() as $template_dir) {

            $_template_dir = $template_dir;

            $template_dir = realpath($template_dir);

            // resolve include_path or fail existance

            if (!$template_dir) {

                if ($smarty->use_include_path && !preg_match('/^([\/\\\\]|[a-zA-Z]:[\/\\\\])/', $_template_dir)) {

                    // try PHP include_path

                    if ($_stream_resolve_include_path) {

                        $template_dir = stream_resolve_include_path($_template_dir);

                    } else {

                        $template_dir = Smarty_Internal_Get_Include_Path::getIncludePath($_template_dir);

                    }

                    if ($template_dir !== false) {

                        if ($errors === null) {

                            echo "$template_dir is OK.\n";

                        }

                        continue;

                    } else {

                        $status = false;

                        $message = "FAILED: $_template_dir does not exist (and couldn't be found in include_path either)";

                        if ($errors === null) {

                            echo $message . ".\n";

                        } else {

                            $errors['template_dir'] = $message;

                        }

                        continue;

                    }

                } else {

                    $status = false;

                    $message = "FAILED: $_template_dir does not exist";

                    if ($errors === null) {

                        echo $message . ".\n";

                    } else {

                        $errors['template_dir'] = $message;

                    }

                    continue;

                }

            }

            if (!is_dir($template_dir)) {

                $status = false;

                $message = "FAILED: $template_dir is not a directory";

                if ($errors === null) {

                    echo $message . ".\n";

                } else {

                    $errors['template_dir'] = $message;

                }

            } elseif (!is_readable($template_dir)) {

                $status = false;

                $message = "FAILED: $template_dir is not readable";

                if ($errors === null) {

                    echo $message . ".\n";

                } else {

                    $errors['template_dir'] = $message;

                }

            } else {

                if ($errors === null) {

                    echo "$template_dir is OK.\n";

                }

            }

        }

        if ($errors === null) {

            echo "Testing compile directory...\n";

        }

        // test if registered compile_dir is accessible

        $__compile_dir = $smarty->getCompileDir();

        $_compile_dir = realpath($__compile_dir);

        if (!$_compile_dir) {

            $status = false;

            $message = "FAILED: {$__compile_dir} does not exist";

            if ($errors === null) {

                echo $message . ".\n";

            } else {

                $errors['compile_dir'] = $message;

            }

        } elseif (!is_dir($_compile_dir)) {

            $status = false;

            $message = "FAILED: {$_compile_dir} is not a directory";

            if ($errors === null) {

                echo $message . ".\n";

            } else {

                $errors['compile_dir'] = $message;

            }

        } elseif (!is_readable($_compile_dir)) {

            $status = false;

            $message = "FAILED: {$_compile_dir} is not readable";

            if ($errors === null) {

                echo $message . ".\n";

            } else {

                $errors['compile_dir'] = $message;

            }

        } elseif (!is_writable($_compile_dir)) {

            $status = false;

            $message = "FAILED: {$_compile_dir} is not writable";

            if ($errors === null) {

                echo $message . ".\n";

            } else {

                $errors['compile_dir'] = $message;

            }

        } else {

            if ($errors === null) {

                echo "{$_compile_dir} is OK.\n";

            }

        }

        if ($errors === null) {

            echo "Testing plugins directory...\n";

        }

        // test if all registered plugins_dir are accessible

        // and if core plugins directory is still registered

        $_core_plugins_dir = realpath(dirname(__FILE__) .'/../plugins');

        $_core_plugins_available = false;

        foreach($smarty->getPluginsDir() as $plugin_dir) {

            $_plugin_dir = $plugin_dir;

            $plugin_dir = realpath($plugin_dir);

            // resolve include_path or fail existance

            if (!$plugin_dir) {

                if ($smarty->use_include_path && !preg_match('/^([\/\\\\]|[a-zA-Z]:[\/\\\\])/', $_plugin_dir)) {

                    // try PHP include_path

                    if ($_stream_resolve_include_path) {

                        $plugin_dir = stream_resolve_include_path($_plugin_dir);

                    } else {

                        $plugin_dir = Smarty_Internal_Get_Include_Path::getIncludePath($_plugin_dir);

                    }

                    if ($plugin_dir !== false) {

                        if ($errors === null) {

                            echo "$plugin_dir is OK.\n";

                        }

                        continue;

                    } else {

                        $status = false;

                        $message = "FAILED: $_plugin_dir does not exist (and couldn't be found in include_path either)";

                        if ($errors === null) {

                            echo $message . ".\n";

                        } else {

                            $errors['plugins_dir'] = $message;

                        }

                        continue;

                    }

                } else {

                    $status = false;

                    $message = "FAILED: $_plugin_dir does not exist";

                    if ($errors === null) {

                        echo $message . ".\n";

                    } else {

                        $errors['plugins_dir'] = $message;

                    }

                    continue;

                }

            }

            if (!is_dir($plugin_dir)) {

                $status = false;

                $message = "FAILED: $plugin_dir is not a directory";

                if ($errors === null) {

                    echo $message . ".\n";

                } else {

                    $errors['plugins_dir'] = $message;

                }

            } elseif (!is_readable($plugin_dir)) {

                $status = false;

                $message = "FAILED: $plugin_dir is not readable";

                if ($errors === null) {

                    echo $message . ".\n";

                } else {

                    $errors['plugins_dir'] = $message;

                }

            } elseif ($_core_plugins_dir && $_core_plugins_dir == realpath($plugin_dir)) {

                $_core_plugins_available = true;

                if ($errors === null) {

                    echo "$plugin_dir is OK.\n";

                }

            } else {

                if ($errors === null) {

                    echo "$plugin_dir is OK.\n";

                }

            }

        }

        if (!$_core_plugins_available) {

            $status = false;

            $message = "WARNING: Smarty's own libs/plugins is not available";

            if ($errors === null) {

                echo $message . ".\n";

            } elseif (!isset($errors['plugins_dir'])) {

                $errors['plugins_dir'] = $message;

            }

        }

        if ($errors === null) {

            echo "Testing cache directory...\n";

        }

        // test if all registered cache_dir is accessible

        $__cache_dir = $smarty->getCacheDir();

        $_cache_dir = realpath($__cache_dir);

        if (!$_cache_dir) {

            $status = false;

            $message = "FAILED: {$__cache_dir} does not exist";

            if ($errors === null) {

                echo $message . ".\n";

            } else {

                $errors['cache_dir'] = $message;

            }

        } elseif (!is_dir($_cache_dir)) {

            $status = false;

            $message = "FAILED: {$_cache_dir} is not a directory";

            if ($errors === null) {

                echo $message . ".\n";