From 82a96a5c335bd1affce375e33350289bf82573b9 Mon Sep 17 00:00:00 2001 From: astanley Date: Fri, 4 Sep 2026 12:29:08 -0300 Subject: [PATCH] initial commit --- LICENSE | 339 ++++++++++++++++++ README.md | 33 ++ composer.json | 9 + .../islandora_collection_manager.settings.yml | 4 + .../islandora_collection_manager.schema.yml | 10 + islandora_collection_manager.info.yml | 9 + islandora_collection_manager.install | 20 ++ islandora_collection_manager.links.menu.yml | 13 + islandora_collection_manager.links.task.yml | 9 + islandora_collection_manager.permissions.yml | 13 + islandora_collection_manager.routing.yml | 24 ++ islandora_collection_manager.services.yml | 8 + .../CollectionAutocompleteController.php | 59 +++ src/Form/CollectionManagerForm.php | 310 ++++++++++++++++ src/Form/CollectionManagerSettingsForm.php | 60 ++++ src/Service/DescendantFinder.php | 46 +++ src/Service/ModelHelper.php | 137 +++++++ 17 files changed, 1103 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 composer.json create mode 100644 config/install/islandora_collection_manager.settings.yml create mode 100644 config/schema/islandora_collection_manager.schema.yml create mode 100644 islandora_collection_manager.info.yml create mode 100644 islandora_collection_manager.install create mode 100644 islandora_collection_manager.links.menu.yml create mode 100644 islandora_collection_manager.links.task.yml create mode 100644 islandora_collection_manager.permissions.yml create mode 100644 islandora_collection_manager.routing.yml create mode 100644 islandora_collection_manager.services.yml create mode 100644 src/Controller/CollectionAutocompleteController.php create mode 100644 src/Form/CollectionManagerForm.php create mode 100644 src/Form/CollectionManagerSettingsForm.php create mode 100644 src/Service/DescendantFinder.php create mode 100644 src/Service/ModelHelper.php diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a174118 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Islandora Collection Manager + +Provides an administrative Collection Manager for Islandora-style Drupal sites. + +## Features + +- Container autocomplete restricted to configured Islandora models. +- Recursive, cycle-safe traversal through `field_member_of`. +- Paged descendant results (50/page). +- Result filtering by model. +- Configured Drupal node Actions can be applied to selected results. +- Administrator-selectable container models using taxonomy term `field_external_uri` values. + +## Configuration + +After enabling/updating the module: + + drush updb -y + drush cr + +Configure container models at: + + /admin/config/content/collection-manager + +Use Collection Manager at: + + /admin/content/collection-manager + +The upgrade hook preserves the former hard-coded defaults: + +- Collection — http://purl.org/dc/dcmitype/Collection +- Compound Object — http://vocab.getty.edu/aat/300242735 +- Book/Paged Content — https://schema.org/Book diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..4c35e85 --- /dev/null +++ b/composer.json @@ -0,0 +1,9 @@ +{ + "name": "roblib/islandora_collection_manager", + "description": "Allows Actions to be run on collection members", + "type": "drupal-custom-module", + "minimum-stability": "dev", + "license": "GPL-2.0-or-later", + "require": { + } +} diff --git a/config/install/islandora_collection_manager.settings.yml b/config/install/islandora_collection_manager.settings.yml new file mode 100644 index 0000000..a9d1055 --- /dev/null +++ b/config/install/islandora_collection_manager.settings.yml @@ -0,0 +1,4 @@ +container_model_uris: + - 'http://purl.org/dc/dcmitype/Collection' + - 'http://vocab.getty.edu/aat/300242735' + - 'https://schema.org/Book' diff --git a/config/schema/islandora_collection_manager.schema.yml b/config/schema/islandora_collection_manager.schema.yml new file mode 100644 index 0000000..7f53e65 --- /dev/null +++ b/config/schema/islandora_collection_manager.schema.yml @@ -0,0 +1,10 @@ +islandora_collection_manager.settings: + type: config_object + label: 'Islandora Collection Manager settings' + mapping: + container_model_uris: + type: sequence + label: 'Container model URIs' + sequence: + type: string + label: 'Model URI' diff --git a/islandora_collection_manager.info.yml b/islandora_collection_manager.info.yml new file mode 100644 index 0000000..c920e37 --- /dev/null +++ b/islandora_collection_manager.info.yml @@ -0,0 +1,9 @@ +name: 'Islandora Collection Manager' +type: module +description: 'Select an Islandora collection/container, browse descendants, filter by model, and execute configured node actions.' +package: Custom +core_version_requirement: ^10 || ^11 +dependencies: + - drupal:node + - drupal:taxonomy + - drupal:action diff --git a/islandora_collection_manager.install b/islandora_collection_manager.install new file mode 100644 index 0000000..b9931b0 --- /dev/null +++ b/islandora_collection_manager.install @@ -0,0 +1,20 @@ +getEditable('islandora_collection_manager.settings'); + if ($config->get('container_model_uris') === NULL) { + $config->set('container_model_uris', [ + 'http://purl.org/dc/dcmitype/Collection', + 'http://vocab.getty.edu/aat/300242735', + 'https://schema.org/Book', + ])->save(); + } +} diff --git a/islandora_collection_manager.links.menu.yml b/islandora_collection_manager.links.menu.yml new file mode 100644 index 0000000..1f4afde --- /dev/null +++ b/islandora_collection_manager.links.menu.yml @@ -0,0 +1,13 @@ +islandora_collection_manager.manager: + title: 'Collection Manager' + description: 'Browse and act on descendants of a collection/container.' + route_name: islandora_collection_manager.manager + parent: system.admin_content + weight: 20 + +islandora_collection_manager.settings: + title: 'Collection Manager' + description: 'Configure Collection Manager container models.' + route_name: islandora_collection_manager.settings + parent: system.admin_config_content + weight: 20 diff --git a/islandora_collection_manager.links.task.yml b/islandora_collection_manager.links.task.yml new file mode 100644 index 0000000..1d842f8 --- /dev/null +++ b/islandora_collection_manager.links.task.yml @@ -0,0 +1,9 @@ +islandora_collection_manager.manager_tab: + route_name: islandora_collection_manager.manager + title: 'Collection Manager' + base_route: system.admin_content + +islandora_collection_manager.settings_tab: + route_name: islandora_collection_manager.settings + title: 'Settings' + base_route: islandora_collection_manager.settings diff --git a/islandora_collection_manager.permissions.yml b/islandora_collection_manager.permissions.yml new file mode 100644 index 0000000..dcd4435 --- /dev/null +++ b/islandora_collection_manager.permissions.yml @@ -0,0 +1,13 @@ +access collection manager: + title: 'Access Collection Manager' + description: 'Select containers and browse their descendants.' + +administer collection manager: + title: 'Administer Collection Manager' + description: 'Configure which Islandora models can be used as containers.' + restrict access: true + +execute collection manager actions: + title: 'Execute actions in Collection Manager' + description: 'Execute configured node actions from Collection Manager results.' + restrict access: true diff --git a/islandora_collection_manager.routing.yml b/islandora_collection_manager.routing.yml new file mode 100644 index 0000000..a9bc9f5 --- /dev/null +++ b/islandora_collection_manager.routing.yml @@ -0,0 +1,24 @@ +islandora_collection_manager.manager: + path: '/admin/content/collection-manager' + defaults: + _form: '\Drupal\islandora_collection_manager\Form\CollectionManagerForm' + _title: 'Collection Manager' + requirements: + _permission: 'access collection manager' + +# Drupal entity autocomplete callback used by the form. +islandora_collection_manager.autocomplete: + path: '/admin/content/collection-manager/autocomplete' + defaults: + _controller: '\Drupal\islandora_collection_manager\Controller\CollectionAutocompleteController::autocomplete' + requirements: + _permission: 'access collection manager' + +# Configuration screen. +islandora_collection_manager.settings: + path: '/admin/config/content/collection-manager' + defaults: + _form: '\Drupal\islandora_collection_manager\Form\CollectionManagerSettingsForm' + _title: 'Collection Manager settings' + requirements: + _permission: 'administer collection manager' diff --git a/islandora_collection_manager.services.yml b/islandora_collection_manager.services.yml new file mode 100644 index 0000000..d85c4ad --- /dev/null +++ b/islandora_collection_manager.services.yml @@ -0,0 +1,8 @@ +services: + islandora_collection_manager.model_helper: + class: Drupal\islandora_collection_manager\Service\ModelHelper + arguments: ['@entity_type.manager', '@entity_field.manager', '@config.factory'] + + islandora_collection_manager.descendant_finder: + class: Drupal\islandora_collection_manager\Service\DescendantFinder + arguments: ['@entity_type.manager'] diff --git a/src/Controller/CollectionAutocompleteController.php b/src/Controller/CollectionAutocompleteController.php new file mode 100644 index 0000000..136259c --- /dev/null +++ b/src/Controller/CollectionAutocompleteController.php @@ -0,0 +1,59 @@ +get('entity_type.manager'), + $container->get('islandora_collection_manager.model_helper'), + ); + } + + public function autocomplete(Request $request): JsonResponse { + $q = trim((string) $request->query->get('q', '')); + if (mb_strlen($q) < 1) { + return new JsonResponse([]); + } + + $model_tids = $this->modelHelper->getContainerModelTermIds(); + if (!$model_tids) { + return new JsonResponse([]); + } + + $storage = $this->entityTypeManagerService->getStorage('node'); + $query = $storage->getQuery() + ->accessCheck(TRUE) + ->condition('field_model.target_id', $model_tids, 'IN') + ->condition('title', $q, 'CONTAINS') + ->sort('title') + ->range(0, 20); + + $ids = $query->execute(); + $matches = []; + foreach ($storage->loadMultiple($ids) as $node) { + $matches[] = [ + 'value' => $node->label() . ' (' . $node->id() . ')', + 'label' => $node->label() . ' (' . $node->id() . ')', + ]; + } + return new JsonResponse($matches); + } + +} diff --git a/src/Form/CollectionManagerForm.php b/src/Form/CollectionManagerForm.php new file mode 100644 index 0000000..bf8b20b --- /dev/null +++ b/src/Form/CollectionManagerForm.php @@ -0,0 +1,310 @@ +requestStack = $request_stack; + } + + public static function create(ContainerInterface $container): static { + return new static( + $container->get('entity_type.manager'), + $container->get('islandora_collection_manager.descendant_finder'), + $container->get('islandora_collection_manager.model_helper'), + $container->get('pager.manager'), + $container->get('pager.parameters'), + $container->get('request_stack'), + ); + } + + public function getFormId(): string { + return 'islandora_collection_manager_form'; + } + + /** + * {@inheritdoc} + * + * Submission is handled by the button-specific submit handlers below. + */ + public function submitForm(array &$form, FormStateInterface $form_state): void { + // Intentionally empty. + } + + public function buildForm(array $form, FormStateInterface $form_state): array { + $request = $this->requestStack->getCurrentRequest(); + $collection_nid = (int) $request->query->get('collection', 0); + $selected_models = array_values(array_filter((array) $request->query->all('models'))); + + $collection_default = ''; + if ($collection_nid) { + $collection = $this->entityTypeManagerService->getStorage('node')->load($collection_nid); + if ($collection && $this->modelHelper->nodeIsConfiguredContainer($collection)) { + $collection_default = $collection->label() . ' (' . $collection->id() . ')'; + } + else { + $collection_nid = 0; + } + } + + $form['collection'] = [ + '#type' => 'textfield', + '#title' => $this->t('Collection / container'), + '#default_value' => $collection_default, + '#autocomplete_route_name' => 'islandora_collection_manager.autocomplete', + '#required' => TRUE, + '#description' => $this->t('Begin typing the title of a configured container.'), + ]; + $form['show'] = [ + '#type' => 'submit', + '#value' => $this->t('Show descendants'), + '#submit' => ['::submitCollection'], + ]; + + if (!$collection_nid) { + return $form; + } + + $all_descendants = $this->descendantFinder->findDescendantIds($collection_nid); + $node_storage = $this->entityTypeManagerService->getStorage('node'); + + // Build the result-model filter from models actually present in descendants. + $available_model_tids = []; + if ($all_descendants) { + $nodes = $node_storage->loadMultiple($all_descendants); + foreach ($nodes as $node) { + if ($node->hasField('field_model')) { + foreach ($node->get('field_model')->getValue() as $item) { + if (!empty($item['target_id'])) { + $available_model_tids[(int) $item['target_id']] = TRUE; + } + } + } + } + } + + $model_options = []; + $uri_by_tid = []; + foreach ($this->modelHelper->getModelTerms() as $tid => $term) { + if (isset($available_model_tids[(int) $tid])) { + $uri = $this->modelHelper->getTermExternalUri($term); + $model_options[$uri] = $term->label(); + $uri_by_tid[(int) $tid] = $uri; + } + } + asort($model_options, SORT_NATURAL | SORT_FLAG_CASE); + + $form['filters'] = [ + '#type' => 'details', + '#title' => $this->t('Filter results'), + '#open' => !empty($selected_models), + '#tree' => TRUE, + ]; + $form['filters']['models'] = [ + '#type' => 'checkboxes', + '#title' => $this->t('Result models'), + '#options' => $model_options, + '#default_value' => $selected_models, + '#description' => $this->t('Leave all unchecked to show descendants of every model.'), + ]; + $form['filters']['apply_filter'] = [ + '#type' => 'submit', + '#value' => $this->t('Apply filter'), + '#submit' => ['::submitFilter'], + ]; + $form['filters']['clear_filter'] = [ + '#type' => 'submit', + '#value' => $this->t('Clear filter'), + '#submit' => ['::clearFilter'], + '#limit_validation_errors' => [], + ]; + + $filtered_ids = $all_descendants; + if ($selected_models) { + $selected_tids = array_fill_keys($this->modelHelper->termIdsForUris($selected_models), TRUE); + $filtered_ids = []; + foreach ($node_storage->loadMultiple($all_descendants) as $nid => $node) { + if (!$node->hasField('field_model')) { + continue; + } + foreach ($node->get('field_model')->getValue() as $item) { + if (isset($selected_tids[(int) ($item['target_id'] ?? 0)])) { + $filtered_ids[] = (int) $nid; + break; + } + } + } + } + + $total = count($filtered_ids); + $pager = $this->pagerManager->createPager($total, self::ITEMS_PER_PAGE); + $page = $this->pagerParameters->findPage(); + $offset = $page * self::ITEMS_PER_PAGE; + $page_ids = array_slice($filtered_ids, $offset, self::ITEMS_PER_PAGE); + $page_nodes = $node_storage->loadMultiple($page_ids); + + $form['summary'] = [ + '#markup' => '

