diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..0ad25db4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 38296586..7ae656fa 100644 --- a/README.md +++ b/README.md @@ -155,13 +155,15 @@ StressLess/ ### Installation -1. Clone the repository: +1. Clone the repository if you have read/write access: ```bash -git clone https://github.com/trappaly/StressLess +git clone git@github.com:StressLess-Team/StressLess.git cd StressLess ``` +If you do not have read/write access to this repository but you want to contribute to **StressLess**, please see [Contributing Guidelines](docs/dev%20docs/contributing.md) for instructions on forking and making pull requests. You can keep following the steps below to set up your local environment. **In order for your forked repo's GitHub actions to run correctly, you have to enter every environment variables into GitHub secrets in Settings.** You should also get your deploy services secrets and put them into GitHub secrets for the `deploy.yml` action file to run. + ### Setting Environment Variables (Please contact a team member for the three .env files) In the `backend` directory, create a `.env` file and add the following variables: @@ -197,11 +199,22 @@ NEXT_PUBLIC_FIREBASE_APP_ID= NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID= ``` +**Note:** +After Spring 2025 grades are released by Grinnell College, the availability of database credentials used for our development cannot be guaranteed. +The availability of Firebase credentials cannot be guaranteed as well. +Therefore, after grades are released, team members may be unable to provide `.env` files. +You may need to provide your own PostgreSQL database and Firebase credentials after this point. + ### Setting Other Secrets The file `backend/serviceAccountKey.json` is the Firebase service account key JSON. An example is provided. This file is used to authenticate with Firebase services. Ask a team member for the content of this file. +**Note:** +After Spring 2025 grades are released by Grinnell College, the availability of Firebase credentials used for our development cannot be guaranteed. +Therefore, after grades are released, team members may be unable to provide the `serviceAccountKey.json` file. +You may need to provide your own Firebase credentials after this point. + ### Installing Dependencies At root level, run: @@ -212,20 +225,63 @@ pnpm install This will install 3 workspaces, because we have specified so in [pnpm-workspace.yaml](pnpm-workspace.yaml). This will install the dependencies for the backend and frontend. Alternatively, you can go into each directory and run `pnpm install` separately. -### Setting Up the Database +### Initial Database and Prisma Setup + +How to set up the database will depend on whether the database services used for our development are still available: +- Before Spring 2025 grades are released, you may ask a team member for credentials. + - This way, graders may use the team's credentials for grading purposes. +- After grades are released, please provide your own PostgreSQL database and Firebase credentials. + +Please consult the sections [Setting Environment Variables](#setting-environment-variables-please-contact-a-team-member-for-the-three-env-files) and [Setting Other Secrets](#setting-other-secrets) for more details on how to configure database and Firebase credentials. + +#### Option A. Before Spring 2025 grades are released (for grading purposes): + +##### Getting Onboard with Neon (Our Database) +1. Optional: Ask Madel to add you to the StressLess Neon database. (Optional: For testing, you can use ThunderClient, which you can easily download on VSCode under Extensions.) +2. Make sure your `.env` and `.test.env` files in the backend are good. See [Setting Environment Variables](#setting-environment-variables-please-contact-a-team-member-for-the-three-env-files) and [Setting Other Secrets](#setting-other-secrets) for more details. You may contact a team member for the content of these files. + + +##### Installing Prisma Client (Tool Used to Access Our Database Neon) + +```bash +cd backend +pnpm exec prisma generate +``` + +For more information on how to use **Prisma** after initial setup, check out [Prisma Guide](./docs/dev%20docs/database/Prisma.md) + +You may proceed to the section [Development](#development). -### Getting Onboard with Neon (Our Database) -1. Ask Madel to add you to the StressLess Neon database. (Optional: For testing, you can use ThunderClient, which you can easily download on VSCode under Extensions.) -2. Make sure your .env file in the backend is good. +#### Option B. After Spring 2025 grades are released: -### Installing Prisma Client (Tool Used to Access Our Database Neon) +##### Setting Up A Database +1. Please provide **two** PostgreSQL databases on your own (one for development and one for automated testing) +2. Make sure your `.env` and `.test.env` files in the backend are good. See [Setting Environment Variables](#setting-environment-variables-please-contact-a-team-member-for-the-three-env-files) and [Setting Other Secrets](#setting-other-secrets) for more details. + +##### Installing Prisma Client (Tool Used to Access Your Database) ```bash cd backend pnpm exec prisma generate ``` -For more information on **Prisma**, check out [Prisma Guide](./docs/dev%20docs/database/Prisma.md) +##### Adding The Schema to Your Database +Ensure that the two databases are empty. +Ensure you are in the `backend` directory (which you should be if you completed the previous step). + +**To add the schema to the development database:** +```bash +pnpm exec prisma migrate dev +``` + +**To add the schema to the automated testing database:** +```bash +pnpm exec env-cmd -f ./.test.env prisma migrate dev +``` + +For more information on how to use **Prisma** after initial setup, check out [Prisma Guide](./docs/dev%20docs/database/Prisma.md) + +You may proceed to the section [Development](#development). ### Development @@ -289,11 +345,11 @@ pnpm lint ## Docker -## Install Docker Desktop for your OS. +### Install Docker Desktop for your OS. https://docs.docker.com/get-started/get-docker/ -## Access the application by running +### Access the application by running Open Docker Desktop. Then run in the command line at root level: @@ -314,8 +370,8 @@ For more information, see the [Docker Guide](docs/dev%20docs/docker-guide.md). - [x] Milestone 7 - Release 1 and demo - [x] Milestone 8 - Documentation - [x] Milestone 9 - Code Review and demo -- [ ] Milestone 10 - Bug logging -- [ ] Milestone 11 - Final Presentation +- [x] Milestone 10 - Bug logging +- [x] Milestone 11 - Final Presentation - [ ] Milestone 12 - Final Release ## Authors @@ -329,4 +385,10 @@ For more information, see the [Docker Guide](docs/dev%20docs/docker-guide.md). ## Acknowledgments +We would like to thank Professor Leah Perlmutter and our class mentor Elliot Swaim for their guidance and support throughout this project. + +We would like to thank all of our stakeholders who gave us useful feedback to help us improve our app. We want to thank [this YouTube tutorial](https://youtu.be/VrC5XhjW6W0?si=_ibhdo7doCMXNtB3) for helping us implement our frontend calendar. + +Finally, we would also like to thank all of our amazing teammates for all of their hard work, dedication, and creativity for making this project possible. + back to top diff --git a/backend/src/controllers/AuthController.ts b/backend/src/controllers/AuthController.ts index 1a5fb82d..04208e6c 100644 --- a/backend/src/controllers/AuthController.ts +++ b/backend/src/controllers/AuthController.ts @@ -93,4 +93,64 @@ export default class AuthController { return res.status(500).json({ error: 'Something went wrong' }); } }; + + /** + * Delete account should delete all data entry with user_id matched + * @param req + * @param res + * @constructor + */ + public static async deleteAccount(req: Request, res: Response): Promise { + try { + const user_id = req.params.user_id; + const user = await prisma.users.findUniqueOrThrow({ + where: { + id: user_id, + }, + }); + + if (!user) { + return res.status(404).json({ error: 'User not found' }); + } + + // Delete their preferences + await prisma.user_preferences.deleteMany({ + where: { + user_id: user_id, + }, + }); + + // Delete their events + await prisma.user_events.deleteMany({ + where: { + user_id: user_id, + }, + }); + + // Delete their deadlines + await prisma.user_deadlines.deleteMany({ + where: { + user_id: user_id, + }, + }); + + // Delete the user instance + await prisma.users.deleteMany({ + where: { + id: user_id, + } + }); + + return res.status(201).json({ + user: { + id: user.id, + email: user.email, + }, + message: 'Deleted account successfully', + }); + } catch (error: any) { + console.error('Sign-in Error:', error); + return res.status(500).json({ error: error.message }); + } + } } diff --git a/backend/src/controllers/DeadlineController.ts b/backend/src/controllers/DeadlineController.ts index 1ca0cf95..90c820b6 100644 --- a/backend/src/controllers/DeadlineController.ts +++ b/backend/src/controllers/DeadlineController.ts @@ -10,13 +10,13 @@ export default class Deadline { */ public static async getUserDeadlines(req: Request, res: Response) { try { - // Finds all of the possible deadlines for each user + // Finds all the possible deadlines for each user const userDeadlines = await prisma.user_deadlines.findMany({ where: { user_id: req.params.user_id, }, }); - // Succuesfully is able to get all of the user's deadlines + // Successfully is able to get all the user's deadlines res.json(userDeadlines); } catch { // Unable to found the user's deadlines @@ -30,7 +30,7 @@ export default class Deadline { * * @param req.params.id - ID of the deadline */ - public static async getDeadlinebyId(req: Request, res: Response) { + public static async getDeadlineById(req: Request, res: Response) { try { // Finds the user's one deadline const deadline = await prisma.user_deadlines.findUniqueOrThrow({ @@ -38,7 +38,7 @@ export default class Deadline { id: req.params.id, }, }); - // Succuesfully is able to find the user's deadline + // Successfully is able to find the user's deadline res.json(deadline); } catch { // Unable to find the user's deadline @@ -53,7 +53,7 @@ export default class Deadline { */ public static async postDeadline(req: Request, res: Response) { try { - // Accesses all of the deadline variables in the request + // Accesses all the deadline variables in the request const values = Deadline.getUserDeadlineValues(req); // Creates a new deadline const result = await prisma.user_deadlines.create({ @@ -72,7 +72,7 @@ export default class Deadline { */ public static async putDeadline(req: Request, res: Response) { try { - // Accesses all of the deadline variables in the request + // Accesses all the deadline variables in the request const values = Deadline.getUserDeadlineValues(req); // Edits the current deadline const result = await prisma.user_deadlines.update({ @@ -98,7 +98,7 @@ export default class Deadline { id: req.params.id, }, }); - // Succuesfully deletes a deadline + // Successfully deletes a deadline res.json(deadline); } catch { // Unable to delete a deadline @@ -107,7 +107,7 @@ export default class Deadline { } /** - * Gets all of the values associated with a deadline from the request body + * Gets all the values associated with a deadline from the request body * (i.e. excluding id, since database generates id automatically) */ private static getUserDeadlineValues(req: Request) { diff --git a/backend/src/routes/auth.ts b/backend/src/routes/auth.ts index 2fc8bcbf..a592383f 100644 --- a/backend/src/routes/auth.ts +++ b/backend/src/routes/auth.ts @@ -7,7 +7,10 @@ const router = express.Router(); // Sign In route router.post('/signin', AuthController.signIn); -// Sign up route +// Sign Up route router.post('/signup', AuthController.signUp); +// Delete Account route +router.delete('/delete/:user_id', AuthController.deleteAccount); + export default router; diff --git a/backend/src/routes/calendar.ts b/backend/src/routes/calendar.ts index c2b30ce3..972fb95c 100644 --- a/backend/src/routes/calendar.ts +++ b/backend/src/routes/calendar.ts @@ -30,7 +30,7 @@ router.get('/deadlines/by-user/:user_id', DeadlineController.getUserDeadlines); router.post('/deadlines', DeadlineController.postDeadline); // Get a deadline by id -router.get('/deadlines/id/:id', DeadlineController.getDeadlinebyId); +router.get('/deadlines/id/:id', DeadlineController.getDeadlineById); // Modify a deadline router.put('/deadlines/id/:id', DeadlineController.putDeadline); diff --git a/docs/dev docs/contributing.md b/docs/dev docs/contributing.md new file mode 100644 index 00000000..febf0ffa --- /dev/null +++ b/docs/dev docs/contributing.md @@ -0,0 +1,62 @@ +# Contributing + +We welcome contributions! To get started: + +#### Step 1: Fork the Repository + +Click the **Fork** button in the top right corner of [this repo](https://github.com/StressLess-Team/StressLess/) to create your own copy under your GitHub account. + +#### Step 2: Clone Your Fork + +```bash +git clone https://github.com//StressLess.git +cd StressLess +``` + +#### Step 3: Set Up the Remote + +Set the original repository as the upstream remote to pull in future changes: + +```bash +git remote add upstream https://github.com/StressLess-Team/StressLess/ +git fetch upstream +``` + +#### Step 4: Create a New Branch + +Always work in a new branch for your feature or fix: + +```bash +git checkout -b feat/your-feature-name +``` + +#### Step 5: Make Changes Locally + +Edit the code, commit your changes: + +```bash +git add . +git commit -m "Add: brief description of what you changed" +``` + +Follow the [Prettier](docs/dev%20docs/typescript%20styling/prettier.md) and [ESLint](docs/dev%20docs/typescript%20styling/eslint.md) guidelines to ensure consistent formatting and styling. + +#### Step 6: Push to Your Fork + +```bash +git push origin your-feature-name +``` + +#### Step 7: Create a Pull Request + +* Go to your fork on GitHub. +* You’ll see a "Compare & pull request" button. Click it. +* Provide a clear description of what you’ve changed and why. +* Submit the pull request to the `development` branch of the original repository. + +> ✅ **Note**: Make sure your code passes all CI checks and has been tested locally before opening a PR. + +#### Step 8: Collaborate + +* A team member will review your PR and may request changes. +* Once approved, your changes will be merged! diff --git a/docs/dev docs/database/Database Schema Design.md b/docs/dev docs/database/Database Schema Design.md index 8d0c003c..fe85c9a7 100644 --- a/docs/dev docs/database/Database Schema Design.md +++ b/docs/dev docs/database/Database Schema Design.md @@ -2,7 +2,7 @@ [https://dbdiagram.io/d/StressLess-67cb5f29263d6cf9a0a32612](https://dbdiagram.io/d/StressLess-67cb5f29263d6cf9a0a32612) (We do not have PRO account so contact @Khanh Phuong Do to suggest edits) -![StressLess](https://github.com/user-attachments/assets/556ad34b-e19c-418d-b760-1c54152746c5) +![Schema](https://github.com/user-attachments/assets/c8572796-bc2d-4421-9197-c5c818eb2228) ## Design Entities @@ -22,8 +22,9 @@ Table users { id uuid [primary key] - username varchar + email varchar created_at timestamp + updated_at timestamp } Table preference_questions { @@ -53,6 +54,7 @@ Table user_events { is_generated boolean [default: false] break_time varchar created_at timestamp + deadline_id varchar } Table user_deadlines { @@ -64,7 +66,7 @@ Table user_deadlines { description text priority varchar(50) projected_duration integer - is_completed boolean [default: false] + is_completed bool [default: false] created_at timestamp } @@ -83,5 +85,5 @@ Ref: users.id < user_events.user_id // A user can have many events Ref: users.id < user_deadlines.user_id // A user can have many deadlines // Deadlines and Events (if applicable) -Ref: user_events.id < user_deadlines.event_id // An event can have an associated deadline +Ref: user_events.deadline_id < user_deadlines.id // An event can have an associated deadline ``` diff --git a/eslint.config.mjs b/eslint.config.mjs index 171a834f..c5ca6b34 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -30,6 +30,7 @@ export default [ clearInterval: "readonly", Notification: 'readonly', setTimeout: 'readonly', + alert: 'readonly', }, }, plugins: { diff --git a/frontend/src/components/ReauthenticateModal.tsx b/frontend/src/components/ReauthenticateModal.tsx new file mode 100644 index 00000000..dda90ea0 --- /dev/null +++ b/frontend/src/components/ReauthenticateModal.tsx @@ -0,0 +1,84 @@ +'use client'; + +import { useState } from 'react'; +import { EmailAuthProvider, reauthenticateWithCredential } from 'firebase/auth'; +import { useAuth } from '@/components/context/auth/AuthContext'; +import axios from 'axios'; +import { backendBaseUrl } from '@/lib/utils'; +import { Input } from '@/components/ui/input'; // assuming you're using shadcn/ui Input +import { Button } from '@/components/ui/button'; // shadcn/ui Button + +interface Props { + onSuccessAction: () => void; + onCancelAction: () => void; +} + +export default function ReauthenticateModal({ + onSuccessAction, + onCancelAction, +}: Props) { + const { user, deleteAccount } = useAuth(); + const [password, setPassword] = useState(''); + const [error, setError] = useState(''); + const [loading, setLoading] = useState(false); + + const handleReauthAndDelete = async () => { + if (!user || !user.email || !user.uid) { + setError('User not signed in or missing email.'); + return; + } + + setLoading(true); + setError(''); + const credential = EmailAuthProvider.credential(user.email, password); + + try { + await reauthenticateWithCredential(user, credential); + const res = await axios.delete( + `${backendBaseUrl}/api/auth/delete/${user.uid}` + ); + + if (res.status === 201 || res.status === 200) { + await deleteAccount(); + onSuccessAction(); + } else { + setError('Failed to delete user data from the backend.'); + } + } catch (err: unknown) { + console.error(err); + setError('Reauthentication failed. Please check your password.'); + } finally { + setLoading(false); + } + }; + + return ( +
+
+

