Merge pull request #11 from bessl/patch-2
[gitphp.git] / include / controller / Controller_Snapshot.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
<?php
/**
 * Controller for getting a snapshot
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Controller
 */
class GitPHP_Controller_Snapshot extends GitPHP_ControllerBase
{
 
        /**
         * Stores the archive object
         *
         * @var GitPHP_Archive
         */
        private $archive = null;
 
        /**
         * Snapshot cache directory
         *
         * @var string
         */
        private $cacheDir = null;
 
        /**
         * Snapshot cached file path
         *
         * @var string
         */
        private $cachedFile;
 
        /**
         * Initialize controller
         */
        public function Initialize()
        {
                $this->InitializeConfig();
 
                $this->InitializeUserList();
 
                $this->InitializeGitExe();
 
                $this->InitializeProjectList();
 
                // HACK: this needs to be done early because the snapshot controller modifies the headers before opening the archive
                if (!GitPHP_Util::FunctionAllowed('popen'))
                        throw new GitPHP_DisabledFunctionException('popen');
 
                if (isset($this->params['project'])) {
                        $project = $this->projectList->GetProject($this->params['project']);
                        if (!$project) {
                                throw new GitPHP_InvalidProjectParameterException($this->params['project']);
                        }
                        if ($this->userList && ($this->userList->GetCount() > 0)) {
                                if (!$project->UserCanAccess((!empty($_SESSION['gitphpuser']) ? $_SESSION['gitphpuser'] : null))) {
                                        throw new GitPHP_UnauthorizedProjectException($this->params['project']);
                                }
                        }
                        $this->project = $project->GetProject();
                }
 
                if (!$this->project) {
                        throw new GitPHP_MissingProjectParameterException();
                }
 
                $this->preserveWhitespace = true;
 
                if (empty($this->params['format']))
                        $this->params['format'] = $this->config->GetValue('compressformat');
 
                $this->InitializeArchive();
 
                if ($this->config->GetValue('cache')) {
 
                        $this->cacheDir = GITPHP_CACHEDIR . 'snapshots/';
 
                        if (file_exists($this->cacheDir)) {
                                if (!is_dir($this->cacheDir)) {
                                        throw new Exception($this->cacheDir . ' exists but is not a directory');
                                } else if (!is_writable($this->cacheDir)) {
                                        throw new Exception($this->cacheDir . ' is not writable');
                                }
                        } else {
                                if (!mkdir($this->cacheDir, 0777))
                                        throw new Exception($this->cacheDir . ' could not be created');
                                chmod($this->cacheDir, 0777);
                        }
                }
        }
 
        /**
         * Gets the template for this controller
         *
         * @return string template filename
         */
        protected function GetTemplate()
        {
        }
 
        /**
         * Gets the cache key for this controller
         *
         * @return string cache key
         */
        protected function GetCacheKey()
        {
                return (isset($this->params['hash']) ? $this->params['hash'] : '') . '|' . (isset($this->params['file']) ? $this->params['file'] : '') . '|' . (isset($this->params['prefix']) ? $this->params['prefix'] : '') . '|' . $this->params['format'];
        }
 
        /**
         * Gets the name of this controller's action
         *
         * @param boolean $local true if caller wants the localized action name
         * @return string action name
         */
        public function GetName($local = false)
        {
                if ($local && $this->resource) {
                        return $this->resource->translate('snapshot');
                }
                return 'snapshot';
        }
 
        /**
         * Loads headers for this template
         */
        protected function LoadHeaders()
        {
                $mimetype = $this->archive->GetMimeType();
                if (!empty($mimetype))
                        $this->headers[] = 'Content-Type: ' . $mimetype;
 
                $this->headers[] = 'Content-Disposition: attachment; filename=' . $this->archive->GetFilename();
 
                if ($this->config->GetValue('cache')) {
                        $cachedfile = $this->cacheDir . $this->CachedSnapshotFile();
                        if (is_readable($cachedfile)) {
                                $size = filesize($cachedfile);
                                if ($size !== false)
                                        $this->headers[] = 'Content-Length: ' . $size;
                        }
                }
        }
 
