├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── README_IMAGES │ ├── Form_Clone_ExcludeFiles.png │ ├── Form_Clone_Progress.png │ ├── Form_Clone_SFTP.png │ ├── Form_Clone_Transfer.png │ ├── Form_FileExplorer.png │ ├── Form_Main.png │ ├── Form_PluginManager.png │ ├── Form_PluginManager_EnDisPlugins.png │ └── Form_PluginManager_LoadPlugin.png ├── .gitignore ├── .poggit.yml ├── LICENSE ├── README.md ├── composer.json ├── composer.lock ├── phpstan.neon.dist ├── plugin.yml ├── resources ├── config.yml └── servertools_logo.png └── src └── matcracker └── ServerTools ├── EventListener.php ├── Main.php ├── commands └── ServerToolsCommand.php ├── forms ├── MainMenuForm.php ├── cloning │ ├── BaseFTPForm.php │ ├── CloneForm.php │ ├── ExcludeFilesForm.php │ ├── FTPForm.php │ └── SFTPForm.php ├── elements │ ├── PermissibleMenuOption.php │ └── TaggedMenuOption.php ├── files │ ├── DeleteFileForm.php │ ├── DeleteFolderForm.php │ ├── FileEditorForm.php │ ├── FileExplorerForm.php │ ├── FileInputForm.php │ ├── NewFileForm.php │ ├── NewFolderForm.php │ ├── RenameFileForm.php │ └── RenameFolderForm.php └── plugins │ ├── downloader │ ├── DownloadPluginForm.php │ ├── SearchPluginForm.php │ └── SearchResultsForm.php │ └── manager │ ├── PluginEnablerForm.php │ └── PluginManagerForm.php ├── ftp ├── BaseFTPHandler.php ├── FTPHandler.php └── SFTPHandler.php ├── task ├── async │ ├── DownloadPluginTask.php │ ├── FTPThread.php │ ├── GetPoggitReleases.php │ └── SearchPluginTask.php └── thread │ └── RestartWindowsServer.php └── utils ├── FormUtils.php └── Utils.php /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Unexpected non-crash behaviour (except missing features). If this doesn’t look 4 | right 5 | title: '' 6 | labels: '' 7 | assignees: '' 8 | 9 | --- 10 | 11 | ### Issue description 12 | 13 | - Expected result: What were you expecting to happen? 14 | - Actual result: What actually happened? 15 | 16 | ### Steps to reproduce the issue 17 | 1. ... 18 | 2. ... 19 | 20 | ### OS and versions 21 | 22 | * ServerTools: 23 | 24 | * PocketMine-MP: 25 | * PHP: 26 | * Server OS: 27 | * Game version: PE/Win10 (delete as appropriate) 28 | 29 | ### Plugins 30 | 31 | 32 | - If you remove all plugins, does the issue still occur? 33 | - If the issue is **not** reproducible without plugins: 34 | - Can you provide sample, *minimal* reproducing code for the issue? If so, paste it in the bottom section 35 | 36 | ### Crashdump, backtrace or other files 37 | 38 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | 12 | 13 | **Describe the solution you'd like** 14 | 15 | 16 | **Describe alternatives you've considered** 17 | 18 | 19 | **Additional context** 20 | 21 | -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_Clone_ExcludeFiles.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_Clone_ExcludeFiles.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_Clone_Progress.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_Clone_Progress.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_Clone_SFTP.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_Clone_SFTP.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_Clone_Transfer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_Clone_Transfer.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_FileExplorer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_FileExplorer.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_Main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_Main.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_PluginManager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_PluginManager.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_PluginManager_EnDisPlugins.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_PluginManager_EnDisPlugins.png -------------------------------------------------------------------------------- /.github/README_IMAGES/Form_PluginManager_LoadPlugin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/.github/README_IMAGES/Form_PluginManager_LoadPlugin.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | /vendor 3 | /libs 4 | /scripts 5 | /.php_cs.cache 6 | TODO -------------------------------------------------------------------------------- /.poggit.yml: -------------------------------------------------------------------------------- 1 | branches: 2 | - master 3 | pulls: false 4 | projects: 5 | ServerTools: 6 | path: "" 7 | icon: resources/servertools_logo.png 8 | libs: 9 | - src: ifera-mc/UpdateNotifier/UpdateNotifier 10 | version: ~3.0.0 11 | - src: ifera-mc/ConfigUpdater/ConfigUpdater 12 | version: ~2.0.0 13 | - src: dktapps-pm-pl/pmforms/pmforms 14 | version: ~2.1.0 15 | ... 16 | -------------------------------------------------------------------------------- /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 | [![](https://poggit.pmmp.io/shield.state/ServerTools)](https://poggit.pmmp.io/p/ServerTools) 2 | [![](https://poggit.pmmp.io/shield.dl.total/ServerTools)](https://poggit.pmmp.io/p/ServerTools) 3 | [![Discord](https://img.shields.io/discord/620519017148579841.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/Uf6U78g) 4 | 5 | # ServerTools 6 | ServerTools is PocketMine-MP plugin containing a set of tools that allows you to manage your server directly from the game! 7 | 8 | ## Features 9 | - File Explorer 10 | - Cloning 11 | - Plugin Manager 12 | - Poggit Plugin Downloader 13 | - Restart Server 14 | 15 | **Menu UI example:** 16 | 17 | ![Main_Menu](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_Main.png) 18 | 19 | ## Commands 20 | - **/servertools** (or alias: **/st**) - _The main command of plugin_ (**Permission (default OP)** _st.command.servertools_) 21 | 22 | ## File Explorer 23 | **Permission (default OP):** _st.ui.file-explorer_
24 | **Permission to create/edit files and folders (default false):** _st.ui.file-explorer.write_ 25 | 26 | It allows to: 27 | - Explore your server files and folder 28 | - Read your files **(max file size is ~10.25 kB)** 29 | - Create, rename, delete and edit files and folders **(requires write permission)** 30 | 31 | ![FileExplorer](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_FileExplorer.png) 32 | 33 | ### Reading file example 34 | ![ReadFile](https://github.com/matcracker/ImageContainer/blob/master/ServerTools/Form_FE_ReadFile.gif) 35 | 36 | ### Editing file example 37 | ![EditFile](https://github.com/matcracker/ImageContainer/blob/master/ServerTools/Form_FE_WriteFile.gif) 38 | 39 | ## Cloning 40 | **Permission (default false):** _st.ui.clone_ 41 | 42 | It allows to clone your server using **FTP** (also available with SSL) or **SFTP** protocols. 43 | 44 | ### Requirements 45 | - **FTP**: you need to have installed on your server the **_"ftp"_ PHP extension**. 46 | - **SFTP**: you need to have installed on your server the **_"openssl"_ and _"ssh2 (libssh2)"_ PHP extensions**. 47 | 48 | ### Steps 49 | 1. Select the transfer mode.
50 | ![TransferMode](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_Clone_Transfer.png) 51 | 52 | 2. Compile the information to login to your FTP/SFTP server.
53 | ![FTP_Data](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_Clone_SFTP.png) 54 | 55 | 3. Choose, if you want, some server folders/files to exclude from your clonation.
56 | ![ExcludeFiles](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_Clone_ExcludeFiles.png) 57 | 58 | 4. Wait until the process is finished.
59 | ![Progress](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_Clone_Progress.png) 60 | 61 | ## Plugin Manager 62 | **Permission (default false):** _st.ui.plugin-manager_ 63 | 64 | ![PluginManager](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_PluginManager.png) 65 | 66 | It allows to: 67 | - Enable/Disable plugins
68 | ![EnableDisablePlugin](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_PluginManager_EnDisPlugins.png) 69 | 70 | - Load a plugin from file (.phar)
71 | ![LoadPharPlugin](https://github.com/matcracker/ServerTools/blob/master/.github/README_IMAGES/Form_PluginManager_LoadPlugin.png) 72 | 73 | ## Poggit Plugin Downloader 74 | **Permission (default false):** _st.ui.poggit-downloader_ 75 | 76 | It allows to search and download to your server a plugin from poggit website. 77 | 78 | ![PoggitDownloader](https://github.com/matcracker/ImageContainer/blob/master/ServerTools/Form_PoggitDownloader.gif) 79 | 80 | ## Restart Server 81 | **Permission (default OP):** _st.ui.restart_ 82 | 83 | It simply restarts your server. 84 | 85 | ## F.A.Q. 86 | 1. **I get the message "You do not have permission to use this function" or similar, why?** 87 | - Some functions of the plugin are very dangerous if given to all the operators of your server, because they could cause irreparable damage. To avoid this, the plugin disables the use of these functions and to be enabled you need to use a third-party plugin for managing permissions (e.g. [PurePerms](https://poggit.pmmp.io/p/PurePerms) or similar) and add to yourself or whoever you trust the permissions of the various features of you need. The permission of each feature can be found in the respective chapter. -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "matcracker/servertools", 3 | "description": "ServerTools is PocketMine-MP plugin containing a set of tools that allows you to manage your server directly from the game!", 4 | "minimum-stability": "stable", 5 | "license": "LGPL-3.0", 6 | "authors": [ 7 | { 8 | "name": "matcracker" 9 | } 10 | ], 11 | "require": { 12 | "pocketmine/pocketmine-mp": "^5.0.0", 13 | "dktapps/pmforms": "dev-master" 14 | }, 15 | "require-dev": { 16 | "sof3/pharynx": "^0.3.0" 17 | }, 18 | "autoload": { 19 | "classmap": [ 20 | "src" 21 | ] 22 | } 23 | } -------------------------------------------------------------------------------- /phpstan.neon.dist: -------------------------------------------------------------------------------- 1 | parameters: 2 | level: 5 3 | checkMissingIterableValueType: false 4 | paths: 5 | - /source/src 6 | bootstrapFiles: 7 | - phar:///pocketmine/PocketMine-MP.phar/vendor/autoload.php 8 | scanDirectories: 9 | - /source/src 10 | - /deps -------------------------------------------------------------------------------- /plugin.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: ServerTools 3 | main: matcracker\ServerTools\Main 4 | version: 0.6.0 5 | api: 5.0.0 6 | 7 | load: POSTWORLD 8 | author: matcracker 9 | description: "ServerTools is a set of tools that allows you to manage your server directly from the game!" 10 | website: https://github.com/matcracker/ServerTools 11 | permissions: 12 | st.command.servertools: 13 | description: "Allows the user to run the command /servertools" 14 | default: op 15 | st.ui.file-explorer: 16 | description: "Allows to use the file explorer function" 17 | default: op 18 | st.ui.file-explorer.write: 19 | description: "Give the permission to create/edit files and folders." 20 | default: false 21 | st.ui.clone: 22 | description: "Allows to use the cloning function" 23 | default: false 24 | st.ui.plugin-manager: 25 | description: "Allows to use the plugin manager function" 26 | default: false 27 | st.ui.poggit-downloader: 28 | description: "Allows to use the poggit plugin downloader function" 29 | default: false 30 | st.ui.restart: 31 | description: "Allows to use the restart function" 32 | default: op 33 | ... -------------------------------------------------------------------------------- /resources/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # DON'T EDIT THE CONFIG VERSION VALUE! 3 | config-version: 2 4 | 5 | # Restart configuration 6 | # Put the executable file name to start the server. 7 | # Example: 8 | # - Windows should be "start.cmd" 9 | # - Other platform should be "start.sh" 10 | restart: 11 | file-name: "start.sh" 12 | 13 | # Settings related to Poggit Plugin Downloader 14 | poggit: 15 | # Maximum time (in seconds) allowed to fetch the plugins list from Poggit. 16 | # Increase this parameter if your internet speed is slow. 17 | timeout: 30 18 | # ServerTools saves the plugins list from Poggit to permit the next time a fast search. 19 | # This parameter allow to save the plugin list after 24 hours. 20 | invalidate-cache: 24 21 | 22 | # =========== WARNING =========== 23 | # Some functions of the plugin are very dangerous if given to all the operators of your server, 24 | # because they could cause irreparable damage. To avoid this, the plugin disables the use of 25 | # these functions and to be enabled you need to use a third-party plugin 26 | # for managing permissions (e.g. PurePerms or similar) and add to yourself or whoever you trust 27 | # the permissions of the various features of you need. 28 | # However, at your own risk, enabling the underlying setting will allow all operators 29 | # to be able to use the plugin functions. 30 | op-bypass-permissions: false 31 | ... -------------------------------------------------------------------------------- /resources/servertools_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/matcracker/ServerTools/ae04f5e4818b9684b7221945ee1033d0eb09edd0/resources/servertools_logo.png -------------------------------------------------------------------------------- /src/matcracker/ServerTools/EventListener.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools; 25 | 26 | use matcracker\ServerTools\forms\files\FileEditorForm; 27 | use pocketmine\event\Listener; 28 | use pocketmine\event\player\PlayerEditBookEvent; 29 | use pocketmine\event\player\PlayerPreLoginEvent; 30 | use pocketmine\nbt\NoSuchTagException; 31 | use pocketmine\scheduler\ClosureTask; 32 | use pocketmine\utils\TextFormat; 33 | use function basename; 34 | use function file_put_contents; 35 | use function is_writable; 36 | 37 | final class EventListener implements Listener{ 38 | 39 | public function __construct(private readonly Main $plugin){ 40 | 41 | } 42 | 43 | /** 44 | * @param PlayerPreLoginEvent $event 45 | * 46 | * @priority HIGHEST 47 | */ 48 | public function onPlayerPreLogin(PlayerPreLoginEvent $event) : void{ 49 | if($this->plugin->isCloning){ 50 | $event->setKickFlag(PlayerPreLoginEvent::KICK_FLAG_PLUGIN, "Cloning in progress. Retry later."); 51 | } 52 | } 53 | 54 | public function onPlayerEditBook(PlayerEditBookEvent $event) : void{ 55 | if($event->getAction() !== PlayerEditBookEvent::ACTION_SIGN_BOOK){ 56 | return; 57 | } 58 | 59 | $oldBook = $event->getOldBook(); 60 | try{ 61 | $filePath = $oldBook->getNamedTag()->getString(FileEditorForm::FILE_TAG); 62 | }catch(NoSuchTagException){ 63 | return; 64 | } 65 | 66 | $player = $event->getPlayer(); 67 | 68 | $fileName = basename($filePath); 69 | if(!is_writable($filePath)){ 70 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "The file \"$fileName\" does not exist or is not writable.")); 71 | 72 | return; 73 | } 74 | 75 | $newFileContent = ""; 76 | foreach($oldBook->getPages() as $page){ 77 | $newFileContent .= $page->getText(); 78 | } 79 | 80 | if(file_put_contents($filePath, $newFileContent) === false){ 81 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Error while saving the new content of file \"$fileName\".")); 82 | }else{ 83 | $newBook = $event->getNewBook(); 84 | //Remove the book from the hotbar 85 | $this->plugin->getScheduler()->scheduleDelayedTask( 86 | new ClosureTask(static fn() => $player?->getInventory()->remove($newBook)), 87 | 1 88 | ); 89 | 90 | $player->sendMessage(Main::formatMessage(TextFormat::GREEN . "File successfully edited!")); 91 | } 92 | 93 | } 94 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/Main.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools; 25 | 26 | use JackMD\ConfigUpdater\ConfigUpdater; 27 | use JackMD\UpdateNotifier\UpdateNotifier; 28 | use matcracker\ServerTools\commands\ServerToolsCommand; 29 | use matcracker\ServerTools\task\thread\RestartWindowsServer; 30 | use pocketmine\player\Player; 31 | use pocketmine\plugin\PluginBase; 32 | use pocketmine\plugin\PluginException; 33 | use pocketmine\Server; 34 | use pocketmine\utils\TextFormat; 35 | use pocketmine\utils\Utils; 36 | use Symfony\Component\Filesystem\Path; 37 | use function file_exists; 38 | use function mb_strtolower; 39 | use function pcntl_exec; 40 | use function register_shutdown_function; 41 | use function sprintf; 42 | 43 | final class Main extends PluginBase{ 44 | private const CONFIG_VERSION = 2; 45 | public const PLUGIN_NAME = "ServerTools"; 46 | public bool $isCloning = false; 47 | 48 | public static function formatMessage(string $message) : string{ 49 | return TextFormat::AQUA . sprintf("[%s] ", self::PLUGIN_NAME) . TextFormat::RESET . $message; 50 | } 51 | 52 | public function restartServer() : bool{ 53 | $startFileName = $this->getConfig()->getNested("restart.file-name"); 54 | 55 | if(!file_exists($startFileName)){ 56 | return false; 57 | } 58 | 59 | $this->getLogger()->notice(self::formatMessage("Restarting the server...")); 60 | 61 | if(Utils::getOS() === Utils::OS_WINDOWS){ 62 | (new RestartWindowsServer($startFileName))->start(); 63 | }else{ 64 | register_shutdown_function(static fn() => pcntl_exec("./$startFileName")); 65 | } 66 | 67 | $this->getServer()->shutdown(); 68 | 69 | return true; 70 | } 71 | 72 | public function onLoad() : void{ 73 | UpdateNotifier::checkUpdate($this->getName(), $this->getDescription()->getVersion()); 74 | } 75 | 76 | public function onEnable() : void{ 77 | ConfigUpdater::checkUpdate($this, $this->getConfig(), "config-version", self::CONFIG_VERSION); 78 | 79 | $this->getServer()->getCommandMap()->register(mb_strtolower($this->getName()), new ServerToolsCommand($this)); 80 | $this->getServer()->getPluginManager()->registerEvents(new EventListener($this), $this); 81 | } 82 | 83 | public function getServerDataPath() : string{ 84 | return Path::canonicalize($this->getServer()->getDataPath()); 85 | } 86 | 87 | public function canBypassPermission(Player $player) : bool{ 88 | $isOp = $this->getServer()->isOp($player->getName()); 89 | 90 | return $isOp && $this->getConfig()->get("op-bypass-permissions"); 91 | } 92 | 93 | public static function getInstance() : Main{ 94 | $instance = Server::getInstance()->getPluginManager()->getPlugin(self::PLUGIN_NAME); 95 | 96 | if(!($instance instanceof Main)){ 97 | throw new PluginException(sprintf("%s instance could not be accessed because it is disabled or not loaded yet.", self::PLUGIN_NAME)); 98 | } 99 | 100 | return $instance; 101 | } 102 | 103 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/commands/ServerToolsCommand.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\commands; 25 | 26 | use matcracker\ServerTools\forms\MainMenuForm; 27 | use matcracker\ServerTools\Main; 28 | use pocketmine\command\Command; 29 | use pocketmine\command\CommandSender; 30 | use pocketmine\player\Player; 31 | use pocketmine\plugin\PluginOwned; 32 | use pocketmine\utils\TextFormat; 33 | use function mb_strtolower; 34 | 35 | final class ServerToolsCommand extends Command implements PluginOwned{ 36 | 37 | public function __construct(private readonly Main $plugin){ 38 | $pluginName = $plugin->getName(); 39 | parent::__construct( 40 | mb_strtolower($pluginName), 41 | "Main command for $pluginName plugin.", 42 | "/servertools", 43 | ["servertool", "st"] 44 | ); 45 | $this->setPermission("st.command.servertools"); 46 | $this->setPermissionMessage(Main::formatMessage(TextFormat::RED . "You do not have permission to use this command")); 47 | } 48 | 49 | public function execute(CommandSender $sender, string $commandLabel, array $args) : bool{ 50 | if(!($sender instanceof Player)){ 51 | $sender->sendMessage(Main::formatMessage("The command must be run in-game.")); 52 | 53 | return false; 54 | } 55 | 56 | if(!$this->testPermission($sender)){ 57 | return false; 58 | } 59 | 60 | $sender->sendForm(new MainMenuForm($this->plugin)); 61 | 62 | return true; 63 | } 64 | 65 | public function getOwningPlugin() : Main{ 66 | return $this->plugin; 67 | } 68 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/MainMenuForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms; 25 | 26 | use dktapps\pmforms\MenuForm; 27 | use matcracker\ServerTools\forms\cloning\CloneForm; 28 | use matcracker\ServerTools\forms\elements\PermissibleMenuOption; 29 | use matcracker\ServerTools\forms\files\FileExplorerForm; 30 | use matcracker\ServerTools\forms\plugins\downloader\SearchPluginForm; 31 | use matcracker\ServerTools\forms\plugins\manager\PluginManagerForm; 32 | use matcracker\ServerTools\ftp\FTPHandler; 33 | use matcracker\ServerTools\ftp\SFTPHandler; 34 | use matcracker\ServerTools\Main; 35 | use matcracker\ServerTools\utils\FormUtils; 36 | use pocketmine\player\Player; 37 | use pocketmine\utils\TextFormat; 38 | 39 | final class MainMenuForm extends MenuForm{ 40 | 41 | public function __construct(Main $plugin){ 42 | static $options = [ 43 | new PermissibleMenuOption("st.ui.file-explorer", "File Explorer"), 44 | new PermissibleMenuOption("st.ui.clone", "Clone Server"), 45 | new PermissibleMenuOption("st.ui.plugin-manager", "Plugin Manager"), 46 | new PermissibleMenuOption("st.ui.poggit-downloader", "Poggit Plugin Downloader"), 47 | new PermissibleMenuOption("st.ui.restart", "Restart Server") 48 | ]; 49 | 50 | parent::__construct( 51 | $plugin->getName(), 52 | "Select an option", 53 | $options, 54 | static function(Player $player, int $selectedOption) use ($plugin, $options) : void{ 55 | if(!$player->hasPermission($options[$selectedOption]->getPermission()) && !$plugin->canBypassPermission($player)){ 56 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "You do not have permission to use this function")); 57 | 58 | return; 59 | } 60 | 61 | switch($selectedOption){ 62 | case 0: 63 | $player->sendForm(new FileExplorerForm($plugin, $plugin->getServerDataPath(), $player)); 64 | break; 65 | case 1: 66 | if(FTPHandler::hasExtension() || SFTPHandler::hasExtension()){ 67 | $player->sendForm(new CloneForm($plugin)); 68 | }else{ 69 | $player->sendForm(FormUtils::getConfirmForm( 70 | "Missing extensions!", 71 | TextFormat::RED . "The server is missing the following PHP extensions:\n" . 72 | "- ftp > for FTP feature\n" . 73 | "- openssl > for SFTP feature\n" . 74 | "- libssh2 > for SFTP feature\n", 75 | FormUtils::onClose(new self($plugin)) 76 | )); 77 | } 78 | break; 79 | case 2: 80 | $player->sendForm(new PluginManagerForm($plugin)); 81 | break; 82 | case 3: 83 | $player->sendForm(new SearchPluginForm($plugin)); 84 | break; 85 | case 4: 86 | if(!$plugin->restartServer()){ 87 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not restart the server.")); 88 | } 89 | 90 | break; 91 | } 92 | } 93 | ); 94 | } 95 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/cloning/BaseFTPForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\cloning; 25 | 26 | use dktapps\pmforms\CustomForm; 27 | use dktapps\pmforms\CustomFormResponse; 28 | use dktapps\pmforms\element\CustomFormElement; 29 | use dktapps\pmforms\element\Input; 30 | use dktapps\pmforms\element\Label; 31 | use matcracker\ServerTools\forms\MainMenuForm; 32 | use matcracker\ServerTools\ftp\BaseFTPHandler; 33 | use matcracker\ServerTools\Main; 34 | use matcracker\ServerTools\utils\FormUtils; 35 | use pocketmine\player\Player; 36 | use pocketmine\utils\TextFormat; 37 | use function ctype_digit; 38 | 39 | abstract class BaseFTPForm extends CustomForm{ 40 | protected const FORM_KEY_LABEL = "label"; 41 | protected const FORM_KEY_HOST = "host"; 42 | protected const FORM_KEY_PORT = "port"; 43 | protected const FORM_KEY_USERNAME = "username"; 44 | protected const FORM_KEY_PWD = "password"; 45 | protected const FORM_KEY_PATH = "remote_path"; 46 | 47 | public function __construct(Main $plugin, string $title){ 48 | parent::__construct( 49 | $title, 50 | $this->getFormElements(), 51 | function(Player $player, CustomFormResponse $response) use ($plugin) : void{ 52 | $port = $response->getString(self::FORM_KEY_PORT); 53 | 54 | if(!ctype_digit($port)){ 55 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Invalid port. The port must be a numeric value.")); 56 | }elseif(((int) $port < 1 || (int) $port > 65535)){ 57 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Invalid port range. The port must be in range 1-65535")); 58 | }else{ 59 | $player->sendForm(new ExcludeFilesForm($plugin, $this, $this->getFTPHandler($response))); 60 | } 61 | }, 62 | FormUtils::onClose(new MainMenuForm($plugin)) 63 | ); 64 | } 65 | 66 | protected abstract function getFTPHandler(CustomFormResponse $response) : BaseFTPHandler; 67 | 68 | /** 69 | * @return CustomFormElement[] 70 | */ 71 | protected function getFormElements() : array{ 72 | return [ 73 | new Label(self::FORM_KEY_LABEL, "The following form will not immediately validated."), 74 | new Input(self::FORM_KEY_HOST, "Host address"), 75 | new Input(self::FORM_KEY_PORT, "Port", defaultText: "21"), 76 | new Input(self::FORM_KEY_USERNAME, "Username", "admin"), 77 | new Input(self::FORM_KEY_PWD, "Password"), 78 | new Input(self::FORM_KEY_PATH, "Remote home path", defaultText: "/") 79 | ]; 80 | } 81 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/cloning/CloneForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\cloning; 25 | 26 | use dktapps\pmforms\MenuForm; 27 | use dktapps\pmforms\MenuOption; 28 | use matcracker\ServerTools\forms\MainMenuForm; 29 | use matcracker\ServerTools\ftp\FTPHandler; 30 | use matcracker\ServerTools\ftp\SFTPHandler; 31 | use matcracker\ServerTools\Main; 32 | use matcracker\ServerTools\utils\FormUtils; 33 | use pocketmine\form\FormValidationException; 34 | use pocketmine\player\Player; 35 | 36 | final class CloneForm extends MenuForm{ 37 | 38 | public function __construct(Main $plugin){ 39 | $options = []; 40 | 41 | if(SFTPHandler::hasExtension()){ 42 | $options[] = new MenuOption("SFTP"); 43 | } 44 | 45 | if(FTPHandler::hasExtension()){ 46 | $options[] = new MenuOption("FTP"); 47 | } 48 | 49 | parent::__construct( 50 | "Transfer Mode", 51 | "Select a mode to send your server data to another one.", 52 | $options, 53 | function(Player $player, int $selectedOption) use($plugin) : void{ 54 | $form = match ($selectedOption) { 55 | 0 => SFTPHandler::hasExtension() ? new SFTPForm($plugin) : new FTPForm($plugin), 56 | 1 => new SFTPForm($plugin), 57 | default => throw new FormValidationException("Unexpected option $selectedOption"), 58 | }; 59 | $player->sendForm($form); 60 | }, 61 | FormUtils::onClose(new MainMenuForm($plugin)) 62 | ); 63 | } 64 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/cloning/ExcludeFilesForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\cloning; 25 | 26 | use dktapps\pmforms\CustomForm; 27 | use dktapps\pmforms\CustomFormResponse; 28 | use dktapps\pmforms\element\Label; 29 | use dktapps\pmforms\element\Toggle; 30 | use matcracker\ServerTools\ftp\BaseFTPHandler; 31 | use matcracker\ServerTools\Main; 32 | use matcracker\ServerTools\task\async\FTPThread; 33 | use matcracker\ServerTools\utils\FormUtils; 34 | use matcracker\ServerTools\utils\Utils; 35 | use pocketmine\player\Player; 36 | use function assert; 37 | use function count; 38 | 39 | final class ExcludeFilesForm extends CustomForm{ 40 | 41 | private const KEY_EXCLUDE_FILES = "exclude_files"; 42 | 43 | public function __construct(Main $plugin, BaseFTPForm $form, BaseFTPHandler $ftpHandler){ 44 | $elements = [ 45 | new Label(self::KEY_EXCLUDE_FILES, "Do you want to exclude something from the clone?") 46 | ]; 47 | 48 | $fileList = Utils::getSortedFileList($plugin->getServerDataPath()); 49 | /** @var array $files */ 50 | $files = []; 51 | foreach($fileList as $file){ 52 | $fileName = $file->getFilename(); 53 | $files[$fileName] = $file->getRealPath(); 54 | $elements[] = new Toggle($fileName, $fileName); 55 | } 56 | 57 | assert(count($elements) > 1); 58 | 59 | parent::__construct( 60 | "Exclude files", 61 | $elements, 62 | static function(Player $player, CustomFormResponse $response) use ($plugin, $ftpHandler, $files) : void{ 63 | foreach($response->getAll() as $fileNameKey => $toggled){ 64 | if($fileNameKey === self::KEY_EXCLUDE_FILES){ 65 | continue; 66 | } 67 | 68 | if($toggled){ 69 | unset($files[$fileNameKey]); 70 | } 71 | } 72 | 73 | new FTPThread($plugin, $ftpHandler, $files); 74 | }, 75 | FormUtils::onClose($form) 76 | ); 77 | } 78 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/cloning/FTPForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\cloning; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use dktapps\pmforms\element\Toggle; 28 | use matcracker\ServerTools\ftp\BaseFTPHandler; 29 | use matcracker\ServerTools\ftp\FTPHandler; 30 | use matcracker\ServerTools\Main; 31 | 32 | class FTPForm extends BaseFTPForm{ 33 | 34 | protected const FORM_KEY_SSL = "ssl"; 35 | 36 | public function __construct(Main $plugin){ 37 | parent::__construct($plugin, "FTP Settings"); 38 | } 39 | 40 | protected function getFTPHandler(CustomFormResponse $response) : BaseFTPHandler{ 41 | return new FTPHandler( 42 | $response->getString(self::FORM_KEY_HOST), 43 | (int) $response->getString(self::FORM_KEY_PORT), 44 | $response->getString(self::FORM_KEY_USERNAME), 45 | $response->getString(self::FORM_KEY_PWD), 46 | $response->getString(self::FORM_KEY_PATH), 47 | $response->getBool(self::FORM_KEY_SSL) 48 | ); 49 | } 50 | 51 | protected function getFormElements() : array{ 52 | $elements = parent::getFormElements(); 53 | 54 | $elements[] = new Toggle(self::FORM_KEY_SSL, "Use SSL", true); 55 | 56 | return $elements; 57 | } 58 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/cloning/SFTPForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\cloning; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use matcracker\ServerTools\ftp\BaseFTPHandler; 28 | use matcracker\ServerTools\ftp\SFTPHandler; 29 | use matcracker\ServerTools\Main; 30 | 31 | class SFTPForm extends BaseFTPForm{ 32 | 33 | public function __construct(Main $plugin){ 34 | parent::__construct($plugin, "SFTP Settings"); 35 | } 36 | 37 | protected function getFTPHandler(CustomFormResponse $response) : BaseFTPHandler{ 38 | return new SFTPHandler( 39 | $response->getString(self::FORM_KEY_HOST), 40 | (int) $response->getString(self::FORM_KEY_PORT), 41 | $response->getString(self::FORM_KEY_USERNAME), 42 | $response->getString(self::FORM_KEY_PWD), 43 | $response->getString(self::FORM_KEY_PATH) 44 | ); 45 | } 46 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/elements/PermissibleMenuOption.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\elements; 25 | 26 | use dktapps\pmforms\FormIcon; 27 | use dktapps\pmforms\MenuOption; 28 | 29 | class PermissibleMenuOption extends MenuOption{ 30 | 31 | public function __construct(private readonly string $permission, string $text, ?FormIcon $image = null){ 32 | parent::__construct($text, $image); 33 | } 34 | 35 | public function getPermission() : string{ 36 | return $this->permission; 37 | } 38 | 39 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/elements/TaggedMenuOption.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\elements; 25 | 26 | use dktapps\pmforms\FormIcon; 27 | use dktapps\pmforms\MenuOption; 28 | 29 | class TaggedMenuOption extends MenuOption{ 30 | 31 | public function __construct(private readonly string $tag, string $text, ?FormIcon $image = null){ 32 | parent::__construct($text, $image); 33 | } 34 | 35 | public function getTag() : string{ 36 | return $this->tag; 37 | } 38 | 39 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/DeleteFileForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\ModalForm; 27 | use InvalidArgumentException; 28 | use matcracker\ServerTools\Main; 29 | use pocketmine\player\Player; 30 | use pocketmine\utils\TextFormat; 31 | use function dirname; 32 | use function is_file; 33 | use function unlink; 34 | 35 | final class DeleteFileForm extends ModalForm{ 36 | 37 | public function __construct(Main $plugin, string $filePath){ 38 | if(!is_file($filePath)){ 39 | throw new InvalidArgumentException("The $filePath must be a file."); 40 | } 41 | 42 | parent::__construct( 43 | "Confirm to delete file.", 44 | "Are you sure to delete the file $filePath?", 45 | static function(Player $player, bool $choice) use ($plugin, $filePath) : void{ 46 | if($choice){ 47 | if(!unlink($filePath)){ 48 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not delete file $filePath.")); 49 | 50 | return; 51 | } 52 | $form = new FileExplorerForm($plugin, dirname($filePath), $player); 53 | }else{ 54 | $form = new FileEditorForm($plugin, $filePath, $player); 55 | } 56 | $player->sendForm($form); 57 | } 58 | ); 59 | } 60 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/DeleteFolderForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\ModalForm; 27 | use matcracker\ServerTools\Main; 28 | use pocketmine\player\Player; 29 | use pocketmine\plugin\PluginException; 30 | use pocketmine\utils\Filesystem; 31 | use function dirname; 32 | use function is_dir; 33 | 34 | final class DeleteFolderForm extends ModalForm{ 35 | 36 | public function __construct(Main $plugin, string $folderPath){ 37 | if(!is_dir($folderPath)){ 38 | throw new PluginException("The $folderPath must be a folder."); 39 | } 40 | 41 | parent::__construct( 42 | "Confirm to delete folder.", 43 | "Are you sure to delete the folder $folderPath and all its contents?", 44 | static function(Player $player, bool $choice) use ($plugin, $folderPath) : void{ 45 | if($choice){ 46 | Filesystem::recursiveUnlink($folderPath); 47 | $form = new FileExplorerForm($plugin, dirname($folderPath), $player); 48 | }else{ 49 | $form = new FileExplorerForm($plugin, $folderPath, $player); 50 | } 51 | $player->sendForm($form); 52 | } 53 | ); 54 | } 55 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/FileEditorForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\FormIcon; 27 | use dktapps\pmforms\MenuForm; 28 | use InvalidArgumentException; 29 | use matcracker\ServerTools\forms\elements\TaggedMenuOption; 30 | use matcracker\ServerTools\Main; 31 | use matcracker\ServerTools\utils\FormUtils; 32 | use matcracker\ServerTools\utils\Utils; 33 | use pocketmine\item\VanillaItems; 34 | use pocketmine\player\Player; 35 | use pocketmine\plugin\PluginException; 36 | use pocketmine\Server; 37 | use pocketmine\utils\TextFormat; 38 | use function basename; 39 | use function dirname; 40 | use function fclose; 41 | use function fgets; 42 | use function filesize; 43 | use function fopen; 44 | use function is_dir; 45 | use function is_readable; 46 | use function is_resource; 47 | use function is_writable; 48 | use function mb_convert_encoding; 49 | use function str_repeat; 50 | use function str_replace; 51 | use function strlen; 52 | 53 | final class FileEditorForm extends MenuForm{ 54 | /** 55 | * Max number of rows in a book. 56 | */ 57 | private const BOOK_ROW_MAX = 14; 58 | /** 59 | * Max number of characters allowed in a row 60 | * 61 | * NOTE: I decreased the max number because 62 | * the client aligns the text to left. 63 | * By doing so, it creates some empty whitespaces (~5) 64 | * and it uses more rows. 65 | */ 66 | private const BOOK_COL_MAX = 20 - 5; 67 | /** 68 | * Max number of allowed pages in a book. 69 | */ 70 | private const BOOK_PAGES_MAX = 50; 71 | /** 72 | * Max number characters allowed in a book 73 | */ 74 | private const BOOK_MAX_SIZE = self::BOOK_ROW_MAX * self::BOOK_COL_MAX * self::BOOK_PAGES_MAX; 75 | 76 | public const FILE_TAG = Main::PLUGIN_NAME . "_FilePath"; 77 | private const FORM_KEY_READ_FILE = "read_file"; 78 | private const FORM_KEY_EDIT_FILE = "edit_file"; 79 | private const FORM_KEY_RENAME_FILE = "rename_file"; 80 | private const FORM_KEY_DELETE_FILE = "delete_file"; 81 | 82 | private string $fileName; 83 | 84 | public function __construct(Main $plugin, private readonly string $filePath, private readonly Player $player){ 85 | if(is_dir($filePath)){ 86 | throw new InvalidArgumentException("The path \"$filePath\" must be a file."); 87 | } 88 | 89 | $this->fileName = basename($filePath); 90 | 91 | /** @var TaggedMenuOption[] $options */ 92 | $options = []; 93 | 94 | if(!is_readable($filePath)){ 95 | $message = TextFormat::RED . "The file \"$this->fileName\" does not exist or is not readable."; 96 | }else{ 97 | $message = "Name: $this->fileName" . TextFormat::EOL . 98 | "Size: " . Utils::bytesToHuman(filesize($filePath)); 99 | 100 | if($canBeOpen = (filesize($filePath) <= self::BOOK_MAX_SIZE)){ 101 | $options[] = new TaggedMenuOption(self::FORM_KEY_READ_FILE, "Read", new FormIcon("textures/items/book_normal.png", FormIcon::IMAGE_TYPE_PATH)); 102 | } 103 | 104 | if(is_writable($filePath) && ($player->hasPermission("st.ui.file-explorer.write") || $plugin->canBypassPermission($player))){ 105 | if($canBeOpen){ 106 | $options[] = new TaggedMenuOption(self::FORM_KEY_EDIT_FILE, "Edit", new FormIcon("textures/ui/text_color_paintbrush.png", FormIcon::IMAGE_TYPE_PATH)); 107 | } 108 | 109 | $options[] = new TaggedMenuOption(self::FORM_KEY_RENAME_FILE, "Rename", new FormIcon("textures/ui/pencil_edit_icon.png", FormIcon::IMAGE_TYPE_PATH)); 110 | $options[] = new TaggedMenuOption(self::FORM_KEY_DELETE_FILE, "Delete", new FormIcon("textures/ui/trash.png", FormIcon::IMAGE_TYPE_PATH)); 111 | } 112 | } 113 | 114 | parent::__construct( 115 | "File Editor", 116 | $message, 117 | $options, 118 | function(Player $player, int $selectedOption) use ($plugin, $options, $filePath) : void{ 119 | if(!is_readable($filePath)){ 120 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "The file \"$this->fileName\" does not exist or is not readable.")); 121 | 122 | return; 123 | } 124 | 125 | $tag = $options[$selectedOption]->getTag(); 126 | 127 | switch($tag){ 128 | case self::FORM_KEY_DELETE_FILE: 129 | $player->sendForm(new DeleteFileForm($plugin, $filePath)); 130 | break; 131 | case self::FORM_KEY_RENAME_FILE: 132 | $player->sendForm(new RenameFileForm($plugin, $filePath, $player)); 133 | break; 134 | case self::FORM_KEY_EDIT_FILE: 135 | $this->fileToBook(true); 136 | break; 137 | case self::FORM_KEY_READ_FILE: 138 | $this->fileToBook(false); 139 | break; 140 | default: 141 | throw new PluginException(); //TODO 142 | } 143 | }, 144 | FormUtils::onClose(new FileExplorerForm($plugin, dirname($filePath), $player)) 145 | ); 146 | } 147 | 148 | private function fileToBook(bool $writableBook) : void{ 149 | $stream = fopen($this->filePath, "r"); 150 | 151 | if(!is_resource($stream)){ 152 | $this->player->sendMessage(Main::formatMessage(TextFormat::RED . "Cannot open the file stream of \"$this->filePath\"")); 153 | 154 | return; 155 | } 156 | 157 | if($writableBook){ 158 | $book = VanillaItems::WRITABLE_BOOK(); 159 | }else{ 160 | $book = VanillaItems::WRITTEN_BOOK() 161 | ->setTitle($this->fileName) 162 | ->setAuthor(Server::getInstance()->getName()); 163 | } 164 | 165 | $tag = $book->getNamedTag()->setString(self::FILE_TAG, $this->filePath); 166 | 167 | $pageId = 0; 168 | $pageContent = ""; 169 | $book->setNamedTag($tag)->setCustomName($this->fileName)->addPage($pageId); 170 | 171 | $tab = str_repeat(" ", 4); 172 | 173 | while(($line = fgets($stream)) !== false){ 174 | $text = mb_convert_encoding(str_replace(["\r", "\t"], ["", $tab], $line), "UTF-8"); 175 | 176 | if(strlen($pageContent) > self::BOOK_ROW_MAX * self::BOOK_COL_MAX){ 177 | if($pageId + 1 >= 50){ 178 | break; 179 | } 180 | 181 | $pageContent = $text; 182 | $pageId++; 183 | }else{ 184 | $pageContent .= $text; 185 | } 186 | 187 | $book->setPageText($pageId, $pageContent); 188 | } 189 | 190 | if(!fclose($stream)){ 191 | $this->player->sendMessage(Main::formatMessage(TextFormat::RED . "Cannot close the file stream of \"$this->filePath\"")); 192 | 193 | return; 194 | } 195 | 196 | $this->player->getInventory()->setItemInHand($book); 197 | } 198 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/FileExplorerForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\FormIcon; 27 | use dktapps\pmforms\MenuForm; 28 | use matcracker\ServerTools\forms\elements\TaggedMenuOption; 29 | use matcracker\ServerTools\forms\MainMenuForm; 30 | use matcracker\ServerTools\Main; 31 | use matcracker\ServerTools\utils\FormUtils; 32 | use matcracker\ServerTools\utils\Utils; 33 | use pocketmine\player\Player; 34 | use pocketmine\plugin\PluginException; 35 | use pocketmine\utils\TextFormat; 36 | use Symfony\Component\Filesystem\Path; 37 | use function count; 38 | use function dirname; 39 | use function is_dir; 40 | 41 | final class FileExplorerForm extends MenuForm{ 42 | 43 | private const KEY_BACK = "back"; 44 | private const KEY_NEW_FILE = "new_file"; 45 | private const KEY_NEW_FOLDER = "new_folder"; 46 | private const KEY_RENAME_FOLDER = "rename_folder"; 47 | private const KEY_DELETE_FOLDER = "delete_folder"; 48 | 49 | public function __construct(Main $plugin, string $filePath, Player $player){ 50 | if(!is_dir($filePath)){ 51 | throw new PluginException("The $filePath must be a folder."); 52 | } 53 | 54 | static $BACK_OPTION = new TaggedMenuOption( 55 | self::KEY_BACK, 56 | "Back", 57 | new FormIcon("textures/ui/arrow_dark_left_stretch.png", FormIcon::IMAGE_TYPE_PATH) 58 | ); 59 | 60 | $fileList = Utils::getSortedFileList($filePath); 61 | 62 | /** @var TaggedMenuOption[] $options */ 63 | $options = []; 64 | 65 | $hasPermission = $player->hasPermission("st.ui.file-explorer.write") || $plugin->canBypassPermission($player); 66 | 67 | if($filePath !== $plugin->getServerDataPath()){ 68 | $options[] = $BACK_OPTION; 69 | 70 | if($hasPermission){ 71 | $options[] = new TaggedMenuOption( 72 | self::KEY_RENAME_FOLDER, 73 | "Rename current folder", 74 | new FormIcon("textures/ui/pencil_edit_icon.png", FormIcon::IMAGE_TYPE_PATH) 75 | ); 76 | $options[] = new TaggedMenuOption( 77 | self::KEY_DELETE_FOLDER, 78 | "Delete current folder", 79 | new FormIcon("textures/ui/trash.png", FormIcon::IMAGE_TYPE_PATH) 80 | ); 81 | } 82 | } 83 | 84 | if($hasPermission){ 85 | $options[] = new TaggedMenuOption( 86 | self::KEY_NEW_FOLDER, 87 | "New folder", 88 | new FormIcon("textures/ui/book_addpicture_default.png", FormIcon::IMAGE_TYPE_PATH) 89 | ); 90 | $options[] = new TaggedMenuOption( 91 | self::KEY_NEW_FILE, 92 | "New file", 93 | new FormIcon("textures/ui/book_addtextpage_default.png", FormIcon::IMAGE_TYPE_PATH) 94 | ); 95 | } 96 | 97 | if(count($fileList) === 0){ 98 | $message = $filePath . TextFormat::EOL . 99 | TextFormat::BOLD . TextFormat::GOLD . "[EMPTY FOLDER]"; 100 | 101 | }else{ 102 | $message = $filePath; 103 | 104 | static $dirIcon = new FormIcon("textures/ui/storageIconColor.png", FormIcon::IMAGE_TYPE_PATH); 105 | static $fileIcon = new FormIcon("textures/items/map_filled.png", FormIcon::IMAGE_TYPE_PATH); 106 | 107 | foreach($fileList as $fileInfo){ 108 | $name = $fileInfo->getFilename(); 109 | $options[] = new TaggedMenuOption( 110 | $name, 111 | $name, 112 | $fileInfo->isDir() ? $dirIcon : $fileIcon 113 | ); 114 | } 115 | } 116 | 117 | parent::__construct( 118 | "File Explorer", 119 | $message, 120 | $options, 121 | static function(Player $player, int $selectedOption) use ($plugin, $options, $filePath) : void{ 122 | $tag = $options[$selectedOption]->getTag(); 123 | 124 | $nextPath = Path::join($filePath, $tag); 125 | 126 | $form = match ($tag) { 127 | self::KEY_BACK => new self($plugin, dirname($filePath), $player), 128 | self::KEY_NEW_FOLDER => new NewFolderForm($plugin, $filePath, $player), 129 | self::KEY_NEW_FILE => new NewFileForm($plugin, $filePath, $player), 130 | self::KEY_DELETE_FOLDER => new DeleteFolderForm($plugin, $filePath), 131 | self::KEY_RENAME_FOLDER => new RenameFolderForm($plugin, $filePath, $player), 132 | default => is_dir($nextPath) ? new self($plugin, $nextPath, $player) : new FileEditorForm($plugin, $nextPath, $player) 133 | }; 134 | 135 | $player->sendForm($form); 136 | }, 137 | FormUtils::onClose(new MainMenuForm($plugin)) 138 | ); 139 | } 140 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/FileInputForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use Closure; 27 | use dktapps\pmforms\CustomForm; 28 | use dktapps\pmforms\element\Input; 29 | use dktapps\pmforms\element\Label; 30 | use pocketmine\utils\TextFormat; 31 | use function strlen; 32 | 33 | abstract class FileInputForm extends CustomForm{ 34 | 35 | protected const FORM_KEY_ERROR_MSG = "ERROR_MSG"; 36 | protected const FORM_KEY_FILE_NAME = "FILE_NAME"; 37 | 38 | public function __construct(string $title, string $text, string $hintText, string $defaultText, string $outputError, Closure $onSubmit, ?Closure $onClose = null){ 39 | $elements = []; 40 | 41 | if(strlen($outputError) > 0){ 42 | $elements[] = new Label(self::FORM_KEY_ERROR_MSG, TextFormat::RED . $outputError); 43 | } 44 | 45 | $elements[] = new Input( 46 | self::FORM_KEY_FILE_NAME, 47 | $text, 48 | $hintText, 49 | $defaultText 50 | ); 51 | 52 | parent::__construct($title, $elements, $onSubmit, $onClose); 53 | } 54 | 55 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/NewFileForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use InvalidArgumentException; 28 | use matcracker\ServerTools\Main; 29 | use matcracker\ServerTools\utils\FormUtils; 30 | use matcracker\ServerTools\utils\Utils; 31 | use pocketmine\player\Player; 32 | use pocketmine\utils\TextFormat; 33 | use Symfony\Component\Filesystem\Path; 34 | use function is_dir; 35 | use function strlen; 36 | use function touch; 37 | use function trim; 38 | 39 | final class NewFileForm extends FileInputForm{ 40 | 41 | public function __construct(Main $plugin, string $filePath, Player $player, string $error = ""){ 42 | if(!is_dir($filePath)){ 43 | throw new InvalidArgumentException("The $filePath must be a folder."); 44 | } 45 | 46 | parent::__construct( 47 | "New file", 48 | "Insert new file name:", 49 | "e.g. MyFile.txt", 50 | "", 51 | $error, 52 | function(Player $player, CustomFormResponse $response) use ($plugin, $filePath) : void{ 53 | $fileName = $response->getString(self::FORM_KEY_FILE_NAME); 54 | if(strlen(trim($fileName)) === 0 || !Utils::isValidFileName($fileName)){ 55 | $player->sendForm( 56 | new self( 57 | $plugin, 58 | $filePath, 59 | $player, 60 | "Invalid name \"$fileName\" for this folder. Try again" 61 | ) 62 | ); 63 | 64 | return; 65 | } 66 | 67 | $newFilePath = Path::join($filePath, $fileName); 68 | if(touch($newFilePath)){ 69 | $player->sendForm(new FileEditorForm($plugin, $newFilePath, $player)); 70 | }else{ 71 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not create " . $newFilePath)); 72 | } 73 | }, 74 | FormUtils::onClose(new FileExplorerForm($plugin, $filePath, $player)) 75 | ); 76 | } 77 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/NewFolderForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use Exception; 28 | use InvalidArgumentException; 29 | use matcracker\ServerTools\Main; 30 | use matcracker\ServerTools\utils\FormUtils; 31 | use pocketmine\player\Player; 32 | use pocketmine\utils\TextFormat; 33 | use Symfony\Component\Filesystem\Path; 34 | use function is_dir; 35 | use function mkdir; 36 | use function strlen; 37 | use function trim; 38 | 39 | final class NewFolderForm extends FileInputForm{ 40 | 41 | public function __construct(Main $plugin, string $filePath, Player $player, string $error = ""){ 42 | if(!is_dir($filePath)){ 43 | throw new InvalidArgumentException("The $filePath must be a folder."); 44 | } 45 | 46 | parent::__construct( 47 | "New folder", 48 | "Insert new folder name:", 49 | "e.g. MyFolder", 50 | "", 51 | $error, 52 | function(Player $player, CustomFormResponse $response) use ($plugin, $filePath) : void{ 53 | $folderName = $response->getString(self::FORM_KEY_FILE_NAME); 54 | if(strlen(trim($folderName)) === 0 || strpbrk($folderName, "\\/?%*:|\"<>") !== false){ 55 | $player->sendForm(new self($plugin, $filePath, $player, "Invalid name \"$folderName\" for this folder. Try again.")); 56 | 57 | return; 58 | } 59 | 60 | $newFilePath = Path::join($filePath, $folderName); 61 | try{ 62 | if(mkdir($newFilePath)){ 63 | $player->sendForm(new FileExplorerForm($plugin, $newFilePath, $player)); 64 | }else{ 65 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not create " . $newFilePath)); 66 | } 67 | }catch(Exception $e){ 68 | $player->sendForm(new self($plugin, $filePath, $player, "Error: " . $e->getMessage())); 69 | } 70 | }, 71 | FormUtils::onClose(new FileExplorerForm($plugin, $filePath, $player)) 72 | ); 73 | } 74 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/RenameFileForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use InvalidArgumentException; 28 | use matcracker\ServerTools\Main; 29 | use matcracker\ServerTools\utils\FormUtils; 30 | use matcracker\ServerTools\utils\Utils; 31 | use pocketmine\player\Player; 32 | use pocketmine\utils\TextFormat; 33 | use Symfony\Component\Filesystem\Path; 34 | use function basename; 35 | use function dirname; 36 | use function is_file; 37 | use function rename; 38 | use function strlen; 39 | use function trim; 40 | 41 | final class RenameFileForm extends FileInputForm{ 42 | 43 | public function __construct(Main $plugin, string $filePath, Player $player, string $error = ""){ 44 | if(!is_file($filePath)){ 45 | throw new InvalidArgumentException("The $filePath must be a file."); 46 | } 47 | 48 | parent::__construct( 49 | "Rename file", 50 | "Insert new file name:", 51 | basename($filePath), 52 | basename($filePath), 53 | $error, 54 | function(Player $player, CustomFormResponse $response) use ($plugin, $filePath) : void{ 55 | $fileName = $response->getString(self::FORM_KEY_FILE_NAME); 56 | if(strlen(trim($fileName)) === 0 || !Utils::isValidFileName($fileName)){ 57 | $player->sendForm(new self($plugin, $filePath, $player, "Invalid name \"$fileName\" for this file. Try again")); 58 | 59 | return; 60 | } 61 | 62 | $newPath = Path::join(dirname($filePath), $fileName); 63 | if(rename($filePath, $newPath)){ 64 | $player->sendForm(new FileEditorForm($plugin, $newPath, $player)); 65 | }else{ 66 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not rename the file $filePath")); 67 | } 68 | }, 69 | FormUtils::onClose(new FileExplorerForm($plugin, dirname($filePath), $player)) 70 | ); 71 | } 72 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/files/RenameFolderForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\files; 25 | 26 | use dktapps\pmforms\CustomFormResponse; 27 | use matcracker\ServerTools\Main; 28 | use matcracker\ServerTools\utils\FormUtils; 29 | use pocketmine\player\Player; 30 | use pocketmine\plugin\PluginException; 31 | use pocketmine\utils\TextFormat; 32 | use function basename; 33 | use function dirname; 34 | use function is_dir; 35 | use function rename; 36 | use function strlen; 37 | use function strpbrk; 38 | use function trim; 39 | use const DIRECTORY_SEPARATOR; 40 | 41 | final class RenameFolderForm extends FileInputForm{ 42 | 43 | public function __construct(Main $plugin, string $filePath, Player $player, string $error = ""){ 44 | if(!is_dir($filePath)){ 45 | throw new PluginException("The $filePath must be a folder."); 46 | } 47 | 48 | parent::__construct( 49 | "Rename folder", 50 | "Insert new folder name:", 51 | basename($filePath), 52 | basename($filePath), 53 | $error, 54 | function(Player $player, CustomFormResponse $response) use ($plugin, $filePath) : void{ 55 | $folderName = $response->getString(self::FORM_KEY_FILE_NAME); 56 | if(strlen(trim($folderName)) === 0 || strpbrk($folderName, "\\/?%*:|\"<>") !== false){ 57 | $player->sendForm(new self($plugin, $filePath, $player, "Invalid name \"$folderName\" for this folder. Try again.")); 58 | 59 | return; 60 | } 61 | $newPath = dirname($filePath) . DIRECTORY_SEPARATOR . $folderName; 62 | if(rename($filePath, $newPath)){ 63 | $player->sendForm(new FileExplorerForm($plugin, $newPath, $player)); 64 | }else{ 65 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "Could not rename the folder $filePath")); 66 | } 67 | }, 68 | FormUtils::onClose(new FileExplorerForm($plugin, $filePath, $player)) 69 | ); 70 | } 71 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/plugins/downloader/DownloadPluginForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\plugins\downloader; 25 | 26 | use dktapps\pmforms\CustomForm; 27 | use dktapps\pmforms\CustomFormResponse; 28 | use dktapps\pmforms\element\Dropdown; 29 | use dktapps\pmforms\element\Label; 30 | use matcracker\ServerTools\Main; 31 | use matcracker\ServerTools\task\async\DownloadPluginTask; 32 | use matcracker\ServerTools\utils\FormUtils; 33 | use pocketmine\player\Player; 34 | use pocketmine\plugin\PluginException; 35 | use pocketmine\utils\TextFormat; 36 | use function array_values; 37 | use function count; 38 | 39 | final class DownloadPluginForm extends CustomForm{ 40 | 41 | private const KEY_DESCRIPTION = "description"; 42 | private const KEY_AUTHOR = "author"; 43 | private const KEY_LICENSE = "license"; 44 | private const KEY_VERSION = "version"; 45 | private const KEY_API = "api"; 46 | private const KEY_SUBMIT = "submit"; 47 | 48 | /** 49 | * DownloadPluginForm constructor. 50 | * 51 | * @param Main $plugin 52 | * @param array $poggitData 53 | * @param string $playerName 54 | */ 55 | public function __construct(Main $plugin, array $poggitData, string $playerName){ 56 | if(count($poggitData) === 0){ 57 | throw new PluginException(); 58 | } 59 | 60 | $versions = []; 61 | /** 62 | * @var string $version 63 | * @var string[] $apiData 64 | */ 65 | foreach($poggitData["versions"] as $version => $apiData){ 66 | $versions[] = "v$version (API: {$apiData["api-from"]} - {$apiData["api-to"]})"; 67 | } 68 | 69 | $serverApi = $plugin->getServer()->getApiVersion(); 70 | 71 | parent::__construct( 72 | "{$poggitData["name"]} Information", 73 | [ 74 | new Label(self::KEY_DESCRIPTION, TextFormat::BOLD . $poggitData["short_description"]), 75 | new Label(self::KEY_AUTHOR, "Author(s): {$poggitData["authors"]}"), 76 | new Label(self::KEY_LICENSE, "License: {$poggitData["license"]}"), 77 | new Dropdown(self::KEY_VERSION, "Select the version", $versions), 78 | new Label(self::KEY_API, TextFormat::BOLD . TextFormat::GOLD . "Server API version: $serverApi"), 79 | new Label(self::KEY_SUBMIT, "Press \"Submit\" to start the download.") 80 | ], 81 | static function(Player $player, CustomFormResponse $response) use ($plugin, $poggitData) : void{ 82 | $versionData = array_values($poggitData["versions"])[$response->getInt(self::KEY_VERSION)]; 83 | 84 | $server = $player->getServer(); 85 | $server->getAsyncPool()->submitTask(new DownloadPluginTask( 86 | $plugin, 87 | $poggitData["name"], 88 | $versionData["artifact_url"], 89 | $player->getName(), 90 | $server->getPluginPath() 91 | )); 92 | }, 93 | FormUtils::onClose(new SearchResultsForm($plugin, SearchResultsForm::getResultsCache($playerName))) 94 | ); 95 | } 96 | 97 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/plugins/downloader/SearchPluginForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\plugins\downloader; 25 | 26 | use dktapps\pmforms\CustomForm; 27 | use dktapps\pmforms\CustomFormResponse; 28 | use dktapps\pmforms\element\Input; 29 | use dktapps\pmforms\element\Label; 30 | use matcracker\ServerTools\forms\MainMenuForm; 31 | use matcracker\ServerTools\Main; 32 | use matcracker\ServerTools\task\async\SearchPluginTask; 33 | use matcracker\ServerTools\utils\FormUtils; 34 | use pocketmine\player\Player; 35 | use pocketmine\utils\TextFormat; 36 | use function array_rand; 37 | 38 | final class SearchPluginForm extends CustomForm{ 39 | 40 | private const SPONSOR_PLUGINS = [ 41 | "BedcoreProtect", "ServerTools", "BlocksConverter", "Elevator" 42 | ]; 43 | private const FORM_KEY_HINT = "hint"; 44 | private const FORM_KEY_SEARCH = "search"; 45 | private const FORM_KEY_PL_NOT_FOUND = "plugin_not_found"; 46 | 47 | public function __construct(Main $plugin, ?string $pluginNotFound = null){ 48 | $elements = [ 49 | new Label( 50 | self::FORM_KEY_HINT, 51 | "Hint:" . TextFormat::EOL . 52 | "- Use \"@\" to search by author (e.g. @matcracker)" 53 | ), 54 | new Input( 55 | self::FORM_KEY_SEARCH, 56 | "Insert the plugin name to search:", 57 | "e.g. " . self::SPONSOR_PLUGINS[array_rand(self::SPONSOR_PLUGINS)] 58 | ) 59 | ]; 60 | 61 | if($pluginNotFound !== null){ 62 | $elements[] = new Label( 63 | self::FORM_KEY_PL_NOT_FOUND, 64 | TextFormat::RED . $pluginNotFound . " does not exist on Poggit." 65 | ); 66 | } 67 | 68 | parent::__construct( 69 | "Search Poggit Plugin", 70 | $elements, 71 | static function(Player $player, CustomFormResponse $response) use ($plugin) : void{ 72 | $player->getServer()->getAsyncPool()->submitTask( 73 | new SearchPluginTask($plugin, $response->getString(self::FORM_KEY_SEARCH), $player->getName()) 74 | ); 75 | }, 76 | FormUtils::onClose(new MainMenuForm($plugin)) 77 | ); 78 | } 79 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/plugins/downloader/SearchResultsForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\plugins\downloader; 25 | 26 | use dktapps\pmforms\FormIcon; 27 | use dktapps\pmforms\MenuForm; 28 | use matcracker\ServerTools\forms\elements\TaggedMenuOption; 29 | use matcracker\ServerTools\Main; 30 | use matcracker\ServerTools\utils\FormUtils; 31 | use pocketmine\player\Player; 32 | use function count; 33 | 34 | final class SearchResultsForm extends MenuForm{ 35 | 36 | /** @var string[][] */ 37 | private static array $resultsCache = []; 38 | 39 | public function __construct(Main $plugin, array $results){ 40 | /** @var TaggedMenuOption[] $options */ 41 | $options = []; 42 | 43 | foreach($results as $pluginName => $data){ 44 | $options[] = new TaggedMenuOption($pluginName, $pluginName, new FormIcon($data["icon_url"])); 45 | } 46 | 47 | parent::__construct( 48 | count($results) . " Poggit Result(s)", 49 | "Select a plugin:", 50 | $options, 51 | static function(Player $player, int $selectedOption) use ($plugin, $results, $options) : void{ 52 | $tag = $options[$selectedOption]->getTag(); 53 | 54 | self::$resultsCache[$player->getName()] = $results; 55 | 56 | $player->sendForm(new DownloadPluginForm($plugin, $results[$tag], $player->getName())); 57 | }, 58 | FormUtils::onClose(new SearchPluginForm($plugin)) 59 | ); 60 | } 61 | 62 | /** 63 | * @param string $playerName 64 | * 65 | * @return string[][] 66 | */ 67 | public static function getResultsCache(string $playerName) : array{ 68 | return self::$resultsCache[$playerName] ?? []; 69 | } 70 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/plugins/manager/PluginEnablerForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\plugins\manager; 25 | 26 | use dktapps\pmforms\MenuForm; 27 | use dktapps\pmforms\MenuOption; 28 | use matcracker\ServerTools\Main; 29 | use matcracker\ServerTools\utils\FormUtils; 30 | use pocketmine\player\Player; 31 | use pocketmine\utils\TextFormat; 32 | use function array_values; 33 | 34 | final class PluginEnablerForm extends MenuForm{ 35 | 36 | public function __construct(Main $plugin){ 37 | $pluginManager = $plugin->getServer()->getPluginManager(); 38 | $plugins = array_values($pluginManager->getPlugins()); 39 | 40 | $options = []; 41 | foreach($plugins as $pl){ 42 | $version = $pl->getDescription()->getVersion(); 43 | $options[] = new MenuOption(($pl->isEnabled() ? TextFormat::DARK_GREEN : TextFormat::RED) . "{$pl->getName()} v$version"); 44 | } 45 | 46 | parent::__construct( 47 | "Enable/Disable Plugins", 48 | TextFormat::BOLD . TextFormat::GOLD . "WARNING! USE THIS FUNCTION CAREFULLY:" . TextFormat::EOL . 49 | TextFormat::RESET . TextFormat::GOLD . "- The plugin commands will still remain usable (they could cause a crash if used)." . TextFormat::EOL . 50 | "- Disabling and re-enabling a plugin could cause your server to crash.", 51 | $options, 52 | static function(Player $player, int $selectedOption) use ($pluginManager, $plugins) : void{ 53 | $plugin = $plugins[$selectedOption]; 54 | if($plugin->isEnabled()){ 55 | $pluginManager->disablePlugin($plugin); 56 | $player->sendMessage(Main::formatMessage(TextFormat::RED . "The plugin {$plugin->getName()} has been disabled.")); 57 | }else{ 58 | $pluginManager->enablePlugin($plugin); 59 | $player->sendMessage(Main::formatMessage(TextFormat::GREEN . "The plugin {$plugin->getName()} has been enabled.")); 60 | } 61 | }, 62 | FormUtils::onClose(new PluginManagerForm($plugin)) 63 | ); 64 | } 65 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/forms/plugins/manager/PluginManagerForm.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\forms\plugins\manager; 25 | 26 | use dktapps\pmforms\MenuForm; 27 | use dktapps\pmforms\MenuOption; 28 | use matcracker\ServerTools\forms\MainMenuForm; 29 | use matcracker\ServerTools\Main; 30 | use matcracker\ServerTools\utils\FormUtils; 31 | use pocketmine\player\Player; 32 | use UnexpectedValueException; 33 | 34 | final class PluginManagerForm extends MenuForm{ 35 | 36 | public function __construct(Main $plugin){ 37 | parent::__construct( 38 | "Plugin Manager", 39 | "", 40 | [new MenuOption("Enable/Disable plugin")], 41 | static function(Player $player, int $selectedOption) use ($plugin) : void{ 42 | $form = match ($selectedOption) { 43 | 0 => new PluginEnablerForm($plugin), 44 | default => throw new UnexpectedValueException("Unexpected option $selectedOption") 45 | }; 46 | 47 | $player->sendForm($form); 48 | }, 49 | FormUtils::onClose(new MainMenuForm($plugin)) 50 | ); 51 | } 52 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/ftp/BaseFTPHandler.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\ftp; 25 | 26 | abstract class BaseFTPHandler{ 27 | public const NO_ERROR = 0; 28 | public const ERR_CONNECT = -1; 29 | public const ERR_DISCONNECT = -2; 30 | public const ERR_LOGIN = -3; 31 | 32 | protected mixed $session = null; 33 | 34 | public function __construct( 35 | private readonly string $host, 36 | private readonly int $port, 37 | private readonly string $username, 38 | private readonly string $password, 39 | private readonly string $remoteHomePath 40 | ){ 41 | } 42 | 43 | public abstract static function hasExtension() : bool; 44 | 45 | public abstract function getProtocolName() : string; 46 | 47 | public abstract function connect() : int; 48 | 49 | public abstract function disconnect() : bool; 50 | 51 | public abstract function putFile(string $localFile, string $remoteFile) : bool; 52 | 53 | public abstract function putDirectory(string $remoteDirPath, int $mode = 0644) : bool; 54 | 55 | public final function getHost() : string{ 56 | return $this->host; 57 | } 58 | 59 | public final function getPort() : int{ 60 | return $this->port; 61 | } 62 | 63 | final public function getUsername() : string{ 64 | return $this->username; 65 | } 66 | 67 | final public function getPassword() : string{ 68 | return $this->password; 69 | } 70 | 71 | public final function getHomePath() : string{ 72 | return $this->remoteHomePath; 73 | } 74 | 75 | /** 76 | * Produces a human-readable output without leaking password 77 | */ 78 | public final function __toString() : string{ 79 | return "$this->username@$this->host:$this->port"; 80 | } 81 | 82 | /** 83 | * Prepares value to be var_dump()'ed without leaking password 84 | */ 85 | public final function __debugInfo() : array{ 86 | return [ 87 | "host" => $this->host, 88 | "port" => $this->port, 89 | "username" => $this->username 90 | ]; 91 | } 92 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/ftp/FTPHandler.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\ftp; 25 | 26 | use UnexpectedValueException; 27 | use function extension_loaded; 28 | use function ftp_chdir; 29 | use function ftp_close; 30 | use function ftp_connect; 31 | use function ftp_login; 32 | use function ftp_mkdir; 33 | use function ftp_pasv; 34 | use function ftp_ssl_connect; 35 | 36 | class FTPHandler extends BaseFTPHandler{ 37 | private bool $ssl; 38 | 39 | public function __construct(string $host, int $port, string $username, string $password, string $remoteHomePath, bool $ssl){ 40 | parent::__construct($host, $port, $username, $password, $remoteHomePath); 41 | $this->ssl = $ssl; 42 | } 43 | 44 | public static function hasExtension() : bool{ 45 | return extension_loaded("ftp"); 46 | } 47 | 48 | public function getProtocolName() : string{ 49 | return "FTP"; 50 | } 51 | 52 | public function connect() : int{ 53 | $ftpConn = $this->ssl ? @ftp_ssl_connect($this->getHost(), $this->getPort()) : @ftp_connect($this->getHost(), $this->getPort()); 54 | 55 | if($ftpConn === false){ 56 | return self::ERR_CONNECT; 57 | } 58 | 59 | if(!@ftp_login($ftpConn, $this->getUsername(), $this->getPassword())){ 60 | if(!@ftp_close($ftpConn)){ 61 | return self::ERR_DISCONNECT; 62 | } 63 | 64 | return self::ERR_LOGIN; 65 | } 66 | 67 | @ftp_pasv($ftpConn, true); 68 | 69 | $this->session = $ftpConn; 70 | 71 | return self::NO_ERROR; 72 | } 73 | 74 | public function putDirectory(string $remoteDirPath, int $mode = 0644) : bool{ 75 | if($this->session === null){ 76 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 77 | } 78 | 79 | if(!@ftp_chdir($this->session, $remoteDirPath)){ 80 | return @ftp_mkdir($this->session, $remoteDirPath) !== false; 81 | } 82 | 83 | return true; 84 | } 85 | 86 | public function putFile(string $localFile, string $remoteFile) : bool{ 87 | if($this->session === null){ 88 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 89 | } 90 | 91 | return @ftp_put($this->session, $remoteFile, $localFile); 92 | } 93 | 94 | public function disconnect() : bool{ 95 | if($this->session === null){ 96 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 97 | } 98 | 99 | $result = @ftp_close($this->session); 100 | $this->session = null; 101 | 102 | return $result; 103 | } 104 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/ftp/SFTPHandler.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\ftp; 25 | 26 | use UnexpectedValueException; 27 | use function extension_loaded; 28 | use function fclose; 29 | use function fopen; 30 | use function ssh2_auth_password; 31 | use function ssh2_connect; 32 | use function ssh2_disconnect; 33 | use function ssh2_sftp; 34 | use function ssh2_sftp_mkdir; 35 | use function stream_copy_to_stream; 36 | 37 | final class SFTPHandler extends BaseFTPHandler{ 38 | 39 | public static function hasExtension() : bool{ 40 | return extension_loaded("openssl") && extension_loaded("ssh2"); 41 | } 42 | 43 | public function getProtocolName() : string{ 44 | return "SFTP"; 45 | } 46 | 47 | public function connect() : int{ 48 | $session = @ssh2_connect($this->getHost(), $this->getPort()); 49 | 50 | if($session === false){ 51 | return self::ERR_CONNECT; 52 | } 53 | 54 | if(!@ssh2_auth_password($session, $this->getUsername(), $this->getPassword())){ 55 | if(!@ssh2_disconnect($session)){ 56 | return self::ERR_DISCONNECT; 57 | } 58 | 59 | return self::ERR_LOGIN; 60 | } 61 | 62 | $stream = @ssh2_sftp($session); 63 | 64 | if($stream === false){ 65 | return self::ERR_CONNECT; 66 | } 67 | 68 | $this->session = $stream; 69 | 70 | return self::NO_ERROR; 71 | } 72 | 73 | public function putDirectory(string $remoteDirPath, int $mode = 0644) : bool{ 74 | if($this->session === null){ 75 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 76 | } 77 | 78 | return @ssh2_sftp_mkdir($this->session, $remoteDirPath, $mode); 79 | } 80 | 81 | public function putFile(string $localFile, string $remoteFile) : bool{ 82 | if($this->session === null){ 83 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 84 | } 85 | 86 | $localRes = @fopen($localFile, "rb"); 87 | if($localRes === false){ 88 | return false; 89 | } 90 | 91 | $remoteRes = @fopen("ssh2.sftp://$this->session$remoteFile", "wb"); 92 | if($remoteRes === false){ 93 | return false; 94 | } 95 | 96 | if(@stream_copy_to_stream($localRes, $remoteRes) === false){ 97 | return false; 98 | } 99 | 100 | return @fclose($remoteRes) && @fclose($localRes); 101 | } 102 | 103 | public function disconnect() : bool{ 104 | if($this->session === null){ 105 | throw new UnexpectedValueException("The session has not been initialized, call connect method before."); 106 | } 107 | 108 | $result = @ssh2_disconnect($this->session); 109 | 110 | $this->session = null; 111 | 112 | return $result; 113 | } 114 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/task/async/DownloadPluginTask.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\task\async; 25 | 26 | use matcracker\ServerTools\Main; 27 | use pocketmine\scheduler\AsyncTask; 28 | use pocketmine\Server; 29 | use pocketmine\utils\Internet; 30 | use pocketmine\utils\TextFormat; 31 | use Symfony\Component\Filesystem\Path; 32 | use function file_put_contents; 33 | 34 | final class DownloadPluginTask extends AsyncTask{ 35 | private int $timeout; 36 | 37 | public function __construct( 38 | Main $plugin, 39 | private readonly string $pluginName, 40 | private readonly string $artifactUrl, 41 | private readonly string $playerName, 42 | private readonly string $pluginPath 43 | ){ 44 | $this->timeout = (int) $plugin->getConfig()->getNested("poggit.timeout", 30); 45 | } 46 | 47 | public function onRun() : void{ 48 | $request = Internet::getURL("$this->artifactUrl/$this->pluginName.phar", $this->timeout); 49 | 50 | if($request !== null){ 51 | $this->setResult(file_put_contents(Path::join($this->pluginPath, "$this->pluginName.phar"), $request->getBody()) !== false); 52 | }else{ 53 | $this->setResult(false); 54 | } 55 | } 56 | 57 | public function onCompletion() : void{ 58 | $player = Server::getInstance()->getPlayerExact($this->playerName); 59 | if($player === null){ 60 | return; 61 | } 62 | 63 | /** @var bool $success */ 64 | $success = $this->getResult(); 65 | if($success){ 66 | $message = TextFormat::GREEN . "$this->pluginName successfully downloaded."; 67 | }else{ 68 | $message = TextFormat::RED . "Could not download $this->pluginName plugin."; 69 | } 70 | 71 | $player->sendMessage(Main::formatMessage($message)); 72 | } 73 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/task/async/FTPThread.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\task\async; 25 | 26 | use FilesystemIterator; 27 | use matcracker\ServerTools\ftp\BaseFTPHandler; 28 | use matcracker\ServerTools\ftp\FTPHandler; 29 | use matcracker\ServerTools\Main; 30 | use matcracker\ServerTools\utils\Utils; 31 | use pmmp\thread\ThreadSafeArray; 32 | use pocketmine\snooze\SleeperHandlerEntry; 33 | use pocketmine\thread\log\AttachableThreadSafeLogger; 34 | use pocketmine\thread\Thread; 35 | use pocketmine\utils\Terminal; 36 | use pocketmine\utils\TextFormat; 37 | use RecursiveDirectoryIterator; 38 | use RecursiveIteratorIterator; 39 | use RuntimeException; 40 | use Symfony\Component\Filesystem\Path; 41 | use UnexpectedValueException; 42 | use function count; 43 | use function fileperms; 44 | use function filesize; 45 | use function igbinary_serialize; 46 | use function igbinary_unserialize; 47 | use function implode; 48 | use function is_dir; 49 | use function microtime; 50 | use function round; 51 | use function str_repeat; 52 | 53 | final class FTPThread extends Thread{ 54 | private const PROGRESS_BAR_SYMBOL_COMPLETE = "■"; 55 | private const PROGRESS_BAR_SYMBOL_NO_COMPLETE = " "; 56 | private const NOT_CONNECTED = 127; 57 | private const PROGRESSBAR_SIZE = 25; 58 | private SleeperHandlerEntry $sleeperHandlerEntry; 59 | private AttachableThreadSafeLogger $logger; 60 | private string $serverPath; 61 | private string $ftpHandler; 62 | private ThreadSafeArray $filePaths; 63 | private int $error = self::NOT_CONNECTED; 64 | 65 | /** 66 | * FTPThread constructor. 67 | * 68 | * @param Main $plugin 69 | * @param BaseFTPHandler $ftpHandler 70 | * @param string[] $filePaths 71 | */ 72 | public function __construct( 73 | Main $plugin, 74 | BaseFTPHandler $ftpHandler, 75 | array $filePaths 76 | ){ 77 | if(!$ftpHandler::hasExtension()){ 78 | throw new RuntimeException("Missing extension"); 79 | } 80 | 81 | $server = $plugin->getServer(); 82 | $plugin->isCloning = true; 83 | $worldManager = $server->getWorldManager(); 84 | $loadedWorlds = []; 85 | 86 | foreach($worldManager->getWorlds() as $world){ 87 | $loadedWorlds[] = $world->getFolderName(); 88 | $worldManager->unloadWorld($world, true); 89 | } 90 | 91 | $this->sleeperHandlerEntry = $server->getTickSleeper()->addNotifier( 92 | function() use ($plugin, $ftpHandler, $worldManager, $loadedWorlds) : void{ 93 | $protocolName = $ftpHandler->getProtocolName(); 94 | 95 | $message = match ($this->error) { 96 | BaseFTPHandler::NO_ERROR => "Cloning process has been completed.", 97 | BaseFTPHandler::ERR_CONNECT => TextFormat::RED . "Could not connect to the $protocolName server.", 98 | BaseFTPHandler::ERR_DISCONNECT => TextFormat::RED . "Could not disconnect from the $protocolName server.", 99 | BaseFTPHandler::ERR_LOGIN => TextFormat::RED . "Wrong username or password for the $protocolName server.", 100 | default => throw new UnexpectedValueException("Unhandled error code: $this->error") 101 | }; 102 | 103 | $plugin->getLogger()->info($message); 104 | 105 | foreach($loadedWorlds as $world){ 106 | $worldManager->loadWorld($world); 107 | } 108 | $plugin->isCloning = false; 109 | } 110 | ); 111 | 112 | $this->logger = $server->getLogger(); 113 | $this->serverPath = $server->getDataPath(); 114 | $this->ftpHandler = igbinary_serialize($ftpHandler); 115 | $this->filePaths = ThreadSafeArray::fromArray($filePaths); 116 | 117 | $this->start(); 118 | } 119 | 120 | public function onRun() : void{ 121 | $notifier = $this->sleeperHandlerEntry->createNotifier(); 122 | /** @var FTPHandler $ftpHandler */ 123 | $ftpHandler = igbinary_unserialize($this->ftpHandler); 124 | $this->error = $ftpHandler->connect(); 125 | 126 | if($this->error !== BaseFTPHandler::NO_ERROR){ 127 | $notifier->wakeupSleeper(); 128 | 129 | return; 130 | } 131 | 132 | $totalBytes = $sentBytes = 0; 133 | 134 | /** @var string[] $files */ 135 | $files = []; 136 | foreach($this->filePaths as $filePath){ 137 | $files[] = $filePath; 138 | 139 | if(is_dir($filePath)){ 140 | $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($filePath, FilesystemIterator::SKIP_DOTS), RecursiveIteratorIterator::SELF_FIRST); 141 | 142 | /** @var RecursiveDirectoryIterator $file */ 143 | foreach($iterator as $file){ 144 | $files[] = $file->getRealPath(); 145 | if($file->isFile()){ 146 | $totalBytes += $file->getSize() ?: 0; 147 | } 148 | } 149 | }else{ 150 | $totalBytes += filesize($filePath); 151 | } 152 | } 153 | 154 | $memTime = microtime(true); 155 | $oldBytes = $bytesSpeed = 0; 156 | 157 | /** @var string[] $failedFiles */ 158 | $failedFiles = []; 159 | 160 | foreach($files as $filePath){ 161 | $remotePath = Path::join($ftpHandler->getHomePath(), Path::makeRelative($filePath, $this->serverPath)); 162 | 163 | if(is_dir($filePath)){ 164 | $perms = fileperms($filePath); 165 | 166 | if(!$ftpHandler->putDirectory($remotePath, $perms !== false ? $perms : 0644)){ 167 | $failedFiles[] = $remotePath; 168 | } 169 | }else{ 170 | if(!$ftpHandler->putFile($filePath, $remotePath)){ 171 | $failedFiles[] = $remotePath; 172 | }else{ 173 | $sentBytes += filesize($filePath); 174 | } 175 | } 176 | 177 | $currTime = microtime(true); 178 | 179 | if($currTime - $memTime >= 1){ 180 | $memTime = $currTime; 181 | $bytesSpeed = $sentBytes - $oldBytes; 182 | $oldBytes = $sentBytes; 183 | } 184 | 185 | $bytesRatio = $sentBytes / $totalBytes; 186 | 187 | $percentage = round($bytesRatio * 100.0, 1); 188 | $steps = (int) ($bytesRatio * self::PROGRESSBAR_SIZE); 189 | 190 | $bar = TextFormat::YELLOW . Main::PLUGIN_NAME . " cloning: " . 191 | TextFormat::WHITE . "[" . TextFormat::GREEN . str_repeat(self::PROGRESS_BAR_SYMBOL_COMPLETE, $steps) . //Current progress 192 | TextFormat::RED . str_repeat(self::PROGRESS_BAR_SYMBOL_NO_COMPLETE, self::PROGRESSBAR_SIZE - $steps) . TextFormat::WHITE . "] " .//Remaining progress 193 | TextFormat::AQUA . Utils::bytesToHuman($sentBytes) . "/" . Utils::bytesToHuman($totalBytes) . " - $percentage% " . //Percentage 194 | "(Speed: " . Utils::bytesToHuman($bytesSpeed) . "/s)"; 195 | 196 | Terminal::write("\r$bar"); 197 | } 198 | 199 | Terminal::write(TextFormat::EOL); 200 | 201 | $ftpHandler->disconnect(); 202 | 203 | $notifier->wakeupSleeper(); 204 | 205 | if(count($failedFiles) > 0){ 206 | $this->logger->warning("The following files has not been cloned due to error:" . implode(TextFormat::EOL . "- ", $failedFiles)); 207 | } 208 | } 209 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/task/async/GetPoggitReleases.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\task\async; 25 | 26 | use matcracker\ServerTools\Main; 27 | use pocketmine\scheduler\AsyncTask; 28 | use pocketmine\utils\Internet; 29 | use Symfony\Component\Filesystem\Path; 30 | use function explode; 31 | use function file_exists; 32 | use function file_get_contents; 33 | use function file_put_contents; 34 | use function filemtime; 35 | use function is_array; 36 | use function json_decode; 37 | use function json_encode; 38 | use function max; 39 | use function time; 40 | 41 | abstract class GetPoggitReleases extends AsyncTask{ 42 | protected const POGGIT_JSON_ID = "PoggitJSON"; 43 | protected const POGGIT_RELEASES_URL = "https://poggit.pmmp.io/releases.min.json"; 44 | private int $timeout; 45 | private int $invalidateCacheTime; 46 | private string $poggitCachePath; 47 | 48 | public function __construct(Main $plugin){ 49 | $config = $plugin->getConfig(); 50 | $this->poggitCachePath = Path::join($plugin->getDataFolder(), "poggit-api.json"); 51 | $this->timeout = (int) $config->getNested("poggit.timeout", 30); 52 | $this->invalidateCacheTime = (int) max(1, $config->getNested("poggit.invalidate-cache", 24)); 53 | } 54 | 55 | public function onRun() : void{ 56 | if(file_exists($this->poggitCachePath)){ 57 | $lastModified = filemtime($this->poggitCachePath); 58 | if($lastModified !== false){ 59 | $downloadApi = time() - $lastModified > $this->invalidateCacheTime * 3600; //Hours -> Seconds 60 | }else{ 61 | $downloadApi = true; 62 | } 63 | }else{ 64 | $downloadApi = true; 65 | } 66 | 67 | if($downloadApi){ 68 | $request = Internet::getUrl(self::POGGIT_RELEASES_URL, $this->timeout); 69 | if($request !== null){ 70 | $jsonAssoc = json_decode($request->getBody(), true); 71 | if(is_array($jsonAssoc)){ 72 | $poggitJson = []; 73 | foreach($jsonAssoc as $data){ 74 | $pluginName = $data["name"]; 75 | 76 | if(!isset($poggitJson[$pluginName])){ 77 | $poggitJson[$pluginName] = [ 78 | "name" => $pluginName, 79 | "authors" => explode("/", $data["repo_name"])[0], 80 | "icon_url" => $data["icon_url"] ?? "", 81 | "short_description" => $data["tagline"], 82 | "license" => $data["license"] ?? "Unknown" 83 | ]; 84 | } 85 | 86 | $poggitJson[$pluginName]["versions"][$data["version"]] = [ 87 | "artifact_url" => $data["artifact_url"], 88 | "api-from" => $data["api"][0]["from"] ?? "Unknown", 89 | "api-to" => $data["api"][0]["to"] ?? "Unknown" 90 | ]; 91 | } 92 | file_put_contents($this->poggitCachePath, json_encode($poggitJson)); 93 | $this->storeLocal(self::POGGIT_JSON_ID, $poggitJson); 94 | } 95 | } 96 | }else{ 97 | $request = file_get_contents($this->poggitCachePath); 98 | if($request !== false){ 99 | $poggitJson = json_decode($request, true); 100 | if(is_array($poggitJson)){ 101 | $this->storeLocal(self::POGGIT_JSON_ID, $poggitJson); 102 | } 103 | } 104 | } 105 | } 106 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/task/async/SearchPluginTask.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\task\async; 25 | 26 | use matcracker\ServerTools\forms\plugins\downloader\SearchPluginForm; 27 | use matcracker\ServerTools\forms\plugins\downloader\SearchResultsForm; 28 | use matcracker\ServerTools\Main; 29 | use pocketmine\Server; 30 | use function array_filter; 31 | use function count; 32 | use function mb_strtolower; 33 | use function mb_substr; 34 | use function strlen; 35 | use const ARRAY_FILTER_USE_BOTH; 36 | 37 | final class SearchPluginTask extends GetPoggitReleases{ 38 | 39 | private const TLS_KEY_PLUGIN = "PluginInstance"; 40 | 41 | public function __construct( 42 | Main $plugin, 43 | private readonly string $nameToSearch, 44 | private readonly string $playerName 45 | ){ 46 | parent::__construct($plugin); 47 | $this->storeLocal(self::TLS_KEY_PLUGIN, $plugin); 48 | } 49 | 50 | public function onRun() : void{ 51 | parent::onRun(); 52 | /** @var array $poggitJson */ 53 | $poggitJson = $this->fetchLocal(self::POGGIT_JSON_ID); 54 | 55 | if(strlen($this->nameToSearch) > 0){ 56 | $result = array_filter( 57 | $poggitJson, 58 | function(array $data, string $pluginName) : bool{ 59 | //Search by author 60 | if(mb_substr($this->nameToSearch, 0, 1) === "@"){ 61 | return mb_strtolower($data["authors"]) === mb_strtolower(mb_substr($this->nameToSearch, 1)); 62 | }else{ 63 | return str_contains(mb_strtolower($pluginName), mb_strtolower($this->nameToSearch)); 64 | } 65 | }, 66 | ARRAY_FILTER_USE_BOTH); 67 | }else{ 68 | $result = $poggitJson; 69 | } 70 | 71 | $this->setResult($result); 72 | } 73 | 74 | public function onCompletion() : void{ 75 | $player = Server::getInstance()->getPlayerExact($this->playerName); 76 | if($player === null){ 77 | return; 78 | } 79 | 80 | /** @var Main $plugin */ 81 | $plugin = $this->fetchLocal(self::TLS_KEY_PLUGIN); 82 | 83 | /** @var string[][] $results */ 84 | $results = $this->getResult(); 85 | if(count($results) === 0){ 86 | $form = new SearchPluginForm($plugin, $this->nameToSearch); 87 | }else{ 88 | $form = new SearchResultsForm($plugin, $results); 89 | } 90 | 91 | $player->sendForm($form); 92 | } 93 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/task/thread/RestartWindowsServer.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\task\thread; 25 | 26 | use pocketmine\thread\Thread; 27 | use pocketmine\thread\ThreadException; 28 | use pocketmine\utils\Utils; 29 | use function proc_close; 30 | use function proc_open; 31 | 32 | final class RestartWindowsServer extends Thread{ 33 | 34 | public function __construct(private readonly string $fileName){ 35 | if(($os = Utils::getOS()) !== Utils::OS_WINDOWS){ 36 | throw new ThreadException("Could not use this thread on $os OS"); 37 | } 38 | } 39 | 40 | public function quit() : void{ 41 | parent::quit(); 42 | $res = proc_open("start cmd.exe /c \"timeout /t 5 & $this->fileName\"", [], $pipes); 43 | if($res !== false){ 44 | proc_close($res); 45 | } 46 | } 47 | 48 | protected function onRun() : void{ 49 | // Do nothing 50 | } 51 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/utils/FormUtils.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\utils; 25 | 26 | use Closure; 27 | use dktapps\pmforms\MenuForm; 28 | use pocketmine\form\Form; 29 | use pocketmine\player\Player; 30 | 31 | final class FormUtils{ 32 | 33 | private function __construct(){ 34 | //NOOP 35 | } 36 | 37 | public static function getConfirmForm(string $title, string $message, ?Closure $onClose = null) : MenuForm{ 38 | return (new MenuForm( 39 | $title, 40 | $message, 41 | [], 42 | static function(Player $player, int $selectedOption) : void{ 43 | }, 44 | $onClose 45 | )); 46 | } 47 | 48 | public static function onClose(Form $form) : Closure{ 49 | return static function(Player $player) use ($form) : void{ 50 | $player->sendForm($form); 51 | }; 52 | } 53 | } -------------------------------------------------------------------------------- /src/matcracker/ServerTools/utils/Utils.php: -------------------------------------------------------------------------------- 1 | | <_> ) |__\___ \ 8 | * /_______ /\___ >__| \_/ \___ >__| |____| \____/ \____/|____/____ > 9 | * \/ \/ \/ \/ 10 | * 11 | * Copyright (C) 2020 12 | * This program is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU Lesser General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * (at your option) any later version. 16 | * 17 | * @author matcracker 18 | * @link https://www.github.com/matcracker/ServerTools 19 | * 20 | */ 21 | 22 | declare(strict_types=1); 23 | 24 | namespace matcracker\ServerTools\utils; 25 | 26 | use DirectoryIterator; 27 | use pocketmine\utils\Utils as PMUtils; 28 | use SplFileInfo; 29 | use function array_merge; 30 | use function file_exists; 31 | use function preg_match; 32 | use function round; 33 | 34 | final class Utils{ 35 | 36 | public static function bytesToHuman(int $size, int $precision = 2) : string{ 37 | static $units = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']; 38 | $step = 1024; 39 | $i = 0; 40 | while(($size / $step) > 0.9){ 41 | $size = $size / $step; 42 | $i++; 43 | } 44 | 45 | return round($size, $precision) . " " . $units[$i]; 46 | } 47 | 48 | /** 49 | * Returns a sorted files list by type. 50 | * 1) Folders 51 | * 2) Files 52 | * Both alphabetically sorted. 53 | * 54 | * @param string $path 55 | * 56 | * @return SplFileInfo[] File paths 57 | */ 58 | public static function getSortedFileList(string $path) : array{ 59 | if(!file_exists($path)){ 60 | return []; 61 | } 62 | 63 | $dirIterator = new DirectoryIterator($path); 64 | if(!$dirIterator->valid()){ 65 | return []; 66 | } 67 | 68 | $fileList = [ 69 | "dir" => [], 70 | "file" => [] 71 | ]; 72 | 73 | /** @var DirectoryIterator $iterator */ 74 | foreach($dirIterator as $iterator){ 75 | $fileInfo = $iterator->getFileInfo(); 76 | if($iterator->isDot()){ 77 | continue; 78 | }elseif($iterator->isDir()){ 79 | $fileList["dir"][] = $fileInfo; 80 | }else{ 81 | $fileList["file"][] = $fileInfo; 82 | } 83 | } 84 | 85 | return array_merge($fileList["dir"], $fileList["file"]); 86 | } 87 | 88 | public static function isValidFileName(string $fileName) : bool{ 89 | return match (PMUtils::getOS()) { 90 | PMUtils::OS_WINDOWS => self::isValidWindowsFileName($fileName), 91 | PMUtils::OS_MACOS, PMUtils::OS_IOS => self::isValidMacFileName($fileName), 92 | default => self::isValidUnixFileName($fileName), 93 | }; 94 | } 95 | 96 | public static function isValidWindowsFileName(string $fileName) : bool{ 97 | $regex = <<<'EOREGEX' 98 | ~ # start of regular expression 99 | ^ # Anchor to start of string. 100 | (?! # Assert filename is not: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9. 101 | (CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9]) 102 | (\.[^.]*)? # followed by optional extension 103 | $ # and end of string 104 | ) # End negative lookahead assertion. 105 | [^<>:"/\\|?*\x00-\x1F]* # Zero or more valid filename chars. 106 | [^<>:"/\\|?*\x00-\x1F\ .] # Last char is not a space or dot. 107 | $ # Anchor to end of string. 108 | # 109 | # tilde = end of regular expression. 110 | # i = pattern modifier PCRE_CASELESS. Make the match case insensitive. 111 | # x = pattern modifier PCRE_EXTENDED. Allows these comments inside the regex. 112 | # D = pattern modifier PCRE_DOLLAR_ENDONLY. A dollar should not match a newline if it is the final character. 113 | ~ixD 114 | EOREGEX; 115 | 116 | return preg_match($regex, $fileName) === 1; 117 | } 118 | 119 | public static function isValidMacFileName(string $fileName) : bool{ 120 | return preg_match("/[\/:]/", $fileName) === 0; 121 | } 122 | 123 | public static function isValidUnixFileName(string $fileName) : bool{ 124 | return !str_contains($fileName, "\x00") && preg_match("/[\/]/", $fileName) === 0; 125 | } 126 | } --------------------------------------------------------------------------------