/
item.php
525 lines (475 loc) · 15.6 KB
/
item.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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2009 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
class Item_Model extends ORM_MPTT {
protected $children = 'items';
private $view_restrictions = null;
protected $sorting = array();
var $rules = array(
"name" => "required|length[0,255]",
"title" => "required|length[0,255]",
"description" => "length[0,65535]"
);
/**
* Add a set of restrictions to any following queries to restrict access only to items
* viewable by the active user.
* @chainable
*/
public function viewable() {
if (is_null($this->view_restrictions)) {
if (user::active()->admin) {
$this->view_restrictions = array();
} else {
$this->view_restrictions["owner_id"] = user::active()->id;
foreach (user::group_ids() as $id) {
$this->view_restrictions["view_$id"] = access::ALLOW;
}
}
}
if (!empty($this->view_restrictions)) {
$this->open_paren();
$this->orwhere($this->view_restrictions);
$this->close_paren();
}
return $this;
}
/**
* Is this item an album?
* @return true if it's an album
*/
public function is_album() {
return $this->type == 'album';
}
/**
* Is this item a photo?
* @return true if it's a photo
*/
public function is_photo() {
return $this->type == 'photo';
}
/**
* Is this item a movie?
* @return true if it's a movie
*/
public function is_movie() {
return $this->type == 'movie';
}
public function delete() {
$old = clone $this;
module::event("item_before_delete", $this);
$parent = $this->parent();
if ($parent->album_cover_item_id == $this->id) {
item::remove_album_cover($parent);
}
$path = $this->file_path();
$resize_path = $this->resize_path();
$thumb_path = $this->thumb_path();
parent::delete();
if (is_dir($path)) {
@dir::unlink($path);
@dir::unlink(dirname($resize_path));
@dir::unlink(dirname($thumb_path));
} else {
@unlink($path);
@unlink($resize_path);
@unlink($thumb_path);
}
module::event("item_deleted", $old);
}
/**
* Move this item to the specified target.
* @chainable
* @param Item_Model $target Target item (must be an album)
* @return ORM_MPTT
*/
function move_to($target) {
if (!$target->is_album()) {
throw new Exception("@todo INVALID_MOVE_TYPE $target->type");
}
if ($this->id == 1) {
throw new Exception("@todo INVALID_SOURCE root album");
}
$original_path = $this->file_path();
$original_resize_path = $this->resize_path();
$original_thumb_path = $this->thumb_path();
$original_parent = $this->parent();
parent::move_to($target, true);
model_cache::clear();
$this->relative_path_cache = null;
rename($original_path, $this->file_path());
if ($this->is_album()) {
@rename(dirname($original_resize_path), dirname($this->resize_path()));
@rename(dirname($original_thumb_path), dirname($this->thumb_path()));
Database::instance()
->update("items",
array("relative_path_cache" => null),
array("left_ptr >" => $this->left_ptr, "right_ptr <" => $this->right_ptr));
} else {
@rename($original_resize_path, $this->resize_path());
@rename($original_thumb_path, $this->thumb_path());
}
module::event("item_moved", $this, $original_parent);
return $this;
}
/**
* Rename the underlying file for this item to a new name. Move all the files. This requires a
* save.
*
* @chainable
*/
public function rename($new_name) {
if ($new_name == $this->name) {
return;
}
if (strpos($new_name, "/")) {
throw new Exception("@todo NAME_CANNOT_CONTAIN_SLASH");
}
$old_relative_path = $this->relative_path();
$new_relative_path = dirname($old_relative_path) . "/" . $new_name;
@rename(VARPATH . "albums/$old_relative_path", VARPATH . "albums/$new_relative_path");
@rename(VARPATH . "resizes/$old_relative_path", VARPATH . "resizes/$new_relative_path");
@rename(VARPATH . "thumbs/$old_relative_path", VARPATH . "thumbs/$new_relative_path");
$this->name = $new_name;
if ($this->is_album()) {
Database::instance()
->update("items",
array("relative_path_cache" => null),
array("left_ptr >" => $this->left_ptr, "right_ptr <" => $this->right_ptr));
}
return $this;
}
/**
* album: url::site("albums/2")
* photo: url::site("photos/3")
*
* @param string $query the query string (eg "show=3")
*/
public function url($query=array(), $full_uri=false) {
$url = ($full_uri ? url::abs_site("{$this->type}s/$this->id")
: url::site("{$this->type}s/$this->id"));
if ($query) {
$url .= "?$query";
}
return $url;
}
/**
* album: /var/albums/album1/album2
* photo: /var/albums/album1/album2/photo.jpg
*/
public function file_path() {
return VARPATH . "albums/" . $this->relative_path();
}
/**
* album: http://example.com/gallery3/var/resizes/album1/
* photo: http://example.com/gallery3/var/albums/album1/photo.jpg
*/
public function file_url($full_uri=false) {
return $full_uri ?
url::abs_file("var/albums/" . $this->relative_path()) :
url::file("var/albums/" . $this->relative_path());
}
/**
* album: /var/resizes/album1/.thumb.jpg
* photo: /var/albums/album1/photo.thumb.jpg
*/
public function thumb_path() {
$base = VARPATH . "thumbs/" . $this->relative_path();
if ($this->is_photo()) {
return $base;
} else if ($this->is_album()) {
return $base . "/.album.jpg";
} else if ($this->is_movie()) {
// Replace the extension with jpg
return preg_replace("/...$/", "jpg", $base);
}
}
/**
* Return true if there is a thumbnail for this item.
*/
public function has_thumb() {
return $this->thumb_width && $this->thumb_height;
}
/**
* album: http://example.com/gallery3/var/resizes/album1/.thumb.jpg
* photo: http://example.com/gallery3/var/albums/album1/photo.thumb.jpg
*/
public function thumb_url($full_uri=false) {
$cache_buster = "?m=" . $this->updated;
$base = ($full_uri ?
url::abs_file("var/thumbs/" . $this->relative_path()) :
url::file("var/thumbs/" . $this->relative_path()));
if ($this->is_photo()) {
return $base . $cache_buster;
} else if ($this->is_album()) {
return $base . "/.album.jpg" . $cache_buster;
} else if ($this->is_movie()) {
// Replace the extension with jpg
$base = preg_replace("/...$/", "jpg", $base);
return $base . $cache_buster;
}
}
/**
* album: /var/resizes/album1/.resize.jpg
* photo: /var/albums/album1/photo.resize.jpg
*/
public function resize_path() {
return VARPATH . "resizes/" . $this->relative_path() .
($this->is_album() ? "/.album.jpg" : "");
}
/**
* album: http://example.com/gallery3/var/resizes/album1/.resize.jpg
* photo: http://example.com/gallery3/var/albums/album1/photo.resize.jpg
*/
public function resize_url($full_uri=false) {
return ($full_uri ?
url::abs_file("var/resizes/" . $this->relative_path()) :
url::file("var/resizes/" . $this->relative_path())) .
($this->is_album() ? "/.album.jpg" : "");
}
/**
* Return the relative path to this item's file.
* @return string
*/
public function relative_path() {
if (!$this->loaded) {
return;
}
if (!isset($this->relative_path_cache)) {
$paths = array();
foreach (Database::instance()
->select("name")
->from("items")
->where("left_ptr <=", $this->left_ptr)
->where("right_ptr >=", $this->right_ptr)
->where("id <>", 1)
->orderby("left_ptr", "ASC")
->get() as $row) {
$paths[] = $row->name;
}
$this->relative_path_cache = implode($paths, "/");
$this->save();
}
return $this->relative_path_cache;
}
/**
* @see ORM::__get()
*/
public function __get($column) {
if ($column == "owner") {
// This relationship depends on an outside module, which may not be present so handle
// failures gracefully.
try {
return model_cache::get("user", $this->owner_id);
} catch (Exception $e) {
return null;
}
} else {
return parent::__get($column);
}
}
/**
* @see ORM::__set()
*/
public function __set($column, $value) {
if ($column == "name") {
// Clear the relative path as it is no longer valid.
$this->relative_path_cache = null;
}
parent::__set($column, $value);
}
/**
* @see ORM::save()
*/
public function save() {
if (!empty($this->changed) && $this->changed != array("view_count" => "view_count")) {
$this->updated = time();
if (!$this->loaded) {
$this->created = $this->updated;
$r = ORM::factory("item")->select("MAX(weight) as max_weight")->find();
$this->weight = $r->max_weight + 1;
} else {
$send_event = 1;
}
}
parent::save();
if (isset($send_event)) {
module::event("item_updated", $this);
}
return $this;
}
/**
* Return the Item_Model representing the cover for this album.
* @return Item_Model or null if there's no cover
*/
public function album_cover() {
if (!$this->is_album()) {
return null;
}
if (empty($this->album_cover_item_id)) {
return null;
}
try {
return model_cache::get("item", $this->album_cover_item_id);
} catch (Exception $e) {
// It's possible (unlikely) that the item was deleted, if so keep going.
return null;
}
}
/**
* Find the position of the given child id in this album. The resulting value is 1-indexed, so
* the first child in the album is at position 1.
*/
public function get_position($child_id) {
if ($this->sort_order == "DESC") {
$comp = ">";
} else {
$comp = "<";
}
$db = Database::instance();
$position = $db->query("
SELECT COUNT(*) AS position FROM {items}
WHERE parent_id = {$this->id}
AND `{$this->sort_column}` $comp (SELECT `{$this->sort_column}`
FROM {items} WHERE id = $child_id)
ORDER BY `{$this->sort_column}` {$this->sort_order}")->current()->position;
// We stopped short of our target value in the sort (notice that we're using a < comparator
// above) because it's possible that we have duplicate values in the sort column. An
// equality check would just arbitrarily pick one of those multiple possible equivalent
// columns, which would mean that if you choose a sort order that has duplicates, it'd pick
// any one of them as the child's "position".
//
// Fix this by doing a 2nd query where we iterate over the equivalent columns and add them to
// our base value.
$result = $db->query("
SELECT id FROM {items}
WHERE parent_id = {$this->id}
AND `{$this->sort_column}` = (SELECT `{$this->sort_column}`
FROM {items} WHERE id = $child_id)");
foreach ($result as $row) {
$position++;
if ($row->id == $child_id) {
break;
}
}
return $position;
}
/**
* Return an <img> tag for the thumbnail.
* @param array $extra_attrs Extra attributes to add to the img tag
* @param int (optional) $max Maximum size of the thumbnail (default: null)
* @param boolean (optional) $center_vertically Center vertically (default: false)
* @return string
*/
public function thumb_img($extra_attrs=array(), $max=null, $center_vertically=false) {
list ($height, $width) = $this->scale_dimensions($max);
if ($center_vertically && $max) {
// The constant is divide by 2 to calculate the file and 10 to convert to em
$margin_top = ($max - $height) / 20;
$extra_attrs["style"] = "margin-top: {$margin_top}em";
$extra_attrs["title"] = $this->title;
}
$attrs = array_merge($extra_attrs,
array(
"src" => $this->thumb_url(),
"alt" => $this->title,
"width" => $width,
"height" => $height)
);
// html::image forces an absolute url which we don't want
return "<img" . html::attributes($attrs) . "/>";
}
/**
* Calculate the largest width/height that fits inside the given maximum, while preserving the
* aspect ratio.
* @param int $max Maximum size of the largest dimension
* @return array
*/
public function scale_dimensions($max) {
$width = $this->thumb_width;
$height = $this->thumb_height;
if ($height) {
if (isset($max)) {
if ($width > $height) {
$height = (int)($max * ($height / $width));
$width = $max;
} else {
$width = (int)($max * ($width / $height));
$height = $max;
}
}
} else {
// Missing thumbnail, can happen on albums with no photos yet.
// @todo we should enforce a placeholder for those albums.
$width = 0;
$height = 0;
}
return array($height, $width);
}
/**
* Return an <img> tag for the resize.
* @param array $extra_attrs Extra attributes to add to the img tag
* @return string
*/
public function resize_img($extra_attrs) {
$attrs = array_merge($extra_attrs,
array("src" => $this->resize_url(),
"alt" => $this->title,
"width" => $this->resize_width,
"height" => $this->resize_height)
);
// html::image forces an absolute url which we don't want
return "<img" . html::attributes($attrs) . "/>";
}
/**
* Return a flowplayer <script> tag for movies
* @param array $extra_attrs
* @return string
*/
public function movie_img($extra_attrs) {
$v = new View("movieplayer.html");
$v->attrs = array_merge($extra_attrs,
array("style" => "display:block;width:{$this->width}px;height:{$this->height}px"));
if (empty($v->attrs["id"])) {
$v->attrs["id"] = "gMovieId-{$this->id}";
}
return $v;
}
/**
* Return all of the children of this node, ordered by the defined sort order.
*
* @chainable
* @param integer SQL limit
* @param integer SQL offset
* @return array ORM
*/
function children($limit=null, $offset=0) {
return parent::children($limit, $offset, array($this->sort_column => $this->sort_order));
}
/**
* Return all of the children of the specified type, ordered by the defined sort order.
* @param integer SQL limit
* @param integer SQL offset
* @param string type to return
* @return object ORM_Iterator
*/
function descendants($limit=null, $offset=0, $type=null) {
return parent::descendants($limit, $offset, $type,
array($this->sort_column => $this->sort_order));
}
}