Merge pull request #1381 from jygaulier/TASK_RECORD_MOVER

Task record mover #PHRAS-517
This commit is contained in:
Benoît Burnichon
2015-05-21 13:04:35 +02:00
9 changed files with 207 additions and 128 deletions

View File

@@ -81,57 +81,81 @@ class RecordMoverEditor extends AbstractEditor
<tasksettings>
<logsql>0</logsql>
<!--
THIS IS AN EXAMPLE OF A SIMPLE WORKFLOW
Fix with your settings (fields names, base/collections id's, status-bits) before try
-->
<!-- ********* un-comment to see the tasks **********
<tasks>
//Maintain offline (sb4 = 1) all docs under copyright
<task active="1" name="confidentiel" action="update" sbas_id="1">
<comment> keep offline (sb4 = 1) all docs before their "go online" date </comment>
<task active="1" name="stay offline" action="update" sbas_id="1">
<from>
<date direction="before" field="FIN_COPYRIGHT"/>
<date direction="before" field="GO_ONLINE"/>
</from>
<to>
<status mask="x1xxxx"/>
</to>
</task>
//Put online (sb4 = 0) all docs from 'public' collection and between the copyright date and the date of filing
<task active="1" name="visible" action="update" sbas_id="1">
<comment> Put online (sb4 = 0) all docs from 'public' collection and between the online date and the date of archiving </comment>
<task active="1" name="go online" action="update" sbas_id="1">
<from>
<coll compare="=" id="5"/>
<date direction="after" field="FIN_COPYRIGHT"/>
<date direction="before" field="ARCHIVAGE"/>
<comment> 5, 6, 7 are "public" collections </comment>
<coll compare="=" id="5,6,7"/>
<date direction="after" field="GO_ONLINE"/>
<date direction="before" field="TO_ARCHIVE"/>
</from>
<to>
<status mask="x0xxxx"/>
</to>
</task>
// Warn 10 days before archiving (raise sb5)
<task active="1" name="bientôt la fin" action="update" sbas_id="1">
<comment> Warn 10 days before archiving (raise sb5) </comment>
<task active="1" name="almost the end" action="update" sbas_id="1">
<from>
<coll compare="=" id="5"/>
<date direction="after" field="ARCHIVAGE" delta="-10"/>
<coll compare="=" id="5,6,7"/>
<date direction="after" field="TO_ARCHIVE" delta="-10"/>
</from>
<to>
<status mask="1xxxxx"/>
</to>
</task>
//Move to 'archive' collection
<comment> Move to 'archive' collection </comment>
<task active="1" name="archivage" action="update" sbas_id="1">
<from>
<coll compare="=" id="5"/>
<date direction="after" field="ARCHIVAGE" />
<coll compare="=" id="5,6,7"/>
<date direction="after" field="TO_ARCHIVE" />
</from>
<to>
<status mask="00xxxx"/> on nettoie les status pour la forme
<comment> reset status of archived documents </comment>
<status mask="00xxxx"/>
<comment> 666 is the "archive" collection </comment>
<coll id="666" />
</to>
</task>
//Purge the archived documents from one year that are in the 'archive' collection
<task active="1" name="archivage" action="delete" sbas_id="1">
<comment> Delete the archived documents that are in the 'archive' collection from one year </comment>
<task active="1" name="trash" action="delete" sbas_id="1">
<from>
<coll compare="=" id="666"/>
<date direction="after" field="ARCHIVAGE" delta="+365" />
<date direction="after" field="TO_ARCHIVE" delta="+365" />
</from>
</task>
</tasks>
-->
****************************************** -->
</tasksettings>
EOF;
}

View File

