Make subtree snapshots using direct tree objects rather than path restrictions
[gitphp.git] / include / git / Archive.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<?php
/**
 * GitPHP Archive
 *
 * Represents an archive (snapshot)
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git
 */
 
require_once(GITPHP_GITOBJECTDIR . 'GitExe.class.php');
require_once(GITPHP_GITOBJECTDIR . 'Commit.class.php');
 
define('GITPHP_COMPRESS_TAR', 'tar');
define('GITPHP_COMPRESS_BZ2', 'tbz2');
define('GITPHP_COMPRESS_GZ', 'tgz');
define('GITPHP_COMPRESS_ZIP', 'zip');
 
/**
 * Archive class
 *
 * @package GitPHP
 * @subpackage Git
 */
class GitPHP_Archive
{
        /**
         * gitObject
         *
         * Stores the object for this archive internally
         *
         * @access protected
         */
        protected $gitObject = null;
 
        /**
         * project
         *
         * Stores the project for this archive internally
         *
         * @access protected
         */
        protected $project = null;
 
        /**
         * format
         *
         * Stores the archive format internally
         *
         * @access protected
         */
        protected $format;
 
        /**
         * fileName
         *
         * Stores the archive filename internally
         *
         * @access protected
         */
        protected $fileName = '';
 
        /**
         * path
         *
         * Stores the archive path internally
         *
         * @access protected
         */
        protected $path = '';
 
        /**
         * prefix
         *
         * Stores the archive prefix internally
         *
         * @access protected
         */
        protected $prefix = '';
 
        /**
         * __construct
         *
         * Instantiates object
         *
         * @access public
         * @param mixed $gitObject the object
         * @param integer $format the format for the archive
         * @return mixed git archive
         */
        public function __construct($project, $gitObject, $format = GITPHP_FORMAT_ZIP, $path = '', $prefix = '')
        {
                $this->SetProject($project);
                $this->SetObject($gitObject);
                $this->SetFormat($format);
                $this->SetPath($path);
                $this->SetPrefix($prefix);
        }
 
        /**
         * GetFormat
         *
         * Gets the archive format
         *
         * @access public
         * @return integer archive format
         */
        public function GetFormat()
        {
                return $this->format;
        }
 
        /**
         * SetFormat
         *
         * Sets the archive format
         *
         * @access public
         * @param integer $format archive format
         */
        public function SetFormat($format)
        {
                if ((($format == GITPHP_COMPRESS_BZ2) && (!function_exists('bzcompress'))) ||
                    (($format == GITPHP_COMPRESS_GZ) && (!function_exists('gzencode')))) {
                    /*
                     * Trying to set a format but doesn't have the appropriate
                     * compression function, fall back to tar
                     */
                    $format = GITPHP_COMPRESS_TAR;
                }
 
                $this->format = $format;
        }
 
        /**
         * GetObject
         *
         * Gets the object for this archive
         *
         * @access public
         * @return mixed the git object
         */
        public function GetObject()
        {
                return $this->gitObject;
        }
 
        /**
         * SetObject
         *
         * Sets the object for this archive
         *
         * @access public
         * @param mixed $object the git object
         */
        public function SetObject($object)
        {
                // Archive only works for commits and trees
                if (($object != null) && (!(($object instanceof GitPHP_Commit) || ($object instanceof GitPHP_Tree)))) {
                        throw new Exception('Invalid source object for archive');
                }
 
                $this->gitObject = $object;
        }
 
        /**
         * GetProject
         *
         * Gets the project for this archive
         *
         * @access public
         * @return mixed the project
         */
        public function GetProject()
        {
                if ($this->project)
                        return $this->project;
 
                if ($this->gitObject)
                        return $this->gitObject->GetProject();
 
                return null;
        }
 
        /**
         * SetProject
         *
         * Sets the project for this archive
         *
         * @access public
         * @param mixed $project the project
         */
        public function SetProject($project)
        {
                $this->project = $project;
        }
 
        /**
         * GetExtension
         *
         * Gets the extension to use for this archive
         *
         * @access public
         * @return string extension for the archive
         */
        public function GetExtension()
        {
                return GitPHP_Archive::FormatToExtension($this->format);
        }
 
        /**
         * GetFilename
         *
         * Gets the filename for this archive
         *
         * @access public
         * @return string filename
         */
        public function GetFilename()
        {
                if (!empty($this->fileName)) {
                        return $this->fileName;
                }
 
                $fname = $this->GetProject()->GetSlug();
 
                $fname .= '.' . $this->GetExtension();
 
                return $fname;
        }
 
        /**
         * SetFilename
         *
         * Sets the filename for this archive
         *
         * @access public
         * @param string $name filename
         */
        public function SetFilename($name = '')
        {
                $this->fileName = $name;
        }
 
        /**
         * GetPath
         *
         * Gets the path to restrict this archive to
         *
         * @access public
         * @return string path
         */
        public function GetPath()
        {
                return $this->path;
        }
 
