diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/examples/debug-nopaths/spec.yaml b/examples/debug-nopaths/spec.yaml deleted file mode 100644 index cc95572..0000000 --- a/examples/debug-nopaths/spec.yaml +++ /dev/null @@ -1,15 +0,0 @@ -openapi: "3.0.0" -info: - version: 1.0.0 - title: Swagger Petstore - description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification - termsOfService: http://swagger.io/terms/ - contact: - name: Swagger API Team - email: apiteam@swagger.io - url: http://swagger.io - license: - name: Apache 2.0 - url: https://www.apache.org/licenses/LICENSE-2.0.html -servers: - - url: https://petstore.swagger.io/v2 diff --git a/package.json b/package.json index d83b144..2d7d6aa 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,11 @@ { - "name": "ProtoPI", + "name": "protopi", + "displayName": "ProtoPI", "description": "OpenAPI spec file parser/creator and mock server for VS Code", "version": "0.0.2", "publisher": "oslabs-beta", "repository": "https://github.com/oslabs-beta/ProtoPI", + "license": "GPL-3.0-only", "engines": { "vscode": "^1.89.0" }, @@ -81,6 +83,31 @@ "category": "ProtoPI", "title": "Open Extension Settings", "icon": "$(gear)" + }, + { + "command": "ProtoPI.runAllPrismMockServersLinearly", + "category": "ProtoPI", + "title": "Run All Mock Servers Linearly" + }, + { + "command": "ProtoPI.runAllPrismMockServersConcurrently", + "category": "ProtoPI", + "title": "Run All Mock Servers Concurrently" + }, + { + "command": "ProtoPI.stopAllPrismMockServersLinearly", + "category": "ProtoPI", + "title": "Shutdown All Mock Servers Linearly" + }, + { + "command": "ProtoPI.stopAllPrismMockServersConcurrently", + "category": "ProtoPI", + "title": "Shutdown All Mock Servers Concurrently" + }, + { + "command": "ProtoPI.listAllPrismMockServers", + "category": "ProtoPI", + "title": "List All Mock Servers" } ], "menus": { @@ -104,6 +131,31 @@ "command": "ProtoPI.openSettings", "when": "view == protopi-sidebar", "group": "z_settings" + }, + { + "command": "ProtoPI.runAllPrismMockServersLinearly", + "when": "view == protopi-sidebar", + "group": "1_prism" + }, + { + "command": "ProtoPI.runAllPrismMockServersConcurrently", + "when": "view == protopi-sidebar", + "group": "1_prism" + }, + { + "command": "ProtoPI.stopAllPrismMockServersLinearly", + "when": "view == protopi-sidebar", + "group": "1_prism" + }, + { + "command": "ProtoPI.stopAllPrismMockServersConcurrently", + "when": "view == protopi-sidebar", + "group": "1_prism" + }, + { + "command": "ProtoPI.listAllPrismMockServers", + "when": "view == protopi-sidebar", + "group": "navigation" } ] }, @@ -176,19 +228,20 @@ "rollup-plugin-postcss": "^4.0.2", "rollup-plugin-svelte": "^6", "rollup-plugin-svg": "^2.0.0", - "svelte": "^4.2.17", "svelte-check": "^3.8.0", "svelte-language-server": "^0.16.13", "svelte-preprocess": "^6.0.2", "tailwindcss": "^3.4.7", - "typescript": "^5.4.5", - "yaml": "^2.4.5" + "@babel/code-frame": "^7.24.7", + "typescript": "^5.4.5" }, "dependencies": { - "@babel/code-frame": "^7.24.7", - "@stoplight/prism-cli": "^5.8.1", + "svelte": "^4.2.17", + "yaml": "^2.4.5", + "@stoplight/prism-cli": "^5.8.3", "axios": "^1.7.2", "crypto-js": "^4.2.0", + "get-port": "^7.1.0", "github-markdown-css": "^5.6.1", "lodash.memoize": "^4.1.2", "marked": "^13.0.2", diff --git a/src/core/statusbar/StatusBarManager.ts b/src/core/statusbar/StatusBarManager.ts deleted file mode 100644 index ff703df..0000000 --- a/src/core/statusbar/StatusBarManager.ts +++ /dev/null @@ -1,29 +0,0 @@ -import * as vscode from 'vscode'; - -export class StatusBarManager { - private statusBarItem: vscode.StatusBarItem; - - constructor() { - this.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100); - this.updateStatusBarItem(`$(gear~spin) Start Mock Server`, "ProtoPI.runPrismMock", "Click to start Mock Server"); - } - - private updateStatusBarItem(text: string, command: string, tooltip: string): void { - this.statusBarItem.text = text; - this.statusBarItem.command = command; - this.statusBarItem.tooltip = tooltip; - this.statusBarItem.show(); - } - - public updateForRunningServer(): void { - this.updateStatusBarItem(`$(stop) Stop Mock Server`, "ProtoPI.stopPrismMock", "Click to stop Mock Server"); - } - - public updateForStoppedServer(): void { - this.updateStatusBarItem(`$(gear~spin) Start Mock Server`, "ProtoPI.runPrismMock", "Click to start Mock Server"); - } - - public dispose(): void { - this.statusBarItem.dispose(); - } -} diff --git a/src/core/subscriptions/commands/index.ts b/src/core/subscriptions/commands/index.ts new file mode 100644 index 0000000..447d95a --- /dev/null +++ b/src/core/subscriptions/commands/index.ts @@ -0,0 +1,14 @@ +import * as vscode from 'vscode'; +import { registerMockServerCommands } from './mockServerCommands'; +import { registerWebviewCommands } from './webviewCommands'; +import { registerSpecFileCommands } from './specFileCommands'; +import { registerSettingsCommands } from './settingsCommands'; +import { Sidebar } from '../../../views/Sidebar'; +import { StatusBarManager } from '../managers/StatusBarManager'; + +export function registerAllCommands(context: vscode.ExtensionContext, sidebar: Sidebar, statusBarManager: StatusBarManager) { + registerMockServerCommands(context, statusBarManager); + registerSpecFileCommands(context); + registerWebviewCommands(context, sidebar); + registerSettingsCommands(context); +} diff --git a/src/core/subscriptions/commands/mockServerCommands.ts b/src/core/subscriptions/commands/mockServerCommands.ts new file mode 100644 index 0000000..71d63d2 --- /dev/null +++ b/src/core/subscriptions/commands/mockServerCommands.ts @@ -0,0 +1,113 @@ +import * as vscode from 'vscode'; +import * as path from 'path'; +import { MockServerManager } from '../managers/MockServerManager'; +import { StatusBarManager } from '../managers/StatusBarManager'; +import { updateOpenAPIFiles } from '../utils/parseWorkspace'; +import { getServerPort } from '../utils/prismConfig'; + +export function registerMockServerCommands(context: vscode.ExtensionContext, statusBarManager: StatusBarManager) { + const serverManager = new MockServerManager(statusBarManager); + + context.subscriptions.push( + // Run a specific Prism mock server + vscode.commands.registerCommand("ProtoPI.runPrismMock", async () => { + const files = await updateOpenAPIFiles(context); + if (files.length === 0) { + vscode.window.showErrorMessage("No API specification files found."); + return; + } + + // Optionally let the user pick a file to mock + const pickItems = files.map(file => ({ + label: path.basename(file.fsPath), + description: file.fsPath, + file + })); + + const pickedFile = await vscode.window.showQuickPick(pickItems, { + placeHolder: 'Select an API specification file to mock', + }); + + if (pickedFile) { + const port = await getServerPort(); + serverManager.startServer(port, pickedFile.file); + } else { + vscode.window.showErrorMessage("No file selected"); + } + }), + + // Stop a specific running server + vscode.commands.registerCommand("ProtoPI.runPrismMockAll", async () => { + const files = await updateOpenAPIFiles(context); + if (files.length === 0) { + vscode.window.showErrorMessage("No API specification files found."); + return; + } + files.forEach(async file => { + const port = await getServerPort(); + serverManager.startServer(port, file); + }); + }), + + vscode.commands.registerCommand("ProtoPI.stopPrismMock", async () => { + const runningServers = serverManager.getRunningServers(); + if (runningServers.length === 0) { + vscode.window.showErrorMessage("No server is currently running."); + return; + } + + const pickItems = runningServers.map(({ port }) => ({ + label: `Server on port ${port}`, + port + })); + + const pickedServer = await vscode.window.showQuickPick(pickItems, { + placeHolder: 'Select a server to stop', + }); + + if (pickedServer) { + const port = pickedServer.port; + await serverManager.stopServer(port); + } else { + vscode.window.showErrorMessage("No server selected"); + } + }), + + // Run all servers linearly + vscode.commands.registerCommand("ProtoPI.runAllPrismMockServersLinearly", async () => { + const files = await updateOpenAPIFiles(context); + if (files.length === 0) { + vscode.window.showErrorMessage("No API specification files found."); + return; + } + await serverManager.startServersLinearly(files); + }), + + // Run all servers concurrently + vscode.commands.registerCommand("ProtoPI.runAllPrismMockServersConcurrently", async () => { + const files = await updateOpenAPIFiles(context); + if (files.length === 0) { + vscode.window.showErrorMessage("No API specification files found."); + return; + } + await serverManager.startServersConcurrently(files); + }), + + // Stop all servers linearly + vscode.commands.registerCommand("ProtoPI.stopAllPrismMockServersLinearly", async () => { + await serverManager.stopAllServersLinearly(); + }), + + // Stop all servers concurrently + vscode.commands.registerCommand("ProtoPI.stopAllPrismMockServersConcurrently", async () => { + await serverManager.stopAllServersConcurrently(); + }), + + // Print to console the status of servers + vscode.commands.registerCommand("ProtoPI.listAllPrismMockServers", async () => { + console.log("Listing all Prism Mock Servers:"); + serverManager.logServerStatus(); + }), + + ); +} \ No newline at end of file diff --git a/src/core/subscriptions/commands/settingsCommands.ts b/src/core/subscriptions/commands/settingsCommands.ts new file mode 100644 index 0000000..392e50a --- /dev/null +++ b/src/core/subscriptions/commands/settingsCommands.ts @@ -0,0 +1,9 @@ +import * as vscode from "vscode"; + +export function registerSettingsCommands(context: vscode.ExtensionContext) { + context.subscriptions.push( + vscode.commands.registerCommand("ProtoPI.openSettings", () => { + vscode.commands.executeCommand("workbench.action.openSettings", "protopi"); + }) + ); +} \ No newline at end of file diff --git a/src/core/subscriptions/commands/specFileCommands.ts b/src/core/subscriptions/commands/specFileCommands.ts new file mode 100644 index 0000000..ef78756 --- /dev/null +++ b/src/core/subscriptions/commands/specFileCommands.ts @@ -0,0 +1,45 @@ +import * as vscode from "vscode"; +import { findSpecFiles, groupFilesByDirectory } from '../utils/parseWorkspace'; + +export function registerSpecFileCommands(context: vscode.ExtensionContext) { + context.subscriptions.push( + + // Parses workspace to display available API Specifications and their directories + vscode.commands.registerCommand("ProtoPI.findSpecFiles", async () => { + const files = await findSpecFiles(); + vscode.window.showInformationMessage(`Files found: ${files.length}`); + + const dirTree = groupFilesByDirectory(files); + vscode.window.showInformationMessage(`Directory tree: ${JSON.stringify(dirTree)}`); + }), + + vscode.commands.registerCommand("ProtoPI.openAPIFile", async () => { + const files = await findSpecFiles(); + const fileItems = files.map(file => ({ + label: vscode.workspace.asRelativePath(file), + description: file.fsPath, + file: file, + })); + + const selectedFile = await vscode.window.showQuickPick(fileItems, { + placeHolder: "Select an API file", + }); + + if (!selectedFile) { + vscode.window.showErrorMessage("No file selected"); + return; + } + + const content = await vscode.workspace.fs.readFile(selectedFile.file); + // TODO: some mechanism or webview to display the content + vscode.window.showTextDocument(selectedFile.file); + vscode.window.showInformationMessage(`Opened file: ${selectedFile.label}`); + }), + + vscode.commands.registerCommand("ProtoPI.closeAPIFile", () => { + // TODO: a specific way you handle the closing of files, perhaps through a webview + // This might be a simple notification or some clean-up task + vscode.window.showInformationMessage("API file closed"); + }) + ); +} \ No newline at end of file diff --git a/src/core/subscriptions/commands/webviewCommands.ts b/src/core/subscriptions/commands/webviewCommands.ts new file mode 100644 index 0000000..6f12e3f --- /dev/null +++ b/src/core/subscriptions/commands/webviewCommands.ts @@ -0,0 +1,29 @@ +import * as vscode from "vscode"; +import { Workshop } from "../../../views/Workshop"; // Adjust path as necessary +import { Sidebar } from "../../../views/Sidebar"; // Adjust path as necessary + +export function registerWebviewCommands(context: vscode.ExtensionContext, sidebar: Sidebar) { + context.subscriptions.push( + // Open Workshop Webview + vscode.commands.registerCommand("ProtoPI.workShop.start", () => { + Workshop.createOrShow(context.extensionUri); + }), + + // Refresh Workshop Webview + vscode.commands.registerCommand("ProtoPI.workShop.refresh", () => { + Workshop.kill(); + Workshop.createOrShow(context.extensionUri); + // setTimeout(() => { + // vscode.commands.executeCommand( + // "workbench.action.webview.openDeveloperTools" + // ); + // }, 500); + }), + + // Reload Side Panel Webview + vscode.commands.registerCommand("ProtoPI.refresh", async () => { + await vscode.commands.executeCommand("workbench.action.closeSidebar"); + await vscode.commands.executeCommand("workbench.view.extension.protopi-sidebar-view"); + }) + ); +} \ No newline at end of file diff --git a/src/core/subscriptions/managers/MockServerManager/index.ts b/src/core/subscriptions/managers/MockServerManager/index.ts new file mode 100644 index 0000000..6753dc1 --- /dev/null +++ b/src/core/subscriptions/managers/MockServerManager/index.ts @@ -0,0 +1,266 @@ +import * as vscode from 'vscode'; +import { spawn, ChildProcess } from 'child_process'; +import * as path from 'path'; +import { terminate } from './../../utils/terminate'; +import { StatusBarManager } from './../StatusBarManager'; +import { getPrismPath, getServerPort } from './../../utils/prismConfig'; +import { getTimestamp } from './../../utils/timeUtils'; + +interface ServerInfo { + process: ChildProcess; + file: string; // Full path of the file + filename: string; // Filename + status: string; +} +export class MockServerManager { + private servers: Map = new Map(); + + constructor(private statusBarManager: StatusBarManager) {} + + public async startServer(port: number, fileUri: vscode.Uri): Promise { + const file = fileUri.fsPath; + const filename = path.basename(file); + + if (this.servers.has(port)) { + vscode.window.showInformationMessage(`Server on port ${port} is already running!`); + this.updateServerStatus(port, 'Already Running', file, filename); + return; + } + + const prismPath = getPrismPath(); + + // Create prism mock command + // @TODO: --no-deprecation TURNS OFF an error for "punycode". + // This is from ES LINT which needs to be ugpraded to get rid of it. + // Errors are: + + // Error starting Prism: (node:84449) [DEP0040] DeprecationWarning: + // The punycode module is deprecated. Please use a userland alternative + // instead. (Use node --trace-deprecation ... to show where the warning + // was created) + + // Error starting Prism: (node:84865) [DEP0040] DeprecationWarning: + // The punycode module is deprecated. Please use a userland alternative + // instead. (Use node --trace-deprecation ... to show where the warning + // was created) + + // NOTE: Since the --no-deprecation flag is a Node.js runtime option and + // not an argument for the prism CLI, it cannot be used directly in the + // prism command we run the Node.js process with the --no-deprecation flag. + + // Including the --no-deprecation flag to suppress deprecation warnings + const prismArgs = ["--no-deprecation", prismPath, "mock", "-d", file, "--port", port.toString()]; + + const process = spawn("node", prismArgs, { shell: false }); + process.on('error', (err) => { + console.group(`[${getTimestamp()}] Failed to start server on port ${port}`); + console.error(`File: ${file}`); + console.error(`Error:`, err); + console.error(`Stack Trace:`, err.stack); + console.error(`Error Message: ${err.message}`); + console.groupEnd(); + vscode.window.showErrorMessage(`Failed to start server on port ${port}: ${filename}`); + this.updateServerStatus(port, `Failed: ${err.message}`, file, filename); + }); + + process.stderr.on('data', (data) => { + console.group(`[${getTimestamp()}] Error on server port ${port}`); + console.error(`File: ${file}`); + console.error(`Error Data:`, data.toString()); + console.groupEnd(); + vscode.window.showErrorMessage(`Error on server port ${port}: ${filename}`); + }); + + this.servers.set(port, { process, file, filename, status: 'Running' }); + + // Handle the server process (setting up stdout, stderr, and process event listeners) + this.handleServerProcess(port, process); + + // Update the status bar to reflect that the server is now running + console.group(`[${getTimestamp()}] Starting server on port ${port}`); + console.log(`File: ${file}`); + console.log(`Filename: ${filename}`); + console.groupEnd(); + + this.statusBarManager.updateForRunningServer(); + } + + public async stopServer(port: number): Promise { + const serverInfo = this.servers.get(port); + + if (!serverInfo) { + vscode.window.showInformationMessage(`Server on port ${port} is not running.`); + return; + } + + if (serverInfo && serverInfo.process.pid) { + this.statusBarManager.updateForAttemptingShutdown(); + console.log(`[${getTimestamp()}] Attempting graceful shutdown for server on port ${port}`); + try { + + // Attempt to gracefully terminate the server process + await terminate({ processId: serverInfo.process.pid, port}, 10000, 1500); + this.updateServerStatus(port, 'Stopped', serverInfo.file, serverInfo.filename); + + this.servers.delete(port); // Remove the server from the map upon successful termination + console.log(`[${getTimestamp()}] Server on port ${port} stopped successfully.`); + vscode.window.showInformationMessage(`Server on port ${port} stopped successfully.`); + this.statusBarManager.updateForStoppedServer(); + } catch (error: unknown) { + // Handle errors during termination + this.handleTerminationError(port, error); + } finally { + this.logServerStatus(); // Log the current status of all servers after attempting to stop + } + } else { + vscode.window.showErrorMessage(`Server on port ${port} does not have an active process.`); + this.servers.delete(port); // Remove the server if no process is associated with it + this.logServerStatus(); + } +} + + public async startServersLinearly(files: vscode.Uri[]): Promise { + for (const file of files) { + const port = await getServerPort(); + await this.startServer(port, file); + } + this.logServerStatus(); + } + + public async startServersConcurrently(files: vscode.Uri[]): Promise { + await Promise.all(files.map(async file => { + const port = await getServerPort(); + await this.startServer(port, file); + })); + this.logServerStatus(); + } + + public async stopAllServersLinearly(): Promise { + this.statusBarManager.updateForAttemptingShutdown(); + const runningServers = Array.from(this.servers.keys()); + for (const port of runningServers) { + await this.stopServer(port); + console.log(`Server on port ${port} stopped linearly.`); + } + this.statusBarManager.updateForStoppedServer(); + this.logServerStatus(); + } + + public async stopAllServersConcurrently(): Promise { + this.statusBarManager.updateForAttemptingShutdown(); + const runningServers = Array.from(this.servers.keys()); + await Promise.all(runningServers.map(port => this.stopServer(port))); + console.log('All servers stopped concurrently.'); + this.statusBarManager.updateForStoppedServer(); + this.logServerStatus(); + } + + private handleServerProcess(port: number, process: ChildProcess): void { + if ( process.stdout ){ + process.stdout.on("data", data => { + console.log(`[${getTimestamp()}] [port ${port}] stdout: ${data}`); + if (data.includes("Prism is listening")) { + this.statusBarManager.updateForRunningServer(); + } + }); + } + + if ( process.stderr ){ + process.stderr.on("data", data => { + console.log(`[${getTimestamp()}] [port ${port}] stderr: ${data}`); + vscode.window.showErrorMessage(`[port ${port}] stderr: ${data}`); + this.statusBarManager.updateForStoppedServer(); + }); + } + + process.on("close", code => { + const serverInfo = this.servers.get(port); + if (serverInfo) { + this.updateServerStatus(port, `Closed with code: ${code}`, serverInfo.file, serverInfo.filename); + this.servers.delete(port); + } + + console.log(`[${getTimestamp()}] Server on port ${port} closed with code: ${code}`); + this.statusBarManager.updateForStoppedServer(); + }); + + process.on("error", error => { + const serverInfo = this.servers.get(port); + if (serverInfo) { + this.updateServerStatus(port, `Error: ${error.message}`, serverInfo.file, serverInfo.filename); + this.servers.delete(port); + } + console.log(`[${getTimestamp()}] Server on port ${port} encountered an error: ${error.message}`); + vscode.window.showErrorMessage(`[port ${port}] Prism process error: ${error.message}`); + this.statusBarManager.updateForStoppedServer(); + }); + + this.statusBarManager.updateForRunningServer(); + } + + private handleTerminationError(port: number, error: unknown): void { + const serverInfo = this.servers.get(port); + if (error instanceof Error && error.message.includes('forcefully')) { + this.statusBarManager.updateForPerformingSIGKILL(); + console.log(`[${getTimestamp()}] Performing SIGKILL for server on port ${port}`); + try { + if (serverInfo && serverInfo.process.pid) { + process.kill(serverInfo.process.pid, 'SIGKILL'); + this.updateServerStatus(port, 'Terminated with SIGKILL', serverInfo.file, serverInfo.filename); + this.servers.delete(port); + + console.log(`[${getTimestamp()}] Server on port ${port} terminated with SIGKILL.`); + vscode.window.showInformationMessage(`Server on port ${port} terminated with SIGKILL.`); + this.statusBarManager.updateForStoppedServer(); + } + } catch (sigkillError: unknown) { + this.handleUnknownError(port, sigkillError); + } + } else if (error instanceof Error) { + console.log(`[${getTimestamp()}] Failed to stop server on port ${port}: ${error.message}`); + vscode.window.showErrorMessage(`Failed to stop server on port ${port}: ${error.message}`); + this.statusBarManager.updateForStoppedServer(); + this.updateServerStatus(port, `Failed to stop: ${error.message}`, serverInfo.file, serverInfo.filename); + } else { + this.handleUnknownError(port, error); + } + this.logServerStatus(); + } + + private handleUnknownError(port: number, error: unknown): void { + console.log(`[${getTimestamp()}] Failed to stop server on port ${port}: An unknown error occurred`); + vscode.window.showErrorMessage(`Failed to stop server on port ${port}: An unknown error occurred`); + this.statusBarManager.updateForStoppedServer(); + const serverInfo = this.servers.get(port); + this.updateServerStatus(port, 'Unknown error', serverInfo.file, serverInfo.filename); + this.logServerStatus(); + } + + private updateServerStatus(port: number, status: string, file: string, filename: string): void { + const serverInfo = this.servers.get(port); + if (serverInfo) { + serverInfo.status = status; + } else { + // Correctly handle missing serverInfo scenarios + this.servers.set(port, { process: null!, file, filename, status }); + } + } + + public logServerStatus(): void { + if (this.servers.size === 0) { + console.log("No servers are currently running."); + return; + } + + const statusArray = Array.from(this.servers.entries()).map(([port, info]) => ({ + file: info.file, + port, + status: info.status + })); + console.table(statusArray); + } + + public getRunningServers(): Array<{ port: number }> { + return Array.from(this.servers.keys()).map(port => ({port})); + } +} \ No newline at end of file diff --git a/src/core/subscriptions/managers/StatusBarManager/index.ts b/src/core/subscriptions/managers/StatusBarManager/index.ts new file mode 100644 index 0000000..2ac8386 --- /dev/null +++ b/src/core/subscriptions/managers/StatusBarManager/index.ts @@ -0,0 +1,64 @@ +import * as vscode from 'vscode'; + +export class StatusBarManager { + private statusBarItem: vscode.StatusBarItem; + private statusConfig: {[key: string]: {text: string, command?: string, tooltip: string}}; + + constructor() { + this.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100); + this.statusConfig = { + 'stopped': { + text: `$(gear~spin) Start Mock Server`, + command: "ProtoPI.runPrismMock", + tooltip: "Click to start Mock Server" + }, + 'running': { + text: `$(stop) Stop Mock Server`, + command: "ProtoPI.stopPrismMock", + tooltip: "Click to stop Mock Server" + }, + 'attemptingShutdown': { + text: `$(sync~spin) Attempting Graceful Shutdown`, + tooltip: "Attempting graceful shutdown" + }, + 'performingSIGKILL': { + text: `$(sync~spin) Performing a SIGKILL`, + tooltip: "Performing a SIGKILL" + } + }; + this.updateStatusBarItem('stopped'); + } + + private updateStatusBarItem(state: 'stopped' | 'running' | 'attemptingShutdown' | 'performingSIGKILL'): void { + const config = this.statusConfig[state]; + this.statusBarItem.text = config.text; + if (config.command) { + this.statusBarItem.command = config.command; + } else { + this.statusBarItem.command = undefined; + } + this.statusBarItem.tooltip = config.tooltip; + this.statusBarItem.show(); + console.log(`Status bar updated to: ${state}`); + } + + public updateForRunningServer(): void { + this.updateStatusBarItem('running'); + } + + public updateForStoppedServer(): void { + this.updateStatusBarItem('stopped'); + } + + public updateForAttemptingShutdown(): void { + this.updateStatusBarItem('attemptingShutdown'); + } + + public updateForPerformingSIGKILL(): void { + this.updateStatusBarItem('performingSIGKILL'); + } + + public dispose(): void { + this.statusBarItem.dispose(); + } +} \ No newline at end of file diff --git a/src/core/subscriptions/subscriptions.ts b/src/core/subscriptions/subscriptions.ts deleted file mode 100644 index 19c9978..0000000 --- a/src/core/subscriptions/subscriptions.ts +++ /dev/null @@ -1,297 +0,0 @@ -import * as vscode from "vscode"; -import { exec, spawn, ChildProcess } from "child_process"; -import * as path from "path"; -import terminate from "terminate"; - -import { postMessageToWebview } from "../router/outboundMailer"; -import { findSpecFiles, groupFilesByDirectory } from "../../parseWorkspace"; -import { Workshop } from "../../Workshop"; -import { Sidebar } from "../../Sidebar"; -import { StatusBarManager } from '../statusbar/StatusBarManager'; - -const config = vscode.workspace.getConfiguration("protopi"); -const prismPath = path.join(__dirname, "..", "node_modules", ".bin", "prism"); -const prismPort: number = config.get("mockServer.port") ?? 3141; -export let mockServer: ChildProcess | null = null; - -export function loadSubscriptions( - context: vscode.ExtensionContext, - sidebar: Sidebar, - statusBarManager: StatusBarManager, -) { - // Initialization of commands and UI elements - initializeCommands(context, sidebar, statusBarManager); -} - -function initializeCommands( - context: vscode.ExtensionContext, - sidebar: Sidebar, - statusBarManager: StatusBarManager, -){ - context.subscriptions.push( - vscode.commands.registerCommand("ProtoPI.runPrismMock", async () => { - if (mockServer) { - vscode.window.showInformationMessage("Server is already running!"); - return; - } - - - // Store all possible API Spec Files - const files = (await context.workspaceState.get( - "openAPIFiles" - )) as vscode.Uri[]; - - // Map files for quick selection - const fileItems = files.map((file) => ({ - label: vscode.workspace.asRelativePath(file), - description: file.fsPath, - file: file, - })); - - // Prompt user for input - const selectedFile = await vscode.window.showQuickPick(fileItems, { - placeHolder: "Select a file to mock", - }); - - if (selectedFile) { - // Create prism mock command - // @TODO: --no-deprecation TURNS OFF an error for "punycode". - // This is from ES LINT which needs to be ugpraded to get rid of it. - // Errors are: - - // Error starting Prism: (node:84449) [DEP0040] DeprecationWarning: - // The punycode module is deprecated. Please use a userland alternative - // instead. (Use node --trace-deprecation ... to show where the warning - // was created) - - // Error starting Prism: (node:84865) [DEP0040] DeprecationWarning: - // The punycode module is deprecated. Please use a userland alternative - // instead. (Use node --trace-deprecation ... to show where the warning - // was created) - - // NOTE: Since the --no-deprecation flag is a Node.js runtime option and - // not an argument for the prism CLI, it cannot be used directly in the - // prism command we run the Node.js process with the --no-deprecation flag. - - const prismArgs = [ - prismPath, - "mock", - "-d", - selectedFile.file.fsPath, - "--port", - prismPort.toString() - ]; - - mockServer = spawn("node", ["--no-deprecation", ...prismArgs]); - - if (mockServer.stdout) { - mockServer.stdout.on("data", (data) => { - console.log(`stdout: ${data}`); - }); - } - - if (mockServer.stderr) { - mockServer.stderr.on("data", (data) => { - if (data.includes('[DEP0040]')) { - console.warn(`Warning: Deprecated module used - ${data}`); - } else { - vscode.window.showErrorMessage(`Error starting Prism: ${data}`); - } - }); - } - - mockServer.on("close", (code) => { - console.log(`Prism process exited with code ${code}`); - if (code !== 0 && code !== null) { - vscode.window.showErrorMessage(`Prism process exited with code ${code}`); - } - mockServer = null; - }); - - mockServer.on("error", (error) => { - console.error(`Prism process error: ${error.message}`); - vscode.window.showErrorMessage(`Prism process error: ${error.message}`); - mockServer = null; - }); - - statusBarManager.updateForRunningServer(); - - } else { - vscode.window.showErrorMessage("No file selected"); - } - }), - - // Stops currently running mock server - not working currently - vscode.commands.registerCommand("ProtoPI.stopPrismMock", async () => { - if (!mockServer) { - vscode.window.showInformationMessage("No server is running"); - return; - } - - if (mockServer.pid) { - terminate(mockServer.pid, (err: any) => { - if (err) { - console.error(`Error killing mock server process:`, err); - vscode.window.showErrorMessage("Error killing mock server process"); - } else { - mockServer = null; - vscode.window.showInformationMessage("Mock server is stopped"); - statusBarManager.updateForStoppedServer(); - // update status bar item: - // statusBarItem.text = `$(gear~spin) Start Mock Server`; - // statusBarItem.tooltip = "Click to start mock server"; - // statusBarItem.command = "ProtoPI.runPrismMock"; - - // statusBarItem.show(); - } - }); - } else { - vscode.window.showErrorMessage("Mock server PID is not defined"); - } - }), - - // Parses workspace to display available API Specifications and their directories - vscode.commands.registerCommand("ProtoPI.findSpecFiles", async () => { - const files = await findSpecFiles(); - vscode.window.showInformationMessage(`Files found: ${files.length}`); - - const dirTree = groupFilesByDirectory(files); - vscode.window.showInformationMessage(`Directory tree: ${JSON.stringify(dirTree)}`); - }), - - // Open Workshop Webview - vscode.commands.registerCommand("ProtoPI.workShop.start", () => { - Workshop.createOrShow(context.extensionUri); - }), - - // Refresh Workshop Webview - vscode.commands.registerCommand("ProtoPI.workShop.refresh", () => { - Workshop.kill(); - Workshop.createOrShow(context.extensionUri); - // setTimeout(() => { - // vscode.commands.executeCommand( - // "workbench.action.webview.openDeveloperTools" - // ); - // }, 500); - }), - - // Reload Side Panel Webview - vscode.commands.registerCommand("ProtoPI.refresh", async () => { - await vscode.commands.executeCommand("workbench.action.closeSidebar"); - await vscode.commands.executeCommand("workbench.view.extension.protopi-sidebar-view"); - }), - - vscode.commands.registerCommand("ProtoPI.openFile", () => openFilePanel(context)), - - vscode.commands.registerCommand("ProtoPI.openAPIFile", async () => { - await openAPIFile(context, sidebar); - }), - - vscode.commands.registerCommand("ProtoPI.closeAPIFile", () => { - if (sidebar._view?.webview) { - postMessageToWebview(sidebar._view.webview, { type: "closeFile" }); - vscode.window.showInformationMessage("API file closed"); - } - }), - - vscode.commands.registerCommand("ProtoPI.openSettings", () => { - vscode.commands.executeCommand("workbench.action.openSettings", "protopi"); - }) - ); -} - -async function openFilePanel(context: vscode.ExtensionContext) { - const panel = vscode.window.createWebviewPanel( - "webview", - "Webview", - vscode.ViewColumn.One, - { - enableScripts: true, - } - ); - - panel.webview.onDidReceiveMessage( - (message) => { - if (message.command === "openFile") { - vscode.window - .showOpenDialog({ canSelectMany: false }) - .then((fileUri) => { - if (fileUri && fileUri[0]) { - vscode.workspace.fs - .readFile(fileUri[0]) - .then((fileContent) => { - panel.webview.postMessage({ - command: "fileContent", - content: fileContent.toString(), - }); - }); - } - }); - } - }, - undefined, - context.subscriptions - ); -} - - async function openAPIFile(context: vscode.ExtensionContext, sidebar: Sidebar) { - console.log("Opening API File"); - const files = await findSpecFiles(); - - const fileItems = files.map(file => ({ - label: vscode.workspace.asRelativePath(file), - description: file.fsPath, - file: file, - })); - - const selectedFile = await vscode.window.showQuickPick(fileItems, { - placeHolder: "Select an API file", - }); - - if (selectedFile) { - const content = await vscode.workspace.fs.readFile(selectedFile.file); - - if (sidebar._view?.webview) { - - postMessageToWebview(sidebar._view.webview, { - type: "fileContent", - content: content.toString(), - }); - vscode.window.showInformationMessage(`Opened file: ${selectedFile.label}`); - } - - // console.log(`Opened file: ${selectedFile.label}`); - // vscode.window.showInformationMessage( - // `Opened file: ${selectedFile.label}` - // ); - } else { - vscode.window.showErrorMessage("No file selected"); - } - }; - -// context.subscriptions.push( -// vscode.commands.registerCommand("ProtoPI.closeAPIFile", () => { -// console.log("Closing API File"); - -// if (sidebar._view?.webview) { - -// postMessageToWebview(sidebar._view.webview, { -// type: "closeFile", -// }); - -// } - -// vscode.window.showInformationMessage("API file closed"); -// }) -// ); - -// // Open Extension Settings -// context.subscriptions.push( -// vscode.commands.registerCommand("ProtoPI.openSettings", () => { -// vscode.commands.executeCommand( -// "workbench.action.openSettings", -// "protopi" -// ); -// }) -// ); -// } \ No newline at end of file diff --git a/src/parseWorkspace.ts b/src/core/subscriptions/utils/parseWorkspace.ts similarity index 97% rename from src/parseWorkspace.ts rename to src/core/subscriptions/utils/parseWorkspace.ts index 4f505f4..45f0ec6 100644 --- a/src/parseWorkspace.ts +++ b/src/core/subscriptions/utils/parseWorkspace.ts @@ -12,7 +12,7 @@ export interface SpecTreeDirectory { } export async function findSpecFiles(): Promise { - const glob = "**/*.yaml"; + const glob = "**/*.{yaml,yml}"; const files = await vscode.workspace.findFiles(glob, "**/node_modules/**"); return files; } diff --git a/src/core/subscriptions/utils/prismConfig.ts b/src/core/subscriptions/utils/prismConfig.ts new file mode 100644 index 0000000..31bc0bd --- /dev/null +++ b/src/core/subscriptions/utils/prismConfig.ts @@ -0,0 +1,17 @@ +import * as vscode from "vscode"; + +export async function getServerPort(): Promise { + const config = vscode.workspace.getConfiguration("protopi"); + const startPort = config.get("mockServer.port") ?? 4010; + + // Dynamic import for get-port + const { default: getPort } = await import('get-port'); + + // Creating a range of ports manually + const port = await getPort({ port: Array.from({ length: 100 }, (_, i) => startPort + i) }); + return port; +} + +export function getPrismPath(): string { + return require.resolve('@stoplight/prism-cli'); +} \ No newline at end of file diff --git a/src/core/subscriptions/utils/terminate.ts b/src/core/subscriptions/utils/terminate.ts new file mode 100644 index 0000000..db3075a --- /dev/null +++ b/src/core/subscriptions/utils/terminate.ts @@ -0,0 +1,88 @@ +import { exec } from "child_process"; +import { getTimestamp } from './timeUtils'; + +interface TerminateParams { + processId: number; + port?: number; + filename?: string; +} + +// Stops currently running mock server +export async function terminate( + { processId, port = 0, filename = 'default.type'}: TerminateParams, + timeout: number = 10000, + delay: number = 1500 +): Promise { + + console.groupCollapsed(`[${getTimestamp()}] Termination of process: ${processId} on port: ${port}.`); + + let processTerminated = false; + console.log(`File: ${filename}`); + console.log(`[${getTimestamp()}] Attempting to gracefully terminate process ${processId}`); + + try { + // Start by sending SIGTERM + await execPromise(`kill ${processId}`); + console.log(`[${getTimestamp()}] Sent SIGTERM to process ${processId}`); + + // Wait for the process to exit + await new Promise((resolve, reject) => { + const checkAlive = setInterval(async () => { + try { + // Check if the process is still alive + await execPromise(`kill -0 ${processId}`); + console.log(`[${getTimestamp()}] Process ${processId} is still running`); + + } catch (error: unknown) { + // Process is not alive anymore, resolve the promise + clearInterval(checkAlive); + processTerminated = true; + console.log(`[${getTimestamp()}] Process ${processId} has terminated`); + resolve(); + } + }, 1000); + + // Timeout if process does not exit in specified time + setTimeout(() => { + clearInterval(checkAlive); + + if (!processTerminated) { + console.log(`[${getTimestamp()}] Process ${processId} did not terminate in time`); + reject(new Error('Process did not exit in time and will be killed forcefully.')); + } + + }, timeout); + }); + } catch (error: unknown) { + if (error instanceof Error && error.message.includes('not exit in time')) { + console.log(`[${getTimestamp()}] Waiting for delay before forceful termination: ${delay}ms`); + await new Promise(resolve => setTimeout(resolve, delay)); + + // If the process did not terminate, send SIGKILL + console.log(`[${getTimestamp()}] Forcefully terminating process ${processId}`); + await execPromise(`kill -9 ${processId}`); + console.log(`[${getTimestamp()}] Sent SIGKILL to process ${processId}`); + + } else if (error instanceof Error) { + console.log(`[${getTimestamp()}] Failed to kill process ${processId}: ${error.message}`); + throw new Error(`Failed to kill process: ${error.message}`); + } else { + console.log(`[${getTimestamp()}] Failed to kill process ${processId}: An unknown error occurred`); + throw new Error('Failed to kill process: An unknown error occurred'); + } + } finally { + console.groupEnd(); + } +} + +function execPromise(command: string): Promise { + return new Promise((resolve, reject) => { + exec(command, (error) => { + if (error) { + reject(error); + } else { + resolve(); + } + }); + }); +} \ No newline at end of file diff --git a/src/core/subscriptions/utils/timeUtils.ts b/src/core/subscriptions/utils/timeUtils.ts new file mode 100644 index 0000000..b179eb5 --- /dev/null +++ b/src/core/subscriptions/utils/timeUtils.ts @@ -0,0 +1,4 @@ + +export function getTimestamp(): string { + return new Date().toISOString(); +} diff --git a/src/extension.ts b/src/extension.ts index 526e96c..7e50d87 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -1,40 +1,33 @@ -// The module 'vscode' contains the VS Code extensibility API -// Import the module and reference it with the alias vscode in your code below import * as vscode from 'vscode'; -import * as path from 'path'; -import terminate from 'terminate'; -import { ChildProcess, exec } from 'child_process'; -import { loadSubscriptions } from './core/subscriptions/subscriptions'; -import { postMessageToWebview } from './core/router/outboundMailer'; +import { registerAllCommands } from './core/subscriptions/commands/index'; +import { loadOpenAPIFilesAndNotifyWebview } from './utils/openAPIFiles'; -import { Workshop } from './Workshop'; -import { Sidebar } from './Sidebar'; -import { updateOpenAPIFiles } from './parseWorkspace'; -import { StatusBarManager } from './core/statusbar/StatusBarManager'; - -// Fetch user's extension settings -const config = vscode.workspace.getConfiguration("protopi"); -const prismPath = path.join(__dirname, "..", "node_modules", ".bin", "prism"); -const prismPort: number = config.get("mockServer.port") ?? 3141; - -let mockServer: ChildProcess | null = null; +import { Workshop } from './views/Workshop'; +import { Sidebar } from './views/Sidebar'; +import { StatusBarManager } from './core/subscriptions/managers/StatusBarManager'; export function activate(context: vscode.ExtensionContext) { console.log('Activating ProtoPI extension.'); + // Initialize the status bar item + const statusBarManager = new StatusBarManager(); + + // Initialize the sidebar const sidebar = new Sidebar(context.extensionUri); context.subscriptions.push( - vscode.window.registerWebviewViewProvider('protopi-sidebar', sidebar) + vscode.window.registerWebviewViewProvider( + 'protopi-sidebar', + sidebar, + ) ); - // Initialize the status bar item - const statusBarManager = new StatusBarManager(); + // Load OpenAPI files and notify webview loadOpenAPIFilesAndNotifyWebview(context, sidebar); - // Load subscriptions from subscriptions file - loadSubscriptions(context, sidebar, statusBarManager); + // Register all commands + registerAllCommands(context, sidebar, statusBarManager); // Uncomment the following line to make the Workshop panel appear on load Workshop.createOrShow(context.extensionUri); @@ -43,32 +36,4 @@ export function activate(context: vscode.ExtensionContext) { // This method is called when your extension is deactivated export function deactivate() { console.log('Deactivating ProtoPI extension.'); - terminateMockServer(); -} - -function terminateMockServer(){ - if (mockServer && mockServer.pid) { - terminate(mockServer.pid, (err) => { - if (err){ - console.error('Failed to terminate mock server:', err); - } else { - console.log('Mock server terminated successfully.'); - mockServer = null; - } - }); - } -} - -function loadOpenAPIFilesAndNotifyWebview(context: vscode.ExtensionContext, sidebar: Sidebar) { - updateOpenAPIFiles(context).then((files) => { - console.log("OpenAPI Files loaded into extension state"); - - if (sidebar._view?.webview) { - postMessageToWebview(sidebar._view.webview, { - type: 'openAPIFiles', - content: files, - }); - console.log('OpenAPI Files loaded into webview'); - } - }); -}; \ No newline at end of file +} \ No newline at end of file diff --git a/src/utils/openAPIFiles.ts b/src/utils/openAPIFiles.ts new file mode 100644 index 0000000..47b1d7e --- /dev/null +++ b/src/utils/openAPIFiles.ts @@ -0,0 +1,22 @@ +import * as vscode from 'vscode'; +import { updateOpenAPIFiles } from '../core/subscriptions/utils/parseWorkspace'; +import { postMessageToWebview } from '../core/router/outboundMailer'; +import { Sidebar } from '../views/Sidebar'; + +export async function loadOpenAPIFilesAndNotifyWebview(context: vscode.ExtensionContext, sidebar: Sidebar): Promise { + try { + const files = await updateOpenAPIFiles(context); + console.log("OpenAPI Files loaded into extension state"); + + if (sidebar._view?.webview) { + postMessageToWebview(sidebar._view.webview, { + type: 'openAPIFiles', + content: files, + }); + console.log('OpenAPI Files loaded into webview'); + } + } catch (error) { + console.error("Failed to load OpenAPI files:", error); + vscode.window.showErrorMessage("Failed to load OpenAPI files. See console for details."); + } +} \ No newline at end of file diff --git a/src/Sidebar.ts b/src/views/Sidebar.ts similarity index 96% rename from src/Sidebar.ts rename to src/views/Sidebar.ts index f4c799c..126af16 100644 --- a/src/Sidebar.ts +++ b/src/views/Sidebar.ts @@ -1,6 +1,6 @@ import * as vscode from "vscode"; -import { getNonce } from "./core/nonce/getNonce"; -import { handleMessage } from "./core/router/inboundRouter"; +import { getNonce } from "./../core/nonce/getNonce"; +import { handleMessage } from "./../core/router/inboundRouter"; import { Workshop } from "./Workshop"; export class Sidebar implements vscode.WebviewViewProvider { diff --git a/src/Workshop.ts b/src/views/Workshop.ts similarity index 97% rename from src/Workshop.ts rename to src/views/Workshop.ts index db0fd9e..5ab0077 100644 --- a/src/Workshop.ts +++ b/src/views/Workshop.ts @@ -1,6 +1,6 @@ import * as vscode from "vscode"; -import { getNonce } from "./core/nonce/getNonce"; -import { handleMessage } from "./core/router/inboundRouter"; +import { getNonce } from "./../core/nonce/getNonce"; +import { handleMessage } from "./../core/router/inboundRouter"; export class Workshop { /** diff --git a/src/vscode-api.ts b/src/vscode-api.ts deleted file mode 100644 index 3fef1f0..0000000 --- a/src/vscode-api.ts +++ /dev/null @@ -1,3 +0,0 @@ -// vscode-api.ts -const vscodeApi = acquireVsCodeApi(); // not a typescript error due to ./types/vscode-env.d.ts -export default vscodeApi; \ No newline at end of file