@@ -13,6 +13,9 @@ namespace Alchemy\Phrasea\TaskManager\Job;
use Alchemy\Phrasea\Application;
use Alchemy\Phrasea\TaskManager\Editor\RecordMoverEditor;
use \databox;
use Doctrine\DBAL\Connection;
use record_adapter;
class RecordMoverJob extends AbstractJob
{
@@ -54,11 +57,13 @@ class RecordMoverJob extends AbstractJob
protected function doJob(JobData $data)
{
$app = $data->getApplication();
$task = $data->getTask();
$settings = $task->getSettings();
$settings = simplexml_load_string($data->getTask()->getSettings());
$logsql = (Boolean) $settings->logsql;
$tasks = (array) $settings->tasks;
$tasks = array();
foreach($settings->tasks->task as $task) {
$tasks[] = $task;
}
$data = $this->getData($app, $tasks, $logsql);
@@ -69,6 +74,7 @@ class RecordMoverJob extends AbstractJob
private function processData(Application $app, $row, $logsql)
{
/** @var databox $databox */
$databox = $app['phraseanet.appbox']->get_databox($row['sbas_id']);
$rec = $databox->get_record($row['record_id']);
@@ -91,7 +97,8 @@ class RecordMoverJob extends AbstractJob
$status[31 - $bit] = $val;
}
}
$rec->set_binary_status(implode('', $status));
$status = implode('', $status);
$rec->set_binary_status($status);
if ($logsql) {
$this->log('debug', sprintf("on sbas %s set rid %s status to %s \n", $row['sbas_id'], $row['record_id'], $status));
}
@@ -100,6 +107,7 @@ class RecordMoverJob extends AbstractJob
case 'DELETE':
if ($row['deletechildren'] && $rec->is_grouping()) {
/** @var record_adapter $child */
foreach ($rec->get_children() as $child) {
$child->delete();
if ($logsql) {
@@ -120,7 +128,6 @@ class RecordMoverJob extends AbstractJob
private function getData(Application $app, array $tasks, $logsql)
{
$ret = [];
foreach ($tasks as $sxtask) {
if (!$this->isStarted()) {
break;
@@ -128,7 +135,7 @@ class RecordMoverJob extends AbstractJob
$task = $this->calcSQL($app, $sxtask);
if (!$task['active']) {
if (!$task['active'] || !$task['sql']) {
continue;
}
@@ -137,6 +144,7 @@ class RecordMoverJob extends AbstractJob
}
try {
/** @var databox $databox */
$databox = $app['phraseanet.appbox']->get_databox($task['sbas_id']);
} catch (\Exception $e) {
$this->log('error', sprintf("can't connect sbas %s", $task['sbas_id']));
@@ -198,22 +206,28 @@ class RecordMoverJob extends AbstractJob
];
try {
/** @var databox $dbox */
$dbox = $app['phraseanet.appbox']->get_databox($sbas_id);
$ret['basename'] = $dbox->get_label($app['locale']);
$ret['basename_htmlencoded'] = htmlentities($ret['basename']);
switch ($ret['action']) {
case 'UPDATE':
$ret['sql'] = $this->calcUPDATE($app, $sbas_id, $sxtask, $playTest);
break;
case 'DELETE':
$ret['sql'] = $this->calcDELETE($app, $sbas_id, $sxtask, $playTest);
$ret['deletechildren'] = (int) ($sxtask['deletechildren']);
break;
default:
$ret['err'] = "bad action '" . $ret['action'] . "'";
$ret['err_htmlencoded'] = htmlentities($ret['err']);
break;
try {
switch ($ret['action']) {
case 'UPDATE':
$ret['sql'] = $this->calcUPDATE($app, $sbas_id, $sxtask, $playTest);
break;
case 'DELETE':
$ret['sql'] = $this->calcDELETE($app, $sbas_id, $sxtask, $playTest);
$ret['deletechildren'] = (int)($sxtask['deletechildren']);
break;
default:
$ret['err'] = "bad action '" . $ret['action'] . "'";
$ret['err_htmlencoded'] = htmlentities($ret['err']);
break;
}
} catch (\Exception $e) {
$ret['err'] = $e->getMessage();
$ret['err_htmlencoded'] = htmlentities($e->getMessage());
}
} catch (\Exception $e) {
$ret['err'] = "bad sbas '" . $sbas_id . "'";
@@ -225,11 +239,8 @@ class RecordMoverJob extends AbstractJob
private function calcUPDATE(Application $app, $sbas_id, &$sxtask, $playTest)
{
$databox = $app['phraseanet.appbox']->get_databox($sbas_id);
$connbas = $databox->get_connection();
$tws = array(); // NEGATION of updates, used to build the 'test' sql
//
// set coll_id ?
if (($x = (int) ($sxtask->to->coll['id'])) > 0) {
$tws[] = 'coll_id!=' . $x;
@@ -252,9 +263,13 @@ class RecordMoverJob extends AbstractJob
}
// compute the 'where' clause
list($tw, $join) = $this->calcWhere($app, $sbas_id, $sxtask);
list($tw, $join, $err) = $this->calcWhere($app, $sbas_id, $sxtask);
// ... complete the where to buid the TEST
if(!empty($err)) {
throw(new \Exception($err));
}
// ... complete the where to build the TEST
if (count($tws) == 1) {
$tw[] = $tws[0];
} elseif (count($tws) > 1) {
@@ -268,21 +283,21 @@ class RecordMoverJob extends AbstractJob
}
// build the real sql (select)
$sql = 'SELECT record_id FROM record' . $join;
$sql_real = 'SELECT record_id FROM record' . $join;
if (count($tw) > 0) {
$sql .= ' WHERE ' . ((count($tw) == 1) ? $tw[0] : '(' . implode(') AND (', $tw) . ')');
$sql_real .= ' WHERE ' . ((count($tw) == 1) ? $tw[0] : '(' . implode(') AND (', $tw) . ')');
}
$ret = array(
'real' => array(
'sql' => $sql,
'sql_htmlencoded' => htmlentities($sql),
'sql' => $sql_real,
'sql_htmlencoded' => htmlentities($sql_real),
),
'test' => array(
'sql' => $sql_test,
'test' => array(
'sql' => $sql_test,
'sql_htmlencoded' => htmlentities($sql_test),
'result' => NULL,
'err' => NULL
'result' => null,
'err' => null
)
);
@@ -296,7 +311,11 @@ class RecordMoverJob extends AbstractJob
private function calcDELETE(Application $app, $sbas_id, &$sxtask, $playTest)
{
// compute the 'where' clause
list($tw, $join) = $this->calcWhere($app, $sbas_id, $sxtask);
list($tw, $join, $err) = $this->calcWhere($app, $sbas_id, $sxtask);
if(!empty($err)) {
throw(new \Exception($err));
}
// build the TEST sql (select)
$sql_test = 'SELECT SQL_CALC_FOUND_ROWS record_id FROM record' . $join;
@@ -305,20 +324,20 @@ class RecordMoverJob extends AbstractJob
$sql_test .= ' LIMIT 10';
// build the real sql (select)
$sql = 'SELECT record_id FROM record' . $join;
$sql_real = 'SELECT record_id FROM record' . $join;
if (count($tw) > 0)
$sql .= ' WHERE ' . ((count($tw) == 1) ? $tw[0] : '(' . implode(') AND (', $tw) . ')');
$sql_real .= ' WHERE ' . ((count($tw) == 1) ? $tw[0] : '(' . implode(') AND (', $tw) . ')');
$ret = [
'real' => [
'sql' => $sql,
'sql_htmlencoded' => htmlentities($sql),
'sql' => $sql_real,
'sql_htmlencoded' => htmlentities($sql_real),
],
'test' => [
'sql' => $sql_test,
'test' => [
'sql' => $sql_test,
'sql_htmlencoded' => htmlentities($sql_test),
'result' => NULL,
'err' => NULL
'result' => null,
'err' => null
]
];
@@ -331,6 +350,7 @@ class RecordMoverJob extends AbstractJob
private function playTest(Application $app, $sbas_id, $sql)
{
/** @var databox $databox */
$databox = $app['phraseanet.appbox']->get_databox($sbas_id);
$connbas = $databox->get_connection();
$result = ['rids' => [], 'err' => '', 'n' => null];
@@ -344,7 +364,7 @@ class RecordMoverJob extends AbstractJob
}
$stmt->closeCursor();
} else {
$result['err'] = $connbas->last_error();
$result['err'] = $connbas->errorInfo();
}
return $result;
@@ -352,16 +372,21 @@ class RecordMoverJob extends AbstractJob
private function calcWhere(Application $app, $sbas_id, &$sxtask)
{
$err = "";
/** @var databox $databox */
$databox = $app['phraseanet.appbox']->get_databox($sbas_id);
/** @var Connection $connbas */
$connbas = $databox->get_connection();
$struct = $databox->get_meta_structure();
$tw = array();
$join = '';
$ijoin = 0;
// criteria <type type="XXX" />
if (($x = $sxtask->from->type['type']) !== NULL) {
if (($x = $sxtask->from->type['type']) !== null) {
switch (strtoupper($x)) {
case 'RECORD':
$tw[] = 'parent_record_id!=record_id';
@@ -374,44 +399,65 @@ class RecordMoverJob extends AbstractJob
// criteria <text field="XXX" compare="OP" value="ZZZ" />
foreach ($sxtask->from->text as $x) {
$ijoin++;
$comp = strtoupper($x['compare']);
if (in_array($comp, array('<', '>', '<=', '>=', '=', '!='))) {
$s = 'p' . $ijoin . '.name=' . $connbas->quote($x['field']) . ' AND p' . $ijoin . '.value' . $comp
. '' . $connbas->quote($x['value']) . '';
$field = $struct->get_element_by_name($x['field']);
if($field != null) {
$ijoin++;
$comp = trim($x['compare']);
if (in_array($comp, array('<', '>', '<=', '>=', '=', '!='))) {
$s = 'p' . $ijoin . '.meta_struct_id=' . $connbas->quote($field->get_id()) . ' AND p' . $ijoin . '.value' . $comp
. '' . $connbas->quote($x['value']) . '';
$tw[] = $s;
$join .= ' INNER JOIN prop AS p' . $ijoin . ' USING(record_id)';
$tw[] = $s;
$join .= ' INNER JOIN metadatas AS p' . $ijoin . ' USING(record_id)';
} else {
// bad comparison operator
$err .= sprintf("bad comparison operator (%s)\n", $comp);
}
} else {
// bad comparison operator
// unknown field ?
$err .= sprintf("unknown field (%s)\n", $x['field']);
}
}
// criteria <date direction ="XXX" field="YYY" delta="Z" />
foreach ($sxtask->from->date as $x) {
$ijoin++;
$s = 'p' . $ijoin . '.name=\'' . $x['field'] . '\' AND NOW()';
$s .= strtoupper($x['direction']) == 'BEFORE' ? '<' : '>=';
$delta = (int) ($x['delta']);
if ($delta > 0) {
$s .= '(p' . $ijoin . '.value+INTERVAL ' . $delta . ' DAY)';
}
elseif ($delta < 0) {
$s .= '(p' . $ijoin . '.value-INTERVAL ' . -$delta . ' DAY)';
$field = $struct->get_element_by_name($x['field']);
if($field != null) {
$ijoin++;
$s = 'p' . $ijoin . '.meta_struct_id=' . $connbas->quote($field->get_id()) . ' AND NOW()';
$dir = strtoupper($x['direction']);
if (in_array($dir, array('BEFORE', 'AFTER'))) {
// prevent malformed dates to act
$tw[] = '!ISNULL(CAST(p' . $ijoin . '.value AS DATETIME))';
$s .= $dir == 'BEFORE' ? '<' : '>=';
$delta = (int)($x['delta']);
if ($delta > 0) {
$s .= '(p' . $ijoin . '.value+INTERVAL ' . $delta . ' DAY)';
} elseif ($delta < 0) {
$s .= '(p' . $ijoin . '.value-INTERVAL ' . -$delta . ' DAY)';
} else {
$s .= 'CAST(p' . $ijoin . '.value AS DATETIME)';
}
$tw[] = $s;
$join .= ' INNER JOIN metadatas AS p' . $ijoin . ' USING(record_id)';
} else {
// bad direction
$err .= sprintf("bad direction (%s)\n", $x['direction']);
}
}
else {
$s .= 'p' . $ijoin . '.value';
// unknown field ?
$err .= sprintf("unknown field (%s)\n", $x['field']);
}
$tw[] = $s;
$join .= ' INNER JOIN prop AS p' . $ijoin . ' USING(record_id)';
}
// criteria <coll compare="OP" id="X,Y,Z" />
if (($x = $sxtask->from->coll) !== NULL) {
if (($x = $sxtask->from->coll) ) {
$tcoll = explode(',', $x['id']);
foreach ($tcoll as $i => $c)
$tcoll[$i] = (int) $c;
foreach ($tcoll as $i => $c) {
$tcoll[$i] = (int)$c;
}
if ($x['compare'] == '=') {
if (count($tcoll) == 1) {
$tw[] = 'coll_id = ' . $tcoll[0];
@@ -426,6 +472,7 @@ class RecordMoverJob extends AbstractJob
}
} else {
// bad operator
$err .= sprintf("bad comparison operator (%s)\n", $x['compare']);
}
}
@@ -443,6 +490,6 @@ class RecordMoverJob extends AbstractJob
$tw[] = '(status & 0b' . $ma . ")=0";
}
return array($tw, $join);
return array($tw, $join, $err);
}
}

View File

@@ -63,30 +63,32 @@
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml)
{
if (xml) {
xml = $.parseXML(xml);
xml = $(xml);
with(document.forms['graphicForm'])
{
var i;
var opts;
var found;
opts = base_id.options;
for (found=0, i=1; found==0 && i<opts.length; i++) {
if(opts[i].value == xml.find("base_id").text())
var gform = document.forms['graphicForm'];
var i;
var opts;
var found;
opts = gform.base_id.options;
for (found=0, i=1; found==0 && i<opts.length; i++) {
if(opts[i].value == xml.find("base_id").text()) {
found = i;
}
opts[found].selected = true;
hotfolder.value = xml.find("hotfolder").text();
cold.value = xml.find("cold").text();
move_archived.checked = Number(xml.find("move_archived").text()) > 0;
move_error.checked = Number(xml.find("move_error").text()) > 0;
delfolder.checked = Number(xml.find("delfolder").text()) > 0;
copy_spe.checked = Number(xml.find("copy_spe").text()) > 0;
}
opts[found].selected = true;
gform.hotfolder.value = xml.find("hotfolder").text();
gform.cold.value = xml.find("cold").text();
gform.move_archived.checked = Number(xml.find("move_archived").text()) > 0;
gform.move_error.checked = Number(xml.find("move_error").text()) > 0;
gform.delfolder.checked = Number(xml.find("delfolder").text()) > 0;
gform.copy_spe.checked = Number(xml.find("copy_spe").text()) > 0;
}
}
</script>
{% endblock %}

View File

@@ -67,25 +67,25 @@
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml)
{
if (xml) {
xml = $.parseXML(xml);
xml = $(xml);
with(document.forms['graphicForm'])
{
proxy.value = xml.find("proxy").text();
proxyport.value = xml.find("proxyport").text();
localpath.value = xml.find("localpath").text();
ftppath.value = xml.find("ftppath").text();
host.value = xml.find("host").text();
port.value = xml.find("port").text();
user.value = xml.find("user").text();
password.value = xml.find("password").text();
ssl.checked = Number(xml.find("ssl").text()) > 0;
passive.checked = Number(xml.find("passive").text()) > 0;
}
var gform = document.forms['graphicForm'];
gform.proxy.value = xml.find("proxy").text();
gform.proxyport.value = xml.find("proxyport").text();
gform.localpath.value = xml.find("localpath").text();
gform.ftppath.value = xml.find("ftppath").text();
gform.host.value = xml.find("host").text();
gform.port.value = xml.find("port").text();
gform.user.value = xml.find("user").text();
gform.password.value = xml.find("password").text();
gform.ssl.checked = Number(xml.find("ssl").text()) > 0;
gform.passive.checked = Number(xml.find("passive").text()) > 0;
}
}
</script>
{% endblock %}

View File

@@ -17,17 +17,17 @@
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml)
{
if (xml) {
xml = $.parseXML(xml);
xml = $(xml);
with(document.forms['graphicForm'])
{
proxy.value = xml.find("proxy").text();
proxyport.value = xml.find("proxyport").text();
}
var gform = document.forms['graphicForm'];
gform.proxy.value = xml.find("proxy").text();
gform.proxyport.value = xml.find("proxyport").text();
}
}
</script>
{% endblock %}

View File

@@ -67,6 +67,8 @@
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml)
{
$("#sqlu").text("");
@@ -155,4 +157,5 @@
});
}
}
</script>
{% endblock %}

View File

@@ -66,6 +66,8 @@
{% block javascript %}
<script type="text/javascript">
function minmax(v, _min, _max)
{
if(isNaN(v) || v < _min)
@@ -112,4 +114,5 @@
}
}
}
</script>
{% endblock %}

View File

@@ -48,11 +48,11 @@
</div>
</div>
<script type="text/javascript">
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml) { };
{% endblock %}
</script>
{% endblock %}
</div>
<script type="text/javascript">

View File

@@ -21,17 +21,17 @@
{% block javascript %}
<script type="text/javascript">
function taskFillGraphic(xml)
{
if (xml) {
xml = $.parseXML(xml);
xml = $(xml);
with(document.forms['graphicForm'])
{
cleardoc.checked = Number(xml.find("cleardoc").text()) > 0;
mwg.checked = Number(xml.find("mwg").text()) > 0;
}
var gform = document.forms['graphicForm'];
gform.cleardoc.checked = Number(xml.find("cleardoc").text()) > 0;
gform.mwg.checked = Number(xml.find("mwg").text()) > 0;
}
}
</script>
{% endblock %}