/**
* Returns representation_id for the object representation with the specified name (and type) or idno (regardless of specified type.) If the object does
* not already exist then it will be created with the specified name, type and locale, as well as with any specified values in the $pa_values array.
* $pa_values keys should be either valid object fields or attributes.
*
* @param string $ps_representation_name Object label name
* @param int $pn_type_id The type_id of the object type to use if the representation needs to be created
* @param int $pn_locale_id The locale_id to use if the representation needs to be created (will be used for both the object locale as well as the label locale)
* @param array $pa_values An optional array of additional values to populate newly created representation records with. These values are *only* used for newly created representation; they will not be applied if the representation named already exists. The array keys should be names of ca_object_representations fields or valid representation attributes. Values should be either a scalar (for single-value attributes) or an array of values for (multi-valued attributes)
* @param array $pa_options An optional array of options, which include:
* outputErrors - if true, errors will be printed to console [default=false]
* matchOn = optional list indicating sequence of checks for an existing record; values of array can be "label" and "idno". Ex. array("idno", "label") will first try to match on idno and then label if the first match fails.
* dontCreate - if true then new representations will not be created [default=false]
* transaction - if Transaction object is passed, use it for all Db-related tasks [default=null]
* returnInstance = return ca_object_representations instance rather than representation_id. Default is false.
* generateIdnoWithTemplate = A template to use when setting the idno. The template is a value with automatically-set SERIAL values replaced with % characters. Eg. 2012.% will set the created row's idno value to 2012.121 (assuming that 121 is the next number in the serial sequence.) The template is NOT used if idno is passed explicitly as a value in $pa_values.
* importEvent = if ca_data_import_events instance is passed then the insert/update of the representation will be logged as part of the import
* importEventSource = if importEvent is passed, then the value set for importEventSource is used in the import event log as the data source. If omitted a default value of "?" is used
* nonPreferredLabels = an optional array of nonpreferred labels to add to any newly created representations. Each label in the array is an array with required representation label values.
* log = if KLogger instance is passed then actions will be logged
* matchMediaFilesWithoutExtension = if media path is invalid, attempt to find media in referenced directory and sub-directories that has a matching name, regardless of file extension. [default=false]
* @return bool|ca_object_representations|mixed|null
*/
static function getObjectRepresentationID($ps_representation_name, $pn_type_id, $pn_locale_id, $pa_values = null, $pa_options = null)
{
if (!is_array($pa_options)) {
$pa_options = array();
}
if (!isset($pa_options['outputErrors'])) {
$pa_options['outputErrors'] = false;
}
$vb_match_media_without_extension = caGetOption('matchMediaFilesWithoutExtension', $pa_options, false);
$pa_match_on = caGetOption('matchOn', $pa_options, array('label', 'idno'), array('castTo' => "array"));
/** @var ca_data_import_events $o_event */
$o_event = isset($pa_options['importEvent']) && $pa_options['importEvent'] instanceof ca_data_import_events ? $pa_options['importEvent'] : null;
$t_rep = new ca_object_representations();
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_rep->setTransaction($pa_options['transaction']);
if ($o_event) {
$o_event->setTransaction($pa_options['transaction']);
}
}
$vs_event_source = isset($pa_options['importEventSource']) && $pa_options['importEventSource'] ? $pa_options['importEventSource'] : "?";
/** @var KLogger $o_log */
$o_log = isset($pa_options['log']) && $pa_options['log'] instanceof KLogger ? $pa_options['log'] : null;
$vs_idno = isset($pa_values['idno']) ? (string) $pa_values['idno'] : null;
if (preg_match('!\\%!', $vs_idno)) {
$pa_options['generateIdnoWithTemplate'] = $vs_idno;
$vs_idno = null;
}
if (!$vs_idno) {
if (isset($pa_options['generateIdnoWithTemplate']) && $pa_options['generateIdnoWithTemplate']) {
$vs_idno = $t_rep->setIdnoWithTemplate($pa_options['generateIdnoWithTemplate'], array('dontSetValue' => true));
}
}
$va_regex_list = caBatchGetMediaFilenameToIdnoRegexList(array('log' => $o_log));
// Get list of replacements that user can use to transform file names to match object idnos
$va_replacements_list = caBatchGetMediaFilenameReplacementRegexList(array('log' => $o_log));
$vn_id = null;
foreach ($pa_match_on as $vs_match_on) {
switch (strtolower($vs_match_on)) {
case 'label':
case 'labels':
if (trim($ps_representation_name)) {
if ($vn_id = ca_object_representations::find(array('preferred_labels' => array('name' => $ps_representation_name), 'type_id' => $pn_type_id), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 2;
}
}
break;
case 'idno':
if (!$vs_idno) {
break;
}
if ($vs_idno == '%') {
break;
}
// don't try to match on an unreplaced idno placeholder
$va_idnos_to_match = array($vs_idno);
if (is_array($va_replacements_list)) {
foreach ($va_replacements_list as $vs_replacement_code => $va_replacement) {
if (isset($va_replacement['search']) && is_array($va_replacement['search'])) {
$va_replace = caGetOption('replace', $va_replacement);
$va_search = array();
foreach ($va_replacement['search'] as $vs_search) {
$va_search[] = '!' . $vs_search . '!';
}
if ($vs_idno_proc = @preg_replace($va_search, $va_replace, $vs_idno)) {
$va_idnos_to_match[] = $vs_idno_proc;
}
}
}
}
if (is_array($va_regex_list) && sizeof($va_regex_list)) {
foreach ($va_regex_list as $vs_regex_name => $va_regex_info) {
foreach ($va_regex_info['regexes'] as $vs_regex) {
foreach ($va_idnos_to_match as $vs_idno_match) {
if (!$vs_idno_match) {
continue;
}
if (preg_match('!' . $vs_regex . '!', $vs_idno_match, $va_matches)) {
if ($vn_id = ca_object_representations::find(array('idno' => $va_matches[1]), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 5;
}
}
}
}
}
} else {
foreach ($va_idnos_to_match as $vs_idno_match) {
if (!$vs_idno_match) {
continue;
}
if ($vn_id = ca_object_representations::find(array('idno' => $vs_idno_match), array('returnAs' => 'firstId', 'transaction' => $pa_options['transaction']))) {
break 3;
}
}
}
break;
}
}
if (!$vn_id) {
if (isset($pa_options['dontCreate']) && $pa_options['dontCreate']) {
return false;
}
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_object_representations', 'I');
}
$t_rep->setMode(ACCESS_WRITE);
$t_rep->set('locale_id', $pn_locale_id);
$t_rep->set('type_id', $pn_type_id);
$t_rep->set('source_id', isset($pa_values['source_id']) ? $pa_values['source_id'] : null);
$t_rep->set('access', isset($pa_values['access']) ? $pa_values['access'] : 0);
$t_rep->set('status', isset($pa_values['status']) ? $pa_values['status'] : 0);
if (isset($pa_values['media']) && $pa_values['media']) {
if ($vb_match_media_without_extension && !isURL($pa_values['media']) && !file_exists($pa_values['media'])) {
$vs_dirname = pathinfo($pa_values['media'], PATHINFO_DIRNAME);
$vs_filename = preg_replace('!\\.[A-Za-z0-9]{1,4}$!', '', pathinfo($pa_values['media'], PATHINFO_BASENAME));
$vs_original_path = $pa_values['media'];
$pa_values['media'] = null;
$va_files_in_dir = caGetDirectoryContentsAsList($vs_dirname, true, false, false, false);
foreach ($va_files_in_dir as $vs_filepath) {
if ($o_log) {
$o_log->logDebug(_t("Trying media %1 in place of %2/%3", $vs_filepath, $vs_original_path, $vs_filename));
}
if (pathinfo($vs_filepath, PATHINFO_FILENAME) == $vs_filename) {
if ($o_log) {
$o_log->logNotice(_t("Found media %1 for %2/%3", $vs_filepath, $vs_original_path, $vs_filename));
}
$pa_values['media'] = $vs_filepath;
break;
}
}
}
$t_rep->set('media', $pa_values['media']);
}
$t_rep->set('idno', $vs_idno);
$t_rep->insert();
if ($t_rep->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not insert object %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not insert object %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())));
}
return null;
}
$vb_label_errors = false;
$t_rep->addLabel(array('name' => $ps_representation_name), $pn_locale_id, null, true);
if ($t_rep->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set preferred label for object %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set preferred label for object %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())));
}
$vb_label_errors = true;
}
/** @var IIDNumbering $o_idno */
if ($o_idno = $t_rep->getIDNoPlugInInstance()) {
$va_values = $o_idno->htmlFormValuesAsArray('idno', $vs_idno);
if (!is_array($va_values)) {
$va_values = array($va_values);
}
if (!($vs_sep = $o_idno->getSeparator())) {
$vs_sep = '';
}
if (($vs_proc_idno = join($vs_sep, $va_values)) && $vs_proc_idno != $vs_idno) {
$t_rep->set('idno', $vs_proc_idno);
$t_rep->update();
if ($t_rep->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not update idno for %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not object idno for %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())));
}
return null;
}
}
}
unset($pa_values['access']);
unset($pa_values['status']);
unset($pa_values['idno']);
unset($pa_values['source_id']);
$vb_attr_errors = false;
if (is_array($pa_values)) {
foreach ($pa_values as $vs_element => $va_values) {
if (!caIsIndexedArray($va_values)) {
$va_values = array($va_values);
}
foreach ($va_values as $va_value) {
if (is_array($va_value)) {
// array of values (complex multi-valued attribute)
$t_rep->addAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_rep->addAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_rep->update();
if ($t_rep->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set values for representation %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set values for representation %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())));
}
$vb_attr_errors = true;
}
}
if (is_array($va_nonpreferred_labels = caGetOption("nonPreferredLabels", $pa_options, null))) {
if (caIsAssociativeArray($va_nonpreferred_labels)) {
// single non-preferred label
$va_labels = array($va_nonpreferred_labels);
} else {
// list of non-preferred labels
$va_labels = $va_nonpreferred_labels;
}
foreach ($va_labels as $va_label) {
$t_rep->addLabel($va_label, $pn_locale_id, null, false);
if ($t_rep->numErrors()) {
if (isset($pa_options['outputErrors']) && $pa_options['outputErrors']) {
print "[Error] " . _t("Could not set non-preferred label for representation %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())) . "\n";
}
if ($o_log) {
$o_log->logError(_t("Could not set non-preferred label for representation %1: %2", $ps_representation_name, join('; ', $t_rep->getErrors())));
}
}
}
}
$vn_representation_id = $t_rep->getPrimaryKey();
if ($o_event) {
if ($vb_attr_errors || $vb_label_errors) {
$o_event->endItem($vn_representation_id, __CA_DATA_IMPORT_ITEM_PARTIAL_SUCCESS__, _t("Errors setting field values: %1", join('; ', $t_rep->getErrors())));
} else {
$o_event->endItem($vn_representation_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
}
if ($o_log) {
$o_log->logInfo(_t("Created new representation %1", $ps_representation_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
return $t_rep;
}
} else {
if ($o_event) {
$o_event->beginItem($vs_event_source, 'ca_object_representations', 'U');
}
$vn_representation_id = $vn_id;
if ($o_event) {
$o_event->endItem($vn_representation_id, __CA_DATA_IMPORT_ITEM_SUCCESS__, '');
}
if ($o_log) {
$o_log->logDebug(_t("Found existing representation %1 in DataMigrationUtils::getObjectRepresentationID()", $ps_representation_name));
}
if (isset($pa_options['returnInstance']) && $pa_options['returnInstance']) {
$t_rep = new ca_object_representations($vn_representation_id);
if (isset($pa_options['transaction']) && $pa_options['transaction'] instanceof Transaction) {
$t_rep->setTransaction($pa_options['transaction']);
}
return $t_rep;
}
}
return $vn_representation_id;
}
/**
* Add media represention to currently loaded item
*
* @param $ps_media_path - the path to the media you want to add
* @param $pn_type_id - the item_id of the representation type, in the ca_list with list_code 'object_represention_types'
* @param $pn_locale_id - the locale_id of the locale of the representation
* @param $pn_status - the status code for the representation (as defined in item_value fields of items in the 'workflow_statuses' ca_list)
* @param $pn_access - the access code for the representation (as defined in item_value fields of items in the 'access_statuses' ca_list)
* @param $pb_is_primary - if set to true, representation is designated "primary." Primary representation are used in cases where only one representation is required (such as search results). If a primary representation is already attached to this item, then it will be changed to non-primary as only one representation can be primary at any given time. If no primary representations exist, then the new representation will always be marked primary no matter what the setting of this parameter (there must always be a primary representation, if representations are defined).
* @param $pa_values - array of attributes to attach to new representation
* @param $pa_options - an array of options passed through to BaseModel::set() when creating the new representation. Currently supported options:
* original_filename - the name of the file being uploaded; will be recorded in the database and used as the filename when the file is subsequently downloaded
* rank - a numeric rank used to order the representations when listed
* returnRepresentation = if set the newly created ca_object_representations instance is returned rather than the link_id of the newly created relationship record
* matchOn =
* centerX = Horizontal position of image center used when cropping as a percentage expressed as a decimal between 0 and 1. If omitted existing value is maintained. Note that both centerX and centerY must be specified for the center to be changed.
* centerY = Vertical position of image center used when cropping as a percentage expressed as a decimal between 0 and 1. If omitted existing value is maintained. Note that both centerX and centerY must be specified for the center to be changed.
*
* @return mixed Returns primary key (link_id) of the relatipnship row linking the newly created representation to the item; if the 'returnRepresentation' is set then an instance for the newly created ca_object_representations is returned instead; boolean false is returned on error
*/
public function addRepresentation($ps_media_path, $pn_type_id, $pn_locale_id, $pn_status, $pn_access, $pb_is_primary, $pa_values = null, $pa_options = null)
{
if (!($vn_id = $this->getPrimaryKey())) {
return null;
}
if (!$pn_locale_id) {
$pn_locale_id = ca_locales::getDefaultCataloguingLocaleID();
}
$t_rep = new ca_object_representations();
if ($this->inTransaction()) {
$t_rep->setTransaction($this->getTransaction());
}
$vn_rep_id = null;
if (is_array($va_match_on = caGetOption('matchOn', $pa_options, null))) {
$va_ids = null;
foreach ($va_match_on as $vs_match_on) {
switch ($vs_match_on) {
case 'idno':
if (!trim($pa_values['idno'])) {
break;
}
$va_ids = ca_object_representations::find(array('idno' => trim($pa_values['idno'])), array('returnAs' => 'ids'));
break;
case 'label':
if (!trim($pa_values['preferred_labels']['name'])) {
break;
}
$va_ids = ca_object_representations::find(array('preferred_labels' => array('name' => trim($pa_values['preferred_labels']['name']))), array('returnAs' => 'ids'));
break;
}
if (is_array($va_ids) && sizeof($va_ids)) {
$vn_rep_id = array_shift($va_ids);
break;
}
}
}
if (!$vn_rep_id) {
$t_rep->setMode(ACCESS_WRITE);
$t_rep->set('type_id', $pn_type_id);
$t_rep->set('locale_id', $pn_locale_id);
$t_rep->set('status', $pn_status);
$t_rep->set('access', $pn_access);
$t_rep->set('media', $ps_media_path, $pa_options);
$o_idno = $t_rep->getIDNoPlugInInstance();
$t_rep->setIdnoWithTemplate($o_idno->makeTemplateFromValue(''));
if (is_array($pa_values)) {
if (isset($pa_values['idno'])) {
$t_rep->set('idno', $pa_values['idno']);
unset($pa_values['idno']);
}
foreach ($pa_values as $vs_element => $va_value) {
if (is_array($va_value)) {
// array of values (complex multi-valued attribute)
$t_rep->addAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_rep->addAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_rep->insert();
if ($t_rep->numErrors()) {
$this->errors = array_merge($this->errors, $t_rep->errors());
return false;
}
if ($t_rep->getPreferredLabelCount() == 0) {
$vs_label = isset($pa_values['name']) && $pa_values['name'] ? $pa_values['name'] : '[' . _t('BLANK') . ']';
$t_rep->addLabel(array('name' => $vs_label), $pn_locale_id, null, true);
if ($t_rep->numErrors()) {
$this->errors = array_merge($this->errors, $t_rep->errors());
return false;
}
}
} else {
$t_rep->load($vn_rep_id);
$t_rep->setMode(ACCESS_WRITE);
$t_rep->set('status', $pn_status);
$t_rep->set('access', $pn_access);
if ($ps_media_path) {
$t_rep->set('media', $ps_media_path, $pa_options);
}
if (is_array($pa_values)) {
if (isset($pa_values['idno'])) {
$t_rep->set('idno', $pa_values['idno']);
unset($pa_values['idno']);
}
foreach ($pa_values as $vs_element => $va_value) {
if (is_array($va_value)) {
// array of values (complex multi-valued attribute)
$t_rep->replaceAttribute(array_merge($va_value, array('locale_id' => $pn_locale_id)), $vs_element);
} else {
// scalar value (simple single value attribute)
if ($va_value) {
$t_rep->replaceAttribute(array('locale_id' => $pn_locale_id, $vs_element => $va_value), $vs_element);
}
}
}
}
$t_rep->update();
if ($t_rep->numErrors()) {
$this->errors = array_merge($this->errors, $t_rep->errors());
return false;
}
}
// Set image center if specified
$vn_center_x = caGetOption('centerX', $pa_options, null);
$vn_center_y = caGetOption('centerY', $pa_options, null);
if (strlen($vn_center_x) && strlen($vn_center_y) && $vn_center_x >= 0 && $vn_center_y >= 0 && $vn_center_x <= 1 && $vn_center_y <= 1) {
$t_rep->setMediaCenter('media', (double) $vn_center_x, (double) $vn_center_y);
$t_rep->update();
if ($t_rep->numErrors()) {
$this->errors = array_merge($this->errors, $t_rep->errors());
return false;
}
}
if (!($t_oxor = $this->_getRepresentationRelationshipTableInstance())) {
return null;
}
$vs_pk = $this->primaryKey();
if ($this->inTransaction()) {
$t_oxor->setTransaction($this->getTransaction());
}
$t_oxor->setMode(ACCESS_WRITE);
$t_oxor->set($vs_pk, $vn_id);
$t_oxor->set('representation_id', $t_rep->getPrimaryKey());
$t_oxor->set('is_primary', $pb_is_primary ? 1 : 0);
$t_oxor->set('rank', isset($pa_options['rank']) ? (int) $pa_options['rank'] : $t_rep->getPrimaryKey());
if ($t_oxor->hasField('type_id')) {
$t_oxor->set('type_id', isset($pa_options['type_id']) ? (int) $pa_options['type_id'] : null);
}
$t_oxor->insert();
if ($t_oxor->numErrors()) {
$this->errors = array_merge($this->errors, $t_oxor->errors());
//$t_rep->delete();
//if ($t_rep->numErrors()) {
// $this->errors = array_merge($this->errors, $t_rep->errors());
//}
return false;
}
//
// Perform mapping of embedded metadata for newly uploaded representation with respect
// to ca_objects and ca_object_representation records
//
$va_metadata = $t_rep->get('media_metadata', array('binary' => true));
if (caExtractEmbeddedMetadata($this, $va_metadata, $pn_locale_id)) {
$this->update();
}
if (isset($pa_options['returnRepresentation']) && (bool) $pa_options['returnRepresentation']) {
return $t_rep;
}
return $t_oxor->getPrimaryKey();
}