Files
gallery3/core/models/item.php
Bharat Mediratta eed57674f9 Add move support. Use the move icon in the quick pane. You can't
move an item into its own hierarchy, or into an album where you don't
have edit permission.
2009-01-24 05:14:44 +00:00

316 lines
8.9 KiB
PHP

<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2008 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 $relative_path = null;
private $view_restrictions = null;
var $rules = array(
"name" => "required|length[0,255]",
"title" => "required|length[0,255]",
"description" => "length[0,255]"
);
/**
* 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 {
foreach (user::group_ids() as $id) {
// Separate the first restriction from the rest to make it easier for us to formulate
// our where clause below
if (empty($this->view_restrictions)) {
$this->view_restrictions[0] = "view_$id";
} else {
$this->view_restrictions[1]["view_$id"] = access::ALLOW;
}
}
}
}
switch (count($this->view_restrictions)) {
case 0:
break;
case 1:
$this->where($this->view_restrictions);
break;
default:
$this->open_paren();
$this->where($this->view_restrictions[0], access::ALLOW);
$this->orwhere($this->view_restrictions[1]);
$this->close_paren();
break;
}
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';
}
public function delete() {
$path = $this->file_path();
parent::delete();
// If there is no name, the path is invalid so don't try to delete
if (!empty($this->name)) {
if ($this->is_album()) {
dir::unlink($path);
} else {
unlink($path);
}
}
}
/**
* Move this item to the specified target.
*
* @chainable
* @param Item_Model $target Target item (must be an album
* @return ORM_MTPP
*/
function move_to($target) {
$original_path = $this->file_path();
$original_resize_path = $this->resize_path();
$original_thumb_path = $this->thumb_path();
parent::move_to($target, true);
$this->relative_path = 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()));
} else {
rename($original_resize_path, $this->resize_path());
rename($original_thumb_path, $this->thumb_path());
}
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()) {
if ($this->is_album()) {
$url = url::site("albums/$this->id");
} else {
$url = url::site("photos/$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() {
return VARPATH . "thumbs/" . $this->_relative_path() .
($this->type == "album" ? "/.album.jpg" : "");
}
/**
* 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=true) {
return ($full_uri ?
url::abs_file("var/thumbs/" . $this->_relative_path()) :
url::file("var/thumbs/" . $this->_relative_path())) .
($this->type == "album" ? "/.album.jpg" : "");
}
/**
* album: /var/resizes/album1/.resize.jpg
* photo: /var/albums/album1/photo.resize.jpg
*/
public function resize_path() {
return VARPATH . "resizes/" . $this->_relative_path() .
($this->type == "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=true) {
return ($full_uri ?
url::abs_file("var/resizes/" . $this->_relative_path()) :
url::file("var/resizes/" . $this->_relative_path())) .
($this->type == "album" ? "/.album.jpg" : "");
}
/**
* Return the relative path to this item's file.
* @return string
*/
private function _relative_path() {
if (empty($this->relative_path)) {
foreach ($this->parents() as $parent) {
if ($parent->id > 1) {
$paths[] = $parent->name;
}
}
$paths[] = $this->name;
$this->relative_path = implode($paths, "/");
}
return $this->relative_path;
}
/**
* @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::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;
}
}
return parent::save();
}
/**
* 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->type != "album") {
return null;
}
if (empty($this->album_cover_item_id)) {
return null;
}
return model_cache::get("item", $this->album_cover_item_id);
}
/**
* 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) {
// Right now we only sort by id ascending, so bake that assumption in here.
// @todo fix this when we introduce sort orders.
return ORM::factory("item")
->where("parent_id", $this->id)
->where("id <=", $child_id)
->count_all();
}
/**
* Return an <img> tag for the thumbnail.
* @param array $extra_attrs Extra attributes to add to the img tag
* @return string
*/
public function thumb_tag($extra_attrs, $max=null) {
$width = $this->thumb_width;
$height = $this->thumb_height;
if (isset($max)) {
if ($width > $height) {
$height = (int)($max * ($height / $width));
$width = $max;
} else {
$width = (int)($max * ($width / $height));
$height = $max;
}
}
return html::image(array("src" => $this->thumb_url(),
"alt" => $this->title,
"width" => $width,
"height" => $height),
$extra_attrs);
}
/**
* Return an <img> tag for the thumbnail.
* @param array $extra_attrs Extra attributes to add to the img tag
* @return string
*/
public function resize_tag($extra_attrs) {
return html::image(array("src" => $this->resize_url(),
"alt" => $this->title,
"width" => $this->resize_width,
"height" => $this->resize_height),
$extra_attrs);
}
}