From 82818414a3e340bb3aa9ba3d29b489866a7e85eb Mon Sep 17 00:00:00 2001 From: FabianS Date: Mon, 28 Mar 2022 21:28:16 +0200 Subject: [PATCH] Ability to create nodes with artisan (#3319) --- app/Console/Commands/Node/MakeNodeCommand.php | 88 +++++++++++++++++ resources/lang/en/command/messages.php | 97 ------------------- 2 files changed, 88 insertions(+), 97 deletions(-) create mode 100644 app/Console/Commands/Node/MakeNodeCommand.php delete mode 100644 resources/lang/en/command/messages.php diff --git a/app/Console/Commands/Node/MakeNodeCommand.php b/app/Console/Commands/Node/MakeNodeCommand.php new file mode 100644 index 000000000..c70aef35f --- /dev/null +++ b/app/Console/Commands/Node/MakeNodeCommand.php @@ -0,0 +1,88 @@ +. + * + * This software is licensed under the terms of the MIT license. + * https://opensource.org/licenses/MIT + */ + +namespace Pterodactyl\Console\Commands\Node; + +use Illuminate\Console\Command; +use Pterodactyl\Services\Nodes\NodeCreationService; + +class MakeNodeCommand extends Command +{ + /** + * @var \Pterodactyl\Services\Nodes\NodeCreationService + */ + protected $creationService; + + /** + * @var string + */ + protected $signature = 'p:node:make + {--name= : A name to identify the node.} + {--description= : A description to identify the node.} + {--locationId= : A valid locationId.} + {--fqdn= : The domain name (e.g node.example.com) to be used for connecting to the daemon. An IP address may only be used if you are not using SSL for this node.} + {--public= : Should the node be public or private? (public=1 / private=0).} + {--scheme= : Which scheme should be used? (Enable SSL=https / Disable SSL=http).} + {--proxy= : Is the daemon behind a proxy? (Yes=1 / No=0).} + {--maintenance= : Should maintenance mode be enabled? (Enable Maintenance mode=1 / Disable Maintenance mode=0).} + {--maxMemory= : Set the max memory amount.} + {--overallocateMemory= : Enter the amount of ram to overallocate (% or -1 to overallocate the maximum).} + {--maxDisk= : Set the max disk amount.} + {--overallocateDisk= : Enter the amount of disk to overallocate (% or -1 to overallocate the maximum).} + {--uploadSize= : Enter the maximum upload filesize.} + {--daemonListeningPort= : Enter the wings listening port.} + {--daemonSFTPPort= : Enter the wings SFTP listening port.} + {--daemonBase= : Enter the base folder.}'; + + /** + * @var string + */ + protected $description = 'Creates a new node on the system via the CLI.'; + + + /** + * Handle the command execution process. + * + * @throws \Pterodactyl\Exceptions\Model\DataValidationException + */ + public function handle(NodeCreationService $creationService) + { + $this->creationService = $creationService; + + $data['name'] = $this->option('name') ?? $this->ask('Enter a short identifier used to distinguish this node from others'); + $data['description'] = $this->option('description') ?? $this->ask('Enter a description to identify the node'); + $data['location_id'] = $this->option('locationId') ?? $this->ask('Enter a valid location id'); + $data['fqdn'] = $this->option('fqdn') ?? $this->ask('Enter a domain name (e.g node.example.com) to be used for connecting to the daemon. An IP address may only be used if you are not using SSL for this node'); + if (!filter_var(gethostbyname($data['fqdn']), FILTER_VALIDATE_IP)) { + $this->error('The FQDN or IP address provided does not resolve to a valid IP address.'); + return; + } + $data['public'] = $this->option('public') ?? $this->confirm('Should this node be public? As a note, setting a node to private you will be denying the ability to auto-deploy to this node.', true); + $data['scheme'] = $this->option('scheme') ?? $this->anticipate('Please either enter https for SSL or http for a non-ssl connection', + ["https","http",],"https"); + if (filter_var($data['fqdn'], FILTER_VALIDATE_IP) && $data['scheme'] === 'https') { + $this->error('A fully qualified domain name that resolves to a public IP address is required in order to use SSL for this node.'); + return; + } + $data['behind_proxy'] = $this->option('proxy') ?? $this->confirm('Is your FQDN behind a proxy?'); + $data['maintenance_mode'] = $this->option('maintenance') ?? $this->confirm('Should maintenance mode be enabled?'); + $data['memory'] = $this->option('maxMemory') ?? $this->ask('Enter the maximum amount of memory'); + $data['memory_overallocate'] = $this->option('overallocateMemory') ?? $this->ask('Enter the amount of memory to over allocate by, -1 will disable checking and 0 will prevent creating new servers'); + $data['disk'] = $this->option('maxDisk') ?? $this->ask('Enter the maximum amount of disk space'); + $data['disk_overallocate'] = $this->option('overallocateDisk') ?? $this->ask('Enter the amount of memory to over allocate by, -1 will disable checking and 0 will prevent creating new server'); + $data['upload_size'] = $this->option('uploadSize') ?? $this->ask('Enter the maximum filesize upload', '100'); + $data['daemonListen'] = $this->option('daemonListeningPort') ?? $this->ask('Enter the wings listening port', '8080'); + $data['daemonSFTP'] = $this->option('daemonSFTPPort') ?? $this->ask('Enter the wings SFTP listening port', '2022'); + $data['daemonBase'] = $this->option('daemonBase') ?? $this->ask('Enter the base folder', '/var/lib/pterodactyl/volumes'); + + $node = $this->creationService->handle($data); + $this->line('Successfully created a new node on the location ' . $data['location_id'] . ' with the name ' . $data['name'] . ' and has an id of ' . $node->id . '.'); + } +} diff --git a/resources/lang/en/command/messages.php b/resources/lang/en/command/messages.php deleted file mode 100644 index b02fa8c29..000000000 --- a/resources/lang/en/command/messages.php +++ /dev/null @@ -1,97 +0,0 @@ - [ - 'no_location_found' => 'Could not locate a record matching the provided short code.', - 'ask_short' => 'Location Short Code', - 'ask_long' => 'Location Description', - 'created' => 'Successfully created a new location (:name) with an ID of :id.', - 'deleted' => 'Successfully deleted the requested location.', - ], - 'user' => [ - 'search_users' => 'Enter a Username, User ID, or Email Address', - 'select_search_user' => 'ID of user to delete (Enter \'0\' to re-search)', - 'deleted' => 'User successfully deleted from the Panel.', - 'confirm_delete' => 'Are you sure you want to delete this user from the Panel?', - 'no_users_found' => 'No users were found for the search term provided.', - 'multiple_found' => 'Multiple accounts were found for the user provided, unable to delete a user because of the --no-interaction flag.', - 'ask_admin' => 'Is this user an administrator?', - 'ask_email' => 'Email Address', - 'ask_username' => 'Username', - 'ask_name_first' => 'First Name', - 'ask_name_last' => 'Last Name', - 'ask_password' => 'Password', - 'ask_password_tip' => 'If you would like to create an account with a random password emailed to the user, re-run this command (CTRL+C) and pass the `--no-password` flag.', - 'ask_password_help' => 'Passwords must be at least 8 characters in length and contain at least one capital letter and number.', - '2fa_help_text' => [ - 'This command will disable 2-factor authentication for a user\'s account if it is enabled. This should only be used as an account recovery command if the user is locked out of their account.', - 'If this is not what you wanted to do, press CTRL+C to exit this process.', - ], - '2fa_disabled' => '2-Factor authentication has been disabled for :email.', - ], - 'schedule' => [ - 'output_line' => 'Dispatching job for first task in `:schedule` (:hash).', - ], - 'maintenance' => [ - 'deleting_service_backup' => 'Deleting service backup file :file.', - ], - 'server' => [ - 'rebuild_failed' => 'Rebuild request for ":name" (#:id) on node ":node" failed with error: :message', - 'reinstall' => [ - 'failed' => 'Reinstall request for ":name" (#:id) on node ":node" failed with error: :message', - 'confirm' => 'You are about to reinstall against a group of servers. Do you wish to continue?', - ], - 'power' => [ - 'confirm' => 'You are about to perform a :action against :count servers. Do you wish to continue?', - 'action_failed' => 'Power action request for ":name" (#:id) on node ":node" failed with error: :message', - ], - ], - 'environment' => [ - 'mail' => [ - 'ask_smtp_host' => 'SMTP Host (e.g. smtp.gmail.com)', - 'ask_smtp_port' => 'SMTP Port', - 'ask_smtp_username' => 'SMTP Username', - 'ask_smtp_password' => 'SMTP Password', - 'ask_mailgun_domain' => 'Mailgun Domain', - 'ask_mailgun_endpoint' => 'Mailgun Endpoint', - 'ask_mailgun_secret' => 'Mailgun Secret', - 'ask_mandrill_secret' => 'Mandrill Secret', - 'ask_postmark_username' => 'Postmark API Key', - 'ask_driver' => 'Which driver should be used for sending emails?', - 'ask_mail_from' => 'Email address emails should originate from', - 'ask_mail_name' => 'Name that emails should appear from', - 'ask_encryption' => 'Encryption method to use', - ], - 'database' => [ - 'host_warning' => 'It is highly recommended to not use "localhost" as your database host as we have seen frequent socket connection issues. If you want to use a local connection you should be using "127.0.0.1".', - 'host' => 'Database Host', - 'port' => 'Database Port', - 'database' => 'Database Name', - 'username_warning' => 'Using the "root" account for MySQL connections is not only highly frowned upon, it is also not allowed by this application. You\'ll need to have created a MySQL user for this software.', - 'username' => 'Database Username', - 'password_defined' => 'It appears you already have a MySQL connection password defined, would you like to change it?', - 'password' => 'Database Password', - 'connection_error' => 'Unable to connect to the MySQL server using the provided credentials. The error returned was ":error".', - 'creds_not_saved' => 'Your connection credentials have NOT been saved. You will need to provide valid connection information before proceeding.', - 'try_again' => 'Go back and try again?', - ], - 'app' => [ - 'settings' => 'Enable UI based settings editor?', - 'author' => 'Egg Author Email', - 'author_help' => 'Provide the email address that eggs exported by this Panel should be from. This should be a valid email address.', - 'app_url_help' => 'The application URL MUST begin with https:// or http:// depending on if you are using SSL or not. If you do not include the scheme your emails and other content will link to the wrong location.', - 'app_url' => 'Application URL', - 'timezone_help' => 'The timezone should match one of PHP\'s supported timezones. If you are unsure, please reference http://php.net/manual/en/timezones.php.', - 'timezone' => 'Application Timezone', - 'cache_driver' => 'Cache Driver', - 'session_driver' => 'Session Driver', - 'queue_driver' => 'Queue Driver', - 'using_redis' => 'You\'ve selected the Redis driver for one or more options, please provide valid connection information below. In most cases you can use the defaults provided unless you have modified your setup.', - 'redis_host' => 'Redis Host', - 'redis_password' => 'Redis Password', - 'redis_pass_help' => 'By default a Redis server instance has no password as it is running locally and inaccessible to the outside world. If this is the case, simply hit enter without entering a value.', - 'redis_port' => 'Redis Port', - 'redis_pass_defined' => 'It seems a password is already defined for Redis, would you like to change it?', - ], - ], -];