Your IP : 216.73.216.46
<?php
/**
* @package Sven.Bluege
* @subpackage com_eventgallery
*
* @copyright Copyright (C) 2005 - 2019 Sven Bluege All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// Check to ensure this file is included in Joomla!
use Joomla\Component\Eventgallery\Site\Library\Configuration\Main;
require_once JPATH_ROOT.'/components/com_eventgallery/library/common/logger.php';
defined('_JEXEC') or die();
abstract class EventgalleryLibraryFolder extends EventgalleryLibraryDatabaseObject implements EventgalleryLibraryInterfaceFoldercapability
{
protected $config = null;
protected static $_tagsCache = Array();
/**
* @var string
*/
protected $_foldername = NULL;
/**
* @var EventgalleryTableFolder
*/
protected $_folder = NULL;
/**
* @var EventgalleryLibraryImagetypeset
*/
protected $_imagetypeset = NULL;
protected $_filecount = NULL;
protected $_attribs = NULL;
protected $_metadata = NULL;
/**
* @var EventgalleryLibraryDatabaseLocalizablestring
*/
protected $_ls_description = NULL;
/**
* @var EventgalleryLibraryDatabaseLocalizablestring
*/
protected $_ls_text = NULL;
/**
* @var array
*/
protected $_tags = NULL;
/**
* @var EventgalleryLibraryDatabaseLocalizablestring
*/
protected $_ls_passwordhint = NULL;
const COM_EVENTGALLERY_EVENT_LOGFILENAME = 'com_eventgallery_event.log.php';
/**
* @param $object object
*/
public function __construct($object)
{
\JLog::addLogger(
array(
'text_file' => self::COM_EVENTGALLERY_EVENT_LOGFILENAME,
'logger' => 'Eventgalleryformattedtext'
),
\JLog::ALL,
'com_eventgallery_event'
);
$this->config = \Joomla\Component\Eventgallery\Site\Library\Configuration\Main::getInstance();
if (!is_object($object)) {
throw new InvalidArgumentException("Can't create folder object without an valid data object");
}
$this->_folder = $object;
$foldername = $this->_folder->folder;
$this->_foldername = $foldername;
if ($this->_folder == null) {
$this->_loadFolder();
}
$this->_prepareData();
parent::__construct();
}
/**
* use this method to sync new folders to the database. It returns an array with EventgalleryLibraryFolderAddresult objects
*
* @return Array
*/
public static function findNewFolders() {
return Array();
}
/**
* add all new folders automatically.
*/
public static function addNewFolders() {
$newFolders = self::findNewFolders();
foreach($newFolders as $folder) {
self::addNewFolder($folder);
}
}
/**
* Add a new folder
* @param $foldername
*/
public static function addNewFolder($foldername) {
}
/**
* @return mixed returns the Factory to create a file for this folder.
*/
public static function getFileFactory() {
return null;
}
/**
* loads a folder from the databas
*/
protected function _loadFolder()
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('*');
$query->from('#__eventgallery_folder');
$query->where('folder=' . $db->quote($this->_foldername));
$db->setQuery($query);
$folderObject = $db->loadObject();
$this->_folder = $folderObject;
}
/**
* Load necessary data for this folder object.
*/
protected function _prepareData() {
if ($this->_folder == null) {
return;
}
$this->_ls_description = new EventgalleryLibraryDatabaseLocalizablestring($this->_folder->description);
$this->_ls_text = new EventgalleryLibraryDatabaseLocalizablestring($this->_folder->text);
$this->_ls_passwordhint = new EventgalleryLibraryDatabaseLocalizablestring($this->_folder->passwordhint);
/**
* @var EventgalleryLibraryFactoryImagetypeset $imagetypesetFactory
*/
$imagetypesetFactory = EventgalleryLibraryFactoryImagetypeset::getInstance();
if ($this->_folder->imagetypesetid == null) {
$this->_imagetypeset = $imagetypesetFactory->getDefaultImageTypeSet(true);
} else {
$this->_imagetypeset = $imagetypesetFactory->getImageTypeSet($this->_folder->imagetypesetid);
if (!$this->_imagetypeset->isPublished()) {
$this->_imagetypeset = $imagetypesetFactory->getDefaultImageTypeSet(true);
}
}
}
/**
* @return string
*/
public function getFolderName()
{
return $this->_folder->folder;
}
/**
* @return EventgalleryLibraryImagetypeset
*/
public function getImageTypeSet()
{
return $this->_imagetypeset;
}
/**
* @return bool
*/
public function isCartable()
{
return $this->_folder->cartable == 1;
}
/**
* @return bool
*/
public function isPublished()
{
if (!isset($this->_folder)) {
return false;
}
$published = $this->_folder->published == 1;
if ($this->_folder->publish_up || $this->_folder->publish_down) {
$nowDate = \Joomla\CMS\Factory::getDate()->toUnix();
$nullDate = \Joomla\CMS\Factory::getDbo()->getNullDate();
$publishUp = $this->_folder->publish_up;
$publishDown = $this->_folder->publish_down;
$tz = \Joomla\CMS\Factory::getUser()->getTimezone();
$publishUp = ($publishUp !== null && $publishUp !== $nullDate) ? \Joomla\CMS\Factory::getDate($publishUp, 'UTC')->setTimeZone($tz) : false;
$publishDown = ($publishDown !== null && $publishDown !== $nullDate) ? \Joomla\CMS\Factory::getDate($publishDown, 'UTC')->setTimeZone($tz) : false;
if ($publishUp && $nowDate < $publishUp->toUnix()) {
$published &= false;
}
if ($publishDown && $nowDate > $publishDown->toUnix()) {
$published &= false;
}
}
return $published;
}
/**
* @return string
*/
public function getPassword()
{
return $this->_folder->password;
}
/**
* Returns true is a password is set for this event.
*
* @return bool
*/
public function hasPassword() {
return strlen($this->getPassword())>0;
}
public function getPasswordHint()
{
if ($this->_ls_passwordhint == null) {
return "";
}
return $this->_ls_passwordhint->get();
}
public function getUserGroupIds()
{
return $this->_folder->usergroupids;
}
/**
* returns a set of attributes
*
* @return \Joomla\Registry\Registry
*/
public function getAttribs() {
if ($this->_attribs == NULL) {
$registry = new JRegistry($this->_folder->attribs);
$this->_attribs = $registry;
}
return $this->_attribs;
}
/**
* returns a set of attributes containing metadata information
*
* @return \Joomla\Registry\Registry
*/
public function getMetadata() {
if ($this->_metadata == NULL) {
$registry = new JRegistry($this->_folder->metadata);
$this->_metadata = $registry;
}
return $this->_metadata;
}
/**
* Returns true if the folder has a password and this password is already entered for this session.
*
* @return bool
*/
public function isAccessible()
{
/**
* this logic is implemented in EventgalleryHelpersFolderprotection too. There we need to update the list
* of folders.
*/
if (strlen($this->getPassword()) > 0) {
$session = JFactory::getSession();
$unlockedFoldersJson = $session->get(EventgalleryHelpersFolderprotection::SESSION_KEY_UNLOCKED_FOLDERS, "");
$unlockedFolders = array();
if (strlen($unlockedFoldersJson) > 0) {
$unlockedFolders = json_decode($unlockedFoldersJson, true);
}
if (!in_array($this->_foldername, $unlockedFolders)) {
return false;
}
}
return true;
}
/**
* Returns true if the current user is allowed to see this item. This
* method is useful if you want to check the user group restrictions for this folder.
*
* @return bool
*/
public function isVisible() {
$user = JFactory::getUser();
$userUserGroups = $user->groups;
$minUserGroups = $this->config->getGeneral()->getDefaultUsergroup();
$folderUserGroups = explode(',', $this->getUserGroupIds()!=null?$this->getUserGroupIds():"");
return EventgalleryLibraryCommonUsergroups::validateWithOverride($minUserGroups, $folderUserGroups, $userUserGroups);
}
/**
* returns true is this folder is visible for the public user group.
* @return bool
*/
public function isPublicVisible() {
/**
* @var \Joomla\Registry\Registry $params
*/
$minUserGroups = $this->config->getGeneral()->getDefaultUsergroup();
// if no user groups are set at all
if (strlen($this->getUserGroupIds())==0 && count($minUserGroups)==0 ) {
return true;
}
// use the default usergroups if the folder does not define any
if (strlen($this->getUserGroupIds())==0) {
$folderUserGroups = $minUserGroups;
} else {
$folderUserGroups = explode(',', $this->getUserGroupIds());
}
// if the public user group is part of the folder user groups
if (in_array(1, $folderUserGroups)) {
return true;
}
return false;
}
/**
*
* @param $config Main
*/
public function doAllowDownloadOfOriginalImage($config) {
$allowDownloadOriginalImages = $config->getSocial()->doDownloadOriginalImages();
if (!$allowDownloadOriginalImages) {
return false;
}
$user = JFactory::getUser();
$userUserGroups = $user->groups;
$defaultUserGroups = $config->getSocial()->getDefaultOriginalImageDownloadUsergroups();
$folderUserGroups = $this->getAttribs()->get('download_original_images_usergroupids', []);
return EventgalleryLibraryCommonUsergroups::validateWithOverride($defaultUserGroups, $folderUserGroups, $userUserGroups);
}
/**
* Returns true if we can download the image in the current session.
*
* @param $config
* @return bool
*/
public function doAllowDownloadAtAll($config) {
$allowDownloadOfOriginalImage = $this->doAllowDownloadOfOriginalImage($config);
$allowDownloadOfLowResImage = $config->getSocial()->doLowResImages();
return $allowDownloadOfLowResImage || $allowDownloadOfOriginalImage;
}
/**
* returns the text for the folder.
*
* @return String
*/
public function getText() {
if ($this->_ls_text == null) {
return "";
}
$splittedText = EventgalleryHelpersTextsplitter::split($this->_ls_text->get());
return $splittedText->fulltext;
}
/**
* returns the intro text for the folder if there is a splitter in the text.
* Otherwise the introtext is the same as the text.
*
* @return String
*/
public function getIntroText() {
if ($this->_ls_text == null) {
return "";
}
$splittedText = EventgalleryHelpersTextsplitter::split($this->_ls_text->get());
return $splittedText->introtext;
}
/**
* Returns the display name of this folder
*
* @return string
*/
public function getDisplayName() {
if ($this->_ls_description == null) {
return "";
}
return $this->_ls_description->get();
}
/**
* returns the date field
*
* @return string
*/
public function getDate() {
if ($this->_folder->date == null) {
return "";
}
return $this->_folder->date;
}
/**
* returns the number of files in this folder
*
* @param bool $publishedOnly defines is the return value contains unpublished files.
* @return int
*/
public function getFileCount($publishedOnly = true) {
// this value might be part of a sql query
if (isset($this->_folder->overallCount)) {
return $this->_folder->overallCount;
}
if ($this->_filecount === NULL) {
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('count(1)')
->from($db->quoteName('#__eventgallery_file') . ' AS file')
->where('folder='.$db->quote($this->_foldername))
->where('(file.ismainimageonly IS NULL OR file.ismainimageonly=0)');
if ($publishedOnly) {
$query->where('file.published=1');
}
$db->setQuery( $query );
$this->_filecount = $db->loadResult();
}
return $this->_filecount;
}
/**
* @param int $limitstart
* @param int $limit
* @param int $imagesForEvents if true load the main images at the first position
* @param string $sortAttribute definefines a database colum which is used to sort the files
* @param string $sortDirection defines the sort direction for the sortAttribute column.
* @return EventgalleryLibraryFile[]
*/
public function getFiles($limitstart = 0, $limit = 0, $imagesForEvents = 0, $sortAttribute='', $sortDirection='ASC') {
/**
* @var JDatabaseDriver $db
*/
// database handling
$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('file.*')
->from($db->quoteName('#__eventgallery_file') . ' AS file')
->where('file.folder=' . $db->quote($this->_foldername))
->where('file.published=1')
->group('file.id');
/**
* Override the incoming sort direction if there is a setting for this folder.
*/
$tmp_sortAttribute = $this->getSortAttribute();
if (!empty($tmp_sortAttribute)) {
$sortAttribute = $tmp_sortAttribute;
}
$tmp_sortDirection = $this->getSortDirection();
if (!empty($tmp_sortDirection)) {
$sortDirection = $tmp_sortDirection;
}
$sortBy = "";
if (!empty($sortAttribute)) {
$sortBy = $db->quoteName($sortAttribute) . ' ' . (strtoupper($sortDirection) == 'ASC'?'ASC':'DESC') . ',';
}
if ($imagesForEvents == 0) {
// find files which are allowed to show in a list
$query->where('file.ismainimageonly=0')
->order($sortBy . 'ordering DESC, file.file');
} else {
// find files and sort them with the main images first
$query->order('file.ismainimage DESC, ' . $sortBy. 'ordering DESC, file.file');
}
if ($limit != 0) {
$db->setQuery($query, $limitstart, $limit);
} else {
$db->setQuery($query);
}
$entries = $db->loadObjectList();
$result = Array();
/**
* @var EventgalleryLibraryFactoryFile $fileFactory
*/
$fileFactory = EventgalleryLibraryFactoryFile::getInstance();
foreach ($entries as $entry) {
try {
$file = $fileFactory->getFile($entry->folder, $entry->file);
if (null == $file) continue;
$result[] = $file;
} catch (InvalidArgumentException $e) {
\JLog::add("EventgalleryLibraryFolder:getFiles() Could not create a file object for {$entry->folder}/{$entry->file}. Skipping it.", \JLog::INFO, 'com_eventgallery_event');
}
}
return $result;
}
/**
* @deprecated
* @return null
*/
public function getFolderTags() {
return $this->_folder->foldertags;
}
/**
* returns the tags of this folder as ucm_content objects
*
* @return array
*/
public function getTags() {
if ($this->_tags == null) {
/**
* @var EventgalleryLibraryFactoryTags $tagsFactory;
*/
$tagsFactory = EventgalleryLibraryFactoryTags::getInstance();
$this->_tags = $tagsFactory->getTagsForFolderId($this->getId());
}
return $this->_tags;
}
/**
* syncs a folder with the used data structure
*
* @param $foldername string
* @param $use_htacces_to_protect_original_files defines if we write a .htaccess file or not if applicable
*/
public static function syncFolder($foldername, $use_htacces_to_protect_original_files) {
}
/**
* returns the watermark object for this folder
*
* @return EventgalleryLibraryWatermark|null
*/
public function getWatermark() {
/**
* @var EventgalleryLibraryFactoryWatermark $watermarkFactory
* @var EventgalleryLibraryWatermark $watermark
*/
$watermarkFactory = EventgalleryLibraryFactoryWatermark::getInstance();
$watermark = $watermarkFactory->getWatermarkById($this->_folder->watermarkid);
return $watermark;
}
/**
* Returns the category id of this folder
*
* @return int|null
*/
public function getCategoryId() {
return $this->_folder->catid;
}
/**
* @return \Joomla\CMS\Categories\CategoryNode|null
*/
public function getCategory() {
if ($this->getCategoryId() == null) {
return null;
}
$categories = Joomla\CMS\Categories\Categories::getInstance('Eventgallery', $options);
return $categories->get($this->getCategoryId());
}
/**
* returns the id of the folder
* @return int
*/
public function getId() {
return $this->_folder->id;
}
/**
* returns the folder type for this folder
*
* @return EventgalleryLibraryFoldertype|null
*/
public function getFolderType() {
/**
* @var EventgalleryLibraryFactoryFoldertype $foldertypeFactory
* @var EventgalleryLibraryFoldertype $foldertype
*/
$foldertypeFactory = EventgalleryLibraryFactoryFoldertype::getInstance();
$foldertype = $foldertypeFactory->getFolderTypeById($this->_folder->foldertypeid);
return $foldertype;
}
/**
* Returns the number of hits for this folder.
* @return int
*/
public function getHits() {
return $this->_folder->hits;
}
/**
* increases the hit counter in the database
*/
public function countHits() {
/**
* @var EventgalleryTableFolder $table
*/
$table = JTable::getInstance('Folder', 'EventgalleryTable');
$table->hit($this->_folder->id);
}
/**
* returns the attribute we use to sort the files of this event.
*
* @return String
*/
public function getSortAttribute() {
return $this->_folder->sortattribute;
}
/**
* Returns the direction for sorting the files of this event
*
* @return string
*/
public function getSortDirection() {
return $this->_folder->sortdirection;
}
public function doShuffleImages() {
return $this->_folder->shuffle_images == 1;
}
/**
* This method helps to grab the user. Since this is not so easy while running in CLI mode
* this tiny method was added. Here we can code the user handly in a central place.
*
* @return JUser|null
*/
protected static function helpToGetUser() {
if (array_key_exists('REQUEST_METHOD', $_SERVER)) {
return JFactory::getUser();
}
return null;
}
public function isShareable() {
return $this->getAttribs()->get('use_social_sharing', 1) == 1;
}
public function __toString() {
return $this->getId() . ' ' . $this->getFolderName();
}
/**
* @param $tmpFilename String defines the tmp file name of the uploaded file
* @param $usFilename String the unsafe string of the original file name
* @param $user \Joomla\CMS\User\User the user who uploads the file
* @return EventgalleryLibraryFile
*/
public function uploadImageFile($tmpFilename, $usFilename, $user) {
throw new InvalidArgumentException('Unsupported Method');
}
}