<?php
namespace Grav\Plugin;
use Composer\Autoload\ClassLoader;
use Grav\Common\Cache;
use Grav\Common\Data\Data;
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\Plugins;
use Grav\Common\Processors\Events\RequestHandlerEvent;
use Grav\Common\Session;
use Grav\Common\Twig\Twig;
use Grav\Common\Uri;
use Grav\Common\User\Interfaces\UserInterface;
use Grav\Common\Utils;
use Grav\Common\Yaml;
use Grav\Events\PermissionsRegisterEvent;
use Grav\Framework\Acl\PermissionsReader;
use Grav\Framework\Psr7\Response;
use Grav\Framework\Session\Exceptions\SessionException;
use Grav\Plugin\Admin\Admin;
use Grav\Plugin\Admin\AdminFormFactory;
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\Admin\WhiteLabel;
use Grav\Plugin\Form\Form;
use Grav\Plugin\Form\Forms;
use Grav\Plugin\Login\Login;
use Pimple\Container;
use Psr\Http\Message\ResponseInterface;
use RocketTheme\Toolbox\Event\Event;
use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
/**
* Class AdminPlugin
* @package Grav\Plugin\Admin
*/
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' => [
['setup', 100000],
['onPluginsInitialized', 1001]
],
'onRequestHandlerInit' => [
['onRequestHandlerInit', 100000]
],
'onFormRegisterTypes' => ['onFormRegisterTypes', 0],
'onPageInitialized' => ['onPageInitialized', 0],
'onShutdown' => ['onShutdown', 1000],
PermissionsRegisterEvent::class => ['onRegisterPermissions', 1000],
];
}
/**
* 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
],
'elements' => [
'input@' => true
],
'element' => [
'input@' => false
],
'file' => [
'array' => true,
'media_field' => true,
'validate' => [
'type' => 'ignore'
]
],
'pagemedia' => [
'array' => true,
'media_field' => true,
'validate' => [
'type' => 'ignore'
]
],
'filepicker' => [
'media_picker_field' => true
],
'pagemediaselect' => [
'media_picker_field' => true
],
'permissions' => [
'ignore_empty' => true,
'validate' => [
'type' => 'array'
],
'filter' => [
'type' => 'flatten_array',
'value_type' => 'bool',
]
],
'acl_picker' => [
'ignore_empty' => true,
'validate' => [
'type' => 'array'
],
'filter' => [
'type' => 'array',
'key_type' => 'string',
'value_type' => 'bool',
]
],
'taxonomy' => [
'multiple' => true,
'validate' => [
'type' => 'array'
]
]
];
}
/**
* @return ClassLoader
*/
public function autoload(): ClassLoader
{
return require __DIR__ . '/vendor/autoload.php';
}
/**
* @param Event $event
* @return void
*/
public function onFormRegisterTypes(Event $event): void
{
/** @var Forms $forms */
$forms = $event['forms'];
$forms->registerType('admin', new AdminFormFactory());
}
/**
* [onPluginsInitialized:100000]
*
* If the admin path matches, initialize the Login plugin configuration and set the admin
* as active.
*
* @return void
*/
public function setup()
{
// Only enable admin if it has a route.
$route = $this->config->get('plugins.admin.route');
if (!$route) {
return;
}
/** @var Uri uri */
$this->uri = $this->grav['uri'];
$this->base = '/' . trim($route, '/');
$this->admin_route = rtrim($this->grav['pages']->base(), '/') . $this->base;
$inAdmin = $this->isAdminPath();
// If no users found, go to register.
if (!$inAdmin && !Admin::doAnyUsersExist()) {
$this->grav->redirect($this->admin_route);
}
// Only setup admin if we're inside the admin path.
if ($inAdmin) {
$this->setupAdmin();
}
}
/**
* [onPluginsInitialized:1001]
*
* If the admin plugin is set as active, initialize the admin
*
* @return void
*/
public function onPluginsInitialized()
{
// Only activate admin if we're inside the admin path.
if ($this->active) {
$this->initializeAdmin();
}
// Always initialize popularity.
$this->popularity = new Popularity();
}
/**
* [onRequestHandlerInit:100000]
*
* @param RequestHandlerEvent $event
* @return void
*/
public function onRequestHandlerInit(RequestHandlerEvent $event)
{
// Store this version.
$this->version = $this->getBlueprint()->get('version');
$route = $event->getRoute();
$base = $route->getRoute(0, 1);
if ($base === $this->base) {
/** @var Debugger $debugger */
$debugger = $this->grav['debugger'];
$debugger->addMessage('Admin v' . $this->version);
$event->addMiddleware('admin_router', new Router($this->grav, $this->admin));
}
}
/**
* @param Event $event
* @return void
*/
public function onAdminControllerInit(Event $event): void
{
$eventController = $event['controller'];
// Blacklist login related views.
$loginViews = ['login', 'forgot', 'register', 'reset'];
$eventController->blacklist_views = array_merge($eventController->blacklist_views, $loginViews);
}
/**
* Force compile during save if admin plugin save
*
* @param Event $event
* @return void
*/
public function onAdminSave(Event $event)
{
$obj = $event['object'];
if ($obj instanceof Data
&& ($blueprint = $obj->blueprints()) && $blueprint && $blueprint->getFilename() === 'admin/blueprints') {
[$status, $msg] = $this->grav['admin-whitelabel']->compilePresetScss($obj);
if (!$status) {
$this->grav['messages']->add($msg, 'error');
}
}
}
/**
* [onPageInitialized:0]
*
* @return void
*/
public function onPageInitialized()
{
$template = $this->uri->param('tmpl');
if ($template) {
/** @var PageInterface $page */
$page = $this->grav['page'];
$page->template($template);
}
}
/**
* [onShutdown:1000]
*
* Handles the shutdown
*
* @return void
*/
public function onShutdown()
{
if ($this->active) {
//only activate when Admin is active
if ($this->admin->shouldLoadAdditionalFilesInBackground()) {
$this->admin->loadAdditionalFilesInBackground();
}
} elseif ($this->popularity && $this->config->get('plugins.admin.popularity.enabled')) {
//if popularity is enabled, track non-admin hits
$this->popularity->trackHit();
}
}
/**
* [onAdminDashboard:0]
*
* @return void
*/
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.VIEWS_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 void
*/
public function onAdminTools(Event $event)
{
$event['tools'] = array_merge($event['tools'], [
'backups' => [['admin.maintenance', 'admin.super'], 'PLUGIN_ADMIN.BACKUPS'],
'scheduler' => [['admin.super'], 'PLUGIN_ADMIN.SCHEDULER'],
'logs' => [['admin.super'], 'PLUGIN_ADMIN.LOGS'],
'reports' => [['admin.super'], 'PLUGIN_ADMIN.REPORTS'],
'direct-install' => [['admin.super'], 'PLUGIN_ADMIN.DIRECT_INSTALL'],
]);
}
/**
* Sets longer path to the home page allowing us to have list of pages when we enter to pages section.
*
* @return void
*/
public function onPagesInitialized()
{
$config = $this->config;
// Force SSL with redirect if required
if ($config->get('system.force_ssl')) {
if (!isset($_SERVER['HTTPS']) || strtolower($_SERVER['HTTPS']) !== 'on') {
Admin::DEBUG && Admin::addDebugMessage('Admin SSL forced on, redirect');
$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->session->user->authorize('admin.super') || $this->uri->param('mode') === 'normal') {
$this->session->expert = false;
} elseif ($this->uri->param('mode') === 'expert') {
$this->session->expert = true;
} else {
// set the default if not set before
$this->session->expert = $this->session->expert ?? false;
}
// make sure page is not frozen!
unset($this->grav['page']);
// Call the controller if it has been set.
$adminParams = $this->admin->request->getAttribute('admin');
$page = null;
if (isset($adminParams['controller'])) {
$controllerParams = $adminParams['controller'];
$class = $controllerParams['class'];
if (!class_exists($class)) {
throw new \RuntimeException(sprintf('Admin controller %s does not exist', $class));
}
/** @var \Grav\Plugin\Admin\Controllers\AdminController $controller */
$controller = new $class($this->grav);
$method = $controllerParams['method'];
$params = $controllerParams['params'] ?? [];
if (!is_callable([$controller, $method])) {
throw new \RuntimeException(sprintf('Admin controller method %s() does not exist', $method));
}
/** @var ResponseInterface $response */
$response = $controller->{$method}(...$params);
if ($response->getStatusCode() !== 418) {
$this->grav->close($response);
}
$page = $controller->getPage();
if (!$page) {
throw new \RuntimeException('Not Found', 404);
}
$this->grav['page'] = $page;
$this->admin->form = $controller->getActiveForm();
$legacyController = false;
} else {
$legacyController = true;
}
/** @var UserInterface $user */
$user = $this->grav['user'];
// Replace page service with admin.
if (empty($this->grav['page'])) {
$this->grav['page'] = function () use ($user) {
$page = new Page();
// Plugins may not have the correct Cache-Control header set, force no-store for the proxies.
$page->expires(0);
if ($user->authorize('admin.login')) {
$event = new Event(['page' => $page]);
$event = $this->grav->fireEvent('onAdminPage', $event);
/** @var PageInterface $page */
$page = $event['page'];
if ($page->slug()) {
Admin::DEBUG && Admin::addDebugMessage('Admin page: from event');
return $page;
}
}
// Look in the pages provided by the Admin plugin itself
if (file_exists(__DIR__ . "/pages/admin/{$this->template}.md")) {
Admin::DEBUG && Admin::addDebugMessage("Admin page: {$this->template}");
$page->init(new \SplFileInfo(__DIR__ . "/pages/admin/{$this->template}.md"));
$page->slug(Utils::basename($this->template));
return $page;
}
/** @var UniformResourceLocator $locator */
$locator = $this->grav['locator'];
// If not provided by Admin, lookup pages added by other plugins
/** @var Plugins $plugins */
$plugins = $this->grav['plugins'];
foreach ($plugins as $plugin) {
if ($this->config->get("plugins.{$plugin->name}.enabled") !== true) {
continue;
}
$path = $locator->findResource("plugins://{$plugin->name}/admin/pages/{$this->template}.md");
if ($path) {
Admin::DEBUG && Admin::addDebugMessage("Admin page: plugin {$plugin->name}/{$this->template}");
$page->init(new \SplFileInfo($path));
$page->slug(Utils::basename($this->template));
return $page;
}
}
return null;
};
}
if (empty($this->grav['page'])) {
if ($user->authenticated) {
Admin::DEBUG && Admin::addDebugMessage('Admin page: fire onPageNotFound event');
$event = new Event(['page' => null]);
$event->page = null;
$event = $this->grav->fireEvent('onPageNotFound', $event);
/** @var PageInterface $page */
$page = $event->page;
if (!$page || !$page->routable()) {
Admin::DEBUG && Admin::addDebugMessage('Admin page: 404 Not Found');
$error_file = $this->grav['locator']->findResource('plugins://admin/pages/admin/error.md');
$page = new Page();
$page->init(new \SplFileInfo($error_file));
$page->slug(Utils::basename($this->route));
$page->routable(true);
}
unset($this->grav['page']);
$this->grav['page'] = $page;
} else {
Admin::DEBUG && Admin::addDebugMessage('Admin page: login');
// 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(Utils::basename($this->route));
unset($this->grav['page']);
$this->grav['page'] = $page;
}
}
if ($legacyController) {
// Handle tasks.
$this->admin->task = $task = $this->grav['task'] ?? $this->grav['action'];
if ($task) {
Admin::DEBUG && Admin::addDebugMessage("Admin task: {$task}");
// Make local copy of POST.
$post = $this->grav['uri']->post();
$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);
}
}
// Explicitly set a timestamp on assets
$this->grav['assets']->setTimestamp(substr(md5(GRAV_VERSION . $this->grav['config']->checksum()), 0, 10));
}
/**
* Handles initializing the assets
*
* @return void
*/
public function onAssetsInitialized()
{
// Disable Asset pipelining
$assets = $this->grav['assets'];
$assets->setJsPipeline(false);
$assets->setCssPipeline(false);
}
/**
* Add twig paths to plugin templates.
*
* @return void
*/
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.
*
* @return void
*/
public function onTwigSiteVariables()
{
/** @var Twig $twig */
$twig = $this->grav['twig'];
/** @var PageInterface $page */
$page = $this->grav['page'];
$twig->twig_vars['location'] = $this->template;
$twig->twig_vars['nav_route'] = trim($this->template . '/' . $this->route, '/') . '/';
$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['base_url'] = $twig->twig_vars['base_url_relative'];
$twig->twig_vars['base_path'] = GRAV_ROOT;
$twig->twig_vars['admin'] = $this->admin;
$twig->twig_vars['user'] = $this->admin->user;
$twig->twig_vars['admin_version'] = $this->version;
$twig->twig_vars['logviewer'] = new LogViewer();
$twig->twig_vars['form_max_filesize'] = Utils::getUploadLimit() / 1024 / 1024;
// Start white label functionality
$twig->twig_vars['whitelabel_presets'] = $this->getPresets();
$custom_logo = $this->config->get('plugins.admin.whitelabel.logo_custom', false);
$custom_login_logo = $this->config->get('plugins.admin.whitelabel.logo_login', false);
$custom_footer = $this->config->get('plugins.admin.whitelabel.custom_footer', false);
if ($custom_logo && is_array($custom_logo)) {
$custom_logo = array_keys($custom_logo);
$path = array_shift($custom_logo);
$twig->twig_vars['custom_admin_logo'] = $path;
}
if ($custom_login_logo && is_array($custom_login_logo)) {
$custom_login_logo = array_keys($custom_login_logo);
$path = array_shift($custom_login_logo);
$twig->twig_vars['custom_login_logo'] = $path;
}
if ($custom_footer) {
$footer = Utils::processMarkdown($custom_footer);
$twig->twig_vars['custom_admin_footer'] = $footer;
}
$custom_css = $this->config->get('plugins.admin.whitelabel.custom_css', false);
if ($custom_css) {
$this->grav['assets']->addInlineCss($custom_css);
}
// End white label functionality
$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 ($this->admin->form) {
$twig->twig_vars['form'] = $this->admin->form;
} elseif (!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
*
* @return void
*/
public function onTwigLoader()
{
/** @var Twig $twig */
$twig = $this->grav['twig'];
/** @var UniformResourceLocator $locator */
$locator = Grav::instance()['locator'];
$theme_paths = $locator->findResources('plugins://admin/themes/' . $this->theme . '/images');
foreach($theme_paths as $images_path) {
$twig->addPath($images_path, 'admin-images');
}
}
/**
* Add the Admin Twig Extensions
*
* @return void
*/
public function onTwigExtensions()
{
/** @var Twig $twig */
$twig = $this->grav['twig'];
$twig->twig->addExtension(new AdminTwigExtension);
}
/**
* @param Event $event
* @return void
*/
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
* @return void
*/
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;
}
}
/**
* @return void
*/
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 PermissionsRegisterEvent $event
* @return void
*/
public function onRegisterPermissions(PermissionsRegisterEvent $event): void
{
$actions = PermissionsReader::fromYaml("plugin://{$this->name}/permissions.yaml");
$permissions = $event->permissions;
$permissions->addActions($actions);
}
/**
* @return void
*/
public function onAdminMenu()
{
/** @var Twig $twig */
$twig = $this->grav['twig'];
// Dashboard
$twig->plugins_hooked_nav['PLUGIN_ADMIN.DASHBOARD'] = [
'route' => 'dashboard',
'icon' => 'fa-th',
'authorize' => ['admin.login', 'admin.super'],
'priority' => 10
];
// Configuration
$twig->plugins_hooked_nav['PLUGIN_ADMIN.CONFIGURATION'] = [
'route' => 'config',
'icon' => 'fa-wrench',
'authorize' => [
'admin.configuration.system',
'admin.configuration.site',
'admin.configuration.media',
'admin.configuration.security',
'admin.configuration.info',
'admin.super'],
'priority' => 9
];
// Pages
$count = new Container(['count' => function () { return $this->admin->pagesCount(); }]);
$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()); }]);
$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()); }]);
$twig->plugins_hooked_nav['PLUGIN_ADMIN.THEMES'] = [
'route' => 'themes',
'icon' => 'fa-tint',
'authorize' => ['admin.themes', 'admin.super'],
'badge' => $count,
'priority' => -9
];
// Tools
$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
*
* @param bool $keysOnly
* @return array
*/
public static function pagesTypes(bool $keysOnly = false)
{
$types = Pages::types();
// First filter by configuration
$hideTypes = (array)Grav::instance()['config']->get('plugins.admin.hide_page_types');
foreach ($hideTypes as $hide) {
if (isset($types[$hide])) {
unset($types[$hide]);
} else {
foreach ($types as $key => $type) {
$match = preg_match('#' . $hide . '#i', $key);
if ($match) {
unset($types[$key]);
}
}
}
}
// Allow manipulating of the data by event
$e = new Event(['types' => &$types]);
Grav::instance()->fireEvent('onAdminPageTypes', $e);
return $keysOnly ? array_keys($types) : $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
*
* @param bool $keysOnly
* @return array
*/
public static function pagesModularTypes(bool $keysOnly = false)
{
$types = Pages::modularTypes();
// First filter by configuration
$hideTypes = (array)Grav::instance()['config']->get('plugins.admin.hide_modular_page_types');
foreach ($hideTypes as $hide) {
if (isset($types[$hide])) {
unset($types[$hide]);
} else {
foreach ($types as $key => $type) {
$match = preg_match('#' . $hide . '#i', $key);
if ($match) {
unset($types[$key]);
}
}
}
}
// Allow manipulating of the data by event
$e = new Event(['types' => &$types]);
Grav::instance()->fireEvent('onAdminModularPageTypes', $e);
return $keysOnly ? array_keys($types) : $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);
}
/**
* @param string $task
* @param array|null $post
* @return void
*/
protected function initializeController($task, $post = null): void
{
Admin::DEBUG && Admin::addDebugMessage('Admin controller: execute');
$controller = new AdminController();
$controller->initialize($this->grav, $this->template, $task, $this->route, $post);
$controller->execute();
$controller->redirect();
}
/**
* @return void
*/
protected function setupAdmin()
{
// Set cache based on admin_cache option.
/** @var Cache $cache */
$cache = $this->grav['cache'];
$cache->setEnabled($this->config->get('plugins.admin.cache_enabled'));
/** @var Pages $pages */
$pages = $this->grav['pages'];
// Disable frontend pages in admin.
$pages->disablePages();
// Force file hash checks to fix caching on moved and deleted pages.
$pages->setCheckMethod('hash');
/** @var Session $session */
$session = $this->grav['session'];
// Make sure that the session has been initialized.
try {
$session->init();
} catch (SessionException $e) {
$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;
}
/**
* Initialize the admin.
*
* @return void
* @throws \RuntimeException
*/
protected function initializeAdmin()
{
// 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');
}
/** @var Cache $cache */
$cache = $this->grav['cache'];
// Have a unique Admin-only Cache key
$cache_key = $cache->getKey();
$cache->setKey($cache_key . '$');
/** @var Session $session */
$session = $this->grav['session'];
/** @var Language $language */
$language = $this->grav['language'];
/** @var UniformResourceLocator $locator */
$locator = $this->grav['locator'];
// Turn on Twig autoescaping
if ($this->uri->param('task') !== 'processmarkdown') {
$this->grav['twig']->setAutoescape(true);
}
// Initialize Admin Language if needed
if ($language->enabled() && empty($session->admin_lang)) {
$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);
// Get theme for admin
$this->theme = $this->config->get('plugins.admin.theme', 'grav');
// Replace themes service with admin.
$this->grav['themes'] = function () {
return new Themes($this->grav);
};
// Initialize white label functionality
$this->grav['admin-whitelabel'] = new WhiteLabel();
// Compile a missing preset.css file
$preset_css = 'asset://admin-preset.css';
$preset_path = $this->grav['locator']->findResource($preset_css);
if (!$preset_path) {
$this->grav['admin-whitelabel']->compilePresetScss($this->config->get('plugins.admin.whitelabel'));
}
// These events are needed for login.
$this->enable([
'onTwigExtensions' => ['onTwigExtensions', 1000],
'onPagesInitialized' => ['onPagesInitialized', 1000],
'onTwigLoader' => ['onTwigLoader', 1000],
'onTwigTemplatePaths' => ['onTwigTemplatePaths', 1000],
'onTwigSiteVariables' => ['onTwigSiteVariables', 1000],
'onAssetsInitialized' => ['onAssetsInitialized', 1000],
]);
// Do not do more if user isn't logged in.
if (!$this->admin->user->authorize('admin.login')) {
return;
}
// These events are not needed during login.
$this->enable([
'onAdminControllerInit' => ['onAdminControllerInit', 1001],
'onAdminDashboard' => ['onAdminDashboard', 0],
'onAdminMenu' => ['onAdminMenu', 1000],
'onAdminTools' => ['onAdminTools', 0],
'onAdminSave' => ['onAdminSave', 0],
'onAdminAfterSave' => ['onAdminAfterSave', 0],
'onAdminData' => ['onAdminData', 0],
'onOutputGenerated' => ['onOutputGenerated', 0],
]);
// Double check we have system.yaml, site.yaml etc
$config_path = $locator->findResource('user://config');
foreach ($this->admin::configurations() as $config_file) {
if ($config_file === 'info') {
continue;
}
$config_file = "{$config_path}/{$config_file}.yaml";
if (!file_exists($config_file)) {
touch($config_file);
}
}
$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);
// Fire even to register permissions from other plugins
$this->grav->fireEvent('onAdminRegisterPermissions', new Event(['admin' => $this->admin]));
}
/**
* @return array
*/
public static function themeOptions()
{
static $options;
if (null === $options) {
$options = [];
$theme_files = glob(__dir__ . '/themes/grav/css/codemirror/themes/*.css');
foreach ($theme_files as $theme_file) {
$theme = Utils::basename(Utils::basename($theme_file, '.css'));
$options[$theme] = Inflector::titleize($theme);
}
}
return $options;
}
/**
* @return array
*/
public function getPresets()
{
$filename = $this->grav['locator']->findResource('plugin://admin/presets.yaml', false);
$file = CompiledYamlFile::instance($filename);
$presets = (array)$file->content();
$custom_presets = $this->config->get('plugins.admin.whitelabel.custom_presets');
if (isset($custom_presets)) {
$custom_presets = Yaml::parse($custom_presets);
if (is_array($custom_presets)) {
if (isset($custom_presets['name'], $custom_presets['colors'], $custom_presets['accents'])) {
$preset = [Inflector::hyphenize($custom_presets['name']) => $custom_presets];
$presets = $preset + $presets;
} else {
foreach ($custom_presets as $value) {
if (isset($value['name'], $value['colors'], $value['accents'])) {
$preset = [Inflector::hyphenize($value['name']) => $value];
$presets = $preset + $presets;
}
}
}
}
}
return $presets;
}
}