2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
41 class SchedulersJob extends SugarBean {
45 var $date_entered = '';
46 var $date_modified = '';
47 var $scheduler_id = '';
48 var $execute_time = '';
50 // standard SugarBean child attrs
51 var $table_name = "schedulers_times";
52 var $object_name = "SchedulersJob";
53 var $module_dir = "SchedulersJobs";
54 var $new_schema = true;
55 var $process_save_dates = true;
57 var $job_name; // the Scheduler's 'name' field
58 var $job; // the Scheduler's 'job' field
59 // object specific attributes
60 var $user; // User object
61 var $scheduler; // Scheduler parent
66 function SchedulersJob($init=true) {
70 //check is default admin exists
71 $adminId = $this->db->getOne(
72 'SELECT id FROM users WHERE id=\'1\' AND is_admin=1 AND deleted=0 AND status=\'Active\'',
74 'Error retrieving Admin account info'
76 if (false === $adminId) {//retrive other admin
77 $adminId = $this->db->getOne(
78 'SELECT id FROM users WHERE is_admin=1 AND deleted=0 AND status=\'Active\'',
80 'Error retrieving Admin account info'
83 $user->retrieve($adminId);
85 $GLOBALS['log']->fatal('No Admin account found!');
90 $user->retrieve('1'); // Scheduler jobs run as default Admin
97 ///////////////////////////////////////////////////////////////////////////
98 //// SCHEDULERSJOB HELPER FUNCTIONS
100 function fireSelf($id) {
102 $sched = new Scheduler();
103 $sched->retrieve($id);
105 $exJob = explode('::', $sched->job);
107 if(is_array($exJob)) {
108 $this->scheduler_id = $sched->id;
109 $this->scheduler = $sched;
110 $this->execute_time = $this->handleDateFormat('now');
113 if($exJob[0] == 'function') {
114 $GLOBALS['log']->debug('----->Scheduler found a job of type FUNCTION');
115 require_once('modules/Schedulers/_AddJobsHere.php');
117 $this->setJobFlag(1);
120 $GLOBALS['log']->debug('----->SchedulersJob firing '.$func);
122 $res = call_user_func($func);
124 $this->setJobFlag(2);
128 $this->setJobFlag(3);
131 } elseif($exJob[0] == 'url') {
132 if(function_exists('curl_init')) {
133 $GLOBALS['log']->debug('----->SchedulersJob found a job of type URL');
134 $this->setJobFlag(1);
136 $GLOBALS['log']->debug('----->SchedulersJob firing URL job: '.$exJob[1]);
137 if($this->fireUrl($exJob[1])) {
138 $this->setJobFlag(2);
142 $this->setJobFlag(3);
146 $this->setJobFlag(4);
155 * handles some date/time foramtting
156 * @param string time Time (usually "now")
157 * @param object user User, usually admin (id = '1')
158 * @param boolean to_local, convert to user's time format
159 * @return string formatted time.
161 function handleDateFormat($time, $user=null, $to_local=true) {
164 if(!isset($timedate) || empty($timedate)) {
165 $timedate = new TimeDate();
169 $user = (empty($user)) ? $this->user : $user;
170 $dbTime = $timedate->nowDb();
173 $ret = $timedate->to_display_date_time($dbTime, true, true, $user);
180 function setJobFlag($flag) {
181 $trackerManager = TrackerManager::getInstance();
182 $trackerManager->pause();
183 $status = array (0 => 'ready', 1 => 'in progress', 2 => 'completed', 3 => 'failed', 4 => 'no curl');
184 $statusScheduler = array (0 => 'Active', 1 => 'In Progress', 2 => 'Active', 3 => 'Active', 4 => 'Active');
185 $GLOBALS['log']->info('-----> SchedulersJob setting Job flag: '.$status[$flag].' AND setting Scheduler status to: '.$statusScheduler[$flag]);
187 $time = $this->handleDateFormat('now');
188 $this->status = $status[$flag];
189 $this->scheduler->retrieve($this->scheduler_id);
190 $this->scheduler->status = $statusScheduler[$flag];
191 $this->scheduler->save();
193 $this->retrieve($this->id);
194 $trackerManager->unPause();
198 * This function takes a job_id, and updates schedulers last_run as well as
199 * soft delete the job instance from schedulers_times
200 * @return boolean Success
202 function finishJob() {
203 $trackerManager = TrackerManager::getInstance();
204 $trackerManager->pause();
205 $GLOBALS['log']->debug('----->SchedulersJob updating Job Status and finishing Job execution.');
206 $this->scheduler->retrieve($this->scheduler->id);
208 $this->scheduler->last_run = gmdate($GLOBALS['timedate']->get_db_date_time_format());
209 if($this->scheduler->last_run == gmdate($GLOBALS['timedate']->get_db_date_time_format(), strtotime('Jan 01 2000 00:00:00'))) {
210 $this->scheduler->last_run = $this->handleDateFormat('now');
211 $GLOBALS['log']->fatal('Scheduler applying bogus date for "Last Run": '.$this->scheduler->last_run);
214 $this->scheduler->save();
215 $trackerManager->unPause();
219 * This function takes a passed URL and cURLs it to fake multi-threading with another httpd instance
220 * @param $job String in URI-clean format
221 * @param $timeout Int value in secs for cURL to timeout. 30 default.
223 //TODO: figure out what error is thrown when no more apache instances can be spun off
224 function fireUrl($job, $timeout=30) {
227 curl_setopt($ch, CURLOPT_URL, $job); // set url
228 curl_setopt($ch, CURLOPT_FAILONERROR, true); // silent failure (code >300);
229 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); // do not follow location(); inits - we always use the current
230 curl_setopt($ch, CURLOPT_FORBID_REUSE, 1);
231 curl_setopt($ch, CURLOPT_DNS_USE_GLOBAL_CACHE, false); // not thread-safe
232 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // return into a variable to continue program execution
233 curl_setopt($ch, CURLOPT_TIMEOUT, $timeout); // never times out - bad idea?
234 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 secs for connect timeout
235 curl_setopt($ch, CURLOPT_FRESH_CONNECT, true); // open brand new conn
236 curl_setopt($ch, CURLOPT_HEADER, true); // do not return header info with result
237 curl_setopt($ch, CURLOPT_NOPROGRESS, true); // do not have progress bar
238 $urlparts = parse_url($job);
239 if(empty($urlparts['port'])) {
240 if($urlparts['scheme'] == 'https'){
241 $urlparts['port'] = 443;
243 $urlparts['port'] = 80;
246 curl_setopt($ch, CURLOPT_PORT, $urlparts['port']); // set port as reported by Server
247 //TODO make the below configurable
248 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // most customers will not have Certificate Authority account
249 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // most customers will not have Certificate Authority account
251 if(constant('PHP_VERSION') > '5.0.0') {
252 curl_setopt($ch, CURLOPT_NOSIGNAL, true); // ignore any cURL signals to PHP (for multi-threading)
254 $result = curl_exec($ch);
255 $cInfo = curl_getinfo($ch); //url,content_type,header_size,request_size,filetime,http_code
256 //ssl_verify_result,total_time,namelookup_time,connect_time
257 //pretransfer_time,size_upload,size_download,speed_download,
258 //speed_upload,download_content_length,upload_content_length
259 //starttransfer_time,redirect_time
262 if($result !== FALSE && $cInfo['http_code'] < 400) {
263 $GLOBALS['log']->debug('----->Firing was successful: ('.$job.') at '.$this->handleDateFormat('now'));
264 $GLOBALS['log']->debug('----->WTIH RESULT: '.strip_tags($result).' AND '.strip_tags(print_r($cInfo, true)));
267 $GLOBALS['log']->fatal('Job errored: ('.$job.') at '.$this->handleDateFormat('now'));
271 //// END SCHEDULERSJOB HELPER FUNCTIONS
272 ///////////////////////////////////////////////////////////////////////////
275 ///////////////////////////////////////////////////////////////////////////
276 //// STANDARD SUGARBEAN OVERRIDES
278 * This function gets DB data and preps it for ListViews
280 function get_list_view_data(){
283 $temp_array = $this->get_list_view_array();
284 $temp_array['JOB_NAME'] = $this->job_name;
285 $temp_array['JOB'] = $this->job;
290 /** method stub for future customization
293 function fill_in_additional_list_fields() {
294 $this->fill_in_additional_detail_fields();
297 function fill_in_additional_detail_fields() {
298 // get the Job Name and Job fields from schedulers table
299 // $q = "SELECT name, job FROM schedulers WHERE id = '".$this->job_id."'";
300 // $result = $this->db->query($q);
301 // $row = $this->db->fetchByAssoc($result);
302 // $this->job_name = $row['name'];
303 // $this->job = $row['job'];
304 // $GLOBALS['log']->info('Assigned Name('.$this->job_name.') and Job('.$this->job.') to Job');
306 // $this->created_by_name = get_assigned_user_name($this->created_by);
307 // $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
312 * returns the bean name - overrides SugarBean's
314 function get_summary_text() {
315 if(isset($this->name))
320 * function overrides the one in SugarBean.php