<?php
/*
 * Gallery - a web based photo album viewer and editor
 * Copyright (C) 2000-2008 Bharat Mediratta
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
 */

GalleryCoreApi::requireOnce('modules/core/AdminMaintenance.inc');

/**
 * This is a MaintenanceTask that will delete all the cached Smarty templates.
 * @package GalleryCore
 * @subpackage Classes
 * @author Bharat Mediratta <bharat@menalto.com>
 * @version $Revision: 17580 $
 */
class FlushTemplatesTask extends MaintenanceTask {
    /**
     * @see MaintenanceTask::getInfo
     */
    function getInfo() {
	global $gallery;

	$info['l10Domain'] = 'modules_core';
	$info['title'] = $gallery->i18n('Delete template cache');
	$info['description'] = $gallery->i18n(
	    'Gallery compiles template files and saves them for increased performance.  If you\''
	    . 're experiencing problems that say <i>Smarty error</i> then you might try running '
	    . 'this task.  Also run this if you add or remove any local/*.tpl or theme override '
	    . 'so Smarty will find the right file.');
	return $info;
    }

    /**
     * @see MaintenanceTask::run
     */
    function run() {
	global $gallery;
	$platform =& $gallery->getPlatform();
	$dir = $gallery->getConfig('data.smarty.templates_c');
	$success = true;

	list ($ret, $module) = GalleryCoreApi::loadPlugin('module', 'core');
	if ($ret) {
	    return array($ret, null, null);
	}

	if ($platform->file_exists($dir)) {
	    $success = $platform->recursiveRmdir($dir);
	}

	/* Clear UrlGenerator's /local/ URL map, somewhat related to templates/theming */
	GalleryDataCache::removeFromDisk(array('type' => 'local-url-map'));

	$details = array();
	if ($success) {
	    $details[] = $module->translate('Template cache deleted successfully');
	} else {
	    $details[] = $module->translate(
		array('text' => 'Unable to delete directory: %s', 'arg1' => $dir));
	}

	return array(null, $success, $details);
    }
}
?>
