@ -2,8 +2,11 @@
namespace Drupal\islandora_fits\Services; namespace Drupal\islandora_fits\Services;
U se Drupal\Component\Utility\Xss;u se Drupal\Component\Utility\Xss;
use Drupal\Core\DependencyInjection\ServiceProviderBase; use Drupal\Core\DependencyInjection\ServiceProviderBase;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\field\Entity\FieldStorageConfig; use Drupal\field\Entity\FieldStorageConfig;
use Drupal\field\Entity\FieldConfig; use Drupal\field\Entity\FieldConfig;
@ -11,345 +14,404 @@ use Drupal\field\Entity\FieldConfig;
* Class XMLTransform. * Class XMLTransform.
*/ */
class XMLTransform extends ServiceProviderBase { class XMLTransform extends ServiceProviderBase {
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
private $renderer;
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
private $entityManager;
/**
* List of characters to switch.
*
* @var array
*/
private $forbidden;
/**
* The messenger.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
private $messenger;
private $renderer; /**
private $entityManager; * XMLTransform constructor.
private $forbidden; *
private $messenger; * @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
* @param \Drupal\Core\Entity\EntityManagerInterface $entityManager
* The entity manager.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger.
*/
public function __construct(RendererInterface $renderer, EntityManagerInterface $entityManager, MessengerInterface $messenger) {
$this->renderer = $renderer;
$this->entityManager = $entityManager;
$this->messenger = $messenger;
$this->forbidden = ['-', ' '];
}
/** /**
* Constructs a new XMLTransform object. * Transforms FITS xml into renderable array.
*/ *
public function __construct($renderer, $entityManager, $messenger) { * @param string $input_xml
$this->renderer = $renderer; * Xml to be transformed.
$this->entityManager = $entityManager; *
$this->messenger = $messenger; * @return array|null
$this->forbidden = ['-', ' ']; * Array of parsed results.
*/
public function transformFits($input_xml) {
$utf8 = mb_detect_encoding($input_xml, 'UTF-8', TRUE);
if (!$utf8) {
$input_xml = utf8_encode($input_xml);
} }
try {
/** $xml = new \SimpleXMLElement($input_xml);
* Transforms FITS xml into renderable array. }
* catch (\Exception $e) {
* @param $input_xml $this->messenger->addWarning(t('File does not contain valid xml.'));
* @return array return;
*/ }
public function transformFits($input_xml) { $xml->registerXPathNamespace('fits', 'http://hul.harvard.edu/ois/xml/ns/fits/fits_output');
$utf8 = mb_detect_encoding($input_xml, 'UTF-8', true); $fits_metadata = $this->islandoraFitsChildXpath($xml);
if (!$utf8) { $headers = [
$input_xml = utf8_encode($input_xml); 'label' => t('Field'),
} 'value' => t('Value'),
try { ];
$xml = new \SimpleXMLElement($input_xml); if (count($fits_metadata) == 0) {
} catch (\Exception $e) { $variables['islandora_fits_table']['empty'] = '';
$this->messenger->addWarning(t('File does not contain valid xml.')); $variables['islandora_fits_fieldsets']['empty'] = [
return; '#type' => 'markup',
} '#markup' => t('No technical metadata found.'),
$xml->registerXPathNamespace('fits', 'http://hul.harvard.edu/ois/xml/ns/fits/fits_output'); ];
$fits_metadata = $this->islandora_fits_child_xpath($xml); }
$headers = array( else {
'label' => t('Field'), foreach ($fits_metadata as $tool_name => $vals_array) {
'value' => t('Value'), $variables['islandora_fits_data'][$tool_name] = [];
); $rows = &$variables['islandora_fits_data'][$tool_name];
if (count($fits_metadata) == 0) { foreach ($vals_array as $field => $val_array) {
$variables['islandora_fits_table']['empty'] = ''; if (!array_key_exists($field, $rows) & & $field != 'Filepath') {
$variables['islandora_fits_fieldsets']['empty'] = array( $rows[$field] = [
'#type' => 'markup', ['data' => Xss::filter($field), 'class' => 'islandora_fits_table_labels'],
'#markup' => t('No technical metadata found.'),
);
} else {
foreach ($fits_metadata as $tool_name => $vals_array) {
$variables['islandora_fits_data'][$tool_name] = array();
$rows = &$variables['islandora_fits_data'][$tool_name];
foreach ($vals_array as $field => $val_array) {
if (!array_key_exists($field, $rows) & & $field != 'Filepath') {
$rows[$field] = array(
array('data' => Xss::filter($field), 'class' => 'islandora_fits_table_labels'),
);
foreach ($val_array as $value) {
if (!isset($rows[$field]['value'])) {
$rows[$field]['value'] = array('data' => Xss::filter($value), 'class' => 'islandora_fits_table_values');
} else {
$data = $rows[$field]['value']['data'] .= ' - ' . Xss::filter($value);
$rows[$field]['value'] = array('data' => $data, 'class' => 'islandora_fits_table_values');
}
}
}
$table_attributes = array('class' => array('islandora_fits_table'));
$table = array(
'header' => $headers,
'rows' => $rows,
'attributes' => $table_attributes,
);
$variables['islandora_fits_table'][$tool_name] = $table;
$variables['islandora_fits_fieldsets'][$tool_name] = [
'#theme' => 'table',
'#header' => $headers,
'#rows' => $rows,
'#attributes' => $table_attributes,
'#header_columns' => 4,
];
}
}
}
$fieldsets = $variables['islandora_fits_fieldsets'];
$output = [];
foreach ($fieldsets as $title => $fieldset) {
$output[] = [
'title' => $title,
'data' => $fieldset,
]; ];
foreach ($val_array as $value) {
if (!isset($rows[$field]['value'])) {
$rows[$field]['value'] = ['data' => Xss::filter($value), 'class' => 'islandora_fits_table_values'];
}
else {
$data = $rows[$field]['value']['data'] .= ' - ' . Xss::filter($value);
$rows[$field]['value'] = ['data' => $data, 'class' => 'islandora_fits_table_values'];
}
}
}
$table_attributes = ['class' => ['islandora_fits_table']];
$table = [
'header' => $headers,
'rows' => $rows,
'attributes' => $table_attributes,
];
$variables['islandora_fits_table'][$tool_name] = $table;
$variables['islandora_fits_fieldsets'][$tool_name] = [
'#theme' => 'table',
'#header' => $headers,
'#rows' => $rows,
'#attributes' => $table_attributes,
'#header_columns' => 4,
];
} }
$renderable = [ }
'#theme' => 'fits', }
'#output' => $output, $fieldsets = $variables['islandora_fits_fieldsets'];
'#attached' => [ $output = [];
'library' => [ foreach ($fieldsets as $title => $fieldset) {
'islandora_fits/islandora_fits', $output[] = [
] 'title' => $title,
] 'data' => $fieldset,
]; ];
return $renderable;
} }
$renderable = [
'#theme' => 'fits',
'#output' => $output,
'#attached' => [
'library' => [
'islandora_fits/islandora_fits',
],
],
];
return $renderable;
}
/** /**
* Finds the the first set of children from the FITS xml. * Finds the the first set of children from the FITS xml.
* *
* Once it has these it passes them off recursively. * Once it has these it passes them off recursively.
* *
* @param SimpleXMLElement $xml * @param SimpleXMLElement $xml
* The SimpleXMLElement to parse. * The SimpleXMLElement to parse.
* *
* @return array * @return array
* An array containing key/value pairs of fields and data. * An array containing key/value pairs of fields and data.
*/ */
private function islandora_fits_child_xpath($xml) { private function islandoraFitsChildXpath(SimpleXMLElement $xml) {
$results = $xml->xpath('/*|/*/fits:metadata'); $results = $xml->xpath('/*|/*/fits:metadata');
$output = array(); $output = [];
foreach ($results as $result) { foreach ($results as $result) {
$this->islandora_fits_children($result, $output); $this->islandoraFitsChildren($result, $output);
}
return $output;
} }
return $output;
}
/** /**
* Finds children for fits module. * Finds children for fits module.
* *
* Recursive function that searches continuously until * Recursive function that searches continuously until
* we grab the node's text value and add to * we grab the node's text value and add to
* the output array. * the output array.
* *
* @param SimpleXMLElement $child * @param SimpleXMLElement $child
* The current child that we are searching through. * The current child that we are searching through.
* * @param array $output
* @param array $output * An array containing key/value pairs of fields and data.
* An array containing key/value pairs of fields and data. */
*/ private function islandoraFitsChildren(SimpleXMLElement $child, array & $output) {
private function islandora_fits_children($child, & $output) { $grandchildren = $child->xpath('*/*');
$grandchildren = $child->xpath('*/*');
if (count($grandchildren) > 0) { if (count($grandchildren) > 0) {
foreach ($grandchildren as $grandchild) { foreach ($grandchildren as $grandchild) {
$this->islandora_fits_children($grandchild, $output); $this->islandoraFitsChildren($grandchild, $output);
}
}
else {
$text_results = $child->xpath('text()');
$tool_name = FALSE;
if ($text_results) {
foreach ($text_results as $text) {
foreach ($text->attributes() as $key => $value) {
if ($key === 'toolname') {
$tool_name = trim((string) $value);
}
}
$output_text = trim((string) $text);
if (!empty($output_text)) {
$fits_out = $this->islandoraFitsContructOutput($child->getName(), $tool_name);
$tool_label = $fits_out['tool'];
$field_label = $fits_out['name'];
// Need to check if the label already exists in our output
// such that we do not duplicate entries.
if ($tool_label) {
if (isset($output[$tool_label])) {
if (!array_key_exists($field_label, $output[$tool_label])) {
$output[$tool_label][$field_label][] = $output_text;
}
else {
if (!in_array($output_text, $output[$tool_label][$field_label])) {
$output[$tool_label][$field_label][] = $output_text;
}
}
}
else {
$output[$tool_label][$field_label][] = $output_text;
}
} }
} else { // No tool attribute.
$text_results = $child->xpath('text()'); else {
$tool_name = FALSE; if (isset($output['Unknown'][$field_label])) {
if ($text_results) { if (!in_array($output_text, $output['Unknown'][$field_label])) {
foreach ($text_results as $text) { $output['Unknown'][$field_label][] = $output_text;
foreach ($text->attributes() as $key => $value) {
if ($key === 'toolname') {
$tool_name = trim((string)$value);
}
}
$output_text = trim((string)$text);
if (!empty($output_text)) {
$fits_out = $this->islandora_fits_construct_output($child->getName(), $tool_name);
$tool_label = $fits_out['tool'];
$field_label = $fits_out['name'];
// Need to check if the label already exists in our output
// such that we do not duplicate entries.
if ($tool_label) {
if (isset($output[$tool_label])) {
if (!array_key_exists($field_label, $output[$tool_label])) {
$output[$tool_label][$field_label][] = $output_text;
} else {
if (!in_array($output_text, $output[$tool_label][$field_label])) {
$output[$tool_label][$field_label][] = $output_text;
}
}
} else {
$output[$tool_label][$field_label][] = $output_text;
}
} // No tool attribute.
else {
if (isset($output['Unknown'][$field_label])) {
if (!in_array($output_text, $output['Unknown'][$field_label])) {
$output['Unknown'][$field_label][] = $output_text;
}
} else {
$output['Unknown'][$field_label][] = $output_text;
}
}
}
} }
}
else {
$output['Unknown'][$field_label][] = $output_text;
}
} }
}
} }
}
} }
}
/** /**
* Builds display by parsing strings. * Builds display by parsing strings.
* *
* @param string $node_name * @param string $node_name
* Name of the current node that we will display. * Name of the current node that we will display.
* @param string $tool_name * @param string $tool_name
* Name of the tool used to generate the metadata. * Name of the tool used to generate the metadata.
* *
* @return array * @return array
* Constructed node name for output. * Constructed node name for output.
*/ */
private function islandora_fits_construct_output($node_name, $tool_name) { private function islandoraFitsContructOutput(string $node_name, string $tool_name) {
// Construct an arbitrary string with all capitals in it. // Construct an arbitrary string with all capitals in it.
$capitals = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'; $capitals = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
$name_array = str_split($node_name); $name_array = str_split($node_name);
$space_position = array() ; $space_position = [];
// Check to see which characters are capitals so we can split // Check to see which characters are capitals so we can split
// them up for cleaner display. // them up for cleaner display.
foreach ($name_array as $key => $value) { foreach ($name_array as $key => $value) {
if (strpos($capitals, $value) !== FALSE & & $key !== 0) { if (strpos($capitals, $value) !== FALSE & & $key !== 0) {
$space_position[] = $key; $space_position[] = $key;
} }
}
if (count($space_position)) {
// Needed in event we add multiple spaces so need to keep track.
$pos_offset = 0;
foreach ($space_position as $pos) {
$node_name = substr_replace($node_name, ' ', $pos + $pos_offset, 0);
$pos_offset++;
}
}
$node_name = ucwords($node_name);
return array('name' => $node_name, 'tool' => ucwords($tool_name));
} }
if (count($space_position)) {
/** // Needed in event we add multiple spaces so need to keep track.
* Adds fields to content type. $pos_offset = 0;
* foreach ($space_position as $pos) {
* @param $input_xml $node_name = substr_replace($node_name, ' ', $pos + $pos_offset, 0);
* @throws \Drupal\Core\Entity\EntityStorageException $pos_offset++;
*/ }
public function add_media_fields($input_xml) {
$fields_added = FALSE;
$data = $this->transformFits($input_xml);
$all_fields = [];
foreach ($data['#output'] as $datum) {
$all_fields = array_merge($all_fields, $this->harvest_values($datum));
}
$to_process = $this->normalize_names($all_fields);
foreach ($to_process as $field) {
$exists = FieldStorageConfig::loadByName('media', $field['field_name']);
if (!$exists) {
$field_storage = FieldStorageConfig::create([
'entity_type' => 'media',
'field_name' => $field['field_name'],
'type' => 'text',
]);
$field_storage->save();
}
$bundle_fields = $this->entityManager->getFieldDefinitions('media', 'fits_technical_metadata');
$bundle_keys = array_keys($bundle_fields);
if (!in_array($field['field_name'], $bundle_keys)) {
$field_storage = FieldStorageConfig::loadByName('media', $field['field_name']);
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'fits_technical_metadata',
'label' => $field['field_label'],
])->save();
$fields_added = TRUE;
}
}
return $fields_added;
} }
$node_name = ucwords($node_name);
/** return ['name' => $node_name, 'tool' => ucwords($tool_name)];
* Populates media. }
*
* @param $input_xml /**
* @param $media * Adds fields to content type.
*/ *
public function populate_media($input_xml, & $media) { * @param string $input_xml
$data = $this->transformFits($input_xml); * Input to be transformed.
$all_fields = []; *
foreach ($data['#output'] as $datum) { * @throws \Drupal\Core\Entity\EntityStorageException
$all_fields = array_merge($all_fields, $this->harvest_values($datum)); *
} * @return bool
$to_add = []; * Fields to be formatted.
foreach ($all_fields as $label => $field_value) { */
$lower = strtolower($label); public function addMediaFields(string $input_xml) {
$normalized = str_replace($this->forbidden, '_', $lower); $fields_added = FALSE;
$field_name = substr("fits_$normalized", 0, 32); $data = $this->transformFits($input_xml);
$to_add[$field_name] = $field_value; $all_fields = [];
} foreach ($data['#output'] as $datum) {
foreach ($to_add as $field_name => $field_value) { $all_fields = array_merge($all_fields, $this->harvestValues($datum));
$media->set($field_name, $field_value); }
} $to_process = $this->normalizeNames($all_fields);
foreach ($to_process as $field) {
$exists = FieldStorageConfig::loadByName('media', $field['field_name']);
if (!$exists) {
$field_storage = FieldStorageConfig::create([
'entity_type' => 'media',
'field_name' => $field['field_name'],
'type' => 'text',
]);
$field_storage->save();
}
$bundle_fields = $this->entityManager->getFieldDefinitions('media', 'fits_technical_metadata');
$bundle_keys = array_keys($bundle_fields);
if (!in_array($field['field_name'], $bundle_keys)) {
$field_storage = FieldStorageConfig::loadByName('media', $field['field_name']);
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'fits_technical_metadata',
'label' => $field['field_label'],
])->save();
$fields_added = TRUE;
}
} }
return $fields_added;
}
/** /**
* Extracts and labels content. * Populates media.
* *
* @param $input * @param string $input_xml
* @return array * String to be transformed.
*/ * @param \Drupal\media\MediaInterface $media
private function harvest_values($input) { * Media to which transformed xml is to be added.
$fields = []; */
$label = str_replace(' ', '_', $input['title']); public function populateMedia(string $input_xml, MediaInterface & $media) {
$rows = $input['data']['#rows']; $data = $this->transformFits($input_xml);
foreach ($rows as $key => $value) { $all_fields = [];
$fields["{$label}_{$key}"] = $value['value']['data']; foreach ($data['#output'] as $datum) {
} $all_fields = array_merge($all_fields, $this->harvestValues($datum));
return $fields; }
$to_add = [];
foreach ($all_fields as $label => $field_value) {
$lower = strtolower($label);
$normalized = str_replace($this->forbidden, '_', $lower);
$field_name = substr("fits_$normalized", 0, 32);
$to_add[$field_name] = $field_value;
}
foreach ($to_add as $field_name => $field_value) {
$media->set($field_name, $field_value);
}
}
/**
* Extracts and labels content.
*
* @param array $input
* Values to be harvested and prepped.
*
* @return array
* Fields prepped for display.
*/
private function harvestValues(array $input) {
$fields = [];
$label = str_replace(' ', '_', $input['title']);
$rows = $input['data']['#rows'];
foreach ($rows as $key => $value) {
$fields["{$label}_{$key}"] = $value['value']['data'];
} }
return $fields;
/** }
* Create standardized machine name fields.
*
* @param array $names
* @return array
*/
private function normalize_names(array $names) {
$normalized_names = [];
foreach ($names as $label => $field_value) {
$lower = strtolower($label);
$normalized = str_replace($this->forbidden, '_', $lower);
$field_name = substr("fits_$normalized", 0, 32);
$normalized_names[] = [ /**
'field_label' => $label, * Create standardized machine name fields.
'field_name' => $field_name, *
'field_value' => $field_value, * @param array $names
]; * Names to be normalized.
} *
return $normalized_names; * @return array
* Normalized names.
*/
private function normalizeNames(array $names) {
$normalized_names = [];
foreach ($names as $label => $field_value) {
$lower = strtolower($label);
$normalized = str_replace($this->forbidden, '_', $lower);
$field_name = substr("fits_$normalized", 0, 32);
$normalized_names[] = [
'field_label' => $label,
'field_name' => $field_name,
'field_value' => $field_value,
];
} }
return $normalized_names;
}
public function check_new($input_xml) { /**
$fields_added = FALSE; * Checks to see if new fields are required.
$data = $this->transformFits($input_xml); *
$all_fields = []; * @param string $input_xml
foreach ($data['#output'] as $datum) { * Xml to be checked.
$all_fields = array_merge($all_fields, $this->harvest_values($datum)); *
} * @return bool
$to_process = $this->normalize_names($all_fields); * Whether fields havbe been added.
foreach ($to_process as $field) { */
$bundle_fields = $this->entityManager->getFieldDefinitions('media', 'fits_technical_metadata'); public function checkNew(string $input_xml) {
$bundle_keys = array_keys($bundle_fields); $fields_added = FALSE;
if (!in_array($field['field_name'], $bundle_keys)) { $data = $this->transformFits($input_xml);
$fields_added = TRUE; $all_fields = [];
} foreach ($data['#output'] as $datum) {
} $all_fields = array_merge($all_fields, $this->harvestValues($datum));
return $fields_added;
} }
$to_process = $this->normalizeNames($all_fields);
foreach ($to_process as $field) {
$bundle_fields = $this->entityManager->getFieldDefinitions('media', 'fits_technical_metadata');
$bundle_keys = array_keys($bundle_fields);
if (!in_array($field['field_name'], $bundle_keys)) {
$fields_added = TRUE;
}
}
return $fields_added;
}
} }