' . $this->formatPlural($total, '1 matching descendant', '@count matching descendants') . '

', + ]; + + $header = [ + 'select' => $this->t('Select'), + 'title' => $this->t('Title'), + 'nid' => $this->t('Node ID'), + 'model' => $this->t('Model'), + 'status' => $this->t('Status'), + ]; + $rows = []; + foreach ($page_nodes as $nid => $node) { + $models = []; + if ($node->hasField('field_model')) { + foreach ($node->get('field_model')->referencedEntities() as $term) { + $models[] = $term->label(); + } + } + $rows[$nid] = [ + 'select' => ['data' => ['#type' => 'checkbox', '#name' => 'selected[' . $nid . ']', '#return_value' => $nid]], + 'title' => ['data' => $node->toLink($node->label())->toRenderable()], + 'nid' => $nid, + 'model' => implode(', ', $models), + 'status' => $node->isPublished() ? $this->t('Published') : $this->t('Unpublished'), + ]; + } + + $form['results'] = [ + '#type' => 'table', + '#header' => $header, + '#rows' => $rows, + '#empty' => $this->t('No descendants match the selected model filter.'), + ]; + $form['pager'] = ['#type' => 'pager']; + + // Preserve the existing VBO-style configured node Action UI. + if ($this->currentUser()->hasPermission('execute collection manager actions')) { + $actions = $this->getNodeActions(); + if ($actions) { + $form['bulk'] = [ + '#type' => 'container', + '#tree' => TRUE, + '#attributes' => ['class' => ['container-inline']], + ]; + $form['bulk']['action'] = [ + '#type' => 'select', + '#title' => $this->t('Action'), + '#options' => $actions, + '#empty_option' => $this->t('- Select an action -'), + ]; + $form['bulk']['apply'] = [ + '#type' => 'submit', + '#value' => $this->t('Apply to selected'), + '#submit' => ['::submitAction'], + ]; + } + } + + $form['#cache']['contexts'][] = 'url.query_args:collection'; + $form['#cache']['contexts'][] = 'url.query_args:models'; + return $form; + } + + public function submitCollection(array &$form, FormStateInterface $form_state): void { + $value = trim((string) $form_state->getValue('collection')); + if (!preg_match('/\((\d+)\)\s*$/', $value, $matches)) { + $form_state->setErrorByName('collection', $this->t('Select a container from the autocomplete list.')); + return; + } + $nid = (int) $matches[1]; + $node = $this->entityTypeManagerService->getStorage('node')->load($nid); + if (!$node || !$this->modelHelper->nodeIsConfiguredContainer($node)) { + $form_state->setErrorByName('collection', $this->t('The selected node is not one of the configured container models.')); + return; + } + $form_state->setRedirect('islandora_collection_manager.manager', [], ['query' => ['collection' => $nid]]); + } + + public function submitFilter(array &$form, FormStateInterface $form_state): void { + $request = $this->requestStack->getCurrentRequest(); + $nid = (int) $request->query->get('collection', 0); + $models = array_values(array_filter($form_state->getValue(['filters', 'models']) ?? [])); + $query = ['collection' => $nid]; + if ($models) { + $query['models'] = $models; + } + $form_state->setRedirect('islandora_collection_manager.manager', [], ['query' => $query]); + } + + public function clearFilter(array &$form, FormStateInterface $form_state): void { + $nid = (int) $this->requestStack->getCurrentRequest()->query->get('collection', 0); + $form_state->setRedirect('islandora_collection_manager.manager', [], ['query' => ['collection' => $nid]]); + } + + public function submitAction(array &$form, FormStateInterface $form_state): void { + if (!$this->currentUser()->hasPermission('execute collection manager actions')) { + throw new \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException(); + } + + $action_id = (string) $form_state->getValue(['bulk', 'action']); + $selected = array_keys(array_filter((array) $form_state->getValue('selected', []))); + if (!$action_id || !$selected) { + $this->messenger()->addWarning($this->t('Select at least one result and an action.')); + return; + } + + $action = $this->entityTypeManagerService->getStorage('action')->load($action_id); + if (!$action || $action->getType() !== 'node') { + $this->messenger()->addError($this->t('The selected action is not available for nodes.')); + return; + } + + $nodes = $this->entityTypeManagerService->getStorage('node')->loadMultiple(array_map('intval', $selected)); + $executed = 0; + foreach ($nodes as $node) { + if ($node->access('update', $this->currentUser())) { + $action->execute([$node]); + $executed++; + } + } + $this->messenger()->addStatus($this->formatPlural($executed, 'Action applied to 1 node.', 'Action applied to @count nodes.')); + $form_state->setRebuild(); + } + + /** + * Returns configured node actions keyed by config entity ID. + */ + protected function getNodeActions(): array { + $options = []; + $actions = $this->entityTypeManagerService->getStorage('action')->loadMultiple(); + foreach ($actions as $id => $action) { + if ($action->getType() === 'node') { + $options[$id] = $action->label(); + } + } + asort($options, SORT_NATURAL | SORT_FLAG_CASE); + return $options; + } + +} diff --git a/src/Form/CollectionManagerSettingsForm.php b/src/Form/CollectionManagerSettingsForm.php new file mode 100644 index 0000000..bf14184 --- /dev/null +++ b/src/Form/CollectionManagerSettingsForm.php @@ -0,0 +1,60 @@ +get('islandora_collection_manager.model_helper')); + } + + public function getFormId(): string { + return 'islandora_collection_manager_settings_form'; + } + + protected function getEditableConfigNames(): array { + return ['islandora_collection_manager.settings']; + } + + public function buildForm(array $form, FormStateInterface $form_state): array { + $options = $this->modelHelper->getModelUriOptions(); + $configured = $this->config('islandora_collection_manager.settings')->get('container_model_uris') ?? []; + + $form['container_model_uris'] = [ + '#type' => 'checkboxes', + '#title' => $this->t('Container models'), + '#description' => $this->t('Nodes using any selected model can be chosen as the starting container in Collection Manager. Model URIs come from taxonomy term field_external_uri values.'), + '#options' => $options, + '#default_value' => $configured, + '#required' => TRUE, + ]; + + if (!$options) { + $form['container_model_uris']['#description'] = $this->t('No taxonomy terms with a populated field_external_uri field were found.'); + $form['container_model_uris']['#required'] = FALSE; + } + + return parent::buildForm($form, $form_state); + } + + public function submitForm(array &$form, FormStateInterface $form_state): void { + $selected = array_values(array_filter($form_state->getValue('container_model_uris') ?? [])); + $this->config('islandora_collection_manager.settings') + ->set('container_model_uris', $selected) + ->save(); + parent::submitForm($form, $form_state); + } + +} diff --git a/src/Service/DescendantFinder.php b/src/Service/DescendantFinder.php new file mode 100644 index 0000000..9616470 --- /dev/null +++ b/src/Service/DescendantFinder.php @@ -0,0 +1,46 @@ +entityTypeManager->getStorage('node'); + $visited = [$root_nid => TRUE]; + $queue = [$root_nid]; + $descendants = []; + + while ($queue) { + $parent_ids = array_splice($queue, 0, 100); + $query = $storage->getQuery() + ->accessCheck(TRUE) + ->condition('field_member_of.target_id', $parent_ids, 'IN'); + $child_ids = array_map('intval', array_values($query->execute())); + + foreach ($child_ids as $child_id) { + if (!isset($visited[$child_id])) { + $visited[$child_id] = TRUE; + $descendants[] = $child_id; + $queue[] = $child_id; + } + } + } + + return $descendants; + } + +} diff --git a/src/Service/ModelHelper.php b/src/Service/ModelHelper.php new file mode 100644 index 0000000..ba44391 --- /dev/null +++ b/src/Service/ModelHelper.php @@ -0,0 +1,137 @@ + + * Terms keyed by term ID. + */ + public function getModelTerms(): array { + $storage = $this->entityTypeManager->getStorage('taxonomy_term'); + $ids = $storage->getQuery() + ->accessCheck(TRUE) + ->condition('vid', 'islandora_models') + ->exists('field_external_uri') + ->sort('name') + ->execute(); + + if (!$ids) { + return []; + } + + $terms = $storage->loadMultiple($ids); + return array_filter($terms, static function ($term): bool { + return $term instanceof TermInterface + && $term->bundle() === 'islandora_models' + && $term->hasField('field_external_uri') + && !$term->get('field_external_uri')->isEmpty(); + }); + } + + /** + * Returns the external URI stored on an Islandora model term. + * + * field_external_uri is normally a Link field, whose property is `uri`, + * but accepting `value` as a fallback keeps this compatible with sites + * using a plain string field. + */ + public function getTermExternalUri(TermInterface $term): string { + if (!$term->hasField('field_external_uri')) { + return ''; + } + + $item = $term->get('field_external_uri')->first(); + if (!$item) { + return ''; + } + + $properties = $item->getValue(); + return trim((string) ($properties['uri'] ?? $properties['value'] ?? '')); + } + + /** + * Returns model choices keyed by URI and labelled with taxonomy term name. + */ + public function getModelUriOptions(): array { + $options = []; + foreach ($this->getModelTerms() as $term) { + $uri = $this->getTermExternalUri($term); + if ($uri !== '') { + $options[$uri] = $term->label(); + } + } + asort($options, SORT_NATURAL | SORT_FLAG_CASE); + return $options; + } + + /** + * Returns term IDs for a list of model URIs. + */ + public function termIdsForUris(array $uris): array { + $wanted = array_fill_keys(array_filter(array_map('strval', $uris)), TRUE); + if (!$wanted) { + return []; + } + + $ids = []; + foreach ($this->getModelTerms() as $tid => $term) { + $uri = $this->getTermExternalUri($term); + if (isset($wanted[$uri])) { + $ids[] = (int) $tid; + } + } + return $ids; + } + + /** + * Returns the configured container-model URIs. + */ + public function getContainerModelUris(): array { + $uris = $this->configFactory + ->get('islandora_collection_manager.settings') + ->get('container_model_uris') ?? []; + return array_values(array_filter(array_map('strval', $uris))); + } + + /** + * Returns configured container model term IDs. + */ + public function getContainerModelTermIds(): array { + return $this->termIdsForUris($this->getContainerModelUris()); + } + + /** + * Determines whether a node has one of the configured container models. + */ + public function nodeIsConfiguredContainer($node): bool { + if (!$node || !$node->hasField('field_model')) { + return FALSE; + } + $allowed = array_fill_keys($this->getContainerModelTermIds(), TRUE); + foreach ($node->get('field_model')->getValue() as $item) { + if (isset($allowed[(int) ($item['target_id'] ?? 0)])) { + return TRUE; + } + } + return FALSE; + } + +}