+ Please re-enter your password to permanently delete your account. +

+ setPassword(e.target.value)} + disabled={loading} + /> +
+ {error &&

{error}

} +
+ + +
+
+ ); +} diff --git a/frontend/src/components/UserProfile.tsx b/frontend/src/components/UserProfile.tsx index 21ea3252..af45446c 100644 --- a/frontend/src/components/UserProfile.tsx +++ b/frontend/src/components/UserProfile.tsx @@ -9,6 +9,7 @@ import { DialogTitle, DialogTrigger, } from '@/components/ui/dialog'; +import ReauthenticateModal from './ReauthenticateModal'; import { UserPreferencesForm, formSchema } from './UserPreferencesForm'; import { useEffect, useState } from 'react'; import { z } from 'zod'; @@ -17,15 +18,18 @@ import axios from 'axios'; import { backendBaseUrl, formatTime } from '@/lib/utils'; import { getPreferenceExtractData } from '@/lib/get-preference-extract-data'; import { updateProfile } from 'firebase/auth'; +import { ExclamationTriangleIcon } from '@heroicons/react/20/solid'; export default function ProfilePage() { const { user, loading } = useAuth(); + const [showReauthModal, setShowReauthModal] = useState(false); // Using state to hold user preferences const [userPreferences, setUserPreferences] = useState | null>(null); // Using state to open page - const [open, setOpen] = useState(false); + const [openEdit, setOpenEdit] = useState(false); + const [openDelete, setOpenDelete] = useState(false); // Using state to set edit username const [editMode, setEditMode] = useState(false); // Using state to set display name @@ -33,6 +37,18 @@ export default function ProfilePage() { user?.displayName || 'Studious Student' ); + const handleDeleteClick = () => { + setShowReauthModal(true); + }; + + const handleCancel = () => { + setShowReauthModal(false); + }; + + const handleSuccess = () => { + alert('Account successfully deleted!'); + }; + // Fetch preferences when user is available useEffect(() => { const fetchPreferences = async () => { @@ -78,7 +94,7 @@ export default function ProfilePage() { if (JSON.stringify(values) === JSON.stringify(userPreferences)) { window.alert("You didn't make any changes!"); - setOpen(false); + setOpenEdit(false); return; } @@ -107,10 +123,29 @@ export default function ProfilePage() { }) .finally(() => { // Close the dialog after save - setOpen(false); + setOpenEdit(false); }); } + // const handleDeleteAccount = async () => { + // try { + // if (!user?.uid) return; + // + // // Delete user data from backend + // const res = await axios.delete( + // backendBaseUrl + `/api/auth/delete/${user.uid}` + // ); + // + // // Delete Firebase auth account + // if (res.status === 201) { + // await deleteAccount(); + // } + // } catch (err) { + // console.error('Failed to delete account:', err); + // alert('Failed to delete account. Please try again another time.'); + // } + // }; + if (loading || !userPreferences) { return
Loading...
; } @@ -197,7 +232,7 @@ export default function ProfilePage() { {/* Edit Button + Dialog */} - + + + {/* Delete Account Button */} + + + + + + +
+
+ Are you sure? + + This action cannot be undone. This will permanently delete + your account and remove your data. + +
+ {!showReauthModal && ( +
+ + +
+ )} + {showReauthModal && ( +
+ +
+ )} +
+
diff --git a/frontend/src/components/context/auth/AuthContext.tsx b/frontend/src/components/context/auth/AuthContext.tsx index f79a5354..c697c1bc 100644 --- a/frontend/src/components/context/auth/AuthContext.tsx +++ b/frontend/src/components/context/auth/AuthContext.tsx @@ -25,6 +25,7 @@ type AuthContextType = { displayName: string ) => Promise; forgotPassword: (email: string) => Promise; + deleteAccount: () => Promise<(() => void) | undefined>; }; const AuthContext = createContext(undefined); @@ -91,6 +92,32 @@ export const AuthProvider: React.FC = ({ children }) => { await sendPasswordResetEmail(firebaseAuth, email); }; + const deleteAccount = async () => { + if (!user) { + return () => { + console.log('User not found'); + }; + } + console.log( + 'Deleting user: ' + user.displayName + ' with uid: ' + user.uid + ); + await user + .delete() + .then(() => { + console.log('User deleted'); + setAllToNullAndFalse(); + }) + .catch((error: Error) => { + console.error(error); + }); + }; + + const setAllToNullAndFalse = () => { + setUser(null); + setLoading(false); + setVerified(false); + }; + return ( = ({ children }) => { signOut, signUp, forgotPassword, + deleteAccount, }} > {children}