Files
Phraseanet/lib/Alchemy/Phrasea/Controller/Prod/Lazaret.php
2013-01-17 11:43:32 +01:00

541 lines
18 KiB
PHP

<?php
/*
* This file is part of Phraseanet
*
* (c) 2005-2012 Alchemy
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Alchemy\Phrasea\Controller\Prod;
use Entities\LazaretFile;
use Alchemy\Phrasea\Border;
use Alchemy\Phrasea\Border\Attribute\AttributeInterface;
use Silex\Application;
use Silex\ControllerProviderInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Filesystem\Exception\IOException;
/**
* Lazaret controller collection
*
* Defines routes related to the lazaret (quarantine) functionality
*
* @license http://opensource.org/licenses/gpl-3.0 GPLv3
* @link www.phraseanet.com
*/
class Lazaret implements ControllerProviderInterface
{
/**
* Connect the ControllerCollection to the Silex Application
*
* @param Application $app A silex application
* @return \Silex\ControllerCollection
*/
public function connect(Application $app)
{
$controllers = $app['controllers_factory'];
$controllers->before(function(Request $request) use ($app) {
$app['firewall']->requireAuthentication()
->requireRight('addrecord');
});
/**
* Lazaret Elements route
*
* name : lazaret_elements
*
* description : List all lazaret elements
*
* method : GET
*
* parameters : 'offset' int (optional) default 0 : List offset
* 'limit' int (optional) default 10 : List limit
*
* return : HTML Response
*/
$controllers->get('/', $this->call('listElement'))
->bind('lazaret_elements');
/**
* Lazaret Element route
*
* name : lazaret_element
*
* descritpion : Get one lazaret element identified by {file_id} parameter
*
* method : GET
*
* return : JSON Response
*/
$controllers->get('/{file_id}/', $this->call('getElement'))
->assert('file_id', '\d+')
->bind('lazaret_element');
/**
* Lazaret Force Add route
*
* name : lazaret_force_add
*
* description : Move a lazaret element identified by {file_id} parameter into phraseanet
*
* method : POST
*
* parameters : 'bas_id' int (mandatory) : The id of the destination collection
* 'keep_attributes' boolean (optional) : Keep all attributes attached to the lazaret element
* 'attributes' array (optional) : Attributes id's to attach to the lazaret element
*
* return : JSON Response
*/
$controllers->post('/{file_id}/force-add/', $this->call('addElement'))
->assert('file_id', '\d+')
->bind('lazaret_force_add');
/**
* Lazaret Deny route
*
* name : lazaret_deny_element
*
* description : Remove a lazaret element identified by {file_id} parameter
*
* method : POST
*
* return : JSON Response
*/
$controllers->post('/{file_id}/deny/', $this->call('denyElement'))
->assert('file_id', '\d+')
->bind('lazaret_deny_element');
/**
* Lazaret Empty route
*
* name : lazaret_empty
*
* description : Empty the lazaret
*
* method : POST
*
* return : JSON Response
*/
$controllers->post('/empty/', $this->call('emptyLazaret'))
->bind('lazaret_empty');
/**
* Lazaret Accept Route
*
* name : lazaret_accept
*
* description : Substitute the phraseanet record identified by
* the post parameter 'record_id'by the lazaret element identified
* by {file_id} parameter
*
* method : POST
*
* parameters : 'record_id' int (mandatory) : The substitued record
*
* return : JSON Response
*/
$controllers->post('/{file_id}/accept/', $this->call('acceptElement'))
->assert('file_id', '\d+')
->bind('lazaret_accept');
/**
* Lazaret Thumbnail route
*
* name : lazaret_thumbnail
*
* descritpion : Get the thumbnail attached to the lazaret element
* identified by {file_id} parameter
*
* method : GET
*
* return : JSON Response
*/
$controllers->get('/{file_id}/thumbnail/', $this->call('thumbnailElement'))
->assert('file_id', '\d+')
->bind('lazaret_thumbnail');
return $controllers;
}
/**
* List all elements in lazaret
*
* @param Application $app A Silex application
* @param Request $request The current request
*
* @return Response
*/
public function listElement(Application $app, Request $request)
{
$baseIds = array_keys($app['phraseanet.user']->ACL()->get_granted_base(array('canaddrecord')));
$lazaretFiles = null;
if (count($baseIds) > 0) {
$lazaretRepository = $app['EM']->getRepository('Entities\LazaretFile');
$lazaretFiles = $lazaretRepository->findPerPage(
$baseIds, $request->query->get('offset', 0), $request->query->get('limit', 10)
);
}
return $app['twig']->render(
'prod/upload/lazaret.html.twig', array('lazaretFiles' => $lazaretFiles)
);
}
/**
* Get one lazaret Element
*
* @param Application $app A Silex application
* @param Request $request The current request
* @param int $file_id A lazaret element id
*
* @return Response
*/
public function getElement(Application $app, Request $request, $file_id)
{
$ret = array('success' => false, 'message' => '', 'result' => array());
$lazaretFile = $app['EM']->find('Entities\LazaretFile', $file_id);
/* @var $lazaretFile \Entities\LazaretFile */
if (null === $lazaretFile) {
$ret['message'] = _('File is not present in quarantine anymore, please refresh');
return $app->json($ret);
}
$file = array(
'filename' => $lazaretFile->getOriginalName(),
'base_id' => $lazaretFile->getBaseId(),
'created' => $lazaretFile->getCreated()->format(\DateTime::ATOM),
'updated' => $lazaretFile->getUpdated()->format(\DateTime::ATOM),
'pathname' => $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getFilename(),
'sha256' => $lazaretFile->getSha256(),
'uuid' => $lazaretFile->getUuid(),
);
$ret['result'] = $file;
$ret['success'] = true;
return $app->json($ret);
}
/**
* Add an element to phraseanet
*
* @param Application $app A Silex application
* @param Request $request The current request
* @param int $file_id A lazaret element id
*
* @return Response
*/
public function addElement(Application $app, Request $request, $file_id)
{
$ret = array('success' => false, 'message' => '', 'result' => array());
//Optional parameter
$keepAttributes = !!$request->request->get('keep_attributes', false);
$attributesToKeep = $request->request->get('attributes', array());
//Mandatory parameter
if (null === $baseId = $request->request->get('bas_id')) {
$ret['message'] = _('You must give a destination collection');
return $app->json($ret);
}
$lazaretFile = $app['EM']->find('Entities\LazaretFile', $file_id);
/* @var $lazaretFile \Entities\LazaretFile */
if (null === $lazaretFile) {
$ret['message'] = _('File is not present in quarantine anymore, please refresh');
return $app->json($ret);
}
$lazaretFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getFilename();
$lazaretThumbFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getThumbFilename();
try {
$borderFile = Border\File::buildFromPathfile(
$lazaretFileName, $lazaretFile->getCollection($app), $app, $lazaretFile->getOriginalName()
);
$record = null;
/* @var $record \record_adapter */
//Post record creation
$callBack = function($element, $visa, $code) use (&$record) {
$record = $element;
};
//Force creation record
$app['border-manager']->process(
$lazaretFile->getSession(), $borderFile, $callBack, Border\Manager::FORCE_RECORD
);
$app['phraseanet.SE']->addRecord($record);
if ($keepAttributes) {
//add attribute
$metaFields = new Border\MetaFieldsBag();
$metadataBag = new Border\MetadataBag();
foreach ($lazaretFile->getAttributes() as $attr) {
//Check which ones to keep
if (!!count($attributesToKeep)) {
if (!in_array($attr->getId(), $attributesToKeep)) {
continue;
}
}
try {
$attribute = Border\Attribute\Factory::getFileAttribute($app, $attr->getName(), $attr->getValue());
} catch (\InvalidArgumentException $e) {
continue;
}
/* @var $attribute AttributeInterface */
switch ($attribute->getName()) {
case AttributeInterface::NAME_METADATA:
$value = $attribute->getValue();
$metadataBag->set($value->getTag()->getTagname(), new \PHPExiftool\Driver\Metadata\Metadata($value->getTag(), $value->getValue()));
break;
case AttributeInterface::NAME_STORY:
$attribute->getValue()->appendChild($record);
break;
case AttributeInterface::NAME_STATUS:
$record->set_binary_status($attribute->getValue());
break;
case AttributeInterface::NAME_METAFIELD:
$metaFields->set($attribute->getField()->get_name(), $attribute->getValue());
break;
}
}
$datas = $metadataBag->toMetadataArray($record->get_databox()->get_meta_structure());
$record->set_metadatas($datas);
$fields = $metaFields->toMetadataArray($record->get_databox()->get_meta_structure());
$record->set_metadatas($fields);
}
//Delete lazaret file
$app['EM']->remove($lazaretFile);
$app['EM']->flush();
$ret['success'] = true;
} catch (\Exception $e) {
$ret['message'] = _('An error occured');
}
try {
$app['filesystem']->remove(array($lazaretFileName, $lazaretThumbFileName));
} catch (IOException $e) {
}
return $app->json($ret);
}
/**
* Delete a lazaret element
*
* @param Application $app A Silex application where the controller is mounted on
* @param Request $request The current request
* @param int $file_id A lazaret element id
*
* @return Response
*/
public function denyElement(Application $app, Request $request, $file_id)
{
$ret = array('success' => false, 'message' => '', 'result' => array());
$lazaretFile = $app['EM']->find('Entities\LazaretFile', $file_id);
/* @var $lazaretFile \Entities\LazaretFile */
if (null === $lazaretFile) {
$ret['message'] = _('File is not present in quarantine anymore, please refresh');
return $app->json($ret);
}
try {
$this->denyLazaretFile($app, $lazaretFile);
$ret['success'] = true;
} catch (\Exception $e) {
}
return $app->json($ret);
}
protected function denyLazaretFile(Application $app, LazaretFile $lazaretFile)
{
$lazaretFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getFilename();
$lazaretThumbFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getThumbFilename();
$app['EM']->remove($lazaretFile);
$app['EM']->flush();
try {
$app['filesystem']->remove(array($lazaretFileName, $lazaretThumbFileName));
} catch (IOException $e) {
}
return $this;
}
/**
* Empty lazaret
*
* @param Application $app
* @param Request $request
*
* @return Response
*/
public function emptyLazaret(Application $app, Request $request)
{
$ret = array('success' => false, 'message' => '', 'result' => array());
$lazaretFiles = $app['EM']->getRepository('Entities\LazaretFile')->findAll();
$app['EM']->beginTransaction();
try {
foreach ($lazaretFiles as $lazaretFile) {
$this->denyLazaretFile($app, $lazaretFile);
}
$app['EM']->commit();
$ret['success'] = true;
} catch (\Exception $e) {
$app['EM']->rollback();
$ret['message'] = _('An error occured');
}
return $app->json($ret);
}
/**
* Substitute a record element by a lazaret element
*
* @param Application $app A Silex application where the controller is mounted on
* @param Request $request The current request
* @param int $file_id A lazaret element id
*
* @return Response
*/
public function acceptElement(Application $app, Request $request, $file_id)
{
$ret = array('success' => false, 'message' => '', 'result' => array());
//Mandatory parameter
if (null === $recordId = $request->request->get('record_id')) {
$ret['message'] = _('You must give a destination record');
return $app->json($ret);
}
$lazaretFile = $app['EM']->find('Entities\LazaretFile', $file_id);
/* @var $lazaretFile \Entities\LazaretFile */
if (null === $lazaretFile) {
$ret['message'] = _('File is not present in quarantine anymore, please refresh');
return $app->json($ret);
}
$found = false;
//Check if the choosen record is eligible to the substitution
foreach ($lazaretFile->getRecordsToSubstitute($app) as $record) {
if ($record->get_record_id() !== (int) $recordId) {
continue;
}
$found = true;
break;
}
if (!$found) {
$ret['message'] = _('The destination record provided is not allowed');
return $app->json($ret);
}
$lazaretFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getFilename();
$lazaretThumbFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getThumbFilename();
try {
$media = $app['mediavorus']->guess($lazaretFileName);
$record = $lazaretFile->getCollection($app)->get_databox()->get_record($recordId);
$record->substitute_subdef('document', $media, $app);
//Delete lazaret file
$app['EM']->remove($lazaretFile);
$app['EM']->flush();
$ret['success'] = true;
} catch (\Exception $e) {
$ret['message'] = _('An error occured');
}
try {
$app['filesystem']->remove(array($lazaretFileName, $lazaretThumbFileName));
} catch (IOException $e) {
}
return $app->json($ret);
}
/**
* Get the associated lazaret element thumbnail
*
* @param Application $app A Silex application where the controller is mounted on
* @param Request $request The current request
* @param int $file_id A lazaret element id
*
* @return Response
*/
public function thumbnailElement(Application $app, Request $request, $file_id)
{
$lazaretFile = $app['EM']->find('Entities\LazaretFile', $file_id);
/* @var $lazaretFile \Entities\LazaretFile */
if (null === $lazaretFile) {
return new Response(null, 404);
}
$lazaretThumbFileName = $app['phraseanet.registry']->get('GV_RootPath') . 'tmp/lazaret/' . $lazaretFile->getThumbFilename();
return \set_export::stream_file(
$app, $lazaretThumbFileName, $lazaretFile->getOriginalName(), 'image/jpeg', 'inline'
);
}
/**
* Prefix the method to call with the controller class name
*
* @param string $method The method to call
* @return string
*/
private function call($method)
{
return sprintf('%s::%s', __CLASS__, $method);
}
}