6e098905d4
This adds specific handling for functions.php error loading to re-throw errors wrapped in a more descriptive message, to make it clear the error is due to an issue in their functions.php file. Decided to throw and stop, rather than ignore & continue, to be on the safe side in the event auth-level (or other security level) customizations have been made via functions.php. Adds test to cover. Closes #4504
84 lines
2.5 KiB
PHP
84 lines
2.5 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Theming;
|
|
|
|
use BookStack\Access\SocialAuthService;
|
|
use BookStack\Exceptions\ThemeException;
|
|
use Illuminate\Console\Application;
|
|
use Illuminate\Console\Application as Artisan;
|
|
use Symfony\Component\Console\Command\Command;
|
|
|
|
class ThemeService
|
|
{
|
|
/**
|
|
* @var array<string, callable[]>
|
|
*/
|
|
protected array $listeners = [];
|
|
|
|
/**
|
|
* Listen to a given custom theme event,
|
|
* setting up the action to be ran when the event occurs.
|
|
*/
|
|
public function listen(string $event, callable $action): void
|
|
{
|
|
if (!isset($this->listeners[$event])) {
|
|
$this->listeners[$event] = [];
|
|
}
|
|
|
|
$this->listeners[$event][] = $action;
|
|
}
|
|
|
|
/**
|
|
* Dispatch the given event name.
|
|
* Runs any registered listeners for that event name,
|
|
* passing all additional variables to the listener action.
|
|
*
|
|
* If a callback returns a non-null value, this method will
|
|
* stop and return that value itself.
|
|
*/
|
|
public function dispatch(string $event, ...$args): mixed
|
|
{
|
|
foreach ($this->listeners[$event] ?? [] as $action) {
|
|
$result = call_user_func_array($action, $args);
|
|
if (!is_null($result)) {
|
|
return $result;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Register a new custom artisan command to be available.
|
|
*/
|
|
public function registerCommand(Command $command): void
|
|
{
|
|
Artisan::starting(function (Application $application) use ($command) {
|
|
$application->addCommands([$command]);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Read any actions from the set theme path if the 'functions.php' file exists.
|
|
*/
|
|
public function readThemeActions(): void
|
|
{
|
|
$themeActionsFile = theme_path('functions.php');
|
|
if ($themeActionsFile && file_exists($themeActionsFile)) {
|
|
try {
|
|
require $themeActionsFile;
|
|
} catch (\Error $exception) {
|
|
throw new ThemeException("Failed loading theme functions file at \"{$themeActionsFile}\" with error: {$exception->getMessage()}");
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see SocialAuthService::addSocialDriver
|
|
*/
|
|
public function addSocialDriver(string $driverName, array $config, string $socialiteHandler, callable $configureForRedirect = null): void
|
|
{
|
|
$socialAuthService = app()->make(SocialAuthService::class);
|
|
$socialAuthService->addSocialDriver($driverName, $config, $socialiteHandler, $configureForRedirect);
|
|
}
|
|
}
|