', $key, $messages));
+ }
+ }
+ }
+ $this->_redirect('*/*/index');
+ }
+
+ /**
+ * Init job instance and set it to registry
+ *
+ * @return Aoe_Scheduler_Model_Job
+ */
+ protected function _initJob()
+ {
+ $jobCode = $this->getRequest()->getParam('job_code', null);
+ $job = Mage::getModel('aoe_scheduler/job')->load($jobCode);
+ Mage::register('current_job_instance', $job);
+ return $job;
+ }
+
+ protected function getMassActionCodes($key = 'codes')
+ {
+ $codes = $this->getRequest()->getParam($key);
+ if (!is_array($codes)) {
+ return array();
+ }
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ $codes = array_intersect(array_unique(array_filter(array_map('trim', $codes))), $allowedCodes);
+ return $codes;
+ }
+
+ /**
+ * New cron (forward to edit action)
+ */
+ public function newAction()
+ {
+ $this->_forward('edit');
+ }
+
+ /**
+ * Edit cron action
+ */
+ public function editAction()
+ {
+ $this->_initJob();
+ $this->loadLayout();
+ $this->renderLayout();
+ }
+
+ protected function _filterPostData($data)
+ {
+ return $data;
+ }
+
+ protected function _validatePostData($data)
+ {
+ try {
+ /* @var Aoe_Scheduler_Helper_Data $helper */
+ $helper = Mage::helper('aoe_scheduler');
+ $helper->getCallBack($data['run_model']);
+ if (!empty($data['schedule_cron_expr'])) {
+ if (!$helper->validateCronExpression($data['schedule_cron_expr'])) {
+ Mage::throwException("Invalid cron expression");
+ }
+ }
+ } catch (Exception $e) {
+ $this->_getSession()->addError($e->getMessage());
+ return false;
+ }
+ // TODO: implement!
+ return true;
+ }
+
+ /**
+ * Save action
+ *
+ */
+ public function saveAction()
+ {
+ if ($data = $this->getRequest()->getPost()) {
+ $data = $this->_filterPostData($data);
+ $job = $this->_initJob();
+ $job->addData($data);
+ //validating
+ if (!$this->_validatePostData($data)) {
+ $this->_redirect('*/*/edit', array('job_code' => $job->getJobCode(), '_current' => true));
+ return;
+ }
+
+ try {
+ // save the data
+ $job->save();
+
+ // display success message
+ $this->_getSession()->addSuccess(
+ Mage::helper('aoe_scheduler')->__('The job has been saved.')
+ );
+ // clear previously saved data from session
+ $this->_getSession()->setFormData(false);
+ // check if 'Save and Continue'
+ if ($this->getRequest()->getParam('back', false)) {
+ $this->_redirect('*/*/edit', array('job_code' => $job->getJobCode(), '_current' => true));
+ return;
+ }
+
+ /* @var $scheduleManager Aoe_Scheduler_Model_ScheduleManager */
+ $scheduleManager = Mage::getModel('aoe_scheduler/scheduleManager');
+ $scheduleManager->flushSchedules($job->getJobCode());
+ $scheduleManager->generateSchedulesForJob($job);
+ $this->_getSession()->addNotice($this->__('Pending schedules for "%s" have been flushed.', $job->getJobCode()));
+ $this->_getSession()->addNotice($this->__('Job "%s" has been scheduled.', $job->getJobCode()));
+
+ // go to grid
+ $this->_redirect('*/*');
+ return;
+ } catch (Mage_Core_Exception $e) {
+ Mage::logException($e);
+ $this->_getSession()->addError($e->getMessage());
+ } catch (Exception $e) {
+ Mage::logException($e);
+ $this->_getSession()->addError($this->__('An error occurred during saving a job: %s', $e->getMessage()));
+ }
+
+ $this->_getSession()->setFormData($data);
+ $this->_redirect('*/*/edit', array('job_code' => $this->getRequest()->getParam('job_code')));
+ return;
+ }
+
+ $this->_redirect('*/*/', array('_current' => true));
+ }
+
+ /**
+ * Delete Action
+ *
+ */
+ public function deleteAction()
+ {
+ $job = $this->_initJob();
+ try {
+ $job->delete();
+ $this->_getSession()->addSuccess($this->__('The job has been deleted.'));
+
+ /* @var Aoe_Scheduler_Model_ScheduleManager $scheduleManager */
+ $scheduleManager = Mage::getModel('aoe_scheduler/scheduleManager');
+ $scheduleManager->flushSchedules($job->getJobCode());
+ $this->_getSession()->addNotice($this->__('Pending schedules for "%s" have been flushed.', $job->getJobCode()));
+ } catch (Exception $e) {
+ $this->_getSession()->addError($e->getMessage());
+ }
+ $this->_redirect('*/*/');
+ return;
+ }
+
+ /**
+ * ACL checking
+ *
+ * @return bool
+ */
+ protected function _isAllowed()
+ {
+ return Mage::getSingleton('admin/session')->isAllowed('system/aoe_scheduler/aoe_scheduler_cron');
+ }
+}
diff --git a/app/code/community/Aoe/Scheduler/controllers/Adminhtml/SchedulerController.php b/app/code/community/Aoe/Scheduler/controllers/Adminhtml/SchedulerController.php
old mode 100755
new mode 100644
index 68add0d..e77a441
--- a/app/code/community/Aoe/Scheduler/controllers/Adminhtml/SchedulerController.php
+++ b/app/code/community/Aoe/Scheduler/controllers/Adminhtml/SchedulerController.php
@@ -1,13 +1,10 @@
getRequest()->getParam('schedule_ids');
foreach ($ids as $id) {
- $schedule = Mage::getModel('cron/schedule')/* @var $schedule Aoe_Scheduler_Model_Schedule */
- ->load($id)
+ Mage::getModel('cron/schedule')->load($id)
->delete();
}
$message = $this->__('Deleted task(s) "%s"', implode(', ', $ids));
- Mage::getSingleton('adminhtml/session')->addSuccess($message);
+ $this->_getSession()->addSuccess($message);
if ($logFile = Mage::getStoreConfig('system/cron/logFile')) {
Mage::log($message, null, $logFile);
}
@@ -40,13 +36,11 @@ public function killAction()
{
$ids = $this->getRequest()->getParam('schedule_ids');
foreach ($ids as $id) {
- $schedule = Mage::getModel('cron/schedule')/* @var $schedule Aoe_Scheduler_Model_Schedule */
- ->load($id)
- ->setKillRequest(strftime('%Y-%m-%d %H:%M:%S', time()))
- ->save();
+ $schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $schedule->load($id)->requestKill();
}
$message = $this->__('Kill requests saved for task(s) "%s" (will be killed via cron)', implode(', ', $ids));
- Mage::getSingleton('adminhtml/session')->addSuccess($message);
+ $this->_getSession()->addSuccess($message);
if ($logFile = Mage::getStoreConfig('system/cron/logFile')) {
Mage::log($message, null, $logFile);
}
@@ -62,5 +56,4 @@ protected function _isAllowed()
{
return Mage::getSingleton('admin/session')->isAllowed('system/aoe_scheduler/aoe_scheduler_scheduler');
}
-
}
diff --git a/app/code/community/Aoe/Scheduler/controllers/Adminhtml/TimelineController.php b/app/code/community/Aoe/Scheduler/controllers/Adminhtml/TimelineController.php
old mode 100755
new mode 100644
index ff51861..d999253
--- a/app/code/community/Aoe/Scheduler/controllers/Adminhtml/TimelineController.php
+++ b/app/code/community/Aoe/Scheduler/controllers/Adminhtml/TimelineController.php
@@ -1,13 +1,10 @@
*/
-class Aoe_Scheduler_Adminhtml_TimelineController extends Aoe_Scheduler_Adminhtml_AbstractController
+class Aoe_Scheduler_Adminhtml_TimelineController extends Aoe_Scheduler_Controller_AbstractController
{
/**
@@ -19,5 +16,4 @@ protected function _isAllowed()
{
return Mage::getSingleton('admin/session')->isAllowed('system/aoe_scheduler/aoe_scheduler_timeline');
}
-
}
diff --git a/app/code/community/Aoe/Scheduler/data/aoescheduler_setup/data-upgrade-0.5.4-0.5.5.php b/app/code/community/Aoe/Scheduler/data/aoescheduler_setup/data-upgrade-0.5.4-0.5.5.php
new file mode 100644
index 0000000..c6b5f3e
--- /dev/null
+++ b/app/code/community/Aoe/Scheduler/data/aoescheduler_setup/data-upgrade-0.5.4-0.5.5.php
@@ -0,0 +1,30 @@
+getNode('default/system/cron/disabled_crons');
+if ($node) {
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ $codes = array_intersect(array_unique(array_filter(array_map('trim', explode(',', trim($node))))), $allowedCodes);
+ foreach ($codes as $code) {
+ $this->getConnection()->insertOnDuplicate(
+ $this->getTable('core/config_data'),
+ array(
+ 'scope' => 'default',
+ 'scope_id' => 0,
+ 'path' => 'crontab/jobs/' . $code . '/is_active',
+ 'value' => 0,
+ )
+ );
+ }
+}
+
+// Remove old config setting
+$this->getConnection()->delete(
+ $this->getTable('core/config_data'),
+ array(
+ 'scope = ?' => 'default',
+ 'scope_id = ?' => 0,
+ 'path = ?' => 'system/cron/disabled_crons'
+ )
+);
diff --git a/app/code/community/Aoe/Scheduler/etc/adminhtml.xml b/app/code/community/Aoe/Scheduler/etc/adminhtml.xml
old mode 100755
new mode 100644
index 2f072ea..0ebdd31
--- a/app/code/community/Aoe/Scheduler/etc/adminhtml.xml
+++ b/app/code/community/Aoe/Scheduler/etc/adminhtml.xml
@@ -8,9 +8,9 @@
1
- Schedule Configuration
+ Job Configuration10
- adminhtml/cron/index
+ adminhtml/job/indexList View
@@ -22,6 +22,11 @@
30adminhtml/timeline/index
+
+ Instructions
+ 40
+ adminhtml/instructions/index
+
@@ -49,6 +54,10 @@
Timeline View30
+
+ Instructions
+ 40
+
diff --git a/app/code/community/Aoe/Scheduler/etc/config.xml b/app/code/community/Aoe/Scheduler/etc/config.xml
old mode 100755
new mode 100644
index f2005d8..616d665
--- a/app/code/community/Aoe/Scheduler/etc/config.xml
+++ b/app/code/community/Aoe/Scheduler/etc/config.xml
@@ -2,7 +2,7 @@
- 0.4.4
+ 1.0.1
@@ -22,16 +22,24 @@
Aoe_Scheduler_Model
+ aoe_scheduler_resource
+
+ Aoe_Scheduler_Model_Resource
+
+
Aoe_Scheduler_Model_ObserverAoe_Scheduler_Model_Schedule
+
+
+
@@ -124,7 +132,7 @@
- aoe_scheduler/testTask::run
+ aoe_scheduler/task_test::run
@@ -133,8 +141,9 @@
system/cron/scheduler_cron_expr_heartbeat
- aoe_scheduler/heartbeatTask::run
+ aoe_scheduler/task_heartbeat::run
+ all
@@ -162,8 +171,3 @@
-
-
-
-
-
diff --git a/app/code/community/Aoe/Scheduler/etc/system.xml b/app/code/community/Aoe/Scheduler/etc/system.xml
old mode 100755
new mode 100644
index e884d65..f3ebc39
--- a/app/code/community/Aoe/Scheduler/etc/system.xml
+++ b/app/code/community/Aoe/Scheduler/etc/system.xml
@@ -17,16 +17,6 @@
0
-
-
- text
-
- 100
- 1
- 0
- 0
-
-
@@ -37,6 +27,16 @@
0
+
+
+
+ text
+ 111
+ 1
+ 0
+ 0
+
+
text
@@ -82,10 +82,10 @@
-
+
text170
-
+ 1
@@ -98,6 +98,15 @@
1
+
+
+
+ select
+ adminhtml/system_config_source_yesno
+ 200
+ 1
+
+
diff --git a/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/install-1.0.0.php b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/install-1.0.0.php
new file mode 100644
index 0000000..4fabacd
--- /dev/null
+++ b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/install-1.0.0.php
@@ -0,0 +1,78 @@
+startSetup();
+
+$tableName = $this->getTable('cron/schedule');
+
+$this->getConnection()->dropColumn(
+ $tableName,
+ 'parameters'
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'parameters',
+ "TEXT NULL COMMENT 'Serialized Parameters'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'eta',
+ "timestamp NULL DEFAULT NULL COMMENT 'Estimated Time of Arrival'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'host',
+ "varchar(255) NULL COMMENT 'Host running this job'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'pid',
+ "varchar(255) NULL COMMENT 'Process id of this job'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'progress_message',
+ "TEXT NULL COMMENT 'Progress message'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'last_seen',
+ "timestamp NULL DEFAULT NULL COMMENT 'Last seen'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'kill_request',
+ "timestamp NULL DEFAULT NULL COMMENT 'Kill Request'"
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'scheduled_by',
+ array(
+ 'type' => Varien_Db_Ddl_Table::TYPE_INTEGER,
+ 'unsigned' => true,
+ 'nullable' => true,
+ 'default' => null,
+ 'comment' => 'Scheduled by'
+ )
+);
+
+$this->getConnection()->addColumn(
+ $tableName,
+ 'scheduled_reason',
+ array(
+ 'type' => Varien_Db_Ddl_Table::TYPE_TEXT,
+ 'length' => 256,
+ 'nullable' => true,
+ 'default' => null,
+ 'comment' => 'Scheduled Reason'
+ )
+);
+
+$this->endSetup();
diff --git a/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.4.0-0.4.1.php b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.4.0-0.4.1.php
old mode 100755
new mode 100644
diff --git a/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.4.1-0.4.2.php b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.4.1-0.4.2.php
old mode 100755
new mode 100644
diff --git a/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.0-0.5.1.php b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.0-0.5.1.php
new file mode 100644
index 0000000..273c3b7
--- /dev/null
+++ b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.0-0.5.1.php
@@ -0,0 +1,23 @@
+startSetup();
+
+$installer->getConnection()->addColumn($installer->getTable('cron/schedule'), 'scheduled_by', array(
+ 'type' => Varien_Db_Ddl_Table::TYPE_INTEGER,
+ 'unsigned' => true,
+ 'nullable' => true,
+ 'default' => null,
+ 'comment' => 'Scheduled by'
+));
+
+$installer->getConnection()->addColumn($installer->getTable('cron/schedule'), 'scheduled_reason', array(
+ 'type' => Varien_Db_Ddl_Table::TYPE_TEXT,
+ 'length' => 256,
+ 'nullable' => true,
+ 'default' => null,
+ 'comment' => 'Scheduled Reason'
+));
+
+$installer->endSetup();
diff --git a/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.3-0.5.4.php b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.3-0.5.4.php
new file mode 100644
index 0000000..e97b18a
--- /dev/null
+++ b/app/code/community/Aoe/Scheduler/sql/aoescheduler_setup/mysql4-upgrade-0.5.3-0.5.4.php
@@ -0,0 +1,7 @@
+startSetup();
+
+$this->getConnection()->dropTable($this->getTable('cron_job'));
+
+$this->endSetup();
diff --git a/app/design/adminhtml/default/default/layout/aoe_scheduler/aoe_scheduler.xml b/app/design/adminhtml/default/default/layout/aoe_scheduler/aoe_scheduler.xml
old mode 100755
new mode 100644
index 7ed585c..57b32e1
--- a/app/design/adminhtml/default/default/layout/aoe_scheduler/aoe_scheduler.xml
+++ b/app/design/adminhtml/default/default/layout/aoe_scheduler/aoe_scheduler.xml
@@ -12,8 +12,7 @@
skin_js
-
+
+
+
+
+
+ */5 * * * *
+
+
+ my_module/job_hello::run
+
+
+
+
+
+
+```
+
+**Hint:** instead of hardcoding your schedule in '' you can use '' instead pointing to a configuration option that holds your schedule. This configuration option can be made avilable through 'System > Configuration'.
+On the other hand, Aoe Scheduler now let's you edit any job and overwrite any hardcoded schedule even if it wasn't pointing to a config path.
+
+TODO: Add complete list of xml tags here, with description (e.g. what's the run>model syntax...)!
+
+TODO: Add examples here of how to interact with Aoe_Scheduler through the $schedule object passed while calling the job.
\ No newline at end of file
diff --git a/doc/cron-configuration.md b/doc/cron-configuration.md
new file mode 100644
index 0000000..bc2d40d
--- /dev/null
+++ b/doc/cron-configuration.md
@@ -0,0 +1,15 @@
+cron.sh vs cron.php vs scheduler_cron.sh
+
+Recommendet frequency
+
+always vs default
+
+Not in webserver context (no wget php)
+
+How to correctly configure cron?
+Note: Correct user!
+Also check: http://www.magentocommerce.com/knowledge-base/entry/ce18-and-ee113-installing#install-cron
+NOT: http://stackoverflow.com/questions/5644037/setting-up-cron-job-in-magento?rq=1
+Add note to not run this via wget
+- cron is not supposed to run in web context
+ - different php settings, max_execution time, memory_limit (and don't increase these globally only to satisfy cron.php)
diff --git a/doc/cron-groups.md b/doc/cron-groups.md
new file mode 100644
index 0000000..e69de29
diff --git a/doc/declutter-timeline.md b/doc/declutter-timeline.md
new file mode 100644
index 0000000..9ce817c
--- /dev/null
+++ b/doc/declutter-timeline.md
@@ -0,0 +1,27 @@
+## Declutter your timeline view and optimize cron processing
+
+### Replace high frequency schedules with 'always'
+
+Some jobs come with a high frequency schedule like `* * * * *` (or strange enough some write it as `*/1 * * * *`). Even running a job every 5 minutes (`*/5 * * * *`) can be considered a high frequency.
+
+Depending on your cron configuration cron might not be even called that often which results on these schedules piling up. Luckily Aoe_Scheduler takes care of this (Mage_Cron doesn't!) and skips overlapping schedules while keeping and executing only a single one.
+
+But really what you these high frequency configuration are expressing is 'run me as often as possible' and this is exactly what the special cron expression 'always' was introduced for.
+
+A good candidate for this change is **core_email_queue_send_all**. Go to 'System > Scheduler > Job Configuration' and click on the core_email_queue_send_all row. Then go to the 'Cron expression' field and replace the value with 'always'.
+
+
+
+### Disable unused jobs
+
+Another candidate for this would be **newsletter_send_all**, but since you might not be sending newsletters from within Magento anyways you might want to disable this job completely:
+
+
+
+### Only keep 20 schedules
+
+Ideally everything works fine and you'll see only green bars in the timeline view. If you have too many jobs and decided to keep every schedule for a day or longer ("Success History Lifetime") your timeline view might take a while to load.
+
+Instead of cutting down the "Success History Lifetime" you can configure the "Maximum number of successful schedules to keep" value to 20 or so. This way only the last 20 successful schedules will be kept and the others will be cleaned up. Failed, skipped and missed (the red ones) schedules will stick around according to your "Failure History Lifetime" setting.
+
+
\ No newline at end of file
diff --git a/doc/deployment-integration.md b/doc/deployment-integration.md
new file mode 100644
index 0000000..7be6194
--- /dev/null
+++ b/doc/deployment-integration.md
@@ -0,0 +1,25 @@
+## How to integrate Aoe_Scheduler into you deployment process
+
+When deploying a new build to your server some tasks might still be running in the background. Here's a simple workflow to make a clean cut:
+
+```shell
+# Disable cron processing (here: using n98-magerun). This will not affect tasks that are currently running
+cd $rootDir && n98-magerun.phar config:set system/cron/enable 0
+
+# Flush all future schedules (so that no new schedule get's started)
+cd $rootDir/shell && php scheduler --action flushSchedules --mode future
+
+# Actively wait until current schedules finish for up to 1 minute (or longer if required):
+cd $rootDir/shell && php scheduler --action wait --timout 60
+
+# Kill all tasks that might still be running
+cd $rootDir/shell && php scheduler --action killAll
+
+# Deploy!
+
+# Enable cron processing (here: using n98-magerun)
+cd $rootDir && n98-magerun.phar config:set system/cron/enable 1
+
+# New schedules will automatically be generated before the next run...
+
+```
\ No newline at end of file
diff --git a/doc/domain-model.md b/doc/domain-model.md
new file mode 100644
index 0000000..465d3e0
--- /dev/null
+++ b/doc/domain-model.md
@@ -0,0 +1,4 @@
+Schedule Manager
+Process Manager
+Abstract Job
+Factory
diff --git a/doc/events.md b/doc/events.md
new file mode 100644
index 0000000..2150a71
--- /dev/null
+++ b/doc/events.md
@@ -0,0 +1,48 @@
+## Events
+
+### Before a schedule run
+
+* `cron_[job_code]_before`
+ * array('schedule' => $schedule)
+* `cron_before`
+ * array('schedule' => $schedule)
+
+### After a schedule run
+
+These events will always be dispatched, no matter of the resulting status of the schedule
+
+* `cron_[job_code]_after`
+ * array('schedule' => $schedule)
+* `cron_after`
+ * array('schedule' => $schedule)
+
+Events dispatched after successful completion only
+
+* `cron_[job_code]_after_success`
+ * array('schedule' => $schedule)
+* `cron_after_success`
+ * array('schedule' => $schedule)
+
+Events dispatched after the schedule reported it did 'nothing';
+
+* `cron_[job_code]_after_nothing`
+ * array('schedule' => $schedule)
+* `cron_after_nothing`
+ * array('schedule' => $schedule)
+
+
+Events dispatched after an error has happened
+
+* `cron_[job_code]_after_error`
+ * array('schedule' => $schedule)
+* `cron_after_error`
+ * array('schedule' => $schedule)
+
+
+
+### On Excpetions
+
+* cron_[job_code]_exception
+ * array('schedule' => $schedule, 'exception' => $e)
+* cron_exception
+ * array('schedule' => $schedule, 'exception' => $e)
\ No newline at end of file
diff --git a/doc/faq.md b/doc/faq.md
new file mode 100644
index 0000000..63e1e20
--- /dev/null
+++ b/doc/faq.md
@@ -0,0 +1,80 @@
+## Frequently asked questions
+
+### Is there a way to run a single job like at the scheduler configuration with selecting the job and start "run now" via URL or something like that?
+
+Please read the answer on why "run now" is a bad idea generally.
+In addition to that it's currently not possible to trigger an individual job via an url. While in most setups it is possible to hit cron.php via the webserver this is also not recommended.
+
+If you need to address a specific job dynamically please use the Magento webservice API that gives you access to scheduling jobs. But even that is not a single url you can hit.
+
+Adding this feature to Aoe_Scheduler is not a big deal, but in order to make this a safe operation we'd have to think about signed urls or adding another form of authentication (e.g. through special headers or additional POST data).
+
+Check out the documentation (currently here: http://www.fabrizio-branca.de/magento-cron-scheduler.html) on how to use the webservice api.
+
+### Why is "run now" a bad idea and what should I use instead?
+
+"Run now" should only be used in a cli context. That's why never versions Aoe_Scheduler disable the use of runNow from the web service API and the Magento admin by default. Instead of "run now" you should use "schedule now" which will result in a task to be scheduled and then being picked from the regular cron and processed in the correct cli context.
+Running a job in the context of the webserver is generally a bad idea since you could run into memory limit out timeout issues. Cron tasks are designed to run from cli and will usually run longer than 30 sec. Increasing your webservers memory limit and maximum execution time is also not a good idea.
+
+### After removing module XYZ I'm seeing an error. What can I do?
+
+Most likely you didn't remove all files that belonged this module and/or didn't clean the cache. The error happens if the job is still configured in config xml (config/crontab/jobs) and scheduler tries to excute it by calling the configured model class that doesn't exist anymore. Please make sure that the module is removed cleanly.
+Starting from Aoe_Scheduler version 0.5 (still under development and not merged to master) these situations are handled a lot better without scheduler. Let me know if you're still experiencing this problem with Aoe_Scheduler >= 0.5.
+
+### I'm getting 'Too late for the schedule' errors.
+
+This happens when the scheduler finds pending jobs that were supposed to be scheduled longer than the time configured in 'system/cron/schedule_lifetime'. By default this value is set to 15 minutes.
+
+There are two different problems the may result in you seeing this error:
+
+1. Cron isn't configured to run often enough:
+If you don't trigger cron often enough then the tasks start piling up and most likely tasks will be too late for schedule at the point when they're being executed by the scheduler. Instead of increasing the scheduler_lifetime settings you should increase the frequency cron is being called to `*/5 * * * *` (every 5 minutes) or even `* * * * *` (every minute).
+
+2. You have long running cron jobs that will block the execution of other jobs:
+In case you're importing data, indexing products, generating reports or doing other long-running jobs via cron (which is generally a good idea) other jobs will not be run in parallel (unless you're running `cron.php` instead of `cron.sh`). This will result in these jobs not being executed. Find out which jobs are preventing others from running (by looking at the timeline view) and run them in a different *cron group*. ([look at this](http://www.slideshare.net/aoemedia/magento-imagine-2013fabriziobranca/38) for more information and check the features added to version >0.5.0 for an easier way to configure and manage cron groups.
+
+### My hoster doesn't allow me to run cron more than x times per hour or at all.
+
+Then your hoster might not be a good choice for Magento :) Although possible, please don't start triggering `cron.php` via HTTP through a third-party cron service.
+
+### Should I use `cron.sh` or `cron.php`?
+
+`cron.sh`!
+
+(TODO: Add more information here)
+
+Even better: `scheduler_cron.sh` from the Aoe_Scheduler module (not merged to master yet). TODO: Add documentation
+
+### What's the difference between an *always* job and a normal one?
+
+...
+
+### How does this work if I'm running multiple webservers?
+
+This is not so much a question about Aoe_Scheduler, but an issue with Magento's cron in general. `cron.sh` does check if there's already another process running, but can only check the current server. Usually you want to avoid running multiple cron.sh in parallel since you could run into race conditions between tasks being executed on different servers. If you have full control over all your servers just pick one and configure cron there and skip this on all the other servers. If you're running Magento on an auto-scaling environment where there's no "master" instance you could dynamically make an instance the "master" instance by having the instance compare it's hostname to a sorted list of all hostnames in that auto-scaling group and only run if it's the first one. Here's an example of how I'm doing this on Aws OpsWorks: https://github.com/fbrnc/opsworks-cookbooks/blob/200a70b07b59e1b5cbed1c612bc064c04a7c0025/magentostack/recipes/configure_magento.rb#L68-L82
+
+### What's the difference between `runNow` and `scheduleNow`?
+
+`scheduleNow` will create a new jobs and uses the current timestamp for the scheduled_at field. The next cron run will pick this task up and execute it exactly like if it was scheduled by the Magento Scheduler in the first place.
+`runNow` instead will go ahead and execute the cron task right away in the same request or script it has been called. While this is very convenient while developing it comes with a number of problems:
+
+- `runNow` might not be called in the correct context. Normally a cron task is being executed in the 'global' scope, while runNow will execute that job in the context of adminhtml when triggered wie the Magento backend or even in the scope of a frontend store when being executed through the webservice api. The only safe way to use 'runNow' is when it's triggered via the cli script it comes with.
+- In many cases cron tasks are meant to be background processes that can potentially run for a long time or consume a lot of memory. Running a task via your webserver in the context of a web request will could result in failing because a timeout or a memory limit is reached.
+- In many cases cron tasks are not designed to run in parallel (race conditions,...). Cron will take care of running jobs sequentially (unless you use the cron group feature and you know what you're doing). Running the job directly doesn't offer this protection.
+- Ideally your webserver user is the same user that also executes cron. If that's not the case you might run into problem with files being generated in cron tasks not having sufficient permissions for the next run from a different environment.
+
+Because of the reasons mentioned above newer versions of Aoe_Scheduler ship with the "runNow" feature being disabled by default. In case you know what you're doing you're welcome to enable this feature in the configuration.
+
+### I've uninstalled a module that introduced cron jobs and now I'm gettings error messages. What's going on?
+
+TODO...
+
+### Will this work in CE and EE?
+
+TODO...
+
+### Will this work in version x?
+
+TODO...
+
+### Will this work in version Windows?
\ No newline at end of file
diff --git a/doc/heartbeat.md b/doc/heartbeat.md
new file mode 100644
index 0000000..19e225a
--- /dev/null
+++ b/doc/heartbeat.md
@@ -0,0 +1,36 @@
+## Heartbeat
+
+The heartbeat is a simple job that doesn't do anything except helping you to verify that your Magento instance is configured correctly.
+
+If everything is ok it will show a notice an all Aoe_Scheduler admin interfaces. If you're not seeing this message please check out the [instructions module](instructions.md) and fund some more information on how to [configure cron](cron-configuration.md) in this manual.
+
+
+
+### Monitoring
+
+Sometimes - for various reasons - Magento's scheduler might stop working. Often there are business critical tasks that need to be run on a regular basis, so there's a need in monitoring the if everything works fine behind the scenes. That's why I added a new dummy job "Heartbeat". By default it runs every 5 minutes. This can be configured or even deactivated completely. This job does nothing but showing that the scheduler is working correctly.
+
+In addition to that there is a new shell command that allows you the check when a task was run successfully the last time (works for all scheduler job - not only for the heartbeat job):
+
+```
+> php scheduler.php -action lastRun -code aoescheduler_heartbeat
+1327960203
+```
+
+By adding the "-secondsFromNow" parameter you'll get the duration since the last execution:
+
+```
+> php scheduler.php -action lastRun -code aoescheduler_heartbeat -secondsFromNow
+35
+```
+
+So you can use this to integrate your instance to whatever monitoring you're using. Using the default configuration the last value must not be bigger than 5x60 = 300 seconds. If it is, there's something wrong with your scheduler.
+
+### Check any job
+
+If you have any other critical job you can check specifically check when this job ran as well:
+```
+> php scheduler.php -action lastRun -code mymodule_helloworld
+1327960263
+```
+
diff --git a/doc/images/Aoe_Scheduler.jpg b/doc/images/Aoe_Scheduler.jpg
new file mode 100644
index 0000000..c301e79
Binary files /dev/null and b/doc/images/Aoe_Scheduler.jpg differ
diff --git a/doc/images/Aoe_Scheduler_Icon.png b/doc/images/Aoe_Scheduler_Icon.png
new file mode 100644
index 0000000..636646d
Binary files /dev/null and b/doc/images/Aoe_Scheduler_Icon.png differ
diff --git a/doc/images/always.png b/doc/images/always.png
new file mode 100644
index 0000000..8096c0a
Binary files /dev/null and b/doc/images/always.png differ
diff --git a/doc/images/cronsh_cronphp.jpg b/doc/images/cronsh_cronphp.jpg
new file mode 100644
index 0000000..b7c6ff5
Binary files /dev/null and b/doc/images/cronsh_cronphp.jpg differ
diff --git a/doc/images/disabled.png b/doc/images/disabled.png
new file mode 100644
index 0000000..1590727
Binary files /dev/null and b/doc/images/disabled.png differ
diff --git a/doc/images/heartbeat.png b/doc/images/heartbeat.png
new file mode 100644
index 0000000..234907e
Binary files /dev/null and b/doc/images/heartbeat.png differ
diff --git a/doc/images/instructions.png b/doc/images/instructions.png
new file mode 100644
index 0000000..146653d
Binary files /dev/null and b/doc/images/instructions.png differ
diff --git a/doc/images/job_schedule.png b/doc/images/job_schedule.png
new file mode 100644
index 0000000..ebc8fd4
Binary files /dev/null and b/doc/images/job_schedule.png differ
diff --git a/doc/images/listview.png b/doc/images/listview.png
new file mode 100644
index 0000000..06af75b
Binary files /dev/null and b/doc/images/listview.png differ
diff --git a/doc/images/maxschedules.png b/doc/images/maxschedules.png
new file mode 100644
index 0000000..75bb220
Binary files /dev/null and b/doc/images/maxschedules.png differ
diff --git a/doc/images/system_configuration.png b/doc/images/system_configuration.png
new file mode 100644
index 0000000..e6ab4ae
Binary files /dev/null and b/doc/images/system_configuration.png differ
diff --git a/doc/images/timeline.png b/doc/images/timeline.png
new file mode 100644
index 0000000..9a6268c
Binary files /dev/null and b/doc/images/timeline.png differ
diff --git a/doc/images/timeline2.jpg b/doc/images/timeline2.jpg
new file mode 100644
index 0000000..e2f096f
Binary files /dev/null and b/doc/images/timeline2.jpg differ
diff --git a/doc/images/uml_diagram.jpg b/doc/images/uml_diagram.jpg
new file mode 100644
index 0000000..616f474
Binary files /dev/null and b/doc/images/uml_diagram.jpg differ
diff --git a/doc/images/webservice_role.png b/doc/images/webservice_role.png
new file mode 100644
index 0000000..a333092
Binary files /dev/null and b/doc/images/webservice_role.png differ
diff --git a/doc/installation.md b/doc/installation.md
new file mode 100644
index 0000000..d22ff36
--- /dev/null
+++ b/doc/installation.md
@@ -0,0 +1,38 @@
+## Installation
+
+**NOTE:** Running Aoe_Scheduler requires you to also setup Magento's cron. If you haven't already done this please also check out [this section on how to configure cron](cron-configuration.md)
+
+For general information on how to install a Magento module using composer/modman, by copying it of via Magento connect please read this post:
+[http://fbrnc.net/blog/2014/11/how-to-install-a-magento-module](http://fbrnc.net/blog/2014/11/how-to-install-a-magento-module)
+
+### Composer
+
+Aoe_Scheduler is registered on [Packagist.org](https://packagist.org/packages/aoepeople/aoe_scheduler) so you don't have to add any additional repositories to you composer.json file:
+
+Install Aoe_Scheduler using the [Hackathon Composer Installer](https://github.com/magento-hackathon/magento-composer-installer) - Read [Option 4.a in this blog post](http://fbrnc.net/blog/2014/11/how-to-install-a-magento-module)
+
+```json
+{
+ "minimum-stability": "dev",
+ "require": {
+ "aoepeople/aoe_scheduler": "1.0.*"
+ }
+}
+```
+
+If you want to use the AOEPeople Composer installer instead (and manually run modman afterwards) use this snippet (Read [Option 4.b in this blog post](http://fbrnc.net/blog/2014/11/how-to-install-a-magento-module)):
+
+```json
+{
+ "minimum-stability": "dev",
+ "require": {
+ "aoepeople/composer-installers": "dev-master",
+ "aoepeople/aoe_scheduler": "1.0.*"
+ }
+}
+```
+
+### Download and extract
+
+Of course you can also [download the zip or tar.gz file](https://github.com/AOEpeople/Aoe_Scheduler/releases) and extract it into your project webroot. While this is **not recommended (especially not on a production environment!)** this might be the easiest way to test Aoe_Scheduler if your not familiar with Composer and modman and don't feel like exploring it (you should! :)
+
diff --git a/doc/instructions.md b/doc/instructions.md
new file mode 100644
index 0000000..b22d791
--- /dev/null
+++ b/doc/instructions.md
@@ -0,0 +1,10 @@
+## Instructions
+
+Find the instructions interface in `System > Scheduler > Instructions`
+
+This provides an interactive interface helping you to create the cron configuration based on your current Magento installation and other preferences.
+
+Find more information on how to setup cron [here](doc/cron-configuration.md).
+
+
+
diff --git a/doc/job-configuration.md b/doc/job-configuration.md
new file mode 100644
index 0000000..d432b7f
--- /dev/null
+++ b/doc/job-configuration.md
@@ -0,0 +1,2 @@
+Edit and create jobs
+Explain overlay mechanism
\ No newline at end of file
diff --git a/doc/list-view.md b/doc/list-view.md
new file mode 100644
index 0000000..db5527b
--- /dev/null
+++ b/doc/list-view.md
@@ -0,0 +1,8 @@
+
+## List View
+
+Find the list view in `System > Scheduler > List View`
+
+
+
+The list view shows you all schedules in a grid allowing you to filter the grid by job code, status or any other schedule field.
\ No newline at end of file
diff --git a/doc/monitoring.md b/doc/monitoring.md
new file mode 100644
index 0000000..ff613d1
--- /dev/null
+++ b/doc/monitoring.md
@@ -0,0 +1,5 @@
+## Monitoring
+
+CLI/Webservice
+
+lastRun
\ No newline at end of file
diff --git a/doc/process-management.md b/doc/process-management.md
new file mode 100644
index 0000000..c042c79
--- /dev/null
+++ b/doc/process-management.md
@@ -0,0 +1,3 @@
+- last seen
+- pid...
+- kill job
\ No newline at end of file
diff --git a/doc/processing.md b/doc/processing.md
new file mode 100644
index 0000000..e88e506
--- /dev/null
+++ b/doc/processing.md
@@ -0,0 +1 @@
+Explain workflow from sh -> php -> events,...
\ No newline at end of file
diff --git a/doc/programmatically.md b/doc/programmatically.md
new file mode 100644
index 0000000..1c55437
--- /dev/null
+++ b/doc/programmatically.md
@@ -0,0 +1,19 @@
+## Schedule a job programmatically
+
+```
+$schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
+$schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_SCHEDULENOW_CLI);
+$schedule->setJobCode($code);
+$schedule->schedule();
+$schedule->save();
+```
+
+## Run a job programmatically
+
+```
+$schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
+$schedule->setJobCode($code);
+$schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_RUNNOW_CLI);
+$schedule->runNow(false);
+$schedule->save();
+```
\ No newline at end of file
diff --git a/doc/readme_old.md b/doc/readme_old.md
new file mode 100644
index 0000000..88fb47f
--- /dev/null
+++ b/doc/readme_old.md
@@ -0,0 +1,118 @@
+
+
+# AOE Scheduler for Magento
+
+
+
+## Installation
+
+
+
+see http://www.fabrizio-branca.de/magento-cron-scheduler.html
+
+Running multiple scheduler jobs in parallel
+-------------------------------------------
+
+*INFO*: Running jobs in parallel like this is outdated. Please check the usage of scheduler_cron.sh below.
+
+Running multiple scheduler jobs in parallel is quite handy when you have some jobs which take a long time to run,
+and are not crucial for shop to run properly. En excample could be a job which generates some kind of reports.
+Magento cron.sh script detects if there is some job already running by parsing output of "ps" command.
+If not, it executes cron.php file.
+So to run multiple schedulers in parallel we have to use different file name than cron.php.
+Additionally we want to run only few jobs with second cron task, and exclude them from the original scheduler job.
+Aoe Scheduler comes with whitelist/blacklist feature enabling you to do so.
+
+1. symlink cron.php to cron2.php
+2. add crontab configuration (crontab -e) like this:
+
+```
+* * * * * /usr/bin/env SCHEDULER_BLACKLIST='job_key1,job_key2' /bin/sh /home/webapps/htdocs/cron.sh
+* * * * * /usr/bin/env SCHEDULER_WHITELIST='job_key1,job_key2' /bin/sh /home/webapps/htdocs/cron.sh cron2.php
+```
+
+cron.sh script takes name of the php script to run as a parameter (by default it is cron.php).
+This way the first cron job will execute all scheduler jobs except job_key1 and job_key2, and the second one will execute only them.
+
+
+scheduler_cron.sh vs cron.sh
+----------------------------
+Aoe_Scheduler introduces a new shell script acting as an endpoint to execute cron.
+
+This new endpoint supports including and excluding groups of crons and manages the parallel execution of cron groups.
+
+scheduler_cron.sh then will call shell/scheduler.php --action cron with the correct mode and options parameters instead of running cron.php
+Managing multiple configuration this way is much cleaner and easier to understand.
+
+scheduler_cron.sh or shell/scheduler.php --action cron will not do any shell_exec to run the different modes in subtasks. It's up to you to configure
+multiple OS level crontasks to trigger these individually.
+
+TODO: Add more information and example code.
+
+Parameters:
+* `--mode [always|default]`
+* `--excludeJobs [comma-separated list of job names]` (deprecated!)
+* `--includeJobs [comma-separated list of job names]` (deprecated!)
+* `--excludeGroups [comma-separated list of cron group names]`
+* `--includeGroups [comma-separated list of cron group names]`
+
+How to define a cron group
+--------------------------
+
+### Via XML
+
+```
+
+ ...
+ ...
+ my_group
+
+```
+
+### Or in a the group field of a record
+
+TODO: add screenshot here.
+
+Configuring crontask
+--------------------
+
+Please remember to add the following configuration to the webserver user's crontab in order to avoid file permission issues with files that are being generated or need to be accessed from different contexts!
+
+### Split always and default:
+
+```
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode always
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode default
+```
+
+### Prepend check for maintenance.flag:
+
+```
+* * * * * ! test -e /var/www/magento/current/htdocs/maintenance.flag && ...
+```
+
+### Configure multiple cron groups
+
+This way you can distribute the jobs on different servers. Also this allows you to control which jobs can run in parallel and which don't. Within a cron group only one job will run at a time, while jobs from multiple cron groups might and will run at the same time
+
+```
+# Always tasks
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode always --includeGroups my_queue_jobs
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode always --excludeGroups my_queue_jobs
+
+# Default tasks
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode default --includeGroups groupA,groupB
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode default --includeGroups groupC
+* * * * * /bin/bash /var/www/magento/current/htdocs/scheduler_cron.sh --mode default --excludeGroups groupA,groupB,groupC
+```
+
+If splitting jobs across multiple groups please double check you have every job covered in one of the includeGroups or excludeGroups list.
+
+Watchdog
+--------
+
+Please configure an additional cron for the watchdog. This will ensure that locked up jobs are being cleaned up even if every single cron process is locked.
+
+```
+*/10 * * * * /usr/bin/php /var/www/magento/current/htdocs/shell/scheduler.php --action watchdog
+```
\ No newline at end of file
diff --git a/doc/states.md b/doc/states.md
new file mode 100644
index 0000000..d4f7468
--- /dev/null
+++ b/doc/states.md
@@ -0,0 +1,28 @@
+
+## Schedule status
+
+### Default states (Mage_Cron_Model_Schedule)
+
+* STATUS_PENDING = 'pending';
+* STATUS_RUNNING = 'running';
+* STATUS_SUCCESS = 'success';
+* STATUS_MISSED = 'missed';
+* STATUS_ERROR = 'error';
+
+### Additional states (Aoe_Scheduler_Model_Schedule
+
+* STATUS_KILLED = 'killed';
+* STATUS_DISAPPEARED = 'gone';
+* STATUS_DIDNTDOANYTHING = 'nothing';
+
+TODO:
+- Explain all states
+- Convert this into a table?
+
+### How to report a state back?
+
+Only success, error and nothing can be actively reported back. The other states are being determined by the scheduler.
+
+Default state: success
+
+Simple way: Prepend return value with 'ERROR:' or 'NOTHING:'
\ No newline at end of file
diff --git a/doc/system-configuration.md b/doc/system-configuration.md
new file mode 100644
index 0000000..9b4da28
--- /dev/null
+++ b/doc/system-configuration.md
@@ -0,0 +1,11 @@
+
+## System Configuration
+
+Find the configuration in `System > Configuration > System > Cron (Scheduled Tasks)
+
+
+
+### Configuration Options
+
+TODO: Walk through all configuration parameters here and advice what settings to use
+
diff --git a/doc/tests.md b/doc/tests.md
new file mode 100644
index 0000000..7821ece
--- /dev/null
+++ b/doc/tests.md
@@ -0,0 +1,9 @@
+## Tests
+
+Add some information on how to run tests (e.g. with MageTestStand).
+
+Note: since some of the tests are integration tests and I want to check if cron is processing jobs correctly a separate test database can't be used (since cron.sh and the other scripts wouldn't find any scheduled jobs).
+
+Don't run the test on production since the schedules table will be flushed and new cron jobs might be created during the tests.
+
+MageTestStand currently doesn't support preparing EcomDev_Phpunit to allow running tests on the same database.
\ No newline at end of file
diff --git a/doc/timeline.md b/doc/timeline.md
new file mode 100644
index 0000000..396672b
--- /dev/null
+++ b/doc/timeline.md
@@ -0,0 +1,7 @@
+## Timeline view
+
+Find the timeline view under `System > Scheduler > Timeline View`
+
+
+
+TODO: Cleanup schedules (keep last x)
\ No newline at end of file
diff --git a/doc/web-services.md b/doc/web-services.md
new file mode 100644
index 0000000..4d4b513
--- /dev/null
+++ b/doc/web-services.md
@@ -0,0 +1,79 @@
+## Web Services
+
+### Usage example
+
+1. Create a web service **user role**:
+Go to `System > Web Services -> Roles -> Role Resources` and set "Resource Access" to "all" or to "Custom" and select the specific options you want to grant to your web services user:
+
+
+2. Create a web service user and assign him to the previously created role (`System > Web Services > Users`)
+
+3. Now you can access some scheduler functions (more might follow soon) via web service api. Currently only API v1 is implemented.
+
+
+```php
+login('your_username', 'your_api_key');
+
+// Run a scheduler task
+$result = $client->call($session, 'aoe_scheduler.runNow', array('aoecachecleaner'));
+var_dump($result);
+ /*
+ array(7) {
+ ["job_code"]=>
+ string(15) "aoecachecleaner"
+ ["status"]=>
+ string(7) "success"
+ ["created_at"]=>
+ string(19) "2011-11-15 20:55:41"
+ ["scheduled_at"]=>
+ string(19) "2011-11-15 20:55:41"
+ ["executed_at"]=>
+ string(19) "2011-11-15 20:55:41"
+ ["finished_at"]=>
+ string(19) "2011-11-15 20:55:41"
+ ["schedule_id"]=>
+ string(6) "150006"
+ }
+ */
+
+// Schedule a task to run (from a normal scheduler process) as soon a possible ...
+$result = $client->call($session, 'aoe_scheduler.schedule', array('aoecachecleaner'));
+// ... or at a given time (e.g. in 1 hour):
+// $result = $client->call($session, 'aoe_scheduler.schedule', array('aoecachecleaner', time()+60*60));
+var_dump($result);
+ /*
+ array(5) {
+ ["job_code"]=>
+ string(15) "aoecachecleaner"
+ ["status"]=>
+ string(7) "pending"
+ ["created_at"]=>
+ string(19) "2011-11-15 21:06:07"
+ ["scheduled_at"]=>
+ string(19) "2011-11-15 21:06:07"
+ ["schedule_id"]=>
+ string(6) "150007"
+ }
+ */
+
+// Get information on an existing task
+$result = $client->call($session, 'aoe_scheduler.info', array('150007'));
+var_dump($result);
+ /*
+ array(5) {
+ ["job_code"]=>
+ string(15) "aoecachecleaner"
+ ["status"]=>
+ string(7) "pending"
+ ["created_at"]=>
+ string(19) "2011-11-15 21:06:07"
+ ["scheduled_at"]=>
+ string(19) "2011-11-15 21:06:07"
+ ["schedule_id"]=>
+ string(6) "150007"
+ }
+ */
+```
\ No newline at end of file
diff --git a/modman b/modman
index 4c7b77f..035173a 100644
--- a/modman
+++ b/modman
@@ -7,3 +7,4 @@ app/locale/en_US/template/email/aoe_scheduler/ app/locale/en_US/template/ema
app/design/adminhtml/default/default/template/aoe_scheduler/ app/design/adminhtml/default/default/template/aoe_scheduler/
app/design/adminhtml/default/default/layout/aoe_scheduler/ app/design/adminhtml/default/default/layout/aoe_scheduler/
skin/adminhtml/default/default/aoe_scheduler/ skin/adminhtml/default/default/aoe_scheduler/
+scheduler_cron.sh scheduler_cron.sh
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..92dd907
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,27 @@
+
+
+ Magento extension ruleset based on PSR-2 but modified for Magento 1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/readme.md b/readme.md
old mode 100755
new mode 100644
index 468686f..aecf737
--- a/readme.md
+++ b/readme.md
@@ -1,24 +1,133 @@
-AOE Scheduler for Magento
-=========================
-see http://www.fabrizio-branca.de/magento-cron-scheduler.html
-
-Running multiple scheduler jobs in parallel
--------------------------------------------
-Running multiple scheduler jobs in parallel is quite handy when you have some jobs which take a long time to run,
-and are not crucial for shop to run properly. En excample could be a job which generates some kind of reports.
-Magento cron.sh script detects if there is some job already running by parsing output of "ps" command.
-If not, it executes cron.php file.
-So to run multiple schedulers in parallel we have to use different file name than cron.php.
-Additionally we want to run only few jobs with second cron task, and exclude them from the original scheduler job.
-Aoe Scheduler comes with whitelist/blacklist feature enabling you to do so.
-
-1. symlink cron.php to cron2.php
-2. add crontab configuration (crontab -e) like this:
-
-```
-* * * * * /usr/bin/env SCHEDULER_BLACKLIST='job_key1,job_key2' /bin/sh /home/webapps/htdocs/cron.sh
-* * * * * /usr/bin/env SCHEDULER_WHITELIST='job_key1,job_key2' /bin/sh /home/webapps/htdocs/cron.sh cron2.php
-```
-
-cron.sh script takes name of the php script to run as a parameter (by default it is cron.php).
-This way the first cron job will execute all scheduler jobs except job_key1 and job_key2, and the second one will execute only them.
\ No newline at end of file
+
+
+# AOE Scheduler for Magento
+
+[](https://travis-ci.org/AOEpeople/Aoe_Scheduler)
+
+**Note: This is a release candidate of version 1.0.0! Please read the [changelog](changelog.md) and carefully test everything on a non-production environment before rolling this out to production. The final stable version will be released March 15th, 2015.**
+
+AOE Scheduler sits on top of Magento's default cron functionality allowing you to manage the jobs, to visualize the timeline and to get some deeper insight on what's going on behind the scenes and to shed some light on what might be going wrong. On top of that AOE Scheduler provides some more functionality like a cli and a web service interface, optimizing cron execution on your server and giving you everything you need to implement complex background tasks including for your Magento store.
+
+
+
+## NOTE
+
+This documentation is currently being written. Sadly, at this point it's still more an outline and some bullet points than a complete documentation. I'm working on it. If you have any comments feel free to [get in touch with me](https://twitter.com/fbrnc).
+
+## Changelog
+
+Version 1.0.0 is a major release. If you're updating from version 0.X please check out the changelog and verify everything is still working as expected after updating.
+
+[Changelog](changelog.md)
+
+## Features
+
+- **Timeline visualization**: The timeline view visualizes all past, current and future jobs showing their status, results, the runtime and some more details.
+- **Cron Management**: Find a list of all jobs defined in the Magento core or in any module installed. You can enable or disable individual jobs, modify them (e.g. edit their schedule) or even create new crons from scratch
+- **Parameterized Crons**: Sometimes a simple cron run isn't enough. You might want to use the same cron but with different parameters. Example: Use this to create daily reports and weekly reports with the same job, but different input parameters.
+- **Process Management**: Check if jobs are actually still running and kill them through Aoe_Scheduler if required.
+- **Cron groups**: Split you crons into different groups so you can run them in parallel or distribute them on multiple servers.
+- **Clean API**
+ - **Cli**
+ - **Web Service API**
+ - **Developer API**: Create/run/schedule jobs programmatically. Use events to create workflows between jobs.
+- **Instructions**: A new admin modules assists you in settings up your cron configuration.
+- **Monitoring**: Heartbeat, Watchdog, last-seen, verification
+- **Compatible with Magento's native cron scheduler**
+- **Manuel scheduling and running**: Schedule or run your jobs manually or programmatically. This comes in handly during development or if you have actions that might have to be triggered manually at times (e.g. re-import product catalog, re-run statistics,...)
+
+
+## Authors, contributors and maintainers
+
+Author:
+- [Fabrizio Branca](https://twitter.com/fbrnc)
+
+Major Contributions:
+- [Lee Saferite](https://twitter.com/leesaferite)
+- For a full list of contributors visit [AOE Scheduler on GitHub](https://github.com/AOEpeople/Aoe_Scheduler/graphs/contributors)
+
+## Ideas, bugs, contributions, comments, feature suggestions?
+
+Please get in touch with us via the [issue tracker on GitHub](https://github.com/AOEpeople/Aoe_Scheduler/issues)
+
+## Compability
+
+- PHP:
+ - 5.3
+ - 5.4
+ - 5.5
+- Magento CE:
+ - 1.6.2.0
+ - 1.7.0.2
+ - 1.8.0.0
+ - 1.8.1.0
+ - 1.9.0.1
+ - 1.9.1.0
+- Magento EE:
+ - 1.11.0.0
+ - 1.11.0.2
+ - 1.11.1.0
+ - 1.11.2.0
+ - 1.12.0.0
+ - 1.12.0.1
+ - 1.12.0.2
+ - 1.13.0.2
+ - 1.13.1.0
+ - 1.14.0.1
+ - 1.14.1.0
+- Operating System: Linux
+
+## Documentation
+
+1. [Module Installation](doc/installation.md)
+1. [Cron Configuration](doc/cron-configuration.md)
+1. [Some Basics (Job? Schedule? Task?)](doc/basics.md)
+1. [Creating new jobs](doc/create-job.md)
+1. [Faq](doc/faq.md)
+1. Admin Interfaces
+ 1. [System Configuration](doc/system-configuration.md)
+ 1. [Job Configuration](doc/job-configuration.md)
+ 1. [List View](doc/list-view.md)
+ 1. [Timeline View](doc/timeline.md)
+ 1. [Instructions](doc/instructions.md)
+1. [Events](doc/events.md)
+1. [Schedule States](doc/states.md)
+1. [CLI](doc/cli.md)
+1. [Web Services](doc/web-services.md)
+1. [Domain Model](doc/domain-model.md)
+1. [Cron Processing](doc/processing.md)
+1. [Unit Tests](doc/tests.md)
+1. Features
+ 1. [Heartbeat and Monitoring](doc/heartbeat.md)
+ 1. [Notifications](doc/notifications.md)
+ 1. [Custom job parameters](doc/custom-job-parameters.md)
+ 1. [Global enabled/disable](doc/global-enable-disable.md)
+ 1. [Disable individual jobs](doc/disable-individual-jobs.md)
+ 1. [runNow](doc/run-now.md)
+ 1. [scheduleNow](doc/schedule-now.md)
+ 1. [Run return values and communication](doc/communication.md)
+ 1. [ETA](doc/eta.md)
+ 1. [Watchdog](doc/watchdog.md)
+ 1. [Cron groups](doc/cron-groups.md)
+ 1. [Process Management](doc/process-management.md)
+ 1. [Output buffering](doc/output-buffering.md)
+1. Cookbook
+ 1. [How to declutter your timeline](doc/declutter-timeline.md)
+ 1. [How to integrate into deployments](doc/deployment-integration.md)
+ 1. [Distributed cron](doc/distributed.md)
+ 1. [Job workflows](doc/job-workflows.md)
+ 1. [Schedule a job programmatically](doc/programmatically.md)
+
+
+## License
+
+[GPL v3](LICENSE.txt)
+
+## Links
+
+- [Aoe Scheduler on Magento Connect](http://www.magentocommerce.com/magento-connect/aoe-scheduler.html)
+- [Aoe Scheduler on Travis CI](https://travis-ci.org/AOEpeople/Aoe_Scheduler)
+- [Aoe Scheduler on Packagist](https://packagist.org/packages/aoepeople/aoe_scheduler)
+- Blog posts
+ - [Magento Cron Demystified (www.webguys.de)](http://www.webguys.de/magento/tuerchen-08-magento-cron-demystified/)
+ - [Magento Cron Scheduler (fbrnc.net)](http://fbrnc.net/blog/2011/03/magento-cron-scheduler)
diff --git a/scheduler_cron.sh b/scheduler_cron.sh
new file mode 100755
index 0000000..4cda36d
--- /dev/null
+++ b/scheduler_cron.sh
@@ -0,0 +1,113 @@
+#!/bin/bash
+
+# Exit when any command returns an error status
+set -o errexit
+
+# Generate an error if any variable doesn't exist
+set -o nounset
+
+# Location of the php binary
+PHP_BIN=$(which php || true)
+if [ -z "${PHP_BIN}" ]; then
+ echo "Could not find a binary for php" 1>&2
+ exit 1
+fi
+
+# Location of the md5sum binary
+MD5SUM_BIN=$(which md5sum || true)
+if [ -z "${MD5SUM_BIN}" ]; then
+ echo "Could not find a binary for md5sum" 1>&2
+ exit 1
+fi
+
+# Absolute path to Magento installation shell scripts
+DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")/shell" && pwd)
+if [[ -z "${DIR}" || ! -d "${DIR}" ]]; then
+ echo "Could not resolve base shell directory" 1>&2
+ exit 1
+fi
+
+# The scheduler.php script
+SCHEDULER="scheduler.php"
+if [[ ! -e "${DIR}/${SCHEDULER}" || ! -r "${DIR}/${SCHEDULER}" ]]; then
+ echo "Could not find scheduler.php script" 1>&2
+ exit 1
+fi
+
+# Defaults
+MODE="default"
+INCLUDE_GROUPS=""
+EXCLUDE_GROUPS=""
+INCLUDE_JOBS=""
+EXCLUDE_JOBS=""
+
+# Parse command line args (very simplistic)
+while [ $# -gt 0 ]; do
+ case "$1" in
+ --mode)
+ MODE=$2
+ shift 2
+ ;;
+ --includeGroups)
+ INCLUDE_GROUPS=$2
+ shift 2
+ ;;
+ --excludeGroups)
+ EXCLUDE_GROUPS=$2
+ shift 2
+ ;;
+ --includeJobs)
+ INCLUDE_JOBS=$2
+ shift 2
+ ;;
+ --excludeJobs)
+ EXCLUDE_JOBS=$2
+ shift 2
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ echo "Invalid arguments." >&2
+ exit 1
+ ;;
+ esac
+done
+
+# Verify we have a MODE parameter
+if [ -z "${MODE}" ]; then
+ echo "Cron run mode MUST be defined." 1>&2
+ exit 1
+fi
+
+# Unique identifier for this cron job run
+IDENTIFIER=$(echo -n "${MODE}${INCLUDE_GROUPS}${EXCLUDE_GROUPS}${INCLUDE_JOBS}${EXCLUDE_JOBS}" | "${MD5SUM_BIN}" - | cut -f1 -d' ')
+
+# Lock process to one run per set of options (This REQUIRES 'set -e' or 'set -o errexit')
+# This is to prevent multiple processes for the same cron parameters (And the only reason we don't call PHP directly)
+LOCK="/tmp/magento.aoe_scheduler.${IDENTIFIER}.lock"
+mkdir "${LOCK}" >/dev/null 2>&1
+# TODO: add pid writing and check
+trap 'rmdir "${LOCK}"; exit $?' INT TERM EXIT
+
+# Needed because PHP is braindead and resolves symlinks before setting __FILE__
+cd "${DIR}"
+
+# Build the options
+OPTIONS=""
+if [ -n "${INCLUDE_GROUPS}" ]; then
+ OPTIONS="${OPTIONS} --includeGroups ${INCLUDE_GROUPS}"
+fi
+if [ -n "${EXCLUDE_GROUPS}" ]; then
+ OPTIONS="${OPTIONS} --excludeGroups ${EXCLUDE_GROUPS}"
+fi
+if [ -n "${INCLUDE_JOBS}" ]; then
+ OPTIONS="${OPTIONS} --includeJobs ${INCLUDE_JOBS}"
+fi
+if [ -n "${EXCLUDE_JOBS}" ]; then
+ OPTIONS="${OPTIONS} --excludeJobs ${EXCLUDE_JOBS}"
+fi
+
+# Run the job in the foreground
+"${PHP_BIN}" "${SCHEDULER}" --action cron --mode ${MODE} ${OPTIONS}
diff --git a/shell/scheduler.php b/shell/scheduler.php
old mode 100755
new mode 100644
index 099386f..1f52859
--- a/shell/scheduler.php
+++ b/shell/scheduler.php
@@ -62,10 +62,11 @@ public function usageHelp()
*/
public function listAllCodesAction()
{
- $collection = Mage::getModel('aoe_scheduler/collection_crons');
- foreach ($collection as $configuration) {
- /* @var $configuration Aoe_Scheduler_Model_Configuration */
- echo sprintf("%-50s %-20s %s\n", $configuration->getId(), $configuration->getCronExpr(), $configuration->getStatus());
+ /** @var Aoe_Scheduler_Model_Resource_Job_Collection $jobs */
+ $jobs = Mage::getSingleton('aoe_scheduler/job')->getCollection();
+ foreach ($jobs as $job) {
+ /* @var $job Aoe_Scheduler_Model_Job */
+ echo sprintf("%-50s %-20s %s\n", $job->getJobCode(), $job->getCronExpression(), $job->getIsActive() ? 'Enabled' : 'Disabled');
}
}
@@ -76,7 +77,6 @@ public function listAllCodesAction()
*/
public function lastRunAction()
{
-
$code = $this->getArg('code');
if (empty($code)) {
echo "\nNo code found!\n\n";
@@ -84,14 +84,13 @@ public function lastRunAction()
exit(1);
}
- $collection = Mage::getModel('cron/schedule')->getCollection();
- /* @var $collection Mage_Cron_Model_Resource_Schedule_Collection */
+ $collection = Mage::getModel('cron/schedule')->getCollection(); /* @var $collection Mage_Cron_Model_Resource_Schedule_Collection */
+
$collection->addFieldToFilter('job_code', $code)
->addFieldToFilter('status', Mage_Cron_Model_Schedule::STATUS_SUCCESS)
->addOrder('finished_at', Varien_Data_Collection_Db::SORT_ORDER_DESC)
->getSelect()->limit(1);
- $schedule = $collection->getFirstItem();
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $schedule = $collection->getFirstItem(); /* @var $schedule Aoe_Scheduler_Model_Schedule */
if (!$schedule || !$schedule->getId()) {
echo "\nNo schedule found\n\n";
exit(1);
@@ -129,8 +128,16 @@ public function scheduleNowAction()
echo $this->usageHelp();
exit(1);
}
- $schedule = Mage::getModel('cron/schedule');
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ if (!in_array($code, $allowedCodes)) {
+ echo "\nNo valid job found!\n\n";
+ echo $this->usageHelp();
+ exit(1);
+ }
+
+ $schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_SCHEDULENOW_CLI);
$schedule->setJobCode($code);
$schedule->schedule();
$schedule->save();
@@ -159,9 +166,17 @@ public function runNowAction()
echo $this->usageHelp();
exit(1);
}
- $schedule = Mage::getModel('cron/schedule');
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ if (!in_array($code, $allowedCodes)) {
+ echo "\nNo valid job found!\n\n";
+ echo $this->usageHelp();
+ exit(1);
+ }
+
+ $schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
$schedule->setJobCode($code);
+ $schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_RUNNOW_CLI);
$schedule->runNow(false);
if ($schedule->getJobWasLocked()) {
echo "\nJob was not executed because it was locked!\n\n";
@@ -182,6 +197,85 @@ public function runNowActionHelp()
return "--code Run a job directly";
}
+ /**
+ * Active wait until no schedules are running
+ */
+ public function waitAction()
+ {
+ $timeout = $this->getArg('timeout') ? $this->getArg('timeout') : 60;
+ $startTime = time();
+ $sleepBetweenPolls = 2;
+ $processManager = Mage::getModel('aoe_scheduler/processManager'); /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
+ do {
+ sleep($sleepBetweenPolls);
+ $aliveSchedules = 0;
+ echo "Currently running schedules:\n";
+ foreach ($processManager->getAllRunningSchedules() as $schedule) { /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $status = $schedule->isAlive();
+ if (is_null($status)) {
+ $status = '?';
+ } else {
+ $status = $status ? 'alive' : 'dead (updating status to "disappeared")';
+ }
+ if ($status) {
+ $aliveSchedules++;
+ }
+ echo sprintf(
+ "%-30s %-10s %-10s %-10s %-10s\n",
+ $schedule->getJobCode(),
+ $schedule->getHost() ? $schedule->getHost() : '(no host)',
+ $schedule->getPid() ? $schedule->getPid() : '(no pid)',
+ $schedule->getLastSeen() ? $schedule->getLastSeen() : '(never)',
+ $status
+ );
+ }
+ if ($aliveSchedules == 0) {
+ echo "No schedules found\n";
+ return;
+ }
+ } while (time() - $startTime < $timeout);
+ echo "Timeout reached\n";
+ exit(1);
+ }
+
+ /**
+ * Display extra help
+ *
+ * @return string
+ */
+ public function waitActionHelp()
+ {
+ return "[--timout ] Active wait until no schedules are running.";
+ }
+
+ /**
+ * Flush schedules
+ */
+ public function flushSchedulesAction()
+ {
+ $scheduleManager = Mage::getModel('aoe_scheduler/scheduleManager'); /* @var $scheduleManager Aoe_Scheduler_Model_ScheduleManager */
+ switch ($this->getArg('mode')) {
+ case 'future': $scheduleManager->flushSchedules();
+ break;
+ case 'all': $scheduleManager->deleteAll();
+ break;
+ default:
+ echo "\nInvalid mode!\n\n";
+ echo $this->usageHelp();
+ exit(1);
+ }
+ }
+
+ /**
+ * Display extra help
+ *
+ * @return string
+ */
+ public function flushSchedulesActionHelp()
+ {
+ return "--mode (future|all) Flush schedules.";
+ }
+
/**
* Print all running schedules
*
@@ -189,10 +283,8 @@ public function runNowActionHelp()
*/
public function listAllRunningSchedulesAction()
{
- $processManager = Mage::getModel('aoe_scheduler/processManager');
- /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
- foreach ($processManager->getAllRunningSchedules() as $schedule) {
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $processManager = Mage::getModel('aoe_scheduler/processManager'); /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
+ foreach ($processManager->getAllRunningSchedules() as $schedule) { /* @var $schedule Aoe_Scheduler_Model_Schedule */
$status = $schedule->isAlive();
if (is_null($status)) {
$status = '?';
@@ -217,10 +309,8 @@ public function listAllRunningSchedulesAction()
*/
public function killAllAction()
{
- $processManager = Mage::getModel('aoe_scheduler/processManager');
- /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
- foreach ($processManager->getAllRunningSchedules(gethostname()) as $schedule) {
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $processManager = Mage::getModel('aoe_scheduler/processManager'); /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
+ foreach ($processManager->getAllRunningSchedules(gethostname()) as $schedule) { /* @var $schedule Aoe_Scheduler_Model_Schedule */
if ($schedule->isAlive() === true) {
$schedule->kill();
echo sprintf(
@@ -233,6 +323,20 @@ public function killAllAction()
}
}
+ /**
+ * Runs watchdog
+ */
+ public function watchdogAction()
+ {
+ $processManager = Mage::getModel('aoe_scheduler/processManager'); /* @var $processManager Aoe_Scheduler_Model_ProcessManager */
+ $processManager->watchdog();
+ }
+
+ /**
+ * Cron action
+ *
+ *
+ */
public function cronAction()
{
Mage::app('admin')->setUseSessionInUrl(false);
@@ -262,7 +366,12 @@ public function cronAction()
*/
public function cronActionHelp()
{
- return "--mode (always|default) [--exclude ] [--include ]";
+ return "--mode (always|default) [--exclude ] [--include ]";
+ }
+
+ protected function _applyPhpVariables()
+ {
+ // Disable this feature as cron jobs should run with CLI settings only
}
}
diff --git a/skin/adminhtml/default/default/aoe_scheduler/Images/red.png b/skin/adminhtml/default/default/aoe_scheduler/Images/red.png
old mode 100755
new mode 100644
diff --git a/skin/adminhtml/default/default/aoe_scheduler/JavaScript/common.js b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/common.js
index 8823873..1fb5cb1 100644
--- a/skin/adminhtml/default/default/aoe_scheduler/JavaScript/common.js
+++ b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/common.js
@@ -1,56 +1,59 @@
$.noConflict();
-jQuery(function() {
- jQuery('.timeline-box').scrollLeft(jQuery('.timeline-panel').width());
-
- jQuery('.task').tooltip({
- offsetParent: 'body',
- predelay: 100,
- position: 'bottom center',
- onShow: function() { this.getTrigger().addClass('active'); },
- onHide: function() { this.getTrigger().removeClass('active'); }
- }).dynamic();
-
- // collision detection
- function getPositions(box) {
- var $box = jQuery(box);
- var pos = $box.position();
- var width = $box.width();
- var height = $box.height();
- return [ [ pos.left, pos.left + width ], [ pos.top, pos.top + height ] ];
- }
-
- function comparePositions(p1, p2) {
- var x1 = p1[0] < p2[0] ? p1 : p2;
- var x2 = p1[0] < p2[0] ? p2 : p1;
- return x1[1] > x2[0] || x1[0] === x2[0] ? true : false;
- }
-
- function collision(a, b) {
- var posA = getPositions(a);
- var posB = getPositions(b);
-
- return (posA[1][0] == posB[1][0]) && comparePositions(posA[0], posB[0]);
- }
-
- jQuery('.timeline').each(function() {
- var $tasks = jQuery('.task', jQuery(this));
- var numberOfTasks = $tasks.length;
- for (var i=0; i x2[0] || x1[0] === x2[0]);
+ }
+
+ function collision(a, b) {
+ var posA = getPositions(a);
+ var posB = getPositions(b);
+
+ return (posA[1][0] == posB[1][0]) && comparePositions(posA[0], posB[0]);
+ }
+
+ jQuery('.timeline').each(function () {
+ var $tasks = jQuery('.task', jQuery(this));
+ var numberOfTasks = $tasks.length;
+ for (var i = 0; i < numberOfTasks; i++) {
+ var u = Math.min(i + 10, numberOfTasks);
+ for (var j = i + 1; j < u; j++) {
+ if (collision($tasks[i], $tasks[j])) {
+ var $subject = jQuery($tasks[i]);
+ var $object = jQuery($tasks[j]);
+
+ var objectTop = parseInt($subject.css('top'));
+
+ $object.css('top', (objectTop + 4) + 'px');
+
+ $subject.css('height', 18);
+ $object.css('height', 18);
+ }
+ }
+ }
+ });
+});
diff --git a/skin/adminhtml/default/default/aoe_scheduler/JavaScript/instructions.js b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/instructions.js
new file mode 100644
index 0000000..0c15a8a
--- /dev/null
+++ b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/instructions.js
@@ -0,0 +1,28 @@
+$.noConflict();
+jQuery(function() {
+ function updateInstructions() {
+ jQuery('.croncommand').hide();
+ jQuery('.configuration input').removeAttr("disabled");
+ if (!jQuery('.configuration input[name="scheduler-cron"]').is(':checked')) {
+ jQuery('.classic').show();
+ jQuery('.configuration input[name="use-crongroups"]').attr('checked', false).attr("disabled", true);
+ }
+ if (jQuery('.configuration input[name="use-crongroups"]').is(':checked')) {
+ jQuery('.configuration input[name="split-always-default"]').attr('checked', true).attr("disabled", true);
+ jQuery('.configuration input[name="scheduler-cron"]').attr('checked', true).attr("disabled", true);
+ jQuery('.crongroups').show();
+ } else if (jQuery('.configuration input[name="split-always-default"]').is(':checked')) {
+ jQuery('.configuration input[name="scheduler-cron"]').attr('checked', true).attr("disabled", true);
+ jQuery('.split').show();
+ } else if (jQuery('.configuration input[name="scheduler-cron"]').is(':checked')) {
+ jQuery('.scheduler').show();
+ }
+ jQuery('.every-five-minutes').toggle(!jQuery('.configuration input[name="every-minute"]').is(':checked'));
+ jQuery('.maintenance-check-command').toggle(jQuery('.configuration input[name="maintenance-check"]').is(':checked'));
+ jQuery('.watchdog').toggle(jQuery('.configuration input[name="use-watchdog"]').is(':checked'));
+ jQuery('.mailto').toggle(jQuery('.configuration input[name="add-mailto"]').is(':checked'));
+
+ }
+ updateInstructions();
+ jQuery('.configuration input').change(updateInstructions);
+});
\ No newline at end of file
diff --git a/skin/adminhtml/default/default/aoe_scheduler/JavaScript/tooltip.js b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/tooltip.js
index f17df89..3211549 100644
--- a/skin/adminhtml/default/default/aoe_scheduler/JavaScript/tooltip.js
+++ b/skin/adminhtml/default/default/aoe_scheduler/JavaScript/tooltip.js
@@ -1,215 +1,215 @@
/**
- * @license
+ * @license
* jQuery Tools @VERSION Tooltip - UI essentials
- *
+ *
* NO COPYRIGHTS OR LICENSES. DO WHAT YOU LIKE.
- *
+ *
* http://flowplayer.org/tools/tooltip/
*
* Since: November 2008
- * Date: @DATE
+ * Date: @DATE
*/
-(function($) {
+(function($) {
// static constructs
$.tools = $.tools || {version: '@VERSION'};
-
+
$.tools.tooltip = {
-
- conf: {
-
+
+ conf: {
+
// default effect variables
- effect: 'toggle',
+ effect: 'toggle',
fadeOutSpeed: "fast",
predelay: 0,
delay: 30,
- opacity: 1,
+ opacity: 1,
tip: 0,
-
+
// 'top', 'bottom', 'right', 'left', 'center'
- position: ['top', 'center'],
+ position: ['top', 'center'],
offset: [0, 0],
relative: false,
offsetParent: null,
cancelDefault: true,
-
- // type to event mapping
+
+ // type to event mapping
events: {
def: "mouseenter,mouseleave",
input: "focus,blur",
widget: "focus mouseenter,blur mouseleave",
tooltip: "mouseenter,mouseleave"
},
-
+
// 1.2
- layout: '',
+ layout: '',
tipClass: 'tooltip'
},
-
+
addEffect: function(name, loadFn, hideFn) {
- effects[name] = [loadFn, hideFn];
- }
+ effects[name] = [loadFn, hideFn];
+ }
};
-
-
- var effects = {
- toggle: [
- function(done) {
+
+
+ var effects = {
+ toggle: [
+ function(done) {
var conf = this.getConf(), tip = this.getTip(), o = conf.opacity;
if (o < 1) { tip.css({opacity: o}); }
tip.show();
done.call();
},
-
- function(done) {
+
+ function(done) {
this.getTip().hide();
done.call();
- }
+ }
],
-
+
fade: [
- function(done) {
+ function(done) {
var conf = this.getConf();
- this.getTip().fadeTo(conf.fadeInSpeed, conf.opacity, done);
- },
- function(done) {
- this.getTip().fadeOut(this.getConf().fadeOutSpeed, done);
- }
- ]
- };
-
-
- /* calculate tip position relative to the trigger */
- function getPosition(trigger, tip, conf) {
-
-
- // get origin top/left position
- var top = conf.relative ? trigger.position().top : trigger.offset().top,
+ this.getTip().fadeTo(conf.fadeInSpeed, conf.opacity, done);
+ },
+ function(done) {
+ this.getTip().fadeOut(this.getConf().fadeOutSpeed, done);
+ }
+ ]
+ };
+
+
+ /* calculate tip position relative to the trigger */
+ function getPosition(trigger, tip, conf) {
+
+
+ // get origin top/left position
+ var top = conf.relative ? trigger.position().top : trigger.offset().top,
left = conf.relative ? trigger.position().left : trigger.offset().left,
pos = conf.position[0];
top -= tip.outerHeight() - conf.offset[0];
left += trigger.outerWidth() + conf.offset[1];
-
+
// iPad position fix
if (/iPad/i.test(navigator.userAgent)) {
top -= $(window).scrollTop();
}
-
- // adjust Y
+
+ // adjust Y
var height = tip.outerHeight() + trigger.outerHeight();
if (pos == 'center') { top += height / 2; }
if (pos == 'bottom') { top += height; }
-
-
+
+
// adjust X
- pos = conf.position[1];
+ pos = conf.position[1];
var width = tip.outerWidth() + trigger.outerWidth();
if (pos == 'center') { left -= width / 2; }
- if (pos == 'left') { left -= width; }
-
+ if (pos == 'left') { left -= width; }
+
return {top: top, left: left};
- }
+ }
+
+
-
-
function Tooltip(trigger, conf) {
- var self = this,
+ var self = this,
fire = trigger.add(self),
tip,
timer = 0,
- pretimer = 0,
+ pretimer = 0,
title = trigger.attr("title"),
tipAttr = trigger.attr("data-tooltip"),
effect = effects[conf.effect],
shown,
-
+
// get show/hide configuration
- isInput = trigger.is(":input"),
- isWidget = isInput && trigger.is(":checkbox, :radio, select, :button, :submit"),
+ isInput = trigger.is(":input"),
+ isWidget = isInput && trigger.is(":checkbox, :radio, select, :button, :submit"),
type = trigger.attr("type"),
- evt = conf.events[type] || conf.events[isInput ? (isWidget ? 'widget' : 'input') : 'def'];
-
-
+ evt = conf.events[type] || conf.events[isInput ? (isWidget ? 'widget' : 'input') : 'def'];
+
+
// check that configuration is sane
- if (!effect) { throw "Nonexistent effect \"" + conf.effect + "\""; }
-
- evt = evt.split(/,\s*/);
- if (evt.length != 2) { throw "Tooltip: bad events configuration for " + type; }
-
-
- // trigger --> show
+ if (!effect) { throw "Nonexistent effect \"" + conf.effect + "\""; }
+
+ evt = evt.split(/,\s*/);
+ if (evt.length != 2) { throw "Tooltip: bad events configuration for " + type; }
+
+
+ // trigger --> show
trigger.bind(evt[0], function(e) {
clearTimeout(timer);
if (conf.predelay) {
- pretimer = setTimeout(function() { self.show(e); }, conf.predelay);
-
+ pretimer = setTimeout(function() { self.show(e); }, conf.predelay);
+
} else {
- self.show(e);
+ self.show(e);
}
-
+
// trigger --> hide
}).bind(evt[1], function(e) {
clearTimeout(pretimer);
if (conf.delay) {
- timer = setTimeout(function() { self.hide(e); }, conf.delay);
-
+ timer = setTimeout(function() { self.hide(e); }, conf.delay);
+
} else {
- self.hide(e);
+ self.hide(e);
}
-
- });
-
-
+
+ });
+
+
// remove default title
- if (title && conf.cancelDefault) {
+ if (title && conf.cancelDefault) {
trigger.removeAttr("title");
- trigger.data("title", title);
- }
-
+ trigger.data("title", title);
+ }
+
$.extend(self, {
-
- show: function(e) {
+
+ show: function(e) {
// tip not initialized yet
if (!tip) {
-
- // data-tooltip
+
+ // data-tooltip
if (tipAttr) {
tip = $(tipAttr);
// single tip element for all
- } else if (conf.tip) {
+ } else if (conf.tip) {
tip = $(conf.tip).eq(0);
-
+
// autogenerated tooltip
- } else if (title) {
+ } else if (title) {
tip = $(conf.layout).addClass(conf.tipClass).appendTo(document.body)
.hide().append(title);
// manual tooltip
- } else {
- tip = trigger.next();
+ } else {
+ tip = trigger.next();
if (!tip.length) { tip = trigger.parent().next(); }
-
+
}
-
+
if (!tip.length) { throw "Cannot find tooltip for " + trigger; }
-
+
if (conf.offsetParent) {
tip.appendTo($(conf.offsetParent));
}
- }
-
- if (self.isShown()) { return self; }
-
+ }
+
+ if (self.isShown()) { return self; }
+
// stop previous animation
- tip.stop(true, true);
-
+ tip.stop(true, true);
+
// get position
- var pos = getPosition(trigger, tip, conf);
-
+ var pos = getPosition(trigger, tip, conf);
+
// restore title for single tooltip element
if (conf.tip) {
tip.html(trigger.data("title"));
@@ -218,96 +218,96 @@
// onBeforeShow
e = e || $.Event();
e.type = "onBeforeShow";
- fire.trigger(e, [pos]);
+ fire.trigger(e, [pos]);
if (e.isDefaultPrevented()) { return self; }
-
-
+
+
// onBeforeShow may have altered the configuration
pos = getPosition(trigger, tip, conf);
-
+
// set position
- tip.css({position:'absolute', top: pos.top, left: pos.left});
-
+ tip.css({position:'absolute', top: pos.top, left: pos.left});
+
shown = true;
-
- // invoke effect
+
+ // invoke effect
effect[0].call(self, function() {
e.type = "onShow";
shown = 'full';
- fire.trigger(e);
- });
+ fire.trigger(e);
+ });
+
-
- // tooltip events
+ // tooltip events
var event = conf.events.tooltip.split(/,\s*/);
if (!tip.data("__set")) {
-
- tip.bind(event[0], function() {
+
+ tip.bind(event[0], function() {
clearTimeout(timer);
clearTimeout(pretimer);
});
-
- if (event[1] && !trigger.is("input:not(:checkbox, :radio), textarea")) {
+
+ if (event[1] && !trigger.is("input:not(:checkbox, :radio), textarea")) {
tip.bind(event[1], function(e) {
-
+
// being moved to the trigger element
if (e.relatedTarget != trigger[0]) {
trigger.trigger(evt[1].split(" ")[0]);
}
- });
- }
-
+ });
+ }
+
tip.data("__set", true);
}
-
+
return self;
},
-
+
hide: function(e) {
if (!tip || !self.isShown()) { return self; }
-
+
// onBeforeHide
e = e || $.Event();
e.type = "onBeforeHide";
- fire.trigger(e);
+ fire.trigger(e);
if (e.isDefaultPrevented()) { return; }
-
+
shown = false;
-
+
effects[conf.effect][1].call(self, function() {
e.type = "onHide";
- fire.trigger(e);
+ fire.trigger(e);
});
-
+
return self;
},
-
+
isShown: function(fully) {
- return fully ? shown == 'full' : shown;
+ return fully ? shown == 'full' : shown;
},
-
+
getConf: function() {
- return conf;
+ return conf;
},
-
+
getTip: function() {
- return tip;
+ return tip;
},
-
+
getTrigger: function() {
- return trigger;
- }
+ return trigger;
+ }
- });
+ });
- // callbacks
+ // callbacks
$.each("onHide,onBeforeShow,onShow,onBeforeHide".split(","), function(i, name) {
-
+
// configuration
- if ($.isFunction(conf[name])) {
- $(self).bind(name, conf[name]);
+ if ($.isFunction(conf[name])) {
+ $(self).bind(name, conf[name]);
}
// API
@@ -316,34 +316,34 @@
return self;
};
});
-
+
}
-
-
+
+
// jQuery plugin implementation
$.fn.tooltip = function(conf) {
-
+
// return existing instance
var api = this.data("tooltip");
if (api) { return api; }
conf = $.extend(true, {}, $.tools.tooltip.conf, conf);
-
+
// position can also be given as string
if (typeof conf.position == 'string') {
- conf.position = conf.position.split(/,?\s/);
+ conf.position = conf.position.split(/,?\s/);
}
-
+
// install tooltip for each entry in jQuery object
this.each(function() {
- api = new Tooltip($(this), conf);
- $(this).data("tooltip", api);
+ api = new Tooltip($(this), conf);
+ $(this).data("tooltip", api);
});
-
- return conf.api ? api: this;
+
+ return conf.api ? api: this;
};
-
+
}) (jQuery);
-
+
diff --git a/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/instructions.css b/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/instructions.css
new file mode 100644
index 0000000..8db1d2c
--- /dev/null
+++ b/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/instructions.css
@@ -0,0 +1,17 @@
+.configuration label {
+ padding-left: 5px;
+}
+
+h5 {
+ margin-top: 20px;
+}
+
+pre {
+ padding: 5px 10px;
+ background-color: black;
+ color: #eee;
+ font-size: 15px;
+ overflow: auto;
+ word-wrap: normal;
+ white-space: pre;
+}
\ No newline at end of file
diff --git a/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/timeline.css b/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/timeline.css
old mode 100755
new mode 100644
index 940a0a4..fe519e2
--- a/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/timeline.css
+++ b/skin/adminhtml/default/default/aoe_scheduler/StyleSheet/timeline.css
@@ -1,39 +1,39 @@
#contentwrapper {
- float: left;
- width: 100%;
+ float: left;
+ width: 100%;
}
#contentcolumn {
- margin-left: 300px; /* Set left margin to LeftColumnWidth */
+ margin-left: 300px; /* Set left margin to LeftColumnWidth */
}
#leftcolumn {
- float: left;
- width: 300px; /* Width of left column */
- margin-left: -100%;
+ float: left;
+ width: 300px; /* Width of left column */
+ margin-left: -100%;
}
.configuration {
- padding: 5px;
+ padding: 5px;
}
#leftcolumn .row {
- background-color: #F6F6F6;
- border-right: 1px solid #DADFE0;
+ background-color: #F6F6F6;
+ border-right: 1px solid #DADFE0;
}
#leftcolumn .row.hours {
- background-color: transparent;
- text-align: right;
- padding-right: 5px;
- font-size: 10px;
+ background-color: transparent;
+ text-align: right;
+ padding-right: 5px;
+ font-size: 10px;
}
#now {
- position: absolute;
- width: 1px;
- height: 100%;
- background-color: red;
+ position: absolute;
+ width: 1px;
+ height: 100%;
+ background-color: red;
}
#now .arrow {
@@ -46,54 +46,54 @@
}
div.row {
- border-bottom: 1px solid #DADFE0;
- padding: 0;
- margin: 0;
- height: 40px;
+ border-bottom: 1px solid #DADFE0;
+ padding: 0;
+ margin: 0;
+ height: 40px;
}
div.timeline-box {
- overflow: auto;
+ overflow: auto;
}
div.timeline-panel {
- background-image: url(../Images/hour.gif);
- border-right: 1px solid black;
- position: relative;
+ background-image: url(../Images/hour.gif);
+ border-right: 1px solid black;
+ position: relative;
}
div.timeline {
- position: relative;
+ position: relative;
}
div.hours {
- height: 20px;
+ height: 20px;
}
.detailwrap {
- width: 100%;
- height: 100%;
+ width: 100%;
+ height: 100%;
}
.details {
- display: none;
- background-color: white;
- border: 1px solid black;
- z-index: 1000;
- max-width: 400px;
+ display: none;
+ background-color: white;
+ border: 1px solid black;
+ z-index: 1000;
+ max-width: 400px;
}
.details pre {
- background-color: white;
- overflow: auto;
- max-width: 385px;
- font-size: 8pt;
- line-height: 9pt;
+ background-color: white;
+ overflow: auto;
+ max-width: 385px;
+ font-size: 8pt;
+ line-height: 9pt;
}
.hour {
- width: 240px;
- float: left;
+ width: 240px;
+ float: left;
}
.hour span {
@@ -102,39 +102,39 @@ div.hours {
}
.details-headline {
- width: 100%;
- height: 24px;
+ width: 100%;
+ height: 24px;
background-position: top center;
}
.details-headline h3 {
- padding: 2px 5px;
- color: white;
- margin: 0;
+ padding: 2px 5px;
+ color: white;
+ margin: 0;
}
.details-content {
- padding: 5px;
+ padding: 5px;
}
.details-content td.label {
- font-weight: bold;
+ font-weight: bold;
}
.caption-container {
- width: 500px;
- overflow: hidden;
+ width: 500px;
+ overflow: hidden;
}
.task, .estimation {
- position: absolute;
- height: 24px;
- top: 8px;
- cursor: default;
+ position: absolute;
+ height: 24px;
+ top: 8px;
+ cursor: default;
}
.status {
- width: 100px;
+ width: 100px;
}
.details-headline, .task { background-image: url(../Images/gradient.png); }
+
+# AOE Scheduler for Magento
+
+[](https://travis-ci.org/AOEpeople/Aoe_Scheduler)
+
+**Note: This is a release candidate of version 1.0.0! Please read the [changelog](changelog.md) and carefully test everything on a non-production environment before rolling this out to production. The final stable version will be released March 15th, 2015.**
+
+AOE Scheduler sits on top of Magento's default cron functionality allowing you to manage the jobs, to visualize the timeline and to get some deeper insight on what's going on behind the scenes and to shed some light on what might be going wrong. On top of that AOE Scheduler provides some more functionality like a cli and a web service interface, optimizing cron execution on your server and giving you everything you need to implement complex background tasks including for your Magento store.
+
+
+
+## NOTE
+
+This documentation is currently being written. Sadly, at this point it's still more an outline and some bullet points than a complete documentation. I'm working on it. If you have any comments feel free to [get in touch with me](https://twitter.com/fbrnc).
+
+## Changelog
+
+Version 1.0.0 is a major release. If you're updating from version 0.X please check out the changelog and verify everything is still working as expected after updating.
+
+[Changelog](changelog.md)
+
+## Features
+
+- **Timeline visualization**: The timeline view visualizes all past, current and future jobs showing their status, results, the runtime and some more details.
+- **Cron Management**: Find a list of all jobs defined in the Magento core or in any module installed. You can enable or disable individual jobs, modify them (e.g. edit their schedule) or even create new crons from scratch
+- **Parameterized Crons**: Sometimes a simple cron run isn't enough. You might want to use the same cron but with different parameters. Example: Use this to create daily reports and weekly reports with the same job, but different input parameters.
+- **Process Management**: Check if jobs are actually still running and kill them through Aoe_Scheduler if required.
+- **Cron groups**: Split you crons into different groups so you can run them in parallel or distribute them on multiple servers.
+- **Clean API**
+ - **Cli**
+ - **Web Service API**
+ - **Developer API**: Create/run/schedule jobs programmatically. Use events to create workflows between jobs.
+- **Instructions**: A new admin modules assists you in settings up your cron configuration.
+- **Monitoring**: Heartbeat, Watchdog, last-seen, verification
+- **Compatible with Magento's native cron scheduler**
+- **Manuel scheduling and running**: Schedule or run your jobs manually or programmatically. This comes in handly during development or if you have actions that might have to be triggered manually at times (e.g. re-import product catalog, re-run statistics,...)
+
+
+## Authors, contributors and maintainers
+
+Author:
+- [Fabrizio Branca](https://twitter.com/fbrnc)
+
+Major Contributions:
+- [Lee Saferite](https://twitter.com/leesaferite)
+- For a full list of contributors visit [AOE Scheduler on GitHub](https://github.com/AOEpeople/Aoe_Scheduler/graphs/contributors)
+
+## Ideas, bugs, contributions, comments, feature suggestions?
+
+Please get in touch with us via the [issue tracker on GitHub](https://github.com/AOEpeople/Aoe_Scheduler/issues)
+
+## Compability
+
+- PHP:
+ - 5.3
+ - 5.4
+ - 5.5
+- Magento CE:
+ - 1.6.2.0
+ - 1.7.0.2
+ - 1.8.0.0
+ - 1.8.1.0
+ - 1.9.0.1
+ - 1.9.1.0
+- Magento EE:
+ - 1.11.0.0
+ - 1.11.0.2
+ - 1.11.1.0
+ - 1.11.2.0
+ - 1.12.0.0
+ - 1.12.0.1
+ - 1.12.0.2
+ - 1.13.0.2
+ - 1.13.1.0
+ - 1.14.0.1
+ - 1.14.1.0
+- Operating System: Linux
+
+## Documentation
+
+1. [Module Installation](doc/installation.md)
+1. [Cron Configuration](doc/cron-configuration.md)
+1. [Some Basics (Job? Schedule? Task?)](doc/basics.md)
+1. [Creating new jobs](doc/create-job.md)
+1. [Faq](doc/faq.md)
+1. Admin Interfaces
+ 1. [System Configuration](doc/system-configuration.md)
+ 1. [Job Configuration](doc/job-configuration.md)
+ 1. [List View](doc/list-view.md)
+ 1. [Timeline View](doc/timeline.md)
+ 1. [Instructions](doc/instructions.md)
+1. [Events](doc/events.md)
+1. [Schedule States](doc/states.md)
+1. [CLI](doc/cli.md)
+1. [Web Services](doc/web-services.md)
+1. [Domain Model](doc/domain-model.md)
+1. [Cron Processing](doc/processing.md)
+1. [Unit Tests](doc/tests.md)
+1. Features
+ 1. [Heartbeat and Monitoring](doc/heartbeat.md)
+ 1. [Notifications](doc/notifications.md)
+ 1. [Custom job parameters](doc/custom-job-parameters.md)
+ 1. [Global enabled/disable](doc/global-enable-disable.md)
+ 1. [Disable individual jobs](doc/disable-individual-jobs.md)
+ 1. [runNow](doc/run-now.md)
+ 1. [scheduleNow](doc/schedule-now.md)
+ 1. [Run return values and communication](doc/communication.md)
+ 1. [ETA](doc/eta.md)
+ 1. [Watchdog](doc/watchdog.md)
+ 1. [Cron groups](doc/cron-groups.md)
+ 1. [Process Management](doc/process-management.md)
+ 1. [Output buffering](doc/output-buffering.md)
+1. Cookbook
+ 1. [How to declutter your timeline](doc/declutter-timeline.md)
+ 1. [How to integrate into deployments](doc/deployment-integration.md)
+ 1. [Distributed cron](doc/distributed.md)
+ 1. [Job workflows](doc/job-workflows.md)
+ 1. [Schedule a job programmatically](doc/programmatically.md)
+
+
+## License
+
+[GPL v3](LICENSE.txt)
+
+## Links
+
+- [Aoe Scheduler on Magento Connect](http://www.magentocommerce.com/magento-connect/aoe-scheduler.html)
+- [Aoe Scheduler on Travis CI](https://travis-ci.org/AOEpeople/Aoe_Scheduler)
+- [Aoe Scheduler on Packagist](https://packagist.org/packages/aoepeople/aoe_scheduler)
+- Blog posts
+ - [Magento Cron Demystified (www.webguys.de)](http://www.webguys.de/magento/tuerchen-08-magento-cron-demystified/)
+ - [Magento Cron Scheduler (fbrnc.net)](http://fbrnc.net/blog/2011/03/magento-cron-scheduler)
diff --git a/scheduler_cron.sh b/scheduler_cron.sh
new file mode 100755
index 0000000..4cda36d
--- /dev/null
+++ b/scheduler_cron.sh
@@ -0,0 +1,113 @@
+#!/bin/bash
+
+# Exit when any command returns an error status
+set -o errexit
+
+# Generate an error if any variable doesn't exist
+set -o nounset
+
+# Location of the php binary
+PHP_BIN=$(which php || true)
+if [ -z "${PHP_BIN}" ]; then
+ echo "Could not find a binary for php" 1>&2
+ exit 1
+fi
+
+# Location of the md5sum binary
+MD5SUM_BIN=$(which md5sum || true)
+if [ -z "${MD5SUM_BIN}" ]; then
+ echo "Could not find a binary for md5sum" 1>&2
+ exit 1
+fi
+
+# Absolute path to Magento installation shell scripts
+DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")/shell" && pwd)
+if [[ -z "${DIR}" || ! -d "${DIR}" ]]; then
+ echo "Could not resolve base shell directory" 1>&2
+ exit 1
+fi
+
+# The scheduler.php script
+SCHEDULER="scheduler.php"
+if [[ ! -e "${DIR}/${SCHEDULER}" || ! -r "${DIR}/${SCHEDULER}" ]]; then
+ echo "Could not find scheduler.php script" 1>&2
+ exit 1
+fi
+
+# Defaults
+MODE="default"
+INCLUDE_GROUPS=""
+EXCLUDE_GROUPS=""
+INCLUDE_JOBS=""
+EXCLUDE_JOBS=""
+
+# Parse command line args (very simplistic)
+while [ $# -gt 0 ]; do
+ case "$1" in
+ --mode)
+ MODE=$2
+ shift 2
+ ;;
+ --includeGroups)
+ INCLUDE_GROUPS=$2
+ shift 2
+ ;;
+ --excludeGroups)
+ EXCLUDE_GROUPS=$2
+ shift 2
+ ;;
+ --includeJobs)
+ INCLUDE_JOBS=$2
+ shift 2
+ ;;
+ --excludeJobs)
+ EXCLUDE_JOBS=$2
+ shift 2
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ echo "Invalid arguments." >&2
+ exit 1
+ ;;
+ esac
+done
+
+# Verify we have a MODE parameter
+if [ -z "${MODE}" ]; then
+ echo "Cron run mode MUST be defined." 1>&2
+ exit 1
+fi
+
+# Unique identifier for this cron job run
+IDENTIFIER=$(echo -n "${MODE}${INCLUDE_GROUPS}${EXCLUDE_GROUPS}${INCLUDE_JOBS}${EXCLUDE_JOBS}" | "${MD5SUM_BIN}" - | cut -f1 -d' ')
+
+# Lock process to one run per set of options (This REQUIRES 'set -e' or 'set -o errexit')
+# This is to prevent multiple processes for the same cron parameters (And the only reason we don't call PHP directly)
+LOCK="/tmp/magento.aoe_scheduler.${IDENTIFIER}.lock"
+mkdir "${LOCK}" >/dev/null 2>&1
+# TODO: add pid writing and check
+trap 'rmdir "${LOCK}"; exit $?' INT TERM EXIT
+
+# Needed because PHP is braindead and resolves symlinks before setting __FILE__
+cd "${DIR}"
+
+# Build the options
+OPTIONS=""
+if [ -n "${INCLUDE_GROUPS}" ]; then
+ OPTIONS="${OPTIONS} --includeGroups ${INCLUDE_GROUPS}"
+fi
+if [ -n "${EXCLUDE_GROUPS}" ]; then
+ OPTIONS="${OPTIONS} --excludeGroups ${EXCLUDE_GROUPS}"
+fi
+if [ -n "${INCLUDE_JOBS}" ]; then
+ OPTIONS="${OPTIONS} --includeJobs ${INCLUDE_JOBS}"
+fi
+if [ -n "${EXCLUDE_JOBS}" ]; then
+ OPTIONS="${OPTIONS} --excludeJobs ${EXCLUDE_JOBS}"
+fi
+
+# Run the job in the foreground
+"${PHP_BIN}" "${SCHEDULER}" --action cron --mode ${MODE} ${OPTIONS}
diff --git a/shell/scheduler.php b/shell/scheduler.php
old mode 100755
new mode 100644
index 099386f..1f52859
--- a/shell/scheduler.php
+++ b/shell/scheduler.php
@@ -62,10 +62,11 @@ public function usageHelp()
*/
public function listAllCodesAction()
{
- $collection = Mage::getModel('aoe_scheduler/collection_crons');
- foreach ($collection as $configuration) {
- /* @var $configuration Aoe_Scheduler_Model_Configuration */
- echo sprintf("%-50s %-20s %s\n", $configuration->getId(), $configuration->getCronExpr(), $configuration->getStatus());
+ /** @var Aoe_Scheduler_Model_Resource_Job_Collection $jobs */
+ $jobs = Mage::getSingleton('aoe_scheduler/job')->getCollection();
+ foreach ($jobs as $job) {
+ /* @var $job Aoe_Scheduler_Model_Job */
+ echo sprintf("%-50s %-20s %s\n", $job->getJobCode(), $job->getCronExpression(), $job->getIsActive() ? 'Enabled' : 'Disabled');
}
}
@@ -76,7 +77,6 @@ public function listAllCodesAction()
*/
public function lastRunAction()
{
-
$code = $this->getArg('code');
if (empty($code)) {
echo "\nNo code found!\n\n";
@@ -84,14 +84,13 @@ public function lastRunAction()
exit(1);
}
- $collection = Mage::getModel('cron/schedule')->getCollection();
- /* @var $collection Mage_Cron_Model_Resource_Schedule_Collection */
+ $collection = Mage::getModel('cron/schedule')->getCollection(); /* @var $collection Mage_Cron_Model_Resource_Schedule_Collection */
+
$collection->addFieldToFilter('job_code', $code)
->addFieldToFilter('status', Mage_Cron_Model_Schedule::STATUS_SUCCESS)
->addOrder('finished_at', Varien_Data_Collection_Db::SORT_ORDER_DESC)
->getSelect()->limit(1);
- $schedule = $collection->getFirstItem();
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $schedule = $collection->getFirstItem(); /* @var $schedule Aoe_Scheduler_Model_Schedule */
if (!$schedule || !$schedule->getId()) {
echo "\nNo schedule found\n\n";
exit(1);
@@ -129,8 +128,16 @@ public function scheduleNowAction()
echo $this->usageHelp();
exit(1);
}
- $schedule = Mage::getModel('cron/schedule');
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ if (!in_array($code, $allowedCodes)) {
+ echo "\nNo valid job found!\n\n";
+ echo $this->usageHelp();
+ exit(1);
+ }
+
+ $schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
+ $schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_SCHEDULENOW_CLI);
$schedule->setJobCode($code);
$schedule->schedule();
$schedule->save();
@@ -159,9 +166,17 @@ public function runNowAction()
echo $this->usageHelp();
exit(1);
}
- $schedule = Mage::getModel('cron/schedule');
- /* @var $schedule Aoe_Scheduler_Model_Schedule */
+
+ $allowedCodes = Mage::getSingleton('aoe_scheduler/job')->getResource()->getJobCodes();
+ if (!in_array($code, $allowedCodes)) {
+ echo "\nNo valid job found!\n\n";
+ echo $this->usageHelp();
+ exit(1);
+ }
+
+ $schedule = Mage::getModel('cron/schedule'); /* @var $schedule Aoe_Scheduler_Model_Schedule */
$schedule->setJobCode($code);
+ $schedule->setScheduledReason(Aoe_Scheduler_Model_Schedule::REASON_RUNNOW_CLI);
$schedule->runNow(false);
if ($schedule->getJobWasLocked()) {
echo "\nJob was not executed because it was locked!\n\n";
@@ -182,6 +197,85 @@ public function runNowActionHelp()
return "--code