diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..086dfe23 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +fedora_repository.info export-subst diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/LICENSE.txt @@ -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/README b/README new file mode 100644 index 00000000..71ece32c --- /dev/null +++ b/README @@ -0,0 +1,13 @@ +Islandora Fedora Repository Module + +For installation and customization instructions please see the documentation and the DuraSpace Wiki: + +https://wiki.duraspace.org/display/ISLANDORA/Islandora + +Specifically the Islandora Guide: + +https://wiki.duraspace.org/display/ISLANDORA/Islandora+Guide + +All bugs, feature requests and improvement suggestions are tracked at the DuraSpace JIRA: + +https://jira.duraspace.org/browse/ISLANDORA \ No newline at end of file diff --git a/admin/islandora.admin.inc b/admin/islandora.admin.inc index 8e06fddf..ab92166d 100644 --- a/admin/islandora.admin.inc +++ b/admin/islandora.admin.inc @@ -1,9 +1,11 @@ + } \ No newline at end of file diff --git a/installer_files/foxml/islandora-collectionCModel.xml b/installer_files/foxml/islandora-collectionCModel.xml new file mode 100644 index 00000000..9ae3a9cb --- /dev/null +++ b/installer_files/foxml/islandora-collectionCModel.xml @@ -0,0 +1,182 @@ + + + + + + + + + + + + + + + + ingest + + admin + 2011-01-24T20:34:53.430Z + Fedora Object Ingested + + + + addDatastream + RELS-EXT + admin + 2011-01-24T20:34:54.112Z + Ingested object RELS-EXT + + + + modifyDatastreamByValue + RELS-EXT + admin + 2011-01-24T20:34:54.528Z + Modified by Islandora API + + + + addDatastream + ISLANDORACM + admin + 2011-01-24T20:34:54.711Z + Ingested object ISLANDORACM + + + + + + + + + + Islandora Collection Content Model + islandora:collectionCModel + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/xml + text/plain + application/xml + + + + + + + + + + + + + + The name given to the resource + + + An entity primarily responsible for making the content of the resource such as a person, organization or service. + + + An entity primarily responsible for making the content of the resource such as a person, organization or service. + + none + Multi Media + image + meeting + presentation + sound + text + + + + Examples include an abstract, table of contents, or free-text account of the content of the resource. + + + An entity, (including persons, organizations, or services), responsible for making the resource available. + + + An entity responsible for contributing to the content of the resource such as a person, organization or service. + + + Temporal scope of the content if known. Date format is YYYY-MM-DD (e.g. 1890,1910-10,or 2007-10-23) + + + Genre of the content of the resource. Examples include: home page, novel, poem, working paper, technical report, essay, dictionary. + + none + collection + dataset + event + image + interactive resource + model + party + physical object + place + service + software + sound + text + + + + A reference to a resource from which the present resource is derived. + + + A unique reference to the resource; In this instance, the accession number or collection number. + + + The language of the intellectual content of the resource. + + English + French + + + + Reference to a related resource. + + + Information about intellectual property rights, copyright, and various property rights. + + + + + + + + diff --git a/installer_files/foxml/islandora-demos.xml b/installer_files/foxml/islandora-demos.xml new file mode 100644 index 00000000..4e59cf29 --- /dev/null +++ b/installer_files/foxml/islandora-demos.xml @@ -0,0 +1,5 @@ + + + Islandora Demo Collections + islandora:demos + diff --git a/installer_files/foxml/islandora-pdfcollection.xml b/installer_files/foxml/islandora-pdfcollection.xml new file mode 100644 index 00000000..b57cb712 --- /dev/null +++ b/installer_files/foxml/islandora-pdfcollection.xml @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + ingest + + admin + 2009-04-02T14:39:19.525Z + Fedora Object Ingested + + + + addDatastream + TN + fedoraAdmin + 2009-04-02T17:06:32.540Z + DatastreamsPane generated this logMessage. + + + + purgeDatastream + COLLECTION_POLICY + fedoraAdmin + 2009-04-02T17:10:50.929Z + DatastreamPane generated this logMessage. . . . Purged datastream (ID=COLLECTION_POLICY), versions ranging from 2009-04-02T11:39:19.554Z to 2009-04-02T11:39:19.554Z. This resulted in the permanent removal of 1 datastream version(s) (2009-04-02T11:39:19.554Z) and all associated audit records. + + + + addDatastream + COLLECTION_POLICY + fedoraAdmin + 2009-04-02T17:11:49.698Z + DatastreamsPane generated this logMessage. + + + + ingest + + aoneill + 2010-10-11T23:08:16.035Z + Fedora Object Ingested + + + + addDatastream + TN + aoneill + 2010-10-11T23:08:16.169Z + Ingested object TN + + + + + + + + + + + + + + + + + + + + + + PDF COllection + + none + A bunch of PDFs + + + + none + + islandora:collection-18 + + eng + + + + + + + + + + + + + islandora:strictpdf + islandora:strict_pdf + ISLANDORACM + + + isMemberOfCollection + + dc.description + + dc.title + dc.title + + + dc.creator + dc.creator + + + dc.description + dc.description + + + dc.date + dc.date + + + dc.identifier + dc.identifier + + + dc.language + dc.language + + + dc.publisher + dc.publisher + + + dc.rights + dc.rights + + + dc.subject + dc.subject + + + dc.relation + dc.relation + + + dcterms.temporal + dcterms.temporal + + + dcterms.spatial + dcterms.spatial + + + fgs.DS.first.text + Full Text + + + + + + + + + + + + diff --git a/installer_files/foxml/islandora-strictpdfCModel.xml b/installer_files/foxml/islandora-strictpdfCModel.xml new file mode 100644 index 00000000..ddebd132 --- /dev/null +++ b/installer_files/foxml/islandora-strictpdfCModel.xml @@ -0,0 +1,808 @@ + + + + + + + + + + + + + + + + ingest + + fedoraAdmin + 2009-02-26T14:50:44.411Z + Created with Admin GUI "New Object" command + + + + addDatastream + ISLANDORACM + fedoraAdmin + 2009-02-26T14:52:58.161Z + DatastreamsPane generated this logMessage. + + + + purgeDatastream + ISLANDORACM + fedoraAdmin + 2009-03-31T18:33:27.172Z + DatastreamPane generated this logMessage. . . . Purged datastream (ID=ISLANDORACM), versions ranging from 2009-02-26T10:52:58.161Z to 2009-02-26T10:52:58.161Z. This resulted in the permanent removal of 1 datastream version(s) (2009-02-26T10:52:58.161Z) and all associated audit records. + + + + ingest + + admin + 2009-09-14T14:09:06.847Z + Fedora Object Ingested + + + + addDatastream + ISLANDORACM + fedoraAdmin + 2010-03-08T20:08:32.004Z + DatastreamsPane generated this logMessage. + + + + modifyDatastreamByValue + ISLANDORACM + fedoraAdmin + 2010-09-30T17:11:42.958Z + + + + + modifyDatastreamByValue + ISLANDORACM + fedoraAdmin + 2010-09-30T17:12:24.421Z + + + + + addDatastream + pdf_test + avc_db + 2010-10-06T16:04:03.630Z + Ingested object pdf_test + + + + + + + + + + + + + + + + + + + + + + This DS-COMPOSITE-MODEL datastream is included as a starting point to + assist in the creation of a content model. The DS-COMPOSITE-MODEL + should define the datastreams that are required for any objects + conforming to this content model. + For more information about content models, see: + http://fedora-commons.org/confluence/x/dgBI. + For examples of completed content model objects, see the demonstration + objects included with your Fedora distribution, such as: + demo:CMImage, demo:UVA_STD_IMAGE, demo:DualResImageCollection, + demo:TEI_TO_PDFDOC, and demo:XML_TO_HTMLDOC. + For more information about the demonstration objects, see: + http://fedora-commons.org/confluence/x/AwFI. + + +
+ + + + + + + + + + Strict PDF + islandora:strict_pdf + + + + + + + + + + + + plugins/ShowStreamsInFieldSets.php + ShowStreamsInFieldSets + showPDFPreview + + + + application/pdf + + plugins/ImageManipulation.php + ImageManipulation + createThumbnailFromPDF + jpg + TN + + 100 + 120 + + + + + + application/pdf + + + + + application/pdf + + + + plugins/ImageManipulation.php + ImageManipulation + createThumbnailFromPDF + jpg + TN + + 100 + 120 + + + + + + dis1 + + + 200 + + + + + + + + + + + + + + + + + + + + + plugins/FormBuilder.php + FormBuilder + buildQDCForm + handleQDCForm + + + + + dc:title + textfield + The name given to the resource + true + + + + dc:creator + textfield + An entity primarily responsible for making the content of the resource such as a person, organization or service. + false + + + + dc:subject + select + An entity primarily responsible for making the content of the resource such as a person, organization or service. + false + + + experiment session + experiment session + + + home recording + home recording + + + image + image + + + meeting + meeting + + + presentation + presentation + + + sound + sound + + + text + text + + + + + + dc:description + textarea + Examples include an abstract, table of contents, or free-text account of the content of the resource. + true + + + + dc:publisher + textfield + An entity, (including persons, organizations, or services), responsible for making the resource available. + false + + + + dc:contributor + textfield + An entity responsible for contributing to the content of the resource such as a person, organization or service. + false + + + + dc:date + textfield + Temporal scope of the content if known. Date format is YYYY-MM-DD (e.g. 1890,1910-10,or 2007-10-23) + false + + + + dc:type + select + Genre of the content of the resource. Examples include: home page, novel, poem, working paper, technical report, essay, dictionary. + false + + + none + none + + + collection + collection + + + dataset + dataset + + + event + event + + + image + image + + + interactive resource + interactive resource + + + model + model + + + party + party + + + physical object + physical object + + + place + place + + + service + service + + + software + software + + + sound + sound + + + text + text + + + + + + dc:source + textfield + A reference to a resource from which the present resource is derived. + false + + + + dc:identifier + textfield + A unique reference to the resource; In this instance, the accession number or collection number. + false + + + + dc:language + select + The language of the intellectual content of the resource. + false + + + eng + English + + + fre + French + + + + + + dc:relation + textfield + Reference to a related resource. + false + + + + dc:rights + textarea + Information about intellectual property rights, copyright, and various property rights. + false + + + + + + + + + + + + + plugins/ShowStreamsInFieldSets.inc + ShowStreamsInFieldSets + showPDFPreview + + + + application/pdf + + plugins/ImageManipulation.inc + ImageManipulation + createThumbnailFromPDF + jpg + TN + + 100 + 120 + + + + + + application/pdf + + + + + application/pdf + + + + plugins/ImageManipulation.inc + ImageManipulation + createThumbnailFromPDF + jpg + TN + + 100 + 120 + + + + + + dis1 + + + 200 + + + + + + + + + + + + + + + + + + + + + plugins/FormBuilder.inc + FormBuilder + buildQDCForm + handleQDCForm + + + + + dc:title + textfield + The name given to the resource + true + + + + dc:creator + textfield + An entity primarily responsible for making the content of the resource such as a person, organization or service. + false + + + + dc:subject + select + An entity primarily responsible for making the content of the resource such as a person, organization or service. + false + + + experiment session + experiment session + + + home recording + home recording + + + image + image + + + meeting + meeting + + + presentation + presentation + + + sound + sound + + + text + text + + + + + + dc:description + textarea + Examples include an abstract, table of contents, or free-text account of the content of the resource. + true + + + + dc:publisher + textfield + An entity, (including persons, organizations, or services), responsible for making the resource available. + false + + + + dc:contributor + textfield + An entity responsible for contributing to the content of the resource such as a person, organization or service. + false + + + + dc:date + textfield + Temporal scope of the content if known. Date format is YYYY-MM-DD (e.g. 1890,1910-10,or 2007-10-23) + false + + + + dc:type + select + Genre of the content of the resource. Examples include: home page, novel, poem, working paper, technical report, essay, dictionary. + false + + + none + none + + + collection + collection + + + dataset + dataset + + + event + event + + + image + image + + + interactive resource + interactive resource + + + model + model + + + party + party + + + physical object + physical object + + + place + place + + + service + service + + + software + software + + + sound + sound + + + text + text + + + + + + dc:source + textfield + A reference to a resource from which the present resource is derived. + false + + + + dc:identifier + textfield + A unique reference to the resource; In this instance, the accession number or collection number. + false + + + + dc:language + select + The language of the intellectual content of the resource. + false + + + eng + English + + + fre + French + + + + + + dc:relation + textfield + Reference to a related resource. + false + + + + dc:rights + textarea + Information about intellectual property rights, copyright, and various property rights. + false + + + + + + + + + + + application/pdf + + + + application/pdf + + + + 100 + 120 + + + + + + + + + + + + + 100 + 120 + + + + + + + + + The name given to the resource + + + An entity primarily responsible for making the content of the resource such as a person, organization or service. + + + An entity primarily responsible for making the content of the resource such as a person, organization or service. + + experiment session + home recording + image + meeting + presentation + sound + text + + + + Examples include an abstract, table of contents, or free-text account of the content of the resource. + + + An entity, (including persons, organizations, or services), responsible for making the resource available. + + + An entity responsible for contributing to the content of the resource such as a person, organization or service. + + + Temporal scope of the content if known. Date format is YYYY-MM-DD (e.g. 1890,1910-10,or 2007-10-23) + + + Genre of the content of the resource. Examples include: home page, novel, poem, working paper, technical report, essay, dictionary. + + none + collection + dataset + event + image + interactive resource + model + party + physical object + place + service + software + sound + text + + + + A reference to a resource from which the present resource is derived. + + + A unique reference to the resource; In this instance, the accession number or collection number. + + + The language of the intellectual content of the resource. + + English + French + + + + Reference to a related resource. + + + Information about intellectual property rights, copyright, and various property rights. + + + + + + + + + + + + + + diff --git a/installer_files/foxml/islandora-top.xml b/installer_files/foxml/islandora-top.xml new file mode 100644 index 00000000..523fb29c --- /dev/null +++ b/installer_files/foxml/islandora-top.xml @@ -0,0 +1,150 @@ + + + + + + + + + + + + + + + + ingest + + fedoraAdmin + 2009-03-23T16:42:07.367Z + Created with Admin GUI "New Object" command + + + + addDatastream + RELS-EXT + fedoraAdmin + 2009-03-23T16:47:49.180Z + + + + + addDatastream + COLLECTION_POLICY + fedoraAdmin + 2009-03-23T16:49:38.149Z + DatastreamsPane generated this logMessage. + + + + ingest + + admin + 2009-03-27T15:56:09.271Z + Fedora Object Ingested + + + + addDatastream + TN + admin + 2009-03-27T15:56:09.381Z + Ingested object TN + + + + purgeDatastream + COLLECTION_POLICY + fedoraAdmin + 2009-03-30T14:31:16.296Z + DatastreamPane generated this logMessage. . . . Purged datastream (ID=COLLECTION_POLICY), versions ranging from 2009-03-23T13:49:38.149Z to 2009-03-23T13:49:38.149Z. This resulted in the permanent removal of 1 datastream version(s) (2009-03-23T13:49:38.149Z) and all associated audit records. + + + + ingest + + aoneill + 2010-10-11T23:08:15.103Z + Fedora Object Ingested + + + + addDatastream + COLLECTION_POLICY + aoneill + 2010-10-11T23:08:15.240Z + Ingested object COLLECTION_POLICY + + + + addDatastream + TN + aoneill + 2010-10-11T23:08:15.373Z + Ingested object TN + + + + + + + + + + Islandora Top-Level Collection + islandora:top + + + + + + + + + + + + + + + + + + + + + + + + dc.title + dc.creator + dc.description + dc.date + dc.identifier + dc.language + dc.publisher + dc.rights + dc.subject + dc.relation + dcterms.temporal + dcterms.spatial + Full Text + + isMemberOfCollection + + + + + + + + + + diff --git a/islandora.module b/islandora.module index 0ab0e152..03f04d28 100644 --- a/islandora.module +++ b/islandora.module @@ -37,33 +37,34 @@ define('FEDORA_MODIFY_STATE', 'modify fedora state'); function islandora_menu() { $items = array(); - $items['admin/settings/islandora'] = array( - 'title' => t('Islandora Configuration'), - 'description' => t("Configure Islandora's interaction with Fedora"), + $items['admin/islandora'] = array( + 'title' => 'Islandora Configuration', + 'description' => "Configure Islandora's interaction with Fedora", + 'access arguments' => array('administer site configuration'), + 'type' => MENU_NORMAL_ITEM, + ); + $items['admin/islandora/configure'] = array( + 'title' => 'Islandora Configuration', + 'description' => 'Enter the Islandora collection information here.', 'page callback' => 'drupal_get_form', 'page arguments' => array('islandora_repository_admin'), 'file' => 'admin/islandora.admin.inc', 'access arguments' => array('administer site configuration'), 'type' => MENU_NORMAL_ITEM, - ); - $items['admin/settings/islandora/collection'] = array( - 'title' => t('Islandora Configuration'), - 'description' => t('Enter the Islandora collection information here.'), - 'access arguments' => array('administer site configuration'), - 'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => 0, ); - $items['admin/settings/islandora/demoobjects'] = array( - 'title' => t('Solution Packs'), - 'description' => t('Install content models and collections required by installed solution packs.'), + $items['admin/islandora/solution_packs'] = array( + 'title' => 'Solution Packs', + 'description' => 'Install content models and collections required by installed solution packs.', 'page callback' => 'islandora_solution_packs_page', 'access arguments' => array(FEDORA_ADD_DS), 'file' => 'admin/islandora.solutionpacks.inc', - 'type' => MENU_LOCAL_TASK, + 'type' => MENU_NORMAL_ITEM, ); + $items['islandoracm.xsd'] = array( - 'title' => t('Islandora Content Model XML Schema Definition'), + 'title' => 'Islandora Content Model XML Schema Definition', 'page callback' => 'islandora_display_schema', 'page arguments' => array('islandoracm.xsd'), 'type' => MENU_CALLBACK, @@ -71,13 +72,21 @@ function islandora_menu() { ); $items['collection_policy.xsd'] = array( - 'title' => t('Islandora Content Model XML Schema Definition'), + 'title' => 'Islandora Content Model XML Schema Definition', 'page callback' => 'islandora_display_schema', 'page arguments' => array('collection_policy.xsd'), 'type' => MENU_CALLBACK, 'access arguments' => array(FEDORA_VIEW), ); + $items['islandora/ingest/%'] = array( + 'title' => 'Ingest object', + 'page callback' => 'islandora_ingest_object', + 'page arguments' => array(2), + 'type' => MENU_NORMAL_ITEM, + 'access arguments' => array(FEDORA_INGEST) + ); + $items['islandora/object/%'] = array( 'title' => 'Repository', 'page callback' => 'islandora_view_object', @@ -86,71 +95,74 @@ function islandora_menu() { 'access arguments' => array(FEDORA_VIEW), ); - /* $items['fedora/repository/service'] = array( - 'page callback' => 'repository_service', - 'type' => MENU_CALLBACK, + $items['islandora/object/%/add'] = array( + 'title' => 'Add stream', + 'page callback' => 'islandora_add_stream', + 'type' => MENU_NORMAL_ITEM, + 'access arguments' => array(FEDORA_ADD_DS) + ); + + $items['islandora/object/%/view'] = array( + 'title' => 'Repository', + 'page callback' => 'islandora_view_object', + 'page arguments' => array(2), + 'type' => MENU_NORMAL_ITEM, 'access arguments' => array(FEDORA_VIEW), - ); */ - - $items['islandora/object/%/datastream/%/download'] = array( - 'title' => t('Download object'), - 'page callback' => 'islandora_object_as_attachment', - 'page arguments' => array(2, 4), - 'type' => MENU_CALLBACK, - 'access arguments' => array(FEDORA_VIEW) ); - - /* $items['fedora/repository/editmetadata'] = array( - 'title' => t('Edit metadata'), - 'page callback' => 'fedora_repository_edit_qdc_page', + + $items['islandora/object/%/edit'] = array( + 'title' => 'Repository', + 'page callback' => 'islandora_edit_object', + 'page arguments' => array(2), + 'type' => MENU_NORMAL_ITEM, + 'access arguments' => array(FEDORA_MODIFY_STATE), + ); + + $items['islandora/object/%/delete'] = array( + 'title' => 'Purge object', + 'page callback' => 'islandora_purge_object', 'type' => MENU_CALLBACK, - 'access arguments' => array('edit fedora meta data') - ); */ - - $items['islandora/object/%/datastream/%/purge'] = array( - 'title' => t('Purge data stream'), - 'page callback' => 'islandora_purge_stream', + 'access arguments' => array(FEDORA_PURGE), + ); + + $items['islandora/object/%/datastream/%'] = array( + 'title' => 'View datastream', + 'page callback' => 'islandora_datastream_as_attachment', 'page arguments' => array(2, 4), 'type' => MENU_CALLBACK, - 'access arguments' => array(FEDORA_PURGE) + 'access arguments' => array(FEDORA_VIEW), ); - - /* $items['fedora/repository/replaceStream'] = array( - 'title' => t('Replace Stream'), - 'page callback' => 'fedora_repository_replace_stream', - 'type' => MENU_CALLBACK, - 'access arguments' => array('add fedora datastreams'), - ); */ - - $items['islandora/object/%/purge'] = array( - 'title' => t('Purge object'), - 'page callback' => 'islandora_purge_object', + + $items['islandora/object/%/datastream/%/view'] = array( + 'title' => 'View datastream', + 'page callback' => 'islandora_datastream_as_attachment', + 'page arguments' => array(2, 4), 'type' => MENU_CALLBACK, - 'access arguments' => array(FEDORA_PURGE) + 'access arguments' => array(FEDORA_VIEW), ); - - $items['islandora/object/%/datastream/%/add'] = array( - 'title' => t('Add stream'), - 'page callback' => 'islandora_add_stream', + + $items['islandora/object/%/datastream/%/download'] = array( + 'title' => 'Download datastream', + 'page callback' => 'islandora_datastream_as_attachment', + 'page arguments' => array(2, 4), 'type' => MENU_CALLBACK, - 'access arguments' => array(FEDORA_ADD_DS) + 'access arguments' => array(FEDORA_VIEW), ); - - /* $items['fedora/repository/collection'] = array( - 'title' => t('Collection view'), - 'page callback' => 'fedora_collection_view', + + $items['islandora/object/%/datastream/%/edit'] = array( + 'title' => 'Edit datastream', + 'page callback' => 'islandora_edit_stream', + 'page arguments' => array(2, 4), 'type' => MENU_CALLBACK, - 'access argruments' => array('view fedora collection'), - ); */ - - //new for mnpl****************************************** - - - $items['islandora/object/ingest'] = array( - 'title' => t('Ingest object'), - 'page callback' => 'islandora_ingest_object', + 'access arguments' => array(FEDORA_METADATA_EDIT), + ); + + $items['islandora/object/%/datastream/%/delete'] = array( + 'title' => 'Purge data stream', + 'page callback' => 'islandora_purge_stream', + 'page arguments' => array(2, 4), 'type' => MENU_CALLBACK, - 'access arguments' => array(FEDORA_INGEST) + 'access arguments' => array(FEDORA_PURGE), ); return $items; @@ -194,12 +206,12 @@ function islandora_node_access($op, $pid = NULL, $as_user = NULL) { */ function islandora_purge_object($object_id) { if (!isset($object_id)) { - drupal_set_message('Cannot remove object, object id not set'); + drupal_set_message(t('Cannot remove object, object id not set')); return; } $object = new Object($object_id); if (!isset($object)) { - drupal_set_message('Could not remove object, object not found'); + drupal_set_message(t('Could not remove object, object not found')); return; } module_invoke_all('islandora_purge_object', $object); //notify modules of pending deletion @@ -221,12 +233,12 @@ function islandora_get_types() { */ function islandora_purge_datastream($object_id, $datastream_id) { if (!isset($datastream_id)) { - drupal_set_message('Cannot remove datastream, datastream id not set'); + drupal_set_message(t('Cannot remove datastream, datastream id not set')); return; } $object = new Object($object_id); if (!isset($object)) { - drupal_set_message('Could not remove object, object not found'); + drupal_set_message(t('Could not remove object, object not found')); return; } module_invoke_all('islandora_purge_datastream', $datastream); //notify modules of pending deletion so we can update rels etc @@ -243,7 +255,7 @@ function islandora_purge_datastream($object_id, $datastream_id) { function islandora_view_object($object_id) { //return $object_id; if (!isset($object_id)) { - drupal_set_message('Cannot view object, object id not set'); + drupal_set_message(t('Cannot view object, object id not set')); return; } @@ -257,7 +269,7 @@ function islandora_view_object($object_id) { $restConnection = new RestConnection($user); $fedora_object = new FedoraObject($object_id, $restConnection->repository); } catch (Exception $e) { - drupal_set_message(t('Error getting Islandora object %s',array('%s' => $object_id)), 'error'); + drupal_set_message(t('Error getting Islandora object %s', array('%s' => $object_id)), 'error'); return""; } drupal_alter('islandora_view_object', $fedora_object); //modify object if required before it is passed along @@ -311,17 +323,15 @@ function islandora_permission() { */ function islandora_add_datastream($object_id) { if (!isset($object_id)) { - drupal_set_message('Cannot add datastream to object, object id not set'); + drupal_set_message(t('Cannot add datastream to object, object id not set')); return; } //send message to synapse $object = new IslandoraObject($object_id); if (!isset($object)) { - drupal_set_message('Could not remove object, object not found'); + drupal_set_message(t('Could not remove object, object not found')); return; } module_invoke_all('islandora_add_datastream', $object); //allow submodules to handle add datastream based on object type } - -?> \ No newline at end of file diff --git a/tests/README_TESTING.txt b/tests/README_TESTING.txt new file mode 100644 index 00000000..18db5ba8 --- /dev/null +++ b/tests/README_TESTING.txt @@ -0,0 +1,42 @@ +There are a few things to set up to get the Simpletests to run properly. + +Fedora Installation + +The test sets up the fedora_repository module with the default server settings. +This means it will expect a Fedora server to be running on localhost:8080 +with the usual defaults. The tests also expect the Islandora demo objects, i.e., +islandora:top, islandora:demos collections, etc. to be installed. (Go to +Administer -> Site Configuration -> Fedora Colleciton List and click the Install +Demos tab and follow the instructions.) + + +Fedora User + +Add the following entry to the fedora users file located at +$FEDORA_HOME/server/config/fedora-users.xml: + + + + administrator + + + +If you look in the fedora_repository.test file we see that we are creating +a user with a password set to 'simpletestpass'. Fedora requires the hashed +version of this password to do a servlet filter-based authentication. + +Drupal Module Setup + +The Drupal Simpletest module http://drupal.org/project/simpletest requires a +patch be applied to your Drupal core. See the module's README file for +instructions. + +To run the tests go to Administration -> Site Building -> Testing, expand +Fedora Repository and check Fedora Repository, leaving Fedora API unchecked +unless you want to test that as well. The tests as they are right now should +return with 0 Fails and 0 Exceptions. If you add new code or functionality +to the module it is your responsibility to add corresponding tests so that other +people making future changes to the codebase don't break your additions. + +See the SimpleTest Tutorial on Drupal.org here http://drupal.org/simpletest-tutorial +for a good introduction to creating Simpletests. \ No newline at end of file diff --git a/tests/fedora_repository.test b/tests/fedora_repository.test new file mode 100644 index 00000000..fea72991 --- /dev/null +++ b/tests/fedora_repository.test @@ -0,0 +1,186 @@ + 'Fedora Repository', + 'description' => t('The Fedora repository content models.'), + 'group' => t('fedora repository'), + ); + } + + function setUp() { + parent::setUp('tabs', 'fedora_repository'); + + module_load_include('inc', 'fedora_repository', 'api/fedora_item'); + + // Create and login user. + $repository_user = $this->drupalCreateFedoraUser(array('add fedora datastreams', + 'edit fedora meta data', + 'edit tags datastream', + 'ingest new fedora objects', + 'purge objects and datastreams', + 'view fedora collection', + 'view detailed list of content')); + + $this->repository_user = $repository_user; + $this->drupalLogin($repository_user); + } + + /** + * Add an item based on a content model. Initially we will assume that the repository + * will be populated with the default content models and collections that are + * created from the admin settings -> Install Demos page. + * + */ + public function testIngest() { + // Check that the 'Strict PDF' content model exists in the repository. + //$pdf_cm = new Fedora_Item('islandora:strict_pdf'); + + $pid_list = array(); + // Create a collection for ingesting PDF content model objects. + //$this->drupalGet('fedora/ingestObject/islandora:top/Islandora%20Top-Level%20Collection'); + $ingest_form = array(); + $ingest_form['models'] = 'islandora:collectionCModel/ISLANDORACM'; + + $this->drupalPost('fedora/ingestObject/islandora:top/Islandora%20Top-Level%20Collection', $ingest_form, 'Next'); + + // Add a sample PDF object via the web ingest form. + // Required fields are file location, dc:title and dc:description + $ingest_form_step_2 = array(); + $ingest_form_step_2['dc:title'] = $this->randomName(32); + $ingest_form_step_2['dc:description'] = $this->randomName(256); + + $ingest_form_step_2['files[ingest-file-location]'] = realpath(drupal_get_path('module', 'fedora_repository') . '/tests/test_files/lorem_ipsum.pdf'); + $this->drupalPost(NULL, $ingest_form_step_2, 'Ingest'); + $this->assertText('mimetype (application/pdf) is not associated with this Content Model', 'PDF mime type not accepted in collection content model.', 'message'); + + $this->outputScreenContents('Initial ingest form submit step 2', 'fedora_repository'); + + // Now try ingesting a proper collection policy. + $ingest_form = array(); + $ingest_form['models'] = 'islandora:collectionCModel/ISLANDORACM'; + + $this->drupalPost('fedora/ingestObject/islandora:top/Islandora%20Top-Level%20Collection', $ingest_form, 'Next'); + // Required fields are file location, dc:title and dc:description + $ingest_form_step_2 = array(); + $ingest_form_step_2['dc:title'] = $this->randomName(32); + $ingest_form_step_2['dc:description'] = $this->randomName(256); + $ingest_form_step_2['files[ingest-file-location]'] = realpath(drupal_get_path('module', 'fedora_repository') . '/collection_policies/PDF-COLLECTION POLICY.xml'); + $this->drupalPost(NULL, $ingest_form_step_2, 'Ingest'); + //$this->outputScreenContents('Initial ingest form submit step 2 - PDF collection', 'fedora_repository'); + $this->assertPattern('/Item .* created successfully./', "Verified item created."); + + $pid = $this->getIngestedPid(); + $pid_list[] = $pid; + $this->pass('Now attempting to ingest a PDF into the new collection.'); + // Now try ingesting a PDF + $ingest_form = array(); + $ingest_form['models'] = 'islandora:strict_pdf/ISLANDORACM'; + $this->drupalPost("fedora/ingestObject/$pid/", $ingest_form, 'Next'); + // Required fields are file location, dc:title and dc:description + $ingest_form_step_2 = array(); + $ingest_form_step_2['dc:title'] = "Lorem Ipsum"; + $ingest_form_step_2['dc:description'] = $this->randomName(256); + $ingest_form_step_2['files[ingest-file-location]'] = realpath(drupal_get_path('module', 'fedora_repository') . '/tests/test_files/lorem_ipsum.pdf'); + $this->drupalPost(NULL, $ingest_form_step_2, 'Ingest'); + $pid = $this->getIngestedPid(); + $pid_list[] = $pid; + if (!empty($pid)) { + $this->pass("Successfully ingested PDF object $pid."); + } + $this->cleanUpRepository($pid_list); + } + + public function testPidSpaceRestriction() { + + // give user full permissions + + $admin_tester = $this->drupalCreateUser(array('administer site configuration', 'view fedora collection')); + $this->drupalLogin($admin_tester); + $pageContent = $this->drupalGet('admin/settings/fedora_repository'); + $hasOption = preg_match('/Enforce namespace restrictions/', $pageContent); + + + if (!$hasOption) { + $this->pass('Removal of namespace restrictions is disabled'); + } + else { + $this->pass('Removal of namespace restrictions is enabled'); + $inVal['fedora_namespace_restriction_enforced'] = TRUE; + $inVal['fedora_pids_allowed'] = 'simpletest:'; + $this->drupalPost('admin/settings/fedora_repository', $inVal, 'Save configuration'); + $this->assertPattern('/The configuration options have been saved./', 'The configuration options have been saved.'); + + $this->drupalGet('fedora/repository/islandora:largeimages/'); + $this->assertPattern('/Access denied/', 'No access to Large image Collection Collection'); + $inVal['fedora_namespace_restriction_enforced'] = 0; + $this->drupalPost('admin/settings/fedora_repository', $inVal, 'Save configuration'); + $this->assertPattern('/The configuration options have been saved./', 'The configuration options have been saved.'); + $this->drupalLogin($this->repository_user); + $this->drupalGet('fedora/repository/islandora:largeimages/'); + $this->assertPattern('/Large Images Collection/', 'Access to Large Images Collection'); + } + } + + private function cleanUpRepository($pid_list = array()) { + $this->pass("This is the PID list to purge: " . implode(", ", $pid_list)); + foreach ($pid_list as $pid) { + $this->drupalPost("fedora/repository/purgeObject/$pid", array(), 'Purge'); + } + } + + private function getIngestedPid() { + $subject = $this->drupalGetContent(); + $pattern = '/">(.*)<\/a> created successfully./'; + $matches = array(); + $res = preg_match($pattern, $subject, $matches); + return $matches[1]; + } + + private function outputScreenContents($description = "Screen contents", $basename = 'Fedora Repository') { + // This is a hack to get a directory that won't be cleaned up by SimpleTest. + $file_dir = file_directory_path() . '../simpletest_output_pages'; + if (!is_dir($file_dir)) { + mkdir($file_dir, 0777, TRUE); + } + $output_path = "$file_dir/$basename." . $this->randomName(10) . '.html'; + $rv = file_put_contents($output_path, $this->drupalGetContent()); + $this->pass("$description: Contents of result page are " . l('here', $output_path)); + } + + protected function drupalCreateFedoraUser($permissions = array('access comments', 'access content', 'post comments', 'post comments without approval')) { + // Create a role with the given permission set. + if (!($rid = $this->drupalCreateRole($permissions))) { + return FALSE; + } + + // Create a user assigned to that role. + $edit = array(); + $edit['name'] = 'simpletestuser'; + $edit['mail'] = $edit['name'] . '@example.com'; + $edit['roles'] = array($rid => $rid); + $edit['pass'] = 'simpletestpass'; + $edit['status'] = 1; + + $account = user_save('', $edit); + + $this->assertTrue(!empty($account->uid), t('User created with name %name and pass %pass', array('%name' => $edit['name'], '%pass' => $edit['pass'])), t('User login')); + if (empty($account->uid)) { + return FALSE; + } + + // Add the raw password so that we can log in as this user. + $account->pass_raw = $edit['pass']; + return $account; + } + +} + diff --git a/tests/test_files/CCITT_5.jp2 b/tests/test_files/CCITT_5.jp2 new file mode 100644 index 00000000..e69de29b diff --git a/tests/test_files/CCITT_5.tiff b/tests/test_files/CCITT_5.tiff new file mode 100644 index 00000000..d52e660d Binary files /dev/null and b/tests/test_files/CCITT_5.tiff differ diff --git a/tests/test_files/CCITT_5_uncompressed.jp2 b/tests/test_files/CCITT_5_uncompressed.jp2 new file mode 100644 index 00000000..32cabf6e Binary files /dev/null and b/tests/test_files/CCITT_5_uncompressed.jp2 differ diff --git a/tests/test_files/CCITT_5_uncompressed.tiff b/tests/test_files/CCITT_5_uncompressed.tiff new file mode 100644 index 00000000..e373aec0 Binary files /dev/null and b/tests/test_files/CCITT_5_uncompressed.tiff differ diff --git a/tests/test_files/jabberwocky.pdf b/tests/test_files/jabberwocky.pdf new file mode 100644 index 00000000..5aedeb27 --- /dev/null +++ b/tests/test_files/jabberwocky.pdf @@ -0,0 +1,70 @@ +%PDF-1.3 +%ª«¬­ +4 0 obj +<< /Type /Info +/Producer (FOP 0.20.4) >> +endobj +5 0 obj +<< /Length 1072 /Filter [ /ASCII85Decode /FlateDecode ] + >> +stream +GauHJ9lHOU&A@P9+Ls=kZBT8uH`3C?<>7mEU"lXh$lJId`fU_(r;/e^nT\OkBiS.`mB/18H#MhjAhMNVqer1i"h%p;ji3^+",Ygb:k#?^)p.QT2p8$=c"\RZ*GD[][0DY/+O<7ns>P!GTc"qg3V`Elf8[ucC3n;8GLDbS'3NT:1+<%oP!8j3ZqfTj.pB[FXE`R[ZHEM`c<4@d[aPPJ*R]Z_sXd35cB^\jP4oZa'T+V>E'UA>ZQMi%G2r.!R?3Nr))oAp?cPdqg"4KHA3%^!;$:Z(f05.Z]&m)bllAbT#,#1m-;\03Q`aPEO7^jC6/bQG86_ufm60&D^VT\isRuBf8rXnJ`K]o?Ej,on&nG$?;bHX[iumsA;WDZ0[eo96Q#@uR1JFnAWbRK>`LK!oIL+PpHI@))$Ind..P7gba5:*E+"ZS1D[5Z+XDmn@md9I^`JbRMH"cJ-`e@on;L\hL?)04l*?N!XK'[79UD5^D','$nRX+_>:2"[Tbm!hig+ucG0V"U;M]A@Q#-FT(]PW.G3\ulS!,5`_o=LV%lr$_%I270peU>CAQ]MT6m42[>O[2hHjQT7+@"cf0Wo%mL31Cd>qe:YOpAV0J&5T#9_q:_tm>aHoHj"K'Pq0'\4R^.[d#6QA_Mm.$CY,,?o"s]=t6uXP.:;5pR2AA2`cLe5ZiC*gAEJZ+g/2SgS)jgHpDm4-HW\[LP@:!GS@ceKJoV6V3_>"KW&8K*mtHg]FLM-2AVRX_:SGf5pZ2?%&,UE!\(Xk;k1K.SNd[TZE(6+;OQk9TLG/V66t[S1<%\oWD6EPtgoCpXBRVWL)Y!KT`,LM%1kdol(s=`o1IAASXrnJ'nGg,H7Y8V5AF/+MtRH3#.1.Smb%=<5;\#Z-eY>c]LQ*Kq/Za4/K7uBEUB16qt!cA+d[XoVT@cGtt:S;dM9:.CW5i@V]f^E-?'IB6=,Jrm@hE[NX7^6E-[Y397[B$\'nlrkW^BqLR)7hDj?*37`OQ2noBVcONh~> +endstream +endobj +6 0 obj +<< /Type /Page +/Parent 1 0 R +/MediaBox [ 0 0 576 792 ] +/Resources 3 0 R +/Contents 5 0 R +>> +endobj +7 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F6 +/BaseFont /Times-Italic +/Encoding /WinAnsiEncoding >> +endobj +8 0 obj +<< /Type /Font +/Subtype /Type1 +/Name /F5 +/BaseFont /Times-Roman +/Encoding /WinAnsiEncoding >> +endobj +1 0 obj +<< /Type /Pages +/Count 1 +/Kids [6 0 R ] >> +endobj +2 0 obj +<< /Type /Catalog +/Pages 1 0 R + >> +endobj +3 0 obj +<< +/Font << /F6 7 0 R /F5 8 0 R >> +/ProcSet [ /PDF /ImageC /Text ] >> +endobj +xref +0 9 +0000000000 65535 f +0000001560 00000 n +0000001618 00000 n +0000001668 00000 n +0000000015 00000 n +0000000071 00000 n +0000001235 00000 n +0000001341 00000 n +0000001451 00000 n +trailer +<< +/Size 9 +/Root 2 0 R +/Info 4 0 R +>> +startxref +1756 +%%EOF diff --git a/tests/test_files/lorem_ipsum.pdf b/tests/test_files/lorem_ipsum.pdf new file mode 100644 index 00000000..7d2f1f9e Binary files /dev/null and b/tests/test_files/lorem_ipsum.pdf differ