From 4ba1816ed91fcb5f7ab77b56145496fc63332248 Mon Sep 17 00:00:00 2001 From: Jared Whiklo Date: Thu, 29 Nov 2018 10:39:31 -0600 Subject: [PATCH] Abstract derivative events and bring image/video in-house (#103) * Make image, video as submodules * Fix branch names and Travis pointers * Deduplicate test code * Return the account * Make queue configurable Remove extraneous CONTRIBUTING.md and composer.json --- config/schema/islandora.schema.yml | 12 +- islandora.info.yml | 2 +- modules/islandora_image/.travis.yml | 41 +++ modules/islandora_image/LICENSE | 339 ++++++++++++++++++ modules/islandora_image/README.md | 23 ++ .../config/schema/islandora_image.info.yml | 28 ++ .../islandora_image/islandora_image.info.yml | 7 + .../islandora_image/islandora_image.module | 24 ++ .../Plugin/Action/GenerateImageDerivative.php | 55 +++ .../tests/fixtures/test_file.txt | 1 + .../GenerateImageDerivativeTest.php | 84 +++++ modules/islandora_video/LICENSE | 339 ++++++++++++++++++ modules/islandora_video/README.md | 23 ++ .../config/schema/islandora_video.info.yml | 28 ++ .../islandora_video/islandora_video.info.yml | 7 + .../islandora_video/islandora_video.module | 32 ++ .../Plugin/Action/GenerateVideoDerivative.php | 54 +++ .../tests/fixtures/test_file.txt | 1 + .../GenerateVideoDerivativeTest.php | 82 +++++ .../Action/AbstractGenerateDerivative.php | 301 ++++++++++++++++ .../Functional/GenerateDerivativeTestBase.php | 116 ++++++ .../IslandoraFunctionalTestBase.php | 54 +++ tests/src/Functional/LinkHeaderTest.php | 36 +- 23 files changed, 1649 insertions(+), 40 deletions(-) create mode 100644 modules/islandora_image/.travis.yml create mode 100644 modules/islandora_image/LICENSE create mode 100644 modules/islandora_image/README.md create mode 100644 modules/islandora_image/config/schema/islandora_image.info.yml create mode 100644 modules/islandora_image/islandora_image.info.yml create mode 100644 modules/islandora_image/islandora_image.module create mode 100644 modules/islandora_image/src/Plugin/Action/GenerateImageDerivative.php create mode 100644 modules/islandora_image/tests/fixtures/test_file.txt create mode 100644 modules/islandora_image/tests/src/Functional/GenerateImageDerivativeTest.php create mode 100644 modules/islandora_video/LICENSE create mode 100644 modules/islandora_video/README.md create mode 100644 modules/islandora_video/config/schema/islandora_video.info.yml create mode 100644 modules/islandora_video/islandora_video.info.yml create mode 100644 modules/islandora_video/islandora_video.module create mode 100644 modules/islandora_video/src/Plugin/Action/GenerateVideoDerivative.php create mode 100644 modules/islandora_video/tests/fixtures/test_file.txt create mode 100644 modules/islandora_video/tests/src/Functional/GenerateVideoDerivativeTest.php create mode 100644 src/Plugin/Action/AbstractGenerateDerivative.php create mode 100644 tests/src/Functional/GenerateDerivativeTestBase.php diff --git a/config/schema/islandora.schema.yml b/config/schema/islandora.schema.yml index ad59a82c..d786a9a5 100644 --- a/config/schema/islandora.schema.yml +++ b/config/schema/islandora.schema.yml @@ -3,13 +3,13 @@ islandora.settings: label: 'Islandora Core Settings' mapping: broker_url: - type: string + type: string label: 'Url to connect to message broker' fedora_rest_endpoint: - type: string + type: string label: 'Url to Fedora instance' broadcast_queue: - type: string + type: string label: 'Queue that handles distributing messages amongst multiple recipients' action.configuration.emit_node_event: @@ -68,21 +68,21 @@ condition.plugin.node_has_term: type: condition.plugin mapping: uri: - type: text + type: text label: 'Taxonomy Term URI' condition.plugin.media_has_term: type: condition.plugin mapping: uri: - type: text + type: text label: 'Taxonomy Term URI' condition.plugin.parent_node_has_term: type: condition.plugin mapping: uri: - type: text + type: text label: 'Taxonomy Term URI' condition.plugin.file_uses_filesystem: diff --git a/islandora.info.yml b/islandora.info.yml index 0c0dbf0f..0e0a265e 100644 --- a/islandora.info.yml +++ b/islandora.info.yml @@ -3,7 +3,7 @@ name: 'islandora' description: "Islandora Core" type: module -package: islandora +package: Islandora core: 8.x dependencies: - block diff --git a/modules/islandora_image/.travis.yml b/modules/islandora_image/.travis.yml new file mode 100644 index 00000000..41cf7d9e --- /dev/null +++ b/modules/islandora_image/.travis.yml @@ -0,0 +1,41 @@ + +sudo: true +language: php +php: + - 7.1 + - 7.2 + +matrix: + fast_finish: true + +branches: + only: + - /^8.x/ + +before_install: + - export SCRIPT_DIR=$HOME/CLAW/.scripts + - export DRUPAL_DIR=/opt/drupal + - export COMPOSER_PATH="/home/travis/.phpenv/versions/$TRAVIS_PHP_VERSION/bin/composer" + +install: + - git clone https://github.com/Islandora-CLAW/CLAW.git $HOME/CLAW + - $SCRIPT_DIR/travis_setup_drupal.sh + - git -C "$TRAVIS_BUILD_DIR" checkout -b travis-testing + - cd $DRUPAL_DIR; + - php -dmemory_limit=-1 $COMPOSER_PATH config repositories.local path "$TRAVIS_BUILD_DIR" + - php -dmemory_limit=-1 $COMPOSER_PATH require "islandora/islandora_image:dev-travis-testing as dev-8.x-1.x" --prefer-source + - cd web; drush en -y islandora_image + +script: + - $SCRIPT_DIR/line_endings.sh $TRAVIS_BUILD_DIR + - phpcs --standard=Drupal --ignore=*.md --extensions=php,module,inc,install,test,profile,theme,css,info $TRAVIS_BUILD_DIR + - phpcpd --names *.module,*.inc,*.test,*.php $TRAVIS_BUILD_DIR + - php core/scripts/run-tests.sh --url http://127.0.0.1:8282 --suppress-deprecations --verbose --php `which php` --module "islandora_image" + +notifications: + irc: + channels: + - "irc.freenode.org#islandora" + on_success: change + on_failure: always + skip_join: true diff --git a/modules/islandora_image/LICENSE b/modules/islandora_image/LICENSE new file mode 100644 index 00000000..ecbc0593 --- /dev/null +++ b/modules/islandora_image/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. \ No newline at end of file diff --git a/modules/islandora_image/README.md b/modules/islandora_image/README.md new file mode 100644 index 00000000..119ad359 --- /dev/null +++ b/modules/islandora_image/README.md @@ -0,0 +1,23 @@ +# ![Islandora Image](https://cloud.githubusercontent.com/assets/2371345/24199472/6f7bfb7a-0ee8-11e7-9c94-754762fd5566.png) Islandora Image +[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](../../CONTRIBUTING.md) +[![LICENSE](https://img.shields.io/badge/license-GPLv2-blue.svg?style=flat-square)](./LICENSE) + +## Introduction + +Islandora Image module for Drupal 8.2.x + +## Maintainers + +Current maintainers: + +* [Danny Lamb](https://github.com/dannylamb) + +## Development + +If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki). We love to hear from you! + +If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor Licencse Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information. + +## License + +[GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt) diff --git a/modules/islandora_image/config/schema/islandora_image.info.yml b/modules/islandora_image/config/schema/islandora_image.info.yml new file mode 100644 index 00000000..350516d0 --- /dev/null +++ b/modules/islandora_image/config/schema/islandora_image.info.yml @@ -0,0 +1,28 @@ +action.configuration.generate_image_derivative: + type: mapping + label: 'Generate an image derivative...' + mapping: + queue: + type: text + label: 'Queue' + event: + type: text + label: 'Event Type' + source_term_uri: + type: text + label: 'Source term uri' + derivative_term_uri: + type: text + label: 'Destination term uri' + mimetype: + type: text + label: 'Image Mimetype' + args: + type: text + label: 'Convert Arguments' + scheme: + type: text + label: 'Flysystem scheme' + path: + type: text + label: 'File path with extension' diff --git a/modules/islandora_image/islandora_image.info.yml b/modules/islandora_image/islandora_image.info.yml new file mode 100644 index 00000000..fe5ef2cf --- /dev/null +++ b/modules/islandora_image/islandora_image.info.yml @@ -0,0 +1,7 @@ +name: 'Islandora Image' +type: module +description: 'Islandora Image derivative actions' +core: 8.x +package: Islandora +dependencies: + - islandora diff --git a/modules/islandora_image/islandora_image.module b/modules/islandora_image/islandora_image.module new file mode 100644 index 00000000..41a7a585 --- /dev/null +++ b/modules/islandora_image/islandora_image.module @@ -0,0 +1,24 @@ +' . t('About') . ''; + $output .= '

' . t('Islandora Image') . '

'; + return $output; + + default: + } +} diff --git a/modules/islandora_image/src/Plugin/Action/GenerateImageDerivative.php b/modules/islandora_image/src/Plugin/Action/GenerateImageDerivative.php new file mode 100644 index 00000000..4e6a36e2 --- /dev/null +++ b/modules/islandora_image/src/Plugin/Action/GenerateImageDerivative.php @@ -0,0 +1,55 @@ +getValue('mimetype')); + + if ($exploded_mime[0] != "image") { + $form_state->setErrorByName( + 'mimetype', + t('Please enter an image mimetype (e.g. image/jpeg, image/png, etc...)') + ); + } + } + +} diff --git a/modules/islandora_image/tests/fixtures/test_file.txt b/modules/islandora_image/tests/fixtures/test_file.txt new file mode 100644 index 00000000..fafd7451 --- /dev/null +++ b/modules/islandora_image/tests/fixtures/test_file.txt @@ -0,0 +1 @@ +TEST FILE diff --git a/modules/islandora_image/tests/src/Functional/GenerateImageDerivativeTest.php b/modules/islandora_image/tests/src/Functional/GenerateImageDerivativeTest.php new file mode 100644 index 00000000..69e18ba7 --- /dev/null +++ b/modules/islandora_image/tests/src/Functional/GenerateImageDerivativeTest.php @@ -0,0 +1,84 @@ +drupalCreateUser([ + 'bypass node access', + 'administer contexts', + 'administer actions', + 'view media', + 'create media', + 'update media', + ]); + $this->drupalLogin($account); + + // Create an action to generate a jpeg thumbnail. + $this->drupalGet('admin/config/system/actions'); + $this->getSession()->getPage()->findById("edit-action")->selectOption("Generate an image derivative"); + $this->getSession()->getPage()->pressButton(t('Create')); + $this->assertSession()->statusCodeEquals(200); + + $this->getSession()->getPage()->fillField('edit-label', "Generate image test derivative"); + $this->getSession()->getPage()->fillField('edit-id', "generate_image_test_derivative"); + $this->getSession()->getPage()->fillField('edit-queue', "generate-image-test-derivative"); + $this->getSession()->getPage()->fillField("edit-source-term", $this->preservationMasterTerm->label()); + $this->getSession()->getPage()->fillField("edit-derivative-term", $this->serviceFileTerm->label()); + $this->getSession()->getPage()->fillField('edit-mimetype', "image/jpeg"); + $this->getSession()->getPage()->fillField('edit-args', "-thumbnail 20x20"); + $this->getSession()->getPage()->fillField('edit-scheme', "public"); + $this->getSession()->getPage()->fillField('edit-path', "derp.jpeg"); + $this->getSession()->getPage()->pressButton(t('Save')); + $this->assertSession()->statusCodeEquals(200); + + // Create a context and add the action as a derivative reaction. + $this->createContext('Test', 'test'); + $this->addPresetReaction('test', 'derivative', "generate_image_test_derivative"); + $this->assertSession()->statusCodeEquals(200); + + // Create a new preservation master belonging to the node. + $values = [ + 'name[0][value]' => 'Test Media', + 'files[field_media_file_0]' => __DIR__ . '/../../fixtures/test_file.txt', + 'field_media_of[0][target_id]' => 'Test Node', + 'field_tags[0][target_id]' => 'Preservation Master', + ]; + $this->drupalPostForm('media/add/' . $this->testMediaType->id(), $values, t('Save')); + + $expected = [ + 'source_uri' => 'test_file.txt', + 'destination_uri' => "node/1/media/{$this->testMediaType->id()}/3", + 'file_upload_uri' => 'public://derp.jpeg', + 'mimetype' => 'image/jpeg', + 'args' => '-thumbnail 20x20', + 'queue' => 'islandora-connector-houdini', + ]; + + // Check the message gets published and is of the right shape. + $this->checkMessage($expected); + } + +} diff --git a/modules/islandora_video/LICENSE b/modules/islandora_video/LICENSE new file mode 100644 index 00000000..ecbc0593 --- /dev/null +++ b/modules/islandora_video/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. \ No newline at end of file diff --git a/modules/islandora_video/README.md b/modules/islandora_video/README.md new file mode 100644 index 00000000..9d12b386 --- /dev/null +++ b/modules/islandora_video/README.md @@ -0,0 +1,23 @@ +# Islandora Video +[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](../../CONTRIBUTING.md) +[![LICENSE](https://img.shields.io/badge/license-GPLv2-blue.svg?style=flat-square)](./LICENSE) + +## Introduction + +Islandora Video module for Drupal 8.2.x + +## Maintainers + +Current maintainers: + +* [Danny Lamb](https://github.com/dannylamb) + +## Development + +If you would like to contribute, please get involved by attending our weekly [Tech Call](https://github.com/Islandora-CLAW/CLAW/wiki). We love to hear from you! + +If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](http://islandora.ca/sites/default/files/islandora_cla.pdf) or [Corporate Contributor Licencse Agreement](http://islandora.ca/sites/default/files/islandora_ccla.pdf). Please see the [Contributors](http://islandora.ca/resources/contributors) pages on Islandora.ca for more information. + +## License + +[GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt) diff --git a/modules/islandora_video/config/schema/islandora_video.info.yml b/modules/islandora_video/config/schema/islandora_video.info.yml new file mode 100644 index 00000000..2d54e4b0 --- /dev/null +++ b/modules/islandora_video/config/schema/islandora_video.info.yml @@ -0,0 +1,28 @@ +action.configuration.generate_video_derivative: + type: mapping + label: 'Generate a video derivative...' + mapping: + queue: + type: text + label: 'Queue' + event: + type: text + label: 'Event Type' + source_term_uri: + type: text + label: 'Source term uri' + derivative_term_uri: + type: text + label: 'Destination term uri' + mimetype: + type: text + label: 'Video Mimetype' + args: + type: text + label: 'FFMpeg Arguments' + scheme: + type: text + label: 'Flysystem scheme' + path: + type: text + label: 'File path with extension' diff --git a/modules/islandora_video/islandora_video.info.yml b/modules/islandora_video/islandora_video.info.yml new file mode 100644 index 00000000..bccc6c80 --- /dev/null +++ b/modules/islandora_video/islandora_video.info.yml @@ -0,0 +1,7 @@ +name: 'Islandora Video' +description: 'Islandora video derivative actions' +type: module +package: Islandora +core: 8.x +dependencies: + - islandora diff --git a/modules/islandora_video/islandora_video.module b/modules/islandora_video/islandora_video.module new file mode 100644 index 00000000..d45baf06 --- /dev/null +++ b/modules/islandora_video/islandora_video.module @@ -0,0 +1,32 @@ +' . t('About') . ''; + $output .= '

' . t('Islandora Video adds video derivative actions.') . '

'; + $output .= '

' . t('These can be used with microservices to automatically generate derivative videos.') . '

'; + return $output; + + default: + } +} diff --git a/modules/islandora_video/src/Plugin/Action/GenerateVideoDerivative.php b/modules/islandora_video/src/Plugin/Action/GenerateVideoDerivative.php new file mode 100644 index 00000000..81d5ac7c --- /dev/null +++ b/modules/islandora_video/src/Plugin/Action/GenerateVideoDerivative.php @@ -0,0 +1,54 @@ +getValue('mimetype')); + if ($exploded_mime[0] != 'video') { + $form_state->setErrorByName( + 'mimetype', + t('Please enter a video mimetype (e.g. video/mp4, video/quicktime, etc...)') + ); + } + } + +} diff --git a/modules/islandora_video/tests/fixtures/test_file.txt b/modules/islandora_video/tests/fixtures/test_file.txt new file mode 100644 index 00000000..e60b7106 --- /dev/null +++ b/modules/islandora_video/tests/fixtures/test_file.txt @@ -0,0 +1 @@ +THIS IS A TEST diff --git a/modules/islandora_video/tests/src/Functional/GenerateVideoDerivativeTest.php b/modules/islandora_video/tests/src/Functional/GenerateVideoDerivativeTest.php new file mode 100644 index 00000000..64bd6d4a --- /dev/null +++ b/modules/islandora_video/tests/src/Functional/GenerateVideoDerivativeTest.php @@ -0,0 +1,82 @@ +drupalCreateUser([ + 'bypass node access', + 'administer contexts', + 'administer actions', + 'view media', + 'create media', + 'update media', + ]); + $this->drupalLogin($account); + + // Create an action to generate a jpeg thumbnail. + $this->drupalGet('admin/config/system/actions'); + $this->getSession()->getPage()->findById("edit-action")->selectOption("Generate a video derivative"); + $this->getSession()->getPage()->pressButton(t('Create')); + $this->assertSession()->statusCodeEquals(200); + + $this->getSession()->getPage()->fillField('edit-label', "Generate video test derivative"); + $this->getSession()->getPage()->fillField('edit-id', "generate_video_test_derivative"); + $this->getSession()->getPage()->fillField('edit-queue', "generate-video-test-derivative"); + $this->getSession()->getPage()->fillField("edit-source-term", $this->preservationMasterTerm->label()); + $this->getSession()->getPage()->fillField("edit-derivative-term", $this->serviceFileTerm->label()); + $this->getSession()->getPage()->fillField('edit-mimetype', "video/mp4"); + $this->getSession()->getPage()->fillField('edit-args', "-f mp4"); + $this->getSession()->getPage()->fillField('edit-scheme', "public"); + $this->getSession()->getPage()->fillField('edit-path', "derp.mov"); + $this->getSession()->getPage()->pressButton(t('Save')); + $this->assertSession()->statusCodeEquals(200); + + // Create a context and add the action as a derivative reaction. + $this->createContext('Test', 'test'); + $this->addPresetReaction('test', 'derivative', "generate_video_test_derivative"); + $this->assertSession()->statusCodeEquals(200); + + // Create a new preservation master belonging to the node. + $values = [ + 'name[0][value]' => 'Test Media', + 'files[field_media_file_0]' => __DIR__ . '/../../fixtures/test_file.txt', + 'field_media_of[0][target_id]' => 'Test Node', + 'field_tags[0][target_id]' => 'Preservation Master', + ]; + $this->drupalPostForm('media/add/' . $this->testMediaType->id(), $values, t('Save')); + + $expected = [ + 'source_uri' => 'test_file.txt', + 'destination_uri' => "node/1/media/{$this->testMediaType->id()}/3", + 'file_upload_uri' => 'public://derp.mov', + 'mimetype' => 'video/mp4', + 'args' => '-f mp4', + 'queue' => 'islandora-connector-homarus', + ]; + + // Check the message gets published and is of the right shape. + $this->checkMessage($expected); + } + +} diff --git a/src/Plugin/Action/AbstractGenerateDerivative.php b/src/Plugin/Action/AbstractGenerateDerivative.php new file mode 100644 index 00000000..d7acc5a2 --- /dev/null +++ b/src/Plugin/Action/AbstractGenerateDerivative.php @@ -0,0 +1,301 @@ +utils = $utils; + $this->mediaSource = $media_source; + $this->token = $token; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { + return new static( + $configuration, + $plugin_id, + $plugin_definition, + $container->get('current_user'), + $container->get('entity_type.manager'), + $container->get('islandora.eventgenerator'), + $container->get('islandora.stomp'), + $container->get('jwt.authentication.jwt'), + $container->get('islandora.utils'), + $container->get('islandora.media_source_service'), + $container->get('token') + ); + } + + /** + * {@inheritdoc} + */ + public function defaultConfiguration() { + return [ + 'queue' => 'islandora-connector-houdini', + 'event' => 'Generate Derivative', + 'source_term_uri' => '', + 'derivative_term_uri' => '', + 'mimetype' => '', + 'args' => '', + 'scheme' => file_default_scheme(), + 'path' => '[date:custom:Y]-[date:custom:m]/[node:nid].bin', + ]; + } + + /** + * Override this to return arbitrary data as an array to be json encoded. + */ + protected function generateData(EntityInterface $entity) { + $data = parent::generateData($entity); + + // Find media belonging to node that has the source term, and set its file + // url in the data array. + $source_term = $this->utils->getTermForUri($this->configuration['source_term_uri']); + if (!$source_term) { + throw new \RuntimeException("Could not locate source term with uri" . $this->configuration['source_term_uri'], 500); + } + + $source_media = $this->utils->getMediaWithTerm($entity, $source_term); + if (!$source_media) { + throw new \RuntimeException("Could not locate source media", 500); + } + + $source_file = $this->mediaSource->getSourceFile($source_media); + if (!$source_file) { + throw new \RuntimeException("Could not locate source file for media {$source_media->id()}", 500); + } + + $data['source_uri'] = $source_file->url('canonical', ['absolute' => TRUE]); + + // Find the term for the derivative and use it to set the destination url + // in the data array. + $derivative_term = $this->utils->getTermForUri($this->configuration['derivative_term_uri']); + if (!$source_term) { + throw new \RuntimeException("Could not locate derivative term with uri" . $this->configuration['derivative_term_uri'], 500); + } + + $route_params = [ + 'node' => $entity->id(), + 'media_type' => $source_media->bundle(), + 'taxonomy_term' => $derivative_term->id(), + ]; + $data['destination_uri'] = Url::fromRoute('islandora.media_source_put_to_node', $route_params) + ->setAbsolute() + ->toString(); + + $token_data = [ + 'node' => $entity, + 'media' => $source_media, + 'term' => $derivative_term, + ]; + $path = $this->token->replace($data['path'], $token_data); + $data['file_upload_uri'] = $data['scheme'] . '://' . $path; + + // Get rid of some config so we just pass along + // what the camel route and microservice need. + unset($data['source_term_uri']); + unset($data['derivative_term_uri']); + unset($data['path']); + unset($data['scheme']); + + return $data; + } + + /** + * {@inheritdoc} + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state) { + $schemes = $this->utils->getFilesystemSchemes(); + $scheme_options = array_combine($schemes, $schemes); + + $form = parent::buildConfigurationForm($form, $form_state); + $form['event']['#disabled'] = 'disabled'; + + $form['source_term'] = [ + '#type' => 'entity_autocomplete', + '#target_type' => 'taxonomy_term', + '#title' => t('Source term'), + '#default_value' => $this->utils->getTermForUri($this->configuration['source_term_uri']), + '#required' => TRUE, + '#description' => t('Term indicating the source media'), + ]; + $form['derivative_term'] = [ + '#type' => 'entity_autocomplete', + '#target_type' => 'taxonomy_term', + '#title' => t('Derivative term'), + '#default_value' => $this->utils->getTermForUri($this->configuration['derivative_term_uri']), + '#required' => TRUE, + '#description' => t('Term indicating the derivative media'), + ]; + $form['mimetype'] = [ + '#type' => 'textfield', + '#title' => t('Mimetype'), + '#default_value' => $this->configuration['mimetype'], + '#required' => TRUE, + '#rows' => '8', + '#description' => t('Mimetype to convert to (e.g. image/jpeg, video/mp4, etc...)'), + ]; + $form['args'] = [ + '#type' => 'textfield', + '#title' => t('Additional arguments'), + '#default_value' => $this->configuration['args'], + '#rows' => '8', + '#description' => t('Additional command line arguments'), + ]; + $form['scheme'] = [ + '#type' => 'select', + '#title' => t('File system'), + '#options' => $scheme_options, + '#default_value' => $this->configuration['scheme'], + '#required' => TRUE, + ]; + $form['path'] = [ + '#type' => 'textfield', + '#title' => t('File path'), + '#default_value' => $this->configuration['path'], + '#description' => t('Path within the upload destination where files will be stored. Includes the filename and optional extension.'), + ]; + $form['queue'] = [ + '#type' => 'textfield', + '#title' => t('Queue name'), + '#default_value' => $this->configuration['queue'], + '#description' => t('Queue name to send along to help routing events, CHANGE WITH CARE. Defaults to :queue', [ + ':queue' => $this->defaultConfiguration()['queue'], + ]), + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::validateConfigurationForm($form, $form_state); + + $exploded_mime = explode('/', $form_state->getValue('mimetype')); + + if (count($exploded_mime) != 2) { + $form_state->setErrorByName( + 'mimetype', + t('Please enter a mimetype (e.g. image/jpeg, video/mp4, audio/mp3, etc...)') + ); + } + + if (empty($exploded_mime[1])) { + $form_state->setErrorByName( + 'mimetype', + t('Please enter a mimetype (e.g. image/jpeg, video/mp4, audio/mp3, etc...)') + ); + } + } + + /** + * {@inheritdoc} + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + parent::submitConfigurationForm($form, $form_state); + + $tid = $form_state->getValue('source_term'); + $term = $this->entityTypeManager->getStorage('taxonomy_term')->load($tid); + $this->configuration['source_term_uri'] = $this->utils->getUriForTerm($term); + + $tid = $form_state->getValue('derivative_term'); + $term = $this->entityTypeManager->getStorage('taxonomy_term')->load($tid); + $this->configuration['derivative_term_uri'] = $this->utils->getUriForTerm($term); + + $this->configuration['mimetype'] = $form_state->getValue('mimetype'); + $this->configuration['args'] = $form_state->getValue('args'); + $this->configuration['scheme'] = $form_state->getValue('scheme'); + $this->configuration['path'] = trim($form_state->getValue('path'), '\\/'); + } + +} diff --git a/tests/src/Functional/GenerateDerivativeTestBase.php b/tests/src/Functional/GenerateDerivativeTestBase.php new file mode 100644 index 00000000..b650ca3b --- /dev/null +++ b/tests/src/Functional/GenerateDerivativeTestBase.php @@ -0,0 +1,116 @@ +createUserAndLogin(); + $this->createImageTag(); + $this->createPreservationMasterTag(); + + // 'Service File' tag. + $this->serviceFileTerm = $this->container->get('entity_type.manager')->getStorage('taxonomy_term')->create([ + 'name' => 'Service File', + 'vid' => $this->testVocabulary->id(), + 'field_external_uri' => [['uri' => "http://pcdm.org/use#ServiceFile"]], + ]); + $this->serviceFileTerm->save(); + + // Node to be referenced via media_of. + $this->node = $this->container->get('entity_type.manager')->getStorage('node')->create([ + 'type' => $this->testType->id(), + 'title' => 'Test Node', + 'field_tags' => [$this->imageTerm->id()], + ]); + $this->node->save(); + } + + /** + * Asserts a derivative event was delivered. + * + * @param array $expected + * The expected values. + */ + protected function checkMessage(array $expected) { + // Verify message is sent. + $stomp = $this->container->get('islandora.stomp'); + try { + $stomp->subscribe('generate-test-derivative'); + while ($msg = $stomp->read()) { + $headers = $msg->getHeaders(); + $this->assertTrue( + isset($headers['Authorization']), + "Authorization header must be set" + ); + $matches = []; + $this->assertTrue( + preg_match('/^Bearer (.*)/', $headers['Authorization'], $matches), + "Authorization header must be a bearer token" + ); + $this->assertTrue( + count($matches) == 2 && !empty($matches[1]), + "Bearer token must not be empty" + ); + + $body = $msg->getBody(); + $body = json_decode($body, TRUE); + + $type = $body['type']; + $this->assertTrue($type == 'Activity', "Expected 'Activity', received $type"); + + $summary = $body['summary']; + $this->assertTrue($summary == 'Generate Derivative', "Expected 'Generate Derivative', received $summary"); + + $content = $body['attachment']['content']; + $this->assertTrue( + strpos($content['source_uri'], $expected['source_uri']) !== FALSE, + "Expected source uri should contain the file." + ); + + $this->assertTrue( + strpos($content['destination_uri'], $expected['destination_uri']) !== FALSE, + "Expected destination uri should reference both node and term" + ); + $this->assertEquals($expected['file_upload_uri'], + $content['file_upload_uri'], + "Expected file upload uri should contain the scheme and path of the derivative" + ); + + $this->assertEquals($expected['mimetype'], $content['mimetype'], "Expected mimetype '{$expected['mimetype']}', received {$content['mimetype']}"); + + $this->assertEquals($expected['args'], $content['args'], "Expected bundle '{$expected['args']}', received {$content['args']}"); + + } + $stomp->unsubscribe(); + } + catch (StompException $e) { + $this->assertTrue(FALSE, "There was an error connecting to the stomp broker"); + } + } + +} diff --git a/tests/src/Functional/IslandoraFunctionalTestBase.php b/tests/src/Functional/IslandoraFunctionalTestBase.php index b9f99dd0..733d24a6 100644 --- a/tests/src/Functional/IslandoraFunctionalTestBase.php +++ b/tests/src/Functional/IslandoraFunctionalTestBase.php @@ -37,6 +37,20 @@ class IslandoraFunctionalTestBase extends BrowserTestBase { protected $testVocabulary; + /** + * Term to belong to the node. + * + * @var \Drupal\taxonomy\TermInterface + */ + protected $imageTerm; + + /** + * Term to belong to the source media. + * + * @var \Drupal\taxonomy\TermInterface + */ + protected $preservationMasterTerm; + /** * {@inheritdoc} */ @@ -161,6 +175,46 @@ EOD; $this->container->get('router.builder')->rebuild(); } + /** + * Create a new user and log them in. + */ + protected function createUserAndLogin() { + // Create a test user. + $account = $this->drupalCreateUser(); + $this->drupalLogin($account); + return $account; + } + + /** + * Create an Image tag. + * + * @throws \Drupal\Core\Entity\EntityStorageException + */ + protected function createImageTag() { + // 'Image' tag. + $this->imageTerm = $this->container->get('entity_type.manager')->getStorage('taxonomy_term')->create([ + 'name' => 'Image', + 'vid' => $this->testVocabulary->id(), + 'field_external_uri' => [['uri' => "http://purl.org/coar/resource_type/c_c513"]], + ]); + $this->imageTerm->save(); + } + + /** + * Create a Preservation Master tag. + * + * @throws \Drupal\Core\Entity\EntityStorageException + */ + protected function createPreservationMasterTag() { + // 'Preservation Master' tag. + $this->preservationMasterTerm = $this->container->get('entity_type.manager')->getStorage('taxonomy_term')->create([ + 'name' => 'Preservation Master', + 'vid' => $this->testVocabulary->id(), + 'field_external_uri' => [['uri' => "http://pcdm.org/use#PreservationMasterFile"]], + ]); + $this->preservationMasterTerm->save(); + } + /** * Creates a test context. */ diff --git a/tests/src/Functional/LinkHeaderTest.php b/tests/src/Functional/LinkHeaderTest.php index 9f7f8328..472986c2 100644 --- a/tests/src/Functional/LinkHeaderTest.php +++ b/tests/src/Functional/LinkHeaderTest.php @@ -39,45 +39,15 @@ class LinkHeaderTest extends IslandoraFunctionalTestBase { */ protected $file; - /** - * Term to belong to the referencer. - * - * @var \Drupal\taxonomy\TermInterface - */ - protected $imageTerm; - - /** - * Term to belong to the media. - * - * @var \Drupal\taxonomy\TermInterface - */ - protected $preservationMasterTerm; - /** * {@inheritdoc} */ public function setUp() { parent::setUp(); - // Create a test user. - $account = $this->drupalCreateUser(); - $this->drupalLogin($account); - - // 'Image' tag. - $this->imageTerm = $this->container->get('entity_type.manager')->getStorage('taxonomy_term')->create([ - 'name' => 'Image', - 'vid' => $this->testVocabulary->id(), - 'field_external_uri' => [['uri' => "http://purl.org/coar/resource_type/c_c513"]], - ]); - $this->imageTerm->save(); - - // 'Preservation Master' tag. - $this->preservationMasterTerm = $this->container->get('entity_type.manager')->getStorage('taxonomy_term')->create([ - 'name' => 'Preservation Master', - 'vid' => $this->testVocabulary->id(), - 'field_external_uri' => [['uri' => "http://pcdm.org/use#PreservationMasterFile"]], - ]); - $this->preservationMasterTerm->save(); + $account = $this->createUserAndLogin(); + $this->createImageTag(); + $this->createPreservationMasterTag(); // Node to be referenced via member of. $this->referenced = $this->container->get('entity_type.manager')->getStorage('node')->create([