added event listeners to make it easy to extend cron jobs and hook in…

… custom behaviors

README.md

@@ -70,6 +70,23 @@ Scheduled jobs module for Infuse Framework
    *	*	*	*	*	php /var/www/example.com/infuse cron:run
    ```
 
+### Events
+
+You can subscribe to events with [event subscribers](https://symfony.com/doc/current/components/event_dispatcher.html#using-event-subscribers) from the symfony/event-dispatcher component. Your subscribers an listen to these events:
+
+- `schedule_run.begin`
+- `schedule_run.finished`
+- `cron_job.begin`
+- `cron_job.finished`
+
+When you have created an [event subscriber](https://symfony.com/doc/current/components/event_dispatcher.html#using-event-subscribers) you can add it to your config like this: 
+
+```php
+'cronSubscribers' => [
+    'App\EventSubscribers\MySubscriber'
+]
+```
+
 ### Webhooks
 
 You can optionally specify a URL that will be called upon a successful run. The output from the run will be available using the `m` query parameter. This was designed to be compatible with [Dead Man's Snitch](https://deadmanssnitch.com/).

composer.json

@@ -23,7 +23,8 @@
 	},
 	"require": {
 		"php": ">=5.6.0",
-		"symfony/lock": "~3.0|~4.0"
+		"symfony/lock": "~3.0|~4.0",
+		"symfony/event-dispatcher": "~3.0|~4.0"
 	},
 	"require-dev": {
 		"infuse/infuse": "~1.6",

src/Console/RunScheduledCommand.php

@@ -42,8 +42,25 @@ private function getSchedule()
         $lockFactory = $this->app['lock_factory'];
         $namespace = $this->app['config']->get('app.hostname');
         $schedule = new JobSchedule($jobs, $lockFactory, $namespace);
+        $this->addSubscribers($schedule);
         $schedule->setLogger($this->app['logger']);
 
         return $schedule;
     }
+
+    /**
+     * @param JobSchedule $schedule
+     */
+    private function addSubscribers(JobSchedule $schedule)
+    {
+        $subscribers = $this->app['config']->get('cronSubscribers', []);
+        foreach ($subscribers as $class) {
+            $subscriber = new $class();
+            if (method_exists($subscriber, 'setApp')) {
+                $subscriber->setApp($this->app);
+            }
+
+            $schedule->subscribe($subscriber);
+        }
+    }
 }

src/Events/CronJobBeginEvent.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Infuse\Cron\Events;
+
+use Symfony\Component\EventDispatcher\Event;
+
+class CronJobBeginEvent extends Event
+{
+    const NAME = 'cron_job.begin';
+
+    /**
+     * @var string
+     */
+    protected $jobId;
+
+    /**
+     * @param string $jobId
+     */
+    public function __construct($jobId)
+    {
+        $this->jobId = $jobId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getJobId()
+    {
+        return $this->jobId;
+    }
+}

src/Events/CronJobFinishedEvent.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Infuse\Cron\Events;
+
+use Symfony\Component\EventDispatcher\Event;
+
+class CronJobFinishedEvent extends Event
+{
+    const NAME = 'cron_job.finished';
+
+    /**
+     * @var string
+     */
+    protected $jobId;
+
+    /**
+     * @var string
+     */
+    protected $result;
+
+    /**
+     * @param string $jobId
+     * @param string $result
+     */
+    public function __construct($jobId, $result)
+    {
+        $this->jobId = $jobId;
+        $this->result = $result;
+    }
+
+    /**
+     * @return string
+     */
+    public function getJobId()
+    {
+        return $this->jobId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getResult()
+    {
+        return $this->result;
+    }
+}

src/Events/ScheduleRunBeginEvent.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Infuse\Cron\Events;
+
+use Symfony\Component\EventDispatcher\Event;
+
+class ScheduleRunBeginEvent extends Event
+{
+    const NAME = 'schedule_run.begin';
+}

src/Events/ScheduleRunFinishedEvent.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Infuse\Cron\Events;
+
+use Symfony\Component\EventDispatcher\Event;
+
+class ScheduleRunFinishedEvent extends Event
+{
+    const NAME = 'schedule_run.finished';
+}

src/Libs/JobSchedule.php

@@ -11,9 +11,13 @@
 
 namespace Infuse\Cron\Libs;
 
+use Infuse\Cron\Events\ScheduleRunBeginEvent;
+use Infuse\Cron\Events\ScheduleRunFinishedEvent;
 use Infuse\Cron\Models\CronJob;
 use Psr\Log\LoggerAwareTrait;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Lock\Factory;
 
 class JobSchedule
@@ -25,6 +29,11 @@ class JobSchedule
      */
     private $jobs;
 
+    /**
+     * @var EventDispatcher
+     */
+    private $dispatcher;
+
     /**
      * @var Factory
      */
@@ -45,6 +54,7 @@ public function __construct(array $jobs, Factory $lockFactory, $namespace = '')
         $this->jobs = $jobs;
         $this->lockFactory = $lockFactory;
         $this->namespace = $namespace;
+        $this->dispatcher = new EventDispatcher();
     }
 
     /**
@@ -57,6 +67,46 @@ public function getAllJobs()
         return $this->jobs;
     }
 
+    /**
+     * Gets the event dispatcher.
+     *
+     * @return EventDispatcher
+     */
+    public function getEventDispatcher()
+    {
+        return $this->dispatcher;
+    }
+
+    /**
+     * Registers a listener for an event.
+     *
+     * @param string   $eventName
+     * @param callable $listener
+     * @param int      $priority
+     *
+     * @return $this
+     */
+    public function listen($eventName, callable $listener, $priority = 0)
+    {
+        $this->dispatcher->addListener($eventName, $listener, $priority);
+
+        return $this;
+    }
+
+    /**
+     * Registers an event subscriber.
+     *
+     * @param EventSubscriberInterface $subscriber
+     *
+     * @return $this
+     */
+    public function subscribe(EventSubscriberInterface $subscriber)
+    {
+        $this->dispatcher->addSubscriber($subscriber);
+
+        return $this;
+    }
+
     /**
      * Gets all of the jobs scheduled to run, now.
      *
@@ -106,13 +156,19 @@ public function runScheduled(OutputInterface $output)
     {
         $success = true;
 
+        $event = new ScheduleRunBeginEvent();
+        $this->dispatcher->dispatch($event::NAME, $event);
+
         foreach ($this->getScheduledJobs() as $jobInfo) {
             $job = $jobInfo['model'];
             $run = $this->runJob($job, $jobInfo, $output);
 
             $success = $run->succeeded() && $success;
         }
 
+        $event = new ScheduleRunFinishedEvent();
+        $this->dispatcher->dispatch($event::NAME, $event);
+
         return $success;
     }
 
@@ -131,7 +187,7 @@ private function runJob(CronJob $job, array $jobInfo, OutputInterface $output)
 
         // set up the runner
         $class = array_value($jobInfo, 'class');
-        $runner = new Runner($job, $class, $this->lockFactory, $this->namespace);
+        $runner = new Runner($job, $class, $this->dispatcher, $this->lockFactory, $this->namespace);
         if ($this->logger) {
             $runner->setLogger($this->logger);
         }

src/Libs/Run.php

@@ -25,7 +25,7 @@ class Run
     private $output = [];
 
     /**
-     * @var int
+     * @var string
      */
     private $result;
 
@@ -69,7 +69,7 @@ public function getOutput()
     /**
      * Sets the result of the run.
      *
-     * @param int $result
+     * @param string $result
      *
      * @return self
      */
@@ -83,7 +83,7 @@ public function setResult($result)
     /**
      * Gets the result of the run.
      *
-     * @return int
+     * @return string
      */
     public function getResult()
     {

src/Libs/Runner.php

@@ -3,8 +3,11 @@
 namespace Infuse\Cron\Libs;
 
 use Exception;
+use Infuse\Cron\Events\CronJobBeginEvent;
+use Infuse\Cron\Events\CronJobFinishedEvent;
 use Infuse\Cron\Models\CronJob;
 use Psr\Log\LoggerAwareTrait;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Lock\Factory;
 
 class Runner
@@ -16,6 +19,11 @@ class Runner
      */
     private $jobModel;
 
+    /**
+     * @var EventDispatcher
+     */
+    private $dispatcher;
+
     /**
      * @var Lock
      */
@@ -27,15 +35,17 @@ class Runner
     private $class;
 
     /**
-     * @param CronJob $job
-     * @param string  $class       callable job class
-     * @param Factory $lockFactory
-     * @param string  $namespace
+     * @param CronJob         $job
+     * @param string          $class       callable job class
+     * @param EventDispatcher $dispatcher
+     * @param Factory         $lockFactory
+     * @param string          $namespace
      */
-    public function __construct(CronJob $job, $class, Factory $lockFactory, $namespace = '')
+    public function __construct(CronJob $job, $class, EventDispatcher $dispatcher, Factory $lockFactory, $namespace = '')
     {
         $this->jobModel = $job;
         $this->class = $class;
+        $this->dispatcher = $dispatcher;
         $this->lock = new Lock($this->jobModel->id, $lockFactory, $namespace);
     }
 
@@ -79,15 +89,27 @@ public function go($expires = 0, $successUrl = false, Run $run = null)
             return $run->setResult(Run::RESULT_LOCKED);
         }
 
+        // call the `cron_job.begin` event
+        $event = new CronJobBeginEvent($this->jobModel->id);
+        $this->dispatcher->dispatch($event::NAME, $event);
+        if ($event->isPropagationStopped()) {
+            $run->writeOutput('Rejected by cron_job.begin event listener')
+                ->setResult(Run::RESULT_FAILED);
+        }
+
         // set up the callable
         $job = $this->setUp($this->class, $run);
 
         // this is where the job actually gets called
-        if ($job) {
+        if ($job && !$event->isPropagationStopped()) {
             $this->invoke($job, $run);
         }
 
         // perform post-run tasks:
+        // call the `cron_job.finished` event
+        $event = new CronJobFinishedEvent($this->jobModel->id, $run->getResult());
+        $this->dispatcher->dispatch($event::NAME, $event);
+
         // persist the result
         $this->saveRun($run);
 
@@ -181,7 +203,9 @@ private function saveRun(Run $run)
     }
 
     /**
-     * Pings a URL about a successful run.
+     * @deprecated should be moved to an event listener
+     *
+     * Pings a URL about a successful run
      *
      * @param string $url
      * @param Run    $run

src/migrations/20140823163217_cron_job.php

@@ -3,7 +3,7 @@
 /**
  * @author Jared King <j@jaredtking.com>
  *
- * @link http://jaredtking.com
+ * @see http://jaredtking.com
  *
  * @copyright 2015 Jared King
  * @license MIT