        /**
         * SetPath
         *
         * Sets the path to restrict this archive to
         *
         * @access public
         * @param string $path path to restrict
         */
        public function SetPath($path = '')
        {
                $this->path = $path;
        }
 
        /**
         * GetPrefix
         *
         * Gets the directory prefix to use for files in this archive
         *
         * @access public
         * @return string prefix
         */
        public function GetPrefix()
        {
                if (!empty($this->prefix)) {
                        return $this->prefix;
                }
 
                return $this->GetProject()->GetSlug() . '/';
        }
 
        /**
         * SetPrefix
         *
         * Sets the directory prefix to use for files in this archive
         *
         * @access public
         * @param string $prefix prefix to use
         */
        public function SetPrefix($prefix = '')
        {
                if (empty($prefix)) {
                        $this->prefix = $prefix;
                        return;
                }
 
                if (substr($prefix, -1) != '/') {
                        $prefix .= '/';
                }
 
                $this->prefix = $prefix;
        }
 
        /**
         * GetHeaders
         *
         * Gets the headers to send to the browser for this file
         *
         * @access public
         * @return array header strings
         */
        public function GetHeaders()
        {
                $headers = array();
 
                switch ($this->format) {
                        case GITPHP_COMPRESS_TAR:
                                $headers[] = 'Content-Type: application/x-tar';
                                break;
                        case GITPHP_COMPRESS_BZ2:
                                $headers[] = 'Content-Type: application/x-bzip2';
                                break;
                        case GITPHP_COMPRESS_GZ:
                                $headers[] = 'Content-Type: application/x-gzip';
                                break;
                        case GITPHP_COMPRESS_ZIP:
                                $headers[] = 'Content-Type: application/x-zip';
                                break;
                        default:
                                throw new Exception('Unknown compression type');
                }
 
                if (count($headers) > 0) {
                        $headers[] = 'Content-Disposition: attachment; filename=' . $this->GetFilename();
                }
 
                return $headers;
        }
 
        /**
         * GetData
         *
         * Gets the archive data
         *
         * @access public
         * @return string archive data
         */
        public function GetData()
        {
                if (!$this->gitObject)
                {
                        throw new Exception('Invalid object for archive');
                }
 
                $exe = new GitPHP_GitExe($this->GetProject());
 
                $args = array();
 
                switch ($this->format) {
                        case GITPHP_COMPRESS_ZIP:
                                $args[] = '--format=zip';
                                break;
                        case GITPHP_COMPRESS_TAR:
                        case GITPHP_COMPRESS_BZ2:
                        case GITPHP_COMPRESS_GZ:
                                $args[] = '--format=tar';
                                break;
                }
 
                $args[] = '--prefix=' . $this->GetPrefix();
                $args[] = $this->gitObject->GetHash();
 
                $data = $exe->Execute(GIT_ARCHIVE, $args);
                unset($exe);
 
                switch ($this->format) {
                        case GITPHP_COMPRESS_BZ2:
                                $data = bzcompress($data, GitPHP_Config::GetInstance()->GetValue('compresslevel', 4));
                                break;
                        case GITPHP_COMPRESS_GZ:
                                $data = gzencode($data, GitPHP_Config::GetInstance()->GetValue('compresslevel', -1));
                                break;
                }
 
                return $data;
        }
 
        /**
         * FormatToExtension
         *
         * Gets the extension to use for a particular format
         *
         * @access public
         * @static
         * @param string $format format to get extension for
         * @return string file extension
         */
        public static function FormatToExtension($format)
        {
                switch ($format) {
                        case GITPHP_COMPRESS_TAR:
                                return 'tar';
                                break;
                        case GITPHP_COMPRESS_BZ2:
                                return 'tar.bz2';
                                break;
                        case GITPHP_COMPRESS_GZ:
                                return 'tar.gz';
                                break;
                        case GITPHP_COMPRESS_ZIP:
                                return 'zip';
                                break;
                }
        }
 
        /**
         * SupportedFormats
         *
         * Gets the supported formats for the archiver
         *
         * @access public
         * @static
         * @return array array of formats mapped to extensions
         */
        public static function SupportedFormats()
        {
                $formats = array();
 
                $formats[GITPHP_COMPRESS_TAR] = GitPHP_Archive::FormatToExtension(GITPHP_COMPRESS_TAR);
                
                // TODO check for git > 1.4.3 for zip
                $formats[GITPHP_COMPRESS_ZIP] = GitPHP_Archive::FormatToExtension(GITPHP_COMPRESS_ZIP);
 
                if (function_exists('bzcompress'))
                        $formats[GITPHP_COMPRESS_BZ2] = GitPHP_Archive::FormatToExtension(GITPHP_COMPRESS_BZ2);
 
                if (function_exists('gzencode'))
                        $formats[GITPHP_COMPRESS_GZ] = GitPHP_Archive::FormatToExtension(GITPHP_COMPRESS_GZ);
 
                return $formats;
        }
 
}
 
comments