hazza/Phraseanet
1
0
Fork 0
mirror of https://github.com/alchemy-fr/Phraseanet.git synced 2025-10-16 22:43:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3841 from alchemy-fr/PHRAS-3499_stamper-in-download-worker

Browse Source 
PHRAS-3499 merge stamper in download worker
This commit is contained in:
Nicolas Maillat
2021-09-07 17:09:24 +02:00
committed by GitHub
parent 88a6506ded f305528cf8
commit 94e71d3e68
10 changed files with 156 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
config/configuration.sample.yml
View File

@@ -235,6 +235,8 @@ registry:
api-clients:
api-require-ssl: false
api-auth-token-header-only: false
actions:
export-stamp-choice: false
crossdomain:
site-control: 'master-only'
allow-access-from:

4
lib/Alchemy/Phrasea/Controller/AbstractDelivery.php
View File

@@ -91,7 +91,9 @@ abstract class AbstractDelivery
if ($watermark === true && $mediaSubdefinition->get_type() === \media_subdef::TYPE_IMAGE) {
$pathOut = \recordutils_image::watermark($this->app, $mediaSubdefinition);
} elseif ($stamp === true && $mediaSubdefinition->get_type() === \media_subdef::TYPE_IMAGE) {
$pathOut = \recordutils_image::stamp($this->app, $mediaSubdefinition);
if( !is_null($newPath = \recordutils_image::stamp($this->app, $mediaSubdefinition)) ) {
$pathOut = $newPath;
}
}
return $pathOut;

3
lib/Alchemy/Phrasea/Controller/Prod/DownloadController.php
View File

@@ -44,7 +44,8 @@ class DownloadController extends Controller
$this->app['filesystem'],
$subdefs,
$request->request->get('type') === 'title' ? true : false,
$request->request->get('businessfields')
$request->request->get('businessfields'),
$request->request->get('stamp_choice') === "NO_STAMP" ? \set_export::NO_STAMP : \set_export::STAMP_SYNC
);
$list['export_name'] = sprintf('%s.zip', $download->getExportName());

13
lib/Alchemy/Phrasea/Controller/Prod/ExportController.php
View File

@@ -9,7 +9,6 @@
*/
namespace Alchemy\Phrasea\Controller\Prod;
use Alchemy\Phrasea\Application;
use Alchemy\Phrasea\Application\Helper\DispatcherAware;
use Alchemy\Phrasea\Application\Helper\FilesystemAware;
use Alchemy\Phrasea\Application\Helper\NotifierAware;
@@ -17,11 +16,7 @@ use Alchemy\Phrasea\Controller\Controller;
use Alchemy\Phrasea\Core\Event\ExportFailureEvent;
use Alchemy\Phrasea\Core\Event\ExportMailEvent;
use Alchemy\Phrasea\Core\PhraseaEvents;
use Alchemy\Phrasea\Exception\InvalidArgumentException;
use Alchemy\Phrasea\Model\Manipulator\TokenManipulator;
use Alchemy\Phrasea\Notification\Emitter;
use Alchemy\Phrasea\Notification\Mail\MailRecordsExport;
use Alchemy\Phrasea\Notification\Receiver;
use Alchemy\Phrasea\WorkerManager\Event\ExportFtpEvent;
use Alchemy\Phrasea\WorkerManager\Event\WorkerEvents;
use Symfony\Component\HttpFoundation\JsonResponse;
@@ -118,8 +113,9 @@ class ExportController extends Controller
$this->getFilesystem(),
$request->request->get('obj'),
false,
$request->request->get('businessfields')
);
$request->request->get('businessfields'),
$request->request->get('stamp_choice') === "NO_STAMP" ? \set_export::NO_STAMP : \set_export::STAMP_ASYNC
);
$exportFtpId = $download->export_ftp(
$request->request->get('user_dest'),
@@ -171,7 +167,8 @@ class ExportController extends Controller
$this->getFilesystem(),
(array) $request->request->get('obj'),
$request->request->get("type") == "title" ? : false,
$request->request->get('businessfields')
$request->request->get('businessfields'),
$request->request->get('stamp_choice') === "NO_STAMP" ? \set_export::NO_STAMP : \set_export::STAMP_ASYNC
);
$list['export_name'] = sprintf("%s.zip", $download->getExportName());

