/usr/share/horde/ansel/lib/GalleryMode/Date.php is in php-horde-ansel 3.0.5+debian0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 | <?php
/**
* Ansel_GalleryMode_Date:: Class for encapsulating gallery methods that
* depend on the current display mode of the gallery being Date.
*
* Copyright 2008-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (GPL). If you
* did not receive this file, see http://www.horde.org/licenses/gpl.
*
* @author Michael J. Rubinsky <mrubinsk@horde.org>
* @package Ansel
*/
class Ansel_GalleryMode_Date extends Ansel_GalleryMode_Base
{
/**
* The date part array for the current grouping.
*
* @var array
*/
protected $_date = array();
/**
* Supported features
*
* @var array
*/
protected $_features = array('slideshow', 'zipdownload', 'upload');
/**
* The subgalleries whose images need to be included in this date grouping.
*
* @var array
*/
protected $_subGalleries = null;
/**
* See if a feature is supported.
*
* @param string $feature The feature
*
* @return boolean
*/
public function hasFeature($feature)
{
/* First, some special cases */
switch ($feature) {
case 'sort_images':
case 'image_captions':
case 'faces':
/* Only allowed when we are on a specific day */
return !empty($this->_date['day']);
default:
return parent::hasFeature($feature);
}
}
/**
* Get an array describing where this gallery is in a breadcrumb trail.
*
* @return array An array of 'title' and 'navdata' hashes with the [0]
* element being the deepest part.
*/
public function getGalleryCrumbData()
{
$year = !empty($this->_date['year']) ? $this->_date['year'] : 0;
$month = !empty($this->_date['month']) ? $this->_date['month'] : 0;
$day = !empty($this->_date['day']) ? $this->_date['day'] : 0;
$trail = array();
// Do we have any date parts?
if (!empty($year)) {
if (!empty($day)) {
$date = new Horde_Date($this->_date);
$text = $date->strftime('%e');
$navdata = array(
'view' => 'Gallery',
'gallery' => $this->_gallery->id,
'slug' => $this->_gallery->get('slug'),
'year' => $year,
'month' => $month,
'day' => $day);
$trail[] = array('title' => $text, 'navdata' => $navdata);
}
if (!empty($month)) {
$date = new Horde_Date(
array(
'year' => $year,
'month' => $month,
'day' => 1));
$text = $date->strftime('%B');
$navdata = array(
'view' => 'Gallery',
'gallery' => $this->_gallery->id,
'slug' => $this->_gallery->get('slug'),
'year' => $year,
'month' => $month);
$trail[] = array('title' => $text, 'navdata' => $navdata);
}
$navdata = array(
'view' => 'Gallery',
'gallery' => $this->_gallery->id,
'slug' => $this->_gallery->get('slug'),
'year' => $year);
$trail[] = array('title' => $year, 'navdata' => $navdata);
} else {
// This is the first level of a date mode gallery.
$navdata = array(
'view' => 'Gallery',
'gallery' => $this->_gallery->id,
'slug' => $this->_gallery->get('slug'));
$trail[] = array('title' => _("All dates"), 'navdata' => $navdata);
}
$text = htmlspecialchars($this->_gallery->get('name'));
$navdata = array(
'view' => 'Gallery',
'gallery' => $this->_gallery->id,
'slug' => $this->_gallery->get('slug'));
$trail[] = array('title' => $text, 'navdata' => $navdata);
return $trail;
}
/**
* Getter for date
*
* @return array A date parts array.
*/
public function getDate()
{
return $this->_date;
}
/**
* Setter for date
*
* @param array $date
*/
public function setDate($date = array())
{
$this->_date = $date;
}
/**
* Get the children of this gallery.
*
* @param integer $perm The permissions to limit to.
* @param integer $from The child to start at.
* @param integer $to The child to end with.
* @param boolean $noauto Whether or not to automatically drill down to the
* first grouping with more then one group.
*
* @return array A mixed array of Ansel_Gallery_Decorator_Date and
* Ansel_Image objects.
*/
public function getGalleryChildren(
$perm = Horde_Perms::SHOW, $from = 0, $to = 0, $noauto = false)
{
// Cache the results
static $children = array();
$fullkey = md5($noauto . $perm . $this->_gallery->id . serialize($this->_date) . 0 . 0);
$cache_key = md5($noauto . $perm . $this->_gallery->id . serialize($this->_date) . $from . $to);
if (!empty($children[$cache_key])) {
return $children[$cache_key];
} elseif (!empty($children[$fullkey])) {
return $this->_getArraySlice($children[$fullkey], $from, $to, true);
}
$ansel_storage = $GLOBALS['injector']->getInstance('Ansel_Storage');
// Get a list of all the subgalleries
$this->_loadSubGalleries();
$params = array(
'fields' => array('image_id', 'image_original_date')
);
if (count($this->_subGalleries)) {
$params['gallery_id'] = array_merge(
$this->_subGalleries,
array($this->_gallery->id));
} else {
$params['gallery_id'] = $this->_gallery->id;
}
$sorted_dates = array();
// See how specific the date is
if (!count($this->_date) || empty($this->_date['year'])) {
// All available images - grouped by year
$images = $ansel_storage->listImages($params);
$dates = array();
foreach ($images as $key => $image) {
$dates[date('Y', $image['image_original_date'])][] = $key;
}
$keys = array_keys($dates);
// Drill down further if we only have a single group
if (!$noauto && count($keys) == 1) {
$this->_date['year'] = array_pop($keys);
return $this->getGalleryChildren($perm, $from, $to, $noauto);
}
sort($keys, SORT_NUMERIC);
foreach ($keys as $key) {
$sorted_dates[$key] = $dates[$key];
}
$display_unit = 'year';
} elseif (empty($this->_date['month'])) {
// Specific year - grouped by month
$start = new Horde_Date(
array(
'year' => $this->_date['year'],
'month' => 1,
'day' => 1)
);
// Last second of the year
$end = new Horde_Date($start);
$end->mday = 31;
$end->month = 12;
$end->hour = 23;
$end->min = 59;
$end->sec = 59;
// Get the image ids and dates
$params['filter'] = array(
array(
'property' => 'originalDate',
'op' => '<=',
'value' => (int)$end->timestamp()
),
array(
'property' => 'originalDate',
'op' => '>=',
'value' => (int)$start->timestamp()
)
);
$images= $ansel_storage->listImages($params);
$dates = array();
foreach ($images as $key => $image) {
$dates[date('n', $image['image_original_date'])][] = $key;
}
$keys = array_keys($dates);
// Only 1 date grouping here, automatically drill down
if (!$noauto && count($keys) == 1) {
$this->_date['month'] = array_pop($keys);
return $this->getGalleryChildren($perm, $from, $to, $noauto);
}
sort($keys, SORT_NUMERIC);
foreach ($keys as $key) {
$sorted_dates[$key] = $dates[$key];
}
$display_unit = 'month';
} elseif (empty($this->_date['day'])) {
// A single month - group by day
$start = new Horde_Date(
array(
'year' => $this->_date['year'],
'month' => $this->_date['month'],
'day' => 1)
);
// Last second of the month
$end = new Horde_Date($start);
$end->mday = Horde_Date_Utils::daysInMonth($end->month, $end->year);
$end->hour = 23;
$end->min = 59;
$end->sec = 59;
$params['filter'] = array(
array(
'property' => 'originalDate',
'op' => '<=',
'value' => (int)$end->timestamp()
),
array(
'property' => 'originalDate',
'op' => '>=',
'value' => (int)$start->timestamp()
)
);
$images= $ansel_storage->listImages($params);
$dates = array();
foreach ($images as $key => $image) {
$dates[date('d', $image['image_original_date'])][] = $key;
}
$keys = array_keys($dates);
// Only a single grouping, go deeper
if (!$noauto && count($keys) == 1) {
$this->_date['day'] = array_pop($keys);
return $this->getGalleryChildren($perm, $from, $to, $noauto);
}
sort($keys, SORT_NUMERIC);
foreach ($keys as $key) {
$sorted_dates[$key] = $dates[$key];
}
$dates = $sorted_dates;
$display_unit = 'day';
} else {
// We are down to a specific day
$start = new Horde_Date($this->_date);
// Last second of this day
$end = new Horde_Date($start->timestamp());
$end->hour = 23;
$end->min = 59;
$end->sec = 59;
// Filter for this day
$params['filter'] = array(
array(
'property' => 'originalDate',
'op' => '<=',
'value' => (int)$end->timestamp()
),
array(
'property' => 'originalDate',
'op' => '>=',
'value' => (int)$start->timestamp()
)
);
// Only get what we need
$params['offset'] = $from;
$params['limit'] = $to;
// Default to asking for just image_ids
unset($params['fields']);
// Get the image list
$images = $ansel_storage->listImages($params);
if ($images) {
$results = $ansel_storage->getImages(
array('ids' => $images, 'preserve' => true));
} else {
$results = array();
}
if ($this->_gallery->get('has_subgalleries')) {
$images = array();
foreach ($results as $id => $image) {
$image->gallery = $this->_gallery->id;
$images[$id] = $image;
}
$children[$cache_key] = $images;
} else {
$children[$cache_key] = $results;
}
return $children[$cache_key];
}
$results = array();
foreach ($sorted_dates as $key => $images) {
/* Get the new date parameter */
switch ($display_unit) {
case 'year':
$date = array('year' => $key);
break;
case 'month':
$date = array(
'year' => $this->_date['year'],
'month' => (int)$key);
break;
case 'day':
$date = array(
'year' => (int)$this->_date['year'],
'month' => (int)$this->_date['month'],
'day' => (int)$key);
}
$obj = new Ansel_Gallery_Decorator_Date($this->_gallery, $images);
$obj->setDate($date);
$results[$key] = $obj;
}
$children[$cache_key] = $results;
if ($from > 0 || $to > 0) {
return $this->_getArraySlice($results, $from, $to, true);
}
return $results;
}
/**
* Return the count of this gallery's children
*
* @param integer $perm The permissions to require.
* @param boolean $galleries_only Only include galleries, no images.
* (Ignored since this makes no sense for a
* gallery grouped by dates).
* @param boolean $noauto Auto navigate down to the first populated
* date grouping.
*
* @return integer The count of this gallery's children. The count is either
* a count of of the number of date groupings (months, days,
* etc..) that need to be displayed, or a count of all the
* images in the current date grouping (for a specific day).
*/
public function countGalleryChildren($perm = Horde_Perms::SHOW,
$galleries_only = false, $noauto = true)
{
$results = $this->getGalleryChildren($perm, 0, 0, $noauto);
return count($results);
}
/**
* Lists a slice of the image ids in this gallery.
* In Date mode, this only makes sense if we are currently viewing a
* specific day, otherwise we return 0.
*
* @param integer $from The image to start listing.
* @param integer $count The numer of images to list.
*
* @return array An array of image_ids
*/
public function listImages($from = 0, $count = 0)
{
/* Get all of this grouping's children. */
$children = $this->getGalleryChildren();
/* At day level, these are all Ansel_Images */
if (!empty($this->_date['day'])) {
$images = array_keys($children);
} else {
$images = array();
// typeof $child == Ansel_Gallery_Decorator_Date
foreach ($children as $child) {
$images = array_merge($images, $child->getImagesByGrouping());
}
}
return $this->_getArraySlice($images, $from, $count);
}
/**
* Moves images from one gallery to another. Since we're viewing by date
* some images might belong to a subgallery so we need to take care to
* udate the appropriate gallery data.
*
* @param array $images An array of image_ids to move.
* @param Ansel_Gallery $gallery The Ansel_Gallery to move them to.
*
* @return boolean
*/
public function moveImagesTo($images, $gallery)
{
if (!$gallery->hasPermission($GLOBALS['registry']->getAuth(), Horde_Perms::EDIT)) {
throw new Horde_Exception_PermissionDenied(_("Access denied moving photos to this gallery."));
} elseif (!$this->_gallery->hasPermission($GLOBALS['registry']->getAuth(), Horde_Perms::DELETE)) {
throw new Horde_Exception_PermissionDenied(_("Access denied removing photos from this gallery."));
}
/* Sanitize image ids, and see if we're removing our key image. */
$ids = array();
foreach ($images as $imageId) {
$ids[] = (int)$imageId;
if ($imageId == $this->_gallery->get('default')) {
$this->_gallery->set('default', null, true);
}
}
/* If we have subgalleries, we need to go the more expensive route. Note
* we can't use $gallery->hasSubgalleries() since that would be
* overridden here since we are in date mode and thus would return false
*/
if ($this->_gallery->get('has_subgalleries')) {
$gallery_ids = array();
$images = $GLOBALS['injector']->getInstance('Ansel_Storage')->getImages(array('ids' => $ids));
foreach ($images as $image) {
if (empty($gallery_ids[$image->gallery])) {
$gallery_ids[$image->gallery] = 1;
} else {
$gallery_ids[$image->gallery]++;
}
}
}
/* Bulk update the images to their new gallery_id */
$GLOBALS['injector']->getInstance('Ansel_Storage')->setImagesGallery($ids, $gallery->id);
/* Update the gallery counts for each affected gallery */
if ($this->_gallery->get('has_subgalleries')) {
foreach ($gallery_ids as $id => $count) {
$GLOBALS['injector']->getInstance('Ansel_Storage')
->getGallery($id)
->updateImageCount($count, false);
}
} else {
$this->_gallery->updateImageCount(count($ids), false);
}
$gallery->updateImageCount(count($ids), true);
/* Expire the cache since we have no reason to save() the gallery */
if ($GLOBALS['conf']['ansel_cache']['usecache']) {
$GLOBALS['injector']->getInstance('Horde_Cache')->expire('Ansel_Gallery' . $gallery->id);
$GLOBALS['injector']->getInstance('Horde_Cache')->expire('Ansel_Gallery' . $this->_gallery->id);
}
return count($ids);
}
/**
* Remove an image from this gallery. Note that the image might actually
* belong to a subgallery of this gallery since we are viewing by date.
* Need to take care of updating correct subgallery's image count etc...
*
* @param mixed $image An image_id or Ansel_Image object to delete.
* @param boolean $isStack Image is a stack image (doesn't update count).
*
* @return boolean
* @throws Horde_Exception_NotFound, Ansel_Exception
*/
public function removeImage($image, $isStack)
{
// Make sure $image is an Ansel_Image; if not, try loading it.
if (!($image instanceof Ansel_Image)) {
$image = $GLOBALS['injector']
->getInstance('Ansel_Storage')
->getImage($image);
}
// If image is a stack image, $gallery will be negative.
$image_gallery = abs($image->gallery);
// Make sure the image is in this gallery.
if ($image_gallery != $this->_gallery->id) {
$this->_loadSubGalleries();
if (!in_array($image_gallery, $this->_subGalleries)) {
throw new Horde_Exception_NotFound(_("Image not found in gallery."));
}
}
/* Change gallery info. */
if ($this->_gallery->get('default') == $image->id) {
$this->_gallery->set('default', null);
$this->_gallery->set('default_type' , 'auto');
}
/* Delete cached files from VFS. */
$image->deleteCache();
/* Delete original image from VFS. */
try {
$GLOBALS['injector']->getInstance('Horde_Core_Factory_Vfs')->create('images')->deleteFile($image->getVFSPath('full'),
$image->getVFSName('full'));
} catch (Horde_Vfs_Exception $e) {}
/* Delete from storage */
$GLOBALS['injector']->getInstance('Ansel_Storage')->removeImage($image->id);
if (!$isStack) {
$GLOBALS['injector']->getInstance('Ansel_Storage')
->getGallery($image_gallery)
->updateImageCount(1, false);
}
/* Update the modified flag if we are not a stack image */
if (!$isStack) {
$this->_gallery->set('last_modified', time());
}
/* Save all gallery changes */
$this->_gallery->save();
/* Clear the image's tags */
$image->setTags(array());
/* Clear the image's faces */
if ($image->facesCount) {
Ansel_Faces::delete($image);
}
/* Clear any comments */
if (($GLOBALS['conf']['comments']['allow'] == 'all' || ($GLOBALS['conf']['comments']['allow'] == 'authenticated' && $GLOBALS['registry']->getAuth())) &&
$GLOBALS['registry']->hasMethod('forums/deleteForum')) {
try {
$GLOBALS['registry']->call('forums/deleteForum', array('ansel', $image->id));
} catch (Horde_Exception $e) {
Horde::log($e, 'ERR');
return false;
}
}
return true;
}
/**
* Gets a slice of the images in this gallery.
*
* @param integer $from The image to start fetching.
* @param integer $count The numer of images to return.
*
* @param array An array of Ansel_Image objects
*/
public function getImages($from = 0, $count = 0)
{
if (!empty($this->_date['day'])) {
// Get all of this grouping's children. At day level, these are all
// Ansel_Images.
$children = $this->getGalleryChildren(Horde_Perms::SHOW);
return $this->_getArraySlice($children, $from, $count, true);
} else {
// We don't want to work with any images at this level in a DateMode
// gallery.
return array();
}
}
/**
* Checks if the gallery has any subgalleries. This will always be false
* for a gallery in date view.
*
* @return boolean
*/
public function hasSubGalleries()
{
return false;
}
/**
* Returns the number of images in this gallery and, optionally, all
* sub-galleries.
*
* @param boolean $subgalleries Determines whether subgalleries should
* be counted or not.
*
* @return integer number of images in this gallery
*/
public function countImages($subgalleries = false)
{
return count($this->listImages());
}
/**
* Helper function to get an array slice while preserving keys.
*
* @param unknown_type $array
* @param unknown_type $from
* @param unknown_type $count
* @return unknown
*/
protected function _getArraySlice($array, $from, $count, $preserve = false)
{
if ($from == 0 && $count == 0) {
return $array;
}
return array_slice($array, $from, $count, $preserve);
}
/**
* Get this gallery's subgalleries. Populates the private member
* _subGalleries
*/
protected function _loadSubGalleries()
{
// Note: We set $this->_subGalleries to null by default so we don't
// have to perform this check again, even if the gallery contains no
// subgalleries (and thus _subGalleries would be an empty array).
if (!is_array($this->_subGalleries)) {
$this->_subGalleries = array();
$subs = $GLOBALS['injector']
->getInstance('Ansel_Storage')
->listGalleries(array('parent' => $this->_gallery->id));
foreach ($subs as $sub) {
$this->_subGalleries[] = $sub->id;
}
}
}
}
|