diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index eebe3fc..78085e0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ # aircox Platform to manage radio programs, schedules, cms, etc. -- main test repo + +# Applications +* **programs**: core application that have all defined models +* **monitor**: monitor file system for new podcasts and sounds + + + diff --git a/programs/__init__.py b/programs/__init__.py new file mode 100755 index 0000000..e69de29 diff --git a/programs/admin.py b/programs/admin.py new file mode 100755 index 0000000..441924b --- /dev/null +++ b/programs/admin.py @@ -0,0 +1,119 @@ +import copy + +from django.contrib import admin +import programs.models as models + + +# +# Inlines +# +# TODO: inherits from the corresponding admin view +class SoundFileInline (admin.TabularInline): + model = models.SoundFile + extra = 1 + + +class EpisodeInline (admin.StackedInline): + model = models.Episode + extra = 0 + + +class ScheduleInline (admin.TabularInline): + model = models.Schedule + extra = 0 + + + + +class EventInline (admin.StackedInline): + model = models.Event + extra = 0 + +# +# Parents +# +class MetadataAdmin (admin.ModelAdmin): + fieldsets = [ + ( None, { + 'fields': [ 'title', 'tags' ] + }), + ( 'metadata', { + 'fields': [ 'date' ], + 'classes': ['collapse'] + }), + ] + + + def save_model(self, request, obj, form, change): + if not obj.author: + obj.author = request.user + obj.save() + + + +class PublicationAdmin (MetadataAdmin): + fieldsets = copy.deepcopy(MetadataAdmin.fieldsets) + + list_display = ('id', 'title', 'date', 'status') + list_filter = ['date', 'status'] + search_fields = ['title', 'content'] + + + def __init__ (self, *args, **kwargs): + self.fieldsets[0][1]['fields'].insert(1, 'subtitle') + self.fieldsets[0][1]['fields'] += [ 'img', 'content' ] + self.fieldsets[1][1]['fields'] += [ 'parent', 'status', 'enable_comments', 'meta' ], + return super(PublicationAdmin, self).__init__(*args, **kwargs) + + +# +# ModelAdmin list +# +#class TrackAdmin (MetadataAdmin): +# fieldsets = [ +# (None, { 'fields': [ 'title', 'artist', 'version', 'tags'] } ) +# ] + +class SoundFileAdmin (MetadataAdmin): + fieldsets = [ + (None, { 'fields': ['title', 'tags', 'file', 'embed' ] } ), + ('metadata', { 'fields': ['duration', 'date', 'podcastable', 'fragment' ] } ) + ] + + #inlines = [ EpisodeInline ] + + + +class ArticleAdmin (PublicationAdmin): + fieldsets = copy.deepcopy(PublicationAdmin.fieldsets) + + fieldsets[1][1]['fields'] += ['static_page'] + + + +class ProgramAdmin (PublicationAdmin): + fieldsets = copy.deepcopy(PublicationAdmin.fieldsets) + prepopulated_fields = { 'tag': ('title',) } + inlines = [ EpisodeInline, ScheduleInline ] + + fieldsets[1][1]['fields'] += ['email', 'url', 'tag'] + + + +class EpisodeAdmin (PublicationAdmin): + fieldsets = copy.deepcopy(PublicationAdmin.fieldsets) + inlines = [ EventInline, SoundFileInline ] + list_filter = ['parent'] + PublicationAdmin.list_filter + + fieldsets[0][1]['fields'] += ['tracks'] + + + +admin.site.register(models.Track) +admin.site.register(models.SoundFile, SoundFileAdmin) +admin.site.register(models.Schedule) +admin.site.register(models.Article, ArticleAdmin) +admin.site.register(models.Program, ProgramAdmin) +admin.site.register(models.Episode, EpisodeAdmin) +admin.site.register(models.Event) + diff --git a/programs/locale/fr_BE/LC_MESSAGES/django.mo b/programs/locale/fr_BE/LC_MESSAGES/django.mo new file mode 100644 index 0000000..cfd3e6d Binary files /dev/null and b/programs/locale/fr_BE/LC_MESSAGES/django.mo differ diff --git a/programs/locale/fr_BE/LC_MESSAGES/django.po b/programs/locale/fr_BE/LC_MESSAGES/django.po new file mode 100644 index 0000000..d1aaa76 --- /dev/null +++ b/programs/locale/fr_BE/LC_MESSAGES/django.po @@ -0,0 +1,237 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-09-02 17:05+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: models.py:51 +msgid "ponctual" +msgstr "" + +#: models.py:52 +msgid "every week" +msgstr "toutes les semaines" + +#: models.py:53 +msgid "first week" +msgstr "1ère semaine du mois" + +#: models.py:54 +msgid "second week" +msgstr "2ème semaine du mois" + +#: models.py:55 +msgid "third week" +msgstr "3ème semaine du mois" + +#: models.py:56 +msgid "fourth week" +msgstr "4ème semaine du mois" + +#: models.py:57 +msgid "first and third" +msgstr "la 1ère et 2ème semaine du mois" + +#: models.py:58 +msgid "second and fourth" +msgstr "la 2ème et 4ème semaine du mois" + +#: models.py:59 +msgid "one week on two" +msgstr "une semaine sur deux" + +#: models.py:74 +msgid "author" +msgstr "auteur" + +#: models.py:78 models.py:568 +msgid "date" +msgstr "date" + +#: models.py:81 models.py:332 +msgid "title" +msgstr "titre" + +#: models.py:89 models.py:565 +msgid "meta" +msgstr "metadonnées" + +#: models.py:93 +msgid "tags" +msgstr "mots-clés" + +#: models.py:125 +msgid "subtitle" +msgstr "sous-titre" + +#: models.py:129 +msgid "image" +msgstr "image" + +#: models.py:133 +msgid "content" +msgstr "contenu" + +#: models.py:136 models.py:575 +msgid "status" +msgstr "statut" + +#: models.py:140 +msgid "enable comments" +msgstr "activer les commentaires" + +#: models.py:328 +msgid "artist" +msgstr "artiste" + +#: models.py:335 +msgid "version" +msgstr "version" + +#: models.py:338 +msgid "additional informations on that track" +msgstr "informations supplémentaires sur cette piste" + +#: models.py:343 +msgid "by" +msgstr "par" + +#: models.py:348 +msgid "track" +msgstr "piste" + +#: models.py:349 +msgid "tracks" +msgstr "pistes" + +#: models.py:356 +msgid "file" +msgstr "fichier" + +#: models.py:360 models.py:380 models.py:570 +msgid "duration" +msgstr "durée" + +#: models.py:364 +msgid "podcastable" +msgstr "peut être podcasté" + +#: models.py:366 +msgid "if checked, the file can be podcasted" +msgstr "si coché, le fichier peut être podcasté" + +#: models.py:368 +msgid "incomplete sound" +msgstr "son incomplet" + +#: models.py:370 +msgid "the file has been cut" +msgstr "le fichier a été monté" + +#: models.py:378 +msgid "schedule" +msgstr "horaire" + +#: models.py:379 +msgid "frequency" +msgstr "fréquence" + +#: models.py:381 models.py:452 +msgid "rerun" +msgstr "rediffusion" + +#: models.py:464 models.py:485 models.py:524 +msgid "parent" +msgstr "parent" + +#: models.py:468 +msgid "static page" +msgstr "page statique" + +#: models.py:471 +msgid "article is focus" +msgstr "l'article est épinglé" + +#: models.py:477 +msgid "Article" +msgstr "Article" + +#: models.py:478 +msgid "Articles" +msgstr "Articles" + +#: models.py:490 +msgid "email" +msgstr "email" + +#: models.py:495 +msgid "website" +msgstr "site" + +#: models.py:499 +msgid "tag" +msgstr "mot-clé" + +#: models.py:501 +msgid "used in articles to refer to it" +msgstr "utilisé par les articles pour y faire référence" + +#: models.py:510 +msgid "Emission" +msgstr "Émission" + +#: models.py:511 +msgid "Emissions" +msgstr "Émissions" + +#: models.py:529 +msgid "podcast file" +msgstr "fichier de podcast" + +#: models.py:534 +msgid "playlist" +msgstr "playlist" + +#: models.py:543 +#, python-format +msgid "An unknown name for this episode of %s" +msgstr "Cette épisode de %s n'a pas encore de nom" + +#: models.py:551 +msgid "Episode" +msgstr "Épisode" + +#: models.py:552 +msgid "Episodes" +msgstr "Épisodes" + +#: models.py:561 +msgid "episode" +msgstr "épisode" + +#: models.py:573 +msgid "this is just indicative" +msgstr "juste indicatif" + +#: models.py:578 +msgid "canceled" +msgstr "annulé" + +#~ msgid "third %s of the month" +#~ msgstr "le troisième %s du mois" + +#~ msgid "fourth %s of the month" +#~ msgstr "le quatrième %s du mois" diff --git a/programs/management/__init__.py b/programs/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/programs/management/commands/__init__.py b/programs/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/programs/management/commands/_private.py b/programs/management/commands/_private.py new file mode 100644 index 0000000..e69de29 diff --git a/programs/management/commands/monitor.py b/programs/management/commands/monitor.py new file mode 100644 index 0000000..5ea6464 --- /dev/null +++ b/programs/management/commands/monitor.py @@ -0,0 +1,29 @@ +import os + +from django.core.management.base import BaseCommand, CommandError +import programs.models as models +import programs.settings + +class Command(BaseCommand): + help= "Take a look at the programs directory to check on new podcasts" + + + + + def handle(self, *args, **options): + programs = models.Program.objects.filter(schedule__isnull = True) + + for program in programs: + self.scan(program, program.path + '/public', public = True) + self.scan(program, program.path + '/podcasts', embed = True) + self.scan(program, program.path + '/private') + + + def scan (self, program, path, public = False, embed = False): + try: + for filename in os.listdir(path): + long_filename = path + '/' + filename + + except: + pass + diff --git a/programs/models.py b/programs/models.py new file mode 100755 index 0000000..1f0cab4 --- /dev/null +++ b/programs/models.py @@ -0,0 +1,513 @@ +import datetime + +# django +from django.db import models +from django.contrib.auth.models import User +from django.template.defaultfilters import slugify + +from django.http import HttpResponse, Http404 + +from django.contrib.contenttypes.fields import GenericForeignKey +from django.contrib.contenttypes.models import ContentType + +from django.shortcuts import get_object_or_404 +from django.utils.translation import ugettext as _, ugettext_lazy +from django.utils import timezone +from django.utils.html import strip_tags + +from django.conf import settings + +# extensions +from taggit.managers import TaggableManager + + +import programs.settings as settings + + + +AStatus = { + 'private': 0, + 'public': 1, + # 'canceled': 2, + # 'finished': 3, +} + +Status = [ (y, ugettext_lazy(x)) for x,y in AStatus.items() ] +RStatus = { y: x for x,y in AStatus.items() } + + +AFrequency = { + 'ponctual': 0x000000, + 'every week': 0b001111, + 'first week': 0x000001, + 'second week': 0x000010, + 'third week': 0x000100, + 'fourth week': 0x001000, + 'first and third': 0x000101, + 'second and fourth': 0x001010, + 'one week on two': 0x010010, + #'uneven week': 0x100000, + # TODO 'every day': 0x110000 +} + + +# Translators: html safe values +ugettext_lazy('ponctual') +ugettext_lazy('every week') +ugettext_lazy('first week') +ugettext_lazy('second week') +ugettext_lazy('third week') +ugettext_lazy('fourth week') +ugettext_lazy('first and third') +ugettext_lazy('second and fourth') +ugettext_lazy('one week on two') + + +Frequency = [ (y, x) for x,y in AFrequency.items() ] +RFrequency = { y: x for x,y in AFrequency.items() } + +Frequency.sort(key = lambda e: e[0]) + + +class Model (models.Model): + @classmethod + def type (cl): + """ + Return a string with the type of the model (class name lowered) + """ + name = cl.__name__.lower() + return name + + @classmethod + def type_plural (cl): + """ + Return a string with the name in plural of the model (cf. name()) + """ + return cl.type() + 's' + + + @classmethod + def name (cl, plural = False): + """ + Return the name of the model using meta.verbose_name + """ + if plural: + return cl._meta.verbose_name_plural.title() + return cl._meta.verbose_name.title() + + + class Meta: + abstract = True + + + +class Metadata (Model): + """ + meta is used to extend a model for future needs + """ + author = models.ForeignKey ( + User, + verbose_name = _('author'), + blank = True, + null = True ) + date = models.DateTimeField( + _('date'), + default = datetime.datetime.now ) + title = models.CharField( + _('title'), + max_length = 128 ) + meta = models.TextField( + _('meta'), + blank = True, + null = True ) + tags = TaggableManager( + _('tags'), + blank = True ) + + class Meta: + abstract = True + + + +class Publication (Metadata): + def get_slug_name (self): + return slugify(self.title) + + def __str__ (self): + return self.title + ' (' + str(self.id) + ')' + + subtitle = models.CharField( + _('subtitle'), + max_length = 128, + blank = True ) + img = models.ImageField( + _('image'), + upload_to = "images", + blank = True ) + content = models.TextField( + _('content'), + blank = True ) + status = models.SmallIntegerField( + _('status'), + choices = Status, + default = AStatus['public'] ) + enable_comments = models.BooleanField( + _('enable comments'), + default = True, + help_text = 'select to enable comments') + + + # + # Class methods + # + + @staticmethod + def _exclude_args (allow_unpublished = False, prefix = ''): + if allow_unpublished: + return {} + + res = {} + res[prefix + 'status'] = AStatus['private'] + res[prefix + 'date__gt'] = timezone.now() + return res + + + @classmethod + def get_available (cl, first = False, **kwargs): + """ + Return the result of filter(kargs) if the resulting publications + is published and public + + Otherwise, return None + """ + kwargs['status'] = AStatus['public'] + kwargs['date__lte'] = timezone.now() + + e = cl.objects.filter(**kwargs) + + if first: + return (e and e[0]) or None + return e or None + + + # + # Instance's methods + # + def is_private (self): + return self.status == AStatus['private'] + + + def get_parent (self, raise_404 = False ): + if not parent and raise_404: + raise Http404 + return parent + + + def get_parents ( self, order_by = "desc", include_fields = None ): + """ + Return an array of the parents of the item. + If include_fields is an array of files to include. + """ + # TODO: fields included + # FIXME: parameter name + container + parents = [ self ] + while parents[-1].parent: + parent = parents[-1].parent + if parent not in parents: + # avoid cycles + parents.append(parent) + + parents = parents[1:] + + if order_by == 'desc': + return reversed(parents) + return parents + + + class Meta: + abstract = True + + + +# +# Final models +# + +class Track (Model): + artist = models.CharField( + _('artist'), + max_length = 128, + blank = True) + title = models.CharField( + _('title'), + max_length = 128 ) + version = models.CharField( + _('version'), + max_length = 128, + blank = True, + help_text = _('additional informations on that track')) + tags = TaggableManager( blank = True ) + + + def __str__(self): + return ' '.join([self.title, _('by'), self.artist, + (self.version and ('(' + self.version + ')') or '') ]) + + + class Meta: + verbose_name = _('Track') + verbose_name_plural = _('Tracks') + + + +class SoundFile (Metadata): + parent = models.ForeignKey( + 'Episode', + verbose_name = _('episode'), + blank = True, + null = True ) + file = models.FileField( + _('file'), + upload_to = "data/tracks", + blank = True ) + duration = models.TimeField( + _('duration'), + blank = True, + null = True ) + podcastable = models.BooleanField( + _('podcastable'), + default = False, + help_text = _('if checked, the file can be podcasted from this server')) + fragment = models.BooleanField( + _('incomplete sound'), + default = False, + help_text = _("the file has been cut")) + embed = models.TextField ( + _('embed HTML code from external website'), + blank = True, + null = True, + help_text = _('if set, consider the sound podcastable from there') + ) + + + def __str__ (self): + return str(self.id) + ': ' + self.file.name + + + class Meta: + verbose_name = _('Sound') + verbose_name_plural = _('Sounds') + + + + +class Schedule (Model): + parent = models.ForeignKey( 'Program', blank = True, null = True ) + date = models.DateTimeField(_('schedule')) + frequency = models.SmallIntegerField(_('frequency'), choices = Frequency) + duration = models.TimeField(_('duration')) + rerun = models.BooleanField(_('rerun'), default = False) + + + def match_week (self, at = datetime.date.today()): + """ + Return True if the given week number matches the schedule, False + otherwise. + If the schedule is ponctual, return None. + """ + if self.frequency == AFrequency['ponctual']: + return None + + if self.frequency == AFrequency['one week on two']: + week = at.isocalendar()[1] + return (week % 2) == (self.date.isocalendar()[1] % 2) + + first_of_month = datetime.date(at.year, at.month, 1) + week = at.isocalendar()[1] - first_of_month.isocalendar()[1] + + # weeks of month + if week == 4: + # fifth week: return if for every week + return self.frequency == 0b1111 + return (self.frequency & (0b0001 << week) > 0) + + + + def next_date (self, at = datetime.date.today()): + if self.frequency == AFrequency['ponctual']: + return None + + print('#####') + # first day of the week + date = at - datetime.timedelta( days = at.weekday() ) + + # for the next five week, we look for a matching week. + # when found, add the number of day since de start of the + # we need to test if the result is >= at + for i in range(0,5): + if self.match_week(date): + date_ = date + datetime.timedelta( days = self.date.weekday() ) + if date_ >= at: + # we don't want past events + return datetime.datetime(date_.year, date_.month, date_.day, + self.date.hour, self.date.minute) + date += datetime.timedelta( days = 7 ) + else: + return None + + + def next_dates (self, at = datetime.date.today(), n = 52): + # we could have optimized this function, but since it should not + # be use too often, we keep a more readable and easier to debug + # solution + if self.frequency == 0b000000: + return None + + res = [] + for i in range(n): + e = self.next_date(at) + if not e: + break + res.append(e) + at = res[-1] + datetime.timedelta(days = 1) + + return res + + + def to_string(self): + s = ugettext_lazy( RFrequency[self.frequency] ) + if self.rerun: + return s + ' (' + _('rerun') + ')' + return s + + + def __str__ (self): + return self.parent.title + ': ' + RFrequency[self.frequency] + + + class Meta: + verbose_name = _('Schedule') + verbose_name_plural = _('Schedules') + + + + +class Article (Publication): + parent = models.ForeignKey( + 'self', + verbose_name = _('parent'), + blank = True, + null = True ) + static_page = models.BooleanField( + _('static page'), + default = False ) + focus = models.BooleanField( + _('article is focus'), + blank = True, + default = False ) + + + class Meta: + verbose_name = _('Article') + verbose_name_plural = _('Articles') + + + +class Program (Publication): + parent = models.ForeignKey( + Article + , verbose_name = _('parent') + , blank = True + , null = True + ) + email = models.EmailField( + _('email') + , max_length = 128 + , null = True + , blank = True + ) + url = models.URLField( + _('website') + , blank = True + , null = True + ) + tag = models.CharField( + _('tag') + , max_length = 64 + , help_text = _('used in articles to refer to it') + ) + + @property + def path(self): + return settings.AIRCOX_PROGRAMS_DATA + slugify(self.title + '_' + self.id) + + + class Meta: + verbose_name = _('Program') + verbose_name_plural = _('Programs') + + + +class Episode (Publication): + # Note: + # We do not especially need a duration here, because even if an + # emussion's schedule can have specified durations, in practice this + # duration may vary. Furthermore, we want the users have to enter a + # minimum of values. + # Duration can be retrieved from the sound file if there is one. + # + parent = models.ForeignKey( + Program, + verbose_name = _('parent'), + blank = True, + null = True ) + tracks = models.ManyToManyField( + Track, + verbose_name = _('playlist'), + blank = True ) + + + class Meta: + verbose_name = _('Episode') + verbose_name_plural = _('Episodes') + + + +class Event (Model): + """ + """ + parent = models.ForeignKey ( + Episode, + verbose_name = _('episode'), + blank = True, + null = True ) + + meta = models.TextField ( + _('meta'), + blank = True, + null = True ) + date = models.DateTimeField( _('date') ) + duration = models.TimeField( + _('duration'), + blank = True, + null = True, + help_text = _('this is just indicative')) + status = models.SmallIntegerField( + _('status'), + choices = Status, + default = AStatus['public'] ) + canceled = models.BooleanField( _('canceled'), default = False ) + + + def testify (self): + parent = self.parent + self.parent.testify() + self.parent.date = self.date + return self.parent + + + class Meta: + verbose_name = _('Event') + verbose_name_plural = _('Events') + + diff --git a/programs/requirements.txt b/programs/requirements.txt new file mode 100644 index 0000000..867b0f3 --- /dev/null +++ b/programs/requirements.txt @@ -0,0 +1,4 @@ +Django>=1.9.0 +taggit + + diff --git a/programs/settings.py b/programs/settings.py new file mode 100755 index 0000000..334bff9 --- /dev/null +++ b/programs/settings.py @@ -0,0 +1,10 @@ +from django.conf import settings + +def ensure (key, default): + globals()[key] = getattr(settings, key, default) + + +ensure('AIRCOX_PROGRAMS_DATA', settings.MEDIA_ROOT + '/programs') + + + diff --git a/programs/tests.py b/programs/tests.py new file mode 100755 index 0000000..7ce503c --- /dev/null +++ b/programs/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/programs/views.py b/programs/views.py new file mode 100755 index 0000000..8e0ebc8 --- /dev/null +++ b/programs/views.py @@ -0,0 +1,2 @@ +from django.shortcuts import render +