Pterodactyl / Panel

app/Notifications/ServerCreated.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
      * Get the notification's delivery channels.
      *
      * @param  mixed  $notifiable
-     * @return array
+     * @return string[]
      */
     public function via($notifiable)
     {

app/Policies/ServerPolicy.php

Doc Comments +76 added lines, -76 removed lines

@@ -42,8 +42,8 @@ 
     /**
      * Determine if current user is the owner of a server.
      *
-     * @param  Pterodactyl\Models\User    $user
-     * @param  Pterodactyl\Models\Server  $server
+     * @param  User    $user
+     * @param  Server  $server
      * @return boolean
      */
     protected function isOwner(User $user, Server $server)
@@ -54,9 +54,9 @@ 
     /**
      * Runs before any of the functions are called. Used to determine if user is root admin, if so, ignore permissions.
      *
-     * @param  Pterodactyl\Models\User $user
+     * @param  User $user
      * @param  string $ability
-     * @return boolean
+     * @return boolean|null
      */
     public function before(User $user, $ability)
     {
@@ -68,8 +68,8 @@ 
     /**
      * Check if user has permission to control power for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function power(User $user, Server $server)
@@ -84,8 +84,8 @@ 
     /**
      * Check if user has permission to start a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function powerStart(User $user, Server $server)
@@ -100,8 +100,8 @@ 
     /**
      * Check if user has permission to stop a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function powerStop(User $user, Server $server)
@@ -116,8 +116,8 @@ 
     /**
      * Check if user has permission to restart a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function powerRestart(User $user, Server $server)
@@ -132,8 +132,8 @@ 
     /**
      * Check if user has permission to kill a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function powerKill(User $user, Server $server)
@@ -148,8 +148,8 @@ 
     /**
      * Check if user has permission to run a command on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function sendCommand(User $user, Server $server)
@@ -164,8 +164,8 @@ 
     /**
      * Check if user has permission to list files on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function listFiles(User $user, Server $server)
@@ -180,8 +180,8 @@ 
     /**
      * Check if user has permission to edit files on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function editFiles(User $user, Server $server)
@@ -196,8 +196,8 @@ 
     /**
      * Check if user has permission to save files on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function saveFiles(User $user, Server $server)
@@ -212,8 +212,8 @@ 
     /**
      * Check if user has permission to move and rename files and folders on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function moveFiles(User $user, Server $server)
@@ -228,8 +228,8 @@ 
     /**
      * Check if user has permission to copy folders and files on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function copyFiles(User $user, Server $server)
@@ -244,8 +244,8 @@ 
     /**
      * Check if user has permission to compress files and folders on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function compressFiles(User $user, Server $server)
@@ -260,8 +260,8 @@ 
     /**
      * Check if user has permission to decompress files on a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function decompressFiles(User $user, Server $server)
@@ -276,8 +276,8 @@ 
     /**
      * Check if user has permission to add files to a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function addFiles(User $user, Server $server)
@@ -293,8 +293,8 @@ 
      * Check if user has permission to upload files to a server.
      * This permission relies on the user having the 'add-files' permission as well due to page authorization.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function uploadFiles(User $user, Server $server)
@@ -309,8 +309,8 @@ 
     /**
      * Check if user has permission to download files from a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function downloadFiles(User $user, Server $server)
@@ -325,8 +325,8 @@ 
     /**
      * Check if user has permission to delete files from a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function deleteFiles(User $user, Server $server)
@@ -341,8 +341,8 @@ 
     /**
      * Check if user has permission to view subusers for the server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function listSubusers(User $user, Server $server)
@@ -357,8 +357,8 @@ 
     /**
      * Check if user has permission to view specific subuser permissions.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewSubuser(User $user, Server $server)
@@ -373,8 +373,8 @@ 
     /**
      * Check if user has permission to edit a subuser.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function editSubuser(User $user, Server $server)
@@ -389,8 +389,8 @@ 
     /**
      * Check if user has permission to delete a subuser.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function deleteSubuser(User $user, Server $server)
@@ -405,8 +405,8 @@ 
     /**
      * Check if user has permission to edit a subuser.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function createSubuser(User $user, Server $server)
@@ -421,8 +421,8 @@ 
     /**
      * Check if user has permission to set the default connection for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function setConnection(User $user, Server $server)
@@ -437,8 +437,8 @@ 
     /**
      * Check if user has permission to view the startup command used for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewStartup(User $user, Server $server)
@@ -453,8 +453,8 @@ 
     /**
      * Check if user has permission to edit the startup command used for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function editStartup(User $user, Server $server)
@@ -469,8 +469,8 @@ 
     /**
      * Check if user has permission to view the SFTP information for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewSftp(User $user, Server $server)
@@ -485,8 +485,8 @@ 
     /**
      * Check if user has permission to reset the SFTP password for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function resetSftp(User $user, Server $server)
@@ -501,8 +501,8 @@ 
     /**
      * Check if user has permission to view the SFTP password for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewSftpPassword(User $user, Server $server)
@@ -517,8 +517,8 @@ 
     /**
      * Check if user has permission to view databases for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewDatabases(User $user, Server $server)
@@ -533,8 +533,8 @@ 
     /**
      * Check if user has permission to reset database passwords.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function resetDbPassword(User $user, Server $server)
@@ -549,8 +549,8 @@ 
     /**
      * Check if user has permission to view all tasks for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function listTasks(User $user, Server $server)
@@ -565,8 +565,8 @@ 
     /**
      * Check if user has permission to view a specific task for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function viewTask(User $user, Server $server)
@@ -581,8 +581,8 @@ 
     /**
      * Check if user has permission to view a toggle a task for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function toggleTask(User $user, Server $server)
@@ -597,8 +597,8 @@ 
     /**
      * Check if user has permission to queue a task for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function queueTask(User $user, Server $server)
@@ -613,8 +613,8 @@ 
     /**
      * Check if user has permission to delete a specific task for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function deleteTask(User $user, Server $server)
@@ -629,8 +629,8 @@ 
     /**
      * Check if user has permission to create a task for a server.
      *
-     * @param  Pterodactyl\Models\User   $user
-     * @param  Pterodactyl\Models\Server $server
+     * @param  User   $user
+     * @param  Server $server
      * @return boolean
      */
     public function createTask(User $user, Server $server)

app/Providers/RouteServiceProvider.php

Doc Comments -1 removed lines

@@ -19,7 +19,6 @@
     /**
      * Define your route model bindings, pattern filters, etc.
      *
-     * @param  \Illuminate\Routing\Router  $router
      * @return void
      */
     public function boot()

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      */
     public function map()
     {
-        Route::group(['namespace' => $this->namespace], function ($router) {
+        Route::group(['namespace' => $this->namespace], function($router) {
             foreach (glob(app_path('Http//Routes') . '/*.php') as $file) {
                 $this->app->make('Pterodactyl\\Http\\Routes\\' . basename($file, '.php'))->map($router);
             }

app/Repositories/APIRepository.php

Unused Use Statements -1 removed lines

@@ -28,7 +28,6 @@
 use Crypt;
 use Validator;
 use IPTools\Network;
-
 use Pterodactyl\Models;
 use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Exceptions\DisplayValidationException;

Spacing +3 added lines, -3 removed lines

@@ -127,7 +127,7 @@ 
 
         $validator->after(function($validator) use ($data) {
             if (array_key_exists('allowed_ips', $data) && !empty($data['allowed_ips'])) {
-                foreach(explode("\n", $data['allowed_ips']) as $ip) {
+                foreach (explode("\n", $data['allowed_ips']) as $ip) {
                     $ip = trim($ip);
                     try {
                         Network::parse($ip);
@@ -161,7 +161,7 @@ 
 
             $totalPermissions = 0;
             if (isset($data['permissions'])) {
-                foreach($data['permissions'] as $permNode) {
+                foreach ($data['permissions'] as $permNode) {
                     if (!strpos($permNode, ':')) continue;
 
                     list($toss, $permission) = explode(':', $permNode);
@@ -178,7 +178,7 @@ 
             }
 
             if ($this->user->root_admin === 1 && isset($data['adminPermissions'])) {
-                foreach($data['adminPermissions'] as $permNode) {
+                foreach ($data['adminPermissions'] as $permNode) {
                     if (!strpos($permNode, ':')) continue;
 
                     list($toss, $permission) = explode(':', $permNode);

Braces +6 added lines, -2 removed lines

@@ -162,7 +162,9 @@ 
             $totalPermissions = 0;
             if (isset($data['permissions'])) {
                 foreach($data['permissions'] as $permNode) {
-                    if (!strpos($permNode, ':')) continue;
+                    if (!strpos($permNode, ':')) {
+                        continue;
+                    }
 
                     list($toss, $permission) = explode(':', $permNode);
                     if (in_array($permission, $this->permissions['user'])) {
@@ -179,7 +181,9 @@ 
 
             if ($this->user->root_admin === 1 && isset($data['adminPermissions'])) {
                 foreach($data['adminPermissions'] as $permNode) {
-                    if (!strpos($permNode, ':')) continue;
+                    if (!strpos($permNode, ':')) {
+                        continue;
+                    }
 
                     list($toss, $permission) = explode(':', $permNode);
                     if (in_array($permission, $this->permissions['admin'])) {

app/Repositories/Daemon/CommandRepository.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
     protected $node;
     protected $client;
 
+    /**
+     * @param Models\Server $server
+     */
     public function __construct($server)
     {
         $this->server = ($server instanceof Models\Server) ? $server : Models\Server::findOrFail($server);

Unused Use Statements -2 removed lines

@@ -25,8 +25,6 @@
 
 use Pterodactyl\Models;
 use Pterodactyl\Exceptions\DisplayException;
-
-use GuzzleHttp\Client;
 use GuzzleHttp\Exception\RequestException;
 
 class CommandRepository {

app/Repositories/Daemon/FileRepository.php

Doc Comments -1 removed lines

@@ -69,7 +69,6 @@
     /**
      * Constructor
      *
-     * @param string $server The server Short UUID
      */
     public function __construct($uuid)
     {

Unused Use Statements -4 removed lines

@@ -24,15 +24,11 @@
 namespace Pterodactyl\Repositories\Daemon;
 
 use \Exception;
-use Log;
-
 use Pterodactyl\Models\Server;
 use Pterodactyl\Models\Node;
 use Pterodactyl\Repositories\HelperRepository;
 use Pterodactyl\Exceptions\DisplayException;
-
 use GuzzleHttp\Client;
-use GuzzleHttp\Exception\RequestException;
 
 class FileRepository
 {

Spacing +7 added lines, -7 removed lines

@@ -98,12 +98,12 @@ 
 
         $file->dirname = (in_array($file->dirname, ['.', './', '/'])) ? null : trim($file->dirname, '/') . '/';
 
-        $res = $this->client->request('GET', '/server/file/stat/' . rawurlencode($file->dirname.$file->basename) , [
+        $res = $this->client->request('GET', '/server/file/stat/' . rawurlencode($file->dirname . $file->basename), [
             'headers' => $this->headers
         ]);
 
         $stat = json_decode($res->getBody());
-        if($res->getStatusCode() !== 200 || !isset($stat->size)) {
+        if ($res->getStatusCode() !== 200 || !isset($stat->size)) {
             throw new DisplayException('The daemon provided a non-200 error code on stat lookup: HTTP\\' . $res->getStatusCode());
         }
 
@@ -115,12 +115,12 @@ 
             throw new DisplayException('That file is too large to open in the browser, consider using a SFTP client.');
         }
 
-        $res = $this->client->request('GET', '/server/file/f/' . rawurlencode($file->dirname.$file->basename) , [
+        $res = $this->client->request('GET', '/server/file/f/' . rawurlencode($file->dirname . $file->basename), [
             'headers' => $this->headers
         ]);
 
         $json = json_decode($res->getBody());
-        if($res->getStatusCode() !== 200 || !isset($json->content)) {
+        if ($res->getStatusCode() !== 200 || !isset($json->content)) {
             throw new DisplayException('The daemon provided a non-200 error code: HTTP\\' . $res->getStatusCode());
         }
 
@@ -152,7 +152,7 @@ 
         $res = $this->client->request('POST', '/server/file/save', [
             'headers' => $this->headers,
             'json' => [
-                'path' => rawurlencode($file->dirname.$file->basename),
+                'path' => rawurlencode($file->dirname . $file->basename),
                 'content' => $content
             ]
         ]);
@@ -183,14 +183,14 @@ 
         ]);
 
         $json = json_decode($res->getBody());
-        if($res->getStatusCode() !== 200) {
+        if ($res->getStatusCode() !== 200) {
             throw new DisplayException('An error occured while attempting to save this file. ' . $res->getBody());
         }
 
         // Iterate through results
         $files = [];
         $folders = [];
-        foreach($json as &$value) {
+        foreach ($json as &$value) {
 
             if ($value->directory === true) {
 

app/Repositories/Daemon/PowerRepository.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
     protected $node;
     protected $client;
 
+    /**
+     * @param Models\Server $server
+     */
     public function __construct($server)
     {
         $this->server = ($server instanceof Models\Server) ? $server : Models\Server::findOrFail($server);

Unused Use Statements -3 removed lines

@@ -26,9 +26,6 @@
 use Pterodactyl\Models;
 use Pterodactyl\Exceptions\DisplayException;
 
-use GuzzleHttp\Client;
-use GuzzleHttp\Exception\RequestException;
-
 class PowerRepository {
 
     protected $server;

Braces +3 added lines, -1 removed lines

@@ -42,7 +42,8 @@ 
         $this->client = Models\Node::guzzleRequest($this->server->node);
     }
 
-    public function do($action)
+    public function do {
+        ($action)
     {
         // We don't use the user's specific daemon secret here since we
         // are assuming that a call to this function has been validated.
@@ -58,6 +59,7 @@ 
                     'action' => $action
                 ]
             ]);
+    }
 
             if ($response->getStatusCode() < 200 || $response->getStatusCode() >= 300) {
                 throw new DisplayException('Power status responded with a non-200 error code.');

app/Repositories/DatabaseRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
      * Updates the password for a given database.
      * @param  int $database The ID of the database to modify.
      * @param  string $password The new password to use for the database.
-     * @return bool
+     * @return boolean|null
      */
     public function modifyPassword($database, $password)
     {

Unused Use Statements -3 removed lines

@@ -24,14 +24,11 @@
 namespace Pterodactyl\Repositories;
 
 use Crypt;
-use Log;
 use DB;
 use Validator;
-
 use Pterodactyl\Models;
 use Pterodactyl\Exceptions\DisplayException;
 use Pterodactyl\Exceptions\DisplayValidationException;
-
 use Illuminate\Database\Capsule\Manager as Capsule;
 
 class DatabaseRepository {

Spacing +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
             ));
 
             DB::commit();
-        } catch(\Exception $ex) {
+        } catch (\Exception $ex) {
             DB::rollback();
             throw $ex;
         }

app/Repositories/LocationRepository.php

Unused Use Statements -1 removed lines

@@ -24,7 +24,6 @@
 namespace Pterodactyl\Repositories;
 
 use Validator;
-
 use Pterodactyl\Models;
 use Pterodactyl\Exceptions\DisplayValidationException;