/**
* Perform media processing for the given field if something has been uploaded
*
* @access private
* @param string $ps_field field name
* @param array options
*
* Supported options:
* delete_old_media = set to zero to prevent that old media files are deleted; defaults to 1
* these_versions_only = if set to an array of valid version names, then only the specified versions are updated with the currently updated file; ignored if no media already exists
* dont_allow_duplicate_media = if set to true, and the model as a field named "md5" then media will be rejected if a row already exists with the same MD5 signature
*/
public function _processMedia($ps_field, $pa_options = null)
{
global $AUTH_CURRENT_USER_ID;
if (!is_array($pa_options)) {
$pa_options = array();
}
if (!isset($pa_options['delete_old_media'])) {
$pa_options['delete_old_media'] = true;
}
if (!isset($pa_options['these_versions_only'])) {
$pa_options['these_versions_only'] = null;
}
$vs_sql = "";
$vn_max_execution_time = ini_get('max_execution_time');
set_time_limit(7200);
$o_tq = new TaskQueue();
$o_media_proc_settings = new MediaProcessingSettings($this, $ps_field);
# only set file if something was uploaded
# (ie. don't nuke an existing file because none
# was uploaded)
$va_field_info = $this->getFieldInfo($ps_field);
if (isset($this->_FILES_CLEAR[$ps_field]) && $this->_FILES_CLEAR[$ps_field]) {
//
// Clear files
//
$va_versions = $this->getMediaVersions($ps_field);
#--- delete files
foreach ($va_versions as $v) {
$this->_removeMedia($ps_field, $v);
}
$this->_removeMedia($ps_field, '_undo_');
$this->_FILES[$ps_field] = null;
$this->_FIELD_VALUES[$ps_field] = null;
$vs_sql = "{$ps_field} = " . $this->quote(caSerializeForDatabase($this->_FILES[$ps_field], true)) . ",";
} else {
// Don't try to process files when no file is actually set
if (isset($this->_SET_FILES[$ps_field]['tmp_name'])) {
$o_tq = new TaskQueue();
$o_media_proc_settings = new MediaProcessingSettings($this, $ps_field);
//
// Process incoming files
//
$m = new Media();
$va_media_objects = array();
// is it a URL?
$vs_url_fetched_from = null;
$vn_url_fetched_on = null;
$vb_allow_fetching_of_urls = (bool) $this->_CONFIG->get('allow_fetching_of_media_from_remote_urls');
$vb_is_fetched_file = false;
if ($vb_allow_fetching_of_urls && (bool) ini_get('allow_url_fopen') && isURL($vs_url = html_entity_decode($this->_SET_FILES[$ps_field]['tmp_name']))) {
$vs_tmp_file = tempnam(__CA_APP_DIR__ . '/tmp', 'caUrlCopy');
$r_incoming_fp = fopen($vs_url, 'r');
if (!$r_incoming_fp) {
$this->postError(1600, _t('Cannot open remote URL [%1] to fetch media', $vs_url), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
return false;
}
$r_outgoing_fp = fopen($vs_tmp_file, 'w');
if (!$r_outgoing_fp) {
$this->postError(1600, _t('Cannot open file for media fetched from URL [%1]', $vs_url), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
return false;
}
while (($vs_content = fgets($r_incoming_fp, 4096)) !== false) {
fwrite($r_outgoing_fp, $vs_content);
}
fclose($r_incoming_fp);
fclose($r_outgoing_fp);
$vs_url_fetched_from = $vs_url;
$vn_url_fetched_on = time();
$this->_SET_FILES[$ps_field]['tmp_name'] = $vs_tmp_file;
$vb_is_fetched_file = true;
}
// is it server-side stored user media?
if (preg_match("!^userMedia[\\d]+/!", $this->_SET_FILES[$ps_field]['tmp_name'])) {
// use configured directory to dump media with fallback to standard tmp directory
if (!is_writeable($vs_tmp_directory = $this->getAppConfig()->get('ajax_media_upload_tmp_directory'))) {
$vs_tmp_directory = caGetTempDirPath();
}
$this->_SET_FILES[$ps_field]['tmp_name'] = "{$vs_tmp_directory}/" . $this->_SET_FILES[$ps_field]['tmp_name'];
// read metadata
if (file_exists("{$vs_tmp_directory}/" . $this->_SET_FILES[$ps_field]['tmp_name'] . "_metadata")) {
if (is_array($va_tmp_metadata = json_decode(file_get_contents("{$vs_tmp_directory}/" . $this->_SET_FILES[$ps_field]['tmp_name'] . "_metadata")))) {
$this->_SET_FILES[$ps_field]['original_filename'] = $va_tmp_metadata['original_filename'];
}
}
}
if (isset($this->_SET_FILES[$ps_field]['tmp_name']) && file_exists($this->_SET_FILES[$ps_field]['tmp_name'])) {
if (!isset($pa_options['dont_allow_duplicate_media'])) {
$pa_options['dont_allow_duplicate_media'] = (bool) $this->getAppConfig()->get('dont_allow_duplicate_media');
}
if (isset($pa_options['dont_allow_duplicate_media']) && $pa_options['dont_allow_duplicate_media']) {
if ($this->hasField('md5')) {
$qr_dupe_chk = $this->getDb()->query("\n\t\t\t\t\t\t\t\tSELECT " . $this->primaryKey() . " FROM " . $this->tableName() . " WHERE md5 = ? " . ($this->hasField('deleted') ? ' AND deleted = 0' : '') . "\n\t\t\t\t\t\t\t", (string) md5_file($this->_SET_FILES[$ps_field]['tmp_name']));
if ($qr_dupe_chk->nextRow()) {
$this->postError(1600, _t("Media already exists in database"), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
return false;
}
}
}
// allow adding zip and (gzipped) tape archives
$vb_is_archive = false;
$vs_original_filename = $this->_SET_FILES[$ps_field]['original_filename'];
$vs_original_tmpname = $this->_SET_FILES[$ps_field]['tmp_name'];
$va_matches = array();
if (preg_match("/(\\.zip|\\.tar\\.gz|\\.tgz)\$/", $vs_original_filename, $va_matches)) {
$vs_archive_extension = $va_matches[1];
// add file extension to temporary file if necessary; otherwise phar barfs when handling the archive
$va_tmp = array();
preg_match("/[.]*\\.([a-zA-Z0-9]+)\$/", $vs_original_tmpname, $va_tmp);
if (!isset($va_tmp[1])) {
@rename($this->_SET_FILES[$ps_field]['tmp_name'], $this->_SET_FILES[$ps_field]['tmp_name'] . $vs_archive_extension);
$this->_SET_FILES[$ps_field]['tmp_name'] = $this->_SET_FILES[$ps_field]['tmp_name'] . $vs_archive_extension;
}
if (caIsArchive($this->_SET_FILES[$ps_field]['tmp_name'])) {
$va_archive_files = caGetDirectoryContentsAsList('phar://' . $this->_SET_FILES[$ps_field]['tmp_name']);
if (sizeof($va_archive_files) > 0) {
// get first file we encounter in the archive and use it to generate them previews
$vb_is_archive = true;
$vs_archive = $this->_SET_FILES[$ps_field]['tmp_name'];
$va_tmp = array();
// copy primary file from the archive to temporary file (with extension so that *Magick can identify properly)
// this is basically a fallback. if the code below fails, we still have a 'fake' original
preg_match("/[.]*\\.([a-zA-Z0-9]+)\$/", $va_archive_files[0], $va_tmp);
$vs_primary_file_tmp = tempnam(caGetTempDirPath(), "caArchivePrimary");
@unlink($vs_primary_file_tmp);
$vs_primary_file_tmp = $vs_primary_file_tmp . "." . $va_tmp[1];
if (!@copy($va_archive_files[0], $vs_primary_file_tmp)) {
$this->postError(1600, _t("Couldn't extract first file from archive. There is probably a invalid character in a directory or file name inside the archive"), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
}
return false;
}
$this->_SET_FILES[$ps_field]['tmp_name'] = $vs_primary_file_tmp;
// prepare to join archive contents to form a better downloadable "original" than the zip/tgz archive (e.g. a multi-page tiff)
// to do that, we have to 'extract' the archive so that command-line utilities like *Magick can operate
@caRemoveDirectory(caGetTempDirPath() . '/caArchiveExtract');
// remove left-overs, just to be sure we don't include other files in the tiff
$va_archive_tmp_files = array();
@mkdir(caGetTempDirPath() . '/caArchiveExtract');
foreach ($va_archive_files as $vs_archive_file) {
$vs_basename = basename($vs_archive_file);
$vs_tmp_file_name = caGetTempDirPath() . '/caArchiveExtract/' . str_replace(" ", "_", $vs_basename);
$va_archive_tmp_files[] = $vs_tmp_file_name;
@copy($vs_archive_file, $vs_tmp_file_name);
}
}
}
if (!$vb_is_archive) {
// something went wrong (i.e. no valid or empty archive) -> restore previous state
@rename($this->_SET_FILES[$ps_field]['tmp_name'] . $vs_archive_extension, $vs_original_tmpname);
$this->_SET_FILES[$ps_field]['tmp_name'] = $vs_original_tmpname;
}
}
// ImageMagick partly relies on file extensions to properly identify images (RAW images in particular)
// therefore we rename the temporary file here (using the extension of the original filename, if any)
$va_matches = array();
$vb_renamed_tmpfile = false;
preg_match("/[.]*\\.([a-zA-Z0-9]+)\$/", $this->_SET_FILES[$ps_field]['tmp_name'], $va_matches);
if (!isset($va_matches[1])) {
// file has no extension, i.e. is probably PHP upload tmp file
$va_matches = array();
preg_match("/[.]*\\.([a-zA-Z0-9]+)\$/", $this->_SET_FILES[$ps_field]['original_filename'], $va_matches);
if (strlen($va_matches[1]) > 0) {
$va_parts = explode("/", $this->_SET_FILES[$ps_field]['tmp_name']);
$vs_new_filename = sys_get_temp_dir() . "/" . $va_parts[sizeof($va_parts) - 1] . "." . $va_matches[1];
if (!move_uploaded_file($this->_SET_FILES[$ps_field]['tmp_name'], $vs_new_filename)) {
rename($this->_SET_FILES[$ps_field]['tmp_name'], $vs_new_filename);
}
$this->_SET_FILES[$ps_field]['tmp_name'] = $vs_new_filename;
$vb_renamed_tmpfile = true;
}
}
$input_mimetype = $m->divineFileFormat($this->_SET_FILES[$ps_field]['tmp_name']);
if (!($input_type = $o_media_proc_settings->canAccept($input_mimetype))) {
# error - filetype not accepted by this field
$this->postError(1600, $input_mimetype ? _t("File type %1 not accepted by %2", $input_mimetype, $ps_field) : _t("Unknown file type not accepted by %1", $ps_field), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
}
return false;
}
# ok process file...
if (!$m->read($this->_SET_FILES[$ps_field]['tmp_name'])) {
$this->errors = array_merge($this->errors, $m->errors());
// copy into model plugin errors
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
}
return false;
}
// if necessary, join archive contents to form a better downloadable "original" than the zip/tgz archive (e.g. a multi-page tiff)
// by this point, a backend plugin was picked using the first file of the archive. this backend is also used to prepare the new original.
if ($vb_is_archive && sizeof($va_archive_tmp_files) > 0) {
if ($vs_archive_original = $m->joinArchiveContents($va_archive_tmp_files)) {
// mangle filename, so that the uploaded archive.zip becomes archive.tif or archive.gif or whatever extension the Media plugin prefers
$va_new_original_pathinfo = pathinfo($vs_archive_original);
$va_archive_pathinfo = pathinfo($this->_SET_FILES[$ps_field]['original_filename']);
$this->_SET_FILES[$ps_field]['original_filename'] = $va_archive_pathinfo['filename'] . "." . $va_new_original_pathinfo['extension'];
// this is now our original, disregard the uploaded archive
$this->_SET_FILES[$ps_field]['tmp_name'] = $vs_archive_original;
// re-run mimetype detection and read on the new original
$m->reset();
$input_mimetype = $m->divineFileFormat($vs_archive_original);
$input_type = $o_media_proc_settings->canAccept($input_mimetype);
$m->read($vs_archive_original);
}
@caRemoveDirectory(caGetTempDirPath() . '/caArchiveExtract');
}
$va_media_objects['_original'] = $m;
// preserve center setting from any existing media
$va_center = null;
if (is_array($va_tmp = $this->getMediaInfo($ps_field))) {
$va_center = caGetOption('_CENTER', $va_tmp, array());
}
$media_desc = array("ORIGINAL_FILENAME" => $this->_SET_FILES[$ps_field]['original_filename'], "_CENTER" => $va_center, "_SCALE" => caGetOption('_SCALE', $va_tmp, array()), "_SCALE_UNITS" => caGetOption('_SCALE_UNITS', $va_tmp, array()), "INPUT" => array("MIMETYPE" => $m->get("mimetype"), "WIDTH" => $m->get("width"), "HEIGHT" => $m->get("height"), "MD5" => md5_file($this->_SET_FILES[$ps_field]['tmp_name']), "FILESIZE" => filesize($this->_SET_FILES[$ps_field]['tmp_name']), "FETCHED_FROM" => $vs_url_fetched_from, "FETCHED_ON" => $vn_url_fetched_on));
if (isset($this->_SET_FILES[$ps_field]['options']['TRANSFORMATION_HISTORY']) && is_array($this->_SET_FILES[$ps_field]['options']['TRANSFORMATION_HISTORY'])) {
$media_desc['TRANSFORMATION_HISTORY'] = $this->_SET_FILES[$ps_field]['options']['TRANSFORMATION_HISTORY'];
}
#
# Extract metadata from file
#
$media_metadata = $m->getExtractedMetadata();
# get versions to create
$va_versions = $this->getMediaVersions($ps_field, $input_mimetype);
$error = 0;
# don't process files that are not going to be processed or converted
# we don't want to waste time opening file we're not going to do anything with
# also, we don't want to recompress JPEGs...
$media_type = $o_media_proc_settings->canAccept($input_mimetype);
$version_info = $o_media_proc_settings->getMediaTypeVersions($media_type);
$va_default_queue_settings = $o_media_proc_settings->getMediaTypeQueueSettings($media_type);
if (!($va_media_write_options = $this->_FILES[$ps_field]['options'])) {
$va_media_write_options = $this->_SET_FILES[$ps_field]['options'];
}
# Is an "undo" version set in options?
if (isset($this->_SET_FILES[$ps_field]['options']['undo']) && file_exists($this->_SET_FILES[$ps_field]['options']['undo'])) {
if ($volume = $version_info['original']['VOLUME']) {
$vi = $this->_MEDIA_VOLUMES->getVolumeInformation($volume);
if ($vi["absolutePath"] && strlen($dirhash = $this->_getDirectoryHash($vi["absolutePath"], $this->getPrimaryKey()))) {
$magic = rand(0, 99999);
$vs_filename = $this->_genMediaName($ps_field) . "_undo_";
$filepath = $vi["absolutePath"] . "/" . $dirhash . "/" . $magic . "_" . $vs_filename;
if (copy($this->_SET_FILES[$ps_field]['options']['undo'], $filepath)) {
$media_desc['_undo_'] = array("VOLUME" => $volume, "FILENAME" => $vs_filename, "HASH" => $dirhash, "MAGIC" => $magic, "MD5" => md5_file($filepath));
}
}
}
}
$va_process_these_versions_only = array();
if (isset($pa_options['these_versions_only']) && is_array($pa_options['these_versions_only']) && sizeof($pa_options['these_versions_only'])) {
$va_tmp = $this->_FIELD_VALUES[$ps_field];
foreach ($pa_options['these_versions_only'] as $vs_this_version_only) {
if (in_array($vs_this_version_only, $va_versions)) {
if (is_array($this->_FIELD_VALUES[$ps_field])) {
$va_process_these_versions_only[] = $vs_this_version_only;
}
}
}
// Copy metadata for version we're not processing
if (sizeof($va_process_these_versions_only)) {
foreach (array_keys($va_tmp) as $v) {
if (!in_array($v, $va_process_these_versions_only)) {
$media_desc[$v] = $va_tmp[$v];
}
}
}
}
$va_files_to_delete = array();
$va_queued_versions = array();
$queue_enabled = !sizeof($va_process_these_versions_only) && $this->getAppConfig()->get('queue_enabled') ? true : false;
$vs_path_to_queue_media = null;
foreach ($va_versions as $v) {
$vs_use_icon = null;
if (sizeof($va_process_these_versions_only) && !in_array($v, $va_process_these_versions_only)) {
// only processing certain versions... and this one isn't it so skip
continue;
}
$queue = $va_default_queue_settings['QUEUE'];
$queue_threshold = isset($version_info[$v]['QUEUE_WHEN_FILE_LARGER_THAN']) ? intval($version_info[$v]['QUEUE_WHEN_FILE_LARGER_THAN']) : (int) $va_default_queue_settings['QUEUE_WHEN_FILE_LARGER_THAN'];
$rule = isset($version_info[$v]['RULE']) ? $version_info[$v]['RULE'] : '';
$volume = isset($version_info[$v]['VOLUME']) ? $version_info[$v]['VOLUME'] : '';
$basis = isset($version_info[$v]['BASIS']) ? $version_info[$v]['BASIS'] : '';
if (isset($media_desc[$basis]) && isset($media_desc[$basis]['FILENAME'])) {
if (!isset($va_media_objects[$basis])) {
$o_media = new Media();
$basis_vi = $this->_MEDIA_VOLUMES->getVolumeInformation($media_desc[$basis]['VOLUME']);
if ($o_media->read($p = $basis_vi['absolutePath'] . "/" . $media_desc[$basis]['HASH'] . "/" . $media_desc[$basis]['MAGIC'] . "_" . $media_desc[$basis]['FILENAME'])) {
$va_media_objects[$basis] = $o_media;
} else {
$m = $va_media_objects['_original'];
}
} else {
$m = $va_media_objects[$basis];
}
} else {
$m = $va_media_objects['_original'];
}
$m->reset();
# get volume
$vi = $this->_MEDIA_VOLUMES->getVolumeInformation($volume);
if (!is_array($vi)) {
print "Invalid volume '{$volume}'<br>";
exit;
}
// Send to queue if it's too big to process here
if ($queue_enabled && $queue && $queue_threshold > 0 && $queue_threshold < (int) $media_desc["INPUT"]["FILESIZE"] && $va_default_queue_settings['QUEUE_USING_VERSION'] != $v) {
$va_queued_versions[$v] = array('VOLUME' => $volume);
$media_desc[$v]["QUEUED"] = $queue;
if ($version_info[$v]["QUEUED_MESSAGE"]) {
$media_desc[$v]["QUEUED_MESSAGE"] = $version_info[$v]["QUEUED_MESSAGE"];
} else {
$media_desc[$v]["QUEUED_MESSAGE"] = $va_default_queue_settings['QUEUED_MESSAGE'] ? $va_default_queue_settings['QUEUED_MESSAGE'] : _t("Media is being processed and will be available shortly.");
}
if ($pa_options['delete_old_media']) {
$va_files_to_delete[] = array('field' => $ps_field, 'version' => $v);
}
continue;
}
# get transformation rules
$rules = $o_media_proc_settings->getMediaTransformationRule($rule);
if (sizeof($rules) == 0) {
$output_mimetype = $input_mimetype;
$m->set("version", $v);
#
# don't process this media, just copy the file
#
$ext = $m->mimetype2extension($output_mimetype);
if (!$ext) {
$this->postError(1600, _t("File could not be copied for %1; can't convert mimetype '%2' to extension", $ps_field, $output_mimetype), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
$m->cleanup();
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
}
if (($dirhash = $this->_getDirectoryHash($vi["absolutePath"], $this->getPrimaryKey())) === false) {
$this->postError(1600, _t("Could not create subdirectory for uploaded file in %1. Please ask your administrator to check the permissions of your media directory.", $vi["absolutePath"]), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
}
if ((bool) $version_info[$v]["USE_EXTERNAL_URL_WHEN_AVAILABLE"]) {
$filepath = $this->_SET_FILES[$ps_field]['tmp_name'];
if ($pa_options['delete_old_media']) {
$va_files_to_delete[] = array('field' => $ps_field, 'version' => $v);
}
$media_desc[$v] = array("VOLUME" => $volume, "MIMETYPE" => $output_mimetype, "WIDTH" => $m->get("width"), "HEIGHT" => $m->get("height"), "PROPERTIES" => $m->getProperties(), "EXTERNAL_URL" => $media_desc['INPUT']['FETCHED_FROM'], "FILENAME" => null, "HASH" => null, "MAGIC" => null, "EXTENSION" => $ext, "MD5" => md5_file($filepath));
} else {
$magic = rand(0, 99999);
$filepath = $vi["absolutePath"] . "/" . $dirhash . "/" . $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v . "." . $ext;
if (!copy($this->_SET_FILES[$ps_field]['tmp_name'], $filepath)) {
$this->postError(1600, _t("File could not be copied. Ask your administrator to check permissions and file space for %1", $vi["absolutePath"]), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
$m->cleanup();
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
}
if ($v === $va_default_queue_settings['QUEUE_USING_VERSION']) {
$vs_path_to_queue_media = $filepath;
}
if ($pa_options['delete_old_media']) {
$va_files_to_delete[] = array('field' => $ps_field, 'version' => $v, 'dont_delete_path' => $vi["absolutePath"] . "/" . $dirhash . "/" . $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v, 'dont_delete_extension' => $ext);
}
if (is_array($vi["mirrors"]) && sizeof($vi["mirrors"]) > 0) {
$vs_entity_key = join("/", array($this->tableName(), $ps_field, $this->getPrimaryKey(), $v));
$vs_row_key = join("/", array($this->tableName(), $this->getPrimaryKey()));
foreach ($vi["mirrors"] as $vs_mirror_code => $va_mirror_info) {
$vs_mirror_method = $va_mirror_info["method"];
$vs_queue = $vs_mirror_method . "mirror";
if (!$o_tq->cancelPendingTasksForEntity($vs_entity_key)) {
//$this->postError(560, _t("Could not cancel pending tasks: %1", $this->error),"BaseModel->_processMedia()");
//$m->cleanup();
//return false;
}
if ($o_tq->addTask($vs_queue, array("MIRROR" => $vs_mirror_code, "VOLUME" => $volume, "FIELD" => $ps_field, "TABLE" => $this->tableName(), "VERSION" => $v, "FILES" => array(array("FILE_PATH" => $filepath, "ABS_PATH" => $vi["absolutePath"], "HASH" => $dirhash, "FILENAME" => $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v . "." . $ext)), "MIRROR_INFO" => $va_mirror_info, "PK" => $this->primaryKey(), "PK_VAL" => $this->getPrimaryKey()), array("priority" => 100, "entity_key" => $vs_entity_key, "row_key" => $vs_row_key, 'user_id' => $AUTH_CURRENT_USER_ID))) {
continue;
} else {
$this->postError(100, _t("Couldn't queue mirror using '%1' for version '%2' (handler '%3')", $vs_mirror_method, $v, $queue), "BaseModel->_processMedia()");
}
}
}
$media_desc[$v] = array("VOLUME" => $volume, "MIMETYPE" => $output_mimetype, "WIDTH" => $m->get("width"), "HEIGHT" => $m->get("height"), "PROPERTIES" => $m->getProperties(), "FILENAME" => $this->_genMediaName($ps_field) . "_" . $v . "." . $ext, "HASH" => $dirhash, "MAGIC" => $magic, "EXTENSION" => $ext, "MD5" => md5_file($filepath));
}
} else {
$m->set("version", $v);
while (list($operation, $parameters) = each($rules)) {
if ($operation === 'SET') {
foreach ($parameters as $pp => $pv) {
if ($pp == 'format') {
$output_mimetype = $pv;
} else {
$m->set($pp, $pv);
}
}
} else {
if (is_array($this->_FIELD_VALUES[$ps_field]) && is_array($va_media_center = $this->getMediaCenter($ps_field))) {
$parameters['_centerX'] = caGetOption('x', $va_media_center, 0.5);
$parameters['_centerY'] = caGetOption('y', $va_media_center, 0.5);
if ($parameters['_centerX'] < 0 || $parameters['_centerX'] > 1) {
$parameters['_centerX'] = 0.5;
}
if ($parameters['_centerY'] < 0 || $parameters['_centerY'] > 1) {
$parameters['_centerY'] = 0.5;
}
}
if (!$m->transform($operation, $parameters)) {
$error = 1;
$error_msg = "Couldn't do transformation '{$operation}'";
break 2;
}
}
}
if (!$output_mimetype) {
$output_mimetype = $input_mimetype;
}
if (!($ext = $m->mimetype2extension($output_mimetype))) {
$this->postError(1600, _t("File could not be processed for %1; can't convert mimetype '%2' to extension", $ps_field, $output_mimetype), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
$m->cleanup();
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
}
if (($dirhash = $this->_getDirectoryHash($vi["absolutePath"], $this->getPrimaryKey())) === false) {
$this->postError(1600, _t("Could not create subdirectory for uploaded file in %1. Please ask your administrator to check the permissions of your media directory.", $vi["absolutePath"]), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
}
$magic = rand(0, 99999);
$filepath = $vi["absolutePath"] . "/" . $dirhash . "/" . $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v;
if (!($vs_output_file = $m->write($filepath, $output_mimetype, $va_media_write_options))) {
$this->postError(1600, _t("Couldn't write file: %1", join("; ", $m->getErrors())), "BaseModel->_processMedia()", $this->tableName() . '.' . $ps_field);
$m->cleanup();
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return false;
break;
} else {
if ($vs_output_file === __CA_MEDIA_VIDEO_DEFAULT_ICON__ || $vs_output_file === __CA_MEDIA_AUDIO_DEFAULT_ICON__ || $vs_output_file === __CA_MEDIA_DOCUMENT_DEFAULT_ICON__ || $vs_output_file === __CA_MEDIA_3D_DEFAULT_ICON__) {
$vs_use_icon = $vs_output_file;
}
}
if ($v === $va_default_queue_settings['QUEUE_USING_VERSION']) {
$vs_path_to_queue_media = $vs_output_file;
$vs_use_icon = __CA_MEDIA_QUEUED_ICON__;
}
if ($pa_options['delete_old_media'] && !$error) {
if ($vs_old_media_path = $this->getMediaPath($ps_field, $v)) {
$va_files_to_delete[] = array('field' => $ps_field, 'version' => $v, 'dont_delete_path' => $filepath, 'dont_delete_extension' => $ext);
}
}
if (is_array($vi["mirrors"]) && sizeof($vi["mirrors"]) > 0) {
$vs_entity_key = join("/", array($this->tableName(), $ps_field, $this->getPrimaryKey(), $v));
$vs_row_key = join("/", array($this->tableName(), $this->getPrimaryKey()));
foreach ($vi["mirrors"] as $vs_mirror_code => $va_mirror_info) {
$vs_mirror_method = $va_mirror_info["method"];
$vs_queue = $vs_mirror_method . "mirror";
if (!$o_tq->cancelPendingTasksForEntity($vs_entity_key)) {
//$this->postError(560, _t("Could not cancel pending tasks: %1", $this->error),"BaseModel->_processMedia()");
//$m->cleanup();
//return false;
}
if ($o_tq->addTask($vs_queue, array("MIRROR" => $vs_mirror_code, "VOLUME" => $volume, "FIELD" => $ps_field, "TABLE" => $this->tableName(), "VERSION" => $v, "FILES" => array(array("FILE_PATH" => $filepath . "." . $ext, "ABS_PATH" => $vi["absolutePath"], "HASH" => $dirhash, "FILENAME" => $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v . "." . $ext)), "MIRROR_INFO" => $va_mirror_info, "PK" => $this->primaryKey(), "PK_VAL" => $this->getPrimaryKey()), array("priority" => 100, "entity_key" => $vs_entity_key, "row_key" => $vs_row_key, 'user_id' => $AUTH_CURRENT_USER_ID))) {
continue;
} else {
$this->postError(100, _t("Couldn't queue mirror using '%1' for version '%2' (handler '%3')", $vs_mirror_method, $v, $queue), "BaseModel->_processMedia()");
}
}
}
if ($vs_use_icon) {
$media_desc[$v] = array("MIMETYPE" => $output_mimetype, "USE_ICON" => $vs_use_icon, "WIDTH" => $m->get("width"), "HEIGHT" => $m->get("height"));
} else {
$media_desc[$v] = array("VOLUME" => $volume, "MIMETYPE" => $output_mimetype, "WIDTH" => $m->get("width"), "HEIGHT" => $m->get("height"), "PROPERTIES" => $m->getProperties(), "FILENAME" => $this->_genMediaName($ps_field) . "_" . $v . "." . $ext, "HASH" => $dirhash, "MAGIC" => $magic, "EXTENSION" => $ext, "MD5" => md5_file($vi["absolutePath"] . "/" . $dirhash . "/" . $magic . "_" . $this->_genMediaName($ps_field) . "_" . $v . "." . $ext));
}
$m->reset();
}
}
if (sizeof($va_queued_versions)) {
$vs_entity_key = md5(join("/", array_merge(array($this->tableName(), $ps_field, $this->getPrimaryKey()), array_keys($va_queued_versions))));
$vs_row_key = join("/", array($this->tableName(), $this->getPrimaryKey()));
if (!$o_tq->cancelPendingTasksForEntity($vs_entity_key, $queue)) {
// TODO: log this
}
if (!($filename = $vs_path_to_queue_media)) {
// if we're not using a designated not-queued representation to generate the queued ones
// then copy the uploaded file to the tmp dir and use that
$filename = $o_tq->copyFileToQueueTmp($va_default_queue_settings['QUEUE'], $this->_SET_FILES[$ps_field]['tmp_name']);
}
if ($filename) {
if ($o_tq->addTask($va_default_queue_settings['QUEUE'], array("TABLE" => $this->tableName(), "FIELD" => $ps_field, "PK" => $this->primaryKey(), "PK_VAL" => $this->getPrimaryKey(), "INPUT_MIMETYPE" => $input_mimetype, "FILENAME" => $filename, "VERSIONS" => $va_queued_versions, "OPTIONS" => $va_media_write_options, "DONT_DELETE_OLD_MEDIA" => $filename == $vs_path_to_queue_media ? true : false), array("priority" => 100, "entity_key" => $vs_entity_key, "row_key" => $vs_row_key, 'user_id' => $AUTH_CURRENT_USER_ID))) {
if ($pa_options['delete_old_media']) {
foreach ($va_queued_versions as $vs_version => $va_version_info) {
$va_files_to_delete[] = array('field' => $ps_field, 'version' => $vs_version);
}
}
} else {
$this->postError(100, _t("Couldn't queue processing for version '%1' using handler '%2'", !$v, $queue), "BaseModel->_processMedia()");
}
} else {
$this->errors = $o_tq->errors;
}
} else {
// Generate preview frames for media that support that (Eg. video)
// and add them as "multifiles" assuming the current model supports that (ca_object_representations does)
if (!sizeof($va_process_these_versions_only) && ((bool) $this->_CONFIG->get('video_preview_generate_frames') || (bool) $this->_CONFIG->get('document_preview_generate_pages')) && method_exists($this, 'addFile')) {
if (method_exists($this, 'removeAllFiles')) {
$this->removeAllFiles();
// get rid of any previously existing frames (they might be hanging ar
}
$va_preview_frame_list = $m->writePreviews(array('width' => $m->get("width"), 'height' => $m->get("height"), 'minNumberOfFrames' => $this->_CONFIG->get('video_preview_min_number_of_frames'), 'maxNumberOfFrames' => $this->_CONFIG->get('video_preview_max_number_of_frames'), 'numberOfPages' => $this->_CONFIG->get('document_preview_max_number_of_pages'), 'frameInterval' => $this->_CONFIG->get('video_preview_interval_between_frames'), 'pageInterval' => $this->_CONFIG->get('document_preview_interval_between_pages'), 'startAtTime' => $this->_CONFIG->get('video_preview_start_at'), 'endAtTime' => $this->_CONFIG->get('video_preview_end_at'), 'startAtPage' => $this->_CONFIG->get('document_preview_start_page'), 'outputDirectory' => __CA_APP_DIR__ . '/tmp'));
if (is_array($va_preview_frame_list)) {
foreach ($va_preview_frame_list as $vn_time => $vs_frame) {
$this->addFile($vs_frame, $vn_time, true);
// the resource path for each frame is it's time, in seconds (may be fractional) for video, or page number for documents
@unlink($vs_frame);
// clean up tmp preview frame file
}
}
}
}
if (!$error) {
#
# --- Clean up old media from versions that are not supported in the new media
#
if ($pa_options['delete_old_media']) {
foreach ($this->getMediaVersions($ps_field) as $old_version) {
if (!is_array($media_desc[$old_version])) {
$this->_removeMedia($ps_field, $old_version);
}
}
}
foreach ($va_files_to_delete as $va_file_to_delete) {
$this->_removeMedia($va_file_to_delete['field'], $va_file_to_delete['version'], $va_file_to_delete['dont_delete_path'], $va_file_to_delete['dont_delete_extension']);
}
# Remove old _undo_ file if defined
if ($vs_undo_path = $this->getMediaPath($ps_field, '_undo_')) {
@unlink($vs_undo_path);
}
$this->_FILES[$ps_field] = $media_desc;
$this->_FIELD_VALUES[$ps_field] = $media_desc;
$vs_serialized_data = caSerializeForDatabase($this->_FILES[$ps_field], true);
$vs_sql = "{$ps_field} = " . $this->quote($vs_serialized_data) . ",";
if (($vs_metadata_field_name = $o_media_proc_settings->getMetadataFieldName()) && $this->hasField($vs_metadata_field_name)) {
$this->set($vs_metadata_field_name, $media_metadata);
$vs_sql .= " " . $vs_metadata_field_name . " = " . $this->quote(caSerializeForDatabase($media_metadata, true)) . ",";
}
if (($vs_content_field_name = $o_media_proc_settings->getMetadataContentName()) && $this->hasField($vs_content_field_name)) {
$this->_FIELD_VALUES[$vs_content_field_name] = $this->quote($m->getExtractedText());
$vs_sql .= " " . $vs_content_field_name . " = " . $this->_FIELD_VALUES[$vs_content_field_name] . ",";
}
if (is_array($va_locs = $m->getExtractedTextLocations())) {
MediaContentLocationIndexer::clear($this->tableNum(), $this->getPrimaryKey());
foreach ($va_locs as $vs_content => $va_loc_list) {
foreach ($va_loc_list as $va_loc) {
MediaContentLocationIndexer::index($this->tableNum(), $this->getPrimaryKey(), $vs_content, $va_loc['p'], $va_loc['x1'], $va_loc['y1'], $va_loc['x2'], $va_loc['y2']);
}
}
MediaContentLocationIndexer::write();
}
} else {
# error - invalid media
$this->postError(1600, _t("File could not be processed for %1: %2", $ps_field, $error_msg), "BaseModel->_processMedia()");
# return false;
}
$m->cleanup();
if ($vb_renamed_tmpfile) {
@unlink($this->_SET_FILES[$ps_field]['tmp_name']);
}
} elseif (is_array($this->_FIELD_VALUES[$ps_field])) {
// Just set field values in SQL (assume in-place update of media metadata) because no tmp_name is set
// [This generally should not happen]
$this->_FILES[$ps_field] = $this->_FIELD_VALUES[$ps_field];
$vs_sql = "{$ps_field} = " . $this->quote(caSerializeForDatabase($this->_FILES[$ps_field], true)) . ",";
}
$this->_SET_FILES[$ps_field] = null;
} elseif (is_array($this->_FIELD_VALUES[$ps_field])) {
// Just set field values in SQL (usually in-place update of media metadata)
$this->_FILES[$ps_field] = $this->_FIELD_VALUES[$ps_field];
$vs_sql = "{$ps_field} = " . $this->quote(caSerializeForDatabase($this->_FILES[$ps_field], true)) . ",";
}
}
set_time_limit($vn_max_execution_time);
if ($vb_is_fetched_file) {
@unlink($vs_tmp_file);
}
if ($vb_is_archive) {
@unlink($vs_archive);
@unlink($vs_primary_file_tmp);
@unlink($vs_archive_original);
}
return $vs_sql;
}
/**
* Returns all available bundle display placements - those data bundles that can be displayed for the given content type, in other words.
* The returned value is a list of arrays; each array contains a 'bundle' specifier than can be passed got Model::get() or SearchResult::get() and a display name
*
* @param mixed $pm_table_name_or_num The table name or number specifying the content type to fetch bundles for. If omitted the content table of the currently loaded display will be used.
* @param array $pa_options Support options are
* no_cache = if set caching of underlying data required to generate list is disabled. This is required in certain situations such as during installation. Only set this if you suspect stale data is being used to generate the list. Eg. if you've been changing metadata attributes in the same request in which you call this method. Default is false.
* no_tooltips = if set no tooltips for available bundles will be emitted. Default is false - tooltips will be emitted.
* format = specifies label format for bundles. Valid values are "simple" (just the name of the element) or "full" (name of element, name of type of item element pertains to and alternate label, if defined). Default is "full"
* @return array And array of bundles keyed on display label. Each value is an array with these keys:
* bundle = The bundle name (eg. ca_objects.idno)
* display = Display label for each available bundle
* description = Description of bundle
*
* Will return null if table name or number is invalid.
*/
public function getAvailableBundles($pm_table_name_or_num = null, $pa_options = null)
{
if (!$pm_table_name_or_num) {
$pm_table_name_or_num = $this->get('table_num');
}
$pm_table_name_or_num = $this->getAppDatamodel()->getTableNum($pm_table_name_or_num);
if (!$pm_table_name_or_num) {
return null;
}
$vb_show_tooltips = isset($pa_options['no_tooltips']) && (bool) $pa_options['no_tooltips'] ? false : true;
$vs_format = isset($pa_options['format']) && in_array($pa_options['format'], array('simple', 'full')) ? $pa_options['format'] : 'full';
$t_instance = $this->getAppDatamodel()->getInstanceByTableNum($pm_table_name_or_num, false);
$vs_table = $t_instance->tableName();
$vs_table_display_name = $t_instance->getProperty('NAME_PLURAL');
$va_available_bundles = array();
$t_placement = new ca_bundle_display_placements(null, array());
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
// get intrinsic fields
$va_additional_settings = array('maximum_length' => array('formatType' => FT_NUMBER, 'displayType' => DT_FIELD, 'width' => 6, 'height' => 1, 'takesLocale' => false, 'default' => 100, 'label' => _t('Maximum length'), 'description' => _t('Maximum length, in characters, of displayed information.')));
foreach ($t_instance->getFormFields() as $vs_f => $va_info) {
if (isset($va_info['DONT_USE_AS_BUNDLE']) && $va_info['DONT_USE_AS_BUNDLE']) {
continue;
}
if ($t_instance->getFieldInfo($vs_f, 'ALLOW_BUNDLE_ACCESS_CHECK')) {
if (caGetBundleAccessLevel($vs_table, $vs_f) == __CA_BUNDLE_ACCESS_NONE__) {
continue;
}
}
$vs_bundle = $vs_table . '.' . $vs_f;
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_{$vs_f}'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_{$vs_f}", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
// get attributes
$va_element_codes = $t_instance->getApplicableElementCodes(null, false, $pa_options['no_cache']);
$t_md = new ca_metadata_elements();
if ($this->inTransaction()) {
$t_md->setTransaction($this->getTransaction());
}
$va_all_elements = $t_md->getElementsAsList();
$va_additional_settings = array('format' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Display format'), 'description' => _t('Template used to format output.'), 'helpText' => ''), 'delimiter' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'label' => _t('Delimiter'), 'description' => _t('Text to place in-between repeating values.')), 'maximum_length' => array('formatType' => FT_NUMBER, 'displayType' => DT_FIELD, 'width' => 6, 'height' => 1, 'takesLocale' => false, 'default' => 2048, 'label' => _t('Maximum length'), 'description' => _t('Maximum length, in characters, of displayed information.')), 'filter' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Filter using expression'), 'description' => _t('Expression to filter values with. Leave blank if you do not wish to filter values.')));
foreach ($va_element_codes as $vn_element_id => $vs_element_code) {
if (!is_null($va_all_elements[$vn_element_id]['settings']['canBeUsedInDisplay']) && !$va_all_elements[$vn_element_id]['settings']['canBeUsedInDisplay']) {
continue;
}
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
if (caGetBundleAccessLevel($vs_table, $vs_element_code) == __CA_BUNDLE_ACCESS_NONE__) {
continue;
}
switch ($va_all_elements[$vn_element_id]['datatype']) {
case 3:
// list
$va_even_more_settings = array('sense' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'width' => 20, 'height' => 1, 'takesLocale' => false, 'default' => 'singular', 'options' => array(_t('Singular') => 'singular', _t('Plural') => 'plural'), 'label' => _t('Sense'), 'description' => _t('Determines if value used is singular or plural version.')));
break;
case 0:
// container (allows sub-elements to be summarized)
// container (allows sub-elements to be summarized)
case 6:
// Currency
// Currency
case 8:
// Length
// Length
case 9:
// Weight
// Weight
case 10:
// Timecode
// Timecode
case 11:
// Integer
// Integer
case 12:
// Numeric (decimal)
$va_even_more_settings = array('bottom_line' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Bottom line format'), 'description' => _t('Template to format aggregate data for display under this column. The template can include these aggregate data tags: ^PAGEAVG, ^AVG, ^PAGESUM, ^SUM, ^PAGEMin, ^MIN, ^PAGEMAX, ^MAX. For containers follow the tag with the element code of the subelement to aggregate. Ex. ^SUM:dimensions_width')));
if ($va_all_elements[$vn_element_id]['datatype'] == 6) {
$va_even_more_settings['display_currency_conversion'] = array('formatType' => FT_NUMBER, 'displayType' => DT_CHECKBOXES, 'width' => 10, 'height' => 1, 'takesLocale' => false, 'default' => '0', 'label' => _t('Display currency conversion?'), 'description' => _t('Check this option if you want your currency values to be displayed in both the specified and local currency.'));
}
break;
default:
$va_even_more_settings = array();
break;
}
$vs_bundle = $vs_table . '.' . $vs_element_code;
$va_even_more_settings['format'] = $va_additional_settings['format'];
//$va_even_more_settings['format']['helpText'] = $this->getTemplatePlaceholderDisplayListForBundle($vs_bundle);
$t_placement = new ca_bundle_display_placements(null, array_merge($va_additional_settings, $va_even_more_settings));
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_{$vs_element_code}'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => array_merge($va_additional_settings, $va_even_more_settings));
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_{$vs_element_code}", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
if (caGetBundleAccessLevel($vs_table, "preferred_labels") != __CA_BUNDLE_ACCESS_NONE__) {
// get preferred labels for this table
$va_additional_settings = array('format' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Display format'), 'description' => _t('Template used to format output.')), 'delimiter' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'label' => _t('Delimiter'), 'description' => _t('Text to place in-between repeating values.')), 'maximum_length' => array('formatType' => FT_NUMBER, 'displayType' => DT_FIELD, 'width' => 6, 'height' => 1, 'takesLocale' => false, 'default' => 100, 'label' => _t('Maximum length'), 'description' => _t('Maximum length, in characters, of displayed information.')));
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = $vs_table . '.preferred_labels';
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_preferred_labels'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_preferred_labels", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
if (caGetBundleAccessLevel($vs_table, "nonpreferred_labels") != __CA_BUNDLE_ACCESS_NONE__) {
// get non-preferred labels for this table
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = $vs_table . '.nonpreferred_labels';
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_nonpreferred_labels'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_nonpreferred_labels", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
// get library checkout and commerce order history bundle (objects only, of course)
if ($vs_table == 'ca_objects') {
$va_additional_settings = array('order_type' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'options' => array(_t('Sales order') => 'O', _t('Loan') => 'L'), 'label' => _t('Type of order'), 'description' => _t('Determines which type of order is displayed.')));
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = 'ca_commerce_order_history';
$vs_label = _t('Order history');
$vs_display = _t('Order history');
$vs_description = _t('List of orders (loans or sales) that include this object');
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description, 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_ca_commerce_order_history", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
$va_additional_settings = array('format' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Display format'), 'description' => _t('Template used to format output.')));
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = 'ca_object_checkouts';
$vs_label = _t('Library checkouts');
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_preferred_labels'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . _t('Library checkouts') . "</div>";
$vs_description = _t('List of library checkouts that include this object');
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description, 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_ca_object_checkouts", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
$va_additional_settings = array();
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = $vs_table . '.ca_objects_location';
$vs_label = _t('Current location');
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_ca_objects_location'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . _t('Current location') . "</div>";
$vs_description = _t('Current location of object');
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description, 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_ca_objects_location", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
if (caGetBundleAccessLevel($vs_table, "ca_object_representations") != __CA_BUNDLE_ACCESS_NONE__) {
// get object representations (objects only, of course)
if ($vs_table == 'ca_objects') {
$va_additional_settings = array('display_mode' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'options' => array(_t('Media') => 'media', _t('URL') => 'url'), 'label' => _t('Output mode'), 'description' => _t('Determines if value used is URL of media or the media itself.')));
$o_media_settings = new MediaProcessingSettings('ca_object_representations', 'media');
$va_versions = $o_media_settings->getMediaTypeVersions('*');
foreach ($va_versions as $vs_version => $va_version_info) {
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = 'ca_object_representations.media.' . $vs_version;
$vs_display = "<div id='bundleDisplayEditorBundle_ca_object_representations_media_{$vs_version}'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_ca_object_representations_media_{$vs_version}", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
$t_rep = new ca_object_representations();
if ($this->inTransaction()) {
$t_rep->setTransaction($this->getTransaction());
}
foreach (array('mimetype', 'md5', 'original_filename') as $vs_rep_field) {
$vs_bundle = 'ca_object_representations.' . $vs_rep_field;
$vs_display = "<div id='bundleDisplayEditorBundle_ca_object_representations_{$vs_rep_field}'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_rep->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_rep->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_rep->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => array());
}
}
}
// get related items
$o_dm = $this->getAppDatamodel();
foreach (array('ca_objects', 'ca_object_lots', 'ca_entities', 'ca_places', 'ca_occurrences', 'ca_collections', 'ca_storage_locations', 'ca_loans', 'ca_movements', 'ca_list_items', 'ca_object_representations') as $vs_related_table) {
if ($this->getAppConfig()->get($vs_related_table . '_disable') && !($vs_related_table == 'ca_object_representations' && !$this->getAppConfig()->get('ca_objects_disable'))) {
continue;
}
if (caGetBundleAccessLevel($vs_table, $vs_related_table) == __CA_BUNDLE_ACCESS_NONE__) {
continue;
}
if ($vs_related_table === $vs_table) {
$vs_bundle = $vs_related_table . '.related';
} else {
$vs_bundle = $vs_related_table;
}
$t_rel_instance = $o_dm->getInstanceByTableName($vs_related_table, true);
$vs_table_name = $o_dm->getTableName($this->get('table_num'));
$va_path = array_keys($o_dm->getPath($vs_table_name, $vs_related_table));
if (sizeof($va_path) < 2 || sizeof($va_path) > 3) {
continue;
}
// only use direct relationships (one-many or many-many)
$va_additional_settings = array('format' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Display format'), 'description' => _t('Template used to format output.')), 'restrict_to_relationship_types' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'useRelationshipTypeList' => $va_path[1], 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Restrict to relationship types'), 'description' => _t('Restricts display to items related using the specified relationship type(s). Leave all unchecked for no restriction.')), 'restrict_to_types' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'useList' => $t_rel_instance->getTypeListCode(), 'width' => 35, 'height' => 5, 'takesLocale' => false, 'default' => '', 'label' => _t('Restrict to types'), 'description' => _t('Restricts display to items of the specified type(s). Leave all unchecked for no restriction.')), 'delimiter' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'label' => _t('Delimiter'), 'description' => _t('Text to place in-between repeating values.')));
if ($t_rel_instance->isHierarchical()) {
$va_additional_settings += array('show_hierarchy' => array('formatType' => FT_NUMBER, 'displayType' => DT_CHECKBOXES, 'width' => 10, 'height' => 1, 'hideOnSelect' => array('format'), 'takesLocale' => false, 'default' => '0', 'label' => _t('Show hierarchy?'), 'description' => _t('If checked the full hierarchical path will be shown.')), 'remove_first_items' => array('formatType' => FT_NUMBER, 'displayType' => DT_FIELD, 'width' => 10, 'height' => 1, 'takesLocale' => false, 'default' => '0', 'label' => _t('Remove first items from hierarchy?'), 'description' => _t('If set to a non-zero value, the specified number of items at the top of the hierarchy will be omitted. For example, if set to 2, the root and first child of the hierarchy will be omitted.')), 'hierarchy_order' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'options' => array(_t('top first') => 'ASC', _t('bottom first') => 'DESC'), 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => '', 'label' => _t('Order hierarchy'), 'description' => _t('Determines order in which hierarchy is displayed.')), 'hierarchy_limit' => array('formatType' => FT_NUMBER, 'displayType' => DT_FIELD, 'width' => 10, 'height' => 1, 'takesLocale' => false, 'default' => '', 'label' => _t('Maximum length of hierarchy'), 'description' => _t('Maximum number of items to show in the hierarchy. Leave blank to show the unabridged hierarchy.')), 'hierarchical_delimiter' => array('formatType' => FT_TEXT, 'displayType' => DT_FIELD, 'width' => 35, 'height' => 1, 'takesLocale' => false, 'default' => ' ➔ ', 'label' => _t('Hierarchical delimiter'), 'description' => _t('Text to place in-between elements of a hierarchical value.')));
}
if ($vs_table === 'ca_objects' && $vs_related_table === 'ca_storage_locations' || $vs_table === 'ca_storage_locations' && $vs_related_table === 'ca_objects' || $vs_table === 'ca_objects' && $vs_related_table === 'ca_movements' || $vs_table === 'ca_movements' && $vs_related_table === 'ca_objects' || $vs_table === 'ca_storage_locations' && $vs_related_table === 'ca_movements' || $vs_table === 'ca_movements' && $vs_related_table === 'ca_storage_locations') {
$va_additional_settings['showCurrentOnly'] = array('formatType' => FT_TEXT, 'displayType' => DT_CHECKBOXES, 'width' => "10", 'height' => "1", 'takesLocale' => false, 'default' => '0', 'label' => _t('Show current only?'), 'description' => _t('If checked only current objects are displayed.'));
}
//$va_additional_settings['format']['helpText'] = $this->getTemplatePlaceholderDisplayListForBundle($vs_bundle);
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_id_suffix = "bundleDisplayEditorBundle_" . str_replace(".", "_", $vs_bundle);
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_id_suffix}'><span class='bundleDisplayEditorPlacementListItemTitle'>" . caUcFirstUTF8Safe($t_rel_instance->getProperty('NAME_SINGULAR')) . "</span> " . ($vs_label = $t_rel_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = $t_rel_instance->getDisplayDescription($vs_bundle), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_id_suffix}", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
}
// created and modified
$va_additional_settings = array('dateFormat' => array('formatType' => FT_TEXT, 'displayType' => DT_SELECT, 'width' => 40, 'height' => 1, 'takesLocale' => false, 'default' => 'iso8601', 'options' => array('ISO-8601' => 'iso8601', 'Text' => 'text'), 'label' => _t('Date format'), 'description' => _t('Sets format for output of date when exporting.')));
$t_placement = new ca_bundle_display_placements(null, $va_additional_settings);
if ($this->inTransaction()) {
$t_placement->setTransaction($this->getTransaction());
}
$vs_bundle = "{$vs_table}.created";
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_created'><span class='bundleDisplayEditorPlacementListItemTitle'>" . _t('General') . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_format == 'simple' ? $vs_label : $vs_display, 'description' => $vs_description = _t('Date and time item was created'), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_created", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
$vs_bundle = "{$vs_table}.lastModified";
$vs_display = "<div id='bundleDisplayEditorBundle_{$vs_table}_lastModified'><span class='bundleDisplayEditorPlacementListItemTitle'>" . _t('General') . "</span> " . ($vs_label = $t_instance->getDisplayLabel($vs_bundle)) . "</div>";
$va_available_bundles[strip_tags($vs_display)][$vs_bundle] = array('bundle' => $vs_bundle, 'display' => $vs_display, 'description' => $vs_description = _t('Date and time item was last modified'), 'settingsForm' => $t_placement->getHTMLSettingForm(array('id' => $vs_bundle . '_0')), 'settings' => $va_additional_settings);
if ($vb_show_tooltips) {
TooltipManager::add("#bundleDisplayEditorBundle_{$vs_table}_lastModified", $this->_formatBundleTooltip($vs_label, $vs_bundle, $vs_description));
}
ksort($va_available_bundles);
$va_sorted_bundles = array();
foreach ($va_available_bundles as $vs_k => $va_val) {
foreach ($va_val as $vs_real_key => $va_info) {
$va_sorted_bundles[$vs_real_key] = $va_info;
}
}
return $va_sorted_bundles;
}
/**
* get() value for intrinsic
*
* @param array $pa_value_list
* @param BaseModel $pt_instance
* @param array Options
*
* @return array|string
*/
private function _getIntrinsicValue($pa_value_list, $pt_instance, $pa_options)
{
$vb_return_as_link = isset($pa_options['returnAsLink']) ? $pa_options['returnAsLink'] : false;
$vb_get_direct_date = (bool) caGetOption(array('getDirectDate', 'GET_DIRECT_DATE'), $pa_options, false);
$vb_sortable = isset($pa_options['sortable']) ? $pa_options['sortable'] : false;
$va_path_components = $pa_options['pathComponents'];
$va_field_info = $pa_options['fieldInfo'];
$vs_pk = $pa_options['primaryKey'];
$vs_table_name = $pt_instance->tableName();
// Handle specific intrinsic types
switch ($va_field_info['FIELD_TYPE']) {
case FT_DATERANGE:
case FT_HISTORIC_DATERANGE:
case FT_TIMESTAMP:
case FT_DATETIME:
case FT_HISTORIC_DATETIME:
foreach ($pa_value_list as $vn_locale_id => $va_values) {
if ($pa_options['useLocaleCodes']) {
if (!$vn_locale_id || !($vm_locale_id = $this->opo_locales->localeIDToCode($vn_locale_id))) {
$vm_locale_id = __CA_DEFAULT_LOCALE__;
}
} else {
if (!($vm_locale_id = $vn_locale_id)) {
$vm_locale_id = $this->opo_locales->localeCodeToID(__CA_DEFAULT_LOCALE__);
}
}
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $vn_id = $va_value[$vs_pk];
if (in_array($va_field_info['FIELD_TYPE'], array(FT_TIMESTAMP, FT_DATETIME, FT_HISTORIC_DATETIME))) {
$vs_prop = $va_value[$va_path_components['field_name']];
if (!$vb_get_direct_date && !$vb_sortable) {
$this->opo_tep->init();
if ($va_field_info['FIELD_TYPE'] !== FT_HISTORIC_DATETIME) {
$this->opo_tep->setUnixTimestamps($vs_prop, $vs_prop);
} else {
$this->opo_tep->setHistoricTimestamps($vs_prop, $vs_prop);
}
$vs_prop = $this->opo_tep->getText($pa_options);
}
} elseif ($vb_get_direct_date) {
$vs_prop = $va_value[$va_field_info['START']];
} elseif ($vb_sortable) {
$vs_prop = $va_value[$va_field_info['START']];
} else {
$this->opo_tep->init();
if ($va_field_info['FIELD_TYPE'] == FT_DATERANGE) {
$this->opo_tep->setUnixTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
} else {
$this->opo_tep->setHistoricTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
}
$vs_prop = $this->opo_tep->getText($pa_options);
}
if ($vb_return_as_link) {
$vs_prop = array_shift(caCreateLinksFromText(array($vs_prop), $vs_table_name, array($vn_id)));
}
$va_return_values[$vn_id][$vm_locale_id] = $vs_prop;
}
}
break;
case FT_MEDIA:
if (!($vs_version = $va_path_components['subfield_name'])) {
$vs_version = "largeicon";
// TODO: fix
}
foreach ($pa_value_list as $vn_locale_id => $va_values) {
if ($pa_options['useLocaleCodes']) {
if (!$vn_locale_id || !($vm_locale_id = $this->opo_locales->localeIDToCode($vn_locale_id))) {
$vm_locale_id = __CA_DEFAULT_LOCALE__;
}
} else {
if (!($vm_locale_id = $vn_locale_id)) {
$vm_locale_id = $this->opo_locales->localeCodeToID(__CA_DEFAULT_LOCALE__);
}
}
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $vn_id = $va_value[$vs_pk];
$o_media_settings = new MediaProcessingSettings($va_path_components['table_name'], $va_path_components['field_name']);
$va_versions = $o_media_settings->getMediaTypeVersions('*');
if (!isset($va_versions[$vs_version])) {
$va_tmp = array_keys($va_versions);
$vs_version = array_shift($va_tmp);
}
// See if an info element was passed, eg. ca_object_representations.media.icon.width should return the width of the media rather than a tag or url to the media
$vs_info_element = $va_path_components['num_components'] == 4 ? $va_path_components['components'][3] : null;
if ($pa_options['unserialize']) {
$va_return_values[$vn_id][$vm_locale_id] = caUnserializeForDatabase($va_value[$va_path_components['field_name']]);
} elseif ($vs_info_element) {
$va_return_values[$vn_id][$vm_locale_id] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_return_values[$vn_id][$vm_locale_id] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} elseif (isset($pa_options['returnPath']) && $pa_options['returnPath']) {
$va_return_values[$vn_id][$vm_locale_id] = $this->getMediaPath($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_return_values[$vn_id][$vm_locale_id] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
}
}
break;
default:
// is intrinsic field in primary table
foreach ($pa_value_list as $vn_locale_id => $va_values) {
if ($pa_options['useLocaleCodes']) {
if (!$vn_locale_id || !($vm_locale_id = $this->opo_locales->localeIDToCode($vn_locale_id))) {
$vm_locale_id = __CA_DEFAULT_LOCALE__;
}
} else {
if (!($vm_locale_id = $vn_locale_id)) {
$vm_locale_id = $this->opo_locales->localeCodeToID(__CA_DEFAULT_LOCALE__);
}
}
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $vn_id = $va_value[$vs_pk];
$vs_prop = $va_value[$va_path_components['field_name']];
if ($pa_options['unserialize']) {
$vs_prop = caUnserializeForDatabase($vs_prop);
}
if ($pa_options['convertCodesToDisplayText']) {
$vs_prop = $this->_convertCodeToDisplayText($vs_prop, $va_path_components, $pt_instance, $pa_options);
} elseif ($pa_options['convertCodesToIdno']) {
$vs_prop = $this->_convertCodeToIdno($vs_prop, $va_path_components, $pt_instance, $pa_options);
}
$va_return_values[$vn_id][$vm_locale_id] = $vs_prop;
}
}
break;
}
if (!$pa_options['returnAllLocales']) {
$va_return_values = caExtractValuesByUserLocale($va_return_values);
}
if ($pa_options['returnWithStructure']) {
return is_array($va_return_values) ? $va_return_values : array();
}
//
// Flatten array for return as string or simple array value
//
$va_flattened_values = $this->_flattenArray($va_return_values, $pa_options);
if ($pa_options['returnAsArray']) {
return $va_flattened_values;
} else {
return sizeof($va_flattened_values) > 0 ? join($pa_options['delimiter'], $va_flattened_values) : null;
}
}
/**
* Method invoked when the task queue needs to actually execute the task. For mediaproc this means
* actually doing the processing of media!
*
* Return false on failure/error and sets the error property with an error description. Returns an array
* with processing details on success.
*
* @param array $pa_parameters An unserialized parameters array for the current task (eg. unserialized data from ca_task_queue.parameters)
* @return array Returns false on error, or an array with processing details on success
*/
public function process($pa_parameters)
{
$vs_table = $pa_parameters["TABLE"];
// name of table of record we're processing
$vs_field = $pa_parameters["FIELD"];
// name of field in record we're processing
$vs_pk = $pa_parameters["PK"];
// Field name of primary key of record we're processing
$vn_id = $pa_parameters["PK_VAL"];
// Value of primary key
$vs_input_mimetype = $pa_parameters["INPUT_MIMETYPE"];
// Mimetype of input file
$vs_input_file = $pa_parameters["FILENAME"];
// Full path to input file
// Array of media versions to process; keys are version names,
// values are arrays with info about processing for that version
// Currently the info array contains a single key, 'VOLUME', which indicates
// the volume the version should be written to
$va_versions = $pa_parameters["VERSIONS"];
$va_options = $pa_parameters["OPTIONS"];
// Array of processing options; names of options to employ are keys, settings are values
// If true, then input media is *not* deleted
$vb_dont_delete_original_media = (bool) $pa_parameters["DONT_DELETE_OLD_MEDIA"];
$va_report = array('errors' => array(), 'notes' => array());
$o_dm = Datamodel::load();
$o_media_volumes = new MediaVolumes();
$o_media = new Media();
$o_media_proc_settings = new MediaProcessingSettings($vs_table, $vs_field);
$vs_media_type = $o_media_proc_settings->canAccept($vs_input_mimetype);
$va_version_info = $o_media_proc_settings->getMediaTypeVersions($vs_media_type);
if (!file_exists($vs_input_file)) {
$o_eventlog = new EventLog();
$o_eventlog->log(array("CODE" => "DEBG", "SOURCE" => "TaskQueue->mediaproc->process()", "MESSAGE" => "Record {$vs_table}.field = file '{$vs_input_file}' did not exist; queued file was discarded"));
$va_report['errors'][] = _t("Record %1.field = file '%2' did not exist; queued file was discarded", $vs_table, $vs_input_file);
return $va_report;
}
if ($t_instance = $o_dm->getInstanceByTableName($vs_table, true)) {
if ($t_instance->hasField($vs_field)) {
if (!$t_instance->load($vn_id)) {
# record no longer exists
if (!$vb_dont_delete_original_media) {
@unlink($vs_input_file);
}
$o_eventlog = new EventLog();
$o_eventlog->log(array("CODE" => "DEBG", "SOURCE" => "TaskQueue->mediaproc->process()", "MESSAGE" => "Record {$vs_table}.field = {$vn_id} did not exist; queued file was discarded"));
$o_media->cleanup();
$va_report['errors'][] = _t("Record %1.field = %2 did not exist; queued file was discarded", $vs_table, $vn_id);
return $va_report;
}
} else {
# bad field name
$this->error->setError(551, _t("Invalid media field '%1' in table '%2'", $vs_field, $vs_table), "mediaproc->process()");
return false;
}
} else {
# bad table name
$this->error->setError(550, _t("Invalid media field table '%1'", $vs_table), "mediaproc->process()");
return false;
}
$va_old_media_to_delete = array();
foreach ($va_versions as $v => $va_version_settings) {
$vs_use_icon = null;
if (!file_exists($vs_input_file)) {
$this->error->setError(505, _t("Input media file '%1' does not exist", $vs_input_file), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if (!is_readable($vs_input_file)) {
$this->error->setError(506, _t("Denied permission to read input media file '%1'", $vs_input_file), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if (!$o_media->read($vs_input_file)) {
$this->error->setError(1600, _t("Could not process input media file '%1': %2", $vs_input_file, join('; ', $o_media->getErrors())), "mediaproc->process()");
$o_media->cleanup();
return false;
}
$vs_rule = isset($va_version_info[$v]['RULE']) ? $va_version_info[$v]['RULE'] : '';
$va_rules = $o_media_proc_settings->getMediaTransformationRule($vs_rule);
$va_volume_info = $o_media_volumes->getVolumeInformation($va_version_settings['VOLUME']);
if (sizeof($va_rules) == 0) {
$vs_output_mimetype = $vs_input_mimetype;
#
# don't process this media, just copy the file
#
$vs_ext = $o_media->mimetype2extension($vs_output_mimetype);
if (!$vs_ext) {
$this->error->setError(1600, _t("File could not be copied for %1; can't convert mimetype %2 to extension", $vs_field, $vs_output_mimetype), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if (($vs_dirhash = $this->_getDirectoryHash($va_volume_info["absolutePath"], $vn_id)) === false) {
$this->error->setError(1600, _t("Couldn't create subdirectory for file for %1", $vs_field), "mediaproc->process()");
$o_media->cleanup();
return false;
}
$vs_magic = rand(0, 99999);
$vs_filepath = $va_volume_info["absolutePath"] . "/" . $vs_dirhash . "/" . $vs_magic . "_" . $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v . "." . $vs_ext;
if (!copy($vs_input_file, $vs_filepath)) {
$this->error->setError(504, _t("File could not be copied for %1", $vs_field), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if (is_array($va_volume_info["mirrors"]) && sizeof($va_volume_info["mirrors"]) > 0) {
$entity_key = join("/", array($vs_table, $vs_field, $vn_id, $v));
$row_key = join("/", array($vs_table, $vn_id));
foreach ($va_volume_info["mirrors"] as $vs_mirror_code => $va_mirror_info) {
$vs_mirror_method = $va_mirror_info["method"];
$vs_queue = $vs_mirror_method . "mirror";
$tq = new TaskQueue();
if (!$tq->cancelPendingTasksForEntity($entity_key)) {
$this->error->setError(560, _t("Could not cancel pending tasks"), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if ($tq->addTask($vs_queue, array("MIRROR" => $vs_mirror_code, "VOLUME" => $va_version_settings['VOLUME'], "FIELD" => $vs_field, "TABLE" => $vs_table, "VERSION" => $v, "FILES" => array(array("FILE_PATH" => $vs_filepath, "ABS_PATH" => $va_volume_info["absolutePath"], "HASH" => $vs_dirhash, "FILENAME" => $vs_magic . "_" . $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v . "." . $vs_ext)), "MIRROR_INFO" => $va_mirror_info, "PK" => $vs_pk, "PK_VAL" => $vn_id), array("priority" => 100, "entity_key" => $entity_key, "row_key" => $row_key))) {
continue;
} else {
$this->error->setError(100, _t("Couldn't queue mirror using '%1' for version '%2' (handler '%3')", $vs_mirror_method, $v, $vs_queue), "mediaproc->process()");
}
}
}
$media_desc[$v] = array("VOLUME" => $va_version_settings['VOLUME'], "MIMETYPE" => $vs_output_mimetype, "WIDTH" => $o_media->get("width"), "HEIGHT" => $o_media->get("height"), "PROPERTIES" => $o_media->getProperties(), "FILENAME" => $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v . "." . $vs_ext, "HASH" => $vs_dirhash, "MAGIC" => $vs_magic, "EXTENSION" => $vs_ext, "MD5" => md5_file($vs_filepath));
} else {
$o_media->set('version', $v);
while (list($operation, $pa_parameters) = each($va_rules)) {
if ($operation === 'SET') {
foreach ($pa_parameters as $pp => $pv) {
if ($pp == 'format') {
$vs_output_mimetype = $pv;
} else {
$o_media->set($pp, $pv);
}
}
} else {
if (!$o_media->transform($operation, $pa_parameters)) {
$this->error = $o_media->errors[0];
$o_media->cleanup();
return false;
}
}
}
if (!$vs_output_mimetype) {
$vs_output_mimetype = $vs_input_mimetype;
}
if (!($vs_ext = $o_media->mimetype2extension($vs_output_mimetype))) {
$this->error->setError(1600, _t("File could not be processed for %1; can't convert mimetype %2 to extension", $vs_field, $vs_output_mimetype), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if (($vs_dirhash = $this->_getDirectoryHash($va_volume_info["absolutePath"], $vn_id)) === false) {
$this->error->setError(1600, _t("Couldn't create subdirectory for file for %1", $vs_field), "mediaproc->process()");
$o_media->cleanup();
return false;
}
$vs_magic = rand(0, 99999);
$vs_filepath = $va_volume_info["absolutePath"] . "/" . $vs_dirhash . "/" . $vs_magic . "_" . $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v;
if (!($vs_output_file = $o_media->write($vs_filepath, $vs_output_mimetype, $va_options))) {
$this->error = $o_media->errors[0];
$o_media->cleanup();
return false;
} else {
if ($vs_output_file === __CA_MEDIA_VIDEO_DEFAULT_ICON__ || $vs_output_file === __CA_MEDIA_AUDIO_DEFAULT_ICON__ || $vs_output_file === __CA_MEDIA_DOCUMENT_DEFAULT_ICON__) {
$vs_use_icon = $vs_output_file;
} else {
$va_output_files[] = $vs_output_file;
}
}
if (is_array($va_volume_info["mirrors"]) && sizeof($va_volume_info["mirrors"]) > 0) {
$entity_key = join("/", array($vs_table, $vs_field, $vn_id, $v));
$row_key = join("/", array($vs_table, $vn_id));
foreach ($va_volume_info["mirrors"] as $vs_mirror_code => $va_mirror_info) {
$vs_mirror_method = $va_mirror_info["method"];
$vs_queue = $vs_mirror_method . "mirror";
$tq = new TaskQueue();
if (!$tq->cancelPendingTasksForEntity($entity_key)) {
$this->error->setError(560, _t("Could not cancel pending tasks"), "mediaproc->process()");
$o_media->cleanup();
return false;
}
if ($tq->addTask($vs_queue, array("MIRROR" => $vs_mirror_code, "VOLUME" => $va_version_settings['VOLUME'], "FIELD" => $vs_field, "TABLE" => $vs_table, "VERSION" => $v, "FILES" => array(array("FILE_PATH" => $vs_filepath, "ABS_PATH" => $va_volume_info["absolutePath"], "HASH" => $vs_dirhash, "FILENAME" => $vs_magic . "_" . $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v . "." . $vs_ext)), "MIRROR_INFO" => $va_mirror_info, "PK" => $vs_pk, "PK_VAL" => $vn_id), array("priority" => 100, "entity_key" => $entity_key, "row_key" => $row_key))) {
continue;
} else {
$this->error->setError(100, _t("Couldn't queue mirror using '%1' for version '%2' (handler '%3')", $vs_mirror_method, $v, $vs_queue), "mediaproc->process()");
}
}
}
if ($vs_use_icon) {
$media_desc[$v] = array("MIMETYPE" => $vs_output_mimetype, "USE_ICON" => $vs_use_icon, "WIDTH" => $o_media->get("width"), "HEIGHT" => $o_media->get("height"));
} else {
$media_desc[$v] = array("VOLUME" => $va_version_settings['VOLUME'], "MIMETYPE" => $vs_output_mimetype, "WIDTH" => $o_media->get("width"), "HEIGHT" => $o_media->get("height"), "PROPERTIES" => $o_media->getProperties(), "FILENAME" => $vs_table . "_" . $vs_field . "_" . $vn_id . "_" . $v . "." . $vs_ext, "HASH" => $vs_dirhash, "MAGIC" => $vs_magic, "EXTENSION" => $vs_ext, "MD5" => md5_file($vs_filepath . "." . $vs_ext));
}
}
if (!$vb_dont_delete_original_media) {
$vs_old_media_path = $t_instance->getMediaPath($vs_field, $v);
if ($vs_old_media_path && $vs_filepath . "." . $vs_ext != $vs_old_media_path && $vs_input_file != vs_old_media_path) {
//@unlink($t_instance->getMediaPath($vs_field, $v));
$va_old_media_to_delete[] = $vs_old_media_path;
}
}
}
#
# Update record
#
if ($t_instance->load($vn_id)) {
if (method_exists($t_instance, "useBlobAsMediaField")) {
// support for attributes - force field to be FT_MEDIA
$t_instance->useBlobAsMediaField(true);
}
$md = $t_instance->get($vs_field);
$va_merged_media_desc = is_array($md) ? $md : array();
foreach ($media_desc as $vs_k => $va_v) {
$va_merged_media_desc[$vs_k] = $va_v;
}
$t_instance->setMode(ACCESS_WRITE);
$t_instance->setMediaInfo($vs_field, $va_merged_media_desc);
$t_instance->update();
if ($t_instance->numErrors()) {
# get rid of files we just created
foreach ($va_output_files as $vs_to_delete) {
@unlink($vs_to_delete);
}
$this->error->setError(560, _t("Could not update %1.%2: %3", $vs_table, $vs_field, join(", ", $t_instance->getErrors())), "mediaproc->process()");
$o_media->cleanup();
return false;
}
$va_report['notes'][] = _t("Processed file %1", $vs_input_file);
// Generate preview frames for media that support that (Eg. video)
// and add them as "multifiles" assuming the current model supports that (ca_object_representations does)
$o_config = Configuration::load();
if (((bool) $o_config->get('video_preview_generate_frames') || (bool) $o_config->get('document_preview_generate_pages')) && method_exists($t_instance, 'addFile')) {
$o_media->read($vs_input_file);
$va_preview_frame_list = $o_media->writePreviews(array('width' => $o_media->get("width"), 'height' => $o_media->get("height"), 'numberOfFrames' => $o_config->get('video_preview_max_number_of_frames'), 'numberOfPages' => $o_config->get('document_preview_max_number_of_pages'), 'frameInterval' => $o_config->get('video_preview_interval_between_frames'), 'pageInterval' => $o_config->get('document_preview_interval_between_pages'), 'startAtTime' => $o_config->get('video_preview_start_at'), 'endAtTime' => $o_config->get('video_preview_end_at'), 'startAtPage' => $o_config->get('document_preview_start_page'), 'outputDirectory' => __CA_APP_DIR__ . '/tmp'));
$t_instance->removeAllFiles();
// get rid of any previously existing frames (they might be hanging around if we're editing an existing record)
if (is_array($va_preview_frame_list)) {
foreach ($va_preview_frame_list as $vn_time => $vs_frame) {
$t_instance->addFile($vs_frame, $vn_time, true);
// the resource path for each frame is it's time, in seconds (may be fractional) for video, or page number for documents
@unlink($vs_frame);
// clean up tmp preview frame file
}
}
}
if (!$vb_dont_delete_original_media) {
@unlink($vs_input_file);
}
foreach ($va_old_media_to_delete as $vs_to_delete) {
@unlink($vs_to_delete);
}
$o_media->cleanup();
return $va_report;
} else {
# record no longer exists
if (!$vb_dont_delete_original_media) {
@unlink($vs_input_file);
}
$o_eventlog = new EventLog();
$o_eventlog->log(array("CODE" => "DEBG", "SOURCE" => "TaskQueue->mediaproc->process()", "MESSAGE" => "Record {$vs_table}.field = {$vn_id} did not exist; queued file was discarded"));
$o_media->cleanup();
$va_report['errors'][] = _t("Record {$vs_table}.field = {$vn_id} did not exist; queued file was discarded");
return $va_report;
}
}
/**
* Implementation of primary get() functionality
*/
private function _get($ps_field, $pa_options = null)
{
if (!is_array($pa_options)) {
$pa_options = array();
}
if (isset($pa_options['restrictToType']) && (!isset($pa_options['restrict_to_type']) || !$pa_options['restrict_to_type'])) {
$pa_options['restrict_to_type'] = $pa_options['restrictToType'];
}
if (isset($pa_options['restrictToTypes']) && (!isset($pa_options['restrict_to_types']) || !$pa_options['restrict_to_types'])) {
$pa_options['restrict_to_types'] = $pa_options['restrictToTypes'];
}
if (isset($pa_options['restrictToRelationshipTypes']) && (!isset($pa_options['restrict_to_relationship_types']) || !$pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = $pa_options['restrictToRelationshipTypes'];
}
if (isset($pa_options['excludeType']) && (!isset($pa_options['exclude_type']) || !$pa_options['exclude_type'])) {
$pa_options['exclude_type'] = $pa_options['excludeType'];
}
if (isset($pa_options['excludeTypes']) && (!isset($pa_options['exclude_types']) || !$pa_options['exclude_types'])) {
$pa_options['exclude_types'] = $pa_options['excludeTypes'];
}
if (isset($pa_options['excludeRelationshipTypes']) && (!isset($pa_options['exclude_relationship_types']) || !$pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = $pa_options['excludeRelationshipTypes'];
}
$vb_return_as_array = caGetOption('returnAsArray', $pa_options, false, array('castTo' => 'bool'));
$vb_return_all_locales = caGetOption('returnAllLocales', $pa_options, false, array('castTo' => 'bool'));
$vb_return_as_link = caGetOption('returnAsLink', $pa_options, false, array('castTo' => 'bool'));
$vs_return_as_link_text = caGetOption('returnAsLinkText', $pa_options, '');
$vs_return_as_link_target = caGetOption('returnAsLinkTarget', $pa_options, '');
$vs_return_as_link_attributes = caGetOption('returnAsLinkAttributes', $pa_options, array(), array('castTo' => 'array'));
$va_original_path_components = $va_path_components = $this->getFieldPathComponents($ps_field);
if ($va_path_components['table_name'] != $this->ops_table_name) {
$vs_access_chk_key = $va_path_components['table_name'] . ($va_path_components['field_name'] ? '.' . $va_path_components['field_name'] : '');
} else {
$vs_access_chk_key = $va_path_components['field_name'];
}
if (caGetBundleAccessLevel($this->ops_table_name, $vs_access_chk_key) == __CA_BUNDLE_ACCESS_NONE__) {
return null;
}
$vo_request = caGetOption('request', $pa_options, null);
unset($pa_options['request']);
// first see if the search engine can provide the field value directly (fastest)
if (!(($vs_value = $this->opo_engine_result->get($ps_field, $pa_options)) === false)) {
if ($vb_return_as_array) {
if ($vb_return_all_locales) {
return array(1 => $vs_value);
} else {
return array($vs_value);
}
} else {
return $vs_value;
}
}
$vs_template = caGetOption('template', $pa_options, null);
$vs_delimiter = caGetOption('delimiter', $pa_options, ' ');
$vs_hierarchical_delimiter = caGetOption('hierarchicalDelimiter', $pa_options, ' ');
if ($vb_return_all_locales && !$vb_return_as_array) {
$vb_return_as_array = true;
}
if (isset($pa_options['sort']) && !is_array($pa_options['sort'])) {
$pa_options['sort'] = array($pa_options['sort']);
}
if (is_array($va_sort_fields = isset($pa_options['sort']) && is_array($pa_options['sort']) ? $pa_options['sort'] : null)) {
foreach ($va_sort_fields as $vn_i => $vs_sort_fld) {
if (!trim($vs_sort_fld)) {
unset($va_sort_fields[$vn_i]);
}
}
}
$vn_row_id = $this->opo_engine_result->get($this->ops_table_pk);
// try to lazy load (slower)...
//
// Are we getting timestamp (created on or last modified) info?
//
if ($va_path_components['table_name'] == $this->ops_table_name && $va_path_components['field_name'] == 'created') {
if (!isset($this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id])) {
$this->prefetchChangeLogData($this->ops_table_name, $this->opo_engine_result->currentRow(), $this->getOption('prefetch'));
}
if ($vb_return_as_array) {
return $this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id];
} else {
$vs_subfield = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : 'timestamp';
$vm_val = $this->opa_timestamp_cache['created_on'][$this->ops_table_name][$vn_row_id][$vs_subfield];
if ($vs_subfield == 'timestamp') {
$o_tep = new TimeExpressionParser();
$o_tep->setUnixTimestamps($vm_val, $vm_val);
$vm_val = $o_tep->getText($pa_options);
}
return $vm_val;
}
}
if ($va_path_components['table_name'] == $this->ops_table_name && $va_path_components['field_name'] == 'lastModified') {
if (!isset($this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id])) {
$this->prefetchChangeLogData($this->ops_table_name, $this->opo_engine_result->currentRow(), $this->getOption('prefetch'));
}
if ($vb_return_as_array) {
return $this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id];
} else {
$vs_subfield = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : 'timestamp';
$vm_val = $this->opa_timestamp_cache['last_changed'][$this->ops_table_name][$vn_row_id][$vs_subfield];
if ($vs_subfield == 'timestamp') {
$o_tep = new TimeExpressionParser();
$o_tep->setUnixTimestamps($vm_val, $vm_val);
$vm_val = $o_tep->getText($pa_options);
}
return $vm_val;
}
}
if (!($t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true))) {
return null;
}
// Bad table
$t_original_instance = $t_instance;
// $t_original_instance will always be the as-called subject; optimizations may results in $t_instance being transformed into a different model
//
// Simple related table get:
// <table>
// <table>.related
// <table>.hierarchy
// <table>.related.hierarchy
//
if ($va_path_components['num_components'] == 1 && $va_path_components['table_name'] !== $this->ops_table_name || $va_path_components['num_components'] == 2 && $va_path_components['field_name'] == 'related' || $va_path_components['num_components'] == 2 && $va_path_components['field_name'] == 'hierarchy' || $va_path_components['num_components'] == 3 && $va_path_components['field_name'] == 'related' && $va_path_components['subfield_name'] == 'hierarchy') {
if (!($t_table = $this->opo_datamodel->getInstanceByTableName($this->ops_table_name, true))) {
return null;
}
$vb_show_hierarachy = (bool) ($va_path_components['field_name'] == 'hierarchy' && $t_instance->isHierarchical());
if ($va_path_components['num_components'] == 2) {
$va_path_components['num_components'] = 1;
$va_path_components['field_name'] = null;
}
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
$va_related_items = $this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5];
if (!is_array($va_related_items)) {
return null;
}
if (is_array($va_sort_fields) && sizeof($va_sort_fields)) {
$va_related_items = caSortArrayByKeyInValue($va_related_items, $va_sort_fields);
}
// Return as array
if ($vs_template) {
return caProcessTemplateForIDs($vs_template, $this->opo_subject_instance->tableName(), array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
if ($vb_return_as_array || $vb_return_all_locales) {
if ($vb_return_all_locales) {
$va_related_tmp = array();
foreach ($va_related_items as $vn_i => $va_related_item) {
$va_related_tmp[$vn_i][$va_related_item['locale_id']] = $va_related_item;
}
return $va_related_tmp;
} else {
if (!$vs_template && !$va_path_components['field_name']) {
return $va_related_items;
}
$vs_pk = $t_instance->primaryKey();
$va_links = array();
foreach ($va_related_items as $vn_relation_id => $va_relation_info) {
$va_relation_info['labels'] = caExtractValuesByUserLocale(array(0 => $va_relation_info['labels']));
if ($vb_return_as_link) {
$va_template_opts = array();
$va_template_opts['relationshipValues'][$va_relation_info[$vs_pk]][$va_relation_info['relation_id']]['relationship_typename'] = $va_relation_info['relationship_typename'];
$vs_text = $vs_template ? caProcessTemplateForIDs($vs_template, $t_instance->tableName(), array($va_relation_info[$vs_pk]), $va_template_opts) : join("; ", $va_relation_info['labels']);
$va_link = caCreateLinksFromText(array($vs_text), $va_original_path_components['table_name'], array($va_relation_info[$vs_pk]), $vs_return_as_link_class, $vs_return_as_link_target);
$va_links[$vn_relation_id] = array_pop($va_link);
} else {
$va_related_items[$vn_relation_id]['labels'] = $va_relation_info['labels'];
}
}
if ($vb_return_as_link) {
return $va_links;
}
return $va_related_items;
}
} else {
// Return scalar
$va_proc_labels = array();
$va_row_ids = array();
$vs_rel_pk = $t_instance->primaryKey();
$va_relationship_values = array();
foreach ($va_related_items as $vn_relation_id => $va_relation_info) {
$va_row_ids[] = $va_relation_info[$vs_rel_pk];
$va_relationship_values[$va_relation_info[$vs_rel_pk]][$vn_relation_id] = array('relationship_typename' => $va_relation_info['relationship_typename'], 'relationship_type_id' => $va_relation_info['relationship_type_id'], 'relationship_type_code' => $va_relation_info['relationship_type_code'], 'relationship_typecode' => $va_relation_info['relationship_type_code'], 'label' => $va_relation_info['label']);
}
if (!sizeof($va_row_ids)) {
return '';
}
if (!$vs_template) {
$vs_template = "^label";
}
$va_template_opts = $pa_options;
unset($va_template_opts['request']);
unset($va_template_opts['template']);
$va_template_opts['returnAsLink'] = false;
$va_template_opts['returnAsArray'] = true;
$va_text = caProcessTemplateForIDs($vs_template, $t_instance->tableNum(), $va_row_ids, array_merge($va_template_opts, array('relationshipValues' => $va_relationship_values, 'showHierarchicalLabels' => $vb_show_hierarachy)));
if ($vb_return_as_link) {
$va_links = caCreateLinksFromText($va_text, $va_original_path_components['table_name'], $va_row_ids, $vs_return_as_link_class, $vs_return_as_link_target);
return join($vs_delimiter, $va_links);
}
return join($vs_delimiter, $va_text);
}
}
$vb_need_parent = false;
$vb_need_children = false;
//
// Transform "preferred_labels" into tables for pre-fetching
//
$vb_is_get_for_labels = $vb_return_all_label_values = $vb_get_preferred_labels_only = $vb_get_nonpreferred_labels_only = false;
if (in_array($va_path_components['field_name'], array('preferred_labels', 'nonpreferred_labels'))) {
if ($t_instance->getProperty('LABEL_TABLE_NAME')) {
$vb_get_preferred_labels_only = $va_path_components['field_name'] == 'preferred_labels' ? true : false;
$vb_get_nonpreferred_labels_only = $va_path_components['field_name'] == 'nonpreferred_labels' ? true : false;
if ($va_path_components['num_components'] == 2) {
// if it's just <table_name>.preferred_labels then return an array of fields from the label table
$vb_return_all_label_values = true;
}
$va_path_components['table_name'] = $t_instance->getLabelTableName();
$t_label_instance = $t_instance->getLabelTableInstance();
if (!$va_path_components['subfield_name'] || !$t_label_instance->hasField($va_path_components['subfield_name'])) {
$va_path_components['field_name'] = $t_instance->getLabelDisplayField();
} else {
$va_path_components['field_name'] = $va_path_components['subfield_name'];
}
$va_path_components['subfield_name'] = null;
$va_path_components = $this->getFieldPathComponents($va_path_components['table_name'] . '.' . $va_path_components['field_name']);
// Ok, convert the table instance to the label table since that's the table we'll be grabbing data from
$t_instance = $t_label_instance;
$vb_is_get_for_labels = true;
}
}
//
// Handle modifiers (parent, children, related, hierarchy) with and without fields
//
if ($va_path_components['num_components'] >= 2) {
switch ($va_path_components['field_name']) {
case 'parent':
if ($t_instance->isHierarchical() && ($vn_parent_id = $this->get($va_path_components['table_name'] . '.' . $t_instance->getProperty('HIERARCHY_PARENT_ID_FLD')))) {
//
// TODO: support some kind of prefetching of parents?
//
unset($va_path_components['components'][1]);
if ($t_instance->load($vn_parent_id)) {
return $t_instance->get(join('.', array_values($va_path_components['components'])), $pa_options);
}
return null;
}
break;
case 'children':
if ($t_instance->isHierarchical()) {
//unset($va_path_components['components'][1]); // remove 'children' from field path
$vs_field_spec = join('.', array_values($va_path_components['components']));
if ($vn_id = $this->get($va_path_components['table_name'] . '.' . $t_instance->primaryKey(), array('returnAsArray' => false))) {
if ($t_instance->load($vn_id)) {
return $t_instance->get($vs_field_spec, $pa_options);
}
}
return null;
}
break;
case 'related':
// Regular related table call
if ($va_path_components['table_name'] != $this->ops_table_name) {
// just remove "related" from name and be on our way
$va_tmp = $va_path_components['components'];
array_splice($va_tmp, 1, 1);
return $this->get(join('.', $va_tmp), $pa_options);
}
// Self-relations need special handling
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
$va_related_items = $this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5];
if (!($t_table = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true))) {
return null;
}
$va_ids = array();
foreach ($va_related_items as $vn_relation_id => $va_item) {
$va_ids[] = $va_item[$t_table->primaryKey()];
}
$va_vals = array();
if ($qr_res = $t_table->makeSearchResult($va_path_components['table_name'], $va_ids)) {
$va_tmp = $va_path_components['components'];
unset($va_tmp[1]);
$vs_rel_field = join('.', $va_tmp);
while ($qr_res->nextHit()) {
if ($vb_return_as_array) {
$va_vals = array_merge($va_vals, $qr_res->get($vs_rel_field, $pa_options));
} else {
$va_vals[] = $qr_res->get($vs_rel_field, $pa_options);
}
}
}
//if (is_array($va_sort_fields) && sizeof($va_sort_fields)) {
// $va_vals = caSortArrayByKeyInValue($va_vals, $va_sort_fields);
//}
if ($vb_return_as_link) {
if (!$vb_return_all_locales) {
$va_vals = caCreateLinksFromText($va_vals, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
}
if ($vb_return_as_array) {
return $va_vals;
} else {
return join($vs_delimiter, $va_vals);
}
break;
case 'hierarchy':
$vn_max_levels_from_bottom = caGetOption('maxLevelsFromBottom', $pa_options, caGetOption('maxLevels', $pa_options, null));
$vn_max_levels_from_top = caGetOption('maxLevelsFromTop', $pa_options, null);
if ($t_instance->isHierarchical()) {
$vs_field_spec = join('.', array_values($va_path_components['components']));
$vs_hier_pk_fld = $t_instance->primaryKey();
if ($va_ids = $this->get($va_path_components['table_name'] . '.' . $vs_hier_pk_fld, array_merge($pa_options, array('returnAsArray' => true, 'returnAsLink' => false, 'returnAllLocales' => false)))) {
$va_vals = array();
if ($va_path_components['subfield_name'] == $vs_hier_pk_fld) {
foreach ($va_ids as $vn_id) {
// TODO: This is too slow
if ($t_instance->load($vn_id)) {
$va_vals = array_merge($va_vals, $t_instance->get($va_path_components['table_name'] . ".hierarchy." . $vs_hier_pk_fld, array_merge($pa_options, array('returnAsArray' => true))));
}
}
} else {
foreach ($va_ids as $vn_id) {
// TODO: This is too slow
if ($t_instance->load($vn_id)) {
$va_vals = $t_instance->get($vs_field_spec, array_merge($pa_options, array('returnAsArray' => true)));
if (is_array($va_vals)) {
$va_vals = array_reverse($va_vals);
}
// Add/replace hierarchy name
if ($t_instance->getProperty('HIERARCHY_TYPE') == __CA_HIER_TYPE_MULTI_MONO__ && $t_instance->getHierarchyName()) {
$vn_first_key = array_shift(array_keys($va_vals));
if ($vb_return_all_locales) {
$va_vals[$vn_first_key] = array(0 => array($t_instance->getHierarchyName()));
} else {
$va_vals[$vn_first_key] = $t_instance->getHierarchyName();
}
}
if ($vn_max_levels_from_bottom > 0) {
if (($vn_start = sizeof($va_vals) - $vn_max_levels_from_bottom) < 0) {
$vn_start = 0;
}
$va_vals = array_slice($va_vals, $vn_start, $vn_max_levels_from_bottom, true);
} elseif ($vn_max_levels_from_top > 0) {
$va_vals = array_slice($va_vals, 0, $vn_max_levels_from_top, true);
}
}
}
}
if ($vb_return_as_array) {
return $va_vals;
} else {
return join($vs_hierarchical_delimiter, $va_vals);
}
}
return null;
}
break;
}
}
// If the requested table was not added to the query via SearchEngine::addTable()
// then auto-add it here. It's better to explicitly add it with addTables() as that call
// gives you precise control over which fields are autoloaded and also lets you specify limiting criteria
// for selection of related field data; and it also lets you explicitly define the tables used to join the
// related table. Autoloading guesses and usually does what you want, but not always.
if (!isset($this->opa_tables[$va_path_components['table_name']]) || !$this->opa_tables[$va_path_components['table_name']]) {
$va_join_tables = $this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']);
array_shift($va_join_tables);
// remove subject table
array_pop($va_join_tables);
// remove content table (we only need linking tables here)
$va_join_criteria = array();
if (is_array($va_primary_ids)) {
foreach ($va_primary_ids as $vs_t => $va_t_ids) {
if (isset($va_join_tables[$vs_t]) && sizeof($va_t_ids) > 0) {
$vs_t_pk = $this->opo_datamodel->getTablePrimaryKeyName($vs_t);
$va_join_criteria[] = "{$vs_t}.{$vs_t_pk} NOT IN (" . join(",", $va_t_ids) . ")";
}
}
}
$this->opa_tables[$va_path_components['table_name']] = array('fieldList' => array($va_path_components['table_name'] . '.*'), 'joinTables' => array_keys($va_join_tables), 'criteria' => $va_join_criteria);
}
if ($va_path_components['table_name'] === $this->ops_table_name && !$t_instance->hasField($va_path_components['field_name']) && method_exists($t_instance, 'getAttributes')) {
//
// Return attribute values for primary table
//
if ($va_path_components['field_name'] && ($t_element = $t_instance->_getElementInstance($va_path_components['field_name']))) {
$vn_element_id = $t_element->getPrimaryKey();
} else {
$vn_element_id = null;
}
if (!isset(ca_attributes::$s_get_attributes_cache[$this->opn_table_num . '/' . $vn_row_id][$vn_element_id])) {
ca_attributes::prefetchAttributes($this->opo_db, $this->opn_table_num, $this->getRowIDsToPrefetch($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch')), $vn_element_id ? array($vn_element_id) : null, array('dontFetchAlreadyCachedValues' => true));
}
if (!$vb_return_as_array && !$vb_return_all_locales) {
// return scalar
//
// Handle "hierarchy" modifier on list elements
//
if ($va_hier = $this->_getElementHierarchy($t_instance, $va_path_components)) {
return join($vs_hierarchical_delimiter, $va_hier);
}
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name']) {
$vs_template = null;
if ($va_path_components['subfield_name']) {
$va_values = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $vn_row_id, $pa_options);
$va_value_list = array();
foreach ($va_values as $vn_id => $va_attr_val_list) {
foreach ($va_attr_val_list as $vn_value_id => $va_value_array) {
$va_value_list[] = $va_value_array[$va_path_components['subfield_name']];
}
}
return join(" ", $va_value_list);
} else {
if (isset($pa_options['template'])) {
$vs_template = $pa_options['template'];
}
}
unset($pa_options['template']);
if (!$vs_template) {
$vs_template = "^" . $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : $va_path_components['field_name'];
}
return $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge(array('row_id' => $vn_row_id), $pa_options));
}
if ($t_element && !$va_path_components['subfield_name'] && $t_element->get('datatype') == 0) {
return $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge($pa_options, array('row_id' => $vn_row_id)));
} else {
if (!$vs_template) {
return $t_instance->getRawValue($vn_row_id, $va_path_components['field_name'], $va_path_components['subfield_name'], ',', $pa_options);
} else {
return caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($vn_row_id), array());
}
}
} else {
// return array
//
// Handle "hierarchy" modifier on list elements
//
if ($va_hier = $this->_getElementHierarchy($t_instance, $va_path_components)) {
return $va_hier;
}
$va_values = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $vn_row_id, $pa_options);
if ($vs_template && !$vb_return_all_locales) {
$va_values_tmp = array();
foreach ($va_values as $vn_i => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_values_tmp[] = caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
}
$va_values = $va_values_tmp;
} else {
if ($va_path_components['subfield_name']) {
if ($vb_return_all_locales) {
foreach ($va_values as $vn_row_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_values[$vn_row_id][$vn_locale_id][$vn_attr_id] = $va_attr_data[$va_path_components['subfield_name']];
}
}
}
} else {
$va_processed_value_list = array();
foreach ($va_values as $vn_row_id => $va_value_list) {
foreach ($va_value_list as $vn_attr_id => $va_attr_data) {
$va_processed_value_list[$vn_attr_id] = $va_attr_data[$va_path_components['subfield_name']];
}
}
$va_values = $va_processed_value_list;
}
} else {
if (!$vb_return_all_locales) {
$va_values = array_shift($va_values);
}
}
}
return $va_values;
}
} else {
// Prefetch intrinsic fields in primary and related tables
if (!isset($this->opa_prefetch_cache[$va_path_components['table_name']][$vn_row_id])) {
$this->prefetch($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
// try to prefetch ahead (usually doesn't hurt and very often helps performance)
}
}
$va_return_values = array();
if ($va_path_components['table_name'] !== $this->ops_table_name && $va_path_components['field_name'] !== 'relationship_typename' && !$t_instance->hasField($va_path_components['field_name']) && method_exists($t_instance, 'getAttributes')) {
//
// Return metadata attributes in a related table
//
$vs_pk = $t_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
$vs_opt_md5 = caMakeCacheKeyFromOptions($pa_options);
if (!isset($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
$this->prefetchRelated($va_path_components['table_name'], $this->opo_engine_result->currentRow(), $this->getOption('prefetch'), $pa_options);
}
if (is_array($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5])) {
foreach ($this->opa_rel_prefetch_cache[$va_path_components['table_name']][$vn_row_id][$vs_opt_md5] as $vn_i => $va_values) {
//$vn_locale_id => $va_values_by_locale) {
$va_ids[] = $va_values[$vs_pk];
if (!$vb_return_as_array) {
$vs_val = $t_instance->getAttributesForDisplay($va_path_components['field_name'], $vs_template, array_merge(array('row_id' => $va_values[$vs_pk]), $pa_options));
} else {
$vs_val = $t_instance->getAttributeDisplayValues($va_path_components['field_name'], $va_values[$vs_pk], $pa_options);
}
if ($vs_val) {
if ($vb_return_as_array) {
if (!$vb_return_all_locales) {
foreach ($vs_val as $vn_i => $va_values_list) {
foreach ($va_values_list as $vn_j => $va_values) {
$va_return_values[] = $va_values;
}
}
} else {
foreach ($vs_val as $vn_i => $va_values_list) {
$va_return_values[] = $va_values_list;
}
}
} else {
$va_return_values[] = $vs_val;
}
}
}
}
if ($vb_return_as_array || $vb_return_all_locales) {
// return array
if ($vb_return_as_link && $vb_is_related) {
$vs_table_name = $t_instance->tableName();
$vs_fld_key = $va_path_components['subfield_name'] ? $va_path_components['subfield_name'] : $va_path_components['field_name'];
if (!$vb_return_all_locales) {
$va_return_values_tmp = array();
foreach ($va_return_values as $vn_i => $va_value) {
if ($vs_template) {
$vs_value = caProcessTemplateForIDs($vs_template, $va_path_components['table_name'], array($va_ids[$vn_i][$vs_pk]), array('returnAsArray' => false));
} else {
$vs_value = $va_value[$vs_fld_key];
}
if ($vb_return_as_link) {
$va_return_values_tmp[$vn_i] = array_pop(caCreateLinksFromText(array($vs_value), $va_original_path_components['table_name'], array($va_ids[$vn_i]), $vs_return_as_link_class, $vs_return_as_link_target));
} else {
$va_return_values_tmp[$vn_i] = $vs_value;
}
}
$va_return_values = $va_return_values_tmp;
}
}
return $va_return_values;
} else {
// return scalar
if ($vb_return_as_link && $vb_is_related) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
if (isset($pa_options['convertLineBreaks']) && $pa_options['convertLineBreaks']) {
return caConvertLineBreaks(join($vs_delimiter, $va_return_values));
} else {
return join($vs_delimiter, $va_return_values);
}
}
} else {
if ($vs_template) {
return caProcessTemplateForIDs($vs_template, $this->opo_subject_instance->tableName(), array($vn_row_id), array_merge($pa_options, array('placeholderPrefix' => $va_path_components['field_name'])));
}
//
// Return fields (intrinsics, labels) in primary or related table
//
$t_list = $this->opo_datamodel->getInstanceByTableName('ca_lists', true);
$va_value_list = array($vn_row_id => $this->opa_prefetch_cache[$va_path_components['table_name']][$vn_row_id]);
// Restrict to relationship types (related)
if (isset($pa_options['restrict_to_relationship_types']) && $pa_options['restrict_to_relationship_types']) {
if (!is_array($pa_options['restrict_to_relationship_types'])) {
$pa_options['restrict_to_relationship_types'] = array($pa_options['restrict_to_relationship_types']);
}
if (sizeof($pa_options['restrict_to_relationship_types'])) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
$va_rel_types = array();
$va_rel_path = array_keys($this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']));
foreach ($pa_options['restrict_to_relationship_types'] as $vm_type) {
if (!$vm_type) {
continue;
}
if ($vn_type_id = $t_rel_type->getRelationshipTypeID($va_rel_path[1], $vm_type)) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel_type->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value['rel_type_id'] || in_array($va_value['rel_type_id'], $va_rel_types)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
}
// Exclude relationship types (related)
if (isset($pa_options['exclude_relationship_types']) && $pa_options['exclude_relationship_types']) {
if (!is_array($pa_options['exclude_relationship_types'])) {
$pa_options['exclude_relationship_types'] = array($pa_options['exclude_relationship_types']);
}
if (sizeof($pa_options['exclude_relationship_types'])) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
$va_rel_types = array();
$va_rel_path = array_keys($this->opo_datamodel->getPath($this->ops_table_name, $va_path_components['table_name']));
foreach ($pa_options['exclude_relationship_types'] as $vm_type) {
if ($vn_type_id = $t_rel_type->getRelationshipTypeID($va_rel_path[1], $vm_type)) {
$va_rel_types[] = $vn_type_id;
if (is_array($va_children = $t_rel_type->getHierarchyChildren($vn_type_id, array('idsOnly' => true)))) {
$va_rel_types = array_merge($va_rel_types, $va_children);
}
}
}
if (sizeof($va_rel_types)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!in_array($va_value['rel_type_id'], $va_rel_types)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
}
// Restrict to types (related)
$va_type_ids = $vs_type_fld = null;
if (method_exists($t_instance, "getTypeFieldName")) {
$va_type_ids = caMergeTypeRestrictionLists($t_instance, $pa_options);
$vs_type_fld = $t_instance->getTypeFieldName();
} else {
if (method_exists($t_instance, "getSubjectTableInstance")) {
$t_label_subj_instance = $t_instance->getSubjectTableInstance();
if (method_exists($t_label_subj_instance, "getTypeFieldName")) {
$va_type_ids = caMergeTypeRestrictionLists($t_label_subj_instance, $pa_options);
$vs_type_fld = 'item_type_id';
}
}
}
if (is_array($va_type_ids) && sizeof($va_type_ids)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'] || in_array($va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'], $va_type_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
// Restrict to sources (related)
$va_source_ids = $vs_source_id_fld = null;
if (method_exists($t_instance, "getSourceFieldName")) {
$va_source_ids = caMergeSourceRestrictionLists($t_instance, $pa_options);
$vs_source_id_fld = $t_instance->getSourceFieldName();
} else {
if (method_exists($t_instance, "getSubjectTableInstance")) {
$t_label_subj_instance = $t_instance->getSubjectTableInstance();
if (method_exists($t_label_subj_instance, "getSourceFieldName")) {
$va_source_ids = caMergeSourceRestrictionLists($t_label_subj_instance, $pa_options);
$vs_source_id_fld = 'item_source_id';
}
}
}
if (is_array($va_source_ids) && sizeof($va_source_ids)) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!$va_value[$vs_source_id_fld ? $vs_source_id_fld : 'item_source_id'] || in_array($va_value[$vs_source_id_fld ? $vs_source_id_fld : 'item_source_id'], $va_source_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
// Exclude types (related)
if (isset($pa_options['exclude_type']) && $pa_options['exclude_type']) {
if (!isset($pa_options['exclude_types']) || !is_array($pa_options['exclude_types'])) {
$pa_options['exclude_types'] = array();
}
$pa_options['exclude_types'][] = $pa_options['exclude_type'];
}
if (isset($pa_options['exclude_types']) && is_array($pa_options['exclude_types'])) {
$va_ids = caMakeTypeIDList($va_path_components['table_name'], $pa_options['exclude_types']);
if (is_array($va_ids) && sizeof($va_ids) > 0) {
$va_tmp = array();
foreach ($va_value_list as $vn_id => $va_by_locale) {
foreach ($va_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if (!in_array($va_value[$vs_type_fld ? $vs_type_fld : 'item_type_id'], $va_type_ids)) {
$va_tmp[$vn_id][$vn_locale_id][$vn_i] = $va_value;
}
}
}
}
$va_value_list = $va_tmp;
}
}
// Handle 'relationship_typename' (related)
$vb_get_relationship_typename = false;
if ($va_path_components['field_name'] == 'relationship_typename') {
$va_path_components['field_name'] = 'rel_type_id';
$vb_get_relationship_typename = true;
}
if ($vb_return_as_array) {
// return array (intrinsics or labels in primary or related table)
if ($t_instance->hasField($va_path_components['field_name']) && $va_path_components['table_name'] === $t_instance->tableName()) {
// Intrinsic
$va_field_info = $t_instance->getFieldInfo($va_path_components['field_name']);
$vs_pk = $t_original_instance->primaryKey();
// Handle specific intrinsic types
switch ($va_field_info['FIELD_TYPE']) {
case FT_DATERANGE:
case FT_HISTORIC_DATERANGE:
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $va_value[$vs_pk];
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (caGetOption('sortable', $pa_options, false)) {
$vs_prop = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$vs_prop = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
if ($va_field_info['FIELD_TYPE'] == FT_DATERANGE) {
$this->opo_tep->setUnixTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
} else {
$this->opo_tep->setHistoricTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
}
$vs_prop = $this->opo_tep->getText($pa_options);
}
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
}
}
}
break;
case FT_MEDIA:
if (!($vs_version = $va_path_components['subfield_name'])) {
$vs_version = "largeicon";
}
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $va_value[$vs_pk];
if (isset($pa_options['unserialize']) && $pa_options['unserialize']) {
$vs_prop = caUnserializeForDatabase($va_value[$va_path_components['field_name']]);
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
} else {
$o_media_settings = new MediaProcessingSettings($va_path_components['table_name'], $va_path_components['field_name']);
$va_versions = $o_media_settings->getMediaTypeVersions('*');
if (!isset($va_versions[$vs_version])) {
$va_tmp = array_keys($va_versions);
$vs_version = array_shift($va_tmp);
}
// See if an info element was passed, eg. ca_object_representations.media.icon.width should return the width of the media rather than a tag or url to the media
$vs_info_element = $va_path_components['num_components'] == 4 ? $va_path_components['components'][3] : null;
if ($vb_return_all_locales) {
if ($vs_info_element) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_return_values[$vn_row_id][$vn_locale_id][] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
} else {
if ($vs_info_element) {
$va_return_values[] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_return_values[] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_return_values[] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
}
}
}
}
}
break;
default:
// is intrinsic field in primary table
$vb_supports_preferred = (bool) $t_instance->hasField('is_preferred');
foreach ($va_value_list as $vn_id => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$va_ids[] = $vn_id = $va_value[$vs_pk];
if ($vb_get_preferred_labels_only && $vb_supports_preferred && !$va_value['is_preferred']) {
continue;
}
if ($vb_get_nonpreferred_labels_only && $vb_supports_preferred && $va_value['is_preferred']) {
continue;
}
$vs_prop = $va_value[$va_path_components['field_name']];
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$vs_prop = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$vs_prop = $vs_option;
break;
}
}
}
}
}
}
if ($vb_return_all_locales) {
$va_return_values[$vn_id][$vn_locale_id][] = $vs_prop;
} else {
$va_return_values[$vn_id][$vn_locale_id] = $vs_prop;
}
}
}
}
if (!$vb_return_all_locales) {
$va_return_values = array_values(caExtractValuesByUserLocale($va_return_values));
}
break;
}
} else {
// Attributes
$vs_pk = $t_original_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
$t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true);
foreach ($va_value_list as $vn_i => $va_values_by_locale) {
foreach ($va_values_by_locale as $vn_locale_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
if ($vb_is_related) {
$va_ids[] = $va_value[$vs_pk];
}
if ($vb_get_preferred_labels_only && !$va_value['is_preferred']) {
continue;
}
if ($vb_get_nonpreferred_labels_only && $va_value['is_preferred']) {
continue;
}
// do we need to translate foreign key and choice list codes to display text?
$vs_prop = $vb_return_all_label_values && !$vb_return_as_link ? $va_value : $va_value[$va_path_components['field_name']];
if ($vb_get_relationship_typename) {
if (!$t_rel_type) {
$t_rel_type = $this->opo_datamodel->getInstanceByTableName('ca_relationship_types', true);
}
if (is_array($va_labels = $t_rel_type->getDisplayLabels(false, array('row_id' => (int) $vs_prop)))) {
$va_label = array_shift($va_labels);
$vs_prop = $va_label[0]['typename'];
} else {
$vs_prop = "?";
}
} else {
// Decode list items to text
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$vs_prop = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$vs_prop = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$vs_prop = $vs_option;
break;
}
}
}
}
}
}
}
if ($vb_return_all_locales) {
$va_return_values[$vn_row_id][$vn_locale_id][] = $vs_prop;
} else {
if ($vb_get_nonpreferred_labels_only && is_array($vs_prop)) {
// non-preferred labels are lists of lists because they can repeat
$va_return_values[][] = $vs_prop;
} else {
$va_return_values[] = $vs_prop;
}
}
}
}
}
}
if ($vb_return_as_link) {
if (!$vb_return_all_locales) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
}
return $va_return_values;
} else {
// Return scalar (intrinsics or labels in primary or related table)
if ($vb_get_preferred_labels_only || $vb_get_nonpreferred_labels_only) {
// We have to distinguish between preferred and non-preferred labels here
// so that only appropriate labels are passed for output.
$va_filtered_values = array();
foreach ($va_value_list as $vn_label_id => $va_labels_by_locale) {
foreach ($va_labels_by_locale as $vn_locale_id => $va_labels) {
foreach ($va_labels as $vn_i => $va_label) {
if ($vb_get_preferred_labels_only && (!isset($va_label['is_preferred']) || $va_label['is_preferred']) || $vb_get_nonpreferred_labels_only && !$va_label['is_preferred']) {
$va_filtered_values[$vn_label_id][$vn_locale_id][] = $va_label;
}
}
}
}
$va_value_list = $va_filtered_values;
}
$va_value_list = caExtractValuesByUserLocale($va_value_list);
// do we need to translate foreign key and choice list codes to display text?
$t_instance = $this->opo_datamodel->getInstanceByTableName($va_path_components['table_name'], true);
$va_field_info = $t_instance->getFieldInfo($va_path_components['field_name']);
$vs_pk = $t_instance->primaryKey();
$vb_is_related = $this->ops_table_name !== $va_path_components['table_name'];
$va_ids = array();
foreach ($va_value_list as $vn_i => $va_values) {
if (!is_array($va_values)) {
continue;
}
// Handle specific intrinsic types
$vs_template_value = $vs_template;
foreach ($va_values as $vn_j => $va_value) {
switch ($va_field_info['FIELD_TYPE']) {
case FT_BIT:
if ($pa_options['convertCodesToDisplayText']) {
$va_value[$va_path_components['field_name']] = (bool) $vs_prop ? _t('yes') : _t('no');
}
break;
case FT_DATERANGE:
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (isset($pa_options['sortable']) && $pa_options['sortable']) {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
$this->opo_tep->setUnixTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
$va_value[$va_path_components['field_name']] = $this->opo_tep->getText($pa_options);
}
break;
case FT_HISTORIC_DATERANGE:
if (caGetOption('GET_DIRECT_DATE', $pa_options, false) || caGetOption('getDirectDate', $pa_options, false)) {
if (caGetOption('sortable', $pa_options, false)) {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']] . '/' . $va_value[$va_field_info['END']];
} else {
$va_value[$va_path_components['field_name']] = $va_value[$va_field_info['START']];
}
} else {
$this->opo_tep->init();
$this->opo_tep->setHistoricTimestamps($va_value[$va_field_info['START']], $va_value[$va_field_info['END']]);
$va_value[$va_path_components['field_name']] = $this->opo_tep->getText($pa_options);
}
break;
case FT_MEDIA:
if (!($vs_version = $va_path_components['subfield_name'])) {
$vs_version = "largeicon";
}
// See if an info element was passed, eg. ca_object_representations.media.icon.width should return the width of the media rather than a tag or url to the media
$vs_info_element = $va_path_components['num_components'] == 4 ? $va_path_components['components'][3] : null;
if (isset($pa_options['unserialize']) && $pa_options['unserialize']) {
return caUnserializeForDatabase($va_value[$va_path_components['field_name']]);
} else {
$o_media_settings = new MediaProcessingSettings($va_path_components['table_name'], $va_path_components['field_name']);
$va_versions = $o_media_settings->getMediaTypeVersions('*');
if (!isset($va_versions[$vs_version])) {
$va_tmp = array_keys($va_versions);
$vs_version = array_shift($va_tmp);
}
if ($vs_info_element) {
// Return media info
$va_value[$va_path_components['field_name']] = $this->getMediaInfo($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $vs_info_element, $pa_options);
} elseif (isset($pa_options['returnURL']) && $pa_options['returnURL']) {
$va_value[$va_path_components['field_name']] = $this->getMediaUrl($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
} else {
$va_value[$va_path_components['field_name']] = $this->getMediaTag($va_path_components['table_name'] . '.' . $va_path_components['field_name'], $vs_version, $pa_options);
}
}
break;
default:
// noop
break;
}
$vs_prop = $va_value[$va_path_components['field_name']];
// Decode list items to text
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST_CODE"))) {
$va_value[$va_path_components['field_name']] = $t_list->getItemFromListForDisplayByItemID($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && ($vs_list_code = $t_instance->getFieldInfo($va_path_components['field_name'], "LIST"))) {
$va_value[$va_path_components['field_name']] = $t_list->getItemFromListForDisplayByItemValue($vs_list_code, $vs_prop);
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && $va_path_components['field_name'] === 'locale_id' && (int) $vs_prop > 0) {
$t_locale = new ca_locales($vs_prop);
$va_value[$va_path_components['field_name']] = $t_locale->getName();
} else {
if (isset($pa_options['convertCodesToDisplayText']) && $pa_options['convertCodesToDisplayText'] && is_array($va_list = $t_instance->getFieldInfo($va_path_components['field_name'], "BOUNDS_CHOICE_LIST"))) {
foreach ($va_list as $vs_option => $vs_value) {
if ($vs_value == $vs_prop) {
$va_value[$va_path_components['field_name']] = $vs_option;
break;
}
}
}
}
}
}
$vs_pk = $this->opo_datamodel->getTablePrimaryKeyName($va_original_path_components['table_name']);
if ($vs_template) {
foreach ($va_value_list as $vn_id => $va_values) {
foreach ($va_values as $vn_i => $va_value) {
$vs_prop = caProcessTemplateForIDs($vs_template, $va_original_path_components['table_name'], array($va_value[$vs_pk]), array('returnAsArray' => false));
$va_return_values[] = $vs_prop;
$va_ids[] = $va_value[$vs_pk];
}
}
} else {
$vs_prop = $va_value[$va_path_components['field_name']];
$va_return_values[] = $vs_prop;
if ($vb_is_related) {
$va_ids[] = $va_value[$vs_pk];
}
}
}
}
if ($vb_return_as_link && $vb_is_related) {
$va_return_values = caCreateLinksFromText($va_return_values, $va_original_path_components['table_name'], $va_ids, $vs_return_as_link_class, $vs_return_as_link_target);
}
if (isset($pa_options['convertLineBreaks']) && $pa_options['convertLineBreaks']) {
return caConvertLineBreaks(join($vs_delimiter, $va_return_values));
} else {
return join($vs_delimiter, $va_return_values);
}
}
}
return null;
}
/**
* Get list of mimetypes for which replication options are configured
*
* @return array
*/
public static function getMediaReplicationMimeTypes()
{
$o_media_volumes = new MediaVolumes();
$o_media_processing = new MediaProcessingSettings('ca_object_representations', 'media');
$va_volumes = $o_media_volumes->getAllVolumeInformation();
$va_mimetypes = array();
foreach ($va_volumes as $vs_volume => $va_volume_info) {
if (isset($va_volume_info['replication']) && is_array($va_volume_info['replication'])) {
foreach ($va_volume_info['replication'] as $vs_target => $va_target_info) {
if (isset($va_target_info['mimetypes']) && is_array($va_target_info['mimetypes'])) {
$va_mimetype_list = $va_target_info['mimetypes'];
} else {
// get mimetypes for volume from media_processing
$va_mimetype_list = $o_media_processing->getMimetypesForVolume($vs_volume);
}
foreach ($va_mimetype_list as $vs_mimetype) {
$va_mimetypes[$vs_mimetype] = true;
}
}
}
}
return array_keys($va_mimetypes);
}