Improve scheduled task layout and data handling

This commit is contained in:
Dane Everitt 2016-03-18 16:23:10 -04:00
parent c1301c7190
commit 67d9f9f4ab
11 changed files with 639 additions and 0 deletions

View file

@ -0,0 +1,87 @@
<?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\Http\Controllers\Server;
use Alert;
use Log;
use Cron;
use Pterodactyl\Models;
use Pterodactyl\Exceptions\DisplayException;
use Pterodactyl\Exceptions\DisplayValidationException;
use Pterodactyl\Http\Controllers\Controller;
use Illuminate\Http\Request;
class TaskController extends Controller
{
public function __constructor()
{
//
}
public function getIndex(Request $request, $uuid)
{
$server = Models\Server::getByUUID($uuid);
$this->authorize('list-tasks', $server);
return view('server.tasks.index', [
'server' => $server,
'node' => Models\Node::findOrFail($server->node),
'tasks' => Models\Task::where('server', $server->id)->get(),
'actions' => [
'command' => 'Send Command',
'power' => 'Set Power Status'
]
]);
}
public function getNew(Request $request, $uuid)
{
$server = Models\Server::getByUUID($uuid);
$this->authorize('create-task', $server);
return view('server.tasks.new', [
'server' => $server,
'node' => Models\Node::findOrFail($server->node)
]);
}
public function postNew(Request $request, $uuid)
{
dd($request->input());
}
public function getView(Request $request, $uuid, $id)
{
$server = Models\Server::getByUUID($uuid);
$this->authorize('view-task', $server);
return view('server.tasks.view', [
'server' => $server,
'node' => Models\Node::findOrFail($server->node),
'task' => Models\Task::where('id', $id)->where('server', $server->id)->firstOrFail()
]);
}
}

View file

@ -117,6 +117,30 @@ class ServerRoutes {
'uses' => 'Server\SubuserController@deleteSubuser' 'uses' => 'Server\SubuserController@deleteSubuser'
]); ]);
$router->get('tasks/', [
'as' => 'server.tasks',
'uses' => 'Server\TaskController@getIndex'
]);
$router->get('tasks/view/{id}', [
'as' => 'server.tasks.view',
'uses' => 'Server\TaskController@getView'
]);
$router->get('tasks/new', [
'as' => 'server.tasks.new',
'uses' => 'Server\TaskController@getNew'
]);
$router->post('tasks/new', [
'uses' => 'Server\TaskController@postNew'
]);
$router->delete('tasks/delete/{id}', [
'as' => 'server.tasks.delete',
'uses' => 'Server\TaskController@deleteTask'
]);
// Assorted AJAX Routes // Assorted AJAX Routes
$router->group(['prefix' => 'ajax'], function ($server) use ($router) { $router->group(['prefix' => 'ajax'], function ($server) use ($router) {
// Returns Server Status // Returns Server Status

View file

@ -450,4 +450,100 @@ class ServerPolicy
return $user->permissions()->server($server)->permission('view-databases')->exists(); return $user->permissions()->server($server)->permission('view-databases')->exists();
} }
/**
* Check if user has permission to view all tasks for a server.
*
* @param Pterodactyl\Models\User $user
* @param Pterodactyl\Models\Server $server
* @return boolean
*/
public function listTasks(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('list-tasks')->exists();
}
/**
* Check if user has permission to view a specific task for a server.
*
* @param Pterodactyl\Models\User $user
* @param Pterodactyl\Models\Server $server
* @return boolean
*/
public function viewTask(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('view-task')->exists();
}
/**
* 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 boolean
*/
public function toggleTask(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('toggle-task')->exists();
}
/**
* Check if user has permission to queue a task for a server.
*
* @param Pterodactyl\Models\User $user
* @param Pterodactyl\Models\Server $server
* @return boolean
*/
public function queueTask(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('queue-task')->exists();
}
/**
* Check if user has permission to delete a specific task for a server.
*
* @param Pterodactyl\Models\User $user
* @param Pterodactyl\Models\Server $server
* @return boolean
*/
public function deleteTask(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('delete-task')->exists();
}
/**
* Check if user has permission to create a task for a server.
*
* @param Pterodactyl\Models\User $user
* @param Pterodactyl\Models\Server $server
* @return boolean
*/
public function createTask(User $user, Server $server)
{
if ($this->isOwner($user, $server)) {
return true;
}
return $user->permissions()->server($server)->permission('create-task')->exists();
}
} }

View file

