CRM/Core/Lock.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 class CRM_Core_Lock {
  36
  37   // lets have a 3 second timeout for now
  38   const TIMEOUT = 3;
  39
  40   protected $_hasLock = FALSE;
  41
  42   protected $_name;
  43
  44   /**
  45    * Initialize the constants used during lock acquire / release
  46    *
  47    * @param string $name
  48    *   Name of the lock. Please prefix with component / functionality.
  49    *                      e.g. civimail.cronjob.JOB_ID
  50    * @param int $timeout
  51    *   The number of seconds to wait to get the lock. 1 if not set.
  52    * @param bool $serverWideLock
  53    *   Should this lock be applicable across your entire mysql server.
  54    *                                this is useful if you have multiple sites running on the same
  55    *                                mysql server and you want to limit the number of parallel cron
  56    *                                jobs - CRM-91XX
  57    *
  58    * @return \CRM_Core_Lock the lock object
  59    */
  60   public function __construct($name, $timeout = NULL, $serverWideLock = FALSE) {
  61     $config = CRM_Core_Config::singleton();
  62     $dsnArray = DB::parseDSN($config->dsn);
  63     $database = $dsnArray['database'];
  64     $domainID = CRM_Core_Config::domainID();
  65     if ($serverWideLock) {
  66       $this->_name = $name;
  67     }
  68     else {
  69       $this->_name = $database . '.' . $domainID . '.' . $name;
  70     }
  71     if (defined('CIVICRM_LOCK_DEBUG')) {
  72       CRM_Core_Error::debug_log_message('trying to construct lock for ' . $this->_name);
  73     }
  74     static $jobLog = FALSE;
  75     if ($jobLog && CRM_Core_DAO::singleValueQuery("SELECT IS_USED_LOCK( '{$jobLog}')")) {
  76       return $this->hackyHandleBrokenCode($jobLog);
  77     }
  78     if (stristr($name, 'civimail.job.')) {
  79       $jobLog = $this->_name;
  80     }
  81     $this->_timeout = $timeout !== NULL ? $timeout : self::TIMEOUT;
  82
  83     $this->acquire();
  84   }
  85
  86   public function __destruct() {
  87     $this->release();
  88   }
  89
  90   /**
  91    * @return bool
  92    */
  93   public function acquire() {
  94     if (defined('CIVICRM_LOCK_DEBUG')) {
  95       CRM_Core_Error::debug_log_message('acquire lock for ' . $this->_name);
  96     }
  97     if (!$this->_hasLock) {
  98       $query = "SELECT GET_LOCK( %1, %2 )";
  99       $params = array(
 100         1 => array($this->_name, 'String'),
 101         2 => array($this->_timeout, 'Integer'),
 102       );
 103       $res = CRM_Core_DAO::singleValueQuery($query, $params);
 104       if ($res) {
 105         $this->_hasLock = TRUE;
 106       }
 107     }
 108     return $this->_hasLock;
 109   }
 110
 111   /**
 112    * @return null|string
 113    */
 114   public function release() {
 115     if ($this->_hasLock) {
 116       $this->_hasLock = FALSE;
 117
 118       $query = "SELECT RELEASE_LOCK( %1 )";
 119       $params = array(1 => array($this->_name, 'String'));
 120       return CRM_Core_DAO::singleValueQuery($query, $params);
 121     }
 122   }
 123
 124   /**
 125    * @return null|string
 126    */
 127   public function isFree() {
 128     $query = "SELECT IS_FREE_LOCK( %1 )";
 129     $params = array(1 => array($this->_name, 'String'));
 130     return CRM_Core_DAO::singleValueQuery($query, $params);
 131   }
 132
 133   /**
 134    * @return bool
 135    */
 136   public function isAcquired() {
 137     return $this->_hasLock;
 138   }
 139
 140   /**
 141    * CRM-12856 locks were originally set up for jobs, but the concept was extended to caching & groups without
 142    * understanding that would undermine the job locks (because grabbing a lock implicitly releases existing ones)
 143    * this is all a big hack to mitigate the impact of that - but should not be seen as a fix. Not sure correct fix
 144    * but maybe locks should be used more selectively? Or else we need to handle is some cool way that Tim is yet to write :-)
 145    * if we are running in the context of the cron log then we would rather die (or at least let our process die)
 146    * than release that lock - so if the attempt is being made by setCache or something relatively trivial
 147    * we'll just return TRUE, but if it's another job then we will crash as that seems 'safer'
 148    *
 149    * @param string $jobLog
 150    * @throws CRM_Core_Exception
 151    * @return bool
 152    */
 153   public function hackyHandleBrokenCode($jobLog) {
 154     if (stristr($this->_name, 'job')) {
 155       throw new CRM_Core_Exception('lock aquisition for ' . $this->_name . 'attempted when ' . $jobLog . 'is not released');
 156     }
 157     if (defined('CIVICRM_LOCK_DEBUG')) {
 158       CRM_Core_Error::debug_log_message('(CRM-12856) faking lock for ' . $this->_name);
 159     }
 160     $this->_hasLock = TRUE;
 161     return TRUE;
 162   }
 163
 164 }