diff --git a/plugins/arZoomPanPlugin/LICENSE b/plugins/arZoomPanPlugin/LICENSE new file mode 100644 index 0000000000..e62ec04cde --- /dev/null +++ b/plugins/arZoomPanPlugin/LICENSE @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. 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 +them 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 prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + 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 +state 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 3 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program 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, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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. But first, please read +. diff --git a/plugins/arZoomPanPlugin/README.md b/plugins/arZoomPanPlugin/README.md new file mode 100644 index 0000000000..3803b8d1c7 --- /dev/null +++ b/plugins/arZoomPanPlugin/README.md @@ -0,0 +1,341 @@ +# arZoomPan Plugin for AtoM + +## Overview + +The arZoomPan plugin provides advanced document viewing capabilities for AtoM (Access to Memory), including zoom, pan, and rotate functionality similar to IIIF viewers. It supports images, PDFs, and text documents. + +## Features + +- **Image Viewer**: Deep zoom with tile-based loading for large images +- **PDF Viewer**: Page navigation with zoom and pan for PDF documents +- **Text Viewer**: Zoomable text display for documents (TXT, DOC, DOCX, ODT) +- **Universal Controls**: Zoom in/out, pan, rotate, fullscreen mode +- **Keyboard Shortcuts**: Navigation using keyboard commands +- **Mobile Responsive**: Touch gestures for mobile devices +- **Caching**: Tile caching for improved performance +- **Download**: Direct download of original files + +## Requirements + +- AtoM 2.x (tested with 2.9) +- PHP 7.4+ or PHP 8.x +- ImageMagick (for image processing) +- Pandoc (optional, for document conversion) +- pdfinfo (for PDF page counting) + +## Installation + +### 1. Copy Plugin Files + +```bash +# Copy the plugin to your AtoM plugins directory +sudo cp -r /mnt/user-data/outputs/arZoomPanPlugin /usr/share/nginx/atom/plugins/ + +# Set proper permissions +sudo chown -R www-data:www-data /usr/share/nginx/atom/plugins/arZoomPanPlugin +sudo chmod -R 755 /usr/share/nginx/atom/plugins/arZoomPanPlugin +``` + +### 2. Enable the Plugin + +Add to your AtoM configuration file (`config/ProjectConfiguration.class.php`): + +```php +public function setup() +{ + $this->enablePlugins(array( + // ... other plugins + 'arZoomPanPlugin' + )); +} +``` + +### 3. Clear Cache + +```bash +cd /usr/share/nginx/atom +sudo -u www-data php symfony cc +``` + +### 4. Install Dependencies + +```bash +# Install ImageMagick if not already installed +sudo apt-get install imagemagick + +# Install Pandoc for document conversion (optional) +sudo apt-get install pandoc + +# Install poppler-utils for PDF info +sudo apt-get install poppler-utils +``` + +### 5. Create Cache Directory + +```bash +# Create cache directory for tiles +sudo mkdir -p /usr/share/nginx/atom/uploads/zoompan-cache +sudo chown www-data:www-data /usr/share/nginx/atom/uploads/zoompan-cache +sudo chmod 755 /usr/share/nginx/atom/uploads/zoompan-cache +``` + +## Configuration + +### Plugin Settings + +Edit the plugin configuration in `arZoomPanPluginConfiguration.class.php`: + +```php +$settings = array( + 'enable_pdf_viewer' => true, // Enable PDF viewing + 'enable_text_viewer' => true, // Enable text document viewing + 'enable_image_viewer' => true, // Enable image viewing + 'tile_size' => 256, // Tile size in pixels + 'max_zoom_level' => 10, // Maximum zoom level + 'cache_tiles' => true, // Enable tile caching + 'cache_directory' => sfConfig::get('sf_upload_dir') . '/zoompan-cache', + 'supported_formats' => array('jpg', 'jpeg', 'png', 'gif', 'tif', 'tiff', 'pdf', 'txt', 'doc', 'docx', 'odt') +); +``` + +### ImageMagick Limits + +For large images, you may need to adjust ImageMagick limits: + +```bash +sudo nano /etc/ImageMagick-6/policy.xml +``` + +Update these values: +```xml + + + + + +``` + +## Usage + +### In Templates + +To use the viewer in your AtoM templates: + +```php + +
+ +
+ +``` + +Or include the viewer partial: + +```php + $digitalObject, + 'viewerType' => 'auto' // auto-detect based on mime type +)) ?> +``` + +### JavaScript API + +Initialize viewer programmatically: + +```javascript +$('#my-viewer').zoomPanViewer({ + digitalObjectId: 123, + viewerType: 'image', + maxZoom: 20, + enableRotation: true, + enableFullscreen: true +}); + +// Control viewer +var viewer = $('#my-viewer').data('zoom.pan.viewer'); +viewer.zoomIn(); +viewer.zoomOut(); +viewer.resetView(); +viewer.rotateLeft(); +viewer.rotateRight(); +``` + +### Keyboard Shortcuts + +- `+` or `=`: Zoom in +- `-`: Zoom out +- `0`: Reset view +- `Ctrl+←`: Rotate left +- `Ctrl+→`: Rotate right +- `←`: Previous page (PDF) +- `→`: Next page (PDF) +- `Ctrl+F`: Fullscreen + +## API Endpoints + +The plugin provides these endpoints: + +- `/zoompan/info/{id}` - Get document information +- `/zoompan/tile/{id}/{z}/{x}/{y}.{format}` - Get image tile +- `/zoompan/pdf/{id}/{page}` - Get PDF page as image +- `/zoompan/text/{id}` - Get text document as HTML + +## Customization + +### Styling + +Override styles in your theme CSS: + +```css +/* Custom toolbar color */ +.zoom-pan-toolbar { + background: #your-color; +} + +/* Custom viewer height */ +.zoom-pan-viewer { + height: 800px !important; +} + +/* Hide navigator */ +.zoom-pan-navigator { + display: none; +} +``` + +### Extending Functionality + +Create custom handlers: + +```javascript +$(document).on('zoom-pan:loaded', function(e, viewer) { + // Custom initialization +}); + +$(document).on('zoom-pan:zoom', function(e, level) { + console.log('Zoom level:', level); +}); + +$(document).on('zoom-pan:page-change', function(e, page) { + console.log('PDF page:', page); +}); +``` + +## Performance Optimization + +### Tile Caching + +Tiles are automatically cached. To clear cache: + +```bash +sudo rm -rf /usr/share/nginx/atom/uploads/zoompan-cache/* +``` + +### Pre-generate Tiles + +For better performance, pre-generate tiles: + +```bash +cd /usr/share/nginx/atom +sudo -u www-data php symfony zoom-pan:generate-tiles --digital-object-id=123 +``` + +## Troubleshooting + +### Images Not Loading + +1. Check file permissions: +```bash +ls -la /usr/share/nginx/atom/uploads/ +``` + +2. Check ImageMagick: +```bash +convert -version +``` + +3. Check error logs: +```bash +tail -f /var/log/nginx/error.log +``` + +### PDF Not Displaying + +1. Check poppler-utils: +```bash +pdfinfo --version +``` + +2. Verify PDF is not corrupted: +```bash +pdfinfo /path/to/file.pdf +``` + +### Performance Issues + +1. Increase PHP memory limit: +```bash +sudo nano /etc/php/8.3/fpm/php.ini +# Set memory_limit = 512M +``` + +2. Enable OPcache: +```bash +opcache.enable=1 +opcache.memory_consumption=256 +``` + +## Integration with Existing Themes + +### For Bootstrap 5 Themes + +```php +// In your theme's digitalobject/indexSuccess.php + + +
+ 'mb-4', + 'height' => '700px' + )) ?> +
+``` + +### For Default Theme + +```php +// In apps/qubit/modules/digitalobject/templates/showSuccess.php +canAccess()): ?> + $resource + )) ?> + +``` + +## License + +This plugin is open source and follows the same license as AtoM. + +## Support + +For issues or questions: +- Create an issue on GitHub +- Contact: johan@theahg.co.za + +## Credits + +- OpenSeadragon for deep zoom functionality +- PDF.js for PDF rendering +- ImageMagick for image processing +- Pandoc for document conversion + +## Version History + +- 1.0.0 - Initial release + - Image viewer with tiling + - PDF viewer with page navigation + - Text document viewer + - Zoom, pan, rotate functionality + - Mobile responsive design diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/config/arZoomPanPluginConfiguration.class.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/config/arZoomPanPluginConfiguration.class.php new file mode 100644 index 0000000000..37e9d96250 --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/config/arZoomPanPluginConfiguration.class.php @@ -0,0 +1,141 @@ +. + */ + +/** + * arZoomPanPluginConfiguration. + * + * Modified by Johan Pieterse to use arMetadataExtractionPlugin + * + * @subpackage config + */ +class arZoomPanPluginConfiguration extends sfPluginConfiguration +{ + public const VERSION = '1.0.0'; + + public function initialize() + { + // 1. Load custom routes + $this->dispatcher->connect( + 'routing.load_configuration', + [$this, 'addRoutes'] + ); + + // 2. Load helper + $this->dispatcher->connect( + 'template.filter_parameters', + [$this, 'registerHelpers'] + ); + + // 3. Inject JS/CSS + $this->dispatcher->connect( + 'response.filter_content', + [$this, 'injectAssets'] + ); + } + + public function addRoutes(sfEvent $event) + { + $routing = $event->getSubject(); + + // /zoompan/viewer/1552 + $routing->prependRoute( + 'zoompan_viewer', + new sfRoute( + '/zoompan/viewer/:id', + ['module' => 'arZoomPan', 'action' => 'viewer'], + ['id' => '\d+'] + ) + ); + + // /zoompan/info/1552 + $routing->prependRoute( + 'zoompan_info', + new sfRoute( + '/zoompan/info/:id', + ['module' => 'arZoomPan', 'action' => 'info'], + ['id' => '\d+'] + ) + ); + + // /zoompan/tile/1552/10/0/0.jpg + $routing->prependRoute( + 'zoompan_tile', + new sfRoute( + '/zoompan/tile/:id/:z/:x/:y.:format', + ['module' => 'arZoomPan', 'action' => 'tile'], + [ + 'id' => '\d+', + 'z' => '\d+', + 'x' => '\d+', + 'y' => '\d+', + 'format' => '(jpg|png)', + ] + ) + ); + } + + /** + * Register helper functions. + * + * @param sfEvent $event + * @param array $params + * + * @return array + */ + public function registerHelpers($event, $params) + { + $params['helpers'][] = 'ZoomPan'; + + return $params; + } + + /** + * Inject assets into the response. + * + * @param sfEvent $event + * @param string $content + * + * @return string + */ + public function injectAssets(sfEvent $event, $content) + { + $request = sfContext::getInstance()->getRequest(); + + // Only inject on pages displaying digital objects + if (!preg_match('#/(informationobject|digitalobject)#i', $request->getPathInfo())) { + return $content; + } + + // Check if assets already injected + if (false !== strpos($content, 'zoom-pan.js')) { + return $content; + } + + // OpenSeadragon + $osd = ''; + + // Plugin CSS + $css = ''; + + // Plugin JS + $js = ''; + + return str_replace('', $osd . "\n" . $css . "\n" . $js . "\n" . '', $content); + } +} \ No newline at end of file diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/config/routing.yml b/plugins/arZoomPanPlugin/arZoomPanPlugin/config/routing.yml new file mode 100644 index 0000000000..72ec956ae6 --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/config/routing.yml @@ -0,0 +1,19 @@ +zoompan_viewer: + url: /zoompan/viewer/:id + param: { module: arZoomPan, action: viewer } + requirements: { id: \d+ } + +zoompan_info: + url: /zoompan/info/:id + param: { module: arZoomPan, action: info } + requirements: { id: \d+ } + +zoompan_tile: + url: /zoompan/tile/:id/:z/:x/:y.:format + param: { module: arZoomPan, action: tile } + requirements: + id: \d+ + z: \d+ + x: \d+ + y: \d+ + format: (jpg|png) diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/css/zoom-pan.css b/plugins/arZoomPanPlugin/arZoomPanPlugin/css/zoom-pan.css new file mode 100644 index 0000000000..0125fe3b8f --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/css/zoom-pan.css @@ -0,0 +1,301 @@ +/** + * arZoomPan Plugin Styles + * + * Styles for the document viewer with zoom and pan functionality + */ + +/* Main container */ +.zoom-pan-container { + position: relative; + background: #f5f5f5; + border: 1px solid #ddd; + border-radius: 4px; + overflow: hidden; + margin: 20px 0; +} + +/* Toolbar */ +.zoom-pan-toolbar { + background: #333; + padding: 10px; + display: flex; + align-items: center; + border-bottom: 1px solid #222; +} + +.zoom-pan-toolbar .btn { + color: #fff; + background: #555; + border: 1px solid #666; + padding: 5px 10px; + margin: 0 2px; + transition: all 0.3s ease; +} + +.zoom-pan-toolbar .btn:hover { + background: #666; + border-color: #777; + transform: translateY(-1px); +} + +.zoom-pan-toolbar .btn:active { + background: #444; + transform: translateY(0); +} + +.zoom-pan-toolbar .btn i { + font-size: 14px; +} + +/* Page indicator for PDFs */ +.page-indicator { + color: #fff; + font-size: 14px; + display: inline-flex; + align-items: center; + padding: 0 10px; +} + +/* Main viewer */ +.zoom-pan-viewer { + position: relative; + cursor: move; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; +} + +.zoom-pan-viewer.dragging { + cursor: grabbing; +} + +/* OpenSeadragon overrides */ +.zoom-pan-viewer .openseadragon-canvas { + background-color: #1a1a1a !important; +} + +/* Navigator minimap */ +.zoom-pan-navigator { + position: absolute; + top: 10px; + right: 10px; + width: 150px; + height: 120px; + border: 2px solid #fff; + box-shadow: 0 2px 10px rgba(0,0,0,0.5); + background: #000; + z-index: 1000; + opacity: 0.8; + transition: opacity 0.3s ease; +} + +.zoom-pan-navigator:hover { + opacity: 1; +} + +/* Status bar */ +.zoom-pan-status { + background: #2a2a2a; + color: #ccc; + padding: 8px 15px; + font-size: 13px; + border-top: 1px solid #333; + display: flex; + justify-content: space-between; + align-items: center; +} + +.zoom-pan-status span { + display: inline-block; +} + +/* Loading indicator */ +.zoom-pan-loading { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + color: #fff; + font-size: 18px; + text-align: center; + z-index: 1001; +} + +.zoom-pan-loading .spinner { + width: 50px; + height: 50px; + border: 3px solid rgba(255,255,255,0.3); + border-top-color: #fff; + border-radius: 50%; + animation: spin 1s linear infinite; + margin: 0 auto 20px; +} + +@keyframes spin { + to { transform: rotate(360deg); } +} + +/* Error message */ +.zoom-pan-error { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + background: #d9534f; + color: #fff; + padding: 20px; + border-radius: 4px; + text-align: center; + max-width: 400px; +} + +/* Fullscreen mode */ +.zoom-pan-container.fullscreen { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + width: 100%; + height: 100%; + z-index: 9999; + margin: 0; + border-radius: 0; +} + +.zoom-pan-container.fullscreen .zoom-pan-viewer { + height: calc(100% - 100px) !important; +} + +/* Text document viewer */ +.zoom-pan-viewer iframe { + background: white; + transform-origin: top left; + transition: transform 0.3s ease; +} + +/* PDF canvas */ +.zoom-pan-viewer canvas { + display: block; + margin: 0 auto; +} + +/* Thumbnails sidebar (optional) */ +.zoom-pan-thumbnails { + position: absolute; + left: 0; + top: 0; + bottom: 0; + width: 150px; + background: #2a2a2a; + overflow-y: auto; + border-right: 1px solid #333; + padding: 10px; +} + +.zoom-pan-thumbnail { + width: 100%; + margin-bottom: 10px; + cursor: pointer; + border: 2px solid transparent; + transition: border-color 0.3s ease; +} + +.zoom-pan-thumbnail:hover { + border-color: #666; +} + +.zoom-pan-thumbnail.active { + border-color: #007bff; +} + +/* Mobile responsive adjustments */ +@media (max-width: 768px) { + .zoom-pan-toolbar { + flex-wrap: wrap; + padding: 8px; + } + + .zoom-pan-toolbar .btn-group { + margin-bottom: 5px; + } + + .zoom-pan-navigator { + width: 100px; + height: 80px; + } + + .zoom-pan-viewer { + height: 400px !important; + } + + .zoom-pan-status { + font-size: 11px; + padding: 5px 10px; + } + + .page-indicator { + font-size: 12px; + } +} + +/* Print styles */ +@media print { + .zoom-pan-toolbar, + .zoom-pan-navigator, + .zoom-pan-status, + .viewer-help { + display: none !important; + } + + .zoom-pan-container { + border: none; + page-break-inside: avoid; + } + + .zoom-pan-viewer { + height: auto !important; + } +} + +/* Accessibility improvements */ +.zoom-pan-toolbar button:focus { + outline: 2px solid #007bff; + outline-offset: 2px; +} + +.zoom-pan-container[aria-busy="true"] .zoom-pan-viewer { + opacity: 0.5; +} + +/* High contrast mode support */ +@media (prefers-contrast: high) { + .zoom-pan-toolbar { + background: #000; + } + + .zoom-pan-toolbar .btn { + background: #fff; + color: #000; + border: 2px solid #fff; + } + + .zoom-pan-status { + background: #000; + color: #fff; + border-top: 2px solid #fff; + } +} + +/* Dark mode support */ +@media (prefers-color-scheme: dark) { + .zoom-pan-container { + background: #1a1a1a; + border-color: #333; + } + + .viewer-help { + color: #aaa; + } +} diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/js/zoom-pan.js b/plugins/arZoomPanPlugin/arZoomPanPlugin/js/zoom-pan.js new file mode 100644 index 0000000000..67cacb231e --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/js/zoom-pan.js @@ -0,0 +1,645 @@ +/** + * arZoomPan Plugin JavaScript + * + * Enhanced viewer functionality for zoom, pan, and rotate operations + */ + +(function($) { + 'use strict'; + + /** + * ZoomPan Viewer Class + */ + var ZoomPanViewer = function(element, options) { + this.element = element; + this.$element = $(element); + this.options = $.extend({}, ZoomPanViewer.DEFAULTS, options); + this.init(); + }; + + ZoomPanViewer.VERSION = '1.0.0'; + + ZoomPanViewer.DEFAULTS = { + digitalObjectId: null, + viewerType: 'image', // image, pdf, text + tileSize: 256, + maxZoom: 10, + minZoom: 0.5, + zoomSpeed: 1.5, + enableRotation: true, + enableFullscreen: true, + enableDownload: true, + showNavigator: true, + navigatorPosition: 'TOP_RIGHT', + toolbar: true, + statusBar: true + }; + + ZoomPanViewer.prototype.init = function() { + var self = this; + + // Create viewer structure if not exists + if (!this.$element.find('.zoom-pan-viewer').length) { + this.createViewerStructure(); + } + + // Initialize based on viewer type + switch(this.options.viewerType) { + case 'image': + this.initImageViewer(); + break; + case 'pdf': + this.initPdfViewer(); + break; + case 'text': + this.initTextViewer(); + break; + } + + // Setup event handlers + this.bindEvents(); + + // Load document information + this.loadDocumentInfo(); + }; + + /** + * Create viewer HTML structure + */ + ZoomPanViewer.prototype.createViewerStructure = function() { + var html = ''; + + // Toolbar + if (this.options.toolbar) { + html += '
'; + html += '
'; + html += ' '; + html += ' '; + html += ' '; + + if (this.options.enableRotation) { + html += ' '; + html += ' '; + } + + if (this.options.enableFullscreen) { + html += ' '; + } + + html += '
'; + + // PDF navigation + if (this.options.viewerType === 'pdf') { + html += '
'; + html += ' '; + html += ' '; + html += ' Page 1 of ?'; + html += ' '; + html += ' '; + html += '
'; + } + + if (this.options.enableDownload) { + html += ' '; + } + + html += '
'; + } + + // Main viewer + html += '
'; + + // Navigator + if (this.options.showNavigator) { + html += '
'; + } + + // Status bar + if (this.options.statusBar) { + html += '
'; + html += ' Zoom: 100%'; + html += ' Rotation: 0°'; + html += ' '; + html += '
'; + } + + this.$element.html(html); + }; + + /** + * Initialize image viewer (OpenSeadragon) + */ + ZoomPanViewer.prototype.initImageViewer = function() { + var self = this; + + // Initialize OpenSeadragon + this.viewer = OpenSeadragon({ + element: this.$element.find('.zoom-pan-viewer')[0], + prefixUrl: 'https://cdn.jsdelivr.net/npm/openseadragon@4.1.0/build/openseadragon/images/', + + showNavigationControl: false, + + animationTime: 0.5, + blendTime: 0.1, + constrainDuringPan: true, + maxZoomPixelRatio: this.options.maxZoom, + minZoomLevel: this.options.minZoom, + + gestureSettingsMouse: { + scrollToZoom: true, + clickToZoom: true, + dblClickToZoom: true, + pinchToZoom: true + } + }); + + // Show navigator if enabled + if (this.options.showNavigator) { + this.viewer.navigator = new OpenSeadragon.Navigator({ + element: this.$element.find('.zoom-pan-navigator')[0], + viewer: this.viewer + }); + } + + // Update status on zoom + this.viewer.addHandler('zoom', function(event) { + var zoom = Math.round(self.viewer.viewport.getZoom(true) * 100); + self.$element.find('.zoom-pan-zoom-level').text('Zoom: ' + zoom + '%'); + }); + }; + + /** + * Initialize PDF viewer + */ + ZoomPanViewer.prototype.initPdfViewer = function() { + var self = this; + + this.currentPage = 1; + this.totalPages = 0; + this.pageCache = {}; + + // Create canvas for PDF rendering + var canvas = document.createElement('canvas'); + canvas.className = 'pdf-canvas'; + this.$element.find('.zoom-pan-viewer').append(canvas); + + // Initialize zoom/pan for canvas + this.initCanvasZoomPan(canvas); + }; + + /** + * Initialize text viewer + */ + ZoomPanViewer.prototype.initTextViewer = function() { + var self = this; + + // Create iframe for text content + var iframe = document.createElement('iframe'); + iframe.className = 'text-iframe'; + iframe.style.width = '100%'; + iframe.style.height = '100%'; + iframe.style.border = 'none'; + + this.$element.find('.zoom-pan-viewer').append(iframe); + + // Load text content + iframe.src = '/zoompan/text/' + this.options.digitalObjectId; + + this.textZoom = 100; + + // Wait for iframe to load + iframe.onload = function() { + self.textDocument = iframe.contentDocument || iframe.contentWindow.document; + }; + }; + + /** + * Initialize canvas zoom/pan functionality + */ + ZoomPanViewer.prototype.initCanvasZoomPan = function(canvas) { + var self = this; + var ctx = canvas.getContext('2d'); + + this.scale = 1; + this.rotation = 0; + this.offsetX = 0; + this.offsetY = 0; + + var isDragging = false; + var dragStartX, dragStartY; + + // Mouse wheel zoom + $(canvas).on('wheel', function(e) { + e.preventDefault(); + + var delta = e.originalEvent.deltaY > 0 ? 0.9 : 1.1; + self.scale *= delta; + self.scale = Math.max(self.options.minZoom, Math.min(self.options.maxZoom, self.scale)); + + self.renderCanvas(); + self.updateZoomLevel(self.scale * 100); + }); + + // Mouse drag pan + $(canvas).on('mousedown', function(e) { + isDragging = true; + dragStartX = e.clientX - self.offsetX; + dragStartY = e.clientY - self.offsetY; + canvas.style.cursor = 'grabbing'; + }); + + $(document).on('mousemove', function(e) { + if (isDragging) { + self.offsetX = e.clientX - dragStartX; + self.offsetY = e.clientY - dragStartY; + self.renderCanvas(); + } + }); + + $(document).on('mouseup', function() { + isDragging = false; + canvas.style.cursor = 'grab'; + }); + }; + + /** + * Bind event handlers + */ + ZoomPanViewer.prototype.bindEvents = function() { + var self = this; + + // Home button + this.$element.find('.zoom-pan-home').on('click', function() { + self.resetView(); + }); + + // Zoom buttons + this.$element.find('.zoom-pan-zoom-in').on('click', function() { + self.zoomIn(); + }); + + this.$element.find('.zoom-pan-zoom-out').on('click', function() { + self.zoomOut(); + }); + + // Rotation buttons + this.$element.find('.zoom-pan-rotate-left').on('click', function() { + self.rotateLeft(); + }); + + this.$element.find('.zoom-pan-rotate-right').on('click', function() { + self.rotateRight(); + }); + + // Fullscreen button + this.$element.find('.zoom-pan-fullscreen').on('click', function() { + self.toggleFullscreen(); + }); + + // Download button + this.$element.find('.zoom-pan-download').on('click', function() { + self.download(); + }); + + // PDF navigation + if (this.options.viewerType === 'pdf') { + this.$element.find('.zoom-pan-prev-page').on('click', function() { + self.previousPage(); + }); + + this.$element.find('.zoom-pan-next-page').on('click', function() { + self.nextPage(); + }); + } + + // Keyboard shortcuts + $(document).on('keydown', function(e) { + if (!self.$element.is(':visible')) return; + + switch(e.key) { + case '+': + case '=': + self.zoomIn(); + break; + case '-': + case '_': + self.zoomOut(); + break; + case '0': + self.resetView(); + break; + case 'ArrowLeft': + if (e.ctrlKey) self.rotateLeft(); + else if (self.options.viewerType === 'pdf') self.previousPage(); + break; + case 'ArrowRight': + if (e.ctrlKey) self.rotateRight(); + else if (self.options.viewerType === 'pdf') self.nextPage(); + break; + case 'f': + if (e.ctrlKey) { + e.preventDefault(); + self.toggleFullscreen(); + } + break; + } + }); + }; + + /** + * Load document information + */ + ZoomPanViewer.prototype.loadDocumentInfo = function() { + var self = this; + + $.ajax({ + url: '/zoompan/info/' + this.options.digitalObjectId, + type: 'GET', + dataType: 'json', + success: function(info) { + self.documentInfo = info; + + // Update viewer based on document type + if (info.type === 'image') { + // Add tile source to OpenSeadragon + self.viewer.addTiledImage({ + tileSource: { + type: 'legacy-image-pyramid', + getTileUrl: function(level, x, y) { + return '/zoompan/tile/' + self.options.digitalObjectId + '/' + level + '/' + x + '/' + y + '.jpg'; + }, + width: info.width, + height: info.height, + tileSize: info.tileSize || 256, + tileOverlap: 0, + minLevel: 0, + maxLevel: info.maxZoom || 10 + } + }); + + // Update dimensions display + self.$element.find('.zoom-pan-dimensions').text('Size: ' + info.width + ' × ' + info.height + ' px'); + } + else if (info.type === 'pdf') { + self.totalPages = info.pages; + self.$element.find('.zoom-pan-total-pages').text(info.pages); + self.loadPdfPage(1); + } + }, + error: function() { + self.showError('Failed to load document information'); + } + }); + }; + + /** + * Load PDF page + */ + ZoomPanViewer.prototype.loadPdfPage = function(pageNum) { + var self = this; + + if (this.pageCache[pageNum]) { + this.displayPdfPage(this.pageCache[pageNum]); + return; + } + + var img = new Image(); + img.onload = function() { + self.pageCache[pageNum] = img; + self.displayPdfPage(img); + }; + img.src = '/zoompan/pdf/' + this.options.digitalObjectId + '/' + pageNum; + + this.currentPage = pageNum; + this.$element.find('.zoom-pan-current-page').text(pageNum); + }; + + /** + * Display PDF page on canvas + */ + ZoomPanViewer.prototype.displayPdfPage = function(img) { + var canvas = this.$element.find('.pdf-canvas')[0]; + var ctx = canvas.getContext('2d'); + + canvas.width = img.width; + canvas.height = img.height; + + this.currentImage = img; + this.renderCanvas(); + }; + + /** + * Render canvas with transformations + */ + ZoomPanViewer.prototype.renderCanvas = function() { + if (!this.currentImage) return; + + var canvas = this.$element.find('.pdf-canvas')[0]; + var ctx = canvas.getContext('2d'); + + // Clear canvas + ctx.clearRect(0, 0, canvas.width, canvas.height); + + // Apply transformations + ctx.save(); + ctx.translate(canvas.width / 2, canvas.height / 2); + ctx.rotate(this.rotation * Math.PI / 180); + ctx.scale(this.scale, this.scale); + ctx.translate(-canvas.width / 2 + this.offsetX, -canvas.height / 2 + this.offsetY); + + // Draw image + ctx.drawImage(this.currentImage, 0, 0); + + ctx.restore(); + }; + + /** + * Viewer control methods + */ + ZoomPanViewer.prototype.zoomIn = function() { + if (this.options.viewerType === 'image' && this.viewer) { + this.viewer.viewport.zoomBy(this.options.zoomSpeed); + } + else if (this.options.viewerType === 'text') { + this.textZoom = Math.min(this.textZoom + 25, 300); + if (this.textDocument) { + this.textDocument.body.style.zoom = this.textZoom + '%'; + this.updateZoomLevel(this.textZoom); + } + } + else { + this.scale *= this.options.zoomSpeed; + this.scale = Math.min(this.scale, this.options.maxZoom); + this.renderCanvas(); + this.updateZoomLevel(this.scale * 100); + } + }; + + ZoomPanViewer.prototype.zoomOut = function() { + if (this.options.viewerType === 'image' && this.viewer) { + this.viewer.viewport.zoomBy(1 / this.options.zoomSpeed); + } + else if (this.options.viewerType === 'text') { + this.textZoom = Math.max(this.textZoom - 25, 50); + if (this.textDocument) { + this.textDocument.body.style.zoom = this.textZoom + '%'; + this.updateZoomLevel(this.textZoom); + } + } + else { + this.scale /= this.options.zoomSpeed; + this.scale = Math.max(this.scale, this.options.minZoom); + this.renderCanvas(); + this.updateZoomLevel(this.scale * 100); + } + }; + + ZoomPanViewer.prototype.resetView = function() { + if (this.options.viewerType === 'image' && this.viewer) { + this.viewer.viewport.goHome(); + } + else if (this.options.viewerType === 'text') { + this.textZoom = 100; + if (this.textDocument) { + this.textDocument.body.style.zoom = '100%'; + this.updateZoomLevel(100); + } + } + else { + this.scale = 1; + this.rotation = 0; + this.offsetX = 0; + this.offsetY = 0; + this.renderCanvas(); + this.updateZoomLevel(100); + this.updateRotation(0); + } + }; + + ZoomPanViewer.prototype.rotateLeft = function() { + if (this.options.viewerType === 'image' && this.viewer) { + var rotation = this.viewer.viewport.getRotation(); + this.viewer.viewport.setRotation(rotation - 90); + this.updateRotation(rotation - 90); + } + else if (this.options.viewerType !== 'text') { + this.rotation -= 90; + this.renderCanvas(); + this.updateRotation(this.rotation); + } + }; + + ZoomPanViewer.prototype.rotateRight = function() { + if (this.options.viewerType === 'image' && this.viewer) { + var rotation = this.viewer.viewport.getRotation(); + this.viewer.viewport.setRotation(rotation + 90); + this.updateRotation(rotation + 90); + } + else if (this.options.viewerType !== 'text') { + this.rotation += 90; + this.renderCanvas(); + this.updateRotation(this.rotation); + } + }; + + ZoomPanViewer.prototype.previousPage = function() { + if (this.currentPage > 1) { + this.loadPdfPage(this.currentPage - 1); + } + }; + + ZoomPanViewer.prototype.nextPage = function() { + if (this.currentPage < this.totalPages) { + this.loadPdfPage(this.currentPage + 1); + } + }; + + ZoomPanViewer.prototype.toggleFullscreen = function() { + this.$element.toggleClass('fullscreen'); + + if (this.options.viewerType === 'image' && this.viewer) { + this.viewer.setFullScreen(this.$element.hasClass('fullscreen')); + } + + // Update fullscreen button icon + var icon = this.$element.find('.zoom-pan-fullscreen i'); + if (this.$element.hasClass('fullscreen')) { + icon.removeClass('fa-expand').addClass('fa-compress'); + } else { + icon.removeClass('fa-compress').addClass('fa-expand'); + } + }; + + ZoomPanViewer.prototype.download = function() { + window.location.href = '/digitalobject/download/' + this.options.digitalObjectId; + }; + + /** + * Update UI displays + */ + ZoomPanViewer.prototype.updateZoomLevel = function(zoom) { + this.$element.find('.zoom-pan-zoom-level').text('Zoom: ' + Math.round(zoom) + '%'); + }; + + ZoomPanViewer.prototype.updateRotation = function(rotation) { + this.$element.find('.zoom-pan-rotation').text('Rotation: ' + rotation + '°'); + }; + + ZoomPanViewer.prototype.showError = function(message) { + var error = $('
' + message + '
'); + this.$element.find('.zoom-pan-viewer').append(error); + }; + + /** + * jQuery plugin definition + */ + $.fn.zoomPanViewer = function(option) { + return this.each(function() { + var $this = $(this); + var data = $this.data('zoom.pan.viewer'); + var options = typeof option == 'object' && option; + + if (!data) { + $this.data('zoom.pan.viewer', (data = new ZoomPanViewer(this, options))); + } + + if (typeof option == 'string') { + data[option](); + } + }); + }; + + $.fn.zoomPanViewer.Constructor = ZoomPanViewer; + + // Auto-initialize on document ready + $(document).ready(function() { + $('.zoom-pan-container[data-digital-object-id]').each(function() { + var $this = $(this); + var options = { + digitalObjectId: $this.data('digital-object-id'), + viewerType: $this.data('viewer-type') || 'image' + }; + + $this.zoomPanViewer(options); + }); + }); + +})(jQuery); diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/lib/helper/ZoomPanHelper.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/lib/helper/ZoomPanHelper.php new file mode 100644 index 0000000000..d076052e8e --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/lib/helper/ZoomPanHelper.php @@ -0,0 +1,235 @@ +id) { + return '
No digital object available for viewing.
'; + } + + // Normalize base URL for ALL AtoM instances + $baseUrl = rtrim(QubitSetting::getByName('siteBaseUrl'), '/'); + $installFolder = basename($baseUrl); + $baseUrl = preg_replace('#('.preg_quote($installFolder, '#').'/)+#', $installFolder.'/', $baseUrl); + $baseUrl = rtrim($baseUrl, '/'); + + // Build zoom URL (works in ALL AtoM instances) + $imageName = urlencode($digitalObject->name); + $imagePath = urlencode($digitalObject->path); + + $zoomUrl = $baseUrl."/plugins/arZoomPan/zoom.php?imageName={$imageName}&imagePath={$imagePath}"; + + // Viewer size & ID + $elementId = 'zoom-pan-viewer-'.$digitalObject->id; + $height = isset($options['height']) ? $options['height'] : '600px'; + + // Simple iframe viewer + return sprintf( + '', + htmlspecialchars($elementId), + htmlspecialchars($zoomUrl), + htmlspecialchars($height) + ); +} + +/** + * Detect viewer type based on digital object mime type. + * + * @param QubitDigitalObject $digitalObject + * + * @return string Viewer type (image, pdf, or text) + */ +function detect_viewer_type($digitalObject) +{ + $mimeType = $digitalObject->getMimeType(); + + // Image types + if (0 === strpos($mimeType, 'image/')) { + return 'image'; + } + + // PDF + if ('application/pdf' === $mimeType) { + return 'pdf'; + } + + // Text documents + $textTypes = [ + 'text/plain', + 'text/html', + 'text/xml', + 'application/xml', + 'application/msword', + 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', + 'application/vnd.oasis.opendocument.text', + ]; + + if (in_array($mimeType, $textTypes)) { + return 'text'; + } + + // Default to image viewer for unknown types + return 'image'; +} + +/** + * Check if digital object is supported by zoom/pan viewer. + * + * @param QubitDigitalObject $digitalObject + * + * @return bool + */ +function is_zoom_pan_supported($digitalObject) +{ + if (!$digitalObject) { + return false; + } + + $settings = sfConfig::get('app_zoom_pan_settings', []); + $supportedFormats = isset($settings['supported_formats']) ? $settings['supported_formats'] : []; + + $extension = strtolower(pathinfo($digitalObject->getName(), PATHINFO_EXTENSION)); + + return in_array($extension, $supportedFormats); +} + +/** + * Get zoom/pan viewer thumbnail. + * + * @param QubitDigitalObject $digitalObject + * @param array $options + * + * @return string HTML for thumbnail with link to viewer + */ +function get_zoom_pan_thumbnail($digitalObject, $options = []) +{ + if (!$digitalObject || !$digitalObject->id) { + return ''; + } + + $defaults = [ + 'size' => 'thumbnail', + 'class' => 'zoom-pan-thumbnail', + 'link' => true, + 'alt' => $digitalObject->getName(), + ]; + + $options = array_merge($defaults, $options); + + // Get thumbnail URL + $thumbnailUrl = $digitalObject->getThumbnailUrl($options['size']); + + // Build image tag + $img = sprintf( + '%s', + htmlspecialchars($thumbnailUrl), + htmlspecialchars($options['alt']), + htmlspecialchars($options['class']) + ); + + // Add link if requested + if ($options['link']) { + $viewerUrl = url_for([$digitalObject, 'module' => 'digitalobject']); + $img = sprintf( + '%s', + htmlspecialchars($viewerUrl), + $img + ); + } + + return $img; +} + +/** + * Include zoom/pan viewer assets. + * + * Call this in your template's head section if auto-loading doesn't work + * + * @return string + */ +function include_zoom_pan_assets() +{ + $html = ''; + + // OpenSeadragon + $html .= ''."\n"; + + // PDF.js + $html .= ''."\n"; + + // Plugin CSS + $html .= ''."\n"; + + // Plugin JS + $html .= ''."\n"; + + return $html; +} + +/** + * Get viewer configuration as JavaScript. + * + * @param QubitDigitalObject $digitalObject + * @param array $options + * + * @return string JavaScript configuration + */ +function get_zoom_pan_config($digitalObject, $options = []) +{ + $config = [ + 'digitalObjectId' => $digitalObject->id, + 'viewerType' => detect_viewer_type($digitalObject), + 'tileSize' => 256, + 'maxZoom' => 10, + 'minZoom' => 0.5, + 'enableRotation' => true, + 'enableFullscreen' => true, + 'enableDownload' => true, + 'showNavigator' => true, + ]; + + $config = array_merge($config, $options); + + return json_encode($config, JSON_PRETTY_PRINT); +} + +/** + * Generate inline viewer initialization script. + * + * @param string $elementId + * @param QubitDigitalObject $digitalObject + * @param array $options + * + * @return string JavaScript code + */ +function get_zoom_pan_init_script($elementId, $digitalObject, $options = []) +{ + $config = get_zoom_pan_config($digitalObject, $options); + + $script = << +SCRIPT; + + return $script; +} \ No newline at end of file diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/actions.class.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/actions.class.php new file mode 100644 index 0000000000..9f5c723556 --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/actions.class.php @@ -0,0 +1,342 @@ + to use arMetadataExtractionPlugin + */ +class arZoomPanActions extends sfActions +{ + /** + * Viewer action (loads viewerSuccess.php). + * + * @param sfWebRequest $request + * + * @return string + */ + public function executeViewer(sfWebRequest $request) + { + $id = $request->getParameter('id'); + + if (!$id) { + return $this->renderText('

