diff --git a/.gitignore b/.gitignore index 3e759b7..30085e6 100644 --- a/.gitignore +++ b/.gitignore @@ -221,7 +221,7 @@ ClientBin/ *.publishsettings orleans.codegen.cs -# Including strong name files can present a security risk +# Including strong name files can present a security risk # (https://github.com/github/gitignore/pull/2483#issue-259490424) #*.snk @@ -317,7 +317,7 @@ __pycache__/ # OpenCover UI analysis results OpenCover/ -# Azure Stream Analytics local run output +# Azure Stream Analytics local run output ASALocalRun/ # MSBuild Binary and Structured Log @@ -326,5 +326,7 @@ ASALocalRun/ # NVidia Nsight GPU debugger configuration file *.nvuser -# MFractors (Xamarin productivity tool) working folder +# MFractors (Xamarin productivity tool) working folder .mfractor/ + +*.Parm \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json index 0bdb5f8..7eb2297 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -1,17 +1,19 @@ { - // Use IntelliSense to find out which attributes exist for C# debugging - // Use hover for the description of the existing attributes - // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md "version": "0.2.0", "configurations": [ { + // Use IntelliSense to find out which attributes exist for C# debugging + // Use hover for the description of the existing attributes + // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md "name": ".NET Core Launch (console)", "type": "coreclr", "request": "launch", "preLaunchTask": "build", // If you have changed target frameworks, make sure to update the program path. - "program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.TelegramBot/bin/Debug/netcoreapp3.1/cv4pve-botgram.dll", - "args": [], + "program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.TelegramBot/bin/Debug/net6.0/cv4pve-botgram.dll", + "args": [ + "@Parm.Parm" + ], "cwd": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.TelegramBot", // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console "console": "internalConsole", @@ -20,8 +22,7 @@ { "name": ".NET Core Attach", "type": "coreclr", - "request": "attach", - "processId": "${command:pickProcess}" + "request": "attach" } ] } \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json index adced24..3a1a784 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -32,9 +32,8 @@ "args": [ "watch", "run", - "${workspaceFolder}/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj", - "/property:GenerateFullPaths=true", - "/consoleloggerparameters:NoSummary" + "--project", + "${workspaceFolder}/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj" ], "problemMatcher": "$msCompile" } diff --git a/LICENSE.md b/LICENSE.md index 60e758e..9cecc1d 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,25 +1,674 @@ -# License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (C) Corsinvest Srl + 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. -This software is available under two different licenses: + Preamble -* GNU General Public License version 3 (GPLv3) -* Corsinvest Enterprise License (CEL) + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -The default license, without a valid Corsinvest Enterprise License (CEL) agreement, is the Open-Source GPLv3 license. + 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. -## GNU General Public License version 3 (GPLv3) + 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. -If you decide to choose the GPLv3 license, you must comply with the following terms: -[GPLv3](gpl-3.0.txt) + 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. -## Corsinvest Enterprise License (CEL) + 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. -Alternatively, commercial and supported versions of the program - also known as Enterprise Distributions - must be used in accordance with the terms and conditions contained in a separate written agreement between you and Corsinvest Srl. For more information about the Corsinvest Enterprise License (CEL) please visit [site](https://www.corsinvest.it/open-source#license) + 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. -Please see also (files in this directory): + 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. -[GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - gpl-3.0.txt](gpl-3.0.txt) + 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. -[Libraries used including their own licenses - 3rd-party-licenses.md](3rd-party-licenses.md) + 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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/gpl-3.0.txt b/gpl-3.0.txt deleted file mode 100644 index bb4435f..0000000 --- a/gpl-3.0.txt +++ /dev/null @@ -1,674 +0,0 @@ - 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. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - 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: - - {project} Copyright (C) {year} {fullname} - 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/src/Corsinvest.ProxmoxVE.TelegramBot.Api/BotManager.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/BotManager.cs index e27eee3..5f80553 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/BotManager.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/BotManager.cs @@ -1,196 +1,220 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System; using System.Collections.Generic; using System.IO; using System.Linq; +using System.Threading; using System.Threading.Tasks; using Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot; -using Telegram.Bot.Args; +using Telegram.Bot.Exceptions; +using Telegram.Bot.Polling; using Telegram.Bot.Types; using Telegram.Bot.Types.Enums; -namespace Corsinvest.ProxmoxVE.TelegramBot.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Api; + +/// +/// Bot Manager +/// +public class BotManager { + private readonly TelegramBotClient _client; + private readonly long[] _chatsIdValid; + private readonly TextWriter _out; + private readonly Dictionary _lastCommandForChat; + private CancellationTokenSource Cts; + /// - /// Botmanager + /// Constructor /// - public class BotManager + /// Proxmox VE host and port HA format 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006 + /// Proxmox VE Api Token + /// Proxmox VE username + /// Proxmox VE password + /// Token Telegram Bot + /// Valid chats Id + /// Output write + public BotManager(string pveHostAndPortHA, + string pveApiToken, + string pveUsername, + string pvePassword, + string token, + long[] chatsIdValid, + TextWriter @out) { - private readonly TelegramBotClient _client; - private readonly long[] _chatsIdValid; - private readonly TextWriter _out; - private readonly Dictionary _lastCommandForChat; - - /// - /// Constructor - /// - /// Proxmox VE host and port HA format 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006 - /// Proxmox VE Api Token - /// Proxmox VE username - /// Proxmox VE password - /// Token Telegram Bot - /// Valid chats Id - /// Output write - public BotManager(string pveHostandPortHA, - string pveApiToken, - string pveUsername, - string pvePassword, - string token, - long[] chatsIdValid, - TextWriter @out) - { - PveHelper.HostandPortHA = pveHostandPortHA; - PveHelper.ApiToken = pveApiToken; - PveHelper.Username = pveUsername; - PveHelper.Password = pvePassword; - PveHelper.Out = @out; - - _chatsIdValid = chatsIdValid; - _out = @out; - _lastCommandForChat = new Dictionary(); - - //create bootgram telegram - _client = new TelegramBotClient(token); - - var result = _client.GetMeAsync().Result; - Username = result.Username; - - _client.OnMessage += OnMessage; - _client.OnMessageEdited += OnMessage; - _client.OnCallbackQuery += OnCallbackQuery; - //Bot.OnInlineQuery += BotOnInlineQueryReceived; - _client.OnInlineResultChosen += OnInlineResultChosen; - _client.OnReceiveError += OnReceiveError; - _client.OnReceiveGeneralError += OnReceiveGeneralError; - } + PveHelperInt.HostAndPortHA = pveHostAndPortHA; + PveHelperInt.ApiToken = pveApiToken; + PveHelperInt.Username = pveUsername; + PveHelperInt.Password = pvePassword; + PveHelperInt.Out = @out; + + _chatsIdValid = chatsIdValid; + _out = @out; + _lastCommandForChat = new Dictionary(); + + //create telegram + _client = new TelegramBotClient(token); + } - /// - /// Chat username - /// - /// - public string Username { get; } - - /// - /// Send message - /// - /// - /// - public async Task SendMessageAsync(long chatId, string message) => await _client.SendTextMessageAsync(chatId, message); - - /// - /// Start chat - /// - public void StartReceiving() - { - _client.StartReceiving(Array.Empty()); + /// + /// Bot Id + /// + public long? BootId => _client.BotId; + + /// + /// Chat username + /// + /// + public string Username { get; private set; } + + /// + /// Send message + /// + /// + /// + public async Task SendMessageAsync(long chatId, string message) => await _client.SendTextMessageAsync(chatId, message); - _out.WriteLine($@"Start listening + /// + /// Start chat + /// + public void StartReceiving() + { + Cts = new CancellationTokenSource(); + + _client.StartReceiving(updateHandler: HandleUpdateAsync, + pollingErrorHandler: HandlePollingErrorAsync, + receiverOptions: new ReceiverOptions + { + AllowedUpdates = Array.Empty() // receive all update types + }, + cancellationToken: Cts.Token); + + var result = _client.GetMeAsync().Result; + Username = result.Username; + + _out.WriteLine($@"Start listening Telegram Bot User: @{Username} + Bot Id: @{BootId} Proxmox VE - Host: {PveHelper.HostandPortHA} - Username: {PveHelper.Username}"); - } + Host: {PveHelperInt.HostAndPortHA} + Username: {PveHelperInt.Username}"); + } - /// - /// Stop chat - /// - public void StopReceiving() => _client.StopReceiving(); + /// + /// Stop chat + /// + public void StopReceiving() + { + //Send cancellation request to stop bot + Cts.Cancel(); + Cts = null; + } - private async void OnReceiveGeneralError(object sender, ReceiveGeneralErrorEventArgs e) - => await _out.WriteLineAsync($"Received error: {e.Exception.Source} — {e.Exception.Message}"); + private async Task HandleUpdateAsync(ITelegramBotClient botClient, Update update, CancellationToken cancellationToken) + { + if (update.CallbackQuery is not null) + { + await ProcessCallbackQuery(update.CallbackQuery); + } + else if (update.Message is not null) + { + await ProcessMessage(update.Message); + } + } - private async void OnReceiveError(object sender, ReceiveErrorEventArgs e) - => await _out.WriteLineAsync($"Received error: {e.ApiRequestException.ErrorCode} — {e.ApiRequestException.Message}"); + private Task HandlePollingErrorAsync(ITelegramBotClient botClient, Exception exception, CancellationToken cancellationToken) + { + var ErrorMessage = exception switch + { + ApiRequestException apiRequestException + => $"Telegram API Error:\n[{apiRequestException.ErrorCode}]\n{apiRequestException.Message}", + _ => exception.ToString() + }; - private async void OnInlineResultChosen(object sender, ChosenInlineResultEventArgs e) - => await _out.WriteLineAsync($"OnInlineResultChosen: {e.ChosenInlineResult.ResultId}"); + Console.WriteLine(ErrorMessage); + return Task.CompletedTask; + } - private async void OnCallbackQuery(object sender, CallbackQueryEventArgs e) - { - await _out.WriteLineAsync($"OnCallbackQuery: {e.CallbackQuery.Data}"); + private async Task ProcessCallbackQuery(CallbackQuery callbackQuery) + { + await _out.WriteLineAsync($"OnCallbackQuery: {callbackQuery.Data}"); - var chatId = e.CallbackQuery.Message.Chat.Id; - await _client.DeleteMessageAsync(chatId, e.CallbackQuery.Message.MessageId); + var chatId = callbackQuery.Message.Chat.Id; + await _client.DeleteMessageAsync(chatId, callbackQuery.Message.MessageId); - try + try + { + if (_lastCommandForChat.TryGetValue(chatId, out var value)) { - if (_lastCommandForChat.TryGetValue(chatId, out var value)) - { - if (await value.Command.Execute(value.Message, e.CallbackQuery, _client)) - { - _lastCommandForChat.Remove(chatId); - } - } - else + if (await value.Command.Execute(value.Message, callbackQuery, _client)) { _lastCommandForChat.Remove(chatId); - await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Data not recognized '{e.CallbackQuery.Data}'"); } } - catch (Exception ex) + else { - await _out.WriteLineAsync(ex.StackTrace); - await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Error CallbackQuery! {ex.Message}"); + _lastCommandForChat.Remove(chatId); + await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Data not recognized '{callbackQuery.Data}'"); } } + catch (Exception ex) + { + await _out.WriteLineAsync(ex.StackTrace); + await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Error CallbackQuery! {ex.Message}"); + } + } - private async void OnMessage(object sender, MessageEventArgs e) + private async Task ProcessMessage(Message message) + { + if (message.Text is not { } messageText) { return; } + + var chatId = message.Chat.Id; + var log = $"{message.Date} - Chat Id: '{chatId}'" + + $" User: '{message.Chat.Username}'" + + $" - '{message.Chat.FirstName} {message.Chat.LastName}'" + + $" Msg Type: '{message.Type}'"; + if (message.Type == MessageType.Text) { log += $"=> '{message.Text}'"; } + await _out.WriteLineAsync(log); + + //check security Chat + if (_chatsIdValid.Any() && !_chatsIdValid.Contains(chatId)) { - var chatId = e.Message.Chat.Id; - var log = $"{e.Message.Date} - Chat Id: '{chatId}'" + - $" User: '{e.Message.Chat.Username}'" + - $" - '{e.Message.Chat.FirstName} {e.Message.Chat.LastName}'" + - $" Msg Type: '{e.Message.Type}'"; - if (e.Message.Type == MessageType.Text) { log += $"=> '{e.Message.Text}'"; } - await _out.WriteLineAsync(log); - - //check security Chat - if (_chatsIdValid.Count() > 0 && !_chatsIdValid.Contains(chatId)) - { - await _out.WriteLineAsync($"Security: Chat Id '{chatId}' - Username '{e.Message.Chat.Username}' not permitted access!"); - await _client.SendTextMessageAsync(chatId, "You not have permission in this Chat!"); - return; - } + await _out.WriteLineAsync($"Security: Chat Id '{chatId}' - Username '{message.Chat.Username}' not permitted access!"); + await _client.SendTextMessageAsync(chatId, "You not have permission in this Chat!"); + return; + } - var command = e.Message.Type == MessageType.Text ? - Command.GetCommand(e.Message.Text) : - null; + var command = message.Type == MessageType.Text + ? Command.GetCommand(message.Text) + : null; - var exists = _lastCommandForChat.ContainsKey(chatId); - if (command == null && exists) { command = _lastCommandForChat[chatId].Command; } - if (command == null) { command = new Help(); } + var exists = _lastCommandForChat.ContainsKey(chatId); + if (command == null && exists) { command = _lastCommandForChat[chatId].Command; } + command ??= new Help(); - //save last command and chat - if (exists) { _lastCommandForChat.Remove(chatId); } - _lastCommandForChat.Add(chatId, (e.Message, command)); + //save last command and chat + if (exists) { _lastCommandForChat.Remove(chatId); } + _lastCommandForChat.Add(chatId, (message, command)); - try - { - if (await command.Execute(e.Message, _client)) - { - _lastCommandForChat.Remove(chatId); - } - } - catch (Exception ex) + try + { + if (await command.Execute(message, _client)) { _lastCommandForChat.Remove(chatId); - await _out.WriteLineAsync(ex.StackTrace); - await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Error execute command! {ex.Message}"); } } + catch (Exception ex) + { + _lastCommandForChat.Remove(chatId); + await _out.WriteLineAsync(ex.StackTrace); + await _client.SendTextMessageAsyncNoKeyboard(chatId, $"Error execute command! {ex.Message}"); + } } -} +} \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Alias.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Alias.cs index e1b964e..2646285 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Alias.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Alias.cs @@ -1,13 +1,6 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.IO; @@ -17,136 +10,136 @@ using System.Linq; using System.Collections.Generic; using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; -using Corsinvest.ProxmoxVE.Api.Extension.Helpers; -using Corsinvest.ProxmoxVE.Api.Extension.Utility; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; +using Corsinvest.ProxmoxVE.Api.Shared.Utils; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; + +internal class Alias : Command { - internal class Alias : Command + private enum RequestType { - private enum RequestType - { - Action, - CreateRequestName, - CreateRequestDescription, - CreateRequestCommand, - DeleteRequestName - } + Action, + CreateRequestName, + CreateRequestDescription, + CreateRequestCommand, + DeleteRequestName + } - private RequestType _requestType = RequestType.Action; - private readonly AliasManager _aliasManager; - private string _name; - private string _description; + private RequestType _requestType = RequestType.Action; + private readonly ApiExplorerHelper.AliasManager _aliasManager; + private string _name; + private string _description; - public Alias() + public Alias() + { + _aliasManager = new ApiExplorerHelper.AliasManager { - _aliasManager = new AliasManager - { - FileName = Path.Combine(ApplicationHelper.GetApplicationDataDirectory("cv4pve-botgram"), "alias.txt") - }; - _aliasManager.Load(); - } + + FileName = Path.Combine(FilesystemHelper.GetApplicationDataDirectory("cv4pve-botgram"), "alias.txt") + }; + _aliasManager.Load(); + } - public override string Name => "alias"; - public override string Description => "Create alias commands"; + public override string Name => "alias"; + public override string Description => "Create alias commands"; - public override async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) + public override async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + { + var endCommand = false; + switch (_requestType) { - var endCommand = false; - switch (_requestType) - { - case RequestType.Action: - switch (callbackQuery.Data) - { - case "List": - await botClient.SendDocumentAsyncFromText(message.Chat.Id, - _aliasManager.ToTable(true, TableOutputType.Html), - "alias.html"); - endCommand = true; - break; - - case "Delete": - //request name - _requestType = RequestType.DeleteRequestName; - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Name alias"); - break; - - case "Create": - //request name - _requestType = RequestType.CreateRequestName; - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Name alias"); - break; - - default: break; - } - break; - - default: break; - } - - return await Task.FromResult(endCommand); + case RequestType.Action: + switch (callbackQuery.Data) + { + case "List": + await botClient.SendDocumentAsyncFromText(message.Chat.Id, + _aliasManager.ToTable(true, TableGenerator.Output.Html), + "alias.html"); + endCommand = true; + break; + + case "Delete": + //request name + _requestType = RequestType.DeleteRequestName; + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Name alias"); + break; + + case "Create": + //request name + _requestType = RequestType.CreateRequestName; + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Name alias"); + break; + + default: break; + } + break; + + default: break; } - public override async Task Execute(Message message, TelegramBotClient botClient) + return await Task.FromResult(endCommand); + } + + public override async Task Execute(Message message, TelegramBotClient botClient) + { + var endCommand = false; + + switch (_requestType) { - var endCommand = false; - - switch (_requestType) - { - case RequestType.Action: - await botClient.ChooseInlineKeyboard(message.Chat.Id, - "Choose action", - new[] { "List", "Delete", "Create" }); - break; - - case RequestType.DeleteRequestName: - if (_aliasManager.Exists(message.Text)) - { - _aliasManager.Remove(message.Text); - } - else - { - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, - $"Name not valid '{message.Text}'"); - } + case RequestType.Action: + await botClient.ChooseInlineKeyboard(message.Chat.Id, + "Choose action", + new[] { "List", "Delete", "Create" }); + break; + + case RequestType.DeleteRequestName: + if (_aliasManager.Exists(message.Text)) + { + _aliasManager.Remove(message.Text); + } + else + { + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, + $"Name not valid '{message.Text}'"); + } + endCommand = true; + break; + + case RequestType.CreateRequestName: + _name = message.Text.Trim(); + if (_aliasManager.Exists(_name)) + { + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, + $"Name not valid '{_name}'"); endCommand = true; - break; - - case RequestType.CreateRequestName: - _name = message.Text.Trim(); - if (_aliasManager.Exists(_name)) - { - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, - $"Name not valid '{_name}'"); - endCommand = true; - } - else - { - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Description"); - _requestType = RequestType.CreateRequestDescription; - } - break; - - case RequestType.CreateRequestDescription: - _description = message.Text.Trim(); + } + else + { await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Description"); - _requestType = RequestType.CreateRequestCommand; - break; - - case RequestType.CreateRequestCommand: - _aliasManager.Create(_name, _description, message.Text.Trim(), false); - endCommand = true; - break; - - default: break; - } - - return await Task.FromResult(endCommand); + _requestType = RequestType.CreateRequestDescription; + } + break; + + case RequestType.CreateRequestDescription: + _description = message.Text.Trim(); + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "Description"); + _requestType = RequestType.CreateRequestCommand; + break; + + case RequestType.CreateRequestCommand: + _aliasManager.Create(_name, _description, message.Text.Trim(), false); + endCommand = true; + break; + + default: break; } - public IReadOnlyList GetCommandsFromAlias() - => _aliasManager.Alias.Select(a => new AliasCommand(a)).ToList().AsReadOnly(); + return await Task.FromResult(endCommand); } + + public IReadOnlyList GetCommandsFromAlias() + => _aliasManager.Alias.Select(a => new AliasCommand(a)).ToList().AsReadOnly(); } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/AliasCommand.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/AliasCommand.cs index 1477598..bee0f53 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/AliasCommand.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/AliasCommand.cs @@ -1,61 +1,53 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.Threading.Tasks; -using Corsinvest.ProxmoxVE.Api.Extension.Utility; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; using Telegram.Bot; using Telegram.Bot.Types; using Telegram.Bot.Types.Enums; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; + +internal class AliasCommand : Command { - internal class AliasCommand : Command - { - private readonly AliasDef _aliasDef; - private Command _commandRef; + private readonly ApiExplorerHelper.AliasDef _aliasDef; + private Command _commandRef; - public AliasCommand(AliasDef aliasDef) - { - _aliasDef = aliasDef; - Names.AddRange(aliasDef.Names); - } + public AliasCommand(ApiExplorerHelper.AliasDef aliasDef) + { + _aliasDef = aliasDef; + Names.AddRange(aliasDef.Names); + } - public override string Name => _aliasDef.Names[0]; - public override string Description => _aliasDef.Description; - public override bool ShowInHelp => false; + public override string Name => _aliasDef.Names[0]; + public override string Description => _aliasDef.Description; + public override bool ShowInHelp => false; - public override async Task Execute(Message message, TelegramBotClient botClient) + public override async Task Execute(Message message, TelegramBotClient botClient) + { + if (_commandRef == null) { - if (_commandRef == null) - { - //command reference - var command = _aliasDef.Command; - if (!command.StartsWith("/")) { command = "/" + command; } - var name = command.Trim().Split(' ')[0]; - _commandRef = message.Type == MessageType.Text ? - Command.GetCommand(name) : - null; - - message.Text = command; - } - - if (_commandRef == null) { return await Task.FromResult(true); } - - return await _commandRef.Execute(message, botClient); + //command reference + var command = _aliasDef.Command; + if (!command.StartsWith("/")) { command = "/" + command; } + var name = command.Trim().Split(' ')[0]; + _commandRef = message.Type == MessageType.Text ? + Command.GetCommand(name) : + null; + + message.Text = command; } - public override async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) - => await _commandRef.Execute(message, callbackQuery, botClient); + if (_commandRef == null) { return await Task.FromResult(true); } + + return await _commandRef.Execute(message, botClient); } + + public override async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + => await _commandRef.Execute(message, callbackQuery, botClient); } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Base.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Base.cs index 0d28aa8..0bf5c20 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Base.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Base.cs @@ -1,13 +1,6 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System; @@ -16,148 +9,147 @@ using System.Linq; using System.Threading.Tasks; using Corsinvest.ProxmoxVE.Api; -using Corsinvest.ProxmoxVE.Api.Extension.Helpers; -using Corsinvest.ProxmoxVE.Api.Extension.Utility; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; +using Corsinvest.ProxmoxVE.Api.Shared.Utils; using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal abstract class Base : Command { - internal abstract class Base : Command + public static readonly string DEFAULT_MSG = "Insert resource (eg nodes)" + + Environment.NewLine + + "More info see documentation API"; + + private enum TypeRequest { - public static readonly string DEFAULT_MSG = "Insert resource (eg nodes)" + - Environment.NewLine + - "More info see documentation API"; + Start, + Resource, + ArgParameter, + ArgResource, + } - private enum TypeRequest + protected abstract MethodType MethodType { get; } + protected string FileName { get; } + private string _messageText; + private TypeRequest _typeRequest = TypeRequest.Start; + + public override async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + { + if (string.IsNullOrWhiteSpace(_messageText)) { - Start, - Resource, - ArgParameter, - ArgResource, + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "No command!"); + await Task.CompletedTask; } - protected abstract MethodType MethodType { get; } - protected string FileName { get; } - private string _messageText; - private TypeRequest _typeRequest = TypeRequest.Start; - - public override async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) - { - if (string.IsNullOrWhiteSpace(_messageText)) - { - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, "No command!"); - await Task.CompletedTask; - } + ReplaceArg(callbackQuery.Data); - ReplaceArg(callbackQuery.Data); + return await ExecuteOrChoose(message, botClient); + } - return await ExecuteOrChoose(message, botClient); + private async Task ExecuteOrChoose(Message message, TelegramBotClient botClient) + { + var endCommand = false; + var cmdArgs = ParserExtensions.Parse(new Parser(), _messageText).Tokens.Select(a => a.Value).ToList(); + if (cmdArgs.Count == 0) + { + //request resource + _typeRequest = TypeRequest.Resource; + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, DEFAULT_MSG); } - - private async Task ExecuteOrChoose(Message message, TelegramBotClient botClient) + else { - var endCommand = false; - var cmdArgs = ParserExtensions.Parse(new Parser(), _messageText).Tokens.Select(a => a.Value).ToList(); - if (cmdArgs.Count == 0) - { - //request resource - _typeRequest = TypeRequest.Resource; - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, DEFAULT_MSG); - } - else + var resource = cmdArgs[0]; + if (!resource.StartsWith("/")) { resource = "/" + resource; } + var requestArgs = ApiExplorerHelper.GetArgumentTags(resource); + var parameters = cmdArgs.Skip(1).ToArray(); + var parametersArgs = parameters.SelectMany(a => ApiExplorerHelper.GetArgumentTags(a)).ToList(); + + if (requestArgs.Any()) { - var resource = cmdArgs[0]; - if (!resource.StartsWith("/")) { resource = "/" + resource; } - var requestArgs = StringHelper.GetArgumentTags(resource); - var parameters = cmdArgs.Skip(1).ToArray(); - var parametersArgs = parameters.SelectMany(a => StringHelper.GetArgumentTags(a)).ToList(); + //fix request + resource = resource[..(resource.IndexOf(ApiExplorerHelper.CreateArgumentTag(requestArgs[0])) - 1)]; - if (requestArgs.Count() > 0) + var pveClient = await GetClient(); + var (Values, Error) = await ApiExplorerHelper.ListValues(pveClient, await PveHelperInt.GetClassApiRoot(pveClient), resource); + if (!string.IsNullOrWhiteSpace(Error)) { - //fix request - resource = resource.Substring(0, resource.IndexOf(StringHelper.CreateArgumentTag(requestArgs[0])) - 1); - - var pveClient = PveHelper.GetClient(); - var (Values, Error) = ApiExplorer.ListValues(pveClient, PveHelper.GetClassApiRoot(pveClient), resource); - if (!string.IsNullOrWhiteSpace(Error)) - { - //return error - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, Error); - endCommand = true; - } - else - { - _typeRequest = TypeRequest.ArgResource; - - await botClient.ChooseInlineKeyboard(message.Chat.Id, - $"Choose {requestArgs[0]}", - Values.Select(a => ("", a.Value, a.Value))); - } + //return error + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, Error); + endCommand = true; } - else if (parametersArgs.Count() > 0) + else { - //request parameter value - _typeRequest = TypeRequest.ArgParameter; + _typeRequest = TypeRequest.ArgResource; - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, - $"Insert value for parmater {parametersArgs[0]}"); + await botClient.ChooseInlineKeyboard(message.Chat.Id, + $"Choose {requestArgs[0]}", + Values.Select(a => ("", a.Value, a.Value))); } - else if (requestArgs.Count() == 0) - { - var pveClient = PveHelper.GetClient(); - //execute request - var (ResultCode, ResultText) = ApiExplorer.Execute(pveClient, - PveHelper.GetClassApiRoot(pveClient), - resource, - MethodType, - ApiExplorer.CreateParameterResource(parameters), - false, - ApiExplorer.OutputType.Html); - - if (ResultCode != 200) - { - await botClient.SendTextMessageAsync(message.Chat.Id, $"Error: {ResultText}"); - } - else - { - var filename = CultureInfo.CurrentCulture.TextInfo.ToTitleCase(resource).Replace("/", ""); - await botClient.SendDocumentAsyncFromText(message.Chat.Id, ResultText, $"{filename}.html"); - } + } + else if (parametersArgs.Any()) + { + //request parameter value + _typeRequest = TypeRequest.ArgParameter; - endCommand = true; + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, + $"Insert value for parmater {parametersArgs[0]}"); + } + else if (requestArgs.Length == 0) + { + var pveClient = await GetClient(); + //execute request + var (ResultCode, ResultText) = await ApiExplorerHelper.Execute(pveClient, + await PveHelperInt.GetClassApiRoot(pveClient), + resource, + MethodType, + ApiExplorerHelper.CreateParameterResource(parameters), + false, + TableGenerator.Output.Html); + + if (ResultCode != 200) + { + await botClient.SendTextMessageAsync(message.Chat.Id, $"Error: {ResultText}"); + } + else + { + var filename = CultureInfo.CurrentCulture.TextInfo.ToTitleCase(resource).Replace("/", ""); + await botClient.SendDocumentAsyncFromText(message.Chat.Id, ResultText, $"{filename}.html"); } + + endCommand = true; } + } - if (endCommand) { _messageText = ""; } + if (endCommand) { _messageText = ""; } - return await Task.FromResult(endCommand); - } + return await Task.FromResult(endCommand); + } - private void ReplaceArg(string value) - => _messageText = _messageText.Replace( - StringHelper.CreateArgumentTag(StringHelper.GetArgumentTags(_messageText)[0]), - value); + private void ReplaceArg(string value) + => _messageText = _messageText.Replace( + ApiExplorerHelper.CreateArgumentTag(ApiExplorerHelper.GetArgumentTags(_messageText)[0]), + value); - public override async Task Execute(Message message, TelegramBotClient botClient) + public override async Task Execute(Message message, TelegramBotClient botClient) + { + switch (_typeRequest) { - switch (_typeRequest) - { - case TypeRequest.Start: - _messageText = ""; - var args = ParserExtensions.Parse(new Parser(), _messageText).Tokens.Select(a => a.Value).ToList(); - if (args.Count > 1) { _messageText = string.Join(" ", args.Skip(1).ToArray()); } - break; - - case TypeRequest.Resource: _messageText = message.Text; break; - case TypeRequest.ArgParameter: ReplaceArg(message.Text); break; - default: break; - } - - return await ExecuteOrChoose(message, botClient); + case TypeRequest.Start: + _messageText = ""; + var args = ParserExtensions.Parse(new Parser(), _messageText).Tokens.Select(a => a.Value).ToList(); + if (args.Count > 1) { _messageText = string.Join(" ", args.Skip(1).ToArray()); } + break; + + case TypeRequest.Resource: _messageText = message.Text; break; + case TypeRequest.ArgParameter: ReplaceArg(message.Text); break; + default: break; } + + return await ExecuteOrChoose(message, botClient); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Create.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Create.cs index a64c575..4d544c7 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Create.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Create.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using Corsinvest.ProxmoxVE.Api; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal class Create : Base { - internal class Create : Base - { - public override string Name => "create"; - public override string Description => "Get from resource and result to file"; - protected override MethodType MethodType => MethodType.Create; - } + public override string Name => "create"; + public override string Description => "Get from resource and result to file"; + protected override MethodType MethodType => MethodType.Create; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Delete.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Delete.cs index ad46b7b..65224c6 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Delete.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Delete.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using Corsinvest.ProxmoxVE.Api; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal class Delete : Base { - internal class Delete : Base - { - public override string Name => "delete"; - public override string Description => "Get from resource and result to file"; - protected override MethodType MethodType => MethodType.Delete; - } + public override string Name => "delete"; + public override string Description => "Get from resource and result to file"; + protected override MethodType MethodType => MethodType.Delete; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Get.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Get.cs index d318bf2..244d62d 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Get.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Get.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using Corsinvest.ProxmoxVE.Api; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal class Get : Base { - internal class Get : Base - { - public override string Name => "get"; - public override string Description => "Get from resource and result to file"; - protected override MethodType MethodType => MethodType.Get; - } + public override string Name => "get"; + public override string Description => "Get from resource and result to file"; + protected override MethodType MethodType => MethodType.Get; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Set.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Set.cs index 8b2acac..41cc86a 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Set.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Set.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using Corsinvest.ProxmoxVE.Api; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal class Set : Base { - internal class Set : Base - { - public override string Name => "set"; - public override string Description => "Set from resource and result to file"; - protected override MethodType MethodType => MethodType.Set; - } + public override string Name => "set"; + public override string Description => "Set from resource and result to file"; + protected override MethodType MethodType => MethodType.Set; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Usage.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Usage.cs index f3e6543..d687145 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Usage.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Api/Usage.cs @@ -1,62 +1,55 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.Threading.Tasks; -using Corsinvest.ProxmoxVE.Api.Extension.Utility; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; +using Corsinvest.ProxmoxVE.Api.Shared.Utils; using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api.Api; + +internal class Usage : Command { - internal class Usage : Command + private enum TypeRequest { - private enum TypeRequest - { - Start, - Resource, - } + Start, + Resource, + } - private TypeRequest _typeRequest; - public override string Name => "usage"; - public override string Description => "Usage resource api"; + private TypeRequest _typeRequest; + public override string Name => "usage"; + public override string Description => "Usage resource api"; - public override async Task Execute(Message message, TelegramBotClient botClient) + public override async Task Execute(Message message, TelegramBotClient botClient) + { + var endCommand = false; + + switch (_typeRequest) { - var endCommand = false; - - switch (_typeRequest) - { - case TypeRequest.Start: - _typeRequest = TypeRequest.Resource; - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, Base.DEFAULT_MSG); - break; - - case TypeRequest.Resource: - var ret = ApiExplorer.Usage(PveHelper.GetClassApiRoot(PveHelper.GetClient()), - message.Text.Trim(), - ApiExplorer.OutputType.Html, - true, - null, - true); - - await botClient.SendDocumentAsyncFromText(message.Chat.Id, ret, "Usage.html"); - endCommand = true; - break; - - default: break; - } - - return await Task.FromResult(endCommand); + case TypeRequest.Start: + _typeRequest = TypeRequest.Resource; + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, Base.DEFAULT_MSG); + break; + + case TypeRequest.Resource: + var ret = ApiExplorerHelper.Usage(await PveHelperInt.GetClassApiRoot(await GetClient()), + message.Text.Trim(), + TableGenerator.Output.Html, + true, + null, + true); + + await botClient.SendDocumentAsyncFromText(message.Chat.Id, ret, "Usage.html"); + endCommand = true; + break; + + default: break; } + + return await Task.FromResult(endCommand); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Command.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Command.cs index 2226c0d..2dfcef8 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Command.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Command.cs @@ -1,102 +1,100 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; +using Corsinvest.ProxmoxVE.Api; +using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; + +/// +/// Public command base +/// +public abstract class Command { /// - /// Public command base + /// Show in Help /// - public abstract class Command - { - /// - /// Show in Help - /// - public virtual bool ShowInHelp => true; + public virtual bool ShowInHelp => true; - /// - /// Name - /// - /// - public abstract string Name { get; } + /// + /// Name + /// + /// + public abstract string Name { get; } - /// - /// Description - /// - /// - public abstract string Description { get; } + /// + /// Description + /// + /// + public abstract string Description { get; } - /// - /// Names alias - /// - /// - public List Names { get; } = new List(); + /// + /// Names alias + /// + /// + public List Names { get; } = new List(); - internal static IReadOnlyList GetCommands() - { - var commands = new List(); - commands.AddRange(typeof(Command).Assembly - .GetTypes() - .Where(a => !a.IsAbstract && - a.IsSubclassOf(typeof(Command)) && - !a.IsAssignableFrom(typeof(AliasCommand))) - .Select(a => (Command)Activator.CreateInstance(a)) - .ToList()); + internal static IReadOnlyList GetCommands() + { + var commands = new List(); + commands.AddRange(typeof(Command).Assembly + .GetTypes() + .Where(a => !a.IsAbstract && + a.IsSubclassOf(typeof(Command)) && + !a.IsAssignableFrom(typeof(AliasCommand))) + .Select(a => (Command)Activator.CreateInstance(a)) + .ToList()); - commands.AddRange(new Alias().GetCommandsFromAlias()); - - return commands.AsReadOnly(); - } + commands.AddRange(new Alias().GetCommandsFromAlias()); - /// - /// Execute - /// - /// - /// - /// - public abstract Task Execute(Message message, TelegramBotClient botClient); + return commands.AsReadOnly(); + } - /// - /// Execute - /// - /// - /// - /// - /// - public virtual async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) - => await Task.FromResult(true); + /// + /// Get client + /// + /// + protected static async Task GetClient() => await PveHelperInt.GetClient(); - internal static Command GetCommand(string messageText) - { - Command command = null; - Console.Out.WriteLine("Message: " + messageText); + /// + /// Execute + /// + /// + /// + /// + public abstract Task Execute(Message message, TelegramBotClient botClient); - if (messageText.Trim().StartsWith("/")) - { - var name = messageText.Trim().Substring(1); - command = Command.GetCommands() - .Where(a => a.Names.Contains(name) || name == a.Name) - .FirstOrDefault(); - } + /// + /// Execute + /// + /// + /// + /// + /// + public virtual async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + => await Task.FromResult(true); + + internal static Command GetCommand(string messageText) + { + Command command = null; + PveHelperInt.Out.WriteLine("Message: " + messageText); - return command; + if (messageText.Trim().StartsWith("/")) + { + var name = messageText.Trim()[1..]; + command = GetCommands().FirstOrDefault(a => a.Names.Contains(name) || name == a.Name); } + + return command; } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Help.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Help.cs index 48081e1..789349a 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Help.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Help.cs @@ -1,13 +1,6 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System; @@ -17,25 +10,23 @@ using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api -{ - internal class Help : Command - { - public override string Name => "help"; - public override string Description => "Show help"; - protected virtual string GetText(Message message) - => "Usage:" + - Environment.NewLine + - string.Join(Environment.NewLine, - Command.GetCommands() - .Where(a => a.ShowInHelp) - .Select(a => $"/{a.Name} - {a.Description}")); +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; - public override async Task Execute(Message message, TelegramBotClient botClient) - { - await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, GetText(message)); +internal class Help : Command +{ + public override string Name => "help"; + public override string Description => "Show help"; + protected virtual string GetText(Message message) + => "Usage:" + + Environment.NewLine + + string.Join(Environment.NewLine, + Command.GetCommands() + .Where(a => a.ShowInHelp) + .Select(a => $"/{a.Name} - {a.Description}")); - return await Task.FromResult(true); - } + public override async Task Execute(Message message, TelegramBotClient botClient) + { + await botClient.SendTextMessageAsyncNoKeyboard(message.Chat.Id, GetText(message)); + return await Task.FromResult(true); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Base.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Base.cs index 1662b56..bfdd745 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Base.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Base.cs @@ -1,13 +1,6 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.Threading.Tasks; @@ -16,29 +9,28 @@ using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api; + +internal abstract class Base : Command { - internal abstract class Base : Command - { - protected abstract bool ForReboot { get; } + protected abstract bool ForReboot { get; } - public override async Task Execute(Message message, TelegramBotClient botClient) - { - await botClient.ChooseNodeInlineKeyboard(message.Chat.Id, PveHelper.GetClient(), true); - return await Task.FromResult(false); - } + public override async Task Execute(Message message, TelegramBotClient botClient) + { + await botClient.ChooseNodeInlineKeyboard(message.Chat.Id, await GetClient(), true); + return await Task.FromResult(false); + } - public override async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) - { - var action = (ForReboot ? "reboot" : "shutdown"); - PveHelper.GetClient().Nodes[callbackQuery.Data].Status.NodeCmd(action); + public override async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + { + var action = ForReboot ? "reboot" : "shutdown"; + await (await GetClient()).Nodes[callbackQuery.Data].Status.NodeCmd(action); - await botClient.SendTextMessageAsyncNoKeyboard(callbackQuery.Message.Chat.Id, - $"Node {callbackQuery.Data} action {action}!"); + await botClient.SendTextMessageAsyncNoKeyboard(callbackQuery.Message.Chat.Id, + $"Node {callbackQuery.Data} action {action}!"); - return await Task.FromResult(true); - } + return await Task.FromResult(true); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Reboot.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Reboot.cs index 9b54271..1e1d2fa 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Reboot.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Reboot.cs @@ -1,21 +1,13 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api; + +internal class Reboot: Base { - internal class Reboot: Base - { - public override string Name => "nodereboot"; - public override string Description => "Reboot node"; - protected override bool ForReboot => true; - } + public override string Name => "nodereboot"; + public override string Description => "Reboot node"; + protected override bool ForReboot => true; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Shutdown.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Shutdown.cs index dffcd87..fa5909f 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Shutdown.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Node/Shutdown.cs @@ -1,21 +1,13 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Node.Api; + +internal class Shutdown : Base { - internal class Shutdown : Base - { - public override string Name => "nodeshutdown"; - public override string Description => "Shutdown node"; - protected override bool ForReboot => false; - } + public override string Name => "nodeshutdown"; + public override string Description => "Shutdown node"; + protected override bool ForReboot => false; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Start.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Start.cs index 8346a0b..c56f186 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Start.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Start.cs @@ -1,28 +1,21 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; + +internal class Start : Help { - internal class Start : Help - { - public override bool ShowInHelp => false; - public override string Name => "start"; - public override string Description => "Start"; - protected override string GetText(Message message) - => $@"Welcome {message.Chat.FirstName} -You are connect to Proxmox VE {PveHelper.HostandPortHA} + public override bool ShowInHelp => false; + public override string Name => "start"; + public override string Description => "Start"; + protected override string GetText(Message message) + => $@"Welcome {message.Chat.FirstName} +You are connect to Proxmox VE {PveHelperInt.HostAndPortHA} {base.GetText(message)} @@ -31,5 +24,4 @@ You are connect to Proxmox VE {PveHelper.HostandPortHA} - From great power comes great responsibility. Good job"; - } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Base.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Base.cs index 3edd42b..f19eb31 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Base.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Base.cs @@ -1,48 +1,43 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.Threading.Tasks; -using Corsinvest.ProxmoxVE.Api.Extension.VM; +using Corsinvest.ProxmoxVE.Api.Extension; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; +using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; using Corsinvest.ProxmoxVE.TelegramBot.Commands.Api; using Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; using Telegram.Bot; using Telegram.Bot.Types; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api; + +internal abstract class Base : Command { - internal abstract class Base : Command - { - protected abstract StatusEnum StatusRequestVM { get; } + protected abstract VmStatus StatusRequest { get; } - public override async Task Execute(Message message, TelegramBotClient botClient) - { - await botClient.ChooseVmInlineKeyboard(message.Chat.Id, - PveHelper.GetClient(), - (StatusRequestVM == StatusEnum.Stop)); + public override async Task Execute(Message message, TelegramBotClient botClient) + { + await botClient.ChooseVmInlineKeyboard(message.Chat.Id, + await GetClient(), + StatusRequest == VmStatus.Stop); - return await Task.FromResult(false); - } + return await Task.FromResult(false); + } - public override async Task Execute(Message message, - CallbackQuery callbackQuery, - TelegramBotClient botClient) - { - var vm = PveHelper.GetClient().GetVM(callbackQuery.Data); - vm.SetStatus(StatusRequestVM, 0); + public override async Task Execute(Message message, + CallbackQuery callbackQuery, + TelegramBotClient botClient) + { + var client = await GetClient(); + var vm = await client.GetVm(callbackQuery.Data); + await VmHelper.ChangeStatusVm(client, vm.Node, vm.VmType, vm.VmId, StatusRequest); - await botClient.SendTextMessageAsyncNoKeyboard(callbackQuery.Message.Chat.Id, - $"VM/CT {vm.Id} on node {vm.Node} {StatusRequestVM}!"); + await botClient.SendTextMessageAsyncNoKeyboard(callbackQuery.Message.Chat.Id, + $"VM/CT {vm.Id} on node {vm.Node} {StatusRequest}!"); - return await Task.FromResult(true); - } + return await Task.FromResult(true); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Reset.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Reset.cs index 369b64a..013ed07 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Reset.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Reset.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ - -using Corsinvest.ProxmoxVE.Api.Extension.VM; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api +using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; + +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api; + +internal class Reset : Base { - internal class Reset : Base - { - public override string Name => "vmreset"; - public override string Description => "Reset VM/CT"; - protected override StatusEnum StatusRequestVM => StatusEnum.Reset; - } + public override string Name => "vmreset"; + public override string Description => "Reset VM/CT"; + protected override VmStatus StatusRequest => VmStatus.Reset; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Shutdown.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Shutdown.cs index d31d52a..363a032 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Shutdown.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Shutdown.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ - -using Corsinvest.ProxmoxVE.Api.Extension.VM; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api +using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; + +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api; + +internal class Shutdown : Base { - internal class Shutdown : Base - { - public override string Name => "vmshutdown"; - public override string Description => "Shutdown VM/CT"; - protected override StatusEnum StatusRequestVM => StatusEnum.Shutdown; - } + public override string Name => "vmshutdown"; + public override string Description => "Shutdown VM/CT"; + protected override VmStatus StatusRequest => VmStatus.Shutdown; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Start.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Start.cs index 441346e..803eb0f 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Start.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Start.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ - -using Corsinvest.ProxmoxVE.Api.Extension.VM; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api +using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; + +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api; + +internal class Start : Base { - internal class Start : Base - { - public override string Name => "vmstart"; - public override string Description => "Start VM/CT"; - protected override StatusEnum StatusRequestVM => StatusEnum.Start; - } + public override string Name => "vmstart"; + public override string Description => "Start VM/CT"; + protected override VmStatus StatusRequest => VmStatus.Start; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Stop.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Stop.cs index 6da0dc1..ed34682 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Stop.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Commands/Vm/Stop.cs @@ -1,23 +1,15 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ - -using Corsinvest.ProxmoxVE.Api.Extension.VM; -namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api +using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; + +namespace Corsinvest.ProxmoxVE.TelegramBot.Commands.Vm.Api; + +internal class Stop : Base { - internal class Stop : Base - { - public override string Name => "vmstop"; - public override string Description => "Stop VM/CT"; - protected override StatusEnum StatusRequestVM => StatusEnum.Stop; - } + public override string Name => "vmstop"; + public override string Description => "Stop VM/CT"; + protected override VmStatus StatusRequest => VmStatus.Stop; } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Corsinvest.ProxmoxVE.TelegramBot.Api.csproj b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Corsinvest.ProxmoxVE.TelegramBot.Api.csproj index 314986b..351bc9c 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Corsinvest.ProxmoxVE.TelegramBot.Api.csproj +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Corsinvest.ProxmoxVE.TelegramBot.Api.csproj @@ -1,9 +1,9 @@  - netstandard2.1 + net6.0 true - 1.6.0 + 1.6.1 Corsinvest Srl Daniele Corsini Corsinvest Srl @@ -12,8 +12,6 @@ Corsinvest for Proxmox VE Botgram Api ProxmoxVE;Api,Client;Rest;Corsinvest;Botgram - icon.png - LICENSE.md icon.png true @@ -33,9 +31,9 @@ - - - + + + diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/BotHelper.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/BotHelper.cs index 24f8996..290bd19 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/BotHelper.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/BotHelper.cs @@ -1,13 +1,6 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System.Collections.Generic; @@ -16,99 +9,105 @@ using System.Text; using System.Threading.Tasks; using Corsinvest.ProxmoxVE.Api; -using Corsinvest.ProxmoxVE.Api.Extension.Node; -using Corsinvest.ProxmoxVE.Api.Extension.VM; +using Corsinvest.ProxmoxVE.Api.Extension; +using Corsinvest.ProxmoxVE.Api.Shared.Models.Cluster; using Telegram.Bot; using Telegram.Bot.Types; using Telegram.Bot.Types.Enums; using Telegram.Bot.Types.InputFiles; using Telegram.Bot.Types.ReplyMarkups; -namespace Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api +namespace Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; + +internal static class BotHelper { - internal static class BotHelper + public static async Task SendTextMessageAsyncNoKeyboard(this TelegramBotClient botClient, + long chatId, + string text) + => await botClient.SendTextMessageAsync(chatId, + text, + ParseMode.Html, + replyMarkup: new ReplyKeyboardRemove()); + + public static async Task SendDocumentAsyncFromText(this TelegramBotClient botClient, + long chatId, + string text, + string fileName) { - public static async Task SendTextMessageAsyncNoKeyboard(this TelegramBotClient botClient, - long chatId, - string text) - => await botClient.SendTextMessageAsync(chatId, - text, - ParseMode.Html, - replyMarkup: new ReplyKeyboardRemove()); - - public static async Task SendDocumentAsyncFromText(this TelegramBotClient botClient, - long chatId, - string text, - string fileName) - { - using var stream = new MemoryStream(Encoding.UTF8.GetBytes(text)); - return await botClient.SendDocumentAsync(chatId, new InputOnlineFile(stream, fileName)); - } + using var stream = new MemoryStream(Encoding.UTF8.GetBytes(text)); + return await botClient.SendDocumentAsync(chatId, new InputOnlineFile(stream, fileName)); + } - public static List> CreateInlineKeyboardButtons(IEnumerable<(string Group, string Text, string CallbackData)> items) - { - var ikb = new List>(); + public static List> CreateInlineKeyboardButtons(IEnumerable<(string Group, string Text, string CallbackData)> items) + { + var ikb = new List>(); - foreach (var group in items.GroupBy(a => a.Group)) + foreach (var group in items.GroupBy(a => a.Group)) + { + var rowIKB = new List(); + foreach (var (_, Text, CallbackData) in group) { - var rowIKB = new List(); - foreach (var (_, Text, CallbackData) in group) + if (rowIKB.Count > 1) { - if (rowIKB.Count > 1) - { - ikb.Add(rowIKB); - rowIKB = new List(); - } - - rowIKB.Add(InlineKeyboardButton.WithCallbackData(Text, CallbackData)); + ikb.Add(rowIKB); + rowIKB = new List(); } - ikb.Add(rowIKB); + rowIKB.Add(InlineKeyboardButton.WithCallbackData(Text, CallbackData)); } - return ikb; + ikb.Add(rowIKB); } - public static async Task ChooseInlineKeyboard(this TelegramBotClient botClient, - long chatId, - string title, - string[] items) - => await ChooseInlineKeyboard(botClient, chatId, title, items.Select(a => ("", a, a))); + return ikb; + } - public static async Task ChooseInlineKeyboard(this TelegramBotClient botClient, - long chatId, - string title, - IEnumerable<(string Group, string Text, string CallbackData)> items) - { - await botClient.SendChatActionAsync(chatId, ChatAction.Typing); + public static async Task ChooseInlineKeyboard(this TelegramBotClient botClient, + long chatId, + string title, + string[] items) + => await ChooseInlineKeyboard(botClient, chatId, title, items.Select(a => ("", a, a))); - await botClient.SendTextMessageAsync(chatId, - title, - replyMarkup: new InlineKeyboardMarkup(CreateInlineKeyboardButtons(items))); - } + public static async Task ChooseInlineKeyboard(this TelegramBotClient botClient, + long chatId, + string title, + IEnumerable<(string Group, string Text, string CallbackData)> items) + { + await botClient.SendChatActionAsync(chatId, ChatAction.Typing); - public static async Task ChooseVmInlineKeyboard(this TelegramBotClient botClient, - long chatId, - PveClient pveClient, - bool isRunning) - { - var items = pveClient.GetVMs() - .Where(a => pveClient.GetNode(a.Node).IsOnline && a.IsRunning == isRunning) - .Select(a => (a.Node, $"{a.Id} {a.Name}", a.Id)); + await botClient.SendTextMessageAsync(chatId, + title, + replyMarkup: new InlineKeyboardMarkup(CreateInlineKeyboardButtons(items))); + } - await botClient.ChooseInlineKeyboard(chatId, "Choose Vm", items); - } + public static async Task ChooseVmInlineKeyboard(this TelegramBotClient botClient, + long chatId, + PveClient pveClient, + bool isRunning) + { + var resources = await pveClient.GetResources(ClusterResourceType.All); - public static async Task ChooseNodeInlineKeyboard(this TelegramBotClient botClient, - long chatId, - PveClient pveClient, - bool isOnline) - { - var items = pveClient.GetNodes() - .Where(a => pveClient.GetNode(a.Node).IsOnline == isOnline) - .Select(a => ("", a.Id, a.Id)); + var nodes = resources.Where(a => a.ResourceType == ClusterResourceType.Node + && a.IsOnline).Select(a => a.Node); - await botClient.ChooseInlineKeyboard(chatId, "Choose Node", items); - } + var vms = resources.Where(a => a.ResourceType == ClusterResourceType.Vm + && nodes.Contains(a.Node) + && a.IsRunning == isRunning); + + var items = vms.Select(a => (a.Node, $"{a.Id} {a.Name}", a.VmId.ToString())); + + await botClient.ChooseInlineKeyboard(chatId, "Choose Vm", items); + } + + public static async Task ChooseNodeInlineKeyboard(this TelegramBotClient botClient, + long chatId, + PveClient pveClient, + bool isOnline) + { + var items = (await pveClient.GetNodes()) + .Where(a => a.IsOnline == isOnline) + .Select(a => ("", a.Node, a.Node)); + + await botClient.ChooseInlineKeyboard(chatId, "Choose Node", items); } } \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelper.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelper.cs deleted file mode 100644 index e310796..0000000 --- a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelper.cs +++ /dev/null @@ -1,48 +0,0 @@ -/* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL - */ - -using System.IO; -using Corsinvest.ProxmoxVE.Api; -using Corsinvest.ProxmoxVE.Api.Extension.Helpers; -using Corsinvest.ProxmoxVE.Api.Metadata; - -namespace Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api -{ - internal static class PveHelper - { - private static ClassApi _classApiRoot; - - public static string HostandPortHA { get; set; } - public static string Username { get; set; } - public static string Password { get; set; } - public static string ApiToken { get; set; } - public static TextWriter Out { get; set; } - - public static ClassApi GetClassApiRoot(PveClient client) - => _classApiRoot ??= GeneretorClassApi.Generate(client.Hostname, client.Port); - - public static PveClient GetClient() - { - var client = ClientHelper.GetClientFromHA(HostandPortHA, Out); - if (string.IsNullOrWhiteSpace(ApiToken)) - { - client.Login(Username, Password); - } - else - { - client.ApiToken = ApiToken; - } - - return client; - } - } -} \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelperInt.cs b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelperInt.cs new file mode 100644 index 0000000..0f961f1 --- /dev/null +++ b/src/Corsinvest.ProxmoxVE.TelegramBot.Api/Helpers/PveHelperInt.cs @@ -0,0 +1,41 @@ +/* + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl + */ + +using System.IO; +using System.Threading.Tasks; +using Corsinvest.ProxmoxVE.Api; +using Corsinvest.ProxmoxVE.Api.Extension.Utils; +using Corsinvest.ProxmoxVE.Api.Metadata; + +namespace Corsinvest.ProxmoxVE.TelegramBot.Helpers.Api; + +internal static class PveHelperInt +{ + private static ClassApi _classApiRoot; + + public static string HostAndPortHA { get; set; } + public static string Username { get; set; } + public static string Password { get; set; } + public static string ApiToken { get; set; } + public static TextWriter Out { get; set; } + + public static async Task GetClassApiRoot(PveClient client) + => _classApiRoot ??= await GeneratorClassApi.Generate(client.Host, client.Port); + + public static async Task GetClient() + { + var client = ClientHelper.GetClientFromHA(HostAndPortHA); + if (string.IsNullOrWhiteSpace(ApiToken)) + { + await client.Login(Username, Password); + } + else + { + client.ApiToken = ApiToken; + } + + return client; + } +} \ No newline at end of file diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj b/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj index c6f37d3..4362c49 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj +++ b/src/Corsinvest.ProxmoxVE.TelegramBot/Corsinvest.ProxmoxVE.TelegramBot.csproj @@ -1,8 +1,8 @@  Exe - 1.5.1 - netcoreapp3.1 + 1.5.2 + net6.0 cv4pve-botgram Corsinvest Srl Daniele Corsini @@ -10,20 +10,16 @@ Corsinvest for Proxmox VE with Telegram Corsinvest for Proxmox VE with Telegram Corsinvest for Proxmox VE with Telegram - + true + false - - - - - - + - + diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot/Program.cs b/src/Corsinvest.ProxmoxVE.TelegramBot/Program.cs index 2d9a81a..ba54d74 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot/Program.cs +++ b/src/Corsinvest.ProxmoxVE.TelegramBot/Program.cs @@ -1,60 +1,53 @@ /* - * This file is part of the cv4pve-botgram https://github.com/Corsinvest/cv4pve-botgram, - * - * This source file is available under two different licenses: - * - GNU General Public License version 3 (GPLv3) - * - Corsinvest Enterprise License (CEL) - * Full copyright and license information is available in - * LICENSE.md which is distributed with this source code. - * - * Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL + * SPDX-License-Identifier: GPL-3.0-only + * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl */ using System; using System.Collections.Generic; +using System.CommandLine; +using System.Threading.Tasks; using Corsinvest.ProxmoxVE.Api.Shell.Helpers; using Corsinvest.ProxmoxVE.TelegramBot.Api; -using McMaster.Extensions.CommandLineUtils; -namespace Corsinvest.ProxmoxVE.TelegramBot +namespace Corsinvest.ProxmoxVE.TelegramBot; + +class Program { - class Program + static async Task Main(string[] args) { - static void Main(string[] args) - { - var app = ShellHelper.CreateConsoleApp("cv4pve-botgram", "Telegram bot for Proxmox VE"); + var app = ConsoleHelper.CreateApp("cv4pve-botgram", "Telegram bot for Proxmox VE"); - var optToken = app.Option("--token", "Telegram API token bot", CommandOptionType.SingleValue) - .DependOn(app, CommandOptionExtension.HOST_OPTION_NAME); + var optToken = app.AddOption("--token", "Telegram API token bot"); + optToken.IsRequired = true; - var optChatsId = app.Option("--chatsId", "Telegram Chats Id valid for communication (comma separated)", CommandOptionType.SingleValue); + var optChatsId = app.AddOption("--chatsId", "Telegram Chats Id valid for communication (comma separated)"); - app.OnExecute(() => + app.SetHandler(() => + { + var chatsId = new List(); + foreach (var chatId in (optChatsId.GetValue() + "").Split(",")) { - var chatsId = new List(); - foreach (var chatId in (optChatsId.Value() + "").Split(",")) - { - if (long.TryParse(chatId, out var id)) { chatsId.Add(id); } - } - - var botManager = new BotManager(app.GetHost().Value(), - app.GetApiToken().Value(), - app.GetUsername().Value(), - app.GetPasswordFromOption(), - optToken.Value(), - chatsId.ToArray(), - app.Out); - botManager.StartReceiving(); - - Console.ReadLine(); - - try { botManager.StopReceiving(); } - catch { } - - app.Out.WriteLine("End application"); - }); - - app.ExecuteConsoleApp(args); - } + if (long.TryParse(chatId, out var id)) { chatsId.Add(id); } + } + + var botManager = new BotManager(app.GetHost().GetValue(), + app.GetApiToken().GetValue(), + app.GetUsername().GetValue(), + app.GetPasswordFromOption(), + optToken.GetValue(), + chatsId.ToArray(), + Console.Out); + botManager.StartReceiving(); + + Console.ReadLine(); + + try { botManager.StopReceiving(); } + catch { } + + Console.Out.WriteLine("End application"); + }); + + await app.ExecuteApp(args); } } diff --git a/src/Corsinvest.ProxmoxVE.TelegramBot/build.ps1 b/src/Corsinvest.ProxmoxVE.TelegramBot/build.ps1 index d0bbd2d..43f48e9 100644 --- a/src/Corsinvest.ProxmoxVE.TelegramBot/build.ps1 +++ b/src/Corsinvest.ProxmoxVE.TelegramBot/build.ps1 @@ -1,12 +1,5 @@ -# This file is part of the cv4pve-bootgram https://github.com/Corsinvest/cv4pve-bootgram, -# -# This source file is available under two different licenses: -# - GNU General Public License version 3 (GPLv3) -# - Corsinvest Enterprise License (CEL) -# Full copyright and license information is available in -# LICENSE.md which is distributed with this source code. -# -# Copyright (C) 2016 Corsinvest Srl GPLv3 and CEL +# SPDX-License-Identifier: GPL-3.0-only +# SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl [System.Console]::Clear(); @@ -23,17 +16,17 @@ Write-Output " == Build System =========================================================" -$pathNet = "Bin\Release\netcoreapp3.1" +$pathNet = "Bin\Release\net6.0" Remove-Item -Path ".\$pathNet" -Recurse -Force $rids = @("linux-x64", "linux-arm", "linux-arm64", "osx-x64", "win-x86", "win-x64", "win-arm", "win-arm64") foreach ($rid in $rids) { - dotnet publish -r $rid -c Release /p:PublishSingleFile=true /p:PublishTrimmed=true + dotnet publish -r $rid -c Release /p:PublishSingleFile=true --self-contained #/p:EnableCompressionInSingleFile=true $path = "$pathNet\$rid\publish\" $fileName = Get-ChildItem $path -Exclude *.pdb -name - $fileDest = "$pathNet\$fileName-$rid.zip" + $fileDest = "$pathNet\$fileName-$rid.zip" Remove-Item $fileDest -ErrorAction SilentlyContinue Compress-Archive $path\$fileName $fileDest } \ No newline at end of file