@ -79,6 +79,14 @@ class SubuserRepository
'create-subuser' => null, 'create-subuser' => null,
'delete-subuser' => null, 'delete-subuser' => null,
// Tasks
'list-tasks' => null,
'view-task' => null,
'toggle-task' => null,
'delete-task' => null,
'create-task' => null,
'queue-task' => null,
// Management // Management
'set-connection' => null, 'set-connection' => null,
'view-startup' => null, 'view-startup' => null,

View file

@ -0,0 +1,130 @@
<?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\Repositories;
use Cron;
use Validator;
use Pterodactyl\Models;
use Pterodactyl\Exceptions\DisplayValidationException;
use Pterodactyl\Exceptions\DisplayException;
class TaskRepository
{
protected $defaults = [
'year' => '*',
'day_of_week' => '*',
'month' => '*',
'day_of_month' => '*',
'hour' => '*',
'minute' => '*/30',
];
protected $actions = [
'command',
'power',
];
public function __construct()
{
//
}
/**
* Create a new scheduled task for a given server.
* @param int $id
* @param array $data
*
* @throws DisplayException
* @throws DisplayValidationException
* @return void
*/
public function create($id, $data)
{
$server = Models\Server::findOrFail($id);
$validator = Validator::make($data, [
'action' => 'string|required',
'data' => 'string|required',
'year' => 'string|sometimes|required',
'day_of_week' => 'string|sometimes|required',
'month' => 'string|sometimes|required',
'day_of_month' => 'string|sometimes|required',
'hour' => 'string|sometimes|required',
'minute' => 'string|sometimes|required'
]);
if ($validator->fails()) {
throw new DisplayValidationException(json_encode($validator->errors()));
}
if (!in_array($data['action'], $this->actions)) {
throw new DisplayException('The action provided is not valid.');
}
$cron = $this->defaults;
foreach ($this->defaults as $setting => $value) {
if (array_key_exists($setting, $data)) {
$cron[$setting] = $data[$setting];
}
}
// Check that is this a valid Cron Entry
try {
$buildCron = Cron::factory(sprintf('%s %s %s %s %s %s',
$cron['minute'],
$cron['hour'],
$cron['day_of_month'],
$cron['month'],
$cron['day_of_week'],
$cron['year']
));
} catch (\Exception $ex) {
throw new DisplayException($ex);
}
$task = new Models\Task;
$task->fill([
'server' => $server->id,
'active' => 1,
'action' => $data['action'],
'data' => $data['data'],
'queued' => 0,
'year' => $cron['year'],
'day_of_week' => $cron['day_of_week'],
'month' => $cron['month'],
'day_of_month' => $cron['day_of_month'],
'hour' => $cron['hour'],
'minute' => $cron['minute'],
'last_run' => null,
'next_run' => $buildCron->getNextRunDate()
]);
return $task->save();
}
}

View file

@ -0,0 +1,29 @@
<?php
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class AddNullableFieldLastrun extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
$table = DB::getQueryGrammar()->wrapTable('tasks');
DB::statement('ALTER TABLE '.$table.' CHANGE `last_run` `last_run` TIMESTAMP NULL;');
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
$table = DB::getQueryGrammar()->wrapTable('tasks');
DB::statement('ALTER TABLE '.$table.' CHANGE `last_run` `last_run` TIMESTAMP;');
}
}

View file

@ -138,6 +138,11 @@ li.btn.btn-default.pill:active,li.btn.btn-default.pill:focus,li.btn.btn-default.
width: 100%; width: 100%;
} }
.fuelux .input-group-btn .dropdown-menu {
max-height:250px;
overflow-y:scroll;
}
.btn-allocate-delete { .btn-allocate-delete {
height:34px; height:34px;
width:34px; width:34px;
@ -149,3 +154,16 @@ li.btn.btn-default.pill:active,li.btn.btn-default.pill:focus,li.btn.btn-default.
margin-top:22px; margin-top:22px;
} }
} }
.text-disabled {
color: #999;
opacity: 0.8;
}
.text-disabled code {
opacity: 0.6;
}
.text-v-center {
vertical-align: middle !important;
}

View file

