├── .github └── workflows │ └── main.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── bashbot.py ├── bashbot ├── __init__.py ├── bot.py ├── command │ ├── __init__.py │ ├── about.py │ ├── close.py │ ├── controls.py │ ├── exec.py │ ├── freeze.py │ ├── help.py │ ├── here.py │ ├── interactive.py │ ├── macro.py │ ├── open.py │ ├── rename.py │ ├── repeat.py │ ├── select.py │ ├── submit.py │ └── whitelist.py ├── constants.py ├── core │ ├── __init__.py │ ├── exceptions.py │ ├── factory.py │ ├── macros.py │ ├── settings.py │ ├── state.py │ ├── updater.py │ └── utils.py └── terminal │ ├── __init__.py │ ├── control.py │ ├── sessions.py │ ├── shortcuts.py │ └── terminal.py ├── config.toml.example ├── macros └── example.txt └── requirements.txt /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | - uses: actions/setup-python@v2 13 | with: 14 | python-version: '3.9' 15 | 16 | - name: Run bashbot build 17 | run: | 18 | pip install -r requirements.txt -t . 19 | mv bashbot.py __main__.py 20 | echo '{"version": "${{ github.sha }}"}' > build.json 21 | zip -r BashBot.zip . 22 | 23 | - name: Create Release 24 | id: create_release 25 | uses: actions/create-release@v1 26 | env: 27 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 28 | with: 29 | tag_name: tag-${{ github.sha }} 30 | release_name: Release ${{ github.sha }} 31 | draft: false 32 | prerelease: false 33 | 34 | - name: Upload Release Asset 35 | id: upload-release-asset 36 | uses: actions/upload-release-asset@v1 37 | env: 38 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 39 | with: 40 | upload_url: ${{ steps.create_release.outputs.upload_url }} 41 | asset_path: ./BashBot.zip 42 | asset_name: BashBot.zip 43 | asset_content_type: application/zip 44 | 45 | - name: Set up QEMU 46 | uses: docker/setup-qemu-action@v1 47 | - name: Set up Docker Buildx 48 | uses: docker/setup-buildx-action@v1 49 | - name: Login to DockerHub 50 | uses: docker/login-action@v1 51 | with: 52 | username: ${{ secrets.DOCKERHUB_USERNAME }} 53 | password: ${{ secrets.DOCKERHUB_TOKEN }} 54 | - name: Build and push 55 | id: docker_build 56 | uses: docker/build-push-action@v2 57 | with: 58 | push: true 59 | tags: adikso/bashbot:latest,adikso/bashbot:${{ github.sha }} 60 | - name: Image digest 61 | run: echo ${{ steps.docker_build.outputs.digest }} 62 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | venv/ 2 | .idea/ 3 | __pycache__/ 4 | 5 | config.toml 6 | bashbot.log 7 | state.json 8 | build.json -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.8.7-slim-buster 2 | 3 | RUN apt update && apt install -y git && rm -rf /var/lib/apt/lists/* 4 | 5 | RUN groupadd -g 1000 bashbot 6 | RUN useradd -u 1000 -g bashbot -s /bin/sh -m bashbot 7 | 8 | RUN git clone https://github.com/Adikso/BashBot.git 9 | WORKDIR BashBot 10 | RUN pip install --no-cache-dir -r requirements.txt 11 | RUN chown -R bashbot:bashbot . 12 | 13 | USER bashbot 14 | CMD [ "python", "./bashbot.py" ] 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![BashBot](https://i.imgur.com/oHESoVW.png) 2 | 3 | BashBot is a Discord bot that provides terminal access via chat. 4 | 5 | ![](https://i.imgur.com/seKhece.png) 6 | 7 | ## Features 8 | * Interactive. Works with `nano`, `htop` etc 9 | * Buttons can be used as input keys 10 | * Open/Close/Select/Freeze terminal sessions 11 | * Run terminal session as different user 12 | * Support for macros 13 | * Users whitelisting 14 | * ... and more 15 | 16 | ## Getting Started 17 | 18 | These instructions will get you a bot installed and running quickly 19 | 20 | ### Prerequisites 21 | * Python 3.5+ 22 | * `pyte` library (installation instructions below) 23 | * `discord.py` library (installation instructions below) 24 | 25 | ### Installing 26 | 27 | You can download BashBot.zip from [Releases](https://github.com/Adikso/BashBot/releases) 28 | which contains all required dependencies and continue to "Running" section. 29 | 30 | or you can continue with manuall installation: 31 | 32 | Type following commands to install dependencies: 33 | ``` 34 | pip install -r requirements.txt 35 | ``` 36 | 37 | ### Running 38 | In order to run bot you have to obtain a bot account. It can be obtained through the [applications page](https://discordapp.com/developers/applications/me#top). 39 | Later you have to transform your app into app bot user 40 | 41 | ![Create a Bot User](https://i.imgur.com/98eUWrP.png) 42 | 43 | then enable "Message Content Intent" 44 | 45 | 2022-09-08_03-38 46 | 47 | 48 | After these operations, copy your bot token using the Copy button 49 | 50 | ![](https://i.imgur.com/m4L67Hs.png) 51 | 52 | And run 53 | ``` 54 | python bashbot.py 55 | ``` 56 | or if you downloaded BashBot [release](https://github.com/Adikso/BashBot/releases) 57 | ``` 58 | python BashBot.zip 59 | ``` 60 | 61 | Now BashBot should start and show later instructions 62 | 63 | ### Docker 64 | Copy `config.toml.example` to `config.toml` file. And in the same directory run following command: 65 | ``` 66 | docker run -v $(pwd)/config.toml:/BashBot/config.toml adikso/bashbot 67 | ``` 68 | You can add `-d` to run container in background 69 | ``` 70 | docker run -d -v $(pwd)/config.toml:/BashBot/config.toml adikso/bashbot 71 | ``` 72 | 73 | Now BashBot should start and show later instructions 74 | 75 | ### Commands 76 | 77 | **Commands are now available as app commands**, but you can still use the old way: 78 | 79 | (Every command have to start with prefix. By default it's "$". You can change it in settings. More information about commands after typing "$.help") 80 | 81 | Command | Alias | Usage | Description 82 | ------------ | ------------- | ------------- | ------------- 83 | .about |-|.about|Shows information about project 84 | .open | .o | .open [name] | Opens new terminal session 85 | .close | .c | .close | Closes current terminal session 86 | .freeze | .f | .freeze | Freezes current terminal session 87 | .here | .h | .here | Moves selected terminal below the user message 88 | .select | .s | .select [name] | Sets terminal as selected 89 | .controls |-|.controls add/remove [emoji] [content..] | Manages terminal controls 90 | .repeat | .r | .repeat | Repeats string n times and sends to the current terminal session 91 | .rename | - | .rename | Changes session name 92 | .submit | - | .submit | Toggles auto submit mode 93 | .macro | .m | .macro | Executes macro from "macros" directory 94 | .interactive | .i | .interactive | Enables interactive mode where all messages are sent to terminal 95 | .exec | .e | .exec | Execute single command 96 | .whitelist | - | .whitelist add/remove | Add/Remove user to/from whitelist. **Bot owner can execute all commands without being on the whitelist** 97 | 98 | ### Shortcuts 99 | Shortcut | Description 100 | ------------ | ------------- | 101 | [UP] | Arrow up 102 | [DOWN] | Arrow down 103 | [LEFT] | Arrow left 104 | [RIGHT] | Arrow right 105 | [ESC] | Escape 106 | [TAB] or [T] | Horizontal tab 107 | [F1]...[F12]| 108 | [<] | Clears entire input line 109 | \a|Bell (BEL) 110 | \b|Backspace (BS) 111 | \f|Formfeed (FF) 112 | \n|Linefeed(Newline) (LF) 113 | \r|Carriage Return (CR) 114 | \t|Horizontal Tab (TAB) 115 | \v|Vertical Tab (VT) 116 | ^(key) | CTRL + (key) 117 | 118 | 119 | ## Built With 120 | 121 | * [Discord.py](https://github.com/Rapptz/discord.py) - Discord API wrapper for Python 122 | * [Pyte](https://github.com/selectel/pyte) - VTXXX-compatible terminal emulator 123 | 124 | ## Contributing 125 | 126 | Feel free to contribute 127 | 128 | ## Authors 129 | 130 | * **Adam Zambrzycki (Adikso)** 131 | 132 | See also the list of [contributors](https://github.com/Adikso/BashBot/contributors) who participated in this project. 133 | 134 | ## License 135 | 136 | This project is licensed under the GNU License - see the [LICENSE](LICENSE) file for details 137 | 138 | ## Acknowledgments 139 | 140 | * Bopke, tomangelo, RhAnjiE for testing 141 | -------------------------------------------------------------------------------- /bashbot.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | from discord import LoginFailure, Intents 4 | 5 | from bashbot.bot import BashBot 6 | from bashbot.core.settings import settings 7 | from bashbot.core.state import state 8 | from bashbot.core.utils import get_logger 9 | 10 | logger = get_logger('Launcher') 11 | 12 | 13 | def setup_logger(): 14 | logging.basicConfig( 15 | level=logging.INFO, 16 | format='[%(asctime)s] %(levelname)s:%(name)s: %(message)s', 17 | datefmt='%Y-%m-%d %H:%M:%S' 18 | ) 19 | 20 | 21 | def launch(): 22 | setup_logger() 23 | settings().load() 24 | settings().load_macros() 25 | state().load() 26 | 27 | prefix = settings().get('commands.prefixes', ['$'])[0] 28 | token = settings().get('discord.token') 29 | 30 | if token == 'TOKEN_HERE': 31 | logger.error('You need to specify bot TOKEN in config.toml') 32 | return 33 | 34 | try: 35 | intents = Intents.default() 36 | intents.message_content = True 37 | BashBot(prefix, intents=intents).run(token) 38 | except LoginFailure as e: 39 | logger.error(e.args[0]) 40 | 41 | 42 | if __name__ == '__main__': 43 | launch() 44 | -------------------------------------------------------------------------------- /bashbot/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adikso/BashBot/19db2e261217621cc297218cc712de52e8c5f8d9/bashbot/__init__.py -------------------------------------------------------------------------------- /bashbot/bot.py: -------------------------------------------------------------------------------- 1 | from discord import Message, Status, Game, DMChannel, Embed, Interaction, InteractionType 2 | from discord.abc import PrivateChannel 3 | from discord.ext.commands import Bot, Context 4 | from discord.ui import View, Button 5 | from discord.utils import oauth_url 6 | 7 | from bashbot.command.about import AboutCommand 8 | from bashbot.command.exec import ExecCommand 9 | from bashbot.command.close import CloseCommand 10 | from bashbot.command.controls import ControlsCommand 11 | from bashbot.command.freeze import FreezeCommand 12 | from bashbot.command.here import HereCommand 13 | from bashbot.command.interactive import InteractiveCommand 14 | from bashbot.command.macro import MacroCommand 15 | from bashbot.command.open import OpenCommand 16 | from bashbot.command.rename import RenameCommand 17 | from bashbot.command.repeat import RepeatCommand 18 | from bashbot.command.select import SelectCommand 19 | from bashbot.command.submit import SubmitCommand 20 | from bashbot.command.help import HelpCommand 21 | from bashbot.command.whitelist import WhitelistCommand 22 | from bashbot.core.exceptions import SessionDontExistException, ArgumentFormatException, TerminalNotFoundException, \ 23 | MacroNotFoundException 24 | from bashbot.core.settings import settings 25 | from bashbot.core.state import state 26 | from bashbot.terminal.sessions import sessions 27 | from bashbot.terminal.terminal import TerminalState 28 | from bashbot.core.updater import updater, Updater 29 | from bashbot.core.utils import get_logger, parse_template, extract_prefix, is_command, remove_prefix 30 | 31 | 32 | class BashBot(Bot): 33 | logger = get_logger('BashBot') 34 | cmd_logger = get_logger('Command') 35 | 36 | async def setup_hook(self): 37 | await self.add_cog(OpenCommand()) 38 | await self.add_cog(CloseCommand()) 39 | await self.add_cog(HereCommand()) 40 | await self.add_cog(FreezeCommand()) 41 | await self.add_cog(RenameCommand()) 42 | await self.add_cog(ControlsCommand()) 43 | await self.add_cog(AboutCommand()) 44 | await self.add_cog(RepeatCommand()) 45 | await self.add_cog(MacroCommand()) 46 | await self.add_cog(SelectCommand()) 47 | await self.add_cog(InteractiveCommand()) 48 | await self.add_cog(SubmitCommand()) 49 | await self.add_cog(ExecCommand()) 50 | await self.add_cog(WhitelistCommand()) 51 | 52 | self.remove_command("help") 53 | await self.add_cog(HelpCommand()) 54 | 55 | async def on_ready(self): 56 | if state()['last_run_version'] != Updater.get_local_commit(): 57 | self.logger.info('Synchronizing command tree...') 58 | await self.tree.sync() 59 | self.logger.info('Command tree synchronized') 60 | 61 | self.__check_for_updates() 62 | 63 | self.logger.info(f'Logged in as {self.user.name} ({self.user.id})') 64 | self.logger.info(f'You can add bot to your server via {oauth_url(self.user.id)}') 65 | 66 | presence = parse_template( 67 | settings().get("discord.presence"), 68 | prefix=self.command_prefix 69 | ) 70 | await self.change_presence( 71 | status=Status.online, 72 | activity=Game(presence) 73 | ) 74 | 75 | def __check_for_updates(self): 76 | if settings().get('other.check_for_updates'): 77 | self.logger.info(f'Checking for updates...') 78 | 79 | releases = updater().check_for_updates() 80 | if releases is None: 81 | self.logger.info(f'Failed to fetch updates information') 82 | elif releases: 83 | self.logger.info( 84 | f'New updates available. Try running `git pull`. \n' + 85 | '\n'.join([f'- {x["name"]} ({x["html_url"]})' for x in releases]) 86 | ) 87 | else: 88 | self.logger.info(f'BashBot is up to date') 89 | 90 | async def check_permissions(self, message): 91 | is_owner = await self.is_owner(message.author) 92 | if not is_owner: 93 | if settings().get('discord.enable_users_whitelist'): 94 | users_whitelist = settings().get('discord.users_whitelist', []) 95 | 96 | if message.author.id not in users_whitelist: 97 | first_prefix = settings().get('commands.prefixes')[0] 98 | embed = Embed( 99 | title=f'Only whitelisted users can execute commands', 100 | description=f'{first_prefix}.whitelist add {message.author.mention}' 101 | ) 102 | 103 | await message.channel.send(embed=embed) 104 | return False 105 | 106 | if isinstance(message.channel, DMChannel) and settings().get('discord.disable_dm'): 107 | embed = Embed( 108 | title=f'Using bot on DM is disabled', 109 | description='discord.disable_dm = true' 110 | ) 111 | 112 | await message.channel.send(embed=embed) 113 | return False 114 | 115 | return True 116 | 117 | async def on_message(self, message: Message): 118 | if message.author.bot: 119 | return 120 | 121 | terminal = sessions().by_channel(message.channel) 122 | 123 | if self.is_invoke(message): 124 | if not await self.check_permissions(message): 125 | return 126 | 127 | await self.process_commands(message) 128 | elif terminal and terminal.state == TerminalState.OPEN: 129 | prefix = extract_prefix(message.content) 130 | if not terminal.interactive and not prefix: 131 | return 132 | 133 | if not await self.check_permissions(message): 134 | return 135 | 136 | # We don't remove prefix when in interactive mode 137 | content = message.content 138 | if not terminal.interactive: 139 | content = remove_prefix(content) 140 | 141 | if terminal.auto_submit: 142 | content += '\n' 143 | 144 | terminal.send_input(content) 145 | 146 | # Log message 147 | guild_name = message.channel.guild.name 148 | channel_name = message.channel.name 149 | author_name = message.author.name 150 | self.cmd_logger.info(f"[{guild_name}/#{channel_name}/{terminal.name}] {author_name} typed: {content}") 151 | 152 | should_delete_any = settings().get('terminal.delete_messages') 153 | should_delete_interactive = settings().get('terminal.interactive.delete_messages') 154 | if should_delete_any or (should_delete_interactive and terminal.interactive): 155 | await message.delete() 156 | 157 | async def on_interaction(self, interaction: Interaction): 158 | if interaction.type != InteractionType.component: 159 | return 160 | 161 | terminal = sessions().by_message(interaction.message) 162 | 163 | label = interaction.data['custom_id'] 164 | if label.startswith('control_') and not terminal: 165 | await interaction.response.send_message(content='This terminal is unavailable', ephemeral=True) 166 | view = View.from_message(interaction.message) 167 | for component in view.children: 168 | if isinstance(component, Button): 169 | component.disabled = True 170 | 171 | await interaction.message.edit(view=view) 172 | terminal.state = TerminalState.BROKEN 173 | terminal.refresh() 174 | 175 | async def on_command(self, ctx: Context): 176 | if not isinstance(ctx.message.channel, DMChannel): 177 | guild_name = ctx.message.channel.guild.name 178 | channel_name = ctx.message.channel.name 179 | else: 180 | guild_name = 'DM' 181 | channel_name = 'DM' 182 | 183 | author_name = ctx.message.author.name 184 | content = ctx.message.content 185 | 186 | self.cmd_logger.info(f"[{guild_name}/#{channel_name}] {author_name} invoked command: {content}") 187 | 188 | async def on_command_error(self, ctx: Context, error): 189 | message = None 190 | 191 | if isinstance(error, ArgumentFormatException): 192 | message = error.message 193 | 194 | if isinstance(error, SessionDontExistException): 195 | message = error.message 196 | 197 | if isinstance(error, TerminalNotFoundException): 198 | message = error.message 199 | 200 | if isinstance(error, MacroNotFoundException): 201 | message = error.message 202 | 203 | if message: 204 | await ctx.send(f'`{message}`') 205 | 206 | def is_invoke(self, message: Message): 207 | if isinstance(message.channel, PrivateChannel): 208 | return True 209 | 210 | has_mention = self.user in message.mentions 211 | return is_command(message.content) or has_mention 212 | -------------------------------------------------------------------------------- /bashbot/command/__init__.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | 3 | from bashbot.core.exceptions import SessionDontExistException 4 | from bashbot.terminal.sessions import sessions 5 | 6 | 7 | def session_exists(): 8 | async def predicate(ctx): 9 | if not sessions().by_channel(ctx.message.channel): 10 | raise SessionDontExistException() 11 | 12 | return True 13 | 14 | return commands.check(predicate) 15 | 16 | -------------------------------------------------------------------------------- /bashbot/command/about.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.constants import REPOSITORY_URL, THUMBNAIL_URL, EMBED_COLOR 6 | from bashbot.core.settings import settings 7 | from bashbot.core.updater import updater 8 | 9 | 10 | class AboutCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='about', 13 | aliases=['.about'], 14 | description='Shows information about project' 15 | ) 16 | async def about(self, ctx: Context): 17 | embed = Embed(title='About BashBot', description='BashBot is a Discord bot that allows terminal access via chat.', color=EMBED_COLOR) 18 | embed.add_field(name='Source code', value=REPOSITORY_URL, inline=False) 19 | embed.add_field(name='Author', value='[Adikso](https://github.com/Adikso)', inline=False) 20 | embed.add_field(name='Current version', value=updater().get_local_commit(), inline=False) 21 | embed.set_thumbnail(url=THUMBNAIL_URL) 22 | 23 | if settings().get('other.check_for_updates'): 24 | releases = updater().check_for_updates() 25 | if releases is None: 26 | embed.add_field(name='Failed to fetch updates information', value='Try again later', inline=False) 27 | elif releases: 28 | embed.add_field(name='Updates available', value='\n'.join([f'- [{x["name"]}]({x["html_url"]})' for x in releases]), inline=False) 29 | else: 30 | embed.add_field(name='No updates available', value='BashBot is up to date', inline=False) 31 | else: 32 | embed.add_field(name='Updates check disabled', value='You can re-enable it via "other.check_for_updates" in the configuration file', inline=False) 33 | 34 | await ctx.send(embed=embed) 35 | -------------------------------------------------------------------------------- /bashbot/command/close.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | 4 | from bashbot.command import session_exists 5 | from bashbot.core.exceptions import SessionDontExistException 6 | from bashbot.core.settings import settings 7 | from bashbot.terminal.sessions import sessions 8 | 9 | 10 | class CloseCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='close', 13 | aliases=['.close', '.c'], 14 | description='Closes current terminal session' 15 | ) 16 | @session_exists() 17 | async def close(self, ctx): 18 | terminal = sessions().by_channel(ctx.message.channel) 19 | 20 | if not terminal: 21 | raise SessionDontExistException() 22 | 23 | terminal.close() 24 | 25 | if settings().get('terminal.delete_on_close'): 26 | message = sessions().find_message(terminal) 27 | await message.delete() 28 | 29 | sessions().remove(terminal) 30 | 31 | embed = Embed(description=f"Closed terminal #{terminal.name}", color=0xff0000) 32 | await ctx.send(embed=embed) 33 | -------------------------------------------------------------------------------- /bashbot/command/controls.py: -------------------------------------------------------------------------------- 1 | import discord 2 | from discord import Message, Interaction, Embed, app_commands 3 | from discord.ext import commands 4 | from discord.ext.commands import Context 5 | from discord.ui import View 6 | 7 | from bashbot.command import session_exists 8 | from bashbot.terminal.control import TerminalControl 9 | from bashbot.terminal.sessions import sessions 10 | from bashbot.terminal.terminal import Terminal 11 | 12 | 13 | async def controls_callback(interaction: Interaction): 14 | label = interaction.data['custom_id'] 15 | if label.startswith('control_'): 16 | label = label[len('control_'):] 17 | terminal = sessions().by_message(interaction.message) 18 | control: TerminalControl = terminal.controls[label] 19 | terminal.send_input(control.text) 20 | 21 | await interaction.response.defer() 22 | 23 | 24 | class ControlsCommand(commands.Cog): 25 | @commands.hybrid_group( 26 | name='controls', 27 | aliases=['.controls'], 28 | description='Manages terminal controls', 29 | usage='add/remove [emoji] [content..]' 30 | ) 31 | async def controls(self, ctx): 32 | if ctx.invoked_subcommand is None: 33 | pass 34 | 35 | @controls.command() 36 | @session_exists() 37 | async def add(self, ctx: Context, label, content): 38 | terminal: Terminal = sessions().by_channel(ctx.channel) 39 | message: Message = sessions().find_message(terminal) 40 | 41 | view = View.from_message(message) 42 | view.timeout = None 43 | 44 | button = discord.ui.Button(style=discord.ButtonStyle.gray, label=label, custom_id=f'control_{label}') 45 | button.callback = controls_callback 46 | view.add_item(button) 47 | 48 | new_message = await message.edit(view=view) 49 | sessions().update_message_reference(terminal, new_message) 50 | 51 | terminal.add_control(label, content) 52 | 53 | if ctx.interaction: 54 | embed = Embed(description=f"Control added", color=0x00ff00) 55 | await ctx.reply(embed=embed, ephemeral=False, delete_after=0) 56 | 57 | @controls.command() 58 | @session_exists() 59 | async def remove(self, ctx: Context, label: str = None): 60 | terminal: Terminal = sessions().by_channel(ctx.channel) 61 | message: Message = sessions().find_message(terminal) 62 | 63 | terminal.remove_control(label) 64 | view = View.from_message(message) 65 | 66 | for component in view.children: 67 | if component.custom_id == label: 68 | view.remove_item(component) 69 | break 70 | else: 71 | await ctx.reply(content="Couldn't find specified control") 72 | return 73 | 74 | new_message = await message.edit(view=view) 75 | sessions().update_message_reference(terminal, new_message) 76 | 77 | if ctx.interaction: 78 | embed = Embed(description=f"Control removed", color=0xff0000) 79 | await ctx.reply(embed=embed, ephemeral=False, delete_after=0) 80 | 81 | @remove.autocomplete('label') 82 | async def remove_autocomplete(self, interaction: Interaction, current: str): 83 | terminal: Terminal = sessions().by_channel(interaction.channel) 84 | results = terminal.search_control(current) 85 | return [ 86 | app_commands.Choice(name=option, value=option) 87 | for option in results 88 | ] 89 | -------------------------------------------------------------------------------- /bashbot/command/exec.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pty 3 | import subprocess 4 | 5 | from discord.ext import commands 6 | 7 | from bashbot.core.settings import settings 8 | 9 | 10 | class ExecCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='exec', 13 | aliases=['.exec', '.e'], 14 | description='Execute single command', 15 | usage='' 16 | ) 17 | async def exec(self, ctx, *, command): 18 | shell_path = settings().get('terminal.shell_path') 19 | 20 | login_as_other_user = settings().get('terminal.user.login_as_other_user') 21 | if login_as_other_user: 22 | su_path = settings().get('terminal.su_path') 23 | 24 | login = settings().get('terminal.user.username') 25 | password = settings().get('terminal.user.password') 26 | 27 | master, slave = pty.openpty() 28 | subprocess.Popen([su_path, "-", login, "-s", shell_path, '-c', command], stdin=slave, stdout=slave, stderr=slave, universal_newlines=True) 29 | os.read(master, 10240) # ignore prompt 30 | os.write(master, f'{password}\n'.encode()) 31 | os.read(master, 10240) # ignore empty line 32 | output = os.read(master, 10240).rstrip().decode('utf-8') 33 | 34 | os.close(master) 35 | os.close(slave) 36 | else: 37 | output = subprocess.check_output( 38 | [shell_path, '-c', command], 39 | universal_newlines=True, 40 | ) 41 | 42 | await ctx.send(f'```\n{output}\n```') 43 | -------------------------------------------------------------------------------- /bashbot/command/freeze.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | 4 | from bashbot.command import session_exists 5 | from bashbot.constants import EMBED_COLOR 6 | from bashbot.core.exceptions import SessionDontExistException 7 | from bashbot.terminal.sessions import sessions 8 | from bashbot.terminal.terminal import TerminalState 9 | 10 | 11 | class FreezeCommand(commands.Cog): 12 | @commands.hybrid_command( 13 | name='freeze', 14 | aliases=['.freeze', '.f'], 15 | description='Freezes current terminal session' 16 | ) 17 | @session_exists() 18 | async def freeze(self, ctx): 19 | terminal = sessions().by_channel(ctx.message.channel) 20 | 21 | if not terminal: 22 | raise SessionDontExistException() 23 | 24 | if terminal.state == TerminalState.FROZEN: 25 | terminal.state = TerminalState.OPEN 26 | elif terminal.state == TerminalState.OPEN: 27 | terminal.state = TerminalState.FROZEN 28 | 29 | terminal.refresh() 30 | 31 | embed = Embed(description=f"Changed terminal #{terminal.name} state to {terminal.state.name}", color=EMBED_COLOR) 32 | await ctx.send(embed=embed) 33 | -------------------------------------------------------------------------------- /bashbot/command/help.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.constants import THUMBNAIL_URL, EMBED_COLOR, EMBED_COLOR_ERROR 6 | from bashbot.core.settings import settings 7 | 8 | 9 | class HelpCommand(commands.Cog): 10 | @commands.hybrid_command( 11 | name='help', 12 | aliases=['.help'], 13 | description='Shows commands usage help' 14 | ) 15 | async def help(self, ctx: Context, command_name=None): 16 | if command_name: 17 | await self._help_for_command(ctx, command_name) 18 | else: 19 | await self._help_all_commands(ctx) 20 | 21 | @staticmethod 22 | async def _help_for_command(ctx: Context, command_name): 23 | # Command does not exist 24 | if command_name not in ctx.bot.all_commands: 25 | embed = Embed(title=f'BashBot Help', description='Command does not exist', color=EMBED_COLOR_ERROR) 26 | await ctx.send(embed=embed) 27 | return 28 | 29 | # Command found, generate help message 30 | command = ctx.bot.all_commands[command_name] 31 | 32 | # Use brief help if full not found 33 | if command.description: 34 | description = command.description 35 | elif command.brief: 36 | description = command.brief 37 | else: 38 | description = '<>' 39 | 40 | embed = Embed(title=f'BashBot Help for {command_name}', description=description, color=EMBED_COLOR) 41 | embed.set_thumbnail(url=THUMBNAIL_URL) 42 | 43 | first_prefix = settings().get('commands.prefixes')[0] 44 | if ctx.interaction: 45 | command_name = f'/{command.name}' 46 | else: 47 | command_name = f'{first_prefix}' + command.aliases[0] 48 | 49 | if command.usage: 50 | embed.add_field(name='Usage', value=f'{command_name} {command.usage}', inline=False) 51 | else: 52 | embed.add_field(name='Usage', value=f'{command_name}', inline=False) 53 | 54 | await ctx.send(embed=embed) 55 | 56 | @staticmethod 57 | async def _help_all_commands(ctx: Context): 58 | first_prefix = settings().get('commands.prefixes')[0] 59 | 60 | embed = Embed(title='BashBot Help', description=f'For more help type {"/" if ctx.interaction else first_prefix + "."}help [command]', color=EMBED_COLOR) 61 | embed.set_thumbnail(url=THUMBNAIL_URL) 62 | 63 | sorted_commands = sorted(ctx.bot.commands, key=lambda c: c.name) 64 | for command in sorted_commands: 65 | # Use full description if brief not found 66 | if command.brief: 67 | description = command.brief 68 | elif command.description: 69 | description = command.description 70 | else: 71 | description = '<>' 72 | 73 | usage = ' ' + command.usage if command.usage else '' 74 | 75 | if ctx.interaction: 76 | command_name = f'/{command.name}' 77 | else: 78 | command_name = f'{first_prefix}' + command.aliases[0] 79 | 80 | embed.add_field(name=command_name + usage, value=description, inline=False) 81 | 82 | await ctx.send(embed=embed) 83 | -------------------------------------------------------------------------------- /bashbot/command/here.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.command import session_exists 6 | from bashbot.constants import EMBED_COLOR 7 | from bashbot.terminal.sessions import sessions 8 | 9 | 10 | class HereCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='here', 13 | aliases=['.here', '.h'], 14 | description='Moves selected terminal below the user message' 15 | ) 16 | @session_exists() 17 | async def here(self, ctx: Context): 18 | terminal = sessions().by_channel(ctx.channel) 19 | message = sessions().find_message(terminal) 20 | 21 | await message.delete() 22 | sessions().remove(terminal) 23 | 24 | embed = Embed(description=f"Moving terminal...", color=EMBED_COLOR) 25 | message = await ctx.send(embed=embed) 26 | sessions().add(message, terminal) 27 | 28 | terminal.refresh() 29 | -------------------------------------------------------------------------------- /bashbot/command/interactive.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.command import session_exists 6 | from bashbot.constants import EMBED_COLOR 7 | from bashbot.core.exceptions import SessionDontExistException 8 | from bashbot.terminal.sessions import sessions 9 | 10 | 11 | class InteractiveCommand(commands.Cog): 12 | @commands.hybrid_command( 13 | name='interact', 14 | aliases=['.interact', '.i'], 15 | description='Toggles interactive mode where all messages are sent to terminal' 16 | ) 17 | @session_exists() 18 | async def interactive(self, ctx: Context): 19 | terminal = sessions().by_channel(ctx.message.channel) 20 | 21 | if not terminal: 22 | raise SessionDontExistException() 23 | 24 | terminal.interactive = not terminal.interactive 25 | 26 | if terminal.interactive: 27 | embed = Embed(description=f"Entered interactive mode. Repeat command to disable", color=EMBED_COLOR) 28 | await ctx.send(embed=embed) 29 | else: 30 | embed = Embed(description=f"Exited interactive mode", color=EMBED_COLOR) 31 | await ctx.send(embed=embed) 32 | -------------------------------------------------------------------------------- /bashbot/command/macro.py: -------------------------------------------------------------------------------- 1 | from discord import Embed, Interaction, app_commands 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.command import session_exists 6 | from bashbot.constants import EMBED_COLOR 7 | from bashbot.core.macros import execute_macro, search_macro 8 | 9 | 10 | class MacroCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='macro', 13 | aliases=['.macro', '.m'], 14 | description='Executes macro from "macros" directory', 15 | usage='' 16 | ) 17 | @session_exists() 18 | async def macro(self, ctx: Context, macro_name: str): 19 | await execute_macro(ctx, macro_name) 20 | 21 | embed = Embed(description=f"Executed macro {macro_name}", color=EMBED_COLOR) 22 | await ctx.send(embed=embed) 23 | 24 | @macro.autocomplete('macro_name') 25 | async def macro_autocomplete(self, interaction: Interaction, current: str): 26 | results = search_macro(current) 27 | return [ 28 | app_commands.Choice(name=option, value=option) 29 | for option in results 30 | ] 31 | -------------------------------------------------------------------------------- /bashbot/command/open.py: -------------------------------------------------------------------------------- 1 | from discord import Message, Embed 2 | from discord.ext import commands 3 | 4 | from bashbot.core.exceptions import ArgumentFormatException 5 | from bashbot.core.macros import execute_macro 6 | from bashbot.core.settings import settings 7 | from bashbot.terminal.sessions import sessions 8 | from bashbot.terminal.terminal import Terminal 9 | from bashbot.core.utils import parse_template 10 | 11 | 12 | class OpenCommand(commands.Cog): 13 | @commands.hybrid_command( 14 | name='open', 15 | aliases=['.open', '.o'], 16 | description='Opens new terminal session', 17 | usage='[name]' 18 | ) 19 | async def open(self, ctx, name: str = None): 20 | if name and len(name) > 20: 21 | raise ArgumentFormatException('Session name length exceeds 20 characters limit') 22 | 23 | # Auto-generated name 24 | if not name: 25 | name = str(len(sessions().sessions)) 26 | 27 | content = parse_template( 28 | settings().get('terminal.template'), 29 | name=name, 30 | state='OPENING', 31 | content='Waiting for tty..' 32 | ) 33 | message: Message = await ctx.send(content) 34 | 35 | # Prepare terminal 36 | sh_path = settings().get('terminal.shell_path') 37 | 38 | login_as_other_user = settings().get('terminal.user.login_as_other_user') 39 | if login_as_other_user: 40 | su_path = settings().get('terminal.su_path') 41 | login = settings().get('terminal.user.username') 42 | password = settings().get('terminal.user.password') 43 | 44 | terminal = Terminal(name, sh_path=sh_path, on_change=sessions().update_message, su_path=su_path, login=login, password=password) 45 | else: 46 | terminal = Terminal(name, sh_path=sh_path, on_change=sessions().update_message) 47 | 48 | sessions().add(message, terminal) 49 | terminal.open() 50 | 51 | # Run macro on terminal startup 52 | startup_macro = settings().get('terminal.startup_macro') 53 | if startup_macro: 54 | await execute_macro(ctx, startup_macro) 55 | -------------------------------------------------------------------------------- /bashbot/command/rename.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | 4 | from bashbot.command import session_exists 5 | from bashbot.constants import EMBED_COLOR 6 | from bashbot.terminal.sessions import sessions 7 | 8 | 9 | class RenameCommand(commands.Cog): 10 | @commands.hybrid_command( 11 | name='rename', 12 | aliases=['.rename'], 13 | description='Changes session name', 14 | usage='' 15 | ) 16 | @session_exists() 17 | async def rename(self, ctx, new_name): 18 | terminal = sessions().by_channel(ctx.message.channel) 19 | 20 | old_name = terminal.name 21 | terminal.name = new_name 22 | terminal.refresh() 23 | 24 | embed = Embed(description=f"Renamed terminal #{old_name} -> #{new_name}", color=EMBED_COLOR) 25 | await ctx.send(embed=embed) 26 | -------------------------------------------------------------------------------- /bashbot/command/repeat.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.constants import EMBED_COLOR 6 | from bashbot.core.exceptions import SessionDontExistException 7 | from bashbot.terminal.sessions import sessions 8 | 9 | 10 | class RepeatCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='repeat', 13 | aliases=['.repeat', '.r'], 14 | description='Repeats string n times and sends to the current terminal session', 15 | usage='' 16 | ) 17 | async def repeat(self, ctx: Context, n: int, *, text): 18 | terminal = sessions().by_channel(ctx.message.channel) 19 | if not terminal: 20 | raise SessionDontExistException() 21 | 22 | terminal.send_input(text * n) 23 | 24 | if ctx.interaction: 25 | embed = Embed(description=f"Text sent", color=EMBED_COLOR) 26 | await ctx.reply(embed=embed, ephemeral=False, delete_after=0) 27 | -------------------------------------------------------------------------------- /bashbot/command/select.py: -------------------------------------------------------------------------------- 1 | from discord import Embed, Interaction, app_commands 2 | from discord.ext import commands 3 | 4 | from bashbot.constants import EMBED_COLOR 5 | from bashbot.core.exceptions import TerminalNotFoundException 6 | from bashbot.terminal.sessions import sessions 7 | 8 | 9 | class SelectCommand(commands.Cog): 10 | @commands.hybrid_command( 11 | name='select', 12 | aliases=['.select', '.s'], 13 | description='Sets terminal as selected', 14 | usage='[name]' 15 | ) 16 | async def select(self, ctx, name): 17 | terminal = sessions().by_name(name) 18 | if not terminal: 19 | raise TerminalNotFoundException() 20 | 21 | sessions().select(ctx.message.channel, terminal) 22 | embed = Embed(description=f"Selected terminal #{name}", color=EMBED_COLOR) 23 | await ctx.send(embed=embed) 24 | 25 | @select.autocomplete('name') 26 | async def select_autocomplete(self, interaction: Interaction, current: str): 27 | results = sessions().search(current) 28 | return [ 29 | app_commands.Choice(name=option.name, value=option.name) 30 | for option in results 31 | ] 32 | -------------------------------------------------------------------------------- /bashbot/command/submit.py: -------------------------------------------------------------------------------- 1 | from discord import Embed 2 | from discord.ext import commands 3 | from discord.ext.commands import Context 4 | 5 | from bashbot.command import session_exists 6 | from bashbot.constants import EMBED_COLOR 7 | from bashbot.terminal.sessions import sessions 8 | 9 | 10 | class SubmitCommand(commands.Cog): 11 | @commands.hybrid_command( 12 | name='submit', 13 | aliases=['.submit'], 14 | description='Toggles auto submit mode' 15 | ) 16 | @session_exists() 17 | async def submit(self, ctx: Context): 18 | terminal = sessions().by_channel(ctx.channel) 19 | 20 | terminal.auto_submit = not terminal.auto_submit 21 | if terminal.auto_submit: 22 | embed = Embed(description=f"Enabled auto submit mode", color=EMBED_COLOR) 23 | await ctx.send(embed=embed) 24 | else: 25 | embed = Embed(description=f"Disabled auto submit mode", color=EMBED_COLOR) 26 | await ctx.send(embed=embed) 27 | -------------------------------------------------------------------------------- /bashbot/command/whitelist.py: -------------------------------------------------------------------------------- 1 | from discord import User, Embed 2 | from discord.ext import commands 3 | 4 | from bashbot.core.settings import settings 5 | 6 | 7 | class WhitelistCommand(commands.Cog): 8 | @commands.hybrid_group( 9 | name='whitelist', 10 | aliases=['.whitelist'], 11 | description='Manages users whitelist', 12 | usage='add/remove ' 13 | ) 14 | async def controls(self, ctx): 15 | if ctx.invoked_subcommand is None: 16 | pass 17 | 18 | @controls.command() 19 | async def add(self, ctx, user: User): 20 | whitelist = settings().config['discord']['users_whitelist'] 21 | if user.id not in whitelist: 22 | whitelist.append(user.id) 23 | settings().save() 24 | 25 | embed = Embed(description=f"Added user {user.mention} to whitelist", color=0x00ff00) 26 | await ctx.send(embed=embed) 27 | else: 28 | embed = Embed(description=f"User {user.mention} is already on the whitelist", color=0xff0000) 29 | await ctx.send(embed=embed) 30 | 31 | @controls.command() 32 | async def remove(self, ctx, user: User): 33 | whitelist = settings().config['discord']['users_whitelist'] 34 | if user.id in whitelist: 35 | whitelist.remove(user.id) 36 | settings().save() 37 | embed = Embed(description=f"Removed user {user.mention} from whitelist", color=0x00ff00) 38 | await ctx.send(embed=embed) 39 | else: 40 | embed = Embed(description=f"User {user.mention} is not on the whitelist", color=0xff0000) 41 | await ctx.send(embed=embed) 42 | -------------------------------------------------------------------------------- /bashbot/constants.py: -------------------------------------------------------------------------------- 1 | REPOSITORY_AUTHOR = 'adikso' 2 | REPOSITORY_NAME = 'BashBot' 3 | REPOSITORY_URL = f'https://github.com/{REPOSITORY_AUTHOR}/{REPOSITORY_NAME}' 4 | 5 | THUMBNAIL_URL = 'https://cdn.discordapp.com/avatars/258638578798559233/8a50a65e7bfaf661d01db9ca2b617748.png' 6 | EMBED_COLOR = 0x327ef7 7 | EMBED_COLOR_ERROR = 0xff0000 8 | 9 | TIME_BETWEEN_UPDATE_CHECKS = 600 10 | 11 | DEFAULT_CONFIG_PATH = 'config.toml' 12 | DEFAULT_MACRO_PATH = 'macros' 13 | -------------------------------------------------------------------------------- /bashbot/core/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adikso/BashBot/19db2e261217621cc297218cc712de52e8c5f8d9/bashbot/core/__init__.py -------------------------------------------------------------------------------- /bashbot/core/exceptions.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | 3 | 4 | class ArgumentFormatException(commands.CheckFailure): 5 | def __init__(self, message): 6 | self.message = message 7 | 8 | 9 | class SessionDontExistException(commands.CheckFailure): 10 | def __init__(self): 11 | self.message = 'You need to have open terminal to use this command' 12 | 13 | 14 | class TerminalNotFoundException(commands.CheckFailure): 15 | def __init__(self): 16 | self.message = 'Could not find requested terminal' 17 | 18 | 19 | class MacroNotFoundException(commands.CheckFailure): 20 | def __init__(self): 21 | self.message = 'Macro with requested name not found' 22 | -------------------------------------------------------------------------------- /bashbot/core/factory.py: -------------------------------------------------------------------------------- 1 | class SingletonDecorator: 2 | def __init__(self, cls): 3 | self.cls = cls 4 | self.instance = None 5 | 6 | def __call__(self, *args, **kwargs): 7 | if self.instance is None: 8 | self.instance = self.cls(*args, **kwargs) 9 | 10 | return self.instance 11 | 12 | -------------------------------------------------------------------------------- /bashbot/core/macros.py: -------------------------------------------------------------------------------- 1 | from bashbot.core.exceptions import MacroNotFoundException 2 | from bashbot.core.settings import settings 3 | from bashbot.terminal.sessions import sessions 4 | from bashbot.core.utils import extract_prefix 5 | 6 | 7 | async def execute_macro(ctx, name): 8 | terminal = sessions().by_channel(ctx.channel) 9 | 10 | if name not in settings().macros: 11 | raise MacroNotFoundException() 12 | 13 | macro = settings().macros[name] 14 | for line in macro.split('\n'): 15 | if extract_prefix(line): 16 | ctx.message.content = line 17 | await ctx.bot.process_commands(ctx.message) 18 | else: 19 | terminal.send_input(line) 20 | 21 | 22 | def search_macro(phrase): 23 | return [name for name in settings().macros.keys() if name.startswith(phrase)] 24 | -------------------------------------------------------------------------------- /bashbot/core/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | import toml 3 | from pathlib import Path 4 | 5 | from bashbot.constants import DEFAULT_CONFIG_PATH, DEFAULT_MACRO_PATH 6 | from bashbot.core.factory import SingletonDecorator 7 | 8 | 9 | class Settings: 10 | def __init__(self): 11 | self.config: dict = {} 12 | self.macros: dict = {} 13 | 14 | def load(self, path=DEFAULT_CONFIG_PATH): 15 | if os.path.exists(path): 16 | with open(path, 'r') as file: 17 | self.config = toml.load(file) 18 | 19 | # [commands] 20 | self.add_default('commands.prefixes', ['$', '.bash']) 21 | 22 | # [discord] 23 | self.add_default('discord.token', 'TOKEN_HERE') 24 | self.add_default('discord.presence', '{prefix}.help') 25 | self.add_default('discord.disable_dm', True) 26 | self.add_default('discord.enable_users_whitelist', True) 27 | self.add_default('discord.users_whitelist', []) 28 | 29 | # [terminal] 30 | self.add_default('terminal.template', '`| TTY #{name} | {state} |`\n```{content}```') 31 | self.add_default('terminal.shell_path', '/bin/bash') 32 | self.add_default('terminal.su_path', '/bin/su') 33 | self.add_default('terminal.startup_macro', '') 34 | self.add_default('terminal.delete_on_close', False) 35 | self.add_default('terminal.delete_messages', True) 36 | self.add_default('terminal.submit_by_default', True) 37 | self.add_default('terminal.interactive_by_default', False) 38 | self.add_default('terminal.max_refresh_frequency', 0.5) 39 | 40 | # [terminal.interactive] 41 | self.add_default('terminal.interactive.delete_messages', True) 42 | 43 | # [terminal.user] 44 | self.add_default('terminal.user.login_as_other_user', False) 45 | self.add_default('terminal.user.username', 'myuser') 46 | self.add_default('terminal.user.password', 'mypassword') 47 | 48 | # [other] 49 | self.add_default('other.check_for_updates', True) 50 | 51 | self.save() 52 | 53 | def load_macros(self, path=DEFAULT_MACRO_PATH): 54 | os.makedirs(path, exist_ok=True) 55 | 56 | for filename in os.listdir(path): 57 | if filename.endswith('.txt'): 58 | self.macros[filename[:-4]] = Path(path + '/' + filename).read_text() 59 | 60 | def get(self, config_path, default=None): 61 | current_node = self.config 62 | 63 | # Follow dot path 64 | for node_name in config_path.split('.'): 65 | if node_name not in current_node.keys(): 66 | return default 67 | 68 | current_node = current_node[node_name] 69 | 70 | return current_node or default 71 | 72 | def add_default(self, path, value): 73 | current_node = self.config 74 | parts = path.split('.') 75 | 76 | for node_name in parts[:-1]: 77 | if node_name not in current_node.keys(): 78 | current_node[node_name] = {} 79 | 80 | current_node = current_node[node_name] 81 | 82 | if not parts[-1] in current_node: 83 | current_node[parts[-1]] = value 84 | 85 | def save(self, path=DEFAULT_CONFIG_PATH): 86 | with open(path, 'w') as file: 87 | toml.dump(self.config, file) 88 | 89 | 90 | settings = SingletonDecorator(Settings) 91 | -------------------------------------------------------------------------------- /bashbot/core/state.py: -------------------------------------------------------------------------------- 1 | import json 2 | from pathlib import Path 3 | 4 | from bashbot.core.factory import SingletonDecorator 5 | from bashbot.core.updater import Updater 6 | 7 | 8 | class State(dict): 9 | def __init__(self): 10 | super().__init__() 11 | self.path = Path('state.json') 12 | 13 | def load(self): 14 | if self.path.is_file(): 15 | with self.path.open() as source: 16 | self.update(json.load(source)) 17 | else: 18 | self.update({ 19 | 'last_run_version': Updater.get_local_commit() 20 | }) 21 | self.save() 22 | 23 | def save(self): 24 | with self.path.open('w') as source: 25 | json.dump(self, source, indent=2) 26 | 27 | 28 | state = SingletonDecorator(State) 29 | -------------------------------------------------------------------------------- /bashbot/core/updater.py: -------------------------------------------------------------------------------- 1 | import json 2 | import time 3 | from datetime import datetime 4 | from pathlib import Path 5 | 6 | import requests 7 | 8 | from bashbot.core.factory import SingletonDecorator 9 | from bashbot.constants import REPOSITORY_AUTHOR, REPOSITORY_NAME, TIME_BETWEEN_UPDATE_CHECKS 10 | 11 | 12 | class Updater: 13 | def __init__(self): 14 | self.last_check = None 15 | self.cached_updates = None 16 | 17 | def check_for_updates(self): 18 | current_time = int(time.time()) 19 | if self.last_check and current_time - self.last_check < TIME_BETWEEN_UPDATE_CHECKS: 20 | return self.cached_updates 21 | 22 | latest_release = self.get_latest_release() 23 | if latest_release is None: 24 | return None 25 | 26 | local_commit_sha = self.get_local_commit() 27 | if latest_release['target_commitish'] != local_commit_sha: 28 | releases = self.get_new_releases(local_commit_sha) 29 | self.cached_updates = releases 30 | return releases 31 | 32 | return [] 33 | 34 | @staticmethod 35 | def get_latest_release(): 36 | api_url = f'https://api.github.com/repos/{REPOSITORY_AUTHOR}/{REPOSITORY_NAME}/releases/latest' 37 | r = requests.get(api_url) 38 | 39 | if r.status_code != 200: 40 | return None 41 | 42 | return r.json() 43 | 44 | @staticmethod 45 | def get_commit(commit_sha): 46 | api_url = f'https://api.github.com/repos/{REPOSITORY_AUTHOR}/{REPOSITORY_NAME}/commits/{commit_sha}' 47 | r = requests.get(api_url, headers={'X-GitHub-Api-Version': '2022-11-28'}) 48 | 49 | if r.status_code != 200: 50 | return None 51 | 52 | return r.json() 53 | 54 | @staticmethod 55 | def get_new_releases(local_version): 56 | api_url = f'https://api.github.com/repos/{REPOSITORY_AUTHOR}/{REPOSITORY_NAME}/releases' 57 | r = requests.get(api_url, headers={'X-GitHub-Api-Version': '2022-11-28'}) 58 | 59 | if r.status_code != 200: 60 | return None 61 | 62 | data = r.json() 63 | 64 | releases = [] 65 | for release in data: 66 | if release['target_commitish'] == local_version: 67 | break 68 | releases.append(release) 69 | else: 70 | # Find updates if current local commit is not a part of a release 71 | releases = [] 72 | commit = Updater.get_commit(local_version) 73 | commit_date = datetime.fromisoformat(commit['commit']['committer']['date'].replace('Z', '+00:00')) 74 | for release in data: 75 | release_date = datetime.fromisoformat(release['published_at'].replace('Z', '+00:00')) 76 | if release_date <= commit_date: 77 | break 78 | releases.append(release) 79 | 80 | return releases 81 | 82 | @staticmethod 83 | def get_git_commit(): 84 | try: 85 | with open('.git/HEAD', 'r') as file: 86 | content = file.readline() 87 | 88 | if ': ' in content: 89 | ref = content.split(": ")[1].rstrip() 90 | with open(f'.git/{ref}', 'r') as file: 91 | commit_hash = file.readline().rstrip() 92 | else: 93 | commit_hash = content.rstrip() 94 | 95 | return commit_hash 96 | except FileNotFoundError: 97 | return None 98 | 99 | @staticmethod 100 | def get_local_commit(): 101 | build_path = Path('build.json') 102 | if build_path.is_file(): 103 | with build_path.open() as file: 104 | build_details = json.load(file) 105 | return build_details.get('version') 106 | 107 | git_commit = Updater.get_git_commit() 108 | if git_commit: 109 | return git_commit 110 | 111 | 112 | updater = SingletonDecorator(Updater) 113 | -------------------------------------------------------------------------------- /bashbot/core/utils.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import logging 3 | 4 | from bashbot.core.settings import settings 5 | 6 | 7 | def get_logger(name): 8 | logger = logging.getLogger(name) 9 | 10 | handler = logging.FileHandler('bashbot.log') 11 | formatter = logging.Formatter('[%(asctime)s] %(levelname)s:%(name)s: %(message)s') 12 | handler.setFormatter(formatter) 13 | logger.addHandler(handler) 14 | 15 | return logger 16 | 17 | 18 | def parse_template(template, **kwargs): 19 | for key, value in kwargs.items(): 20 | template = template.replace('{' + key + '}', str(value)) 21 | 22 | return template 23 | 24 | 25 | def execute_async(loop, coroutine): 26 | asyncio.run_coroutine_threadsafe(coroutine, loop) 27 | 28 | 29 | def block_escape(text): 30 | return text.replace('```', '`‎`‎`') 31 | 32 | 33 | def extract_prefix(content): 34 | for prefix in settings().get('commands.prefixes'): 35 | if content.startswith(prefix): 36 | return prefix 37 | 38 | 39 | def remove_prefix(content): 40 | prefix = extract_prefix(content) 41 | if prefix: 42 | return content[len(prefix):] 43 | else: 44 | return content 45 | 46 | 47 | def is_command(content): 48 | return any(content.startswith(prefix + '.') for prefix in settings().get('commands.prefixes')) 49 | -------------------------------------------------------------------------------- /bashbot/terminal/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Adikso/BashBot/19db2e261217621cc297218cc712de52e8c5f8d9/bashbot/terminal/__init__.py -------------------------------------------------------------------------------- /bashbot/terminal/control.py: -------------------------------------------------------------------------------- 1 | class TerminalControl: 2 | def __init__(self, emoji, text): 3 | self.emoji = emoji 4 | self.text = text 5 | -------------------------------------------------------------------------------- /bashbot/terminal/sessions.py: -------------------------------------------------------------------------------- 1 | from typing import List 2 | 3 | from discord import TextChannel, Message 4 | 5 | from bashbot.core.factory import SingletonDecorator 6 | from bashbot.core.settings import settings 7 | from bashbot.terminal.terminal import Terminal 8 | from bashbot.core.utils import parse_template, block_escape 9 | 10 | 11 | class Sessions: 12 | def __init__(self): 13 | self.sessions = {} 14 | self.selected = {} 15 | 16 | def add(self, message: Message, terminal: Terminal): 17 | self.sessions[message] = terminal 18 | self.select(message.channel, terminal) 19 | 20 | def select(self, channel: TextChannel, terminal: Terminal): 21 | self.selected[channel] = terminal 22 | 23 | def by_channel(self, channel: TextChannel) -> Terminal: 24 | if channel in self.selected: 25 | return self.selected[channel] 26 | 27 | def by_message(self, searched_message: Message) -> Terminal: 28 | for message, terminal in self.sessions.items(): 29 | if searched_message.id == message.id: 30 | return terminal 31 | 32 | def search(self, phrase: str) -> List[Terminal]: 33 | return [terminal for terminal in self.sessions.values() if terminal.name.startswith(phrase)] 34 | 35 | def by_name(self, name: str) -> Terminal: 36 | for message, terminal in self.sessions.items(): 37 | if terminal.name == name: 38 | return terminal 39 | 40 | def remove(self, terminal: Terminal): 41 | for k in self.sessions.copy(): 42 | if self.sessions[k] == terminal: 43 | del self.sessions[k] 44 | 45 | message: Message = self.find_message(terminal) 46 | if message and message.channel in self.selected: 47 | self.selected.pop(message.channel) 48 | 49 | def find_message(self, terminal: Terminal): 50 | inv_map = {v: k for k, v in self.sessions.items()} 51 | return inv_map.get(terminal) 52 | 53 | def update_message_reference(self, terminal: Terminal, message: Message): 54 | del self.sessions[self.find_message(terminal)] 55 | self.sessions[message] = terminal 56 | 57 | async def update_message(self, terminal: Terminal, content: str): 58 | message = self.find_message(terminal) 59 | 60 | content = parse_template( 61 | settings().get('terminal.template'), 62 | name=terminal.name, 63 | state=terminal.state.name, 64 | content=block_escape(content) 65 | ) 66 | 67 | await message.edit(content=content, embed=None) 68 | 69 | 70 | sessions = SingletonDecorator(Sessions) 71 | -------------------------------------------------------------------------------- /bashbot/terminal/shortcuts.py: -------------------------------------------------------------------------------- 1 | def replace_shortcuts(command): 2 | d = { 3 | '[UP]': u'\u001b[A', 4 | '[DOWN]': u'\u001b[B', 5 | '[LEFT]': u'\u001b[D', 6 | '[RIGHT]': u'\u001b[C', 7 | '[ESC]': u'\u001b', 8 | '[TAB]': u'\u0009', 9 | '[T]': u'\u0009', 10 | '[F1]': u'\u001bOP', 11 | '[F2]': u'\u001bOQ', 12 | '[F3]': u'\u001bOR', 13 | '[F4]': u'\u001bOS', 14 | '[F5]': u'\u001b[15~', 15 | '[F6]': '', 16 | '[F7]': u'\u001b[18', 17 | '[F8]': u'\u001b[19~', 18 | '[F9]': u'\u001b[20~', 19 | '[F10]': u'\u001b[21~', 20 | '[F11]': u'\u001b[23~\u001b', 21 | '[F12]': u'\u001b[24~\u0008', 22 | '[<]': u'\u001b\u0005\u0015', # ^E^U Clears input line 23 | '': u'\u001b', 24 | '\\a': '\a', 25 | '\\b': '\b', 26 | '\\f': '\f', 27 | '\\n': '\n', 28 | '\\r': '\r', 29 | '\\t': '\t', 30 | '\\v': '\v' 31 | } 32 | 33 | ctrl_chars = "@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_" 34 | 35 | for i, char in enumerate(ctrl_chars): 36 | command = command.replace("^" + char, str(chr(i))) 37 | 38 | for initial, to in d.items(): 39 | command = command.replace(initial, to) 40 | 41 | return command 42 | -------------------------------------------------------------------------------- /bashbot/terminal/terminal.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import os 3 | import sys 4 | import threading 5 | import pyte 6 | from enum import Enum 7 | 8 | from bashbot.core.settings import settings 9 | from bashbot.core.utils import execute_async 10 | from bashbot.terminal.control import TerminalControl 11 | from bashbot.terminal.shortcuts import replace_shortcuts 12 | 13 | 14 | class TerminalState(Enum): 15 | CLOSED = 0 16 | OPEN = 1 17 | FROZEN = 2 18 | BROKEN = 3 19 | 20 | 21 | INIT_ENVS = { 22 | 'TERM': 'linux' 23 | } 24 | 25 | 26 | class Terminal: 27 | def __init__(self, name: str, 28 | sh_path: str, su_path: str = None, 29 | login: str = None, password: str = None, 30 | on_change=None): 31 | self.name = name 32 | self.sh_path = sh_path 33 | self.su_path = su_path 34 | self.login = login 35 | self.password = password 36 | self.on_change = on_change 37 | 38 | self.controls = {} 39 | self.interactive = settings().get('terminal.interactive_by_default') 40 | self.auto_submit = settings().get('terminal.submit_by_default') 41 | 42 | self.state: TerminalState = TerminalState.CLOSED 43 | self.screen = pyte.Screen(80, 24) 44 | self.stream = pyte.ByteStream(self.screen) 45 | 46 | self.fd = None 47 | self.content = None 48 | 49 | self.refresh_timer = None 50 | self.event_loop = None 51 | 52 | def open(self): 53 | pid, self.fd = os.forkpty() 54 | self.event_loop = asyncio.get_event_loop() 55 | 56 | if pid == 0: 57 | if self.login: 58 | os.execve(self.su_path, [self.su_path, "-", self.login, "-s", self.sh_path], INIT_ENVS) 59 | else: 60 | os.execve(self.sh_path, [self.sh_path, ], INIT_ENVS) 61 | 62 | sys.exit(0) 63 | else: 64 | self.state = TerminalState.OPEN 65 | 66 | pty_watcher = threading.Thread(target=self.__monitor_pty) 67 | pty_watcher.start() 68 | 69 | def close(self): 70 | self.state = TerminalState.CLOSED 71 | self.refresh() 72 | os.close(self.fd) 73 | 74 | def refresh(self): 75 | if self.refresh_timer and self.refresh_timer.is_alive(): 76 | return 77 | 78 | interval = settings().get('terminal.max_refresh_frequency') 79 | self.refresh_timer = threading.Timer(interval, lambda: { 80 | execute_async(self.event_loop, self.on_change(self, self.content)) 81 | }) 82 | self.refresh_timer.start() 83 | 84 | def send_input(self, data: str): 85 | if self.state != TerminalState.OPEN: 86 | return 87 | 88 | data = replace_shortcuts(data) 89 | 90 | try: 91 | os.write(self.fd, data.encode("utf-8")) 92 | except OSError: 93 | self.state = TerminalState.BROKEN 94 | 95 | def add_control(self, emoji, content): 96 | self.controls[emoji] = TerminalControl(emoji, content) 97 | 98 | def remove_control(self, emoji): 99 | self.controls.pop(emoji) 100 | 101 | def search_control(self, phrase): 102 | return [label for label in self.controls.keys() if label.startswith(phrase)] 103 | 104 | def __monitor_pty(self): 105 | try: 106 | output = os.read(self.fd, 1024) 107 | if self.login: 108 | self.send_input(self.password + '\n') 109 | 110 | while output: 111 | self.stream.feed(output) 112 | self.content = '\n'.join(self.screen.display) 113 | 114 | if self.on_change: 115 | self.refresh() 116 | 117 | output = os.read(self.fd, 1024) 118 | except OSError: 119 | self.state = TerminalState.BROKEN 120 | return 121 | -------------------------------------------------------------------------------- /config.toml.example: -------------------------------------------------------------------------------- 1 | [commands] 2 | prefixes = [ "$", ".bash",] 3 | 4 | [discord] 5 | token = "TOKEN_HERE" 6 | presence = "{prefix}.help" 7 | disable_dm = true 8 | enable_users_whitelist = true 9 | users_whitelist = [] 10 | 11 | [terminal] 12 | template = "`| TTY #{name} | {state} |`\n```{content}```" 13 | shell_path = "/bin/bash" 14 | su_path = "/bin/su" 15 | startup_macro = "" 16 | delete_on_close = false 17 | delete_messages = true 18 | submit_by_default = true 19 | interactive_by_default = false 20 | max_refresh_frequency = 0.5 21 | 22 | [other] 23 | check_for_updates = true 24 | 25 | [terminal.interactive] 26 | delete_messages = true 27 | 28 | [terminal.user] 29 | login_as_other_user = false 30 | username = "myuser" 31 | password = "mypassword" 32 | -------------------------------------------------------------------------------- /macros/example.txt: -------------------------------------------------------------------------------- 1 | $.controls add 🍋 abcd 2 | whoami\n -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | toml~=0.10.1 2 | pyte~=0.8.0 3 | discord.py==2.3.2 4 | requests --------------------------------------------------------------------------------