1
lib/Alchemy/Phrasea/Core/Configuration/RegistryFormManipulator.php
View File

@@ -128,6 +128,7 @@ class RegistryFormManipulator
'force-push-authentication' => false,
'enable-feed-notification' => true,
'download-link-validity' => 24,
'export-stamp-choice' => false,
],
'ftp' => [
'ftp-enabled' => false,

2
lib/Alchemy/Phrasea/Order/Controller/ApiOrderController.php
View File

@@ -189,7 +189,7 @@ class ApiOrderController extends BaseOrderController
$subdefs = $this->findDataboxSubdefNames();
try {
$exportData = $export->prepare_export($user, $this->getFilesystem(), $subdefs, true, true);
$exportData = $export->prepare_export($user, $this->getFilesystem(), $subdefs, true, true, false);
}
catch (\Exception $e) {
throw new NotFoundHttpException(sprintf('No archive could be downloaded for Order "%d"', $order->getId()));

24
lib/Alchemy/Phrasea/WorkerManager/Worker/ExportMailWorker.php
View File

@@ -81,6 +81,30 @@ class ExportMailWorker implements WorkerInterface
$list = unserialize($token->getData());
foreach($list['files'] as $k_file => $v_file) {
foreach($v_file['subdefs'] as $k_subdef => $v_subdef) {
if($k_subdef === "document" && $v_subdef['to_stamp']) {
// we must stamp this document
try {
$record = $this->app->getApplicationBox()->get_databox($v_file['databox_id'])->get_record($v_file['record_id']);
assert(!is_object($record));
$sd = $record->get_subdef($k_subdef);
assert(!is_object($sd));
if(!is_null($path = \recordutils_image::stamp($this->app, $sd))) {
// stamped !
$pi = pathinfo($path);
$list['files'][$k_file]['subdefs'][$k_subdef]['path'] = $pi['dirname'];
$list['files'][$k_file]['subdefs'][$k_subdef]['file'] = $pi['basename'];
$list['files'][$k_file]['subdefs'][$k_subdef]['size'] = filesize($path);
}
}
catch (\Exception $e) {
// failed to stamp ? ignore and send the original file
}
}
}
}
$this->repoWorkerJob->reconnect();
//zip documents
\set_export::build_zip(

36
lib/classes/recordutils/image.php
View File

@@ -11,13 +11,13 @@
use Alchemy\Phrasea\Application;
use Alchemy\Phrasea\Model\Serializer\CaptionSerializer;
use Imagine\Exception\Exception as ImagineException;
use Imagine\Image\Box;
use Imagine\Image\ImagineInterface;
use Imagine\Image\Palette\RGB;
use Imagine\Image\Box;
use Imagine\Image\Point;
use Imagine\Exception\Exception as ImagineException;
use MediaVorus\Media\MediaInterface;
use MediaVorus\Media\Image;
use MediaVorus\Media\MediaInterface;
class recordutils_image
{
@@ -25,12 +25,23 @@ class recordutils_image
* @param Application $app
* @param \media_subdef $subdef
*
* @return string The path to the stamped file
* @return string|null The path to the stamped file, or null if stamp is not required
*/
public static function stamp(Application $app, \media_subdef $subdef)
{
static $palette;
$domprefs = new DOMDocument();
if (false === $domprefs->loadXML($subdef->get_record()->getCollection()->get_prefs())) {
return null;
}
$xpprefs = new DOMXPath($domprefs);
$stampNodes = $xpprefs->query('/baseprefs/stamp');
if ($stampNodes->length == 0) {
return null;
}
if (null === $palette) {
$palette = new RGB();
}
@@ -52,11 +63,11 @@ class recordutils_image
$base_id = $subdef->get_record()->getBaseId();
if ($subdef->get_type() !== \media_subdef::TYPE_IMAGE) {
return $subdef->getRealPath();
return null;
}
if (!$subdef->is_physically_present()) {
return $subdef->getRealPath();
return null;
}
$rotation = null;
@@ -69,20 +80,9 @@ class recordutils_image
// getting orientation failed but we don't care the reason
}
$domprefs = new DOMDocument();
if (false === $domprefs->loadXML($subdef->get_record()->getCollection()->get_prefs())) {
return $subdef->getRealPath();
}
if (false === $sxxml = simplexml_load_string($app['serializer.caption']->serialize($subdef->get_record()->get_caption(), CaptionSerializer::SERIALIZE_XML))) {
return $subdef->getRealPath();
}
$xpprefs = new DOMXPath($domprefs);
$stampNodes = $xpprefs->query('/baseprefs/stamp');
if ($stampNodes->length == 0) {
return $subdef->getRealPath();
return null;
}
$pathIn = $subdef->getRealPath();

114
lib/classes/set/export.php
View File

@@ -389,22 +389,29 @@ class set_export extends set_abstract
return $this->total_ftp;
}
const NO_STAMP = 'NO_STAMP';
const STAMP_SYNC = 'STAMP_SYNC';
const STAMP_ASYNC = 'STAMP_ASYNC';
/**
* @param User $user
* @param Filesystem $filesystem
* @param array $wantedSubdefs
* @param bool $rename_title
* @param bool $includeBusinessFields
* @param $stampChoice
* @param $no_stamp
* @return array
* @throws Exception
*/
public function prepare_export(User $user, Filesystem $filesystem, Array $wantedSubdefs, $rename_title, $includeBusinessFields, $stampChoice = null)
public function prepare_export(User $user, Filesystem $filesystem, Array $wantedSubdefs, $rename_title, $includeBusinessFields, $stampMethod)
{
if (!is_array($wantedSubdefs)) {
throw new Exception('No subdefs given');
}
if(!$stampMethod) {
$stampMethod = self::STAMP_SYNC;
}
$includeBusinessFields = (bool) $includeBusinessFields;
$files = [];
$n_files = 0;
@@ -509,7 +516,9 @@ class set_export extends set_abstract
$subdef_ok = true;
$tmp_pathfile = [
'path' => $sd[$subdefName]->get_path(),
'file' => $sd[$subdefName]->get_file()
'file' => $sd[$subdefName]->get_file(),
'to_stamp' => false,
'to_watermark' => false
];
break;
@@ -517,16 +526,28 @@ class set_export extends set_abstract
$subdef_ok = true;
$tmp_pathfile = [
'path' => $sd[$subdefName]->get_path(),
'file' => $sd[$subdefName]->get_file()
'file' => $sd[$subdefName]->get_file(),
'to_stamp' => false,
'to_watermark' => false
];
if($this->app['conf']->get(['registry', 'actions', 'export-stamp-choice']) !== true || is_null($stampChoice) ){
$path = \recordutils_image::stamp($this->app , $sd[$subdefName]);
if (file_exists($path)) {
$tmp_pathfile = [
'path' => dirname($path),
'file' => basename($path)
];
if($this->app['conf']->get(['registry', 'actions', 'export-stamp-choice']) !== true || $stampMethod !== self::NO_STAMP ){
// stamp is mandatory, or user did not check "no stamp" : we must apply stamp
if($stampMethod === self::STAMP_SYNC) {
// we prepare a direct download, we must stamp now
$path = \recordutils_image::stamp($this->app, $sd[$subdefName]);
if ($path && file_exists($path)) {
$tmp_pathfile = [
'path' => dirname($path),
'file' => basename($path),
'to_stamp' => false,
'to_watermark' => false
];
}
}
else {
// we prepare an email or ftp download : the worker will apply stamp
$tmp_pathfile ['to_stamp'] = true;
}
}
@@ -534,7 +555,9 @@ class set_export extends set_abstract
case 'preview':
$tmp_pathfile = [
'path' => $sd[$subdefName]->get_path(),
'file' => $sd[$subdefName]->get_file()
'file' => $sd[$subdefName]->get_file(),
'to_stamp' => false,
'to_watermark' => false
];
if (!$this->app->getAclForUser($user)->has_right_on_base($download_element->getBaseId(), \ACL::NOWATERMARK)
@@ -545,7 +568,9 @@ class set_export extends set_abstract
if (file_exists($path)) {
$tmp_pathfile = [
'path' => dirname($path),
'file' => basename($path)
'file' => basename($path),
'to_stamp' => false,
'to_watermark' => false
];
$subdef_ok = true;
}
@@ -569,14 +594,17 @@ class set_export extends set_abstract
$mime = 'text/xml';
}
$files[$id]["subdefs"][$subdefName]["ajout"] = $ajout;
$files[$id]["subdefs"][$subdefName]["exportExt"] = $ext;
$files[$id]["subdefs"][$subdefName]["label"] = $properties['label'];
$files[$id]["subdefs"][$subdefName]["path"] = null;
$files[$id]["subdefs"][$subdefName]["file"] = null;
$files[$id]["subdefs"][$subdefName]["size"] = 0;
$files[$id]["subdefs"][$subdefName]["mime"] = $mime;
$files[$id]["subdefs"][$subdefName]["folder"] = $download_element->get_directory();
$files[$id]["subdefs"][$subdefName] = [
"ajout" => $ajout,
"exportExt" => $ext,
"label" => $properties['label'],
"path" => null,
"file" => null,
"to_stamp" => false,
"size" => 0,
"mime" => $mime,
"folder" => $download_element->get_directory()
];
break;
case 'document':
@@ -586,19 +614,22 @@ class set_export extends set_abstract
$infos = pathinfo(p4string::addEndSlash($tmp_pathfile["path"]) . $tmp_pathfile["file"]);
$ext = isset($infos['extension']) ? $infos['extension'] : '';
$files[$id]["subdefs"][$subdefName]["ajout"] = $ajout;
$files[$id]["subdefs"][$subdefName]["exportExt"] = $ext;
$files[$id]["subdefs"][$subdefName]["label"] = $properties['label'];
$files[$id]["subdefs"][$subdefName]["path"] = $tmp_pathfile["path"];
$files[$id]["subdefs"][$subdefName]["file"] = $tmp_pathfile["file"];
$files[$id]["subdefs"][$subdefName]["size"] = $sd[$subdefName]->get_size();
$files[$id]["subdefs"][$subdefName]["mime"] = $sd[$subdefName]->get_mime();
$files[$id]["subdefs"][$subdefName]["folder"] = $download_element->get_directory();
$files[$id]["subdefs"][$subdefName] = [
"ajout" => $ajout,
"exportExt" => $ext,
"label" => $properties['label'],
"path" => $tmp_pathfile["path"],
"file" => $tmp_pathfile["file"],
"to_stamp" => $tmp_pathfile["to_stamp"],
"size" => $sd[$subdefName]->get_size(),
"mime" => $sd[$subdefName]->get_mime(),
"folder" => $download_element->get_directory()
];
$size += $sd[$subdefName]->get_size();
break;
default: // should no happen
default: // should not happen
$ajout = $ext = '';
break;
@@ -824,4 +855,27 @@ class set_export extends set_abstract
$stmt->closeCursor();
}
}
public function has_stamp_option()
{
if ($this->total_download == 0) {
return false;
}
$domprefs = new DOMDocument();
foreach ($this->elements as $download_element) {
if ( ($domprefs->loadXML($download_element->getCollection()->get_prefs())) === false) {
continue;
}
$xpprefs = new DOMXPath($domprefs);
$stampNodes = $xpprefs->query('/baseprefs/stamp');
if ($stampNodes->length != 0) {
return true;
}
}
return false;
}
}

16
templates/web/common/dialog_export.html.twig
View File

@@ -156,6 +156,14 @@
</label>
</div>
{% endif %}
{% if app['conf'].get(['registry', 'actions', 'export-stamp-choice']) == true and download.has_stamp_option() == true %}
<div id="download_stamp_choice" class="well-small hide" style="margin-left: 20px;" >
<label for="option_stamp" class="checkbox">
<input class="stamp_choice" type="checkbox" id="stamp_choice" name="stamp_choice" value="NO_STAMP" />
{{ 'prod::download: delete-marking-stamp' | trans }}
</label>
</div>
{% endif %}
<div class="buttons_line">
<button type="button" class="download_button btn btn-inverse">{{ 'boutton::telecharger' | trans }}</button>
<button type="button" class="close_button btn btn-inverse">{{ 'boutton::annuler' | trans }}</button>
@@ -519,6 +527,14 @@
$(document).find(".tagsinput").tagsinput('add', $(this).val());
$(this).val('');
});
$('#download_document').click(function(){
if($(this).is(':checked')){
$('#download_stamp_choice').show();
} else{
$('#download_stamp_choice').hide();
}
});
</script>
{% endif %}