140 lines
6.6 KiB
PHP
140 lines
6.6 KiB
PHP
<?php
|
|
/*************************************************************************************/
|
|
/* */
|
|
/* Thelia */
|
|
/* */
|
|
/* Copyright (c) OpenStudio */
|
|
/* email : info@thelia.net */
|
|
/* web : http://www.thelia.net */
|
|
/* */
|
|
/* 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 3 of the License */
|
|
/* */
|
|
/* 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, see <http://www.gnu.org/licenses/>. */
|
|
/* */
|
|
/*************************************************************************************/
|
|
|
|
namespace Thelia\Action;
|
|
|
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
|
|
|
use Thelia\Core\Event\DocumentEvent;
|
|
use Thelia\Model\ConfigQuery;
|
|
use Thelia\Tools\URL;
|
|
|
|
use Imagine\Document\ImagineInterface;
|
|
use Imagine\Document\DocumentInterface;
|
|
use Imagine\Document\Box;
|
|
use Imagine\Document\Color;
|
|
use Imagine\Document\Point;
|
|
use Thelia\Exception\DocumentException;
|
|
use Thelia\Core\Event\TheliaEvents;
|
|
|
|
/**
|
|
*
|
|
* Document management actions. This class handles document processing an caching.
|
|
*
|
|
* Basically, documents are stored outside the web space (by default in local/media/documents),
|
|
* and cached in the web space (by default in web/local/documents).
|
|
*
|
|
* In the documents caches directory, a subdirectory for documents categories (eg. product, category, folder, etc.) is
|
|
* automatically created, and the cached document is created here. Plugin may use their own subdirectory as required.
|
|
*
|
|
* The cached document name contains a hash of the processing options, and the original (normalized) name of the document.
|
|
*
|
|
* A copy (or symbolic link, by default) of the original document is always created in the cache, so that the full
|
|
* resolution document is always available.
|
|
*
|
|
* Various document processing options are available :
|
|
*
|
|
* - resizing, with border, crop, or by keeping document aspect ratio
|
|
* - rotation, in degrees, positive or negative
|
|
* - background color, applyed to empty background when creating borders or rotating
|
|
* - effects. The effects are applied in the specified order. The following effects are available:
|
|
* - gamma:value : change the document Gamma to the specified value. Example: gamma:0.7
|
|
* - grayscale or greyscale: switch document to grayscale
|
|
* - colorize:color : apply a color mask to the document. Exemple: colorize:#ff2244
|
|
* - negative : transform the document in its negative equivalent
|
|
* - vflip or vertical_flip : vertical flip
|
|
* - hflip or horizontal_flip : horizontal flip
|
|
*
|
|
* If a problem occurs, an DocumentException may be thrown.
|
|
*
|
|
* @package Thelia\Action
|
|
* @author Franck Allimant <franck@cqfdev.fr>
|
|
*
|
|
*/
|
|
class Document extends BaseCachedFile implements EventSubscriberInterface
|
|
{
|
|
/**
|
|
* @return string root of the document cache directory in web space
|
|
*/
|
|
protected function getCacheDirFromWebRoot() {
|
|
return ConfigQuery::read('document_cache_dir_from_web_root', 'cache');
|
|
}
|
|
|
|
/**
|
|
* Process document and write the result in the document cache.
|
|
*
|
|
* When the original document is required, create either a symbolic link with the
|
|
* original document in the cache dir, or copy it in the cache dir if it's not already done.
|
|
*
|
|
* This method updates the cache_file_path and file_url attributes of the event
|
|
*
|
|
* @param DocumentEvent $event
|
|
* @throws \InvalidArgumentException, DocumentException
|
|
*/
|
|
public function processDocument(DocumentEvent $event)
|
|
{
|
|
$subdir = $event->getCacheSubdirectory();
|
|
$source_file = $event->getSourceFilepath();
|
|
|
|
if (null == $subdir || null == $source_file) {
|
|
throw new \InvalidArgumentException("Cache sub-directory and source file path cannot be null");
|
|
}
|
|
|
|
$originalDocumentPathInCache = $this->getCacheFilePath($subdir, $source_file, true);
|
|
|
|
if (! file_exists($originalDocumentPathInCache)) {
|
|
|
|
if (! file_exists($source_file)) {
|
|
throw new DocumentException(sprintf("Source document file %s does not exists.", $source_file));
|
|
}
|
|
|
|
$mode = ConfigQuery::read('original_document_delivery_mode', 'symlink');
|
|
|
|
if ($mode == 'symlink') {
|
|
if (false == symlink($source_file, $originalDocumentPathInCache)) {
|
|
throw new DocumentException(sprintf("Failed to create symbolic link for %s in %s document cache directory", basename($source_file), $subdir));
|
|
}
|
|
} else {// mode = 'copy'
|
|
if (false == @copy($source_file, $originalDocumentPathInCache)) {
|
|
throw new DocumentException(sprintf("Failed to copy %s in %s document cache directory", basename($source_file), $subdir));
|
|
}
|
|
}
|
|
}
|
|
|
|
// Compute the document URL
|
|
$document_url = $this->getCacheFileURL($subdir, basename($originalDocumentPathInCache));
|
|
|
|
// Update the event with file path and file URL
|
|
$event->setDocumentPath($originalDocumentPathInCache);
|
|
$event->setDocumentUrl(URL::getInstance()->absoluteUrl($document_url, null, URL::PATH_TO_FILE));
|
|
}
|
|
|
|
public static function getSubscribedEvents()
|
|
{
|
|
return array(
|
|
TheliaEvents::DOCUMENT_PROCESS => array("processDocument", 128),
|
|
TheliaEvents::DOCUMENT_CLEAR_CACHE => array("clearCache", 128),
|
|
);
|
|
}
|
|
}
|