Skip to content

Add option to cache EAD HTML transformations #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: 7.x
Choose a base branch
from
Open

Add option to cache EAD HTML transformations #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3b738dd
#78: Move EAD HTML generation to a dedicated include
ctgraham Nov 1, 2021
8ba48fa
#69: add option to cache EAD HTML transformations to disk
ctgraham Nov 2, 2021
8a61b09
discoverygarden#69: Use an expired cachefile until a new one is built…
ctgraham Sep 22, 2022
84df877
#69: clear expired cachefiles and check object existence when caching
ctgraham Oct 4, 2022
8c2778b
#69: avoid re-using expired cachefile in cron
ctgraham Oct 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ In `charlie`, we have three logical containers:

Do note that the code tries not to make any assumptions about the numbering of boxes or folders. Folders could either be numbered sequentially across boxes (in which case specifying a range of folders could make sense when specifying a range of boxes) or specific to a box. Additionally, pluralization of types is largely ignored.

### Q. What does the EAD caching feature do?

A. When enabled, the EAD HTML caching will perform the XSLT transform of the EAD to HTML and then cache the resulting HTML to a temporary file, for later reuse. This file will be written into Drupal's Temporary directory, and the last modification time will be used to gauge whether the cache expiration has been exceeded. If Islandora Solr Search is enabled, Drupal's cron wil pre-cache any EADs.

## Maintainers/Sponsors
Current maintainers:

Expand Down
22 changes: 22 additions & 0 deletions includes/admin.form.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ function islandora_manuscript_admin_settings_form(array $form, array &$form_stat
'#default_value' => variable_get('islandora_manuscript_metadata_display', FALSE),
),
),
'islandora_manuscript_ead_caching' => array(
'#type' => 'textfield',
'#title' => t('Cache HTML rendering of EAD'),
'#description' => t("The length of time to cache the HTML rendering of EAD, e.g. \"+90 minutes\"."),
'#default_value' => variable_get('islandora_manuscript_ead_caching', ''),
'#element_validate' => array('islandora_manuscript_validate_strtotime'),
'#size' => 30,
),
);

// Solr field containing the parent book PID.
Expand Down Expand Up @@ -96,6 +104,20 @@ function islandora_manuscript_admin_settings_form(array $form, array &$form_stat
return system_settings_form($form);
}

/**
* Check if the form element is parseable by strtotime
*
* @param array $element
* The element to check.
* @param array $form_state
* The Drupal form state.
*/
function islandora_manuscript_validate_strtotime($element, &$form_state) {
if (!empty($element['#value']) && (!is_numeric(strtotime($element['#value'])) || strtotime($element['#value']) < 0)) {
form_error($element, t('The "!name" option must contain a valid value. You may either leave the text field empty or enter a string like "+30 minutes", "+4 hours", or "+1 week 2 days 4 hours 2 seconds".', array('!name' => t($element['#title']))));
}
}

/**
* Check if the required resources are enabled.
*
Expand Down
Loading