routing for modules

Author: mnoskov

core/config/app.php

@@ -116,6 +116,11 @@
 
     'middleware' => [
 
+        'mgr' => [
+            EvolutionCMS\Middleware\VerifyCsrfToken::class,
+            EvolutionCMS\Middleware\Manager::class,
+        ],
+
         /*
         |--------------------------------------------------------------------------
         | The application's global HTTP middleware stack

core/src/Controllers/Actions.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace EvolutionCMS\Controllers;
+
+use EvolutionCMS\Interfaces\ManagerTheme;
+use Illuminate\Http\Response;
+
+class Actions extends AbstractController implements ManagerTheme\PageControllerInterface
+{
+    public function handleAction()
+    {
+        global $action;
+        // Update last action in table active_users
+        $action = $this->managerTheme->getActionId();
+
+        $output = '';
+
+        if ($action === null) {
+            $_style = $this->managerTheme->getStyle();
+            // first we check to see if this is a frameset request
+            if (!isset($_POST['updateMsgCount'])) {
+                \EvolutionCMS\Tracy\Debugger::$showBar = false;
+                // this looks to be a top-level frameset request, so let's serve up a frameset
+                $output = $this->managerTheme->handle(1, ['frame' => 1]);
+            }
+        } else {
+            $output = $this->managerTheme->handle($action);
+        }
+
+        if ($output instanceof Response) {
+            return $output;
+        }
+
+        $isRedirect = array_reduce(headers_list(), function($result, $header) {
+            return strpos($header, 'Location') === 0;
+        }, 0);
+
+        return response()->make($output)->setStatusCode($isRedirect ? 302 : 200);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function checkLocked(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canView(): bool
+    {
+        return true;
+    }
+
+    public function process() : bool
+    {
+        return true;
+    }
+}

core/src/Controllers/Frame.php

@@ -634,7 +634,7 @@ protected function menuRunModules()
                     'module' . $module['id'],
                     'modules',
                     ($module['icon'] != '' ? '<i class="' . $module['icon'] . '"></i>' : '<i class="' . $this->managerTheme->getStyle('icon_module') . '"></i>') . $module['name'],
-                    'index.php?a=112&id=' . $module['id'],
+                    !empty($module['properties']['routes']) ? 'modules/' . $module['id'] . '/' : 'index.php?a=112&id=' . $module['id'],
                     $module['name'],
                     '',
                     '',

core/src/Core.php

@@ -17,6 +17,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Str;
 use PHPMailer\PHPMailer\Exception;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -6571,6 +6572,43 @@ public function getDataForView()
      */
     public function registerModule($name, $file, $icon = 'fa fa-cube', $params = [])
     {
-        $this->modulesFromFile[md5($name)] = ['id' => md5($name), 'name' => $name, 'file' => $file, 'icon' => $icon, 'properties' => $params];
+        if (!$this->isBackend()) {
+            return false;
+        }
+
+        $module_id = md5($name);
+
+        $this->modulesFromFile[$module_id] = [
+            'id' => $module_id,
+            'name' => $name,
+            'file' => $file,
+            'icon' => $icon,
+            'properties' => $params,
+        ];
+
+        return $module_id;
+    }
+
+    /**
+     * @param string $name
+     * @param string $file
+     * @param string $icon
+     * @param array $params
+     */
+    public function registerRoutingModule($name, $file, $icon = 'fa fa-cube')
+    {
+        $params = [
+            'routes' => $file,
+        ];
+
+        if ($module_id = $this->registerModule($name, $file, $icon, $params)) {
+            Route::middleware('mgr')
+                ->prefix('modules/' . $module_id)
+                ->group($file);
+
+            return $module_id;
+        }
+
+        return false;
     }
 }

core/src/ManagerTheme.php

@@ -10,6 +10,8 @@
 use EvolutionCMS\Interfaces\CoreInterface;
 use EvolutionCMS\Models\ActiveUser;
 use EvolutionCMS\Models\UserAttribute;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Route;
 use View;
 
 class ManagerTheme implements ManagerThemeInterface
@@ -371,6 +373,35 @@ public function findController($action)
         return $action === null ? null : get_by_key($this->actions, $action, $action);
     }
 
+    public function handleRoute()
+    {
+        $evo = $this->getCore();
+
+        $request = Request::createFromGlobals();
+        $evo->instance(Request::class, $request);
+        $evo->alias(Request::class, 'request');
+
+        $middleware = config('app.middleware.mgr', []);
+        $evo->router->middlewareGroup('mgr', $middleware);
+
+        $aliases = config('app.middleware.aliases', []);
+
+        foreach ($aliases as $key => $class) {
+            $evo->router->aliasMiddleware($key, $class);
+        }
+
+        Route::middleware('mgr')
+            ->namespace('\\EvolutionCMS\\Controllers')
+            ->group(MODX_MANAGER_PATH . '/routes.php');
+
+        $routes = $evo->router->getRoutes();
+        $routes->refreshNameLookups();
+        $routes->refreshActionLookups();
+
+        $response = $evo->router->dispatch($request);
+        $response->send();
+    }
+
     public function handle($action, array $data = [])
     {
         $this->saveAction($action);
@@ -611,7 +642,7 @@ public function getTemplatePlaceholders(): array
             }else{
                 $plh['login_bg'] = MODX_SITE_URL . $background;
             }
