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