Error: No ID provided

'); + } + + $this->digitalObject = QubitDigitalObject::getById($id); + + if (!$this->digitalObject) { + return $this->renderText("

Error: Digital Object not found (ID {$id})

"); + } + + // Debug log + error_log("[ZoomPan] executeViewer loaded — ID={$id}"); + + return sfView::SUCCESS; + } + + /** + * Serve image tiles for OpenSeadragon. + * + * @param sfWebRequest $request + * + * @return string + */ + public function executeTile(sfWebRequest $request) + { + $id = $request->getParameter('id'); + $z = $request->getParameter('z'); + $x = $request->getParameter('x'); + $y = $request->getParameter('y'); + $format = $request->getParameter('format', 'jpg'); + + $digitalObject = QubitDigitalObject::getById($id); + if (!$digitalObject) { + $this->forward404('Digital object not found'); + } + + if (!QubitAcl::check($digitalObject->object, 'read')) { + $this->forward403(); + } + + $tilePath = $this->getTilePath($digitalObject, $z, $x, $y, $format); + + if (!file_exists($tilePath)) { + $this->generateTile($digitalObject, $z, $x, $y, $format, $tilePath); + } + + $this->serveFile($tilePath, 'image/' . $format); + + return sfView::NONE; + } + + /** + * Return document information. + * + * @param sfWebRequest $request + * + * @return string + */ + public function executeInfo(sfWebRequest $request) + { + $id = $request->getParameter('id'); + $digitalObject = QubitDigitalObject::getById($id); + + if (!$digitalObject) { + $this->forward404('Digital object not found'); + } + + if (!QubitAcl::check($digitalObject->object, 'read')) { + $this->forward403(); + } + + $info = $this->getDocumentInfo($digitalObject); + + $this->getResponse()->setContentType('application/json'); + echo json_encode($info); + + return sfView::NONE; + } + + /** + * Render PDF page to image. + * + * @param sfWebRequest $request + * + * @return string + */ + public function executePdfPage(sfWebRequest $request) + { + $id = $request->getParameter('id'); + $page = $request->getParameter('page', 1); + + $digitalObject = QubitDigitalObject::getById($id); + if (!$digitalObject) { + $this->forward404('Digital object not found'); + } + + if ('application/pdf' !== $digitalObject->getMimeType()) { + $this->forward404('Not a PDF'); + } + + $imagePath = $this->convertPdfPage($digitalObject, $page); + $this->serveFile($imagePath, 'image/jpeg'); + + return sfView::NONE; + } + + /** + * Render text document as HTML. + * + * @param sfWebRequest $request + * + * @return string + */ + public function executeTextDocument(sfWebRequest $request) + { + $id = $request->getParameter('id'); + + $digitalObject = QubitDigitalObject::getById($id); + if (!$digitalObject) { + $this->forward404('Digital object not found'); + } + + $mimeType = $digitalObject->getMimeType(); + $textTypes = [ + 'text/plain', + 'text/html', + 'text/xml', + 'application/xml', + 'application/msword', + 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', + 'application/vnd.oasis.opendocument.text', + ]; + + if (!in_array($mimeType, $textTypes)) { + $this->forward404('Not a text document'); + } + + $html = $this->convertToHtml($digitalObject); + + $this->getResponse()->setContentType('text/html'); + echo $html; + + return sfView::NONE; + } + + /* + * =========================================================== + * Helper Methods + * =========================================================== + */ + + /** + * Generate tile for OpenSeadragon. + * + * @param QubitDigitalObject $digitalObject + * @param int $z + * @param int $x + * @param int $y + * @param string $format + * @param string $tilePath + */ + protected function generateTile($digitalObject, $z, $x, $y, $format, $tilePath) + { + $settings = sfConfig::get('app_zoom_pan_settings'); + if (!is_array($settings)) { + $settings = [ + 'tile_size' => 256, + 'max_zoom_level' => 12, + 'cache_directory' => sfConfig::get('sf_root_dir') . '/cache/zoompan', + ]; + } + $tileSize = $settings['tile_size']; + + $source = $digitalObject->getAbsolutePath(QubitDigitalObject::DERIVATIVE_TYPE_MASTER) + ?: $digitalObject->getAbsolutePath(QubitDigitalObject::DERIVATIVE_TYPE_REFERENCE) + ?: $digitalObject->getAbsolutePath(); + + $scale = pow(2, $z); + $x1 = $x * $tileSize; + $y1 = $y * $tileSize; + + $cmd = sprintf( + 'convert "%s" -crop %dx%d+%d+%d -resize %dx%d "%s"', + escapeshellarg($source), + $tileSize / $scale, + $tileSize / $scale, + $x1 / $scale, + $y1 / $scale, + $tileSize, + $tileSize, + escapeshellarg($tilePath) + ); + + @mkdir(dirname($tilePath), 0755, true); + exec($cmd); + } + + /** + * Get tile path. + * + * @param QubitDigitalObject $digitalObject + * @param int $z + * @param int $x + * @param int $y + * @param string $format + * + * @return string + */ + protected function getTilePath($digitalObject, $z, $x, $y, $format) + { + $settings = sfConfig::get('app_zoom_pan_settings'); + if (!is_array($settings)) { + $settings = [ + 'tile_size' => 256, + 'max_zoom_level' => 12, + 'cache_directory' => sfConfig::get('sf_root_dir') . '/cache/zoompan', + ]; + } + $cache = $settings['cache_directory']; + + return sprintf( + '%s/%d/%d/%d/%d.%s', + $cache, + $digitalObject->id, + $z, + $x, + $y, + $format + ); + } + + /** + * Get document information. + * + * @param QubitDigitalObject $digitalObject + * + * @return array + */ + protected function getDocumentInfo($digitalObject) + { + $path = $digitalObject->getAbsolutePath(); + $mime = $digitalObject->getMimeType(); + + $info = [ + 'id' => $digitalObject->id, + 'name' => $digitalObject->getName(), + 'mimeType' => $mime, + 'fileSize' => filesize($path), + ]; + + if (0 === strpos($mime, 'image/')) { + $s = getimagesize($path); + $info['width'] = $s[0]; + $info['height'] = $s[1]; + $info['type'] = 'image'; + } + + return $info; + } + + /** + * Convert PDF page to image. + * + * @param QubitDigitalObject $digitalObject + * @param int $page + * + * @return string + */ + protected function convertPdfPage($digitalObject, $page) + { + $settings = sfConfig::get('app_zoom_pan_settings'); + $cache = $settings['cache_directory']; + + $cachePath = sprintf('%s/pdf/%d/page_%d.jpg', $cache, $digitalObject->id, $page); + + @mkdir(dirname($cachePath), 0755, true); + + $cmd = sprintf( + 'convert -density 150 "%s[%d]" -quality 90 "%s"', + escapeshellarg($digitalObject->getAbsolutePath()), + $page - 1, + escapeshellarg($cachePath) + ); + + exec($cmd); + + return $cachePath; + } + + /** + * Convert document to HTML. + * + * @param QubitDigitalObject $digitalObject + * + * @return string + */ + protected function convertToHtml($digitalObject) + { + return '
Preview not implemented.
'; + } + + /** + * Serve file to browser. + * + * @param string $path + * @param string $mime + */ + protected function serveFile($path, $mime) + { + if (!file_exists($path)) { + $this->forward404('File not found'); + } + + $response = $this->getResponse(); + $response->setContentType($mime); + $response->setHttpHeader('Content-Length', filesize($path)); + + readfile($path); + } +} \ No newline at end of file diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/viewerAction.class.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/viewerAction.class.php new file mode 100644 index 0000000000..f2f593fa00 --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/actions/viewerAction.class.php @@ -0,0 +1,31 @@ + to use arMetadataExtractionPlugin + */ +class arZoomPanViewerAction extends sfAction +{ + /** + * Execute the viewer action. + * + * @param sfWebRequest $request + * + * @return string + */ + public function execute($request) + { + $this->digitalObject = QubitDigitalObject::getById($request->getParameter('id')); + if (!$this->digitalObject) { + return $this->renderText('

