| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 10 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 11 | | under the terms of the GNU Affero General Public License | |
| 12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 13 | | | |
| 14 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 17 | | See the GNU Affero General Public License for more details. | |
| 18 | | | |
| 19 | | You should have received a copy of the GNU Affero General Public | |
| 20 | | License and the CiviCRM Licensing Exception along | |
| 21 | | with this program; if not, contact CiviCRM LLC | |
| 22 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 23 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 25 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * This interface defines methods that need to be implemented |
| 30 | * by every scheduled job (cron task) in CiviCRM. |
| 31 | * |
| 32 | * @package CRM |
| 33 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 34 | * $Id$ |
| 35 | * |
| 36 | */ |
| 37 | class CRM_Core_ScheduledJob { |
| 38 | |
| 39 | var $version = 3; |
| 40 | |
| 41 | var $name = NULL; |
| 42 | |
| 43 | var $apiParams = array(); |
| 44 | |
| 45 | var $remarks = array(); |
| 46 | |
| 47 | /** |
| 48 | * @param array $params |
| 49 | */ |
| 50 | public function __construct($params) { |
| 51 | foreach ($params as $name => $param) { |
| 52 | $this->$name = $param; |
| 53 | } |
| 54 | |
| 55 | // version is set to 3 by default - if different number |
| 56 | // defined in params, it's replaced later on, however, |
| 57 | // it's practically useles, since it seems none of api v2 |
| 58 | // will work properly in cron job setup. It might become |
| 59 | // useful when/if api v4 starts to emerge and will need |
| 60 | // testing in the cron job setup. To permanenty require |
| 61 | // hardcoded api version, it's enough to move below line |
| 62 | // under following if block. |
| 63 | $this->apiParams = array('version' => $this->version); |
| 64 | |
| 65 | if (!empty($this->parameters)) { |
| 66 | $lines = explode("\n", $this->parameters); |
| 67 | |
| 68 | foreach ($lines as $line) { |
| 69 | $pair = explode("=", $line); |
| 70 | if (empty($pair[0]) || empty($pair[1])) { |
| 71 | $this->remarks[] .= 'Malformed parameters!'; |
| 72 | break; |
| 73 | } |
| 74 | $this->apiParams[trim($pair[0])] = trim($pair[1]); |
| 75 | } |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * @param null $date |
| 81 | */ |
| 82 | public function saveLastRun($date = NULL) { |
| 83 | $dao = new CRM_Core_DAO_Job(); |
| 84 | $dao->id = $this->id; |
| 85 | $dao->last_run = ($date == NULL) ? CRM_Utils_Date::currentDBDate() : CRM_Utils_Date::currentDBDate($date); |
| 86 | $dao->save(); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * @return bool |
| 91 | */ |
| 92 | public function needsRunning() { |
| 93 | // run if it was never run |
| 94 | if (empty($this->last_run)) { |
| 95 | return TRUE; |
| 96 | } |
| 97 | |
| 98 | // run_frequency check |
| 99 | switch ($this->run_frequency) { |
| 100 | case 'Always': |
| 101 | return TRUE; |
| 102 | |
| 103 | case 'Hourly': |
| 104 | $now = CRM_Utils_Date::currentDBDate(); |
| 105 | $hourAgo = strtotime('-1 hour', strtotime($now)); |
| 106 | $lastRun = strtotime($this->last_run); |
| 107 | if ($lastRun < $hourAgo) { |
| 108 | return TRUE; |
| 109 | } |
| 110 | |
| 111 | case 'Daily': |
| 112 | $now = CRM_Utils_Date::currentDBDate(); |
| 113 | $dayAgo = strtotime('-1 day', strtotime($now)); |
| 114 | $lastRun = strtotime($this->last_run); |
| 115 | if ($lastRun < $dayAgo) { |
| 116 | return TRUE; |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | return FALSE; |
| 121 | } |
| 122 | |
| 123 | public function __destruct() { |
| 124 | } |
| 125 | |
| 126 | } |