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