@ -193,6 +193,7 @@
<li class="server-index"><a href="/server/{{ $server->uuidShort }}">{{ trans('pagination.sidebar.overview') }}</a></li> <li class="server-index"><a href="/server/{{ $server->uuidShort }}">{{ trans('pagination.sidebar.overview') }}</a></li>
@can('list-files', $server)<li class="server-files"><a href="/server/{{ $server->uuidShort }}/files">{{ trans('pagination.sidebar.files') }}</a></li>@endcan @can('list-files', $server)<li class="server-files"><a href="/server/{{ $server->uuidShort }}/files">{{ trans('pagination.sidebar.files') }}</a></li>@endcan
@can('list-subusers', $server)<li class="server-users"><a href="/server/{{ $server->uuidShort }}/users">{{ trans('pagination.sidebar.subusers') }}</a></li>@endcan @can('list-subusers', $server)<li class="server-users"><a href="/server/{{ $server->uuidShort }}/users">{{ trans('pagination.sidebar.subusers') }}</a></li>@endcan
@can('list-tasks', $server)<li class="server-tasks"><a href="/server/{{ $server->uuidShort }}/tasks">Scheduled Tasks</a></li>@endcan
@can('view-sftp', $server) @can('view-sftp', $server)
<li class="server-settings"><a href="/server/{{ $server->uuidShort }}/settings">{{ trans('pagination.sidebar.manage') }}</a></li> <li class="server-settings"><a href="/server/{{ $server->uuidShort }}/settings">{{ trans('pagination.sidebar.manage') }}</a></li>
@else @else
@ -249,6 +250,7 @@
<a href="/server/{{ $server->uuidShort }}/" class="list-group-item server-index">{{ trans('pagination.sidebar.overview') }}</a> <a href="/server/{{ $server->uuidShort }}/" class="list-group-item server-index">{{ trans('pagination.sidebar.overview') }}</a>
@can('list-files', $server)<a href="/server/{{ $server->uuidShort }}/files" class="list-group-item server-files">{{ trans('pagination.sidebar.files') }}</a>@endcan @can('list-files', $server)<a href="/server/{{ $server->uuidShort }}/files" class="list-group-item server-files">{{ trans('pagination.sidebar.files') }}</a>@endcan
@can('list-subusers', $server)<a href="/server/{{ $server->uuidShort }}/users" class="list-group-item server-users">{{ trans('pagination.sidebar.subusers') }}</a>@endcan @can('list-subusers', $server)<a href="/server/{{ $server->uuidShort }}/users" class="list-group-item server-users">{{ trans('pagination.sidebar.subusers') }}</a>@endcan
@can('list-tasks', $server)<a href="/server/{{ $server->uuidShort }}/tasks" class="list-group-item server-tasks">Scheduled Tasks</a>@endcan
@can('view-sftp', $server) @can('view-sftp', $server)
<a href="/server/{{ $server->uuidShort }}/settings" class="list-group-item server-settings">{{ trans('pagination.sidebar.manage') }}</a> <a href="/server/{{ $server->uuidShort }}/settings" class="list-group-item server-settings">{{ trans('pagination.sidebar.manage') }}</a>
@else @else

View file

@ -0,0 +1,73 @@
{{-- 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. --}}
@extends('layouts.master')
@section('title')
Scheduled Tasks
@endsection
@section('content')
<div class="col-md-12">
<h3 class="nopad">Manage Scheduled Tasks</h3><hr />
<table class="table table-bordered table-hover">
<thead>
<tr>
<th>Action</th>
<th>Data</th>
<th>Last Run</th>
<th>Next Run</th>
@can('delete-task', $server)<th></th>@endcan
@can('toggle-task', $server)<th></th>@endcan
</tr>
</thead>
<tbody>
@foreach($tasks as $task)
<tr @if($task->active === 0)class="text-disabled"@endif>
<td><a href="{{ route('server.tasks.view', [ $server->uuidShort, $task->id ]) }}">{{ $actions[$task->action] }}</a></td>
<td><code>{{ $task->data }}</code></td>
<td>{{ Carbon::parse($task->last_run)->toDayDateTimeString() }} <p class="text-muted"><small>({{ Carbon::parse($task->last_run)->diffForHumans() }})</small></p></td>
<td>
@if($task->active !== 0)
{{ Carbon::parse($task->next_run)->toDayDateTimeString() }} <p class="text-muted"><small>({{ Carbon::parse($task->next_run)->diffForHumans() }})</small></p>
@else
<em>n/a</em>
@endif
</td>
@can('delete-task', $server)
<td class="text-center text-v-center"><a href="#" data-action="delete-task" data-id="{{ $task->id }}"><i class="fa fa-fw fa-trash-o text-danger"></i></a></td>
@endcan
@can('toggle-task', $server)
<td class="text-center text-v-center"><a href="#" data-action="toggle-task" data-id="{{ $task->id }}"><i class="fa fa-fw fa-eye-slash text-primary"></i></a></td>
@endcan
</tr>
@endforeach
</tbody>
</table>
@can('create-task', $server)
<a href="{{ route('server.tasks.new', $server->uuidShort) }}"><button class="btn btn-sm btn-primary">Add Scheduled Task</button></a>
@endcan
</div>
<script>
$(document).ready(function () {
$('.server-tasks').addClass('active');
});
</script>
@endsection

