/**
* A method for testing the obtainPriorityLock and
* releasePriorityLock methods.
*
* @TODO Complete testing using a separate client connection to
* ensure locking works.
*/
function testLocking()
{
$oDbh =& OA_DB::singleton();
$oDal = new OA_Dal_Maintenance_Priority();
// Try to get the lock
$result = $oDal->obtainPriorityLock();
$this->assertTrue($result);
// Try to get the lock again, with a brand new connection,
// and ensure that the lock is NOT obtained
// Release the lock
$result = $oDal->releasePriorityLock();
$this->assertTrue($result);
// Try to get the lock again with the new connection, and
// ensure the lock IS obtained
// Release the lock from the new connection
}
/**
* The method to run the Maintenance Priority Engine process.
*
* @static
* @param boolean $alwaysRun Default value is false. If true, the Maintenance
* Priority Engine process will always run, even if
* instant priority updates have been disabled in the
* configuration. Used to ensure that the maintenance
* script process can always update priorities.
* @return boolean True on MPE running correctly, false otherwise.
*/
function run($alwaysRun = false)
{
OA::switchLogIdent('maintenance');
// Get the configuration
$aConf = $GLOBALS['_MAX']['CONF'];
// Should the MPE process run?
if (!$alwaysRun) {
// Is instant update for priority set?
if (!$aConf['priority']['instantUpdate']) {
OA::debug('Instant update of priorities disabled, not running MPE', PEAR_LOG_INFO);
return false;
}
OA::debug();
}
// Log the start of the process
OA::debug('Running Maintenance Priority Engine', PEAR_LOG_INFO);
// Set longer time out, and ignore user abort
if (!ini_get('safe_mode')) {
@set_time_limit($aConf['maintenance']['timeLimitScripts']);
@ignore_user_abort(true);
}
// Attempt to increase PHP memory
OX_increaseMemoryLimit(OX_getMinimumRequiredMemory('maintenance'));
// Run the following code as the "Maintenance" user
OA_Permission::switchToSystemProcessUser('Maintenance');
// Create a Maintenance DAL object
$oDal = new OA_Dal_Maintenance_Priority();
// Try to get the MPE database-level lock
$lock = $oDal->obtainPriorityLock();
if (!$lock) {
OA::debug('Unable to obtain database-level lock, not running MPE', PEAR_LOG_ERR);
return false;
}
// Ensure the the current time is registered with the OA_ServiceLocator
$oServiceLocator =& OA_ServiceLocator::instance();
$oDate =& $oServiceLocator->get('now');
if (!$oDate) {
// Record the current time, and register with the OA_ServiceLocator
$oDate = new Date();
$oServiceLocator->register('now', $oDate);
}
// Run the MPE process for the AdServer module
require_once MAX_PATH . '/lib/OA/Maintenance/Priority/AdServer.php';
$oMaintenancePriority = new OA_Maintenance_Priority_AdServer();
// TODO: OA_Maintenance_Priority_AdServer::updatePriorities
// should be refactored to return a boolean we can check here.
$oMaintenancePriority->updatePriorities();
// Release the MPE database-level lock
$result = $oDal->releasePriorityLock();
if (PEAR::isError($result)) {
// Unable to continue!
OA::debug('Unable to release database-level lock', PEAR_LOG_ERR);
return false;
}
// Return to the "normal" user
OA_Permission::switchToSystemProcessUser();
// Log the end of the process
OA::debug('Maintenance Priority Engine Completed (Started at ' . $oDate->format('%Y-%m-%d %H:%M:%S') . ' ' . $oDate->tz->getShortName() . ')', PEAR_LOG_INFO);
OA::switchLogIdent();
return true;
}
