Merge pull request #11 from bessl/patch-2
[gitphp.git] / include / git / blob / Blob.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
<?php
/**
 * Represents a single blob
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 * @subpackage Git\Blob
 */
class GitPHP_Blob extends GitPHP_FilesystemObject implements GitPHP_Observable_Interface, GitPHP_Cacheable_Interface
{
 
        /**
         * Large blob threshold
         *
         * @var int
         */
        const LargeBlobSize = 5242880;  // 5 megs
 
        /**
         * The blob data
         *
         * @var string
         */
        protected $data;
 
        /**
         * Whether data has been read
         *
         * @var boolean
         */
        protected $dataRead = false;
 
        /**
         * The blob size
         *
         * @var int
         */
        protected $size = null;
 
        /**
         * Whether the data is binary
         *
         * @var boolean|null
         */
        protected $binary = null;
 
        /**
         * Whether data has been encoded for serialization
         *
         * @var boolean
         */
        protected $dataEncoded = false;
 
        /**
         * Observers
         *
         * @var array
         */
        protected $observers = array();
 
        /**
         * Data load strategy
         *
         * @var GitPHP_BlobLoadStrategy_Interface
         */
        protected $strategy;
 
        /**
         * Instantiates object
         *
         * @param GitPHP_Project $project the project
         * @param string $hash object hash
         * @param GitPHP_BlobLoadStrategy_Interface $strategy load strategy
         */
        public function __construct($project, $hash, GitPHP_BlobLoadStrategy_Interface $strategy)
        {
                parent::__construct($project, $hash);
 
                if (!$strategy)
                        throw new Exception('Blob load strategy is required');
 
                $this->SetStrategy($strategy);
        }
 
        /**
         * Gets the blob data
         *
         * @param boolean $explode true to explode data into an array of lines
         * @return string|string[] blob data
         */
        public function GetData($explode = false)
        {
                if (!$this->dataRead)
                        $this->ReadData();
 
                if ($this->dataEncoded)
                        $this->DecodeData();
 
                if ($explode)
                        return explode("\n", $this->data);
                else
                        return $this->data;
        }
 
        /**
         * Gets whether data has been loaded
         *
         * @return boolean true if data is loaded
         */
        public function DataLoaded()
        {
                return $this->dataRead;
        }
 
        /**
         * Set the load strategy
         *
         * @param GitPHP_BlobLoadStrategy_Interface $strategy load strategy
         */
        public function SetStrategy(GitPHP_BlobLoadStrategy_Interface $strategy)
        {
                if (!$strategy)
                        return;
 
                $this->strategy = $strategy;
        }
 
        /**
         * Reads the blob data
         */
        private function ReadData()
        {
                $this->dataRead = true;
 
                $this->data = $this->strategy->Load($this);
 
                $this->dataEncoded = false;
 
                $datachanged = false;
 
                if ($this->size === null) {
                        $this->size = strlen($this->data);
                        $datachanged = true;
                }
 
                if ($this->binary === null) {
                        $this->binary = GitPHP_Blob::DataIsBinary($this->data);
                        $datachanged = true;
                }
 
                if ($this->size > GitPHP_Blob::LargeBlobSize) {
                        $this->data = null;
                        $this->dataRead = false;
                } else {
                        $datachanged = true;
                }
 
                if ($datachanged) {
                        foreach ($this->observers as $observer) {
                                $observer->ObjectChanged($this, GitPHP_Observer_Interface::CacheableDataChange);
                        }
                }
        }
 
        /**
         * Gets the blob size
         *
         * @return integer size
         */
        public function GetSize()
        {
                if ($this->size === null) {
                        $this->size = $this->strategy->Size($this);
 
                        foreach ($this->observers as $observer) {
                                $observer->ObjectChanged($this, GitPHP_Observer_Interface::CacheableDataChange);
                        }
                }
                
                return $this->size;
        }
 
        /**
         * Sets the blob size
         *
         * @param integer $size size
         */
        public function SetSize($size)
        {
                $this->size = $size;
        }
 
        /**
         * Tests if this blob is a binary file
         *
         * @return boolean true if binary file
         */
        public function IsBinary()
        {
                if ($this->binary === null) {
                        $this->binary = GitPHP_Blob::DataIsBinary($this->GetData());
 
                        foreach ($this->observers as $observer) {
                                $observer->ObjectChanged($this, GitPHP_Observer_Interface::CacheableDataChange);
                        }
                }
 
                return $this->binary;
        }
 
        /**
         * Encodes data so it can be serialized safely
         */
        private function EncodeData()
        {
                if ($this->dataEncoded)
                        return;
 
                $this->data = base64_encode($this->data);
 
                $this->dataEncoded = true;
        }
 
        /**
         * Decodes data after unserialization
         */
        private function DecodeData()
        {
                if (!$this->dataEncoded)
                        return;
 
                $this->data = base64_decode($this->data);
 
                $this->dataEncoded = false;
        }
 
        /**
         * Add a new observer
         *
         * @param GitPHP_Observer_Interface $observer observer
         */
        public function AddObserver($observer)
        {
                if (!$observer)
                        return;
 
                if (array_search($observer, $this->observers) !== false)
                        return;
 
                $this->observers[] = $observer;
        }
 
        /**
         * Remove an observer
         *
         * @param GitPHP_Observer_Interface $observer observer
         */
        public function RemoveObserver($observer)
        {
                if (!$observer)
                        return;
 
                $key = array_search($observer, $this->observers);
 
                if ($key === false)
                        return;
 
                unset($this->observers[$key]);
        }
 
        /**
         * Called to prepare the object for serialization
         *
         * @return string[] list of properties to serialize
         */
        public function __sleep()
        {
                $properties = array('data', 'dataRead', 'dataEncoded', 'binary', 'size');
 
                if ($this->dataRead && strlen($this->data) > GitPHP_Blob::LargeBlobSize) {
                        $this->data = null;
                        $this->dataRead = false;
                }
                
                if ($this->dataRead && !$this->dataEncoded)
                        $this->EncodeData();
 
                return array_merge($properties, parent::__sleep());
        }
 
        /**
         * Gets the cache key to use for this object
         *
         * @return string cache key
         */
        public function GetCacheKey()
        {
                return GitPHP_Blob::CacheKey($this->project->GetProject(), $this->hash);
        }
 
        /**
         * Generates a blob cache key
         *
         * @param string $proj project
         * @param string $hash hash
         * @return string cache key
         */
        public static function CacheKey($proj, $hash)
        {
                return 'project|' . $proj . '|blob|' . $hash;
        }
 
        /**
         * Determines whether a data buffer is binary
         *
         * @param string $data data buffer
         * @return boolean true if binary
         */
        public static function DataIsBinary($data)
        {
                if (empty($data))
                        return false;
 
                if (strlen($data) > 8000)
                        $data = substr($data, 0, 8000);
 
                return strpos($data, chr(0)) !== false;
        }
 
}
 
comments