@ -5,36 +5,10 @@
* Contains bibcite_footnotes.module. * Contains bibcite_footnotes.module.
*/ */
use Drupal\Core\Field\EntityReferenceFieldItemListInterface;
use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface; use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Url; use Drupal\Core\Url;
use Drupal\Core\Link; use Drupal\Core\Link;
use Drupal\bibcite_footnotes\CitationTools;
use Drupal\bibcite_footnotes\Plugin\Filter\ReferenceFootnotesFilter;
use Drupal\field\Entity\FieldConfig;
/**
* Implements hook_theme().
*/
function bibcite_footnotes_theme() {
return [
'bibcite_footnote_link' => [
'render element' => 'fn',
'template' => 'bibcite-footnote-link',
],
'bibcite_footnote_list' => [
'render element' => 'footnotes',
'path' => \Drupal::service('extension.list.module')->getPath('bibcite_footnotes') . '/templates',
'template' => 'bibcite-footnote-list',
'variables' => [
'notes' => [],
'note_type' => [],
'config' => [],
],
],
];
}
/** /**
* Implements hook_help(). * Implements hook_help().
@ -53,7 +27,7 @@ function bibcite_footnotes_help($route_name, RouteMatchInterface $route_match) {
} }
/** /**
* Implementation of hook_preprocess_bibcite_ footnote_list(). * Implementation of hook_preprocess_footnote_list().
* *
* Gatehrs all notes and prints out Notes and References as separate lists. * Gatehrs all notes and prints out Notes and References as separate lists.
* *
@ -62,25 +36,31 @@ function bibcite_footnotes_help($route_name, RouteMatchInterface $route_match) {
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/ */
function bibcite_footnotes_preprocess_bibcite_ footnote_list(&$variables) { function bibcite_footnotes_preprocess_footnote_list(&$variables) {
$config = $variables['config'] ; $config = \Drupal::config('filter.format.rich_text_references');//filters.filter_reference_footnotes.settings') ;
$footnotes = $variables['notes']; $footnotes = $variables['foot notes'];
$notes = [ $notes = [
'#theme' => 'item_list', '#theme' => 'item_list',
'#list_type' => 'ul', '#list_type' => 'ul',
'#title' => $variables['note_type'] == $config['notes_section_label'] , '#title' => $config->get('filters.filter_reference_footnotes.settings.notes_section_label') ,
'#attributes' => ['class' => 'footnotes'], '#attributes' => ['class' => 'footnotes'],
'#wrapper_attributes' => ['class' => 'container'], '#wrapper_attributes' => ['class' => 'container'],
]; ];
$notes['#attached']['library'][] = 'bibcite_footnotes/reference_footnote'; $references= [
$dont_show_backlink_text = $config['reference_dont_show_backlink_text']; '#theme' => 'item_list',
'#list_type' => 'ul',
'#title' => $config->get('filters.filter_reference_footnotes.settings.references_section_label'),
'#attributes' => ['class' => 'footnotes'],
'#wrapper_attributes' => ['class' => 'container'],
];
$references['#attached']['library'][] = 'bibcite_footnotes/reference_footnote';
$dont_show_backlink_text = $config->get('filters.filter_reference_footnotes.settings.reference_dont_show_backlink_text');
$sort_references_by = $config->get('filters.filter_reference_footnotes.settings.reference_sort_by');
$serializer = \Drupal::service('serializer');
$citation_tools = new CitationTools();
if (empty($footnotes)) {
return;
}
foreach ($footnotes as $fn) { foreach ($footnotes as $fn) {
$item = [ $item = [
'#id' => $fn['fn_id'], '#id' => $fn['fn_id'],
@ -89,14 +69,16 @@ function bibcite_footnotes_preprocess_bibcite_footnote_list(&$variables) {
], ],
]; ];
$build = []; $build = [];
$reference_entity_id = $fn['reference']; preg_match('/\[bibcite_reference:(\d*)\]/', $fn['text'], $matches);
$reference_entity_id = $matches[1];
$footnote_link_text = ($dont_show_backlink_text) ? '^' : $fn['value'];
if (!is_array($fn['ref_id'])) { if (!is_array($fn['ref_id'])) {
// Output normal footnote.
$url = Url::fromUserInput('#' . $fn['ref_id'], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]); $url = Url::fromUserInput('#' . $fn['ref_id'], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]);
$link = Link::fromTextAndUrl(($footnote_link_text), $url)->toRenderable(); $link = Link::fromTextAndUrl(($dont_show_backlink_text && $reference_entity_id ? '^' : $fn['value']), $url)->toRenderable();
$build['footnote-link'] = $link; $build[] = $link;
$override_page_in_citation = $fn['page'] ? $fn['page'] : FALSE;
} }
else { else {
// Output footnote that has more than one reference to it in the body. // Output footnote that has more than one reference to it in the body.
@ -106,7 +88,7 @@ function bibcite_footnotes_preprocess_bibcite_footnote_list(&$variables) {
$i = 0; $i = 0;
$url = Url::fromUserInput('#' . $fn['ref_id'][0], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]); $url = Url::fromUserInput('#' . $fn['ref_id'][0], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]);
$build['footnote-link'] = Link::fromTextAndUrl($footnote_link_text , $url)->toRenderable(); $build[] = Link::fromTextAndUrl($fn['value'] , $url)->toRenderable();
foreach ($fn['ref_id'] as $ref) { foreach ($fn['ref_id'] as $ref) {
$url = Url::fromUserInput( '#' . $ref, ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-multi']]); $url = Url::fromUserInput( '#' . $ref, ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-multi']]);
@ -114,253 +96,76 @@ function bibcite_footnotes_preprocess_bibcite_footnote_list(&$variables) {
$i++; $i++;
} }
$override_page_in_citation = FALSE;
}
if (isset($fn['ibid']) && $fn['ibid']) {
$build['footnote-text'] = [
'#type' => 'markup',
'#markup' => ' <span class="endnote-text"><span class="ibid">'
. t('Ibid') . '.</span>'
. (!empty($fn['page']) ? ', ' . $fn['page'] : '')
. '</span>',
];
}
else if (!empty($fn['text'])) {
$build['footnote-link'] = Link::fromTextAndUrl($footnote_link_text, $url)->toRenderable();
$build['footnote-text'] = [
'#type' => 'markup',
'#markup' => ' <span class="endnote-text">' . $fn['text'] . '</span>',
];
} }
if (!empty($reference_entity_id)) { if (!empty($reference_entity_id)) {
if (empty($fn['ibid'])) { $reference_storage = \Drupal::entityTypeManager()
$citation_build = $citation_tools->getRenderableReference($reference_entity_id); ->getStorage('bibcite_reference')
if ($override_page_in_citation) { ->load($reference_entity_id);
$citation_build['#data']['page'] = $override_page_in_citation; $data = $serializer->normalize($reference_storage, 'csl');
} $citation_build = ['#theme' => 'bibcite_citation', '#data' => $data];
$build[] = $citation_build;
$build[] = $citation_build; $render = render($build);
} $item['#markup'] = $render;
$item['sort'] = trim(strip_tags(render($citation_build)));
$references['#items'][] = $item;
//$render = render($build);
$citation_build_render = \Drupal::service('renderer')->render($citation_build);
$item['sort'] = trim(strip_tags($citation_build_render));
} }
else {
$build[] = ['#type' => 'markup', '#markup' => ' ' . $fn['text']];
$render = render($build);
$item['#markup'] = $render;
// $item['#markup'] = $render; $notes['#items'][] = $item;
$notes['#items'][] = $build; }
$reference_entity_id = FALSE;
$render = FALSE;
} }
$variables['notes'] = $notes; $variables['notes'] = $notes;
if ($sort_references_by == 'alphabetical') {
usort($references['#items'], '_bibcite_footnotes_reference_array_cmp');
}
$variables['references'] = $references;
} }
/**
* Comparator function for sorting lists of references.
*
* @param $a First item to compare
* @param $b Second item to compare
* @return int Result of the comparison.
*/
function _bibcite_footnotes_reference_array_cmp($a, $b) { function _bibcite_footnotes_reference_array_cmp($a, $b) {
$a1 = (!empty($a['sort']) ? strtolower($a['sort']) : ''); $a1 = (!empty($a['sort']) ? strtolower($a['sort']) : '');
$b1 = (!empty($b['sort']) ? strtolower($b['sort']) : ''); $b1 = (!empty($b['sort']) ? strtolower($b['sort']) : '');
return strcmp($a1, $b1); return strcmp($a1, $b1);
} }
/** function bibcite_footnotes_preprocess_footnote_link(&$variables) {
* Implementation of hook_preprocess_bibcite_footnote_link().
*
* Construct a link inside a block of text so that it points to the reference list.
*
* @param $variables
*/
function bibcite_footnotes_preprocess_bibcite_footnote_link(&$variables) {
// $variables['fn']['fn']['#type'] = 'markeup'; // $variables['fn']['fn']['#type'] = 'markeup';
// $variables['fn']['fn']['#markup'] = '<h2>Hello!</h2>'; // $variables['fn']['fn']['#markup'] = '<h2>Hello!</h2>';
$fn = $variables['fn']['fn']; $fn = $variables['fn']['fn'];
// TODO: Make a more formal way to denote inline citations. $url = Url::fromUserInput('#' . $fn['ref_id'], ['attributes' => ['id' => $fn['fn_id'], 'class' => 'footnote-link']]);
$link = Link::fromTextAndUrl(($dont_show_backlink_text && $reference_entity_id ? '^' : $fn['value']), $url)->toRenderable();
$class = 'see-footnote'; $build[] = $link;
// Generate the hover text
$citation_tools = new CitationTools();
$citation_entity_id = $fn['reference'];
$citation_data = $citation_tools->getRenderableReference($citation_entity_id);
// Citation contains a page reference, so construct parenthetical footnote.
// @TODO: Make it explicit.
if (!empty($fn['page'] && !is_numeric($fn['value']))) {
$fn['value'] = "({$fn['value']}, {$fn['page']})";
$citation_data['#data']['page'] = $fn['page'];
$class .= '-inline';
}
$citation_data_render = \Drupal::service('renderer')->render($citation_data);
$title = trim(strip_tags($citation_data_render));
$url = Url::fromUserInput('#' . $fn['fn_id'], ['attributes' => ['id' => $fn['ref_id'], 'class' => $class, 'title' => $title]]);
$link = Link::fromTextAndUrl($fn['value'], $url)->toRenderable();
unset($variables['fn']['fn']);
$variables['fn']['fn'] = $link;
// $variables['fn']['fn'][] = $link;
} }
/** /**
* Implementation of hook_inline_entity_form_entity_form_alter(). * Implements hook_theme().
*
* Force all entities to be saved once they are created.
*
* @TODO: Add cleanup batch task for orphaned References.
*
* @param $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*/
function bibcite_footnotes_inline_entity_form_entity_form_alter(&$form, FormStateInterface &$form_state) {
$form['#save_entity'] = TRUE;
}
/**
* Implementation of hook_form_node_form_alter().
*
* This function populates the Reference list drop-down in the CKEditor drop-down.
* It gathers all referenced entities of type bibcite_reference and puts them
* into a JavaScript setting under drupalSettings.bibcite_footnotes.references.
*
* @param $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*/
function bibcite_footnotes_form_node_form_alter(&$form, FormStateInterface &$form_state) {
$ief = $form_state->get('inline_entity_form');
if ($ief) {
// Inline entity storage uses hashes to separate out the field instances.
$bibcite_references = [];
foreach ($ief as $ief_instance) {
/**
* @var FieldConfig $field_config
*/
if ($field_config = $ief_instance['instance']) {
// Check if this is a bibcite_reference field type.
if ($field_config->getSetting('handler') == 'default:bibcite_reference') {
$field_name = $field_config->get('field_name');
if (!empty($ief_instance['entities'])) {
foreach ($ief_instance['entities'] as $entity_wrapper) {
/**
* @var \Drupal\core\Entity\EntityInterface $entity
*/
$entity = $entity_wrapper['entity'];
if ($entity->getEntityTypeId() == 'bibcite_reference') {
list($citation_text, $citation_key) = bibcite_footnotes_get_ckeditor_select_item($entity);
$bibcite_references[] = [$citation_text, $citation_key];
}
}
}
}
}
}
$triggering_element = $form_state->getTriggeringElement();
if (!$triggering_element) {
$form['#attached']['drupalSettings']['bibcite_footnotes']['references'] = $bibcite_references;
}
else {
$form[$triggering_element['#parents'][0]]['widget']['#attached']['library'][] = 'bibcite_footnotes/replace_citations';
$form[$triggering_element['#parents'][0]]['widget']['#attached']['drupalSettings']['bibcite_footnotes']['references'] = $bibcite_references;
}
}
else {
// Not using Inline Entity Form, get the references if they exist
$entity = $form_state->getFormObject()->getEntity();
$fields = $entity->getFields();
$reference_field = FALSE;
foreach ($fields as $field) {
$type = $field->getFieldDefinition();
if ($type->getType() == 'entity_reference') {
if ($type->getSetting('handler') == 'default:bibcite_reference') {
$referenced_entities = $field->referencedEntities();
$bibcite_references = [];
foreach ($referenced_entities as $referenced_entity) {
list($citation_text, $citation_key) = bibcite_footnotes_get_ckeditor_select_item($referenced_entity);
$bibcite_references[] = [$citation_text, $citation_key];
}
$form['#attached']['drupalSettings']['bibcite_footnotes']['references'] = $bibcite_references;
}
}
}
}
}
/**
* Construct an item to go into the CKEditor Reference drop-down list.
*
* @param $entity
*
* @return array
* The form of the array is ["Citation string", [reference entity id].
*/ */
function bibcite_footnotes_get_ckeditor_select_item($entity): array { function bibcite_footnotes_theme() {
$serializer = \Drupal::service('serializer'); return [
'bibcite_footnotes' => [
$data = $serializer->normalize($entity, 'csl'); 'render element' => 'children',
$build = ['#theme' => 'bibcite_citation', '#data' => $data]; ],
$build_render = \Drupal::service('renderer')->render($build); ];
$citation_text = trim(strip_tags($build_render));
// Attempt to match up pre-saved entities with the eventual saved ones.
$citation_key = $entity->id->first()->getValue()['value'];
return [$citation_text, $citation_key];
} }
/** function bibcite_footnotes_theme_registry_alter(&$theme_registry) {
* Implementation of hook_preprocess_field(). unset($theme_registry['footnote_list']['function']);
* Sort the works cited list by rendered text, which results in author(s) then title. $theme_registry['footnote_list']['path'] = drupal_get_path('module', 'bibcite_footnotes') . '/templates';
* $theme_registry['footnote_list']['template'] = 'footnote-list';
* @param $variables $theme_registry['footnote_list']['variables']['notes'] = [];
* @param $hook $theme_registry['footnote_list']['variables']['references'] = [];
*/ $theme_registry['footnote_list']['variables']['footnotes'] = [];
function bibcite_footnotes_preprocess_field(&$variables, $hook) {
$citation_tools = new CitationTools(); unset($theme_registry['footnote_link']['function']);
if ($variables['field_name'] == 'field_bibcite_fn_works_cited') { $theme_registry['footnote_link']['path'] = drupal_get_path('module', 'bibcite_footnotes') . '/templates';
$theme_registry['footnote_link']['template'] = 'footnote-link';
foreach($variables['element'] as $index => $element) {
if (is_numeric($index)) {
$renderable = $citation_tools->getRenderableReference($element['#bibcite_reference']);
$renderable = \Drupal::service('renderer')->render($renderable);
$items[] = [
'orig_index' => $index,
'orig_element' => $element,
'rendered' => trim(strip_tags($renderable)),
];
}
}
uasort($items, '_bibcite_footnotes_sort_rendered_references');
$i = 0;
foreach ($items as $item) {
$variables['element'][$i] = $item['orig_element'];
$variables['element']['#items'][$i] = $item['orig_element'];
$variables['items'][$i]['content'] = $item['orig_element'];
$i += 1;
}
}
} }
/**
* Comparator function for theme field preprocess.
*
* @param $a
* The first renderable element.
* @param $b
* The second renderable element.
*
* @return int
*/
function _bibcite_footnotes_sort_rendered_references($a, $b) {
if ($a['rendered'] == $b['rendered']) {
return 0;
}
return strtolower($a['rendered']) < strtolower($b['rendered']) ? -1 : 1;
}
Alexander O'Neill