        /**
         * Loads data for this template
         */
        protected function LoadData()
        {
        }
 
        /**
         * Render this controller
         */
        public function Render()
        {
                $cache = $this->config->GetValue('cache');
                $cachedfile = null;
 
                if ($cache) {
                        $cachedfile = $this->CachedSnapshotFile();
                        $cachedfilepath = $this->cacheDir . $cachedfile;
                        if (is_readable($cachedfilepath)) {
                                $cachehandle = fopen($cachedfilepath, 'rb');
                                if ($cachehandle) {
                                        while (!feof($cachehandle)) {
                                                print fread($cachehandle, 1048576);
                                                flush();
                                        }
                                        fclose($cachehandle);
                                        return;
                                }
                        }
                }
 
                if ($this->archive->Open()) {
 
                        $tmpcachefile = null;
                        $cachehandle = null;
 
                        if ($cache && !empty($cachedfile)) {
                                // write cached file too
                                $pid = 0;
                                if (function_exists('posix_getpid'))
                                        $pid = posix_getpid();
                                else
                                        $pid = rand();
 
                                $tmpcachefile = 'tmp-' . $pid . '-' . $cachedfile;
                                $cachehandle = fopen($this->cacheDir . $tmpcachefile, 'wb');
                        }
 
                        while (($data = $this->archive->Read()) !== false) {
 
                                print $data;
                                flush();
 
                                if ($cache && $cachehandle) {
                                        fwrite($cachehandle, $data);
                                }
 
                        }
 
                        $this->archive->Close();
 
                        if ($cachehandle) {
                                fclose($cachehandle);
                                sleep(1);
                                rename($this->cacheDir . $tmpcachefile, $this->cacheDir . $cachedfile);
                        }
                }
        }
 
        /**
         * Initialize archive for reading
         */
        private function InitializeArchive()
        {
                $strategy = null;
                if ($this->params['format'] == GITPHP_COMPRESS_TAR) {
                        $strategy = new GitPHP_Archive_Tar();
                } else if ($this->params['format'] == GITPHP_COMPRESS_BZ2) {
                        $strategy = new GitPHP_Archive_Bzip2($this->config->GetValue('compresslevel'));
                        if (!$strategy->Valid())
                                $strategy = new GitPHP_Archive_Tar();
                } else if ($this->params['format'] == GITPHP_COMPRESS_GZ) {
                        $strategy = new GitPHP_Archive_Gzip($this->config->GetValue('compresslevel'));
                        if (!$strategy->Valid())
                                $strategy = new GitPHP_Archive_Tar();
                } else if ($this->params['format'] == GITPHP_COMPRESS_ZIP) {
                        $strategy = new GitPHP_Archive_Zip($this->config->GetValue('compresslevel'));
                        if (!$strategy->Valid())
                                $strategy = new GitPHP_Archive_Tar();
                }
                $strategy->SetExe($this->exe);
 
                $this->archive = new GitPHP_Archive($this->GetProject(), null, $strategy, (isset($this->params['file']) ? $this->params['file'] : ''), (isset($this->params['prefix']) ? $this->params['prefix'] : ''));
                $commit = null;
 
                if (!isset($this->params['hash']))
                        $commit = $this->GetProject()->GetHeadCommit();
                else
                        $commit = $this->GetProject()->GetCommit($this->params['hash']);
 
                $this->archive->SetObject($commit);
        }
 
        /**
         * Gets the cached snapshot file name
         *
         * @return string cached file name
         */
        private function CachedSnapshotFile()
        {
                $key = ($this->archive->GetObject() ? $this->archive->GetObject()->GetHash() : '') . '|' . (isset($this->params['file']) ? $this->params['file'] : '') . '|' . (isset($this->params['prefix']) ? $this->params['prefix'] : '');
                $cachefile = sha1($key) . '-' . $this->archive->GetFilename();
                return $cachefile;
        }
 
}
 
comments