initial commit
This commit is contained in:
commit
eb5b65cec6
17
.editorconfig
Normal file
17
.editorconfig
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
tab_width = 4
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.md]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[*.{md,nix,yml,yaml}]
|
||||||
|
indent_size = 2
|
||||||
|
tab_width = 2
|
||||||
6
.eslintignore
Normal file
6
.eslintignore
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
public
|
||||||
|
node_modules
|
||||||
|
resources/views
|
||||||
|
babel.config.js
|
||||||
|
tailwind.config.js
|
||||||
|
webpack.config.js
|
||||||
51
.eslintrc.js
Normal file
51
.eslintrc.js
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
/** @type {import('eslint').Linter.Config} */
|
||||||
|
module.exports = {
|
||||||
|
parser: '@typescript-eslint/parser',
|
||||||
|
parserOptions: {
|
||||||
|
ecmaVersion: 6,
|
||||||
|
ecmaFeatures: {
|
||||||
|
jsx: true,
|
||||||
|
},
|
||||||
|
project: './tsconfig.json',
|
||||||
|
tsconfigRootDir: './',
|
||||||
|
},
|
||||||
|
settings: {
|
||||||
|
react: {
|
||||||
|
pragma: 'React',
|
||||||
|
version: 'detect',
|
||||||
|
},
|
||||||
|
linkComponents: [
|
||||||
|
{ name: 'Link', linkAttribute: 'to' },
|
||||||
|
{ name: 'NavLink', linkAttribute: 'to' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
env: {
|
||||||
|
browser: true,
|
||||||
|
es6: true,
|
||||||
|
},
|
||||||
|
plugins: ['react', 'react-hooks', 'prettier', '@typescript-eslint'],
|
||||||
|
extends: [
|
||||||
|
// 'standard',
|
||||||
|
'eslint:recommended',
|
||||||
|
'plugin:react/recommended',
|
||||||
|
'plugin:@typescript-eslint/recommended',
|
||||||
|
'plugin:jest-dom/recommended',
|
||||||
|
],
|
||||||
|
rules: {
|
||||||
|
eqeqeq: 'error',
|
||||||
|
'prettier/prettier': ['error', {}, { usePrettierrc: true }],
|
||||||
|
// TypeScript can infer this significantly better than eslint ever can.
|
||||||
|
'react/prop-types': 0,
|
||||||
|
'react/display-name': 0,
|
||||||
|
'@typescript-eslint/no-explicit-any': 0,
|
||||||
|
'@typescript-eslint/no-non-null-assertion': 0,
|
||||||
|
// This setup is required to avoid a spam of errors when running eslint about React being
|
||||||
|
// used before it is defined.
|
||||||
|
//
|
||||||
|
// @see https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md#how-to-use
|
||||||
|
'no-use-before-define': 0,
|
||||||
|
'@typescript-eslint/no-use-before-define': 'warn',
|
||||||
|
'@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
|
||||||
|
'@typescript-eslint/ban-ts-comment': ['error', { 'ts-expect-error': 'allow-with-description' }],
|
||||||
|
},
|
||||||
|
};
|
||||||
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
github: [matthewpi]
|
||||||
87
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
87
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
@ -0,0 +1,87 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Something isn't working quite right in the software.
|
||||||
|
labels: [not confirmed]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Bug reports should only be used for reporting issues with how the software works. For assistance installing this software, as well as debugging issues with dependencies, please use our [Discord server](https://discord.gg/pterodactyl).
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Current Behavior
|
||||||
|
description: Please provide a clear & concise description of the issue.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: Please describe what you expected to happen.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: Please be as detailed as possible when providing steps to reproduce, failure to provide steps will result in this issue being closed.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: panel-version
|
||||||
|
attributes:
|
||||||
|
label: Panel Version
|
||||||
|
description: Version number of your Panel (latest is not a version)
|
||||||
|
placeholder: 1.4.0
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: wings-version
|
||||||
|
attributes:
|
||||||
|
label: Wings Version
|
||||||
|
description: Version number of your Wings (latest is not a version)
|
||||||
|
placeholder: 1.4.2
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: egg-details
|
||||||
|
attributes:
|
||||||
|
label: Games and/or Eggs Affected
|
||||||
|
description: Please include the specific game(s) or egg(s) you are running into this bug with.
|
||||||
|
placeholder: Minecraft (Paper), Minecraft (Forge)
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: docker-image
|
||||||
|
attributes:
|
||||||
|
label: Docker Image
|
||||||
|
description: The specific Docker image you are using for the game(s) above.
|
||||||
|
placeholder: ghcr.io/pterodactyl/yolks:java_17
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: panel-logs
|
||||||
|
attributes:
|
||||||
|
label: Error Logs
|
||||||
|
description: |
|
||||||
|
Run the following command to collect logs on your system.
|
||||||
|
|
||||||
|
Wings: `sudo wings diagnostics`
|
||||||
|
Panel: `tail -n 150 /var/www/pterodactyl/storage/logs/laravel-$(date +%F).log | nc pteropaste.com 99`
|
||||||
|
placeholder: "https://pteropaste.com/a1h6z"
|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: Please [search here](https://github.com/pterodactyl/panel/issues) to see if an issue already exists for your problem.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues before opening this issue.
|
||||||
|
required: true
|
||||||
|
- label: I have provided all relevant details, including the specific game and Docker images I am using if this issue is related to running a server.
|
||||||
|
required: true
|
||||||
|
- label: I have checked in the Discord server and believe this is a bug with the software, and not a configuration issue with my specific system.
|
||||||
|
required: true
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Installation Help
|
||||||
|
url: https://discord.gg/pterodactyl
|
||||||
|
about: Please visit our Discord for help with your installation.
|
||||||
|
- name: General Question
|
||||||
|
url: https://discord.gg/pterodactyl
|
||||||
|
about: Please visit our Discord for general questions about Pterodactyl.
|
||||||
32
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
32
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Suggest a new feature or improvement for the software.
|
||||||
|
labels: [feature request]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing feature request for this?
|
||||||
|
description: Please [search here](https://github.com/pterodactyl/panel/issues?q=is%3Aissue) to see if someone else has already suggested this.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues before opening this feature request.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the feature you would like to see.
|
||||||
|
description: "A clear & concise description of the feature you'd like to have added, and what issues it would solve."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Describe the solution you'd like.
|
||||||
|
description: "You must explain how you'd like to see this feature implemented. Technical implementation details are not necessary, rather an idea of how you'd like to see this feature used."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional context to this request.
|
||||||
|
description: "Add any other context or screenshots about the feature request."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
76
.github/docker/README.md
vendored
Normal file
76
.github/docker/README.md
vendored
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
# Pterodactyl Panel - Docker Image
|
||||||
|
This is a ready to use docker image for the panel.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
This docker image requires some additional software to function. The software can either be provided in other containers (see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/develop/docker-compose.example.yml) as an example) or as existing instances.
|
||||||
|
|
||||||
|
A mysql database is required. We recommend the stock [MariaDB Image](https://hub.docker.com/_/mariadb/) image if you prefer to run it in a docker container. As a non-containerized option we recommend mariadb.
|
||||||
|
|
||||||
|
A caching software is required as well. We recommend the stock [Redis Image](https://hub.docker.com/_/redis/) image. You can choose any of the [supported options](#cache-drivers).
|
||||||
|
|
||||||
|
You can provide additional settings using a custom `.env` file or by setting the appropriate environment variables in the docker-compose file.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Start the docker container and the required dependencies (either provide existing ones or start containers as well, see the [docker-compose.yml](https://github.com/pterodactyl/panel/blob/develop/docker-compose.example.yml) file as an example.
|
||||||
|
|
||||||
|
After the startup is complete you'll need to create a user.
|
||||||
|
If you are running the docker container without docker-compose, use:
|
||||||
|
```
|
||||||
|
docker exec -it <container id> php artisan p:user:make
|
||||||
|
```
|
||||||
|
If you are using docker compose use
|
||||||
|
```
|
||||||
|
docker-compose exec panel php artisan p:user:make
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
There are multiple environment variables to configure the panel when not providing your own `.env` file, see the following table for details on each available option.
|
||||||
|
|
||||||
|
Note: If your `APP_URL` starts with `https://` you need to provide an `LE_EMAIL` as well so Certificates can be generated.
|
||||||
|
|
||||||
|
| Variable | Description | Required |
|
||||||
|
| ------------------- | ------------------------------------------------------------------------------ | -------- |
|
||||||
|
| `APP_URL` | The URL the panel will be reachable with (including protocol) | yes |
|
||||||
|
| `APP_TIMEZONE` | The timezone to use for the panel | yes |
|
||||||
|
| `LE_EMAIL` | The email used for letsencrypt certificate generation | yes |
|
||||||
|
| `DB_HOST` | The host of the mysql instance | yes |
|
||||||
|
| `DB_PORT` | The port of the mysql instance | yes |
|
||||||
|
| `DB_DATABASE` | The name of the mysql database | yes |
|
||||||
|
| `DB_USERNAME` | The mysql user | yes |
|
||||||
|
| `DB_PASSWORD` | The mysql password for the specified user | yes |
|
||||||
|
| `CACHE_DRIVER` | The cache driver (see [Cache drivers](#cache-drivers) for detais) | yes |
|
||||||
|
| `SESSION_DRIVER` | | yes |
|
||||||
|
| `QUEUE_DRIVER` | | yes |
|
||||||
|
| `REDIS_HOST` | The hostname or IP address of the redis database | yes |
|
||||||
|
| `REDIS_PASSWORD` | The password used to secure the redis database | maybe |
|
||||||
|
| `REDIS_PORT` | The port the redis database is using on the host | maybe |
|
||||||
|
| `MAIL_DRIVER` | The email driver (see [Mail drivers](#mail-drivers) for details) | yes |
|
||||||
|
| `MAIL_FROM` | The email that should be used as the sender email | yes |
|
||||||
|
| `MAIL_HOST` | The host of your mail driver instance | maybe |
|
||||||
|
| `MAIL_PORT` | The port of your mail driver instance | maybe |
|
||||||
|
| `MAIL_USERNAME` | The username for your mail driver | maybe |
|
||||||
|
| `MAIL_PASSWORD` | The password for your mail driver | maybe |
|
||||||
|
|
||||||
|
|
||||||
|
### Cache drivers
|
||||||
|
You can choose between different cache drivers depending on what you prefer.
|
||||||
|
We recommend redis when using docker as it can be started in a container easily.
|
||||||
|
|
||||||
|
| Driver | Description | Required variables |
|
||||||
|
| -------- | ------------------------------------ | ------------------------------------------------------ |
|
||||||
|
| redis | host where redis is running | `REDIS_HOST` |
|
||||||
|
| redis | port redis is running on | `REDIS_PORT` |
|
||||||
|
| redis | redis database password | `REDIS_PASSWORD` |
|
||||||
|
|
||||||
|
### Mail drivers
|
||||||
|
You can choose between different mail drivers according to your needs.
|
||||||
|
Every driver requires `MAIL_FROM` to be set.
|
||||||
|
|
||||||
|
| Driver | Description | Required variables |
|
||||||
|
| -------- | ------------------------------------ | ------------------------------------------------------------- |
|
||||||
|
| mail | uses the installed php mail | |
|
||||||
|
| mandrill | [Mandrill](http://www.mandrill.com/) | `MAIL_USERNAME` |
|
||||||
|
| postmark | [Postmark](https://postmarkapp.com/) | `MAIL_USERNAME` |
|
||||||
|
| mailgun | [Mailgun](https://www.mailgun.com/) | `MAIL_USERNAME`, `MAIL_HOST` |
|
||||||
|
| smtp | Any SMTP server can be configured | `MAIL_USERNAME`, `MAIL_HOST`, `MAIL_PASSWORD`, `MAIL_PORT` |
|
||||||
51
.github/docker/default.conf
vendored
Normal file
51
.github/docker/default.conf
vendored
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
# If using Ubuntu this file should be placed in:
|
||||||
|
# /etc/nginx/sites-available/
|
||||||
|
#
|
||||||
|
# If using CentOS this file should be placed in:
|
||||||
|
# /etc/nginx/conf.d/
|
||||||
|
#
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
root /app/public;
|
||||||
|
index index.html index.htm index.php;
|
||||||
|
charset utf-8;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.php?$query_string;
|
||||||
|
}
|
||||||
|
|
||||||
|
location = /favicon.ico { access_log off; log_not_found off; }
|
||||||
|
location = /robots.txt { access_log off; log_not_found off; }
|
||||||
|
|
||||||
|
access_log off;
|
||||||
|
error_log /var/log/nginx/pterodactyl.app-error.log error;
|
||||||
|
|
||||||
|
# allow larger file uploads and longer script runtimes
|
||||||
|
client_max_body_size 100m;
|
||||||
|
client_body_timeout 120s;
|
||||||
|
|
||||||
|
sendfile off;
|
||||||
|
|
||||||
|
location ~ \.php$ {
|
||||||
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||||
|
# the fastcgi_pass path needs to be changed accordingly when using CentOS
|
||||||
|
fastcgi_pass 127.0.0.1:9000;
|
||||||
|
fastcgi_index index.php;
|
||||||
|
include fastcgi_params;
|
||||||
|
fastcgi_param PHP_VALUE "upload_max_filesize = 100M \n post_max_size=100M";
|
||||||
|
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||||
|
fastcgi_param HTTP_PROXY "";
|
||||||
|
fastcgi_intercept_errors off;
|
||||||
|
fastcgi_buffer_size 16k;
|
||||||
|
fastcgi_buffers 4 16k;
|
||||||
|
fastcgi_connect_timeout 300;
|
||||||
|
fastcgi_send_timeout 300;
|
||||||
|
fastcgi_read_timeout 300;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ /\.ht {
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
}
|
||||||
70
.github/docker/default_ssl.conf
vendored
Normal file
70
.github/docker/default_ssl.conf
vendored
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
# If using Ubuntu this file should be placed in:
|
||||||
|
# /etc/nginx/sites-available/
|
||||||
|
#
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name <domain>;
|
||||||
|
return 301 https://$server_name$request_uri;
|
||||||
|
}
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 443 ssl http2;
|
||||||
|
server_name <domain>;
|
||||||
|
|
||||||
|
root /app/public;
|
||||||
|
index index.php;
|
||||||
|
|
||||||
|
access_log /var/log/nginx/pterodactyl.app-access.log;
|
||||||
|
error_log /var/log/nginx/pterodactyl.app-error.log error;
|
||||||
|
|
||||||
|
# allow larger file uploads and longer script runtimes
|
||||||
|
client_max_body_size 100m;
|
||||||
|
client_body_timeout 120s;
|
||||||
|
|
||||||
|
sendfile off;
|
||||||
|
|
||||||
|
# strengthen ssl security
|
||||||
|
ssl_certificate /etc/letsencrypt/live/<domain>/fullchain.pem;
|
||||||
|
ssl_certificate_key /etc/letsencrypt/live/<domain>/privkey.pem;
|
||||||
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
|
||||||
|
ssl_prefer_server_ciphers on;
|
||||||
|
ssl_session_cache shared:SSL:10m;
|
||||||
|
ssl_ciphers "EECDH+AESGCM:EDH+AESGCM:ECDHE-RSA-AES128-GCM-SHA256:AES256+EECDH:DHE-RSA-AES128-GCM-SHA256:AES256+EDH:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
|
||||||
|
|
||||||
|
# See the link below for more SSL information:
|
||||||
|
# https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html
|
||||||
|
#
|
||||||
|
# ssl_dhparam /etc/ssl/certs/dhparam.pem;
|
||||||
|
|
||||||
|
# Add headers to serve security related headers
|
||||||
|
add_header Strict-Transport-Security "max-age=15768000; preload;";
|
||||||
|
add_header X-Content-Type-Options nosniff;
|
||||||
|
add_header X-XSS-Protection "1; mode=block";
|
||||||
|
add_header X-Robots-Tag none;
|
||||||
|
add_header Content-Security-Policy "frame-ancestors 'self'";
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.php?$query_string;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ \.php$ {
|
||||||
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||||
|
fastcgi_pass 127.0.0.1:9000;
|
||||||
|
fastcgi_index index.php;
|
||||||
|
include fastcgi_params;
|
||||||
|
fastcgi_param PHP_VALUE "upload_max_filesize = 100M \n post_max_size=100M";
|
||||||
|
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||||
|
fastcgi_param HTTP_PROXY "";
|
||||||
|
fastcgi_intercept_errors off;
|
||||||
|
fastcgi_buffer_size 16k;
|
||||||
|
fastcgi_buffers 4 16k;
|
||||||
|
fastcgi_connect_timeout 300;
|
||||||
|
fastcgi_send_timeout 300;
|
||||||
|
fastcgi_read_timeout 300;
|
||||||
|
include /etc/nginx/fastcgi_params;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ /\.ht {
|
||||||
|
deny all;
|
||||||
|
}
|
||||||
|
}
|
||||||
81
.github/docker/entrypoint.sh
vendored
Normal file
81
.github/docker/entrypoint.sh
vendored
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
#!/bin/ash -e
|
||||||
|
cd /app
|
||||||
|
|
||||||
|
mkdir -p /var/log/panel/logs/ /var/log/supervisord/ /var/log/nginx/ /var/log/php7/ \
|
||||||
|
&& chmod 777 /var/log/panel/logs/ \
|
||||||
|
&& ln -s /app/storage/logs/ /var/log/panel/
|
||||||
|
|
||||||
|
## check for .env file and generate app keys if missing
|
||||||
|
if [ -f /app/var/.env ]; then
|
||||||
|
echo "external vars exist."
|
||||||
|
rm -rf /app/.env
|
||||||
|
ln -s /app/var/.env /app/
|
||||||
|
else
|
||||||
|
echo "external vars don't exist."
|
||||||
|
rm -rf /app/.env
|
||||||
|
touch /app/var/.env
|
||||||
|
|
||||||
|
## manually generate a key because key generate --force fails
|
||||||
|
if [ -z $APP_KEY ]; then
|
||||||
|
echo -e "Generating key."
|
||||||
|
APP_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)
|
||||||
|
echo -e "Generated app key: $APP_KEY"
|
||||||
|
echo -e "APP_KEY=$APP_KEY" > /app/var/.env
|
||||||
|
else
|
||||||
|
echo -e "APP_KEY exists in environment, using that."
|
||||||
|
echo -e "APP_KEY=$APP_KEY" > /app/var/.env
|
||||||
|
fi
|
||||||
|
|
||||||
|
ln -s /app/var/.env /app/
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Checking if https is required."
|
||||||
|
if [ -f /etc/nginx/http.d/panel.conf ]; then
|
||||||
|
echo "Using nginx config already in place."
|
||||||
|
if [ $LE_EMAIL ]; then
|
||||||
|
echo "Checking for cert update"
|
||||||
|
certbot certonly -d $(echo $APP_URL | sed 's~http[s]*://~~g') --standalone -m $LE_EMAIL --agree-tos -n
|
||||||
|
else
|
||||||
|
echo "No letsencrypt email is set"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "Checking if letsencrypt email is set."
|
||||||
|
if [ -z $LE_EMAIL ]; then
|
||||||
|
echo "No letsencrypt email is set using http config."
|
||||||
|
cp .github/docker/default.conf /etc/nginx/http.d/panel.conf
|
||||||
|
else
|
||||||
|
echo "writing ssl config"
|
||||||
|
cp .github/docker/default_ssl.conf /etc/nginx/http.d/panel.conf
|
||||||
|
echo "updating ssl config for domain"
|
||||||
|
sed -i "s|<domain>|$(echo $APP_URL | sed 's~http[s]*://~~g')|g" /etc/nginx/http.d/panel.conf
|
||||||
|
echo "generating certs"
|
||||||
|
certbot certonly -d $(echo $APP_URL | sed 's~http[s]*://~~g') --standalone -m $LE_EMAIL --agree-tos -n
|
||||||
|
fi
|
||||||
|
echo "Removing the default nginx config"
|
||||||
|
rm -rf /etc/nginx/http.d/default.conf
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -z $DB_PORT ]]; then
|
||||||
|
echo -e "DB_PORT not specified, defaulting to 3306"
|
||||||
|
DB_PORT=3306
|
||||||
|
fi
|
||||||
|
|
||||||
|
## check for DB up before starting the panel
|
||||||
|
echo "Checking database status."
|
||||||
|
until nc -z -v -w30 $DB_HOST $DB_PORT
|
||||||
|
do
|
||||||
|
echo "Waiting for database connection..."
|
||||||
|
# wait for 1 seconds before check again
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
|
||||||
|
## make sure the db is set up
|
||||||
|
echo -e "Migrating and Seeding D.B"
|
||||||
|
php artisan migrate --seed --force
|
||||||
|
|
||||||
|
## start cronjobs for the queue
|
||||||
|
echo -e "Starting cron jobs."
|
||||||
|
crond -L /var/log/crond -l 5
|
||||||
|
|
||||||
|
echo -e "Starting supervisord."
|
||||||
|
exec "$@"
|
||||||
39
.github/docker/supervisord.conf
vendored
Normal file
39
.github/docker/supervisord.conf
vendored
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
[unix_http_server]
|
||||||
|
file=/tmp/supervisor.sock ; path to your socket file
|
||||||
|
|
||||||
|
[supervisord]
|
||||||
|
logfile=/var/log/supervisord/supervisord.log ; supervisord log file
|
||||||
|
logfile_maxbytes=50MB ; maximum size of logfile before rotation
|
||||||
|
logfile_backups=2 ; number of backed up logfiles
|
||||||
|
loglevel=error ; info, debug, warn, trace
|
||||||
|
pidfile=/var/run/supervisord.pid ; pidfile location
|
||||||
|
nodaemon=false ; run supervisord as a daemon
|
||||||
|
minfds=1024 ; number of startup file descriptors
|
||||||
|
minprocs=200 ; number of process descriptors
|
||||||
|
user=root ; default user
|
||||||
|
childlogdir=/var/log/supervisord/ ; where child log files will live
|
||||||
|
|
||||||
|
[rpcinterface:supervisor]
|
||||||
|
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
|
||||||
|
|
||||||
|
[supervisorctl]
|
||||||
|
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
|
||||||
|
|
||||||
|
[program:php-fpm]
|
||||||
|
command=/usr/local/sbin/php-fpm -F
|
||||||
|
autostart=true
|
||||||
|
autorestart=true
|
||||||
|
|
||||||
|
[program:queue-worker]
|
||||||
|
command=/usr/local/bin/php /app/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3
|
||||||
|
user=nginx
|
||||||
|
autostart=true
|
||||||
|
autorestart=true
|
||||||
|
|
||||||
|
[program:nginx]
|
||||||
|
command=/usr/sbin/nginx -g 'daemon off;'
|
||||||
|
autostart=true
|
||||||
|
autorestart=true
|
||||||
|
priority=10
|
||||||
|
stdout_events_enabled=true
|
||||||
|
stderr_events_enabled=true
|
||||||
16
.github/docker/www.conf
vendored
Normal file
16
.github/docker/www.conf
vendored
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
[www]
|
||||||
|
|
||||||
|
user = nginx
|
||||||
|
group = nginx
|
||||||
|
|
||||||
|
listen = 127.0.0.1:9000
|
||||||
|
listen.owner = nginx
|
||||||
|
listen.group = nginx
|
||||||
|
listen.mode = 0750
|
||||||
|
|
||||||
|
pm = ondemand
|
||||||
|
pm.max_children = 9
|
||||||
|
pm.process_idle_timeout = 10s
|
||||||
|
pm.max_requests = 200
|
||||||
|
|
||||||
|
clear_env = no
|
||||||
37
.github/workflows/build.yaml
vendored
Normal file
37
.github/workflows/build.yaml
vendored
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
name: Build
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
ui:
|
||||||
|
name: UI
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
node-version: [16]
|
||||||
|
steps:
|
||||||
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
cache: yarn
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: yarn install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: yarn build:production
|
||||||
78
.github/workflows/ci.yaml
vendored
Normal file
78
.github/workflows/ci.yaml
vendored
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
name: Tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
tests:
|
||||||
|
name: Tests
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
php: [8.2, 8.3]
|
||||||
|
database:
|
||||||
|
- mariadb:10.5
|
||||||
|
- mariadb:10.11
|
||||||
|
- mariadb:11.5
|
||||||
|
- mysql:8
|
||||||
|
- mysql:9
|
||||||
|
services:
|
||||||
|
database:
|
||||||
|
image: ${{ matrix.database }}
|
||||||
|
env:
|
||||||
|
MYSQL_ALLOW_EMPTY_PASSWORD: yes
|
||||||
|
MYSQL_DATABASE: testing
|
||||||
|
ports:
|
||||||
|
- 3306
|
||||||
|
steps:
|
||||||
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Get cache directory
|
||||||
|
id: composer-cache
|
||||||
|
run: |
|
||||||
|
echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Cache
|
||||||
|
uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: ${{ steps.composer-cache.outputs.dir }}
|
||||||
|
key: ${{ runner.os }}-composer-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-composer-${{ matrix.php }}-
|
||||||
|
|
||||||
|
- name: Setup PHP
|
||||||
|
uses: shivammathur/setup-php@v2
|
||||||
|
with:
|
||||||
|
php-version: ${{ matrix.php }}
|
||||||
|
extensions: bcmath, cli, curl, gd, mbstring, mysql, openssl, pdo, tokenizer, xml, zip
|
||||||
|
tools: composer:v2
|
||||||
|
coverage: none
|
||||||
|
|
||||||
|
- name: Setup .env
|
||||||
|
run: cp .env.ci .env
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: composer install --no-interaction --no-progress --no-suggest --prefer-dist
|
||||||
|
|
||||||
|
- name: Unit tests
|
||||||
|
run: vendor/bin/phpunit --bootstrap vendor/autoload.php tests/Unit
|
||||||
|
if: ${{ always() }}
|
||||||
|
env:
|
||||||
|
DB_HOST: UNIT_NO_DB
|
||||||
|
|
||||||
|
- name: Integration tests
|
||||||
|
run: vendor/bin/phpunit tests/Integration
|
||||||
|
env:
|
||||||
|
DB_PORT: ${{ job.services.database.ports[3306] }}
|
||||||
|
DB_USERNAME: root
|
||||||
72
.github/workflows/docker.yaml
vendored
Normal file
72
.github/workflows/docker.yaml
vendored
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
name: Docker
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- develop
|
||||||
|
- 1.0-develop
|
||||||
|
- release/v1.11.5
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- develop
|
||||||
|
- 1.0-develop
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
push:
|
||||||
|
name: Push
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
if: "!contains(github.ref, 'develop') || (!contains(github.event.head_commit.message, 'skip docker') && !contains(github.event.head_commit.message, 'docker skip'))"
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Code checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Docker metadata
|
||||||
|
id: docker_meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: ghcr.io/nookure/nooktheme
|
||||||
|
flavor: |
|
||||||
|
latest=false
|
||||||
|
tags: |
|
||||||
|
type=raw,value=latest,enable=${{ github.event_name == 'release' && github.event.action == 'published' && github.event.release.prerelease == false }}
|
||||||
|
type=ref,event=tag
|
||||||
|
type=ref,event=branch
|
||||||
|
|
||||||
|
- name: Setup QEMU
|
||||||
|
uses: docker/setup-qemu-action@v3
|
||||||
|
|
||||||
|
- name: Setup Docker buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
if: "github.event_name != 'pull_request'"
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.repository_owner }}
|
||||||
|
password: ${{ secrets.TOKEN }}
|
||||||
|
|
||||||
|
- name: Update version
|
||||||
|
if: "github.event_name == 'release' && github.event.action == 'published'"
|
||||||
|
env:
|
||||||
|
REF: ${{ github.event.release.tag_name }}
|
||||||
|
run: |
|
||||||
|
sed -i "s/ 'version' => 'canary',/ 'version' => '${REF:1}',/" config/app.php
|
||||||
|
|
||||||
|
- name: Build and Push
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./Dockerfile
|
||||||
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
labels: ${{ steps.docker_meta.outputs.labels }}
|
||||||
|
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
||||||
38
.github/workflows/lint.yaml
vendored
Normal file
38
.github/workflows/lint.yaml
vendored
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
name: Lint
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- "develop"
|
||||||
|
- "1.0-develop"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
name: Lint
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Code Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup PHP
|
||||||
|
uses: shivammathur/setup-php@v2
|
||||||
|
with:
|
||||||
|
php-version: "8.2"
|
||||||
|
extensions: bcmath, curl, gd, mbstring, mysql, openssl, pdo, tokenizer, xml, zip
|
||||||
|
tools: composer:v2
|
||||||
|
coverage: none
|
||||||
|
|
||||||
|
- name: Setup .env
|
||||||
|
run: cp .env.ci .env
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: composer install --no-interaction --no-progress --no-suggest --prefer-dist
|
||||||
|
|
||||||
|
- name: PHP CS Fixer
|
||||||
|
run: vendor/bin/php-cs-fixer fix --dry-run --diff
|
||||||
72
.github/workflows/release.yaml
vendored
Normal file
72
.github/workflows/release.yaml
vendored
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v*"
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Release
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
permissions:
|
||||||
|
contents: write # write is required to create releases and push.
|
||||||
|
steps:
|
||||||
|
- name: Code checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 16
|
||||||
|
cache: yarn
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: yarn install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: yarn build:production
|
||||||
|
|
||||||
|
- name: Create release branch and bump version
|
||||||
|
env:
|
||||||
|
REF: ${{ github.ref }}
|
||||||
|
run: |
|
||||||
|
BRANCH=release/"${REF:10}"
|
||||||
|
git config --local user.email 'ci@pterodactyl.io'
|
||||||
|
git config --local user.name 'Pterodactyl CI'
|
||||||
|
git checkout -b "$BRANCH"
|
||||||
|
git push -u origin "$BRANCH"
|
||||||
|
sed -i "s/ 'version' => 'canary',/ 'version' => '${REF:11}',/" config/app.php
|
||||||
|
git add config/app.php
|
||||||
|
git commit -m 'ci(release): bump version'
|
||||||
|
git push
|
||||||
|
|
||||||
|
- name: Create release archive
|
||||||
|
run: |
|
||||||
|
rm -rf node_modules tests CODE_OF_CONDUCT.md CONTRIBUTING.md flake.lock flake.nix phpunit.xml shell.nix
|
||||||
|
tar -czf panel.tar.gz * .editorconfig .env.example .eslintignore .eslintrc.js .gitignore .prettierrc.json
|
||||||
|
|
||||||
|
- name: Extract changelog
|
||||||
|
env:
|
||||||
|
REF: ${{ github.ref }}
|
||||||
|
run: |
|
||||||
|
sed -n "/^## ${REF:10}/,/^## /{/^## /b;p}" CHANGELOG.md > ./RELEASE_CHANGELOG
|
||||||
|
|
||||||
|
- name: Create checksum and add to changelog
|
||||||
|
run: |
|
||||||
|
SUM=`sha256sum panel.tar.gz`
|
||||||
|
echo -e "\n#### SHA256 Checksum\n\n\`\`\`\n$SUM\n\`\`\`\n" >> ./RELEASE_CHANGELOG
|
||||||
|
echo "$SUM" > checksum.txt
|
||||||
|
|
||||||
|
- name: Create release
|
||||||
|
id: create_release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
draft: true
|
||||||
|
prerelease: ${{ contains(github.ref, 'rc') || contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
|
||||||
|
body_path: ./RELEASE_CHANGELOG
|
||||||
|
files: |
|
||||||
|
panel.tar.gz
|
||||||
|
checksum.txt
|
||||||
37
.gitignore
vendored
Normal file
37
.gitignore
vendored
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
/vendor
|
||||||
|
*.DS_Store*
|
||||||
|
!.env.ci
|
||||||
|
!.env.example
|
||||||
|
.env*
|
||||||
|
.vagrant/*
|
||||||
|
.vscode/*
|
||||||
|
storage/framework/*
|
||||||
|
/.idea
|
||||||
|
/nbproject
|
||||||
|
/.direnv
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
*.log
|
||||||
|
_ide_helper.php
|
||||||
|
_ide_helper_models.php
|
||||||
|
.phpstorm.meta.php
|
||||||
|
.yarn
|
||||||
|
public/assets/manifest.json
|
||||||
|
|
||||||
|
# For local development with docker
|
||||||
|
# Remove if we ever put the Dockerfile in the repo
|
||||||
|
.dockerignore
|
||||||
|
docker-compose.yml
|
||||||
|
|
||||||
|
# for image related files
|
||||||
|
misc
|
||||||
|
.php-cs-fixer.cache
|
||||||
|
coverage.xml
|
||||||
|
resources/lang/locales.js
|
||||||
|
.phpunit.result.cache
|
||||||
|
|
||||||
|
/public/build
|
||||||
|
/public/hot
|
||||||
|
result
|
||||||
|
docker-compose.yaml
|
||||||
|
release
|
||||||
52
.php-cs-fixer.dist.php
Normal file
52
.php-cs-fixer.dist.php
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use PhpCsFixer\Config;
|
||||||
|
use PhpCsFixer\Finder;
|
||||||
|
|
||||||
|
$finder = (new Finder())
|
||||||
|
->in(__DIR__)
|
||||||
|
->exclude([
|
||||||
|
'vendor',
|
||||||
|
'node_modules',
|
||||||
|
'storage',
|
||||||
|
'bootstrap/cache',
|
||||||
|
])
|
||||||
|
->notName(['_ide_helper*']);
|
||||||
|
|
||||||
|
return (new Config())
|
||||||
|
->setRiskyAllowed(true)
|
||||||
|
->setFinder($finder)
|
||||||
|
->setRules([
|
||||||
|
'@Symfony' => true,
|
||||||
|
'@PSR1' => true,
|
||||||
|
'@PSR2' => true,
|
||||||
|
'@PSR12' => true,
|
||||||
|
'align_multiline_comment' => ['comment_type' => 'phpdocs_like'],
|
||||||
|
'combine_consecutive_unsets' => true,
|
||||||
|
'concat_space' => ['spacing' => 'one'],
|
||||||
|
'heredoc_to_nowdoc' => true,
|
||||||
|
'no_alias_functions' => true,
|
||||||
|
'no_unreachable_default_argument_value' => true,
|
||||||
|
'no_useless_return' => true,
|
||||||
|
'ordered_imports' => [
|
||||||
|
'sort_algorithm' => 'length',
|
||||||
|
],
|
||||||
|
'phpdoc_align' => [
|
||||||
|
'align' => 'left',
|
||||||
|
'tags' => [
|
||||||
|
'param',
|
||||||
|
'property',
|
||||||
|
'return',
|
||||||
|
'throws',
|
||||||
|
'type',
|
||||||
|
'var',
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'random_api_migration' => true,
|
||||||
|
'ternary_to_null_coalescing' => true,
|
||||||
|
'yoda_style' => [
|
||||||
|
'equal' => false,
|
||||||
|
'identical' => false,
|
||||||
|
'less_and_greater' => false,
|
||||||
|
],
|
||||||
|
]);
|
||||||
9
.prettierrc.json
Normal file
9
.prettierrc.json
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"printWidth": 120,
|
||||||
|
"tabWidth": 4,
|
||||||
|
"useTabs": false,
|
||||||
|
"semi": true,
|
||||||
|
"singleQuote": true,
|
||||||
|
"jsxSingleQuote": true,
|
||||||
|
"endOfLine": "lf"
|
||||||
|
}
|
||||||
63
BUILDING.md
Normal file
63
BUILDING.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
# Local Development
|
||||||
|
Pterodactyl is now powered by React, Typescript, and Tailwindcss using webpack at its core to generate compiled assets.
|
||||||
|
Release versions of Pterodactyl will include pre-compiled, minified, and hashed assets ready-to-go.
|
||||||
|
|
||||||
|
However, if you are interested in running custom themes or making modifications to the React files you'll need a build
|
||||||
|
system in place to generate these compiled assets. To get your environment setup you'll need at minimum:
|
||||||
|
|
||||||
|
* [Node.js](https://nodejs.org/en/) v14.x.x
|
||||||
|
* [Yarn](https://classic.yarnpkg.com/lang/en/) v1.x.x
|
||||||
|
* [Go](https://golang.org/) 1.17.x
|
||||||
|
|
||||||
|
### Install Dependencies
|
||||||
|
```bash
|
||||||
|
yarn install
|
||||||
|
```
|
||||||
|
|
||||||
|
The command above will download all of the dependencies necessary to get Pterodactyl assets building. After that, its as
|
||||||
|
simple as running the command below to generate assets while you're developing. Until you've run this command at least
|
||||||
|
once you'll likely see a 500 error on your Panel about a missing `manifest.json` file. This is generated by the commands
|
||||||
|
below.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build the compiled set of assets for development.
|
||||||
|
yarn run build
|
||||||
|
|
||||||
|
# Build the assets automatically as they are changed. This allows you to refresh
|
||||||
|
# the page and see the changes immediately.
|
||||||
|
yarn run watch
|
||||||
|
```
|
||||||
|
|
||||||
|
### Hot Module Reloading
|
||||||
|
For more advanced users, we also support 'Hot Module Reloading', allowing you to quickly see changes you're making
|
||||||
|
to the Vue template files without having to reload the page you're on. To Get started with this, you just need
|
||||||
|
to run the command below.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
PUBLIC_PATH=http://192.168.1.1:8080 yarn run serve --host 192.168.1.1
|
||||||
|
```
|
||||||
|
|
||||||
|
There are two _very important_ parts of this command to take note of and change for your specific environment. The first
|
||||||
|
is the `--host` flag, which is required and should point to the machine where the `webpack-serve` server will be running.
|
||||||
|
The second is the `PUBLIC_PATH` environment variable which is the URL pointing to the HMR server and is appended to all of
|
||||||
|
the asset URLs used in Pterodactyl.
|
||||||
|
|
||||||
|
#### Development Environment
|
||||||
|
If you're using the [`pterodactyl/development`](https://github.com/pterodactyl/development) environments, which are
|
||||||
|
highly recommended, you can just run `yarn run serve` to run the HMR server, no additional configuration is necessary.
|
||||||
|
|
||||||
|
### Building for Production
|
||||||
|
Once you have your files squared away and ready for the live server, you'll be needing to generate compiled, minified,
|
||||||
|
and hashed assets to push live. To do so, run the command below:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn run build:production
|
||||||
|
```
|
||||||
|
|
||||||
|
This will generate a production JS bundle and associated assets, all located in `public/assets/` which will need to
|
||||||
|
be uploaded to your server or CDN for clients to use.
|
||||||
|
|
||||||
|
### Running Wings
|
||||||
|
To run `wings` in development all you need to do is set up the configuration file as normal when adding a new node, and
|
||||||
|
then you can build and run a local version of Wings by executing `make debug` in the Wings code directory. This must
|
||||||
|
be run on a Linux VM of some sort, you cannot run this locally on macOS or Windows.
|
||||||
1823
CHANGELOG.md
Normal file
1823
CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
74
CODE_OF_CONDUCT.md
Normal file
74
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and maintainers pledge to making participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity and
|
||||||
|
orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
|
advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
|
behavior and are expected to take appropriate and fair corrective action in
|
||||||
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces
|
||||||
|
when an individual is representing the project or its community. Examples of
|
||||||
|
representing a project or community include using an official project e-mail
|
||||||
|
address, posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event. Representation of a project may be
|
||||||
|
further defined and clarified by project maintainers.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported by contacting the project team at support@pterodactyl.io. All
|
||||||
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||||
|
faith may face temporary or permanent repercussions as determined by other
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
|
available at [http://contributor-covenant.org/version/1/4][version]
|
||||||
|
|
||||||
|
[homepage]: http://contributor-covenant.org
|
||||||
|
[version]: http://contributor-covenant.org/version/1/4/
|
||||||
31
CONTRIBUTING.md
Normal file
31
CONTRIBUTING.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Pterodactyl does not accept Pull Requests (PRs) _for new functionality_ from users that are not currently part of the
|
||||||
|
core project team. It has become overwhelming to try and give the proper time and attention that such complicated PRs
|
||||||
|
tend to require — and deserve. As a result, it is in the project's best interest to limit the scope of work on
|
||||||
|
new functionality to work done within the core project team.
|
||||||
|
|
||||||
|
PRs that address existing _bugs_ with a corresponding issue opened in our issue tracker will continue to be accepted
|
||||||
|
and reviewed. Their scope is often significantly more targeted, and simply improving upon existing and well defined
|
||||||
|
logic.
|
||||||
|
|
||||||
|
### Responsible Disclosure
|
||||||
|
|
||||||
|
This is a fairly in-depth project and makes use of a lot of parts. We strive to keep everything as secure as possible
|
||||||
|
and welcome you to take a look at the code provided in this project yourself. We do ask that you be considerate of
|
||||||
|
others who are using the software and not publicly disclose security issues without contacting us first by email.
|
||||||
|
|
||||||
|
We'll make a deal with you: if you contact us by email, and we fail to respond to you within a week you are welcome to
|
||||||
|
publicly disclose whatever issue you have found. We understand how frustrating it is when you find something big and
|
||||||
|
no one will respond to you. This holds us to a standard of providing prompt attention to any issues that arise and
|
||||||
|
keeping this community safe.
|
||||||
|
|
||||||
|
If you've found what you believe is a security issue please email `matthew@pterodactyl.io`. Please check
|
||||||
|
[SECURITY.md](/SECURITY.md) for additional details.
|
||||||
|
|
||||||
|
### Contact Us
|
||||||
|
|
||||||
|
You can find us in a couple places online. First and foremost, we're active right here on GitHub. If you encounter a
|
||||||
|
bug or other problems, open an issue on here for us to take a look at it. We also accept feature requests here as well.
|
||||||
|
|
||||||
|
You can also find us on [Discord](https://discord.gg/pterodactyl).
|
||||||
41
Dockerfile
Normal file
41
Dockerfile
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Stage 0:
|
||||||
|
# Build the assets that are needed for the frontend. This build stage is then discarded
|
||||||
|
# since we won't need NodeJS anymore in the future. This Docker image ships a final production
|
||||||
|
# level distribution of Pterodactyl.
|
||||||
|
FROM --platform=$TARGETOS/$TARGETARCH mhart/alpine-node:14
|
||||||
|
WORKDIR /app
|
||||||
|
COPY . ./
|
||||||
|
RUN yarn install --frozen-lockfile \
|
||||||
|
&& yarn run build:production
|
||||||
|
|
||||||
|
# Stage 1:
|
||||||
|
# Build the actual container with all of the needed PHP dependencies that will run the application.
|
||||||
|
FROM --platform=$TARGETOS/$TARGETARCH php:8.2-fpm-alpine
|
||||||
|
WORKDIR /app
|
||||||
|
COPY . ./
|
||||||
|
COPY --from=0 /app/public/assets ./public/assets
|
||||||
|
RUN apk add --no-cache --update ca-certificates dcron curl git supervisor tar unzip nginx libpng-dev libxml2-dev libzip-dev certbot certbot-nginx \
|
||||||
|
&& docker-php-ext-configure zip \
|
||||||
|
&& docker-php-ext-install bcmath gd pdo_mysql zip \
|
||||||
|
&& curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer \
|
||||||
|
&& cp .env.example .env \
|
||||||
|
&& mkdir -p bootstrap/cache/ storage/logs storage/framework/sessions storage/framework/views storage/framework/cache \
|
||||||
|
&& chmod 777 -R bootstrap storage \
|
||||||
|
&& composer install --no-dev --optimize-autoloader \
|
||||||
|
&& rm -rf .env bootstrap/cache/*.php \
|
||||||
|
&& mkdir -p /app/storage/logs/ \
|
||||||
|
&& chown -R nginx:nginx .
|
||||||
|
|
||||||
|
RUN rm /usr/local/etc/php-fpm.conf \
|
||||||
|
&& echo "* * * * * /usr/local/bin/php /app/artisan schedule:run >> /dev/null 2>&1" >> /var/spool/cron/crontabs/root \
|
||||||
|
&& echo "0 23 * * * certbot renew --nginx --quiet" >> /var/spool/cron/crontabs/root \
|
||||||
|
&& sed -i s/ssl_session_cache/#ssl_session_cache/g /etc/nginx/nginx.conf \
|
||||||
|
&& mkdir -p /var/run/php /var/run/nginx
|
||||||
|
|
||||||
|
COPY .github/docker/default.conf /etc/nginx/http.d/default.conf
|
||||||
|
COPY .github/docker/www.conf /usr/local/etc/php-fpm.conf
|
||||||
|
COPY .github/docker/supervisord.conf /etc/supervisord.conf
|
||||||
|
|
||||||
|
EXPOSE 80 443
|
||||||
|
ENTRYPOINT [ "/bin/ash", ".github/docker/entrypoint.sh" ]
|
||||||
|
CMD [ "supervisord", "-n", "-c", "/etc/supervisord.conf" ]
|
||||||
24
LICENSE.md
Normal file
24
LICENSE.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
# The MIT License (MIT)
|
||||||
|
|
||||||
|
```
|
||||||
|
Pterodactyl®
|
||||||
|
Copyright © Dane Everitt <dane@daneeveritt.com> and contributors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
```
|
||||||
674
NookLicense.md
Normal file
674
NookLicense.md
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
173
README.md
Normal file
173
README.md
Normal file
@ -0,0 +1,173 @@
|
|||||||
|
# Nook Theme
|
||||||
|
NookTheme is a free and open source [Pterodactyl theme](https://pterodactyl.io) designed to be simple, clean, and modern.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>View Screenshots</summary>
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
</details>
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
This will update your panel to the latest version of NookTheme panel is based. <br>
|
||||||
|
You can see the version in the current branch name.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Upgrade PHP</summary>
|
||||||
|
|
||||||
|
Before proceeding with the installation steps, ensure that your PHP version is upgraded to 8.2 or newer. Follow the instructions below to upgrade PHP:
|
||||||
|
|
||||||
|
1. Update your package list:
|
||||||
|
```bash
|
||||||
|
sudo apt update
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Install the required dependencies:
|
||||||
|
```bash
|
||||||
|
sudo apt install -y software-properties-common
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Add the PHP repository:
|
||||||
|
```bash
|
||||||
|
sudo add-apt-repository ppa:ondrej/php
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Update your package list again:
|
||||||
|
```bash
|
||||||
|
sudo apt update
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Install PHP 8.3:
|
||||||
|
```bash
|
||||||
|
sudo apt install -y php8.3
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Verify the PHP version:
|
||||||
|
```bash
|
||||||
|
php -v
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### Enter Maintenance Mode
|
||||||
|
|
||||||
|
Whenever you are performing an update you should be sure to place your Panel into maintenance mode. This will prevent
|
||||||
|
users from encountering unexpected errors and ensure everything can be updated before users encounter
|
||||||
|
potentially new features.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /var/www/pterodactyl
|
||||||
|
|
||||||
|
php artisan down
|
||||||
|
```
|
||||||
|
|
||||||
|
### Download the theme
|
||||||
|
|
||||||
|
The first step in the update process is to download the new panel files from GitHub. The command below will download
|
||||||
|
the release archive for the most recent version of Pterodactyl, save it in the current directory and will automatically
|
||||||
|
unpack the archive into your current folder.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L https://github.com/Nookure/NookTheme/releases/latest/download/panel.tar.gz | tar -xzv
|
||||||
|
```
|
||||||
|
|
||||||
|
Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid
|
||||||
|
any webserver related errors.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
chmod -R 755 storage/* bootstrap/cache
|
||||||
|
```
|
||||||
|
|
||||||
|
### Update Dependencies
|
||||||
|
|
||||||
|
After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,
|
||||||
|
simply run the commands below and follow any prompts.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer install --no-dev --optimize-autoloader
|
||||||
|
```
|
||||||
|
|
||||||
|
### Clear Compiled Template Cache
|
||||||
|
|
||||||
|
You'll also want to clear the compiled template cache to ensure that new and modified templates show up correctly for
|
||||||
|
users.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan view:clear
|
||||||
|
php artisan config:clear
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database Updates
|
||||||
|
|
||||||
|
You'll also need to update your database schema for the newest version of Pterodactyl. Running the command below
|
||||||
|
will update the schema and ensure the default eggs we ship are up to date (and add any new ones we might have). Just
|
||||||
|
remember, _never edit core eggs we ship_! They will be overwritten by this update process.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan migrate --seed --force
|
||||||
|
```
|
||||||
|
|
||||||
|
### Set Permissions
|
||||||
|
|
||||||
|
The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this
|
||||||
|
is `www-data` but can vary from system to system — sometimes being `nginx`, `caddy`, `apache`, or even `nobody`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# If using NGINX or Apache (not on CentOS):
|
||||||
|
chown -R www-data:www-data /var/www/pterodactyl/*
|
||||||
|
|
||||||
|
# If using NGINX on CentOS:
|
||||||
|
chown -R nginx:nginx /var/www/pterodactyl/*
|
||||||
|
|
||||||
|
# If using Apache on CentOS
|
||||||
|
chown -R apache:apache /var/www/pterodactyl/*
|
||||||
|
```
|
||||||
|
|
||||||
|
### Restarting Queue Workers
|
||||||
|
|
||||||
|
After _every_ update you should restart the queue worker to ensure that the new code is loaded in and used.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan queue:restart
|
||||||
|
```
|
||||||
|
|
||||||
|
### Exit Maintenance Mode
|
||||||
|
|
||||||
|
Now that everything has been updated you need to exit maintenance mode so that the Panel can resume accepting
|
||||||
|
connections.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan up
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
* [Panel Documentation](https://pterodactyl.io/panel/1.0/getting_started.html)
|
||||||
|
* [Wings Documentation](https://pterodactyl.io/wings/1.0/installing.html)
|
||||||
|
* [Community Guides](https://pterodactyl.io/community/about.html)
|
||||||
|
* Or, get additional help [via Discord](https://discord.nookure.com/)
|
||||||
|
|
||||||
|
## Star History
|
||||||
|
|
||||||
|
<a href="https://star-history.com/#Nookure/NookTheme&Timeline">
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Nookure/NookTheme&type=Timeline&theme=dark" />
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Nookure/NookTheme&type=Timeline" />
|
||||||
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Nookure/NookTheme&type=Timeline" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Pterodactyl® Copyright © 2015 - 2023 Dane Everitt and contributors.
|
||||||
|
|
||||||
|
> Nookure is not affiliated with Pterodactyl® Panel or its contributors.
|
||||||
|
|
||||||
|
Pterodactyl code released under the [MIT License](./LICENSE.md).
|
||||||
|
|
||||||
|
NookTheme code edits released under the [GNU GPLv3 License](./NookLicense.md).
|
||||||
19
SECURITY.md
Normal file
19
SECURITY.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
The following versions of Pterodactyl are receiving active support and maintenance. Any security vulnerabilities discovered must be reproducible in supported versions.
|
||||||
|
|
||||||
|
| Panel | Daemon | Supported |
|
||||||
|
|--------|--------------|--------------------|
|
||||||
|
| 1.11.x | wings@1.11.x | :white_check_mark: |
|
||||||
|
| 0.7.x | daemon@0.6.x | :x: |
|
||||||
|
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Please reach out directly to any project team member on Discord when reporting a security vulnerability, or you can email `matthew@pterodactyl.io`.
|
||||||
|
|
||||||
|
We make every effort to respond as soon as possible, although it may take a day or two for us to sync internally and determine the severity of the report and its impact. Please, _do not_ use a public facing channel or GitHub issues to report sensitive security issues.
|
||||||
|
|
||||||
|
As part of our process, we will create a security advisory for the affected versions and disclose it publicly, usually two to four weeks after a releasing a version that addresses it.
|
||||||
183
app/Console/Commands/Environment/AppSettingsCommand.php
Normal file
183
app/Console/Commands/Environment/AppSettingsCommand.php
Normal file
@ -0,0 +1,183 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Environment;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Console\Kernel;
|
||||||
|
use Pterodactyl\Traits\Commands\EnvironmentWriterTrait;
|
||||||
|
|
||||||
|
class AppSettingsCommand extends Command
|
||||||
|
{
|
||||||
|
use EnvironmentWriterTrait;
|
||||||
|
|
||||||
|
public const CACHE_DRIVERS = [
|
||||||
|
'redis' => 'Redis (recommended)',
|
||||||
|
'memcached' => 'Memcached',
|
||||||
|
'file' => 'Filesystem',
|
||||||
|
];
|
||||||
|
|
||||||
|
public const SESSION_DRIVERS = [
|
||||||
|
'redis' => 'Redis (recommended)',
|
||||||
|
'memcached' => 'Memcached',
|
||||||
|
'database' => 'MySQL Database',
|
||||||
|
'file' => 'Filesystem',
|
||||||
|
'cookie' => 'Cookie',
|
||||||
|
];
|
||||||
|
|
||||||
|
public const QUEUE_DRIVERS = [
|
||||||
|
'redis' => 'Redis (recommended)',
|
||||||
|
'database' => 'MySQL Database',
|
||||||
|
'sync' => 'Sync',
|
||||||
|
];
|
||||||
|
|
||||||
|
protected $description = 'Configure basic environment settings for the Panel.';
|
||||||
|
|
||||||
|
protected $signature = 'p:environment:setup
|
||||||
|
{--new-salt : Whether or not to generate a new salt for Hashids.}
|
||||||
|
{--author= : The email that services created on this instance should be linked to.}
|
||||||
|
{--url= : The URL that this Panel is running on.}
|
||||||
|
{--timezone= : The timezone to use for Panel times.}
|
||||||
|
{--cache= : The cache driver backend to use.}
|
||||||
|
{--session= : The session driver backend to use.}
|
||||||
|
{--queue= : The queue driver backend to use.}
|
||||||
|
{--redis-host= : Redis host to use for connections.}
|
||||||
|
{--redis-pass= : Password used to connect to redis.}
|
||||||
|
{--redis-port= : Port to connect to redis over.}
|
||||||
|
{--settings-ui= : Enable or disable the settings UI.}
|
||||||
|
{--telemetry= : Enable or disable anonymous telemetry.}';
|
||||||
|
|
||||||
|
protected array $variables = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AppSettingsCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private Kernel $console)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\PterodactylException
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
if (empty(config('hashids.salt')) || $this->option('new-salt')) {
|
||||||
|
$this->variables['HASHIDS_SALT'] = str_random(20);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->comment('Provide the email address that eggs exported by this Panel should be from. This should be a valid email address.');
|
||||||
|
$this->variables['APP_SERVICE_AUTHOR'] = $this->option('author') ?? $this->ask(
|
||||||
|
'Egg Author Email',
|
||||||
|
config('pterodactyl.service.author', 'unknown@unknown.com')
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!filter_var($this->variables['APP_SERVICE_AUTHOR'], FILTER_VALIDATE_EMAIL)) {
|
||||||
|
$this->output->error('The service author email provided is invalid.');
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->comment('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.');
|
||||||
|
$this->variables['APP_URL'] = $this->option('url') ?? $this->ask(
|
||||||
|
'Application URL',
|
||||||
|
config('app.url', 'https://example.com')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->output->comment('The timezone should match one of PHP\'s supported timezones. If you are unsure, please reference https://php.net/manual/en/timezones.php.');
|
||||||
|
$this->variables['APP_TIMEZONE'] = $this->option('timezone') ?? $this->anticipate(
|
||||||
|
'Application Timezone',
|
||||||
|
\DateTimeZone::listIdentifiers(),
|
||||||
|
config('app.timezone')
|
||||||
|
);
|
||||||
|
|
||||||
|
$selected = config('cache.default', 'redis');
|
||||||
|
$this->variables['CACHE_DRIVER'] = $this->option('cache') ?? $this->choice(
|
||||||
|
'Cache Driver',
|
||||||
|
self::CACHE_DRIVERS,
|
||||||
|
array_key_exists($selected, self::CACHE_DRIVERS) ? $selected : null
|
||||||
|
);
|
||||||
|
|
||||||
|
$selected = config('session.driver', 'redis');
|
||||||
|
$this->variables['SESSION_DRIVER'] = $this->option('session') ?? $this->choice(
|
||||||
|
'Session Driver',
|
||||||
|
self::SESSION_DRIVERS,
|
||||||
|
array_key_exists($selected, self::SESSION_DRIVERS) ? $selected : null
|
||||||
|
);
|
||||||
|
|
||||||
|
$selected = config('queue.default', 'redis');
|
||||||
|
$this->variables['QUEUE_CONNECTION'] = $this->option('queue') ?? $this->choice(
|
||||||
|
'Queue Driver',
|
||||||
|
self::QUEUE_DRIVERS,
|
||||||
|
array_key_exists($selected, self::QUEUE_DRIVERS) ? $selected : null
|
||||||
|
);
|
||||||
|
|
||||||
|
if (!is_null($this->option('settings-ui'))) {
|
||||||
|
$this->variables['APP_ENVIRONMENT_ONLY'] = $this->option('settings-ui') == 'true' ? 'false' : 'true';
|
||||||
|
} else {
|
||||||
|
$this->variables['APP_ENVIRONMENT_ONLY'] = $this->confirm('Enable UI based settings editor?', true) ? 'false' : 'true';
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->comment('Please reference https://pterodactyl.io/panel/1.0/additional_configuration.html#telemetry for more detailed information regarding telemetry data and collection.');
|
||||||
|
$this->variables['PTERODACTYL_TELEMETRY_ENABLED'] = $this->option('telemetry') ?? $this->confirm(
|
||||||
|
'Enable sending anonymous telemetry data?',
|
||||||
|
config('pterodactyl.telemetry.enabled', true)
|
||||||
|
) ? 'true' : 'false';
|
||||||
|
|
||||||
|
// Make sure session cookies are set as "secure" when using HTTPS
|
||||||
|
if (str_starts_with($this->variables['APP_URL'], 'https://')) {
|
||||||
|
$this->variables['SESSION_SECURE_COOKIE'] = 'true';
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->checkForRedis();
|
||||||
|
$this->writeToEnvironment($this->variables);
|
||||||
|
|
||||||
|
$this->info($this->console->output());
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if redis is selected, if so, request connection details and verify them.
|
||||||
|
*/
|
||||||
|
private function checkForRedis()
|
||||||
|
{
|
||||||
|
$items = collect($this->variables)->filter(function ($item) {
|
||||||
|
return $item === 'redis';
|
||||||
|
});
|
||||||
|
|
||||||
|
// Redis was not selected, no need to continue.
|
||||||
|
if (count($items) === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->note('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.');
|
||||||
|
$this->variables['REDIS_HOST'] = $this->option('redis-host') ?? $this->ask(
|
||||||
|
'Redis Host',
|
||||||
|
config('database.redis.default.host')
|
||||||
|
);
|
||||||
|
|
||||||
|
$askForRedisPassword = true;
|
||||||
|
if (!empty(config('database.redis.default.password'))) {
|
||||||
|
$this->variables['REDIS_PASSWORD'] = config('database.redis.default.password');
|
||||||
|
$askForRedisPassword = $this->confirm('It seems a password is already defined for Redis, would you like to change it?');
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($askForRedisPassword) {
|
||||||
|
$this->output->comment('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.');
|
||||||
|
$this->variables['REDIS_PASSWORD'] = $this->option('redis-pass') ?? $this->output->askHidden(
|
||||||
|
'Redis Password'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (empty($this->variables['REDIS_PASSWORD'])) {
|
||||||
|
$this->variables['REDIS_PASSWORD'] = 'null';
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->variables['REDIS_PORT'] = $this->option('redis-port') ?? $this->ask(
|
||||||
|
'Redis Port',
|
||||||
|
config('database.redis.default.port')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
113
app/Console/Commands/Environment/DatabaseSettingsCommand.php
Normal file
113
app/Console/Commands/Environment/DatabaseSettingsCommand.php
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Environment;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Console\Kernel;
|
||||||
|
use Illuminate\Database\DatabaseManager;
|
||||||
|
use Pterodactyl\Traits\Commands\EnvironmentWriterTrait;
|
||||||
|
|
||||||
|
class DatabaseSettingsCommand extends Command
|
||||||
|
{
|
||||||
|
use EnvironmentWriterTrait;
|
||||||
|
|
||||||
|
protected $description = 'Configure database settings for the Panel.';
|
||||||
|
|
||||||
|
protected $signature = 'p:environment:database
|
||||||
|
{--host= : The connection address for the MySQL server.}
|
||||||
|
{--port= : The connection port for the MySQL server.}
|
||||||
|
{--database= : The database to use.}
|
||||||
|
{--username= : Username to use when connecting.}
|
||||||
|
{--password= : Password to use for this database.}';
|
||||||
|
|
||||||
|
protected array $variables = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DatabaseSettingsCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private DatabaseManager $database, private Kernel $console)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\PterodactylException
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$this->output->note('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".');
|
||||||
|
$this->variables['DB_HOST'] = $this->option('host') ?? $this->ask(
|
||||||
|
'Database Host',
|
||||||
|
config('database.connections.mysql.host', '127.0.0.1')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['DB_PORT'] = $this->option('port') ?? $this->ask(
|
||||||
|
'Database Port',
|
||||||
|
config('database.connections.mysql.port', 3306)
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['DB_DATABASE'] = $this->option('database') ?? $this->ask(
|
||||||
|
'Database Name',
|
||||||
|
config('database.connections.mysql.database', 'panel')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->output->note('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.');
|
||||||
|
$this->variables['DB_USERNAME'] = $this->option('username') ?? $this->ask(
|
||||||
|
'Database Username',
|
||||||
|
config('database.connections.mysql.username', 'pterodactyl')
|
||||||
|
);
|
||||||
|
|
||||||
|
$askForMySQLPassword = true;
|
||||||
|
if (!empty(config('database.connections.mysql.password')) && $this->input->isInteractive()) {
|
||||||
|
$this->variables['DB_PASSWORD'] = config('database.connections.mysql.password');
|
||||||
|
$askForMySQLPassword = $this->confirm('It appears you already have a MySQL connection password defined, would you like to change it?');
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($askForMySQLPassword) {
|
||||||
|
$this->variables['DB_PASSWORD'] = $this->option('password') ?? $this->secret('Database Password');
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->testMySQLConnection();
|
||||||
|
} catch (\PDOException $exception) {
|
||||||
|
$this->output->error(sprintf('Unable to connect to the MySQL server using the provided credentials. The error returned was "%s".', $exception->getMessage()));
|
||||||
|
$this->output->error('Your connection credentials have NOT been saved. You will need to provide valid connection information before proceeding.');
|
||||||
|
|
||||||
|
if ($this->confirm('Go back and try again?')) {
|
||||||
|
$this->database->disconnect('_pterodactyl_command_test');
|
||||||
|
|
||||||
|
return $this->handle();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->writeToEnvironment($this->variables);
|
||||||
|
|
||||||
|
$this->info($this->console->output());
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test that we can connect to the provided MySQL instance and perform a selection.
|
||||||
|
*/
|
||||||
|
private function testMySQLConnection()
|
||||||
|
{
|
||||||
|
config()->set('database.connections._pterodactyl_command_test', [
|
||||||
|
'driver' => 'mysql',
|
||||||
|
'host' => $this->variables['DB_HOST'],
|
||||||
|
'port' => $this->variables['DB_PORT'],
|
||||||
|
'database' => $this->variables['DB_DATABASE'],
|
||||||
|
'username' => $this->variables['DB_USERNAME'],
|
||||||
|
'password' => $this->variables['DB_PASSWORD'],
|
||||||
|
'charset' => 'utf8mb4',
|
||||||
|
'collation' => 'utf8mb4_unicode_ci',
|
||||||
|
'strict' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->database->connection('_pterodactyl_command_test')->getPdo();
|
||||||
|
}
|
||||||
|
}
|
||||||
152
app/Console/Commands/Environment/EmailSettingsCommand.php
Normal file
152
app/Console/Commands/Environment/EmailSettingsCommand.php
Normal file
@ -0,0 +1,152 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Environment;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Traits\Commands\EnvironmentWriterTrait;
|
||||||
|
use Illuminate\Contracts\Config\Repository as ConfigRepository;
|
||||||
|
|
||||||
|
class EmailSettingsCommand extends Command
|
||||||
|
{
|
||||||
|
use EnvironmentWriterTrait;
|
||||||
|
|
||||||
|
protected $description = 'Set or update the email sending configuration for the Panel.';
|
||||||
|
|
||||||
|
protected $signature = 'p:environment:mail
|
||||||
|
{--driver= : The mail driver to use.}
|
||||||
|
{--email= : Email address that messages from the Panel will originate from.}
|
||||||
|
{--from= : The name emails from the Panel will appear to be from.}
|
||||||
|
{--encryption=}
|
||||||
|
{--host=}
|
||||||
|
{--port=}
|
||||||
|
{--endpoint=}
|
||||||
|
{--username=}
|
||||||
|
{--password=}';
|
||||||
|
|
||||||
|
protected array $variables = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* EmailSettingsCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private ConfigRepository $config)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\PterodactylException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$this->variables['MAIL_DRIVER'] = $this->option('driver') ?? $this->choice(
|
||||||
|
trans('command/messages.environment.mail.ask_driver'),
|
||||||
|
[
|
||||||
|
'smtp' => 'SMTP Server',
|
||||||
|
'sendmail' => 'sendmail Binary',
|
||||||
|
'mailgun' => 'Mailgun Transactional Email',
|
||||||
|
'mandrill' => 'Mandrill Transactional Email',
|
||||||
|
'postmark' => 'Postmark Transactional Email',
|
||||||
|
],
|
||||||
|
$this->config->get('mail.default', 'smtp')
|
||||||
|
);
|
||||||
|
|
||||||
|
$method = 'setup' . studly_case($this->variables['MAIL_DRIVER']) . 'DriverVariables';
|
||||||
|
if (method_exists($this, $method)) {
|
||||||
|
$this->{$method}();
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->variables['MAIL_FROM_ADDRESS'] = $this->option('email') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mail_from'),
|
||||||
|
$this->config->get('mail.from.address')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAIL_FROM_NAME'] = $this->option('from') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mail_name'),
|
||||||
|
$this->config->get('mail.from.name')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->writeToEnvironment($this->variables);
|
||||||
|
|
||||||
|
$this->line('Updating stored environment configuration file.');
|
||||||
|
$this->line('');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle variables for SMTP driver.
|
||||||
|
*/
|
||||||
|
private function setupSmtpDriverVariables()
|
||||||
|
{
|
||||||
|
$this->variables['MAIL_HOST'] = $this->option('host') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_smtp_host'),
|
||||||
|
$this->config->get('mail.mailers.smtp.host')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAIL_PORT'] = $this->option('port') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_smtp_port'),
|
||||||
|
$this->config->get('mail.mailers.smtp.port')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAIL_USERNAME'] = $this->option('username') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_smtp_username'),
|
||||||
|
$this->config->get('mail.mailers.smtp.username')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAIL_PASSWORD'] = $this->option('password') ?? $this->secret(
|
||||||
|
trans('command/messages.environment.mail.ask_smtp_password')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAIL_ENCRYPTION'] = $this->option('encryption') ?? $this->choice(
|
||||||
|
trans('command/messages.environment.mail.ask_encryption'),
|
||||||
|
['tls' => 'TLS', 'ssl' => 'SSL', '' => 'None'],
|
||||||
|
$this->config->get('mail.mailers.smtp.encryption', 'tls')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle variables for mailgun driver.
|
||||||
|
*/
|
||||||
|
private function setupMailgunDriverVariables()
|
||||||
|
{
|
||||||
|
$this->variables['MAILGUN_DOMAIN'] = $this->option('host') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mailgun_domain'),
|
||||||
|
$this->config->get('services.mailgun.domain')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAILGUN_SECRET'] = $this->option('password') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mailgun_secret'),
|
||||||
|
$this->config->get('services.mailgun.secret')
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->variables['MAILGUN_ENDPOINT'] = $this->option('endpoint') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mailgun_endpoint'),
|
||||||
|
$this->config->get('services.mailgun.endpoint')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle variables for mandrill driver.
|
||||||
|
*/
|
||||||
|
private function setupMandrillDriverVariables()
|
||||||
|
{
|
||||||
|
$this->variables['MANDRILL_SECRET'] = $this->option('password') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_mandrill_secret'),
|
||||||
|
$this->config->get('services.mandrill.secret')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle variables for postmark driver.
|
||||||
|
*/
|
||||||
|
private function setupPostmarkDriverVariables()
|
||||||
|
{
|
||||||
|
$this->variables['MAIL_DRIVER'] = 'smtp';
|
||||||
|
$this->variables['MAIL_HOST'] = 'smtp.postmarkapp.com';
|
||||||
|
$this->variables['MAIL_PORT'] = 587;
|
||||||
|
$this->variables['MAIL_USERNAME'] = $this->variables['MAIL_PASSWORD'] = $this->option('username') ?? $this->ask(
|
||||||
|
trans('command/messages.environment.mail.ask_postmark_username'),
|
||||||
|
$this->config->get('mail.username')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
81
app/Console/Commands/InfoCommand.php
Normal file
81
app/Console/Commands/InfoCommand.php
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Services\Helpers\SoftwareVersionService;
|
||||||
|
use Illuminate\Contracts\Config\Repository as ConfigRepository;
|
||||||
|
|
||||||
|
class InfoCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Displays the application, database, and email configurations along with the panel version.';
|
||||||
|
|
||||||
|
protected $signature = 'p:info';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* VersionCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private ConfigRepository $config, private SoftwareVersionService $versionService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle execution of command.
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$this->output->title('Version Information');
|
||||||
|
$this->table([], [
|
||||||
|
['Panel Version', $this->config->get('app.version')],
|
||||||
|
['Latest Version', $this->versionService->getPanel()],
|
||||||
|
['Up-to-Date', $this->versionService->isLatestPanel() ? 'Yes' : $this->formatText('No', 'bg=red')],
|
||||||
|
['Unique Identifier', $this->config->get('pterodactyl.service.author')],
|
||||||
|
], 'compact');
|
||||||
|
|
||||||
|
$this->output->title('Application Configuration');
|
||||||
|
$this->table([], [
|
||||||
|
['Environment', $this->formatText($this->config->get('app.env'), $this->config->get('app.env') === 'production' ?: 'bg=red')],
|
||||||
|
['Debug Mode', $this->formatText($this->config->get('app.debug') ? 'Yes' : 'No', !$this->config->get('app.debug') ?: 'bg=red')],
|
||||||
|
['Installation URL', $this->config->get('app.url')],
|
||||||
|
['Installation Directory', base_path()],
|
||||||
|
['Timezone', $this->config->get('app.timezone')],
|
||||||
|
['Cache Driver', $this->config->get('cache.default')],
|
||||||
|
['Queue Driver', $this->config->get('queue.default')],
|
||||||
|
['Session Driver', $this->config->get('session.driver')],
|
||||||
|
['Filesystem Driver', $this->config->get('filesystems.default')],
|
||||||
|
['Default Theme', $this->config->get('themes.active')],
|
||||||
|
['Proxies', $this->config->get('trustedproxies.proxies')],
|
||||||
|
], 'compact');
|
||||||
|
|
||||||
|
$this->output->title('Database Configuration');
|
||||||
|
$driver = $this->config->get('database.default');
|
||||||
|
$this->table([], [
|
||||||
|
['Driver', $driver],
|
||||||
|
['Host', $this->config->get("database.connections.$driver.host")],
|
||||||
|
['Port', $this->config->get("database.connections.$driver.port")],
|
||||||
|
['Database', $this->config->get("database.connections.$driver.database")],
|
||||||
|
['Username', $this->config->get("database.connections.$driver.username")],
|
||||||
|
], 'compact');
|
||||||
|
|
||||||
|
// TODO: Update this to handle other mail drivers
|
||||||
|
$this->output->title('Email Configuration');
|
||||||
|
$this->table([], [
|
||||||
|
['Driver', $this->config->get('mail.default')],
|
||||||
|
['Host', $this->config->get('mail.mailers.smtp.host')],
|
||||||
|
['Port', $this->config->get('mail.mailers.smtp.port')],
|
||||||
|
['Username', $this->config->get('mail.mailers.smtp.username')],
|
||||||
|
['From Address', $this->config->get('mail.from.address')],
|
||||||
|
['From Name', $this->config->get('mail.from.name')],
|
||||||
|
['Encryption', $this->config->get('mail.mailers.smtp.encryption')],
|
||||||
|
], 'compact');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format output in a Name: Value manner.
|
||||||
|
*/
|
||||||
|
private function formatText(string $value, string $opts = ''): string
|
||||||
|
{
|
||||||
|
return sprintf('<%s>%s</>', $opts, $value);
|
||||||
|
}
|
||||||
|
}
|
||||||
55
app/Console/Commands/Location/DeleteLocationCommand.php
Normal file
55
app/Console/Commands/Location/DeleteLocationCommand.php
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Location;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Pterodactyl\Services\Locations\LocationDeletionService;
|
||||||
|
use Pterodactyl\Contracts\Repository\LocationRepositoryInterface;
|
||||||
|
|
||||||
|
class DeleteLocationCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Deletes a location from the Panel.';
|
||||||
|
|
||||||
|
protected $signature = 'p:location:delete {--short= : The short code of the location to delete.}';
|
||||||
|
|
||||||
|
protected Collection $locations;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DeleteLocationCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
private LocationDeletionService $deletionService,
|
||||||
|
private LocationRepositoryInterface $repository
|
||||||
|
) {
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Respond to the command request.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Service\Location\HasActiveNodesException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$this->locations = $this->locations ?? $this->repository->all();
|
||||||
|
$short = $this->option('short') ?? $this->anticipate(
|
||||||
|
trans('command/messages.location.ask_short'),
|
||||||
|
$this->locations->pluck('short')->toArray()
|
||||||
|
);
|
||||||
|
|
||||||
|
$location = $this->locations->where('short', $short)->first();
|
||||||
|
if (is_null($location)) {
|
||||||
|
$this->error(trans('command/messages.location.no_location_found'));
|
||||||
|
if ($this->input->isInteractive()) {
|
||||||
|
$this->handle();
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->deletionService->handle($location->id);
|
||||||
|
$this->line(trans('command/messages.location.deleted'));
|
||||||
|
}
|
||||||
|
}
|
||||||
40
app/Console/Commands/Location/MakeLocationCommand.php
Normal file
40
app/Console/Commands/Location/MakeLocationCommand.php
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Location;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Services\Locations\LocationCreationService;
|
||||||
|
|
||||||
|
class MakeLocationCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:location:make
|
||||||
|
{--short= : The shortcode name of this location (ex. us1).}
|
||||||
|
{--long= : A longer description of this location.}';
|
||||||
|
|
||||||
|
protected $description = 'Creates a new location on the system via the CLI.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new command instance.
|
||||||
|
*/
|
||||||
|
public function __construct(private LocationCreationService $creationService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the command execution process.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$short = $this->option('short') ?? $this->ask(trans('command/messages.location.ask_short'));
|
||||||
|
$long = $this->option('long') ?? $this->ask(trans('command/messages.location.ask_long'));
|
||||||
|
|
||||||
|
$location = $this->creationService->handle(compact('short', 'long'));
|
||||||
|
$this->line(trans('command/messages.location.created', [
|
||||||
|
'name' => $location->short,
|
||||||
|
'id' => $location->id,
|
||||||
|
]));
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Maintenance;
|
||||||
|
|
||||||
|
use Carbon\Carbon;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Filesystem\Filesystem;
|
||||||
|
use Illuminate\Contracts\Filesystem\Factory as FilesystemFactory;
|
||||||
|
|
||||||
|
class CleanServiceBackupFilesCommand extends Command
|
||||||
|
{
|
||||||
|
public const BACKUP_THRESHOLD_MINUTES = 5;
|
||||||
|
|
||||||
|
protected $description = 'Clean orphaned .bak files created when modifying services.';
|
||||||
|
|
||||||
|
protected $signature = 'p:maintenance:clean-service-backups';
|
||||||
|
|
||||||
|
protected Filesystem $disk;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CleanServiceBackupFilesCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(FilesystemFactory $filesystem)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
|
||||||
|
$this->disk = $filesystem->disk();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution.
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$files = $this->disk->files('services/.bak');
|
||||||
|
|
||||||
|
collect($files)->each(function (\SplFileInfo $file) {
|
||||||
|
$lastModified = Carbon::createFromTimestamp($this->disk->lastModified($file->getPath()));
|
||||||
|
if ($lastModified->diffInMinutes(Carbon::now()) > self::BACKUP_THRESHOLD_MINUTES) {
|
||||||
|
$this->disk->delete($file->getPath());
|
||||||
|
$this->info(trans('command/messages.maintenance.deleting_service_backup', ['file' => $file->getFilename()]));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Maintenance;
|
||||||
|
|
||||||
|
use Carbon\CarbonImmutable;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Repositories\Eloquent\BackupRepository;
|
||||||
|
|
||||||
|
class PruneOrphanedBackupsCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:maintenance:prune-backups {--prune-age=}';
|
||||||
|
|
||||||
|
protected $description = 'Marks all backups older than "n" minutes that have not yet completed as being failed.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PruneOrphanedBackupsCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private BackupRepository $backupRepository)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$since = $this->option('prune-age') ?? config('backups.prune_age', 360);
|
||||||
|
if (!$since || !is_digit($since)) {
|
||||||
|
throw new \InvalidArgumentException('The "--prune-age" argument must be a value greater than 0.');
|
||||||
|
}
|
||||||
|
|
||||||
|
$query = $this->backupRepository->getBuilder()
|
||||||
|
->whereNull('completed_at')
|
||||||
|
->where('created_at', '<=', CarbonImmutable::now()->subMinutes($since)->toDateTimeString());
|
||||||
|
|
||||||
|
$count = $query->count();
|
||||||
|
if (!$count) {
|
||||||
|
$this->info('There are no orphaned backups to be marked as failed.');
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->warn("Marking $count uncompleted backups that are older than $since minutes as failed.");
|
||||||
|
|
||||||
|
$query->update([
|
||||||
|
'is_successful' => false,
|
||||||
|
'completed_at' => CarbonImmutable::now(),
|
||||||
|
'updated_at' => CarbonImmutable::now(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
69
app/Console/Commands/Node/MakeNodeCommand.php
Normal file
69
app/Console/Commands/Node/MakeNodeCommand.php
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Node;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Services\Nodes\NodeCreationService;
|
||||||
|
|
||||||
|
class MakeNodeCommand extends Command
|
||||||
|
{
|
||||||
|
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.}';
|
||||||
|
|
||||||
|
protected $description = 'Creates a new node on the system via the CLI.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MakeNodeCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private NodeCreationService $creationService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the command execution process.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$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['scheme'] = $this->option('scheme') ?? $this->anticipate(
|
||||||
|
'Please either enter https for SSL or http for a non-ssl connection',
|
||||||
|
['https', 'http'],
|
||||||
|
'https'
|
||||||
|
);
|
||||||
|
$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');
|
||||||
|
$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['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 . '.');
|
||||||
|
}
|
||||||
|
}
|
||||||
44
app/Console/Commands/Node/NodeConfigurationCommand.php
Normal file
44
app/Console/Commands/Node/NodeConfigurationCommand.php
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Node;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Node;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
|
||||||
|
class NodeConfigurationCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:node:configuration
|
||||||
|
{node : The ID or UUID of the node to return the configuration for.}
|
||||||
|
{--format=yaml : The output format. Options are "yaml" and "json".}';
|
||||||
|
|
||||||
|
protected $description = 'Displays the configuration for the specified node.';
|
||||||
|
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$column = ctype_digit((string) $this->argument('node')) ? 'id' : 'uuid';
|
||||||
|
|
||||||
|
/** @var \Pterodactyl\Models\Node $node */
|
||||||
|
$node = Node::query()->where($column, $this->argument('node'))->firstOr(function () {
|
||||||
|
$this->error('The selected node does not exist.');
|
||||||
|
|
||||||
|
exit(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
$format = $this->option('format');
|
||||||
|
if (!in_array($format, ['yaml', 'yml', 'json'])) {
|
||||||
|
$this->error('Invalid format specified. Valid options are "yaml" and "json".');
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($format === 'json') {
|
||||||
|
$this->output->write($node->getJsonConfiguration(true));
|
||||||
|
} else {
|
||||||
|
$this->output->write($node->getYamlConfiguration());
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->newLine();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
34
app/Console/Commands/Node/NodeListCommand.php
Normal file
34
app/Console/Commands/Node/NodeListCommand.php
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Node;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Node;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
|
||||||
|
class NodeListCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:node:list {--format=text : The output format: "text" or "json". }';
|
||||||
|
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$nodes = Node::query()->with('location')->get()->map(function (Node $node) {
|
||||||
|
return [
|
||||||
|
'id' => $node->id,
|
||||||
|
'uuid' => $node->uuid,
|
||||||
|
'name' => $node->name,
|
||||||
|
'location' => $node->location->short,
|
||||||
|
'host' => $node->getConnectionAddress(),
|
||||||
|
];
|
||||||
|
});
|
||||||
|
|
||||||
|
if ($this->option('format') === 'json') {
|
||||||
|
$this->output->write($nodes->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
|
||||||
|
} else {
|
||||||
|
$this->table(['ID', 'UUID', 'Name', 'Location', 'Host'], $nodes->toArray());
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->output->newLine();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
28
app/Console/Commands/Overrides/KeyGenerateCommand.php
Normal file
28
app/Console/Commands/Overrides/KeyGenerateCommand.php
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Overrides;
|
||||||
|
|
||||||
|
use Illuminate\Foundation\Console\KeyGenerateCommand as BaseKeyGenerateCommand;
|
||||||
|
|
||||||
|
class KeyGenerateCommand extends BaseKeyGenerateCommand
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Override the default Laravel key generation command to throw a warning to the user
|
||||||
|
* if it appears that they have already generated an application encryption key.
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
if (!empty(config('app.key')) && $this->input->isInteractive()) {
|
||||||
|
$this->output->warning('It appears you have already configured an application encryption key. Continuing with this process with overwrite that key and cause data corruption for any existing encrypted data. DO NOT CONTINUE UNLESS YOU KNOW WHAT YOU ARE DOING.');
|
||||||
|
if (!$this->confirm('I understand the consequences of performing this command and accept all responsibility for the loss of encrypted data.')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$this->confirm('Are you sure you wish to continue? Changing the application encryption key WILL CAUSE DATA LOSS.')) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
parent::handle();
|
||||||
|
}
|
||||||
|
}
|
||||||
26
app/Console/Commands/Overrides/SeedCommand.php
Normal file
26
app/Console/Commands/Overrides/SeedCommand.php
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Overrides;
|
||||||
|
|
||||||
|
use Pterodactyl\Console\RequiresDatabaseMigrations;
|
||||||
|
use Illuminate\Database\Console\Seeds\SeedCommand as BaseSeedCommand;
|
||||||
|
|
||||||
|
class SeedCommand extends BaseSeedCommand
|
||||||
|
{
|
||||||
|
use RequiresDatabaseMigrations;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Block someone from running this seed command if they have not completed
|
||||||
|
* the migration process.
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
if (!$this->hasCompletedMigrations()) {
|
||||||
|
$this->showMigrationWarning();
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parent::handle();
|
||||||
|
}
|
||||||
|
}
|
||||||
26
app/Console/Commands/Overrides/UpCommand.php
Normal file
26
app/Console/Commands/Overrides/UpCommand.php
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Overrides;
|
||||||
|
|
||||||
|
use Pterodactyl\Console\RequiresDatabaseMigrations;
|
||||||
|
use Illuminate\Foundation\Console\UpCommand as BaseUpCommand;
|
||||||
|
|
||||||
|
class UpCommand extends BaseUpCommand
|
||||||
|
{
|
||||||
|
use RequiresDatabaseMigrations;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Block someone from running this up command if they have not completed
|
||||||
|
* the migration process.
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
if (!$this->hasCompletedMigrations()) {
|
||||||
|
$this->showMigrationWarning();
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parent::handle() ?? 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
76
app/Console/Commands/Schedule/ProcessRunnableCommand.php
Normal file
76
app/Console/Commands/Schedule/ProcessRunnableCommand.php
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Schedule;
|
||||||
|
|
||||||
|
use Exception;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Models\Schedule;
|
||||||
|
use Illuminate\Support\Facades\Log;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Pterodactyl\Services\Schedules\ProcessScheduleService;
|
||||||
|
|
||||||
|
class ProcessRunnableCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:schedule:process';
|
||||||
|
|
||||||
|
protected $description = 'Process schedules in the database and determine which are ready to run.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution.
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$schedules = Schedule::query()
|
||||||
|
->with('tasks')
|
||||||
|
->whereRelation('server', fn (Builder $builder) => $builder->whereNull('status'))
|
||||||
|
->where('is_active', true)
|
||||||
|
->where('is_processing', false)
|
||||||
|
->whereRaw('next_run_at <= NOW()')
|
||||||
|
->get();
|
||||||
|
|
||||||
|
if ($schedules->count() < 1) {
|
||||||
|
$this->line('There are no scheduled tasks for servers that need to be run.');
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
$bar = $this->output->createProgressBar(count($schedules));
|
||||||
|
foreach ($schedules as $schedule) {
|
||||||
|
$bar->clear();
|
||||||
|
$this->processSchedule($schedule);
|
||||||
|
$bar->advance();
|
||||||
|
$bar->display();
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->line('');
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Processes a given schedule and logs and errors encountered the console output. This should
|
||||||
|
* never throw an exception out, otherwise you'll end up killing the entire run group causing
|
||||||
|
* any other schedules to not process correctly.
|
||||||
|
*
|
||||||
|
* @see https://github.com/pterodactyl/panel/issues/2609
|
||||||
|
*/
|
||||||
|
protected function processSchedule(Schedule $schedule)
|
||||||
|
{
|
||||||
|
if ($schedule->tasks->isEmpty()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->getLaravel()->make(ProcessScheduleService::class)->handle($schedule);
|
||||||
|
|
||||||
|
$this->line(trans('command/messages.schedule.output_line', [
|
||||||
|
'schedule' => $schedule->name,
|
||||||
|
'hash' => $schedule->hashid,
|
||||||
|
]));
|
||||||
|
} catch (\Throwable|\Exception $exception) {
|
||||||
|
Log::error($exception, ['schedule_id' => $schedule->id]);
|
||||||
|
|
||||||
|
$this->error("An error was encountered while processing Schedule #$schedule->id: " . $exception->getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
106
app/Console/Commands/Server/BulkPowerActionCommand.php
Normal file
106
app/Console/Commands/Server/BulkPowerActionCommand.php
Normal file
@ -0,0 +1,106 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Validation\ValidationException;
|
||||||
|
use Illuminate\Validation\Factory as ValidatorFactory;
|
||||||
|
use Pterodactyl\Repositories\Wings\DaemonPowerRepository;
|
||||||
|
use Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException;
|
||||||
|
|
||||||
|
class BulkPowerActionCommand extends Command
|
||||||
|
{
|
||||||
|
protected $signature = 'p:server:bulk-power
|
||||||
|
{action : The action to perform (start, stop, restart, kill)}
|
||||||
|
{--servers= : A comma separated list of servers.}
|
||||||
|
{--nodes= : A comma separated list of nodes.}';
|
||||||
|
|
||||||
|
protected $description = 'Perform bulk power management on large groupings of servers or nodes at once.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* BulkPowerActionCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private DaemonPowerRepository $powerRepository, private ValidatorFactory $validator)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the bulk power request.
|
||||||
|
*
|
||||||
|
* @throws \Illuminate\Validation\ValidationException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$action = $this->argument('action');
|
||||||
|
$nodes = empty($this->option('nodes')) ? [] : explode(',', $this->option('nodes'));
|
||||||
|
$servers = empty($this->option('servers')) ? [] : explode(',', $this->option('servers'));
|
||||||
|
|
||||||
|
$validator = $this->validator->make([
|
||||||
|
'action' => $action,
|
||||||
|
'nodes' => $nodes,
|
||||||
|
'servers' => $servers,
|
||||||
|
], [
|
||||||
|
'action' => 'string|in:start,stop,kill,restart',
|
||||||
|
'nodes' => 'array',
|
||||||
|
'nodes.*' => 'integer|min:1',
|
||||||
|
'servers' => 'array',
|
||||||
|
'servers.*' => 'integer|min:1',
|
||||||
|
]);
|
||||||
|
|
||||||
|
if ($validator->fails()) {
|
||||||
|
foreach ($validator->getMessageBag()->all() as $message) {
|
||||||
|
$this->output->error($message);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new ValidationException($validator);
|
||||||
|
}
|
||||||
|
|
||||||
|
$count = $this->getQueryBuilder($servers, $nodes)->count();
|
||||||
|
if (!$this->confirm(trans('command/messages.server.power.confirm', ['action' => $action, 'count' => $count])) && $this->input->isInteractive()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$bar = $this->output->createProgressBar($count);
|
||||||
|
$powerRepository = $this->powerRepository;
|
||||||
|
$this->getQueryBuilder($servers, $nodes)->each(function (Server $server) use ($action, $powerRepository, &$bar) {
|
||||||
|
$bar->clear();
|
||||||
|
|
||||||
|
try {
|
||||||
|
$powerRepository->setServer($server)->send($action);
|
||||||
|
} catch (DaemonConnectionException $exception) {
|
||||||
|
$this->output->error(trans('command/messages.server.power.action_failed', [
|
||||||
|
'name' => $server->name,
|
||||||
|
'id' => $server->id,
|
||||||
|
'node' => $server->node->name,
|
||||||
|
'message' => $exception->getMessage(),
|
||||||
|
]));
|
||||||
|
}
|
||||||
|
|
||||||
|
$bar->advance();
|
||||||
|
$bar->display();
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->line('');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the query builder instance that will return the servers that should be affected.
|
||||||
|
*/
|
||||||
|
protected function getQueryBuilder(array $servers, array $nodes): Builder
|
||||||
|
{
|
||||||
|
$instance = Server::query()->whereNull('status');
|
||||||
|
|
||||||
|
if (!empty($nodes) && !empty($servers)) {
|
||||||
|
$instance->whereIn('id', $servers)->orWhereIn('node_id', $nodes);
|
||||||
|
} elseif (empty($nodes) && !empty($servers)) {
|
||||||
|
$instance->whereIn('id', $servers);
|
||||||
|
} elseif (!empty($nodes) && empty($servers)) {
|
||||||
|
$instance->whereIn('node_id', $nodes);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $instance->with('node');
|
||||||
|
}
|
||||||
|
}
|
||||||
34
app/Console/Commands/TelemetryCommand.php
Normal file
34
app/Console/Commands/TelemetryCommand.php
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Symfony\Component\VarDumper\VarDumper;
|
||||||
|
use Pterodactyl\Services\Telemetry\TelemetryCollectionService;
|
||||||
|
|
||||||
|
class TelemetryCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Displays all the data that would be sent to the Pterodactyl Telemetry Service if telemetry collection is enabled.';
|
||||||
|
|
||||||
|
protected $signature = 'p:telemetry';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TelemetryCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private TelemetryCollectionService $telemetryCollectionService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle execution of command.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$this->output->info('Collecting telemetry data, this may take a while...');
|
||||||
|
|
||||||
|
VarDumper::dump($this->telemetryCollectionService->collect());
|
||||||
|
}
|
||||||
|
}
|
||||||
195
app/Console/Commands/UpgradeCommand.php
Normal file
195
app/Console/Commands/UpgradeCommand.php
Normal file
@ -0,0 +1,195 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Console\Kernel;
|
||||||
|
use Symfony\Component\Process\Process;
|
||||||
|
use Symfony\Component\Console\Helper\ProgressBar;
|
||||||
|
|
||||||
|
class UpgradeCommand extends Command
|
||||||
|
{
|
||||||
|
protected const DEFAULT_URL = 'https://github.com/pterodactyl/panel/releases/%s/panel.tar.gz';
|
||||||
|
|
||||||
|
protected $signature = 'p:upgrade
|
||||||
|
{--user= : The user that PHP runs under. All files will be owned by this user.}
|
||||||
|
{--group= : The group that PHP runs under. All files will be owned by this group.}
|
||||||
|
{--url= : The specific archive to download.}
|
||||||
|
{--release= : A specific Pterodactyl version to download from GitHub. Leave blank to use latest.}
|
||||||
|
{--skip-download : If set no archive will be downloaded.}';
|
||||||
|
|
||||||
|
protected $description = 'Downloads a new archive for Pterodactyl from GitHub and then executes the normal upgrade commands.';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Executes an upgrade command which will run through all of our standard
|
||||||
|
* commands for Pterodactyl and enable users to basically just download
|
||||||
|
* the archive and execute this and be done.
|
||||||
|
*
|
||||||
|
* This places the application in maintenance mode as well while the commands
|
||||||
|
* are being executed.
|
||||||
|
*
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$skipDownload = $this->option('skip-download');
|
||||||
|
if (!$skipDownload) {
|
||||||
|
$this->output->warning('This command does not verify the integrity of downloaded assets. Please ensure that you trust the download source before continuing. If you do not wish to download an archive, please indicate that using the --skip-download flag, or answering "no" to the question below.');
|
||||||
|
$this->output->comment('Download Source (set with --url=):');
|
||||||
|
$this->line($this->getUrl());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (version_compare(PHP_VERSION, '7.4.0') < 0) {
|
||||||
|
$this->error('Cannot execute self-upgrade process. The minimum required PHP version required is 7.4.0, you have [' . PHP_VERSION . '].');
|
||||||
|
}
|
||||||
|
|
||||||
|
$user = 'www-data';
|
||||||
|
$group = 'www-data';
|
||||||
|
if ($this->input->isInteractive()) {
|
||||||
|
if (!$skipDownload) {
|
||||||
|
$skipDownload = !$this->confirm('Would you like to download and unpack the archive files for the latest version?', true);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (is_null($this->option('user'))) {
|
||||||
|
$userDetails = posix_getpwuid(fileowner('public'));
|
||||||
|
$user = $userDetails['name'] ?? 'www-data';
|
||||||
|
|
||||||
|
if (!$this->confirm("Your webserver user has been detected as <fg=blue>[{$user}]:</> is this correct?", true)) {
|
||||||
|
$user = $this->anticipate(
|
||||||
|
'Please enter the name of the user running your webserver process. This varies from system to system, but is generally "www-data", "nginx", or "apache".',
|
||||||
|
[
|
||||||
|
'www-data',
|
||||||
|
'nginx',
|
||||||
|
'apache',
|
||||||
|
]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (is_null($this->option('group'))) {
|
||||||
|
$groupDetails = posix_getgrgid(filegroup('public'));
|
||||||
|
$group = $groupDetails['name'] ?? 'www-data';
|
||||||
|
|
||||||
|
if (!$this->confirm("Your webserver group has been detected as <fg=blue>[{$group}]:</> is this correct?", true)) {
|
||||||
|
$group = $this->anticipate(
|
||||||
|
'Please enter the name of the group running your webserver process. Normally this is the same as your user.',
|
||||||
|
[
|
||||||
|
'www-data',
|
||||||
|
'nginx',
|
||||||
|
'apache',
|
||||||
|
]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$this->confirm('Are you sure you want to run the upgrade process for your Panel?')) {
|
||||||
|
$this->warn('Upgrade process terminated by user.');
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ini_set('output_buffering', '0');
|
||||||
|
$bar = $this->output->createProgressBar($skipDownload ? 9 : 10);
|
||||||
|
$bar->start();
|
||||||
|
|
||||||
|
if (!$skipDownload) {
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line("\$upgrader> curl -L \"{$this->getUrl()}\" | tar -xzv");
|
||||||
|
$process = Process::fromShellCommandline("curl -L \"{$this->getUrl()}\" | tar -xzv");
|
||||||
|
$process->run(function ($type, $buffer) {
|
||||||
|
$this->{$type === Process::ERR ? 'error' : 'line'}($buffer);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan down');
|
||||||
|
$this->call('down');
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> chmod -R 755 storage bootstrap/cache');
|
||||||
|
$process = new Process(['chmod', '-R', '755', 'storage', 'bootstrap/cache']);
|
||||||
|
$process->run(function ($type, $buffer) {
|
||||||
|
$this->{$type === Process::ERR ? 'error' : 'line'}($buffer);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$command = ['composer', 'install', '--no-ansi'];
|
||||||
|
if (config('app.env') === 'production' && !config('app.debug')) {
|
||||||
|
$command[] = '--optimize-autoloader';
|
||||||
|
$command[] = '--no-dev';
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->line('$upgrader> ' . implode(' ', $command));
|
||||||
|
$process = new Process($command);
|
||||||
|
$process->setTimeout(10 * 60);
|
||||||
|
$process->run(function ($type, $buffer) {
|
||||||
|
$this->line($buffer);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/** @var \Illuminate\Foundation\Application $app */
|
||||||
|
$app = require __DIR__ . '/../../../bootstrap/app.php';
|
||||||
|
/** @var \Pterodactyl\Console\Kernel $kernel */
|
||||||
|
$kernel = $app->make(Kernel::class);
|
||||||
|
$kernel->bootstrap();
|
||||||
|
$this->setLaravel($app);
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan view:clear');
|
||||||
|
$this->call('view:clear');
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan config:clear');
|
||||||
|
$this->call('config:clear');
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan migrate --force --seed');
|
||||||
|
$this->call('migrate', ['--force' => true, '--seed' => true]);
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () use ($user, $group) {
|
||||||
|
$this->line("\$upgrader> chown -R {$user}:{$group} *");
|
||||||
|
$process = Process::fromShellCommandline("chown -R {$user}:{$group} *", $this->getLaravel()->basePath());
|
||||||
|
$process->setTimeout(10 * 60);
|
||||||
|
$process->run(function ($type, $buffer) {
|
||||||
|
$this->{$type === Process::ERR ? 'error' : 'line'}($buffer);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan queue:restart');
|
||||||
|
$this->call('queue:restart');
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->withProgress($bar, function () {
|
||||||
|
$this->line('$upgrader> php artisan up');
|
||||||
|
$this->call('up');
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->newLine(2);
|
||||||
|
$this->info('Panel has been successfully upgraded. Please ensure you also update any Wings instances: https://pterodactyl.io/wings/1.0/upgrading.html');
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function withProgress(ProgressBar $bar, \Closure $callback)
|
||||||
|
{
|
||||||
|
$bar->clear();
|
||||||
|
$callback();
|
||||||
|
$bar->advance();
|
||||||
|
$bar->display();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getUrl(): string
|
||||||
|
{
|
||||||
|
if ($this->option('url')) {
|
||||||
|
return $this->option('url');
|
||||||
|
}
|
||||||
|
|
||||||
|
return sprintf(self::DEFAULT_URL, $this->option('release') ? 'download/v' . $this->option('release') : 'latest/download');
|
||||||
|
}
|
||||||
|
}
|
||||||
71
app/Console/Commands/User/DeleteUserCommand.php
Normal file
71
app/Console/Commands/User/DeleteUserCommand.php
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\User;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Webmozart\Assert\Assert;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Services\Users\UserDeletionService;
|
||||||
|
|
||||||
|
class DeleteUserCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Deletes a user from the Panel if no servers are attached to their account.';
|
||||||
|
|
||||||
|
protected $signature = 'p:user:delete {--user=}';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DeleteUserCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private UserDeletionService $deletionService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$search = $this->option('user') ?? $this->ask(trans('command/messages.user.search_users'));
|
||||||
|
Assert::notEmpty($search, 'Search term should be an email address, got: %s.');
|
||||||
|
|
||||||
|
$results = User::query()
|
||||||
|
->where('id', 'LIKE', "$search%")
|
||||||
|
->orWhere('username', 'LIKE', "$search%")
|
||||||
|
->orWhere('email', 'LIKE', "$search%")
|
||||||
|
->get();
|
||||||
|
|
||||||
|
if (count($results) < 1) {
|
||||||
|
$this->error(trans('command/messages.user.no_users_found'));
|
||||||
|
if ($this->input->isInteractive()) {
|
||||||
|
return $this->handle();
|
||||||
|
}
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($this->input->isInteractive()) {
|
||||||
|
$tableValues = [];
|
||||||
|
foreach ($results as $user) {
|
||||||
|
$tableValues[] = [$user->id, $user->email, $user->name];
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->table(['User ID', 'Email', 'Name'], $tableValues);
|
||||||
|
if (!$deleteUser = $this->ask(trans('command/messages.user.select_search_user'))) {
|
||||||
|
return $this->handle();
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (count($results) > 1) {
|
||||||
|
$this->error(trans('command/messages.user.multiple_found'));
|
||||||
|
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
$deleteUser = $results->first();
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($this->confirm(trans('command/messages.user.confirm_delete')) || !$this->input->isInteractive()) {
|
||||||
|
$this->deletionService->handle($deleteUser);
|
||||||
|
$this->info(trans('command/messages.user.deleted'));
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
43
app/Console/Commands/User/DisableTwoFactorCommand.php
Normal file
43
app/Console/Commands/User/DisableTwoFactorCommand.php
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\User;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
|
||||||
|
|
||||||
|
class DisableTwoFactorCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Disable two-factor authentication for a specific user in the Panel.';
|
||||||
|
|
||||||
|
protected $signature = 'p:user:disable2fa {--email= : The email of the user to disable 2-Factor for.}';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DisableTwoFactorCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private UserRepositoryInterface $repository)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command execution process.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
if ($this->input->isInteractive()) {
|
||||||
|
$this->output->warning(trans('command/messages.user.2fa_help_text'));
|
||||||
|
}
|
||||||
|
|
||||||
|
$email = $this->option('email') ?? $this->ask(trans('command/messages.user.ask_email'));
|
||||||
|
$user = $this->repository->setColumns(['id', 'email'])->findFirstWhere([['email', '=', $email]]);
|
||||||
|
|
||||||
|
$this->repository->withoutFreshModel()->update($user->id, [
|
||||||
|
'use_totp' => false,
|
||||||
|
'totp_secret' => null,
|
||||||
|
]);
|
||||||
|
$this->info(trans('command/messages.user.2fa_disabled', ['email' => $user->email]));
|
||||||
|
}
|
||||||
|
}
|
||||||
51
app/Console/Commands/User/MakeUserCommand.php
Normal file
51
app/Console/Commands/User/MakeUserCommand.php
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console\Commands\User;
|
||||||
|
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
use Pterodactyl\Services\Users\UserCreationService;
|
||||||
|
|
||||||
|
class MakeUserCommand extends Command
|
||||||
|
{
|
||||||
|
protected $description = 'Creates a user on the system via the CLI.';
|
||||||
|
|
||||||
|
protected $signature = 'p:user:make {--email=} {--username=} {--name-first=} {--name-last=} {--password=} {--admin=} {--no-password}';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MakeUserCommand constructor.
|
||||||
|
*/
|
||||||
|
public function __construct(private UserCreationService $creationService)
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle command request to create a new user.
|
||||||
|
*
|
||||||
|
* @throws \Exception
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function handle()
|
||||||
|
{
|
||||||
|
$root_admin = $this->option('admin') ?? $this->confirm(trans('command/messages.user.ask_admin'));
|
||||||
|
$email = $this->option('email') ?? $this->ask(trans('command/messages.user.ask_email'));
|
||||||
|
$username = $this->option('username') ?? $this->ask(trans('command/messages.user.ask_username'));
|
||||||
|
$name_first = $this->option('name-first') ?? $this->ask(trans('command/messages.user.ask_name_first'));
|
||||||
|
$name_last = $this->option('name-last') ?? $this->ask(trans('command/messages.user.ask_name_last'));
|
||||||
|
|
||||||
|
if (is_null($password = $this->option('password')) && !$this->option('no-password')) {
|
||||||
|
$this->warn(trans('command/messages.user.ask_password_help'));
|
||||||
|
$this->line(trans('command/messages.user.ask_password_tip'));
|
||||||
|
$password = $this->secret(trans('command/messages.user.ask_password'));
|
||||||
|
}
|
||||||
|
|
||||||
|
$user = $this->creationService->handle(compact('email', 'username', 'name_first', 'name_last', 'password', 'root_admin'));
|
||||||
|
$this->table(['Field', 'Value'], [
|
||||||
|
['UUID', $user->uuid],
|
||||||
|
['Email', $user->email],
|
||||||
|
['Username', $user->username],
|
||||||
|
['Name', $user->name],
|
||||||
|
['Admin', $user->root_admin ? 'Yes' : 'No'],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
76
app/Console/Kernel.php
Normal file
76
app/Console/Kernel.php
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console;
|
||||||
|
|
||||||
|
use Ramsey\Uuid\Uuid;
|
||||||
|
use Pterodactyl\Models\ActivityLog;
|
||||||
|
use Illuminate\Console\Scheduling\Schedule;
|
||||||
|
use Illuminate\Database\Console\PruneCommand;
|
||||||
|
use Pterodactyl\Repositories\Eloquent\SettingsRepository;
|
||||||
|
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
|
||||||
|
use Pterodactyl\Services\Telemetry\TelemetryCollectionService;
|
||||||
|
use Pterodactyl\Console\Commands\Schedule\ProcessRunnableCommand;
|
||||||
|
use Pterodactyl\Console\Commands\Maintenance\PruneOrphanedBackupsCommand;
|
||||||
|
use Pterodactyl\Console\Commands\Maintenance\CleanServiceBackupFilesCommand;
|
||||||
|
|
||||||
|
class Kernel extends ConsoleKernel
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Register the commands for the application.
|
||||||
|
*/
|
||||||
|
protected function commands(): void
|
||||||
|
{
|
||||||
|
$this->load(__DIR__ . '/Commands');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Define the application's command schedule.
|
||||||
|
*/
|
||||||
|
protected function schedule(Schedule $schedule): void
|
||||||
|
{
|
||||||
|
// https://laravel.com/docs/10.x/upgrade#redis-cache-tags
|
||||||
|
$schedule->command('cache:prune-stale-tags')->hourly();
|
||||||
|
|
||||||
|
// Execute scheduled commands for servers every minute, as if there was a normal cron running.
|
||||||
|
$schedule->command(ProcessRunnableCommand::class)->everyMinute()->withoutOverlapping();
|
||||||
|
$schedule->command(CleanServiceBackupFilesCommand::class)->daily();
|
||||||
|
|
||||||
|
if (config('backups.prune_age')) {
|
||||||
|
// Every 30 minutes, run the backup pruning command so that any abandoned backups can be deleted.
|
||||||
|
$schedule->command(PruneOrphanedBackupsCommand::class)->everyThirtyMinutes();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config('activity.prune_days')) {
|
||||||
|
$schedule->command(PruneCommand::class, ['--model' => [ActivityLog::class]])->daily();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config('pterodactyl.telemetry.enabled')) {
|
||||||
|
$this->registerTelemetry($schedule);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* I wonder what this does.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Illuminate\Contracts\Container\BindingResolutionException
|
||||||
|
*/
|
||||||
|
private function registerTelemetry(Schedule $schedule): void
|
||||||
|
{
|
||||||
|
$settingsRepository = app()->make(SettingsRepository::class);
|
||||||
|
|
||||||
|
$uuid = $settingsRepository->get('app:telemetry:uuid');
|
||||||
|
if (is_null($uuid)) {
|
||||||
|
$uuid = Uuid::uuid4()->toString();
|
||||||
|
$settingsRepository->set('app:telemetry:uuid', $uuid);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Calculate a fixed time to run the data push at, this will be the same time every day.
|
||||||
|
$time = hexdec(str_replace('-', '', substr($uuid, 27))) % 1440;
|
||||||
|
$hour = floor($time / 60);
|
||||||
|
$minute = $time % 60;
|
||||||
|
|
||||||
|
// Run the telemetry collector.
|
||||||
|
$schedule->call(app()->make(TelemetryCollectionService::class))->description('Collect Telemetry')->dailyAt("$hour:$minute");
|
||||||
|
}
|
||||||
|
}
|
||||||
55
app/Console/RequiresDatabaseMigrations.php
Normal file
55
app/Console/RequiresDatabaseMigrations.php
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Console;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @mixin \Illuminate\Console\Command
|
||||||
|
*/
|
||||||
|
trait RequiresDatabaseMigrations
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Checks if the migrations have finished running by comparing the last migration file.
|
||||||
|
*/
|
||||||
|
protected function hasCompletedMigrations(): bool
|
||||||
|
{
|
||||||
|
/** @var \Illuminate\Database\Migrations\Migrator $migrator */
|
||||||
|
$migrator = $this->getLaravel()->make('migrator');
|
||||||
|
|
||||||
|
$files = $migrator->getMigrationFiles(database_path('migrations'));
|
||||||
|
|
||||||
|
if (!$migrator->repositoryExists()) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (array_diff(array_keys($files), $migrator->getRepository()->getRan())) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Throw a massive error into the console to hopefully catch the users attention and get
|
||||||
|
* them to properly run the migrations rather than ignoring all of the other previous
|
||||||
|
* errors...
|
||||||
|
*/
|
||||||
|
protected function showMigrationWarning(): void
|
||||||
|
{
|
||||||
|
$this->getOutput()->writeln('<options=bold>
|
||||||
|
| @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
|
||||||
|
| |
|
||||||
|
| Your database has not been properly migrated! |
|
||||||
|
| |
|
||||||
|
| @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |</>
|
||||||
|
|
||||||
|
You must run the following command to finish migrating your database:
|
||||||
|
|
||||||
|
<fg=green;options=bold>php artisan migrate --step --force</>
|
||||||
|
|
||||||
|
You will not be able to use Pterodactyl Panel as expected without fixing your
|
||||||
|
database state by running the command above.
|
||||||
|
');
|
||||||
|
|
||||||
|
$this->getOutput()->error('You must correct the error above before continuing.');
|
||||||
|
}
|
||||||
|
}
|
||||||
13
app/Contracts/Core/ReceivesEvents.php
Normal file
13
app/Contracts/Core/ReceivesEvents.php
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Core;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
|
||||||
|
interface ReceivesEvents
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Handles receiving an event from the application.
|
||||||
|
*/
|
||||||
|
public function handle(Event $notification): void;
|
||||||
|
}
|
||||||
14
app/Contracts/Criteria/CriteriaInterface.php
Normal file
14
app/Contracts/Criteria/CriteriaInterface.php
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Criteria;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Pterodactyl\Repositories\Repository;
|
||||||
|
|
||||||
|
interface CriteriaInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Apply selected criteria to a repository call.
|
||||||
|
*/
|
||||||
|
public function apply(Model $model, Repository $repository): mixed;
|
||||||
|
}
|
||||||
15
app/Contracts/Extensions/HashidsInterface.php
Normal file
15
app/Contracts/Extensions/HashidsInterface.php
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Extensions;
|
||||||
|
|
||||||
|
use Hashids\HashidsInterface as VendorHashidsInterface;
|
||||||
|
|
||||||
|
interface HashidsInterface extends VendorHashidsInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Decode an encoded hashid and return the first result.
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException
|
||||||
|
*/
|
||||||
|
public function decodeFirst(string $encoded, string $default = null): mixed;
|
||||||
|
}
|
||||||
13
app/Contracts/Http/ClientPermissionsRequest.php
Normal file
13
app/Contracts/Http/ClientPermissionsRequest.php
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Http;
|
||||||
|
|
||||||
|
interface ClientPermissionsRequest
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Returns the permissions string indicating which permission should be used to
|
||||||
|
* validate that the authenticated user has permission to perform this action against
|
||||||
|
* the given resource (server).
|
||||||
|
*/
|
||||||
|
public function permission(): string;
|
||||||
|
}
|
||||||
19
app/Contracts/Repository/AllocationRepositoryInterface.php
Normal file
19
app/Contracts/Repository/AllocationRepositoryInterface.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Allocation;
|
||||||
|
|
||||||
|
interface AllocationRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return all the allocations that exist for a node that are not currently
|
||||||
|
* allocated.
|
||||||
|
*/
|
||||||
|
public function getUnassignedAllocationIds(int $node): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a single allocation from those meeting the requirements.
|
||||||
|
*/
|
||||||
|
public function getRandomAllocation(array $nodes, array $ports, bool $dedicated = false): ?Allocation;
|
||||||
|
}
|
||||||
29
app/Contracts/Repository/ApiKeyRepositoryInterface.php
Normal file
29
app/Contracts/Repository/ApiKeyRepositoryInterface.php
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface ApiKeyRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Get all the account API keys that exist for a specific user.
|
||||||
|
*/
|
||||||
|
public function getAccountKeys(User $user): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all the application API keys that exist for a specific user.
|
||||||
|
*/
|
||||||
|
public function getApplicationKeys(User $user): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete an account API key from the panel for a specific user.
|
||||||
|
*/
|
||||||
|
public function deleteAccountKey(User $user, string $identifier): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete an application API key from the panel for a specific user.
|
||||||
|
*/
|
||||||
|
public function deleteApplicationKey(User $user, string $identifier): int;
|
||||||
|
}
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
interface ApiPermissionRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
}
|
||||||
14
app/Contracts/Repository/DatabaseHostRepositoryInterface.php
Normal file
14
app/Contracts/Repository/DatabaseHostRepositoryInterface.php
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface DatabaseHostRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return database hosts with a count of databases and the node
|
||||||
|
* information for which it is attached.
|
||||||
|
*/
|
||||||
|
public function getWithViewDetails(): Collection;
|
||||||
|
}
|
||||||
61
app/Contracts/Repository/DatabaseRepositoryInterface.php
Normal file
61
app/Contracts/Repository/DatabaseRepositoryInterface.php
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
|
||||||
|
|
||||||
|
interface DatabaseRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
public const DEFAULT_CONNECTION_NAME = 'dynamic';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the connection name to execute statements against.
|
||||||
|
*/
|
||||||
|
public function setConnection(string $connection): self;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the connection to execute statements against.
|
||||||
|
*/
|
||||||
|
public function getConnection(): string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all the databases belonging to a server.
|
||||||
|
*/
|
||||||
|
public function getDatabasesForServer(int $server): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all the databases for a given host with the server relationship loaded.
|
||||||
|
*/
|
||||||
|
public function getDatabasesForHost(int $host, int $count = 25): LengthAwarePaginator;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new database on a given connection.
|
||||||
|
*/
|
||||||
|
public function createDatabase(string $database): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new database user on a given connection.
|
||||||
|
*/
|
||||||
|
public function createUser(string $username, string $remote, string $password, ?int $max_connections): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Give a specific user access to a given database.
|
||||||
|
*/
|
||||||
|
public function assignUserToDatabase(string $database, string $username, string $remote): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Flush the privileges for a given connection.
|
||||||
|
*/
|
||||||
|
public function flush(): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Drop a given database on a specific connection.
|
||||||
|
*/
|
||||||
|
public function dropDatabase(string $database): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Drop a given user on a specific connection.
|
||||||
|
*/
|
||||||
|
public function dropUser(string $username, string $remote): bool;
|
||||||
|
}
|
||||||
38
app/Contracts/Repository/EggRepositoryInterface.php
Normal file
38
app/Contracts/Repository/EggRepositoryInterface.php
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Egg;
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
|
||||||
|
interface EggRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return an egg with the variables relation attached.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithVariables(int $id): Egg;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all eggs and their relations to be used in the daemon API.
|
||||||
|
*/
|
||||||
|
public function getAllWithCopyAttributes(): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return an egg with the scriptFrom and configFrom relations loaded onto the model.
|
||||||
|
*/
|
||||||
|
public function getWithCopyAttributes(int|string $value, string $column = 'id'): Egg;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all the data needed to export a service.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithExportAttributes(int $id): Egg;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Confirm a copy script belongs to the same nest as the item trying to use it.
|
||||||
|
*/
|
||||||
|
public function isCopyableScript(int $copyFromId, int $service): bool;
|
||||||
|
}
|
||||||
14
app/Contracts/Repository/EggVariableRepositoryInterface.php
Normal file
14
app/Contracts/Repository/EggVariableRepositoryInterface.php
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface EggVariableRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return editable variables for a given egg. Editable variables must be set to
|
||||||
|
* user viewable in order to be picked up by this function.
|
||||||
|
*/
|
||||||
|
public function getEditableVariables(int $egg): Collection;
|
||||||
|
}
|
||||||
33
app/Contracts/Repository/LocationRepositoryInterface.php
Normal file
33
app/Contracts/Repository/LocationRepositoryInterface.php
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Location;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface LocationRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return locations with a count of nodes and servers attached to it.
|
||||||
|
*/
|
||||||
|
public function getAllWithDetails(): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all the available locations with the nodes as a relationship.
|
||||||
|
*/
|
||||||
|
public function getAllWithNodes(): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all the nodes and their respective count of servers for a location.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithNodes(int $id): Location;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a location and the count of nodes in that location.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithNodeCount(int $id): Location;
|
||||||
|
}
|
||||||
30
app/Contracts/Repository/NestRepositoryInterface.php
Normal file
30
app/Contracts/Repository/NestRepositoryInterface.php
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Nest;
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
|
||||||
|
interface NestRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return a nest or all nests with their associated eggs and variables.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithEggs(int $id = null): Collection|Nest;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a nest or all nests and the count of eggs and servers for that nest.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithCounts(int $id = null): Collection|Nest;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a nest along with its associated eggs and the servers relation on those eggs.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithEggServers(int $id): Nest;
|
||||||
|
}
|
||||||
38
app/Contracts/Repository/NodeRepositoryInterface.php
Normal file
38
app/Contracts/Repository/NodeRepositoryInterface.php
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Node;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface NodeRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
public const THRESHOLD_PERCENTAGE_LOW = 75;
|
||||||
|
public const THRESHOLD_PERCENTAGE_MEDIUM = 90;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the usage stats for a single node.
|
||||||
|
*/
|
||||||
|
public function getUsageStats(Node $node): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the usage stats for a single node.
|
||||||
|
*/
|
||||||
|
public function getUsageStatsRaw(Node $node): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a single node with location and server information.
|
||||||
|
*/
|
||||||
|
public function loadLocationAndServerCount(Node $node, bool $refresh = false): Node;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attach a paginated set of allocations to a node mode including
|
||||||
|
* any servers that are also attached to those allocations.
|
||||||
|
*/
|
||||||
|
public function loadNodeAllocations(Node $node, bool $refresh = false): Node;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a collection of nodes for all locations to use in server creation UI.
|
||||||
|
*/
|
||||||
|
public function getNodesForServerCreation(): Collection;
|
||||||
|
}
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
interface PermissionRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
}
|
||||||
141
app/Contracts/Repository/RepositoryInterface.php
Normal file
141
app/Contracts/Repository/RepositoryInterface.php
Normal file
@ -0,0 +1,141 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
|
||||||
|
|
||||||
|
interface RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return an identifier or Model object to be used by the repository.
|
||||||
|
*/
|
||||||
|
public function model(): string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the model being used for this repository instance.
|
||||||
|
*/
|
||||||
|
public function getModel(): Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an instance of a query builder.
|
||||||
|
*/
|
||||||
|
public function getBuilder(): Builder;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the columns to be selected or returned by the query.
|
||||||
|
*/
|
||||||
|
public function getColumns(): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An array of columns to filter the response by.
|
||||||
|
*/
|
||||||
|
public function setColumns(array|string $columns = ['*']): self;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stop repository update functions from returning a fresh
|
||||||
|
* model when changes are committed.
|
||||||
|
*/
|
||||||
|
public function withoutFreshModel(): self;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a fresh model with a repository updates a model.
|
||||||
|
*/
|
||||||
|
public function withFreshModel(): self;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set whether the repository should return a fresh model
|
||||||
|
* when changes are committed.
|
||||||
|
*/
|
||||||
|
public function setFreshModel(bool $fresh = true): self;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new model instance and persist it to the database.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function create(array $fields, bool $validate = true, bool $force = false): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find a model that has the specific ID passed.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function find(int $id): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find a model matching an array of where clauses.
|
||||||
|
*/
|
||||||
|
public function findWhere(array $fields): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find and return the first matching instance for the given fields.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function findFirstWhere(array $fields): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a count of records matching the passed arguments.
|
||||||
|
*/
|
||||||
|
public function findCountWhere(array $fields): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete a given record from the database.
|
||||||
|
*/
|
||||||
|
public function delete(int $id): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete records matching the given attributes.
|
||||||
|
*/
|
||||||
|
public function deleteWhere(array $attributes): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update a given ID with the passed array of fields.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function update(int $id, array $fields, bool $validate = true, bool $force = false): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Perform a mass update where matching records are updated using whereIn.
|
||||||
|
* This does not perform any model data validation.
|
||||||
|
*/
|
||||||
|
public function updateWhereIn(string $column, array $values, array $fields): int;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update a record if it exists in the database, otherwise create it.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
*/
|
||||||
|
public function updateOrCreate(array $where, array $fields, bool $validate = true, bool $force = false): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return all records associated with the given model.
|
||||||
|
*/
|
||||||
|
public function all(): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a paginated result set using a search term if set on the repository.
|
||||||
|
*/
|
||||||
|
public function paginated(int $perPage): LengthAwarePaginator;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Insert a single or multiple records into the database at once skipping
|
||||||
|
* validation and mass assignment checking.
|
||||||
|
*/
|
||||||
|
public function insert(array $data): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Insert multiple records into the database and ignore duplicates.
|
||||||
|
*/
|
||||||
|
public function insertIgnore(array $values): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the amount of entries in the database.
|
||||||
|
*/
|
||||||
|
public function count(): int;
|
||||||
|
}
|
||||||
21
app/Contracts/Repository/ScheduleRepositoryInterface.php
Normal file
21
app/Contracts/Repository/ScheduleRepositoryInterface.php
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Schedule;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface ScheduleRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return all the schedules for a given server.
|
||||||
|
*/
|
||||||
|
public function findServerSchedules(int $server): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a schedule model with all the associated tasks as a relationship.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getScheduleWithTasks(int $schedule): Schedule;
|
||||||
|
}
|
||||||
73
app/Contracts/Repository/ServerRepositoryInterface.php
Normal file
73
app/Contracts/Repository/ServerRepositoryInterface.php
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
|
||||||
|
|
||||||
|
interface ServerRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Load the egg relations onto the server model.
|
||||||
|
*/
|
||||||
|
public function loadEggRelations(Server $server, bool $refresh = false): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a collection of servers with their associated data for rebuild operations.
|
||||||
|
*/
|
||||||
|
public function getDataForRebuild(int $server = null, int $node = null): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a collection of servers with their associated data for reinstall operations.
|
||||||
|
*/
|
||||||
|
public function getDataForReinstall(int $server = null, int $node = null): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a server model and all variables associated with the server.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function findWithVariables(int $id): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the primary allocation for a given server. If a model is passed into
|
||||||
|
* the function, load the allocation relationship onto it. Otherwise, find and
|
||||||
|
* return the server from the database.
|
||||||
|
*/
|
||||||
|
public function getPrimaryAllocation(Server $server, bool $refresh = false): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return enough data to be used for the creation of a server via the daemon.
|
||||||
|
*/
|
||||||
|
public function getDataForCreation(Server $server, bool $refresh = false): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load associated databases onto the server model.
|
||||||
|
*/
|
||||||
|
public function loadDatabaseRelations(Server $server, bool $refresh = false): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get data for use when updating a server on the Daemon. Returns an array of
|
||||||
|
* the egg which is used for build and rebuild. Only loads relations
|
||||||
|
* if they are missing, or refresh is set to true.
|
||||||
|
*/
|
||||||
|
public function getDaemonServiceData(Server $server, bool $refresh = false): array;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a server by UUID.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getByUuid(string $uuid): Server;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if a given UUID and UUID-Short string are unique to a server.
|
||||||
|
*/
|
||||||
|
public function isUniqueUuidCombo(string $uuid, string $short): bool;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns all the servers that exist for a given node in a paginated response.
|
||||||
|
*/
|
||||||
|
public function loadAllServersForNode(int $node, int $limit): LengthAwarePaginator;
|
||||||
|
}
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
interface ServerVariableRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
}
|
||||||
18
app/Contracts/Repository/SessionRepositoryInterface.php
Normal file
18
app/Contracts/Repository/SessionRepositoryInterface.php
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
|
interface SessionRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return all the active sessions for a user.
|
||||||
|
*/
|
||||||
|
public function getUserSessions(int $user): Collection;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete a session for a given user.
|
||||||
|
*/
|
||||||
|
public function deleteUserSession(int $user, string $session): ?int;
|
||||||
|
}
|
||||||
24
app/Contracts/Repository/SettingsRepositoryInterface.php
Normal file
24
app/Contracts/Repository/SettingsRepositoryInterface.php
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
interface SettingsRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Store a new persistent setting in the database.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function set(string $key, string $value = null);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve a persistent setting from the database.
|
||||||
|
*/
|
||||||
|
public function get(string $key, mixed $default): mixed;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove a key from the database cache.
|
||||||
|
*/
|
||||||
|
public function forget(string $key);
|
||||||
|
}
|
||||||
25
app/Contracts/Repository/SubuserRepositoryInterface.php
Normal file
25
app/Contracts/Repository/SubuserRepositoryInterface.php
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Subuser;
|
||||||
|
|
||||||
|
interface SubuserRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Return a subuser with the associated server relationship.
|
||||||
|
*/
|
||||||
|
public function loadServerAndUserRelations(Subuser $subuser, bool $refresh = false): Subuser;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a subuser with the associated permissions relationship.
|
||||||
|
*/
|
||||||
|
public function getWithPermissions(Subuser $subuser, bool $refresh = false): Subuser;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a subuser and associated permissions given a user_id and server_id.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getWithPermissionsUsingUserAndServer(int $user, int $server): Subuser;
|
||||||
|
}
|
||||||
20
app/Contracts/Repository/TaskRepositoryInterface.php
Normal file
20
app/Contracts/Repository/TaskRepositoryInterface.php
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\Task;
|
||||||
|
|
||||||
|
interface TaskRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Get a task and the server relationship for that task.
|
||||||
|
*
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
|
*/
|
||||||
|
public function getTaskForJobProcess(int $id): Task;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the next task in a schedule.
|
||||||
|
*/
|
||||||
|
public function getNextTask(int $schedule, int $index): ?Task;
|
||||||
|
}
|
||||||
7
app/Contracts/Repository/UserRepositoryInterface.php
Normal file
7
app/Contracts/Repository/UserRepositoryInterface.php
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Contracts\Repository;
|
||||||
|
|
||||||
|
interface UserRepositoryInterface extends RepositoryInterface
|
||||||
|
{
|
||||||
|
}
|
||||||
34
app/Events/ActivityLogged.php
Normal file
34
app/Events/ActivityLogged.php
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events;
|
||||||
|
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
use Pterodactyl\Models\ActivityLog;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class ActivityLogged extends Event
|
||||||
|
{
|
||||||
|
public function __construct(public ActivityLog $model)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
public function is(string $event): bool
|
||||||
|
{
|
||||||
|
return $this->model->event === $event;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function actor(): ?Model
|
||||||
|
{
|
||||||
|
return $this->isSystem() ? null : $this->model->actor;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isServerEvent(): bool
|
||||||
|
{
|
||||||
|
return Str::startsWith($this->model->event, 'server:');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isSystem(): bool
|
||||||
|
{
|
||||||
|
return is_null($this->model->actor_id);
|
||||||
|
}
|
||||||
|
}
|
||||||
13
app/Events/Auth/DirectLogin.php
Normal file
13
app/Events/Auth/DirectLogin.php
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Auth;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
|
||||||
|
class DirectLogin extends Event
|
||||||
|
{
|
||||||
|
public function __construct(public User $user, public bool $remember)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
18
app/Events/Auth/FailedCaptcha.php
Normal file
18
app/Events/Auth/FailedCaptcha.php
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Auth;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class FailedCaptcha extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public string $ip, public string $domain)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
18
app/Events/Auth/FailedPasswordReset.php
Normal file
18
app/Events/Auth/FailedPasswordReset.php
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Auth;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class FailedPasswordReset extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public string $ip, public string $email)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
13
app/Events/Auth/ProvidedAuthenticationToken.php
Normal file
13
app/Events/Auth/ProvidedAuthenticationToken.php
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Auth;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
|
||||||
|
class ProvidedAuthenticationToken extends Event
|
||||||
|
{
|
||||||
|
public function __construct(public User $user, public bool $recovery = false)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
7
app/Events/Event.php
Normal file
7
app/Events/Event.php
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events;
|
||||||
|
|
||||||
|
abstract class Event
|
||||||
|
{
|
||||||
|
}
|
||||||
19
app/Events/Server/Created.php
Normal file
19
app/Events/Server/Created.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Created extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Creating.php
Normal file
19
app/Events/Server/Creating.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Creating extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Deleted.php
Normal file
19
app/Events/Server/Deleted.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleted extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Deleting.php
Normal file
19
app/Events/Server/Deleting.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleting extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Installed.php
Normal file
19
app/Events/Server/Installed.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Installed extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Saved.php
Normal file
19
app/Events/Server/Saved.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Saved extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Saving.php
Normal file
19
app/Events/Server/Saving.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Saving extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Updated.php
Normal file
19
app/Events/Server/Updated.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Updated extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Server/Updating.php
Normal file
19
app/Events/Server/Updating.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Server;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Server;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Updating extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Server $server)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Subuser/Created.php
Normal file
19
app/Events/Subuser/Created.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Subuser;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Subuser;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Created extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Subuser $subuser)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Subuser/Creating.php
Normal file
19
app/Events/Subuser/Creating.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Subuser;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Subuser;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Creating extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Subuser $subuser)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Subuser/Deleted.php
Normal file
19
app/Events/Subuser/Deleted.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Subuser;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Subuser;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleted extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Subuser $subuser)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/Subuser/Deleting.php
Normal file
19
app/Events/Subuser/Deleting.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\Subuser;
|
||||||
|
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Pterodactyl\Models\Subuser;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleting extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public Subuser $subuser)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/User/Created.php
Normal file
19
app/Events/User/Created.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\User;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Created extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public User $user)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/User/Creating.php
Normal file
19
app/Events/User/Creating.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\User;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Creating extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public User $user)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/User/Deleted.php
Normal file
19
app/Events/User/Deleted.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\User;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleted extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public User $user)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
19
app/Events/User/Deleting.php
Normal file
19
app/Events/User/Deleting.php
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Pterodactyl\Events\User;
|
||||||
|
|
||||||
|
use Pterodactyl\Models\User;
|
||||||
|
use Pterodactyl\Events\Event;
|
||||||
|
use Illuminate\Queue\SerializesModels;
|
||||||
|
|
||||||
|
class Deleting extends Event
|
||||||
|
{
|
||||||
|
use SerializesModels;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new event instance.
|
||||||
|
*/
|
||||||
|
public function __construct(public User $user)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user