diff --git a/.gitignore b/.gitignore index 36902e2..3db300b 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,20 @@ node_modules server/config/reddit.coffee server/config/keys src/coffee/config.coffee + +# +# Electron +# +!electron/build +.DS_Store +Thumbs.db +*.autogenerated +electron/dist +electron/coverage + +# ignore everything in 'app' folder what had been generated from 'src' folder +electron/app/stylesheets +electron/app/app.js +electron/app/background.js +electron/app/env.json +electron/app/**/*.map \ No newline at end of file diff --git a/electron/.travis.yml b/electron/.travis.yml new file mode 100644 index 0000000..c716de3 --- /dev/null +++ b/electron/.travis.yml @@ -0,0 +1,24 @@ +os: + - linux + - osx + +branches: + only: + - master + +env: + - NODE_VERSION="6.3.0" + +before_script: + - chmod +x ./scripts/travis-build.sh + +script: ./scripts/travis-build.sh + +cache: + directories: + - node_modules + +notifications: + email: + on_success: never + on_failure: change diff --git a/electron/LICENSE b/electron/LICENSE new file mode 100644 index 0000000..78f62ad --- /dev/null +++ b/electron/LICENSE @@ -0,0 +1,596 @@ +GNU GENERAL PUBLIC LICENSE +========================== + +Version 3, 29 June 2007 + +Copyright © 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/electron/README.md b/electron/README.md new file mode 100644 index 0000000..a765e33 --- /dev/null +++ b/electron/README.md @@ -0,0 +1,20 @@ +# Reddit Music Player Electron Application + +For more info, check out: + +* [electron](http://electron.atom.io/) +* [electron-boilerplate](https://github.com/szwacz/electron-boilerplate) + +# Quick start + +``` +cd redditmusicplayer/electron +npm install +npm start +``` + +# Build a production app / installer + +``` +npm run release +``` \ No newline at end of file diff --git a/electron/app/helpers/context_menu.js b/electron/app/helpers/context_menu.js new file mode 100644 index 0000000..b50877b --- /dev/null +++ b/electron/app/helpers/context_menu.js @@ -0,0 +1,59 @@ +// This gives you default context menu (cut, copy, paste) +// in all input fields and textareas across your app. + +(function () { + 'use strict'; + + var remote = require('electron').remote; + var Menu = remote.Menu; + var MenuItem = remote.MenuItem; + + var isAnyTextSelected = function () { + return window.getSelection().toString() !== ''; + }; + + var cut = new MenuItem({ + label: "Cut", + click: function () { + document.execCommand("cut"); + } + }); + + var copy = new MenuItem({ + label: "Copy", + click: function () { + document.execCommand("copy"); + } + }); + + var paste = new MenuItem({ + label: "Paste", + click: function () { + document.execCommand("paste"); + } + }); + + var normalMenu = new Menu(); + normalMenu.append(copy); + + var textEditingMenu = new Menu(); + textEditingMenu.append(cut); + textEditingMenu.append(copy); + textEditingMenu.append(paste); + + document.addEventListener('contextmenu', function (e) { + switch (e.target.nodeName) { + case 'TEXTAREA': + case 'INPUT': + e.preventDefault(); + textEditingMenu.popup(remote.getCurrentWindow()); + break; + default: + if (isAnyTextSelected()) { + e.preventDefault(); + normalMenu.popup(remote.getCurrentWindow()); + } + } + }, false); + +}()); diff --git a/electron/app/helpers/external_links.js b/electron/app/helpers/external_links.js new file mode 100644 index 0000000..12e94ed --- /dev/null +++ b/electron/app/helpers/external_links.js @@ -0,0 +1,44 @@ +// Convenient way for opening links in external browser, not in the app. +// Useful especially if you have a lot of links to deal with. +// +// Usage: +// +// Every link with class ".js-external-link" will be opened in external browser. +// google +// +// The same behaviour for many links can be achieved by adding +// this class to any parent tag of an anchor tag. +// + +(function () { + 'use strict'; + + var shell = require('electron').shell; + + var supportExternalLinks = function (e) { + var href; + var isExternal = false; + + var checkDomElement = function (element) { + if (element.nodeName === 'A') { + href = element.getAttribute('href'); + } + if (element.classList.contains('js-external-link')) { + isExternal = true; + } + if (href && isExternal) { + shell.openExternal(href); + e.preventDefault(); + } else if (element.parentElement) { + checkDomElement(element.parentElement); + } + }; + + checkDomElement(e.target); + }; + + document.addEventListener('click', supportExternalLinks, false); +}()); diff --git a/electron/appveyor.yml b/electron/appveyor.yml new file mode 100644 index 0000000..62ac8a8 --- /dev/null +++ b/electron/appveyor.yml @@ -0,0 +1,26 @@ +build: off + +os: unstable + +branches: + only: + - master + +skip_tags: true + +environment: + nodejs_version: "6.3.0" + +cache: + - node_modules -> package.json + +install: + - ps: Install-Product node $env:nodejs_version + - npm install npm + - .\node_modules\.bin\npm install + +test_script: + - node --version + - .\node_modules\.bin\npm --version + - .\node_modules\.bin\npm test + - .\node_modules\.bin\npm run e2e diff --git a/electron/build/icon.icns b/electron/build/icon.icns new file mode 100644 index 0000000..fccf09d Binary files /dev/null and b/electron/build/icon.icns differ diff --git a/electron/build/icon.ico b/electron/build/icon.ico new file mode 100644 index 0000000..139fe2d Binary files /dev/null and b/electron/build/icon.ico differ diff --git a/electron/build/icons/512x512.png b/electron/build/icons/512x512.png new file mode 100644 index 0000000..1f202d1 Binary files /dev/null and b/electron/build/icons/512x512.png differ diff --git a/electron/config/env_development.json b/electron/config/env_development.json new file mode 100644 index 0000000..efb7748 --- /dev/null +++ b/electron/config/env_development.json @@ -0,0 +1,4 @@ +{ + "name": "development", + "description": "Add here any environment specific stuff you like." +} diff --git a/electron/config/env_production.json b/electron/config/env_production.json new file mode 100644 index 0000000..600b2d7 --- /dev/null +++ b/electron/config/env_production.json @@ -0,0 +1,4 @@ +{ + "name": "production", + "description": "Add here any environment specific stuff you like." +} diff --git a/electron/config/env_test.json b/electron/config/env_test.json new file mode 100644 index 0000000..e3956a5 --- /dev/null +++ b/electron/config/env_test.json @@ -0,0 +1,4 @@ +{ + "name": "test", + "description": "Add here any environment specific stuff you like." +} diff --git a/electron/gulpfile.js b/electron/gulpfile.js new file mode 100644 index 0000000..9ea1796 --- /dev/null +++ b/electron/gulpfile.js @@ -0,0 +1,5 @@ +'use strict'; + +require('./tasks/build_app'); +require('./tasks/build_tests'); +require('./tasks/start'); diff --git a/electron/package.json b/electron/package.json new file mode 100644 index 0000000..1ae1e35 --- /dev/null +++ b/electron/package.json @@ -0,0 +1,52 @@ +{ + "name": "redditmusicplayer-electron", + "productName": "Reddit Music Player", + "description": "Music Player For Reddit | A Free and Open-Source Music Player", + "version": "1.0.0", + "author": "Nick Franken ", + "license": "GPLv3", + "main": "app/background.js", + "build": { + "appId": "com.example.redditmusicplayer", + "files": [ + "app/**/*", + "node_modules/**/*", + "package.json" + ] + }, + "scripts": { + "postinstall": "install-app-deps", + "build": "gulp build", + "prerelease": "gulp build --env=production", + "release": "build", + "start": "gulp start", + "pretest": "gulp build-unit --env=test", + "test": "electron-mocha app/specs.js.autogenerated --renderer --require source-map-support/register", + "coverage": "npm test -- -R scripts/istanbul-reporter", + "pree2e": "gulp build-e2e --env=test", + "e2e": "mocha app/e2e.js.autogenerated --require source-map-support/register" + }, + "dependencies": { + "fs-jetpack": "^0.10.2", + "jquery": "^2.1.4" + }, + "devDependencies": { + "chai": "^3.5.0", + "electron": "^1.4.7", + "electron-builder": "^8.6.0", + "electron-mocha": "^3.0.0", + "gulp": "^3.9.0", + "gulp-batch": "^1.0.5", + "gulp-less": "^3.0.3", + "gulp-plumber": "^1.1.0", + "gulp-util": "^3.0.6", + "gulp-watch": "^4.3.5", + "istanbul": "^0.4.3", + "minimist": "^1.2.0", + "mocha": "^3.0.2", + "rollup": "^0.36.3", + "rollup-plugin-istanbul": "^1.1.0", + "source-map-support": "^0.4.2", + "spectron": "^3.3.0" + } +} diff --git a/electron/src/app.js b/electron/src/app.js new file mode 100644 index 0000000..e69de29 diff --git a/electron/src/background.js b/electron/src/background.js new file mode 100644 index 0000000..c4d7b85 --- /dev/null +++ b/electron/src/background.js @@ -0,0 +1,75 @@ +// This is main process of Electron, started as first thing when your +// app starts. This script is running through entire life of your application. +// It doesn't have any windows which you can see on screen, but we can open +// window from here. + +import path from 'path'; +import url from 'url'; +import { app, Menu, BrowserWindow, globalShortcut } from 'electron'; +import { devMenuTemplate } from './menu/dev_menu_template'; +import { editMenuTemplate } from './menu/edit_menu_template'; +import createWindow from './helpers/window'; + +// Special module holding environment variables which you declared +// in config/env_xxx.json file. +import env from './env'; + +var mainWindow, keysWindow; + +var setApplicationMenu = function () { + var menus = [editMenuTemplate]; + if (env.name !== 'production') { + menus.push(devMenuTemplate); + } + Menu.setApplicationMenu(Menu.buildFromTemplate(menus)); +}; + +// Save userData in separate folders for each environment. +// Thanks to this you can use production and development versions of the app +// on same machine like those are two separate apps. +if (env.name !== 'production') { + var userDataPath = app.getPath('userData'); + app.setPath('userData', userDataPath + ' (' + env.name + ')'); +} + +app.on('ready', function () { + setApplicationMenu(); + + mainWindow = createWindow('main', { + width: 1024, + height: 768, + minWidth: 1024, + minHeight: 768, + webPreferences: { + nodeIntegration: false + } + }); + + mainWindow.loadURL('https://reddit.musicplayer.io/'); + + let webContents = mainWindow.webContents + + if (env.name === 'development') { + mainWindow.openDevTools(); + } + + globalShortcut.register('MediaNextTrack', () => { + webContents.executeJavaScript("$('.item.forward.button').click()") + }) + + globalShortcut.register('MediaPreviousTrack', () => { + webContents.executeJavaScript("$('.item.backward.button').click()") + }) + + globalShortcut.register('MediaStop', () => { + webContents.executeJavaScript("$('.item.play.button').click()") + }) + + globalShortcut.register('MediaPlayPause', () => { + webContents.executeJavaScript("$('.item.play.button').click()") + }) +}); + +app.on('window-all-closed', function () { + app.quit(); +}); diff --git a/electron/src/env.js b/electron/src/env.js new file mode 100644 index 0000000..dc48a38 --- /dev/null +++ b/electron/src/env.js @@ -0,0 +1,8 @@ +// Simple wrapper exposing environment variables to rest of the code. + +import jetpack from 'fs-jetpack'; + +// The variables have been written to `env.json` by the build process. +var env = jetpack.cwd(__dirname).read('env.json', 'json'); + +export default env; diff --git a/electron/src/helpers/window.js b/electron/src/helpers/window.js new file mode 100644 index 0000000..befd29f --- /dev/null +++ b/electron/src/helpers/window.js @@ -0,0 +1,83 @@ +// This helper remembers the size and position of your windows (and restores +// them in that place after app relaunch). +// Can be used for more than one window, just construct many +// instances of it and give each different name. + +import { app, BrowserWindow, screen } from 'electron'; +import jetpack from 'fs-jetpack'; + +export default function (name, options) { + + var userDataDir = jetpack.cwd(app.getPath('userData')); + var stateStoreFile = 'window-state-' + name +'.json'; + var defaultSize = { + width: options.width, + height: options.height + }; + var state = {}; + var win; + + var restore = function () { + var restoredState = {}; + try { + restoredState = userDataDir.read(stateStoreFile, 'json'); + } catch (err) { + // For some reason json can't be read (might be corrupted). + // No worries, we have defaults. + } + return Object.assign({}, defaultSize, restoredState); + }; + + var getCurrentPosition = function () { + var position = win.getPosition(); + var size = win.getSize(); + return { + x: position[0], + y: position[1], + width: size[0], + height: size[1] + }; + }; + + var windowWithinBounds = function (windowState, bounds) { + return windowState.x >= bounds.x && + windowState.y >= bounds.y && + windowState.x + windowState.width <= bounds.x + bounds.width && + windowState.y + windowState.height <= bounds.y + bounds.height; + }; + + var resetToDefaults = function (windowState) { + var bounds = screen.getPrimaryDisplay().bounds; + return Object.assign({}, defaultSize, { + x: (bounds.width - defaultSize.width) / 2, + y: (bounds.height - defaultSize.height) / 2 + }); + }; + + var ensureVisibleOnSomeDisplay = function (windowState) { + var visible = screen.getAllDisplays().some(function (display) { + return windowWithinBounds(windowState, display.bounds); + }); + if (!visible) { + // Window is partially or fully not visible now. + // Reset it to safe defaults. + return resetToDefaults(windowState); + } + return windowState; + }; + + var saveState = function () { + if (!win.isMinimized() && !win.isMaximized()) { + Object.assign(state, getCurrentPosition()); + } + userDataDir.write(stateStoreFile, state, { atomic: true }); + }; + + state = ensureVisibleOnSomeDisplay(restore()); + + win = new BrowserWindow(Object.assign({}, options, state)); + + win.on('close', saveState); + + return win; +} diff --git a/electron/src/menu/dev_menu_template.js b/electron/src/menu/dev_menu_template.js new file mode 100644 index 0000000..63f3416 --- /dev/null +++ b/electron/src/menu/dev_menu_template.js @@ -0,0 +1,24 @@ +import { app, BrowserWindow } from 'electron'; + +export var devMenuTemplate = { + label: 'Development', + submenu: [{ + label: 'Reload', + accelerator: 'CmdOrCtrl+R', + click: function () { + BrowserWindow.getFocusedWindow().webContents.reloadIgnoringCache(); + } + },{ + label: 'Toggle DevTools', + accelerator: 'Alt+CmdOrCtrl+I', + click: function () { + BrowserWindow.getFocusedWindow().toggleDevTools(); + } + },{ + label: 'Quit', + accelerator: 'CmdOrCtrl+Q', + click: function () { + app.quit(); + } + }] +}; diff --git a/electron/src/menu/edit_menu_template.js b/electron/src/menu/edit_menu_template.js new file mode 100644 index 0000000..d225201 --- /dev/null +++ b/electron/src/menu/edit_menu_template.js @@ -0,0 +1,12 @@ +export var editMenuTemplate = { + label: 'Edit', + submenu: [ + { label: "Undo", accelerator: "CmdOrCtrl+Z", selector: "undo:" }, + { label: "Redo", accelerator: "Shift+CmdOrCtrl+Z", selector: "redo:" }, + { type: "separator" }, + { label: "Cut", accelerator: "CmdOrCtrl+X", selector: "cut:" }, + { label: "Copy", accelerator: "CmdOrCtrl+C", selector: "copy:" }, + { label: "Paste", accelerator: "CmdOrCtrl+V", selector: "paste:" }, + { label: "Select All", accelerator: "CmdOrCtrl+A", selector: "selectAll:" } + ] +}; diff --git a/electron/tasks/build_app.js b/electron/tasks/build_app.js new file mode 100644 index 0000000..8f1548b --- /dev/null +++ b/electron/tasks/build_app.js @@ -0,0 +1,53 @@ +'use strict'; + +var gulp = require('gulp'); +var less = require('gulp-less'); +var watch = require('gulp-watch'); +var batch = require('gulp-batch'); +var plumber = require('gulp-plumber'); +var jetpack = require('fs-jetpack'); +var bundle = require('./bundle'); +var utils = require('./utils'); + +var projectDir = jetpack; +var srcDir = jetpack.cwd('./src'); +var destDir = jetpack.cwd('./app'); + +gulp.task('bundle', function () { + return Promise.all([ + bundle(srcDir.path('background.js'), destDir.path('background.js')), + bundle(srcDir.path('app.js'), destDir.path('app.js')), + ]); +}); + +gulp.task('less', function () { + return gulp.src(srcDir.path('stylesheets/main.less')) + .pipe(plumber()) + .pipe(less()) + .pipe(gulp.dest(destDir.path('stylesheets'))); +}); + +gulp.task('environment', function () { + var configFile = 'config/env_' + utils.getEnvName() + '.json'; + projectDir.copy(configFile, destDir.path('env.json'), { overwrite: true }); +}); + +gulp.task('watch', function () { + var beepOnError = function (done) { + return function (err) { + if (err) { + utils.beepSound(); + } + done(err); + }; + }; + + watch('src/**/*.js', batch(function (events, done) { + gulp.start('bundle', beepOnError(done)); + })); + watch('src/**/*.less', batch(function (events, done) { + gulp.start('less', beepOnError(done)); + })); +}); + +gulp.task('build', ['bundle', 'less', 'environment']); diff --git a/electron/tasks/build_tests.js b/electron/tasks/build_tests.js new file mode 100644 index 0000000..230ddca --- /dev/null +++ b/electron/tasks/build_tests.js @@ -0,0 +1,51 @@ +'use strict'; + +var gulp = require('gulp'); +var jetpack = require('fs-jetpack'); +var bundle = require('./bundle'); +var istanbul = require('rollup-plugin-istanbul'); + +// Spec files are scattered through the whole project. Here we're searching +// for them and generate one entry file which will run all the tests. +var generateEntryFile = function (dir, destFileName, filePattern) { + var fileBanner = "// This file is generated automatically.\n" + + "// All modifications will be lost.\n"; + + return dir.findAsync('.', { matching: filePattern }) + .then(function (specPaths) { + var fileContent = specPaths.map(function (path) { + return 'import "./' + path.replace(/\\/g, '/') + '";'; + }).join('\n'); + return dir.writeAsync(destFileName, fileBanner + fileContent); + }) + .then(function () { + return dir.path(destFileName); + }); +}; + +gulp.task('build-unit', ['environment'], function () { + var srcDir = jetpack.cwd('src'); + var destDir = jetpack.cwd('app'); + + return generateEntryFile(srcDir, 'specs.js.autogenerated', '*.spec.js') + .then(function (entryFilePath) { + return bundle(entryFilePath, destDir.path('specs.js.autogenerated'), { + rollupPlugins: [ + istanbul({ + exclude: ['**/*.spec.js', '**/specs.js.autogenerated'], + sourceMap: true + }) + ] + }); + }); +}); + +gulp.task('build-e2e', ['build'], function () { + var srcDir = jetpack.cwd('e2e'); + var destDir = jetpack.cwd('app'); + + return generateEntryFile(srcDir, 'e2e.js.autogenerated', '*.e2e.js') + .then(function (entryFilePath) { + return bundle(entryFilePath, destDir.path('e2e.js.autogenerated')); + }); +}); diff --git a/electron/tasks/bundle.js b/electron/tasks/bundle.js new file mode 100644 index 0000000..1d6f619 --- /dev/null +++ b/electron/tasks/bundle.js @@ -0,0 +1,53 @@ +'use strict'; + +var path = require('path'); +var jetpack = require('fs-jetpack'); +var rollup = require('rollup').rollup; + +var nodeBuiltInModules = ['assert', 'buffer', 'child_process', 'cluster', + 'console', 'constants', 'crypto', 'dgram', 'dns', 'domain', 'events', + 'fs', 'http', 'https', 'module', 'net', 'os', 'path', 'process', 'punycode', + 'querystring', 'readline', 'repl', 'stream', 'string_decoder', 'timers', + 'tls', 'tty', 'url', 'util', 'v8', 'vm', 'zlib']; + +var electronBuiltInModules = ['electron']; + +var generateExternalModulesList = function () { + var appManifest = jetpack.read('./package.json', 'json'); + return [].concat( + nodeBuiltInModules, + electronBuiltInModules, + Object.keys(appManifest.dependencies), + Object.keys(appManifest.devDependencies) + ); +}; + +var cached = {}; + +module.exports = function (src, dest, opts) { + opts = opts || {}; + opts.rollupPlugins = opts.rollupPlugins || []; + return rollup({ + entry: src, + external: generateExternalModulesList(), + cache: cached[src], + plugins: opts.rollupPlugins, + }) + .then(function (bundle) { + cached[src] = bundle; + + var jsFile = path.basename(dest); + var result = bundle.generate({ + format: 'cjs', + sourceMap: true, + sourceMapFile: jsFile, + }); + // Wrap code in self invoking function so the variables don't + // pollute the global namespace. + var isolatedCode = '(function () {' + result.code + '\n}());'; + return Promise.all([ + jetpack.writeAsync(dest, isolatedCode + '\n//# sourceMappingURL=' + jsFile + '.map'), + jetpack.writeAsync(dest + '.map', result.map.toString()), + ]); + }); +}; diff --git a/electron/tasks/start.js b/electron/tasks/start.js new file mode 100644 index 0000000..116ccce --- /dev/null +++ b/electron/tasks/start.js @@ -0,0 +1,15 @@ +'use strict'; + +var childProcess = require('child_process'); +var electron = require('electron'); +var gulp = require('gulp'); + +gulp.task('start', ['build', 'watch'], function () { + childProcess.spawn(electron, ['.'], { + stdio: 'inherit' + }) + .on('close', function () { + // User closed the app. Kill the host process. + process.exit(); + }); +}); diff --git a/electron/tasks/utils.js b/electron/tasks/utils.js new file mode 100644 index 0000000..6e95998 --- /dev/null +++ b/electron/tasks/utils.js @@ -0,0 +1,11 @@ +'use strict'; + +var argv = require('minimist')(process.argv); + +exports.getEnvName = function () { + return argv.env || 'development'; +}; + +exports.beepSound = function () { + process.stdout.write('\u0007'); +};