includes/GitInfo.php

   1 <?php
   2 /**
   3  * A class to help return information about a git repo MediaWiki may be inside
   4  * This is used by Special:Version and is also useful for the LocalSettings.php
   5  * of anyone working on large branches in git to setup config that show up only
   6  * when specific branches are currently checked out.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 class GitInfo {
  27
  28         /**
  29          * Singleton for the repo at $IP
  30          */
  31         protected static $repo = null;
  32
  33         /**
  34          * Location of the .git directory
  35          */
  36         protected $basedir;
  37
  38         /**
  39          * Map of repo URLs to viewer URLs. Access via static method getViewers().
  40          */
  41         private static $viewers = false;
  42
  43         /**
  44          * @param string $dir The root directory of the repo where the .git dir can be found
  45          */
  46         public function __construct( $dir ) {
  47                 $this->basedir = "{$dir}/.git";
  48                 if ( is_readable( $this->basedir ) && !is_dir( $this->basedir ) ) {
  49                         $GITfile = file_get_contents( $this->basedir );
  50                         if ( strlen( $GITfile ) > 8 && substr( $GITfile, 0, 8 ) === 'gitdir: ' ) {
  51                                 $path = rtrim( substr( $GITfile, 8 ), "\r\n" );
  52                                 $isAbsolute = $path[0] === '/' || substr( $path, 1, 1 ) === ':';
  53                                 $this->basedir = $isAbsolute ? $path : "{$dir}/{$path}";
  54                         }
  55                 }
  56         }
  57
  58         /**
  59          * Return a singleton for the repo at $IP
  60          * @return GitInfo
  61          */
  62         public static function repo() {
  63                 global $IP;
  64                 if ( is_null( self::$repo ) ) {
  65                         self::$repo = new self( $IP );
  66                 }
  67                 return self::$repo;
  68         }
  69
  70         /**
  71          * Check if a string looks like a hex encoded SHA1 hash
  72          *
  73          * @param string $str The string to check
  74          * @return bool Whether or not the string looks like a SHA1
  75          */
  76         public static function isSHA1( $str ) {
  77                 return !!preg_match( '/^[0-9A-F]{40}$/i', $str );
  78         }
  79
  80         /**
  81          * Return the HEAD of the repo (without any opening "ref: ")
  82          * @return string The HEAD
  83          */
  84         public function getHead() {
  85                 $HEADfile = "{$this->basedir}/HEAD";
  86
  87                 if ( !is_readable( $HEADfile ) ) {
  88                         return false;
  89                 }
  90
  91                 $HEAD = file_get_contents( $HEADfile );
  92
  93                 if ( preg_match( "/ref: (.*)/", $HEAD, $m ) ) {
  94                         return rtrim( $m[1] );
  95                 } else {
  96                         return rtrim( $HEAD );
  97                 }
  98         }
  99
 100         /**
 101          * Return the SHA1 for the current HEAD of the repo
 102          * @return string A SHA1 or false
 103          */
 104         public function getHeadSHA1() {
 105                 $HEAD = $this->getHead();
 106
 107                 // If detached HEAD may be a SHA1
 108                 if ( self::isSHA1( $HEAD ) ) {
 109                         return $HEAD;
 110                 }
 111
 112                 // If not a SHA1 it may be a ref:
 113                 $REFfile = "{$this->basedir}/{$HEAD}";
 114                 if ( !is_readable( $REFfile ) ) {
 115                         return false;
 116                 }
 117
 118                 $sha1 = rtrim( file_get_contents( $REFfile ) );
 119
 120                 return $sha1;
 121         }
 122
 123         /**
 124          * Return the commit date of HEAD entry of the git code repository
 125          *
 126          * @since 1.22
 127          * @return int|bool Commit date (UNIX timestamp) or false
 128          */
 129         public function getHeadCommitDate() {
 130                 global $wgGitBin;
 131
 132                 if ( !is_file( $wgGitBin ) || !is_executable( $wgGitBin ) ) {
 133                         return false;
 134                 }
 135
 136                 $environment = array( "GIT_DIR" => $this->basedir );
 137                 $cmd = wfEscapeShellArg( $wgGitBin ) . " show -s --format=format:%ct HEAD";
 138                 $retc = false;
 139                 $commitDate = wfShellExec( $cmd, $retc, $environment );
 140
 141                 if ( $retc !== 0 ) {
 142                         return false;
 143                 } else {
 144                         return (int)$commitDate;
 145                 }
 146
 147          }
 148
 149         /**
 150          * Return the name of the current branch, or HEAD if not found
 151          * @return string The branch name, HEAD, or false
 152          */
 153         public function getCurrentBranch() {
 154                 $HEAD = $this->getHead();
 155                 if ( $HEAD && preg_match( "#^refs/heads/(.*)$#", $HEAD, $m ) ) {
 156                         return $m[1];
 157                 } else {
 158                         return $HEAD;
 159                 }
 160         }
 161
 162         /**
 163          * Get an URL to a web viewer link to the HEAD revision.
 164          *
 165          * @return string|bool string if a URL is available or false otherwise.
 166          */
 167         public function getHeadViewUrl() {
 168                 $config = "{$this->basedir}/config";
 169                 if ( !is_readable( $config ) ) {
 170                         return false;
 171                 }
 172
 173                 $configArray = parse_ini_file( $config, true );
 174                 $remote = false;
 175
 176                 // Use the "origin" remote repo if available or any other repo if not.
 177                 if ( isset( $configArray['remote origin'] ) ) {
 178                         $remote = $configArray['remote origin'];
 179                 } else {
 180                         foreach ( $configArray as $sectionName => $sectionConf ) {
 181                                 if ( substr( $sectionName, 0, 6 ) == 'remote' ) {
 182                                         $remote = $sectionConf;
 183                                 }
 184                         }
 185                 }
 186
 187                 if ( $remote === false || !isset( $remote['url'] ) ) {
 188                         return false;
 189                 }
 190
 191                 $url = $remote['url'];
 192                 if ( substr( $url, -4 ) !== '.git' ) {
 193                         $url .= '.git';
 194                 }
 195                 foreach ( self::getViewers() as $repo => $viewer ) {
 196                         $pattern = '#^' . $repo . '$#';
 197                         if ( preg_match( $pattern, $url, $matches ) ) {
 198                                 $viewerUrl = preg_replace( $pattern, $viewer, $url );
 199                                 $headSHA1 = $this->getHeadSHA1();
 200                                 $replacements = array(
 201                                         '%h' => substr( $headSHA1, 0, 7 ),
 202                                         '%H' => $headSHA1,
 203                                         '%r' => urlencode( $matches[1] ),
 204                                 );
 205                                 return strtr( $viewerUrl, $replacements );
 206                         }
 207                 }
 208                 return false;
 209         }
 210
 211         /**
 212          * @see self::getHeadSHA1
 213          * @return string
 214          */
 215         public static function headSHA1() {
 216                 return self::repo()->getHeadSHA1();
 217         }
 218
 219         /**
 220          * @see self::getCurrentBranch
 221          * @return string
 222          */
 223         public static function currentBranch() {
 224                 return self::repo()->getCurrentBranch();
 225         }
 226
 227         /**
 228          * @see self::getHeadViewUrl()
 229          * @return bool|string
 230          */
 231         public static function headViewUrl() {
 232                 return self::repo()->getHeadViewUrl();
 233         }
 234
 235         /**
 236          * Gets the list of repository viewers
 237          * @return array
 238          */
 239         protected static function getViewers() {
 240                 global $wgGitRepositoryViewers;
 241
 242                 if ( self::$viewers === false ) {
 243                         self::$viewers = $wgGitRepositoryViewers;
 244                         wfRunHooks( 'GitViewers', array( &self::$viewers ) );
 245                 }
 246
 247                 return self::$viewers;
 248         }
 249 }