*
* @return \CRM_Core_Lock the lock object
*/
- function __construct($name, $timeout = NULL, $serverWideLock = FALSE) {
- $config = CRM_Core_Config::singleton();
+ function __construct($name, $timeout = NULL, $serverWideLock = FALSE) {
+ $config = CRM_Core_Config::singleton();
$dsnArray = DB::parseDSN($config->dsn);
$database = $dsnArray['database'];
$domainID = CRM_Core_Config::domainID();
else {
$this->_name = $database . '.' . $domainID . '.' . $name;
}
+ if (defined('CIVICRM_LOCK_DEBUG')) {
+ CRM_Core_Error::debug_log_message('trying to construct lock for ' . $this->_name);
+ }
+ static $jobLog = FALSE;
+ if ($jobLog && CRM_Core_DAO::singleValueQuery("SELECT IS_USED_LOCK( '{$jobLog}')")) {
+ return $this->hackyHandleBrokenCode($jobLog);
+ }
+ if (stristr($name, 'civimail.job.')) {
+ $jobLog = $this->_name;
+ }
$this->_timeout = $timeout !== NULL ? $timeout : self::TIMEOUT;
$this->acquire();
* @return bool
*/
function acquire() {
+ if (defined('CIVICRM_LOCK_DEBUG')) {
+ CRM_Core_Error::debug_log_message('acquire lock for ' . $this->_name);
+ }
if (!$this->_hasLock) {
$query = "SELECT GET_LOCK( %1, %2 )";
- $params = array(1 => array($this->_name, 'String'),
+ $params = array(
+ 1 => array($this->_name, 'String'),
2 => array($this->_timeout, 'Integer'),
);
$res = CRM_Core_DAO::singleValueQuery($query, $params);
function isAcquired() {
return $this->_hasLock;
}
+
+ /**
+ * CRM-12856 locks were originally set up for jobs, but the concept was extended to caching & groups without
+ * understanding that would undermine the job locks (because grabbing a lock implicitly releases existing ones)
+ * this is all a big hack to mitigate the impact of that - but should not be seen as a fix. Not sure correct fix
+ * but maybe locks should be used more selectively? Or else we need to handle is some cool way that Tim is yet to write :-)
+ * if we are running in the context of the cron log then we would rather die (or at least let our process die)
+ * than release that lock - so if the attempt is being made by setCache or something relatively trivial
+ * we'll just return TRUE, but if it's another job then we will crash as that seems 'safer'
+ *
+ * @param string $jobLog
+ * @throws CRM_Core_Exception
+ * @return boolean
+ */
+ function hackyHandleBrokenCode($jobLog) {
+ if (stristr($this->_name, 'job')) {
+ throw new CRM_Core_Exception('lock aquisition for ' . $this->_name . 'attempted when ' . $jobLog . 'is not released');
+ }
+ if (defined('CIVICRM_LOCK_DEBUG')) {
+ CRM_Core_Error::debug_log_message('(CRM-12856) faking lock for ' . $this->_name);
+ }
+ $this->_hasLock = TRUE;
+ return TRUE;
+ }
}