GetThis feature + Regex config file support

config/vufind/GetThis.yaml

@@ -0,0 +1,96 @@
+---
+# This file contains the settings for the GetThis feature
+
+# Either to display the copy number (next to the call number), default false
+showCopyNumber: true
+
+templates:
+  # Elements here correspond to a template file within templates/get-this with .phtml being stripped from the end
+  # The order changes the order templates are displayed
+  # Elements parameter, all parameters are optional :
+  #   enabled: true/false, whether to enable the template
+  #   view_variables: array of extra variables made available to the templates.
+  #     It can be used with placeholders if available; see example below.
+  #   condition_function: a function within GetThisLoader returning a boolean to whether display or not the template
+  #     The result of the function can be negated if prefixed with "!"
+  #     note : If the function does not exist, the condition will evaluate to false
+  #   conditions: if condition_function is limiting for you, conditions replace it to give more flexibility :
+  #     This element defines a set of logical conditions.
+  #     The structure is recursive, allowing nested combinations of AND/OR logic.
+  #     At each level, conditions is a list of entries.
+  #     If any entry is true, the whole list is considered true (logical OR).
+  #     Entries can be:
+  #       condition_function: evaluates a single condition.
+  #       conditions: e nested conditions block used to combine conditions.
+  #       The string "and": acts as a logical AND between adjacent conditions.
+  #
+  #   Example; Values surrounded with brackets are placeholders serving as example :
+  #     {template_name}:
+  #       conditions:
+  #         - conditions:
+  #             - conditions:
+  #                 - condition_function: {test_function1}
+  #                 - and
+  #                 - condition_function: {test_function2}
+  #             - condition_function: {test_function3}
+  #         - condition_function: {test_function4}
+  #       view_variables:
+  #         - {my_link}: {https://your_lib.edu}
+  #         - {my_link_with_placeholder}: {https://mylib.edu/%%location%%/open_hours}
+
+  holdings:
+    condition_function: showHoldings
+
+  biblio-info:
+    enabled: true
+
+  micro-form:
+    condition_function: showMicroForm
+    view_variables:
+      open_hours: https://your_lib.edu/hours
+
+  message:
+    condition_function: showMessage
+
+  staff-office-delivery:
+    condition_function: showStaffDelivery
+    view_variables:
+      # Has the following placeholders available:
+      #   %%item%% : Item record
+      #   %%location%%: Location of the item
+      #   %%callNum%%: Call number
+      #   %%title%%: Title
+      #   %%author%%: Author
+      #   %%isbn%%: ISBN
+      general_link: https://your_lib.msu.edu/facstaffdelivery
+      request_link: https://interlib.your_lib.edu/request_link/%%title%%?author=%%author%%&rft.isbn=%%isbn%%&loc=%%location%%&callno=%%callNum%%&CAT=1
+
+
+  inter-library:
+    condition_function: showInterLibrary
+    view_variables:
+      # Has the following placeholders available:
+      #   %%item%% : Item record
+      #   %%location%%: Location of the item
+      #   %%status%%: Availability status
+      #   %%callNum%%: Call number
+      #   %%title%%: Title
+      #   %%author%%: Author
+      #   %%isbn%%: ISBN
+      general_link: https://your_lib.edu/ils/
+      request_link: https://interlib.your_lib.edu/request_link/%%title%%?author=%%author%%&rft.isbn=%%isbn%%&loc=%%location%%&callno=%%callNum%%&CAT=1
+
+
+  remote-delivery:
+    condition_function: showRemotePatron
+    view_variables:
+      # Has the following placeholders available:
+      #   %%item%% : Item record
+      #   %%location%%: Location of the item
+      #   %%status%%: Availability status
+      #   %%callNum%%: Call number
+      #   %%title%%: Title
+      #   %%author%%: Author
+      #   %%isbn%%: ISBN
+      general_link: https://your_lib.edu/ils/distance
+      request_link: https://interlib.your_lib.edu/request_link/%%title%%?author=%%author%%&rft.isbn=%%isbn%%&loc=%%location%%&callno=%%callNum%%&CAT=1

config/vufind/Regex.yaml

