mirror of
https://github.com/getgrav/grav-plugin-admin.git
synced 2025-10-31 10:25:50 +01:00
1095 lines
37 KiB
PHP
1095 lines
37 KiB
PHP
<?php
|
|
namespace Grav\Plugin;
|
|
|
|
use Composer\Autoload\ClassLoader;
|
|
use Grav\Common\Cache;
|
|
use Grav\Common\Debugger;
|
|
use Grav\Common\File\CompiledYamlFile;
|
|
use Grav\Common\Grav;
|
|
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;
|
|
use Grav\Common\Processors\Events\RequestHandlerEvent;
|
|
use Grav\Common\Session;
|
|
use Grav\Common\Uri;
|
|
use Grav\Common\User\Interfaces\UserCollectionInterface;
|
|
use Grav\Common\Utils;
|
|
use Grav\Framework\Psr7\Response;
|
|
use Grav\Framework\Session\Exceptions\SessionException;
|
|
use Grav\Plugin\Admin\Admin;
|
|
use Grav\Plugin\Admin\Popularity;
|
|
use Grav\Plugin\Admin\Router;
|
|
use Grav\Plugin\Admin\Themes;
|
|
use Grav\Plugin\Admin\AdminController;
|
|
use Grav\Plugin\Admin\Twig\AdminTwigExtension;
|
|
use Grav\Plugin\Form\Form;
|
|
use Grav\Plugin\Login\Login;
|
|
use Pimple\Container;
|
|
use RocketTheme\Toolbox\Event\Event;
|
|
|
|
class AdminPlugin extends Plugin
|
|
{
|
|
public $features = [
|
|
'blueprints' => 1000,
|
|
];
|
|
|
|
/** @var bool */
|
|
protected $active = false;
|
|
|
|
/** @var string */
|
|
protected $template;
|
|
|
|
/** @var string */
|
|
protected $theme;
|
|
|
|
/** @var string */
|
|
protected $route;
|
|
|
|
/** @var string */
|
|
protected $admin_route;
|
|
|
|
/** @var Uri */
|
|
protected $uri;
|
|
|
|
/** @var Admin */
|
|
protected $admin;
|
|
|
|
/** @var Session */
|
|
protected $session;
|
|
|
|
/** @var Popularity */
|
|
protected $popularity;
|
|
|
|
/** @var string */
|
|
protected $base;
|
|
|
|
/** @var string */
|
|
protected $version;
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public static function getSubscribedEvents()
|
|
{
|
|
return [
|
|
'onPluginsInitialized' => [
|
|
['autoload', 100001],
|
|
['setup', 100000],
|
|
['onPluginsInitialized', 1001]
|
|
],
|
|
'onRequestHandlerInit' => [
|
|
['onRequestHandlerInit', 100000]
|
|
],
|
|
'onPageInitialized' => ['onPageInitialized', 0],
|
|
'onFormProcessed' => ['onFormProcessed', 0],
|
|
'onShutdown' => ['onShutdown', 1000],
|
|
'onAdminDashboard' => ['onAdminDashboard', 0],
|
|
'onAdminTools' => ['onAdminTools', 0],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* 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';
|
|
}
|
|
|
|
/**
|
|
* [onPluginsInitialized:100000]
|
|
*
|
|
* 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, '/');
|
|
$this->admin_route = rtrim($this->grav['pages']->base(), '/') . $this->base;
|
|
$this->uri = $this->grav['uri'];
|
|
|
|
$users_exist = Admin::doAnyUsersExist();
|
|
|
|
// If no users found, go to register
|
|
if (!$users_exist) {
|
|
if (!$this->isAdminPath()) {
|
|
$this->grav->redirect($this->admin_route);
|
|
}
|
|
$this->template = 'register';
|
|
}
|
|
|
|
// Only activate admin if we're inside the admin path.
|
|
if ($this->isAdminPath()) {
|
|
$pages = $this->grav['pages'];
|
|
if (method_exists($pages, 'disablePages')) {
|
|
$pages->disablePages();
|
|
}
|
|
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');
|
|
}
|
|
$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');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* [onPluginsInitialized:1001]
|
|
*
|
|
* If the admin plugin is set as active, initialize the admin
|
|
*/
|
|
public function onPluginsInitialized()
|
|
{
|
|
// 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 ($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]));
|
|
}
|
|
|
|
/**
|
|
* [onRequestHandlerInit:100000]
|
|
*
|
|
* @param RequestHandlerEvent $event
|
|
*/
|
|
public function onRequestHandlerInit(RequestHandlerEvent $event)
|
|
{
|
|
$route = $event->getRoute();
|
|
$base = $route->getRoute(0, 1);
|
|
|
|
if ($base === $this->base) {
|
|
$event->addMiddleware('admin_router', new Router($this->grav));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* [onPageInitialized:0]
|
|
*/
|
|
public function onPageInitialized()
|
|
{
|
|
$page = $this->grav['page'];
|
|
|
|
$template = $this->grav['uri']->param('tmpl');
|
|
|
|
if ($template) {
|
|
$page->template($template);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* [onFormProcessed:0]
|
|
*
|
|
* 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':
|
|
|
|
if (Admin::doAnyUsersExist()) {
|
|
throw new \RuntimeException('A user account already exists, please create an admin account manually.');
|
|
}
|
|
|
|
if (!$this->config->get('plugins.login.enabled')) {
|
|
throw new \RuntimeException($this->grav['language']->translate('PLUGIN_LOGIN.PLUGIN_LOGIN_DISABLED'));
|
|
}
|
|
|
|
$data = [];
|
|
$username = $form->value('username');
|
|
|
|
if ($form->value('password1') !== $form->value('password2')) {
|
|
$this->grav->fireEvent('onFormValidationError', new Event([
|
|
'form' => $form,
|
|
'message' => $this->grav['language']->translate('PLUGIN_LOGIN.PASSWORDS_DO_NOT_MATCH')
|
|
]));
|
|
$event->stopPropagation();
|
|
|
|
return;
|
|
}
|
|
|
|
$data['password'] = $form->value('password1');
|
|
|
|
$fields = [
|
|
'email',
|
|
'fullname',
|
|
'title'
|
|
];
|
|
|
|
foreach ($fields as $field) {
|
|
// Process value of field if set in the page process.register_user
|
|
if (!isset($data[$field]) && $form->value($field)) {
|
|
$data[$field] = $form->value($field);
|
|
}
|
|
}
|
|
|
|
// Don't store plain text password or username (part of the filename).
|
|
unset($data['password1'], $data['password2'], $data['username']);
|
|
|
|
// Extra lowercase to ensure file is saved lowercase
|
|
$username = strtolower($username);
|
|
|
|
$inflector = new Inflector();
|
|
|
|
$data['fullname'] = $data['fullname'] ?? $inflector->titleize($username);
|
|
$data['title'] = $data['title'] ?? 'Administrator';
|
|
$data['state'] = 'enabled';
|
|
|
|
/** @var UserCollectionInterface $users */
|
|
$users = $this->grav['accounts'];
|
|
|
|
// Create user object and save it
|
|
$user = $users->load($username);
|
|
$user->update($data);
|
|
$user->set('access', ['admin' => ['login' => true, 'super' => true], 'site' => ['login' => true]]);
|
|
$user->save();
|
|
|
|
//Login user
|
|
$this->grav['session']->user = $user;
|
|
unset($this->grav['user']);
|
|
$this->grav['user'] = $user;
|
|
$user->authenticated = true;
|
|
$user->authorized = $user->authorize('admin.login') ?? false;
|
|
|
|
$messages = $this->grav['messages'];
|
|
$messages->add($this->grav['language']->translate('PLUGIN_ADMIN.LOGIN_LOGGED_IN'), 'info');
|
|
$this->grav->redirect($this->admin_route);
|
|
|
|
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();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* [onAdminDashboard:0]
|
|
*/
|
|
public function onAdminDashboard()
|
|
{
|
|
$lang = $this->grav['language'];
|
|
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = [
|
|
'name' => $lang->translate('PLUGIN_ADMIN.MAINTENANCE'),
|
|
'template' => 'dashboard-maintenance',
|
|
];
|
|
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = [
|
|
'name' => $lang->translate('PLUGIN_ADMIN.STATISTICS'),
|
|
'template' => 'dashboard-statistics',
|
|
];
|
|
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = [
|
|
'name' => $lang->translate('PLUGIN_ADMIN.NOTIFICATIONS'),
|
|
'template' => 'dashboard-notifications',
|
|
];
|
|
$this->grav['twig']->plugins_hooked_dashboard_widgets_top[] = [
|
|
'name' => $lang->translate('PLUGIN_ADMIN.NEWS_FEED'),
|
|
'template' => 'dashboard-feed',
|
|
];
|
|
$this->grav['twig']->plugins_hooked_dashboard_widgets_main[] = [
|
|
'name' => $lang->translate('PLUGIN_ADMIN.LATEST_PAGE_UPDATES'),
|
|
'template' => 'dashboard-pages',
|
|
];
|
|
}
|
|
|
|
|
|
/**
|
|
* [onAdminTools:0]
|
|
*
|
|
* Provide the tools for the Tools page, currently only direct install
|
|
*
|
|
* @return Event
|
|
*/
|
|
public function onAdminTools(Event $event)
|
|
{
|
|
$lang = $this->grav['language'];
|
|
$event['tools'] = array_merge($event['tools'], [
|
|
'backups' => [['admin.maintenance', 'admin.super'], $lang->translate('PLUGIN_ADMIN.BACKUPS')],
|
|
'scheduler' => [['admin.super'], $lang->translate('PLUGIN_ADMIN.SCHEDULER')],
|
|
'logs' => [['admin.super'], $lang->translate('PLUGIN_ADMIN.LOGS')],
|
|
'reports' => [['admin.super'], $lang->translate('PLUGIN_ADMIN.REPORTS')],
|
|
'direct-install' => [['admin.super'], $lang->translate('PLUGIN_ADMIN.DIRECT_INSTALL')],
|
|
]);
|
|
|
|
return $event;
|
|
}
|
|
|
|
/**
|
|
* Sets longer path to the home page allowing us to have list of pages when we enter to pages section.
|
|
*/
|
|
public function onPagesInitialized()
|
|
{
|
|
$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'];
|
|
|
|
// set session variable if it's passed via the url
|
|
if ($this->uri->param('mode') === 'expert') {
|
|
$this->session->expert = true;
|
|
} elseif ($this->uri->param('mode') === 'normal') {
|
|
$this->session->expert = false;
|
|
} else {
|
|
// set the default if not set before
|
|
$this->session->expert = $this->session->expert ?? false;
|
|
}
|
|
|
|
// Make local copy of POST.
|
|
$post = $this->grav['uri']->post();
|
|
|
|
// Handle tasks.
|
|
$this->admin->task = $task = $this->grav['task'] ?? $this->grav['action'];
|
|
if ($task) {
|
|
$this->initializeController($task, $post);
|
|
} elseif ($this->template === 'logs' && $this->route) {
|
|
// Display RAW error message.
|
|
$response = new Response(200, [], $this->admin->logEntry());
|
|
|
|
$this->grav->close($response);
|
|
}
|
|
|
|
$self = $this;
|
|
|
|
// make sure page is not frozen!
|
|
unset($this->grav['page']);
|
|
|
|
// 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;
|
|
}
|
|
|
|
// If not provided by Admin, lookup pages added by other plugins
|
|
$plugins = $this->grav['plugins'];
|
|
$locator = $this->grav['locator'];
|
|
|
|
foreach ($plugins as $plugin) {
|
|
if ($this->config->get("plugins.{$plugin->name}.enabled") !== true) {
|
|
continue;
|
|
}
|
|
|
|
$path = $locator->findResource("plugins://{$plugin->name}/admin/pages/{$self->template}.md");
|
|
|
|
if ($path) {
|
|
$page->init(new \SplFileInfo($path));
|
|
$page->slug(basename($self->template));
|
|
|
|
return $page;
|
|
}
|
|
}
|
|
|
|
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
|
|
$this->grav['assets']->setTimestamp(substr(md5(GRAV_VERSION . $this->grav['config']->checksum()), 0, 10));
|
|
}
|
|
|
|
/**
|
|
* Handles initializing the assets
|
|
*/
|
|
public function onAssetsInitialized()
|
|
{
|
|
// Disable Asset pipelining
|
|
$assets = $this->grav['assets'];
|
|
$assets->setJsPipeline(false);
|
|
$assets->setCssPipeline(false);
|
|
}
|
|
|
|
/**
|
|
* Add twig paths to plugin templates.
|
|
*/
|
|
public function onTwigTemplatePaths()
|
|
{
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Set all twig variables for generating output.
|
|
*/
|
|
public function onTwigSiteVariables()
|
|
{
|
|
$twig = $this->grav['twig'];
|
|
$page = $this->grav['page'];
|
|
|
|
$twig->twig_vars['location'] = $this->template;
|
|
$twig->twig_vars['base_url_relative_frontend'] = $twig->twig_vars['base_url_relative'] ?: '/';
|
|
$twig->twig_vars['admin_route'] = trim($this->admin_route, '/');
|
|
$twig->twig_vars['template_route'] = $this->template;
|
|
$twig->twig_vars['current_route'] = '/' . $twig->twig_vars['admin_route'] . '/' . $this->template . '/' . $this->route;
|
|
$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, '/');
|
|
$theme_url = '/' . ltrim($this->grav['locator']->findResource('plugin://admin/themes/' . $this->theme,
|
|
false), '/');
|
|
$twig->twig_vars['theme_url'] = $theme_url;
|
|
$twig->twig_vars['preset_url'] = $twig->twig_vars['preset_url'] ?? $theme_url;
|
|
$twig->twig_vars['base_url'] = $twig->twig_vars['base_url_relative'];
|
|
$twig->twig_vars['base_path'] = GRAV_ROOT;
|
|
$twig->twig_vars['admin'] = $this->admin;
|
|
$twig->twig_vars['admin_version'] = $this->version;
|
|
$twig->twig_vars['logviewer'] = new LogViewer();
|
|
$twig->twig_vars['form_max_filesize'] = Utils::getUploadLimit() / 1024 / 1024;
|
|
|
|
$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;
|
|
|
|
// 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));
|
|
}
|
|
}
|
|
|
|
// Gather all nav items
|
|
$this->grav['twig']->plugins_hooked_nav = [];
|
|
$this->grav->fireEvent('onAdminMenu');
|
|
uasort($this->grav['twig']->plugins_hooked_nav, function ($a, $b) {
|
|
$ac = $a['priority'] ?? 0;
|
|
$bc = $b['priority'] ?? 0;
|
|
return $bc <=> $ac;
|
|
});
|
|
|
|
// Gather Plugin-hooked dashboard items
|
|
$this->grav->fireEvent('onAdminDashboard');
|
|
|
|
switch ($this->template) {
|
|
case 'dashboard':
|
|
$twig->twig_vars['popularity'] = $this->popularity;
|
|
break;
|
|
}
|
|
|
|
$flashData = $this->grav['session']->getFlashCookieObject(Admin::TMP_COOKIE_NAME);
|
|
|
|
if (isset($flashData->message)) {
|
|
$this->grav['messages']->add($flashData->message, $flashData->status);
|
|
}
|
|
}
|
|
|
|
// 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()
|
|
{
|
|
$this->grav['twig']->twig->addExtension(new AdminTwigExtension);
|
|
}
|
|
|
|
public function onAdminAfterSave(Event $event)
|
|
{
|
|
// Special case to redirect after changing the admin route to avoid 'breaking'
|
|
$obj = $event['object'];
|
|
|
|
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 'config':
|
|
$e['type'] = $this->admin->authorize(['admin.configuration_system','admin.super']) ? 'config/system' : 'config/site';
|
|
break;
|
|
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 = [
|
|
'site.login' => 'boolean',
|
|
'admin.login' => 'boolean',
|
|
'admin.super' => '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);
|
|
}
|
|
|
|
public function onAdminMenu()
|
|
{
|
|
// Dashboard
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.DASHBOARD'] = [
|
|
'route' => 'dashboard',
|
|
'icon' => 'fa-th',
|
|
'authorize' => ['admin.login', 'admin.super'],
|
|
'priority' => 10
|
|
];
|
|
|
|
// Configuration
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.CONFIGURATION'] = [
|
|
'route' => 'config',
|
|
'icon' => 'fa-wrench',
|
|
'authorize' => ['admin.configuration_system', 'admin.super'],
|
|
'priority' => 9
|
|
];
|
|
|
|
// Pages
|
|
$count = new Container(['count' => function () { return $this->admin->pagesCount(); }]);
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.PAGES'] = [
|
|
'route' => 'pages',
|
|
'icon' => 'fa-file-text-o',
|
|
'authorize' => ['admin.pages', 'admin.super'],
|
|
'badge' => $count,
|
|
'priority' => 5
|
|
];
|
|
|
|
// Plugins
|
|
$count = new Container(['updates' => 0, 'count' => function () { return count($this->admin->plugins()); }]);
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.PLUGINS'] = [
|
|
'route' => 'plugins',
|
|
'icon' => 'fa-plug',
|
|
'authorize' => ['admin.plugins', 'admin.super'],
|
|
'badge' => $count,
|
|
'priority' => -8
|
|
];
|
|
|
|
// Themes
|
|
$count = new Container(['updates' => 0, 'count' => function () { return count($this->admin->themes()); }]);
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.THEMES'] = [
|
|
'route' => 'themes',
|
|
'icon' => 'fa-tint',
|
|
'authorize' => ['admin.themes', 'admin.super'],
|
|
'badge' => $count,
|
|
'priority' => -9
|
|
];
|
|
|
|
// Tools
|
|
$this->grav['twig']->plugins_hooked_nav['PLUGIN_ADMIN.TOOLS'] = [
|
|
'route' => 'tools',
|
|
'icon' => 'fa-briefcase',
|
|
'authorize' => $this->admin::toolsPermissions(),
|
|
'priority' => -10
|
|
];
|
|
}
|
|
|
|
/**
|
|
* 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],
|
|
'onAdminMenu' => ['onAdminMenu', 1000],
|
|
]);
|
|
|
|
// Check for required plugins
|
|
if (!$this->grav['config']->get('plugins.login.enabled') || !$this->grav['config']->get('plugins.form.enabled') || !$this->grav['config']->get('plugins.email.enabled')) {
|
|
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)), '/');
|
|
|
|
if (empty($this->template)) {
|
|
$this->template = 'dashboard';
|
|
}
|
|
|
|
// Can't access path directly...
|
|
if ($path && $path !== 'register') {
|
|
$array = explode('/', $path, 2);
|
|
$this->template = array_shift($array);
|
|
$this->route = array_shift($array);
|
|
}
|
|
|
|
// Initialize admin class (also registers it to Grav services).
|
|
$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');
|
|
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'];
|
|
$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);
|
|
|
|
$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',
|
|
'DAYS',
|
|
'PAGE_MODES',
|
|
'PAGE_TYPES',
|
|
'ACCESS_LEVELS',
|
|
'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',
|
|
'FULLSCREEN',
|
|
'MODULE',
|
|
'NON_MODULE',
|
|
'VISIBLE',
|
|
'NON_VISIBLE',
|
|
'ROUTABLE',
|
|
'NON_ROUTABLE',
|
|
'PUBLISHED',
|
|
'NON_PUBLISHED',
|
|
'PLUGINS',
|
|
'THEMES',
|
|
'ALL',
|
|
'FROM',
|
|
'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'
|
|
];
|
|
|
|
foreach ($strings as $string) {
|
|
$separator = (end($strings) === $string) ? '' : ',';
|
|
$translations .= '"' . $string . '": "' . htmlspecialchars($this->admin::translate('PLUGIN_ADMIN.' . $string)) . '"' . $separator;
|
|
}
|
|
|
|
$translations .= '};';
|
|
|
|
$translations .= 'this.GravAdmin.translations.PLUGIN_FORM = {';
|
|
$strings = ['RESOLUTION_MIN', 'RESOLUTION_MAX'];
|
|
foreach ($strings as $string) {
|
|
$separator = (end($strings) === $string) ? '' : ',';
|
|
$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',
|
|
'CRON.ERROR4',
|
|
'MONTHS_OF_THE_YEAR',
|
|
'DAYS_OF_THE_WEEK'
|
|
];
|
|
foreach ($strings as $string) {
|
|
$separator = (end($strings) === $string) ? '' : ',';
|
|
$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);
|
|
}
|
|
}
|