# HG changeset patch # User Guido Berhoerster # Date 1425983242 -3600 # Node ID dfe10c951e217a4af0df23db0820efbda437e464 Initial revision diff -r 000000000000 -r dfe10c951e21 COPYING --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/COPYING Tue Mar 10 11:27:22 2015 +0100 @@ -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 -r 000000000000 -r dfe10c951e21 notification.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/notification.py Tue Mar 10 11:27:22 2015 +0100 @@ -0,0 +1,852 @@ +# +# Copyright (C) 2014 Guido Berhoerster +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3 as +# published by the Free Software Foundation. +# +# 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 . +# + +import os +import sys +import time +import re +import select +import signal +import errno +import fcntl +import cgi +import multiprocessing + + +SCRIPT_NAME = 'notification' +APPLICATION = 'Weechat' +VERSION = '1' +AUTHOR = 'Guido Berhoerster' +COPYRIGHT = '(C) 2014 Guido Berhoerster' +SUBTITLE = 'Notification Plugin for Weechat' +HOMEPAGE = 'https://code.guido-berhoerster.org/addons/weechat-scripts/weechat-notification-script/' +EMAIL = 'guido+weechat@berhoerster.name' +DESCRIPTION = 'Notifies of a number of events through desktop notifications ' \ + 'and an optional status icon' +DEFAULT_SETTINGS = { + 'status_icon': ('weechat', 'path or name of the status icon'), + 'notification_icon': ('weechat', 'path or name of the icon shown in ' + 'notifications'), + 'preferred_toolkit': ('', 'preferred UI toolkit'), + 'notify_on_displayed_only': ('on', 'only notify of messages that are ' + 'actually displayed'), + 'notify_on_privmsg': ('on', 'notify when receiving a private message'), + 'notify_on_highlight': ('on', 'notify when a messages is highlighted'), + 'notify_on_dcc_request': ('on', 'notify on DCC requests') +} +BUFFER_SIZE = 1024 + + +class NetstringParser(object): + """Netstring Stream Parser""" + + IN_LENGTH = 0 + IN_STRING = 1 + + def __init__(self, on_string_complete): + self.on_string_complete = on_string_complete + self.length = 0 + self.input_buffer = '' + self.state = self.IN_LENGTH + + def parse(self, data): + self.input_buffer += data + ret = True + while ret: + if self.state == self.IN_LENGTH: + ret = self.parse_length() + else: + ret = self.parse_string() + + def parse_length(self): + length, delimiter, self.input_buffer = self.input_buffer.partition(':') + if not delimiter: + return False + try: + self.length = int(length) + except ValueError: + raise SyntaxError('Invalid length: %s' % length) + self.state = self.IN_STRING + return True + + def parse_string(self): + input_buffer_len = len(self.input_buffer) + if input_buffer_len < self.length + 1: + return False + string = self.input_buffer[0:self.length] + if self.input_buffer[self.length] != ',': + raise SyntaxError('Missing delimiter') + self.input_buffer = self.input_buffer[self.length + 1:] + self.length = 0 + self.state = self.IN_LENGTH + self.on_string_complete(string) + return True + + +def netstring_encode(*args): + return ''.join(['%d:%s,' % (len(element), element) for element in + args]) + +def netstring_decode(netstring): + result = [] + def append_result(data): + result.append(data) + np = NetstringParser(append_result) + np.parse(netstring) + return result + +def dispatch_weechat_callback(*args): + return weechat_callbacks[args[0]](*args) + +def create_weechat_callback(method): + global weechat_callbacks + + method_id = str(id(method)) + weechat_callbacks[method_id] = method + return method_id + + +class Notifier(object): + """Simple notifier which discards all notifications, base class for all + other notifiers + """ + + def __init__(self, icon): + flags = fcntl.fcntl(sys.stdin, fcntl.F_GETFL) + fcntl.fcntl(sys.stdin, fcntl.F_SETFL, flags | os.O_NONBLOCK) + + self.parser = NetstringParser(self.on_command_received) + + def on_command_received(self, raw_command): + command_args = netstring_decode(raw_command) + if len(command_args) > 1: + command = command_args[0] + args = netstring_decode(command_args[1]) + else: + command = command_args[0] + args = [] + getattr(self, command)(*args) + + def notify(self, summary, message, icon): + pass + + def reset(self): + pass + + def run(self): + poll = select.poll() + poll.register(sys.stdin, select.POLLIN | select.POLLPRI) + + while True: + try: + events = poll.poll() + except select.error as e: + if e.args and e.args[0] == errno.EINTR: + continue + else: + raise e + for fd, event in events: + if event & (select.POLLIN | select.POLLPRI): + buffer_ = os.read(fd, BUFFER_SIZE) + if buffer_ != '': + self.parser.parse(buffer_) + if event & (select.POLLERR | select.POLLHUP | select.POLLNVAL): + sys.exit(1) + + +class Gtk2Notifier(Notifier): + """GTK 2 notifier based on pygtk and pynotify""" + + def __init__(self, icon): + super(Gtk2Notifier, self).__init__(icon) + + pynotify.init(APPLICATION) + + gobject.io_add_watch(sys.stdin, gobject.IO_IN | gobject.IO_PRI, + self.on_input) + + if not icon: + icon_name = None + icon_pixbuf = None + elif icon.startswith('/'): + icon_name = None + try: + icon_pixbuf = gtk.gdk.Pixbuf.new_from_file(icon) + except gobject.GError: + icon_pixbuf = None + else: + icon_name = icon + icon_pixbuf = None + + if icon_name or icon_pixbuf: + self.status_icon = gtk.StatusIcon() + self.status_icon.set_title(APPLICATION) + self.status_icon.set_tooltip_text(APPLICATION) + self.status_icon.connect('activate', self.on_activate) + if icon_name: + self.status_icon.set_from_icon_name(icon_name) + elif icon_pixbuf: + self.status_icon.set_from_pixbuf(icon_pixbuf) + else: + self.status_icon = None + + def on_input(self, fd, cond): + if cond & (gobject.IO_IN | gobject.IO_PRI): + try: + buffer_ = os.read(fd.fileno(), BUFFER_SIZE) + if buffer_ != '': + self.parser.parse(buffer_) + except EOFError: + gtk.main_quit() + return False + + if cond & (gobject.IO_ERR | gobject.IO_HUP): + gtk.main_quit() + return False + + return True + + def on_activate(self, widget): + self.reset() + + def notify(self, summary, message, icon): + if self.status_icon: + self.status_icon.set_tooltip_text('%s: %s' % (APPLICATION, + summary)) + self.status_icon.set_blinking(True) + + if icon and icon.startswith('/'): + icon_name = None + try: + icon_pixbuf = gtk.gdk.Pixbuf.new_from_file(icon) + except gobject.GError: + icon_pixbuf = None + else: + icon_name = icon + icon_pixbuf = None + + if 'body-markup' in pynotify.get_server_caps(): + body = cgi.escape(message) + else: + body = message + + notification = pynotify.Notification(summary, body, icon_name) + if icon_pixbuf is not None: + notification.set_image_from_pixbuf(icon_pixbuf) + notification.show() + + def reset(self): + if self.status_icon: + self.status_icon.set_tooltip_text(APPLICATION) + self.status_icon.set_blinking(False) + + def run(self): + gtk.main() + + +class Gtk3Notifier(Notifier): + """GTK3 notifier based on GObject Introspection Bindings for GTK 3 and + libnotify + """ + + def __init__(self, icon): + super(Gtk3Notifier, self).__init__(icon) + + Notify.init(APPLICATION) + + GLib.io_add_watch(sys.stdin, GLib.IO_IN | GLib.IO_PRI, self.on_input) + + if not icon: + self.icon_name = None + self.icon_pixbuf = None + elif icon.startswith('/'): + self.icon_name = None + try: + self.icon_pixbuf = GdkPixbuf.Pixbuf.new_from_file(icon) + except GLib.GError: + self.icon_pixbuf = None + else: + self.icon_name = icon + self.icon_pixbuf = None + + if self.icon_name or self.icon_pixbuf: + # create blank, fully transparent pixbuf in order to simulate + # blinking + self.blank_pixbuf = GdkPixbuf.Pixbuf.new(GdkPixbuf.Colorspace.RGB, + True, 8, 22, 22) + self.blank_pixbuf.fill(0x00) + + self.blink_on = True + self.blink_timeout_id = None + + self.status_icon = Gtk.StatusIcon.new() + self.status_icon.set_title(APPLICATION) + self.status_icon.set_tooltip_text(APPLICATION) + self.status_icon.connect('activate', self.on_activate) + self.update_icon() + else: + self.status_icon = None + + def on_input(self, fd, cond): + if cond & (GLib.IO_IN | GLib.IO_PRI): + try: + self.parser.parse(os.read(fd.fileno(), BUFFER_SIZE)) + except EOFError: + Gtk.main_quit() + return False + + if cond & (GLib.IO_ERR | GLib.IO_HUP): + Gtk.main_quit() + return False + + return True + + def on_activate(self, widget): + self.reset() + + def update_icon(self): + if not self.blink_on: + self.status_icon.set_from_pixbuf(self.blank_pixbuf) + elif self.icon_name: + self.status_icon.set_from_icon_name(self.icon_name) + elif self.icon_pixbuf: + self.status_icon.set_from_pixbuf(self.icon_pixbuf) + + def on_blink_timeout(self): + self.blink_on = not self.blink_on + self.update_icon() + return True + + def notify(self, summary, message, icon): + if self.status_icon: + self.status_icon.set_tooltip_text('%s: %s' % (APPLICATION, + summary)) + if self.blink_timeout_id is None: + self.blink_timeout_id = GLib.timeout_add(500, + self.on_blink_timeout) + + if icon and icon.startswith('/'): + icon_name = None + try: + icon_pixbuf = GdkPixbuf.Pixbuf.new_from_file(icon) + except GLib.GError: + icon_pixbuf = None + else: + icon_name = icon + icon_pixbuf = None + + if 'body-markup' in Notify.get_server_caps(): + body = cgi.escape(message) + else: + body = message + + notification = Notify.Notification.new(summary, body, icon_name) + if icon_pixbuf is not None: + notification.set_image_from_pixbuf(icon_pixbuf) + notification.show() + + def reset(self): + if self.status_icon: + self.status_icon.set_tooltip_text(APPLICATION) + if self.blink_timeout_id is not None: + GLib.source_remove(self.blink_timeout_id) + self.blink_timeout_id = None + self.blink_on = True + self.update_icon() + + def run(self): + Gtk.main() + + +class Qt4Notifier(Notifier): + """Qt 4 notifier""" + + def __init__(self, icon): + super(Qt4Notifier, self).__init__(icon) + + signal.signal(signal.SIGINT, self.on_sigint) + + self.qapplication = QtGui.QApplication([]) + + self.readable_notifier = QtCore.QSocketNotifier(sys.stdin.fileno(), + QtCore.QSocketNotifier.Read) + self.readable_notifier.activated.connect(self.on_input) + self.readable_notifier.setEnabled(True) + + if not icon: + self.icon = None + elif icon.startswith('/'): + self.icon = QtGui.QIcon(icon) + else: + self.icon = QtGui.QIcon.fromTheme(icon) + + if self.icon: + # create blank, fully transparent pixbuf in order to simulate + # blinking + self.blank_icon = QtGui.QIcon() + + self.blink_on = True + self.blinking_timer = QtCore.QTimer() + self.blinking_timer.setInterval(500) + self.blinking_timer.timeout.connect(self.on_blink_timeout) + + self.status_icon = QtGui.QSystemTrayIcon() + self.status_icon.setToolTip(APPLICATION) + self.update_icon() + self.status_icon.setVisible(True) + self.status_icon.activated.connect(self.on_activated) + else: + self.status_icon = None + + def on_sigint(self, signo, frame): + self.qapplication.exit(0) + + def on_input(self, fd): + try: + self.parser.parse(os.read(fd, BUFFER_SIZE)) + except EOFError: + self.qapplication.exit(1) + + def on_activated(self, reason): + self.reset() + + def on_blink_timeout(self): + self.blink_on = not self.blink_on + self.update_icon() + + def update_icon(self): + if not self.blink_on: + self.status_icon.setIcon(self.blank_icon) + else: + self.status_icon.setIcon(self.icon) + + def notify(self, summary, message, icon): + if self.status_icon: + self.status_icon.setToolTip('%s: %s' % (APPLICATION, + cgi.escape(summary))) + self.blinking_timer.start() + if self.status_icon.supportsMessages(): + self.status_icon.showMessage(summary, message, + QtGui.QSystemTrayIcon.NoIcon) + + def reset(self): + if self.status_icon: + self.blinking_timer.stop() + self.blink_on = True + self.update_icon() + self.status_icon.setToolTip(APPLICATION) + + def run(self): + sys.exit(self.qapplication.exec_()) + + +class KDE4Notifier(Notifier): + """KDE 4 notifier based on PyKDE4""" + + def __init__(self, icon): + super(KDE4Notifier, self).__init__(icon) + + signal.signal(signal.SIGINT, self.on_sigint) + + aboutData = kdecore.KAboutData(APPLICATION.lower(), '', + kdecore.ki18n(APPLICATION), VERSION, kdecore.ki18n(SUBTITLE), + kdecore.KAboutData.License_GPL_V3, kdecore.ki18n(COPYRIGHT), + kdecore.ki18n (''), HOMEPAGE, EMAIL) + kdecore.KCmdLineArgs.init(aboutData) + self.kapplication = kdeui.KApplication() + + self.readable_notifier = QtCore.QSocketNotifier(sys.stdin.fileno(), + QtCore.QSocketNotifier.Read) + self.readable_notifier.activated.connect(self.on_input) + self.readable_notifier.setEnabled(True) + + if not icon: + icon_qicon = None + icon_name = None + elif icon.startswith('/'): + icon_qicon = QtGui.QIcon(icon) + icon_name = None + else: + icon_qicon = None + icon_name = icon + + if icon_name or icon_pixmap: + self.status_notifier = kdeui.KStatusNotifierItem(self.kapplication) + self.status_notifier.setCategory( + kdeui.KStatusNotifierItem.Communications) + if icon_name: + self.status_notifier.setIconByName(icon_name) + self.status_notifier.setToolTip(icon_name, APPLICATION, + SUBTITLE) + else: + self.status_notifier.setIconByPixmap(icon_qicon) + self.status_notifier.setToolTip(icon_qicon, APPLICATION, + SUBTITLE) + self.status_notifier.setStandardActionsEnabled(False) + self.status_notifier.setStatus(kdeui.KStatusNotifierItem.Active) + self.status_notifier.setTitle(APPLICATION) + self.status_notifier.activateRequested.connect( + self.on_activate_requested) + else: + self.status_notifier = None + + def on_sigint(self, signo, frame): + self.kapplication.exit(0) + + def on_input(self, fd): + try: + self.parser.parse(os.read(fd, BUFFER_SIZE)) + except EOFError: + self.kapplication.exit(1) + + def on_activate_requested(self, active, pos): + self.reset() + + def notify(self, summary, message, icon): + if self.status_notifier: + self.status_notifier.setToolTipSubTitle(cgi.escape(summary)) + self.status_notifier.setStatus( + kdeui.KStatusNotifierItem.NeedsAttention) + + if icon: + if icon.startswith('/'): + pixmap = QtGui.QPixmap.load(icon) + else: + pixmap = kdeui.KIcon(icon).pixmap(kdeui.KIconLoader.SizeHuge, + kdeui.KIconLoader.SizeHuge) + else: + pixmap = QtGui.QPixmap() + kdeui.KNotification.event(kdeui.KNotification.Notification, summary, + cgi.escape(message), pixmap) + + def reset(self): + if self.status_notifier: + self.status_notifier.setStatus(kdeui.KStatusNotifierItem.Active) + self.status_notifier.setToolTipTitle(APPLICATION) + self.status_notifier.setToolTipSubTitle(SUBTITLE) + + def run(self): + sys.exit(self.kapplication.exec_()) + + +class NotificationProxy(object): + """Proxy object for interfacing with the notifier process""" + + def __init__(self, preferred_toolkit, status_icon): + self.script_file = os.path.realpath(__file__) + self._status_icon = status_icon + self._preferred_toolkit = preferred_toolkit + self.notifier_process_hook = None + self.spawn_timer_hook = None + self.next_spawn_time = 0.0 + + self.spawn_notifier_process() + + @property + def status_icon(self): + return self._status_icon + + @status_icon.setter + def status_icon(self, value): + self._status_icon = value + self.terminate_notifier_process() + self.spawn_notifier_process() + + @property + def preferred_toolkit(self): + return self._preferred_toolkit + + @preferred_toolkit.setter + def preferred_toolkit(self, value): + self._preferred_toolkit = value + self.terminate_notifier_process() + self.spawn_notifier_process() + + def on_notifier_process_event(self, data, command, return_code, output, + error_output): + if return_code != weechat.WEECHAT_HOOK_PROCESS_RUNNING: + if return_code == weechat.WEECHAT_HOOK_PROCESS_ERROR: + error = '%sfailed to run notifier' % weechat.prefix("error") + else: + error = '%snotifier exited with exit status %d' % \ + (weechat.prefix("error"), return_code) + if output: + error += '\nstdout:%s' % output + if error_output: + error += '\nstderr:%s' % error_output + weechat.prnt('', error) + self.notifier_process_hook = None + self.spawn_notifier_process() + return weechat.WEECHAT_RC_OK + + def on_spawn_timer(self, data, remaining): + self.spawn_timer_hook = None + if not self.notifier_process_hook: + self.spawn_notifier_process() + return weechat.WEECHAT_RC_OK + + def spawn_notifier_process(self): + if self.notifier_process_hook or self.spawn_timer_hook: + return + + # do not try to respawn a notifier more than once every ten seconds + now = time.time() + if long(self.next_spawn_time - now) > 0: + self.spawn_timer_hook = \ + weechat.hook_timer(long((self.next_spawn_time - now) * + 1000), 0, 1, 'dispatch_weechat_callback', + create_weechat_callback(self.on_spawn_timer)) + return + + self.next_spawn_time = now + 10 + self.notifier_process_hook = \ + weechat.hook_process_hashtable(sys.executable, {'arg1': + self.script_file, 'arg2': self.preferred_toolkit, 'arg3': + self.status_icon, 'stdin': '1'}, 0, + 'dispatch_weechat_callback', + create_weechat_callback(self.on_notifier_process_event)) + + def terminate_notifier_process(self): + if self.spawn_timer_hook: + weechat.unhook(self.spawn_timer_hook) + self.spawn_timer_hook = None + if self.notifier_process_hook: + weechat.unhook(self.notifier_process_hook) + self.notifier_process_hook = None + self.next_spawn_time = 0.0 + + def send(self, command, *args): + if self.notifier_process_hook: + if args: + weechat.hook_set(self.notifier_process_hook, 'stdin', + netstring_encode(netstring_encode(command, + netstring_encode(*args)))) + else: + weechat.hook_set(self.notifier_process_hook, 'stdin', + netstring_encode(netstring_encode(command))) + + def notify(self, summary, message, icon): + self.send('notify', summary, message, icon) + + def reset(self): + self.send('reset') + + +class NotificationPlugin(object): + """Weechat plugin""" + + def __init__(self): + self.DCC_SEND_RE = re.compile(r':(?P\S+) PRIVMSG \S+ :' + r'\x01DCC SEND (?P\S+) \d+ \d+ (?P\d+)') + self.DCC_CHAT_RE = re.compile(r':(?P\S+) PRIVMSG \S+ :' + r'\x01DCC CHAT ') + + weechat.register(SCRIPT_NAME, AUTHOR, VERSION, 'GPL3', DESCRIPTION, '', + '') + + for option, (value, description) in DEFAULT_SETTINGS.iteritems(): + if not weechat.config_is_set_plugin(option): + weechat.config_set_plugin(option, value) + weechat.config_set_desc_plugin(option, '%s (default: "%s")' % + (description, value)) + + self.notification_proxy = NotificationProxy( + weechat.config_get_plugin('preferred_toolkit'), + weechat.config_get_plugin('status_icon')) + + weechat.hook_print('', 'irc_privmsg', '', 1, + 'dispatch_weechat_callback', + create_weechat_callback(self.on_message)) + weechat.hook_signal('key_pressed', 'dispatch_weechat_callback', + create_weechat_callback(self.on_key_pressed)) + weechat.hook_signal('irc_dcc', 'dispatch_weechat_callback', + create_weechat_callback(self.on_dcc)) + weechat.hook_config('plugins.var.python.%s.*' % SCRIPT_NAME, + 'dispatch_weechat_callback', + create_weechat_callback(self.on_config_changed)) + + def on_message(self, data, buffer, date, tags, displayed, highlight, + prefix, message): + if weechat.config_get_plugin('notify_on_displayed_only') == 'on' and \ + int(displayed) != 1: + return weechat.WEECHAT_RC_OK + + formatted_date = time.strftime('%H:%M', time.localtime(float(date))) + if 'notify_private' in tags.split(',') and \ + weechat.config_get_plugin('notify_on_privmsg') == 'on': + summary = 'Private message from %s at %s' % (prefix, + formatted_date) + self.notification_proxy.notify(summary, message, + weechat.config_get_plugin('notification_icon')) + elif int(highlight) == 1 and \ + weechat.config_get_plugin('notify_on_highlight') == 'on': + summary = 'Highlighted message from %s at %s' % (prefix, + formatted_date) + self.notification_proxy.notify(summary, message, + weechat.config_get_plugin('notification_icon')) + + return weechat.WEECHAT_RC_OK + + def on_dcc(self, data, signal, signal_data): + if weechat.config_get_plugin('notify_on_dcc') != 'on': + return weechat.WEECHAT_RC_OK + + matches = self.DCC_SEND_RE.match(signal_data) + if matches: + summary = 'DCC send request from %s' % matches.group('sender') + message = 'Filname: %s, Size: %d bytes' % \ + (matches.group('filename'), int(matches.group('size'))) + self.notification_proxy.notify(summary, message, + weechat.config_get_plugin('notification_icon')) + return weechat.WEECHAT_RC_OK + + matches = self.DCC_CHAT_RE.match(signal_data) + if matches: + summary = 'DCC chat request from %s' % matches.group('sender') + message = '' + self.notification_proxy.notify(summary, message, + weechat.config_get_plugin('notification_icon')) + return weechat.WEECHAT_RC_OK + + return weechat.WEECHAT_RC_OK + + def on_key_pressed(self, data, signal, signal_data): + self.notification_proxy.reset() + return weechat.WEECHAT_RC_OK + + def on_config_changed(self, data, option, value): + if option.endswith('.preferred_toolkit'): + self.notification_proxy.preferred_toolkit = value + elif option.endswith('.status_icon'): + self.notification_proxy.status_icon = value + return weechat.WEECHAT_RC_OK + + +def import_modules(modules): + for module_name, fromlist in modules: + if fromlist: + module = __import__(module_name, fromlist=fromlist) + for identifier in fromlist: + globals()[identifier] = getattr(module, identifier) + else: + globals()[module_name] = __import__(module_name) + +def try_import_modules(modules): + try: + import_modules(modules) + except ImportError: + sys.exit(1) + sys.exit(0) + + +if __name__ == '__main__': + if sys.argv[0] == '__weechat_plugin__': + # running as Weechat plugin + import weechat + + weechat_callbacks = {} + + plugin = NotificationPlugin() + elif len(sys.argv) == 3: + # running as the notifier process + preferred_toolkit = sys.argv[1] + icon = sys.argv[2] + + # required modules for each toolkit + toolkits_modules = { + 'gtk3': [ + ('gi.repository', [ + 'GLib', + 'GdkPixbuf', + 'Gtk', + 'Notify' + ]) + ], + 'gtk2': [ + ('pygtk', []), + ('gobject', []), + ('gtk', []), + ('pynotify', []) + ], + 'qt4': [ + ('PyQt4', [ + 'QtGui', + 'QtCore' + ]) + ], + 'kde4': [ + ('PyQt4', [ + 'QtGui', + 'QtCore' + ]), + ('PyKDE4', [ + 'kdecore', + 'kdeui' + ]) + ], + '': [] + } + available_toolkits = [] + selected_toolkit = '' + + # find available toolkits by spawning a process for each toolkit which + # tries to import all required modules and returns an exit status of 1 + # in case of an import error + for toolkit in toolkits_modules: + process = multiprocessing.Process(target=try_import_modules, + args=(toolkits_modules[toolkit],)) + process.start() + process.join(3) + if process.is_alive(): + process.terminate() + process.join() + if process.exitcode == 0: + available_toolkits.append(toolkit) + + # select toolkit based on either explicit preference or the + # availability of modules and the used desktop environment + if preferred_toolkit: + if preferred_toolkit in available_toolkits: + selected_toolkit = preferred_toolkit + else: + if 'KDE_FULL_SESSION' in os.environ: + # preferred order if running KDE4 + toolkits = ['kde4', 'qt4', 'gtk3', 'gtk2'] + else: + # preferred order for all other desktop environments + toolkits = ['gtk3', 'gtk2', 'qt4', 'kde4'] + for toolkit in toolkits: + if toolkit in available_toolkits: + selected_toolkit = toolkit + break + + # import required toolkit modules + import_modules(toolkits_modules[selected_toolkit]) + + # run selected notifier + if selected_toolkit == 'gtk3': + notifier = Gtk3Notifier(icon) + elif selected_toolkit == 'gtk2': + notifier = Gtk2Notifier(icon) + elif selected_toolkit == 'qt4': + notifier = Qt4Notifier(icon) + elif selected_toolkit == 'kde4': + notifier = KDE4Notifier(icon) + else: + notifier = Notifier(icon) + notifier.run() + else: + sys.exit(1)