-            
+
             $plh['login_bg'] = MODX_SITE_URL . $background;
         } else {
             $plh['login_bg'] = $this->getThemeUrl() . 'images/login/default/login-background.jpg';

core/src/Middleware/Manager.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace EvolutionCMS\Middleware;
+
+use Closure, ManagerTheme;
+
+class Manager
+{
+    public function handle($request, Closure $next)
+    {
+        // Update last action in table active_users
+        global $action;
+        $action = ManagerTheme::getActionId();
+
+        // accesscontrol.php checks to see if the user is logged in. If not, a log in form is shown
+        if (0 !== $action && ManagerTheme::isAuthManager() === false) {
+            return ManagerTheme::renderLoginPage();
+        }
+
+        // Ignore Logout and LogIn action
+        if (8 !== $action && 0 !== $action && ManagerTheme::hasManagerAccess() === false) {
+            return ManagerTheme::renderAccessPage();
+        }
+
+        return $next($request);
+    }
+}

core/src/Providers/ManagerThemeServiceProvider.php

@@ -2,6 +2,7 @@
 
 use EvolutionCMS\ServiceProvider;
 use EvolutionCMS\ManagerTheme;
+use EvolutionCMS\Interfaces\ManagerThemeInterface;
 
 class ManagerThemeServiceProvider extends ServiceProvider
 {
@@ -33,6 +34,9 @@ public function register()
             );
             return new ManagerTheme($app, $theme);
         });
+
+        $this->app->alias('ManagerTheme', ManagerThemeInterface::class);
+        $this->app->alias('ManagerTheme', ManagerTheme::class);
     }
 
     /**

core/src/Providers/RoutingServiceProvider.php

@@ -16,11 +16,13 @@ public function register()
     {
         parent::register();
 
-        if (is_readable(EVO_CORE_PATH . 'custom/routes.php')) {
-            Route::middleware('web')->group(EVO_CORE_PATH . 'custom/routes.php');
-        }
+        if ($this->app->isFrontend() || is_cli()) {
+            if (is_readable(EVO_CORE_PATH . 'custom/routes.php')) {
+                Route::middleware('web')->group(EVO_CORE_PATH . 'custom/routes.php');
+            }
 
-        Route::fallbackToParser();
+            Route::fallbackToParser();
+        }
     }
 
     /**

manager/ht.access renamed to manager/.htaccess

@@ -1,13 +1,12 @@
 # For unexpected logouts in multi-server/cloud environments see:
 # http://rtfm.modx.com/evolution/1.0/administration/friendly-url-solutions 
 
-# No redirect
-RewriteEngine Off
+RewriteEngine On
+RewriteBase /manager/
 
-# Redirect http to https
-# RewriteEngine On
-# RewriteCond %{HTTPS} off
-# RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^(.*)$ index.php [L,QSA]
 
 <IfModule mod_security.c>
 # Turn the filtering engine Off

manager/index.php

@@ -69,6 +69,10 @@
     define('MODX_API_MODE', false);
 }
 
+if (! defined('IN_PARSER_MODE')) {
+    define('IN_PARSER_MODE', false);
+}
+
 if (file_exists(__DIR__ . '/config.php')) {
     $config = require __DIR__ . '/config.php';
 } elseif (file_exists(dirname(__DIR__) . '/config.php')) {
@@ -150,36 +154,9 @@
 // send the charset header
 header('Content-Type: text/html; charset=' . ManagerTheme::getCharset());
 
-// Update last action in table active_users
-$action = ManagerTheme::getActionId();
-
-// accesscontrol.php checks to see if the user is logged in. If not, a log in form is shown
-if (0 !== $action && ManagerTheme::isAuthManager() === false) {
-    echo ManagerTheme::renderLoginPage();
-    exit;
-}
-
-/** Ignore Logout and LogIn action */
-if (8 !== $action && 0 !== $action && ManagerTheme::hasManagerAccess() === false) {
-    echo ManagerTheme::renderAccessPage();
-    exit;
-}
+$action = 0;
 
 // Update table active_user_sessions
 $modx->updateValidatedUserSession();
 
-$output = '';
-
-if ($action === null) {
-    $_style = ManagerTheme::getStyle();
-    // first we check to see if this is a frameset request
-    if (!isset($_POST['updateMsgCount'])) {
-        EvolutionCMS\Tracy\Debugger::$showBar = false;
-        // this looks to be a top-level frameset request, so let's serve up a frameset
-        $output = ManagerTheme::handle(1, ['frame' => 1]);
-    }
-} else {
-    $output = ManagerTheme::handle($action);
-}
-
-echo $output;
+ManagerTheme::handleRoute();