Synchronisation messages
diff --git a/modules/sref_osie/helpers/osie.php b/modules/sref_osie/helpers/osie.php
index 106af71adf..98d399733c 100644
--- a/modules/sref_osie/helpers/osie.php
+++ b/modules/sref_osie/helpers/osie.php
@@ -13,39 +13,36 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/gpl.html.
*
- * @package Modules
- * @subpackage OSGB Grid References
- * @author Indicia Team
+ * @author Indicia Team
* @license http://www.gnu.org/licenses/gpl.html GPL 3.0
- * @link https://github.com/indicia-team/warehouse/
+ * @link https://github.com/indicia-team/warehouse/
*/
/**
* Conversion class for OS Ireland grid references (TM75).
- * @package Modules
- * @subpackage OSGB Grid References
- * @author Indicia Team
*/
class osie {
/**
* Returns true if the spatial reference is a recognised Irish Grid square.
*
- * @param $sref string Spatial reference to validate
+ * @param $sref string
+ * Spatial reference to validate
*/
- public static function is_valid($sref)
- {
- // ignore any spaces in the grid ref
- $sref = str_replace(' ','',$sref);
+ public static function is_valid($sref) {
+ // Ignore any spaces in the grid ref.
+ $sref = str_replace(' ', '', $sref);
$sq100 = strtoupper(substr($sref, 0, 1));
- if (!preg_match('([A-HJ-Z])', $sq100))
+ if (!preg_match('([A-HJ-Z])', $sq100)) {
return FALSE;
- $eastnorth=substr($sref, 1);
+ }
+ $eastnorth = substr($sref, 1);
// 2 cases - either remaining chars must be all numeric and an equal number, up to 10 digits
// OR for DINTY Tetrads, 2 numbers followed by a letter (Excluding O, including I)
- if ((!preg_match('/^[0-9]*$/', $eastnorth) || strlen($eastnorth) % 2 != 0 || strlen($eastnorth)>10) AND
- (!preg_match('/^[0-9][0-9][A-NP-Z]$/', $eastnorth)))
+ if ((!preg_match('/^[0-9]*$/', $eastnorth) || strlen($eastnorth) % 2 != 0 || strlen($eastnorth) > 10) &&
+ (!preg_match('/^[0-9][0-9][A-NP-Z]$/', $eastnorth))) {
return FALSE;
+ }
return TRUE;
}
@@ -53,13 +50,15 @@ public static function is_valid($sref)
* Converts a grid reference in OSI notation into the WKT text for the polygon, in
* easting and northings from the zero reference.
*
- * @param string $sref The grid reference
- * @return string String containing the well known text.
+ * @param string $sref
+ * The grid reference.
+ *
+ * @return string
+ * String containing the well known text.
*/
- public static function sref_to_wkt($sref)
- {
+ public static function sref_to_wkt($sref) {
// ignore any spaces in the grid ref
- $sref = str_replace(' ','',$sref);
+ $sref = str_replace(' ', '', $sref);
if (!self::is_valid($sref))
throw new InvalidArgumentException('Spatial reference is not a recognisable grid square.', 4001);
$sq_100 = self::get_100k_square($sref);
diff --git a/modules/taxon_associations/tests/TaxonAssocations_ServicesTest.php b/modules/taxon_associations/tests/TaxonAssocations_ServicesTest.php
index 75b81c2cd8..2e5c2165c8 100644
--- a/modules/taxon_associations/tests/TaxonAssocations_ServicesTest.php
+++ b/modules/taxon_associations/tests/TaxonAssocations_ServicesTest.php
@@ -3,9 +3,9 @@
require_once 'client_helpers/data_entry_helper.php';
require_once 'client_helpers/submission_builder.php';
-define ('CORE_FIXTURE_TERMLIST_COUNT', 4);
-define ('CORE_FIXTURE_TERM_COUNT', 5);
-define ('CORE_FIXTURE_TERMLISTS_TERM_COUNT', 5);
+define('CORE_FIXTURE_TERMLIST_COUNT', 4);
+define('CORE_FIXTURE_TERM_COUNT', 5);
+define('CORE_FIXTURE_TERMLISTS_TERM_COUNT', 5);
class TaxonAssociations_ServicesTest extends Indicia_DatabaseTestCase {
@@ -13,16 +13,16 @@ class TaxonAssociations_ServicesTest extends Indicia_DatabaseTestCase {
public function getDataSet()
{
- $ds1 = new PHPUnit_Extensions_Database_DataSet_YamlDataSet('modules/phpUnit/config/core_fixture.yaml');
+ $ds1 = new PHPUnit_Extensions_Database_DataSet_YamlDataSet('modules/phpUnit/config/core_fixture.yaml');
$ds2 = new Indicia_ArrayDataSet(
- array(
- 'meanings' => array(
- array(
- 'id' => 20000
- )
- ),
- 'termlists' => array(
- array(
+ [
+ 'meanings' => [
+ [
+ 'id' => 20000,
+ ],
+ ],
+ 'termlists' => [
+ [
'title' => 'Taxon association types',
'description' => 'Types of associations between taxa',
'website_id' => 1,
@@ -30,21 +30,21 @@ public function getDataSet()
'created_by_id' => 1,
'updated_on' => '2016-07-22:16:00:00',
'updated_by_id' => 1,
- 'external_key' => NULL
- ),
- ),
- 'terms' => array(
- array(
+ 'external_key' => NULL,
+ ],
+ ],
+ 'terms' => [
+ [
'term' => 'is associated with',
'language_id' => 1,
'created_on' => '2016-07-22:16:00:00',
'created_by_id' => 1,
'updated_on' => '2016-07-22:16:00:00',
- 'updated_by_id' => 1
- ),
- ),
- 'termlists_terms' => array(
- array(
+ 'updated_by_id' => 1,
+ ],
+ ],
+ 'termlists_terms' => [
+ [
'termlist_id' => CORE_FIXTURE_TERMLIST_COUNT + 1,
'term_id' => CORE_FIXTURE_TERM_COUNT + 1,
'created_on' => '2016-07-22:16:00:00',
@@ -52,11 +52,11 @@ public function getDataSet()
'updated_on' => '2016-07-22:16:00:00',
'updated_by_id' => 1,
'meaning_id' => 20000,
- 'preferred' => true,
- 'sort_order' => 1
- ),
- ),
- )
+ 'preferred' => TRUE,
+ 'sort_order' => 1,
+ ],
+ ],
+ ]
);
$compositeDs = new PHPUnit_Extensions_Database_DataSet_CompositeDataSet();
@@ -67,20 +67,30 @@ public function getDataSet()
public function setup() {
$this->auth = data_entry_helper::get_read_write_auth(1, 'password');
- // make the tokens re-usable
- $this->auth['write_tokens']['persist_auth']=true;
+ // Make the tokens re-usable.
+ $this->auth['write_tokens']['persist_auth'] = true;
parent::setup();
}
function testPost() {
- $array = array(
+ $array = [
'taxon_association:from_taxon_meaning_id' => 10000,
'taxon_association:to_taxon_meaning_id' => 10001,
'taxon_association:association_type_id' => CORE_FIXTURE_TERMLISTS_TERM_COUNT + 1,
+ ];
+ $s = submission_builder::build_submission(
+ $array, ['model' => 'taxon_association']
+ );
+ $r = data_entry_helper::forward_post_to(
+ 'taxon_association', $s, $this->auth['write_tokens']
+ );
+ Kohana::log(
+ 'debug',
+ "Submission response to taxon_association save " . print_r($r, TRUE)
+ );
+ $this->assertTrue(
+ isset($r['success']),
+ 'Submitting a taxon_association did not return success response'
);
- $s = submission_builder::build_submission($array, array('model' => 'taxon_association'));
- $r = data_entry_helper::forward_post_to('taxon_association', $s, $this->auth['write_tokens']);
- Kohana::log('debug', "Submission response to taxon_association save " . print_r($r, TRUE));
- $this->assertTrue(isset($r['success']), 'Submitting a taxon_association did not return success response');
}
}
\ No newline at end of file
diff --git a/modules/workflow/controllers/workflow_event.php b/modules/workflow/controllers/workflow_event.php
index 656b4070cc..d6b6ad02c1 100644
--- a/modules/workflow/controllers/workflow_event.php
+++ b/modules/workflow/controllers/workflow_event.php
@@ -53,6 +53,27 @@ protected function get_action_columns() {
);
}
+ /**
+ * Convert location_ids_filter to suitable default for the sub_list control.
+ */
+ protected function getModelValues() {
+ $r = parent::getModelValues();
+ $r['location_ids_filter_array'] = [];
+ if (preg_match('/^{(?
\d+(,\d+)*)}$/', $r['workflow_event:location_ids_filter'], $matches)) {
+ $ids = explode(',', $matches['list']);
+ foreach ($ids as $id) {
+ $location = ORM::factory('location', $id);
+ $r['location_ids_filter_array'][] = [
+ 'caption' => $location->name,
+ 'fieldname' => 'workflow_event:location_ids_filter[]',
+ 'default' => $id,
+ ];
+ }
+
+ }
+ return $r;
+ }
+
/**
* Prepares any additional data required by the edit view.
*
diff --git a/modules/workflow/db/version_6_3_0/202108160940_workflow_filters.sql b/modules/workflow/db/version_6_3_0/202108160940_workflow_filters.sql
new file mode 100644
index 0000000000..0892ce934d
--- /dev/null
+++ b/modules/workflow/db/version_6_3_0/202108160940_workflow_filters.sql
@@ -0,0 +1,17 @@
+ALTER TABLE workflow_events
+ ADD COLUMN attrs_filter_term text;
+
+ALTER TABLE workflow_events
+ ADD COLUMN attrs_filter_values text[];
+
+ALTER TABLE workflow_events
+ADD COLUMN location_ids_filter integer[];
+
+COMMENT ON COLUMN workflow_events.attrs_filter_term IS
+ 'When this event should only trigger if a certain attribute value is present, specify the DwC term here which identifies the attribute to use (e.g. ReproductiveCondition or Stage). Typically used to limit bird events to breeding ReproductiveCondition terms.';
+
+COMMENT ON COLUMN workflow_events.attrs_filter_values IS
+ 'When this event should only trigger if a certain attribute value is present, specify the list of triggering values here. A record matching any value in the list will trigger the event.';
+
+COMMENT ON COLUMN workflow_events.location_ids_filter IS
+ 'When this event should only trigger if the record overlaps an indexed location boundary, specify the location ID or list of IDs here. Used to limit alerts to geographic areas.';
\ No newline at end of file
diff --git a/modules/workflow/helpers/task_workflow_event_check_filters.php b/modules/workflow/helpers/task_workflow_event_check_filters.php
new file mode 100644
index 0000000000..fdc1fe2f96
--- /dev/null
+++ b/modules/workflow/helpers/task_workflow_event_check_filters.php
@@ -0,0 +1,80 @@
+>'workflow_events.id'
+LEFT JOIN samples s ON s.id=o.sample_id AND e.location_ids_filter is not null
+LEFT JOIN locations l ON l.id = ANY(e.location_ids_filter) AND st_intersects(l.boundary_geom, s.geom)
+LEFT JOIN (occurrence_attribute_values v
+ JOIN cache_termlists_terms t on t.id=v.int_value
+ JOIN occurrence_attributes a ON a.id=v.occurrence_attribute_id
+) ON v.occurrence_id=o.id AND e.attrs_filter_term IS NOT NULL
+ -- case insensitive array check.
+ AND lower(t.term)=ANY(lower(e.attrs_filter_values::text)::text[])
+ AND lower(a.term_name)=lower(e.attrs_filter_term)
+WHERE q.entity='occurrence' AND q.task='task_workflow_event_check_filters' AND claimed_by='$procId'
+-- Need to either fail on the locations filter, or attribute values filter.
+AND ((e.location_ids_filter IS NOT NULL AND l.id IS NULL)
+OR (e.attrs_filter_term IS NOT NULL AND v.id IS NULL));
+SQL;
+ $tasks = $db->query($qry);
+ $occurrenceIds = [];
+ foreach ($tasks as $task) {
+ $occurrenceIds[] = $task->record_id;
+ }
+ // For the records outside the workflow_event's filter we can rewind them.
+ $rewinds = workflow::getRewindChangesForRecords($db, 'occurrence', $occurrenceIds, ['S', 'V', 'R']);
+ foreach ($rewinds as $key => $rewind) {
+ list($entity, $id) = explode('.', $key);
+ $obj = ORM::factory($entity, $id);
+ foreach ($rewind as $field => $value) {
+ $obj->$field = $value;
+ }
+ $obj->save();
+ }
+ }
+
+}
diff --git a/modules/workflow/helpers/workflow.php b/modules/workflow/helpers/workflow.php
index 29949a4790..0fb203a632 100644
--- a/modules/workflow/helpers/workflow.php
+++ b/modules/workflow/helpers/workflow.php
@@ -45,8 +45,9 @@ public static function getEntityConfig($entity) {
/**
* Applies undo data to rewind records to their originally posted state.
*
- * This occurs when a record has been modified by the workflow system because of a particular key value linking it to
- * a workflow event record, then the key value is changed so the workflow event is no longer relevant.
+ * This occurs when a record has been modified by the workflow system because
+ * of a particular key value linking it to a workflow event record, then the
+ * key value is changed so the workflow event is no longer relevant.
*
* @param object $db
* Database connection.
@@ -71,16 +72,17 @@ public static function getRewoundRecord($db, $entity, $oldRecord, &$newRecord) {
}
$eventTypes = [];
foreach ($entityConfig['keys'] as $keyDef) {
- $keyChanged = false;
+ $keyChanged = FALSE;
// We need to know if the key has changed to decide whether to wind back.
// If the key is in the main entity, we can directly compare the old and new keys.
if ($keyDef['table'] === $entity) {
$keyCol = $keyDef['column'];
- $keyChanged = (string) $oldRecord->$column !== (string) $newRecord->column;
+ $keyChanged = (string) $oldRecord->column !== (string) $newRecord->column;
}
else {
- // Find the definintion of the extra data table that contains the column we need to look for changes in. We can
- // then look to see if the foreign key pointing to that table has changed.
+ // Find the definintion of the extra data table that contains the
+ // column we need to look for changes in. We can then look to see if
+ // the foreign key pointing to that table has changed.
foreach ($entityConfig['extraData'] as $extraDataDef) {
if ($extraDataDef['table'] === $keyDef['table']) {
$column = $extraDataDef['originating_table_column'];
@@ -94,7 +96,8 @@ public static function getRewoundRecord($db, $entity, $oldRecord, &$newRecord) {
}
if ($entity === 'occurrence'
&& $oldRecord->record_status !== $newRecord->record_status) {
- // Remove previuos verification and rejection workflow changes as the record status is changing.
+ // Remove previuos verification and rejection workflow changes as the
+ // record status is changing.
$eventTypes[] = 'V';
$eventTypes[] = 'R';
}
@@ -129,17 +132,18 @@ public static function getRewoundRecord($db, $entity, $oldRecord, &$newRecord) {
* List of event types to rewind ('S', 'V', 'R').
*
* @return array
- * Associatie array keyed by entity.entity_id, containing an array of the fields with undo values to apply.
+ * Associate array keyed by entity.entity_id, containing an array of the
+ * fields with undo values to apply.
*/
public static function getRewindChangesForRecords($db, $entity, array $entityIdList, array $eventTypes) {
$r = [];
$undoRecords = $db
->select('DISTINCT workflow_undo.id, workflow_undo.entity_id, workflow_undo.original_values')
->from('workflow_undo')
- ->where(array(
+ ->where([
'workflow_undo.entity' => $entity,
'workflow_undo.active' => 't',
- ))
+ ])
->in('event_type', $eventTypes)
->in('entity_id', $entityIdList)
->orderby('workflow_undo.id', 'DESC')
@@ -154,7 +158,7 @@ public static function getRewindChangesForRecords($db, $entity, array $entityIdL
$r["$entity.$undoRecord->entity_id"] = array_merge($r["$entity.$undoRecord->entity_id"], $unsetColumns);
}
// As this is a hard rewind, disable the undo data.
- $db->update('workflow_undo', array('active' => 'f'), array('id' => $undoRecord->id));
+ $db->update('workflow_undo', ['active' => 'f'], ['id' => $undoRecord->id]);
}
return $r;
}
@@ -164,7 +168,7 @@ public static function getRewindChangesForRecords($db, $entity, array $entityIdL
*
* @param object $db
* Database connection.
- * @param int $websiteId
+ * @param int $websiteId
* ID of the website the update is associated with.
* @param string $entity
* Name of the database entity being saved, e.g. occurrence.
@@ -174,8 +178,8 @@ public static function getRewindChangesForRecords($db, $entity, array $entityIdL
* List of event types to include in the results.
*
* @return array
- * List of records with events attached (keyed by entity.id), with each entry containing an array of the events
- * associated with that record.
+ * List of records with events attached (keyed by entity.id), with each
+ * entry containing an array of the events associated with that record.
*/
public static function getEventsForRecords($db, $websiteId, $entity, array $entityIdList, array $eventTypes) {
$r = [];
@@ -192,13 +196,13 @@ public static function getEventsForRecords($db, $websiteId, $entity, array $enti
$table = inflector::plural($entity);
foreach ($entityConfig['keys'] as $keyDef) {
$qry = $db
- ->select('workflow_events.key_value, workflow_events.event_type, workflow_events.mimic_rewind_first, ' .
- "workflow_events.values, $table.id as {$entity}_id")
+ ->select('workflow_events.id, workflow_events.key_value, workflow_events.event_type, workflow_events.mimic_rewind_first, ' .
+ "workflow_events.values, $table.id as {$entity}_id, workflow_events.attrs_filter_term, workflow_events.location_ids_filter")
->from('workflow_events')
- ->where(array(
+ ->where([
'workflow_events.deleted' => 'f',
'key' => $keyDef['db_store_value'],
- ))
+ ])
->in('group_code', $groupCodes)
->in('workflow_events.event_type', $eventTypes);
if ($keyDef['table'] === $entity) {
@@ -207,7 +211,8 @@ public static function getEventsForRecords($db, $websiteId, $entity, array $enti
}
else {
$qry->join($keyDef['table'], "$keyDef[table].$keyDef[column]", 'workflow_events.key_value');
- // Cross reference to the extraData for the same table to find the field name which matches $newRecord->column.
+ // Cross reference to the extraData for the same table to find the
+ // field name which matches $newRecord->column.
foreach ($entityConfig['extraData'] as $extraDataDef) {
if ($extraDataDef['table'] === $keyDef['table']) {
$qry->join(
@@ -274,8 +279,8 @@ public static function applyWorkflow($db, $websiteId, $entity, $oldRecord, $rewo
/**
* Construct a query to retrieve workflow events.
*
- * Constructs a query object which will find all the events applicable to the current record for a given key in the
- * entity's configuration.
+ * Constructs a query object which will find all the events applicable to the
+ * current record for a given key in the entity's configuration.
*
* @param object $db
* Database connection.
@@ -293,16 +298,17 @@ public static function applyWorkflow($db, $websiteId, $entity, $oldRecord, $rewo
* @return object
* Query object.
*/
- private static function buildEventQueryForKey($db, $groupCodes, $entity, $oldRecord, $newRecord, array $keyDef) {
+ private static function buildEventQueryForKey($db, array $groupCodes, $entity, $oldRecord, $newRecord, array $keyDef) {
$entityConfig = self::getEntityConfig($entity);
$eventTypes = [];
$qry = $db
- ->select('workflow_events.event_type, workflow_events.mimic_rewind_first, workflow_events.values')
+ ->select('workflow_events.id, workflow_events.event_type, workflow_events.mimic_rewind_first, workflow_events.values, ' .
+ 'workflow_events.attrs_filter_term, workflow_events.location_ids_filter')
->from('workflow_events')
- ->where(array(
+ ->where([
'workflow_events.deleted' => 'f',
'key' => $keyDef['db_store_value'],
- ))
+ ])
->in('group_code', $groupCodes);
if ($keyDef['table'] === $entity) {
$column = $keyDef['column'];
@@ -361,8 +367,10 @@ private static function buildEventQueryForKey($db, $groupCodes, $entity, $oldRec
* Finds configured groups which the current operation's website uses the workflow for.
*
* @param int $websiteId
+ * Website ID.
*
* @return array
+ * List of group names.
*/
private static function getGroupCodesForThisWebsite($websiteId) {
$config = kohana::config('workflow_groups', FALSE, FALSE);
@@ -380,8 +388,9 @@ private static function getGroupCodesForThisWebsite($websiteId) {
/**
* Applies the events query results to a record.
*
- * Applies the field value changes determined by a query against the workflow_events table to the contents of a record
- * that is about to be saved.
+ * Applies the field value changes determined by a query against the
+ * workflow_events table to the contents of a record that is about to be
+ * saved.
*
* @param object $qry
* Query object set up to retrieve the events to apply.
@@ -393,15 +402,17 @@ private static function getGroupCodesForThisWebsite($websiteId) {
* @param object $newRecord
* ORM Validation object containing the new record details.
* @param array $state
- * State data to pass through to the post-process hook, containing undo data.
+ * State data to pass through to the post-process hook, containing undo
+ * data.
*/
private static function applyEventsQueryToRecord($qry, $entity, array $oldValues, &$newRecord, array &$state) {
$events = $qry->get();
foreach ($events as $event) {
- $newUndoRecord = array();
kohana::log('debug', 'Processing event: ' . var_export($event, TRUE));
+ $needsFilterCheck = !empty($event->attrs_filter_term) || !empty($event->location_ids_filter);
$valuesToApply = self::processEvent(
$event,
+ $needsFilterCheck,
$entity,
$oldValues,
$newRecord->as_array(),
@@ -416,25 +427,32 @@ private static function applyEventsQueryToRecord($qry, $entity, array $oldValues
/**
* Processes a single workflow event.
*
- * Retrieves a list of the values that need to be applied to a database record given an event. The values may include
- * the results of a mimiced rewind as well as the value changes required for the event.
+ * Retrieves a list of the values that need to be applied to a database
+ * record given an event. The values may include the results of a mimiced
+ * rewind as well as the value changes required for the event.
*
* @param object $event
* Event object loaded from the database query.
+ * @param bool $needsFilterCheck
+ * If true, then the workflow event has an attribute or location filter
+ * that needs double checking via a work queue task.
* @param string $entity
* Name of the database entity being saved, e.g. occurrence.
* @param array $oldValues
* Array of the record values before the save operation. Used to retrieve
* values for undo state data.
* @param array $newValues
- * Array of the record values that were submitted to be saved, causing the event to fire.
+ * Array of the record values that were submitted to be saved, causing the
+ * event to fire.
* @param array $state
- * Array of undo state data which will be updated by this method to allow any proposed changes to be undone.
+ * Array of undo state data which will be updated by this method to allow
+ * any proposed changes to be undone.
*
* @return array
- * Associative array of the database fields and values which need to be applied.
+ * Associative array of the database fields and values which need to be
+ * applied.
*/
- public static function processEvent($event, $entity, array $oldValues, array $newValues, array &$state) {
+ public static function processEvent($event, $needsFilterCheck, $entity, array $oldValues, array $newValues, array &$state) {
$entityConfig = self::getEntityConfig($entity);
$columnDeltaList = [];
$valuesToApply = [];
@@ -463,12 +481,17 @@ public static function processEvent($event, $entity, array $oldValues, array $ne
$valuesToApply[$deltaColumn] = $deltaValue;
}
}
- $state[] = array('event_type' => $event->event_type, 'old_data' => $newUndoRecord);
+ $state[] = [
+ 'event_id' => $event->id,
+ 'needs_filter_check' => $needsFilterCheck,
+ 'event_type' => $event->event_type,
+ 'old_data' => $newUndoRecord,
+ ];
return $valuesToApply;
}
/**
- * Returns true if the current user is allowed to view the workflow configuration pages.
+ * Returns true if the user is allowed to view the workflow config pages.
*
* @param object $auth
* Kohana authorisation object.
@@ -496,8 +519,8 @@ public static function allowWorkflowConfigAccess($auth) {
/**
* Rewind a record.
*
- * If an event wants to mimic a rewind to reset data to its original state, then undoes all changes to the record
- * caused by workflow.
+ * If an event wants to mimic a rewind to reset data to its original state,
+ * then undoes all changes to the record caused by workflow.
*
* @param string $entity
* Name of the database entity being saved, e.g. occurrence.
@@ -506,8 +529,8 @@ public static function allowWorkflowConfigAccess($auth) {
* @param array $columnDeltaList
* Array containing the field values that will be changed by the rewind.
* @param array $state
- * Undo state change data from events applied to the record on this transaction which may need to be rewound.
- * @return void
+ * Undo state change data from events applied to the record on this
+ * transaction which may need to be rewound.
*/
private static function mimicRewind($entity, $entityId, array &$columnDeltaList, array $state) {
for ($i = count($state) - 1; $i >= 0; $i--) {
@@ -516,11 +539,11 @@ private static function mimicRewind($entity, $entityId, array &$columnDeltaList,
}
}
$undoRecords = ORM::factory('workflow_undo')
- ->where(array(
+ ->where([
'entity' => $entity,
'entity_id' => $entityId,
'active' => 't',
- ))
+ ])
->orderby('id', 'DESC')->find_all();
foreach ($undoRecords as $undoRecord) {
kohana::log('debug', 'mimic rewind record: ' . var_export($undoRecord->as_array(), TRUE));
diff --git a/modules/workflow/models/workflow_event.php b/modules/workflow/models/workflow_event.php
index 6779a22c19..0fad0ef59a 100644
--- a/modules/workflow/models/workflow_event.php
+++ b/modules/workflow/models/workflow_event.php
@@ -27,16 +27,20 @@
* Model class for the workflow_event table.
*/
class Workflow_event_Model extends ORM {
- public $search_field='id';
+ public $search_field = 'id';
- protected $belongs_to = array(
+ protected $belongs_to = [
'created_by' => 'user',
- 'updated_by' => 'user'
- );
- protected $has_and_belongs_to_many = array();
+ 'updated_by' => 'user',
+ ];
+ protected $has_and_belongs_to_many = [];
+ /**
+ * Define model validation behaviour.
+ */
public function validate(Validation $array, $save = FALSE) {
- // uses PHP trim() to remove whitespace from beginning and end of all fields before validation
+ // Uses PHP trim() to remove whitespace from beginning and end of all
+ // fields before validation.
$array->pre_filter('trim');
$array->add_rules('entity', 'required');
$array->add_rules('group_code', 'required');
@@ -46,12 +50,37 @@ public function validate(Validation $array, $save = FALSE) {
$array->add_rules('values', 'required');
// Explicitly add those fields for which we don't do validation.
- $this->unvalidatedFields = array(
+ $this->unvalidatedFields = [
'deleted',
'mimic_rewind_first',
- );
+ 'attrs_filter_term',
+ 'attrs_filter_values',
+ 'location_ids_filter',
+ ];
return parent::validate($array, $save);
}
+ /**
+ * Tidy form data to prepare for submission.
+ *
+ * Converts attr_filter_values from form submission string to array. Also
+ * ensures location_ids_filter array is cleaned.
+ */
+ public function preSubmit() {
+ if (!empty($this->submission['fields']['attrs_filter_values']['value'])
+ && is_string($this->submission['fields']['attrs_filter_values']['value'])) {
+ $valueList = str_replace("\r\n", "\n", $this->submission['fields']['attrs_filter_values']['value']);
+ $valueList = str_replace("\r", "\n", $valueList);
+ $valueList = explode("\n", trim($valueList));
+ $this->submission['fields']['attrs_filter_values'] = ['value' => $valueList];
+ }
+ // Due to the way the sub_list control works, we can have hidden empty
+ // values which need to be cleaned.
+ if (!empty($this->submission['fields']['location_ids_filter']['value'])
+ && is_array($this->submission['fields']['location_ids_filter']['value'])) {
+ $this->submission['fields']['location_ids_filter']['value'] = array_values(array_filter($this->submission['fields']['location_ids_filter']['value']));
+ }
+ }
+
}
diff --git a/modules/workflow/plugins/workflow.php b/modules/workflow/plugins/workflow.php
index d3da739359..38f07eb79d 100644
--- a/modules/workflow/plugins/workflow.php
+++ b/modules/workflow/plugins/workflow.php
@@ -17,8 +17,6 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/gpl.html.
*
- * @package Modules
- * @subpackage Workflow
* @author Indicia Team
* @license http://www.gnu.org/licenses/gpl.html GPL
* @link https://github.com/Indicia-Team/
@@ -46,25 +44,27 @@ function workflow_alter_menu($menu, $auth) {
/**
* Implements the extend_data_services hook.
*
- * Determines the data entities which should be added to those available via data services.
+ * Determines the data entities which should be added to those available via
+ * data services.
*
* @return array
* List of database entities exposed by this plugin with configuration.
*/
function workflow_extend_data_services() {
- return array(
- 'workflow_events' => array(),
- 'workflow_metadata' => array('allow_full_access' => TRUE)
- );
+ return [
+ 'workflow_events' => [],
+ 'workflow_metadata' => ['allow_full_access' => TRUE],
+ ];
}
/**
* Pre-record save processing hook.
*
- * Potential problem when a record matches multiple events, and they change the same columns,
- * so we are making the assumption that each record will only fire one alert key/key_value combination
- * undo record would require more details on firing event (key and key_value) if this is changed in future
- * In following code, entity means the orm entity, e.g. 'occurrence'
+ * Potential problem when a record matches multiple events, and they change the
+ * same columns, so we are making the assumption that each record will only
+ * fire one alert key/key_value combination undo record would require more
+ * details on firing event (key and key_value) if this is changed in future.
+ * In following code, entity means the orm entity, e.g. 'occurrence'.
*
* @param object $db
* Database connection.
@@ -81,12 +81,13 @@ function workflow_extend_data_services() {
* State data to pass to the post save processing hook.
*/
function workflow_orm_pre_save_processing($db, $websiteId, $entity, $oldRecord, &$newRecord) {
- $state = array();
+ $state = [];
// Abort if no workflow configuration for this entity.
if (empty(workflow::getEntityConfig($entity))) {
return $state;
}
- // Rewind the record if previous workflow rule changes no longer apply (e.g. after redetermination).
+ // Rewind the record if previous workflow rule changes no longer apply (e.g.
+ // safter redetermination).
$rewoundRecord = workflow::getRewoundRecord($db, $entity, $oldRecord, $newRecord);
// Apply any changes in the workflow_events table relevant to the record.
$state = workflow::applyWorkflow($db, $websiteId, $entity, $oldRecord, $rewoundRecord, $newRecord);
@@ -121,14 +122,27 @@ function workflow_orm_post_save_processing($db, $entity, $record, array $state,
$userId = security::getUserId();
// Insert any state undo records.
foreach ($state as $undoDetails) {
- $db->insert('workflow_undo', array(
+ $db->insert('workflow_undo', [
'entity' => $entity,
'entity_id' => $id,
'event_type' => $undoDetails['event_type'],
'created_on' => date("Ymd H:i:s"),
'created_by_id' => $userId,
- 'original_values' => json_encode($undoDetails['old_data'])
- ));
+ 'original_values' => json_encode($undoDetails['old_data']),
+ ]);
+ if ($undoDetails['needs_filter_check']) {
+ $q = new WorkQueue();
+ $q->enqueue($db, [
+ 'task' => 'task_workflow_event_check_filters',
+ 'entity' => $entity,
+ 'record_id' => $id,
+ 'cost_estimate' => 50,
+ 'priority' => 2,
+ 'params' => json_encode([
+ 'workflow_events.id' => $undoDetails['event_id'],
+ ]),
+ ]);
+ }
}
return TRUE;
}
diff --git a/modules/workflow/views/workflow_event/edit.js b/modules/workflow/views/workflow_event/edit.js
index df57119755..70e0a20b71 100644
--- a/modules/workflow/views/workflow_event/edit.js
+++ b/modules/workflow/views/workflow_event/edit.js
@@ -1,8 +1,16 @@
jQuery(document).ready(function($) {
$('#taxon_list_id').change(function() {
- var options = $('input#workflow_event\\:key_value\\:taxon').indiciaAutocomplete('option');
- options.extraParams.taxon_list_id = $('#taxon_list_id').val();
- $('input#workflow_event\\:key_value\\:taxon').indiciaAutocomplete('option', options);
+ $('input#workflow_event\\:key_value\\:taxon').setExtraParams({
+ taxon_list_id: $('#taxon_list_id').val()
+ });
+ });
+
+ $('#location_type').change(function() {
+ // Remove any hanging autocomplete select list.
+ $('.ac_results').hide();
+ $('#workflow_event\\:location_ids_filter\\:search\\:name').setExtraParams({
+ location_type_id: $('#location_type').val()
+ });
});
$('#workflow_event\\:entity').change(function entityChange() {
diff --git a/modules/workflow/views/workflow_event/index.php b/modules/workflow/views/workflow_event/index.php
index 69ab0f16d1..4e60a49f41 100644
--- a/modules/workflow/views/workflow_event/index.php
+++ b/modules/workflow/views/workflow_event/index.php
@@ -31,7 +31,7 @@
echo $grid;
?>
db->select('*')->from('system')->where('name', 'workflow')->get()->as_array(TRUE);
diff --git a/modules/workflow/views/workflow_event/workflow_event_edit.php b/modules/workflow/views/workflow_event/workflow_event_edit.php
index 53ac130b28..e7ff83e52c 100644
--- a/modules/workflow/views/workflow_event/workflow_event_edit.php
+++ b/modules/workflow/views/workflow_event/workflow_event_edit.php
@@ -24,21 +24,20 @@
* @link https://github.com/Indicia-Team/
*/
-require_once DOCROOT . 'client_helpers/data_entry_helper.php';
+warehouse::loadHelpers(['data_entry_helper']);
+$id = html::initial_value($values, 'workflow_event:id');
if (isset($_POST)) {
data_entry_helper::dump_errors(['errors' => $this->model->getAllErrors()]);
}
$readAuth = data_entry_helper::get_read_auth(0 - $_SESSION['auth_user']->id, kohana::config('indicia.private_key'));
?>
-