summaryrefslogtreecommitdiff
path: root/includes/GitInfo.php
blob: 6f7f80200b03f82ad76dced9fb602f07a041bfc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?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 string $dir The root directory of the repo where the .git dir can be found
	 */
	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}";
			}
		}
	}

	/**
	 * 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 string $str 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;
	}
}