├── .gitignore
├── nbproject
    ├── project.properties
    └── project.xml
├── ThirdParty
    ├── README.md
    └── Cron
    │   ├── YearField.php
    │   ├── LICENSE
    │   ├── MonthField.php
    │   ├── FieldInterface.php
    │   ├── FieldFactory.php
    │   ├── MinutesField.php
    │   ├── HoursField.php
    │   ├── README.md
    │   ├── DayOfMonthField.php
    │   ├── AbstractField.php
    │   ├── DayOfWeekField.php
    │   └── CronExpression.php
├── Entity
    ├── TimingRepository.php
    └── Timing.php
├── TimingEvents.php
├── phpunit.xml.dist
├── Views
    └── FormTheme
    │   └── Custom
    │       ├── timing_row.html.php
    │       ├── _campaignevent_timing_expression_row.html.php
    │       └── timing_label.html.php
├── Tests
    └── Form
    │   └── Type
    │       └── TimingTypeTest.php
├── Config
    └── config.php
├── Model
    ├── EventModel.php
    └── TimingModel.php
├── EventListener
    ├── CampaignEventSubscriber.php
    ├── TimingFormSubscriber.php
    └── DoctrineSubscriber.php
├── DependencyInjection
    └── Compiler
    │   └── OverrideServiceCompilerPass.php
├── ThirdSetMauticTimingBundle.php
├── Form
    ├── Type
    │   └── TimingType.php
    └── Extension
    │   └── EventTypeExtension.php
├── changelog.txt
├── Event
    └── CampaignPreExecutionEvent.php
├── README.md
├── Executioner
    ├── EventExecutioner.php
    ├── Scheduler
    │   └── EventScheduler.php
    ├── KickoffExecutioner.php
    ├── RealTimeExecutioner.php
    └── ScheduledExecutioner.php
├── Helper
    └── TimingHelper.php
└── license.txt


/.gitignore:
--------------------------------------------------------------------------------
1 | # NetBeans
2 | /nbproject/private/
3 | 
4 | # OSX
5 | .DS_Store
6 | 


--------------------------------------------------------------------------------
/nbproject/project.properties:
--------------------------------------------------------------------------------
1 | include.path=${php.global.include.path}
2 | php.version=PHP_56
3 | source.encoding=UTF-8
4 | src.dir=.
5 | tags.asp=false
6 | tags.short=false
7 | web.root=.
8 | 


--------------------------------------------------------------------------------
/nbproject/project.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://www.netbeans.org/ns/project/1">
 3 |     <type>org.netbeans.modules.php.project</type>
 4 |     <configuration>
 5 |         <data xmlns="http://www.netbeans.org/ns/php-project/1">
 6 |             <name>ThirdSetMauticTimingBundle</name>
 7 |         </data>
 8 |     </configuration>
 9 | </project>
10 | 


