lychee/php/modules/Album.php
Tobias Reich 17e5dba979 Singleton pattern for Settings::get(), Database::get() and Plugins::get()
What could properly go wrong? ¯\_(ツ)_/¯
2016-01-24 22:14:20 +01:00

753 lines
20 KiB
PHP

<?php
###
# @name Album Module
# @copyright 2015 by Tobias Reich
###
if (!defined('LYCHEE')) exit('Error: Direct access is not allowed!');
final class Album extends Module {
private $albumIDs = null;
public function __construct($albumIDs) {
# Init vars
$this->albumIDs = $albumIDs;
return true;
}
public function add($title = 'Untitled') {
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Parse
if (strlen($title)>50) $title = substr($title, 0, 50);
# Properties
$public = 0;
$visible = 1;
# Database
$sysstamp = time();
$query = Database::prepare(Database::get(), "INSERT INTO ? (title, sysstamp, public, visible) VALUES ('?', '?', '?', '?')", array(LYCHEE_TABLE_ALBUMS, $title, $sysstamp, $public, $visible));
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return Database::get()->insert_id;
}
public static function prepareData($data) {
# This function requires the following album-attributes and turns them
# into a front-end friendly format: id, title, public, sysstamp, password
# Note that some attributes remain unchanged
# Check dependencies
self::dependencies(isset($data));
# Init
$album = null;
# Set unchanged attributes
$album['id'] = $data['id'];
$album['title'] = $data['title'];
$album['public'] = $data['public'];
# Additional attributes
# Only part of $album when available
if (isset($data['description'])) $album['description'] = $data['description'];
if (isset($data['visible'])) $album['visible'] = $data['visible'];
if (isset($data['downloadable'])) $album['downloadable'] = $data['downloadable'];
# Parse date
$album['sysdate'] = date('F Y', $data['sysstamp']);
# Parse password
$album['password'] = ($data['password']=='' ? '0' : '1');
# Parse thumbs or set default value
$album['thumbs'] = (isset($data['thumbs']) ? explode(',', $data['thumbs']) : array());
return $album;
}
public function get() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Get album information
switch ($this->albumIDs) {
case 'f': $return['public'] = '0';
$query = Database::prepare(Database::get(), "SELECT id, title, tags, public, star, album, thumbUrl, takestamp, url FROM ? WHERE star = 1 " . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
break;
case 's': $return['public'] = '0';
$query = Database::prepare(Database::get(), "SELECT id, title, tags, public, star, album, thumbUrl, takestamp, url FROM ? WHERE public = 1 " . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
break;
case 'r': $return['public'] = '0';
$query = Database::prepare(Database::get(), "SELECT id, title, tags, public, star, album, thumbUrl, takestamp, url FROM ? WHERE LEFT(id, 10) >= unix_timestamp(DATE_SUB(NOW(), INTERVAL 1 DAY)) " . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
break;
case '0': $return['public'] = '0';
$query = Database::prepare(Database::get(), "SELECT id, title, tags, public, star, album, thumbUrl, takestamp, url FROM ? WHERE album = 0 " . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
break;
default: $query = Database::prepare(Database::get(), "SELECT * FROM ? WHERE id = '?' LIMIT 1", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$albums = Database::get()->query($query);
$return = $albums->fetch_assoc();
$return = Album::prepareData($return);
$query = Database::prepare(Database::get(), "SELECT id, title, tags, public, star, album, thumbUrl, takestamp, url FROM ? WHERE album = '?' " . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS, $this->albumIDs));
break;
}
# Get photos
$photos = Database::get()->query($query);
$previousPhotoID = '';
while ($photo = $photos->fetch_assoc()) {
# Turn data from the database into a front-end friendly format
$photo = Photo::prepareData($photo);
# Set previous and next photoID for navigation purposes
$photo['previousPhoto'] = $previousPhotoID;
$photo['nextPhoto'] = '';
# Set current photoID as nextPhoto of previous photo
if ($previousPhotoID!=='') $return['content'][$previousPhotoID]['nextPhoto'] = $photo['id'];
$previousPhotoID = $photo['id'];
# Add to return
$return['content'][$photo['id']] = $photo;
}
if ($photos->num_rows===0) {
# Album empty
$return['content'] = false;
} else {
# Enable next and previous for the first and last photo
$lastElement = end($return['content']);
$lastElementId = $lastElement['id'];
$firstElement = reset($return['content']);
$firstElementId = $firstElement['id'];
if ($lastElementId!==$firstElementId) {
$return['content'][$lastElementId]['nextPhoto'] = $firstElementId;
$return['content'][$firstElementId]['previousPhoto'] = $lastElementId;
}
}
$return['id'] = $this->albumIDs;
$return['num'] = $photos->num_rows;
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
return $return;
}
public function getAll($public) {
# Check dependencies
self::dependencies(isset($public));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Initialize return var
$return = array(
'smartalbums' => null,
'albums' => null,
'num' => 0
);
# Get SmartAlbums
if ($public===false) $return['smartalbums'] = $this->getSmartInfo();
# Albums query
if ($public===false) $query = Database::prepare(Database::get(), 'SELECT id, title, public, sysstamp, password FROM ? ' . Settings::get()['sortingAlbums'], array(LYCHEE_TABLE_ALBUMS));
else $query = Database::prepare(Database::get(), 'SELECT id, title, public, sysstamp, password FROM ? WHERE public = 1 AND visible <> 0 ' . Settings::get()['sortingAlbums'], array(LYCHEE_TABLE_ALBUMS));
# Execute query
$albums = Database::get()->query($query);
if (!$albums) {
Log::error(__METHOD__, __LINE__, 'Could not get all albums (' . Database::get()->error . ')');
exit('Error: ' . Database::get()->error);
}
# For each album
while ($album = $albums->fetch_assoc()) {
# Turn data from the database into a front-end friendly format
$album = Album::prepareData($album);
# Thumbs
if (($public===true&&$album['password']==='0')||
($public===false)) {
# Execute query
$query = Database::prepare(Database::get(), "SELECT thumbUrl FROM ? WHERE album = '?' ORDER BY star DESC, " . substr(Settings::get()['sortingPhotos'], 9) . " LIMIT 3", array(LYCHEE_TABLE_PHOTOS, $album['id']));
$thumbs = Database::get()->query($query);
# For each thumb
$k = 0;
while ($thumb = $thumbs->fetch_object()) {
$album['thumbs'][$k] = LYCHEE_URL_UPLOADS_THUMB . $thumb->thumbUrl;
$k++;
}
}
# Add to return
$return['albums'][] = $album;
}
# Num of albums
$return['num'] = $albums->num_rows;
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
return $return;
}
private function getSmartInfo() {
# Initialize return var
$return = array(
'unsorted' => null,
'public' => null,
'starred' => null,
'recent' => null
);
###
# Unsorted
###
$query = Database::prepare(Database::get(), 'SELECT thumbUrl FROM ? WHERE album = 0 ' . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
$unsorted = Database::get()->query($query);
$i = 0;
$return['unsorted'] = array(
'thumbs' => array(),
'num' => $unsorted->num_rows
);
while($row = $unsorted->fetch_object()) {
if ($i<3) {
$return['unsorted']['thumbs'][$i] = LYCHEE_URL_UPLOADS_THUMB . $row->thumbUrl;
$i++;
} else break;
}
###
# Starred
###
$query = Database::prepare(Database::get(), 'SELECT thumbUrl FROM ? WHERE star = 1 ' . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
$starred = Database::get()->query($query);
$i = 0;
$return['starred'] = array(
'thumbs' => array(),
'num' => $starred->num_rows
);
while($row3 = $starred->fetch_object()) {
if ($i<3) {
$return['starred']['thumbs'][$i] = LYCHEE_URL_UPLOADS_THUMB . $row3->thumbUrl;
$i++;
} else break;
}
###
# Public
###
$query = Database::prepare(Database::get(), 'SELECT thumbUrl FROM ? WHERE public = 1 ' . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
$public = Database::get()->query($query);
$i = 0;
$return['public'] = array(
'thumbs' => array(),
'num' => $public->num_rows
);
while($row2 = $public->fetch_object()) {
if ($i<3) {
$return['public']['thumbs'][$i] = LYCHEE_URL_UPLOADS_THUMB . $row2->thumbUrl;
$i++;
} else break;
}
###
# Recent
###
$query = Database::prepare(Database::get(), 'SELECT thumbUrl FROM ? WHERE LEFT(id, 10) >= unix_timestamp(DATE_SUB(NOW(), INTERVAL 1 DAY)) ' . Settings::get()['sortingPhotos'], array(LYCHEE_TABLE_PHOTOS));
$recent = Database::get()->query($query);
$i = 0;
$return['recent'] = array(
'thumbs' => array(),
'num' => $recent->num_rows
);
while($row3 = $recent->fetch_object()) {
if ($i<3) {
$return['recent']['thumbs'][$i] = LYCHEE_URL_UPLOADS_THUMB . $row3->thumbUrl;
$i++;
} else break;
}
# Return SmartAlbums
return $return;
}
public function getArchive() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Illicit chars
$badChars = array_merge(
array_map('chr', range(0,31)),
array("<", ">", ":", '"', "/", "\\", "|", "?", "*")
);
# Photos query
switch($this->albumIDs) {
case 's':
$photos = Database::prepare(Database::get(), 'SELECT title, url FROM ? WHERE public = 1', array(LYCHEE_TABLE_PHOTOS));
$zipTitle = 'Public';
break;
case 'f':
$photos = Database::prepare(Database::get(), 'SELECT title, url FROM ? WHERE star = 1', array(LYCHEE_TABLE_PHOTOS));
$zipTitle = 'Starred';
break;
case 'r':
$photos = Database::prepare(Database::get(), 'SELECT title, url FROM ? WHERE LEFT(id, 10) >= unix_timestamp(DATE_SUB(NOW(), INTERVAL 1 DAY)) GROUP BY checksum', array(LYCHEE_TABLE_PHOTOS));
$zipTitle = 'Recent';
break;
default:
$photos = Database::prepare(Database::get(), "SELECT title, url FROM ? WHERE album = '?'", array(LYCHEE_TABLE_PHOTOS, $this->albumIDs));
$zipTitle = 'Unsorted';
}
# Get title from database when album is not a SmartAlbum
if ($this->albumIDs!=0&&is_numeric($this->albumIDs)) {
$query = Database::prepare(Database::get(), "SELECT title FROM ? WHERE id = '?' LIMIT 1", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$album = Database::get()->query($query);
# Error in database query
if (!$album) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
# Fetch object
$album = $album->fetch_object();
# Photo not found
if ($album===null) {
Log::error(__METHOD__, __LINE__, 'Album not found. Cannot start download.');
return false;
}
# Set title
$zipTitle = $album->title;
}
# Escape title
$zipTitle = str_replace($badChars, '', $zipTitle);
$filename = LYCHEE_DATA . $zipTitle . '.zip';
# Create zip
$zip = new ZipArchive();
if ($zip->open($filename, ZIPARCHIVE::CREATE)!==TRUE) {
Log::error(__METHOD__, __LINE__, 'Could not create ZipArchive');
return false;
}
# Execute query
$photos = Database::get()->query($photos);
# Check if album empty
if ($photos->num_rows==0) {
Log::error(__METHOD__, __LINE__, 'Could not create ZipArchive without images');
return false;
}
# Parse each path
$files = array();
while ($photo = $photos->fetch_object()) {
# Parse url
$photo->url = LYCHEE_UPLOADS_BIG . $photo->url;
# Parse title
$photo->title = str_replace($badChars, '', $photo->title);
if (!isset($photo->title)||$photo->title==='') $photo->title = 'Untitled';
# Check if readable
if (!@is_readable($photo->url)) continue;
# Get extension of image
$extension = getExtension($photo->url);
# Set title for photo
$zipFileName = $zipTitle . '/' . $photo->title . $extension;
# Check for duplicates
if (!empty($files)) {
$i = 1;
while (in_array($zipFileName, $files)) {
# Set new title for photo
$zipFileName = $zipTitle . '/' . $photo->title . '-' . $i . $extension;
$i++;
}
}
# Add to array
$files[] = $zipFileName;
# Add photo to zip
$zip->addFile($photo->url, $zipFileName);
}
# Finish zip
$zip->close();
# Send zip
header("Content-Type: application/zip");
header("Content-Disposition: attachment; filename=\"$zipTitle.zip\"");
header("Content-Length: " . filesize($filename));
readfile($filename);
# Delete zip
unlink($filename);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
return true;
}
public function setTitle($title = 'Untitled') {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Execute query
$query = Database::prepare(Database::get(), "UPDATE ? SET title = '?' WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $title, $this->albumIDs));
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return true;
}
public function setDescription($description = '') {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Execute query
$query = Database::prepare(Database::get(), "UPDATE ? SET description = '?' WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $description, $this->albumIDs));
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return true;
}
public function getPublic() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
if ($this->albumIDs==='0'||$this->albumIDs==='s'||$this->albumIDs==='f') return false;
# Execute query
$query = Database::prepare(Database::get(), "SELECT public FROM ? WHERE id = '?' LIMIT 1", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$albums = Database::get()->query($query);
$album = $albums->fetch_object();
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if ($album->public==1) return true;
return false;
}
public function getDownloadable() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
if ($this->albumIDs==='0'||$this->albumIDs==='s'||$this->albumIDs==='f'||$this->albumIDs==='r') return false;
# Execute query
$query = Database::prepare(Database::get(), "SELECT downloadable FROM ? WHERE id = '?' LIMIT 1", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$albums = Database::get()->query($query);
$album = $albums->fetch_object();
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if ($album->downloadable==1) return true;
return false;
}
public function setPublic($public, $password, $visible, $downloadable) {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Convert values
$public = ($public==='1' ? 1 : 0);
$visible = ($visible==='1' ? 1 : 0);
$downloadable = ($downloadable==='1' ? 1 : 0);
# Set public
$query = Database::prepare(Database::get(), "UPDATE ? SET public = '?', visible = '?', downloadable = '?', password = NULL WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $public, $visible, $downloadable, $this->albumIDs));
$result = Database::get()->query($query);
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
# Reset permissions for photos
if ($public===1) {
$query = Database::prepare(Database::get(), "UPDATE ? SET public = 0 WHERE album IN (?)", array(LYCHEE_TABLE_PHOTOS, $this->albumIDs));
$result = Database::get()->query($query);
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
}
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
# Set password
if (isset($password)&&strlen($password)>0) return $this->setPassword($password);
return true;
}
private function setPassword($password) {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
if (strlen($password)>0) {
# Get hashed password
$password = getHashedString($password);
# Set hashed password
# Do not prepare $password because it is hashed and save
# Preparing (escaping) the password would destroy the hash
$query = Database::prepare(Database::get(), "UPDATE ? SET password = '$password' WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
} else {
# Unset password
$query = Database::prepare(Database::get(), "UPDATE ? SET password = NULL WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
}
# Execute query
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return true;
}
public function checkPassword($password) {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Execute query
$query = Database::prepare(Database::get(), "SELECT password FROM ? WHERE id = '?' LIMIT 1", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$albums = Database::get()->query($query);
$album = $albums->fetch_object();
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if ($album->password=='') return true;
else if ($album->password===crypt($password, $album->password)) return true;
return false;
}
public function merge() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Convert to array
$albumIDs = explode(',', $this->albumIDs);
# Get first albumID
$albumID = array_splice($albumIDs, 0, 1);
$albumID = $albumID[0];
$query = Database::prepare(Database::get(), "UPDATE ? SET album = ? WHERE album IN (?)", array(LYCHEE_TABLE_PHOTOS, $albumID, $this->albumIDs));
$result = Database::get()->query($query);
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
# $albumIDs contains all IDs without the first albumID
# Convert to string
$filteredIDs = implode(',', $albumIDs);
$query = Database::prepare(Database::get(), "DELETE FROM ? WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $filteredIDs));
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return true;
}
public function delete() {
# Check dependencies
self::dependencies(isset($this->albumIDs));
# Call plugins
$this->plugins(__METHOD__, 0, func_get_args());
# Init vars
$error = false;
# Execute query
$query = Database::prepare(Database::get(), "SELECT id FROM ? WHERE album IN (?)", array(LYCHEE_TABLE_PHOTOS, $this->albumIDs));
$photos = Database::get()->query($query);
# For each album delete photo
while ($row = $photos->fetch_object()) {
$photo = new Photo($row->id);
if (!$photo->delete($row->id)) $error = true;
}
# Delete albums
$query = Database::prepare(Database::get(), "DELETE FROM ? WHERE id IN (?)", array(LYCHEE_TABLE_ALBUMS, $this->albumIDs));
$result = Database::get()->query($query);
# Call plugins
$this->plugins(__METHOD__, 1, func_get_args());
if ($error) return false;
if (!$result) {
Log::error(__METHOD__, __LINE__, Database::get()->error);
return false;
}
return true;
}
}
?>