Pterodactyl\Policies\ServerPolicy

Complexity

Total Complexity

44

Size/Duplication

Total Lines	512
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

42 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isOwner()	0	4	1
A	before()	0	6	2
A	power()	0	4	1
A	powerStart()	0	4	1
A	powerStop()	0	4	1
A	powerRestart()	0	4	1
A	powerKill()	0	4	1
A	sendCommand()	0	4	1
A	listFiles()	0	4	1
A	editFiles()	0	4	1
A	saveFiles()	0	4	1
A	moveFiles()	0	4	1
A	copyFiles()	0	4	1
A	compressFiles()	0	4	1
A	decompressFiles()	0	4	1
A	addFiles()	0	4	1
A	uploadFiles()	0	4	1
A	downloadFiles()	0	4	1
A	deleteFiles()	0	4	1
A	listSubusers()	0	4	1
A	viewSubuser()	0	4	1
A	editSubuser()	0	4	1
A	deleteSubuser()	0	4	1
A	createSubuser()	0	4	1
A	setConnection()	0	4	1
A	viewStartup()	0	4	1
A	editStartup()	0	4	1
A	viewSftp()	0	4	1
A	resetSftp()	0	4	1
A	viewSftpPassword()	0	4	1
A	viewDatabases()	0	4	1
A	resetDbPassword()	0	4	1
A	listTasks()	0	4	1
A	viewTask()	0	4	1
A	toggleTask()	0	4	1
A	queueTask()	0	4	1
A	deleteTask()	0	4	1
A	createTask()	0	4	1
A	viewAllocation()	0	4	1
A	setAllocation()	0	4	1
A	checkPermission()	0	8	2

<?php
/**
 * Pterodactyl - Panel
 * Copyright (c) 2015 - 2016 Dane Everitt <dane@daneeveritt.com>.
 *
 * 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.
 */

namespace Pterodactyl\Policies;

use Pterodactyl\Models\User;
use Pterodactyl\Models\Server;

class ServerPolicy
{
    /**
     * Create a new policy instance.
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        //
    }

    /**
     * Determine if current user is the owner of a server.
     *
     * @param  \Pterodactyl\Models\User    $user
     * @param  \Pterodactyl\Models\Server  $server
     * @return bool
     */
    protected function isOwner(User $user, Server $server)
    {
        return $server->owner === $user->id;

The property owner does not exist on object<Pterodactyl\Models\Server>. Since you implemented __get, maybe consider adding a @property annotation.

The property id does not exist on object<Pterodactyl\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * 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  string $ability
     * @return bool
     */
    public function before(User $user, $ability)

The parameter $ability is not used and could be removed.

    {
        if ($user->root_admin === 1) {

The property root_admin does not exist on object<Pterodactyl\Models\User>. Since you implemented __get, maybe consider adding a @property annotation.

            return true;
        }
    }

    /**
     * Check if user has permission to control power for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function power(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'power');
    }

    /**
     * Check if user has permission to start a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function powerStart(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'power-start');
    }

    /**
     * Check if user has permission to stop a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function powerStop(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'power-stop');
    }

    /**
     * Check if user has permission to restart a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function powerRestart(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'power-restart');
    }

    /**
     * Check if user has permission to kill a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function powerKill(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'power-kill');
    }

    /**
     * Check if user has permission to run a command on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function sendCommand(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'send-command');
    }

    /**
     * Check if user has permission to list files on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function listFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'list-files');
    }

    /**
     * Check if user has permission to edit files on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function editFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'edit-files');
    }

    /**
     * Check if user has permission to save files on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function saveFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'save-files');
    }

    /**
     * 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
     * @return bool
     */
    public function moveFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'move-files');
    }

    /**
     * Check if user has permission to copy folders and files on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function copyFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'copy-files');
    }

    /**
     * Check if user has permission to compress files and folders on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function compressFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'compress-files');
    }

    /**
     * Check if user has permission to decompress files on a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function decompressFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'decompress-files');
    }

    /**
     * Check if user has permission to add files to a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function addFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'add-files');
    }

    /**
     * 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
     * @return bool
     */
    public function uploadFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'upload-files');
    }

    /**
     * Check if user has permission to download files from a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function downloadFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'download-files');
    }

    /**
     * Check if user has permission to delete files from a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function deleteFiles(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'delete-files');
    }

    /**
     * Check if user has permission to view subusers for the server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function listSubusers(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'list-subusers');
    }

    /**
     * Check if user has permission to view specific subuser permissions.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewSubuser(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-subuser');
    }

    /**
     * Check if user has permission to edit a subuser.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function editSubuser(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'edit-subuser');
    }

    /**
     * Check if user has permission to delete a subuser.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function deleteSubuser(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'delete-subuser');
    }

    /**
     * Check if user has permission to edit a subuser.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function createSubuser(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'create-subuser');
    }

    /**
     * Check if user has permission to set the default connection for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function setConnection(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'set-connection');
    }

    /**
     * Check if user has permission to view the startup command used for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewStartup(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-startup');
    }

    /**
     * Check if user has permission to edit the startup command used for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function editStartup(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'edit-startup');
    }

    /**
     * Check if user has permission to view the SFTP information for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewSftp(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-sftp');
    }

    /**
     * Check if user has permission to reset the SFTP password for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function resetSftp(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'reset-sftp');
    }

    /**
     * Check if user has permission to view the SFTP password for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewSftpPassword(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-sftp-password');
    }

    /**
     * Check if user has permission to view databases for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewDatabases(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-databases');
    }

    /**
     * Check if user has permission to reset database passwords.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function resetDbPassword(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'reset-db-password');
    }

    /**
     * Check if user has permission to view all tasks for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function listTasks(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'list-tasks');
    }

    /**
     * Check if user has permission to view a specific task for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewTask(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-task');
    }

    /**
     * Check if user has permission to view a toggle a task for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function toggleTask(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'toggle-task');
    }

    /**
     * Check if user has permission to queue a task for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function queueTask(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'queue-task');
    }

    /**
     * Check if user has permission to delete a specific task for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function deleteTask(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'delete-task');
    }

    /**
     * Check if user has permission to create a task for a server.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function createTask(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'create-task');
    }

    /**
     * Check if user has permission to view server allocations.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function viewAllocation(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'view-allocation');
    }

    /**
     * Check if user has permission to set the default allocation.
     *
     * @param  \Pterodactyl\Models\User   $user
     * @param  \Pterodactyl\Models\Server $server
     * @return bool
     */
    public function setAllocation(User $user, Server $server)
    {
        return $this->checkPermission($user, $server, 'set-allocation');
    }

    /**
     * Checks if the user has the given permission on/for the server.
     *
     * @param \Pterodactyl\Models\User   $user
     * @param \Pterodactyl\Models\Server $server
     * @param $permission
     * @return bool
     */
    private function checkPermission(User $user, Server $server, $permission)
    {
        if ($this->isOwner($user, $server)) {
            return true;
        }

        return $user->permissions()->server($server)->permission($permission)->exists();
    }
}