diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 20d40b6..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. \ No newline at end of file diff --git a/includes/export_batch.inc b/includes/export_batch.inc index 2a4fc37..9f252d0 100644 --- a/includes/export_batch.inc +++ b/includes/export_batch.inc @@ -1,40 +1,36 @@ - (isset($raw_settings['entities'])) ? $raw_settings['entities'] : array(), 'associations' => (isset($raw_settings['associations'])) ? $raw_settings['associations'] : array(), 'bundles' => array(), ); - + foreach ($settings['entities'] as $key => $value) { - if ($value && isset($raw_settings['bundle_' . $key])) { $settings['bundles'][$key] = $raw_settings['bundle_' . $key]; } - } - - + variable_set('topic_map_export_batch_settings', $settings); - - // Batch declaration + + // Batch declaration. $batch = array( 'finished' => 'topic_map_export_finished', 'title' => t('Exporting topic map'), @@ -44,28 +40,31 @@ function topic_map_export_topic_map($raw_settings = NULL) { 'error_message' => t('A error has occurred during export.'), 'file' => drupal_get_path('module', 'topic_map_export') . '/includes/export_batch.inc', ); - - $file = file_create_filename("topic_map_" . time() . ".xtm", 'public://'); + + $file = file_create_filename('topic_map_' . time() . '.xtm', 'public://'); $batch['operations'][] = array('topic_map_export_prepare_processing', array($file)); - - if (isset($settings['entities']['node']) && $settings['entities']['node']) + + if (isset($settings['entities']['node']) && $settings['entities']['node']) { $batch['operations'][] = array('topic_map_export_process_nodes', array()); - - if (isset($settings['entities']['user']) && $settings['entities']['user']) + } + + if (isset($settings['entities']['user']) && $settings['entities']['user']) { $batch['operations'][] = array('topic_map_export_process_users', array()); - - if (isset($settings['entities']['comment']) && $settings['entities']['comment']) + } + + if (isset($settings['entities']['comment']) && $settings['entities']['comment']) { $batch['operations'][] = array('topic_map_export_process_comments', array()); - - if (isset($settings['entities']['taxonomy_term']) && $settings['entities']['taxonomy_term']) + } + + if (isset($settings['entities']['taxonomy_term']) && $settings['entities']['taxonomy_term']) { $batch['operations'][] = array('topic_map_export_process_taxonomy', array()); - + } + $batch['operations'][] = array('topic_map_export_process_associations', array()); $batch['operations'][] = array('topic_map_export_process_create_topic_map', array()); - + batch_set($batch); batch_process(); - } /** @@ -73,451 +72,391 @@ function topic_map_export_topic_map($raw_settings = NULL) { * entities(not instances), association types and occurrence types to it. */ function topic_map_export_prepare_processing($filepath, &$context) { - $settings = variable_get('topic_map_export_batch_settings'); $context['results'] = array( 'topics' => array(), 'associations' => array()); $context['results']['topic_map'] = $filepath; - + $file = fopen($filepath, 'w'); - + $sitename = variable_get('site_name', 'Drupal'); - + $entities = entity_get_info(); $association_fields = _topic_map_export_get_association_fields(); $occurrences = _topic_map_export_get_supported_occurences(); - + foreach ($entities as $key => $value) { - if (!isset($settings['entities'][$key]) || !$settings['entities'][$key]) { unset($entities[$key]); } - } - + foreach ($settings['bundles'] as $key => $bundle_set) { if (isset($entities[$key])) { - foreach ($entities[$key]['bundles'] as $bundle_key => $bundle_value) { - if (!isset($bundle_set[$bundle_key]) || !$bundle_set[$bundle_key]) { unset($entities[$key]['bundles'][$bundle_key]); } - } - } } - + fwrite($file, theme('topic_map_header', array('site_name' => $sitename))); fwrite($file, theme('topic_map_entities_and_bundles', array('entities' => $entities))); fwrite($file, theme('topic_map_occurence_types', array('occurrences' => $occurrences))); fwrite($file, theme('topic_map_roles_and_association_types', array('association_fields' => $association_fields))); - + fclose($file); - } /** * Loads and processes nodes to topics. */ function topic_map_export_process_nodes(&$context) { - $settings = variable_get('topic_map_export_batch_settings'); //module_load_include('inc', 'topic_map_export', 'includes/TopicMapClasses'); - + if (!isset($context['sandbox']['current_node'])) { $context['sandbox']['current_node'] = 0; - - + $query = new EntityFieldQuery(); $query->entityCondition('entity_type', 'node'); $result = $query->execute(); $context['sandbox']['nodes'] = array_keys($result['node']); - + $context['sandbox']['max'] = count($context['sandbox']['nodes']); - + $context['finished'] = 0; return; } $limit = 10; - + $max = 0; - + $nids = $context['sandbox']['nodes']; - + $nodes = array(); - + if ($context['sandbox']['max'] > ($context['sandbox']['current_node'] + $limit)) { - $max = $context['sandbox']['current_node'] + $limit; $nodes = node_load_multiple(array_slice($nids, $context['sandbox']['current_node'], $limit)); - - } + } else { - $max = $context['sandbox']['max']; - $nodes = node_load_multiple(array_slice($nids, $context['sandbox']['current_node'], + $nodes = node_load_multiple(array_slice($nids, $context['sandbox']['current_node'], $context['sandbox']['max'] - $context['sandbox']['current_node'])); - } - + $context['sandbox']['current_node'] = min(array($context['sandbox']['max'], $context['sandbox']['current_node'] + $limit)); - + foreach ($nodes as $key => $node) { - - if (!$settings['bundles']['node'][$node->type]) continue; - + if (!$settings['bundles']['node'][$node->type]) { + continue; + } + $dt = new DrupalTopic($node, EntityEnum::TYPE_NODE); $context['results']['topics'][$dt->unique_id] = $dt; } - - + if ($context['sandbox']['max'] != $context['sandbox']['current_node']) { $context['finished'] = $context['sandbox']['current_node'] / $context['sandbox']['max']; } - - } /** * Loads and processes users to topics. */ function topic_map_export_process_users(&$context) { - - if (!isset($context['sandbox']['current_user'])) { $context['sandbox']['current_user'] = 0; - + $query = new EntityFieldQuery(); $query->entityCondition('entity_type', 'user'); $result = $query->execute(); - + $context['sandbox']['uids'] = array_keys($result['user']); $context['sandbox']['max'] = count($context['sandbox']['uids']); - + $context['finished'] = 0; return; } $limit = 10; - + $max = 0; - + $uids = $context['sandbox']['uids']; - + $users = array(); - + if ($context['sandbox']['max'] > ($context['sandbox']['current_user'] + $limit)) { - $max = $context['sandbox']['current_user'] + $limit; $users = user_load_multiple(array_slice($uids, $context['sandbox']['current_user'], $limit)); - - } + } else { - $max = $context['sandbox']['max']; - $users = user_load_multiple(array_slice($uids, $context['sandbox']['current_user'], + $users = user_load_multiple(array_slice($uids, $context['sandbox']['current_user'], $context['sandbox']['max'] - $context['sandbox']['current_user'])); - } - + $context['sandbox']['current_user'] = min(array($context['sandbox']['max'], $context['sandbox']['current_user'] + $limit)); - + foreach ($users as $key => $user) { $dt = new DrupalTopic($user, EntityEnum::TYPE_USER); $context['results']['topics'][$dt->unique_id] = $dt; } - - + if ($context['sandbox']['max'] != $context['sandbox']['current_user']) { $context['finished'] = $context['sandbox']['current_user'] / $context['sandbox']['max']; } - } /** * Loads and processes comments to topics. */ function topic_map_export_process_comments(&$context) { - - //module_load_include('inc', 'topic_map_export', 'includes/TopicMapClasses'); - + //module_load_include('inc', 'topic_map_export', 'includes/TopicMapClasses'); + if (!isset($context['sandbox']['comments'])) { $query = new EntityFieldQuery(); $query->entityCondition('entity_type', 'comment'); $result = $query->execute(); - + $context['sandbox']['comments'] = array_keys($result['comment']); - + $context['sandbox']['current_comment'] = 0; $context['sandbox']['max'] = count($context['sandbox']['comments']); - + $context['finished'] = 0; return; - } - + $limit = 20; - - $max = min(array($context['sandbox']['max'], $context['sandbox']['current_comment']+$limit)); - + + $max = min(array($context['sandbox']['max'], $context['sandbox']['current_comment'] + $limit)); + for ($context['sandbox']['current_comment']; $context['sandbox']['current_comment'] < $max; $context['sandbox']['current_comment']++) { - $comment = comment_load($context['sandbox']['comments'][$context['sandbox']['current_comment']]); - + $dt = new DrupalTopic($comment, EntityEnum::TYPE_COMMENT); $context['results']['topics'][$dt->unique_id] = $dt; } - + $context['sandbox']['current_comment'] = $max; - + if ($context['sandbox']['max'] != $context['sandbox']['current_comment']) { $context['finished'] = $context['sandbox']['current_comment'] / $context['sandbox']['max']; } - - } /** * Loads and processes taxonomy terms. */ function topic_map_export_process_taxonomy(&$context) { - $settings = variable_get('topic_map_export_batch_settings'); - + if (!isset($context['sandbox']['terms'])) { - $query = new EntityFieldQuery(); $query ->entityCondition('entity_type', 'taxonomy_term'); $result = $query->execute(); - + $context['sandbox']['terms'] = array_keys($result['taxonomy_term']); - + $context['sandbox']['current_term'] = 0; $context['sandbox']['max'] = count($context['sandbox']['terms']); - + $context['finished'] = 0; return; - } - + $limit = 20; - - - $max = min(array($context['sandbox']['max'], $context['sandbox']['current_term']+$limit)); - + + $max = min(array($context['sandbox']['max'], $context['sandbox']['current_term'] + $limit)); + for ($context['sandbox']['current_term']; $context['sandbox']['current_term'] < $max; $context['sandbox']['current_term']++) { - $term = taxonomy_term_load($context['sandbox']['terms'][$context['sandbox']['current_term']]); - - if (!$settings['bundles']['taxonomy_term'][$term->vocabulary_machine_name]) continue; - + + if (!$settings['bundles']['taxonomy_term'][$term->vocabulary_machine_name]) { + continue; + } + $dt = new DrupalTopic($term, EntityEnum::TYPE_TERM); $context['results']['topics'][$dt->unique_id] = $dt; } - + $context['sandbox']['current_term'] = $max; - + if ($context['sandbox']['max'] != $context['sandbox']['current_term']) { $context['finished'] = $context['sandbox']['current_term'] / $context['sandbox']['max']; } - - } - /** * Goes trough the created topics and creates associations between them. */ function topic_map_export_process_associations(&$context) { - $settings = variable_get('topic_map_export_batch_settings'); - + if (!isset($context['sandbox']['current_topic'])) { $context['sandbox']['current_topic'] = 0; $context['sandbox']['keys'] = array_keys($context['results']['topics']); $context['sandbox']['max'] = count($context['results']['topics']); - + $context['finished'] = 0; return; - } - + $limit = 5; - - $topic_ilength = min(array($context['sandbox']['max'], $context['sandbox']['current_topic']+$limit)); - + + $topic_ilength = min(array($context['sandbox']['max'], $context['sandbox']['current_topic'] + $limit)); + $association_fields = _topic_map_export_get_association_fields(); - - - - for ($i=$context['sandbox']['current_topic']; $i < $topic_ilength; $i++) { - + + for ($i = $context['sandbox']['current_topic']; $i < $topic_ilength; $i++) { $key = $context['sandbox']['keys'][$i]; $dt = $context['results']['topics'][$key]; - - + switch ($dt->type) { case EntityEnum::TYPE_NODE: - $node = node_load($dt->id); - + _topic_map_export_create_association_node_creation($context['results']['associations'], $dt); - - /* + + /* * Check if node has certain type of fields for association creation * @see _topic_map_export_get_association_fields() - * @todo The following loop should probably be moved outside the + * @todo The following loop should probably be moved outside the * TYPE_NODE switch case and made entity based instead node based. */ foreach ($node as $key => $field) { - - if (isset($association_fields[$key]) && - !empty($association_fields[$key]) && + !empty($association_fields[$key]) && isset($field[$node->language])) { - foreach ($field[$node->language] as $value) { - switch ($association_fields[$key]['type']) { - case 'taxonomy_term_reference': - _topic_map_export_create_association_node_terms($context['results']['associations'], $dt, $value, $association_fields[$key]['type'] . '-' . $key); break; - + case 'node_reference': - _topic_map_export_create_association_node_reference($context['results']['associations'], $dt, $value, $association_fields[$key]['type'] . '-' . $key); break; } - } - } - } - + break; - + case EntityEnum::TYPE_COMMENT: - _topic_map_export_create_association_comment($context['results']['associations'], $dt); break; - } - } $context['sandbox']['current_topic'] = $topic_ilength; - + if ($context['sandbox']['max'] != $context['sandbox']['current_topic']) { $context['finished'] = $context['sandbox']['current_topic'] / $context['sandbox']['max']; } - - } /** * Creates assocations for comment type of topic */ function _topic_map_export_create_association_comment(&$associations, $topic) { - $settings = variable_get('topic_map_export_batch_settings'); - + $comment = comment_load($topic->id); - - # Three members: User - Comment - Node - + + // Three members: User - Comment - Node. + $comment_member = new stdClass(); $comment_member->actor = $topic->unique_id; - $comment_member->role = "entity_comment"; - - + $comment_member->role = 'entity_comment'; + $user_member = new stdClass(); - $user_member->actor = EntityEnum::TYPE_USER . "-" . $comment->uid; + $user_member->actor = EntityEnum::TYPE_USER . '-' . $comment->uid; $user_member->role = 'commentor'; - + $node_member = new stdClass(); - $node_member->actor = EntityEnum::TYPE_NODE . "-" . $comment->nid; + $node_member->actor = EntityEnum::TYPE_NODE . '-' . $comment->nid; $node_member->role = 'comment_target'; - - + $parent_member = NULL; - + if ($comment->pid > 0) { - $parent_member = new stdClass(); - $parent_member->actor = EntityEnum::TYPE_COMMENT . "-" . $comment->pid; - $parent_member->role = "parent_comment"; - + $parent_member->actor = EntityEnum::TYPE_COMMENT . '-' . $comment->pid; + $parent_member->role = 'parent_comment'; } - - - if (isset($settings['associations']['node-comment']) && $settings['associations']['node-comment']) + + if (isset($settings['associations']['node-comment']) && $settings['associations']['node-comment']) { $associations[] = new DrupalAssociation(array($comment_member, $node_member), 'comment-comment_target'); - - if (isset($settings['associations']['comment-user']) && $settings['associations']['comment-user']) + } + + if (isset($settings['associations']['comment-user']) && $settings['associations']['comment-user']) { $associations[] = new DrupalAssociation(array($user_member, $comment_member), 'comment-commentor'); - - if ($parent_member && isset($settings['associations']['comment-comment']) && $settings['associations']['comment-comment']) + } + + if ($parent_member && isset($settings['associations']['comment-comment']) && $settings['associations']['comment-comment']) { $associations[] = new DrupalAssociation(array($comment_member, $parent_member), 'comment-parent_comment'); - + } } /** * Creates assocation for user -> node creation type relationship */ function _topic_map_export_create_association_node_creation(&$associations, $topic) { - $settings = variable_get('topic_map_export_batch_settings'); - - if (!isset($settings['associations']['node-user']) || !$settings['associations']['node-user']) return; - - # Node - User Association + + if (!isset($settings['associations']['node-user']) || !$settings['associations']['node-user']) { + return; + } + + // Node - User Association. $node = node_load($topic->id); - + $node_member = new stdClass(); $node_member->actor = $topic->unique_id; - $node_member->role = "creation"; - + $node_member->role = 'creation'; + $user_member = new stdClass(); - $user_member->role = "creator"; - $user_member->actor = EntityEnum::TYPE_USER . "-" . $node->uid; - + $user_member->role = 'creator'; + $user_member->actor = EntityEnum::TYPE_USER . '-' . $node->uid; + $associations[] = new DrupalAssociation(array($node_member, $user_member), 'created-by'); - } /** * Creates assocation between node and its terms */ function _topic_map_export_create_association_node_terms(&$associations, $topic, $field_value, $association_name) { - $settings = variable_get('topic_map_export_batch_settings'); - - if (!isset($settings['associations']['node-taxonomy_term']) || !$settings['associations']['node-taxonomy_term']) return; - + + if (!isset($settings['associations']['node-taxonomy_term']) || !$settings['associations']['node-taxonomy_term']) { + return; + } + $node = node_load($topic->id); $term = taxonomy_term_load($field_value['tid']); - - - if (!$settings['bundles']['taxonomy_term'][$term->vocabulary_machine_name]) return FALSE; - + + if (!$settings['bundles']['taxonomy_term'][$term->vocabulary_machine_name]) { + return FALSE; + } + $node_member = new stdClass(); $node_member->actor = $topic->unique_id; - $node_member->role = 'entity_node' . "-bundle_" . $node->type; + $node_member->role = 'entity_node' . '-bundle_' . $node->type; $term_member = new stdClass(); - $term_member->actor = EntityEnum::TYPE_TERM . "-" . $term->tid; + $term_member->actor = EntityEnum::TYPE_TERM . '-' . $term->tid; $term_member->role = 'entity_taxonomy_term'; - + $associations[] = new DrupalAssociation(array($term_member, $node_member), $association_name); - } /** @@ -525,128 +464,112 @@ function _topic_map_export_create_association_node_terms(&$associations, $topic, * module enabled) */ function _topic_map_export_create_association_node_reference(&$associations, $topic, $field_value, $association_name) { - $settings = variable_get('topic_map_export_batch_settings'); - - if (!isset($settings['associations']['node:reference:node']) || !$settings['associations']['node:reference:node']) return; - + + if (!isset($settings['associations']['node:reference:node']) || !$settings['associations']['node:reference:node']) { + return; + } + $node = node_load($topic->id); $referred = node_load($field_value['nid']); - + $referrer_member = new stdClass(); $referrer_member->actor = $topic->unique_id; - $referrer_member->role = 'entity_node' . "-bundle_" . $node->type; + $referrer_member->role = 'entity_node' . '-bundle_' . $node->type; $referred_member = new stdClass(); - $referred_member->actor = EntityEnum::TYPE_NODE . "-" . $referred->nid; - $referred_member->role = 'entity_node' . "-bundle_" . $referred->type; - + $referred_member->actor = EntityEnum::TYPE_NODE . '-' . $referred->nid; + $referred_member->role = 'entity_node' . '-bundle_' . $referred->type; + $associations[] = new DrupalAssociation(array($referrer_member, $referred_member), $association_name); - } /** - * Last batch processing function. Goes through every created topic and + * Last batch processing function. Goes through every created topic and * association and writes them into the XTM file. */ function topic_map_export_process_create_topic_map(&$context) { - if (!isset($context['sandbox']['current_topic'])) { - $context['sandbox']['current_topic'] = 0; $context['sandbox']['current_association'] = 0; - + $context['finished'] = 0; - + $context['sandbox']['topic_keys'] = array_keys($context['results']['topics']); - + $context['sandbox']['max_topic'] = count($context['sandbox']['topic_keys']); $context['sandbox']['max_association'] = count($context['results']['associations']); - + $context['finished'] = 0; return; - } - + $limit = 10; - - # Begin top insertion - - $topic_ilength = min(array($context['sandbox']['max_topic'], $context['sandbox']['current_topic']+$limit)); - + + // Begin top insertion. + + $topic_ilength = min(array($context['sandbox']['max_topic'], $context['sandbox']['current_topic'] + $limit)); + $file = fopen($context['results']['topic_map'], 'a+'); - - for ($i=$context['sandbox']['current_topic']; $i < $topic_ilength; $i++) { - + + for ($i=$context['sandbox']['current_topic']; $i < $topic_ilength; $i++) { $key = $context['sandbox']['topic_keys'][$i]; $dt = $context['results']['topics'][$key]; fwrite($file, (string) $context['results']['topics'][$context['sandbox']['topic_keys'][$i]]); } - + fclose($file); - + $context['sandbox']['current_topic'] = $topic_ilength; - - # End topic insertion - - - # Begin association insertion - + + // End topic insertion. + + // Begin association insertion. + if ($context['sandbox']['current_topic'] == $context['sandbox']['max_topic']) { - - $asso_ilength = min(array($context['sandbox']['max_association'], $context['sandbox']['current_association']+$limit)); - + $asso_ilength = min(array($context['sandbox']['max_association'], $context['sandbox']['current_association'] + $limit)); + $file = fopen($context['results']['topic_map'], 'a'); - - for ($i=$context['sandbox']['current_association']; $i < $asso_ilength; $i++) { - - if (!$context['results']['associations'][$i]) continue; + + for ($i=$context['sandbox']['current_association']; $i < $asso_ilength; $i++) { + if (!$context['results']['associations'][$i]) { + continue; + } fwrite($file, (string) $context['results']['associations'][$i]); - } - + fclose($file); - + $context['sandbox']['current_association'] = $asso_ilength; - } - - - # End association insertion - - + + // End association insertion. + $totalmax = $context['sandbox']['max_topic'] + $context['sandbox']['max_association']; $totalcurrent = $context['sandbox']['current_topic'] + $context['sandbox']['current_association']; - if ($totalcurrent != $totalmax) { $context['finished'] = $totalcurrent / $totalmax; } - - } function topic_map_export_finished($success, $results, $operations) { - $file = fopen($results['topic_map'], 'a'); fwrite($file, ''); fclose($file); - - $msg = t("The exported topic map can be found !link_starthere!link_end.", array( + + $msg = t('The exported topic map can be found !link_starthere!link_end.', array( '!link_start' => '', '!link_end' => '' )); - + drupal_set_message(filter_xss($msg)); variable_del('topic_map_export_batch_settings'); - } - function _topic_map_export_get_supported_occurences() { - - // @todo For extensibilty I should be invoking some kind of hook here - + // @todo For extensibilty I should be invoking some kind of hook here. + $supported_occurrence_types = array( 'file' => 1, 'image' => 1, @@ -657,53 +580,39 @@ function _topic_map_export_get_supported_occurences() { 'text_long' => 1, 'text_with_summary' => 1, ); - + $existing_field_types = field_info_field_types(); $occurences = array_intersect_key($existing_field_types, $supported_occurrence_types); - + return $occurences; - - } - - function _topic_map_export_get_supported_fields() { - $fields = field_info_fields(); $occurences = _topic_map_export_get_supported_occurences(); - + foreach ($fields as $key => $field) { - if (!isset($occurences[$field['type']])) { unset($fields[$key]); } - } - + return $fields; - } - function _topic_map_export_get_association_fields() { - $fields = field_info_fields(); $types = array( 'node_reference' => 1, 'user_reference' => 1, 'taxonomy_term_reference' => 1, ); - + foreach ($fields as $key => $field) { - if (!isset($types[$field['type']])) { unset($fields[$key]); } - } - + return $fields; - } - diff --git a/includes/topic_map_classes.inc b/includes/topic_map_classes.inc index a6a088b..e627b09 100644 --- a/includes/topic_map_classes.inc +++ b/includes/topic_map_classes.inc @@ -7,8 +7,6 @@ * is called, and the Class prints a XTM complient version of it's self. */ - - /** * Enumeration of every currently supported topic types */ @@ -17,222 +15,198 @@ class EntityEnum { const TYPE_NODE = 'node'; const TYPE_NODE_TYPE = 'node_type'; const TYPE_COMMENT = 'comment'; - const TYPE_TERM = "term"; + const TYPE_TERM = 'term'; const TYPE_UNKNOWN = 'unknown'; } - /** * This represents the datamodel for a topic in Drupal(Topic can pretty much anything: node, user or a term). * Used to hold data necessary to create topic, when called __toString() method */ class DrupalTopic { - public $basename; public $id; public $type; - + public $unique_id; - + public $classes; public $occurrences; - + function __construct($entity, $type = NULL, $classes = array()) { - $this->type = $type; $this->classes = $classes; $this->occurrences = array(); - - - + // Trying to determine itself what type of topic is being created here. // Only if no type is given. if (!$this->type) { - if (isset($entity->nid)) { $this->type = EntityEnum::TYPE_NODE; - } + } elseif (isset($entity->uid)) { $this->type = EntityEnum::TYPE_USER; - } + } elseif (isset($entity->cid)) { $this->type = EntityEnum::TYPE_COMMENT; - } + } else { $this->type = EntityEnum::TYPE_UNKNOWN; } - + } - + // Based on type the topic is given id, its name and classes. switch ($this->type) { case EntityEnum::TYPE_NODE: $this->id = $entity->nid; $this->basename = $entity->title; - - $node_type = EntityEnum::TYPE_NODE_TYPE . "-" . $entity->type; - + + $node_type = EntityEnum::TYPE_NODE_TYPE . '-' . $entity->type; + if (!isset($this->classes[$node_type])) { - $this->classes['entity_node' . "-bundle_" . $entity->type] = TRUE; + $this->classes['entity_node' . '-bundle_' . $entity->type] = TRUE; } - break; + case EntityEnum::TYPE_USER: $this->id = $entity->uid; $this->basename = $entity->name; - + if ($entity->uid == 0) { - $this->basename = "Anonymous"; // Was there user defined version of anonymous username? + // @TODO Was there user defined version of anonymous username? + $this->basename = 'Anonymous'; } - - $this->classes['entity_user' . "-bundle_user"] = TRUE; + + $this->classes['entity_user' . '-bundle_user'] = TRUE; break; + case EntityEnum::TYPE_NODE_TYPE: $this->id = $entity->type; $this->basename = $entity->name; - $this->classes['entity_node' . "-bundle_" . $entity->type] = TRUE; + $this->classes['entity_node' . '-bundle_' . $entity->type] = TRUE; break; + case EntityEnum::TYPE_COMMENT: $this->id = $entity->cid; - $this->basename = truncate_utf8(check_plain($entity->subject), 60, TRUE) . "..."; - $this->classes['entity_comment' . "-bundle_" . $entity->node_type] = TRUE; + $this->basename = truncate_utf8(check_plain($entity->subject), 60, TRUE) . '...'; + $this->classes['entity_comment' . '-bundle_' . $entity->node_type] = TRUE; break; + case EntityEnum::TYPE_TERM: $this->id = $entity->tid; $this->basename = $entity->name; - $this->classes['entity_taxonomy_term' . "-bundle_" . $entity->vocabulary_machine_name] = TRUE; + $this->classes['entity_taxonomy_term' . '-bundle_' . $entity->vocabulary_machine_name] = TRUE; $this->occurrences[] = theme('topic_map_occurrence', array( - 'type' => "entity_taxonomy_term-bundle-" . $entity->vocabulary_machine_name . "-description", + 'type' => 'entity_taxonomy_term-bundle-' . $entity->vocabulary_machine_name . '-description', 'data' => check_plain(strip_tags($entity->description)) )); - break; + default: - throw new Exception("This type of entity is not supported", $this->type); + throw new Exception('This type of entity is not supported', $this->type); break; } - - - - + $supported_fields = _topic_map_export_get_supported_fields(); - - // Loop trough all supported fields and create occurrences based on the + + // Loop trough all supported fields and create occurrences based on the // entity's field. // Notice: Im iterating through object here, meaning that the following loop wont work on php4 - + foreach ($entity as $key => $field) { - - if (isset($supported_fields[$key]) && !empty($supported_fields[$key]) && isset($field[$entity->language])) { - - foreach ($field[$entity->language] as $value) { - - - switch ($supported_fields[$key]['type']) { case 'text': - $this->occurrences[] = theme('topic_map_occurrence', array( - 'type' => 'field-type-text', + 'type' => 'field-type-text', 'data' => check_plain(strip_tags($value['value'])) )); - - break; + case 'text_long': - $this->occurrences[] = theme('topic_map_occurrence', array( - 'type' => 'field-type-text_long', + 'type' => 'field-type-text_long', 'data' => check_plain(strip_tags($value['value'])) )); - break; + case 'text_with_summary': - $this->occurrences[] = theme('topic_map_occurrence', array( - 'type' => 'field-type-text_with_summary', + 'type' => 'field-type-text_with_summary', 'data' => check_plain(strip_tags($value['value'])) )); - break; - - case 'image': - + + case 'image': $this->occurrences[] = theme('topic_map_occurrence', array( - 'type' => 'field-type-image', + 'type' => 'field-type-image', 'dataref' => file_create_url($value['uri']), )); - break; - + } - - } - } - } - - $this->unique_id = $this->type . "-" . $this->id; - - + $this->unique_id = $this->type . '-' . $this->id; } - + public function __toString() { - - $site_url = ""; - # Subject identifier - + $site_url = ''; + // Subject identifier. + switch ($this->type) { - case EntityEnum::TYPE_NODE: $site_url = url("node/$this->id", array('absolute' => TRUE)); break; - case EntityEnum::TYPE_USER: $site_url = url("user/$this->id", array('absolute' => TRUE)); break; - case EntityEnum::TYPE_COMMENT: $site_url = url("comment/$this->id", array('absolute' => TRUE)); break; - case EntityEnum::TYPE_NODE_TYPE: $site_url = url("admin/structure/types/manage/$this->id", array('absolute' => TRUE)); break; - case EntityEnum::TYPE_TERM: $site_url = url("taxonomy/term/$this->id", array('absolute' => TRUE)); break; + case EntityEnum::TYPE_NODE: + $site_url = url("node/$this->id", array('absolute' => TRUE)); + break; + + case EntityEnum::TYPE_USER: + $site_url = url("user/$this->id", array('absolute' => TRUE)); + break; + + case EntityEnum::TYPE_COMMENT: + $site_url = url("comment/$this->id", array('absolute' => TRUE)); + break; + + case EntityEnum::TYPE_NODE_TYPE: + $site_url = url("admin/structure/types/manage/$this->id", array('absolute' => TRUE)); + break; + + case EntityEnum::TYPE_TERM: + $site_url = url("taxonomy/term/$this->id", array('absolute' => TRUE)); + break; } - - - return theme('topic_map_topic', array( - 'topic_id' => $this->unique_id, - 'si' => $site_url, - 'name' => $this->basename, - 'instOf' => array_keys($this->classes), - 'occurrences' => $this->occurrences, - )); - - - } + return theme('topic_map_topic', array( + 'topic_id' => $this->unique_id, + 'si' => $site_url, + 'name' => $this->basename, + 'instOf' => array_keys($this->classes), + 'occurrences' => $this->occurrences, + )); + } } /** * Holds information of two or more topic how they associate with themself. */ class DrupalAssociation { - public $members; public $type; - + function __construct($entities, $type_id) { - $this->type = $type_id; $this->members = $entities; - + } - + public function __toString() { - - return theme('topic_map_association', array( 'type' => $this->type, 'roles' => $this->members, )); - - - + } - } diff --git a/includes/forms.inc b/includes/topic_map_export.pages.inc similarity index 84% rename from includes/forms.inc rename to includes/topic_map_export.pages.inc index 58b3ec9..5312f3d 100644 --- a/includes/forms.inc +++ b/includes/topic_map_export.pages.inc @@ -1,15 +1,15 @@ - t('Select export preset you want to use.'), '#type' => 'select', @@ -23,14 +23,14 @@ function topic_map_export_export_form($form, &$form_state) { ), '#suffix' => '
', ); - + $entities_options = array( 'node' => t('Nodes'), 'user' => t('Users'), 'comment' => t('Comments'), 'taxonomy_term' => t('Taxonomy terms'), ); - + $available_associations = array( 'node-user' => t('Node <-> User'), 'comment-node' => t('Comment <-> Node'), @@ -38,24 +38,24 @@ function topic_map_export_export_form($form, &$form_state) { 'comment-comment' => t('Comment <-> Comment (Parent)'), 'node-taxonomy_term' => t('Node <-> Taxonomy terms'), ); - - if (module_exists('node_reference')) $available_associations['node:reference:node'] = t('Node <-> Node (Reference module)'); - - $description = ""; + + if (module_exists('node_reference')) { + $available_associations['node:reference:node'] = t('Node <-> Node (Reference module)'); + } + + $description = ''; $entities_defaults = array(); $associations_defaults= array(); - + switch ($selected_preset) { case 'full': - - $description = t('Full preset exports every entity, bundle and association. The ' . - 'resulting topic map can quite large.'); + $description = t('Full preset exports every entity, bundle and association. The resulting topic map can quite large.'); $entities_defaults = $entities_options; - $associations_defaults = $available_associations; // Just select everything - + // Just select everything. + $associations_defaults = $available_associations; break; + case 'normal': - $description = t('Normal preset exports nodes, users and comments with only few associations.'); $entities_defaults = array( 'node' => 'node', @@ -67,12 +67,10 @@ function topic_map_export_export_form($form, &$form_state) { 'comment-node' => 'comment-node', 'comment-user' => 'comment-user', ); - break; + case 'minimum': - - $description = t('Minimum preset exports only nodes, users and the node ' . - 'creation type association between them'); + $description = t('Minimum preset exports only nodes, users and the node creation type association between them'); $entities_defaults = array( 'node' => 'node', 'user' => 'user', @@ -80,14 +78,14 @@ function topic_map_export_export_form($form, &$form_state) { $associations_defaults = array( 'node-user' => 'node-user', ); - break; + case 'custom': $description = t('No description'); $entities_defaults = $form_state['input']['entities']; + break; } - - + $form['export_settings'] = array( '#type' => 'fieldset', '#title' => t('Topic Map export settings'), @@ -95,9 +93,11 @@ function topic_map_export_export_form($form, &$form_state) { '#suffix' => '', '#description' => $description, ); - - if($selected_preset == "custom") unset($form['export_settings']['#description']); - + + if ($selected_preset == 'custom') { + unset($form['export_settings']['#description']); + } + $form['export_settings']['entities'] = array( '#type' => 'checkboxes', '#title' => t('Select entities you wish to export as topic(s).'), @@ -110,61 +110,48 @@ function topic_map_export_export_form($form, &$form_state) { 'progress' => array('type' => 'none'), ), ); - + $selected_entities = $entities_defaults; - + if (isset($form_state['triggering_element']) && $form_state['triggering_element']['#ajax']['callback'] == 'topic_map_export_export_callback_update_bundles') { $selected_entities = (!isset($form_state['values'])) ? $entities_defaults : $form_state['values']['entities']; } - - - + + + foreach ($available_associations as $as_key => $value) { - $needed_entities = array(); - foreach ($entities_options as $ent => $ent_value) { - if (strpos($as_key, $ent) !== FALSE) { $needed_entities[$ent] = 1; } - } + $include_association = TRUE; - foreach ($needed_entities as $ent_key => $ent_value) { - if (!isset($selected_entities[$ent_key])) { $include_association = FALSE; - } + } elseif (!$selected_entities[$ent_key]) { $include_association = FALSE; } - } - + if (!$include_association) { unset($available_associations[$as_key]); } - } - - - $form['export_settings']['sub'] = array( + $form['export_settings']['sub'] = array( '#prefix' => '
', '#suffix' => '
' - ); - - + $custom_selector_callback = array( 'callback' => 'topic_map_export_export_callback_custom_callback', 'progress' => array('type' => 'none'), ); - - - + $form['export_settings']['sub']['associations'] = array( '#type' => 'checkboxes', '#title' => t('Select associations you wish to have described.'), @@ -172,29 +159,23 @@ function topic_map_export_export_form($form, &$form_state) { '#default_value' => $associations_defaults, '#ajax' => $custom_selector_callback, ); - - - + $form['export_settings']['sub']['scope'] = array( '#type' => 'fieldset', '#title' => t('Bundles to export'), '#prefix' => '
', '#suffix' => '
', - '#collapsible' => TRUE, + '#collapsible' => TRUE, '#collapsed' => FALSE, ); - + foreach ($selected_entities as $key => $value) { - if ($value) { - switch ($key) { case 'node': - $options = array(); $defaults = array(); - $types = node_type_get_types(); - foreach ($types as $key_type => $type) { + foreach (node_type_get_types() as $key_type => $type) { $defaults[$type->type] = $type->type; $options[$type->type] = $type->name; } @@ -206,13 +187,11 @@ function topic_map_export_export_form($form, &$form_state) { '#ajax' => $custom_selector_callback, ); break; + case 'taxonomy_term': - $options = array(); $defaults = array(); - $vocabularies = taxonomy_vocabulary_get_names(); - - foreach ($vocabularies as $key_voc => $vocabulary) { + foreach (taxonomy_vocabulary_get_names() as $key_voc => $vocabulary) { $defaults[$vocabulary->machine_name] = $vocabulary->machine_name; $options[$vocabulary->machine_name] = $vocabulary->name; } @@ -224,60 +203,53 @@ function topic_map_export_export_form($form, &$form_state) { '#ajax' => $custom_selector_callback, ); break; - } - } - } - + $form_state['input']['entities'] = $entities_defaults; $form_state['input']['associations'] = $associations_defaults; - + $form['submit'] = array( '#type' => 'submit', '#value' => t('Export'), ); - + return $form; - } function topic_map_export_export_callback_update_settings($form, $form_state) { return $form['export_settings']; } - /** - * Changes the preset selector to "custom" value. Is called when any user made + * Changes the preset selector to 'custom' value. Is called when any user made * changed are made to entities selection. - * + * * Also changes the form to reflect the selected entities. */ function topic_map_export_export_callback_update_bundles($form, $form_state) { - $commands = array(); - + $formi = ajax_process_form($form['export_settings']['sub'], $form_state); - - $commands[] = ajax_command_replace("#tm-export-sub-settings", render($formi)); - $commands[] = ajax_command_invoke("form #edit-preset-selector", 'val', array('custom')); + + $commands[] = ajax_command_replace('#tm-export-sub-settings', render($formi)); + $commands[] = ajax_command_invoke('form #edit-preset-selector', 'val', array('custom')); $commands[] = ajax_command_invoke("form fieldset[id^='edit-export-settings'] .fieldset-description:first", 'hide', array()); - + return array('#type' => 'ajax', '#commands' => $commands); - } /** - * Changes the preset selector to "custom" value. Is called when any minor + * Changes the preset selector to 'custom' value. Is called when any minor * setting is changed on the form. - * + * * @todo This should be probably implemented on the client instead making * callbacks to server. */ function topic_map_export_export_callback_custom_callback($form, $form_state) { $commands = array(); - $commands[] = ajax_command_invoke("form #edit-preset-selector", 'val', array('custom')); + $commands[] = ajax_command_invoke('form #edit-preset-selector', 'val', array('custom')); $commands[] = ajax_command_invoke("form fieldset[id^='edit-export-settings'] .fieldset-description:first", 'hide', array()); return array('#type' => 'ajax', '#commands' => $commands); } @@ -289,8 +261,6 @@ function topic_map_export_export_callback_custom_callback($form, $form_state) { * Upon submission the Topic Map batch processing is started. */ function topic_map_export_export_form_submit($form, &$form_state) { - module_load_include('inc', 'topic_map_export', 'includes/export_batch'); topic_map_export_topic_map($form_state['values']); - } diff --git a/templates/association.tpl.php b/templates/association.tpl.php index 26dd6a9..4fb3dc7 100644 --- a/templates/association.tpl.php +++ b/templates/association.tpl.php @@ -11,7 +11,7 @@ ?> - + @@ -24,4 +24,4 @@ - \ No newline at end of file + diff --git a/templates/occurrence.tpl.php b/templates/occurrence.tpl.php index 75d377a..81810ee 100644 --- a/templates/occurrence.tpl.php +++ b/templates/occurrence.tpl.php @@ -15,10 +15,10 @@ - + - + - \ No newline at end of file + diff --git a/templates/topic-map-entities-and-bundles.tpl.php b/templates/topic-map-entities-and-bundles.tpl.php index a8b1362..3fa1e37 100644 --- a/templates/topic-map-entities-and-bundles.tpl.php +++ b/templates/topic-map-entities-and-bundles.tpl.php @@ -7,9 +7,9 @@ * Available variables: * - $entities: List supported entities(keys) and bundles(values) */ +?> -foreach ($entities as $key => $entity): - ?> + $entity): ?> TRUE)); ?>" /> @@ -25,53 +25,46 @@ foreach ($entities as $key => $entity): bundle description - $bundle): ?> - - TRUE)); ?>" /> - - - - - - - $bundle): ?> + + TRUE)); ?>" /> + + + + + + + description; - break; - case 'taxonomy_term': - $full_bundle = taxonomy_vocabulary_machine_name_load($bundle_key); - $descr = $full_bundle->description; - break; - } - - if(!empty($descr)) : - $descr = check_plain(strip_tags($descr)); -?> - - - - - - - - - - TRUE)); ?>" /> - - description - - - - + switch ($key) { + case 'node': + $full_bundle = node_type_load($bundle_key); + $descr = $full_bundle->description; + break; + case 'taxonomy_term': + $full_bundle = taxonomy_vocabulary_machine_name_load($bundle_key); + $descr = $full_bundle->description; + break; + } + + if (!empty($descr)): + $descr = check_plain(strip_tags($descr)); + ?> + + + + + + + + + + TRUE)); ?>" /> + + description + + + + diff --git a/templates/topic-map-header.tpl.php b/templates/topic-map-header.tpl.php index 1c50803..e0eedb3 100644 --- a/templates/topic-map-header.tpl.php +++ b/templates/topic-map-header.tpl.php @@ -1,5 +1,7 @@ - '; ?> @@ -8,4 +10,4 @@ - \ No newline at end of file + diff --git a/templates/topic-map-occurence-types.tpl.php b/templates/topic-map-occurence-types.tpl.php index 40b7296..c160d8d 100644 --- a/templates/topic-map-occurence-types.tpl.php +++ b/templates/topic-map-occurence-types.tpl.php @@ -8,10 +8,10 @@ * Available variables: * - $occurrences: List occurrences */ - -foreach ($occurrences as $key => $value): ?> + $value): ?> + @@ -28,4 +28,4 @@ foreach ($occurrences as $key => $value): Field description - \ No newline at end of file + diff --git a/templates/topic-map-roles-and-association-types.tpl.php b/templates/topic-map-roles-and-association-types.tpl.php index b7e83b7..27173a9 100644 --- a/templates/topic-map-roles-and-association-types.tpl.php +++ b/templates/topic-map-roles-and-association-types.tpl.php @@ -7,13 +7,13 @@ * Available variables: * - $association_fields: List supported association fields. */ - -foreach ($association_fields as $key => $value): ?> - "> + $value): ?> + + - + @@ -28,7 +28,7 @@ foreach ($association_fields as $key => $value): Referred - + @@ -45,7 +45,7 @@ foreach ($association_fields as $key => $value): Creator - + Comment - Commenter @@ -56,7 +56,7 @@ foreach ($association_fields as $key => $value): Commentor - + Comment - Commenter @@ -67,7 +67,7 @@ foreach ($association_fields as $key => $value): Comment target - + Comment - Parent Comment diff --git a/templates/topic.tpl.php b/templates/topic.tpl.php index 485f580..eb4b8cb 100644 --- a/templates/topic.tpl.php +++ b/templates/topic.tpl.php @@ -14,34 +14,34 @@ ?> - $value): + foreach ($si as $key => $value): ?> - - + - $value): + foreach($instOf as $key => $value): ?> - - $value) { @@ -50,4 +50,4 @@ if (!empty($occurrences)) { } ?> - \ No newline at end of file + diff --git a/topic_map_export.info b/topic_map_export.info index 49e607b..e20bb44 100644 --- a/topic_map_export.info +++ b/topic_map_export.info @@ -1,5 +1,4 @@ name = Topic Map Export -description = "Topic Map Export is a configurable exporter for Drupal 7 that generates a topic map out of Drupal content." +description = Topic Map Export is a configurable exporter for Drupal 7 that generates a topic map out of Drupal content. core = 7.x -version = 7.x-1.x-dev -files[] = includes/topic_map_classes.inc \ No newline at end of file +files[] = includes/topic_map_classes.inc diff --git a/topic_map_export.install b/topic_map_export.install new file mode 100644 index 0000000..8f330f0 --- /dev/null +++ b/topic_map_export.install @@ -0,0 +1,13 @@ + 'Export topic map', 'access arguments' => array('export topic map'), 'page callback' => 'drupal_get_form', 'page arguments' => array('topic_map_export_export_form'), 'type' => MENU_CALLBACK, - 'file' => 'includes/forms.inc' + 'file' => 'includes/topic_map_export.pages.inc' ); - + $items['topic_map/testing'] = array( 'access arguments' => array('access content'), 'page callback' => 'topic_map_export_testing', 'type' => MENU_CALLBACK ); - - + return $items; - } /** * Implements hook_theme(). */ function topic_map_export_theme($existing, $type, $theme, $path) { - - $items['topic_map_entities_and_bundles'] = array( - 'template' => 'topic-map-entities-and-bundles', - 'variables' => array('entities' => array()), - ); - - $items['topic_map_header'] = array( - 'template' => 'topic-map-header', - 'variables' => array('site_name' => "Drupal site"), - ); - - $items['topic_map_occurence_types'] = array( - 'template' => 'topic-map-occurence-types', - 'variables' => array('occurrences' => array()), - ); - - $items['topic_map_roles_and_association_types'] = array( - 'template' => 'topic-map-roles-and-association-types', - 'variables' => array('association_fields' => array()), + $base = array( + 'path' => $path . '/templates', ); - $items['topic_map_topic'] = array( - 'template' => 'topic', - 'variables' => array('id' => NULL, 'si' => array(), 'name' => array(), 'instOf' => array(), 'occurrences' => array()), - ); - - $items['topic_map_association'] = array( - 'template' => 'association', - 'variables' => array('type' => NULL, 'data' => '', 'roles' => array()), - ); - - $items['topic_map_occurrence'] = array( - 'template' => 'occurrence', - 'variables' => array('type' => NULL, 'data' => "", 'dataref' => ""), + return array( + 'topic_map_entities_and_bundles' => $base + array( + 'template' => 'topic-map-entities-and-bundles', + 'variables' => array('entities' => array()), + ), + 'topic_map_header' => $base + array( + 'template' => 'topic-map-header', + 'variables' => array('site_name' => 'Drupal site'), + ), + 'topic_map_occurence_types' => $base + array( + 'template' => 'topic-map-occurence-types', + 'variables' => array('occurrences' => array()), + ), + 'topic_map_roles_and_association_types' => $base + array( + 'template' => 'topic-map-roles-and-association-types', + 'variables' => array('association_fields' => array()), + ), + 'topic_map_topic' => $base + array( + 'template' => 'topic', + 'variables' => array('id' => NULL, 'si' => array(), 'name' => array(), 'instOf' => array(), 'occurrences' => array()), + ), + 'topic_map_association' => $base + array( + 'template' => 'association', + 'variables' => array('type' => NULL, 'data' => '', 'roles' => array()), + ), + 'topic_map_occurrence' => $base + array( + 'template' => 'occurrence', + 'variables' => array('type' => NULL, 'data' => '', 'dataref' => ''), + ), ); - - - foreach ($items as $key => $value) { - $items[$key]['path'] = drupal_get_path('module', 'topic_map_export') . "/templates"; - } - - return $items; - -} - - -/** - * Implements hook_uninstall(). - */ -function topic_map_export_uninstall() { - variable_del('topic_map_export_batch_settings'); }