CRM/Admin/Page/Job.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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   public 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   public 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           'ref' => 'crm-enable-disable',
  87           'title' => ts('Disable Scheduled Job'),
  88         ),
  89         CRM_Core_Action::ENABLE => array(
  90           'name' => ts('Enable'),
  91           'ref' => 'crm-enable-disable',
  92           'title' => ts('Enable Scheduled Job'),
  93         ),
  94         CRM_Core_Action::DELETE => array(
  95           'name' => ts('Delete'),
  96           'url' => 'civicrm/admin/job',
  97           'qs' => 'action=delete&id=%%id%%',
  98           'title' => ts('Delete Scheduled Job'),
  99         ),
 100       );
 101     }
 102     return self::$_links;
 103   }
 104
 105   /**
 106    * Run the page.
 107    *
 108    * This method is called after the page is created. It checks for the
 109    * type of action and executes that action.
 110    * Finally it calls the parent's run method.
 111    *
 112    * @return void
 113    *
 114    */
 115   public function run() {
 116     // set title and breadcrumb
 117     CRM_Utils_System::setTitle(ts('Settings - Scheduled Jobs'));
 118     $breadCrumb = array(array(
 119     'title' => ts('Scheduled Jobs'),
 120         'url' => CRM_Utils_System::url('civicrm/admin',
 121           'reset=1'
 122         ),
 123       ));
 124     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 125
 126     $this->_id = CRM_Utils_Request::retrieve('id', 'String',
 127       $this, FALSE, 0
 128     );
 129     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
 130       $this, FALSE, 0
 131     );
 132
 133     if ($this->_action == 'export') {
 134       $session = CRM_Core_Session::singleton();
 135       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/job', 'reset=1'));
 136     }
 137
 138     return parent::run();
 139   }
 140
 141   /**
 142    * Browse all jobs.
 143    *
 144    * @param null $action
 145    *
 146    * @return void
 147    * @static
 148    */
 149   public function browse($action = NULL) {
 150
 151     // using Export action for Execute. Doh.
 152     if ($this->_action & CRM_Core_Action::EXPORT) {
 153       $jm = new CRM_Core_JobManager();
 154       $jm->executeJobById($this->_id);
 155
 156       CRM_Core_Session::setStatus(ts('Selected Scheduled Job has been executed. See the log for details.'), ts("Executed"), "success");
 157     }
 158
 159     $sj = new CRM_Core_JobManager();
 160     $rows = $temp = array();
 161     foreach ($sj->jobs as $job) {
 162       $action = array_sum(array_keys($this->links()));
 163
 164       // update enable/disable links.
 165       // CRM-9868- remove enable action for jobs that should never be run automatically via execute action or runjobs url
 166       if ($job->api_action == 'process_membership_reminder_date' || $job->api_action == 'update_greeting') {
 167         $action -= CRM_Core_Action::ENABLE;
 168         $action -= CRM_Core_Action::DISABLE;
 169       }
 170       elseif ($job->is_active) {
 171         $action -= CRM_Core_Action::ENABLE;
 172       }
 173       else {
 174         $action -= CRM_Core_Action::DISABLE;
 175       }
 176
 177       $job->action = CRM_Core_Action::formLink(self::links(), $action,
 178         array('id' => $job->id),
 179         ts('more'),
 180         FALSE,
 181         'job.manage.action',
 182         'Job',
 183         $job->id
 184       );
 185       $rows[] = get_object_vars($job);
 186     }
 187     $this->assign('rows', $rows);
 188   }
 189
 190   /**
 191    * Get name of edit form
 192    *
 193    * @return string Classname of edit form.
 194    */
 195   public function editForm() {
 196     return 'CRM_Admin_Form_Job';
 197   }
 198
 199   /**
 200    * Get edit form name
 201    *
 202    * @return string name of this page.
 203    */
 204   public function editName() {
 205     return 'Scheduled Jobs';
 206   }
 207
 208   /**
 209    * Get user context.
 210    *
 211    * @param null $mode
 212    *
 213    * @return string user context.
 214    */
 215   public function userContext($mode = NULL) {
 216     return 'civicrm/admin/job';
 217   }
 218 }