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

PHRAS-2808_disable-cterms_4.1

Browse Source 
new : checkbox in admin/field to disable cterms generation.
fix : when cterms is cleared (during reindex), rejected terms are kept
WIP
This commit is contained in:
Jean-Yves Gaulier
2019-10-31 18:12:26 +01:00
parent 1becb29bc3
commit ce13112105
14 changed files with 166 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/Alchemy/Phrasea/Controller/Admin/FieldsController.php
View File

@@ -314,6 +314,7 @@ class FieldsController extends Controller
->set_readonly($data['readonly'])
->set_type($data['type'])
->set_tbranch($data['tbranch'])
->set_publish_cterms($data['publish_cterms'])
->set_report($data['report'])
->setVocabularyControl(null)
->setVocabularyRestricted(false);
@@ -349,7 +350,7 @@ class FieldsController extends Controller
{
return [
'name', 'multi', 'thumbtitle', 'tag', 'business', 'indexable', 'aggregable',
'required', 'separator', 'readonly', 'type', 'tbranch', 'report',
'required', 'separator', 'readonly', 'type', 'tbranch', 'publish_cterms', 'report',
'vocabulary-type', 'vocabulary-restricted', 'dces-element', 'labels'
];
}

1
lib/Alchemy/Phrasea/Controller/Api/V1Controller.php
View File

@@ -594,6 +594,7 @@ class V1Controller extends Controller
],
'separator' => $databox_field->get_separator(),
'thesaurus_branch' => $databox_field->get_tbranch(),
'publish_cterms' => $databox_field->get_publish_cterms(),
'type' => $databox_field->get_type(),
'indexable' => $databox_field->is_indexable(),
'multivalue' => $databox_field->is_multi(),

1
lib/Alchemy/Phrasea/Controller/Prod/EditController.php
View File

@@ -75,6 +75,7 @@ class EditController extends Controller
'format' => '',
'explain' => '',
'tbranch' => $meta->get_tbranch(),
'publish_cterms' => $meta->get_publish_cterms(),
'maxLength' => $meta->get_tag()
->getMaxLength(),
'minLength' => $meta->get_tag()

2
lib/Alchemy/Phrasea/Core/Version.php
View File

@@ -16,7 +16,7 @@ class Version
/**
* @var string
*/
private $number = '4.1.0-alpha.15a';
private $number = '4.1.0-alpha.17a';
/**
* @var string

1
lib/Alchemy/Phrasea/Databox/Field/DbalDataboxFieldRepository.php
View File

@@ -36,6 +36,7 @@ final class DbalDataboxFieldRepository implements DataboxFieldRepository
'label_fr',
'label_de',
'label_nl',
'publish_cterms',
];
/** @var DataboxFieldFactory */

20
lib/Alchemy/Phrasea/SearchEngine/Elastic/Indexer/Record/Hydrator/ThesaurusHydrator.php
View File

