A module that provides interfaces for scheduling jobs for certain times.
PHP Shell Scheme
Pull request Compare This branch is even with tractorcow:master.
Latest commit f221122 Mar 17, 2014 @nyeholt Merge pull request #14 from ajshort/master
Custom Job Config
Permalink
Failed to load latest commit information.
.tx Globalisation, transifex support Oct 24, 2013
_config Added support for executing jobs via Gearman Sep 12, 2012
code Allow attaching custom config to an abstract queued job. Mar 16, 2014
images Add menu icon for queued jobs May 24, 2013
lang Pull language strings from Transifex. Jan 22, 2014
scripts BUG Fixing incorrect paths to framework May 16, 2013
templates
tests FIX Renamed tests to *Test.php to fit the phpunit format Aug 15, 2013
.travis.yml Only trigger travis on master branch, because config resolution appea… Sep 16, 2013
CHANGELOG FIX Don't process whole queue if a job breaks Dec 20, 2013
LICENSE INITIAL IMPORT May 12, 2010
README.md Fixed travis-ci URL for moved repo Oct 25, 2013
SILVERSTRIPE_VERSION MINOR added getTitle() method to QueuedJobDescriptor, for the model a… Oct 12, 2012
TODO INITIAL IMPORT May 12, 2010
VERSION FIX Don't process whole queue if a job breaks Dec 20, 2013
_config.php EXAMPLE: Added an example job to generate a google sitemap Nov 1, 2010
composer.json Updating composer requirements to ~3.1 so it works with stable versions. Oct 29, 2013

README.md

SilverStripe Queued Jobs Module

Build Status

Maintainer Contact

Marcus Nyeholt

Requirements

Version info

The master branch of this module is currently aiming for SilverStripe 3.1 compatibility

Documentation

See http://github.com/nyeholt/silverstripe-queuedjobs/wiki/ for more complete documentation

The Queued Jobs module provides a framework for SilverStripe developers to define long running processes that should be run as background tasks. This asynchronous processing allows users to continue using the system while long running tasks proceed when time permits. It also lets developers set these processes to be executed in the future.

The module comes with

  • A section in the CMS for viewing a list of currently running jobs or scheduled jobs.
  • An abstract skeleton class for defining your own jobs
  • A task that is executed as a cronjob for collecting and executing jobs.

Quick Usage Overview

  • Install the cronjob needed to manage all the jobs within the system. It is best to have this execute as the same user as your webserver - this prevents any problems with file permissions.

*/1 * * * * php /path/to/silverstripe/framework/cli-script.php dev/tasks/ProcessJobQueueTask

  • If your code is to make use of the 'long' jobs, ie that could take days to process, also install another task that processes this queue. Its time of execution can be left a little longer.

*/15 * * * * php /path/to/silverstripe/framework/cli-script.php dev/tasks/ProcessJobQueueTask queue=2

  • From your code, add a new job for execution.

    $publish = new PublishItemsJob(21); singleton('QueuedJobService')->queueJob($publish);

  • To schedule a job to be executed at some point in the future, pass a date through with the call to queueJob The following will run the publish job in 1 day's time from now.

    $publish = new PublishItemsJob(21); singleton('QueuedJobService')->queueJob($publish, date('Y-m-d H:i:s', time() + 86400));

Using Gearman for running jobs


Name: localproject

After: '#queuedjobsettings'

Injector: QueueHandler: class: GearmanQueueHandler

  • Run the gearman worker using php gearman/gearman_runner.php in your SS root dir

This will cause all queuedjobs to trigger immediate via a gearman worker (code/workers/JobWorker.php) EXCEPT those with a StartAfter date set, for which you will STILL need the cron settings from above

Using QueuedJob::IMMEDIATE jobs

Queued jobs can be executed immediately (instead of being limited by cron's 1 minute interval) by using a file based notification system. This relies on something like inotifywait to monitor a folder (by default this is SILVERSTRIPE_CACHE_DIR/queuedjobs) and triggering the ProcessJobQueueTask as above but passing job=$filename as the argument. An example script is in queuedjobs/scripts that will run inotifywait and then call the ProcessJobQueueTask when a new job is ready to run.

Note - if you do NOT have this running, make sure to set QueuedJobService::$use_shutdown_function = true; so that immediate mode jobs don't stall. By setting this to true, immediate jobs will be executed after the request finishes as the php script ends.

Troubleshooting

To make sure your job works, you can first try to execute the job directly outside the framework of the queues - this can be done by manually calling the setup() and process() methods. If it works fine under these circumstances, try having getJobType() return QueuedJob::IMMEDIATE to have execution work immediately, without being persisted or executed via cron. If this works, next make sure your cronjob is configured and executing correctly.

Indexes

ALTER TABLE QueuedJobDescriptor ADD INDEX ( JobStatus , JobType )

Contributing

Translations

Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.

Please use https://www.transifex.com/projects/p/silverstripe-queuedjobs to contribute translations, rather than sending pull requests with YAML files.