@@ -0,0 +1,69 @@
+---
+# This file contains the settings for the Regex feature
+
+# Status
+  # Regex in this section are used to match against the specific item status value
+  # Each heading in this section is a grouping of those statuses used for logic within the GetThis feature
+AVAILABLE:
+  # Used within GetThisLoader in the following functions : showRemotePatron, showStaffDelivery
+  - '/^AVAILABLE/i'
+  - '/ITEM IN LIBRARY/i'
+LIB_USE_ONLY:
+  # Used within GetThisLoader in the following functions : isLibUseOnly
+  - '/RESTRICTED/i'
+OUT:
+  # Used within GetThisLoader in the following functions : isOut
+  - '/CHECKED/i'
+  - '/BILLED/i'
+  - '/ON SEARCH/i'
+  - '/LOST/i'
+  - '/HOLD/i'
+  - '/AWAITING PICKUP/i'
+  - '/AWAITING DELIVERY/i'
+  - '/IN TRANSIT/i'
+  - '/PAGES/i'
+UNAVAILABLE:
+  # Used within GetThisLoader in the following functions : isUnavailable
+  - '/AGED TO LOST/i'
+  - '/CLAIMED RETURNED/i'
+  - '/DECLARED LOST/i'
+  - '/IN PROCESS/i'
+  - '/IN PROCESS (NON-REQUESTABLE)/i'
+  - '/LONG MISSING/i'
+  - '/LOST AND PAID/i'
+  - '/MISSING/i'
+  - '/ON ORDER/i'
+  - '/ORDER CLOSED/i'
+  - '/UNKNOWN/i'
+  - '/WITHDRAWN/i'
+
+# Description / Call Number
+AV_MEDIA:
+  # Used within GetThisLoader in the following functions : isAudioVideoMedia
+  - '/DISC/i'
+  - '/VIDEO/i'
+  - '/CD/i'
+  - '/DVD/i'
+  - '/BLU-RAY/i'
+  - '/VINYL/i'
+  - '/AUDIOCASSETTE/i'
+
+# Location
+EXCLUSIVE:
+  # Used within GetThisLoader in the following functions : showInterLibrary
+  # It should include patterns that should be excluded from Inter Library Loan
+  # (i.e. will return false and not show the inter-library.phtml template)
+#  - CAMPUS
+MICROFORMS:
+  # Used within GetThisLoader in the following functions : showMicroForm
+  - '/MICROFORMS/i'
+ONLINE:
+  # Used within GetThisLoader in the following functions : isOnlineResource
+  - '/ONLINE RESOURCE/i'
+  - '/ELECTRONIC RESOURCES/i'
+  - '/INTERNET/i'
+
+# Format
+SERIAL:
+  # Used within GetThisLoader in the following functions : isSerial
+  - '/SERIAL/i'

config/vufind/config.ini

@@ -2191,6 +2191,10 @@ includeSchemaOrgMetadata = true
 ; If set to "numerical", it will sort numerically by MARC tag.
 ;marcSubjectHeadingsSort = "numerical"
 
+; Enable the link for the get this feature
+; The get this feature opens a lightbox with information on how to get the record
+;getThisEnabled = true
+
 ; The following two sections control the Alphabetic Browse module.
 [AlphaBrowse]
 ; This setting controls how many headings are displayed on each page of results:

languages/en.ini

@@ -70,6 +70,7 @@ All Text = "All Text"
 alphabrowse_matches = "Results"
 alphabrowselink_html = 'Browse entries by %%index%% starting from <a href="%%url%%">%%from%%</a>.'
 Alternate Title = "Alternate Title"
+Alternative = "Alternative"
 Always ask me = "Always ask me"
 An error has occurred = "An error has occurred"
 An error occurred during execution; please try again later. = "An error occurred during execution; please try again later."
@@ -195,6 +196,9 @@ By Topic = "By Topic"
 cached_record_warning = "This record is not available in the search index. Last cached version is shown."
 Call Number = "Call Number"
 callnumber_abbrev = "Call #"
+campus_pickup = "On-Campus Pickup"
+campus_pickup_place_request = "Place Request for On-Campus Pickup"
+campus_pickup_place_request_text = "We will hold materials for pickup at the library."
 Cannot find record = "Cannot find record"
 Cannot find similar records = "Cannot find similar records"
 cannot set = "Cannot set"
@@ -301,6 +305,7 @@ Cookie Settings = "Cookie Settings"
 Coordinates = "Coordinates"
 Copies = "Copies"
 Copy = "Copy"
+copy_number = "Copy #%%number%%"
 copy_to_clipboard_button_label = "Copy to clipboard"
 copy_to_clipboard_failure_message = "Copying to clipboard failed"
 copy_to_clipboard_success_message = "Successfully copied to clipboard"
@@ -353,6 +358,10 @@ delete_selected_favorites = "Delete Selected Saved Items"
 delete_tag = "Delete Tag"
 delete_tags = "Delete Tags"
 delete_tags_by = "Delete Tags By"
