LockManager.php

Go to the documentation of this file.

<?php
abstract class LockManager {
        protected $lockTypeMap = array(
                self::LOCK_SH => self::LOCK_SH,
                self::LOCK_UW => self::LOCK_EX, // subclasses may use self::LOCK_SH
                self::LOCK_EX => self::LOCK_EX
        );

        protected $locksHeld = array();

        protected $domain; // string; domain (usually wiki ID)
        protected $lockTTL; // integer; maximum time locks can be held

        /* Lock types; stronger locks have higher values */
        const LOCK_SH = 1; // shared lock (for reads)
        const LOCK_UW = 2; // shared lock (for reads used to write elsewhere)
        const LOCK_EX = 3; // exclusive lock (for writes)

        public function __construct( array $config ) {
                $this->domain = isset( $config['domain'] ) ? $config['domain'] : wfWikiID();
                if ( isset( $config['lockTTL'] ) ) {
                        $this->lockTTL = max( 1, $config['lockTTL'] );
                } elseif ( PHP_SAPI === 'cli' ) {
                        $this->lockTTL = 2*3600;
                } else {
                        $met = ini_get( 'max_execution_time' ); // this is 0 in CLI mode
                        $this->lockTTL = max( 5*60, 2*(int)$met );
                }
        }

        final public function lock( array $paths, $type = self::LOCK_EX ) {
                wfProfileIn( __METHOD__ );
                $status = $this->doLock( array_unique( $paths ), $this->lockTypeMap[$type] );
                wfProfileOut( __METHOD__ );
                return $status;
        }

        final public function unlock( array $paths, $type = self::LOCK_EX ) {
                wfProfileIn( __METHOD__ );
                $status = $this->doUnlock( array_unique( $paths ), $this->lockTypeMap[$type] );
                wfProfileOut( __METHOD__ );
                return $status;
        }

        final protected function sha1Base36Absolute( $path ) {
                return wfBaseConvert( sha1( "{$this->domain}:{$path}" ), 16, 36, 31 );
        }

        final protected function sha1Base16Absolute( $path ) {
                return sha1( "{$this->domain}:{$path}" );
        }

        abstract protected function doLock( array $paths, $type );

        abstract protected function doUnlock( array $paths, $type );
}

class NullLockManager extends LockManager {
        protected function doLock( array $paths, $type ) {
                return Status::newGood();
        }

        protected function doUnlock( array $paths, $type ) {
                return Status::newGood();
        }
}