diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
commit | 63601400e476c6cf43d985f3e7b9864681695ed4 (patch) | |
tree | f7846203a952e38aaf66989d0a4702779f549962 /includes/GitInfo.php | |
parent | 8ff01378c9e0207f9169b81966a51def645b6a51 (diff) |
Update to MediaWiki 1.20.2
this update includes:
* adjusted Arch Linux skin
* updated FluxBBAuthPlugin
* patch for https://bugzilla.wikimedia.org/show_bug.cgi?id=44024
Diffstat (limited to 'includes/GitInfo.php')
-rw-r--r-- | includes/GitInfo.php | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/includes/GitInfo.php b/includes/GitInfo.php new file mode 100644 index 00000000..c3c30733 --- /dev/null +++ b/includes/GitInfo.php @@ -0,0 +1,214 @@ +<?php +/** + * A class to help return information about a git repo MediaWiki may be inside + * This is used by Special:Version and is also useful for the LocalSettings.php + * of anyone working on large branches in git to setup config that show up only + * when specific branches are currently checked out. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +class GitInfo { + + /** + * Singleton for the repo at $IP + */ + protected static $repo = null; + + /** + * Location of the .git directory + */ + protected $basedir; + + /** + * Map of repo URLs to viewer URLs. Access via static method getViewers(). + */ + private static $viewers = false; + + /** + * @param $dir string The root directory of the repo where the .git dir can be found + */ + public function __construct( $dir ) { + $this->basedir = "{$dir}/.git/"; + } + + /** + * Return a singleton for the repo at $IP + * @return GitInfo + */ + public static function repo() { + global $IP; + if ( is_null( self::$repo ) ) { + self::$repo = new self( $IP ); + } + return self::$repo; + } + + /** + * Check if a string looks like a hex encoded SHA1 hash + * + * @param $str string The string to check + * @return bool Whether or not the string looks like a SHA1 + */ + public static function isSHA1( $str ) { + return !!preg_match( '/^[0-9A-F]{40}$/i', $str ); + } + + /** + * Return the HEAD of the repo (without any opening "ref: ") + * @return string The HEAD + */ + public function getHead() { + $HEADfile = "{$this->basedir}/HEAD"; + + if ( !is_readable( $HEADfile ) ) { + return false; + } + + $HEAD = file_get_contents( $HEADfile ); + + if ( preg_match( "/ref: (.*)/", $HEAD, $m ) ) { + return rtrim( $m[1] ); + } else { + return rtrim( $HEAD ); + } + } + + /** + * Return the SHA1 for the current HEAD of the repo + * @return string 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; + } + + $sha1 = rtrim( file_get_contents( $REFfile ) ); + + return $sha1; + } + + /** + * Return the name of the current branch, or HEAD if not found + * @return string 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; + } + } + + /** + * Get an URL to a web viewer link to the HEAD revision. + * + * @return string|bool string if an 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'] ) ) { + return false; + } + + $url = $remote['url']; + if ( substr( $url, -4 ) !== '.git' ) { + $url .= '.git'; + } + foreach( self::getViewers() as $repo => $viewer ) { + $pattern = '#^' . $repo . '$#'; + if ( preg_match( $pattern, $url ) ) { + $viewerUrl = preg_replace( $pattern, $viewer, $url ); + $headSHA1 = $this->getHeadSHA1(); + $replacements = array( + '%h' => substr( $headSHA1, 0, 7 ), + '%H' => $headSHA1 + ); + return strtr( $viewerUrl, $replacements ); + } + } + return false; + } + + /** + * @see self::getHeadSHA1 + * @return string + */ + public static function headSHA1() { + return self::repo()->getHeadSHA1(); + } + + /** + * @see self::getCurrentBranch + * @return string + */ + public static function currentBranch() { + return self::repo()->getCurrentBranch(); + } + + /** + * @see self::getHeadViewUrl() + * @return bool|string + */ + public static function headViewUrl() { + return self::repo()->getHeadViewUrl(); + } + + /** + * Gets the list of repository viewers + * @return array + */ + protected static function getViewers() { + global $wgGitRepositoryViewers; + + if( self::$viewers === false ) { + self::$viewers = $wgGitRepositoryViewers; + wfRunHooks( 'GitViewers', array( &self::$viewers ) ); + } + + return self::$viewers; + } +} |