Alpha Framework alpha--util
[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]
alpha--util
Packages:
alpha--controller
alpha--controller--front
alpha--exceptions
alpha--model
alpha--model--types
alpha--service
alpha--tests
alpha--util
alpha--util--convertors
alpha--util--feeds
alpha--util--filters
alpha--util--graphs
alpha--util--helpers
alpha--util--metrics
alpha--view
alpha--view--widgets

Source for file AlphaCronManager.inc

Documentation is available at AlphaCronManager.inc

  1. <?php
  2.  
  3. // load config
  4. if(!isset($config)) {
  5.     require_once 'AlphaConfig.inc';
  6.     $config = AlphaConfig::getInstance();
  7. }
  8.  
  9. require_once $config->get('sysRoot').'alpha/util/AlphaErrorHandlers.inc';
  10.  
  11. /**
  12.  *
  13.  * The main class responsible for running custom cron tasks found under the [webapp]/tasks
  14.  * directory.  This class should be executed from Linux cron via the CLI.
  15.  * 
  16.  * @package alpha::util
  17.  * @since 1.0
  18.  * @author John Collins <dev@alphaframework.org>
  19.  * @version $Id: AlphaCronManager.inc 1341 2011-03-17 15:02:02Z johnc $
  20.  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
  21.  * @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
  22.  *  All rights reserved.
  23.  * 
  24.  *  <pre>
  25.  *  Redistribution and use in source and binary forms, with or
  26.  *  without modification, are permitted provided that the
  27.  *  following conditions are met:
  28.  * 
  29.  *  * Redistributions of source code must retain the above
  30.  *    copyright notice, this list of conditions and the
  31.  *    following disclaimer.
  32.  *  * Redistributions in binary form must reproduce the above
  33.  *    copyright notice, this list of conditions and the
  34.  *    following disclaimer in the documentation and/or other
  35.  *    materials provided with the distribution.
  36.  *  * Neither the name of the Alpha Framework nor the names
  37.  *    of its contributors may be used to endorse or promote
  38.  *    products derived from this software without specific
  39.  *    prior written permission.
  40.  *   
  41.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  42.  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  43.  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  44.  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  45.  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  46.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  47.  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  48.  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  49.  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50.  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  51.  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  52.  *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  53.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54.  *  </pre>
  55.  *  
  56.  */
  57. class AlphaCronManager {
  58.     /**
  59.      * Trace logger
  60.      * 
  61.      * @var Logger 
  62.      * @since 1.0
  63.      */
  64.     private static $logger = null;
  65.     
  66.     /**
  67.      * Constructor
  68.      * 
  69.      * @since 1.0
  70.      */
  71.     public function __construct() {
  72.         global $config;        
  73.         
  74.         self::$logger = new Logger('AlphaCronManager');            
  75.         self::$logger->setLogFile($config->get('sysRoot').'logs/tasks.log');
  76.         
  77.         self::$logger->debug('>>__construct()');
  78.         
  79.         self::$logger->info('New AlphaCronManager invoked');
  80.  
  81.         $taskList = self::getTaskClassNames();
  82.         
  83.         self::$logger->info('Found ['.count($taskList).'] tasks in the directory ['.$config->get('sysRoot').'tasks]');
  84.         
  85.         foreach($taskList as $taskClass) {
  86.             self::$logger->info('Loading task ['.$taskClass.']');
  87.             self::loadClassDef($taskClass);
  88.             $task = new $taskClass;
  89.             
  90.             $startTime = microtime(true);            
  91.             $maxAllowedTime = $startTime+$task->getMaxRunTime();
  92.             
  93.             self::$logger->info('Start time is ['.$startTime.'], maximum task run time is ['.$task->getMaxRunTime().']');
  94.             
  95.             // only continue to execute for the task max time
  96.             set_time_limit($task->getMaxRunTime());
  97.             $task->doTask();
  98.             
  99.             self::$logger->info('Done in ['.round(microtime(true)-$startTime, 5).'] seconds');
  100.         }
  101.         
  102.         self::$logger->info('Finished processing all cron tasks');
  103.         
  104.         self::$logger->debug('<<__construct');
  105.     }
  106.     
  107.     /**
  108.      * Loops over the /tasks directory and builds an array of all of the task
  109.      * class names in the system.
  110.      *
  111.      * @return array 
  112.      * @since 1.0
  113.      */
  114.     public static function getTaskClassNames() {
  115.         global $config;
  116.         
  117.         if(self::$logger == null) {
  118.             self::$logger = new Logger('AlphaCronManager');
  119.             self::$logger->setLogFile($config->get('sysRoot').'logs/tasks.log');
  120.         }
  121.         self::$logger->debug('>>getTaskClassNames()');
  122.         
  123.         global $config;
  124.         
  125.         $classNameArray = array();        
  126.         
  127.         $handle = opendir($config->get('sysRoot').'tasks');
  128.            
  129.         // loop over the business object directory
  130.         while (false !== ($file = readdir($handle))) {
  131.             if (preg_match("/_task.inc/", $file)) {
  132.                 $classname = substr($file, 0, -4);
  133.                 
  134.                 array_push($classNameArray, $classname);
  135.             }
  136.         }
  137.  
  138.         self::$logger->debug('<<getTaskClassNames ['.var_export($classNameArray, true).']');
  139.         return $classNameArray;
  140.     }
  141.     
  142.     /**
  143.      * Loads the definition for the task classname provided
  144.      * 
  145.      * @param string $classname 
  146.      * @since 1.0
  147.      */
  148.     public static function loadClassDef($classname) {
  149.         global $config;
  150.         
  151.         if(self::$logger == null) {
  152.             self::$logger = new Logger('AlphaCronManager');
  153.             self::$logger->setLogFile($config->get('sysRoot').'logs/tasks.log');
  154.         }
  155.         self::$logger->debug('>>loadClassDef(classname=['.$classname.'])');
  156.         
  157.         if(file_exists($config->get('sysRoot').'tasks/'.$classname.'.inc'))
  158.             require_once $config->get('sysRoot').'tasks/'.$classname.'.inc';
  159.         else
  160.             throw new IllegalArguementException('The class ['.$classname.'] is not defined anywhere!');
  161.         
  162.         self::$logger->debug('<<loadClassDef');
  163.     }
  164. }
  165.  
  166. // invoke a cron manager object
  167. $processor = new AlphaCronManager();
  168.  
  169. ?>
Documentation generated on Thu, 17 Mar 2011 16:43:14 +0000 by phpDocumentor 1.4.3