Clean up git object docblocks
[gitphp.git] / include / git / GitExe.class.php
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<?php
 
/**
 * git cat-file constant
 */
define('GIT_CAT_FILE','cat-file');
 
/**
 * git diff-tree constant
 */
define('GIT_DIFF_TREE','diff-tree');
 
/**
 * git ls-tree constant
 */
define('GIT_LS_TREE','ls-tree');
 
/**
 * git rev-list constant
 */
define('GIT_REV_LIST','rev-list');
 
/**
 * git rev-parse constant
 */
define('GIT_REV_PARSE','rev-parse');
 
/**
 * git show-ref constant
 */
define('GIT_SHOW_REF','show-ref');
 
/**
 * git archive constant
 */
define('GIT_ARCHIVE','archive');
 
/**
 * git grep constant
 */
define('GIT_GREP','grep');
 
/**
 * git blame constant
 */
define('GIT_BLAME','blame');
 
/**
 * git name-rev constant
 */
define('GIT_NAME_REV','name-rev');
 
/**
 * git for-each-ref constant
 */
define('GIT_FOR_EACH_REF','for-each-ref');
 
/**
 * git config constant
 */
define('GIT_CONFIG','config');
 
/**
 * Class to wrap git executable
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_GitExe
{
 
        /**
         * The singleton instance
         *
         * @var GitPHP_GitExe
         */
        protected static $instance;
 
        /**
         * The binary path
         *
         * @var string
         */
        protected $binary;
        
        /**
         * The binary version
         *
         * @var string
         */
        protected $version;
 
        /**
         * Whether the version has been read
         *
         * @var boolean
         */
        protected $versionRead = false;
 
        /**
         * Returns the singleton instance
         *
         * @return GitPHP_GitExe instance of git exe classe
         */
        public static function GetInstance()
        {
                if (!self::$instance) {
                        self::$instance = new GitPHP_GitExe(GitPHP_Config::GetInstance()->GetValue('gitbin'));
                }
                return self::$instance;
        }
 
        /**
         * Releases the singleton instance
         */
        public static function DestroyInstance()
        {
                self::$instance = null;
        }
 
        /**
         * Constructor
         *
         * @param string $binary path to git binary
         */
        protected function __construct($binary)
        {
                if (empty($binary)) {
                        $binary = GitPHP_GitExe::DefaultBinary();
                }
                $this->binary = $binary;
        }
 
        /**
         * Executes a command
         *
         * @param string $projectPath path to project
         * @param string $command the command to execute
         * @param string[] $args arguments
         * @return string result of command
         */
        public function Execute($projectPath, $command, $args)
        {
                $fullCommand = $this->CreateCommand($projectPath, $command, $args);
 
                GitPHP_DebugLog::GetInstance()->Log('Begin executing "' . $fullCommand . '"');
 
                $ret = shell_exec($fullCommand);
 
                GitPHP_DebugLog::GetInstance()->Log('Finish executing "' . $fullCommand . '"' .
                        "\nwith result: " . $ret);
 
                return $ret;
        }
 
        /**
         * Opens a resource to a command
         *
         * @param string $projectPath path to project
         * @param string $command the command to execute
         * @param string[] $args arguments
         * @param string $mode process open mode
         * @return resource process handle
         */
        public function Open($projectPath, $command, $args, $mode = 'r')
        {
                $fullCommand = $this->CreateCommand($projectPath, $command, $args);
 
                return popen($fullCommand, $mode);
        }
 
        /**
         * Creates a command
         *
         * @param string $projectPath path to project
         * @param string $command the command to execute
         * @param string[] $args arguments
         * @return string full executable string
         */
        protected function CreateCommand($projectPath, $command, $args)
        {
                $gitDir = '';
                if (!empty($projectPath)) {
                        $gitDir = '--git-dir=' . $projectPath;
                }
                
                return $this->binary . ' ' . $gitDir . ' ' . $command . ' ' . implode(' ', $args);
        }
 
        /**
         * Gets the binary for this executable
         *
         * @return string binary
         */
        public function GetBinary()
        {
                return $this->binary;
        }
 
        /**
         * Gets the version of the git binary
         *
         * @return string version
         */
        public function GetVersion()
        {
                if (!$this->versionRead)
                        $this->ReadVersion();
 
                return $this->version;
        }
 
        /**
         * Reads the git version
         */
        protected function ReadVersion()
        {
                $this->versionRead = true;
 
                $this->version = '';
 
                $versionCommand = $this->binary . ' --version';
                $ret = trim(shell_exec($versionCommand));
                if (preg_match('/^git version ([0-9\.]+)$/i', $ret, $regs)) {
                        $this->version = $regs[1];
                }
        }
 
        /**
         * Tests if this version of git can skip through the revision list
         *
         * @return boolean true if we can skip
         */
        public function CanSkip()
        {
                $version = $this->GetVersion();
                if (!empty($version)) {
                        $splitver = explode('.', $version);
 
                        /* Skip only appears in git >= 1.5.0 */
                        if (($splitver[0] < 1) || (($splitver[0] == 1) && ($splitver[1] < 5))) {
                                return false;
                        }
                }
 
                return true;
        }
 
        /**
         * Tests if this version of git can show the size of a blob when listing a tree
         *
         * @return true if we can show sizes
         */
        public function CanShowSizeInTree()
        {
                $version = $this->GetVersion();
                if (!empty($version)) {
                        $splitver = explode('.', $version);
 
                        /*
                         * ls-tree -l only appears in git 1.5.3
                         * (technically 1.5.3-rc0 but i'm not getting that fancy)
                         */
                        if (($splitver[0] < 1) || (($splitver[0] == 1) && ($splitver[1] < 5)) || (($splitver[0] == 1) && ($splitver[1] == 5) && ($splitver[2] < 3))) {
                                return false;
                        }
                }
 
                return true;
 
        }
 
        /**
         * Tests if this version of git has the regexp tuning option to ignore regexp case
         *
         * @return true if we can ignore regexp case
         */
        public function CanIgnoreRegexpCase()
        {
                $version = $this->GetVersion();
                if (!empty($version)) {
                        $splitver = explode('.', $version);
 
                        /*
                         * regexp-ignore-case only appears in git 1.5.3
                         */
                        if (($splitver[0] < 1) || (($splitver[0] == 1) && ($splitver[1] < 5)) || (($splitver[0] == 1) && ($splitver[1] == 5) && ($splitver[2] < 3))) {
                                return false;
                        }
                }
 
                return true;
        }
 
        /**
         * Tests if this executable is valid
         *
         * @return boolean true if valid
         */
        public function Valid()
        {
                if (empty($this->binary))
                        return false;
 
                $code = 0;
                $out = exec($this->binary . ' --version', $tmp, $code);
 
                return $code == 0;
        }
 
        /**
         * Gets the default binary for the platform
         *
         * @return string binary
         */
        public static function DefaultBinary()
        {
                if (GitPHP_Util::IsWindows()) {
                        // windows
 
                        if (GitPHP_Util::Is64Bit()) {
                                // match x86_64 and x64 (64 bit)
                                // C:\Program Files (x86)\Git\bin\git.exe
                                return 'C:\\Progra~2\\Git\\bin\\git.exe';
                        } else {
                                // 32 bit
                                // C:\Program Files\Git\bin\git.exe
                                return 'C:\\Progra~1\\Git\\bin\\git.exe';
                        }
                } else {
                        // *nix, just use PATH
                        return 'git';
                }
        }
 
}
 
comments