+delivery_request = "Request Delivery"
+delivery_request_distance = "Distance Delivery Services"
+delivery_request_distance_text = "We deliver materials directly to your home."
+delivery_request_distance_user = "Request Item as Distance User"
 Department = "Department"
 Description = "Description"
 Descriptors = "Descriptors"
@@ -740,6 +749,7 @@ Institutional Login = "Institutional Login"
 institutional_login_desc = "Enter your campus-wide username and password."
 Instructor = "Instructor"
 Interlibrary Loan Requests = "Interlibrary Loan Requests"
+interlibrary_loan_requests_text = "Request materials through Inter-library Loan system."
 Internet = "Internet"
 interval_captcha_not_passed = "This action can only be performed after %%delay%% seconds."
 Invalid Patron Login = "Invalid Patron Login"
@@ -855,6 +865,7 @@ Message = "Message"
 Message From Sender = "Message From Sender"
 Metadata Prefix = "Metadata Prefix"
 Microfilm = "Microfilm"
+microform_viewing_request_text = "Microform materials can be accessed at the Main Library during %%link_start%%open hours%%link_end%%."
 MLA Citation = "MLA Citation"
 MLA Edition Citation = "MLA (9th ed.) Citation"
 Mobile Number = "Mobile Number"
@@ -932,6 +943,7 @@ nohit_query_without_filters = "Remove all filters from this search."
 nohit_spelling = "Perhaps you should try some spelling variations"
 nohit_suggest = "You may want to try to revise your search phrase by removing some words or check your spelling."
 NOT = "NOT"
+Not Available = "Not Available"
 Not Illustrated = "Not Illustrated"
 Not On Reserve = "Not On Reserve"
 not_applicable = "n/a"
@@ -1417,6 +1429,8 @@ Source Title = "Source Title"
 spell_expand_alt = "Expand Search"
 spell_suggest = "Search alternatives"
 Staff View = "Staff View"
+staff_office_delivery = "Faculty/Staff Office Delivery"
+staff_office_delivery_text = "We deliver materials to your on-campus office."
 standalone_record_link = "Standalone Record"
 Start a new Advanced Search = "Start a new Advanced Search"
 Start a new Basic Search = "Start a new Basic Search"
@@ -1586,6 +1600,7 @@ View Retraction Notice = "View Retraction Notice"
 View this record in EBSCOhost = "View this record in EBSCOhost"
 view_already_selected = "%%current%% view already selected"
 view_in_opac = "View in OPAC"
+viewing_request = "Request Viewing"
 visual_facet_parent = "From"
 Volume = "Volume"
 Volume Holdings = "Volume Holdings"

languages/fr.ini

@@ -66,6 +66,7 @@ All Pages Loaded = "Toutes les pages chargées"
 All Text = "Tout le texte"
 alphabrowse_matches = "Résultats"
 alphabrowselink_html = 'Parcourir par %%index%% à partir de <a href="%%url%%">%%from%%</a>.'
+Alternative = "Alternative"
 Always ask me = "Toujours me demander"
 An error has occurred = "Une erreur est survenue"
 An error occurred during execution; please try again later. = "Erreur lors de l'exécution de la commande. Veuillez réessayer plus tard."
@@ -184,6 +185,9 @@ By Topic = "par sujet"
 cached_record_warning = "Cette notice n'est pas disponible dans l'index de recherche. La version affichée est la dernière enregistrée dans le cache."
 Call Number = "Cote"
 callnumber_abbrev = "Cote :"
+campus_pickup = "Retrait sur le campus"
+campus_pickup_place_request = "Faire une demande de retrait sur campus"
+campus_pickup_place_request_text = "Nous mettrons de côté les ressources demandées à la bibliothèque."
 Cannot find record = "Notice introuvable"
 Cannot find similar records = "Pas de notices similaires trouvées"
 cannot set = "Ne peut pas être modifié"
@@ -281,6 +285,7 @@ Cookie Settings = "Configuration des cookies"
 Coordinates = "Coordonnées"
 Copies = "Exemplaires"
 Copy = "Exemplaire"
+copy_number = "Exemplaire N°%%number%%"
 copy_to_clipboard_button_label = "Copier vers le presse-papier"
 copy_to_clipboard_failure_message = "Échec de la copie vers le presse-papier"
 copy_to_clipboard_success_message = "Copié avec succès vers le presse-papier"
@@ -330,6 +335,10 @@ delete_selected_favorites = "Supprimer les favoris sélectionnés"
 delete_tag = "Supprimer le tag"
 delete_tags = "Supprimer les tags"
 delete_tags_by = "Supprimer les tags par"
