File Source for LPeriodicTask.php

<?php
/**
* Class file.
*
* @license http://opensource.org/licenses/mozilla1.1.php Mozilla Public License
* @copyright 2005, diemeisterei GmbH. All rights reserved.
* @author $Author: schmunk $
* @version $Revision: 233 $ $Date: 2006-05-30 17:14:13 +0200 (Di, 30 Mai 2006) $
* @package Phundament.Components
* @subpackage Modules
*/
Prado::using("System.Util.TLogger");
/**
* LPeriodicTask class
*
* <code>
* <module id="garbage_collector" class="LGarbageCollector">
* <scan dir="/public/tmp" probability="0.01">
* <condition fileatime="-1440"/>
* <action delete="1"/>
* </scan>
* </module>
* </code>
*
* This module is used execute tasks periodically
*
* @package System.Util
* @subpackage Modules
*/
class LPeriodicTask extends TModule
{
/**
* timestamp now
*/
private $now = 0;
/**
* global state updates
*/
private $configNode;
/**
* Initializes the module.
* This method is required by IModule and is invoked by application.
* This just hooks into Application::onLoadStateComplete, because we have no global state
* earlier
* @param TXmlElement module configuration
*/
public function init($xmlNode)
{
$this->configNode = $xmlNode;
$this->Application->onLoadStateComplete[] = array($this, "work");
}
/**
* Does the modules work.
* It loads scanning information from the module configuration, and executes all wanted tasks
* @param object $sender TApplication
* @param unused $param
*/
public function work($sender, $param)
{
$this->now = time();
foreach($this->configNode->getElementsByTagName('scan') as $node)
{
$d = $node->getAttribute('dir');
if ($dd = rtrim($d, "/")) $d = $dd; // trim trailing slashes if it's not "/"
if (!$d || !is_dir($d))
{
Prado :: log("scan node has invalid dir attribute ('$d')!", TLogger::ERROR, "Lithron.LPeriodicTask");
continue;
}
$p = strtolower($node->getAttribute('probability'));
if ($p === "")
{
Prado :: log("scan node has no probability (using default 1.0)!", TLogger::WARNING, "Lithron.LPeriodicTask");
$p = 1.0;
}
$i = strtolower($node->getAttribute('interval'));
if ($i)
{
$iid = $node->getAttribute('id');
if (!$iid)
Prado :: log("need id for using an interval! interval ignored", TLogger::ERROR, "Lithron.LPeriodicTask");
else if (($res = $this->strToStamp($i)) == -1)
Prado :: log("invalid interval given! interval ignored", TLogger::ERROR, "Lithron.LPeriodicTask");
else
{
$last = $this->Application->getGlobalState('LPeriodicTask:Interval:'.$iid);
if ($last > $res) $p = 0.0;
}
}
$r = strtolower($node->getAttribute('recursive')) != "";
$q = rand(0, 100000) / 100000;
if ($q > $p) continue;
Prado :: log("Doing Scan!", TLogger::NOTICE, "Lithron.LPeriodicTask");
$this->doScan($d, $node, $r);
if ($iid)
$this->Application->setGlobalState('LPeriodicTask:Interval:'.$iid, $this->now);
}
}
/**
* Executes on scan task by finding the files and working through all conditions and actions
* @param string $dir directory to scan
* @param TXmlElement $node scan node
* @param boolean $rec do a recursive scan
*/
private function doScan($dir, $node, $rec)
{
$iter = new DirectoryIterator($dir);
foreach($iter as $file)
{
if ($file->isDot()) continue;
if ($rec && $file->isDir()) $this->doScan($file->getPathname(), $node, $rec);
$els = $node->getElements();
foreach($els as $cmdnode)
{
switch($cmdnode->getTagname())
{
case "condition":
if (!$this->evalCondition($file, $cmdnode))
continue 3;
break;
case "action":
if (!$this->execAction($file, $cmdnode))
continue 3;
break;
default:
Prado :: log("unknown node under scan node ignored (".$cmdnode->getTagname().")!", TLogger::WARNING, "Lithron.LPeriodicTask");
}
}
}
}
/**
* returns a timestamp from a string converted by strtotime
* @param string $value the string
* @return integer timestamp, -1 on error
*/
private function strToStamp($value)
{
$res = strtotime($value, $this->now);
if ($res == -1)
Prado :: log("unrecognized time value ('$value')! assuming condition met!", TLogger::WARNING, "Lithron.LPeriodicTask");
return $res;
}
/**
* Evaluates a condition for a file and returns the result
* @param SplFileInfo $file the file
* @param TXmlElement $condnode the condition node
* @return boolean true if condition is met, false otherwise
*/
private function evalCondition($file, $condnode)
{
$attrs = $condnode->getAttributes();
foreach($attrs as $key => $value)
{
switch($key)
{
case "fileatime":
if (($res = $this->strToStamp($value)) == -1) break;
if ($file->getATime() > $res) return false;
break;
case "filectime":
if (($res = $this->strToStamp($value)) == -1) break;
if ($file->getCTime() > $res) return false;
break;
default:
Prado :: log("unknown condition attribute ('$key'). assuming condition met!", TLogger::WARNING, "Lithron.LPeriodicTask");
}
}
return true;
}
/**
* Executes an action for a file and returns the result
* @param SplFileInfo $file the file
* @param TXmlElement $condnode the condition node
* @return boolean true if action successfully executed, false otherwise
*/
private function execAction($file, $condnode)
{
$attrs = $condnode->getAttributes();
foreach($attrs as $key => $value)
{
switch($key)
{
case "touch":
if (!touch($file->getPathname()))
Prado :: log("touch action failed on '".$file->getPathname()."'!", TLogger::ERROR, "Lithron.LPeriodicTask");
else
Prado :: log("touch action successfull on '".$file->getPathname()."'!", TLogger::NOTICE, "Lithron.LPeriodicTask");
break;
case "delete":
if (!unlink($file->getPathname()))
Prado :: log("delete action failed on '".$file->getPathname()."'!", TLogger::ERROR, "Lithron.LPeriodicTask");
else
Prado :: log("delete action successfull on '".$file->getPathname()."'!", TLogger::NOTICE, "Lithron.LPeriodicTask");
break;
default:
Prado :: log("unknown action attribute ('$key'). no action taken!", TLogger::WARNING, "Lithron.LPeriodicTask");
}
}
return true;
}
}
?>

Source for file LPeriodicTask.php