/**
* Creates a config instance from the specified config. It will use various config options
* for setting up a filter instance. This is a helper function.
*
* @param MOXMAN_Util_Config $config Config instance to get settings from.
* @param String $prefix Prefix of subfilter for example "edit"
* @return MOXMAN_Vfs_CombinedFileFilter Basic file filter instance based on config.
*/
public static function createFromConfig(MOXMAN_Util_Config $config, $prefix)
{
$filter1 = new MOXMAN_Vfs_BasicFileFilter();
$filter1->setIncludeDirectoryPattern($config->get('filesystem.include_directory_pattern'));
$filter1->setExcludeDirectoryPattern($config->get('filesystem.exclude_directory_pattern'));
$filter1->setIncludeFilePattern($config->get('filesystem.include_file_pattern'));
$filter1->setExcludeFilePattern($config->get('filesystem.exclude_file_pattern'));
$filter1->setIncludeExtensions($config->get('filesystem.extensions'));
$filter1->setExcludeFiles($config->get('filesystem.local.access_file_name'));
$filter2 = new MOXMAN_Vfs_BasicFileFilter();
$filter2->setIncludeDirectoryPattern($config->get($prefix . '.include_directory_pattern'));
$filter2->setExcludeDirectoryPattern($config->get($prefix . '.exclude_directory_pattern'));
$filter2->setIncludeFilePattern($config->get($prefix . '.include_file_pattern'));
$filter2->setExcludeFilePattern($config->get($prefix . '.exclude_file_pattern'));
$filter2->setIncludeExtensions($config->get($prefix . '.extensions'));
$filter = new MOXMAN_Vfs_CombinedFileFilter();
$filter->addFilter($filter1);
$filter->addFilter($filter2);
return $filter;
}
/**
* Converts a file instance to a JSON serializable object.
*
* @param MOXMAN_Vfs_IFile $file File to convert into JSON format.
* @param Boolean $meta State if the meta data should be returned or not.
* @return stdClass JSON serializable object.
*/
public static function fileToJson($file, $meta = false)
{
$config = $file->getConfig();
$renameFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($config, "rename");
$editFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($config, "edit");
$viewFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($config, "view");
$configuredFilter = new MOXMAN_Vfs_BasicFileFilter();
$configuredFilter->setIncludeDirectoryPattern($config->get('filesystem.include_directory_pattern'));
$configuredFilter->setExcludeDirectoryPattern($config->get('filesystem.exclude_directory_pattern'));
$configuredFilter->setIncludeFilePattern($config->get('filesystem.include_file_pattern'));
$configuredFilter->setExcludeFilePattern($config->get('filesystem.exclude_file_pattern'));
$configuredFilter->setIncludeExtensions($config->get('filesystem.extensions'));
$result = (object) array("path" => $file->getPublicPath(), "size" => $file->getSize(), "lastModified" => $file->getLastModified(), "isFile" => $file->isFile(), "canRead" => $file->canRead(), "canWrite" => $file->canWrite(), "canEdit" => $file->isFile() && $editFilter->accept($file), "canRename" => $renameFilter->accept($file), "canView" => $file->isFile() && $viewFilter->accept($file), "canPreview" => $file->isFile() && MOXMAN_Media_ImageAlter::canEdit($file), "visible" => $configuredFilter->accept($file), "exists" => $file->exists());
if ($meta) {
$args = new MOXMAN_Vfs_CustomInfoEventArgs(MOXMAN_Vfs_CustomInfoEventArgs::INSERT_TYPE, $file);
MOXMAN::getPluginManager()->get("core")->fire("CustomInfo", $args);
$metaData = (object) array_merge($file->getMetaData()->getAll(), $args->getInfo());
if (MOXMAN_Media_ImageAlter::canEdit($file)) {
$thumbnailFolderPath = MOXMAN_Util_PathUtils::combine($file->getParent(), $config->get('thumbnail.folder'));
$thumbnailFile = MOXMAN::getFile($thumbnailFolderPath, $config->get('thumbnail.prefix') . $file->getName());
// TODO: Implement stat info cache layer here
if ($file instanceof MOXMAN_Vfs_Local_File) {
$info = MOXMAN_Media_MediaInfo::getInfo($file->getPath());
$metaData->width = $info["width"];
$metaData->height = $info["height"];
}
if ($thumbnailFile->exists()) {
$metaData->thumb_url = $thumbnailFile->getUrl();
// Get image size server side only on local filesystem
if ($file instanceof MOXMAN_Vfs_Local_File) {
$info = MOXMAN_Media_MediaInfo::getInfo($thumbnailFile->getPath());
$metaData->thumb_width = $info["width"];
$metaData->thumb_height = $info["height"];
}
}
}
$metaData->url = $file->getUrl();
$result->meta = $metaData;
}
return $result;
}
/**
* Executes the command logic with the specified RPC parameters.
*
* @param Object $params Command parameters sent from client.
* @return Object Result object to be passed back to client.
*/
public function execute($params)
{
$url = isset($params->url) ? $params->url : "";
$path = isset($params->path) ? $params->path : "{default}";
$lastPath = isset($params->lastPath) ? $params->lastPath : "";
$offset = isset($params->offset) ? $params->offset : 0;
$length = isset($params->length) ? $params->length : null;
$orderBy = isset($params->orderBy) ? $params->orderBy : "name";
$desc = isset($params->desc) ? $params->desc : false;
// Result URL to closest file
$file = null;
if ($url) {
try {
$file = MOXMAN::getFile($url);
} catch (MOXMAN_Exception $e) {
// Might throw exception ignore it
$file = null;
}
if ($file) {
if ($file->exists()) {
$urlFile = $file;
}
while (!$file->exists() || !$file->isDirectory()) {
$file = $file->getParentFile();
}
}
}
// Resolve lastPath input
if ($lastPath && !$file) {
try {
$file = MOXMAN::getFile($lastPath);
} catch (MOXMAN_Exception $e) {
// Might throw exception ignore it
$file = null;
}
if ($file) {
while (!$file->exists() || !$file->isDirectory()) {
$file = $file->getParentFile();
}
}
}
$file = $file ? $file : MOXMAN::getFile($path);
// Force update on cached file info
if (isset($params->force) && $params->force) {
MOXMAN_Vfs_Cache_FileInfoStorage::getInstance()->updateFileList($file);
}
if (!$file->isDirectory()) {
throw new MOXMAN_Exception("Path isn't a directory: " . $file->getPublicPath(), MOXMAN_Exception::INVALID_FILE_TYPE);
}
$config = $file->getConfig();
// Setup input file filter
$paramsFileFilter = new MOXMAN_Vfs_BasicFileFilter();
if (isset($params->include_directory_pattern) && $params->include_directory_pattern) {
$paramsFileFilter->setIncludeDirectoryPattern($params->include_directory_pattern);
}
if (isset($params->exclude_directory_pattern) && $params->exclude_directory_pattern) {
$paramsFileFilter->setExcludeDirectoryPattern($params->exclude_directory_pattern);
}
if (isset($params->include_file_pattern) && $params->include_file_pattern) {
$paramsFileFilter->setIncludeFilePattern($params->include_file_pattern);
}
if (isset($params->exclude_file_pattern) && $params->exclude_file_pattern) {
$paramsFileFilter->setExcludeFilePattern($params->exclude_file_pattern);
}
if (isset($params->extensions) && $params->extensions) {
$paramsFileFilter->setIncludeExtensions($params->extensions);
}
if (isset($params->filter) && $params->filter != null) {
$paramsFileFilter->setIncludeWildcardPattern($params->filter);
}
if (isset($params->only_dirs) && $params->only_dirs === true) {
$paramsFileFilter->setOnlyDirs(true);
}
if (isset($params->only_files) && $params->only_files === true) {
$paramsFileFilter->setOnlyFiles(true);
}
// Setup file filter
$configuredFilter = new MOXMAN_Vfs_BasicFileFilter();
$configuredFilter->setIncludeDirectoryPattern($config->get('filesystem.include_directory_pattern'));
$configuredFilter->setExcludeDirectoryPattern($config->get('filesystem.exclude_directory_pattern'));
$configuredFilter->setIncludeFilePattern($config->get('filesystem.include_file_pattern'));
$configuredFilter->setExcludeFilePattern($config->get('filesystem.exclude_file_pattern'));
$configuredFilter->setIncludeExtensions($config->get('filesystem.extensions'));
// Setup combined filter
$combinedFilter = new MOXMAN_Vfs_CombinedFileFilter();
$combinedFilter->addFilter($paramsFileFilter);
$combinedFilter->addFilter($configuredFilter);
$files = $file->listFilesFiltered($combinedFilter)->limit($offset, $length)->orderBy($orderBy, $desc);
$args = $this->fireFilesAction(MOXMAN_Vfs_FileActionEventArgs::LIST_FILES, $file, $files);
$files = $args->getFileList();
$renameFilter = MOXMAN_Vfs_BasicFileFilter::createFromConfig($file->getConfig(), "rename");
$editFilter = MOXMAN_Vfs_BasicFileFilter::createFromConfig($file->getConfig(), "edit");
$viewFilter = MOXMAN_Vfs_BasicFileFilter::createFromConfig($file->getConfig(), "view");
// List thumbnails and make lookup table
$thumbnails = array();
$thumbnailFolder = $config->get("thumbnail.folder");
$thumbnailPrefix = $config->get("thumbnail.prefix");
if ($config->get('thumbnail.enabled')) {
$thumbFolderFile = MOXMAN::getFile($file->getPath(), $thumbnailFolder);
// Force update on cached file info
if (isset($params->force) && $params->force) {
MOXMAN_Vfs_Cache_FileInfoStorage::getInstance()->updateFileList($thumbFolderFile);
}
if ($file instanceof MOXMAN_Vfs_Local_File === false) {
$hasThumbnails = false;
foreach ($files as $subFile) {
if (MOXMAN_Media_ImageAlter::canEdit($subFile)) {
$hasThumbnails = true;
break;
}
}
if ($hasThumbnails) {
$thumbFiles = $thumbFolderFile->listFilesFiltered($combinedFilter)->limit($offset, $length)->orderBy($orderBy, $desc);
foreach ($thumbFiles as $thumbFile) {
$thumbnails[$thumbFile->getName()] = true;
}
}
} else {
// Stat individual files on local fs faster than listing 1000 files
$fileSystem = $thumbFolderFile->getFileSystem();
foreach ($files as $subFile) {
if (MOXMAN_Media_ImageAlter::canEdit($subFile)) {
$thumbFile = $fileSystem->getFile(MOXMAN_Util_PathUtils::combine($thumbFolderFile->getPath(), $thumbnailPrefix . $subFile->getName()));
if ($thumbFile->exists()) {
$thumbnails[$thumbFile->getName()] = true;
}
}
}
}
}
$result = (object) array("columns" => array("name", "size", "modified", "attrs", "info"), "config" => $this->getPublicConfig($file), "file" => $this->fileToJson($file, true), "urlFile" => isset($urlFile) ? $this->fileToJson($urlFile, true) : null, "data" => array(), "url" => $file->getUrl(), "thumbnailFolder" => $thumbnailFolder, "thumbnailPrefix" => $thumbnailPrefix, "total" => $files->getCount());
foreach ($files as $subFile) {
$attrs = $subFile->isDirectory() ? "d" : "-";
$attrs .= $subFile->canRead() ? "r" : "-";
$attrs .= $subFile->canWrite() ? "w" : "-";
$attrs .= $renameFilter->accept($subFile) ? "r" : "-";
$attrs .= $subFile->isFile() && $editFilter->accept($subFile) ? "e" : "-";
$attrs .= $subFile->isFile() && $viewFilter->accept($subFile) ? "v" : "-";
$attrs .= $subFile->isFile() && MOXMAN_Media_ImageAlter::canEdit($subFile) ? "p" : "-";
$attrs .= isset($thumbnails[$thumbnailPrefix . $subFile->getName()]) ? "t" : "-";
$args = $this->fireCustomInfo(MOXMAN_Vfs_CustomInfoEventArgs::LIST_TYPE, $subFile);
$custom = (object) $args->getInfo();
if ($subFile->getPublicLinkPath()) {
$custom->link = $subFile->getPublicLinkPath();
}
$result->data[] = array($subFile->getName(), $subFile->isDirectory() ? 0 : $subFile->getSize(), $subFile->getLastModified(), $attrs, $custom);
}
return $result;
}
/**
* Executes the command logic with the specified RPC parameters.
*
* @param Object $params Command parameters sent from client.
* @return Object Result object to be passed back to client.
*/
public function execute($params)
{
$url = isset($params->url) ? $params->url : '';
$path = isset($params->path) ? $params->path : '{default}';
// Result URL to closest file
$file = null;
if ($url) {
try {
$file = MOXMAN::getFile($url);
} catch (MOXMAN_Exception $e) {
// Might throw exception ignore it
$file = null;
}
if ($file) {
if ($file->exists()) {
$urlFile = $file;
}
while (!$file->exists() || !$file->isDirectory()) {
$file = $file->getParentFile();
}
}
}
$file = $file ? $file : MOXMAN::getFile($path);
if (!$file->isDirectory()) {
throw new MOXMAN_Exception("Path isn't a directory: " . $file->getPublicPath(), MOXMAN_Exception::INVALID_FILE_TYPE);
}
$config = $file->getConfig();
// Setup input file filter
$paramsFileFilter = new MOXMAN_Vfs_BasicFileFilter();
if (isset($params->include_directory_pattern) && $params->include_directory_pattern) {
$paramsFileFilter->setIncludeDirectoryPattern($params->include_directory_pattern);
}
if (isset($params->exclude_directory_pattern) && $params->exclude_directory_pattern) {
$paramsFileFilter->setExcludeDirectoryPattern($params->exclude_directory_pattern);
}
if (isset($params->include_file_pattern) && $params->include_file_pattern) {
$paramsFileFilter->setIncludeFilePattern($params->include_file_pattern);
}
if (isset($params->exclude_file_pattern) && $params->exclude_file_pattern) {
$paramsFileFilter->setExcludeFilePattern($params->exclude_file_pattern);
}
if (isset($params->extensions) && $params->extensions) {
$paramsFileFilter->setIncludeExtensions($params->extensions);
}
if (isset($params->filter) && $params->filter != null) {
$paramsFileFilter->setIncludeWildcardPattern($params->filter);
}
if (isset($params->only_dirs) && $params->only_dirs === true) {
$paramsFileFilter->setOnlyDirs(true);
}
if (isset($params->only_files) && $params->only_files === true) {
$paramsFileFilter->setOnlyFiles(true);
}
// Setup file filter
$configuredFilter = new MOXMAN_Vfs_BasicFileFilter();
$configuredFilter->setIncludeDirectoryPattern($config->get('filesystem.include_directory_pattern'));
$configuredFilter->setExcludeDirectoryPattern($config->get('filesystem.exclude_directory_pattern'));
$configuredFilter->setIncludeFilePattern($config->get('filesystem.include_file_pattern'));
$configuredFilter->setExcludeFilePattern($config->get('filesystem.exclude_file_pattern'));
$configuredFilter->setIncludeExtensions($config->get('filesystem.extensions'));
// Setup combined filter
$combinedFilter = new MOXMAN_Vfs_CombinedFileFilter();
$combinedFilter->addFilter($paramsFileFilter);
$combinedFilter->addFilter($configuredFilter);
$files = $file->listFilesFiltered($combinedFilter);
$args = $this->fireFilesAction(MOXMAN_Core_FileActionEventArgs::LIST_FILES, $file, $files);
$files = $args->getFileList();
$renameFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($file->getConfig(), "rename");
$editFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($file->getConfig(), "edit");
$viewFilter = MOXMAN_Vfs_CombinedFileFilter::createFromConfig($file->getConfig(), "view");
$result = (object) array("columns" => array("name", "size", "modified", "attrs", "info"), "config" => $this->getPublicConfig($file), "file" => $this->fileToJson($file, true), "urlFile" => isset($urlFile) ? $this->fileToJson($urlFile, true) : null, "data" => array());
foreach ($files as $subFile) {
$attrs = $subFile->isDirectory() ? "d" : "-";
$attrs .= $subFile->canRead() ? "r" : "-";
$attrs .= $subFile->canWrite() ? "w" : "-";
$attrs .= $renameFilter->accept($subFile) === MOXMAN_Vfs_CombinedFileFilter::ACCEPTED ? "r" : "-";
$attrs .= $subFile->isFile() && $editFilter->accept($subFile) === MOXMAN_Vfs_CombinedFileFilter::ACCEPTED ? "e" : "-";
$attrs .= $subFile->isFile() && $viewFilter->accept($subFile) === MOXMAN_Vfs_CombinedFileFilter::ACCEPTED ? "v" : "-";
$attrs .= $subFile->isFile() && MOXMAN_Media_ImageAlter::canEdit($subFile) ? "p" : "-";
$args = $this->fireCustomInfo(MOXMAN_Core_CustomInfoEventArgs::LIST_TYPE, $subFile);
$custom = (object) $args->getInfo();
if ($subFile->getPublicLinkPath()) {
$custom->link = $subFile->getPublicLinkPath();
}
$result->data[] = array($subFile->getName(), $subFile->isDirectory() ? 0 : $subFile->getSize(), $subFile->getLastModified(), $attrs, $custom);
}
return $result;
}