ZoomPan Error: DigitalObject not found

'); + } + + // DEBUG + // error_log("[ZoomPan] ViewerAction loaded for ID: " . $this->digitalObject->id); + + return sfView::SUCCESS; + } +} \ No newline at end of file diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/_viewer.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/_viewer.php new file mode 100644 index 0000000000..1705be808d --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/_viewer.php @@ -0,0 +1,328 @@ +id) { ?> +
+ No digital object available for viewing. +
+getMimeType(); +$isImage = 0 === strpos($mimeType, 'image/'); +$isPdf = 'application/pdf' === $mimeType; +$isText = in_array($mimeType, ['text/plain', 'text/html', 'application/msword', + 'application/vnd.openxmlformats-officedocument.wordprocessingml.document']); + +$viewerId = 'zoom-pan-viewer-'.$digitalObject->id; +?> + +
+ + +
+
+ + + + + + +
+ + + +
+ + + Page 1 of ? + + +
+ + + + +
+ + +
+ +
+ + +
+ + +
+ Zoom: 100% + Rotation: 0° + + + +
+
+ + + + +
+ Controls: + + Mouse wheel to zoom, drag to pan, double-click to zoom in, shift+double-click to zoom out + + Use toolbar buttons to zoom in/out, Ctrl+F to search within document + +
diff --git a/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/viewerSuccess.php b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/viewerSuccess.php new file mode 100644 index 0000000000..103b9532f5 --- /dev/null +++ b/plugins/arZoomPanPlugin/arZoomPanPlugin/modules/arZoomPan/templates/viewerSuccess.php @@ -0,0 +1,114 @@ +getParameter('id'); + +if (!$id) { + echo "
ERROR: No ID received by viewerSuccess.php
"; + + return; +} + +// echo "
✔ ID RECEIVED: {$id}
"; + +// ======================================================== +// 2. LOAD DIGITAL OBJECT +// ======================================================== +$digitalObject = QubitDigitalObject::getById($id); + +if (!$digitalObject) { + echo "
ERROR: DigitalObject not found for ID {$id}
"; + + return; +} + +// echo "
DIGITAL OBJECT LOADED:
+// ID: {$digitalObject->id}
+// Name: {$digitalObject->name}
+// Path: {$digitalObject->path}
+// Mime: {$digitalObject->mimeType}
+// 
"; + +// ======================================================== +// 3. BUILD PUBLIC URL +// ======================================================== +$request = sfContext::getInstance()->getRequest(); +$root = $request->getRelativeUrlRoot(); + +$publicUrl = $root.$digitalObject->path.'/'.$digitalObject->name; + +// echo "
PUBLIC URL:
+// {$publicUrl}
+// 
"; + +// ======================================================== +// 4. SIMPLE OPENSEADRAGON VIEWER (WORKS FOR JPG/PNG/TIF) +// ======================================================== +?> + +

Zoom / Pan Viewer Test

+ +
+
+ + + + + + +
+ Zoom: Mouse wheel • Pan: Drag • Rotate: Shift + Drag • Touch: Pinch/Rotate +
+ + diff --git a/plugins/arZoomPanPlugin/doc/ZoomPan.png b/plugins/arZoomPanPlugin/doc/ZoomPan.png new file mode 100644 index 0000000000..b00e8d90ca Binary files /dev/null and b/plugins/arZoomPanPlugin/doc/ZoomPan.png differ