diff --git a/.babelrc b/.babelrc index 1e86a76..4c68c50 100644 --- a/.babelrc +++ b/.babelrc @@ -1,15 +1,15 @@ -{ - "plugins": [ - "@babel/plugin-proposal-class-properties" - ], - "presets": [ - [ - "@babel/preset-env", - { - "targets": { - "node": "12" - } - } - ] - ] +{ + "plugins": [ + "@babel/plugin-proposal-class-properties" + ], + "presets": [ + [ + "@babel/preset-env", + { + "targets": { + "node": "12" + } + } + ] + ] } \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 4c44dd4..6a8f510 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,25 +1,25 @@ -// For format details, see https://aka.ms/devcontainer.json. For config options, see the -// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node -{ - "name": "Node.js & TypeScript", - // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile - "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm", - "features": { - "ghcr.io/devcontainers/features/git:1": {} - }, - - // Features to add to the dev container. More info: https://containers.dev/features. - // "features": {}, - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - // "forwardPorts": [], - - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "npm install" - - // Configure tool-specific properties. - // "customizations": {}, - - // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. - // "remoteUser": "root" -} +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node +{ + "name": "Node.js & TypeScript", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm", + "features": { + "ghcr.io/devcontainers/features/git:1": {} + }, + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Use 'postCreateCommand' to run commands after the container is created. + "postCreateCommand": "npm install" + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/.eslintignore b/.eslintignore index 24fa511..7ef9dab 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,3 @@ -!.eslintrc.js -/node_modules/** -/lib/** +!.eslintrc.js +/node_modules/** +/lib/** diff --git a/.eslintrc.json b/.eslintrc.json index 86c86f3..53e6e82 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -1,30 +1,33 @@ -{ - "root": true, - "parser": "@typescript-eslint/parser", - "parserOptions": { - "ecmaVersion": 6, - "sourceType": "module" - }, - "plugins": [ - "@typescript-eslint" - ], - "rules": { - "@typescript-eslint/naming-convention": [ - "warn", - { - "selector": "import", - "format": [ "camelCase", "PascalCase" ] - } - ], - "@typescript-eslint/semi": "warn", - "curly": "warn", - "eqeqeq": "warn", - "no-throw-literal": "warn", - "semi": "off" - }, - "ignorePatterns": [ - "out", - "dist", - "**/*.d.ts" - ] +{ + "root": true, + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 6, + "sourceType": "module" + }, + "plugins": [ + "@typescript-eslint" + ], + "rules": { + "@typescript-eslint/naming-convention": [ + "warn", + { + "selector": "import", + "format": [ + "camelCase", + "PascalCase" + ] + } + ], + "@typescript-eslint/semi": "off", //关闭分号检查 + "curly": "warn", + "eqeqeq": "warn", + "no-throw-literal": "warn", + "semi": "off" + }, + "ignorePatterns": [ + "out", + "dist", + "**/*.d.ts" + ] } \ No newline at end of file diff --git a/.gitignore b/.gitignore index 1b68154..b8e9b20 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,9 @@ -/node_modules/ -/dist -*.vsix -yarn.lock -package-lock.json -*.dict -.vscode/settings.json -*.DS_Store +/node_modules/ +/dist +*.vsix +yarn.lock +package-lock.json +*.dict +.vscode/settings.json +*.DS_Store /tmp \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json index e056382..bd3e7d6 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -1,26 +1,26 @@ -// A launch configuration that launches the extension inside a new window -{ - "version": "0.1.0", - "configurations": [ - { - "name": "Launch Extension", - "type": "extensionHost", - "request": "launch", - "args": ["--extensionDevelopmentPath=${workspaceRoot}"], - "sourceMaps": true, - "preLaunchTask": "npm: build", - "outFiles": ["${workspaceFolder}/dist/**/*.js"], - }, - { - "name": "Launch Tests", - "type": "extensionHost", - "request": "launch", - "runtimeExecutable": "${execPath}", - "args": [ - "--extensionDevelopmentPath=${workspaceRoot}", - "--extensionTestsPath=${workspaceRoot}/test" - ], - "preLaunchTask": "npm: build", - } - ] -} +// A launch configuration that launches the extension inside a new window +{ + "version": "0.1.0", + "configurations": [ + { + "name": "Launch Extension", + "type": "extensionHost", + "request": "launch", + "args": ["--extensionDevelopmentPath=${workspaceRoot}"], + "sourceMaps": true, + "preLaunchTask": "npm: build", + "outFiles": ["${workspaceFolder}/dist/**/*.js"], + }, + { + "name": "Launch Tests", + "type": "extensionHost", + "request": "launch", + "runtimeExecutable": "${execPath}", + "args": [ + "--extensionDevelopmentPath=${workspaceRoot}", + "--extensionTestsPath=${workspaceRoot}/test" + ], + "preLaunchTask": "npm: build", + } + ] +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 2c7b5b9..c0894d2 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -1,34 +1,34 @@ -{ - "version": "2.0.0", - "tasks": [ - { - "type": "npm", - "script": "build", - "group": "build", - "problemMatcher": [], - "label": "npm: build", - "detail": "webpack --mode production" - }, - { - "type": "npm", - "script": "package", - "problemMatcher": [], - "label": "npm: package", - "detail": "webpack --mode production && vsce package" - }, - { - "type": "npm", - "script": "watch", - "problemMatcher": [], - "label": "npm: watch", - "detail": "webpack --mode production --watch" - }, - { - "type": "npm", - "script": "format", - "problemMatcher": [], - "label": "npm: format", - "detail": "eslint src --ext ts" - }, - ] +{ + "version": "2.0.0", + "tasks": [ + { + "type": "npm", + "script": "build", + "group": "build", + "problemMatcher": [], + "label": "npm: build", + "detail": "webpack --mode production" + }, + { + "type": "npm", + "script": "package", + "problemMatcher": [], + "label": "npm: package", + "detail": "webpack --mode production && vsce package" + }, + { + "type": "npm", + "script": "watch", + "problemMatcher": [], + "label": "npm: watch", + "detail": "webpack --mode production --watch" + }, + { + "type": "npm", + "script": "format", + "problemMatcher": [], + "label": "npm: format", + "detail": "eslint src --ext ts" + }, + ] } \ No newline at end of file diff --git a/.vscodeignore b/.vscodeignore index 7c5fd92..95e2ecf 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -1,8 +1,8 @@ -.vscode/** -.vscode-test/** -src/** -test/** -.babelrc -.eslintignore -.eslintrc.js -.gitignore +.vscode/** +.vscode-test/** +src/** +test/** +.babelrc +.eslintignore +.eslintrc.js +.gitignore diff --git a/LICENSE b/LICENSE index dbbe355..80a61fa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,661 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.en.md b/README.en.md index 70d70fc..b314677 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,36 @@ -# DevStar - -#### Description -Super IDE Client for VS Code - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +# DevStar + +#### Description +Super IDE Client for VS Code + +#### Software Architecture +Software architecture description + +#### Installation + +1. xxxx +2. xxxx +3. xxxx + +#### Instructions + +1. xxxx +2. xxxx +3. xxxx + +#### Contribution + +1. Fork the repository +2. Create Feat_xxx branch +3. Commit your code +4. Create Pull Request + + +#### Gitee Feature + +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index 617cd6c..ff56c85 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,84 @@ -# DevStar - -## User Quick Start - -进入home页面,home页面的功能都需要登录后才能使用。 - -登录后,登录状态会长久保存,直到主动退出登录或者卸载插件。 - -### 可供配置的字段 - -- Devstar Domain(注意点:`https://devstar.cn`和`http://localhost:3000`的协议头`https`和`http`不能写错或写反,否则会出现页面无反应的异常。) - -注意: - -1)配置修改后,重启vscode才能生效; - -### 创建新仓库/创建新项目 - -目前可供选择的字段 - -- name* 必填 -- default_branch -- description -- gitignores -- issue_labels -- license -- object_format_name -- private -- readme -- template -- trust_model - -### 打开项目 - -打开项目是指在vscode上打开远程容器中创建好的项目。选择项目名称右侧对应的Open project,即可打开项目。 - -### 编译/调试 - -容器环境提供了开发环境,安装好编译与调试所需要的工具链。 - -## Developer Quick Start - -### 准备开发环境 - -#### Windows/MacOS/Linux - -需要预置开发环境:Nodejs、Typescript开发环境 - -1. git clone项目到本地,然后通过VSCode打开项目。 -2. 下载项目所需依赖,执行命令:`npm install`。 - -#### DevContainer环境 - -1. git clone项目到本地,然后通过VSCode打开项目 -2. 项目提供了devcontainer的开发配置,通过vscode打开本项目后,会提示“Folder contains a Dev Container configuration file. Reopen folder to develop in a container ([learn more](https://aka.ms/vscode-remote/docker)).”,此时点击“Reopen in Container”,自动进入vscode的devcontainer环境中。 -3. 本项目的devcontainer预置了Node.js & Typescript的开发环境。在vscode的命令行工具执行`npm install`命令,下载项目所需依赖。 - -### 编译插件 - -1. 项目目录`.vscode/launch.json`中提供了编译与启动插件的配置。 -2. 按`F5`即可编译和测试插件。 - -### 打包&发布插件 - -1. 打包和发布插件均需要用到`@vscode/vsce`包,项目依赖中已包含。 -2. 打包插件 - 1. 方法一:通过Ctrl+Shift+P启动Command Palette,选择Tasks: Run Task,然后选择最下方的Show All Tasks...,最后选择npm: vscode:package。 - 2. 方法二:打开package.json文件,找到`scripts`字段,它上方有`Debug`按钮,点击之后会让你选择要执行的task,选择vscode:package。 -3. 发布插件 - 1. 发布之前需要先完成打包。 - 2. 发布插件需要publisher的Personal Access Token(token项目负责人)。(Token**有效时间**:1年) - 3. 发布方法 - 1. 方法一:步骤与打包插件的方法一基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 - 2. 方法二:步骤与打包插件的方法二基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 - -### 特殊:Git - -由于先在主机上clone下来项目,在devcontainer上再打开以后,git认为所有的文件都更改了。需要在`.git/config`添加如下的配置: - -```bash -[core] - - filemode = false - - autocrlf = true +# DevStar + +## User Quick Start + +进入home页面,home页面的功能都需要登录后才能使用。 + +登录后,登录状态会长久保存,直到主动退出登录或者卸载插件。 + +### 可供配置的字段 + +- Devstar Domain(注意点:`https://devstar.cn`和`http://localhost:3000`的协议头`https`和`http`不能写错或写反,否则会出现页面无反应的异常。) + +注意: + +1)配置修改后,重启vscode才能生效; + +### 创建新仓库/创建新项目 + +目前可供选择的字段 + +- name* 必填 +- default_branch +- description +- gitignores +- issue_labels +- license +- object_format_name +- private +- readme +- template +- trust_model + +### 打开项目 + +打开项目是指在vscode上打开远程容器中创建好的项目。选择项目名称右侧对应的Open project,即可打开项目。 + +### 编译/调试 + +容器环境提供了开发环境,安装好编译与调试所需要的工具链。 + +## Developer Quick Start + +### 准备开发环境 + +#### Windows/MacOS/Linux + +需要预置开发环境:Nodejs、Typescript开发环境 + +1. git clone项目到本地,然后通过VSCode打开项目。 +2. 下载项目所需依赖,执行命令:`npm install`。 + +#### DevContainer环境 + +1. git clone项目到本地,然后通过VSCode打开项目 +2. 项目提供了devcontainer的开发配置,通过vscode打开本项目后,会提示“Folder contains a Dev Container configuration file. Reopen folder to develop in a container ([learn more](https://aka.ms/vscode-remote/docker)).”,此时点击“Reopen in Container”,自动进入vscode的devcontainer环境中。 +3. 本项目的devcontainer预置了Node.js & Typescript的开发环境。在vscode的命令行工具执行`npm install`命令,下载项目所需依赖。 + +### 编译插件 + +1. 项目目录`.vscode/launch.json`中提供了编译与启动插件的配置。 +2. 按`F5`即可编译和测试插件。 + +### 打包&发布插件 + +1. 打包和发布插件均需要用到`@vscode/vsce`包,项目依赖中已包含。 +2. 打包插件 + 1. 方法一:通过Ctrl+Shift+P启动Command Palette,选择Tasks: Run Task,然后选择最下方的Show All Tasks...,最后选择npm: vscode:package。 + 2. 方法二:打开package.json文件,找到`scripts`字段,它上方有`Debug`按钮,点击之后会让你选择要执行的task,选择vscode:package。 +3. 发布插件 + 1. 发布之前需要先完成打包。 + 2. 发布插件需要publisher的Personal Access Token(token项目负责人)。(Token**有效时间**:1年) + 3. 发布方法 + 1. 方法一:步骤与打包插件的方法一基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 + 2. 方法二:步骤与打包插件的方法二基本一样,除了最后一步选择npm: vscode:publish。接着会弹出要求填写Personal Access Token的prompt,填上回车即可。 + +### 特殊:Git + +由于先在主机上clone下来项目,在devcontainer上再打开以后,git认为所有的文件都更改了。需要在`.git/config`添加如下的配置: + +```bash +[core] + - filemode = false + - autocrlf = true ``` \ No newline at end of file diff --git a/docs/developer_manual.md b/docs/developer_manual.md index cf9afd2..99d9eee 100644 --- a/docs/developer_manual.md +++ b/docs/developer_manual.md @@ -1,44 +1,44 @@ -## 项目结构 - -`package.json` - -- 插件基本信息 -- 插件的命令、对外开放的接口 -- 插件的activity bar、status bar -- scripts -- 项目配置、依赖 - -`tsconfig.json`、`webpack.config.js` - -- ts编译为js的配置 - -assets目录 - -- 静态资源 - -源文件 - -- `main.ts`:负责构建插件、构建插件过程的操作,activate/deactivate插件 -- `home.ts`:负责与home页面相关的操作,如构建home页面(webview)、作为home页面与vscode交互的桥梁 - - home页面 - embedded.html -- views目录:负责vscode中除home页面的其他界面设计 - - `quick-access-tree.ts`负责左侧快速访问栏 -- `remote-container.ts`:负责与remote container相关的操作,如第一次连接容器、打开容器中的项目文件夹 -- `utils.ts`:一些通用函数 - - - -.devcontainer目录 - -- devcontainer相关配置 - -.vscode目录 - -- `launch.json`:(编译)启动插件配置 - - -## 模块 - -Remote container - +## 项目结构 + +`package.json` + +- 插件基本信息 +- 插件的命令、对外开放的接口 +- 插件的activity bar、status bar +- scripts +- 项目配置、依赖 + +`tsconfig.json`、`webpack.config.js` + +- ts编译为js的配置 + +assets目录 + +- 静态资源 + +源文件 + +- `main.ts`:负责构建插件、构建插件过程的操作,activate/deactivate插件 +- `home.ts`:负责与home页面相关的操作,如构建home页面(webview)、作为home页面与vscode交互的桥梁 + - home页面 - embedded.html +- views目录:负责vscode中除home页面的其他界面设计 + - `quick-access-tree.ts`负责左侧快速访问栏 +- `remote-container.ts`:负责与remote container相关的操作,如第一次连接容器、打开容器中的项目文件夹 +- `utils.ts`:一些通用函数 + + + +.devcontainer目录 + +- devcontainer相关配置 + +.vscode目录 + +- `launch.json`:(编译)启动插件配置 + + +## 模块 + +Remote container + Home \ No newline at end of file diff --git a/l10n/bundle.l10n.zh-CN.json b/l10n/bundle.l10n.zh-CN.json index 2cab5e9..6944b83 100644 --- a/l10n/bundle.l10n.zh-CN.json +++ b/l10n/bundle.l10n.zh-CN.json @@ -1,13 +1,13 @@ -{ - "Home": "主页", - "DevStar Home": "DevStar主页", - "Open": "打开主页", - "Miscellaneous": "杂项", - "Clean": "清理", - "User login successfully!":"用户已登录!", - "User has logged out!":"用户已登出!", - "Installing vscode-server and devstar extension in container": "正在容器中安装vscode-server及devstar插件", - "Connected! Start installation": "连接成功,开始安装", - "Installation completed!": "安装完成!", - "Project has been open!": "该项目已经打开!" +{ + "Home": "主页", + "DevStar Home": "DevStar主页", + "Open": "打开主页", + "Miscellaneous": "杂项", + "Clean": "清理", + "User login successfully!":"用户已登录!", + "User has logged out!":"用户已登出!", + "Installing vscode-server and devstar extension in container": "正在容器中安装vscode-server及devstar插件", + "Connected! Start installation": "连接成功,开始安装", + "Installation completed!": "安装完成!", + "Project has been open!": "该项目已经打开!" } \ No newline at end of file diff --git a/package.json b/package.json index b6bdf5d..87e0b37 100644 --- a/package.json +++ b/package.json @@ -1,139 +1,139 @@ -{ - "name": "devstar", - "displayName": "%displayName%", - "description": "%description%", - "version": "0.3.8", - "keywords": [], - "publisher": "mengning", - "engines": { - "vscode": "^1.75.0" - }, - "l10n": "./l10n", - "license": "Apache-2.0", - "categories": [], - "main": "./dist/extension", - "icon": "assets/images/devstar-logo.png", - "bugs": { - "url": "https://github.com/mengning/DevStar/issues" - }, - "repository": { - "type": "git", - "url": "https://github.com/mengning/DevStar.git" - }, - "activationEvents": [ - "onView:devstar.quickAccess", - "onCommand:devstar.showHome", - "onUri" - ], - "contributes": { - "commands": [ - { - "command": "devstar.showHome", - "title": "%devstar.showHome.title%", - "category": "DevStar" - }, - { - "command": "devstar.connectRemoteContainer", - "title": "%devstar.connectRemoteContainer.title%", - "category": "DevStar" - } - ], - "uriHandlers": [ - { - "protocol": "vscode", - "path": "/openProject" - } - ], - "views": { - "devstarListView": [ - { - "id": "devstar.quickAccess", - "name": "%devstar.quickAccess.title%", - "type": "tree" - } - ] - }, - "viewsContainers": { - "activitybar": [ - { - "id": "devstarListView", - "title": "%devstar.devstar.title%", - "icon": "assets/icons/devstar-activity-icon.svg" - } - ] - }, - "viewsWelcome": [ - { - "view": "devstar.quickAccess", - "contents": "%devstar.welcome.title%" - } - ], - "menus": { - "file/newFile": [ - { - "command": "devstar.showHome", - "group": "navigation" - } - ], - "touchBar": [] - }, - "configuration": { - "type": "object", - "title": "DevStar", - "properties": { - "devstar.disableDevStarHomeStartup": { - "type": "boolean", - "default": false, - "description": "Disable showing DevStar Home at startup" - }, - "devstar.devstarDomain": { - "type": "string", - "default": "https://devstar.cn/", - "description": "DevStar Domain URL" - } - } - } - }, - "scripts": { - "build": "webpack --mode production", - "package": "webpack --mode production && vsce package", - "publish": "vsce publish", - "watch": "webpack --mode production --watch", - "format": "eslint src --ext ts" - }, - "dependencies": { - "axios": "^1.7.9", - "cheerio": "^1.0.0", - "fs-plus": "~3.1.1", - "node-ssh": "^13.2.0", - "semver": "^7.7.2", - "sshpk": "^1.18.0" - }, - "devDependencies": { - "@babel/core": "~7.21.3", - "@babel/eslint-parser": "~7.21.3", - "@babel/plugin-proposal-class-properties": "~7.18.6", - "@babel/plugin-proposal-object-rest-spread": "~7.18.9", - "@babel/preset-env": "~7.20.2", - "@babel/preset-typescript": "^7.18.6", - "@types/mocha": "^10.0.6", - "@types/node": "18.x", - "@types/vscode": "~1.75.0", - "@typescript-eslint/eslint-plugin": "^7.11.0", - "@typescript-eslint/parser": "^7.11.0", - "@vscode/test-cli": "^0.0.9", - "@vscode/test-electron": "^2.4.0", - "@vscode/vsce": "^2.29.0", - "babel-loader": "~9.1.2", - "eslint-import-resolver-webpack": "~0.13.2", - "eslint-plugin-import": "~2.27.5", - "prettier": "~2.8.4", - "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "~5.76.2", - "webpack-cli": "~5.0.1" - }, - "extensionDependencies": [ - "ms-vscode.cpptools" - ] -} +{ + "name": "devstar", + "displayName": "%displayName%", + "description": "%description%", + "version": "0.3.8", + "keywords": [], + "publisher": "mengning", + "engines": { + "vscode": "^1.75.0" + }, + "l10n": "./l10n", + "license": "Apache-2.0", + "categories": [], + "main": "./dist/extension", + "icon": "assets/images/devstar-logo.png", + "bugs": { + "url": "https://github.com/mengning/DevStar/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/mengning/DevStar.git" + }, + "activationEvents": [ + "onView:devstar.quickAccess", + "onCommand:devstar.showHome", + "onUri" + ], + "contributes": { + "commands": [ + { + "command": "devstar.showHome", + "title": "%devstar.showHome.title%", + "category": "DevStar" + }, + { + "command": "devstar.connectRemoteContainer", + "title": "%devstar.connectRemoteContainer.title%", + "category": "DevStar" + } + ], + "uriHandlers": [ + { + "protocol": "vscode", + "path": "/openProject" + } + ], + "views": { + "devstarListView": [ + { + "id": "devstar.quickAccess", + "name": "%devstar.quickAccess.title%", + "type": "tree" + } + ] + }, + "viewsContainers": { + "activitybar": [ + { + "id": "devstarListView", + "title": "%devstar.devstar.title%", + "icon": "assets/icons/devstar-activity-icon.svg" + } + ] + }, + "viewsWelcome": [ + { + "view": "devstar.quickAccess", + "contents": "%devstar.welcome.title%" + } + ], + "menus": { + "file/newFile": [ + { + "command": "devstar.showHome", + "group": "navigation" + } + ], + "touchBar": [] + }, + "configuration": { + "type": "object", + "title": "DevStar", + "properties": { + "devstar.disableDevStarHomeStartup": { + "type": "boolean", + "default": false, + "description": "Disable showing DevStar Home at startup" + }, + "devstar.devstarDomain": { + "type": "string", + "default": "https://devstar.cn/", + "description": "DevStar Domain URL" + } + } + } + }, + "scripts": { + "build": "webpack --mode production", + "package": "webpack --mode production && vsce package", + "publish": "vsce publish", + "watch": "webpack --mode production --watch", + "format": "eslint src --ext ts" + }, + "dependencies": { + "axios": "^1.7.9", + "cheerio": "^1.0.0", + "fs-plus": "~3.1.1", + "node-ssh": "^13.2.0", + "semver": "^7.7.2", + "sshpk": "^1.18.0" + }, + "devDependencies": { + "@babel/core": "~7.21.3", + "@babel/eslint-parser": "~7.21.3", + "@babel/plugin-proposal-class-properties": "~7.18.6", + "@babel/plugin-proposal-object-rest-spread": "~7.18.9", + "@babel/preset-env": "~7.20.2", + "@babel/preset-typescript": "^7.18.6", + "@types/mocha": "^10.0.6", + "@types/node": "18.x", + "@types/vscode": "~1.75.0", + "@typescript-eslint/eslint-plugin": "^7.11.0", + "@typescript-eslint/parser": "^7.11.0", + "@vscode/test-cli": "^0.0.9", + "@vscode/test-electron": "^2.4.0", + "@vscode/vsce": "^2.29.0", + "babel-loader": "~9.1.2", + "eslint-import-resolver-webpack": "~0.13.2", + "eslint-plugin-import": "~2.27.5", + "prettier": "~2.8.4", + "ts-loader": "^9.5.1", + "typescript": "^5.4.5", + "webpack": "~5.76.2", + "webpack-cli": "~5.0.1" + }, + "extensionDependencies": [ + "ms-vscode.cpptools" + ] +} diff --git a/package.nls.json b/package.nls.json index 78ecfb6..3ae9ccc 100644 --- a/package.nls.json +++ b/package.nls.json @@ -1,9 +1,9 @@ -{ - "displayName": "DevStar", - "description": "DevStar Client", - "devstar.showHome.title": "DevStar Home", - "devstar.connectRemoteContainer.title": "Connect to a Remote Container", - "devstar.quickAccess.title": "Quick Access", - "devstar.devstar.title":"DevStar", - "devstar.welcome.title":"welcome DevStar..." +{ + "displayName": "DevStar", + "description": "DevStar Client", + "devstar.showHome.title": "DevStar Home", + "devstar.connectRemoteContainer.title": "Connect to a Remote Container", + "devstar.quickAccess.title": "Quick Access", + "devstar.devstar.title":"DevStar", + "devstar.welcome.title":"welcome DevStar..." } \ No newline at end of file diff --git a/package.nls.zh-CN.json b/package.nls.zh-CN.json index a9a1de5..64a1ddf 100644 --- a/package.nls.zh-CN.json +++ b/package.nls.zh-CN.json @@ -1,9 +1,9 @@ -{ - "displayName": "DevStar", - "description": "DevStar客户端", - "devstar.showHome.title": "显示主页", - "devstar.connectRemoteContainer.title": "连接容器", - "devstar.quickAccess.title": "快速访问", - "devstar.devstar.title":"DevStar", - "devstar.welcome.title":"欢迎使用DevStar..." +{ + "displayName": "DevStar", + "description": "DevStar客户端", + "devstar.showHome.title": "显示主页", + "devstar.connectRemoteContainer.title": "连接容器", + "devstar.quickAccess.title": "快速访问", + "devstar.devstar.title":"DevStar", + "devstar.welcome.title":"欢迎使用DevStar..." } \ No newline at end of file diff --git a/src/devstar-api.ts b/src/devstar-api.ts index 76053f2..51dc394 100644 --- a/src/devstar-api.ts +++ b/src/devstar-api.ts @@ -1,99 +1,99 @@ -import * as os from 'os'; - -import User from "./user"; -import * as utils from './utils'; - -export default class DevstarAPIHandler { - - private devstarDomain: string; - - constructor() { - // 获取domain - const devstarDomainFromUserConfig = utils.devstarDomain() - if (undefined == devstarDomainFromUserConfig || "" == devstarDomainFromUserConfig) { - this.devstarDomain = "https://devstar.cn"; - } else { - this.devstarDomain = devstarDomainFromUserConfig.endsWith('/') ? devstarDomainFromUserConfig.slice(0, -1) : devstarDomainFromUserConfig; - } - } - - public async verifyToken(token: string, username: string): Promise { - try { - const response = await fetch(this.devstarDomain + `/api/devcontainer/user`, { - method: 'GET', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'token ' + token - } - }); - - // 处理非200响应状态码 - if (!response.ok) { - const text = await response.text(); // 先读取文本防止json解析失败 - if (response.status == 401) { - throw new Error('Token错误') - } else { - throw new Error(`HTTP Error: ${response.status} - ${text}`); - } - } - - const responseData = await response.json(); - const data = responseData.data - if (data.username == undefined || data.username == "") { - throw new Error('Token对应用户不存在') - } else { - // 验证用户名匹配 - if (data.username !== username) { - throw new Error('Token与用户名不符'); - } - } - - return true; - } catch (error) { - console.error(error) - return false - } - } - - // 上传公钥 - public async uploadUserPublicKey(user: User): Promise { - return new Promise(async (resolve) => { - // 获取机器名称 - const machineName = os.hostname(); - // 组成公钥名称 - const timestamp = Date.now(); - const keyTitle = `${user.getUsernameFromLocal()}-${machineName}-${timestamp}` - const postData = { - "key": user.getUserPublicKey(), - "title": keyTitle - } - - const uploadUrl = this.devstarDomain + `/api/v1/user/keys` - - // 上传公钥 - fetch(uploadUrl, { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Authorization': 'token ' + user.getUserTokenFromLocal() - }, - body: JSON.stringify(postData) - }) - .then(response => { - response.json().then(data => { - if (response.ok) { - console.log("Successfully upload new created public key.\n", data) - resolve("ok") - } else { - throw new Error(`Failed to upload new created public key!\nError: ${data.message}`) - } - }) - }) - .catch(error => { - console.error(error); - }); - - }) - } -} - +import * as os from 'os'; + +import User from "./user"; +import * as utils from './utils'; + +export default class DevstarAPIHandler { + + private devstarDomain: string; + + constructor() { + // 获取domain + const devstarDomainFromUserConfig = utils.devstarDomain() + if (undefined == devstarDomainFromUserConfig || "" == devstarDomainFromUserConfig) { + this.devstarDomain = "https://devstar.cn"; + } else { + this.devstarDomain = devstarDomainFromUserConfig.endsWith('/') ? devstarDomainFromUserConfig.slice(0, -1) : devstarDomainFromUserConfig; + } + } + + public async verifyToken(token: string, username: string): Promise { + try { + const response = await fetch(this.devstarDomain + `/api/devcontainer/user`, { + method: 'GET', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'token ' + token + } + }); + + // 处理非200响应状态码 + if (!response.ok) { + const text = await response.text(); // 先读取文本防止json解析失败 + if (response.status == 401) { + throw new Error('Token错误') + } else { + throw new Error(`HTTP Error: ${response.status} - ${text}`); + } + } + + const responseData = await response.json(); + const data = responseData.data + if (data.username == undefined || data.username == "") { + throw new Error('Token对应用户不存在') + } else { + // 验证用户名匹配 + if (data.username !== username) { + throw new Error('Token与用户名不符'); + } + } + + return true; + } catch (error) { + console.error(error) + return false + } + } + + // 上传公钥 + public async uploadUserPublicKey(user: User): Promise { + return new Promise(async (resolve) => { + // 获取机器名称 + const machineName = os.hostname(); + // 组成公钥名称 + const timestamp = Date.now(); + const keyTitle = `${user.getUsernameFromLocal()}-${machineName}-${timestamp}` + const postData = { + "key": user.getUserPublicKey(), + "title": keyTitle + } + + const uploadUrl = this.devstarDomain + `/api/v1/user/keys` + + // 上传公钥 + fetch(uploadUrl, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'Authorization': 'token ' + user.getUserTokenFromLocal() + }, + body: JSON.stringify(postData) + }) + .then(response => { + response.json().then(data => { + if (response.ok) { + console.log("Successfully upload new created public key.\n", data) + resolve("ok") + } else { + throw new Error(`Failed to upload new created public key!\nError: ${data.message}`) + } + }) + }) + .catch(error => { + console.error(error); + }); + + }) + } +} + diff --git a/src/home.ts b/src/home.ts index 38cc942..cc06c88 100644 --- a/src/home.ts +++ b/src/home.ts @@ -1,246 +1,246 @@ -import * as vscode from 'vscode'; -import * as os from 'os'; -import RemoteContainer from './remote-container'; -import User from './user'; -import * as utils from './utils' - -export default class DSHome { - private context: vscode.ExtensionContext; - private remoteContainer: RemoteContainer; - private user: User; - private devstarHomePageUrl: string; - private devstarDomain: string | undefined - - constructor(context: vscode.ExtensionContext, user: User) { - this.context = context; - this.user = user; - this.remoteContainer = new RemoteContainer(user); - - this.devstarDomain = utils.devstarDomain() - if (undefined == this.devstarDomain || "" == this.devstarDomain) { - this.devstarHomePageUrl = "https://devstar.cn/devstar-home" - } else { - this.devstarHomePageUrl = this.devstarDomain.endsWith('/') ? this.devstarDomain + "devstar-home" : this.devstarDomain + "/devstar-home" - } - } - - async toggle(devstarHomePageUrl: string = this.devstarHomePageUrl) { - const panel = vscode.window.createWebviewPanel( - 'homeWebview', - vscode.l10n.t('Home'), - vscode.ViewColumn.One, - { - enableScripts: true, - retainContextWhenHidden: true, - } - ); - - panel.webview.html = await this.getWebviewContent(devstarHomePageUrl); - - panel.webview.onDidReceiveMessage( - async (message) => { - const data = message.data - const need_return = message.need_return - if (need_return) { - // ================= need return ==================== - switch (message.command) { - // ----------------- frequent ----------------------- - case 'getHomeConfig': - const config = { - language: vscode.env.language - } - panel.webview.postMessage({command: 'getHomeConfig', data: {homeConfig: config}}) - break; - case 'getUserToken': - const userToken = this.user.getUserTokenFromLocal() - if (userToken === undefined) { - panel.webview.postMessage({ command: 'getUserToken', data: { userToken: '' } }) - break; - } else { - panel.webview.postMessage({ command: 'getUserToken', data: { userToken: userToken } }) - break; - } - case 'getUsername': - const username = this.user.getUsernameFromLocal() - if (username === undefined) { - panel.webview.postMessage({ command: 'getUsername', data: { username: '' } }) - break; - } else { - panel.webview.postMessage({ command: 'getUsername', data: { username: username } }) - break; - } - case 'firstOpenRemoteFolder': - // data.host - project name - await this.remoteContainer.firstOpenProject(data.host, data.hostname, data.port, data.username, data.path, this.context) - break; - case 'openRemoteFolder': - this.remoteContainer.openRemoteFolder(data.host, data.port, data.username, data.path); - break; - case 'getDevstarDomain': - panel.webview.postMessage({ command: 'getDevstarDomain', data: { devstarDomain: this.devstarDomain } }) - break; - // ----------------- not frequent ----------------------- - case 'setUserToken': - this.user.setUserTokenToLocal(data.userToken) - if (data.userToken === this.user.getUserTokenFromLocal()) { - panel.webview.postMessage({ command: 'setUserToken', data: { ok: true } }) - break; - } else { - panel.webview.postMessage({ command: 'setUserToken', data: { ok: false } }) - break; - } - case 'setUsername': - this.user.setUsernameToLocal(data.username); - if (data.username === this.user.getUsernameFromLocal()) { - panel.webview.postMessage({ command: 'setUsername', data: { ok: true } }); - break; - } else { - panel.webview.postMessage({ command: 'setUsername', data: { ok: false } }); - break; - } - case 'getUserPublicKey': - var userPublicKey = ''; - if (this.user.existUserPrivateKey()) { - userPublicKey = this.user.getUserPublicKey(); - panel.webview.postMessage({ command: 'getUserPublicKey', data: { userPublicKey: userPublicKey } }) - break; - } else { - panel.webview.postMessage({ command: 'getUserPublicKey', data: { userPublicKey: userPublicKey } }) - break; - } - case 'createUserPublicKey': - await this.user.createUserSSHKey(); - if (this.user.existUserPublicKey()) { - panel.webview.postMessage({ command: 'createUserPublicKey', data: { ok: true } }) - break; - } else { - panel.webview.postMessage({ command: 'createUserPublicKey', data: { ok: false } }) - break; - } - case 'getMachineName': - const machineName = os.hostname(); - panel.webview.postMessage({ command: 'getMachineName', data: { machineName: machineName } }) - } - } else { - // ================= don't need return ============== - // frequent - switch (message.command) { - // ----------------- frequent ----------------------- - case 'showInformationNotification': - vscode.window.showInformationMessage(data.message); - break; - case 'showWarningNotification': - vscode.window.showWarningMessage(data.message) - break; - case 'showErrorNotification': - await utils.showErrorNotification(data.message) - break; - } - } - }, - undefined, - this.context.subscriptions - ); - - this.context.subscriptions.push(panel) - } - - - async getWebviewContent(devstarHomePageUrl: string): Promise { - return ` - - - - - - - - DevStar Home - - - - - - - - - ` - } -} +import * as vscode from 'vscode'; +import * as os from 'os'; +import RemoteContainer from './remote-container'; +import User from './user'; +import * as utils from './utils' + +export default class DSHome { + private context: vscode.ExtensionContext; + private remoteContainer: RemoteContainer; + private user: User; + private devstarHomePageUrl: string; + private devstarDomain: string | undefined + + constructor(context: vscode.ExtensionContext, user: User) { + this.context = context; + this.user = user; + this.remoteContainer = new RemoteContainer(user); + + this.devstarDomain = utils.devstarDomain() + if (undefined == this.devstarDomain || "" == this.devstarDomain) { + this.devstarHomePageUrl = "https://devstar.cn/devstar-home" + } else { + this.devstarHomePageUrl = this.devstarDomain.endsWith('/') ? this.devstarDomain + "devstar-home" : this.devstarDomain + "/devstar-home" + } + } + + async toggle(devstarHomePageUrl: string = this.devstarHomePageUrl) { + const panel = vscode.window.createWebviewPanel( + 'homeWebview', + vscode.l10n.t('Home'), + vscode.ViewColumn.One, + { + enableScripts: true, + retainContextWhenHidden: true, + } + ); + + panel.webview.html = await this.getWebviewContent(devstarHomePageUrl); + + panel.webview.onDidReceiveMessage( + async (message) => { + const data = message.data + const need_return = message.need_return + if (need_return) { + // ================= need return ==================== + switch (message.command) { + // ----------------- frequent ----------------------- + case 'getHomeConfig': + const config = { + language: vscode.env.language + } + panel.webview.postMessage({command: 'getHomeConfig', data: {homeConfig: config}}) + break; + case 'getUserToken': + const userToken = this.user.getUserTokenFromLocal() + if (userToken === undefined) { + panel.webview.postMessage({ command: 'getUserToken', data: { userToken: '' } }) + break; + } else { + panel.webview.postMessage({ command: 'getUserToken', data: { userToken: userToken } }) + break; + } + case 'getUsername': + const username = this.user.getUsernameFromLocal() + if (username === undefined) { + panel.webview.postMessage({ command: 'getUsername', data: { username: '' } }) + break; + } else { + panel.webview.postMessage({ command: 'getUsername', data: { username: username } }) + break; + } + case 'firstOpenRemoteFolder': + // data.host - project name + await this.remoteContainer.firstOpenProject(data.host, data.hostname, data.port, data.username, data.path, this.context) + break; + case 'openRemoteFolder': + this.remoteContainer.openRemoteFolder(data.host, data.port, data.username, data.path); + break; + case 'getDevstarDomain': + panel.webview.postMessage({ command: 'getDevstarDomain', data: { devstarDomain: this.devstarDomain } }) + break; + // ----------------- not frequent ----------------------- + case 'setUserToken': + this.user.setUserTokenToLocal(data.userToken) + if (data.userToken === this.user.getUserTokenFromLocal()) { + panel.webview.postMessage({ command: 'setUserToken', data: { ok: true } }) + break; + } else { + panel.webview.postMessage({ command: 'setUserToken', data: { ok: false } }) + break; + } + case 'setUsername': + this.user.setUsernameToLocal(data.username); + if (data.username === this.user.getUsernameFromLocal()) { + panel.webview.postMessage({ command: 'setUsername', data: { ok: true } }); + break; + } else { + panel.webview.postMessage({ command: 'setUsername', data: { ok: false } }); + break; + } + case 'getUserPublicKey': + var userPublicKey = ''; + if (this.user.existUserPrivateKey()) { + userPublicKey = this.user.getUserPublicKey(); + panel.webview.postMessage({ command: 'getUserPublicKey', data: { userPublicKey: userPublicKey } }) + break; + } else { + panel.webview.postMessage({ command: 'getUserPublicKey', data: { userPublicKey: userPublicKey } }) + break; + } + case 'createUserPublicKey': + await this.user.createUserSSHKey(); + if (this.user.existUserPublicKey()) { + panel.webview.postMessage({ command: 'createUserPublicKey', data: { ok: true } }) + break; + } else { + panel.webview.postMessage({ command: 'createUserPublicKey', data: { ok: false } }) + break; + } + case 'getMachineName': + const machineName = os.hostname(); + panel.webview.postMessage({ command: 'getMachineName', data: { machineName: machineName } }) + } + } else { + // ================= don't need return ============== + // frequent + switch (message.command) { + // ----------------- frequent ----------------------- + case 'showInformationNotification': + vscode.window.showInformationMessage(data.message); + break; + case 'showWarningNotification': + vscode.window.showWarningMessage(data.message) + break; + case 'showErrorNotification': + await utils.showErrorNotification(data.message) + break; + } + } + }, + undefined, + this.context.subscriptions + ); + + this.context.subscriptions.push(panel) + } + + + async getWebviewContent(devstarHomePageUrl: string): Promise { + return ` + + + + + + + + DevStar Home + + + + + + + + + ` + } +} diff --git a/src/main.ts b/src/main.ts index 7bb66b2..8f8d649 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,155 +1,155 @@ -import * as vscode from 'vscode'; -import * as fs from 'fs'; -import QuickAccessTreeProvider from './views/quick-access-tree'; -import DSHome from './home'; -import RemoteContainer, { openProjectWithoutLogging } from './remote-container'; -import User from './user'; -import DevstarAPIHandler from './devstar-api'; -import * as os from 'os'; -import * as utils from './utils'; - -export class DevStarExtension { - user: User; - remoteContainer: RemoteContainer; - dsHome: DSHome; - - constructor(private context: vscode.ExtensionContext) { - this.user = new User(context); - // 只保持一个User实例 - this.remoteContainer = new RemoteContainer(this.user); - this.dsHome = new DSHome(context, this.user); - - // 确定local系统是否为win,如果是,保存powershell版本 - if (vscode.env.remoteName === undefined) { - if (os.platform() === 'win32') { - utils.powershellVersion() - .then(powershellVersion => { - this.context.globalState.update('powershellVersion', powershellVersion) - }) - } - } - - // support for open with vscode in web - const handler = vscode.window.registerUriHandler({ - handleUri: async (uri: vscode.Uri) => { - const devstarAPIHandler = new DevstarAPIHandler() - - if (uri.path === '/openProject') { - const params = new URLSearchParams(uri.query); - const host = params.get('host'); - const hostname = params.get('hostname'); - const port = params.get('port'); - const username = params.get('username'); - const path = params.get('path'); - const access_token = params.get('access_token'); - const devstar_username = params.get('devstar_username'); - - if (host && hostname && port && username && path) { - const container_host = host; - const container_hostname = hostname - const container_port = parseInt(port, 10); - const container_username = username; - const project_path = decodeURIComponent(path); - - if (access_token && devstar_username) { - if (!this.user.isLogged()) { - // 如果没有用户登录,则直接登录; - const res = await this.user.login(access_token, devstar_username) - if (res === 'ok') { - await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) - } - } else if (devstar_username === this.user.getUsernameFromLocal()) { - // 如果同用户已经登录,则忽略,直接打开项目 - await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) - } else { - // 如果不是同用户,可以选择切换用户,或者不切换登录用户,直接打开容器 - const selection = await vscode.window.showWarningMessage(`已登录用户:${this.user.getUsernameFromLocal()},是否切换用户?`, - 'Yes', 'No',); - if (selection === 'Yes') { - // 如果没有用户登录,则直接登录; - const res = await this.user.login(access_token, devstar_username) - if (res === 'ok') { - await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) - } - } else if (selection === 'No') { - await openProjectWithoutLogging(container_host, container_port, container_username, project_path); - } - } - } else { - await openProjectWithoutLogging(container_host, container_port, container_username, project_path); - } - } else { - vscode.window.showErrorMessage('Missing required parameters.'); - } - } else if (uri.path === "/openProjectSkippingLoginCheck") { - // 仅有已登录、不用改变登录状态时,用此流程 - const params = new URLSearchParams(uri.query); - const host = params.get('host'); - const hostname = params.get('hostname'); - const port = params.get('port'); - const username = params.get('username'); - const path = params.get('path'); - - if (host && hostname && port && username && path) { - const container_host = host; - const container_hostname = hostname - const container_port = parseInt(port, 10); - const container_username = username; - const project_path = decodeURIComponent(path); - - await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) - } - } - } - }); - - context.subscriptions.push(handler); - - context.subscriptions.push( - vscode.window.registerTreeDataProvider( - 'devstar.quickAccess', - new QuickAccessTreeProvider() - ) - ); - - this.registerGlobalCommands(context); - - this.startDevStarHome(); - } - - - async startDevStarHome() { - vscode.commands.executeCommand('devstar.showHome'); - } - - - registerGlobalCommands(context: vscode.ExtensionContext) { - context.subscriptions.push( - vscode.commands.registerCommand('devstar.showHome', (url: string) => - this.dsHome.toggle(url) - ), - vscode.commands.registerCommand('devstar.clean', () => { - // 先清除ssh key - if (fs.existsSync(this.user.getUserPrivateKeyPath())) { - fs.unlinkSync(this.user.getUserPrivateKeyPath()) - } - - if (fs.existsSync(this.user.getUserPublicKeyPath())) { - fs.unlinkSync(this.user.getUserPublicKeyPath()) - } - console.log("User's ssh key has been deleted!") - // 更新local user private key path - this.user.updateLocalUserPrivateKeyPath("") - // 退出登录 - this.user.logout() - }) - ); - } -} - -export function activate(context: vscode.ExtensionContext) { - return new DevStarExtension(context); -} - -export function deactivate() { -} +import * as vscode from 'vscode'; +import * as fs from 'fs'; +import QuickAccessTreeProvider from './views/quick-access-tree'; +import DSHome from './home'; +import RemoteContainer, { openProjectWithoutLogging } from './remote-container'; +import User from './user'; +import DevstarAPIHandler from './devstar-api'; +import * as os from 'os'; +import * as utils from './utils'; + +export class DevStarExtension { + user: User; + remoteContainer: RemoteContainer; + dsHome: DSHome; + + constructor(private context: vscode.ExtensionContext) { + this.user = new User(context); + // 只保持一个User实例 + this.remoteContainer = new RemoteContainer(this.user); + this.dsHome = new DSHome(context, this.user); + + // 确定local系统是否为win,如果是,保存powershell版本 + if (vscode.env.remoteName === undefined) { + if (os.platform() === 'win32') { + utils.powershellVersion() + .then(powershellVersion => { + this.context.globalState.update('powershellVersion', powershellVersion) + }) + } + } + + // support for open with vscode in web + const handler = vscode.window.registerUriHandler({ + handleUri: async (uri: vscode.Uri) => { + const devstarAPIHandler = new DevstarAPIHandler() + + if (uri.path === '/openProject') { + const params = new URLSearchParams(uri.query); + const host = params.get('host'); + const hostname = params.get('hostname'); + const port = params.get('port'); + const username = params.get('username'); + const path = params.get('path'); + const access_token = params.get('access_token'); + const devstar_username = params.get('devstar_username'); + + if (host && hostname && port && username && path) { + const container_host = host; + const container_hostname = hostname + const container_port = parseInt(port, 10); + const container_username = username; + const project_path = decodeURIComponent(path); + + if (access_token && devstar_username) { + if (!this.user.isLogged()) { + // 如果没有用户登录,则直接登录; + const res = await this.user.login(access_token, devstar_username) + if (res === 'ok') { + await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) + } + } else if (devstar_username === this.user.getUsernameFromLocal()) { + // 如果同用户已经登录,则忽略,直接打开项目 + await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) + } else { + // 如果不是同用户,可以选择切换用户,或者不切换登录用户,直接打开容器 + const selection = await vscode.window.showWarningMessage(`已登录用户:${this.user.getUsernameFromLocal()},是否切换用户?`, + 'Yes', 'No',); + if (selection === 'Yes') { + // 如果没有用户登录,则直接登录; + const res = await this.user.login(access_token, devstar_username) + if (res === 'ok') { + await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) + } + } else if (selection === 'No') { + await openProjectWithoutLogging(container_host, container_port, container_username, project_path); + } + } + } else { + await openProjectWithoutLogging(container_host, container_port, container_username, project_path); + } + } else { + vscode.window.showErrorMessage('Missing required parameters.'); + } + } else if (uri.path === "/openProjectSkippingLoginCheck") { + // 仅有已登录、不用改变登录状态时,用此流程 + const params = new URLSearchParams(uri.query); + const host = params.get('host'); + const hostname = params.get('hostname'); + const port = params.get('port'); + const username = params.get('username'); + const path = params.get('path'); + + if (host && hostname && port && username && path) { + const container_host = host; + const container_hostname = hostname + const container_port = parseInt(port, 10); + const container_username = username; + const project_path = decodeURIComponent(path); + + await this.remoteContainer.firstOpenProject(container_host, container_hostname, container_port, container_username, project_path, this.context) + } + } + } + }); + + context.subscriptions.push(handler); + + context.subscriptions.push( + vscode.window.registerTreeDataProvider( + 'devstar.quickAccess', + new QuickAccessTreeProvider() + ) + ); + + this.registerGlobalCommands(context); + + this.startDevStarHome(); + } + + + async startDevStarHome() { + vscode.commands.executeCommand('devstar.showHome'); + } + + + registerGlobalCommands(context: vscode.ExtensionContext) { + context.subscriptions.push( + vscode.commands.registerCommand('devstar.showHome', (url: string) => + this.dsHome.toggle(url) + ), + vscode.commands.registerCommand('devstar.clean', () => { + // 先清除ssh key + if (fs.existsSync(this.user.getUserPrivateKeyPath())) { + fs.unlinkSync(this.user.getUserPrivateKeyPath()) + } + + if (fs.existsSync(this.user.getUserPublicKeyPath())) { + fs.unlinkSync(this.user.getUserPublicKeyPath()) + } + console.log("User's ssh key has been deleted!") + // 更新local user private key path + this.user.updateLocalUserPrivateKeyPath("") + // 退出登录 + this.user.logout() + }) + ); + } +} + +export function activate(context: vscode.ExtensionContext) { + return new DevStarExtension(context); +} + +export function deactivate() { +} diff --git a/src/remote-container.ts b/src/remote-container.ts index 0efef91..0a8ca02 100644 --- a/src/remote-container.ts +++ b/src/remote-container.ts @@ -1,204 +1,204 @@ -import * as fs from 'fs'; -import * as path from 'path'; -import * as os from 'os'; -import * as vscode from 'vscode'; -import * as rd from 'readline' -const { NodeSSH } = require('node-ssh') - -import * as utils from './utils'; -import User from './user'; -import DevstarAPIHandler from './devstar-api'; - -export default class RemoteContainer { - private user: User; - - constructor(user: User) { - this.user = user - } - - /** - * 第一次打开远程项目 - * - * 远程环境,先创建local窗口,在通过命令行调用url打开(目前,仅支持vscode协议) - * @param host 项目名称 - * @param hostname ip - * @param port - * @param username - * @param path - * @param context 用于支持远程项目环境 - */ - async firstOpenProject(host: string, hostname: string, port: number, username: string, path: string, context: vscode.ExtensionContext) { - if (vscode.env.remoteName) { - // 远程环境 - vscode.commands.executeCommand('workbench.action.terminal.newLocal').then(() => { - const terminal = vscode.window.terminals[vscode.window.terminals.length - 1]; - if (terminal) { - // vscode协议 - // 根据系统+命令行版本确定命令 - const semver = require('semver') - const powershellVersion = context.globalState.get('powershellVersion') - const powershell_semver_compatible_version = semver.coerce(powershellVersion) - if (powershellVersion === undefined) - terminal.sendText(`code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) - else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) { - // win & powershell >= 5.1.26100.0 - terminal.sendText(`code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) - } else { - // win & powershell < 5.1.26100.0 - terminal.sendText(`code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) - } - } - }) - } else { - await this.firstConnect(host, hostname, username, port) - .then((res) => { - if (res === 'success') { - // only success then open folder - this.openRemoteFolder(host, port, username, path); - } - }) - - } - } - - /** - * local environment,第一次连接其他项目 - * @param host 项目名称 - * @param hostname ip - * @param username - * @param port - * @returns 成功返回success - */ - // connect with key - async firstConnect(host: string, hostname: string, username: string, port: number): Promise { - return new Promise(async (resolve) => { - const ssh = new NodeSSH(); - vscode.window.withProgress({ - location: vscode.ProgressLocation.Notification, - title: vscode.l10n.t("Installing vscode-server and devstar extension in container"), - cancellable: false - }, async (progress) => { - try { - // 检查公私钥是否存在,如果不存在,需要创建 - if (!this.user.existUserPrivateKey() || !this.user.existUserPublicKey()) { - await this.user.createUserSSHKey() - // 上传公钥 - const devstarAPIHandler = new DevstarAPIHandler() - const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this.user) - if (uploadResult !== "ok") { - throw new Error('Upload public key failed.') - } - } - } catch (error) { - console.error("Failed to first connect container: ", error) - } - - // 本地环境 - try { - // connect with key - await ssh.connect({ - host: hostname, - username: username, - port: port, - privateKeyPath: this.user.getUserPrivateKeyPath() - }); - progress.report({ message: vscode.l10n.t("Connected! Start installation") }); - - // install vscode-server and devstar extension - const vscodeCommitId = await utils.getVsCodeCommitId() - if ("" != vscodeCommitId) { - const vscodeServerUrl = `https://vscode.download.prss.microsoft.com/dbazure/download/stable/${vscodeCommitId}/vscode-server-linux-x64.tar.gz` - const installVscodeServerScript = ` - mkdir -p ~/.vscode-server/bin/${vscodeCommitId} && \\ - if [ "$(ls -A ~/.vscode-server/bin/${vscodeCommitId})" ]; then - ~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar - else - wget ${vscodeServerUrl} -O vscode-server-linux-x64.tar.gz && \\ - mv vscode-server-linux-x64.tar.gz ~/.vscode-server/bin/${vscodeCommitId} && \\ - cd ~/.vscode-server/bin/${vscodeCommitId} && \\ - tar -xvzf vscode-server-linux-x64.tar.gz --strip-components 1 && \\ - rm vscode-server-linux-x64.tar.gz && \\ - ~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar - fi - `; - await ssh.execCommand(installVscodeServerScript); - console.log("vscode-server and extension installed"); - vscode.window.showInformationMessage(vscode.l10n.t('Installation completed!')); - } - - await ssh.dispose(); - - // only connect successfully then save the host info - await this.storeProjectSSHInfo(host, hostname, port, username) - - resolve('success') - } catch (error) { - console.error('Failed to install vscode-server and extension: ', error); - await ssh.dispose(); - } - }); - }); - } - - /** - * 本地环境,保存项目的ssh连接信息 - * @param host - * @param hostname - * @param port - * @param username - */ - async storeProjectSSHInfo(host: string, hostname: string, port: number, username: string): Promise { - const sshConfigPath = path.join(os.homedir(), '.ssh', 'config'); - // check if the host and related info exist in local ssh config file before saving - var canAppendSSHConfig = true - if (fs.existsSync(sshConfigPath)) { - var reader = rd.createInterface(fs.createReadStream(sshConfigPath)) - - for await (const line of reader) { - if (line.includes(`Host ${host}`)) { - // the container ssh info exists - canAppendSSHConfig = false - break; - } - } - } - - if (canAppendSSHConfig) { - // save the host to the local ssh config file - const privateKeyPath = this.user.getUserPrivateKeyPath(); - const newSShConfigContent = - `\nHost ${host}\n HostName ${hostname}\n Port ${port}\n User ${username}\n PreferredAuthentications publickey\n IdentityFile ${privateKeyPath}\n `; - fs.writeFileSync(sshConfigPath, newSShConfigContent, { encoding: 'utf8', flag: 'a' }); - console.log('Host registered in local ssh config'); - } - } - - - /** - * local env - * 仅支持已经成功连接,并在ssh config file中存储ssh信息的项目连接。 - * - * @host 表示project name - */ - openRemoteFolder(host: string, port: number, username: string, path: string): void { - let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); - terminal.show(true); - // 在原窗口打开 - terminal.sendText(`code --remote ssh-remote+${username}@${host}:${port} ${path} --reuse-window`); - } -} - - -/** - * 打开项目(无须插件登录) - * @param hostname 表示ip - * @param port - * @param username - * @param path - */ -export async function openProjectWithoutLogging(hostname: string, port: number, username: string, path: string): Promise { - const command = `code --remote ssh-remote+${username}@${hostname}:${port} ${path} --reuse-window` - let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); - terminal.show(true); - terminal.sendText(command); +import * as fs from 'fs'; +import * as path from 'path'; +import * as os from 'os'; +import * as vscode from 'vscode'; +import * as rd from 'readline' +const { NodeSSH } = require('node-ssh') + +import * as utils from './utils'; +import User from './user'; +import DevstarAPIHandler from './devstar-api'; + +export default class RemoteContainer { + private user: User; + + constructor(user: User) { + this.user = user + } + + /** + * 第一次打开远程项目 + * + * 远程环境,先创建local窗口,在通过命令行调用url打开(目前,仅支持vscode协议) + * @param host 项目名称 + * @param hostname ip + * @param port + * @param username + * @param path + * @param context 用于支持远程项目环境 + */ + async firstOpenProject(host: string, hostname: string, port: number, username: string, path: string, context: vscode.ExtensionContext) { + if (vscode.env.remoteName) { + // 远程环境 + vscode.commands.executeCommand('workbench.action.terminal.newLocal').then(() => { + const terminal = vscode.window.terminals[vscode.window.terminals.length - 1]; + if (terminal) { + // vscode协议 + // 根据系统+命令行版本确定命令 + const semver = require('semver') + const powershellVersion = context.globalState.get('powershellVersion') + const powershell_semver_compatible_version = semver.coerce(powershellVersion) + if (powershellVersion === undefined) + terminal.sendText(`code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) + else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) { + // win & powershell >= 5.1.26100.0 + terminal.sendText(`code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) + } else { + // win & powershell < 5.1.26100.0 + terminal.sendText(`code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`) + } + } + }) + } else { + await this.firstConnect(host, hostname, username, port) + .then((res) => { + if (res === 'success') { + // only success then open folder + this.openRemoteFolder(host, port, username, path); + } + }) + + } + } + + /** + * local environment,第一次连接其他项目 + * @param host 项目名称 + * @param hostname ip + * @param username + * @param port + * @returns 成功返回success + */ + // connect with key + async firstConnect(host: string, hostname: string, username: string, port: number): Promise { + return new Promise(async (resolve) => { + const ssh = new NodeSSH(); + vscode.window.withProgress({ + location: vscode.ProgressLocation.Notification, + title: vscode.l10n.t("Installing vscode-server and devstar extension in container"), + cancellable: false + }, async (progress) => { + try { + // 检查公私钥是否存在,如果不存在,需要创建 + if (!this.user.existUserPrivateKey() || !this.user.existUserPublicKey()) { + await this.user.createUserSSHKey() + // 上传公钥 + const devstarAPIHandler = new DevstarAPIHandler() + const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this.user) + if (uploadResult !== "ok") { + throw new Error('Upload public key failed.') + } + } + } catch (error) { + console.error("Failed to first connect container: ", error) + } + + // 本地环境 + try { + // connect with key + await ssh.connect({ + host: hostname, + username: username, + port: port, + privateKeyPath: this.user.getUserPrivateKeyPath() + }); + progress.report({ message: vscode.l10n.t("Connected! Start installation") }); + + // install vscode-server and devstar extension + const vscodeCommitId = await utils.getVsCodeCommitId() + if ("" != vscodeCommitId) { + const vscodeServerUrl = `https://vscode.download.prss.microsoft.com/dbazure/download/stable/${vscodeCommitId}/vscode-server-linux-x64.tar.gz` + const installVscodeServerScript = ` + mkdir -p ~/.vscode-server/bin/${vscodeCommitId} && \\ + if [ "$(ls -A ~/.vscode-server/bin/${vscodeCommitId})" ]; then + ~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar + else + wget ${vscodeServerUrl} -O vscode-server-linux-x64.tar.gz && \\ + mv vscode-server-linux-x64.tar.gz ~/.vscode-server/bin/${vscodeCommitId} && \\ + cd ~/.vscode-server/bin/${vscodeCommitId} && \\ + tar -xvzf vscode-server-linux-x64.tar.gz --strip-components 1 && \\ + rm vscode-server-linux-x64.tar.gz && \\ + ~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar + fi + `; + await ssh.execCommand(installVscodeServerScript); + console.log("vscode-server and extension installed"); + vscode.window.showInformationMessage(vscode.l10n.t('Installation completed!')); + } + + await ssh.dispose(); + + // only connect successfully then save the host info + await this.storeProjectSSHInfo(host, hostname, port, username) + + resolve('success') + } catch (error) { + console.error('Failed to install vscode-server and extension: ', error); + await ssh.dispose(); + } + }); + }); + } + + /** + * 本地环境,保存项目的ssh连接信息 + * @param host + * @param hostname + * @param port + * @param username + */ + async storeProjectSSHInfo(host: string, hostname: string, port: number, username: string): Promise { + const sshConfigPath = path.join(os.homedir(), '.ssh', 'config'); + // check if the host and related info exist in local ssh config file before saving + var canAppendSSHConfig = true + if (fs.existsSync(sshConfigPath)) { + var reader = rd.createInterface(fs.createReadStream(sshConfigPath)) + + for await (const line of reader) { + if (line.includes(`Host ${host}`)) { + // the container ssh info exists + canAppendSSHConfig = false + break; + } + } + } + + if (canAppendSSHConfig) { + // save the host to the local ssh config file + const privateKeyPath = this.user.getUserPrivateKeyPath(); + const newSShConfigContent = + `\nHost ${host}\n HostName ${hostname}\n Port ${port}\n User ${username}\n PreferredAuthentications publickey\n IdentityFile ${privateKeyPath}\n `; + fs.writeFileSync(sshConfigPath, newSShConfigContent, { encoding: 'utf8', flag: 'a' }); + console.log('Host registered in local ssh config'); + } + } + + + /** + * local env + * 仅支持已经成功连接,并在ssh config file中存储ssh信息的项目连接。 + * + * @host 表示project name + */ + openRemoteFolder(host: string, port: number, username: string, path: string): void { + let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); + terminal.show(true); + // 在原窗口打开 + terminal.sendText(`code --remote ssh-remote+${username}@${host}:${port} ${path} --reuse-window`); + } +} + + +/** + * 打开项目(无须插件登录) + * @param hostname 表示ip + * @param port + * @param username + * @param path + */ +export async function openProjectWithoutLogging(hostname: string, port: number, username: string, path: string): Promise { + const command = `code --remote ssh-remote+${username}@${hostname}:${port} ${path} --reuse-window` + let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); + terminal.show(true); + terminal.sendText(command); } \ No newline at end of file diff --git a/src/user.ts b/src/user.ts index 530fbca..4bcb72f 100644 --- a/src/user.ts +++ b/src/user.ts @@ -1,214 +1,214 @@ -import * as vscode from 'vscode'; -import * as path from 'path'; -import * as os from 'os'; -import * as fs from 'fs'; -import DevstarAPIHandler from './devstar-api'; -import { showErrorNotification } from './utils'; -const { - generateKeyPairSync, - createHash -} = require('node:crypto'); -const sshpk = require('sshpk'); - -export default class User { - private context: vscode.ExtensionContext; - private username: string | undefined; - private userToken: string | undefined; - private usernameKey: string = 'devstarUsername' - private userTokenKey: string = 'devstarUserToken' - private localUserPrivateKeyPath: string = '' - private devstarHostname: string; - - constructor(context: vscode.ExtensionContext) { - this.context = context; - this.username = this.context.globalState.get(this.usernameKey); - this.userToken = this.context.globalState.get(this.userTokenKey); - - // 提取devstar domain的主域名,用于本地ssh key的命名 - let devstarDomainFromConfig: string | undefined; - let devstarDomainURL: string; - devstarDomainFromConfig = vscode.workspace.getConfiguration('devstar').get('devstarDomain') - // 如果没有配置devstar domain,则默认domain为https://devstar.cn - devstarDomainURL = (devstarDomainFromConfig === undefined || devstarDomainFromConfig === "") ? 'https://devstar.cn' : devstarDomainFromConfig; - let parsedUrl = new URL(devstarDomainURL); - this.devstarHostname = parsedUrl.hostname.replace(/\./g, '_'); //提取hostname,并用下划线替换. - } - - public async login(token: string, username: string) { - const devstarAPIHandler = new DevstarAPIHandler() - - try { - const res = await devstarAPIHandler.verifyToken(token, username) - if (!res) { - throw new Error('Token verification failed') - } - - // token与用户名验证通过 - // 插件登录:存储token与用户名 - this.setUserTokenToLocal(token) - this.setUsernameToLocal(username) - - // 检查本地是否有用户所属公钥,没有则创建 - if (!this.existUserPublicKey()) { - await this.createUserSSHKey() - - // 上传公钥 - const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this) - if (uploadResult !== 'ok') { - throw new Error('Upload user public key failed') - } - } - - vscode.window.showInformationMessage(vscode.l10n.t('User login successfully!')) - return 'ok' - } catch (error) { - console.error(error) - await showErrorNotification('用户登录失败!') - return 'login failed' - } - } - - public logout() { - this.setUserTokenToLocal("") - this.setUsernameToLocal("") - vscode.window.showInformationMessage(vscode.l10n.t("User has logged out!")) - } - - public isLogged() { - var existUsername = false; - var existUserToken = false; - if (this.username != undefined && this.username != '') { - existUsername = true; - } - if (this.userToken != undefined && this.userToken != '') { - existUserToken = true; - } - - if (existUsername && existUserToken) { - return true; - } else { - return false; - } - } - - public getUsernameFromLocal(): string | undefined { - return this.username; - } - - public getUserTokenFromLocal(): string | undefined { - return this.userToken; - } - - public setUsernameToLocal(username: string) { - this.context.globalState.update(this.usernameKey, username); - this.username = username; - if (username !== "") { - console.log('Username has been stored.') - } else { - console.log('Username has been cleaned up.') - } - } - - public setUserTokenToLocal(userToken: string) { - this.context.globalState.update(this.userTokenKey, userToken) - this.userToken = userToken - if (userToken !== "") { - console.log('Token has been stored.'); - } else { - console.log('Token has been cleaned up.') - } - } - - public updateLocalUserPrivateKeyPath(localUserPrivateKeyPath: string) { - this.context.globalState.update('localUserPrivateKeyPath', localUserPrivateKeyPath) - } - - public getLocalUserPrivateKeyPath(): undefined | string { - return this.context.globalState.get('localUserPrivateKeyPath') - } - - public getUserPrivateKeyPath(): string { - if (!this.isLogged) { - return ''; - } - - return path.join(os.homedir(), '.ssh', `id_rsa_${this.username}_${this.devstarHostname}`) - } - - public getUserPublicKeyPath(): string { - if (!this.isLogged) { - return ''; - } - - return path.join(os.homedir(), '.ssh', `id_rsa_${this.username}_${this.devstarHostname}.pub`) - } - - public existUserPublicKey(): boolean { - const userPublicKeyPath = this.getUserPublicKeyPath(); - return fs.existsSync(userPublicKeyPath) - } - - public existUserPrivateKey(): boolean { - const userPrivateKeyPath = this.getUserPrivateKeyPath(); - return fs.existsSync(userPrivateKeyPath) - } - - public getUserPublicKey(): string { - const userPublicKeyPath = this.getUserPublicKeyPath(); - const userPublicKey = fs.readFileSync(userPublicKeyPath, 'utf-8'); - // remove `\r` `\n` - const trimmedDefaultPublicKey = userPublicKey.replace(/[\r\n]/g, ""); - return trimmedDefaultPublicKey; - } - - public getUserPrivateKey(): string { - const userPrivateKey = this.getUserPrivateKeyPath(); - return fs.readFileSync(userPrivateKey, 'utf-8'); - } - - public async createUserSSHKey() { - if (this.existUserPublicKey() && this.existUserPrivateKey()) { - // if both public and private key exists, stop - return; - } - - const { - publicKey, - privateKey, - } = await generateKeyPairSync('rsa', { - modulusLength: 4096, - publicKeyEncoding: { - type: 'pkcs1', - format: 'pem', - }, - privateKeyEncoding: { - type: 'pkcs1', - format: 'pem', - }, - }); - const publicKeyFingerprint = sshpk.parseKey(publicKey, 'pem').toString('ssh'); - const publicKeyStr = publicKeyFingerprint; // public key is public key fingerprint - const privateKeyStr = privateKey; - - try { - // 确保公/私钥目录存在 - const publicKeyDir = path.dirname(this.getUserPublicKeyPath()) - if (!fs.existsSync(publicKeyDir)) { - console.log(`Directory ${publicKeyDir} does not exist, creating it...`); - // 公钥与私钥的目录一样,所以只用创建一次 - fs.mkdirSync(publicKeyDir, {recursive: true}) - } - - fs.writeFileSync(this.getUserPublicKeyPath(), publicKeyStr); - fs.writeFileSync(this.getUserPrivateKeyPath(), privateKeyStr); - // limit the permission of private key to prevent that the private key not works - fs.chmodSync(this.getUserPrivateKeyPath(), 0o600) - console.log(`User's ssh key has been created.`) - // 更新local user private key path - this.updateLocalUserPrivateKeyPath(this.getUserPrivateKeyPath()) - console.log(`Update local user private key path.`) - } catch (error) { - console.error(`Failed to write public/private key into the user(${this.username}) ssh public/key file: `, error); - } - } +import * as vscode from 'vscode'; +import * as path from 'path'; +import * as os from 'os'; +import * as fs from 'fs'; +import DevstarAPIHandler from './devstar-api'; +import { showErrorNotification } from './utils'; +const { + generateKeyPairSync, + createHash +} = require('node:crypto'); +const sshpk = require('sshpk'); + +export default class User { + private context: vscode.ExtensionContext; + private username: string | undefined; + private userToken: string | undefined; + private usernameKey: string = 'devstarUsername' + private userTokenKey: string = 'devstarUserToken' + private localUserPrivateKeyPath: string = '' + private devstarHostname: string; + + constructor(context: vscode.ExtensionContext) { + this.context = context; + this.username = this.context.globalState.get(this.usernameKey); + this.userToken = this.context.globalState.get(this.userTokenKey); + + // 提取devstar domain的主域名,用于本地ssh key的命名 + let devstarDomainFromConfig: string | undefined; + let devstarDomainURL: string; + devstarDomainFromConfig = vscode.workspace.getConfiguration('devstar').get('devstarDomain') + // 如果没有配置devstar domain,则默认domain为https://devstar.cn + devstarDomainURL = (devstarDomainFromConfig === undefined || devstarDomainFromConfig === "") ? 'https://devstar.cn' : devstarDomainFromConfig; + let parsedUrl = new URL(devstarDomainURL); + this.devstarHostname = parsedUrl.hostname.replace(/\./g, '_'); //提取hostname,并用下划线替换. + } + + public async login(token: string, username: string) { + const devstarAPIHandler = new DevstarAPIHandler() + + try { + const res = await devstarAPIHandler.verifyToken(token, username) + if (!res) { + throw new Error('Token verification failed') + } + + // token与用户名验证通过 + // 插件登录:存储token与用户名 + this.setUserTokenToLocal(token) + this.setUsernameToLocal(username) + + // 检查本地是否有用户所属公钥,没有则创建 + if (!this.existUserPublicKey()) { + await this.createUserSSHKey() + + // 上传公钥 + const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this) + if (uploadResult !== 'ok') { + throw new Error('Upload user public key failed') + } + } + + vscode.window.showInformationMessage(vscode.l10n.t('User login successfully!')) + return 'ok' + } catch (error) { + console.error(error) + await showErrorNotification('用户登录失败!') + return 'login failed' + } + } + + public logout() { + this.setUserTokenToLocal("") + this.setUsernameToLocal("") + vscode.window.showInformationMessage(vscode.l10n.t("User has logged out!")) + } + + public isLogged() { + var existUsername = false; + var existUserToken = false; + if (this.username != undefined && this.username != '') { + existUsername = true; + } + if (this.userToken != undefined && this.userToken != '') { + existUserToken = true; + } + + if (existUsername && existUserToken) { + return true; + } else { + return false; + } + } + + public getUsernameFromLocal(): string | undefined { + return this.username; + } + + public getUserTokenFromLocal(): string | undefined { + return this.userToken; + } + + public setUsernameToLocal(username: string) { + this.context.globalState.update(this.usernameKey, username); + this.username = username; + if (username !== "") { + console.log('Username has been stored.') + } else { + console.log('Username has been cleaned up.') + } + } + + public setUserTokenToLocal(userToken: string) { + this.context.globalState.update(this.userTokenKey, userToken) + this.userToken = userToken + if (userToken !== "") { + console.log('Token has been stored.'); + } else { + console.log('Token has been cleaned up.') + } + } + + public updateLocalUserPrivateKeyPath(localUserPrivateKeyPath: string) { + this.context.globalState.update('localUserPrivateKeyPath', localUserPrivateKeyPath) + } + + public getLocalUserPrivateKeyPath(): undefined | string { + return this.context.globalState.get('localUserPrivateKeyPath') + } + + public getUserPrivateKeyPath(): string { + if (!this.isLogged) { + return ''; + } + + return path.join(os.homedir(), '.ssh', `id_rsa_${this.username}_${this.devstarHostname}`) + } + + public getUserPublicKeyPath(): string { + if (!this.isLogged) { + return ''; + } + + return path.join(os.homedir(), '.ssh', `id_rsa_${this.username}_${this.devstarHostname}.pub`) + } + + public existUserPublicKey(): boolean { + const userPublicKeyPath = this.getUserPublicKeyPath(); + return fs.existsSync(userPublicKeyPath) + } + + public existUserPrivateKey(): boolean { + const userPrivateKeyPath = this.getUserPrivateKeyPath(); + return fs.existsSync(userPrivateKeyPath) + } + + public getUserPublicKey(): string { + const userPublicKeyPath = this.getUserPublicKeyPath(); + const userPublicKey = fs.readFileSync(userPublicKeyPath, 'utf-8'); + // remove `\r` `\n` + const trimmedDefaultPublicKey = userPublicKey.replace(/[\r\n]/g, ""); + return trimmedDefaultPublicKey; + } + + public getUserPrivateKey(): string { + const userPrivateKey = this.getUserPrivateKeyPath(); + return fs.readFileSync(userPrivateKey, 'utf-8'); + } + + public async createUserSSHKey() { + if (this.existUserPublicKey() && this.existUserPrivateKey()) { + // if both public and private key exists, stop + return; + } + + const { + publicKey, + privateKey, + } = await generateKeyPairSync('rsa', { + modulusLength: 4096, + publicKeyEncoding: { + type: 'pkcs1', + format: 'pem', + }, + privateKeyEncoding: { + type: 'pkcs1', + format: 'pem', + }, + }); + const publicKeyFingerprint = sshpk.parseKey(publicKey, 'pem').toString('ssh'); + const publicKeyStr = publicKeyFingerprint; // public key is public key fingerprint + const privateKeyStr = privateKey; + + try { + // 确保公/私钥目录存在 + const publicKeyDir = path.dirname(this.getUserPublicKeyPath()) + if (!fs.existsSync(publicKeyDir)) { + console.log(`Directory ${publicKeyDir} does not exist, creating it...`); + // 公钥与私钥的目录一样,所以只用创建一次 + fs.mkdirSync(publicKeyDir, {recursive: true}) + } + + fs.writeFileSync(this.getUserPublicKeyPath(), publicKeyStr); + fs.writeFileSync(this.getUserPrivateKeyPath(), privateKeyStr); + // limit the permission of private key to prevent that the private key not works + fs.chmodSync(this.getUserPrivateKeyPath(), 0o600) + console.log(`User's ssh key has been created.`) + // 更新local user private key path + this.updateLocalUserPrivateKeyPath(this.getUserPrivateKeyPath()) + console.log(`Update local user private key path.`) + } catch (error) { + console.error(`Failed to write public/private key into the user(${this.username}) ssh public/key file: `, error); + } + } } \ No newline at end of file diff --git a/src/utils.ts b/src/utils.ts index d06a6a0..a0a4c2d 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,135 +1,135 @@ -import * as http from 'http'; -import * as https from 'https'; -import * as vscode from 'vscode'; -import * as os from 'os'; -import { exec } from 'child_process'; -import * as path from 'path'; - -const { - generateKeyPairSync, -} = require('node:crypto') -const axios = require('axios'); -const cheerio = require('cheerio'); - - -export function isWindows(): boolean { - return os.platform() === 'win32'; -} - -export function isLinux(): boolean { - return os.platform() === 'linux'; -} - -export function isMacOS(): boolean { - return os.platform() === 'darwin'; -} - - -export function fetch(url: string): Promise { - // determine the library to use (based on the url protocol) - const lib = url.startsWith('https://') ? https : http; - - return new Promise((resolve, reject) => { - lib.get(url, (response) => { - // make sure the status code is 200 - if (response.statusCode !== 200) { - reject(new Error(`Failed to load page, status code: ${response.statusCode}`)); - return; - } - - let data = ''; - response.on('data', (chunk) => { - data += chunk; - }); - response.on('end', () => { - resolve(data); - }); - }).on('error', (err) => { - reject(err); - }); - }); -} - -export const Sleep = (ms: number) => { - return new Promise(resolve => setTimeout(resolve, ms)) -} - -export async function getVsCodeCommitId(): Promise { - if (isLinux() || isMacOS()) { - return new Promise((resolve) => { - exec('code --version', (error, stdout, stderr) => { - if (error) { - console.error('Error occurred:' + error.message); - resolve(""); - return; - } - if (stderr) { - console.error('Error output:' + stderr); - resolve(""); - return; - } - const lines = stdout.trim().split('\n'); - if (lines.length > 1) { - const commitId = lines[1]; // 第二行是 commit ID - resolve(commitId); - } else { - console.error('Unexpected output format:' + stdout); - resolve(""); - return; - } - }); - }) - } else { - // 获取vscode version - const version = vscode.version - - // 根据version提取相应的release页面中的commitid - try { - const { data } = await axios.get(`https://github.com/microsoft/vscode/releases/tag/${version}`); - - // Load the HTML into cheerio - const $ = cheerio.load(data); - // Find the tag with the 'data-hovercard-type="commit"' attribute - const commitLink = $('a[data-hovercard-type="commit"]'); - // Extract the href attribute and commit hash - const href = commitLink.attr('href'); // href example: /microsoft/vscode/commit/fabdb6a30b49f79a7aba0f2ad9df9b399473380f - const commitHash = href.split('/').pop(); - - return commitHash - } catch (error) { - console.error('Failed to get commit id: ' + error) - return "" - } - - } -} - -export function devstarDomain(): string | undefined { - // 从用户配置中读取 - return vscode.workspace.getConfiguration('devstar').get('devstarDomain') -} - -export async function showErrorNotification(message: string): Promise { - const selection = await vscode.window.showErrorMessage(message, 'Open Console', 'Report a problem',); - if (selection === 'Open Console') { - vscode.commands.executeCommand('workbench.action.toggleDevTools'); - } else if (selection === 'Report a problem') { - vscode.commands.executeCommand('vscode.open', vscode.Uri.parse('https://github.com/mengning/DevStar/issues/new')); - } -} - -export async function powershellVersion(): Promise { - return new Promise((resolve, reject) => { - exec('powershell -Command "$PSVersionTable.PSVersion.ToString()"', (error, stdout, stderr) => { - if (error) { - reject(`Error executing PowerShell command: ${error.message}`); - return; - } - if (stderr) { - reject(`PowerShell command returned an error: ${stderr}`); - return; - } - resolve(stdout.trim()); - }); - }); +import * as http from 'http'; +import * as https from 'https'; +import * as vscode from 'vscode'; +import * as os from 'os'; +import { exec } from 'child_process'; +import * as path from 'path'; + +const { + generateKeyPairSync, +} = require('node:crypto') +const axios = require('axios'); +const cheerio = require('cheerio'); + + +export function isWindows(): boolean { + return os.platform() === 'win32'; +} + +export function isLinux(): boolean { + return os.platform() === 'linux'; +} + +export function isMacOS(): boolean { + return os.platform() === 'darwin'; +} + + +export function fetch(url: string): Promise { + // determine the library to use (based on the url protocol) + const lib = url.startsWith('https://') ? https : http; + + return new Promise((resolve, reject) => { + lib.get(url, (response) => { + // make sure the status code is 200 + if (response.statusCode !== 200) { + reject(new Error(`Failed to load page, status code: ${response.statusCode}`)); + return; + } + + let data = ''; + response.on('data', (chunk) => { + data += chunk; + }); + response.on('end', () => { + resolve(data); + }); + }).on('error', (err) => { + reject(err); + }); + }); +} + +export const Sleep = (ms: number) => { + return new Promise(resolve => setTimeout(resolve, ms)) +} + +export async function getVsCodeCommitId(): Promise { + if (isLinux() || isMacOS()) { + return new Promise((resolve) => { + exec('code --version', (error, stdout, stderr) => { + if (error) { + console.error('Error occurred:' + error.message); + resolve(""); + return; + } + if (stderr) { + console.error('Error output:' + stderr); + resolve(""); + return; + } + const lines = stdout.trim().split('\n'); + if (lines.length > 1) { + const commitId = lines[1]; // 第二行是 commit ID + resolve(commitId); + } else { + console.error('Unexpected output format:' + stdout); + resolve(""); + return; + } + }); + }) + } else { + // 获取vscode version + const version = vscode.version + + // 根据version提取相应的release页面中的commitid + try { + const { data } = await axios.get(`https://github.com/microsoft/vscode/releases/tag/${version}`); + + // Load the HTML into cheerio + const $ = cheerio.load(data); + // Find the tag with the 'data-hovercard-type="commit"' attribute + const commitLink = $('a[data-hovercard-type="commit"]'); + // Extract the href attribute and commit hash + const href = commitLink.attr('href'); // href example: /microsoft/vscode/commit/fabdb6a30b49f79a7aba0f2ad9df9b399473380f + const commitHash = href.split('/').pop(); + + return commitHash + } catch (error) { + console.error('Failed to get commit id: ' + error) + return "" + } + + } +} + +export function devstarDomain(): string | undefined { + // 从用户配置中读取 + return vscode.workspace.getConfiguration('devstar').get('devstarDomain') +} + +export async function showErrorNotification(message: string): Promise { + const selection = await vscode.window.showErrorMessage(message, 'Open Console', 'Report a problem',); + if (selection === 'Open Console') { + vscode.commands.executeCommand('workbench.action.toggleDevTools'); + } else if (selection === 'Report a problem') { + vscode.commands.executeCommand('vscode.open', vscode.Uri.parse('https://github.com/mengning/DevStar/issues/new')); + } +} + +export async function powershellVersion(): Promise { + return new Promise((resolve, reject) => { + exec('powershell -Command "$PSVersionTable.PSVersion.ToString()"', (error, stdout, stderr) => { + if (error) { + reject(`Error executing PowerShell command: ${error.message}`); + return; + } + if (stderr) { + reject(`PowerShell command returned an error: ${stderr}`); + return; + } + resolve(stdout.trim()); + }); + }); } \ No newline at end of file diff --git a/src/views/quick-access-tree.ts b/src/views/quick-access-tree.ts index 5b7c806..864440d 100644 --- a/src/views/quick-access-tree.ts +++ b/src/views/quick-access-tree.ts @@ -1,47 +1,47 @@ -import * as vscode from 'vscode'; - -class QuickItem extends vscode.TreeItem { - customChildren: QuickItem[] | undefined; - - constructor(label: string, command?: string, args?: any, collapsibleState?: vscode.TreeItemCollapsibleState, children?: QuickItem[]) { - super(label, collapsibleState); - if (command) { - this.command = { - title: label, - command, - arguments: args, - }; - } - this.customChildren = children; - } -} - -export default class QuickAccessTreeProvider { - getChildren(element: QuickItem) { - if (element && element.customChildren) { - return element.customChildren; - } - - return [ - new QuickItem( - vscode.l10n.t('DevStar Home'), - undefined, - undefined, - vscode.TreeItemCollapsibleState.Expanded, - [new QuickItem(vscode.l10n.t('Open'), 'devstar.showHome')] - ), - new QuickItem( - vscode.l10n.t('Miscellaneous'), - undefined, - undefined, - vscode.TreeItemCollapsibleState.Expanded, - // [new QuickItem('Connect Remote Container', 'devstar.connectRemoteContainer')] - [new QuickItem(vscode.l10n.t('Clean'), 'devstar.clean')] - ), - ]; - } - - getTreeItem(element: QuickItem) { - return element; - } -} +import * as vscode from 'vscode'; + +class QuickItem extends vscode.TreeItem { + customChildren: QuickItem[] | undefined; + + constructor(label: string, command?: string, args?: any, collapsibleState?: vscode.TreeItemCollapsibleState, children?: QuickItem[]) { + super(label, collapsibleState); + if (command) { + this.command = { + title: label, + command, + arguments: args, + }; + } + this.customChildren = children; + } +} + +export default class QuickAccessTreeProvider { + getChildren(element: QuickItem) { + if (element && element.customChildren) { + return element.customChildren; + } + + return [ + new QuickItem( + vscode.l10n.t('DevStar Home'), + undefined, + undefined, + vscode.TreeItemCollapsibleState.Expanded, + [new QuickItem(vscode.l10n.t('Open'), 'devstar.showHome')] + ), + new QuickItem( + vscode.l10n.t('Miscellaneous'), + undefined, + undefined, + vscode.TreeItemCollapsibleState.Expanded, + // [new QuickItem('Connect Remote Container', 'devstar.connectRemoteContainer')] + [new QuickItem(vscode.l10n.t('Clean'), 'devstar.clean')] + ), + ]; + } + + getTreeItem(element: QuickItem) { + return element; + } +} diff --git a/test/home.html b/test/home.html index 7494260..489feac 100644 --- a/test/home.html +++ b/test/home.html @@ -1,916 +1,916 @@ - - - - - - - - Embedded page - - - - - -

DevStar Home

- - - - - - - - - - -
- - -

Created Repositories

- - - - - - - - - - - - -
repoNamerepoURLOperation
- - - - - ` - - - + + + + + + + + Embedded page + + + + + +

DevStar Home

+ + + + + + + + + + +
+ + +

Created Repositories

+ + + + + + + + + + + + +
repoNamerepoURLOperation
+ + + + + ` + + + \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 6950dbe..3ae95d9 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,24 +1,24 @@ -{ - "compilerOptions": { - "module": "CommonJS", - "target": "ES6", - "lib": [ - "ES6", - "DOM" - ], - "sourceMap": true, - "rootDir": "src", - "strict": true, /* enable all strict type-checking options */ - /* Additional Checks */ - "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ - // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ - "noUnusedParameters": true, /* Report errors on unused parameters. */ - /* Emit */ - "outDir": "dist", /* Redirect output structure to the directory. */ - "removeComments": true, /* Do not emit comments to output. */ - "noEmitOnError": true, /* Do not emit outputs if any errors were reported. */ - }, - "include": [ - "**/*.ts" - ], -} +{ + "compilerOptions": { + "module": "CommonJS", + "target": "ES6", + "lib": [ + "ES6", + "DOM" + ], + "sourceMap": true, + "rootDir": "src", + "strict": true, /* enable all strict type-checking options */ + /* Additional Checks */ + "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + "noUnusedParameters": true, /* Report errors on unused parameters. */ + /* Emit */ + "outDir": "dist", /* Redirect output structure to the directory. */ + "removeComments": true, /* Do not emit comments to output. */ + "noEmitOnError": true, /* Do not emit outputs if any errors were reported. */ + }, + "include": [ + "**/*.ts" + ], +} diff --git a/webpack.config.js b/webpack.config.js index 09c3e71..ad8777e 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -1,32 +1,32 @@ -const fs = require('fs'); -const path = require('path'); - -const packageConfig = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'), 'utf8')); -const externals = Object.keys(packageConfig.dependencies); -externals.push('vscode'); - -module.exports = { - mode: 'production', - entry: __dirname + '/src/main.ts', - output: { - path: path.resolve(__dirname, 'dist'), - filename: 'extension.js', - libraryTarget: 'commonjs2' - }, - devtool: 'source-map', - target: 'node', - externals: externals, - module: { - rules: [ - { - test: /\.ts$/, - loader: 'ts-loader', - exclude: /node_modules/ - } - ] - }, - resolve: { - modules: [path.resolve('./node_modules'), path.resolve('./src')], - extensions: ['.ts', '.js'] - } +const fs = require('fs'); +const path = require('path'); + +const packageConfig = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'), 'utf8')); +const externals = Object.keys(packageConfig.dependencies); +externals.push('vscode'); + +module.exports = { + mode: 'production', + entry: __dirname + '/src/main.ts', + output: { + path: path.resolve(__dirname, 'dist'), + filename: 'extension.js', + libraryTarget: 'commonjs2' + }, + devtool: 'source-map', + target: 'node', + externals: externals, + module: { + rules: [ + { + test: /\.ts$/, + loader: 'ts-loader', + exclude: /node_modules/ + } + ] + }, + resolve: { + modules: [path.resolve('./node_modules'), path.resolve('./src')], + extensions: ['.ts', '.js'] + } }; \ No newline at end of file