X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/9135a85de4eef32a91c7a3ee0aa405ed454e5a4c..refs/pull/5239/head:/app/Theming/ThemeEvents.php diff --git a/app/Theming/ThemeEvents.php b/app/Theming/ThemeEvents.php index 91f4fcd67..2d4900c96 100644 --- a/app/Theming/ThemeEvents.php +++ b/app/Theming/ThemeEvents.php @@ -2,8 +2,6 @@ namespace BookStack\Theming; -use BookStack\Entities\Models\Page; - /** * The ThemeEvents used within BookStack. * @@ -25,8 +23,8 @@ class ThemeEvents * The provided $detail can be a string or a loggable type of model. You should check * the type before making use of this parameter. * - * @param string $type - * @param string|\BookStack\Interfaces\Loggable $detail + * @param string $type + * @param string|\BookStack\Activity\Models\Loggable $detail */ const ACTIVITY_LOGGED = 'activity_logged'; @@ -34,7 +32,7 @@ class ThemeEvents * Application boot-up. * After main services are registered. * - * @param \BookStack\Application $app + * @param \BookStack\App\Application $app */ const APP_BOOT = 'app_boot'; @@ -44,19 +42,38 @@ class ThemeEvents * system as a standard app user. This includes a user becoming logged in * after registration. This is not emitted upon API usage. * - * @param string $authSystem - * @param \BookStack\Auth\User $user + * @param string $authSystem + * @param \BookStack\Users\Models\User $user */ const AUTH_LOGIN = 'auth_login'; + /** + * Auth pre-register event. + * Runs right before a new user account is registered in the system by any authentication + * system as a standard app user including auto-registration systems used by LDAP, + * SAML, OIDC and social systems. It only includes self-registrations, + * not accounts created by others in the UI or via the REST API. + * It runs after any other normal validation steps. + * Any account/email confirmation occurs post-registration. + * The provided $userData contains the main details that would be used to create + * the account, and may depend on authentication method. + * If false is returned from the event, registration will be prevented and the user + * will be returned to the login page. + * + * @param string $authSystem + * @param array $userData + * @returns bool|null + */ + const AUTH_PRE_REGISTER = 'auth_pre_register'; + /** * Auth register event. * Runs right after a user is newly registered to the application by any authentication * system as a standard app user. This includes auto-registration systems used - * by LDAP, SAML and social systems. It only includes self-registrations. + * by LDAP, SAML, OIDC and social systems. It only includes self-registrations. * - * @param string $authSystem - * @param \BookStack\Auth\User $user + * @param string $authSystem + * @param \BookStack\Users\Models\User $user */ const AUTH_REGISTER = 'auth_register'; @@ -70,6 +87,19 @@ class ThemeEvents */ const COMMONMARK_ENVIRONMENT_CONFIGURE = 'commonmark_environment_configure'; + /** + * OIDC ID token pre-validate event. + * Runs just before BookStack validates the user ID token data upon login. + * Provides the existing found set of claims for the user as a key-value array, + * along with an array of the proceeding access token data provided by the identity platform. + * If the listener returns a non-null value, that will replace the existing ID token claim data. + * + * @param array $idTokenData + * @param array $accessTokenData + * @returns array|null + */ + const OIDC_ID_TOKEN_PRE_VALIDATE = 'oidc_id_token_pre_validate'; + /** * Page include parse event. * Runs when a page include tag is being parsed, typically when page content is being processed for viewing. @@ -80,11 +110,30 @@ class ThemeEvents * * @param string $tagReference * @param string $replacementHTML - * @param Page $currentPage - * @param ?Page $referencedPage + * @param \BookStack\Entities\Models\Page $currentPage + * @param ?\BookStack\Entities\Models\Page $referencedPage */ const PAGE_INCLUDE_PARSE = 'page_include_parse'; + /** + * Routes register web event. + * Called when standard web (browser/non-api) app routes are registered. + * Provides an app router, so you can register your own web routes. + * + * @param \Illuminate\Routing\Router $router + */ + const ROUTES_REGISTER_WEB = 'routes_register_web'; + + /** + * Routes register web auth event. + * Called when auth-required web (browser/non-api) app routes can be registered. + * These are routes that typically require login to access (unless the instance is made public). + * Provides an app router, so you can register your own web routes. + * + * @param \Illuminate\Routing\Router $router + */ + const ROUTES_REGISTER_WEB_AUTH = 'routes_register_web_auth'; + /** * Web before middleware action. * Runs before the request is handled but after all other middleware apart from those @@ -103,7 +152,7 @@ class ThemeEvents * Provides both the original request and the currently resolved response. * Return values, if provided, will be used as a new response to use. * - * @param \Illuminate\Http\Request $request + * @param \Illuminate\Http\Request $request * @param \Illuminate\Http\Response|\Symfony\Component\HttpFoundation\BinaryFileResponse $response * @returns \Illuminate\Http\Response|null */ @@ -119,11 +168,12 @@ class ThemeEvents * If the listener returns a non-null value, that will be used as the POST data instead * of the system default. * - * @param string $event - * @param \BookStack\Actions\Webhook $webhook - * @param string|\BookStack\Interfaces\Loggable $detail - * @param \BookStack\Auth\User $initiator - * @param int $initiatedTime + * @param string $event + * @param \BookStack\Activity\Models\Webhook $webhook + * @param string|\BookStack\Activity\Models\Loggable $detail + * @param \BookStack\Users\Models\User $initiator + * @param int $initiatedTime + * @returns array|null */ const WEBHOOK_CALL_BEFORE = 'webhook_call_before'; }