+delivery_request = "Me faire livrer"
+delivery_request_distance = "Livraison à distance"
+delivery_request_distance_text = "Nous livrons à votre domicile."
+delivery_request_distance_user = "Se faire livrer à distance"
 Department = "Département"
 Description = "Description"
 Desired Username = "Nom d'utilisateur souhaité"
@@ -683,6 +692,7 @@ Institutional Login = "Accéder à votre institution"
 institutional_login_desc = "Entrez votre identifiant institutionnel et votre mot de passe."
 Instructor = "Professeur"
 Interlibrary Loan Requests = "Demandes de prêt entre bibliothèques"
+interlibrary_loan_requests_text = "Demander un prêt entre bibliothèques."
 Internet = "Internet"
 interval_captcha_not_passed = "Il n'est possible de réaliser cette action qu'après un délai de %%delay%% secondes."
 Invalid Patron Login = "Identifiant lecteur invalide"
@@ -792,6 +802,7 @@ Message = "Message"
 Message From Sender = "Message de l'expéditeur"
 Metadata Prefix = "Préfixe des métadonnées"
 Microfilm = "Microfilm"
+microform_viewing_request_text = "Les ressources microform peuvent être consulter pendant les %%link_start%%horaires d'ouverture%%link_end%% de la bibliothèque."
 MLA Citation = "Style de citation MLA"
 MLA Edition Citation = "Style de citation MLA (9e éd.)"
 Mobile Number = "Numéro de téléphone portable"
@@ -860,6 +871,7 @@ nohit_query_without_filters = "Supprimer tous les filtres de cette recherche."
 nohit_spelling = "Essayez une orthographe différente."
 nohit_suggest = "Vérifiez votre recherche en supprimant des mots-clés et en vérifiant l'orthographe."
 NOT = "PAS"
+Not Available = "Non-disponible"
 Not Illustrated = "Sans illustrations"
 Not On Reserve = "Non réservé"
 not_applicable = "n/a"
@@ -1278,6 +1290,8 @@ Source Title = "Titre de la source"
 spell_expand_alt = "Recherche élargie"
 spell_suggest = "Recherches alternatives"
 Staff View = "Affichage MARC"
+staff_office_delivery = "Livraison au bureau (employés)"
+staff_office_delivery_text = "Nous livrons des ressources à votre bureau sur le campus."
 Start a new Advanced Search = "Nouvelle recherche avancée"
 Start a new Basic Search = "Nouvelle recherche simple"
 Start Page = "Page d'accueil"
@@ -1440,6 +1454,7 @@ View Retraction Notice = "Voir l'avis de rétractation"
 View this record in EBSCOhost = "Voir cette notice dans EBSCOhost"
 view_already_selected = "%%current%% voir les éléments déjà sélectionnés"
 view_in_opac = "Voir à l'OPAC"
+viewing_request = "Demande de consultation"
 visual_facet_parent = "De"
 Volume = "Volume"
 Volume Holdings = "Indications des volumes"

module/VuFind/config/module.config.php

@@ -465,6 +465,7 @@
             'VuFind\Favorites\FavoritesService' => 'VuFind\Favorites\FavoritesServiceFactory',
             'VuFind\Form\Form' => 'VuFind\Form\FormFactory',
             'VuFind\Form\Handler\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
+            'VuFind\GetThis\GetThisLoader' => 'VuFind\GetThis\GetThisLoaderFactory',
             'VuFind\GeoFeatures\BasemapConfig' => 'VuFind\GeoFeatures\AbstractConfigFactory',
             'VuFind\GeoFeatures\MapTabConfig' => 'VuFind\GeoFeatures\AbstractConfigFactory',
             'VuFind\GeoFeatures\MapSelectionConfig' => 'VuFind\GeoFeatures\AbstractConfigFactory',
@@ -513,6 +514,7 @@
             'VuFind\RecordDriver\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\RecordTab\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\RecordTab\TabManager' => 'VuFind\RecordTab\TabManagerFactory',
+            'VuFind\Regex\Regex' => 'VuFind\Regex\RegexFactory',
             'VuFind\Related\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Resolver\Driver\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Role\PermissionDeniedManager' => 'VuFind\Role\PermissionDeniedManagerFactory',
@@ -778,6 +780,7 @@
     'AddComment', 'DeleteComment', 'AddTag', 'DeleteTag', 'Save', 'Email', 'SMS',
     'Cite', 'Explain', 'Export', 'RDF', 'Hold', 'Home', 'StorageRetrievalRequest',
     'AjaxTab', 'ILLRequest', 'PDF', 'Epub', 'LinkedText', 'Permalink', 'Rating',
+    'GetThis',
 ];
 
 // Define dynamic routes -- controller => [route name => action]