diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..818433e --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MMM-NewsFeedTicker.css b/MMM-NewsFeedTicker.css new file mode 100644 index 0000000..ecc0aa0 --- /dev/null +++ b/MMM-NewsFeedTicker.css @@ -0,0 +1,25 @@ +.newsfeed { + width: 100%; + height: 150px; + font-size: 350%; + line-height: 120%; + background-color: maroon; +} + +.newsfeed .marquee { + width: 100%; + margin: 0 auto; + overflow: hidden; + white-space: nowrap; + box-sizing: border-box; + -webkit-transition: marquee 121s linear infinite; + -moz-transition: marquee 121s linear infinite; + -o-transition: marquee 121s linear infinite; + transition: marquee 121s linear infinite; +} + +.newsfeed .image { + height: 300px; + vertical-align: middle; + line-height: 120%; +} diff --git a/MMM-NewsFeedTicker.js b/MMM-NewsFeedTicker.js new file mode 100644 index 0000000..4ec4735 --- /dev/null +++ b/MMM-NewsFeedTicker.js @@ -0,0 +1,472 @@ +/* global Module */ + +/* Magic Mirror + * Module: NewsFeed + * + * By Michael Teeuw http://michaelteeuw.nl + * MIT Licensed. + */ + +Module.register("newsfeed", { + + // Default module config. + defaults: { + feeds: [ + { + imageUrl: "https://static01.nyt.com/images/misc/NYT_logo_rss_250x40.png", + title: "New York Times", + url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml" + }, + { + imageUrl: "http://online.wsj.com/img/wsj_sm_logo.gif", + title: "Wall St. Journal", + url: "http://www.wsj.com/xml/rss/3_7085.xml" + }, + { + imageUrl: "http://www.gannett-cdn.com/sites/usatnetwork/images/RSS_Syndication_Logo-USATN.png", + title: "USA Today", + url: "http://rssfeeds.usatoday.com/UsatodaycomNation-TopStories" + }, + { + imageUrl: "https://news.bbcimg.co.uk/nol/shared/img/bbc_news_120x60.gif", + title: "BBC World News", + url: "http://feeds.bbci.co.uk/news/world/rss.xml#" + } + ], + + showMarquee: true, + showIcon: true, + showSourceTitle: false, + showPublishDate: false, + showDescription: false, + wrapTitle: false, + wrapDescription: false, + truncDescription: false, + lengthDescription: 1900, + hideLoading: false, + reloadInterval: 60 * 60 * 1000, // every 30 minutes + updateInterval: 30 * 1000, // every 90 seconds + animationSpeed: 500, + maxNewsItems: 2, // 0 for unlimited + ignoreOldItems: true, + ignoreOlderThan: 2 * 24 * 60 * 60 * 1000, // 2 days + removeStartTags: "both", + removeEndTags: "both", + startTags: [], + endTags: [], + prohibitedWords: [], + scrollLength: "100%", + logFeedWarnings: true, + encoding: "UTF-8", //ISO-8859-1 + }, + + requiresversion: "2.1.0", + + // Define required scripts. + getScripts: function () { + return ["moment.js"]; + }, + + getStyles: function() { + return ["NewsFeedTicker.css"]; + }, + + // Define required translations. + getTranslations: function () { + // The translations for the default modules are defined in the core translation files. + // Therefor we can just return false. Otherwise we should have returned a dictionary. + // If you're trying to build your own module including translations, check out the documentation. + return false; + }, + + /* + + NYT > Home Page + + https://static01.nyt.com/images/misc/NYT_logo_rss_250x40.png + + + http://www.nytimes.com/pages/index.html?partner=rss&emc=rss + + + */ + + // Define start sequence. + start: function () { + Log.info("Starting module: " + this.name); + + // Set locale. + moment.locale(config.language); + + this.newsItems = []; + this.loaded = false; + this.activeItem = 0; + this.scrollPosition = 0; + + this.registerFeeds(); + + "use strict"; + + this.isShowingDescription = this.config.showDescription; + }, + + // Override socket notification handler. + socketNotificationReceived: function (notification, payload) { + if (notification === "NEWS_ITEMS") { + this.generateFeed(payload); + + if (!this.loaded) { + this.scheduleUpdateInterval(); + } + + this.loaded = true; + } + }, + + // Override dom generator. + getDom: function () { + var wrapper = document.createElement("div"); + + if (this.config.feedUrl) { + wrapper.className = "bold xxlarge normal"; + wrapper.innerHTML = "The configuration options for the newsfeed module have changed.
Please check the documentation."; + return wrapper; + } + + if (this.activeItem >= this.newsItems.length) { + this.activeItem = 0; + } + + if (this.newsItems.length > 0) { + + // this.config.showFullArticle is a run-time configuration, triggered by optional notifications + if (!this.config.showFullArticle && (this.config.showSourceTitle || this.config.showPublishDate)) { + var sourceAndTimestamp = document.createElement("div"); + //sourceAndTimestamp.className = "bold large dimmed"; + + if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") { + sourceAndTimestamp.innerHTML = this.newsItems[this.activeItem].sourceTitle; + } + if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "" && this.config.showPublishDate) { + sourceAndTimestamp.innerHTML += " "; + } + if (this.config.showPublishDate) { + sourceAndTimestamp.innerHTML += moment(new Date(this.newsItems[this.activeItem].pubdate)).fromNow(); + } + if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "" || this.config.showPublishDate) { + sourceAndTimestamp.innerHTML += ":"; + } + + wrapper.appendChild(sourceAndTimestamp); + } + + //Remove selected tags from the beginning of rss feed items (title or description) + if (this.config.removeStartTags == "title" || this.config.removeStartTags == "both") { + + for (f = 0; f < this.config.startTags.length; f++) { + if (this.newsItems[this.activeItem].title.slice(0, this.config.startTags[f].length) == this.config.startTags[f]) { + this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(this.config.startTags[f].length, this.newsItems[this.activeItem].title.length); + } + } + + } + + if (this.config.removeStartTags == "description" || this.config.removeStartTags == "both") { + + if (this.config.showDescription) { + for (f = 0; f < this.config.startTags.length; f++) { + if (this.newsItems[this.activeItem].description.slice(0, this.config.startTags[f].length) == this.config.startTags[f]) { + this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].description.slice(this.config.startTags[f].length, this.newsItems[this.activeItem].description.length); + } + } + } + + } + + //Remove selected tags from the end of rss feed items (title or description) + if (this.config.removeEndTags) { + for (f = 0; f < this.config.endTags.length; f++) { + if (this.newsItems[this.activeItem].title.slice(-this.config.endTags[f].length) == this.config.endTags[f]) { + this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(0, -this.config.endTags[f].length); + } + } + + if (this.config.showDescription) { + for (f = 0; f < this.config.endTags.length; f++) { + if (this.newsItems[this.activeItem].description.slice(-this.config.endTags[f].length) == this.config.endTags[f]) { + this.newsItems[this.activeItem].description = this.newsItems[this.activeItem].description.slice(0, -this.config.endTags[f].length); + } + } + } + + } + + if (this.config.showSourceTicle) { + var title = document.createElement("div"); + title.className = "bright medium light" + (!this.config.wrapTitle ? " no-wrap" : ""); + title.innerHTML = this.newsItems[this.activeItem].title; + wrapper.appendChild(title); + } + + if (this.isShowingDescription) { + var description = document.createElement("div"); + description.className = "large light" + (!this.config.wrapDescription ? " no-wrap" : ""); + var txtDesc = this.newsItems[this.activeItem].description; + description.innerHTML = (this.config.truncDescription ? (txtDesc.length > this.config.lengthDescription ? txtDesc.substring(0, this.config.lengthDescription) + "..." : txtDesc) : txtDesc); + wrapper.appendChild(description); + } + + if (this.config.showMarquee && this.config.showIcon) { + var image = document.createElement("image"); + image.className = "image"; + image.innerHTML = "" + ":  "; + + wrapper.appendChild(description); + + var txtDesc = document.createElement("marquee"); + txtDesc.setAttribute("style", "padding-bottom:25px"); + txtDesc.className = "bright large bold"; + txtDesc.innerHTML = moment(new Date(this.newsItems[this.activeItem].pubdate)).fromNow() + ":  " + this.newsItems[this.activeItem].sourceTitle + " " + this.newsItems[this.activeItem].description; + + wrapper.appendChild(txtDesc); + } + + if (this.config.showFullArticle) { + var fullArticle = document.createElement("iframe"); + fullArticle.className = ""; + fullArticle.style.width = "100%"; + // very large height value to allow scrolling + fullArticle.height = "3000px"; + fullArticle.style.height = "3000px"; + fullArticle.style.top = "0"; + fullArticle.style.left = "0"; + fullArticle.style.border = "none"; + fullArticle.src = typeof this.newsItems[this.activeItem].url === "string" ? this.newsItems[this.activeItem].url : this.newsItems[this.activeItem].url.href; + fullArticle.style.zIndex = 1; + wrapper.appendChild(fullArticle); + } + + if (this.config.hideLoading) { + this.show(); + } + + } else { + if (this.config.hideLoading) { + this.hide(); + } else { + wrapper.innerHTML = this.translate("LOADING"); + wrapper.className = "medium normal bold"; + } + } + + return wrapper; + }, + + /* registerFeeds() + * registers the feeds to be used by the backend. + */ + registerFeeds: function () { + for (var f in this.config.feeds) { + var feed = this.config.feeds[f]; + this.sendSocketNotification("ADD_FEED", { + feed: feed, + config: this.config + }); + } + }, + + /* generateFeed() + * Generate an ordered list of items for this configured module. + * + * attribute feeds object - An object with feeds returned by the node helper. + */ + generateFeed: function (feeds) { + var newsItems = []; + for (var feed in feeds) { + var feedItems = feeds[feed]; + if (this.subscribedToFeed(feed)) { + for (var i in feedItems) { + var item = feedItems[i]; + item.sourceTitle = this.titleForFeed(feed); + if (!(this.config.ignoreOldItems && ((Date.now() - new Date(item.pubdate)) > this.config.ignoreOlderThan))) { + newsItems.push(item); + } + } + } + } + newsItems.sort(function (a, b) { + var dateA = new Date(a.pubdate); + var dateB = new Date(b.pubdate); + return dateB - dateA; + }); + + if (this.config.maxNewsItems > 0) { + newsItems = newsItems.slice(0, this.config.maxNewsItems); + } + + if (this.config.prohibitedWords.length > 0) { + newsItems = newsItems.filter(function (value) { + for (var i = 0; i < this.config.prohibitedWords.length; i++) { + if (value["title"].toLowerCase().indexOf(this.config.prohibitedWords[i].toLowerCase()) > -1) { + return false; + } + } + return true; + }, this); + } + + this.newsItems = newsItems; + }, + + /* subscribedToFeed(feedUrl) + * Check if this module is configured to show this feed. + * + * attribute feedUrl string - Url of the feed to check. + * + * returns bool + */ + subscribedToFeed: function (feedUrl) { + for (var f in this.config.feeds) { + var feed = this.config.feeds[f]; + if (feed.url === feedUrl) { + return true; + } + } + return false; + }, + + /* titleForFeed(feedUrl) + * Returns title for a specific feed Url. + * + * attribute feedUrl string - Url of the feed to check. + * + * returns string + */ + titleForFeed: function (feedUrl) { + for (var f in this.config.feeds) { + var feed = this.config.feeds[f]; + if (feed.url === feedUrl) { + return feed.title || ""; + } + } + return ""; + }, + + logoForFeed: function(feedUrl) { + for (var f in this.config.feeds) { + var feed = this.config.feeds[f]; + if (feed.url === feedUrl) { + return feed.logo || feed.icon || feed.image || ""; + } + } + return ""; + }, + + /* scheduleUpdateInterval() + * Schedule visual update. + */ + scheduleUpdateInterval: function () { + var self = this; + + self.updateDom(self.config.animationSpeed); + + timer = setInterval(function () { + self.activeItem++; + self.updateDom(self.config.animationSpeed); + }, this.config.updateInterval); + }, + + /* capitalizeFirstLetter(string) + * Capitalizes the first character of a string. + * + * argument string string - Input string. + * + * return string - Capitalized output string. + */ + capitalizeFirstLetter: function (string) { + return string.charAt(0).toUpperCase() + string.slice(1); + }, + + resetDescrOrFullArticleAndTimer: function () { + this.isShowingDescription = this.config.showDescription; + this.config.showFullArticle = false; + this.scrollPosition = 0; + // reset bottom bar alignment + document.getElementsByClassName("region top bar")[0].style.top = "0"; + document.getElementsByClassName("region top bar")[0].style.top = "inherit"; + if (!timer) { + this.scheduleUpdateInterval(); + } + }, + + notificationReceived: function (notification, payload, sender) { + Log.info(this.name + " - received notification: " + notification); + if (notification == "ARTICLE_NEXT") { + var before = this.activeItem; + this.activeItem++; + if (this.activeItem >= this.newsItems.length) { + this.activeItem = 0; + } + this.resetDescrOrFullArticleAndTimer(); + Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")"); + this.updateDom(100); + } else if (notification == "ARTICLE_PREVIOUS") { + var before = this.activeItem; + this.activeItem--; + if (this.activeItem < 0) { + this.activeItem = this.newsItems.length - 1; + } + this.resetDescrOrFullArticleAndTimer(); + Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")"); + this.updateDom(100); + } + // if "more details" is received the first time: show article summary, on second time show full article + else if (notification == "ARTICLE_MORE_DETAILS") { + // full article is already showing, so scrolling down + if (this.config.showFullArticle == true) { + this.scrollPosition += this.config.scrollLength; + window.scrollTo(0, this.scrollPosition); + Log.info(this.name + " - scrolling left"); + Log.info(this.name + " - ARTICLE_MORE_DETAILS, scroll position: " + this.config.scrollLength); + } + else { + this.showFullArticle(); + } + } else if (notification == "ARTICLE_SCROLL_UP") { + if (this.config.showFullArticle == true) { + this.scrollPosition -= this.config.scrollLength; + window.scrollTo(0, this.scrollPosition); + Log.info(this.name + " - scrolling up"); + Log.info(this.name + " - ARTICLE_SCROLL_UP, scroll position: " + this.config.scrollLength); + } + } else if (notification == "ARTICLE_LESS_DETAILS") { + this.resetDescrOrFullArticleAndTimer(); + Log.info(this.name + " - showing only article titles again"); + this.updateDom(100); + } else if (notification === "ARTICLE_TOGGLE_FULL"){ + if (this.config.showFullArticle){ + this.activeItem++; + this.resetDescrOrFullArticleAndTimer(); + } else { + this.showFullArticle(); + } + } else { + Log.info(this.name + " - unknown notification, ignoring: " + notification); + } + }, + + showFullArticle: function() { + this.isShowingDescription = !this.isShowingDescription; + this.config.showFullArticle = !this.isShowingDescription; + // make bottom bar align to top to allow scrolling + if(this.config.showFullArticle === true){ + document.getElementsByClassName("region top bar")[0].style.bottom = "inherit"; + document.getElementsByClassName("region top bar")[0].style.top = "-90px"; + } + clearInterval(timer); + timer = null; + Log.info(this.name + " - showing " + this.isShowingDescription ? "article description" : "full article"); + this.updateDom(100); + } + +}); diff --git a/README.md b/README.md index e89b7d8..f80ea4e 100644 --- a/README.md +++ b/README.md @@ -1 +1,73 @@ -# NewsFeedTicker \ No newline at end of file +# MMM-NewsFeedTicker +news ticker like what you see on the news channels, except for online newspapers. +Each listed new# Module: MMM-NewsFeedTicker + +The MMM-NewsFeedTickermodule is a 3rd party module of the MagicMirror +This module loads a YouTube player and a specified playlist and will randomize the videos. + +## Using the module... + +To use this module, add it to the modules array in the 'config/config.js' file: +``` +modules: [ + { + disabled: false, + module: "MMM-NewsFeedTicker", + position: "bottom_bar", //works best in top_bar or bottom_bar + //classes: "day_scheduler", // this is for the MMM-ModuleScheduler module (https://github.com/ianperrin/MMM-ModuleScheduler.git) + config: { + height: "100px", + width: "100%", + feedsource: [ + { + imageUrl: "https://static01.nyt.com/images/misc/NYT_logo_rss_250x40.png", + title: "New York Times", + url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml" + }, + { + imageUrl: "http://online.wsj.com/img/wsj_sm_logo.gif", + title: "Wall St. Journal", + url: "http://www.wsj.com/xml/rss/3_7085.xml" + }, + { + imageUrl: "http://www.gannett-cdn.com/sites/usatnetwork/images/RSS_Syndication_Logo-USATN.png", + title: "USA Today", + url: "http://rssfeeds.usatoday.com/UsatodaycomNation-TopStories" + }, + { + imageUrl: "https://news.bbcimg.co.uk/nol/shared/img/bbc_news_120x60.gif", + title: "BBC World News", + url: "http://feeds.bbci.co.uk/news/world/rss.xml#" + } + ], + } + }, +] +``` + +## Install... +``` +cd ~/MagicMirror/modules +git clone https://github.com/justjim1220/MMM-NewsFeedTicker.git +cd MMM-NewsFeedTicker +npm install +``` + +## Other Info... +``` +can add as many feeds as you like. +to change or add feedsources... + - need to make sure the site can be linked + - need to add the imageURL from the RSS or XML feed + + - Hope you all like it! +``` + + + +## Acknowledgements... +First, I want to thank @sdetweil, @Sean, @cowboysdude, & @Mykle1 for their patience in attempting to teach me this coding stuff!!! + +And, @Sean & @sdetweil for giving the pointers I needed to finish it when I was stuck! + +Enjoy! diff --git a/fetcher.js b/fetcher.js new file mode 100644 index 0000000..dff90d4 --- /dev/null +++ b/fetcher.js @@ -0,0 +1,192 @@ +/* Magic Mirror + * Fetcher + * + * By Michael Teeuw http://michaelteeuw.nl + * MIT Licensed. + */ + +var FeedMe = require("feedme"); +var request = require("request"); +var iconv = require("iconv-lite"); + +/* Fetcher + * Responsible for requesting an update on the set interval and broadcasting the data. + * + * attribute url string - URL of the news feed. + * attribute reloadInterval number - Reload interval in milliseconds. + * attribute logFeedWarnings boolean - Log warnings when there is an error parsing a news article. + */ + +var Fetcher = function(url, reloadInterval, encoding, logFeedWarnings) { + var self = this; + if (reloadInterval < 1000) { + reloadInterval = 1000; + } + + var reloadTimer = null; + var items = []; + + var fetchFailedCallback = function() {}; + var itemsReceivedCallback = function() {}; + + /* private methods */ + + /* fetchNews() + * Request the new items. + */ + + var fetchNews = function() { + clearTimeout(reloadTimer); + reloadTimer = null; + items = []; + + var parser = new FeedMe(); + + parser.on("item", function(item) { + + var title = item.title; + var image = item.image || item.logo || item.img || item.svg || ""; + var description = item.description || item.summary || item.content || ""; + var pubdate = item.pubdate || item.published || item.updated || item["dc:date"]; + var url = item.url || item.link || ""; + + if (title && pubdate) { + + var regex = /(<([^>]+)>)/ig; + description = description.toString().replace(regex, ""); + + items.push({ + title: title, + image: image, + description: description, + pubdate: pubdate, + url: url, + }); + + } else if (logFeedWarnings) { + console.log("Can't parse feed item:"); + console.log(item); + console.log("Title: " + title); + console.log("Image: " + image); + console.log("Description: " + description); + console.log("Pubdate: " + pubdate); + } + }); + + parser.on("image", function(image){ + var title = image.title; + var image = image.image || image.logo || image.img || image.svg || this.feed_var_in_function.icon || ""; + var url = image.url || image.link || ""; + if (image && url) { + + var regex = /(]+)>)/ig; + description = description.toString().replace(regex, ""); + + images.push({ + title: title, + image: image, + url: url, + }); + + } else if (logFeedWarnings) { + console.log("Can't parse feed item:"); + console.log(item); + console.log("Title: " + title); + console.log("Image: " + image); + console.log("Description: " + description); + console.log("Pubdate: " + pubdate); + } + }); + + parser.on("end", function() { + //console.log("end parsing - " + url); + self.broadcastItems(); + scheduleTimer(); + }); + + parser.on("error", function(error) { + fetchFailedCallback(self, error); + scheduleTimer(); + }); + + + nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]); + headers = {"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)", + "Cache-Control": "max-age=0, no-cache, no-store, must-revalidate", + "Pragma": "no-cache"} + + request({uri: url, encoding: null, headers: headers}) + .on("error", function(error) { + fetchFailedCallback(self, error); + scheduleTimer(); + }) + .pipe(iconv.decodeStream(encoding)).pipe(parser); + + }; + + /* scheduleTimer() + * Schedule the timer for the next update. + */ + + var scheduleTimer = function() { + //console.log('Schedule update timer.'); + clearTimeout(reloadTimer); + reloadTimer = setTimeout(function() { + fetchNews(); + }, reloadInterval); + }; + + /* public methods */ + + /* setReloadInterval() + * Update the reload interval, but only if we need to increase the speed. + * + * attribute interval number - Interval for the update in milliseconds. + */ + this.setReloadInterval = function(interval) { + if (interval > 1000 && interval < reloadInterval) { + reloadInterval = interval; + } + }; + + /* startFetch() + * Initiate fetchNews(); + */ + this.startFetch = function() { + fetchNews(); + }; + + /* broadcastItems() + * Broadcast the existing items. + */ + this.broadcastItems = function() { + if (items.length <= 0) { + //console.log('No items to broadcast yet.'); + return; + } + //console.log('Broadcasting ' + items.length + ' items.'); + itemsReceivedCallback(self); + }; + + this.onReceive = function(callback) { + itemsReceivedCallback = callback; + }; + + this.onError = function(callback) { + fetchFailedCallback = callback; + }; + + this.url = function() { + return url; + }; + + this.image = function() { + return image; + }; + + this.items = function() { + return items; + }; +}; + +module.exports = Fetcher; diff --git a/jsconfig.json b/jsconfig.json new file mode 100644 index 0000000..f68f8a6 --- /dev/null +++ b/jsconfig.json @@ -0,0 +1,13 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=759670 + // for the documentation about the jsconfig.json format + "compilerOptions": { + "target": "es6", + "module": "commonjs", + "allowSyntheticDefaultImports": true + }, + "exclude": [ + "modules", + "node_modules" + ] +} diff --git a/node_helper.js b/node_helper.js new file mode 100644 index 0000000..5e9ef91 --- /dev/null +++ b/node_helper.js @@ -0,0 +1,105 @@ +/* Magic Mirror + * Node Helper: Newsfeed + * + * By Michael Teeuw http://michaelteeuw.nl + * MIT Licensed. + */ + +var NodeHelper = require("node_helper"); +var validUrl = require("valid-url"); +var Fetcher = require("./fetcher.js"); + +module.exports = NodeHelper.create({ + // Subclass start method. + start: function() { + console.log("Starting module: " + this.name); + this.fetchers = []; + }, + + // Subclass socketNotificationReceived received. + socketNotificationReceived: function(notification, payload) { + if (notification === "ADD_FEED") { + this.createFetcher(payload.feed, payload.config); + return; + } + }, + + /* createFetcher(feed, config) + * Creates a fetcher for a new feed if it doesn't exist yet. + * Otherwise it reuses the existing one. + * + * attribute feed object - A feed object. + * attribute config object - A configuration object containing reload interval in milliseconds. + */ + createFetcher: function(feed, config) { + var self = this; + + var url = feed.url || ""; + var encoding = feed.encoding || "UTF-8"; + var reloadInterval = feed.reloadInterval || config.reloadInterval || 5 * 60 * 1000; + + if (!validUrl.isUri(url)) { + self.sendSocketNotification("INCORRECT_URL", url); + return; + } + + var fetcher; + if (typeof self.fetchers[url] === "undefined") { + console.log("Create new news fetcher for url: " + url + " - Interval: " + reloadInterval); + fetcher = new Fetcher(url, reloadInterval, encoding, config.logFeedWarnings); + + fetcher.onReceive(function(fetcher) { + for(var item in fetcher.items()) + { + item.icon=this.feed_def.icon; + } + self.broadcastFeeds(); + }.bind({feed_var_in_function:feed})); + + fetcher.onError(function(fetcher, error) { + self.sendSocketNotification("FETCH_ERROR", { + url: fetcher.url(), + error: error + }); + }); + + self.fetchers[url] = fetcher; + } else { + console.log("Use existing news fetcher for url: " + url); + fetcher = self.fetchers[url]; + fetcher.setReloadInterval(reloadInterval); + fetcher.broadcastItems(); + } + + fetcher.startFetch(); + }, + + /* broadcastFeeds() + * Creates an object with all feed items of the different registered feeds, + * and broadcasts these using sendSocketNotification. + */ + broadcastFeeds: function() { + var feeds = {}; + for (var f in this.fetchers) { + feeds[f] = this.fetchers[f].items(); + } + this.sendSocketNotification("NEWS_ITEMS", feeds); + } +}); + + +/* + +fetcher = new Fetcher(url, reloadInterval, encoding, config.logFeedWarnings); + + fetcher.onReceive(function(fetcher) { + // add code here to run thru the array of feed response items and add the icon url to each entry.. + // the feed definition was passed in as parm to the containing method.. because this is a callback, you will probably have to bind the feed definition to this function + for( var item in fetcher.items()) + { + item.icon=this.feed_def.icon; + } + self.broadcastFeeds(); + }).bind({feed_def:feed}) + + */ \ No newline at end of file diff --git a/pics/BBCNews.png b/pics/BBCNews.png new file mode 100644 index 0000000..5251cfc Binary files /dev/null and b/pics/BBCNews.png differ diff --git a/pics/BBCWorldNews-1.png b/pics/BBCWorldNews-1.png new file mode 100644 index 0000000..1f995a7 Binary files /dev/null and b/pics/BBCWorldNews-1.png differ diff --git a/pics/BBCWorldNews-color.png b/pics/BBCWorldNews-color.png new file mode 100644 index 0000000..8f448df Binary files /dev/null and b/pics/BBCWorldNews-color.png differ diff --git a/pics/BBCWorldNews.png b/pics/BBCWorldNews.png new file mode 100644 index 0000000..e6ffbc0 Binary files /dev/null and b/pics/BBCWorldNews.png differ diff --git a/pics/KansasCityStar.png b/pics/KansasCityStar.png new file mode 100644 index 0000000..aa205fc Binary files /dev/null and b/pics/KansasCityStar.png differ diff --git a/pics/Kansas_City_Star.svg b/pics/Kansas_City_Star.svg new file mode 100644 index 0000000..30e7c15 --- /dev/null +++ b/pics/Kansas_City_Star.svg @@ -0,0 +1,359 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/pics/NYT_logo_rss_250x40.png b/pics/NYT_logo_rss_250x40.png new file mode 100644 index 0000000..0dc5753 Binary files /dev/null and b/pics/NYT_logo_rss_250x40.png differ diff --git a/pics/NewYorkTimes.jpg b/pics/NewYorkTimes.jpg new file mode 100644 index 0000000..dffae25 Binary files /dev/null and b/pics/NewYorkTimes.jpg differ diff --git a/pics/NewYorkTimes.png b/pics/NewYorkTimes.png new file mode 100644 index 0000000..b54beae Binary files /dev/null and b/pics/NewYorkTimes.png differ diff --git a/pics/NewYorkTimesLogo.jpg b/pics/NewYorkTimesLogo.jpg new file mode 100644 index 0000000..7833d47 Binary files /dev/null and b/pics/NewYorkTimesLogo.jpg differ diff --git a/pics/RSS_Syndication_Logo-USATN.png b/pics/RSS_Syndication_Logo-USATN.png new file mode 100644 index 0000000..85c3551 Binary files /dev/null and b/pics/RSS_Syndication_Logo-USATN.png differ diff --git a/pics/Republican-Clipper-LOGO-e.jpg b/pics/Republican-Clipper-LOGO-e.jpg new file mode 100644 index 0000000..a8e8014 Binary files /dev/null and b/pics/Republican-Clipper-LOGO-e.jpg differ diff --git a/pics/The-Kansas-City-Star-logo.jpg b/pics/The-Kansas-City-Star-logo.jpg new file mode 100644 index 0000000..c84e376 Binary files /dev/null and b/pics/The-Kansas-City-Star-logo.jpg differ diff --git a/pics/TheIrishNews.png b/pics/TheIrishNews.png new file mode 100644 index 0000000..ec27b74 Binary files /dev/null and b/pics/TheIrishNews.png differ diff --git a/pics/TheWashingtonPost WB.png b/pics/TheWashingtonPost WB.png new file mode 100644 index 0000000..89b3720 Binary files /dev/null and b/pics/TheWashingtonPost WB.png differ diff --git a/pics/TheWashingtonPost.png b/pics/TheWashingtonPost.png new file mode 100644 index 0000000..9c23d89 Binary files /dev/null and b/pics/TheWashingtonPost.png differ diff --git a/pics/TheWashingtonPostBW.png b/pics/TheWashingtonPostBW.png new file mode 100644 index 0000000..52334bd Binary files /dev/null and b/pics/TheWashingtonPostBW.png differ diff --git a/pics/USAToday-1.png b/pics/USAToday-1.png new file mode 100644 index 0000000..c7c090e Binary files /dev/null and b/pics/USAToday-1.png differ diff --git a/pics/USAToday.png b/pics/USAToday.png new file mode 100644 index 0000000..47de8ba Binary files /dev/null and b/pics/USAToday.png differ diff --git a/pics/Wall-Street-Journal-Logo.jpg b/pics/Wall-Street-Journal-Logo.jpg new file mode 100644 index 0000000..6f0f6ea Binary files /dev/null and b/pics/Wall-Street-Journal-Logo.jpg differ diff --git a/pics/WallStJournal.png b/pics/WallStJournal.png new file mode 100644 index 0000000..5af1cd0 Binary files /dev/null and b/pics/WallStJournal.png differ diff --git a/pics/bbc.jpg b/pics/bbc.jpg new file mode 100644 index 0000000..b36bd18 Binary files /dev/null and b/pics/bbc.jpg differ diff --git a/pics/bbc_news_logo.png b/pics/bbc_news_logo.png new file mode 100644 index 0000000..bee0041 Binary files /dev/null and b/pics/bbc_news_logo.png differ diff --git a/pics/download (2).png b/pics/download (2).png new file mode 100644 index 0000000..182f54c Binary files /dev/null and b/pics/download (2).png differ diff --git a/pics/download (3).png b/pics/download (3).png new file mode 100644 index 0000000..b30f521 Binary files /dev/null and b/pics/download (3).png differ diff --git a/pics/download (5).png b/pics/download (5).png new file mode 100644 index 0000000..7283f7e Binary files /dev/null and b/pics/download (5).png differ diff --git a/pics/download (7).png b/pics/download (7).png new file mode 100644 index 0000000..c4080bb Binary files /dev/null and b/pics/download (7).png differ diff --git a/pics/download (9).png b/pics/download (9).png new file mode 100644 index 0000000..e03a921 Binary files /dev/null and b/pics/download (9).png differ diff --git a/pics/download.png b/pics/download.png new file mode 100644 index 0000000..07e768e Binary files /dev/null and b/pics/download.png differ diff --git a/pics/header-logo.jpg b/pics/header-logo.jpg new file mode 100644 index 0000000..6ddb7a2 Binary files /dev/null and b/pics/header-logo.jpg differ diff --git a/pics/images (1).png b/pics/images (1).png new file mode 100644 index 0000000..9449800 Binary files /dev/null and b/pics/images (1).png differ diff --git a/pics/logo.svg b/pics/logo.svg new file mode 100644 index 0000000..640d385 --- /dev/null +++ b/pics/logo.svg @@ -0,0 +1 @@ +kansas-city-star \ No newline at end of file diff --git a/pics/twp-masthead-415x57.svg b/pics/twp-masthead-415x57.svg new file mode 100644 index 0000000..521c64b --- /dev/null +++ b/pics/twp-masthead-415x57.svg @@ -0,0 +1,119 @@ + + + + + + + + + + + + + + + + diff --git a/pics/washington-post-logo-300x221.jpg b/pics/washington-post-logo-300x221.jpg new file mode 100644 index 0000000..f7853c5 Binary files /dev/null and b/pics/washington-post-logo-300x221.jpg differ diff --git a/pics/wsj_launcher-icon-3x.png b/pics/wsj_launcher-icon-3x.png new file mode 100644 index 0000000..c5e9541 Binary files /dev/null and b/pics/wsj_launcher-icon-3x.png differ