ActionsService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Exceptions\DomainException;
use Elgg\Project\Paths;
use Elgg\Router\Middleware\ActionMiddleware;
use Elgg\Router\Middleware\AdminGatekeeper;
use Elgg\Router\Middleware\CsrfFirewall;
use Elgg\Router\Middleware\Gatekeeper as MiddlewareGateKeeper;
use Elgg\Router\Middleware\LoggedOutGatekeeper;
use Elgg\Router\RouteRegistrationService;
use Elgg\Traits\Loggable;

class ActionsService {

    use Loggable;
    
    private static $access_levels = ['public', 'logged_in', 'logged_out', 'admin'];

    private static $bypass_csrf = [
        'logout',
    ];

    public function __construct(protected RouteRegistrationService $routes, protected HandlersService $handlers) {
    }

    public function register(string $action, string $handler = '', string $access = 'logged_in', array $params = []): void {
        if (!in_array($access, self::$access_levels)) {
            throw new DomainException("Unrecognized value '{$access}' for \$access in " . __METHOD__);
        }
        
        // plugins are encouraged to call actions with a trailing / to prevent 301
        // redirects but we store the actions without it
        $action = trim($action, '/');

        if (empty($handler)) {
            $path = Paths::elgg() . 'actions';
            $handler = Paths::sanitize("{$path}/{$action}.php", false);
        }

        $file = null;
        $controller = null;

        if (str_ends_with($handler, '.php')) {
            $file = $handler;
        } else {
            $controller = $handler;
        }

        $middleware = [];

        if (!in_array($action, self::$bypass_csrf)) {
            $middleware[] = CsrfFirewall::class;
        }

        if ($access == 'admin') {
            $middleware[] = AdminGatekeeper::class;
        } elseif ($access == 'logged_in') {
            $middleware[] = MiddlewareGateKeeper::class;
        } elseif ($access == 'logged_out') {
            $middleware[] = LoggedOutGatekeeper::class;
        }

        $middleware[] = ActionMiddleware::class;
        
        $additional_middleware = (array) elgg_extract('middleware', $params);
        $middleware = array_merge($middleware, $additional_middleware);

        $this->routes->register("action:{$action}", [
            'path' => "/action/{$action}",
            'file' => $file,
            'controller' => $controller,
            'middleware' => $middleware,
            'walled' => false,
        ]);
    }

    public function unregister(string $action): void {
        $action = trim($action, '/');

        $route = $this->routes->get("action:{$action}");
        if (!$route) {
            return;
        }

        $this->routes->unregister("action:{$action}");
    }

    public function exists(string $action): bool {
        $action = trim($action, '/');
        $route = $this->routes->get("action:$action");
        if (!$route) {
            return false;
        }

        $file = $route->getDefault('_file');
        $controller = $route->getDefault('_controller');

        if (!$file && !$controller) {
            return false;
        }

        if ($file && !file_exists($file)) {
            return false;
        }

        if ($controller && !$this->handlers->isCallable($controller)) {
            return false;
        }

        return true;
    }

    public function getAllActions(): array {
        $actions = [];
        $routes = $this->routes->all();
        foreach ($routes as $name => $route) {
            if (!str_starts_with($name, 'action:')) {
                continue;
            }

            $action = substr($name, 7);

            $access = 'public';
            $middleware = (array) $route->getDefault('_middleware');
            if (in_array(MiddlewareGateKeeper::class, $middleware)) {
                $access = 'logged_in';
            } elseif (in_array(LoggedOutGatekeeper::class, $middleware)) {
                $access = 'logged_out';
            } elseif (in_array(AdminGatekeeper::class, $middleware)) {
                $access = 'admin';
            }

            $actions[$action] = array_filter([
                'file' => $route->getDefault('_file'),
                'controller' => $route->getDefault('_controller'),
                'access' => $access,
            ]);
        }

        return $actions;
    }
}