@@ -42,7 +42,7 @@ class ThesaurusHydrator implements HydratorInterface
$fields = [];
$index_fields = [];
foreach ($structure as $name => $field) {
$fields[$name] = $field->getThesaurusRoots();
$fields[$name] = $field; // ->getThesaurusRoots();
$index_fields[$name] = $field->getIndexField();
}
// Hydrate records with concepts
@@ -51,7 +51,13 @@ class ThesaurusHydrator implements HydratorInterface
}
}
private function hydrate(array &$record, array $fields, array $index_fields)
/**
* @param array $record
* @param Field[] $fields
* @param array $index_fields
* @throws Exception
*/
private function hydrate(array &$record, $fields, array $index_fields)
{
if (!isset($record['databox_id'])) {
throw new Exception('Expected a record with the "databox_id" key set.');
@@ -61,7 +67,8 @@ class ThesaurusHydrator implements HydratorInterface
$terms = array();
$filters = array();
$field_names = array();
foreach ($fields as $name => $root_concepts) {
foreach ($fields as $name => $field) {
$root_concepts = $field->getThesaurusRoots();
// Loop through all values to prepare bulk query
$field_values = \igorw\get_in($record, explode('.', $index_fields[$name]));
if ($field_values !== null) {
@@ -84,14 +91,17 @@ class ThesaurusHydrator implements HydratorInterface
$bulk = $this->thesaurus->findConceptsBulk($terms, null, $filters, true);
foreach ($bulk as $offset => $item_concepts) {
if ($item_concepts && is_array($item_concepts) && count($item_concepts)>0) {
$name = $field_names[$offset];
if ($item_concepts && is_array($item_concepts) && count($item_concepts)>0) {
foreach ($item_concepts as $concept) {
$record['concept_path'][$name][] = $concept->getPath();
}
} else {
}
else {
if(($fields[$name])->get_publish_cterms()) {
$this->candidate_terms->insert($field_names[$offset], $values[$offset]);
}
}
}
}
}

10
lib/Alchemy/Phrasea/SearchEngine/Elastic/Structure/Field.php
View File

@@ -43,6 +43,8 @@ class Field implements Typed
private $thesaurus_roots;
private $publish_cterms;
private $used_by_collections;
public static function createFromLegacyField(databox_field $field, $with = Structure::WITH_EVERYTHING)
@@ -75,6 +77,7 @@ class Field implements Typed
'private' => $field->isBusiness(),
'facet' => $facet,
'thesaurus_roots' => $roots,
'publish_cterms' => $field->get_publish_cterms(),
'used_by_collections' => $databox->get_collection_unique_ids()
]);
}
@@ -103,6 +106,7 @@ class Field implements Typed
$this->is_private = \igorw\get_in($options, ['private'], false);
$this->facet = \igorw\get_in($options, ['facet']);
$this->thesaurus_roots = \igorw\get_in($options, ['thesaurus_roots'], null);
$this->publish_cterms = \igorw\get_in($options, ['publish_cterms'], false);
$this->used_by_collections = \igorw\get_in($options, ['used_by_collections'], []);
Assertion::boolean($this->is_searchable);
@@ -126,6 +130,7 @@ class Field implements Typed
'private' => $this->is_private,
'facet' => $this->facet,
'thesaurus_roots' => $this->thesaurus_roots,
'publish_cterms' => $this->publish_cterms,
'used_by_collections' => $this->used_by_collections
]);
}
@@ -190,6 +195,11 @@ class Field implements Typed
return $this->thesaurus_roots;
}
public function get_publish_cterms()
{
return $this->publish_cterms;
}
/**
* Merge with another field, returning the new instance
*

26
lib/classes/databox.php
View File

@@ -462,6 +462,7 @@ class databox extends base implements ThumbnailedElement
->set_aggregable((isset($field['aggregable']) ? (string) $field['aggregable'] : 0))
->set_type($type)
->set_tbranch(isset($field['tbranch']) ? (string) $field['tbranch'] : '')
->set_publish_cterms((isset($field['publish_cterms']) && (string) $field['publish_cterms'] == 1))
->set_thumbtitle(isset($field['thumbtitle']) ? (string) $field['thumbtitle'] : (isset($field['thumbTitle']) ? $field['thumbTitle'] : '0'))
->set_report(isset($field['report']) ? (string) $field['report'] : '1')
->save();
@@ -1214,21 +1215,40 @@ class databox extends base implements ThumbnailedElement
$domct = $this->get_dom_cterms();
if ($domct !== false) {
$changed = false;
$nodesToDel = [];
// loop on first level : "fields"
for($n = $domct->documentElement->firstChild; $n; $n = $n->nextSibling) {
if($n->nodeType == XML_ELEMENT_NODE && !($n->getAttribute('delbranch'))){
$nodesToDel2 = [];
// loop on 2nd level : "terms"
for($n2 = $n->firstChild; $n2; $n2 = $n2->nextSibling) {
// do not remove "rejected" candidates
if(substr($n2->getAttribute('id'), 0, 1) != 'R') {
$nodesToDel2[] = $n2;
}
}
foreach($nodesToDel2 as $n2) {
$n->removeChild($n2);
$changed = true;
}
// if a field has no more candidates, we can remove it
if(!($n->firstChild)) {
$nodesToDel[] = $n;
}
}
}
foreach($nodesToDel as $n) {
$n->parentNode->removeChild($n);
$changed = true;
}
if(!empty($nodesToDel)) {
if($changed) {
$this->saveCterms($domct);
}
}
} catch (\Exception $e) {
}
catch (\Exception $e) {
// no-op
}
}

30
lib/classes/databox/field.php
View File

@@ -43,6 +43,7 @@ class databox_field implements cache_cacheableInterface
protected $report;
protected $type;
protected $tbranch;
protected $publish_cterms;
protected $separator;
protected $thumbtitle;
@@ -166,6 +167,7 @@ class databox_field implements cache_cacheableInterface
$this->position = (int)$row['sorter'];
$this->type = $row['type'] ?: self::TYPE_STRING;
$this->tbranch = $row['tbranch'];
$this->publish_cterms = (bool)$row['publish_cterms'];
$this->VocabularyType = $row['VocabularyControlType'];
$this->VocabularyRestriction = (bool)$row['RestrictToVocabularyControl'];
@@ -306,6 +308,7 @@ class databox_field implements cache_cacheableInterface
`report` = :report,
`type` = :type,
`tbranch` = :tbranch,
`publish_cterms` = :publish_cterms,
`sorter` = :position,
`thumbtitle` = :thumbtitle,
`VocabularyControlType` = :VocabularyControlType,
@@ -329,6 +332,7 @@ class databox_field implements cache_cacheableInterface
':report' => $this->report ? '1' : '0',
':type' => $this->type,
':tbranch' => $this->tbranch,
':publish_cterms' => $this->publish_cterms ? '1' : '0',
':position' => $this->position,
':thumbtitle' => $this->thumbtitle,
':VocabularyControlType' => $this->getVocabularyControl() ? $this->getVocabularyControl()->getType() : null,
@@ -380,6 +384,7 @@ class databox_field implements cache_cacheableInterface
$meta->setAttribute('aggregable', $this->aggregable);
$meta->setAttribute('type', $this->type);
$meta->setAttribute('tbranch', $this->tbranch);
$meta->setAttribute('publish_cterms', $this->publish_cterms ? '1' : '0');
if ($this->multi) {
$meta->setAttribute('separator', $this->separator);
}
@@ -711,6 +716,17 @@ class databox_field implements cache_cacheableInterface
return $this;
}
/**
* @param boolean $publish_cterms
* @return databox_field
*/
public function set_publish_cterms($publish_cterms)
{
$this->publish_cterms = $publish_cterms;
return $this;
}
/**
*
* @param string $separator
@@ -795,6 +811,15 @@ class databox_field implements cache_cacheableInterface
return $this->tbranch;
}
/**
*
* @return boolean
*/
public function get_publish_cterms()
{
return $this->publish_cterms;
}
/**
* @param Boolean $all If set to false, returns a one-char separator to use for serialiation
*
@@ -905,6 +930,7 @@ class databox_field implements cache_cacheableInterface
'sorter' => $this->position,
'thumbtitle' => $this->thumbtitle,
'tbranch' => $this->tbranch,
'publish_cterms' => $this->publish_cterms,
'separator' => $this->separator,
'required' => $this->required,
'report' => $this->report,
@@ -943,10 +969,10 @@ class databox_field implements cache_cacheableInterface
}
$sql = "INSERT INTO metadatas_structure
(`id`, `name`, `src`, `readonly`, `required`, `indexable`, `type`, `tbranch`,
(`id`, `name`, `src`, `readonly`, `required`, `indexable`, `type`, `tbranch`, `publish_cterms`,
`thumbtitle`, `multi`, `business`, `aggregable`,
`report`, `sorter`, `separator`)
VALUES (null, :name, '', 0, 0, 1, 'string', '',
VALUES (null, :name, '', 0, 0, 1, 'string', '', 1,
null, 0, 0, 0,
1, :sorter, '')";

65
lib/classes/patch/410alpha17a.php Normal file
View File

@@ -0,0 +1,65 @@
<?php
/*
* This file is part of Phraseanet
*
* (c) 2005-2016 Alchemy
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
use Alchemy\Phrasea\Application;
class patch_410alpha17a implements patchInterface
{
/** @var string */
private $release = '4.1.0-alpha.17a';
/** @var array */
private $concern = [base::DATA_BOX];
/**
* {@inheritdoc}
*/
public function get_release()
{
return $this->release;
}
/**
* {@inheritdoc}
*/
public function getDoctrineMigrations()
{
return [];
}
/**
* {@inheritdoc}
*/
public function require_all_upgrades()
{
return false;
}
/**
* {@inheritdoc}
*/
public function concern()
{
return $this->concern;
}
/**
* {@inheritdoc}
*/
public function apply(base $databox, Application $app)
{
// -- done by xml schema --
// $sql = "ALTER TABLE `metadatas_structure` ADD `publish_cterms` INT(1) UNSIGNED NOT NULL DEFAULT '0' AFTER `tbranch`";
// $databox->get_connection()->executeQuery($sql);
return true;
}
}

