3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
39 class CRM_Admin_Form_Job
extends CRM_Admin_Form
{
40 protected $_id = NULL; function preProcess() {
44 CRM_Utils_System
::setTitle(ts('Manage - Scheduled Jobs'));
47 $refreshURL = CRM_Utils_System
::url('civicrm/admin/job',
48 "reset=1&action=update&id={$this->_id}",
53 $refreshURL = CRM_Utils_System
::url('civicrm/admin/job',
59 $this->assign('refreshURL', $refreshURL);
63 * Function to build the form
68 public function buildQuickForm($check = FALSE) {
69 parent
::buildQuickForm();
71 if ($this->_action
& CRM_Core_Action
::DELETE
) {
75 $attributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Job');
77 $this->add('text', 'name', ts('Name'),
78 $attributes['name'], TRUE
81 $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array('CRM_Core_DAO_Job', $this->_id
));
83 $this->add('text', 'description', ts('Description'),
84 $attributes['description']
87 $this->add('text', 'api_entity', ts('API Call Entity'),
88 $attributes['api_entity'], TRUE
91 $this->add('text', 'api_action', ts('API Call Action'),
92 $attributes['api_action'], TRUE
95 $this->add('select', 'run_frequency', ts('Run frequency'),
96 array('Daily' => ts('Daily'), 'Hourly' => ts('Hourly'), 'Always' => ts('Every time cron job is run'))
100 $this->add('textarea', 'parameters', ts('Command parameters'),
104 // is this job active ?
105 $this->add('checkbox', 'is_active', ts('Is this Scheduled Job active?'));
107 $this->addFormRule(array('CRM_Admin_Form_Job', 'formRule'));
110 static function formRule($fields) {
114 require_once 'api/api.php';
116 $apiRequest = array();
117 $apiRequest['entity'] = CRM_Utils_String
::munge($fields['api_entity']);
118 $apiRequest['action'] = CRM_Utils_String
::munge($fields['api_action']);
119 $apiRequest['version'] = 3;
120 $apiRequest +
= _civicrm_api_resolve($apiRequest); // look up function, file, is_generic
122 if( !$apiRequest['function'] ) {
123 $errors['api_action'] = ts('Given API command is not defined.');
126 if (!empty($errors)) {
130 return empty($errors) ?
TRUE : $errors;
133 function setDefaultValues() {
137 $defaults['is_active'] = $defaults['is_default'] = 1;
140 $domainID = CRM_Core_Config
::domainID();
142 $dao = new CRM_Core_DAO_Job();
143 $dao->id
= $this->_id
;
144 $dao->domain_id
= $domainID;
145 if (!$dao->find(TRUE)) {
149 CRM_Core_DAO
::storeValues($dao, $defaults);
152 // job entity thats shipped with core is all lower case.
153 // this makes sure camel casing is followed for proper working of default population.
154 if (CRM_Utils_Array
::value('api_entity', $defaults)) {
155 $defaults['api_entity'] = ucfirst($defaults['api_entity']);
162 * Function to process the form
168 public function postProcess() {
170 CRM_Utils_System
::flushCache('CRM_Core_DAO_Job');
172 if ($this->_action
& CRM_Core_Action
::DELETE
) {
173 CRM_Core_BAO_Job
::del($this->_id
);
174 CRM_Core_Session
::setStatus("", ts('Scheduled Job Deleted.'), "success");
178 $values = $this->controller
->exportValues($this->_name
);
179 $domainID = CRM_Core_Config
::domainID();
181 $dao = new CRM_Core_DAO_Job();
183 $dao->id
= $this->_id
;
184 $dao->domain_id
= $domainID;
185 $dao->run_frequency
= $values['run_frequency'];
186 $dao->parameters
= $values['parameters'];
187 $dao->name
= $values['name'];
188 $dao->api_entity
= $values['api_entity'];
189 $dao->api_action
= $values['api_action'];
190 $dao->description
= $values['description'];
191 $dao->is_active
= CRM_Utils_Array
::value('is_active', $values, 0);
195 // 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.
196 if ($values['api_action'] == 'update_greeting' && CRM_Utils_Array
::value('is_active', $values) == 1) {
197 // pass "wiki" as 6th param to docURL2 if you are linking to a page in wiki.civicrm.org
198 $docLink = CRM_Utils_System
::docURL2("Managing Scheduled Jobs", NULL, NULL, NULL, NULL, "wiki");
199 $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));
200 CRM_Core_Session
::setStatus($msg, ts('Warning: Update Greeting job enabled'), 'alert');