--------------------------------------------------------------------------------
/ThirdParty/README.md:
--------------------------------------------------------------------------------
1 | # ThirdParty Bundles
2 | 
3 | As of this writing, Mautic doesn't seem to have a published way for plugins to
4 | include dependencies (see https://www.mautic.org/community/index.php/4898-about-plugin-dependencies/0).
5 | 
6 | As a hack to get around this limitation, we include the source of the bundles
7 | here.  We've updated the namespacing in the source code to use our plugin's
8 | namespace as a base in order to prevent conflicts, etc.
9 | 


--------------------------------------------------------------------------------
/Entity/TimingRepository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Entity;
11 | 
12 | use Mautic\CoreBundle\Entity\CommonRepository;
13 | 
14 | class TimingRepository extends CommonRepository
15 | {
16 |     
17 | }
18 | 


--------------------------------------------------------------------------------
/TimingEvents.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle;
11 | 
12 | /**
13 |  * Class TimingEvents.
14 |  * Events available for ThirdSetMauticTimingBundle.
15 |  */
16 | final class TimingEvents
17 | {
18 | 
19 |     /**
20 |      * The plugin.thirdset.timing.campaign_pre_event_execution event is
21 |      * dispatched before a campaign event is executed.
22 |      *
23 |      * The event listener receives a
24 |      * MauticPlugin\ThirdSetMauticTimingBundle\Event\CampaignPreExceutionEvent
25 |      * instance.
26 |      *
27 |      * @var string
28 |      */
29 |     const PRE_EVENT_EXECUTION = 'plugin.thirdset.timing.campaign_pre_event_execution';
30 | 
31 | }
32 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/YearField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | 
 5 | use DateTime;
 6 | 
 7 | 
 8 | /**
 9 |  * Year field.  Allows: * , / -
10 |  */
11 | class YearField extends AbstractField
12 | {
13 |     public function isSatisfiedBy(DateTime $date, $value)
14 |     {
15 |         return $this->isSatisfied($date->format('Y'), $value);
16 |     }
17 | 
18 |     public function increment(DateTime $date, $invert = false)
19 |     {
20 |         if ($invert) {
21 |             $date->modify('-1 year');
22 |             $date->setDate($date->format('Y'), 12, 31);
23 |             $date->setTime(23, 59, 0);
24 |         } else {
25 |             $date->modify('+1 year');
26 |             $date->setDate($date->format('Y'), 1, 1);
27 |             $date->setTime(0, 0, 0);
28 |         }
29 | 
30 |         return $this;
31 |     }
32 | 
33 |     public function validate($value)
34 |     {
35 |         return (bool) preg_match('/^[\*,\/\-0-9]+$/', $value);
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2011 Michael Dowling <mtdowling@gmail.com> and contributors
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is
 8 | furnished to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in
11 | all copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.
20 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <!-- http://www.phpunit.de/manual/current/en/appendixes.configuration.html -->
 4 | <phpunit
 5 |     backupGlobals               = "false"
 6 |     backupStaticAttributes      = "false"
 7 |     colors                      = "true"
 8 |     convertErrorsToExceptions   = "true"
 9 |     convertNoticesToExceptions  = "true"
10 |     convertWarningsToExceptions = "true"
11 |     processIsolation            = "false"
12 |     stopOnFailure               = "false"
13 |     bootstrap                   = "../../autoload.php" >
14 | 
15 |     <testsuites>
16 |         <testsuite name="thirdset_timing">
17 |             <directory>Tests</directory>
18 |         </testsuite>
19 |     </testsuites>
20 |     
21 |     <filter>
22 |         <whitelist>
23 |             <directory>bundles</directory>
24 |             <exclude>
25 |                 <directory>bundles/*Bundle/Config</directory>
26 |                 <directory>bundles/*Bundle/Tests</directory>
27 |                 <directory>bundles/*Bundle/Translations</directory>
28 |                 <directory>bundles/*Bundle/Views</directory>
29 |             </exclude>
30 |         </whitelist>
31 |     </filter>
32 | 
33 | </phpunit>
34 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/MonthField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | 
 5 | use DateTime;
 6 | 
 7 | /**
 8 |  * Month field.  Allows: * , / -
 9 |  */
10 | class MonthField extends AbstractField
11 | {
12 |     public function isSatisfiedBy(DateTime $date, $value)
13 |     {
14 |         // Convert text month values to integers
15 |         $value = str_ireplace(
16 |             array(
17 |                 'JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN',
18 |                 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC'
19 |             ),
20 |             range(1, 12),
21 |             $value
22 |         );
23 | 
24 |         return $this->isSatisfied($date->format('m'), $value);
25 |     }
26 | 
27 |     public function increment(DateTime $date, $invert = false)
28 |     {
29 |         if ($invert) {
30 |             $date->modify('last day of previous month');
31 |             $date->setTime(23, 59);
32 |         } else {
33 |             $date->modify('first day of next month');
34 |             $date->setTime(0, 0);
35 |         }
36 | 
37 |         return $this;
38 |     }
39 | 
40 |     public function validate($value)
41 |     {
42 |         return (bool) preg_match('/^[\*,\/\-0-9A-Z]+$/', $value);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/FieldInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | use DateTime;
 5 | 
 6 | /**
 7 |  * CRON field interface
 8 |  */
 9 | interface FieldInterface
10 | {
11 |     /**
12 |      * Check if the respective value of a DateTime field satisfies a CRON exp
13 |      *
14 |      * @param DateTime $date  DateTime object to check
15 |      * @param string   $value CRON expression to test against
16 |      *
17 |      * @return bool Returns TRUE if satisfied, FALSE otherwise
18 |      */
19 |     public function isSatisfiedBy(DateTime $date, $value);
20 | 
21 |     /**
22 |      * When a CRON expression is not satisfied, this method is used to increment
23 |      * or decrement a DateTime object by the unit of the cron field
24 |      *
25 |      * @param DateTime $date   DateTime object to change
26 |      * @param bool     $invert (optional) Set to TRUE to decrement
27 |      *
28 |      * @return FieldInterface
29 |      */
30 |     public function increment(DateTime $date, $invert = false);
31 | 
32 |     /**
33 |      * Validates a CRON expression for a given field
34 |      *
35 |      * @param string $value CRON expression value to validate
36 |      *
37 |      * @return bool Returns TRUE if valid, FALSE otherwise
38 |      */
39 |     public function validate($value);
40 | }
41 | 


--------------------------------------------------------------------------------
/Views/FormTheme/Custom/timing_row.html.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | /**
11 |  * This template was copied from CoreBundle\Views\FormTheme\Custom\form_row.html.php
12 |  * It modifies the row for the timing fields and adds an <hr/> tag above it.
13 |  * 
14 |  * The folder of theme files is registered in the ThirdSetMauticTimingBundle
15 |  * class.
16 |  * 
17 |  * You can see what other theme files are searched for by editing
18 |  * Symfony\Bundle\FrameworkBundle\Templating\Loader\FileSystemLoader->load()
19 |  *   Add the following line at the top of the function:
20 |  *       echo $template->getPath();
21 |  *   Then load the form in a browser. Note that you may need to find the output 
22 |  * by using the browser's Developer Tools.
23 |  */
24 | 
25 | $hasErrors     = count($form->vars['errors']);
26 | $feedbackClass = (!empty($hasErrors)) ? ' has-error' : '';
27 | ?>
28 | <hr/>
29 | <div class="row">
30 |     <div class="form-group col-xs-12 <?php echo $feedbackClass; ?>">
31 |         <?php echo $view['form']->label($form, $label) ?>
32 |         <?php echo $view['form']->widget($form) ?>
33 |         <?php echo $view['form']->errors($form) ?>
34 |     </div>
35 | </div>


--------------------------------------------------------------------------------
/Views/FormTheme/Custom/_campaignevent_timing_expression_row.html.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | /**
11 |  * This template was copied from CoreBundle\Views\FormTheme\Custom\form_row.html.php
12 |  * It modifies the row for the timing fields and adds an <hr/> tag above it.
13 |  * 
14 |  * The folder of theme files is registered in the ThirdSetMauticTimingBundle
15 |  * class.
16 |  * 
17 |  * You can see what other theme files are searched for by editing
18 |  * Symfony\Bundle\FrameworkBundle\Templating\Loader\FileSystemLoader->load()
19 |  *   Add the following line at the top of the function:
20 |  *       echo $template->getPath();
21 |  *   Then load the form in a browser. Note that you may need to find the output 
22 |  * by using the browser's Developer Tools.
23 |  */
24 | 
25 | $hasErrors     = count($form->vars['errors']);
26 | $feedbackClass = (!empty($hasErrors)) ? ' has-error' : '';
27 | ?>
28 | <hr/>
29 | <div class="row">
30 |     <div class="form-group col-xs-12 <?php echo $feedbackClass; ?>">
31 |         <?php echo $view['form']->label($form, $label) ?>
32 |         <?php echo $view['form']->widget($form) ?>
33 |         <a href="#" style="margin-left: 1em;" onclick="mQuery('#campaignevent_timing_expression').val('* 09-17 * * 1-5'); return true;" title="Set the expression to 9AM to 5PM, Monday through Friday."><small>Use Work Hours</small></a>
34 |         <?php echo $view['form']->errors($form) ?>
35 |     </div>
36 | </div>


--------------------------------------------------------------------------------
/Tests/Form/Type/TimingTypeTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @package     ThirdSetMauticTimingBundle
 5 |  * @copyright   2020 Third Set Productions. All rights reserved.
 6 |  * @author      Third Set Productions
 7 |  * @link        http://www.thirdset.com
 8 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 9 |  */
10 | 
11 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Tests\Form\Type;
12 | 
13 | use Symfony\Component\Form\Test\TypeTestCase;
14 | use Symfony\Component\Form\FormBuilderInterface;
15 | use Symfony\Component\HttpFoundation\Session\Session;
16 | 
17 | use MauticPlugin\ThirdSetMauticTimingBundle\Form\Type\TimingType;
18 | use MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel;
19 | 
20 | /**
21 |  * Tests the TimingType class.
22 |  */
23 | class TimingTypeTest extends \PHPUnit\Framework\TestCase
24 | {
25 |     /**
26 |      * @testdox buildForm builds form as expected.
27 |      */
28 |     public function testBuildForm()
29 |     {
30 |         // Set up dependencies.
31 |         $session = new Session();
32 |         $timingModel = new TimingModel();
33 |         $builder = $this->getMockBuilder(FormBuilderInterface::class)
34 |                             ->disableOriginalConstructor()
35 |                             ->getMock();
36 |         $builder->expects($spy = $this->any())->method('add');
37 |         $options = array();
38 | 
39 |         // Instantiate the SUT (System Under Test) class.
40 |         $timingType = new TimingType($session, $timingModel);
41 | 
42 |         // Assert that the class was instantiated as expected.
43 |         $this->assertEquals(TimingType::class, get_class($timingType));
44 | 
45 |         // Call the method.
46 |         $timingType->buildForm($builder, $options);
47 | 
48 |         // Assert that the builder's add method was called as expected.
49 |         $this->assertEquals(3, $spy->getInvocationCount());
50 |     }
51 | 
52 | }
53 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/FieldFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | 
 5 | use InvalidArgumentException;
 6 | 
 7 | /**
 8 |  * CRON field factory implementing a flyweight factory
 9 |  * @link http://en.wikipedia.org/wiki/Cron
10 |  */
11 | class FieldFactory
12 | {
13 |     /**
14 |      * @var array Cache of instantiated fields
15 |      */
16 |     private $fields = array();
17 | 
18 |     /**
19 |      * Get an instance of a field object for a cron expression position
20 |      *
21 |      * @param int $position CRON expression position value to retrieve
22 |      *
23 |      * @return FieldInterface
24 |      * @throws InvalidArgumentException if a position is not valid
25 |      */
26 |     public function getField($position)
27 |     {
28 |         if (!isset($this->fields[$position])) {
29 |             switch ($position) {
30 |                 case 0:
31 |                     $this->fields[$position] = new MinutesField();
32 |                     break;
33 |                 case 1:
34 |                     $this->fields[$position] = new HoursField();
35 |                     break;
36 |                 case 2:
37 |                     $this->fields[$position] = new DayOfMonthField();
38 |                     break;
39 |                 case 3:
40 |                     $this->fields[$position] = new MonthField();
41 |                     break;
42 |                 case 4:
43 |                     $this->fields[$position] = new DayOfWeekField();
44 |                     break;
45 |                 case 5:
46 |                     $this->fields[$position] = new YearField();
47 |                     break;
48 |                 default:
49 |                     throw new InvalidArgumentException(
50 |                         $position . ' is not a valid position'
51 |                     );
52 |             }
53 |         }
54 | 
55 |         return $this->fields[$position];
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/Views/FormTheme/Custom/timing_label.html.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | /**
11 |  * This template was copied from CoreBundle\Views\FormTheme\Custom\form_label.html.php
12 |  * It modifies the label for the timing fields.
13 |  * 
14 |  * The folder of theme files is registered in the ThirdSetMauticTimingBundle
15 |  * class.
16 |  * 
17 |  * You can see what other theme files are searched for by editing
18 |  * Symfony\Bundle\FrameworkBundle\Templating\Loader\FileSystemLoader->load()
19 |  *   Add the following line at the top of the function:
20 |  *       echo $template->getPath();
21 |  *   Then load the form in a browser. Note that you may need to find the output 
22 |  * by using the browser's Developer Tools.
23 |  */
24 | ?>
25 | 
26 | <?php if (false !== $label): ?>
27 | <?php if ($required) {
28 |     $label_attr['class'] = trim((isset($label_attr['class']) ? $label_attr['class'] : '').' required');
29 | } ?>
30 | <?php if (!$compound) {
31 |     $label_attr['for'] = $id;
32 | } ?>
33 | <?php if (!$label) {
34 |     $label = $view['form']->humanize($name);
35 | } ?>
36 | <?php $tooltip = (!empty($form->vars['attr']['tooltip'])) ? $form->vars['attr']['tooltip'] : false; ?>
37 | <h3 <?php foreach ($label_attr as $k => $v) {
38 |     printf('%s="%s" ', $view->escape($k), $view->escape($v));
39 | } ?><?php if ($tooltip): ?>data-toggle="tooltip" data-container="body" data-placement="top" title="<?php echo $view['translator']->trans($tooltip); ?>"<?php endif; ?>><?php echo $view->escape($view['translator']->trans($label, [], $translation_domain)) ?><?php if ($tooltip): ?> <i class="fa fa-question-circle"></i><?php endif; ?></h3>
40 | <h6 class="text-muted" style="margin-bottom: 1em;">Use the settings in this section to control when this event can occur.</h6>
41 | <?php endif ?>
42 | 
43 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/MinutesField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | 
 5 | use DateTime;
 6 | 
 7 | 
 8 | /**
 9 |  * Minutes field.  Allows: * , / -
10 |  */
11 | class MinutesField extends AbstractField
12 | {
13 |     public function isSatisfiedBy(DateTime $date, $value)
14 |     {
15 |         return $this->isSatisfied($date->format('i'), $value);
16 |     }
17 | 
18 |     public function increment(DateTime $date, $invert = false, $parts = null)
19 |     {
20 |         if (null === $parts) {
21 |             if ($invert) {
22 |                 $date->modify('-1 minute');
23 |             } else {
24 |                 $date->modify('+1 minute');
25 |             }
26 |             return $this;
27 |         }
28 | 
29 |         $parts = strpos($parts, ',') !== false ? explode(',', $parts) : array($parts);
30 |         $minutes = array();
31 |         foreach ($parts as $part) {
32 |             $minutes = array_merge($minutes, $this->getRangeForExpression($part, 59));
33 |         }
34 | 
35 |         $current_minute = $date->format('i');
36 |         $position = $invert ? count($minutes) - 1 : 0;
37 |         if (count($minutes) > 1) {
38 |             for ($i = 0; $i < count($minutes) - 1; $i++) {
39 |                 if ((!$invert && $current_minute >= $minutes[$i] && $current_minute < $minutes[$i + 1]) ||
40 |                     ($invert && $current_minute > $minutes[$i] && $current_minute <= $minutes[$i + 1])) {
41 |                     $position = $invert ? $i : $i + 1;
42 |                     break;
43 |                 }
44 |             }
45 |         }
46 | 
47 |         if ((!$invert && $current_minute >= $minutes[$position]) || ($invert && $current_minute <= $minutes[$position])) {
48 |             $date->modify(($invert ? '-' : '+') . '1 hour');
49 |             $date->setTime($date->format('H'), $invert ? 59 : 0);
50 |         }
51 |         else {
52 |             $date->setTime($date->format('H'), $minutes[$position]);
53 |         }
54 | 
55 |         return $this;
56 |     }
57 | 
58 |     public function validate($value)
59 |     {
60 |         return (bool) preg_match('/^[\*,\/\-0-9]+$/', $value);
61 |     }
62 | }
63 | 


--------------------------------------------------------------------------------
/Config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2022 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | /**
11 |  * Configure the plugin.
12 |  * Note: there are additional services defined in the ThirdSetMauticTimingBundle
13 |  * class.
14 |  */
15 | return array(
16 |     'name'        => 'Timing',
17 |     'description' => 'Allows for processing actions only during certain times.',
18 |     'version'     => '2.1.2',
19 |     'author'      => 'Third Set Productions',
20 |     'services'    => array(
21 |         //MODELS
22 |         'models' => array(
23 |             'plugin.thirdset.timing.event_timing_model' => array(
24 |                 'class'     => 'MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel',
25 |             ),
26 |         ),
27 |         //OTHER
28 |         'other' => array(
29 |             //SUBSCRIBERS
30 |             'plugin.thirdset.timing.doctrine_subscriber' => array(
31 |                 'class'     => 'MauticPlugin\ThirdSetMauticTimingBundle\EventListener\DoctrineSubscriber',
32 |                 'tag'       => 'doctrine.event_subscriber',
33 |                 'arguments' => [
34 |                     'session',
35 |                 ],
36 |             ),
37 |         ),
38 |         //HELPERS
39 |         'helpers' => array(
40 |             'plugin.thirdset.timing.timing_helper' => array(
41 |                 'class'     => 'MauticPlugin\ThirdSetMauticTimingBundle\Helper\TimingHelper',
42 |                 'arguments' => [
43 |                     'plugin.thirdset.timing.event_timing_model',
44 |                 ]
45 |             ),
46 |         ),
47 |         //EVENT SUBSCRIBERS/LISTENERS (Note: there are more in the "other" section)
48 |         'events' => array(
49 |             'plugin.thirdset.timing.campaign_event_subscriber' => array(
50 |                 'class'     => 'MauticPlugin\ThirdSetMauticTimingBundle\EventListener\CampaignEventSubscriber',
51 |                 'arguments' => 'plugin.thirdset.timing.timing_helper',
52 |             ),
53 |         ),
54 |     ),
55 | 
56 | );


--------------------------------------------------------------------------------
/Model/EventModel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Model;
11 | 
12 | use MauticPlugin\ThirdSetMauticTimingBundle\Event\CampaignPreExecutionEvent;
13 | use MauticPlugin\ThirdSetMauticTimingBundle\TimingEvents;
14 | 
15 | /**
16 |  * The EventModel class extends Mautic's EventModel class to add our additional
17 |  * events, etc.
18 |  *
19 |  * @package ThirdSetMauticTimingBundle
20 |  * @since 1.0
21 |  */
22 | class EventModel extends \Mautic\CampaignBundle\Model\EventModel
23 | {
24 |     /**
25 |      * {@inheritdoc}
26 |      */
27 |     public function executeEvent(
28 |         $event,
29 |         $campaign,
30 |         $lead,
31 |         $eventSettings = null,
32 |         $allowNegative = false,
33 |         \DateTime $parentTriggeredDate = null,
34 |         $eventTriggerDate = null,
35 |         $logExists = false,
36 |         &$evaluatedEventCount = 0,
37 |         &$executedEventCount = 0,
38 |         &$totalEventCount = 0
39 |     ) {
40 |         //dispatch our custom event and filter the $eventTriggerDate
41 |         $preExecutionEvent = new CampaignPreExecutionEvent(
42 |                                     $event,
43 |                                     $parentTriggeredDate,
44 |                                     $allowNegative,
45 |                                     $lead,
46 |                                     $eventTriggerDate
47 |                                  );
48 |         $this->dispatcher->dispatch(TimingEvents::PRE_EVENT_EXECUTION, $preExecutionEvent);
49 | 
50 |         $eventTriggerDate = $preExecutionEvent->getEventTriggerDate();
51 | 
52 |         // Call the parent method.
53 |         return parent::executeEvent(
54 |             $event,
55 |             $campaign,
56 |             $lead,
57 |             $eventSettings,
58 |             $allowNegative,
59 |             $parentTriggeredDate,
60 |             $eventTriggerDate,
61 |             $logExists,
62 |             $evaluatedEventCount,
63 |             $executedEventCount,
64 |             $totalEventCount
65 |         );
66 |     }
67 | }
68 | 


--------------------------------------------------------------------------------
/EventListener/CampaignEventSubscriber.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\EventListener;
11 | 
12 | use Symfony\Component\EventDispatcher\EventSubscriberInterface;
13 | 
14 | use MauticPlugin\ThirdSetMauticTimingBundle\TimingEvents;
15 | use MauticPlugin\ThirdSetMauticTimingBundle\Event\CampaignPreExecutionEvent;
16 | use MauticPlugin\ThirdSetMauticTimingBundle\Helper\TimingHelper;
17 | 
18 | /**
19 |  * Class CampaignEventSubscriber.
20 |  *
21 |  * @package ThirdSetMauticTimingBundle
22 |  */
23 | class CampaignEventSubscriber implements EventSubscriberInterface
24 | {
25 | 
26 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Helper\TimingHelper */
27 |     private $timingHelper;
28 | 
29 |     /**
30 |      * Constructor.
31 |      * @param TimingHelper $timingHelper
32 |      */
33 |     public function __construct(
34 |                 TimingHelper $timingHelper
35 |             )
36 |     {
37 |         $this->timingHelper = $timingHelper;
38 |     }
39 | 
40 |     /**
41 |      * Get the list of events that this subscriber subscribes to.
42 |      * @return array
43 |      */
44 |     static public function getSubscribedEvents()
45 |     {
46 |         return [
47 |             TimingEvents::PRE_EVENT_EXECUTION => ['onPreEventExecution', 0],
48 |         ];
49 |     }
50 | 
51 |     /**
52 |      * Method to be applied to the
53 |      * plugin.thirdset.timing.campaign_pre_event_execution event.
54 |      * @param CampaignPreExecutionEvent $event
55 |      */
56 |     public function onPreEventExecution(CampaignPreExecutionEvent $event)
57 |     {
58 |         // if the eventTriggerDate is already set, just leave it alone.
59 |         if (null === $event->getEventTriggerDate()) {
60 | 
61 |             $eventTriggerDate = $this->timingHelper->checkEventTiming(
62 |                                             $event->getEventData(),
63 |                                             $event->getParentTriggeredDate(),
64 |                                             $event->allowNegative(),
65 |                                             $event->getLead()
66 |                                         );
67 | 
68 |             $event->setEventTriggerDate($eventTriggerDate);
69 |         }
70 |     }
71 | }


--------------------------------------------------------------------------------
/ThirdParty/Cron/HoursField.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
 4 | use DateTime;
 5 | use DateTimeZone;
 6 | 
 7 | 
 8 | /**
 9 |  * Hours field.  Allows: * , / -
10 |  */
11 | class HoursField extends AbstractField
12 | {
13 |     public function isSatisfiedBy(DateTime $date, $value)
14 |     {
15 |         return $this->isSatisfied($date->format('H'), $value);
16 |     }
17 | 
18 |     public function increment(DateTime $date, $invert = false, $parts = null)
19 |     {
20 |         // Change timezone to UTC temporarily. This will
21 |         // allow us to go back or forwards and hour even
22 |         // if DST will be changed between the hours.
23 |         if ((null === $parts) || ('*' === $parts)) {
24 |             $timezone = $date->getTimezone();
25 |             $date->setTimezone(new DateTimeZone('UTC'));
26 |             if ($invert) {
27 |                 $date->modify('-1 hour');
28 |             } else {
29 |                 $date->modify('+1 hour');
30 |             }
31 |             $date->setTimezone($timezone);
32 | 
33 |             $date->setTime($date->format('H'), $invert ? 59 : 0);
34 |             return $this;
35 |         }
36 | 
37 |         $parts = strpos($parts, ',') !== false ? explode(',', $parts) : array($parts);
38 |         $hours = array();
39 |         foreach ($parts as $part) {
40 |             $hours = array_merge($hours, $this->getRangeForExpression($part, 23));
41 |         }
42 | 
43 |         $current_hour = $date->format('H');
44 |         $position = $invert ? count($hours) - 1 : 0;
45 |         if (count($hours) > 1) {
46 |             for ($i = 0; $i < count($hours) - 1; $i++) {
47 |                 if ((!$invert && $current_hour >= $hours[$i] && $current_hour < $hours[$i + 1]) ||
48 |                     ($invert && $current_hour > $hours[$i] && $current_hour <= $hours[$i + 1])) {
49 |                     $position = $invert ? $i : $i + 1;
50 |                     break;
51 |                 }
52 |             }
53 |         }
54 | 
55 |         $hour = $hours[$position];
56 |         if ((!$invert && $date->format('H') >= $hour) || ($invert && $date->format('H') <= $hour)) {
57 |             $date->modify(($invert ? '-' : '+') . '1 day');
58 |             $date->setTime($invert ? 23 : 0, $invert ? 59 : 0);
59 |         }
60 |         else {
61 |             $date->setTime($hour, $invert ? 59 : 0);
62 |         }
63 | 
64 |         return $this;
65 |     }
66 | 
67 |     public function validate($value)
68 |     {
69 |         return (bool) preg_match('/^[\*,\/\-0-9]+$/', $value);
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/Model/TimingModel.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Model;
11 | 
12 | use Mautic\CoreBundle\Model\FormModel as CommonFormModel;
13 | use Mautic\CampaignBundle\Entity\Event;
14 | 
15 | use MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing;
16 | 
17 | /**
18 |  * Class TimingModel
19 |  * {@inheritdoc}
20 |  */
21 | class TimingModel extends CommonFormModel
22 | {
23 | 
24 |     /**
25 |      * EvetTimingModel constructor.
26 |      */
27 |     public function __construct()
28 |     {
29 |         //
30 |     }
31 | 
32 |     /**
33 |      * {@inheritdoc}
34 |      *
35 |      * @return \MauticPlugin\ThirdSetMauticTimingBundle\Entity\TimingRepository
36 |      */
37 |     public function getRepository()
38 |     {
39 |         return $this->em->getRepository('ThirdSetMauticTimingBundle:Timing');
40 |     }
41 | 
42 |     /**
43 |      * Gets a Timing entity by its id or generates a new Timing entity if no id
44 |      * is passed.
45 |      *
46 |      * @param null|integer $id The id of the Timing entity.
47 |      *
48 |      * @return Entity Returns the Entity specified by $id or generates a new one
49 |      * if it doesn't yet exist.
50 |      */
51 |     public function getEntity($id = null)
52 |     {
53 |         if (null === $id) {
54 |             return new Timing();
55 |         }
56 | 
57 |         return parent::getEntity($id);
58 |     }
59 | 
60 |     /**
61 |      * Get a specific Timing entity or generate a new one if it doesn't yet
62 |      * exist.
63 |      *
64 |      * @param $event Event The event that the Timing is for.
65 |      *
66 |      * @return null|Timing Returns the Timing for the passed Event.
67 |      */
68 |     public function getTimingForEvent(Event $event = null)
69 |     {
70 |         if (null === $event) {
71 |             return new Timing($event);
72 |         }
73 | 
74 |         $entity = parent::getEntity($event->getId());
75 | 
76 |         if (null === $entity) {
77 |             $entity = new Timing($event);
78 |         }
79 | 
80 |         return $entity;
81 |     }
82 | 
83 |     /**
84 |      * Get a specific Timing entity.
85 |      * @param $id The id of the Timing entity that you want to get.
86 |      * @return Timing
87 |      */
88 |     public function getById($id)
89 |     {
90 |         $entity = parent::getEntity($id);
91 | 
92 |         return $entity;
93 |     }
94 | 
95 | }
96 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/README.md:
--------------------------------------------------------------------------------
 1 | PHP Cron Expression Parser
 2 | ==========================
 3 | 
 4 | [![Latest Stable Version](https://poser.pugx.org/mtdowling/cron-expression/v/stable.png)](https://packagist.org/packages/mtdowling/cron-expression) [![Total Downloads](https://poser.pugx.org/mtdowling/cron-expression/downloads.png)](https://packagist.org/packages/mtdowling/cron-expression) [![Build Status](https://secure.travis-ci.org/mtdowling/cron-expression.png)](http://travis-ci.org/mtdowling/cron-expression)
 5 | 
 6 | The PHP cron expression parser can parse a CRON expression, determine if it is
 7 | due to run, calculate the next run date of the expression, and calculate the previous
 8 | run date of the expression.  You can calculate dates far into the future or past by
 9 | skipping n number of matching dates.
10 | 
11 | The parser can handle increments of ranges (e.g. */12, 2-59/3), intervals (e.g. 0-9),
12 | lists (e.g. 1,2,3), W to find the nearest weekday for a given day of the month, L to
13 | find the last day of the month, L to find the last given weekday of a month, and hash
14 | (#) to find the nth weekday of a given month.
15 | 
16 | Installing
17 | ==========
18 | 
19 | Add the dependency to your project:
20 | 
21 | ```bash
22 | composer require mtdowling/cron-expression
23 | ```
24 | 
25 | Usage
26 | =====
27 | ```php
28 | <?php
29 | 
30 | require_once '/vendor/autoload.php';
31 | 
32 | // Works with predefined scheduling definitions
33 | $cron = Cron\CronExpression::factory('@daily');
34 | $cron->isDue();
35 | echo $cron->getNextRunDate()->format('Y-m-d H:i:s');
36 | echo $cron->getPreviousRunDate()->format('Y-m-d H:i:s');
37 | 
38 | // Works with complex expressions
39 | $cron = Cron\CronExpression::factory('3-59/15 2,6-12 */15 1 2-5');
40 | echo $cron->getNextRunDate()->format('Y-m-d H:i:s');
41 | 
42 | // Calculate a run date two iterations into the future
43 | $cron = Cron\CronExpression::factory('@daily');
44 | echo $cron->getNextRunDate(null, 2)->format('Y-m-d H:i:s');
45 | 
46 | // Calculate a run date relative to a specific time
47 | $cron = Cron\CronExpression::factory('@monthly');
48 | echo $cron->getNextRunDate('2010-01-12 00:00:00')->format('Y-m-d H:i:s');
49 | ```
50 | 
51 | CRON Expressions
52 | ================
53 | 
54 | A CRON expression is a string representing the schedule for a particular command to execute.  The parts of a CRON schedule are as follows:
55 | 
56 |     *    *    *    *    *    *
57 |     -    -    -    -    -    -
58 |     |    |    |    |    |    |
59 |     |    |    |    |    |    + year [optional]
60 |     |    |    |    |    +----- day of week (0 - 7) (Sunday=0 or 7)
61 |     |    |    |    +---------- month (1 - 12)
62 |     |    |    +--------------- day of month (1 - 31)
63 |     |    +-------------------- hour (0 - 23)
64 |     +------------------------- min (0 - 59)
65 | 
66 | Requirements
67 | ============
68 | 
69 | - PHP 5.3+
70 | - PHPUnit is required to run the unit tests
71 | - Composer is required to run the unit tests


--------------------------------------------------------------------------------
/DependencyInjection/Compiler/OverrideServiceCompilerPass.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2018 Third Set Productions.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | namespace MauticPlugin\ThirdSetMauticTimingBundle\DependencyInjection\Compiler;
10 | 
11 | use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
12 | use Symfony\Component\DependencyInjection\ContainerBuilder;
13 | use Symfony\Component\DependencyInjection\Reference;
14 | 
15 | /**
16 |  * Class OverrideServiceCompilerPass.
17 |  *
18 |  * This class has overrides for the Symfony services.
19 |  * See:
20 |  *  * http://symfony.com/doc/2.8/bundles/override.html#services-configuration
21 |  *  * http://symfony.com/doc/2.8/service_container/compiler_passes.html
22 |  *
23 |  * @package ThirdSetMauticTimingBundle
24 |  */
25 | class OverrideServiceCompilerPass implements CompilerPassInterface
26 | {
27 |     /**
28 |      * Process the compiler pass.
29 |      * @param $container
30 |      */
31 |     public function process(ContainerBuilder $container)
32 |     {
33 |         $schedulerDefinition = null;
34 | 
35 |         try {
36 |             $schedulerDefinition = $container->getDefinition('mautic.campaign.scheduler');
37 |         } catch (\Exception $ex) {
38 |             //
39 |         }
40 |         if (null !== $schedulerDefinition) {
41 |             // Mautic >= v2.14.0.
42 |             $schedulerDefinition
43 |                     ->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Executioner\Scheduler\EventScheduler')
44 |                     ->addArgument(new Reference('plugin.thirdset.timing.timing_helper'));
45 | 
46 |             $eventExecutionerDefinition = $container->getDefinition('mautic.campaign.event_executioner');
47 |             $eventExecutionerDefinition->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Executioner\EventExecutioner');
48 | 
49 |             $kickoffExecutionerDefinition = $container->getDefinition('mautic.campaign.executioner.kickoff');
50 |             $kickoffExecutionerDefinition->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Executioner\KickoffExecutioner');
51 | 
52 |             $realtimeExecutionerDefinition = $container->getDefinition('mautic.campaign.executioner.realtime');
53 |             $realtimeExecutionerDefinition->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Executioner\RealTimeExecutioner');
54 | 
55 |             $scheduledExecutionerDefinition = $container->getDefinition('mautic.campaign.executioner.scheduled');
56 |             $scheduledExecutionerDefinition->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Executioner\ScheduledExecutioner');
57 |         } else {
58 |             // Mautic < v2.14.0.
59 |             $definition = $container->getDefinition('mautic.campaign.model.event');
60 |             $definition->setClass('MauticPlugin\ThirdSetMauticTimingBundle\Model\EventModel');
61 |         }
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/EventListener/TimingFormSubscriber.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | namespace MauticPlugin\ThirdSetMauticTimingBundle\EventListener;
10 | 
11 | use Symfony\Component\EventDispatcher\EventSubscriberInterface;
12 | use Symfony\Component\Form\FormEvent;
13 | use Symfony\Component\Form\FormEvents;
14 | use Symfony\Component\HttpFoundation\Session\Session;
15 | 
16 | use Mautic\CampaignBundle\Entity\Event;
17 | 
18 | use MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel;
19 | 
20 | /**
21 |  * Class TimingFormSubscriber. Subscribes to events that occur with the Timing
22 |  * form.
23 |  *
24 |  * Note: this subscriber is registered in the Form\Extension\EventTypeExtension
25 |  * class.
26 |  *
27 |  * @package ThirdSetMauticTimingBundle
28 |  */
29 | class TimingFormSubscriber implements EventSubscriberInterface
30 | {
31 |     /** @var \Symfony\Component\HttpFoundation\Session\Session */
32 |     private $session;
33 | 
34 |     /** @var \Mautic\CampaignBundle\Entity\Event */
35 |     private $event;
36 | 
37 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel */
38 |     private $timingModel;
39 | 
40 |     /**
41 |      * Constructor.
42 |      * @param Session $session
43 |      * @param Event|null $event
44 |      * @param TimingModel $timingModel
45 |      */
46 |     public function __construct(
47 |                         Session $session,
48 |                         Event $event = null,
49 |                         TimingModel $timingModel
50 |                     )
51 |     {
52 |         $this->session = $session;
53 |         $this->event = $event;
54 |         $this->timingModel = $timingModel;
55 |     }
56 | 
57 |     /**
58 |      * Get the list of events that this subscriber subscribes to.
59 |      * @return array
60 |      */
61 |     static public function getSubscribedEvents()
62 |     {
63 |         return [
64 |             FormEvents::PRE_SET_DATA => 'onPreSetData',
65 |         ];
66 |     }
67 | 
68 |     /**
69 |      * Called when a form is pre-populated.
70 |      *
71 |      * Add any timing data to the formEvent.
72 |      *
73 |      * @param FormEvent $formEvent
74 |      */
75 |     public function onPreSetData(FormEvent $formEvent)
76 |     {
77 |         // Get the data from the from event.
78 |         $data = $formEvent->getData();
79 | 
80 |         // If the timing isn't set, try to get it from the db.
81 |         if ((!isset($data['timing']['expression'])) && (null !== $this->event)) {
82 | 
83 |             // Retrieve the campaign event timing from the db.
84 |             /* @var $timing \MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing */
85 |             $timing = $this->timingModel->getTimingForEvent($this->event);
86 | 
87 |             // Add the campaign event timing to the data.
88 |             $data['timing']['expression'] = $timing->getExpression();
89 |             $data['timing']['use_contact_timezone'] = $timing->useContactTimezone();
90 |             $data['timing']['timezone'] = $timing->getTimezone();
91 | 
92 |             // Set our modified data as the data to be sent to the form.
93 |             $formEvent->setData($data);
94 |         }
95 |     }
96 | 
97 | }
98 | 


--------------------------------------------------------------------------------
/ThirdSetMauticTimingBundle.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @package     ThirdSetMauticTimingBundle
 4 |  * @copyright   2016 Third Set Productions. All rights reserved.
 5 |  * @author      Third Set Productions
 6 |  * @link        http://www.thirdset.com
 7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
 8 |  */
 9 | 
10 | namespace MauticPlugin\ThirdSetMauticTimingBundle;
11 | 
12 | use Symfony\Component\DependencyInjection\ContainerBuilder;
13 | use Symfony\Component\DependencyInjection\Reference;
14 | 
15 | use Mautic\PluginBundle\Bundle\PluginBundleBase;
16 | 
17 | use MauticPlugin\ThirdSetMauticTimingBundle\DependencyInjection\Compiler\OverrideServiceCompilerPass;
18 | 
19 | /**
20 |  * Class ThirdSetMauticTimingBundle.
21 |  *
22 |  * @package MauticPlugin\ThirdSetMauticTimingBundle
23 |  */
24 | class ThirdSetMauticTimingBundle extends PluginBundleBase
25 | {
26 | 
27 |     /**
28 |      * {@inheritdoc}
29 |      */
30 |     public function build(ContainerBuilder $container)
31 |     {
32 |         parent::build($container);
33 | 
34 |         /**
35 |          * NOTE: this is declared here (instead of in config.php) so that we
36 |          * can inject it into the services defined below in this file.
37 |          */
38 |         $container
39 |             ->register(
40 |                 'plugin.thirdset.timing.campaign_event_manager',
41 |                 'MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel'
42 |             )
43 |             ->addArgument(new Reference('doctrine.orm.entity_manager'));
44 | 
45 |         /**
46 |          * EventType.
47 |          * NOTE: this is declared here (instead of in config.php) so that we
48 |          * can inject it into the services defined below in this file.
49 |          */
50 |         $container
51 |             ->register(
52 |                 'plugin.thirdset.timing.timing',
53 |                 'MauticPlugin\ThirdSetMauticTimingBundle\Form\Type\TimingType'
54 |             )
55 |             ->addArgument(new Reference('session'))
56 |             ->addArgument(new Reference('plugin.thirdset.timing.campaign_event_manager'))
57 |             ->addTag('form.type', array('alias' => 'timing'));
58 | 
59 |         /**
60 |          * Form Type Extensions.
61 |          * Note: these are registered here because Mautic's config system
62 |          * doesn't seem to be able to handle complex tags.
63 |          */
64 |         $container
65 |             ->register(
66 |                 'plugin.thirdset.timing.event_type_extension',
67 |                 'MauticPlugin\ThirdSetMauticTimingBundle\Form\Extension\EventTypeExtension'
68 |             )
69 |             ->addArgument(new Reference('session'))
70 |             ->addArgument(new Reference('mautic.campaign.model.event'))
71 |             ->addArgument(new Reference('plugin.thirdset.timing.event_timing_model'))
72 |             ->addTag('form.type_extension', array('extended_type' => 'Mautic\CampaignBundle\Form\Type\EventType'));
73 | 
74 |         // Register our custom form theme.
75 |         $container->loadFromExtension('framework', array(
76 |             'templating' => array(
77 |                 'form' => array(
78 |                     'resources' => array(
79 |                         'ThirdSetMauticTimingBundle:FormTheme\Custom',
80 |                     ),
81 |                 ),
82 |             ),
83 |         ));
84 | 
85 |         // Add a compiler pass for overriding mautic services.
86 |         $container->addCompilerPass(new OverrideServiceCompilerPass());
87 |     }
88 | 
89 | }


--------------------------------------------------------------------------------
/Form/Type/TimingType.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2016 Third Set Productions. All rights reserved.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Form\Type;
 10 | 
 11 | use Mautic\CoreBundle\Form\Type\YesNoButtonGroupType;
 12 | use Symfony\Component\Form\AbstractType;
 13 | use Symfony\Component\Form\Extension\Core\Type\TextType;
 14 | use Symfony\Component\Form\FormBuilderInterface;
 15 | use Symfony\Component\HttpFoundation\Session\Session;
 16 | 
 17 | use MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel;
 18 | 
 19 | /**
 20 |  * Class EventTypeExtension.
 21 |  *
 22 |  * @package ThirdSetMauticTimingBundle
 23 |  */
 24 | class TimingType extends AbstractType
 25 | {
 26 |     /** @var \Symfony\Component\HttpFoundation\Session\Session */
 27 |     private $session;
 28 | 
 29 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel */
 30 |     private $timingModel;
 31 | 
 32 |     /**
 33 |      * Constructor.
 34 |      * @param Session $session
 35 |      * @param TimingModel $timingModel
 36 |      */
 37 |     public function __construct(
 38 |                         Session $session,
 39 |                         TimingModel $timingModel
 40 |                     )
 41 |     {
 42 |         $this->session = $session;
 43 |         $this->timingModel = $timingModel;
 44 |     }
 45 | 
 46 |     /**
 47 |      * Build the form.
 48 |      * @param FormBuilderInterface $builder The builder.
 49 |      * @param array $options Any options.
 50 |      */
 51 |     public function buildForm(FormBuilderInterface $builder, array $options)
 52 |     {
 53 | 
 54 |         // Add the timing_expression field.
 55 |         $builder->add('expression', TextType::class, array(
 56 |                     'attr' => array(
 57 |                             'title' => 'Enter when the email can be sent.',
 58 |                             'tooltip'  => 'When is the event allowed to occur? Uses standard crontab notation (Google it!).',
 59 |                         )
 60 |                     )
 61 |                 );
 62 | 
 63 |         // Add the "Use Contact's timezone?" field.
 64 |         $builder->add('use_contact_timezone', YesNoButtonGroupType::class, [
 65 |             'label' => 'Use Contact\'s Time Zone?',
 66 |             'attr'  => [
 67 |                 'tooltip' => 'If enabled, the timing expression will be evaluated using the contact\'s time zone. If their time zone isn\'t known, it will fallback to the time zone selected below.',
 68 |             ],
 69 |         ]);
 70 | 
 71 |         // Add the "Add the timezone" field.
 72 |         if (class_exists('Mautic\CoreBundle\Form\Type\TimezoneType')) {
 73 |             // Mautic >= 3.0.
 74 |             $timezoneType = 'Mautic\CoreBundle\Form\Type\TimezoneType';
 75 |         } else {
 76 |             // Mautic < 3.0.
 77 |             $timezoneType = 'Symfony\Component\Form\Extension\Core\Type\TimezoneType';
 78 |         }
 79 | 
 80 |         $builder->add('timezone', $timezoneType, array(
 81 |                 'label'      => 'Time Zone',
 82 |                 'attr'       => array(
 83 |                     'class'   => 'form-control',
 84 |                     'tooltip' => 'Choose the time zone to use when evaluating the timing expression.',
 85 |                 ),
 86 |                 'multiple'    => false,
 87 |                 'placeholder' => 'mautic.user.user.form.defaulttimezone',
 88 |                 'required'    => false,
 89 |             )
 90 |         );
 91 |     }
 92 | 
 93 |     /**
 94 |      * Returns the name associated with the form.
 95 |      * @return string
 96 |      */
 97 |     public function getName()
 98 |     {
 99 |         return 'timing';
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/changelog.txt:
--------------------------------------------------------------------------------
  1 | = 2.1.2 =
  2 | 
  3 | * Updated the README.md to reflect that the plugin has been tested with up to 
  4 |   Mautic 4.3.1.
  5 | * Updated the README.md to reflect that the plugin has been tested with up to 
  6 |   PHP 7.4.29.
  7 | * Updated the phpunit.xml.dist file for the new location of the bootstrap file.
  8 | * Updated the README.md file to specify how to run unit tests with older 
  9 |   versions of mautic (where the bootstrap file is in a different location).
 10 | 
 11 | = 2.1.1 =
 12 | 
 13 | * Updated the README.md to reflect that the plugin has been tested with up to 
 14 |   Mautic 3.2.1.
 15 | 
 16 | = 2.1.0 =
 17 | 
 18 | * Added support for Mautic 3.x. - maintained Mautic 2.x compatibility (#21, 
 19 |   credit @indorock).
 20 | * Updated the README.md to reflect that the plugin has been tested with up to 
 21 |   Mautic 3.0.0, Mautic 2.16.0 and PHP 7.3.19.
 22 | 
 23 | = 2.0.1 =
 24 | 
 25 | * Updated the README.md to reflect that the plugin has been tested with up to 
 26 |   Mautic 2.15.1.
 27 | * Updated the README.md to reflect that the plugin has been tested with up to 
 28 |   PHP 7.1.30.
 29 | 
 30 | = 2.0.0 =
 31 | 
 32 | * Now uses (and gives priority to) the Preferred Time Zone field on the Contact 
 33 |   (if set) when determining the Contact's time zone (applies to Mautic >= 2.6.1).
 34 |   Note that previous versions of this plugin ignore the Preferred Time Zone
 35 |   field and instead only use the contact's IP (if known) to determine the
 36 |   Contact's time zone. See the README.md for more details (#19, credit: @regevbr)
 37 | * Updated the README to reflect that the plugin has been tested with up to 
 38 |   Mautic 2.15.0.
 39 | 
 40 | = 1.2.1 =
 41 | 
 42 | * Fixed a bug where the plugin was trying to apply timing rules to events that 
 43 |   didn't have a timing expression (#17).
 44 | * Fixed a backwards compatibility issue with Mautic < 2.14.
 45 | 
 46 | = 1.2.0 =
 47 | 
 48 | * Updated the plugin to hook Mautic 2.14's refactored campaign processing system. 
 49 | * Updated the README to reflect that the plugin has been tested with up to 
 50 |   Mautic 2.14.0.
 51 | 
 52 | = 1.1.7 =
 53 | 
 54 | * Updated the README to reflect that the plugin has been tested with up to 
 55 |   Mautic 2.13.1.
 56 | * Updated the README to reflect that the plugin has been tested with up to 
 57 |   PHP 7.1.16.
 58 | 
 59 | = 1.1.6 =
 60 | 
 61 | * Updated the README to reflect that the plugin has been tested with up to 
 62 |   Mautic 2.12.0.
 63 | 
 64 | = 1.1.5 =
 65 | 
 66 | * Updated the README to reflect that the plugin has been tested with up to 
 67 |   Mautic 2.11.0.
 68 | * Updated the README with some additional installation info.
 69 | 
 70 | = 1.1.4 =
 71 | 
 72 | * Fixed a bug that would break saving certain events with NOTICE level PHP 
 73 |   errors turned on.
 74 | 
 75 | = 1.1.3 =
 76 | 
 77 | * Fixed a bug with the TimingHelper when getDueDate returns null.
 78 | 
 79 | = 1.1.2 =
 80 | 
 81 | * Fixed a compatibility issue with Mautic 2.7.1.
 82 | * Updated the README to reflect that the plugin has been tested with up to 
 83 |   Mautic 2.7.1.
 84 | * Updated the README with info regarding how to manually update the database (if
 85 |   necessary).
 86 | 
 87 | = 1.1.1 =
 88 | 
 89 | * Fixed a bug that occurred when attempting to use a contact's timezone when 
 90 |   their ip isn't set (credit: @sageeki).
 91 | 
 92 | = 1.1.0 =
 93 | 
 94 | * Now using the timing fields to schedule events (rather than to abort execution
 95 |   as was done in previous versions).
 96 | * Added a 'Use Work Hours' link next to the Expression field.
 97 | 
 98 | = 1.0.2 =
 99 | 
100 | * Fixed a bug that was throwing errors in the log when a new action event form
101 |   for a new campaign was opened.
102 | * Events with missing or empty timing data now bypassing timing rules.
103 | 
104 | = 1.0.1 =
105 | 
106 | * Fixed a bug with adding timing settings to events in new campaigns.
107 | 
108 | = 1.0.0 =
109 | 
110 | * Initial release.
111 | 


--------------------------------------------------------------------------------
/Form/Extension/EventTypeExtension.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2016 Third Set Productions. All rights reserved.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Form\Extension;
 10 | 
 11 | use MauticPlugin\ThirdSetMauticTimingBundle\Form\Type\TimingType;
 12 | use Symfony\Component\Form\AbstractTypeExtension;
 13 | use Symfony\Component\Form\FormBuilderInterface;
 14 | use Symfony\Component\HttpFoundation\Session\Session;
 15 | 
 16 | use Mautic\CampaignBundle\Model\EventModel;
 17 | 
 18 | use MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel;
 19 | use MauticPlugin\ThirdSetMauticTimingBundle\EventListener\TimingFormSubscriber;
 20 | 
 21 | /**
 22 |  * Class EventTypeExtension.
 23 |  *
 24 |  * This extension is registered in the ThirdSetMauticTimingBundle class.
 25 |  *
 26 |  * @package ThirdSetMauticTimingBundle
 27 |  */
 28 | class EventTypeExtension extends AbstractTypeExtension
 29 | {
 30 |     /** @var \Symfony\Component\HttpFoundation\Session\Session */
 31 |     private $session;
 32 | 
 33 |     /** @var \Mautic\CampaignBundle\Model\EventModel */
 34 |     private $eventModel;
 35 | 
 36 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel */
 37 |     private $timingModel;
 38 | 
 39 |     /**
 40 |      * Constructor.
 41 |      * @param Session $session
 42 |      * @param EventModel $eventModel
 43 |      * @param TimingModel $timingModel
 44 |      */
 45 |     public function __construct(
 46 |                         Session $session,
 47 |                         EventModel $eventModel,
 48 |                         TimingModel $timingModel
 49 |                     )
 50 |     {
 51 |         $this->session = $session;
 52 |         $this->eventModel = $eventModel;
 53 |         $this->timingModel = $timingModel;
 54 |     }
 55 | 
 56 |     /**
 57 |      * Returns the name of the type being extended.
 58 |      *
 59 |      * @return string The name of the type being extended
 60 |      */
 61 |     public function getExtendedType()
 62 |     {
 63 |         return 'Mautic\CampaignBundle\Form\Type\EventType';
 64 |     }
 65 | 
 66 |     /**
 67 |      * Build the form (starting with the form built by the parent type).
 68 |      * @param FormBuilderInterface $builder The builder from the parent type.
 69 |      * @param array $options Any options from the parent type.
 70 |      */
 71 |     public function buildForm(FormBuilderInterface $builder, array $options)
 72 |     {
 73 |         // If this is an 'action' or 'condition' event, add the timing form.
 74 |         if (in_array($options['data']['eventType'], ['action', 'condition'])) {
 75 | 
 76 |             // Add timing form.
 77 |             $builder->add('timing', TimingType::class, array(
 78 |                     'required'    => false,
 79 |                 )
 80 |             );
 81 |             //var_dump($options['data']); //For debugging (goes to AJAX response).
 82 | 
 83 |             // Get the event (or use null) if this is a new Campaign.
 84 |             $event = null;
 85 |             $update = (!empty($options['data']['id']) && strpos($options['data']['id'], 'new') === false) ? true : false;
 86 |             if ($update) {
 87 |                 $eventId = $options['data']['id'];
 88 | 
 89 |                 /* @var $event \Mautic\CampaignBundle\Entity\Event */
 90 |                 $event = $this->eventModel->getEntity($eventId);
 91 |             }
 92 | 
 93 |             // Add timing form event subscriber.
 94 |             $builder->addEventSubscriber(
 95 |                         new TimingFormSubscriber(
 96 |                                 $this->session,
 97 |                                 $event,
 98 |                                 $this->timingModel
 99 |                         )
100 |                     );
101 |         }
102 |     }
103 | 
104 | }
105 | 


--------------------------------------------------------------------------------
/Event/CampaignPreExecutionEvent.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2016 Third Set Productions. All rights reserved.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Event;
 11 | 
 12 | use Symfony\Component\EventDispatcher\Event;
 13 | 
 14 | use Mautic\LeadBundle\Entity\Lead;
 15 | 
 16 | /**
 17 |  * Class CampaignPreExecutionEvent.
 18 |  */
 19 | class CampaignPreExecutionEvent extends Event
 20 | {
 21 |     /**
 22 |      * @var array
 23 |      */
 24 |     protected $eventData;
 25 | 
 26 |     /**
 27 |      * @var \DateTime;
 28 |      */
 29 |     protected $parentTriggeredDate;
 30 | 
 31 |     /**
 32 |      *
 33 |      * @var boolean
 34 |      */
 35 |     protected $allowNegative;
 36 | 
 37 |     /**
 38 |      * @var \Mautic\LeadBundle\Entity\Lead;
 39 |      */
 40 |     protected $lead;
 41 | 
 42 |     /**
 43 |      *
 44 |      * @var \DateTime|boolean
 45 |      */
 46 |     protected $eventTriggerDate;
 47 | 
 48 | 
 49 |     /**
 50 |      * Constructor.
 51 |      * @param array $eventData An array of campaign Event data.
 52 |      * @param \DateTime|null $parentTriggeredDate
 53 |      * @param bool $allowNegative
 54 |      * @param \DateTime|bool $eventTriggerDate The current eventTriggerDate
 55 |      */
 56 |     public function __construct(
 57 |                         $eventData,
 58 |                         \DateTime $parentTriggeredDate = null,
 59 |                         $allowNegative = false,
 60 |                         Lead $lead,
 61 |                         $eventTriggerDate = null
 62 |                     )
 63 |     {
 64 |         $this->eventData = $eventData;
 65 |         $this->parentTriggeredDate = $parentTriggeredDate;
 66 |         $this->allowNegative = $allowNegative;
 67 |         $this->lead = $lead;
 68 |         $this->eventTriggerDate = $eventTriggerDate;
 69 |     }
 70 | 
 71 |     /**
 72 |      * Get the campaign event's data array.
 73 |      * @return array An array of data for the campaign event.
 74 |      */
 75 |     public function getEventData()
 76 |     {
 77 |         return $this->eventData;
 78 |     }
 79 | 
 80 |     /**
 81 |      * Get the trigger \DateTime of the campaign Event's parent.
 82 |      * @return \DateTime The trigger \DateTime of the campaign Event's parent.
 83 |      */
 84 |     public function getParentTriggeredDate()
 85 |     {
 86 |         return $this->parentTriggeredDate;
 87 |     }
 88 | 
 89 |     /**
 90 |      * Whether or not to allow negative (for 'no' decision paths).
 91 |      * @return boolean Returns whether or not to allow negative.
 92 |      */
 93 |     public function allowNegative()
 94 |     {
 95 |         return $this->allowNegative;
 96 |     }
 97 | 
 98 |     /**
 99 |      * Get the Lead associated with the event.
100 |      * @return Mautic\LeadBundle\Entity\Lead The Lead/Contact associated with
101 |      * the event.
102 |      */
103 |     public function getLead()
104 |     {
105 |         return $this->lead;
106 |     }
107 | 
108 |     /**
109 |      * Get the campaign Event trigger DateTime if in the future, or true if the
110 |      * campaign Event is already due.
111 |      * @return \DateTime|boolean The campaign Event trigger \DateTime if in the
112 |      * future or true if the campaign Event is already due.
113 |      */
114 |     public function getEventTriggerDate()
115 |     {
116 |         return $this->eventTriggerDate;
117 |     }
118 | 
119 |     /**
120 |      * Sets the campaign EventTriggerDate to allow for filtering the value.
121 |      * @param \DateTime|boolean $eventTriggerDate The campaign Event trigger
122 |      * \DateTime if in the future or true if the campaign Event is already due.
123 |      */
124 |     public function setEventTriggerDate($eventTriggerDate)
125 |     {
126 |         $this->eventTriggerDate = $eventTriggerDate;
127 |     }
128 | 
129 | }
130 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/DayOfMonthField.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
  4 | 
  5 | use DateTime;
  6 | 
  7 | /**
  8 |  * Day of month field.  Allows: * , / - ? L W
  9 |  *
 10 |  * 'L' stands for "last" and specifies the last day of the month.
 11 |  *
 12 |  * The 'W' character is used to specify the weekday (Monday-Friday) nearest the
 13 |  * given day. As an example, if you were to specify "15W" as the value for the
 14 |  * day-of-month field, the meaning is: "the nearest weekday to the 15th of the
 15 |  * month". So if the 15th is a Saturday, the trigger will fire on Friday the
 16 |  * 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If
 17 |  * the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you
 18 |  * specify "1W" as the value for day-of-month, and the 1st is a Saturday, the
 19 |  * trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary
 20 |  * of a month's days. The 'W' character can only be specified when the
 21 |  * day-of-month is a single day, not a range or list of days.
 22 |  *
 23 |  * @author Michael Dowling <mtdowling@gmail.com>
 24 |  */
 25 | class DayOfMonthField extends AbstractField
 26 | {
 27 |     /**
 28 |      * Get the nearest day of the week for a given day in a month
 29 |      *
 30 |      * @param int $currentYear  Current year
 31 |      * @param int $currentMonth Current month
 32 |      * @param int $targetDay    Target day of the month
 33 |      *
 34 |      * @return \DateTime Returns the nearest date
 35 |      */
 36 |     private static function getNearestWeekday($currentYear, $currentMonth, $targetDay)
 37 |     {
 38 |         $tday = str_pad($targetDay, 2, '0', STR_PAD_LEFT);
 39 |         $target = DateTime::createFromFormat('Y-m-d', "$currentYear-$currentMonth-$tday");
 40 |         $currentWeekday = (int) $target->format('N');
 41 | 
 42 |         if ($currentWeekday < 6) {
 43 |             return $target;
 44 |         }
 45 | 
 46 |         $lastDayOfMonth = $target->format('t');
 47 | 
 48 |         foreach (array(-1, 1, -2, 2) as $i) {
 49 |             $adjusted = $targetDay + $i;
 50 |             if ($adjusted > 0 && $adjusted <= $lastDayOfMonth) {
 51 |                 $target->setDate($currentYear, $currentMonth, $adjusted);
 52 |                 if ($target->format('N') < 6 && $target->format('m') == $currentMonth) {
 53 |                     return $target;
 54 |                 }
 55 |             }
 56 |         }
 57 |     }
 58 | 
 59 |     public function isSatisfiedBy(DateTime $date, $value)
 60 |     {
 61 |         // ? states that the field value is to be skipped
 62 |         if ($value == '?') {
 63 |             return true;
 64 |         }
 65 | 
 66 |         $fieldValue = $date->format('d');
 67 | 
 68 |         // Check to see if this is the last day of the month
 69 |         if ($value == 'L') {
 70 |             return $fieldValue == $date->format('t');
 71 |         }
 72 | 
 73 |         // Check to see if this is the nearest weekday to a particular value
 74 |         if (strpos($value, 'W')) {
 75 |             // Parse the target day
 76 |             $targetDay = substr($value, 0, strpos($value, 'W'));
 77 |             // Find out if the current day is the nearest day of the week
 78 |             return $date->format('j') == self::getNearestWeekday(
 79 |                 $date->format('Y'),
 80 |                 $date->format('m'),
 81 |                 $targetDay
 82 |             )->format('j');
 83 |         }
 84 | 
 85 |         return $this->isSatisfied($date->format('d'), $value);
 86 |     }
 87 | 
 88 |     public function increment(DateTime $date, $invert = false)
 89 |     {
 90 |         if ($invert) {
 91 |             $date->modify('previous day');
 92 |             $date->setTime(23, 59);
 93 |         } else {
 94 |             $date->modify('next day');
 95 |             $date->setTime(0, 0);
 96 |         }
 97 | 
 98 |         return $this;
 99 |     }
100 | 
101 |     public function validate($value)
102 |     {
103 |         return (bool) preg_match('/^[\*,\/\-\?LW0-9A-Za-z]+$/', $value);
104 |     }
105 | }
106 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/AbstractField.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
  4 | 
  5 | /**
  6 |  * Abstract CRON expression field
  7 |  */
  8 | abstract class AbstractField implements FieldInterface
  9 | {
 10 |     /**
 11 |      * Check to see if a field is satisfied by a value
 12 |      *
 13 |      * @param string $dateValue Date value to check
 14 |      * @param string $value     Value to test
 15 |      *
 16 |      * @return bool
 17 |      */
 18 |     public function isSatisfied($dateValue, $value)
 19 |     {
 20 |         if ($this->isIncrementsOfRanges($value)) {
 21 |             return $this->isInIncrementsOfRanges($dateValue, $value);
 22 |         } elseif ($this->isRange($value)) {
 23 |             return $this->isInRange($dateValue, $value);
 24 |         }
 25 | 
 26 |         return $value == '*' || $dateValue == $value;
 27 |     }
 28 | 
 29 |     /**
 30 |      * Check if a value is a range
 31 |      *
 32 |      * @param string $value Value to test
 33 |      *
 34 |      * @return bool
 35 |      */
 36 |     public function isRange($value)
 37 |     {
 38 |         return strpos($value, '-') !== false;
 39 |     }
 40 | 
 41 |     /**
 42 |      * Check if a value is an increments of ranges
 43 |      *
 44 |      * @param string $value Value to test
 45 |      *
 46 |      * @return bool
 47 |      */
 48 |     public function isIncrementsOfRanges($value)
 49 |     {
 50 |         return strpos($value, '/') !== false;
 51 |     }
 52 | 
 53 |     /**
 54 |      * Test if a value is within a range
 55 |      *
 56 |      * @param string $dateValue Set date value
 57 |      * @param string $value     Value to test
 58 |      *
 59 |      * @return bool
 60 |      */
 61 |     public function isInRange($dateValue, $value)
 62 |     {
 63 |         $parts = array_map('trim', explode('-', $value, 2));
 64 | 
 65 |         return $dateValue >= $parts[0] && $dateValue <= $parts[1];
 66 |     }
 67 | 
 68 |     /**
 69 |      * Test if a value is within an increments of ranges (offset[-to]/step size)
 70 |      *
 71 |      * @param string $dateValue Set date value
 72 |      * @param string $value     Value to test
 73 |      *
 74 |      * @return bool
 75 |      */
 76 |     public function isInIncrementsOfRanges($dateValue, $value)
 77 |     {
 78 |         $parts = array_map('trim', explode('/', $value, 2));
 79 |         $stepSize = isset($parts[1]) ? $parts[1] : 0;
 80 |         if (($parts[0] == '*' || $parts[0] === '0') && 0 !== $stepSize) {
 81 |             return (int) $dateValue % $stepSize == 0;
 82 |         }
 83 | 
 84 |         $range = explode('-', $parts[0], 2);
 85 |         $offset = $range[0];
 86 |         $to = isset($range[1]) ? $range[1] : $dateValue;
 87 |         // Ensure that the date value is within the range
 88 |         if ($dateValue < $offset || $dateValue > $to) {
 89 |             return false;
 90 |         }
 91 | 
 92 |         if ($dateValue > $offset && 0 === $stepSize) {
 93 |           return false;
 94 |         }
 95 | 
 96 |         for ($i = $offset; $i <= $to; $i+= $stepSize) {
 97 |             if ($i == $dateValue) {
 98 |                 return true;
 99 |             }
100 |         }
101 | 
102 |         return false;
103 |     }
104 | 
105 |     /**
106 |      * Returns a range of values for the given cron expression
107 |      *
108 |      * @param string $expression The expression to evaluate
109 |      * @param int $max           Maximum offset for range
110 |      *
111 |      * @return array
112 |      */
113 |     public function getRangeForExpression($expression, $max)
114 |     {
115 |         $values = array();
116 | 
117 |         if ($this->isRange($expression) || $this->isIncrementsOfRanges($expression)) {
118 |             if (!$this->isIncrementsOfRanges($expression)) {
119 |                 list ($offset, $to) = explode('-', $expression);
120 |                 $stepSize = 1;
121 |             }
122 |             else {
123 |                 $range = array_map('trim', explode('/', $expression, 2));
124 |                 $stepSize = isset($range[1]) ? $range[1] : 0;
125 |                 $range = $range[0];
126 |                 $range = explode('-', $range, 2);
127 |                 $offset = $range[0];
128 |                 $to = isset($range[1]) ? $range[1] : $max;
129 |             }
130 |             $offset = $offset == '*' ? 0 : $offset;
131 |             for ($i = $offset; $i <= $to; $i += $stepSize) {
132 |                 $values[] = $i;
133 |             }
134 |             sort($values);
135 |         }
136 |         else {
137 |             $values = array($expression);
138 |         }
139 | 
140 |         return $values;
141 |     }
142 | 
143 | }
144 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/DayOfWeekField.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
  4 | 
  5 | use DateTime;
  6 | use InvalidArgumentException;
  7 | 
  8 | 
  9 | /**
 10 |  * Day of week field.  Allows: * / , - ? L #
 11 |  *
 12 |  * Days of the week can be represented as a number 0-7 (0|7 = Sunday)
 13 |  * or as a three letter string: SUN, MON, TUE, WED, THU, FRI, SAT.
 14 |  *
 15 |  * 'L' stands for "last". It allows you to specify constructs such as
 16 |  * "the last Friday" of a given month.
 17 |  *
 18 |  * '#' is allowed for the day-of-week field, and must be followed by a
 19 |  * number between one and five. It allows you to specify constructs such as
 20 |  * "the second Friday" of a given month.
 21 |  */
 22 | class DayOfWeekField extends AbstractField
 23 | {
 24 |     public function isSatisfiedBy(DateTime $date, $value)
 25 |     {
 26 |         if ($value == '?') {
 27 |             return true;
 28 |         }
 29 | 
 30 |         // Convert text day of the week values to integers
 31 |         $value = $this->convertLiterals($value);
 32 | 
 33 |         $currentYear = $date->format('Y');
 34 |         $currentMonth = $date->format('m');
 35 |         $lastDayOfMonth = $date->format('t');
 36 | 
 37 |         // Find out if this is the last specific weekday of the month
 38 |         if (strpos($value, 'L')) {
 39 |             $weekday = str_replace('7', '0', substr($value, 0, strpos($value, 'L')));
 40 |             $tdate = clone $date;
 41 |             $tdate->setDate($currentYear, $currentMonth, $lastDayOfMonth);
 42 |             while ($tdate->format('w') != $weekday) {
 43 |                 $tdateClone = new DateTime();
 44 |                 $tdate = $tdateClone
 45 |                     ->setTimezone($tdate->getTimezone())
 46 |                     ->setDate($currentYear, $currentMonth, --$lastDayOfMonth);
 47 |             }
 48 | 
 49 |             return $date->format('j') == $lastDayOfMonth;
 50 |         }
 51 | 
 52 |         // Handle # hash tokens
 53 |         if (strpos($value, '#')) {
 54 |             list($weekday, $nth) = explode('#', $value);
 55 | 
 56 |             // 0 and 7 are both Sunday, however 7 matches date('N') format ISO-8601
 57 |             if ($weekday === '0') {
 58 |                 $weekday = 7;
 59 |             }
 60 | 
 61 |             // Validate the hash fields
 62 |             if ($weekday < 0 || $weekday > 7) {
 63 |                 throw new InvalidArgumentException("Weekday must be a value between 0 and 7. {$weekday} given");
 64 |             }
 65 |             if ($nth > 5) {
 66 |                 throw new InvalidArgumentException('There are never more than 5 of a given weekday in a month');
 67 |             }
 68 |             // The current weekday must match the targeted weekday to proceed
 69 |             if ($date->format('N') != $weekday) {
 70 |                 return false;
 71 |             }
 72 | 
 73 |             $tdate = clone $date;
 74 |             $tdate->setDate($currentYear, $currentMonth, 1);
 75 |             $dayCount = 0;
 76 |             $currentDay = 1;
 77 |             while ($currentDay < $lastDayOfMonth + 1) {
 78 |                 if ($tdate->format('N') == $weekday) {
 79 |                     if (++$dayCount >= $nth) {
 80 |                         break;
 81 |                     }
 82 |                 }
 83 |                 $tdate->setDate($currentYear, $currentMonth, ++$currentDay);
 84 |             }
 85 | 
 86 |             return $date->format('j') == $currentDay;
 87 |         }
 88 | 
 89 |         // Handle day of the week values
 90 |         if (strpos($value, '-')) {
 91 |             $parts = explode('-', $value);
 92 |             if ($parts[0] == '7') {
 93 |                 $parts[0] = '0';
 94 |             } elseif ($parts[1] == '0') {
 95 |                 $parts[1] = '7';
 96 |             }
 97 |             $value = implode('-', $parts);
 98 |         }
 99 | 
100 |         // Test to see which Sunday to use -- 0 == 7 == Sunday
101 |         $format = in_array(7, str_split($value)) ? 'N' : 'w';
102 |         $fieldValue = $date->format($format);
103 | 
104 |         return $this->isSatisfied($fieldValue, $value);
105 |     }
106 | 
107 |     public function increment(DateTime $date, $invert = false)
108 |     {
109 |         if ($invert) {
110 |             $date->modify('-1 day');
111 |             $date->setTime(23, 59, 0);
112 |         } else {
113 |             $date->modify('+1 day');
114 |             $date->setTime(0, 0, 0);
115 |         }
116 | 
117 |         return $this;
118 |     }
119 | 
120 |     public function validate($value)
121 |     {
122 |         $value = $this->convertLiterals($value);
123 | 
124 |         foreach (explode(',', $value) as $expr) {
125 |             if (!preg_match('/^(\*|[0-7](L?|#[1-5]))([\/\,\-][0-7]+)*$/', $expr)) {
126 |                 return false;
127 |             }
128 |         }
129 | 
130 |         return true;
131 |     }
132 | 
133 |     private function convertLiterals($string)
134 |     {
135 |         return str_ireplace(
136 |             array('SUN', 'MON', 'TUE', 'WED', 'THU', 'FRI', 'SAT'),
137 |             range(0, 6),
138 |             $string
139 |         );
140 |     }
141 | }
142 | 


--------------------------------------------------------------------------------
/EventListener/DoctrineSubscriber.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2016 Third Set Productions. All rights reserved.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\EventListener;
 11 | 
 12 | use Doctrine\Common\EventSubscriber;
 13 | use Doctrine\ORM\Event\LifecycleEventArgs;
 14 | use Doctrine\ORM\Events;
 15 | use Symfony\Component\HttpFoundation\Session\Session;
 16 | use Symfony\Component\HttpFoundation\ParameterBag;
 17 | 
 18 | use Mautic\CampaignBundle\Entity\Event;
 19 | 
 20 | use MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing;
 21 | 
 22 | /**
 23 |  * Class DoctrineSubscriber.
 24 |  *
 25 |  * @package ThirdSetMauticTimingBundle
 26 |  */
 27 | class DoctrineSubscriber implements EventSubscriber
 28 | {
 29 |     /** @var \Symfony\Component\HttpFoundation\Session\Session */
 30 |     private $session;
 31 | 
 32 |     /**
 33 |      * Constructor.
 34 |      * @param Session $session
 35 |      */
 36 |     public function __construct(
 37 |                         Session $session
 38 |                     )
 39 |     {
 40 |         $this->session = $session;
 41 |     }
 42 | 
 43 |     /**
 44 |      * Get the list of events that this subscriber subscribes to.
 45 |      * @return array
 46 |      */
 47 |     public function getSubscribedEvents()
 48 |     {
 49 |         return [
 50 |             Events::postPersist,
 51 |             Events::postUpdate,
 52 |         ];
 53 |     }
 54 | 
 55 |     /**
 56 |      * Function for subscribing to postPersist events. Note: these are just
 57 |      * for new entities, existing entities throw the postUpdate event.
 58 |      * @param LifecycleEventArgs $args
 59 |      */
 60 |     public function postPersist(LifecycleEventArgs $args)
 61 |     {
 62 |         $entity = $args->getEntity();
 63 | 
 64 |         if ($entity instanceof \Mautic\CampaignBundle\Entity\Event) {
 65 |             /* @var $event \Mautic\CampaignBundle\Entity\Event */
 66 |             $event = $entity;
 67 | 
 68 |             $postVars = new ParameterBag($_POST);
 69 |             $campaignId = $postVars->get('campaign')['sessionId'];
 70 |             $modifiedEvents = $this->session->get('mautic.campaign.'.$campaignId.'.events.modified', []);
 71 |             $eventData = $modifiedEvents[$event->getTempId()];
 72 | 
 73 |             if (isset($eventData['timing'])) {
 74 |                 $timingData = $eventData['timing'];
 75 | 
 76 |                 $this->saveTimingData($args, $event, $timingData);
 77 |             }
 78 |         }
 79 | 
 80 |     }
 81 | 
 82 |     /**
 83 |      * Function for subscribing to postUpdate events. Note: these are just
 84 |      * for existing entities, new entities throw the postPersist event.
 85 |      * @param LifecycleEventArgs $args
 86 |      */
 87 |     public function postUpdate(LifecycleEventArgs $args)
 88 |     {
 89 |         $entity = $args->getEntity();
 90 | 
 91 |         if ($entity instanceof \Mautic\CampaignBundle\Entity\Event) {
 92 |             /* @var $event \Mautic\CampaignBundle\Entity\Event  */
 93 |             $event = $entity;
 94 | 
 95 |             $campaignId = $event->getCampaign()->getId();
 96 | 
 97 |             // Get the timing data out of the session (for edit requests).
 98 |             $modifiedEvents = $this->session->get('mautic.campaign.'.$campaignId.'.events.modified', []);
 99 |             $eventData = $modifiedEvents[$event->getId()];
100 | 
101 |             if (isset($eventData['timing'])) {
102 |                 $timingData = $eventData['timing'];
103 | 
104 |                 $this->saveTimingData($args, $event, $timingData);
105 |             }
106 |         }
107 |     }
108 | 
109 |     /**
110 |      * Private helper method for adding timing data to an Event.
111 |      *
112 |      * Note: we access the db from within this function (instead of a model
113 |      * class) to avoid circular references.
114 |      *
115 |      * @param LifecycleEventArgs $args
116 |      * @param Event $event The campaign Event to attach the timing data to.
117 |      * @param array $timingData An array of timing post data.
118 |      */
119 |     private function saveTimingData(
120 |                         LifecycleEventArgs $args,
121 |                         Event $event,
122 |                         $timingData
123 |                     )
124 |     {
125 |         // Get the timing object (note: we have to go through the attached em to
126 |         //prevent a circular reference).
127 |         /* @var $em \Doctrine\ORM\EntityManager */
128 |         $em = $args->getEntityManager();
129 |         /* @var $timingRepository \MauticPlugin\ThirdSetMauticTimingBundle\Entity\TimingRepository */
130 |         $timingRepository = $em->getRepository('ThirdSetMauticTimingBundle:Timing');
131 |         /* @var $timing \MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing */
132 |         $timing = $timingRepository->getEntity($event->getId());
133 | 
134 |         // If there isn't any timing data yet, create a new Timing Entity.
135 |         if (null === $timing) {
136 |             $timing = new Timing($event);
137 |         }
138 | 
139 |         // Add the new data.
140 |         $timing->addPostData($timingData);
141 | 
142 |         // Persist the Timing.
143 |         $em->persist($timing);
144 |         $em->flush();
145 |     }
146 | }
147 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # ThirdSetMauticTimingBundle
  2 | 
  3 | ## [Description](id:description)
  4 | 
  5 | The ThirdSetMauticTimingBundle is a [Mautic](http://www.mautic.org) plugin that allows you to set a cron timing expression on any Campaign action event (such as a "Send Email" action).
  6 | 
  7 | ### Purpose
  8 | 
  9 | For example, you could add a cron expression that only allows sending on weekdays during working hours in New York.
 10 | 
 11 | ### Compatibility
 12 | 
 13 | This plugin works on Mautic 2.x, Mautic 3.x and Mautic 4.x. It should work on most versions of PHP.
 14 | 
 15 | #### Mautic 4.x
 16 | 
 17 | This plugin has been tested with up to **Mautic v4.3.1**.
 18 | 
 19 | #### Mautic 3.x
 20 | 
 21 | This plugin has been tested with up to **Mautic v3.2.1**.
 22 | 
 23 | #### Mautic 2.x
 24 | 
 25 | This plugin has been tested with up to **Mautic v2.16.0**.
 26 | 
 27 | #### PHP
 28 | 
 29 | This plugin has been tested with up to **PHP v7.4.29**.
 30 | 
 31 | ### Features
 32 | 
 33 | * Adds the full ability of cron syntax to your campaign actions allowing you to only send emails at certain times.
 34 | * Use different cron expressions on different campaign actions.
 35 | * Enter a timezone to use when evaluating the cron expression (this allows you to send an email during working hours in your own timezone, for example).
 36 | * Use different time zones for different cron expressions/campaign actions.
 37 | * Use the Contact's time zone (if available) to evaluate the cron expression. It will fall back to use any time zone you specify (or the System Default time zone) if the Contact's time zone isn't known.
 38 | 
 39 | ## [Installation](id:installation)
 40 | 
 41 | 1. Download or clone this bundle into your Mautic `/plugins` folder.
 42 | 2. Manually delete your cache (`var/cache/prod` for Mautic 3.x+ and `app/cache/prod` for Mautic 2.x).
 43 | 3. In the Mautic GUI, go to the :gear: icon in the top right and then to Plugins.
 44 | 4. Click the "Install/Upgrade Plugins" button in the top right. Note: if you are on an older version of Mautic, click the drowpdown arrow in the top right and then choose "Install/Upgrade Plugins".
 45 | 5. You should now see the Timing plugin in your list of plugins.
 46 | 6. Run the following console commands to update the database:
 47 | 
 48 | ```bash
 49 | php bin/console doctrine:schema:update --dump-sql
 50 | php bin/console doctrine:schema:update --force
 51 | ```
 52 | 
 53 | _Note: For Mautic 2.x, replace `php bin/console` with `php app/console` in the above commands._
 54 | 
 55 | ## [Usage](id:usage)
 56 | 
 57 | ### Timing
 58 | 
 59 | After installing the plugin, you will now see a new Timing section when adding or editing Campaign actions.
 60 | 
 61 | #### Expression Field
 62 | 
 63 | The expression field allows you to enter a cron expression for the timing to be evaluated against. See the [Wikipedia Cron Page](https://en.wikipedia.org/wiki/Cron) for a good overview of cron syntax.
 64 | 
 65 | Note that it is best to use ranges (ex: "1-5") instead of exact values. This is because the expression is evaluated when the campaign is triggered and when that happens is external to this plugin.
 66 | 
 67 | Example:
 68 | 
 69 | `* 09-17 * * 1-5` (Weekdays, 9AM to 5PM)
 70 | 
 71 | #### Use Contact's Time Zone Field
 72 | 
 73 | When this field is enabled, the plugin will evaluate the cron expression off of the Contact's time zone.  This allows you to only send emails during the Contact's working hours.
 74 | 
 75 | The contact time zone is evaluated in the following order:
 76 | 
 77 | 1. The timezone field of the contact (e.g. `mautic.lead.field.timezone`) (Mautic > 2.6.1), else:
 78 | 2. The timezone of the last ip address used by the contact, else:
 79 | 3. The value of the `Time Zone Field` in the action, else:
 80 | 4. The system default time zone
 81 | 
 82 | #### Time Zone Field
 83 | 
 84 | If a time zone is specified in this field, the cron expression will evaluate against the selected time zone.  This allows you to do things such as only sending emails during _your_ working hours.
 85 | 
 86 | If you've enabled the "Use Contact's Time Zone" field, the contact's time zone would be used instead of this field (unless the Contact's time zone is unknown in which case the plugin will fall back to the time zone specified here).
 87 | 
 88 | ## Testing the Plugin
 89 | 
 90 | This plugin includes a suite of unit tests. You will need to have PHPUnit installed in order to run the tests.
 91 | 
 92 | ### Installing PHPUnit on AlpineLinux
 93 | 
 94 | ```bash
 95 | apk update && apk add ca-certificates && update-ca-certificates && apk add openssl
 96 | /usr/bin/wget https://phar.phpunit.de/phpunit.phar -O /usr/bin/phpunit && chmod 755 /usr/bin/phpunit
 97 | ```
 98 | 
 99 | ### Installing PHPUnit on Debian Linux
100 | 
101 | ```bash
102 | curl https://phar.phpunit.de/phpunit.phar -L -o /usr/bin/phpunit && chmod 755 /usr/bin/phpunit
103 | ```
104 | 
105 | ### Running the Tests
106 | 
107 | Change directories into the plugin dir (`cd plugins/ThirdSetMauticTimingBundle`) and then run:
108 | 
109 | ```bash
110 | phpunit
111 | ```
112 | 
113 | Or for older versions of Mautic (<4.0), run:
114 | 
115 | ```bash
116 | phpunit --bootstrap ../../app/autoload.php
117 | ```
118 | 
119 | ## Credits
120 | 
121 | This plugin is developed and maintained by [Third Set Productions](http://www.thirdset.com) the makers of [AdPlugg](http://www.adplugg.com).
122 | 
123 | ## Disclaimer
124 | 
125 | This plugin is licensed under GPLv3.
126 | 
127 | The GPL clearly explains that there is no warranty for this free software. Please see the included license.txt file for details.
128 | 


--------------------------------------------------------------------------------
/Executioner/EventExecutioner.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2018 Third Set Productions.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Executioner;
 11 | 
 12 | use Psr\Log\LoggerInterface;
 13 | use Doctrine\Common\Collections\ArrayCollection;
 14 | 
 15 | use Mautic\CampaignBundle\Executioner\Result\Counter;
 16 | use Mautic\CampaignBundle\Entity\LeadRepository;
 17 | use Mautic\CampaignBundle\EventCollector\EventCollector;
 18 | use Mautic\CampaignBundle\Executioner\Event\ActionExecutioner;
 19 | use Mautic\CampaignBundle\Executioner\Event\ConditionExecutioner;
 20 | use Mautic\CampaignBundle\Executioner\Event\DecisionExecutioner;
 21 | use Mautic\CampaignBundle\Executioner\Logger\EventLogger;
 22 | use Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler;
 23 | use Mautic\CampaignBundle\Helper\RemovedContactTracker;
 24 | 
 25 | /**
 26 |  * Older versions of Mautic don't have the EventExecutioner class so we extend
 27 |  * a middleman class to maintain backwards compatibility.
 28 |  */
 29 | if (class_exists('\Mautic\CampaignBundle\Executioner\EventExecutioner')) {
 30 |     class VersionSafeEventExecutioner extends \Mautic\CampaignBundle\Executioner\EventExecutioner {
 31 |         
 32 |        /**
 33 |         * Increase the visibility of the scheduler from private to protected so
 34 |         * that we can access it.
 35 |         * @var EventScheduler
 36 |         */
 37 |        protected $scheduler;
 38 |         
 39 |     }
 40 | } else {
 41 |     /**
 42 |      * Create a class to extend (we won't use it but this will prevent a
 43 |      * ClassNotFoundException in older versions of Mautic).
 44 |      */
 45 |     class VersionSafeEventExecutioner {}
 46 | }
 47 | 
 48 | /**
 49 |  * The EventExecutioner class extends Mautic's EventExecutioner class to add our
 50 |  * additional timing and scheduling logic. 
 51 |  * 
 52 |  * We extend via a middle man class called VersionSafeEventExecutioner (defined
 53 |  * above) to prevent ClassNotFoundExceptions on older versions of Mautic.
 54 |  * 
 55 |  * This class was easier to modify than the other executioners because it calls
 56 |  * the scheduler from a public method.
 57 |  * 
 58 |  * This class works with Mautic v2.14 and up.
 59 |  * 
 60 |  * @package ThirdSetMauticTimingBundle
 61 |  * @since 1.2
 62 |  */
 63 | class EventExecutioner extends VersionSafeEventExecutioner
 64 | {   
 65 |     
 66 |     /**
 67 |      * Increase the visibility of the scheduler from private to protected so
 68 |      * that we can access it.
 69 |      * @var EventScheduler
 70 |      */
 71 |     protected $scheduler;
 72 |     
 73 |     /**
 74 |      * Constructor
 75 |      *
 76 |      * @param EventCollector       $eventCollector
 77 |      * @param EventLogger          $eventLogger
 78 |      * @param ActionExecutioner    $actionExecutioner
 79 |      * @param ConditionExecutioner $conditionExecutioner
 80 |      * @param DecisionExecutioner  $decisionExecutioner
 81 |      * @param LoggerInterface      $logger
 82 |      * @param EventScheduler       $scheduler
 83 |      * @param LeadRepository       $leadRepository
 84 |      */
 85 |     public function __construct(
 86 |         EventCollector $eventCollector,
 87 |         EventLogger $eventLogger,
 88 |         ActionExecutioner $actionExecutioner,
 89 |         ConditionExecutioner $conditionExecutioner,
 90 |         DecisionExecutioner $decisionExecutioner,
 91 |         LoggerInterface $logger,
 92 |         EventScheduler $scheduler,
 93 |         RemovedContactTracker $removedContactTracker,
 94 |         LeadRepository $leadRepository
 95 |     ) {
 96 |         // Call the parent constructor.
 97 |         parent::__construct(
 98 |             $eventCollector,
 99 |             $eventLogger,
100 |             $actionExecutioner,
101 |             $conditionExecutioner,
102 |             $decisionExecutioner,
103 |             $logger,
104 |             $scheduler,
105 |             $removedContactTracker,
106 |             $leadRepository);
107 | 
108 |         // Make sure that we can access the scheduler
109 |         $this->scheduler = $scheduler;
110 |     }
111 |     
112 |     /**
113 |      * The parent class executes events for a group of contacts. Here we rewrite
114 |      * the method to loop contacts individually so that we can make scheduling
115 |      * decisions on a contact by contact basis.
116 |      * @param ArrayCollection $events
117 |      * @param ArrayCollection $contacts
118 |      * @param Counter|null    $childrenCounter
119 |      * @param bool            $isInactive
120 |      *
121 |      * @throws Dispatcher\Exception\LogNotProcessedException
122 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
123 |      * @throws Exception\CannotProcessEventException
124 |      * @throws Scheduler\Exception\NotSchedulableException
125 |      */
126 |     public function executeEventsForContacts(ArrayCollection $events, ArrayCollection $contacts, Counter $childrenCounter = null, $isInactive = false)
127 |     {
128 |         // Quit if ther are no contacts.
129 |         if (!$contacts->count()) {
130 |             return;
131 |         }
132 |         
133 |         // Loop contacts and process them one at a time.
134 |         foreach ($contacts as $contact) {
135 |             
136 |             // Set the current contact on our custom scheduler.
137 |             $this->scheduler->setCurrentContact($contact);
138 |             
139 |             // Call the parent method with just our current contact.
140 |             parent::executeEventsForContacts(
141 |                         $events, 
142 |                         new ArrayCollection(array($contact)),
143 |                         $childrenCounter,
144 |                         $isInactive
145 |                     );
146 |         }
147 |     }
148 |     
149 | }
150 | 


--------------------------------------------------------------------------------
/Entity/Timing.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2016 Third Set Productions. All rights reserved.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Entity;
 11 | 
 12 | use Doctrine\ORM\Mapping as ORM;
 13 | 
 14 | use Mautic\CoreBundle\Doctrine\Mapping\ClassMetadataBuilder;
 15 | use Mautic\CampaignBundle\Entity\Event;
 16 | 
 17 | /**
 18 |  * The Timing class is an Entity class that holds timing data for an event.
 19 |  * It holds a one-to-one relationship with the Entity class.
 20 |  */
 21 | class Timing
 22 | {
 23 |     /**
 24 |      * The event that the Timing is for.
 25 |      * @var Event
 26 |      */
 27 |     private $event;
 28 | 
 29 |     /**
 30 |      * The cron expression for the Timing.
 31 |      * @var string
 32 |      */
 33 |     private $expression;
 34 | 
 35 |     /**
 36 |      * Whether or not to use the contact's timezone.
 37 |      * @var boolean
 38 |      */
 39 |     private $useContactTimezone;
 40 | 
 41 |     /**
 42 |      * The timezone for the Timing (ex: "America/Los_Angeles").
 43 |      * @var string
 44 |      */
 45 |     private $timezone;
 46 | 
 47 |     /**
 48 |      * Constructor.
 49 |      * @param Event $event|null The event that the Timing is for.
 50 |      * @param string|null $expression The cron expression for the Timing.
 51 |      * @param boolean|null $useContactTimezone Whether or not to use the
 52 |      * contact's timezone.
 53 |      * @param string|null $timezone The timezone for the Timing
 54 |      * (ex: "America/Los_Angeles")
 55 |      */
 56 |     public function __construct(
 57 |                         Event $event = null,
 58 |                         $expression = null,
 59 |                         $useContactTimezone = null,
 60 |                         $timezone = null
 61 |                     )
 62 |     {
 63 |         $this->event = $event;
 64 |         $this->expression = $expression;
 65 |         $this->useContactTimezone = $useContactTimezone;
 66 |         $this->timezone = $timezone;
 67 |     }
 68 | 
 69 |     /**
 70 |      * @param ORM\ClassMetadata $metadata
 71 |      */
 72 |     public static function loadMetadata(ORM\ClassMetadata $metadata)
 73 |     {
 74 |         $builder = new ClassMetadataBuilder($metadata);
 75 | 
 76 |         $builder->setTable('campaign_events_timing')
 77 |             ->setCustomRepositoryClass('MauticPlugin\ThirdSetMauticTimingBundle\Entity\TimingRepository');
 78 | 
 79 |         $builder->createOneToOne('event', 'Mautic\CampaignBundle\Entity\Event')
 80 |             ->isPrimaryKey()
 81 |             ->addJoinColumn('event_id', 'id', false, true, 'CASCADE')
 82 |             ->build();
 83 | 
 84 |         $builder->createField('expression', 'string')
 85 |             ->columnName('expression')
 86 |             ->nullable()
 87 |             ->build();
 88 | 
 89 |         $builder->createField('useContactTimezone', 'integer')
 90 |             ->columnName('use_contact_timezone')
 91 |             ->nullable()
 92 |             ->build();
 93 | 
 94 |         $builder->createField('timezone', 'string')
 95 |             ->columnName('timezone')
 96 |             ->nullable()
 97 |             ->build();
 98 |     }
 99 | 
100 |     /**
101 |      * Method to post data to the Timing entity.
102 |      * @param Event $event The eventId of the Campaign Event that the Timing
103 |      * belongs to.
104 |      * @param array $dataArray The post data to be added to the Timing entity.
105 |      */
106 |     public function addPostData($dataArray)
107 |     {
108 |         $this->expression = $dataArray['expression'];
109 | 
110 |         $useContactTimezone = ( ! empty($dataArray['use_contact_timezone'])) ? $dataArray['use_contact_timezone'] : 0;
111 |         $this->useContactTimezone = $useContactTimezone;
112 | 
113 |         $this->timezone = $dataArray['timezone'];
114 |     }
115 | 
116 |     /**
117 |      * Set event.
118 |      *
119 |      * @param \Mautic\CampaignBundle\Entity\Event $event
120 |      *
121 |      * @return Timing
122 |      */
123 |     public function setEvent(\Mautic\CampaignBundle\Entity\Campaign $event)
124 |     {
125 |         $this->event = $event;
126 | 
127 |         return $this;
128 |     }
129 | 
130 |     /**
131 |      * Get event.
132 |      *
133 |      * @return \Mautic\CampaignBundle\Entity\Event
134 |      */
135 |     public function getEvent()
136 |     {
137 |         return $this->event;
138 |     }
139 | 
140 |     /**
141 |      * @return array
142 |      */
143 |     public function convertToArray()
144 |     {
145 |         return get_object_vars($this);
146 |     }
147 | 
148 |     /**
149 |      * Sets the cron expression.
150 |      * @param string The cron expression.
151 |      */
152 |     public function setExpression($expression)
153 |     {
154 |         $this->expression = $expression;
155 |     }
156 | 
157 |     /**
158 |      * Gets the cron expression.
159 |      * @return string Returns the cron expression.
160 |      */
161 |     public function getExpression()
162 |     {
163 |         return $this->expression;
164 |     }
165 | 
166 |     /**
167 |      * Sets whether or not to use the contact's timezone.
168 |      * @param boolean Whether or not to use the contact's timezone.
169 |      */
170 |     public function setUseContactTimezone($useContactTimezone)
171 |     {
172 |         $this->useContactTimezone = $useContactTimezone;
173 |     }
174 | 
175 |     /**
176 |      * Gets whether or not to use the contact's timezone.
177 |      * @return boolean Returns whether or not to use the contact's timezone.
178 |      */
179 |     public function useContactTimezone()
180 |     {
181 |         return $this->useContactTimezone;
182 |     }
183 | 
184 |     /**
185 |      * Sets the timezone.
186 |      * @param string The timezone.
187 |      */
188 |     public function setTimezone($timezone)
189 |     {
190 |         $this->timezone = $timezone;
191 |     }
192 | 
193 |     /**
194 |      * Gets the timezone.
195 |      * @return string Returns the timezone.
196 |      */
197 |     public function getTimezone()
198 |     {
199 |         return $this->timezone;
200 |     }
201 | 
202 | }
203 | 


--------------------------------------------------------------------------------
/Executioner/Scheduler/EventScheduler.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2018 Third Set Productions.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Executioner\Scheduler;
 11 | 
 12 | use Psr\Log\LoggerInterface;
 13 | use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 14 | 
 15 | use Mautic\LeadBundle\Entity\Lead;
 16 | use Mautic\CampaignBundle\Entity\Event;
 17 | use Mautic\CampaignBundle\Executioner\Logger\EventLogger;
 18 | use Mautic\CampaignBundle\Executioner\Scheduler\Mode\Interval;
 19 | use Mautic\CampaignBundle\Executioner\Scheduler\Mode\DateTime;
 20 | use Mautic\CampaignBundle\EventCollector\EventCollector;
 21 | use Mautic\CoreBundle\Helper\CoreParametersHelper;
 22 | 
 23 | use MauticPlugin\ThirdSetMauticTimingBundle\Helper\TimingHelper;
 24 | 
 25 | /**
 26 |  * Older versions of Mautic don't have the EventScheduler class so we extend
 27 |  * a middleman class to maintain backwards compatibility.
 28 |  */
 29 | if (class_exists('\Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler')) {
 30 |     class VersionSafeEventScheduler extends \Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler { }
 31 | } else {
 32 |     /**
 33 |      * Create a class to extend (we won't use it but this will prevent a
 34 |      * ClassNotFoundException in older versions of Mautic).
 35 |      */
 36 |     class VersionSafeEventScheduler {}
 37 | }
 38 | 
 39 | /**
 40 |  * The EventScheduler class extends Mautic's EventScheduler class to add our
 41 |  * additional timing and scheduling logic.
 42 |  *
 43 |  * We extend via a middle man class called VersionSafeEventScheduler (defined
 44 |  * above) to prevent ClassNotFoundExceptions on older versions of Mautic.
 45 |  *
 46 |  * This class works with Mautic v2.14 and up.
 47 |  *
 48 |  * @package ThirdSetMauticTimingBundle
 49 |  * @since 1.2
 50 |  */
 51 | class EventScheduler extends VersionSafeEventScheduler
 52 | {
 53 |     /**
 54 |      * We store the current contact here so that we can use their time zone
 55 |      * when making scheduling decisions. Normally we would pass this in as a
 56 |      * method parameter but storing it as a class property allows us to override
 57 |      * less of the core Mautic code.
 58 |      * @var \Mautic\LeadBundle\Entity\Lead
 59 |      */
 60 |     protected $currentContact;
 61 | 
 62 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Helper\TimingHelper */
 63 |     protected $timingHelper;
 64 | 
 65 |     /**
 66 |      * Custom constructor. Extends the standard EventScheduler constructor to
 67 |      * also inject the TimingHelper service.
 68 |      *
 69 |      * @param LoggerInterface          $logger
 70 |      * @param EventLogger              $eventLogger
 71 |      * @param Interval                 $intervalScheduler
 72 |      * @param DateTime                 $dateTimeScheduler
 73 |      * @param EventCollector           $collector
 74 |      * @param EventDispatcherInterface $dispatcher
 75 |      * @param TimingHelper             $timingHelper
 76 |      */
 77 |     public function __construct(
 78 |         LoggerInterface $logger,
 79 |         EventLogger $eventLogger,
 80 |         Interval $intervalScheduler,
 81 |         DateTime $dateTimeScheduler,
 82 |         EventCollector $collector,
 83 |         EventDispatcherInterface $dispatcher,
 84 |         CoreParametersHelper $coreParametersHelper,
 85 |         TimingHelper $timingHelper
 86 |     ) {
 87 |         // Call the parent constructor.
 88 |         parent::__construct(
 89 |                     $logger,
 90 |                     $eventLogger,
 91 |                     $intervalScheduler,
 92 |                     $dateTimeScheduler,
 93 |                     $collector,
 94 |                     $dispatcher,
 95 |                     $coreParametersHelper
 96 |                 );
 97 | 
 98 |         $this->timingHelper = $timingHelper;
 99 |     }
100 | 
101 |     /**
102 |      * Overrides the standard getExecutionDateTime method to use our custom
103 |      * contact specific timing logic.
104 |      *
105 |      * @param Event          $event The Campaign Event that is being processed.
106 |      * @param \DateTime|null $compareFromDateTime The date to compare from (this
107 |      * would typically be 'now').
108 |      * @param \DateTime|null $comparedToDateTime The date/time to compare to.
109 |      *
110 |      * @return \DateTime
111 |      *
112 |      * @throws NotSchedulableException
113 |      */
114 |     public function getExecutionDateTime(
115 |                         Event $event,
116 |                         \DateTime $compareFromDateTime = null,
117 |                         \DateTime $comparedToDateTime = null
118 |                     )
119 |     {
120 |         // Get the executionDateTime from the parent method.
121 |         $executionDateTime = parent::getExecutionDateTime(
122 |                                         $event,
123 |                                         $compareFromDateTime,
124 |                                         $comparedToDateTime
125 |                                     );
126 | 
127 |         // Now apply our extended timing rules. Note that contact may be null
128 |         // for certain executioners and that's okay. The only one that we are
129 |         // concerned with is the EventExecutioner and that one is being
130 |         // overridden to set the contact.
131 |         if (null !== $this->currentContact) {
132 |             $executionDateTime = $this->timingHelper->getExecutionDateTime(
133 |                                     $event,
134 |                                     $this->currentContact,
135 |                                     $executionDateTime
136 |                             );
137 |         }
138 | 
139 |         return $executionDateTime;
140 |     }
141 | 
142 |     /**
143 |      * Set the current contact (the contact that is currently being scheduled).
144 |      *
145 |      * @param \Mautic\LeadBundle\Entity\Lead $currentContact
146 |      *
147 |      * @return EventScheduler
148 |      */
149 |     public function setCurrentContact(Lead $currentContact)
150 |     {
151 |         $this->currentContact = $currentContact;
152 | 
153 |         return $this;
154 |     }
155 | 
156 |     /**
157 |      * Get current contact (the contact that is currently being scheduled).
158 |      *
159 |      * @return \Mautic\LeadBundle\Entity\Lead
160 |      */
161 |     public function getCurrentContact()
162 |     {
163 |         return $this->currentContact;
164 |     }
165 | 
166 | }
167 | 


--------------------------------------------------------------------------------
/Executioner/KickoffExecutioner.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * @package     ThirdSetMauticTimingBundle
  4 |  * @copyright   2018 Third Set Productions.
  5 |  * @author      Third Set Productions
  6 |  * @link        http://www.thirdset.com
  7 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  8 |  */
  9 | 
 10 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Executioner;
 11 | 
 12 | use Doctrine\Common\Collections\ArrayCollection;
 13 | use Mautic\CampaignBundle\Entity\Campaign;
 14 | use Mautic\CampaignBundle\Entity\Event;
 15 | use Mautic\CampaignBundle\Executioner\ContactFinder\KickoffContactFinder;
 16 | use Mautic\CampaignBundle\Executioner\ContactFinder\Limiter\ContactLimiter;
 17 | use Mautic\CampaignBundle\Executioner\Exception\NoContactsFoundException;
 18 | use Mautic\CampaignBundle\Executioner\Exception\NoEventsFoundException;
 19 | use Mautic\CampaignBundle\Executioner\Result\Counter;
 20 | use Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler;
 21 | use Mautic\CampaignBundle\Executioner\Scheduler\Exception\NotSchedulableException;
 22 | use Mautic\CoreBundle\Helper\ProgressBarHelper;
 23 | use Psr\Log\LoggerInterface;
 24 | use Symfony\Component\Console\Helper\ProgressBar;
 25 | use Symfony\Component\Console\Output\NullOutput;
 26 | use Symfony\Component\Console\Output\OutputInterface;
 27 | use Symfony\Component\Translation\TranslatorInterface;
 28 | 
 29 | /**
 30 |  * Older versions of Mautic don't have the KickoffExecutioner class so we extend
 31 |  * a middleman class to maintain backwards compatibility.
 32 |  */
 33 | if (class_exists('\Mautic\CampaignBundle\Executioner\KickoffExecutioner')) {
 34 |     class VersionSafeKickoffExecutioner extends \Mautic\CampaignBundle\Executioner\KickoffExecutioner {}
 35 | } else {
 36 |     /**
 37 |      * Create a class to extend (we won't use it but this will prevent a
 38 |      * ClassNotFoundException in older versions of Mautic).
 39 |      */
 40 |     class VersionSafeKickoffExecutioner {}
 41 | }
 42 | 
 43 | /**
 44 |  * The KickoffExecutioner class extends Mautic's KickoffExecutioner class to add
 45 |  * our additional timing and scheduling logic. 
 46 |  * 
 47 |  * We extend via a middle man class called VersionSafeKickoffExecutioner 
 48 |  * (defined above) to prevent ClassNotFoundExceptions on older versions of 
 49 |  * Mautic.
 50 |  * 
 51 |  * We basically had to override this entire class. This was necessary because
 52 |  * we needed to override private methods and change how they work significantly.
 53 |  * Going forward, it will probably be easiest to diff this class against the
 54 |  * parent class.
 55 |  * 
 56 |  * This class works with Mautic v2.14 and up.
 57 |  * 
 58 |  * @package ThirdSetMauticTimingBundle
 59 |  * @since 1.2
 60 |  */
 61 | class KickoffExecutioner extends VersionSafeKickoffExecutioner
 62 | {   
 63 |     /**
 64 |      * @var ContactLimiter
 65 |      */
 66 |     private $limiter;
 67 | 
 68 |     /**
 69 |      * @var Campaign
 70 |      */
 71 |     private $campaign;
 72 | 
 73 |     /**
 74 |      * @var OutputInterface
 75 |      */
 76 |     private $output;
 77 | 
 78 |     /**
 79 |      * @var LoggerInterface
 80 |      */
 81 |     private $logger;
 82 | 
 83 |     /**
 84 |      * @var KickoffContactFinder
 85 |      */
 86 |     private $kickoffContactFinder;
 87 | 
 88 |     /**
 89 |      * @var TranslatorInterface
 90 |      */
 91 |     private $translator;
 92 | 
 93 |     /**
 94 |      * @var EventExecutioner
 95 |      */
 96 |     private $executioner;
 97 | 
 98 |     /**
 99 |      * @var EventScheduler
100 |      */
101 |     private $scheduler;
102 | 
103 |     /**
104 |      * @var ProgressBar
105 |      */
106 |     private $progressBar;
107 | 
108 |     /**
109 |      * @var int
110 |      */
111 |     private $batchCounter = 0;
112 | 
113 |     /**
114 |      * @var ArrayCollection
115 |      */
116 |     private $rootEvents;
117 | 
118 |     /**
119 |      * @var Counter
120 |      */
121 |     private $counter;
122 | 
123 |     /**
124 |      * KickoffExecutioner constructor.
125 |      *
126 |      * @param LoggerInterface      $logger
127 |      * @param KickoffContactFinder $kickoffContactFinder
128 |      * @param TranslatorInterface  $translator
129 |      * @param EventExecutioner     $executioner
130 |      * @param EventScheduler       $scheduler
131 |      */
132 |     public function __construct(
133 |         LoggerInterface $logger,
134 |         KickoffContactFinder $kickoffContactFinder,
135 |         TranslatorInterface $translator,
136 |         EventExecutioner $executioner,
137 |         EventScheduler $scheduler
138 |     ) {
139 |         $this->logger               = $logger;
140 |         $this->kickoffContactFinder = $kickoffContactFinder;
141 |         $this->translator           = $translator;
142 |         $this->executioner          = $executioner;
143 |         $this->scheduler            = $scheduler;
144 |     }
145 |     
146 |     /**
147 |      * @param Campaign             $campaign
148 |      * @param ContactLimiter       $limiter
149 |      * @param OutputInterface|null $output
150 |      *
151 |      * @return Counter
152 |      *
153 |      * @throws Dispatcher\Exception\LogNotProcessedException
154 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
155 |      * @throws Exception\CannotProcessEventException
156 |      * @throws NotSchedulableException
157 |      */
158 |     public function execute(Campaign $campaign, ContactLimiter $limiter, OutputInterface $output = null)
159 |     {
160 |         $this->campaign = $campaign;
161 |         $this->limiter  = $limiter;
162 |         $this->output   = ($output) ? $output : new NullOutput();
163 |         $this->counter  = new Counter();
164 | 
165 |         try {
166 |             $this->prepareForExecution();
167 |             $this->executeOrScheduleEvent();
168 |         } catch (NoContactsFoundException $exception) {
169 |             $this->logger->debug('CAMPAIGN: No more contacts to process');
170 |         } catch (NoEventsFoundException $exception) {
171 |             $this->logger->debug('CAMPAIGN: No events to process');
172 |         } finally {
173 |             if ($this->progressBar) {
174 |                 $this->progressBar->finish();
175 |                 $this->output->writeln("\n");
176 |             }
177 |         }
178 | 
179 |         return $this->counter;
180 |     }
181 | 
182 |     /**
183 |      * @throws NoEventsFoundException
184 |      */
185 |     private function prepareForExecution()
186 |     {
187 |         $this->logger->debug('CAMPAIGN: Triggering kickoff events');
188 | 
189 |         $this->progressBar  = null;
190 |         $this->batchCounter = 0;
191 | 
192 |         $this->rootEvents = $this->campaign->getRootEvents();
193 |         $totalRootEvents  = $this->rootEvents->count();
194 |         $this->logger->debug('CAMPAIGN: Processing the following events: '.implode(', ', $this->rootEvents->getKeys()));
195 | 
196 |         $totalContacts      = $this->kickoffContactFinder->getContactCount($this->campaign->getId(), $this->rootEvents->getKeys(), $this->limiter);
197 |         $totalKickoffEvents = $totalRootEvents * $totalContacts;
198 | 
199 |         $this->output->writeln(
200 |             $this->translator->trans(
201 |                 'mautic.campaign.trigger.event_count',
202 |                 [
203 |                     '%events%' => $totalKickoffEvents,
204 |                     '%batch%'  => $this->limiter->getBatchLimit(),
205 |                 ]
206 |             )
207 |         );
208 | 
209 |         if (!$totalKickoffEvents) {
210 |             throw new NoEventsFoundException();
211 |         }
212 | 
213 |         $this->progressBar = ProgressBarHelper::init($this->output, $totalKickoffEvents);
214 |         $this->progressBar->start();
215 |     }
216 | 
217 |     /**
218 |      * @throws Dispatcher\Exception\LogNotProcessedException
219 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
220 |      * @throws Exception\CannotProcessEventException
221 |      * @throws NoContactsFoundException
222 |      * @throws NotSchedulableException
223 |      */
224 |     private function executeOrScheduleEvent()
225 |     {
226 |         // Use the same timestamp across all contacts processed
227 |         $now = new \DateTime();
228 |         $this->counter->advanceEventCount($this->rootEvents->count());
229 | 
230 |         // Loop over contacts until the entire campaign is executed
231 |         $contacts = $this->kickoffContactFinder->getContacts($this->campaign->getId(), $this->limiter);
232 |         while ($contacts->count()) {
233 |             $batchMinContactId = max($contacts->getKeys()) + 1;
234 |             $rootEvents        = clone $this->rootEvents;
235 | 
236 |             /** @var Event $event */
237 |             foreach ($rootEvents as $key => $event) {
238 |                 $this->progressBar->advance($contacts->count());
239 |                 $this->counter->advanceEvaluated($contacts->count());
240 | 
241 |                 // Loop contacts and process them one at a time.
242 |                 foreach ($contacts as $contact) {
243 |                     $this->scheduler->setCurrentContact($contact);
244 |                 
245 |                     // Check if the event should be scheduled (let the schedulers do the debug logging)
246 |                     $executionDate = $this->scheduler->getExecutionDateTime($event, $now);
247 |                     $this->logger->debug(
248 |                         'CAMPAIGN: Event ID# '.$event->getId().
249 |                         ' to be executed on '.$executionDate->format('Y-m-d H:i:s').
250 |                         ' compared to '.$now->format('Y-m-d H:i:s')
251 |                     );
252 | 
253 |                     if ($this->scheduler->shouldSchedule($executionDate, $now)) {
254 |                         $this->counter->advanceTotalScheduled(1);
255 |                         $this->scheduler->schedule($event, $executionDate, new ArrayCollection(array($contact)));
256 | 
257 |                         $rootEvents->remove($key);
258 | 
259 |                         continue;
260 |                     }
261 |                 }
262 |             }
263 | 
264 |             if ($rootEvents->count()) {
265 |                 // Execute the events for the batch of contacts
266 |                 $this->executioner->executeEventsForContacts($rootEvents, $contacts, $this->counter);
267 |             }
268 | 
269 |             $this->kickoffContactFinder->clear();
270 | 
271 |             if ($this->limiter->getContactId()) {
272 |                 // No use making another call
273 |                 break;
274 |             }
275 | 
276 |             $this->logger->debug('CAMPAIGN: Fetching the next batch of kickoff contacts starting with contact ID '.$batchMinContactId);
277 |             $this->limiter->setBatchMinContactId($batchMinContactId);
278 | 
279 |             // Get the next batch
280 |             $contacts = $this->kickoffContactFinder->getContacts($this->campaign->getId(), $this->limiter);
281 |         }
282 |     }
283 | }
284 | 


--------------------------------------------------------------------------------
/Helper/TimingHelper.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @package     ThirdSetMauticTimingBundle
  5 |  * @copyright   2019 Third Set Productions.
  6 |  * @author      Third Set Productions
  7 |  * @link        http://www.thirdset.com
  8 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  9 |  */
 10 | 
 11 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Helper;
 12 | 
 13 | use Mautic\CampaignBundle\Entity\Event;
 14 | use Mautic\LeadBundle\Entity\Lead;
 15 | 
 16 | use MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing;
 17 | use MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel;
 18 | 
 19 | use MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron\CronExpression;
 20 | 
 21 | /**
 22 |  * Class TimingHelper.
 23 |  *
 24 |  * @package ThirdSetMauticTimingBundle
 25 |  * @since 1.0
 26 |  */
 27 | class TimingHelper
 28 | {
 29 |     /** @var \MauticPlugin\ThirdSetMauticTimingBundle\Model\TimingModel */
 30 |     private $timingModel;
 31 | 
 32 |     /**
 33 |      * Constructor.
 34 |      * @param TimingModel $timingModel
 35 |      */
 36 |     public function __construct(
 37 |                 TimingModel $timingModel
 38 |             )
 39 |     {
 40 |         $this->timingModel = $timingModel;
 41 |     }
 42 | 
 43 |     /**
 44 |      * Gets the executionDateTime with our extended timing rules applied.
 45 |      *
 46 |      * This is used by Mautic 2.14 and up.
 47 |      *
 48 |      * @param \Mautic\CampaignBundle\Entity\Event $event The Campaign Event to
 49 |      * use for the evaluation.
 50 |      * @param \Mautic\LeadBundle\Entity\Lead $contact The Contact to use for the
 51 |      * evaluation.
 52 |      * @param \DateTime $executionDateTime The executionDateTime that was
 53 |      * determined by Mautic's standard timing rules.
 54 |      * @param string $initNowStr A string for calulating 'now'. This can be used
 55 |      * to find the nextRunDate based on some future now date.
 56 |      * @return \DateTime Returns the executionDateTime.
 57 |      */
 58 |     public function getExecutionDateTime(
 59 |                         Event $event,
 60 |                         Lead $contact,
 61 |                         \DateTime $executionDateTime,
 62 |                         $initNowStr = 'now'
 63 |                     )
 64 |     {
 65 |         /* @var $timing \MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing */
 66 |         $timing = $this->timingModel->getById($event->getId());
 67 | 
 68 |         // If there is no timing data for the event, return the received
 69 |         // executionDateTime as is.
 70 |         if (null === $timing) {
 71 |             return $executionDateTime;
 72 |         }
 73 | 
 74 |         // If the timing expression is empty/null, return the received
 75 |         // executionDateTime as is.
 76 |         if (empty($timing->getExpression())) {
 77 |             return $executionDateTime;
 78 |         }
 79 | 
 80 |         // Get the nextRunDate (next time that the trigger can be run according
 81 |         // to our extended timing rules).
 82 |         $nextRunDate = $this->getNextRunDate(
 83 |                                 $timing,
 84 |                                 $contact,
 85 |                                 $executionDateTime->format('Y-m-d H:i:s')
 86 |                         );
 87 | 
 88 |         return $nextRunDate;
 89 |     }
 90 | 
 91 |     /**
 92 |      * Our custom checkEventTiming function.
 93 |      * @param array $eventData An array of event data.
 94 |      * @param \DateTime|null $parentTriggeredDate
 95 |      * @param boolean $allowNegative
 96 |      * @param Mautic\LeadBundle\Entity\Lead The Lead to use for the evaluation.
 97 |      * @param string $initNowStr A string for calulating 'now'.  This is used
 98 |      * for testing and can usually be left off.
 99 |      * @return \DateTime|boolean|null Returns one of:
100 |      *  * The DateTime when the event should be triggered (if in the future)
101 |      *  * true if the event is due now
102 |      *  * false if there is an error/issue.
103 |      *  * null if we want to pass through and let it be determined by core
104 |      *    methods.
105 |      */
106 |     public function checkEventTiming(
107 |                         $eventData,
108 |                         \DateTime $parentTriggeredDate = null,
109 |                         $allowNegative = false,
110 |                         Lead $lead,
111 |                         $initNowStr = 'now'
112 |                     )
113 |     {
114 |         $eventId = $eventData['id'];
115 | 
116 |         /* @var $timing \MauticPlugin\ThirdSetMauticTimingBundle\Entity\Timing */
117 |         $timing = $this->timingModel->getById($eventId);
118 | 
119 |         // If there is no timing data for the event, return null (hand off to
120 |         // core methods).
121 |         if (null === $timing) {
122 |             return null;
123 |         }
124 | 
125 |         // If the timing expression is empty/null, return null (hand off to core
126 |         //methods).
127 |         if (empty($timing->getExpression())) {
128 |             return null;
129 |         }
130 | 
131 |         // Get the dueDate (according to the standard Mautic settings).
132 |         $dueDate = $this->getDueDate(
133 |                             $eventData,
134 |                             $parentTriggeredDate,
135 |                             $allowNegative,
136 |                             $initNowStr
137 |                     );
138 | 
139 |         // If the standard mautic logic returns null, return null (hand off to
140 |         // core methods).
141 |         if (null === $dueDate) {
142 |             return null;
143 |         }
144 | 
145 |         // Get the nextRunDate (next time that the trigger can be run according
146 |         // to our extended timing rules).
147 |         $nextRunDate = $this->getNextRunDate(
148 |                                 $timing,
149 |                                 $lead,
150 |                                 $dueDate->format('Y-m-d H:i:s')
151 |                         );
152 | 
153 |         $now = new \DateTime($initNowStr);
154 | 
155 |         if ($nextRunDate <= $now) {
156 |             return true; // Trigger now.
157 |         } else {
158 |             return $nextRunDate; // Schedule.
159 |         }
160 |     }
161 | 
162 |     /**
163 |      * Private helper function to calculate the due date based on the standard
164 |      * Mautic timing logic/fields.
165 |      *
166 |      * Most of the logic here is copy/pasta from the
167 |      * Mautic\CampaignBundle\Model\EventModel->checkEventTiming function
168 |      *
169 |      * @param array $action An array of data from an action Event.
170 |      * @param \DateTime|null $parentTriggeredDate
171 |      * @param boolean $allowNegative
172 |      * @param string $initNowStr A string for calulating 'now'.  This is used
173 |      * for testing and can usually be left off.
174 |      * @return DateTime|null
175 |      */
176 |     private function getDueDate(
177 |                             $action,
178 |                             \DateTime $parentTriggeredDate = null,
179 |                             $allowNegative = false,
180 |                             $initNowStr = 'now'
181 |     ) {
182 |         if (('no' === $action['decisionPath']) && (!$allowNegative)) {
183 |             return null;
184 |         }
185 | 
186 |         // Default the dueDate to now.
187 |         $dueDate = new \DateTime($initNowStr);
188 | 
189 |         if ($action['triggerMode'] == 'interval') {
190 |             if (('no' === $action['decisionPath']) && ($allowNegative)) {
191 |                 $dueDate = clone $parentTriggeredDate;
192 |             }
193 | 
194 |             $interval = $action['triggerInterval'];
195 |             $unit     = strtoupper($action['triggerIntervalUnit']);
196 | 
197 |             switch ($unit) {
198 |                 case 'Y':
199 |                 case 'M':
200 |                 case 'D':
201 |                     $dt = "P{$interval}{$unit}";
202 |                     break;
203 |                 case 'I':
204 |                     $dt = "PT{$interval}M";
205 |                     break;
206 |                 case 'H':
207 |                 case 'S':
208 |                     $dt = "PT{$interval}{$unit}";
209 |                     break;
210 |             }
211 | 
212 |             $dv = new \DateInterval($dt);
213 |             $dueDate->add($dv);
214 | 
215 |         } elseif ('date' === $action['triggerMode']) {
216 |             $dueDate = $action['triggerDate'];
217 |         }
218 | 
219 |         return $dueDate;
220 |     }
221 | 
222 |     /**
223 |      * Private helper function that gets the next run date based on our timing
224 |      * rules.
225 |      * @param Timing $timing The timing rules object to use for the calculation
226 |      * this should have been pre-screened for an expression, etc.
227 |      * @param Mautic\LeadBundle\Entity\Lead The Lead to use for the evaluation.
228 |      * @param string $initNowStr A string for calulating 'now'. This can be used
229 |      * to find the nextRunDate based on some future now date.
230 |      * @return \DateTime|boolean Returns the DateTime to trigger the event (if
231 |      * in the future), true if the event is due now or false if there is an
232 |      * error/issue.
233 |      */
234 |     private function getNextRunDate(
235 |                         Timing $timing,
236 |                         Lead $lead,
237 |                         $initNowStr = 'now'
238 |                     )
239 |     {
240 |         $cron = CronExpression::factory($timing->getExpression());
241 | 
242 |         $timezone = null;
243 | 
244 |         // Attempt to use the contact's timezone (if directed).
245 |         if ($timing->useContactTimezone()) {
246 | 
247 |             if (method_exists($lead, 'getTimezone')) {
248 |                 $timezone = $lead->getTimezone();
249 |             }
250 |             if ((empty($timezone)) && (!$lead->getIpAddresses()->isEmpty())) {
251 |                 /* @var $ipDetails array */
252 |                 $ipDetails = $lead->getIpAddresses()->first()->getIpDetails();
253 |                 if (!empty($ipDetails['timezone'])) {
254 |                     $timezone = $ipDetails['timezone'];
255 |                 }
256 |             }
257 |         }
258 | 
259 |         // If no timezone is set yet, try to get it from the Timing settings.
260 |         if ((empty($timezone)) && (null !== $timing->getTimezone())) {
261 |             $timezone = $timing->getTimezone();
262 |         }
263 | 
264 |         // If no timezone is set yet, use the system's default timezone.
265 |         if (empty($timezone)) {
266 |             $timezone = date_default_timezone_get();
267 |         }
268 | 
269 |         // Calculate 'now' (offset by timezone).
270 |         $now = new \DateTime($initNowStr);
271 |         $now->setTimezone(new \DateTimeZone($timezone));
272 | 
273 |         // Calculate the next run date.
274 |         // See https://github.com/mtdowling/cron-expression/blob/master/src/Cron/CronExpression.php
275 |         $nextRunDate = $cron->getNextRunDate(
276 |                                     $now, // Current time.
277 |                                     0, // Number of matches to skip before returning a matching next run date.
278 |                                     true // allowCurrentDate: Set to TRUE to return the current date if it matches the cron expression.
279 |                                 );
280 | 
281 |         return $nextRunDate;
282 |     }
283 | }
284 | 


--------------------------------------------------------------------------------
/Executioner/RealTimeExecutioner.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @package     ThirdSetMauticTimingBundle
  5 |  * @copyright   2018 Third Set Productions.
  6 |  * @author      Third Set Productions
  7 |  * @link        http://www.thirdset.com
  8 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  9 |  */
 10 | 
 11 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Executioner;
 12 | 
 13 | use Doctrine\Common\Collections\ArrayCollection;
 14 | use Mautic\CampaignBundle\Entity\Event;
 15 | use Mautic\CampaignBundle\Entity\EventRepository;
 16 | use Mautic\CampaignBundle\EventCollector\Accessor\Event\DecisionAccessor;
 17 | use Mautic\CampaignBundle\EventCollector\EventCollector;
 18 | use Mautic\CampaignBundle\Executioner\Event\DecisionExecutioner as Executioner;
 19 | use Mautic\CampaignBundle\Executioner\Exception\CampaignNotExecutableException;
 20 | use Mautic\CampaignBundle\Executioner\Exception\DecisionNotApplicableException;
 21 | use Mautic\CampaignBundle\Executioner\Result\Responses;
 22 | use Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler;
 23 | use Mautic\CampaignBundle\Helper\ChannelExtractor;
 24 | use Mautic\LeadBundle\Entity\Lead;
 25 | use Mautic\LeadBundle\Model\LeadModel;
 26 | use Mautic\LeadBundle\Tracker\ContactTracker;
 27 | use Psr\Log\LoggerInterface;
 28 | 
 29 | /**
 30 |  * Older versions of Mautic don't have the RealTimeExecutioner class so we extend
 31 |  * a middleman class to maintain backwards compatibility.
 32 |  */
 33 | if (class_exists('\Mautic\CampaignBundle\Executioner\RealTimeExecutioner')) {
 34 |     class VersionSafeRealTimeExecutioner extends \Mautic\CampaignBundle\Executioner\RealTimeExecutioner {}
 35 | } else {
 36 |     /**
 37 |      * Create a class to extend (we won't use it but this will prevent a
 38 |      * ClassNotFoundException in older versions of Mautic).
 39 |      */
 40 |     class VersionSafeRealTimeExecutioner {}
 41 | }
 42 | 
 43 | /**
 44 |  * The RealTimeExecutioner class extends Mautic's RealTimeExecutioner class to add
 45 |  * our additional timing and scheduling logic. 
 46 |  * 
 47 |  * We extend via a middle man class called VersionSafeRealTimeExecutioner 
 48 |  * (defined above) to prevent ClassNotFoundExceptions on older versions of 
 49 |  * Mautic.
 50 |  * 
 51 |  * We basically had to override this entire class. This was necessary because
 52 |  * we needed to override private methods and change how they work significantly.
 53 |  * Going forward, it will probably be easiest to diff this class against the
 54 |  * parent class.
 55 |  * 
 56 |  * This class works with Mautic v2.14 and up.
 57 |  * 
 58 |  * @package ThirdSetMauticTimingBundle
 59 |  * @since 1.2
 60 |  */
 61 | class RealTimeExecutioner extends VersionSafeRealTimeExecutioner
 62 | {   
 63 |     /**
 64 |      * @var LoggerInterface
 65 |      */
 66 |     private $logger;
 67 | 
 68 |     /**
 69 |      * @var LeadModel
 70 |      */
 71 |     private $leadModel;
 72 | 
 73 |     /**
 74 |      * @var Lead
 75 |      */
 76 |     private $contact;
 77 | 
 78 |     /**
 79 |      * @var array
 80 |      */
 81 |     private $events;
 82 | 
 83 |     /**
 84 |      * @var EventRepository
 85 |      */
 86 |     private $eventRepository;
 87 | 
 88 |     /**
 89 |      * @var EventExecutioner
 90 |      */
 91 |     private $executioner;
 92 | 
 93 |     /**
 94 |      * @var Executioner
 95 |      */
 96 |     private $decisionExecutioner;
 97 | 
 98 |     /**
 99 |      * @var EventCollector
100 |      */
101 |     private $collector;
102 | 
103 |     /**
104 |      * @var EventScheduler
105 |      */
106 |     private $scheduler;
107 | 
108 |     /**
109 |      * @var ContactTracker
110 |      */
111 |     private $contactTracker;
112 | 
113 |     /**
114 |      * @var Responses
115 |      */
116 |     private $responses;
117 | 
118 |     /**
119 |      * RealTimeExecutioner constructor.
120 |      *
121 |      * @param LoggerInterface  $logger
122 |      * @param LeadModel        $leadModel
123 |      * @param EventRepository  $eventRepository
124 |      * @param EventExecutioner $executioner
125 |      * @param Executioner      $decisionExecutioner
126 |      * @param EventCollector   $collector
127 |      * @param EventScheduler   $scheduler
128 |      * @param ContactTracker   $contactTracker
129 |      */
130 |     public function __construct(
131 |         LoggerInterface $logger,
132 |         LeadModel $leadModel,
133 |         EventRepository $eventRepository,
134 |         EventExecutioner $executioner,
135 |         Executioner $decisionExecutioner,
136 |         EventCollector $collector,
137 |         EventScheduler $scheduler,
138 |         ContactTracker $contactTracker
139 |     ) {
140 |         $this->logger              = $logger;
141 |         $this->leadModel           = $leadModel;
142 |         $this->eventRepository     = $eventRepository;
143 |         $this->executioner         = $executioner;
144 |         $this->decisionExecutioner = $decisionExecutioner;
145 |         $this->collector           = $collector;
146 |         $this->scheduler           = $scheduler;
147 |         $this->contactTracker      = $contactTracker;
148 |     }
149 |     
150 |     /**
151 |      * @param string      $type
152 |      * @param mixed       $passthrough
153 |      * @param string|null $channel
154 |      * @param int|null    $channelId
155 |      *
156 |      * @return Responses
157 |      *
158 |      * @throws Dispatcher\Exception\LogNotProcessedException
159 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
160 |      * @throws Exception\CannotProcessEventException
161 |      * @throws Scheduler\Exception\NotSchedulableException
162 |      */
163 |     public function execute($type, $passthrough = null, $channel = null, $channelId = null)
164 |     {
165 |         $this->responses = new Responses();
166 |         $now             = new \DateTime();
167 | 
168 |         $this->logger->debug('CAMPAIGN: Campaign triggered for event type '.$type.'('.$channel.' / '.$channelId.')');
169 | 
170 |         // Kept for BC support although not sure we need this
171 |         defined('MAUTIC_CAMPAIGN_NOT_SYSTEM_TRIGGERED') or define('MAUTIC_CAMPAIGN_NOT_SYSTEM_TRIGGERED', 1);
172 | 
173 |         try {
174 |             $this->fetchCurrentContact();
175 |         } catch (CampaignNotExecutableException $exception) {
176 |             $this->logger->debug('CAMPAIGN: '.$exception->getMessage());
177 | 
178 |             return $this->responses;
179 |         }
180 | 
181 |         try {
182 |             $this->fetchCampaignData($type);
183 |         } catch (CampaignNotExecutableException $exception) {
184 |             $this->logger->debug('CAMPAIGN: '.$exception->getMessage());
185 | 
186 |             return $this->responses;
187 |         }
188 | 
189 |         /** @var Event $event */
190 |         foreach ($this->events as $event) {
191 |             try {
192 |                 $this->evaluateDecisionForContact($event, $passthrough, $channel, $channelId);
193 |             } catch (DecisionNotApplicableException $exception) {
194 |                 $this->logger->debug('CAMPAIGN: Event ID '.$event->getId().' is not applicable ('.$exception->getMessage().')');
195 | 
196 |                 continue;
197 |             }
198 | 
199 |             $children = $event->getPositiveChildren();
200 |             if (!$children->count()) {
201 |                 $this->logger->debug('CAMPAIGN: Event ID '.$event->getId().' has no positive children');
202 | 
203 |                 continue;
204 |             }
205 | 
206 |             $this->executeAssociatedEvents($children, $now);
207 |         }
208 | 
209 |         // Save any changes to the contact done by the listeners
210 |         if ($this->contact->getChanges()) {
211 |             $this->leadModel->saveEntity($this->contact, false);
212 |         }
213 | 
214 |         return $this->responses;
215 |     }
216 | 
217 |     /**
218 |      * @param ArrayCollection $children
219 |      * @param \DateTime       $now
220 |      *
221 |      * @throws Dispatcher\Exception\LogNotProcessedException
222 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
223 |      * @throws Exception\CannotProcessEventException
224 |      * @throws Scheduler\Exception\NotSchedulableException
225 |      */
226 |     private function executeAssociatedEvents(ArrayCollection $children, \DateTime $now)
227 |     {
228 |         $children = clone $children;
229 | 
230 |         /** @var Event $child */
231 |         foreach ($children as $key => $child) {
232 |             ////////////// ThirdSetMauticTimingBundle \\\\\\\\\\\\\\
233 |             $this->scheduler->setCurrentContact($this->contact);
234 |             //////////////////////////\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
235 |             $executionDate = $this->scheduler->getExecutionDateTime($child, $now);
236 |             $this->logger->debug(
237 |                 'CAMPAIGN: Event ID# '.$child->getId().
238 |                 ' to be executed on '.$executionDate->format('Y-m-d H:i:s')
239 |             );
240 | 
241 |             if ($this->scheduler->shouldSchedule($executionDate, $now)) {
242 |                 $this->scheduler->scheduleForContact($child, $executionDate, $this->contact);
243 | 
244 |                 $children->remove($key);
245 |             }
246 |         }
247 | 
248 |         if ($children->count()) {
249 |             $this->executioner->executeEventsForContact($children, $this->contact, $this->responses);
250 |         }
251 |     }
252 | 
253 |     /**
254 |      * @param Event       $event
255 |      * @param mixed       $passthrough
256 |      * @param string|null $channel
257 |      * @param int|null    $channelId
258 |      *
259 |      * @throws DecisionNotApplicableException
260 |      * @throws Exception\CannotProcessEventException
261 |      */
262 |     private function evaluateDecisionForContact(Event $event, $passthrough = null, $channel = null, $channelId = null)
263 |     {
264 |         $this->logger->debug('CAMPAIGN: Executing '.$event->getType().' ID '.$event->getId().' for contact ID '.$this->contact->getId());
265 | 
266 |         if ($event->getEventType() !== Event::TYPE_DECISION) {
267 |             @trigger_error(
268 |                 "{$event->getType()} is not assigned to a decision and no longer supported. ".
269 |                 'Check that you are executing RealTimeExecutioner::execute for an event registered as a decision.',
270 |                 E_USER_DEPRECATED
271 |             );
272 | 
273 |             throw new DecisionNotApplicableException("Event {$event->getId()} is not a decision.");
274 |         }
275 | 
276 |         // If channels do not match up, there's no need to go further
277 |         if ($channel && $event->getChannel() && $channel !== $event->getChannel()) {
278 |             throw new DecisionNotApplicableException("Channels, $channel and {$event->getChannel()}, do not match.");
279 |         }
280 | 
281 |         if ($channel && $channelId && $event->getChannelId() && $channelId !== $event->getChannelId()) {
282 |             throw new DecisionNotApplicableException("Channel IDs, $channelId and {$event->getChannelId()}, do not match for $channel.");
283 |         }
284 | 
285 |         /** @var DecisionAccessor $config */
286 |         $config = $this->collector->getEventConfig($event);
287 |         $this->decisionExecutioner->evaluateForContact($config, $event, $this->contact, $passthrough, $channel, $channelId);
288 |     }
289 | 
290 |     /**
291 |      * @throws CampaignNotExecutableException
292 |      */
293 |     private function fetchCurrentContact()
294 |     {
295 |         $this->contact = $this->contactTracker->getContact();
296 |         if (!$this->contact instanceof Lead || !$this->contact->getId()) {
297 |             throw new CampaignNotExecutableException('Unidentifiable contact');
298 |         }
299 | 
300 |         $this->logger->debug('CAMPAIGN: Current contact ID# '.$this->contact->getId());
301 |     }
302 | 
303 |     /**
304 |      * @param $type
305 |      *
306 |      * @throws CampaignNotExecutableException
307 |      */
308 |     private function fetchCampaignData($type)
309 |     {
310 |         if (!$this->events = $this->eventRepository->getContactPendingEvents($this->contact->getId(), $type)) {
311 |             throw new CampaignNotExecutableException('Contact does not have any applicable '.$type.' associations.');
312 |         }
313 | 
314 |         // 2.14 BC break workaround - pre 2.14 had a bug that recorded channelId for decisions as 1 regardless of actually ID
315 |         // if channelIdField was an array and only one item was selected. That caused the channel ID check in evaluateDecisionForContact
316 |         // to fail resulting in the decision never being evaluated. Therefore we are going to self heal these decisions.
317 |         /** @var Event $event */
318 |         foreach ($this->events as $event) {
319 |             if (1 === $event->getChannelId()) {
320 |                 ChannelExtractor::setChannel($event, $event, $this->collector->getEventConfig($event));
321 | 
322 |                 $this->eventRepository->saveEntity($event);
323 |             }
324 |         }
325 | 
326 |         $this->logger->debug('CAMPAIGN: Found '.count($this->events).' events to analyze for contact ID '.$this->contact->getId());
327 |     }
328 | }
329 | 


--------------------------------------------------------------------------------
/ThirdParty/Cron/CronExpression.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace MauticPlugin\ThirdSetMauticTimingBundle\ThirdParty\Cron;
  4 | 
  5 | use DateTime;
  6 | use DateTimeImmutable;
  7 | use DateTimeZone;
  8 | use Exception;
  9 | use InvalidArgumentException;
 10 | use RuntimeException;
 11 | 
 12 | /**
 13 |  * CRON expression parser that can determine whether or not a CRON expression is
 14 |  * due to run, the next run date and previous run date of a CRON expression.
 15 |  * The determinations made by this class are accurate if checked run once per
 16 |  * minute (seconds are dropped from date time comparisons).
 17 |  *
 18 |  * Schedule parts must map to:
 19 |  * minute [0-59], hour [0-23], day of month, month [1-12|JAN-DEC], day of week
 20 |  * [1-7|MON-SUN], and an optional year.
 21 |  *
 22 |  * @link http://en.wikipedia.org/wiki/Cron
 23 |  */
 24 | class CronExpression
 25 | {
 26 |     const MINUTE = 0;
 27 |     const HOUR = 1;
 28 |     const DAY = 2;
 29 |     const MONTH = 3;
 30 |     const WEEKDAY = 4;
 31 |     const YEAR = 5;
 32 | 
 33 |     /**
 34 |      * @var array CRON expression parts
 35 |      */
 36 |     private $cronParts;
 37 | 
 38 |     /**
 39 |      * @var FieldFactory CRON field factory
 40 |      */
 41 |     private $fieldFactory;
 42 | 
 43 |     /**
 44 |      * @var int Max iteration count when searching for next run date
 45 |      */
 46 |     private $maxIterationCount = 1000;
 47 | 
 48 |     /**
 49 |      * @var array Order in which to test of cron parts
 50 |      */
 51 |     private static $order = array(self::YEAR, self::MONTH, self::DAY, self::WEEKDAY, self::HOUR, self::MINUTE);
 52 | 
 53 |     /**
 54 |      * Factory method to create a new CronExpression.
 55 |      *
 56 |      * @param string $expression The CRON expression to create.  There are
 57 |      *                           several special predefined values which can be used to substitute the
 58 |      *                           CRON expression:
 59 |      *
 60 |      *      `@yearly`, `@annually` - Run once a year, midnight, Jan. 1 - 0 0 1 1 *
 61 |      *      `@monthly` - Run once a month, midnight, first of month - 0 0 1 * *
 62 |      *      `@weekly` - Run once a week, midnight on Sun - 0 0 * * 0
 63 |      *      `@daily` - Run once a day, midnight - 0 0 * * *
 64 |      *      `@hourly` - Run once an hour, first minute - 0 * * * *
 65 |      * @param FieldFactory $fieldFactory Field factory to use
 66 |      *
 67 |      * @return CronExpression
 68 |      */
 69 |     public static function factory($expression, FieldFactory $fieldFactory = null)
 70 |     {
 71 |         $mappings = array(
 72 |             '@yearly' => '0 0 1 1 *',
 73 |             '@annually' => '0 0 1 1 *',
 74 |             '@monthly' => '0 0 1 * *',
 75 |             '@weekly' => '0 0 * * 0',
 76 |             '@daily' => '0 0 * * *',
 77 |             '@hourly' => '0 * * * *'
 78 |         );
 79 | 
 80 |         if (isset($mappings[$expression])) {
 81 |             $expression = $mappings[$expression];
 82 |         }
 83 | 
 84 |         return new static($expression, $fieldFactory ?: new FieldFactory());
 85 |     }
 86 | 
 87 |     /**
 88 |      * Validate a CronExpression.
 89 |      *
 90 |      * @param string $expression The CRON expression to validate.
 91 |      *
 92 |      * @return bool True if a valid CRON expression was passed. False if not.
 93 |      * @see Cron\CronExpression::factory
 94 |      */
 95 |     public static function isValidExpression($expression)
 96 |     {
 97 |         try {
 98 |             self::factory($expression);
 99 |         } catch (InvalidArgumentException $e) {
100 |             return false;
101 |         }
102 | 
103 |         return true;
104 |     }
105 | 
106 |     /**
107 |      * Parse a CRON expression
108 |      *
109 |      * @param string       $expression   CRON expression (e.g. '8 * * * *')
110 |      * @param FieldFactory $fieldFactory Factory to create cron fields
111 |      */
112 |     public function __construct($expression, FieldFactory $fieldFactory)
113 |     {
114 |         $this->fieldFactory = $fieldFactory;
115 |         $this->setExpression($expression);
116 |     }
117 | 
118 |     /**
119 |      * Set or change the CRON expression
120 |      *
121 |      * @param string $value CRON expression (e.g. 8 * * * *)
122 |      *
123 |      * @return CronExpression
124 |      * @throws \InvalidArgumentException if not a valid CRON expression
125 |      */
126 |     public function setExpression($value)
127 |     {
128 |         $this->cronParts = preg_split('/\s/', $value, -1, PREG_SPLIT_NO_EMPTY);
129 |         if (count($this->cronParts) < 5) {
130 |             throw new InvalidArgumentException(
131 |                 $value . ' is not a valid CRON expression'
132 |             );
133 |         }
134 | 
135 |         foreach ($this->cronParts as $position => $part) {
136 |             $this->setPart($position, $part);
137 |         }
138 | 
139 |         return $this;
140 |     }
141 | 
142 |     /**
143 |      * Set part of the CRON expression
144 |      *
145 |      * @param int    $position The position of the CRON expression to set
146 |      * @param string $value    The value to set
147 |      *
148 |      * @return CronExpression
149 |      * @throws \InvalidArgumentException if the value is not valid for the part
150 |      */
151 |     public function setPart($position, $value)
152 |     {
153 |         if (!$this->fieldFactory->getField($position)->validate($value)) {
154 |             throw new InvalidArgumentException(
155 |                 'Invalid CRON field value ' . $value . ' at position ' . $position
156 |             );
157 |         }
158 | 
159 |         $this->cronParts[$position] = $value;
160 | 
161 |         return $this;
162 |     }
163 | 
164 |     /**
165 |      * Set max iteration count for searching next run dates
166 |      *
167 |      * @param int $maxIterationCount Max iteration count when searching for next run date
168 |      *
169 |      * @return CronExpression
170 |      */
171 |     public function setMaxIterationCount($maxIterationCount)
172 |     {
173 |         $this->maxIterationCount = $maxIterationCount;
174 |         
175 |         return $this;
176 |     }
177 | 
178 |     /**
179 |      * Get a next run date relative to the current date or a specific date
180 |      *
181 |      * @param string|\DateTime $currentTime      Relative calculation date
182 |      * @param int              $nth              Number of matches to skip before returning a
183 |      *                                           matching next run date.  0, the default, will return the current
184 |      *                                           date and time if the next run date falls on the current date and
185 |      *                                           time.  Setting this value to 1 will skip the first match and go to
186 |      *                                           the second match.  Setting this value to 2 will skip the first 2
187 |      *                                           matches and so on.
188 |      * @param bool             $allowCurrentDate Set to TRUE to return the current date if
189 |      *                                           it matches the cron expression.
190 |      *
191 |      * @return \DateTime
192 |      * @throws \RuntimeException on too many iterations
193 |      */
194 |     public function getNextRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false)
195 |     {
196 |         return $this->getRunDate($currentTime, $nth, false, $allowCurrentDate);
197 |     }
198 | 
199 |     /**
200 |      * Get a previous run date relative to the current date or a specific date
201 |      *
202 |      * @param string|\DateTime $currentTime      Relative calculation date
203 |      * @param int              $nth              Number of matches to skip before returning
204 |      * @param bool             $allowCurrentDate Set to TRUE to return the
205 |      *                                           current date if it matches the cron expression
206 |      *
207 |      * @return \DateTime
208 |      * @throws \RuntimeException on too many iterations
209 |      * @see Cron\CronExpression::getNextRunDate
210 |      */
211 |     public function getPreviousRunDate($currentTime = 'now', $nth = 0, $allowCurrentDate = false)
212 |     {
213 |         return $this->getRunDate($currentTime, $nth, true, $allowCurrentDate);
214 |     }
215 | 
216 |     /**
217 |      * Get multiple run dates starting at the current date or a specific date
218 |      *
219 |      * @param int              $total            Set the total number of dates to calculate
220 |      * @param string|\DateTime $currentTime      Relative calculation date
221 |      * @param bool             $invert           Set to TRUE to retrieve previous dates
222 |      * @param bool             $allowCurrentDate Set to TRUE to return the
223 |      *                                           current date if it matches the cron expression
224 |      *
225 |      * @return array Returns an array of run dates
226 |      */
227 |     public function getMultipleRunDates($total, $currentTime = 'now', $invert = false, $allowCurrentDate = false)
228 |     {
229 |         $matches = array();
230 |         for ($i = 0; $i < max(0, $total); $i++) {
231 |             try {
232 |                 $matches[] = $this->getRunDate($currentTime, $i, $invert, $allowCurrentDate);
233 |             } catch (RuntimeException $e) {
234 |                 break;
235 |             }
236 |         }
237 | 
238 |         return $matches;
239 |     }
240 | 
241 |     /**
242 |      * Get all or part of the CRON expression
243 |      *
244 |      * @param string $part Specify the part to retrieve or NULL to get the full
245 |      *                     cron schedule string.
246 |      *
247 |      * @return string|null Returns the CRON expression, a part of the
248 |      *                     CRON expression, or NULL if the part was specified but not found
249 |      */
250 |     public function getExpression($part = null)
251 |     {
252 |         if (null === $part) {
253 |             return implode(' ', $this->cronParts);
254 |         } elseif (array_key_exists($part, $this->cronParts)) {
255 |             return $this->cronParts[$part];
256 |         }
257 | 
258 |         return null;
259 |     }
260 | 
261 |     /**
262 |      * Helper method to output the full expression.
263 |      *
264 |      * @return string Full CRON expression
265 |      */
266 |     public function __toString()
267 |     {
268 |         return $this->getExpression();
269 |     }
270 | 
271 |     /**
272 |      * Determine if the cron is due to run based on the current date or a
273 |      * specific date.  This method assumes that the current number of
274 |      * seconds are irrelevant, and should be called once per minute.
275 |      *
276 |      * @param string|\DateTime $currentTime Relative calculation date
277 |      *
278 |      * @return bool Returns TRUE if the cron is due to run or FALSE if not
279 |      */
280 |     public function isDue($currentTime = 'now')
281 |     {
282 |         if ('now' === $currentTime) {
283 |             $currentDate = date('Y-m-d H:i');
284 |             $currentTime = strtotime($currentDate);
285 |         } elseif ($currentTime instanceof DateTime) {
286 |             $currentDate = clone $currentTime;
287 |             // Ensure time in 'current' timezone is used
288 |             $currentDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
289 |             $currentDate = $currentDate->format('Y-m-d H:i');
290 |             $currentTime = strtotime($currentDate);
291 |         } elseif ($currentTime instanceof DateTimeImmutable) {
292 |             $currentDate = DateTime::createFromFormat('U', $currentTime->format('U'));
293 |             $currentDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
294 |             $currentDate = $currentDate->format('Y-m-d H:i');
295 |             $currentTime = strtotime($currentDate);
296 |         } else {
297 |             $currentTime = new DateTime($currentTime);
298 |             $currentTime->setTime($currentTime->format('H'), $currentTime->format('i'), 0);
299 |             $currentDate = $currentTime->format('Y-m-d H:i');
300 |             $currentTime = $currentTime->getTimeStamp();
301 |         }
302 | 
303 |         try {
304 |             return $this->getNextRunDate($currentDate, 0, true)->getTimestamp() == $currentTime;
305 |         } catch (Exception $e) {
306 |             return false;
307 |         }
308 |     }
309 | 
310 |     /**
311 |      * Get the next or previous run date of the expression relative to a date
312 |      *
313 |      * @param string|\DateTime $currentTime      Relative calculation date
314 |      * @param int              $nth              Number of matches to skip before returning
315 |      * @param bool             $invert           Set to TRUE to go backwards in time
316 |      * @param bool             $allowCurrentDate Set to TRUE to return the
317 |      *                                           current date if it matches the cron expression
318 |      *
319 |      * @return \DateTime
320 |      * @throws \RuntimeException on too many iterations
321 |      */
322 |     protected function getRunDate($currentTime = null, $nth = 0, $invert = false, $allowCurrentDate = false)
323 |     {
324 |         if ($currentTime instanceof DateTime) {
325 |             $currentDate = clone $currentTime;
326 |         } elseif ($currentTime instanceof DateTimeImmutable) {
327 |             $currentDate = DateTime::createFromFormat('U', $currentTime->format('U'));
328 |             $currentDate->setTimezone($currentTime->getTimezone());
329 |         } else {
330 |             $currentDate = new DateTime($currentTime ?: 'now');
331 |             $currentDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
332 |         }
333 | 
334 |         $currentDate->setTime($currentDate->format('H'), $currentDate->format('i'), 0);
335 |         $nextRun = clone $currentDate;
336 |         $nth = (int) $nth;
337 | 
338 |         // We don't have to satisfy * or null fields
339 |         $parts = array();
340 |         $fields = array();
341 |         foreach (self::$order as $position) {
342 |             $part = $this->getExpression($position);
343 |             if (null === $part || '*' === $part) {
344 |                 continue;
345 |             }
346 |             $parts[$position] = $part;
347 |             $fields[$position] = $this->fieldFactory->getField($position);
348 |         }
349 | 
350 |         // Set a hard limit to bail on an impossible date
351 |         for ($i = 0; $i < $this->maxIterationCount; $i++) {
352 | 
353 |             foreach ($parts as $position => $part) {
354 |                 $satisfied = false;
355 |                 // Get the field object used to validate this part
356 |                 $field = $fields[$position];
357 |                 // Check if this is singular or a list
358 |                 if (strpos($part, ',') === false) {
359 |                     $satisfied = $field->isSatisfiedBy($nextRun, $part);
360 |                 } else {
361 |                     foreach (array_map('trim', explode(',', $part)) as $listPart) {
362 |                         if ($field->isSatisfiedBy($nextRun, $listPart)) {
363 |                             $satisfied = true;
364 |                             break;
365 |                         }
366 |                     }
367 |                 }
368 | 
369 |                 // If the field is not satisfied, then start over
370 |                 if (!$satisfied) {
371 |                     $field->increment($nextRun, $invert, $part);
372 |                     continue 2;
373 |                 }
374 |             }
375 | 
376 |             // Skip this match if needed
377 |             if ((!$allowCurrentDate && $nextRun == $currentDate) || --$nth > -1) {
378 |                 $this->fieldFactory->getField(0)->increment($nextRun, $invert, isset($parts[0]) ? $parts[0] : null);
379 |                 continue;
380 |             }
381 | 
382 |             return $nextRun;
383 |         }
384 | 
385 |         // @codeCoverageIgnoreStart
386 |         throw new RuntimeException('Impossible CRON expression');
387 |         // @codeCoverageIgnoreEnd
388 |     }
389 | }
390 | 


--------------------------------------------------------------------------------
/Executioner/ScheduledExecutioner.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @package     ThirdSetMauticTimingBundle
  5 |  * @copyright   2018 Third Set Productions.
  6 |  * @author      Third Set Productions
  7 |  * @link        http://www.thirdset.com
  8 |  * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
  9 |  */
 10 | 
 11 | namespace MauticPlugin\ThirdSetMauticTimingBundle\Executioner;
 12 | 
 13 | use Doctrine\Common\Collections\ArrayCollection;
 14 | use Mautic\CampaignBundle\Entity\Campaign;
 15 | use Mautic\CampaignBundle\Entity\Event;
 16 | use Mautic\CampaignBundle\Entity\LeadEventLog;
 17 | use Mautic\CampaignBundle\Entity\LeadEventLogRepository;
 18 | use Mautic\CampaignBundle\EventListener\CampaignActionJumpToEventSubscriber;
 19 | use Mautic\CampaignBundle\Executioner\ContactFinder\Limiter\ContactLimiter;
 20 | use Mautic\CampaignBundle\Executioner\ContactFinder\ScheduledContactFinder;
 21 | use Mautic\CampaignBundle\Executioner\Exception\NoContactsFoundException;
 22 | use Mautic\CampaignBundle\Executioner\Exception\NoEventsFoundException;
 23 | use Mautic\CampaignBundle\Executioner\Result\Counter;
 24 | use Mautic\CampaignBundle\Executioner\Scheduler\EventScheduler;
 25 | use Mautic\CoreBundle\Helper\ProgressBarHelper;
 26 | use Psr\Log\LoggerInterface;
 27 | use Symfony\Component\Console\Helper\ProgressBar;
 28 | use Symfony\Component\Console\Output\NullOutput;
 29 | use Symfony\Component\Console\Output\OutputInterface;
 30 | use Symfony\Component\Translation\TranslatorInterface;
 31 | 
 32 | /**
 33 |  * Older versions of Mautic don't have the ScheduledExecutioner class so we extend
 34 |  * a middleman class to maintain backwards compatibility.
 35 |  */
 36 | if (class_exists('\Mautic\CampaignBundle\Executioner\ScheduledExecutioner')) {
 37 |     class VersionSafeScheduledExecutioner extends \Mautic\CampaignBundle\Executioner\ScheduledExecutioner {}
 38 | } else {
 39 |     /**
 40 |      * Create a class to extend (we won't use it but this will prevent a
 41 |      * ClassNotFoundException in older versions of Mautic).
 42 |      */
 43 |     class VersionSafeScheduledExecutioner {}
 44 | }
 45 | 
 46 | /**
 47 |  * The ScheduledExecutioner class extends Mautic's ScheduledExecutioner class to add
 48 |  * our additional timing and scheduling logic. 
 49 |  * 
 50 |  * We extend via a middle man class called VersionSafeScheduledExecutioner 
 51 |  * (defined above) to prevent ClassNotFoundExceptions on older versions of 
 52 |  * Mautic.
 53 |  * 
 54 |  * We basically had to override this entire class. This was necessary because
 55 |  * we needed to override private methods and change how they work significantly.
 56 |  * Going forward, it will probably be easiest to diff this class against the
 57 |  * parent class.
 58 |  * 
 59 |  * This class works with Mautic v2.14 and up.
 60 |  * 
 61 |  * @package ThirdSetMauticTimingBundle
 62 |  * @since 1.2
 63 |  */
 64 | class ScheduledExecutioner extends VersionSafeScheduledExecutioner
 65 | {   
 66 |     /**
 67 |      * @var LeadEventLogRepository
 68 |      */
 69 |     private $repo;
 70 | 
 71 |     /**
 72 |      * @var LoggerInterface
 73 |      */
 74 |     private $logger;
 75 | 
 76 |     /**
 77 |      * @var TranslatorInterface
 78 |      */
 79 |     private $translator;
 80 | 
 81 |     /**
 82 |      * @var EventExecutioner
 83 |      */
 84 |     private $executioner;
 85 | 
 86 |     /**
 87 |      * @var EventScheduler
 88 |      */
 89 |     private $scheduler;
 90 | 
 91 |     /**
 92 |      * @var ScheduledContactFinder
 93 |      */
 94 |     private $scheduledContactFinder;
 95 | 
 96 |     /**
 97 |      * @var Campaign
 98 |      */
 99 |     private $campaign;
100 | 
101 |     /**
102 |      * @var ContactLimiter
103 |      */
104 |     private $limiter;
105 | 
106 |     /**
107 |      * @var OutputInterface
108 |      */
109 |     private $output;
110 | 
111 |     /**
112 |      * @var ProgressBar
113 |      */
114 |     private $progressBar;
115 | 
116 |     /**
117 |      * @var array
118 |      */
119 |     private $scheduledEvents;
120 | 
121 |     /**
122 |      * @var Counter
123 |      */
124 |     private $counter;
125 | 
126 |     /**
127 |      * @var \DateTime
128 |      */
129 |     private $now;
130 | 
131 |     /**
132 |      * ScheduledExecutioner constructor.
133 |      *
134 |      * @param LeadEventLogRepository $repository
135 |      * @param LoggerInterface        $logger
136 |      * @param TranslatorInterface    $translator
137 |      * @param EventExecutioner       $executioner
138 |      * @param EventScheduler         $scheduler
139 |      * @param ScheduledContactFinder $scheduledContactFinder
140 |      */
141 |     public function __construct(
142 |         LeadEventLogRepository $repository,
143 |         LoggerInterface $logger,
144 |         TranslatorInterface $translator,
145 |         EventExecutioner $executioner,
146 |         EventScheduler $scheduler,
147 |         ScheduledContactFinder $scheduledContactFinder
148 |     ) {
149 |         $this->repo                   = $repository;
150 |         $this->logger                 = $logger;
151 |         $this->translator             = $translator;
152 |         $this->executioner            = $executioner;
153 |         $this->scheduler              = $scheduler;
154 |         $this->scheduledContactFinder = $scheduledContactFinder;
155 |     }
156 |     
157 |     /**
158 |      * @param Campaign             $campaign
159 |      * @param ContactLimiter       $limiter
160 |      * @param OutputInterface|null $output
161 |      *
162 |      * @return Counter|mixed
163 |      *
164 |      * @throws Dispatcher\Exception\LogNotProcessedException
165 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
166 |      * @throws Exception\CannotProcessEventException
167 |      * @throws Scheduler\Exception\NotSchedulableException
168 |      * @throws \Doctrine\ORM\Query\QueryException
169 |      */
170 |     public function execute(Campaign $campaign, ContactLimiter $limiter, OutputInterface $output = null)
171 |     {
172 |         $this->campaign   = $campaign;
173 |         $this->limiter    = $limiter;
174 |         $this->output     = ($output) ? $output : new NullOutput();
175 |         $this->counter    = new Counter();
176 | 
177 |         $this->logger->debug('CAMPAIGN: Triggering scheduled events');
178 | 
179 |         try {
180 |             $this->prepareForExecution();
181 |             $this->executeOrRecheduleEvent();
182 |         } catch (NoEventsFoundException $exception) {
183 |             $this->logger->debug('CAMPAIGN: No events to process');
184 |         } finally {
185 |             if ($this->progressBar) {
186 |                 $this->progressBar->finish();
187 |                 $this->output->writeln("\n");
188 |             }
189 |         }
190 | 
191 |         return $this->counter;
192 |     }
193 | 
194 |     /**
195 |      * @param array                $logIds
196 |      * @param OutputInterface|null $output
197 |      *
198 |      * @return Counter
199 |      *
200 |      * @throws Dispatcher\Exception\LogNotProcessedException
201 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
202 |      * @throws Exception\CannotProcessEventException
203 |      * @throws Scheduler\Exception\NotSchedulableException
204 |      * @throws \Doctrine\ORM\Query\QueryException
205 |      */
206 |     public function executeByIds(array $logIds, OutputInterface $output = null)
207 |     {
208 |         $this->output  = ($output) ? $output : new NullOutput();
209 |         $this->counter = new Counter();
210 | 
211 |         if (!$logIds) {
212 |             return $this->counter;
213 |         }
214 | 
215 |         $logs           = $this->repo->getScheduledByIds($logIds);
216 |         $totalLogsFound = $logs->count();
217 |         $this->counter->advanceEvaluated($totalLogsFound);
218 | 
219 |         $this->logger->debug('CAMPAIGN: '.$logs->count().' events scheduled to execute.');
220 |         $this->output->writeln(
221 |             $this->translator->trans(
222 |                 'mautic.campaign.trigger.event_count',
223 |                 [
224 |                     '%events%' => $totalLogsFound,
225 |                     '%batch%'  => 'n/a',
226 |                 ]
227 |             )
228 |         );
229 | 
230 |         if (!$logs->count()) {
231 |             return $this->counter;
232 |         }
233 | 
234 |         $this->progressBar = ProgressBarHelper::init($this->output, $totalLogsFound);
235 |         $this->progressBar->start();
236 | 
237 |         $scheduledLogCount = $totalLogsFound - $logs->count();
238 |         $this->progressBar->advance($scheduledLogCount);
239 | 
240 |         // Organize the logs by event ID
241 |         $organized = $this->organizeByEvent($logs);
242 |         $now       = new \DateTime();
243 |         foreach ($organized as $organizedLogs) {
244 |             $event = $organizedLogs->first()->getEvent();
245 | 
246 |             // Validate that the schedule is still appropriate
247 |             $this->validateSchedule($event, $organizedLogs, $now, true);
248 | 
249 |             try {
250 |                 // Hydrate contacts with custom field data
251 |                 $this->scheduledContactFinder->hydrateContacts($organizedLogs);
252 | 
253 |                 $this->executioner->executeLogs($event, $organizedLogs, $this->counter);
254 |             } catch (NoContactsFoundException $e) {
255 |                 // All of the events were rescheduled
256 |             }
257 | 
258 |             $this->progressBar->advance($organizedLogs->count());
259 |         }
260 | 
261 |         $this->progressBar->finish();
262 | 
263 |         return $this->counter;
264 |     }
265 | 
266 |     /**
267 |      * @throws NoEventsFoundException
268 |      */
269 |     private function prepareForExecution()
270 |     {
271 |         $this->progressBar = null;
272 |         $this->now         = new \Datetime();
273 | 
274 |         // Get counts by event
275 |         $scheduledEvents       = $this->repo->getScheduledCounts($this->campaign->getId(), $this->now, $this->limiter);
276 |         $totalScheduledCount   = array_sum($scheduledEvents);
277 |         $this->scheduledEvents = array_keys($scheduledEvents);
278 |         $this->logger->debug('CAMPAIGN: '.$totalScheduledCount.' events scheduled to execute.');
279 | 
280 |         $this->output->writeln(
281 |             $this->translator->trans(
282 |                 'mautic.campaign.trigger.event_count',
283 |                 [
284 |                     '%events%' => $totalScheduledCount,
285 |                     '%batch%'  => $this->limiter->getBatchLimit(),
286 |                 ]
287 |             )
288 |         );
289 | 
290 |         if (!$totalScheduledCount) {
291 |             throw new NoEventsFoundException();
292 |         }
293 | 
294 |         $this->progressBar = ProgressBarHelper::init($this->output, $totalScheduledCount);
295 |         $this->progressBar->start();
296 |     }
297 | 
298 |     /**
299 |      * @throws Dispatcher\Exception\LogNotProcessedException
300 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
301 |      * @throws Exception\CannotProcessEventException
302 |      * @throws Scheduler\Exception\NotSchedulableException
303 |      * @throws \Doctrine\ORM\Query\QueryException
304 |      */
305 |     private function executeOrRecheduleEvent()
306 |     {
307 |         // Use the same timestamp across all contacts processed
308 |         $now = new \DateTime();
309 | 
310 |         foreach ($this->scheduledEvents as $eventId) {
311 |             $this->counter->advanceEventCount();
312 | 
313 |             // Loop over contacts until the entire campaign is executed
314 |             $this->executeScheduled($eventId, $now);
315 |         }
316 |     }
317 | 
318 |     /**
319 |      * @param           $eventId
320 |      * @param \DateTime $now
321 |      *
322 |      * @throws Dispatcher\Exception\LogNotProcessedException
323 |      * @throws Dispatcher\Exception\LogPassedAndFailedException
324 |      * @throws Exception\CannotProcessEventException
325 |      * @throws Scheduler\Exception\NotSchedulableException
326 |      * @throws \Doctrine\ORM\Query\QueryException
327 |      */
328 |     private function executeScheduled($eventId, \DateTime $now)
329 |     {
330 |         $logs = $this->repo->getScheduled($eventId, $this->now, $this->limiter);
331 |         while ($logs->count()) {
332 |             try {
333 |                 $this->scheduledContactFinder->hydrateContacts($logs);
334 |             } catch (NoContactsFoundException $e) {
335 |                 break;
336 |             }
337 | 
338 |             $event = $logs->first()->getEvent();
339 |             $this->progressBar->advance($logs->count());
340 |             $this->counter->advanceEvaluated($logs->count());
341 | 
342 |             // Validate that the schedule is still appropriate
343 |             $this->validateSchedule($event, $logs, $now);
344 | 
345 |             // Execute if there are any that did not get rescheduled
346 |             $this->executioner->executeLogs($event, $logs, $this->counter);
347 | 
348 |             // Get next batch
349 |             $this->scheduledContactFinder->clear();
350 |             $logs = $this->repo->getScheduled($eventId, $this->now, $this->limiter);
351 |         }
352 |     }
353 | 
354 |     /**
355 |      * @param Event           $event
356 |      * @param ArrayCollection $logs
357 |      * @param \DateTime       $now
358 |      * @param bool            $scheduleTogether
359 |      *
360 |      * @throws Scheduler\Exception\NotSchedulableException
361 |      */
362 |     private function validateSchedule(Event $event, ArrayCollection $logs, \DateTime $now, $scheduleTogether = false)
363 |     {
364 |         $toBeRescheduled     = new ArrayCollection();
365 |         $latestExecutionDate = $now;
366 | 
367 |         // Check if the event should be scheduled (let the schedulers do the debug logging)
368 |         /** @var LeadEventLog $log */
369 |         foreach ($logs as $key => $log) {
370 |             ////////////// ThirdSetMauticTimingBundle \\\\\\\\\\\\\\
371 |             $this->scheduler->setCurrentContact($log->getLead());
372 |             //////////////////////////\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
373 |             $executionDate = $this->scheduler->getExecutionDateTime($event, $now, $log->getDateTriggered());
374 |             $this->logger->debug(
375 |                 'CAMPAIGN: Log ID #'.$log->getID().
376 |                 ' to be executed on '.$executionDate->format('Y-m-d H:i:s').
377 |                 ' compared to '.$now->format('Y-m-d H:i:s')
378 |             );
379 | 
380 |             if ($this->scheduler->shouldSchedule($executionDate, $now)) {
381 |                 // The schedule has changed for this event since first scheduled
382 |                 $this->counter->advanceTotalScheduled();
383 |                 if ($scheduleTogether) {
384 |                     $toBeRescheduled->set($key, $log);
385 | 
386 |                     if ($executionDate > $latestExecutionDate) {
387 |                         $latestExecutionDate = $executionDate;
388 |                     }
389 |                 } else {
390 |                     $this->scheduler->reschedule($log, $executionDate);
391 |                 }
392 | 
393 |                 $logs->remove($key);
394 | 
395 |                 continue;
396 |             }
397 |         }
398 | 
399 |         if ($toBeRescheduled->count()) {
400 |             $this->scheduler->rescheduleLogs($toBeRescheduled, $latestExecutionDate);
401 |         }
402 |     }
403 | 
404 |     /**
405 |      * @param ArrayCollection $logs
406 |      *
407 |      * @return ArrayCollection[]
408 |      */
409 |     private function organizeByEvent(ArrayCollection $logs)
410 |     {
411 |         $jumpTo = [];
412 |         $other  = [];
413 | 
414 |         /** @var LeadEventLog $log */
415 |         foreach ($logs as $log) {
416 |             $event     = $log->getEvent();
417 |             $eventType = $event->getType();
418 | 
419 |             if (CampaignActionJumpToEventSubscriber::EVENT_NAME === $eventType) {
420 |                 if (!isset($jumpTo[$event->getId()])) {
421 |                     $jumpTo[$event->getId()] = new ArrayCollection();
422 |                 }
423 | 
424 |                 $jumpTo[$event->getId()]->set($log->getId(), $log);
425 |             } else {
426 |                 if (!isset($other[$event->getId()])) {
427 |                     $other[$event->getId()] = new ArrayCollection();
428 |                 }
429 | 
430 |                 $other[$event->getId()]->set($log->getId(), $log);
431 |             }
432 |         }
433 | 
434 |         return array_merge($other, $jumpTo);
435 |     }
436 | }
437 | 


--------------------------------------------------------------------------------
/license.txt:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 


--------------------------------------------------------------------------------