Files
Grav-Admin-Plugin/admin.php

1015 lines
34 KiB
PHP
Raw Normal View History

2014-08-05 13:06:38 -07:00
<?php
namespace Grav\Plugin;
use Composer\Autoload\ClassLoader;
use Grav\Common\Cache;
use Grav\Common\Debugger;
2015-12-10 12:07:36 +01:00
use Grav\Common\File\CompiledYamlFile;
use Grav\Common\Grav;
2019-01-31 18:39:38 -07:00
use Grav\Common\Helpers\LogViewer;
use Grav\Common\Inflector;
use Grav\Common\Language\Language;
use Grav\Common\Page\Interfaces\PageInterface;
use Grav\Common\Page\Page;
use Grav\Common\Page\Pages;
use Grav\Common\Plugin;
2018-12-05 08:20:38 +02:00
use Grav\Common\Session;
use Grav\Common\Uri;
use Grav\Common\User\Interfaces\UserCollectionInterface;
use Grav\Common\Utils;
use Grav\Framework\Session\Exceptions\SessionException;
use Grav\Plugin\Admin\Admin;
use Grav\Plugin\Admin\Popularity;
use Grav\Plugin\Admin\Themes;
use Grav\Plugin\Admin\AdminController;
2018-05-10 10:14:18 +03:00
use Grav\Plugin\Admin\Twig\AdminTwigExtension;
use Grav\Plugin\Form\Form;
2017-08-31 12:46:51 -06:00
use Grav\Plugin\Login\Login;
use RocketTheme\Toolbox\Event\Event;
2014-08-05 13:06:38 -07:00
class AdminPlugin extends Plugin
{
2016-01-22 10:42:38 +02:00
public $features = [
'blueprints' => 1000,
];
/** @var bool */
2014-08-05 13:06:38 -07:00
protected $active = false;
/** @var string */
2014-08-05 13:06:38 -07:00
protected $template;
/** @var string */
2014-09-03 22:22:03 -06:00
protected $theme;
/** @var string */
2014-08-05 13:06:38 -07:00
protected $route;
/** @var string */
2016-09-27 18:21:11 +03:00
protected $admin_route;
/** @var Uri */
2014-08-05 13:06:38 -07:00
protected $uri;
/** @var Admin */
2014-08-05 13:06:38 -07:00
protected $admin;
/** @var Session */
2014-10-01 22:28:16 +03:00
protected $session;
/** @var Popularity */
protected $popularity;
/** @var string */
2014-10-01 22:28:16 +03:00
protected $base;
/** @var string */
2016-04-26 12:57:29 -06:00
protected $version;
/**
* @return array
*/
public static function getSubscribedEvents()
{
2017-09-25 17:10:54 -06:00
return [
'onPluginsInitialized' => [
['autoload', 100001],
['setup', 100000],
['onPluginsInitialized', 1001]
],
2017-09-25 17:10:54 -06:00
'onPageInitialized' => ['onPageInitialized', 0],
'onFormProcessed' => ['onFormProcessed', 0],
'onShutdown' => ['onShutdown', 1000],
2017-09-25 17:10:54 -06:00
'onAdminDashboard' => ['onAdminDashboard', 0],
'onAdminTools' => ['onAdminTools', 0],
];
2015-12-10 12:07:36 +01:00
}
/**
* Get list of form field types specified in this plugin. Only special types needs to be listed.
*
* @return array
*/
public function getFormFieldTypes()
{
return [
'column' => [
'input@' => false
],
'columns' => [
'input@' => false
],
'fieldset' => [
'input@' => false
],
'section' => [
'input@' => false
],
'list' => [
'array' => true
],
'file' => [
'array' => true
]
];
}
/**
* [onPluginsInitialized:100000] Composer autoload.
*
* @return ClassLoader
*/
public function autoload()
{
return require __DIR__ . '/vendor/autoload.php';
}
2015-12-10 11:02:19 -07:00
/**
* [onPluginsInitialized:100000]
*
2015-12-10 11:02:19 -07:00
* If the admin path matches, initialize the Login plugin configuration and set the admin
* as active.
*/
public function setup()
{
$route = $this->config->get('plugins.admin.route');
if (!$route) {
return;
}
$this->base = '/' . trim($route, '/');
2016-09-27 18:21:11 +03:00
$this->admin_route = rtrim($this->grav['pages']->base(), '/') . $this->base;
$this->uri = $this->grav['uri'];
2015-12-10 11:02:19 -07:00
2017-08-31 12:46:51 -06:00
$users_exist = Admin::doAnyUsersExist();
2015-12-10 11:02:19 -07:00
// If no users found, go to register
2017-08-31 12:46:51 -06:00
if (!$users_exist) {
if (!$this->isAdminPath()) {
2016-09-27 18:21:11 +03:00
$this->grav->redirect($this->admin_route);
2015-12-10 11:02:19 -07:00
}
$this->template = 'register';
2015-12-10 11:02:19 -07:00
}
// Only activate admin if we're inside the admin path.
if ($this->isAdminPath()) {
try {
$this->grav['session']->init();
} catch (SessionException $e) {
$this->grav['session']->init();
$message = 'Session corruption detected, restarting session...';
/** @var Debugger $debugger */
$debugger = $this->grav['debugger'];
$debugger->addMessage($message);
$this->grav['messages']->add($message, 'error');
}
2015-12-10 11:02:19 -07:00
$this->active = true;
// Set cache based on admin_cache option
$this->grav['cache']->setEnabled($this->config->get('plugins.admin.cache_enabled'));
$pages = $this->grav['pages'];
if (method_exists($pages, 'setCheckMethod')) {
// Force file hash checks to fix caching on moved and deleted pages.
$pages->setCheckMethod('hash');
}
2015-12-10 11:02:19 -07:00
}
}
2015-12-10 12:07:36 +01:00
/**
* [onPluginsInitialized:1001]
2015-12-10 12:07:36 +01:00
*
* If the admin plugin is set as active, initialize the admin
2015-12-10 12:07:36 +01:00
*/
public function onPluginsInitialized()
2015-12-10 12:07:36 +01:00
{
// Only activate admin if we're inside the admin path.
if ($this->active) {
// Store this version.
$this->version = $this->getBlueprint()->get('version');
// Have a unique Admin-only Cache key
if (method_exists($this->grav['cache'], 'setKey')) {
/** @var Cache $cache */
$cache = $this->grav['cache'];
$cache_key = $cache->getKey();
$cache->setKey($cache_key . '$');
}
// Turn on Twig autoescaping
if (method_exists($this->grav['twig'], 'setAutoescape') && $this->grav['uri']->param('task') !== 'processmarkdown') {
$this->grav['twig']->setAutoescape(true);
}
$this->grav['debugger']->addMessage('Admin v' . $this->version);
$this->initializeAdmin();
// Disable Asset pipelining (old method - remove this after Grav is updated)
if (!method_exists($this->grav['assets'], 'setJsPipeline')) {
$this->config->set('system.assets.css_pipeline', false);
$this->config->set('system.assets.js_pipeline', false);
}
// Replace themes service with admin.
$this->grav['themes'] = function () {
return new Themes($this->grav);
};
}
// We need popularity no matter what
$this->popularity = new Popularity();
// Fire even to register permissions from other plugins
$this->grav->fireEvent('onAdminRegisterPermissions', new Event(['admin' => $this->admin]));
}
/**
* [onPageInitialized:0]
*/
public function onPageInitialized()
{
$page = $this->grav['page'];
$template = $this->grav['uri']->param('tmpl');
if ($template) {
$page->template($template);
}
2015-12-10 12:07:36 +01:00
}
/**
* [onFormProcessed:0]
*
2015-12-10 12:07:36 +01:00
* Process the admin registration form.
*
* @param Event $event
*/
public function onFormProcessed(Event $event)
{
$form = $event['form'];
$action = $event['action'];
switch ($action) {
case 'register_admin_user':
2017-08-31 12:46:51 -06:00
if (Admin::doAnyUsersExist()) {
throw new \RuntimeException('A user account already exists, please create an admin account manually.');
}
2015-12-10 12:07:36 +01:00
if (!$this->config->get('plugins.login.enabled')) {
throw new \RuntimeException($this->grav['language']->translate('PLUGIN_LOGIN.PLUGIN_LOGIN_DISABLED'));
}
$data = [];
$username = $form->value('username');
2018-05-10 10:14:18 +03:00
if ($form->value('password1') !== $form->value('password2')) {
2016-07-07 18:55:52 +02:00
$this->grav->fireEvent('onFormValidationError', new Event([
'form' => $form,
2015-12-10 12:07:36 +01:00
'message' => $this->grav['language']->translate('PLUGIN_LOGIN.PASSWORDS_DO_NOT_MATCH')
]));
$event->stopPropagation();
2016-07-07 18:55:52 +02:00
2015-12-10 12:07:36 +01:00
return;
}
2015-12-10 12:07:36 +01:00
$data['password'] = $form->value('password1');
$fields = [
'email',
'fullname',
'title'
];
2016-07-07 18:55:52 +02:00
foreach ($fields as $field) {
2015-12-10 12:07:36 +01:00
// Process value of field if set in the page process.register_user
if (!isset($data[$field]) && $form->value($field)) {
$data[$field] = $form->value($field);
}
}
2018-05-10 10:14:18 +03:00
// Don't store plain text password or username (part of the filename).
unset($data['password1'], $data['password2'], $data['username']);
2015-12-10 12:07:36 +01:00
2015-12-11 10:34:40 -07:00
// Extra lowercase to ensure file is saved lowercase
$username = strtolower($username);
$inflector = new Inflector();
2018-12-05 08:20:38 +02:00
$data['fullname'] = $data['fullname'] ?? $inflector->titleize($username);
$data['title'] = $data['title'] ?? 'Administrator';
2015-12-10 12:07:36 +01:00
$data['state'] = 'enabled';
$data['access'] = ['admin' => ['login' => true, 'super' => true], 'site' => ['login' => true]];
/** @var UserCollectionInterface $users */
$users = $this->grav['accounts'];
2016-07-07 18:55:52 +02:00
// Create user object and save it
$user = $users->load($username);
2018-12-04 15:36:21 +02:00
$user->update($data);
$user->save();
2015-12-10 12:07:36 +01:00
//Login user
$this->grav['session']->user = $user;
unset($this->grav['user']);
$this->grav['user'] = $user;
2017-08-31 12:46:51 -06:00
$user->authenticated = true;
$user->authorized = $user->authorize('admin.login');
2015-12-10 12:07:36 +01:00
$messages = $this->grav['messages'];
$messages->add($this->grav['language']->translate('PLUGIN_ADMIN.LOGIN_LOGGED_IN'), 'info');
2016-09-27 18:21:11 +03:00
$this->grav->redirect($this->admin_route);
2015-12-10 12:07:36 +01:00
break;
}
}
/**
* [onShutdown:1000]
*
* Handles the shutdown
*/
public function onShutdown()
{
if ($this->active) {
//only activate when Admin is active
if ($this->admin->shouldLoadAdditionalFilesInBackground()) {
$this->admin->loadAdditionalFilesInBackground();
}
} else {
//if popularity is enabled, track non-admin hits
if ($this->config->get('plugins.admin.popularity.enabled')) {
$this->popularity->trackHit();
}
2014-08-05 13:06:38 -07:00
}
}
2014-09-09 14:03:01 -06:00
/**
* [onAdminDashboard:0]
*/
public function onAdminDashboard()
{
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = ['template' => 'dashboard-maintenance'];
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = ['template' => 'dashboard-statistics'];
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = ['template' => 'dashboard-notifications'];
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = ['template' => 'dashboard-feed'];
$this->grav['twig']->plugins_hooked_dashboard_widgets_main[] = ['template' => 'dashboard-pages'];
2014-08-05 13:06:38 -07:00
}
/**
* [onAdminTools:0]
*
* Provide the tools for the Tools page, currently only direct install
*
* @return Event
*/
public function onAdminTools(Event $event)
2016-07-07 18:55:52 +02:00
{
$event['tools'] = array_merge($event['tools'], [
2019-02-08 13:53:11 -07:00
'backups' => [['admin.maintenance', 'admin.super'], $this->grav['language']->translate('PLUGIN_ADMIN.BACKUPS')],
'scheduler' => [['admin.super'], $this->grav['language']->translate('PLUGIN_ADMIN.SCHEDULER')],
'logs' => [['admin.super'], $this->grav['language']->translate('PLUGIN_ADMIN.LOGS')],
'reports' => [['admin.super'], $this->grav['language']->translate('PLUGIN_ADMIN.REPORTS')],
'direct-install' => [['admin.super'], $this->grav['language']->translate('PLUGIN_ADMIN.DIRECT_INSTALL')],
]);
return $event;
}
2014-08-05 13:06:38 -07:00
/**
* Sets longer path to the home page allowing us to have list of pages when we enter to pages section.
*/
public function onPagesInitialized()
2014-08-05 13:06:38 -07:00
{
$config = $this->config;
// Force SSL with redirect if required
if ($config->get('system.force_ssl')) {
if (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] !== 'on') {
$url = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
$this->grav->redirect($url);
}
}
$this->session = $this->grav['session'];
2014-08-05 13:06:38 -07:00
// Set original route for the home page.
$home = '/' . trim($this->config->get('system.home.alias'), '/');
// set session variable if it's passed via the url
2018-05-10 10:14:18 +03:00
if ($this->uri->param('mode') === 'expert') {
$this->session->expert = true;
2018-05-10 10:14:18 +03:00
} elseif ($this->uri->param('mode') === 'normal') {
$this->session->expert = false;
2018-12-05 08:20:38 +02:00
} else {
// set the default if not set before
$this->session->expert = $this->session->expert ?? false;
}
2014-08-05 13:06:38 -07:00
/** @var Pages $pages */
$pages = $this->grav['pages'];
$this->grav['admin']->routes = $pages->routes();
// Remove default route from routes.
if (isset($this->grav['admin']->routes['/'])) {
unset($this->grav['admin']->routes['/']);
}
$page = $pages->dispatch('/', true);
// If page is null, the default page does not exist, and we cannot route to it
if ($page) {
$page->route($home);
}
2014-08-05 13:06:38 -07:00
// Make local copy of POST.
$post = $this->grav['uri']->post();
2014-08-05 13:06:38 -07:00
2018-10-04 16:30:07 -06:00
// Initialize Page Types
Pages::types();
2014-08-05 13:06:38 -07:00
// Handle tasks.
2018-12-05 08:20:38 +02:00
$this->admin->task = $task = $this->grav['task'];
2014-08-05 13:06:38 -07:00
if ($task) {
$this->initializeController($task, $post);
2018-05-10 10:14:18 +03:00
} elseif ($this->template === 'logs' && $this->route) {
2014-08-05 13:06:38 -07:00
// Display RAW error message.
echo $this->admin->logEntry();
exit();
}
$self = $this;
2014-08-05 13:06:38 -07:00
2015-12-09 21:37:34 -07:00
// make sure page is not frozen!
unset($this->grav['page']);
$this->admin->pagesCount();
// Replace page service with admin.
$this->grav['page'] = function () use ($self) {
$page = new Page();
$page->expires(0);
if ($this->grav['user']->authorize('admin.login')) {
$event = new Event(['page' => $page]);
$event = $this->grav->fireEvent('onAdminPage', $event);
$page = $event['page'];
if ($page->slug()) {
return $page;
}
}
// Look in the pages provided by the Admin plugin itself
if (file_exists(__DIR__ . "/pages/admin/{$self->template}.md")) {
$page->init(new \SplFileInfo(__DIR__ . "/pages/admin/{$self->template}.md"));
$page->slug(basename($self->template));
return $page;
}
2017-04-11 09:47:12 +02:00
// If not provided by Admin, lookup pages added by other plugins
$plugins = $this->grav['plugins'];
$locator = $this->grav['locator'];
2016-07-07 18:55:52 +02:00
foreach ($plugins as $plugin) {
if ($this->config->get("plugins.{$plugin->name}.enabled") !== true) {
continue;
}
2016-07-07 18:55:52 +02:00
$path = $locator->findResource("user://plugins/{$plugin->name}/admin/pages/{$self->template}.md");
2015-10-26 21:30:33 +01:00
if ($path) {
2015-10-26 21:30:33 +01:00
$page->init(new \SplFileInfo($path));
$page->slug(basename($self->template));
2016-07-07 18:55:52 +02:00
2015-10-26 21:30:33 +01:00
return $page;
}
}
2016-01-21 09:46:38 +02:00
return null;
};
if (empty($this->grav['page'])) {
if ($this->grav['user']->authenticated) {
$event = new Event(['page' => null]);
$event->page = null;
$event = $this->grav->fireEvent('onPageNotFound', $event);
/** @var PageInterface $page */
$page = $event->page;
if (!$page || !$page->routable()) {
$error_file = $this->grav['locator']->findResource('plugins://admin/pages/admin/error.md');
$page = new Page();
$page->init(new \SplFileInfo($error_file));
$page->slug(basename($this->route));
$page->routable(true);
}
unset($this->grav['page']);
$this->grav['page'] = $page;
} else {
// Not Found and not logged in: Display login page.
$login_file = $this->grav['locator']->findResource('plugins://admin/pages/admin/login.md');
$page = new Page();
$page->init(new \SplFileInfo($login_file));
$page->slug(basename($this->route));
unset($this->grav['page']);
$this->grav['page'] = $page;
}
}
// Explicitly set a timestamp on assets
2016-07-07 18:55:52 +02:00
$this->grav['assets']->setTimestamp(substr(md5(GRAV_VERSION . $this->grav['config']->checksum()), 0, 10));
2014-08-05 13:06:38 -07:00
}
2016-01-10 17:17:04 +01:00
/**
* Handles initializing the assets
*/
public function onAssetsInitialized()
{
// Disable Asset pipelining
$assets = $this->grav['assets'];
$assets->setJsPipeline(false);
$assets->setCssPipeline(false);
}
2014-08-05 13:06:38 -07:00
/**
* Add twig paths to plugin templates.
*/
public function onTwigTemplatePaths()
2014-08-05 13:06:38 -07:00
{
$twig_paths = [];
$this->grav->fireEvent('onAdminTwigTemplatePaths', new Event(['paths' => &$twig_paths]));
$twig_paths[] = __DIR__ . '/themes/' . $this->theme . '/templates';
$this->grav['twig']->twig_paths = $twig_paths;
2014-08-05 13:06:38 -07:00
}
/**
* Set all twig variables for generating output.
*/
public function onTwigSiteVariables()
2014-08-05 13:06:38 -07:00
{
$twig = $this->grav['twig'];
2017-04-13 14:50:27 -06:00
$page = $this->grav['page'];
2014-08-05 13:06:38 -07:00
$twig->twig_vars['location'] = $this->template;
$twig->twig_vars['base_url_relative_frontend'] = $twig->twig_vars['base_url_relative'] ?: '/';
2016-09-27 18:21:11 +03:00
$twig->twig_vars['admin_route'] = trim($this->admin_route, '/');
2019-02-11 14:33:48 -07:00
$twig->twig_vars['template_route'] = $this->template;
2018-05-23 22:33:08 +03:00
$twig->twig_vars['current_route'] = '/' . $twig->twig_vars['admin_route'] . '/' . $this->template . '/' . $this->route;
2016-07-07 18:55:52 +02:00
$twig->twig_vars['base_url_relative'] = $twig->twig_vars['base_url_simple'] . '/' . $twig->twig_vars['admin_route'];
$twig->twig_vars['current_url'] = rtrim($twig->twig_vars['base_url_relative'] . '/' . $this->template . '/' . $this->route, '/');
2016-07-15 17:39:13 +02:00
$theme_url = '/' . ltrim($this->grav['locator']->findResource('plugin://admin/themes/' . $this->theme,
false), '/');
$twig->twig_vars['theme_url'] = $theme_url;
2019-01-10 17:32:46 -07:00
$twig->twig_vars['preset_url'] = $twig->twig_vars['preset_url'] ?? $theme_url;
2014-08-29 11:59:43 +03:00
$twig->twig_vars['base_url'] = $twig->twig_vars['base_url_relative'];
$twig->twig_vars['base_path'] = GRAV_ROOT;
2014-08-05 13:06:38 -07:00
$twig->twig_vars['admin'] = $this->admin;
2016-04-26 12:57:29 -06:00
$twig->twig_vars['admin_version'] = $this->version;
2019-01-31 18:39:38 -07:00
$twig->twig_vars['logviewer'] = new LogViewer();
2019-03-12 06:51:53 -06:00
$twig->twig_vars['form_max_filesize'] = Utils::getUploadLimit() / 1024 / 1024;
2014-08-05 13:06:38 -07:00
$fa_icons_file = CompiledYamlFile::instance($this->grav['locator']->findResource('plugin://admin/themes/grav/templates/forms/fields/iconpicker/icons' . YAML_EXT));
$fa_icons = $fa_icons_file->content();
$fa_icons = array_map(function ($icon) {
//only pick used values
return ['id' => $icon['id'], 'unicode' => $icon['unicode']];
}, $fa_icons['icons']);
$twig->twig_vars['fa_icons'] = $fa_icons;
2017-04-13 14:50:27 -06:00
// add form if it exists in the page
$header = $page->header();
$forms = [];
if (isset($header->forms)) foreach ($header->forms as $key => $form) {
$forms[$key] = new Form($page, null, $form);
}
$twig->twig_vars['forms'] = $forms;
// preserve form validation
if (!isset($twig->twig_vars['form'])) {
if (isset($header->form)) {
$twig->twig_vars['form'] = new Form($page);
} elseif (isset($header->forms)) {
$twig->twig_vars['form'] = new Form($page, null, reset($header->forms));
}
2017-04-13 14:50:27 -06:00
}
// Gather Plugin-hooked nav items
2015-10-26 21:30:33 +01:00
$this->grav->fireEvent('onAdminMenu');
2014-08-05 13:06:38 -07:00
switch ($this->template) {
case 'dashboard':
$twig->twig_vars['popularity'] = $this->popularity;
// Gather Plugin-hooked dashboard items
$this->grav->fireEvent('onAdminDashboard');
2014-08-05 13:06:38 -07:00
break;
}
2017-12-01 16:08:52 -07:00
$flashData = $this->grav['session']->getFlashCookieObject(Admin::TMP_COOKIE_NAME);
if (isset($flashData->message)) {
$this->grav['messages']->add($flashData->message, $flashData->status);
}
2014-08-05 13:06:38 -07:00
}
2014-09-03 22:22:03 -06:00
// Add images to twig template paths to allow inclusion of SVG files
public function onTwigLoader()
{
$theme_paths = Grav::instance()['locator']->findResources('plugins://admin/themes/' . $this->theme . '/images');
foreach($theme_paths as $images_path) {
$this->grav['twig']->addPath($images_path, 'admin-images');
}
}
/**
* Add the Admin Twig Extensions
*/
public function onTwigExtensions()
{
require_once __DIR__ . '/classes/Twig/AdminTwigExtension.php';
$this->grav['twig']->twig->addExtension(new AdminTwigExtension);
}
public function onAdminAfterSave(Event $event)
2014-09-03 22:22:03 -06:00
{
// Special case to redirect after changing the admin route to avoid 'breaking'
$obj = $event['object'];
2014-09-03 22:22:03 -06:00
if (null !== $obj && method_exists($obj, 'blueprints')) {
$blueprint = $obj->blueprints()->getFilename();
if ($blueprint === 'admin/blueprints' && isset($obj->route) && $this->admin_route !== $obj->route) {
$redirect = preg_replace('/^' . str_replace('/','\/',$this->admin_route) . '/',$obj->route,$this->uri->path());
$this->grav->redirect($redirect);
}
}
}
/**
* Convert some types where we want to process out of the standard config path
*
* @param Event $e
*/
public function onAdminData(Event $e)
{
$type = $e['type'] ?? null;
switch ($type) {
case 'tools/scheduler':
$e['type'] = 'config/scheduler';
break;
case 'tools':
case 'tools/backups':
$e['type'] = 'config/backups';
break;
}
}
public function onOutputGenerated()
{
// Clear flash objects for previously uploaded files whenever the user switches page or reloads
// ignoring any JSON / extension call
if ($this->admin->task !== 'save' && empty($this->uri->extension())) {
// Discard any previously uploaded files session and remove all uploaded files.
if ($flash = $this->session->getFlashObject('files-upload')) {
$flash = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($flash));
foreach ($flash as $key => $value) {
if ($key !== 'tmp_name') {
continue;
}
@unlink($value);
}
}
}
}
/**
* Initial stab at registering permissions (WIP)
*
* @param Event $e
*/
public function onAdminRegisterPermissions(Event $e)
{
$admin = $e['admin'];
$permissions = [
'admin.super' => 'boolean',
'admin.login' => 'boolean',
'admin.cache' => 'boolean',
'admin.configuration' => 'boolean',
'admin.configuration_system' => 'boolean',
'admin.configuration_site' => 'boolean',
'admin.configuration_media' => 'boolean',
'admin.configuration_info' => 'boolean',
'admin.settings' => 'boolean',
'admin.pages' => 'boolean',
'admin.maintenance' => 'boolean',
'admin.statistics' => 'boolean',
'admin.plugins' => 'boolean',
'admin.themes' => 'boolean',
'admin.tools' => 'boolean',
'admin.users' => 'boolean',
];
$admin->addPermissions($permissions);
}
/**
* Check if the current route is under the admin path
*
* @return bool
*/
public function isAdminPath()
{
$route = $this->uri->route();
return $route === $this->base || 0 === strpos($route, $this->base . '/');
}
/**
* Helper function to replace Pages::Types()
* and to provide an event to manipulate the data
*
* Dispatches 'onAdminPageTypes' event
* with 'types' data member which is a
* reference to the data
*/
public static function pagesTypes()
{
$types = Pages::types();
// First filter by configuration
$hideTypes = Grav::instance()['config']->get('plugins.admin.hide_page_types', []);
foreach ((array) $hideTypes as $type) {
unset($types[$type]);
}
// Allow manipulating of the data by event
$e = new Event(['types' => &$types]);
Grav::instance()->fireEvent('onAdminPageTypes', $e);
return $types;
}
/**
* Helper function to replace Pages::modularTypes()
* and to provide an event to manipulate the data
*
* Dispatches 'onAdminModularPageTypes' event
* with 'types' data member which is a
* reference to the data
*/
public static function pagesModularTypes()
{
$types = Pages::modularTypes();
// First filter by configuration
$hideTypes = (array) Grav::instance()['config']->get('plugins.admin.hide_modular_page_types', []);
foreach ($hideTypes as $type) {
unset($types[$type]);
}
// Allow manipulating of the data by event
$e = new Event(['types' => &$types]);
Grav::instance()->fireEvent('onAdminModularPageTypes', $e);
return $types;
}
/**
* Validate a value. Currently validates
*
* - 'user' for username format and username availability.
* - 'password1' for password format
* - 'password2' for equality to password1
*
* @param string $type The field type
* @param string $value The field value
* @param string $extra Any extra value required
*
* @return bool
*/
protected function validate($type, $value, $extra = '')
{
/** @var Login $login */
$login = $this->grav['login'];
return $login->validateField($type, $value, $extra);
}
protected function initializeController($task, $post)
{
$controller = new AdminController();
$controller->initialize($this->grav, $this->template, $task, $this->route, $post);
$controller->execute();
$controller->redirect();
}
/**
* Initialize the admin.
*
* @throws \RuntimeException
*/
protected function initializeAdmin()
{
$this->enable([
'onTwigExtensions' => ['onTwigExtensions', 1000],
'onPagesInitialized' => ['onPagesInitialized', 1000],
'onTwigLoader' => ['onTwigLoader', 1000],
'onTwigTemplatePaths' => ['onTwigTemplatePaths', 1000],
'onTwigSiteVariables' => ['onTwigSiteVariables', 1000],
'onAssetsInitialized' => ['onAssetsInitialized', 1000],
'onAdminRegisterPermissions' => ['onAdminRegisterPermissions', 0],
'onOutputGenerated' => ['onOutputGenerated', 0],
'onAdminAfterSave' => ['onAdminAfterSave', 0],
'onAdminData' => ['onAdminData', 0],
]);
// Autoload classes
require_once __DIR__ . '/vendor/autoload.php';
2015-07-27 12:56:16 -06:00
// Check for required plugins
2016-07-07 18:55:52 +02:00
if (!$this->grav['config']->get('plugins.login.enabled') || !$this->grav['config']->get('plugins.form.enabled') || !$this->grav['config']->get('plugins.email.enabled')) {
2015-07-27 12:56:16 -06:00
throw new \RuntimeException('One of the required plugins is missing or not enabled');
}
// Initialize Admin Language if needed
/** @var Language $language */
$language = $this->grav['language'];
if ($language->enabled() && empty($this->grav['session']->admin_lang)) {
$this->grav['session']->admin_lang = $language->getLanguage();
}
// Decide admin template and route.
$path = trim(substr($this->uri->route(), strlen($this->base)), '/');
2015-12-10 11:02:19 -07:00
if (empty($this->template)) {
$this->template = 'dashboard';
}
// Can't access path directly...
2018-05-10 10:14:18 +03:00
if ($path && $path !== 'register') {
$array = explode('/', $path, 2);
$this->template = array_shift($array);
$this->route = array_shift($array);
}
2014-09-03 22:22:03 -06:00
// Initialize admin class (also registers it to Grav services).
2016-09-27 18:21:11 +03:00
$this->admin = new Admin($this->grav, $this->admin_route, $this->template, $this->route);
// Double check we have system.yaml, site.yaml etc
$config_path = $this->grav['locator']->findResource('user://config');
2018-12-05 08:20:38 +02:00
foreach ($this->admin::configurations() as $config_file) {
$config_file = "{$config_path}/{$config_file}.yaml";
if (!file_exists($config_file)) {
touch($config_file);
}
}
// Get theme for admin
$this->theme = $this->config->get('plugins.admin.theme', 'grav');
$assets = $this->grav['assets'];
2016-07-07 18:55:52 +02:00
$translations = 'this.GravAdmin = this.GravAdmin || {}; if (!this.GravAdmin.translations) this.GravAdmin.translations = {}; ' . PHP_EOL . 'this.GravAdmin.translations.PLUGIN_ADMIN = {';
// Enable language translations
$translations_actual_state = $this->config->get('system.languages.translations');
$this->config->set('system.languages.translations', true);
2016-07-07 18:55:52 +02:00
$strings = [
'EVERYTHING_UP_TO_DATE',
'UPDATES_ARE_AVAILABLE',
'IS_AVAILABLE_FOR_UPDATE',
'AND',
'IS_NOW_AVAILABLE',
'CURRENT',
'UPDATE_GRAV_NOW',
'TASK_COMPLETED',
'UPDATE',
'UPDATING_PLEASE_WAIT',
'GRAV_SYMBOLICALLY_LINKED',
'OF_YOUR',
'OF_THIS',
'HAVE_AN_UPDATE_AVAILABLE',
'UPDATE_AVAILABLE',
'UPDATES_AVAILABLE',
'FULLY_UPDATED',
2015-10-21 19:54:10 +02:00
'DAYS',
'PAGE_MODES',
'PAGE_TYPES',
2016-02-01 11:27:34 -08:00
'ACCESS_LEVELS',
2016-02-01 16:34:50 -08:00
'NOTHING_TO_SAVE',
'FILE_UNSUPPORTED',
'FILE_ERROR_ADD',
'FILE_ERROR_UPLOAD',
'DROP_FILES_HERE_TO_UPLOAD',
'DELETE',
'UNSET',
'INSERT',
'METADATA',
'VIEW',
'UNDO',
'REDO',
'HEADERS',
'BOLD',
'ITALIC',
'STRIKETHROUGH',
'SUMMARY_DELIMITER',
'LINK',
'IMAGE',
'BLOCKQUOTE',
'UNORDERED_LIST',
'ORDERED_LIST',
'EDITOR',
'PREVIEW',
2016-05-06 18:17:26 +02:00
'FULLSCREEN',
'MODULAR',
'NON_MODULAR',
'VISIBLE',
'NON_VISIBLE',
'ROUTABLE',
'NON_ROUTABLE',
'PUBLISHED',
'NON_PUBLISHED',
'PLUGINS',
'THEMES',
'ALL',
'FROM',
[WIP] Ajax Files Upload (#748) * Reworked the `file` field. All files get uploaded via Ajax and are stored upon Save This improves the Save task tremendously as now there is no longer the need of waiting for the files to finish uploading. Fully backward compatible, `file` field now includes also a `limit` and `filesize` option in the blueprints. The former determines how many files are allowed to be uploaded when in combination with `multiple: true` (default: 10), the latter determines the file size limit (in MB) allowed for each file (default: 5MB) * Added support for `accept: [‘*’]` to allow any file type * Minor tweaks in the comments and messages * Delete any orphan file when discarding the uploaded files session * Minor optimization * Fixed issue with `_json` elements where nested fields merging would get stored in an unexpected way * Potential fix for wrong order of value in Datetime * Fixed nested fields for files * Fixed tmp streams * Minor cleanup * Update JSON data when removing a file. Implemented task to remove files that haven’t been saved yet, from the flash object session * Ensure temporary files are deleted when removing un-saved files from the flash object session * Fixed wrong reference of HTML file field when clicking on the drop zone area to pick a file * Added JSON template for pages * fix a CSS issue in page order * More CSS fixes * Trigger file field mutation when adding or removing a file * Recompiled JS * Removed twig templates that are no longer needed * Fixed issue with nested header fields in a page, not properly merging data * [internal] Fixed issue with collections not capable of handling both param and dot notations at the same time * Reorganized FileField structure to be more consistent with the other fields * Added support for dynamically created file fields (ie, autoinitialization on new lists items) * Added translationable strings for file uploads errors * Added translasions for all Dropzone available strings * Changed default values
2016-08-29 11:12:09 -07:00
'TO',
'DROPZONE_CANCEL_UPLOAD',
'DROPZONE_CANCEL_UPLOAD_CONFIRMATION',
'DROPZONE_DEFAULT_MESSAGE',
'DROPZONE_FALLBACK_MESSAGE',
'DROPZONE_FALLBACK_TEXT',
'DROPZONE_FILE_TOO_BIG',
'DROPZONE_INVALID_FILE_TYPE',
'DROPZONE_MAX_FILES_EXCEEDED',
'DROPZONE_REMOVE_FILE',
'DROPZONE_RESPONSE_ERROR'
2015-10-21 19:54:10 +02:00
];
2016-07-07 18:55:52 +02:00
foreach ($strings as $string) {
2016-02-01 11:27:34 -08:00
$separator = (end($strings) === $string) ? '' : ',';
2018-12-05 08:20:38 +02:00
$translations .= '"' . $string . '": "' . htmlspecialchars($this->admin::translate('PLUGIN_ADMIN.' . $string)) . '"' . $separator;
}
2016-02-01 11:27:34 -08:00
$translations .= '};';
$translations .= 'this.GravAdmin.translations.PLUGIN_FORM = {';
$strings = ['RESOLUTION_MIN', 'RESOLUTION_MAX'];
foreach ($strings as $string) {
$separator = (end($strings) === $string) ? '' : ',';
2018-12-05 08:20:38 +02:00
$translations .= '"' . $string . '": "' . $this->admin::translate('PLUGIN_FORM.' . $string) . '"' . $separator;
}
$translations .= '};';
$translations .= 'this.GravAdmin.translations.GRAV_CORE = {';
$strings = [
'NICETIME.SECOND',
'NICETIME.MINUTE',
'NICETIME.HOUR',
'NICETIME.DAY',
'NICETIME.WEEK',
'NICETIME.MONTH',
'NICETIME.YEAR',
'CRON.EVERY',
'CRON.EVERY_HOUR',
'CRON.EVERY_MINUTE',
'CRON.EVERY_DAY_OF_WEEK',
'CRON.EVERY_DAY_OF_MONTH',
'CRON.EVERY_MONTH',
'CRON.TEXT_PERIOD',
'CRON.TEXT_MINS',
'CRON.TEXT_TIME',
'CRON.TEXT_DOW',
'CRON.TEXT_MONTH',
'CRON.TEXT_DOM',
'CRON.ERROR1',
'CRON.ERROR2',
'CRON.ERROR3',
2018-10-24 14:46:24 -06:00
'CRON.ERROR4',
'MONTHS_OF_THE_YEAR',
'DAYS_OF_THE_WEEK'
];
foreach ($strings as $string) {
$separator = (end($strings) === $string) ? '' : ',';
2018-12-05 08:20:38 +02:00
$translations .= '"' . $string . '": ' . json_encode($this->admin::translate('GRAV.'.$string)) . $separator;
}
$translations .= '};';
// set the actual translations state back
$this->config->set('system.languages.translations', $translations_actual_state);
$assets->addInlineJs($translations);
2014-09-03 22:22:03 -06:00
}
2014-08-05 13:06:38 -07:00
}