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
  53    *   Classname of BAO.
  54    */
  55   public function getBAOName() {
  56     return 'CRM_Core_BAO_Job';
  57   }
  58
  59   /**
  60    * Get action Links
  61    *
  62    * @return array
  63    *   (reference) of action links
  64    */
  65   public function &links() {
  66     if (!(self::$_links)) {
  67       self::$_links = array(
  68         CRM_Core_Action::FOLLOWUP => array(
  69           'name' => ts('View Job Log'),
  70           'url' => 'civicrm/admin/joblog',
  71           'qs' => 'jid=%%id%%&reset=1',
  72           'title' => ts('See log entries for this Scheduled Job'),
  73         ),
  74         CRM_Core_Action::UPDATE => array(
  75           'name' => ts('Edit'),
  76           'url' => 'civicrm/admin/job',
  77           'qs' => 'action=update&id=%%id%%&reset=1',
  78           'title' => ts('Edit Scheduled Job'),
  79         ),
  80         CRM_Core_Action::EXPORT => array(
  81           'name' => ts('Execute Now'),
  82           'url' => 'civicrm/admin/job',
  83           'qs' => 'action=export&id=%%id%%&reset=1',
  84           'title' => ts('Execute Scheduled Job Now'),
  85         ),
  86         CRM_Core_Action::DISABLE => array(
  87           'name' => ts('Disable'),
  88           'ref' => 'crm-enable-disable',
  89           'title' => ts('Disable Scheduled Job'),
  90         ),
  91         CRM_Core_Action::ENABLE => array(
  92           'name' => ts('Enable'),
  93           'ref' => 'crm-enable-disable',
  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    */
 116   public function run() {
 117     // set title and breadcrumb
 118     CRM_Utils_System::setTitle(ts('Settings - Scheduled Jobs'));
 119     $breadCrumb = array(array(
 120     'title' => ts('Scheduled Jobs'),
 121         'url' => CRM_Utils_System::url('civicrm/admin',
 122           'reset=1'
 123         ),
 124       ));
 125     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 126
 127     $this->_id = CRM_Utils_Request::retrieve('id', 'String',
 128       $this, FALSE, 0
 129     );
 130     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
 131       $this, FALSE, 0
 132     );
 133
 134     if ($this->_action == 'export') {
 135       $session = CRM_Core_Session::singleton();
 136       $session->pushUserContext(CRM_Utils_System::url('civicrm/admin/job', 'reset=1'));
 137     }
 138
 139     return parent::run();
 140   }
 141
 142   /**
 143    * Browse all jobs.
 144    *
 145    * @param null $action
 146    *
 147    * @return void
 148    * @static
 149    */
 150   public function browse($action = NULL) {
 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,
 179         array('id' => $job->id),
 180         ts('more'),
 181         FALSE,
 182         'job.manage.action',
 183         'Job',
 184         $job->id
 185       );
 186       $rows[] = get_object_vars($job);
 187     }
 188     $this->assign('rows', $rows);
 189   }
 190
 191   /**
 192    * Get name of edit form
 193    *
 194    * @return string
 195    *   Classname of edit form.
 196    */
 197   public function editForm() {
 198     return 'CRM_Admin_Form_Job';
 199   }
 200
 201   /**
 202    * Get edit form name
 203    *
 204    * @return string
 205    *   name of this page.
 206    */
 207   public function editName() {
 208     return 'Scheduled Jobs';
 209   }
 210
 211   /**
 212    * Get user context.
 213    *
 214    * @param null $mode
 215    *
 216    * @return string
 217    *   user context.
 218    */
 219   public function userContext($mode = NULL) {
 220     return 'civicrm/admin/job';
 221   }
 222 }