Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
ce064e4f | 35 | * Page for displaying list of jobs. |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { | |
38 | ||
39 | /** | |
eceb18cc | 40 | * The action links that we need to display for the browse screen. |
6a488035 TO |
41 | * |
42 | * @var array | |
6a488035 TO |
43 | */ |
44 | static $_links = NULL; | |
45 | ||
46 | /** | |
eceb18cc | 47 | * Get BAO Name. |
6a488035 | 48 | * |
a6c01b45 CW |
49 | * @return string |
50 | * Classname of BAO. | |
6a488035 | 51 | */ |
00be9182 | 52 | public function getBAOName() { |
6a488035 TO |
53 | return 'CRM_Core_BAO_Job'; |
54 | } | |
55 | ||
56 | /** | |
eceb18cc | 57 | * Get action Links. |
6a488035 | 58 | * |
a6c01b45 CW |
59 | * @return array |
60 | * (reference) of action links | |
6a488035 | 61 | */ |
00be9182 | 62 | public function &links() { |
6a488035 TO |
63 | if (!(self::$_links)) { |
64 | self::$_links = array( | |
65 | CRM_Core_Action::FOLLOWUP => array( | |
66 | 'name' => ts('View Job Log'), | |
67 | 'url' => 'civicrm/admin/joblog', | |
68 | 'qs' => 'jid=%%id%%&reset=1', | |
69 | 'title' => ts('See log entries for this Scheduled Job'), | |
70 | ), | |
71 | CRM_Core_Action::UPDATE => array( | |
72 | 'name' => ts('Edit'), | |
73 | 'url' => 'civicrm/admin/job', | |
74 | 'qs' => 'action=update&id=%%id%%&reset=1', | |
75 | 'title' => ts('Edit Scheduled Job'), | |
76 | ), | |
77 | CRM_Core_Action::EXPORT => array( | |
78 | 'name' => ts('Execute Now'), | |
79 | 'url' => 'civicrm/admin/job', | |
80 | 'qs' => 'action=export&id=%%id%%&reset=1', | |
81 | 'title' => ts('Execute Scheduled Job Now'), | |
82 | ), | |
83 | CRM_Core_Action::DISABLE => array( | |
84 | 'name' => ts('Disable'), | |
4d17a233 | 85 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
86 | 'title' => ts('Disable Scheduled Job'), |
87 | ), | |
88 | CRM_Core_Action::ENABLE => array( | |
89 | 'name' => ts('Enable'), | |
4d17a233 | 90 | 'ref' => 'crm-enable-disable', |
6a488035 TO |
91 | 'title' => ts('Enable Scheduled Job'), |
92 | ), | |
93 | CRM_Core_Action::DELETE => array( | |
94 | 'name' => ts('Delete'), | |
95 | 'url' => 'civicrm/admin/job', | |
96 | 'qs' => 'action=delete&id=%%id%%', | |
97 | 'title' => ts('Delete Scheduled Job'), | |
98 | ), | |
99 | ); | |
100 | } | |
101 | return self::$_links; | |
102 | } | |
103 | ||
104 | /** | |
105 | * Run the page. | |
106 | * | |
107 | * This method is called after the page is created. It checks for the | |
108 | * type of action and executes that action. | |
109 | * Finally it calls the parent's run method. | |
6a488035 | 110 | */ |
00be9182 | 111 | public function run() { |
6a488035 TO |
112 | // set title and breadcrumb |
113 | CRM_Utils_System::setTitle(ts('Settings - Scheduled Jobs')); | |
353ffa53 TO |
114 | $breadCrumb = array( |
115 | array( | |
116 | 'title' => ts('Scheduled Jobs'), | |
6a488035 TO |
117 | 'url' => CRM_Utils_System::url('civicrm/admin', |
118 | 'reset=1' | |
119 | ), | |
bed98343 | 120 | ), |
353ffa53 | 121 | ); |
6a488035 TO |
122 | CRM_Utils_System::appendBreadCrumb($breadCrumb); |
123 | ||
124 | $this->_id = CRM_Utils_Request::retrieve('id', 'String', | |
125 | $this, FALSE, 0 | |
126 | ); | |
127 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', | |
128 | $this, FALSE, 0 | |
129 | ); | |
130 | ||
131 | if ($this->_action == 'export') { | |
132 | $session = CRM_Core_Session::singleton(); | |
133 | $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/job', 'reset=1')); | |
134 | } | |
135 | ||
6a488035 TO |
136 | return parent::run(); |
137 | } | |
138 | ||
139 | /** | |
140 | * Browse all jobs. | |
141 | * | |
da6b46f4 | 142 | * @param null $action |
6a488035 | 143 | */ |
00be9182 | 144 | public function browse($action = NULL) { |
f008885c E |
145 | // check if non-prod mode is enabled. |
146 | if (CRM_Core_Config::environment() != 'Production') { | |
147 | CRM_Core_Session::setStatus(ts('Execution of scheduled jobs has been turned off by default since this is a non-production environment. You can override this for particular jobs by adding runInNonProductionEnvironment=TRUE as a parameter.'), ts("Non-production Environment"), "warning", array('expires' => 0)); | |
148 | } | |
6a488035 TO |
149 | |
150 | // using Export action for Execute. Doh. | |
151 | if ($this->_action & CRM_Core_Action::EXPORT) { | |
152 | $jm = new CRM_Core_JobManager(); | |
153 | $jm->executeJobById($this->_id); | |
154 | ||
155 | CRM_Core_Session::setStatus(ts('Selected Scheduled Job has been executed. See the log for details.'), ts("Executed"), "success"); | |
156 | } | |
157 | ||
158 | $sj = new CRM_Core_JobManager(); | |
159 | $rows = $temp = array(); | |
160 | foreach ($sj->jobs as $job) { | |
161 | $action = array_sum(array_keys($this->links())); | |
162 | ||
163 | // update enable/disable links. | |
164 | // CRM-9868- remove enable action for jobs that should never be run automatically via execute action or runjobs url | |
165 | if ($job->api_action == 'process_membership_reminder_date' || $job->api_action == 'update_greeting') { | |
166 | $action -= CRM_Core_Action::ENABLE; | |
167 | $action -= CRM_Core_Action::DISABLE; | |
168 | } | |
169 | elseif ($job->is_active) { | |
170 | $action -= CRM_Core_Action::ENABLE; | |
171 | } | |
172 | else { | |
173 | $action -= CRM_Core_Action::DISABLE; | |
174 | } | |
175 | ||
176 | $job->action = CRM_Core_Action::formLink(self::links(), $action, | |
87dab4a4 AH |
177 | array('id' => $job->id), |
178 | ts('more'), | |
179 | FALSE, | |
180 | 'job.manage.action', | |
181 | 'Job', | |
182 | $job->id | |
6a488035 TO |
183 | ); |
184 | $rows[] = get_object_vars($job); | |
185 | } | |
186 | $this->assign('rows', $rows); | |
187 | } | |
188 | ||
189 | /** | |
eceb18cc | 190 | * Get name of edit form. |
6a488035 | 191 | * |
a6c01b45 CW |
192 | * @return string |
193 | * Classname of edit form. | |
6a488035 | 194 | */ |
00be9182 | 195 | public function editForm() { |
6a488035 TO |
196 | return 'CRM_Admin_Form_Job'; |
197 | } | |
198 | ||
199 | /** | |
eceb18cc | 200 | * Get edit form name. |
6a488035 | 201 | * |
a6c01b45 CW |
202 | * @return string |
203 | * name of this page. | |
6a488035 | 204 | */ |
00be9182 | 205 | public function editName() { |
6a488035 TO |
206 | return 'Scheduled Jobs'; |
207 | } | |
208 | ||
209 | /** | |
210 | * Get user context. | |
211 | * | |
77b97be7 EM |
212 | * @param null $mode |
213 | * | |
a6c01b45 CW |
214 | * @return string |
215 | * user context. | |
6a488035 | 216 | */ |
00be9182 | 217 | public function userContext($mode = NULL) { |
6a488035 TO |
218 | return 'civicrm/admin/job'; |
219 | } | |
96025800 | 220 | |
6a488035 | 221 | } |