View file

@ -0,0 +1,172 @@
{{-- 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. --}}
@extends('layouts.master')
@section('title')
Scheduled Tasks
@endsection
@section('content')
<div class="col-md-12">
<h3 class="nopad">Create Scheduled Task<br /><small>Current System Time: {{ Carbon::now()->toDayDateTimeString() }}</small></h3><hr />
<form action="{{ route('server.tasks.new', $server->uuidShort) }}" method="POST">
<div class="alert alert-info">You may use either the dropdown selection boxes or enter custom <code>cron</code> variables into the fields below.</div>
<div class="row">
<div class="col-md-6">
<div class="well">
<div class="row">
<div class="form-group col-md-12">
<label class="control-label">Day of Week:</label>
<div>
<select data-action="update-field" data-field="day_of_week" class="form-control" multiple>
<option value="0">Sunday</option>
<option value="1">Monday</option>
<option value="2">Tuesday</option>
<option value="3">Wednesday</option>
<option value="4">Thursday</option>
<option value="5">Friday</option>
<option value="6">Saturday</option>
</select>
</div>
</div>
<div class="form-group col-md-12">
<label class="control-label">Custom Value:</label>
<div>
<input type="text" class="form-control" name="day_of_week" />
</div>
</div>
</div>
</div>
</div>
<div class="col-md-6">
<div class="well">
<div class="row">
<div class="form-group col-md-12">
<label class="control-label">Day of Month:</label>
<div>
<select data-action="update-field" data-field="day_of_month" class="form-control" multiple>
@foreach(range(1, 31) as $i)
<option value="{{ $i }}">{{ $i }}</option>
@endforeach
</select>
</div>
</div>
<div class="form-group col-md-12">
<label class="control-label">Custom Value:</label>
<div>
<input type="text" class="form-control" name="day_of_month" />
</div>
</div>
</div>
</div>
</div>
</div>
<div class="row">
<div class="col-md-6">
<div class="well">
<div class="row">
<div class="form-group col-md-12">
<label class="control-label">Hour:</label>
<div>
<select data-action="update-field" data-field="hour" class="form-control" multiple>
@foreach(range(0, 23) as $i)
<option value="{{ $i }}">{{ str_pad($i, 2, '0', STR_PAD_LEFT) }}:00</option>
@endforeach
</select>
</div>
</div>
<div class="form-group col-md-12">
<label class="control-label">Custom Value:</label>
<div>
<input type="text" class="form-control" name="hour" />
</div>
</div>
</div>
</div>
</div>
<div class="col-md-6">
<div class="well">
<div class="row">
<div class="form-group col-md-12">
<label class="control-label">Minute:</label>
<div>
<select data-action="update-field" data-field="minute" class="form-control" multiple>
@foreach(range(0, 55) as $i)
@if($i % 5 === 0)
<option value="{{ $i }}">_ _:{{ str_pad($i, 2, '0', STR_PAD_LEFT) }}</option>
@endif
@endforeach
</select>
</div>
</div>
<div class="form-group col-md-12">
<label class="control-label">Custom Value:</label>
<div>
<input type="text" class="form-control" name="minute" />
</div>
</div>
</div>
</div>
</div>
</div>
<div class="row">
<div class="form-group col-md-4">
<label class="control-label">Task Type:</label>
<div>
<select name="action" class="form-control">
<option value="command">Send Command</option>
<option value="power">Send Power Action</option>
</select>
</div>
</div>
<div class="form-group col-md-8">
<label class="control-label">Task Payload:</label>
<div>
<input type="text" name="data" class="form-control" value="{{ old('data') }}">
<p class="text-muted"><small>For example, if you selected <code>Send Command</code> enter the command here. If you selected <code>Send Power Option</code> put the power action here (e.g. <code>restart</code>).</small></p>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
{!! csrf_field() !!}
<input type="submit" class="btn btn-success btn-sm" value="Schedule Task" />
</div>
</div>
</form>
</div>
<script>
$(document).ready(function () {
$('.server-tasks').addClass('active');
$('[data-action="update-field"]').on('change', function (event) {
event.preventDefault();
var updateField = $(this).data('field');
var selected = $(this).map(function (i, opt) {
return $(opt).val();
}).toArray();
if (selected.length === $(this).find('option').length) {
$('input[name=' + updateField + ']').val('*');
} else {
$('input[name=' + updateField + ']').val(selected.join(','));
}
});
});
</script>
@endsection