/**
* A PHP cron script to run the outstanding and scheduled CiviMail jobs
* initiated by Owen Barton from a mailing sent by Lobo to crm-mail
*
* The structure of the file is set to mimiic soap.php which is a stand-alone
* script and hence does not have any UF issues. You should be able to run
* this script using a web url or from the command line
*/
function processQueue($batch_size)
{
require_once 'CRM/Mailing/BAO/Job.php';
// Split up the parent jobs into multiple child jobs
CRM_Mailing_BAO_Job::runJobs_pre($batch_size);
CRM_Mailing_BAO_Job::runJobs();
CRM_Mailing_BAO_Job::runJobs_post();
}
/**
* run this page (figure out the action needed and perform it).
*
* @return void
*/
function run($newArgs)
{
$this->preProcess();
if (isset($_GET['runJobs']) || CRM_Utils_Array::value('2', $newArgs) == 'queue') {
require_once 'CRM/Mailing/BAO/Job.php';
$config =& CRM_Core_Config::singleton();
CRM_Mailing_BAO_Job::runJobs_pre($config->mailerJobSize);
CRM_Mailing_BAO_Job::runJobs();
CRM_Mailing_BAO_Job::runJobs_post();
}
$this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', $this);
if ($this->_sortByCharacter == 1 || !empty($_POST)) {
$this->_sortByCharacter = '';
$this->set('sortByCharacter', '');
}
if (CRM_Utils_Array::value(3, $newArgs) == 'unscheduled') {
$this->_unscheduled = true;
}
$this->set('unscheduled', $this->_unscheduled);
if (CRM_Utils_Array::value(3, $newArgs) == 'archived') {
$this->_archived = true;
}
$this->set('archived', $this->_archived);
if (CRM_Utils_Array::value(3, $newArgs) == 'scheduled') {
$this->_scheduled = true;
}
$this->set('scheduled', $this->_scheduled);
$this->_createdId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, false, 0);
if ($this->_createdId) {
$this->set('createdId', $this->_createdId);
}
$session = CRM_Core_Session::singleton();
$context = $session->readUserContext();
if ($this->_action & CRM_Core_Action::DISABLE) {
if (CRM_Utils_Request::retrieve('confirmed', 'Boolean', $this)) {
require_once 'CRM/Mailing/BAO/Job.php';
CRM_Mailing_BAO_Job::cancel($this->_mailingId);
CRM_Utils_System::redirect($context);
} else {
$controller = new CRM_Core_Controller_Simple('CRM_Mailing_Form_Browse', ts('Cancel Mailing'), $this->_action);
$controller->setEmbedded(true);
$controller->run();
}
} else {
if ($this->_action & CRM_Core_Action::DELETE) {
if (CRM_Utils_Request::retrieve('confirmed', 'Boolean', $this)) {
// check for action permissions.
if (!CRM_Core_Permission::checkActionPermission('CiviMail', $this->_action)) {
CRM_Core_Error::fatal(ts('You do not have permission to access this page'));
}
require_once 'CRM/Mailing/BAO/Mailing.php';
CRM_Mailing_BAO_Mailing::del($this->_mailingId);
CRM_Utils_System::redirect($context);
} else {
$controller = new CRM_Core_Controller_Simple('CRM_Mailing_Form_Browse', ts('Delete Mailing'), $this->_action);
$controller->setEmbedded(true);
$controller->run();
}
} else {
if ($this->_action & CRM_Core_Action::RENEW) {
//archive this mailing, CRM-3752.
if (CRM_Utils_Request::retrieve('confirmed', 'Boolean', $this)) {
//set is_archived to 1
CRM_Core_DAO::setFieldValue('CRM_Mailing_DAO_Mailing', $this->_mailingId, 'is_archived', true);
CRM_Utils_System::redirect($context);
} else {
$controller = new CRM_Core_Controller_Simple('CRM_Mailing_Form_Browse', ts('Archive Mailing'), $this->_action);
$controller->setEmbedded(true);
$controller->run();
}
}
}
}
$selector = new CRM_Mailing_Selector_Browse();
$selector->setParent($this);
$controller = new CRM_Core_Selector_Controller($selector, $this->get(CRM_Utils_Pager::PAGE_ID), $this->get(CRM_Utils_Sort::SORT_ID) . $this->get(CRM_Utils_Sort::SORT_DIRECTION), CRM_Core_Action::VIEW, $this, CRM_Core_Selector_Controller::TEMPLATE);
$controller->setEmbedded(true);
$controller->run();
//hack to display results as per search
$rows = $controller->getRows($controller);
$this->assign('rows', $rows);
$urlParams = 'reset=1';
$urlString = 'civicrm/mailing/browse';
if (CRM_Utils_Array::value(3, $newArgs) == 'unscheduled') {
$urlString .= '/unscheduled';
$urlParams .= '&scheduled=false';
$this->assign('unscheduled', true);
CRM_Utils_System::setTitle(ts('Draft and Unscheduled Mailings'));
} else {
if (CRM_Utils_Array::value(3, $newArgs) == 'archived') {
$urlString .= '/archived';
$this->assign('archived', true);
CRM_Utils_System::setTitle(ts('Archived Mailings'));
} else {
if (CRM_Utils_Array::value(3, $newArgs) == 'scheduled') {
$urlString .= '/scheduled';
$urlParams .= '&scheduled=true';
CRM_Utils_System::setTitle(ts('Scheduled and Sent Mailings'));
} else {
CRM_Utils_System::setTitle(ts('Find Mailings'));
}
}
}
$crmRowCount = CRM_Utils_Request::retrieve('crmRowCount', 'Integer', CRM_Core_DAO::$_nullObject);
$crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject);
if ($crmRowCount || $crmPID) {
$urlParams .= '&force=1';
$urlParams .= $crmRowCount ? '&crmRowCount=' . $crmRowCount : '';
$urlParams .= $crmPID ? '&crmPID=' . $crmPID : '';
}
$crmSID = CRM_Utils_Request::retrieve('crmSID', 'Integer', CRM_Core_DAO::$_nullObject);
if ($crmSID) {
$urlParams .= '&crmSID=' . $crmSID;
}
$session = CRM_Core_Session::singleton();
$url = CRM_Utils_System::url($urlString, $urlParams);
$session->pushUserContext($url);
//CRM-6862 -run form cotroller after
//selector, since it erase $_POST
$this->search();
return parent::run();
}
static function processQueue($mode = NULL)
{
$config =& CRM_Core_Config::singleton();
CRM_Core_Error::debug_log_message("Beginning processQueue run: {$config->mailerJobsMax}, {$config->mailerJobSize}");
if ($mode == NULL && CRM_Core_BAO_MailSettings::defaultDomain() == "FIXME.ORG") {
CRM_Core_Error::fatal(ts('The <a href="%1">default mailbox</a> has not been configured. You will find <a href="%2">more info in the online user and administrator guide</a>', array(1 => CRM_Utils_System::url('civicrm/admin/mailSettings', 'reset=1'), 2 => "http://book.civicrm.org/user/initial-set-up/email-system-configuration")));
}
// check if we are enforcing number of parallel cron jobs
// CRM-8460
$gotCronLock = FALSE;
if ($config->mailerJobsMax && $config->mailerJobsMax > 1) {
$lockArray = range(1, $config->mailerJobsMax);
shuffle($lockArray);
// check if we are using global locks
$serverWideLock = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'civimail_server_wide_lock');
foreach ($lockArray as $lockID) {
$cronLock = new CRM_Core_Lock("civimail.cronjob.{$lockID}", NULL, $serverWideLock);
if ($cronLock->isAcquired()) {
$gotCronLock = TRUE;
break;
}
}
// exit here since we have enuf cronjobs running
if (!$gotCronLock) {
CRM_Core_Error::debug_log_message('Returning early, since max number of cronjobs running');
return TRUE;
}
}
// load bootstrap to call hooks
// Split up the parent jobs into multiple child jobs
CRM_Mailing_BAO_Job::runJobs_pre($config->mailerJobSize, $mode);
CRM_Mailing_BAO_Job::runJobs(NULL, $mode);
CRM_Mailing_BAO_Job::runJobs_post($mode);
// lets release the global cron lock if we do have one
if ($gotCronLock) {
$cronLock->release();
}
CRM_Core_Error::debug_log_message('Ending processQueue run');
return TRUE;
}
