diff options
| author | Igor Wiedler <igor@wiedler.ch> | 2011-11-19 01:20:22 +0100 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2011-11-19 01:20:22 +0100 |
| commit | b7c4fb38de526eb446de20c0b8e54d7cf9108834 (patch) | |
| tree | e5a09515fb73ca34e01736c681a733f40b2c89ba /phpBB/includes/cron | |
| parent | 3df4b83cd3306013d78b93024905a67ecc97df25 (diff) | |
| parent | 5f48f55cca5d0a6a2c51cdcc8a60b475354f50b1 (diff) | |
| download | forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.gz forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.bz2 forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.tar.xz forums-b7c4fb38de526eb446de20c0b8e54d7cf9108834.zip | |
Merge remote-tracking branch 'naderman/feature/extension-manager' into develop
* naderman/feature/extension-manager: (67 commits)
[feature/extension-manager] Removing now unused acp_search code
[feature/extension-manager] Split disabling extensions up into steps as well
[feature/extension-manager] Add documentation on caching in ext finder
[feature/extension-manager] Reference correct new module basenames in install
[feature/extension-manager] Rename default methods to core methods on finder.
[feature/extension-manager] Document what the class loader stores in cache
[feature/extension-manager] Add docblock to cached paths map in class loader
[feature/extension-manager] Clear up docs of extension related template changes
[feature/extension-manager] Use "core files" instead of "global files" in docs
[feature/extension-manager] Add docblocks to new search backend methods
[feature/extension-manager] Add docblocks to new methods in functions_module
[feature/extension-manager] Clarify comment on ext meta class instantiator
[feature/extension-manager] Add more info on suffixes in extension finder
[feature/extension-manager] Clarify is_dir parameter description
[feature/extension-manager] Clarify class finding method docblock
[feature/extension-manager] Correct default path comment & remove double strlen
[feature/extension-manager] Fix "disbale" typo in comment
[feature/extension-manager] Properly remove old ACP language loading code
[feature/extension-manager] Support extensions in subdirectories of ext/
[feature/extension-manager] Add prefix to extension meta data / install classes
...
Diffstat (limited to 'phpBB/includes/cron')
| -rw-r--r-- | phpBB/includes/cron/manager.php | 121 | ||||
| -rw-r--r-- | phpBB/includes/cron/task/provider.php | 48 |
2 files changed, 52 insertions, 117 deletions
diff --git a/phpBB/includes/cron/manager.php b/phpBB/includes/cron/manager.php index 31be1a69cb..a0bf018b33 100644 --- a/phpBB/includes/cron/manager.php +++ b/phpBB/includes/cron/manager.php @@ -33,137 +33,24 @@ class phpbb_cron_manager protected $tasks = array(); /** - * Path to the root of directory tree with tasks. - * For bundled phpBB tasks, this is the path to includes/cron/tasks - * under phpBB root. - * @var string - */ - protected $task_path; - - /** - * PHP file extension - * @var string - */ - protected $phpEx; - - /** - * Cache driver - * @var phpbb_cache_driver_interface - */ - protected $cache; - - /** * Constructor. Loads all available tasks. * - * Tasks will be looked up in directory tree rooted at $task_path. - * Task classes will be autoloaded and must be named according to - * autoloading naming conventions. To load cron tasks shipped with - * phpbb, pass $phpbb_root_path . 'includes/cron/task' as $task_path. - * - * If $cache is given, names of found cron tasks will be cached in it - * for one hour. Note that the cron task names are stored without - * namespacing; if two different phbb_cron_manager instances are - * constructed with different $task_path arguments but the same $cache, - * the second instance will use task names found by the first instance. - * - * @param string $task_path Directory containing cron tasks - * @param string $phpEx PHP file extension - * @param phpbb_cache_driver_interface $cache Cache for task names (optional) - * @return void + * @param array|Traversable $task_names Provides an iterable set of task names */ - public function __construct($task_path, $phpEx, phpbb_cache_driver_interface $cache = null) + public function __construct($task_names) { - if (DIRECTORY_SEPARATOR != '/') - { - // Need this on some platforms since the code elsewhere uses / - // to separate directory components, but PHP iterators return - // paths with platform-specific directory separators. - $task_path = str_replace('/', DIRECTORY_SEPARATOR, $task_path); - } - - $this->task_path = $task_path; - $this->phpEx = $phpEx; - $this->cache = $cache; - - $task_names = $this->find_cron_task_names(); $this->load_tasks($task_names); } /** - * Finds cron task names. - * - * A cron task file must follow the naming convention: - * includes/cron/task/$mod/$name.php. - * $mod is core for tasks that are part of phpbb. - * Modifications should use their name as $mod. - * $name is the name of the cron task. - * Cron task is expected to be a class named phpbb_cron_task_${mod}_${name}. - * - * @return array List of task names - */ - public function find_cron_task_names() - { - if ($this->cache) - { - $task_names = $this->cache->get('_cron_tasks'); - - if ($task_names !== false) - { - return $task_names; - } - } - - $task_names = array(); - $ext = '.' . $this->phpEx; - $ext_length = strlen($ext); - - $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($this->task_path)); - - foreach ($iterator as $fileinfo) - { - $file = preg_replace('#^' . preg_quote($this->task_path, '#') . '#', '', $fileinfo->getPathname()); - - // skip directories and files direclty in the task root path - if ($fileinfo->isFile() && strpos($file, DIRECTORY_SEPARATOR) !== false) - { - $task_name = str_replace(DIRECTORY_SEPARATOR, '_', substr($file, 0, -$ext_length)); - if (substr($file, -$ext_length) == $ext && $this->is_valid_name($task_name)) - { - $task_names[] = 'phpbb_cron_task_' . $task_name; - } - } - } - - if ($this->cache) - { - $this->cache->put('_cron_tasks', $task_names, 3600); - } - - return $task_names; - } - - /** - * Checks whether $name is a valid identifier, and - * therefore part of valid cron task class name. - * - * @param string $name Name to check - * - * @return bool - */ - public function is_valid_name($name) - { - return (bool) preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $name); - } - - /** * Loads tasks given by name, wraps them * and puts them into $this->tasks. * - * @param array $task_names Array of strings + * @param array|Traversable $task_names Array of strings * * @return void */ - public function load_tasks(array $task_names) + public function load_tasks($task_names) { foreach ($task_names as $task_name) { diff --git a/phpBB/includes/cron/task/provider.php b/phpBB/includes/cron/task/provider.php new file mode 100644 index 0000000000..e6ae0f75ec --- /dev/null +++ b/phpBB/includes/cron/task/provider.php @@ -0,0 +1,48 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2011 phpBB Group +* @license http://opensource.org/licenses/gpl-license.php GNU Public License +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Provides cron manager with tasks +* +* Finds installed cron tasks and makes them available to the cron manager. +* +* @package phpBB3 +*/ +class phpbb_cron_task_provider extends phpbb_extension_provider +{ + /** + * Finds cron task names using the extension manager. + * + * All PHP files in includes/cron/task/core/ are considered tasks. Tasks + * in extensions have to be located in a directory called cron or a subdir + * of a directory called cron. The class and filename must end in a _task + * suffix. Additionally all PHP files in includes/cron/task/core/ are + * tasks. + * + * @return array List of task names + */ + protected function find() + { + $finder = $this->extension_manager->get_finder(); + + return $finder + ->extension_suffix('_task') + ->extension_directory('/cron') + ->core_path('includes/cron/task/core/') + ->get_classes(); + } +} |