diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2ef9345 --- /dev/null +++ b/LICENSE @@ -0,0 +1,623 @@ +Iface Watch is licensed under the GNU General Public License version 3. + + 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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..874d028 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +## Iface Watch : A Deluge plugin to monitor a network interface for IP changes ## + +Author: bendikro + + +License: GPLv3 + +## Building the plugin ## + +``` +#!bash + +$ python setup.py bdist_egg +``` + + +## Changelog ## + +v1.0 - 2015-09-27 + +* Support for unix hosts with pyiface + +(Tested with Deluge 1.3.11) diff --git a/ifacewatch/__init__.py b/ifacewatch/__init__.py new file mode 100644 index 0000000..b5b0d94 --- /dev/null +++ b/ifacewatch/__init__.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2012-2015 bendikro bro.devel+yarss2@gmail.com +# +# Based on work by: +# Copyright (C) 2009 Camillo Dell'mour +# +# Basic plugin template created by: +# Copyright (C) 2008 Martijn Voncken +# Copyright (C) 2007-2009 Andrew Resch +# Copyright (C) 2009 Damien Churchill +# +# This file is part of YaRSS2 and is licensed under GNU General Public License 3.0, or later, with +# the additional special exception to link portions of this program with the OpenSSL library. +# See LICENSE for more details. +# + +import sys + +import pkg_resources +from deluge.plugins.init import PluginInitBase + +import ifacewatch.util.logger + +log = ifacewatch.util.logger.Logger() + + +def load_libs(): + egg = pkg_resources.require("IfaceWatch")[0] + for name in egg.get_entry_map("ifacewatch.libpaths"): + ep = egg.get_entry_info("ifacewatch.libpaths", name) + location = "%s/%s" % (egg.location, ep.module_name.replace(".", "/")) + sys.path.append(location) + log.info("Appending to sys.path: '%s'" % location) + + +class CorePlugin(PluginInitBase): + def __init__(self, plugin_name): + load_libs() + from core import Core as CorePluginClass + self._plugin_cls = CorePluginClass + super(CorePlugin, self).__init__(plugin_name) + + +class GtkUIPlugin(PluginInitBase): + def __init__(self, plugin_name): + load_libs() + from gtkui.gtkui import GtkUI as GtkUIPluginClass + self._plugin_cls = GtkUIPluginClass + super(GtkUIPlugin, self).__init__(plugin_name) diff --git a/ifacewatch/core.py b/ifacewatch/core.py new file mode 100644 index 0000000..cda3436 --- /dev/null +++ b/ifacewatch/core.py @@ -0,0 +1,130 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 bendikro bro.devel+ifacewatch@gmail.com +# +# This file is part of Iface Watch and is licensed under GNU General Public +# License 3.0, or later, with the additional special exception to link portions +# of this program with the OpenSSL library. See LICENSE for more details. +# + + +import deluge.common +import deluge.component as component +from deluge.core.rpcserver import export +from deluge.plugins.pluginbase import CorePluginBase +from twisted.internet.task import LoopingCall + +import ifacewatch.util.common +import ifacewatch.util.logger +from ifacewatch.ifacewatch_config import IfacewatchConfig +from ifacewatch.lib.pyiface.iface import Interface +from ifacewatch.util.common import IfaceWatchIPChangedEvent + + +class Core(CorePluginBase): + + def __init__(self, name): + """Used for tests only""" + if name is not "test": + super(Core, self).__init__(name) + else: + # To avoid warnings when running tests + self._component_name = name + + self.timer = None + self.config = None + self.ip = None + self.log = ifacewatch.util.logger.Logger() + self.log.info("Core init", gtkui=True) + self.core = component.get("Core") + self.core.config.register_set_function("listen_interface", self.interface_changed) + + def interface_changed(self, iface, ip): + component.get("EventManager").emit(IfaceWatchIPChangedEvent(ip)) + + def enable(self, config=None): + if config is None: + self.config = IfacewatchConfig(self.log) + else: + self.config = config + self.log.info("Enabled Iface Watch %s" % ifacewatch.util.common.get_version()) + + self.scheduler_timer() + self.check_interface() + + def scheduler_timer(self): + if self.timer: + if self.timer.running: + self.timer.stop() + else: + self.timer = LoopingCall(self.check_interface) + + interval = int(self.config.get_config()["update_interval"]) + if self.config.get_config()["active"]: + self.timer.start(interval * 6, now=True) # Multiply to get seconds + self.log.info("Scheduling watch with interval %s." % + self.config.get_config()["update_interval"], gtkui=True) + else: + self.log.info("Watch mode disabled", gtkui=True) + + def disable(self): + self.config.save() + + def update(self): + pass + + def check_interface(self, *args, **kwargs): + if self.config is None: + return + prev_ip = self.ip + self.ip = None + iface = self.config.get_config()["interface"] + + if iface.strip(): + try: + iff = Interface(name=str(iface)) + self.ip = iff.ip_str() + if not deluge.common.is_ip(self.ip): + self.log.info("Invalid IP returned for interface '%s': %s" % (iface, self.ip), gtkui=True) + self.ip = None + except TypeError as e: + self.log.error("TypeError: %s" % e, gtkui=True) + + if self.ip is None: + self.ip = "" + iface = "" + + has_changed = prev_ip != self.ip + + if prev_ip is not None and has_changed: + self.log.info("IP from interface %s is new: %s -> %s" % + (iface, prev_ip, self.ip if self.ip else "0.0.0.0"), gtkui=True) + if has_changed: + self.log.info("Updating with IP '%s'" % (self.ip if self.ip else "0.0.0.0"), gtkui=True) + self.core.set_config({"listen_interface": self.ip}) + + return True + + @export + def get_ip(self): + """Returns the config dictionary""" + return self.core.get_config_value("listen_interface") + + @export + def get_config(self): + """Returns the config dictionary""" + return self.config.get_config() + + @export + def save_config(self, config): + newiface = "interface" in config and config["interface"] != self.config.get_config()["interface"] + newinterval = ("update_interval" in config and + config["update_interval"] != self.config.get_config()["update_interval"]) + newstate = config["active"] != self.config.get_config()["active"] + self.config.set_config(config) + if newstate and config["active"] is True: + self.log.info("Watch mode enabled") + if newiface: + self.check_interface() + if newinterval or newstate: + self.scheduler_timer() diff --git a/ifacewatch/data/ifacewatch.glade b/ifacewatch/data/ifacewatch.glade new file mode 100644 index 0000000..75a612c --- /dev/null +++ b/ifacewatch/data/ifacewatch.glade @@ -0,0 +1,270 @@ + + + + + + False + False + + + True + False + 5 + + + True + False + 5 + 5 + + + True + False + 7 + 10 + + + True + False + 14 + + + Active + True + True + False + True + + + + False + True + 0 + + + + + Update + True + True + True + + + + False + True + 1 + + + + + True + False + 11 + + + True + False + Interface + + + False + False + 0 + + + + + True + • + True + False + False + True + True + + + False + True + end + 1 + + + + + False + True + end + 2 + + + + + False + False + 0 + + + + + True + False + 15 + + + True + False + 7 + + + True + False + Update interval + + + False + True + 0 + + + + + True + True + • + False + False + True + True + 1 1 100000 1 10 0 + + + False + True + 1 + + + + + True + True + 0 + + + + + True + False + 67 + + + True + False + IP: + + + False + False + 0 + + + + + 114 + True + False + True + + + False + False + 1 + + + + + False + False + 1 + + + + + False + True + 1 + + + + + False + False + 0 + + + + + True + True + 10 + automatic + automatic + + + True + False + none + + + True + False + 0 + + + True + False + 3 + 3 + 7 + 7 + + + True + True + + + + + + + True + False + <b> Log </b> + True + + + label_item + + + + + + + + + True + True + 1 + + + + + True + True + 0 + + + + + + diff --git a/ifacewatch/gtkui/__init__.py b/ifacewatch/gtkui/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ifacewatch/gtkui/gtkui.py b/ifacewatch/gtkui/gtkui.py new file mode 100644 index 0000000..311d0e1 --- /dev/null +++ b/ifacewatch/gtkui/gtkui.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 bendikro bro.devel+ifacewatch@gmail.com +# +# This file is part of Iface Watch and is licensed under GNU General Public +# License 3.0, or later. +# + +import gtk + +from deluge.ui.client import client +from deluge.plugins.pluginbase import GtkPluginBase +import deluge.component as component + +from ifacewatch.util.logger import Logger +from ifacewatch.util.gtkui_log import GTKUILogger +from ifacewatch.util.common import get_resource + + +class GtkUI(GtkPluginBase): + + def enable(self): + self.create_ui() + self.on_show_prefs() # Necessary for the first time when the plugin is installed + client.register_event_handler("IfaceWatchLogMessageEvent", self.cb_on_log_message_arrived_event) + client.register_event_handler("IfaceWatchIPChangedEvent", self.cb_get_ip) + + def disable(self): + component.get("Preferences").remove_page("IfaceWatch") + component.get("PluginManager").deregister_hook("on_apply_prefs", self.on_apply_prefs) + component.get("PluginManager").deregister_hook("on_show_prefs", self.on_show_prefs) + + def create_ui(self): + self.glade = gtk.glade.XML(get_resource("ifacewatch.glade")) + self.ifacewatch_window = self.glade.get_widget('ifacewatch_window') + box = self.glade.get_widget("ifacewatch_prefs_box") + + self.glade.signal_autoconnect({ + "on_button_update_iface_clicked": self.on_button_update_iface_clicked, + "on_checkbutton_active_toggled": self.on_checkbutton_active_toggled, + }) + component.get("Preferences").add_page("IfaceWatch", box) + component.get("PluginManager").register_hook("on_apply_prefs", self.on_apply_prefs) + component.get("PluginManager").register_hook("on_show_prefs", self.on_show_prefs) + self.gtkui_log = GTKUILogger(self.glade.get_widget('textview_log')) + self.log = Logger(gtkui_logger=self.gtkui_log) + +############################### +# Update config and lists data +############################### + + def on_button_update_iface_clicked(self, widget): + iface = self.glade.get_widget("entry_interface").get_text() + interval = self.glade.get_widget("spinbutton_update_interval").get_value() + active = self.glade.get_widget("checkbutton_active").get_active() + client.ifacewatch.save_config({"interface": iface, "update_interval": int(interval), + "active": active}) + + def on_checkbutton_active_toggled(self, widget): + active = self.glade.get_widget("checkbutton_active").get_active() + client.ifacewatch.save_config({"active": active}) + + def on_apply_prefs(self): + """Called when the 'Apply' button is pressed""" + pass + + def on_show_prefs(self): + """Called when showing preferences window""" + client.ifacewatch.get_config().addCallback(self.cb_get_config) + client.ifacewatch.get_ip().addCallback(self.cb_get_ip) + + def cb_on_log_message_arrived_event(self, message): + """Callback function called on GtkUILogMessageEvent events""" + self.gtkui_log.gtkui_log_message(message) + + def cb_get_config(self, config): + """Callback function called after saving data to core""" + if config is None: + self.log.error("An error has occured. Cannot load data from config") + else: + self.glade.get_widget("entry_interface").set_text(config['interface']) + self.glade.get_widget("spinbutton_update_interval").set_value(int(config['update_interval'])) + self.glade.get_widget("checkbutton_active").set_active(config['active']) + + def cb_get_ip(self, ip): + self.glade.get_widget("label_IP_value").set_text(ip) + component.get("Preferences").glade.get_widget("entry_interface").set_text(ip) diff --git a/ifacewatch/ifacewatch_config.py b/ifacewatch/ifacewatch_config.py new file mode 100644 index 0000000..9624d5f --- /dev/null +++ b/ifacewatch/ifacewatch_config.py @@ -0,0 +1,73 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2015 bendikro bro.devel+ifacewatch@gmail.com +# +# This file is part of Iface Watch and is licensed under GNU General Public +# License 3.0, or later, with the additional special exception to link portions +# of this program with the OpenSSL library. See LICENSE for more details. +# + +import copy + +import deluge.configmanager +from deluge.event import DelugeEvent + +CONFIG_FILENAME = "ifacewatch.conf" + +__DEFAULT_PREFS = { + "interface": "", + "active": True, + "update_interval": 10, +} + + +def default_prefs(): + return copy.deepcopy(__DEFAULT_PREFS) + + +class YARSSConfigChangedEvent(DelugeEvent): + """ + Emitted when the config has been changed. + """ + def __init__(self, config): + """ + :param config: the new config + """ + self._args = [config] + + +class IfacewatchConfig(object): + + def __init__(self, logger, config=None, core_config=None, verify_config=True): + self.log = logger + self.config = config + + if config is None: + self.config = deluge.configmanager.ConfigManager(CONFIG_FILENAME, default_prefs()) + self.config.save() + + if verify_config: + self._verify_config() + + def save(self): + self.config.save() + + def get_config(self): + "returns the config dictionary" + config = copy.copy(self.config.config) + return config + + def set_config(self, config): + """Replaces the config data in self.config with the available keys in config""" + for key in config.keys(): + self.config[key] = config[key] + self.config.save() + + def _verify_config(self): + """Adding missing keys, in case a new version adds more config fields""" + # Update config + pass + + def run_for_each_dict_element(self, conf_dict, update_func): + for key in conf_dict.keys(): + update_func(conf_dict[key]) diff --git a/ifacewatch/lib/__init__.py b/ifacewatch/lib/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ifacewatch/lib/pyiface/__init__.py b/ifacewatch/lib/pyiface/__init__.py new file mode 100644 index 0000000..57501a8 --- /dev/null +++ b/ifacewatch/lib/pyiface/__init__.py @@ -0,0 +1,12 @@ +from ifreqioctls import * +from iface import Interface, getIfaces + +__all__=['Interface', 'getIfaces'] + +ll = dir() +for l in ll: + if l.startswith('IFF_'): + __all__.append(l) + if l.startswith('SIOC'): + __all__.append(l) + diff --git a/ifacewatch/lib/pyiface/iface.py b/ifacewatch/lib/pyiface/iface.py new file mode 100644 index 0000000..3f1d9ff --- /dev/null +++ b/ifacewatch/lib/pyiface/iface.py @@ -0,0 +1,432 @@ +import sys +import fcntl +import struct +import socket + +from ctypes import * +from ifreqioctls import * +from binascii import hexlify + +flags2str = { + IFF_UP: 'Interface is up.', + IFF_BROADCAST: 'Broadcast address valid.', + IFF_DEBUG: 'Turn on debugging.', + IFF_LOOPBACK: 'Is a loopback net.', + IFF_POINTOPOINT: 'Interface is point-to-point link.', + IFF_NOTRAILERS: 'Avoid use of trailers.', + IFF_RUNNING: 'Resources allocated.', + IFF_NOARP: 'No address resolution protocol.', + IFF_PROMISC: 'Receive all packets.', + IFF_ALLMULTI: 'Receive all multicast packets.', + IFF_MASTER: 'Master of a load balancer.', + IFF_SLAVE: 'Slave of a load balancer.', + IFF_MULTICAST: 'Supports multicast.', + IFF_PORTSEL: 'Can set media type.', + IFF_AUTOMEDIA: 'Auto media select active.', + IFF_DYNAMIC: 'Dialup device with changing addresses.' +} + +def flagsToStr(fin): + ret = '' + for k in flags2str.keys(): + if fin & k: + ret = ret +'\t'+ flags2str[k] + '\n' + + return ret + + +class sockaddr_gen(Structure): + _fields_ = [ + ( "sa_family", c_uint16 ), + ( "sa_data", (c_uint8 * 22) ) + ] + +# AF_INET / IPv4 +class in_addr(Structure): + _pack_=1 + _fields_ = [ + ("s_addr", c_uint32), + ] + +class sockaddr_in(Structure): + _pack_=1 + _fields_ = [ + ("sin_family", c_ushort), + ("sin_port", c_ushort), + ("sin_addr", in_addr), + ("sin_zero", (c_uint8 * 16) ), # padding + ] + +# AF_INET6 / IPv6 +class in6_u(Union): + _pack_=1 + _fields_ = [ + ("u6_addr8", (c_uint8 * 16) ), + ("u6_addr16", (c_uint16 * 8) ), + ("u6_addr32", (c_uint32 * 4) ) + ] + +class in6_addr(Structure): + _pack_ = 1 + _fields_ = [ + ("in6_u", in6_u), + ] + +class sockaddr_in6(Structure): + _pack_=1 + _fields_ = [ + ("sin6_family", c_short), + ("sin6_port", c_ushort), + ("sin6_flowinfo", c_uint32), + ("sin6_addr", in6_addr), + ("sin6_scope_id", c_uint32), + ] + +# AF_LINK / BSD|OSX +class sockaddr_dl( Structure ): + _fields_ = [ + ("sdl_len", c_uint8 ), + ("sdl_family", c_uint8 ), + ("sdl_index", c_uint16 ), + ("sdl_type", c_uint8 ), + ("sdl_nlen", c_uint8 ), + ("sdl_alen", c_uint8 ), + ("sdl_slen", c_uint8 ) +# ("sdl_data", (c_uint8 * 46) ) + ] + + +class sockaddr ( Union ): + _pack_=1 + _fields_ = [ + ('gen', sockaddr_gen), + ('in4', sockaddr_in ), + ('in6', sockaddr_in6 ) + ] + +class ifmap( Structure ): + _pack_=1 + _fields_ = [ + ('mem_start', c_ulong), + ('mem_end', c_ulong), + ('base_addr', c_ushort), + ('irq', c_ubyte ), + ('dma', c_ubyte ), + ('port', c_ubyte ) + ] + +IFNAMSIZ = 16 +IFHWADDRLEN = 6 +class ifr_data( Union ): + _pack_ = 1 + _fields_ = [ + ('ifr_addr', sockaddr), + ('ifr_dstaddr', sockaddr), + ('ifr_broadaddr',sockaddr), + ('ifr_netmask', sockaddr), + ('ifr_hwaddr', sockaddr), + ('ifr_flags', c_short), + ('ifr_ifindex', c_int), + ('ifr_ifqlen', c_int), + ('ifr_metric', c_int), + ('ifr_mtu', c_int), + ('ifr_map', ifmap), + ('ifr_slave', (c_ubyte*IFNAMSIZ)), + ('ifr_newname', (c_ubyte*IFNAMSIZ)), + ('ifr_data', c_void_p) + ] + +class ifreq( Structure ): + _pack_=1 + _fields_= [ + ('ifr_name', (c_ubyte*IFNAMSIZ)), + ('data', ifr_data) + ] + + +class Interface(object): + """ + Represents a network interface. + + Almost all interesting attributes are exported in the form + of a variable. You can get or set this variable. For example: + + ifeth0 = Interface("eth0") + print ifeth0.addr # will print the current address + ... + or + ... + ifeth0.addr = (AF_INET, '1.2.3.4') # will set a new address + + """ + + def __init__(self, idx=1, name=None): + self.skt = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, 0) + fcntl.fcntl(self.skt, + fcntl.F_SETFD, + fcntl.fcntl(self.skt, fcntl.F_GETFD) | fcntl.FD_CLOEXEC) + + self._index = idx + self._name = name + + # Get the name of the interface + if (self._name == None): + self._name = self.name + else: + self._name = (c_ubyte*IFNAMSIZ) (*bytearray(self._name)) + self._index = self.index + + def __newIfreqWithName(self): + ifr = ifreq() + ifr.ifr_name = self._name + return ifr + + def __doIoctl(self, ifr, SIOC, mutate = True): + try: + fcntl.ioctl(self.skt, SIOC, ifr, mutate) + except IOError as ioException: + #print "ioException.errno:", ioException.errno + if ioException.errno == 99: + pass + else: + raise ioException + + def __getSimple(self, ioctl, elem): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, ioctl) + + elem = elem.split('.') + tmpVal = ifr + for curElem in elem: + tmpVal = getattr(tmpVal, curElem) + + return tmpVal + + def __setSimple(self,ioctl, elem, val): + ifr = self.__newIfreqWithName() + + elem = elem.split('.') + tmpVal = ifr + + for curElem in elem[:-1]: + tmpVal = getattr(tmpVal, curElem) + + setattr(tmpVal, elem[-1], val) + self.__doIoctl(ifr, ioctl) + + @property + def index(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFINDEX) + self._index = ifr.data.ifr_ifindex + return self._index + + @property + def name(self): + ifr = ifreq() + ifr.data.ifr_ifindex = self._index + self.__doIoctl(ifr, SIOCGIFNAME) + self._name = ifr.ifr_name + return string_at(self._name) + + @name.setter + def name(self, val): + ifr = ifreq() + ifr.ifr_name = self._name + ifr.data.ifr_newname = val + self.__doIoctl(ifr, SIOCGIFNAME) + self._name = val + + @property + def flags(self): + return self.__getSimple(SIOCGIFFLAGS, 'data.ifr_flags') + + @flags.setter + def flags(self, val): + self.__setSimple(SIOCSIFFLAGS, 'data.ifr_flags', val) + + @property + def ifqlen(self): + return self.__getSimple(SIOCGIFTXQLEN, 'data.ifr_ifqlen') + + @ifqlen.setter + def ifqlen(self, val): + self.__setSimple(SIOCSIFTXQLEN, 'data.ifr_ifqlen', val) + + @property + def metric(self): + return self.__getSimple(SIOCGIFMETRIC, 'data.ifr_metric') + + @metric.setter + def metric(self, val): + self.__getSimple(SIOCSIFMETRIC, 'data.ifr_metric', val) + + @property + def mtu(self): + return self.__getSimple(SIOCGIFMTU, 'data.ifr_mtu') + + @mtu.setter + def mtu(self, val): + self.__getSimple(SIOCSIFMTU, 'data.ifr_mtu', val) + + @property + def hwaddr(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFHWADDR) + hw = ifr.data.ifr_hwaddr.gen.sa_data + + self._hwaddr = '' + for i in hw[:IFHWADDRLEN] : + self._hwaddr = self._hwaddr + '%.2X:' % i + + return self._hwaddr + + @property + def ip(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFHWADDR) + hw = ifr.data.ifr_hwaddr.gen.sa_data + self._hwaddr = '' + for i in hw[:IFHWADDRLEN] : + self._hwaddr = self._hwaddr + '%.2X:' % i + + return self._hwaddr + + @hwaddr.setter + def hwaddr(self, val): + ifr = self.__newIfreqWithName() + ifr.data.ifr_hwaddr.sin_addr.s_addr = val + self.__doIoctl(ifr, SIOCSIFHWADDR) + + @property + def addr(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFADDR) + return ifr.data.ifr_addr + + @addr.setter + def addr(self, val): + ifr = self.__newIfreqWithName() + ifr.data.ifr_addr = self.__sockaddrFromTuple(val) + self.__doIoctl(ifr, SIOCSIFADDR, False) + + @property + def broadaddr(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFBRDADDR) + return ifr.data.ifr_broadaddr + + @broadaddr.setter + def broadaddr(self, val): + ifr = self.__newIfreqWithName() + ifr.data.ifr_broadaddr = self.__sockaddrFromTuple(val) + self.__doIoctl(ifr, SIOCSIFBRDADDR) + + @property + def netmask(self): + ifr = self.__newIfreqWithName() + self.__doIoctl(ifr, SIOCGIFNETMASK) + return ifr.data.ifr_netmask + + @netmask.setter + def netmask(self, val): + ifr = self.__newIfreqWithName() + ifr.data.ifr_netmask = self.__sockaddrFromTuple(val) + self.__doIoctl(ifr, SIOCSIFNETMASK, False) + + + def __getSinAddr(self, sockaddr): + if sockaddr.gen.sa_family == socket.AF_INET: + return sockaddr.in4.sin_addr.s_addr + if sockaddr.gen.sa_family == socket.AF_INET6: + return sockaddr.in6.sin6_addr.in6_u + return 0 + + def __sockaddrFromTuple(self, inVal): + if inVal[0] == socket.AF_INET: + sin4 = sockaddr() + + sin4.in4.sin_family = inVal[0] + sin4.in4.sin_addr.s_addr = struct.unpack('