8
lib/conf.d/bases_structure.xml
View File

@@ -2033,6 +2033,14 @@
<default></default>
<comment></comment>
</field>
<field>
<name>publish_cterms</name>
<type>int(1) unsigned</type>
<null></null>
<extra></extra>
<default></default>
<comment></comment>
</field>
</fields>
<indexes>
<index>

4
templates/web/admin/fields/templates.html.twig
View File

@@ -247,6 +247,10 @@
<td><label for="tbranch">{% trans %}Thesaurus branch{% endtrans %}</label></td>
<td><input id="tbranch" type="text" value="<%= field.tbranch %>"/></td>
</tr>
<tr>
<td><label for="publish_cterms" class="checkbox">{% trans %}publish_cterms{% endtrans %}</label></td>
<td><input id="publish_cterms" type="checkbox" <%= field.publish_cterms ? "checked='checked'" : "" %> /></td>
</tr>
</table>
</div>
</div>

1
www/scripts/models/field.js
View File

@@ -26,6 +26,7 @@ define([
"type": "string",
"thumbtitle": "0",
"tbranch": "",
"publish_cterms": false,
"separator": "",
"required": false,
"report": true,

4
www/scripts/tests/specs/models.js
View File

@@ -44,6 +44,10 @@ define([
this.field.get('tbranch').should.equal("");
});
it("should default publish_cterms property to '0'", function () {
this.field.get('publish_cterms').should.equal("0");
});
it("should default separator property to 'empty'", function () {
this.field.get('separator').should.equal("");
});