From c1f9b1f7b1b77776192048005dcc66dcf3df2bfb Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sat, 27 Dec 2014 15:41:37 +0100 Subject: Update to MediaWiki 1.24.1 --- includes/GitInfo.php | 323 +++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 237 insertions(+), 86 deletions(-) (limited to 'includes/GitInfo.php') diff --git a/includes/GitInfo.php b/includes/GitInfo.php index f49f9be1..7052820e 100644 --- a/includes/GitInfo.php +++ b/includes/GitInfo.php @@ -35,33 +35,103 @@ class GitInfo { */ protected $basedir; + /** + * Path to JSON cache file for pre-computed git information. + */ + protected $cacheFile; + + /** + * Cached git information. + */ + protected $cache = array(); + /** * Map of repo URLs to viewer URLs. Access via static method getViewers(). */ private static $viewers = false; /** - * @param string $dir The root directory of the repo where the .git dir can be found + * @param string $repoDir The root directory of the repo where .git can be found + * @param bool $usePrecomputed Use precomputed information if available + * @see precomputeValues + */ + public function __construct( $repoDir, $usePrecomputed = true ) { + $this->cacheFile = self::getCacheFilePath( $repoDir ); + wfDebugLog( 'gitinfo', + "Computed cacheFile={$this->cacheFile} for {$repoDir}" + ); + if ( $usePrecomputed && + $this->cacheFile !== null && + is_readable( $this->cacheFile ) + ) { + $this->cache = FormatJson::decode( + file_get_contents( $this->cacheFile ), + true + ); + wfDebugLog( 'gitinfo', "Loaded git data from cache for {$repoDir}" ); + } + + if ( !$this->cacheIsComplete() ) { + wfDebugLog( 'gitinfo', "Cache incomplete for {$repoDir}" ); + $this->basedir = $repoDir . DIRECTORY_SEPARATOR . '.git'; + if ( is_readable( $this->basedir ) && !is_dir( $this->basedir ) ) { + $GITfile = file_get_contents( $this->basedir ); + if ( strlen( $GITfile ) > 8 && + substr( $GITfile, 0, 8 ) === 'gitdir: ' + ) { + $path = rtrim( substr( $GITfile, 8 ), "\r\n" ); + if ( $path[0] === '/' || substr( $path, 1, 1 ) === ':' ) { + // Path from GITfile is absolute + $this->basedir = $path; + } else { + $this->basedir = $repoDir . DIRECTORY_SEPARATOR . $path; + } + } + } + } + } + + /** + * Compute the path to the cache file for a given directory. + * + * @param string $repoDir The root directory of the repo where .git can be found + * @return string Path to GitInfo cache file in $wgGitInfoCacheDirectory or + * null if $wgGitInfoCacheDirectory is false (cache disabled). + * @since 1.24 */ - public function __construct( $dir ) { - $this->basedir = "{$dir}/.git"; - if ( is_readable( $this->basedir ) && !is_dir( $this->basedir ) ) { - $GITfile = file_get_contents( $this->basedir ); - if ( strlen( $GITfile ) > 8 && substr( $GITfile, 0, 8 ) === 'gitdir: ' ) { - $path = rtrim( substr( $GITfile, 8 ), "\r\n" ); - $isAbsolute = $path[0] === '/' || substr( $path, 1, 1 ) === ':'; - $this->basedir = $isAbsolute ? $path : "{$dir}/{$path}"; + protected static function getCacheFilePath( $repoDir ) { + global $IP, $wgGitInfoCacheDirectory; + + if ( $wgGitInfoCacheDirectory ) { + // Convert both $IP and $repoDir to canonical paths to protect against + // $IP having changed between the settings files and runtime. + $realIP = realpath( $IP ); + $repoName = realpath( $repoDir ); + if ( $repoName === false ) { + // Unit tests use fake path names + $repoName = $repoDir; + } + if ( strpos( $repoName, $realIP ) === 0 ) { + // Strip $IP from path + $repoName = substr( $repoName, strlen( $realIP ) ); } + // Transform path to git repo to something we can safely embed in + // a filename + $repoName = strtr( $repoName, DIRECTORY_SEPARATOR, '-' ); + $fileName = 'info' . $repoName . '.json'; + return "{$wgGitInfoCacheDirectory}/{$fileName}"; } + return null; } /** - * Return a singleton for the repo at $IP + * Get the singleton for the repo at $IP + * * @return GitInfo */ public static function repo() { - global $IP; if ( is_null( self::$repo ) ) { + global $IP; self::$repo = new self( $IP ); } return self::$repo; @@ -78,50 +148,56 @@ class GitInfo { } /** - * Return the HEAD of the repo (without any opening "ref: ") - * @return string The HEAD + * Get the HEAD of the repo (without any opening "ref: ") + * + * @return string|bool The HEAD (git reference or SHA1) or false */ public function getHead() { - $HEADfile = "{$this->basedir}/HEAD"; - - if ( !is_readable( $HEADfile ) ) { - return false; - } + if ( !isset( $this->cache['head'] ) ) { + $headFile = "{$this->basedir}/HEAD"; + $head = false; - $HEAD = file_get_contents( $HEADfile ); + if ( is_readable( $headFile ) ) { + $head = file_get_contents( $headFile ); - if ( preg_match( "/ref: (.*)/", $HEAD, $m ) ) { - return rtrim( $m[1] ); - } else { - return rtrim( $HEAD ); + if ( preg_match( "/ref: (.*)/", $head, $m ) ) { + $head = rtrim( $m[1] ); + } else { + $head = rtrim( $head ); + } + } + $this->cache['head'] = $head; } + return $this->cache['head']; } /** - * Return the SHA1 for the current HEAD of the repo - * @return string A SHA1 or false + * Get the SHA1 for the current HEAD of the repo + * + * @return string|bool A SHA1 or false */ public function getHeadSHA1() { - $HEAD = $this->getHead(); - - // If detached HEAD may be a SHA1 - if ( self::isSHA1( $HEAD ) ) { - return $HEAD; - } - - // If not a SHA1 it may be a ref: - $REFfile = "{$this->basedir}/{$HEAD}"; - if ( !is_readable( $REFfile ) ) { - return false; + if ( !isset( $this->cache['headSHA1'] ) ) { + $head = $this->getHead(); + $sha1 = false; + + // If detached HEAD may be a SHA1 + if ( self::isSHA1( $head ) ) { + $sha1 = $head; + } else { + // If not a SHA1 it may be a ref: + $refFile = "{$this->basedir}/{$head}"; + if ( is_readable( $refFile ) ) { + $sha1 = rtrim( file_get_contents( $refFile ) ); + } + } + $this->cache['headSHA1'] = $sha1; } - - $sha1 = rtrim( file_get_contents( $REFfile ) ); - - return $sha1; + return $this->cache['headSHA1']; } /** - * Return the commit date of HEAD entry of the git code repository + * Get the commit date of HEAD entry of the git code repository * * @since 1.22 * @return int|bool Commit date (UNIX timestamp) or false @@ -129,66 +205,54 @@ class GitInfo { public function getHeadCommitDate() { global $wgGitBin; - if ( !is_file( $wgGitBin ) || !is_executable( $wgGitBin ) ) { - return false; - } - - $environment = array( "GIT_DIR" => $this->basedir ); - $cmd = wfEscapeShellArg( $wgGitBin ) . " show -s --format=format:%ct HEAD"; - $retc = false; - $commitDate = wfShellExec( $cmd, $retc, $environment ); - - if ( $retc !== 0 ) { - return false; - } else { - return (int)$commitDate; + if ( !isset( $this->cache['headCommitDate'] ) ) { + $date = false; + if ( is_file( $wgGitBin ) && + is_executable( $wgGitBin ) && + $this->getHead() !== false + ) { + $environment = array( "GIT_DIR" => $this->basedir ); + $cmd = wfEscapeShellArg( $wgGitBin ) . + " show -s --format=format:%ct HEAD"; + $retc = false; + $commitDate = wfShellExec( $cmd, $retc, $environment ); + if ( $retc === 0 ) { + $date = (int)$commitDate; + } + } + $this->cache['headCommitDate'] = $date; } - - } + return $this->cache['headCommitDate']; + } /** - * Return the name of the current branch, or HEAD if not found - * @return string The branch name, HEAD, or false + * Get the name of the current branch, or HEAD if not found + * + * @return string|bool The branch name, HEAD, or false */ public function getCurrentBranch() { - $HEAD = $this->getHead(); - if ( $HEAD && preg_match( "#^refs/heads/(.*)$#", $HEAD, $m ) ) { - return $m[1]; - } else { - return $HEAD; + if ( !isset( $this->cache['branch'] ) ) { + $branch = $this->getHead(); + if ( $branch && + preg_match( "#^refs/heads/(.*)$#", $branch, $m ) + ) { + $branch = $m[1]; + } + $this->cache['branch'] = $branch; } + return $this->cache['branch']; } /** * Get an URL to a web viewer link to the HEAD revision. * - * @return string|bool string if a URL is available or false otherwise. + * @return string|bool String if a URL is available or false otherwise */ public function getHeadViewUrl() { - $config = "{$this->basedir}/config"; - if ( !is_readable( $config ) ) { - return false; - } - - $configArray = parse_ini_file( $config, true ); - $remote = false; - - // Use the "origin" remote repo if available or any other repo if not. - if ( isset( $configArray['remote origin'] ) ) { - $remote = $configArray['remote origin']; - } else { - foreach ( $configArray as $sectionName => $sectionConf ) { - if ( substr( $sectionName, 0, 6 ) == 'remote' ) { - $remote = $sectionConf; - } - } - } - - if ( $remote === false || !isset( $remote['url'] ) ) { + $url = $this->getRemoteUrl(); + if ( $url === false ) { return false; } - - $url = $remote['url']; if ( substr( $url, -4 ) !== '.git' ) { $url .= '.git'; } @@ -208,6 +272,93 @@ class GitInfo { return false; } + /** + * Get the URL of the remote origin. + * @return string|bool String if a URL is available or false otherwise. + */ + protected function getRemoteUrl() { + if ( !isset( $this->cache['remoteURL'] ) ) { + $config = "{$this->basedir}/config"; + $url = false; + if ( is_readable( $config ) ) { + wfSuppressWarnings(); + $configArray = parse_ini_file( $config, true ); + wfRestoreWarnings(); + $remote = false; + + // Use the "origin" remote repo if available or any other repo if not. + if ( isset( $configArray['remote origin'] ) ) { + $remote = $configArray['remote origin']; + } elseif ( is_array( $configArray ) ) { + foreach ( $configArray as $sectionName => $sectionConf ) { + if ( substr( $sectionName, 0, 6 ) == 'remote' ) { + $remote = $sectionConf; + } + } + } + + if ( $remote !== false && isset( $remote['url'] ) ) { + $url = $remote['url']; + } + } + $this->cache['remoteURL'] = $url; + } + return $this->cache['remoteURL']; + } + + /** + * Check to see if the current cache is fully populated. + * + * Note: This method is public only to make unit testing easier. There's + * really no strong reason that anything other than a test should want to + * call this method. + * + * @return bool True if all expected cache keys exist, false otherwise + */ + public function cacheIsComplete() { + return isset( $this->cache['head'] ) && + isset( $this->cache['headSHA1'] ) && + isset( $this->cache['headCommitDate'] ) && + isset( $this->cache['branch'] ) && + isset( $this->cache['remoteURL'] ); + } + + /** + * Precompute and cache git information. + * + * Creates a JSON file in the cache directory associated with this + * GitInfo instance. This cache file will be used by subsequent GitInfo objects referencing + * the same directory to avoid needing to examine the .git directory again. + * + * @since 1.24 + */ + public function precomputeValues() { + if ( $this->cacheFile !== null ) { + // Try to completely populate the cache + $this->getHead(); + $this->getHeadSHA1(); + $this->getHeadCommitDate(); + $this->getCurrentBranch(); + $this->getRemoteUrl(); + + if ( !$this->cacheIsComplete() ) { + wfDebugLog( 'gitinfo', + "Failed to compute GitInfo for \"{$this->basedir}\"" + ); + return; + } + + $cacheDir = dirname( $this->cacheFile ); + if ( !file_exists( $cacheDir ) && + !wfMkdirParents( $cacheDir, null, __METHOD__ ) + ) { + throw new MWException( "Unable to create GitInfo cache \"{$cacheDir}\"" ); + } + + file_put_contents( $this->cacheFile, FormatJson::encode( $this->cache ) ); + } + } + /** * @see self::getHeadSHA1 * @return string -- cgit v1.2.2