CRM/Admin/Form/Job.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id: $
  33  *
  34  */
  35
  36 /**
  37  *
  38  */
  39 class CRM_Admin_Form_Job extends CRM_Admin_Form {
  40   protected $_id = NULL;
  41
  42   function preProcess() {
  43
  44     parent::preProcess();
  45
  46     CRM_Utils_System::setTitle(ts('Manage - Scheduled Jobs'));
  47
  48     if ($this->_id) {
  49       $refreshURL = CRM_Utils_System::url('civicrm/admin/job',
  50         "reset=1&action=update&id={$this->_id}",
  51         FALSE, NULL, FALSE
  52       );
  53     }
  54     else {
  55       $refreshURL = CRM_Utils_System::url('civicrm/admin/job',
  56         "reset=1&action=add",
  57         FALSE, NULL, FALSE
  58       );
  59     }
  60
  61     $this->assign('refreshURL', $refreshURL);
  62   }
  63
  64   /**
  65    * Function to build the form
  66    *
  67    * @return void
  68    * @access public
  69    */
  70   public function buildQuickForm($check = FALSE) {
  71     parent::buildQuickForm();
  72
  73     if ($this->_action & CRM_Core_Action::DELETE) {
  74       return;
  75     }
  76
  77     $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Job');
  78
  79     $this->add('text', 'name', ts('Name'),
  80       $attributes['name'], TRUE
  81     );
  82
  83     $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array('CRM_Core_DAO_Job', $this->_id));
  84
  85     $this->add('text', 'description', ts('Description'),
  86       $attributes['description']
  87     );
  88
  89     $this->add('text', 'api_entity', ts('API Call Entity'),
  90       $attributes['api_entity'], TRUE
  91     );
  92
  93     $this->add('text', 'api_action', ts('API Call Action'),
  94       $attributes['api_action'], TRUE
  95     );
  96
  97     $this->add('select', 'run_frequency', ts('Run frequency'),
  98       array('Daily' => ts('Daily'), 'Hourly' => ts('Hourly'), 'Always' => ts('Every time cron job is run'))
  99     );
 100
 101
 102     $this->add('textarea', 'parameters', ts('Command parameters'),
 103       "cols=50 rows=6"
 104     );
 105
 106     // is this job active ?
 107     $this->add('checkbox', 'is_active', ts('Is this Scheduled Job active?'));
 108
 109     $this->addFormRule(array('CRM_Admin_Form_Job', 'formRule'));
 110   }
 111
 112   static function formRule($fields) {
 113
 114     $errors = array();
 115
 116     require_once 'api/api.php';
 117
 118     $apiRequest = array();
 119     $apiRequest['entity']  = CRM_Utils_String::munge($fields['api_entity']);
 120     $apiRequest['action']  = CRM_Utils_String::munge($fields['api_action']);
 121     $apiRequest['version'] = 3;
 122     $apiRequest += _civicrm_api_resolve($apiRequest);    // look up function, file, is_generic
 123
 124     if( !$apiRequest['function'] ) {
 125       $errors['api_action'] = ts('Given API command is not defined.');
 126     }
 127
 128     if (!empty($errors)) {
 129       return $errors;
 130     }
 131
 132     return empty($errors) ? TRUE : $errors;
 133   }
 134
 135   function setDefaultValues() {
 136     $defaults = array();
 137
 138     if (!$this->_id) {
 139       $defaults['is_active'] = $defaults['is_default'] = 1;
 140       return $defaults;
 141     }
 142     $domainID = CRM_Core_Config::domainID();
 143
 144     $dao            = new CRM_Core_DAO_Job();
 145     $dao->id        = $this->_id;
 146     $dao->domain_id = $domainID;
 147     if (!$dao->find(TRUE)) {
 148       return $defaults;
 149     }
 150
 151     CRM_Core_DAO::storeValues($dao, $defaults);
 152
 153     // CRM-10708
 154     // job entity thats shipped with core is all lower case.
 155     // this makes sure camel casing is followed for proper working of default population.
 156     if (!empty($defaults['api_entity'])) {
 157       $defaults['api_entity'] = ucfirst($defaults['api_entity']);
 158     }
 159
 160     return $defaults;
 161   }
 162
 163   /**
 164    * Function to process the form
 165    *
 166    * @access public
 167    *
 168    * @return void
 169    */
 170   public function postProcess() {
 171
 172     CRM_Utils_System::flushCache('CRM_Core_DAO_Job');
 173
 174     if ($this->_action & CRM_Core_Action::DELETE) {
 175       CRM_Core_BAO_Job::del($this->_id);
 176       CRM_Core_Session::setStatus("", ts('Scheduled Job Deleted.'), "success");
 177       return;
 178     }
 179
 180     $values = $this->controller->exportValues($this->_name);
 181     $domainID = CRM_Core_Config::domainID();
 182
 183     $dao = new CRM_Core_DAO_Job();
 184
 185     $dao->id            = $this->_id;
 186     $dao->domain_id     = $domainID;
 187     $dao->run_frequency = $values['run_frequency'];
 188     $dao->parameters    = $values['parameters'];
 189     $dao->name          = $values['name'];
 190     $dao->api_entity    = $values['api_entity'];
 191     $dao->api_action    = $values['api_action'];
 192     $dao->description   = $values['description'];
 193     $dao->is_active     = CRM_Utils_Array::value('is_active', $values, 0);
 194
 195     $dao->save();
 196
 197     // CRM-11143 - Give warning message if update_greetings is Enabled (is_active) since it generally should not be run automatically via execute action or runjobs url.
 198     if ($values['api_action'] == 'update_greeting' && CRM_Utils_Array::value('is_active', $values) == 1) {
 199       // pass "wiki" as 6th param to docURL2 if you are linking to a page in wiki.civicrm.org
 200       $docLink = CRM_Utils_System::docURL2("Managing Scheduled Jobs", NULL, NULL, NULL, NULL, "wiki");
 201       $msg = ts('The update greeting job can be very resource intensive and is typically not necessary to run on a regular basis. If you do choose to enable the job, we recommend you do not run it with the force=1 option, which would rebuild greetings on all records. Leaving that option absent, or setting it to force=0, will only rebuild greetings for contacts that do not currently have a value stored. %1', array(1 => $docLink));
 202       CRM_Core_Session::setStatus($msg, ts('Warning: Update Greeting job enabled'), 'alert');
 203     }
 204
 205
 206   }
 207   //end of function
 208 }
 209