Load tree data from pack
[gitphp.git] / include / git / Tree.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
340
341
342
343
344
345
346
347
348
349
350
351
352
<?php
/**
 * GitPHP Tree
 *
 * Represents a single tree
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_GITOBJECTDIR . 'FilesystemObject.class.php');
require_once(GITPHP_GITOBJECTDIR . 'GitExe.class.php');
 
/**
 * Tree class
 *
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_Tree extends GitPHP_FilesystemObject
{
 
        /**
         * contents
         *
         * Tree contents
         *
         * @access protected
         */
        protected $contents = array();
 
        /**
         * contentsRead
         *
         * Stores whether contents were read
         *
         * @access protected
         */
        protected $contentsRead = false;
 
        /**
         * contentsReferenced
         *
         * Stores whether contents have been referenced into pointers
         *
         * @access private
         */
        private $contentsReferenced = false;
 
        /**
         * __construct
         *
         * Instantiates object
         *
         * @access public
         * @param mixed $project the project
         * @param string $hash tree hash
         * @return mixed tree object
         * @throws Exception exception on invalid hash
         */
        public function __construct($project, $hash)
        {
                parent::__construct($project, $hash);
        }
 
        /**
         * SetCommit
         *
         * Sets the commit for this tree (overrides base)
         *
         * @access public
         * @param mixed $commit commit object
         */
        public function SetCommit($commit)
        {
                parent::SetCommit($commit);
 
                if ($this->contentsRead && !$this->contentsReferenced) {
                        foreach ($this->contents as $obj) {
                                $obj->SetCommit($commit);
                        }
                }
        }
 
        /**
         * GetContents
         *
         * Gets the tree contents
         *
         * @access public
         * @return array array of objects for contents
         */
        public function GetContents()
        {
                if (!$this->contentsRead)
                        $this->ReadContents();
 
                if ($this->contentsReferenced)
                        $this->DereferenceContents();
 
                return $this->contents;
        }
 
        /**
         * ReadContents
         *
         * Reads the tree contents
         *
         * @access protected
         */
        protected function ReadContents()
        {
                $this->contentsRead = true;
 
                if (GitPHP_Config::GetInstance()->GetValue('compat', false)) {
                        $this->ReadContentsGit();
                } else {
                        $this->ReadContentsRaw();
                }
 
                GitPHP_Cache::GetInstance()->Set($this->GetCacheKey(), $this);
        }
 
        /**
         * ReadContentsGit
         *
         * Reads the tree contents using the git executable
         *
         * @access private
         */
        private function ReadContentsGit()
        {
                $exe = new GitPHP_GitExe($this->GetProject());
 
                $args = array();
                $args[] = '--full-name';
                if ($exe->CanShowSizeInTree())
                        $args[] = '-l';
                $args[] = '-t';
                $args[] = $this->hash;
                
                $lines = explode("\n", $exe->Execute(GIT_LS_TREE, $args));
 
                foreach ($lines as $line) {
                        if (preg_match("/^([0-9]+) (.+) ([0-9a-fA-F]{40})(\s+[0-9]+|\s+-)?\t(.+)$/", $line, $regs)) {
                                switch($regs[2]) {
                                        case 'tree':
                                                $t = $this->GetProject()->GetTree($regs[3]);
                                                $t->SetMode($regs[1]);
                                                $path = $regs[5];
                                                if (!empty($this->path))
                                                        $path = $this->path . '/' . $path;
                                                $t->SetPath($path);
                                                if ($this->commit)
                                                        $t->SetCommit($this->commit);
                                                $this->contents[] = $t;
                                                break;
                                        case 'blob':
                                                $b = $this->GetProject()->GetBlob($regs[3]);
                                                $b->SetMode($regs[1]);
                                                $path = $regs[5];
                                                if (!empty($this->path))
                                                        $path = $this->path . '/' . $path;
                                                $b->SetPath($path);
                                                $size = trim($regs[4]);
                                                if (!empty($size))
                                                        $b->SetSize($regs[4]);
                                                if ($this->commit)
                                                        $b->SetCommit($this->commit);
                                                $this->contents[] = $b;
                                                break;
                                }
                        }
                }
 
        }
 
        /**
         * ReadContentsRaw
         *
         * Reads the tree contents using the raw git object
         *
         * @access private
         */
        private function ReadContentsRaw()
        {
                $treeData = $this->GetProject()->GetObject($this->hash);
 
                $start = 0;
                $len = strlen($treeData);
                while ($start < $len) {
                        $pos = strpos($treeData, "\0", $start);
 
                        list($mode, $path) = explode(' ', substr($treeData, $start, $pos-$start), 2);
                        $mode = str_pad($mode, 6, '0', STR_PAD_LEFT);
                        $hash = bin2hex(substr($treeData, $pos+1, 20));
                        $start = $pos + 21;
 
                        $octmode = octdec($mode);
 
                        if ($octmode == 57344) {
                                // submodules not currently supported
                                continue;
                        }
 
                        if (!empty($this->path))
                                $path = $this->path . '/' . $path;
 
                        $obj = null;
                        if ($octmode & 0x4000) {
                                // tree
                                $obj = $this->GetProject()->GetTree($hash);
                        } else {
                                // blob
                                $obj = $this->GetProject()->GetBlob($hash);
                        }
 
                        if (!$obj) {
                                continue;
                        }
 
                        $obj->SetMode($mode);
                        $obj->SetPath($path);
                        if ($this->commit)
                                $obj->SetCommit($this->commit);
                        $this->contents[] = $obj;
                }
        }
 
        /**
         * ReferenceContents
         *
         * Turns the contents objects into reference pointers
         *
         * @access private
         */
        private function ReferenceContents()
        {
                if ($this->contentsReferenced)
                        return;
 
                if (!(isset($this->contents) && (count($this->contents) > 0)))
                        return;
 
                for ($i = 0; $i < count($this->contents); ++$i) {
                        $obj = $this->contents[$i];
                        $data = array();
 
                        $data['hash'] = $obj->GetHash();
                        $data['mode'] = $obj->GetMode();
                        $data['path'] = $obj->GetPath();
 
                        if ($obj instanceof GitPHP_Tree) {
                                $data['type'] = 'tree';
                        } else if ($obj instanceof GitPHP_Blob) {
                                $data['type'] = 'blob';
                                $data['size'] = $obj->GetSize();
                        }
 
                        $this->contents[$i] = $data;
                }
 
                $this->contentsReferenced = true;
        }
 
        /**
         * DereferenceContents
         *
         * Turns the contents pointers back into objects
         *
         * @access private
         */
        private function DereferenceContents()
        {
                if (!$this->contentsReferenced)
                        return;
 
                if (!(isset($this->contents) && (count($this->contents) > 0)))
                        return;
 
                for ($i = 0; $i < count($this->contents); ++$i) {
                        $data = $this->contents[$i];
                        $obj = null;
 
                        if (!isset($data['hash']) || empty($data['hash']))
                                continue;
 
                        if ($data['type'] == 'tree') {
                                $obj = $this->GetProject()->GetTree($data['hash']);
                        } else if ($data['type'] == 'blob') {
                                $obj = $this->GetProject()->GetBlob($data['hash']);
                                if (isset($data['size']) && !empty($data['size']))
                                        $obj->SetSize($data['size']);
                        } else {
                                continue;
                        }
 
                        if (isset($data['mode']) && !empty($data['mode']))
                                $obj->SetMode($data['mode']);
 
                        if (isset($data['path']) && !empty($data['path']))
                                $obj->SetPath($data['path']);
 
                        if ($this->commit)
                                $obj->SetCommit($this->commit);
 
                        $this->contents[$i] = $obj;
                }
 
                $this->contentsReferenced = false;
        }
 
        /**
         * __sleep
         *
         * Called to prepare the object for serialization
         *
         * @access public
         * @return array list of properties to serialize
         */
        public function __sleep()
        {
                if (!$this->contentsReferenced)
                        $this->ReferenceContents();
 
                $properties = array('contents', 'contentsRead', 'contentsReferenced');
                return array_merge($properties, parent::__sleep());
        }
 
        /**
         * GetCacheKey
         *
         * Gets the cache key to use for this object
         *
         * @access public
         * @return string cache key
         */
        public function GetCacheKey()
        {
                $key = parent::GetCacheKey();
                if (!empty($key))
                        $key .= '|';
 
                $key .= 'tree|' . $this->hash;
 
                return $key;
        }
 
}
 
comments