include/SugarQueue/SugarCronRemoteJobs.php

   1 <?php
   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-2012 SugarCRM Inc.
   6  *
   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.
  13  *
  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
  17  * details.
  18  *
  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
  22  * 02110-1301 USA.
  23  *
  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.
  26  *
  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.
  30  *
  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  ********************************************************************************/
  37
  38 require_once 'include/SugarQueue/SugarCronJobs.php';
  39 require_once 'include/SugarHttpClient.php';
  40
  41 /**
  42  * CRON driver for job queue that ships jobs outside
  43  * @api
  44  */
  45 class SugarCronRemoteJobs extends SugarCronJobs
  46 {
  47     /**
  48      * URL for remote job server
  49      * @var string
  50      */
  51     protected $jobserver;
  52
  53     /**
  54      * Just in case we'd ever need to override...
  55      * @var string
  56      */
  57     protected $submitURL = "submitJob";
  58
  59     /**
  60      * REST client
  61      * @var string
  62      */
  63     protected $client;
  64
  65     public function __construct()
  66     {
  67         parent::__construct();
  68         if(!empty($GLOBALS['sugar_config']['job_server'])) {
  69             $this->jobserver = $GLOBALS['sugar_config']['job_server'];
  70         }
  71         $this->setClient(new SugarHttpClient());
  72     }
  73
  74     /**
  75     * Set client to talk to SNIP
  76     * @param SugarHttpClient $client
  77     */
  78     public function setClient(SugarHttpClient $client)
  79     {
  80         $this->client = $client;
  81         return $this;
  82     }
  83
  84     /**
  85      * Return ID for this client
  86      * @return string
  87      */
  88     public function getMyId()
  89     {
  90         return 'CRON'.$GLOBALS['sugar_config']['unique_key'].':'.md5($this->jobserver);
  91     }
  92
  93     /**
  94      * Execute given job
  95      * @param SchedulersJob $job
  96      */
  97     public function executeJob($job)
  98     {
  99         $data = http_build_query(array("data" => json_encode(array("job" => $job->id, "client" => $this->getMyId(), "instance" => $GLOBALS['sugar_config']['site_url']))));
 100         $response = $this->client->callRest($this->jobserver.$this->submitURL, $data);
 101         if(!empty($response)) {
 102             $result = json_decode($response, true);
 103             if(empty($result) || empty($result['ok']) || $result['ok'] != $job->id) {
 104                 $GLOBALS['log']->debug("CRON Remote: Job {$job->id} not accepted by server: $response");
 105                 $this->jobFailed($job);
 106                 $job->failJob("Job not accepted by server: $response");
 107             }
 108         } else {
 109             $GLOBALS['log']->debug("CRON Remote: REST request failed for job {$job->id}");
 110             $this->jobFailed($job);
 111             $job->failJob("Could not connect to job server");
 112         }
 113     }
 114
 115 }
 116