diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,88 @@ +# v1.4.0 (unreleased) + +## Highlights +- 🚀 Improved Dev Server: faster, more reliable reloads without race conditions. +- 📦 Ecosystem split: IHP now modular (`ihp-ide`, `ihp-ssc`, `ihp-migrate`, `ihp-sitemap`). +- 🔧 New helpers: `createRecordDiscardResult`, `copyRecord`, `queryUnionList`, `orderByAscJoinedTable`. +- 🛠️ Production-ready: warp + systemd integration, healthcheck endpoint, better job runner handling. +- 🐘 Compiler upgrade: GHC 9.8 (with support for 9.10 and 9.12). + +--- + +## Major Changes +- [Added `createRecordDiscardResult`](https://github.com/digitallyinduced/ihp/commit/c7cbbef728d96f85493494afba8da15d6bf96e70) (complements `updateRecordDiscardResult`) for cases where the result is not needed (e.g. scheduling jobs). +- [Added `copyRecord`](https://github.com/digitallyinduced/ihp/commit/06e5e30ebe1d9b95d5cbebb3e04513e33ab607e2) for easier duplication of database records. +- [Improved Dev Server](https://github.com/digitallyinduced/ihp/pull/2050) reliability and performance. Race conditions on rapid file updates are fixed by using proper bracketed resource management. +- Split IHP into multiple packages ([`ihp-ide`](https://github.com/digitallyinduced/ihp/commit/6b21f550d8a6d843ee85c09150b8e2ba587df248), [`ihp-ssc`](https://github.com/digitallyinduced/ihp/commit/50fbe028cb2ef5e3646ce5ab59077be68f5a0df1), [`ihp-migrate`](https://github.com/digitallyinduced/ihp/commit/de021bb3161c8be384a10571963470956aac753c), [`ihp-sitemap`](https://github.com/digitallyinduced/ihp/commit/996e2431ce7a0e74bbb920cfed6ce7d53f668f58)) for cleaner dependency boundaries. +- Production improvements: [integrated `warp-systemd`](https://github.com/digitallyinduced/ihp/commit/d0cf5c6fafa151f3052b39d15f2691f487cefeb4), [added healthcheck endpoint](https://github.com/digitallyinduced/ihp/commit/7b685e696c8f7474ac20cd1737525f4bd50566a6), and [improved socket activation](https://github.com/digitallyinduced/ihp/commit/250da5a3d569afdd048b135d8e0f7db8de55f719). +- [Upgraded to GHC 9.8](https://github.com/digitallyinduced/ihp/commit/a1b0ebb429ae5e95278405be4611b74365e795bb), with support for [9.10.x and 9.12.x](https://github.com/digitallyinduced/ihp/commit/5611f77306c076c2a8c2a89b3efcf3afd54fd7fd). + +## Minor Changes + +### Nix / Deployment +- [Added options: `rtsFlags`, `optimizationLevel`, `appName`](https://github.com/digitallyinduced/ihp/commit/5718a7cdfb3984958ce78ed9c958ce8bf686a7c2). +- [Support for aarch64 NixOS deployments](https://github.com/digitallyinduced/ihp/commit/fa107a604511d383bddf163211b406aa6f28ff5b). +- [Faster `nix build` via caching of `Generated.Types`](https://github.com/digitallyinduced/ihp/commit/b5e5cdafc4d0980c333db0afcafaf038be4e2eee). +- [Simplified migration service (`IHP_MIGRATION_DIR`)](https://github.com/digitallyinduced/ihp/commit/5684d1a214c2bd1c34fc314f7a4bd3265dd8b4c8). +- [Dropped dependency on `ihp` source](https://github.com/digitallyinduced/ihp/commit/d93f07e0bc6aa38e58f3219ce109ef73d1157460) to reduce closure size. +- [Updated nixpkgs to 25.05 and devenv to 1.8.2](https://github.com/digitallyinduced/ihp/commit/42060df96e10ab31c5b56b07cf9db15646235964). +- [Use flake overlays instead of manual `mkGhcCompiler`](https://github.com/digitallyinduced/ihp/commit/03675cea869226fdb4e46acea1f99391bd94af22). +- [Don’t set `system.stateVersion`](https://github.com/digitallyinduced/ihp/commit/bc9a676bed1775a6ebfda35b499b7630cbcd5c7d) automatically (configured in project’s `flake.nix`). + +### Job Runner +- [Jobs with timeouts are now restarted if workers crash](https://github.com/digitallyinduced/ihp/commit/c33034ca77d44f5e2d4ec7ab652f66b3ed028acb). +- [Improved async handling of jobrunner](https://github.com/digitallyinduced/ihp/commit/11377c503be9fa38ad369d3a52c91d1952c5afb1). +- [Use `ResourceT` for job worker scheduling](https://github.com/digitallyinduced/ihp/commit/30d1a156a25ecf350291c634e7909b19c2dc447f) to avoid leaks. +- [Exceptions are now printed to logs](https://github.com/digitallyinduced/ihp/commit/9de03cd652aa69859eda1c0df8951bd7a99e2f4f) for easier debugging. +- [Don’t log job worker SQL queries](https://github.com/digitallyinduced/ihp/commit/54948a62307b829675e37b49754e324d7f292145). + +### DataSync +- Fixes: [arrays double-escaped](https://github.com/digitallyinduced/ihp/commit/ad90fc222159bb07235c3f66afd39e8422ee1049), [connections closed prematurely](https://github.com/digitallyinduced/ihp/commit/611b881d29cdb4be32887c356332510d06951273), [crash with spaces in table names](https://github.com/digitallyinduced/ihp/commit/c37be20011ded07120f4ee6efd75175ee52f7438), [non-snake_case column names](https://github.com/digitallyinduced/ihp/commit/96d41a5d9f68aef9514bd8950e7c91ff4787db03). +- Features: [added `useCount`](https://github.com/digitallyinduced/ihp/commit/9bc16f6ff1c85a2dab1040dedc8a9fce2c56b26), [custom `newRecordBehaviour`](https://github.com/digitallyinduced/ihp/commit/d1613e631f6542d5aef4d021ef8f2f253784e090), [support for event triggers](https://github.com/digitallyinduced/ihp/commit/51d17d24eee0bb50e64c53acb2e15a5d19440974), [React 18 `useSyncExternalStore`](https://github.com/digitallyinduced/ihp/commit/1ffdf28bcf956fda43561d1a4670994c2334f570). +- [Avoid creating `large_pg_notifications` table when not needed](https://github.com/digitallyinduced/ihp/commit/6fc9158647619cf50a8bf2c7ade9f7f1b4aa274c). + +### HSX / View Layer +- [Added `uncheckedHsx` and `customHsx`](https://github.com/digitallyinduced/ihp/commit/61bc6a7365f4d545a5a7bd120d5186dfbb65ab36). +- [Lucid2 port and core library split](https://github.com/digitallyinduced/ihp/commit/7649fbd06e373c3564ea920f518902ebaf37659c). +- [Added missing HTML attributes](https://github.com/digitallyinduced/ihp/commit/ba748e871dac4e73b26f66dfc6ad5ede2f48e5c9). +- [Fixed generator issues (brackets, variable references, migrations)](https://github.com/digitallyinduced/ihp/commit/e02a4e38e2475329ec40413d80becb464811b8a1). +- [Use Blaze helpers in HSX](https://github.com/digitallyinduced/ihp/commit/50fa3ce43afb87d93710ed6c59b3894bb5c24634). + +### SQL / Query Layer +- [Added `filterWhereInCaseInsensitive`](https://github.com/digitallyinduced/ihp/commit/012c7a3c03437109426c64b7c98189b6d639ca44), [`queryUnionList`](https://github.com/digitallyinduced/ihp/commit/d9fe4048f38812b887edf2614052d2116f0a8741), [`orderByAscJoinedTable` / `orderByDescJoinedTable`](https://github.com/digitallyinduced/ihp/commit/dcabc288485457258fdeb508f3fd8e7c4ea63986). +- [Refactored pagination queries](https://github.com/digitallyinduced/ihp/commit/2cd71cfd23156089975a4a27e4c82b4be5b663b4). +- Logging improvements: [show final SQL](https://github.com/digitallyinduced/ihp/commit/0265137b47702f88641ebb7e01d5c8f366f4be01), [rounded runtimes](https://github.com/digitallyinduced/ihp/commit/1fb65084fdf306978da4b42ba3d86f3a17f4efc2), [simplified log format with icons](https://github.com/digitallyinduced/ihp/commit/903e44d521ac673a6414f4c3ae33a1185e8581eb). + +### Storage +- [Support custom storage directory via `IHP_STORAGE_DIR`](https://github.com/digitallyinduced/ihp/commit/2c23415e2fb002a9b0f7d0320cdc45dc3d6af838). +- [Support custom filenames in `storeFileFromPath`](https://github.com/digitallyinduced/ihp/commit/c570fb1b5b0d0365a534a85424c32293c4774504). +- [S3 `storagePrefix` now returns base URL](https://github.com/digitallyinduced/ihp/commit/157c0709dc292f0e55142f57e1e222c247f5fc2a). +- [Fix `createTemporaryDownloadUrlFromPath`](https://github.com/digitallyinduced/ihp/commit/145d3c52a45e97d04f22c264212ac6befd6d6fa3). + +### Miscellaneous +- [Support custom base URL in `assetPath`](https://github.com/digitallyinduced/ihp/commit/459e72cbb01fdb337b12f0284e9fc368bf2e0845). +- [Add `withPGListener`](https://github.com/digitallyinduced/ihp/commit/c02be01a43b546ffe3439cd3eb82537dbc8c1611). +- [Always evaluate Blaze HTML](https://github.com/digitallyinduced/ihp/commit/2fe1b63319d35da1cf55b7666273ad1751873583). +- [Added `mainInParentDirectory`](https://github.com/digitallyinduced/ihp/commit/27a696af90efcd0f84260d84805dd2dc753e818c). +- [Enabled warp file cache in production](https://github.com/digitallyinduced/ihp/commit/acbb143cc9eae0ac32fa072dbbc7421191d81c00). +- [Set default gracefulShutdownTimeout](https://github.com/digitallyinduced/ihp/commit/58cc32da1264aeb581d6abd6fa87971acc82160a). +- [Improved schema compiler performance](https://github.com/digitallyinduced/ihp/commit/0a779b798050440c373aa50f70314cf3b4916f69). + +## IHP OpenAI +- [Removed deprecated `prompt` field](https://github.com/digitallyinduced/ihp/commit/7d6f039c68a69ac50a3c99b1eafc4b5964c1563f). +- [Added support for tools and tool calls](https://github.com/digitallyinduced/ihp/commit/413b95fec6b31106b5fef902571a8bff7098acf9), [`response_format`](https://github.com/digitallyinduced/ihp/commit/c2aec3302f1a2d31cafaa2129ce88faf0eef7e07), [Anthropic `cache_control`](https://github.com/digitallyinduced/ihp/commit/6604104ae177406737c6594cf56760ebec1f4e1f), [Google Gemini](https://github.com/digitallyinduced/ihp/commit/e22491b10b9749266590758db7a3fe5bb97df98a). +- [Added `extraHeaders`](https://github.com/digitallyinduced/ihp/commit/0b50e7076ec08ec5dcb32887fcbacb72909cbb74), [`finish_reason`](https://github.com/digitallyinduced/ihp/commit/4d1fc1a5242994be542ceac87ceeed05a69f7d5b), [`usage` in streaming responses](https://github.com/digitallyinduced/ihp/commit/6931a682f99ea6471b6a6c11b1e3213961b87449). +- [Changed `maxTokens`, `temperature`, `presencePenalty`, `frequencyPenalty` to `Maybe`](https://github.com/digitallyinduced/ihp/commit/3ccc20e51978e6564e290a3e21a7d61bd4a3576c). +- [Improved error messages](https://github.com/digitallyinduced/ihp/commit/92c774224d6b40350e4efcdb9ee29cdd9df51ad9) and [quota exceeded feedback](https://github.com/digitallyinduced/ihp/commit/807047c6d716942ce0bbcbdd5e5db65c634264ac). +- [Added `reasoningEffort`](https://github.com/digitallyinduced/ihp/commit/f0fea79ce9bbeb0ea9154a48ee6d2bc940fdcb60) and [`parallelToolCalls`](https://github.com/digitallyinduced/ihp/commit/9e3c3983bd3942311ea23eb0e4f8b98247abdc47). +- [`system_fingerprint` is now optional](https://github.com/digitallyinduced/ihp/commit/290c462779adc1343d92f258b4a2073ea6a3ba49). + +## Documentation +- [Improved deployment docs](https://github.com/digitallyinduced/ihp/commit/dcf28e67cefe96fc9fb46058dbbb1267225b5f63) (workers, systemd integration, AWS Terraform). +- [Updated guides](https://github.com/digitallyinduced/ihp/commit/d0d3cd0ff710c4a6d11b863b382f0e876c205093) for pagination, htmx, realtime SPAs. +- [Clarified environment differences between dev/prod](https://github.com/digitallyinduced/ihp/commit/56ef57a22462ad41e3f513f8725ec8c2878f2ab3). +- [Added docs for `validateFieldIO`](https://github.com/digitallyinduced/ihp/commit/9c7476d68c489fec454543d1a0d993fa22227172) and [scheduled job execution with `runAt`](https://github.com/digitallyinduced/ihp/commit/0ac5d136a565303d00609f1536b1b5e6a656d858). +- [Removed outdated NixOS installation instructions](https://github.com/digitallyinduced/ihp/commit/de206e94807d3c00cb759ecb5ac0552c52ec9855). +- [Cleaned up Emacs docs](https://github.com/digitallyinduced/ihp/commit/3821f80b3a6abe12cc5bb29893fb32538aa05626). +- [Added troubleshooting notes for EC2 deployments](https://github.com/digitallyinduced/ihp/commit/5ae4b04d0c05e593347b2032a2243f7aefff5dca). + diff --git a/IHP/ApplicationContext.hs b/IHP/ApplicationContext.hs new file mode 100644 --- /dev/null +++ b/IHP/ApplicationContext.hs @@ -0,0 +1,13 @@ +module IHP.ApplicationContext where + +import IHP.Prelude +import IHP.AutoRefresh.Types (AutoRefreshServer) +import IHP.FrameworkConfig (FrameworkConfig) +import IHP.PGListener (PGListener) + +data ApplicationContext = ApplicationContext + { modelContext :: !ModelContext + , autoRefreshServer :: !(IORef AutoRefreshServer) + , frameworkConfig :: !FrameworkConfig + , pgListener :: PGListener + } diff --git a/IHP/Assets/Types.hs b/IHP/Assets/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Assets/Types.hs @@ -0,0 +1,17 @@ +{-| +Module: IHP.Assets.Types +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.Assets.Types +( AssetVersion (..) +) where + +import IHP.Prelude + +-- | Stores the version appended to CSS and JS files via the @?v=..@ query parameter +-- +-- __Example:__ An asset path where the @AssetVersion@ was set to @"dev"@ +-- +-- > "/app.css?v=dev" +-- +newtype AssetVersion = AssetVersion Text diff --git a/IHP/Assets/ViewFunctions.hs b/IHP/Assets/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Assets/ViewFunctions.hs @@ -0,0 +1,37 @@ +{-| +Module: IHP.Assets.ViewFunctions +Description: Functions for dealing with CSS and JS files, e.g. 'assetPath' +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.Assets.ViewFunctions +( assetPath +, assetVersion +) where + +import IHP.Prelude +import IHP.Controller.Context +import qualified IHP.FrameworkConfig as Config + +-- | Adds a cache buster to a asset path +-- +-- >>> assetPath "/keyhandlers.js" +-- "/keyhandlers.js?v=9be8995c-7055-43d9-a1b2-43e05c210271" +-- +-- The asset version can be configured using the +-- @IHP_ASSET_VERSION@ environment variable. +assetPath :: (?context :: ControllerContext) => Text -> Text +assetPath assetPath = baseUrl <> assetPath <> "?v=" <> assetVersion + where + baseUrl = fromMaybe "" ?context.frameworkConfig.assetBaseUrl +{-# INLINABLE assetPath #-} + +-- | Returns the assetVersion +-- +-- >>> assetVersion +-- "9be8995c-7055-43d9-a1b2-43e05c210271" +-- +-- The asset version can be configured using the +-- @IHP_ASSET_VERSION@ environment variable. +assetVersion :: (?context :: ControllerContext) => Text +assetVersion = ?context.frameworkConfig.assetVersion +{-# INLINABLE assetVersion #-} diff --git a/IHP/AuthSupport/Authentication.hs b/IHP/AuthSupport/Authentication.hs new file mode 100644 --- /dev/null +++ b/IHP/AuthSupport/Authentication.hs @@ -0,0 +1,63 @@ +{-| +Module: IHP.AuthSupport.Authentication +Description: Authentication functions +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.AuthSupport.Authentication (verifyPassword, hashPassword, generateAuthenticationToken, Lockable (maxSignInAttemps), VerifiyPassword (..)) where + +import IHP.Prelude +import qualified Crypto.PasswordStore +import qualified Test.RandomStrings + +class Lockable entity where + maxSignInAttemps :: entity -> Int + +passwordStrength :: Int +passwordStrength = 17 + +-- | Creates a password hash +-- +-- __Example:__ +-- +-- > action CreateUserAction = do +-- > newRecord @User +-- > |> fill @'["passwordHash"] +-- > |> validateField nonEmpty #passwordHash +-- > |> ifValid \case +-- > Left user -> .. +-- > Right user -> do +-- > user <- user.passwordHash |> liftIO . hashPassword +-- > user <- createRecord user +-- > +hashPassword :: Text -> IO Text +hashPassword plainText = cs <$> Crypto.PasswordStore.makePassword (cs plainText) passwordStrength +{-# INLINE hashPassword #-} + + +class VerifiyPassword a where + verifyPassword' :: a -> Text -> Bool + +instance VerifiyPassword Text where + verifyPassword' passwordHash plainText = Crypto.PasswordStore.verifyPassword (cs plainText) (cs passwordHash) + +instance VerifiyPassword (Maybe Text) where + verifyPassword' (Just passwordHash) plainText = verifyPassword' passwordHash plainText + verifyPassword' Nothing _ = False + +-- | Returns @True@ when a given non-hashed password matches the hashed password of the given user. +-- +-- >>> user <- query @User |> filterWhere (#email, "hunter2@outlook.com") |> fetchOne +-- >>> verifyPassword user "hunter2" +-- True +verifyPassword :: (HasField "passwordHash" entity passwordField, VerifiyPassword passwordField) => entity -> Text -> Bool +verifyPassword entity plainText = verifyPassword' entity.passwordHash plainText +{-# INLINE verifyPassword #-} + + +-- | Generates a 32 character random string +-- +-- >>> token <- generateAuthenticationToken +-- "11D3OAbUfL0P9KNJ09VcUfCO0S9RwI" +generateAuthenticationToken :: IO Text +generateAuthenticationToken = cs <$> Test.RandomStrings.randomWord Test.RandomStrings.randomASCII 32 +{-# INLINE generateAuthenticationToken #-} diff --git a/IHP/AuthSupport/Controller/Sessions.hs b/IHP/AuthSupport/Controller/Sessions.hs new file mode 100644 --- /dev/null +++ b/IHP/AuthSupport/Controller/Sessions.hs @@ -0,0 +1,192 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-| +Module: IHP.AuthSupport.Controller.Sessions +Description: Provides action implementations for SessionControllers +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.AuthSupport.Controller.Sessions +( newSessionAction +, createSessionAction +, deleteSessionAction +, SessionsControllerConfig (..) +) +where + +import IHP.Prelude +import IHP.ControllerPrelude hiding (Success, currentUserOrNothing) +import IHP.AuthSupport.View.Sessions.New +import IHP.ViewSupport (View) +import Data.Data +import qualified IHP.AuthSupport.Lockable as Lockable +import System.IO.Unsafe (unsafePerformIO) + +-- | Displays the login form. +-- +-- In case the user is already logged in, redirects to the home page ('afterLoginRedirectPath'). +newSessionAction :: forall record action. + ( ?theAction :: action + , ?context :: ControllerContext + , HasNewSessionUrl record + , ?modelContext :: ModelContext + , Typeable record + , View (NewView record) + , Data action + , Record record + , HasPath action + , SessionsControllerConfig record + ) => IO () +newSessionAction = do + let alreadyLoggedIn = isJust (currentUserOrNothing @record) + when alreadyLoggedIn (redirectToPath (afterLoginRedirectPath @record)) + + let user = newRecord @record + render NewView { .. } +{-# INLINE newSessionAction #-} + +-- | Logs in a user when a valid email and password is given +-- +-- After 10 failed attempts, the user is locked for an hours. See 'maxFailedLoginAttempts' to customize this. +-- +-- After a successful login, the user is redirect to 'afterLoginRedirectPath'. +createSessionAction :: forall record action. + (?theAction :: action + , ?context :: ControllerContext + , ?modelContext :: ModelContext + , Data action + , HasField "email" record Text + , HasPath action + , HasField "id" record (Id record) + , HasField "passwordHash" record Text + , SessionsControllerConfig record + , UpdateField "lockedAt" record record (Maybe UTCTime) (Maybe UTCTime) + , HasField "failedLoginAttempts" record Int + , SetField "failedLoginAttempts" record Int + , CanUpdate record + , Show (PrimaryKey (GetTableName record)) + , record ~ GetModelByTableName (GetTableName record) + , Table record + ) => IO () +createSessionAction = do + usersQueryBuilder + |> filterWhereCaseInsensitive (#email, param "email") + |> fetchOneOrNothing + >>= \case + Just (user :: record) -> do + isLocked <- Lockable.isLocked user + when isLocked do + setErrorMessage "User is locked" + redirectTo buildNewSessionAction + + if verifyPassword user (param @Text "password") + then do + beforeLogin user + login user + user <- user + |> set #failedLoginAttempts 0 + |> updateRecord + redirectUrl <- getSessionAndClear "IHP.LoginSupport.redirectAfterLogin" + redirectToPath (fromMaybe (afterLoginRedirectPath @record) redirectUrl) + else do + setErrorMessage "Invalid Credentials" + user :: record <- user + |> incrementField #failedLoginAttempts + |> updateRecord + when (user.failedLoginAttempts >= maxFailedLoginAttempts user) do + Lockable.lock user + pure () + redirectTo buildNewSessionAction + Nothing -> do + setErrorMessage "Invalid Credentials" + redirectTo buildNewSessionAction +{-# INLINE createSessionAction #-} + +-- | Logs out the user and redirects to `afterLogoutRedirectPath` or login page by default +deleteSessionAction :: forall record action id. + ( ?theAction :: action + , ?context :: ControllerContext + , ?modelContext :: ModelContext + , Data action + , HasPath action + , Show id + , HasField "id" record id + , SessionsControllerConfig record + ) => IO () +deleteSessionAction = do + case currentUserOrNothing @record of + Just user -> do + beforeLogout user + logout user + Nothing -> pure () + redirectToPath (afterLogoutRedirectPath @record) +{-# INLINE deleteSessionAction #-} + +currentUserOrNothing :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user) => (Maybe user) +currentUserOrNothing = + case unsafePerformIO (maybeFromContext @(Maybe user)) of + Just user -> user + Nothing -> error "currentUserOrNothing: initAuthentication has not been called in initContext inside FrontController of this application" +{-# INLINE currentUserOrNothing #-} + +-- | Returns the NewSessionAction action for the given SessionsController +buildNewSessionAction :: forall controller. (?theAction :: controller, Data controller) => controller +buildNewSessionAction = fromConstr createConstructor + where + createConstructor :: Constr + (Just createConstructor) = find isNewSessionConstructor allConstructors + + allConstructors :: [Constr] + allConstructors = dataTypeConstrs (dataTypeOf ?theAction) + + isNewSessionConstructor :: Constr -> Bool + isNewSessionConstructor constructor = "NewSessionAction" == showConstr constructor +{-# INLINE buildNewSessionAction #-} + +-- | Configuration for the session controller actions +class ( Typeable record + , Show record + , KnownSymbol (GetModelName record) + , HasNewSessionUrl record + , KnownSymbol (GetTableName record) + , FromRow record + ) => SessionsControllerConfig record where + + -- | Your home page, where the user is redirect after login, by default it's @/@ + afterLoginRedirectPath :: Text + afterLoginRedirectPath = "/" + + -- | Where the user is redirected after logout, by default it's @/NewSession@ + afterLogoutRedirectPath :: forall action. (?theAction :: action, Data action, HasPath action) => Text + afterLogoutRedirectPath = pathTo buildNewSessionAction + + -- | After 10 failed login attempts the user will be locked for an hour + maxFailedLoginAttempts :: record -> Int + maxFailedLoginAttempts _ = 10 + + -- | Callback that is executed just before the user is logged in + -- + -- This is called only after checking that the password is correct. When a wrong password is given this callback is not executed. + -- + -- __Example: Disallow login until user is confirmed__ + -- + -- > beforeLogin user = do + -- > unless (user.isConfirmed) do + -- > setErrorMessage "Please click the confirmation link we sent to your email before you can use the App" + -- > redirectTo NewSessionAction + beforeLogin :: (?context :: ControllerContext, ?modelContext :: ModelContext) => record -> IO () + beforeLogin _ = pure () + + -- | Callback that is executed just before the user is logged out + -- + -- This is called only if user session exists + beforeLogout :: (?context :: ControllerContext, ?modelContext :: ModelContext) => record -> IO () + beforeLogout _ = pure () + + -- | Return's the @query\ \@User@ used by the controller. Customize this to e.g. exclude guest users from logging in. + -- + -- __Example: Exclude guest users from login__ + -- + -- > usersQueryBuilder = query @User |> filterWhere (#isGuest, False) + -- + usersQueryBuilder :: (GetModelByTableName (GetTableName record) ~ record, Table record) => QueryBuilder (GetTableName record) + usersQueryBuilder = query @record + {-# INLINE usersQueryBuilder #-} diff --git a/IHP/AuthSupport/Lockable.hs b/IHP/AuthSupport/Lockable.hs new file mode 100644 --- /dev/null +++ b/IHP/AuthSupport/Lockable.hs @@ -0,0 +1,26 @@ +module IHP.AuthSupport.Lockable where + +import IHP.Prelude + +lock :: forall user. (?modelContext :: ModelContext, CanUpdate user, UpdateField "lockedAt" user user (Maybe UTCTime) (Maybe UTCTime)) => user -> IO user +lock user = do + now <- getCurrentTime + let currentLockedAt :: Maybe UTCTime = user.lockedAt + let user' :: user = updateField @"lockedAt" (Just now) user + updateRecord user' + +lockDuration :: NominalDiffTime +lockDuration = let timeInSecs = 60 * 60 in secondsToNominalDiffTime timeInSecs + +isLocked :: forall user. (HasField "lockedAt" user (Maybe UTCTime)) => user -> IO Bool +isLocked user = do + now <- getCurrentTime + pure (isLocked' now user) + +isLocked' :: forall user. (HasField "lockedAt" user (Maybe UTCTime)) => UTCTime -> user -> Bool +isLocked' now user = + case user.lockedAt of + Just lockedAt -> + let diff = diffUTCTime now lockedAt + in diff < lockDuration + Nothing -> False diff --git a/IHP/AuthSupport/View/Sessions/New.hs b/IHP/AuthSupport/View/Sessions/New.hs new file mode 100644 --- /dev/null +++ b/IHP/AuthSupport/View/Sessions/New.hs @@ -0,0 +1,4 @@ +module IHP.AuthSupport.View.Sessions.New where +import IHP.Prelude + +data NewView user = NewView { user :: user } deriving (Typeable) diff --git a/IHP/AutoRefresh.hs b/IHP/AutoRefresh.hs new file mode 100644 --- /dev/null +++ b/IHP/AutoRefresh.hs @@ -0,0 +1,253 @@ +{-| +Module: IHP.AutoRefresh +Description: Provides automatically diff-based refreshing views after page load +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.AutoRefresh where + +import IHP.Prelude +import IHP.AutoRefresh.Types +import IHP.ControllerSupport +import IHP.ApplicationContext +import qualified Data.UUID.V4 as UUID +import qualified Data.UUID as UUID +import IHP.Controller.Session +import qualified Network.Wai.Internal as Wai +import qualified Data.Binary.Builder as ByteString +import qualified Data.Set as Set +import IHP.ModelSupport +import qualified Control.Exception as Exception +import qualified Control.Concurrent.MVar as MVar +import qualified Data.Maybe as Maybe +import qualified Data.Text as Text +import IHP.WebSocket +import IHP.Controller.Context +import IHP.Controller.Response +import qualified IHP.PGListener as PGListener +import qualified Database.PostgreSQL.Simple.Types as PG +import Data.String.Interpolate.IsString + +initAutoRefresh :: (?context :: ControllerContext, ?applicationContext :: ApplicationContext) => IO () +initAutoRefresh = do + putContext AutoRefreshDisabled + putContext ?applicationContext.autoRefreshServer + +autoRefresh :: ( + ?theAction :: action + , Controller action + , ?modelContext :: ModelContext + , ?context :: ControllerContext + ) => ((?modelContext :: ModelContext) => IO ()) -> IO () +autoRefresh runAction = do + autoRefreshState <- fromContext @AutoRefreshState + autoRefreshServer <- fromContext @(IORef AutoRefreshServer) + + case autoRefreshState of + AutoRefreshDisabled -> do + availableSessions <- getAvailableSessions autoRefreshServer + + id <- UUID.nextRandom + + -- We save the current state of the controller context here. This includes e.g. all current + -- flash messages, the current user, ... + -- + -- This frozen context is used as a "template" inside renderView to make a new controller context + -- with the exact same content we had when rendering the initial page, whenever we do a server-side re-rendering + frozenControllerContext <- freeze ?context + + let renderView = \requestContext -> do + controllerContext <- unfreeze frozenControllerContext + let ?context = controllerContext { requestContext } + action ?theAction + + putContext (AutoRefreshEnabled id) + + -- We save the allowed session ids to the session cookie to only grant a client access + -- to sessions it initially opened itself + -- + -- Otherwise you might try to guess session UUIDs to access other peoples auto refresh sessions + setSession "autoRefreshSessions" (map UUID.toText (id:availableSessions) |> Text.intercalate "") + + withTableReadTracker do + let handleResponse exception@(ResponseException response) = case response of + Wai.ResponseBuilder status headers builder -> do + tables <- readIORef ?touchedTables + lastPing <- getCurrentTime + + -- It's important that we evaluate the response to HNF here + -- Otherwise a response `error "fail"` will break auto refresh and cause + -- the action to be unreachable until the server is restarted. + -- + -- Specifically a request like this will crash the action: + -- + -- > curl --header 'Accept: application/json' http://localhost:8000/ShowItem?itemId=6bbe1a72-400a-421e-b26a-ff58d17af3e5 + -- + -- Let's assume that the view has no implementation for JSON responses. Then + -- it will render a 'error "JSON not implemented"'. After this curl request + -- all future HTML requests to the current action will fail with a 503. + -- + lastResponse <- Exception.evaluate (ByteString.toLazyByteString builder) + + event <- MVar.newEmptyMVar + let session = AutoRefreshSession { id, renderView, event, tables, lastResponse, lastPing } + modifyIORef' autoRefreshServer (\s -> s { sessions = session:s.sessions } ) + async (gcSessions autoRefreshServer) + + registerNotificationTrigger ?touchedTables autoRefreshServer + + throw exception + _ -> error "Unimplemented WAI response type." + + runAction `Exception.catch` handleResponse + AutoRefreshEnabled {} -> do + -- When this function calls the 'action ?theAction' in the other case + -- we will evaluate this branch + runAction + +data AutoRefreshWSApp = AwaitingSessionID | AutoRefreshActive { sessionId :: UUID } +instance WSApp AutoRefreshWSApp where + initialState = AwaitingSessionID + + run = do + sessionId <- receiveData @UUID + setState AutoRefreshActive { sessionId } + + availableSessions <- getAvailableSessions ?applicationContext.autoRefreshServer + + when (sessionId `elem` availableSessions) do + AutoRefreshSession { renderView, event, lastResponse } <- getSessionById sessionId + + let handleResponseException (ResponseException response) = case response of + Wai.ResponseBuilder status headers builder -> do + let html = ByteString.toLazyByteString builder + + when (html /= lastResponse) do + sendTextData html + updateSession sessionId (\session -> session { lastResponse = html }) + _ -> error "Unimplemented WAI response type." + + async $ forever do + MVar.takeMVar event + let requestContext = ?context.requestContext + (renderView requestContext) `catch` handleResponseException + pure () + + pure () + + -- Keep the connection open until it's killed and the onClose is called + forever receiveDataMessage + + onPing = do + now <- getCurrentTime + AutoRefreshActive { sessionId } <- getState + updateSession sessionId (\session -> session { lastPing = now }) + + onClose = do + getState >>= \case + AutoRefreshActive { sessionId } -> do + let autoRefreshServer = ?applicationContext.autoRefreshServer + modifyIORef' autoRefreshServer (\server -> server { sessions = filter (\AutoRefreshSession { id } -> id /= sessionId) server.sessions }) + AwaitingSessionID -> pure () + + +registerNotificationTrigger :: (?modelContext :: ModelContext) => IORef (Set ByteString) -> IORef AutoRefreshServer -> IO () +registerNotificationTrigger touchedTablesVar autoRefreshServer = do + touchedTables <- Set.toList <$> readIORef touchedTablesVar + subscribedTables <- (.subscribedTables) <$> (autoRefreshServer |> readIORef) + + let subscriptionRequired = touchedTables |> filter (\table -> subscribedTables |> Set.notMember table) + modifyIORef' autoRefreshServer (\server -> server { subscribedTables = server.subscribedTables <> Set.fromList subscriptionRequired }) + + pgListener <- (.pgListener) <$> readIORef autoRefreshServer + subscriptions <- subscriptionRequired |> mapM (\table -> do + let createTriggerSql = notificationTrigger table + + -- We need to add the trigger from the main IHP database role other we will get this error: + -- ERROR: permission denied for schema public + withRowLevelSecurityDisabled do + sqlExec createTriggerSql () + + pgListener |> PGListener.subscribe (channelName table) \notification -> do + sessions <- (.sessions) <$> readIORef autoRefreshServer + sessions + |> filter (\session -> table `Set.member` session.tables) + |> map (\session -> session.event) + |> mapM (\event -> MVar.tryPutMVar event ()) + pure ()) + modifyIORef' autoRefreshServer (\s -> s { subscriptions = s.subscriptions <> subscriptions }) + pure () + +-- | Returns the ids of all sessions available to the client based on what sessions are found in the session cookie +getAvailableSessions :: (?context :: ControllerContext) => IORef AutoRefreshServer -> IO [UUID] +getAvailableSessions autoRefreshServer = do + allSessions <- (.sessions) <$> readIORef autoRefreshServer + text <- fromMaybe "" <$> getSession "autoRefreshSessions" + let uuidCharCount = Text.length (UUID.toText UUID.nil) + let allSessionIds = map (.id) allSessions + text + |> Text.chunksOf uuidCharCount + |> mapMaybe UUID.fromText + |> filter (\id -> id `elem` allSessionIds) + |> pure + +-- | Returns a session for a given session id. Errors in case the session does not exist. +getSessionById :: (?applicationContext :: ApplicationContext) => UUID -> IO AutoRefreshSession +getSessionById sessionId = do + autoRefreshServer <- readIORef ?applicationContext.autoRefreshServer + autoRefreshServer.sessions + |> find (\AutoRefreshSession { id } -> id == sessionId) + |> Maybe.fromMaybe (error "getSessionById: Could not find the session") + |> pure + +-- | Applies a update function to a session specified by its session id +updateSession :: (?applicationContext :: ApplicationContext) => UUID -> (AutoRefreshSession -> AutoRefreshSession) -> IO () +updateSession sessionId updateFunction = do + let server = ?applicationContext.autoRefreshServer + let updateSession' session = if session.id == sessionId then updateFunction session else session + modifyIORef' server (\server -> server { sessions = map updateSession' server.sessions }) + pure () + +-- | Removes all expired sessions +-- +-- This is useful to avoid dead sessions hanging around. This can happen when a websocket connection was never established +-- after the initial request. Then the onClose of the websocket app is never called and thus the session will not be +-- removed automatically. +gcSessions :: IORef AutoRefreshServer -> IO () +gcSessions autoRefreshServer = do + now <- getCurrentTime + modifyIORef' autoRefreshServer (\autoRefreshServer -> autoRefreshServer { sessions = filter (not . isSessionExpired now) autoRefreshServer.sessions }) + +-- | A session is expired if it was not pinged in the last 60 seconds +isSessionExpired :: UTCTime -> AutoRefreshSession -> Bool +isSessionExpired now AutoRefreshSession { lastPing } = (now `diffUTCTime` lastPing) > (secondsToNominalDiffTime 60) + +-- | Returns the event name of the event that the pg notify trigger dispatches +channelName :: ByteString -> ByteString +channelName tableName = "ar_did_change_" <> tableName + +-- | Returns the sql code to set up a database trigger +notificationTrigger :: ByteString -> PG.Query +notificationTrigger tableName = PG.Query [i| + BEGIN; + CREATE OR REPLACE FUNCTION #{functionName}() RETURNS TRIGGER AS $$ + BEGIN + PERFORM pg_notify('#{channelName tableName}', ''); + RETURN new; + END; + $$ language plpgsql; + DROP TRIGGER IF EXISTS #{insertTriggerName} ON #{tableName}; + CREATE TRIGGER #{insertTriggerName} AFTER INSERT ON "#{tableName}" FOR EACH STATEMENT EXECUTE PROCEDURE #{functionName}(); + + DROP TRIGGER IF EXISTS #{updateTriggerName} ON #{tableName}; + CREATE TRIGGER #{updateTriggerName} AFTER UPDATE ON "#{tableName}" FOR EACH STATEMENT EXECUTE PROCEDURE #{functionName}(); + + DROP TRIGGER IF EXISTS #{deleteTriggerName} ON #{tableName}; + CREATE TRIGGER #{deleteTriggerName} AFTER DELETE ON "#{tableName}" FOR EACH STATEMENT EXECUTE PROCEDURE #{functionName}(); + + COMMIT; + |] + where + functionName = "ar_notify_did_change_" <> tableName + insertTriggerName = "ar_did_insert_" <> tableName + updateTriggerName = "ar_did_update_" <> tableName + deleteTriggerName = "ar_did_delete_" <> tableName diff --git a/IHP/AutoRefresh/Types.hs b/IHP/AutoRefresh/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/AutoRefresh/Types.hs @@ -0,0 +1,36 @@ +{-| +Module: IHP.AutoRefresh.Types +Description: Types & Data Structures for IHP AutoRefresh +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.AutoRefresh.Types where + +import IHP.Prelude +import IHP.Controller.RequestContext +import Control.Concurrent.MVar (MVar) +import qualified IHP.PGListener as PGListener + +data AutoRefreshState = AutoRefreshDisabled | AutoRefreshEnabled { sessionId :: !UUID } +data AutoRefreshSession = AutoRefreshSession + { id :: !UUID + -- | A callback to rerun an action within a given request context + , renderView :: !(RequestContext -> IO ()) + -- | MVar that is filled whenever some table changed + , event :: !(MVar ()) + -- | All tables this auto refresh session watches + , tables :: !(Set ByteString) + -- | The last rendered html of this action. Initially this is the result of the initial page rendering + , lastResponse :: !LByteString + -- | Keep track of the last ping to this session to close it after too much time has passed without anything happening + , lastPing :: !UTCTime + } + +data AutoRefreshServer = AutoRefreshServer + { subscriptions :: [PGListener.Subscription] + , sessions :: ![AutoRefreshSession] + , subscribedTables :: !(Set ByteString) + , pgListener :: PGListener.PGListener + } + +newAutoRefreshServer :: PGListener.PGListener -> AutoRefreshServer +newAutoRefreshServer pgListener = AutoRefreshServer { subscriptions = [], sessions = [], subscribedTables = mempty, pgListener } diff --git a/IHP/AutoRefresh/View.hs b/IHP/AutoRefresh/View.hs new file mode 100644 --- /dev/null +++ b/IHP/AutoRefresh/View.hs @@ -0,0 +1,12 @@ +module IHP.AutoRefresh.View where + +import IHP.Prelude +import IHP.AutoRefresh.Types +import IHP.HSX.QQ (hsx) +import qualified Text.Blaze.Html5 as Html5 +import IHP.Controller.Context + +autoRefreshMeta :: (?context :: ControllerContext) => Html5.Html +autoRefreshMeta = case fromFrozenContext @AutoRefreshState of + AutoRefreshDisabled -> mempty + AutoRefreshEnabled { sessionId } -> [hsx||] diff --git a/IHP/Breadcrumb/Types.hs b/IHP/Breadcrumb/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Breadcrumb/Types.hs @@ -0,0 +1,19 @@ +module IHP.Breadcrumb.Types where + +import IHP.Prelude +import Text.Blaze.Html (Html) +import Text.Blaze.Html.Renderer.String (renderHtml) +import ClassyPrelude + +data BreadcrumbItem = + BreadcrumbItem + { breadcrumbLabel :: Html -- ^ The label of a single breadcrumbs item. May be HTML, thus use SVG or font icon. + , url :: Maybe Text -- ^ The URL of the item. If Nothing, it will only show the label. + } + +-- Html doesn't have a Show instance, so we define it manually and use 'renderHtml' for that. +instance Show BreadcrumbItem where + show breadcrumbItem = [plain|{ breadcrumbLabel = "#{breadcrumbLabel}", url = #{url} }|] + where + breadcrumbLabel = renderHtml $ breadcrumbItem.breadcrumbLabel + url = ClassyPrelude.show $ breadcrumbItem.url diff --git a/IHP/Breadcrumb/ViewFunctions.hs b/IHP/Breadcrumb/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Breadcrumb/ViewFunctions.hs @@ -0,0 +1,45 @@ +module IHP.Breadcrumb.ViewFunctions ( + module IHP.Breadcrumb.Types, + renderBreadcrumb, + breadcrumbLink, + breadcrumbLinkExternal, + breadcrumbText, +) where + +import IHP.Prelude +import IHP.Breadcrumb.Types + +import IHP.ControllerSupport + +import Text.Blaze.Html (Html) + +import IHP.View.Types (BreadcrumbsView(..), styledBreadcrumb, styledBreadcrumbItem) +import IHP.ViewSupport (theCSSFramework) +import IHP.ControllerPrelude + +renderBreadcrumb :: (?context :: ControllerContext) => [BreadcrumbItem] -> Html +renderBreadcrumb breadcrumbItems = styledBreadcrumb theCSSFramework theCSSFramework breadcrumbItems breadcrumbsView + where + breadcrumbsView = BreadcrumbsView + { breadcrumbItems = forEachWithIndex breadcrumbItems (\(index, breadcrumbItem) -> + let + isLast = index == length breadcrumbItems - 1 + in + styledBreadcrumbItem theCSSFramework theCSSFramework breadcrumbItems breadcrumbItem isLast + ) + } + + +breadcrumbLink :: (HasPath controller) => Html -> controller -> BreadcrumbItem +breadcrumbLink label route = + breadcrumbLinkExternal label (pathTo route) + +breadcrumbLinkExternal :: Html -> Text -> BreadcrumbItem +breadcrumbLinkExternal label url = + BreadcrumbItem { breadcrumbLabel = label, url = Just url } + + + +breadcrumbText :: Html -> BreadcrumbItem +breadcrumbText label = + BreadcrumbItem { breadcrumbLabel = label, url = Nothing } diff --git a/IHP/Controller/AccessDenied.hs b/IHP/Controller/AccessDenied.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/AccessDenied.hs @@ -0,0 +1,159 @@ +module IHP.Controller.AccessDenied +( accessDeniedWhen +, accessDeniedUnless +, handleAccessDeniedFound +, buildAccessDeniedResponse +, renderAccessDenied +) +where + +import IHP.Prelude hiding (displayException) +import IHP.Controller.RequestContext +import Network.HTTP.Types (status403) +import Network.Wai +import Network.HTTP.Types.Header +import qualified Text.Blaze.Html.Renderer.Utf8 as Blaze +import qualified Data.ByteString.Lazy as LBS +import IHP.HSX.QQ (hsx) +import qualified System.Directory as Directory +import IHP.Controller.Context +import IHP.Controller.Response (respondAndExit) + + +-- | Stops the action execution with an access denied message (403) when the access condition is True. +-- +-- __Example:__ Checking a user is the author of a blog post. +-- +-- > action EditPostAction { postId } = do +-- > post <- fetch postId +-- > accessDeniedWhen (post.authorId /= currentUserId) +-- > +-- > renderHtml EditView { .. } +-- +-- This will throw an error and prevent the view from being rendered when the current user is not the author of the post. +accessDeniedWhen :: (?context :: ControllerContext) => Bool -> IO () +accessDeniedWhen condition = when condition renderAccessDenied + +-- | Stops the action execution with an access denied message (403) when the access condition is False. +-- +-- __Example:__ Checking a user is the author of a blog post. +-- +-- > action EditPostAction { postId } = do +-- > post <- fetch postId +-- > accessDeniedUnless (post.authorId == currentUserId) +-- > +-- > renderHtml EditView { .. } +-- +-- This will throw an error and prevent the view from being rendered when the current user is not the author of the post. +accessDeniedUnless :: (?context :: ControllerContext) => Bool -> IO () +accessDeniedUnless condition = unless condition renderAccessDenied + +-- | Renders a 403 access denied response. If a static/403.html exists, that is rendered instead of the IHP access denied page. +handleAccessDeniedFound :: Request -> Respond -> IO ResponseReceived +handleAccessDeniedFound request respond = do + response <- buildAccessDeniedResponse + respond response + +buildAccessDeniedResponse :: IO Response +buildAccessDeniedResponse = do + hasCustomAccessDenied <- Directory.doesFileExist "static/403.html" + if hasCustomAccessDenied + then customAccessDeniedResponse + else pure defaultAccessDeniedResponse + +-- | The default IHP 403 not found page +defaultAccessDeniedResponse :: Response +defaultAccessDeniedResponse = responseBuilder status403 [(hContentType, "text/html")] $ Blaze.renderHtmlBuilder [hsx| + + + + + + + Access denied + + + +
+ + + + + + + + + + + + + + + + + + +
+

Error 403

+

Access denied

+
+ + + |] + +-- | Renders the static/403.html file +customAccessDeniedResponse :: IO Response +customAccessDeniedResponse = do + -- We cannot use responseFile here as responseFile ignore the status code by default + -- + -- See https://github.com/yesodweb/wai/issues/644 + page <- LBS.readFile "static/403.html" + pure $ responseLBS status403 [(hContentType, "text/html")] page + + +-- | Renders an "Access denied" page. +-- +-- This can be useful e.g. when an entity cannot be accessed: +-- +-- > action ExampleAction = do +-- > renderAccessDenied +-- +-- You can override the default access denied page by creating a new file at @static/403.html@. Then IHP will render that HTML file instead of displaying the default IHP access denied page. +-- +renderAccessDenied :: (?context :: ControllerContext) => IO () +renderAccessDenied = do + response <- buildAccessDeniedResponse + respondAndExit response diff --git a/IHP/Controller/BasicAuth.hs b/IHP/Controller/BasicAuth.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/BasicAuth.hs @@ -0,0 +1,26 @@ +{-| +Module: IHP.Controller.BasicAuth +Description: Very Simple Basic Auth +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Controller.BasicAuth (basicAuth) where + +import IHP.Prelude +import IHP.ControllerSupport +import Network.HTTP.Types (status401) +import Network.Wai (responseLBS) +import Network.Wai.Middleware.HttpAuth (extractBasicAuth) +import Network.HTTP.Types.Header (hWWWAuthenticate) + +-- | Adds basic http authentication +-- +-- Mainly for protecting a site during external review. +-- Meant for use in the controller: +-- +-- > beforeAction = basicAuth ... +-- +basicAuth :: (?context :: ControllerContext) => Text -> Text -> Text -> IO () +basicAuth uid pw realm = do + let mein = Just (cs uid, cs pw) + let cred = join $ fmap extractBasicAuth (getHeader "Authorization") + when (cred /= mein) $ respondAndExit $ responseLBS status401 [(hWWWAuthenticate,cs ("Basic " ++ (if null realm then "" else "realm=\"" ++ realm ++ "\", ") ++ "charset=\"UTF-8\""))] "" diff --git a/IHP/Controller/Context.hs b/IHP/Controller/Context.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Context.hs @@ -0,0 +1,180 @@ +{-| +Module: IHP.Controller.Context +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Controller.Context where + +import IHP.Prelude +import qualified Data.TMap as TypeMap +import qualified Data.Typeable as Typeable +import IHP.Controller.RequestContext +import IHP.FrameworkConfig +import IHP.Log.Types +import System.IO.Unsafe (unsafePerformIO) + +-- | A container storing useful data along the request lifecycle, such as the request, the current user, set current view layout, flash messages, ... +-- +-- The controller context is usually accessed via the @?context@ variable. It's availble inside the action and the view. Think of it as a key-value-map where the key is the type of the value. +-- +-- You can store information inside the context using 'putContext': +-- +-- >>> newtype CurrentLayout = CurrentLayout Html +-- >>> +-- >>> ?context <- newControllerContext +-- >>> putContext (CurrentLayout layout) +-- +-- Inside an action you can access the values using 'fromContext': +-- +-- >>> (CurrentLayout layout) <- fromContext +-- +-- You can freeze the context and then access values without being inside an IO context (like inside views which are pure): +-- +-- Call 'freeze' inside an IO part: +-- +-- >>> ?context <- freeze ?context +-- +-- ('freeze' is automatically called by IHP before rendering a view, so usually you don't need to call it manually) +-- +-- Then use the frozen context from your pure code like this: +-- +-- >>> let (CurrentLayout layout) = fromFrozenContext in ... +-- +-- The context is initially created before a action is going to be executed. Its life cycle looks like this: +-- +-- - @newControllerContext@: The new controller context is created +-- - The 'IHP.ControllerSupport.runActionWithNewContext' fills in a few default values: The current @?application@ and also the Flash Messages to be rendered in the to-be-generated response. +-- - @initContext@: The initContext function of the @InitControllerContext WebApplication@ (inside your FrontController.hs) is called. There application-specific context can be provided. Usually this is the current user and the default layout. +-- - @beforeAction@: Here the context could also be modified. E.g. the layout could be overriden here for the whole controller. +-- - @action ..@: The action itself. +-- - Freezing: Before rendering the response, the container is frozen. Frozen means that all previously mutable fields become immutable. +-- - View Rendering: The frozen container is now used inside the view and layout to display information such as the current user or flash messages +data ControllerContext = ControllerContext { requestContext :: RequestContext, customFieldsRef :: IORef TypeMap.TMap } + | FrozenControllerContext { requestContext :: RequestContext, customFields :: TypeMap.TMap } + +newControllerContext :: (?requestContext :: RequestContext) => IO ControllerContext +newControllerContext = do + customFieldsRef <- newIORef TypeMap.empty + pure ControllerContext { requestContext = ?requestContext, customFieldsRef } +{-# INLINABLE newControllerContext #-} + +-- | After freezing a container you can access its values from pure non-IO code by using 'fromFronzenContext' +-- +-- Calls to 'putContext' will throw an exception after it's frozen. +freeze :: ControllerContext -> IO ControllerContext +freeze ControllerContext { requestContext, customFieldsRef } = FrozenControllerContext requestContext <$> readIORef customFieldsRef +freeze frozen = pure frozen +{-# INLINABLE freeze #-} + +-- | Returns a unfrozen version of the controller context that can be modified again +-- +-- This is used together with 'freeze' by e.g. AutoRefresh to make a immutable copy of the current controller context state +unfreeze :: ControllerContext -> IO ControllerContext +unfreeze FrozenControllerContext { requestContext, customFields } = do + customFieldsRef <- newIORef customFields + pure ControllerContext { .. } +unfreeze ControllerContext {} = error "Cannot call unfreeze on a controller context that is not frozen" +{-# INLINABLE unfreeze #-} + + +-- | Returns a value from the current controller context +-- +-- Throws an exception if the there is no value with the type inside the context +-- +-- __Example:__ Read the current user from the context +-- +-- >>> user <- fromContext @User +fromContext :: forall value. (?context :: ControllerContext, Typeable value) => IO value +fromContext = maybeFromContext @value >>= \case + Just value -> pure value + Nothing -> do + let ControllerContext { customFieldsRef } = ?context + customFields <- readIORef customFieldsRef + let notFoundMessage = ("Unable to find " <> (show (Typeable.typeRep (Typeable.Proxy @value))) <> " in controller context: " <> show customFields) + + error notFoundMessage +{-# INLINABLE fromContext #-} + +-- | Returns a value from the current controller context. Requires the context to be frozen. +-- +-- __Example:__ Read the current user from the context +-- +-- >>> let user = fromFrozenContext @User +fromFrozenContext :: forall value. (?context :: ControllerContext, Typeable value) => value +fromFrozenContext = case maybeFromFrozenContext @value of + Just value -> value + Nothing -> do + let FrozenControllerContext { customFields } = ?context + let notFoundMessage = ("Unable to find " <> (show (Typeable.typeRep (Typeable.Proxy @value))) <> " in controller context: " <> show customFields) + + error notFoundMessage +{-# INLINABLE fromFrozenContext #-} + +maybeFromContext :: forall value. (?context :: ControllerContext, Typeable value) => IO (Maybe value) +maybeFromContext = do + frozen <- freeze ?context + let ?context = frozen + pure (maybeFromFrozenContext @value) +{-# INLINABLE maybeFromContext #-} + +maybeFromFrozenContext :: forall value. (?context :: ControllerContext, Typeable value) => Maybe value +maybeFromFrozenContext = case ?context of + FrozenControllerContext { customFields } -> TypeMap.lookup @value customFields + ControllerContext {} -> error ("maybeFromFrozenContext called on a non frozen context while trying to access " <> (show (Typeable.typeRep (Typeable.Proxy @value)))) +{-# INLINABLE maybeFromFrozenContext #-} + +-- | Puts a value into the context +-- +-- Throws an exception if the context is already frozen. +putContext :: forall value. (?context :: ControllerContext, Typeable value) => value -> IO () +putContext value = do + let ControllerContext { customFieldsRef } = ?context + modifyIORef customFieldsRef (TypeMap.insert value) + pure () +{-# INLINABLE putContext #-} + +newtype ActionType = ActionType Typeable.TypeRep + +instance HasField "frameworkConfig" ControllerContext FrameworkConfig where + getField controllerContext = controllerContext.requestContext.frameworkConfig + {-# INLINABLE getField #-} + +-- The following hack is bad, but allows us to override the logger using 'putContext' +-- The alternative would be https://github.com/digitallyinduced/ihp/pull/1921 which is also not very nice +-- +-- This can be useful to customize the log formatter for all actions of an app: +-- +-- > -- Web/FrontController.hs +-- > +-- > import IHP.Log.Types as Log +-- > import IHP.Controller.Context +-- > +-- > instance InitControllerContext WebApplication where +-- > initContext = do +-- > -- ... your other initContext code +-- > +-- > putContext userIdLogger +-- > +-- > userIdLogger :: (?context :: ControllerContext) => Logger +-- > userIdLogger = +-- > defaultLogger { Log.formatter = userIdFormatter defaultLogger.formatter } +-- > where +-- > defaultLogger = ?context.frameworkConfig.logger +-- > +-- > +-- > userIdFormatter :: (?context :: ControllerContext) => Log.LogFormatter -> Log.LogFormatter +-- > userIdFormatter existingFormatter time level string = +-- > existingFormatter time level (prependUserId string) +-- > +-- > prependUserId :: (?context :: ControllerContext) => LogStr -> LogStr +-- > prependUserId string = +-- > toLogStr $ userInfo <> show string +-- > where +-- > userInfo = +-- > case currentUserOrNothing of +-- > Just currentUser -> "Authenticated user ID: " <> show currentUser.id <> " " +-- > Nothing -> "Anonymous user: " +-- +-- This design mistake should be fixed in IHP v2 +instance HasField "logger" ControllerContext Logger where + getField context@(FrozenControllerContext { customFields }) = fromMaybe context.frameworkConfig.logger (TypeMap.lookup @Logger customFields) + getField context = (unsafePerformIO (freeze context)).logger -- Hacky, but there's no better way. The only way to retrieve the logger here, is by reading from the IORef in an unsafe way diff --git a/IHP/Controller/Cookie.hs b/IHP/Controller/Cookie.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Cookie.hs @@ -0,0 +1,44 @@ +{-| +Module: IHP.Controller.Cookie +Description: Set Cookies +Copyright: (c) digitally induced GmbH, 2022 +-} +module IHP.Controller.Cookie (setCookie, getCookie, allCookies) where + +import IHP.Prelude +import IHP.ControllerSupport +import Web.Cookie +import qualified Data.Binary.Builder as Binary +import qualified Data.ByteString.Lazy as LBS + +-- | Sets a @Set-Cookie@ header +-- +-- > import Web.Cookie +-- > +-- > action MyAction = do +-- > setCookie defaultSetCookie +-- > { setCookieName = "exampleCookie" +-- > , setCookieValue = "exampleValue" +-- > } +-- +setCookie :: (?context :: ControllerContext) => SetCookie -> IO () +setCookie cookie = setHeader ("Set-Cookie", cookieString) + where + cookieString = cookie + |> renderSetCookie + |> Binary.toLazyByteString + |> LBS.toStrict + +-- | Returns a cookie by it's name +-- +-- > getCookie "fbc" +-- Just "1234" +-- +getCookie :: (?context :: ControllerContext) => Text -> Maybe Text +getCookie name = + lookup name allCookies + +-- | Returns all cookies sent with the current request +allCookies :: (?context :: ControllerContext) => [(Text, Text)] +allCookies = + maybe [] parseCookiesText $ lookup "Cookie" request.requestHeaders diff --git a/IHP/Controller/FileUpload.hs b/IHP/Controller/FileUpload.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/FileUpload.hs @@ -0,0 +1,240 @@ +{-# LANGUAGE MultiParamTypeClasses, TypeFamilies, FlexibleContexts, AllowAmbiguousTypes, FlexibleInstances, IncoherentInstances, UndecidableInstances, PolyKinds, BlockArguments, DataKinds #-} + +{-| +Module: IHP.Controller.FileUpload +Description: Easy access to uploaded files +Copyright: (c) digitally induced GmbH, 2020 + +This modules provides high-level file and image upload functionality. + +All uploaded files are saved to the `uploads` directory. Given e.g. an User entity with @id = 550e8400-e29b-11d4-a716-446655440000@, the file is saved to @\/uploads\/users\/550e8400-e29b-11d4-a716-446655440000\/picture.jpg@. If the directory does not exists, it will be created. + +-} +module IHP.Controller.FileUpload where + +import IHP.Prelude + +import Network.Wai.Parse (FileInfo, fileContent) +import qualified IHP.ModelSupport as ModelSupport +import qualified Data.ByteString.Lazy as LBS +import IHP.Controller.RequestContext +import IHP.Controller.Context +import qualified System.Process as Process + +-- | Returns a file upload from the request as a ByteString. +-- +-- Returns `Nothing` when the file is not found in the request body. +-- +-- __Example:__ +-- +-- Given a form like this: +-- +-- >
+-- > type="file" +-- > name="markdown" +-- > accept="text/markdown, text/plain" +-- > > +-- >
+-- +-- The file can be accessed within the action like this: +-- +-- > action SubmitMarkdownAction = do +-- > let content :: Text = +-- > fileOrNothing "markdown" +-- > |> fromMaybe (error "no file given") +-- > |> (.fileContent) +-- > |> cs -- content is a LazyByteString, so we use `cs` to convert it to Text +-- > +-- +-- See 'filesByName' if multiple files can be uploaded by the user in a single form submission. +-- +-- See 'IHP.FileStorage.ControllerFunctions.storeFile' to upload the file to S3 or similar cloud storages. +-- +fileOrNothing :: (?context :: ControllerContext) => ByteString -> Maybe (FileInfo LBS.ByteString) +fileOrNothing !name = + case ?context.requestContext.requestBody of + FormBody { files } -> + -- Search for the file, and confirm it's not an empty one. + case lookup name files of + Just fileInfo | not (LBS.null (fileInfo.fileContent)) -> Just fileInfo + _ -> Nothing + _ -> Nothing + +-- | Like 'fileOrNothing' but allows uploading multiple files in the same request +-- +-- __Example:__ +-- +-- For uploading multiple files we need to set the multiple attribute on the file input: +-- +-- >
+-- > type="file" +-- > name="markdown" +-- > accept="text/markdown, text/plain" +-- > multiple +-- > > +-- >
+-- +-- When the user selects multiple files, we can access them like this: +-- +-- > action SubmitMarkdownAction = do +-- > let contents :: [Text] = +-- > filesByName "markdown" +-- > |> map (.fileContent) +-- > |> map cs -- content is a LazyByteString, so we use `cs` to convert it to Text +-- > +-- +-- Use 'IHP.HaskellSupport.forEach' to store multiple files inside the cloud storage: +-- +-- > action SubmitMarkdownAction = do +-- > let markdownFiles = filesByName "markdown" +-- > +-- > forEach markdownFiles \file -> do +-- > storeFile file "notes" +-- > +-- > pure () +-- > +-- +filesByName :: (?context :: ControllerContext) => ByteString -> [FileInfo LBS.ByteString] +filesByName !name = + case ?context.requestContext.requestBody of + FormBody { files } -> files + |> filter (\(filename, _) -> filename == name) + |> map snd + _ -> [] + +-- | Options to be used together with 'uploadImageWithOptions' +-- +-- __Example:__ +-- +-- > ImageUploadOptions { convertTo = "jpg", imageMagickOptions = "-resize '1024x1024^' -gravity north -extent 1024x1024 -quality 85% -strip" } +data ImageUploadOptions = ImageUploadOptions { + -- | The file extension to be used when saving the file, e.g. @"jpg"@ or @"png"@. + convertTo :: Text + -- | Command line options passed to imagemagick. Can used for e.g. resizing, rotating, file size reduction. + , imageMagickOptions :: Text + } + +-- | Saves an uploaded image file to the @uploads@ directory and writes the relative path to the given record attribute. +-- +-- Given e.g. an User entity with @id = 550e8400-e29b-11d4-a716-446655440000@, the file is saved to @\/uploads\/users\/550e8400-e29b-11d4-a716-446655440000\/picture.jpg@. +-- +-- Before saving, the image is converted using imagemagick. You can supply custom image magick options using the options attribute. +-- +-- If the upload directory does not exists, it will be created. +-- +-- __Example:__ Uploading a user profile picture +-- +-- > let profilePictureOptions = ImageUploadOptions +-- > { convertTo = "jpg" +-- > , imageMagickOptions = "-resize '1024x1024^' -gravity north -extent 1024x1024 -quality 85% -strip" +-- > } +-- > +-- > user +-- > |> fill @["firstname", "lastname", "pictureUrl"] +-- > |> uploadImageWithOptions profilePictureOptions #pictureUrl +-- > >>= ifValid \case +-- > Left user -> render EditView { .. } +-- > Right user -> do +-- > user <- user |> updateRecord +-- > redirectTo EditUserAction { .. } +-- +-- The uploaded image path is now stored in #pictureUrl. +uploadImageWithOptions :: forall (fieldName :: Symbol) record (tableName :: Symbol). ( + ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , KnownSymbol fieldName + , HasField "id" record (ModelSupport.Id (ModelSupport.NormalizeModel record)) + , Show (ModelSupport.PrimaryKey (ModelSupport.GetTableName (ModelSupport.NormalizeModel record))) + , tableName ~ ModelSupport.GetTableName record + , KnownSymbol tableName + ) => ImageUploadOptions -> Proxy fieldName -> record -> IO record +uploadImageWithOptions options _ user = + let + fieldName :: ByteString = cs (symbolVal (Proxy @fieldName)) + tableName :: Text = cs (symbolVal (Proxy @tableName)) + uploadDir :: Text = "static" + baseImagePath :: Text = "/uploads/" <> tableName <> "/" <> tshow user.id <> "/picture." + imagePath :: Text = baseImagePath <> "jpg" + uploadFilePath = baseImagePath <> "upload" + in case fileOrNothing fieldName of + Just file -> liftIO do + _ <- Process.system ("mkdir -p `dirname " <> cs (uploadDir <> uploadFilePath) <> "`") + let fullImagePath = uploadDir <> imagePath + fileContent file |> LBS.writeFile (cs (uploadDir <> uploadFilePath)) + Process.runCommand (cs ("convert " <> cs uploadDir <> uploadFilePath <> " " <> (getField @"imageMagickOptions" options) <> " " <> cs fullImagePath)) + user + |> setField @fieldName (Just (cs imagePath :: Text)) + |> return + _ -> pure user + +-- | Saves an uploaded image file to the `uploads` directory. +-- +-- Given e.g. an User entity with @id = 550e8400-e29b-11d4-a716-446655440000@, the file is saved to @\/uploads\/users\/550e8400-e29b-11d4-a716-446655440000\/picture.jpg@. +-- +-- No transformation or validation is applied to the given uploaded file. If you need this, take a look at 'uploadImageWithOptions'. +-- +-- __Example:__ Uploading a user profile picture +-- +-- > let profilePictureOptions = ImageUploadOptions +-- > { convertTo = "jpg" +-- > , imageMagickOptions = "-resize '1024x1024^' -gravity north -extent 1024x1024 -quality 85% -strip" +-- > } +-- > +-- > user +-- > |> fill @["firstname", "lastname", "pictureUrl"] +-- > |> uploadImageFile "png" #pictureUrl +-- > >>= ifValid \case +-- > Left user -> render EditView { .. } +-- > Right user -> do +-- > user <- user |> updateRecord +-- > redirectTo EditUserAction { .. } +-- +uploadImageFile :: forall (fieldName :: Symbol) record (tableName :: Symbol). ( + ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , KnownSymbol fieldName + , HasField "id" record (ModelSupport.Id (ModelSupport.NormalizeModel record)) + , Show (ModelSupport.PrimaryKey (ModelSupport.GetTableName (ModelSupport.NormalizeModel record))) + , tableName ~ ModelSupport.GetTableName record + , KnownSymbol tableName + ) => Text -> Proxy fieldName -> record -> IO record +uploadImageFile ext _ user = + let + fieldName :: ByteString = cs (symbolVal (Proxy @fieldName)) + tableName :: Text = cs (symbolVal (Proxy @tableName)) + uploadDir :: Text = "static" + imagePath :: Text = "/uploads/" <> tableName <> "/" <> tshow user.id <> "/picture." <> ext + in case fileOrNothing fieldName of + Just file -> liftIO do + _ <- Process.system ("mkdir -p `dirname " <> cs (uploadDir <> imagePath) <> "`") + fileContent file |> LBS.writeFile (cs $ uploadDir <> imagePath) + user + |> setField @fieldName (Just (cs imagePath :: Text)) + |> pure + _ -> pure user + +-- | Saves an uploaded png file. No validation or transformation applied. +-- See 'uploadImageFile' for details. +uploadPng :: + ( ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , HasField "id" record (ModelSupport.Id' (GetTableName (ModelSupport.GetModelByTableName (GetTableName record)))) + , Show (ModelSupport.PrimaryKey (GetTableName (ModelSupport.GetModelByTableName (GetTableName record)))) + , KnownSymbol fieldName + , KnownSymbol (GetTableName record) + ) => Proxy fieldName -> record -> IO record +uploadPng field record = uploadImageFile "png" field record + +-- | Saves an uploaded svg file. No validation or transformation applied. +-- See 'uploadImageFile' for details. +uploadSVG :: + ( ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , HasField "id" record (ModelSupport.Id' (GetTableName (ModelSupport.GetModelByTableName (GetTableName record)))) + , Show (ModelSupport.PrimaryKey (GetTableName (ModelSupport.GetModelByTableName (GetTableName record)))) + , KnownSymbol fieldName + , KnownSymbol (GetTableName record) + ) => Proxy fieldName -> record -> IO record +uploadSVG = uploadImageFile "svg" diff --git a/IHP/Controller/Layout.hs b/IHP/Controller/Layout.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Layout.hs @@ -0,0 +1,25 @@ +{-| +Module: IHP.Controller.Layout +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Controller.Layout +( setLayout +, getLayout +, ViewLayout (..) +) where + +import IHP.Prelude +import IHP.ViewSupport +import IHP.Controller.Context + +newtype ViewLayout = ViewLayout ((?context :: ControllerContext) => Layout) + +setLayout :: (?context :: ControllerContext) => ((?context :: ControllerContext) => Layout) -> IO () +setLayout layout = do + putContext (ViewLayout layout) +{-# INLINE setLayout #-} + +getLayout :: (?context :: ControllerContext) => IO Layout +getLayout = do + (ViewLayout layout) <- fromContext + pure layout diff --git a/IHP/Controller/NotFound.hs b/IHP/Controller/NotFound.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/NotFound.hs @@ -0,0 +1,159 @@ +module IHP.Controller.NotFound +( notFoundWhen +, notFoundUnless +, handleNotFound +, buildNotFoundResponse +, renderNotFound +) + where + +import IHP.Prelude hiding (displayException) +import IHP.Controller.RequestContext +import Network.HTTP.Types (status404) +import Network.Wai +import Network.HTTP.Types.Header +import qualified Text.Blaze.Html.Renderer.Utf8 as Blaze +import qualified Data.ByteString.Lazy as LBS +import IHP.HSX.QQ (hsx) +import qualified System.Directory as Directory +import IHP.Controller.Context +import IHP.Controller.Response (respondAndExit) + + +-- | Stops the action execution with a not found message (404) when the access condition is True. +-- +-- __Example:__ Checking a user is the author of a blog post. +-- +-- > action EditPostAction { postId } = do +-- > post <- fetch postId +-- > notFoundWhen (post.authorId /= currentUserId) +-- > +-- > renderHtml EditView { .. } +-- +-- This will throw an error and prevent the view from being rendered when the current user is not the author of the post. +notFoundWhen :: (?context :: ControllerContext) => Bool -> IO () +notFoundWhen condition = when condition renderNotFound + +-- | Stops the action execution with a not found message (404) when the access condition is False. +-- +-- __Example:__ Checking a user is the author of a blog post. +-- +-- > action EditPostAction { postId } = do +-- > post <- fetch postId +-- > notFoundUnless (post.authorId == currentUserId) +-- > +-- > renderHtml EditView { .. } +-- +-- This will throw an error and prevent the view from being rendered when the current user is not the author of the post. +notFoundUnless :: (?context :: ControllerContext) => Bool -> IO () +notFoundUnless condition = unless condition renderNotFound + + +-- | Renders a 404 not found response. If a static/404.html exists, that is rendered instead of the IHP not found page +handleNotFound :: Request -> Respond -> IO ResponseReceived +handleNotFound request respond = do + response <- buildNotFoundResponse + respond response + +buildNotFoundResponse :: IO Response +buildNotFoundResponse = do + hasCustomNotFound <- Directory.doesFileExist "static/404.html" + if hasCustomNotFound + then customNotFoundResponse + else pure defaultNotFoundResponse + +-- | The default IHP 404 not found page +defaultNotFoundResponse :: Response +defaultNotFoundResponse = responseBuilder status404 [(hContentType, "text/html")] $ Blaze.renderHtmlBuilder [hsx| + + + + + + + Action not found + + + +
+ + + + + + + + + + + + + + + + + + +
+

Error 404

+

Action not found

+
+ + + |] + +-- | Renders the static/404.html file +customNotFoundResponse :: IO Response +customNotFoundResponse = do + -- We cannot use responseFile here as responseFile ignore the status code by default + -- + -- See https://github.com/yesodweb/wai/issues/644 + page <- LBS.readFile "static/404.html" + pure $ responseLBS status404 [(hContentType, "text/html")] page + +-- | Renders an "Not found" page. +-- +-- This can be useful e.g. when an entity cannot be accessed: +-- +-- > action ExampleAction = do +-- > renderNotFound +-- +-- You can override the default access denied page by creating a new file at @static/403.html@. Then IHP will render that HTML file instead of displaying the default IHP access denied page. +-- +renderNotFound :: (?context :: ControllerContext) => IO () +renderNotFound = do + response <- buildNotFoundResponse + respondAndExit response diff --git a/IHP/Controller/Param.hs b/IHP/Controller/Param.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Param.hs @@ -0,0 +1,660 @@ +{-# LANGUAGE MultiParamTypeClasses, TypeFamilies, FlexibleContexts, AllowAmbiguousTypes, FlexibleInstances, IncoherentInstances, UndecidableInstances, PolyKinds, BlockArguments, DataKinds #-} + +{-| +Module: IHP.Controller.Param +Description: Accessing query parameters and the request body +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Controller.Param where + +import IHP.Prelude +import qualified Data.Either as Either +import IHP.Controller.RequestContext +import qualified Network.Wai as Wai +import qualified Data.UUID as UUID +import qualified IHP.ModelSupport as ModelSupport +import qualified Data.ByteString.Char8 as Char8 +import IHP.ValidationSupport +import GHC.TypeLits +import qualified Data.Attoparsec.ByteString.Char8 as Attoparsec +import qualified GHC.Float as Float +import qualified Control.Exception as Exception +import IHP.Controller.Context +import qualified Data.Aeson as Aeson +import qualified Data.Aeson.KeyMap as Aeson +import qualified Data.Aeson.Key as Aeson +import qualified Data.Scientific as Scientific +import qualified Data.Vector as Vector +import qualified Control.DeepSeq as DeepSeq +import Text.Read (readMaybe) + +-- | Returns a query or body parameter from the current request. The raw string +-- value is parsed before returning it. So the return value type depends on what +-- you expect (e.g. can be Int, Text, UUID, Bool, some custom type). +-- +-- When the parameter is missing or cannot be parsed, an exception is thrown and +-- the current action is aborted. Use 'paramOrDefault' when you want to get a +-- default value instead of an exception, or 'paramOrNothing' to get @Nothing@ +-- when the parameter is missing. +-- +-- You can define a custom parameter parser by defining a 'ParamReader' instance. +-- +-- __Example:__ Accessing a query parameter. +-- +-- Let's say the request is: +-- +-- > GET /UsersAction?maxItems=50 +-- +-- We can read @maxItems@ like this: +-- +-- > action UsersAction = do +-- > let maxItems :: Int = param "maxItems" +-- +-- +-- __Example:__ Working with forms (Accessing a body parameter). +-- +-- Let's say we have the following html form: +-- +-- >
+-- > +-- >
+-- +-- The form has firstname text field and a send button. +-- When the form is submitted, it's send to @/HelloWorld@. +-- +-- The following action reads the value of the submitted firstname and prints out @Hello firstname@: +-- +-- > action HelloWorldAction = do +-- > let firstname = param "firstname" +-- > renderPlain ("Hello " <> firstname) +-- +-- +-- __Example:__ Missing parameters +-- +-- Let's say the request is: +-- +-- > GET /HelloWorldAction +-- +-- But the action requires us to provide a firstname, like: +-- +-- > action HelloWorldAction = do +-- > let firstname = param "firstname" +-- > renderPlain ("Hello " <> firstname) +-- +-- Running the request @GET /HelloWorldAction@ without the firstname parameter will cause an +-- 'ParamNotFoundException' to be thrown with: +-- +-- > param: Parameter 'firstname' not found +param :: (?context :: ControllerContext) => (ParamReader valueType) => ByteString -> valueType +param !name = case paramOrError name of + Left exception -> Exception.throw exception + Right value -> value +{-# INLINABLE param #-} + +-- | Similiar to 'param' but works with multiple params. Useful when working with checkboxes. +-- +-- Given a query like: +-- +-- > ingredients=milk&ingredients=egg +-- +-- This will return: +-- +-- >>> paramList @Text "ingredients" +-- ["milk", "egg"] +-- +-- When no parameter with the name is given, an empty list is returned: +-- +-- >>> paramList @Text "not_given_in_url" +-- [] +-- +-- When a value cannot be parsed, this function will fail similiar to 'param'. +-- +-- Related: https://stackoverflow.com/questions/63875081/how-can-i-pass-list-params-in-ihp-forms/63879113 +paramList :: forall valueType. (?context :: ControllerContext, DeepSeq.NFData valueType, ParamReader valueType) => ByteString -> [valueType] +paramList name = + allParams + |> filter (\(paramName, paramValue) -> paramName == name) + |> mapMaybe (\(paramName, paramValue) -> paramValue) + |> map (readParameter @valueType) + |> map (Either.fromRight (error (paramParserErrorMessage name))) + |> DeepSeq.force +{-# INLINABLE paramList #-} + +-- | Similiar to 'paramOrNothing' but works with multiple params. This is useful when submitting multiple +-- input fields with the same name, and some may be empty. +-- +-- Given a query like (note the `ingredients` in the middle that has no value): +-- +-- > ingredients=milk&ingredients&ingredients=egg +-- +-- This will return: +-- +-- >>> paramListOrNothing @Text "ingredients" +-- [Just "milk", Nothing, Just "egg"] +-- +-- When no parameter with the name is given, an empty list is returned: +-- +-- >>> paramListOrNothing @Text "not_given_in_url" +-- [] +-- +-- +paramListOrNothing :: forall valueType. (?context :: ControllerContext, DeepSeq.NFData valueType, ParamReader valueType) => ByteString -> [Maybe valueType] +paramListOrNothing name = + allParams + |> filter (\(paramName, paramValue) -> paramName == name) + |> mapMaybe (\(paramName, paramValue) -> paramValue) + |> map (\paramValue -> if paramValue == "" then Left "Empty ByteString" else readParameter @valueType paramValue) + |> map (\value -> case value of + Left _ -> Nothing + Right val -> Just val + ) + |> DeepSeq.force +{-# INLINABLE paramListOrNothing #-} + +paramParserErrorMessage name = "param: Parameter '" <> cs name <> "' is invalid" + +-- | Thrown when a parameter is missing when calling 'param "myParam"' or related functions +data ParamException + = ParamNotFoundException { name :: ByteString } + | ParamCouldNotBeParsedException { name :: ByteString, parserError :: ByteString } + deriving (Show, Eq) + +instance Exception ParamException where + displayException (ParamNotFoundException { name }) = "param: Parameter '" <> cs name <> "' not found" + displayException (ParamCouldNotBeParsedException { name, parserError }) = "param: Parameter '" <> cs name <> "' could not be parsed, " <> cs parserError + +-- | Specialized version of param for 'Text'. +-- +-- This way you don't need to know about the type application syntax. +paramText :: (?context :: ControllerContext) => ByteString -> Text +paramText = param @Text + +-- | Specialized version of param for 'Int'. +-- +-- This way you don't need to know about the type application syntax. +paramInt :: (?context :: ControllerContext) => ByteString -> Int +paramInt = param @Int + +-- | Specialized version of param for 'Bool'. +-- +-- This way you don't need to know about the type application syntax. +paramBool :: (?context :: ControllerContext) => ByteString -> Bool +paramBool = param @Bool + +-- | Specialized version of param for 'UUID'. +-- +-- This way you don't need to know about the type application syntax. +paramUUID :: (?context :: ControllerContext) => ByteString -> UUID +paramUUID = param @UUID + +-- | Returns @True@ when a parameter is given in the request via the query or request body. +-- +-- Use 'paramOrDefault' when you want to use this for providing a default value. +-- +-- __Example:__ +-- +-- Given the request @GET /HelloWorld@ +-- +-- > action HelloWorldAction = do +-- > if hasParam "firstname" +-- > then ... +-- > else renderPlain "Please provide your firstname" +-- +-- This will render @Please provide your firstname@ because @hasParam "firstname"@ returns @False@ +hasParam :: (?context :: ControllerContext) => ByteString -> Bool +hasParam = isJust . queryOrBodyParam +{-# INLINABLE hasParam #-} + +-- | Like 'param', but returns a default value when the parameter is missing instead of throwing +-- an exception. +-- +-- Use 'paramOrNothing' when you want to get @Maybe@. +-- +-- __Example:__ Pagination +-- +-- When calling @GET /Users@ the variable @page@ will be set to the default value @0@. +-- +-- > action UsersAction = do +-- > let page :: Int = paramOrDefault 0 "page" +-- +-- When calling @GET /Users?page=1@ the variable @page@ will be set to @1@. +paramOrDefault :: (?context :: ControllerContext) => ParamReader a => a -> ByteString -> a +paramOrDefault !defaultValue = fromMaybe defaultValue . paramOrNothing +{-# INLINABLE paramOrDefault #-} + +-- | Like 'param', but returns @Nothing@ the parameter is missing instead of throwing +-- an exception. +-- +-- Use 'paramOrDefault' when you want to deal with a default value. +-- +-- __Example:__ +-- +-- When calling @GET /Users@ the variable @page@ will be set to @Nothing@. +-- +-- > action UsersAction = do +-- > let page :: Maybe Int = paramOrNothing "page" +-- +-- When calling @GET /Users?page=1@ the variable @page@ will be set to @Just 1@. +paramOrNothing :: forall paramType. (?context :: ControllerContext) => ParamReader (Maybe paramType) => ByteString -> Maybe paramType +paramOrNothing !name = + case paramOrError name of + Left ParamNotFoundException {} -> Nothing + Left otherException -> Exception.throw otherException + Right value -> value +{-# INLINABLE paramOrNothing #-} + +-- | Like 'param', but returns @Left "Some error message"@ if the parameter is missing or invalid +paramOrError :: forall paramType. (?context :: ControllerContext) => ParamReader paramType => ByteString -> Either ParamException paramType +paramOrError !name = + let + RequestContext { requestBody } = ?context.requestContext + in case requestBody of + FormBody {} -> case queryOrBodyParam name of + Just value -> case readParameter @paramType value of + Left parserError -> Left ParamCouldNotBeParsedException { name, parserError } + Right value -> Right value + Nothing -> Left ParamNotFoundException { name } + JSONBody { jsonPayload } -> case jsonPayload of + (Just (Aeson.Object hashMap)) -> case Aeson.lookup (Aeson.fromText $ cs name) hashMap of + Just value -> case readParameterJSON @paramType value of + Left parserError -> Left ParamCouldNotBeParsedException { name, parserError } + Right value -> Right value + Nothing -> Left ParamNotFoundException { name } + _ -> Left ParamNotFoundException { name } +{-# INLINABLE paramOrError #-} + +-- | Returns a parameter without any parsing. Returns @Nothing@ when the parameter is missing. +queryOrBodyParam :: (?context :: ControllerContext) => ByteString -> Maybe ByteString +queryOrBodyParam !name = join (lookup name allParams) +{-# INLINABLE queryOrBodyParam #-} + +-- | Returns all params available in the current request +allParams :: (?context :: ControllerContext) => [(ByteString, Maybe ByteString)] +allParams = case requestBody of + FormBody { params, files } -> concat [(map (\(a, b) -> (a, Just b)) params), (Wai.queryString request)] + JSONBody { jsonPayload } -> error "allParams: Not supported for JSON requests" + where + RequestContext { request, requestBody } = ?context.requestContext + +-- | Input parser for 'param'. +-- +-- Parses the input bytestring. Returns @Left "some error"@ when there is an error parsing the value. +-- Returns @Right value@ when the parsing succeeded. +class ParamReader a where + -- | The error messages here should be human-readable, as they're visible e.g. in forms + readParameter :: ByteString -> Either ByteString a + -- | The error messages here are directed at other developers, so they can be a bit more technical than 'readParameter' errors + readParameterJSON :: Aeson.Value -> Either ByteString a + readParameterJSON = enumParamReaderJSON + +instance ParamReader ByteString where + {-# INLINABLE readParameter #-} + readParameter byteString = pure byteString + + readParameterJSON (Aeson.String bytestring) = Right (cs bytestring) + readParameterJSON _ = Left "Expected String" + +instance ParamReader Int where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly ((Attoparsec.signed Attoparsec.decimal) <* Attoparsec.endOfInput) byteString of + Right value -> Right value + Left error -> Left "has to be an integer" + + readParameterJSON (Aeson.Number number) = + case Scientific.floatingOrInteger number of + Left float -> Left "Expected Int" + Right int -> Right int + readParameterJSON _ = Left "Expected Int" + +instance ParamReader Integer where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly ((Attoparsec.signed Attoparsec.decimal) <* Attoparsec.endOfInput) byteString of + Right value -> Right value + Left error -> Left "has to be an integer" + + readParameterJSON (Aeson.Number number) = + case Scientific.floatingOrInteger number of + Left float -> Left "Expected Integer" + Right integer -> Right integer + readParameterJSON _ = Left "Expected Integer" + +instance ParamReader Double where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly (Attoparsec.double <* Attoparsec.endOfInput) byteString of + Right value -> Right value + Left error -> Left "has to be a number with decimals" + + readParameterJSON (Aeson.Number number) = + case Scientific.floatingOrInteger number of + Left double -> Right double + Right integer -> Right (fromIntegral integer) + readParameterJSON _ = Left "Expected Double" + +instance ParamReader Scientific.Scientific where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly (Attoparsec.scientific <* Attoparsec.endOfInput) byteString of + Right value -> Right value + Left error -> Left "has to be a number with decimals" + + readParameterJSON (Aeson.Number number) = Right number + readParameterJSON _ = Left "Expected Scientific" + +instance ParamReader Float where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly (Attoparsec.double <* Attoparsec.endOfInput) byteString of + Right value -> Right (Float.double2Float value) + Left error -> Left "has to be a number with decimals" + + readParameterJSON (Aeson.Number number) = + case Scientific.floatingOrInteger number of + Left double -> Right double + Right integer -> Right (fromIntegral integer) + readParameterJSON _ = Left "Expected Float" + +instance ParamReader ModelSupport.Point where + {-# INLINABLE readParameter #-} + readParameter byteString = + case Attoparsec.parseOnly (do x <- Attoparsec.double; Attoparsec.char ','; y <- Attoparsec.double; Attoparsec.endOfInput; pure ModelSupport.Point { x, y }) byteString of + Right value -> Right value + Left error -> Left "has to be two numbers with a comma, e.g. '1,2'" + + readParameterJSON (Aeson.String string) = let byteString :: ByteString = cs string in readParameter byteString + readParameterJSON _ = Left "Expected Point" + +instance ParamReader ModelSupport.PGInterval where + {-# INLINABLE readParameter #-} + readParameter byteString = pure (ModelSupport.PGInterval byteString) + + readParameterJSON (Aeson.String bytestring) = Right (ModelSupport.PGInterval (cs bytestring)) + readParameterJSON _ = Left "Expected String" + + + +instance ParamReader ModelSupport.Polygon where + {-# INLINABLE readParameter #-} + readParameter byteString = + let + pointParser = do + Attoparsec.char '(' + x <- Attoparsec.double + Attoparsec.char ',' + y <- Attoparsec.double + Attoparsec.char ')' + pure ModelSupport.Point { .. } + parser = do + points <- pointParser `Attoparsec.sepBy` (Attoparsec.char ',') + Attoparsec.endOfInput + pure ModelSupport.Polygon { .. } + in + case Attoparsec.parseOnly parser byteString of + Right value -> Right value + Left error -> Left "has to be points wrapped in parenthesis, separated with a comma, e.g. '(1,2),(3,4)'" + + readParameterJSON (Aeson.String string) = let byteString :: ByteString = cs string in readParameter byteString + readParameterJSON _ = Left "Expected Polygon" + +instance ParamReader Text where + {-# INLINABLE readParameter #-} + readParameter byteString = pure (cs byteString) + + readParameterJSON (Aeson.String text) = Right text + readParameterJSON _ = Left "Expected String" + +-- | Parses comma separated input like @userIds=1,2,3@ +-- +-- __Example:__ +-- +-- >>> let userIds :: [Int] = param "userIds" +instance ParamReader value => ParamReader [value] where + {-# INLINABLE readParameter #-} + readParameter byteString = + byteString + |> Char8.split ',' + |> map readParameter + |> Either.partitionEithers + |> \case + ([], values) -> Right values + ((first:rest), _) -> Left first + + readParameterJSON (Aeson.Array values) = + values + |> Vector.toList + |> map readParameterJSON + |> Either.partitionEithers + |> \case + ([], values) -> Right values + ((first:rest), _) -> Left first + readParameterJSON _ = Left "Expected Array" + +-- | Parses a boolean. +-- +-- Html form checkboxes usually use @on@ or @off@ for representation. These +-- values are supported here. +instance ParamReader Bool where + {-# INLINABLE readParameter #-} + readParameter on | on == cs (ModelSupport.inputValue True) = pure True + readParameter true | toLower (cs true) == "true" = pure True + readParameter _ = pure False + + readParameterJSON (Aeson.Bool bool) = Right bool + readParameterJSON _ = Left "Expected Bool" + +instance ParamReader UUID where + {-# INLINABLE readParameter #-} + readParameter byteString = + case UUID.fromASCIIBytes byteString of + Just uuid -> pure uuid + Nothing -> Left "has to be an UUID" + + readParameterJSON (Aeson.String string) = + case UUID.fromText string of + Just uuid -> pure uuid + Nothing -> Left "Invalid UUID" + readParameterJSON _ = Left "Expected String with an UUID" + +-- | Accepts values such as @2020-11-08T12:03:35Z@ or @2020-11-08@ +instance ParamReader UTCTime where + {-# INLINABLE readParameter #-} + readParameter "" = Left "This field cannot be empty" + readParameter byteString = + let + input = (cs byteString) + dateTime = parseTimeM True defaultTimeLocale "%Y-%m-%dT%H:%M:%S%QZ" input + date = parseTimeM True defaultTimeLocale "%Y-%-m-%-d" input + in case dateTime of + Nothing -> case date of + Just value -> Right value + Nothing -> Left "has to be a valid date and time, e.g. 2020-11-08T12:03:35Z" + Just value -> Right value + + readParameterJSON (Aeson.String string) = readParameter (cs string) + readParameterJSON _ = Left "Expected String" + +-- | Accepts values such as @2020-11-08T12:03:35Z@ or @2020-11-08@ +instance ParamReader LocalTime where + {-# INLINABLE readParameter #-} + readParameter "" = Left "This field cannot be empty" + readParameter byteString = + let + input = (cs byteString) + dateTime = parseTimeM True defaultTimeLocale "%Y-%m-%dT%H:%M:%S%QZ" input + date = parseTimeM True defaultTimeLocale "%Y-%-m-%-d" input + in case dateTime of + Nothing -> case date of + Just value -> Right value + Nothing -> Left "has to be a valid date and time, e.g. 2020-11-08T12:03:35Z" + Just value -> Right value + + readParameterJSON (Aeson.String string) = readParameter (cs string) + readParameterJSON _ = Left "Expected String" + +-- | Accepts values such as @2020-11-08@ +instance ParamReader Day where + {-# INLINABLE readParameter #-} + readParameter "" = Left "This field cannot be empty" + readParameter byteString = + let + input = (cs byteString) + date = parseTimeM True defaultTimeLocale "%Y-%-m-%-d" input + in case date of + Just value -> Right value + Nothing -> Left "has to be a date, e.g. 2020-11-08" + + readParameterJSON (Aeson.String string) = readParameter (cs string) + readParameterJSON _ = Left "Expected String" + +instance ParamReader TimeOfDay where + {-# INLINABLE readParameter #-} + readParameter "" = Left "This field cannot be empty" + readParameter byteString = + let + input = (cs byteString) + in case readMaybe input of + Just value -> Right value + Nothing -> Left "has to be time in the format hh:mm:ss" + + readParameterJSON (Aeson.String string) = readParameter (cs string) + readParameterJSON _ = Left "Expected String" + +instance {-# OVERLAPS #-} (ParamReader (ModelSupport.PrimaryKey model')) => ParamReader (ModelSupport.Id' model') where + {-# INLINABLE readParameter #-} + readParameter uuid = ModelSupport.Id <$> readParameter uuid + readParameterJSON value = ModelSupport.Id <$> readParameterJSON value + +instance ParamReader param => ParamReader (Maybe param) where + {-# INLINABLE readParameter #-} + readParameter param = + case (readParameter param) :: Either ByteString param of + Right value -> Right (Just value) + Left error | param == "" -> Right Nothing + Left error -> Left error + + readParameterJSON value = + case (readParameterJSON value) :: Either ByteString param of + Right value -> Right (Just value) + Left error | value == (Aeson.String "") -> Right Nothing + Left error -> Left error + +-- | Custom error hint when the 'param' is called with do-notation +-- +-- __Example:__ +-- +-- > action Example = do +-- > myParam <- param "hello" +-- +-- Now a custom type error will be shown telling the user to use @let myParam = param "hello"@ instead of do-notation. +instance (TypeError ('Text ("Use 'let x = param \"..\"' instead of 'x <- param \"..\"'" :: Symbol))) => ParamReader (IO param) where + readParameter _ = error "Unreachable" + readParameterJSON _ = error "Unreachable" + +-- | Can be used as a default implementation for 'readParameter' for enum structures +-- +-- __Example:__ +-- +-- > data Color = Yellow | Red | Blue deriving (Enum) +-- > +-- > instance ParamReader Color where +-- > readParameter = enumParamReader +-- > readParameterJSON = enumParamReaderJSON +enumParamReader :: forall parameter. (Enum parameter, ModelSupport.InputValue parameter) => ByteString -> Either ByteString parameter +enumParamReader string = + case find (\value -> ModelSupport.inputValue value == string') allEnumValues of + Just value -> Right value + Nothing -> Left "Invalid value" + where + string' = cs string + +-- | Used as a default implementation for 'readParameterJSON' +-- +-- __Example:__ +-- +-- > data Color = Yellow | Red | Blue deriving (Enum) +-- > +-- > instance ParamReader Color where +-- > readParameter = enumParamReader +-- > readParameterJSON = enumParamReaderJSON +enumParamReaderJSON :: forall parameter. (ParamReader parameter) => Aeson.Value -> Either ByteString parameter +enumParamReaderJSON (Aeson.String string) = readParameter (cs string) +enumParamReaderJSON otherwise = Left "enumParamReaderJSON: Invalid value, expected a string but got something else" + +-- | Provides the 'fill' function for mass-assignment of multiple parameters to a record +-- +-- Accepts a type-level list of parameter names (type-list syntax is like @\@'["a", "b", "c"]@) and a record. Then each parameter is +-- read from the request using the 'param' API. The parameter value is written to the record +-- field. Because the parameter is assigned to the record, the parameter name list can only +-- contain attribute names of the record. +-- +-- When there is a parser error, the error will be attached as a validation error to the record. The +-- remaining parameters will continue to be read. +-- +-- If a parameter is missing from the request, this will be ignored and the function proceeds as usual. +-- +-- +-- __Example:__ +-- +-- > action UpdateUserAction { userId } = do +-- > user :: User <- fetch userId +-- > user +-- > |> fill @["firstname", "lastname", "email"] +-- +-- This code will read the firstname, lastname and email from the request and assign them to the user. +class FillParams (params :: [Symbol]) record where + fill :: ( + ?context :: ControllerContext + , HasField "meta" record ModelSupport.MetaBag + , SetField "meta" record ModelSupport.MetaBag + ) => record -> record + +instance FillParams ('[]) record where + fill !record = record + {-# INLINE fill #-} + +instance (FillParams rest record + , KnownSymbol fieldName + , SetField fieldName record fieldType + , ParamReader fieldType + , HasField "meta" record ModelSupport.MetaBag + , SetField "meta" record ModelSupport.MetaBag + ) => FillParams (fieldName:rest) record where + fill !record = + let + name :: ByteString = cs $! (symbolVal (Proxy @fieldName)) + record' = case paramOrError name of + Right !(value :: fieldType) -> setField @fieldName value record + Left ParamCouldNotBeParsedException { parserError } -> attachFailure (Proxy @fieldName) (cs parserError) record + Left ParamNotFoundException {} -> record + in + fill @rest record' + {-# INLINE fill #-} + +ifValid :: (HasField "meta" model ModelSupport.MetaBag) => (Either model model -> IO r) -> model -> IO r +ifValid branch model = branch $! if ModelSupport.isValid model + then Right model + else Left model +{-# INLINE ifValid #-} + +ifNew :: forall record. (?context :: ControllerContext, ?modelContext :: ModelSupport.ModelContext, HasField "meta" record MetaBag) => (record -> record) -> record -> record +ifNew thenBlock record = if ModelSupport.isNew record then thenBlock record else record + + +-- | Transforms @Just ""@ to @Nothing@ +-- +-- __Example:__ We have record called @Company@ with a optional field @comment :: Maybe Text@ +-- +-- When we have a form that submits the @comment@ field and the field is empty, it will not be @NULL@ inside the database, +-- instead it will be set to the empty string. To avoid this we can apply @emptyValueToNothing #comment@. This function +-- turns the empty string into a 'Nothing' value. +-- +-- > action UpdateCompanyAction { companyId } = do +-- > company <- fetch companyId +-- > company +-- > |> fill '["name", "comment"] +-- > |> emptyValueToNothing #comment +-- > |> updateRecord +emptyValueToNothing field = modify field (maybe Nothing (\value -> if null value then Nothing else Just value)) diff --git a/IHP/Controller/Redirect.hs b/IHP/Controller/Redirect.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Redirect.hs @@ -0,0 +1,116 @@ +{-| +Module: IHP.Controller.Redirect +Description: redirect helpers +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Controller.Redirect +( redirectTo +, redirectToPath +, redirectToUrl +, redirectBack +, redirectBackWithFallback +) where + +import IHP.Prelude +import qualified Network.Wai.Util +import Network.URI (parseURI) +import IHP.Controller.RequestContext +import IHP.RouterSupport (HasPath (pathTo)) +import IHP.FrameworkConfig +import Network.HTTP.Types.Status +import qualified Network.Wai.Middleware.Approot as Approot + +import IHP.Controller.Context +import IHP.ControllerSupport + +-- | Redirects to an action +-- +-- __Example:__ +-- +-- > redirectTo ShowProjectAction { projectId = project.id } +-- +-- Use 'redirectToPath' if you want to redirect to a non-action url. +redirectTo :: (?context :: ControllerContext, HasPath action) => action -> IO () +redirectTo action = redirectToPath (pathTo action) +{-# INLINABLE redirectTo #-} + +-- TODO: redirectTo user + +-- | Redirects to a path (given as a string) +-- +-- __Example:__ +-- +-- > redirectToPath "/blog/wp-login.php" +-- +-- Use 'redirectTo' if you want to redirect to a controller action. +redirectToPath :: (?context :: ControllerContext) => Text -> IO () +redirectToPath path = redirectToUrl (convertString baseUrl <> path) + where + baseUrl = Approot.getApproot ?context.requestContext.request +{-# INLINABLE redirectToPath #-} + +-- | Redirects to a url (given as a string) +-- +-- __Example:__ +-- +-- > redirectToUrl "https://example.com/hello-world.html" +-- +-- Use 'redirectToPath' if you want to redirect to a relative path like @/hello-world.html@ +redirectToUrl :: (?context :: ControllerContext) => Text -> IO () +redirectToUrl url = do + let RequestContext { respond } = ?context.requestContext + let !parsedUrl = fromMaybe + (error ("redirectToPath: Unable to parse url: " <> show url)) + (parseURI (cs url)) + let !redirectResponse = fromMaybe + (error "redirectToPath: Unable to construct redirect response") + (Network.Wai.Util.redirect status302 [] parsedUrl) + respondAndExit redirectResponse +{-# INLINABLE redirectToUrl #-} + + +-- | Redirects back to the last page +-- +-- Uses the Referer header to do a redirect to page that got you here. +-- +-- In case the Referer header is not set this function will redirect to @/@. Use 'redirectBackWithFallback' when you want +-- to specify a custom fallback path. +-- +-- __Example:__ +-- +-- > action LikeAction { postId } = do +-- > post <- fetch postId +-- > post +-- > |> incrementField #likesCount +-- > |> updateRecord +-- > +-- > redirectBack +-- +redirectBack :: (?context :: ControllerContext) => IO () +redirectBack = redirectBackWithFallback "/" +{-# INLINABLE redirectBack #-} + +-- | Redirects back to the last page or the given fallback path in case the Referer header is missing +-- +-- If you don't care about the missing-Referer-header case, use 'redirectBack'. +-- +-- __Example:__ +-- +-- > action LikeAction { postId } = do +-- > post <- fetch postId +-- > post +-- > |> incrementField #likesCount +-- > |> updateRecord +-- > +-- > redirectBackWithFallback (pathTo ShowPostAction { postId = post.id }) +-- +redirectBackWithFallback :: (?context :: ControllerContext) => Text -> IO () +redirectBackWithFallback fallbackPathOrUrl = do + case getHeader "Referer" of + Just referer -> case parseURI (cs referer) of + Just uri -> redirectToUrl (tshow uri) -- Referer Is URL "https://google.com/..." + Nothing -> redirectToPath (cs referer) -- Referer Is Path "/../" + Nothing -> case parseURI (cs fallbackPathOrUrl) of + Just uri -> redirectToUrl (tshow uri) -- Fallback Is URL "https://google.com/..." + Nothing -> redirectToPath fallbackPathOrUrl -- Fallback Is Path "/../" +{-# INLINABLE redirectBackWithFallback #-} diff --git a/IHP/Controller/Render.hs b/IHP/Controller/Render.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Render.hs @@ -0,0 +1,129 @@ +{-# LANGUAGE BangPatterns #-} +module IHP.Controller.Render where +import ClassyPrelude +import Network.Wai (responseLBS, responseBuilder, responseFile) +import qualified Network.Wai +import Network.HTTP.Types (Status, status200, status406) +import Network.HTTP.Types.Header +import qualified Data.ByteString.Lazy +import qualified IHP.ViewSupport as ViewSupport +import qualified Data.Aeson +import IHP.ControllerSupport +import qualified Network.HTTP.Media as Accept +import qualified Data.List as List + +import qualified Text.Blaze.Html.Renderer.Utf8 as Blaze +import Text.Blaze.Html (Html) +import qualified IHP.Controller.Context as Context +import IHP.Controller.Layout +import qualified IHP.FrameworkConfig as FrameworkConfig +import qualified Data.ByteString.Builder as ByteString +import IHP.FlashMessages.ControllerFunctions (initFlashMessages) + +renderPlain :: (?context :: ControllerContext) => LByteString -> IO () +renderPlain text = respondAndExit $ responseLBS status200 [(hContentType, "text/plain")] text +{-# INLINABLE renderPlain #-} + +respondHtml :: (?context :: ControllerContext) => Html -> IO () +respondHtml html = + -- The seq is required to force evaluation of `evaluatedBuilder` before returning the IO action. See below for details + evaluatedBuilder `seq` (respondAndExit $ responseBuilder status200 [(hContentType, "text/html; charset=utf-8"), (hConnection, "keep-alive")] evaluatedBuilder) + where + builder = Blaze.renderHtmlBuilder html + builderAsByteString = ByteString.toLazyByteString builder + + -- We force the full evaluation of the blaze html expressions to catch + -- any runtime errors with the IHP error middleware. Without this full evaluation + -- certain thunks might only cause an error when warp is building the response string. + -- But then it's already too late to catch the exception and the user will only get + -- the default warp error message instead of our nice IHP error message design. + evaluatedBuilder = Data.ByteString.Lazy.length builderAsByteString `seq` ByteString.lazyByteString builderAsByteString +{-# INLINABLE respondHtml #-} + +respondSvg :: (?context :: ControllerContext) => Html -> IO () +respondSvg html = respondAndExit $ responseBuilder status200 [(hContentType, "image/svg+xml"), (hConnection, "keep-alive")] (Blaze.renderHtmlBuilder html) +{-# INLINABLE respondSvg #-} + +renderHtml :: forall view. (ViewSupport.View view, ?context :: ControllerContext) => view -> IO Html +renderHtml !view = do + let ?view = view + initFlashMessages + ViewSupport.beforeRender view + frozenContext <- Context.freeze ?context + + let ?context = frozenContext + let layout = case Context.maybeFromFrozenContext @ViewLayout of + Just (ViewLayout layout) -> layout + Nothing -> id + + let boundHtml = let ?context = frozenContext in layout (ViewSupport.html ?view) + pure boundHtml +{-# INLINABLE renderHtml #-} + +renderFile :: (?context :: ControllerContext) => String -> ByteString -> IO () +renderFile filePath contentType = respondAndExit $ responseFile status200 [(hContentType, contentType)] filePath Nothing +{-# INLINABLE renderFile #-} + +renderJson :: (?context :: ControllerContext) => Data.Aeson.ToJSON json => json -> IO () +renderJson json = renderJsonWithStatusCode status200 json +{-# INLINABLE renderJson #-} + +renderJsonWithStatusCode :: (?context :: ControllerContext) => Data.Aeson.ToJSON json => Status -> json -> IO () +renderJsonWithStatusCode statusCode json = respondAndExit $ responseLBS statusCode [(hContentType, "application/json")] (Data.Aeson.encode json) +{-# INLINABLE renderJsonWithStatusCode #-} + +renderXml :: (?context :: ControllerContext) => LByteString -> IO () +renderXml xml = respondAndExit $ responseLBS status200 [(hContentType, "application/xml")] xml +{-# INLINABLE renderXml #-} + +-- | Use 'setHeader' intead +renderJson' :: (?context :: ControllerContext) => ResponseHeaders -> Data.Aeson.ToJSON json => json -> IO () +renderJson' additionalHeaders json = respondAndExit $ responseLBS status200 ([(hContentType, "application/json")] <> additionalHeaders) (Data.Aeson.encode json) +{-# INLINABLE renderJson' #-} + +data PolymorphicRender + = PolymorphicRender + { html :: Maybe (IO ()) + , json :: Maybe (IO ()) + } + +-- | Can be used to render different responses for html, json, etc. requests based on `Accept` header +-- Example: +-- +-- > show :: Action +-- > show = do +-- > renderPolymorphic polymorphicRender { +-- > html = renderHtml [hsx|
Hello World
|] +-- > json = renderJson True +-- > } +-- +-- This will render @Hello World@ for normal browser requests and @true@ when requested via an ajax request +{-# INLINABLE renderPolymorphic #-} +renderPolymorphic :: (?context :: ControllerContext) => PolymorphicRender -> IO () +renderPolymorphic PolymorphicRender { html, json } = do + let headers = Network.Wai.requestHeaders request + let acceptHeader = snd (fromMaybe (hAccept, "text/html") (List.find (\(headerName, _) -> headerName == hAccept) headers)) :: ByteString + let send406Error = respondAndExit $ responseLBS status406 [] "Could not find any acceptable response format" + let formats = concat [ + case html of + Just handler -> [("text/html", handler)] + Nothing -> mempty + , + case json of + Just handler -> [("application/json", handler)] + Nothing -> mempty + ] + fromMaybe send406Error (Accept.mapAcceptMedia formats acceptHeader) + +polymorphicRender :: PolymorphicRender +polymorphicRender = PolymorphicRender Nothing Nothing + + +{-# INLINABLE render #-} +render :: forall view. (ViewSupport.View view, ?context :: ControllerContext) => view -> IO () +render !view = do + renderPolymorphic PolymorphicRender + { html = Just $ (renderHtml view) >>= respondHtml + , json = Just $ renderJson (ViewSupport.json view) + } + diff --git a/IHP/Controller/RequestContext.hs b/IHP/Controller/RequestContext.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/RequestContext.hs @@ -0,0 +1,26 @@ +module IHP.Controller.RequestContext +( RequestContext (..) +, Respond +, RequestBody (..) +) where + +import ClassyPrelude +import qualified Data.ByteString.Lazy as LBS +import Network.Wai (Request, Response, ResponseReceived) +import Network.Wai.Parse (File, Param) +import IHP.FrameworkConfig +import qualified Data.Aeson as Aeson + + +type Respond = Response -> IO ResponseReceived + +data RequestBody + = FormBody { params :: [Param], files :: [File LBS.ByteString] } + | JSONBody { jsonPayload :: Maybe Aeson.Value, rawPayload :: LByteString } -- ^ The jsonPayload is the decoded json request. We keep a copy of the original json request in rawPayload, so that you can e.g. get a HMAC signature from the request + +data RequestContext = RequestContext + { request :: Request + , respond :: Respond + , requestBody :: RequestBody + , frameworkConfig :: FrameworkConfig + } diff --git a/IHP/Controller/Response.hs b/IHP/Controller/Response.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Response.hs @@ -0,0 +1,51 @@ +module IHP.Controller.Response +( respondAndExit +, addResponseHeaders +, addResponseHeadersFromContext +, ResponseException (..) +) +where + +import ClassyPrelude +import Network.HTTP.Types.Header +import qualified IHP.Controller.Context as Context +import qualified Network.Wai +import Network.Wai (Response) +import qualified Control.Exception as Exception + +respondAndExit :: (?context :: Context.ControllerContext) => Response -> IO () +respondAndExit response = do + responseWithHeaders <- addResponseHeadersFromContext response + Exception.throwIO (ResponseException responseWithHeaders) +{-# INLINE respondAndExit #-} + +-- | Add headers to current response +-- | Returns a Response with headers +-- +-- > addResponseHeaders [("Content-Type", "text/html")] response +-- +addResponseHeaders :: [Header] -> Response -> Response +addResponseHeaders headers = Network.Wai.mapResponseHeaders (\hs -> headers <> hs) +{-# INLINABLE addResponseHeaders #-} + +-- | Add headers to current response, getting the headers from ControllerContext +-- | Returns a Response with headers +-- +-- > addResponseHeadersFromContext response +-- You probabaly want `setHeader` +-- +addResponseHeadersFromContext :: (?context :: Context.ControllerContext) => Response -> IO Response +addResponseHeadersFromContext response = do + maybeHeaders <- Context.maybeFromContext @[Header] + let headers = fromMaybe [] maybeHeaders + let responseWithHeaders = addResponseHeaders headers response + pure responseWithHeaders +{-# INLINABLE addResponseHeadersFromContext #-} + +-- Can be thrown from inside the action to abort the current action execution. +-- Does not indicates a runtime error. It's just used for control flow management. +newtype ResponseException = ResponseException Response + +instance Show ResponseException where show _ = "ResponseException { .. }" + +instance Exception ResponseException diff --git a/IHP/Controller/Session.hs b/IHP/Controller/Session.hs new file mode 100644 --- /dev/null +++ b/IHP/Controller/Session.hs @@ -0,0 +1,172 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE UndecidableInstances #-} +{-| +Module: IHP.Controller.Session +Description: Functions to work with session cookies, provides 'setSession', 'getSession' and friends +Copyright: (c) digitally induced GmbH, 2021 + +The session provides a way for your application to store small amounts of information that will be persisted between requests. It’s mainly used from inside your controller actions. + +In general, you should not store complex data structures in the session. It’s better to store scalar values in there only. For example: Store the current user-id instead of the current user record. + +The session works by storing the data inside a cryptographically signed and encrypted cookie on the client. The encryption key is generated automatically and is stored at @Config/client_session_key.aes@. Internally IHP uses the clientsession library. You can find more technical details on the implementation in the documentation. + +The cookie @max-age@ is set to 30 days by default. To protect against CSRF, the @SameSite@ Policy is set to @Lax@. +-} +module IHP.Controller.Session + ( + -- * Session Error + SessionError (..) + + -- * Interacting with session store + , setSession + , getSession + , getSessionEither + , deleteSession + , getSessionAndClear + , sessionVaultKey + ) where + +import IHP.Prelude +import IHP.Controller.RequestContext +import IHP.Controller.Context +import IHP.ModelSupport +import qualified Data.UUID as UUID +import qualified Data.Vault.Lazy as Vault +import qualified Network.Wai as Wai +import qualified Data.Serialize as Serialize +import Data.Serialize (Serialize) +import Data.Serialize.Text () +import qualified Network.Wai.Session +import System.IO.Unsafe (unsafePerformIO) + +-- | Types of possible errors as a result of +-- requesting a value from the session storage +data SessionError + -- | Value not found in the session storage + = NotFoundError + -- | Error occurce during parsing value + | ParseError String + deriving (Show, Eq) + +-- | Stores a value inside the session: +-- +-- > action SessionExampleAction { userId } = do +-- > setSession "userId" userId +-- +-- For cases where setSession is used with literals, +-- to avoid type ambiguity, you can use one of the options below +-- +-- __Example:__ Annotate a literal with a type +-- +-- > action LogoutAction = do +-- > setSession "userEmail" ("hi@digitallyinduced.com" :: Text) +-- +-- __Example:__ Using setSession with type application +-- +-- > action LogoutAction = do +-- > setSession @Text "userEmail" "hi@digitallyinduced.com" +-- +setSession :: (?context :: ControllerContext, Serialize value) + => ByteString -> value -> IO () +setSession name value = sessionInsert name (Serialize.encode value) +{-# INLINABLE setSession #-} + +-- | Retrives a value from the session: +-- +-- > action SessionExampleAction = do +-- > userEmail <- getSession @Text "userEmail" +-- > counter <- getSession @Int "counter" +-- > userId <- getSession @(Id User) "userId" +-- +-- @userEmail@ is set to @Just' "hi@digitallyinduced.com"@ +-- when the value has been set before. Otherwise, it will be 'Nothing'. +-- +-- If an error occurs while getting the value, the result will be 'Nothing'. +getSession :: forall value + . (?context :: ControllerContext, Serialize value) + => ByteString -> IO (Maybe value) +getSession name = getSessionEither name >>= \case + Left _ -> pure Nothing + Right result -> pure (Just result) +{-# INLINABLE getSession #-} + +-- | Retrives a value from the session: +-- +-- 'getSession' variant, which returns 'SessionError' if an error occurs +-- while getting value from session storage +-- +-- > action SessionExampleAction = do +-- > counter <- getSessionEither @Int "counter" +-- > case counter of +-- > Right value -> ... +-- > Left (ParseError errorMessage) -> ... +-- > Left NotFoundError -> ... +-- > Left VaultError -> ... +getSessionEither :: forall value + . (?context :: ControllerContext, Serialize value) + => ByteString -> IO (Either SessionError value) +getSessionEither name = sessionLookup name >>= \case + Nothing -> pure $ Left NotFoundError + Just "" -> pure $ Left NotFoundError + Just stringValue -> case Serialize.decode stringValue of + Left error -> pure . Left $ ParseError error + Right value -> pure $ Right value +{-# INLINABLE getSessionEither #-} + +-- | Remove session values from storage: +-- +-- __Example:__ Deleting a @userId@ field from the session +-- +-- > action LogoutAction = do +-- > deleteSession "userId" +-- +-- __Example:__ Calling 'getSession' after +-- using 'deleteSession' will return @Nothing@ +-- +-- > setSession "userId" (1337 :: Int) +-- > userId <- getSession @Int "userId" -- Returns: Just 1337 +-- > +-- > deleteSession "userId" +-- > userId <- getSession @Int "userId" -- Returns: Nothing +deleteSession :: (?context :: ControllerContext) => ByteString -> IO () +deleteSession name = sessionInsert name "" + +-- | Returns a value from the session, and deletes it after retrieving: +-- +-- > action SessionExampleAction = do +-- > notification <- getSessionAndClear @Text "notification" +getSessionAndClear :: forall value + . (?context :: ControllerContext, Serialize value) + => ByteString -> IO (Maybe value) +getSessionAndClear name = do + value <- getSession @value name + when (isJust value) (deleteSession name) + pure value +{-# INLINABLE getSessionAndClear #-} + +instance (PrimaryKey table ~ UUID) => Serialize (Id' table) where + put (Id value) = Serialize.put (UUID.toASCIIBytes value) + get = do + maybeUUID <- UUID.fromASCIIBytes <$> Serialize.get + case maybeUUID of + Nothing -> fail "Failed to parse UUID" + Just uuid -> pure (Id uuid) + +sessionInsert :: (?context :: ControllerContext) => ByteString -> ByteString -> IO () +sessionInsert = snd sessionVault + +sessionLookup :: (?context :: ControllerContext) => ByteString -> IO (Maybe ByteString) +sessionLookup = fst sessionVault + +sessionVault :: (?context :: ControllerContext) => (ByteString -> IO (Maybe ByteString), ByteString -> ByteString -> IO ()) +sessionVault = case vaultLookup of + Just session -> session + Nothing -> error "sessionInsert: The session vault is missing in the request" + where + RequestContext { request } = ?context.requestContext + vaultLookup = Vault.lookup sessionVaultKey request.vault + +sessionVaultKey :: Vault.Key (Network.Wai.Session.Session IO ByteString ByteString) +sessionVaultKey = unsafePerformIO Vault.newKey +{-# NOINLINE sessionVaultKey #-} diff --git a/IHP/ControllerPrelude.hs b/IHP/ControllerPrelude.hs new file mode 100644 --- /dev/null +++ b/IHP/ControllerPrelude.hs @@ -0,0 +1,88 @@ +module IHP.ControllerPrelude + ( module IHP.Prelude + , module IHP.ControllerSupport + , module IHP.Controller.AccessDenied + , module IHP.Controller.NotFound + , module IHP.Controller.Render + , module IHP.Controller.Param + , module IHP.Controller.FileUpload + , module IHP.Controller.Session + , module IHP.Controller.Redirect + , module IHP.Controller.BasicAuth + , module IHP.Controller.Cookie + , module IHP.HaskellSupport + , module IHP.ModelSupport + , module IHP.FrameworkConfig + , module IHP.QueryBuilder + , module IHP.Fetch + , module IHP.FetchRelated + , module Data.Aeson + , module Network.Wai.Parse + , module IHP.RouterSupport + , module IHP.ValidationSupport + , module IHP.AutoRefresh + , module IHP.Mail + , module IHP.FlashMessages.Types + , module IHP.FlashMessages.ControllerFunctions + , module IHP.Controller.Context + , module IHP.Modal.Types + , module IHP.Modal.ControllerFunctions + , module IHP.Controller.Layout + , module IHP.Job.Types + , module IHP.LoginSupport.Helper.Controller + , Only (..) + , module IHP.PageHead.ControllerFunctions + , module IHP.WebSocket + , module IHP.FileStorage.Types + , module IHP.FileStorage.ControllerFunctions + , module IHP.FileStorage.Preprocessor.ImageMagick + , module IHP.Pagination.ControllerFunctions + , module IHP.HSX.QQ + ) where +import IHP.Prelude +import IHP.Controller.Param +import IHP.Controller.FileUpload +import IHP.Controller.Render +import IHP.Controller.AccessDenied +import IHP.Controller.NotFound +import IHP.Controller.Session +import IHP.Controller.RequestContext +import IHP.Controller.BasicAuth +import IHP.Controller.Cookie +import IHP.ControllerSupport +import IHP.ValidationSupport +import IHP.HaskellSupport +import IHP.ModelSupport +import IHP.FrameworkConfig +import IHP.QueryBuilder +import IHP.Fetch +import IHP.FetchRelated +import Data.Aeson hiding (Success) +import Network.Wai.Parse (FileInfo(..)) +import IHP.RouterSupport hiding (get, post) +import IHP.Controller.Redirect +import IHP.Mail (sendMail) +import Database.PostgreSQL.Simple.Types (Only (..)) +import IHP.FlashMessages.Types +import IHP.FlashMessages.ControllerFunctions +import IHP.Controller.Context +import IHP.Controller.Layout + +import IHP.Modal.Types +import IHP.Modal.ControllerFunctions + +import IHP.Job.Types +import IHP.AutoRefresh (initAutoRefresh, autoRefresh) + +import IHP.LoginSupport.Helper.Controller +import IHP.PageHead.ControllerFunctions + +import IHP.WebSocket + +import IHP.FileStorage.Types +import IHP.FileStorage.ControllerFunctions +import IHP.FileStorage.Preprocessor.ImageMagick + +import IHP.Pagination.ControllerFunctions +import IHP.HSX.QQ (hsx) +import IHP.HSX.ToHtml () diff --git a/IHP/ControllerSupport.hs b/IHP/ControllerSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/ControllerSupport.hs @@ -0,0 +1,292 @@ +{-# LANGUAGE TypeSynonymInstances, FlexibleInstances, TypeFamilies, ConstrainedClassMethods, ScopedTypeVariables, FunctionalDependencies, AllowAmbiguousTypes #-} + +module IHP.ControllerSupport +( Action' +, (|>) +, getRequestBody +, getRequestPath +, getRequestPathAndQuery +, getHeader +, RequestContext (RequestContext) +, request +, requestHeaders +, getFiles +, Controller (..) +, runAction +, createRequestContext +, ControllerContext +, InitControllerContext (..) +, runActionWithNewContext +, newContextForAction +, respondAndExit +, jumpToAction +, requestBodyJSON +, startWebSocketApp +, startWebSocketAppAndFailOnHTTP +, setHeader +, getAppConfig +) where + +import ClassyPrelude +import IHP.HaskellSupport +import Network.Wai (Request, ResponseReceived, responseLBS, requestHeaders) +import qualified Network.HTTP.Types as HTTP +import qualified Network.Wai +import IHP.ModelSupport +import IHP.ApplicationContext (ApplicationContext (..)) +import Network.Wai.Parse as WaiParse +import qualified Data.ByteString.Lazy +import qualified IHP.Controller.RequestContext as RequestContext +import IHP.Controller.RequestContext (RequestContext, Respond) +import qualified Data.CaseInsensitive +import qualified IHP.ErrorController as ErrorController +import qualified Data.Typeable as Typeable +import IHP.FrameworkConfig (FrameworkConfig (..), ConfigProvider(..)) +import qualified IHP.Controller.Context as Context +import IHP.Controller.Context (ControllerContext(ControllerContext), customFieldsRef) +import IHP.Controller.Response +import Network.HTTP.Types.Header +import qualified Data.Aeson as Aeson +import qualified Network.Wai.Handler.WebSockets as WebSockets +import qualified Network.WebSockets as WebSockets +import qualified IHP.WebSocket as WebSockets +import qualified Data.TMap as TypeMap + +type Action' = IO ResponseReceived + +class (Show controller, Eq controller) => Controller controller where + beforeAction :: (?context :: ControllerContext, ?modelContext :: ModelContext, ?theAction :: controller) => IO () + beforeAction = pure () + {-# INLINABLE beforeAction #-} + action :: (?context :: ControllerContext, ?modelContext :: ModelContext, ?theAction :: controller) => controller -> IO () + +class InitControllerContext application where + initContext :: (?modelContext :: ModelContext, ?requestContext :: RequestContext, ?applicationContext :: ApplicationContext, ?context :: ControllerContext) => IO () + initContext = pure () + {-# INLINABLE initContext #-} + +instance InitControllerContext () where + initContext = pure () + +{-# INLINE runAction #-} +runAction :: forall controller. (Controller controller, ?context :: ControllerContext, ?modelContext :: ModelContext, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext) => controller -> IO ResponseReceived +runAction controller = do + let ?theAction = controller + let respond = ?context.requestContext.respond + + let doRunAction = do + authenticatedModelContext <- prepareRLSIfNeeded ?modelContext + + let ?modelContext = authenticatedModelContext + beforeAction + (action controller) + ErrorController.handleNoResponseReturned controller + + let handleResponseException (ResponseException response) = respond response + + doRunAction `catches` [ Handler handleResponseException, Handler (\exception -> ErrorController.displayException exception controller "")] + +{-# INLINE newContextForAction #-} +newContextForAction + :: forall application controller + . ( Controller controller + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , InitControllerContext application + , ?application :: application + , Typeable application + , Typeable controller + ) + => controller -> IO (Either (IO ResponseReceived) ControllerContext) +newContextForAction controller = do + let ?modelContext = ?applicationContext.modelContext + let ?requestContext = ?context + controllerContext <- Context.newControllerContext + let ?context = controllerContext + Context.putContext ?application + Context.putContext (Context.ActionType (Typeable.typeOf controller)) + + try (initContext @application) >>= \case + Left (exception :: SomeException) -> do + pure $ Left $ case fromException exception of + Just (ResponseException response) -> + let respond = ?context.requestContext.respond + in respond response + Nothing -> ErrorController.displayException exception controller " while calling initContext" + Right _ -> pure $ Right ?context + +{-# INLINE runActionWithNewContext #-} +runActionWithNewContext :: forall application controller. (Controller controller, ?applicationContext :: ApplicationContext, ?context :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, Typeable controller) => controller -> IO ResponseReceived +runActionWithNewContext controller = do + contextOrResponse <- newContextForAction controller + case contextOrResponse of + Left response -> response + Right context -> do + let ?modelContext = ?applicationContext.modelContext + let ?requestContext = ?context + let ?context = context + runAction controller + +-- | If 'IHP.LoginSupport.Helper.Controller.enableRowLevelSecurityIfLoggedIn' was called, this will copy the +-- the prepared RowLevelSecurityContext from the controller context into the ModelContext. +-- +-- If row leve security wasn't enabled, this will just return the current model context. +prepareRLSIfNeeded :: (?context :: ControllerContext) => ModelContext -> IO ModelContext +prepareRLSIfNeeded modelContext = do + rowLevelSecurityContext <- Context.maybeFromContext + case rowLevelSecurityContext of + Just context -> pure modelContext { rowLevelSecurity = Just context } + Nothing -> pure modelContext + +{-# INLINE startWebSocketApp #-} +startWebSocketApp :: forall webSocketApp application. (?applicationContext :: ApplicationContext, ?context :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, WebSockets.WSApp webSocketApp) => webSocketApp -> IO ResponseReceived -> Network.Wai.Application +startWebSocketApp initialState onHTTP request respond = do + let ?modelContext = ?applicationContext.modelContext + requestContext <- createRequestContext ?applicationContext request respond + let ?requestContext = requestContext + + let handleConnection pendingConnection = do + connection <- WebSockets.acceptRequest pendingConnection + + controllerContext <- Context.newControllerContext + let ?context = controllerContext + + Context.putContext ?application + + try (initContext @application) >>= \case + Left (exception :: SomeException) -> putStrLn $ "Unexpected exception in initContext, " <> tshow exception + Right context -> do + WebSockets.startWSApp initialState connection + + let connectionOptions = WebSockets.connectionOptions @webSocketApp + + request + |> WebSockets.websocketsApp connectionOptions handleConnection + |> \case + Just response -> respond response + Nothing -> onHTTP +{-# INLINE startWebSocketAppAndFailOnHTTP #-} +startWebSocketAppAndFailOnHTTP :: forall webSocketApp application. (?applicationContext :: ApplicationContext, ?context :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, WebSockets.WSApp webSocketApp) => webSocketApp -> Network.Wai.Application +startWebSocketAppAndFailOnHTTP initialState = startWebSocketApp @webSocketApp @application initialState (respond $ responseLBS HTTP.status400 [(hContentType, "text/plain")] "This endpoint is only available via a WebSocket") + where + respond = ?context.respond + + +jumpToAction :: forall action. (Controller action, ?context :: ControllerContext, ?modelContext :: ModelContext) => action -> IO () +jumpToAction theAction = do + let ?theAction = theAction + beforeAction @action + action theAction + +{-# INLINE getRequestBody #-} +getRequestBody :: (?context :: ControllerContext) => IO LByteString +getRequestBody = + case ?context.requestContext.requestBody of + RequestContext.JSONBody { rawPayload } -> pure rawPayload + _ -> Network.Wai.lazyRequestBody request + +-- | Returns the request path, e.g. @/Users@ or @/CreateUser@ +getRequestPath :: (?context :: ControllerContext) => ByteString +getRequestPath = request.rawPathInfo +{-# INLINABLE getRequestPath #-} + +-- | Returns the request path and the query params, e.g. @/ShowUser?userId=9bd6b37b-2e53-40a4-bb7b-fdba67d6af42@ +getRequestPathAndQuery :: (?context :: ControllerContext) => ByteString +getRequestPathAndQuery = request.rawPathInfo <> request.rawQueryString +{-# INLINABLE getRequestPathAndQuery #-} + +-- | Returns a header value for a given header name. Returns Nothing if not found +-- +-- The header is looked up in a case insensitive way. +-- +-- >>> getHeader "Content-Type" +-- Just "text/html" +-- +-- >>> getHeader "X-My-Custom-Header" +-- Nothing +-- +getHeader :: (?context :: ControllerContext) => ByteString -> Maybe ByteString +getHeader name = lookup (Data.CaseInsensitive.mk name) request.requestHeaders +{-# INLINABLE getHeader #-} + +-- | Set a header value for a given header name. +-- +-- >>> setHeader ("Content-Language", "en") +-- +setHeader :: (?context :: ControllerContext) => Header -> IO () +setHeader header = do + maybeHeaders <- Context.maybeFromContext @[Header] + let headers = fromMaybe [] maybeHeaders + Context.putContext (header : headers) +{-# INLINABLE setHeader #-} + +-- | Returns the current HTTP request. +-- +-- See https://hackage.haskell.org/package/wai-3.2.2.1/docs/Network-Wai.html#t:Request +request :: (?context :: ControllerContext) => Network.Wai.Request +request = requestContext.request +{-# INLINE request #-} + +{-# INLINE getFiles #-} +getFiles :: (?context :: ControllerContext) => [File Data.ByteString.Lazy.ByteString] +getFiles = + case requestContext.requestBody of + RequestContext.FormBody { files } -> files + _ -> [] + +requestContext :: (?context :: ControllerContext) => RequestContext +requestContext = ?context.requestContext +{-# INLINE requestContext #-} + +requestBodyJSON :: (?context :: ControllerContext) => Aeson.Value +requestBodyJSON = + case ?context.requestContext.requestBody of + RequestContext.JSONBody { jsonPayload = Just value } -> value + _ -> error "Expected JSON body" + +{-# INLINE createRequestContext #-} +createRequestContext :: ApplicationContext -> Request -> Respond -> IO RequestContext +createRequestContext ApplicationContext { frameworkConfig } request respond = do + let contentType = lookup hContentType (requestHeaders request) + requestBody <- case contentType of + "application/json" -> do + rawPayload <- Network.Wai.lazyRequestBody request + let jsonPayload = Aeson.decode rawPayload + pure RequestContext.JSONBody { jsonPayload, rawPayload } + _ -> do + (params, files) <- WaiParse.parseRequestBodyEx frameworkConfig.parseRequestBodyOptions WaiParse.lbsBackEnd request + pure RequestContext.FormBody { .. } + + pure RequestContext.RequestContext { request, respond, requestBody, frameworkConfig } + + +-- | Returns a custom config parameter +-- +-- >>> getAppConfig @StripePublicKey +-- StripePublicKey "pk_test_..." +-- +-- Example: +-- +-- First you need to define a custom config parameter in Config.hs: +-- +-- > -- Config/Config.hs +-- > newtype StripePublicKey = StripePublicKey Text +-- > +-- > config :: ConfigBuilder +-- > config = do +-- > -- ... +-- > stripePublicKey <- StripePublicKey <$> env @Text "STRIPE_PUBLIC_KEY" +-- > option stripePublicKey +-- +-- Then you can access it using 'getAppConfig': +-- +-- > action MyAction = do +-- > let (StripePublicKey stripePublicKey) = getAppConfig @StripePublicKey +-- > +-- > putStrLn ("Stripe public key: " <> stripePublicKey) +-- +getAppConfig :: forall configParameter context. (?context :: context, ConfigProvider context, Typeable configParameter) => configParameter +getAppConfig = ?context.frameworkConfig.appConfig + |> TypeMap.lookup @configParameter + |> fromMaybe (error ("Could not find " <> (show (Typeable.typeRep (Typeable.Proxy @configParameter))) <>" in config")) +{-# INLINE getAppConfig #-} diff --git a/IHP/DataSync/ChangeNotifications.hs b/IHP/DataSync/ChangeNotifications.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/ChangeNotifications.hs @@ -0,0 +1,187 @@ +module IHP.DataSync.ChangeNotifications +( channelName +, ChangeNotification (..) +, Change (..) +, ChangeSet (..) +, createNotificationFunction +, installTableChangeTriggers +, makeCachedInstallTableChangeTriggers +, retrieveChanges +) where + +import IHP.Prelude +import qualified Database.PostgreSQL.Simple as PG +import IHP.ModelSupport +import Data.String.Interpolate.IsString (i) +import Data.Aeson +import Data.Aeson.TH +import qualified IHP.DataSync.RowLevelSecurity as RLS +import qualified Data.Set as Set +import qualified Data.UUID as UUID + +data ChangeNotification + = DidInsert { id :: !UUID } + | DidUpdate { id :: !UUID, changeSet :: !ChangeSet } + | DidUpdateLarge { id :: !UUID, payloadId :: !UUID } + | DidDelete { id :: !UUID } + deriving (Eq, Show) + +data ChangeSet + = InlineChangeSet { changeSet :: ![Change] } -- | When the patch fits into the 8000 bytes limit of @pg_notify@ + | ExternalChangeSet { largePgNotificationId :: !UUID } -- | The patch is over 8000 bytes, so we have stored it in the @large_pg_notifications@ table + deriving (Eq, Show) + +data Change = Change + { col :: !Text + , new :: !Value + } deriving (Eq, Show) + +-- | Returns the sql code to set up a database trigger. Mainly used by 'watchInsertOrUpdateTable'. +createNotificationFunction :: RLS.TableWithRLS -> PG.Query +createNotificationFunction table = [i| + DO $$ + BEGIN + CREATE FUNCTION "#{functionName}"() RETURNS TRIGGER AS $BODY$ + DECLARE + payload TEXT; + large_pg_notification_id UUID; + changeset JSON; + BEGIN + CASE TG_OP + WHEN 'UPDATE' THEN + SELECT coalesce(json_agg(row_to_json(t)), '[]'::json) + FROM ( + SELECT pre.key AS "col", post.value AS "new" + FROM jsonb_each(to_jsonb(OLD)) AS pre + CROSS JOIN jsonb_each(to_jsonb(NEW)) AS post + WHERE pre.key = post.key AND pre.value IS DISTINCT FROM post.value + ) t INTO changeset; + payload := json_build_object( + 'UPDATE', NEW.id::text, + 'CHANGESET', changeset + )::text; + IF octet_length(payload) > 7800 THEN + INSERT INTO large_pg_notifications (payload) VALUES (changeset) RETURNING id INTO large_pg_notification_id; + payload := json_build_object( + 'UPDATE', NEW.id::text, + 'CHANGESET', large_pg_notification_id::text + )::text; + DELETE FROM large_pg_notifications WHERE created_at < CURRENT_TIMESTAMP - interval '30s'; + END IF; + PERFORM pg_notify( + '#{channelName table}', + payload + ); + WHEN 'DELETE' THEN + PERFORM pg_notify( + '#{channelName table}', + (json_build_object('DELETE', OLD.id)::text) + ); + WHEN 'INSERT' THEN + PERFORM pg_notify( + '#{channelName table}', + json_build_object('INSERT', NEW.id)::text + ); + END CASE; + RETURN new; + END; + $BODY$ language plpgsql; + DROP TRIGGER IF EXISTS "#{insertTriggerName}" ON "#{tableName}"; + DROP TRIGGER IF EXISTS "#{updateTriggerName}" ON "#{tableName}"; + DROP TRIGGER IF EXISTS "#{deleteTriggerName}" ON "#{tableName}"; + + + CREATE TRIGGER "#{insertTriggerName}" AFTER INSERT ON "#{tableName}" FOR EACH ROW EXECUTE PROCEDURE "#{functionName}"(); + CREATE TRIGGER "#{updateTriggerName}" AFTER UPDATE ON "#{tableName}" FOR EACH ROW EXECUTE PROCEDURE "#{functionName}"(); + CREATE TRIGGER "#{deleteTriggerName}" AFTER DELETE ON "#{tableName}" FOR EACH ROW EXECUTE PROCEDURE "#{functionName}"(); + EXCEPTION + WHEN duplicate_function THEN + null; + + IF NOT EXISTS ( + SELECT FROM pg_catalog.pg_class c + JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace + WHERE c.relname = 'large_pg_notifications' + AND n.nspname = 'public' + ) THEN + CREATE UNLOGGED TABLE large_pg_notifications ( + id UUID DEFAULT uuid_generate_v4() PRIMARY KEY NOT NULL, + payload TEXT DEFAULT NULL, + created_at TIMESTAMP WITH TIME ZONE DEFAULT now() NOT NULL + ); + CREATE INDEX large_pg_notifications_created_at_index ON large_pg_notifications (created_at); + END IF; + END; $$ +|] + + where + tableName = table.tableName + + functionName = "notify_did_change_" <> tableName + insertTriggerName = "did_insert_" <> tableName + updateTriggerName = "did_update_" <> tableName + deleteTriggerName = "did_delete_" <> tableName + +installTableChangeTriggers :: (?modelContext :: ModelContext) => RLS.TableWithRLS -> IO () +installTableChangeTriggers tableNameRLS = do + withoutQueryLogging -- This spams the log way to much + (sqlExec (createNotificationFunction tableNameRLS) ()) + pure () + +makeCachedInstallTableChangeTriggers :: (?modelContext :: ModelContext) => IO (RLS.TableWithRLS -> IO ()) +makeCachedInstallTableChangeTriggers = do + tables <- newIORef Set.empty + pure \tableName -> do + triggersInstalled <- Set.member tableName <$> readIORef tables + + unless triggersInstalled do + installTableChangeTriggers tableName + modifyIORef' tables (Set.insert tableName) + +-- | Returns the event name of the event that the pg notify trigger dispatches +channelName :: RLS.TableWithRLS -> ByteString +channelName table = "did_change_" <> (cs $ table.tableName) + + +instance FromJSON ChangeNotification where + parseJSON = withObject "ChangeNotification" $ \values -> insert values <|> update values <|> delete values + where + insert values = do + id <- values .: "INSERT" + pure DidInsert { id } + update values = do + id <- values .: "UPDATE" + changeSet <- values .: "CHANGESET" + pure $ DidUpdate id changeSet + delete values = DidDelete <$> values .: "DELETE" + +instance FromJSON ChangeSet where + parseJSON array@(Array v) = do + changeSet <- parseJSON array + pure InlineChangeSet { changeSet } + parseJSON (String id) = do + case UUID.fromText id of + Just largePgNotificationId -> pure ExternalChangeSet { largePgNotificationId } + Nothing -> fail "Invalid UUID" + +instance FromJSON Change where + parseJSON = withObject "Change" $ \values -> do + col <- values .: "col" + new <- values .: "new" + pure Change { .. } +-- | The @pg_notify@ function has a payload limit of 8000 bytes. When a record update is larger than the payload size +-- we store the patch in the @large_pg_notifications@ table and pass over the id to the patch. +-- +-- This function retrieves the patch from the @large_pg_notifications@ table, or directly returns the patch +-- when it's less than 8000 bytes. +retrieveChanges :: (?modelContext :: ModelContext) => ChangeSet -> IO [Change] +retrieveChanges InlineChangeSet { changeSet } = pure changeSet +retrieveChanges ExternalChangeSet { largePgNotificationId } = do + (payload :: ByteString) <- sqlQueryScalar "SELECT payload FROM large_pg_notifications WHERE id = ? LIMIT 1" (PG.Only largePgNotificationId) + case eitherDecodeStrict' payload of + Left e -> fail e + Right result -> pure result + +$(deriveToJSON defaultOptions 'Change) +$(deriveToJSON defaultOptions 'InlineChangeSet) +$(deriveToJSON defaultOptions 'DidInsert) diff --git a/IHP/DataSync/Controller.hs b/IHP/DataSync/Controller.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/Controller.hs @@ -0,0 +1,26 @@ +{-# LANGUAGE UndecidableInstances #-} +module IHP.DataSync.Controller where + +import IHP.ControllerPrelude hiding (OrderByClause) + +import IHP.DataSync.Types +import IHP.DataSync.RowLevelSecurity +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified IHP.DataSync.ChangeNotifications as ChangeNotifications +import IHP.DataSync.ControllerImpl (runDataSyncController, cleanupAllSubscriptions) +import IHP.DataSync.DynamicQueryCompiler (camelCaseRenamer) + +instance ( + PG.ToField (PrimaryKey (GetTableName CurrentUserRecord)) + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + ) => WSApp DataSyncController where + initialState = DataSyncController + + run = do + ensureRLSEnabled <- makeCachedEnsureRLSEnabled + installTableChangeTriggers <- ChangeNotifications.makeCachedInstallTableChangeTriggers + runDataSyncController ensureRLSEnabled installTableChangeTriggers (receiveData @ByteString) sendJSON (\_ _ -> pure ()) (\_ -> camelCaseRenamer) + onClose = cleanupAllSubscriptions diff --git a/IHP/DataSync/ControllerImpl.hs b/IHP/DataSync/ControllerImpl.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/ControllerImpl.hs @@ -0,0 +1,533 @@ +{-# LANGUAGE UndecidableInstances #-} +module IHP.DataSync.ControllerImpl where + +import IHP.ControllerPrelude hiding (OrderByClause) +import qualified Control.Exception.Safe as Exception +import qualified IHP.Log as Log +import qualified Data.Aeson as Aeson +import qualified Data.Aeson.Key as Aeson + +import Data.Aeson.TH +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Data.HashMap.Strict as HashMap +import qualified Data.UUID.V4 as UUID +import qualified Control.Concurrent.MVar as MVar +import IHP.DataSync.Types +import IHP.DataSync.RowLevelSecurity +import IHP.DataSync.DynamicQuery +import IHP.DataSync.DynamicQueryCompiler +import qualified IHP.DataSync.ChangeNotifications as ChangeNotifications +import IHP.DataSync.REST.Controller (aesonValueToPostgresValue) +import qualified Data.ByteString.Char8 as ByteString +import qualified IHP.PGListener as PGListener +import IHP.ApplicationContext +import qualified Data.Set as Set +import qualified Data.Pool as Pool + + +$(deriveFromJSON defaultOptions ''DataSyncMessage) +$(deriveToJSON defaultOptions 'DataSyncResult) + +type EnsureRLSEnabledFn = Text -> IO TableWithRLS +type InstallTableChangeTriggerFn = TableWithRLS -> IO () +type SendJSONFn = DataSyncResponse -> IO () +type HandleCustomMessageFn = (DataSyncResponse -> IO ()) -> DataSyncMessage -> IO () + +runDataSyncController :: + ( HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , ?applicationContext :: ApplicationContext + , ?context :: ControllerContext + , ?modelContext :: ModelContext + , ?state :: IORef DataSyncController + , PG.ToField (PrimaryKey (GetTableName CurrentUserRecord)) + , Typeable CurrentUserRecord + , HasNewSessionUrl CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + ) => EnsureRLSEnabledFn -> InstallTableChangeTriggerFn -> IO ByteString -> SendJSONFn -> HandleCustomMessageFn -> (Text -> Renamer) -> IO () +runDataSyncController ensureRLSEnabled installTableChangeTriggers receiveData sendJSON handleCustomMessage renamer = do + setState DataSyncReady { subscriptions = HashMap.empty, transactions = HashMap.empty, asyncs = [] } + + let handleMessage :: DataSyncMessage -> IO () = buildMessageHandler ensureRLSEnabled installTableChangeTriggers sendJSON handleCustomMessage renamer + + forever do + message <- Aeson.eitherDecodeStrict' <$> receiveData + + case message of + Right decodedMessage -> do + let requestId = decodedMessage.requestId + + Exception.mask \restore -> do + -- Handle the messages in an async way + -- This increases throughput as multiple queries can be fetched + -- in parallel + handlerProcess <- async $ restore do + result <- Exception.try (handleMessage decodedMessage) + + case result of + Left (e :: Exception.SomeException) -> do + let errorMessage = case fromException e of + Just (enhancedSqlError :: EnhancedSqlError) -> cs (enhancedSqlError.sqlError.sqlErrorMsg) + Nothing -> cs (displayException e) + Log.error (tshow e) + sendJSON DataSyncError { requestId, errorMessage } + Right result -> pure () + + atomicModifyIORef'' ?state (\state -> state |> modify #asyncs (handlerProcess:)) + pure () + Left errorMessage -> sendJSON FailedToDecodeMessageError { errorMessage = cs errorMessage } +{-# INLINE runDataSyncController #-} + + +buildMessageHandler :: + ( HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , ?applicationContext :: ApplicationContext + , ?context :: ControllerContext + , ?modelContext :: ModelContext + , ?state :: IORef DataSyncController + , PG.ToField (PrimaryKey (GetTableName CurrentUserRecord)) + , Typeable CurrentUserRecord + , HasNewSessionUrl CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + ) + => EnsureRLSEnabledFn -> InstallTableChangeTriggerFn -> SendJSONFn -> HandleCustomMessageFn -> (Text -> Renamer) -> (DataSyncMessage -> IO ()) +buildMessageHandler ensureRLSEnabled installTableChangeTriggers sendJSON handleCustomMessage renamer = handleMessage + where + pgListener = ?applicationContext.pgListener + handleMessage :: DataSyncMessage -> IO () + handleMessage DataSyncQuery { query, requestId, transactionId } = do + ensureRLSEnabled (query.table) + + let (theQuery, theParams) = compileQueryWithRenamer (renamer query.table) query + + rawResult :: [[Field]] <- sqlQueryWithRLSAndTransactionId transactionId theQuery theParams + let result = map (map (renameField (renamer query.table))) rawResult + + sendJSON DataSyncResult { result, requestId } + + handleMessage CreateDataSubscription { query, requestId } = do + ensureBelowSubscriptionsLimit + + tableNameRLS <- ensureRLSEnabled (query.table) + + subscriptionId <- UUID.nextRandom + + -- Allocate the close handle as early as possible + -- to make DeleteDataSubscription calls succeed even when the DataSubscription is + -- not fully set up yet + close <- MVar.newEmptyMVar + atomicModifyIORef'' ?state (\state -> state |> modify #subscriptions (HashMap.insert subscriptionId close)) + + let (theQuery, theParams) = compileQueryWithRenamer (renamer query.table) query + + rawResult :: [[Field]] <- sqlQueryWithRLS theQuery theParams + let result = map (map (renameField (renamer query.table))) rawResult + + let tableName = query.table + + -- We need to keep track of all the ids of entities we're watching to make + -- sure that we only send update notifications to clients that can actually + -- access the record (e.g. if a RLS policy denies access) + let watchedRecordIds = recordIds rawResult + + -- Store it in IORef as an INSERT requires us to add an id + watchedRecordIdsRef <- newIORef (Set.fromList watchedRecordIds) + + -- Make sure the database triggers are there + installTableChangeTriggers tableNameRLS + + let callback notification = case notification of + ChangeNotifications.DidInsert { id } -> do + -- The new record could not be accessible to the current user with a RLS policy + -- E.g. it could be a new record in a 'projects' table, but the project belongs + -- to a different user, and thus the current user should not be able to see it. + -- + -- The new record could also be not part of the WHERE condition of the initial query. + -- Therefore we need to use the subscriptions WHERE condition to fetch the new record here. + -- + -- To honor the RLS policies we therefore need to fetch the record as the current user + -- If the result set is empty, we know the record is not accesible to us + newRecord :: [[Field]] <- sqlQueryWithRLS ("SELECT * FROM (" <> theQuery <> ") AS records WHERE records.id = ? LIMIT 1") (theParams <> [PG.toField id]) + + case headMay newRecord of + Just rawRecord -> do + -- Add the new record to 'watchedRecordIdsRef' + -- Otherwise the updates and deletes will not be dispatched to the client + modifyIORef' watchedRecordIdsRef (Set.insert id) + + let record = map (renameField (renamer tableName)) rawRecord + sendJSON DidInsert { subscriptionId, record } + Nothing -> pure () + ChangeNotifications.DidUpdate { id, changeSet } -> do + -- Only send the notifcation if the deleted record was part of the initial + -- results set + isWatchingRecord <- Set.member id <$> readIORef watchedRecordIdsRef + when isWatchingRecord do + -- The updated record could not be part of the query result set anymore + -- E.g. if it's not matched anymore by the WHERE condition after the update + [(PG.Only isRecordInResultSet)] <- sqlQueryWithRLS ("SELECT EXISTS(SELECT * FROM (" <> theQuery <> ") AS records WHERE records.id = ? LIMIT 1)") (theParams <> [PG.toField id]) + + changes <- ChangeNotifications.retrieveChanges changeSet + if isRecordInResultSet + then sendJSON DidUpdate { subscriptionId, id, changeSet = changesToValue (renamer tableName) changes } + else sendJSON DidDelete { subscriptionId, id } + ChangeNotifications.DidDelete { id } -> do + -- Only send the notifcation if the deleted record was part of the initial + -- results set + isWatchingRecord <- Set.member id <$> readIORef watchedRecordIdsRef + when isWatchingRecord do + sendJSON DidDelete { subscriptionId, id } + + let subscribe = PGListener.subscribeJSON (ChangeNotifications.channelName tableNameRLS) callback pgListener + let unsubscribe subscription = PGListener.unsubscribe subscription pgListener + + Exception.bracket subscribe unsubscribe \channelSubscription -> do + sendJSON DidCreateDataSubscription { subscriptionId, requestId, result } + + MVar.takeMVar close + + handleMessage CreateCountSubscription { query, requestId } = do + ensureBelowSubscriptionsLimit + + tableNameRLS <- ensureRLSEnabled query.table + + subscriptionId <- UUID.nextRandom + + -- Allocate the close handle as early as possible + -- to make DeleteDataSubscription calls succeed even when the CountSubscription is + -- not fully set up yet + close <- MVar.newEmptyMVar + atomicModifyIORef'' ?state (\state -> state |> modify #subscriptions (HashMap.insert subscriptionId close)) + + let (theQuery, theParams) = compileQueryWithRenamer (renamer query.table) query + + let countQuery = "SELECT COUNT(*) FROM (" <> theQuery <> ") AS _inner" + + let + unpackResult :: [(Only Int)] -> Int + unpackResult [(Only value)] = value + unpackResult otherwise = error "DataSync.unpackResult: Expected INT, but got something else" + + count <- unpackResult <$> sqlQueryWithRLS countQuery theParams + countRef <- newIORef count + + installTableChangeTriggers tableNameRLS + + let + callback :: ChangeNotifications.ChangeNotification -> IO () + callback _ = do + newCount <- unpackResult <$> sqlQueryWithRLS countQuery theParams + lastCount <- readIORef countRef + + when (newCount /= count) (sendJSON DidChangeCount { subscriptionId, count = newCount }) + + let subscribe = PGListener.subscribeJSON (ChangeNotifications.channelName tableNameRLS) callback pgListener + let unsubscribe subscription = PGListener.unsubscribe subscription pgListener + + Exception.bracket subscribe unsubscribe \channelSubscription -> do + sendJSON DidCreateCountSubscription { subscriptionId, requestId, count } + + MVar.takeMVar close + + handleMessage DeleteDataSubscription { requestId, subscriptionId } = do + DataSyncReady { subscriptions } <- getState + case HashMap.lookup subscriptionId subscriptions of + Just closeSignalMVar -> do + -- Cancel table watcher + MVar.putMVar closeSignalMVar () + + atomicModifyIORef'' ?state (\state -> state |> modify #subscriptions (HashMap.delete subscriptionId)) + + sendJSON DidDeleteDataSubscription { subscriptionId, requestId } + Nothing -> error ("Failed to delete DataSubscription, could not find DataSubscription with id " <> tshow subscriptionId) + + handleMessage CreateRecordMessage { table, record, requestId, transactionId } = do + ensureRLSEnabled table + + let query = "INSERT INTO ? ? VALUES ? RETURNING *" + let columns = record + |> HashMap.keys + |> map (renamer table).fieldToColumn + + let values = record + |> HashMap.elems + |> map aesonValueToPostgresValue + + let params = (PG.Identifier table, PG.In (map PG.Identifier columns), PG.In values) + + result :: [[Field]] <- sqlQueryWithRLSAndTransactionId transactionId query params + + case result of + [rawRecord] -> + let + record = map (renameField (renamer table)) rawRecord + in + sendJSON DidCreateRecord { requestId, record } + otherwise -> error "Unexpected result in CreateRecordMessage handler" + + pure () + + handleMessage CreateRecordsMessage { table, records, requestId, transactionId } = do + ensureRLSEnabled table + + let query = "INSERT INTO ? ? ? RETURNING *" + let columns = records + |> head + |> \case + Just value -> value + Nothing -> error "Atleast one record is required" + |> HashMap.keys + |> map (renamer table).fieldToColumn + + let values = records + |> map (\object -> + object + |> HashMap.elems + |> map aesonValueToPostgresValue + ) + + + let params = (PG.Identifier table, PG.In (map PG.Identifier columns), PG.Values [] values) + + rawRecords :: [[Field]] <- sqlQueryWithRLSAndTransactionId transactionId query params + let records = map (map (renameField (renamer table))) rawRecords + + sendJSON DidCreateRecords { requestId, records } + + pure () + + handleMessage UpdateRecordMessage { table, id, patch, requestId, transactionId } = do + ensureRLSEnabled table + + let columns = patch + |> HashMap.keys + |> map (renamer table).fieldToColumn + |> map PG.Identifier + + let values = patch + |> HashMap.elems + |> map aesonValueToPostgresValue + + let keyValues = zip columns values + + let setCalls = keyValues + |> map (\_ -> "? = ?") + |> ByteString.intercalate ", " + let query = "UPDATE ? SET " <> setCalls <> " WHERE id = ? RETURNING *" + + let params = [PG.toField (PG.Identifier table)] + <> (join (map (\(key, value) -> [PG.toField key, value]) keyValues)) + <> [PG.toField id] + + result :: [[Field]] <- sqlQueryWithRLSAndTransactionId transactionId (PG.Query query) params + + case result of + [rawRecord] -> + let + record = map (renameField (renamer table)) rawRecord + in + sendJSON DidUpdateRecord { requestId, record } + otherwise -> error "Could not apply the update to the given record. Are you sure the record ID you passed is correct? If the record ID is correct, likely the row level security policy is not making the record visible to the UPDATE operation." + + pure () + + handleMessage UpdateRecordsMessage { table, ids, patch, requestId, transactionId } = do + ensureRLSEnabled table + + let columns = patch + |> HashMap.keys + |> map (renamer table).fieldToColumn + |> map PG.Identifier + + let values = patch + |> HashMap.elems + |> map aesonValueToPostgresValue + + let keyValues = zip columns values + + let setCalls = keyValues + |> map (\_ -> "? = ?") + |> ByteString.intercalate ", " + let query = "UPDATE ? SET " <> setCalls <> " WHERE id IN ? RETURNING *" + + let params = [PG.toField (PG.Identifier table)] + <> (join (map (\(key, value) -> [PG.toField key, value]) keyValues)) + <> [PG.toField (PG.In ids)] + + rawRecords <- sqlQueryWithRLSAndTransactionId transactionId (PG.Query query) params + let records = map (map (renameField (renamer table))) rawRecords + + sendJSON DidUpdateRecords { requestId, records } + + pure () + + handleMessage DeleteRecordMessage { table, id, requestId, transactionId } = do + ensureRLSEnabled table + + sqlExecWithRLSAndTransactionId transactionId "DELETE FROM ? WHERE id = ?" (PG.Identifier table, id) + + sendJSON DidDeleteRecord { requestId } + + handleMessage DeleteRecordsMessage { table, ids, requestId, transactionId } = do + ensureRLSEnabled table + + sqlExecWithRLSAndTransactionId transactionId "DELETE FROM ? WHERE id IN ?" (PG.Identifier table, PG.In ids) + + sendJSON DidDeleteRecords { requestId } + + handleMessage StartTransaction { requestId } = do + ensureBelowTransactionLimit + + transactionId <- UUID.nextRandom + + + let takeConnection = ?modelContext.connectionPool + |> Pool.takeResource + + let releaseConnection (connection, localPool) = do + PG.execute connection "ROLLBACK" () -- Make sure there's no pending transaction in case something went wrong + Pool.putResource localPool connection + + Exception.bracket takeConnection releaseConnection \(connection, localPool) -> do + transactionSignal <- MVar.newEmptyMVar + + let globalModelContext = ?modelContext + let ?modelContext = globalModelContext { transactionConnection = Just connection } in sqlExecWithRLS "BEGIN" () + + let transaction = DataSyncTransaction + { id = transactionId + , connection + , close = transactionSignal + } + + atomicModifyIORef'' ?state (\state -> state |> modify #transactions (HashMap.insert transactionId transaction)) + + sendJSON DidStartTransaction { requestId, transactionId } + + MVar.takeMVar transactionSignal + + atomicModifyIORef'' ?state (\state -> state |> modify #transactions (HashMap.delete transactionId)) + + handleMessage RollbackTransaction { requestId, id } = do + DataSyncTransaction { id, close } <- findTransactionById id + + sqlExecWithRLSAndTransactionId (Just id) "ROLLBACK" () + MVar.putMVar close () + + sendJSON DidRollbackTransaction { requestId, transactionId = id } + + handleMessage CommitTransaction { requestId, id } = do + DataSyncTransaction { id, close } <- findTransactionById id + + sqlExecWithRLSAndTransactionId (Just id) "COMMIT" () + MVar.putMVar close () + + sendJSON DidCommitTransaction { requestId, transactionId = id } + + handleMessage otherwise = handleCustomMessage sendJSON otherwise + +cleanupAllSubscriptions :: (?state :: IORef DataSyncController, ?applicationContext :: ApplicationContext) => IO () +cleanupAllSubscriptions = do + state <- getState + let pgListener = ?applicationContext.pgListener + + case state of + DataSyncReady { asyncs } -> forEach asyncs uninterruptibleCancel + _ -> pure () + +changesToValue :: Renamer -> [ChangeNotifications.Change] -> Value +changesToValue renamer changes = object (map changeToPair changes) + where + changeToPair ChangeNotifications.Change { col, new } = (Aeson.fromText $ renamer.columnToField col) .= new + +runInModelContextWithTransaction :: (?state :: IORef DataSyncController, ?modelContext :: ModelContext) => ((?modelContext :: ModelContext) => IO result) -> Maybe UUID -> IO result +runInModelContextWithTransaction function (Just transactionId) = do + let globalModelContext = ?modelContext + + DataSyncTransaction { connection } <- findTransactionById transactionId + let + ?modelContext = globalModelContext { transactionConnection = Just connection } + in + function +runInModelContextWithTransaction function Nothing = function + +findTransactionById :: (?state :: IORef DataSyncController) => UUID -> IO DataSyncTransaction +findTransactionById transactionId = do + transactions <- (.transactions) <$> readIORef ?state + case HashMap.lookup transactionId transactions of + Just transaction -> pure transaction + Nothing -> error "No transaction with that id" + +-- | Allow max 10 concurrent transactions per connection to avoid running out of database connections +-- +-- Each transaction removes a database connection from the connection pool. If we don't limit the transactions, +-- a single user could take down the application by starting more than 'IHP.FrameworkConfig.DBPoolMaxConnections' +-- concurrent transactions. Then all database connections are removed from the connection pool and further database +-- queries for other users will fail. +-- +ensureBelowTransactionLimit :: (?state :: IORef DataSyncController, ?context :: ControllerContext) => IO () +ensureBelowTransactionLimit = do + transactions <- (.transactions) <$> readIORef ?state + let transactionCount = HashMap.size transactions + when (transactionCount >= maxTransactionsPerConnection) do + error ("You've reached the transaction limit of " <> tshow maxTransactionsPerConnection <> " transactions") + +ensureBelowSubscriptionsLimit :: (?state :: IORef DataSyncController, ?context :: ControllerContext) => IO () +ensureBelowSubscriptionsLimit = do + subscriptions <- (.subscriptions) <$> readIORef ?state + let subscriptionsCount = HashMap.size subscriptions + when (subscriptionsCount >= maxSubscriptionsPerConnection) do + error ("You've reached the subscriptions limit of " <> tshow maxSubscriptionsPerConnection <> " subscriptions") + +maxTransactionsPerConnection :: (?context :: ControllerContext) => Int +maxTransactionsPerConnection = + case getAppConfig @DataSyncMaxTransactionsPerConnection of + DataSyncMaxTransactionsPerConnection value -> value + +maxSubscriptionsPerConnection :: (?context :: ControllerContext) => Int +maxSubscriptionsPerConnection = + case getAppConfig @DataSyncMaxSubscriptionsPerConnection of + DataSyncMaxSubscriptionsPerConnection value -> value + +sqlQueryWithRLSAndTransactionId :: + ( ?modelContext :: ModelContext + , PG.ToRow parameters + , ?context :: ControllerContext + , userId ~ Id CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , ?context :: ControllerContext + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , PG.ToField userId + , FromRow result + , ?state :: IORef DataSyncController + ) => Maybe UUID -> PG.Query -> parameters -> IO [result] +sqlQueryWithRLSAndTransactionId transactionId theQuery theParams = runInModelContextWithTransaction (sqlQueryWithRLS theQuery theParams) transactionId + +sqlExecWithRLSAndTransactionId :: + ( ?modelContext :: ModelContext + , PG.ToRow parameters + , ?context :: ControllerContext + , userId ~ Id CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , ?context :: ControllerContext + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , PG.ToField userId + , ?state :: IORef DataSyncController + ) => Maybe UUID -> PG.Query -> parameters -> IO Int64 +sqlExecWithRLSAndTransactionId transactionId theQuery theParams = runInModelContextWithTransaction (sqlExecWithRLS theQuery theParams) transactionId + +instance SetField "subscriptions" DataSyncController (HashMap UUID (MVar.MVar ())) where + setField subscriptions record = record { subscriptions } + +instance SetField "transactions" DataSyncController (HashMap UUID DataSyncTransaction) where + setField transactions record = record { transactions } + +instance SetField "asyncs" DataSyncController [Async ()] where + setField asyncs record = record { asyncs } + +atomicModifyIORef'' ref updateFn = atomicModifyIORef' ref (\value -> (updateFn value, ())) diff --git a/IHP/DataSync/DynamicQuery.hs b/IHP/DataSync/DynamicQuery.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/DynamicQuery.hs @@ -0,0 +1,221 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-| +Module: IHP.DataSync.DynamicQuery +Description: The normal IHP query functionality is type-safe. This module provides type-unsafe access to the database. +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.DataSync.DynamicQuery where + +import IHP.ControllerPrelude hiding (OrderByClause) +import Data.Aeson +import qualified Database.PostgreSQL.Simple.FromField as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified IHP.QueryBuilder as QueryBuilder +import Data.Aeson.TH +import qualified GHC.Generics +import qualified Control.DeepSeq as DeepSeq +import qualified Data.Aeson.KeyMap as Aeson +import qualified Data.Aeson.Key as Aeson + +data Field = Field { fieldName :: Text, fieldValue :: DynamicValue } + +data DynamicValue + = IntValue !Int + | DoubleValue !Double + | TextValue !Text + | BoolValue !Bool + | UUIDValue !UUID + | DateTimeValue !UTCTime + | PointValue !Point + | IntervalValue !PGInterval + | ArrayValue ![DynamicValue] + | Null + deriving (Show, Eq) + +newtype UndecodedJSON = UndecodedJSON ByteString + deriving (Show, Eq) + +-- | Similiar to IHP.QueryBuilder.SQLQuery, but is designed to be accessed by external users +-- +-- When compiling to SQL we have to be extra careful to escape all identifers and variables in the query. +-- The normal IHP.QueryBuilder doesn't need to be that careful as parts of the input are derived from +-- generated code from the Schema.sql. +-- +data DynamicSQLQuery = DynamicSQLQuery + { table :: !Text + , selectedColumns :: SelectedColumns + , whereCondition :: !(Maybe ConditionExpression) + , orderByClause :: ![OrderByClause] + , distinctOnColumn :: !(Maybe ByteString) + , limit :: !(Maybe Int) + , offset :: !(Maybe Int) + } deriving (Show, Eq) + +data OrderByClause + = OrderByClause + { orderByColumn :: !ByteString + , orderByDirection :: !OrderByDirection } + | OrderByTSRank { tsvector :: Text, tsquery :: !Text } + deriving (Show, Eq, GHC.Generics.Generic, DeepSeq.NFData) + +-- | Represents a WHERE conditions of a 'DynamicSQLQuery' +data ConditionExpression + = ColumnExpression { field :: !Text } + | InfixOperatorExpression + { left :: !ConditionExpression + , op :: !ConditionOperator + , right :: !ConditionExpression + } + | LiteralExpression { value :: !DynamicValue } + | CallExpression { functionCall :: !FunctionCall } + | ListExpression { values :: ![DynamicValue] } + deriving (Show, Eq) + +data FunctionCall + = ToTSQuery { text :: !Text } -- ^ to_tsquery('english', text) + deriving (Show, Eq, GHC.Generics.Generic, DeepSeq.NFData) + +-- | Operators available in WHERE conditions +data ConditionOperator + = OpEqual -- ^ a = b + | OpGreaterThan -- ^ a > b + | OpLessThan -- ^ a < b + | OpGreaterThanOrEqual -- ^ a >= b + | OpLessThanOrEqual -- ^ a <= b + | OpNotEqual -- ^ a <> b + | OpAnd -- ^ a AND b + | OpOr -- ^ a OR b + | OpIs -- ^ a IS b + | OpIsNot -- ^ a IS NOT b + | OpTSMatch -- ^ tsvec_a @@ tsvec_b + | OpIn -- ^ a IN b + deriving (Show, Eq) + +data SelectedColumns + = SelectAll -- ^ SELECT * FROM table + | SelectSpecific [Text] -- ^ SELECT a, b, c FROM table + deriving (Show, Eq) + +instance FromJSON ByteString where + parseJSON (String v) = pure $ cs v + +instance FromJSON PG.Action where + parseJSON (String v) = pure (PG.Escape (cs v)) + +instance {-# OVERLAPS #-} ToJSON [Field] where + toJSON fields = object (map (\Field { fieldName, fieldValue } -> (cs fieldName) .= (toJSON fieldValue)) fields) + toEncoding fields = pairs $ foldl' (<>) mempty encodedFields + where + encodedFields = (map (\Field { fieldName, fieldValue } -> (cs fieldName) .= (toJSON fieldValue)) fields) + +instance ToJSON DynamicValue where + toJSON (IntValue value) = toJSON value + toJSON (DoubleValue value) = toJSON value + toJSON (TextValue value) = toJSON value + toJSON (BoolValue value) = toJSON value + toJSON (UUIDValue value) = toJSON value + toJSON (DateTimeValue value) = toJSON value + toJSON (PointValue value) = toJSON value + toJSON (IntervalValue value) = toJSON value + toJSON (ArrayValue value) = toJSON value + toJSON IHP.DataSync.DynamicQuery.Null = toJSON Data.Aeson.Null + +instance PG.FromField Field where + fromField field fieldValue' = do + fieldValue <- PG.fromField field fieldValue' + pure Field { .. } + where + fieldName = (PG.name field) + |> fmap cs + |> fromMaybe "" + +instance PG.FromField DynamicValue where + fromField field fieldValue' = fieldValue + where + fieldValue = + (IntValue <$> PG.fromField field fieldValue') + <|> (TextValue <$> PG.fromField field fieldValue') + <|> (BoolValue <$> PG.fromField field fieldValue') + <|> (UUIDValue <$> PG.fromField field fieldValue') + <|> (DoubleValue <$> PG.fromField field fieldValue') + <|> (DateTimeValue <$> PG.fromField field fieldValue') + <|> (PointValue <$> PG.fromField field fieldValue') + <|> (IntervalValue <$> PG.fromField field fieldValue') + <|> (ArrayValue <$> PG.fromField field fieldValue') + <|> (PG.fromField @PG.Null field fieldValue' >> pure IHP.DataSync.DynamicQuery.Null) + <|> fromFieldCustomEnum field fieldValue' + + fromFieldCustomEnum field (Just value) = pure (TextValue (cs value)) + fromFieldCustomEnum field Nothing = pure IHP.DataSync.DynamicQuery.Null + +instance PG.FromField UndecodedJSON where + fromField field (Just value) = pure (UndecodedJSON value) + fromField field Nothing = pure (UndecodedJSON "null") + +-- | Returns a list of all id's in a result +recordIds :: [[Field]] -> [UUID] +recordIds result = result + |> concat + |> filter (\Field { fieldName } -> fieldName == "id") + |> map (.fieldValue) + |> mapMaybe \case + UUIDValue uuid -> Just uuid + otherwise -> Nothing + + + +-- Here you can add functions which are available in all your controllers + +-- | Transforms the keys of a JSON object from field name to column name +-- +-- >>> transformColumnNamesToFieldNames [json|{"isCompleted": true}|] +-- [json|{"is_completed": true}|] +transformColumnNamesToFieldNames :: Value -> Value +transformColumnNamesToFieldNames (Object hashMap) = + hashMap + |> Aeson.toList + |> map (\(key, value) -> (applyKey columnNameToFieldName key, value)) + |> Aeson.fromList + |> Object + where + applyKey function key = + key + |> Aeson.toText + |> function + |> Aeson.fromText + + +$(deriveFromJSON defaultOptions ''FunctionCall) +$(deriveFromJSON defaultOptions 'QueryBuilder.OrCondition) +$(deriveFromJSON defaultOptions 'QueryBuilder.Join) +$(deriveFromJSON defaultOptions ''QueryBuilder.OrderByDirection) +$(deriveFromJSON defaultOptions 'QueryBuilder.OrderByClause) +$(deriveFromJSON defaultOptions 'SelectAll) +$(deriveFromJSON defaultOptions ''ConditionOperator) +$(deriveFromJSON defaultOptions ''DynamicValue) +$(deriveFromJSON defaultOptions ''ConditionExpression) + +instance FromJSON DynamicSQLQuery where + parseJSON = withObject "DynamicSQLQuery" $ \v -> DynamicSQLQuery + <$> v .: "table" + <*> v .: "selectedColumns" + <*> v .: "whereCondition" + <*> v .: "orderByClause" + <*> v .:? "distinctOnColumn" -- distinctOnColumn can be absent in older versions of ihp-datasync.js + <*> v .:? "limit" -- Limit can be absent in older versions of ihp-datasync.js + <*> v .:? "offset" -- Offset can be absent in older versions of ihp-datasync.js + + +instance FromJSON OrderByClause where + parseJSON = withObject "OrderByClause" $ \v -> do + let oldFormat = OrderByClause + <$> v .: "orderByColumn" + <*> v .: "orderByDirection" + let tagged = do + tag <- v .: "tag" + case tag of + "OrderByClause" -> oldFormat + "OrderByTSRank" -> OrderByTSRank <$> v .: "tsvector" <*> v .: "tsquery" + otherwise -> error ("Invalid tag: " <> otherwise) + tagged <|> oldFormat diff --git a/IHP/DataSync/DynamicQueryCompiler.hs b/IHP/DataSync/DynamicQueryCompiler.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/DynamicQueryCompiler.hs @@ -0,0 +1,190 @@ +{-| +Module: IHP.DataSync.DynamicQueryCompiler +Description: Compiles a DynamicQuery to SQL +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.DataSync.DynamicQueryCompiler where + +import IHP.Prelude +import IHP.DataSync.DynamicQuery +import qualified IHP.QueryBuilder as QueryBuilder +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Data.List as List + +data Renamer = Renamer + { fieldToColumn :: Text -> Text + , columnToField :: Text -> Text + } + +compileQuery :: DynamicSQLQuery -> (PG.Query, [PG.Action]) +compileQuery = compileQueryWithRenamer camelCaseRenamer + +compileQueryWithRenamer :: Renamer -> DynamicSQLQuery -> (PG.Query, [PG.Action]) +compileQueryWithRenamer renamer query = compileQueryMapped (mapColumnNames renamer.fieldToColumn query) + +-- | Default renamer used by DataSync. +-- +-- Transforms JS inputs in @camelCase@ to snake_case for the database +-- and DB outputs in @snake_case@ back to @camelCase@ +camelCaseRenamer :: Renamer +camelCaseRenamer = + Renamer + { fieldToColumn = fieldNameToColumnName + , columnToField = columnNameToFieldName + } + +-- | Renamer that does not modify the column names +unmodifiedRenamer :: Renamer +unmodifiedRenamer = + Renamer + { fieldToColumn = id + , columnToField = id + } + +-- | When a Field is retrieved from the database, it's all in @snake_case@. This turns it into @camelCase@ +renameField :: Renamer -> Field -> Field +renameField renamer field = + field { fieldName = renamer.columnToField field.fieldName } + +compileQueryMapped :: DynamicSQLQuery -> (PG.Query, [PG.Action]) +compileQueryMapped DynamicSQLQuery { .. } = (sql, args) + where + sql = "SELECT" <> distinctOnSql <> "? FROM ?" <> whereSql <> orderBySql <> limitSql <> offsetSql + args = distinctOnArgs + <> catMaybes + [ Just (compileSelectedColumns selectedColumns) + , Just (PG.toField (PG.Identifier table)) + ] + <> whereArgs + <> orderByArgs + <> limitArgs + <> offsetArgs + + (distinctOnSql, distinctOnArgs) = case distinctOnColumn of + Just column -> (" DISTINCT ON (?) ", [PG.toField $ PG.Identifier (cs column)]) + Nothing -> (" ", []) + + (orderBySql, orderByArgs) = case orderByClause of + [] -> ("", []) + orderByClauses -> + ( PG.Query $ cs $ " ORDER BY " <> (intercalate ", " (map compileOrderByClause orderByClauses)) + , orderByClauses + |> map (\case + OrderByClause { orderByColumn, orderByDirection } -> + [ PG.toField $ PG.Identifier (cs orderByColumn) + , PG.toField $ if orderByDirection == QueryBuilder.Desc + then PG.Plain "DESC" + else PG.Plain "" + ] + OrderByTSRank { tsvector, tsquery } -> + [ PG.toField $ PG.Identifier tsvector + , PG.toField tsquery + ] + ) + |> concat + ) + + (whereSql, whereArgs) = case compileCondition <$> whereCondition of + Just (sql, args) -> (" WHERE " <> sql, args) + Nothing -> ("", []) + + (limitSql, limitArgs) = case limit of + Just limit -> (" LIMIT ?", [PG.toField limit]) + Nothing -> ("", []) + + (offsetSql, offsetArgs) = case offset of + Just offset -> (" OFFSET ?", [PG.toField offset]) + Nothing -> ("", []) + +-- | Used to transform column names from @camelCase@ to @snake_case@ +mapColumnNames :: (Text -> Text) -> DynamicSQLQuery -> DynamicSQLQuery +mapColumnNames rename query = + query + { selectedColumns = mapSelectedColumns query.selectedColumns + , whereCondition = mapConditionExpression <$> query.whereCondition + , orderByClause = map mapOrderByClause query.orderByClause + , distinctOnColumn = (cs . rename . cs) <$> query.distinctOnColumn + } + where + mapSelectedColumns :: SelectedColumns -> SelectedColumns + mapSelectedColumns SelectAll = SelectAll + mapSelectedColumns (SelectSpecific columns) = SelectSpecific (map rename columns) + + mapConditionExpression :: ConditionExpression -> ConditionExpression + mapConditionExpression ColumnExpression { field } = ColumnExpression { field = rename field } + mapConditionExpression InfixOperatorExpression { left, op, right } = InfixOperatorExpression { left = mapConditionExpression left, op, right = mapConditionExpression right } + mapConditionExpression otherwise = otherwise + + mapOrderByClause :: OrderByClause -> OrderByClause + mapOrderByClause OrderByClause { orderByColumn, orderByDirection } = OrderByClause { orderByColumn = cs (rename (cs orderByColumn)), orderByDirection } + mapOrderByClause otherwise = otherwise + +compileOrderByClause :: OrderByClause -> Text +compileOrderByClause OrderByClause {} = "? ?" +compileOrderByClause OrderByTSRank { tsvector, tsquery } = "ts_rank(?, to_tsquery('english', ?))" + +compileSelectedColumns :: SelectedColumns -> PG.Action +compileSelectedColumns SelectAll = PG.Plain "*" +compileSelectedColumns (SelectSpecific fields) = PG.Many args + where + args :: [PG.Action] + args = List.intercalate ([PG.Plain ", "]) fieldActions + fieldActions :: [[PG.Action]] + fieldActions = (map (\field -> [ PG.toField (PG.Identifier field) ]) fields) + +-- TODO: validate query against schema + +compileCondition :: ConditionExpression -> (PG.Query, [PG.Action]) +compileCondition (ColumnExpression column) = ("?", [PG.toField $ PG.Identifier column]) +compileCondition (InfixOperatorExpression a OpEqual (LiteralExpression Null)) = compileCondition (InfixOperatorExpression a OpIs (LiteralExpression Null)) -- Turn 'a = NULL' into 'a IS NULL' +compileCondition (InfixOperatorExpression a OpNotEqual (LiteralExpression Null)) = compileCondition (InfixOperatorExpression a OpIsNot (LiteralExpression Null)) -- Turn 'a <> NULL' into 'a IS NOT NULL' +compileCondition (InfixOperatorExpression a OpIn (ListExpression { values })) | (Null `List.elem` values) = + -- Turn 'a IN (NULL)' into 'a IS NULL' + case partition ((/=) Null) values of + ([], nullValues) -> compileCondition (InfixOperatorExpression a OpIs (LiteralExpression Null)) + (nonNullValues, nullValues) -> compileCondition (InfixOperatorExpression (InfixOperatorExpression a OpIn (ListExpression { values = nonNullValues })) OpOr (InfixOperatorExpression a OpIs (LiteralExpression Null))) +compileCondition (InfixOperatorExpression a operator b) = ("(" <> queryA <> ") " <> compileOperator operator <> " " <> rightOperand, paramsA <> paramsB) + where + (queryA, paramsA) = compileCondition a + (queryB, paramsB) = compileCondition b + + rightOperand = if rightParentheses + then "(" <> queryB <> ")" + else queryB + + rightParentheses :: Bool + rightParentheses = + case b of + LiteralExpression Null -> False + ListExpression {} -> False -- The () are inserted already via @PG.In@ + _ -> True +compileCondition (LiteralExpression literal) = ("?", [PG.toField literal]) +compileCondition (CallExpression { functionCall = ToTSQuery { text } }) = ("to_tsquery('english', ?)", [PG.toField text]) +compileCondition (ListExpression { values }) = ("?", [PG.toField (PG.In values)]) + +compileOperator :: ConditionOperator -> PG.Query +compileOperator OpEqual = "=" +compileOperator OpGreaterThan = ">" +compileOperator OpLessThan = "<" +compileOperator OpGreaterThanOrEqual = ">=" +compileOperator OpLessThanOrEqual = "<=" +compileOperator OpNotEqual = "<>" +compileOperator OpAnd = "AND" +compileOperator OpOr = "OR" +compileOperator OpIs = "IS" +compileOperator OpIsNot = "IS NOT" +compileOperator OpTSMatch = "@@" +compileOperator OpIn = "IN" + +instance PG.ToField DynamicValue where + toField (IntValue int) = PG.toField int + toField (DoubleValue double) = PG.toField double + toField (TextValue text) = PG.toField text + toField (BoolValue bool) = PG.toField bool + toField (UUIDValue uuid) = PG.toField uuid + toField (DateTimeValue utcTime) = PG.toField utcTime + toField (PointValue point) = PG.toField point + toField (ArrayValue values) = PG.toField (PG.PGArray values) + toField Null = PG.toField PG.Null diff --git a/IHP/DataSync/REST/Controller.hs b/IHP/DataSync/REST/Controller.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/REST/Controller.hs @@ -0,0 +1,239 @@ +{-# LANGUAGE UndecidableInstances #-} +module IHP.DataSync.REST.Controller where + +import IHP.ControllerPrelude hiding (OrderByClause) +import IHP.DataSync.REST.Types +import Data.Aeson +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple as PG +import qualified Data.Vector as Vector +import qualified Data.ByteString.Char8 as ByteString +import qualified Control.Exception.Safe as Exception +import IHP.DataSync.RowLevelSecurity +import IHP.DataSync.DynamicQuery +import IHP.DataSync.Types +import Network.HTTP.Types (status400) +import IHP.DataSync.DynamicQueryCompiler +import qualified Data.Text as Text +import qualified Data.Scientific as Scientific + +import qualified Data.ByteString.Builder as ByteString +import qualified Data.Aeson.Encoding.Internal as Aeson +import qualified Data.Aeson.KeyMap as Aeson +import qualified Data.Aeson.Key as Aeson + + +instance ( + PG.ToField (PrimaryKey (GetTableName CurrentUserRecord)) + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + ) => Controller ApiController where + action CreateRecordAction { table } = do + ensureRLSEnabled table + + let payload = requestBodyJSON + + case payload of + Object hashMap -> do + let query = "INSERT INTO ? ? VALUES ? RETURNING *" + let columns = hashMap + |> Aeson.keys + |> map (fieldNameToColumnName . Aeson.toText) + + let values = hashMap + |> Aeson.elems + |> map aesonValueToPostgresValue + + let params = (PG.Identifier table, PG.In (map PG.Identifier columns), PG.In values) + + result :: Either EnhancedSqlError [[Field]] <- Exception.try do + sqlQueryWithRLS query params + + case result of + Left error -> renderErrorJson error + Right result -> renderJson result + + Array objects -> do + let query = "INSERT INTO ? ? ? RETURNING *" + let columns = objects + |> Vector.toList + |> head + |> \case + Just value -> value + Nothing -> error "Atleast one record is required" + |> \case + Object hashMap -> hashMap + otherwise -> error "Expected object" + |> Aeson.keys + |> map (fieldNameToColumnName . Aeson.toText) + + let values = objects + |> Vector.toList + |> map (\object -> + object + |> \case + Object hashMap -> hashMap + otherwise -> error "Expected object" + |> Aeson.elems + |> map aesonValueToPostgresValue + ) + + + let params = (PG.Identifier table, PG.In (map PG.Identifier columns), PG.Values [] values) + + result :: [[Field]] <- sqlQueryWithRLS query params + renderJson result + + + + action UpdateRecordAction { table, id } = do + ensureRLSEnabled table + + let payload = requestBodyJSON + |> \case + Object hashMap -> hashMap + + let columns = payload + |> Aeson.keys + |> map (fieldNameToColumnName . Aeson.toText) + |> map PG.Identifier + + let values = payload + |> Aeson.elems + |> map aesonValueToPostgresValue + + let keyValues = zip columns values + + let setCalls = keyValues + |> map (\_ -> "? = ?") + |> ByteString.intercalate ", " + let query = "UPDATE ? SET " <> setCalls <> " WHERE id = ? RETURNING *" + + let params = [PG.toField (PG.Identifier table)] + <> (join (map (\(key, value) -> [PG.toField key, value]) keyValues)) + <> [PG.toField id] + + result :: [[Field]] <- sqlQueryWithRLS (PG.Query query) params + + renderJson (head result) + + -- DELETE /api/:table/:id + action DeleteRecordAction { table, id } = do + ensureRLSEnabled table + + sqlExecWithRLS "DELETE FROM ? WHERE id = ?" (PG.Identifier table, id) + + renderJson True + + -- GET /api/:table/:id + action ShowRecordAction { table, id } = do + ensureRLSEnabled table + + result :: [[Field]] <- sqlQueryWithRLS "SELECT * FROM ? WHERE id = ?" (PG.Identifier table, id) + + renderJson (head result) + + -- GET /api/:table + -- GET /api/:table?orderBy=createdAt + -- GET /api/:table?fields=id,title + action ListRecordsAction { table } = do + ensureRLSEnabled table + + let (theQuery, theParams) = compileQuery (buildDynamicQueryFromRequest table) + result :: [[Field]] <- sqlQueryWithRLS theQuery theParams + + renderJson result + +buildDynamicQueryFromRequest table = DynamicSQLQuery + { table + , selectedColumns = paramOrDefault SelectAll "fields" + , whereCondition = Nothing + , orderByClause = paramList "orderBy" + , distinctOnColumn = paramOrNothing "distinctOnColumn" + , limit = paramOrNothing "limit" + , offset = paramOrNothing "offset" + } + +instance ParamReader SelectedColumns where + readParameter byteString = pure $ + byteString + |> cs + |> Text.split (\char -> char == ',') + |> SelectSpecific + +instance ParamReader OrderByClause where + readParameter byteString = case ByteString.split ',' byteString of + [orderByColumn, order] -> do + orderByDirection <- parseOrder order + pure OrderByClause { orderByColumn, orderByDirection } + [orderByColumn] -> pure OrderByClause { orderByColumn, orderByDirection = Asc } + where + parseOrder "asc" = Right Asc + parseOrder "desc" = Right Desc + parseOrder otherwise = Left ("Invalid order " <> cs otherwise) + +instance ToJSON PG.SqlError where + toJSON PG.SqlError { sqlState, sqlErrorMsg, sqlErrorDetail, sqlErrorHint } = object + [ "state" .= ((cs sqlState) :: Text) + , "errorMsg" .= ((cs sqlErrorMsg) :: Text) + , "errorDetail" .= ((cs sqlErrorDetail) :: Text) + , "errorHint" .= ((cs sqlErrorHint) :: Text) + ] + where + fieldValueToJSON (IntValue value) = toJSON value + fieldValueToJSON (TextValue value) = toJSON value + fieldValueToJSON (BoolValue value) = toJSON value + fieldValueToJSON (UUIDValue value) = toJSON value + fieldValueToJSON (DateTimeValue value) = toJSON value + +instance ToJSON EnhancedSqlError where + toJSON EnhancedSqlError { sqlError } = toJSON sqlError + +renderErrorJson :: (?context :: ControllerContext) => Data.Aeson.ToJSON json => json -> IO () +renderErrorJson json = renderJsonWithStatusCode status400 json +{-# INLINABLE renderErrorJson #-} + +aesonValueToPostgresValue :: Value -> PG.Action +aesonValueToPostgresValue (String text) = PG.toField text +aesonValueToPostgresValue (Bool value) = PG.toField value +aesonValueToPostgresValue (Number value) = case Scientific.floatingOrInteger value of -- Hacky, we should make this function "Schema.sql"-aware in the future + Left (floating :: Double) -> PG.toField floating + Right (integer :: Integer) -> PG.toField integer +aesonValueToPostgresValue Data.Aeson.Null = PG.toField PG.Null +aesonValueToPostgresValue (Data.Aeson.Array values) = PG.toField (PG.PGArray (map aesonValueToPostgresValue (Vector.toList values))) +aesonValueToPostgresValue object@(Object values) = + let + tryDecodeAsPoint :: Maybe Point + tryDecodeAsPoint = do + xValue <- Aeson.lookup "x" values + yValue <- Aeson.lookup "y" values + x <- case xValue of + Number number -> pure (Scientific.toRealFloat number) + otherwise -> Nothing + y <- case yValue of + Number number -> pure (Scientific.toRealFloat number) + otherwise -> Nothing + pure Point { x, y } + in + -- This is really hacky and is mostly duck typing. We should refactor this in the future to + -- become more type aware by passing the DDL of the table to 'aesonValueToPostgresValue'. + if Aeson.size values == 2 + then fromMaybe (PG.toField $ toJSON object) (PG.toField <$> tryDecodeAsPoint) + else PG.toField (toJSON object) + + +instance ToJSON GraphQLResult where + toJSON GraphQLResult { requestId, graphQLResult } = object [ "tag" .= ("GraphQLResult" :: Text), "requestId" .= requestId, "graphQLResult" .= ("" :: Text) ] + toEncoding GraphQLResult { requestId, graphQLResult } = Aeson.econcat + [ Aeson.unsafeToEncoding "{\"tag\":\"GraphQLResult\",\"requestId\":" + , Aeson.int requestId + , Aeson.unsafeToEncoding ",\"graphQLResult\":" + , toEncoding graphQLResult + , Aeson.unsafeToEncoding "}" + ] +instance ToJSON UndecodedJSON where + toJSON (UndecodedJSON _) = error "Not implemented" + toEncoding (UndecodedJSON json) = Aeson.unsafeToEncoding (ByteString.byteString json) diff --git a/IHP/DataSync/REST/Routes.hs b/IHP/DataSync/REST/Routes.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/REST/Routes.hs @@ -0,0 +1,50 @@ +module IHP.DataSync.REST.Routes where + +import IHP.RouterPrelude +import IHP.DataSync.REST.Types + +instance CanRoute ApiController where + parseRoute' = do + string "/api/" + + let + graphQLQueryAction = do + string "graphql" + endOfInput + onlyAllowMethods [POST] + pure GraphQLQueryAction + + createRecordAction table = do + endOfInput + onlyAllowMethods [POST] + pure CreateRecordAction { table } + + updateOrDeleteRecordAction table = do + string "/" + id <- parseUUID + + endOfInput + + method <- getMethod + case method of + PATCH -> pure UpdateRecordAction { table, id } + GET -> pure ShowRecordAction { table, id } + DELETE -> pure DeleteRecordAction { table, id } + + listRecordsAction table = do + endOfInput + method <- getMethod + case method of + GET -> pure ListRecordsAction { table } + + crud = do + table <- parseText + updateOrDeleteRecordAction table <|> createRecordAction table <|> listRecordsAction table + + graphQLQueryAction <|> crud + +instance HasPath ApiController where + pathTo CreateRecordAction { table } = "/api/" <> table + pathTo UpdateRecordAction { table, id } = "/api/" <> table <> "/" <> tshow id + pathTo DeleteRecordAction { table, id } = "/api/" <> table <> "/" <> tshow id + pathTo GraphQLQueryAction = "/api/graphql" diff --git a/IHP/DataSync/REST/Types.hs b/IHP/DataSync/REST/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/REST/Types.hs @@ -0,0 +1,12 @@ +module IHP.DataSync.REST.Types where + +import IHP.Prelude + +data ApiController + = CreateRecordAction { table :: Text } -- ^ POST /api/books + | UpdateRecordAction { table :: Text, id :: UUID } + | DeleteRecordAction { table :: Text, id :: UUID } + | ShowRecordAction { table :: Text, id :: UUID } -- ^ GET /api/books/9ba0ffbc-bfc1-4d7d-8152-30a6648806f7 + | ListRecordsAction { table :: Text } -- ^ GET /api/books + | GraphQLQueryAction + deriving (Eq, Show, Data) diff --git a/IHP/DataSync/Role.hs b/IHP/DataSync/Role.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/Role.hs @@ -0,0 +1,69 @@ +{-| +Module: IHP.DataSync.Role +Description: Postgres role management for RLS +Copyright: (c) digitally induced GmbH, 2021 + +The default user that creates a table in postgres always +has access to all rows inside the table. The default user is not restricted +to the RLS policies. + +Therefore we need to use a second role whenever we want to +make a query with RLS enabled. Basically for every query we do, we'll +wrap it in a transaction and then use 'SET LOCAL ROLE ..' to switch to +our second role for the duration of the transaction. + +-} +module IHP.DataSync.Role where + +import IHP.Prelude +import IHP.FrameworkConfig +import IHP.ModelSupport +import qualified Database.PostgreSQL.Simple.Types as PG + +doesRoleExists :: (?modelContext :: ModelContext) => Text -> IO Bool +doesRoleExists name = sqlQueryScalar "SELECT EXISTS(SELECT 1 FROM pg_roles WHERE rolname = ? LIMIT 1)" [name] + +ensureAuthenticatedRoleExists :: (?context :: context, ConfigProvider context, ?modelContext :: ModelContext) => IO () +ensureAuthenticatedRoleExists = do + roleExists <- doesRoleExists authenticatedRole + unless roleExists (createAuthenticatedRole authenticatedRole) + grantPermissions authenticatedRole + +createAuthenticatedRole :: (?modelContext :: ModelContext) => Text -> IO () +createAuthenticatedRole role = do + -- The role is only going to be used from 'SET ROLE ..' calls + -- Therefore we can disallow direct connection with NOLOGIN + sqlExec "CREATE ROLE ? NOLOGIN" [PG.Identifier role] + + + pure () + +grantPermissions :: (?modelContext :: ModelContext) => Text -> IO () +grantPermissions role = do + -- From SO https://stackoverflow.com/a/17355059/14144232 + -- + -- GRANTs on different objects are separate. GRANTing on a database doesn't GRANT rights to the schema within. Similiarly, GRANTing on a schema doesn't grant rights on the tables within. + -- + -- If you have rights to SELECT from a table, but not the right to see it in the schema that contains it then you can't access the table. + -- + -- The rights tests are done in order: + -- + -- Do you have `USAGE` on the schema? + -- No: Reject access. + -- Yes: Do you also have the appropriate rights on the table? + -- No: Reject access. + -- Yes: Check column privileges. + + -- The role should have access to all existing tables in our schema + sqlExec "GRANT USAGE ON SCHEMA public TO ?" [PG.Identifier role] + + -- The role should have access to all existing tables in our schema + sqlExec "GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO ?" [PG.Identifier role] + + -- Also grant access to all tables created in the future + sqlExec "ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT ALL PRIVILEGES ON TABLES TO ?" [PG.Identifier role] + + pure () + +authenticatedRole :: (?context :: context, ConfigProvider context) => Text +authenticatedRole = ?context.frameworkConfig.rlsAuthenticatedRole diff --git a/IHP/DataSync/RowLevelSecurity.hs b/IHP/DataSync/RowLevelSecurity.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/RowLevelSecurity.hs @@ -0,0 +1,138 @@ +module IHP.DataSync.RowLevelSecurity +( ensureRLSEnabled +, hasRLSEnabled +, TableWithRLS (tableName) +, makeCachedEnsureRLSEnabled +, sqlQueryWithRLS +, sqlExecWithRLS +) +where + +import IHP.ControllerPrelude +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple.ToRow as PG +import qualified IHP.DataSync.Role as Role +import qualified Data.Set as Set + +sqlQueryWithRLS :: + ( ?modelContext :: ModelContext + , PG.ToRow parameters + , ?context :: ControllerContext + , userId ~ Id CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , ?context :: ControllerContext + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , PG.ToField userId + , FromRow result + ) => PG.Query -> parameters -> IO [result] +sqlQueryWithRLS query parameters = sqlQuery queryWithRLS parametersWithRLS + where + (queryWithRLS, parametersWithRLS) = wrapStatementWithRLS query parameters +{-# INLINE sqlQueryWithRLS #-} + +sqlExecWithRLS :: + ( ?modelContext :: ModelContext + , PG.ToRow parameters + , ?context :: ControllerContext + , userId ~ Id CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , ?context :: ControllerContext + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , PG.ToField userId + ) => PG.Query -> parameters -> IO Int64 +sqlExecWithRLS query parameters = sqlExec queryWithRLS parametersWithRLS + where + (queryWithRLS, parametersWithRLS) = wrapStatementWithRLS query parameters +{-# INLINE sqlExecWithRLS #-} + +wrapStatementWithRLS :: + ( ?modelContext :: ModelContext + , PG.ToRow parameters + , ?context :: ControllerContext + , userId ~ Id CurrentUserRecord + , Show (PrimaryKey (GetTableName CurrentUserRecord)) + , HasNewSessionUrl CurrentUserRecord + , Typeable CurrentUserRecord + , ?context :: ControllerContext + , HasField "id" CurrentUserRecord (Id' (GetTableName CurrentUserRecord)) + , PG.ToField userId + ) => PG.Query -> parameters -> (PG.Query, [PG.Action]) +wrapStatementWithRLS query parameters = (queryWithRLS, parametersWithRLS) + where + queryWithRLS = "SET LOCAL ROLE ?; SET LOCAL rls.ihp_user_id = ?; " <> query <> ";" + + maybeUserId = (.id) <$> currentUserOrNothing + + -- When the user is not logged in and maybeUserId is Nothing, we cannot + -- just pass @NULL@ to postgres. The @SET LOCAL@ values can only be strings. + -- + -- Therefore we map Nothing to an empty string here. The empty string + -- means "not logged in". + -- + encodedUserId = case maybeUserId of + Just userId -> PG.toField userId + Nothing -> PG.toField ("" :: Text) + + parametersWithRLS = [PG.toField (PG.Identifier Role.authenticatedRole), PG.toField encodedUserId] <> (PG.toRow parameters) +{-# INLINE wrapStatementWithRLS #-} + +-- | Returns a proof that RLS is enabled for a table +ensureRLSEnabled :: (?modelContext :: ModelContext) => Text -> IO TableWithRLS +ensureRLSEnabled table = do + rlsEnabled <- hasRLSEnabled table + unless rlsEnabled (error "Row level security is required for accessing this table") + pure (TableWithRLS table) + +-- | Returns a factory for 'ensureRLSEnabled' that memoizes when a table has RLS enabled. +-- +-- When a table doesn't have RLS enabled yet, the result is not memoized. +-- +-- __Example:__ +-- +-- > -- Setup +-- > ensureRLSEnabled <- makeCachedEnsureRLSEnabled +-- > +-- > ensureRLSEnabled "projects" -- Runs a database query to check if row level security is enabled for the projects table +-- > +-- > -- Asuming 'ensureRLSEnabled "projects"' proceeded without errors: +-- > +-- > ensureRLSEnabled "projects" -- Now this will instantly return True and don't fire any SQL queries anymore +-- +makeCachedEnsureRLSEnabled :: (?modelContext :: ModelContext) => IO (Text -> IO TableWithRLS) +makeCachedEnsureRLSEnabled = do + tables <- newIORef Set.empty + pure \tableName -> do + rlsEnabled <- Set.member tableName <$> readIORef tables + + if rlsEnabled + then pure TableWithRLS { tableName } + else do + proof <- ensureRLSEnabled tableName + modifyIORef' tables (Set.insert tableName) + pure proof + +-- | Returns 'True' if row level security has been enabled on a table +-- +-- RLS can be enabled with this SQL statement: +-- +-- > ALTER TABLE my_table ENABLE ROW LEVEL SECURITY; +-- +-- After this 'hasRLSEnabled' will return true: +-- +-- >>> hasRLSEnabled "my_table" +-- True +hasRLSEnabled :: (?modelContext :: ModelContext) => Text -> IO Bool +hasRLSEnabled table = sqlQueryScalar "SELECT relrowsecurity FROM pg_class WHERE oid = quote_ident(?)::regclass" [table] + +-- | Can be constructed using 'ensureRLSEnabled' +-- +-- > tableWithRLS <- ensureRLSEnabled "my_table" +-- +-- Useful to carry a proof that the RLS is actually enabled +newtype TableWithRLS = TableWithRLS { tableName :: Text } deriving (Eq, Ord) diff --git a/IHP/DataSync/Types.hs b/IHP/DataSync/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/DataSync/Types.hs @@ -0,0 +1,77 @@ +module IHP.DataSync.Types where + +import IHP.Prelude +import Data.Aeson +import IHP.DataSync.DynamicQuery +import qualified Database.PostgreSQL.Simple as PG +import Control.Concurrent.MVar as MVar + + +data DataSyncMessage + = DataSyncQuery { query :: !DynamicSQLQuery, requestId :: !Int, transactionId :: !(Maybe UUID) } + | CreateDataSubscription { query :: !DynamicSQLQuery, requestId :: !Int } + | CreateCountSubscription { query :: !DynamicSQLQuery, requestId :: !Int } + | DeleteDataSubscription { subscriptionId :: !UUID, requestId :: !Int } + | CreateRecordMessage { table :: !Text, record :: !(HashMap Text Value), requestId :: !Int, transactionId :: !(Maybe UUID) } + | CreateRecordsMessage { table :: !Text, records :: ![HashMap Text Value], requestId :: !Int, transactionId :: !(Maybe UUID) } + | UpdateRecordMessage { table :: !Text, id :: !UUID, patch :: !(HashMap Text Value), requestId :: !Int, transactionId :: !(Maybe UUID) } + | UpdateRecordsMessage { table :: !Text, ids :: ![UUID], patch :: !(HashMap Text Value), requestId :: !Int, transactionId :: !(Maybe UUID) } + | DeleteRecordMessage { table :: !Text, id :: !UUID, requestId :: !Int, transactionId :: !(Maybe UUID) } + | DeleteRecordsMessage { table :: !Text, ids :: ![UUID], requestId :: !Int, transactionId :: !(Maybe UUID) } + | StartTransaction { requestId :: !Int } + | RollbackTransaction { requestId :: !Int, id :: !UUID } + | CommitTransaction { requestId :: !Int, id :: !UUID } + | LoginWithEmailAndPassword { requestId :: !Int, email :: !Text, password :: !Text } + | LoginWithJWT { requestId :: !Int, jwt :: !Text } + | CreateUser { requestId :: !Int, email :: !Text, password :: !Text } + | ConfirmUser { requestId :: !Int, userId :: !UUID, token :: !Text } + deriving (Eq, Show) + +data DataSyncResponse + = DataSyncResult { result :: ![[Field]], requestId :: !Int } + | DataSyncError { requestId :: !Int, errorMessage :: !Text } + | FailedToDecodeMessageError { errorMessage :: !Text } + | DidCreateDataSubscription { requestId :: !Int, subscriptionId :: !UUID, result :: ![[Field]] } + | DidCreateCountSubscription { requestId :: !Int, subscriptionId :: !UUID, count :: !Int } + | DidDeleteDataSubscription { requestId :: !Int, subscriptionId :: !UUID } + | DidInsert { subscriptionId :: !UUID, record :: ![Field] } + | DidUpdate { subscriptionId :: !UUID, id :: UUID, changeSet :: !Value } + | DidDelete { subscriptionId :: !UUID, id :: !UUID } + | DidChangeCount { subscriptionId :: !UUID, count :: !Int } + | DidCreateRecord { requestId :: !Int, record :: ![Field] } -- ^ Response to 'CreateRecordMessage' + | DidCreateRecords { requestId :: !Int, records :: ![[Field]] } -- ^ Response to 'CreateRecordsMessage' + | DidUpdateRecord { requestId :: !Int, record :: ![Field] } -- ^ Response to 'UpdateRecordMessage' + | DidUpdateRecords { requestId :: !Int, records :: ![[Field]] } -- ^ Response to 'UpdateRecordsMessage' + | DidDeleteRecord { requestId :: !Int } + | DidDeleteRecords { requestId :: !Int } + | DidStartTransaction { requestId :: !Int, transactionId :: !UUID } + | DidRollbackTransaction { requestId :: !Int, transactionId :: !UUID } + | DidCommitTransaction { requestId :: !Int, transactionId :: !UUID } + + | LoginSuccessful { requestId :: !Int, userId :: !UUID, jwt :: !Text } + | UserLocked { requestId :: !Int } + | UserUnconfirmed { requestId :: !Int } + | InvalidCredentials { requestId :: !Int } + + | DidCreateUser { requestId :: !Int, userId :: !UUID, emailConfirmationRequired :: !Bool, jwt :: !Text } + | CreateUserFailed { requestId :: !Int, validationFailures :: [(Text, Text)] } + | DidConfirmUser { requestId :: !Int, jwt :: !Text } + | DidConfirmUserAlready { requestId :: !Int } + | ConfirmUserFailed { requestId :: !Int } + +data GraphQLResult = GraphQLResult { graphQLResult :: !UndecodedJSON, requestId :: !Int } + +data DataSyncTransaction + = DataSyncTransaction + { id :: !UUID + , connection :: !PG.Connection + , close :: MVar () + } + +data DataSyncController + = DataSyncController + | DataSyncReady + { subscriptions :: !(HashMap UUID (MVar.MVar ())) + , transactions :: !(HashMap UUID DataSyncTransaction) + , asyncs :: ![Async ()] + } diff --git a/IHP/EnvVar.hs b/IHP/EnvVar.hs new file mode 100644 --- /dev/null +++ b/IHP/EnvVar.hs @@ -0,0 +1,109 @@ +module IHP.EnvVar +( env +, envOrDefault +, envOrNothing +, hasEnvVar +, EnvVarReader (..) +) +where + +import IHP.Prelude +import Data.String.Interpolate.IsString (i) +import qualified System.Posix.Env.ByteString as Posix +import Network.Socket (PortNumber) +import IHP.Mail.Types +import IHP.Environment + +-- | Returns a env variable. The raw string +-- value is parsed before returning it. So the return value type depends on what +-- you expect (e.g. can be Text, Int some custom type). +-- +-- When the parameter is missing or cannot be parsed, an error is raised and +-- the app startup is aborted. Use 'envOrDefault' when you want to get a +-- default value instead of an error, or 'paramOrNothing' to get @Nothing@ +-- when the env variable is missing. +-- +-- You can define a custom env variable parser by defining a 'EnvVarReader' instance. +-- +-- __Example:__ Accessing a env var PORT. +-- +-- Let's say an env var PORT is set to 1337 +-- +-- > export PORT=1337 +-- +-- We can read @PORT@ like this: +-- +-- > port <- env @Int "PORT" +-- +-- __Example:__ Missing env vars +-- +-- Let's say the @PORT@ env var is not defined. In that case we'll get an +-- error when trying to access it: +-- +-- >>> port <- env @Int "PORT" +-- "Env var 'PORT' not set, but it's required for the app to run" +-- +env :: forall result monad. (MonadIO monad) => EnvVarReader result => ByteString -> monad result +env name = envOrDefault name (error [i|Env var '#{name}' not set, but it's required for the app to run|]) +{-# INLINE env #-} + +envOrDefault :: (MonadIO monad) => EnvVarReader result => ByteString -> result -> monad result +envOrDefault name defaultValue = fromMaybe defaultValue <$> envOrNothing name +{-# INLINE envOrDefault #-} + +envOrNothing :: (MonadIO monad) => EnvVarReader result => ByteString -> monad (Maybe result) +envOrNothing name = liftIO $ fmap parseString <$> Posix.getEnv name + where + parseString string = case envStringToValue string of + Left errorMessage -> error [i|Env var '#{name}' is invalid: #{errorMessage}|] + Right value -> value +{-# INLINE envOrNothing #-} + +hasEnvVar :: (MonadIO monad) => ByteString -> monad Bool +hasEnvVar name = liftIO do + value :: Maybe ByteString <- envOrNothing name + pure (isJust value) +{-# INLINE hasEnvVar #-} + +class EnvVarReader valueType where + envStringToValue :: ByteString -> Either Text valueType + +instance EnvVarReader Environment where + envStringToValue "Production" = Right Production + envStringToValue "Development" = Right Development + envStringToValue otherwise = Left "Should be set to 'Development' or 'Production'" + +instance EnvVarReader Int where + envStringToValue string = case textToInt (cs string) of + Just integer -> Right integer + Nothing -> Left [i|Expected integer, got #{string}|] + +instance EnvVarReader Text where + envStringToValue string = Right (cs string) + +instance EnvVarReader String where + envStringToValue string = Right (cs string) + +instance EnvVarReader ByteString where + envStringToValue string = Right string + +instance EnvVarReader Bool where + envStringToValue "1" = Right True + envStringToValue "0" = Right False + envStringToValue otherwise = Left "Should be set to '1' or '0'" + +-- | Allow reading the env var of an SMTP port number. +instance EnvVarReader PortNumber where + envStringToValue string = case textToInt (cs string) of + Just integer -> Right $ convertIntToPortNumber integer + Nothing -> Left [i|Expected integer to be used as a Port number, got #{string}|] + +convertIntToPortNumber :: Int -> PortNumber +convertIntToPortNumber int = fromIntegral (int :: Int) :: PortNumber + +-- | Allow reading the env var of an SMTP encryption method. +instance EnvVarReader SMTPEncryption where + envStringToValue "Unencrypted" = Right Unencrypted + envStringToValue "TLS" = Right TLS + envStringToValue "STARTTLS" = Right STARTTLS + envStringToValue otherwise = Left [i|Expected 'Unencrypted', 'TLS' or 'STARTTLS', got #{otherwise}|] diff --git a/IHP/Environment.hs b/IHP/Environment.hs new file mode 100644 --- /dev/null +++ b/IHP/Environment.hs @@ -0,0 +1,17 @@ +module IHP.Environment where +import IHP.Prelude + +-- | The 'Environment' type is used to switch between development and production configurations. +-- +-- When running 'devenv up', this will be set to 'Development', while 'deploy-to-nixos' will set it to 'Production'. +-- You can also manually set it with 'option Development' or 'option Production' in your Config.hs, or via the 'IHP_ENV' environment variable. +-- +-- You can check the current environment using 'isDevelopment', 'isProduction', or 'isEnvironment' if you want to change behaviour based on the environment. +-- IHP by default implements the following differences: +-- +-- - Static file caching: In 'Development', browser cache is disabled (max-age=0). In 'Production', max-age is forever, with asset hashes for invalidation. See 'initStaticApp'. +-- - Logger: In 'Development', logging uses the default format. In 'Production', it uses an Apache-style logger and higher log level. See 'ihpDefaultConfig'. +-- - Background workers: In 'Development', a development job worker server is started automatically. In 'Production', you need to manually start a separate RunJobs process. See the [chapter on Jobs in the Guide](https://ihp.digitallyinduced.com/Guide/jobs.html#development-vs-production) for details. +-- - Database connections: The pool idle time is by default shorter in 'Development'. See 'ihpDefaultConfig'. +-- - Error pages: In 'Development', error pages may contain backtraces and details about the code, with links to the IDE. In 'Production', error pages do not contain implementation information. +data Environment = Development | Production deriving (Eq, Show) diff --git a/IHP/ErrorController.hs b/IHP/ErrorController.hs new file mode 100644 --- /dev/null +++ b/IHP/ErrorController.hs @@ -0,0 +1,503 @@ +{-| +Module: IHP.ErrorController +Description: Provides web-based error screens for runtime errors in IHP +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.ErrorController +( displayException +, handleNoResponseReturned +, handleRouterException +) where + +import IHP.Prelude hiding (displayException) +import qualified IHP.Controller.Param as Param +import qualified IHP.Router.Types as Router +import qualified Network.HTTP.Types.Method as Router +import qualified Control.Exception as Exception +import qualified Data.Text as Text +import IHP.Controller.RequestContext +import Network.HTTP.Types (status500, status400) +import Network.Wai +import Network.HTTP.Types.Header + +import qualified Text.Blaze.Html5 as H +import qualified Text.Blaze.Html.Renderer.Utf8 as Blaze +import qualified Database.PostgreSQL.Simple as PG +import qualified Data.ByteString.Char8 as ByteString + +import IHP.HSX.QQ (hsx) +import qualified IHP.ModelSupport as ModelSupport +import IHP.FrameworkConfig +import qualified IHP.Environment as Environment +import IHP.Controller.Context +import IHP.ApplicationContext +import IHP.Controller.NotFound (handleNotFound) +import qualified IHP.Log as Log + +handleNoResponseReturned :: (Show controller, ?context :: ControllerContext) => controller -> IO ResponseReceived +handleNoResponseReturned controller = do + let codeSample :: Text = "render MyView { .. }" + let errorMessage = [hsx| +

Possible Solutions

+

You can fix this by calling '{codeSample}' at the end of your action.

+ +

Details

+

No response was returned while running the action {tshow controller}

+ + |] + let title = [hsx|No response returned in {tshow controller}|] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + +displayException :: (Show action, ?context :: ControllerContext, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext) => SomeException -> action -> Text -> IO ResponseReceived +displayException exception action additionalInfo = do + -- Dev handlers display helpful tips on how to resolve the problem + let devHandlers = + [ postgresHandler + , paramNotFoundExceptionHandler + , patternMatchFailureHandler + , recordNotFoundExceptionHandlerDev + ] + + -- Prod handlers should not leak any information about the system + let prodHandlers = + [ recordNotFoundExceptionHandlerProd + ] + + let allHandlers = if ?context.frameworkConfig.environment == Environment.Development + then devHandlers + else prodHandlers + + let supportingHandlers = allHandlers |> mapMaybe (\f -> f exception action additionalInfo) + + let displayGenericError = genericHandler exception action additionalInfo + + + -- Additionally to rendering the error message to the browser we also send it + -- to the error tracking service (e.g. sentry). Usually this service also writes + -- the error message to the stderr output + -- + when (?context.frameworkConfig.environment == Environment.Production) do + let exceptionTracker = ?applicationContext.frameworkConfig.exceptionTracker.onException + let request = ?requestContext.request + + + exceptionTracker (Just request) exception + + supportingHandlers + |> head + |> fromMaybe displayGenericError + +-- | Responds to all exceptions with a generic error message. +-- +-- In dev mode the action and exception is added to the output. +-- In production mode nothing is specific is communicated about the exception +genericHandler :: (Show controller, ?context :: ControllerContext) => Exception.SomeException -> controller -> Text -> IO ResponseReceived +genericHandler exception controller additionalInfo = do + let errorMessageText = "An exception was raised while running the action " <> tshow controller <> additionalInfo + let errorMessageTitle = Exception.displayException exception + + let devErrorMessage = [hsx|{errorMessageText}|] + let devTitle = [hsx|{errorMessageTitle}|] + + Log.error (errorMessageText <> ": " <> cs errorMessageTitle) + + let prodErrorMessage = [hsx|An exception was raised while running the action|] + let prodTitle = [hsx|An error happened|] + + let (errorMessage, errorTitle) = if ?context.frameworkConfig.environment == Environment.Development + then (devErrorMessage, devTitle) + else (prodErrorMessage, prodTitle) + let RequestContext { respond } = ?context.requestContext + + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError errorTitle errorMessage)) + +postgresHandler :: (Show controller, ?context :: ControllerContext) => SomeException -> controller -> Text -> Maybe (IO ResponseReceived) +postgresHandler exception controller additionalInfo = do + let + handlePostgresOutdatedError :: Show exception => exception -> H.Html -> IO ResponseReceived + handlePostgresOutdatedError exception errorText = do + let ihpIdeBaseUrl = ?context.frameworkConfig.ideBaseUrl + let title = [hsx|Database looks outdated. {errorText}|] + let errorMessage = [hsx| +

Possible Solutions

+
+ Have you clicked on +
"/NewMigration"} target="_blank" style="display: inline"> + +
+ after updating the Schema? +
+ +

Details

+

The exception was raised while running the action: {tshow controller}{additionalInfo}

+

{tshow exception}

+ |] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + + handleSqlError :: ModelSupport.EnhancedSqlError -> IO ResponseReceived + handleSqlError exception = do + let ihpIdeBaseUrl = ?context.frameworkConfig.ideBaseUrl + let sqlError = exception.sqlError + let title = [hsx|{sqlError.sqlErrorMsg}|] + let errorMessage = [hsx| +

While running the following Query:

+
+ {exception.sqlErrorQuery} +
+ +

With Query Parameters:

+
+ {exception.sqlErrorQueryParams} +
+ +

Details:

+

The exception was raised while running the action: {tshow controller}{additionalInfo}

+

{tshow exception}

+ |] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + case fromException exception of + Just (exception :: PG.ResultError) -> Just (handlePostgresOutdatedError exception "The database result does not match the expected type.") + Nothing -> case fromException exception of + -- Catching `relation "..." does not exist` + Just exception@ModelSupport.EnhancedSqlError { sqlError } + | "relation" `ByteString.isPrefixOf` (sqlError.sqlErrorMsg) + && "does not exist" `ByteString.isSuffixOf` (sqlError.sqlErrorMsg) + -> Just (handlePostgresOutdatedError exception "A table is missing.") + + -- Catching `columns "..." does not exist` + Just exception@ModelSupport.EnhancedSqlError { sqlError } + | "column" `ByteString.isPrefixOf` (sqlError.sqlErrorMsg) + && "does not exist" `ByteString.isSuffixOf` (sqlError.sqlErrorMsg) + -> Just (handlePostgresOutdatedError exception "A column is missing.") + -- Catching other SQL Errors + Just exception -> Just (handleSqlError exception) + Nothing -> Nothing + +patternMatchFailureHandler :: (Show controller, ?context :: ControllerContext) => SomeException -> controller -> Text -> Maybe (IO ResponseReceived) +patternMatchFailureHandler exception controller additionalInfo = do + case fromException exception of + Just (exception :: Exception.PatternMatchFail) -> Just do + let (controllerPath, _) = Text.breakOn ":" (tshow exception) + let errorMessage = [hsx| +

Possible Solutions

+

a) Maybe the action function is missing for {tshow controller}? You can fix this by adding an action handler like this to the controller '{controllerPath}':

+ 
{codeSample}
+

b) A pattern match like 'let (Just value) = ...' failed. Please see the details section.

+ +

Details

+

{exception}

+ |] + where + codeSample = " action (" <> tshow controller <> ") = do\n renderPlain \"Hello World\"" + + let title = [hsx|Pattern match failed while executing {tshow controller}|] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Nothing -> Nothing + +-- Handler for 'IHP.Controller.Param.ParamNotFoundException' +paramNotFoundExceptionHandler :: (Show controller, ?context :: ControllerContext) => SomeException -> controller -> Text -> Maybe (IO ResponseReceived) +paramNotFoundExceptionHandler exception controller additionalInfo = do + case fromException exception of + Just (exception@(Param.ParamNotFoundException paramName)) -> Just do + let (controllerPath, _) = Text.breakOn ":" (tshow exception) + + let renderParam (paramName, paramValue) = [hsx|
  • {paramName}: {paramValue}
    • |] + let solutionHint = + if isEmpty Param.allParams + then [hsx| + This action was called without any parameters at all. + You can pass this parameter by appending ?{paramName}=someValue to the URL. + |] + else [hsx| +

    The following parameters are provided by the request:

    + + +

    a) Is there a typo in your call to param {tshow paramName}?

    +

    b) You can pass this parameter by appending &{paramName}=someValue to the URL.

    +

    c) You can pass this parameter using a form input like {" paramName <> "\"/>" :: ByteString}.

    + |] + let errorMessage = [hsx| +

    + This exception was caused by a call to param {tshow paramName} in {tshow controller}. +

    +

    + A request parameter is just a query parameter like /MyAction?someParameter=someValue&secondParameter=1 + or a form input when the request was submitted from a html form or via ajax. +

    +

    Possible Solutions:

    + {solutionHint} + +

    Details

    +

    {exception}

    + |] + + + + let title = [hsx|Parameter {paramName} not found in the request|] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Just (exception@(Param.ParamCouldNotBeParsedException { name, parserError })) -> Just do + let (controllerPath, _) = Text.breakOn ":" (tshow exception) + + let renderParam (paramName, paramValue) = [hsx|
  • {paramName}: {paramValue}
    • |] + let errorMessage = [hsx| +

    + This exception was caused by a call to param {tshow name} in {tshow controller}. +

    +

    + Here's the error output from the parser: {parserError} +

    + +

    Details

    +

    {exception}

    + |] + + + + let title = [hsx|Parameter {name} was invalid|] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Nothing -> Nothing + +-- Handler for 'IHP.ModelSupport.RecordNotFoundException' +-- +-- Used only in development mode of the app. +recordNotFoundExceptionHandlerDev :: (Show controller, ?context :: ControllerContext) => SomeException -> controller -> Text -> Maybe (IO ResponseReceived) +recordNotFoundExceptionHandlerDev exception controller additionalInfo = + case fromException exception of + Just (exception@(ModelSupport.RecordNotFoundException { queryAndParams = (query, params) })) -> Just do + let (controllerPath, _) = Text.breakOn ":" (tshow exception) + let errorMessage = [hsx| +

    + The following SQL was executed: + 

    {query}
    +

    +

    + These query parameters have been used: + 

    {params}
    +

    + +

    + This exception was caused by a call to fetchOne in {tshow controller}. +

    + +

    Possible Solutions:

    + +

    + a) Use fetchOneOrNothing. This will return a Nothing + when no results are returned by the database. +

    + +

    + b) Make sure the the data you are querying is actually there. +

    + + +

    Details

    +

    {exception}

    + |] + + + + let title = [hsx|Call to fetchOne failed. No records returned.|] + let RequestContext { respond } = ?context.requestContext + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Nothing -> Nothing + +-- Handler for 'IHP.ModelSupport.RecordNotFoundException' +-- +-- Used only in production mode of the app. The exception is handled by calling 'handleNotFound' +recordNotFoundExceptionHandlerProd :: (?context :: ControllerContext) => SomeException -> controller -> Text -> Maybe (IO ResponseReceived) +recordNotFoundExceptionHandlerProd exception controller additionalInfo = + case fromException exception of + Just (exception@(ModelSupport.RecordNotFoundException {})) -> + let requestContext = ?context.requestContext + in + let ?context = requestContext + in Just (handleNotFound ?context.request ?context.respond) + Nothing -> Nothing + +handleRouterException :: (?applicationContext :: ApplicationContext) => SomeException -> Application +handleRouterException exception request respond = + let ?context = ?applicationContext + in case fromException exception of + Just Router.NoConstructorMatched { expectedType, value, field } -> do + let routingError = if ?context.frameworkConfig.environment == Environment.Development + then [hsx|

    Routing failed with: {tshow exception}

    |] + else "" + + let errorMessage = [hsx| + { routingError } + +

    Possible Solutions

    +

    You can pass this parameter by appending &{field}=someValue to the URL.

    + |] + + let title = case value of + Just value -> [hsx|Expected {expectedType} for field {field} but got {value}|] + Nothing -> [hsx|The action was called without the required {field} parameter|] + respond $ responseBuilder status400 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Just Router.BadType { expectedType, value = Just value, field } -> do + let errorMessage = [hsx| +

    Routing failed with: {tshow exception}

    + |] + let title = [hsx|Query parameter {field} needs to be a {expectedType} but got {value}|] + respond $ responseBuilder status400 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + _ -> case fromException exception of + Just Router.UnexpectedMethodException { allowedMethods = [Router.DELETE], method = Router.GET } -> do + let exampleLink :: Text = "Delete Project" + let formExample :: Text = cs [plain| +
    + + +
    + |] + let errorMessage = [hsx| +

    + You cannot directly link to Delete Action. + GET requests should not have any external side effects, as a user could accidentally trigger it by following a normal link. +

    + +

    Possible Solutions

    +

    + a) Add a js-delete class to your link. IHP's helper.js will intercept link clicks on these links and use a form with a DELETE request to submit the request. +

    + + Example:

    + {exampleLink} +

    +

    + b) Use a form to submit the request as a DELETE request: +

    + + Example:
    + 

    {formExample}
    + HTML forms don't support DELETE requests natively, therefore we use the hidden input field to work around this browser limitation. +

    + |] + let title = [hsx|Action was called from a GET request, but needs to be called as a DELETE request|] + respond $ responseBuilder status400 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Just Router.UnexpectedMethodException { allowedMethods = [Router.POST], method = Router.GET } -> do + let errorMessage = [hsx| +

    + You cannot directly link to Create Action. + GET requests should not have any external side effects, as a user could accidentally trigger it by following a normal link. +

    + +

    Possible Solutions

    +

    + Make a form with formFor to do the request +

    + |] + let title = [hsx|Action was called from a GET request, but needs to be called as a POST request|] + respond $ responseBuilder status400 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + Just Router.UnexpectedMethodException { allowedMethods, method } -> do + let errorMessage = [hsx| +

    Routing failed with: {tshow exception}

    +

    Possible Solutions

    +

    + Make a form with formFor to do the request +

    + |] + let title = [hsx|Action was called with a {method} request, but needs to be called with one of these request methods: {allowedMethods}|] + respond $ responseBuilder status400 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + _ -> do + let errorMessage = [hsx| + Routing failed with: {tshow exception} + +

    Possible Solutions

    +

    Are you trying to do a DELETE action, but your link is missing class="js-delete"?

    + |] + let title = H.text "Routing failed" + respond $ responseBuilder status500 [(hContentType, "text/html")] (Blaze.renderHtmlBuilder (renderError title errorMessage)) + + +renderError :: forall context. (?context :: context, ConfigProvider context) => H.Html -> H.Html -> H.Html +renderError errorTitle view = [hsx| + + + + + + + IHP Error + + + +
    +
    +

    {errorTitle}

    +
    + {view} +
    + + {when shouldShowHelpFooter helpFooter} +
    +
    + + + |] + where + shouldShowHelpFooter = ?context.frameworkConfig.environment == Environment.Development + helpFooter = [hsx| +
    + Ask the IHP Community on StackOverflow + Check the Troubleshooting + Open GitHub Issue + Slack + Reddit + StackShare +
    + |] diff --git a/IHP/Fetch.hs b/IHP/Fetch.hs new file mode 100644 --- /dev/null +++ b/IHP/Fetch.hs @@ -0,0 +1,309 @@ +{-# LANGUAGE BangPatterns, TypeFamilies, DataKinds, PolyKinds, TypeApplications, ScopedTypeVariables, ConstraintKinds, TypeOperators, GADTs, UndecidableInstances, StandaloneDeriving, FunctionalDependencies, FlexibleContexts, InstanceSigs, AllowAmbiguousTypes, DeriveAnyClass #-} +{-| +Module: IHP.Fetch +Description: fetch, fetchOne, fetchOneOrNothing and friends +Copyright: (c) digitally induced GmbH, 2020 + +This modules builds on top of 'IHP.QueryBuilder' and provides functions to fetch a query builder. + +For more complex sql queries, use 'IHP.ModelSupport.sqlQuery'. +-} +module IHP.Fetch +( findManyBy +, findMaybeBy +, findBy +, In (In) +, genericFetchId +, genericfetchIdOneOrNothing +, genericFetchIdOne +, Fetchable (..) +, genericFetchIds +, genericfetchIdsOneOrNothing +, genericFetchIdsOne +, fetchCount +, fetchExists +, fetchSQLQuery +, fetchLatest +, fetchLatestBy +) +where + +import IHP.Prelude +import Database.PostgreSQL.Simple.Types (Query (Query)) +import Database.PostgreSQL.Simple.FromField hiding (Field, name) +import Database.PostgreSQL.Simple.ToField +import qualified Database.PostgreSQL.Simple as PG +import IHP.ModelSupport +import IHP.QueryBuilder + +class Fetchable fetchable model | fetchable -> model where + type FetchResult fetchable model + fetch :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => fetchable -> IO (FetchResult fetchable model) + fetchOneOrNothing :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => fetchable -> IO (Maybe model) + fetchOne :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => fetchable -> IO model + +-- The instance declaration had to be split up because a type variable ranging over HasQueryBuilder instances is not allowed in the declaration of the associated type. The common*-functions reduce the redundancy to the necessary minimum. +instance (model ~ GetModelByTableName table, KnownSymbol table) => Fetchable (QueryBuilder table) model where + type instance FetchResult (QueryBuilder table) model = [model] + {-# INLINE fetch #-} + fetch :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => QueryBuilder table -> IO [model] + fetch = commonFetch + + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => QueryBuilder table -> IO (Maybe model) + fetchOneOrNothing = commonFetchOneOrNothing + + {-# INLINE fetchOne #-} + fetchOne :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => QueryBuilder table -> IO model + fetchOne = commonFetchOne + +instance (model ~ GetModelByTableName table, KnownSymbol table) => Fetchable (JoinQueryBuilderWrapper r table) model where + type instance FetchResult (JoinQueryBuilderWrapper r table) model = [model] + {-# INLINE fetch #-} + fetch :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => JoinQueryBuilderWrapper r table -> IO [model] + fetch = commonFetch + + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => JoinQueryBuilderWrapper r table -> IO (Maybe model) + fetchOneOrNothing = commonFetchOneOrNothing + + {-# INLINE fetchOne #-} + fetchOne :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => JoinQueryBuilderWrapper r table -> IO model + fetchOne = commonFetchOne + +instance (model ~ GetModelByTableName table, KnownSymbol table) => Fetchable (NoJoinQueryBuilderWrapper table) model where + type instance FetchResult (NoJoinQueryBuilderWrapper table) model = [model] + {-# INLINE fetch #-} + fetch :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => NoJoinQueryBuilderWrapper table -> IO [model] + fetch = commonFetch + + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => NoJoinQueryBuilderWrapper table -> IO (Maybe model) + fetchOneOrNothing = commonFetchOneOrNothing + + {-# INLINE fetchOne #-} + fetchOne :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => NoJoinQueryBuilderWrapper table -> IO model + fetchOne = commonFetchOne + +instance (model ~ GetModelByTableName table, KnownSymbol table, FromField value, KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable, KnownSymbol columnName, HasField columnName foreignModel value, HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable columnName value) NoJoins) => Fetchable (LabeledQueryBuilderWrapper foreignTable columnName value table) model where + type instance FetchResult (LabeledQueryBuilderWrapper foreignTable columnName value table) model = [LabeledData value model] + -- fetch needs to return a list of labeled data. The + {-# INLINE fetch #-} + fetch :: (Table model, PG.FromRow model, ?modelContext :: ModelContext) => LabeledQueryBuilderWrapper foreignTable columnName value table -> IO [LabeledData value model] + fetch !queryBuilderProvider = do + let !(theQuery, theParameters) = queryBuilderProvider + |> toSQL + trackTableRead (tableNameByteString @model) + sqlQuery @_ @(LabeledData value model) (Query $ cs theQuery) theParameters + + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => LabeledQueryBuilderWrapper foreignTable columnName value table -> IO (Maybe model) + fetchOneOrNothing = commonFetchOneOrNothing + + {-# INLINE fetchOne #-} + fetchOne :: (?modelContext :: ModelContext) => (Table model, PG.FromRow model) => LabeledQueryBuilderWrapper foreignTable columnName value table -> IO model + fetchOne = commonFetchOne + + + +{-# INLINE commonFetch #-} +commonFetch :: forall model table queryBuilderProvider joinRegister. (Table model, HasQueryBuilder queryBuilderProvider joinRegister, model ~ GetModelByTableName table, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext) => queryBuilderProvider table -> IO [model] +commonFetch !queryBuilder = do + let !(theQuery, theParameters) = queryBuilder + |> toSQL + trackTableRead (tableNameByteString @model) + sqlQuery (Query $ cs theQuery) theParameters + +{-# INLINE commonFetchOneOrNothing #-} +commonFetchOneOrNothing :: forall model table queryBuilderProvider joinRegister. (?modelContext :: ModelContext) => (Table model, KnownSymbol table, HasQueryBuilder queryBuilderProvider joinRegister, PG.FromRow model) => queryBuilderProvider table -> IO (Maybe model) +commonFetchOneOrNothing !queryBuilder = do + let !(theQuery, theParameters) = queryBuilder + |> buildQuery + |> setJust #limitClause "LIMIT 1" + |> toSQL' + trackTableRead (tableNameByteString @model) + results <- sqlQuery (Query $ cs theQuery) theParameters + pure $ listToMaybe results + +{-# INLINE commonFetchOne #-} +commonFetchOne :: forall model table queryBuilderProvider joinRegister. (?modelContext :: ModelContext) => (Table model, KnownSymbol table, Fetchable (queryBuilderProvider table) model, HasQueryBuilder queryBuilderProvider joinRegister, PG.FromRow model) => queryBuilderProvider table -> IO model +commonFetchOne !queryBuilder = do + maybeModel <- fetchOneOrNothing queryBuilder + case maybeModel of + Just model -> pure model + Nothing -> throwIO RecordNotFoundException { queryAndParams = toSQL queryBuilder } + + +-- | Returns the count of records selected by the query builder. +-- +-- __Example:__ Counting all users. +-- +-- > allUsersCount <- query @User |> fetchCount -- SELECT COUNT(*) FROM users +-- +-- +-- __Example:__ Counting all active projects +-- +-- > activeProjectsCount <- query @Project +-- > |> filterWhere (#isActive, True) +-- > |> fetchCount +-- > -- SELECT COUNT(*) FROM projects WHERE is_active = true +fetchCount :: forall table queryBuilderProvider joinRegister. (?modelContext :: ModelContext, KnownSymbol table, HasQueryBuilder queryBuilderProvider joinRegister) => queryBuilderProvider table -> IO Int +fetchCount !queryBuilder = do + let !(theQuery', theParameters) = toSQL' (buildQuery queryBuilder) + let theQuery = "SELECT COUNT(*) FROM (" <> theQuery' <> ") AS _count_values" + trackTableRead (symbolToByteString @table) + [PG.Only count] <- sqlQuery (Query $! cs theQuery) theParameters + pure count +{-# INLINE fetchCount #-} + +-- | Checks whether the query has any results. +-- +-- Returns @True@ when there is at least one row matching the conditions of the query. Returns @False@ otherwise. +-- +-- __Example:__ Checking whether there are unread messages +-- +-- > hasUnreadMessages <- query @Message +-- > |> filterWhere (#isUnread, True) +-- > |> fetchExists +-- > -- SELECT EXISTS (SELECT * FROM messages WHERE is_unread = true) +fetchExists :: forall table queryBuilderProvider joinRegister. (?modelContext :: ModelContext, KnownSymbol table, HasQueryBuilder queryBuilderProvider joinRegister) => queryBuilderProvider table -> IO Bool +fetchExists !queryBuilder = do + let !(theQuery', theParameters) = toSQL' (buildQuery queryBuilder) + let theQuery = "SELECT EXISTS (" <> theQuery' <> ") AS _exists_values" + trackTableRead (symbolToByteString @table) + [PG.Only exists] <- sqlQuery (Query $! cs theQuery) theParameters + pure exists +{-# INLINE fetchExists #-} + +{-# INLINE genericFetchId #-} +genericFetchId :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, FilterPrimaryKey table, model ~ GetModelByTableName table, GetTableName model ~ table) => Id' table -> IO [model] +genericFetchId !id = query @model |> filterWhereId id |> fetch + +{-# INLINE genericfetchIdOneOrNothing #-} +genericfetchIdOneOrNothing :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, FilterPrimaryKey table, model ~ GetModelByTableName table, GetTableName model ~ table) => Id' table -> IO (Maybe model) +genericfetchIdOneOrNothing !id = query @model |> filterWhereId id |> fetchOneOrNothing + +{-# INLINE genericFetchIdOne #-} +genericFetchIdOne :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, FilterPrimaryKey table, model ~ GetModelByTableName table, GetTableName model ~ table) => Id' table -> IO model +genericFetchIdOne !id = query @model |> filterWhereId id |> fetchOne + +{-# INLINE genericFetchIds #-} +genericFetchIds :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, model ~ GetModelByTableName table, GetTableName model ~ table) => [Id model] -> IO [model] +genericFetchIds !ids = query @model |> filterWhereIdIn ids |> fetch + +{-# INLINE genericfetchIdsOneOrNothing #-} +genericfetchIdsOneOrNothing :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, model ~ GetModelByTableName table, GetTableName model ~ table) => [Id model] -> IO (Maybe model) +genericfetchIdsOneOrNothing !ids = query @model |> filterWhereIdIn ids |> fetchOneOrNothing + +{-# INLINE genericFetchIdsOne #-} +genericFetchIdsOne :: forall table model. (Table model, KnownSymbol table, PG.FromRow model, ?modelContext :: ModelContext, model ~ GetModelByTableName table, GetTableName model ~ table) => [Id model] -> IO model +genericFetchIdsOne !ids = query @model |> filterWhereIdIn ids |> fetchOne + +{-# INLINE findBy #-} +findBy !field !value !queryBuilder = queryBuilder |> filterWhere (field, value) |> fetchOne + +{-# INLINE findMaybeBy #-} +findMaybeBy !field !value !queryBuilder = queryBuilder |> filterWhere (field, value) |> fetchOneOrNothing + +--findManyBy :: (?modelContext :: ModelContext, PG.FromRow model, KnownSymbol name, ToField value, HasField name value model) => Proxy name -> value -> QueryBuilder model -> IO [model] +{-# INLINE findManyBy #-} +findManyBy !field !value !queryBuilder = queryBuilder |> filterWhere (field, value) |> fetch +-- Step.findOneByWorkflowId id == queryBuilder |> findBy #templateId id + +instance (model ~ GetModelById (Id' table), GetTableName model ~ table, FilterPrimaryKey table) => Fetchable (Id' table) model where + type FetchResult (Id' table) model = model + {-# INLINE fetch #-} + fetch = genericFetchIdOne + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing = genericfetchIdOneOrNothing + {-# INLINE fetchOne #-} + fetchOne = genericFetchIdOne + +instance (model ~ GetModelById (Id' table), GetTableName model ~ table, FilterPrimaryKey table) => Fetchable (Maybe (Id' table)) model where + type FetchResult (Maybe (Id' table)) model = [model] + {-# INLINE fetch #-} + fetch (Just a) = genericFetchId a + fetch Nothing = pure [] + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing Nothing = pure Nothing + fetchOneOrNothing (Just a) = genericfetchIdOneOrNothing a + {-# INLINE fetchOne #-} + fetchOne (Just a) = genericFetchIdOne a + fetchOne Nothing = error "Fetchable (Maybe Id): Failed to fetch because given id is 'Nothing', 'Just id' was expected" + +instance (model ~ GetModelById (Id' table), GetModelByTableName table ~ model, GetTableName model ~ table) => Fetchable [Id' table] model where + type FetchResult [Id' table] model = [model] + {-# INLINE fetch #-} + fetch = genericFetchIds + {-# INLINE fetchOneOrNothing #-} + fetchOneOrNothing = genericfetchIdsOneOrNothing + {-# INLINE fetchOne #-} + fetchOne = genericFetchIdsOne + +fetchSQLQuery :: (PG.FromRow model, ?modelContext :: ModelContext) => SQLQuery -> IO [model] +fetchSQLQuery theQuery = do + let (sql, theParameters) = toSQL' theQuery + trackTableRead (theQuery.selectFrom) + sqlQuery (Query $ cs sql) theParameters + +-- | Returns the latest record or Nothing +-- +-- __Example:__ +-- +-- > latestUser <- +-- > query @User +-- > |> fetchLatest +-- > +-- +-- 'fetchLatest' is mainly a shortcut for code like this: +-- +-- > latestUser <- +-- > query @User +-- > |> orderByDesc #createdAt +-- > |> fetchOneOrNothing +-- +fetchLatest :: forall table queryBuilderProvider joinRegister model. + ( ?modelContext :: ModelContext + , model ~ GetModelByTableName table + , KnownSymbol table + , HasQueryBuilder queryBuilderProvider joinRegister + , HasField "createdAt" model UTCTime + , Fetchable (queryBuilderProvider table) model + , Table model + , FromRow model + ) => queryBuilderProvider table -> IO (Maybe model) +fetchLatest queryBuilder = queryBuilder |> fetchLatestBy #createdAt + +-- | Provided a field name, it returns the latest record or Nothing +-- +-- See 'fetchLatest' if you're looking for the latest record by the createdAt timestamp. +-- +-- __Example:__ +-- +-- > latestTrialUser <- +-- > query @User +-- > |> fetchLatestBy #trialStartedAt +-- > +-- +-- 'fetchLatestBy' is mainly a shortcut for code like this: +-- +-- > latestUser <- +-- > query @User +-- > |> orderByDesc #trialStartedAt +-- > |> fetchOneOrNothing +-- +fetchLatestBy :: forall table createdAt queryBuilderProvider joinRegister model. + ( ?modelContext :: ModelContext + , KnownSymbol createdAt + , model ~ GetModelByTableName table + , KnownSymbol table + , HasQueryBuilder queryBuilderProvider joinRegister + , HasField createdAt model UTCTime + , Fetchable (queryBuilderProvider table) model + , Table model + , FromRow model + ) => Proxy createdAt -> queryBuilderProvider table -> IO (Maybe model) +fetchLatestBy field queryBuilder = + queryBuilder + |> orderByDesc field + |> fetchOneOrNothing diff --git a/IHP/FetchRelated.hs b/IHP/FetchRelated.hs new file mode 100644 --- /dev/null +++ b/IHP/FetchRelated.hs @@ -0,0 +1,249 @@ +{-# LANGUAGE TypeFamilies, DataKinds, MultiParamTypeClasses, PolyKinds, TypeApplications, ScopedTypeVariables, ConstraintKinds, TypeOperators, GADTs, UndecidableInstances, StandaloneDeriving, FunctionalDependencies, FlexibleContexts, AllowAmbiguousTypes #-} +{-| +Module: IHP.FetchRelated +Description: Provides fetchRelated, collectionFetchRelated, etc. +Copyright: (c) digitally induced GmbH, 2020 + +This modules provides helper functions to access relationshops for a model. + +See https://ihp.digitallyinduced.com/Guide/relationships.html for some examples. +-} +module IHP.FetchRelated (fetchRelated, collectionFetchRelated, collectionFetchRelatedOrNothing, fetchRelatedOrNothing, maybeFetchRelatedOrNothing) where + +import IHP.Prelude +import Database.PostgreSQL.Simple.ToField +import qualified Database.PostgreSQL.Simple as PG +import IHP.ModelSupport (Include, Id', PrimaryKey, GetModelByTableName, Table) +import IHP.QueryBuilder +import IHP.Fetch + +-- | This class provides the collectionFetchRelated function +-- +-- This function is provided by this class as we have to deal with two cases: +-- +-- 1. the related field is a id, e.g. like the company ids in @users |> collectionFetchRelated #companyId@ +-- 2. the related field is a query builder, e.g. in @posts |> collectionFetchRelated #comments@ +class CollectionFetchRelated relatedFieldValue relatedModel where + collectionFetchRelated :: forall model relatedField. ( + ?modelContext :: ModelContext, + HasField relatedField model relatedFieldValue, + UpdateField relatedField model (Include relatedField model) relatedFieldValue (FetchResult relatedFieldValue relatedModel), + Fetchable relatedFieldValue relatedModel, + KnownSymbol (GetTableName relatedModel), + PG.FromRow relatedModel, + KnownSymbol relatedField + ) => Proxy relatedField -> [model] -> IO [Include relatedField model] + +-- | This class provides the collectionFetchRelatedOrNothing function +-- +-- This function is provided by this class as we have to deal with two cases: +-- +-- 1. the related field is an id, e.g. like the company ids in @users |> collectionFetchRelated #companyId@ +-- 2. the related field is a query builder, e.g. in @posts |> collectionFetchRelated #comments@ +class CollectionFetchRelatedOrNothing relatedFieldValue relatedModel where + collectionFetchRelatedOrNothing :: forall model relatedField. ( + ?modelContext :: ModelContext, + HasField relatedField model (Maybe relatedFieldValue), + UpdateField relatedField model (Include relatedField model) (Maybe relatedFieldValue) (Maybe (FetchResult relatedFieldValue relatedModel)), + Fetchable relatedFieldValue relatedModel, + KnownSymbol (GetTableName relatedModel), + PG.FromRow relatedModel, + KnownSymbol relatedField + ) => Proxy relatedField -> [model] -> IO [Include relatedField model] + +-- | Provides collectionFetchRelated for ids, e.g. @collectionFetchRelated #companyId@ +-- +-- When we want to fetch all the users with their companies, we can use collectionFetchRelated like this: +-- +-- > users <- query @User +-- > |> fetch +-- > >>= collectionFetchRelated #companyId +-- +-- This will query all users with their company. The type of @users@ is @[Include "companyId" User]@. +-- +-- This example will trigger only two SQL queries: +-- +-- > SELECT * FROM users +-- > SELECT * FROM companies WHERE id IN (?) +instance ( + Eq (PrimaryKey tableName) + , ToField (PrimaryKey tableName) + , Show (PrimaryKey tableName) + , HasField "id" relatedModel (Id' tableName) + , relatedModel ~ GetModelByTableName (GetTableName relatedModel) + , GetTableName relatedModel ~ tableName + , Table relatedModel + ) => CollectionFetchRelated (Id' tableName) relatedModel where + collectionFetchRelated :: forall model relatedField. ( + ?modelContext :: ModelContext, + HasField relatedField model (Id' tableName), + UpdateField relatedField model (Include relatedField model) (Id' tableName) (FetchResult (Id' tableName) relatedModel), + Fetchable (Id' tableName) relatedModel, + KnownSymbol (GetTableName relatedModel), + PG.FromRow relatedModel, + KnownSymbol relatedField, + Table relatedModel + ) => Proxy relatedField -> [model] -> IO [Include relatedField model] + collectionFetchRelated relatedField model = do + relatedModels :: [relatedModel] <- query @relatedModel |> filterWhereIdIn (map (getField @relatedField) model) |> fetch + let + assignRelated :: model -> Include relatedField model + assignRelated model = + let + relatedModel :: relatedModel + relatedModel = case find (\r -> r.id == targetForeignKey) relatedModels of + Just m -> m + Nothing -> error ("Could not find record with id = " <> show targetForeignKey <> " in result set. Looks like the foreign key is pointing to a non existing record") + targetForeignKey = (getField @relatedField model :: Id' tableName) + in + updateField @relatedField relatedModel model + + let + result :: [Include relatedField model] + result = map assignRelated model + pure result + +-- | Provides collectionFetchRelatedOrNothing for nullable ids, e.g. @collectionFetchRelatedOrNothing #companyId@ +-- +-- When we want to fetch all the users with their companies, we can use collectionFetchRelatedOrNothing like this: +-- +-- > users <- query @User +-- > |> fetch +-- > >>= collectionFetchRelatedOrNothing #companyId +-- +-- This will query all users with their company. The type of @users@ is @[Include "companyId" User]@. +-- +-- This example will trigger only two SQL queries: +-- +-- > SELECT * FROM users +-- > SELECT * FROM companies WHERE id IN (?) +instance ( + Eq (PrimaryKey tableName) + , ToField (PrimaryKey tableName) + , HasField "id" relatedModel (Id' tableName) + , relatedModel ~ GetModelByTableName (GetTableName relatedModel) + , GetTableName relatedModel ~ tableName + , Table relatedModel + ) => CollectionFetchRelatedOrNothing (Id' tableName) relatedModel where + collectionFetchRelatedOrNothing :: forall model relatedField. ( + ?modelContext :: ModelContext, + HasField relatedField model (Maybe (Id' tableName)), + UpdateField relatedField model (Include relatedField model) (Maybe (Id' tableName)) (Maybe (FetchResult (Id' tableName) relatedModel)), + Fetchable (Id' tableName) relatedModel, + KnownSymbol (GetTableName relatedModel), + PG.FromRow relatedModel, + KnownSymbol relatedField + ) => Proxy relatedField -> [model] -> IO [Include relatedField model] + collectionFetchRelatedOrNothing relatedField model = do + relatedModels :: [relatedModel] <- query @relatedModel |> filterWhereIdIn (mapMaybe (getField @relatedField) model) |> fetch + let + assignRelated :: model -> Include relatedField model + assignRelated model = + let + relatedModel :: Maybe (FetchResult (Id' tableName) relatedModel) + relatedModel = find (\r -> Just r.id == targetForeignKey) relatedModels + targetForeignKey = (getField @relatedField model :: Maybe (Id' tableName)) + in + updateField @relatedField relatedModel model + + let + result :: [Include relatedField model] + result = map assignRelated model + pure result + +-- | Provides collectionFetchRelated for QueryBuilder's, e.g. @collectionFetchRelated #comments@ +-- +-- When we want to fetch all the comments for a list of posts, we can use collectionFetchRelated like this: +-- +-- > posts <- query @Post +-- > |> fetch +-- > >>= collectionFetchRelated #comments +-- +-- This will query all posts with their comments. The type of @posts@ is @[Include "comments" Post]@. +-- +-- When fetching query builders, currently the implementation is not very efficient. E.g. given 10 Posts above, it will run 10 queries to fetch the comments. We should optimise this behavior in the future. +instance (relatedModel ~ GetModelByTableName relatedTable, Table relatedModel) => CollectionFetchRelated (QueryBuilder relatedTable) relatedModel where + collectionFetchRelated :: forall model relatedField. ( + ?modelContext :: ModelContext, + HasField relatedField model (QueryBuilder relatedTable), + UpdateField relatedField model (Include relatedField model) (QueryBuilder relatedTable) (FetchResult (QueryBuilder relatedTable) relatedModel), + Fetchable (QueryBuilder relatedTable) relatedModel, + KnownSymbol (GetTableName relatedModel), + PG.FromRow relatedModel, + KnownSymbol relatedField + ) => Proxy relatedField -> [model] -> IO [Include relatedField model] + collectionFetchRelated relatedField models = do + let fetchRelated model = do + let queryBuilder :: QueryBuilder relatedTable = getField @relatedField model + result :: [relatedModel] <- fetch queryBuilder + pure (updateField @relatedField result model) + mapM fetchRelated models + +-- Fetches a related record +-- +-- Given a specific post, we can fetch the post and all its comments like this: +-- +-- > let postId :: Id Post = ... +-- > +-- > post <- fetch postId +-- > >>= fetchRelated #comments +-- +-- This Haskell code will trigger the following SQL queries to be executed: +-- +-- > SELECT posts.* FROM posts WHERE id = ? LIMIT 1 +-- > SELECT comments.* FROM comments WHERE post_id = ? +-- +-- In the view we can just access the comments like this: +-- +-- > [hsx| +-- >

    {post.title}

    +-- >

    Comments:

    +-- > {post.comments} +-- > |] +-- +-- The @post.comments@ returns a list of the comments belonging to the post. +-- The type of post is @Include "comments"@ Post instead of the usual @Post@. This way the state of a fetched nested resource is tracked at the type level. +-- +fetchRelated :: forall model field fieldValue fetchModel. ( + ?modelContext :: ModelContext, + UpdateField field model (Include field model) fieldValue (FetchResult fieldValue fetchModel), + HasField field model fieldValue, + PG.FromRow fetchModel, + KnownSymbol (GetTableName fetchModel), + Fetchable fieldValue fetchModel, + Table fetchModel + ) => Proxy field -> model -> IO (Include field model) +fetchRelated relatedField model = do + result :: FetchResult fieldValue fetchModel <- fetch ((getField @field model) :: fieldValue) + let model' = updateField @field result model + pure model' +{-# INLINE fetchRelated #-} + +fetchRelatedOrNothing :: forall model field fieldValue fetchModel. ( + ?modelContext :: ModelContext, + UpdateField field model (Include field model) (Maybe fieldValue) (Maybe (FetchResult fieldValue fetchModel)), + HasField field model (Maybe fieldValue), + PG.FromRow fetchModel, + KnownSymbol (GetTableName fetchModel), + Fetchable fieldValue fetchModel, + Table fetchModel + ) => Proxy field -> model -> IO (Include field model) +fetchRelatedOrNothing relatedField model = do + result :: Maybe (FetchResult fieldValue fetchModel) <- case getField @field model of + Just fieldValue -> Just <$> fetch fieldValue + Nothing -> pure Nothing + let model' = updateField @field result model + pure model' +{-# INLINE fetchRelatedOrNothing #-} + +maybeFetchRelatedOrNothing :: forall model field fieldValue fetchModel. ( + ?modelContext :: ModelContext, + UpdateField field model (Include field model) (Maybe fieldValue) (Maybe (FetchResult fieldValue fetchModel)), + HasField field model (Maybe fieldValue), + PG.FromRow fetchModel, + KnownSymbol (GetTableName fetchModel), + Fetchable fieldValue fetchModel, + Table fetchModel + ) => Proxy field -> Maybe model -> IO (Maybe (Include field model)) +maybeFetchRelatedOrNothing relatedField = maybe (pure Nothing) (\q -> fetchRelatedOrNothing relatedField q >>= pure . Just) +{-# INLINE maybeFetchRelatedOrNothing #-} diff --git a/IHP/FileStorage/Config.hs b/IHP/FileStorage/Config.hs new file mode 100644 --- /dev/null +++ b/IHP/FileStorage/Config.hs @@ -0,0 +1,134 @@ +{-| +Module: IHP.FileStorage.Config +Description: Helpers for Config.hs to set up the File Storage +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.FileStorage.Config +( initS3Storage +, initStaticDirStorage +, initMinioStorage +, initFilebaseStorage +) where + +import IHP.Prelude +import IHP.FileStorage.Types +import IHP.FrameworkConfig + +import Network.Minio + +import qualified Control.Monad.Trans.State.Strict as State +import qualified Data.TMap as TMap +import Control.Monad.Trans.Maybe +import qualified IHP.EnvVar as EnvVar + +-- | The AWS access key and secret key have to be provided using the @AWS_ACCESS_KEY_ID@ and @AWS_SECRET_ACCESS_KEY@ env vars. +-- +-- __Example:__ Set up a s3 storage in @Config.hs@ +-- +-- > module Config where +-- > +-- > import IHP.Prelude +-- > import IHP.Environment +-- > import IHP.FrameworkConfig +-- > import IHP.FileStorage.Config +-- > +-- > config :: ConfigBuilder +-- > config = do +-- > option Development +-- > option (AppHostname "localhost") +-- > initS3Storage "eu-central-1" "my-bucket-name" +-- +initS3Storage :: HasCallStack => Text -> Text -> State.StateT TMap.TMap IO () +initS3Storage region bucket = do + connectInfo <- awsCI + |> setRegion region + |> setCredsFrom [fromAWSEnv] + |> configIO + + let baseUrl = "https://" <> bucket <> ".s3." <> region <> ".amazonaws.com/" + option S3Storage { connectInfo, bucket, baseUrl } + +-- | The Minio access key and secret key have to be provided using the @MINIO_ACCESS_KEY@ and @MINIO_SECRET_KEY@ env vars. +-- +-- __Example:__ Set up a minio storage in @Config.hs@ +-- +-- > module Config where +-- > +-- > import IHP.Prelude +-- > import IHP.Environment +-- > import IHP.FrameworkConfig +-- > import IHP.FileStorage.Config +-- > +-- > config :: ConfigBuilder +-- > config = do +-- > option Development +-- > option (AppHostname "localhost") +-- > initMinioStorage "https://minio.example.com" "my-bucket-name" +-- +initMinioStorage :: HasCallStack => Text -> Text -> State.StateT TMap.TMap IO () +initMinioStorage server bucket = do + connectInfo <- server + |> cs + |> fromString + |> setCredsFrom [fromMinioEnv] + |> configIO + + let baseUrl = server <> "/" <> bucket <> "/" + option S3Storage { connectInfo, bucket, baseUrl } + +-- | Stores files publicly visible inside the @static@ directory +-- +-- __Example:__ Store uploaded files in the @static/@ directory +-- +-- > module Config where +-- > +-- > import IHP.Prelude +-- > import IHP.Environment +-- > import IHP.FrameworkConfig +-- > import IHP.FileStorage.Config +-- > +-- > config :: ConfigBuilder +-- > config = do +-- > option Development +-- > option (AppHostname "localhost") +-- > initStaticDirStorage +-- +initStaticDirStorage :: State.StateT TMap.TMap IO () +initStaticDirStorage = do + directory <- EnvVar.envOrDefault "IHP_STORAGE_DIR" "static/" + option StaticDirStorage { directory } + +-- | The Filebase access key and secret key have to be provided using the @FILEBASE_KEY@ and @FILEBASE_SECRET@ env vars. +-- +-- __Example:__ Set up a Filebase storage in @Config.hs@ +-- +-- > module Config where +-- > +-- > import IHP.Prelude +-- > import IHP.Environment +-- > import IHP.FrameworkConfig +-- > import IHP.FileStorage.Config +-- > +-- > config :: ConfigBuilder +-- > config = do +-- > option Development +-- > option (AppHostname "localhost") +-- > initFilebaseStorage "my-bucket-name" +-- +initFilebaseStorage :: HasCallStack => Text -> State.StateT TMap.TMap IO () +initFilebaseStorage bucket = do + connectInfo <- filebaseCI + |> setCredsFrom [fromFilebaseEnv] + |> configIO + + let baseUrl = "https://" <> bucket <> ".s3.filebase.com/" + option S3Storage { connectInfo, bucket, baseUrl } + +filebaseCI :: ConnectInfo +filebaseCI = "https://s3.filebase.com" |> setRegion "us-east-1" + +fromFilebaseEnv :: CredentialLoader +fromFilebaseEnv = runMaybeT $ do + filebaseKey <- MaybeT $ EnvVar.envOrNothing "FILEBASE_KEY" + filebaseSecret <- MaybeT $ EnvVar.envOrNothing "FILEBASE_SECRET" + pure CredentialValue { cvAccessKey = fromString filebaseKey, cvSecretKey = fromString filebaseSecret, cvSessionToken = Nothing } diff --git a/IHP/FileStorage/ControllerFunctions.hs b/IHP/FileStorage/ControllerFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/FileStorage/ControllerFunctions.hs @@ -0,0 +1,429 @@ +{-| +Module: IHP.FileStorage.ControllerFunctions +Description: Store uploaded files +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.FileStorage.ControllerFunctions +( storeFile +, removeFileFromStorage +, storeFileWithOptions +, storeFileFromUrl +, storeFileFromPath +, contentDispositionAttachmentAndFileName +, createTemporaryDownloadUrl +, createTemporaryDownloadUrlFromPath +, createTemporaryDownloadUrlFromPathWithExpiredAt +, refreshTemporaryDownloadUrlFromFile +, uploadToStorage +, uploadToStorageWithOptions +, storage +, storagePrefix +) where + +import IHP.Prelude +import IHP.FileStorage.Types +import IHP.Controller.Context +import IHP.Controller.FileUpload +import IHP.FrameworkConfig +import qualified IHP.ModelSupport as ModelSupport +import IHP.ValidationSupport + +import Network.Minio +import qualified Data.Conduit.Binary as Conduit +import qualified Network.Wai.Parse as Wai + +import qualified Data.UUID as UUID +import qualified Data.UUID.V4 as UUID +import qualified Data.TMap as TMap +import qualified Data.Text as Text +import qualified Data.ByteString.Lazy as LBS +import qualified System.Directory as Directory +import qualified Control.Exception.Safe as Exception +import qualified Network.Wreq as Wreq +import Control.Lens hiding ((|>), set) +import qualified Network.Mime as Mime + +-- | Uploads a file to a directory in the storage +-- +-- See 'storeFileWithOptions' for more advanced use cases. +-- +-- __Example:__ Save a file upload by the user to the storage +-- +-- > action UpdateLogoAction = do +-- > let file = fileOrNothing "file" +-- > |> fromMaybe (error "No file given") +-- > +-- > storedFile <- storeFile file "logos" +-- > +-- > let url = storedFile.url +-- > +-- +storeFile :: (?context :: context, ConfigProvider context) => Wai.FileInfo LByteString -> Text -> IO StoredFile +storeFile fileInfo directory = storeFileWithOptions fileInfo (def { directory }) + + +-- | Like 'storeFile' but with more options. +-- +-- See 'storeFileWithOptions' for more advanced use cases. +-- +-- __Example:__ Save a file to @my_files@ directory and specify a 'Content-Disposition: attachment; filename="$filename"' header +-- +-- > let file = fileOrNothing "file" |> fromMaybe (error "no file given") +-- > +-- > let options :: StoreFileOptions = def +-- > { directory = "my_files" +-- > , contentDisposition = contentDispositionAttachmentAndFileName +-- > } +-- > +-- > storedFile <- storeFileWithOptions file options +-- > let url = storedFile.url +-- +-- +-- __Example:__ Transform an uploaded image to a JPEG file, strip meta data and store it inside the @pictures@ directory +-- +-- > let file = fileOrNothing "file" |> fromMaybe (error "no file given") +-- > +-- > let options :: StoreFileOptions = def +-- > { directory = "pictures" +-- > , preprocess = applyImageMagick "jpg" "-strip" +-- > } +-- > +-- > storedFile <- storeFileWithOptions file options +-- > let url = storedFile.url +-- +storeFileWithOptions :: (?context :: context, ConfigProvider context) => Wai.FileInfo LByteString -> StoreFileOptions -> IO StoredFile +storeFileWithOptions fileInfo options = do + objectId <- UUID.nextRandom + + let fileName = options.fileName |> fromMaybe objectId + + let objectPath = options.directory <> "/" <> UUID.toText fileName + let preprocess = options.preprocess + + fileInfo <- preprocess fileInfo + + url <- case storage of + StaticDirStorage { directory } -> do + let destPath :: Text = directory <> objectPath + Directory.createDirectoryIfMissing True (cs $ directory <> options.directory) + + fileInfo + |> (.fileContent) + |> LBS.writeFile (cs destPath) + + let frameworkConfig = ?context.frameworkConfig + -- Prefix with a slash so it can be used in URLs, even if the baseUrl is empty. + pure $ "/" <> objectPath + S3Storage { connectInfo, bucket, baseUrl } -> do + let payload = fileInfo + |> (.fileContent) + |> Conduit.sourceLbs + + let contentType = cs (Wai.fileContentType fileInfo) + contentDisposition <- (options.contentDisposition) fileInfo + trySaveFile <- runMinio connectInfo do + let options :: PutObjectOptions = defaultPutObjectOptions { pooContentType = Just contentType, pooContentDisposition = contentDisposition } + putObject bucket objectPath payload Nothing options + case trySaveFile of + Left e -> throw e + Right _ -> pure () + + pure $ baseUrl <> objectPath + + pure StoredFile { path = objectPath, url } + +-- | Fetches an url and uploads it to the storage. +-- +-- The stored file has the content type provided by @Content-Type@ header of the downloaded file. +-- +-- __Example:__ Copy a file from a remote server to the @pictures@ directory +-- +-- > let externalUrl = "http://example/picture.jpg" +-- > +-- > let options :: StoreFileOptions = def +-- > { directory = "pictures" +-- > } +-- > +-- > storedFile <- storeFileFromUrl externalUrl options +-- > let newUrl = storedFile.url +-- +storeFileFromUrl :: (?context :: context, ConfigProvider context) => Text -> StoreFileOptions -> IO StoredFile +storeFileFromUrl url options = do + (contentType, responseBody) <- do + response <- Wreq.get (cs url) + let contentType = response ^. Wreq.responseHeader "Content-Type" + let responseBody = response ^. Wreq.responseBody + pure (contentType, responseBody) + + let file = Wai.FileInfo + { fileName = "" + , fileContentType = contentType + , fileContent = responseBody + } + + storeFileWithOptions file options + + +-- | Uploads a local file to the storage +-- +-- The content type is guessed based on the file extension. +-- +-- __Example:__ Copy a local "picture.jpg" to the @pictures@ directory inside the storage +-- +-- > +-- > let options :: StoreFileOptions = def +-- > { directory = "pictures" +-- > } +-- > +-- > storedFile <- storeFileFromPath "picture.jpg" options +-- > let newUrl = storedFile.url +-- +storeFileFromPath :: (?context :: context, ConfigProvider context) => Text -> StoreFileOptions -> IO StoredFile +storeFileFromPath path options = do + let fileContentType = Mime.defaultMimeLookup (cs path) + + fileContent <- LBS.readFile (cs path) + + -- If fileName was passed (as UUID), use it. Otherwise, keep it empty, and a new random UUID will be generated. + let fileName = case options.fileName of + Just name -> cs $ UUID.toText name + Nothing -> "" + + let file = Wai.FileInfo + { fileName = fileName + , fileContentType + , fileContent + } + + storeFileWithOptions file options + +-- | Returns a signed url for a path inside the storage. The url is valid for 7 days. +-- +-- If the 'StaticDirStorage' is used, a unsigned normal URL will be returned, as these files are public anyways. +-- +-- __Example:__ Get a signed url for a path +-- +-- > +-- > signedUrl <- createTemporaryDownloadUrlFromPath "logos/8ed22caa-11ea-4c45-a05e-91a51e72558d" +-- > +-- > let url :: Text = signedUrl.url +-- > let expiredAt :: UTCTime = signedUrl.expiredAt +-- +-- See 'createTemporaryDownloadUrlFromPathWithExpiredAt' if you want to customize the url expiration time of 7 days. +-- +createTemporaryDownloadUrlFromPath :: (?context :: context, ConfigProvider context) => Text -> IO TemporaryDownloadUrl +createTemporaryDownloadUrlFromPath objectPath = createTemporaryDownloadUrlFromPathWithExpiredAt (7 * 24 * 3600) objectPath + + +-- | Like 'createTemporaryDownloadUrlFromPath', but with a custom expiration time. Returns a signed url for a path inside the storage. The url is valid for 7 days. +-- +-- If the 'StaticDirStorage' is used, a unsigned normal URL will be returned, as these files are public anyways. +-- +-- __Example:__ Get a signed url for a path that expires in 5 minutes +-- +-- > let validInSeconds = 5 * 60 +-- > signedUrl <- createTemporaryDownloadUrlFromPathWithExpiredAt validInSeconds "logos/8ed22caa-11ea-4c45-a05e-91a51e72558d" +-- > +-- > let url :: Text = signedUrl.url +-- > let expiredAt :: UTCTime = signedUrl.expiredAt +-- +createTemporaryDownloadUrlFromPathWithExpiredAt :: (?context :: context, ConfigProvider context) => Int -> Text -> IO TemporaryDownloadUrl +createTemporaryDownloadUrlFromPathWithExpiredAt validInSeconds objectPath = do + publicUrlExpiredAt <- addUTCTime (fromIntegral validInSeconds) <$> getCurrentTime + case storage of + StaticDirStorage {} -> do + let frameworkConfig = ?context.frameworkConfig + let urlSchemes = ["http://", "https://"] + + let cleanPath = if "/" `isPrefixOf` objectPath + then Text.drop 1 objectPath + else objectPath + + let url = if any (`isPrefixOf` objectPath) urlSchemes + -- Legacy case: full URL saved, use as is. + then objectPath + -- Otherwise, construct full URL using baseUrl and cleaned path. + else frameworkConfig.baseUrl <> "/" <> cleanPath + + pure TemporaryDownloadUrl { url = cs url, expiredAt = publicUrlExpiredAt } + S3Storage { connectInfo, bucket} -> do + + url <- runMinio connectInfo do + presignedGetObjectUrl bucket objectPath validInSeconds [] [] + + case url of + Left message -> error (tshow message) + Right url -> pure TemporaryDownloadUrl { url = cs url, expiredAt = publicUrlExpiredAt } + +-- | Returns a signed url for a 'StoredFile'. The url is valid for 7 days. +-- +-- If the 'StaticDirStorage' is used, a unsigned normal URL will be returned, as these files are public anyways. +-- +-- __Example:__ Get a signed url for a stored file using 'createTemporaryDownloadUrl' +-- +-- > let file = fileOrNothing "file" +-- > |> fromMaybe (error "No file given") +-- > +-- > storedFile <- storeFile file "logos" +-- > +-- > signedUrl <- createTemporaryDownloadUrl storedFile +-- > +-- > let url :: Text = signedUrl.url +-- > let expiredAt :: UTCTime = signedUrl.expiredAt +-- +createTemporaryDownloadUrl :: (?context :: context, ConfigProvider context) => StoredFile -> IO TemporaryDownloadUrl +createTemporaryDownloadUrl storedFile = createTemporaryDownloadUrlFromPath (storedFile.path) + +-- | Use the temporary download URL if the current one is not expired. +-- Otherwise, create a new temporary download URL and update the record. +-- +-- __Example:__ Fetch an 'UploadedFile' record (a custom record with @signedUrl@, @signedUrlExpiredAt@ and @path@ ) and use 'refreshTemporaryDownloadUrlFromFile' +-- to get a fresh signed url if expired date has passed. +-- and update it with the signed url. +-- +-- > uploadedFile <- fetch uploadedFileId +-- > uploadedFile <- refreshTemporaryDownloadUrlFromFile uploadedFile +refreshTemporaryDownloadUrlFromFile :: + ( ?modelContext::ModelContext + , ?context :: context + , ConfigProvider context + , CanUpdate record + , HasField "signedUrl" record Text + , HasField "signedUrlExpiredAt" record UTCTime + , HasField "path" record Text + , SetField "signedUrl" record Text + , SetField "signedUrlExpiredAt" record UTCTime + , SetField "path" record Text + ) => record -> IO record +refreshTemporaryDownloadUrlFromFile record = do + now <- getCurrentTime + let diff = diffUTCTime now record.signedUrlExpiredAt + if diff > 0 + then do + temporaryDownloadUrl <- createTemporaryDownloadUrlFromPath record.path + record + |> set #signedUrl (temporaryDownloadUrl |> get #url) + |> set #signedUrlExpiredAt (temporaryDownloadUrl |> get #expiredAt) + |> updateRecord + + else + pure record + +contentDispositionAttachmentAndFileName :: Wai.FileInfo LByteString -> IO (Maybe Text) +contentDispositionAttachmentAndFileName fileInfo = pure (Just ("attachment; filename=\"" <> cs (fileInfo.fileName) <> "\"")) + +-- | Saves an upload to the storage and sets the record attribute to the url. +-- +-- __Example:__ Upload a logo for a Company and convert it to a 512x512 PNG +-- +-- > action UpdateCompanyAction { companyId } = do +-- > let uploadLogo = uploadToStorageWithOptions $ def +-- > { preprocess = applyImageMagick "png" "-resize '512x512^' -gravity north -extent 512x512 -quality 100% -strip" } +-- > +-- > company <- fetch companyId +-- > company +-- > |> fill @'["name"] +-- > |> uploadLogo #logoUrl +-- > >>= ifValid \case +-- > Left company -> render EditView { .. } +-- > Right company -> do +-- > company <- company |> updateRecord +-- > redirectTo EditCompanyAction { .. } +-- +uploadToStorageWithOptions :: forall (fieldName :: Symbol) record (tableName :: Symbol). ( + ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , KnownSymbol fieldName + , HasField "id" record (ModelSupport.Id (ModelSupport.NormalizeModel record)) + , Show (ModelSupport.PrimaryKey (ModelSupport.GetTableName (ModelSupport.NormalizeModel record))) + , tableName ~ ModelSupport.GetTableName record + , KnownSymbol tableName + , HasField "meta" record MetaBag + , SetField "meta" record MetaBag + ) => StoreFileOptions -> Proxy fieldName -> record -> IO record +uploadToStorageWithOptions options field record = do + let fieldName :: ByteString = cs (symbolVal (Proxy @fieldName)) + let tableName :: Text = cs (symbolVal (Proxy @tableName)) + let directory = tableName <> "/" <> cs fieldName + + case fileOrNothing fieldName of + Just fileInfo -> do + storeFileWithOptions fileInfo options { directory } + |> Exception.try + >>= \case + Left (exception :: SomeException) -> record + |> attachFailure field ("Failed uploading to storage: " <> show exception) + |> pure + Right storedFile -> record + |> setField @fieldName (Just (storedFile.url)) + |> pure + + _ -> pure record + +-- | Saves an upload to the storage and sets the record attribute to the url. +-- +-- Uses the table name of the record as the upload directory (e.g. @companies@ when saving an attachment for a @Company@ record). +-- +-- See 'uploadToStorageWithOptions' if you want to provide custom options. +-- +-- __Example:__ Upload a logo for a Company +-- +-- > action UpdateCompanyAction { companyId } = do +-- > company <- fetch companyId +-- > company +-- > |> fill @'["name"] +-- > |> uploadToStorage #logoUrl +-- > >>= ifValid \case +-- > Left company -> render EditView { .. } +-- > Right company -> do +-- > company <- company |> updateRecord +-- > redirectTo EditCompanyAction { .. } +-- +uploadToStorage :: forall (fieldName :: Symbol) record (tableName :: Symbol). ( + ?context :: ControllerContext + , SetField fieldName record (Maybe Text) + , KnownSymbol fieldName + , HasField "id" record (ModelSupport.Id (ModelSupport.NormalizeModel record)) + , Show (ModelSupport.PrimaryKey (ModelSupport.GetTableName (ModelSupport.NormalizeModel record))) + , tableName ~ ModelSupport.GetTableName record + , KnownSymbol tableName + , HasField "meta" record MetaBag + , SetField "meta" record MetaBag + ) => Proxy fieldName -> record -> IO record +uploadToStorage field record = uploadToStorageWithOptions def field record + +-- | Permanently removes a previously stored file from storage. +-- +-- __Example:__ Delete a previously uploaded file. The objectPath and url are stored in the database in this example. +-- +-- > action DeleteUploadedFileAction { uploadedFileId } = do +-- > uploadedFile <- fetch uploadedFile +-- > let storedFile = StoredFile +-- > { path = uploadedFile.objectPath +-- > , url = uploadedFile.url +-- > } +-- > removeFileFromStorage storedFile +-- > deleteRecord uploadedFile +-- > redirectTo UploadedFilesAction +removeFileFromStorage :: (?context :: context, ConfigProvider context) => StoredFile -> IO (Either MinioErr ()) +removeFileFromStorage StoredFile { path, url } = do + case storage of + StaticDirStorage { directory } -> do + let fullPath :: String = cs $ directory <> path + Directory.removeFile fullPath + pure $ Right () + S3Storage { connectInfo, bucket} -> do + runMinio connectInfo do + removeObject bucket path + +-- | Returns the current storage configured in Config.hs +storage :: (?context :: context, ConfigProvider context) => FileStorage +storage = ?context.frameworkConfig.appConfig + |> TMap.lookup @FileStorage + |> fromMaybe (error "Could not find FileStorage in config. Did you call initS3Storage from your Config.hs?") + +-- | Returns the prefix for the storage. This is either @static/@ or an empty string depending on the storage. +storagePrefix :: (?context :: ControllerContext) => Text +storagePrefix = case storage of + StaticDirStorage { directory } -> directory + S3Storage { baseUrl} -> baseUrl diff --git a/IHP/FileStorage/Preprocessor/ImageMagick.hs b/IHP/FileStorage/Preprocessor/ImageMagick.hs new file mode 100644 --- /dev/null +++ b/IHP/FileStorage/Preprocessor/ImageMagick.hs @@ -0,0 +1,65 @@ +{-| +Module: IHP.FileStorage.Preprocessor.ImageMagick +Description: Preprocessor for images. Requires that you add @imagemagick@ to the @otherDeps@ inside the project's @default.nix. +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.FileStorage.Preprocessor.ImageMagick +( applyImageMagick +) where + +import IHP.Prelude + +import qualified Network.Wai.Parse as Wai +import qualified Data.ByteString.Lazy as LBS +import qualified System.IO.Temp as Temp +import qualified System.Process as Process + + +-- | Converts the image to the specified output format and applies specified image magick transforms +-- +-- __Example:__ Transform an uploaded image to a PNG file, resize it to 512x512 and strip meta data +-- +-- > let uploadLogo = uploadToStorageWithOptions $ def +-- > { preprocess = applyImageMagick "png" ["-resize", "512x512^", "-gravity", "north", "-extent" , "512x512", "-quality", "100%", "-strip"] } +-- > +-- > company <- fetch companyId +-- > company +-- > |> fill @'["name"] +-- > |> uploadLogo #logoUrl +-- > >>= ifValid \case +-- > Left company -> render EditView { .. } +-- > Right company -> do +-- > company <- company |> updateRecord +-- > redirectTo EditCompanyAction { .. } +-- +-- +-- __Example:__ Transform an uploaded image to a JPEG file and strip meta data +-- +-- > let uploadLogo = uploadToStorageWithOptions $ def +-- > { preprocess = applyImageMagick "jpg" ["-strip"] } +-- > +-- > company <- fetch companyId +-- > company +-- > |> fill @'["name"] +-- > |> uploadLogo #logoUrl +-- > >>= ifValid \case +-- > Left company -> render EditView { .. } +-- > Right company -> do +-- > company <- company |> updateRecord +-- > redirectTo EditCompanyAction { .. } +-- +applyImageMagick :: Text -> [String] -> Wai.FileInfo LByteString -> IO (Wai.FileInfo LByteString) +applyImageMagick convertTo otherParams fileInfo = do + Temp.withTempDirectory "/tmp" "ihp-upload" $ \tempPath -> do + let tempFilePath = tempPath <> "/image" + let convertedFilePath = tempPath <> "/converted." <> cs convertTo + + fileInfo + |> (.fileContent) + |> LBS.writeFile tempFilePath + + let params :: [String] = [tempFilePath] <> otherParams <> [convertedFilePath] + Process.callProcess "magick" params + + newContent <- LBS.readFile convertedFilePath + pure fileInfo { Wai.fileContent = newContent } diff --git a/IHP/FileStorage/Types.hs b/IHP/FileStorage/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/FileStorage/Types.hs @@ -0,0 +1,40 @@ +{-| +Module: IHP.FileStorage.Types +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.FileStorage.Types +( FileStorage (..) +, StoredFile (..) +, StoreFileOptions (..) +, TemporaryDownloadUrl (..) +) where + +import IHP.Prelude +import qualified Network.Minio as Minio +import qualified Network.Wai.Parse as Wai + +data FileStorage + = StaticDirStorage { directory :: !Text } -- ^ Stores files publicly visible inside the project's @static@ directory + | S3Storage { connectInfo :: Minio.ConnectInfo, bucket :: Text, baseUrl :: Text } -- ^ Stores files inside a S3 compatible cloud storage + +-- | Result of a 'storeFile' operation +data StoredFile = StoredFile { path :: Text, url :: Text } + +-- | Options that can be passed to 'storeFileWithOptions' +data StoreFileOptions = StoreFileOptions + { directory :: Text -- ^ Directory on S3 or inside the @static@ where all files are placed + , contentDisposition :: Wai.FileInfo LByteString -> IO (Maybe Text) -- ^ The browser uses the content disposition header to detect if the file should be shown inside the browser or should be downloaded as a file attachment. You can provide a function here that returns a custom content-disposition header based on the uploaded file. This currently only works with the S3 storage. See 'contentDispositionAttachmentAndFileName' for standard configuration. + , preprocess :: Wai.FileInfo LByteString -> IO (Wai.FileInfo LByteString) -- ^ Can be used to preprocess the file before storing it inside the storage. See 'applyImageMagick' for preprocessing images. + , fileName :: Maybe UUID -- ^ Optional filename. We use UUID for security reasons. + } + +instance Default StoreFileOptions where + def = StoreFileOptions + { directory = "" + , contentDisposition = const (pure Nothing) + , preprocess = pure + , fileName = Nothing + } + +-- | A signed url to a file. See 'createTemporaryDownloadUrl' +data TemporaryDownloadUrl = TemporaryDownloadUrl { url :: Text, expiredAt :: UTCTime } diff --git a/IHP/FlashMessages/ControllerFunctions.hs b/IHP/FlashMessages/ControllerFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/FlashMessages/ControllerFunctions.hs @@ -0,0 +1,70 @@ +{-| +Module: IHP.FlashMessages.ControllerFunctions +Description: Success and error messages for your application +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.FlashMessages.ControllerFunctions where + +import IHP.Prelude +import IHP.FlashMessages.Types +import IHP.Controller.Context +import IHP.Controller.Session +import qualified Data.Maybe as Maybe + +-- | Sets a flash messages. This is shown to the user when the next view is rendered. +-- +-- Will be rendered in a bootstrap alert, with the @alert-success@ styling. +-- Take a look at https://getbootstrap.com/docs/4.5/components/alerts/ for how this will look like. +-- +-- This requires 'IHP.ViewSupport.renderFlashMessages' to be placed somewhere in the layout or page of the next view. +-- For example: +-- +-- > myLayout view = [hsx| +-- > {renderFlashMessages} +-- >
    {view}
    +-- > |] +setSuccessMessage :: (?context :: ControllerContext) => Text -> IO () +setSuccessMessage = setSession successMessageKey + +-- | Sets a flash messages. This is shown to the user when the next view is rendered. +-- +-- Will be rendered in a bootstrap alert, with the @alert-danger@ styling. +-- Take a look at https://getbootstrap.com/docs/4.5/components/alerts/ for how this will look like. +-- +-- This requires 'IHP.ViewSupport.renderFlashMessages' to be placed somewhere in the layout or page of the next view. +-- For example: +-- +-- > myLayout view = [hsx| +-- > {renderFlashMessages} +-- >
    {view}
    +-- > |] +setErrorMessage :: (?context :: ControllerContext) => Text -> IO () +setErrorMessage = setSession errorMessageKey + +-- | Returns the flash message currently set +getSuccessMessage :: (?context :: ControllerContext) => IO (Maybe Text) +getSuccessMessage = getSession successMessageKey + +-- | Removes the current flash message +clearSuccessMessage :: (?context :: ControllerContext) => IO () +clearSuccessMessage = setSession successMessageKey ("" :: Text) + +-- Returns a list of all flash messages which need to be displayed to the user +-- +-- Then clears the flash messages so they won't be displayed again. +getAndClearFlashMessages :: (?context :: ControllerContext) => IO [FlashMessage] +getAndClearFlashMessages = do + successMessage <- getSessionAndClear successMessageKey + errorMessage <- getSessionAndClear errorMessageKey + pure $ Maybe.catMaybes ((fmap SuccessFlashMessage successMessage):(fmap ErrorFlashMessage errorMessage):[]) + +successMessageKey :: ByteString +successMessageKey = "flashSuccessMessage" + +errorMessageKey :: ByteString +errorMessageKey = "flashErrorMessage" + +initFlashMessages :: (?context :: ControllerContext) => IO () +initFlashMessages = do + flashMessages <- getAndClearFlashMessages + putContext flashMessages diff --git a/IHP/FlashMessages/Types.hs b/IHP/FlashMessages/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/FlashMessages/Types.hs @@ -0,0 +1,13 @@ +{-| +Module: IHP.FlashMessages.Types +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.FlashMessages.Types +( FlashMessage (..) +) where + +import IHP.Prelude + +data FlashMessage + = SuccessFlashMessage !Text + | ErrorFlashMessage !Text diff --git a/IHP/FlashMessages/ViewFunctions.hs b/IHP/FlashMessages/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/FlashMessages/ViewFunctions.hs @@ -0,0 +1,41 @@ +{-| +Module: IHP.FlashMessages.ViewFunctions +Description: Success and error messages for your application +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.FlashMessages.ViewFunctions where + +import IHP.FlashMessages.Types +import qualified Text.Blaze.Html5 as Html5 +import IHP.ViewSupport +import IHP.View.Types +import IHP.Controller.Context + + +-- | Displays the flash messages for the current request. +-- +-- You can add a flash message to the next request by calling 'IHP.FlashMessages.ControllerFunctions.setSuccessMessage' or 'IHP.FlashMessages.ControllerFunctions.setErrorMessage': +-- +-- > action CreateProjectAction = do +-- > ... +-- > setSuccessMessage "Your project has been created successfully" +-- > redirectTo ShowProjectAction { .. } +-- +-- +-- > action CreateTeamAction = do +-- > unless userOnPaidPlan do +-- > setErrorMessage "This requires you to be on the paid plan" +-- > redirectTo NewTeamAction +-- > +-- > ... +-- +-- For success messages, the text message is wrapped in a @
    ...
    @, which is automatically styled by bootstrap. +-- Errors flash messages are wraped in @
    ...
    @. +renderFlashMessages :: (?context :: ControllerContext) => Html5.Html +renderFlashMessages = render flashMessages + where + flashMessages :: [FlashMessage] + flashMessages = fromFrozenContext + + render :: [FlashMessage] -> Html5.Html + render = fromCSSFramework #styledFlashMessages diff --git a/IHP/FrameworkConfig.hs b/IHP/FrameworkConfig.hs new file mode 100644 --- /dev/null +++ b/IHP/FrameworkConfig.hs @@ -0,0 +1,520 @@ +{-# LANGUAGE ConstraintKinds #-} +module IHP.FrameworkConfig where + +import IHP.Prelude +import System.Directory (getCurrentDirectory) +import IHP.Environment +import qualified Data.Text as Text +import qualified Network.Wai.Middleware.RequestLogger as RequestLogger +import qualified Web.Cookie as Cookie +import IHP.Mail.Types +import qualified Control.Monad.Trans.State.Strict as State +import qualified Data.TMap as TMap +import qualified Data.Typeable as Typeable +import IHP.View.Types +import IHP.View.CSSFramework +import IHP.Log.Types +import IHP.Log (makeRequestLogger, defaultRequestLogger) +import Network.Wai +import qualified Network.Wai.Handler.Warp as Warp +import qualified Network.Wai.Middleware.Cors as Cors +import qualified Network.Wai.Parse as WaiParse +import qualified Control.Exception as Exception +import IHP.ModelSupport +import IHP.EnvVar + +import qualified Prelude +import qualified GHC.Stack as Stack + +import qualified Control.Concurrent as Concurrent + +newtype AppHostname = AppHostname Text +newtype AppPort = AppPort Int +newtype BaseUrl = BaseUrl Text + +-- | Provides IHP with a middleware to log requests and responses. +-- +-- By default this uses the RequestLogger middleware from wai-extra. Take a look at the wai-extra +-- documentation when you want to customize the request logging. +-- +-- See https://hackage.haskell.org/package/wai-extra-3.0.29.2/docs/Network-Wai-Middleware-RequestLogger.html +-- +-- +-- Set @requestLoggerMiddleware = \application -> application@ to disable request logging. +newtype RequestLoggerMiddleware = RequestLoggerMiddleware Middleware + +-- | Provides the default settings for the session cookie. +-- +-- - Max Age: 30 days +-- - Same Site Policy: Lax +-- - HttpOnly (no access through JS) +-- - secure, when baseUrl is a https url +-- +-- Override this to set e.g. a custom max age or change the default same site policy. +-- +-- __Example: Set max age to 90 days__ +-- > sessionCookie = defaultIHPSessionCookie { Cookie.setCookieMaxAge = Just (fromIntegral (60 * 60 * 24 * 90)) } +newtype SessionCookie = SessionCookie Cookie.SetCookie + +-- | How long db connection are kept alive inside the connecton pool when they're idle +newtype DBPoolIdleTime = DBPoolIdleTime NominalDiffTime + +-- | Max number of db connections the connection pool can open to the database +newtype DBPoolMaxConnections = DBPoolMaxConnections Int + +newtype DatabaseUrl = DatabaseUrl ByteString + +type ConfigBuilder = State.StateT TMap.TMap IO () + +-- | Interface for exception tracking services such as sentry +newtype ExceptionTracker = ExceptionTracker { onException :: Maybe Request -> SomeException -> IO () } + +-- | Typically "http://localhost:8001", Url where the IDE is running +newtype IdeBaseUrl = IdeBaseUrl Text + +-- | Postgres role to be used for making queries with Row level security enabled +newtype RLSAuthenticatedRole = RLSAuthenticatedRole Text + +newtype AssetVersion = AssetVersion Text + +newtype CustomMiddleware = CustomMiddleware Middleware + +newtype DataSyncMaxSubscriptionsPerConnection = DataSyncMaxSubscriptionsPerConnection Int +newtype DataSyncMaxTransactionsPerConnection = DataSyncMaxTransactionsPerConnection Int + +newtype Initializer = Initializer { onStartup :: (?context :: FrameworkConfig, ?modelContext :: ModelContext) => IO () } + +-- | Puts an option into the current configuration +-- +-- In case an option already exists with the same type, it will not be overriden: +-- +-- > option Production +-- > option Development +-- > findOption @Environment +-- +-- This code will return 'Production' as the second call to 'option' is ignored to not override the existing option. +option :: forall option. Typeable option => option -> State.StateT TMap.TMap IO () +option !value = State.modify (\map -> if TMap.member @option map then map else TMap.insert value map) +{-# INLINABLE option #-} + +-- | Adds a callback to be run during startup of the app server +-- +-- The follwoing example will print a hello world message on startup: +-- +-- > config = do +-- > addInitializer (putStrLn "Hello World!") +-- +addInitializer :: ((?context :: FrameworkConfig, ?modelContext :: ModelContext) => IO ()) -> State.StateT TMap.TMap IO () +addInitializer onStartup = do + initializers <- fromMaybe [] <$> findOptionOrNothing @[Initializer] + let newInitializers = initializers <> [Initializer { onStartup }] + State.modify (\map -> map + |> TMap.delete @[Initializer] + |> TMap.insert newInitializers + ) + +ihpDefaultConfig :: ConfigBuilder +ihpDefaultConfig = do + ihpEnv <- envOrDefault "IHP_ENV" Development + option ihpEnv + + option $ AppHostname "localhost" + + port :: AppPort <- envOrDefault "PORT" (AppPort defaultPort) + option port + + option $ ExceptionTracker Warp.defaultOnException + + environment <- findOption @Environment + + defaultLogger <- configIO (defaultLoggerForEnv environment) + option defaultLogger + logger <- findOption @Logger + + requestLoggerIpAddrSource <- envOrDefault "IHP_REQUEST_LOGGER_IP_ADDR_SOURCE" RequestLogger.FromSocket + + reqLoggerMiddleware <- configIO $ + case environment of + Development -> do + reqLogger <- (logger |> defaultRequestLogger) + pure (RequestLoggerMiddleware reqLogger) + Production -> do + reqLogger <- (logger |> makeRequestLogger def { RequestLogger.outputFormat = RequestLogger.Apache requestLoggerIpAddrSource }) + pure (RequestLoggerMiddleware reqLogger) + + + option $ reqLoggerMiddleware + + option $ defaultCorsResourcePolicy + + option $ Sendmail + + databaseUrl <- configIO defaultDatabaseUrl + + option $ DatabaseUrl databaseUrl + option $ DBPoolIdleTime $ + case environment of + Development -> 2 + Production -> 60 + + -- poolMaxResources must not be smaller than numStripes + -- https://github.com/digitallyinduced/ihp/issues/1959 + numCapabilities <- configIO Concurrent.getNumCapabilities + option $ DBPoolMaxConnections (max numCapabilities 20) + + (AppPort port) <- findOption @AppPort + + -- The IHP_BASEURL env var can override the hardcoded base url in Config.hs + ihpBaseUrlEnvVar <- envOrNothing "IHP_BASEURL" + case ihpBaseUrlEnvVar of + Just baseUrl -> option (BaseUrl baseUrl) + Nothing -> do + (AppHostname appHostname) <- findOption @AppHostname + option $ BaseUrl ("http://" <> appHostname <> (if port /= 80 then ":" <> tshow port else "")) + + (BaseUrl currentBaseUrl) <- findOption @BaseUrl + option $ SessionCookie (defaultIHPSessionCookie currentBaseUrl) + + option WaiParse.defaultParseRequestBodyOptions + + option bootstrap + + when (environment == Development) do + ihpIdeBaseUrl <- envOrDefault "IHP_IDE_BASEURL" ("http://localhost:" <> tshow (port + 1)) + option (IdeBaseUrl ihpIdeBaseUrl) + + rlsAuthenticatedRole <- envOrDefault "IHP_RLS_AUTHENTICATED_ROLE" "ihp_authenticated" + option $ RLSAuthenticatedRole rlsAuthenticatedRole + + initAssetVersion + + dataSyncMaxSubscriptionsPerConnection <- envOrDefault "IHP_DATASYNC_MAX_SUBSCRIPTIONS_PER_CONNECTION" 128 + dataSyncMaxTransactionsPerConnection <- envOrDefault "IHP_DATASYNC_MAX_TRANSACTIONS_PER_CONNECTION" 10 + option $ DataSyncMaxSubscriptionsPerConnection dataSyncMaxSubscriptionsPerConnection + option $ DataSyncMaxTransactionsPerConnection dataSyncMaxTransactionsPerConnection + + option $ CustomMiddleware id + +{-# INLINABLE ihpDefaultConfig #-} + +instance EnvVarReader AppPort where + envStringToValue string = AppPort <$> envStringToValue string + +instance EnvVarReader RequestLogger.IPAddrSource where + envStringToValue "FromHeader" = Right RequestLogger.FromHeader + envStringToValue "FromSocket" = Right RequestLogger.FromSocket + envStringToValue otherwise = Left "Expected 'FromHeader' or 'FromSocket'" + +initAssetVersion :: ConfigBuilder +initAssetVersion = do + ihpAssetVersion <- envOrNothing "IHP_ASSET_VERSION" + let assetVersion = fromMaybe "dev" ihpAssetVersion + option (AssetVersion assetVersion) + +findOption :: forall option. Typeable option => State.StateT TMap.TMap IO option +findOption = fromMaybe (error optionNotFoundErrorMessage) <$> findOptionOrNothing @option + where + optionNotFoundErrorMessage = "findOption: Could not find " <> show (Typeable.typeOf (undefined :: option)) +{-# INLINABLE findOption #-} + +findOptionOrNothing :: forall option. Typeable option => State.StateT TMap.TMap IO (Maybe option) +findOptionOrNothing = do + options <- State.get + options + |> TMap.lookup @option + |> pure +{-# INLINABLE findOptionOrNothing #-} + +buildFrameworkConfig :: ConfigBuilder -> IO FrameworkConfig +buildFrameworkConfig appConfig = do + let resolve = do + (AppHostname appHostname) <- findOption @AppHostname + environment <- findOption @Environment + (AppPort appPort) <- findOption @AppPort + (BaseUrl baseUrl) <- findOption @BaseUrl + (RequestLoggerMiddleware requestLoggerMiddleware) <- findOption @RequestLoggerMiddleware + (SessionCookie sessionCookie) <- findOption @SessionCookie + mailServer <- findOption @MailServer + (DBPoolIdleTime dbPoolIdleTime) <- findOption @DBPoolIdleTime + (DBPoolMaxConnections dbPoolMaxConnections) <- findOption @DBPoolMaxConnections + (DatabaseUrl databaseUrl) <- findOption @DatabaseUrl + cssFramework <- findOption @CSSFramework + logger <- findOption @Logger + exceptionTracker <- findOption @ExceptionTracker + corsResourcePolicy <- findOptionOrNothing @Cors.CorsResourcePolicy + parseRequestBodyOptions <- findOption @WaiParse.ParseRequestBodyOptions + (IdeBaseUrl ideBaseUrl) <- findOption @IdeBaseUrl + (RLSAuthenticatedRole rlsAuthenticatedRole) <- findOption @RLSAuthenticatedRole + (AssetVersion assetVersion) <- findOption @AssetVersion + assetBaseUrl <- envOrNothing "IHP_ASSET_BASEURL" + customMiddleware <- findOption @CustomMiddleware + initializers <- fromMaybe [] <$> findOptionOrNothing @[Initializer] + + appConfig <- State.get + + + pure FrameworkConfig { .. } + + (frameworkConfig, _) <- State.runStateT (appConfig >> ihpDefaultConfig >> resolve) TMap.empty + + pure frameworkConfig +{-# INLINABLE buildFrameworkConfig #-} + +data FrameworkConfig = FrameworkConfig + { appHostname :: !Text + , environment :: !Environment + , appPort :: !Int + , baseUrl :: !Text + + -- | Provides IHP with a middleware to log requests and responses. + -- + -- By default this uses the RequestLogger middleware from wai-extra. Take a look at the wai-extra + -- documentation when you want to customize the request logging. + -- + -- See https://hackage.haskell.org/package/wai-extra-3.0.29.2/docs/Network-Wai-Middleware-RequestLogger.html + -- + -- + -- Set @requestLoggerMiddleware = \application -> application@ to disable request logging. + , requestLoggerMiddleware :: !Middleware + + -- | Provides the default settings for the session cookie. + -- + -- - Max Age: 30 days + -- - Same Site Policy: Lax + -- - HttpOnly (no access through JS) + -- - secure, when baseUrl is a https url + -- + -- Override this to set e.g. a custom max age or change the default same site policy. + -- + -- __Example: Set max age to 90 days__ + -- > sessionCookie = defaultIHPSessionCookie { Cookie.setCookieMaxAge = Just (fromIntegral (60 * 60 * 24 * 90)) } + , sessionCookie :: !Cookie.SetCookie + + , mailServer :: !MailServer + + , databaseUrl :: !ByteString + -- | How long db connection are kept alive inside the connecton pool when they're idle + , dbPoolIdleTime :: !NominalDiffTime + + -- | Max number of db connections the connection pool can open to the database + , dbPoolMaxConnections :: !Int + + -- | Bootstrap 4 by default + -- + -- Override this if you use a CSS framework that is not bootstrap + , cssFramework :: !CSSFramework + , logger :: !Logger + , exceptionTracker :: !ExceptionTracker + + -- | Custom 'option's from @Config.hs@ are stored here + -- + -- To access a custom option here, first set it up inside @Config.hs@. This example + -- reads a string from a env variable on app startup and makes it available to the app + -- by saving it into the application context: + -- + -- > -- Config.hs: + -- > + -- > newtype RedisUrl = RedisUrl String + -- > + -- > config :: ConfigBuilder + -- > config = do + -- > option Development + -- > option (AppHostname "localhost") + -- > + -- > redisUrl <- env "REDIS_URL" + -- > option (RedisUrl redisUrl) + -- + -- This redis url can be access from all IHP entrypoints using the ?applicationContext that is in scope: + -- + -- > import qualified Data.TMap as TMap + -- > import Config -- For accessing the RedisUrl data type + -- > + -- > action MyAction = do + -- > let appConfig = ?context.frameworkConfig.appConfig + -- > let (RedisUrl redisUrl) = appConfig + -- > |> TMap.lookup @RedisUrl + -- > |> fromMaybe (error "Could not find RedisUrl in config") + -- > + , appConfig :: !TMap.TMap + + -- | Configures CORS headers for the application. By default this is set to 'Nothing', and the server will not respond with any CORS headers + -- + -- You can provide a custom CORS policy in @Config.hs@: + -- + -- > -- Config.hs + -- > import qualified Network.Wai.Middleware.Cors as Cors + -- > + -- > config :: ConfigBuilder + -- > config = do + -- > option Development + -- > option (AppHostname "localhost") + -- > + -- > option Cors.simpleCorsResourcePolicy + -- > + -- + -- Take a look at the documentation of wai-cors https://hackage.haskell.org/package/wai-cors-0.2.7/docs/Network-Wai-Middleware-Cors.html for understanding what @simpleCorsResourcePolicy@ is doing + -- + -- You can specify CORS origins like this: + -- + -- > -- Config.hs + -- > import qualified Network.Wai.Middleware.Cors as Cors + -- > + -- > config :: ConfigBuilder + -- > config = do + -- > option Development + -- > option (AppHostname "localhost") + -- > + -- > -- The boolean True specifies if credentials are allowed for the request. You still need to set withCredentials on your XmlHttpRequest + -- > option Cors.simpleCorsResourcePolicy { Cors.corsOrigins = Just (["localhost"], True) } + -- > + , corsResourcePolicy :: !(Maybe Cors.CorsResourcePolicy) + + -- | Configures the limits for request parameters, uploaded files, maximum number of headers etc. + -- + -- IHP is using 'Network.Wai.Parse.parseRequestBodyEx' for parsing the HTTP request. By default it applies certain limits + -- to avoid a single request overloading the server. + -- + -- You can find the default limits here: https://hackage.haskell.org/package/wai-extra-3.1.6/docs/Network-Wai-Parse.html#v:defaultParseRequestBodyOptions + -- + -- You can override the default limits like this: + -- + -- > -- Config.hs + -- > import qualified Network.Wai.Parse as WaiParse + -- > + -- > config :: ConfigBuilder + -- > config = do + -- > option Development + -- > option (AppHostname "localhost") + -- > + -- > -- We extend the default options here + -- > option $ WaiParse.defaultParseRequestBodyOptions + -- > |> WaiParse.setMaxRequestNumFiles 20 -- Increase count of allowed files per request + -- > + , parseRequestBodyOptions :: !WaiParse.ParseRequestBodyOptions + + -- | Used by the dev server. This field cannot be strict. + , ideBaseUrl :: Text + + -- | See IHP.DataSync.Role + , rlsAuthenticatedRole :: !Text + + -- | The asset version is used for cache busting + -- + -- If you deploy IHP on your own, you should provide the IHP_ASSET_VERSION + -- env variable with e.g. the git commit hash of the production build. + -- + -- If IHP cannot figure out an asset version, it will fallback to the static + -- string @"dev"@. + -- + , assetVersion :: !Text + + -- | Base URL used by the 'assetPath' helper. Useful to move your static files to a CDN + , assetBaseUrl :: !(Maybe Text) + + -- | User provided WAI middleware that is run after IHP's middleware stack. + , customMiddleware :: !CustomMiddleware + , initializers :: ![Initializer] +} + +instance HasField "frameworkConfig" FrameworkConfig FrameworkConfig where + getField frameworkConfig = frameworkConfig + +type ConfigProvider context = HasField "frameworkConfig" context FrameworkConfig + +-- | Returns the default IHP session cookie configuration. Useful when you want to override the default settings in 'sessionCookie' +defaultIHPSessionCookie :: Text -> Cookie.SetCookie +defaultIHPSessionCookie baseUrl = def + { Cookie.setCookiePath = Just "/" + , Cookie.setCookieMaxAge = Just (fromIntegral (60 * 60 * 24 * 30)) + , Cookie.setCookieSameSite = Just Cookie.sameSiteLax + , Cookie.setCookieHttpOnly = True + , Cookie.setCookieSecure = "https://" `Text.isPrefixOf` baseUrl + } + +data RootApplication = RootApplication deriving (Eq, Show) + +defaultPort :: Int +defaultPort = 8000 + +defaultDatabaseUrl :: HasCallStack => IO ByteString +defaultDatabaseUrl = do + currentDirectory <- getCurrentDirectory + let defaultDatabaseUrl = "postgresql:///app?host=" <> cs currentDirectory <> "/build/db" + envOrDefault "DATABASE_URL" defaultDatabaseUrl + +defaultLoggerForEnv :: HasCallStack => Environment -> IO Logger +defaultLoggerForEnv = \case + Development -> defaultLogger + Production -> newLogger def { level = Info } + + +-- Returns 'True' when the application is running in a given environment +isEnvironment :: (?context :: context, ConfigProvider context) => Environment -> Bool +isEnvironment environment = ?context.frameworkConfig.environment == environment +{-# INLINABLE isEnvironment #-} + +-- | Returns 'True' when the application is running in Development mode +-- +-- Development mode means that the Development option is configured in Config/Config.hs +-- +-- See 'Environment' for documentation on the default differences. +isDevelopment :: (?context :: context, ConfigProvider context) => Bool +isDevelopment = isEnvironment Development +{-# INLINABLE isDevelopment #-} + +-- | Returns 'True' when the application is running in Production mode +-- +-- Production mode means that the Production option is configured in Config/Config.hs +-- +-- See 'Environment' for documentation on the default differences. +isProduction :: (?context :: context, ConfigProvider context) => Bool +isProduction = isEnvironment Production +{-# INLINABLE isProduction #-} + +defaultCorsResourcePolicy :: Maybe Cors.CorsResourcePolicy +defaultCorsResourcePolicy = Nothing + +-- | Builds a config and calls the provided callback. +-- +-- Once the callback has returned the resources allocated by the config are closed. Specifcally +-- this will close open log file handles. +-- +-- __Example:__ +-- +-- > import Config (config) +-- > +-- > withFrameworkConfig config \frameworkConfig -> do +-- > -- Do something with the FrameworkConfig here +-- +withFrameworkConfig :: ConfigBuilder -> (FrameworkConfig -> IO result) -> IO result +withFrameworkConfig configBuilder = Exception.bracket (buildFrameworkConfig configBuilder) (\frameworkConfig -> frameworkConfig.logger.cleanup) + +initModelContext :: FrameworkConfig -> IO ModelContext +initModelContext FrameworkConfig { environment, dbPoolIdleTime, dbPoolMaxConnections, databaseUrl, logger } = do + let isDevelopment = environment == Development + modelContext <- createModelContext dbPoolIdleTime dbPoolMaxConnections databaseUrl logger + pure modelContext + +-- | Wraps an Exception thrown during the config process, but adds a CallStack +-- +-- Inspired by https://maksbotan.github.io/posts/2021-01-20-callstacks.html +-- +data ExceptionWithCallStack = ExceptionWithCallStack CallStack SomeException + +instance Prelude.Show ExceptionWithCallStack where + show (ExceptionWithCallStack callStack inner) = Prelude.show inner <> "\n" <> Stack.prettyCallStack callStack + +instance Exception ExceptionWithCallStack + +-- | Runs IO inside the config process +-- +-- It works like 'liftIO', but attaches a CallStack on error. Without this it would be hard to see where +-- an error during the config setup comes from. +-- +-- All call-sites of this function should also have a @HasCallStack@ constraint to provide helpful information in the call stack. +-- +-- See https://github.com/digitallyinduced/ihp/issues/1503 +configIO :: (MonadIO monad, HasCallStack) => IO result -> monad result +configIO action = liftIO (action `catch` wrapWithCallStack) + where + wrapWithCallStack exception = throwIO (ExceptionWithCallStack Stack.callStack exception) diff --git a/IHP/HaskellSupport.hs b/IHP/HaskellSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/HaskellSupport.hs @@ -0,0 +1,453 @@ +{-# LANGUAGE TypeFamilies, DataKinds, MultiParamTypeClasses, PolyKinds, TypeApplications, ScopedTypeVariables, ConstraintKinds, TypeOperators, GADTs, UndecidableInstances, StandaloneDeriving, IncoherentInstances, AllowAmbiguousTypes, FunctionalDependencies #-} + +{-| +Module: IHP.HaskellSupport +Description: Provides helpers to write better haskell code +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.HaskellSupport +( (|>) +, (|>>) +, whenEmpty +, whenNonEmpty +, get +, set +, setJust +, setMaybe +, ifOrEmpty +, modify +, modifyJust +, SetField (..) +, UpdateField (..) +, incrementField +, decrementField +, isToday +, isToday' +, forEach +, forEachWithIndex +, textToInt +, isWeekend +, todayIsWeekend +, debug +, includes +, stripTags +, symbolToText +, symbolToByteString +, IsEmpty (..) +, copyFields +, allEnumValues +) where + +import ClassyPrelude +import qualified Data.Default +import qualified Data.UUID as UUID +import Data.Proxy +import qualified Data.Time +import GHC.TypeLits +import GHC.OverloadedLabels +import qualified GHC.Records as Record +import qualified Data.Attoparsec.ByteString.Char8 as Attoparsec +import Data.String.Conversions (cs, ConvertibleStrings (..)) +import qualified Debug.Trace +import qualified Data.Text as Text +import qualified Data.Map as Map +import qualified Data.ByteString.Char8 as ByteString +import qualified Data.Aeson.Key as Aeson + +--(|>) :: a -> f -> f a +infixl 8 |> +a |> f = f a +{-# INLINE (|>) #-} + +infixl 8 |>> +a |>> b = a <&> b +{-# INLINABLE (|>>) #-} + +-- | Used by 'nonEmpty' and 'isEmptyValue' to check for emptyness +class IsEmpty value where + -- | Returns True when the value is an empty string, empty list, zero UUID, etc. + isEmpty :: value -> Bool + +instance IsEmpty Text where + isEmpty "" = True + isEmpty _ = False + {-# INLINE isEmpty #-} + +instance IsEmpty (Maybe value) where + isEmpty Nothing = True + isEmpty (Just _) = False + {-# INLINE isEmpty #-} + +instance IsEmpty [a] where + isEmpty [] = True + isEmpty _ = False + {-# INLINE isEmpty #-} + +instance IsEmpty UUID.UUID where + isEmpty uuid = UUID.nil == uuid + {-# INLINE isEmpty #-} + +instance IsEmpty (Map a b) where + isEmpty = Map.null + {-# INLINE isEmpty #-} + +ifOrEmpty :: (Monoid a) => Bool -> a -> a +ifOrEmpty bool a = if bool then a else mempty +{-# INLINE ifOrEmpty #-} + +whenEmpty condition = when (isEmpty condition) +{-# INLINE whenEmpty #-} + +whenNonEmpty :: (IsEmpty a, Applicative f) => a -> f () -> f () +whenNonEmpty condition = unless (isEmpty condition) +{-# INLINE whenNonEmpty #-} + +-- Returns 'True' when a value is contained in the given list, array, set, ... +-- +-- Alias for 'elem', but with a nicer name :) +-- +-- >>> ["hello", "world"] |> includes "hello" +-- True +-- +-- >>> "Hello" |> includes 'H' +-- True +includes :: (MonoFoldable container, Eq (Element container)) => Element container -> container -> Bool +includes = elem +{-# INLINE includes #-} + +instance Data.Default.Default UUID.UUID where + def = UUID.nil + {-# INLINE def #-} + +instance forall name name'. (KnownSymbol name, name' ~ name) => IsLabel name (Proxy name') where + fromLabel = Proxy @name' + {-# INLINE fromLabel #-} + +-- | Returns the field value for a field name +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Text, isPublic :: Bool } +-- > +-- > let project = Project { name = "Hello World", isPublic = False } +-- +-- >>> project.name +-- "Hello World" +-- +-- >>> project.isPublic +-- False +get :: forall model name value. (KnownSymbol name, Record.HasField name model value) => Proxy name -> model -> value +get _ record = Record.getField @name record +{-# INLINE get #-} + +-- | Sets a field of a record and returns the new record. +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Text, isPublic :: Bool } +-- > +-- > let project = Project { name = "Hello World", isPublic = False } +-- +-- >>> set #name "New Name" project +-- Project { name = "New Name", isPublic = False } +-- +-- >>> set #isPublic True project +-- Project { name = "Hello World", isPublic = True } +set :: forall model name value. (KnownSymbol name, SetField name model value) => Proxy name -> value -> model -> model +set name value record = setField @name value record +{-# INLINE set #-} + + +-- | Like 'set' but doesn't set the value if it's 'Nothing'. Useful when you update NULL values +-- | e.g. via a cron job and don't want to lose that work on subsequent updates. +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Maybe Text } +-- > +-- > let project = Project { name = Nothing } +-- +-- >>> setMaybe #name (Just "New Name") project +-- Project { name = Just "New Name" } +-- +-- >>> setMaybe #name Nothing project +-- Project { name = Just "New Name" } -- previous value is kept +-- +setMaybe :: forall model name value. (KnownSymbol name, SetField name model (Maybe value)) => Proxy name -> Maybe value -> model -> model +setMaybe name value record = case value of + Just value -> setField @name (Just value) record + Nothing -> record +{-# INLINE setMaybe #-} + + +-- | Like 'set' but wraps the value with a 'Just'. Useful when you want to set a 'Maybe' field +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Maybe Text } +-- > +-- > let project = Project { name = Nothing } +-- +-- >>> setJust #name "New Name" project +-- Project { name = Just "New Name" } +-- +setJust :: forall model name value. (KnownSymbol name, SetField name model (Maybe value)) => Proxy name -> value -> model -> model +setJust name value record = setField @name (Just value) record +{-# INLINE setJust #-} + + +modify :: forall model name value. (KnownSymbol name, Record.HasField name model value, SetField name model value) => Proxy name -> (value -> value) -> model -> model +modify _ updateFunction model = let value = Record.getField @name model in setField @name (updateFunction value) model +{-# INLINE modify #-} + +-- Like 'modify', but only modifies the value if it's not Nothing. +-- +-- __Example:__ +-- +-- > let pauseDuration = now `diffUTCTime` pausedAt +-- > +-- > floorTimer <- floorTimer +-- > |> modifyJust #startedAt (addUTCTime pauseDuration) +-- > |> updateRecord +-- +modifyJust :: forall model name value. (KnownSymbol name, Record.HasField name model (Maybe value), SetField name model (Maybe value)) => Proxy name -> (value -> value) -> model -> model +modifyJust _ updateFunction model = case Record.getField @name model of + Just value -> setField @name (Just (updateFunction value)) model + Nothing -> model +{-# INLINE modifyJust #-} + +-- | Plus @1@ on record field. +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Text, followersCount :: Int } +-- > +-- > let project = Project { name = "Hello World", followersCount = 0 } +-- +-- >>> project |> incrementField #followersCount +-- Project { name = "Hello World", followersCount = 1 } +incrementField :: forall model name value. (KnownSymbol name, Record.HasField name model value, SetField name model value, Num value) => Proxy name -> model -> model +incrementField _ model = let value = Record.getField @name model in setField @name (value + 1) model +{-# INLINE incrementField #-} + +-- | Minus @1@ on a record field. +-- +-- __Example:__ +-- +-- > data Project = Project { name :: Text, followersCount :: Int } +-- > +-- > let project = Project { name = "Hello World", followersCount = 1337 } +-- +-- >>> project |> decrementField #followersCount +-- Project { name = "Hello World", followersCount = 1336 } +decrementField :: forall model name value. (KnownSymbol name, Record.HasField name model value, SetField name model value, Num value) => Proxy name -> model -> model +decrementField _ model = let value = Record.getField @name model in setField @name (value - 1) model +{-# INLINE decrementField #-} + +class SetField (field :: GHC.TypeLits.Symbol) model value | field model -> value where + setField :: value -> model -> model + +class Record.HasField field model value => UpdateField (field :: GHC.TypeLits.Symbol) model model' value value' | model model' value' -> value where + updateField :: value' -> model -> model' + +utcTimeToYearMonthDay :: UTCTime -> (Integer, Int, Int) +utcTimeToYearMonthDay = toGregorian . utctDay -- (year,month,day) + +isToday :: UTCTime -> IO Bool +isToday timestamp = do + now <- getCurrentTime + pure (isToday' now timestamp) + +isToday' :: UTCTime -> UTCTime -> Bool +isToday' currentTime timestamp = utcTimeToYearMonthDay currentTime == utcTimeToYearMonthDay timestamp + +-- | Allows `Just "someThing"` to be written as `"someThing"` +instance IsString string => IsString (Maybe string) where + fromString string = Just (fromString string) + {-# INLINE fromString #-} + + +-- | Example: +-- +-- > forEach users \user -> putStrLn (tshow user) +-- +-- __Example:__ Within HSX +-- +-- > renderUser :: User -> Html +-- > renderUser user = [hsx|
    User: {user.name}
    |] +-- > +-- > render = [hsx|{forEach users renderUser}|] +-- +forEach :: (MonoFoldable mono, Applicative m) => mono -> (Element mono -> m ()) -> m () +forEach elements function = forM_ elements function +{-# INLINE forEach #-} + + +-- | Like 'forEach' but with an index, starting at 0 +-- +-- __Example:__ With a Callback +-- +-- > forEachWithIndex users \(index, user) -> putStrLn (tshow index <> ": " <> tshow user) +-- +-- __Example:__ With a Function +-- +-- > printUser :: (Int, User) -> IO () +-- > printUser (index, user) = putStrLn (tshow index <> ": " <> tshow user) +-- > +-- > forEachWithIndex users printUser +-- +-- __Example:__ Within HSX +-- +-- > renderUser :: (Int, User) -> Html +-- > renderUser (index, user) = [hsx|
    User {index}: {user.name}
    |] +-- > +-- > render = [hsx|{forEachWithIndex users renderUser}|] +-- +forEachWithIndex :: (Applicative m) => [a] -> ((Int, a) -> m ()) -> m () +forEachWithIndex elements function = forM_ (ClassyPrelude.zip [0..] elements) function +{-# INLINE forEachWithIndex #-} + +-- | Parses a text to an int. Returns @Nothing@ on failure. +-- +-- __Example:__ +-- +-- >>> textToInt "1337" +-- Just 1337 +-- +-- >>> textToInt "bad input" +-- Nothing +textToInt :: Text -> Maybe Int +textToInt text = case Attoparsec.parseOnly (Attoparsec.decimal <* Attoparsec.endOfInput) (cs text) of + Right value -> Just value + Left _error -> Nothing + +-- | Returns @True@ when today is Saturday or Sunday. +-- +-- __Example:__ +-- +-- > do +-- > todayIsWeekend <- isWeekend +-- > when todayIsWeekend (putStrLn "It's weekend!") +todayIsWeekend :: IO Bool +todayIsWeekend = do + now <- Data.Time.getCurrentTime + let today = Data.Time.utctDay now + return (isWeekend today) + +-- | Returns @True@ when day is Saturday or Sunday. +-- +-- __Example:__ +-- +-- >>> isWeekend $ fromGregorian 2019 10 7 +-- False +-- +-- >>> isWeekend $ fromGregorian 2020 6 13 +-- True +isWeekend :: Day -> Bool +isWeekend day = + weekday == Data.Time.Saturday || weekday == Data.Time.Sunday + where + weekday = Data.Time.dayOfWeek day + +-- | Debug-print a value during evaluation +-- +-- Alias for 'Debug.Trace.traceShowId' +debug :: Show value => value -> value +debug value = Debug.Trace.traceShowId value +{-# INLINE debug #-} + +-- | Removes all html tags from a given html text +-- +-- >>> stripTags "This is Bold" +-- "This is Bold" +stripTags :: Text -> Text +stripTags "" = "" +stripTags html | Text.head html == '<' = stripTags (Text.drop 1 (Text.dropWhile (/= '>') (Text.tail html))) +stripTags html = let (a, b) = Text.splitAt 1 html in a <> stripTags b + +-- | Returns the value of a type level symbol as a text +-- +-- >>> symbolToText @"hello" +-- "hello" +-- +-- >>> symbolToText @(GetTableName User) +-- "users" +symbolToText :: forall symbol. (KnownSymbol symbol) => Text +symbolToText = Text.pack (symbolVal @symbol Proxy) +{-# INLINE symbolToText #-} + +-- | Returns the value of a type level symbol as a bytestring +-- +-- >>> symbolToByteString @"hello" +-- "hello" +-- +-- >>> symbolToByteString @(GetTableName User) +-- "users" +symbolToByteString :: forall symbol. (KnownSymbol symbol) => ByteString +symbolToByteString = ByteString.pack (symbolVal @symbol Proxy) +{-# INLINE symbolToByteString #-} + +instance IsString UUID.UUID where + fromString string = case UUID.fromString string of + Just uuid -> uuid + Nothing -> error ("Invalid UUID: " <> string) + + +class CopyFields (fields :: [Symbol]) destinationRecord sourceRecord where + -- | Provides the 'copyFields' function + -- + -- Useful to rewrite getter-setter code like this: + -- + -- > let newProject = newRecord @Project + -- > |> set #name (otherProject.name) + -- > |> set #isPublic (otherProject.isPublic) + -- > |> set #userId (otherProject.userId) + -- + -- With 'copyFields' this can be written like this: + -- + -- > let newProject = newRecord @Project + -- > |> copyFields @["name", "isPublic", "userId"] otherProject + -- + copyFields :: sourceRecord -> destinationRecord -> destinationRecord + +instance CopyFields ('[]) destinationRecord sourceRecord where + copyFields sourceRecord destinationRecord = destinationRecord + {-# INLINE copyFields #-} + +instance (CopyFields rest destinationRecord sourceRecord + , KnownSymbol fieldName + , SetField fieldName destinationRecord fieldType + , Record.HasField fieldName sourceRecord fieldType + ) => CopyFields (fieldName:rest) destinationRecord sourceRecord where + copyFields sourceRecord destinationRecord = + destinationRecord + |> set (Proxy @fieldName) (Record.getField @fieldName sourceRecord) + |> copyFields @rest sourceRecord + {-# INLINE copyFields #-} + +-- | Returns a list of all values of an enum type +-- +-- Given a data structure like this: +-- +-- > data Color = Yellow | Red | Blue deriving (Enum) +-- +-- You can call 'allEnumValues' to get a list of all colors: +-- +-- >>> allEnumValues @Color +-- [Yellow, Red, Blue] +-- +-- This also works if the enum is defined in the @Schema.sql@: +-- +-- > CREATE TYPE brokerage_subscription_type AS ENUM ('basic_subscription', 'bronze_subscription', 'silver_subscription', 'gold_subscription'); +-- +-- >>> allEnumValues @BrokerageSubscriptionType +-- [BasicSubscription, BronzeSubscription, SilverSubscription] +-- +allEnumValues :: forall enumType. Enum enumType => [enumType] +allEnumValues = enumFrom (toEnum 0) +{-# INLINABLE allEnumValues #-} + +instance ConvertibleStrings ByteString Aeson.Key where + convertString byteString = Aeson.fromText (cs byteString) +instance ConvertibleStrings Text Aeson.Key where + convertString text = Aeson.fromText text diff --git a/IHP/Job/Dashboard.hs b/IHP/Job/Dashboard.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Dashboard.hs @@ -0,0 +1,400 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +{-| +Module: IHP.Job.Dashboard +Description: Auto-generate a dashboard for job types + +This module allows IHP applications to generate a dashboard for interacting with job types. +To start, first define a type for the dashboard: + +> type MyDashboard = JobsDashboardController NoAuth '[] + +And include the following in the 'controllers' list of a FrontController: + +> parseRoute @MyDashboard + +This generates a dashboard with listings for all tables which have names ending with "_jobs". + +All views are fully customizable. For more info, see the documentation for 'DisplayableJob'. +If you implement custom behavior for a job type, add it to the list in the Dashboard type: + +> type MyDashboard = JobsDashboardController NoAuth '[EmailUserJob, UpdateRecordJob] +-} +module IHP.Job.Dashboard ( + module IHP.Job.Dashboard.View, + module IHP.Job.Dashboard.Auth, + module IHP.Job.Dashboard.Types, + + JobsDashboard(..), + DisplayableJob(..), + JobsDashboardController(..), + getTableName, +) where + +import IHP.Prelude +import IHP.ModelSupport +import IHP.ControllerPrelude +import Unsafe.Coerce +import IHP.Job.Queue () +import IHP.Pagination.Types +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple.FromField as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import Network.Wai (requestMethod) +import Network.HTTP.Types.Method (methodPost) + +import IHP.Job.Dashboard.Types +import IHP.Job.Dashboard.View +import IHP.Job.Dashboard.Auth +import IHP.Job.Dashboard.Utils + +-- | The crazy list of type constraints for this class defines everything needed for a generic "Job". +-- All jobs created through the IHP dev IDE will automatically satisfy these constraints and thus be able to +-- be used as a 'DisplayableJob'. +-- To customize the dashboard behavior for each job, you should provide a custom implementation of 'DisplayableJob' +-- for your job type. Your custom implementations will then be used instead of the defaults. +class ( job ~ GetModelByTableName (GetTableName job) + , FilterPrimaryKey (GetTableName job) + , FromRow job + , Show (PrimaryKey (GetTableName job)) + , PG.FromField (PrimaryKey (GetTableName job)) + , PG.ToField (PrimaryKey (GetTableName job)) + , KnownSymbol (GetTableName job) + , HasField "id" job (Id job) + , HasField "status" job JobStatus + , HasField "updatedAt" job UTCTime + , HasField "createdAt" job UTCTime + , HasField "lastError" job (Maybe Text) + , CanUpdate job + , CanCreate job + , Record job + , Show job + , Eq job + , Table job + , Typeable job) => DisplayableJob job where + + -- | How this job's section should be displayed in the dashboard. By default it's displayed as a table, + -- but this can be any arbitrary view! Make some cool graphs :) + makeDashboardSection :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO SomeView + + makePageView :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Int -> Int -> IO SomeView + + -- | The content of the page that will be displayed for a detail view of this job. + -- By default, the ID, Status, Created/Updated at times, and last error are displayed. + -- Can be defined as any arbitrary view. + makeDetailView :: (?context :: ControllerContext, ?modelContext :: ModelContext) => job -> IO SomeView + makeDetailView job = do + pure $ SomeView $ HtmlView $ renderBaseJobDetailView (buildBaseJob job) + + -- | The content of the page that will be displayed for the "new job" form of this job. + -- By default, only the submit button is rendered. For additonal form data, define your own implementation. + -- Can be defined as any arbitrary view, but it should be a form. + makeNewJobView :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO SomeView + makeNewJobView = pure $ SomeView $ HtmlView $ renderNewBaseJobForm $ tableName @job + + -- | The action run to create and insert a new value of this job into the database. + -- By default, create an empty record and insert it. + -- To add more data, define your own implementation. + createNewJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO () + createNewJob = do + newRecord @job |> create + pure () + + + + +-- | Defines implementations for actions for acting on a dashboard made of some list of types. +-- This is included to allow these actions to recurse on the types, isn't possible in an IHP Controller +-- action implementation. +-- +-- Later functions and typeclasses introduce constraints on the types in this list, +-- so you'll get a compile error if you try and include a type that is not a job. +class JobsDashboard (jobs :: [Type]) where + -- | Creates the entire dashboard by recursing on the type list and calling 'makeDashboardSection' on each type. + makeDashboard :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO SomeView + + includedJobTables :: [Text] + + -- | Renders the index page, which is the view returned from 'makeDashboard'. + indexPage :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO () + + listJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Text -> IO () + listJob' :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Bool -> IO () + + -- | Renders the detail view page. Rescurses on the type list to find a type with the + -- same table name as the "tableName" query parameter. + viewJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Text -> UUID -> IO () + viewJob' :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Bool -> IO () + + -- | If performed in a POST request, creates a new job depending on the "tableName" query parameter. + -- If performed in a GET request, renders the new job from depending on said parameter. + newJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Text -> IO () + newJob' :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Bool -> IO () + + -- | Deletes a job from the database. + deleteJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Text -> UUID -> IO () + deleteJob' :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Bool -> IO () + + retryJob :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Text -> UUID -> IO () + retryJob' :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO () + +-- If no types are passed, try to get all tables dynamically and render them as BaseJobs +instance JobsDashboard '[] where + + -- | Invoked at the end of recursion + makeDashboard = pure $ SomeView $ HtmlView [hsx| + + + |] + + includedJobTables = [] + + indexPage = do + tableNames <- getAllTableNames + tables <- mapM buildBaseJobTable tableNames + render $ SomeView tables + where + getAllTableNames = map extractText <$> sqlQuery + "SELECT table_name FROM information_schema.tables WHERE table_name LIKE '%_jobs'" () + + listJob = error "listJob: Requested job type not in JobsDashboard Type" + listJob' _ = do + let table = param "tableName" + options = defaultPaginationOptions + page = paramOrDefault 1 "page" + pageSize = paramOrDefault (maxItems options) "maxItems" + totalItems <- totalRecordsForTable table + jobs <- queryBaseJobsFromTablePaginated table (page - 1) pageSize + let pagination = Pagination { currentPage = page, totalItems, pageSize, window = windowSize options } + render $ HtmlView $ renderBaseJobTablePaginated table jobs pagination + + viewJob = error "viewJob: Requested job type not in JobsDashboard Type" + viewJob' _ = do + baseJob <- queryBaseJob (param "tableName") (param "id") + render $ HtmlView $ renderBaseJobDetailView baseJob + + newJob = error "newJob: Requested job type not in JobsDashboard Type" + newJob' _ = do + if requestMethod request == methodPost + then do + insertJob + setSuccessMessage (columnNameToFieldLabel (param "tableName") <> " job started.") + redirectTo ListJobsAction + else render $ HtmlView $ renderNewBaseJobForm (param "tableName") + where insertJob = sqlExec (PG.Query $ "INSERT into " <> param "tableName" <> " DEFAULT VALUES") () + + deleteJob = error "deleteJob: Requested job type not in JobsDashboard Type" + deleteJob' _ = do + let id :: UUID = param "id" + table :: Text = param "tableName" + delete id table + setSuccessMessage (columnNameToFieldLabel table <> " record deleted.") + redirectTo ListJobsAction + + where delete id table = sqlExec (PG.Query $ cs $ "DELETE FROM " <> table <> " WHERE id = ?") (Only id) + + retryJob = error "retryJob: Requested job type not in JobsDashboard Type" + retryJob' = do + let id :: UUID = param "id" + table :: Text = param "tableName" + retryJobById table id + setSuccessMessage (columnNameToFieldLabel table <> " record marked as 'retry'.") + redirectTo ListJobsAction + + where retryJobById table id = sqlExec ("UPDATE ? SET status = 'job_status_retry' WHERE id = ?") (PG.Identifier table, id) + + +-- | Defines the default implementation for a dashboard of a list of job types. +-- We know the current job is a 'DisplayableJob', and we can recurse on the rest of the list to build the rest of the dashboard. +-- You probably don't want to provide custom implementations for these. Read the documentation for each of the functions if +-- you'd like to know how to customize the behavior. They mostly rely on the functions from 'DisplayableJob'. +instance {-# OVERLAPPABLE #-} (DisplayableJob job, JobsDashboard rest) => JobsDashboard (job:rest) where + + -- | Recusively create a list of views that are concatenated together as 'SomeView's to build the dashboard. + -- To customize, override 'makeDashboardSection' for each job. + makeDashboard = do + section <- makeDashboardSection @job + restSections <- SomeView <$> makeDashboard @rest + pure $ SomeView (section : [restSections]) + + -- | Recursively build list of included table names + includedJobTables = tableName @job : includedJobTables @rest + + -- | Build the dashboard and render it. + indexPage = do + dashboardIncluded <- makeDashboard @(job:rest) + notIncluded <- getNotIncludedTableNames (includedJobTables @(job:rest)) + baseJobTables <- mapM buildBaseJobTable notIncluded + render $ dashboardIncluded : baseJobTables + + listJob table = do + let page = fromMaybe 1 $ param "page" + page <- makePageView @job page 25 + render page + + listJob' isFirstTime = do + let table = param "tableName" + + when isFirstTime $ do + notIncluded <- getNotIncludedTableNames (includedJobTables @(job:rest)) + when (table `elem` notIncluded) (listJob' @'[] False) + + if tableName @job == table + then listJob @(job:rest) table + else listJob' @rest False + + -- | View the detail page for the job with a given uuid. + viewJob _ uuid = do + let id :: Id job = unsafeCoerce uuid + j <- fetch id + view <- makeDetailView @job j + render view + + -- | For a given "tableName" parameter, try and recurse over the list of types + -- in order to find a type with the some table name as the parameter. + -- If one is found, attempt to construct an ID from the "id" parameter, + -- and render a page using the type's implementation of 'makeDetailView'. + -- If you want to customize the page, override that function instead. + viewJob' isFirstTime = do + let table = param "tableName" + + when isFirstTime $ do + notIncluded <- getNotIncludedTableNames (includedJobTables @(job:rest)) + when (table `elem` notIncluded) (viewJob' @'[] False) + + if tableName @job == table + then viewJob @(job:rest) table (param "id") + else viewJob' @rest False + + -- For POST, create a new job using the job's implementation of 'createNewJob'. + -- To include other request data and parameters, override that function, not this one. + -- If it's a GET request, render a new job form with the job's implementation of 'makeNewJobView'. + -- For customizing this form, override 'makeNewJobView'. + newJob tableName = do + if requestMethod request == methodPost + then do + createNewJob @job + setSuccessMessage (columnNameToFieldLabel tableName <> " job started.") + redirectTo ListJobsAction + else do + view <- makeNewJobView @job + render view + + -- | For a given "tableName" parameter, try and recurse over the list of types + -- in order to find a type with the some table name as the parameter. + -- If such a type is found, call newJob. + newJob' isFirstTime = do + let table = param "tableName" + + when isFirstTime $ do + notIncluded <- getNotIncludedTableNames (includedJobTables @(job:rest)) + when (table `elem` notIncluded) (newJob' @'[] False) + + if tableName @job == table + then newJob @(job:rest) table + else newJob' @rest False + + -- | Delete job in 'table' with ID 'uuid'. + deleteJob table uuid = do + let id :: Id job = unsafeCoerce uuid + deleteRecordById @job id + setSuccessMessage (columnNameToFieldLabel table <> " record deleted.") + redirectTo ListJobsAction + + -- | For a given "tableName" parameter, try and recurse over the list of types + -- in order to find a type with the some table name as the parameter. + -- If one is found, delete the record with the given id. + deleteJob' isFirstTime = do + let table = param "tableName" + + when isFirstTime $ do + notIncluded <- getNotIncludedTableNames (includedJobTables @(job:rest)) + when (table `elem` notIncluded) (deleteJob' @'[] False) + + if tableName @job == table + then deleteJob @(job:rest) table (param "id") + else deleteJob' @rest False + + retryJob table uuid = do + let id :: UUID = param "id" + table :: Text = param "tableName" + retryJobById table id = sqlExec ("UPDATE ? SET status = 'job_status_retry' WHERE id = ?") (PG.Identifier table, id) + retryJobById table id + setSuccessMessage (columnNameToFieldLabel table <> " record marked as 'retry'.") + redirectTo ListJobsAction + retryJob' = do + let table = param "tableName" + + if tableName @job == table + then retryJob @(job:rest) table (param "id") + else retryJob' @rest + +extractText = \(Only t) -> t +getNotIncludedTableNames includedNames = map extractText <$> sqlQuery + "SELECT table_name FROM information_schema.tables WHERE table_name LIKE '%_jobs' AND table_name NOT IN ?" + (Only $ In $ includedNames) +buildBaseJobTable :: (?modelContext :: ModelContext, ?context :: ControllerContext) => Text -> IO SomeView +buildBaseJobTable tableName = do + baseJobs <- sqlQuery (PG.Query $ cs $ queryString) (Only tableName) + baseJobs + |> renderBaseJobTable tableName + |> HtmlView + |> SomeView + |> pure + + where + queryString = "SELECT ?, id, status, updated_at, created_at, last_error FROM " + <> tableName + <> " ORDER BY created_at DESC LIMIT 10" + +buildBaseJob :: forall job. (DisplayableJob job) => job -> BaseJob +buildBaseJob job = BaseJob + (tableName @job) + (unsafeCoerce $ job.id) -- model Id type -> UUID. Pls don't use integer IDs for your jobs :) + (job.status) + (job.updatedAt) + (job.createdAt) + (job.lastError) + + +-- | We can't always access the type of our job in order to use type application syntax for 'tableName'. +-- This is just a convinence function for those cases. +getTableName :: forall job. (DisplayableJob job) => job -> Text +getTableName _ = tableName @job + +-- | Get the job with in the given table with the given ID as a 'BaseJob'. +queryBaseJob :: (?modelContext :: ModelContext) => Text -> UUID -> IO BaseJob +queryBaseJob table id = do + (job : _) <- sqlQuery + (PG.Query $ cs $ "select ?, id, status, updated_at, created_at, last_error from " <> table <> " where id = ?") + [table, tshow id] + pure job + +queryBaseJobsFromTablePaginated :: (?modelContext :: ModelContext) => Text -> Int -> Int -> IO [BaseJob] +queryBaseJobsFromTablePaginated table page pageSize = + sqlQuery + (PG.Query $ cs $ "select ?, id, status, updated_at, created_at, last_error from " <> table <> " OFFSET " <> tshow (page * pageSize) <> " LIMIT " <> tshow pageSize) + (Only table) + +instance (JobsDashboard jobs, AuthenticationMethod authType) => Controller (JobsDashboardController authType jobs) where + beforeAction = authenticate @authType + action ListJobsAction = autoRefresh $ indexPage @jobs + action ListJobAction' = autoRefresh $ listJob' @jobs True + action ViewJobAction' = autoRefresh $ viewJob' @jobs True + action CreateJobAction' = newJob' @jobs True + action DeleteJobAction' = deleteJob' @jobs True + action RetryJobAction' = retryJob' @jobs + action _ = error "Cannot call this action directly. Call the backtick function with no parameters instead." diff --git a/IHP/Job/Dashboard/Auth.hs b/IHP/Job/Dashboard/Auth.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Dashboard/Auth.hs @@ -0,0 +1,52 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +{-| +Module: IHP.Job.Dashboard.Auth +Description: Authentication for Job dashboard +-} +module IHP.Job.Dashboard.Auth ( + AuthenticationMethod(..), + NoAuth(..), + BasicAuth(..), + BasicAuthStatic(..), +) where + +import IHP.Prelude +import IHP.ControllerPrelude +import qualified IHP.EnvVar as EnvVar + +-- | Defines one method, 'authenticate', called before every action. Use to authenticate user. +-- +-- Three implementations are provided: +-- - 'NoAuth' : No authentication +-- - 'BasicAuth' : HTTP Basic Auth using environment variables +-- - 'BasicAuthStatic' : HTTP Basic Auth using static values +-- +-- Define your own implementation to use custom authentication for production. +class AuthenticationMethod a where + authenticate :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO () + +-- | Don't use any authentication for jobs. +data NoAuth + +-- | Authenticate using HTTP Basic Authentication by looking up username/password values +-- in environment variables given as type-level strings. +data BasicAuth (userEnv :: Symbol) (passEnv :: Symbol) + +-- | Authenticate using HTTP Basic Authentication using username/password given as type level strings. +-- Meant for development only! +data BasicAuthStatic (user :: Symbol) (pass :: Symbol) + +instance AuthenticationMethod NoAuth where + authenticate = pure () + +instance (KnownSymbol userEnv, KnownSymbol passEnv) => AuthenticationMethod (BasicAuth userEnv passEnv) where + authenticate = do + creds <- (,) <$> EnvVar.envOrNothing (symbolToByteString @userEnv) <*> EnvVar.envOrNothing (symbolToByteString @passEnv) + case creds of + (Just user, Just pass) -> basicAuth user pass "jobs" + _ -> error "Did not find HTTP Basic Auth credentials for Jobs Dashboard." + +instance (KnownSymbol user, KnownSymbol pass) => AuthenticationMethod (BasicAuthStatic user pass) where + authenticate = basicAuth (cs $ symbolVal $ Proxy @user) (cs $ symbolVal $ Proxy @pass) "jobs" + diff --git a/IHP/Job/Dashboard/Types.hs b/IHP/Job/Dashboard/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Dashboard/Types.hs @@ -0,0 +1,112 @@ +{-| +Module: IHP.Job.Dashboard.Types +Description: Types for Job dashboard +-} +{-# LANGUAGE AllowAmbiguousTypes #-} +module IHP.Job.Dashboard.Types ( + BaseJob(..), + JobsDashboardController(..), + TableViewable(..), + IncludeWrapper(..), +) where + +import IHP.Prelude +import IHP.ControllerPrelude +import IHP.ViewPrelude (Html) +import IHP.RouterPrelude hiding (get, tshow, error, map, putStrLn, elem) +import Database.PostgreSQL.Simple.FromRow (FromRow(..), field) +import IHP.Job.Queue () -- get FromField definition for JobStatus + + +data BaseJob = BaseJob { + table :: Text + , id :: UUID + , status :: JobStatus + , updatedAt :: UTCTime + , createdAt :: UTCTime + , lastError :: Maybe Text +} deriving (Show) + +class TableViewable a where + -- | Human readable title displayed on the table + tableTitle :: Text + + -- | Database table backing the view + modelTableName :: Text + + tableHeaders :: [Text] + renderTableRow :: a -> Html + + -- | Link used in the table to send user to new job form + newJobLink :: Html + + -- | Gets records for displaying in the dashboard index page + getIndex :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO [a] + + -- | Gets paginated records for displaying in the list page + getPage :: (?context :: ControllerContext, ?modelContext :: ModelContext) => Int -> Int -> IO [a] + +instance FromRow BaseJob where + fromRow = BaseJob <$> field <*> field <*> field <*> field <*> field <*> field + +-- | Often, jobs are related to some model type. These relations are modeled through the type system. +-- For example, the type 'Include "userId" UpdateUserJob' models an 'UpdateUserJob' type that can access +-- the 'User' it belongs to through the 'userId' field. +-- For some reason, GHC doesn't allow us to create implementations of type family applications, so the following doesn't work: +-- +-- > instance DisplayableJob (Include "userId" UpdateUserJob) where +-- +-- However, if we wrap this in a concrete type, it works fine. That's what this wrapper is for. +-- To get the same behavior as above, just define +-- +-- > instance DisplayableJob (IncludeWrapper "userId" UpdateUserJob) where +-- +-- and wrap the values as so: +-- +-- > jobsWithUsers <- query @UpdateUserJob +-- > |> fetch +-- > >>= mapM (fetchRelated #userId) +-- > >>= pure . map (IncludeWrapper @"userId" @UpdateUserJob) +newtype IncludeWrapper (id :: Symbol) job = IncludeWrapper (Include id job) + +-- | Defines controller actions for acting on a dashboard made of some list of types. +-- Later functions and typeclasses introduce constraints on the types in this list, +-- so you'll get a compile error if you try and include a type that is not a job. +data JobsDashboardController authType (jobs :: [Type]) + = ListJobsAction + | ListJobAction { jobTableName :: Text, page :: Int } + -- These actions are used for 'pathTo'. Need to pass the parameters explicity to know how to build the path + | ViewJobAction { jobTableName :: Text, jobId :: UUID } + | CreateJobAction { jobTableName :: Text } + | DeleteJobAction { jobTableName :: Text, jobId :: UUID } + | RetryJobAction { jobTableName :: Text, jobId :: UUID } + + -- These actions are used for interal routing. Parameters are extracted dynamically in the action based on types + | ListJobAction' + | ViewJobAction' + | CreateJobAction' + | DeleteJobAction' + | RetryJobAction' + deriving (Show, Eq, Data) + + +instance HasPath (JobsDashboardController authType jobs) where + pathTo ListJobsAction = "/jobs/ListJobs" + pathTo ListJobAction { .. } = "/jobs/ListJob?tableName=" <> jobTableName <> "&page=" <> tshow page + pathTo ViewJobAction { .. } = "/jobs/ViewJob?tableName=" <> jobTableName <> "&id=" <> tshow jobId + pathTo CreateJobAction { .. } = "/jobs/CreateJob?tableName=" <> jobTableName + pathTo DeleteJobAction { .. } = "/jobs/DeleteJob?tableName=" <> jobTableName <> "&id=" <> tshow jobId + pathTo RetryJobAction { .. } = "/jobs/RetryJob?tableName=" <> jobTableName <> "&id=" <> tshow jobId + pathTo _ = error "pathTo for internal JobsDashboard functions not supported. Use non-backtick action and pass necessary parameters to use pathTo." + +instance CanRoute (JobsDashboardController authType jobs) where + parseRoute' = do + (string "/jobs" <* endOfInput >> pure ListJobsAction) + <|> (string "/jobs/" <* endOfInput >> pure ListJobsAction) + <|> (string "/jobs/ListJobs" <* endOfInput >> pure ListJobsAction) + <|> (string "/jobs/ListJob" <* endOfInput >> pure ListJobAction') + <|> (string "/jobs/ViewJob" <* endOfInput >> pure ViewJobAction') + <|> (string "/jobs/CreateJob" <* endOfInput >> pure CreateJobAction') + <|> (string "/jobs/DeleteJob" <* endOfInput >> pure DeleteJobAction') + <|> (string "/jobs/RetryJob" <* endOfInput >> pure RetryJobAction') + diff --git a/IHP/Job/Dashboard/Utils.hs b/IHP/Job/Dashboard/Utils.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Dashboard/Utils.hs @@ -0,0 +1,15 @@ +module IHP.Job.Dashboard.Utils where + +import IHP.Prelude +import IHP.ModelSupport +import qualified Database.PostgreSQL.Simple.Types as PG + +numberOfPagesForTable :: (?modelContext::ModelContext) => Text -> Int -> IO Int +numberOfPagesForTable table pageSize = do + totalRecords <- totalRecordsForTable table + pure $ case totalRecords `quotRem` pageSize of + (pages, 0) -> pages + (pages, _) -> pages + 1 + +totalRecordsForTable :: (?modelContext :: ModelContext) => Text -> IO Int +totalRecordsForTable table = sqlQueryScalar (PG.Query $ cs $ "SELECT COUNT(*) FROM " <> table) () diff --git a/IHP/Job/Dashboard/View.hs b/IHP/Job/Dashboard/View.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Dashboard/View.hs @@ -0,0 +1,305 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE GADTs #-} + +{-| +Module: IHP.Job.Dashboard.View +Description: Views for Job dashboard +-} +module IHP.Job.Dashboard.View where + +import IHP.Prelude +import IHP.ViewPrelude (JobStatus(..), ControllerContext, Html, View, hsx, html, timeAgo) +import qualified Data.List as List +import IHP.Job.Dashboard.Types +import IHP.Job.Dashboard.Utils +import IHP.Pagination.Types +import IHP.Pagination.ViewFunctions + +-- | Provides a type-erased view. This allows us to specify a view as a return type without needed +-- to know exactly what type the view will be, which in turn allows for custom implmentations of +-- almost all the view functions in this module. Go GADTs! +data SomeView where + SomeView :: forall a. (View a) => a -> SomeView + +-- | Since the only constructor for 'SomeView' requires that it is passed a 'View', we can use +-- that to implement a 'View' instance for 'SomeView' +instance View SomeView where + html (SomeView a) = let ?view = a in IHP.ViewPrelude.html a + +-- | Define how to render a list of views as a view. Just concatenate them together! +instance (View a) => View [a] where + html [] = [hsx||] + html (x:xs) = + -- need to nest let's here in order to satisfy the implicit ?view parameter for 'html'. + -- ?view needs to be the type of the view being rendered, so set it before each render + -- here we render single view + let ?view = x in + let current = IHP.ViewPrelude.html x in + -- now rendering a list view + let ?view = xs in + let rest = IHP.ViewPrelude.html xs in + [hsx|{current}{rest}|] + +-- | A view containing no data. Used occasionally as a default implementation for some functions. +data EmptyView = EmptyView +instance View EmptyView where + html _ = [hsx||] + +-- | A view constructed from some HTML. +newtype HtmlView = HtmlView Html +instance View HtmlView where + html (HtmlView html) = [hsx|{html}|] + +renderStatus job = case job.status of + JobStatusNotStarted -> [hsx|Not Started|] + JobStatusRunning -> [hsx|Running|] + JobStatusFailed -> [hsx|Failed|] + JobStatusSucceeded -> [hsx|Succeeded|] + JobStatusRetry -> [hsx|Retry|] + JobStatusTimedOut -> [hsx|Timed Out|] + +-- BASE JOB VIEW HELPERS -------------------------------- + +renderBaseJobTable :: Text -> [BaseJob] -> Html +renderBaseJobTable table rows = + let + headers :: [Text] = ["ID", "Updated At", "Status", "", ""] + humanTitle = table |> columnNameToFieldLabel + in [hsx| +
    +
    +

    {humanTitle}

    + {renderNewBaseJobLink table} +
    + + + + {forEach headers renderHeader} + + + + + {forEach rows renderBaseJobTableRow} + +
    + See all {humanTitle} +
    +
    +|] + where renderHeader field = [hsx|{field}|] + +renderBaseJobTablePaginated :: Text -> [BaseJob] -> Pagination -> Html +renderBaseJobTablePaginated table jobs pagination = + let + headers :: [Text] = ["ID", "Updated At", "Status", "", ""] + lastJobIndex = (List.length jobs) - 1 + in + [hsx| +
    +
    +

    {table |> columnNameToFieldLabel}

    + {renderNewBaseJobLink table} +
    + + + + {forEach headers renderHeader} + + + + + {forEach jobs renderBaseJobTableRow} + +
    +
    + {renderPagination pagination} + |] + where + renderHeader field = [hsx|{field}|] + +renderBaseJobTableRow :: BaseJob -> Html +renderBaseJobTableRow job = [hsx| + + {job.id} + {job.updatedAt |> timeAgo} + {renderStatus job} + Show + +
    + +
    + + + |] + +-- | Link included in table to create a new job. +renderNewBaseJobLink :: Text -> Html +renderNewBaseJobLink table = + let + link = "/jobs/CreateJob?tableName=" <> table + in [hsx| +
    + +
    + |] + +renderNewBaseJobForm :: Text -> Html +renderNewBaseJobForm table = [hsx| +
    +
    New Job: {table}
    +
    +
    + + +
    +|] + +renderBaseJobDetailView :: BaseJob -> Html +renderBaseJobDetailView job = let table = job.table in [hsx| +
    +
    Viewing Job {job.id} in {table |> columnNameToFieldLabel}
    +
    + + + + + + + + + + + + + + + + + + + +
    Updated At{job.updatedAt |> timeAgo} ({job.updatedAt})
    Created At{job.createdAt |> timeAgo} ({job.createdAt})
    Status{renderStatus job}
    Last Error{fromMaybe "No error" (job.lastError)}
    + +
    +
    + + + +
    +
    + + + +
    +
    +|] +------------------------------------------------------------------ + +-- TABLE VIEWABLE view helpers ----------------------------------- +makeDashboardSectionFromTableViewable :: forall a. (TableViewable a + , ?context :: ControllerContext + , ?modelContext :: ModelContext) => IO SomeView +makeDashboardSectionFromTableViewable = do + indexRows <- getIndex @a + pure $ SomeView $ HtmlView $ renderTableViewableTable indexRows + +renderTableViewableTable :: forall a. TableViewable a => [a] -> Html +renderTableViewableTable rows = let + headers = tableHeaders @a + title = tableTitle @a + link = newJobLink @a + renderRow = renderTableRow @a + table = modelTableName @a + in [hsx| +
    +
    +

    {title}

    + {link} +
    + + + + {forEach headers renderHeader} + + + + + {forEach rows renderRow} + +
    + See all {title} +
    +
    +|] + where renderHeader field = [hsx|{field}|] + + + +makeListPageFromTableViewable :: forall a. (TableViewable a, ?context :: ControllerContext, ?modelContext :: ModelContext) => Int -> Int -> IO SomeView +makeListPageFromTableViewable page pageSize = do + pageData <- getPage @a (page - 1) pageSize + numPages <- numberOfPagesForTable (modelTableName @a) pageSize + pure $ SomeView $ HtmlView $ renderTableViewableTablePaginated pageData page numPages + +renderTableViewableTablePaginated :: forall a. TableViewable a => [a] -> Int -> Int -> Html +renderTableViewableTablePaginated jobs page totalPages = + let + title = tableTitle @a + table = modelTableName @a + headers = tableHeaders @a + lastJobIndex = (List.length jobs) - 1 + newLink = newJobLink @a + in + [hsx| +
    +
    +

    {title}

    + {newLink} +
    + + + + {forEach headers renderHeader} + + + + + {forEach jobs renderTableRow} + +
    +
    + + |] + where + renderHeader field = [hsx|{field}|] + renderDest = let table = modelTableName @a in [hsx|
  • {page}
    • |] + renderPrev + | page == 1 = [hsx||] + | otherwise = let table = modelTableName @a in [hsx| +
  • + + + Previous + +
    • + |] + renderNext + | page == totalPages || totalPages == 0 = [hsx||] + | otherwise = let table = modelTableName @a in [hsx| +
  • + + + Next + +
    • + |] +------------------------------------------------------------ + +retryButtonStyle :: Text +retryButtonStyle = "outline: none !important; padding: 0; border: 0; vertical-align: baseline;" diff --git a/IHP/Job/Queue.hs b/IHP/Job/Queue.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Queue.hs @@ -0,0 +1,269 @@ +{-| +Module: IHP.Job.Queue +Description: Functions to operate on the Job Queue Database +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Job.Queue where + +import IHP.Prelude +import IHP.Job.Types +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple.FromField as PG +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Control.Concurrent.Async as Async +import qualified Control.Concurrent as Concurrent +import IHP.ModelSupport +import IHP.QueryBuilder +import IHP.Fetch +import IHP.Controller.Param +import qualified System.Random as Random +import qualified IHP.PGListener as PGListener +import qualified IHP.Log as Log +import Control.Monad.Trans.Resource + +-- | Lock and fetch the next available job. In case no job is available returns Nothing. +-- +-- The lock is set on the job row in an atomic way. +-- +-- The job status is set to JobStatusRunning, lockedBy will be set to the worker id and the attemptsCount is incremented. +-- +-- __Example:__ Locking a SendMailJob +-- +-- > let workerId :: UUID = "faa5ba30-1d76-4adf-bf01-2d1f95cddc04" +-- > job <- fetchNextJob @SendMailJob workerId +-- +-- After you're done with the job, call 'jobDidFail' or 'jobDidSucceed' to make it available to the queue again. +fetchNextJob :: forall job. + ( ?modelContext :: ModelContext + , job ~ GetModelByTableName (GetTableName job) + , FilterPrimaryKey (GetTableName job) + , FromRow job + , Show (PrimaryKey (GetTableName job)) + , PG.FromField (PrimaryKey (GetTableName job)) + , Table job + ) => Maybe Int -> BackoffStrategy -> UUID -> IO (Maybe job) +fetchNextJob timeoutInMicroseconds backoffStrategy workerId = do + let query = PG.Query ("UPDATE ? SET status = ?, locked_at = NOW(), locked_by = ?, attempts_count = attempts_count + 1 WHERE id IN (SELECT id FROM ? WHERE (((status = ?) OR (status = ? AND " <> retryQuery backoffStrategy <> ")) AND locked_by IS NULL AND run_at <= NOW()) " <> timeoutCondition timeoutInMicroseconds <> " ORDER BY created_at LIMIT 1 FOR UPDATE) RETURNING id") + let params = (PG.Identifier (tableName @job), JobStatusRunning, workerId, PG.Identifier (tableName @job), JobStatusNotStarted, JobStatusRetry, backoffStrategy.delayInSeconds, timeoutInMicroseconds) + + result :: [PG.Only (Id job)] <- withoutQueryLogging (sqlQuery query params) + case result of + [] -> pure Nothing + [PG.Only id] -> Just <$> withoutQueryLogging (fetch id) + otherwise -> error (show otherwise) + +-- | Calls a callback every time something is inserted, updated or deleted in a given database table. +-- +-- In the background this function creates a database trigger to notify this function about table changes +-- using pg_notify. When there are existing triggers, it will silently recreate them. So this will most likely +-- not fail. +-- +-- This function returns a Async. Call 'cancel' on the async to stop watching the database. +-- +-- __Example:__ +-- +-- > watchInsertOrUpdateTable "projects" do +-- > putStrLn "Something changed in the projects table" +-- +-- Now insert something into the @projects@ table. E.g. by running @make psql@ and then running @INSERT INTO projects (id, name) VALUES (DEFAULT, 'New project');@ +-- You will see that @"Something changed in the projects table"@ is printed onto the screen. +-- +watchForJob :: (?modelContext :: ModelContext) => PGListener.PGListener -> Text -> Int -> Maybe Int -> BackoffStrategy -> Concurrent.MVar JobWorkerProcessMessage -> ResourceT IO (PGListener.Subscription, ReleaseKey) +watchForJob pgListener tableName pollInterval timeoutInMicroseconds backoffStrategy onNewJob = do + let tableNameBS = cs tableName + liftIO $ withoutQueryLogging (sqlExec (createNotificationTrigger tableNameBS) ()) + + poller <- pollForJob tableName pollInterval timeoutInMicroseconds backoffStrategy onNewJob + subscription <- liftIO $ pgListener |> PGListener.subscribe (channelName tableNameBS) (const (Concurrent.putMVar onNewJob JobAvailable)) + + pure (subscription, poller) + +-- | Periodically checks the queue table for open jobs. Calls the callback if there are any. +-- +-- 'watchForJob' only catches jobs when something is changed on the table. When a job is scheduled +-- with a 'runAt' in the future, and no other operation is happening on the queue, the database triggers +-- will not run, and so 'watchForJob' cannot pick up the job even when 'runAt' is now in the past. +-- +-- This function returns a Async. Call 'cancel' on the async to stop polling the database. +-- +pollForJob :: (?modelContext :: ModelContext) => Text -> Int -> Maybe Int -> BackoffStrategy -> Concurrent.MVar JobWorkerProcessMessage -> ResourceT IO ReleaseKey +pollForJob tableName pollInterval timeoutInMicroseconds backoffStrategy onNewJob = do + let query = PG.Query ("SELECT COUNT(*) FROM ? WHERE (((status = ?) OR (status = ? AND " <> retryQuery backoffStrategy <> ")) AND locked_by IS NULL AND run_at <= NOW()) " <> timeoutCondition timeoutInMicroseconds <> " LIMIT 1") + let params = (PG.Identifier tableName, JobStatusNotStarted, JobStatusRetry, backoffStrategy.delayInSeconds, timeoutInMicroseconds) + let handler = do + forever do + -- We don't log the queries to the console as it's filling up the log entries with noise + count :: Int <- withoutQueryLogging (sqlQueryScalar query params) + + -- For every job we send one signal to the job workers + -- This way we use full concurrency when we find multiple jobs + -- that haven't been picked up by the PGListener + forEach [1..count] \_ -> do + Concurrent.putMVar onNewJob JobAvailable + + -- Add up to 2 seconds of jitter to avoid all job queues polling at the same time + jitter <- Random.randomRIO (0, 2000000) + let pollIntervalWithJitter = pollInterval + jitter + + Concurrent.threadDelay pollIntervalWithJitter + + fst <$> allocate (Async.async handler) Async.cancel + +createNotificationTrigger :: ByteString -> PG.Query +createNotificationTrigger tableName = PG.Query $ "" + <> "BEGIN;\n" + <> "CREATE OR REPLACE FUNCTION " <> functionName <> "() RETURNS TRIGGER AS $$" + <> "BEGIN\n" + <> " PERFORM pg_notify('" <> channelName tableName <> "', '');\n" + <> " RETURN new;" + <> "END;\n" + <> "$$ language plpgsql;" + <> "DROP TRIGGER IF EXISTS " <> insertTriggerName <> " ON " <> tableName <> "; CREATE TRIGGER " <> insertTriggerName <> " AFTER INSERT ON \"" <> tableName <> "\" FOR EACH ROW WHEN (NEW.status = 'job_status_not_started' OR NEW.status = 'job_status_retry') EXECUTE PROCEDURE " <> functionName <> "();\n" + <> "DROP TRIGGER IF EXISTS " <> updateTriggerName <> " ON " <> tableName <> "; CREATE TRIGGER " <> updateTriggerName <> " AFTER UPDATE ON \"" <> tableName <> "\" FOR EACH ROW WHEN (NEW.status = 'job_status_not_started' OR NEW.status = 'job_status_retry') EXECUTE PROCEDURE " <> functionName <> "();\n" + <> "COMMIT;" + where + functionName = "notify_job_queued_" <> tableName + insertTriggerName = "did_insert_job_" <> tableName + updateTriggerName = "did_update_job_" <> tableName + +-- | Retuns the event name of the event that the pg notify trigger dispatches +channelName :: ByteString -> ByteString +channelName tableName = "job_available_" <> tableName + +-- | Called when a job failed. Sets the job status to 'JobStatusFailed' or 'JobStatusRetry' (if more attempts are possible) and resets 'lockedBy' +jobDidFail :: forall job context. + ( job ~ GetModelByTableName (GetTableName job) + , SetField "lockedBy" job (Maybe UUID) + , SetField "status" job JobStatus + , SetField "updatedAt" job UTCTime + , HasField "attemptsCount" job Int + , SetField "lastError" job (Maybe Text) + , Job job + , CanUpdate job + , Show job + , ?modelContext :: ModelContext + , ?context :: context + , HasField "logger" context Log.Logger + ) => job -> SomeException -> IO () +jobDidFail job exception = do + updatedAt <- getCurrentTime + + Log.warn ("Failed job with exception: " <> tshow exception) + + let ?job = job + let canRetry = job.attemptsCount < maxAttempts + let status = if canRetry then JobStatusRetry else JobStatusFailed + job + |> set #status status + |> set #lockedBy Nothing + |> set #updatedAt updatedAt + |> set #lastError (Just (tshow exception)) + |> updateRecord + + pure () + +jobDidTimeout :: forall job context. + ( job ~ GetModelByTableName (GetTableName job) + , SetField "lockedBy" job (Maybe UUID) + , SetField "status" job JobStatus + , SetField "updatedAt" job UTCTime + , HasField "attemptsCount" job Int + , SetField "lastError" job (Maybe Text) + , Job job + , CanUpdate job + , Show job + , ?modelContext :: ModelContext + , ?context :: context + , HasField "logger" context Log.Logger + ) => job -> IO () +jobDidTimeout job = do + updatedAt <- getCurrentTime + + Log.warn ("Job timed out" :: Text) + + let ?job = job + let canRetry = job.attemptsCount < maxAttempts + let status = if canRetry then JobStatusRetry else JobStatusTimedOut + job + |> set #status status + |> set #lockedBy Nothing + |> set #updatedAt updatedAt + |> setJust #lastError "Timeout reached" + |> updateRecord + + pure () + + +-- | Called when a job succeeded. Sets the job status to 'JobStatusSucceded' and resets 'lockedBy' +jobDidSucceed :: forall job context. + ( job ~ GetModelByTableName (GetTableName job) + , SetField "lockedBy" job (Maybe UUID) + , SetField "status" job JobStatus + , SetField "updatedAt" job UTCTime + , HasField "attemptsCount" job Int + , SetField "lastError" job (Maybe Text) + , Job job + , CanUpdate job + , Show job + , ?modelContext :: ModelContext + , ?context :: context + , HasField "logger" context Log.Logger + ) => job -> IO () +jobDidSucceed job = do + Log.info ("Succeeded job" :: Text) + updatedAt <- getCurrentTime + job + |> set #status JobStatusSucceeded + |> set #lockedBy Nothing + |> set #updatedAt updatedAt + |> updateRecord + + pure () + +-- | Mapping for @JOB_STATUS@: +-- +-- > CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry'); +instance PG.FromField JobStatus where + fromField field (Just "job_status_not_started") = pure JobStatusNotStarted + fromField field (Just "job_status_running") = pure JobStatusRunning + fromField field (Just "job_status_failed") = pure JobStatusFailed + fromField field (Just "job_status_timed_out") = pure JobStatusTimedOut + fromField field (Just "job_status_succeeded") = pure JobStatusSucceeded + fromField field (Just "job_status_retry") = pure JobStatusRetry + fromField field (Just value) = PG.returnError PG.ConversionFailed field ("Unexpected value for enum value. Got: " <> cs value) + fromField field Nothing = PG.returnError PG.UnexpectedNull field "Unexpected null for enum value" + +-- The default state is @not started@ +instance Default JobStatus where + def = JobStatusNotStarted + +-- | Mapping for @JOB_STATUS@: +-- +-- > CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry'); +instance PG.ToField JobStatus where + toField JobStatusNotStarted = PG.toField ("job_status_not_started" :: Text) + toField JobStatusRunning = PG.toField ("job_status_running" :: Text) + toField JobStatusFailed = PG.toField ("job_status_failed" :: Text) + toField JobStatusTimedOut = PG.toField ("job_status_timed_out" :: Text) + toField JobStatusSucceeded = PG.toField ("job_status_succeeded" :: Text) + toField JobStatusRetry = PG.toField ("job_status_retry" :: Text) + +instance InputValue JobStatus where + inputValue JobStatusNotStarted = "job_status_not_started" :: Text + inputValue JobStatusRunning = "job_status_running" :: Text + inputValue JobStatusFailed = "job_status_failed" :: Text + inputValue JobStatusTimedOut = "job_status_timed_out" :: Text + inputValue JobStatusSucceeded = "job_status_succeeded" :: Text + inputValue JobStatusRetry = "job_status_retry" :: Text + +instance IHP.Controller.Param.ParamReader JobStatus where + readParameter = IHP.Controller.Param.enumParamReader + +retryQuery :: BackoffStrategy -> ByteString +retryQuery LinearBackoff {} = "updated_at < NOW() + (interval '1 second' * ?)" +retryQuery ExponentialBackoff {} = "updated_at < NOW() - interval '1 second' * ? * POW(2, attempts_count)" + +timeoutCondition :: Maybe Int -> ByteString +timeoutCondition (Just timeoutInMicroseconds) = "OR (status = 'job_status_running' AND locked_by IS NOT NULL AND locked_at + ((? + 1000000) || 'microseconds')::interval < NOW())" -- Add 1000000 here to avoid race condition with the Haskell based timeout mechanism +timeoutCondition Nothing = "AND (? IS NULL)" diff --git a/IHP/Job/Runner.hs b/IHP/Job/Runner.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Runner.hs @@ -0,0 +1,198 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-| +Module: IHP.Job.Runner +Description: Functions to run jobs +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Job.Runner where + +import IHP.Prelude +import IHP.ControllerPrelude +import IHP.ScriptSupport +import qualified IHP.Job.Queue as Queue +import qualified Control.Exception.Safe as Exception +import qualified Database.PostgreSQL.Simple.FromField as PG +import qualified Data.UUID.V4 as UUID +import qualified Control.Concurrent as Concurrent +import qualified Control.Concurrent.Async as Async +import qualified System.Posix.Signals as Signals +import qualified System.Exit as Exit +import qualified System.Timeout as Timeout +import qualified IHP.PGListener as PGListener +import Control.Monad.Trans.Resource +import qualified IHP.Log as Log + +-- | Used by the RunJobs binary +runJobWorkers :: [JobWorker] -> Script +runJobWorkers jobWorkers = dedicatedProcessMainLoop jobWorkers + +-- | This job worker main loop is used when the job workers are running as part of their own binary +-- +-- In dev mode the IHP dev server is using the 'devServerMainLoop' instead. We have two main loops +-- as the stop handling works a different in those cases. +-- +dedicatedProcessMainLoop :: (?modelContext :: ModelContext, ?context :: FrameworkConfig) => [JobWorker] -> IO () +dedicatedProcessMainLoop jobWorkers = do + threadId <- Concurrent.myThreadId + exitSignalsCount <- newIORef 0 + workerId <- UUID.nextRandom + let logger = ?context.logger + + Log.info ("Starting worker " <> tshow workerId) + + -- The job workers use their own dedicated PG listener as e.g. AutoRefresh or DataSync + -- could overload the main PGListener connection. In that case we still want jobs to be + -- run independent of the system being very busy. + PGListener.withPGListener ?modelContext \pgListener -> do + stopSignal <- Concurrent.newEmptyMVar + + runResourceT do + waitForExitSignal <- liftIO installSignalHandlers + + let jobWorkerArgs = JobWorkerArgs { workerId, modelContext = ?modelContext, frameworkConfig = ?context, pgListener } + + processes <- jobWorkers + |> mapM (\(JobWorker listenAndRun)-> listenAndRun jobWorkerArgs) + + liftIO waitForExitSignal + + liftIO $ Log.info ("Waiting for jobs to complete. CTRL+C again to force exit" :: Text) + + -- Stop subscriptions and poller already + -- This will stop all producers for the queue MVar + liftIO $ forEach processes \JobWorkerProcess { pollerReleaseKey, subscription, action } -> do + PGListener.unsubscribe subscription pgListener + release pollerReleaseKey + Concurrent.putMVar action Stop + + liftIO $ PGListener.stop pgListener + + -- While waiting for all jobs to complete, we also wait for another exit signal + -- If the user sends two exit signals, we just kill all processes + liftIO $ async do + waitForExitSignal + + Log.info ("Canceling all running jobs. CTRL+C again to force exit" :: Text) + + forEach processes \JobWorkerProcess { runners } -> do + forEach runners \(releaseKey, _) -> release releaseKey + + Concurrent.throwTo threadId Exit.ExitSuccess + + pure () + + -- Wait for all runners to complete + liftIO $ forEach processes \JobWorkerProcess { runners } -> do + forEach runners \(_, async) -> Async.wait async + + liftIO $ Concurrent.throwTo threadId Exit.ExitSuccess + +devServerMainLoop :: (?modelContext :: ModelContext) => FrameworkConfig -> PGListener.PGListener -> [JobWorker] -> IO () +devServerMainLoop frameworkConfig pgListener jobWorkers = do + workerId <- UUID.nextRandom + let ?context = frameworkConfig + let logger = frameworkConfig.logger + + Log.info ("Starting worker " <> tshow workerId) + + runResourceT do + let jobWorkerArgs = JobWorkerArgs { workerId, modelContext = ?modelContext, frameworkConfig = ?context, pgListener } + + processes <- jobWorkers + |> mapM (\(JobWorker listenAndRun) -> listenAndRun jobWorkerArgs) + + liftIO $ (forever (Concurrent.threadDelay maxBound)) `Exception.finally` do + forEach processes \JobWorkerProcess { action } -> do + Concurrent.putMVar action Stop + +-- | Installs signals handlers and returns an IO action that blocks until the next sigINT or sigTERM is sent +installSignalHandlers :: IO (IO ()) +installSignalHandlers = do + exitSignal <- Concurrent.newEmptyMVar + + let catchHandler = Concurrent.putMVar exitSignal () + + Signals.installHandler Signals.sigINT (Signals.Catch catchHandler) Nothing + Signals.installHandler Signals.sigTERM (Signals.Catch catchHandler) Nothing + + pure (Concurrent.takeMVar exitSignal) + +stopExitHandler JobWorkerArgs { .. } main = main + +worker :: forall job. + ( job ~ GetModelByTableName (GetTableName job) + , FilterPrimaryKey (GetTableName job) + , FromRow job + , Show (PrimaryKey (GetTableName job)) + , PG.FromField (PrimaryKey (GetTableName job)) + , KnownSymbol (GetTableName job) + , SetField "attemptsCount" job Int + , SetField "lockedBy" job (Maybe UUID) + , SetField "status" job JobStatus + , SetField "updatedAt" job UTCTime + , HasField "runAt" job UTCTime + , HasField "attemptsCount" job Int + , SetField "lastError" job (Maybe Text) + , Job job + , CanUpdate job + , Show job + , Table job + ) => JobWorker +worker = JobWorker (jobWorkerFetchAndRunLoop @job) + + +jobWorkerFetchAndRunLoop :: forall job. + ( job ~ GetModelByTableName (GetTableName job) + , FilterPrimaryKey (GetTableName job) + , FromRow job + , Show (PrimaryKey (GetTableName job)) + , PG.FromField (PrimaryKey (GetTableName job)) + , KnownSymbol (GetTableName job) + , SetField "attemptsCount" job Int + , SetField "lockedBy" job (Maybe UUID) + , SetField "status" job JobStatus + , SetField "updatedAt" job UTCTime + , HasField "attemptsCount" job Int + , SetField "lastError" job (Maybe Text) + , Job job + , CanUpdate job + , Show job + , Table job + ) => JobWorkerArgs -> ResourceT IO JobWorkerProcess +jobWorkerFetchAndRunLoop JobWorkerArgs { .. } = do + let ?context = frameworkConfig + let ?modelContext = modelContext + action <- liftIO $ Concurrent.newMVar JobAvailable + let loop = do + receivedAction <- Concurrent.takeMVar action + + case receivedAction of + JobAvailable -> do + maybeJob <- Queue.fetchNextJob @job (timeoutInMicroseconds @job) (backoffStrategy @job) workerId + case maybeJob of + Just job -> do + Log.info ("Starting job: " <> tshow job) + + let ?job = job + let timeout :: Int = fromMaybe (-1) (timeoutInMicroseconds @job) + resultOrException <- Exception.tryAsync (Timeout.timeout timeout (perform job)) + case resultOrException of + Left exception -> do + Queue.jobDidFail job exception + when (Exception.isAsyncException exception) (Exception.throwIO exception) + Right Nothing -> Queue.jobDidTimeout job + Right (Just _) -> Queue.jobDidSucceed job + + loop + Nothing -> loop + Stop -> do + -- Put the stop signal back in to stop the other runners as well + Concurrent.putMVar action Stop + pure () + + runners <- forM [1..(maxConcurrency @job)] \index -> allocate (async loop) cancel + + (subscription, pollerReleaseKey) <- Queue.watchForJob pgListener (tableName @job) (queuePollInterval @job) (timeoutInMicroseconds @job) (backoffStrategy @job) action + + + pure JobWorkerProcess { runners, subscription, pollerReleaseKey, action } diff --git a/IHP/Job/Types.hs b/IHP/Job/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Job/Types.hs @@ -0,0 +1,85 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +module IHP.Job.Types +( Job (..) +, JobWorkerArgs (..) +, JobWorker (..) +, JobStatus (..) +, Worker (..) +, JobWorkerProcess (..) +, JobWorkerProcessMessage (..) +, BackoffStrategy (..) +) +where + +import IHP.Prelude +import IHP.FrameworkConfig +import qualified IHP.PGListener as PGListener +import qualified Control.Concurrent as Concurrent +import Control.Monad.Trans.Resource + +data BackoffStrategy + = LinearBackoff { delayInSeconds :: !Int } + | ExponentialBackoff { delayInSeconds :: !Int } + deriving (Eq, Show) + +class Job job where + perform :: (?modelContext :: ModelContext, ?context :: FrameworkConfig) => job -> IO () + + maxAttempts :: (?job :: job) => Int + maxAttempts = 10 + + timeoutInMicroseconds :: Maybe Int + timeoutInMicroseconds = Nothing + + -- | While jobs are typically fetch using pg_notiy, we have to poll the queue table + -- periodically to catch jobs with a @run_at@ in the future + -- + -- By default we only poll every minute + queuePollInterval :: Int + queuePollInterval = 60 * 1000000 + + -- | How many jobs of this type can be executed at the same time + -- + -- This limit only applies to the running haskell process. If you run @N@ multiple + -- independent processes of the job runner, the limit will be @N * maxConcurrency@ + maxConcurrency :: Int + maxConcurrency = 16 + + backoffStrategy :: BackoffStrategy + backoffStrategy = LinearBackoff { delayInSeconds = 30 } + +class Worker application where + workers :: application -> [JobWorker] + +data JobWorkerArgs = JobWorkerArgs + { workerId :: UUID + , modelContext :: ModelContext + , frameworkConfig :: FrameworkConfig + , pgListener :: PGListener.PGListener + } + +newtype JobWorker = JobWorker (JobWorkerArgs -> ResourceT IO JobWorkerProcess) + +-- | Mapping for @JOB_STATUS@. The DDL statement for this can be found in IHPSchema.sql: +-- +-- > CREATE TYPE JOB_STATUS AS ENUM ('job_status_not_started', 'job_status_running', 'job_status_failed', 'job_status_succeeded', 'job_status_retry'); +data JobStatus + = JobStatusNotStarted + | JobStatusRunning + | JobStatusFailed + | JobStatusTimedOut + | JobStatusSucceeded + | JobStatusRetry + deriving (Eq, Show, Read, Enum) + +data JobWorkerProcess + = JobWorkerProcess + { runners :: [(ReleaseKey, Async ())] + , subscription :: PGListener.Subscription + , pollerReleaseKey :: ReleaseKey + , action :: Concurrent.MVar JobWorkerProcessMessage + } + +data JobWorkerProcessMessage + = JobAvailable + | Stop diff --git a/IHP/Log.hs b/IHP/Log.hs new file mode 100644 --- /dev/null +++ b/IHP/Log.hs @@ -0,0 +1,122 @@ +{-| +Module: IHP.Log +Description: Functions to write logs at all log levels. + +Import this module qualified! All code examples +assume you have imported the module as follows: + +> import qualified IHP.Log as Log + +-} +module IHP.Log +( module IHP.Log.Types +, debug +, info +, warn +, error +, fatal +, unknown +, makeRequestLogger +, defaultRequestLogger +) where + +import IHP.HaskellSupport hiding (debug) + +import CorePrelude hiding (putStr, putStrLn, print, error, show, log, debug) +import Control.Monad (when) +import IHP.Log.Types +import Network.Wai (Middleware) +import Network.Wai.Middleware.RequestLogger (mkRequestLogger, RequestLoggerSettings, destination) +import qualified Network.Wai.Middleware.RequestLogger as RequestLogger +import Data.Default (Default (def)) +import qualified System.Log.FastLogger as FastLogger + +-- | Format a log and send it to the logger. +-- Internal use only -- application code should call the +-- function corresponding to the desired log level. +log :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => LogLevel -> string -> IO () +log level text = do + writeLog level ?context.logger text + +-- | Log a debug level message. +-- +-- > action CreateUserAction { .. } = do +-- > Log.debug "entered CreateUserAction" +-- > ... +debug :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +debug = log Debug + +-- | Log an info level message. +-- +-- > action UsersAction = do +-- > users <- query @User |> fetch +-- > Log.info $ show (lengh users) <> " users fetched." +-- > ... +info :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +info = log Info + +-- | Log a warning level message. +-- +-- > action UsersAction = do +-- > users <- query @User |> fetch +-- > whenEmpty users $ Log.warn "No users found. Something might be wrong!" +-- > ... +warn :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +warn = log Warn + +-- |Log a warning level message. +-- +-- @ +-- action CreatePostAction = do +-- let post = newRecord @Post +-- post +-- |> buildPost +-- |> ifValid \case +-- Left post -> do +-- Log.error "Invalid post." +-- render NewView { .. } +-- Right post -> do +-- post <- post |> createRecord +-- setSuccessMessage "Post created" +-- redirectTo PostsAction +-- @ +error :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +error = log Error + +-- | Log a fatal level message. +-- Note this does not exit the program for you -- it only logs to the "Fatal" log level. +-- +-- > Log.fatal "Unrecoverable application error!" +fatal :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +fatal = log Fatal + +-- | Log an "unknown" level message. +-- This is the highest log level and will always be output by the logger. +-- +-- > Log.unknown "This will be sent to the logger no matter what!" +unknown :: (?context :: context, LoggingProvider context, FastLogger.ToLogStr string) => string -> IO () +unknown = log Unknown + +-- | Write a log if the given log level is greater than or equal to the logger's log level. +writeLog :: (FastLogger.ToLogStr string) => LogLevel -> Logger -> string -> IO () +writeLog level logger text = do + let write = logger.write + let formatter = logger.formatter + when (level >= logger.level) do + write (\time -> formatter time level (toLogStr text)) + +-- | Wraps 'RequestLogger' from wai-extra to log to an IHP logger. +-- See 'Network.Wai.Middleware.RequestLogger'. +makeRequestLogger :: RequestLoggerSettings -> Logger -> IO Middleware +makeRequestLogger settings logger = + mkRequestLogger settings { + destination = RequestLogger.Callback (\logStr -> + let ?context = logger in + logStr |> fromLogStr |> info + ) + } + +-- | Create a request logger with default settings wrapped in an IHP logger. +-- See 'Network.Wai.Middleware.RequestLogger'. +defaultRequestLogger :: Logger -> IO Middleware +defaultRequestLogger = makeRequestLogger def diff --git a/IHP/Log/Types.hs b/IHP/Log/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Log/Types.hs @@ -0,0 +1,252 @@ +{-# LANGUAGE ConstraintKinds #-} +{-| +Module: IHP.Log.Types +Description: Types for the IHP logging system +-} + +module IHP.Log.Types +( Bytes(..) +, LogStr +, BufSize +, TimeFormat +, RotateSettings(..) +, toLogStr +, fromLogStr +, defaultBufSize +, simpleTimeFormat +, simpleTimeFormat' +, Logger(..) +, LogLevel(..) +, LogDestination(..) +, LoggingProvider(..) +, LoggerSettings(..) +, LogFormatter +, FormattedTime +, newLogger +, defaultLogger +, defaultDestination +, defaultFormatter +, withLevelFormatter +, withTimeFormatter +, withTimeAndLevelFormatter +) where + +import qualified Prelude +import CorePrelude hiding (putStr, putStrLn, print, error, show) +import Data.Text as Text +import Data.Default (Default (def)) +import System.Log.FastLogger ( + LogStr, + LogType'(..), + BufSize, + FileLogSpec(..), + TimedFileLogSpec(..), + TimeFormat, + toLogStr, + fromLogStr, + defaultBufSize, + newTimeCache, + simpleTimeFormat, + simpleTimeFormat', + newTimedFastLogger, + ToLogStr (..) + ) + +import qualified System.Log.FastLogger as FastLogger (FormattedTime) +import GHC.Records + + +-- some functions brought over from IHP.Prelude +-- can't import due to circular dependency with IHP.ModelSupport which relies on this module + +tshow :: Show a => a -> Text +tshow value = Text.pack (Prelude.show value) + +show :: Show a => a -> Text +show = tshow + +-- | Interal logger type that encapsulates information needed to perform +-- logging operations. Users can also access this though the 'LoggingProvider' +-- class in controller and model actions to perform logic based on the set log level. +data Logger = Logger { + write :: !((FastLogger.FormattedTime -> LogStr) -> IO ()), + level :: !LogLevel, + formatter :: !LogFormatter, + timeCache :: !(IO FastLogger.FormattedTime), + cleanup :: !(IO ()) +} + +data LogLevel + -- | For general messages to help with debugging during development. + -- Default log level in development. + -- Also the log level used for SQL queries. + -- See 'IHP.Log.debug' for example usage. + = Debug + -- | For info messages that help montior application usage. + -- Default log level for production. + -- See 'IHP.Log.info' for example usage. + | Info + -- | For warning messages when something might be wrong. + -- See 'IHP.Log.warn' for example usage. + | Warn + -- | For application errors that can be recovered from. + -- See 'IHP.Log.error' for example usage. + | Error + -- | For application errors that are fatal + -- See 'IHP.Log.fatal' for example usage. + | Fatal + -- | For miscallenaous log messages. Highest log level - will always be logged + -- See 'IHP.Log.unknown' for example usage. + | Unknown + deriving (Enum, Eq, Ord, Show) + +instance ToLogStr LogLevel where + toLogStr Debug = "DEBUG" + toLogStr Info = "INFO" + toLogStr Warn = "WARN" + toLogStr Error = "ERROR" + toLogStr Fatal = "FATAL" + toLogStr Unknown = "UNKNOWN" + +-- | The timestamp in the formatted defined by the logger's timeFormat string. +type FormattedTime = ByteString + +-- | Called every time a message is sent to the logger. +-- Since this is just a function type, it's trivial to define custom formatters: +-- +-- @ +-- withTimeAndLevelFormatterUpcaseAndHappy :: LogFormatter +-- withTimeAndLevelFormatterUpcaseAndHappy time level msg = +-- "[" <> toUpper (show level) <> "]" +-- <> "[" <> time <> "] " +-- <> toUpper msg <> " :) \n" +-- @ +type LogFormatter = FormattedTime -> LogLevel -> LogStr -> LogStr + +-- | A number of bytes, used in 'RotateSettings' +newtype Bytes = Bytes Integer + +data RotateSettings + -- | Log messages to a file which is never rotated. + -- + -- @ + -- newLogger def { + -- destination = File "Log/production.log" NoRotate defaultBufSize + -- } + -- @ + = NoRotate + -- | Log messages to a file and rotate the file after it reaches the given size in bytes. + -- Third argument is the max number of rotated log files to keep around before overwriting the oldest one. + -- + -- Example: log to a file rotated once it is 4MB, and keep 7 files before overwriting the first file. + -- + -- @ + -- newLogger def { + -- destination = File "Log/production.log" (SizeRotate (Bytes (4 * 1024 * 1024)) 7) defaultBufSize + -- } + -- @ + | SizeRotate !Bytes !Int + -- | Log messages to a file rotated on a timed basis. + -- Expects a time format string as well as a function which compares two formatted time strings + -- which is used to determine if the file should be rotated. + -- Last argument is a function which is called on a log file once its rotated. + -- + -- Example: rotate a file daily and compress the log file once rotated. + -- + -- @ + -- let + -- filePath = "Log/production.log" + -- formatString = "%FT%H%M%S" + -- timeCompare = (==) on C8.takeWhile (/=T)) + -- compressFile fp = void . forkIO $ + -- callProcess "tar" [ "--remove-files", "-caf", fp <> ".gz", fp ] + -- in + -- newLogger def { + -- destination = File + -- filePath + -- (TimedRotate formatString timeCompare compressFile) + -- defaultBufSize + -- } + -- @ + | TimedRotate !TimeFormat (FastLogger.FormattedTime -> FastLogger.FormattedTime -> Bool) (FilePath -> IO ()) + +-- | Where logged messages will be delivered to. +data LogDestination + = None + -- | Log messages to standard output. + | Stdout !BufSize + -- | Log messages to standard error. + | Stderr !BufSize + -- | Log message to a file. Rotate the log file with the behavior given by 'RotateSettings'. + | File !FilePath !RotateSettings !BufSize + -- | Send logged messages to a callback. Flush action called after every log. + | Callback !(LogStr -> IO ()) !(IO ()) + +data LoggerSettings = LoggerSettings { + level :: LogLevel, + formatter :: LogFormatter, + destination :: LogDestination, + timeFormat :: TimeFormat +} + +instance Default LoggerSettings where + def = LoggerSettings { + level = Debug, + formatter = defaultFormatter, + destination = defaultDestination, + timeFormat = simpleTimeFormat' + } + +-- | Logger default destination is to standard out. +defaultDestination :: LogDestination +defaultDestination = Stdout defaultBufSize + +-- | Used to get the logger for a given environment. +-- | Call in any instance of 'LoggingProvider' get the the environment's current logger. +-- Useful in controller and model actions, which both have logging contexts. +type LoggingProvider context = HasField "logger" context Logger + +instance HasField "logger" Logger Logger where + getField logger = logger + +-- | Create a new 'FastLogger' and wrap it in an IHP 'Logger'. +-- Use with the default logger settings and record update syntax for nice configuration: +-- +-- > newLogger def { level = Error } +newLogger :: LoggerSettings -> IO Logger +newLogger LoggerSettings { .. } = do + timeCache <- newTimeCache timeFormat + (write, cleanup) <- makeFastLogger timeCache destination + pure Logger { .. } + where + makeFastLogger timeCache destination = newTimedFastLogger timeCache $ + case destination of + None -> LogNone + Stdout buf -> LogStdout buf + Stderr buf -> LogStderr buf + File path settings buf -> makeFileLogger path settings buf + Callback callback flush -> LogCallback callback flush + + makeFileLogger path NoRotate = LogFileNoRotate path + makeFileLogger path (SizeRotate (Bytes size) count) = LogFile (FileLogSpec path size count) + makeFileLogger path (TimedRotate fmt cmp post) = LogFileTimedRotate (TimedFileLogSpec path fmt cmp post) + +-- | Formats logs as-is to stdout. +defaultLogger :: IO Logger +defaultLogger = newLogger def + +-- | Formats the log as-is with a newline added. +defaultFormatter :: LogFormatter +defaultFormatter _ _ msg = msg <> "\n" + +-- | Prepends the timestamp to the log message and adds a new line. +withTimeFormatter :: LogFormatter +withTimeFormatter time _ msg = "[" <> toLogStr time <> "] " <> msg <> "\n" + +-- | Prepends the log level to the log message and adds a new line. +withLevelFormatter :: LogFormatter +withLevelFormatter time level msg = "[" <> (toLogStr level) <> "] " <> msg <> "\n" + +-- | Prepends the log level and timestamp to the log message and adds a new line. +withTimeAndLevelFormatter :: LogFormatter +withTimeAndLevelFormatter time level msg = "[" <> (toLogStr level) <> "] [" <> toLogStr time <> "] " <> msg <> "\n" diff --git a/IHP/LoginSupport/Helper/Controller.hs b/IHP/LoginSupport/Helper/Controller.hs new file mode 100644 --- /dev/null +++ b/IHP/LoginSupport/Helper/Controller.hs @@ -0,0 +1,174 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +module IHP.LoginSupport.Helper.Controller +( currentUser +, currentUserOrNothing +, currentUserId +, ensureIsUser +, HasNewSessionUrl +, currentAdmin +, currentAdminOrNothing +, currentAdminId +, ensureIsAdmin +, login +, sessionKey +, logout +, CurrentUserRecord +, CurrentAdminRecord +, module IHP.AuthSupport.Authentication +, enableRowLevelSecurityIfLoggedIn +, currentRoleOrNothing +, currentRole +, currentRoleId +, ensureIsRole +) where + +import IHP.Prelude +import IHP.Controller.Redirect +import IHP.Controller.Session +import IHP.LoginSupport.Types +import qualified IHP.Controller.Session as Session +import IHP.FlashMessages.ControllerFunctions +import qualified IHP.ModelSupport as ModelSupport +import IHP.ControllerSupport +import System.IO.Unsafe (unsafePerformIO) +import IHP.AuthSupport.Authentication +import IHP.Controller.Context +import qualified IHP.FrameworkConfig as FrameworkConfig +import qualified Database.PostgreSQL.Simple.ToField as PG +import Data.Kind +import Data.Typeable + +currentRoleOrNothing :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user) => Maybe user +currentRoleOrNothing = case unsafePerformIO (maybeFromContext @(Maybe user)) of + Just user -> user + Nothing -> error ("initAuthentication @" <> show (typeRep (Proxy @user)) <> " has not been called in initContext inside FrontController of this application") +{-# INLINE currentRoleOrNothing #-} + +currentRole :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user) => user +currentRole = fromMaybe (redirectToLogin (newSessionUrl (Proxy @user))) (currentRoleOrNothing @user) +{-# INLINE currentRole #-} + +currentRoleId :: forall user userId. (?context :: ControllerContext, HasNewSessionUrl user, HasField "id" user userId, Typeable user) => userId +currentRoleId = (currentRole @user).id +{-# INLINE currentRoleId #-} + +ensureIsRole :: forall (user :: Type). (?context :: ControllerContext, HasNewSessionUrl user, Typeable user) => IO () +ensureIsRole = + case currentRoleOrNothing @user of + Just _ -> pure () + Nothing -> redirectToLoginWithMessage (newSessionUrl (Proxy :: Proxy user)) +{-# INLINABLE ensureIsRole #-} + +currentUser :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user, user ~ CurrentUserRecord) => user +currentUser = currentRole @user +{-# INLINABLE currentUser #-} + +currentUserOrNothing :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user, user ~ CurrentUserRecord) => (Maybe user) +currentUserOrNothing = currentRoleOrNothing @user +{-# INLINABLE currentUserOrNothing #-} + +currentUserId :: forall user userId. (?context :: ControllerContext, HasNewSessionUrl user, HasField "id" user userId, Typeable user, user ~ CurrentUserRecord) => userId +currentUserId = currentRoleId @user +{-# INLINABLE currentUserId #-} + +ensureIsUser :: forall user. (?context :: ControllerContext, HasNewSessionUrl user, Typeable user, user ~ CurrentUserRecord) => IO () +ensureIsUser = ensureIsRole @user +{-# INLINABLE ensureIsUser #-} + +currentAdmin :: forall admin. (?context :: ControllerContext, HasNewSessionUrl admin, Typeable admin, admin ~ CurrentAdminRecord) => admin +currentAdmin = currentRole @admin +{-# INLINABLE currentAdmin #-} + +currentAdminOrNothing :: forall admin. (?context :: ControllerContext, HasNewSessionUrl admin, Typeable admin, admin ~ CurrentAdminRecord) => (Maybe admin) +currentAdminOrNothing = currentRoleOrNothing @admin +{-# INLINABLE currentAdminOrNothing #-} + +currentAdminId :: forall admin adminId. (?context :: ControllerContext, HasNewSessionUrl admin, HasField "id" admin adminId, Typeable admin, admin ~ CurrentAdminRecord) => adminId +currentAdminId = currentRoleId @admin +{-# INLINABLE currentAdminId #-} + +ensureIsAdmin :: forall (admin :: Type). (?context :: ControllerContext, HasNewSessionUrl admin, Typeable admin, admin ~ CurrentAdminRecord) => IO () +ensureIsAdmin = ensureIsRole @admin +{-# INLINABLE ensureIsAdmin #-} + +-- | Log's in a user +-- +-- Examples: +-- +-- > action ExampleAction = do +-- > user <- query @User |> fetchOne +-- > login user +-- > +-- > redirectToPath "/" +-- +login :: forall user id. (?context :: ControllerContext, KnownSymbol (ModelSupport.GetModelName user), HasField "id" user id, Show id) => user -> IO () +login user = Session.setSession (sessionKey @user) (tshow (user.id)) +{-# INLINABLE login #-} + +-- | Log's out a user +-- +-- Example: +-- +-- > action LogoutAction = do +-- > let user = currentUser +-- > logout user +-- > +-- > redirectToPath "/" +-- +logout :: forall user. (?context :: ControllerContext, KnownSymbol (ModelSupport.GetModelName user)) => user -> IO () +logout user = Session.setSession (sessionKey @user) ("" :: Text) +{-# INLINABLE logout #-} + +sessionKey :: forall user. (KnownSymbol (ModelSupport.GetModelName user)) => ByteString +sessionKey = "login." <> cs (ModelSupport.getModelName @user) +{-# INLINABLE sessionKey #-} + +redirectToLoginWithMessage :: (?context :: ControllerContext) => Text -> IO () +redirectToLoginWithMessage newSessionPath = do + setSuccessMessage "Please log in to access this page" + setSession "IHP.LoginSupport.redirectAfterLogin" getRequestPathAndQuery + redirectToPath newSessionPath + error "Unreachable" + + +redirectToLogin :: (?context :: ControllerContext) => Text -> a +redirectToLogin newSessionPath = unsafePerformIO $ do + redirectToPath newSessionPath + error "Unreachable" + +-- | After this call the security policies defined in your Schema.sql will be applied to the controller actions called after this +-- +-- __Example:__ +-- +-- > instance InitControllerContext WebApplication where +-- > initContext = do +-- > initAuthentication @User +-- > enableRowLevelSecurityIfLoggedIn +-- +-- Let's assume we have a policy defined in our Schema.sql that only allows users to see and edit rows in the projects table that have @projects.user_id = current_user_id@: +-- +-- > CREATE POLICY "Users can manage their projects" ON projects USING (user_id = ihp_user_id()) WITH CHECK (user_id = ihp_user_id()); +-- +-- Now any database queries to our @projects@ table will have this policy applied. +-- +-- E.g. this action will now only show the users projects, even though no explicit @filterWhere (#userId, currentUserId)@ is specified on the query: +-- +-- > action ProjectsAction = do +-- > projects <- query @Project |> fetch +-- +enableRowLevelSecurityIfLoggedIn :: + ( ?context :: ControllerContext + , Typeable CurrentUserRecord + , HasNewSessionUrl CurrentUserRecord + , HasField "id" CurrentUserRecord userId + , PG.ToField userId + ) => IO () +enableRowLevelSecurityIfLoggedIn = do + case currentUserOrNothing of + Just user -> do + let rlsAuthenticatedRole = ?context.frameworkConfig.rlsAuthenticatedRole + let rlsUserId = PG.toField user.id + let rlsContext = ModelSupport.RowLevelSecurityContext { rlsAuthenticatedRole, rlsUserId} + putContext rlsContext + Nothing -> pure () diff --git a/IHP/LoginSupport/Helper/View.hs b/IHP/LoginSupport/Helper/View.hs new file mode 100644 --- /dev/null +++ b/IHP/LoginSupport/Helper/View.hs @@ -0,0 +1,27 @@ +module IHP.LoginSupport.Helper.View +( currentUser +, currentUserId +, currentUserOrNothing +, currentAdmin +, currentAdminOrNothing +) +where + +import IHP.Prelude +import IHP.Controller.Context +import IHP.LoginSupport.Helper.Controller (CurrentUserRecord, CurrentAdminRecord) + +currentUser :: (?context :: ControllerContext, user ~ CurrentUserRecord, Typeable user) => user +currentUser = fromMaybe (error "Application.Helper.View.currentUser: Not logged in") currentUserOrNothing + +currentUserId :: forall user userId. (?context :: ControllerContext, HasField "id" user userId, Typeable user, user ~ CurrentUserRecord) => userId +currentUserId = (currentUser @user).id + +currentUserOrNothing :: forall user. (?context :: ControllerContext, user ~ CurrentUserRecord, Typeable user) => Maybe user +currentUserOrNothing = fromFrozenContext @(Maybe user) + +currentAdmin :: (?context :: ControllerContext, admin ~ CurrentAdminRecord, Typeable admin) => admin +currentAdmin = fromMaybe (error "Application.Helper.View.currentAdmin: Not logged in") currentAdminOrNothing + +currentAdminOrNothing :: forall admin. (?context :: ControllerContext, admin ~ CurrentAdminRecord, Typeable admin) => Maybe admin +currentAdminOrNothing = fromFrozenContext @(Maybe admin) diff --git a/IHP/LoginSupport/Middleware.hs b/IHP/LoginSupport/Middleware.hs new file mode 100644 --- /dev/null +++ b/IHP/LoginSupport/Middleware.hs @@ -0,0 +1,30 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} + +module IHP.LoginSupport.Middleware (initAuthentication) where + +import IHP.Prelude +import IHP.LoginSupport.Helper.Controller +import IHP.Controller.Session +import IHP.QueryBuilder +import IHP.Fetch +import IHP.ControllerSupport +import IHP.ModelSupport +import IHP.Controller.Context + +{-# INLINE initAuthentication #-} +initAuthentication :: forall user normalizedModel. + ( ?context :: ControllerContext + , ?modelContext :: ModelContext + , normalizedModel ~ NormalizeModel user + , Typeable normalizedModel + , Table normalizedModel + , FromRow normalizedModel + , PrimaryKey (GetTableName normalizedModel) ~ UUID + , GetTableName normalizedModel ~ GetTableName user + , FilterPrimaryKey (GetTableName normalizedModel) + , KnownSymbol (GetModelName user) + ) => IO () +initAuthentication = do + user <- getSession @(Id user) (sessionKey @user) + >>= fetchOneOrNothing + putContext user diff --git a/IHP/LoginSupport/Types.hs b/IHP/LoginSupport/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/LoginSupport/Types.hs @@ -0,0 +1,15 @@ +{-# LANGUAGE ConstraintKinds, ConstrainedClassMethods, AllowAmbiguousTypes #-} + +module IHP.LoginSupport.Types +( HasNewSessionUrl (newSessionUrl) +, CurrentUserRecord +, CurrentAdminRecord +) where + +import IHP.Prelude + +class HasNewSessionUrl user where + newSessionUrl :: Proxy user -> Text + +type family CurrentUserRecord +type family CurrentAdminRecord diff --git a/IHP/Mail.hs b/IHP/Mail.hs new file mode 100644 --- /dev/null +++ b/IHP/Mail.hs @@ -0,0 +1,153 @@ +{-| +Module: IHP.Mail +Description: Send Emails +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Mail +( MailServer (..) +, BuildMail (..) +, SMTPEncryption ( ..) +, sendMail +, sendWithMailServer +) +where + +import IHP.Prelude +import IHP.Mail.Types +import IHP.FrameworkConfig + +import Network.Mail.Mime +import qualified Network.Mail.Mime.SES as Mailer +import qualified Network.Mail.SMTP as SMTP +import qualified Network.HTTP.Client +import qualified Network.HTTP.Client.TLS +import Text.Blaze.Html5 (Html) +import qualified Text.Blaze.Html.Renderer.Text as Blaze +import qualified Data.Text as Text +import Data.Maybe + +buildMail :: (BuildMail mail, ?context :: context, ConfigProvider context) => mail -> Mail +buildMail mail = + let ?mail = mail in + let mail' = simpleMailInMemory (to mail) from subject (cs $ text mail) (html mail |> Blaze.renderHtml) attachments' in + mail' { mailCc = cc mail + , mailBcc = bcc mail + , mailHeaders = ("Subject", subject) : h + } + where + h = case replyTo mail of + Nothing -> headers mail + Just replyTo -> ("Reply-To", renderAddress replyTo) : (headers mail) + + attachments' = mail + |> attachments + |> map (\MailAttachment { name, content, contentType } -> (contentType, name, content)) + +-- | Sends an email +-- +-- Uses the mail server provided in the controller context, configured in Config/Config.hs +sendMail :: (BuildMail mail, ?context :: context, ConfigProvider context) => mail -> IO () +sendMail mail = sendWithMailServer ?context.frameworkConfig.mailServer (buildMail mail) + +sendWithMailServer :: MailServer -> Mail -> IO () +sendWithMailServer SES { .. } mail = do + manager <- Network.HTTP.Client.newManager Network.HTTP.Client.TLS.tlsManagerSettings + let ses = Mailer.SES { + Mailer.sesFrom = cs $ addressEmail (mailFrom mail), + Mailer.sesTo = map (cs . addressEmail) ((mailTo mail) <> (mailCc mail) <> (mailBcc mail)), + Mailer.sesAccessKey = accessKey, + Mailer.sesSecretKey = secretKey, + Mailer.sesSessionToken = Nothing, + Mailer.sesRegion = region + } + Mailer.renderSendMailSES manager ses mail + +sendWithMailServer SendGrid { .. } mail = do + let mail' = if isJust category then mail {mailHeaders = ("X-SMTPAPI","{\"category\": \"" ++ (fromJust category) ++ "\"}") : headers} else mail + SMTP.sendMailWithLoginSTARTTLS' "smtp.sendgrid.net" 587 "apikey" (Text.unpack apiKey) mail' + where headers = mailHeaders mail + +sendWithMailServer IHP.Mail.Types.SMTP { .. } mail + | isNothing credentials = + case encryption of + Unencrypted -> SMTP.sendMail' host port mail + TLS -> SMTP.sendMailTLS' host port mail + STARTTLS -> SMTP.sendMailSTARTTLS' host port mail + | otherwise = + case encryption of + Unencrypted -> SMTP.sendMailWithLogin' host port (fst creds) (snd creds) mail + TLS -> SMTP.sendMailWithLoginTLS' host port (fst creds) (snd creds) mail + STARTTLS -> SMTP.sendMailWithLoginSTARTTLS' host port (fst creds) (snd creds) mail + where creds = fromJust credentials + +sendWithMailServer Sendmail mail = do + message <- renderMail' mail + sendmail message + +class BuildMail mail where + -- | You can use @?mail@ to make this dynamic based on the given entity + subject :: (?mail :: mail) => Text + + -- | The email receiver + -- + -- __Example:__ + -- + -- > to ConfirmationMail { .. } = Address { addressName = Just (user.name), addressEmail = user.email } + -- + -- __Example:__ Send all emails to a fixed email address while in development mode + -- + -- > to CreateAccountMail { .. } = Address + -- > { addressName = Just (fullName admin) + -- > , addressEmail = + -- > if isDevelopment then + -- > "staging@example.com" + -- > else + -- > admin.email + -- > } + -- + to :: (?context :: context, ConfigProvider context) => mail -> Address + + -- | Sets an optional reply-to address + replyTo :: (?context :: context, ConfigProvider context) => mail -> Maybe Address + replyTo mail = Nothing + + -- | Public list of addresses to receive a copy of the mail (CC) + cc :: (?context :: context, ConfigProvider context) => mail -> [Address] + cc mail = [] + + -- | Hidden list of addresses to receive a copy of the mail (BCC) + bcc :: (?context :: context, ConfigProvider context) => mail -> [Address] + bcc mail = [] + + -- | Custom headers, excluding @from@, @to@, @cc@, @bcc@, @subject@, and @reply-to@ + -- + -- __Example:__ Add a custom X-Mailer header + -- + -- > headers CreateAccountMail { .. } = [("X-Mailer", "mail4j 2.17.0")] + -- + headers :: (?context :: context, ConfigProvider context) => mail -> Headers + headers mail = [] + + -- | Your sender address + -- + -- __Example:__ + -- + -- > from = Address { addressName = "Acme Inc.", addressEmail = "hi@example.com" } + -- + from :: (?mail :: mail, ?context :: context, ConfigProvider context) => Address + + -- | Similiar to a normal html view, HSX can be used here + html :: (?context :: context, ConfigProvider context) => mail -> Html + + -- | When no plain text version of the email is specified it falls back to using the html version but striping out all the html tags + text :: (?context :: context, ConfigProvider context) => mail -> Text + text mail = stripTags (cs $ Blaze.renderHtml (html mail)) + + -- | Optional, mail attachments + -- + -- __Example:__ + -- + -- > attachments = [ MailAttachment { name = "attached_file.xml", contentType = "application/xml", content = "" } ] + -- + attachments :: (?context :: context, ConfigProvider context) => mail -> [MailAttachment] + attachments mail = [] diff --git a/IHP/Mail/Types.hs b/IHP/Mail/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Mail/Types.hs @@ -0,0 +1,41 @@ +{-| +Module: IHP.Mail.Types +Description: Types for emails +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Mail.Types +( MailServer (..) +, MailAttachment (..) +, SMTPEncryption (..) +) +where + +import IHP.Prelude +import Network.Socket (PortNumber) + +-- | Configuration for a mailer used by IHP +data SMTPEncryption = Unencrypted | TLS | STARTTLS + +data MailServer = + -- | Uses AWS SES for sending emails + SES { accessKey :: ByteString + , secretKey :: ByteString + -- | E.g. @"us-east-1"@ or @"eu-west-1"@ + , region :: Text } + -- | Uses the local Sendmail binary for sending emails + | Sendmail + -- | Uses SendGrid for sending emails + | SendGrid { apiKey :: Text + , category :: Maybe Text } + -- | Uses a generic SMTP server for sending emails + | SMTP { host :: String + , port :: PortNumber + -- (Username,Password) combination + , credentials :: Maybe (String, String) + , encryption :: SMTPEncryption } + +data MailAttachment = MailAttachment + { name :: Text -- ^ File name of an attachment + , content :: LByteString + , contentType :: Text + } deriving (Eq, Show) diff --git a/IHP/MailPrelude.hs b/IHP/MailPrelude.hs new file mode 100644 --- /dev/null +++ b/IHP/MailPrelude.hs @@ -0,0 +1,16 @@ +{-| +Module: IHP.MailPrelude +Description: Prelude for email views +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.MailPrelude +( module IHP.Mail +, module Network.Mail.Mime +, module IHP.ViewPrelude +, module IHP.Mail.Types +) where + +import IHP.Mail +import IHP.Mail.Types +import Network.Mail.Mime +import IHP.ViewPrelude hiding (html) diff --git a/IHP/Modal/ControllerFunctions.hs b/IHP/Modal/ControllerFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Modal/ControllerFunctions.hs @@ -0,0 +1,21 @@ +{-| +Module: IHP.Modal.ControllerFunctions +Description: Controller Helper Functions to use modals +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Modal.ControllerFunctions (setModal) where + +import IHP.Prelude +import IHP.Controller.Context +import IHP.Modal.Types +import qualified IHP.ViewSupport as ViewSupport + +setModal :: (?context :: ControllerContext, ViewSupport.View view) => view -> IO () +setModal view = do + html <- do + context <- freeze ?context + let ?context = context + let ?view = view + pure $ ViewSupport.html view + + putContext (ModalContainer html) diff --git a/IHP/Modal/Types.hs b/IHP/Modal/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Modal/Types.hs @@ -0,0 +1,21 @@ +{-| +Module: IHP.Modal.Types +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Modal.Types +( Modal (..) +, ModalContainer (..) +) where + +import IHP.Prelude +import Text.Blaze.Html5 (Html) + +data Modal = Modal + { modalContent :: Html + , modalFooter :: Maybe Html + , modalCloseUrl :: Text + , modalTitle :: Text + } + +-- | Stores the current modal inside @?context@ +newtype ModalContainer = ModalContainer Html diff --git a/IHP/Modal/ViewFunctions.hs b/IHP/Modal/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Modal/ViewFunctions.hs @@ -0,0 +1,56 @@ +{-| +Module: IHP.Modal.ViewFunctions +Description: View Helper Functions to use modals +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Modal.ViewFunctions (modal, renderModal) where + +import IHP.Prelude +import IHP.Controller.Context +import IHP.HSX.QQ (hsx) +import IHP.Modal.Types +import Text.Blaze.Html5 (Html) + +renderModal modal = renderModal' modal True +renderModal' Modal { .. } show = [hsx| + + + |] + where + modalClassName :: Text + modalClassName = "modal fade overflow-auto " <> if show then "show" else "" + backdropClassName :: Text + backdropClassName = "modal-backdrop fade " <> if show then "show" else "" + displayStyle :: Text + displayStyle = if show then "display: block" else "display: none" + + modalInner = [hsx| + + |] + + renderModalFooter = + case modalFooter of + Just modalFooter -> [hsx|
    {modalFooter}
    |] + Nothing -> mempty + +renderModalHeader :: Text -> Text -> Html +renderModalHeader title closeUrl = [hsx| +
    + + +
    +|] + +modal :: (?context :: ControllerContext) => Html +modal = + case maybeFromFrozenContext of + Just (ModalContainer html) -> html + Nothing -> mempty diff --git a/IHP/ModelSupport.hs b/IHP/ModelSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/ModelSupport.hs @@ -0,0 +1,1140 @@ +{-# LANGUAGE MultiParamTypeClasses, TypeFamilies, FlexibleContexts, AllowAmbiguousTypes, UndecidableInstances, FlexibleInstances, IncoherentInstances, DataKinds, PolyKinds, TypeApplications, ScopedTypeVariables, ConstraintKinds, TypeOperators, GADTs, GeneralizedNewtypeDeriving #-} + +module IHP.ModelSupport +( module IHP.ModelSupport +, module IHP.Postgres.Point +, module IHP.Postgres.Polygon +, module IHP.Postgres.Inet +, module IHP.Postgres.TSVector +, module IHP.Postgres.TimeParser +) where + +import IHP.HaskellSupport +import IHP.NameSupport +import ClassyPrelude hiding (UTCTime, find, ModifiedJulianDay) +import Database.PostgreSQL.Simple (Connection) +import Database.PostgreSQL.Simple.Types (Query) +import Database.PostgreSQL.Simple.FromField hiding (Field, name) +import Database.PostgreSQL.Simple.ToField +import Data.Default +import Data.Time.Format.ISO8601 (iso8601Show) +import Data.String.Conversions (cs ,ConvertibleStrings) +import Data.Time.Clock +import Data.Time.LocalTime +import Data.Time.Calendar +import Data.UUID +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple.FromRow as PGFR +import qualified Database.PostgreSQL.Simple.ToField as PG +import qualified Database.PostgreSQL.Simple.ToRow as PG +import GHC.Records +import GHC.TypeLits +import GHC.Types +import Data.Proxy +import Data.Data +import Data.Aeson (ToJSON (..), FromJSON (..)) +import qualified Data.Aeson as Aeson +import qualified Data.Set as Set +import qualified Text.Read as Read +import qualified Data.Pool as Pool +import qualified GHC.Conc +import IHP.Postgres.Point +import IHP.Postgres.Interval () +import IHP.Postgres.Polygon +import IHP.Postgres.Inet () +import IHP.Postgres.TSVector +import IHP.Postgres.TimeParser +import IHP.Log.Types +import qualified IHP.Log as Log +import Data.Dynamic +import Data.Scientific +import GHC.Stack +import qualified Numeric +import qualified Data.Text.Encoding as Text +import qualified Data.ByteString.Builder as Builder + +-- | Provides the db connection and some IHP-specific db configuration +data ModelContext = ModelContext + { connectionPool :: Pool.Pool Connection -- ^ Used to get database connections when no 'transactionConnection' is set + , transactionConnection :: Maybe Connection -- ^ Set to a specific database connection when executing a database transaction + -- | Logs all queries to this logger at log level info + , logger :: Logger + -- | A callback that is called whenever a specific table is accessed using a SELECT query + , trackTableReadCallback :: Maybe (ByteString -> IO ()) + -- | Is set to a value if row level security was enabled at runtime + , rowLevelSecurity :: Maybe RowLevelSecurityContext + } + +-- | When row level security is enabled at runtime, this keeps track of the current +-- logged in user and the postgresql role to switch to. +data RowLevelSecurityContext = RowLevelSecurityContext + { rlsAuthenticatedRole :: Text -- ^ Default is @ihp_authenticated@. This value comes from the @IHP_RLS_AUTHENTICATED_ROLE@ env var. + , rlsUserId :: PG.Action -- ^ The user id of the current logged in user + } + +-- | Provides a mock ModelContext to be used when a database connection is not available +notConnectedModelContext :: Logger -> ModelContext +notConnectedModelContext logger = ModelContext + { connectionPool = error "Not connected" + , transactionConnection = Nothing + , logger = logger + , trackTableReadCallback = Nothing + , rowLevelSecurity = Nothing + } + +createModelContext :: NominalDiffTime -> Int -> ByteString -> Logger -> IO ModelContext +createModelContext idleTime maxConnections databaseUrl logger = do + let poolConfig = Pool.defaultPoolConfig (PG.connectPostgreSQL databaseUrl) PG.close (realToFrac idleTime) maxConnections + connectionPool <- Pool.newPool poolConfig + + let trackTableReadCallback = Nothing + let transactionConnection = Nothing + let rowLevelSecurity = Nothing + pure ModelContext { .. } + +type family GetModelById id :: Type where + GetModelById (Maybe (Id' tableName)) = Maybe (GetModelByTableName tableName) + GetModelById (Id' tableName) = GetModelByTableName tableName +type family GetTableName model :: Symbol +type family GetModelByTableName (tableName :: Symbol) :: Type + +class CanCreate a where + create :: (?modelContext :: ModelContext) => a -> IO a + createMany :: (?modelContext :: ModelContext) => [a] -> IO [a] + + -- | Like 'createRecord' but doesn't return the created record + createRecordDiscardResult :: (?modelContext :: ModelContext) => a -> IO () + createRecordDiscardResult record = do + _ <- createRecord record + pure () + +class CanUpdate a where + updateRecord :: (?modelContext :: ModelContext) => a -> IO a + + -- | Like 'updateRecord' but doesn't return the updated record + updateRecordDiscardResult :: (?modelContext :: ModelContext) => a -> IO () + updateRecordDiscardResult record = do + _ <- updateRecord record + pure () + +{-# INLINE createRecord #-} +createRecord :: (?modelContext :: ModelContext, CanCreate model) => model -> IO model +createRecord = create + +class InputValue a where + inputValue :: a -> Text + +instance InputValue Text where + inputValue text = text + +instance InputValue Int where + inputValue = tshow + +instance InputValue Integer where + inputValue = tshow + +instance InputValue Double where + inputValue double = cs (Numeric.showFFloat Nothing double "") + +instance InputValue Float where + inputValue float = cs (Numeric.showFFloat Nothing float "") + +instance InputValue Bool where + inputValue True = "on" + inputValue False = "off" + +instance InputValue Data.UUID.UUID where + inputValue = Data.UUID.toText + +instance InputValue () where + inputValue () = "error: inputValue(()) not supported" + +instance InputValue UTCTime where + inputValue time = cs (iso8601Show time) + +instance InputValue LocalTime where + inputValue time = cs (iso8601Show time) + +instance InputValue Day where + inputValue date = cs (iso8601Show date) + +instance InputValue TimeOfDay where + inputValue timeOfDay = tshow timeOfDay + +instance InputValue PGInterval where + inputValue (PGInterval pgInterval) = tshow pgInterval + +instance InputValue fieldType => InputValue (Maybe fieldType) where + inputValue (Just value) = inputValue value + inputValue Nothing = "" + +instance InputValue value => InputValue [value] where + inputValue list = list |> map inputValue |> intercalate "," + +instance InputValue Aeson.Value where + inputValue json = json |> Aeson.encode |> cs + +instance InputValue Scientific where + inputValue = tshow + +instance Default Text where + {-# INLINE def #-} + def = "" + +instance Default Bool where + {-# INLINE def #-} + def = False + +instance Default Point where + def = Point def def + +instance Default Polygon where + def = Polygon [def] + +instance Default TSVector where + def = TSVector def + +instance Default Scientific where + def = 0 + +type FieldName = ByteString + +-- | Returns @True@ when the record has not been saved to the database yet. Returns @False@ otherwise. +-- +-- __Example:__ Returns @True@ when a record has not been inserted yet. +-- +-- >>> let project = newRecord @Project +-- >>> isNew project +-- True +-- +-- __Example:__ Returns @False@ after inserting a record. +-- +-- >>> project <- createRecord project +-- >>> isNew project +-- False +-- +-- __Example:__ Returns @False@ for records which have been fetched from the database. +-- +-- >>> book <- query @Book |> fetchOne +-- >>> isNew book +-- False +isNew :: forall model. (HasField "meta" model MetaBag) => model -> Bool +isNew model = isNothing model.meta.originalDatabaseRecord +{-# INLINABLE isNew #-} + +type family GetModelName model :: Symbol + +-- | Provides the primary key type for a given table. The instances are usually declared +-- by the generated haskell code in Generated.Types +-- +-- __Example:__ Defining the primary key for a users table +-- +-- > type instance PrimaryKey "users" = UUID +-- +-- +-- __Example:__ Defining the primary key for a table with a SERIAL pk +-- +-- > type instance PrimaryKey "projects" = Int +-- +type family PrimaryKey (tableName :: Symbol) + +-- | Returns the model name of a given model as Text +-- +-- __Example:__ +-- +-- >>> modelName @User +-- "User" +-- +-- >>> modelName @Project +-- "Project" +getModelName :: forall model. KnownSymbol (GetModelName model) => Text +getModelName = cs $! symbolVal (Proxy :: Proxy (GetModelName model)) +{-# INLINE getModelName #-} + +newtype Id' table = Id (PrimaryKey table) + +deriving instance (Eq (PrimaryKey table)) => Eq (Id' table) +deriving instance (Ord (PrimaryKey table)) => Ord (Id' table) +deriving instance (Hashable (PrimaryKey table)) => Hashable (Id' table) +deriving instance (KnownSymbol table, Data (PrimaryKey table)) => Data (Id' table) +deriving instance (KnownSymbol table, NFData (PrimaryKey table)) => NFData (Id' table) + +-- | We need to map the model to its table name to prevent infinite recursion in the model data definition +-- E.g. `type Project = Project' { id :: Id Project }` will not work +-- But `type Project = Project' { id :: Id "projects" }` will +type Id model = Id' (GetTableName model) + +instance InputValue (PrimaryKey model') => InputValue (Id' model') where + {-# INLINE inputValue #-} + inputValue = inputValue . unpackId + +instance IsEmpty (PrimaryKey table) => IsEmpty (Id' table) where + isEmpty (Id primaryKey) = isEmpty primaryKey + +recordToInputValue :: (HasField "id" entity (Id entity), Show (PrimaryKey (GetTableName entity))) => entity -> Text +recordToInputValue entity = + entity.id + |> unpackId + |> tshow +{-# INLINE recordToInputValue #-} + +instance FromField (PrimaryKey model) => FromField (Id' model) where + {-# INLINE fromField #-} + fromField value metaData = do + fieldValue <- fromField value metaData + pure (Id fieldValue) + +instance ToField (PrimaryKey model) => ToField (Id' model) where + {-# INLINE toField #-} + toField = toField . unpackId + +instance Show (PrimaryKey model) => Show (Id' model) where + {-# INLINE show #-} + show = show . unpackId + +-- | Turns an @UUID@ into a @Id@ type +-- +-- > let uuid :: UUID = "5240e79c-97ff-4a5f-8567-84112541aaba" +-- > let userId :: Id User = packId uuid +-- +packId :: PrimaryKey model -> Id' model +packId uuid = Id uuid + +-- | Unwraps a @Id@ value into an @UUID@ +-- +-- >>> unpackId ("296e5a50-b237-4ee9-83b0-17fb1e6f208f" :: Id User) +-- "296e5a50-b237-4ee9-83b0-17fb1e6f208f" :: UUID +-- +unpackId :: Id' model -> PrimaryKey model +unpackId (Id uuid) = uuid + +-- | Record type for objects of model types labeled with values from different database tables. (e.g. comments labeled with the IDs of the posts they belong to). +data LabeledData a b = LabeledData { labelValue :: a, contentValue :: b } + deriving (Show) + +instance (FromField label, PG.FromRow a) => PGFR.FromRow (LabeledData label a) where + fromRow = LabeledData <$> PGFR.field <*> PGFR.fromRow + +-- | Sometimes you have a hardcoded UUID value which represents some record id. This instance allows you +-- to write the Id like a string: +-- +-- > let projectId = "ca63aace-af4b-4e6c-bcfa-76ca061dbdc6" :: Id Project +instance (Read (PrimaryKey model), ParsePrimaryKey (PrimaryKey model)) => IsString (Id' model) where + fromString uuid = textToId uuid + {-# INLINE fromString #-} + +class ParsePrimaryKey primaryKey where + parsePrimaryKey :: Text -> Maybe primaryKey + +instance ParsePrimaryKey UUID where + parsePrimaryKey = Read.readMaybe . cs + +instance ParsePrimaryKey Text where + parsePrimaryKey text = Just text + +-- | Transforms a text, bytestring or string into an Id. Throws an exception if the input is invalid. +-- +-- __Example:__ +-- +-- > let projectIdText = "7cbc76e2-1c4f-49b6-a7d9-5015e7575a9b" :: Text +-- > let projectId = (textToId projectIdText) :: Id Project +-- +-- In case your UUID value is hardcoded, there is also an 'IsString' instance, so you +-- can just write it like: +-- +-- > let projectId = "ca63aace-af4b-4e6c-bcfa-76ca061dbdc6" :: Id Project +textToId :: (HasCallStack, ParsePrimaryKey (PrimaryKey model), ConvertibleStrings text Text) => text -> Id' model +textToId text = case parsePrimaryKey (cs text) of + Just id -> Id id + Nothing -> error (cs $ "Unable to convert " <> (cs text :: Text) <> " to Id value. Is it a valid uuid?") +{-# INLINE textToId #-} + +-- | Measure and log the query time for a given query action if the log level is Debug. +-- If the log level is greater than debug, just perform the query action without measuring time. +measureTimeIfLogging :: (?modelContext :: ModelContext, PG.ToRow q) => Text -> PG.Connection -> IO a -> Query -> q -> IO a +measureTimeIfLogging logPrefix connection queryAction theQuery theParameters = do + let currentLogLevel = ?modelContext.logger.level + if currentLogLevel == Debug + then do + start <- getCurrentTime + queryAction `finally` do + end <- getCurrentTime + let theTime = end `diffUTCTime` start + logQuery logPrefix connection theQuery theParameters theTime + else queryAction + +-- | Runs a raw sql query +-- +-- __Example:__ +-- +-- > users <- sqlQuery "SELECT id, firstname, lastname FROM users" () +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +-- +-- *AutoRefresh:* When using 'sqlQuery' with AutoRefresh, you need to use 'trackTableRead' to let AutoRefresh know that you have accessed a certain table. Otherwise AutoRefresh will not watch table of your custom sql query. +-- +-- Use 'sqlQuerySingleRow' if you expect only a single row to be returned. +-- +sqlQuery :: (?modelContext :: ModelContext, PG.ToRow q, PG.FromRow r) => Query -> q -> IO [r] +sqlQuery theQuery theParameters = do + withDatabaseConnection \connection -> enhanceSqlError theQuery theParameters do + withRLSParams (\theQuery theParameters -> measureTimeIfLogging "🔍" connection (PG.query connection theQuery theParameters) theQuery theParameters) theQuery theParameters +{-# INLINABLE sqlQuery #-} + + +-- | Runs a raw sql query, that is expected to return a single result row +-- +-- Like 'sqlQuery', but useful when you expect only a single row as the result +-- +-- __Example:__ +-- +-- > user <- sqlQuerySingleRow "SELECT id, firstname, lastname FROM users WHERE id = ?" (Only user.id) +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +-- +-- *AutoRefresh:* When using 'sqlQuerySingleRow' with AutoRefresh, you need to use 'trackTableRead' to let AutoRefresh know that you have accessed a certain table. Otherwise AutoRefresh will not watch table of your custom sql query. +-- +sqlQuerySingleRow :: (?modelContext :: ModelContext, PG.ToRow query, PG.FromRow record) => Query -> query -> IO record +sqlQuerySingleRow theQuery theParameters = do + result <- sqlQuery theQuery theParameters + case result of + [] -> error ("sqlQuerySingleRow: Expected a single row to be returned. Query: " <> show theQuery) + [record] -> pure record + otherwise -> error ("sqlQuerySingleRow: Expected a single row to be returned. But got " <> show (length otherwise) <> " rows") +{-# INLINABLE sqlQuerySingleRow #-} + +-- | Runs a sql statement (like a CREATE statement) +-- +-- __Example:__ +-- +-- > sqlExec "CREATE TABLE users ()" () +sqlExec :: (?modelContext :: ModelContext, PG.ToRow q) => Query -> q -> IO Int64 +sqlExec theQuery theParameters = do + withDatabaseConnection \connection -> enhanceSqlError theQuery theParameters do + withRLSParams (\theQuery theParameters -> measureTimeIfLogging "💾" connection (PG.execute connection theQuery theParameters) theQuery theParameters) theQuery theParameters +{-# INLINABLE sqlExec #-} + +-- | Runs a sql statement (like a CREATE statement), but doesn't return any result +-- +-- __Example:__ +-- +-- > sqlExecDiscardResult "CREATE TABLE users ()" () +sqlExecDiscardResult :: (?modelContext :: ModelContext, PG.ToRow q) => Query -> q -> IO () +sqlExecDiscardResult theQuery theParameters = do + _ <- sqlExec theQuery theParameters + pure () +{-# INLINABLE sqlExecDiscardResult #-} + +-- | Wraps the query with Row level security boilerplate, if a row level security context was provided +-- +-- __Example:__ +-- +-- If a row level security context is given, this will turn a query like the following +-- +-- > withRLSParams runQuery "SELECT * FROM projects WHERE id = ?" (Only "..") +-- +-- Into the following equivalent: +-- +-- > runQuery "SET LOCAL ROLE ?; SET LOCAL rls.ihp_user_id = ?; SELECT * FROM projects WHERE id = ?" ["ihp_authenticated", "", .."] +-- +withRLSParams :: (?modelContext :: ModelContext, PG.ToRow params) => (PG.Query -> [PG.Action] -> result) -> PG.Query -> params -> result +withRLSParams runQuery query params = do + case ?modelContext.rowLevelSecurity of + Just RowLevelSecurityContext { rlsAuthenticatedRole, rlsUserId } -> do + let query' = "SET LOCAL ROLE ?; SET LOCAL rls.ihp_user_id = ?; " <> query + let params' = [PG.toField (PG.Identifier rlsAuthenticatedRole), PG.toField rlsUserId] <> PG.toRow params + runQuery query' params' + Nothing -> runQuery query (PG.toRow params) + +withDatabaseConnection :: (?modelContext :: ModelContext) => (Connection -> IO a) -> IO a +withDatabaseConnection block = + let + ModelContext { connectionPool, transactionConnection, rowLevelSecurity } = ?modelContext + in case transactionConnection of + Just transactionConnection -> block transactionConnection + Nothing -> Pool.withResource connectionPool block +{-# INLINABLE withDatabaseConnection #-} + +-- | Runs a raw sql query which results in a single scalar value such as an integer or string +-- +-- __Example:__ +-- +-- > usersCount <- sqlQueryScalar "SELECT COUNT(*) FROM users" +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +sqlQueryScalar :: (?modelContext :: ModelContext) => (PG.ToRow q, FromField value) => Query -> q -> IO value +sqlQueryScalar theQuery theParameters = do + result <- sqlQuery theQuery theParameters + pure case result of + [PG.Only result] -> result + _ -> error "sqlQueryScalar: Expected a scalar result value" +{-# INLINABLE sqlQueryScalar #-} + +-- | Runs a raw sql query which results in a single scalar value such as an integer or string, or nothing +-- +-- __Example:__ +-- +-- > usersCount <- sqlQueryScalarOrNothing "SELECT COUNT(*) FROM users" +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +sqlQueryScalarOrNothing :: (?modelContext :: ModelContext) => (PG.ToRow q, FromField value) => Query -> q -> IO (Maybe value) +sqlQueryScalarOrNothing theQuery theParameters = do + result <- sqlQuery theQuery theParameters + pure case result of + [] -> Nothing + [PG.Only result] -> Just result + _ -> error "sqlQueryScalarOrNothing: Expected a scalar result value or an empty result set" +{-# INLINABLE sqlQueryScalarOrNothing #-} + +-- | Executes the given block with a database transaction +-- +-- __Example:__ +-- +-- > withTransaction do +-- > company <- newRecord @Company |> createRecord +-- > +-- > -- When creating the user fails, there will be no company left over +-- > user <- newRecord @User +-- > |> set #companyId company.id +-- > |> createRecord +-- > +-- > company <- company +-- > |> set #ownerId user.id +-- > |> updateRecord +withTransaction :: (?modelContext :: ModelContext) => ((?modelContext :: ModelContext) => IO a) -> IO a +withTransaction block = withTransactionConnection do + let connection = ?modelContext.transactionConnection + |> \case + Just connection -> connection + Nothing -> error "withTransaction: transactionConnection not set as expected" + PG.withTransaction connection block +{-# INLINABLE withTransaction #-} + +-- | Executes the given block with the main database role and temporarly sidesteps the row level security policies. +-- +-- This is used e.g. by IHP AutoRefresh to be able to set up it's database triggers. When trying to set up a database +-- trigger from the ihp_authenticated role, it typically fails because it's missing permissions. Using 'withRowLevelSecurityDisabled' +-- we switch to the main role which is allowed to set up database triggers. +-- +-- SQL queries run from within the passed block are executed in their own transaction. +-- +-- __Example:__ +-- +-- > -- SQL code executed here might be run from the ihp_authenticated role +-- > withRowLevelSecurityDisabled do +-- > -- SQL code executed here is run as the main IHP db role +-- > sqlExec "CREATE OR REPLACE FUNCTION .." () +-- +withRowLevelSecurityDisabled :: (?modelContext :: ModelContext) => ((?modelContext :: ModelContext) => IO a) -> IO a +withRowLevelSecurityDisabled block = do + let currentModelContext = ?modelContext + let ?modelContext = currentModelContext { rowLevelSecurity = Nothing } in block +{-# INLINABLE withRowLevelSecurityDisabled #-} + +-- | Returns the postgres connection when called within a 'withTransaction' block +-- +-- Throws an error if called from outside a 'withTransaction' +transactionConnectionOrError :: (?modelContext :: ModelContext) => Connection +transactionConnectionOrError = ?modelContext.transactionConnection + |> \case + Just connection -> connection + Nothing -> error "getTransactionConnectionOrError: Not in a transaction state" + +commitTransaction :: (?modelContext :: ModelContext) => IO () +commitTransaction = PG.commit transactionConnectionOrError +{-# INLINABLE commitTransaction #-} + +rollbackTransaction :: (?modelContext :: ModelContext) => IO () +rollbackTransaction = PG.rollback transactionConnectionOrError +{-# INLINABLE rollbackTransaction #-} + +withTransactionConnection :: (?modelContext :: ModelContext) => ((?modelContext :: ModelContext) => IO a) -> IO a +withTransactionConnection block = do + let ModelContext { connectionPool } = ?modelContext + Pool.withResource connectionPool \connection -> do + let modelContext = ?modelContext { transactionConnection = Just connection } + let ?modelContext = modelContext in block +{-# INLINABLE withTransactionConnection #-} + +-- | Access meta data for a database table +class + ( KnownSymbol (GetTableName record) + ) => Table record where + -- | Returns the table name of a given model. + -- + -- __Example:__ + -- + -- >>> tableName @User + -- "users" + -- + + tableName :: Text + tableName = symbolToText @(GetTableName record) + {-# INLINE tableName #-} + + -- | Returns the table name of a given model as a bytestring. + -- + -- __Example:__ + -- + -- >>> tableNameByteString @User + -- "users" + -- + tableNameByteString :: ByteString + tableNameByteString = Text.encodeUtf8 (tableName @record) + {-# INLINE tableNameByteString #-} + + -- | Returns the list of column names for a given model + -- + -- __Example:__ + -- + -- >>> columnNames @User + -- ["id", "email", "created_at"] + -- + columnNames :: [ByteString] + + -- | Returns the list of column names, that are contained in the primary key for a given model + -- + -- __Example:__ + -- + -- >>> primaryKeyColumnNames @User + -- ["id"] + -- + -- >>> primaryKeyColumnNames @PostTagging + -- ["post_id", "tag_id"] + -- + primaryKeyColumnNames :: [ByteString] + + -- | Returns the parameters for a WHERE conditions to match an entity by it's primary key, given the entities id + -- + -- For tables with a simple primary key this simply the id: + -- + -- >>> primaryKeyConditionForId project.id + -- Plain "d619f3cf-f355-4614-8a4c-e9ea4f301e39" + -- + -- If the table has a composite primary key, this returns multiple elements: + -- + -- >>> primaryKeyConditionForId postTag.id + -- Many [Plain "(", Plain "0ace9270-568f-4188-b237-3789aa520588", Plain ",", Plain "0b58fdf5-4bbb-4e57-a5b7-aa1c57148e1c", Plain ")"] + -- + -- The order of the elements for a composite primary key must match the order of the columns returned by 'primaryKeyColumnNames' + primaryKeyConditionForId :: Id record -> PG.Action + +-- | Returns ByteString, that represents the part of an SQL where clause, that matches on a tuple consisting of all the primary keys +-- For table with simple primary keys this simply returns the name of the primary key column, without wrapping in a tuple +-- >>> primaryKeyColumnSelector @PostTag +-- "(post_tags.post_id, post_tags.tag_id)" +-- >>> primaryKeyColumnSelector @Post +-- "post_tags.post_id" +primaryKeyConditionColumnSelector :: forall record. (Table record) => ByteString +primaryKeyConditionColumnSelector = + let + qualifyColumnName col = tableNameByteString @record <> "." <> col + in + case primaryKeyColumnNames @record of + [] -> error . cs $ "Impossible happened in primaryKeyConditionColumnSelector. No primary keys found for table " <> tableName @record <> ". At least one primary key is required." + [s] -> qualifyColumnName s + conds -> "(" <> intercalate ", " (map qualifyColumnName conds) <> ")" + +-- | Returns WHERE conditions to match an entity by it's primary key +-- +-- For tables with a simple primary key this returns a tuple with the id: +-- +-- >>> primaryKeyCondition project +-- Plain "d619f3cf-f355-4614-8a4c-e9ea4f301e39" +-- +-- If the table has a composite primary key, this returns multiple elements: +-- +-- >>> primaryKeyCondition postTag +-- Many [Plain "(", Plain "0ace9270-568f-4188-b237-3789aa520588", Plain ",", Plain "0b58fdf5-4bbb-4e57-a5b7-aa1c57148e1c", Plain ")"] +primaryKeyCondition :: forall record. (HasField "id" record (Id record), Table record) => record -> PG.Action +primaryKeyCondition record = primaryKeyConditionForId @record record.id + +logQuery :: (?modelContext :: ModelContext, PG.ToRow parameters) => Text -> PG.Connection -> Query -> parameters -> NominalDiffTime -> IO () +logQuery logPrefix connection query parameters time = do + let ?context = ?modelContext + -- NominalTimeDiff is represented as seconds, and doesn't provide a FormatTime option for printing in ms. + -- To get around that we convert to and from a rational so we can format as desired. + let queryTimeInMs = (time * 1000) |> toRational |> fromRational @Double |> round + let formatRLSInfo userId = " { ihp_user_id = " <> userId <> " }" + let rlsInfo = case ?context.rowLevelSecurity of + Just RowLevelSecurityContext { rlsUserId = PG.Plain rlsUserId } -> formatRLSInfo (cs (Builder.toLazyByteString rlsUserId)) + Just RowLevelSecurityContext { rlsUserId = rlsUserId } -> formatRLSInfo (tshow rlsUserId) + Nothing -> "" + + formatted <- PG.formatQuery connection query parameters + Log.debug (logPrefix <> " " <> cs formatted <> rlsInfo <> " (" <> tshow queryTimeInMs <> "ms)") +{-# INLINABLE logQuery #-} + +-- | Runs a @DELETE@ query for a record. +-- +-- >>> let project :: Project = ... +-- >>> deleteRecord project +-- DELETE FROM projects WHERE id = '..' +-- +-- Use 'deleteRecords' if you want to delete multiple records. +-- +deleteRecord :: forall record table. (?modelContext :: ModelContext, Table record, Show (PrimaryKey table), HasField "id" record (Id record), GetTableName record ~ table, record ~ GetModelByTableName table) => record -> IO () +deleteRecord record = + deleteRecordById @record record.id +{-# INLINABLE deleteRecord #-} + +-- | Like 'deleteRecord' but using an Id +-- +-- >>> let project :: Id Project = ... +-- >>> delete projectId +-- DELETE FROM projects WHERE id = '..' +-- +deleteRecordById :: forall record table. (?modelContext :: ModelContext, Table record, Show (PrimaryKey table), GetTableName record ~ table, record ~ GetModelByTableName table) => Id' table -> IO () +deleteRecordById id = do + let theQuery = "DELETE FROM " <> tableNameByteString @record <> " WHERE " <> (primaryKeyConditionColumnSelector @record) <> " = ?" + let theParameters = PG.Only $ primaryKeyConditionForId @record id + sqlExec (PG.Query $! theQuery) theParameters + pure () +{-# INLINABLE deleteRecordById #-} + +-- | Runs a @DELETE@ query for a list of records. +-- +-- >>> let projects :: [Project] = ... +-- >>> deleteRecords projects +-- DELETE FROM projects WHERE id IN (..) +deleteRecords :: forall record table. (?modelContext :: ModelContext, Show (PrimaryKey table), Table record, HasField "id" record (Id' table), GetTableName record ~ table, record ~ GetModelByTableName table) => [record] -> IO () +deleteRecords records = + deleteRecordByIds @record (ids records) +{-# INLINABLE deleteRecords #-} + +-- | Like 'deleteRecordById' but for a list of Ids. +-- +-- >>> let projectIds :: [ Id Project ] = ... +-- >>> delete projectIds +-- DELETE FROM projects WHERE id IN ('..') +-- +deleteRecordByIds :: forall record table. (?modelContext :: ModelContext, Show (PrimaryKey table), Table record, GetTableName record ~ table, record ~ GetModelByTableName table) => [Id' table] -> IO () +deleteRecordByIds ids = do + let theQuery = "DELETE FROM " <> tableNameByteString @record <> " WHERE " <> (primaryKeyConditionColumnSelector @record) <> " IN ?" + let theParameters = PG.Only $ PG.In $ map (primaryKeyConditionForId @record) ids + sqlExec (PG.Query $! theQuery) theParameters + pure () +{-# INLINABLE deleteRecordByIds #-} + +-- | Runs a @DELETE@ query to delete all rows in a table. +-- +-- >>> deleteAll @Project +-- DELETE FROM projects +deleteAll :: forall record. (?modelContext :: ModelContext, Table record) => IO () +deleteAll = do + let theQuery = "DELETE FROM " <> tableName @record + sqlExec (PG.Query . cs $! theQuery) () + pure () +{-# INLINABLE deleteAll #-} + +type family Include (name :: GHC.Types.Symbol) model + +type family Include' (name :: [GHC.Types.Symbol]) model where + Include' '[] model = model + Include' (x:xs) model = Include' xs (Include x model) + +instance Default NominalDiffTime where + def = 0 + +instance Default TimeOfDay where + def = TimeOfDay 0 0 0 + +instance Default LocalTime where + def = LocalTime def def + +instance Default Day where + def = ModifiedJulianDay 0 + +instance Default UTCTime where + def = UTCTime def 0 + +instance Default (PG.Binary ByteString) where + def = PG.Binary "" + +instance Default PGInterval where + def = PGInterval "00:00:00" + +class Record model where + newRecord :: model + +-- | Helper type to deal with models where relations are included or that are only partially fetched +-- Examples: +-- +-- >>> NormalizeModel (Include "author_id" Post) +-- Post +-- +-- >>> NormalizeModel Post +-- Post +type NormalizeModel model = GetModelByTableName (GetTableName model) + +-- | Returns the ids for a list of models +-- +-- Shorthand for @map (.id) records@. +-- +-- >>> users <- query @User |> fetch +-- >>> ids users +-- [227fbba3-0578-4eb8-807d-b9b692c3644f, 9d7874f2-5343-429b-bcc4-8ee62a5a6895, ...] :: [Id User] +ids :: (HasField "id" record id) => [record] -> [id] +ids records = map (.id) records +{-# INLINE ids #-} + +-- | The error message of a validator can be either a plain text value or a HTML formatted value +data Violation + = TextViolation { message :: !Text } -- ^ Plain text validation error, like "cannot be empty" + | HtmlViolation { message :: !Text } -- ^ HTML formatted, already pre-escaped validation error, like "Invalid, please check the documentation" + deriving (Eq, Show) + +-- | Every IHP database record has a magic @meta@ field which keeps a @MetaBag@ inside. This data structure is used e.g. to keep track of the validation errors that happend. +data MetaBag = MetaBag + { annotations :: ![(Text, Violation)] -- ^ Stores validation failures, as a list of (field name, error) pairs. E.g. @annotations = [ ("name", TextViolation "cannot be empty") ]@ + , touchedFields :: ![Text] -- ^ Whenever a 'set' is callled on a field, it will be marked as touched. Only touched fields are saved to the database when you call 'updateRecord' + , originalDatabaseRecord :: Maybe Dynamic -- ^ When the record has been fetched from the database, we save the initial database record here. This is used by 'didChange' to check if a field value is different from the initial database value. + } deriving (Show) + +instance Eq MetaBag where + MetaBag { annotations, touchedFields } == MetaBag { annotations = annotations', touchedFields = touchedFields' } = annotations == annotations' && touchedFields == touchedFields' + +instance Default MetaBag where + def = MetaBag { annotations = [], touchedFields = [], originalDatabaseRecord = Nothing } + {-# INLINE def #-} + +instance SetField "annotations" MetaBag [(Text, Violation)] where + setField value meta = meta { annotations = value } + {-# INLINE setField #-} + +instance SetField "touchedFields" MetaBag [Text] where + setField value meta = meta { touchedFields = value } + {-# INLINE setField #-} + +-- | Returns 'True' if any fields of the record have unsaved changes +-- +-- __Example:__ Returns 'False' for freshly fetched records +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> didChangeRecord project +-- False +-- +-- __Example:__ Returns 'True' after setting a field +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> project |> set #name "New Name" |> didChangeRecord +-- True +didChangeRecord :: (HasField "meta" record MetaBag) => record -> Bool +didChangeRecord record = isEmpty record.meta.touchedFields + +-- | Returns 'True' if the specific field of the record has unsaved changes +-- +-- __Example:__ Returns 'False' for freshly fetched records +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> didChange #name project +-- False +-- +-- __Example:__ Returns 'True' after setting a field +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> project |> set #name "New Name" |> didChange #name +-- True +-- +-- __Example:__ Setting a flash message after updating the profile picture +-- +-- > when (user |> didChange #profilePictureUrl) (setSuccessMessage "Your Profile Picture has been updated. It might take a few minutes until it shows up everywhere") +didChange :: forall fieldName fieldValue record. (KnownSymbol fieldName, HasField fieldName record fieldValue, HasField "meta" record MetaBag, Eq fieldValue, Typeable record) => Proxy fieldName -> record -> Bool +didChange field record = didTouchField field record && didChangeField + where + didChangeField :: Bool + didChangeField = originalFieldValue /= fieldValue + + fieldValue :: fieldValue + fieldValue = record |> getField @fieldName + + originalFieldValue :: fieldValue + originalFieldValue = + record.meta.originalDatabaseRecord + |> fromMaybe (error "didChange called on a record without originalDatabaseRecord") + |> fromDynamic @record + |> fromMaybe (error "didChange failed to retrieve originalDatabaseRecord") + |> getField @fieldName + +-- | Returns 'True' if 'set' was called on that field +-- +-- __Example:__ Returns 'False' for freshly fetched records +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> didTouchField #name project +-- False +-- +-- __Example:__ Returns 'True' after setting a field +-- +-- >>> let projectId = "227fbba3-0578-4eb8-807d-b9b692c3644f" :: Id Project +-- >>> project <- fetch projectId +-- >>> project |> set #name project.name |> didTouchField #name +-- True +-- +didTouchField :: forall fieldName fieldValue record. (KnownSymbol fieldName, HasField fieldName record fieldValue, HasField "meta" record MetaBag, Eq fieldValue, Typeable record) => Proxy fieldName -> record -> Bool +didTouchField field record = + record.meta.touchedFields + |> includes (symbolToText @fieldName) + +-- | Represents fields that have a default value in an SQL schema +-- +-- The 'Default' constructor represents the default value from the schema, +-- while the 'NonDefault' constructor holds some other value for the field +data FieldWithDefault valueType = Default | NonDefault valueType deriving (Eq, Show) + +instance ToField valueType => ToField (FieldWithDefault valueType) where + toField Default = Plain "DEFAULT" + toField (NonDefault a) = toField a + +-- | Construct a 'FieldWithDefault' +-- +-- Use the default SQL value when the field hasn't been touched since the +-- record was created. This information is stored in the 'touchedFields' +-- attribute of the 'meta' field. +fieldWithDefault + :: ( KnownSymbol name + , HasField name model value + , HasField "meta" model MetaBag + ) + => Proxy name + -> model + -> FieldWithDefault value +fieldWithDefault name model + | cs (symbolVal name) `elem` model.meta.touchedFields = + NonDefault (get name model) + | otherwise = Default + +-- | Represents fields that may have been updated +-- +-- The 'NoUpdate' constructor represents the existing value in the database, +-- while the 'Update' constructor holds some new value for the field +data FieldWithUpdate name value + = NoUpdate (Proxy name) + | Update value + deriving (Eq, Show) + +instance (KnownSymbol name, ToField value) => ToField (FieldWithUpdate name value) where + toField (NoUpdate name) = + Plain (ClassyPrelude.fromString $ cs $ fieldNameToColumnName $ cs $ symbolVal name) + toField (Update a) = toField a + +-- | Construct a 'FieldWithUpdate' +-- +-- Use the current database value when the field hasn't been touched since the +-- record was accessed. This information is stored in the 'touchedFields' +-- attribute of the 'meta' field. +fieldWithUpdate + :: ( KnownSymbol name + , HasField name model value + , HasField "meta" model MetaBag + ) + => Proxy name + -> model + -> FieldWithUpdate name value +fieldWithUpdate name model + | cs (symbolVal name) `elem` model.meta.touchedFields = + Update (get name model) + | otherwise = NoUpdate name + +instance (ToJSON (PrimaryKey a)) => ToJSON (Id' a) where + toJSON (Id a) = toJSON a + +instance (FromJSON (PrimaryKey a)) => FromJSON (Id' a) where + parseJSON value = Id <$> parseJSON value + +-- | Thrown by 'fetchOne' when the query result is empty +data RecordNotFoundException + = RecordNotFoundException { queryAndParams :: (ByteString, [Action]) } + deriving (Show) + +instance Exception RecordNotFoundException + +-- | Whenever calls to 'Database.PostgreSQL.Simple.query' or 'Database.PostgreSQL.Simple.execute' +-- raise an 'Database.PostgreSQL.Simple.SqlError' exception, we wrap that exception in this data structure. +-- This allows us to show the actual database query that has triggered the error. +data EnhancedSqlError + = EnhancedSqlError + { sqlErrorQuery :: Query + , sqlErrorQueryParams :: [Action] + , sqlError :: PG.SqlError + } deriving (Show) + +-- | Catches 'SqlError' and wraps them in 'EnhancedSqlError' +enhanceSqlError :: PG.ToRow parameters => Query -> parameters -> IO a -> IO a +enhanceSqlError sqlErrorQuery sqlErrorQueryParams block = catch block (\sqlError -> throwIO EnhancedSqlError { sqlErrorQuery, sqlErrorQueryParams = PG.toRow sqlErrorQueryParams, sqlError }) +{-# INLINE enhanceSqlError #-} + +instance Exception EnhancedSqlError + +instance Default Aeson.Value where + def = Aeson.Null + +-- | This instance allows us to avoid wrapping lists with PGArray when +-- using sql types such as @INT[]@ +instance ToField value => ToField [value] where + toField list = toField (PG.PGArray list) + +-- | This instancs allows us to avoid wrapping lists with PGArray when +-- using sql types such as @INT[]@ +instance (FromField value, Typeable value) => FromField [value] where + fromField field value = PG.fromPGArray <$> (fromField field value) + +-- | Useful to manually mark a table read when doing a custom sql query inside AutoRefresh or 'withTableReadTracker'. +-- +-- When using 'fetch' on a query builder, this function is automatically called. That's why you only need to call +-- it yourself when using 'sqlQuery' to run a custom query. +-- +-- __Example:__ +-- +-- > action MyAction = autoRefresh do +-- > users <- sqlQuery "SELECT * FROM users WHERE .." +-- > trackTableRead "users" +-- > +-- > render MyView { .. } +-- +-- +trackTableRead :: (?modelContext :: ModelContext) => ByteString -> IO () +trackTableRead tableName = case ?modelContext.trackTableReadCallback of + Just callback -> callback tableName + Nothing -> pure () +{-# INLINABLE trackTableRead #-} + +-- | Track all tables in SELECT queries executed within the given IO action. +-- +-- You can read the touched tables by this function by accessing the variable @?touchedTables@ inside your given IO action. +-- +-- __Example:__ +-- +-- > withTableReadTracker do +-- > project <- query @Project |> fetchOne +-- > user <- query @User |> fetchOne +-- > +-- > tables <- readIORef ?touchedTables +-- > -- tables = Set.fromList ["projects", "users"] +-- > +withTableReadTracker :: (?modelContext :: ModelContext) => ((?modelContext :: ModelContext, ?touchedTables :: IORef (Set ByteString)) => IO ()) -> IO () +withTableReadTracker trackedSection = do + touchedTablesVar <- newIORef Set.empty + let trackTableReadCallback = Just \tableName -> modifyIORef' touchedTablesVar (Set.insert tableName) + let oldModelContext = ?modelContext + let ?modelContext = oldModelContext { trackTableReadCallback } + let ?touchedTables = touchedTablesVar + trackedSection + + +-- | Shorthand filter function +-- +-- In IHP code bases you often write filter functions such as these: +-- +-- > getUserPosts user posts = +-- > filter (\p -> p.userId == user.id) posts +-- +-- This can be written in a shorter way using 'onlyWhere': +-- +-- > getUserPosts user posts = +-- > posts |> onlyWhere #userId user.id +-- +-- Because the @userId@ field is an Id, we can use 'onlyWhereReferences' to make it even shorter: +-- +-- > getUserPosts user posts = +-- > posts |> onlyWhereReferences #userId user +-- +-- If the Id field is nullable, we need to use 'onlyWhereReferencesMaybe': +-- +-- > getUserTasks user tasks = +-- > tasks |> onlyWhereReferencesMaybe #optionalUserId user +-- +onlyWhere :: forall record fieldName value. (KnownSymbol fieldName, HasField fieldName record value, Eq value) => Proxy fieldName -> value -> [record] -> [record] +onlyWhere field value records = filter (\record -> get field record == value) records + +-- | Shorthand filter function for Id fields +-- +-- In IHP code bases you often write filter functions such as these: +-- +-- > getUserPosts user posts = +-- > filter (\p -> p.userId == user.id) posts +-- +-- This can be written in a shorter way using 'onlyWhereReferences': +-- +-- > getUserPosts user posts = +-- > posts |> onlyWhereReferences #userId user +-- +-- If the Id field is nullable, we need to use 'onlyWhereReferencesMaybe': +-- +-- > getUserTasks user tasks = +-- > tasks |> onlyWhereReferencesMaybe #optionalUserId user +-- +-- +-- See 'onlyWhere' for more details. +onlyWhereReferences :: forall record fieldName value referencedRecord. (KnownSymbol fieldName, HasField fieldName record value, Eq value, HasField "id" referencedRecord value) => Proxy fieldName -> referencedRecord -> [record] -> [record] +onlyWhereReferences field referenced records = filter (\record -> get field record == referenced.id) records + +-- | Shorthand filter function for nullable Id fields +-- +-- In IHP code bases you often write filter functions such as these: +-- +-- > getUserTasks user tasks = +-- > filter (\task -> task.optionalUserId == Just user.id) tasks +-- +-- This can be written in a shorter way using 'onlyWhereReferencesMaybe': +-- +-- > getUserTasks user tasks = +-- > tasks |> onlyWhereReferencesMaybe #optionalUserId user +-- +-- See 'onlyWhere' for more details. +onlyWhereReferencesMaybe :: forall record fieldName value referencedRecord. (KnownSymbol fieldName, HasField fieldName record (Maybe value), Eq value, HasField "id" referencedRecord value) => Proxy fieldName -> referencedRecord -> [record] -> [record] +onlyWhereReferencesMaybe field referenced records = filter (\record -> get field record == Just referenced.id) records + +-- | Returns True when a record has no validation errors attached from a previous validation call +-- +-- Example: +-- +-- > isValidProject :: Project -> Bool +-- > isValidProject project = +-- > project +-- > |> validateField #name isNonEmpty +-- > |> isValid +-- +isValid :: forall record. (HasField "meta" record MetaBag) => record -> Bool +isValid record = isEmpty record.meta.annotations + +-- | Copies all the fields (except the 'id' field) into a new record +-- +-- Example: Duplicate a database record (except the primary key of course) +-- +-- > project <- fetch projectId +-- > duplicatedProject <- createRecord (copyRecord project) +-- +copyRecord :: forall record id. (Table record, SetField "id" record id, Default id, SetField "meta" record MetaBag) => record -> record +copyRecord existingRecord = + let + fieldsExceptId = (columnNames @record) |> filter (\field -> field /= "id") + + meta :: MetaBag + meta = def { touchedFields = map (IHP.NameSupport.columnNameToFieldName . cs) fieldsExceptId } + in + existingRecord + |> set #id def + |> set #meta meta + +-- | Runs sql queries without logging them +-- +-- Example: +-- +-- > users <- withoutQueryLogging (sqlQuery "SELECT * FROM users" ()) +-- +withoutQueryLogging :: (?modelContext :: ModelContext) => ((?modelContext :: ModelContext) => result) -> result +withoutQueryLogging callback = + let + modelContext = ?modelContext + nullLogger = modelContext.logger { write = \_ -> pure ()} + in + let ?modelContext = modelContext { logger = nullLogger } + in + callback diff --git a/IHP/NameSupport.hs b/IHP/NameSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/NameSupport.hs @@ -0,0 +1,291 @@ +{-| +Module: IHP.NameSupport +Description: Transforms names, e.g. table names to model names +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.NameSupport +( tableNameToModelName +, columnNameToFieldName +, modelNameToTableName +, humanize +, ucfirst +, lcfirst +, fieldNameToColumnName +, escapeHaskellKeyword +, tableNameToControllerName +, tableNameToViewName +, enumValueToControllerName +, toSlug +, fieldNameToFieldLabel +, columnNameToFieldLabel +, removeIdSuffix +) where + +import Prelude hiding (splitAt, words, map) +import IHP.HaskellSupport +import Data.Text +import Data.String.Conversions (cs) +import qualified Data.Char as Char +import qualified Text.Inflections as Inflector +import qualified Data.Maybe as Maybe +import qualified Data.List as List +import Control.Monad (join) +import qualified Text.Inflections +import qualified Data.Text as Text +import Text.Countable (singularize, pluralize) + +-- | Transforms a underscore table name to a camel case model name. +-- +-- >>> tableNameToModelName "users" +-- "User" +-- +-- >>> tableNameToModelName "projects" +-- "Project" +tableNameToModelName :: Text -> Text +tableNameToModelName "brain_waves" = "BrainWave" +tableNameToModelName tableName = do + let singularizedTableName = cs (singularize tableName) + if "_" `isInfixOf` singularizedTableName + then unwrapEither tableName $ Inflector.toCamelCased True $ singularizedTableName + else ucfirst singularizedTableName +{-# INLINABLE tableNameToModelName #-} + +-- | Transforms a underscore table name to a name for a controller +-- +-- >>> tableNameToControllerName "users" +-- "Users" +-- +-- >>> tableNameToControllerName "projects" +-- "Projects" +-- +-- >>> tableNameToControllerName "user_projects" +-- "UserProjects" +tableNameToControllerName :: Text -> Text +tableNameToControllerName tableName = do + if "_" `isInfixOf` tableName + then unwrapEither tableName $ Inflector.toCamelCased True tableName + else ucfirst tableName +{-# INLINABLE tableNameToControllerName #-} + +-- | Transforms an underscore table name to a name for a view +-- +-- >>> tableNameToViewName "users" +-- +-- >>> tableNameToViewName "projects" +-- +-- >>> tableNameToViewName "user_projects" +tableNameToViewName :: Text -> Text +tableNameToViewName = tableNameToControllerName +{-# INLINABLE tableNameToViewName #-} + +-- | Transforms a enum value to a name for a model +-- +-- >>> enumValueToControllerName "happy" +-- "Happy" +-- +-- >>> enumValueToControllerName "very happy" +-- "VeryHappy" +-- +-- >>> enumValueToControllerName "very_happy" +-- "VeryHappy" +enumValueToControllerName :: Text -> Text +enumValueToControllerName enumValue = + let + words :: [Inflector.SomeWord] + words = + enumValue + |> splitOn " " + |> List.map (Inflector.parseSnakeCase []) + |> List.map (\case + Left failed -> error (cs $ "enumValueToControllerName failed for " <> show failed) + Right result -> result) + |> join + in + Inflector.camelizeCustom True words + +-- | Transforms a camel case model name to a underscored table name. +-- +-- >>> modelNameToTableName "User" +-- "users" +-- +-- >>> modelNameToTableName "UserProject" +-- "user_projects" +modelNameToTableName :: Text -> Text +modelNameToTableName modelName = + Inflector.toUnderscore modelName + |> unwrapEither modelName + |> pluralize +{-# INLINABLE modelNameToTableName #-} + +-- | Transforms a underscore table column name to a camel case attribute name for use in haskell. +-- +-- >>> columnNameToFieldName "email" +-- "email" +-- +-- >>> columnNameToFieldName "project_id" +-- "projectId" +columnNameToFieldName :: Text -> Text +columnNameToFieldName columnName = escapeHaskellKeyword (unwrapEither columnName $ Inflector.toCamelCased False columnName) +{-# INLINABLE columnNameToFieldName #-} + +{-# INLINABLE unwrapEither #-} +unwrapEither _ (Right value) = value +unwrapEither input (Left value) = error ("IHP.NameSupport: " <> show value <> " (value to be transformed: " <> show input <> ")") + +-- | Transforms a camel case attribute name from haskell to a underscore table column name for the database. +-- +-- >>> fieldNameToColumnName "email" +-- "email" +-- +-- >>> fieldNameToColumnName "projectId" +-- "project_id" +fieldNameToColumnName :: Text -> Text +fieldNameToColumnName columnName = unwrapEither columnName $ Inflector.toUnderscore columnName +{-# INLINABLE fieldNameToColumnName #-} + +-- | Returns a more friendly version for an identifier +humanize :: Text -> Text +humanize text = unwrapEither text $ Inflector.toHumanized True text +{-# INLINABLE humanize #-} + +{-# INLINABLE applyFirst #-} +applyFirst :: (Text -> Text) -> Text -> Text +applyFirst f text = + let (first, rest) = splitAt 1 text + in (f first) <> rest + +-- | Make a text's first character lowercase +-- +-- >>> lcfirst "Hello World" +-- "hello World" +-- +-- >>> lcfirst "alread lowercase" +-- "already lowercase" +lcfirst :: Text -> Text +lcfirst = applyFirst toLower +{-# INLINABLE lcfirst #-} + +-- | Make a text's first character uppercase +-- +-- >>> ucfirst "hello world" +-- "Hello World" +-- +-- >>> ucfirst "Already uppercase" +-- "Already uppercase" +ucfirst :: Text -> Text +ucfirst = applyFirst toUpper +{-# INLINABLE ucfirst #-} + +-- | Add '_' to the end of a name if it is a reserved haskell keyword +-- +-- >>> escapeHaskellKeyword "test" +-- "test" +-- +-- >>> escapeHaskellKeyword "type" +-- "type_" +escapeHaskellKeyword :: Text -> Text +escapeHaskellKeyword name = if toLower name `Prelude.elem` haskellKeywords then name <> "_" else name + +haskellKeywords :: [Text] +haskellKeywords = [ "_" + , "as" + , "case" + , "class" + , "data" + , "default" + , "deriving" + , "do" + , "else" + , "hiding" + , "if" + , "import" + , "in" + , "infix" + , "infixl" + , "infixr" + , "instance" + , "let" + , "module" + , "newtype" + , "of" + , "qualified" + , "then" + , "type" + , "where" + , "forall" + , "mdo" + , "family" + , "role" + , "pattern" + , "static" + , "group" + , "by" + , "using" + , "foreign" + , "export" + , "label" + , "dynamic" + , "safe" + , "interruptible" + , "unsafe" + , "stdcall" + , "ccall" + , "capi" + , "prim" + , "javascript" + , "rec" + , "proc" + ] + +-- | Transforms a string to a value to be safely used in urls +-- +-- >>> toSlug "IHP Release: 21.08.2020 (v21082020)" +-- "ihp-release-21-08-2020-v21082020" +-- +-- >>> toSlug "Hallo! @ Welt" +-- "hallo-welt" +toSlug :: Text -> Text +toSlug text = + text + |> toLower + |> map replaceChar + |> words + |> intercalate "-" + where + replaceChar 'ä' = 'a' + replaceChar 'ö' = 'o' + replaceChar 'ü' = 'u' + replaceChar char = if Char.isAlphaNum char && Char.isAscii char then char else ' ' + + +-- | Transform a data-field name like @userName@ to a friendly human-readable name like @User name@ +-- +-- >>> fieldNameToFieldLabel "userName" +-- "User name" +-- +fieldNameToFieldLabel :: Text -> Text +fieldNameToFieldLabel fieldName = cs (let (Right parts) = Text.Inflections.parseCamelCase [] fieldName in Text.Inflections.titleize parts) +{-# INLINABLE fieldNameToFieldLabel #-} + +-- | Transform a column name like @user_name@ to a friendly human-readable name like @User name@ +-- +-- >>> columnNameToFieldLabel "user_name" +-- "User name" +-- +columnNameToFieldLabel :: Text -> Text +columnNameToFieldLabel columnName = cs (let (Right parts) = Text.Inflections.parseSnakeCase [] columnName in Text.Inflections.titleize parts) +{-# INLINABLE columnNameToFieldLabel #-} + + +-- | Removes @ Id@ from a string +-- +-- >>> removeIdSuffix "User Id" +-- "User" +-- +-- When the string does not end with @ Id@, it will just return the input string: +-- +-- >>> removeIdSuffix "Project" +-- "Project" +removeIdSuffix :: Text -> Text +removeIdSuffix text = Maybe.fromMaybe text (Text.stripSuffix " Id" text) +{-# INLINABLE removeIdSuffix #-} diff --git a/IHP/PGListener.hs b/IHP/PGListener.hs new file mode 100644 --- /dev/null +++ b/IHP/PGListener.hs @@ -0,0 +1,274 @@ +{-| +Module: IHP.PGListener +Description: Event listener handling pg_notify messages +Copyright: (c) digitally induced GmbH, 2021 + +This module is solving the problem, that previously IHP was using one database connection +per running @LISTEN ..;@ statement. A @PGListener@ provides one central object to listen on +postgres channels, without manually dealing with connection management. +-} +module IHP.PGListener +( Channel +, Callback +, Subscription (..) +, PGListener (..) +, init +, stop +, withPGListener +, subscribe +, subscribeJSON +, unsubscribe +) where + +import IHP.Prelude hiding (init) +import IHP.ModelSupport +import qualified Data.Set as Set +import qualified Database.PostgreSQL.Simple as PG +import qualified Database.PostgreSQL.Simple.Types as PG +import qualified Database.PostgreSQL.Simple.Notification as PG +import qualified Data.UUID.V4 as UUID +import Control.Concurrent.MVar (MVar) +import qualified Control.Concurrent.MVar as MVar +import Data.HashMap.Strict as HashMap +import qualified Control.Concurrent.Async as Async +import qualified Data.List as List +import qualified Data.Aeson as Aeson +import qualified IHP.Log as Log +import qualified Control.Exception.Safe as Exception +import qualified Control.Concurrent.Chan.Unagi as Queue +import qualified Control.Concurrent + +-- TODO: How to deal with timeout of the connection? + +-- | The channel is like the event name +-- +-- It's used in the postgres NOTIFY call: +-- +-- > NOTIFY channel [ , payload ] +-- +type Channel = ByteString + +-- | An event callback receives the postgres notification object and can do IO +type Callback = PG.Notification -> IO () + +-- | Returned by a call to 'subscribe' +data Subscription = Subscription + { id :: !UUID + , reader :: !(Async ()) + , inChan :: !(Queue.InChan PG.Notification) + , channel :: !Channel + } + +-- | The main datatype of the service. Keeps tracks of all channels we're watching on, as well as all open subscriptions +-- +-- Use 'init' to create a new object and 'stop' to deallocate it. +data PGListener = PGListener + { modelContext :: !ModelContext + , listeningTo :: !(MVar (Set Channel)) + , listenTo :: !(MVar Channel) + , subscriptions :: !(IORef (HashMap Channel [Subscription])) + , notifyLoopAsync :: !(Async ()) + } + +-- | Creates a new 'PGListener' object +-- +-- > let modelContext = .. +-- > pgListener <- PGListener.init modelContext +-- +-- This will start a new async listening for postgres notifications. This will take one connection +-- from the database pool and keep it blocked until 'stop' is called. +-- +init :: ModelContext -> IO PGListener +init modelContext = do + listeningTo <- MVar.newMVar Set.empty + subscriptions <- newIORef HashMap.empty + listenTo <- MVar.newEmptyMVar + + let ?modelContext = modelContext + notifyLoopAsync <- async (notifyLoop listeningTo listenTo subscriptions) + pure PGListener { modelContext, listeningTo, subscriptions, listenTo, notifyLoopAsync } + +-- | Stops the database listener async and puts the database connection used back into the database pool +-- +-- > PGListener.stop pgListener +-- +stop :: PGListener -> IO () +stop PGListener { notifyLoopAsync } = do + cancel notifyLoopAsync + +withPGListener :: ModelContext -> (PGListener -> IO a) -> IO a +withPGListener modelContext = + Exception.bracket (init modelContext) stop + +-- | After you subscribed to a channel, the provided callback will be called whenever there's a new +-- notification on the channel. +-- +-- > pgListener <- PGListener.init +-- > +-- > let callback notification = do +-- > let payload :: Text = cs (notification.notificationData) +-- > putStrLn ("Received notification: " <> payload) +-- > +-- > subscription <- pgListener |> PGListener.subscribe "my_channel" callback +-- +-- The @callback@ function will now be called whenever @NOTIFY "my_channel", "my payload"@ is executed on the postgres server. +-- +-- When the subscription is not used anymore, call 'unsubscribe' to stop the callback from being called anymore. +-- +subscribe :: Channel -> Callback -> PGListener -> IO Subscription +subscribe channel callback pgListener = do + id <- UUID.nextRandom + listenToChannelIfNeeded channel pgListener + + -- We use a queue here to guarantee that the messages are processed in the right order + -- while keeping high performance. + -- + -- A naive implementation might be just kicking of an async for each message. But in that case + -- the messages might be delivered to the final consumer out of order. + (inChan, outChan) <- Queue.newChan + + let + -- We need to log any exception, otherwise there might be silent errors + logException :: SomeException -> IO () + logException exception = logError pgListener ("Error in pg_notify handler: " <> cs (displayException exception)) + + reader <- async $ forever do + message <- Queue.readChan outChan + callback message `Exception.catch` logException + let subscription = Subscription { .. } + + modifyIORef' (pgListener.subscriptions) (HashMap.insertWith mappend channel [subscription] ) + + pure subscription + +-- | Like 'subscribe' but decodes the notification payload from JSON and passes the decoded data structure to the callback +-- +-- When JSON parsing fails, this will ignore the notification. +-- +-- > pgListener <- PGListener.init +-- > +-- > let callback (jsonObject :: Aeson.Value) = do +-- > putStrLn ("Received notification: " <> tshow jsonObject) +-- > +-- > subscription <- pgListener |> PGListener.subscribeJSON "my_json_channel" callback +-- +-- The @callback@ function will now be called whenever @NOTIFY "my_json_channel", "{\"hello\":\"world\"}"@ is executed on the postgres server. +subscribeJSON :: Aeson.FromJSON jsonValue => Channel -> (jsonValue -> IO ()) -> PGListener -> IO Subscription +subscribeJSON channel callback pgListener = subscribe channel callback' pgListener + where + callback' notification = do + let payload = (notification.notificationData) + case Aeson.decodeStrict' payload of + Just payload -> callback payload + Nothing -> logError pgListener ("PGListener.subscribeJSON: Failed to parse " <> tshow payload) + +-- | Stops the callback of a subscription from receiving further notifications +-- +-- > pgListener <- PGListener.init +-- > +-- > subscription <- pgListener |> PGListener.subscribe "my_channel" callback +-- > doSomethingExpensive +-- > pgListener |> PGListener.unsubscribe subscription +-- +unsubscribe :: Subscription -> PGListener -> IO () +unsubscribe subscription@(Subscription { .. }) pgListener = do + let + deleteById :: [Subscription] -> [Subscription] + deleteById = List.deleteBy (\a b -> a.id == b.id) subscription + modifyIORef' (pgListener.subscriptions) (HashMap.adjust deleteById channel) + uninterruptibleCancel reader + pure () + +-- | Runs a @LISTEN ..;@ statements on the postgres connection, if not already listening on that channel +listenToChannelIfNeeded :: Channel -> PGListener -> IO () +listenToChannelIfNeeded channel pgListener = do + listeningTo <- MVar.readMVar (pgListener.listeningTo) + let alreadyListening = channel `Set.member` listeningTo + + unless alreadyListening do + MVar.putMVar (pgListener.listenTo) channel + + + + +-- | The main loop that is receiving events from the database and triggering callbacks +-- +-- Todo: What happens when the connection dies? +notifyLoop :: (?modelContext :: ModelContext) => MVar (Set Channel) -> MVar Channel -> IORef (HashMap Channel [Subscription]) -> IO () +notifyLoop listeningToVar listenToVar subscriptions = do + -- Wait until the first LISTEN is requested before taking a database connection from the pool + MVar.readMVar listenToVar + + let innerLoop = do + withDatabaseConnection \databaseConnection -> do + + -- If listeningTo already contains channels, this means that previously the database connection + -- died, so we're restarting here. Therefore we need to replay all LISTEN calls to restore the previous state + listeningTo <- MVar.readMVar listeningToVar + forEach listeningTo (listenToChannel databaseConnection) + + -- This loop reads channels from the 'listenToVar' and then triggers a LISTEN statement on + -- the current database connections + let listenLoop = forever do + channel <- MVar.takeMVar listenToVar + + MVar.modifyMVar_ listeningToVar \listeningTo -> do + let alreadyListening = channel `Set.member` listeningTo + + if alreadyListening + then pure listeningTo + else do + listenToChannel databaseConnection channel + pure (Set.insert channel listeningTo) + + Async.withAsync listenLoop \listenLoopAsync -> do + forever do + notification <- PG.getNotification databaseConnection + let channel = notification.notificationChannel + + allSubscriptions <- readIORef subscriptions + let channelSubscriptions = allSubscriptions + |> HashMap.lookup channel + |> fromMaybe [] + + forEach channelSubscriptions \subscription -> do + let inChan = subscription.inChan + Queue.writeChan inChan notification + + -- Initial delay (in microseconds) + let initialDelay = 500 * 1000 + -- Max delay (in microseconds) + let maxDelay = 60 * 1000 * 1000 + -- This outer loop restarts the listeners if the database connection dies (e.g. due to a timeout) + let retryLoop delay isFirstError = do + result <- Exception.tryAny innerLoop + case result of + Left error -> do + let ?context = ?modelContext -- Log onto the modelContext logger + if isFirstError then do + Log.info ("PGListener is going to restart, loop failed with exception: " <> (displayException error) <> ". Retrying immediately.") + retryLoop delay False -- Retry with no delay interval on first error, but will increase delay interval in subsequent retries + else do + let increasedDelay = delay * 2 -- Double current delay + let nextDelay = min increasedDelay maxDelay -- Picks whichever delay is lowest of increasedDelay * 2 or maxDelay + Log.info ("PGListener is going to restart, loop failed with exception: " <> (displayException error) <> ". Retrying in " <> cs (printTimeToNextRetry delay) <> ".") + Control.Concurrent.threadDelay delay -- Sleep for the current delay + retryLoop nextDelay False -- Retry with longer interval + Right _ -> + retryLoop initialDelay True -- If all went well, re-run with no sleeping and reset current delay to the initial value + retryLoop initialDelay True + +printTimeToNextRetry :: Int -> Text +printTimeToNextRetry microseconds + | microseconds >= 1000000000 = show (microseconds `div` 1000000000) <> " min" + | microseconds >= 1000000 = show (microseconds `div` 1000000) <> " s" + | microseconds >= 1000 = show (microseconds `div` 1000) <> " ms" + | otherwise = show microseconds <> " µs" + +listenToChannel :: PG.Connection -> Channel -> IO () +listenToChannel databaseConnection channel = do + PG.execute databaseConnection "LISTEN ?" [PG.Identifier (cs channel)] + pure () + +logError :: PGListener -> Text -> IO () +logError pgListener message = let ?context = pgListener.modelContext in Log.error message diff --git a/IHP/PageHead/ControllerFunctions.hs b/IHP/PageHead/ControllerFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/PageHead/ControllerFunctions.hs @@ -0,0 +1,57 @@ +{-| +Module: IHP.PageHead.ControllerFunctions +Description: Manage the @@ and @<meta>@ tags of your HTML pages +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.PageHead.ControllerFunctions +( setTitle +, setDescription +, setOGTitle +, setOGType +, setOGDescription +, setOGUrl +, setOGImage +) where + +import IHP.Prelude +import IHP.PageHead.Types +import IHP.Controller.Context + +-- | Sets the page title. Can be accessed using '{pageTitle}' inside your @Layout.hs@. +-- +-- Example: +-- +-- > action ShowProjectAction { projectId } = do +-- > project <- fetch projectId +-- > setTitle (project.title) +-- > +-- +-- Inside your layout use it like: +-- +-- > defaultLayout :: Html -> Html +-- > defaultLayout inner = [hsx| +-- > <head> +-- > <title>{pageTitle} +-- > +-- > |] +-- +setTitle :: (?context :: ControllerContext) => Text -> IO () +setTitle title = putContext (PageTitle title) + +setDescription :: (?context :: ControllerContext) => Text -> IO () +setDescription description = putContext (PageDescription description) + +setOGTitle :: (?context :: ControllerContext) => Text -> IO () +setOGTitle title = putContext (OGTitle title) + +setOGType :: (?context :: ControllerContext) => Text -> IO () +setOGType type_ = putContext (OGType type_) + +setOGDescription :: (?context :: ControllerContext) => Text -> IO () +setOGDescription description = putContext (OGDescription description) + +setOGUrl :: (?context :: ControllerContext) => Text -> IO () +setOGUrl url = putContext (OGUrl url) + +setOGImage :: (?context :: ControllerContext) => Text -> IO () +setOGImage image = putContext (OGImage image) diff --git a/IHP/PageHead/Types.hs b/IHP/PageHead/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/PageHead/Types.hs @@ -0,0 +1,21 @@ +{-| +Module: IHP.PageHead.Types +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.PageHead.Types where + +import IHP.Prelude + +newtype PageTitle = PageTitle Text + +newtype PageDescription = PageDescription Text + +newtype OGTitle = OGTitle Text + +newtype OGType = OGType Text + +newtype OGDescription = OGDescription Text + +newtype OGUrl = OGUrl Text + +newtype OGImage = OGImage Text diff --git a/IHP/PageHead/ViewFunctions.hs b/IHP/PageHead/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/PageHead/ViewFunctions.hs @@ -0,0 +1,261 @@ +{-| +Module: IHP.PageHead.ViewFunctions +Description: Manage the @@ and @<meta>@ tags of your HTML pages +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.PageHead.ViewFunctions +( pageTitle +, pageTitleOrDefault +, pageTitleOrNothing +, descriptionOrDefault +, ogTitleOrDefault +, ogTypeOrDefault +, ogDescriptionOrDefault +, ogUrl +, ogImage +, module IHP.PageHead.ControllerFunctions -- | Re-export as we want to call setTitle from the beforeRender hook +) where + +import IHP.Prelude +import IHP.PageHead.Types +import IHP.Controller.Context +import IHP.PageHead.ControllerFunctions +import IHP.HSX.QQ (hsx) +import Text.Blaze.Html5 (Html) + +-- | Returns the current page title. The title can be set using @setTitle "my title"@ from the action. +-- +-- If the title hasn't been set yet, this will return an empty string. You can also use 'pageTitleOrDefault' to pass a custom default title. +-- +-- You can use this inside your @<title>@ tag like this: +-- +-- > [hsx| +-- > <head> +-- > <title>{pageTitle} +-- > +-- > |] +-- +-- +-- *App-wide default title:* +-- +-- You can set a app-wide default title by calling 'setTitle' from the @FrontController.hs@: +-- +-- > instance InitControllerContext Web where +-- > initContext = do +-- > setLayout defaultLayout +-- > initAutoRefresh +-- > setTitle "Jobs" +-- +-- +-- *View-specific title:* +-- +-- You can set a custom title inside the view by calling 'setTitle' inside the 'beforeRender' hook. +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setTitle "Custom title" +-- > +-- > html ShowView { .. } = [hsx|..|] +pageTitle :: (?context :: ControllerContext) => Text +pageTitle = pageTitleOrDefault "" + +-- | Returns the current page title, like 'pageTitle' but returns a provided default value instead of an empty string if no title is set. +-- +-- You can use this inside your @@ tag like this: +-- +-- > [hsx| +-- > <head> +-- > <title>{pageTitleOrDefault "My Application"} +-- > +-- > |] +pageTitleOrDefault :: (?context :: ControllerContext) => Text -> Text +pageTitleOrDefault defaultValue = pageTitleOrNothing |> fromMaybe defaultValue + +-- | Returns the current page title or Nothing if not set yet +pageTitleOrNothing :: (?context :: ControllerContext) => Maybe Text +pageTitleOrNothing = case maybeFromFrozenContext @PageTitle of + Just (PageTitle title) -> Just title + Nothing -> Nothing + + +-- | Returns the meta og:title element. The og:title can be set using @setOGTitle "my title"@ from the view. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {ogTitleOrDefault "default title"} +-- > +-- > |] +-- +-- +-- *View-specific og:title:* +-- +-- You can override the default og:title inside the view by calling 'setOGTitle' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setOGTitle "Custom title" +-- > +-- > html ShowView { .. } = [hsx|..|] +ogTitleOrDefault :: (?context :: ControllerContext) => Text -> Html +ogTitleOrDefault defaultValue = [hsx||] + where + content = case maybeFromFrozenContext @OGTitle of + Just (OGTitle title) -> title + Nothing -> defaultValue + +-- | Returns @@ element. The description can be set using @setDescription "my description"@ from the view. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {descriptionOrDefault "CO2 Database"} +-- > +-- > |] +-- +-- +-- *View-specific description:* +-- +-- You can override the default description inside the view by calling 'setDescription' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setDescription "The CO2 Footprint of beef is about 67kg CO2 per 1kg of beef." +-- > +-- > html ShowView { .. } = [hsx|..|] +descriptionOrDefault :: (?context :: ControllerContext) => Text -> Html +descriptionOrDefault defaultValue = [hsx||] + where + content = case maybeFromFrozenContext @PageDescription of + Just (PageDescription description) -> description + Nothing -> defaultValue + +-- | Returns the meta og:type element. The og:type can be set using @setOGType "data"@ from the view. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {ogTypeOrDefault "data"} +-- > +-- > |] +-- +-- +-- *View-specific og:type:* +-- +-- You can override the default og:type inside the view by calling 'setOGType' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setOGType "mytype" +-- > +-- > html ShowView { .. } = [hsx|..|] +ogTypeOrDefault :: (?context :: ControllerContext) => Text -> Html +ogTypeOrDefault defaultValue = [hsx||] + where + content = case maybeFromFrozenContext @OGType of + Just (OGType type_) -> type_ + Nothing -> defaultValue + +-- | Returns the meta og:description element. The og:description can be set using @setOGDescription "my description"@ from the view. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {ogDescriptionOrDefault "CO2 Database"} +-- > +-- > |] +-- +-- +-- *View-specific og:description:* +-- +-- You can override the default og:description inside the view by calling 'setOGDescription' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setOGDescription "The CO2 Footprint of beef is about 67kg CO2 per 1kg of beef." +-- > +-- > html ShowView { .. } = [hsx|..|] +ogDescriptionOrDefault :: (?context :: ControllerContext) => Text -> Html +ogDescriptionOrDefault defaultValue = [hsx||] + where + content = case maybeFromFrozenContext @OGDescription of + Just (OGDescription description) -> description + Nothing -> defaultValue + + +-- | Returns the meta og:url element if @setOGUrl "https://example.com/"@ was called before. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {ogUrl} +-- > +-- > |] +-- +-- When 'setOGUrl' is not called, no meta tag will be rendered. +-- +-- *Setting og:url:* +-- +-- You can set the og:url inside the view by calling 'setOGUrl' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setOGUrl (urlTo ShowAction { .. }) +-- > +-- > html ShowView { .. } = [hsx|..|] +ogUrl :: (?context :: ControllerContext) => Html +ogUrl = case maybeFromFrozenContext @OGUrl of + Just (OGUrl url) -> [hsx||] + Nothing -> mempty + + +-- | Returns the meta og:image element if @setOGImage "https://example.com/image.png"@ was called before. +-- +-- You can use this inside your Layout like this: +-- +-- > [hsx| +-- > +-- > {pageTitle} +-- > {ogImage} +-- > +-- > |] +-- +-- When 'setOGImage' is not called, no meta tag will be rendered. +-- +-- *Setting og:image:* +-- +-- You can set the og:image inside the view by calling 'setOGImage' inside the 'beforeRender' hook: +-- +-- > module JobSite.View.JobPositions.Show where +-- > +-- > instance View ShowView where +-- > beforeRender ShowView { .. } = do +-- > setOGImage "https://example.com/image.png" +-- > +-- > html ShowView { .. } = [hsx|..|] +ogImage :: (?context :: ControllerContext) => Html +ogImage = case maybeFromFrozenContext @OGImage of + Just (OGImage url) -> [hsx||] + Nothing -> mempty diff --git a/IHP/Pagination/ControllerFunctions.hs b/IHP/Pagination/ControllerFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Pagination/ControllerFunctions.hs @@ -0,0 +1,233 @@ +{-| +Module: IHP.Pagination.ControllerFunctions +Description: Paginate results in your actions +Copyright: (c) digitally induced GmbH, 2021 +-} +module IHP.Pagination.ControllerFunctions +( paginate, + paginateWithOptions, + filterList, + defaultPaginationOptions, + paginatedSqlQuery, + paginatedSqlQueryWithOptions, +) where + +import IHP.Prelude +import IHP.Controller.Context +import IHP.Controller.Param ( paramOrDefault, paramOrNothing ) +import IHP.Pagination.Types ( Options(..), Pagination(..) ) +import IHP.QueryBuilder ( HasQueryBuilder, filterWhereILike, limit, offset ) +import IHP.Fetch (fetchCount) +import IHP.ModelSupport (GetModelByTableName, sqlQuery, sqlQueryScalar, Table) + +import Database.PostgreSQL.Simple (FromRow, ToRow, Query(..), Only(Only), (:.)(..)) + +-- | Paginate a query, with the following default options: +-- +-- 1. Maximum items per page: 50. Each page will show at most 50 items. +-- 2. Selector window size: 5. The selector will show the current page, and 5 pages before and after it, +-- if they exist. +-- +-- This function should be used inside your controller action. It will do two things: +-- +-- 1. Using the 'page' (current page number to display) and 'maxItems' (which overrides the set maximum +-- items per page) request parameters, this applies the the needed limit and offset to display the +-- correct page. For instance, page 3 with a maxItems of 50 would produce a limit of 50 and an offset +-- of 100 to display results 100 through 150. +-- 2. Returns a 'Pagination' state which should be passed through to your view and then, +-- in turn, 'renderPagination'. +-- +-- Example: +-- +-- > action UsersAction = do +-- > (userQ, pagination) <- query @User +-- > |> orderBy #email +-- > |> paginate +-- > user <- userQ |> fetch +-- > render IndexView { .. } +paginate :: forall controller table queryBuilderProvider joinRegister . + (?context::ControllerContext + , ?modelContext :: ModelContext + , ?theAction :: controller + , KnownSymbol table + , HasQueryBuilder queryBuilderProvider joinRegister) => + queryBuilderProvider table + -> IO (queryBuilderProvider table, Pagination) +paginate = paginateWithOptions defaultPaginationOptions + +-- | Paginate with ability to override the default options for maximum items per page and selector window size. +-- +-- This function should be used inside your controller action. It will do two things: +-- +-- 1. Using the 'page' (current page number to display) and 'maxItems' (which overrides the set maximum +-- items per page) request parameters, this applies the the needed limit and offset to display the +-- correct page. For instance, page 3 with a maxItems of 50 would produce a limit of 50 and an offset +-- of 100 to display results 100 through 150. +-- 2. Returns a 'Pagination' state which should be passed through to your view and then, +-- in turn, 'renderPagination'. +-- +-- Example: +-- +-- > action UsersAction = do +-- > (userQ, pagination) <- query @User +-- > |> orderBy #email +-- > |> paginateWithOptions +-- > (defaultPaginationOptions +-- > |> set #maxItems 10) +-- > user <- userQ |> fetch +-- > render IndexView { .. } +paginateWithOptions :: forall controller table queryBuilderProvider joinRegister . + (?context::ControllerContext + , ?modelContext :: ModelContext + , ?theAction :: controller + , KnownSymbol table + , HasQueryBuilder queryBuilderProvider joinRegister) => + Options + -> queryBuilderProvider table + -> IO (queryBuilderProvider table, Pagination) +paginateWithOptions options query = do + count <- query + |> fetchCount + + let pageSize = pageSize' options + pagination = Pagination + { currentPage = page + , totalItems = fromIntegral count + , pageSize = pageSize + , window = windowSize options + } + + let results = query + |> limit pageSize + |> offset (offset' pageSize page) + + pure + ( results + , pagination + ) + +-- | Reading from the 'filter' query parameter, filters a query according to the string entered in the +-- filter box by the user (if any), on a given text-based field. Will return any results containing the +-- string in a case-insensitive fashion. +-- +-- Example: +-- +-- > action UsersAction = do +-- > (userQ, pagination) <- query @User +-- > |> orderBy #email +-- > |> paginate +-- > |> filterList #email +-- > user <- userQ |> fetch +-- > render IndexView { .. } +filterList :: forall name table model queryBuilderProvider joinRegister . + (?context::ControllerContext + , KnownSymbol name + , HasField name model Text + , model ~ GetModelByTableName table + , KnownSymbol table + , HasQueryBuilder queryBuilderProvider joinRegister + , Table model + ) => + Proxy name + -> queryBuilderProvider table + -> queryBuilderProvider table +filterList field = + case paramOrNothing @Text "filter" of + Just uf -> filterWhereILike (field, "%" <> uf <> "%") + Nothing -> id + +-- | Default options for a pagination. Can be passed into 'paginateOptions'. The defaults are as follows: +-- +-- 1. Maximum items per page: 50. Each page will show at most 50 items. +-- 2. Selector window size: 5. The selector will show the current page, and up to 5 pages before and after it, +-- if they exist. +defaultPaginationOptions :: Options +defaultPaginationOptions = + Options + { maxItems = 50 + , windowSize = 5 + } + +-- | Runs a raw sql query and adds pagination to it. +-- +-- By default, the pagination uses the following options: +-- 1. Maximum items per page: 50. Each page will show at most 50 items. +-- 2. Selector window size: 5. The selector will show the current page, and 5 pages before and after it, +-- if they exist. +-- +-- This function should be used inside your controller action. It will do three things: +-- +-- 1. Using the 'page' (current page number to display) and 'maxItems' (which overrides the set maximum +-- items per page) request parameters, this applies the the needed limit and offset to display the +-- correct page. For instance, page 3 with a maxItems of 50 would produce a limit of 50 and an offset +-- of 100 to display results 100 through 150. +-- 2. Returns a 'Pagination' state which should be passed through to your view and then, +-- in turn, 'renderPagination'. +-- 3. Actually run the query and return the result. +-- +-- __Example:__ +-- +-- > (users, pagination) <- paginatedSqlQuery "SELECT id, firstname, lastname FROM users" () +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +-- +-- *AutoRefresh:* When using 'paginatedSqlQuery' with AutoRefresh, you need to use 'trackTableRead' to let AutoRefresh know that you have accessed a certain table. Otherwise AutoRefresh will not watch table of your custom sql query. +paginatedSqlQuery + :: ( FromRow model + , ToRow parameters + , ?context :: ControllerContext + , ?modelContext :: ModelContext + ) + => Query -> parameters -> IO ([model], Pagination) +paginatedSqlQuery = paginatedSqlQueryWithOptions defaultPaginationOptions + +-- | Runs a raw sql query and adds pagination to it. +-- +-- This function accepts the same Options as 'paginateWithOptions', but otherwise behaves like 'paginatedSqlQuery'. +-- +-- __Example:__ +-- +-- > (users, pagination) <- paginatedSqlQueryWithOptions +-- > (defaultPaginationOptions |> set #maxItems 10) +-- > "SELECT id, firstname, lastname FROM users" +-- > () +-- +-- Take a look at "IHP.QueryBuilder" for a typesafe approach on building simple queries. +-- +-- *AutoRefresh:* When using 'paginatedSqlQuery' with AutoRefresh, you need to use 'trackTableRead' to let AutoRefresh know that you have accessed a certain table. Otherwise AutoRefresh will not watch table of your custom sql query. +paginatedSqlQueryWithOptions + :: ( FromRow model + , ToRow parameters + , ?context :: ControllerContext + , ?modelContext :: ModelContext + ) + => Options -> Query -> parameters -> IO ([model], Pagination) +paginatedSqlQueryWithOptions options sql placeholders = do + count :: Int <- sqlQueryScalar ("SELECT count(subquery.*) FROM (" <> sql <> ") as subquery") placeholders + + let pageSize = pageSize' options + pagination = Pagination + { pageSize = pageSize + , totalItems = fromIntegral count + , currentPage = fromIntegral page + , window = windowSize options + } + + results :: [model] <- sqlQuery + ("SELECT subquery.* FROM (" <> sql <> ") as subquery LIMIT ? OFFSET ?") + (placeholders :. Only pageSize :. Only (offset' pageSize page)) + + pure (results, pagination) + +-- We limit the page size to a maximum of 200, to prevent users from +-- passing in query params with a value that could overload the +-- database (e.g. maxItems=100000) +pageSize' :: (?context::ControllerContext) => Options -> Int +pageSize' options = min (max 1 $ paramOrDefault @Int (maxItems options) "maxItems") 200 + +-- Page and page size shouldn't be lower than 1. +page :: (?context::ControllerContext) => Int +page = max 1 $ paramOrDefault @Int 1 "page" + +offset' :: Int -> Int -> Int +offset' pageSize page = (page - 1) * pageSize diff --git a/IHP/Pagination/Helpers.hs b/IHP/Pagination/Helpers.hs new file mode 100644 --- /dev/null +++ b/IHP/Pagination/Helpers.hs @@ -0,0 +1,23 @@ +module IHP.Pagination.Helpers where + +import IHP.Prelude +import IHP.Pagination.Types + +-- | Gets the number of the last page from a 'Pagination' state. Uses the total +-- number of items and the page size to calculate the final page. +getLastPage :: Pagination -> Int +getLastPage Pagination { pageSize, totalItems } = + if pageSize > 1 then + ((totalItems - 1) `div` pageSize) + 1 + else + totalItems `div` pageSize + +-- | Returns 'True' if there is a next page in the pagination, 'False' otherwise. +hasNextPage :: Pagination -> Bool +hasNextPage pagination@Pagination { currentPage } = + getLastPage pagination > currentPage + +-- | Returns 'True' if there is a previous page in the pagination, 'False' otherwise. +hasPreviousPage :: Pagination -> Bool +hasPreviousPage pagination@Pagination { currentPage } = + currentPage > 1 diff --git a/IHP/Pagination/Types.hs b/IHP/Pagination/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Pagination/Types.hs @@ -0,0 +1,32 @@ +module IHP.Pagination.Types where + +import IHP.Prelude + +data Pagination = + Pagination + { + pageSize :: Int -- the number of items per page + , totalItems :: Int -- the total number of items in the result + , currentPage :: Int -- the currently-selected page + , window :: Int -- The size of the window + } + deriving(Show) + +-- | Options for customizing a pagination, to be used with 'paginateOptions'. +data Options = + Options + { + maxItems :: Int -- ^ The maximum items per page. Default 50. + , windowSize :: Int -- ^ The size of the window in the page selector. Default 5. + } + +instance SetField "maxItems" Options Int where + setField value options = + options { maxItems = value } +instance SetField "windowSize" Options Int where + setField value options = + options { windowSize = value } + +data PageDotDot = + Page Int + | DotDot Int diff --git a/IHP/Pagination/ViewFunctions.hs b/IHP/Pagination/ViewFunctions.hs new file mode 100644 --- /dev/null +++ b/IHP/Pagination/ViewFunctions.hs @@ -0,0 +1,199 @@ +module IHP.Pagination.ViewFunctions ( + module IHP.Pagination.Types, + renderPagination, + renderFilter, +) where + +import IHP.Prelude +import IHP.Pagination.Types +import IHP.Pagination.Helpers + +import IHP.ControllerSupport + +import Text.Blaze.Html (Html) +import IHP.HSX.QQ (hsx) + +import IHP.Controller.Param (paramOrNothing) + +import qualified Network.Wai as Wai +import qualified Network.HTTP.Types.URI as Query +import IHP.ViewSupport (theRequest, theCSSFramework) +import qualified Data.Containers.ListUtils as List +import IHP.View.Types (PaginationView(..), styledPagination, styledPaginationPageLink, styledPaginationDotDot, styledPaginationItemsPerPageSelector, styledPaginationLinkPrevious, styledPaginationLinkNext) + + +-- | Render a navigation for your pagination. This is to be used in your view whenever +-- to allow users to change pages, including "Next" and "Previous". +-- If there is only one page, this will not render anything. +renderPagination :: (?context::ControllerContext) => Pagination -> Html +renderPagination pagination@Pagination {currentPage, window, pageSize} = + when (showPagination pagination) $ styledPagination theCSSFramework theCSSFramework paginationView + where + paginationView = PaginationView + { cssFramework = theCSSFramework + , pagination = pagination + , pageUrl = pageUrl + , linkPrevious = linkPrevious + , linkNext = linkNext + , pageDotDotItems = pageDotDotItems + , itemsPerPageSelector = itemsPerPageSelector + } + + linkPrevious = + styledPaginationLinkPrevious theCSSFramework theCSSFramework pagination (pageUrl $ currentPage - 1) + + linkNext = + styledPaginationLinkNext theCSSFramework theCSSFramework pagination (pageUrl $ currentPage + 1) + + itemsPerPageSelector = + styledPaginationItemsPerPageSelector theCSSFramework theCSSFramework pagination itemsPerPageUrl + + pageDotDotItems = [hsx|{forEach (processedPages pages) pageDotDotItem}|] + + pageDotDotItem pg = + case pg of + Page n -> + styledPaginationPageLink theCSSFramework theCSSFramework pagination (pageUrl n) n + DotDot n -> + styledPaginationDotDot theCSSFramework theCSSFramework pagination + + pageUrl n = path <> Query.renderQuery True newQueryString + where + -- "?page=" ++ show n ++ maybeFilter ++ maybeMaxItems + path = Wai.rawPathInfo theRequest + queryString = Wai.queryString theRequest + newQueryString = queryString + |> setQueryValue "page" (cs $ show n) + |> maybeFilter + |> maybeMaxItems + + itemsPerPageUrl n = path <> Query.renderQuery True newQueryString + where + path = Wai.rawPathInfo theRequest + queryString = Wai.queryString theRequest + newQueryString = queryString + |> setQueryValue "maxItems" (cs $ tshow n) + -- If we change the number of items, we should jump back to the first page + -- so we are not out of the items bound. + |> setQueryValue "page" (cs $ show 1) + + maybeFilter queryString = + case paramOrNothing @Text "filter" of + Nothing -> queryString + Just "" -> queryString + Just filterValue -> queryString |> setQueryValue "filter" (cs filterValue) + + maybeMaxItems queryString = + case paramOrNothing @Int "maxItems" of + Nothing -> queryString + Just m -> queryString |> setQueryValue "maxItems" (cs $ tshow m) + + processedPages (pg0:pg1:rest) = + if pg1 == pg0 + 1 then + Page pg0 : processedPages (pg1:rest) + else + Page pg0 : DotDot ((pg1+pg0) `div` 2) : processedPages (pg1:rest) + processedPages [pg] = + [Page pg] + processedPages [] = [] + pages = + let + totalPages = getLastPage pagination + + lowerBound + | currentPage - window < 1 = + 1 + | currentPage + window > totalPages = + totalPages - window * 2 + 1 + | otherwise = + currentPage - window + + upperBound + | currentPage + window > totalPages = + totalPages + | currentPage - window < 1 = + window * 2 + | otherwise = + currentPage + window + + in + if window > totalPages then + [1..getLastPage pagination] + else + List.nubInt $ 1 : [max 1 lowerBound..min (getLastPage pagination) upperBound] ++ [totalPages] + +-- | Render a filtering box in your view. Allows the user to type in a query and filter +-- results according to what they type. +-- +-- Below is an example of how this might be used in your index. Replace the existing

    with: +--
    +--
    +--
    +--

    Users+ New

    +--
    +--
    +-- {renderFilter "Username"} +--
    +--
    +--
    +renderFilter :: (?context::ControllerContext) => + Text -- ^ Placeholder text for the text box + -> Html +renderFilter placeholder = + [hsx| +
    +
    +
    + + + +
    +
    + + Clear +
    +
    +
    + |] + where + boxValue = fromMaybe "" (paramOrNothing "filter") :: Text + clearFilterUrl = path <> Query.renderQuery True newQueryString + where + path = Wai.rawPathInfo theRequest + queryString = Wai.queryString theRequest + newQueryString = queryString + |> removeQueryItem "filter" + + +-- | Set or replace a query string item +-- +-- >>> setQueryValue "page" "1" [] +-- [("page", Just "1")] +-- +-- >>> setQueryValue "page" "2" [("page", Just "1")] +-- [("page", Just "2")] +-- +setQueryValue :: ByteString -> ByteString -> Query.Query -> Query.Query +setQueryValue name value queryString = + case lookup name queryString of + Just existingPage -> queryString + |> map (\(queryItem@(queryItemName, _)) -> if queryItemName == name + then (name, Just value) + else queryItem + ) + Nothing -> queryString <> [(name, Just value)] + +-- | Removes a query item, specified by the name +-- +-- >>> removeQueryItem "filter" [("filter", Just "test")] +-- [] +-- +removeQueryItem :: ByteString -> Query.Query -> Query.Query +removeQueryItem name queryString = queryString |> filter (\(queryItemName, _) -> queryItemName /= name) + +{-| Determine if a Pagination needs to be shown. + If there is only a single page, we shouldn't show a pager. +-} +showPagination :: Pagination -> Bool +showPagination pagination@Pagination {currentPage} = + currentPage /= 1 || hasNextPage pagination || hasPreviousPage pagination diff --git a/IHP/Prelude.hs b/IHP/Prelude.hs new file mode 100644 --- /dev/null +++ b/IHP/Prelude.hs @@ -0,0 +1,122 @@ +module IHP.Prelude +( module CorePrelude +, module Data.Text.IO +, module IHP.HaskellSupport +, module GHC.Records +, UUID +, module Data.Default +, tshow +, Proxy (..) +, module Control.Monad +, module Data.List +, head +, headMay +, last +, lastMay +, tail +, tailMay +, init +, initMay +, show +, module Data.String.Conversions +, module Data.Time.Clock +, module Data.Time.Calendar +, module Data.Time.LocalTime +, module Data.Text +, module GHC.OverloadedLabels +, plain +, (++) +, error +, module Data.Data +, module GHC.TypeLits +, module IHP.NameSupport +, module IHP.ModelSupport +, module Data.TMap +, module Database.PostgreSQL.Simple +, module Data.IORef +, module Data.Time.Format +, null +, module Control.Exception.Safe +, module Control.Monad.Fail +, module Control.Concurrent.Async +, module NeatInterpolation +, module GHC.Stack +, module Data.Kind +) +where + +import CorePrelude hiding (putStr, putStrLn, print, error) +import Data.Text.IO (putStr, putStrLn) +import IHP.HaskellSupport +import Data.Default (def, Default (..)) +import ClassyPrelude (null) +import Data.UUID (UUID) +import GHC.Records +import qualified Prelude +import qualified Data.Text as Text +import Data.Proxy (Proxy (Proxy)) +import Control.Monad (when, unless, mapM, mapM_, forM, forM_, sequence, sequence_, join, forever) +import Data.List hiding (head, last, unwords, unlines, words, lines, isPrefixOf, isSuffixOf, isInfixOf, intercalate, intersperse, (++), splitAt, null, tail, init) +import Data.String.Conversions (ConvertibleStrings (convertString), cs) +import Data.Time.Clock +import Data.Time.Calendar +import Data.Time.LocalTime +import Data.Text (words, unwords, lines, unlines, intersperse, intercalate, toLower, toUpper, isInfixOf, isSuffixOf, isPrefixOf, splitAt) +import qualified "interpolate" Data.String.Interpolate +import GHC.OverloadedLabels +import Data.Data (Data) +import GHC.TypeLits (KnownSymbol, Symbol, symbolVal) +import IHP.NameSupport +import IHP.ModelSupport (ModelContext (..), CanUpdate, NormalizeModel, Id, GetTableName, GetModelName, updateRecord, updateRecordDiscardResult, createRecord, deleteRecord, MetaBag (..)) +import Data.TMap (TMap) +import Database.PostgreSQL.Simple (FromRow) +import Data.IORef +import Data.Time.Format +import Control.Exception.Safe (throw, throwIO, catch) +import Control.Monad.Fail (fail) +import Control.Concurrent.Async +import NeatInterpolation (trimming) +import GHC.Stack (HasCallStack, CallStack) +import Data.Kind (Type) + +-- Alias for haskell newcomers :) +a ++ b = a <> b + +tshow :: Show a => a -> Text +tshow value = Text.pack (Prelude.show value) + +show :: Show a => a -> Text +show = tshow + +error :: Text -> a +error message = Prelude.error (Text.unpack message) + +head :: [a] -> Maybe a +head [] = Nothing +head (firstItem:rest) = Just firstItem + +headMay :: [a] -> Maybe a +headMay = head + +last :: [a] -> Maybe a +last [] = Nothing +last [item] = Just item +last (_:rest) = last rest + +lastMay :: [a] -> Maybe a +lastMay = last + +tail :: [a] -> Maybe [a] +tail (_:rest) = Just rest +tail [] = Nothing + +tailMay :: [a] -> Maybe [a] +tailMay = tail + +init :: [a] -> Maybe [a] +init list = fst <$> (unsnoc list) + +initMay :: [a] -> Maybe [a] +initMay = init + +plain = Data.String.Interpolate.i diff --git a/IHP/QueryBuilder.hs b/IHP/QueryBuilder.hs new file mode 100644 --- /dev/null +++ b/IHP/QueryBuilder.hs @@ -0,0 +1,1192 @@ +{-# LANGUAGE BangPatterns, TypeFamilies, DataKinds, PolyKinds, TypeApplications, ScopedTypeVariables, ConstraintKinds, TypeOperators, GADTs, UndecidableInstances, StandaloneDeriving, FunctionalDependencies, FlexibleContexts, InstanceSigs, AllowAmbiguousTypes, DeriveAnyClass #-} +{-| +Module: IHP.QueryBuilder +Description: Tool to build simple sql queries +Copyright: (c) digitally induced GmbH, 2020 +QueryBuilder is mainly used for doing simple `SELECT` sql queries. It allows dynamic +creation of sql queries in a type safe way. + +For more complex sql queries, use 'IHP.ModelSupport.sqlQuery'. +-} +module IHP.QueryBuilder +( query +, QueryBuilder (..) +, In (In) +, orderBy +, orderByJoinedTable +, orderByAsc +, orderByAscJoinedTable +, orderByDesc +, orderByDescJoinedTable +, limit +, offset +, queryUnion +, queryUnionList +, queryOr +, DefaultScope (..) +, filterWhere +, filterWhereCaseInsensitive +, filterWhereNot +, filterWhereIn +, filterWhereInCaseInsensitive +, filterWhereIdIn +, filterWhereNotIn +, filterWhereLike +, filterWhereILike +, filterWhereMatches +, filterWhereIMatches +, filterWhereJoinedTable +, filterWhereNotJoinedTable +, filterWhereInJoinedTable +, filterWhereNotInJoinedTable +, filterWhereLikeJoinedTable +, filterWhereILikeJoinedTable +, filterWhereMatchesJoinedTable +, filterWhereIMatchesJoinedTable +, filterWherePast +, filterWhereFuture +, labelResults +, EqOrIsOperator +, filterWhereSql +, FilterPrimaryKey (..) +, distinctOn +, distinct +, toSQL +, toSQL' +, buildQuery +, SQLQuery (..) +, OrderByClause (..) +, innerJoin +, innerJoinThirdTable +, HasQueryBuilder +, JoinQueryBuilderWrapper +, NoJoinQueryBuilderWrapper +, LabeledQueryBuilderWrapper +, getQueryBuilder +, NoJoins +, Condition (..) +, Join (..) +, OrderByDirection (..) +, injectQueryBuilder +, FilterOperator (..) +, toEqOrIsOperator +) +where +import IHP.Prelude +import Database.PostgreSQL.Simple.Types (In (In)) +import Database.PostgreSQL.Simple.ToField +import IHP.ModelSupport +import qualified Data.ByteString.Builder as Builder +import IHP.HSX.ToHtml +import qualified Data.ByteString.Char8 as ByteString +import qualified Data.ByteString.Lazy as LByteString +import qualified Control.DeepSeq as DeepSeq +import qualified Data.Text.Encoding as Text +import Data.Text (toLower) +import qualified GHC.Generics + +class DefaultScope table where + defaultScope :: QueryBuilder table -> QueryBuilder table + +instance {-# OVERLAPPABLE #-} DefaultScope table where + {-# INLINE defaultScope #-} + defaultScope queryBuilder = queryBuilder + +instance Table (GetModelByTableName table) => Default (QueryBuilder table) where + {-# INLINE def #-} + def = NewQueryBuilder { selectFrom = tableNameByteString @(GetModelByTableName table), columns = columnNames @(GetModelByTableName table) } + +data MatchSensitivity = CaseSensitive | CaseInsensitive deriving (Show, Eq) + +data FilterOperator + = EqOp -- ^ @col = val@ + | NotEqOp -- ^ @col != val@ + | InOp -- ^ @col IN (set)@ + | NotInOp -- ^ @col NOT IN (set)@ + | IsOp -- ^ @col IS val@ + | IsNotOp -- ^ @col IS NOT val@ + | LikeOp !MatchSensitivity -- ^ @col LIKE val@ + | NotLikeOp !MatchSensitivity -- ^ @col NOT LIKE val@ + | MatchesOp !MatchSensitivity -- ^ @col ~ pattern@ + | SqlOp -- ^ Used by 'filterWhereSql' + deriving (Show, Eq) + + +compileOperator :: FilterOperator -> ByteString +compileOperator EqOp = "=" +compileOperator NotEqOp = "!=" +compileOperator InOp = "IN" +compileOperator NotInOp = "NOT IN" +compileOperator IsOp = "IS" +compileOperator IsNotOp = "IS NOT" +compileOperator (LikeOp CaseSensitive) = "LIKE" +compileOperator (LikeOp CaseInsensitive) = "ILIKE" +compileOperator (NotLikeOp CaseSensitive) = "NOT LIKE" +compileOperator (NotLikeOp CaseInsensitive) = "NOT ILIKE" +compileOperator (MatchesOp CaseSensitive) = " ~ " +compileOperator (MatchesOp CaseInsensitive) = " ~* " +compileOperator SqlOp = "" +{-# INLINE compileOperator #-} + +-- | Returns the "NOT" version of an operator +-- +-- >>> negateFilterOperator EqOp +-- NotEqOp +-- +negateFilterOperator :: FilterOperator -> FilterOperator +negateFilterOperator EqOp = NotEqOp +negateFilterOperator InOp = NotInOp +negateFilterOperator IsOp = IsNotOp +negateFilterOperator (LikeOp matchSensitivity) = (NotLikeOp matchSensitivity) +negateFilterOperator (MatchesOp matchSensitivity) = error "not supported" +negateFilterOperator SqlOp = SqlOp + +data OrderByClause = + OrderByClause + { orderByColumn :: !ByteString + , orderByDirection :: !OrderByDirection } + deriving (Show, Eq, GHC.Generics.Generic, DeepSeq.NFData) + +-- Types implementing a type level list to record joined tables. EmptyModelList and ConsModelList correspond to the data constructors [] and :. NoJoins is like the empty List but cannot be extended. +data NoJoins +data EmptyModelList +data ConsModelList model models + +-- Type class to represent the true list type EmptyModelList ConsModelList. +class ModelList a + +instance ModelList EmptyModelList +instance ModelList (ConsModelList model models) + +-- Typeclass to quer containment in the type-level list. +class IsJoined a b + +instance (ModelList b) => IsJoined a (ConsModelList a b) +instance {-# OVERLAPPABLE #-} (ModelList b, IsJoined a b) => IsJoined a (ConsModelList c b) + +-- Class to generalise over different QueryBuilder-providing types. The actual query builder can be extracted with 'getQueryBuilder' and injected with 'injectQueryBuilder'. Also assigns a join reqister to a queryBilderProvider. +class HasQueryBuilder queryBuilderProvider joinRegister | queryBuilderProvider -> joinRegister where + getQueryBuilder :: queryBuilderProvider table -> QueryBuilder table + injectQueryBuilder :: QueryBuilder table -> queryBuilderProvider table + getQueryIndex :: queryBuilderProvider table -> Maybe ByteString + getQueryIndex _ = Nothing + {-# INLINABLE getQueryIndex #-} + +-- Wrapper for QueryBuilders resulting from joins. Associates a joinRegister type. +newtype JoinQueryBuilderWrapper joinRegister table = JoinQueryBuilderWrapper (QueryBuilder table) + +-- Wrapper for QueryBuilder that must not joins, e.g. queryUnion. +newtype NoJoinQueryBuilderWrapper table = NoJoinQueryBuilderWrapper (QueryBuilder table) + +-- Wrapper for QueryBuilders with indexed results. +newtype LabeledQueryBuilderWrapper foreignTable indexColumn indexValue table = LabeledQueryBuilderWrapper (QueryBuilder table) + +-- QueryBuilders have query builders and the join register is empty. +instance HasQueryBuilder QueryBuilder EmptyModelList where + getQueryBuilder = id + {-# INLINE getQueryBuilder #-} + injectQueryBuilder = id + {-# INLINE injectQueryBuilder #-} + +-- JoinQueryBuilderWrappers have query builders +instance HasQueryBuilder (JoinQueryBuilderWrapper joinRegister) joinRegister where + getQueryBuilder (JoinQueryBuilderWrapper queryBuilder) = queryBuilder + {-# INLINABLE getQueryBuilder #-} + injectQueryBuilder = JoinQueryBuilderWrapper + {-# INLINABLE injectQueryBuilder #-} + +-- NoJoinQueryBuilderWrapper have query builders and the join register does not allow any joins +instance HasQueryBuilder NoJoinQueryBuilderWrapper NoJoins where + getQueryBuilder (NoJoinQueryBuilderWrapper queryBuilder) = queryBuilder + {-# INLINABLE getQueryBuilder #-} + injectQueryBuilder = NoJoinQueryBuilderWrapper + {-# INLINABLE injectQueryBuilder #-} + +instance (KnownSymbol foreignTable, foreignModel ~ GetModelByTableName foreignTable , KnownSymbol indexColumn, HasField indexColumn foreignModel indexValue) => HasQueryBuilder (LabeledQueryBuilderWrapper foreignTable indexColumn indexValue) NoJoins where + getQueryBuilder (LabeledQueryBuilderWrapper queryBuilder) = queryBuilder + {-# INLINABLE getQueryBuilder #-} + injectQueryBuilder = LabeledQueryBuilderWrapper + {-# INLINABLE injectQueryBuilder #-} + getQueryIndex _ = Just $ symbolToByteString @foreignTable <> "." <> (Text.encodeUtf8 . fieldNameToColumnName) (symbolToText @indexColumn) + {-# INLINABLE getQueryIndex #-} + + +data QueryBuilder (table :: Symbol) = + NewQueryBuilder { selectFrom :: !ByteString, columns :: ![ByteString] } + | DistinctQueryBuilder { queryBuilder :: !(QueryBuilder table) } + | DistinctOnQueryBuilder { queryBuilder :: !(QueryBuilder table), distinctOnColumn :: !ByteString } + | FilterByQueryBuilder { queryBuilder :: !(QueryBuilder table), queryFilter :: !(ByteString, FilterOperator, Action), applyLeft :: !(Maybe ByteString), applyRight :: !(Maybe ByteString) } + | OrderByQueryBuilder { queryBuilder :: !(QueryBuilder table), queryOrderByClause :: !OrderByClause } + | LimitQueryBuilder { queryBuilder :: !(QueryBuilder table), queryLimit :: !Int } + | OffsetQueryBuilder { queryBuilder :: !(QueryBuilder table), queryOffset :: !Int } + | UnionQueryBuilder { firstQueryBuilder :: !(QueryBuilder table), secondQueryBuilder :: !(QueryBuilder table) } + | JoinQueryBuilder { queryBuilder :: !(QueryBuilder table), joinData :: Join} + deriving (Show, Eq) + +data Condition = VarCondition !ByteString !Action | OrCondition !Condition !Condition | AndCondition !Condition !Condition deriving (Show, Eq) + +-- | Display QueryBuilder's as their sql query inside HSX +instance KnownSymbol table => ToHtml (QueryBuilder table) where + toHtml queryBuilder = toHtml (toSQL queryBuilder) + +data Join = Join { table :: ByteString, tableJoinColumn :: ByteString, otherJoinColumn :: ByteString } + deriving (Show, Eq) + +data OrderByDirection = Asc | Desc deriving (Eq, Show, GHC.Generics.Generic, DeepSeq.NFData) +data SQLQuery = SQLQuery + { queryIndex :: !(Maybe ByteString) + , selectFrom :: !ByteString + , distinctClause :: !(Maybe ByteString) + , distinctOnClause :: !(Maybe ByteString) + , whereCondition :: !(Maybe Condition) + , joins :: ![Join] + , orderByClause :: ![OrderByClause] + , limitClause :: !(Maybe ByteString) + , offsetClause :: !(Maybe ByteString) + , columns :: ![ByteString] + } deriving (Show, Eq) + +-- | Needed for the 'Eq QueryBuilder' instance +deriving instance Eq Action + +-- | Need for the 'Eq QueryBuilder' instance +-- +-- You likely wonder: Why do we need the 'Eq SQLQuery' instance if this causes so much trouble? +-- This has to do with how has-many and belongs-to relations are models by the SchemaCompiler +-- +-- E.g. given a table users and a table posts. Each Post belongs to a user. The schema compiler will +-- add a field 'posts :: QueryBuilder "posts"' with the default value @query |> filterWhere (#userId, self.id)@ to all users by default. +-- +-- This is needed to support syntax like this: +-- +-- > fetch user.posts +-- +instance Eq Builder.Builder where + a == b = (Builder.toLazyByteString a) == (Builder.toLazyByteString b) + +instance SetField "queryIndex" SQLQuery (Maybe ByteString) where setField value sqlQuery = sqlQuery { queryIndex = value } +instance SetField "selectFrom" SQLQuery ByteString where setField value sqlQuery = sqlQuery { selectFrom = value } +instance SetField "distinctClause" SQLQuery (Maybe ByteString) where setField value sqlQuery = sqlQuery { distinctClause = value } +instance SetField "distinctOnClause" SQLQuery (Maybe ByteString) where setField value sqlQuery = sqlQuery { distinctOnClause = value } +instance SetField "whereCondition" SQLQuery (Maybe Condition) where setField value sqlQuery = sqlQuery { whereCondition = value } +instance SetField "orderByClause" SQLQuery [OrderByClause] where setField value sqlQuery = sqlQuery { orderByClause = value } +instance SetField "limitClause" SQLQuery (Maybe ByteString) where setField value sqlQuery = sqlQuery { limitClause = value } +instance SetField "offsetClause" SQLQuery (Maybe ByteString) where setField value sqlQuery = sqlQuery { offsetClause = value } + + + +-- | Represent's a @SELECT * FROM ..@ query. It's the starting point to build a query. +-- Used together with the other functions to compose a sql query. +-- +-- Example: +-- +-- > toSQL (query @User) +-- > -- Returns: ("SELECT id, firstname, lastname FROM users", []) +-- +-- Example: Fetching all users +-- +-- > allUsers <- query @User |> fetch +-- > -- Runs a 'SELECT * FROM users' query +-- +-- You can use it together with 'filterWhere': +-- +-- > activeUsers :: [User] <- +-- > query @User +-- > |> filterWhere (#active, True) +-- > |> fetch +query :: forall model table. (table ~ GetTableName model, Table model) => DefaultScope table => QueryBuilder table +query = (defaultScope @table) NewQueryBuilder { selectFrom = tableNameByteString @model, columns = columnNames @model } +{-# INLINE query #-} + +{-# INLINE buildQuery #-} +buildQuery :: forall table queryBuilderProvider joinRegister. (KnownSymbol table, HasQueryBuilder queryBuilderProvider joinRegister) => queryBuilderProvider table -> SQLQuery +buildQuery queryBuilderProvider = buildQueryHelper $ getQueryBuilder queryBuilderProvider + where + buildQueryHelper NewQueryBuilder { selectFrom, columns } = + SQLQuery + { queryIndex = getQueryIndex queryBuilderProvider + , selectFrom = selectFrom + , distinctClause = Nothing + , distinctOnClause = Nothing + , whereCondition = Nothing + , joins = [] + , orderByClause = [] + , limitClause = Nothing + , offsetClause = Nothing + , columns + } + buildQueryHelper DistinctQueryBuilder { queryBuilder } = queryBuilder + |> buildQueryHelper + |> setJust #distinctClause "DISTINCT" + buildQueryHelper DistinctOnQueryBuilder { queryBuilder, distinctOnColumn } = queryBuilder + |> buildQueryHelper + |> setJust #distinctOnClause ("DISTINCT ON (" <> distinctOnColumn <> ")") + buildQueryHelper FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, operator, value), applyLeft, applyRight } = + let + applyFn fn value = case fn of + Just fn -> fn <> "(" <> value <> ")" + Nothing -> value + + condition = VarCondition (applyFn applyLeft columnName <> " " <> compileOperator operator <> " " <> applyFn applyRight "?") value + in + queryBuilder + |> buildQueryHelper + |> modify #whereCondition \case + Just c -> Just (AndCondition c condition) + Nothing -> Just condition + buildQueryHelper OrderByQueryBuilder { queryBuilder, queryOrderByClause } = queryBuilder + |> buildQueryHelper + |> modify #orderByClause (\value -> value <> [queryOrderByClause] ) -- although adding to the end of a list is bad form, these lists are very short + buildQueryHelper LimitQueryBuilder { queryBuilder, queryLimit } = + queryBuilder + |> buildQueryHelper + |> setJust #limitClause ( + (Builder.byteString "LIMIT " <> Builder.intDec queryLimit) + |> Builder.toLazyByteString + |> LByteString.toStrict + ) + buildQueryHelper OffsetQueryBuilder { queryBuilder, queryOffset } = queryBuilder + |> buildQueryHelper + |> setJust #offsetClause ( + (Builder.byteString "OFFSET " <> Builder.intDec queryOffset) + |> Builder.toLazyByteString + |> LByteString.toStrict + ) + buildQueryHelper UnionQueryBuilder { firstQueryBuilder, secondQueryBuilder } = + let + firstQuery = buildQueryHelper firstQueryBuilder + secondQuery = buildQueryHelper secondQueryBuilder + isSimpleQuery query = null (orderByClause query) && isNothing (limitClause query) && isNothing (offsetClause query) && null (joins query) + isSimpleUnion = isSimpleQuery firstQuery && isSimpleQuery secondQuery + unionWhere = + case (whereCondition firstQuery, whereCondition secondQuery) of + (Nothing, whereCondition) -> whereCondition + (whereCondition, Nothing) -> whereCondition + (Just firstWhere, Just secondWhere) -> Just $ OrCondition firstWhere secondWhere + in + if isSimpleUnion then + firstQuery { whereCondition = unionWhere } + else + error "buildQuery: Union of complex queries not supported yet" + + buildQueryHelper JoinQueryBuilder { queryBuilder, joinData } = + let + firstQuery = buildQueryHelper queryBuilder + in firstQuery { joins = joinData:joins firstQuery } + +-- | Transforms a @query @@User |> ..@ expression into a SQL Query. Returns a tuple with the sql query template and it's placeholder values. +-- +-- __Example:__ Get the sql query that is represented by a QueryBuilder +-- +-- >>> let postsQuery = query @Post |> filterWhere (#public, True) +-- >>> toSQL postsQuery +-- ("SELECT posts.* FROM posts WHERE public = ?", [Plain "true"]) +toSQL :: (KnownSymbol table, HasQueryBuilder queryBuilderProvider joinRegister) => queryBuilderProvider table -> (ByteString, [Action]) +toSQL queryBuilderProvider = toSQL' (buildQuery queryBuilderProvider) +{-# INLINE toSQL #-} + +toSQL' :: SQLQuery -> (ByteString, [Action]) +toSQL' sqlQuery@SQLQuery { queryIndex, selectFrom, distinctClause, distinctOnClause, orderByClause, limitClause, offsetClause, columns } = + (DeepSeq.force theQuery, theParams) + where + !theQuery = + ByteString.intercalate " " $ + catMaybes + [ Just "SELECT" + , distinctClause + , distinctOnClause + , Just selectors + , Just "FROM" + , Just fromClause + , joinClause + , whereConditions' + , orderByClause' + , limitClause + , offsetClause + ] + + selectors :: ByteString + selectors = ByteString.intercalate ", " $ (catMaybes [queryIndex]) <> selectFromWithColumns + where + -- Generates a string like: `posts.id, posts.title, posts.body` + selectFromWithColumns :: [ByteString] + selectFromWithColumns = + columns + |> map (\column -> selectFrom <> "." <> column) + fromClause :: ByteString + fromClause = selectFrom + + !theParams = + case whereCondition sqlQuery of + Just condition -> compileConditionArgs condition + Nothing -> mempty + + toQualifiedName unqualifiedName = selectFrom <> "." <> unqualifiedName + + whereConditions' = case whereCondition sqlQuery of + Just condition -> Just $ "WHERE " <> compileConditionQuery condition + Nothing -> Nothing + + orderByClause' :: Maybe ByteString + orderByClause' = case orderByClause of + [] -> Nothing + xs -> Just ("ORDER BY " <> ByteString.intercalate "," ((map (\OrderByClause { orderByColumn, orderByDirection } -> orderByColumn <> (if orderByDirection == Desc then " DESC" else mempty)) xs))) + joinClause :: Maybe ByteString + joinClause = buildJoinClause $ reverse $ joins sqlQuery + buildJoinClause :: [Join] -> Maybe ByteString + buildJoinClause [] = Nothing + buildJoinClause (joinClause:joinClauses) = Just $ "INNER JOIN " <> table joinClause <> " ON " <> tableJoinColumn joinClause <> " = " <>table joinClause <> "." <> otherJoinColumn joinClause <> maybe "" (" " <>) (buildJoinClause joinClauses) + + +{-# INLINE toSQL' #-} + +{-# INLINE compileConditionQuery #-} +compileConditionQuery :: Condition -> ByteString +compileConditionQuery (VarCondition var _) = var +compileConditionQuery (OrCondition a b) = "(" <> compileConditionQuery a <> ") OR (" <> compileConditionQuery b <> ")" +compileConditionQuery (AndCondition a b) = "(" <> compileConditionQuery a <> ") AND (" <> compileConditionQuery b <> ")" + +{-# INLINE compileConditionArgs #-} +compileConditionArgs :: Condition -> [Action] +compileConditionArgs (VarCondition _ arg) = [arg] +compileConditionArgs (OrCondition a b) = compileConditionArgs a <> compileConditionArgs b +compileConditionArgs (AndCondition a b) = compileConditionArgs a <> compileConditionArgs b + +class FilterPrimaryKey table where + filterWhereId :: Id' table -> QueryBuilder table -> QueryBuilder table + +-- | Adds a simple @WHERE x = y@ condition to the query. +-- +-- __Example:__ Only show projects where @active@ is @True@. +-- +-- > activeProjects <- query @Project +-- > |> filterWhere (#active, True) +-- > |> fetch +-- > -- SELECT * FROM projects WHERE active = True +-- +-- __Example:__ Find book with title @Learn you a Haskell@. +-- +-- > book <- query @Book +-- > |> filterWhere (#title, "Learn you a Haskell") +-- > |> fetchOne +-- > -- SELECT * FROM books WHERE name = 'Learn you a Haskell' LIMIT 1 +-- +-- +-- __Example:__ Find active projects owned by the current user. +-- +-- > projects <- query @Project +-- > |> filterWhere (#active, True) +-- > |> filterWhere (#currentUserId, currentUserId) +-- > |> fetch +-- > -- SELECT * FROM projects WHERE active = true AND current_user_id = '..' +-- +-- +-- For dynamic conditions (e.g. involving @NOW()@), see 'filterWhereSql'. +-- +-- For @WHERE x IN (a, b, c)@ conditions, take a look at 'filterWhereIn' and 'filterWhereNotIn'. +-- +-- For @WHERE x LIKE a@ or @WHERE x ~ a@ conditions, see 'filterWhereLike' and 'filterWhereMatches' respectively. +-- For case-insensitive versions of these operators, see 'filterWhereILike' and 'filterWhereIMatches'. +-- +-- When your condition is too complex, use a raw sql query with 'IHP.ModelSupport.sqlQuery'. +filterWhere :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, EqOrIsOperator value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhere (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, toEqOrIsOperator value, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhere #-} + +-- | Like 'filterWhere', but takes a type argument specifying the table which holds the column that is to be compared. The column must have been joined before using 'innerJoin' or 'innerJoinThirdTable'. Example: +-- +-- __Example:__ get posts by user Tom. +-- +-- > tomPosts <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereJoinedTable @User (#name, "Tom" :: Text) +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name = 'Tom' +-- +filterWhereJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, EqOrIsOperator value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, toEqOrIsOperator value, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereJoinedTable #-} + +-- | Like 'filterWhere' but negates the condition. +-- +-- __Example:__ Only show projects created by other users. +-- +-- > activeProjects <- query @Project +-- > |> filterWhereNot (#userId, currentUserId) +-- > |> fetch +-- > -- SELECT * FROM projects WHERE user_id != '23d5ea33-b28e-4f0a-99b3-77a3564a2546' +-- +filterWhereNot :: forall name table model value. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, EqOrIsOperator value, model ~ GetModelByTableName table, Table model) => (Proxy name, value) -> QueryBuilder table -> QueryBuilder table +filterWhereNot (name, value) queryBuilder = FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, negateFilterOperator (toEqOrIsOperator value), toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) +{-# INLINE filterWhereNot #-} + +-- | Like 'filterWhereNotJoinedTable' but negates the condition. +-- +-- __Example:__ Only show projects not created by user Tom. +-- +-- > tomPosts <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereNotJoinedTable @User (#name, "Tom" :: Text) +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name = 'Tom' +-- +filterWhereNotJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, EqOrIsOperator value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereNotJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, negateFilterOperator (toEqOrIsOperator value), toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereNotJoinedTable #-} +-- | Adds a @WHERE x IN (y)@ condition to the query. +-- +-- __Example:__ Only show projects where @status@ is @Draft@ or @Active@. +-- +-- > visibleProjects <- query @Project +-- > |> filterWhereIn (#status, [Draft, Active]) +-- > |> fetch +-- > -- SELECT * FROM projects WHERE status IN ('draft', 'active') +-- +-- For negation use 'filterWhereNotIn' +-- +filterWhereIn :: forall name table model value queryBuilderProvider (joinRegister :: Type). (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, EqOrIsOperator value, Table model) => (Proxy name, [value]) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereIn (name, value) queryBuilderProvider = + case head nullValues of + Nothing -> injectQueryBuilder whereInQuery -- All values non null + Just nullValue -> + let + isNullValueExpr = FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, IsOp, toField nullValue), applyLeft = Nothing, applyRight = Nothing } + in + case head nonNullValues of + Just nonNullValue -> -- Some non null values, some null values + injectQueryBuilder $ UnionQueryBuilder + (injectQueryBuilder whereInQuery) + (injectQueryBuilder isNullValueExpr) + Nothing -> injectQueryBuilder isNullValueExpr -- All values null + where + -- Only NOT NULL values can be compares inside the IN expression, NULL values have to be compares using a manual appended IS expression + -- https://github.com/digitallyinduced/ihp/issues/906 + -- + (nonNullValues, nullValues) = value |> partition (\v -> toEqOrIsOperator v == EqOp) + + whereInQuery = FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, InOp, toField (In nonNullValues)), applyLeft = Nothing, applyRight = Nothing } + + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereIn #-} + +-- Like 'filterWhereIn', but case insensitive. +-- +-- __Example:__ Only show users where @email@ is @User1@example.com@ or @User2@example.com@. +-- +-- > users <- query @User +-- > |> filterWhereInCaseInsensitive (#email, ['User1@example.com', 'User2@example.com']) +-- > |> fetch +-- > -- SELECT * FROM users WHERE LOWER(email) IN ('user1@example.com', 'user2@example.com') +-- +filterWhereInCaseInsensitive :: forall name table model value queryBuilderProvider (joinRegister :: Type). ( KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, EqOrIsOperator value, Table model) => (Proxy name, [Text]) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereInCaseInsensitive (name, values) queryBuilderProvider = + case head nullValues of + Nothing -> injectQueryBuilder whereInQuery + Just nullValue -> + let + isNullValueExpr = FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, IsOp, toField nullValue), applyLeft = Nothing, applyRight = Nothing } + in + case head nonNullValues of + Just _ -> + injectQueryBuilder $ UnionQueryBuilder + (injectQueryBuilder whereInQuery) + (injectQueryBuilder isNullValueExpr) + Nothing -> injectQueryBuilder isNullValueExpr + where + (nonNullValues, nullValues) = values |> partition (\v -> toEqOrIsOperator v == EqOp) + + lowerValues = map toLower nonNullValues + + whereInQuery = FilterByQueryBuilder { queryBuilder, queryFilter = (lowerColumnName, InOp, toField (In lowerValues)), applyLeft = Nothing, applyRight = Nothing } + + lowerColumnName = "LOWER(" <> columnName <> ")" + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider + +{-# INLINE filterWhereInCaseInsensitive #-} + +-- | Like 'filterWhereIn', but takes a type argument specifying the table which holds the column that is compared. The table needs to have been joined before using 'innerJoin' or 'innerJoinThirdTable'. +-- +-- __Example:__ get posts by Tom and Tim. +-- +-- > tomOrTimPosts <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereInJoinedTable @User (#name, ["Tom","Tim"]) +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name IN ('Tom', 'Tim') +-- +filterWhereInJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, [value]) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereInJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, InOp, toField (In value)), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereInJoinedTable #-} + + +-- | Adds a @WHERE x NOT IN (y)@ condition to the query. +-- +-- __Example:__ Only show projects where @status@ is not @Archived@ +-- +-- > visibleProjects <- query @Project +-- > |> filterWhereNotIn (#status, [Archived]) +-- > |> fetch +-- > -- SELECT * FROM projects WHERE status NOT IN ('archived') +-- +-- The inclusive version of this function is called 'filterWhereIn'. +-- +filterWhereNotIn :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, EqOrIsOperator value) => (Proxy name, [value]) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereNotIn (_, []) queryBuilder = queryBuilder -- Handle empty case by ignoring query part: `WHERE x NOT IN ()` +filterWhereNotIn (name, value) queryBuilderProvider = + case head nullValues of + Nothing -> injectQueryBuilder whereNotInQuery -- All values non null + Just nullValue -> + case head nonNullValues of + Just nonNullValue -> injectQueryBuilder FilterByQueryBuilder { queryBuilder = whereNotInQuery, queryFilter = (columnName, IsNotOp, toField nullValue), applyLeft = Nothing, applyRight = Nothing } -- Some non null values, some null values + Nothing -> injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, IsNotOp, toField nullValue), applyLeft = Nothing, applyRight = Nothing } -- All values null + where + -- Only NOT NULL values can be compares inside the IN expression, NULL values have to be compares using a manual appended IS expression + -- https://github.com/digitallyinduced/ihp/issues/906 + -- + (nonNullValues, nullValues) = value |> partition (\v -> toEqOrIsOperator v == EqOp) + + whereNotInQuery = FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, NotInOp, toField (In nonNullValues)), applyLeft = Nothing, applyRight = Nothing } + + columnName = Text.encodeUtf8 (symbolToText @table) <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereNotIn #-} + +-- | Like 'filterWhereNotIn', but takes a type argument specifying the table which holds the column that is compared. The table needs to have been joined before using 'innerJoin' or 'innerJoinThirdTable'. +-- +-- __Example:__ get posts by users not named Tom or Tim. +-- +-- > notTomOrTimPosts <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereNotInJoinedTable @User (#name, ["Tom","Tim"]) +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name NOT IN ('Tom', 'Tim') +filterWhereNotInJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, [value]) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereNotInJoinedTable (_, []) queryBuilderProvider = queryBuilderProvider -- Handle empty case by ignoring query part: `WHERE x NOT IN ()` +filterWhereNotInJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, NotInOp, toField (In value)), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereNotInJoinedTable #-} + + +-- | Adds a @WHERE x LIKE y@ condition to the query. +-- +-- __Example:__ Find titles matching search term. +-- +-- > articles <- query @Article +-- > |> filterWhereLike (#title, "%" <> searchTerm <> "%") +-- > |> fetch +-- > -- SELECT * FROM articles WHERE title LIKE '%..%' +filterWhereLike :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereLike (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, LikeOp CaseSensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereLike #-} + +-- | Like 'filterWhereLik'e, but takes a type argument specifying the table which holds the column that is compared. The table needs to have been joined before using 'innerJoin' or 'innerJoinThirdTable'. +-- +-- __Example:__ Serach for Posts by users whose name contains "olaf" (case insensitive) +-- +-- > olafPosts <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereLikeJoinedTable @User (#name, "%Olaf%") +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name LIKE '%Olaf%' +filterWhereLikeJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol name, KnownSymbol table, table ~ GetTableName model, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereLikeJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, LikeOp CaseSensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereLikeJoinedTable #-} + + +-- | Adds a @WHERE x ILIKE y@ condition to the query. Case-insensitive version of 'filterWhereLike'. +-- +-- __Example:__ Find titles matching search term. +-- +-- > articles <- query @Article +-- > |> filterWhereILike (#title, "%" <> searchTerm <> "%") +-- > |> fetch +-- > -- SELECT * FROM articles WHERE title ILIKE '%..%' +filterWhereILike :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereILike (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, LikeOp CaseInsensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereILike #-} + +-- | Like 'filterWhereILike'; case-insensitive version of filterWhereLikeJoinedTable, takes a type argument specifying the table which holds the column that is compared. The table needs to have been joined before using 'innerJoin' or 'innerJoinThirdTable'. +-- +-- __Example:__ Serach for Posts by users whose name contains "olaf" (case insensitive) +-- +-- > olafPosts <- +-- > query @Post +-- |> innerJoin @User (#createdBy, #id) +-- |> filterWhereILikeJoinedTable @User (#name, "%Olaf%") +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.name ILIKE '%Olaf%' +filterWhereILikeJoinedTable :: forall model table name table' model' value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, model' ~ GetModelByTableName table', HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereILikeJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, LikeOp CaseInsensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereILikeJoinedTable #-} + + +-- | Adds a @WHERE x ~ y@ condition to the query. +-- +-- __Example:__ Find names with titles in front. +-- +-- > articles <- query @User +-- > |> filterWhereMatches (#name, "^(M(rs|r|iss)|Dr|Sir). ") +-- > |> fetch +-- > -- SELECT * FROM articles WHERE title ~ '^(M(rs|r|iss)|Dr|Sir). ' +filterWhereMatches :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereMatches (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, MatchesOp CaseSensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereMatches #-} + +-- | Adds a @WHERE x ~ y@ condition to the query, where the column x is held by a joined table. +-- +-- __Example:__ Find Posts by people with names with titles in front. +-- +-- > articles <- query @Post +-- > |> innerJoin @User (#createdBy, #id) +-- > |> filterWhereMatchesJoinedTable (#title, "^(M(rs|r|iss|s)|Dr|Sir). ") +-- > |> fetch +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.created_by = users.id WHERE users.title ~ '^(M(rs|r|iss|s)|Dr|Sir). ' + +filterWhereMatchesJoinedTable :: forall model table name value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereMatchesJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, MatchesOp CaseSensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereMatchesJoinedTable #-} + + +-- | Adds a @WHERE x ~* y@ condition to the query. Case-insensitive version of 'filterWhereMatches'. +filterWhereIMatches :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereIMatches (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, MatchesOp CaseInsensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereIMatches #-} + +-- | Case-insensitive version of 'filterWhereMatchesJoinedTable' +filterWhereIMatchesJoinedTable :: forall model table name value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table' -> queryBuilderProvider table' +filterWhereIMatchesJoinedTable (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, MatchesOp CaseInsensitive, toField value), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereIMatchesJoinedTable #-} + + +-- | Filter all rows by whether a field is in the past, determined by comparing 'NOW()' to the field's value. +-- +-- Opposite of 'filterWhereFuture' +-- +-- __Example:__ Fetch all posts scheduled for the past. +-- +-- > publicPosts <- query @Post +-- > |> filterWherePast #scheduledAt +-- > |> fetch +-- > -- SELECT * FROM posts WHERE scheduled_at <= NOW() +filterWherePast + :: ( KnownSymbol table + , KnownSymbol name + , ToField value + , HasField name (GetModelByTableName table) value + , HasQueryBuilder queryBuilderProvider joinRegister + , Table (GetModelByTableName table) + ) + => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +filterWherePast name = filterWhereSql (name, "<= NOW()") +{-# INLINE filterWherePast #-} + +-- | Filter all rows by whether a field is in the future, determined by comparing 'NOW()' to the field's value. +-- +-- Opposite of 'filterWherePast' +-- +-- __Example:__ Fetch all posts scheduled for the future. +-- +-- > hiddenPosts <- query @Post +-- > |> filterWhereFuture #scheduledAt +-- > |> fetch +-- > -- SELECT * FROM posts WHERE scheduled_at > NOW() +filterWhereFuture + :: ( KnownSymbol table + , KnownSymbol name + , ToField value + , HasField name (GetModelByTableName table) value + , HasQueryBuilder queryBuilderProvider joinRegister + , Table (GetModelByTableName table) + ) + => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereFuture name = filterWhereSql (name, "> NOW()") +{-# INLINE filterWhereFuture #-} + + +-- | Allows to add a custom raw sql where condition +-- +-- If your query cannot be represented with 'filterWhereSql', take a look at 'IHP.ModelSupport.sqlQuery'. +-- +-- __Example:__ Fetching all projects created in the last 24 hours. +-- +-- > latestProjects <- query @Project +-- > |> filterWhereSql (#startedAt, "< current_timestamp - interval '1 day'") +-- > |> fetch +-- > -- SELECT * FROM projects WHERE started_at < current_timestamp - interval '1 day' +-- +filterWhereSql :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, ByteString) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereSql (name, sqlCondition) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, SqlOp, Plain (Builder.byteString sqlCondition)), applyLeft = Nothing, applyRight = Nothing } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereSql #-} + +-- | Adds a @WHERE LOWER(x) = LOWER(y)@ condition to the query. +-- +-- __Example:__ Get a user by an email address, ignoring case +-- +-- > user <- query @User +-- > |> filterWhereCaseInsensitive (#email, "marc@digitallyinduced.com") +-- > |> fetchOne +-- > -- SELECT * FROM users WHERE LOWER(email) = 'marc@digitallyinduced.com' +-- +-- For high performance it's best to have an index for @LOWER(field)@ in your Schema.sql +-- +-- >>> CREATE UNIQUE INDEX users_email_index ON users ((LOWER(email))); +-- +filterWhereCaseInsensitive :: forall name table model value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, ToField value, HasField name model value, EqOrIsOperator value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => (Proxy name, value) -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereCaseInsensitive (name, value) queryBuilderProvider = injectQueryBuilder FilterByQueryBuilder { queryBuilder, queryFilter = (columnName, toEqOrIsOperator value, toField value), applyLeft = Just "LOWER", applyRight = Just "LOWER" } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE filterWhereCaseInsensitive #-} + + +filterWhereIdIn :: forall table model queryBuilderProvider (joinRegister :: Type). (KnownSymbol table, Table model, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister) => [Id model] -> queryBuilderProvider table -> queryBuilderProvider table +filterWhereIdIn values queryBuilderProvider = + -- We don't need to treat null values differently here, because primary keys imply not-null + let + pkConditions = map (primaryKeyConditionForId @model) values + + queryBuilder = getQueryBuilder queryBuilderProvider + + whereInQuery = FilterByQueryBuilder {queryBuilder, queryFilter = (primaryKeyConditionColumnSelector @model, InOp, toField (In pkConditions)), applyLeft = Nothing, applyRight = Nothing} + in + injectQueryBuilder whereInQuery +{-# INLINE filterWhereIdIn #-} + + +-- | Joins a table to an existing QueryBuilder (or something holding a QueryBuilder) on the specified columns. Example: +-- > query @Posts +-- > |> innerJoin @Users (#author, #id) +-- > -- SELECT users.* FROM users INNER JOIN posts ON users.id = posts.author ... +innerJoin :: forall model' table' name' value' model table name value queryBuilderProvider joinRegister. + ( + KnownSymbol name, + KnownSymbol table, + HasField name model value, + KnownSymbol name', + KnownSymbol table', + HasQueryBuilder queryBuilderProvider joinRegister, + ModelList joinRegister, + HasField name' model' value', + value ~ value', + model ~ GetModelByTableName table, + table' ~ GetTableName model' + ) => (Proxy name, Proxy name') -> queryBuilderProvider table -> JoinQueryBuilderWrapper (ConsModelList model' joinRegister) table +innerJoin (name, name') queryBuilderProvider = injectQueryBuilder $ JoinQueryBuilder (getQueryBuilder queryBuilderProvider) $ Join joinTableName leftJoinColumn rightJoinColumn + where + baseTableName = symbolToByteString @table + joinTableName = symbolToByteString @table' + leftJoinColumn = baseTableName <> "." <> (Text.encodeUtf8 . fieldNameToColumnName) (symbolToText @name) + rightJoinColumn = (Text.encodeUtf8 . fieldNameToColumnName) (symbolToText @name') +{-# INLINE innerJoin #-} + +-- | Index the values from a table with values of a field from a table joined by 'innerJoin' or 'innerJoinThirdTable'. Useful to get, e.g., the tags to a set of posts in such a way that the assignment of tags to posts is preserved. +-- +-- +-- __Example:__ Fetch a list of all comments, each paired with the id of the post it belongs to. +-- +-- > labeledTags <- +-- > query @Tag +-- > |> innerJoin @Tagging (#id, #tagId) +-- > |> innerJoinThirdTable @Post @Tagging (#id, #postId) +-- > |> labelResults @Post #id +-- > |> fetch +-- > -- SELECT posts.id, tags.* FROM comments INNER JOIN taggings ON tags.id = taggings.tagId INNER JOIN posts ON posts.id = taggings.postId +-- +-- labeledTags is then a list of type ['LabeledData' (Id' "posts") Tag] such that "LabeledData postId tag" is contained in that list if "tag" is a tag of the post with id postId. +-- +labelResults :: forall foreignModel baseModel foreignTable baseTable name value queryBuilderProvider joinRegister. + ( + KnownSymbol foreignTable, + KnownSymbol baseTable, + foreignTable ~ GetTableName foreignModel, + baseModel ~ GetModelByTableName baseTable, + HasField name foreignModel value, + HasQueryBuilder queryBuilderProvider joinRegister, + KnownSymbol name, + IsJoined foreignModel joinRegister + ) => Proxy name -> queryBuilderProvider baseTable -> LabeledQueryBuilderWrapper foreignTable name value baseTable +labelResults name queryBuilderProvider = LabeledQueryBuilderWrapper $ getQueryBuilder queryBuilderProvider + +-- | Joins a table on a column held by a previously joined table. Example: +-- > query @Posts +-- > |> innerJoin @Users (#author, #id) +-- > |> innerJoinThirdTable @City @Users (#id, #homeTown) +-- > -- SELECT posts.* FROM posts INNER JOIN users ON posts.author = users.id INNER JOIN cities ON user.home_town = cities.id +-- +innerJoinThirdTable :: forall model model' name name' value value' table table' baseTable baseModel queryBuilderProvider joinRegister. + ( + KnownSymbol name, + KnownSymbol table, + HasField name model value, + KnownSymbol name', + KnownSymbol table', + HasQueryBuilder queryBuilderProvider joinRegister, + ModelList joinRegister, + HasField name' model' value', + value ~ value', + table ~ GetTableName model, + table' ~ GetTableName model', + baseModel ~ GetModelByTableName baseTable + ) => (Proxy name, Proxy name') -> queryBuilderProvider baseTable -> JoinQueryBuilderWrapper (ConsModelList model joinRegister) baseTable +innerJoinThirdTable (name, name') queryBuilderProvider = injectQueryBuilder $ JoinQueryBuilder (getQueryBuilder queryBuilderProvider) $ Join joinTableName leftJoinColumn rightJoinColumn + where + baseTableName = symbolToByteString @table' + joinTableName = symbolToByteString @table + leftJoinColumn = baseTableName <> "." <> (Text.encodeUtf8 . fieldNameToColumnName) (symbolToText @name') + rightJoinColumn = (Text.encodeUtf8 . fieldNameToColumnName) (symbolToText @name) +{-# INLINE innerJoinThirdTable #-} + +-- | Adds an @ORDER BY .. ASC@ to your query. +-- +-- Use 'orderByDesc' for descending order. +-- +-- __Example:__ Fetch the 10 oldest books. +-- +-- > query @Book +-- > |> orderBy #createdAt -- > |> limit 10 +-- > |> fetch +-- > -- SELECT * FROM books LIMIT 10 ORDER BY created_at ASC +orderByAsc :: forall name model table value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +orderByAsc !name queryBuilderProvider = injectQueryBuilder OrderByQueryBuilder { queryBuilder, queryOrderByClause = OrderByClause { orderByColumn = columnName, orderByDirection = Asc } } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE orderByAsc #-} + +-- | Adds an @ORDER BY .. ASC@ on a joined table column to your query. +-- +-- Use 'orderByDescJoinedTable' for descending order. +-- +-- __Example:__ Order joined `User` records by `username` ascending. +-- +-- > query @Project +-- > |> innerJoin @User (#id, #projectId) +-- > |> orderByAscJoinedTable #username +-- > |> fetch +-- > -- SELECT ... FROM projects +-- > -- INNER JOIN users ON projects.id = users.project_id +-- > -- ORDER BY users.username ASC +orderByAscJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. ( KnownSymbol table, KnownSymbol name, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => Proxy name -> queryBuilderProvider table' -> queryBuilderProvider table' +orderByAscJoinedTable !name queryBuilderProvider = injectQueryBuilder OrderByQueryBuilder { queryBuilder = queryBuilder, queryOrderByClause = OrderByClause { orderByColumn = columnName, orderByDirection = Asc } } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE orderByAscJoinedTable #-} + +-- | Adds an @ORDER BY .. DESC@ to your query. +-- +-- Use 'orderBy' for ascending order. +-- +-- __Example:__ Fetch the 10 newest projects (ordered by creation time). +-- +-- > query @Project +-- > |> orderByDesc #createdAt +-- > |> limit 10 +-- > |> fetch +-- > -- SELECT * FROM projects LIMIT 10 ORDER BY created_at DESC +orderByDesc :: forall name model table value queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +orderByDesc !name queryBuilderProvider = injectQueryBuilder OrderByQueryBuilder { queryBuilder, queryOrderByClause = OrderByClause { orderByColumn = columnName, orderByDirection = Desc } } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE orderByDesc #-} + +-- | Adds an @ORDER BY .. DESC@ on a joined table column to your query. +-- +-- Use 'orderByAscJoinedTable' for ascending order. +-- +-- __Example:__ Order joined `User` records by `username` descending. +-- +-- > query @Project +-- > |> innerJoin @User (#id, #projectId) +-- > |> orderByDescJoinedTable #username +-- > |> fetch +-- > -- SELECT ... FROM projects +-- > -- INNER JOIN users ON projects.id = users.project_id +-- > -- ORDER BY users.username DESC +orderByDescJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. ( KnownSymbol table, KnownSymbol name, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => Proxy name -> queryBuilderProvider table' -> queryBuilderProvider table' +orderByDescJoinedTable !name queryBuilderProvider = injectQueryBuilder OrderByQueryBuilder { queryBuilder = queryBuilder, queryOrderByClause = OrderByClause { orderByColumn = columnName, orderByDirection = Desc } } + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE orderByDescJoinedTable #-} + +-- | Alias for 'orderByAsc' +orderBy :: (KnownSymbol table, KnownSymbol name, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +orderBy !name = orderByAsc name +{-# INLINE orderBy #-} + +-- | Alias for 'orderByAscJoinedTable' +orderByJoinedTable :: forall model name table value queryBuilderProvider joinRegister table'. (KnownSymbol table, KnownSymbol name, HasField name model value, table ~ GetTableName model, HasQueryBuilder queryBuilderProvider joinRegister, IsJoined model joinRegister, Table model) => Proxy name -> queryBuilderProvider table' -> queryBuilderProvider table' +orderByJoinedTable !name = orderByAscJoinedTable @model @name @table @value @queryBuilderProvider @joinRegister @table' name +{-# INLINE orderByJoinedTable #-} + +-- | Adds an @LIMIT ..@ to your query. +-- +-- +-- __Example:__ Fetch 10 posts +-- +-- > query @Post +-- > |> limit 10 +-- > |> fetch +-- > -- SELECT * FROM posts LIMIT 10 +limit :: (HasQueryBuilder queryBuilderProvider joinRegister) => Int -> queryBuilderProvider model -> queryBuilderProvider model +limit !queryLimit queryBuilderProvider = injectQueryBuilder LimitQueryBuilder { queryBuilder, queryLimit } + where + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE limit #-} + +-- | Adds an @OFFSET ..@ to your query. Most often used together with @LIMIT...@ +-- +-- +-- __Example:__ Fetch posts 10-20 +-- +-- > query @Post +-- > |> limit 10 +-- > |> offset 10 +-- > |> fetch +-- > -- SELECT * FROM posts LIMIT 10 OFFSET 10 +offset :: (HasQueryBuilder queryBuilderProvider joinRegister) => Int -> queryBuilderProvider model -> queryBuilderProvider model +offset !queryOffset queryBuilderProvider = injectQueryBuilder OffsetQueryBuilder { queryBuilder, queryOffset } + where + queryBuilder = getQueryBuilder queryBuilderProvider +{-# INLINE offset #-} + +-- | Merges the results of two query builders. +-- +-- Take a look at ‘queryOr' as well, as this might be a bit shorter. +-- +-- __Example:__ Return all pages owned by the user or owned by the users team. +-- +-- > let userPages = query @Page |> filterWhere (#ownerId, currentUserId) +-- > let teamPages = query @Page |> filterWhere (#teamId, currentTeamId) +-- > pages <- queryUnion userPages teamPages |> fetch +-- > -- (SELECT * FROM pages WHERE owner_id = '..') UNION (SELECT * FROM pages WHERE team_id = '..') +queryUnion :: (HasQueryBuilder queryBuilderProvider joinRegister, HasQueryBuilder r joinRegister') => queryBuilderProvider model -> r model -> NoJoinQueryBuilderWrapper model +queryUnion firstQueryBuilderProvider secondQueryBuilderProvider = NoJoinQueryBuilderWrapper (UnionQueryBuilder { firstQueryBuilder, secondQueryBuilder }) + where + firstQueryBuilder = getQueryBuilder firstQueryBuilderProvider + secondQueryBuilder = getQueryBuilder secondQueryBuilderProvider + + +{-# INLINE queryUnion #-} + +-- | Like 'queryUnion', but applied on all the elements on the list +-- +-- > action ProjectsAction = do +-- > let values :: [(ProjectType, Int)] = [(ProjectTypeOngoing, 3), (ProjectTypeNotStarted, 2)] +-- > +-- > valuePairToCondition :: (ProjectType, Int) -> QueryBuilder "projects" +-- > valuePairToCondition (projectType, participants) = +-- > query @Project +-- > |> filterWhere (#projectType, projectType) +-- > |> filterWhere (#participants, participants) +-- > +-- > theQuery = queryUnionList (map valuePairToCondition values) +-- > +-- > projects <- fetch theQuery +-- > render IndexView { .. } +queryUnionList :: forall table. (Table (GetModelByTableName table), KnownSymbol table, GetTableName (GetModelByTableName table) ~ table) => [QueryBuilder table] -> QueryBuilder table +queryUnionList [] = FilterByQueryBuilder { queryBuilder = query @(GetModelByTableName table) @table, queryFilter = ("id", NotEqOp, Plain "id"), applyLeft = Nothing, applyRight = Nothing } +queryUnionList (firstQueryBuilder:secondQueryBuilder:[]) = UnionQueryBuilder { firstQueryBuilder, secondQueryBuilder } +queryUnionList (firstQueryBuilder:rest) = UnionQueryBuilder { firstQueryBuilder, secondQueryBuilder = queryUnionList @table rest } + + +-- | Adds an @a OR b@ condition +-- +-- __Example:__ Return all pages owned by the user or public. +-- +-- > query @Page +-- > |> queryOr +-- > (filterWhere (#createdBy, currentUserId)) +-- > (filterWhere (#public, True)) +-- > |> fetch +-- > -- SELECT * FROM pages WHERE created_by = '..' OR public = True +queryOr :: (HasQueryBuilder queryBuilderProvider joinRegister, HasQueryBuilder queryBuilderProvider'' joinRegister'', HasQueryBuilder queryBuilderProvider''' joinRegister''') => (queryBuilderProvider model -> queryBuilderProvider''' model) -> (queryBuilderProvider model -> queryBuilderProvider'' model) -> queryBuilderProvider model -> queryBuilderProvider model +queryOr firstQuery secondQuery queryBuilder = injectQueryBuilder + (UnionQueryBuilder { + firstQueryBuilder = getQueryBuilder $ firstQuery queryBuilder, + secondQueryBuilder = getQueryBuilder $ secondQuery queryBuilder} + ) +{-# INLINE queryOr #-} + +-- | Adds a @DISTINCT@ to your query. +-- +-- Use 'distinct' to remove all duplicate rows from the result +-- +-- __Example:__ Fetch distinct books +-- +-- > query @Book +-- > |> distinct +-- > |> fetch +-- > -- SELECT DISTINCT * FROM books +distinct :: (HasQueryBuilder queryBuilderProvider joinRegister) => queryBuilderProvider table -> queryBuilderProvider table +distinct = injectQueryBuilder . DistinctQueryBuilder . getQueryBuilder +{-# INLINE distinct #-} + +-- | Adds an @DISTINCT ON .. to your query. +-- +-- Use 'distinctOn' to return a single row for each distinct value provided. +-- +-- __Example:__ Fetch one book for each categoryId field +-- +-- > query @Book +-- > |> distinctOn #categoryId +-- > |> fetch +-- > -- SELECT DISTINCT ON (category_id) * FROM books +distinctOn :: forall name model value table queryBuilderProvider joinRegister. (KnownSymbol table, KnownSymbol name, HasField name model value, model ~ GetModelByTableName table, HasQueryBuilder queryBuilderProvider joinRegister, Table model) => Proxy name -> queryBuilderProvider table -> queryBuilderProvider table +distinctOn !name queryBuilderProvider = injectQueryBuilder DistinctOnQueryBuilder { distinctOnColumn = columnName, queryBuilder = getQueryBuilder queryBuilderProvider} + where + columnName = tableNameByteString @model <> "." <> Text.encodeUtf8 (fieldNameToColumnName (symbolToText @name)) +{-# INLINE distinctOn #-} + + + +-- | Helper to deal with @some_field IS NULL@ and @some_field = 'some value'@ +class EqOrIsOperator value where toEqOrIsOperator :: value -> FilterOperator +instance {-# OVERLAPS #-} EqOrIsOperator (Maybe something) where toEqOrIsOperator Nothing = IsOp; toEqOrIsOperator (Just _) = EqOp +instance {-# OVERLAPPABLE #-} EqOrIsOperator otherwise where toEqOrIsOperator _ = EqOp diff --git a/IHP/Router/Types.hs b/IHP/Router/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/Router/Types.hs @@ -0,0 +1,39 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-| +Module: IHP.Router.Types +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.Router.Types where + +import IHP.Prelude +import Network.HTTP.Types.Method + +data TypedAutoRouteError + = BadType + { expectedType :: !ByteString + , value :: !(Maybe ByteString) + , field :: !ByteString + } + | TooFewArguments + | NotMatched + -- | Thrown when 'IHP.RouterSupport.parseUUIDArgument', 'IHP.RouterSupport.parseIntArgument', etc. get passed an invalid value + -- + -- Let's say we have a @ShowProjectAction { id :: Id Project }@. + -- + -- When opening @/ShowProject?projectId=ab55d579-80cd-4608-9a8f-c76dea6c2332@ everything is fine. + -- But when opening @/ShowProject?projectId=not-an-uuid@ this exception will be thrown. + | NoConstructorMatched + { expectedType :: !ByteString + , value :: !(Maybe ByteString) + , field :: !ByteString + } + deriving (Show, Exception) + +-- | Thrown e.g. a @CreateProjectAction@ is called from a GET request +-- +data UnexpectedMethodException + = UnexpectedMethodException + { allowedMethods :: [StdMethod] + , method :: StdMethod + } + deriving (Show, Exception) diff --git a/IHP/RouterPrelude.hs b/IHP/RouterPrelude.hs new file mode 100644 --- /dev/null +++ b/IHP/RouterPrelude.hs @@ -0,0 +1,21 @@ +{-| +Module: IHP.RouterPrelude +Description: Prelude used by modules like Web.Routes, Admin.Routes, etc. +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.RouterPrelude +( module IHP.RouterSupport +, module Data.Attoparsec.ByteString.Char8 +, module ClassyPrelude +, module Data.String.Conversions +, module IHP.ModelSupport +, module Network.HTTP.Types.Method +) +where + +import Data.Attoparsec.ByteString.Char8 +import IHP.RouterSupport +import ClassyPrelude hiding (index, delete, show, take, takeWhile, try) +import Data.String.Conversions (cs) +import IHP.ModelSupport (Id, Id' (..)) +import Network.HTTP.Types.Method (StdMethod (..)) diff --git a/IHP/RouterSupport.hs b/IHP/RouterSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/RouterSupport.hs @@ -0,0 +1,949 @@ +{-# LANGUAGE AllowAmbiguousTypes, UndecidableInstances, LambdaCase #-} +module IHP.RouterSupport ( +CanRoute (..) +, HasPath (..) +, AutoRoute (..) +, runAction +, get +, post +, startPage +, frontControllerToWAIApp +, withPrefix +, FrontController (..) +, defaultRouter +, parseRoute +, catchAll +, mountFrontController +, createAction +, updateAction +, urlTo +, parseUUID +, parseId +, parseIntegerId +, remainingText +, parseText +, webSocketApp +, webSocketAppWithCustomPath +, webSocketAppWithHTTPFallback +, onlyAllowMethods +, getMethod +, routeParam +) where + +import qualified Prelude +import ClassyPrelude hiding (index, delete, take) +import qualified IHP.ModelSupport as ModelSupport +import IHP.FrameworkConfig +import IHP.ApplicationContext hiding (frameworkConfig) +import Data.UUID +import Network.HTTP.Types.Method +import IHP.Controller.RequestContext +import Network.Wai +import IHP.ControllerSupport +import Data.Attoparsec.ByteString.Char8 (string, Parser, parseOnly, take, endOfInput, choice, takeTill, takeByteString) +import qualified Data.Attoparsec.ByteString.Char8 as Attoparsec +import GHC.TypeLits +import Data.Data +import qualified Control.Monad.State.Strict as State +import qualified Data.Text as Text +import Network.HTTP.Types.URI +import qualified Data.List as List +import Unsafe.Coerce +import IHP.HaskellSupport hiding (get) +import qualified Data.Typeable as Typeable +import qualified Data.ByteString.Char8 as ByteString +import qualified Data.Char as Char +import Control.Monad.Fail +import Data.String.Conversions (ConvertibleStrings (convertString), cs) +import qualified Text.Blaze.Html5 as Html5 +import qualified IHP.ErrorController as ErrorController +import qualified Control.Exception as Exception +import qualified Data.List.Split as List +import qualified Network.URI.Encode as URI +import qualified Data.Text.Encoding as Text +import Data.Dynamic +import IHP.Router.Types +import IHP.WebSocket (WSApp) +import qualified IHP.WebSocket as WS +import GHC.TypeLits as T +import IHP.Controller.Context +import IHP.Controller.Param +import qualified Data.TMap as TMap +import qualified IHP.ApplicationContext as ApplicationContext +import Data.Kind + +runAction' + :: forall application controller + . ( Controller controller + , ?applicationContext :: ApplicationContext + , InitControllerContext application + , ?application :: application + , Typeable application + , Typeable controller + ) + => controller -> Application +runAction' controller request respond = do + let ?modelContext = ApplicationContext.modelContext ?applicationContext + requestContext <- createRequestContext ?applicationContext request respond + let ?context = requestContext + let ?requestContext = requestContext + contextOrErrorResponse <- newContextForAction controller + case contextOrErrorResponse of + Left res -> res + Right context -> let ?context = context in runAction controller +{-# INLINABLE runAction' #-} + +class FrontController application where + controllers + :: (?applicationContext :: ApplicationContext, ?application :: application, ?context :: RequestContext) + => [Parser Application] + + router + :: (?applicationContext :: ApplicationContext, ?application :: application, ?context :: RequestContext) + => [Parser Application] -> Parser Application + router = defaultRouter + {-# INLINABLE router #-} + +defaultRouter + :: (?applicationContext :: ApplicationContext, ?application :: application, ?context :: RequestContext, FrontController application) + => [Parser Application] -> Parser Application +defaultRouter additionalControllers = do + let allControllers = controllers <> additionalControllers + applications <- choice $ map (\r -> r <* endOfInput) allControllers + pure applications +{-# INLINABLE defaultRouter #-} + +class HasPath controller where + -- | Returns the path to a given action + -- + -- >>> pathTo UsersAction + -- "/Users" + -- + -- >>> pathTo ShowUserAction { userId = "a32913dd-ef80-4f3e-9a91-7879e17b2ece" } + -- "/ShowUser?userId=a32913dd-ef80-4f3e-9a91-7879e17b2ece" + pathTo :: controller -> Text + +-- | Returns the url to a given action. +-- +-- Uses the baseUrl configured in @Config/Config.hs@. When no @baseUrl@ +-- is configured in development mode, it will automatically detect the +-- correct @baseUrl@ value. +-- +-- >>> urlTo UsersAction +-- "http://localhost:8000/Users" +-- +-- >>> urlTo ShowUserAction { userId = "a32913dd-ef80-4f3e-9a91-7879e17b2ece" } +-- "http://localhost:8000/ShowUser?userId=a32913dd-ef80-4f3e-9a91-7879e17b2ece" +urlTo :: (?context :: context, ConfigProvider context, HasPath action) => action -> Text +urlTo action = ?context.frameworkConfig.baseUrl <> pathTo action +{-# INLINE urlTo #-} + +class HasPath controller => CanRoute controller where + parseRoute' :: (?context :: RequestContext) => Parser controller + + +-- | Each of these is tried when trying to parse an argument to a controller constructor (i.e. in IHP, an action). +-- The type @d@ is an the type of the argument, and all we know about this type that its conforms to @Data@. +-- We cannot cast @d@ to some arbitrary type, since adding additional constraints to @d@ (such as Read) +-- will break the @fromConstrM@ function which actually constructs the action. +-- +-- The approach taken here is to make use of the type equality operator @:~:@ +-- to check and see if @d@ happens to be a certain type. If it is, +-- by matching on Just Refl, we are able to use @d@ as the type we matched it to. +-- +-- Please consult your doctor before engaging in Haskell type programming. +parseFuncs :: forall d idType. (Data d, Data idType) => (ByteString -> Maybe idType) -> [Maybe ByteString -> Either TypedAutoRouteError d] +parseFuncs parseIdType = [ + -- Try and parse @Int@ or @Maybe Int@ + \case + Just queryValue -> case eqT :: Maybe (d :~: Int) of + Just Refl -> readMay (cs queryValue :: String) + |> \case + Just int -> Right int + Nothing -> Left BadType { field = "", value = Just queryValue, expectedType = "Int" } + Nothing -> case eqT :: Maybe (d :~: Maybe Int) of + Just Refl -> Right $ readMay (cs queryValue :: String) + Nothing -> Left NotMatched + Nothing -> case eqT :: Maybe (d :~: Maybe Int) of + Just Refl -> Right Nothing + Nothing -> Left NotMatched, + + \case + Just queryValue -> case eqT :: Maybe (d :~: Integer) of + Just Refl -> readMay (cs queryValue :: String) + |> \case + Just int -> Right int + Nothing -> Left BadType { field = "", value = Just queryValue, expectedType = "Integer" } + Nothing -> case eqT :: Maybe (d :~: Maybe Integer) of + Just Refl -> Right $ readMay (cs queryValue :: String) + Nothing -> Left NotMatched + Nothing -> case eqT :: Maybe (d :~: Maybe Integer) of + Just Refl -> Right Nothing + Nothing -> Left NotMatched, + + -- Try and parse @Text@ or @Maybe Text@ + \case + Just queryValue -> case eqT :: Maybe (d :~: Text) of + Just Refl -> Right $ cs queryValue + Nothing -> case eqT :: Maybe (d :~: Maybe Text) of + Just Refl -> Right $ Just $ cs queryValue + Nothing -> Left NotMatched + Nothing -> case eqT :: Maybe (d :~: Maybe Text) of + Just Refl -> Right Nothing + Nothing -> Left NotMatched, + \case + Just queryValue -> case parseIdType queryValue of + Just idValue -> case eqT :: Maybe (d :~: idType) of + Just Refl -> Right idValue + Nothing -> Left NotMatched + Nothing -> Left NotMatched + Nothing -> Left NotMatched, + + -- Try and parse @[Text]@. If value is not present then default to empty list. + \queryValue -> case eqT :: Maybe (d :~: [Text]) of + Just Refl -> case queryValue of + Just queryValue -> Right $ Text.splitOn "," (cs queryValue) + Nothing -> Right [] + Nothing -> Left NotMatched, + + -- Try and parse @[Int]@. If value is not present then default to empty list. + \queryValue -> case eqT :: Maybe (d :~: [Int]) of + Just Refl -> case queryValue of + Just queryValue -> Text.splitOn "," (cs queryValue) + |> map readMay + |> catMaybes + |> Right + Nothing -> Right [] + Nothing -> Left NotMatched, + + \queryValue -> case eqT :: Maybe (d :~: [Integer]) of + Just Refl -> case queryValue of + Just queryValue -> Text.splitOn "," (cs queryValue) + |> map readMay + |> catMaybes + |> Right + Nothing -> Right [] + Nothing -> Left NotMatched, + + -- Try and parse a raw [UUID] + \queryValue -> case eqT :: Maybe (d :~: [UUID]) of + Just Refl -> case queryValue of + Just queryValue -> queryValue + |> cs + |> Text.splitOn "," + |> map (fromASCIIBytes . cs) + |> catMaybes + |> Right + Nothing -> Right [] + Nothing -> Left NotMatched, + + -- Try and parse a raw UUID + \queryValue -> case eqT :: Maybe (d :~: UUID) of + Just Refl -> case queryValue of + Just queryValue -> queryValue + |> fromASCIIBytes + |> \case + Just uuid -> uuid |> Right + Nothing -> Left BadType { field = "", value = Just queryValue, expectedType = "UUID" } + Nothing -> Left NotMatched + Nothing -> Left NotMatched, + + -- This has to be last parser in the list + -- + -- Try and parse a UUID wrapped with a Id. In IHP types these are wrapped in a newtype @Id@ such as @Id User@. + -- Since @Id@ is a newtype wrapping a UUID, it has the same data representation in GHC. + -- Therefore, we're able to safely cast it to its @Id@ type with @unsafeCoerce@. + -- + -- We cannot use 'eqT' here for checking the types, as it's wrapped inside the @Id@ type. We expect + -- that if it looks like a UUID, we can just treat it like an @Id@ type. For that to not overshadow other + -- parsers, we need to have this last. + \queryValue -> case queryValue of + Just queryValue -> queryValue + |> fromASCIIBytes + |> \case + Just uuid -> uuid |> unsafeCoerce |> Right + Nothing -> Left BadType { field = "", value = Just queryValue, expectedType = "UUID" } + Nothing -> Left NotMatched + ] +{-# INLINABLE parseFuncs #-} + +-- | As we fold over a constructor, we want the values parsed from the query string +-- to be in the same order as they are in the constructor. +-- This function uses the field labels from the constructor to sort the values from +-- the query string. As a consequence, constructors with basic record syntax will not work with auto types. +-- +-- @data MyController = MyAction Text Int@ +-- +-- does not work. Instead use, +-- +-- @data MyController = MyAction { textArg :: Text, intArg :: Int }@ +querySortedByFields :: Query -> Constr -> Query +querySortedByFields query constructor = constrFields constructor + |> map cs + |> map (\field -> (field, join $ List.lookup field query)) +{-# INLINABLE querySortedByFields #-} + +-- | Given a constructor and a parsed query string, attempt to construct a value of the constructor's type. +-- For example, given the controller +-- +-- @data MyController = MyAction { textArg :: Text, intArg :: Int }@ +-- +-- this function will receive a representation of the @MyAction@ constructor as well as some query string +-- @[("textArg", "some text"), ("intArg", "123")]@. +-- +-- By iterating through the query and attempting to match the type of each constructor argument +-- with some transformation of the query string, we attempt to call @MyAction@. +applyConstr :: (Data controller, Data idType) => (ByteString -> Maybe idType) -> Constr -> Query -> Either TypedAutoRouteError controller +applyConstr parseIdType constructor query = let + + -- | Given some query item (key, optional value), try to parse into the current expected type + -- by iterating through the available parse functions. + attemptToParseArg :: forall d. (Data d) => (ByteString, Maybe ByteString) -> [Maybe ByteString -> Either TypedAutoRouteError d] -> State.StateT Query (Either TypedAutoRouteError) d + attemptToParseArg queryParam@(queryName, queryValue) [] = State.lift (Left NoConstructorMatched + { field = queryName + , value = queryValue + , expectedType = (dataTypeOf (Prelude.undefined :: d)) |> dataTypeName |> cs + }) + attemptToParseArg queryParam@(k, v) (parseFunc:restFuncs) = case parseFunc v of + Right result -> pure result + -- BadType will be returned if, for example, a text is passed to a query parameter typed as int. + Left badType@BadType{} -> State.lift (Left badType { field = k }) + -- otherwise, safe to assume the match just failed, so recurse on the rest of the functions and try to find one that matches. + Left _ -> attemptToParseArg queryParam restFuncs + + -- | Attempt to parse the current expected type, and return its value. + -- For the example @MyController@ this is called twice by @fromConstrM@. + -- Once, it is called for @textArg@ where @d :: Text@. Then it is called + -- for @intArg@ with @d ::: Int@. With both of these values parsed from the query string, + -- the controller action is able to be created. + nextField :: forall d. (Data d) => State.StateT Query (Either TypedAutoRouteError) d + nextField = do + queryParams <- State.get + case queryParams of + [] -> State.lift (Left TooFewArguments) + (p@(key, value):rest) -> do + State.put rest + attemptToParseArg p (parseFuncs parseIdType) + + + in case State.runStateT (fromConstrM nextField constructor) (querySortedByFields query constructor) of + Right (x, []) -> pure x + Right (_) -> Left TooFewArguments + Left e -> Left e -- runtime type error +{-# INLINABLE applyConstr #-} + +class Data controller => AutoRoute controller where + autoRouteWithIdType :: (?context :: RequestContext, Data idType) => (ByteString -> Maybe idType) -> Parser controller + autoRouteWithIdType parseIdFunc = + let + allConstructors :: [Constr] + allConstructors = dataTypeConstrs (dataTypeOf (Prelude.undefined :: controller)) + + query :: Query + query = queryString ?context.request + + paramValues :: [ByteString] + paramValues = catMaybes $ map snd query + + parseAction :: Constr -> Parser controller + parseAction constr = let + prefix :: ByteString + prefix = ByteString.pack (actionPrefix @controller) + + actionName = ByteString.pack (showConstr constr) + + actionPath :: ByteString + actionPath = stripActionSuffixByteString actionName + + allowedMethods = allowedMethodsForAction @controller actionName + + checkRequestMethod action = do + method <- getMethod + unless (allowedMethods |> includes method) (Exception.throw UnexpectedMethodException { allowedMethods, method }) + pure action + + action = case applyConstr parseIdFunc constr query of + Right parsedAction -> pure parsedAction + Left e -> Exception.throw e + + in do + parsedAction <- string prefix >> (string actionPath <* endOfInput) *> action + checkRequestMethod parsedAction + + in choice (map parseAction allConstructors) + {-# INLINABLE autoRouteWithIdType #-} + + autoRoute :: (?context :: RequestContext) => Parser controller + autoRoute = autoRouteWithIdType (\_ -> Nothing :: Maybe Integer) + {-# INLINABLE autoRoute #-} + + -- | Specifies the allowed HTTP methods for a given action + -- + -- The default implementation does a smart guess based on the + -- usual naming conventions for controllers. + -- + -- __Example (for default implementation):__ + -- + -- >>> allowedMethodsForAction @ProjectsController "DeleteProjectAction" + -- [DELETE] + -- + -- >>> allowedMethodsForAction @ProjectsController "UpdateProjectAction" + -- [POST, PATCH] + -- + -- >>> allowedMethodsForAction @ProjectsController "CreateProjectAction" + -- [POST] + -- + -- >>> allowedMethodsForAction @ProjectsController "ShowProjectAction" + -- [GET, HEAD] + -- + -- >>> allowedMethodsForAction @ProjectsController "HelloAction" + -- [GET, POST, HEAD] + -- + allowedMethodsForAction :: ByteString -> [StdMethod] + allowedMethodsForAction actionName = + case actionName of + a | "Delete" `ByteString.isPrefixOf` a -> [DELETE] + a | "Update" `ByteString.isPrefixOf` a -> [POST, PATCH] + a | "Create" `ByteString.isPrefixOf` a -> [POST] + a | "Show" `ByteString.isPrefixOf` a -> [GET, HEAD] + _ -> [GET, POST, HEAD] + {-# INLINE allowedMethodsForAction #-} + +-- | Returns the url prefix for a controller. The prefix is based on the +-- module where the controller is defined. +-- +-- All controllers defined in the `Web/` directory don't have a prefix at all. +-- +-- E.g. controllers in the `Admin/` directory are prefixed with @/admin/@. +actionPrefix :: forall (controller :: Type). Typeable controller => String +actionPrefix = + case moduleName of + ('W':'e':'b':'.':_) -> "/" + ('I':'H':'P':'.':_) -> "/" + ("") -> "/" + moduleName -> "/" <> let prefix = getPrefix "" moduleName in map Char.toLower prefix <> "/" + where + moduleName :: String + moduleName = Typeable.typeOf (error "unreachable" :: controller) + |> Typeable.typeRepTyCon + |> Typeable.tyConModule + + -- E.g. getPrefix "" "Admin.User" == "Admin" + getPrefix prefix ('.':_) = prefix + getPrefix prefix (x:xs) = getPrefix (prefix <> [x]) xs + getPrefix prefix [] = prefix + +{-# INLINE actionPrefix #-} + +-- | Strips the "Action" at the end of action names +-- +-- >>> stripActionSuffixString "ShowUserAction" +-- "ShowUser" +-- +-- >>> stripActionSuffixString "UsersAction" +-- "UsersAction" +-- +-- >>> stripActionSuffixString "User" +-- "User" +stripActionSuffixString :: String -> String +stripActionSuffixString string = + case string of + "Action" -> "" + (x:xs) -> x : stripActionSuffixString xs + "" -> "" +{-# INLINE stripActionSuffixString #-} + +-- | Like 'stripActionSuffixString' but for ByteStrings +stripActionSuffixByteString :: ByteString -> ByteString +stripActionSuffixByteString actionName = fromMaybe actionName (ByteString.stripSuffix "Action" actionName) +{-# INLINE stripActionSuffixByteString #-} + + +-- | Returns the create action for a given controller. +-- Example: `createAction @UsersController == Just CreateUserAction` +createAction :: forall controller. AutoRoute controller => Maybe controller +createAction = fmap fromConstr createConstructor + where + createConstructor :: Maybe Constr + createConstructor = find isCreateConstructor allConstructors + + allConstructors :: [Constr] + allConstructors = dataTypeConstrs (dataTypeOf (Prelude.undefined :: controller)) + + isCreateConstructor :: Constr -> Bool + isCreateConstructor constructor = "Create" `isPrefixOf` showConstr constructor && ClassyPrelude.null (constrFields constructor) +{-# INLINE createAction #-} + +-- | Returns the update action when given a controller and id. +-- Example: `updateAction @UsersController == Just (\id -> UpdateUserAction id)` +updateAction :: forall controller id. AutoRoute controller => Maybe (id -> controller) +updateAction = + case updateConstructor of + Just constructor -> Just $ \id -> buildInstance constructor id + Nothing -> Nothing + where + updateConstructor :: Maybe Constr + updateConstructor = find isUpdateConstructor allConstructors + + buildInstance :: Constr -> id -> controller + buildInstance constructor id = State.evalState ((fromConstrM (do + i <- State.get + + State.modify (+1) + pure (unsafeCoerce id) + )) constructor) 0 + + allConstructors :: [Constr] + allConstructors = dataTypeConstrs (dataTypeOf (Prelude.undefined :: controller)) + + isUpdateConstructor :: Constr -> Bool + isUpdateConstructor constructor = "Update" `isPrefixOf` (showConstr constructor) && (length (constrFields constructor) == 1) +{-# INLINE updateAction #-} + +instance {-# OVERLAPPABLE #-} (AutoRoute controller, Controller controller) => CanRoute controller where + parseRoute' = autoRoute + {-# INLINABLE parseRoute' #-} + +-- | Instances of the @QueryParam@ type class can be represented in URLs as query parameters. +-- Currently this is only Int, Text, and both wrapped in List and Maybe. +-- IDs also are representable in a URL, but we are unable to match on polymorphic types using reflection, +-- so we fall back to the default "show" for these. +class Data a => QueryParam a where + showQueryParam :: a -> String + +instance QueryParam Text where + showQueryParam text = Text.unpack text + +instance QueryParam Int where + showQueryParam = show + +instance QueryParam Integer where + showQueryParam = show + +instance QueryParam UUID where + showQueryParam = show + +instance QueryParam a => QueryParam (Maybe a) where + showQueryParam (Just val) = showQueryParam val + showQueryParam Nothing = "" + +instance QueryParam a => QueryParam [a] where + showQueryParam = List.intercalate "," . map showQueryParam + +instance {-# OVERLAPPABLE #-} (Show controller, AutoRoute controller) => HasPath controller where + {-# INLINABLE pathTo #-} + pathTo !action = Text.pack (appPrefix <> actionName <> arguments) + where + appPrefix :: String + !appPrefix = actionPrefix @controller + + actionName :: String + !actionName = stripActionSuffixString $! showConstr constructor + + constructor = toConstr action + + stripQuotes ('"':rest) = List.init rest + stripQuotes otherwise = otherwise + + -- | The @gmapQ@ function allows us to iterate over each term in a constructor function and + -- build a list of results from performing some function on each term. + -- Here we send each term through @constrShow@, giving us our preferred representation for + -- use in URLs. + showTerms :: controller -> [Maybe String] + showTerms = gmapQ (constrShow typeShows) + + -- | @constrShow@ tries to convert each value @d@ into a String representation. + -- If one passes, return it immediately, otherwise try all the defined @typeShow@ functions. + constrShow :: Data d => [(d -> Maybe String)] -> d -> Maybe String + constrShow [] _ = Nothing + constrShow (f:fs) d = case f d of + Just str -> Just str + Nothing -> constrShow fs d + + -- | Try and match some value to all of the types we can represent in a URL. + -- Only type not contained in here is the "Id" type, since we cannot match + -- on polymorphic types. + typeShows :: forall d. Data d => [(d -> Maybe String)] + typeShows = [ + \val -> (eqT :: Maybe (d :~: Text)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: [Text])) + >>= \Refl -> Just (showQueryParam (val :: [Text])), + \val -> (eqT :: Maybe (d :~: Maybe Text)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: Int)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: [Int])) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: Maybe Int)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: Integer)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: [Integer])) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: Maybe Integer)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: UUID)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: Maybe UUID)) + >>= \Refl -> Just (showQueryParam val), + \val -> (eqT :: Maybe (d :~: [UUID])) + >>= \Refl -> Just (showQueryParam val) + ] + + arguments :: String + !arguments = show action -- `SomeRecord { a = b, c = d }` + |> List.filter (/= ' ') + |> List.break (== '{') + |> snd + |> List.drop 1 + |> List.break (== '}') + |> fst -- `a=b,c=d` + |> List.splitWhen (== ',') -- ["a=b", "c=d"] + |> map (\s -> let (key, value) = List.break (== '=') s in (key, List.drop 1 value)) + |> map (\(k ,v) -> (k, stripQuotes v)) -- "value" -> value + |> filter (\(k, v) -> (not . List.null) k && (not . List.null) v) + -- At this point we have a list of keys and values as represented by @show@. + -- For Lists and Maybe types, we want to represent these in a different way, + -- so we construct another list of values using type reflection and the QueryParam type class. + |> \(kvs :: [(String, String)]) -> zip (showTerms action) kvs + -- If an Id type was present in the action, it will be returned as Nothing by @showTerms@ + -- as we are not able to match on the type using reflection. + -- In this case we default back to the @show@ representation. + |> map (\(v1, (k, v2)) -> (k, fromMaybe v2 v1)) + |> map (\(k, v) -> if isEmpty v + then "" + else k <> "=" <> URI.encode v) + |> List.filter (not . isEmpty) + |> List.intercalate "&" + |> (\q -> if List.null q then q else '?':q) + +-- | Parses the HTTP Method from the request and returns it. +getMethod :: (?context :: RequestContext) => Parser StdMethod +getMethod = + case parseMethod ?context.request.requestMethod of + Left error -> fail (ByteString.unpack error) + Right method -> pure method +{-# INLINABLE getMethod #-} + +-- | Routes a given path to an action when requested via GET. +-- +-- __Example:__ +-- +-- > instance FrontController WebApplication where +-- > controllers = [ +-- > get "/my-custom-page" NewSessionAction +-- > ] +-- +-- The request @GET \/my-custom-page@ is now executing NewSessionAction +-- +-- Also see 'post'. +get :: (Controller action + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable action + ) => ByteString -> action -> Parser Application +get path action = do + method <- getMethod + case method of + GET -> do + string path + pure (runAction' action) + _ -> fail "Invalid method, expected GET" +{-# INLINABLE get #-} + +-- | Routes a given path to an action when requested via POST. +-- +-- __Example:__ +-- +-- > instance FrontController WebApplication where +-- > controllers = [ +-- > post "/do-something" DoSomethingAction +-- > ] +-- +-- The request @POST \/do-something@ is now executing DoSomethingAction +-- +-- Also see 'get'. +post :: (Controller action + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable action + ) => ByteString -> action -> Parser Application +post path action = do + method <- getMethod + case method of + POST -> do + string path + pure (runAction' action) + _ -> fail "Invalid method, expected POST" +{-# INLINABLE post #-} + +-- | Filter methods when writing a custom routing parser +-- +-- __Example:__ +-- +-- > instance CanRoute ApiController where +-- > parseRoute' = do +-- > string "/api/" +-- > let +-- > createRecordAction = do +-- > onlyAllowMethods [POST] +-- > +-- > table <- parseText +-- > endOfInput +-- > pure CreateRecordAction { table } +-- > +-- > updateRecordAction = do +-- > onlyAllowMethods [PATCH] +-- > +-- > table <- parseText +-- > string "/" +-- > id <- parseUUID +-- > pure UpdateRecordAction { table, id } +-- > +-- > createRecordAction <|> updateRecordAction +-- +onlyAllowMethods :: (?context :: RequestContext) => [StdMethod] -> Parser () +onlyAllowMethods methods = do + method <- getMethod + unless (method `elem` methods) (fail ("Invalid method, expected one of: " <> show methods)) +{-# INLINABLE onlyAllowMethods #-} + +-- | Routes to a given WebSocket app if the path matches the WebSocket app name +-- +-- __Example:__ +-- +-- > instance FrontController WebApplication where +-- > controllers = [ +-- > webSocketApp @AutoRefreshWSApp +-- > ] +-- +-- The request @\/AutoRefreshWSApp@ will call the AutoRefreshWSApp +-- +webSocketApp :: forall webSocketApp application. + ( WSApp webSocketApp + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable webSocketApp + ) => Parser Application +webSocketApp = webSocketAppWithCustomPath @webSocketApp typeName + where + typeName :: ByteString + typeName = Typeable.typeOf (error "unreachable" :: webSocketApp) + |> show + |> ByteString.pack +{-# INLINABLE webSocketApp #-} + +webSocketAppWithHTTPFallback :: forall webSocketApp application. + ( WSApp webSocketApp + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable webSocketApp + , Controller webSocketApp + ) => Parser Application +webSocketAppWithHTTPFallback = webSocketAppWithCustomPathAndHTTPFallback @webSocketApp @application typeName + where + typeName :: ByteString + typeName = Typeable.typeOf (error "unreachable" :: webSocketApp) + |> show + |> ByteString.pack +{-# INLINABLE webSocketAppWithHTTPFallback #-} + +-- | Routes to a given WebSocket app if the path matches +-- +-- __Example:__ +-- +-- > instance FrontController WebApplication where +-- > controllers = [ +-- > webSocketAppWithCustomPath @AutoRefreshWSApp "my-ws-app" +-- > ] +-- +-- The request @\/my-ws-app@ will call the AutoRefreshWSApp +-- +webSocketAppWithCustomPath :: forall webSocketApp application. + ( WSApp webSocketApp + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable webSocketApp + ) => ByteString -> Parser Application +webSocketAppWithCustomPath path = do + Attoparsec.char '/' + string path + pure (startWebSocketAppAndFailOnHTTP (WS.initialState @webSocketApp)) +{-# INLINABLE webSocketAppWithCustomPath #-} + +webSocketAppWithCustomPathAndHTTPFallback :: forall webSocketApp application. + ( WSApp webSocketApp + , InitControllerContext application + , ?application :: application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Typeable application + , Typeable webSocketApp + , Controller webSocketApp + ) => ByteString -> Parser Application +webSocketAppWithCustomPathAndHTTPFallback path = do + Attoparsec.char '/' + string path + let action = WS.initialState @webSocketApp + pure (startWebSocketApp action (runActionWithNewContext action)) +{-# INLINABLE webSocketAppWithCustomPathAndHTTPFallback #-} + + +-- | Defines the start page for a router (when @\/@ is requested). +startPage :: forall action application. (Controller action, InitControllerContext application, ?application::application, ?applicationContext::ApplicationContext, ?context::RequestContext, Typeable application, Typeable action) => action -> Parser Application +startPage action = get (ByteString.pack (actionPrefix @action)) action +{-# INLINABLE startPage #-} + +withPrefix prefix routes = string prefix >> choice (map (\r -> r <* endOfInput) routes) +{-# INLINABLE withPrefix #-} + +frontControllerToWAIApp :: forall app (autoRefreshApp :: Type). (?applicationContext :: ApplicationContext, FrontController app, WSApp autoRefreshApp, Typeable autoRefreshApp, InitControllerContext ()) => Middleware -> app -> Application -> Application +frontControllerToWAIApp middleware application notFoundAction request respond = do + let requestContext = RequestContext { request, respond, requestBody = FormBody { params = [], files = [] }, frameworkConfig = ?applicationContext.frameworkConfig } + + let ?context = requestContext + + let + path = request.rawPathInfo + handleException :: SomeException -> IO (Either String Application) + handleException exception = pure $ Right $ ErrorController.handleRouterException exception + + routes = let ?application = application in router [let ?application = () in webSocketApp @autoRefreshApp] + + routedAction :: Either String Application <- + (do + res <- evaluate $ parseOnly (routes <* endOfInput) path + case res of + Left s -> pure $ Left s + Right action -> do + pure $ Right action + ) + `Exception.catch` handleException + case routedAction of + Left message -> notFoundAction request respond + Right action -> (middleware action) request respond +{-# INLINABLE frontControllerToWAIApp #-} + +mountFrontController :: forall frontController. (?applicationContext :: ApplicationContext, ?context :: RequestContext, FrontController frontController) => frontController -> Parser Application +mountFrontController application = let ?application = application in router [] +{-# INLINABLE mountFrontController #-} + +parseRoute :: forall controller application. (?applicationContext :: ApplicationContext, ?context :: RequestContext, Controller controller, CanRoute controller, InitControllerContext application, ?application :: application, Typeable application, Typeable controller) => Parser Application +parseRoute = do + action <- parseRoute' @controller + pure $ runAction' @application action +{-# INLINABLE parseRoute #-} + +parseUUIDOrTextId :: ByteString -> Maybe Dynamic +parseUUIDOrTextId queryVal = queryVal + |> fromASCIIBytes + |> \case + Just uuid -> uuid |> toDyn |> Just + Nothing -> Nothing + +parseRouteWithId + :: forall controller application. + (?applicationContext :: ApplicationContext, + ?context :: RequestContext, + Controller controller, + CanRoute controller, + InitControllerContext application, + ?application :: application, + Typeable application, + Data controller) + => Parser Application +parseRouteWithId = do + action <- parseRoute' @controller + pure (runAction' @application action) + +catchAll :: forall action application. (?applicationContext :: ApplicationContext, ?context :: RequestContext, Controller action, InitControllerContext application, Typeable action, ?application :: application, Typeable application, Data action) => action -> Parser Application +catchAll action = do + string (ByteString.pack (actionPrefix @action)) + _ <- takeByteString + pure (runAction' @application action) +{-# INLINABLE catchAll #-} + +-- | This instances makes it possible to write @@ in HSX +instance {-# OVERLAPPABLE #-} (HasPath action) => ConvertibleStrings action Html5.AttributeValue where + convertString action = Html5.textValue (pathTo action) + {-# INLINE convertString #-} + +-- | Parses and returns an UUID +parseUUID :: Parser UUID +parseUUID = do + uuid <- take 36 + case fromASCIIBytes uuid of + Just theUUID -> pure theUUID + Nothing -> fail "not uuid" +{-# INLINABLE parseUUID #-} + +-- | Parses an UUID, afterwards wraps it in an Id +parseId :: ((ModelSupport.PrimaryKey table) ~ UUID) => Parser (ModelSupport.Id' table) +parseId = ModelSupport.Id <$> parseUUID +{-# INLINABLE parseId #-} + +-- | Returns all the remaining text until the end of the input +remainingText :: Parser Text +remainingText = Text.decodeUtf8 <$> takeByteString +{-# INLINABLE remainingText #-} + +-- | Parses until the next @/@ +parseText :: Parser Text +parseText = Text.decodeUtf8 <$> takeTill ('/' ==) +{-# INLINABLE parseText #-} + +parseIntegerId :: (Data idType) => ByteString -> Maybe idType +parseIntegerId queryVal = let + rawValue :: Maybe Integer = readMay (cs queryVal :: String) + in + rawValue >>= Just . unsafeCoerce + +-- | Parses and returns an integer +-- parseRational :: (Integral a) => Parser a +-- parseRational = Attoparsec.decimal + +-- | Parses a route query parameter +-- +-- __Example:__ +-- +-- > let showPost = do +-- > string "/post" +-- > let postId = routeParam "postId" +-- > pure ShowPostAction { .. } +-- Will parse the `postId` query in `/post?postId=09b545dd-9744-4ef8-87b8-8d227f4faa1e` +-- +routeParam :: (?context::RequestContext, ParamReader paramType) => ByteString -> paramType +routeParam paramName = + let requestContext = ?context + in + let ?context = FrozenControllerContext { requestContext = requestContext, customFields = mempty } + in param paramName + +-- | Display a better error when the user missed to pass an argument to an action. +-- +-- E.g. when you forgot to pass a projectId to the ShowProjectAction: +-- +-- > Show project +-- +-- The correct code would be this: +-- +-- > Show project +-- +-- See https://github.com/digitallyinduced/ihp/issues/840 +instance ((T.TypeError (T.Text "Looks like you forgot to pass a " :<>: (T.ShowType argument) :<>: T.Text " to this " :<>: (T.ShowType controller))), Data argument, Data controller, Data (argument -> controller)) => AutoRoute (argument -> controller) where diff --git a/IHP/SchemaMigration.hs b/IHP/SchemaMigration.hs new file mode 100644 --- /dev/null +++ b/IHP/SchemaMigration.hs @@ -0,0 +1,136 @@ +{-| +Module: IHP.SchemaMigration +Description: Managing Database Migrations +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.SchemaMigration where + +import IHP.Prelude +import qualified System.Directory as Directory +import qualified Data.Text as Text +import qualified Data.Text.IO as Text +import IHP.ModelSupport hiding (withTransaction) +import qualified Data.Char as Char +import IHP.Log.Types +import IHP.EnvVar + +data Migration = Migration + { revision :: Int + , migrationFile :: Text + } deriving (Show, Eq) + +data MigrateOptions = MigrateOptions + { minimumRevision :: !(Maybe Int) -- ^ When deploying a fresh install of an existing app that has existing migrations, it might be useful to ignore older migrations as they're already part of the existing schema + } + +-- | Migrates the database schema to the latest version +migrate :: (?modelContext :: ModelContext) => MigrateOptions -> IO () +migrate options = do + createSchemaMigrationsTable + + let minimumRevision = fromMaybe 0 options.minimumRevision + + openMigrations <- findOpenMigrations minimumRevision + forEach openMigrations runMigration + +-- | The sql statements contained in the migration file are executed. Then the revision is inserted into the @schema_migrations@ table. +-- +-- All queries are executed inside a database transaction to make sure that it can be restored when something goes wrong. +runMigration :: (?modelContext :: ModelContext) => Migration -> IO () +runMigration migration@Migration { revision, migrationFile } = do + -- | User can specify migrations directory as environment variable (defaults to /Application/Migrations/...) + migrationFilePath <- migrationPath migration + migrationSql <- Text.readFile (cs migrationFilePath) + + let fullSql = [trimming| + BEGIN; + ${migrationSql}; + INSERT INTO schema_migrations (revision) VALUES (?); + COMMIT; + |] + sqlExec (fromString . cs $ fullSql) [revision] + + pure () + +-- | Creates the @schema_migrations@ table if it doesn't exist yet +createSchemaMigrationsTable :: (?modelContext :: ModelContext) => IO () +createSchemaMigrationsTable = do + -- Hide this query from the log + withoutQueryLogging do + -- We don't use CREATE TABLE IF NOT EXISTS as adds a "NOTICE: relation schema_migrations already exists, skipping" + -- This sometimes confuses users as they don't know if the this is an error or not (it's not) + -- https://github.com/digitallyinduced/ihp/issues/818 + maybeTableName :: Maybe Text <- sqlQueryScalar "SELECT (to_regclass('schema_migrations')) :: text" () + let schemaMigrationTableExists = isJust maybeTableName + + unless schemaMigrationTableExists do + let ddl = "CREATE TABLE IF NOT EXISTS schema_migrations (revision BIGINT NOT NULL UNIQUE)" + _ <- sqlExec ddl () + pure () + +-- | Returns all migrations that haven't been executed yet. The result is sorted so that the oldest revision is first. +findOpenMigrations :: (?modelContext :: ModelContext) => Int -> IO [Migration] +findOpenMigrations !minimumRevision = do + let modelContext = ?modelContext + let ?modelContext = modelContext { logger = (modelContext.logger) { write = \_ -> pure ()} } + + migratedRevisions <- findMigratedRevisions + migrations <- findAllMigrations + migrations + |> filter (\Migration { revision } -> not (migratedRevisions |> includes revision)) + |> filter (\Migration { revision } -> revision > minimumRevision) + |> pure + +-- | Returns all migration revisions applied to the database schema +-- +-- >>> findMigratedRevisions +-- [ 1604850570, 1604850660 ] +-- +findMigratedRevisions :: (?modelContext :: ModelContext) => IO [Int] +findMigratedRevisions = map (\[revision] -> revision) <$> sqlQuery "SELECT revision FROM schema_migrations ORDER BY revision" () + +-- | Returns all migrations found in @Application/Migration@ +-- +-- >>> findAllMigrations +-- [ Migration { revision = 1604850570, migrationFile = "Application/Migration/1604850570-create-projects.sql" } ] +-- +-- The result is sorted so that the oldest revision is first. +findAllMigrations :: IO [Migration] +findAllMigrations = do + migrationDir <- detectMigrationDir + directoryFiles <- Directory.listDirectory (cs migrationDir) + directoryFiles + |> map cs + |> filter (\path -> ".sql" `isSuffixOf` path) + |> mapMaybe pathToMigration + |> sortBy (comparing revision) + |> pure + +-- | Given a path such as Application/Migrate/00-initial-migration.sql it returns a Migration +-- +-- Returns Nothing if the path is not following the usual migration file path convention. +-- +-- >>> pathToMigration "Application/Migration/1604850570-create-projects.sql" +-- Migration { revision = 1604850570, migrationFile = "Application/Migration/1604850570-create-projects.sql" } +-- +pathToMigration :: Text -> Maybe Migration +pathToMigration fileName = case revision of + Just revision -> Just Migration { migrationFile = fileName, revision } + Nothing -> Nothing + where + revision :: Maybe Int + revision = fileName + |> Text.split (not . Char.isDigit) + |> head + |> fmap textToInt + |> join + +migrationPath :: Migration -> IO Text +migrationPath Migration { migrationFile } = do + migrationDir <- detectMigrationDir + pure (migrationDir <> migrationFile) + +detectMigrationDir :: IO Text +detectMigrationDir = + envOrDefault "IHP_MIGRATION_DIR" "Application/Migration/" + diff --git a/IHP/ScriptSupport.hs b/IHP/ScriptSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/ScriptSupport.hs @@ -0,0 +1,27 @@ +{-| +Module: IHP.ScriptSupport +Description: Run scripts inside the framework context, but outside of the usual web request response lifecycle +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.ScriptSupport (runScript, Script, module IHP.FrameworkConfig) where + +import IHP.Prelude +import IHP.FrameworkConfig +import IHP.ModelSupport +import Control.Exception (finally) +import IHP.Log (Logger(cleanup)) +import Main.Utf8 (withUtf8) + +-- | A script is just an IO action which requires a database connection and framework config +type Script = (?modelContext :: ModelContext, ?context :: FrameworkConfig) => IO () + +-- | Initializes IHP and then runs the script inside the framework context +runScript :: ConfigBuilder -> Script -> IO () +runScript configBuilder taskMain = withUtf8 do + frameworkConfig@FrameworkConfig { environment, dbPoolIdleTime, dbPoolMaxConnections, databaseUrl, logger } <- buildFrameworkConfig configBuilder + modelContext <- createModelContext dbPoolIdleTime dbPoolMaxConnections databaseUrl logger + + let ?modelContext = modelContext + let ?context = frameworkConfig + taskMain `finally` cleanup logger +{-# INLINABLE runScript #-} diff --git a/IHP/Server.hs b/IHP/Server.hs new file mode 100644 --- /dev/null +++ b/IHP/Server.hs @@ -0,0 +1,173 @@ +{-# LANGUAGE IncoherentInstances #-} + +module IHP.Server (run, application) where +import IHP.Prelude +import qualified Network.Wai.Handler.Warp as Warp +import qualified Network.Wai.Handler.Warp.Systemd as Systemd +import Network.Wai +import Network.Wai.Middleware.MethodOverridePost (methodOverridePost) +import Network.Wai.Session (withSession) +import Network.Wai.Session.ClientSession (clientsessionStore) +import qualified Network.Wai.Middleware.HealthCheckEndpoint as HealthCheckEndpoint +import qualified Web.ClientSession as ClientSession +import IHP.Controller.Session (sessionVaultKey) +import IHP.ApplicationContext +import qualified IHP.Environment as Env +import qualified IHP.PGListener as PGListener + +import IHP.FrameworkConfig +import IHP.RouterSupport (frontControllerToWAIApp, FrontController) +import qualified IHP.AutoRefresh as AutoRefresh +import qualified IHP.AutoRefresh.Types as AutoRefresh +import qualified IHP.Job.Runner as Job +import qualified IHP.Job.Types as Job +import qualified Data.ByteString.Char8 as ByteString +import qualified Network.Wai.Middleware.Cors as Cors +import qualified Network.Wai.Middleware.Approot as Approot +import qualified Control.Exception as Exception + +import qualified System.Directory as Directory +import qualified GHC.IO.Encoding as IO +import qualified System.IO as IO + +import qualified Network.Wai.Application.Static as Static +import qualified WaiAppStatic.Types as Static +import qualified IHP.EnvVar as EnvVar +import qualified Network.Wreq as Wreq +import qualified Data.Function as Function + +import IHP.Controller.NotFound (handleNotFound) +import Paths_ihp (getDataFileName) + +run :: (FrontController RootApplication, Job.Worker RootApplication) => ConfigBuilder -> IO () +run configBuilder = do + -- We cannot use 'Main.Utf8.withUtf8' here, as this for some reason breaks live reloading + -- in the dev server. So we switch the file handles to utf8 manually + IO.setLocaleEncoding IO.utf8 + + withFrameworkConfig configBuilder \frameworkConfig -> do + modelContext <- IHP.FrameworkConfig.initModelContext frameworkConfig + + approotMiddleware <- Approot.envFallback + + withInitalizers frameworkConfig modelContext do + PGListener.withPGListener modelContext \pgListener -> do + autoRefreshServer <- newIORef (AutoRefresh.newAutoRefreshServer pgListener) + + let ?modelContext = modelContext + let ?applicationContext = ApplicationContext { modelContext = ?modelContext, autoRefreshServer, frameworkConfig, pgListener } + + sessionMiddleware <- initSessionMiddleware frameworkConfig + staticApp <- initStaticApp frameworkConfig + let corsMiddleware = initCorsMiddleware frameworkConfig + let requestLoggerMiddleware = frameworkConfig.requestLoggerMiddleware + let CustomMiddleware customMiddleware = frameworkConfig.customMiddleware + + useSystemd <- EnvVar.envOrDefault "IHP_SYSTEMD" False + + withBackgroundWorkers pgListener frameworkConfig + . runServer frameworkConfig useSystemd + . (if useSystemd then HealthCheckEndpoint.healthCheck else Function.id) + . customMiddleware + . corsMiddleware + . methodOverridePost + . sessionMiddleware + . approotMiddleware + $ application staticApp requestLoggerMiddleware + +{-# INLINABLE run #-} + +withBackgroundWorkers :: (Job.Worker RootApplication, ?modelContext :: ModelContext) => PGListener.PGListener -> FrameworkConfig -> IO () -> IO () +withBackgroundWorkers pgListener frameworkConfig app = do + let jobWorkers = Job.workers RootApplication + let isDevelopment = frameworkConfig.environment == Env.Development + if isDevelopment && not (isEmpty jobWorkers) + then race_ (Job.devServerMainLoop frameworkConfig pgListener jobWorkers) app + else app + +-- | Returns a WAI app that servers files stored in the app's @static/@ directory and IHP's own @static/@ directory +-- +-- HTTP Cache headers are set automatically. This includes Cache-Control, Last-Mofified and ETag +-- +-- The cache strategy works like this: +-- - In dev mode we disable the browser cache for the app's @static/@ directory to make sure that always the latest CSS and JS is used +-- - In production mode: We cache files forever. IHP's 'assetPath' helper will add a hash to files to cache bust when something has changed. +initStaticApp :: FrameworkConfig -> IO Application +initStaticApp frameworkConfig = do + frameworkStaticDir <- getDataFileName "static" + let + maxAge = case frameworkConfig.environment of + Env.Development -> Static.MaxAgeSeconds 0 + Env.Production -> Static.MaxAgeForever + + frameworkSettings = (Static.defaultWebAppSettings frameworkStaticDir) + { Static.ss404Handler = Just (frameworkConfig.requestLoggerMiddleware handleNotFound) + , Static.ssMaxAge = maxAge + } + appSettings = (Static.defaultWebAppSettings "static/") + { Static.ss404Handler = Just (Static.staticApp frameworkSettings) + , Static.ssMaxAge = maxAge + } + + pure (Static.staticApp appSettings) + +initSessionMiddleware :: FrameworkConfig -> IO Middleware +initSessionMiddleware FrameworkConfig { sessionCookie } = do + let path = "Config/client_session_key.aes" + + hasSessionSecretEnvVar <- EnvVar.hasEnvVar "IHP_SESSION_SECRET" + doesConfigDirectoryExist <- Directory.doesDirectoryExist "Config" + store <- clientsessionStore <$> + if hasSessionSecretEnvVar || not doesConfigDirectoryExist + then ClientSession.getKeyEnv "IHP_SESSION_SECRET" + else ClientSession.getKey path + let sessionMiddleware :: Middleware = withSession store "SESSION" sessionCookie sessionVaultKey + pure sessionMiddleware + +initCorsMiddleware :: FrameworkConfig -> Middleware +initCorsMiddleware FrameworkConfig { corsResourcePolicy } = case corsResourcePolicy of + Just corsResourcePolicy -> Cors.cors (const (Just corsResourcePolicy)) + Nothing -> id + +application :: (FrontController RootApplication, ?applicationContext :: ApplicationContext) => Application -> Middleware -> Application +application staticApp middleware request respond = do + frontControllerToWAIApp @RootApplication @AutoRefresh.AutoRefreshWSApp middleware RootApplication staticApp request respond +{-# INLINABLE application #-} + +runServer :: (?applicationContext :: ApplicationContext) => FrameworkConfig -> Bool -> Application -> IO () +runServer config@FrameworkConfig { environment = Env.Development, appPort } useSystemd = Warp.runSettings $ + Warp.defaultSettings + |> Warp.setBeforeMainLoop (do + ByteString.putStrLn "Server started" + IO.hFlush IO.stdout + ) + |> Warp.setPort appPort +runServer FrameworkConfig { environment = Env.Production, appPort, exceptionTracker } useSystemd = + let + warpSettings = Warp.defaultSettings + |> Warp.setPort appPort + |> Warp.setOnException exceptionTracker.onException + |> Warp.setGracefulShutdownTimeout (Just 6) + |> Warp.setFdCacheDuration (5 * 60) + |> Warp.setFileInfoCacheDuration (5 * 60) + heartbeatCheck = do + response <- Wreq.get ("http://127.0.0.1:" <> cs (show appPort) <> "/_healthz") + pure () + systemdSettings = Systemd.defaultSystemdSettings + |> Systemd.setRequireSocketActivation True + |> Systemd.setHeartbeatInterval (Just 30) + |> Systemd.setHeartbeatCheck heartbeatCheck + in + if useSystemd + then Systemd.runSystemdWarp systemdSettings warpSettings + else Warp.runSettings warpSettings + +withInitalizers :: FrameworkConfig -> ModelContext -> IO () -> IO () +withInitalizers frameworkConfig modelContext continue = do + let ?context = frameworkConfig + let ?modelContext = modelContext + withInitalizers' frameworkConfig.initializers + where + withInitalizers' :: (?context :: FrameworkConfig, ?modelContext :: ModelContext) => [Initializer] -> IO () + withInitalizers' (Initializer { onStartup } : rest) = withAsync onStartup (\async -> link async >> withInitalizers' rest) + withInitalizers' [] = continue diff --git a/IHP/Test/Mocking.hs b/IHP/Test/Mocking.hs new file mode 100644 --- /dev/null +++ b/IHP/Test/Mocking.hs @@ -0,0 +1,229 @@ +{-# LANGUAGE ConstraintKinds #-} +{-# LANGUAGE ImplicitParams #-} +{-# LANGUAGE QuantifiedConstraints #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE ExistentialQuantification #-} + +module IHP.Test.Mocking where + +import Data.ByteString.Builder (toLazyByteString) +import qualified Data.ByteString.Lazy as LBS +import qualified Data.Vault.Lazy as Vault +import qualified Network.HTTP.Types.Status as HTTP +import Network.Wai +import Network.Wai.Internal (ResponseReceived (..)) +import Network.Wai.Parse (Param (..)) + +import IHP.ApplicationContext (ApplicationContext (..)) +import qualified IHP.AutoRefresh.Types as AutoRefresh +import IHP.Controller.RequestContext (RequestBody (..), RequestContext (..)) +import IHP.ControllerSupport (InitControllerContext, Controller, runActionWithNewContext) +import IHP.FrameworkConfig (ConfigBuilder (..), FrameworkConfig (..)) +import qualified IHP.FrameworkConfig as FrameworkConfig +import IHP.ModelSupport (createModelContext, Id') +import IHP.Prelude +import IHP.Log.Types +import IHP.Job.Types +import Test.Hspec +import qualified Data.Text as Text +import qualified Network.Wai as Wai +import qualified IHP.LoginSupport.Helper.Controller as Session +import qualified Network.Wai.Session +import qualified Data.Serialize as Serialize +import qualified Control.Exception as Exception +import qualified IHP.PGListener as PGListener +import IHP.Controller.Session (sessionVaultKey) +import qualified Network.Wai.Middleware.Approot as Approot +import qualified Network.Wai.Test as WaiTest + +type ContextParameters application = (?applicationContext :: ApplicationContext, ?context :: RequestContext, ?modelContext :: ModelContext, ?application :: application, InitControllerContext application, ?mocking :: MockContext application) + +data MockContext application = InitControllerContext application => MockContext + { modelContext :: ModelContext + , requestContext :: RequestContext + , applicationContext :: ApplicationContext + , application :: application + } + +mockContextNoDatabase :: (InitControllerContext application) => application -> ConfigBuilder -> IO (MockContext application) +mockContextNoDatabase application configBuilder = do + frameworkConfig@(FrameworkConfig {dbPoolMaxConnections, dbPoolIdleTime, databaseUrl}) <- FrameworkConfig.buildFrameworkConfig configBuilder + let databaseConnection = undefined + logger <- newLogger def { level = Warn } -- don't log queries + modelContext <- createModelContext dbPoolIdleTime dbPoolMaxConnections databaseUrl logger + + let sessionVault = Vault.insert sessionVaultKey mempty Vault.empty + pgListener <- PGListener.init modelContext + autoRefreshServer <- newIORef (AutoRefresh.newAutoRefreshServer pgListener) + let applicationContext = ApplicationContext { modelContext = modelContext, autoRefreshServer, frameworkConfig, pgListener } + + let requestContext = RequestContext + { request = defaultRequest {vault = sessionVault} + , requestBody = FormBody [] [] + , respond = \resp -> pure ResponseReceived + , frameworkConfig = frameworkConfig } + + pure MockContext{..} + +-- | Run a IO action, setting implicit params based on supplied mock context +withContext :: (ContextParameters application => IO a) -> MockContext application -> IO a +withContext action mocking@MockContext{..} = let + ?modelContext = modelContext + ?context = requestContext + ?applicationContext = applicationContext + ?application = application + ?mocking = mocking + in do + action + +setupWithContext :: (ContextParameters application => IO a) -> MockContext application -> IO (MockContext application) +setupWithContext action context = withContext action context >> pure context + +-- | Runs a controller action in a mock environment +callAction :: forall application controller. (Controller controller, ContextParameters application, Typeable application, Typeable controller) => controller -> IO Response +callAction controller = callActionWithParams controller [] + +-- | Runs a controller action in a mock environment +-- +-- >>> callActionWithParams CreatePostAction [("title", "Hello World"), ("body", "lorem ipsum")| +-- Response { .. } +-- +callActionWithParams :: forall application controller. (Controller controller, ContextParameters application, Typeable application, Typeable controller) => controller -> [Param] -> IO Response +callActionWithParams controller params = do + approotMiddleware <- Approot.envFallback + let ihpWaiApp request respond = do + let requestContextWithOverridenRespond = ?context { respond, request, requestBody = FormBody params [] } + let ?context = requestContextWithOverridenRespond + runActionWithNewContext controller + + allMiddlewares app = approotMiddleware app + + simpleResponse <- WaiTest.withSession (allMiddlewares ihpWaiApp) do + WaiTest.request ?context.request + + pure $ Wai.responseLBS simpleResponse.simpleStatus simpleResponse.simpleHeaders simpleResponse.simpleBody + +-- | Run a Job in a mock environment +-- +-- __Example:__ +-- +-- Let's say you have a Job called @JobPost@ that you would like to process as part of a test. +-- +-- > let postJob <- fetch ... +-- > +-- > callJob postJob +-- +-- Note that 'callJob' doesn't set the Job status that is initially set 'IHP.Job.Types.JobStatusNotStarted', as that is +-- done by the Job queue (see 'IHP.Job.Queue.jobDidSucceed' for example). +-- +callJob :: forall application job. (ContextParameters application, Typeable application, Job job) => job -> IO () +callJob job = do + let frameworkConfig = ?context.frameworkConfig + let ?context = frameworkConfig + perform job + + +-- | mockAction has been renamed to callAction +mockAction :: forall application controller. (Controller controller, ContextParameters application, Typeable application, Typeable controller) => controller -> IO Response +mockAction = callAction + +-- | Get contents of response +mockActionResponse :: forall application controller. (Controller controller, ContextParameters application, Typeable application, Typeable controller) => controller -> IO LBS.ByteString +mockActionResponse = (responseBody =<<) . mockAction + +-- | Get HTTP status of the controller +mockActionStatus :: forall application controller. (Controller controller, ContextParameters application, Typeable application, Typeable controller) => controller -> IO HTTP.Status +mockActionStatus = fmap responseStatus . mockAction + +responseBody :: Response -> IO LBS.ByteString +responseBody res = + let (status,headers,body) = responseToStream res in + body $ \f -> do + content <- newIORef mempty + f (\chunk -> modifyIORef' content (<> chunk)) (return ()) + toLazyByteString <$> readIORef content + +-- | Asserts that the response body contains the given text. +responseBodyShouldContain :: Response -> Text -> IO () +responseBodyShouldContain response includedText = do + body :: Text <- cs <$> responseBody response + body `shouldSatisfy` (includedText `Text.isInfixOf`) + +-- | Asserts that the response body does not contain the given text. +responseBodyShouldNotContain :: Response -> Text -> IO () +responseBodyShouldNotContain response includedText = do + body :: Text <- cs <$> responseBody response + body `shouldNotSatisfy` (includedText `Text.isInfixOf`) + +-- | Asserts that the response status is equal to the given status. +responseStatusShouldBe :: Response -> HTTP.Status -> IO () +responseStatusShouldBe response status = responseStatus response `shouldBe` status + +-- | Set's the current user for the application +-- +-- Example: +-- +-- > user <- newRecord @User +-- > |> set #email "marc@digitallyinduced.com" +-- > |> createRecord +-- > +-- > response <- withUser user do +-- > callAction CreatePostAction +-- +-- In this example the 'currentUser' will refer to the newly +-- created user during the execution of CreatePostAction +-- +-- Internally this function overrides the session cookie passed to +-- the application. +-- +withUser :: forall user application userId result. + ( ?mocking :: MockContext application + , ?applicationContext :: ApplicationContext + , ?context :: RequestContext + , Serialize.Serialize userId + , HasField "id" user userId + , KnownSymbol (GetModelName user) + ) => user -> ((?context :: RequestContext) => IO result) -> IO result +withUser user callback = + let ?context = newContext + in callback + where + newContext = ?context { request = newRequest } + newRequest = request { Wai.vault = newVault } + + newSession :: Network.Wai.Session.Session IO ByteString ByteString + newSession = (lookupSession, insertSession) + + lookupSession key = if key == sessionKey + then pure (Just sessionValue) + else pure Nothing + + insertSession key value = pure () + + newVault = Vault.insert sessionVaultKey newSession (Wai.vault request) + RequestContext { request } = ?mocking.requestContext + + sessionValue = Serialize.encode (user.id) + sessionKey = cs (Session.sessionKey @user) + +-- | Turns a record id into a value that can be used with 'callActionWithParams' +-- +-- __Example:__ +-- +-- Let's say you have a test like this: +-- +-- > let postId = cs $ show $ post.id +-- > +-- > let params = [ ("postId", postId) ] +-- +-- You can replace the @cs $ show $@ with a cleaner 'idToParam': +-- +-- +-- > let postId = idToParam (libraryOpening.id) +-- > +-- > let params = [ ("postId", postId) ] +-- +idToParam :: forall table. (Show (Id' table)) => Id' table -> ByteString +idToParam id = id + |> tshow + |> cs diff --git a/IHP/ValidationSupport.hs b/IHP/ValidationSupport.hs new file mode 100644 --- /dev/null +++ b/IHP/ValidationSupport.hs @@ -0,0 +1,14 @@ +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE TypeFamilies #-} + +module IHP.ValidationSupport +( module IHP.ValidationSupport.Types +, module IHP.ValidationSupport.ValidateField +, module IHP.ValidationSupport.ValidateIsUnique +) +where + +import IHP.ValidationSupport.Types +import IHP.ValidationSupport.ValidateIsUnique +import IHP.ValidationSupport.ValidateField diff --git a/IHP/ValidationSupport/Types.hs b/IHP/ValidationSupport/Types.hs new file mode 100644 --- /dev/null +++ b/IHP/ValidationSupport/Types.hs @@ -0,0 +1,112 @@ +module IHP.ValidationSupport.Types where + +import IHP.Prelude +import qualified Data.Text as Text +import IHP.ModelSupport (Violation (..)) +import Text.Blaze.Html5 (Html) +import qualified Text.Blaze.Html.Renderer.Text as Blaze +import qualified Data.List as List + +data ValidatorResult + = Success + | Failure !Text + | FailureHtml !Text + deriving (Eq, Show) + +{-# INLINE isSuccess #-} +isSuccess Success = True +isSuccess _ = False + +{-# INLINE isFailure #-} +isFailure Failure {} = True +isFailure FailureHtml {} = True +isFailure _ = False + +{-# INLINE attachValidatorResult #-} +attachValidatorResult :: (KnownSymbol field, HasField "meta" model MetaBag, SetField "meta" model MetaBag) => Proxy field -> ValidatorResult -> model -> model +attachValidatorResult field Success record = record +attachValidatorResult field (Failure message) record = modify #meta prependAnnotation record + where + prependAnnotation :: MetaBag -> MetaBag + prependAnnotation = modify #annotations (\a -> annotation:a) + annotation = (Text.pack (symbolVal field), TextViolation message) +attachValidatorResult field (FailureHtml message) record = modify #meta prependAnnotation record + where + prependAnnotation :: MetaBag -> MetaBag + prependAnnotation = modify #annotations (\a -> annotation:a) + annotation = (Text.pack (symbolVal field), HtmlViolation message) + +-- | Adds a plain-text validation error to a record +-- +-- __Example:__ +-- +-- >>> record |> attachFailure #email "should be a valid email" +-- User { .., meta = MetaBag { .., annotations = [ ("email", TextViolation "should be a valid email") ] } } +-- +-- You can use this together with 'getValidationFailure' +-- +-- > user +-- > |> attachFailure #email "cannot be empty" +-- > |> getValidationFailure #email +-- > +-- > -- Returns: Just "cannot be empty" +-- +-- If your error message uses HTML code, use 'attachFailureHtml'. +attachFailure :: (KnownSymbol field, HasField "meta" model MetaBag, SetField "meta" model MetaBag) => Proxy field -> Text -> model -> model +attachFailure field !message = attachValidatorResult field (Failure message) +{-# INLINE attachFailure #-} + +-- | Adds a validation error to a record. The error message can contain HTML code. +-- +-- __Example:__ +-- +-- >>> record |> attachFailureHtml #email [hsx|should be a valid email. Check out the documentation|] +-- User { .., meta = MetaBag { .., annotations = [ ("email", HtmlViolation "should be a valid email. Check out the documentation") ] } } +-- +-- You can use this together with 'getValidationViolation' +-- +-- > user +-- > |> attachFailure #email "cannot be empty" +-- > |> getValidationViolation #email +-- > +-- > -- Returns: Just (HtmlViolation "should be a valid email. Check out the documentation") +attachFailureHtml :: (KnownSymbol field, HasField "meta" model MetaBag, SetField "meta" model MetaBag) => Proxy field -> Html -> model -> model +attachFailureHtml field !message = attachValidatorResult field (FailureHtml renderedHtml) + where + renderedHtml = message + |> Blaze.renderHtml + |> cs +{-# INLINE attachFailureHtml #-} + +-- | Returns the validation failure for a field or Nothing +-- +-- > user +-- > |> attachFailure #email "cannot be empty" +-- > |> getValidationFailure #email +-- > +-- > -- Returns: Just "cannot be empty" +-- +-- When 'attachFailureHtml' is used, this function will return HTML code: +-- +-- > user +-- > |> attachFailureHtml #url [hsx|Invalid value, check the documentation|] +-- > |> getValidationFailure #url +-- > +-- > -- Returns: Just "Invalid value, check the documentation" +-- +-- +-- If you need to special-case validation errors with HTML code, use 'getValidationViolation' +getValidationFailure :: (KnownSymbol field, HasField "meta" model MetaBag) => Proxy field -> model -> Maybe Text +getValidationFailure field model = (.message) <$> getValidationViolation field model +{-# INLINE getValidationFailure #-} + +-- | Similar to 'getValidationFailure', but exposes the information whether the error message contains HTML code +-- +-- >>> user |> getValidationViolation #email +-- Just (TextViolation "cannot be empty") +-- +getValidationViolation :: (KnownSymbol field, HasField "meta" model MetaBag) => Proxy field -> model -> Maybe Violation +getValidationViolation field model = + List.lookup fieldName model.meta.annotations + where + fieldName = Text.pack (symbolVal field) diff --git a/IHP/ValidationSupport/ValidateField.hs b/IHP/ValidationSupport/ValidateField.hs new file mode 100644 --- /dev/null +++ b/IHP/ValidationSupport/ValidateField.hs @@ -0,0 +1,506 @@ +{-| +Module: IHP.ValidationSupport.ValidateField +Description: Validation for records +Copyright: (c) digitally induced GmbH, 2020 + +Use 'validateField' and 'validateFieldIO' together with the validation functions to do simple validations. + +Also take a look at 'IHP.ValidationSupport.ValidateIsUnique.validateIsUnique' for e.g. checking that an email is unique. +-} +module IHP.ValidationSupport.ValidateField where + +import ClassyPrelude +import Data.Proxy +import IHP.ValidationSupport.Types +import GHC.TypeLits (KnownSymbol) +import GHC.Records +import IHP.ModelSupport +import IHP.HaskellSupport +import Text.Regex.TDFA +import Data.List ((!!)) +import Network.URI (parseURI, uriScheme) + +-- | A function taking some value and returning a 'ValidatorResult' +-- +-- >>> Validator Text +-- Text -> ValidatorResult +-- +-- >>> Validator Int +-- Int -> ValidatorResult +type Validator valueType = valueType -> ValidatorResult + +-- | Validates a record field using a given validator function. +-- +-- When the validation fails, the validation error is saved inside the @meta :: MetaBag@ field of the record. +-- You can retrieve a possible validation error using 'IHP.ValidationSupport.Types.getValidationFailure'. +-- +-- __Example:__ 'nonEmpty' validation for a record +-- +-- > let project :: Project = newRecord +-- > project +-- > |> validateField #name nonEmpty +-- > |> getValidationFailure #name -- Just "This field cannot be empty" +-- > +-- > +-- > project +-- > |> set #name "Hello World" +-- > |> validateField #name nonEmpty +-- > |> getValidationFailure #name -- Nothing +-- +-- +-- __Example:__ Using 'IHP.Controller.Param.ifValid' for branching +-- +-- > let project :: Project = newRecord +-- > +-- > project +-- > |> validateField #name nonEmpty +-- > |> ifValid \case +-- > Left project -> do +-- > putStrLn "Invalid project. Please try again" +-- > Right project -> do +-- > putStrLn "Project is valid. Saving to database." +-- > createRecord project +validateField :: forall field fieldValue model. ( + KnownSymbol field + , HasField field model fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + ) => Proxy field -> Validator fieldValue -> model -> model +validateField field validator model = attachValidatorResult field (validator (getField @field model)) model +{-# INLINE validateField #-} + + +-- | A function taking some value and returning a 'IO ValidatorResult' +-- +-- >>> ValidatorIO Text +-- Text -> IO ValidatorResult +-- +-- >>> ValidatorIO Int +-- Int -> IO ValidatorResult +type ValidatorIO value = value -> IO ValidatorResult + +-- | Validates a record field using a given validator function. +-- +-- The same as 'validateField', but works with IO and can e.g. access the database. +-- +-- When the validation fails, the validation error is saved inside the @meta :: MetaBag@ field of the record. +-- You can retrieve a possible validation error using 'IHP.ValidationSupport.Types.getValidationFailure'. +-- +validateFieldIO :: forall field model fieldValue. ( + ?modelContext :: ModelContext + , KnownSymbol field + , HasField field model fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + ) => Proxy field -> ValidatorIO fieldValue -> model -> IO model +validateFieldIO fieldProxy customValidation model = do + let value :: fieldValue = getField @field model + result <- customValidation value + pure (attachValidatorResult fieldProxy result model) +{-# INLINE validateFieldIO #-} + +-- | Validate a Maybe field. +-- +-- Validate a Maybe field using a given validator function. +-- >>> validateMaybe nonEmpty (Just "foo") +-- Success +-- +-- >>> validateMaybe nonEmpty (Just "") +-- Failure "This field cannot be empty" +-- +-- If the value is 'Nothing', the validation will succeed. +-- >>> validateMaybe nonEmpty Nothing +-- Success +-- +-- This function is useful when you want to validate a field that is optional. +-- >>> buildPost :: Post -> Post +-- >>> buildPost post = post +-- >>> |> validateField #title nonEmpty +-- >>> -- Assuming sourceUrl is optional. +-- >>> |> validateField #sourceUrl (validateMaybe nonEmpty) +validateMaybe :: (val -> ValidatorResult) -> Maybe val -> ValidatorResult +validateMaybe _ Nothing = Success +validateMaybe validator (Just value) = validator value +{-# INLINE validateMaybe #-} + +-- | Overrides the error message of a given validator function. +-- +-- >>> (nonEmpty |> withCustomErrorMessage "Custom error message") "" +-- Failure "Custom error message" +-- +-- +-- >>> (isEmail |> withCustomErrorMessage "We only accept valid email addresses") "not valid email" +-- Failure "We only accept valid email addresses" +withCustomErrorMessage :: Text -> (value -> ValidatorResult) -> value -> ValidatorResult +withCustomErrorMessage errorMessage validator value = + case validator value of + Failure _ -> Failure errorMessage + Success -> Success +{-# INLINABLE withCustomErrorMessage #-} + + +-- | Validates that value passes at least one of the given validators +-- +-- >>> "ihp@example.com" |> validateAny([isEmptyValue, isEmail]) +-- Success +-- +-- >>> "" |> validateAny([isEmptyValue, isEmail]) +-- Success +-- +-- >>> "no spam plz" |> validateAny([empty, isEmail]) +-- Failure "did not pass any validators" +validateAny :: [value -> ValidatorResult] -> value -> ValidatorResult +validateAny validators text = + case any isSuccess $ map ($ text) validators of + True -> Success + False -> Failure "did not pass any validators" +{-# INLINABLE validateAny #-} + + +-- | Validates that value passes all of the given validators +-- +-- In case of multiple failures, the first Failure is returned. +-- +-- >>> 2016 |> validateAll([isGreaterThan(1900), isLessThan(2020)]) +-- Success +-- +-- >>> 1899 |> validateAll([isGreaterThan(1900), isLessThan(2020)]) +-- Failure "has to be greater than 1900" +validateAll :: [value -> ValidatorResult] -> value -> ValidatorResult +validateAll validators text = + let results = map ($ text) validators + in case all isSuccess results of + True -> Success + False -> (filter isFailure results) !! 0 +{-# INLINABLE validateAll #-} + + +-- | Validates that value is not empty +-- +-- >>> nonEmpty "hello world" +-- Success +-- +-- >>> nonEmpty "" +-- Failure "This field cannot be empty" +-- +-- >>> nonEmpty (Just "hello") +-- Success +-- +-- >>> nonEmpty Nothing +-- Failure "This field cannot be empty" +nonEmpty :: IsEmpty value => value -> ValidatorResult +nonEmpty value | isEmpty value = Failure "This field cannot be empty" +nonEmpty _ = Success +{-# INLINABLE nonEmpty #-} + + +-- | Validates that value is empty +-- +-- >>> isEmptyValue "hello world" +-- Failure "This field must be empty" +-- +-- >>> ieEmptyValue "" +-- Success +-- +-- >>> isEmptyValue (Just "hello") +-- Failure "This field must be empty" +-- +-- >>> isEmptyValue Nothing +-- Success +isEmptyValue :: IsEmpty value => value -> ValidatorResult +isEmptyValue value | isEmpty value = Success +isEmptyValue _ = Failure "This field must be empty" +{-# INLINABLE isEmptyValue #-} + + +-- | Validates that value looks like a phone number +-- +-- Values needs to start with @\+@ and has to have atleast 5 characters +-- +-- >>> isPhoneNumber "1337" +-- Failure ".." +-- +-- >>> isPhoneNumber "+49123456789" +-- Success +isPhoneNumber :: Text -> ValidatorResult +isPhoneNumber text | "+" `isPrefixOf` text && length text > 5 = Success +isPhoneNumber text = Failure "is not a valid phone number (has to start with +, at least 5 characters)" +{-# INLINABLE isPhoneNumber #-} + + +-- | Validates that value is an email address +-- +-- The validation is not meant to be compliant with RFC 822. Its purpose is to +-- reject obviously invalid values without false-negatives. +-- +-- >>> isEmail "marc@digitallyinduced.com" +-- Success +-- +-- >>> isEmail "marc@secret.digitallyinduced.com" -- subdomains are fine +-- Success +-- +-- >>> isEmail "ॐ@मणिपद्मे.हूँ" +-- Success +-- +-- >>> isEmail "marc@localhost" -- Although discouraged by ICANN, dotless TLDs are legal. See https://www.icann.org/news/announcement-2013-08-30-en +-- Success +-- +-- >>> isEmail "loremipsum" +-- Failure "is not a valid email" +-- +-- >>> isEmail "A@b@c@domain.com" +-- Failure "is not a valid email" +isEmail :: Text -> ValidatorResult +isEmail text | text =~ ("^[^ @]+@[^ @_+]+\\.?[^ @_+-]+$" :: Text) = Success +isEmail text = Failure "is not a valid email" +{-# INLINABLE isEmail #-} + + +-- | Validates that value is between min and max +-- +-- >>> isInRange (0, 10) 5 +-- Success +-- +-- >>> isInRange (0, 10) 0 +-- Success +-- +-- >>> isInRange (0, 10) 1337 +-- Failure "has to be between 0 and 10" +-- +-- >>> let isHumanAge = isInRange (0, 100) +-- >>> isHumanAge 22 +-- Success +isInRange :: (Show value, Ord value) => (value, value) -> value -> ValidatorResult +isInRange (min, max) value | value >= min && value <= max = Success +isInRange (min, max) value = Failure ("has to be between " <> tshow min <> " and " <> tshow max) +{-# INLINABLE isInRange #-} + + +-- | Validates that value is less than a max value +-- +-- >>> isLessThan 10 5 +-- Success +-- +-- >>> isLessThan 10 20 +-- Failure "has to be less than 10" +isLessThan :: (Show value, Ord value) => value -> value -> ValidatorResult +isLessThan max value | value < max = Success +isLessThan max value = Failure ("has to be less than " <> tshow max) +{-# INLINABLE isLessThan #-} + + +-- | Validates that value is greater than a min value +-- +-- >>> isGreaterThan 10 20 +-- Success +-- +-- >>> isGreaterThan 10 5 +-- Failure "has to be greater than 10" +isGreaterThan :: (Show value, Ord value) => value -> value -> ValidatorResult +isGreaterThan min value | value > min = Success +isGreaterThan min value = Failure ("has to be greater than " <> tshow min) +{-# INLINABLE isGreaterThan #-} + + +-- | Validates that value is equal to another value +-- +-- >>> isEqual "foo" "foo" +-- Success +-- +-- >>> isEqual "foo" "bar" +-- Failure "has to be equal to \"foo\"" +isEqual :: (Show value, Eq value) => value -> value -> ValidatorResult +isEqual expected value | value == expected = Success +isEqual expected value = Failure ("has to be equal to " <> tshow expected) +{-# INLINABLE isEqual #-} + +-- | Validates that value has a max length +-- +-- >>> hasMaxLength 10 "IHP" +-- Success +-- +-- >>> hasMaxLength 2 "IHP" +-- Failure "is longer than 2 characters" +hasMaxLength :: Int -> Text -> ValidatorResult +hasMaxLength max text | length text <= max = Success +hasMaxLength max text = Failure ("is longer than " <> tshow max <> " characters") +{-# INLINABLE hasMaxLength #-} + + +-- | Validates that value has a min length +-- +-- >>> hasMinLength 2 "IHP" +-- Success +-- +-- >>> hasMinLength 10 "IHP" +-- Failure "is shorter than 10 characters" +hasMinLength :: Int -> Text -> ValidatorResult +hasMinLength min text | length text >= min = Success +hasMinLength min text = Failure ("is shorter than " <> tshow min <> " characters") +{-# INLINABLE hasMinLength #-} + + +-- | Validates that value is a hex-based rgb color string +-- +-- >>> isRgbHexColor "#ffffff" +-- Success +-- +-- >>> isRgbHexColor "#fff" +-- Success +-- +-- >>> isRgbHexColor "rgb(0, 0, 0)" +-- Failure "is not a valid rgb hex color" +isRgbHexColor :: Text -> ValidatorResult +isRgbHexColor text | text =~ ("^#([0-9a-f]{3}|[0-9a-f]{6})$" :: Text) = Success +isRgbHexColor text = Failure "is not a valid rgb hex color" +{-# INLINABLE isRgbHexColor #-} + + +-- | Validates that value is a hex-based rgb color string +-- +-- >>> isRgbaHexColor "#ffffffff" +-- Success +-- +-- >>> isRgbaHexColor "#ffff" +-- Success +-- +-- >>> isRgbaHexColor "rgb(0, 0, 0, 1)" +-- Failure "is not a valid rgba hex color" +isRgbaHexColor :: Text -> ValidatorResult +isRgbaHexColor text | text =~ ("^#([0-9a-f]{4}|[0-9a-f]{8})$" :: Text) = Success +isRgbaHexColor text = Failure "is not a valid rgba hex color" +{-# INLINABLE isRgbaHexColor #-} + + +-- | Validates that value is a hex-based rgb(a) color string +-- +-- >>> isHexColor "#ffffff" +-- Success +-- +-- >>> isHexColor "#ffffffff" +-- Success +-- +-- >>> isHexColor "rgb(0, 0, 0)" +-- Failure "is not a valid hex color" +isHexColor :: Text -> ValidatorResult +isHexColor = validateAny [isRgbHexColor, isRgbaHexColor] + |> withCustomErrorMessage "is not a valid hex color" +{-# INLINABLE isHexColor #-} + + +-- | Validates that value is a rgb() color string +-- +-- >>> isRgbColor "rgb(255, 0, 0)" +-- Success +-- +-- >>> isRgbColor "#f00" +-- Failure "is not a valid rgb() color" +isRgbColor :: Text -> ValidatorResult +isRgbColor text | text =~ ("^rgb\\( *([0-9]*\\.)?[0-9]+ *, *([0-9]*\\.)?[0-9]+ *, *([0-9]*\\.)?[0-9]+ *\\)$" :: Text) = Success +isRgbColor text = Failure "is not a valid rgb() color" +{-# INLINABLE isRgbColor #-} + + +-- | Validates that value is a rgba() color string +-- +-- >>> isRgbaColor "rgb(255, 0, 0, 1.0)" +-- Success +-- +-- >>> isRgbaColor "#f00f" +-- Failure "is not a valid rgba() color" +isRgbaColor :: Text -> ValidatorResult +isRgbaColor text | text =~ ("^rgba\\( *([0-9]*\\.)?[0-9]+ *, *([0-9]*\\.)?[0-9]+ *, *([0-9]*\\.)?[0-9]+ *, *([0-9]*\\.)?[0-9]+ *\\)$" :: Text) = Success +isRgbaColor text = Failure "is not a valid rgba() color" +{-# INLINABLE isRgbaColor #-} + + +-- | Validates that value is a hex-based or rgb(a) color string +-- +-- >>> isColor "#ffffff" +-- Success +-- +-- >>> isColor "rgba(255, 0, 0, 0.5)" +-- Success +-- +-- >>> isColor "rgb(0, 0, 0)" +-- Failure "is not a valid color" +isColor :: Text -> ValidatorResult +isColor = validateAny [isRgbHexColor, isRgbaHexColor, isRgbColor, isRgbaColor] + |> withCustomErrorMessage "is not a valid color" +{-# INLINABLE isColor #-} + + +-- | Validates string starts with @http://@ or @https://@ +-- +-- >>> isUrl "https://digitallyinduced.com" +-- Success +-- +-- >>> isUrl "digitallyinduced.com" +-- Failure "URL must start with http:// or https://" +isUrl :: Text -> ValidatorResult +isUrl url = + case parseURI (unpack url) of + Just uri -> + if uriScheme uri `elem` ["http:", "https:"] + then Success + else Failure "URL must start with http:// or https://" + Nothing -> Failure "Invalid URL" +{-# INLINABLE isUrl #-} + + +isInList :: (Eq value, Show value) => [value] -> value -> ValidatorResult +isInList list value | list |> includes value = Success +isInList list value = Failure ("is not allowed. It needs to be one of the following: " <> (tshow list)) +{-# INLINABLE isInList #-} + +-- | Validates that value is True +-- +-- >>> isTrue True +-- Success +-- +-- >>> isTrue False +-- Failure "This field cannot be false" +isTrue :: Bool -> ValidatorResult +isTrue value = if value then Success else Failure "This field cannot be false" +{-# INLINABLE isTrue #-} + + +-- | Validates that value is False +-- +-- >>> isFalse False +-- Success +-- +-- >>> isFalse True +-- Failure "This field cannot be true" +isFalse :: Bool -> ValidatorResult +isFalse value = if not value then Success else Failure "This field cannot be true" +{-# INLINABLE isFalse #-} + + +-- | Validates that value is matched by the regular expression +-- +-- >>> matchesRegex "^[0-9]{4}$" "2016" +-- Success +-- +-- >>> matchesRegex "^[0-9]{4}$" "16" +-- Failure "This field does not match the regular expression \"^[0-9]{4}$\"" +-- +-- >>> matchesRegex "[0-9]{4}" "xx2016xx" +-- Success -- regex is missing ^ and $ +-- +matchesRegex :: Text -> Text -> ValidatorResult +matchesRegex regex text = if text =~ regex then Success else Failure $ "This field does not match the regular expression \"" <> regex <> "\"" +{-# INLINABLE matchesRegex #-} + + +-- | Validates that value is a valid slug +-- +-- >>> isSlug "i-am-a-slug" +-- Success +-- +-- >>> isSlug "I-AM-A-Slug (Copy)" +-- Failure "is not a valid slug (consisting of only letters, numbers, underscores or hyphens)" +isSlug :: Text -> ValidatorResult +isSlug text | text =~ ("^[a-zA-Z0-9_-]+$" :: Text) = Success +isSlug text = Failure "is not a valid slug (consisting of only letters, numbers, underscores or hyphens)" +{-# INLINABLE isSlug #-} diff --git a/IHP/ValidationSupport/ValidateIsUnique.hs b/IHP/ValidationSupport/ValidateIsUnique.hs new file mode 100644 --- /dev/null +++ b/IHP/ValidationSupport/ValidateIsUnique.hs @@ -0,0 +1,165 @@ +module IHP.ValidationSupport.ValidateIsUnique +( validateIsUnique +, validateIsUniqueCaseInsensitive +, withCustomErrorMessageIO +) where + +import IHP.Prelude +import Database.PostgreSQL.Simple.ToField +import IHP.ModelSupport +import IHP.ValidationSupport.Types +import IHP.QueryBuilder +import IHP.Fetch + +-- | Validates that e.g. an email (or another field) is unique across all users before inserting. +-- +-- This validator reads the given field name (e.g. email) from the record, and runs a database query +-- to check that there is no other record using the same field value (e.g. email value). +-- +-- __Example:__ Validate that an email is unique +-- +-- > action CreateUserAction = do +-- > let user = newRecord @User +-- > user +-- > |> fill @'["email"] +-- > |> validateIsUnique #email +-- > >>= ifValid \case +-- > Left user -> render NewView { .. } +-- > Right user -> do +-- > createRecord user +-- > redirectTo UsersAction +validateIsUnique :: forall field model savedModel fieldValue modelId savedModelId. ( + savedModel ~ NormalizeModel model + , ?modelContext :: ModelContext + , FromRow savedModel + , KnownSymbol field + , HasField field model fieldValue + , HasField field savedModel fieldValue + , KnownSymbol (GetTableName savedModel) + , ToField fieldValue + , EqOrIsOperator fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + , HasField "id" savedModel savedModelId + , HasField "id" model modelId + , savedModelId ~ modelId + , Eq modelId + , GetModelByTableName (GetTableName savedModel) ~ savedModel + , Table savedModel + ) => Proxy field -> model -> IO model +validateIsUnique fieldProxy model = validateIsUniqueCaseAware fieldProxy model True +{-# INLINE validateIsUnique #-} + + +-- | Case insensitive version of 'validateIsUnique'. +-- +-- Uses a comparison like @LOWER(field) = LOWER(value)@ internally, so it's best to have an index for @LOWER(field)@ in your Schema.sql +-- +-- >>> CREATE UNIQUE INDEX users_email_index ON users ((LOWER(email))); +-- +-- __Example:__ Validate that an email is unique, ignoring case +-- +-- > action CreateUserAction = do +-- > let user = newRecord @User +-- > user +-- > |> fill @'["email"] +-- > |> validateIsUniqueCaseInsensitive #email +-- > >>= ifValid \case +-- > Left user -> render NewView { .. } +-- > Right user -> do +-- > createRecord user +-- > redirectTo UsersAction +validateIsUniqueCaseInsensitive :: forall field model savedModel fieldValue modelId savedModelId. ( + savedModel ~ NormalizeModel model + , ?modelContext :: ModelContext + , FromRow savedModel + , KnownSymbol field + , HasField field model fieldValue + , HasField field savedModel fieldValue + , KnownSymbol (GetTableName savedModel) + , ToField fieldValue + , EqOrIsOperator fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + , HasField "id" savedModel savedModelId + , HasField "id" model modelId + , savedModelId ~ modelId + , Eq modelId + , GetModelByTableName (GetTableName savedModel) ~ savedModel + , Table savedModel + ) => Proxy field -> model -> IO model +validateIsUniqueCaseInsensitive fieldProxy model = validateIsUniqueCaseAware fieldProxy model False +{-# INLINE validateIsUniqueCaseInsensitive #-} + +-- | Internal helper for 'validateIsUnique' and 'validateIsUniqueCaseInsensitive' +validateIsUniqueCaseAware :: forall field model savedModel fieldValue modelId savedModelId. ( + savedModel ~ NormalizeModel model + , ?modelContext :: ModelContext + , FromRow savedModel + , KnownSymbol field + , HasField field model fieldValue + , HasField field savedModel fieldValue + , KnownSymbol (GetTableName savedModel) + , ToField fieldValue + , EqOrIsOperator fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + , HasField "id" savedModel savedModelId + , HasField "id" model modelId + , savedModelId ~ modelId + , Eq modelId + , GetModelByTableName (GetTableName savedModel) ~ savedModel + , Table savedModel + ) => Proxy field -> model -> Bool -> IO model +validateIsUniqueCaseAware fieldProxy model caseSensitive = do + let value = getField @field model + result <- query @savedModel + |> (if caseSensitive + then filterWhere (fieldProxy, value) + else filterWhereCaseInsensitive (fieldProxy, value) + ) + |> fetchOneOrNothing + case result of + Just value | not $ model.id == value.id -> pure (attachValidatorResult fieldProxy (Failure "This is already in use") model) + _ -> pure (attachValidatorResult fieldProxy Success model) +{-# INLINE validateIsUniqueCaseAware #-} + +-- | Overrides the error message of a given IO validator function. +-- +-- __Example:__ Validate that an email is unique with a custom error message +-- +-- > action CreateUserAction = do +-- > let user = newRecord @User +-- > user +-- > |> fill @'["email"] +-- > |> withCustomErrorMessageIO "Email Has Already Been Used" validateIsUnique #email +-- > >>= ifValid \case +-- > Left user -> render NewView { .. } +-- > Right user -> do +-- > createRecord user +-- > redirectTo UsersAction +withCustomErrorMessageIO :: forall field model savedModel fieldValue modelId savedModelId. ( + savedModel ~ NormalizeModel model + , ?modelContext :: ModelContext + , FromRow savedModel + , KnownSymbol field + , HasField field model fieldValue + , HasField field savedModel fieldValue + , KnownSymbol (GetTableName savedModel) + , ToField fieldValue + , EqOrIsOperator fieldValue + , HasField "meta" model MetaBag + , SetField "meta" model MetaBag + , HasField "id" savedModel savedModelId + , HasField "id" model modelId + , savedModelId ~ modelId + , Eq modelId + , GetModelByTableName (GetTableName savedModel) ~ savedModel + ) => Text -> (Proxy field -> model -> IO model) -> Proxy field -> model -> IO model +withCustomErrorMessageIO message validator field model = do + validator field model >>= (\model -> + let maybeFailure = getValidationFailure field model + in case maybeFailure of + Just _ -> pure $ attachFailure field message model + Nothing -> pure model) +{-# INLINABLE withCustomErrorMessageIO #-} diff --git a/IHP/View/CSSFramework.hs b/IHP/View/CSSFramework.hs new file mode 100644 --- /dev/null +++ b/IHP/View/CSSFramework.hs @@ -0,0 +1,1130 @@ +{-| +Module: IHP.View.CSSFramework +Description: Adds support for bootstrap, tailwind, etc. to IHP +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.View.CSSFramework where + +import IHP.Prelude +import IHP.FlashMessages.Types +import qualified Text.Blaze.Html5 as Blaze +import IHP.HSX.QQ (hsx) +import IHP.HSX.ToHtml () +import IHP.View.Types +import IHP.View.Classes + +import IHP.ModelSupport +import IHP.Breadcrumb.Types +import IHP.Pagination.Helpers +import IHP.Pagination.Types + + +-- | Provides an unstyled CSSFramework +-- +-- This way we can later add more properties to the CSSFramework without having to update all the CSS Frameworks manually +instance Default CSSFramework where + def = CSSFramework + { + styledFlashMessage = \cssFramework -> \case + SuccessFlashMessage message -> [hsx|
    {message}
    |] + ErrorFlashMessage message -> [hsx|
    {message}
    |] + , styledFlashMessages + , styledFormField + , styledTextFormField + , styledTextareaFormField + , styledCheckboxFormField + , styledSelectFormField + , styledRadioFormField + , styledFormGroup + , styledSubmitButton + , styledSubmitButtonClass + , styledFormFieldHelp + , styledInputClass + , styledInputInvalidClass + , styledFormGroupClass + , styledValidationResult + , styledValidationResultClass + , styledPagination + , styledPaginationPageLink + , styledPaginationDotDot + , styledPaginationItemsPerPageSelector + , styledPaginationLinkPrevious + , styledPaginationLinkNext + , styledBreadcrumb + , styledBreadcrumbItem + } + where + styledFlashMessages cssFramework flashMessages = forEach flashMessages (cssFramework.styledFlashMessage cssFramework) + + styledFormField :: CSSFramework -> FormField -> Blaze.Html + styledFormField cssFramework@CSSFramework {styledValidationResult, styledTextFormField, styledCheckboxFormField, styledSelectFormField, styledRadioFormField, styledTextareaFormField} formField = + formGroup renderInner + where + renderInner = case formField.fieldType of + TextInput -> styledTextFormField cssFramework "text" formField validationResult + NumberInput -> styledTextFormField cssFramework "number" formField validationResult + UrlInput -> styledTextFormField cssFramework "url" formField validationResult + PasswordInput -> styledTextFormField cssFramework "password" formField validationResult + ColorInput -> styledTextFormField cssFramework "color" formField validationResult + EmailInput -> styledTextFormField cssFramework "email" formField validationResult + DateInput -> styledTextFormField cssFramework "date" formField validationResult + DateTimeInput -> styledTextFormField cssFramework "datetime-local" formField validationResult + CheckboxInput -> styledCheckboxFormField cssFramework formField validationResult + HiddenInput -> styledTextFormField cssFramework "hidden" formField validationResult + TextareaInput -> styledTextareaFormField cssFramework formField validationResult + SelectInput {} -> styledSelectFormField cssFramework formField validationResult + RadioInput {} -> styledRadioFormField cssFramework formField validationResult + FileInput -> styledTextFormField cssFramework "file" formField validationResult + + validationResult :: Blaze.Html + validationResult = unless formField.disableValidationResult (styledValidationResult cssFramework formField) + + -- | Wraps the input inside a @
    ...
    @ (unless @disableGroup = True@) + formGroup :: Blaze.Html -> Blaze.Html + formGroup renderInner = case formField of + FormField { disableGroup = True } -> renderInner + FormField { fieldInputId } -> styledFormGroup cssFramework fieldInputId renderInner + + + styledFormGroup :: CSSFramework -> Text -> Blaze.Html -> Blaze.Html + styledFormGroup cssFramework@CSSFramework {styledFormGroupClass} fieldInputId renderInner = + [hsx|
    fieldInputId}>{renderInner}
    |] + + styledCheckboxFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledCheckboxFormField cssFramework@CSSFramework {styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = do + [hsx|
    {element}
    |] + where + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + -- If the checkbox is checked off, the browser will not send the parameter as part of the form. + -- This will then make it impossible to set a field to False using a checkbox. + -- For that we add the "hidden" input type. + theInput = [hsx| + + + + |] + + + element = if disableLabel + then [hsx|
    + {theInput} + {validationResult} + {helpText} +
    + |] + else [hsx| + {theInput} + + + {validationResult} + {helpText} + |] + + styledTextFormField :: CSSFramework -> Text -> FormField -> Blaze.Html -> Blaze.Html + styledTextFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} inputType formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + -- If there's no value, then we want to hide the "value" attribute. + maybeValue = if fieldValue == "" then Nothing else Just fieldValue + + styledSelectFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledSelectFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, placeholder, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + label = unless disableLabel [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + isValueSelected = any (\(_, optionValue) -> optionValue == fieldValue) (options fieldType) + + -- Get a single option. + getOption (optionLabel, optionValue) = [hsx| + + |] + + + styledRadioFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledRadioFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, placeholder, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = + [hsx| + {label} +
    + {forEach (options fieldType) (getRadio)} +
    + + {validationResult} + {helpText} + |] + where + label = unless disableLabel [hsx||] + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + -- Get a single radio button. + getRadio (optionLabel, optionValue) = [hsx| +
    + + {label} +
    + |] + where + optionId = fieldInputId <> "_" <> optionValue + label = unless disableLabel [hsx||] + + styledTextareaFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledTextareaFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + {validationResult}{helpText}|] + where + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + styledValidationResult :: CSSFramework -> FormField -> Blaze.Html + styledValidationResult cssFramework formField@FormField { validatorResult = Just violation } = + let + className :: Text = cssFramework.styledValidationResultClass + message = case violation of + TextViolation text -> [hsx|{text}|] + HtmlViolation html -> Blaze.preEscapedToHtml html + in + [hsx|
    {message}
    |] + styledValidationResult _ _ = mempty + + styledValidationResultClass = "" + + styledSubmitButton cssFramework SubmitButton { label, buttonClass, buttonDisabled } = + let className :: Text = cssFramework.styledSubmitButtonClass + in [hsx||] + + styledInputClass _ _ = "" + styledInputInvalidClass _ _ = "invalid" + + styledFormGroupClass = "" + + styledFormFieldHelp _ FormField { helpText = "" } = mempty + styledFormFieldHelp _ FormField { helpText } = [hsx|

    {helpText}

    |] + + styledSubmitButtonClass = "" + + styledPagination :: CSSFramework -> PaginationView -> Blaze.Html + styledPagination _ paginationView = + [hsx| + +
    + + +
    +
    + +
    +
    + +
    + |] + + styledPaginationPageLink :: CSSFramework -> Pagination -> ByteString -> Int -> Blaze.Html + styledPaginationPageLink _ pagination@Pagination {currentPage} pageUrl pageNumber = + let + linkClass = classes ["page-item", ("active", pageNumber == currentPage)] + in + [hsx|
  • {show pageNumber}
    • |] + + + styledPaginationDotDot :: CSSFramework -> Pagination -> Blaze.Html + styledPaginationDotDot _ _ = + [hsx|
  • …
    • |] + + styledPaginationItemsPerPageSelector :: CSSFramework -> Pagination -> (Int -> ByteString) -> Blaze.Html + styledPaginationItemsPerPageSelector _ pagination@Pagination {pageSize} itemsPerPageUrl = + let + oneOption :: Int -> Blaze.Html + oneOption n = [hsx||] + in + [hsx|{forEach [10,20,50,100,200] oneOption}|] + + styledPaginationLinkPrevious :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkPrevious _ pagination@Pagination {currentPage} pageUrl = + let + prevClass = classes ["page-item", ("disabled", not $ hasPreviousPage pagination)] + url = if hasPreviousPage pagination then pageUrl else "#" + in + [hsx| +
  • + + + Previous + +
    • + |] + + styledPaginationLinkNext :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkNext _ pagination@Pagination {currentPage} pageUrl = + let + nextClass = classes ["page-item", ("disabled", not $ hasNextPage pagination)] + url = if hasNextPage pagination then pageUrl else "#" + in + [hsx| +
  • + + + Next + +
    • + |] + + styledBreadcrumb :: CSSFramework -> [BreadcrumbItem]-> BreadcrumbsView -> Blaze.Html + styledBreadcrumb _ _ breadcrumbsView = [hsx| + + |] + + + styledBreadcrumbItem :: CSSFramework -> [ BreadcrumbItem ]-> BreadcrumbItem -> Bool -> Blaze.Html + styledBreadcrumbItem _ breadcrumbItems breadcrumbItem@BreadcrumbItem {breadcrumbLabel, url} isLast = + let + breadcrumbsClasses = classes ["breadcrumb-item", ("active", isLast)] + in + case url of + Nothing -> [hsx|
  • {breadcrumbLabel}
    • |] + Just url -> [hsx|
  • {breadcrumbLabel}
    • |] + + + +bootstrap :: CSSFramework +bootstrap = def + { styledFlashMessage + , styledSubmitButtonClass + , styledFormGroupClass + , styledFormFieldHelp + , styledInputClass + , styledInputInvalidClass + , styledValidationResultClass + } + where + styledFlashMessage _ (SuccessFlashMessage message) = [hsx|
    {message}
    |] + styledFlashMessage _ (ErrorFlashMessage message) = [hsx|
    {message}
    |] + + styledInputClass _ FormField { fieldType = FileInput } = "form-control-file" + styledInputClass _ FormField {} = "form-control" + styledInputInvalidClass _ _ = "is-invalid" + + styledFormFieldHelp _ FormField { helpText = "" } = mempty + styledFormFieldHelp _ FormField { helpText } = [hsx|{helpText}|] + + styledFormGroupClass = "mb-3" + + styledValidationResultClass = "invalid-feedback" + + styledSubmitButtonClass = "btn btn-primary" + +bootstrap4 :: CSSFramework +bootstrap4 = def + { styledFlashMessage + , styledFormField + , styledTextFormField + , styledTextareaFormField + , styledCheckboxFormField + , styledSelectFormField + , styledFormGroup + , styledSubmitButton + , styledSubmitButtonClass + , styledFormFieldHelp + , styledInputClass + , styledInputInvalidClass + , styledFormGroupClass + , styledValidationResult + , styledValidationResultClass + , styledPagination + , styledPaginationPageLink + , styledPaginationDotDot + , styledPaginationItemsPerPageSelector + , styledPaginationLinkPrevious + , styledPaginationLinkNext + , styledBreadcrumb + , styledBreadcrumbItem + } + where + styledFlashMessage _ (SuccessFlashMessage message) = [hsx|
    {message}
    |] + styledFlashMessage _ (ErrorFlashMessage message) = [hsx|
    {message}
    |] + + styledInputClass _ FormField { fieldType = FileInput } = "form-control-file" + styledInputClass _ FormField {} = "form-control" + styledInputInvalidClass _ _ = "is-invalid" + + styledFormFieldHelp _ FormField { helpText = "" } = mempty + styledFormFieldHelp _ FormField { helpText } = [hsx|{helpText}|] + + styledFormGroupClass = "form-group" + + styledValidationResultClass = "invalid-feedback" + + styledSubmitButtonClass = "btn btn-primary" + + + styledFormField :: CSSFramework -> FormField -> Blaze.Html + styledFormField cssFramework@CSSFramework {styledValidationResult, styledTextFormField, styledCheckboxFormField, styledSelectFormField, styledRadioFormField, styledTextareaFormField} formField = + formGroup renderInner + where + renderInner = case formField.fieldType of + TextInput -> styledTextFormField cssFramework "text" formField validationResult + NumberInput -> styledTextFormField cssFramework "number" formField validationResult + PasswordInput -> styledTextFormField cssFramework "password" formField validationResult + ColorInput -> styledTextFormField cssFramework "color" formField validationResult + EmailInput -> styledTextFormField cssFramework "email" formField validationResult + DateInput -> styledTextFormField cssFramework "date" formField validationResult + DateTimeInput -> styledTextFormField cssFramework "datetime-local" formField validationResult + CheckboxInput -> styledCheckboxFormField cssFramework formField validationResult + HiddenInput -> styledTextFormField cssFramework "hidden" formField { disableLabel = True, disableGroup = True, disableValidationResult = True } validationResult + TextareaInput -> styledTextareaFormField cssFramework formField validationResult + SelectInput {} -> styledSelectFormField cssFramework formField validationResult + RadioInput {} -> styledRadioFormField cssFramework formField validationResult + FileInput -> styledTextFormField cssFramework "file" formField validationResult + + validationResult :: Blaze.Html + validationResult = unless formField.disableValidationResult (styledValidationResult cssFramework formField) + + -- | Wraps the input inside a @
    ...
    @ (unless @disableGroup = True@) + formGroup :: Blaze.Html -> Blaze.Html + formGroup renderInner = case formField of + FormField { disableGroup = True } -> renderInner + FormField { fieldInputId } -> styledFormGroup cssFramework fieldInputId renderInner + + + styledFormGroup :: CSSFramework -> Text -> Blaze.Html -> Blaze.Html + styledFormGroup cssFramework@CSSFramework {styledFormGroupClass} fieldInputId renderInner = + [hsx|
    fieldInputId}>{renderInner}
    |] + + styledCheckboxFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledCheckboxFormField cssFramework@CSSFramework {styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = do + [hsx|
    {element}
    |] + where + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + -- If the checkbox is checked off, the browser will not send the parameter as part of the form. + -- This will then make it impossible to set a field to False using a checkbox. + -- For that we add the "hidden" input type. + theInput = [hsx| + + + + |] + + + element = if disableLabel + then [hsx|
    + {theInput} + {validationResult} + {helpText} +
    + |] + else [hsx| + {theInput} + + + {validationResult} + {helpText} + |] + + styledTextFormField :: CSSFramework -> Text -> FormField -> Blaze.Html -> Blaze.Html + styledTextFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} inputType formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + -- If there's no value, then we want to hide the "value" attribute. + maybeValue = if fieldValue == "" then Nothing else Just fieldValue + + styledSelectFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledSelectFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, placeholder, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + label = unless disableLabel [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + isValueSelected = any (\(_, optionValue) -> optionValue == fieldValue) (options fieldType) + + -- Get a single option. + getOption (optionLabel, optionValue) = [hsx| + + |] + + styledTextareaFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledTextareaFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + {validationResult}{helpText}|] + where + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + styledValidationResult :: CSSFramework -> FormField -> Blaze.Html + styledValidationResult cssFramework formField@FormField { validatorResult = Just violation } = + let + className :: Text = cssFramework.styledValidationResultClass + message = case violation of + TextViolation text -> [hsx|{text}|] + HtmlViolation html -> Blaze.preEscapedToHtml html + in + [hsx|
    {message}
    |] + styledValidationResult _ _ = mempty + + styledSubmitButton cssFramework SubmitButton { label, buttonClass, buttonDisabled } = + let className :: Text = cssFramework.styledSubmitButtonClass + in [hsx||] + + styledPagination :: CSSFramework -> PaginationView -> Blaze.Html + styledPagination _ paginationView = + [hsx| + +
    + + +
    +
    + +
    +
    + +
    + |] + + styledPaginationPageLink :: CSSFramework -> Pagination -> ByteString -> Int -> Blaze.Html + styledPaginationPageLink _ pagination@Pagination {currentPage} pageUrl pageNumber = + let + linkClass = classes ["page-item", ("active", pageNumber == currentPage)] + in + [hsx|
  • {show pageNumber}
    • |] + + + styledPaginationDotDot :: CSSFramework -> Pagination -> Blaze.Html + styledPaginationDotDot _ _ = + [hsx|
  • …
    • |] + + styledPaginationItemsPerPageSelector :: CSSFramework -> Pagination -> (Int -> ByteString) -> Blaze.Html + styledPaginationItemsPerPageSelector _ pagination@Pagination {pageSize} itemsPerPageUrl = + let + oneOption :: Int -> Blaze.Html + oneOption n = [hsx||] + in + [hsx|{forEach [10,20,50,100,200] oneOption}|] + + styledPaginationLinkPrevious :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkPrevious _ pagination@Pagination {currentPage} pageUrl = + let + prevClass = classes ["page-item", ("disabled", not $ hasPreviousPage pagination)] + url = if hasPreviousPage pagination then pageUrl else "#" + in + [hsx| +
  • + + + Previous + +
    • + |] + + styledPaginationLinkNext :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkNext _ pagination@Pagination {currentPage} pageUrl = + let + nextClass = classes ["page-item", ("disabled", not $ hasNextPage pagination)] + url = if hasNextPage pagination then pageUrl else "#" + in + [hsx| +
  • + + + Next + +
    • + |] + + styledBreadcrumb :: CSSFramework -> [BreadcrumbItem]-> BreadcrumbsView -> Blaze.Html + styledBreadcrumb _ _ breadcrumbsView = [hsx| + + |] + + + styledBreadcrumbItem :: CSSFramework -> [ BreadcrumbItem ]-> BreadcrumbItem -> Bool -> Blaze.Html + styledBreadcrumbItem _ breadcrumbItems breadcrumbItem@BreadcrumbItem {breadcrumbLabel, url} isLast = + let + breadcrumbsClasses = classes ["breadcrumb-item", ("active", isLast)] + in + case url of + Nothing -> [hsx|
  • {breadcrumbLabel}
    • |] + Just url -> [hsx|
  • {breadcrumbLabel}
    • |] + + + + +tailwind :: CSSFramework +tailwind = def + { styledFlashMessage + , styledTextFormField + , styledTextareaFormField + , styledCheckboxFormField + , styledSelectFormField + , styledRadioFormField + , styledSubmitButtonClass + , styledFormGroupClass + , styledFormFieldHelp + , styledInputClass + , styledInputInvalidClass + , styledValidationResultClass + , styledPagination + , styledPaginationLinkPrevious + , styledPaginationLinkNext + , styledPaginationPageLink + , styledPaginationDotDot + , styledPaginationItemsPerPageSelector + , styledBreadcrumb + , styledBreadcrumbItem + } + where + styledFlashMessage _ (SuccessFlashMessage message) = [hsx|
    {message}
    |] + styledFlashMessage _ (ErrorFlashMessage message) = [hsx|
    {message}
    |] + + styledCheckboxFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledCheckboxFormField cssFramework@CSSFramework {styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = do + [hsx|
    {element}
    |] + where + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + theInput = [hsx| +
    + + + +
    + |] + + + element = if disableLabel + then [hsx|
    + {theInput} +
    + {validationResult} + {helpText} +
    +
    + |] + else [hsx| +
    + {theInput} +
    + + + {validationResult} + {helpText} +
    +
    + |] + + styledTextFormField :: CSSFramework -> Text -> FormField -> Blaze.Html -> Blaze.Html + styledTextFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} inputType formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + twLabelClass = "font-medium text-gray-700" <> " " <> labelClass + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + -- If there's no value, then we want to hide the "value" attribute. + maybeValue = if fieldValue == "" then Nothing else Just fieldValue + + + styledTextareaFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledTextareaFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, placeholder, required, autofocus } validationResult = + [hsx| + {label} + {validationResult}{helpText} + |] + where + twLabelClass = classes ["font-medium text-gray-700", (labelClass, not (null labelClass))] + label = unless (disableLabel || null fieldLabel) [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + + styledSelectFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledSelectFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, placeholder, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = + [hsx| + {label} + + + {validationResult} + {helpText} + |] + where + twLabelClass = "font-medium text-gray-700" <> " " <> labelClass + label = unless disableLabel [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + isValueSelected = any (\(_, optionValue) -> optionValue == fieldValue) (options fieldType) + + -- Get a single option. + getOption (optionLabel, optionValue) = [hsx| + + |] + + styledRadioFormField :: CSSFramework -> FormField -> Blaze.Html -> Blaze.Html + styledRadioFormField cssFramework@CSSFramework {styledInputClass, styledInputInvalidClass, styledFormFieldHelp} formField@FormField {fieldType, fieldName, placeholder, fieldLabel, fieldValue, fieldInputId, validatorResult, fieldClass, disabled, disableLabel, disableValidationResult, additionalAttributes, labelClass, required, autofocus } validationResult = + [hsx| + {label} +
    + + {forEach (options fieldType) (getRadio)} +
    + + {validationResult} + {helpText} + |] + where + label = unless disableLabel [hsx||] + inputClass = (styledInputClass cssFramework formField, True) + inputInvalidClass = styledInputInvalidClass cssFramework formField + helpText = styledFormFieldHelp cssFramework formField + + -- Get a single radio button. + getRadio (optionLabel, optionValue) = [hsx| +
    + + {label} +
    + |] + where + optionId = fieldInputId <> "_" <> optionValue + label = unless disableLabel [hsx||] + + + styledInputClass _ FormField {} = "focus:ring-blue-500 focus:border-blue-500 block w-full border-gray-300 rounded-md" + styledInputInvalidClass _ _ = "is-invalid" + + styledSubmitButtonClass = "bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded" + + styledFormFieldHelp _ FormField { helpText = "" } = mempty + styledFormFieldHelp _ FormField { helpText } = [hsx|

    {helpText}

    |] + + styledFormGroupClass = "flex flex-col my-6 space-y-2" + + styledValidationResultClass = "text-red-500 text-xs italic" + + styledPagination :: CSSFramework -> PaginationView -> Blaze.Html + styledPagination _ paginationView@PaginationView {pageUrl, pagination} = + let + currentPage = pagination.currentPage + + previousPageUrl = if hasPreviousPage pagination then pageUrl $ currentPage - 1 else "#" + nextPageUrl = if hasNextPage pagination then pageUrl $ currentPage + 1 else "#" + + defaultClass = "relative inline-flex items-center px-4 py-2 border border-gray-300 text-sm font-medium rounded-md text-gray-700 bg-white hover:bg-gray-50" + previousClass = classes + [ defaultClass + , ("disabled", not $ hasPreviousPage pagination) + ] + nextClass = classes + [ defaultClass + , ("disabled", not $ hasNextPage pagination) + ] + + previousMobileOnly = + [hsx| + + Previous + + |] + + nextMobileOnly = + [hsx| + + Next + + |] + + in + [hsx| +
    +
    + {previousMobileOnly} + {nextMobileOnly} +
    + +
    + |] + + styledPaginationLinkPrevious :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkPrevious _ pagination@Pagination {currentPage} pageUrl = + let + prevClass = classes + [ "relative inline-flex items-center px-2 py-2 rounded-l-md border border-gray-300 bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" + , ("disabled", not $ hasPreviousPage pagination) + ] + + url = if hasPreviousPage pagination then pageUrl else "#" + + in + [hsx| + + Previous + + + + |] + + styledPaginationLinkNext :: CSSFramework -> Pagination -> ByteString -> Blaze.Html + styledPaginationLinkNext _ pagination@Pagination {currentPage} pageUrl = + let + nextClass = classes + [ "relative inline-flex items-center px-2 py-2 rounded-r-md border border-gray-300 bg-white text-sm font-medium text-gray-500 hover:bg-gray-50" + , ("disabled", not $ hasNextPage pagination) + ] + + url = if hasNextPage pagination then pageUrl else "#" + in + [hsx| + + Next + + + + + |] + + styledPaginationPageLink :: CSSFramework -> Pagination -> ByteString -> Int -> Blaze.Html + styledPaginationPageLink _ pagination@Pagination {currentPage} pageUrl pageNumber = + let + linkClass = classes + [ "relative inline-flex items-center px-4 py-2 border text-sm font-medium" + -- Current page + , ("z-10 bg-blue-50 border-blue-500 text-blue-600", pageNumber == currentPage) + -- Not current page + , ("bg-white border-gray-300 text-gray-500 hover:bg-gray-50", pageNumber /= currentPage) + ] + in + [hsx| + + {show pageNumber} + + |] + + + styledPaginationDotDot :: CSSFramework -> Pagination -> Blaze.Html + styledPaginationDotDot _ _ = + [hsx| + + ... + + |] + + + styledPaginationItemsPerPageSelector :: CSSFramework -> Pagination -> (Int -> ByteString) -> Blaze.Html + styledPaginationItemsPerPageSelector _ pagination@Pagination {pageSize} itemsPerPageUrl = + let + oneOption :: Int -> Blaze.Html + oneOption n = [hsx||] + in + [hsx|{forEach [10,20,50,100,200] oneOption}|] + + + styledBreadcrumb :: CSSFramework -> [BreadcrumbItem]-> BreadcrumbsView -> Blaze.Html + styledBreadcrumb _ _ breadcrumbsView = [hsx| + + |] + + + styledBreadcrumbItem :: CSSFramework -> [ BreadcrumbItem ]-> BreadcrumbItem -> Bool -> Blaze.Html + styledBreadcrumbItem _ breadcrumbItems breadcrumbItem@BreadcrumbItem {breadcrumbLabel, url} isLast = + let + breadcrumbsClasses = classes ["flex flex-row space-x-2 text-gray-600 items-center", ("active", isLast)] + + -- Show chevron if item isn't the active one (i.e. the last one). + chevronRight = unless isLast [hsx| + + + + + |] + in + case url of + Nothing -> [hsx| +
  • + {breadcrumbLabel} + {chevronRight} +
    • + |] + Just url -> [hsx| +
  • + {breadcrumbLabel} + {chevronRight} +
    • + |] diff --git a/IHP/View/Classes.hs b/IHP/View/Classes.hs new file mode 100644 --- /dev/null +++ b/IHP/View/Classes.hs @@ -0,0 +1,56 @@ +{-| +Module: IHP.View.Classes +Description: Provides the classes view helper function +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.View.Classes where + +import IHP.Prelude + +-- | Helper for dynamically generating the @class=".."@ attribute. +-- +-- Given a list like +-- +-- > [("a", True), ("b", False), ("c", True)] +-- +-- builds a class name string for all parts where the second value is @True@. +-- +-- E.g. +-- +-- >>> classes [("a", True), ("b", False), ("c", True)] +-- "a c" +-- +-- When setting @b@ to @True@: +-- +-- >>> classes [("a", True), ("b", True), ("c", True)] +-- "a b c" +-- +-- __Example:__ +-- +-- >>>
    +--
    +-- +-- >>>
    +--
    +-- +-- >>> forEach projects \project -> [hsx| +-- >>>
    +-- >>> {project} +-- >>>
    +-- >>> |] +-- If project is active:
    {project}
    +-- Otherwise:
    {project}
    +classes :: [(Text, Bool)] -> Text +classes !classNameBoolPairs = + classNameBoolPairs + |> filter snd + |> map fst + |> unwords +{-# INLINABLE classes #-} + +-- | Allows `("my-class", True)` to be written as `"my-class"` +-- +-- Useful together with 'classes' +instance IsString (Text, Bool) where + fromString string = (cs string, True) + {-# INLINABLE fromString #-} diff --git a/IHP/View/Form.hs b/IHP/View/Form.hs new file mode 100644 --- /dev/null +++ b/IHP/View/Form.hs @@ -0,0 +1,950 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE AllowAmbiguousTypes #-} +{-# LANGUAGE InstanceSigs, UndecidableInstances, AllowAmbiguousTypes, ScopedTypeVariables, IncoherentInstances #-} +{-| +Module: IHP.View.Form +Description: 'IHP.View.Form.formFor' and all form controls +Copyright: (c) digitally induced GmbH, 2020 +-} +module IHP.View.Form where + +import IHP.Prelude +import IHP.ValidationSupport +import IHP.HSX.ConvertibleStrings () +import IHP.ViewErrorMessages () +import IHP.ViewSupport +import qualified Text.Blaze.Html5 as Html5 +import IHP.HSX.ToHtml +import GHC.Types +import IHP.ModelSupport (getModelName, inputValue, isNew, Id', InputValue, didTouchField) +import IHP.HSX.QQ (hsx) +import IHP.View.Types +import IHP.View.Classes () +import Network.Wai (pathInfo) +import IHP.Controller.Context + +-- | Forms usually begin with a 'formFor' expression. +-- +-- This is how a simple form can look like: +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {textField #title} +-- > {textareaField #body} +-- > {submitButton} +-- > |] +-- +-- Calling this form from inside your HSX code will lead to the following HTML being generated: +-- +-- >
    +-- >
    +-- > +-- > +-- >
    +-- > +-- >
    +-- > +-- > +-- >
    +-- > +-- > +-- >
    +-- +-- You can see that the form is submitted via @POST@. The form action has also been set by default to @/CreatePost@. +-- +-- All inputs have auto-generated class names and ids for styling. Also, all @name@ attributes are set as expected. +-- +-- __Field Values:__ +-- +-- A form control is always filled with the value of the given field when rendering. For example, given a post +-- +-- > let post = Post { ..., title = "Hello World" } +-- +-- Rendering this, the input value will be set like: +-- +-- >>> {textField #title} +-- +-- +-- __Validation:__ +-- +-- When rendering a record that has failed validation, the validation error message will be rendered automatically. +-- +-- Given a post like this: +-- +-- > let post = Post { ..., title = "" } +-- > |> validateField #title nonEmpty +-- +-- Rendering @{textField #title}@, the input will have the css class @is-invalid@ and an element with the error message will be rendered below the input: +-- +-- >
    +-- > +-- > type="text" +-- > name="title" +-- > placeholder="" +-- > id="post_title" +-- > class="form-control is-invalid " +-- > /> +-- >
    This field cannot be empty
    +-- >
    +formFor :: forall record. ( + ?context :: ControllerContext + , ModelFormAction record + , HasField "meta" record MetaBag + ) => record -> ((?context :: ControllerContext, ?formContext :: FormContext record) => Html5.Html) -> Html5.Html +formFor record formBody = formForWithOptions @record record (\c -> c) formBody +{-# INLINE formFor #-} + +-- | Like 'formFor' but allows changing the underlying 'FormContext' +-- +-- This is how you can render a form with a @id="post-form"@ id attribute and a custom @data-post-id@ attribute: +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formForWithOptions formOptions post [hsx| +-- > {textField #title} +-- > {textareaField #body} +-- > {submitButton} +-- > |] +-- > +-- > formOptions :: FormContext Post -> FormContext Post +-- > formOptions formContext = formContext +-- > |> set #formId "post-form" +-- > |> set #customFormAttributes [("data-post-id", show formContext.model.id)] +-- +formForWithOptions :: forall record. ( + ?context :: ControllerContext + , ModelFormAction record + , HasField "meta" record MetaBag + ) => record -> (FormContext record -> FormContext record) -> ((?context :: ControllerContext, ?formContext :: FormContext record) => Html5.Html) -> Html5.Html +formForWithOptions record applyOptions formBody = buildForm (applyOptions (createFormContext record) { formAction = modelFormAction record }) formBody +{-# INLINE formForWithOptions #-} + +-- | Like 'formFor' but disables the IHP javascript helpers. +-- +-- Use it like this: +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formForWithoutJavascript post [hsx| +-- > {textField #title} +-- > {textareaField #body} +-- > {submitButton} +-- > |] +-- +-- If you want to use this with e.g. a custom form action, remember that 'formForWithoutJavascript' is just a shortcut for 'formForWithOptions': +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formForWithOptions formOptions post [hsx| +-- > {textField #title} +-- > {textareaField #body} +-- > {submitButton} +-- > |] +-- > +-- > formOptions :: FormContext Post -> FormContext Post +-- > formOptions formContext = formContext +-- > |> set #formAction (pathTo BespokeNewPostAction) +-- > |> set #disableJavascriptSubmission True +-- +formForWithoutJavascript :: forall record. ( + ?context :: ControllerContext + , ModelFormAction record + , HasField "meta" record MetaBag + ) => record -> ((?context :: ControllerContext, ?formContext :: FormContext record) => Html5.Html) -> Html5.Html +formForWithoutJavascript record formBody = formForWithOptions @record record (\formContext -> formContext { disableJavascriptSubmission = True }) formBody +{-# INLINE formForWithoutJavascript #-} + +-- | Allows a custom form action (form submission url) to be set +-- +-- The URL where the form is going to be submitted to is specified in HTML using the form's @action@ attribute. When using 'formFor' the @action@ attribute is automatically set to the expected path. +-- +-- E.g. given the below 'formFor' code, the @action@ is set to @/CreatePost@ or @/UpdatePost@: +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {textField #title} +-- > {textareaField #body} +-- > {submitButton} +-- > |] +-- +-- To override the auto-generated @action@ attribute use the 'formFor\'' function: +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor' post "/my-custom-endpoint" [hsx||] +-- +-- If you pass an action to that, you need to wrap it with 'pathTo': +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor' post (pathTo CreateDraftAction) [hsx||] +-- +formFor' :: forall record. ( + ?context :: ControllerContext + , HasField "meta" record MetaBag + ) => record -> Text -> ((?context :: ControllerContext, ?formContext :: FormContext record) => Html5.Html) -> Html5.Html +formFor' record action = buildForm (createFormContext record) { formAction = action } +{-# INLINE formFor' #-} + +-- | Used by 'formFor' to make a new form context +createFormContext :: forall record. ( + ?context :: ControllerContext + , HasField "meta" record MetaBag + ) => record -> FormContext record +createFormContext record = + FormContext + { model = record + , formAction = "" + , formMethod = "POST" + , cssFramework = theCSSFramework + , formId = "" + , formClass = if isNew record then "new-form" else "edit-form" + , customFormAttributes = [] + , disableJavascriptSubmission = False + , fieldNamePrefix = "" + } +{-# INLINE createFormContext #-} + +-- | Used by 'formFor' to render the form +buildForm :: forall model. (?context :: ControllerContext) => FormContext model -> ((?context :: ControllerContext, ?formContext :: FormContext model) => Html5.Html) -> Html5.Html +buildForm formContext inner = [hsx| +
    + {formInner} +
    + |] + where + formInner = let ?formContext = formContext in inner +{-# INLINE buildForm #-} + +nestedFormFor :: forall fieldName childRecord parentRecord idType. ( + ?context :: ControllerContext + , ?formContext :: FormContext parentRecord + , HasField fieldName parentRecord [childRecord] + , KnownSymbol fieldName + , KnownSymbol (GetModelName childRecord) + , HasField "id" childRecord idType + , InputValue idType + , HasField "meta" childRecord MetaBag + ) => Proxy fieldName -> ((?context :: ControllerContext, ?formContext :: FormContext childRecord) => Html5.Html) -> Html5.Html +nestedFormFor field nestedRenderForm = forEach children renderChild + where + parentFormContext :: FormContext parentRecord + parentFormContext = ?formContext + + renderChild :: childRecord -> Html5.Html + renderChild record = let ?formContext = buildNestedFormContext record in [hsx| + {hiddenField #id} + {nestedRenderForm} + |] + + buildNestedFormContext :: childRecord -> FormContext childRecord + buildNestedFormContext record = parentFormContext { model = record, fieldNamePrefix = symbolToText @fieldName <> "_" } + + children :: [childRecord] + children = getField @fieldName ?formContext.model +{-# INLINE nestedFormFor #-} + +-- | Renders a submit button +-- +-- > +-- +-- __Example:__ +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {submitButton} +-- > |] +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- >
    +-- +-- __Custom Text__ +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {submitButton { label = "Create it!" } } +-- > |] +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- >
    +-- +-- __Custom Class__ +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {submitButton { buttonClass = "create-button" } } +-- > |] +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- >
    +-- +-- __Disabled button__ +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {submitButton { buttonDisabled = True } } +-- > |] +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- >
    +submitButton :: forall model. (?formContext :: FormContext model, HasField "meta" model MetaBag, KnownSymbol (GetModelName model)) => SubmitButton +submitButton = + let + modelName = IHP.ModelSupport.getModelName @model + buttonText = modelName |> humanize -- We do this to turn 'Create ProjectTask' into 'Create Project Task' + isNew = IHP.ModelSupport.isNew (model ?formContext) + in SubmitButton + { label = cs $ (if isNew then "Create " else "Save ") <> buttonText + , buttonClass = mempty + , buttonDisabled = False + , cssFramework = ?formContext.cssFramework + } +{-# INLINE submitButton #-} + +-- | Renders a text input field +-- +-- >>> {textField #title} +--
    +-- +-- +--
    +-- +-- __Example:__ +-- +-- > renderForm :: Post -> Html +-- > renderForm post = formFor post [hsx| +-- > {textField #title} +-- > |] +-- +-- This will generate code like this: +-- +-- >
    +-- >
    +-- > +-- > +-- >
    +-- >
    +-- +-- __Help Texts:__ +-- +-- You can add a help text below a form control like this: +-- +-- > {(textField #title) { helpText = "Max. 140 characters"} } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > +-- > +-- > Max. 140 characters +-- >
    +-- +-- +-- __Custom Field Label Text:__ +-- +-- By default, the field name will be used as a label text. The camel case field name will be made more human-readable of course, so @contactName@ will turn to @Contact Name@, etc. Sometimes you want to change this auto-generated input label to something custom. Use @fieldLabel@ for that, like this: +-- +-- > {(textField #title) { fieldLabel = "Post Title"} } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > +-- >
    +-- +-- +-- __Custom CSS Classes:__ +-- +-- You can add custom CSS classes to the input and label for better styling. Set @fieldClass@ for adding a class to the input element and @labelClass@ for the label element: +-- +-- > {(textField #title) { fieldClass="title-input", labelClass = "title-label" } } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > type="text" +-- > name="title" +-- > id="post_title" +-- > class="form-control title-input" +-- > /> +-- >
    +-- +-- Of course, the CSS classes for validation are still set as expected. +-- +-- __Placeholder:__ +-- +-- > {(textField #title) { placeholder = "Enter your title ..." } } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > +-- > type="text" +-- > name="title" +-- > id="post_title" +-- > placeholder="Enter your title ..." +-- > class="form-control" +-- > /> +-- >
    +-- +-- +-- __Required Fields:__ +-- +-- You can mark an input as required like this: +-- +-- > {(textField #title) { required = True } } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > +-- > type="text" +-- > name="title" +-- > id="post_title" +-- > required="required" +-- > class="form-control" +-- > /> +-- >
    +-- +-- __Autofocus:__ +-- +-- You can mark an input with autofocus, to ensure it will be given the input focus on page load, like this: +-- +-- > {(textField #title) { autofocus = True } } +-- +-- This will generate code like this: +-- +-- >
    +-- > +-- > +-- > type="text" +-- > name="title" +-- > id="post_title" +-- > autofocus="autofocus" +-- > class="form-control" +-- > /> +-- >
    +textField :: forall fieldName model value. + ( ?formContext :: FormContext model + , HasField fieldName model value + , HasField "meta" model MetaBag + , KnownSymbol fieldName + , InputValue value + , KnownSymbol (GetModelName model) + ) => Proxy fieldName -> FormField +textField field = FormField + { fieldType = TextInput + , fieldName = ?formContext.fieldNamePrefix <> cs fieldName + , fieldLabel = fieldNameToFieldLabel (cs fieldName) + , fieldValue = inputValue ((getField @fieldName model) :: value) + , fieldInputId = cs (lcfirst (getModelName @model) <> "_" <> cs fieldName) + , validatorResult = getValidationViolation field model + , fieldClass = "" + , labelClass = "" + , disabled = False + , disableLabel = False + , disableGroup = False + , disableValidationResult = False + , additionalAttributes = [] + , cssFramework = ?formContext.cssFramework + , helpText = "" + , placeholder = "" + , required = False + , autofocus = False + } + where + fieldName = symbolVal field + FormContext { model } = ?formContext +{-# INLINE textField #-} + +-- | Renders a number input field +-- +-- >>> {numberField #maxUsers} +--
    +-- +-- +--
    +-- +-- See 'textField' for examples of possible form control options. +numberField :: forall fieldName model value. + ( ?formContext :: FormContext model + , HasField fieldName model value + , HasField "meta" model MetaBag + , KnownSymbol fieldName + , InputValue value + , KnownSymbol (GetModelName model) + ) => Proxy fieldName -> FormField +numberField field = (textField field) { fieldType = NumberInput } +{-# INLINE numberField #-} + +-- | Renders a URL input field +-- +-- >>> {urlField #url} +--
    +-- +-- +--
    +-- +-- See 'textField' for examples of possible form control options. +urlField :: forall fieldName model value. + ( ?formContext :: FormContext model + , HasField fieldName model value + , HasField "meta" model MetaBag + , KnownSymbol fieldName + , InputValue value + , KnownSymbol (GetModelName model) + ) => Proxy fieldName -> FormField +urlField field = (textField field) { fieldType = UrlInput } +{-# INLINE urlField #-} + +-- | Renders a textarea +-- +-- >>> {textareaField #body} +--
    +-- +-- ",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var ra=d.documentElement,sa=/^key/,ta=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,ua=/^([^.]*)(?:\.(.+)|)/;function va(){return!0}function wa(){return!1}function xa(){try{return d.activeElement}catch(a){}}function ya(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ya(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=wa;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(ra,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(L)||[""],j=b.length;while(j--)h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.hasData(a)&&W.get(a);if(q&&(i=q.events)){b=(b||"").match(L)||[""],j=b.length;while(j--)if(h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&W.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(W.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c=1))for(;j!==this;j=j.parentNode||this)if(1===j.nodeType&&("click"!==a.type||j.disabled!==!0)){for(f=[],g={},c=0;c-1:r.find(e,this,null,[j]).length),g[e]&&f.push(d);f.length&&h.push({elem:j,handlers:f})}return j=this,i\x20\t\r\n\f]*)[^>]*)\/>/gi,Aa=/\s*$/g;function Ea(a,b){return B(a,"table")&&B(11!==b.nodeType?b:b.firstChild,"tr")?r(">tbody",a)[0]||a:a}function Fa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ga(a){var b=Ca.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ha(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(W.hasData(a)&&(f=W.access(a),g=W.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c1&&"string"==typeof q&&!o.checkClone&&Ba.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ja(f,b,c,d)});if(m&&(e=qa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(na(e,"script"),Fa),i=h.length;l")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||r.isXMLDoc(a)))for(g=na(h),f=na(a),d=0,e=f.length;d0&&oa(g,!i&&na(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(U(c)){if(b=c[W.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[W.expando]=void 0}c[X.expando]&&(c[X.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ka(this,a,!0)},remove:function(a){return Ka(this,a)},text:function(a){return T(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.appendChild(a)}})},prepend:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(na(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return T(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!Aa.test(a)&&!ma[(ka.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c1)}}),r.fn.delay=function(b,c){return b=r.fx?r.fx.speeds[b]||b:b,c=c||"fx",this.queue(c,function(c,d){var e=a.setTimeout(c,b);d.stop=function(){a.clearTimeout(e)}})},function(){var a=d.createElement("input"),b=d.createElement("select"),c=b.appendChild(d.createElement("option"));a.type="checkbox",o.checkOn=""!==a.value,o.optSelected=c.selected,a=d.createElement("input"),a.value="t",a.type="radio",o.radioValue="t"===a.value}();var _a,ab=r.expr.attrHandle;r.fn.extend({attr:function(a,b){return T(this,r.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?_a:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b),null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&B(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(L);if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),_a={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=ab[b]||r.find.attr;ab[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=ab[g],ab[g]=e,e=null!=c(a,b,d)?g:null,ab[g]=f),e}});var bb=/^(?:input|select|textarea|button)$/i,cb=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return T(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});function db(a){var b=a.match(L)||[];return b.join(" ")}function eb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,eb(this)))});if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=eb(c),d=1===c.nodeType&&" "+db(e)+" "){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=db(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,eb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=eb(c),d=1===c.nodeType&&" "+db(e)+" "){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=db(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,eb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(L)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=eb(this),b&&W.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":W.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+db(eb(c))+" ").indexOf(b)>-1)return!0;return!1}});var fb=/\r/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":Array.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(fb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:db(r.text(a))}},select:{get:function(a){var b,c,d,e=a.options,f=a.selectedIndex,g="select-one"===a.type,h=g?null:[],i=g?f+1:e.length;for(d=f<0?i:g?f:0;d-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(Array.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var gb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!gb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,gb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(W.get(h,"events")||{})[b.type]&&W.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&U(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!U(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=W.access(d,b);e||d.addEventListener(a,c,!0),W.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=W.access(d,b)-1;e?W.access(d,b,e):(d.removeEventListener(a,c,!0),W.remove(d,b))}}});var hb=/\[\]$/,ib=/\r?\n/g,jb=/^(?:submit|button|image|reset|file)$/i,kb=/^(?:input|select|textarea|keygen)/i;function lb(a,b,c,d){var e;if(Array.isArray(b))r.each(b,function(b,e){c||hb.test(a)?d(a,e):lb(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d); +});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)lb(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(Array.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)lb(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!r(this).is(":disabled")&&kb.test(this.nodeName)&&!jb.test(a)&&(this.checked||!ja.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:Array.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(ib,"\r\n")}}):{name:b.name,value:c.replace(ib,"\r\n")}}).get()}}),r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},o.createHTMLDocument=function(){var a=d.implementation.createHTMLDocument("").body;return a.innerHTML="
    ",2===a.childNodes.length}(),r.parseHTML=function(a,b,c){if("string"!=typeof a)return[];"boolean"==typeof b&&(c=b,b=!1);var e,f,g;return b||(o.createHTMLDocument?(b=d.implementation.createHTMLDocument(""),e=b.createElement("base"),e.href=d.location.href,b.head.appendChild(e)):b=d),f=C.exec(a),g=!c&&[],f?[b.createElement(f[1])]:(f=qa([a],b,g),g&&g.length&&r(g).remove(),r.merge([],f.childNodes))},r.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=r.css(a,"position"),l=r(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=r.css(a,"top"),i=r.css(a,"left"),j=("absolute"===k||"fixed"===k)&&(f+i).indexOf("auto")>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),r.isFunction(b)&&(b=b.call(a,c,r.extend({},h))),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},r.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){r.offset.setOffset(this,a,b)});var b,c,d,e,f=this[0];if(f)return f.getClientRects().length?(d=f.getBoundingClientRect(),b=f.ownerDocument,c=b.documentElement,e=b.defaultView,{top:d.top+e.pageYOffset-c.clientTop,left:d.left+e.pageXOffset-c.clientLeft}):{top:0,left:0}},position:function(){if(this[0]){var a,b,c=this[0],d={top:0,left:0};return"fixed"===r.css(c,"position")?b=c.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),B(a[0],"html")||(d=a.offset()),d={top:d.top+r.css(a[0],"borderTopWidth",!0),left:d.left+r.css(a[0],"borderLeftWidth",!0)}),{top:b.top-d.top-r.css(c,"marginTop",!0),left:b.left-d.left-r.css(c,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent;while(a&&"static"===r.css(a,"position"))a=a.offsetParent;return a||ra})}}),r.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c="pageYOffset"===b;r.fn[a]=function(d){return T(this,function(a,d,e){var f;return r.isWindow(a)?f=a:9===a.nodeType&&(f=a.defaultView),void 0===e?f?f[b]:a[d]:void(f?f.scrollTo(c?f.pageXOffset:e,c?e:f.pageYOffset):a[d]=e)},a,d,arguments.length)}}),r.each(["top","left"],function(a,b){r.cssHooks[b]=Pa(o.pixelPosition,function(a,c){if(c)return c=Oa(a,b),Ma.test(c)?r(a).position()[b]+"px":c})}),r.each({Height:"height",Width:"width"},function(a,b){r.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){r.fn[d]=function(e,f){var g=arguments.length&&(c||"boolean"!=typeof e),h=c||(e===!0||f===!0?"margin":"border");return T(this,function(b,c,e){var f;return r.isWindow(b)?0===d.indexOf("outer")?b["inner"+a]:b.document.documentElement["client"+a]:9===b.nodeType?(f=b.documentElement,Math.max(b.body["scroll"+a],f["scroll"+a],b.body["offset"+a],f["offset"+a],f["client"+a])):void 0===e?r.css(b,c,h):r.style(b,c,e,h)},b,g?e:void 0,g)}})}),r.fn.extend({bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}}),r.holdReady=function(a){a?r.readyWait++:r.ready(!0)},r.isArray=Array.isArray,r.parseJSON=JSON.parse,r.nodeName=B,"function"==typeof define&&define.amd&&define("jquery",[],function(){return r});var mb=a.jQuery,nb=a.$;return r.noConflict=function(b){return a.$===r&&(a.$=nb),b&&a.jQuery===r&&(a.jQuery=mb),r},b||(a.jQuery=a.$=r),r}); diff --git a/data/static/vendor/jquery-3.5.0.min.js b/data/static/vendor/jquery-3.5.0.min.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/jquery-3.5.0.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.5.0 | (c) JS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+R+")"+R+"*"),U=new RegExp(R+"|>"),V=new RegExp(W),X=new RegExp("^"+B+"$"),Q={ID:new RegExp("^#("+B+")"),CLASS:new RegExp("^\\.("+B+")"),TAG:new RegExp("^("+B+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+W),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+R+"*(even|odd|(([+-]|)(\\d*)n|)"+R+"*(?:([+-]|)"+R+"*(\\d+)|))"+R+"*\\)|)","i"),bool:new RegExp("^(?:"+I+")$","i"),needsContext:new RegExp("^"+R+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+R+"*((?:-\\d)?\\d*)"+R+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,G=/^(?:input|select|textarea|button)$/i,K=/^h\d$/i,J=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+R+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){C()},ae=xe(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{O.apply(t=P.call(d.childNodes),d.childNodes),t[d.childNodes.length].nodeType}catch(e){O={apply:t.length?function(e,t){q.apply(e,P.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,d=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==d&&9!==d&&11!==d)return n;if(!r&&(C(e),e=e||T,E)){if(11!==d&&(u=Z.exec(t)))if(i=u[1]){if(9===d){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return O.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&p.getElementsByClassName&&e.getElementsByClassName)return O.apply(n,e.getElementsByClassName(i)),n}if(p.qsa&&!k[t+" "]&&(!v||!v.test(t))&&(1!==d||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===d&&(U.test(t)||_.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&p.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=A)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+be(l[o]);c=l.join(",")}try{return O.apply(n,f.querySelectorAll(c)),n}catch(e){k(t,!0)}finally{s===A&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>x.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[A]=!0,e}function ce(e){var t=T.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)x.attrHandle[n[r]]=t}function de(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function pe(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in p=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},C=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:d;return r!=T&&9===r.nodeType&&r.documentElement&&(a=(T=r).documentElement,E=!i(T),d!=T&&(n=T.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),p.scope=ce(function(e){return a.appendChild(e).appendChild(T.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),p.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),p.getElementsByTagName=ce(function(e){return e.appendChild(T.createComment("")),!e.getElementsByTagName("*").length}),p.getElementsByClassName=J.test(T.getElementsByClassName),p.getById=ce(function(e){return a.appendChild(e).id=A,!T.getElementsByName||!T.getElementsByName(A).length}),p.getById?(x.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},x.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(x.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},x.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),x.find.TAG=p.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):p.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},x.find.CLASS=p.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(p.qsa=J.test(T.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+R+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+R+"*(?:value|"+I+")"),e.querySelectorAll("[id~="+A+"-]").length||v.push("~="),(t=T.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+R+"*name"+R+"*="+R+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+A+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=T.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+R+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(p.matchesSelector=J.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){p.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",W)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=J.test(a.compareDocumentPosition),y=t||J.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!p.sortDetached&&t.compareDocumentPosition(e)===n?e==T||e.ownerDocument==d&&y(d,e)?-1:t==T||t.ownerDocument==d&&y(d,t)?1:u?H(u,e)-H(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==T?-1:t==T?1:i?-1:o?1:u?H(u,e)-H(u,t):0;if(i===o)return de(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?de(a[r],s[r]):a[r]==d?-1:s[r]==d?1:0}),T},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(C(e),p.matchesSelector&&E&&!k[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||p.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){k(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return Q.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&V.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+R+")"+e+"("+R+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return b(n)?E.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?E.grep(e,function(e){return e===n!==r}):"string"!=typeof n?E.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(E.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||L,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:j.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof E?t[0]:t,E.merge(this,E.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:w,!0)),k.test(r[1])&&E.isPlainObject(t))for(r in t)b(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=w.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):b(e)?void 0!==n.ready?n.ready(e):e(E):E.makeArray(e,this)}).prototype=E.fn,L=E(w);var q=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}E.fn.extend({has:function(e){var t=E(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,pe=/^$|^module$|\/(?:java|ecma)script/i;le=w.createDocumentFragment().appendChild(w.createElement("div")),(ce=w.createElement("input")).setAttribute("type","radio"),ce.setAttribute("checked","checked"),ce.setAttribute("name","t"),le.appendChild(ce),m.checkClone=le.cloneNode(!0).cloneNode(!0).lastChild.checked,le.innerHTML="",m.noCloneChecked=!!le.cloneNode(!0).lastChild.defaultValue,le.innerHTML="",m.option=!!le.lastChild;var he={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ge(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&S(e,t)?E.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var ye=/<|&#?\w+;/;function me(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),d=[],p=0,h=e.length;p\s*$/g;function ke(e,t){return S(e,"table")&&S(11!==t.nodeType?t:t.firstChild,"tr")&&E(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Le(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function je(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n
    ",2===lt.childNodes.length),E.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(m.createHTMLDocument?((r=(t=w.implementation.createHTMLDocument("")).createElement("base")).href=w.location.href,t.head.appendChild(r)):t=w),o=!n&&[],(i=k.exec(e))?[t.createElement(i[1])]:(i=me([e],t,o),o&&o.length&&E(o).remove(),E.merge([],i.childNodes)));var r,i,o},E.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=E.css(e,"position"),c=E(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=E.css(e,"top"),u=E.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),b(t)&&(t=t.call(e,n,E.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},E.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){E.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===E.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===E.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=E(e).offset()).top+=E.css(e,"borderTopWidth",!0),i.left+=E.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-E.css(r,"marginTop",!0),left:t.left-i.left-E.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===E.css(e,"position"))e=e.offsetParent;return e||re})}}),E.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;E.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),E.each(["top","left"],function(e,n){E.cssHooks[n]=Me(m.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?E(e).position()[n]+"px":t})}),E.each({Height:"height",Width:"width"},function(a,s){E.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){E.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?E.css(e,t,i):E.style(e,t,n,i)},s,n?e:void 0,n)}})}),E.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),E.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){E.fn[n]=function(e,t){return 0=0;i--){attr=toNodeAttrs[i];attrName=attr.name;attrNamespaceURI=attr.namespaceURI;attrValue=attr.value;if(attrNamespaceURI){attrName=attr.localName||attrName;fromValue=fromNode.getAttributeNS(attrNamespaceURI,attrName);if(fromValue!==attrValue){if(attr.prefix==="xmlns"){attrName=attr.name}fromNode.setAttributeNS(attrNamespaceURI,attrName,attrValue)}}else{fromValue=fromNode.getAttribute(attrName);if(fromValue!==attrValue){fromNode.setAttribute(attrName,attrValue)}}}var fromNodeAttrs=fromNode.attributes;for(var d=fromNodeAttrs.length-1;d>=0;d--){attr=fromNodeAttrs[d];attrName=attr.name;attrNamespaceURI=attr.namespaceURI;if(attrNamespaceURI){attrName=attr.localName||attrName;if(!toNode.hasAttributeNS(attrNamespaceURI,attrName)){fromNode.removeAttributeNS(attrNamespaceURI,attrName)}}else{if(!toNode.hasAttribute(attrName)){fromNode.removeAttribute(attrName)}}}}var range;var NS_XHTML="http://www.w3.org/1999/xhtml";var doc=typeof document==="undefined"?undefined:document;var HAS_TEMPLATE_SUPPORT=!!doc&&"content"in doc.createElement("template");var HAS_RANGE_SUPPORT=!!doc&&doc.createRange&&"createContextualFragment"in doc.createRange();function createFragmentFromTemplate(str){var template=doc.createElement("template");template.innerHTML=str;return template.content.childNodes[0]}function createFragmentFromRange(str){if(!range){range=doc.createRange();range.selectNode(doc.body)}var fragment=range.createContextualFragment(str);return fragment.childNodes[0]}function createFragmentFromWrap(str){var fragment=doc.createElement("body");fragment.innerHTML=str;return fragment.childNodes[0]}function toElement(str){str=str.trim();if(HAS_TEMPLATE_SUPPORT){return createFragmentFromTemplate(str)}else if(HAS_RANGE_SUPPORT){return createFragmentFromRange(str)}return createFragmentFromWrap(str)}function compareNodeNames(fromEl,toEl){var fromNodeName=fromEl.nodeName;var toNodeName=toEl.nodeName;var fromCodeStart,toCodeStart;if(fromNodeName===toNodeName){return true}fromCodeStart=fromNodeName.charCodeAt(0);toCodeStart=toNodeName.charCodeAt(0);if(fromCodeStart<=90&&toCodeStart>=97){return fromNodeName===toNodeName.toUpperCase()}else if(toCodeStart<=90&&fromCodeStart>=97){return toNodeName===fromNodeName.toUpperCase()}else{return false}}function createElementNS(name,namespaceURI){return!namespaceURI||namespaceURI===NS_XHTML?doc.createElement(name):doc.createElementNS(namespaceURI,name)}function moveChildren(fromEl,toEl){var curChild=fromEl.firstChild;while(curChild){var nextChild=curChild.nextSibling;toEl.appendChild(curChild);curChild=nextChild}return toEl}function syncBooleanAttrProp(fromEl,toEl,name){if(fromEl[name]!==toEl[name]){fromEl[name]=toEl[name];if(fromEl[name]){fromEl.setAttribute(name,"")}else{fromEl.removeAttribute(name)}}}var specialElHandlers={OPTION:function(fromEl,toEl){var parentNode=fromEl.parentNode;if(parentNode){var parentName=parentNode.nodeName.toUpperCase();if(parentName==="OPTGROUP"){parentNode=parentNode.parentNode;parentName=parentNode&&parentNode.nodeName.toUpperCase()}if(parentName==="SELECT"&&!parentNode.hasAttribute("multiple")){if(fromEl.hasAttribute("selected")&&!toEl.selected){fromEl.setAttribute("selected","selected");fromEl.removeAttribute("selected")}parentNode.selectedIndex=-1}}syncBooleanAttrProp(fromEl,toEl,"selected")},INPUT:function(fromEl,toEl){syncBooleanAttrProp(fromEl,toEl,"checked");syncBooleanAttrProp(fromEl,toEl,"disabled");if(fromEl.value!==toEl.value){fromEl.value=toEl.value}if(!toEl.hasAttribute("value")){fromEl.removeAttribute("value")}},TEXTAREA:function(fromEl,toEl){var newValue=toEl.value;if(fromEl.value!==newValue){fromEl.value=newValue}var firstChild=fromEl.firstChild;if(firstChild){var oldValue=firstChild.nodeValue;if(oldValue==newValue||!newValue&&oldValue==fromEl.placeholder){return}firstChild.nodeValue=newValue}},SELECT:function(fromEl,toEl){if(!toEl.hasAttribute("multiple")){var selectedIndex=-1;var i=0;var curChild=fromEl.firstChild;var optgroup;var nodeName;while(curChild){nodeName=curChild.nodeName&&curChild.nodeName.toUpperCase();if(nodeName==="OPTGROUP"){optgroup=curChild;curChild=optgroup.firstChild}else{if(nodeName==="OPTION"){if(curChild.hasAttribute("selected")){selectedIndex=i;break}i++}curChild=curChild.nextSibling;if(!curChild&&optgroup){curChild=optgroup.nextSibling;optgroup=null}}}fromEl.selectedIndex=selectedIndex}}};var ELEMENT_NODE=1;var DOCUMENT_FRAGMENT_NODE$1=11;var TEXT_NODE=3;var COMMENT_NODE=8;function noop(){}function defaultGetNodeKey(node){if(node){return node.getAttribute&&node.getAttribute("id")||node.id}}function morphdomFactory(morphAttrs){return function morphdom(fromNode,toNode,options){if(!options){options={}}if(typeof toNode==="string"){if(fromNode.nodeName==="#document"||fromNode.nodeName==="HTML"||fromNode.nodeName==="BODY"){var toNodeHtml=toNode;toNode=doc.createElement("html");toNode.innerHTML=toNodeHtml}else{toNode=toElement(toNode)}}var getNodeKey=options.getNodeKey||defaultGetNodeKey;var onBeforeNodeAdded=options.onBeforeNodeAdded||noop;var onNodeAdded=options.onNodeAdded||noop;var onBeforeElUpdated=options.onBeforeElUpdated||noop;var onElUpdated=options.onElUpdated||noop;var onBeforeNodeDiscarded=options.onBeforeNodeDiscarded||noop;var onNodeDiscarded=options.onNodeDiscarded||noop;var onBeforeElChildrenUpdated=options.onBeforeElChildrenUpdated||noop;var childrenOnly=options.childrenOnly===true;var fromNodesLookup=Object.create(null);var keyedRemovalList=[];function addKeyedRemoval(key){keyedRemovalList.push(key)}function walkDiscardedChildNodes(node,skipKeyedNodes){if(node.nodeType===ELEMENT_NODE){var curChild=node.firstChild;while(curChild){var key=undefined;if(skipKeyedNodes&&(key=getNodeKey(curChild))){addKeyedRemoval(key)}else{onNodeDiscarded(curChild);if(curChild.firstChild){walkDiscardedChildNodes(curChild,skipKeyedNodes)}}curChild=curChild.nextSibling}}}function removeNode(node,parentNode,skipKeyedNodes){if(onBeforeNodeDiscarded(node)===false){return}if(parentNode){parentNode.removeChild(node)}onNodeDiscarded(node);walkDiscardedChildNodes(node,skipKeyedNodes)}function indexTree(node){if(node.nodeType===ELEMENT_NODE||node.nodeType===DOCUMENT_FRAGMENT_NODE$1){var curChild=node.firstChild;while(curChild){var key=getNodeKey(curChild);if(key){fromNodesLookup[key]=curChild}indexTree(curChild);curChild=curChild.nextSibling}}}indexTree(fromNode);function handleNodeAdded(el){onNodeAdded(el);var curChild=el.firstChild;while(curChild){var nextSibling=curChild.nextSibling;var key=getNodeKey(curChild);if(key){var unmatchedFromEl=fromNodesLookup[key];if(unmatchedFromEl&&compareNodeNames(curChild,unmatchedFromEl)){curChild.parentNode.replaceChild(unmatchedFromEl,curChild);morphEl(unmatchedFromEl,curChild)}else{handleNodeAdded(curChild)}}else{handleNodeAdded(curChild)}curChild=nextSibling}}function cleanupFromEl(fromEl,curFromNodeChild,curFromNodeKey){while(curFromNodeChild){var fromNextSibling=curFromNodeChild.nextSibling;if(curFromNodeKey=getNodeKey(curFromNodeChild)){addKeyedRemoval(curFromNodeKey)}else{removeNode(curFromNodeChild,fromEl,true)}curFromNodeChild=fromNextSibling}}function morphEl(fromEl,toEl,childrenOnly){var toElKey=getNodeKey(toEl);if(toElKey){delete fromNodesLookup[toElKey]}if(!childrenOnly){if(onBeforeElUpdated(fromEl,toEl)===false){return}morphAttrs(fromEl,toEl);onElUpdated(fromEl);if(onBeforeElChildrenUpdated(fromEl,toEl)===false){return}}if(fromEl.nodeName!=="TEXTAREA"){morphChildren(fromEl,toEl)}else{specialElHandlers.TEXTAREA(fromEl,toEl)}}function morphChildren(fromEl,toEl){var curToNodeChild=toEl.firstChild;var curFromNodeChild=fromEl.firstChild;var curToNodeKey;var curFromNodeKey;var fromNextSibling;var toNextSibling;var matchingFromEl;outer:while(curToNodeChild){toNextSibling=curToNodeChild.nextSibling;curToNodeKey=getNodeKey(curToNodeChild);while(curFromNodeChild){fromNextSibling=curFromNodeChild.nextSibling;if(curToNodeChild.isSameNode&&curToNodeChild.isSameNode(curFromNodeChild)){curToNodeChild=toNextSibling;curFromNodeChild=fromNextSibling;continue outer}curFromNodeKey=getNodeKey(curFromNodeChild);var curFromNodeType=curFromNodeChild.nodeType;var isCompatible=undefined;if(curFromNodeType===curToNodeChild.nodeType){if(curFromNodeType===ELEMENT_NODE){if(curToNodeKey){if(curToNodeKey!==curFromNodeKey){if(matchingFromEl=fromNodesLookup[curToNodeKey]){if(fromNextSibling===matchingFromEl){isCompatible=false}else{fromEl.insertBefore(matchingFromEl,curFromNodeChild);if(curFromNodeKey){addKeyedRemoval(curFromNodeKey)}else{removeNode(curFromNodeChild,fromEl,true)}curFromNodeChild=matchingFromEl}}else{isCompatible=false}}}else if(curFromNodeKey){isCompatible=false}isCompatible=isCompatible!==false&&compareNodeNames(curFromNodeChild,curToNodeChild);if(isCompatible){morphEl(curFromNodeChild,curToNodeChild)}}else if(curFromNodeType===TEXT_NODE||curFromNodeType==COMMENT_NODE){isCompatible=true;if(curFromNodeChild.nodeValue!==curToNodeChild.nodeValue){curFromNodeChild.nodeValue=curToNodeChild.nodeValue}}}if(isCompatible){curToNodeChild=toNextSibling;curFromNodeChild=fromNextSibling;continue outer}if(curFromNodeKey){addKeyedRemoval(curFromNodeKey)}else{removeNode(curFromNodeChild,fromEl,true)}curFromNodeChild=fromNextSibling}if(curToNodeKey&&(matchingFromEl=fromNodesLookup[curToNodeKey])&&compareNodeNames(matchingFromEl,curToNodeChild)){fromEl.appendChild(matchingFromEl);morphEl(matchingFromEl,curToNodeChild)}else{var onBeforeNodeAddedResult=onBeforeNodeAdded(curToNodeChild);if(onBeforeNodeAddedResult!==false){if(onBeforeNodeAddedResult){curToNodeChild=onBeforeNodeAddedResult}if(curToNodeChild.actualize){curToNodeChild=curToNodeChild.actualize(fromEl.ownerDocument||doc)}fromEl.appendChild(curToNodeChild);handleNodeAdded(curToNodeChild)}}curToNodeChild=toNextSibling;curFromNodeChild=fromNextSibling}cleanupFromEl(fromEl,curFromNodeChild,curFromNodeKey);var specialElHandler=specialElHandlers[fromEl.nodeName];if(specialElHandler){specialElHandler(fromEl,toEl)}}var morphedNode=fromNode;var morphedNodeType=morphedNode.nodeType;var toNodeType=toNode.nodeType;if(!childrenOnly){if(morphedNodeType===ELEMENT_NODE){if(toNodeType===ELEMENT_NODE){if(!compareNodeNames(fromNode,toNode)){onNodeDiscarded(fromNode);morphedNode=moveChildren(fromNode,createElementNS(toNode.nodeName,toNode.namespaceURI))}}else{morphedNode=toNode}}else if(morphedNodeType===TEXT_NODE||morphedNodeType===COMMENT_NODE){if(toNodeType===morphedNodeType){if(morphedNode.nodeValue!==toNode.nodeValue){morphedNode.nodeValue=toNode.nodeValue}return morphedNode}else{morphedNode=toNode}}}if(morphedNode===toNode){onNodeDiscarded(fromNode)}else{if(toNode.isSameNode&&toNode.isSameNode(morphedNode)){return}morphEl(morphedNode,toNode,childrenOnly);if(keyedRemovalList){for(var i=0,len=keyedRemovalList.length;i0&&s(a.width)/e.offsetWidth||1,p=e.offsetHeight>0&&s(a.height)/e.offsetHeight||1);var u=(n(e)?t(e):window).visualViewport,l=!c()&&i,d=(a.left+(l&&u?u.offsetLeft:0))/f,h=(a.top+(l&&u?u.offsetTop:0))/p,m=a.width/f,v=a.height/p;return{width:m,height:v,top:h,right:d+m,bottom:h+v,left:d,x:d,y:h}}function u(e){var n=t(e);return{scrollLeft:n.pageXOffset,scrollTop:n.pageYOffset}}function l(e){return e?(e.nodeName||"").toLowerCase():null}function d(e){return((n(e)?e.ownerDocument:e.document)||window.document).documentElement}function h(e){return p(d(e)).left+u(e).scrollLeft}function m(e){return t(e).getComputedStyle(e)}function v(e){var t=m(e),n=t.overflow,r=t.overflowX,o=t.overflowY;return/auto|scroll|overlay|hidden/.test(n+o+r)}function y(e,n,o){void 0===o&&(o=!1);var i,a,f=r(n),c=r(n)&&function(e){var t=e.getBoundingClientRect(),n=s(t.width)/e.offsetWidth||1,r=s(t.height)/e.offsetHeight||1;return 1!==n||1!==r}(n),m=d(n),y=p(e,c,o),g={scrollLeft:0,scrollTop:0},b={x:0,y:0};return(f||!f&&!o)&&(("body"!==l(n)||v(m))&&(g=(i=n)!==t(i)&&r(i)?{scrollLeft:(a=i).scrollLeft,scrollTop:a.scrollTop}:u(i)),r(n)?((b=p(n,!0)).x+=n.clientLeft,b.y+=n.clientTop):m&&(b.x=h(m))),{x:y.left+g.scrollLeft-b.x,y:y.top+g.scrollTop-b.y,width:y.width,height:y.height}}function g(e){var t=p(e),n=e.offsetWidth,r=e.offsetHeight;return Math.abs(t.width-n)<=1&&(n=t.width),Math.abs(t.height-r)<=1&&(r=t.height),{x:e.offsetLeft,y:e.offsetTop,width:n,height:r}}function b(e){return"html"===l(e)?e:e.assignedSlot||e.parentNode||(o(e)?e.host:null)||d(e)}function w(e){return["html","body","#document"].indexOf(l(e))>=0?e.ownerDocument.body:r(e)&&v(e)?e:w(b(e))}function x(e,n){var r;void 0===n&&(n=[]);var o=w(e),i=o===(null==(r=e.ownerDocument)?void 0:r.body),a=t(o),s=i?[a].concat(a.visualViewport||[],v(o)?o:[]):o,f=n.concat(s);return i?f:f.concat(x(b(s)))}function O(e){return["table","td","th"].indexOf(l(e))>=0}function j(e){return r(e)&&"fixed"!==m(e).position?e.offsetParent:null}function E(e){for(var n=t(e),i=j(e);i&&O(i)&&"static"===m(i).position;)i=j(i);return i&&("html"===l(i)||"body"===l(i)&&"static"===m(i).position)?n:i||function(e){var t=/firefox/i.test(f());if(/Trident/i.test(f())&&r(e)&&"fixed"===m(e).position)return null;var n=b(e);for(o(n)&&(n=n.host);r(n)&&["html","body"].indexOf(l(n))<0;){var i=m(n);if("none"!==i.transform||"none"!==i.perspective||"paint"===i.contain||-1!==["transform","perspective"].indexOf(i.willChange)||t&&"filter"===i.willChange||t&&i.filter&&"none"!==i.filter)return n;n=n.parentNode}return null}(e)||n}var D="top",A="bottom",L="right",P="left",M="auto",k=[D,A,L,P],W="start",B="end",H="viewport",T="popper",R=k.reduce((function(e,t){return e.concat([t+"-"+W,t+"-"+B])}),[]),S=[].concat(k,[M]).reduce((function(e,t){return e.concat([t,t+"-"+W,t+"-"+B])}),[]),V=["beforeRead","read","afterRead","beforeMain","main","afterMain","beforeWrite","write","afterWrite"];function q(e){var t=new Map,n=new Set,r=[];function o(e){n.add(e.name),[].concat(e.requires||[],e.requiresIfExists||[]).forEach((function(e){if(!n.has(e)){var r=t.get(e);r&&o(r)}})),r.push(e)}return e.forEach((function(e){t.set(e.name,e)})),e.forEach((function(e){n.has(e.name)||o(e)})),r}function C(e){return e.split("-")[0]}function N(e,t){var n=t.getRootNode&&t.getRootNode();if(e.contains(t))return!0;if(n&&o(n)){var r=t;do{if(r&&e.isSameNode(r))return!0;r=r.parentNode||r.host}while(r)}return!1}function I(e){return Object.assign({},e,{left:e.x,top:e.y,right:e.x+e.width,bottom:e.y+e.height})}function _(e,r,o){return r===H?I(function(e,n){var r=t(e),o=d(e),i=r.visualViewport,a=o.clientWidth,s=o.clientHeight,f=0,p=0;if(i){a=i.width,s=i.height;var u=c();(u||!u&&"fixed"===n)&&(f=i.offsetLeft,p=i.offsetTop)}return{width:a,height:s,x:f+h(e),y:p}}(e,o)):n(r)?function(e,t){var n=p(e,!1,"fixed"===t);return n.top=n.top+e.clientTop,n.left=n.left+e.clientLeft,n.bottom=n.top+e.clientHeight,n.right=n.left+e.clientWidth,n.width=e.clientWidth,n.height=e.clientHeight,n.x=n.left,n.y=n.top,n}(r,o):I(function(e){var t,n=d(e),r=u(e),o=null==(t=e.ownerDocument)?void 0:t.body,a=i(n.scrollWidth,n.clientWidth,o?o.scrollWidth:0,o?o.clientWidth:0),s=i(n.scrollHeight,n.clientHeight,o?o.scrollHeight:0,o?o.clientHeight:0),f=-r.scrollLeft+h(e),c=-r.scrollTop;return"rtl"===m(o||n).direction&&(f+=i(n.clientWidth,o?o.clientWidth:0)-a),{width:a,height:s,x:f,y:c}}(d(e)))}function F(e,t,o,s){var f="clippingParents"===t?function(e){var t=x(b(e)),o=["absolute","fixed"].indexOf(m(e).position)>=0&&r(e)?E(e):e;return n(o)?t.filter((function(e){return n(e)&&N(e,o)&&"body"!==l(e)})):[]}(e):[].concat(t),c=[].concat(f,[o]),p=c[0],u=c.reduce((function(t,n){var r=_(e,n,s);return t.top=i(r.top,t.top),t.right=a(r.right,t.right),t.bottom=a(r.bottom,t.bottom),t.left=i(r.left,t.left),t}),_(e,p,s));return u.width=u.right-u.left,u.height=u.bottom-u.top,u.x=u.left,u.y=u.top,u}function U(e){return e.split("-")[1]}function z(e){return["top","bottom"].indexOf(e)>=0?"x":"y"}function X(e){var t,n=e.reference,r=e.element,o=e.placement,i=o?C(o):null,a=o?U(o):null,s=n.x+n.width/2-r.width/2,f=n.y+n.height/2-r.height/2;switch(i){case D:t={x:s,y:n.y-r.height};break;case A:t={x:s,y:n.y+n.height};break;case L:t={x:n.x+n.width,y:f};break;case P:t={x:n.x-r.width,y:f};break;default:t={x:n.x,y:n.y}}var c=i?z(i):null;if(null!=c){var p="y"===c?"height":"width";switch(a){case W:t[c]=t[c]-(n[p]/2-r[p]/2);break;case B:t[c]=t[c]+(n[p]/2-r[p]/2)}}return t}function Y(e){return Object.assign({},{top:0,right:0,bottom:0,left:0},e)}function G(e,t){return t.reduce((function(t,n){return t[n]=e,t}),{})}function J(e,t){void 0===t&&(t={});var r=t,o=r.placement,i=void 0===o?e.placement:o,a=r.strategy,s=void 0===a?e.strategy:a,f=r.boundary,c=void 0===f?"clippingParents":f,u=r.rootBoundary,l=void 0===u?H:u,h=r.elementContext,m=void 0===h?T:h,v=r.altBoundary,y=void 0!==v&&v,g=r.padding,b=void 0===g?0:g,w=Y("number"!=typeof b?b:G(b,k)),x=m===T?"reference":T,O=e.rects.popper,j=e.elements[y?x:m],E=F(n(j)?j:j.contextElement||d(e.elements.popper),c,l,s),P=p(e.elements.reference),M=X({reference:P,element:O,strategy:"absolute",placement:i}),W=I(Object.assign({},O,M)),B=m===T?W:P,R={top:E.top-B.top+w.top,bottom:B.bottom-E.bottom+w.bottom,left:E.left-B.left+w.left,right:B.right-E.right+w.right},S=e.modifiersData.offset;if(m===T&&S){var V=S[i];Object.keys(R).forEach((function(e){var t=[L,A].indexOf(e)>=0?1:-1,n=[D,A].indexOf(e)>=0?"y":"x";R[e]+=V[n]*t}))}return R}var K={placement:"bottom",modifiers:[],strategy:"absolute"};function Q(){for(var e=arguments.length,t=new Array(e),n=0;n=0?-1:1,i="function"==typeof n?n(Object.assign({},t,{placement:e})):n,a=i[0],s=i[1];return a=a||0,s=(s||0)*o,[P,L].indexOf(r)>=0?{x:s,y:a}:{x:a,y:s}}(n,t.rects,i),e}),{}),s=a[t.placement],f=s.x,c=s.y;null!=t.modifiersData.popperOffsets&&(t.modifiersData.popperOffsets.x+=f,t.modifiersData.popperOffsets.y+=c),t.modifiersData[r]=a}},se={left:"right",right:"left",bottom:"top",top:"bottom"};function fe(e){return e.replace(/left|right|bottom|top/g,(function(e){return se[e]}))}var ce={start:"end",end:"start"};function pe(e){return e.replace(/start|end/g,(function(e){return ce[e]}))}function ue(e,t){void 0===t&&(t={});var n=t,r=n.placement,o=n.boundary,i=n.rootBoundary,a=n.padding,s=n.flipVariations,f=n.allowedAutoPlacements,c=void 0===f?S:f,p=U(r),u=p?s?R:R.filter((function(e){return U(e)===p})):k,l=u.filter((function(e){return c.indexOf(e)>=0}));0===l.length&&(l=u);var d=l.reduce((function(t,n){return t[n]=J(e,{placement:n,boundary:o,rootBoundary:i,padding:a})[C(n)],t}),{});return Object.keys(d).sort((function(e,t){return d[e]-d[t]}))}var le={name:"flip",enabled:!0,phase:"main",fn:function(e){var t=e.state,n=e.options,r=e.name;if(!t.modifiersData[r]._skip){for(var o=n.mainAxis,i=void 0===o||o,a=n.altAxis,s=void 0===a||a,f=n.fallbackPlacements,c=n.padding,p=n.boundary,u=n.rootBoundary,l=n.altBoundary,d=n.flipVariations,h=void 0===d||d,m=n.allowedAutoPlacements,v=t.options.placement,y=C(v),g=f||(y===v||!h?[fe(v)]:function(e){if(C(e)===M)return[];var t=fe(e);return[pe(e),t,pe(t)]}(v)),b=[v].concat(g).reduce((function(e,n){return e.concat(C(n)===M?ue(t,{placement:n,boundary:p,rootBoundary:u,padding:c,flipVariations:h,allowedAutoPlacements:m}):n)}),[]),w=t.rects.reference,x=t.rects.popper,O=new Map,j=!0,E=b[0],k=0;k=0,S=R?"width":"height",V=J(t,{placement:B,boundary:p,rootBoundary:u,altBoundary:l,padding:c}),q=R?T?L:P:T?A:D;w[S]>x[S]&&(q=fe(q));var N=fe(q),I=[];if(i&&I.push(V[H]<=0),s&&I.push(V[q]<=0,V[N]<=0),I.every((function(e){return e}))){E=B,j=!1;break}O.set(B,I)}if(j)for(var _=function(e){var t=b.find((function(t){var n=O.get(t);if(n)return n.slice(0,e).every((function(e){return e}))}));if(t)return E=t,"break"},F=h?3:1;F>0;F--){if("break"===_(F))break}t.placement!==E&&(t.modifiersData[r]._skip=!0,t.placement=E,t.reset=!0)}},requiresIfExists:["offset"],data:{_skip:!1}};function de(e,t,n){return i(e,a(t,n))}var he={name:"preventOverflow",enabled:!0,phase:"main",fn:function(e){var t=e.state,n=e.options,r=e.name,o=n.mainAxis,s=void 0===o||o,f=n.altAxis,c=void 0!==f&&f,p=n.boundary,u=n.rootBoundary,l=n.altBoundary,d=n.padding,h=n.tether,m=void 0===h||h,v=n.tetherOffset,y=void 0===v?0:v,b=J(t,{boundary:p,rootBoundary:u,padding:d,altBoundary:l}),w=C(t.placement),x=U(t.placement),O=!x,j=z(w),M="x"===j?"y":"x",k=t.modifiersData.popperOffsets,B=t.rects.reference,H=t.rects.popper,T="function"==typeof y?y(Object.assign({},t.rects,{placement:t.placement})):y,R="number"==typeof T?{mainAxis:T,altAxis:T}:Object.assign({mainAxis:0,altAxis:0},T),S=t.modifiersData.offset?t.modifiersData.offset[t.placement]:null,V={x:0,y:0};if(k){if(s){var q,N="y"===j?D:P,I="y"===j?A:L,_="y"===j?"height":"width",F=k[j],X=F+b[N],Y=F-b[I],G=m?-H[_]/2:0,K=x===W?B[_]:H[_],Q=x===W?-H[_]:-B[_],Z=t.elements.arrow,$=m&&Z?g(Z):{width:0,height:0},ee=t.modifiersData["arrow#persistent"]?t.modifiersData["arrow#persistent"].padding:{top:0,right:0,bottom:0,left:0},te=ee[N],ne=ee[I],re=de(0,B[_],$[_]),oe=O?B[_]/2-G-re-te-R.mainAxis:K-re-te-R.mainAxis,ie=O?-B[_]/2+G+re+ne+R.mainAxis:Q+re+ne+R.mainAxis,ae=t.elements.arrow&&E(t.elements.arrow),se=ae?"y"===j?ae.clientTop||0:ae.clientLeft||0:0,fe=null!=(q=null==S?void 0:S[j])?q:0,ce=F+ie-fe,pe=de(m?a(X,F+oe-fe-se):X,F,m?i(Y,ce):Y);k[j]=pe,V[j]=pe-F}if(c){var ue,le="x"===j?D:P,he="x"===j?A:L,me=k[M],ve="y"===M?"height":"width",ye=me+b[le],ge=me-b[he],be=-1!==[D,P].indexOf(w),we=null!=(ue=null==S?void 0:S[M])?ue:0,xe=be?ye:me-B[ve]-H[ve]-we+R.altAxis,Oe=be?me+B[ve]+H[ve]-we-R.altAxis:ge,je=m&&be?function(e,t,n){var r=de(e,t,n);return r>n?n:r}(xe,me,Oe):de(m?xe:ye,me,m?Oe:ge);k[M]=je,V[M]=je-me}t.modifiersData[r]=V}},requiresIfExists:["offset"]};var me={name:"arrow",enabled:!0,phase:"main",fn:function(e){var t,n=e.state,r=e.name,o=e.options,i=n.elements.arrow,a=n.modifiersData.popperOffsets,s=C(n.placement),f=z(s),c=[P,L].indexOf(s)>=0?"height":"width";if(i&&a){var p=function(e,t){return Y("number"!=typeof(e="function"==typeof e?e(Object.assign({},t.rects,{placement:t.placement})):e)?e:G(e,k))}(o.padding,n),u=g(i),l="y"===f?D:P,d="y"===f?A:L,h=n.rects.reference[c]+n.rects.reference[f]-a[f]-n.rects.popper[c],m=a[f]-n.rects.reference[f],v=E(i),y=v?"y"===f?v.clientHeight||0:v.clientWidth||0:0,b=h/2-m/2,w=p[l],x=y-u[c]-p[d],O=y/2-u[c]/2+b,j=de(w,O,x),M=f;n.modifiersData[r]=((t={})[M]=j,t.centerOffset=j-O,t)}},effect:function(e){var t=e.state,n=e.options.element,r=void 0===n?"[data-popper-arrow]":n;null!=r&&("string"!=typeof r||(r=t.elements.popper.querySelector(r)))&&N(t.elements.popper,r)&&(t.elements.arrow=r)},requires:["popperOffsets"],requiresIfExists:["preventOverflow"]};function ve(e,t,n){return void 0===n&&(n={x:0,y:0}),{top:e.top-t.height-n.y,right:e.right-t.width+n.x,bottom:e.bottom-t.height+n.y,left:e.left-t.width-n.x}}function ye(e){return[D,L,A,P].some((function(t){return e[t]>=0}))}var ge={name:"hide",enabled:!0,phase:"main",requiresIfExists:["preventOverflow"],fn:function(e){var t=e.state,n=e.name,r=t.rects.reference,o=t.rects.popper,i=t.modifiersData.preventOverflow,a=J(t,{elementContext:"reference"}),s=J(t,{altBoundary:!0}),f=ve(a,r),c=ve(s,o,i),p=ye(f),u=ye(c);t.modifiersData[n]={referenceClippingOffsets:f,popperEscapeOffsets:c,isReferenceHidden:p,hasPopperEscaped:u},t.attributes.popper=Object.assign({},t.attributes.popper,{"data-popper-reference-hidden":p,"data-popper-escaped":u})}},be=Z({defaultModifiers:[ee,te,oe,ie]}),we=[ee,te,oe,ie,ae,le,he,me,ge],xe=Z({defaultModifiers:we});e.applyStyles=ie,e.arrow=me,e.computeStyles=oe,e.createPopper=xe,e.createPopperLite=be,e.defaultModifiers=we,e.detectOverflow=J,e.eventListeners=ee,e.flip=le,e.hide=ge,e.offset=ae,e.popperGenerator=Z,e.popperOffsets=te,e.preventOverflow=he,Object.defineProperty(e,"__esModule",{value:!0})})); +//# sourceMappingURL=popper.min.js.map diff --git a/data/static/vendor/popper.min.js b/data/static/vendor/popper.min.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/popper.min.js @@ -0,0 +1,5 @@ +/* + Copyright (C) Federico Zivolo 2018 + Distributed under the MIT License (license terms are at http://opensource.org/licenses/MIT). + */(function(e,t){'object'==typeof exports&&'undefined'!=typeof module?module.exports=t():'function'==typeof define&&define.amd?define(t):e.Popper=t()})(this,function(){'use strict';function e(e){return e&&'[object Function]'==={}.toString.call(e)}function t(e,t){if(1!==e.nodeType)return[];var o=getComputedStyle(e,null);return t?o[t]:o}function o(e){return'HTML'===e.nodeName?e:e.parentNode||e.host}function n(e){if(!e)return document.body;switch(e.nodeName){case'HTML':case'BODY':return e.ownerDocument.body;case'#document':return e.body;}var i=t(e),r=i.overflow,p=i.overflowX,s=i.overflowY;return /(auto|scroll|overlay)/.test(r+s+p)?e:n(o(e))}function r(e){if(!e)return document.documentElement;for(var o=ie(10)?document.body:null,n=e.offsetParent;n===o&&e.nextElementSibling;)n=(e=e.nextElementSibling).offsetParent;var i=n&&n.nodeName;return i&&'BODY'!==i&&'HTML'!==i?-1!==['TD','TABLE'].indexOf(n.nodeName)&&'static'===t(n,'position')?r(n):n:e?e.ownerDocument.documentElement:document.documentElement}function p(e){var t=e.nodeName;return'BODY'!==t&&('HTML'===t||r(e.firstElementChild)===e)}function s(e){return null===e.parentNode?e:s(e.parentNode)}function d(e,t){if(!e||!e.nodeType||!t||!t.nodeType)return document.documentElement;var o=e.compareDocumentPosition(t)&Node.DOCUMENT_POSITION_FOLLOWING,n=o?e:t,i=o?t:e,a=document.createRange();a.setStart(n,0),a.setEnd(i,0);var l=a.commonAncestorContainer;if(e!==l&&t!==l||n.contains(i))return p(l)?l:r(l);var f=s(e);return f.host?d(f.host,t):d(e,s(t).host)}function a(e){var t=1=o.clientWidth&&n>=o.clientHeight}),l=0n[e]&&!t.escapeWithReference&&(i=X(p[o],n[e]-('right'===e?p.width:p.height))),se({},o,i)}};return i.forEach(function(e){var t=-1===['left','top'].indexOf(e)?'secondary':'primary';p=de({},p,s[t](e))}),e.offsets.popper=p,e},priority:['left','right','top','bottom'],padding:5,boundariesElement:'scrollParent'},keepTogether:{order:400,enabled:!0,fn:function(e){var t=e.offsets,o=t.popper,n=t.reference,i=e.placement.split('-')[0],r=J,p=-1!==['top','bottom'].indexOf(i),s=p?'right':'bottom',d=p?'left':'top',a=p?'width':'height';return o[s]r(n[s])&&(e.offsets.popper[d]=r(n[s])),e}},arrow:{order:500,enabled:!0,fn:function(e,o){var n;if(!q(e.instance.modifiers,'arrow','keepTogether'))return e;var i=o.element;if('string'==typeof i){if(i=e.instance.popper.querySelector(i),!i)return e;}else if(!e.instance.popper.contains(i))return console.warn('WARNING: `arrow.element` must be child of its popper element!'),e;var r=e.placement.split('-')[0],p=e.offsets,s=p.popper,d=p.reference,a=-1!==['left','right'].indexOf(r),l=a?'height':'width',f=a?'Top':'Left',m=f.toLowerCase(),h=a?'left':'top',g=a?'bottom':'right',u=L(i)[l];d[g]-us[g]&&(e.offsets.popper[m]+=d[m]+u-s[g]),e.offsets.popper=c(e.offsets.popper);var b=d[m]+d[l]/2-u/2,y=t(e.instance.popper),w=parseFloat(y['margin'+f],10),E=parseFloat(y['border'+f+'Width'],10),v=b-e.offsets.popper[m]-w-E;return v=Q(X(s[l]-u,v),0),e.arrowElement=i,e.offsets.arrow=(n={},se(n,m,Math.round(v)),se(n,h,''),n),e},element:'[x-arrow]'},flip:{order:600,enabled:!0,fn:function(e,t){if(P(e.instance.modifiers,'inner'))return e;if(e.flipped&&e.placement===e.originalPlacement)return e;var o=E(e.instance.popper,e.instance.reference,t.padding,t.boundariesElement,e.positionFixed),n=e.placement.split('-')[0],i=S(n),r=e.placement.split('-')[1]||'',p=[];switch(t.behavior){case fe.FLIP:p=[n,i];break;case fe.CLOCKWISE:p=V(n);break;case fe.COUNTERCLOCKWISE:p=V(n,!0);break;default:p=t.behavior;}return p.forEach(function(s,d){if(n!==s||p.length===d+1)return e;n=e.placement.split('-')[0],i=S(n);var a=e.offsets.popper,l=e.offsets.reference,f=J,m='left'===n&&f(a.right)>f(l.left)||'right'===n&&f(a.left)f(l.top)||'bottom'===n&&f(a.top)f(o.right),g=f(a.top)f(o.bottom),b='left'===n&&h||'right'===n&&c||'top'===n&&g||'bottom'===n&&u,y=-1!==['top','bottom'].indexOf(n),w=!!t.flipVariations&&(y&&'start'===r&&h||y&&'end'===r&&c||!y&&'start'===r&&g||!y&&'end'===r&&u);(m||b||w)&&(e.flipped=!0,(m||b)&&(n=p[d+1]),w&&(r=K(r)),e.placement=n+(r?'-'+r:''),e.offsets.popper=de({},e.offsets.popper,T(e.instance.popper,e.offsets.reference,e.placement)),e=N(e.instance.modifiers,e,'flip'))}),e},behavior:'flip',padding:5,boundariesElement:'viewport'},inner:{order:700,enabled:!1,fn:function(e){var t=e.placement,o=t.split('-')[0],n=e.offsets,i=n.popper,r=n.reference,p=-1!==['left','right'].indexOf(o),s=-1===['top','left'].indexOf(o);return i[p?'left':'top']=r[o]-(s?i[p?'width':'height']:0),e.placement=S(t),e.offsets.popper=c(i),e}},hide:{order:800,enabled:!0,fn:function(e){if(!q(e.instance.modifiers,'hide','preventOverflow'))return e;var t=e.offsets.reference,o=D(e.instance.modifiers,function(e){return'preventOverflow'===e.name}).boundaries;if(t.bottomo.right||t.top>o.bottom||t.right
    ',\n trigger: 'hover focus',\n offset: 0,\n arrowSelector: '.tooltip-arrow, .tooltip__arrow',\n innerSelector: '.tooltip-inner, .tooltip__inner',\n};\n\nexport default class Tooltip {\n /**\n * Create a new Tooltip.js instance\n * @class Tooltip\n * @param {HTMLElement} reference - The DOM node used as reference of the tooltip (it can be a jQuery element).\n * @param {Object} options\n * @param {String} options.placement='top'\n * Placement of the popper accepted values: `top(-start, -end), right(-start, -end), bottom(-start, -end),\n * left(-start, -end)`\n * @param {String} options.arrowSelector='.tooltip-arrow, .tooltip__arrow' - className used to locate the DOM arrow element in the tooltip.\n * @param {String} options.innerSelector='.tooltip-inner, .tooltip__inner' - className used to locate the DOM inner element in the tooltip.\n * @param {HTMLElement|String|false} options.container=false - Append the tooltip to a specific element.\n * @param {Number|Object} options.delay=0\n * Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type.\n * If a number is supplied, delay is applied to both hide/show.\n * Object structure is: `{ show: 500, hide: 100 }`\n * @param {Boolean} options.html=false - Insert HTML into the tooltip. If false, the content will inserted with `textContent`.\n * @param {String} [options.template='
    ']\n * Base HTML to used when creating the tooltip.\n * The tooltip's `title` will be injected into the `.tooltip-inner` or `.tooltip__inner`.\n * `.tooltip-arrow` or `.tooltip__arrow` will become the tooltip's arrow.\n * The outermost wrapper element should have the `.tooltip` class.\n * @param {String|HTMLElement|TitleFunction} options.title='' - Default title value if `title` attribute isn't present.\n * @param {String} [options.trigger='hover focus']\n * How tooltip is triggered - click, hover, focus, manual.\n * You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.\n * @param {Boolean} options.closeOnClickOutside=false - Close a popper on click outside of the popper and reference element. This has effect only when options.trigger is 'click'.\n * @param {String|HTMLElement} options.boundariesElement\n * The element used as boundaries for the tooltip. For more information refer to Popper.js'\n * [boundariesElement docs](https://popper.js.org/popper-documentation.html)\n * @param {Number|String} options.offset=0 - Offset of the tooltip relative to its reference. For more information refer to Popper.js'\n * [offset docs](https://popper.js.org/popper-documentation.html)\n * @param {Object} options.popperOptions={} - Popper options, will be passed directly to popper instance. For more information refer to Popper.js'\n * [options docs](https://popper.js.org/popper-documentation.html)\n * @return {Object} instance - The generated tooltip instance\n */\n constructor(reference, options) {\n // apply user options over default ones\n options = { ...DEFAULT_OPTIONS, ...options };\n\n reference.jquery && (reference = reference[0]);\n\n // cache reference and options\n this.reference = reference;\n this.options = options;\n\n // get events list\n const events =\n typeof options.trigger === 'string'\n ? options.trigger\n .split(' ')\n .filter(\n trigger => ['click', 'hover', 'focus'].indexOf(trigger) !== -1\n )\n : [];\n\n // set initial state\n this._isOpen = false;\n this._popperOptions = {};\n\n // set event listeners\n this._setEventListeners(reference, events, options);\n }\n\n //\n // Public methods\n //\n\n /**\n * Reveals an element's tooltip. This is considered a \"manual\" triggering of the tooltip.\n * Tooltips with zero-length titles are never displayed.\n * @method Tooltip#show\n * @memberof Tooltip\n */\n show = () => this._show(this.reference, this.options);\n\n /**\n * Hides an element’s tooltip. This is considered a “manual” triggering of the tooltip.\n * @method Tooltip#hide\n * @memberof Tooltip\n */\n hide = () => this._hide();\n\n /**\n * Hides and destroys an element’s tooltip.\n * @method Tooltip#dispose\n * @memberof Tooltip\n */\n dispose = () => this._dispose();\n\n /**\n * Toggles an element’s tooltip. This is considered a “manual” triggering of the tooltip.\n * @method Tooltip#toggle\n * @memberof Tooltip\n */\n toggle = () => {\n if (this._isOpen) {\n return this.hide();\n } else {\n return this.show();\n }\n };\n\n /**\n * Updates the tooltip's title content\n * @method Tooltip#updateTitleContent\n * @memberof Tooltip\n * @param {String|HTMLElement} title - The new content to use for the title\n */\n updateTitleContent = (title) => this._updateTitleContent(title);\n\n //\n // Private methods\n //\n\n _events = [];\n\n /**\n * Creates a new tooltip node\n * @memberof Tooltip\n * @private\n * @param {HTMLElement} reference\n * @param {String} template\n * @param {String|HTMLElement|TitleFunction} title\n * @param {Boolean} allowHtml\n * @return {HTMLElement} tooltipNode\n */\n _create(reference, template, title, allowHtml) {\n // create tooltip element\n const tooltipGenerator = window.document.createElement('div');\n tooltipGenerator.innerHTML = template.trim();\n const tooltipNode = tooltipGenerator.childNodes[0];\n\n // add unique ID to our tooltip (needed for accessibility reasons)\n tooltipNode.id = `tooltip_${Math.random()\n .toString(36)\n .substr(2, 10)}`;\n\n // set initial `aria-hidden` state to `false` (it's visible!)\n tooltipNode.setAttribute('aria-hidden', 'false');\n\n // add title to tooltip\n const titleNode = tooltipGenerator.querySelector(this.options.innerSelector);\n this._addTitleContent(reference, title, allowHtml, titleNode);\n\n // return the generated tooltip node\n return tooltipNode;\n }\n\n _addTitleContent(reference, title, allowHtml, titleNode) {\n if (title.nodeType === 1 || title.nodeType === 11) {\n // if title is a element node or document fragment, append it only if allowHtml is true\n allowHtml && titleNode.appendChild(title);\n } else if (isFunction(title)) {\n // if title is a function, call it and set textContent or innerHtml depending by `allowHtml` value\n const titleText = title.call(reference);\n allowHtml\n ? (titleNode.innerHTML = titleText)\n : (titleNode.textContent = titleText);\n } else {\n // if it's just a simple text, set textContent or innerHtml depending by `allowHtml` value\n allowHtml ? (titleNode.innerHTML = title) : (titleNode.textContent = title);\n }\n }\n\n _show(reference, options) {\n // don't show if it's already visible\n // or if it's not being showed\n if (this._isOpen && !this._isOpening) {\n return this;\n }\n this._isOpen = true;\n\n // if the tooltipNode already exists, just show it\n if (this._tooltipNode) {\n this._tooltipNode.style.visibility = 'visible';\n this._tooltipNode.setAttribute('aria-hidden', 'false');\n this.popperInstance.update();\n return this;\n }\n\n // get title\n const title = reference.getAttribute('title') || options.title;\n\n // don't show tooltip if no title is defined\n if (!title) {\n return this;\n }\n\n // create tooltip node\n const tooltipNode = this._create(\n reference,\n options.template,\n title,\n options.html\n );\n\n // Add `aria-describedby` to our reference element for accessibility reasons\n reference.setAttribute('aria-describedby', tooltipNode.id);\n\n // append tooltip to container\n const container = this._findContainer(options.container, reference);\n\n this._append(tooltipNode, container);\n\n this._popperOptions = {\n ...options.popperOptions,\n placement: options.placement,\n };\n\n this._popperOptions.modifiers = {\n ...this._popperOptions.modifiers,\n arrow: {\n element: this.options.arrowSelector,\n },\n offset: {\n offset: options.offset,\n },\n };\n\n if (options.boundariesElement) {\n this._popperOptions.modifiers.preventOverflow = {\n boundariesElement: options.boundariesElement,\n };\n }\n\n this.popperInstance = new Popper(\n reference,\n tooltipNode,\n this._popperOptions\n );\n\n this._tooltipNode = tooltipNode;\n\n return this;\n }\n\n _hide(/*reference, options*/) {\n // don't hide if it's already hidden\n if (!this._isOpen) {\n return this;\n }\n\n this._isOpen = false;\n\n // hide tooltipNode\n this._tooltipNode.style.visibility = 'hidden';\n this._tooltipNode.setAttribute('aria-hidden', 'true');\n\n return this;\n }\n\n _dispose() {\n // remove event listeners first to prevent any unexpected behaviour\n this._events.forEach(({ func, event }) => {\n this.reference.removeEventListener(event, func);\n });\n this._events = [];\n\n if (this._tooltipNode) {\n this._hide();\n\n // destroy instance\n this.popperInstance.destroy();\n\n // destroy tooltipNode if removeOnDestroy is not set, as popperInstance.destroy() already removes the element\n if (!this.popperInstance.options.removeOnDestroy) {\n this._tooltipNode.parentNode.removeChild(this._tooltipNode);\n this._tooltipNode = null;\n }\n }\n return this;\n }\n\n _findContainer(container, reference) {\n // if container is a query, get the relative element\n if (typeof container === 'string') {\n container = window.document.querySelector(container);\n } else if (container === false) {\n // if container is `false`, set it to reference parent\n container = reference.parentNode;\n }\n return container;\n }\n\n /**\n * Append tooltip to container\n * @memberof Tooltip\n * @private\n * @param {HTMLElement} tooltipNode\n * @param {HTMLElement|String|false} container\n */\n _append(tooltipNode, container) {\n container.appendChild(tooltipNode);\n }\n\n _setEventListeners(reference, events, options) {\n const directEvents = [];\n const oppositeEvents = [];\n\n events.forEach(event => {\n switch (event) {\n case 'hover':\n directEvents.push('mouseenter');\n oppositeEvents.push('mouseleave');\n break;\n case 'focus':\n directEvents.push('focus');\n oppositeEvents.push('blur');\n break;\n case 'click':\n directEvents.push('click');\n oppositeEvents.push('click');\n break;\n }\n });\n\n // schedule show tooltip\n directEvents.forEach(event => {\n const func = evt => {\n if (this._isOpening === true) {\n return;\n }\n evt.usedByTooltip = true;\n this._scheduleShow(reference, options.delay, options, evt);\n };\n this._events.push({ event, func });\n reference.addEventListener(event, func);\n });\n\n // schedule hide tooltip\n oppositeEvents.forEach(event => {\n const func = evt => {\n if (evt.usedByTooltip === true) {\n return;\n }\n this._scheduleHide(reference, options.delay, options, evt);\n };\n this._events.push({ event, func });\n reference.addEventListener(event, func);\n if (event === 'click' && options.closeOnClickOutside) {\n document.addEventListener('mousedown', e => {\n if (!this._isOpening) {\n return;\n }\n const popper = this.popperInstance.popper;\n if (reference.contains(e.target) ||\n popper.contains(e.target)) {\n return;\n }\n func(e);\n }, true);\n }\n });\n }\n\n _scheduleShow(reference, delay, options /*, evt */) {\n this._isOpening = true;\n // defaults to 0\n const computedDelay = (delay && delay.show) || delay || 0;\n this._showTimeout = window.setTimeout(\n () => this._show(reference, options),\n computedDelay\n );\n }\n\n _scheduleHide(reference, delay, options, evt) {\n this._isOpening = false;\n // defaults to 0\n const computedDelay = (delay && delay.hide) || delay || 0;\n window.setTimeout(() => {\n window.clearTimeout(this._showTimeout);\n if (this._isOpen === false) {\n return;\n }\n if (!document.body.contains(this._tooltipNode)) {\n return;\n }\n\n // if we are hiding because of a mouseleave, we must check that the new\n // reference isn't the tooltip, because in this case we don't want to hide it\n if (evt.type === 'mouseleave') {\n const isSet = this._setTooltipNodeEvent(evt, reference, delay, options);\n\n // if we set the new event, don't hide the tooltip yet\n // the new event will take care to hide it if necessary\n if (isSet) {\n return;\n }\n }\n\n this._hide(reference, options);\n }, computedDelay);\n }\n\n _setTooltipNodeEvent = (evt, reference, delay, options) => {\n const relatedreference =\n evt.relatedreference || evt.toElement || evt.relatedTarget;\n\n const callback = evt2 => {\n const relatedreference2 =\n evt2.relatedreference || evt2.toElement || evt2.relatedTarget;\n\n // Remove event listener after call\n this._tooltipNode.removeEventListener(evt.type, callback);\n\n // If the new reference is not the reference element\n if (!reference.contains(relatedreference2)) {\n // Schedule to hide tooltip\n this._scheduleHide(reference, options.delay, options, evt2);\n }\n };\n\n if (this._tooltipNode.contains(relatedreference)) {\n // listen to mouseleave on the tooltip element to be able to hide the tooltip\n this._tooltipNode.addEventListener(evt.type, callback);\n return true;\n }\n\n return false;\n };\n\n _updateTitleContent(title) {\n if(typeof this._tooltipNode === 'undefined') {\n if(typeof this.options.title !== 'undefined') {\n this.options.title = title;\n }\n return;\n }\n const titleNode = this._tooltipNode.parentNode.querySelector(this.options.innerSelector);\n this._clearTitleContent(titleNode, this.options.html, this.reference.getAttribute('title') || this.options.title)\n this._addTitleContent(this.reference, title, this.options.html, titleNode);\n this.options.title = title;\n this.popperInstance.update();\n }\n\n _clearTitleContent(titleNode, allowHtml, lastTitle) {\n if(lastTitle.nodeType === 1 || lastTitle.nodeType === 11) {\n allowHtml && titleNode.removeChild(lastTitle);\n } else {\n allowHtml ? titleNode.innerHTML = '' : titleNode.textContent = '';\n }\n }\n\n}\n\n/**\n * Title function, its context is the Tooltip instance.\n * @memberof Tooltip\n * @callback TitleFunction\n * @return {String} placement - The desired title.\n */\n"],"names":["functionToCheck","getType","toString","call","DEFAULT_OPTIONS","Tooltip","jquery","reference","options","events","trigger","split","filter","indexOf","_isOpen","_popperOptions","_setEventListeners","tooltipGenerator","window","document","createElement","innerHTML","template","trim","tooltipNode","childNodes","id","Math","random","substr","setAttribute","titleNode","querySelector","innerSelector","_addTitleContent","title","nodeType","appendChild","isFunction","titleText","textContent","_isOpening","_tooltipNode","style","visibility","popperInstance","update","getAttribute","_create","html","container","_findContainer","_append","popperOptions","placement","modifiers","arrowSelector","offset","boundariesElement","preventOverflow","_events","forEach","func","event","removeEventListener","_hide","destroy","removeOnDestroy","parentNode","removeChild","directEvents","oppositeEvents","push","usedByTooltip","_scheduleShow","delay","addEventListener","evt","_scheduleHide","closeOnClickOutside","popper","contains","e","target","computedDelay","show","_showTimeout","setTimeout","_show","hide","clearTimeout","body","type","isSet","_setTooltipNodeEvent","_clearTitleContent","lastTitle","dispose","_dispose","toggle","updateTitleContent","_updateTitleContent","relatedreference","toElement","relatedTarget","relatedreference2","evt2"],"mappings":";;;kOAOA,aAAoD,OAGhDA,IAC2C,mBAA3CC,MAAQC,QAARD,CAAiBE,IAAjBF,yiBCREG,EAAkB,aAAA,OAEf,CAFe,QAAA,WAIX,KAJW,OAKf,EALe,UAOpB,8GAPoB,SAQb,aARa,QASd,CATc,eAUP,iCAVO,eAWP,iCAXO,EAcHC,4BAoCa,UAAA,aAAA,YAAA,GAIpBC,SAAWC,EAAYA,EAAU,CAAVA,EAJH,MAOzBA,WAPyB,MAQzBC,SARyB,IAWxBC,GACuB,QAA3B,QAAOD,GAAQE,OAAf,CACIF,EAAQE,OAARF,CACGG,KADHH,CACS,GADTA,EAEGI,MAFHJ,CAGI,kBAA4D,CAAC,CAAlD,6BAA4BK,OAA5B,GAHf,CAAAL,CADJ,SASGM,UArByB,MAsBzBC,iBAtByB,MAyBzBC,4EAkEwC,IAEvCC,GAAmBC,OAAOC,QAAPD,CAAgBE,aAAhBF,CAA8B,KAA9BA,IACRG,UAAYC,EAASC,IAATD,EAHgB,IAIvCE,GAAcP,EAAiBQ,UAAjBR,CAA4B,CAA5BA,IAGRS,cAAgBC,KAAKC,MAALD,GACzBzB,QADyByB,CAChB,EADgBA,EAEzBE,MAFyBF,CAElB,CAFkBA,CAEf,EAFeA,CAPiB,GAYjCG,aAAa,cAAe,QAZK,IAevCC,GAAYd,EAAiBe,aAAjBf,CAA+B,KAAKT,OAAL,CAAayB,aAA5ChB,cACbiB,6EAMkD,IAChC,CAAnBC,KAAMC,QAAND,EAA2C,EAAnBA,KAAMC,YAEnBL,EAAUM,WAAVN,QACR,IAAIO,IAAJ,CAAuB,IAEtBC,GAAYJ,EAAMhC,IAANgC,MAEbJ,EAAUV,SAAVU,GACAA,EAAUS,WAAVT,EALA,CAAA,OAQQA,EAAUV,SAAVU,GAAgCA,EAAUS,WAAVT,qCAIvB,IAGpB,KAAKjB,OAAL,EAAgB,CAAC,KAAK2B,iBACjB,cAEJ3B,WAGD,KAAK4B,yBACFA,aAAaC,MAAMC,WAAa,eAChCF,aAAaZ,aAAa,cAAe,cACzCe,eAAeC,SACb,QAIHX,GAAQ5B,EAAUwC,YAAVxC,CAAuB,OAAvBA,GAAmCC,EAAQ2B,SAGrD,SACK,SAIHX,GAAc,KAAKwB,OAAL,GAElBxC,EAAQc,QAFU,GAIlBd,EAAQyC,IAJU,IAQVnB,aAAa,mBAAoBN,EAAYE,GAjC/B,IAoClBwB,GAAY,KAAKC,cAAL,CAAoB3C,EAAQ0C,SAA5B,gBAEbE,kBAEArC,oBACAP,EAAQ6C,yBACA7C,EAAQ8C,iBAGhBvC,eAAewC,eACf,KAAKxC,cAAL,CAAoBwC,iBAChB,SACI,KAAK/C,OAAL,CAAagD,aADjB,SAGC,QACEhD,EAAQiD,MADV,IAKNjD,EAAQkD,yBACL3C,eAAewC,UAAUI,gBAAkB,mBAC3BnD,EAAQkD,iBADmB,QAK7Cb,eAAiB,UAGpB,KAAK9B,cAHe,OAMjB2B,eAEE,oCAGqB,OAEvB,MAAK5B,OAFkB,OAMvBA,UANuB,MASvB4B,aAAaC,MAAMC,WAAa,QATT,MAUvBF,aAAaZ,aAAa,cAAe,OAVlB,CAYrB,IAZqB,EAGnB,uCAYA,wBAEJ8B,QAAQC,QAAQ,WAAqB,IAAlBC,KAAAA,KAAMC,IAAAA,QACvBxD,UAAUyD,wBADjB,QAGKJ,WAED,KAAKlB,oBACFuB,aAGApB,eAAeqB,UAGhB,CAAC,KAAKrB,cAAL,CAAoBrC,OAApB,CAA4B2D,uBAC1BzB,aAAa0B,WAAWC,YAAY,KAAK3B,mBACzCA,aAAe,OAGjB,gDAG4B,OAEV,QAArB,aACUxB,OAAOC,QAAPD,CAAgBc,aAAhBd,IACHgC,WAEG3C,EAAU6D,kDAYM,GACpB/B,gEAGmC,YACvCiC,KACAC,OAECV,QAAQ,WAAS,CAEf,OAFe,QAGLW,KAAK,aAHA,GAIHA,KAAK,aAJF,EAMf,OANe,QAOLA,KAAK,QAPA,GAQHA,KAAK,OARF,EAUf,OAVe,QAWLA,KAAK,QAXA,GAYHA,KAAK,QAZF,QAAxB,EAJ6C,GAsBhCX,QAAQ,WAAS,IACtBC,GAAO,WAAO,CACd,OAAKrB,UADS,KAIdgC,gBAJc,GAKbC,gBAAyBlE,EAAQmE,UALpB,CAApB,IAOKf,QAAQY,KAAK,CAAET,OAAF,CAASD,MAAT,EARU,GASlBc,qBATZ,EAtB6C,GAmC9Bf,QAAQ,WAAS,IACxBC,GAAO,WAAO,CACde,OAAIJ,aADU,IAIbK,gBAAyBtE,EAAQmE,UAJxC,IAMKf,QAAQY,KAAK,CAAET,OAAF,CAASD,MAAT,EAPY,GAQpBc,qBARoB,CAShB,OAAVb,MAAqBvD,EAAQuE,mBATH,WAUnBH,iBAAiB,YAAa,WAAK,IACrC,EAAKnC,eAGJuC,GAAS,EAAKnC,cAAL,CAAoBmC,OAC/BzE,EAAU0E,QAAV1E,CAAmB2E,EAAEC,MAArB5E,GACAyE,EAAOC,QAAPD,CAAgBE,EAAEC,MAAlBH,QANN,KAVJ,+CAyBkD,iBAC7CvC,aAD6C,IAG5C2C,GAAiBT,GAASA,EAAMU,IAAfV,KAAiC,OACnDW,aAAepE,OAAOqE,UAAPrE,CAClB,iBAAM,GAAKsE,KAAL,KADY,CAAAtE,kDAMwB,iBACvCuB,aADuC,IAGtC2C,GAAiBT,GAASA,EAAMc,IAAfd,KAAiC,SACjDY,WAAW,UAAM,YACfG,aAAa,EAAKJ,cACrB,OAAKxE,UAGJK,SAASwE,IAATxE,CAAc8D,QAAd9D,CAAuB,EAAKuB,YAA5BvB,MAMY,YAAb0D,KAAIe,KAAuB,IACvBC,GAAQ,EAAKC,oBAAL,wBASX7B,WArBP,mDAoDyB,IACO,WAA7B,QAAO,MAAKvB,yBACoB,WAA9B,QAAO,MAAKlC,OAAL,CAAa2B,aAChB3B,QAAQ2B,aAIXJ,GAAY,KAAKW,YAAL,CAAkB0B,UAAlB,CAA6BpC,aAA7B,CAA2C,KAAKxB,OAAL,CAAayB,aAAxD,OACb8D,qBAA8B,KAAKvF,OAAL,CAAayC,KAAM,KAAK1C,SAAL,CAAewC,YAAf,CAA4B,OAA5B,GAAwC,KAAKvC,OAAL,CAAa2B,MARlF,MASpBD,iBAAiB,KAAK3B,YAAkB,KAAKC,OAAL,CAAayC,OATjC,MAUpBzC,QAAQ2B,OAVY,MAWpBU,eAAeC,0DAG8B,CACxB,CAAvBkD,KAAU5D,QAAV4D,EAAmD,EAAvBA,KAAU5D,QADS,IAEnCL,EAAUsC,WAAVtC,GAFmC,GAIpCA,EAAUV,SAAVU,CAAsB,GAAKA,EAAUS,WAAVT,CAAwB,yCA9WnEsD,KAAO,iBAAM,GAAKG,KAAL,CAAW,EAAKjF,SAAhB,CAA2B,EAAKC,OAAhC,QAObiF,KAAO,iBAAM,GAAKxB,KAAL,SAObgC,QAAU,iBAAM,GAAKC,QAAL,SAOhBC,OAAS,UAAM,OACT,GAAKrF,OADI,CAEJ,EAAK2E,IAAL,EAFI,CAIJ,EAAKJ,IAAL,SAUXe,mBAAqB,kBAAW,GAAKC,mBAAL,UAMhCzC,gBAwRAkC,qBAAuB,iBAAoC,IACnDQ,GACJzB,EAAIyB,gBAAJzB,EAAwBA,EAAI0B,SAA5B1B,EAAyCA,EAAI2B,cAFU,QAkBrD,EAAK9D,YAAL,CAAkBuC,QAAlB,GAlBqD,KAoBlDvC,aAAakC,iBAAiBC,EAAIe,KAhBxB,aAAQ,IACjBa,GACJC,EAAKJ,gBAALI,EAAyBA,EAAKH,SAA9BG,EAA2CA,EAAKF,gBAG7C9D,aAAasB,oBAAoBa,EAAIe,OALnB,CAQlBrF,EAAU0E,QAAV1E,GARkB,IAUhBuE,gBAAyBtE,EAAQmE,UAV1C,EAJyD"} diff --git a/data/static/vendor/select2.min.css b/data/static/vendor/select2.min.css new file mode 100644 --- /dev/null +++ b/data/static/vendor/select2.min.css @@ -0,0 +1,1 @@ +.select2-container{box-sizing:border-box;display:inline-block;margin:0;position:relative;vertical-align:middle}.select2-container .select2-selection--single{box-sizing:border-box;cursor:pointer;display:block;height:28px;user-select:none;-webkit-user-select:none}.select2-container .select2-selection--single .select2-selection__rendered{display:block;padding-left:8px;padding-right:20px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.select2-container .select2-selection--single .select2-selection__clear{position:relative}.select2-container[dir="rtl"] .select2-selection--single .select2-selection__rendered{padding-right:8px;padding-left:20px}.select2-container .select2-selection--multiple{box-sizing:border-box;cursor:pointer;display:block;min-height:32px;user-select:none;-webkit-user-select:none}.select2-container .select2-selection--multiple .select2-selection__rendered{display:inline-block;overflow:hidden;padding-left:8px;text-overflow:ellipsis;white-space:nowrap}.select2-container .select2-search--inline{float:left}.select2-container .select2-search--inline .select2-search__field{box-sizing:border-box;border:none;font-size:100%;margin-top:5px;padding:0}.select2-container .select2-search--inline .select2-search__field::-webkit-search-cancel-button{-webkit-appearance:none}.select2-dropdown{background-color:white;border:1px solid #aaa;border-radius:4px;box-sizing:border-box;display:block;position:absolute;left:-100000px;width:100%;z-index:1051}.select2-results{display:block}.select2-results__options{list-style:none;margin:0;padding:0}.select2-results__option{padding:6px;user-select:none;-webkit-user-select:none}.select2-results__option[aria-selected]{cursor:pointer}.select2-container--open .select2-dropdown{left:0}.select2-container--open .select2-dropdown--above{border-bottom:none;border-bottom-left-radius:0;border-bottom-right-radius:0}.select2-container--open .select2-dropdown--below{border-top:none;border-top-left-radius:0;border-top-right-radius:0}.select2-search--dropdown{display:block;padding:4px}.select2-search--dropdown .select2-search__field{padding:4px;width:100%;box-sizing:border-box}.select2-search--dropdown .select2-search__field::-webkit-search-cancel-button{-webkit-appearance:none}.select2-search--dropdown.select2-search--hide{display:none}.select2-close-mask{border:0;margin:0;padding:0;display:block;position:fixed;left:0;top:0;min-height:100%;min-width:100%;height:auto;width:auto;opacity:0;z-index:99;background-color:#fff;filter:alpha(opacity=0)}.select2-hidden-accessible{border:0 !important;clip:rect(0 0 0 0) !important;-webkit-clip-path:inset(50%) !important;clip-path:inset(50%) !important;height:1px !important;overflow:hidden !important;padding:0 !important;position:absolute !important;width:1px !important;white-space:nowrap !important}.select2-container--default .select2-selection--single{background-color:#fff;border:1px solid #aaa;border-radius:4px}.select2-container--default .select2-selection--single .select2-selection__rendered{color:#444;line-height:28px}.select2-container--default .select2-selection--single .select2-selection__clear{cursor:pointer;float:right;font-weight:bold}.select2-container--default .select2-selection--single .select2-selection__placeholder{color:#999}.select2-container--default .select2-selection--single .select2-selection__arrow{height:26px;position:absolute;top:1px;right:1px;width:20px}.select2-container--default .select2-selection--single .select2-selection__arrow b{border-color:#888 transparent transparent transparent;border-style:solid;border-width:5px 4px 0 4px;height:0;left:50%;margin-left:-4px;margin-top:-2px;position:absolute;top:50%;width:0}.select2-container--default[dir="rtl"] .select2-selection--single .select2-selection__clear{float:left}.select2-container--default[dir="rtl"] .select2-selection--single .select2-selection__arrow{left:1px;right:auto}.select2-container--default.select2-container--disabled .select2-selection--single{background-color:#eee;cursor:default}.select2-container--default.select2-container--disabled .select2-selection--single .select2-selection__clear{display:none}.select2-container--default.select2-container--open .select2-selection--single .select2-selection__arrow b{border-color:transparent transparent #888 transparent;border-width:0 4px 5px 4px}.select2-container--default .select2-selection--multiple{background-color:white;border:1px solid #aaa;border-radius:4px;cursor:text}.select2-container--default .select2-selection--multiple .select2-selection__rendered{box-sizing:border-box;list-style:none;margin:0;padding:0 5px;width:100%}.select2-container--default .select2-selection--multiple .select2-selection__rendered li{list-style:none}.select2-container--default .select2-selection--multiple .select2-selection__clear{cursor:pointer;float:right;font-weight:bold;margin-top:5px;margin-right:10px;padding:1px}.select2-container--default .select2-selection--multiple .select2-selection__choice{background-color:#e4e4e4;border:1px solid #aaa;border-radius:4px;cursor:default;float:left;margin-right:5px;margin-top:5px;padding:0 5px}.select2-container--default .select2-selection--multiple .select2-selection__choice__remove{color:#999;cursor:pointer;display:inline-block;font-weight:bold;margin-right:2px}.select2-container--default .select2-selection--multiple .select2-selection__choice__remove:hover{color:#333}.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice,.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-search--inline{float:right}.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice{margin-left:5px;margin-right:auto}.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice__remove{margin-left:2px;margin-right:auto}.select2-container--default.select2-container--focus .select2-selection--multiple{border:solid black 1px;outline:0}.select2-container--default.select2-container--disabled .select2-selection--multiple{background-color:#eee;cursor:default}.select2-container--default.select2-container--disabled .select2-selection__choice__remove{display:none}.select2-container--default.select2-container--open.select2-container--above .select2-selection--single,.select2-container--default.select2-container--open.select2-container--above .select2-selection--multiple{border-top-left-radius:0;border-top-right-radius:0}.select2-container--default.select2-container--open.select2-container--below .select2-selection--single,.select2-container--default.select2-container--open.select2-container--below .select2-selection--multiple{border-bottom-left-radius:0;border-bottom-right-radius:0}.select2-container--default .select2-search--dropdown .select2-search__field{border:1px solid #aaa}.select2-container--default .select2-search--inline .select2-search__field{background:transparent;border:none;outline:0;box-shadow:none;-webkit-appearance:textfield}.select2-container--default .select2-results>.select2-results__options{max-height:200px;overflow-y:auto}.select2-container--default .select2-results__option[role=group]{padding:0}.select2-container--default .select2-results__option[aria-disabled=true]{color:#999}.select2-container--default .select2-results__option[aria-selected=true]{background-color:#ddd}.select2-container--default .select2-results__option .select2-results__option{padding-left:1em}.select2-container--default .select2-results__option .select2-results__option .select2-results__group{padding-left:0}.select2-container--default .select2-results__option .select2-results__option .select2-results__option{margin-left:-1em;padding-left:2em}.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option{margin-left:-2em;padding-left:3em}.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option{margin-left:-3em;padding-left:4em}.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option{margin-left:-4em;padding-left:5em}.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option{margin-left:-5em;padding-left:6em}.select2-container--default .select2-results__option--highlighted[aria-selected]{background-color:#5897fb;color:white}.select2-container--default .select2-results__group{cursor:default;display:block;padding:6px}.select2-container--classic .select2-selection--single{background-color:#f7f7f7;border:1px solid #aaa;border-radius:4px;outline:0;background-image:-webkit-linear-gradient(top, #fff 50%, #eee 100%);background-image:-o-linear-gradient(top, #fff 50%, #eee 100%);background-image:linear-gradient(to bottom, #fff 50%, #eee 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFFFF', endColorstr='#FFEEEEEE', GradientType=0)}.select2-container--classic .select2-selection--single:focus{border:1px solid #5897fb}.select2-container--classic .select2-selection--single .select2-selection__rendered{color:#444;line-height:28px}.select2-container--classic .select2-selection--single .select2-selection__clear{cursor:pointer;float:right;font-weight:bold;margin-right:10px}.select2-container--classic .select2-selection--single .select2-selection__placeholder{color:#999}.select2-container--classic .select2-selection--single .select2-selection__arrow{background-color:#ddd;border:none;border-left:1px solid #aaa;border-top-right-radius:4px;border-bottom-right-radius:4px;height:26px;position:absolute;top:1px;right:1px;width:20px;background-image:-webkit-linear-gradient(top, #eee 50%, #ccc 100%);background-image:-o-linear-gradient(top, #eee 50%, #ccc 100%);background-image:linear-gradient(to bottom, #eee 50%, #ccc 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFEEEEEE', endColorstr='#FFCCCCCC', GradientType=0)}.select2-container--classic .select2-selection--single .select2-selection__arrow b{border-color:#888 transparent transparent transparent;border-style:solid;border-width:5px 4px 0 4px;height:0;left:50%;margin-left:-4px;margin-top:-2px;position:absolute;top:50%;width:0}.select2-container--classic[dir="rtl"] .select2-selection--single .select2-selection__clear{float:left}.select2-container--classic[dir="rtl"] .select2-selection--single .select2-selection__arrow{border:none;border-right:1px solid #aaa;border-radius:0;border-top-left-radius:4px;border-bottom-left-radius:4px;left:1px;right:auto}.select2-container--classic.select2-container--open .select2-selection--single{border:1px solid #5897fb}.select2-container--classic.select2-container--open .select2-selection--single .select2-selection__arrow{background:transparent;border:none}.select2-container--classic.select2-container--open .select2-selection--single .select2-selection__arrow b{border-color:transparent transparent #888 transparent;border-width:0 4px 5px 4px}.select2-container--classic.select2-container--open.select2-container--above .select2-selection--single{border-top:none;border-top-left-radius:0;border-top-right-radius:0;background-image:-webkit-linear-gradient(top, #fff 0%, #eee 50%);background-image:-o-linear-gradient(top, #fff 0%, #eee 50%);background-image:linear-gradient(to bottom, #fff 0%, #eee 50%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFFFF', endColorstr='#FFEEEEEE', GradientType=0)}.select2-container--classic.select2-container--open.select2-container--below .select2-selection--single{border-bottom:none;border-bottom-left-radius:0;border-bottom-right-radius:0;background-image:-webkit-linear-gradient(top, #eee 50%, #fff 100%);background-image:-o-linear-gradient(top, #eee 50%, #fff 100%);background-image:linear-gradient(to bottom, #eee 50%, #fff 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFEEEEEE', endColorstr='#FFFFFFFF', GradientType=0)}.select2-container--classic .select2-selection--multiple{background-color:white;border:1px solid #aaa;border-radius:4px;cursor:text;outline:0}.select2-container--classic .select2-selection--multiple:focus{border:1px solid #5897fb}.select2-container--classic .select2-selection--multiple .select2-selection__rendered{list-style:none;margin:0;padding:0 5px}.select2-container--classic .select2-selection--multiple .select2-selection__clear{display:none}.select2-container--classic .select2-selection--multiple .select2-selection__choice{background-color:#e4e4e4;border:1px solid #aaa;border-radius:4px;cursor:default;float:left;margin-right:5px;margin-top:5px;padding:0 5px}.select2-container--classic .select2-selection--multiple .select2-selection__choice__remove{color:#888;cursor:pointer;display:inline-block;font-weight:bold;margin-right:2px}.select2-container--classic .select2-selection--multiple .select2-selection__choice__remove:hover{color:#555}.select2-container--classic[dir="rtl"] .select2-selection--multiple .select2-selection__choice{float:right;margin-left:5px;margin-right:auto}.select2-container--classic[dir="rtl"] .select2-selection--multiple .select2-selection__choice__remove{margin-left:2px;margin-right:auto}.select2-container--classic.select2-container--open .select2-selection--multiple{border:1px solid #5897fb}.select2-container--classic.select2-container--open.select2-container--above .select2-selection--multiple{border-top:none;border-top-left-radius:0;border-top-right-radius:0}.select2-container--classic.select2-container--open.select2-container--below .select2-selection--multiple{border-bottom:none;border-bottom-left-radius:0;border-bottom-right-radius:0}.select2-container--classic .select2-search--dropdown .select2-search__field{border:1px solid #aaa;outline:0}.select2-container--classic .select2-search--inline .select2-search__field{outline:0;box-shadow:none}.select2-container--classic .select2-dropdown{background-color:#fff;border:1px solid transparent}.select2-container--classic .select2-dropdown--above{border-bottom:none}.select2-container--classic .select2-dropdown--below{border-top:none}.select2-container--classic .select2-results>.select2-results__options{max-height:200px;overflow-y:auto}.select2-container--classic .select2-results__option[role=group]{padding:0}.select2-container--classic .select2-results__option[aria-disabled=true]{color:grey}.select2-container--classic .select2-results__option--highlighted[aria-selected]{background-color:#3875d7;color:#fff}.select2-container--classic .select2-results__group{cursor:default;display:block;padding:6px}.select2-container--classic.select2-container--open .select2-dropdown{border-color:#5897fb} diff --git a/data/static/vendor/select2.min.js b/data/static/vendor/select2.min.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/select2.min.js @@ -0,0 +1,2 @@ +/*! Select2 4.0.13 | https://github.com/select2/select2/blob/master/LICENSE.md */ +!function(n){"function"==typeof define&&define.amd?define(["jquery"],n):"object"==typeof module&&module.exports?module.exports=function(e,t){return void 0===t&&(t="undefined"!=typeof window?require("jquery"):require("jquery")(e)),n(t),t}:n(jQuery)}(function(u){var e=function(){if(u&&u.fn&&u.fn.select2&&u.fn.select2.amd)var e=u.fn.select2.amd;var t,n,r,h,o,s,f,g,m,v,y,_,i,a,b;function w(e,t){return i.call(e,t)}function l(e,t){var n,r,i,o,s,a,l,c,u,d,p,h=t&&t.split("/"),f=y.map,g=f&&f["*"]||{};if(e){for(s=(e=e.split("/")).length-1,y.nodeIdCompat&&b.test(e[s])&&(e[s]=e[s].replace(b,"")),"."===e[0].charAt(0)&&h&&(e=h.slice(0,h.length-1).concat(e)),u=0;u":">",'"':""","'":"'","/":"/"};return"string"!=typeof e?e:String(e).replace(/[&<>"'\/\\]/g,function(e){return t[e]})},i.appendMany=function(e,t){if("1.7"===o.fn.jquery.substr(0,3)){var n=o();o.map(t,function(e){n=n.add(e)}),t=n}e.append(t)},i.__cache={};var n=0;return i.GetUniqueElementId=function(e){var t=e.getAttribute("data-select2-id");return null==t&&(e.id?(t=e.id,e.setAttribute("data-select2-id",t)):(e.setAttribute("data-select2-id",++n),t=n.toString())),t},i.StoreData=function(e,t,n){var r=i.GetUniqueElementId(e);i.__cache[r]||(i.__cache[r]={}),i.__cache[r][t]=n},i.GetData=function(e,t){var n=i.GetUniqueElementId(e);return t?i.__cache[n]&&null!=i.__cache[n][t]?i.__cache[n][t]:o(e).data(t):i.__cache[n]},i.RemoveData=function(e){var t=i.GetUniqueElementId(e);null!=i.__cache[t]&&delete i.__cache[t],e.removeAttribute("data-select2-id")},i}),e.define("select2/results",["jquery","./utils"],function(h,f){function r(e,t,n){this.$element=e,this.data=n,this.options=t,r.__super__.constructor.call(this)}return f.Extend(r,f.Observable),r.prototype.render=function(){var e=h('
      ');return this.options.get("multiple")&&e.attr("aria-multiselectable","true"),this.$results=e},r.prototype.clear=function(){this.$results.empty()},r.prototype.displayMessage=function(e){var t=this.options.get("escapeMarkup");this.clear(),this.hideLoading();var n=h(''),r=this.options.get("translations").get(e.message);n.append(t(r(e.args))),n[0].className+=" select2-results__message",this.$results.append(n)},r.prototype.hideMessages=function(){this.$results.find(".select2-results__message").remove()},r.prototype.append=function(e){this.hideLoading();var t=[];if(null!=e.results&&0!==e.results.length){e.results=this.sort(e.results);for(var n=0;n",{class:"select2-results__options select2-results__options--nested"});p.append(l),s.append(a),s.append(p)}else this.template(e,t);return f.StoreData(t,"data",e),t},r.prototype.bind=function(t,e){var l=this,n=t.id+"-results";this.$results.attr("id",n),t.on("results:all",function(e){l.clear(),l.append(e.data),t.isOpen()&&(l.setClasses(),l.highlightFirstItem())}),t.on("results:append",function(e){l.append(e.data),t.isOpen()&&l.setClasses()}),t.on("query",function(e){l.hideMessages(),l.showLoading(e)}),t.on("select",function(){t.isOpen()&&(l.setClasses(),l.options.get("scrollAfterSelect")&&l.highlightFirstItem())}),t.on("unselect",function(){t.isOpen()&&(l.setClasses(),l.options.get("scrollAfterSelect")&&l.highlightFirstItem())}),t.on("open",function(){l.$results.attr("aria-expanded","true"),l.$results.attr("aria-hidden","false"),l.setClasses(),l.ensureHighlightVisible()}),t.on("close",function(){l.$results.attr("aria-expanded","false"),l.$results.attr("aria-hidden","true"),l.$results.removeAttr("aria-activedescendant")}),t.on("results:toggle",function(){var e=l.getHighlightedResults();0!==e.length&&e.trigger("mouseup")}),t.on("results:select",function(){var e=l.getHighlightedResults();if(0!==e.length){var t=f.GetData(e[0],"data");"true"==e.attr("aria-selected")?l.trigger("close",{}):l.trigger("select",{data:t})}}),t.on("results:previous",function(){var e=l.getHighlightedResults(),t=l.$results.find("[aria-selected]"),n=t.index(e);if(!(n<=0)){var r=n-1;0===e.length&&(r=0);var i=t.eq(r);i.trigger("mouseenter");var o=l.$results.offset().top,s=i.offset().top,a=l.$results.scrollTop()+(s-o);0===r?l.$results.scrollTop(0):s-o<0&&l.$results.scrollTop(a)}}),t.on("results:next",function(){var e=l.getHighlightedResults(),t=l.$results.find("[aria-selected]"),n=t.index(e)+1;if(!(n>=t.length)){var r=t.eq(n);r.trigger("mouseenter");var i=l.$results.offset().top+l.$results.outerHeight(!1),o=r.offset().top+r.outerHeight(!1),s=l.$results.scrollTop()+o-i;0===n?l.$results.scrollTop(0):ithis.$results.outerHeight()||o<0)&&this.$results.scrollTop(i)}},r.prototype.template=function(e,t){var n=this.options.get("templateResult"),r=this.options.get("escapeMarkup"),i=n(e,t);null==i?t.style.display="none":"string"==typeof i?t.innerHTML=r(i):h(t).append(i)},r}),e.define("select2/keys",[],function(){return{BACKSPACE:8,TAB:9,ENTER:13,SHIFT:16,CTRL:17,ALT:18,ESC:27,SPACE:32,PAGE_UP:33,PAGE_DOWN:34,END:35,HOME:36,LEFT:37,UP:38,RIGHT:39,DOWN:40,DELETE:46}}),e.define("select2/selection/base",["jquery","../utils","../keys"],function(n,r,i){function o(e,t){this.$element=e,this.options=t,o.__super__.constructor.call(this)}return r.Extend(o,r.Observable),o.prototype.render=function(){var e=n('');return this._tabindex=0,null!=r.GetData(this.$element[0],"old-tabindex")?this._tabindex=r.GetData(this.$element[0],"old-tabindex"):null!=this.$element.attr("tabindex")&&(this._tabindex=this.$element.attr("tabindex")),e.attr("title",this.$element.attr("title")),e.attr("tabindex",this._tabindex),e.attr("aria-disabled","false"),this.$selection=e},o.prototype.bind=function(e,t){var n=this,r=e.id+"-results";this.container=e,this.$selection.on("focus",function(e){n.trigger("focus",e)}),this.$selection.on("blur",function(e){n._handleBlur(e)}),this.$selection.on("keydown",function(e){n.trigger("keypress",e),e.which===i.SPACE&&e.preventDefault()}),e.on("results:focus",function(e){n.$selection.attr("aria-activedescendant",e.data._resultId)}),e.on("selection:update",function(e){n.update(e.data)}),e.on("open",function(){n.$selection.attr("aria-expanded","true"),n.$selection.attr("aria-owns",r),n._attachCloseHandler(e)}),e.on("close",function(){n.$selection.attr("aria-expanded","false"),n.$selection.removeAttr("aria-activedescendant"),n.$selection.removeAttr("aria-owns"),n.$selection.trigger("focus"),n._detachCloseHandler(e)}),e.on("enable",function(){n.$selection.attr("tabindex",n._tabindex),n.$selection.attr("aria-disabled","false")}),e.on("disable",function(){n.$selection.attr("tabindex","-1"),n.$selection.attr("aria-disabled","true")})},o.prototype._handleBlur=function(e){var t=this;window.setTimeout(function(){document.activeElement==t.$selection[0]||n.contains(t.$selection[0],document.activeElement)||t.trigger("blur",e)},1)},o.prototype._attachCloseHandler=function(e){n(document.body).on("mousedown.select2."+e.id,function(e){var t=n(e.target).closest(".select2");n(".select2.select2-container--open").each(function(){this!=t[0]&&r.GetData(this,"element").select2("close")})})},o.prototype._detachCloseHandler=function(e){n(document.body).off("mousedown.select2."+e.id)},o.prototype.position=function(e,t){t.find(".selection").append(e)},o.prototype.destroy=function(){this._detachCloseHandler(this.container)},o.prototype.update=function(e){throw new Error("The `update` method must be defined in child classes.")},o.prototype.isEnabled=function(){return!this.isDisabled()},o.prototype.isDisabled=function(){return this.options.get("disabled")},o}),e.define("select2/selection/single",["jquery","./base","../utils","../keys"],function(e,t,n,r){function i(){i.__super__.constructor.apply(this,arguments)}return n.Extend(i,t),i.prototype.render=function(){var e=i.__super__.render.call(this);return e.addClass("select2-selection--single"),e.html(''),e},i.prototype.bind=function(t,e){var n=this;i.__super__.bind.apply(this,arguments);var r=t.id+"-container";this.$selection.find(".select2-selection__rendered").attr("id",r).attr("role","textbox").attr("aria-readonly","true"),this.$selection.attr("aria-labelledby",r),this.$selection.on("mousedown",function(e){1===e.which&&n.trigger("toggle",{originalEvent:e})}),this.$selection.on("focus",function(e){}),this.$selection.on("blur",function(e){}),t.on("focus",function(e){t.isOpen()||n.$selection.trigger("focus")})},i.prototype.clear=function(){var e=this.$selection.find(".select2-selection__rendered");e.empty(),e.removeAttr("title")},i.prototype.display=function(e,t){var n=this.options.get("templateSelection");return this.options.get("escapeMarkup")(n(e,t))},i.prototype.selectionContainer=function(){return e("")},i.prototype.update=function(e){if(0!==e.length){var t=e[0],n=this.$selection.find(".select2-selection__rendered"),r=this.display(t,n);n.empty().append(r);var i=t.title||t.text;i?n.attr("title",i):n.removeAttr("title")}else this.clear()},i}),e.define("select2/selection/multiple",["jquery","./base","../utils"],function(i,e,l){function n(e,t){n.__super__.constructor.apply(this,arguments)}return l.Extend(n,e),n.prototype.render=function(){var e=n.__super__.render.call(this);return e.addClass("select2-selection--multiple"),e.html('
        '),e},n.prototype.bind=function(e,t){var r=this;n.__super__.bind.apply(this,arguments),this.$selection.on("click",function(e){r.trigger("toggle",{originalEvent:e})}),this.$selection.on("click",".select2-selection__choice__remove",function(e){if(!r.isDisabled()){var t=i(this).parent(),n=l.GetData(t[0],"data");r.trigger("unselect",{originalEvent:e,data:n})}})},n.prototype.clear=function(){var e=this.$selection.find(".select2-selection__rendered");e.empty(),e.removeAttr("title")},n.prototype.display=function(e,t){var n=this.options.get("templateSelection");return this.options.get("escapeMarkup")(n(e,t))},n.prototype.selectionContainer=function(){return i('
      • ×
        • ')},n.prototype.update=function(e){if(this.clear(),0!==e.length){for(var t=[],n=0;n×');a.StoreData(r[0],"data",t),this.$selection.find(".select2-selection__rendered").prepend(r)}},e}),e.define("select2/selection/search",["jquery","../utils","../keys"],function(r,a,l){function e(e,t,n){e.call(this,t,n)}return e.prototype.render=function(e){var t=r('
        • ');this.$searchContainer=t,this.$search=t.find("input");var n=e.call(this);return this._transferTabIndex(),n},e.prototype.bind=function(e,t,n){var r=this,i=t.id+"-results";e.call(this,t,n),t.on("open",function(){r.$search.attr("aria-controls",i),r.$search.trigger("focus")}),t.on("close",function(){r.$search.val(""),r.$search.removeAttr("aria-controls"),r.$search.removeAttr("aria-activedescendant"),r.$search.trigger("focus")}),t.on("enable",function(){r.$search.prop("disabled",!1),r._transferTabIndex()}),t.on("disable",function(){r.$search.prop("disabled",!0)}),t.on("focus",function(e){r.$search.trigger("focus")}),t.on("results:focus",function(e){e.data._resultId?r.$search.attr("aria-activedescendant",e.data._resultId):r.$search.removeAttr("aria-activedescendant")}),this.$selection.on("focusin",".select2-search--inline",function(e){r.trigger("focus",e)}),this.$selection.on("focusout",".select2-search--inline",function(e){r._handleBlur(e)}),this.$selection.on("keydown",".select2-search--inline",function(e){if(e.stopPropagation(),r.trigger("keypress",e),r._keyUpPrevented=e.isDefaultPrevented(),e.which===l.BACKSPACE&&""===r.$search.val()){var t=r.$searchContainer.prev(".select2-selection__choice");if(0this.maximumInputLength?this.trigger("results:message",{message:"inputTooLong",args:{maximum:this.maximumInputLength,input:t.term,params:t}}):e.call(this,t,n)},e}),e.define("select2/data/maximumSelectionLength",[],function(){function e(e,t,n){this.maximumSelectionLength=n.get("maximumSelectionLength"),e.call(this,t,n)}return e.prototype.bind=function(e,t,n){var r=this;e.call(this,t,n),t.on("select",function(){r._checkIfMaximumSelected()})},e.prototype.query=function(e,t,n){var r=this;this._checkIfMaximumSelected(function(){e.call(r,t,n)})},e.prototype._checkIfMaximumSelected=function(e,n){var r=this;this.current(function(e){var t=null!=e?e.length:0;0=r.maximumSelectionLength?r.trigger("results:message",{message:"maximumSelected",args:{maximum:r.maximumSelectionLength}}):n&&n()})},e}),e.define("select2/dropdown",["jquery","./utils"],function(t,e){function n(e,t){this.$element=e,this.options=t,n.__super__.constructor.call(this)}return e.Extend(n,e.Observable),n.prototype.render=function(){var e=t('');return e.attr("dir",this.options.get("dir")),this.$dropdown=e},n.prototype.bind=function(){},n.prototype.position=function(e,t){},n.prototype.destroy=function(){this.$dropdown.remove()},n}),e.define("select2/dropdown/search",["jquery","../utils"],function(o,e){function t(){}return t.prototype.render=function(e){var t=e.call(this),n=o('');return this.$searchContainer=n,this.$search=n.find("input"),t.prepend(n),t},t.prototype.bind=function(e,t,n){var r=this,i=t.id+"-results";e.call(this,t,n),this.$search.on("keydown",function(e){r.trigger("keypress",e),r._keyUpPrevented=e.isDefaultPrevented()}),this.$search.on("input",function(e){o(this).off("keyup")}),this.$search.on("keyup input",function(e){r.handleSearch(e)}),t.on("open",function(){r.$search.attr("tabindex",0),r.$search.attr("aria-controls",i),r.$search.trigger("focus"),window.setTimeout(function(){r.$search.trigger("focus")},0)}),t.on("close",function(){r.$search.attr("tabindex",-1),r.$search.removeAttr("aria-controls"),r.$search.removeAttr("aria-activedescendant"),r.$search.val(""),r.$search.trigger("blur")}),t.on("focus",function(){t.isOpen()||r.$search.trigger("focus")}),t.on("results:all",function(e){null!=e.query.term&&""!==e.query.term||(r.showSearch(e)?r.$searchContainer.removeClass("select2-search--hide"):r.$searchContainer.addClass("select2-search--hide"))}),t.on("results:focus",function(e){e.data._resultId?r.$search.attr("aria-activedescendant",e.data._resultId):r.$search.removeAttr("aria-activedescendant")})},t.prototype.handleSearch=function(e){if(!this._keyUpPrevented){var t=this.$search.val();this.trigger("query",{term:t})}this._keyUpPrevented=!1},t.prototype.showSearch=function(e,t){return!0},t}),e.define("select2/dropdown/hidePlaceholder",[],function(){function e(e,t,n,r){this.placeholder=this.normalizePlaceholder(n.get("placeholder")),e.call(this,t,n,r)}return e.prototype.append=function(e,t){t.results=this.removePlaceholder(t.results),e.call(this,t)},e.prototype.normalizePlaceholder=function(e,t){return"string"==typeof t&&(t={id:"",text:t}),t},e.prototype.removePlaceholder=function(e,t){for(var n=t.slice(0),r=t.length-1;0<=r;r--){var i=t[r];this.placeholder.id===i.id&&n.splice(r,1)}return n},e}),e.define("select2/dropdown/infiniteScroll",["jquery"],function(n){function e(e,t,n,r){this.lastParams={},e.call(this,t,n,r),this.$loadingMore=this.createLoadingMore(),this.loading=!1}return e.prototype.append=function(e,t){this.$loadingMore.remove(),this.loading=!1,e.call(this,t),this.showLoadingMore(t)&&(this.$results.append(this.$loadingMore),this.loadMoreIfNeeded())},e.prototype.bind=function(e,t,n){var r=this;e.call(this,t,n),t.on("query",function(e){r.lastParams=e,r.loading=!0}),t.on("query:append",function(e){r.lastParams=e,r.loading=!0}),this.$results.on("scroll",this.loadMoreIfNeeded.bind(this))},e.prototype.loadMoreIfNeeded=function(){var e=n.contains(document.documentElement,this.$loadingMore[0]);if(!this.loading&&e){var t=this.$results.offset().top+this.$results.outerHeight(!1);this.$loadingMore.offset().top+this.$loadingMore.outerHeight(!1)<=t+50&&this.loadMore()}},e.prototype.loadMore=function(){this.loading=!0;var e=n.extend({},{page:1},this.lastParams);e.page++,this.trigger("query:append",e)},e.prototype.showLoadingMore=function(e,t){return t.pagination&&t.pagination.more},e.prototype.createLoadingMore=function(){var e=n('
      • '),t=this.options.get("translations").get("loadingMore");return e.html(t(this.lastParams)),e},e}),e.define("select2/dropdown/attachBody",["jquery","../utils"],function(f,a){function e(e,t,n){this.$dropdownParent=f(n.get("dropdownParent")||document.body),e.call(this,t,n)}return e.prototype.bind=function(e,t,n){var r=this;e.call(this,t,n),t.on("open",function(){r._showDropdown(),r._attachPositioningHandler(t),r._bindContainerResultHandlers(t)}),t.on("close",function(){r._hideDropdown(),r._detachPositioningHandler(t)}),this.$dropdownContainer.on("mousedown",function(e){e.stopPropagation()})},e.prototype.destroy=function(e){e.call(this),this.$dropdownContainer.remove()},e.prototype.position=function(e,t,n){t.attr("class",n.attr("class")),t.removeClass("select2"),t.addClass("select2-container--open"),t.css({position:"absolute",top:-999999}),this.$container=n},e.prototype.render=function(e){var t=f(""),n=e.call(this);return t.append(n),this.$dropdownContainer=t},e.prototype._hideDropdown=function(e){this.$dropdownContainer.detach()},e.prototype._bindContainerResultHandlers=function(e,t){if(!this._containerResultsHandlersBound){var n=this;t.on("results:all",function(){n._positionDropdown(),n._resizeDropdown()}),t.on("results:append",function(){n._positionDropdown(),n._resizeDropdown()}),t.on("results:message",function(){n._positionDropdown(),n._resizeDropdown()}),t.on("select",function(){n._positionDropdown(),n._resizeDropdown()}),t.on("unselect",function(){n._positionDropdown(),n._resizeDropdown()}),this._containerResultsHandlersBound=!0}},e.prototype._attachPositioningHandler=function(e,t){var n=this,r="scroll.select2."+t.id,i="resize.select2."+t.id,o="orientationchange.select2."+t.id,s=this.$container.parents().filter(a.hasScroll);s.each(function(){a.StoreData(this,"select2-scroll-position",{x:f(this).scrollLeft(),y:f(this).scrollTop()})}),s.on(r,function(e){var t=a.GetData(this,"select2-scroll-position");f(this).scrollTop(t.y)}),f(window).on(r+" "+i+" "+o,function(e){n._positionDropdown(),n._resizeDropdown()})},e.prototype._detachPositioningHandler=function(e,t){var n="scroll.select2."+t.id,r="resize.select2."+t.id,i="orientationchange.select2."+t.id;this.$container.parents().filter(a.hasScroll).off(n),f(window).off(n+" "+r+" "+i)},e.prototype._positionDropdown=function(){var e=f(window),t=this.$dropdown.hasClass("select2-dropdown--above"),n=this.$dropdown.hasClass("select2-dropdown--below"),r=null,i=this.$container.offset();i.bottom=i.top+this.$container.outerHeight(!1);var o={height:this.$container.outerHeight(!1)};o.top=i.top,o.bottom=i.top+o.height;var s=this.$dropdown.outerHeight(!1),a=e.scrollTop(),l=e.scrollTop()+e.height(),c=ai.bottom+s,d={left:i.left,top:o.bottom},p=this.$dropdownParent;"static"===p.css("position")&&(p=p.offsetParent());var h={top:0,left:0};(f.contains(document.body,p[0])||p[0].isConnected)&&(h=p.offset()),d.top-=h.top,d.left-=h.left,t||n||(r="below"),u||!c||t?!c&&u&&t&&(r="below"):r="above",("above"==r||t&&"below"!==r)&&(d.top=o.top-h.top-s),null!=r&&(this.$dropdown.removeClass("select2-dropdown--below select2-dropdown--above").addClass("select2-dropdown--"+r),this.$container.removeClass("select2-container--below select2-container--above").addClass("select2-container--"+r)),this.$dropdownContainer.css(d)},e.prototype._resizeDropdown=function(){var e={width:this.$container.outerWidth(!1)+"px"};this.options.get("dropdownAutoWidth")&&(e.minWidth=e.width,e.position="relative",e.width="auto"),this.$dropdown.css(e)},e.prototype._showDropdown=function(e){this.$dropdownContainer.appendTo(this.$dropdownParent),this._positionDropdown(),this._resizeDropdown()},e}),e.define("select2/dropdown/minimumResultsForSearch",[],function(){function e(e,t,n,r){this.minimumResultsForSearch=n.get("minimumResultsForSearch"),this.minimumResultsForSearch<0&&(this.minimumResultsForSearch=1/0),e.call(this,t,n,r)}return e.prototype.showSearch=function(e,t){return!(function e(t){for(var n=0,r=0;r');return e.attr("dir",this.options.get("dir")),this.$container=e,this.$container.addClass("select2-container--"+this.options.get("theme")),u.StoreData(e[0],"element",this.$element),e},d}),e.define("jquery-mousewheel",["jquery"],function(e){return e}),e.define("jquery.select2",["jquery","jquery-mousewheel","./select2/core","./select2/defaults","./select2/utils"],function(i,e,o,t,s){if(null==i.fn.select2){var a=["open","close","destroy"];i.fn.select2=function(t){if("object"==typeof(t=t||{}))return this.each(function(){var e=i.extend(!0,{},t);new o(i(this),e)}),this;if("string"!=typeof t)throw new Error("Invalid arguments for Select2: "+t);var n,r=Array.prototype.slice.call(arguments,1);return this.each(function(){var e=s.GetData(this,"select2");null==e&&window.console&&console.error&&console.error("The select2('"+t+"') method was called on an element that is not using Select2."),n=e[t].apply(e,r)}),-11&&u(t,"")>-1&&(a=RegExp(this.source,r.replace.call(o(this),"g","")),r.replace.call(e.slice(t.index),a,function(){for(var e=1;et.index&&this.lastIndex--}return t},s||(RegExp.prototype.test=function(e){var t=r.exec.call(this,e);return t&&this.global&&!t[0].length&&this.lastIndex>t.index&&this.lastIndex--,!!t})}),define("ace/lib/es5-shim",["require","exports","module"],function(e,t,n){function r(){}function w(e){try{return Object.defineProperty(e,"sentinel",{}),"sentinel"in e}catch(t){}}function H(e){return e=+e,e!==e?e=0:e!==0&&e!==1/0&&e!==-1/0&&(e=(e>0||-1)*Math.floor(Math.abs(e))),e}function B(e){var t=typeof e;return e===null||t==="undefined"||t==="boolean"||t==="number"||t==="string"}function j(e){var t,n,r;if(B(e))return e;n=e.valueOf;if(typeof n=="function"){t=n.call(e);if(B(t))return t}r=e.toString;if(typeof r=="function"){t=r.call(e);if(B(t))return t}throw new TypeError}Function.prototype.bind||(Function.prototype.bind=function(t){var n=this;if(typeof n!="function")throw new TypeError("Function.prototype.bind called on incompatible "+n);var i=u.call(arguments,1),s=function(){if(this instanceof s){var e=n.apply(this,i.concat(u.call(arguments)));return Object(e)===e?e:this}return n.apply(t,i.concat(u.call(arguments)))};return n.prototype&&(r.prototype=n.prototype,s.prototype=new r,r.prototype=null),s});var i=Function.prototype.call,s=Array.prototype,o=Object.prototype,u=s.slice,a=i.bind(o.toString),f=i.bind(o.hasOwnProperty),l,c,h,p,d;if(d=f(o,"__defineGetter__"))l=i.bind(o.__defineGetter__),c=i.bind(o.__defineSetter__),h=i.bind(o.__lookupGetter__),p=i.bind(o.__lookupSetter__);if([1,2].splice(0).length!=2)if(!function(){function e(e){var t=new Array(e+2);return t[0]=t[1]=0,t}var t=[],n;t.splice.apply(t,e(20)),t.splice.apply(t,e(26)),n=t.length,t.splice(5,0,"XXX"),n+1==t.length;if(n+1==t.length)return!0}())Array.prototype.splice=function(e,t){var n=this.length;e>0?e>n&&(e=n):e==void 0?e=0:e<0&&(e=Math.max(n+e,0)),e+ta)for(h=l;h--;)this[f+h]=this[a+h];if(s&&e===c)this.length=c,this.push.apply(this,i);else{this.length=c+s;for(h=0;h>>0;if(a(t)!="[object Function]")throw new TypeError;while(++s>>0,s=Array(i),o=arguments[1];if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");for(var u=0;u>>0,s=[],o,u=arguments[1];if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");for(var f=0;f>>0,s=arguments[1];if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");for(var o=0;o>>0,s=arguments[1];if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");for(var o=0;o>>0;if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");if(!i&&arguments.length==1)throw new TypeError("reduce of empty array with no initial value");var s=0,o;if(arguments.length>=2)o=arguments[1];else do{if(s in r){o=r[s++];break}if(++s>=i)throw new TypeError("reduce of empty array with no initial value")}while(!0);for(;s>>0;if(a(t)!="[object Function]")throw new TypeError(t+" is not a function");if(!i&&arguments.length==1)throw new TypeError("reduceRight of empty array with no initial value");var s,o=i-1;if(arguments.length>=2)s=arguments[1];else do{if(o in r){s=r[o--];break}if(--o<0)throw new TypeError("reduceRight of empty array with no initial value")}while(!0);do o in this&&(s=t.call(void 0,s,r[o],o,n));while(o--);return s});if(!Array.prototype.indexOf||[0,1].indexOf(1,2)!=-1)Array.prototype.indexOf=function(t){var n=g&&a(this)=="[object String]"?this.split(""):F(this),r=n.length>>>0;if(!r)return-1;var i=0;arguments.length>1&&(i=H(arguments[1])),i=i>=0?i:Math.max(0,r+i);for(;i>>0;if(!r)return-1;var i=r-1;arguments.length>1&&(i=Math.min(i,H(arguments[1]))),i=i>=0?i:r-Math.abs(i);for(;i>=0;i--)if(i in n&&t===n[i])return i;return-1};Object.getPrototypeOf||(Object.getPrototypeOf=function(t){return t.__proto__||(t.constructor?t.constructor.prototype:o)});if(!Object.getOwnPropertyDescriptor){var y="Object.getOwnPropertyDescriptor called on a non-object: ";Object.getOwnPropertyDescriptor=function(t,n){if(typeof t!="object"&&typeof t!="function"||t===null)throw new TypeError(y+t);if(!f(t,n))return;var r,i,s;r={enumerable:!0,configurable:!0};if(d){var u=t.__proto__;t.__proto__=o;var i=h(t,n),s=p(t,n);t.__proto__=u;if(i||s)return i&&(r.get=i),s&&(r.set=s),r}return r.value=t[n],r}}Object.getOwnPropertyNames||(Object.getOwnPropertyNames=function(t){return Object.keys(t)});if(!Object.create){var b;Object.prototype.__proto__===null?b=function(){return{__proto__:null}}:b=function(){var e={};for(var t in e)e[t]=null;return e.constructor=e.hasOwnProperty=e.propertyIsEnumerable=e.isPrototypeOf=e.toLocaleString=e.toString=e.valueOf=e.__proto__=null,e},Object.create=function(t,n){var r;if(t===null)r=b();else{if(typeof t!="object")throw new TypeError("typeof prototype["+typeof t+"] != 'object'");var i=function(){};i.prototype=t,r=new i,r.__proto__=t}return n!==void 0&&Object.defineProperties(r,n),r}}if(Object.defineProperty){var E=w({}),S=typeof document=="undefined"||w(document.createElement("div"));if(!E||!S)var x=Object.defineProperty}if(!Object.defineProperty||x){var T="Property description must be an object: ",N="Object.defineProperty called on non-object: ",C="getters & setters can not be defined on this javascript engine";Object.defineProperty=function(t,n,r){if(typeof t!="object"&&typeof t!="function"||t===null)throw new TypeError(N+t);if(typeof r!="object"&&typeof r!="function"||r===null)throw new TypeError(T+r);if(x)try{return x.call(Object,t,n,r)}catch(i){}if(f(r,"value"))if(d&&(h(t,n)||p(t,n))){var s=t.__proto__;t.__proto__=o,delete t[n],t[n]=r.value,t.__proto__=s}else t[n]=r.value;else{if(!d)throw new TypeError(C);f(r,"get")&&l(t,n,r.get),f(r,"set")&&c(t,n,r.set)}return t}}Object.defineProperties||(Object.defineProperties=function(t,n){for(var r in n)f(n,r)&&Object.defineProperty(t,r,n[r]);return t}),Object.seal||(Object.seal=function(t){return t}),Object.freeze||(Object.freeze=function(t){return t});try{Object.freeze(function(){})}catch(k){Object.freeze=function(t){return function(n){return typeof n=="function"?n:t(n)}}(Object.freeze)}Object.preventExtensions||(Object.preventExtensions=function(t){return t}),Object.isSealed||(Object.isSealed=function(t){return!1}),Object.isFrozen||(Object.isFrozen=function(t){return!1}),Object.isExtensible||(Object.isExtensible=function(t){if(Object(t)===t)throw new TypeError;var n="";while(f(t,n))n+="?";t[n]=!0;var r=f(t,n);return delete t[n],r});if(!Object.keys){var L=!0,A=["toString","toLocaleString","valueOf","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","constructor"],O=A.length;for(var M in{toString:null})L=!1;Object.keys=function I(e){if(typeof e!="object"&&typeof e!="function"||e===null)throw new TypeError("Object.keys called on a non-object");var I=[];for(var t in e)f(e,t)&&I.push(t);if(L)for(var n=0,r=O;n=0?parseFloat((s.match(/(?:MSIE |Trident\/[0-9]+[\.0-9]+;.*rv:)([0-9]+[\.0-9]+)/)||[])[1]):parseFloat((s.match(/(?:Trident\/[0-9]+[\.0-9]+;.*rv:)([0-9]+[\.0-9]+)/)||[])[1]),t.isOldIE=t.isIE&&t.isIE<9,t.isGecko=t.isMozilla=s.match(/ Gecko\/\d+/),t.isOpera=typeof opera=="object"&&Object.prototype.toString.call(window.opera)=="[object Opera]",t.isWebKit=parseFloat(s.split("WebKit/")[1])||undefined,t.isChrome=parseFloat(s.split(" Chrome/")[1])||undefined,t.isEdge=parseFloat(s.split(" Edge/")[1])||undefined,t.isAIR=s.indexOf("AdobeAIR")>=0,t.isAndroid=s.indexOf("Android")>=0,t.isChromeOS=s.indexOf(" CrOS ")>=0,t.isIOS=/iPad|iPhone|iPod/.test(s)&&!window.MSStream,t.isIOS&&(t.isMac=!0),t.isMobile=t.isIOS||t.isAndroid}),define("ace/lib/dom",["require","exports","module","ace/lib/useragent"],function(e,t,n){"use strict";var r=e("./useragent"),i="http://www.w3.org/1999/xhtml";t.buildDom=function o(e,t,n){if(typeof e=="string"&&e){var r=document.createTextNode(e);return t&&t.appendChild(r),r}if(!Array.isArray(e))return e&&e.appendChild&&t&&t.appendChild(e),e;if(typeof e[0]!="string"||!e[0]){var i=[];for(var s=0;s=1.5:!0;if(typeof document!="undefined"){var s=document.createElement("div");t.HI_DPI&&s.style.transform!==undefined&&(t.HAS_CSS_TRANSFORMS=!0),!r.isEdge&&typeof s.style.animationName!="undefined"&&(t.HAS_CSS_ANIMATION=!0),s=null}t.HAS_CSS_TRANSFORMS?t.translate=function(e,t,n){e.style.transform="translate("+Math.round(t)+"px, "+Math.round(n)+"px)"}:t.translate=function(e,t,n){e.style.top=Math.round(n)+"px",e.style.left=Math.round(t)+"px"}}),define("ace/lib/oop",["require","exports","module"],function(e,t,n){"use strict";t.inherits=function(e,t){e.super_=t,e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}})},t.mixin=function(e,t){for(var n in t)e[n]=t[n];return e},t.implement=function(e,n){t.mixin(e,n)}}),define("ace/lib/keys",["require","exports","module","ace/lib/oop"],function(e,t,n){"use strict";var r=e("./oop"),i=function(){var e={MODIFIER_KEYS:{16:"Shift",17:"Ctrl",18:"Alt",224:"Meta",91:"MetaLeft",92:"MetaRight",93:"ContextMenu"},KEY_MODS:{ctrl:1,alt:2,option:2,shift:4,"super":8,meta:8,command:8,cmd:8,control:1},FUNCTION_KEYS:{8:"Backspace",9:"Tab",13:"Return",19:"Pause",27:"Esc",32:"Space",33:"PageUp",34:"PageDown",35:"End",36:"Home",37:"Left",38:"Up",39:"Right",40:"Down",44:"Print",45:"Insert",46:"Delete",96:"Numpad0",97:"Numpad1",98:"Numpad2",99:"Numpad3",100:"Numpad4",101:"Numpad5",102:"Numpad6",103:"Numpad7",104:"Numpad8",105:"Numpad9","-13":"NumpadEnter",112:"F1",113:"F2",114:"F3",115:"F4",116:"F5",117:"F6",118:"F7",119:"F8",120:"F9",121:"F10",122:"F11",123:"F12",144:"Numlock",145:"Scrolllock"},PRINTABLE_KEYS:{32:" ",48:"0",49:"1",50:"2",51:"3",52:"4",53:"5",54:"6",55:"7",56:"8",57:"9",59:";",61:"=",65:"a",66:"b",67:"c",68:"d",69:"e",70:"f",71:"g",72:"h",73:"i",74:"j",75:"k",76:"l",77:"m",78:"n",79:"o",80:"p",81:"q",82:"r",83:"s",84:"t",85:"u",86:"v",87:"w",88:"x",89:"y",90:"z",107:"+",109:"-",110:".",186:";",187:"=",188:",",189:"-",190:".",191:"/",192:"`",219:"[",220:"\\",221:"]",222:"'",111:"/",106:"*"}},t,n;for(n in e.FUNCTION_KEYS)t=e.FUNCTION_KEYS[n].toLowerCase(),e[t]=parseInt(n,10);for(n in e.PRINTABLE_KEYS)t=e.PRINTABLE_KEYS[n].toLowerCase(),e[t]=parseInt(n,10);return r.mixin(e,e.MODIFIER_KEYS),r.mixin(e,e.PRINTABLE_KEYS),r.mixin(e,e.FUNCTION_KEYS),e.enter=e["return"],e.escape=e.esc,e.del=e["delete"],e[173]="-",function(){var t=["cmd","ctrl","alt","shift"];for(var n=Math.pow(2,t.length);n--;)e.KEY_MODS[n]=t.filter(function(t){return n&e.KEY_MODS[t]}).join("-")+"-"}(),e.KEY_MODS[0]="",e.KEY_MODS[-1]="input-",e}();r.mixin(t,i),t.keyCodeToString=function(e){var t=i[e];return typeof t!="string"&&(t=String.fromCharCode(e)),t.toLowerCase()}}),define("ace/lib/event",["require","exports","module","ace/lib/keys","ace/lib/useragent"],function(e,t,n){"use strict";function a(){u=!1;try{document.createComment("").addEventListener("test",function(){},{get passive(){u={passive:!1}}})}catch(e){}}function f(){return u==undefined&&a(),u}function l(e,t,n){this.elem=e,this.type=t,this.callback=n}function d(e,t,n){var u=p(t);if(!i.isMac&&s){t.getModifierState&&(t.getModifierState("OS")||t.getModifierState("Win"))&&(u|=8);if(s.altGr){if((3&u)==3)return;s.altGr=0}if(n===18||n===17){var a="location"in t?t.location:t.keyLocation;if(n===17&&a===1)s[n]==1&&(o=t.timeStamp);else if(n===18&&u===3&&a===2){var f=t.timeStamp-o;f<50&&(s.altGr=!0)}}}n in r.MODIFIER_KEYS&&(n=-1);if(!u&&n===13){var a="location"in t?t.location:t.keyLocation;if(a===3){e(t,u,-n);if(t.defaultPrevented)return}}if(i.isChromeOS&&u&8){e(t,u,n);if(t.defaultPrevented)return;u&=-9}return!!u||n in r.FUNCTION_KEYS||n in r.PRINTABLE_KEYS?e(t,u,n):!1}function v(){s=Object.create(null)}var r=e("./keys"),i=e("./useragent"),s=null,o=0,u;l.prototype.destroy=function(){h(this.elem,this.type,this.callback),this.elem=this.type=this.callback=undefined};var c=t.addListener=function(e,t,n,r){e.addEventListener(t,n,f()),r&&r.$toDestroy.push(new l(e,t,n))},h=t.removeListener=function(e,t,n){e.removeEventListener(t,n,f())};t.stopEvent=function(e){return t.stopPropagation(e),t.preventDefault(e),!1},t.stopPropagation=function(e){e.stopPropagation&&e.stopPropagation()},t.preventDefault=function(e){e.preventDefault&&e.preventDefault()},t.getButton=function(e){return e.type=="dblclick"?0:e.type=="contextmenu"||i.isMac&&e.ctrlKey&&!e.altKey&&!e.shiftKey?2:e.button},t.capture=function(e,t,n){function r(e){t&&t(e),n&&n(e),h(document,"mousemove",t),h(document,"mouseup",r),h(document,"dragstart",r)}return c(document,"mousemove",t),c(document,"mouseup",r),c(document,"dragstart",r),r},t.addMouseWheelListener=function(e,t,n){"onmousewheel"in e?c(e,"mousewheel",function(e){var n=8;e.wheelDeltaX!==undefined?(e.wheelX=-e.wheelDeltaX/n,e.wheelY=-e.wheelDeltaY/n):(e.wheelX=0,e.wheelY=-e.wheelDelta/n),t(e)},n):"onwheel"in e?c(e,"wheel",function(e){var n=.35;switch(e.deltaMode){case e.DOM_DELTA_PIXEL:e.wheelX=e.deltaX*n||0,e.wheelY=e.deltaY*n||0;break;case e.DOM_DELTA_LINE:case e.DOM_DELTA_PAGE:e.wheelX=(e.deltaX||0)*5,e.wheelY=(e.deltaY||0)*5}t(e)},n):c(e,"DOMMouseScroll",function(e){e.axis&&e.axis==e.HORIZONTAL_AXIS?(e.wheelX=(e.detail||0)*5,e.wheelY=0):(e.wheelX=0,e.wheelY=(e.detail||0)*5),t(e)},n)},t.addMultiMouseDownListener=function(e,n,r,s,o){function p(e){t.getButton(e)!==0?u=0:e.detail>1?(u++,u>4&&(u=1)):u=1;if(i.isIE){var o=Math.abs(e.clientX-a)>5||Math.abs(e.clientY-f)>5;if(!l||o)u=1;l&&clearTimeout(l),l=setTimeout(function(){l=null},n[u-1]||600),u==1&&(a=e.clientX,f=e.clientY)}e._clicks=u,r[s]("mousedown",e);if(u>4)u=0;else if(u>1)return r[s](h[u],e)}var u=0,a,f,l,h={2:"dblclick",3:"tripleclick",4:"quadclick"};Array.isArray(e)||(e=[e]),e.forEach(function(e){c(e,"mousedown",p,o)})};var p=function(e){return 0|(e.ctrlKey?1:0)|(e.altKey?2:0)|(e.shiftKey?4:0)|(e.metaKey?8:0)};t.getModifierString=function(e){return r.KEY_MODS[p(e)]},t.addCommandKeyListener=function(e,n,r){if(i.isOldGecko||i.isOpera&&!("KeyboardEvent"in window)){var o=null;c(e,"keydown",function(e){o=e.keyCode},r),c(e,"keypress",function(e){return d(n,e,o)},r)}else{var u=null;c(e,"keydown",function(e){s[e.keyCode]=(s[e.keyCode]||0)+1;var t=d(n,e,e.keyCode);return u=e.defaultPrevented,t},r),c(e,"keypress",function(e){u&&(e.ctrlKey||e.altKey||e.shiftKey||e.metaKey)&&(t.stopEvent(e),u=null)},r),c(e,"keyup",function(e){s[e.keyCode]=null},r),s||(v(),c(window,"focus",v))}};if(typeof window=="object"&&window.postMessage&&!i.isOldIE){var m=1;t.nextTick=function(e,n){n=n||window;var r="zero-timeout-message-"+m++,i=function(s){s.data==r&&(t.stopPropagation(s),h(n,"message",i),e())};c(n,"message",i),n.postMessage(r,"*")}}t.$idleBlocked=!1,t.onIdle=function(e,n){return setTimeout(function r(){t.$idleBlocked?setTimeout(r,100):e()},n)},t.$idleBlockId=null,t.blockIdle=function(e){t.$idleBlockId&&clearTimeout(t.$idleBlockId),t.$idleBlocked=!0,t.$idleBlockId=setTimeout(function(){t.$idleBlocked=!1},e||100)},t.nextFrame=typeof window=="object"&&(window.requestAnimationFrame||window.mozRequestAnimationFrame||window.webkitRequestAnimationFrame||window.msRequestAnimationFrame||window.oRequestAnimationFrame),t.nextFrame?t.nextFrame=t.nextFrame.bind(window):t.nextFrame=function(e){setTimeout(e,17)}}),define("ace/range",["require","exports","module"],function(e,t,n){"use strict";var r=function(e,t){return e.row-t.row||e.column-t.column},i=function(e,t,n,r){this.start={row:e,column:t},this.end={row:n,column:r}};(function(){this.isEqual=function(e){return this.start.row===e.start.row&&this.end.row===e.end.row&&this.start.column===e.start.column&&this.end.column===e.end.column},this.toString=function(){return"Range: ["+this.start.row+"/"+this.start.column+"] -> ["+this.end.row+"/"+this.end.column+"]"},this.contains=function(e,t){return this.compare(e,t)==0},this.compareRange=function(e){var t,n=e.end,r=e.start;return t=this.compare(n.row,n.column),t==1?(t=this.compare(r.row,r.column),t==1?2:t==0?1:0):t==-1?-2:(t=this.compare(r.row,r.column),t==-1?-1:t==1?42:0)},this.comparePoint=function(e){return this.compare(e.row,e.column)},this.containsRange=function(e){return this.comparePoint(e.start)==0&&this.comparePoint(e.end)==0},this.intersects=function(e){var t=this.compareRange(e);return t==-1||t==0||t==1},this.isEnd=function(e,t){return this.end.row==e&&this.end.column==t},this.isStart=function(e,t){return this.start.row==e&&this.start.column==t},this.setStart=function(e,t){typeof e=="object"?(this.start.column=e.column,this.start.row=e.row):(this.start.row=e,this.start.column=t)},this.setEnd=function(e,t){typeof e=="object"?(this.end.column=e.column,this.end.row=e.row):(this.end.row=e,this.end.column=t)},this.inside=function(e,t){return this.compare(e,t)==0?this.isEnd(e,t)||this.isStart(e,t)?!1:!0:!1},this.insideStart=function(e,t){return this.compare(e,t)==0?this.isEnd(e,t)?!1:!0:!1},this.insideEnd=function(e,t){return this.compare(e,t)==0?this.isStart(e,t)?!1:!0:!1},this.compare=function(e,t){return!this.isMultiLine()&&e===this.start.row?tthis.end.column?1:0:ethis.end.row?1:this.start.row===e?t>=this.start.column?0:-1:this.end.row===e?t<=this.end.column?0:1:0},this.compareStart=function(e,t){return this.start.row==e&&this.start.column==t?-1:this.compare(e,t)},this.compareEnd=function(e,t){return this.end.row==e&&this.end.column==t?1:this.compare(e,t)},this.compareInside=function(e,t){return this.end.row==e&&this.end.column==t?1:this.start.row==e&&this.start.column==t?-1:this.compare(e,t)},this.clipRows=function(e,t){if(this.end.row>t)var n={row:t+1,column:0};else if(this.end.rowt)var r={row:t+1,column:0};else if(this.start.row0){t&1&&(n+=e);if(t>>=1)e+=e}return n};var r=/^\s\s*/,i=/\s\s*$/;t.stringTrimLeft=function(e){return e.replace(r,"")},t.stringTrimRight=function(e){return e.replace(i,"")},t.copyObject=function(e){var t={};for(var n in e)t[n]=e[n];return t},t.copyArray=function(e){var t=[];for(var n=0,r=e.length;nDate.now()-50?!0:r=!1},cancel:function(){r=Date.now()}}}),define("ace/keyboard/textinput",["require","exports","module","ace/lib/event","ace/lib/useragent","ace/lib/dom","ace/lib/lang","ace/clipboard","ace/lib/keys"],function(e,t,n){"use strict";var r=e("../lib/event"),i=e("../lib/useragent"),s=e("../lib/dom"),o=e("../lib/lang"),u=e("../clipboard"),a=i.isChrome<18,f=i.isIE,l=i.isChrome>63,c=400,h=e("../lib/keys"),p=h.KEY_MODS,d=i.isIOS,v=d?/\s/:/\n/,m=i.isMobile,g=function(e,t){function X(){x=!0,n.blur(),n.focus(),x=!1}function $(e){e.keyCode==27&&n.value.lengthC&&T[s]=="\n")o=h.end;else if(rC&&T.slice(0,s).split("\n").length>2)o=h.down;else if(s>C&&T[s-1]==" ")o=h.right,u=p.option;else if(s>C||s==C&&C!=N&&r==s)o=h.right;r!==s&&(u|=p.shift);if(o){var a=t.onCommandKey({},u,o);if(!a&&t.commands){o=h.keyCodeToString(o);var f=t.commands.findKeyCommand(u,o);f&&t.execCommand(f)}N=r,C=s,O("")}};document.addEventListener("selectionchange",s),t.on("destroy",function(){document.removeEventListener("selectionchange",s)})}var n=s.createElement("textarea");n.className="ace_text-input",n.setAttribute("wrap","off"),n.setAttribute("autocorrect","off"),n.setAttribute("autocapitalize","off"),n.setAttribute("spellcheck",!1),n.style.opacity="0",e.insertBefore(n,e.firstChild);var g=!1,y=!1,b=!1,w=!1,E="";m||(n.style.fontSize="1px");var S=!1,x=!1,T="",N=0,C=0,k=0;try{var L=document.activeElement===n}catch(A){}r.addListener(n,"blur",function(e){if(x)return;t.onBlur(e),L=!1},t),r.addListener(n,"focus",function(e){if(x)return;L=!0;if(i.isEdge)try{if(!document.hasFocus())return}catch(e){}t.onFocus(e),i.isEdge?setTimeout(O):O()},t),this.$focusScroll=!1,this.focus=function(){if(E||l||this.$focusScroll=="browser")return n.focus({preventScroll:!0});var e=n.style.top;n.style.position="fixed",n.style.top="0px";try{var t=n.getBoundingClientRect().top!=0}catch(r){return}var i=[];if(t){var s=n.parentElement;while(s&&s.nodeType==1)i.push(s),s.setAttribute("ace_nocontext",!0),!s.parentElement&&s.getRootNode?s=s.getRootNode().host:s=s.parentElement}n.focus({preventScroll:!0}),t&&i.forEach(function(e){e.removeAttribute("ace_nocontext")}),setTimeout(function(){n.style.position="",n.style.top=="0px"&&(n.style.top=e)},0)},this.blur=function(){n.blur()},this.isFocused=function(){return L},t.on("beforeEndOperation",function(){var e=t.curOp,r=e&&e.command&&e.command.name;if(r=="insertstring")return;var i=r&&(e.docChanged||e.selectionChanged);b&&i&&(T=n.value="",W()),O()});var O=d?function(e){if(!L||g&&!e||w)return;e||(e="");var r="\n ab"+e+"cde fg\n";r!=n.value&&(n.value=T=r);var i=4,s=4+(e.length||(t.selection.isEmpty()?0:1));(N!=i||C!=s)&&n.setSelectionRange(i,s),N=i,C=s}:function(){if(b||w)return;if(!L&&!P)return;b=!0;var e=0,r=0,i="";if(t.session){var s=t.selection,o=s.getRange(),u=s.cursor.row;e=o.start.column,r=o.end.column,i=t.session.getLine(u);if(o.start.row!=u){var a=t.session.getLine(u-1);e=o.start.rowu+1?f.length:r,r+=i.length+1,i=i+"\n"+f}else m&&u>0&&(i="\n"+i,r+=1,e+=1);i.length>c&&(e=T.length&&e.value===T&&T&&e.selectionEnd!==C},_=function(e){if(b)return;g?g=!1:M(n)?(t.selectAll(),O()):m&&n.selectionStart!=N&&O()},D=null;this.setInputHandler=function(e){D=e},this.getInputHandler=function(){return D};var P=!1,H=function(e,r){P&&(P=!1);if(y)return O(),e&&t.onPaste(e),y=!1,"";var i=n.selectionStart,s=n.selectionEnd,o=N,u=T.length-C,a=e,f=e.length-i,l=e.length-s,c=0;while(o>0&&T[c]==e[c])c++,o--;a=a.slice(c),c=1;while(u>0&&T.length-c>N-1&&T[T.length-c]==e[e.length-c])c++,u--;f-=c-1,l-=c-1;var h=a.length-c+1;return h<0&&(o=-h,h=0),a=a.slice(0,h),!r&&!a&&!f&&!o&&!u&&!l?"":(w=!0,a&&!o&&!u&&!f&&!l||S?t.onTextInput(a):t.onTextInput(a,{extendLeft:o,extendRight:u,restoreStart:f,restoreEnd:l}),w=!1,T=e,N=i,C=s,k=l,a)},B=function(e){if(b)return z();if(e&&e.inputType){if(e.inputType=="historyUndo")return t.execCommand("undo");if(e.inputType=="historyRedo")return t.execCommand("redo")}var r=n.value,i=H(r,!0);(r.length>c+100||v.test(i)||m&&N<1&&N==C)&&O()},j=function(e,t,n){var r=e.clipboardData||window.clipboardData;if(!r||a)return;var i=f||n?"Text":"text/plain";try{return t?r.setData(i,t)!==!1:r.getData(i)}catch(e){if(!n)return j(e,t,!0)}},F=function(e,i){var s=t.getCopyText();if(!s)return r.preventDefault(e);j(e,s)?(d&&(O(s),g=s,setTimeout(function(){g=!1},10)),i?t.onCut():t.onCopy(),r.preventDefault(e)):(g=!0,n.value=s,n.select(),setTimeout(function(){g=!1,O(),i?t.onCut():t.onCopy()}))},I=function(e){F(e,!0)},q=function(e){F(e,!1)},R=function(e){var s=j(e);if(u.pasteCancelled())return;typeof s=="string"?(s&&t.onPaste(s,e),i.isIE&&setTimeout(O),r.preventDefault(e)):(n.value="",y=!0)};r.addCommandKeyListener(n,t.onCommandKey.bind(t),t),r.addListener(n,"select",_,t),r.addListener(n,"input",B,t),r.addListener(n,"cut",I,t),r.addListener(n,"copy",q,t),r.addListener(n,"paste",R,t),(!("oncut"in n)||!("oncopy"in n)||!("onpaste"in n))&&r.addListener(e,"keydown",function(e){if(i.isMac&&!e.metaKey||!e.ctrlKey)return;switch(e.keyCode){case 67:q(e);break;case 86:R(e);break;case 88:I(e)}},t);var U=function(e){if(b||!t.onCompositionStart||t.$readOnly)return;b={};if(S)return;e.data&&(b.useTextareaForIME=!1),setTimeout(z,0),t._signal("compositionStart"),t.on("mousedown",X);var r=t.getSelectionRange();r.end.row=r.start.row,r.end.column=r.start.column,b.markerRange=r,b.selectionStart=N,t.onCompositionStart(b),b.useTextareaForIME?(T=n.value="",N=0,C=0):(n.msGetInputContext&&(b.context=n.msGetInputContext()),n.getInputContext&&(b.context=n.getInputContext()))},z=function(){if(!b||!t.onCompositionUpdate||t.$readOnly)return;if(S)return X();if(b.useTextareaForIME)t.onCompositionUpdate(n.value);else{var e=n.value;H(e),b.markerRange&&(b.context&&(b.markerRange.start.column=b.selectionStart=b.context.compositionStartOffset),b.markerRange.end.column=b.markerRange.start.column+C-b.selectionStart+k)}},W=function(e){if(!t.onCompositionEnd||t.$readOnly)return;b=!1,t.onCompositionEnd(),t.off("mousedown",X),e&&B()},V=o.delayedCall(z,50).schedule.bind(null,null);r.addListener(n,"compositionstart",U,t),r.addListener(n,"compositionupdate",z,t),r.addListener(n,"keyup",$,t),r.addListener(n,"keydown",V,t),r.addListener(n,"compositionend",W,t),this.getElement=function(){return n},this.setCommandMode=function(e){S=e,n.readOnly=!1},this.setReadOnly=function(e){S||(n.readOnly=e)},this.setCopyWithEmptySelection=function(e){},this.onContextMenu=function(e){P=!0,O(),t._emit("nativecontextmenu",{target:t,domEvent:e}),this.moveToMouse(e,!0)},this.moveToMouse=function(e,o){E||(E=n.style.cssText),n.style.cssText=(o?"z-index:100000;":"")+(i.isIE?"opacity:0.1;":"")+"text-indent: -"+(N+C)*t.renderer.characterWidth*.5+"px;";var u=t.container.getBoundingClientRect(),a=s.computedStyle(t.container),f=u.top+(parseInt(a.borderTopWidth)||0),l=u.left+(parseInt(u.borderLeftWidth)||0),c=u.bottom-f-n.clientHeight-2,h=function(e){s.translate(n,e.clientX-l-2,Math.min(e.clientY-f-2,c))};h(e);if(e.type!="mousedown")return;t.renderer.$isMousePressed=!0,clearTimeout(J),i.isWin&&r.capture(t.container,h,K)},this.onContextMenuClose=K;var J,Q=function(e){t.textInput.onContextMenu(e),K()};r.addListener(n,"mouseup",Q,t),r.addListener(n,"mousedown",function(e){e.preventDefault(),K()},t),r.addListener(t.renderer.scroller,"contextmenu",Q,t),r.addListener(n,"contextmenu",Q,t),d&&G(e,t,n)};t.TextInput=g,t.$setUserAgentForTests=function(e,t){m=e,d=t}}),define("ace/mouse/default_handlers",["require","exports","module","ace/lib/useragent"],function(e,t,n){"use strict";function o(e){e.$clickSelection=null;var t=e.editor;t.setDefaultHandler("mousedown",this.onMouseDown.bind(e)),t.setDefaultHandler("dblclick",this.onDoubleClick.bind(e)),t.setDefaultHandler("tripleclick",this.onTripleClick.bind(e)),t.setDefaultHandler("quadclick",this.onQuadClick.bind(e)),t.setDefaultHandler("mousewheel",this.onMouseWheel.bind(e));var n=["select","startSelect","selectEnd","selectAllEnd","selectByWordsEnd","selectByLinesEnd","dragWait","dragWaitEnd","focusWait"];n.forEach(function(t){e[t]=this[t]},this),e.selectByLines=this.extendSelectionBy.bind(e,"getLineRange"),e.selectByWords=this.extendSelectionBy.bind(e,"getWordRange")}function u(e,t,n,r){return Math.sqrt(Math.pow(n-e,2)+Math.pow(r-t,2))}function a(e,t){if(e.start.row==e.end.row)var n=2*t.column-e.start.column-e.end.column;else if(e.start.row==e.end.row-1&&!e.start.column&&!e.end.column)var n=t.column-4;else var n=2*t.row-e.start.row-e.end.row;return n<0?{cursor:e.start,anchor:e.end}:{cursor:e.end,anchor:e.start}}var r=e("../lib/useragent"),i=0,s=550;(function(){this.onMouseDown=function(e){var t=e.inSelection(),n=e.getDocumentPosition();this.mousedownEvent=e;var i=this.editor,s=e.getButton();if(s!==0){var o=i.getSelectionRange(),u=o.isEmpty();(u||s==1)&&i.selection.moveToPosition(n),s==2&&(i.textInput.onContextMenu(e.domEvent),r.isMozilla||e.preventDefault());return}this.mousedownEvent.time=Date.now();if(t&&!i.isFocused()){i.focus();if(this.$focusTimeout&&!this.$clickSelection&&!i.inMultiSelectMode){this.setState("focusWait"),this.captureMouse(e);return}}return this.captureMouse(e),this.startSelect(n,e.domEvent._clicks>1),e.preventDefault()},this.startSelect=function(e,t){e=e||this.editor.renderer.screenToTextCoordinates(this.x,this.y);var n=this.editor;if(!this.mousedownEvent)return;this.mousedownEvent.getShiftKey()?n.selection.selectToPosition(e):t||n.selection.moveToPosition(e),t||this.select(),n.renderer.scroller.setCapture&&n.renderer.scroller.setCapture(),n.setStyle("ace_selecting"),this.setState("select")},this.select=function(){var e,t=this.editor,n=t.renderer.screenToTextCoordinates(this.x,this.y);if(this.$clickSelection){var r=this.$clickSelection.comparePoint(n);if(r==-1)e=this.$clickSelection.end;else if(r==1)e=this.$clickSelection.start;else{var i=a(this.$clickSelection,n);n=i.cursor,e=i.anchor}t.selection.setSelectionAnchor(e.row,e.column)}t.selection.selectToPosition(n),t.renderer.scrollCursorIntoView()},this.extendSelectionBy=function(e){var t,n=this.editor,r=n.renderer.screenToTextCoordinates(this.x,this.y),i=n.selection[e](r.row,r.column);if(this.$clickSelection){var s=this.$clickSelection.comparePoint(i.start),o=this.$clickSelection.comparePoint(i.end);if(s==-1&&o<=0){t=this.$clickSelection.end;if(i.end.row!=r.row||i.end.column!=r.column)r=i.start}else if(o==1&&s>=0){t=this.$clickSelection.start;if(i.start.row!=r.row||i.start.column!=r.column)r=i.end}else if(s==-1&&o==1)r=i.end,t=i.start;else{var u=a(this.$clickSelection,r);r=u.cursor,t=u.anchor}n.selection.setSelectionAnchor(t.row,t.column)}n.selection.selectToPosition(r),n.renderer.scrollCursorIntoView()},this.selectEnd=this.selectAllEnd=this.selectByWordsEnd=this.selectByLinesEnd=function(){this.$clickSelection=null,this.editor.unsetStyle("ace_selecting"),this.editor.renderer.scroller.releaseCapture&&this.editor.renderer.scroller.releaseCapture()},this.focusWait=function(){var e=u(this.mousedownEvent.x,this.mousedownEvent.y,this.x,this.y),t=Date.now();(e>i||t-this.mousedownEvent.time>this.$focusTimeout)&&this.startSelect(this.mousedownEvent.getDocumentPosition())},this.onDoubleClick=function(e){var t=e.getDocumentPosition(),n=this.editor,r=n.session,i=r.getBracketRange(t);i?(i.isEmpty()&&(i.start.column--,i.end.column++),this.setState("select")):(i=n.selection.getWordRange(t.row,t.column),this.setState("selectByWords")),this.$clickSelection=i,this.select()},this.onTripleClick=function(e){var t=e.getDocumentPosition(),n=this.editor;this.setState("selectByLines");var r=n.getSelectionRange();r.isMultiLine()&&r.contains(t.row,t.column)?(this.$clickSelection=n.selection.getLineRange(r.start.row),this.$clickSelection.end=n.selection.getLineRange(r.end.row).end):this.$clickSelection=n.selection.getLineRange(t.row),this.select()},this.onQuadClick=function(e){var t=this.editor;t.selectAll(),this.$clickSelection=t.getSelectionRange(),this.setState("selectAll")},this.onMouseWheel=function(e){if(e.getAccelKey())return;e.getShiftKey()&&e.wheelY&&!e.wheelX&&(e.wheelX=e.wheelY,e.wheelY=0);var t=this.editor;this.$lastScroll||(this.$lastScroll={t:0,vx:0,vy:0,allowed:0});var n=this.$lastScroll,r=e.domEvent.timeStamp,i=r-n.t,o=i?e.wheelX/i:n.vx,u=i?e.wheelY/i:n.vy;i=1&&t.renderer.isScrollableBy(e.wheelX*e.speed,0)&&(f=!0),a<=1&&t.renderer.isScrollableBy(0,e.wheelY*e.speed)&&(f=!0);if(f)n.allowed=r;else if(r-n.allowedt.session.documentToScreenRow(l.row,l.column))return c()}if(f==s)return;f=s.text.join("
        "),i.setHtml(f),i.show(),t._signal("showGutterTooltip",i),t.on("mousewheel",c);if(e.$tooltipFollowsMouse)h(u);else{var p=u.domEvent.target,d=p.getBoundingClientRect(),v=i.getElement().style;v.left=d.right+"px",v.top=d.bottom+"px"}}function c(){o&&(o=clearTimeout(o)),f&&(i.hide(),f=null,t._signal("hideGutterTooltip",i),t.off("mousewheel",c))}function h(e){i.setPosition(e.x,e.y)}var t=e.editor,n=t.renderer.$gutterLayer,i=new a(t.container);e.editor.setDefaultHandler("guttermousedown",function(r){if(!t.isFocused()||r.getButton()!=0)return;var i=n.getRegion(r);if(i=="foldWidgets")return;var s=r.getDocumentPosition().row,o=t.session.selection;if(r.getShiftKey())o.selectTo(s,0);else{if(r.domEvent.detail==2)return t.selectAll(),r.preventDefault();e.$clickSelection=t.selection.getLineRange(s)}return e.setState("selectByLines"),e.captureMouse(r),r.preventDefault()});var o,u,f;e.editor.setDefaultHandler("guttermousemove",function(t){var n=t.domEvent.target||t.domEvent.srcElement;if(r.hasCssClass(n,"ace_fold-widget"))return c();f&&e.$tooltipFollowsMouse&&h(t),u=t;if(o)return;o=setTimeout(function(){o=null,u&&!e.isMousePressed?l():c()},50)}),s.addListener(t.renderer.$gutter,"mouseout",function(e){u=null;if(!f||o)return;o=setTimeout(function(){o=null,c()},50)},t),t.on("changeSession",c)}function a(e){o.call(this,e)}var r=e("../lib/dom"),i=e("../lib/oop"),s=e("../lib/event"),o=e("../tooltip").Tooltip;i.inherits(a,o),function(){this.setPosition=function(e,t){var n=window.innerWidth||document.documentElement.clientWidth,r=window.innerHeight||document.documentElement.clientHeight,i=this.getWidth(),s=this.getHeight();e+=15,t+=15,e+i>n&&(e-=e+i-n),t+s>r&&(t-=20+s),o.prototype.setPosition.call(this,e,t)}}.call(a.prototype),t.GutterHandler=u}),define("ace/mouse/mouse_event",["require","exports","module","ace/lib/event","ace/lib/useragent"],function(e,t,n){"use strict";var r=e("../lib/event"),i=e("../lib/useragent"),s=t.MouseEvent=function(e,t){this.domEvent=e,this.editor=t,this.x=this.clientX=e.clientX,this.y=this.clientY=e.clientY,this.$pos=null,this.$inSelection=null,this.propagationStopped=!1,this.defaultPrevented=!1};(function(){this.stopPropagation=function(){r.stopPropagation(this.domEvent),this.propagationStopped=!0},this.preventDefault=function(){r.preventDefault(this.domEvent),this.defaultPrevented=!0},this.stop=function(){this.stopPropagation(),this.preventDefault()},this.getDocumentPosition=function(){return this.$pos?this.$pos:(this.$pos=this.editor.renderer.screenToTextCoordinates(this.clientX,this.clientY),this.$pos)},this.inSelection=function(){if(this.$inSelection!==null)return this.$inSelection;var e=this.editor,t=e.getSelectionRange();if(t.isEmpty())this.$inSelection=!1;else{var n=this.getDocumentPosition();this.$inSelection=t.contains(n.row,n.column)}return this.$inSelection},this.getButton=function(){return r.getButton(this.domEvent)},this.getShiftKey=function(){return this.domEvent.shiftKey},this.getAccelKey=i.isMac?function(){return this.domEvent.metaKey}:function(){return this.domEvent.ctrlKey}}).call(s.prototype)}),define("ace/mouse/dragdrop_handler",["require","exports","module","ace/lib/dom","ace/lib/event","ace/lib/useragent"],function(e,t,n){"use strict";function f(e){function T(e,n){var r=Date.now(),i=!n||e.row!=n.row,s=!n||e.column!=n.column;if(!S||i||s)t.moveCursorToPosition(e),S=r,x={x:p,y:d};else{var o=l(x.x,x.y,p,d);o>a?S=null:r-S>=u&&(t.renderer.scrollCursorIntoView(),S=null)}}function N(e,n){var r=Date.now(),i=t.renderer.layerConfig.lineHeight,s=t.renderer.layerConfig.characterWidth,u=t.renderer.scroller.getBoundingClientRect(),a={x:{left:p-u.left,right:u.right-p},y:{top:d-u.top,bottom:u.bottom-d}},f=Math.min(a.x.left,a.x.right),l=Math.min(a.y.top,a.y.bottom),c={row:e.row,column:e.column};f/s<=2&&(c.column+=a.x.left=o&&t.renderer.scrollCursorIntoView(c):E=r:E=null}function C(){var e=g;g=t.renderer.screenToTextCoordinates(p,d),T(g,e),N(g,e)}function k(){m=t.selection.toOrientedRange(),h=t.session.addMarker(m,"ace_selection",t.getSelectionStyle()),t.clearSelection(),t.isFocused()&&t.renderer.$cursorLayer.setBlinking(!1),clearInterval(v),C(),v=setInterval(C,20),y=0,i.addListener(document,"mousemove",O)}function L(){clearInterval(v),t.session.removeMarker(h),h=null,t.selection.fromOrientedRange(m),t.isFocused()&&!w&&t.$resetCursorStyle(),m=null,g=null,y=0,E=null,S=null,i.removeListener(document,"mousemove",O)}function O(){A==null&&(A=setTimeout(function(){A!=null&&h&&L()},20))}function M(e){var t=e.types;return!t||Array.prototype.some.call(t,function(e){return e=="text/plain"||e=="Text"})}function _(e){var t=["copy","copymove","all","uninitialized"],n=["move","copymove","linkmove","all","uninitialized"],r=s.isMac?e.altKey:e.ctrlKey,i="uninitialized";try{i=e.dataTransfer.effectAllowed.toLowerCase()}catch(e){}var o="none";return r&&t.indexOf(i)>=0?o="copy":n.indexOf(i)>=0?o="move":t.indexOf(i)>=0&&(o="copy"),o}var t=e.editor,n=r.createElement("img");n.src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==",s.isOpera&&(n.style.cssText="width:1px;height:1px;position:fixed;top:0;left:0;z-index:2147483647;opacity:0;");var f=["dragWait","dragWaitEnd","startDrag","dragReadyEnd","onMouseDrag"];f.forEach(function(t){e[t]=this[t]},this),t.on("mousedown",this.onMouseDown.bind(e));var c=t.container,h,p,d,v,m,g,y=0,b,w,E,S,x;this.onDragStart=function(e){if(this.cancelDrag||!c.draggable){var r=this;return setTimeout(function(){r.startSelect(),r.captureMouse(e)},0),e.preventDefault()}m=t.getSelectionRange();var i=e.dataTransfer;i.effectAllowed=t.getReadOnly()?"copy":"copyMove",s.isOpera&&(t.container.appendChild(n),n.scrollTop=0),i.setDragImage&&i.setDragImage(n,0,0),s.isOpera&&t.container.removeChild(n),i.clearData(),i.setData("Text",t.session.getTextRange()),w=!0,this.setState("drag")},this.onDragEnd=function(e){c.draggable=!1,w=!1,this.setState(null);if(!t.getReadOnly()){var n=e.dataTransfer.dropEffect;!b&&n=="move"&&t.session.remove(t.getSelectionRange()),t.$resetCursorStyle()}this.editor.unsetStyle("ace_dragging"),this.editor.renderer.setCursorStyle("")},this.onDragEnter=function(e){if(t.getReadOnly()||!M(e.dataTransfer))return;return p=e.clientX,d=e.clientY,h||k(),y++,e.dataTransfer.dropEffect=b=_(e),i.preventDefault(e)},this.onDragOver=function(e){if(t.getReadOnly()||!M(e.dataTransfer))return;return p=e.clientX,d=e.clientY,h||(k(),y++),A!==null&&(A=null),e.dataTransfer.dropEffect=b=_(e),i.preventDefault(e)},this.onDragLeave=function(e){y--;if(y<=0&&h)return L(),b=null,i.preventDefault(e)},this.onDrop=function(e){if(!g)return;var n=e.dataTransfer;if(w)switch(b){case"move":m.contains(g.row,g.column)?m={start:g,end:g}:m=t.moveText(m,g);break;case"copy":m=t.moveText(m,g,!0)}else{var r=n.getData("Text");m={start:g,end:t.session.insert(g,r)},t.focus(),b=null}return L(),i.preventDefault(e)},i.addListener(c,"dragstart",this.onDragStart.bind(e),t),i.addListener(c,"dragend",this.onDragEnd.bind(e),t),i.addListener(c,"dragenter",this.onDragEnter.bind(e),t),i.addListener(c,"dragover",this.onDragOver.bind(e),t),i.addListener(c,"dragleave",this.onDragLeave.bind(e),t),i.addListener(c,"drop",this.onDrop.bind(e),t);var A=null}function l(e,t,n,r){return Math.sqrt(Math.pow(n-e,2)+Math.pow(r-t,2))}var r=e("../lib/dom"),i=e("../lib/event"),s=e("../lib/useragent"),o=200,u=200,a=5;(function(){this.dragWait=function(){var e=Date.now()-this.mousedownEvent.time;e>this.editor.getDragDelay()&&this.startDrag()},this.dragWaitEnd=function(){var e=this.editor.container;e.draggable=!1,this.startSelect(this.mousedownEvent.getDocumentPosition()),this.selectEnd()},this.dragReadyEnd=function(e){this.editor.$resetCursorStyle(),this.editor.unsetStyle("ace_dragging"),this.editor.renderer.setCursorStyle(""),this.dragWaitEnd()},this.startDrag=function(){this.cancelDrag=!1;var e=this.editor,t=e.container;t.draggable=!0,e.renderer.$cursorLayer.setBlinking(!1),e.setStyle("ace_dragging");var n=s.isWin?"default":"move";e.renderer.setCursorStyle(n),this.setState("dragReady")},this.onMouseDrag=function(e){var t=this.editor.container;if(s.isIE&&this.state=="dragReady"){var n=l(this.mousedownEvent.x,this.mousedownEvent.y,this.x,this.y);n>3&&t.dragDrop()}if(this.state==="dragWait"){var n=l(this.mousedownEvent.x,this.mousedownEvent.y,this.x,this.y);n>0&&(t.draggable=!1,this.startSelect(this.mousedownEvent.getDocumentPosition()))}},this.onMouseDown=function(e){if(!this.$dragEnabled)return;this.mousedownEvent=e;var t=this.editor,n=e.inSelection(),r=e.getButton(),i=e.domEvent.detail||1;if(i===1&&r===0&&n){if(e.editor.inMultiSelectMode&&(e.getAccelKey()||e.getShiftKey()))return;this.mousedownEvent.time=Date.now();var o=e.domEvent.target||e.domEvent.srcElement;"unselectable"in o&&(o.unselectable="on");if(t.getDragDelay()){if(s.isWebKit){this.cancelDrag=!0;var u=t.container;u.draggable=!0}this.setState("dragWait")}else this.startDrag();this.captureMouse(e,this.onMouseDrag.bind(this)),e.defaultPrevented=!0}}}).call(f.prototype),t.DragdropHandler=f}),define("ace/mouse/touch_handler",["require","exports","module","ace/mouse/mouse_event","ace/lib/event","ace/lib/dom"],function(e,t,n){"use strict";var r=e("./mouse_event").MouseEvent,i=e("../lib/event"),s=e("../lib/dom");t.addTouchListeners=function(e,t){function b(){var e=window.navigator&&window.navigator.clipboard,r=!1,i=function(){var n=t.getCopyText(),i=t.session.getUndoManager().hasUndo();y.replaceChild(s.buildDom(r?["span",!n&&["span",{"class":"ace_mobile-button",action:"selectall"},"Select All"],n&&["span",{"class":"ace_mobile-button",action:"copy"},"Copy"],n&&["span",{"class":"ace_mobile-button",action:"cut"},"Cut"],e&&["span",{"class":"ace_mobile-button",action:"paste"},"Paste"],i&&["span",{"class":"ace_mobile-button",action:"undo"},"Undo"],["span",{"class":"ace_mobile-button",action:"find"},"Find"],["span",{"class":"ace_mobile-button",action:"openCommandPallete"},"Pallete"]]:["span"]),y.firstChild)},o=function(n){var s=n.target.getAttribute("action");if(s=="more"||!r)return r=!r,i();if(s=="paste")e.readText().then(function(e){t.execCommand(s,e)});else if(s){if(s=="cut"||s=="copy")e?e.writeText(t.getCopyText()):document.execCommand("copy");t.execCommand(s)}y.firstChild.style.display="none",r=!1,s!="openCommandPallete"&&t.focus()};y=s.buildDom(["div",{"class":"ace_mobile-menu",ontouchstart:function(e){n="menu",e.stopPropagation(),e.preventDefault(),t.textInput.focus()},ontouchend:function(e){e.stopPropagation(),e.preventDefault(),o(e)},onclick:o},["span"],["span",{"class":"ace_mobile-button",action:"more"},"..."]],t.container)}function w(){y||b();var e=t.selection.cursor,n=t.renderer.textToScreenCoordinates(e.row,e.column),r=t.container.getBoundingClientRect();y.style.top=n.pageY-r.top-3+"px",y.style.right="10px",y.style.display="",y.firstChild.style.display="none",t.on("input",E)}function E(e){y&&(y.style.display="none"),t.off("input",E)}function S(){l=null,clearTimeout(l);var e=t.selection.getRange(),r=e.contains(p.row,p.column);if(e.isEmpty()||!r)t.selection.moveToPosition(p),t.selection.selectWord();n="wait",w()}function x(){l=null,clearTimeout(l),t.selection.moveToPosition(p);var e=d>=2?t.selection.getLineRange(p.row):t.session.getBracketRange(p);e&&!e.isEmpty()?t.selection.setRange(e):t.selection.selectWord(),n="wait"}function T(){h+=60,c=setInterval(function(){h--<=0&&(clearInterval(c),c=null),Math.abs(v)<.01&&(v=0),Math.abs(m)<.01&&(m=0),h<20&&(v=.9*v),h<20&&(m=.9*m);var e=t.session.getScrollTop();t.renderer.scrollBy(10*v,10*m),e==t.session.getScrollTop()&&(h=0)},10)}var n="scroll",o,u,a,f,l,c,h=0,p,d=0,v=0,m=0,g,y;i.addListener(e,"contextmenu",function(e){if(!g)return;var n=t.textInput.getElement();n.focus()},t),i.addListener(e,"touchstart",function(e){var i=e.touches;if(l||i.length>1){clearTimeout(l),l=null,a=-1,n="zoom";return}g=t.$mouseHandler.isMousePressed=!0;var s=t.renderer.layerConfig.lineHeight,c=t.renderer.layerConfig.lineHeight,y=e.timeStamp;f=y;var b=i[0],w=b.clientX,E=b.clientY;Math.abs(o-w)+Math.abs(u-E)>s&&(a=-1),o=e.clientX=w,u=e.clientY=E,v=m=0;var T=new r(e,t);p=T.getDocumentPosition();if(y-a<500&&i.length==1&&!h)d++,e.preventDefault(),e.button=0,x();else{d=0;var N=t.selection.cursor,C=t.selection.isEmpty()?N:t.selection.anchor,k=t.renderer.$cursorLayer.getPixelPosition(N,!0),L=t.renderer.$cursorLayer.getPixelPosition(C,!0),A=t.renderer.scroller.getBoundingClientRect(),O=function(e,t){return e/=c,t=t/s-.75,e*e+t*t};if(e.clientX_?"cursor":"anchor"),_<3.5?n="anchor":M<3.5?n="cursor":n="scroll",l=setTimeout(S,450)}a=y},t),i.addListener(e,"touchend",function(e){g=t.$mouseHandler.isMousePressed=!1,c&&clearInterval(c),n=="zoom"?(n="",h=0):l?(t.selection.moveToPosition(p),h=0,w()):n=="scroll"?(T(),E()):w(),clearTimeout(l),l=null},t),i.addListener(e,"touchmove",function(e){l&&(clearTimeout(l),l=null);var i=e.touches;if(i.length>1||n=="zoom")return;var s=i[0],a=o-s.clientX,c=u-s.clientY;if(n=="wait"){if(!(a*a+c*c>4))return e.preventDefault();n="cursor"}o=s.clientX,u=s.clientY,e.clientX=s.clientX,e.clientY=s.clientY;var h=e.timeStamp,p=h-f;f=h;if(n=="scroll"){var d=new r(e,t);d.speed=1,d.wheelX=a,d.wheelY=c,10*Math.abs(a)1&&(i=n[n.length-2]);var o=a[t+"Path"];return o==null?o=a.basePath:r=="/"&&(t=r=""),o&&o.slice(-1)!="/"&&(o+="/"),o+t+r+i+this.get("suffix")},t.setModuleUrl=function(e,t){return a.$moduleUrls[e]=t},t.$loading={},t.loadModule=function(n,r){var i,o;Array.isArray(n)&&(o=n[0],n=n[1]);try{i=e(n)}catch(u){}if(i&&!t.$loading[n])return r&&r(i);t.$loading[n]||(t.$loading[n]=[]),t.$loading[n].push(r);if(t.$loading[n].length>1)return;var a=function(){e([n],function(e){t._emit("load.module",{name:n,module:e});var r=t.$loading[n];t.$loading[n]=null,r.forEach(function(t){t&&t(e)})})};if(!t.get("packaged"))return a();s.loadScript(t.moduleUrl(n,o),a),f()};var f=function(){!a.basePath&&!a.workerPath&&!a.modePath&&!a.themePath&&!Object.keys(a.$moduleUrls).length&&(console.error("Unable to infer path to ace from script src,","use ace.config.set('basePath', 'path') to enable dynamic loading of modes and themes","or with webpack use ace/webpack-resolver"),f=function(){})};t.init=l,t.version="1.4.10"}),define("ace/mouse/mouse_handler",["require","exports","module","ace/lib/event","ace/lib/useragent","ace/mouse/default_handlers","ace/mouse/default_gutter_handler","ace/mouse/mouse_event","ace/mouse/dragdrop_handler","ace/mouse/touch_handler","ace/config"],function(e,t,n){"use strict";var r=e("../lib/event"),i=e("../lib/useragent"),s=e("./default_handlers").DefaultHandlers,o=e("./default_gutter_handler").GutterHandler,u=e("./mouse_event").MouseEvent,a=e("./dragdrop_handler").DragdropHandler,f=e("./touch_handler").addTouchListeners,l=e("../config"),c=function(e){var t=this;this.editor=e,new s(this),new o(this),new a(this);var n=function(t){var n=!document.hasFocus||!document.hasFocus()||!e.isFocused()&&document.activeElement==(e.textInput&&e.textInput.getElement());n&&window.focus(),e.focus()},u=e.renderer.getMouseEventTarget();r.addListener(u,"click",this.onMouseEvent.bind(this,"click"),e),r.addListener(u,"mousemove",this.onMouseMove.bind(this,"mousemove"),e),r.addMultiMouseDownListener([u,e.renderer.scrollBarV&&e.renderer.scrollBarV.inner,e.renderer.scrollBarH&&e.renderer.scrollBarH.inner,e.textInput&&e.textInput.getElement()].filter(Boolean),[400,300,250],this,"onMouseEvent",e),r.addMouseWheelListener(e.container,this.onMouseWheel.bind(this,"mousewheel"),e),f(e.container,e);var l=e.renderer.$gutter;r.addListener(l,"mousedown",this.onMouseEvent.bind(this,"guttermousedown"),e),r.addListener(l,"click",this.onMouseEvent.bind(this,"gutterclick"),e),r.addListener(l,"dblclick",this.onMouseEvent.bind(this,"gutterdblclick"),e),r.addListener(l,"mousemove",this.onMouseEvent.bind(this,"guttermousemove"),e),r.addListener(u,"mousedown",n,e),r.addListener(l,"mousedown",n,e),i.isIE&&e.renderer.scrollBarV&&(r.addListener(e.renderer.scrollBarV.element,"mousedown",n,e),r.addListener(e.renderer.scrollBarH.element,"mousedown",n,e)),e.on("mousemove",function(n){if(t.state||t.$dragDelay||!t.$dragEnabled)return;var r=e.renderer.screenToTextCoordinates(n.x,n.y),i=e.session.selection.getRange(),s=e.renderer;!i.isEmpty()&&i.insideStart(r.row,r.column)?s.setCursorStyle("default"):s.setCursorStyle("")},e)};(function(){this.onMouseEvent=function(e,t){this.editor._emit(e,new u(t,this.editor))},this.onMouseMove=function(e,t){var n=this.editor._eventRegistry&&this.editor._eventRegistry.mousemove;if(!n||!n.length)return;this.editor._emit(e,new u(t,this.editor))},this.onMouseWheel=function(e,t){var n=new u(t,this.editor);n.speed=this.$scrollSpeed*2,n.wheelX=t.wheelX,n.wheelY=t.wheelY,this.editor._emit(e,n)},this.setState=function(e){this.state=e},this.captureMouse=function(e,t){this.x=e.x,this.y=e.y,this.isMousePressed=!0;var n=this.editor,s=this.editor.renderer;s.$isMousePressed=!0;var o=this,a=function(e){if(!e)return;if(i.isWebKit&&!e.which&&o.releaseMouse)return o.releaseMouse();o.x=e.clientX,o.y=e.clientY,t&&t(e),o.mouseEvent=new u(e,o.editor),o.$mouseMoved=!0},f=function(e){n.off("beforeEndOperation",c),clearInterval(h),l(),o[o.state+"End"]&&o[o.state+"End"](e),o.state="",o.isMousePressed=s.$isMousePressed=!1,s.$keepTextAreaAtCursor&&s.$moveTextAreaToCursor(),o.$onCaptureMouseMove=o.releaseMouse=null,e&&o.onMouseEvent("mouseup",e),n.endOperation()},l=function(){o[o.state]&&o[o.state](),o.$mouseMoved=!1};if(i.isOldIE&&e.domEvent.type=="dblclick")return setTimeout(function(){f(e)});var c=function(e){if(!o.releaseMouse)return;n.curOp.command.name&&n.curOp.selectionChanged&&(o[o.state+"End"]&&o[o.state+"End"](),o.state="",o.releaseMouse())};n.on("beforeEndOperation",c),n.startOperation({command:{name:"mouse"}}),o.$onCaptureMouseMove=a,o.releaseMouse=r.capture(this.editor.container,a,f);var h=setInterval(l,20)},this.releaseMouse=null,this.cancelContextMenu=function(){var e=function(t){if(t&&t.domEvent&&t.domEvent.type!="contextmenu")return;this.editor.off("nativecontextmenu",e),t&&t.domEvent&&r.stopEvent(t.domEvent)}.bind(this);setTimeout(e,10),this.editor.on("nativecontextmenu",e)}}).call(c.prototype),l.defineOptions(c.prototype,"mouseHandler",{scrollSpeed:{initialValue:2},dragDelay:{initialValue:i.isMac?150:0},dragEnabled:{initialValue:!0},focusTimeout:{initialValue:0},tooltipFollowsMouse:{initialValue:!0}}),t.MouseHandler=c}),define("ace/mouse/fold_handler",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";function i(e){e.on("click",function(t){var n=t.getDocumentPosition(),i=e.session,s=i.getFoldAt(n.row,n.column,1);s&&(t.getAccelKey()?i.removeFold(s):i.expandFold(s),t.stop());var o=t.domEvent&&t.domEvent.target;o&&r.hasCssClass(o,"ace_inline_button")&&r.hasCssClass(o,"ace_toggle_wrap")&&(i.setOption("wrap",!i.getUseWrapMode()),e.renderer.scrollCursorIntoView())}),e.on("gutterclick",function(t){var n=e.renderer.$gutterLayer.getRegion(t);if(n=="foldWidgets"){var r=t.getDocumentPosition().row,i=e.session;i.foldWidgets&&i.foldWidgets[r]&&e.session.onFoldWidgetClick(r,t),e.isFocused()||e.focus(),t.stop()}}),e.on("gutterdblclick",function(t){var n=e.renderer.$gutterLayer.getRegion(t);if(n=="foldWidgets"){var r=t.getDocumentPosition().row,i=e.session,s=i.getParentFoldRangeData(r,!0),o=s.range||s.firstRange;if(o){r=o.start.row;var u=i.getFoldAt(r,i.getLine(r).length,1);u?i.removeFold(u):(i.addFold("...",o),e.renderer.scrollCursorIntoView({row:o.start.row,column:0}))}t.stop()}})}var r=e("../lib/dom");t.FoldHandler=i}),define("ace/keyboard/keybinding",["require","exports","module","ace/lib/keys","ace/lib/event"],function(e,t,n){"use strict";var r=e("../lib/keys"),i=e("../lib/event"),s=function(e){this.$editor=e,this.$data={editor:e},this.$handlers=[],this.setDefaultHandler(e.commands)};(function(){this.setDefaultHandler=function(e){this.removeKeyboardHandler(this.$defaultHandler),this.$defaultHandler=e,this.addKeyboardHandler(e,0)},this.setKeyboardHandler=function(e){var t=this.$handlers;if(t[t.length-1]==e)return;while(t[t.length-1]&&t[t.length-1]!=this.$defaultHandler)this.removeKeyboardHandler(t[t.length-1]);this.addKeyboardHandler(e,1)},this.addKeyboardHandler=function(e,t){if(!e)return;typeof e=="function"&&!e.handleKeyboard&&(e.handleKeyboard=e);var n=this.$handlers.indexOf(e);n!=-1&&this.$handlers.splice(n,1),t==undefined?this.$handlers.push(e):this.$handlers.splice(t,0,e),n==-1&&e.attach&&e.attach(this.$editor)},this.removeKeyboardHandler=function(e){var t=this.$handlers.indexOf(e);return t==-1?!1:(this.$handlers.splice(t,1),e.detach&&e.detach(this.$editor),!0)},this.getKeyboardHandler=function(){return this.$handlers[this.$handlers.length-1]},this.getStatusText=function(){var e=this.$data,t=e.editor;return this.$handlers.map(function(n){return n.getStatusText&&n.getStatusText(t,e)||""}).filter(Boolean).join(" ")},this.$callKeyboardHandlers=function(e,t,n,r){var s,o=!1,u=this.$editor.commands;for(var a=this.$handlers.length;a--;){s=this.$handlers[a].handleKeyboard(this.$data,e,t,n,r);if(!s||!s.command)continue;s.command=="null"?o=!0:o=u.exec(s.command,this.$editor,s.args,r),o&&r&&e!=-1&&s.passEvent!=1&&s.command.passEvent!=1&&i.stopEvent(r);if(o)break}return!o&&e==-1&&(s={command:"insertstring"},o=u.exec("insertstring",this.$editor,t)),o&&this.$editor._signal&&this.$editor._signal("keyboardActivity",s),o},this.onCommandKey=function(e,t,n){var i=r.keyCodeToString(n);return this.$callKeyboardHandlers(t,i,n,e)},this.onTextInput=function(e){return this.$callKeyboardHandlers(-1,e)}}).call(s.prototype),t.KeyBinding=s}),define("ace/lib/bidiutil",["require","exports","module"],function(e,t,n){"use strict";function F(e,t,n,r){var i=s?d:p,c=null,h=null,v=null,m=0,g=null,y=null,b=-1,w=null,E=null,T=[];if(!r)for(w=0,r=[];w0)if(g==16){for(w=b;w-1){for(w=b;w=0;C--){if(r[C]!=N)break;t[C]=s}}}function I(e,t,n){if(o=e){u=i+1;while(u=e)u++;for(a=i,l=u-1;a=t.length||(o=n[r-1])!=b&&o!=w||(c=t[r+1])!=b&&c!=w)return E;return u&&(c=w),c==o?c:E;case k:o=r>0?n[r-1]:S;if(o==b&&r+10&&n[r-1]==b)return b;if(u)return E;p=r+1,h=t.length;while(p=1425&&d<=2303||d==64286;o=t[p];if(v&&(o==y||o==T))return y}if(r<1||(o=t[r-1])==S)return E;return n[r-1];case S:return u=!1,f=!0,s;case x:return l=!0,E;case O:case M:case D:case P:case _:u=!1;case H:return E}}function R(e){var t=e.charCodeAt(0),n=t>>8;return n==0?t>191?g:B[t]:n==5?/[\u0591-\u05f4]/.test(e)?y:g:n==6?/[\u0610-\u061a\u064b-\u065f\u06d6-\u06e4\u06e7-\u06ed]/.test(e)?A:/[\u0660-\u0669\u066b-\u066c]/.test(e)?w:t==1642?L:/[\u06f0-\u06f9]/.test(e)?b:T:n==32&&t<=8287?j[t&255]:n==254?t>=65136?T:E:E}function U(e){return e>="\u064b"&&e<="\u0655"}var r=["\u0621","\u0641"],i=["\u063a","\u064a"],s=0,o=0,u=!1,a=!1,f=!1,l=!1,c=!1,h=!1,p=[[0,3,0,1,0,0,0],[0,3,0,1,2,2,0],[0,3,0,17,2,0,1],[0,3,5,5,4,1,0],[0,3,21,21,4,0,1],[0,3,5,5,4,2,0]],d=[[2,0,1,1,0,1,0],[2,0,1,1,0,2,0],[2,0,2,1,3,2,0],[2,0,2,33,3,1,1]],v=0,m=1,g=0,y=1,b=2,w=3,E=4,S=5,x=6,T=7,N=8,C=9,k=10,L=11,A=12,O=13,M=14,_=15,D=16,P=17,H=18,B=[H,H,H,H,H,H,H,H,H,x,S,x,N,S,H,H,H,H,H,H,H,H,H,H,H,H,H,H,S,S,S,x,N,E,E,L,L,L,E,E,E,E,E,k,C,k,C,C,b,b,b,b,b,b,b,b,b,b,C,E,E,E,E,E,E,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,E,E,E,E,E,E,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,g,E,E,E,E,H,H,H,H,H,H,S,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,H,C,E,L,L,L,L,E,E,E,E,g,E,E,H,E,E,L,L,b,b,E,g,E,E,E,b,g,E,E,E,E,E],j=[N,N,N,N,N,N,N,N,N,N,N,H,H,H,g,y,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,N,S,O,M,_,D,P,C,L,L,L,L,L,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,C,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,E,N];t.L=g,t.R=y,t.EN=b,t.ON_R=3,t.AN=4,t.R_H=5,t.B=6,t.RLE=7,t.DOT="\u00b7",t.doBidiReorder=function(e,n,r){if(e.length<2)return{};var i=e.split(""),o=new Array(i.length),u=new Array(i.length),a=[];s=r?m:v,F(i,a,i.length,n);for(var f=0;fT&&n[f]0&&i[f-1]==="\u0644"&&/\u0622|\u0623|\u0625|\u0627/.test(i[f])&&(a[f-1]=a[f]=t.R_H,f++);i[i.length-1]===t.DOT&&(a[i.length-1]=t.B),i[0]==="\u202b"&&(a[0]=t.RLE);for(var f=0;f=0&&(e=this.session.$docRowCache[n])}return e},this.getSplitIndex=function(){var e=0,t=this.session.$screenRowCache;if(t.length){var n,r=this.session.$getRowCacheIndex(t,this.currentRow);while(this.currentRow-e>0){n=this.session.$getRowCacheIndex(t,this.currentRow-e-1);if(n!==r)break;r=n,e++}}else e=this.currentRow;return e},this.updateRowLine=function(e,t){e===undefined&&(e=this.getDocumentRow());var n=e===this.session.getLength()-1,s=n?this.EOF:this.EOL;this.wrapIndent=0,this.line=this.session.getLine(e),this.isRtlDir=this.$isRtl||this.line.charAt(0)===this.RLE;if(this.session.$useWrapMode){var o=this.session.$wrapData[e];o&&(t===undefined&&(t=this.getSplitIndex()),t>0&&o.length?(this.wrapIndent=o.indent,this.wrapOffset=this.wrapIndent*this.charWidths[r.L],this.line=tt?this.session.getOverwrite()?e:e-1:t,i=r.getVisualFromLogicalIdx(n,this.bidiMap),s=this.bidiMap.bidiLevels,o=0;!this.session.getOverwrite()&&e<=t&&s[i]%2!==0&&i++;for(var u=0;ut&&s[i]%2===0&&(o+=this.charWidths[s[i]]),this.wrapIndent&&(o+=this.isRtlDir?-1*this.wrapOffset:this.wrapOffset),this.isRtlDir&&(o+=this.rtlLineOffset),o},this.getSelections=function(e,t){var n=this.bidiMap,r=n.bidiLevels,i,s=[],o=0,u=Math.min(e,t)-this.wrapIndent,a=Math.max(e,t)-this.wrapIndent,f=!1,l=!1,c=0;this.wrapIndent&&(o+=this.isRtlDir?-1*this.wrapOffset:this.wrapOffset);for(var h,p=0;p=u&&hn+s/2){n+=s;if(r===i.length-1){s=0;break}s=this.charWidths[i[++r]]}return r>0&&i[r-1]%2!==0&&i[r]%2===0?(e0&&i[r-1]%2===0&&i[r]%2!==0?t=1+(e>n?this.bidiMap.logicalFromVisual[r]:this.bidiMap.logicalFromVisual[r-1]):this.isRtlDir&&r===i.length-1&&s===0&&i[r-1]%2===0||!this.isRtlDir&&r===0&&i[r]%2!==0?t=1+this.bidiMap.logicalFromVisual[r]:(r>0&&i[r-1]%2!==0&&s!==0&&r--,t=this.bidiMap.logicalFromVisual[r]),t===0&&this.isRtlDir&&t++,t+this.wrapIndent}}).call(o.prototype),t.BidiHandler=o}),define("ace/selection",["require","exports","module","ace/lib/oop","ace/lib/lang","ace/lib/event_emitter","ace/range"],function(e,t,n){"use strict";var r=e("./lib/oop"),i=e("./lib/lang"),s=e("./lib/event_emitter").EventEmitter,o=e("./range").Range,u=function(e){this.session=e,this.doc=e.getDocument(),this.clearSelection(),this.cursor=this.lead=this.doc.createAnchor(0,0),this.anchor=this.doc.createAnchor(0,0),this.$silent=!1;var t=this;this.cursor.on("change",function(e){t.$cursorChanged=!0,t.$silent||t._emit("changeCursor"),!t.$isEmpty&&!t.$silent&&t._emit("changeSelection"),!t.$keepDesiredColumnOnChange&&e.old.column!=e.value.column&&(t.$desiredColumn=null)}),this.anchor.on("change",function(){t.$anchorChanged=!0,!t.$isEmpty&&!t.$silent&&t._emit("changeSelection")})};(function(){r.implement(this,s),this.isEmpty=function(){return this.$isEmpty||this.anchor.row==this.lead.row&&this.anchor.column==this.lead.column},this.isMultiLine=function(){return!this.$isEmpty&&this.anchor.row!=this.cursor.row},this.getCursor=function(){return this.lead.getPosition()},this.setSelectionAnchor=function(e,t){this.$isEmpty=!1,this.anchor.setPosition(e,t)},this.getAnchor=this.getSelectionAnchor=function(){return this.$isEmpty?this.getSelectionLead():this.anchor.getPosition()},this.getSelectionLead=function(){return this.lead.getPosition()},this.isBackwards=function(){var e=this.anchor,t=this.lead;return e.row>t.row||e.row==t.row&&e.column>t.column},this.getRange=function(){var e=this.anchor,t=this.lead;return this.$isEmpty?o.fromPoints(t,t):this.isBackwards()?o.fromPoints(t,e):o.fromPoints(e,t)},this.clearSelection=function(){this.$isEmpty||(this.$isEmpty=!0,this._emit("changeSelection"))},this.selectAll=function(){this.$setSelection(0,0,Number.MAX_VALUE,Number.MAX_VALUE)},this.setRange=this.setSelectionRange=function(e,t){var n=t?e.end:e.start,r=t?e.start:e.end;this.$setSelection(n.row,n.column,r.row,r.column)},this.$setSelection=function(e,t,n,r){if(this.$silent)return;var i=this.$isEmpty,s=this.inMultiSelectMode;this.$silent=!0,this.$cursorChanged=this.$anchorChanged=!1,this.anchor.setPosition(e,t),this.cursor.setPosition(n,r),this.$isEmpty=!o.comparePoints(this.anchor,this.cursor),this.$silent=!1,this.$cursorChanged&&this._emit("changeCursor"),(this.$cursorChanged||this.$anchorChanged||i!=this.$isEmpty||s)&&this._emit("changeSelection")},this.$moveSelection=function(e){var t=this.lead;this.$isEmpty&&this.setSelectionAnchor(t.row,t.column),e.call(this)},this.selectTo=function(e,t){this.$moveSelection(function(){this.moveCursorTo(e,t)})},this.selectToPosition=function(e){this.$moveSelection(function(){this.moveCursorToPosition(e)})},this.moveTo=function(e,t){this.clearSelection(),this.moveCursorTo(e,t)},this.moveToPosition=function(e){this.clearSelection(),this.moveCursorToPosition(e)},this.selectUp=function(){this.$moveSelection(this.moveCursorUp)},this.selectDown=function(){this.$moveSelection(this.moveCursorDown)},this.selectRight=function(){this.$moveSelection(this.moveCursorRight)},this.selectLeft=function(){this.$moveSelection(this.moveCursorLeft)},this.selectLineStart=function(){this.$moveSelection(this.moveCursorLineStart)},this.selectLineEnd=function(){this.$moveSelection(this.moveCursorLineEnd)},this.selectFileEnd=function(){this.$moveSelection(this.moveCursorFileEnd)},this.selectFileStart=function(){this.$moveSelection(this.moveCursorFileStart)},this.selectWordRight=function(){this.$moveSelection(this.moveCursorWordRight)},this.selectWordLeft=function(){this.$moveSelection(this.moveCursorWordLeft)},this.getWordRange=function(e,t){if(typeof t=="undefined"){var n=e||this.lead;e=n.row,t=n.column}return this.session.getWordRange(e,t)},this.selectWord=function(){this.setSelectionRange(this.getWordRange())},this.selectAWord=function(){var e=this.getCursor(),t=this.session.getAWordRange(e.row,e.column);this.setSelectionRange(t)},this.getLineRange=function(e,t){var n=typeof e=="number"?e:this.lead.row,r,i=this.session.getFoldLine(n);return i?(n=i.start.row,r=i.end.row):r=n,t===!0?new o(n,0,r,this.session.getLine(r).length):new o(n,0,r+1,0)},this.selectLine=function(){this.setSelectionRange(this.getLineRange())},this.moveCursorUp=function(){this.moveCursorBy(-1,0)},this.moveCursorDown=function(){this.moveCursorBy(1,0)},this.wouldMoveIntoSoftTab=function(e,t,n){var r=e.column,i=e.column+t;return n<0&&(r=e.column-t,i=e.column),this.session.isTabStop(e)&&this.doc.getLine(e.row).slice(r,i).split(" ").length-1==t},this.moveCursorLeft=function(){var e=this.lead.getPosition(),t;if(t=this.session.getFoldAt(e.row,e.column,-1))this.moveCursorTo(t.start.row,t.start.column);else if(e.column===0)e.row>0&&this.moveCursorTo(e.row-1,this.doc.getLine(e.row-1).length);else{var n=this.session.getTabSize();this.wouldMoveIntoSoftTab(e,n,-1)&&!this.session.getNavigateWithinSoftTabs()?this.moveCursorBy(0,-n):this.moveCursorBy(0,-1)}},this.moveCursorRight=function(){var e=this.lead.getPosition(),t;if(t=this.session.getFoldAt(e.row,e.column,1))this.moveCursorTo(t.end.row,t.end.column);else if(this.lead.column==this.doc.getLine(this.lead.row).length)this.lead.row0&&(t.column=r)}}this.moveCursorTo(t.row,t.column)},this.moveCursorFileEnd=function(){var e=this.doc.getLength()-1,t=this.doc.getLine(e).length;this.moveCursorTo(e,t)},this.moveCursorFileStart=function(){this.moveCursorTo(0,0)},this.moveCursorLongWordRight=function(){var e=this.lead.row,t=this.lead.column,n=this.doc.getLine(e),r=n.substring(t);this.session.nonTokenRe.lastIndex=0,this.session.tokenRe.lastIndex=0;var i=this.session.getFoldAt(e,t,1);if(i){this.moveCursorTo(i.end.row,i.end.column);return}this.session.nonTokenRe.exec(r)&&(t+=this.session.nonTokenRe.lastIndex,this.session.nonTokenRe.lastIndex=0,r=n.substring(t));if(t>=n.length){this.moveCursorTo(e,n.length),this.moveCursorRight(),e0&&this.moveCursorWordLeft();return}this.session.tokenRe.exec(s)&&(t-=this.session.tokenRe.lastIndex,this.session.tokenRe.lastIndex=0),this.moveCursorTo(e,t)},this.$shortWordEndIndex=function(e){var t=0,n,r=/\s/,i=this.session.tokenRe;i.lastIndex=0;if(this.session.tokenRe.exec(e))t=this.session.tokenRe.lastIndex;else{while((n=e[t])&&r.test(n))t++;if(t<1){i.lastIndex=0;while((n=e[t])&&!i.test(n)){i.lastIndex=0,t++;if(r.test(n)){if(t>2){t--;break}while((n=e[t])&&r.test(n))t++;if(t>2)break}}}}return i.lastIndex=0,t},this.moveCursorShortWordRight=function(){var e=this.lead.row,t=this.lead.column,n=this.doc.getLine(e),r=n.substring(t),i=this.session.getFoldAt(e,t,1);if(i)return this.moveCursorTo(i.end.row,i.end.column);if(t==n.length){var s=this.doc.getLength();do e++,r=this.doc.getLine(e);while(e0&&/^\s*$/.test(r));t=r.length,/\s+$/.test(r)||(r="")}var s=i.stringReverse(r),o=this.$shortWordEndIndex(s);return this.moveCursorTo(e,t-o)},this.moveCursorWordRight=function(){this.session.$selectLongWords?this.moveCursorLongWordRight():this.moveCursorShortWordRight()},this.moveCursorWordLeft=function(){this.session.$selectLongWords?this.moveCursorLongWordLeft():this.moveCursorShortWordLeft()},this.moveCursorBy=function(e,t){var n=this.session.documentToScreenPosition(this.lead.row,this.lead.column),r;t===0&&(e!==0&&(this.session.$bidiHandler.isBidiRow(n.row,this.lead.row)?(r=this.session.$bidiHandler.getPosLeft(n.column),n.column=Math.round(r/this.session.$bidiHandler.charWidths[0])):r=n.column*this.session.$bidiHandler.charWidths[0]),this.$desiredColumn?n.column=this.$desiredColumn:this.$desiredColumn=n.column);if(e!=0&&this.session.lineWidgets&&this.session.lineWidgets[this.lead.row]){var i=this.session.lineWidgets[this.lead.row];e<0?e-=i.rowsAbove||0:e>0&&(e+=i.rowCount-(i.rowsAbove||0))}var s=this.session.screenToDocumentPosition(n.row+e,n.column,r);e!==0&&t===0&&s.row===this.lead.row&&s.column===this.lead.column,this.moveCursorTo(s.row,s.column+t,t===0)},this.moveCursorToPosition=function(e){this.moveCursorTo(e.row,e.column)},this.moveCursorTo=function(e,t,n){var r=this.session.getFoldAt(e,t,1);r&&(e=r.start.row,t=r.start.column),this.$keepDesiredColumnOnChange=!0;var i=this.session.getLine(e);/[\uDC00-\uDFFF]/.test(i.charAt(t))&&i.charAt(t-1)&&(this.lead.row==e&&this.lead.column==t+1?t-=1:t+=1),this.lead.setPosition(e,t),this.$keepDesiredColumnOnChange=!1,n||(this.$desiredColumn=null)},this.moveCursorToScreen=function(e,t,n){var r=this.session.screenToDocumentPosition(e,t);this.moveCursorTo(r.row,r.column,n)},this.detach=function(){this.lead.detach(),this.anchor.detach(),this.session=this.doc=null},this.fromOrientedRange=function(e){this.setSelectionRange(e,e.cursor==e.start),this.$desiredColumn=e.desiredColumn||this.$desiredColumn},this.toOrientedRange=function(e){var t=this.getRange();return e?(e.start.column=t.start.column,e.start.row=t.start.row,e.end.column=t.end.column,e.end.row=t.end.row):e=t,e.cursor=this.isBackwards()?e.start:e.end,e.desiredColumn=this.$desiredColumn,e},this.getRangeOfMovements=function(e){var t=this.getCursor();try{e(this);var n=this.getCursor();return o.fromPoints(t,n)}catch(r){return o.fromPoints(t,t)}finally{this.moveCursorToPosition(t)}},this.toJSON=function(){if(this.rangeCount)var e=this.ranges.map(function(e){var t=e.clone();return t.isBackwards=e.cursor==e.start,t});else{var e=this.getRange();e.isBackwards=this.isBackwards()}return e},this.fromJSON=function(e){if(e.start==undefined){if(this.rangeList&&e.length>1){this.toSingleRange(e[0]);for(var t=e.length;t--;){var n=o.fromPoints(e[t].start,e[t].end);e[t].isBackwards&&(n.cursor=n.start),this.addRange(n,!0)}return}e=e[0]}this.rangeList&&this.toSingleRange(e),this.setSelectionRange(e,e.isBackwards)},this.isEqual=function(e){if((e.length||this.rangeCount)&&e.length!=this.rangeCount)return!1;if(!e.length||!this.ranges)return this.getRange().isEqual(e);for(var t=this.ranges.length;t--;)if(!this.ranges[t].isEqual(e[t]))return!1;return!0}}).call(u.prototype),t.Selection=u}),define("ace/tokenizer",["require","exports","module","ace/config"],function(e,t,n){"use strict";var r=e("./config"),i=2e3,s=function(e){this.states=e,this.regExps={},this.matchMappings={};for(var t in this.states){var n=this.states[t],r=[],i=0,s=this.matchMappings[t]={defaultToken:"text"},o="g",u=[];for(var a=0;a1?f.onMatch=this.$applyToken:f.onMatch=f.token),c>1&&(/\\\d/.test(f.regex)?l=f.regex.replace(/\\([0-9]+)/g,function(e,t){return"\\"+(parseInt(t,10)+i+1)}):(c=1,l=this.removeCapturingGroups(f.regex)),!f.splitRegex&&typeof f.token!="string"&&u.push(f)),s[i]=a,i+=c,r.push(l),f.onMatch||(f.onMatch=null)}r.length||(s[0]=0,r.push("$")),u.forEach(function(e){e.splitRegex=this.createSplitterRegexp(e.regex,o)},this),this.regExps[t]=new RegExp("("+r.join(")|(")+")|($)",o)}};(function(){this.$setMaxTokenCount=function(e){i=e|0},this.$applyToken=function(e){var t=this.splitRegex.exec(e).slice(1),n=this.token.apply(this,t);if(typeof n=="string")return[{type:n,value:e}];var r=[];for(var i=0,s=n.length;il){var g=e.substring(l,m-v.length);h.type==p?h.value+=g:(h.type&&f.push(h),h={type:p,value:g})}for(var y=0;yi){c>2*e.length&&this.reportError("infinite loop with in ace tokenizer",{startState:t,line:e});while(l1&&n[0]!==r&&n.unshift("#tmp",r),{tokens:f,state:n.length?n:r}},this.reportError=r.reportError}).call(s.prototype),t.Tokenizer=s}),define("ace/mode/text_highlight_rules",["require","exports","module","ace/lib/lang"],function(e,t,n){"use strict";var r=e("../lib/lang"),i=function(){this.$rules={start:[{token:"empty_line",regex:"^$"},{defaultToken:"text"}]}};(function(){this.addRules=function(e,t){if(!t){for(var n in e)this.$rules[n]=e[n];return}for(var n in e){var r=e[n];for(var i=0;i=this.$rowTokens.length){this.$row+=1,e||(e=this.$session.getLength());if(this.$row>=e)return this.$row=e-1,null;this.$rowTokens=this.$session.getTokens(this.$row),this.$tokenIndex=0}return this.$rowTokens[this.$tokenIndex]},this.getCurrentToken=function(){return this.$rowTokens[this.$tokenIndex]},this.getCurrentTokenRow=function(){return this.$row},this.getCurrentTokenColumn=function(){var e=this.$rowTokens,t=this.$tokenIndex,n=e[t].start;if(n!==undefined)return n;n=0;while(t>0)t-=1,n+=e[t].value.length;return n},this.getCurrentTokenPosition=function(){return{row:this.$row,column:this.getCurrentTokenColumn()}},this.getCurrentTokenRange=function(){var e=this.$rowTokens[this.$tokenIndex],t=this.getCurrentTokenColumn();return new r(this.$row,t,this.$row,t+e.value.length)}}).call(i.prototype),t.TokenIterator=i}),define("ace/mode/behaviour/cstyle",["require","exports","module","ace/lib/oop","ace/mode/behaviour","ace/token_iterator","ace/lib/lang"],function(e,t,n){"use strict";var r=e("../../lib/oop"),i=e("../behaviour").Behaviour,s=e("../../token_iterator").TokenIterator,o=e("../../lib/lang"),u=["text","paren.rparen","rparen","paren","punctuation.operator"],a=["text","paren.rparen","rparen","paren","punctuation.operator","comment"],f,l={},c={'"':'"',"'":"'"},h=function(e){var t=-1;e.multiSelect&&(t=e.selection.index,l.rangeCount!=e.multiSelect.rangeCount&&(l={rangeCount:e.multiSelect.rangeCount}));if(l[t])return f=l[t];f=l[t]={autoInsertedBrackets:0,autoInsertedRow:-1,autoInsertedLineEnd:"",maybeInsertedBrackets:0,maybeInsertedRow:-1,maybeInsertedLineStart:"",maybeInsertedLineEnd:""}},p=function(e,t,n,r){var i=e.end.row-e.start.row;return{text:n+t+r,selection:[0,e.start.column+1,i,e.end.column+(i?0:1)]}},d=function(e){this.add("braces","insertion",function(t,n,r,i,s){var u=r.getCursorPosition(),a=i.doc.getLine(u.row);if(s=="{"){h(r);var l=r.getSelectionRange(),c=i.doc.getTextRange(l);if(c!==""&&c!=="{"&&r.getWrapBehavioursEnabled())return p(l,c,"{","}");if(d.isSaneInsertion(r,i))return/[\]\}\)]/.test(a[u.column])||r.inMultiSelectMode||e&&e.braces?(d.recordAutoInsert(r,i,"}"),{text:"{}",selection:[1,1]}):(d.recordMaybeInsert(r,i,"{"),{text:"{",selection:[1,1]})}else if(s=="}"){h(r);var v=a.substring(u.column,u.column+1);if(v=="}"){var m=i.$findOpeningBracket("}",{column:u.column+1,row:u.row});if(m!==null&&d.isAutoInsertedClosing(u,a,s))return d.popAutoInsertedClosing(),{text:"",selection:[1,1]}}}else{if(s=="\n"||s=="\r\n"){h(r);var g="";d.isMaybeInsertedClosing(u,a)&&(g=o.stringRepeat("}",f.maybeInsertedBrackets),d.clearMaybeInsertedClosing());var v=a.substring(u.column,u.column+1);if(v==="}"){var y=i.findMatchingBracket({row:u.row,column:u.column+1},"}");if(!y)return null;var b=this.$getIndent(i.getLine(y.row))}else{if(!g){d.clearMaybeInsertedClosing();return}var b=this.$getIndent(a)}var w=b+i.getTabString();return{text:"\n"+w+"\n"+b+g,selection:[1,w.length,1,w.length]}}d.clearMaybeInsertedClosing()}}),this.add("braces","deletion",function(e,t,n,r,i){var s=r.doc.getTextRange(i);if(!i.isMultiLine()&&s=="{"){h(n);var o=r.doc.getLine(i.start.row),u=o.substring(i.end.column,i.end.column+1);if(u=="}")return i.end.column++,i;f.maybeInsertedBrackets--}}),this.add("parens","insertion",function(e,t,n,r,i){if(i=="("){h(n);var s=n.getSelectionRange(),o=r.doc.getTextRange(s);if(o!==""&&n.getWrapBehavioursEnabled())return p(s,o,"(",")");if(d.isSaneInsertion(n,r))return d.recordAutoInsert(n,r,")"),{text:"()",selection:[1,1]}}else if(i==")"){h(n);var u=n.getCursorPosition(),a=r.doc.getLine(u.row),f=a.substring(u.column,u.column+1);if(f==")"){var l=r.$findOpeningBracket(")",{column:u.column+1,row:u.row});if(l!==null&&d.isAutoInsertedClosing(u,a,i))return d.popAutoInsertedClosing(),{text:"",selection:[1,1]}}}}),this.add("parens","deletion",function(e,t,n,r,i){var s=r.doc.getTextRange(i);if(!i.isMultiLine()&&s=="("){h(n);var o=r.doc.getLine(i.start.row),u=o.substring(i.start.column+1,i.start.column+2);if(u==")")return i.end.column++,i}}),this.add("brackets","insertion",function(e,t,n,r,i){if(i=="["){h(n);var s=n.getSelectionRange(),o=r.doc.getTextRange(s);if(o!==""&&n.getWrapBehavioursEnabled())return p(s,o,"[","]");if(d.isSaneInsertion(n,r))return d.recordAutoInsert(n,r,"]"),{text:"[]",selection:[1,1]}}else if(i=="]"){h(n);var u=n.getCursorPosition(),a=r.doc.getLine(u.row),f=a.substring(u.column,u.column+1);if(f=="]"){var l=r.$findOpeningBracket("]",{column:u.column+1,row:u.row});if(l!==null&&d.isAutoInsertedClosing(u,a,i))return d.popAutoInsertedClosing(),{text:"",selection:[1,1]}}}}),this.add("brackets","deletion",function(e,t,n,r,i){var s=r.doc.getTextRange(i);if(!i.isMultiLine()&&s=="["){h(n);var o=r.doc.getLine(i.start.row),u=o.substring(i.start.column+1,i.start.column+2);if(u=="]")return i.end.column++,i}}),this.add("string_dquotes","insertion",function(e,t,n,r,i){var s=r.$mode.$quotes||c;if(i.length==1&&s[i]){if(this.lineCommentStart&&this.lineCommentStart.indexOf(i)!=-1)return;h(n);var o=i,u=n.getSelectionRange(),a=r.doc.getTextRange(u);if(a!==""&&(a.length!=1||!s[a])&&n.getWrapBehavioursEnabled())return p(u,a,o,o);if(!a){var f=n.getCursorPosition(),l=r.doc.getLine(f.row),d=l.substring(f.column-1,f.column),v=l.substring(f.column,f.column+1),m=r.getTokenAt(f.row,f.column),g=r.getTokenAt(f.row,f.column+1);if(d=="\\"&&m&&/escape/.test(m.type))return null;var y=m&&/string|escape/.test(m.type),b=!g||/string|escape/.test(g.type),w;if(v==o)w=y!==b,w&&/string\.end/.test(g.type)&&(w=!1);else{if(y&&!b)return null;if(y&&b)return null;var E=r.$mode.tokenRe;E.lastIndex=0;var S=E.test(d);E.lastIndex=0;var x=E.test(d);if(S||x)return null;if(v&&!/[\s;,.})\]\\]/.test(v))return null;var T=l[f.column-2];if(!(d!=o||T!=o&&!E.test(T)))return null;w=!0}return{text:w?o+o:"",selection:[1,1]}}}}),this.add("string_dquotes","deletion",function(e,t,n,r,i){var s=r.$mode.$quotes||c,o=r.doc.getTextRange(i);if(!i.isMultiLine()&&s.hasOwnProperty(o)){h(n);var u=r.doc.getLine(i.start.row),a=u.substring(i.start.column+1,i.start.column+2);if(a==o)return i.end.column++,i}})};d.isSaneInsertion=function(e,t){var n=e.getCursorPosition(),r=new s(t,n.row,n.column);if(!this.$matchTokenType(r.getCurrentToken()||"text",u)){if(/[)}\]]/.test(e.session.getLine(n.row)[n.column]))return!0;var i=new s(t,n.row,n.column+1);if(!this.$matchTokenType(i.getCurrentToken()||"text",u))return!1}return r.stepForward(),r.getCurrentTokenRow()!==n.row||this.$matchTokenType(r.getCurrentToken()||"text",a)},d.$matchTokenType=function(e,t){return t.indexOf(e.type||e)>-1},d.recordAutoInsert=function(e,t,n){var r=e.getCursorPosition(),i=t.doc.getLine(r.row);this.isAutoInsertedClosing(r,i,f.autoInsertedLineEnd[0])||(f.autoInsertedBrackets=0),f.autoInsertedRow=r.row,f.autoInsertedLineEnd=n+i.substr(r.column),f.autoInsertedBrackets++},d.recordMaybeInsert=function(e,t,n){var r=e.getCursorPosition(),i=t.doc.getLine(r.row);this.isMaybeInsertedClosing(r,i)||(f.maybeInsertedBrackets=0),f.maybeInsertedRow=r.row,f.maybeInsertedLineStart=i.substr(0,r.column)+n,f.maybeInsertedLineEnd=i.substr(r.column),f.maybeInsertedBrackets++},d.isAutoInsertedClosing=function(e,t,n){return f.autoInsertedBrackets>0&&e.row===f.autoInsertedRow&&n===f.autoInsertedLineEnd[0]&&t.substr(e.column)===f.autoInsertedLineEnd},d.isMaybeInsertedClosing=function(e,t){return f.maybeInsertedBrackets>0&&e.row===f.maybeInsertedRow&&t.substr(e.column)===f.maybeInsertedLineEnd&&t.substr(0,e.column)==f.maybeInsertedLineStart},d.popAutoInsertedClosing=function(){f.autoInsertedLineEnd=f.autoInsertedLineEnd.substr(1),f.autoInsertedBrackets--},d.clearMaybeInsertedClosing=function(){f&&(f.maybeInsertedBrackets=0,f.maybeInsertedRow=-1)},r.inherits(d,i),t.CstyleBehaviour=d}),define("ace/unicode",["require","exports","module"],function(e,t,n){"use strict";var r=[48,9,8,25,5,0,2,25,48,0,11,0,5,0,6,22,2,30,2,457,5,11,15,4,8,0,2,0,18,116,2,1,3,3,9,0,2,2,2,0,2,19,2,82,2,138,2,4,3,155,12,37,3,0,8,38,10,44,2,0,2,1,2,1,2,0,9,26,6,2,30,10,7,61,2,9,5,101,2,7,3,9,2,18,3,0,17,58,3,100,15,53,5,0,6,45,211,57,3,18,2,5,3,11,3,9,2,1,7,6,2,2,2,7,3,1,3,21,2,6,2,0,4,3,3,8,3,1,3,3,9,0,5,1,2,4,3,11,16,2,2,5,5,1,3,21,2,6,2,1,2,1,2,1,3,0,2,4,5,1,3,2,4,0,8,3,2,0,8,15,12,2,2,8,2,2,2,21,2,6,2,1,2,4,3,9,2,2,2,2,3,0,16,3,3,9,18,2,2,7,3,1,3,21,2,6,2,1,2,4,3,8,3,1,3,2,9,1,5,1,2,4,3,9,2,0,17,1,2,5,4,2,2,3,4,1,2,0,2,1,4,1,4,2,4,11,5,4,4,2,2,3,3,0,7,0,15,9,18,2,2,7,2,2,2,22,2,9,2,4,4,7,2,2,2,3,8,1,2,1,7,3,3,9,19,1,2,7,2,2,2,22,2,9,2,4,3,8,2,2,2,3,8,1,8,0,2,3,3,9,19,1,2,7,2,2,2,22,2,15,4,7,2,2,2,3,10,0,9,3,3,9,11,5,3,1,2,17,4,23,2,8,2,0,3,6,4,0,5,5,2,0,2,7,19,1,14,57,6,14,2,9,40,1,2,0,3,1,2,0,3,0,7,3,2,6,2,2,2,0,2,0,3,1,2,12,2,2,3,4,2,0,2,5,3,9,3,1,35,0,24,1,7,9,12,0,2,0,2,0,5,9,2,35,5,19,2,5,5,7,2,35,10,0,58,73,7,77,3,37,11,42,2,0,4,328,2,3,3,6,2,0,2,3,3,40,2,3,3,32,2,3,3,6,2,0,2,3,3,14,2,56,2,3,3,66,5,0,33,15,17,84,13,619,3,16,2,25,6,74,22,12,2,6,12,20,12,19,13,12,2,2,2,1,13,51,3,29,4,0,5,1,3,9,34,2,3,9,7,87,9,42,6,69,11,28,4,11,5,11,11,39,3,4,12,43,5,25,7,10,38,27,5,62,2,28,3,10,7,9,14,0,89,75,5,9,18,8,13,42,4,11,71,55,9,9,4,48,83,2,2,30,14,230,23,280,3,5,3,37,3,5,3,7,2,0,2,0,2,0,2,30,3,52,2,6,2,0,4,2,2,6,4,3,3,5,5,12,6,2,2,6,67,1,20,0,29,0,14,0,17,4,60,12,5,0,4,11,18,0,5,0,3,9,2,0,4,4,7,0,2,0,2,0,2,3,2,10,3,3,6,4,5,0,53,1,2684,46,2,46,2,132,7,6,15,37,11,53,10,0,17,22,10,6,2,6,2,6,2,6,2,6,2,6,2,6,2,6,2,31,48,0,470,1,36,5,2,4,6,1,5,85,3,1,3,2,2,89,2,3,6,40,4,93,18,23,57,15,513,6581,75,20939,53,1164,68,45,3,268,4,27,21,31,3,13,13,1,2,24,9,69,11,1,38,8,3,102,3,1,111,44,25,51,13,68,12,9,7,23,4,0,5,45,3,35,13,28,4,64,15,10,39,54,10,13,3,9,7,22,4,1,5,66,25,2,227,42,2,1,3,9,7,11171,13,22,5,48,8453,301,3,61,3,105,39,6,13,4,6,11,2,12,2,4,2,0,2,1,2,1,2,107,34,362,19,63,3,53,41,11,5,15,17,6,13,1,25,2,33,4,2,134,20,9,8,25,5,0,2,25,12,88,4,5,3,5,3,5,3,2],i=0,s=[];for(var o=0;o2?r%f!=f-1:r%f==0}}var E=Infinity;w(function(e,t){var n=e.search(/\S/);n!==-1?(ne.length&&(E=e.length)}),u==Infinity&&(u=E,s=!1,o=!1),l&&u%f!=0&&(u=Math.floor(u/f)*f),w(o?m:v)},this.toggleBlockComment=function(e,t,n,r){var i=this.blockComment;if(!i)return;!i.start&&i[0]&&(i=i[0]);var s=new f(t,r.row,r.column),o=s.getCurrentToken(),u=t.selection,a=t.selection.toOrientedRange(),c,h;if(o&&/comment/.test(o.type)){var p,d;while(o&&/comment/.test(o.type)){var v=o.value.indexOf(i.start);if(v!=-1){var m=s.getCurrentTokenRow(),g=s.getCurrentTokenColumn()+v;p=new l(m,g,m,g+i.start.length);break}o=s.stepBackward()}var s=new f(t,r.row,r.column),o=s.getCurrentToken();while(o&&/comment/.test(o.type)){var v=o.value.indexOf(i.end);if(v!=-1){var m=s.getCurrentTokenRow(),g=s.getCurrentTokenColumn()+v;d=new l(m,g,m,g+i.end.length);break}o=s.stepForward()}d&&t.remove(d),p&&(t.remove(p),c=p.start.row,h=-i.start.length)}else h=i.start.length,c=n.start.row,t.insert(n.end,i.end),t.insert(n.start,i.start);a.start.row==c&&(a.start.column+=h),a.end.row==c&&(a.end.column+=h),t.selection.fromOrientedRange(a)},this.getNextLineIndent=function(e,t,n){return this.$getIndent(t)},this.checkOutdent=function(e,t,n){return!1},this.autoOutdent=function(e,t,n){},this.$getIndent=function(e){return e.match(/^\s*/)[0]},this.createWorker=function(e){return null},this.createModeDelegates=function(e){this.$embeds=[],this.$modes={};for(var t in e)if(e[t]){var n=e[t],i=n.prototype.$id,s=r.$modes[i];s||(r.$modes[i]=s=new n),r.$modes[t]||(r.$modes[t]=s),this.$embeds.push(t),this.$modes[t]=s}var o=["toggleBlockComment","toggleCommentLines","getNextLineIndent","checkOutdent","autoOutdent","transformAction","getCompletions"];for(var t=0;t=0&&t.row=0&&t.column<=e[t.row].length}function s(e,t){t.action!="insert"&&t.action!="remove"&&r(t,"delta.action must be 'insert' or 'remove'"),t.lines instanceof Array||r(t,"delta.lines must be an Array"),(!t.start||!t.end)&&r(t,"delta.start/end must be an present");var n=t.start;i(e,t.start)||r(t,"delta.start must be contained in document");var s=t.end;t.action=="remove"&&!i(e,s)&&r(t,"delta.end must contained in document for 'remove' actions");var o=s.row-n.row,u=s.column-(o==0?n.column:0);(o!=t.lines.length-1||t.lines[o].length!=u)&&r(t,"delta.range must match delta lines")}t.applyDelta=function(e,t,n){var r=t.start.row,i=t.start.column,s=e[r]||"";switch(t.action){case"insert":var o=t.lines;if(o.length===1)e[r]=s.substring(0,i)+t.lines[0]+s.substring(i);else{var u=[r,1].concat(t.lines);e.splice.apply(e,u),e[r]=s.substring(0,i)+e[r],e[r+t.lines.length-1]+=s.substring(i)}break;case"remove":var a=t.end.column,f=t.end.row;r===f?e[r]=s.substring(0,i)+s.substring(a):e.splice(r,f-r+1,s.substring(0,i)+e[f].substring(a))}}}),define("ace/anchor",["require","exports","module","ace/lib/oop","ace/lib/event_emitter"],function(e,t,n){"use strict";var r=e("./lib/oop"),i=e("./lib/event_emitter").EventEmitter,s=t.Anchor=function(e,t,n){this.$onChange=this.onChange.bind(this),this.attach(e),typeof n=="undefined"?this.setPosition(t.row,t.column):this.setPosition(t,n)};(function(){function e(e,t,n){var r=n?e.column<=t.column:e.columnthis.row)return;var n=t(e,{row:this.row,column:this.column},this.$insertRight);this.setPosition(n.row,n.column,!0)},this.setPosition=function(e,t,n){var r;n?r={row:e,column:t}:r=this.$clipPositionToDocument(e,t);if(this.row==r.row&&this.column==r.column)return;var i={row:this.row,column:this.column};this.row=r.row,this.column=r.column,this._signal("change",{old:i,value:r})},this.detach=function(){this.document.off("change",this.$onChange)},this.attach=function(e){this.document=e||this.document,this.document.on("change",this.$onChange)},this.$clipPositionToDocument=function(e,t){var n={};return e>=this.document.getLength()?(n.row=Math.max(0,this.document.getLength()-1),n.column=this.document.getLine(n.row).length):e<0?(n.row=0,n.column=0):(n.row=e,n.column=Math.min(this.document.getLine(n.row).length,Math.max(0,t))),t<0&&(n.column=0),n}}).call(s.prototype)}),define("ace/document",["require","exports","module","ace/lib/oop","ace/apply_delta","ace/lib/event_emitter","ace/range","ace/anchor"],function(e,t,n){"use strict";var r=e("./lib/oop"),i=e("./apply_delta").applyDelta,s=e("./lib/event_emitter").EventEmitter,o=e("./range").Range,u=e("./anchor").Anchor,a=function(e){this.$lines=[""],e.length===0?this.$lines=[""]:Array.isArray(e)?this.insertMergedLines({row:0,column:0},e):this.insert({row:0,column:0},e)};(function(){r.implement(this,s),this.setValue=function(e){var t=this.getLength()-1;this.remove(new o(0,0,t,this.getLine(t).length)),this.insert({row:0,column:0},e)},this.getValue=function(){return this.getAllLines().join(this.getNewLineCharacter())},this.createAnchor=function(e,t){return new u(this,e,t)},"aaa".split(/a/).length===0?this.$split=function(e){return e.replace(/\r\n|\r/g,"\n").split("\n")}:this.$split=function(e){return e.split(/\r\n|\r|\n/)},this.$detectNewLine=function(e){var t=e.match(/^.*?(\r\n|\r|\n)/m);this.$autoNewLine=t?t[1]:"\n",this._signal("changeNewLineMode")},this.getNewLineCharacter=function(){switch(this.$newLineMode){case"windows":return"\r\n";case"unix":return"\n";default:return this.$autoNewLine||"\n"}},this.$autoNewLine="",this.$newLineMode="auto",this.setNewLineMode=function(e){if(this.$newLineMode===e)return;this.$newLineMode=e,this._signal("changeNewLineMode")},this.getNewLineMode=function(){return this.$newLineMode},this.isNewLine=function(e){return e=="\r\n"||e=="\r"||e=="\n"},this.getLine=function(e){return this.$lines[e]||""},this.getLines=function(e,t){return this.$lines.slice(e,t+1)},this.getAllLines=function(){return this.getLines(0,this.getLength())},this.getLength=function(){return this.$lines.length},this.getTextRange=function(e){return this.getLinesForRange(e).join(this.getNewLineCharacter())},this.getLinesForRange=function(e){var t;if(e.start.row===e.end.row)t=[this.getLine(e.start.row).substring(e.start.column,e.end.column)];else{t=this.getLines(e.start.row,e.end.row),t[0]=(t[0]||"").substring(e.start.column);var n=t.length-1;e.end.row-e.start.row==n&&(t[n]=t[n].substring(0,e.end.column))}return t},this.insertLines=function(e,t){return console.warn("Use of document.insertLines is deprecated. Use the insertFullLines method instead."),this.insertFullLines(e,t)},this.removeLines=function(e,t){return console.warn("Use of document.removeLines is deprecated. Use the removeFullLines method instead."),this.removeFullLines(e,t)},this.insertNewLine=function(e){return console.warn("Use of document.insertNewLine is deprecated. Use insertMergedLines(position, ['', '']) instead."),this.insertMergedLines(e,["",""])},this.insert=function(e,t){return this.getLength()<=1&&this.$detectNewLine(t),this.insertMergedLines(e,this.$split(t))},this.insertInLine=function(e,t){var n=this.clippedPos(e.row,e.column),r=this.pos(e.row,e.column+t.length);return this.applyDelta({start:n,end:r,action:"insert",lines:[t]},!0),this.clonePos(r)},this.clippedPos=function(e,t){var n=this.getLength();e===undefined?e=n:e<0?e=0:e>=n&&(e=n-1,t=undefined);var r=this.getLine(e);return t==undefined&&(t=r.length),t=Math.min(Math.max(t,0),r.length),{row:e,column:t}},this.clonePos=function(e){return{row:e.row,column:e.column}},this.pos=function(e,t){return{row:e,column:t}},this.$clipPosition=function(e){var t=this.getLength();return e.row>=t?(e.row=Math.max(0,t-1),e.column=this.getLine(t-1).length):(e.row=Math.max(0,e.row),e.column=Math.min(Math.max(e.column,0),this.getLine(e.row).length)),e},this.insertFullLines=function(e,t){e=Math.min(Math.max(e,0),this.getLength());var n=0;e0,r=t=0&&this.applyDelta({start:this.pos(e,this.getLine(e).length),end:this.pos(e+1,0),action:"remove",lines:["",""]})},this.replace=function(e,t){e instanceof o||(e=o.fromPoints(e.start,e.end));if(t.length===0&&e.isEmpty())return e.start;if(t==this.getTextRange(e))return e.end;this.remove(e);var n;return t?n=this.insert(e.start,t):n=e.start,n},this.applyDeltas=function(e){for(var t=0;t=0;t--)this.revertDelta(e[t])},this.applyDelta=function(e,t){var n=e.action=="insert";if(n?e.lines.length<=1&&!e.lines[0]:!o.comparePoints(e.start,e.end))return;n&&e.lines.length>2e4?this.$splitAndapplyLargeDelta(e,2e4):(i(this.$lines,e,t),this._signal("change",e))},this.$safeApplyDelta=function(e){var t=this.$lines.length;(e.action=="remove"&&e.start.row20){n.running=setTimeout(n.$worker,20);break}}n.currentLine=t,r==-1&&(r=t),s<=r&&n.fireUpdateEvent(s,r)}};(function(){r.implement(this,i),this.setTokenizer=function(e){this.tokenizer=e,this.lines=[],this.states=[],this.start(0)},this.setDocument=function(e){this.doc=e,this.lines=[],this.states=[],this.stop()},this.fireUpdateEvent=function(e,t){var n={first:e,last:t};this._signal("update",{data:n})},this.start=function(e){this.currentLine=Math.min(e||0,this.currentLine,this.doc.getLength()),this.lines.splice(this.currentLine,this.lines.length),this.states.splice(this.currentLine,this.states.length),this.stop(),this.running=setTimeout(this.$worker,700)},this.scheduleStart=function(){this.running||(this.running=setTimeout(this.$worker,700))},this.$updateOnChange=function(e){var t=e.start.row,n=e.end.row-t;if(n===0)this.lines[t]=null;else if(e.action=="remove")this.lines.splice(t,n+1,null),this.states.splice(t,n+1,null);else{var r=Array(n+1);r.unshift(t,1),this.lines.splice.apply(this.lines,r),this.states.splice.apply(this.states,r)}this.currentLine=Math.min(t,this.currentLine,this.doc.getLength()),this.stop()},this.stop=function(){this.running&&clearTimeout(this.running),this.running=!1},this.getTokens=function(e){return this.lines[e]||this.$tokenizeRow(e)},this.getState=function(e){return this.currentLine==e&&this.$tokenizeRow(e),this.states[e]||"start"},this.$tokenizeRow=function(e){var t=this.doc.getLine(e),n=this.states[e-1],r=this.tokenizer.getLineTokens(t,n,e);return this.states[e]+""!=r.state+""?(this.states[e]=r.state,this.lines[e+1]=null,this.currentLine>e+1&&(this.currentLine=e+1)):this.currentLine==e&&(this.currentLine=e+1),this.lines[e]=r.tokens}}).call(s.prototype),t.BackgroundTokenizer=s}),define("ace/search_highlight",["require","exports","module","ace/lib/lang","ace/lib/oop","ace/range"],function(e,t,n){"use strict";var r=e("./lib/lang"),i=e("./lib/oop"),s=e("./range").Range,o=function(e,t,n){this.setRegexp(e),this.clazz=t,this.type=n||"text"};(function(){this.MAX_RANGES=500,this.setRegexp=function(e){if(this.regExp+""==e+"")return;this.regExp=e,this.cache=[]},this.update=function(e,t,n,i){if(!this.regExp)return;var o=i.firstRow,u=i.lastRow;for(var a=o;a<=u;a++){var f=this.cache[a];f==null&&(f=r.getMatchOffsets(n.getLine(a),this.regExp),f.length>this.MAX_RANGES&&(f=f.slice(0,this.MAX_RANGES)),f=f.map(function(e){return new s(a,e.offset,a,e.offset+e.length)}),this.cache[a]=f.length?f:"");for(var l=f.length;l--;)t.drawSingleLineMarker(e,f[l].toScreenRange(n),this.clazz,i)}}}).call(o.prototype),t.SearchHighlight=o}),define("ace/edit_session/fold_line",["require","exports","module","ace/range"],function(e,t,n){"use strict";function i(e,t){this.foldData=e,Array.isArray(t)?this.folds=t:t=this.folds=[t];var n=t[t.length-1];this.range=new r(t[0].start.row,t[0].start.column,n.end.row,n.end.column),this.start=this.range.start,this.end=this.range.end,this.folds.forEach(function(e){e.setFoldLine(this)},this)}var r=e("../range").Range;(function(){this.shiftRow=function(e){this.start.row+=e,this.end.row+=e,this.folds.forEach(function(t){t.start.row+=e,t.end.row+=e})},this.addFold=function(e){if(e.sameRow){if(e.start.rowthis.endRow)throw new Error("Can't add a fold to this FoldLine as it has no connection");this.folds.push(e),this.folds.sort(function(e,t){return-e.range.compareEnd(t.start.row,t.start.column)}),this.range.compareEnd(e.start.row,e.start.column)>0?(this.end.row=e.end.row,this.end.column=e.end.column):this.range.compareStart(e.end.row,e.end.column)<0&&(this.start.row=e.start.row,this.start.column=e.start.column)}else if(e.start.row==this.end.row)this.folds.push(e),this.end.row=e.end.row,this.end.column=e.end.column;else{if(e.end.row!=this.start.row)throw new Error("Trying to add fold to FoldRow that doesn't have a matching row");this.folds.unshift(e),this.start.row=e.start.row,this.start.column=e.start.column}e.foldLine=this},this.containsRow=function(e){return e>=this.start.row&&e<=this.end.row},this.walk=function(e,t,n){var r=0,i=this.folds,s,o,u,a=!0;t==null&&(t=this.end.row,n=this.end.column);for(var f=0;f0)continue;var a=i(e,o.start);return u===0?t&&a!==0?-s-2:s:a>0||a===0&&!t?s:-s-1}return-s-1},this.add=function(e){var t=!e.isEmpty(),n=this.pointIndex(e.start,t);n<0&&(n=-n-1);var r=this.pointIndex(e.end,t,n);return r<0?r=-r-1:r++,this.ranges.splice(n,r-n,e)},this.addList=function(e){var t=[];for(var n=e.length;n--;)t.push.apply(t,this.add(e[n]));return t},this.substractPoint=function(e){var t=this.pointIndex(e);if(t>=0)return this.ranges.splice(t,1)},this.merge=function(){var e=[],t=this.ranges;t=t.sort(function(e,t){return i(e.start,t.start)});var n=t[0],r;for(var s=1;s=0},this.containsPoint=function(e){return this.pointIndex(e)>=0},this.rangeAtPoint=function(e){var t=this.pointIndex(e);if(t>=0)return this.ranges[t]},this.clipRows=function(e,t){var n=this.ranges;if(n[0].start.row>t||n[n.length-1].start.row=r)break}if(e.action=="insert"){var f=i-r,l=-t.column+n.column;for(;or)break;a.start.row==r&&a.start.column>=t.column&&(a.start.column==t.column&&this.$bias<=0||(a.start.column+=l,a.start.row+=f));if(a.end.row==r&&a.end.column>=t.column){if(a.end.column==t.column&&this.$bias<0)continue;a.end.column==t.column&&l>0&&oa.start.column&&a.end.column==s[o+1].start.column&&(a.end.column-=l),a.end.column+=l,a.end.row+=f}}}else{var f=r-i,l=t.column-n.column;for(;oi)break;if(a.end.rowt.column)a.end.column=t.column,a.end.row=t.row}else a.end.column+=l,a.end.row+=f;else a.end.row>i&&(a.end.row+=f);if(a.start.rowt.column)a.start.column=t.column,a.start.row=t.row}else a.start.column+=l,a.start.row+=f;else a.start.row>i&&(a.start.row+=f)}}if(f!=0&&o=e)return i;if(i.end.row>e)return null}return null},this.getNextFoldLine=function(e,t){var n=this.$foldData,r=0;t&&(r=n.indexOf(t)),r==-1&&(r=0);for(r;r=e)return i}return null},this.getFoldedRowCount=function(e,t){var n=this.$foldData,r=t-e+1;for(var i=0;i=t){u=e?r-=t-u:r=0);break}o>=e&&(u>=e?r-=o-u:r-=o-e+1)}return r},this.$addFoldLine=function(e){return this.$foldData.push(e),this.$foldData.sort(function(e,t){return e.start.row-t.start.row}),e},this.addFold=function(e,t){var n=this.$foldData,r=!1,o;e instanceof s?o=e:(o=new s(t,e),o.collapseChildren=t.collapseChildren),this.$clipRangeToDocument(o.range);var u=o.start.row,a=o.start.column,f=o.end.row,l=o.end.column,c=this.getFoldAt(u,a,1),h=this.getFoldAt(f,l,-1);if(c&&h==c)return c.addSubFold(o);c&&!c.range.isStart(u,a)&&this.removeFold(c),h&&!h.range.isEnd(f,l)&&this.removeFold(h);var p=this.getFoldsInRange(o.range);p.length>0&&(this.removeFolds(p),p.forEach(function(e){o.addSubFold(e)}));for(var d=0;d0&&this.foldAll(e.start.row+1,e.end.row,e.collapseChildren-1),e.subFolds=[]},this.expandFolds=function(e){e.forEach(function(e){this.expandFold(e)},this)},this.unfold=function(e,t){var n,i;e==null?(n=new r(0,0,this.getLength(),0),t=!0):typeof e=="number"?n=new r(e,0,e,this.getLine(e).length):"row"in e?n=r.fromPoints(e,e):n=e,i=this.getFoldsInRangeList(n);if(t)this.removeFolds(i);else{var s=i;while(s.length)this.expandFolds(s),s=this.getFoldsInRangeList(n)}if(i.length)return i},this.isRowFolded=function(e,t){return!!this.getFoldLine(e,t)},this.getRowFoldEnd=function(e,t){var n=this.getFoldLine(e,t);return n?n.end.row:e},this.getRowFoldStart=function(e,t){var n=this.getFoldLine(e,t);return n?n.start.row:e},this.getFoldDisplayLine=function(e,t,n,r,i){r==null&&(r=e.start.row),i==null&&(i=0),t==null&&(t=e.end.row),n==null&&(n=this.getLine(t).length);var s=this.doc,o="";return e.walk(function(e,t,n,u){if(tl)break}while(s&&a.test(s.type));s=i.stepBackward()}else s=i.getCurrentToken();return f.end.row=i.getCurrentTokenRow(),f.end.column=i.getCurrentTokenColumn()+s.value.length-2,f}},this.foldAll=function(e,t,n){n==undefined&&(n=1e5);var r=this.foldWidgets;if(!r)return;t=t||this.getLength(),e=e||0;for(var i=e;i=e){i=s.end.row;try{var o=this.addFold("...",s);o&&(o.collapseChildren=n)}catch(u){}}}},this.$foldStyles={manual:1,markbegin:1,markbeginend:1},this.$foldStyle="markbegin",this.setFoldStyle=function(e){if(!this.$foldStyles[e])throw new Error("invalid fold style: "+e+"["+Object.keys(this.$foldStyles).join(", ")+"]");if(this.$foldStyle==e)return;this.$foldStyle=e,e=="manual"&&this.unfold();var t=this.$foldMode;this.$setFolding(null),this.$setFolding(t)},this.$setFolding=function(e){if(this.$foldMode==e)return;this.$foldMode=e,this.off("change",this.$updateFoldWidgets),this.off("tokenizerUpdate",this.$tokenizerUpdateFoldWidgets),this._signal("changeAnnotation");if(!e||this.$foldStyle=="manual"){this.foldWidgets=null;return}this.foldWidgets=[],this.getFoldWidget=e.getFoldWidget.bind(e,this,this.$foldStyle),this.getFoldWidgetRange=e.getFoldWidgetRange.bind(e,this,this.$foldStyle),this.$updateFoldWidgets=this.updateFoldWidgets.bind(this),this.$tokenizerUpdateFoldWidgets=this.tokenizerUpdateFoldWidgets.bind(this),this.on("change",this.$updateFoldWidgets),this.on("tokenizerUpdate",this.$tokenizerUpdateFoldWidgets)},this.getParentFoldRangeData=function(e,t){var n=this.foldWidgets;if(!n||t&&n[e])return{};var r=e-1,i;while(r>=0){var s=n[r];s==null&&(s=n[r]=this.getFoldWidget(r));if(s=="start"){var o=this.getFoldWidgetRange(r);i||(i=o);if(o&&o.end.row>=e)break}r--}return{range:r!==-1&&o,firstRange:i}},this.onFoldWidgetClick=function(e,t){t=t.domEvent;var n={children:t.shiftKey,all:t.ctrlKey||t.metaKey,siblings:t.altKey},r=this.$toggleFoldWidget(e,n);if(!r){var i=t.target||t.srcElement;i&&/ace_fold-widget/.test(i.className)&&(i.className+=" ace_invalid")}},this.$toggleFoldWidget=function(e,t){if(!this.getFoldWidget)return;var n=this.getFoldWidget(e),r=this.getLine(e),i=n==="end"?-1:1,s=this.getFoldAt(e,i===-1?0:r.length,i);if(s)return t.children||t.all?this.removeFold(s):this.expandFold(s),s;var o=this.getFoldWidgetRange(e,!0);if(o&&!o.isMultiLine()){s=this.getFoldAt(o.start.row,o.start.column,1);if(s&&o.isEqual(s.range))return this.removeFold(s),s}if(t.siblings){var u=this.getParentFoldRangeData(e);if(u.range)var a=u.range.start.row+1,f=u.range.end.row;this.foldAll(a,f,t.all?1e4:0)}else t.children?(f=o?o.end.row:this.getLength(),this.foldAll(e+1,f,t.all?1e4:0)):o&&(t.all&&(o.collapseChildren=1e4),this.addFold("...",o));return o},this.toggleFoldWidget=function(e){var t=this.selection.getCursor().row;t=this.getRowFoldStart(t);var n=this.$toggleFoldWidget(t,{});if(n)return;var r=this.getParentFoldRangeData(t,!0);n=r.range||r.firstRange;if(n){t=n.start.row;var i=this.getFoldAt(t,this.getLine(t).length,1);i?this.removeFold(i):this.addFold("...",n)}},this.updateFoldWidgets=function(e){var t=e.start.row,n=e.end.row-t;if(n===0)this.foldWidgets[t]=null;else if(e.action=="remove")this.foldWidgets.splice(t,n+1,null);else{var r=Array(n+1);r.unshift(t,1),this.foldWidgets.splice.apply(this.foldWidgets,r)}},this.tokenizerUpdateFoldWidgets=function(e){var t=e.data;t.first!=t.last&&this.foldWidgets.length>t.first&&this.foldWidgets.splice(t.first,this.foldWidgets.length)}}var r=e("../range").Range,i=e("./fold_line").FoldLine,s=e("./fold").Fold,o=e("../token_iterator").TokenIterator;t.Folding=u}),define("ace/edit_session/bracket_match",["require","exports","module","ace/token_iterator","ace/range"],function(e,t,n){"use strict";function s(){this.findMatchingBracket=function(e,t){if(e.column==0)return null;var n=t||this.getLine(e.row).charAt(e.column-1);if(n=="")return null;var r=n.match(/([\(\[\{])|([\)\]\}])/);return r?r[1]?this.$findClosingBracket(r[1],e):this.$findOpeningBracket(r[2],e):null},this.getBracketRange=function(e){var t=this.getLine(e.row),n=!0,r,s=t.charAt(e.column-1),o=s&&s.match(/([\(\[\{])|([\)\]\}])/);o||(s=t.charAt(e.column),e={row:e.row,column:e.column+1},o=s&&s.match(/([\(\[\{])|([\)\]\}])/),n=!1);if(!o)return null;if(o[1]){var u=this.$findClosingBracket(o[1],e);if(!u)return null;r=i.fromPoints(e,u),n||(r.end.column++,r.start.column--),r.cursor=r.end}else{var u=this.$findOpeningBracket(o[2],e);if(!u)return null;r=i.fromPoints(u,e),n||(r.start.column++,r.end.column--),r.cursor=r.start}return r},this.getMatchingBracketRanges=function(e){var t=this.getLine(e.row),n=t.charAt(e.column-1),r=n&&n.match(/([\(\[\{])|([\)\]\}])/);r||(n=t.charAt(e.column),e={row:e.row,column:e.column+1},r=n&&n.match(/([\(\[\{])|([\)\]\}])/));if(!r)return null;var s=new i(e.row,e.column-1,e.row,e.column),o=r[1]?this.$findClosingBracket(r[1],e):this.$findOpeningBracket(r[2],e);if(!o)return[s];var u=new i(o.row,o.column,o.row,o.column+1);return[s,u]},this.$brackets={")":"(","(":")","]":"[","[":"]","{":"}","}":"{","<":">",">":"<"},this.$findOpeningBracket=function(e,t,n){var i=this.$brackets[e],s=1,o=new r(this,t.row,t.column),u=o.getCurrentToken();u||(u=o.stepForward());if(!u)return;n||(n=new RegExp("(\\.?"+u.type.replace(".","\\.").replace("rparen",".paren").replace(/\b(?:end)\b/,"(?:start|begin|end)")+")+"));var a=t.column-o.getCurrentTokenColumn()-2,f=u.value;for(;;){while(a>=0){var l=f.charAt(a);if(l==i){s-=1;if(s==0)return{row:o.getCurrentTokenRow(),column:a+o.getCurrentTokenColumn()}}else l==e&&(s+=1);a-=1}do u=o.stepBackward();while(u&&!n.test(u.type));if(u==null)break;f=u.value,a=f.length-1}return null},this.$findClosingBracket=function(e,t,n){var i=this.$brackets[e],s=1,o=new r(this,t.row,t.column),u=o.getCurrentToken();u||(u=o.stepForward());if(!u)return;n||(n=new RegExp("(\\.?"+u.type.replace(".","\\.").replace("lparen",".paren").replace(/\b(?:start|begin)\b/,"(?:start|begin|end)")+")+"));var a=t.column-o.getCurrentTokenColumn();for(;;){var f=u.value,l=f.length;while(a=4352&&e<=4447||e>=4515&&e<=4519||e>=4602&&e<=4607||e>=9001&&e<=9002||e>=11904&&e<=11929||e>=11931&&e<=12019||e>=12032&&e<=12245||e>=12272&&e<=12283||e>=12288&&e<=12350||e>=12353&&e<=12438||e>=12441&&e<=12543||e>=12549&&e<=12589||e>=12593&&e<=12686||e>=12688&&e<=12730||e>=12736&&e<=12771||e>=12784&&e<=12830||e>=12832&&e<=12871||e>=12880&&e<=13054||e>=13056&&e<=19903||e>=19968&&e<=42124||e>=42128&&e<=42182||e>=43360&&e<=43388||e>=44032&&e<=55203||e>=55216&&e<=55238||e>=55243&&e<=55291||e>=63744&&e<=64255||e>=65040&&e<=65049||e>=65072&&e<=65106||e>=65108&&e<=65126||e>=65128&&e<=65131||e>=65281&&e<=65376||e>=65504&&e<=65510}r.implement(this,u),this.setDocument=function(e){this.doc&&this.doc.removeListener("change",this.$onChange),this.doc=e,e.on("change",this.$onChange),this.bgTokenizer&&this.bgTokenizer.setDocument(this.getDocument()),this.resetCaches()},this.getDocument=function(){return this.doc},this.$resetRowCache=function(e){if(!e){this.$docRowCache=[],this.$screenRowCache=[];return}var t=this.$docRowCache.length,n=this.$getRowCacheIndex(this.$docRowCache,e)+1;t>n&&(this.$docRowCache.splice(n,t),this.$screenRowCache.splice(n,t))},this.$getRowCacheIndex=function(e,t){var n=0,r=e.length-1;while(n<=r){var i=n+r>>1,s=e[i];if(t>s)n=i+1;else{if(!(t=t)break}return r=n[s],r?(r.index=s,r.start=i-r.value.length,r):null},this.setUndoManager=function(e){this.$undoManager=e,this.$informUndoManager&&this.$informUndoManager.cancel();if(e){var t=this;e.addSession(this),this.$syncInformUndoManager=function(){t.$informUndoManager.cancel(),t.mergeUndoDeltas=!1},this.$informUndoManager=i.delayedCall(this.$syncInformUndoManager)}else this.$syncInformUndoManager=function(){}},this.markUndoGroup=function(){this.$syncInformUndoManager&&this.$syncInformUndoManager()},this.$defaultUndoManager={undo:function(){},redo:function(){},hasUndo:function(){},hasRedo:function(){},reset:function(){},add:function(){},addSelection:function(){},startNewGroup:function(){},addSession:function(){}},this.getUndoManager=function(){return this.$undoManager||this.$defaultUndoManager},this.getTabString=function(){return this.getUseSoftTabs()?i.stringRepeat(" ",this.getTabSize()):" "},this.setUseSoftTabs=function(e){this.setOption("useSoftTabs",e)},this.getUseSoftTabs=function(){return this.$useSoftTabs&&!this.$mode.$indentWithTabs},this.setTabSize=function(e){this.setOption("tabSize",e)},this.getTabSize=function(){return this.$tabSize},this.isTabStop=function(e){return this.$useSoftTabs&&e.column%this.$tabSize===0},this.setNavigateWithinSoftTabs=function(e){this.setOption("navigateWithinSoftTabs",e)},this.getNavigateWithinSoftTabs=function(){return this.$navigateWithinSoftTabs},this.$overwrite=!1,this.setOverwrite=function(e){this.setOption("overwrite",e)},this.getOverwrite=function(){return this.$overwrite},this.toggleOverwrite=function(){this.setOverwrite(!this.$overwrite)},this.addGutterDecoration=function(e,t){this.$decorations[e]||(this.$decorations[e]=""),this.$decorations[e]+=" "+t,this._signal("changeBreakpoint",{})},this.removeGutterDecoration=function(e,t){this.$decorations[e]=(this.$decorations[e]||"").replace(" "+t,""),this._signal("changeBreakpoint",{})},this.getBreakpoints=function(){return this.$breakpoints},this.setBreakpoints=function(e){this.$breakpoints=[];for(var t=0;t0&&(r=!!n.charAt(t-1).match(this.tokenRe)),r||(r=!!n.charAt(t).match(this.tokenRe));if(r)var i=this.tokenRe;else if(/^\s+$/.test(n.slice(t-1,t+1)))var i=/\s/;else var i=this.nonTokenRe;var s=t;if(s>0){do s--;while(s>=0&&n.charAt(s).match(i));s++}var o=t;while(oe&&(e=t.screenWidth)}),this.lineWidgetWidth=e},this.$computeWidth=function(e){if(this.$modified||e){this.$modified=!1;if(this.$useWrapMode)return this.screenWidth=this.$wrapLimit;var t=this.doc.getAllLines(),n=this.$rowLengthCache,r=0,i=0,s=this.$foldData[i],o=s?s.start.row:Infinity,u=t.length;for(var a=0;ao){a=s.end.row+1;if(a>=u)break;s=this.$foldData[i++],o=s?s.start.row:Infinity}n[a]==null&&(n[a]=this.$getStringScreenWidth(t[a])[0]),n[a]>r&&(r=n[a])}this.screenWidth=r}},this.getLine=function(e){return this.doc.getLine(e)},this.getLines=function(e,t){return this.doc.getLines(e,t)},this.getLength=function(){return this.doc.getLength()},this.getTextRange=function(e){return this.doc.getTextRange(e||this.selection.getRange())},this.insert=function(e,t){return this.doc.insert(e,t)},this.remove=function(e){return this.doc.remove(e)},this.removeFullLines=function(e,t){return this.doc.removeFullLines(e,t)},this.undoChanges=function(e,t){if(!e.length)return;this.$fromUndo=!0;for(var n=e.length-1;n!=-1;n--){var r=e[n];r.action=="insert"||r.action=="remove"?this.doc.revertDelta(r):r.folds&&this.addFolds(r.folds)}!t&&this.$undoSelect&&(e.selectionBefore?this.selection.fromJSON(e.selectionBefore):this.selection.setRange(this.$getUndoSelection(e,!0))),this.$fromUndo=!1},this.redoChanges=function(e,t){if(!e.length)return;this.$fromUndo=!0;for(var n=0;ne.end.column&&(s.start.column+=u),s.end.row==e.end.row&&s.end.column>e.end.column&&(s.end.column+=u)),o&&s.start.row>=e.end.row&&(s.start.row+=o,s.end.row+=o)}s.end=this.insert(s.start,r);if(i.length){var a=e.start,f=s.start,o=f.row-a.row,u=f.column-a.column;this.addFolds(i.map(function(e){return e=e.clone(),e.start.row==a.row&&(e.start.column+=u),e.end.row==a.row&&(e.end.column+=u),e.start.row+=o,e.end.row+=o,e}))}return s},this.indentRows=function(e,t,n){n=n.replace(/\t/g,this.getTabString());for(var r=e;r<=t;r++)this.doc.insertInLine({row:r,column:0},n)},this.outdentRows=function(e){var t=e.collapseRows(),n=new l(0,0,0,0),r=this.getTabSize();for(var i=t.start.row;i<=t.end.row;++i){var s=this.getLine(i);n.start.row=i,n.end.row=i;for(var o=0;o0){var r=this.getRowFoldEnd(t+n);if(r>this.doc.getLength()-1)return 0;var i=r-t}else{e=this.$clipRowToDocument(e),t=this.$clipRowToDocument(t);var i=t-e+1}var s=new l(e,0,t,Number.MAX_VALUE),o=this.getFoldsInRange(s).map(function(e){return e=e.clone(),e.start.row+=i,e.end.row+=i,e}),u=n==0?this.doc.getLines(e,t):this.doc.removeFullLines(e,t);return this.doc.insertFullLines(e+i,u),o.length&&this.addFolds(o),i},this.moveLinesUp=function(e,t){return this.$moveLines(e,t,-1)},this.moveLinesDown=function(e,t){return this.$moveLines(e,t,1)},this.duplicateLines=function(e,t){return this.$moveLines(e,t,0)},this.$clipRowToDocument=function(e){return Math.max(0,Math.min(e,this.doc.getLength()-1))},this.$clipColumnToRow=function(e,t){return t<0?0:Math.min(this.doc.getLine(e).length,t)},this.$clipPositionToDocument=function(e,t){t=Math.max(0,t);if(e<0)e=0,t=0;else{var n=this.doc.getLength();e>=n?(e=n-1,t=this.doc.getLine(n-1).length):t=Math.min(this.doc.getLine(e).length,t)}return{row:e,column:t}},this.$clipRangeToDocument=function(e){e.start.row<0?(e.start.row=0,e.start.column=0):e.start.column=this.$clipColumnToRow(e.start.row,e.start.column);var t=this.doc.getLength()-1;return e.end.row>t?(e.end.row=t,e.end.column=this.doc.getLine(t).length):e.end.column=this.$clipColumnToRow(e.end.row,e.end.column),e},this.$wrapLimit=80,this.$useWrapMode=!1,this.$wrapLimitRange={min:null,max:null},this.setUseWrapMode=function(e){if(e!=this.$useWrapMode){this.$useWrapMode=e,this.$modified=!0,this.$resetRowCache(0);if(e){var t=this.getLength();this.$wrapData=Array(t),this.$updateWrapData(0,t-1)}this._signal("changeWrapMode")}},this.getUseWrapMode=function(){return this.$useWrapMode},this.setWrapLimitRange=function(e,t){if(this.$wrapLimitRange.min!==e||this.$wrapLimitRange.max!==t)this.$wrapLimitRange={min:e,max:t},this.$modified=!0,this.$bidiHandler.markAsDirty(),this.$useWrapMode&&this._signal("changeWrapMode")},this.adjustWrapLimit=function(e,t){var n=this.$wrapLimitRange;n.max<0&&(n={min:t,max:t});var r=this.$constrainWrapLimit(e,n.min,n.max);return r!=this.$wrapLimit&&r>1?(this.$wrapLimit=r,this.$modified=!0,this.$useWrapMode&&(this.$updateWrapData(0,this.getLength()-1),this.$resetRowCache(0),this._signal("changeWrapLimit")),!0):!1},this.$constrainWrapLimit=function(e,t,n){return t&&(e=Math.max(t,e)),n&&(e=Math.min(n,e)),e},this.getWrapLimit=function(){return this.$wrapLimit},this.setWrapLimit=function(e){this.setWrapLimitRange(e,e)},this.getWrapLimitRange=function(){return{min:this.$wrapLimitRange.min,max:this.$wrapLimitRange.max}},this.$updateInternalDataOnChange=function(e){var t=this.$useWrapMode,n=e.action,r=e.start,i=e.end,s=r.row,o=i.row,u=o-s,a=null;this.$updating=!0;if(u!=0)if(n==="remove"){this[t?"$wrapData":"$rowLengthCache"].splice(s,u);var f=this.$foldData;a=this.getFoldsInRange(e),this.removeFolds(a);var l=this.getFoldLine(i.row),c=0;if(l){l.addRemoveChars(i.row,i.column,r.column-i.column),l.shiftRow(-u);var h=this.getFoldLine(s);h&&h!==l&&(h.merge(l),l=h),c=f.indexOf(l)+1}for(c;c=i.row&&l.shiftRow(-u)}o=s}else{var p=Array(u);p.unshift(s,0);var d=t?this.$wrapData:this.$rowLengthCache;d.splice.apply(d,p);var f=this.$foldData,l=this.getFoldLine(s),c=0;if(l){var v=l.range.compareInside(r.row,r.column);v==0?(l=l.split(r.row,r.column),l&&(l.shiftRow(u),l.addRemoveChars(o,0,i.column-r.column))):v==-1&&(l.addRemoveChars(s,0,i.column-r.column),l.shiftRow(u)),c=f.indexOf(l)+1}for(c;c=s&&l.shiftRow(u)}}else{u=Math.abs(e.start.column-e.end.column),n==="remove"&&(a=this.getFoldsInRange(e),this.removeFolds(a),u=-u);var l=this.getFoldLine(s);l&&l.addRemoveChars(s,r.column,u)}return t&&this.$wrapData.length!=this.doc.getLength()&&console.error("doc.getLength() and $wrapData.length have to be the same!"),this.$updating=!1,t?this.$updateWrapData(s,o):this.$updateRowLengthCache(s,o),a},this.$updateRowLengthCache=function(e,t,n){this.$rowLengthCache[e]=null,this.$rowLengthCache[t]=null},this.$updateWrapData=function(e,t){var r=this.doc.getAllLines(),i=this.getTabSize(),o=this.$wrapData,u=this.$wrapLimit,a,f,l=e;t=Math.min(t,r.length-1);while(l<=t)f=this.getFoldLine(l,f),f?(a=[],f.walk(function(e,t,i,o){var u;if(e!=null){u=this.$getDisplayTokens(e,a.length),u[0]=n;for(var f=1;fr-b){var w=f+r-b;if(e[w-1]>=c&&e[w]>=c){y(w);continue}if(e[w]==n||e[w]==s){for(w;w!=f-1;w--)if(e[w]==n)break;if(w>f){y(w);continue}w=f+r;for(w;w>2)),f-1);while(w>E&&e[w]E&&e[w]E&&e[w]==a)w--}else while(w>E&&e[w]E){y(++w);continue}w=f+r,e[w]==t&&w--,y(w-b)}return o},this.$getDisplayTokens=function(n,r){var i=[],s;r=r||0;for(var o=0;o39&&u<48||u>57&&u<64?i.push(a):u>=4352&&m(u)?i.push(e,t):i.push(e)}return i},this.$getStringScreenWidth=function(e,t,n){if(t==0)return[0,0];t==null&&(t=Infinity),n=n||0;var r,i;for(i=0;i=4352&&m(r)?n+=2:n+=1;if(n>t)break}return[n,i]},this.lineWidgets=null,this.getRowLength=function(e){var t=1;return this.lineWidgets&&(t+=this.lineWidgets[e]&&this.lineWidgets[e].rowCount||0),!this.$useWrapMode||!this.$wrapData[e]?t:this.$wrapData[e].length+t},this.getRowLineCount=function(e){return!this.$useWrapMode||!this.$wrapData[e]?1:this.$wrapData[e].length+1},this.getRowWrapIndent=function(e){if(this.$useWrapMode){var t=this.screenToDocumentPosition(e,Number.MAX_VALUE),n=this.$wrapData[t.row];return n.length&&n[0]=0)var u=f[l],i=this.$docRowCache[l],h=e>f[c-1];else var h=!c;var p=this.getLength()-1,d=this.getNextFoldLine(i),v=d?d.start.row:Infinity;while(u<=e){a=this.getRowLength(i);if(u+a>e||i>=p)break;u+=a,i++,i>v&&(i=d.end.row+1,d=this.getNextFoldLine(i,d),v=d?d.start.row:Infinity),h&&(this.$docRowCache.push(i),this.$screenRowCache.push(u))}if(d&&d.start.row<=i)r=this.getFoldDisplayLine(d),i=d.start.row;else{if(u+a<=e||i>p)return{row:p,column:this.getLine(p).length};r=this.getLine(i),d=null}var m=0,g=Math.floor(e-u);if(this.$useWrapMode){var y=this.$wrapData[i];y&&(o=y[g],g>0&&y.length&&(m=y.indent,s=y[g-1]||y[y.length-1],r=r.substring(s)))}return n!==undefined&&this.$bidiHandler.isBidiRow(u+g,i,g)&&(t=this.$bidiHandler.offsetToCol(n)),s+=this.$getStringScreenWidth(r,t-m)[1],this.$useWrapMode&&s>=o&&(s=o-1),d?d.idxToPosition(s):{row:i,column:s}},this.documentToScreenPosition=function(e,t){if(typeof t=="undefined")var n=this.$clipPositionToDocument(e.row,e.column);else n=this.$clipPositionToDocument(e,t);e=n.row,t=n.column;var r=0,i=null,s=null;s=this.getFoldAt(e,t,1),s&&(e=s.start.row,t=s.start.column);var o,u=0,a=this.$docRowCache,f=this.$getRowCacheIndex(a,e),l=a.length;if(l&&f>=0)var u=a[f],r=this.$screenRowCache[f],c=e>a[l-1];else var c=!l;var h=this.getNextFoldLine(u),p=h?h.start.row:Infinity;while(u=p){o=h.end.row+1;if(o>e)break;h=this.getNextFoldLine(o,h),p=h?h.start.row:Infinity}else o=u+1;r+=this.getRowLength(u),u=o,c&&(this.$docRowCache.push(u),this.$screenRowCache.push(r))}var d="";h&&u>=p?(d=this.getFoldDisplayLine(h,e,t),i=h.start.row):(d=this.getLine(e).substring(0,t),i=e);var v=0;if(this.$useWrapMode){var m=this.$wrapData[i];if(m){var g=0;while(d.length>=m[g])r++,g++;d=d.substring(m[g-1]||0,d.length),v=g>0?m.indent:0}}return this.lineWidgets&&this.lineWidgets[u]&&this.lineWidgets[u].rowsAbove&&(r+=this.lineWidgets[u].rowsAbove),{row:r,column:v+this.$getStringScreenWidth(d)[0]}},this.documentToScreenColumn=function(e,t){return this.documentToScreenPosition(e,t).column},this.documentToScreenRow=function(e,t){return this.documentToScreenPosition(e,t).row},this.getScreenLength=function(){var e=0,t=null;if(!this.$useWrapMode){e=this.getLength();var n=this.$foldData;for(var r=0;ro&&(s=t.end.row+1,t=this.$foldData[r++],o=t?t.start.row:Infinity)}}return this.lineWidgets&&(e+=this.$getWidgetScreenLength()),e},this.$setFontMetrics=function(e){if(!this.$enableVarChar)return;this.$getStringScreenWidth=function(t,n,r){if(n===0)return[0,0];n||(n=Infinity),r=r||0;var i,s;for(s=0;sn)break}return[r,s]}},this.destroy=function(){this.bgTokenizer&&(this.bgTokenizer.setDocument(null),this.bgTokenizer=null),this.$stopWorker(),this.removeAllListeners(),this.selection.detach()},this.isFullWidth=m}.call(d.prototype),e("./edit_session/folding").Folding.call(d.prototype),e("./edit_session/bracket_match").BracketMatch.call(d.prototype),o.defineOptions(d.prototype,"session",{wrap:{set:function(e){!e||e=="off"?e=!1:e=="free"?e=!0:e=="printMargin"?e=-1:typeof e=="string"&&(e=parseInt(e,10)||!1);if(this.$wrap==e)return;this.$wrap=e;if(!e)this.setUseWrapMode(!1);else{var t=typeof e=="number"?e:null;this.setWrapLimitRange(t,t),this.setUseWrapMode(!0)}},get:function(){return this.getUseWrapMode()?this.$wrap==-1?"printMargin":this.getWrapLimitRange().min?this.$wrap:"free":"off"},handlesSet:!0},wrapMethod:{set:function(e){e=e=="auto"?this.$mode.type!="text":e!="text",e!=this.$wrapAsCode&&(this.$wrapAsCode=e,this.$useWrapMode&&(this.$useWrapMode=!1,this.setUseWrapMode(!0)))},initialValue:"auto"},indentedSoftWrap:{set:function(){this.$useWrapMode&&(this.$useWrapMode=!1,this.setUseWrapMode(!0))},initialValue:!0},firstLineNumber:{set:function(){this._signal("changeBreakpoint")},initialValue:1},useWorker:{set:function(e){this.$useWorker=e,this.$stopWorker(),e&&this.$startWorker()},initialValue:!0},useSoftTabs:{initialValue:!0},tabSize:{set:function(e){e=parseInt(e),e>0&&this.$tabSize!==e&&(this.$modified=!0,this.$rowLengthCache=[],this.$tabSize=e,this._signal("changeTabSize"))},initialValue:4,handlesSet:!0},navigateWithinSoftTabs:{initialValue:!1},foldStyle:{set:function(e){this.setFoldStyle(e)},handlesSet:!0},overwrite:{set:function(e){this._signal("changeOverwrite")},initialValue:!1},newLineMode:{set:function(e){this.doc.setNewLineMode(e)},get:function(){return this.doc.getNewLineMode()},handlesSet:!0},mode:{set:function(e){this.setMode(e)},get:function(){return this.$modeId},handlesSet:!0}}),t.EditSession=d}),define("ace/search",["require","exports","module","ace/lib/lang","ace/lib/oop","ace/range"],function(e,t,n){"use strict";function u(e,t){function n(e){return/\w/.test(e)||t.regExp?"\\b":""}return n(e[0])+e+n(e[e.length-1])}var r=e("./lib/lang"),i=e("./lib/oop"),s=e("./range").Range,o=function(){this.$options={}};(function(){this.set=function(e){return i.mixin(this.$options,e),this},this.getOptions=function(){return r.copyObject(this.$options)},this.setOptions=function(e){this.$options=e},this.find=function(e){var t=this.$options,n=this.$matchIterator(e,t);if(!n)return!1;var r=null;return n.forEach(function(e,n,i,o){return r=new s(e,n,i,o),n==o&&t.start&&t.start.start&&t.skipCurrent!=0&&r.isEqual(t.start)?(r=null,!1):!0}),r},this.findAll=function(e){var t=this.$options;if(!t.needle)return[];this.$assembleRegExp(t);var n=t.range,i=n?e.getLines(n.start.row,n.end.row):e.doc.getAllLines(),o=[],u=t.re;if(t.$isMultiLine){var a=u.length,f=i.length-a,l;e:for(var c=u.offset||0;c<=f;c++){for(var h=0;hv)continue;o.push(l=new s(c,v,c+a-1,m)),a>2&&(c=c+a-2)}}else for(var g=0;gE&&o[h].end.row==n.end.row)h--;o=o.slice(g,h+1);for(g=0,h=o.length;g=u;n--)if(c(n,Number.MAX_VALUE,e))return;if(t.wrap==0)return;for(n=a,u=o.row;n>=u;n--)if(c(n,Number.MAX_VALUE,e))return};else var f=function(e){var n=o.row;if(c(n,o.column,e))return;for(n+=1;n<=a;n++)if(c(n,0,e))return;if(t.wrap==0)return;for(n=u,a=o.row;n<=a;n++)if(c(n,0,e))return};if(t.$isMultiLine)var l=n.length,c=function(t,i,s){var o=r?t-l+1:t;if(o<0)return;var u=e.getLine(o),a=u.search(n[0]);if(!r&&ai)return;if(s(o,a,o+l-1,c))return!0};else if(r)var c=function(t,r,i){var s=e.getLine(t),o=[],u,a=0;n.lastIndex=0;while(u=n.exec(s)){var f=u[0].length;a=u.index;if(!f){if(a>=s.length)break;n.lastIndex=a+=1}if(u.index+f>r)break;o.push(u.index,f)}for(var l=o.length-1;l>=0;l-=2){var c=o[l-1],f=o[l];if(i(t,c,t,c+f))return!0}};else var c=function(t,r,i){var s=e.getLine(t),o,u;n.lastIndex=r;while(u=n.exec(s)){var a=u[0].length;o=u.index;if(i(t,o,t,o+a))return!0;if(!a){n.lastIndex=o+=1;if(o>=s.length)return!1}}};return{forEach:f}}}).call(o.prototype),t.Search=o}),define("ace/keyboard/hash_handler",["require","exports","module","ace/lib/keys","ace/lib/useragent"],function(e,t,n){"use strict";function o(e,t){this.platform=t||(i.isMac?"mac":"win"),this.commands={},this.commandKeyBinding={},this.addCommands(e),this.$singleCommand=!0}function u(e,t){o.call(this,e,t),this.$singleCommand=!1}var r=e("../lib/keys"),i=e("../lib/useragent"),s=r.KEY_MODS;u.prototype=o.prototype,function(){function e(e){return typeof e=="object"&&e.bindKey&&e.bindKey.position||(e.isDefault?-100:0)}this.addCommand=function(e){this.commands[e.name]&&this.removeCommand(e),this.commands[e.name]=e,e.bindKey&&this._buildKeyHash(e)},this.removeCommand=function(e,t){var n=e&&(typeof e=="string"?e:e.name);e=this.commands[n],t||delete this.commands[n];var r=this.commandKeyBinding;for(var i in r){var s=r[i];if(s==e)delete r[i];else if(Array.isArray(s)){var o=s.indexOf(e);o!=-1&&(s.splice(o,1),s.length==1&&(r[i]=s[0]))}}},this.bindKey=function(e,t,n){typeof e=="object"&&e&&(n==undefined&&(n=e.position),e=e[this.platform]);if(!e)return;if(typeof t=="function")return this.addCommand({exec:t,bindKey:e,name:t.name||e});e.split("|").forEach(function(e){var r="";if(e.indexOf(" ")!=-1){var i=e.split(/\s+/);e=i.pop(),i.forEach(function(e){var t=this.parseKeys(e),n=s[t.hashId]+t.key;r+=(r?" ":"")+n,this._addCommandToBinding(r,"chainKeys")},this),r+=" "}var o=this.parseKeys(e),u=s[o.hashId]+o.key;this._addCommandToBinding(r+u,t,n)},this)},this._addCommandToBinding=function(t,n,r){var i=this.commandKeyBinding,s;if(!n)delete i[t];else if(!i[t]||this.$singleCommand)i[t]=n;else{Array.isArray(i[t])?(s=i[t].indexOf(n))!=-1&&i[t].splice(s,1):i[t]=[i[t]],typeof r!="number"&&(r=e(n));var o=i[t];for(s=0;sr)break}o.splice(s,0,n)}},this.addCommands=function(e){e&&Object.keys(e).forEach(function(t){var n=e[t];if(!n)return;if(typeof n=="string")return this.bindKey(n,t);typeof n=="function"&&(n={exec:n});if(typeof n!="object")return;n.name||(n.name=t),this.addCommand(n)},this)},this.removeCommands=function(e){Object.keys(e).forEach(function(t){this.removeCommand(e[t])},this)},this.bindKeys=function(e){Object.keys(e).forEach(function(t){this.bindKey(t,e[t])},this)},this._buildKeyHash=function(e){this.bindKey(e.bindKey,e)},this.parseKeys=function(e){var t=e.toLowerCase().split(/[\-\+]([\-\+])?/).filter(function(e){return e}),n=t.pop(),i=r[n];if(r.FUNCTION_KEYS[i])n=r.FUNCTION_KEYS[i].toLowerCase();else{if(!t.length)return{key:n,hashId:-1};if(t.length==1&&t[0]=="shift")return{key:n.toUpperCase(),hashId:-1}}var s=0;for(var o=t.length;o--;){var u=r.KEY_MODS[t[o]];if(u==null)return typeof console!="undefined"&&console.error("invalid modifier "+t[o]+" in "+e),!1;s|=u}return{key:n,hashId:s}},this.findKeyCommand=function(t,n){var r=s[t]+n;return this.commandKeyBinding[r]},this.handleKeyboard=function(e,t,n,r){if(r<0)return;var i=s[t]+n,o=this.commandKeyBinding[i];e.$keyChain&&(e.$keyChain+=" "+i,o=this.commandKeyBinding[e.$keyChain]||o);if(o)if(o=="chainKeys"||o[o.length-1]=="chainKeys")return e.$keyChain=e.$keyChain||i,{command:"null"};if(e.$keyChain)if(!!t&&t!=4||n.length!=1){if(t==-1||r>0)e.$keyChain=""}else e.$keyChain=e.$keyChain.slice(0,-i.length-1);return{command:o}},this.getStatusText=function(e,t){return t.$keyChain||""}}.call(o.prototype),t.HashHandler=o,t.MultiHashHandler=u}),define("ace/commands/command_manager",["require","exports","module","ace/lib/oop","ace/keyboard/hash_handler","ace/lib/event_emitter"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("../keyboard/hash_handler").MultiHashHandler,s=e("../lib/event_emitter").EventEmitter,o=function(e,t){i.call(this,t,e),this.byName=this.commands,this.setDefaultHandler("exec",function(e){return e.command.exec(e.editor,e.args||{})})};r.inherits(o,i),function(){r.implement(this,s),this.exec=function(e,t,n){if(Array.isArray(e)){for(var r=e.length;r--;)if(this.exec(e[r],t,n))return!0;return!1}typeof e=="string"&&(e=this.commands[e]);if(!e)return!1;if(t&&t.$readOnly&&!e.readOnly)return!1;if(this.$checkCommandState!=0&&e.isAvailable&&!e.isAvailable(t))return!1;var i={editor:t,command:e,args:n};return i.returnValue=this._emit("exec",i),this._signal("afterExec",i),i.returnValue===!1?!1:!0},this.toggleRecording=function(e){if(this.$inReplay)return;return e&&e._emit("changeStatus"),this.recording?(this.macro.pop(),this.off("exec",this.$addCommandToMacro),this.macro.length||(this.macro=this.oldMacro),this.recording=!1):(this.$addCommandToMacro||(this.$addCommandToMacro=function(e){this.macro.push([e.command,e.args])}.bind(this)),this.oldMacro=this.macro,this.macro=[],this.on("exec",this.$addCommandToMacro),this.recording=!0)},this.replay=function(e){if(this.$inReplay||!this.macro)return;if(this.recording)return this.toggleRecording(e);try{this.$inReplay=!0,this.macro.forEach(function(t){typeof t=="string"?this.exec(t,e):this.exec(t[0],e,t[1])},this)}finally{this.$inReplay=!1}},this.trimMacro=function(e){return e.map(function(e){return typeof e[0]!="string"&&(e[0]=e[0].name),e[1]||(e=e[0]),e})}}.call(o.prototype),t.CommandManager=o}),define("ace/commands/default_commands",["require","exports","module","ace/lib/lang","ace/config","ace/range"],function(e,t,n){"use strict";function o(e,t){return{win:e,mac:t}}var r=e("../lib/lang"),i=e("../config"),s=e("../range").Range;t.commands=[{name:"showSettingsMenu",bindKey:o("Ctrl-,","Command-,"),exec:function(e){i.loadModule("ace/ext/settings_menu",function(t){t.init(e),e.showSettingsMenu()})},readOnly:!0},{name:"goToNextError",bindKey:o("Alt-E","F4"),exec:function(e){i.loadModule("./ext/error_marker",function(t){t.showErrorMarker(e,1)})},scrollIntoView:"animate",readOnly:!0},{name:"goToPreviousError",bindKey:o("Alt-Shift-E","Shift-F4"),exec:function(e){i.loadModule("./ext/error_marker",function(t){t.showErrorMarker(e,-1)})},scrollIntoView:"animate",readOnly:!0},{name:"selectall",description:"Select all",bindKey:o("Ctrl-A","Command-A"),exec:function(e){e.selectAll()},readOnly:!0},{name:"centerselection",description:"Center selection",bindKey:o(null,"Ctrl-L"),exec:function(e){e.centerSelection()},readOnly:!0},{name:"gotoline",description:"Go to line...",bindKey:o("Ctrl-L","Command-L"),exec:function(e,t){typeof t=="number"&&!isNaN(t)&&e.gotoLine(t),e.prompt({$type:"gotoLine"})},readOnly:!0},{name:"fold",bindKey:o("Alt-L|Ctrl-F1","Command-Alt-L|Command-F1"),exec:function(e){e.session.toggleFold(!1)},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"unfold",bindKey:o("Alt-Shift-L|Ctrl-Shift-F1","Command-Alt-Shift-L|Command-Shift-F1"),exec:function(e){e.session.toggleFold(!0)},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"toggleFoldWidget",bindKey:o("F2","F2"),exec:function(e){e.session.toggleFoldWidget()},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"toggleParentFoldWidget",bindKey:o("Alt-F2","Alt-F2"),exec:function(e){e.session.toggleFoldWidget(!0)},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"foldall",description:"Fold all",bindKey:o(null,"Ctrl-Command-Option-0"),exec:function(e){e.session.foldAll()},scrollIntoView:"center",readOnly:!0},{name:"foldOther",description:"Fold other",bindKey:o("Alt-0","Command-Option-0"),exec:function(e){e.session.foldAll(),e.session.unfold(e.selection.getAllRanges())},scrollIntoView:"center",readOnly:!0},{name:"unfoldall",description:"Unfold all",bindKey:o("Alt-Shift-0","Command-Option-Shift-0"),exec:function(e){e.session.unfold()},scrollIntoView:"center",readOnly:!0},{name:"findnext",description:"Find next",bindKey:o("Ctrl-K","Command-G"),exec:function(e){e.findNext()},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"findprevious",description:"Find previous",bindKey:o("Ctrl-Shift-K","Command-Shift-G"),exec:function(e){e.findPrevious()},multiSelectAction:"forEach",scrollIntoView:"center",readOnly:!0},{name:"selectOrFindNext",description:"Select or find next",bindKey:o("Alt-K","Ctrl-G"),exec:function(e){e.selection.isEmpty()?e.selection.selectWord():e.findNext()},readOnly:!0},{name:"selectOrFindPrevious",description:"Select or find previous",bindKey:o("Alt-Shift-K","Ctrl-Shift-G"),exec:function(e){e.selection.isEmpty()?e.selection.selectWord():e.findPrevious()},readOnly:!0},{name:"find",description:"Find",bindKey:o("Ctrl-F","Command-F"),exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e)})},readOnly:!0},{name:"overwrite",description:"Overwrite",bindKey:"Insert",exec:function(e){e.toggleOverwrite()},readOnly:!0},{name:"selecttostart",description:"Select to start",bindKey:o("Ctrl-Shift-Home","Command-Shift-Home|Command-Shift-Up"),exec:function(e){e.getSelection().selectFileStart()},multiSelectAction:"forEach",readOnly:!0,scrollIntoView:"animate",aceCommandGroup:"fileJump"},{name:"gotostart",description:"Go to start",bindKey:o("Ctrl-Home","Command-Home|Command-Up"),exec:function(e){e.navigateFileStart()},multiSelectAction:"forEach",readOnly:!0,scrollIntoView:"animate",aceCommandGroup:"fileJump"},{name:"selectup",description:"Select up",bindKey:o("Shift-Up","Shift-Up|Ctrl-Shift-P"),exec:function(e){e.getSelection().selectUp()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"golineup",description:"Go line up",bindKey:o("Up","Up|Ctrl-P"),exec:function(e,t){e.navigateUp(t.times)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selecttoend",description:"Select to end",bindKey:o("Ctrl-Shift-End","Command-Shift-End|Command-Shift-Down"),exec:function(e){e.getSelection().selectFileEnd()},multiSelectAction:"forEach",readOnly:!0,scrollIntoView:"animate",aceCommandGroup:"fileJump"},{name:"gotoend",description:"Go to end",bindKey:o("Ctrl-End","Command-End|Command-Down"),exec:function(e){e.navigateFileEnd()},multiSelectAction:"forEach",readOnly:!0,scrollIntoView:"animate",aceCommandGroup:"fileJump"},{name:"selectdown",description:"Select down",bindKey:o("Shift-Down","Shift-Down|Ctrl-Shift-N"),exec:function(e){e.getSelection().selectDown()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"golinedown",description:"Go line down",bindKey:o("Down","Down|Ctrl-N"),exec:function(e,t){e.navigateDown(t.times)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectwordleft",description:"Select word left",bindKey:o("Ctrl-Shift-Left","Option-Shift-Left"),exec:function(e){e.getSelection().selectWordLeft()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotowordleft",description:"Go to word left",bindKey:o("Ctrl-Left","Option-Left"),exec:function(e){e.navigateWordLeft()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selecttolinestart",description:"Select to line start",bindKey:o("Alt-Shift-Left","Command-Shift-Left|Ctrl-Shift-A"),exec:function(e){e.getSelection().selectLineStart()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotolinestart",description:"Go to line start",bindKey:o("Alt-Left|Home","Command-Left|Home|Ctrl-A"),exec:function(e){e.navigateLineStart()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectleft",description:"Select left",bindKey:o("Shift-Left","Shift-Left|Ctrl-Shift-B"),exec:function(e){e.getSelection().selectLeft()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotoleft",description:"Go to left",bindKey:o("Left","Left|Ctrl-B"),exec:function(e,t){e.navigateLeft(t.times)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectwordright",description:"Select word right",bindKey:o("Ctrl-Shift-Right","Option-Shift-Right"),exec:function(e){e.getSelection().selectWordRight()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotowordright",description:"Go to word right",bindKey:o("Ctrl-Right","Option-Right"),exec:function(e){e.navigateWordRight()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selecttolineend",description:"Select to line end",bindKey:o("Alt-Shift-Right","Command-Shift-Right|Shift-End|Ctrl-Shift-E"),exec:function(e){e.getSelection().selectLineEnd()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotolineend",description:"Go to line end",bindKey:o("Alt-Right|End","Command-Right|End|Ctrl-E"),exec:function(e){e.navigateLineEnd()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectright",description:"Select right",bindKey:o("Shift-Right","Shift-Right"),exec:function(e){e.getSelection().selectRight()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"gotoright",description:"Go to right",bindKey:o("Right","Right|Ctrl-F"),exec:function(e,t){e.navigateRight(t.times)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectpagedown",description:"Select page down",bindKey:"Shift-PageDown",exec:function(e){e.selectPageDown()},readOnly:!0},{name:"pagedown",description:"Page down",bindKey:o(null,"Option-PageDown"),exec:function(e){e.scrollPageDown()},readOnly:!0},{name:"gotopagedown",description:"Go to page down",bindKey:o("PageDown","PageDown|Ctrl-V"),exec:function(e){e.gotoPageDown()},readOnly:!0},{name:"selectpageup",description:"Select page up",bindKey:"Shift-PageUp",exec:function(e){e.selectPageUp()},readOnly:!0},{name:"pageup",description:"Page up",bindKey:o(null,"Option-PageUp"),exec:function(e){e.scrollPageUp()},readOnly:!0},{name:"gotopageup",description:"Go to page up",bindKey:"PageUp",exec:function(e){e.gotoPageUp()},readOnly:!0},{name:"scrollup",description:"Scroll up",bindKey:o("Ctrl-Up",null),exec:function(e){e.renderer.scrollBy(0,-2*e.renderer.layerConfig.lineHeight)},readOnly:!0},{name:"scrolldown",description:"Scroll down",bindKey:o("Ctrl-Down",null),exec:function(e){e.renderer.scrollBy(0,2*e.renderer.layerConfig.lineHeight)},readOnly:!0},{name:"selectlinestart",description:"Select line start",bindKey:"Shift-Home",exec:function(e){e.getSelection().selectLineStart()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectlineend",description:"Select line end",bindKey:"Shift-End",exec:function(e){e.getSelection().selectLineEnd()},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"togglerecording",description:"Toggle recording",bindKey:o("Ctrl-Alt-E","Command-Option-E"),exec:function(e){e.commands.toggleRecording(e)},readOnly:!0},{name:"replaymacro",description:"Replay macro",bindKey:o("Ctrl-Shift-E","Command-Shift-E"),exec:function(e){e.commands.replay(e)},readOnly:!0},{name:"jumptomatching",description:"Jump to matching",bindKey:o("Ctrl-\\|Ctrl-P","Command-\\"),exec:function(e){e.jumpToMatching()},multiSelectAction:"forEach",scrollIntoView:"animate",readOnly:!0},{name:"selecttomatching",description:"Select to matching",bindKey:o("Ctrl-Shift-\\|Ctrl-Shift-P","Command-Shift-\\"),exec:function(e){e.jumpToMatching(!0)},multiSelectAction:"forEach",scrollIntoView:"animate",readOnly:!0},{name:"expandToMatching",description:"Expand to matching",bindKey:o("Ctrl-Shift-M","Ctrl-Shift-M"),exec:function(e){e.jumpToMatching(!0,!0)},multiSelectAction:"forEach",scrollIntoView:"animate",readOnly:!0},{name:"passKeysToBrowser",description:"Pass keys to browser",bindKey:o(null,null),exec:function(){},passEvent:!0,readOnly:!0},{name:"copy",description:"Copy",exec:function(e){},readOnly:!0},{name:"cut",description:"Cut",exec:function(e){var t=e.$copyWithEmptySelection&&e.selection.isEmpty(),n=t?e.selection.getLineRange():e.selection.getRange();e._emit("cut",n),n.isEmpty()||e.session.remove(n),e.clearSelection()},scrollIntoView:"cursor",multiSelectAction:"forEach"},{name:"paste",description:"Paste",exec:function(e,t){e.$handlePaste(t)},scrollIntoView:"cursor"},{name:"removeline",description:"Remove line",bindKey:o("Ctrl-D","Command-D"),exec:function(e){e.removeLines()},scrollIntoView:"cursor",multiSelectAction:"forEachLine"},{name:"duplicateSelection",description:"Duplicate selection",bindKey:o("Ctrl-Shift-D","Command-Shift-D"),exec:function(e){e.duplicateSelection()},scrollIntoView:"cursor",multiSelectAction:"forEach"},{name:"sortlines",description:"Sort lines",bindKey:o("Ctrl-Alt-S","Command-Alt-S"),exec:function(e){e.sortLines()},scrollIntoView:"selection",multiSelectAction:"forEachLine"},{name:"togglecomment",description:"Toggle comment",bindKey:o("Ctrl-/","Command-/"),exec:function(e){e.toggleCommentLines()},multiSelectAction:"forEachLine",scrollIntoView:"selectionPart"},{name:"toggleBlockComment",description:"Toggle block comment",bindKey:o("Ctrl-Shift-/","Command-Shift-/"),exec:function(e){e.toggleBlockComment()},multiSelectAction:"forEach",scrollIntoView:"selectionPart"},{name:"modifyNumberUp",description:"Modify number up",bindKey:o("Ctrl-Shift-Up","Alt-Shift-Up"),exec:function(e){e.modifyNumber(1)},scrollIntoView:"cursor",multiSelectAction:"forEach"},{name:"modifyNumberDown",description:"Modify number down",bindKey:o("Ctrl-Shift-Down","Alt-Shift-Down"),exec:function(e){e.modifyNumber(-1)},scrollIntoView:"cursor",multiSelectAction:"forEach"},{name:"replace",description:"Replace",bindKey:o("Ctrl-H","Command-Option-F"),exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!0)})}},{name:"undo",description:"Undo",bindKey:o("Ctrl-Z","Command-Z"),exec:function(e){e.undo()}},{name:"redo",description:"Redo",bindKey:o("Ctrl-Shift-Z|Ctrl-Y","Command-Shift-Z|Command-Y"),exec:function(e){e.redo()}},{name:"copylinesup",description:"Copy lines up",bindKey:o("Alt-Shift-Up","Command-Option-Up"),exec:function(e){e.copyLinesUp()},scrollIntoView:"cursor"},{name:"movelinesup",description:"Move lines up",bindKey:o("Alt-Up","Option-Up"),exec:function(e){e.moveLinesUp()},scrollIntoView:"cursor"},{name:"copylinesdown",description:"Copy lines down",bindKey:o("Alt-Shift-Down","Command-Option-Down"),exec:function(e){e.copyLinesDown()},scrollIntoView:"cursor"},{name:"movelinesdown",description:"Move lines down",bindKey:o("Alt-Down","Option-Down"),exec:function(e){e.moveLinesDown()},scrollIntoView:"cursor"},{name:"del",description:"Delete",bindKey:o("Delete","Delete|Ctrl-D|Shift-Delete"),exec:function(e){e.remove("right")},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"backspace",description:"Backspace",bindKey:o("Shift-Backspace|Backspace","Ctrl-Backspace|Shift-Backspace|Backspace|Ctrl-H"),exec:function(e){e.remove("left")},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"cut_or_delete",description:"Cut or delete",bindKey:o("Shift-Delete",null),exec:function(e){if(!e.selection.isEmpty())return!1;e.remove("left")},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removetolinestart",description:"Remove to line start",bindKey:o("Alt-Backspace","Command-Backspace"),exec:function(e){e.removeToLineStart()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removetolineend",description:"Remove to line end",bindKey:o("Alt-Delete","Ctrl-K|Command-Delete"),exec:function(e){e.removeToLineEnd()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removetolinestarthard",description:"Remove to line start hard",bindKey:o("Ctrl-Shift-Backspace",null),exec:function(e){var t=e.selection.getRange();t.start.column=0,e.session.remove(t)},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removetolineendhard",description:"Remove to line end hard",bindKey:o("Ctrl-Shift-Delete",null),exec:function(e){var t=e.selection.getRange();t.end.column=Number.MAX_VALUE,e.session.remove(t)},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removewordleft",description:"Remove word left",bindKey:o("Ctrl-Backspace","Alt-Backspace|Ctrl-Alt-Backspace"),exec:function(e){e.removeWordLeft()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"removewordright",description:"Remove word right",bindKey:o("Ctrl-Delete","Alt-Delete"),exec:function(e){e.removeWordRight()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"outdent",description:"Outdent",bindKey:o("Shift-Tab","Shift-Tab"),exec:function(e){e.blockOutdent()},multiSelectAction:"forEach",scrollIntoView:"selectionPart"},{name:"indent",description:"Indent",bindKey:o("Tab","Tab"),exec:function(e){e.indent()},multiSelectAction:"forEach",scrollIntoView:"selectionPart"},{name:"blockoutdent",description:"Block outdent",bindKey:o("Ctrl-[","Ctrl-["),exec:function(e){e.blockOutdent()},multiSelectAction:"forEachLine",scrollIntoView:"selectionPart"},{name:"blockindent",description:"Block indent",bindKey:o("Ctrl-]","Ctrl-]"),exec:function(e){e.blockIndent()},multiSelectAction:"forEachLine",scrollIntoView:"selectionPart"},{name:"insertstring",description:"Insert string",exec:function(e,t){e.insert(t)},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"inserttext",description:"Insert text",exec:function(e,t){e.insert(r.stringRepeat(t.text||"",t.times||1))},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"splitline",description:"Split line",bindKey:o(null,"Ctrl-O"),exec:function(e){e.splitLine()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"transposeletters",description:"Transpose letters",bindKey:o("Alt-Shift-X","Ctrl-T"),exec:function(e){e.transposeLetters()},multiSelectAction:function(e){e.transposeSelections(1)},scrollIntoView:"cursor"},{name:"touppercase",description:"To uppercase",bindKey:o("Ctrl-U","Ctrl-U"),exec:function(e){e.toUpperCase()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"tolowercase",description:"To lowercase",bindKey:o("Ctrl-Shift-U","Ctrl-Shift-U"),exec:function(e){e.toLowerCase()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"autoindent",description:"Auto Indent",bindKey:o(null,null),exec:function(e){e.autoIndent()},multiSelectAction:"forEachLine",scrollIntoView:"animate"},{name:"expandtoline",description:"Expand to line",bindKey:o("Ctrl-Shift-L","Command-Shift-L"),exec:function(e){var t=e.selection.getRange();t.start.column=t.end.column=0,t.end.row++,e.selection.setRange(t,!1)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"joinlines",description:"Join lines",bindKey:o(null,null),exec:function(e){var t=e.selection.isBackwards(),n=t?e.selection.getSelectionLead():e.selection.getSelectionAnchor(),i=t?e.selection.getSelectionAnchor():e.selection.getSelectionLead(),o=e.session.doc.getLine(n.row).length,u=e.session.doc.getTextRange(e.selection.getRange()),a=u.replace(/\n\s*/," ").length,f=e.session.doc.getLine(n.row);for(var l=n.row+1;l<=i.row+1;l++){var c=r.stringTrimLeft(r.stringTrimRight(e.session.doc.getLine(l)));c.length!==0&&(c=" "+c),f+=c}i.row+10?(e.selection.moveCursorTo(n.row,n.column),e.selection.selectTo(n.row,n.column+a)):(o=e.session.doc.getLine(n.row).length>o?o+1:o,e.selection.moveCursorTo(n.row,o))},multiSelectAction:"forEach",readOnly:!0},{name:"invertSelection",description:"Invert selection",bindKey:o(null,null),exec:function(e){var t=e.session.doc.getLength()-1,n=e.session.doc.getLine(t).length,r=e.selection.rangeList.ranges,i=[];r.length<1&&(r=[e.selection.getRange()]);for(var o=0;o=i.lastRow||r.end.row<=i.firstRow)&&this.renderer.scrollSelectionIntoView(this.selection.anchor,this.selection.lead);break;default:}n=="animate"&&this.renderer.animateScrolling(this.curOp.scrollTop)}var s=this.selection.toJSON();this.curOp.selectionAfter=s,this.$lastSel=this.selection.toJSON(),this.session.getUndoManager().addSelection(s),this.prevOp=this.curOp,this.curOp=null}},this.$mergeableCommands=["backspace","del","insertstring"],this.$historyTracker=function(e){if(!this.$mergeUndoDeltas)return;var t=this.prevOp,n=this.$mergeableCommands,r=t.command&&e.command.name==t.command.name;if(e.command.name=="insertstring"){var i=e.args;this.mergeNextCommand===undefined&&(this.mergeNextCommand=!0),r=r&&this.mergeNextCommand&&(!/\s/.test(i)||/\s/.test(t.args)),this.mergeNextCommand=!0}else r=r&&n.indexOf(e.command.name)!==-1;this.$mergeUndoDeltas!="always"&&Date.now()-this.sequenceStartTime>2e3&&(r=!1),r?this.session.mergeUndoDeltas=!0:n.indexOf(e.command.name)!==-1&&(this.sequenceStartTime=Date.now())},this.setKeyboardHandler=function(e,t){if(e&&typeof e=="string"&&e!="ace"){this.$keybindingId=e;var n=this;g.loadModule(["keybinding",e],function(r){n.$keybindingId==e&&n.keyBinding.setKeyboardHandler(r&&r.handler),t&&t()})}else this.$keybindingId=null,this.keyBinding.setKeyboardHandler(e),t&&t()},this.getKeyboardHandler=function(){return this.keyBinding.getKeyboardHandler()},this.setSession=function(e){if(this.session==e)return;this.curOp&&this.endOperation(),this.curOp={};var t=this.session;if(t){this.session.off("change",this.$onDocumentChange),this.session.off("changeMode",this.$onChangeMode),this.session.off("tokenizerUpdate",this.$onTokenizerUpdate),this.session.off("changeTabSize",this.$onChangeTabSize),this.session.off("changeWrapLimit",this.$onChangeWrapLimit),this.session.off("changeWrapMode",this.$onChangeWrapMode),this.session.off("changeFold",this.$onChangeFold),this.session.off("changeFrontMarker",this.$onChangeFrontMarker),this.session.off("changeBackMarker",this.$onChangeBackMarker),this.session.off("changeBreakpoint",this.$onChangeBreakpoint),this.session.off("changeAnnotation",this.$onChangeAnnotation),this.session.off("changeOverwrite",this.$onCursorChange),this.session.off("changeScrollTop",this.$onScrollTopChange),this.session.off("changeScrollLeft",this.$onScrollLeftChange);var n=this.session.getSelection();n.off("changeCursor",this.$onCursorChange),n.off("changeSelection",this.$onSelectionChange)}this.session=e,e?(this.$onDocumentChange=this.onDocumentChange.bind(this),e.on("change",this.$onDocumentChange),this.renderer.setSession(e),this.$onChangeMode=this.onChangeMode.bind(this),e.on("changeMode",this.$onChangeMode),this.$onTokenizerUpdate=this.onTokenizerUpdate.bind(this),e.on("tokenizerUpdate",this.$onTokenizerUpdate),this.$onChangeTabSize=this.renderer.onChangeTabSize.bind(this.renderer),e.on("changeTabSize",this.$onChangeTabSize),this.$onChangeWrapLimit=this.onChangeWrapLimit.bind(this),e.on("changeWrapLimit",this.$onChangeWrapLimit),this.$onChangeWrapMode=this.onChangeWrapMode.bind(this),e.on("changeWrapMode",this.$onChangeWrapMode),this.$onChangeFold=this.onChangeFold.bind(this),e.on("changeFold",this.$onChangeFold),this.$onChangeFrontMarker=this.onChangeFrontMarker.bind(this),this.session.on("changeFrontMarker",this.$onChangeFrontMarker),this.$onChangeBackMarker=this.onChangeBackMarker.bind(this),this.session.on("changeBackMarker",this.$onChangeBackMarker),this.$onChangeBreakpoint=this.onChangeBreakpoint.bind(this),this.session.on("changeBreakpoint",this.$onChangeBreakpoint),this.$onChangeAnnotation=this.onChangeAnnotation.bind(this),this.session.on("changeAnnotation",this.$onChangeAnnotation),this.$onCursorChange=this.onCursorChange.bind(this),this.session.on("changeOverwrite",this.$onCursorChange),this.$onScrollTopChange=this.onScrollTopChange.bind(this),this.session.on("changeScrollTop",this.$onScrollTopChange),this.$onScrollLeftChange=this.onScrollLeftChange.bind(this),this.session.on("changeScrollLeft",this.$onScrollLeftChange),this.selection=e.getSelection(),this.selection.on("changeCursor",this.$onCursorChange),this.$onSelectionChange=this.onSelectionChange.bind(this),this.selection.on("changeSelection",this.$onSelectionChange),this.onChangeMode(),this.onCursorChange(),this.onScrollTopChange(),this.onScrollLeftChange(),this.onSelectionChange(),this.onChangeFrontMarker(),this.onChangeBackMarker(),this.onChangeBreakpoint(),this.onChangeAnnotation(),this.session.getUseWrapMode()&&this.renderer.adjustWrapLimit(),this.renderer.updateFull()):(this.selection=null,this.renderer.setSession(e)),this._signal("changeSession",{session:e,oldSession:t}),this.curOp=null,t&&t._signal("changeEditor",{oldEditor:this}),e&&e._signal("changeEditor",{editor:this}),e&&e.bgTokenizer&&e.bgTokenizer.scheduleStart()},this.getSession=function(){return this.session},this.setValue=function(e,t){return this.session.doc.setValue(e),t?t==1?this.navigateFileEnd():t==-1&&this.navigateFileStart():this.selectAll(),e},this.getValue=function(){return this.session.getValue()},this.getSelection=function(){return this.selection},this.resize=function(e){this.renderer.onResize(e)},this.setTheme=function(e,t){this.renderer.setTheme(e,t)},this.getTheme=function(){return this.renderer.getTheme()},this.setStyle=function(e){this.renderer.setStyle(e)},this.unsetStyle=function(e){this.renderer.unsetStyle(e)},this.getFontSize=function(){return this.getOption("fontSize")||i.computedStyle(this.container).fontSize},this.setFontSize=function(e){this.setOption("fontSize",e)},this.$highlightBrackets=function(){if(this.$highlightPending)return;var e=this;this.$highlightPending=!0,setTimeout(function(){e.$highlightPending=!1;var t=e.session;if(!t||!t.bgTokenizer)return;t.$bracketHighlight&&(t.$bracketHighlight.markerIds.forEach(function(e){t.removeMarker(e)}),t.$bracketHighlight=null);var n=t.getMatchingBracketRanges(e.getCursorPosition());!n&&t.$mode.getMatching&&(n=t.$mode.getMatching(e.session));if(!n)return;var r="ace_bracket";Array.isArray(n)?n.length==1&&(r="ace_error_bracket"):n=[n],n.length==2&&(p.comparePoints(n[0].end,n[1].start)==0?n=[p.fromPoints(n[0].start,n[1].end)]:p.comparePoints(n[0].start,n[1].end)==0&&(n=[p.fromPoints(n[1].start,n[0].end)])),t.$bracketHighlight={ranges:n,markerIds:n.map(function(e){return t.addMarker(e,r,"text")})}},50)},this.$highlightTags=function(){if(this.$highlightTagPending)return;var e=this;this.$highlightTagPending=!0,setTimeout(function(){e.$highlightTagPending=!1;var t=e.session;if(!t||!t.bgTokenizer)return;var n=e.getCursorPosition(),r=new y(e.session,n.row,n.column),i=r.getCurrentToken();if(!i||!/\b(?:tag-open|tag-name)/.test(i.type)){t.removeMarker(t.$tagHighlight),t.$tagHighlight=null;return}if(i.type.indexOf("tag-open")!=-1){i=r.stepForward();if(!i)return}var s=i.value,o=0,u=r.stepBackward();if(u.value=="<"){do u=i,i=r.stepForward(),i&&i.value===s&&i.type.indexOf("tag-name")!==-1&&(u.value==="<"?o++:u.value==="=0)}else{do i=u,u=r.stepBackward(),i&&i.value===s&&i.type.indexOf("tag-name")!==-1&&(u.value==="<"?o++:u.value==="1)&&(t=!1)}if(e.$highlightLineMarker&&!t)e.removeMarker(e.$highlightLineMarker.id),e.$highlightLineMarker=null;else if(!e.$highlightLineMarker&&t){var n=new p(t.row,t.column,t.row,Infinity);n.id=e.addMarker(n,"ace_active-line","screenLine"),e.$highlightLineMarker=n}else t&&(e.$highlightLineMarker.start.row=t.row,e.$highlightLineMarker.end.row=t.row,e.$highlightLineMarker.start.column=t.column,e._signal("changeBackMarker"))},this.onSelectionChange=function(e){var t=this.session;t.$selectionMarker&&t.removeMarker(t.$selectionMarker),t.$selectionMarker=null;if(!this.selection.isEmpty()){var n=this.selection.getRange(),r=this.getSelectionStyle();t.$selectionMarker=t.addMarker(n,"ace_selection",r)}else this.$updateHighlightActiveLine();var i=this.$highlightSelectedWord&&this.$getSelectionHighLightRegexp();this.session.highlight(i),this._signal("changeSelection")},this.$getSelectionHighLightRegexp=function(){var e=this.session,t=this.getSelectionRange();if(t.isEmpty()||t.isMultiLine())return;var n=t.start.column,r=t.end.column,i=e.getLine(t.start.row),s=i.substring(n,r);if(s.length>5e3||!/[\w\d]/.test(s))return;var o=this.$search.$assembleRegExp({wholeWord:!0,caseSensitive:!0,needle:s}),u=i.substring(n-1,r+1);if(!o.test(u))return;return o},this.onChangeFrontMarker=function(){this.renderer.updateFrontMarkers()},this.onChangeBackMarker=function(){this.renderer.updateBackMarkers()},this.onChangeBreakpoint=function(){this.renderer.updateBreakpoints()},this.onChangeAnnotation=function(){this.renderer.setAnnotations(this.session.getAnnotations())},this.onChangeMode=function(e){this.renderer.updateText(),this._emit("changeMode",e)},this.onChangeWrapLimit=function(){this.renderer.updateFull()},this.onChangeWrapMode=function(){this.renderer.onResize(!0)},this.onChangeFold=function(){this.$updateHighlightActiveLine(),this.renderer.updateFull()},this.getSelectedText=function(){return this.session.getTextRange(this.getSelectionRange())},this.getCopyText=function(){var e=this.getSelectedText(),t=this.session.doc.getNewLineCharacter(),n=!1;if(!e&&this.$copyWithEmptySelection){n=!0;var r=this.selection.getAllRanges();for(var i=0;iu.search(/\S|$/)){var a=u.substr(i.column).search(/\S|$/);n.doc.removeInLine(i.row,i.column,i.column+a)}}this.clearSelection();var f=i.column,l=n.getState(i.row),u=n.getLine(i.row),c=r.checkOutdent(l,u,e);n.insert(i,e),s&&s.selection&&(s.selection.length==2?this.selection.setSelectionRange(new p(i.row,f+s.selection[0],i.row,f+s.selection[1])):this.selection.setSelectionRange(new p(i.row+s.selection[0],s.selection[1],i.row+s.selection[2],s.selection[3])));if(this.$enableAutoIndent){if(n.getDocument().isNewLine(e)){var h=r.getNextLineIndent(l,u.slice(0,i.column),n.getTabString());n.insert({row:i.row+1,column:0},h)}c&&r.autoOutdent(l,n,i.row)}},this.autoIndent=function(){var e=this.session,t=e.getMode(),n,r;if(this.selection.isEmpty())n=0,r=e.doc.getLength()-1;else{var i=this.getSelectionRange();n=i.start.row,r=i.end.row}var s="",o="",u="",a,f,l,c=e.getTabString();for(var h=n;h<=r;h++)h>0&&(s=e.getState(h-1),o=e.getLine(h-1),u=t.getNextLineIndent(s,o,c)),a=e.getLine(h),f=t.$getIndent(a),u!==f&&(f.length>0&&(l=new p(h,0,h,f.length),e.remove(l)),u.length>0&&e.insert({row:h,column:0},u)),t.autoOutdent(s,e,h)},this.onTextInput=function(e,t){if(!t)return this.keyBinding.onTextInput(e);this.startOperation({command:{name:"insertstring"}});var n=this.applyComposition.bind(this,e,t);this.selection.rangeCount?this.forEachSelection(n):n(),this.endOperation()},this.applyComposition=function(e,t){if(t.extendLeft||t.extendRight){var n=this.selection.getRange();n.start.column-=t.extendLeft,n.end.column+=t.extendRight,n.start.column<0&&(n.start.row--,n.start.column+=this.session.getLine(n.start.row).length+1),this.selection.setRange(n),!e&&!n.isEmpty()&&this.remove()}(e||!this.selection.isEmpty())&&this.insert(e,!0);if(t.restoreStart||t.restoreEnd){var n=this.selection.getRange();n.start.column-=t.restoreStart,n.end.column-=t.restoreEnd,this.selection.setRange(n)}},this.onCommandKey=function(e,t,n){return this.keyBinding.onCommandKey(e,t,n)},this.setOverwrite=function(e){this.session.setOverwrite(e)},this.getOverwrite=function(){return this.session.getOverwrite()},this.toggleOverwrite=function(){this.session.toggleOverwrite()},this.setScrollSpeed=function(e){this.setOption("scrollSpeed",e)},this.getScrollSpeed=function(){return this.getOption("scrollSpeed")},this.setDragDelay=function(e){this.setOption("dragDelay",e)},this.getDragDelay=function(){return this.getOption("dragDelay")},this.setSelectionStyle=function(e){this.setOption("selectionStyle",e)},this.getSelectionStyle=function(){return this.getOption("selectionStyle")},this.setHighlightActiveLine=function(e){this.setOption("highlightActiveLine",e)},this.getHighlightActiveLine=function(){return this.getOption("highlightActiveLine")},this.setHighlightGutterLine=function(e){this.setOption("highlightGutterLine",e)},this.getHighlightGutterLine=function(){return this.getOption("highlightGutterLine")},this.setHighlightSelectedWord=function(e){this.setOption("highlightSelectedWord",e)},this.getHighlightSelectedWord=function(){return this.$highlightSelectedWord},this.setAnimatedScroll=function(e){this.renderer.setAnimatedScroll(e)},this.getAnimatedScroll=function(){return this.renderer.getAnimatedScroll()},this.setShowInvisibles=function(e){this.renderer.setShowInvisibles(e)},this.getShowInvisibles=function(){return this.renderer.getShowInvisibles()},this.setDisplayIndentGuides=function(e){this.renderer.setDisplayIndentGuides(e)},this.getDisplayIndentGuides=function(){return this.renderer.getDisplayIndentGuides()},this.setShowPrintMargin=function(e){this.renderer.setShowPrintMargin(e)},this.getShowPrintMargin=function(){return this.renderer.getShowPrintMargin()},this.setPrintMarginColumn=function(e){this.renderer.setPrintMarginColumn(e)},this.getPrintMarginColumn=function(){return this.renderer.getPrintMarginColumn()},this.setReadOnly=function(e){this.setOption("readOnly",e)},this.getReadOnly=function(){return this.getOption("readOnly")},this.setBehavioursEnabled=function(e){this.setOption("behavioursEnabled",e)},this.getBehavioursEnabled=function(){return this.getOption("behavioursEnabled")},this.setWrapBehavioursEnabled=function(e){this.setOption("wrapBehavioursEnabled",e)},this.getWrapBehavioursEnabled=function(){return this.getOption("wrapBehavioursEnabled")},this.setShowFoldWidgets=function(e){this.setOption("showFoldWidgets",e)},this.getShowFoldWidgets=function(){return this.getOption("showFoldWidgets")},this.setFadeFoldWidgets=function(e){this.setOption("fadeFoldWidgets",e)},this.getFadeFoldWidgets=function(){return this.getOption("fadeFoldWidgets")},this.remove=function(e){this.selection.isEmpty()&&(e=="left"?this.selection.selectLeft():this.selection.selectRight());var t=this.getSelectionRange();if(this.getBehavioursEnabled()){var n=this.session,r=n.getState(t.start.row),i=n.getMode().transformAction(r,"deletion",this,n,t);if(t.end.column===0){var s=n.getTextRange(t);if(s[s.length-1]=="\n"){var o=n.getLine(t.end.row);/^\s+$/.test(o)&&(t.end.column=o.length)}}i&&(t=i)}this.session.remove(t),this.clearSelection()},this.removeWordRight=function(){this.selection.isEmpty()&&this.selection.selectWordRight(),this.session.remove(this.getSelectionRange()),this.clearSelection()},this.removeWordLeft=function(){this.selection.isEmpty()&&this.selection.selectWordLeft(),this.session.remove(this.getSelectionRange()),this.clearSelection()},this.removeToLineStart=function(){this.selection.isEmpty()&&this.selection.selectLineStart(),this.selection.isEmpty()&&this.selection.selectLeft(),this.session.remove(this.getSelectionRange()),this.clearSelection()},this.removeToLineEnd=function(){this.selection.isEmpty()&&this.selection.selectLineEnd();var e=this.getSelectionRange();e.start.column==e.end.column&&e.start.row==e.end.row&&(e.end.column=0,e.end.row++),this.session.remove(e),this.clearSelection()},this.splitLine=function(){this.selection.isEmpty()||(this.session.remove(this.getSelectionRange()),this.clearSelection());var e=this.getCursorPosition();this.insert("\n"),this.moveCursorToPosition(e)},this.transposeLetters=function(){if(!this.selection.isEmpty())return;var e=this.getCursorPosition(),t=e.column;if(t===0)return;var n=this.session.getLine(e.row),r,i;tt.toLowerCase()?1:0});var i=new p(0,0,0,0);for(var r=e.first;r<=e.last;r++){var s=t.getLine(r);i.start.row=r,i.end.row=r,i.end.column=s.length,t.replace(i,n[r-e.first])}},this.toggleCommentLines=function(){var e=this.session.getState(this.getCursorPosition().row),t=this.$getSelectedRows();this.session.getMode().toggleCommentLines(e,this.session,t.first,t.last)},this.toggleBlockComment=function(){var e=this.getCursorPosition(),t=this.session.getState(e.row),n=this.getSelectionRange();this.session.getMode().toggleBlockComment(t,this.session,n,e)},this.getNumberAt=function(e,t){var n=/[\-]?[0-9]+(?:\.[0-9]+)?/g;n.lastIndex=0;var r=this.session.getLine(e);while(n.lastIndex=t){var s={value:i[0],start:i.index,end:i.index+i[0].length};return s}}return null},this.modifyNumber=function(e){var t=this.selection.getCursor().row,n=this.selection.getCursor().column,r=new p(t,n-1,t,n),i=this.session.getTextRange(r);if(!isNaN(parseFloat(i))&&isFinite(i)){var s=this.getNumberAt(t,n);if(s){var o=s.value.indexOf(".")>=0?s.start+s.value.indexOf(".")+1:s.end,u=s.start+s.value.length-o,a=parseFloat(s.value);a*=Math.pow(10,u),o!==s.end&&n=u&&o<=a&&(n=t,f.selection.clearSelection(),f.moveCursorTo(e,u+r),f.selection.selectTo(e,a+r)),u=a});var l=this.$toggleWordPairs,c;for(var h=0;hp+1)break;p=d.last}l--,u=this.session.$moveLines(h,p,t?0:e),t&&e==-1&&(c=l+1);while(c<=l)o[c].moveBy(u,0),c++;t||(u=0),a+=u}i.fromOrientedRange(i.ranges[0]),i.rangeList.attach(this.session),this.inVirtualSelectionMode=!1}},this.$getSelectedRows=function(e){return e=(e||this.getSelectionRange()).collapseRows(),{first:this.session.getRowFoldStart(e.start.row),last:this.session.getRowFoldEnd(e.end.row)}},this.onCompositionStart=function(e){this.renderer.showComposition(e)},this.onCompositionUpdate=function(e){this.renderer.setCompositionText(e)},this.onCompositionEnd=function(){this.renderer.hideComposition()},this.getFirstVisibleRow=function(){return this.renderer.getFirstVisibleRow()},this.getLastVisibleRow=function(){return this.renderer.getLastVisibleRow()},this.isRowVisible=function(e){return e>=this.getFirstVisibleRow()&&e<=this.getLastVisibleRow()},this.isRowFullyVisible=function(e){return e>=this.renderer.getFirstFullyVisibleRow()&&e<=this.renderer.getLastFullyVisibleRow()},this.$getVisibleRowCount=function(){return this.renderer.getScrollBottomRow()-this.renderer.getScrollTopRow()+1},this.$moveByPage=function(e,t){var n=this.renderer,r=this.renderer.layerConfig,i=e*Math.floor(r.height/r.lineHeight);t===!0?this.selection.$moveSelection(function(){this.moveCursorBy(i,0)}):t===!1&&(this.selection.moveCursorBy(i,0),this.selection.clearSelection());var s=n.scrollTop;n.scrollBy(0,i*r.lineHeight),t!=null&&n.scrollCursorIntoView(null,.5),n.animateScrolling(s)},this.selectPageDown=function(){this.$moveByPage(1,!0)},this.selectPageUp=function(){this.$moveByPage(-1,!0)},this.gotoPageDown=function(){this.$moveByPage(1,!1)},this.gotoPageUp=function(){this.$moveByPage(-1,!1)},this.scrollPageDown=function(){this.$moveByPage(1)},this.scrollPageUp=function(){this.$moveByPage(-1)},this.scrollToRow=function(e){this.renderer.scrollToRow(e)},this.scrollToLine=function(e,t,n,r){this.renderer.scrollToLine(e,t,n,r)},this.centerSelection=function(){var e=this.getSelectionRange(),t={row:Math.floor(e.start.row+(e.end.row-e.start.row)/2),column:Math.floor(e.start.column+(e.end.column-e.start.column)/2)};this.renderer.alignCursor(t,.5)},this.getCursorPosition=function(){return this.selection.getCursor()},this.getCursorPositionScreen=function(){return this.session.documentToScreenPosition(this.getCursorPosition())},this.getSelectionRange=function(){return this.selection.getRange()},this.selectAll=function(){this.selection.selectAll()},this.clearSelection=function(){this.selection.clearSelection()},this.moveCursorTo=function(e,t){this.selection.moveCursorTo(e,t)},this.moveCursorToPosition=function(e){this.selection.moveCursorToPosition(e)},this.jumpToMatching=function(e,t){var n=this.getCursorPosition(),r=new y(this.session,n.row,n.column),i=r.getCurrentToken(),s=i||r.stepForward();if(!s)return;var o,u=!1,a={},f=n.column-s.start,l,c={")":"(","(":"(","]":"[","[":"[","{":"{","}":"{"};do{if(s.value.match(/[{}()\[\]]/g))for(;f=0;--s)this.$tryReplace(n[s],e)&&r++;return this.selection.setSelectionRange(i),r},this.$tryReplace=function(e,t){var n=this.session.getTextRange(e);return t=this.$search.replace(n,t),t!==null?(e.end=this.session.replace(e,t),e):null},this.getLastSearchOptions=function(){return this.$search.getOptions()},this.find=function(e,t,n){t||(t={}),typeof e=="string"||e instanceof RegExp?t.needle=e:typeof e=="object"&&r.mixin(t,e);var i=this.selection.getRange();t.needle==null&&(e=this.session.getTextRange(i)||this.$search.$options.needle,e||(i=this.session.getWordRange(i.start.row,i.start.column),e=this.session.getTextRange(i)),this.$search.set({needle:e})),this.$search.set(t),t.start||this.$search.set({start:i});var s=this.$search.find(this.session);if(t.preventScroll)return s;if(s)return this.revealRange(s,n),s;t.backwards?i.start=i.end:i.end=i.start,this.selection.setRange(i)},this.findNext=function(e,t){this.find({skipCurrent:!0,backwards:!1},e,t)},this.findPrevious=function(e,t){this.find(e,{skipCurrent:!0,backwards:!0},t)},this.revealRange=function(e,t){this.session.unfold(e),this.selection.setSelectionRange(e);var n=this.renderer.scrollTop;this.renderer.scrollSelectionIntoView(e.start,e.end,.5),t!==!1&&this.renderer.animateScrolling(n)},this.undo=function(){this.session.getUndoManager().undo(this.session),this.renderer.scrollCursorIntoView(null,.5)},this.redo=function(){this.session.getUndoManager().redo(this.session),this.renderer.scrollCursorIntoView(null,.5)},this.destroy=function(){this.$toDestroy&&(this.$toDestroy.forEach(function(e){e.destroy()}),this.$toDestroy=null),this.renderer.destroy(),this._signal("destroy",this),this.session&&this.session.destroy(),this._$emitInputEvent&&this._$emitInputEvent.cancel(),this.removeAllListeners()},this.setAutoScrollEditorIntoView=function(e){if(!e)return;var t,n=this,r=!1;this.$scrollAnchor||(this.$scrollAnchor=document.createElement("div"));var i=this.$scrollAnchor;i.style.cssText="position:absolute",this.container.insertBefore(i,this.container.firstChild);var s=this.on("changeSelection",function(){r=!0}),o=this.renderer.on("beforeRender",function(){r&&(t=n.renderer.container.getBoundingClientRect())}),u=this.renderer.on("afterRender",function(){if(r&&t&&(n.isFocused()||n.searchBox&&n.searchBox.isFocused())){var e=n.renderer,s=e.$cursorLayer.$pixelPos,o=e.layerConfig,u=s.top-o.offset;s.top>=0&&u+t.top<0?r=!0:s.topwindow.innerHeight?r=!1:r=null,r!=null&&(i.style.top=u+"px",i.style.left=s.left+"px",i.style.height=o.lineHeight+"px",i.scrollIntoView(r)),r=t=null}});this.setAutoScrollEditorIntoView=function(e){if(e)return;delete this.setAutoScrollEditorIntoView,this.off("changeSelection",s),this.renderer.off("afterRender",u),this.renderer.off("beforeRender",o)}},this.$resetCursorStyle=function(){var e=this.$cursorStyle||"ace",t=this.renderer.$cursorLayer;if(!t)return;t.setSmoothBlinking(/smooth/.test(e)),t.isBlinking=!this.$readOnly&&e!="wide",i.setCssClass(t.element,"ace_slim-cursors",/slim/.test(e))},this.prompt=function(e,t,n){var r=this;g.loadModule("./ext/prompt",function(i){i.prompt(r,e,t,n)})}}.call(w.prototype),g.defineOptions(w.prototype,"editor",{selectionStyle:{set:function(e){this.onSelectionChange(),this._signal("changeSelectionStyle",{data:e})},initialValue:"line"},highlightActiveLine:{set:function(){this.$updateHighlightActiveLine()},initialValue:!0},highlightSelectedWord:{set:function(e){this.$onSelectionChange()},initialValue:!0},readOnly:{set:function(e){this.textInput.setReadOnly(e),this.$resetCursorStyle()},initialValue:!1},copyWithEmptySelection:{set:function(e){this.textInput.setCopyWithEmptySelection(e)},initialValue:!1},cursorStyle:{set:function(e){this.$resetCursorStyle()},values:["ace","slim","smooth","wide"],initialValue:"ace"},mergeUndoDeltas:{values:[!1,!0,"always"],initialValue:!0},behavioursEnabled:{initialValue:!0},wrapBehavioursEnabled:{initialValue:!0},enableAutoIndent:{initialValue:!0},autoScrollEditorIntoView:{set:function(e){this.setAutoScrollEditorIntoView(e)}},keyboardHandler:{set:function(e){this.setKeyboardHandler(e)},get:function(){return this.$keybindingId},handlesSet:!0},value:{set:function(e){this.session.setValue(e)},get:function(){return this.getValue()},handlesSet:!0,hidden:!0},session:{set:function(e){this.setSession(e)},get:function(){return this.session},handlesSet:!0,hidden:!0},showLineNumbers:{set:function(e){this.renderer.$gutterLayer.setShowLineNumbers(e),this.renderer.$loop.schedule(this.renderer.CHANGE_GUTTER),e&&this.$relativeLineNumbers?E.attach(this):E.detach(this)},initialValue:!0},relativeLineNumbers:{set:function(e){this.$showLineNumbers&&e?E.attach(this):E.detach(this)}},placeholder:{set:function(e){this.$updatePlaceholder||(this.$updatePlaceholder=function(){var e=this.session&&(this.renderer.$composition||this.getValue());if(e&&this.renderer.placeholderNode)this.renderer.off("afterRender",this.$updatePlaceholder),i.removeCssClass(this.container,"ace_hasPlaceholder"),this.renderer.placeholderNode.remove(),this.renderer.placeholderNode=null;else if(!e&&!this.renderer.placeholderNode){this.renderer.on("afterRender",this.$updatePlaceholder),i.addCssClass(this.container,"ace_hasPlaceholder");var t=i.createElement("div");t.className="ace_placeholder",t.textContent=this.$placeholder||"",this.renderer.placeholderNode=t,this.renderer.content.appendChild(this.renderer.placeholderNode)}else!e&&this.renderer.placeholderNode&&(this.renderer.placeholderNode.textContent=this.$placeholder||"")}.bind(this),this.on("input",this.$updatePlaceholder)),this.$updatePlaceholder()}},hScrollBarAlwaysVisible:"renderer",vScrollBarAlwaysVisible:"renderer",highlightGutterLine:"renderer",animatedScroll:"renderer",showInvisibles:"renderer",showPrintMargin:"renderer",printMarginColumn:"renderer",printMargin:"renderer",fadeFoldWidgets:"renderer",showFoldWidgets:"renderer",displayIndentGuides:"renderer",showGutter:"renderer",fontSize:"renderer",fontFamily:"renderer",maxLines:"renderer",minLines:"renderer",scrollPastEnd:"renderer",fixedWidthGutter:"renderer",theme:"renderer",hasCssTransforms:"renderer",maxPixelHeight:"renderer",useTextareaForIME:"renderer",scrollSpeed:"$mouseHandler",dragDelay:"$mouseHandler",dragEnabled:"$mouseHandler",focusTimeout:"$mouseHandler",tooltipFollowsMouse:"$mouseHandler",firstLineNumber:"session",overwrite:"session",newLineMode:"session",useWorker:"session",useSoftTabs:"session",navigateWithinSoftTabs:"session",tabSize:"session",wrap:"session",indentedSoftWrap:"session",foldStyle:"session",mode:"session"});var E={getText:function(e,t){return(Math.abs(e.selection.lead.row-t)||t+1+(t<9?"\u00b7":""))+""},getWidth:function(e,t,n){return Math.max(t.toString().length,(n.lastRow+1).toString().length,2)*n.characterWidth},update:function(e,t){t.renderer.$loop.schedule(t.renderer.CHANGE_GUTTER)},attach:function(e){e.renderer.$gutterLayer.$renderer=this,e.on("changeSelection",this.update),this.update(null,e)},detach:function(e){e.renderer.$gutterLayer.$renderer==this&&(e.renderer.$gutterLayer.$renderer=null),e.off("changeSelection",this.update),this.update(null,e)}};t.Editor=w}),define("ace/undomanager",["require","exports","module","ace/range"],function(e,t,n){"use strict";function i(e,t){for(var n=t;n--;){var r=e[n];if(r&&!r[0].ignore){while(n0){a.row+=i,a.column+=a.row==r.row?s:0;continue}!t&&l<=0&&(a.row=n.row,a.column=n.column,l===0&&(a.bias=1))}}function f(e){return{row:e.row,column:e.column}}function l(e){return{start:f(e.start),end:f(e.end),action:e.action,lines:e.lines.slice()}}function c(e){e=e||this;if(Array.isArray(e))return e.map(c).join("\n");var t="";e.action?(t=e.action=="insert"?"+":"-",t+="["+e.lines+"]"):e.value&&(Array.isArray(e.value)?t=e.value.map(h).join("\n"):t=h(e.value)),e.start&&(t+=h(e));if(e.id||e.rev)t+=" ("+(e.id||e.rev)+")";return t}function h(e){return e.start.row+":"+e.start.column+"=>"+e.end.row+":"+e.end.column}function p(e,t){var n=e.action=="insert",r=t.action=="insert";if(n&&r)if(o(t.start,e.end)>=0)m(t,e,-1);else{if(!(o(t.start,e.start)<=0))return null;m(e,t,1)}else if(n&&!r)if(o(t.start,e.end)>=0)m(t,e,-1);else{if(!(o(t.end,e.start)<=0))return null;m(e,t,-1)}else if(!n&&r)if(o(t.start,e.start)>=0)m(t,e,1);else{if(!(o(t.start,e.start)<=0))return null;m(e,t,1)}else if(!n&&!r)if(o(t.start,e.start)>=0)m(t,e,1);else{if(!(o(t.end,e.start)<=0))return null;m(e,t,-1)}return[t,e]}function d(e,t){for(var n=e.length;n--;)for(var r=0;r=0?m(e,t,-1):o(e.start,t.start)<=0?m(t,e,1):(m(e,s.fromPoints(t.start,e.start),-1),m(t,e,1));else if(!n&&r)o(t.start,e.end)>=0?m(t,e,-1):o(t.start,e.start)<=0?m(e,t,1):(m(t,s.fromPoints(e.start,t.start),-1),m(e,t,1));else if(!n&&!r)if(o(t.start,e.end)>=0)m(t,e,-1);else{if(!(o(t.end,e.start)<=0)){var i,u;return o(e.start,t.start)<0&&(i=e,e=y(e,t.start)),o(e.end,t.end)>0&&(u=y(e,t.end)),g(t.end,e.start,e.end,-1),u&&!i&&(e.lines=u.lines,e.start=u.start,e.end=u.end,u=e),[t,i,u].filter(Boolean)}m(e,t,-1)}return[t,e]}function m(e,t,n){g(e.start,t.start,t.end,n),g(e.end,t.start,t.end,n)}function g(e,t,n,r){e.row==(r==1?t:n).row&&(e.column+=r*(n.column-t.column)),e.row+=r*(n.row-t.row)}function y(e,t){var n=e.lines,r=e.end;e.end=f(t);var i=e.end.row-e.start.row,s=n.splice(i,n.length),o=i?t.column:t.column-e.start.column;n.push(s[0].substring(0,o)),s[0]=s[0].substr(o);var u={start:f(t),end:r,lines:s,action:e.action};return u}function b(e,t){t=l(t);for(var n=e.length;n--;){var r=e[n];for(var i=0;i0},this.canRedo=function(){return this.$redoStack.length>0},this.bookmark=function(e){e==undefined&&(e=this.$rev),this.mark=e},this.isAtBookmark=function(){return this.$rev===this.mark},this.toJSON=function(){},this.fromJSON=function(){},this.hasUndo=this.canUndo,this.hasRedo=this.canRedo,this.isClean=this.isAtBookmark,this.markClean=this.bookmark,this.$prettyPrint=function(e){return e?c(e):c(this.$undoStack)+"\n---\n"+c(this.$redoStack)}}).call(r.prototype);var s=e("./range").Range,o=s.comparePoints,u=s.comparePoints;t.UndoManager=r}),define("ace/layer/lines",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../lib/dom"),i=function(e,t){this.element=e,this.canvasHeight=t||5e5,this.element.style.height=this.canvasHeight*2+"px",this.cells=[],this.cellCache=[],this.$offsetCoefficient=0};(function(){this.moveContainer=function(e){r.translate(this.element,0,-(e.firstRowScreen*e.lineHeight%this.canvasHeight)-e.offset*this.$offsetCoefficient)},this.pageChanged=function(e,t){return Math.floor(e.firstRowScreen*e.lineHeight/this.canvasHeight)!==Math.floor(t.firstRowScreen*t.lineHeight/this.canvasHeight)},this.computeLineTop=function(e,t,n){var r=t.firstRowScreen*t.lineHeight,i=Math.floor(r/this.canvasHeight),s=n.documentToScreenRow(e,0)*t.lineHeight;return s-i*this.canvasHeight},this.computeLineHeight=function(e,t,n){return t.lineHeight*n.getRowLineCount(e)},this.getLength=function(){return this.cells.length},this.get=function(e){return this.cells[e]},this.shift=function(){this.$cacheCell(this.cells.shift())},this.pop=function(){this.$cacheCell(this.cells.pop())},this.push=function(e){if(Array.isArray(e)){this.cells.push.apply(this.cells,e);var t=r.createFragment(this.element);for(var n=0;ns&&(a=i.end.row+1,i=t.getNextFoldLine(a,i),s=i?i.start.row:Infinity);if(a>r){while(this.$lines.getLength()>u+1)this.$lines.pop();break}o=this.$lines.get(++u),o?o.row=a:(o=this.$lines.createCell(a,e,this.session,f),this.$lines.push(o)),this.$renderCell(o,e,i,a),a++}this._signal("afterRender"),this.$updateGutterWidth(e)},this.$updateGutterWidth=function(e){var t=this.session,n=t.gutterRenderer||this.$renderer,r=t.$firstLineNumber,i=this.$lines.last()?this.$lines.last().text:"";if(this.$fixedWidth||t.$useWrapMode)i=t.getLength()+r-1;var s=n?n.getWidth(t,i,e):i.toString().length*e.characterWidth,o=this.$padding||this.$computePadding();s+=o.left+o.right,s!==this.gutterWidth&&!isNaN(s)&&(this.gutterWidth=s,this.element.parentNode.style.width=this.element.style.width=Math.ceil(this.gutterWidth)+"px",this._signal("changeGutterWidth",s))},this.$updateCursorRow=function(){if(!this.$highlightGutterLine)return;var e=this.session.selection.getCursor();if(this.$cursorRow===e.row)return;this.$cursorRow=e.row},this.updateLineHighlight=function(){if(!this.$highlightGutterLine)return;var e=this.session.selection.cursor.row;this.$cursorRow=e;if(this.$cursorCell&&this.$cursorCell.row==e)return;this.$cursorCell&&(this.$cursorCell.element.className=this.$cursorCell.element.className.replace("ace_gutter-active-line ",""));var t=this.$lines.cells;this.$cursorCell=null;for(var n=0;n=this.$cursorRow){if(r.row>this.$cursorRow){var i=this.session.getFoldLine(this.$cursorRow);if(!(n>0&&i&&i.start.row==t[n-1].row))break;r=t[n-1]}r.element.className="ace_gutter-active-line "+r.element.className,this.$cursorCell=r;break}}},this.scrollLines=function(e){var t=this.config;this.config=e,this.$updateCursorRow();if(this.$lines.pageChanged(t,e))return this.update(e);this.$lines.moveContainer(e);var n=Math.min(e.lastRow+e.gutterOffset,this.session.getLength()-1),r=this.oldLastRow;this.oldLastRow=n;if(!t||r0;i--)this.$lines.shift();if(r>n)for(var i=this.session.getFoldedRowCount(n+1,r);i>0;i--)this.$lines.pop();e.firstRowr&&this.$lines.push(this.$renderLines(e,r+1,n)),this.updateLineHighlight(),this._signal("afterRender"),this.$updateGutterWidth(e)},this.$renderLines=function(e,t,n){var r=[],i=t,s=this.session.getNextFoldLine(i),o=s?s.start.row:Infinity;for(;;){i>o&&(i=s.end.row+1,s=this.session.getNextFoldLine(i,s),o=s?s.start.row:Infinity);if(i>n)break;var u=this.$lines.createCell(i,e,this.session,f);this.$renderCell(u,e,s,i),r.push(u),i++}return r},this.$renderCell=function(e,t,n,i){var s=e.element,o=this.session,u=s.childNodes[0],a=s.childNodes[1],f=o.$firstLineNumber,l=o.$breakpoints,c=o.$decorations,h=o.gutterRenderer||this.$renderer,p=this.$showFoldWidgets&&o.foldWidgets,d=n?n.start.row:Number.MAX_VALUE,v="ace_gutter-cell ";this.$highlightGutterLine&&(i==this.$cursorRow||n&&i=d&&this.$cursorRow<=n.end.row)&&(v+="ace_gutter-active-line ",this.$cursorCell!=e&&(this.$cursorCell&&(this.$cursorCell.element.className=this.$cursorCell.element.className.replace("ace_gutter-active-line ","")),this.$cursorCell=e)),l[i]&&(v+=l[i]),c[i]&&(v+=c[i]),this.$annotations[i]&&(v+=this.$annotations[i].className),s.className!=v&&(s.className=v);if(p){var m=p[i];m==null&&(m=p[i]=o.getFoldWidget(i))}if(m){var v="ace_fold-widget ace_"+m;m=="start"&&i==d&&in.right-t.right)return"foldWidgets"}}).call(a.prototype),t.Gutter=a}),define("ace/layer/marker",["require","exports","module","ace/range","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../range").Range,i=e("../lib/dom"),s=function(e){this.element=i.createElement("div"),this.element.className="ace_layer ace_marker-layer",e.appendChild(this.element)};(function(){function e(e,t,n,r){return(e?1:0)|(t?2:0)|(n?4:0)|(r?8:0)}this.$padding=0,this.setPadding=function(e){this.$padding=e},this.setSession=function(e){this.session=e},this.setMarkers=function(e){this.markers=e},this.elt=function(e,t){var n=this.i!=-1&&this.element.childNodes[this.i];n?this.i++:(n=document.createElement("div"),this.element.appendChild(n),this.i=-1),n.style.cssText=t,n.className=e},this.update=function(e){if(!e)return;this.config=e,this.i=0;var t;for(var n in this.markers){var r=this.markers[n];if(!r.range){r.update(t,this,this.session,e);continue}var i=r.range.clipRows(e.firstRow,e.lastRow);if(i.isEmpty())continue;i=i.toScreenRange(this.session);if(r.renderer){var s=this.$getTop(i.start.row,e),o=this.$padding+i.start.column*e.characterWidth;r.renderer(t,i,o,s,e)}else r.type=="fullLine"?this.drawFullLineMarker(t,i,r.clazz,e):r.type=="screenLine"?this.drawScreenLineMarker(t,i,r.clazz,e):i.isMultiLine()?r.type=="text"?this.drawTextMarker(t,i,r.clazz,e):this.drawMultiLineMarker(t,i,r.clazz,e):this.drawSingleLineMarker(t,i,r.clazz+" ace_start"+" ace_br15",e)}if(this.i!=-1)while(this.ip,l==f),s,l==f?0:1,o)},this.drawMultiLineMarker=function(e,t,n,r,i){var s=this.$padding,o=r.lineHeight,u=this.$getTop(t.start.row,r),a=s+t.start.column*r.characterWidth;i=i||"";if(this.session.$bidiHandler.isBidiRow(t.start.row)){var f=t.clone();f.end.row=f.start.row,f.end.column=this.session.getLine(f.start.row).length,this.drawBidiSingleLineMarker(e,f,n+" ace_br1 ace_start",r,null,i)}else this.elt(n+" ace_br1 ace_start","height:"+o+"px;"+"right:0;"+"top:"+u+"px;left:"+a+"px;"+(i||""));if(this.session.$bidiHandler.isBidiRow(t.end.row)){var f=t.clone();f.start.row=f.end.row,f.start.column=0,this.drawBidiSingleLineMarker(e,f,n+" ace_br12",r,null,i)}else{u=this.$getTop(t.end.row,r);var l=t.end.column*r.characterWidth;this.elt(n+" ace_br12","height:"+o+"px;"+"width:"+l+"px;"+"top:"+u+"px;"+"left:"+s+"px;"+(i||""))}o=(t.end.row-t.start.row-1)*r.lineHeight;if(o<=0)return;u=this.$getTop(t.start.row+1,r);var c=(t.start.column?1:0)|(t.end.column?0:8);this.elt(n+(c?" ace_br"+c:""),"height:"+o+"px;"+"right:0;"+"top:"+u+"px;"+"left:"+s+"px;"+(i||""))},this.drawSingleLineMarker=function(e,t,n,r,i,s){if(this.session.$bidiHandler.isBidiRow(t.start.row))return this.drawBidiSingleLineMarker(e,t,n,r,i,s);var o=r.lineHeight,u=(t.end.column+(i||0)-t.start.column)*r.characterWidth,a=this.$getTop(t.start.row,r),f=this.$padding+t.start.column*r.characterWidth;this.elt(n,"height:"+o+"px;"+"width:"+u+"px;"+"top:"+a+"px;"+"left:"+f+"px;"+(s||""))},this.drawBidiSingleLineMarker=function(e,t,n,r,i,s){var o=r.lineHeight,u=this.$getTop(t.start.row,r),a=this.$padding,f=this.session.$bidiHandler.getSelections(t.start.column,t.end.column);f.forEach(function(e){this.elt(n,"height:"+o+"px;"+"width:"+e.width+(i||0)+"px;"+"top:"+u+"px;"+"left:"+(a+e.left)+"px;"+(s||""))},this)},this.drawFullLineMarker=function(e,t,n,r,i){var s=this.$getTop(t.start.row,r),o=r.lineHeight;t.start.row!=t.end.row&&(o+=this.$getTop(t.end.row,r)-s),this.elt(n,"height:"+o+"px;"+"top:"+s+"px;"+"left:0;right:0;"+(i||""))},this.drawScreenLineMarker=function(e,t,n,r,i){var s=this.$getTop(t.start.row,r),o=r.lineHeight;this.elt(n,"height:"+o+"px;"+"top:"+s+"px;"+"left:0;right:0;"+(i||""))}}).call(s.prototype),t.Marker=s}),define("ace/layer/text",["require","exports","module","ace/lib/oop","ace/lib/dom","ace/lib/lang","ace/layer/lines","ace/lib/event_emitter"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("../lib/dom"),s=e("../lib/lang"),o=e("./lines").Lines,u=e("../lib/event_emitter").EventEmitter,a=function(e){this.dom=i,this.element=this.dom.createElement("div"),this.element.className="ace_layer ace_text-layer",e.appendChild(this.element),this.$updateEolChar=this.$updateEolChar.bind(this),this.$lines=new o(this.element)};(function(){r.implement(this,u),this.EOF_CHAR="\u00b6",this.EOL_CHAR_LF="\u00ac",this.EOL_CHAR_CRLF="\u00a4",this.EOL_CHAR=this.EOL_CHAR_LF,this.TAB_CHAR="\u2014",this.SPACE_CHAR="\u00b7",this.$padding=0,this.MAX_LINE_LENGTH=1e4,this.$updateEolChar=function(){var e=this.session.doc,t=e.getNewLineCharacter()=="\n"&&e.getNewLineMode()!="windows",n=t?this.EOL_CHAR_LF:this.EOL_CHAR_CRLF;if(this.EOL_CHAR!=n)return this.EOL_CHAR=n,!0},this.setPadding=function(e){this.$padding=e,this.element.style.margin="0 "+e+"px"},this.getLineHeight=function(){return this.$fontMetrics.$characterSize.height||0},this.getCharacterWidth=function(){return this.$fontMetrics.$characterSize.width||0},this.$setFontMetrics=function(e){this.$fontMetrics=e,this.$fontMetrics.on("changeCharacterSize",function(e){this._signal("changeCharacterSize",e)}.bind(this)),this.$pollSizeChanges()},this.checkForSizeChanges=function(){this.$fontMetrics.checkForSizeChanges()},this.$pollSizeChanges=function(){return this.$pollSizeChangesTimer=this.$fontMetrics.$pollSizeChanges()},this.setSession=function(e){this.session=e,e&&this.$computeTabString()},this.showInvisibles=!1,this.showSpaces=!1,this.showTabs=!1,this.showEOL=!1,this.setShowInvisibles=function(e){return this.showInvisibles==e?!1:(this.showInvisibles=e,typeof e=="string"?(this.showSpaces=/tab/i.test(e),this.showTabs=/space/i.test(e),this.showEOL=/eol/i.test(e)):this.showSpaces=this.showTabs=this.showEOL=e,this.$computeTabString(),!0)},this.displayIndentGuides=!0,this.setDisplayIndentGuides=function(e){return this.displayIndentGuides==e?!1:(this.displayIndentGuides=e,this.$computeTabString(),!0)},this.$tabStrings=[],this.onChangeTabSize=this.$computeTabString=function(){var e=this.session.getTabSize();this.tabSize=e;var t=this.$tabStrings=[0];for(var n=1;nl&&(u=a.end.row+1,a=this.session.getNextFoldLine(u,a),l=a?a.start.row:Infinity);if(u>i)break;var c=s[o++];if(c){this.dom.removeChildren(c),this.$renderLine(c,u,u==l?a:!1),f&&(c.style.top=this.$lines.computeLineTop(u,e,this.session)+"px");var h=e.lineHeight*this.session.getRowLength(u)+"px";c.style.height!=h&&(f=!0,c.style.height=h)}u++}if(f)while(o0;i--)this.$lines.shift();if(t.lastRow>e.lastRow)for(var i=this.session.getFoldedRowCount(e.lastRow+1,t.lastRow);i>0;i--)this.$lines.pop();e.firstRowt.lastRow&&this.$lines.push(this.$renderLinesFragment(e,t.lastRow+1,e.lastRow))},this.$renderLinesFragment=function(e,t,n){var r=[],s=t,o=this.session.getNextFoldLine(s),u=o?o.start.row:Infinity;for(;;){s>u&&(s=o.end.row+1,o=this.session.getNextFoldLine(s,o),u=o?o.start.row:Infinity);if(s>n)break;var a=this.$lines.createCell(s,e,this.session),f=a.element;this.dom.removeChildren(f),i.setStyle(f.style,"height",this.$lines.computeLineHeight(s,e,this.session)+"px"),i.setStyle(f.style,"top",this.$lines.computeLineTop(s,e,this.session)+"px"),this.$renderLine(f,s,s==u?o:!1),this.$useLineGroups()?f.className="ace_line_group":f.className="ace_line",r.push(a),s++}return r},this.update=function(e){this.$lines.moveContainer(e),this.config=e;var t=e.firstRow,n=e.lastRow,r=this.$lines;while(r.getLength())r.pop();r.push(this.$renderLinesFragment(e,t,n))},this.$textToken={text:!0,rparen:!0,lparen:!0},this.$renderToken=function(e,t,n,r){var i=this,o=/(\t)|( +)|([\x00-\x1f\x80-\xa0\xad\u1680\u180E\u2000-\u200f\u2028\u2029\u202F\u205F\uFEFF\uFFF9-\uFFFC]+)|(\u3000)|([\u1100-\u115F\u11A3-\u11A7\u11FA-\u11FF\u2329-\u232A\u2E80-\u2E99\u2E9B-\u2EF3\u2F00-\u2FD5\u2FF0-\u2FFB\u3001-\u303E\u3041-\u3096\u3099-\u30FF\u3105-\u312D\u3131-\u318E\u3190-\u31BA\u31C0-\u31E3\u31F0-\u321E\u3220-\u3247\u3250-\u32FE\u3300-\u4DBF\u4E00-\uA48C\uA490-\uA4C6\uA960-\uA97C\uAC00-\uD7A3\uD7B0-\uD7C6\uD7CB-\uD7FB\uF900-\uFAFF\uFE10-\uFE19\uFE30-\uFE52\uFE54-\uFE66\uFE68-\uFE6B\uFF01-\uFF60\uFFE0-\uFFE6]|[\uD800-\uDBFF][\uDC00-\uDFFF])/g,u=this.dom.createFragment(this.element),a,f=0;while(a=o.exec(r)){var l=a[1],c=a[2],h=a[3],p=a[4],d=a[5];if(!i.showSpaces&&c)continue;var v=f!=a.index?r.slice(f,a.index):"";f=a.index+a[0].length,v&&u.appendChild(this.dom.createTextNode(v,this.element));if(l){var m=i.session.getScreenTabSize(t+a.index);u.appendChild(i.$tabStrings[m].cloneNode(!0)),t+=m-1}else if(c)if(i.showSpaces){var g=this.dom.createElement("span");g.className="ace_invisible ace_invisible_space",g.textContent=s.stringRepeat(i.SPACE_CHAR,c.length),u.appendChild(g)}else u.appendChild(this.com.createTextNode(c,this.element));else if(h){var g=this.dom.createElement("span");g.className="ace_invisible ace_invisible_space ace_invalid",g.textContent=s.stringRepeat(i.SPACE_CHAR,h.length),u.appendChild(g)}else if(p){t+=1;var g=this.dom.createElement("span");g.style.width=i.config.characterWidth*2+"px",g.className=i.showSpaces?"ace_cjk ace_invisible ace_invisible_space":"ace_cjk",g.textContent=i.showSpaces?i.SPACE_CHAR:p,u.appendChild(g)}else if(d){t+=1;var g=this.dom.createElement("span");g.style.width=i.config.characterWidth*2+"px",g.className="ace_cjk",g.textContent=d,u.appendChild(g)}}u.appendChild(this.dom.createTextNode(f?r.slice(f):r,this.element));if(!this.$textToken[n.type]){var y="ace_"+n.type.replace(/\./g," ace_"),g=this.dom.createElement("span");n.type=="fold"&&(g.style.width=n.value.length*this.config.characterWidth+"px"),g.className=y,g.appendChild(u),e.appendChild(g)}else e.appendChild(u);return t+r.length},this.renderIndentGuide=function(e,t,n){var r=t.search(this.$indentGuideRe);if(r<=0||r>=n)return t;if(t[0]==" "){r-=r%this.tabSize;var i=r/this.tabSize;for(var s=0;s=o)u=this.$renderToken(a,u,l,c.substring(0,o-r)),c=c.substring(o-r),r=o,a=this.$createLineElement(),e.appendChild(a),a.appendChild(this.dom.createTextNode(s.stringRepeat("\u00a0",n.indent),this.element)),i++,u=0,o=n[i]||Number.MAX_VALUE;c.length!=0&&(r+=c.length,u=this.$renderToken(a,u,l,c))}}n[n.length-1]>this.MAX_LINE_LENGTH&&this.$renderOverflowMessage(a,u,null,"",!0)},this.$renderSimpleLine=function(e,t){var n=0,r=t[0],i=r.value;this.displayIndentGuides&&(i=this.renderIndentGuide(e,i)),i&&(n=this.$renderToken(e,n,r,i));for(var s=1;sthis.MAX_LINE_LENGTH)return this.$renderOverflowMessage(e,n,r,i);n=this.$renderToken(e,n,r,i)}},this.$renderOverflowMessage=function(e,t,n,r,i){n&&this.$renderToken(e,t,n,r.slice(0,this.MAX_LINE_LENGTH-t));var s=this.dom.createElement("span");s.className="ace_inline_button ace_keyword ace_toggle_wrap",s.textContent=i?"":"",e.appendChild(s)},this.$renderLine=function(e,t,n){!n&&n!=0&&(n=this.session.getFoldLine(t));if(n)var r=this.$getFoldLineTokens(t,n);else var r=this.session.getTokens(t);var i=e;if(r.length){var s=this.session.getRowSplitData(t);if(s&&s.length){this.$renderWrappedLine(e,r,s);var i=e.lastChild}else{var i=e;this.$useLineGroups()&&(i=this.$createLineElement(),e.appendChild(i)),this.$renderSimpleLine(i,r)}}else this.$useLineGroups()&&(i=this.$createLineElement(),e.appendChild(i));if(this.showEOL&&i){n&&(t=n.end.row);var o=this.dom.createElement("span");o.className="ace_invisible ace_invisible_eol",o.textContent=t==this.session.getLength()-1?this.EOF_CHAR:this.EOL_CHAR,i.appendChild(o)}},this.$getFoldLineTokens=function(e,t){function i(e,t,n){var i=0,s=0;while(s+e[i].value.lengthn-t&&(o=o.substring(0,n-t)),r.push({type:e[i].type,value:o}),s=t+o.length,i+=1}while(sn?r.push({type:e[i].type,value:o.substring(0,n-s)}):r.push(e[i]),s+=o.length,i+=1}}var n=this.session,r=[],s=n.getTokens(e);return t.walk(function(e,t,o,u,a){e!=null?r.push({type:"fold",value:e}):(a&&(s=n.getTokens(t)),s.length&&i(s,u,o))},t.end.row,this.session.getLine(t.end.row).length),r},this.$useLineGroups=function(){return this.session.getUseWrapMode()},this.destroy=function(){}}).call(a.prototype),t.Text=a}),define("ace/layer/cursor",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../lib/dom"),i=function(e){this.element=r.createElement("div"),this.element.className="ace_layer ace_cursor-layer",e.appendChild(this.element),this.isVisible=!1,this.isBlinking=!0,this.blinkInterval=1e3,this.smoothBlinking=!1,this.cursors=[],this.cursor=this.addCursor(),r.addCssClass(this.element,"ace_hidden-cursors"),this.$updateCursors=this.$updateOpacity.bind(this)};(function(){this.$updateOpacity=function(e){var t=this.cursors;for(var n=t.length;n--;)r.setStyle(t[n].style,"opacity",e?"":"0")},this.$startCssAnimation=function(){var e=this.cursors;for(var t=e.length;t--;)e[t].style.animationDuration=this.blinkInterval+"ms";setTimeout(function(){r.addCssClass(this.element,"ace_animate-blinking")}.bind(this))},this.$stopCssAnimation=function(){r.removeCssClass(this.element,"ace_animate-blinking")},this.$padding=0,this.setPadding=function(e){this.$padding=e},this.setSession=function(e){this.session=e},this.setBlinking=function(e){e!=this.isBlinking&&(this.isBlinking=e,this.restartTimer())},this.setBlinkInterval=function(e){e!=this.blinkInterval&&(this.blinkInterval=e,this.restartTimer())},this.setSmoothBlinking=function(e){e!=this.smoothBlinking&&(this.smoothBlinking=e,r.setCssClass(this.element,"ace_smooth-blinking",e),this.$updateCursors(!0),this.restartTimer())},this.addCursor=function(){var e=r.createElement("div");return e.className="ace_cursor",this.element.appendChild(e),this.cursors.push(e),e},this.removeCursor=function(){if(this.cursors.length>1){var e=this.cursors.pop();return e.parentNode.removeChild(e),e}},this.hideCursor=function(){this.isVisible=!1,r.addCssClass(this.element,"ace_hidden-cursors"),this.restartTimer()},this.showCursor=function(){this.isVisible=!0,r.removeCssClass(this.element,"ace_hidden-cursors"),this.restartTimer()},this.restartTimer=function(){var e=this.$updateCursors;clearInterval(this.intervalId),clearTimeout(this.timeoutId),this.$stopCssAnimation(),this.smoothBlinking&&r.removeCssClass(this.element,"ace_smooth-blinking"),e(!0);if(!this.isBlinking||!this.blinkInterval||!this.isVisible){this.$stopCssAnimation();return}this.smoothBlinking&&setTimeout(function(){r.addCssClass(this.element,"ace_smooth-blinking")}.bind(this));if(r.HAS_CSS_ANIMATION)this.$startCssAnimation();else{var t=function(){this.timeoutId=setTimeout(function(){e(!1)},.6*this.blinkInterval)}.bind(this);this.intervalId=setInterval(function(){e(!0),t()},this.blinkInterval),t()}},this.getPixelPosition=function(e,t){if(!this.config||!this.session)return{left:0,top:0};e||(e=this.session.selection.getCursor());var n=this.session.documentToScreenPosition(e),r=this.$padding+(this.session.$bidiHandler.isBidiRow(n.row,e.row)?this.session.$bidiHandler.getPosLeft(n.column):n.column*this.config.characterWidth),i=(n.row-(t?this.config.firstRowScreen:0))*this.config.lineHeight;return{left:r,top:i}},this.isCursorInView=function(e,t){return e.top>=0&&e.tope.height+e.offset||o.top<0)&&n>1)continue;var u=this.cursors[i++]||this.addCursor(),a=u.style;this.drawCursor?this.drawCursor(u,o,e,t[n],this.session):this.isCursorInView(o,e)?(r.setStyle(a,"display","block"),r.translate(u,o.left,o.top),r.setStyle(a,"width",Math.round(e.characterWidth)+"px"),r.setStyle(a,"height",e.lineHeight+"px")):r.setStyle(a,"display","none")}while(this.cursors.length>i)this.removeCursor();var f=this.session.getOverwrite();this.$setOverwrite(f),this.$pixelPos=o,this.restartTimer()},this.drawCursor=null,this.$setOverwrite=function(e){e!=this.overwrite&&(this.overwrite=e,e?r.addCssClass(this.element,"ace_overwrite-cursors"):r.removeCssClass(this.element,"ace_overwrite-cursors"))},this.destroy=function(){clearInterval(this.intervalId),clearTimeout(this.timeoutId)}}).call(i.prototype),t.Cursor=i}),define("ace/scrollbar",["require","exports","module","ace/lib/oop","ace/lib/dom","ace/lib/event","ace/lib/event_emitter"],function(e,t,n){"use strict";var r=e("./lib/oop"),i=e("./lib/dom"),s=e("./lib/event"),o=e("./lib/event_emitter").EventEmitter,u=32768,a=function(e){this.element=i.createElement("div"),this.element.className="ace_scrollbar ace_scrollbar"+this.classSuffix,this.inner=i.createElement("div"),this.inner.className="ace_scrollbar-inner",this.inner.textContent="\u00a0",this.element.appendChild(this.inner),e.appendChild(this.element),this.setVisible(!1),this.skipEvent=!1,s.addListener(this.element,"scroll",this.onScroll.bind(this)),s.addListener(this.element,"mousedown",s.preventDefault)};(function(){r.implement(this,o),this.setVisible=function(e){this.element.style.display=e?"":"none",this.isVisible=e,this.coeff=1}}).call(a.prototype);var f=function(e,t){a.call(this,e),this.scrollTop=0,this.scrollHeight=0,t.$scrollbarWidth=this.width=i.scrollbarWidth(e.ownerDocument),this.inner.style.width=this.element.style.width=(this.width||15)+5+"px",this.$minWidth=0};r.inherits(f,a),function(){this.classSuffix="-v",this.onScroll=function(){if(!this.skipEvent){this.scrollTop=this.element.scrollTop;if(this.coeff!=1){var e=this.element.clientHeight/this.scrollHeight;this.scrollTop=this.scrollTop*(1-e)/(this.coeff-e)}this._emit("scroll",{data:this.scrollTop})}this.skipEvent=!1},this.getWidth=function(){return Math.max(this.isVisible?this.width:0,this.$minWidth||0)},this.setHeight=function(e){this.element.style.height=e+"px"},this.setInnerHeight=this.setScrollHeight=function(e){this.scrollHeight=e,e>u?(this.coeff=u/e,e=u):this.coeff!=1&&(this.coeff=1),this.inner.style.height=e+"px"},this.setScrollTop=function(e){this.scrollTop!=e&&(this.skipEvent=!0,this.scrollTop=e,this.element.scrollTop=e*this.coeff)}}.call(f.prototype);var l=function(e,t){a.call(this,e),this.scrollLeft=0,this.height=t.$scrollbarWidth,this.inner.style.height=this.element.style.height=(this.height||15)+5+"px"};r.inherits(l,a),function(){this.classSuffix="-h",this.onScroll=function(){this.skipEvent||(this.scrollLeft=this.element.scrollLeft,this._emit("scroll",{data:this.scrollLeft})),this.skipEvent=!1},this.getHeight=function(){return this.isVisible?this.height:0},this.setWidth=function(e){this.element.style.width=e+"px"},this.setInnerWidth=function(e){this.inner.style.width=e+"px"},this.setScrollWidth=function(e){this.inner.style.width=e+"px"},this.setScrollLeft=function(e){this.scrollLeft!=e&&(this.skipEvent=!0,this.scrollLeft=this.element.scrollLeft=e)}}.call(l.prototype),t.ScrollBar=f,t.ScrollBarV=f,t.ScrollBarH=l,t.VScrollBar=f,t.HScrollBar=l}),define("ace/renderloop",["require","exports","module","ace/lib/event"],function(e,t,n){"use strict";var r=e("./lib/event"),i=function(e,t){this.onRender=e,this.pending=!1,this.changes=0,this.$recursionLimit=2,this.window=t||window;var n=this;this._flush=function(e){n.pending=!1;var t=n.changes;t&&(r.blockIdle(100),n.changes=0,n.onRender(t));if(n.changes){if(n.$recursionLimit--<0)return;n.schedule()}else n.$recursionLimit=2}};(function(){this.schedule=function(e){this.changes=this.changes|e,this.changes&&!this.pending&&(r.nextFrame(this._flush),this.pending=!0)},this.clear=function(e){var t=this.changes;return this.changes=0,t}}).call(i.prototype),t.RenderLoop=i}),define("ace/layer/font_metrics",["require","exports","module","ace/lib/oop","ace/lib/dom","ace/lib/lang","ace/lib/event","ace/lib/useragent","ace/lib/event_emitter"],function(e,t,n){var r=e("../lib/oop"),i=e("../lib/dom"),s=e("../lib/lang"),o=e("../lib/event"),u=e("../lib/useragent"),a=e("../lib/event_emitter").EventEmitter,f=256,l=typeof ResizeObserver=="function",c=200,h=t.FontMetrics=function(e){this.el=i.createElement("div"),this.$setMeasureNodeStyles(this.el.style,!0),this.$main=i.createElement("div"),this.$setMeasureNodeStyles(this.$main.style),this.$measureNode=i.createElement("div"),this.$setMeasureNodeStyles(this.$measureNode.style),this.el.appendChild(this.$main),this.el.appendChild(this.$measureNode),e.appendChild(this.el),this.$measureNode.textContent=s.stringRepeat("X",f),this.$characterSize={width:0,height:0},l?this.$addObserver():this.checkForSizeChanges()};(function(){r.implement(this,a),this.$characterSize={width:0,height:0},this.$setMeasureNodeStyles=function(e,t){e.width=e.height="auto",e.left=e.top="0px",e.visibility="hidden",e.position="absolute",e.whiteSpace="pre",u.isIE<8?e["font-family"]="inherit":e.font="inherit",e.overflow=t?"hidden":"visible"},this.checkForSizeChanges=function(e){e===undefined&&(e=this.$measureSizes());if(e&&(this.$characterSize.width!==e.width||this.$characterSize.height!==e.height)){this.$measureNode.style.fontWeight="bold";var t=this.$measureSizes();this.$measureNode.style.fontWeight="",this.$characterSize=e,this.charSizes=Object.create(null),this.allowBoldFonts=t&&t.width===e.width&&t.height===e.height,this._emit("changeCharacterSize",{data:e})}},this.$addObserver=function(){var e=this;this.$observer=new window.ResizeObserver(function(t){e.checkForSizeChanges()}),this.$observer.observe(this.$measureNode)},this.$pollSizeChanges=function(){if(this.$pollSizeChangesTimer||this.$observer)return this.$pollSizeChangesTimer;var e=this;return this.$pollSizeChangesTimer=o.onIdle(function t(){e.checkForSizeChanges(),o.onIdle(t,500)},500)},this.setPolling=function(e){e?this.$pollSizeChanges():this.$pollSizeChangesTimer&&(clearInterval(this.$pollSizeChangesTimer),this.$pollSizeChangesTimer=0)},this.$measureSizes=function(e){var t={height:(e||this.$measureNode).clientHeight,width:(e||this.$measureNode).clientWidth/f};return t.width===0||t.height===0?null:t},this.$measureCharWidth=function(e){this.$main.textContent=s.stringRepeat(e,f);var t=this.$main.getBoundingClientRect();return t.width/f},this.getCharacterWidth=function(e){var t=this.charSizes[e];return t===undefined&&(t=this.charSizes[e]=this.$measureCharWidth(e)/this.$characterSize.width),t},this.destroy=function(){clearInterval(this.$pollSizeChangesTimer),this.$observer&&this.$observer.disconnect(),this.el&&this.el.parentNode&&this.el.parentNode.removeChild(this.el)},this.$getZoom=function e(t){return t?(window.getComputedStyle(t).zoom||1)*e(t.parentElement):1},this.$initTransformMeasureNodes=function(){var e=function(e,t){return["div",{style:"position: absolute;top:"+e+"px;left:"+t+"px;"}]};this.els=i.buildDom([e(0,0),e(c,0),e(0,c),e(c,c)],this.el)},this.transformCoordinates=function(e,t){function r(e,t,n){var r=e[1]*t[0]-e[0]*t[1];return[(-t[1]*n[0]+t[0]*n[1])/r,(+e[1]*n[0]-e[0]*n[1])/r]}function i(e,t){return[e[0]-t[0],e[1]-t[1]]}function s(e,t){return[e[0]+t[0],e[1]+t[1]]}function o(e,t){return[e*t[0],e*t[1]]}function u(e){var t=e.getBoundingClientRect();return[t.left,t.top]}if(e){var n=this.$getZoom(this.el);e=o(1/n,e)}this.els||this.$initTransformMeasureNodes();var a=u(this.els[0]),f=u(this.els[1]),l=u(this.els[2]),h=u(this.els[3]),p=r(i(h,f),i(h,l),i(s(f,l),s(h,a))),d=o(1+p[0],i(f,a)),v=o(1+p[1],i(l,a));if(t){var m=t,g=p[0]*m[0]/c+p[1]*m[1]/c+1,y=s(o(m[0],d),o(m[1],v));return s(o(1/g/c,y),a)}var b=i(e,a),w=r(i(d,o(p[0],b)),i(v,o(p[1],b)),b);return o(c,w)}}).call(h.prototype)}),define("ace/virtual_renderer",["require","exports","module","ace/lib/oop","ace/lib/dom","ace/config","ace/layer/gutter","ace/layer/marker","ace/layer/text","ace/layer/cursor","ace/scrollbar","ace/scrollbar","ace/renderloop","ace/layer/font_metrics","ace/lib/event_emitter","ace/lib/useragent"],function(e,t,n){"use strict";var r=e("./lib/oop"),i=e("./lib/dom"),s=e("./config"),o=e("./layer/gutter").Gutter,u=e("./layer/marker").Marker,a=e("./layer/text").Text,f=e("./layer/cursor").Cursor,l=e("./scrollbar").HScrollBar,c=e("./scrollbar").VScrollBar,h=e("./renderloop").RenderLoop,p=e("./layer/font_metrics").FontMetrics,d=e("./lib/event_emitter").EventEmitter,v='.ace_br1 {border-top-left-radius : 3px;}.ace_br2 {border-top-right-radius : 3px;}.ace_br3 {border-top-left-radius : 3px; border-top-right-radius: 3px;}.ace_br4 {border-bottom-right-radius: 3px;}.ace_br5 {border-top-left-radius : 3px; border-bottom-right-radius: 3px;}.ace_br6 {border-top-right-radius : 3px; border-bottom-right-radius: 3px;}.ace_br7 {border-top-left-radius : 3px; border-top-right-radius: 3px; border-bottom-right-radius: 3px;}.ace_br8 {border-bottom-left-radius : 3px;}.ace_br9 {border-top-left-radius : 3px; border-bottom-left-radius: 3px;}.ace_br10{border-top-right-radius : 3px; border-bottom-left-radius: 3px;}.ace_br11{border-top-left-radius : 3px; border-top-right-radius: 3px; border-bottom-left-radius: 3px;}.ace_br12{border-bottom-right-radius: 3px; border-bottom-left-radius: 3px;}.ace_br13{border-top-left-radius : 3px; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px;}.ace_br14{border-top-right-radius : 3px; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px;}.ace_br15{border-top-left-radius : 3px; border-top-right-radius: 3px; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px;}.ace_editor {position: relative;overflow: hidden;padding: 0;font: 12px/normal \'Monaco\', \'Menlo\', \'Ubuntu Mono\', \'Consolas\', \'source-code-pro\', monospace;direction: ltr;text-align: left;-webkit-tap-highlight-color: rgba(0, 0, 0, 0);}.ace_scroller {position: absolute;overflow: hidden;top: 0;bottom: 0;background-color: inherit;-ms-user-select: none;-moz-user-select: none;-webkit-user-select: none;user-select: none;cursor: text;}.ace_content {position: absolute;box-sizing: border-box;min-width: 100%;contain: style size layout;font-variant-ligatures: no-common-ligatures;}.ace_dragging .ace_scroller:before{position: absolute;top: 0;left: 0;right: 0;bottom: 0;content: \'\';background: rgba(250, 250, 250, 0.01);z-index: 1000;}.ace_dragging.ace_dark .ace_scroller:before{background: rgba(0, 0, 0, 0.01);}.ace_selecting, .ace_selecting * {cursor: text !important;}.ace_gutter {position: absolute;overflow : hidden;width: auto;top: 0;bottom: 0;left: 0;cursor: default;z-index: 4;-ms-user-select: none;-moz-user-select: none;-webkit-user-select: none;user-select: none;contain: style size layout;}.ace_gutter-active-line {position: absolute;left: 0;right: 0;}.ace_scroller.ace_scroll-left {box-shadow: 17px 0 16px -16px rgba(0, 0, 0, 0.4) inset;}.ace_gutter-cell {position: absolute;top: 0;left: 0;right: 0;padding-left: 19px;padding-right: 6px;background-repeat: no-repeat;}.ace_gutter-cell.ace_error {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAABOFBMVEX/////////QRswFAb/Ui4wFAYwFAYwFAaWGAfDRymzOSH/PxswFAb/SiUwFAYwFAbUPRvjQiDllog5HhHdRybsTi3/Tyv9Tir+Syj/UC3////XurebMBIwFAb/RSHbPx/gUzfdwL3kzMivKBAwFAbbvbnhPx66NhowFAYwFAaZJg8wFAaxKBDZurf/RB6mMxb/SCMwFAYwFAbxQB3+RB4wFAb/Qhy4Oh+4QifbNRcwFAYwFAYwFAb/QRzdNhgwFAYwFAbav7v/Uy7oaE68MBK5LxLewr/r2NXewLswFAaxJw4wFAbkPRy2PyYwFAaxKhLm1tMwFAazPiQwFAaUGAb/QBrfOx3bvrv/VC/maE4wFAbRPBq6MRO8Qynew8Dp2tjfwb0wFAbx6eju5+by6uns4uH9/f36+vr/GkHjAAAAYnRSTlMAGt+64rnWu/bo8eAA4InH3+DwoN7j4eLi4xP99Nfg4+b+/u9B/eDs1MD1mO7+4PHg2MXa347g7vDizMLN4eG+Pv7i5evs/v79yu7S3/DV7/498Yv24eH+4ufQ3Ozu/v7+y13sRqwAAADLSURBVHjaZc/XDsFgGIBhtDrshlitmk2IrbHFqL2pvXf/+78DPokj7+Fz9qpU/9UXJIlhmPaTaQ6QPaz0mm+5gwkgovcV6GZzd5JtCQwgsxoHOvJO15kleRLAnMgHFIESUEPmawB9ngmelTtipwwfASilxOLyiV5UVUyVAfbG0cCPHig+GBkzAENHS0AstVF6bacZIOzgLmxsHbt2OecNgJC83JERmePUYq8ARGkJx6XtFsdddBQgZE2nPR6CICZhawjA4Fb/chv+399kfR+MMMDGOQAAAABJRU5ErkJggg==");background-repeat: no-repeat;background-position: 2px center;}.ace_gutter-cell.ace_warning {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAmVBMVEX///8AAAD///8AAAAAAABPSzb/5sAAAAB/blH/73z/ulkAAAAAAAD85pkAAAAAAAACAgP/vGz/rkDerGbGrV7/pkQICAf////e0IsAAAD/oED/qTvhrnUAAAD/yHD/njcAAADuv2r/nz//oTj/p064oGf/zHAAAAA9Nir/tFIAAAD/tlTiuWf/tkIAAACynXEAAAAAAAAtIRW7zBpBAAAAM3RSTlMAABR1m7RXO8Ln31Z36zT+neXe5OzooRDfn+TZ4p3h2hTf4t3k3ucyrN1K5+Xaks52Sfs9CXgrAAAAjklEQVR42o3PbQ+CIBQFYEwboPhSYgoYunIqqLn6/z8uYdH8Vmdnu9vz4WwXgN/xTPRD2+sgOcZjsge/whXZgUaYYvT8QnuJaUrjrHUQreGczuEafQCO/SJTufTbroWsPgsllVhq3wJEk2jUSzX3CUEDJC84707djRc5MTAQxoLgupWRwW6UB5fS++NV8AbOZgnsC7BpEAAAAABJRU5ErkJggg==");background-position: 2px center;}.ace_gutter-cell.ace_info {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAAAAAA6mKC9AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAJ0Uk5TAAB2k804AAAAPklEQVQY02NgIB68QuO3tiLznjAwpKTgNyDbMegwisCHZUETUZV0ZqOquBpXj2rtnpSJT1AEnnRmL2OgGgAAIKkRQap2htgAAAAASUVORK5CYII=");background-position: 2px center;}.ace_dark .ace_gutter-cell.ace_info {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQBAMAAADt3eJSAAAAJFBMVEUAAAChoaGAgIAqKiq+vr6tra1ZWVmUlJSbm5s8PDxubm56enrdgzg3AAAAAXRSTlMAQObYZgAAAClJREFUeNpjYMAPdsMYHegyJZFQBlsUlMFVCWUYKkAZMxZAGdxlDMQBAG+TBP4B6RyJAAAAAElFTkSuQmCC");}.ace_scrollbar {contain: strict;position: absolute;right: 0;bottom: 0;z-index: 6;}.ace_scrollbar-inner {position: absolute;cursor: text;left: 0;top: 0;}.ace_scrollbar-v{overflow-x: hidden;overflow-y: scroll;top: 0;}.ace_scrollbar-h {overflow-x: scroll;overflow-y: hidden;left: 0;}.ace_print-margin {position: absolute;height: 100%;}.ace_text-input {position: absolute;z-index: 0;width: 0.5em;height: 1em;opacity: 0;background: transparent;-moz-appearance: none;appearance: none;border: none;resize: none;outline: none;overflow: hidden;font: inherit;padding: 0 1px;margin: 0 -1px;contain: strict;-ms-user-select: text;-moz-user-select: text;-webkit-user-select: text;user-select: text;white-space: pre!important;}.ace_text-input.ace_composition {background: transparent;color: inherit;z-index: 1000;opacity: 1;}.ace_composition_placeholder { color: transparent }.ace_composition_marker { border-bottom: 1px solid;position: absolute;border-radius: 0;margin-top: 1px;}[ace_nocontext=true] {transform: none!important;filter: none!important;clip-path: none!important;mask : none!important;contain: none!important;perspective: none!important;mix-blend-mode: initial!important;z-index: auto;}.ace_layer {z-index: 1;position: absolute;overflow: hidden;word-wrap: normal;white-space: pre;height: 100%;width: 100%;box-sizing: border-box;pointer-events: none;}.ace_gutter-layer {position: relative;width: auto;text-align: right;pointer-events: auto;height: 1000000px;contain: style size layout;}.ace_text-layer {font: inherit !important;position: absolute;height: 1000000px;width: 1000000px;contain: style size layout;}.ace_text-layer > .ace_line, .ace_text-layer > .ace_line_group {contain: style size layout;position: absolute;top: 0;left: 0;right: 0;}.ace_hidpi .ace_text-layer,.ace_hidpi .ace_gutter-layer,.ace_hidpi .ace_content,.ace_hidpi .ace_gutter {contain: strict;will-change: transform;}.ace_hidpi .ace_text-layer > .ace_line, .ace_hidpi .ace_text-layer > .ace_line_group {contain: strict;}.ace_cjk {display: inline-block;text-align: center;}.ace_cursor-layer {z-index: 4;}.ace_cursor {z-index: 4;position: absolute;box-sizing: border-box;border-left: 2px solid;transform: translatez(0);}.ace_multiselect .ace_cursor {border-left-width: 1px;}.ace_slim-cursors .ace_cursor {border-left-width: 1px;}.ace_overwrite-cursors .ace_cursor {border-left-width: 0;border-bottom: 1px solid;}.ace_hidden-cursors .ace_cursor {opacity: 0.2;}.ace_hasPlaceholder .ace_hidden-cursors .ace_cursor {opacity: 0;}.ace_smooth-blinking .ace_cursor {transition: opacity 0.18s;}.ace_animate-blinking .ace_cursor {animation-duration: 1000ms;animation-timing-function: step-end;animation-name: blink-ace-animate;animation-iteration-count: infinite;}.ace_animate-blinking.ace_smooth-blinking .ace_cursor {animation-duration: 1000ms;animation-timing-function: ease-in-out;animation-name: blink-ace-animate-smooth;}@keyframes blink-ace-animate {from, to { opacity: 1; }60% { opacity: 0; }}@keyframes blink-ace-animate-smooth {from, to { opacity: 1; }45% { opacity: 1; }60% { opacity: 0; }85% { opacity: 0; }}.ace_marker-layer .ace_step, .ace_marker-layer .ace_stack {position: absolute;z-index: 3;}.ace_marker-layer .ace_selection {position: absolute;z-index: 5;}.ace_marker-layer .ace_bracket {position: absolute;z-index: 6;}.ace_marker-layer .ace_error_bracket {position: absolute;border-bottom: 1px solid #DE5555;border-radius: 0;}.ace_marker-layer .ace_active-line {position: absolute;z-index: 2;}.ace_marker-layer .ace_selected-word {position: absolute;z-index: 4;box-sizing: border-box;}.ace_line .ace_fold {box-sizing: border-box;display: inline-block;height: 11px;margin-top: -2px;vertical-align: middle;background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAJCAYAAADU6McMAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAJpJREFUeNpi/P//PwOlgAXGYGRklAVSokD8GmjwY1wasKljQpYACtpCFeADcHVQfQyMQAwzwAZI3wJKvCLkfKBaMSClBlR7BOQikCFGQEErIH0VqkabiGCAqwUadAzZJRxQr/0gwiXIal8zQQPnNVTgJ1TdawL0T5gBIP1MUJNhBv2HKoQHHjqNrA4WO4zY0glyNKLT2KIfIMAAQsdgGiXvgnYAAAAASUVORK5CYII="),url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAA3CAYAAADNNiA5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAACJJREFUeNpi+P//fxgTAwPDBxDxD078RSX+YeEyDFMCIMAAI3INmXiwf2YAAAAASUVORK5CYII=");background-repeat: no-repeat, repeat-x;background-position: center center, top left;color: transparent;border: 1px solid black;border-radius: 2px;cursor: pointer;pointer-events: auto;}.ace_dark .ace_fold {}.ace_fold:hover{background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAJCAYAAADU6McMAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAJpJREFUeNpi/P//PwOlgAXGYGRklAVSokD8GmjwY1wasKljQpYACtpCFeADcHVQfQyMQAwzwAZI3wJKvCLkfKBaMSClBlR7BOQikCFGQEErIH0VqkabiGCAqwUadAzZJRxQr/0gwiXIal8zQQPnNVTgJ1TdawL0T5gBIP1MUJNhBv2HKoQHHjqNrA4WO4zY0glyNKLT2KIfIMAAQsdgGiXvgnYAAAAASUVORK5CYII="),url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAA3CAYAAADNNiA5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAACBJREFUeNpi+P//fz4TAwPDZxDxD5X4i5fLMEwJgAADAEPVDbjNw87ZAAAAAElFTkSuQmCC");}.ace_tooltip {background-color: #FFF;background-image: linear-gradient(to bottom, transparent, rgba(0, 0, 0, 0.1));border: 1px solid gray;border-radius: 1px;box-shadow: 0 1px 2px rgba(0, 0, 0, 0.3);color: black;max-width: 100%;padding: 3px 4px;position: fixed;z-index: 999999;box-sizing: border-box;cursor: default;white-space: pre;word-wrap: break-word;line-height: normal;font-style: normal;font-weight: normal;letter-spacing: normal;pointer-events: none;}.ace_folding-enabled > .ace_gutter-cell {padding-right: 13px;}.ace_fold-widget {box-sizing: border-box;margin: 0 -12px 0 1px;display: none;width: 11px;vertical-align: top;background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAANElEQVR42mWKsQ0AMAzC8ixLlrzQjzmBiEjp0A6WwBCSPgKAXoLkqSot7nN3yMwR7pZ32NzpKkVoDBUxKAAAAABJRU5ErkJggg==");background-repeat: no-repeat;background-position: center;border-radius: 3px;border: 1px solid transparent;cursor: pointer;}.ace_folding-enabled .ace_fold-widget {display: inline-block; }.ace_fold-widget.ace_end {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAANElEQVR42m3HwQkAMAhD0YzsRchFKI7sAikeWkrxwScEB0nh5e7KTPWimZki4tYfVbX+MNl4pyZXejUO1QAAAABJRU5ErkJggg==");}.ace_fold-widget.ace_closed {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAAGCAYAAAAG5SQMAAAAOUlEQVR42jXKwQkAMAgDwKwqKD4EwQ26sSOkVWjgIIHAzPiCgaqiqnJHZnKICBERHN194O5b9vbLuAVRL+l0YWnZAAAAAElFTkSuQmCCXA==");}.ace_fold-widget:hover {border: 1px solid rgba(0, 0, 0, 0.3);background-color: rgba(255, 255, 255, 0.2);box-shadow: 0 1px 1px rgba(255, 255, 255, 0.7);}.ace_fold-widget:active {border: 1px solid rgba(0, 0, 0, 0.4);background-color: rgba(0, 0, 0, 0.05);box-shadow: 0 1px 1px rgba(255, 255, 255, 0.8);}.ace_dark .ace_fold-widget {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHklEQVQIW2P4//8/AzoGEQ7oGCaLLAhWiSwB146BAQCSTPYocqT0AAAAAElFTkSuQmCC");}.ace_dark .ace_fold-widget.ace_end {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAH0lEQVQIW2P4//8/AxQ7wNjIAjDMgC4AxjCVKBirIAAF0kz2rlhxpAAAAABJRU5ErkJggg==");}.ace_dark .ace_fold-widget.ace_closed {background-image: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAAFCAYAAACAcVaiAAAAHElEQVQIW2P4//+/AxAzgDADlOOAznHAKgPWAwARji8UIDTfQQAAAABJRU5ErkJggg==");}.ace_dark .ace_fold-widget:hover {box-shadow: 0 1px 1px rgba(255, 255, 255, 0.2);background-color: rgba(255, 255, 255, 0.1);}.ace_dark .ace_fold-widget:active {box-shadow: 0 1px 1px rgba(255, 255, 255, 0.2);}.ace_inline_button {border: 1px solid lightgray;display: inline-block;margin: -1px 8px;padding: 0 5px;pointer-events: auto;cursor: pointer;}.ace_inline_button:hover {border-color: gray;background: rgba(200,200,200,0.2);display: inline-block;pointer-events: auto;}.ace_fold-widget.ace_invalid {background-color: #FFB4B4;border-color: #DE5555;}.ace_fade-fold-widgets .ace_fold-widget {transition: opacity 0.4s ease 0.05s;opacity: 0;}.ace_fade-fold-widgets:hover .ace_fold-widget {transition: opacity 0.05s ease 0.05s;opacity:1;}.ace_underline {text-decoration: underline;}.ace_bold {font-weight: bold;}.ace_nobold .ace_bold {font-weight: normal;}.ace_italic {font-style: italic;}.ace_error-marker {background-color: rgba(255, 0, 0,0.2);position: absolute;z-index: 9;}.ace_highlight-marker {background-color: rgba(255, 255, 0,0.2);position: absolute;z-index: 8;}.ace_mobile-menu {position: absolute;line-height: 1.5;border-radius: 4px;-ms-user-select: none;-moz-user-select: none;-webkit-user-select: none;user-select: none;background: white;box-shadow: 1px 3px 2px grey;border: 1px solid #dcdcdc;color: black;}.ace_dark > .ace_mobile-menu {background: #333;color: #ccc;box-shadow: 1px 3px 2px grey;border: 1px solid #444;}.ace_mobile-button {padding: 2px;cursor: pointer;overflow: hidden;}.ace_mobile-button:hover {background-color: #eee;opacity:1;}.ace_mobile-button:active {background-color: #ddd;}.ace_placeholder {font-family: arial;transform: scale(0.9);transform-origin: left;white-space: pre;opacity: 0.7;margin: 0 10px;}',m=e("./lib/useragent"),g=m.isIE;i.importCssString(v,"ace_editor.css");var y=function(e,t){var n=this;this.container=e||i.createElement("div"),i.addCssClass(this.container,"ace_editor"),i.HI_DPI&&i.addCssClass(this.container,"ace_hidpi"),this.setTheme(t),this.$gutter=i.createElement("div"),this.$gutter.className="ace_gutter",this.container.appendChild(this.$gutter),this.$gutter.setAttribute("aria-hidden",!0),this.scroller=i.createElement("div"),this.scroller.className="ace_scroller",this.container.appendChild(this.scroller),this.content=i.createElement("div"),this.content.className="ace_content",this.scroller.appendChild(this.content),this.$gutterLayer=new o(this.$gutter),this.$gutterLayer.on("changeGutterWidth",this.onGutterResize.bind(this)),this.$markerBack=new u(this.content);var r=this.$textLayer=new a(this.content);this.canvas=r.element,this.$markerFront=new u(this.content),this.$cursorLayer=new f(this.content),this.$horizScroll=!1,this.$vScroll=!1,this.scrollBar=this.scrollBarV=new c(this.container,this),this.scrollBarH=new l(this.container,this),this.scrollBarV.on("scroll",function(e){n.$scrollAnimation||n.session.setScrollTop(e.data-n.scrollMargin.top)}),this.scrollBarH.on("scroll",function(e){n.$scrollAnimation||n.session.setScrollLeft(e.data-n.scrollMargin.left)}),this.scrollTop=0,this.scrollLeft=0,this.cursorPos={row:0,column:0},this.$fontMetrics=new p(this.container),this.$textLayer.$setFontMetrics(this.$fontMetrics),this.$textLayer.on("changeCharacterSize",function(e){n.updateCharacterSize(),n.onResize(!0,n.gutterWidth,n.$size.width,n.$size.height),n._signal("changeCharacterSize",e)}),this.$size={width:0,height:0,scrollerHeight:0,scrollerWidth:0,$dirty:!0},this.layerConfig={width:1,padding:0,firstRow:0,firstRowScreen:0,lastRow:0,lineHeight:0,characterWidth:0,minHeight:1,maxHeight:1,offset:0,height:1,gutterOffset:1},this.scrollMargin={left:0,right:0,top:0,bottom:0,v:0,h:0},this.margin={left:0,right:0,top:0,bottom:0,v:0,h:0},this.$keepTextAreaAtCursor=!m.isIOS,this.$loop=new h(this.$renderChanges.bind(this),this.container.ownerDocument.defaultView),this.$loop.schedule(this.CHANGE_FULL),this.updateCharacterSize(),this.setPadding(4),s.resetOptions(this),s._signal("renderer",this)};(function(){this.CHANGE_CURSOR=1,this.CHANGE_MARKER=2,this.CHANGE_GUTTER=4,this.CHANGE_SCROLL=8,this.CHANGE_LINES=16,this.CHANGE_TEXT=32,this.CHANGE_SIZE=64,this.CHANGE_MARKER_BACK=128,this.CHANGE_MARKER_FRONT=256,this.CHANGE_FULL=512,this.CHANGE_H_SCROLL=1024,r.implement(this,d),this.updateCharacterSize=function(){this.$textLayer.allowBoldFonts!=this.$allowBoldFonts&&(this.$allowBoldFonts=this.$textLayer.allowBoldFonts,this.setStyle("ace_nobold",!this.$allowBoldFonts)),this.layerConfig.characterWidth=this.characterWidth=this.$textLayer.getCharacterWidth(),this.layerConfig.lineHeight=this.lineHeight=this.$textLayer.getLineHeight(),this.$updatePrintMargin(),i.setStyle(this.scroller.style,"line-height",this.lineHeight+"px")},this.setSession=function(e){this.session&&this.session.doc.off("changeNewLineMode",this.onChangeNewLineMode),this.session=e,e&&this.scrollMargin.top&&e.getScrollTop()<=0&&e.setScrollTop(-this.scrollMargin.top),this.$cursorLayer.setSession(e),this.$markerBack.setSession(e),this.$markerFront.setSession(e),this.$gutterLayer.setSession(e),this.$textLayer.setSession(e);if(!e)return;this.$loop.schedule(this.CHANGE_FULL),this.session.$setFontMetrics(this.$fontMetrics),this.scrollBarH.scrollLeft=this.scrollBarV.scrollTop=null,this.onChangeNewLineMode=this.onChangeNewLineMode.bind(this),this.onChangeNewLineMode(),this.session.doc.on("changeNewLineMode",this.onChangeNewLineMode)},this.updateLines=function(e,t,n){t===undefined&&(t=Infinity),this.$changedLines?(this.$changedLines.firstRow>e&&(this.$changedLines.firstRow=e),this.$changedLines.lastRowthis.layerConfig.lastRow)return;this.$loop.schedule(this.CHANGE_LINES)},this.onChangeNewLineMode=function(){this.$loop.schedule(this.CHANGE_TEXT),this.$textLayer.$updateEolChar(),this.session.$bidiHandler.setEolChar(this.$textLayer.EOL_CHAR)},this.onChangeTabSize=function(){this.$loop.schedule(this.CHANGE_TEXT|this.CHANGE_MARKER),this.$textLayer.onChangeTabSize()},this.updateText=function(){this.$loop.schedule(this.CHANGE_TEXT)},this.updateFull=function(e){e?this.$renderChanges(this.CHANGE_FULL,!0):this.$loop.schedule(this.CHANGE_FULL)},this.updateFontSize=function(){this.$textLayer.checkForSizeChanges()},this.$changes=0,this.$updateSizeAsync=function(){this.$loop.pending?this.$size.$dirty=!0:this.onResize()},this.onResize=function(e,t,n,r){if(this.resizing>2)return;this.resizing>0?this.resizing++:this.resizing=e?1:0;var i=this.container;r||(r=i.clientHeight||i.scrollHeight),n||(n=i.clientWidth||i.scrollWidth);var s=this.$updateCachedSize(e,t,n,r);if(!this.$size.scrollerHeight||!n&&!r)return this.resizing=0;e&&(this.$gutterLayer.$padding=null),e?this.$renderChanges(s|this.$changes,!0):this.$loop.schedule(s|this.$changes),this.resizing&&(this.resizing=0),this.scrollBarV.scrollLeft=this.scrollBarV.scrollTop=null},this.$updateCachedSize=function(e,t,n,r){r-=this.$extraHeight||0;var s=0,o=this.$size,u={width:o.width,height:o.height,scrollerHeight:o.scrollerHeight,scrollerWidth:o.scrollerWidth};r&&(e||o.height!=r)&&(o.height=r,s|=this.CHANGE_SIZE,o.scrollerHeight=o.height,this.$horizScroll&&(o.scrollerHeight-=this.scrollBarH.getHeight()),this.scrollBarV.element.style.bottom=this.scrollBarH.getHeight()+"px",s|=this.CHANGE_SCROLL);if(n&&(e||o.width!=n)){s|=this.CHANGE_SIZE,o.width=n,t==null&&(t=this.$showGutter?this.$gutter.offsetWidth:0),this.gutterWidth=t,i.setStyle(this.scrollBarH.element.style,"left",t+"px"),i.setStyle(this.scroller.style,"left",t+this.margin.left+"px"),o.scrollerWidth=Math.max(0,n-t-this.scrollBarV.getWidth()-this.margin.h),i.setStyle(this.$gutter.style,"left",this.margin.left+"px");var a=this.scrollBarV.getWidth()+"px";i.setStyle(this.scrollBarH.element.style,"right",a),i.setStyle(this.scroller.style,"right",a),i.setStyle(this.scroller.style,"bottom",this.scrollBarH.getHeight());if(this.session&&this.session.getUseWrapMode()&&this.adjustWrapLimit()||e)s|=this.CHANGE_FULL}return o.$dirty=!n||!r,s&&this._signal("resize",u),s},this.onGutterResize=function(e){var t=this.$showGutter?e:0;t!=this.gutterWidth&&(this.$changes|=this.$updateCachedSize(!0,t,this.$size.width,this.$size.height)),this.session.getUseWrapMode()&&this.adjustWrapLimit()?this.$loop.schedule(this.CHANGE_FULL):this.$size.$dirty?this.$loop.schedule(this.CHANGE_FULL):this.$computeLayerConfig()},this.adjustWrapLimit=function(){var e=this.$size.scrollerWidth-this.$padding*2,t=Math.floor(e/this.characterWidth);return this.session.adjustWrapLimit(t,this.$showPrintMargin&&this.$printMarginColumn)},this.setAnimatedScroll=function(e){this.setOption("animatedScroll",e)},this.getAnimatedScroll=function(){return this.$animatedScroll},this.setShowInvisibles=function(e){this.setOption("showInvisibles",e),this.session.$bidiHandler.setShowInvisibles(e)},this.getShowInvisibles=function(){return this.getOption("showInvisibles")},this.getDisplayIndentGuides=function(){return this.getOption("displayIndentGuides")},this.setDisplayIndentGuides=function(e){this.setOption("displayIndentGuides",e)},this.setShowPrintMargin=function(e){this.setOption("showPrintMargin",e)},this.getShowPrintMargin=function(){return this.getOption("showPrintMargin")},this.setPrintMarginColumn=function(e){this.setOption("printMarginColumn",e)},this.getPrintMarginColumn=function(){return this.getOption("printMarginColumn")},this.getShowGutter=function(){return this.getOption("showGutter")},this.setShowGutter=function(e){return this.setOption("showGutter",e)},this.getFadeFoldWidgets=function(){return this.getOption("fadeFoldWidgets")},this.setFadeFoldWidgets=function(e){this.setOption("fadeFoldWidgets",e)},this.setHighlightGutterLine=function(e){this.setOption("highlightGutterLine",e)},this.getHighlightGutterLine=function(){return this.getOption("highlightGutterLine")},this.$updatePrintMargin=function(){if(!this.$showPrintMargin&&!this.$printMarginEl)return;if(!this.$printMarginEl){var e=i.createElement("div");e.className="ace_layer ace_print-margin-layer",this.$printMarginEl=i.createElement("div"),this.$printMarginEl.className="ace_print-margin",e.appendChild(this.$printMarginEl),this.content.insertBefore(e,this.content.firstChild)}var t=this.$printMarginEl.style;t.left=Math.round(this.characterWidth*this.$printMarginColumn+this.$padding)+"px",t.visibility=this.$showPrintMargin?"visible":"hidden",this.session&&this.session.$wrap==-1&&this.adjustWrapLimit()},this.getContainerElement=function(){return this.container},this.getMouseEventTarget=function(){return this.scroller},this.getTextAreaContainer=function(){return this.container},this.$moveTextAreaToCursor=function(){if(this.$isMousePressed)return;var e=this.textarea.style,t=this.$composition;if(!this.$keepTextAreaAtCursor&&!t){i.translate(this.textarea,-100,0);return}var n=this.$cursorLayer.$pixelPos;if(!n)return;t&&t.markerRange&&(n=this.$cursorLayer.getPixelPosition(t.markerRange.start,!0));var r=this.layerConfig,s=n.top,o=n.left;s-=r.offset;var u=t&&t.useTextareaForIME?this.lineHeight:g?0:1;if(s<0||s>r.height-u){i.translate(this.textarea,0,0);return}var a=1,f=this.$size.height-u;if(!t)s+=this.lineHeight;else if(t.useTextareaForIME){var l=this.textarea.value;a=this.characterWidth*this.session.$getStringScreenWidth(l)[0]}else s+=this.lineHeight+2;o-=this.scrollLeft,o>this.$size.scrollerWidth-a&&(o=this.$size.scrollerWidth-a),o+=this.gutterWidth+this.margin.left,i.setStyle(e,"height",u+"px"),i.setStyle(e,"width",a+"px"),i.translate(this.textarea,Math.min(o,this.$size.scrollerWidth-a),Math.min(s,f))},this.getFirstVisibleRow=function(){return this.layerConfig.firstRow},this.getFirstFullyVisibleRow=function(){return this.layerConfig.firstRow+(this.layerConfig.offset===0?0:1)},this.getLastFullyVisibleRow=function(){var e=this.layerConfig,t=e.lastRow,n=this.session.documentToScreenRow(t,0)*e.lineHeight;return n-this.session.getScrollTop()>e.height-e.lineHeight?t-1:t},this.getLastVisibleRow=function(){return this.layerConfig.lastRow},this.$padding=null,this.setPadding=function(e){this.$padding=e,this.$textLayer.setPadding(e),this.$cursorLayer.setPadding(e),this.$markerFront.setPadding(e),this.$markerBack.setPadding(e),this.$loop.schedule(this.CHANGE_FULL),this.$updatePrintMargin()},this.setScrollMargin=function(e,t,n,r){var i=this.scrollMargin;i.top=e|0,i.bottom=t|0,i.right=r|0,i.left=n|0,i.v=i.top+i.bottom,i.h=i.left+i.right,i.top&&this.scrollTop<=0&&this.session&&this.session.setScrollTop(-i.top),this.updateFull()},this.setMargin=function(e,t,n,r){var i=this.margin;i.top=e|0,i.bottom=t|0,i.right=r|0,i.left=n|0,i.v=i.top+i.bottom,i.h=i.left+i.right,this.$updateCachedSize(!0,this.gutterWidth,this.$size.width,this.$size.height),this.updateFull()},this.getHScrollBarAlwaysVisible=function(){return this.$hScrollBarAlwaysVisible},this.setHScrollBarAlwaysVisible=function(e){this.setOption("hScrollBarAlwaysVisible",e)},this.getVScrollBarAlwaysVisible=function(){return this.$vScrollBarAlwaysVisible},this.setVScrollBarAlwaysVisible=function(e){this.setOption("vScrollBarAlwaysVisible",e)},this.$updateScrollBarV=function(){var e=this.layerConfig.maxHeight,t=this.$size.scrollerHeight;!this.$maxLines&&this.$scrollPastEnd&&(e-=(t-this.lineHeight)*this.$scrollPastEnd,this.scrollTop>e-t&&(e=this.scrollTop+t,this.scrollBarV.scrollTop=null)),this.scrollBarV.setScrollHeight(e+this.scrollMargin.v),this.scrollBarV.setScrollTop(this.scrollTop+this.scrollMargin.top)},this.$updateScrollBarH=function(){this.scrollBarH.setScrollWidth(this.layerConfig.width+2*this.$padding+this.scrollMargin.h),this.scrollBarH.setScrollLeft(this.scrollLeft+this.scrollMargin.left)},this.$frozen=!1,this.freeze=function(){this.$frozen=!0},this.unfreeze=function(){this.$frozen=!1},this.$renderChanges=function(e,t){this.$changes&&(e|=this.$changes,this.$changes=0);if(!this.session||!this.container.offsetWidth||this.$frozen||!e&&!t){this.$changes|=e;return}if(this.$size.$dirty)return this.$changes|=e,this.onResize(!0);this.lineHeight||this.$textLayer.checkForSizeChanges(),this._signal("beforeRender",e),this.session&&this.session.$bidiHandler&&this.session.$bidiHandler.updateCharacterWidths(this.$fontMetrics);var n=this.layerConfig;if(e&this.CHANGE_FULL||e&this.CHANGE_SIZE||e&this.CHANGE_TEXT||e&this.CHANGE_LINES||e&this.CHANGE_SCROLL||e&this.CHANGE_H_SCROLL){e|=this.$computeLayerConfig()|this.$loop.clear();if(n.firstRow!=this.layerConfig.firstRow&&n.firstRowScreen==this.layerConfig.firstRowScreen){var r=this.scrollTop+(n.firstRow-this.layerConfig.firstRow)*this.lineHeight;r>0&&(this.scrollTop=r,e|=this.CHANGE_SCROLL,e|=this.$computeLayerConfig()|this.$loop.clear())}n=this.layerConfig,this.$updateScrollBarV(),e&this.CHANGE_H_SCROLL&&this.$updateScrollBarH(),i.translate(this.content,-this.scrollLeft,-n.offset);var s=n.width+2*this.$padding+"px",o=n.minHeight+"px";i.setStyle(this.content.style,"width",s),i.setStyle(this.content.style,"height",o)}e&this.CHANGE_H_SCROLL&&(i.translate(this.content,-this.scrollLeft,-n.offset),this.scroller.className=this.scrollLeft<=0?"ace_scroller":"ace_scroller ace_scroll-left");if(e&this.CHANGE_FULL){this.$changedLines=null,this.$textLayer.update(n),this.$showGutter&&this.$gutterLayer.update(n),this.$markerBack.update(n),this.$markerFront.update(n),this.$cursorLayer.update(n),this.$moveTextAreaToCursor(),this._signal("afterRender",e);return}if(e&this.CHANGE_SCROLL){this.$changedLines=null,e&this.CHANGE_TEXT||e&this.CHANGE_LINES?this.$textLayer.update(n):this.$textLayer.scrollLines(n),this.$showGutter&&(e&this.CHANGE_GUTTER||e&this.CHANGE_LINES?this.$gutterLayer.update(n):this.$gutterLayer.scrollLines(n)),this.$markerBack.update(n),this.$markerFront.update(n),this.$cursorLayer.update(n),this.$moveTextAreaToCursor(),this._signal("afterRender",e);return}e&this.CHANGE_TEXT?(this.$changedLines=null,this.$textLayer.update(n),this.$showGutter&&this.$gutterLayer.update(n)):e&this.CHANGE_LINES?(this.$updateLines()||e&this.CHANGE_GUTTER&&this.$showGutter)&&this.$gutterLayer.update(n):e&this.CHANGE_TEXT||e&this.CHANGE_GUTTER?this.$showGutter&&this.$gutterLayer.update(n):e&this.CHANGE_CURSOR&&this.$highlightGutterLine&&this.$gutterLayer.updateLineHighlight(n),e&this.CHANGE_CURSOR&&(this.$cursorLayer.update(n),this.$moveTextAreaToCursor()),e&(this.CHANGE_MARKER|this.CHANGE_MARKER_FRONT)&&this.$markerFront.update(n),e&(this.CHANGE_MARKER|this.CHANGE_MARKER_BACK)&&this.$markerBack.update(n),this._signal("afterRender",e)},this.$autosize=function(){var e=this.session.getScreenLength()*this.lineHeight,t=this.$maxLines*this.lineHeight,n=Math.min(t,Math.max((this.$minLines||1)*this.lineHeight,e))+this.scrollMargin.v+(this.$extraHeight||0);this.$horizScroll&&(n+=this.scrollBarH.getHeight()),this.$maxPixelHeight&&n>this.$maxPixelHeight&&(n=this.$maxPixelHeight);var r=n<=2*this.lineHeight,i=!r&&e>t;if(n!=this.desiredHeight||this.$size.height!=this.desiredHeight||i!=this.$vScroll){i!=this.$vScroll&&(this.$vScroll=i,this.scrollBarV.setVisible(i));var s=this.container.clientWidth;this.container.style.height=n+"px",this.$updateCachedSize(!0,this.$gutterWidth,s,n),this.desiredHeight=n,this._signal("autosize")}},this.$computeLayerConfig=function(){var e=this.session,t=this.$size,n=t.height<=2*this.lineHeight,r=this.session.getScreenLength(),i=r*this.lineHeight,s=this.$getLongestLine(),o=!n&&(this.$hScrollBarAlwaysVisible||t.scrollerWidth-s-2*this.$padding<0),u=this.$horizScroll!==o;u&&(this.$horizScroll=o,this.scrollBarH.setVisible(o));var a=this.$vScroll;this.$maxLines&&this.lineHeight>1&&this.$autosize();var f=t.scrollerHeight+this.lineHeight,l=!this.$maxLines&&this.$scrollPastEnd?(t.scrollerHeight-this.lineHeight)*this.$scrollPastEnd:0;i+=l;var c=this.scrollMargin;this.session.setScrollTop(Math.max(-c.top,Math.min(this.scrollTop,i-t.scrollerHeight+c.bottom))),this.session.setScrollLeft(Math.max(-c.left,Math.min(this.scrollLeft,s+2*this.$padding-t.scrollerWidth+c.right)));var h=!n&&(this.$vScrollBarAlwaysVisible||t.scrollerHeight-i+l<0||this.scrollTop>c.top),p=a!==h;p&&(this.$vScroll=h,this.scrollBarV.setVisible(h));var d=this.scrollTop%this.lineHeight,v=Math.ceil(f/this.lineHeight)-1,m=Math.max(0,Math.round((this.scrollTop-d)/this.lineHeight)),g=m+v,y,b,w=this.lineHeight;m=e.screenToDocumentRow(m,0);var E=e.getFoldLine(m);E&&(m=E.start.row),y=e.documentToScreenRow(m,0),b=e.getRowLength(m)*w,g=Math.min(e.screenToDocumentRow(g,0),e.getLength()-1),f=t.scrollerHeight+e.getRowLength(g)*w+b,d=this.scrollTop-y*w;var S=0;if(this.layerConfig.width!=s||u)S=this.CHANGE_H_SCROLL;if(u||p)S|=this.$updateCachedSize(!0,this.gutterWidth,t.width,t.height),this._signal("scrollbarVisibilityChanged"),p&&(s=this.$getLongestLine());return this.layerConfig={width:s,padding:this.$padding,firstRow:m,firstRowScreen:y,lastRow:g,lineHeight:w,characterWidth:this.characterWidth,minHeight:f,maxHeight:i,offset:d,gutterOffset:w?Math.max(0,Math.ceil((d+t.height-t.scrollerHeight)/w)):0,height:this.$size.scrollerHeight},this.session.$bidiHandler&&this.session.$bidiHandler.setContentWidth(s-this.$padding),S},this.$updateLines=function(){if(!this.$changedLines)return;var e=this.$changedLines.firstRow,t=this.$changedLines.lastRow;this.$changedLines=null;var n=this.layerConfig;if(e>n.lastRow+1)return;if(tthis.$textLayer.MAX_LINE_LENGTH&&(e=this.$textLayer.MAX_LINE_LENGTH+30),Math.max(this.$size.scrollerWidth-2*this.$padding,Math.round(e*this.characterWidth))},this.updateFrontMarkers=function(){this.$markerFront.setMarkers(this.session.getMarkers(!0)),this.$loop.schedule(this.CHANGE_MARKER_FRONT)},this.updateBackMarkers=function(){this.$markerBack.setMarkers(this.session.getMarkers()),this.$loop.schedule(this.CHANGE_MARKER_BACK)},this.addGutterDecoration=function(e,t){this.$gutterLayer.addGutterDecoration(e,t)},this.removeGutterDecoration=function(e,t){this.$gutterLayer.removeGutterDecoration(e,t)},this.updateBreakpoints=function(e){this.$loop.schedule(this.CHANGE_GUTTER)},this.setAnnotations=function(e){this.$gutterLayer.setAnnotations(e),this.$loop.schedule(this.CHANGE_GUTTER)},this.updateCursor=function(){this.$loop.schedule(this.CHANGE_CURSOR)},this.hideCursor=function(){this.$cursorLayer.hideCursor()},this.showCursor=function(){this.$cursorLayer.showCursor()},this.scrollSelectionIntoView=function(e,t,n){this.scrollCursorIntoView(e,n),this.scrollCursorIntoView(t,n)},this.scrollCursorIntoView=function(e,t,n){if(this.$size.scrollerHeight===0)return;var r=this.$cursorLayer.getPixelPosition(e),i=r.left,s=r.top,o=n&&n.top||0,u=n&&n.bottom||0,a=this.$scrollAnimation?this.session.getScrollTop():this.scrollTop;a+o>s?(t&&a+o>s+this.lineHeight&&(s-=t*this.$size.scrollerHeight),s===0&&(s=-this.scrollMargin.top),this.session.setScrollTop(s)):a+this.$size.scrollerHeight-ui?(i=1-this.scrollMargin.top)return!0;if(t>0&&this.session.getScrollTop()+this.$size.scrollerHeight-this.layerConfig.maxHeight<-1+this.scrollMargin.bottom)return!0;if(e<0&&this.session.getScrollLeft()>=1-this.scrollMargin.left)return!0;if(e>0&&this.session.getScrollLeft()+this.$size.scrollerWidth-this.layerConfig.width<-1+this.scrollMargin.right)return!0},this.pixelToScreenCoordinates=function(e,t){var n;if(this.$hasCssTransforms){n={top:0,left:0};var r=this.$fontMetrics.transformCoordinates([e,t]);e=r[1]-this.gutterWidth-this.margin.left,t=r[0]}else n=this.scroller.getBoundingClientRect();var i=e+this.scrollLeft-n.left-this.$padding,s=i/this.characterWidth,o=Math.floor((t+this.scrollTop-n.top)/this.lineHeight),u=this.$blockCursor?Math.floor(s):Math.round(s);return{row:o,column:u,side:s-u>0?1:-1,offsetX:i}},this.screenToTextCoordinates=function(e,t){var n;if(this.$hasCssTransforms){n={top:0,left:0};var r=this.$fontMetrics.transformCoordinates([e,t]);e=r[1]-this.gutterWidth-this.margin.left,t=r[0]}else n=this.scroller.getBoundingClientRect();var i=e+this.scrollLeft-n.left-this.$padding,s=i/this.characterWidth,o=this.$blockCursor?Math.floor(s):Math.round(s),u=Math.floor((t+this.scrollTop-n.top)/this.lineHeight);return this.session.screenToDocumentPosition(u,Math.max(o,0),i)},this.textToScreenCoordinates=function(e,t){var n=this.scroller.getBoundingClientRect(),r=this.session.documentToScreenPosition(e,t),i=this.$padding+(this.session.$bidiHandler.isBidiRow(r.row,e)?this.session.$bidiHandler.getPosLeft(r.column):Math.round(r.column*this.characterWidth)),s=r.row*this.lineHeight;return{pageX:n.left+i-this.scrollLeft,pageY:n.top+s-this.scrollTop}},this.visualizeFocus=function(){i.addCssClass(this.container,"ace_focus")},this.visualizeBlur=function(){i.removeCssClass(this.container,"ace_focus")},this.showComposition=function(e){this.$composition=e,e.cssText||(e.cssText=this.textarea.style.cssText),e.useTextareaForIME==undefined&&(e.useTextareaForIME=this.$useTextareaForIME),this.$useTextareaForIME?(i.addCssClass(this.textarea,"ace_composition"),this.textarea.style.cssText="",this.$moveTextAreaToCursor(),this.$cursorLayer.element.style.display="none"):e.markerId=this.session.addMarker(e.markerRange,"ace_composition_marker","text")},this.setCompositionText=function(e){var t=this.session.selection.cursor;this.addToken(e,"composition_placeholder",t.row,t.column),this.$moveTextAreaToCursor()},this.hideComposition=function(){if(!this.$composition)return;this.$composition.markerId&&this.session.removeMarker(this.$composition.markerId),i.removeCssClass(this.textarea,"ace_composition"),this.textarea.style.cssText=this.$composition.cssText;var e=this.session.selection.cursor;this.removeExtraToken(e.row,e.column),this.$composition=null,this.$cursorLayer.element.style.display=""},this.addToken=function(e,t,n,r){var i=this.session;i.bgTokenizer.lines[n]=null;var s={type:t,value:e},o=i.getTokens(n);if(r==null)o.push(s);else{var u=0;for(var a=0;a50&&e.length>this.$doc.getLength()>>1?this.call("setValue",[this.$doc.getValue()]):this.emit("change",{data:e})}}).call(f.prototype);var l=function(e,t,n){var r=null,i=!1,u=Object.create(s),a=[],l=new f({messageBuffer:a,terminate:function(){},postMessage:function(e){a.push(e);if(!r)return;i?setTimeout(c):c()}});l.setEmitSync=function(e){i=e};var c=function(){var e=a.shift();e.command?r[e.command].apply(r,e.args):e.event&&u._signal(e.event,e.data)};return u.postMessage=function(e){l.onMessage({data:e})},u.callback=function(e,t){this.postMessage({type:"call",id:t,data:e})},u.emit=function(e,t){this.postMessage({type:"event",name:e,data:t})},o.loadModule(["worker",t],function(e){r=new e[n](u);while(a.length)c()}),l};t.UIWorkerClient=l,t.WorkerClient=f,t.createWorker=a}),define("ace/placeholder",["require","exports","module","ace/range","ace/lib/event_emitter","ace/lib/oop"],function(e,t,n){"use strict";var r=e("./range").Range,i=e("./lib/event_emitter").EventEmitter,s=e("./lib/oop"),o=function(e,t,n,r,i,s){var o=this;this.length=t,this.session=e,this.doc=e.getDocument(),this.mainClass=i,this.othersClass=s,this.$onUpdate=this.onUpdate.bind(this),this.doc.on("change",this.$onUpdate),this.$others=r,this.$onCursorChange=function(){setTimeout(function(){o.onCursorChange()})},this.$pos=n;var u=e.getUndoManager().$undoStack||e.getUndoManager().$undostack||{length:-1};this.$undoStackDepth=u.length,this.setup(),e.selection.on("changeCursor",this.$onCursorChange)};(function(){s.implement(this,i),this.setup=function(){var e=this,t=this.doc,n=this.session;this.selectionBefore=n.selection.toJSON(),n.selection.inMultiSelectMode&&n.selection.toSingleRange(),this.pos=t.createAnchor(this.$pos.row,this.$pos.column);var i=this.pos;i.$insertRight=!0,i.detach(),i.markerId=n.addMarker(new r(i.row,i.column,i.row,i.column+this.length),this.mainClass,null,!1),this.others=[],this.$others.forEach(function(n){var r=t.createAnchor(n.row,n.column);r.$insertRight=!0,r.detach(),e.others.push(r)}),n.setUndoSelect(!1)},this.showOtherMarkers=function(){if(this.othersActive)return;var e=this.session,t=this;this.othersActive=!0,this.others.forEach(function(n){n.markerId=e.addMarker(new r(n.row,n.column,n.row,n.column+t.length),t.othersClass,null,!1)})},this.hideOtherMarkers=function(){if(!this.othersActive)return;this.othersActive=!1;for(var e=0;e=this.pos.column&&t.start.column<=this.pos.column+this.length+1,s=t.start.column-this.pos.column;this.updateAnchors(e),i&&(this.length+=n);if(i&&!this.session.$fromUndo)if(e.action==="insert")for(var o=this.others.length-1;o>=0;o--){var u=this.others[o],a={row:u.row,column:u.column+s};this.doc.insertMergedLines(a,e.lines)}else if(e.action==="remove")for(var o=this.others.length-1;o>=0;o--){var u=this.others[o],a={row:u.row,column:u.column+s};this.doc.remove(new r(a.row,a.column,a.row,a.column-n))}this.$updating=!1,this.updateMarkers()},this.updateAnchors=function(e){this.pos.onChange(e);for(var t=this.others.length;t--;)this.others[t].onChange(e);this.updateMarkers()},this.updateMarkers=function(){if(this.$updating)return;var e=this,t=this.session,n=function(n,i){t.removeMarker(n.markerId),n.markerId=t.addMarker(new r(n.row,n.column,n.row,n.column+e.length),i,null,!1)};n(this.pos,this.mainClass);for(var i=this.others.length;i--;)n(this.others[i],this.othersClass)},this.onCursorChange=function(e){if(this.$updating||!this.session)return;var t=this.session.selection.getCursor();t.row===this.pos.row&&t.column>=this.pos.column&&t.column<=this.pos.column+this.length?(this.showOtherMarkers(),this._emit("cursorEnter",e)):(this.hideOtherMarkers(),this._emit("cursorLeave",e))},this.detach=function(){this.session.removeMarker(this.pos&&this.pos.markerId),this.hideOtherMarkers(),this.doc.off("change",this.$onUpdate),this.session.selection.off("changeCursor",this.$onCursorChange),this.session.setUndoSelect(!0),this.session=null},this.cancel=function(){if(this.$undoStackDepth===-1)return;var e=this.session.getUndoManager(),t=(e.$undoStack||e.$undostack).length-this.$undoStackDepth;for(var n=0;n1?e.multiSelect.joinSelections():e.multiSelect.splitIntoLines()},bindKey:{win:"Ctrl-Alt-L",mac:"Ctrl-Alt-L"},readOnly:!0},{name:"splitSelectionIntoLines",description:"Split into lines",exec:function(e){e.multiSelect.splitIntoLines()},readOnly:!0},{name:"alignCursors",description:"Align cursors",exec:function(e){e.alignCursors()},bindKey:{win:"Ctrl-Alt-A",mac:"Ctrl-Alt-A"},scrollIntoView:"cursor"},{name:"findAll",description:"Find all",exec:function(e){e.findAll()},bindKey:{win:"Ctrl-Alt-K",mac:"Ctrl-Alt-G"},scrollIntoView:"cursor",readOnly:!0}],t.multiSelectCommands=[{name:"singleSelection",description:"Single selection",bindKey:"esc",exec:function(e){e.exitMultiSelectMode()},scrollIntoView:"cursor",readOnly:!0,isAvailable:function(e){return e&&e.inMultiSelectMode}}];var r=e("../keyboard/hash_handler").HashHandler;t.keyboardHandler=new r(t.multiSelectCommands)}),define("ace/multi_select",["require","exports","module","ace/range_list","ace/range","ace/selection","ace/mouse/multi_select_handler","ace/lib/event","ace/lib/lang","ace/commands/multi_select_commands","ace/search","ace/edit_session","ace/editor","ace/config"],function(e,t,n){function h(e,t,n){return c.$options.wrap=!0,c.$options.needle=t,c.$options.backwards=n==-1,c.find(e)}function v(e,t){return e.row==t.row&&e.column==t.column}function m(e){if(e.$multiselectOnSessionChange)return;e.$onAddRange=e.$onAddRange.bind(e),e.$onRemoveRange=e.$onRemoveRange.bind(e),e.$onMultiSelect=e.$onMultiSelect.bind(e),e.$onSingleSelect=e.$onSingleSelect.bind(e),e.$multiselectOnSessionChange=t.onSessionChange.bind(e),e.$checkMultiselectChange=e.$checkMultiselectChange.bind(e),e.$multiselectOnSessionChange(e),e.on("changeSession",e.$multiselectOnSessionChange),e.on("mousedown",o),e.commands.addCommands(f.defaultCommands),g(e)}function g(e){function r(t){n&&(e.renderer.setMouseCursor(""),n=!1)}if(!e.textInput)return;var t=e.textInput.getElement(),n=!1;u.addListener(t,"keydown",function(t){var i=t.keyCode==18&&!(t.ctrlKey||t.shiftKey||t.metaKey);e.$blockSelectEnabled&&i?n||(e.renderer.setMouseCursor("crosshair"),n=!0):n&&r()},e),u.addListener(t,"keyup",r,e),u.addListener(t,"blur",r,e)}var r=e("./range_list").RangeList,i=e("./range").Range,s=e("./selection").Selection,o=e("./mouse/multi_select_handler").onMouseDown,u=e("./lib/event"),a=e("./lib/lang"),f=e("./commands/multi_select_commands");t.commands=f.defaultCommands.concat(f.multiSelectCommands);var l=e("./search").Search,c=new l,p=e("./edit_session").EditSession;(function(){this.getSelectionMarkers=function(){return this.$selectionMarkers}}).call(p.prototype),function(){this.ranges=null,this.rangeList=null,this.addRange=function(e,t){if(!e)return;if(!this.inMultiSelectMode&&this.rangeCount===0){var n=this.toOrientedRange();this.rangeList.add(n),this.rangeList.add(e);if(this.rangeList.ranges.length!=2)return this.rangeList.removeAll(),t||this.fromOrientedRange(e);this.rangeList.removeAll(),this.rangeList.add(n),this.$onAddRange(n)}e.cursor||(e.cursor=e.end);var r=this.rangeList.add(e);return this.$onAddRange(e),r.length&&this.$onRemoveRange(r),this.rangeCount>1&&!this.inMultiSelectMode&&(this._signal("multiSelect"),this.inMultiSelectMode=!0,this.session.$undoSelect=!1,this.rangeList.attach(this.session)),t||this.fromOrientedRange(e)},this.toSingleRange=function(e){e=e||this.ranges[0];var t=this.rangeList.removeAll();t.length&&this.$onRemoveRange(t),e&&this.fromOrientedRange(e)},this.substractPoint=function(e){var t=this.rangeList.substractPoint(e);if(t)return this.$onRemoveRange(t),t[0]},this.mergeOverlappingRanges=function(){var e=this.rangeList.merge();e.length&&this.$onRemoveRange(e)},this.$onAddRange=function(e){this.rangeCount=this.rangeList.ranges.length,this.ranges.unshift(e),this._signal("addRange",{range:e})},this.$onRemoveRange=function(e){this.rangeCount=this.rangeList.ranges.length;if(this.rangeCount==1&&this.inMultiSelectMode){var t=this.rangeList.ranges.pop();e.push(t),this.rangeCount=0}for(var n=e.length;n--;){var r=this.ranges.indexOf(e[n]);this.ranges.splice(r,1)}this._signal("removeRange",{ranges:e}),this.rangeCount===0&&this.inMultiSelectMode&&(this.inMultiSelectMode=!1,this._signal("singleSelect"),this.session.$undoSelect=!0,this.rangeList.detach(this.session)),t=t||this.ranges[0],t&&!t.isEqual(this.getRange())&&this.fromOrientedRange(t)},this.$initRangeList=function(){if(this.rangeList)return;this.rangeList=new r,this.ranges=[],this.rangeCount=0},this.getAllRanges=function(){return this.rangeCount?this.rangeList.ranges.concat():[this.getRange()]},this.splitIntoLines=function(){var e=this.ranges.length?this.ranges:[this.getRange()],t=[];for(var n=0;n1){var e=this.rangeList.ranges,t=e[e.length-1],n=i.fromPoints(e[0].start,t.end);this.toSingleRange(),this.setSelectionRange(n,t.cursor==t.start)}else{var r=this.session.documentToScreenPosition(this.cursor),s=this.session.documentToScreenPosition(this.anchor),o=this.rectangularRangeBlock(r,s);o.forEach(this.addRange,this)}},this.rectangularRangeBlock=function(e,t,n){var r=[],s=e.column0)g--;if(g>0){var y=0;while(r[y].isEmpty())y++}for(var b=g;b>=y;b--)r[b].isEmpty()&&r.splice(b,1)}return r}}.call(s.prototype);var d=e("./editor").Editor;(function(){this.updateSelectionMarkers=function(){this.renderer.updateCursor(),this.renderer.updateBackMarkers()},this.addSelectionMarker=function(e){e.cursor||(e.cursor=e.end);var t=this.getSelectionStyle();return e.marker=this.session.addMarker(e,"ace_selection",t),this.session.$selectionMarkers.push(e),this.session.selectionMarkerCount=this.session.$selectionMarkers.length,e},this.removeSelectionMarker=function(e){if(!e.marker)return;this.session.removeMarker(e.marker);var t=this.session.$selectionMarkers.indexOf(e);t!=-1&&this.session.$selectionMarkers.splice(t,1),this.session.selectionMarkerCount=this.session.$selectionMarkers.length},this.removeSelectionMarkers=function(e){var t=this.session.$selectionMarkers;for(var n=e.length;n--;){var r=e[n];if(!r.marker)continue;this.session.removeMarker(r.marker);var i=t.indexOf(r);i!=-1&&t.splice(i,1)}this.session.selectionMarkerCount=t.length},this.$onAddRange=function(e){this.addSelectionMarker(e.range),this.renderer.updateCursor(),this.renderer.updateBackMarkers()},this.$onRemoveRange=function(e){this.removeSelectionMarkers(e.ranges),this.renderer.updateCursor(),this.renderer.updateBackMarkers()},this.$onMultiSelect=function(e){if(this.inMultiSelectMode)return;this.inMultiSelectMode=!0,this.setStyle("ace_multiselect"),this.keyBinding.addKeyboardHandler(f.keyboardHandler),this.commands.setDefaultHandler("exec",this.$onMultiSelectExec),this.renderer.updateCursor(),this.renderer.updateBackMarkers()},this.$onSingleSelect=function(e){if(this.session.multiSelect.inVirtualMode)return;this.inMultiSelectMode=!1,this.unsetStyle("ace_multiselect"),this.keyBinding.removeKeyboardHandler(f.keyboardHandler),this.commands.removeDefaultHandler("exec",this.$onMultiSelectExec),this.renderer.updateCursor(),this.renderer.updateBackMarkers(),this._emit("changeSelection")},this.$onMultiSelectExec=function(e){var t=e.command,n=e.editor;if(!n.multiSelect)return;if(!t.multiSelectAction){var r=t.exec(n,e.args||{});n.multiSelect.addRange(n.multiSelect.toOrientedRange()),n.multiSelect.mergeOverlappingRanges()}else t.multiSelectAction=="forEach"?r=n.forEachSelection(t,e.args):t.multiSelectAction=="forEachLine"?r=n.forEachSelection(t,e.args,!0):t.multiSelectAction=="single"?(n.exitMultiSelectMode(),r=t.exec(n,e.args||{})):r=t.multiSelectAction(n,e.args||{});return r},this.forEachSelection=function(e,t,n){if(this.inVirtualSelectionMode)return;var r=n&&n.keepOrder,i=n==1||n&&n.$byLines,o=this.session,u=this.selection,a=u.rangeList,f=(r?u:a).ranges,l;if(!f.length)return e.exec?e.exec(this,t||{}):e(this,t||{});var c=u._eventRegistry;u._eventRegistry={};var h=new s(o);this.inVirtualSelectionMode=!0;for(var p=f.length;p--;){if(i)while(p>0&&f[p].start.row==f[p-1].end.row)p--;h.fromOrientedRange(f[p]),h.index=p,this.selection=o.selection=h;var d=e.exec?e.exec(this,t||{}):e(this,t||{});!l&&d!==undefined&&(l=d),h.toOrientedRange(f[p])}h.detach(),this.selection=o.selection=u,this.inVirtualSelectionMode=!1,u._eventRegistry=c,u.mergeOverlappingRanges(),u.ranges[0]&&u.fromOrientedRange(u.ranges[0]);var v=this.renderer.$scrollAnimation;return this.onCursorChange(),this.onSelectionChange(),v&&v.from==v.to&&this.renderer.animateScrolling(v.from),l},this.exitMultiSelectMode=function(){if(!this.inMultiSelectMode||this.inVirtualSelectionMode)return;this.multiSelect.toSingleRange()},this.getSelectedText=function(){var e="";if(this.inMultiSelectMode&&!this.inVirtualSelectionMode){var t=this.multiSelect.rangeList.ranges,n=[];for(var r=0;r0);u<0&&(u=0),f>=c&&(f=c-1)}var p=this.session.removeFullLines(u,f);p=this.$reAlignText(p,l),this.session.insert({row:u,column:0},p.join("\n")+"\n"),l||(o.start.column=0,o.end.column=p[p.length-1].length),this.selection.setRange(o)}else{s.forEach(function(e){t.substractPoint(e.cursor)});var d=0,v=Infinity,m=n.map(function(t){var n=t.cursor,r=e.getLine(n.row),i=r.substr(n.column).search(/\S/g);return i==-1&&(i=0),n.column>d&&(d=n.column),io?e.insert(r,a.stringRepeat(" ",s-o)):e.remove(new i(r.row,r.column,r.row,r.column-s+o)),t.start.column=t.end.column=d,t.start.row=t.end.row=r.row,t.cursor=t.end}),t.fromOrientedRange(n[0]),this.renderer.updateCursor(),this.renderer.updateBackMarkers()}},this.$reAlignText=function(e,t){function u(e){return a.stringRepeat(" ",e)}function f(e){return e[2]?u(i)+e[2]+u(s-e[2].length+o)+e[4].replace(/^([=:])\s+/,"$1 "):e[0]}function l(e){return e[2]?u(i+s-e[2].length)+e[2]+u(o)+e[4].replace(/^([=:])\s+/,"$1 "):e[0]}function c(e){return e[2]?u(i)+e[2]+u(o)+e[4].replace(/^([=:])\s+/,"$1 "):e[0]}var n=!0,r=!0,i,s,o;return e.map(function(e){var t=e.match(/(\s*)(.*?)(\s*)([=:].*)/);return t?i==null?(i=t[1].length,s=t[2].length,o=t[3].length,t):(i+s+o!=t[1].length+t[2].length+t[3].length&&(r=!1),i!=t[1].length&&(n=!1),i>t[1].length&&(i=t[1].length),st[3].length&&(o=t[3].length),t):[e]}).map(t?f:n?r?l:f:c)}}).call(d.prototype),t.onSessionChange=function(e){var t=e.session;t&&!t.multiSelect&&(t.$selectionMarkers=[],t.selection.$initRangeList(),t.multiSelect=t.selection),this.multiSelect=t&&t.multiSelect;var n=e.oldSession;n&&(n.multiSelect.off("addRange",this.$onAddRange),n.multiSelect.off("removeRange",this.$onRemoveRange),n.multiSelect.off("multiSelect",this.$onMultiSelect),n.multiSelect.off("singleSelect",this.$onSingleSelect),n.multiSelect.lead.off("change",this.$checkMultiselectChange),n.multiSelect.anchor.off("change",this.$checkMultiselectChange)),t&&(t.multiSelect.on("addRange",this.$onAddRange),t.multiSelect.on("removeRange",this.$onRemoveRange),t.multiSelect.on("multiSelect",this.$onMultiSelect),t.multiSelect.on("singleSelect",this.$onSingleSelect),t.multiSelect.lead.on("change",this.$checkMultiselectChange),t.multiSelect.anchor.on("change",this.$checkMultiselectChange)),t&&this.inMultiSelectMode!=t.selection.inMultiSelectMode&&(t.selection.inMultiSelectMode?this.$onMultiSelect():this.$onSingleSelect())},t.MultiSelect=m,e("./config").defineOptions(d.prototype,"editor",{enableMultiselect:{set:function(e){m(this),e?(this.on("changeSession",this.$multiselectOnSessionChange),this.on("mousedown",o)):(this.off("changeSession",this.$multiselectOnSessionChange),this.off("mousedown",o))},value:!0},enableBlockSelect:{set:function(e){this.$blockSelectEnabled=e},value:!0}})}),define("ace/mode/folding/fold_mode",["require","exports","module","ace/range"],function(e,t,n){"use strict";var r=e("../../range").Range,i=t.FoldMode=function(){};(function(){this.foldingStartMarker=null,this.foldingStopMarker=null,this.getFoldWidget=function(e,t,n){var r=e.getLine(n);return this.foldingStartMarker.test(r)?"start":t=="markbeginend"&&this.foldingStopMarker&&this.foldingStopMarker.test(r)?"end":""},this.getFoldWidgetRange=function(e,t,n){return null},this.indentationBlock=function(e,t,n){var i=/\S/,s=e.getLine(t),o=s.search(i);if(o==-1)return;var u=n||s.length,a=e.getLength(),f=t,l=t;while(++tf){var p=e.getLine(l).length;return new r(f,u,l,p)}},this.openingBracketBlock=function(e,t,n,i,s){var o={row:n,column:i+1},u=e.$findClosingBracket(t,o,s);if(!u)return;var a=e.foldWidgets[u.row];return a==null&&(a=e.getFoldWidget(u.row)),a=="start"&&u.row>o.row&&(u.row--,u.column=e.getLine(u.row).length),r.fromPoints(o,u)},this.closingBracketBlock=function(e,t,n,i,s){var o={row:n,column:i},u=e.$findOpeningBracket(t,o);if(!u)return;return u.column++,o.column--,r.fromPoints(u,o)}}).call(i.prototype)}),define("ace/theme/textmate",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";t.isDark=!1,t.cssClass="ace-tm",t.cssText='.ace-tm .ace_gutter {background: #f0f0f0;color: #333;}.ace-tm .ace_print-margin {width: 1px;background: #e8e8e8;}.ace-tm .ace_fold {background-color: #6B72E6;}.ace-tm {background-color: #FFFFFF;color: black;}.ace-tm .ace_cursor {color: black;}.ace-tm .ace_invisible {color: rgb(191, 191, 191);}.ace-tm .ace_storage,.ace-tm .ace_keyword {color: blue;}.ace-tm .ace_constant {color: rgb(197, 6, 11);}.ace-tm .ace_constant.ace_buildin {color: rgb(88, 72, 246);}.ace-tm .ace_constant.ace_language {color: rgb(88, 92, 246);}.ace-tm .ace_constant.ace_library {color: rgb(6, 150, 14);}.ace-tm .ace_invalid {background-color: rgba(255, 0, 0, 0.1);color: red;}.ace-tm .ace_support.ace_function {color: rgb(60, 76, 114);}.ace-tm .ace_support.ace_constant {color: rgb(6, 150, 14);}.ace-tm .ace_support.ace_type,.ace-tm .ace_support.ace_class {color: rgb(109, 121, 222);}.ace-tm .ace_keyword.ace_operator {color: rgb(104, 118, 135);}.ace-tm .ace_string {color: rgb(3, 106, 7);}.ace-tm .ace_comment {color: rgb(76, 136, 107);}.ace-tm .ace_comment.ace_doc {color: rgb(0, 102, 255);}.ace-tm .ace_comment.ace_doc.ace_tag {color: rgb(128, 159, 191);}.ace-tm .ace_constant.ace_numeric {color: rgb(0, 0, 205);}.ace-tm .ace_variable {color: rgb(49, 132, 149);}.ace-tm .ace_xml-pe {color: rgb(104, 104, 91);}.ace-tm .ace_entity.ace_name.ace_function {color: #0000A2;}.ace-tm .ace_heading {color: rgb(12, 7, 255);}.ace-tm .ace_list {color:rgb(185, 6, 144);}.ace-tm .ace_meta.ace_tag {color:rgb(0, 22, 142);}.ace-tm .ace_string.ace_regex {color: rgb(255, 0, 0)}.ace-tm .ace_marker-layer .ace_selection {background: rgb(181, 213, 255);}.ace-tm.ace_multiselect .ace_selection.ace_start {box-shadow: 0 0 3px 0px white;}.ace-tm .ace_marker-layer .ace_step {background: rgb(252, 255, 0);}.ace-tm .ace_marker-layer .ace_stack {background: rgb(164, 229, 101);}.ace-tm .ace_marker-layer .ace_bracket {margin: -1px 0 0 -1px;border: 1px solid rgb(192, 192, 192);}.ace-tm .ace_marker-layer .ace_active-line {background: rgba(0, 0, 0, 0.07);}.ace-tm .ace_gutter-active-line {background-color : #dcdcdc;}.ace-tm .ace_marker-layer .ace_selected-word {background: rgb(250, 250, 255);border: 1px solid rgb(200, 200, 250);}.ace-tm .ace_indent-guide {background: url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAE0lEQVQImWP4////f4bLly//BwAmVgd1/w11/gAAAABJRU5ErkJggg==") right repeat-y;}',t.$id="ace/theme/textmate";var r=e("../lib/dom");r.importCssString(t.cssText,t.cssClass)}),define("ace/line_widgets",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";function i(e){this.session=e,this.session.widgetManager=this,this.session.getRowLength=this.getRowLength,this.session.$getWidgetScreenLength=this.$getWidgetScreenLength,this.updateOnChange=this.updateOnChange.bind(this),this.renderWidgets=this.renderWidgets.bind(this),this.measureWidgets=this.measureWidgets.bind(this),this.session._changedWidgets=[],this.$onChangeEditor=this.$onChangeEditor.bind(this),this.session.on("change",this.updateOnChange),this.session.on("changeFold",this.updateOnFold),this.session.on("changeEditor",this.$onChangeEditor)}var r=e("./lib/dom");(function(){this.getRowLength=function(e){var t;return this.lineWidgets?t=this.lineWidgets[e]&&this.lineWidgets[e].rowCount||0:t=0,!this.$useWrapMode||!this.$wrapData[e]?1+t:this.$wrapData[e].length+1+t},this.$getWidgetScreenLength=function(){var e=0;return this.lineWidgets.forEach(function(t){t&&t.rowCount&&!t.hidden&&(e+=t.rowCount)}),e},this.$onChangeEditor=function(e){this.attach(e.editor)},this.attach=function(e){e&&e.widgetManager&&e.widgetManager!=this&&e.widgetManager.detach();if(this.editor==e)return;this.detach(),this.editor=e,e&&(e.widgetManager=this,e.renderer.on("beforeRender",this.measureWidgets),e.renderer.on("afterRender",this.renderWidgets))},this.detach=function(e){var t=this.editor;if(!t)return;this.editor=null,t.widgetManager=null,t.renderer.off("beforeRender",this.measureWidgets),t.renderer.off("afterRender",this.renderWidgets);var n=this.session.lineWidgets;n&&n.forEach(function(e){e&&e.el&&e.el.parentNode&&(e._inDocument=!1,e.el.parentNode.removeChild(e.el))})},this.updateOnFold=function(e,t){var n=t.lineWidgets;if(!n||!e.action)return;var r=e.data,i=r.start.row,s=r.end.row,o=e.action=="add";for(var u=i+1;ut[n].column&&n++,s.unshift(n,0),t.splice.apply(t,s),this.$updateRows()}},this.$updateRows=function(){var e=this.session.lineWidgets;if(!e)return;var t=!0;e.forEach(function(e,n){if(e){t=!1,e.row=n;while(e.$oldWidget)e.$oldWidget.row=n,e=e.$oldWidget}}),t&&(this.session.lineWidgets=null)},this.$registerLineWidget=function(e){this.session.lineWidgets||(this.session.lineWidgets=new Array(this.session.getLength()));var t=this.session.lineWidgets[e.row];return t&&(e.$oldWidget=t,t.el&&t.el.parentNode&&(t.el.parentNode.removeChild(t.el),t._inDocument=!1)),this.session.lineWidgets[e.row]=e,e},this.addLineWidget=function(e){this.$registerLineWidget(e),e.session=this.session;if(!this.editor)return e;var t=this.editor.renderer;e.html&&!e.el&&(e.el=r.createElement("div"),e.el.innerHTML=e.html),e.el&&(r.addCssClass(e.el,"ace_lineWidgetContainer"),e.el.style.position="absolute",e.el.style.zIndex=5,t.container.appendChild(e.el),e._inDocument=!0,e.coverGutter||(e.el.style.zIndex=3),e.pixelHeight==null&&(e.pixelHeight=e.el.offsetHeight)),e.rowCount==null&&(e.rowCount=e.pixelHeight/t.layerConfig.lineHeight);var n=this.session.getFoldAt(e.row,0);e.$fold=n;if(n){var i=this.session.lineWidgets;e.row==n.end.row&&!i[n.start.row]?i[n.start.row]=e:e.hidden=!0}return this.session._emit("changeFold",{data:{start:{row:e.row}}}),this.$updateRows(),this.renderWidgets(null,t),this.onWidgetChanged(e),e},this.removeLineWidget=function(e){e._inDocument=!1,e.session=null,e.el&&e.el.parentNode&&e.el.parentNode.removeChild(e.el);if(e.editor&&e.editor.destroy)try{e.editor.destroy()}catch(t){}if(this.session.lineWidgets){var n=this.session.lineWidgets[e.row];if(n==e)this.session.lineWidgets[e.row]=e.$oldWidget,e.$oldWidget&&this.onWidgetChanged(e.$oldWidget);else while(n){if(n.$oldWidget==e){n.$oldWidget=e.$oldWidget;break}n=n.$oldWidget}}this.session._emit("changeFold",{data:{start:{row:e.row}}}),this.$updateRows()},this.getWidgetsAtRow=function(e){var t=this.session.lineWidgets,n=t&&t[e],r=[];while(n)r.push(n),n=n.$oldWidget;return r},this.onWidgetChanged=function(e){this.session._changedWidgets.push(e),this.editor&&this.editor.renderer.updateFull()},this.measureWidgets=function(e,t){var n=this.session._changedWidgets,r=t.layerConfig;if(!n||!n.length)return;var i=Infinity;for(var s=0;s0&&!r[i])i--;this.firstRow=n.firstRow,this.lastRow=n.lastRow,t.$cursorLayer.config=n;for(var o=i;o<=s;o++){var u=r[o];if(!u||!u.el)continue;if(u.hidden){u.el.style.top=-100-(u.pixelHeight||0)+"px";continue}u._inDocument||(u._inDocument=!0,t.container.appendChild(u.el));var a=t.$cursorLayer.getPixelPosition({row:o,column:0},!0).top;u.coverLine||(a+=n.lineHeight*this.session.getRowLineCount(u.row)),u.el.style.top=a-n.offset+"px";var f=u.coverGutter?0:t.gutterWidth;u.fixedWidth||(f-=t.scrollLeft),u.el.style.left=f+"px",u.fullWidth&&u.screenWidth&&(u.el.style.minWidth=n.width+2*n.padding+"px"),u.fixedWidth?u.el.style.right=t.scrollBar.getWidth()+"px":u.el.style.right=""}}}).call(i.prototype),t.LineWidgets=i}),define("ace/ext/error_marker",["require","exports","module","ace/line_widgets","ace/lib/dom","ace/range"],function(e,t,n){"use strict";function o(e,t,n){var r=0,i=e.length-1;while(r<=i){var s=r+i>>1,o=n(t,e[s]);if(o>0)r=s+1;else{if(!(o<0))return s;i=s-1}}return-(r+1)}function u(e,t,n){var r=e.getAnnotations().sort(s.comparePoints);if(!r.length)return;var i=o(r,{row:t,column:-1},s.comparePoints);i<0&&(i=-i-1),i>=r.length?i=n>0?0:r.length-1:i===0&&n<0&&(i=r.length-1);var u=r[i];if(!u||!n)return;if(u.row===t){do u=r[i+=n];while(u&&u.row===t);if(!u)return r.slice()}var a=[];t=u.row;do a[n<0?"unshift":"push"](u),u=r[i+=n];while(u&&u.row==t);return a.length&&a}var r=e("../line_widgets").LineWidgets,i=e("../lib/dom"),s=e("../range").Range;t.showErrorMarker=function(e,t){var n=e.session;n.widgetManager||(n.widgetManager=new r(n),n.widgetManager.attach(e));var s=e.getCursorPosition(),o=s.row,a=n.widgetManager.getWidgetsAtRow(o).filter(function(e){return e.type=="errorMarker"})[0];a?a.destroy():o-=t;var f=u(n,o,t),l;if(f){var c=f[0];s.column=(c.pos&&typeof c.column!="number"?c.pos.sc:c.column)||0,s.row=c.row,l=e.renderer.$gutterLayer.$annotations[s.row]}else{if(a)return;l={text:["Looks good!"],className:"ace_ok"}}e.session.unfold(s.row),e.selection.moveToPosition(s);var h={row:s.row,fixedWidth:!0,coverGutter:!0,el:i.createElement("div"),type:"errorMarker"},p=h.el.appendChild(i.createElement("div")),d=h.el.appendChild(i.createElement("div"));d.className="error_widget_arrow "+l.className;var v=e.renderer.$cursorLayer.getPixelPosition(s).left;d.style.left=v+e.renderer.gutterWidth-5+"px",h.el.className="error_widget_wrapper",p.className="error_widget "+l.className,p.innerHTML=l.text.join("
        "),p.appendChild(i.createElement("div"));var m=function(e,t,n){if(t===0&&(n==="esc"||n==="return"))return h.destroy(),{command:"null"}};h.destroy=function(){if(e.$mouseHandler.isMousePressed)return;e.keyBinding.removeKeyboardHandler(m),n.widgetManager.removeLineWidget(h),e.off("changeSelection",h.destroy),e.off("changeSession",h.destroy),e.off("mouseup",h.destroy),e.off("change",h.destroy)},e.keyBinding.addKeyboardHandler(m),e.on("changeSelection",h.destroy),e.on("changeSession",h.destroy),e.on("mouseup",h.destroy),e.on("change",h.destroy),e.session.widgetManager.addLineWidget(h),h.el.onmousedown=e.focus.bind(e),e.renderer.scrollCursorIntoView(null,.5,{bottom:h.el.offsetHeight})},i.importCssString(" .error_widget_wrapper { background: inherit; color: inherit; border:none } .error_widget { border-top: solid 2px; border-bottom: solid 2px; margin: 5px 0; padding: 10px 40px; white-space: pre-wrap; } .error_widget.ace_error, .error_widget_arrow.ace_error{ border-color: #ff5a5a } .error_widget.ace_warning, .error_widget_arrow.ace_warning{ border-color: #F1D817 } .error_widget.ace_info, .error_widget_arrow.ace_info{ border-color: #5a5a5a } .error_widget.ace_ok, .error_widget_arrow.ace_ok{ border-color: #5aaa5a } .error_widget_arrow { position: absolute; border: solid 5px; border-top-color: transparent!important; border-right-color: transparent!important; border-left-color: transparent!important; top: -5px; }","")}),define("ace/ace",["require","exports","module","ace/lib/fixoldbrowsers","ace/lib/dom","ace/lib/event","ace/range","ace/editor","ace/edit_session","ace/undomanager","ace/virtual_renderer","ace/worker/worker_client","ace/keyboard/hash_handler","ace/placeholder","ace/multi_select","ace/mode/folding/fold_mode","ace/theme/textmate","ace/ext/error_marker","ace/config"],function(e,t,n){"use strict";e("./lib/fixoldbrowsers");var r=e("./lib/dom"),i=e("./lib/event"),s=e("./range").Range,o=e("./editor").Editor,u=e("./edit_session").EditSession,a=e("./undomanager").UndoManager,f=e("./virtual_renderer").VirtualRenderer;e("./worker/worker_client"),e("./keyboard/hash_handler"),e("./placeholder"),e("./multi_select"),e("./mode/folding/fold_mode"),e("./theme/textmate"),e("./ext/error_marker"),t.config=e("./config"),t.require=e,typeof define=="function"&&(t.define=define),t.edit=function(e,n){if(typeof e=="string"){var s=e;e=document.getElementById(s);if(!e)throw new Error("ace.edit can't find div #"+s)}if(e&&e.env&&e.env.editor instanceof o)return e.env.editor;var u="";if(e&&/input|textarea/i.test(e.tagName)){var a=e;u=a.value,e=r.createElement("pre"),a.parentNode.replaceChild(e,a)}else e&&(u=e.textContent,e.innerHTML="");var l=t.createEditSession(u),c=new o(new f(e),l,n),h={document:l,editor:c,onResize:c.resize.bind(c,null)};return a&&(h.textarea=a),i.addListener(window,"resize",h.onResize),c.on("destroy",function(){i.removeListener(window,"resize",h.onResize),h.editor.container.env=null}),c.container.env=c.env=h,c},t.createEditSession=function(e,t){var n=new u(e,t);return n.setUndoManager(new a),n},t.Range=s,t.Editor=o,t.EditSession=u,t.UndoManager=a,t.VirtualRenderer=f,t.version=t.config.version}); (function() { + window.require(["ace/ace"], function(a) { + if (a) { + a.config.init(true); + a.define = window.define; + } + if (!window.ace) + window.ace = a; + for (var key in a) if (a.hasOwnProperty(key)) + window.ace[key] = a[key]; + window.ace["default"] = window.ace; + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = window.ace; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-beautify.js b/data/static/vendor/src-min/ext-beautify.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-beautify.js @@ -0,0 +1,8 @@ +define("ace/ext/beautify",["require","exports","module","ace/token_iterator"],function(e,t,n){"use strict";function i(e,t){return e.type.lastIndexOf(t+".xml")>-1}var r=e("../token_iterator").TokenIterator;t.singletonTags=["area","base","br","col","command","embed","hr","html","img","input","keygen","link","meta","param","source","track","wbr"],t.blockTags=["article","aside","blockquote","body","div","dl","fieldset","footer","form","head","header","html","nav","ol","p","script","section","style","table","tbody","tfoot","thead","ul"],t.beautify=function(e){var n=new r(e,0,0),s=n.getCurrentToken(),o=e.getTabString(),u=t.singletonTags,a=t.blockTags,f,l=!1,c=!1,h=!1,p="",d="",v="",m=0,g=0,y=0,b=0,w=0,E=0,S=0,x,T=0,N=0,C=[],k=!1,L,A=!1,O=!1,M=!1,_=!1,D={0:0},P=[],H=function(){f&&f.value&&f.type!=="string.regexp"&&(f.value=f.value.replace(/^\s*/,""))},B=function(){p=p.replace(/ +$/,"")},j=function(){p=p.trimRight(),l=!1};while(s!==null){T=n.getCurrentTokenRow(),C=n.$rowTokens,f=n.stepForward();if(typeof s!="undefined"){d=s.value,w=0,M=v==="style"||e.$modeId==="ace/mode/css",i(s,"tag-open")?(O=!0,f&&(_=a.indexOf(f.value)!==-1),d==="0;N--)p+="\n";l=!0,!i(s,"comment")&&!s.type.match(/^(comment|string)$/)&&(d=d.trimLeft())}if(d){s.type==="keyword"&&d.match(/^(if|else|elseif|for|foreach|while|switch)$/)?(P[m]=d,H(),h=!0,d.match(/^(else|elseif)$/)&&p.match(/\}[\s]*$/)&&(j(),c=!0)):s.type==="paren.lparen"?(H(),d.substr(-1)==="{"&&(h=!0,A=!1,O||(N=1)),d.substr(0,1)==="{"&&(c=!0,p.substr(-1)!=="["&&p.trimRight().substr(-1)==="["?(j(),c=!1):p.trimRight().substr(-1)===")"?j():B())):s.type==="paren.rparen"?(w=1,d.substr(0,1)==="}"&&(P[m-1]==="case"&&w++,p.trimRight().substr(-1)==="{"?j():(c=!0,M&&(N+=2))),d.substr(0,1)==="]"&&p.substr(-1)!=="}"&&p.trimRight().substr(-1)==="}"&&(c=!1,b++,j()),d.substr(0,1)===")"&&p.substr(-1)!=="("&&p.trimRight().substr(-1)==="("&&(c=!1,b++,j()),B()):s.type!=="keyword.operator"&&s.type!=="keyword"||!d.match(/^(=|==|===|!=|!==|&&|\|\||and|or|xor|\+=|.=|>|>=|<|<=|=>)$/)?s.type==="punctuation.operator"&&d===";"?(j(),H(),h=!0,M&&N++):s.type==="punctuation.operator"&&d.match(/^(:|,)$/)?(j(),H(),d.match(/^(,)$/)&&S>0&&E===0?N++:(h=!0,l=!1)):s.type==="support.php_tag"&&d==="?>"&&!l?(j(),c=!0):i(s,"attribute-name")&&p.substr(-1).match(/^\s$/)?c=!0:i(s,"attribute-equals")?(B(),H()):i(s,"tag-close")&&(B(),d==="/>"&&(c=!0)):(j(),H(),c=!0,h=!0);if(l&&(!s.type.match(/^(comment)$/)||!!d.substr(0,1).match(/^[/#]$/))&&(!s.type.match(/^(string)$/)||!!d.substr(0,1).match(/^['"]$/))){b=y;if(m>g){b++;for(L=m;L>g;L--)D[L]=b}else m")_&&f&&f.value===""&&u.indexOf(v)===-1&&m--,x=T}}s=f}p=p.trim(),e.doc.setValue(p)},t.commands=[{name:"beautify",description:"Format selection (Beautify)",exec:function(e){t.beautify(e.session)},bindKey:"Ctrl-Shift-B"}]}); (function() { + window.require(["ace/ext/beautify"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-code_lens.js b/data/static/vendor/src-min/ext-code_lens.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-code_lens.js @@ -0,0 +1,8 @@ +define("ace/ext/code_lens",["require","exports","module","ace/line_widgets","ace/lib/event","ace/lib/lang","ace/lib/dom","ace/editor","ace/config"],function(e,t,n){"use strict";function u(e){var t=e.$textLayer,n=t.$lenses;n&&n.forEach(function(e){e.remove()}),t.$lenses=null}function a(e,t){var n=e&t.CHANGE_LINES||e&t.CHANGE_FULL||e&t.CHANGE_SCROLL||e&t.CHANGE_TEXT;if(!n)return;var r=t.session,i=t.session.lineWidgets,s=t.$textLayer,a=s.$lenses;if(!i){a&&u(t);return}var f=t.$textLayer.$lines.cells,l=t.layerConfig,c=t.$padding;a||(a=s.$lenses=[]);var h=0;for(var p=0;p2*y-1)g.lastChild.remove();var w=t.$cursorLayer.getPixelPosition({row:d,column:0},!0).top-l.lineHeight*v.rowsAbove-l.offset;g.style.top=w+"px";var E=t.gutterWidth,S=r.getLine(d).search(/\S|$/);S==-1&&(S=0),E+=S*l.characterWidth,E-=t.scrollLeft,g.style.paddingLeft=c+E+"px"}while(h1)return;var u=n.documentToScreenRow(r),a=e.renderer.layerConfig.lineHeight,f=n.getScrollTop()+(u-i)*a;n.setScrollTop(f)}var n=e.session;if(!n)return;n.widgetManager||(n.widgetManager=new r(n),n.widgetManager.attach(e));var i=e.codeLensProviders.length,s=[];e.codeLensProviders.forEach(function(e){e.provideCodeLenses(n,function(e,t){if(e)return;t.forEach(function(e){s.push(e)}),i--,i==0&&o()})})};var n=s.delayedCall(e.$updateLenses);e.$updateLensesOnInput=function(){n.delay(250)},e.on("input",e.$updateLensesOnInput)}function c(e){e.off("input",e.$updateLensesOnInput),e.renderer.off("afterRender",a),e.$codeLensClickHandler&&e.container.removeEventListener("click",e.$codeLensClickHandler)}var r=e("../line_widgets").LineWidgets,i=e("../lib/event"),s=e("../lib/lang"),o=e("../lib/dom");t.setLenses=function(e,t){var n=Number.MAX_VALUE;f(e),t&&t.forEach(function(t){var r=t.start.row,i=t.start.column,s=e.lineWidgets&&e.lineWidgets[r];if(!s||!s.lenses)s=e.widgetManager.$registerLineWidget({rowCount:1,rowsAbove:1,row:r,column:i,lenses:[]});s.lenses.push(t.command),r a { cursor: pointer; pointer-events: auto;}.ace_codeLens > a:hover { color: #0000ff; text-decoration: underline;}.ace_dark > .ace_codeLens > a:hover { color: #4e94ce;}","")}); (function() { + window.require(["ace/ext/code_lens"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-elastic_tabstops_lite.js b/data/static/vendor/src-min/ext-elastic_tabstops_lite.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-elastic_tabstops_lite.js @@ -0,0 +1,8 @@ +define("ace/ext/elastic_tabstops_lite",["require","exports","module","ace/editor","ace/config"],function(e,t,n){"use strict";var r=function(e){this.$editor=e;var t=this,n=[],r=!1;this.onAfterExec=function(){r=!1,t.processRows(n),n=[]},this.onExec=function(){r=!0},this.onChange=function(e){r&&(n.indexOf(e.start.row)==-1&&n.push(e.start.row),e.end.row!=e.start.row&&n.push(e.end.row))}};(function(){this.processRows=function(e){this.$inChange=!0;var t=[];for(var n=0,r=e.length;n-1)continue;var s=this.$findCellWidthsForBlock(i),o=this.$setBlockCellWidthsToMax(s.cellWidths),u=s.firstRow;for(var a=0,f=o.length;a=0){n=this.$cellWidthsForRow(r);if(n.length==0)break;t.unshift(n),r--}var i=r+1;r=e;var s=this.$editor.session.getLength();while(r0&&(this.$editor.session.getDocument().insertInLine({row:e,column:f+1},Array(l+1).join(" ")+" "),this.$editor.session.getDocument().removeInLine(e,f,f+1),r+=l),l<0&&p>=-l&&(this.$editor.session.getDocument().removeInLine(e,f+l,f),r+=l)}},this.$izip_longest=function(e){if(!e[0])return[];var t=e[0].length,n=e.length;for(var r=1;rt&&(t=i)}var s=[];for(var o=0;o=t.length?t.length:e.length,r=[];for(var i=0;i"a"}),[e]}},{regex:"/\\w*}",onMatch:function(e,t,n){var r=n.shift();return r&&(r.flag=e.slice(1,-1)),this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"},{regex:/\$(?:\d+|\w+)/,onMatch:function(e,t,n){return[{text:e.slice(1)}]}},{regex:/\${\w+/,onMatch:function(e,t,n){var r={text:e.slice(2)};return n.unshift(r),[r]},next:"formatStringVar"},{regex:/\n/,token:"newline",merge:!1},{regex:/}/,onMatch:function(e,t,n){var r=n.shift();return this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"}],formatStringVar:[{regex:/:\/\w+}/,onMatch:function(e,t,n){var r=n[0];return r.formatFunction=e.slice(2,-1),[n.shift()]},next:"formatString"},n,{regex:/:[\?\-+]?/,onMatch:function(e,t,n){e[1]=="+"&&(n[0].ifEnd=n[0]),e[1]=="?"&&(n[0].expectElse=!0)},next:"formatString"},{regex:"([^:}\\\\]|\\\\.)*:?",token:"",next:"formatString"}]}),p.$tokenizer},this.tokenizeTmSnippet=function(e,t){return this.getTokenizer().getLineTokens(e,t).tokens.map(function(e){return e.value||e})},this.getVariableValue=function(e,t,n){if(/^\d+$/.test(t))return(this.variables.__||{})[t]||"";if(/^[A-Z]\d+$/.test(t))return(this.variables[t[0]+"__"]||{})[t.substr(1)]||"";t=t.replace(/^TM_/,"");if(!this.variables.hasOwnProperty(t))return"";var r=this.variables[t];return typeof r=="function"&&(r=this.variables[t](e,t,n)),r==null?"":r},this.variables=c,this.tmStrFormat=function(e,t,n){if(!t.fmt)return e;var r=t.flag||"",i=t.guard;i=new RegExp(i,r.replace(/[^gim]/g,""));var s=typeof t.fmt=="string"?this.tokenizeTmSnippet(t.fmt,"formatString"):t.fmt,o=this,u=e.replace(i,function(){var e=o.variables.__;o.variables.__=[].slice.call(arguments);var t=o.resolveVariables(s,n),r="E";for(var i=0;i1?(y=t[t.length-1].length,g+=t.length-1):y+=e.length,b+=e}else e&&(e.start?e.end={row:g,column:y}:e.start={row:g,column:y})});var w=e.getSelectionRange(),E=e.session.replace(w,b),S=new d(e),x=e.inVirtualSelectionMode&&e.selection.index;S.addTabstops(u,w.start,E,x)},this.insertSnippet=function(e,t){var n=this;if(e.inVirtualSelectionMode)return n.insertSnippetForSelection(e,t);e.forEachSelection(function(){n.insertSnippetForSelection(e,t)},null,{keepOrder:!0}),e.tabstopManager&&e.tabstopManager.tabNext()},this.$getScope=function(e){var t=e.session.$mode.$id||"";t=t.split("/").pop();if(t==="html"||t==="php"){t==="php"&&!e.session.$mode.inlinePhp&&(t="html");var n=e.getCursorPosition(),r=e.session.getState(n.row);typeof r=="object"&&(r=r[0]),r.substring&&(r.substring(0,3)=="js-"?t="javascript":r.substring(0,4)=="css-"?t="css":r.substring(0,4)=="php-"&&(t="php"))}return t},this.getActiveScopes=function(e){var t=this.$getScope(e),n=[t],r=this.snippetMap;return r[t]&&r[t].includeScopes&&n.push.apply(n,r[t].includeScopes),n.push("_"),n},this.expandWithTab=function(e,t){var n=this,r=e.forEachSelection(function(){return n.expandSnippetForSelection(e,t)},null,{keepOrder:!0});return r&&e.tabstopManager&&e.tabstopManager.tabNext(),r},this.expandSnippetForSelection=function(e,t){var n=e.getCursorPosition(),r=e.session.getLine(n.row),i=r.substring(0,n.column),s=r.substr(n.column),o=this.snippetMap,u;return this.getActiveScopes(e).some(function(e){var t=o[e];return t&&(u=this.findMatchingSnippet(t,i,s)),!!u},this),u?t&&t.dryRun?!0:(e.session.doc.removeInLine(n.row,n.column-u.replaceBefore.length,n.column+u.replaceAfter.length),this.variables.M__=u.matchBefore,this.variables.T__=u.matchAfter,this.insertSnippetForSelection(e,u.content),this.variables.M__=this.variables.T__=null,!0):!1},this.findMatchingSnippet=function(e,t,n){for(var r=e.length;r--;){var i=e[r];if(i.startRe&&!i.startRe.test(t))continue;if(i.endRe&&!i.endRe.test(n))continue;if(!i.startRe&&!i.endRe)continue;return i.matchBefore=i.startRe?i.startRe.exec(t):[""],i.matchAfter=i.endRe?i.endRe.exec(n):[""],i.replaceBefore=i.triggerRe?i.triggerRe.exec(t)[0]:"",i.replaceAfter=i.endTriggerRe?i.endTriggerRe.exec(n)[0]:"",i}},this.snippetMap={},this.snippetNameMap={},this.register=function(e,t){function o(e){return e&&!/^\^?\(.*\)\$?$|^\\b$/.test(e)&&(e="(?:"+e+")"),e||""}function u(e,t,n){return e=o(e),t=o(t),n?(e=t+e,e&&e[e.length-1]!="$"&&(e+="$")):(e+=t,e&&e[0]!="^"&&(e="^"+e)),new RegExp(e)}function a(e){e.scope||(e.scope=t||"_"),t=e.scope,n[t]||(n[t]=[],r[t]={});var o=r[t];if(e.name){var a=o[e.name];a&&i.unregister(a),o[e.name]=e}n[t].push(e),e.prefix&&(e.tabTrigger=e.prefix),!e.content&&e.body&&(e.content=Array.isArray(e.body)?e.body.join("\n"):e.body),e.tabTrigger&&!e.trigger&&(!e.guard&&/^\w/.test(e.tabTrigger)&&(e.guard="\\b"),e.trigger=s.escapeRegExp(e.tabTrigger));if(!e.trigger&&!e.guard&&!e.endTrigger&&!e.endGuard)return;e.startRe=u(e.trigger,e.guard,!0),e.triggerRe=new RegExp(e.trigger),e.endRe=u(e.endTrigger,e.endGuard,!0),e.endTriggerRe=new RegExp(e.endTrigger)}var n=this.snippetMap,r=this.snippetNameMap,i=this;e||(e=[]),Array.isArray(e)?e.forEach(a):Object.keys(e).forEach(function(t){a(e[t])}),this._signal("registerSnippets",{scope:t})},this.unregister=function(e,t){function i(e){var i=r[e.scope||t];if(i&&i[e.name]){delete i[e.name];var s=n[e.scope||t],o=s&&s.indexOf(e);o>=0&&s.splice(o,1)}}var n=this.snippetMap,r=this.snippetNameMap;e.content?i(e):Array.isArray(e)&&e.forEach(i)},this.parseSnippetFile=function(e){e=e.replace(/\r/g,"");var t=[],n={},r=/^#.*|^({[\s\S]*})\s*$|^(\S+) (.*)$|^((?:\n*\t.*)+)/gm,i;while(i=r.exec(e)){if(i[1])try{n=JSON.parse(i[1]),t.push(n)}catch(s){}if(i[4])n.content=i[4].replace(/^\t/gm,""),t.push(n),n={};else{var o=i[2],u=i[3];if(o=="regex"){var a=/\/((?:[^\/\\]|\\.)*)|$/g;n.guard=a.exec(u)[1],n.trigger=a.exec(u)[1],n.endTrigger=a.exec(u)[1],n.endGuard=a.exec(u)[1]}else o=="snippet"?(n.tabTrigger=u.match(/^\S*/)[0],n.name||(n.name=u)):o&&(n[o]=u)}}return t},this.getSnippetByName=function(e,t){var n=this.snippetNameMap,r;return this.getActiveScopes(t).some(function(t){var i=n[t];return i&&(r=i[e]),!!r},this),r}}).call(p.prototype);var d=function(e){if(e.tabstopManager)return e.tabstopManager;e.tabstopManager=this,this.$onChange=this.onChange.bind(this),this.$onChangeSelection=s.delayedCall(this.onChangeSelection.bind(this)).schedule,this.$onChangeSession=this.onChangeSession.bind(this),this.$onAfterExec=this.onAfterExec.bind(this),this.attach(e)};(function(){this.attach=function(e){this.index=0,this.ranges=[],this.tabstops=[],this.$openTabstops=null,this.selectedTabstop=null,this.editor=e,this.editor.on("change",this.$onChange),this.editor.on("changeSelection",this.$onChangeSelection),this.editor.on("changeSession",this.$onChangeSession),this.editor.commands.on("afterExec",this.$onAfterExec),this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler)},this.detach=function(){this.tabstops.forEach(this.removeTabstopMarkers,this),this.ranges=null,this.tabstops=null,this.selectedTabstop=null,this.editor.removeListener("change",this.$onChange),this.editor.removeListener("changeSelection",this.$onChangeSelection),this.editor.removeListener("changeSession",this.$onChangeSession),this.editor.commands.removeListener("afterExec",this.$onAfterExec),this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler),this.editor.tabstopManager=null,this.editor=null},this.onChange=function(e){var t=e.action[0]=="r",n=this.selectedTabstop||{},r=n.parents||{},i=(this.tabstops||[]).slice();for(var s=0;s2&&(this.tabstops.length&&a.push(a.splice(2,1)[0]),this.tabstops.splice.apply(this.tabstops,a))},this.addTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){e.markerId||(e.markerId=t.addMarker(e,"ace_snippet-marker","text"))})},this.removeTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){t.removeMarker(e.markerId),e.markerId=null})},this.removeRange=function(e){var t=e.tabstop.indexOf(e);t!=-1&&e.tabstop.splice(t,1),t=this.ranges.indexOf(e),t!=-1&&this.ranges.splice(t,1),t=e.tabstop.rangeList.ranges.indexOf(e),t!=-1&&e.tabstop.splice(t,1),this.editor.session.removeMarker(e.markerId),e.tabstop.length||(t=this.tabstops.indexOf(e.tabstop),t!=-1&&this.tabstops.splice(t,1),this.tabstops.length||this.detach())},this.keyboardHandler=new a,this.keyboardHandler.bindKeys({Tab:function(e){if(t.snippetManager&&t.snippetManager.expandWithTab(e))return;e.tabstopManager.tabNext(1),e.renderer.scrollCursorIntoView()},"Shift-Tab":function(e){e.tabstopManager.tabNext(-1),e.renderer.scrollCursorIntoView()},Esc:function(e){e.tabstopManager.detach()}})}).call(d.prototype);var v=function(e,t){e.row==0&&(e.column+=t.column),e.row+=t.row},m=function(e,t){e.row==t.row&&(e.column-=t.column),e.row-=t.row};e("./lib/dom").importCssString(".ace_snippet-marker { -moz-box-sizing: border-box; box-sizing: border-box; background: rgba(194, 193, 208, 0.09); border: 1px dotted rgba(211, 208, 235, 0.62); position: absolute;}"),t.snippetManager=new p;var g=e("./editor").Editor;(function(){this.insertSnippet=function(e,n){return t.snippetManager.insertSnippet(this,e,n)},this.expandSnippet=function(e){return t.snippetManager.expandWithTab(this,e)}}).call(g.prototype)}),define("ace/ext/emmet",["require","exports","module","ace/keyboard/hash_handler","ace/editor","ace/snippets","ace/range","ace/config","resources","resources","tabStops","resources","utils","actions"],function(e,t,n){"use strict";function l(){}var r=e("../keyboard/hash_handler").HashHandler,i=e("../editor").Editor,s=e("../snippets").snippetManager,o=e("../range").Range,u=e("../config"),a,f;l.prototype={setupContext:function(e){this.ace=e,this.indentation=e.session.getTabString(),a||(a=window.emmet);var t=a.resources||a.require("resources");t.setVariable("indentation",this.indentation),this.$syntax=null,this.$syntax=this.getSyntax()},getSelectionRange:function(){var e=this.ace.getSelectionRange(),t=this.ace.session.doc;return{start:t.positionToIndex(e.start),end:t.positionToIndex(e.end)}},createSelection:function(e,t){var n=this.ace.session.doc;this.ace.selection.setRange({start:n.indexToPosition(e),end:n.indexToPosition(t)})},getCurrentLineRange:function(){var e=this.ace,t=e.getCursorPosition().row,n=e.session.getLine(t).length,r=e.session.doc.positionToIndex({row:t,column:0});return{start:r,end:r+n}},getCaretPos:function(){var e=this.ace.getCursorPosition();return this.ace.session.doc.positionToIndex(e)},setCaretPos:function(e){var t=this.ace.session.doc.indexToPosition(e);this.ace.selection.moveToPosition(t)},getCurrentLine:function(){var e=this.ace.getCursorPosition().row;return this.ace.session.getLine(e)},replaceContent:function(e,t,n,r){n==null&&(n=t==null?this.getContent().length:t),t==null&&(t=0);var i=this.ace,u=i.session.doc,a=o.fromPoints(u.indexToPosition(t),u.indexToPosition(n));i.session.remove(a),a.end=a.start,e=this.$updateTabstops(e),s.insertSnippet(i,e)},getContent:function(){return this.ace.getValue()},getSyntax:function(){if(this.$syntax)return this.$syntax;var e=this.ace.session.$modeId.split("/").pop();if(e=="html"||e=="php"){var t=this.ace.getCursorPosition(),n=this.ace.session.getState(t.row);typeof n!="string"&&(n=n[0]),n&&(n=n.split("-"),n.length>1?e=n[0]:e=="php"&&(e="html"))}return e},getProfileName:function(){var e=a.resources||a.require("resources");switch(this.getSyntax()){case"css":return"css";case"xml":case"xsl":return"xml";case"html":var t=e.getVariable("profile");return t||(t=this.ace.session.getLines(0,2).join("").search(/]+XHTML/i)!=-1?"xhtml":"html"),t;default:var n=this.ace.session.$mode;return n.emmetConfig&&n.emmetConfig.profile||"xhtml"}},prompt:function(e){return prompt(e)},getSelection:function(){return this.ace.session.getTextRange()},getFilePath:function(){return""},$updateTabstops:function(e){var t=1e3,n=0,r=null,i=a.tabStops||a.require("tabStops"),s=a.resources||a.require("resources"),o=s.getVocabulary("user"),u={tabstop:function(e){var s=parseInt(e.group,10),o=s===0;o?s=++n:s+=t;var a=e.placeholder;a&&(a=i.processText(a,u));var f="${"+s+(a?":"+a:"")+"}";return o&&(r=[e.start,f]),f},escape:function(e){return e=="$"?"\\$":e=="\\"?"\\\\":e}};e=i.processText(e,u);if(o.variables.insert_final_tabstop&&!/\$\{0\}$/.test(e))e+="${0}";else if(r){var f=a.utils?a.utils.common:a.require("utils");e=f.replaceSubstring(e,"${0}",r[0],r[1])}return e}};var c={expand_abbreviation:{mac:"ctrl+alt+e",win:"alt+e"},match_pair_outward:{mac:"ctrl+d",win:"ctrl+,"},match_pair_inward:{mac:"ctrl+j",win:"ctrl+shift+0"},matching_pair:{mac:"ctrl+alt+j",win:"alt+j"},next_edit_point:"alt+right",prev_edit_point:"alt+left",toggle_comment:{mac:"command+/",win:"ctrl+/"},split_join_tag:{mac:"shift+command+'",win:"shift+ctrl+`"},remove_tag:{mac:"command+'",win:"shift+ctrl+;"},evaluate_math_expression:{mac:"shift+command+y",win:"shift+ctrl+y"},increment_number_by_1:"ctrl+up",decrement_number_by_1:"ctrl+down",increment_number_by_01:"alt+up",decrement_number_by_01:"alt+down",increment_number_by_10:{mac:"alt+command+up",win:"shift+alt+up"},decrement_number_by_10:{mac:"alt+command+down",win:"shift+alt+down"},select_next_item:{mac:"shift+command+.",win:"shift+ctrl+."},select_previous_item:{mac:"shift+command+,",win:"shift+ctrl+,"},reflect_css_value:{mac:"shift+command+r",win:"shift+ctrl+r"},encode_decode_data_url:{mac:"shift+ctrl+d",win:"ctrl+'"},expand_abbreviation_with_tab:"Tab",wrap_with_abbreviation:{mac:"shift+ctrl+a",win:"shift+ctrl+a"}},h=new l;t.commands=new r,t.runEmmetCommand=function v(e){if(this.action=="expand_abbreviation_with_tab"){if(!e.selection.isEmpty())return!1;var n=e.selection.lead,r=e.session.getTokenAt(n.row,n.column);if(r&&/\btag\b/.test(r.type))return!1}try{h.setupContext(e);var i=a.actions||a.require("actions");if(this.action=="wrap_with_abbreviation")return setTimeout(function(){i.run("wrap_with_abbreviation",h)},0);var s=i.run(this.action,h)}catch(o){if(!a){var f=t.load(v.bind(this,e));return this.action=="expand_abbreviation_with_tab"?!1:f}e._signal("changeStatus",typeof o=="string"?o:o.message),u.warn(o),s=!1}return s};for(var p in c)t.commands.addCommand({name:"emmet:"+p,action:p,bindKey:c[p],exec:t.runEmmetCommand,multiSelectAction:"forEach"});t.updateCommands=function(e,n){n?e.keyBinding.addKeyboardHandler(t.commands):e.keyBinding.removeKeyboardHandler(t.commands)},t.isSupportedMode=function(e){if(!e)return!1;if(e.emmetConfig)return!0;var t=e.$id||e;return/css|less|scss|sass|stylus|html|php|twig|ejs|handlebars/.test(t)},t.isAvailable=function(e,n){if(/(evaluate_math_expression|expand_abbreviation)$/.test(n))return!0;var r=e.session.$mode,i=t.isSupportedMode(r);if(i&&r.$modes)try{h.setupContext(e),/js|php/.test(h.getSyntax())&&(i=!1)}catch(s){}return i};var d=function(e,n){var r=n;if(!r)return;var i=t.isSupportedMode(r.session.$mode);e.enableEmmet===!1&&(i=!1),i&&t.load(),t.updateCommands(r,i)};t.load=function(e){return typeof f!="string"?(u.warn("script for emmet-core is not loaded"),!1):(u.loadModule(f,function(){f=null,e&&e()}),!0)},t.AceEmmetEditor=l,u.defineOptions(i.prototype,"editor",{enableEmmet:{set:function(e){this[e?"on":"removeListener"]("changeMode",d),d({enableEmmet:!!e},this)},value:!0}}),t.setCore=function(e){typeof e=="string"?f=e:a=e}}); (function() { + window.require(["ace/ext/emmet"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-error_marker.js b/data/static/vendor/src-min/ext-error_marker.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-error_marker.js @@ -0,0 +1,8 @@ +; (function() { + window.require(["ace/ext/error_marker"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-keybinding_menu.js b/data/static/vendor/src-min/ext-keybinding_menu.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-keybinding_menu.js @@ -0,0 +1,8 @@ +define("ace/ext/menu_tools/overlay_page",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../../lib/dom"),i="#ace_settingsmenu, #kbshortcutmenu {background-color: #F7F7F7;color: black;box-shadow: -5px 4px 5px rgba(126, 126, 126, 0.55);padding: 1em 0.5em 2em 1em;overflow: auto;position: absolute;margin: 0;bottom: 0;right: 0;top: 0;z-index: 9991;cursor: default;}.ace_dark #ace_settingsmenu, .ace_dark #kbshortcutmenu {box-shadow: -20px 10px 25px rgba(126, 126, 126, 0.25);background-color: rgba(255, 255, 255, 0.6);color: black;}.ace_optionsMenuEntry:hover {background-color: rgba(100, 100, 100, 0.1);transition: all 0.3s}.ace_closeButton {background: rgba(245, 146, 146, 0.5);border: 1px solid #F48A8A;border-radius: 50%;padding: 7px;position: absolute;right: -8px;top: -8px;z-index: 100000;}.ace_closeButton{background: rgba(245, 146, 146, 0.9);}.ace_optionsMenuKey {color: darkslateblue;font-weight: bold;}.ace_optionsMenuCommand {color: darkcyan;font-weight: normal;}.ace_optionsMenuEntry input, .ace_optionsMenuEntry button {vertical-align: middle;}.ace_optionsMenuEntry button[ace_selected_button=true] {background: #e7e7e7;box-shadow: 1px 0px 2px 0px #adadad inset;border-color: #adadad;}.ace_optionsMenuEntry button {background: white;border: 1px solid lightgray;margin: 0px;}.ace_optionsMenuEntry button:hover{background: #f0f0f0;}";r.importCssString(i),n.exports.overlayPage=function(t,n,r){function o(e){e.keyCode===27&&u()}function u(){if(!i)return;document.removeEventListener("keydown",o),i.parentNode.removeChild(i),t&&t.focus(),i=null,r&&r()}function a(e){s=e,e&&(i.style.pointerEvents="none",n.style.pointerEvents="auto")}var i=document.createElement("div"),s=!1;return i.style.cssText="margin: 0; padding: 0; position: fixed; top:0; bottom:0; left:0; right:0;z-index: 9990; "+(t?"background-color: rgba(0, 0, 0, 0.3);":""),i.addEventListener("click",function(e){s||u()}),document.addEventListener("keydown",o),n.addEventListener("click",function(e){e.stopPropagation()}),i.appendChild(n),document.body.appendChild(i),t&&t.blur(),{close:u,setIgnoreFocusOut:a}}}),define("ace/ext/menu_tools/get_editor_keyboard_shortcuts",["require","exports","module","ace/lib/keys"],function(e,t,n){"use strict";var r=e("../../lib/keys");n.exports.getEditorKeybordShortcuts=function(e){var t=r.KEY_MODS,n=[],i={};return e.keyBinding.$handlers.forEach(function(e){var t=e.commandKeyBinding;for(var r in t){var s=r.replace(/(^|-)\w/g,function(e){return e.toUpperCase()}),o=t[r];Array.isArray(o)||(o=[o]),o.forEach(function(e){typeof e!="string"&&(e=e.name),i[e]?i[e].key+="|"+s:(i[e]={key:s,command:e},n.push(i[e]))})}}),n}}),define("ace/ext/keybinding_menu",["require","exports","module","ace/editor","ace/ext/menu_tools/overlay_page","ace/ext/menu_tools/get_editor_keyboard_shortcuts"],function(e,t,n){"use strict";function i(t){if(!document.getElementById("kbshortcutmenu")){var n=e("./menu_tools/overlay_page").overlayPage,r=e("./menu_tools/get_editor_keyboard_shortcuts").getEditorKeybordShortcuts,i=r(t),s=document.createElement("div"),o=i.reduce(function(e,t){return e+'
        '+t.command+" : "+''+t.key+"
        "},"");s.id="kbshortcutmenu",s.innerHTML="

        Keyboard Shortcuts

        "+o+"
        ",n(t,s)}}var r=e("../editor").Editor;n.exports.init=function(e){r.prototype.showKeyboardShortcuts=function(){i(this)},e.commands.addCommands([{name:"showKeyboardShortcuts",bindKey:{win:"Ctrl-Alt-h",mac:"Command-Alt-h"},exec:function(e,t){e.showKeyboardShortcuts()}}])}}); (function() { + window.require(["ace/ext/keybinding_menu"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-language_tools.js b/data/static/vendor/src-min/ext-language_tools.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-language_tools.js @@ -0,0 +1,8 @@ +define("ace/snippets",["require","exports","module","ace/lib/oop","ace/lib/event_emitter","ace/lib/lang","ace/range","ace/range_list","ace/keyboard/hash_handler","ace/tokenizer","ace/clipboard","ace/lib/dom","ace/editor"],function(e,t,n){"use strict";function h(e){var t=(new Date).toLocaleString("en-us",e);return t.length==1?"0"+t:t}var r=e("./lib/oop"),i=e("./lib/event_emitter").EventEmitter,s=e("./lib/lang"),o=e("./range").Range,u=e("./range_list").RangeList,a=e("./keyboard/hash_handler").HashHandler,f=e("./tokenizer").Tokenizer,l=e("./clipboard"),c={CURRENT_WORD:function(e){return e.session.getTextRange(e.session.getWordRange())},SELECTION:function(e,t,n){var r=e.session.getTextRange();return n?r.replace(/\n\r?([ \t]*\S)/g,"\n"+n+"$1"):r},CURRENT_LINE:function(e){return e.session.getLine(e.getCursorPosition().row)},PREV_LINE:function(e){return e.session.getLine(e.getCursorPosition().row-1)},LINE_INDEX:function(e){return e.getCursorPosition().row},LINE_NUMBER:function(e){return e.getCursorPosition().row+1},SOFT_TABS:function(e){return e.session.getUseSoftTabs()?"YES":"NO"},TAB_SIZE:function(e){return e.session.getTabSize()},CLIPBOARD:function(e){return l.getText&&l.getText()},FILENAME:function(e){return/[^/\\]*$/.exec(this.FILEPATH(e))[0]},FILENAME_BASE:function(e){return/[^/\\]*$/.exec(this.FILEPATH(e))[0].replace(/\.[^.]*$/,"")},DIRECTORY:function(e){return this.FILEPATH(e).replace(/[^/\\]*$/,"")},FILEPATH:function(e){return"/not implemented.txt"},WORKSPACE_NAME:function(){return"Unknown"},FULLNAME:function(){return"Unknown"},BLOCK_COMMENT_START:function(e){var t=e.session.$mode||{};return t.blockComment&&t.blockComment.start||""},BLOCK_COMMENT_END:function(e){var t=e.session.$mode||{};return t.blockComment&&t.blockComment.end||""},LINE_COMMENT:function(e){var t=e.session.$mode||{};return t.lineCommentStart||""},CURRENT_YEAR:h.bind(null,{year:"numeric"}),CURRENT_YEAR_SHORT:h.bind(null,{year:"2-digit"}),CURRENT_MONTH:h.bind(null,{month:"numeric"}),CURRENT_MONTH_NAME:h.bind(null,{month:"long"}),CURRENT_MONTH_NAME_SHORT:h.bind(null,{month:"short"}),CURRENT_DATE:h.bind(null,{day:"2-digit"}),CURRENT_DAY_NAME:h.bind(null,{weekday:"long"}),CURRENT_DAY_NAME_SHORT:h.bind(null,{weekday:"short"}),CURRENT_HOUR:h.bind(null,{hour:"2-digit",hour12:!1}),CURRENT_MINUTE:h.bind(null,{minute:"2-digit"}),CURRENT_SECOND:h.bind(null,{second:"2-digit"})};c.SELECTED_TEXT=c.SELECTION;var p=function(){this.snippetMap={},this.snippetNameMap={}};(function(){r.implement(this,i),this.getTokenizer=function(){return p.$tokenizer||this.createTokenizer()},this.createTokenizer=function(){function e(e){return e=e.substr(1),/^\d+$/.test(e)?[{tabstopId:parseInt(e,10)}]:[{text:e}]}function t(e){return"(?:[^\\\\"+e+"]|\\\\.)"}var n={regex:"/("+t("/")+"+)/",onMatch:function(e,t,n){var r=n[0];return r.fmtString=!0,r.guard=e.slice(1,-1),r.flag="",""},next:"formatString"};return p.$tokenizer=new f({start:[{regex:/\\./,onMatch:function(e,t,n){var r=e[1];return r=="}"&&n.length?e=r:"`$\\".indexOf(r)!=-1&&(e=r),[e]}},{regex:/}/,onMatch:function(e,t,n){return[n.length?n.shift():e]}},{regex:/\$(?:\d+|\w+)/,onMatch:e},{regex:/\$\{[\dA-Z_a-z]+/,onMatch:function(t,n,r){var i=e(t.substr(1));return r.unshift(i[0]),i},next:"snippetVar"},{regex:/\n/,token:"newline",merge:!1}],snippetVar:[{regex:"\\|"+t("\\|")+"*\\|",onMatch:function(e,t,n){var r=e.slice(1,-1).replace(/\\[,|\\]|,/g,function(e){return e.length==2?e[1]:"\0"}).split("\0");return n[0].choices=r,[r[0]]},next:"start"},n,{regex:"([^:}\\\\]|\\\\.)*:?",token:"",next:"start"}],formatString:[{regex:/:/,onMatch:function(e,t,n){return n.length&&n[0].expectElse?(n[0].expectElse=!1,n[0].ifEnd={elseEnd:n[0]},[n[0].ifEnd]):":"}},{regex:/\\./,onMatch:function(e,t,n){var r=e[1];return r=="}"&&n.length?e=r:"`$\\".indexOf(r)!=-1?e=r:r=="n"?e="\n":r=="t"?e=" ":"ulULE".indexOf(r)!=-1&&(e={changeCase:r,local:r>"a"}),[e]}},{regex:"/\\w*}",onMatch:function(e,t,n){var r=n.shift();return r&&(r.flag=e.slice(1,-1)),this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"},{regex:/\$(?:\d+|\w+)/,onMatch:function(e,t,n){return[{text:e.slice(1)}]}},{regex:/\${\w+/,onMatch:function(e,t,n){var r={text:e.slice(2)};return n.unshift(r),[r]},next:"formatStringVar"},{regex:/\n/,token:"newline",merge:!1},{regex:/}/,onMatch:function(e,t,n){var r=n.shift();return this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"}],formatStringVar:[{regex:/:\/\w+}/,onMatch:function(e,t,n){var r=n[0];return r.formatFunction=e.slice(2,-1),[n.shift()]},next:"formatString"},n,{regex:/:[\?\-+]?/,onMatch:function(e,t,n){e[1]=="+"&&(n[0].ifEnd=n[0]),e[1]=="?"&&(n[0].expectElse=!0)},next:"formatString"},{regex:"([^:}\\\\]|\\\\.)*:?",token:"",next:"formatString"}]}),p.$tokenizer},this.tokenizeTmSnippet=function(e,t){return this.getTokenizer().getLineTokens(e,t).tokens.map(function(e){return e.value||e})},this.getVariableValue=function(e,t,n){if(/^\d+$/.test(t))return(this.variables.__||{})[t]||"";if(/^[A-Z]\d+$/.test(t))return(this.variables[t[0]+"__"]||{})[t.substr(1)]||"";t=t.replace(/^TM_/,"");if(!this.variables.hasOwnProperty(t))return"";var r=this.variables[t];return typeof r=="function"&&(r=this.variables[t](e,t,n)),r==null?"":r},this.variables=c,this.tmStrFormat=function(e,t,n){if(!t.fmt)return e;var r=t.flag||"",i=t.guard;i=new RegExp(i,r.replace(/[^gim]/g,""));var s=typeof t.fmt=="string"?this.tokenizeTmSnippet(t.fmt,"formatString"):t.fmt,o=this,u=e.replace(i,function(){var e=o.variables.__;o.variables.__=[].slice.call(arguments);var t=o.resolveVariables(s,n),r="E";for(var i=0;i1?(y=t[t.length-1].length,g+=t.length-1):y+=e.length,b+=e}else e&&(e.start?e.end={row:g,column:y}:e.start={row:g,column:y})});var w=e.getSelectionRange(),E=e.session.replace(w,b),S=new d(e),x=e.inVirtualSelectionMode&&e.selection.index;S.addTabstops(u,w.start,E,x)},this.insertSnippet=function(e,t){var n=this;if(e.inVirtualSelectionMode)return n.insertSnippetForSelection(e,t);e.forEachSelection(function(){n.insertSnippetForSelection(e,t)},null,{keepOrder:!0}),e.tabstopManager&&e.tabstopManager.tabNext()},this.$getScope=function(e){var t=e.session.$mode.$id||"";t=t.split("/").pop();if(t==="html"||t==="php"){t==="php"&&!e.session.$mode.inlinePhp&&(t="html");var n=e.getCursorPosition(),r=e.session.getState(n.row);typeof r=="object"&&(r=r[0]),r.substring&&(r.substring(0,3)=="js-"?t="javascript":r.substring(0,4)=="css-"?t="css":r.substring(0,4)=="php-"&&(t="php"))}return t},this.getActiveScopes=function(e){var t=this.$getScope(e),n=[t],r=this.snippetMap;return r[t]&&r[t].includeScopes&&n.push.apply(n,r[t].includeScopes),n.push("_"),n},this.expandWithTab=function(e,t){var n=this,r=e.forEachSelection(function(){return n.expandSnippetForSelection(e,t)},null,{keepOrder:!0});return r&&e.tabstopManager&&e.tabstopManager.tabNext(),r},this.expandSnippetForSelection=function(e,t){var n=e.getCursorPosition(),r=e.session.getLine(n.row),i=r.substring(0,n.column),s=r.substr(n.column),o=this.snippetMap,u;return this.getActiveScopes(e).some(function(e){var t=o[e];return t&&(u=this.findMatchingSnippet(t,i,s)),!!u},this),u?t&&t.dryRun?!0:(e.session.doc.removeInLine(n.row,n.column-u.replaceBefore.length,n.column+u.replaceAfter.length),this.variables.M__=u.matchBefore,this.variables.T__=u.matchAfter,this.insertSnippetForSelection(e,u.content),this.variables.M__=this.variables.T__=null,!0):!1},this.findMatchingSnippet=function(e,t,n){for(var r=e.length;r--;){var i=e[r];if(i.startRe&&!i.startRe.test(t))continue;if(i.endRe&&!i.endRe.test(n))continue;if(!i.startRe&&!i.endRe)continue;return i.matchBefore=i.startRe?i.startRe.exec(t):[""],i.matchAfter=i.endRe?i.endRe.exec(n):[""],i.replaceBefore=i.triggerRe?i.triggerRe.exec(t)[0]:"",i.replaceAfter=i.endTriggerRe?i.endTriggerRe.exec(n)[0]:"",i}},this.snippetMap={},this.snippetNameMap={},this.register=function(e,t){function o(e){return e&&!/^\^?\(.*\)\$?$|^\\b$/.test(e)&&(e="(?:"+e+")"),e||""}function u(e,t,n){return e=o(e),t=o(t),n?(e=t+e,e&&e[e.length-1]!="$"&&(e+="$")):(e+=t,e&&e[0]!="^"&&(e="^"+e)),new RegExp(e)}function a(e){e.scope||(e.scope=t||"_"),t=e.scope,n[t]||(n[t]=[],r[t]={});var o=r[t];if(e.name){var a=o[e.name];a&&i.unregister(a),o[e.name]=e}n[t].push(e),e.prefix&&(e.tabTrigger=e.prefix),!e.content&&e.body&&(e.content=Array.isArray(e.body)?e.body.join("\n"):e.body),e.tabTrigger&&!e.trigger&&(!e.guard&&/^\w/.test(e.tabTrigger)&&(e.guard="\\b"),e.trigger=s.escapeRegExp(e.tabTrigger));if(!e.trigger&&!e.guard&&!e.endTrigger&&!e.endGuard)return;e.startRe=u(e.trigger,e.guard,!0),e.triggerRe=new RegExp(e.trigger),e.endRe=u(e.endTrigger,e.endGuard,!0),e.endTriggerRe=new RegExp(e.endTrigger)}var n=this.snippetMap,r=this.snippetNameMap,i=this;e||(e=[]),Array.isArray(e)?e.forEach(a):Object.keys(e).forEach(function(t){a(e[t])}),this._signal("registerSnippets",{scope:t})},this.unregister=function(e,t){function i(e){var i=r[e.scope||t];if(i&&i[e.name]){delete i[e.name];var s=n[e.scope||t],o=s&&s.indexOf(e);o>=0&&s.splice(o,1)}}var n=this.snippetMap,r=this.snippetNameMap;e.content?i(e):Array.isArray(e)&&e.forEach(i)},this.parseSnippetFile=function(e){e=e.replace(/\r/g,"");var t=[],n={},r=/^#.*|^({[\s\S]*})\s*$|^(\S+) (.*)$|^((?:\n*\t.*)+)/gm,i;while(i=r.exec(e)){if(i[1])try{n=JSON.parse(i[1]),t.push(n)}catch(s){}if(i[4])n.content=i[4].replace(/^\t/gm,""),t.push(n),n={};else{var o=i[2],u=i[3];if(o=="regex"){var a=/\/((?:[^\/\\]|\\.)*)|$/g;n.guard=a.exec(u)[1],n.trigger=a.exec(u)[1],n.endTrigger=a.exec(u)[1],n.endGuard=a.exec(u)[1]}else o=="snippet"?(n.tabTrigger=u.match(/^\S*/)[0],n.name||(n.name=u)):o&&(n[o]=u)}}return t},this.getSnippetByName=function(e,t){var n=this.snippetNameMap,r;return this.getActiveScopes(t).some(function(t){var i=n[t];return i&&(r=i[e]),!!r},this),r}}).call(p.prototype);var d=function(e){if(e.tabstopManager)return e.tabstopManager;e.tabstopManager=this,this.$onChange=this.onChange.bind(this),this.$onChangeSelection=s.delayedCall(this.onChangeSelection.bind(this)).schedule,this.$onChangeSession=this.onChangeSession.bind(this),this.$onAfterExec=this.onAfterExec.bind(this),this.attach(e)};(function(){this.attach=function(e){this.index=0,this.ranges=[],this.tabstops=[],this.$openTabstops=null,this.selectedTabstop=null,this.editor=e,this.editor.on("change",this.$onChange),this.editor.on("changeSelection",this.$onChangeSelection),this.editor.on("changeSession",this.$onChangeSession),this.editor.commands.on("afterExec",this.$onAfterExec),this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler)},this.detach=function(){this.tabstops.forEach(this.removeTabstopMarkers,this),this.ranges=null,this.tabstops=null,this.selectedTabstop=null,this.editor.removeListener("change",this.$onChange),this.editor.removeListener("changeSelection",this.$onChangeSelection),this.editor.removeListener("changeSession",this.$onChangeSession),this.editor.commands.removeListener("afterExec",this.$onAfterExec),this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler),this.editor.tabstopManager=null,this.editor=null},this.onChange=function(e){var t=e.action[0]=="r",n=this.selectedTabstop||{},r=n.parents||{},i=(this.tabstops||[]).slice();for(var s=0;s2&&(this.tabstops.length&&a.push(a.splice(2,1)[0]),this.tabstops.splice.apply(this.tabstops,a))},this.addTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){e.markerId||(e.markerId=t.addMarker(e,"ace_snippet-marker","text"))})},this.removeTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){t.removeMarker(e.markerId),e.markerId=null})},this.removeRange=function(e){var t=e.tabstop.indexOf(e);t!=-1&&e.tabstop.splice(t,1),t=this.ranges.indexOf(e),t!=-1&&this.ranges.splice(t,1),t=e.tabstop.rangeList.ranges.indexOf(e),t!=-1&&e.tabstop.splice(t,1),this.editor.session.removeMarker(e.markerId),e.tabstop.length||(t=this.tabstops.indexOf(e.tabstop),t!=-1&&this.tabstops.splice(t,1),this.tabstops.length||this.detach())},this.keyboardHandler=new a,this.keyboardHandler.bindKeys({Tab:function(e){if(t.snippetManager&&t.snippetManager.expandWithTab(e))return;e.tabstopManager.tabNext(1),e.renderer.scrollCursorIntoView()},"Shift-Tab":function(e){e.tabstopManager.tabNext(-1),e.renderer.scrollCursorIntoView()},Esc:function(e){e.tabstopManager.detach()}})}).call(d.prototype);var v=function(e,t){e.row==0&&(e.column+=t.column),e.row+=t.row},m=function(e,t){e.row==t.row&&(e.column-=t.column),e.row-=t.row};e("./lib/dom").importCssString(".ace_snippet-marker { -moz-box-sizing: border-box; box-sizing: border-box; background: rgba(194, 193, 208, 0.09); border: 1px dotted rgba(211, 208, 235, 0.62); position: absolute;}"),t.snippetManager=new p;var g=e("./editor").Editor;(function(){this.insertSnippet=function(e,n){return t.snippetManager.insertSnippet(this,e,n)},this.expandSnippet=function(e){return t.snippetManager.expandWithTab(this,e)}}).call(g.prototype)}),define("ace/autocomplete/popup",["require","exports","module","ace/virtual_renderer","ace/editor","ace/range","ace/lib/event","ace/lib/lang","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../virtual_renderer").VirtualRenderer,i=e("../editor").Editor,s=e("../range").Range,o=e("../lib/event"),u=e("../lib/lang"),a=e("../lib/dom"),f=function(e){var t=new r(e);t.$maxLines=4;var n=new i(t);return n.setHighlightActiveLine(!1),n.setShowPrintMargin(!1),n.renderer.setShowGutter(!1),n.renderer.setHighlightGutterLine(!1),n.$mouseHandler.$focusTimeout=0,n.$highlightTagPending=!0,n},l=function(e){var t=a.createElement("div"),n=new f(t);e&&e.appendChild(t),t.style.display="none",n.renderer.content.style.cursor="default",n.renderer.setStyle("ace_autocomplete"),n.setOption("displayIndentGuides",!1),n.setOption("dragDelay",150);var r=function(){};n.focus=r,n.$isFocused=!0,n.renderer.$cursorLayer.restartTimer=r,n.renderer.$cursorLayer.element.style.opacity=0,n.renderer.$maxLines=8,n.renderer.$keepTextAreaAtCursor=!1,n.setHighlightActiveLine(!1),n.session.highlight(""),n.session.$searchHighlight.clazz="ace_highlight-marker",n.on("mousedown",function(e){var t=e.getDocumentPosition();n.selection.moveToPosition(t),c.start.row=c.end.row=t.row,e.stop()});var i,l=new s(-1,0,-1,Infinity),c=new s(-1,0,-1,Infinity);c.id=n.session.addMarker(c,"ace_active-line","fullLine"),n.setSelectOnHover=function(e){e?l.id&&(n.session.removeMarker(l.id),l.id=null):l.id=n.session.addMarker(l,"ace_line-hover","fullLine")},n.setSelectOnHover(!1),n.on("mousemove",function(e){if(!i){i=e;return}if(i.x==e.x&&i.y==e.y)return;i=e,i.scrollTop=n.renderer.scrollTop;var t=i.getDocumentPosition().row;l.start.row!=t&&(l.id||n.setRow(t),p(t))}),n.renderer.on("beforeRender",function(){if(i&&l.start.row!=-1){i.$pos=null;var e=i.getDocumentPosition().row;l.id||n.setRow(e),p(e,!0)}}),n.renderer.on("afterRender",function(){var e=n.getRow(),t=n.renderer.$textLayer,r=t.element.childNodes[e-t.config.firstRow];r!==t.selectedNode&&t.selectedNode&&a.removeCssClass(t.selectedNode,"ace_selected"),t.selectedNode=r,r&&a.addCssClass(r,"ace_selected")});var h=function(){p(-1)},p=function(e,t){e!==l.start.row&&(l.start.row=l.end.row=e,t||n.session._emit("changeBackMarker"),n._emit("changeHoverMarker"))};n.getHoveredRow=function(){return l.start.row},o.addListener(n.container,"mouseout",h),n.on("hide",h),n.on("changeSelection",h),n.session.doc.getLength=function(){return n.data.length},n.session.doc.getLine=function(e){var t=n.data[e];return typeof t=="string"?t:t&&t.value||""};var d=n.session.bgTokenizer;return d.$tokenizeRow=function(e){function s(e,n){e&&r.push({type:(t.className||"")+(n||""),value:e})}var t=n.data[e],r=[];if(!t)return r;typeof t=="string"&&(t={value:t});var i=t.caption||t.value||t.name,o=i.toLowerCase(),u=(n.filterText||"").toLowerCase(),a=0,f=0;for(var l=0;l<=u.length;l++)if(l!=f&&(t.matchMask&1<o/2&&!r;c&&l+t+f>o?(a.$maxPixelHeight=l-2*this.$borderSize,s.style.top="",s.style.bottom=o-l+"px",n.isTopdown=!1):(l+=t,a.$maxPixelHeight=o-l-.2*t,s.style.top=l+"px",s.style.bottom="",n.isTopdown=!0),s.style.display="";var h=e.left;h+s.offsetWidth>u&&(h=u-s.offsetWidth),s.style.left=h+"px",this._signal("show"),i=null,n.isOpen=!0},n.goTo=function(e){var t=this.getRow(),n=this.session.getLength()-1;switch(e){case"up":t=t<=0?n:t-1;break;case"down":t=t>=n?-1:t+1;break;case"start":t=0;break;case"end":t=n}this.setRow(t)},n.getTextLeftOffset=function(){return this.$borderSize+this.renderer.$padding+this.$imageSize},n.$imageSize=0,n.$borderSize=1,n};a.importCssString(".ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line { background-color: #CAD6FA; z-index: 1;}.ace_dark.ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line { background-color: #3a674e;}.ace_editor.ace_autocomplete .ace_line-hover { border: 1px solid #abbffe; margin-top: -1px; background: rgba(233,233,253,0.4); position: absolute; z-index: 2;}.ace_dark.ace_editor.ace_autocomplete .ace_line-hover { border: 1px solid rgba(109, 150, 13, 0.8); background: rgba(58, 103, 78, 0.62);}.ace_completion-meta { opacity: 0.5; margin: 0.9em;}.ace_completion-message { color: blue;}.ace_editor.ace_autocomplete .ace_completion-highlight{ color: #2d69c7;}.ace_dark.ace_editor.ace_autocomplete .ace_completion-highlight{ color: #93ca12;}.ace_editor.ace_autocomplete { width: 300px; z-index: 200000; border: 1px lightgray solid; position: fixed; box-shadow: 2px 3px 5px rgba(0,0,0,.2); line-height: 1.4; background: #fefefe; color: #111;}.ace_dark.ace_editor.ace_autocomplete { border: 1px #484747 solid; box-shadow: 2px 3px 5px rgba(0, 0, 0, 0.51); line-height: 1.4; background: #25282c; color: #c1c1c1;}","autocompletion.css"),t.AcePopup=l,t.$singleLineEditor=f}),define("ace/autocomplete/util",["require","exports","module"],function(e,t,n){"use strict";t.parForEach=function(e,t,n){var r=0,i=e.length;i===0&&n();for(var s=0;s=0;s--){if(!n.test(e[s]))break;i.push(e[s])}return i.reverse().join("")},t.retrieveFollowingIdentifier=function(e,t,n){n=n||r;var i=[];for(var s=t;sthis.filterText&&e.lastIndexOf(this.filterText,0)===0)var t=this.filtered;else var t=this.all;this.filterText=e,t=this.filterCompletions(t,this.filterText),t=t.sort(function(e,t){return t.exactMatch-e.exactMatch||t.$score-e.$score||(e.caption||e.value).localeCompare(t.caption||t.value)});var n=null;t=t.filter(function(e){var t=e.snippet||e.caption||e.value;return t===n?!1:(n=t,!0)}),this.filtered=t},this.filterCompletions=function(e,t){var n=[],r=t.toUpperCase(),i=t.toLowerCase();e:for(var s=0,o;o=e[s];s++){var u=o.caption||o.value||o.snippet;if(!u)continue;var a=-1,f=0,l=0,c,h;if(this.exactMatch){if(t!==u.substr(0,t.length))continue e}else{var p=u.toLowerCase().indexOf(i);if(p>-1)l=p;else for(var d=0;d=0?m<0||v0&&(a===-1&&(l+=10),l+=h,f|=1<",o.escapeHTML(e.caption),"","
        ",o.escapeHTML(e.snippet)].join(""))}},c=[l,a,f];t.setCompleters=function(e){c.length=0,e&&c.push.apply(c,e)},t.addCompleter=function(e){c.push(e)},t.textCompleter=a,t.keyWordCompleter=f,t.snippetCompleter=l;var h={name:"expandSnippet",exec:function(e){return r.expandWithTab(e)},bindKey:"Tab"},p=function(e,t){d(t.session.$mode)},d=function(e){typeof e=="string"&&(e=s.$modes[e]);if(!e)return;r.files||(r.files={}),v(e.$id,e.snippetFileId),e.modes&&e.modes.forEach(d)},v=function(e,t){if(!t||!e||r.files[e])return;r.files[e]={},s.loadModule(t,function(t){if(!t)return;r.files[e]=t,!t.snippets&&t.snippetText&&(t.snippets=r.parseSnippetFile(t.snippetText)),r.register(t.snippets||[],t.scope),t.includeScopes&&(r.snippetMap[t.scope].includeScopes=t.includeScopes,t.includeScopes.forEach(function(e){d("ace/mode/"+e)}))})},m=function(e){var t=e.editor,n=t.completer&&t.completer.activated;if(e.command.name==="backspace")n&&!u.getCompletionPrefix(t)&&t.completer.detach();else if(e.command.name==="insertstring"){var r=u.getCompletionPrefix(t);if(r&&!n){var s=i.for(t);s.autoInsert=!1,s.showPopup(t)}}},g=e("../editor").Editor;e("../config").defineOptions(g.prototype,"editor",{enableBasicAutocompletion:{set:function(e){e?(this.completers||(this.completers=Array.isArray(e)?e:c),this.commands.addCommand(i.startCommand)):this.commands.removeCommand(i.startCommand)},value:!1},enableLiveAutocompletion:{set:function(e){e?(this.completers||(this.completers=Array.isArray(e)?e:c),this.commands.on("afterExec",m)):this.commands.removeListener("afterExec",m)},value:!1},enableSnippets:{set:function(e){e?(this.commands.addCommand(h),this.on("changeMode",p),p(null,this)):(this.commands.removeCommand(h),this.off("changeMode",p))},value:!1}})}); (function() { + window.require(["ace/ext/language_tools"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-linking.js b/data/static/vendor/src-min/ext-linking.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-linking.js @@ -0,0 +1,8 @@ +define("ace/ext/linking",["require","exports","module","ace/editor","ace/config"],function(e,t,n){function i(e){var n=e.editor,r=e.getAccelKey();if(r){var n=e.editor,i=e.getDocumentPosition(),s=n.session,o=s.getTokenAt(i.row,i.column);t.previousLinkingHover&&t.previousLinkingHover!=o&&n._emit("linkHoverOut"),n._emit("linkHover",{position:i,token:o}),t.previousLinkingHover=o}else t.previousLinkingHover&&(n._emit("linkHoverOut"),t.previousLinkingHover=!1)}function s(e){var t=e.getAccelKey(),n=e.getButton();if(n==0&&t){var r=e.editor,i=e.getDocumentPosition(),s=r.session,o=s.getTokenAt(i.row,i.column);r._emit("linkClick",{position:i,token:o})}}var r=e("../editor").Editor;e("../config").defineOptions(r.prototype,"editor",{enableLinking:{set:function(e){e?(this.on("click",s),this.on("mousemove",i)):(this.off("click",s),this.off("mousemove",i))},value:!1}}),t.previousLinkingHover=!1}); (function() { + window.require(["ace/ext/linking"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-modelist.js b/data/static/vendor/src-min/ext-modelist.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-modelist.js @@ -0,0 +1,8 @@ +define("ace/ext/modelist",["require","exports","module"],function(e,t,n){"use strict";function i(e){var t=a.text,n=e.split(/[\/\\]/).pop();for(var i=0;io/2&&!r;c&&l+t+f>o?(a.$maxPixelHeight=l-2*this.$borderSize,s.style.top="",s.style.bottom=o-l+"px",n.isTopdown=!1):(l+=t,a.$maxPixelHeight=o-l-.2*t,s.style.top=l+"px",s.style.bottom="",n.isTopdown=!0),s.style.display="";var h=e.left;h+s.offsetWidth>u&&(h=u-s.offsetWidth),s.style.left=h+"px",this._signal("show"),i=null,n.isOpen=!0},n.goTo=function(e){var t=this.getRow(),n=this.session.getLength()-1;switch(e){case"up":t=t<=0?n:t-1;break;case"down":t=t>=n?-1:t+1;break;case"start":t=0;break;case"end":t=n}this.setRow(t)},n.getTextLeftOffset=function(){return this.$borderSize+this.renderer.$padding+this.$imageSize},n.$imageSize=0,n.$borderSize=1,n};a.importCssString(".ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line { background-color: #CAD6FA; z-index: 1;}.ace_dark.ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line { background-color: #3a674e;}.ace_editor.ace_autocomplete .ace_line-hover { border: 1px solid #abbffe; margin-top: -1px; background: rgba(233,233,253,0.4); position: absolute; z-index: 2;}.ace_dark.ace_editor.ace_autocomplete .ace_line-hover { border: 1px solid rgba(109, 150, 13, 0.8); background: rgba(58, 103, 78, 0.62);}.ace_completion-meta { opacity: 0.5; margin: 0.9em;}.ace_completion-message { color: blue;}.ace_editor.ace_autocomplete .ace_completion-highlight{ color: #2d69c7;}.ace_dark.ace_editor.ace_autocomplete .ace_completion-highlight{ color: #93ca12;}.ace_editor.ace_autocomplete { width: 300px; z-index: 200000; border: 1px lightgray solid; position: fixed; box-shadow: 2px 3px 5px rgba(0,0,0,.2); line-height: 1.4; background: #fefefe; color: #111;}.ace_dark.ace_editor.ace_autocomplete { border: 1px #484747 solid; box-shadow: 2px 3px 5px rgba(0, 0, 0, 0.51); line-height: 1.4; background: #25282c; color: #c1c1c1;}","autocompletion.css"),t.AcePopup=l,t.$singleLineEditor=f}),define("ace/autocomplete/util",["require","exports","module"],function(e,t,n){"use strict";t.parForEach=function(e,t,n){var r=0,i=e.length;i===0&&n();for(var s=0;s=0;s--){if(!n.test(e[s]))break;i.push(e[s])}return i.reverse().join("")},t.retrieveFollowingIdentifier=function(e,t,n){n=n||r;var i=[];for(var s=t;s"a"}),[e]}},{regex:"/\\w*}",onMatch:function(e,t,n){var r=n.shift();return r&&(r.flag=e.slice(1,-1)),this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"},{regex:/\$(?:\d+|\w+)/,onMatch:function(e,t,n){return[{text:e.slice(1)}]}},{regex:/\${\w+/,onMatch:function(e,t,n){var r={text:e.slice(2)};return n.unshift(r),[r]},next:"formatStringVar"},{regex:/\n/,token:"newline",merge:!1},{regex:/}/,onMatch:function(e,t,n){var r=n.shift();return this.next=r&&r.tabstopId?"start":"",[r||e]},next:"start"}],formatStringVar:[{regex:/:\/\w+}/,onMatch:function(e,t,n){var r=n[0];return r.formatFunction=e.slice(2,-1),[n.shift()]},next:"formatString"},n,{regex:/:[\?\-+]?/,onMatch:function(e,t,n){e[1]=="+"&&(n[0].ifEnd=n[0]),e[1]=="?"&&(n[0].expectElse=!0)},next:"formatString"},{regex:"([^:}\\\\]|\\\\.)*:?",token:"",next:"formatString"}]}),p.$tokenizer},this.tokenizeTmSnippet=function(e,t){return this.getTokenizer().getLineTokens(e,t).tokens.map(function(e){return e.value||e})},this.getVariableValue=function(e,t,n){if(/^\d+$/.test(t))return(this.variables.__||{})[t]||"";if(/^[A-Z]\d+$/.test(t))return(this.variables[t[0]+"__"]||{})[t.substr(1)]||"";t=t.replace(/^TM_/,"");if(!this.variables.hasOwnProperty(t))return"";var r=this.variables[t];return typeof r=="function"&&(r=this.variables[t](e,t,n)),r==null?"":r},this.variables=c,this.tmStrFormat=function(e,t,n){if(!t.fmt)return e;var r=t.flag||"",i=t.guard;i=new RegExp(i,r.replace(/[^gim]/g,""));var s=typeof t.fmt=="string"?this.tokenizeTmSnippet(t.fmt,"formatString"):t.fmt,o=this,u=e.replace(i,function(){var e=o.variables.__;o.variables.__=[].slice.call(arguments);var t=o.resolveVariables(s,n),r="E";for(var i=0;i1?(y=t[t.length-1].length,g+=t.length-1):y+=e.length,b+=e}else e&&(e.start?e.end={row:g,column:y}:e.start={row:g,column:y})});var w=e.getSelectionRange(),E=e.session.replace(w,b),S=new d(e),x=e.inVirtualSelectionMode&&e.selection.index;S.addTabstops(u,w.start,E,x)},this.insertSnippet=function(e,t){var n=this;if(e.inVirtualSelectionMode)return n.insertSnippetForSelection(e,t);e.forEachSelection(function(){n.insertSnippetForSelection(e,t)},null,{keepOrder:!0}),e.tabstopManager&&e.tabstopManager.tabNext()},this.$getScope=function(e){var t=e.session.$mode.$id||"";t=t.split("/").pop();if(t==="html"||t==="php"){t==="php"&&!e.session.$mode.inlinePhp&&(t="html");var n=e.getCursorPosition(),r=e.session.getState(n.row);typeof r=="object"&&(r=r[0]),r.substring&&(r.substring(0,3)=="js-"?t="javascript":r.substring(0,4)=="css-"?t="css":r.substring(0,4)=="php-"&&(t="php"))}return t},this.getActiveScopes=function(e){var t=this.$getScope(e),n=[t],r=this.snippetMap;return r[t]&&r[t].includeScopes&&n.push.apply(n,r[t].includeScopes),n.push("_"),n},this.expandWithTab=function(e,t){var n=this,r=e.forEachSelection(function(){return n.expandSnippetForSelection(e,t)},null,{keepOrder:!0});return r&&e.tabstopManager&&e.tabstopManager.tabNext(),r},this.expandSnippetForSelection=function(e,t){var n=e.getCursorPosition(),r=e.session.getLine(n.row),i=r.substring(0,n.column),s=r.substr(n.column),o=this.snippetMap,u;return this.getActiveScopes(e).some(function(e){var t=o[e];return t&&(u=this.findMatchingSnippet(t,i,s)),!!u},this),u?t&&t.dryRun?!0:(e.session.doc.removeInLine(n.row,n.column-u.replaceBefore.length,n.column+u.replaceAfter.length),this.variables.M__=u.matchBefore,this.variables.T__=u.matchAfter,this.insertSnippetForSelection(e,u.content),this.variables.M__=this.variables.T__=null,!0):!1},this.findMatchingSnippet=function(e,t,n){for(var r=e.length;r--;){var i=e[r];if(i.startRe&&!i.startRe.test(t))continue;if(i.endRe&&!i.endRe.test(n))continue;if(!i.startRe&&!i.endRe)continue;return i.matchBefore=i.startRe?i.startRe.exec(t):[""],i.matchAfter=i.endRe?i.endRe.exec(n):[""],i.replaceBefore=i.triggerRe?i.triggerRe.exec(t)[0]:"",i.replaceAfter=i.endTriggerRe?i.endTriggerRe.exec(n)[0]:"",i}},this.snippetMap={},this.snippetNameMap={},this.register=function(e,t){function o(e){return e&&!/^\^?\(.*\)\$?$|^\\b$/.test(e)&&(e="(?:"+e+")"),e||""}function u(e,t,n){return e=o(e),t=o(t),n?(e=t+e,e&&e[e.length-1]!="$"&&(e+="$")):(e+=t,e&&e[0]!="^"&&(e="^"+e)),new RegExp(e)}function a(e){e.scope||(e.scope=t||"_"),t=e.scope,n[t]||(n[t]=[],r[t]={});var o=r[t];if(e.name){var a=o[e.name];a&&i.unregister(a),o[e.name]=e}n[t].push(e),e.prefix&&(e.tabTrigger=e.prefix),!e.content&&e.body&&(e.content=Array.isArray(e.body)?e.body.join("\n"):e.body),e.tabTrigger&&!e.trigger&&(!e.guard&&/^\w/.test(e.tabTrigger)&&(e.guard="\\b"),e.trigger=s.escapeRegExp(e.tabTrigger));if(!e.trigger&&!e.guard&&!e.endTrigger&&!e.endGuard)return;e.startRe=u(e.trigger,e.guard,!0),e.triggerRe=new RegExp(e.trigger),e.endRe=u(e.endTrigger,e.endGuard,!0),e.endTriggerRe=new RegExp(e.endTrigger)}var n=this.snippetMap,r=this.snippetNameMap,i=this;e||(e=[]),Array.isArray(e)?e.forEach(a):Object.keys(e).forEach(function(t){a(e[t])}),this._signal("registerSnippets",{scope:t})},this.unregister=function(e,t){function i(e){var i=r[e.scope||t];if(i&&i[e.name]){delete i[e.name];var s=n[e.scope||t],o=s&&s.indexOf(e);o>=0&&s.splice(o,1)}}var n=this.snippetMap,r=this.snippetNameMap;e.content?i(e):Array.isArray(e)&&e.forEach(i)},this.parseSnippetFile=function(e){e=e.replace(/\r/g,"");var t=[],n={},r=/^#.*|^({[\s\S]*})\s*$|^(\S+) (.*)$|^((?:\n*\t.*)+)/gm,i;while(i=r.exec(e)){if(i[1])try{n=JSON.parse(i[1]),t.push(n)}catch(s){}if(i[4])n.content=i[4].replace(/^\t/gm,""),t.push(n),n={};else{var o=i[2],u=i[3];if(o=="regex"){var a=/\/((?:[^\/\\]|\\.)*)|$/g;n.guard=a.exec(u)[1],n.trigger=a.exec(u)[1],n.endTrigger=a.exec(u)[1],n.endGuard=a.exec(u)[1]}else o=="snippet"?(n.tabTrigger=u.match(/^\S*/)[0],n.name||(n.name=u)):o&&(n[o]=u)}}return t},this.getSnippetByName=function(e,t){var n=this.snippetNameMap,r;return this.getActiveScopes(t).some(function(t){var i=n[t];return i&&(r=i[e]),!!r},this),r}}).call(p.prototype);var d=function(e){if(e.tabstopManager)return e.tabstopManager;e.tabstopManager=this,this.$onChange=this.onChange.bind(this),this.$onChangeSelection=s.delayedCall(this.onChangeSelection.bind(this)).schedule,this.$onChangeSession=this.onChangeSession.bind(this),this.$onAfterExec=this.onAfterExec.bind(this),this.attach(e)};(function(){this.attach=function(e){this.index=0,this.ranges=[],this.tabstops=[],this.$openTabstops=null,this.selectedTabstop=null,this.editor=e,this.editor.on("change",this.$onChange),this.editor.on("changeSelection",this.$onChangeSelection),this.editor.on("changeSession",this.$onChangeSession),this.editor.commands.on("afterExec",this.$onAfterExec),this.editor.keyBinding.addKeyboardHandler(this.keyboardHandler)},this.detach=function(){this.tabstops.forEach(this.removeTabstopMarkers,this),this.ranges=null,this.tabstops=null,this.selectedTabstop=null,this.editor.removeListener("change",this.$onChange),this.editor.removeListener("changeSelection",this.$onChangeSelection),this.editor.removeListener("changeSession",this.$onChangeSession),this.editor.commands.removeListener("afterExec",this.$onAfterExec),this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler),this.editor.tabstopManager=null,this.editor=null},this.onChange=function(e){var t=e.action[0]=="r",n=this.selectedTabstop||{},r=n.parents||{},i=(this.tabstops||[]).slice();for(var s=0;s2&&(this.tabstops.length&&a.push(a.splice(2,1)[0]),this.tabstops.splice.apply(this.tabstops,a))},this.addTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){e.markerId||(e.markerId=t.addMarker(e,"ace_snippet-marker","text"))})},this.removeTabstopMarkers=function(e){var t=this.editor.session;e.forEach(function(e){t.removeMarker(e.markerId),e.markerId=null})},this.removeRange=function(e){var t=e.tabstop.indexOf(e);t!=-1&&e.tabstop.splice(t,1),t=this.ranges.indexOf(e),t!=-1&&this.ranges.splice(t,1),t=e.tabstop.rangeList.ranges.indexOf(e),t!=-1&&e.tabstop.splice(t,1),this.editor.session.removeMarker(e.markerId),e.tabstop.length||(t=this.tabstops.indexOf(e.tabstop),t!=-1&&this.tabstops.splice(t,1),this.tabstops.length||this.detach())},this.keyboardHandler=new a,this.keyboardHandler.bindKeys({Tab:function(e){if(t.snippetManager&&t.snippetManager.expandWithTab(e))return;e.tabstopManager.tabNext(1),e.renderer.scrollCursorIntoView()},"Shift-Tab":function(e){e.tabstopManager.tabNext(-1),e.renderer.scrollCursorIntoView()},Esc:function(e){e.tabstopManager.detach()}})}).call(d.prototype);var v=function(e,t){e.row==0&&(e.column+=t.column),e.row+=t.row},m=function(e,t){e.row==t.row&&(e.column-=t.column),e.row-=t.row};e("./lib/dom").importCssString(".ace_snippet-marker { -moz-box-sizing: border-box; box-sizing: border-box; background: rgba(194, 193, 208, 0.09); border: 1px dotted rgba(211, 208, 235, 0.62); position: absolute;}"),t.snippetManager=new p;var g=e("./editor").Editor;(function(){this.insertSnippet=function(e,n){return t.snippetManager.insertSnippet(this,e,n)},this.expandSnippet=function(e){return t.snippetManager.expandWithTab(this,e)}}).call(g.prototype)}),define("ace/autocomplete",["require","exports","module","ace/keyboard/hash_handler","ace/autocomplete/popup","ace/autocomplete/util","ace/lib/lang","ace/lib/dom","ace/snippets","ace/config"],function(e,t,n){"use strict";var r=e("./keyboard/hash_handler").HashHandler,i=e("./autocomplete/popup").AcePopup,s=e("./autocomplete/util"),o=e("./lib/lang"),u=e("./lib/dom"),a=e("./snippets").snippetManager,f=e("./config"),l=function(){this.autoInsert=!1,this.autoSelect=!0,this.exactMatch=!1,this.gatherCompletionsId=0,this.keyboardHandler=new r,this.keyboardHandler.bindKeys(this.commands),this.blurListener=this.blurListener.bind(this),this.changeListener=this.changeListener.bind(this),this.mousedownListener=this.mousedownListener.bind(this),this.mousewheelListener=this.mousewheelListener.bind(this),this.changeTimer=o.delayedCall(function(){this.updateCompletions(!0)}.bind(this)),this.tooltipTimer=o.delayedCall(this.updateDocTooltip.bind(this),50)};(function(){this.$init=function(){return this.popup=new i(document.body||document.documentElement),this.popup.on("click",function(e){this.insertMatch(),e.stop()}.bind(this)),this.popup.focus=this.editor.focus.bind(this.editor),this.popup.on("show",this.tooltipTimer.bind(null,null)),this.popup.on("select",this.tooltipTimer.bind(null,null)),this.popup.on("changeHoverMarker",this.tooltipTimer.bind(null,null)),this.popup},this.getPopup=function(){return this.popup||this.$init()},this.openPopup=function(e,t,n){this.popup||this.$init(),this.popup.autoSelect=this.autoSelect,this.popup.setData(this.completions.filtered,this.completions.filterText),e.keyBinding.addKeyboardHandler(this.keyboardHandler);var r=e.renderer;this.popup.setRow(this.autoSelect?0:-1);if(!n){this.popup.setTheme(e.getTheme()),this.popup.setFontSize(e.getFontSize());var i=r.layerConfig.lineHeight,s=r.$cursorLayer.getPixelPosition(this.base,!0);s.left-=this.popup.getTextLeftOffset();var o=e.container.getBoundingClientRect();s.top+=o.top-r.layerConfig.offset,s.left+=o.left-e.renderer.scrollLeft,s.left+=r.gutterWidth,this.popup.show(s,i)}else n&&!t&&this.detach()},this.detach=function(){this.editor.keyBinding.removeKeyboardHandler(this.keyboardHandler),this.editor.off("changeSelection",this.changeListener),this.editor.off("blur",this.blurListener),this.editor.off("mousedown",this.mousedownListener),this.editor.off("mousewheel",this.mousewheelListener),this.changeTimer.cancel(),this.hideDocTooltip(),this.gatherCompletionsId+=1,this.popup&&this.popup.isOpen&&this.popup.hide(),this.base&&this.base.detach(),this.activated=!1,this.completions=this.base=null},this.changeListener=function(e){var t=this.editor.selection.lead;(t.row!=this.base.row||t.columnthis.filterText&&e.lastIndexOf(this.filterText,0)===0)var t=this.filtered;else var t=this.all;this.filterText=e,t=this.filterCompletions(t,this.filterText),t=t.sort(function(e,t){return t.exactMatch-e.exactMatch||t.$score-e.$score||(e.caption||e.value).localeCompare(t.caption||t.value)});var n=null;t=t.filter(function(e){var t=e.snippet||e.caption||e.value;return t===n?!1:(n=t,!0)}),this.filtered=t},this.filterCompletions=function(e,t){var n=[],r=t.toUpperCase(),i=t.toLowerCase();e:for(var s=0,o;o=e[s];s++){var u=o.caption||o.value||o.snippet;if(!u)continue;var a=-1,f=0,l=0,c,h;if(this.exactMatch){if(t!==u.substr(0,t.length))continue e}else{var p=u.toLowerCase().indexOf(i);if(p>-1)l=p;else for(var d=0;d=0?m<0||v0&&(a===-1&&(l+=10),l+=h,f|=1<0?e=x():e=o.getValue();var t=m?m.getData(m.getRow()):e;t&&!t.error&&(E(),n.onAccept&&n.onAccept({value:e,item:t},o))}function E(){v.close(),r&&r(),p=null}function S(){if(n.getCompletions){var e;n.getPrefix&&(e=n.getPrefix(o));var t=n.getCompletions(o);m.setData(t,e),m.resize(!0)}}function x(){var e=m.getData(m.getRow());if(e&&!e.error)return e.value||e.caption||e}if(typeof t=="object")return d(e,"",t,n);if(p){var s=p;e=s.editor,s.close();if(s.name&&s.name==n.name)return}if(n.$type)return d[n.$type](e,r);var o=a();o.session.setUndoManager(new f);var h=i.buildDom(["div",{"class":"ace_prompt_container"+(n.hasDescription?" input-box-with-description":"")}]),v=c(e,h,E);h.appendChild(o.container),e&&(e.cmdLine=o,o.setOption("fontSize",e.getOption("fontSize"))),t&&o.setValue(t,1),n.selection&&o.selection.setRange({start:o.session.doc.indexToPosition(n.selection[0]),end:o.session.doc.indexToPosition(n.selection[1])});if(n.getCompletions){var m=new u;m.renderer.setStyle("ace_autocomplete_inline"),m.container.style.display="block",m.container.style.maxWidth="600px",m.container.style.width="100%",m.container.style.marginTop="3px",m.renderer.setScrollMargin(2,2,0,0),m.autoSelect=!1,m.renderer.$maxLines=15,m.setRow(-1),m.on("click",function(e){var t=m.getData(m.getRow());t.error||(o.setValue(t.value||t.name||t),b(),e.stop())}),h.appendChild(m.container),S()}if(n.$rules){var g=new l(n.$rules);o.session.bgTokenizer.setTokenizer(g)}n.placeholder&&o.setOption("placeholder",n.placeholder);if(n.hasDescription){var y=i.buildDom(["div",{"class":"ace_prompt_text_container"}]);i.buildDom(n.prompt||"Press 'Enter' to confirm or 'Escape' to cancel",y),h.appendChild(y)}v.setIgnoreFocusOut(n.ignoreFocusOut);var w={Enter:b,"Esc|Shift-Esc":function(){n.onCancel&&n.onCancel(o.getValue(),o),E()}};m&&Object.assign(w,{Up:function(e){m.goTo("up"),x()},Down:function(e){m.goTo("down"),x()},"Ctrl-Up|Ctrl-Home":function(e){m.goTo("start"),x()},"Ctrl-Down|Ctrl-End":function(e){m.goTo("end"),x()},Tab:function(e){m.goTo("down"),x()},PageUp:function(e){m.gotoPageUp(),x()},PageDown:function(e){m.gotoPageDown(),x()}}),o.commands.bindKeys(w),o.on("input",function(){n.onInput&&n.onInput(),S()}),o.resize(!0),m&&m.resize(!0),o.focus(),p={close:E,name:n.name,editor:e}}var r=e("../range").Range,i=e("../lib/dom"),s=e("../ext/menu_tools/get_editor_keyboard_shortcuts"),o=e("../autocomplete").FilteredList,u=e("../autocomplete/popup").AcePopup,a=e("../autocomplete/popup").$singleLineEditor,f=e("../undomanager").UndoManager,l=e("../tokenizer").Tokenizer,c=e("./menu_tools/overlay_page").overlayPage,h=e("./modelist"),p;d.gotoLine=function(e,t){function n(e){return Array.isArray(e)||(e=[e]),e.map(function(e){var t=e.isBackwards?e.start:e.end,n=e.isBackwards?e.end:e.start,r=n.row,i=r+1+":"+n.column;return n.row==t.row?n.column!=t.column&&(i+=">:"+t.column):i+=">"+(t.row+1)+":"+t.column,i}).reverse().join(", ")}d(e,":"+n(e.selection.toJSON()),{name:"gotoLine",selection:[1,Number.MAX_VALUE],onAccept:function(t){var n=t.value,i=d.gotoLine._history;i||(d.gotoLine._history=i=[]),i.indexOf(n)!=-1&&i.splice(i.indexOf(n),1),i.unshift(n),i.length>20&&(i.length=20);var s=e.getCursorPosition(),o=[];n.replace(/^:/,"").split(/,/).map(function(t){function u(){var t=n[i++];if(!t)return;if(t[0]=="c"){var r=parseInt(t.slice(1))||0;return e.session.doc.indexToPosition(r)}var o=s.row,u=0;return/\d/.test(t)&&(o=parseInt(t)-1,t=n[i++]),t==":"&&(t=n[i++],/\d/.test(t)&&(u=parseInt(t)||0)),{row:o,column:u}}var n=t.split(/([<>:+-]|c?\d+)|[^c\d<>:+-]+/).filter(Boolean),i=0;s=u();var a=r.fromPoints(s,s);n[i]==">"?(i++,a.end=u()):n[i]=="<"&&(i++,a.start=u()),o.unshift(a)}),e.selection.fromJSON(o);var u=e.renderer.scrollTop;e.renderer.scrollSelectionIntoView(e.selection.anchor,e.selection.cursor,.5),e.renderer.animateScrolling(u)},history:function(){var t=e.session.getUndoManager();return d.gotoLine._history?d.gotoLine._history:[]},getCompletions:function(t){var n=t.getValue(),r=n.replace(/^:/,"").split(":"),i=Math.min(parseInt(r[0])||1,e.session.getLength())-1,s=e.session.getLine(i),o=n+" "+s;return[o].concat(this.history())},$rules:{start:[{regex:/\d+/,token:"string"},{regex:/[:,><+\-c]/,token:"keyword"}]}})},d.commands=function(e,t){function n(e){return(e||"").replace(/^./,function(e){return e.toUpperCase(e)}).replace(/[a-z][A-Z]/g,function(e){return e[0]+" "+e[1].toLowerCase(e)})}function r(t){var r=[],i={};return e.keyBinding.$handlers.forEach(function(e){var s=e.platform,o=e.byName;for(var u in o){var a;o[u].bindKey&&o[u].bindKey[s]!==null?a=o[u].bindKey.win:a="";var f=o[u],l=f.description||n(f.name);Array.isArray(f)||(f=[f]),f.forEach(function(e){typeof e!="string"&&(e=e.name);var n=t.find(function(t){return t===e});n||(i[e]?i[e].key+="|"+a:(i[e]={key:a,command:e,description:l},r.push(i[e])))})}}),r}var i=["insertstring","inserttext","setIndentation","paste"],s=r(i);s=s.map(function(e){return{value:e.description,meta:e.key,command:e.command}}),d(e,"",{name:"commands",selection:[0,Number.MAX_VALUE],maxHistoryCount:5,onAccept:function(t){if(t.item){var n=t.item.command;this.addToHistory(t.item),e.execCommand(n)}},addToHistory:function(e){var t=this.history();t.unshift(e),delete e.message;for(var n=1;n0&&t.length>this.maxHistoryCount&&t.splice(t.length-1,1),d.commands.history=t},history:function(){return d.commands.history||[]},getPrefix:function(e){var t=e.getCursorPosition(),n=e.getValue();return n.substring(0,t.column)},getCompletions:function(e){function t(e,t){var n=JSON.parse(JSON.stringify(e)),r=new o(n);return r.filterCompletions(n,t)}function n(e,t){if(!t||!t.length)return e;var n=[];t.forEach(function(e){n.push(e.command)});var r=[];return e.forEach(function(e){n.indexOf(e.command)===-1&&r.push(e)}),r}var r=this.getPrefix(e),i=t(this.history(),r),u=n(s,i);u=t(u,r),i.length&&u.length&&(i[0].message=" Recently used",u[0].message=" Other commands");var a=i.concat(u);return a.length>0?a:[{value:"No matching commands",error:1}]}})},d.modes=function(e,t){var n=h.modes;n=n.map(function(e){return{value:e.caption,mode:e.name}}),d(e,"",{name:"modes",selection:[0,Number.MAX_VALUE],onAccept:function(t){if(t.item){var n="ace/mode/"+t.item.mode;e.session.setMode(n)}},getPrefix:function(e){var t=e.getCursorPosition(),n=e.getValue();return n.substring(0,t.column)},getCompletions:function(e){function t(e,t){var n=JSON.parse(JSON.stringify(e)),r=new o(n);return r.filterCompletions(n,t)}var r=this.getPrefix(e),i=t(n,r);return i.length>0?i:[{caption:"No mode matching",value:"No mode matching",error:1}]}})},i.importCssString(".ace_prompt_container { max-width: 600px; width: 100%; margin: 20px auto; padding: 3px; background: white; border-radius: 2px; box-shadow: 0px 2px 3px 0px #555;}"),t.prompt=d}); (function() { + window.require(["ace/ext/prompt"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-rtl.js b/data/static/vendor/src-min/ext-rtl.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-rtl.js @@ -0,0 +1,8 @@ +define("ace/ext/rtl",["require","exports","module","ace/editor","ace/config"],function(e,t,n){"use strict";function s(e,t){var n=t.getSelection().lead;t.session.$bidiHandler.isRtlLine(n.row)&&n.column===0&&(t.session.$bidiHandler.isMoveLeftOperation&&n.row>0?t.getSelection().moveCursorTo(n.row-1,t.session.getLine(n.row-1).length):t.getSelection().isEmpty()?n.column+=1:n.setPosition(n.row,n.column+1))}function o(e){e.editor.session.$bidiHandler.isMoveLeftOperation=/gotoleft|selectleft|backspace|removewordleft/.test(e.command.name)}function u(e,t){var n=t.session;n.$bidiHandler.currentRow=null;if(n.$bidiHandler.isRtlLine(e.start.row)&&e.action==="insert"&&e.lines.length>1)for(var r=e.start.row;rf)break;if(!u[0]){t.lastIndex=o+=1;if(o>=i.length)break}}}this.searchCounter.textContent=r+" of "+(n>f?f+"+":n)},this.findNext=function(){this.find(!0,!1)},this.findPrev=function(){this.find(!0,!0)},this.findAll=function(){var e=this.editor.findAll(this.searchInput.value,{regExp:this.regExpOption.checked,caseSensitive:this.caseSensitiveOption.checked,wholeWord:this.wholeWordOption.checked}),t=!e&&this.searchInput.value;r.setCssClass(this.searchBox,"ace_nomatch",t),this.editor._emit("findSearchBox",{match:!t}),this.highlight(),this.hide()},this.replace=function(){this.editor.getReadOnly()||this.editor.replace(this.replaceInput.value)},this.replaceAndFindNext=function(){this.editor.getReadOnly()||(this.editor.replace(this.replaceInput.value),this.findNext())},this.replaceAll=function(){this.editor.getReadOnly()||this.editor.replaceAll(this.replaceInput.value)},this.hide=function(){this.active=!1,this.setSearchRange(null),this.editor.off("changeSession",this.setSession),this.element.style.display="none",this.editor.keyBinding.removeKeyboardHandler(this.$closeSearchBarKb),this.editor.focus()},this.show=function(e,t){this.active=!0,this.editor.on("changeSession",this.setSession),this.element.style.display="",this.replaceOption.checked=t,e&&(this.searchInput.value=e),this.searchInput.focus(),this.searchInput.select(),this.editor.keyBinding.addKeyboardHandler(this.$closeSearchBarKb),this.$syncOptions(!0)},this.isFocused=function(){var e=document.activeElement;return e==this.searchInput||e==this.replaceInput}}).call(l.prototype),t.SearchBox=l,t.Search=function(e,t){var n=e.searchBox||new l(e);n.show(e.session.getTextRange(),t)}}); (function() { + window.require(["ace/ext/searchbox"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/ext-settings_menu.js b/data/static/vendor/src-min/ext-settings_menu.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/ext-settings_menu.js @@ -0,0 +1,8 @@ +define("ace/ext/menu_tools/overlay_page",["require","exports","module","ace/lib/dom"],function(e,t,n){"use strict";var r=e("../../lib/dom"),i="#ace_settingsmenu, #kbshortcutmenu {background-color: #F7F7F7;color: black;box-shadow: -5px 4px 5px rgba(126, 126, 126, 0.55);padding: 1em 0.5em 2em 1em;overflow: auto;position: absolute;margin: 0;bottom: 0;right: 0;top: 0;z-index: 9991;cursor: default;}.ace_dark #ace_settingsmenu, .ace_dark #kbshortcutmenu {box-shadow: -20px 10px 25px rgba(126, 126, 126, 0.25);background-color: rgba(255, 255, 255, 0.6);color: black;}.ace_optionsMenuEntry:hover {background-color: rgba(100, 100, 100, 0.1);transition: all 0.3s}.ace_closeButton {background: rgba(245, 146, 146, 0.5);border: 1px solid #F48A8A;border-radius: 50%;padding: 7px;position: absolute;right: -8px;top: -8px;z-index: 100000;}.ace_closeButton{background: rgba(245, 146, 146, 0.9);}.ace_optionsMenuKey {color: darkslateblue;font-weight: bold;}.ace_optionsMenuCommand {color: darkcyan;font-weight: normal;}.ace_optionsMenuEntry input, .ace_optionsMenuEntry button {vertical-align: middle;}.ace_optionsMenuEntry button[ace_selected_button=true] {background: #e7e7e7;box-shadow: 1px 0px 2px 0px #adadad inset;border-color: #adadad;}.ace_optionsMenuEntry button {background: white;border: 1px solid lightgray;margin: 0px;}.ace_optionsMenuEntry button:hover{background: #f0f0f0;}";r.importCssString(i),n.exports.overlayPage=function(t,n,r){function o(e){e.keyCode===27&&u()}function u(){if(!i)return;document.removeEventListener("keydown",o),i.parentNode.removeChild(i),t&&t.focus(),i=null,r&&r()}function a(e){s=e,e&&(i.style.pointerEvents="none",n.style.pointerEvents="auto")}var i=document.createElement("div"),s=!1;return i.style.cssText="margin: 0; padding: 0; position: fixed; top:0; bottom:0; left:0; right:0;z-index: 9990; "+(t?"background-color: rgba(0, 0, 0, 0.3);":""),i.addEventListener("click",function(e){s||u()}),document.addEventListener("keydown",o),n.addEventListener("click",function(e){e.stopPropagation()}),i.appendChild(n),document.body.appendChild(i),t&&t.blur(),{close:u,setIgnoreFocusOut:a}}}),define("ace/ext/modelist",["require","exports","module"],function(e,t,n){"use strict";function i(e){var t=a.text,n=e.split(/[\/\\]/).pop();for(var i=0;i 0!";if(e==this.$splits)return;if(e>this.$splits){while(this.$splitse)t=this.$editors[this.$splits-1],this.$container.removeChild(t.container),this.$splits--;this.resize()},this.getSplits=function(){return this.$splits},this.getEditor=function(e){return this.$editors[e]},this.getCurrentEditor=function(){return this.$cEditor},this.focus=function(){this.$cEditor.focus()},this.blur=function(){this.$cEditor.blur()},this.setTheme=function(e){this.$editors.forEach(function(t){t.setTheme(e)})},this.setKeyboardHandler=function(e){this.$editors.forEach(function(t){t.setKeyboardHandler(e)})},this.forEach=function(e,t){this.$editors.forEach(e,t)},this.$fontSize="",this.setFontSize=function(e){this.$fontSize=e,this.forEach(function(t){t.setFontSize(e)})},this.$cloneSession=function(e){var t=new a(e.getDocument(),e.getMode()),n=e.getUndoManager();return t.setUndoManager(n),t.setTabSize(e.getTabSize()),t.setUseSoftTabs(e.getUseSoftTabs()),t.setOverwrite(e.getOverwrite()),t.setBreakpoints(e.getBreakpoints()),t.setUseWrapMode(e.getUseWrapMode()),t.setUseWorker(e.getUseWorker()),t.setWrapLimitRange(e.$wrapLimitRange.min,e.$wrapLimitRange.max),t.$foldData=e.$cloneFoldData(),t},this.setSession=function(e,t){var n;t==null?n=this.$cEditor:n=this.$editors[t];var r=this.$editors.some(function(t){return t.session===e});return r&&(e=this.$cloneSession(e)),n.setSession(e),e},this.getOrientation=function(){return this.$orientation},this.setOrientation=function(e){if(this.$orientation==e)return;this.$orientation=e,this.resize()},this.resize=function(){var e=this.$container.clientWidth,t=this.$container.clientHeight,n;if(this.$orientation==this.BESIDE){var r=e/this.$splits;for(var i=0;i")}return this.textContent&&e.push(this.textContent),this.type!="fragment"&&e.push(""),e.join("")};var l={createTextNode:function(e,t){return a(e)},createElement:function(e){return new f(e)},createFragment:function(){return new f("fragment")}},c=function(){this.config={},this.dom=l};c.prototype=i.prototype;var h=function(e,t,n){var r=e.className.match(/lang-(\w+)/),i=t.mode||r&&"ace/mode/"+r[1];if(!i)return!1;var s=t.theme||"ace/theme/textmate",o="",a=[];if(e.firstElementChild){var f=0;for(var l=0;l");return}e.push("")}var s=null,o={mode:"Mode:",wrap:"Soft Wrap:",theme:"Theme:",fontSize:"Font Size:",showGutter:"Display Gutter:",keybindings:"Keyboard",showPrintMargin:"Show Print Margin:",useSoftTabs:"Use Soft Tabs:",showInvisibles:"Show Invisibles"},u={mode:{text:"Plain",javascript:"JavaScript",xml:"XML",html:"HTML",css:"CSS",scss:"SCSS",python:"Python",php:"PHP",java:"Java",ruby:"Ruby",c_cpp:"C/C++",coffee:"CoffeeScript",json:"json",perl:"Perl",clojure:"Clojure",ocaml:"OCaml",csharp:"C#",haxe:"haXe",svg:"SVG",textile:"Textile",groovy:"Groovy",liquid:"Liquid",Scala:"Scala"},theme:{clouds:"Clouds",clouds_midnight:"Clouds Midnight",cobalt:"Cobalt",crimson_editor:"Crimson Editor",dawn:"Dawn",gob:"Green on Black",eclipse:"Eclipse",idle_fingers:"Idle Fingers",kr_theme:"Kr Theme",merbivore:"Merbivore",merbivore_soft:"Merbivore Soft",mono_industrial:"Mono Industrial",monokai:"Monokai",pastel_on_dark:"Pastel On Dark",solarized_dark:"Solarized Dark",solarized_light:"Solarized Light",textmate:"Textmate",twilight:"Twilight",vibrant_ink:"Vibrant Ink"},showGutter:s,fontSize:{"10px":"10px","11px":"11px","12px":"12px","14px":"14px","16px":"16px"},wrap:{off:"Off",40:"40",80:"80",free:"Free"},keybindings:{ace:"ace",vim:"vim",emacs:"emacs"},showPrintMargin:s,useSoftTabs:s,showInvisibles:s},a=[];a.push("");for(var l in t.defaultOptions)a.push(""),a.push("");a.push("
        SettingValue
        ",o[l],""),f(a,l,u[l],i.getOption(l)),a.push("
        "),e.innerHTML=a.join("");var c=function(e){var t=e.currentTarget;i.setOption(t.title,t.value)},h=function(e){var t=e.currentTarget;i.setOption(t.title,t.checked)},p=e.getElementsByTagName("select");for(var d=0;d0&&!(s%l)&&!(f%l)&&(r[l]=(r[l]||0)+1),n[f]=(n[f]||0)+1}s=f}while(up.score&&(p={score:v,length:u})}if(p.score&&p.score>1.4)var m=p.length;if(i>d+1){if(m==1||di+1)return{ch:" ",length:m}},t.detectIndentation=function(e){var n=e.getLines(0,1e3),r=t.$detectIndentation(n)||{};return r.ch&&e.setUseSoftTabs(r.ch==" "),r.length&&e.setTabSize(r.length),r},t.trimTrailingSpace=function(e,t){var n=e.getDocument(),r=n.getAllLines(),i=t&&t.trimEmpty?-1:0,s=[],o=-1;t&&t.keepCursorPosition&&(e.selection.rangeCount?e.selection.rangeList.ranges.forEach(function(e,t,n){var r=n[t+1];if(r&&r.cursor.row==e.cursor.row)return;s.push(e.cursor)}):s.push(e.selection.getCursor()),o=0);var u=s[o]&&s[o].row;for(var a=0,f=r.length;ai&&(c=s[o].column),o++,u=s[o]?s[o].row:-1),c>i&&n.removeInLine(a,c,l.length)}},t.convertIndentation=function(e,t,n){var i=e.getTabString()[0],s=e.getTabSize();n||(n=s),t||(t=i);var o=t==" "?t:r.stringRepeat(t,n),u=e.doc,a=u.getAllLines(),f={},l={};for(var c=0,h=a.length;c30&&this.$data.shift()},append:function(e){var t=this.$data.length-1,n=this.$data[t]||"";e&&(n+=e),n&&(this.$data[t]=n)},get:function(e){return e=e||1,this.$data.slice(this.$data.length-e,this.$data.length).reverse().join("\n")},pop:function(){return this.$data.length>1&&this.$data.pop(),this.get()},rotate:function(){return this.$data.unshift(this.$data.pop()),this.get()}}}); (function() { + window.require(["ace/keyboard/emacs"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/keybinding-sublime.js b/data/static/vendor/src-min/keybinding-sublime.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/keybinding-sublime.js @@ -0,0 +1,8 @@ +define("ace/keyboard/sublime",["require","exports","module","ace/keyboard/hash_handler"],function(e,t,n){"use strict";function i(e,t,n){function f(e){return e?/\s/.test(e)?"s":e=="_"?"_":e.toUpperCase()==e&&e.toLowerCase()!=e?"W":e.toUpperCase()!=e&&e.toLowerCase()==e?"w":"o":"-"}var r=e.selection,i=r.lead.row,s=r.lead.column,o=e.session.getLine(i);if(!o[s+t]){var u=(n?"selectWord":"moveCursorShortWord")+(t==1?"Right":"Left");return e.selection[u]()}t==-1&&s--;while(o[s]){var a=f(o[s])+f(o[s+t]);s+=t;if(t==1){if(a=="WW"&&f(o[s+1])=="w")break}else{if(a=="wW"){if(f(o[s-1])=="W"){s-=1;break}continue}if(a=="Ww")break}if(/w[s_oW]|_[sWo]|o[s_wW]|s[W]|W[so]/.test(a))break}t==-1&&s++,n?e.selection.moveCursorTo(i,s):e.selection.moveTo(i,s)}var r=e("../keyboard/hash_handler").HashHandler;t.handler=new r,t.handler.addCommands([{name:"find_all_under",exec:function(e){e.selection.isEmpty()&&e.selection.selectWord(),e.findAll()},readOnly:!0},{name:"find_under",exec:function(e){e.selection.isEmpty()&&e.selection.selectWord(),e.findNext()},readOnly:!0},{name:"find_under_prev",exec:function(e){e.selection.isEmpty()&&e.selection.selectWord(),e.findPrevious()},readOnly:!0},{name:"find_under_expand",exec:function(e){e.selectMore(1,!1,!0)},scrollIntoView:"animate",readOnly:!0},{name:"find_under_expand_skip",exec:function(e){e.selectMore(1,!0,!0)},scrollIntoView:"animate",readOnly:!0},{name:"delete_to_hard_bol",exec:function(e){var t=e.selection.getCursor();e.session.remove({start:{row:t.row,column:0},end:t})},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"delete_to_hard_eol",exec:function(e){var t=e.selection.getCursor();e.session.remove({start:t,end:{row:t.row,column:Infinity}})},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"moveToWordStartLeft",exec:function(e){e.selection.moveCursorLongWordLeft(),e.clearSelection()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"moveToWordEndRight",exec:function(e){e.selection.moveCursorLongWordRight(),e.clearSelection()},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"selectToWordStartLeft",exec:function(e){var t=e.selection;t.$moveSelection(t.moveCursorLongWordLeft)},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"selectToWordEndRight",exec:function(e){var t=e.selection;t.$moveSelection(t.moveCursorLongWordRight)},multiSelectAction:"forEach",scrollIntoView:"cursor"},{name:"selectSubWordRight",exec:function(e){i(e,1,!0)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"selectSubWordLeft",exec:function(e){i(e,-1,!0)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"moveSubWordRight",exec:function(e){i(e,1)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0},{name:"moveSubWordLeft",exec:function(e){i(e,-1)},multiSelectAction:"forEach",scrollIntoView:"cursor",readOnly:!0}]),[{bindKey:{mac:"cmd-k cmd-backspace|cmd-backspace",win:"ctrl-shift-backspace|ctrl-k ctrl-backspace"},name:"removetolinestarthard"},{bindKey:{mac:"cmd-k cmd-k|cmd-delete|ctrl-k",win:"ctrl-shift-delete|ctrl-k ctrl-k"},name:"removetolineendhard"},{bindKey:{mac:"cmd-shift-d",win:"ctrl-shift-d"},name:"duplicateSelection"},{bindKey:{mac:"cmd-l",win:"ctrl-l"},name:"expandtoline"},{bindKey:{mac:"cmd-shift-a",win:"ctrl-shift-a"},name:"expandSelection",args:{to:"tag"}},{bindKey:{mac:"cmd-shift-j",win:"ctrl-shift-j"},name:"expandSelection",args:{to:"indentation"}},{bindKey:{mac:"ctrl-shift-m",win:"ctrl-shift-m"},name:"expandSelection",args:{to:"brackets"}},{bindKey:{mac:"cmd-shift-space",win:"ctrl-shift-space"},name:"expandSelection",args:{to:"scope"}},{bindKey:{mac:"ctrl-cmd-g",win:"alt-f3"},name:"find_all_under"},{bindKey:{mac:"alt-cmd-g",win:"ctrl-f3"},name:"find_under"},{bindKey:{mac:"shift-alt-cmd-g",win:"ctrl-shift-f3"},name:"find_under_prev"},{bindKey:{mac:"cmd-g",win:"f3"},name:"findnext"},{bindKey:{mac:"shift-cmd-g",win:"shift-f3"},name:"findprevious"},{bindKey:{mac:"cmd-d",win:"ctrl-d"},name:"find_under_expand"},{bindKey:{mac:"cmd-k cmd-d",win:"ctrl-k ctrl-d"},name:"find_under_expand_skip"},{bindKey:{mac:"cmd-alt-[",win:"ctrl-shift-["},name:"toggleFoldWidget"},{bindKey:{mac:"cmd-alt-]",win:"ctrl-shift-]"},name:"unfold"},{bindKey:{mac:"cmd-k cmd-0|cmd-k cmd-j",win:"ctrl-k ctrl-0|ctrl-k ctrl-j"},name:"unfoldall"},{bindKey:{mac:"cmd-k cmd-1",win:"ctrl-k ctrl-1"},name:"foldOther",args:{level:1}},{bindKey:{win:"ctrl-left",mac:"alt-left"},name:"moveToWordStartLeft"},{bindKey:{win:"ctrl-right",mac:"alt-right"},name:"moveToWordEndRight"},{bindKey:{win:"ctrl-shift-left",mac:"alt-shift-left"},name:"selectToWordStartLeft"},{bindKey:{win:"ctrl-shift-right",mac:"alt-shift-right"},name:"selectToWordEndRight"},{bindKey:{mac:"ctrl-alt-shift-right|ctrl-shift-right",win:"alt-shift-right"},name:"selectSubWordRight"},{bindKey:{mac:"ctrl-alt-shift-left|ctrl-shift-left",win:"alt-shift-left"},name:"selectSubWordLeft"},{bindKey:{mac:"ctrl-alt-right|ctrl-right",win:"alt-right"},name:"moveSubWordRight"},{bindKey:{mac:"ctrl-alt-left|ctrl-left",win:"alt-left"},name:"moveSubWordLeft"},{bindKey:{mac:"ctrl-m",win:"ctrl-m"},name:"jumptomatching",args:{to:"brackets"}},{bindKey:{mac:"ctrl-f6",win:"ctrl-f6"},name:"goToNextError"},{bindKey:{mac:"ctrl-shift-f6",win:"ctrl-shift-f6"},name:"goToPreviousError"},{bindKey:{mac:"ctrl-o"},name:"splitline"},{bindKey:{mac:"ctrl-shift-w",win:"alt-shift-w"},name:"surrowndWithTag"},{bindKey:{mac:"cmd-alt-.",win:"alt-."},name:"close_tag"},{bindKey:{mac:"cmd-j",win:"ctrl-j"},name:"joinlines"},{bindKey:{mac:"ctrl--",win:"alt--"},name:"jumpBack"},{bindKey:{mac:"ctrl-shift--",win:"alt-shift--"},name:"jumpForward"},{bindKey:{mac:"cmd-k cmd-l",win:"ctrl-k ctrl-l"},name:"tolowercase"},{bindKey:{mac:"cmd-k cmd-u",win:"ctrl-k ctrl-u"},name:"touppercase"},{bindKey:{mac:"cmd-shift-v",win:"ctrl-shift-v"},name:"paste_and_indent"},{bindKey:{mac:"cmd-k cmd-v|cmd-alt-v",win:"ctrl-k ctrl-v"},name:"paste_from_history"},{bindKey:{mac:"cmd-shift-enter",win:"ctrl-shift-enter"},name:"addLineBefore"},{bindKey:{mac:"cmd-enter",win:"ctrl-enter"},name:"addLineAfter"},{bindKey:{mac:"ctrl-shift-k",win:"ctrl-shift-k"},name:"removeline"},{bindKey:{mac:"ctrl-alt-up",win:"ctrl-up"},name:"scrollup"},{bindKey:{mac:"ctrl-alt-down",win:"ctrl-down"},name:"scrolldown"},{bindKey:{mac:"cmd-a",win:"ctrl-a"},name:"selectall"},{bindKey:{linux:"alt-shift-down",mac:"ctrl-shift-down",win:"ctrl-alt-down"},name:"addCursorBelow"},{bindKey:{linux:"alt-shift-up",mac:"ctrl-shift-up",win:"ctrl-alt-up"},name:"addCursorAbove"},{bindKey:{mac:"cmd-k cmd-c|ctrl-l",win:"ctrl-k ctrl-c"},name:"centerselection"},{bindKey:{mac:"f5",win:"f9"},name:"sortlines"},{bindKey:{mac:"ctrl-f5",win:"ctrl-f9"},name:"sortlines",args:{caseSensitive:!0}},{bindKey:{mac:"cmd-shift-l",win:"ctrl-shift-l"},name:"splitSelectionIntoLines"},{bindKey:{mac:"ctrl-cmd-down",win:"ctrl-shift-down"},name:"movelinesdown"},{bindKey:{mac:"ctrl-cmd-up",win:"ctrl-shift-up"},name:"movelinesup"},{bindKey:{mac:"alt-down",win:"alt-down"},name:"modifyNumberDown"},{bindKey:{mac:"alt-up",win:"alt-up"},name:"modifyNumberUp"},{bindKey:{mac:"cmd-/",win:"ctrl-/"},name:"togglecomment"},{bindKey:{mac:"cmd-alt-/",win:"ctrl-shift-/"},name:"toggleBlockComment"},{bindKey:{linux:"ctrl-alt-q",mac:"ctrl-q",win:"ctrl-q"},name:"togglerecording"},{bindKey:{linux:"ctrl-alt-shift-q",mac:"ctrl-shift-q",win:"ctrl-shift-q"},name:"replaymacro"},{bindKey:{mac:"ctrl-t",win:"ctrl-t"},name:"transpose"}].forEach(function(e){var n=t.handler.commands[e.name];n&&(n.bindKey=e.bindKey),t.handler.bindKey(e.bindKey,n||e.name)})}); (function() { + window.require(["ace/keyboard/sublime"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/keybinding-vim.js b/data/static/vendor/src-min/keybinding-vim.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/keybinding-vim.js @@ -0,0 +1,8 @@ +define("ace/keyboard/vim",["require","exports","module","ace/range","ace/lib/event_emitter","ace/lib/dom","ace/lib/oop","ace/lib/keys","ace/lib/event","ace/search","ace/lib/useragent","ace/search_highlight","ace/commands/multi_select_commands","ace/mode/text","ace/multi_select"],function(e,t,n){"use strict";function r(){function t(e){return typeof e!="object"?e+"":"line"in e?e.line+":"+e.ch:"anchor"in e?t(e.anchor)+"->"+t(e.head):Array.isArray(e)?"["+e.map(function(e){return t(e)})+"]":JSON.stringify(e)}var e="";for(var n=0;n"):!1}function _(e){var t=e.state.vim;return t.onPasteFn||(t.onPasteFn=function(){t.insertMode||(e.setCursor(Tt(e.getCursor(),0,1)),wt.enterInsertMode(e,{},t))}),t.onPasteFn}function B(e,t){var n=[];for(var r=e;r=e.firstLine()&&t<=e.lastLine()}function z(e){return/^[a-z]$/.test(e)}function W(e){return"()[]{}".indexOf(e)!=-1}function X(e){return D.test(e)}function V(e){return/^[A-Z]$/.test(e)}function $(e){return/^\s*$/.test(e)}function J(e){return".?!".indexOf(e)!=-1}function K(e,t){for(var n=0;n"){var n=t.length-11,r=e.slice(0,n),i=t.slice(0,n);return r==i&&e.length>n?"full":i.indexOf(r)==0?"partial":!1}return e==t?"full":t.indexOf(e)==0?"partial":!1}function kt(e){var t=/^.*(<[^>]+>)$/.exec(e),n=t?t[1]:e.slice(-1);if(n.length>1)switch(n){case"":n="\n";break;case"":n=" ";break;default:n=""}return n}function Lt(e,t,n){return function(){for(var r=0;r2&&(t=_t.apply(undefined,Array.prototype.slice.call(arguments,1))),Mt(e,t)?e:t}function Dt(e,t){return arguments.length>2&&(t=Dt.apply(undefined,Array.prototype.slice.call(arguments,1))),Mt(e,t)?t:e}function Pt(e,t,n){var r=Mt(e,t),i=Mt(t,n);return r&&i}function Ht(e,t){return e.getLine(t).length}function Bt(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}function jt(e){return e.replace(/([.?*+$\[\]\/\\(){}|\-])/g,"\\$1")}function Ft(e,t,n){var r=Ht(e,t),i=(new Array(n-r+1)).join(" ");e.setCursor(S(t,r)),e.replaceRange(i,e.getCursor())}function It(e,t){var n=[],r=e.listSelections(),i=At(e.clipPos(t)),s=!Ot(t,i),o=e.getCursor("head"),u=Rt(r,o),a=Ot(r[u].head,r[u].anchor),f=r.length-1,l=f-u>u?f:0,c=r[l].anchor,h=Math.min(c.line,i.line),p=Math.max(c.line,i.line),d=c.ch,v=i.ch,m=r[l].head.ch-d,g=v-d;m>0&&g<=0?(d++,s||v--):m<0&&g>=0?(d--,a||v++):m<0&&g==-1&&(d--,v++);for(var y=h;y<=p;y++){var b={anchor:new S(y,d),head:new S(y,v)};n.push(b)}return e.setSelections(n),t.ch=v,c.ch=d,c}function qt(e,t,n){var r=[];for(var i=0;ia&&(i.line=a),i.ch=Ht(e,i.line)}else i.ch=0,s.ch=Ht(e,s.line);return{ranges:[{anchor:s,head:i}],primary:0}}if(n=="block"){var f=Math.min(s.line,i.line),l=Math.min(s.ch,i.ch),c=Math.max(s.line,i.line),h=Math.max(s.ch,i.ch)+1,p=c-f+1,d=i.line==f?0:p-1,v=[];for(var m=0;m0&&s&&$(s);s=i.pop())n.line--,n.ch=0;s?(n.line--,n.ch=Ht(e,n.line)):n.ch=0}}function Qt(e,t,n){t.ch=0,n.ch=0,n.line++}function Gt(e){if(!e)return 0;var t=e.search(/\S/);return t==-1?e.length:t}function Yt(e,t,n,r,i){var s=$t(e),o=e.getLine(s.line),u=s.ch,a=i?P[0]:H[0];while(!a(o.charAt(u))){u++;if(u>=o.length)return null}r?a=H[0]:(a=P[0],a(o.charAt(u))||(a=P[1]));var f=u,l=u;while(a(o.charAt(f))&&f=0)l--;l++;if(t){var c=f;while(/\s/.test(o.charAt(f))&&f0)l--;l||(l=h)}}return{start:S(s.line,l),end:S(s.line,f)}}function Zt(e,t,n){Ot(t,n)||it.jumpList.add(e,t,n)}function en(e,t){it.lastCharacterSearch.increment=e,it.lastCharacterSearch.forward=t.forward,it.lastCharacterSearch.selectedCharacter=t.selectedCharacter}function rn(e,t,n,r){var i=At(e.getCursor()),s=n?1:-1,o=n?e.lineCount():-1,u=i.ch,a=i.line,f=e.getLine(a),l={lineText:f,nextCh:f.charAt(u),lastCh:null,index:u,symb:r,reverseSymb:(n?{")":"(","}":"{"}:{"(":")","{":"}"})[r],forward:n,depth:0,curMoveThrough:!1},c=tn[r];if(!c)return i;var h=nn[c].init,p=nn[c].isComplete;h&&h(l);while(a!==o&&t){l.index+=s,l.nextCh=l.lineText.charAt(l.index);if(!l.nextCh){a+=s,l.lineText=e.getLine(a)||"";if(s>0)l.index=0;else{var d=l.lineText.length;l.index=d>0?d-1:0}l.nextCh=l.lineText.charAt(l.index)}p(l)&&(i.line=a,i.ch=l.index,t--)}return l.nextCh||l.curMoveThrough?S(a,l.index):i}function sn(e,t,n,r,i){var s=t.line,o=t.ch,u=e.getLine(s),a=n?1:-1,f=r?H:P;if(i&&u==""){s+=a,u=e.getLine(s);if(!U(e,s))return null;o=n?0:u.length}for(;;){if(i&&u=="")return{from:0,to:0,line:s};var l=a>0?u.length:-1,c=l,h=l;while(o!=l){var p=!1;for(var d=0;d0?0:u.length}}function on(e,t,n,r,i,s){var o=At(t),u=[];(r&&!i||!r&&i)&&n++;var a=!r||!i;for(var f=0;f0?1:-1;var n=e.ace.session.getFoldLine(t);n&&t+r>n.start.row&&t+r0?n.end.row:n.start.row)-t)}var s=t.line,o=e.firstLine(),u=e.lastLine(),a,f,l=s;if(r){while(o<=l&&l<=u&&n>0)p(l),h(l,r)&&n--,l+=r;return new S(l,0)}var d=e.state.vim;if(d.visualLine&&h(s,1,!0)){var v=d.sel.anchor;h(v.line,-1,!0)&&(!i||v.line!=s)&&(s+=1)}var m=c(s);for(l=s;l<=u&&n;l++)h(l,1,!0)&&(!i||c(l)!=m)&&n--;f=new S(l,0),l>u&&!m?m=!0:i=!1;for(l=s;l>o;l--)if(!i||c(l)==m||l==s)if(h(l,-1,!0))break;return a=new S(l,0),{start:a,end:f}}function hn(e,t,n,r){function i(e,t){if(t.pos+t.dir<0||t.pos+t.dir>=t.line.length){t.ln+=t.dir;if(!U(e,t.ln)){t.line=null,t.ln=null,t.pos=null;return}t.line=e.getLine(t.ln),t.pos=t.dir>0?0:t.line.length-1}else t.pos+=t.dir}function s(e,t,n,r){var s=e.getLine(t),o=s==="",u={line:s,ln:t,pos:n,dir:r},a={ln:u.ln,pos:u.pos},f=u.line==="";i(e,u);while(u.line!==null){a.ln=u.ln,a.pos=u.pos;if(u.line===""&&!f)return{ln:u.ln,pos:u.pos};if(o&&u.line!==""&&!$(u.line[u.pos]))return{ln:u.ln,pos:u.pos};J(u.line[u.pos])&&!o&&(u.pos===u.line.length-1||$(u.line[u.pos+1]))&&(o=!0),i(e,u)}var s=e.getLine(a.ln);a.pos=0;for(var l=s.length-1;l>=0;--l)if(!$(s[l])){a.pos=l;break}return a}function o(e,t,n,r){var s=e.getLine(t),o={line:s,ln:t,pos:n,dir:r},u={ln:o.ln,pos:null},a=o.line==="";i(e,o);while(o.line!==null){if(o.line===""&&!a)return u.pos!==null?u:{ln:o.ln,pos:o.pos};if(!(!J(o.line[o.pos])||u.pos===null||o.ln===u.ln&&o.pos+1===u.pos))return u;o.line!==""&&!$(o.line[o.pos])&&(a=!1,u={ln:o.ln,pos:o.pos}),i(e,o)}var s=e.getLine(u.ln);u.pos=0;for(var f=0;f0)r<0?u=o(e,u.ln,u.pos,r):u=s(e,u.ln,u.pos,r),n--;return S(u.ln,u.pos)}function pn(e,t,n,r){var i=t,s,o,u={"(":/[()]/,")":/[()]/,"[":/[[\]]/,"]":/[[\]]/,"{":/[{}]/,"}":/[{}]/,"<":/[<>]/,">":/[<>]/}[n],a={"(":"(",")":"(","[":"[","]":"[","{":"{","}":"{","<":"<",">":"<"}[n],f=e.getLine(i.line).charAt(i.ch),l=f===a?1:0;s=e.scanForBracket(S(i.line,i.ch+l),-1,undefined,{bracketRegex:u}),o=e.scanForBracket(S(i.line,i.ch+l),1,undefined,{bracketRegex:u});if(!s||!o)return{start:i,end:i};s=s.pos,o=o.pos;if(s.line==o.line&&s.ch>o.ch||s.line>o.line){var c=s;s=o,o=c}return r?o.ch+=1:s.ch+=1,{start:s,end:o}}function dn(e,t,n,r){var i=At(t),s=e.getLine(i.line),o=s.split(""),u,a,f,l,c=o.indexOf(n);i.ch-1&&!u;f--)o[f]==n&&(u=f+1);if(u&&!a)for(f=u,l=o.length;f'+t+"",{bottom:!0,duration:5e3}):alert(t)}function An(e,t){var n=''+(e||"")+'';return t&&(n+=' '+t+""),n}function Mn(e,t){var n=(t.prefix||"")+" "+(t.desc||""),r=An(t.prefix,t.desc);gn(e,r,n,t.onClose,t)}function _n(e,t){if(e instanceof RegExp&&t instanceof RegExp){var n=["global","multiline","ignoreCase","source"];for(var r=0;r=t&&e<=n:e==t}function In(e){var t=e.ace.renderer;return{top:t.getFirstFullyVisibleRow(),bottom:t.getLastFullyVisibleRow()}}function qn(e,t,n){if(n=="'"||n=="`")return it.jumpList.find(e,-1)||S(0,0);if(n==".")return Rn(e);var r=t.marks[n];return r&&r.find()}function Rn(e){var t=e.ace.session.$undoManager;if(t&&t.$lastDelta)return g(t.$lastDelta.end)}function Xn(e,t,n,r,i,s,o,u,a){function c(){e.operation(function(){while(!f)h(),p();d()})}function h(){var t=e.getRange(s.from(),s.to()),n=t.replace(o,u);s.replace(n)}function p(){while(s.findNext()&&Fn(s.from(),r,i)){if(!n&&l&&s.from().line==l.line)continue;e.scrollIntoView(s.from(),30),e.setSelection(s.from(),s.to()),l=s.from(),f=!1;return}f=!0}function d(t){t&&t(),e.focus();if(l){e.setCursor(l);var n=e.state.vim;n.exMode=!1,n.lastHPos=n.lastHSPos=l.ch}a&&a()}function m(t,n,r){v.e_stop(t);var i=v.keyName(t);switch(i){case"Y":h(),p();break;case"N":p();break;case"A":var s=a;a=undefined,e.operation(c),a=s;break;case"L":h();case"Q":case"Esc":case"Ctrl-C":case"Ctrl-[":d(r)}return f&&d(r),!0}e.state.vim.exMode=!0;var f=!1,l=s.from();p();if(f){Ln(e,"No matches for "+o.source);return}if(!t){c(),a&&a();return}Mn(e,{prefix:"replace with "+u+" (y/n/a/q/l)",onKeyDown:m})}function Vn(e){var t=e.state.vim,n=it.macroModeState,r=it.registerController.getRegister("."),i=n.isPlaying,s=n.lastInsertModeChanges;i||(e.off("change",Zn),v.off(e.getInputField(),"keydown",ir)),!i&&t.insertModeRepeat>1&&(sr(e,t,t.insertModeRepeat-1,!0),t.lastEditInputState.repeatOverride=t.insertModeRepeat),delete t.insertModeRepeat,t.insertMode=!1,e.setCursor(e.getCursor().line,e.getCursor().ch-1),e.setOption("keyMap","vim"),e.setOption("disableInput",!0),e.toggleOverwrite(!1),r.setText(s.changes.join("")),v.signal(e,"vim-mode-change",{mode:"normal"}),n.isRecording&&Gn(n)}function $n(e){b.unshift(e)}function Jn(e,t,n,r,i){var s={keys:e,type:t};s[t]=n,s[t+"Args"]=r;for(var o in i)s[o]=i[o];$n(s)}function Kn(e,t,n,r){var i=it.registerController.getRegister(r);if(r==":"){i.keyBuffer[0]&&Wn.processCommand(e,i.keyBuffer[0]),n.isPlaying=!1;return}var s=i.keyBuffer,o=0;n.isPlaying=!0,n.replaySearchQueries=i.searchQueries.slice(0);for(var u=0;u|<\w+>|./.exec(a),l=f[0],a=a.substring(f.index+l.length),v.Vim.handleKey(e,l,"macro");if(t.insertMode){var c=i.insertModeChanges[o++].changes;it.macroModeState.lastInsertModeChanges.changes=c,or(e,c,1),Vn(e)}}}n.isPlaying=!1}function Qn(e,t){if(e.isPlaying)return;var n=e.latestRegister,r=it.registerController.getRegister(n);r&&r.pushText(t)}function Gn(e){if(e.isPlaying)return;var t=e.latestRegister,n=it.registerController.getRegister(t);n&&n.pushInsertModeChanges&&n.pushInsertModeChanges(e.lastInsertModeChanges)}function Yn(e,t){if(e.isPlaying)return;var n=e.latestRegister,r=it.registerController.getRegister(n);r&&r.pushSearchQuery&&r.pushSearchQuery(t)}function Zn(e,t){var n=it.macroModeState,r=n.lastInsertModeChanges;if(!n.isPlaying)while(t){r.expectCursorActivityForChange=!0;if(r.ignoreCount>1)r.ignoreCount--;else if(t.origin=="+input"||t.origin=="paste"||t.origin===undefined){var i=e.listSelections().length;i>1&&(r.ignoreCount=i);var s=t.text.join("\n");r.maybeReset&&(r.changes=[],r.maybeReset=!1),s&&(e.state.overwrite&&!/\n/.test(s)?r.changes.push([s]):r.changes.push(s))}t=t.next}}function er(e){var t=e.state.vim;if(t.insertMode){var n=it.macroModeState;if(n.isPlaying)return;var r=n.lastInsertModeChanges;r.expectCursorActivityForChange?r.expectCursorActivityForChange=!1:r.maybeReset=!0}else e.curOp.isVimOp||nr(e,t);t.visualMode&&tr(e)}function tr(e){var t=e.state.vim,n=St(e,At(t.sel.head)),r=Tt(n,0,1);t.fakeCursor&&t.fakeCursor.clear(),t.fakeCursor=e.markText(n,r,{className:"cm-animate-fat-cursor"})}function nr(e,t,n){var r=e.getCursor("anchor"),i=e.getCursor("head");t.visualMode&&!e.somethingSelected()?Jt(e,!1):!t.visualMode&&!t.insertMode&&e.somethingSelected()&&(t.visualMode=!0,t.visualLine=!1,v.signal(e,"vim-mode-change",{mode:"visual"}));if(t.visualMode){var s=Mt(i,r)?0:-1,o=Mt(i,r)?-1:0;i=Tt(i,0,s),r=Tt(r,0,o),t.sel={anchor:r,head:i},fn(e,t,"<",_t(i,r)),fn(e,t,">",Dt(i,r))}else!t.insertMode&&!n&&(t.lastHPos=e.getCursor().ch)}function rr(e){this.keyName=e}function ir(e){function i(){return n.maybeReset&&(n.changes=[],n.maybeReset=!1),n.changes.push(new rr(r)),!0}var t=it.macroModeState,n=t.lastInsertModeChanges,r=v.keyName(e);if(!r)return;(r.indexOf("Delete")!=-1||r.indexOf("Backspace")!=-1)&&v.lookupKey(r,"vim-insert",i)}function sr(e,t,n,r){function u(){s?dt.processAction(e,t,t.lastEditActionCommand):dt.evalInput(e,t)}function a(n){if(i.lastInsertModeChanges.changes.length>0){n=t.lastEditActionCommand?n:1;var r=i.lastInsertModeChanges;or(e,r.changes,n)}}var i=it.macroModeState;i.isPlaying=!0;var s=!!t.lastEditActionCommand,o=t.inputState;t.inputState=t.lastEditInputState;if(s&&t.lastEditActionCommand.interlaceInsertRepeat)for(var f=0;f1&&t[0]=="n"&&(t=t.replace("numpad","")),t=ur[t]||t;var r="";return n.ctrlKey&&(r+="C-"),n.altKey&&(r+="A-"),(r||t.length>1)&&n.shiftKey&&(r+="S-"),r+=t,r.length>1&&(r="<"+r+">"),r}function lr(e){var t=new e.constructor;return Object.keys(e).forEach(function(n){var r=e[n];Array.isArray(r)?r=r.slice():r&&typeof r=="object"&&r.constructor!=Object&&(r=lr(r)),t[n]=r}),e.sel&&(t.sel={head:e.sel.head&&At(e.sel.head),anchor:e.sel.anchor&&At(e.sel.anchor)}),t}function cr(e,t,n){var r=!1,i=x.maybeInitVimState_(e),s=i.visualBlock||i.wasInVisualBlock,o=e.ace.inMultiSelectMode;i.wasInVisualBlock&&!o?i.wasInVisualBlock=!1:o&&i.visualBlock&&(i.wasInVisualBlock=!0);if(t==""&&!i.insertMode&&!i.visualMode&&o)e.ace.exitMultiSelectMode();else if(s||!o||e.ace.inVirtualSelectionMode)r=x.handleKey(e,t,n);else{var u=lr(i);e.operation(function(){e.ace.forEachSelection(function(){var i=e.ace.selection;e.state.vim.lastHPos=i.$desiredColumn==null?i.lead.column:i.$desiredColumn;var s=e.getCursor("head"),o=e.getCursor("anchor"),a=Mt(s,o)?0:-1,f=Mt(s,o)?-1:0;s=Tt(s,0,a),o=Tt(o,0,f),e.state.vim.sel.head=s,e.state.vim.sel.anchor=o,r=fr(e,t,n),i.$desiredColumn=e.state.vim.lastHPos==-1?null:e.state.vim.lastHPos,e.virtualSelectionMode()&&(e.state.vim=lr(u))}),e.curOp.cursorActivity&&!r&&(e.curOp.cursorActivity=!1)},!0)}return r&&!i.visualMode&&!i.insert&&i.visualMode!=e.somethingSelected()&&nr(e,i,!0),r}function pr(e,t){t.off("beforeEndOperation",pr);var n=t.state.cm.vimCmd;n&&t.execCommand(n.exec?n:n.name,n.args),t.curOp=t.prevOp}var i=e("../range").Range,s=e("../lib/event_emitter").EventEmitter,o=e("../lib/dom"),u=e("../lib/oop"),a=e("../lib/keys"),f=e("../lib/event"),l=e("../search").Search,c=e("../lib/useragent"),h=e("../search_highlight").SearchHighlight,p=e("../commands/multi_select_commands"),d=e("../mode/text").Mode.prototype.tokenRe;e("../multi_select");var v=function(e){this.ace=e,this.state={},this.marks={},this.$uid=0,this.onChange=this.onChange.bind(this),this.onSelectionChange=this.onSelectionChange.bind(this),this.onBeforeEndOperation=this.onBeforeEndOperation.bind(this),this.ace.on("change",this.onChange),this.ace.on("changeSelection",this.onSelectionChange),this.ace.on("beforeEndOperation",this.onBeforeEndOperation)};v.Pos=function(e,t){if(!(this instanceof S))return new S(e,t);this.line=e,this.ch=t},v.defineOption=function(e,t,n){},v.commands={redo:function(e){e.ace.redo()},undo:function(e){e.ace.undo()},newlineAndIndent:function(e){e.ace.insert("\n")}},v.keyMap={},v.addClass=v.rmClass=function(){},v.e_stop=v.e_preventDefault=f.stopEvent,v.keyName=function(e){var t=a[e.keyCode]||e.key||"";return t.length==1&&(t=t.toUpperCase()),t=f.getModifierString(e).replace(/(^|-)\w/g,function(e){return e.toUpperCase()})+t,t},v.keyMap["default"]=function(e){return function(t){var n=t.ace.commands.commandKeyBinding[e.toLowerCase()];return n&&t.ace.execCommand(n)!==!1}},v.lookupKey=function dr(e,t,n){t||(t="default"),typeof t=="string"&&(t=v.keyMap[t]);var r=typeof t=="function"?t(e):t[e];if(r===!1)return"nothing";if(r==="...")return"multi";if(r!=null&&n(r))return"handled";if(t.fallthrough){if(!Array.isArray(t.fallthrough))return dr(e,t.fallthrough,n);for(var i=0;i0){a.row+=s,a.column+=a.row==r.row?o:0;continue}!t&&l<=0&&(a.row=n.row,a.column=n.column,l===0&&(a.bias=1))}};var e=function(e,t,n,r){this.cm=e,this.id=t,this.row=n,this.column=r,e.marks[this.id]=this};e.prototype.clear=function(){delete this.cm.marks[this.id]},e.prototype.find=function(){return g(this)},this.setBookmark=function(t,n){var r=new e(this,this.$uid++,t.line,t.ch);if(!n||!n.insertLeft)r.$insertRight=!0;return this.marks[r.id]=r,r},this.moveH=function(e,t){if(t=="char"){var n=this.ace.selection;n.clearSelection(),n.moveCursorBy(0,e)}},this.findPosV=function(e,t,n,r){if(n=="page"){var i=this.ace.renderer,s=i.layerConfig;t*=Math.floor(s.height/s.lineHeight),n="line"}if(n=="line"){var o=this.ace.session.documentToScreenPosition(e.line,e.ch);r!=null&&(o.column=r),o.row+=t,o.row=Math.min(Math.max(0,o.row),this.ace.session.getScreenLength()-1);var u=this.ace.session.screenToDocumentPosition(o.row,o.column);return g(u)}debugger},this.charCoords=function(e,t){if(t=="div"||!t){var n=this.ace.session.documentToScreenPosition(e.line,e.ch);return{left:n.column,top:n.row}}if(t=="local"){var r=this.ace.renderer,n=this.ace.session.documentToScreenPosition(e.line,e.ch),i=r.layerConfig.lineHeight,s=r.layerConfig.characterWidth,o=i*n.row;return{left:n.column*s,top:o,bottom:o+i}}},this.coordsChar=function(e,t){var n=this.ace.renderer;if(t=="local"){var r=Math.max(0,Math.floor(e.top/n.lineHeight)),i=Math.max(0,Math.floor(e.left/n.characterWidth)),s=n.session.screenToDocumentPosition(r,i);return g(s)}if(t=="div")throw"not implemented"},this.getSearchCursor=function(e,t,n){var r=!1,i=!1;e instanceof RegExp&&!e.global&&(r=!e.ignoreCase,e=e.source,i=!0);var s=new l;t.ch==undefined&&(t.ch=Number.MAX_VALUE);var o={row:t.line,column:t.ch},u=this,a=null;return{findNext:function(){return this.find(!1)},findPrevious:function(){return this.find(!0)},find:function(t){s.setOptions({needle:e,caseSensitive:r,wrap:!1,backwards:t,regExp:i,start:a||o});var n=s.find(u.ace.session);return n&&n.isEmpty()&&u.getLine(n.start.row).length==n.start.column&&(s.$options.start=n,n=s.find(u.ace.session)),a=n,a},from:function(){return a&&g(a.start)},to:function(){return a&&g(a.end)},replace:function(e){a&&(a.end=u.ace.session.doc.replace(a,e))}}},this.scrollTo=function(e,t){var n=this.ace.renderer,r=n.layerConfig,i=r.maxHeight;i-=(n.$size.scrollerHeight-n.lineHeight)*n.$scrollPastEnd,t!=null&&this.ace.session.setScrollTop(Math.max(0,Math.min(t,i))),e!=null&&this.ace.session.setScrollLeft(Math.max(0,Math.min(e,r.width)))},this.scrollInfo=function(){return 0},this.scrollIntoView=function(e,t){if(e){var n=this.ace.renderer,r={top:0,bottom:t};n.scrollCursorIntoView(m(e),n.lineHeight*2/n.$size.scrollerHeight,r)}},this.getLine=function(e){return this.ace.session.getLine(e)},this.getRange=function(e,t){return this.ace.session.getTextRange(new i(e.line,e.ch,t.line,t.ch))},this.replaceRange=function(e,t,n){return n||(n=t),this.ace.session.replace(new i(t.line,t.ch,n.line,n.ch),e)},this.replaceSelection=this.replaceSelections=function(e){var t=this.ace.selection;if(this.ace.inVirtualSelectionMode){this.ace.session.replace(t.getRange(),e[0]||"");return}t.inVirtualSelectionMode=!0;var n=t.rangeList.ranges;n.length||(n=[this.ace.multiSelect.getRange()]);for(var r=n.length;r--;)this.ace.session.replace(n[r],e[r]||"");t.inVirtualSelectionMode=!1},this.getSelection=function(){return this.ace.getSelectedText()},this.getSelections=function(){return this.listSelections().map(function(e){return this.getRange(e.anchor,e.head)},this)},this.getInputField=function(){return this.ace.textInput.getElement()},this.getWrapperElement=function(){return this.ace.container};var t={indentWithTabs:"useSoftTabs",indentUnit:"tabSize",tabSize:"tabSize",firstLineNumber:"firstLineNumber",readOnly:"readOnly"};this.setOption=function(e,n){this.state[e]=n;switch(e){case"indentWithTabs":e=t[e],n=!n;break;case"keyMap":this.state.$keyMap=n;return;default:e=t[e]}e&&this.ace.setOption(e,n)},this.getOption=function(e,n){var r=t[e];r&&(n=this.ace.getOption(r));switch(e){case"indentWithTabs":return e=t[e],!n;case"keyMap":return this.state.$keyMap}return r?n:this.state[e]},this.toggleOverwrite=function(e){return this.state.overwrite=e,this.ace.setOverwrite(e)},this.addOverlay=function(e){if(!this.$searchHighlight||!this.$searchHighlight.session){var t=new h(null,"ace_highlight-marker","text"),n=this.ace.session.addDynamicMarker(t);t.id=n.id,t.session=this.ace.session,t.destroy=function(e){t.session.off("change",t.updateOnChange),t.session.off("changeEditor",t.destroy),t.session.removeMarker(t.id),t.session=null},t.updateOnChange=function(e){var n=e.start.row;n==e.end.row?t.cache[n]=undefined:t.cache.splice(n,t.cache.length)},t.session.on("changeEditor",t.destroy),t.session.on("change",t.updateOnChange)}var r=new RegExp(e.query.source,"gmi");this.$searchHighlight=e.highlight=t,this.$searchHighlight.setRegexp(r),this.ace.renderer.updateBackMarkers()},this.removeOverlay=function(e){this.$searchHighlight&&this.$searchHighlight.session&&this.$searchHighlight.destroy()},this.getScrollInfo=function(){var e=this.ace.renderer,t=e.layerConfig;return{left:e.scrollLeft,top:e.scrollTop,height:t.maxHeight,width:t.width,clientHeight:t.height,clientWidth:t.width}},this.getValue=function(){return this.ace.getValue()},this.setValue=function(e){return this.ace.setValue(e,-1)},this.getTokenTypeAt=function(e){var t=this.ace.session.getTokenAt(e.line,e.ch);return t&&/comment|string/.test(t.type)?"string":""},this.findMatchingBracket=function(e){var t=this.ace.session.findMatchingBracket(m(e));return{to:t&&g(t)}},this.indentLine=function(e,t){t===!0?this.ace.session.indentRows(e,e," "):t===!1&&this.ace.session.outdentRows(new i(e,0,e,0))},this.indexFromPos=function(e){return this.ace.session.doc.positionToIndex(m(e))},this.posFromIndex=function(e){return g(this.ace.session.doc.indexToPosition(e))},this.focus=function(e){return this.ace.textInput.focus()},this.blur=function(e){return this.ace.blur()},this.defaultTextHeight=function(e){return this.ace.renderer.layerConfig.lineHeight},this.scanForBracket=function(e,t,n,r){var i=r.bracketRegex.source,s=/paren|text|operator|tag/;if(t==1)var o=this.ace.session.$findClosingBracket(i.slice(1,2),m(e),s);else var o=this.ace.session.$findOpeningBracket(i.slice(-2,-1),{row:e.line,column:e.ch+1},s);return o&&{pos:g(o)}},this.refresh=function(){return this.ace.resize(!0)},this.getMode=function(){return{name:this.getOption("mode")}},this.execCommand=function(e){e=="indentAuto"?this.ace.execCommand("autoindent"):console.log(e+" is not implemented")}}.call(v.prototype);var y=v.StringStream=function(e,t){this.pos=this.start=0,this.string=e,this.tabSize=t||8,this.lastColumnPos=this.lastColumnValue=0,this.lineStart=0};y.prototype={eol:function(){return this.pos>=this.string.length},sol:function(){return this.pos==this.lineStart},peek:function(){return this.string.charAt(this.pos)||undefined},next:function(){if(this.post},eatSpace:function(){var e=this.pos;while(/[\s\u00a0]/.test(this.string.charAt(this.pos)))++this.pos;return this.pos>e},skipToEnd:function(){this.pos=this.string.length},skipTo:function(e){var t=this.string.indexOf(e,this.pos);if(t>-1)return this.pos=t,!0},backUp:function(e){this.pos-=e},column:function(){throw"not implemented"},indentation:function(){throw"not implemented"},match:function(e,t,n){if(typeof e!="string"){var s=this.string.slice(this.pos).match(e);return s&&s.index>0?null:(s&&t!==!1&&(this.pos+=s[0].length),s)}var r=function(e){return n?e.toLowerCase():e},i=this.string.substr(this.pos,e.length);if(r(i)==r(e))return t!==!1&&(this.pos+=e.length),!0},current:function(){return this.string.slice(this.start,this.pos)},hideFirstChars:function(e,t){this.lineStart+=e;try{return t()}finally{this.lineStart-=e}}},v.defineExtension=function(e,t){v.prototype[e]=t},o.importCssString(".normal-mode .ace_cursor{ border: none; background-color: rgba(255,0,0,0.5);}.normal-mode .ace_hidden-cursors .ace_cursor{ background-color: transparent; border: 1px solid red; opacity: 0.7}.ace_dialog { position: absolute; left: 0; right: 0; background: inherit; z-index: 15; padding: .1em .8em; overflow: hidden; color: inherit;}.ace_dialog-top { border-bottom: 1px solid #444; top: 0;}.ace_dialog-bottom { border-top: 1px solid #444; bottom: 0;}.ace_dialog input { border: none; outline: none; background: transparent; width: 20em; color: inherit; font-family: monospace;}","vimMode"),function(){function e(e,t,n){var r=e.ace.container,i;return i=r.appendChild(document.createElement("div")),n?i.className="ace_dialog ace_dialog-bottom":i.className="ace_dialog ace_dialog-top",typeof t=="string"?i.innerHTML=t:i.appendChild(t),i}function t(e,t){e.state.currentNotificationClose&&e.state.currentNotificationClose(),e.state.currentNotificationClose=t}v.defineExtension("openDialog",function(n,r,i){function a(e){if(typeof e=="string")f.value=e;else{if(o)return;if(e&&e.type=="blur"&&document.activeElement===f)return;u.state.dialog=null,o=!0,s.parentNode.removeChild(s),u.focus(),i.onClose&&i.onClose(s)}}if(this.virtualSelectionMode())return;i||(i={}),t(this,null);var s=e(this,n,i.bottom),o=!1,u=this;this.state.dialog=s;var f=s.getElementsByTagName("input")[0],l;if(f)i.value&&(f.value=i.value,i.selectValueOnOpen!==!1&&f.select()),i.onInput&&v.on(f,"input",function(e){i.onInput(e,f.value,a)}),i.onKeyUp&&v.on(f,"keyup",function(e){i.onKeyUp(e,f.value,a)}),v.on(f,"keydown",function(e){if(i&&i.onKeyDown&&i.onKeyDown(e,f.value,a))return;e.keyCode==13&&r(f.value);if(e.keyCode==27||i.closeOnEnter!==!1&&e.keyCode==13)f.blur(),v.e_stop(e),a()}),i.closeOnBlur!==!1&&v.on(f,"blur",a),f.focus();else if(l=s.getElementsByTagName("button")[0])v.on(l,"click",function(){a(),u.focus()}),i.closeOnBlur!==!1&&v.on(l,"blur",a),l.focus();return a}),v.defineExtension("openNotification",function(n,r){function a(){if(s)return;s=!0,clearTimeout(o),i.parentNode.removeChild(i)}if(this.virtualSelectionMode())return;t(this,a);var i=e(this,n,r&&r.bottom),s=!1,o,u=r&&typeof r.duration!="undefined"?r.duration:5e3;return v.on(i,"click",function(e){v.e_preventDefault(e),a()}),u&&(o=setTimeout(a,u)),a})}();var b=[{keys:"",type:"keyToKey",toKeys:"h"},{keys:"",type:"keyToKey",toKeys:"l"},{keys:"",type:"keyToKey",toKeys:"k"},{keys:"",type:"keyToKey",toKeys:"j"},{keys:"",type:"keyToKey",toKeys:"l"},{keys:"",type:"keyToKey",toKeys:"h",context:"normal"},{keys:"",type:"keyToKey",toKeys:"x",context:"normal"},{keys:"",type:"keyToKey",toKeys:"W"},{keys:"",type:"keyToKey",toKeys:"B",context:"normal"},{keys:"",type:"keyToKey",toKeys:"w"},{keys:"",type:"keyToKey",toKeys:"b",context:"normal"},{keys:"",type:"keyToKey",toKeys:"j"},{keys:"",type:"keyToKey",toKeys:"k"},{keys:"",type:"keyToKey",toKeys:""},{keys:"",type:"keyToKey",toKeys:""},{keys:"",type:"keyToKey",toKeys:"",context:"insert"},{keys:"",type:"keyToKey",toKeys:"",context:"insert"},{keys:"",type:"keyToKey",toKeys:""},{keys:"",type:"keyToKey",toKeys:"",context:"insert"},{keys:"s",type:"keyToKey",toKeys:"cl",context:"normal"},{keys:"s",type:"keyToKey",toKeys:"c",context:"visual"},{keys:"S",type:"keyToKey",toKeys:"cc",context:"normal"},{keys:"S",type:"keyToKey",toKeys:"VdO",context:"visual"},{keys:"",type:"keyToKey",toKeys:"0"},{keys:"",type:"keyToKey",toKeys:"$"},{keys:"",type:"keyToKey",toKeys:""},{keys:"",type:"keyToKey",toKeys:""},{keys:"",type:"keyToKey",toKeys:"j^",context:"normal"},{keys:"",type:"action",action:"toggleOverwrite",context:"insert"},{keys:"H",type:"motion",motion:"moveToTopLine",motionArgs:{linewise:!0,toJumplist:!0}},{keys:"M",type:"motion",motion:"moveToMiddleLine",motionArgs:{linewise:!0,toJumplist:!0}},{keys:"L",type:"motion",motion:"moveToBottomLine",motionArgs:{linewise:!0,toJumplist:!0}},{keys:"h",type:"motion",motion:"moveByCharacters",motionArgs:{forward:!1}},{keys:"l",type:"motion",motion:"moveByCharacters",motionArgs:{forward:!0}},{keys:"j",type:"motion",motion:"moveByLines",motionArgs:{forward:!0,linewise:!0}},{keys:"k",type:"motion",motion:"moveByLines",motionArgs:{forward:!1,linewise:!0}},{keys:"gj",type:"motion",motion:"moveByDisplayLines",motionArgs:{forward:!0}},{keys:"gk",type:"motion",motion:"moveByDisplayLines",motionArgs:{forward:!1}},{keys:"w",type:"motion",motion:"moveByWords",motionArgs:{forward:!0,wordEnd:!1}},{keys:"W",type:"motion",motion:"moveByWords",motionArgs:{forward:!0,wordEnd:!1,bigWord:!0}},{keys:"e",type:"motion",motion:"moveByWords",motionArgs:{forward:!0,wordEnd:!0,inclusive:!0}},{keys:"E",type:"motion",motion:"moveByWords",motionArgs:{forward:!0,wordEnd:!0,bigWord:!0,inclusive:!0}},{keys:"b",type:"motion",motion:"moveByWords",motionArgs:{forward:!1,wordEnd:!1}},{keys:"B",type:"motion",motion:"moveByWords",motionArgs:{forward:!1,wordEnd:!1,bigWord:!0}},{keys:"ge",type:"motion",motion:"moveByWords",motionArgs:{forward:!1,wordEnd:!0,inclusive:!0}},{keys:"gE",type:"motion",motion:"moveByWords",motionArgs:{forward:!1,wordEnd:!0,bigWord:!0,inclusive:!0}},{keys:"{",type:"motion",motion:"moveByParagraph",motionArgs:{forward:!1,toJumplist:!0}},{keys:"}",type:"motion",motion:"moveByParagraph",motionArgs:{forward:!0,toJumplist:!0}},{keys:"(",type:"motion",motion:"moveBySentence",motionArgs:{forward:!1}},{keys:")",type:"motion",motion:"moveBySentence",motionArgs:{forward:!0}},{keys:"",type:"motion",motion:"moveByPage",motionArgs:{forward:!0}},{keys:"",type:"motion",motion:"moveByPage",motionArgs:{forward:!1}},{keys:"",type:"motion",motion:"moveByScroll",motionArgs:{forward:!0,explicitRepeat:!0}},{keys:"",type:"motion",motion:"moveByScroll",motionArgs:{forward:!1,explicitRepeat:!0}},{keys:"gg",type:"motion",motion:"moveToLineOrEdgeOfDocument",motionArgs:{forward:!1,explicitRepeat:!0,linewise:!0,toJumplist:!0}},{keys:"G",type:"motion",motion:"moveToLineOrEdgeOfDocument",motionArgs:{forward:!0,explicitRepeat:!0,linewise:!0,toJumplist:!0}},{keys:"0",type:"motion",motion:"moveToStartOfLine"},{keys:"^",type:"motion",motion:"moveToFirstNonWhiteSpaceCharacter"},{keys:"+",type:"motion",motion:"moveByLines",motionArgs:{forward:!0,toFirstChar:!0}},{keys:"-",type:"motion",motion:"moveByLines",motionArgs:{forward:!1,toFirstChar:!0}},{keys:"_",type:"motion",motion:"moveByLines",motionArgs:{forward:!0,toFirstChar:!0,repeatOffset:-1}},{keys:"$",type:"motion",motion:"moveToEol",motionArgs:{inclusive:!0}},{keys:"%",type:"motion",motion:"moveToMatchedSymbol",motionArgs:{inclusive:!0,toJumplist:!0}},{keys:"f",type:"motion",motion:"moveToCharacter",motionArgs:{forward:!0,inclusive:!0}},{keys:"F",type:"motion",motion:"moveToCharacter",motionArgs:{forward:!1}},{keys:"t",type:"motion",motion:"moveTillCharacter",motionArgs:{forward:!0,inclusive:!0}},{keys:"T",type:"motion",motion:"moveTillCharacter",motionArgs:{forward:!1}},{keys:";",type:"motion",motion:"repeatLastCharacterSearch",motionArgs:{forward:!0}},{keys:",",type:"motion",motion:"repeatLastCharacterSearch",motionArgs:{forward:!1}},{keys:"'",type:"motion",motion:"goToMark",motionArgs:{toJumplist:!0,linewise:!0}},{keys:"`",type:"motion",motion:"goToMark",motionArgs:{toJumplist:!0}},{keys:"]`",type:"motion",motion:"jumpToMark",motionArgs:{forward:!0}},{keys:"[`",type:"motion",motion:"jumpToMark",motionArgs:{forward:!1}},{keys:"]'",type:"motion",motion:"jumpToMark",motionArgs:{forward:!0,linewise:!0}},{keys:"['",type:"motion",motion:"jumpToMark",motionArgs:{forward:!1,linewise:!0}},{keys:"]p",type:"action",action:"paste",isEdit:!0,actionArgs:{after:!0,isEdit:!0,matchIndent:!0}},{keys:"[p",type:"action",action:"paste",isEdit:!0,actionArgs:{after:!1,isEdit:!0,matchIndent:!0}},{keys:"]",type:"motion",motion:"moveToSymbol",motionArgs:{forward:!0,toJumplist:!0}},{keys:"[",type:"motion",motion:"moveToSymbol",motionArgs:{forward:!1,toJumplist:!0}},{keys:"|",type:"motion",motion:"moveToColumn"},{keys:"o",type:"motion",motion:"moveToOtherHighlightedEnd",context:"visual"},{keys:"O",type:"motion",motion:"moveToOtherHighlightedEnd",motionArgs:{sameLine:!0},context:"visual"},{keys:"d",type:"operator",operator:"delete"},{keys:"y",type:"operator",operator:"yank"},{keys:"c",type:"operator",operator:"change"},{keys:"=",type:"operator",operator:"indentAuto"},{keys:">",type:"operator",operator:"indent",operatorArgs:{indentRight:!0}},{keys:"<",type:"operator",operator:"indent",operatorArgs:{indentRight:!1}},{keys:"g~",type:"operator",operator:"changeCase"},{keys:"gu",type:"operator",operator:"changeCase",operatorArgs:{toLower:!0},isEdit:!0},{keys:"gU",type:"operator",operator:"changeCase",operatorArgs:{toLower:!1},isEdit:!0},{keys:"n",type:"motion",motion:"findNext",motionArgs:{forward:!0,toJumplist:!0}},{keys:"N",type:"motion",motion:"findNext",motionArgs:{forward:!1,toJumplist:!0}},{keys:"x",type:"operatorMotion",operator:"delete",motion:"moveByCharacters",motionArgs:{forward:!0},operatorMotionArgs:{visualLine:!1}},{keys:"X",type:"operatorMotion",operator:"delete",motion:"moveByCharacters",motionArgs:{forward:!1},operatorMotionArgs:{visualLine:!0}},{keys:"D",type:"operatorMotion",operator:"delete",motion:"moveToEol",motionArgs:{inclusive:!0},context:"normal"},{keys:"D",type:"operator",operator:"delete",operatorArgs:{linewise:!0},context:"visual"},{keys:"Y",type:"operatorMotion",operator:"yank",motion:"expandToLine",motionArgs:{linewise:!0},context:"normal"},{keys:"Y",type:"operator",operator:"yank",operatorArgs:{linewise:!0},context:"visual"},{keys:"C",type:"operatorMotion",operator:"change",motion:"moveToEol",motionArgs:{inclusive:!0},context:"normal"},{keys:"C",type:"operator",operator:"change",operatorArgs:{linewise:!0},context:"visual"},{keys:"~",type:"operatorMotion",operator:"changeCase",motion:"moveByCharacters",motionArgs:{forward:!0},operatorArgs:{shouldMoveCursor:!0},context:"normal"},{keys:"~",type:"operator",operator:"changeCase",context:"visual"},{keys:"",type:"operatorMotion",operator:"delete",motion:"moveByWords",motionArgs:{forward:!1,wordEnd:!1},context:"insert"},{keys:"",type:"idle",context:"normal"},{keys:"",type:"action",action:"jumpListWalk",actionArgs:{forward:!0}},{keys:"",type:"action",action:"jumpListWalk",actionArgs:{forward:!1}},{keys:"",type:"action",action:"scroll",actionArgs:{forward:!0,linewise:!0}},{keys:"",type:"action",action:"scroll",actionArgs:{forward:!1,linewise:!0}},{keys:"a",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"charAfter"},context:"normal"},{keys:"A",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"eol"},context:"normal"},{keys:"A",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"endOfSelectedArea"},context:"visual"},{keys:"i",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"inplace"},context:"normal"},{keys:"gi",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"lastEdit"},context:"normal"},{keys:"I",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"firstNonBlank"},context:"normal"},{keys:"gI",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"bol"},context:"normal"},{keys:"I",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{insertAt:"startOfSelectedArea"},context:"visual"},{keys:"o",type:"action",action:"newLineAndEnterInsertMode",isEdit:!0,interlaceInsertRepeat:!0,actionArgs:{after:!0},context:"normal"},{keys:"O",type:"action",action:"newLineAndEnterInsertMode",isEdit:!0,interlaceInsertRepeat:!0,actionArgs:{after:!1},context:"normal"},{keys:"v",type:"action",action:"toggleVisualMode"},{keys:"V",type:"action",action:"toggleVisualMode",actionArgs:{linewise:!0}},{keys:"",type:"action",action:"toggleVisualMode",actionArgs:{blockwise:!0}},{keys:"",type:"action",action:"toggleVisualMode",actionArgs:{blockwise:!0}},{keys:"gv",type:"action",action:"reselectLastSelection"},{keys:"J",type:"action",action:"joinLines",isEdit:!0},{keys:"gJ",type:"action",action:"joinLines",actionArgs:{keepSpaces:!0},isEdit:!0},{keys:"p",type:"action",action:"paste",isEdit:!0,actionArgs:{after:!0,isEdit:!0}},{keys:"P",type:"action",action:"paste",isEdit:!0,actionArgs:{after:!1,isEdit:!0}},{keys:"r",type:"action",action:"replace",isEdit:!0},{keys:"@",type:"action",action:"replayMacro"},{keys:"q",type:"action",action:"enterMacroRecordMode"},{keys:"R",type:"action",action:"enterInsertMode",isEdit:!0,actionArgs:{replace:!0},context:"normal"},{keys:"R",type:"operator",operator:"change",operatorArgs:{linewise:!0,fullLine:!0},context:"visual",exitVisualBlock:!0},{keys:"u",type:"action",action:"undo",context:"normal"},{keys:"u",type:"operator",operator:"changeCase",operatorArgs:{toLower:!0},context:"visual",isEdit:!0},{keys:"U",type:"operator",operator:"changeCase",operatorArgs:{toLower:!1},context:"visual",isEdit:!0},{keys:"",type:"action",action:"redo"},{keys:"m",type:"action",action:"setMark"},{keys:'"',type:"action",action:"setRegister"},{keys:"zz",type:"action",action:"scrollToCursor",actionArgs:{position:"center"}},{keys:"z.",type:"action",action:"scrollToCursor",actionArgs:{position:"center"},motion:"moveToFirstNonWhiteSpaceCharacter"},{keys:"zt",type:"action",action:"scrollToCursor",actionArgs:{position:"top"}},{keys:"z",type:"action",action:"scrollToCursor",actionArgs:{position:"top"},motion:"moveToFirstNonWhiteSpaceCharacter"},{keys:"z-",type:"action",action:"scrollToCursor",actionArgs:{position:"bottom"}},{keys:"zb",type:"action",action:"scrollToCursor",actionArgs:{position:"bottom"},motion:"moveToFirstNonWhiteSpaceCharacter"},{keys:".",type:"action",action:"repeatLastEdit"},{keys:"",type:"action",action:"incrementNumberToken",isEdit:!0,actionArgs:{increase:!0,backtrack:!1}},{keys:"",type:"action",action:"incrementNumberToken",isEdit:!0,actionArgs:{increase:!1,backtrack:!1}},{keys:"",type:"action",action:"indent",actionArgs:{indentRight:!0},context:"insert"},{keys:"",type:"action",action:"indent",actionArgs:{indentRight:!1},context:"insert"},{keys:"a",type:"motion",motion:"textObjectManipulation"},{keys:"i",type:"motion",motion:"textObjectManipulation",motionArgs:{textObjectInner:!0}},{keys:"/",type:"search",searchArgs:{forward:!0,querySrc:"prompt",toJumplist:!0}},{keys:"?",type:"search",searchArgs:{forward:!1,querySrc:"prompt",toJumplist:!0}},{keys:"*",type:"search",searchArgs:{forward:!0,querySrc:"wordUnderCursor",wholeWordOnly:!0,toJumplist:!0}},{keys:"#",type:"search",searchArgs:{forward:!1,querySrc:"wordUnderCursor",wholeWordOnly:!0,toJumplist:!0}},{keys:"g*",type:"search",searchArgs:{forward:!0,querySrc:"wordUnderCursor",toJumplist:!0}},{keys:"g#",type:"search",searchArgs:{forward:!1,querySrc:"wordUnderCursor",toJumplist:!0}},{keys:":",type:"ex"}],w=b.length,E=[{name:"colorscheme",shortName:"colo"},{name:"map"},{name:"imap",shortName:"im"},{name:"nmap",shortName:"nm"},{name:"vmap",shortName:"vm"},{name:"unmap"},{name:"write",shortName:"w"},{name:"undo",shortName:"u"},{name:"redo",shortName:"red"},{name:"set",shortName:"se"},{name:"set",shortName:"se"},{name:"setlocal",shortName:"setl"},{name:"setglobal",shortName:"setg"},{name:"sort",shortName:"sor"},{name:"substitute",shortName:"s",possiblyAsync:!0},{name:"nohlsearch",shortName:"noh"},{name:"yank",shortName:"y"},{name:"delmarks",shortName:"delm"},{name:"registers",shortName:"reg",excludeFromCommandHistory:!0},{name:"global",shortName:"g"}],S=v.Pos,x=function(){return ut};v.defineOption("vimMode",!1,function(e,t,n){t&&e.getOption("keyMap")!="vim"?e.setOption("keyMap","vim"):!t&&n!=v.Init&&/^vim/.test(e.getOption("keyMap"))&&e.setOption("keyMap","default")});var A={Shift:"S",Ctrl:"C",Alt:"A",Cmd:"D",Mod:"A"},O={Enter:"CR",Backspace:"BS",Delete:"Del",Insert:"Ins"},D=/[\d]/,P=[v.isWordChar,function(e){return e&&!v.isWordChar(e)&&!/\s/.test(e)}],H=[function(e){return/\S/.test(e)}],j=B(65,26),F=B(97,26),I=B(48,10),q=[].concat(j,F,I,["<",">"]),R=[].concat(j,F,I,["-",'"',".",":","/"]),Q={};G("filetype",undefined,"string",["ft"],function(e,t){if(t===undefined)return;if(e===undefined){var n=t.getOption("mode");return n=="null"?"":n}var n=e==""?"null":e;t.setOption("mode",n)});var et=function(){function s(s,o,u){function l(n){var r=++t%e,o=i[r];o&&o.clear(),i[r]=s.setBookmark(n)}var a=t%e,f=i[a];if(f){var c=f.find();c&&!Ot(c,o)&&l(o)}else l(o);l(u),n=t,r=t-e+1,r<0&&(r=0)}function o(s,o){t+=o,t>n?t=n:t0?1:-1,f,l=s.getCursor();do{t+=a,u=i[(e+t)%e];if(u&&(f=u.find())&&!Ot(l,f))break}while(tr)}return u}function u(e,n){var r=t,i=o(e,n);return t=r,i&&i.find()}var e=100,t=-1,n=0,r=0,i=new Array(e);return{cachedCursor:undefined,add:s,find:u,move:o}},tt=function(e){return e?{changes:e.changes,expectCursorActivityForChange:e.expectCursorActivityForChange}:{changes:[],expectCursorActivityForChange:!1}};nt.prototype={exitMacroRecordMode:function(){var e=it.macroModeState;e.onRecordingDone&&e.onRecordingDone(),e.onRecordingDone=undefined,e.isRecording=!1},enterMacroRecordMode:function(e,t){var n=it.registerController.getRegister(t);n&&(n.clear(),this.latestRegister=t,e.openDialog&&(this.onRecordingDone=e.openDialog("(recording)["+t+"]",null,{bottom:!0})),this.isRecording=!0)}};var it,ot,ut={buildKeyMap:function(){},getRegisterController:function(){return it.registerController},resetVimGlobalState_:st,getVimGlobalState_:function(){return it},maybeInitVimState_:rt,suppressErrorLogging:!1,InsertModeKey:rr,map:function(e,t,n){Wn.map(e,t,n)},unmap:function(e,t){Wn.unmap(e,t)},noremap:function(e,t,n){function r(e){return e?[e]:["normal","insert","visual"]}var i=r(n),s=b.length,o=w;for(var u=s-o;u=0;i--){var s=r[i];if(e!==s.context)if(s.context)this._mapCommand(s);else{var o=["normal","insert","visual"];for(var u in o)if(o[u]!==e){var a={};for(var f in s)a[f]=s[f];a.context=o[u],this._mapCommand(a)}}}},setOption:Y,getOption:Z,defineOption:G,defineEx:function(e,t,n){if(!t)t=e;else if(e.indexOf(t)!==0)throw new Error('(Vim.defineEx) "'+t+'" is not a prefix of "'+e+'", command not registered');zn[e]=n,Wn.commandMap_[t]={name:e,shortName:t,type:"api"}},handleKey:function(e,t,n){var r=this.findKey(e,t,n);if(typeof r=="function")return r()},findKey:function(e,t,n){function i(){var r=it.macroModeState;if(r.isRecording){if(t=="q")return r.exitMacroRecordMode(),ft(e),!0;n!="mapping"&&Qn(r,t)}}function s(){if(t=="")return ft(e),r.visualMode?Jt(e):r.insertMode&&Vn(e),!0}function o(n){var r;while(n)r=/<\w+-.+?>|<\w+>|./.exec(n),t=r[0],n=n.substring(r.index+t.length),v.Vim.handleKey(e,t,"mapping")}function u(){if(s())return!0;var n=r.inputState.keyBuffer=r.inputState.keyBuffer+t,i=t.length==1,o=dt.matchCommand(n,b,r.inputState,"insert");while(n.length>1&&o.type!="full"){var n=r.inputState.keyBuffer=n.slice(1),u=dt.matchCommand(n,b,r.inputState,"insert");u.type!="none"&&(o=u)}if(o.type=="none")return ft(e),!1;if(o.type=="partial")return ot&&window.clearTimeout(ot),ot=window.setTimeout(function(){r.insertMode&&r.inputState.keyBuffer&&ft(e)},Z("insertModeEscKeysTimeout")),!i;ot&&window.clearTimeout(ot);if(i){var a=e.listSelections();for(var f=0;f0||this.motionRepeat.length>0)e=1,this.prefixRepeat.length>0&&(e*=parseInt(this.prefixRepeat.join(""),10)),this.motionRepeat.length>0&&(e*=parseInt(this.motionRepeat.join(""),10));return e},lt.prototype={setText:function(e,t,n){this.keyBuffer=[e||""],this.linewise=!!t,this.blockwise=!!n},pushText:function(e,t){t&&(this.linewise||this.keyBuffer.push("\n"),this.linewise=!0),this.keyBuffer.push(e)},pushInsertModeChanges:function(e){this.insertModeChanges.push(tt(e))},pushSearchQuery:function(e){this.searchQueries.push(e)},clear:function(){this.keyBuffer=[],this.insertModeChanges=[],this.searchQueries=[],this.linewise=!1},toString:function(){return this.keyBuffer.join("")}},ht.prototype={pushText:function(e,t,n,r,i){r&&n.charAt(n.length-1)!=="\n"&&(n+="\n");var s=this.isValidRegister(e)?this.getRegister(e):null;if(!s){switch(t){case"yank":this.registers[0]=new lt(n,r,i);break;case"delete":case"change":n.indexOf("\n")==-1?this.registers["-"]=new lt(n,r):(this.shiftNumericRegisters_(),this.registers[1]=new lt(n,r))}this.unnamedRegister.setText(n,r,i);return}var o=V(e);o?s.pushText(n,r):s.setText(n,r,i),this.unnamedRegister.setText(s.toString(),r)},getRegister:function(e){return this.isValidRegister(e)?(e=e.toLowerCase(),this.registers[e]||(this.registers[e]=new lt),this.registers[e]):this.unnamedRegister},isValidRegister:function(e){return e&&K(e,R)},shiftNumericRegisters_:function(){for(var e=9;e>=2;e--)this.registers[e]=this.getRegister(""+(e-1))}},pt.prototype={nextMatch:function(e,t){var n=this.historyBuffer,r=t?-1:1;this.initialPrefix===null&&(this.initialPrefix=e);for(var i=this.iterator+r;t?i>=0:i=n.length)return this.iterator=n.length,this.initialPrefix;if(i<0)return e},pushInput:function(e){var t=this.historyBuffer.indexOf(e);t>-1&&this.historyBuffer.splice(t,1),e.length&&this.historyBuffer.push(e)},reset:function(){this.initialPrefix=null,this.iterator=this.historyBuffer.length}};var dt={matchCommand:function(e,t,n,r){var i=Nt(e,t,r,n);if(!i.full&&!i.partial)return{type:"none"};if(!i.full&&i.partial)return{type:"partial"};var s;for(var o=0;o"){var a=kt(e);if(//.test(a)||!a)return{type:"none"};n.selectedCharacter=a}return{type:"full",command:s}},processCommand:function(e,t,n){t.inputState.repeatOverride=n.repeatOverride;switch(n.type){case"motion":this.processMotion(e,t,n);break;case"operator":this.processOperator(e,t,n);break;case"operatorMotion":this.processOperatorMotion(e,t,n);break;case"action":this.processAction(e,t,n);break;case"search":this.processSearch(e,t,n);break;case"ex":case"keyToEx":this.processEx(e,t,n);break;default:}},processMotion:function(e,t,n){t.inputState.motion=n.motion,t.inputState.motionArgs=xt(n.motionArgs),this.evalInput(e,t)},processOperator:function(e,t,n){var r=t.inputState;if(r.operator){if(r.operator==n.operator){r.motion="expandToLine",r.motionArgs={linewise:!0},this.evalInput(e,t);return}ft(e)}r.operator=n.operator,r.operatorArgs=xt(n.operatorArgs),n.exitVisualBlock&&(t.visualBlock=!1,Xt(e)),t.visualMode&&this.evalInput(e,t)},processOperatorMotion:function(e,t,n){var r=t.visualMode,i=xt(n.operatorMotionArgs);i&&r&&i.visualLine&&(t.visualLine=!0),this.processOperator(e,t,n),r||this.processMotion(e,t,n)},processAction:function(e,t,n){var r=t.inputState,i=r.getRepeat(),s=!!i,o=xt(n.actionArgs)||{};r.selectedCharacter&&(o.selectedCharacter=r.selectedCharacter),n.operator&&this.processOperator(e,t,n),n.motion&&this.processMotion(e,t,n),(n.motion||n.operator)&&this.evalInput(e,t),o.repeat=i||1,o.repeatIsExplicit=s,o.registerName=r.registerName,ft(e),t.lastMotion=null,n.isEdit&&this.recordLastEdit(t,r,n),wt[n.action](e,o,t)},processSearch:function(e,t,n){function a(r,i,s){it.searchHistoryController.pushInput(r),it.searchHistoryController.reset();try{Dn(e,r,i,s)}catch(o){Ln(e,"Invalid regex: "+r),ft(e);return}dt.processMotion(e,t,{type:"motion",motion:"findNext",motionArgs:{forward:!0,toJumplist:n.searchArgs.toJumplist}})}function f(t){e.scrollTo(u.left,u.top),a(t,!0,!0);var n=it.macroModeState;n.isRecording&&Yn(n,t)}function l(t,n,i){var s=v.keyName(t),o,a;s=="Up"||s=="Down"?(o=s=="Up"?!0:!1,a=t.target?t.target.selectionEnd:0,n=it.searchHistoryController.nextMatch(n,o)||"",i(n),a&&t.target&&(t.target.selectionEnd=t.target.selectionStart=Math.min(a,t.target.value.length))):s!="Left"&&s!="Right"&&s!="Ctrl"&&s!="Alt"&&s!="Shift"&&it.searchHistoryController.reset();var f;try{f=Dn(e,n,!0,!0)}catch(t){}f?e.scrollIntoView(Bn(e,!r,f),30):(jn(e),e.scrollTo(u.left,u.top))}function c(t,n,r){var i=v.keyName(t);i=="Esc"||i=="Ctrl-C"||i=="Ctrl-["||i=="Backspace"&&n==""?(it.searchHistoryController.pushInput(n),it.searchHistoryController.reset(),Dn(e,o),jn(e),e.scrollTo(u.left,u.top),v.e_stop(t),ft(e),r(),e.focus()):i=="Up"||i=="Down"?v.e_stop(t):i=="Ctrl-U"&&(v.e_stop(t),r(""))}if(!e.getSearchCursor)return;var r=n.searchArgs.forward,i=n.searchArgs.wholeWordOnly;mn(e).setReversed(!r);var s=r?"/":"?",o=mn(e).getQuery(),u=e.getScrollInfo();switch(n.searchArgs.querySrc){case"prompt":var h=it.macroModeState;if(h.isPlaying){var p=h.replaySearchQueries.shift();a(p,!0,!1)}else Mn(e,{onClose:f,prefix:s,desc:On,onKeyUp:l,onKeyDown:c});break;case"wordUnderCursor":var d=Yt(e,!1,!0,!1,!0),m=!0;d||(d=Yt(e,!1,!0,!1,!1),m=!1);if(!d)return;var p=e.getLine(d.start.line).substring(d.start.ch,d.end.ch);m&&i?p="\\b"+p+"\\b":p=jt(p),it.jumpList.cachedCursor=e.getCursor(),e.setCursor(d.start),a(p,!0,!1)}},processEx:function(e,t,n){function r(t){it.exCommandHistoryController.pushInput(t),it.exCommandHistoryController.reset(),Wn.processCommand(e,t)}function i(t,n,r){var i=v.keyName(t),s,o;if(i=="Esc"||i=="Ctrl-C"||i=="Ctrl-["||i=="Backspace"&&n=="")it.exCommandHistoryController.pushInput(n),it.exCommandHistoryController.reset(),v.e_stop(t),ft(e),r(),e.focus();i=="Up"||i=="Down"?(v.e_stop(t),s=i=="Up"?!0:!1,o=t.target?t.target.selectionEnd:0,n=it.exCommandHistoryController.nextMatch(n,s)||"",r(n),o&&t.target&&(t.target.selectionEnd=t.target.selectionStart=Math.min(o,t.target.value.length))):i=="Ctrl-U"?(v.e_stop(t),r("")):i!="Left"&&i!="Right"&&i!="Ctrl"&&i!="Alt"&&i!="Shift"&&it.exCommandHistoryController.reset()}n.type=="keyToEx"?Wn.processCommand(e,n.exArgs.input):t.visualMode?Mn(e,{onClose:r,prefix:":",value:"'<,'>",onKeyDown:i,selectValueOnOpen:!1}):Mn(e,{onClose:r,prefix:":",onKeyDown:i})},evalInput:function(e,t){var n=t.inputState,r=n.motion,i=n.motionArgs||{},s=n.operator,o=n.operatorArgs||{},u=n.registerName,a=t.sel,f=At(t.visualMode?St(e,a.head):e.getCursor("head")),l=At(t.visualMode?St(e,a.anchor):e.getCursor("anchor")),c=At(f),h=At(l),p,d,v;s&&this.recordLastEdit(t,n),n.repeatOverride!==undefined?v=n.repeatOverride:v=n.getRepeat();if(v>0&&i.explicitRepeat)i.repeatIsExplicit=!0;else if(i.noRepeat||!i.explicitRepeat&&v===0)v=1,i.repeatIsExplicit=!1;n.selectedCharacter&&(i.selectedCharacter=o.selectedCharacter=n.selectedCharacter),i.repeat=v,ft(e);if(r){var m=vt[r](e,f,i,t);t.lastMotion=vt[r];if(!m)return;if(i.toJumplist){!s&&e.ace.curOp!=null&&(e.ace.curOp.command.scrollIntoView="center-animate");var g=it.jumpList,y=g.cachedCursor;y?(Zt(e,y,m),delete g.cachedCursor):Zt(e,f,m)}m instanceof Array?(d=m[0],p=m[1]):p=m,p||(p=At(f));if(t.visualMode){if(!t.visualBlock||p.ch!==Infinity)p=St(e,p,t.visualBlock);d&&(d=St(e,d,!0)),d=d||h,a.anchor=d,a.head=p,Xt(e),fn(e,t,"<",Mt(d,p)?d:p),fn(e,t,">",Mt(d,p)?p:d)}else s||(p=St(e,p),e.setCursor(p.line,p.ch))}if(s){if(o.lastSel){d=h;var b=o.lastSel,w=Math.abs(b.head.line-b.anchor.line),E=Math.abs(b.head.ch-b.anchor.ch);b.visualLine?p=S(h.line+w,h.ch):b.visualBlock?p=S(h.line+w,h.ch+E):b.head.line==b.anchor.line?p=S(h.line,h.ch+E):p=S(h.line+w,h.ch),t.visualMode=!0,t.visualLine=b.visualLine,t.visualBlock=b.visualBlock,a=t.sel={anchor:d,head:p},Xt(e)}else t.visualMode&&(o.lastSel={anchor:At(a.anchor),head:At(a.head),visualBlock:t.visualBlock,visualLine:t.visualLine});var x,T,N,C,k;if(t.visualMode){x=_t(a.head,a.anchor),T=Dt(a.head,a.anchor),N=t.visualLine||o.linewise,C=t.visualBlock?"block":N?"line":"char",k=Vt(e,{anchor:x,head:T},C);if(N){var L=k.ranges;if(C=="block")for(var A=0;Af&&i.line==f)return this.moveToEol(e,t,n,r,!0);var l=e.ace.session.getFoldLine(u);return l&&(n.forward?u>l.start.row&&(u=l.end.row+1):u=l.start.row),n.toFirstChar&&(s=Gt(e.getLine(u)),r.lastHPos=s),r.lastHSPos=e.charCoords(S(u,s),"div").left,S(u,s)},moveByDisplayLines:function(e,t,n,r){var i=t;switch(r.lastMotion){case this.moveByDisplayLines:case this.moveByScroll:case this.moveByLines:case this.moveToColumn:case this.moveToEol:break;default:r.lastHSPos=e.charCoords(i,"div").left}var s=n.repeat,o=e.findPosV(i,n.forward?s:-s,"line",r.lastHSPos);if(o.hitSide)if(n.forward)var u=e.charCoords(o,"div"),a={top:u.top+8,left:r.lastHSPos},o=e.coordsChar(a,"div");else{var f=e.charCoords(S(e.firstLine(),0),"div");f.left=r.lastHSPos,o=e.coordsChar(f,"div")}return r.lastHPos=o.ch,o},moveByPage:function(e,t,n){var r=t,i=n.repeat;return e.findPosV(r,n.forward?i:-i,"page")},moveByParagraph:function(e,t,n){var r=n.forward?1:-1;return cn(e,t,n.repeat,r)},moveBySentence:function(e,t,n){var r=n.forward?1:-1;return hn(e,t,n.repeat,r)},moveByScroll:function(e,t,n,r){var i=e.getScrollInfo(),s=null,o=n.repeat;o||(o=i.clientHeight/(2*e.defaultTextHeight()));var u=e.charCoords(t,"local");n.repeat=o;var s=vt.moveByDisplayLines(e,t,n,r);if(!s)return null;var a=e.charCoords(s,"local");return e.scrollTo(null,i.top+a.top-u.top),s},moveByWords:function(e,t,n){return on(e,t,n.repeat,!!n.forward,!!n.wordEnd,!!n.bigWord)},moveTillCharacter:function(e,t,n){var r=n.repeat,i=un(e,r,n.forward,n.selectedCharacter),s=n.forward?-1:1;return en(s,n),i?(i.ch+=s,i):null},moveToCharacter:function(e,t,n){var r=n.repeat;return en(0,n),un(e,r,n.forward,n.selectedCharacter)||t},moveToSymbol:function(e,t,n){var r=n.repeat;return rn(e,r,n.forward,n.selectedCharacter)||t},moveToColumn:function(e,t,n,r){var i=n.repeat;return r.lastHPos=i-1,r.lastHSPos=e.charCoords(t,"div").left,an(e,i)},moveToEol:function(e,t,n,r,i){var s=t,o=S(s.line+n.repeat-1,Infinity),u=e.clipPos(o);return u.ch--,i||(r.lastHPos=Infinity,r.lastHSPos=e.charCoords(u,"div").left),o},moveToFirstNonWhiteSpaceCharacter:function(e,t){var n=t;return S(n.line,Gt(e.getLine(n.line)))},moveToMatchedSymbol:function(e,t){var n=t,r=n.line,i=n.ch,s=e.getLine(r),o;for(;i]/.test(s[i])?/[(){}[\]<>]/:/[(){}[\]]/,f=e.findMatchingBracket(S(r,i+1),{bracketRegex:a});return f.to}return n},moveToStartOfLine:function(e,t){return S(t.line,0)},moveToLineOrEdgeOfDocument:function(e,t,n){var r=n.forward?e.lastLine():e.firstLine();return n.repeatIsExplicit&&(r=n.repeat-e.getOption("firstLineNumber")),S(r,Gt(e.getLine(r)))},textObjectManipulation:function(e,t,n,r){var i={"(":")",")":"(","{":"}","}":"{","[":"]","]":"[","<":">",">":"<"},s={"'":!0,'"':!0,"`":!0},o=n.selectedCharacter;o=="b"?o="(":o=="B"&&(o="{");var u=!n.textObjectInner,a;if(i[o])a=pn(e,t,o,u);else if(s[o])a=dn(e,t,o,u);else if(o==="W")a=Yt(e,u,!0,!0);else if(o==="w")a=Yt(e,u,!0,!1);else{if(o!=="p")return null;a=cn(e,t,n.repeat,0,u),n.linewise=!0;if(r.visualMode)r.visualLine||(r.visualLine=!0);else{var f=r.inputState.operatorArgs;f&&(f.linewise=!0),a.end.line--}}return e.state.vim.visualMode?Wt(e,a.start,a.end):[a.start,a.end]},repeatLastCharacterSearch:function(e,t,n){var r=it.lastCharacterSearch,i=n.repeat,s=n.forward===r.forward,o=(r.increment?1:0)*(s?-1:1);e.moveH(-o,"char"),n.inclusive=s?!0:!1;var u=un(e,i,s,r.selectedCharacter);return u?(u.ch+=o,u):(e.moveH(o,"char"),t)}},yt={change:function(e,t,n){var r,i,s=e.state.vim,o=n[0].anchor,u=n[0].head;if(!s.visualMode){i=e.getRange(o,u);var a=s.lastEditInputState||{};if(a.motion=="moveByWords"&&!$(i)){var f=/\s+$/.exec(i);f&&a.motionArgs&&a.motionArgs.forward&&(u=Tt(u,0,-f[0].length),i=i.slice(0,-f[0].length))}var l=new S(o.line-1,Number.MAX_VALUE),c=e.firstLine()==e.lastLine();u.line>e.lastLine()&&t.linewise&&!c?e.replaceRange("",l,u):e.replaceRange("",o,u),t.linewise&&(c||(e.setCursor(l),v.commands.newlineAndIndent(e)),o.ch=Number.MAX_VALUE),r=o}else if(t.fullLine)u.ch=Number.MAX_VALUE,u.line--,e.setSelection(o,u),i=e.getSelection(),e.replaceSelection(""),r=o;else{i=e.getSelection();var h=gt("",n.length);e.replaceSelections(h),r=_t(n[0].head,n[0].anchor)}it.registerController.pushText(t.registerName,"change",i,t.linewise,n.length>1),wt.enterInsertMode(e,{head:r},e.state.vim)},"delete":function(e,t,n){var r,i,s=e.state.vim;if(!s.visualBlock){var o=n[0].anchor,u=n[0].head;t.linewise&&u.line!=e.firstLine()&&o.line==e.lastLine()&&o.line==u.line-1&&(o.line==e.firstLine()?o.ch=0:o=S(o.line-1,Ht(e,o.line-1))),i=e.getRange(o,u),e.replaceRange("",o,u),r=o,t.linewise&&(r=vt.moveToFirstNonWhiteSpaceCharacter(e,o))}else{i=e.getSelection();var a=gt("",n.length);e.replaceSelections(a),r=n[0].anchor}it.registerController.pushText(t.registerName,"delete",i,t.linewise,s.visualBlock);var f=s.insertMode;return St(e,r,f)},indent:function(e,t,n){var r=e.state.vim,i=n[0].anchor.line,s=r.visualBlock?n[n.length-1].anchor.line:n[0].head.line,o=r.visualMode?t.repeat:1;t.linewise&&s--;for(var u=i;u<=s;u++)for(var a=0;af.top?(a.line+=(u-f.top)/i,a.line=Math.ceil(a.line),e.setCursor(a),f=e.charCoords(a,"local"),e.scrollTo(null,f.top)):e.scrollTo(null,u);else{var l=u+e.getScrollInfo().clientHeight;l=i.anchor.line?s=Tt(i.head,0,1):s=S(i.anchor.line,0)}else if(r=="inplace"){if(n.visualMode)return}else r=="lastEdit"&&(s=Rn(e)||s);e.setOption("disableInput",!1),t&&t.replace?(e.toggleOverwrite(!0),e.setOption("keyMap","vim-replace"),v.signal(e,"vim-mode-change",{mode:"replace"})):(e.toggleOverwrite(!1),e.setOption("keyMap","vim-insert"),v.signal(e,"vim-mode-change",{mode:"insert"})),it.macroModeState.isPlaying||(e.on("change",Zn),v.on(e.getInputField(),"keydown",ir)),n.visualMode&&Jt(e),qt(e,s,o)},toggleVisualMode:function(e,t,n){var r=t.repeat,i=e.getCursor(),s;n.visualMode?n.visualLine^t.linewise||n.visualBlock^t.blockwise?(n.visualLine=!!t.linewise,n.visualBlock=!!t.blockwise,v.signal(e,"vim-mode-change",{mode:"visual",subMode:n.visualLine?"linewise":n.visualBlock?"blockwise":""}),Xt(e)):Jt(e):(n.visualMode=!0,n.visualLine=!!t.linewise,n.visualBlock=!!t.blockwise,s=St(e,S(i.line,i.ch+r-1),!0),n.sel={anchor:i,head:s},v.signal(e,"vim-mode-change",{mode:"visual",subMode:n.visualLine?"linewise":n.visualBlock?"blockwise":""}),Xt(e),fn(e,n,"<",_t(i,s)),fn(e,n,">",Dt(i,s)))},reselectLastSelection:function(e,t,n){var r=n.lastSelection;n.visualMode&&zt(e,n);if(r){var i=r.anchorMark.find(),s=r.headMark.find();if(!i||!s)return;n.sel={anchor:i,head:s},n.visualMode=!0,n.visualLine=r.visualLine,n.visualBlock=r.visualBlock,Xt(e),fn(e,n,"<",_t(i,s)),fn(e,n,">",Dt(i,s)),v.signal(e,"vim-mode-change",{mode:"visual",subMode:n.visualLine?"linewise":n.visualBlock?"blockwise":""})}},joinLines:function(e,t,n){var r,i;if(n.visualMode){r=e.getCursor("anchor"),i=e.getCursor("head");if(Mt(i,r)){var s=i;i=r,r=s}i.ch=Ht(e,i.line)-1}else{var o=Math.max(t.repeat,2);r=e.getCursor(),i=St(e,S(r.line+o-1,Infinity))}var u=0;for(var a=r.line;a1)var s=Array(t.repeat+1).join(s);var p=i.linewise,d=i.blockwise;if(d){s=s.split("\n"),p&&s.pop();for(var v=0;ve.lastLine()&&e.replaceRange("\n",S(C,0));var k=Ht(e,C);ka.length&&(s=a.length),o=S(i.line,s)}if(r=="\n")n.visualMode||e.replaceRange("",i,o),(v.commands.newlineAndIndentContinueComment||v.commands.newlineAndIndent)(e);else{var f=e.getRange(i,o);f=f.replace(/[^\n]/g,r);if(n.visualBlock){var l=(new Array(e.getOption("tabSize")+1)).join(" ");f=e.getSelection(),f=f.replace(/\t/g,l).replace(/[^\n]/g,r).split("\n"),e.replaceSelections(f)}else e.replaceRange(f,i,o);n.visualMode?(i=Mt(u[0].anchor,u[0].head)?u[0].anchor:u[0].head,e.setCursor(i),Jt(e,!1)):e.setCursor(Tt(o,0,-1))}},incrementNumberToken:function(e,t){var n=e.getCursor(),r=e.getLine(n.line),i=/(-?)(?:(0x)([\da-f]+)|(0b|0|)(\d+))/gi,s,o,u,a;while((s=i.exec(r))!==null){o=s.index,u=o+s[0].length;if(n.ch=1)return!0}else e.nextCh===e.reverseSymb&&e.depth--;return!1}},section:{init:function(e){e.curMoveThrough=!0,e.symb=(e.forward?"]":"[")===e.symb?"{":"}"},isComplete:function(e){return e.index===0&&e.nextCh===e.symb}},comment:{isComplete:function(e){var t=e.lastCh==="*"&&e.nextCh==="/";return e.lastCh=e.nextCh,t}},method:{init:function(e){e.symb=e.symb==="m"?"{":"}",e.reverseSymb=e.symb==="{"?"}":"{"},isComplete:function(e){return e.nextCh===e.symb?!0:!1}},preprocess:{init:function(e){e.index=0},isComplete:function(e){if(e.nextCh==="#"){var t=e.lineText.match(/#(\w+)/)[1];if(t==="endif"){if(e.forward&&e.depth===0)return!0;e.depth++}else if(t==="if"){if(!e.forward&&e.depth===0)return!0;e.depth--}if(t==="else"&&e.depth===0)return!0}return!1}}};G("pcre",!0,"boolean"),vn.prototype={getQuery:function(){return it.query},setQuery:function(e){it.query=e},getOverlay:function(){return this.searchOverlay},setOverlay:function(e){this.searchOverlay=e},isReversed:function(){return it.isReversed},setReversed:function(e){it.isReversed=e},getScrollbarAnnotate:function(){return this.annotate},setScrollbarAnnotate:function(e){this.annotate=e}};var xn={"\\n":"\n","\\r":"\r","\\t":" "},Nn={"\\/":"/","\\\\":"\\","\\n":"\n","\\r":"\r","\\t":" "},On="(Javascript regexp)",Un=function(){this.buildCommandMap_()};Un.prototype={processCommand:function(e,t,n){var r=this;e.operation(function(){e.curOp.isVimOp=!0,r._processCommand(e,t,n)})},_processCommand:function(e,t,n){var r=e.state.vim,i=it.registerController.getRegister(":"),s=i.toString();r.visualMode&&Jt(e);var o=new v.StringStream(t);i.setText(t);var u=n||{};u.input=t;try{this.parseInput_(e,o,u)}catch(a){throw Ln(e,a),a}var f,l;if(!u.commandName)u.line!==undefined&&(l="move");else{f=this.matchCommand_(u.commandName);if(f){l=f.name,f.excludeFromCommandHistory&&i.setText(s),this.parseCommandArgs_(o,u,f);if(f.type=="exToKey"){for(var c=0;c0;t--){var n=e.substring(0,t);if(this.commandMap_[n]){var r=this.commandMap_[n];if(r.name.indexOf(e)===0)return r}}return null},buildCommandMap_:function(){this.commandMap_={};for(var e=0;e
        ";if(!n)for(var s in r){var o=r[s].toString();o.length&&(i+='"'+s+" "+o+"
        ")}else{var s;n=n.join("");for(var u=0;u"}}Ln(e,i)},sort:function(e,t){function u(){if(t.argString){var e=new v.StringStream(t.argString);e.eat("!")&&(n=!0);if(e.eol())return;if(!e.eatSpace())return"Invalid arguments";var u=e.match(/([dinuox]+)?\s*(\/.+\/)?\s*/);if(!u&&!e.eol())return"Invalid arguments";if(u[1]){r=u[1].indexOf("i")!=-1,i=u[1].indexOf("u")!=-1;var a=u[1].indexOf("d")!=-1||u[1].indexOf("n")!=-1&&1,f=u[1].indexOf("x")!=-1&&1,l=u[1].indexOf("o")!=-1&&1;if(a+f+l>1)return"Invalid arguments";s=a&&"decimal"||f&&"hex"||l&&"octal"}u[2]&&(o=new RegExp(u[2].substr(1,u[2].length-2),r?"i":""))}}function E(e,t){if(n){var i;i=e,e=t,t=i}r&&(e=e.toLowerCase(),t=t.toLowerCase());var o=s&&d.exec(e),u=s&&d.exec(t);return o?(o=parseInt((o[1]+o[2]).toLowerCase(),m),u=parseInt((u[1]+u[2]).toLowerCase(),m),o-u):e")}if(!u){Ln(e,c);return}var d=0,v=function(){if(d=f){Ln(e,"Invalid argument: "+t.argString.substring(i));return}for(var l=0;l<=f-a;l++){var c=String.fromCharCode(a+l);delete n.marks[c]}}else delete n.marks[s]}}},Wn=new Un;v.keyMap.vim={attach:k,detach:C,call:L},G("insertModeEscKeysTimeout",200,"number"),v.keyMap["vim-insert"]={fallthrough:["default"],attach:k,detach:C,call:L},v.keyMap["vim-replace"]={Backspace:"goCharLeft",fallthrough:["vim-insert"],attach:k,detach:C,call:L},st(),v.Vim=x(),x=v.Vim;var ur={"return":"CR",backspace:"BS","delete":"Del",esc:"Esc",left:"Left",right:"Right",up:"Up",down:"Down",space:"Space",home:"Home",end:"End",pageup:"PageUp",pagedown:"PageDown",enter:"CR"},fr=x.handleKey.bind(x);x.handleKey=function(e,t,n){return e.operation(function(){return fr(e,t,n)},!0)},t.CodeMirror=v;var hr=x.maybeInitVimState_;t.handler={$id:"ace/keyboard/vim",drawCursor:function(e,t,n,r,s){var u=this.state.vim||{},a=n.characterWidth,f=n.lineHeight,l=t.top,c=t.left;if(!u.insertMode){var h=r.cursor?i.comparePoints(r.cursor,r.start)<=0:s.selection.isBackwards()||s.selection.isEmpty();!h&&c>a&&(c-=a)}!u.insertMode&&u.status&&(f/=2,l+=f),o.translate(e,c,l),o.setStyle(e.style,"width",a+"px"),o.setStyle(e.style,"height",f+"px")},handleKeyboard:function(e,t,n,r,i){var s=e.editor,o=s.state.cm,u=hr(o);if(r==-1)return;u.insertMode||(t==-1?(n.charCodeAt(0)>255&&e.inputKey&&(n=e.inputKey,n&&e.inputHash==4&&(n=n.toUpperCase())),e.inputChar=n):t==4||t==0?e.inputKey==n&&e.inputHash==t&&e.inputChar?(n=e.inputChar,t=-1):(e.inputChar=null,e.inputKey=n,e.inputHash=t):e.inputChar=e.inputKey=null);if(n=="c"&&t==1&&!c.isMac&&s.getCopyText())return s.once("copy",function(){s.selection.clearSelection()}),{command:"null",passEvent:!0};if(n=="esc"&&!u.insertMode&&!u.visualMode&&!o.ace.inMultiSelectMode){var a=mn(o),f=a.getOverlay();f&&o.removeOverlay(f)}if(t==-1||t&1||t===0&&n.length>1){var l=u.insertMode,h=ar(t,n,i||{});u.status==null&&(u.status="");var p=cr(o,h,"user");u=hr(o),p&&u.status!=null?u.status+=h:u.status==null&&(u.status=""),o._signal("changeStatus");if(!p&&(t!=-1||l))return;return{command:"null",passEvent:!p}}},attach:function(e){function n(){var n=hr(t).insertMode;t.ace.renderer.setStyle("normal-mode",!n),e.textInput.setCommandMode(!n),e.renderer.$keepTextAreaAtCursor=n,e.renderer.$blockCursor=!n}e.state||(e.state={});var t=new v(e);e.state.cm=t,e.$vimModeHandler=this,v.keyMap.vim.attach(t),hr(t).status=null,t.on("vim-command-done",function(){if(t.virtualSelectionMode())return;hr(t).status=null,t.ace._signal("changeStatus"),t.ace.session.markUndoGroup()}),t.on("changeStatus",function(){t.ace.renderer.updateCursor(),t.ace._signal("changeStatus")}),t.on("vim-mode-change",function(){if(t.virtualSelectionMode())return;n(),t._signal("changeStatus")}),n(),e.renderer.$cursorLayer.drawCursor=this.drawCursor.bind(t)},detach:function(e){var t=e.state.cm;v.keyMap.vim.detach(t),t.destroy(),e.state.cm=null,e.$vimModeHandler=null,e.renderer.$cursorLayer.drawCursor=null,e.renderer.setStyle("normal-mode",!1),e.textInput.setCommandMode(!1),e.renderer.$keepTextAreaAtCursor=!0},getStatusText:function(e){var t=e.state.cm,n=hr(t);if(n.insertMode)return"INSERT";var r="";return n.visualMode&&(r+="VISUAL",n.visualLine&&(r+=" LINE"),n.visualBlock&&(r+=" BLOCK")),n.status&&(r+=(r?" ":"")+n.status),r}},x.defineOption({name:"wrap",set:function(e,t){t&&t.ace.setOption("wrap",e)},type:"boolean"},!1),x.defineEx("write","w",function(){console.log(":write is not implemented")}),b.push({keys:"zc",type:"action",action:"fold",actionArgs:{open:!1}},{keys:"zC",type:"action",action:"fold",actionArgs:{open:!1,all:!0}},{keys:"zo",type:"action",action:"fold",actionArgs:{open:!0}},{keys:"zO",type:"action",action:"fold",actionArgs:{open:!0,all:!0}},{keys:"za",type:"action",action:"fold",actionArgs:{toggle:!0}},{keys:"zA",type:"action",action:"fold",actionArgs:{toggle:!0,all:!0}},{keys:"zf",type:"action",action:"fold",actionArgs:{open:!0,all:!0}},{keys:"zd",type:"action",action:"fold",actionArgs:{open:!0,all:!0}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"addCursorAbove"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"addCursorBelow"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"addCursorAboveSkipCurrent"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"addCursorBelowSkipCurrent"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"selectMoreBefore"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"selectMoreAfter"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"selectNextBefore"}},{keys:"",type:"action",action:"aceCommand",actionArgs:{name:"selectNextAfter"}}),wt.aceCommand=function(e,t,n){e.vimCmd=t,e.ace.inVirtualSelectionMode?e.ace.on("beforeEndOperation",pr):pr(null,e.ace)},wt.fold=function(e,t,n){e.ace.execCommand(["toggleFoldWidget","toggleFoldWidget","foldOther","unfoldall"][(t.all?2:0)+(t.open?1:0)])},t.handler.defaultKeymap=b,t.handler.actions=wt,t.Vim=x}); (function() { + window.require(["ace/keyboard/vim"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/keybinding-vscode.js b/data/static/vendor/src-min/keybinding-vscode.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/keybinding-vscode.js @@ -0,0 +1,8 @@ +define("ace/keyboard/vscode",["require","exports","module","ace/keyboard/hash_handler","ace/config"],function(e,t,n){"use strict";var r=e("../keyboard/hash_handler").HashHandler,i=e("../config");t.handler=new r,t.handler.$id="ace/keyboard/vscode",t.handler.addCommands([{name:"toggleWordWrap",exec:function(e){var t=e.session.getUseWrapMode();e.session.setUseWrapMode(!t)},readOnly:!0},{name:"navigateToLastEditLocation",exec:function(e){var t=e.session.getUndoManager().$lastDelta,n=t.action=="remove"?t.start:t.end;e.moveCursorTo(n.row,n.column),e.clearSelection()}},{name:"replaceAll",exec:function(e){e.searchBox?e.searchBox.active===!0&&e.searchBox.replaceOption.checked===!0&&e.searchBox.replaceAll():i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!0)})}},{name:"replaceOne",exec:function(e){e.searchBox?e.searchBox.active===!0&&e.searchBox.replaceOption.checked===!0&&e.searchBox.replace():i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!0)})}},{name:"selectAllMatches",exec:function(e){e.searchBox?e.searchBox.active===!0&&e.searchBox.findAll():i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!1)})}},{name:"toggleFindCaseSensitive",exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!1);var n=e.searchBox;n.caseSensitiveOption.checked=!n.caseSensitiveOption.checked,n.$syncOptions()})}},{name:"toggleFindInSelection",exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!1);var n=e.searchBox;n.searchOption.checked=!n.searchRange,n.setSearchRange(n.searchOption.checked&&n.editor.getSelectionRange()),n.$syncOptions()})}},{name:"toggleFindRegex",exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!1);var n=e.searchBox;n.regExpOption.checked=!n.regExpOption.checked,n.$syncOptions()})}},{name:"toggleFindWholeWord",exec:function(e){i.loadModule("ace/ext/searchbox",function(t){t.Search(e,!1);var n=e.searchBox;n.wholeWordOption.checked=!n.wholeWordOption.checked,n.$syncOptions()})}},{name:"removeSecondaryCursors",exec:function(e){var t=e.selection.ranges;t&&t.length>1?e.selection.toSingleRange(t[t.length-1]):e.selection.clearSelection()}}]),[{bindKey:{mac:"Ctrl-G",win:"Ctrl-G"},name:"gotoline"},{bindKey:{mac:"Command-Shift-L|Command-F2",win:"Ctrl-Shift-L|Ctrl-F2"},name:"findAll"},{bindKey:{mac:"Shift-F8|Shift-Option-F8",win:"Shift-F8|Shift-Alt-F8"},name:"goToPreviousError"},{bindKey:{mac:"F8|Option-F8",win:"F8|Alt-F8"},name:"goToNextError"},{bindKey:{mac:"Command-Shift-P|F1",win:"Ctrl-Shift-P|F1"},name:"openCommandPallete"},{bindKey:{mac:"Command-K|Command-S",win:"Ctrl-K|Ctrl-S"},name:"showKeyboardShortcuts"},{bindKey:{mac:"Shift-Option-Up",win:"Alt-Shift-Up"},name:"copylinesup"},{bindKey:{mac:"Shift-Option-Down",win:"Alt-Shift-Down"},name:"copylinesdown"},{bindKey:{mac:"Command-Shift-K",win:"Ctrl-Shift-K"},name:"removeline"},{bindKey:{mac:"Command-Enter",win:"Ctrl-Enter"},name:"addLineAfter"},{bindKey:{mac:"Command-Shift-Enter",win:"Ctrl-Shift-Enter"},name:"addLineBefore"},{bindKey:{mac:"Command-Shift-\\",win:"Ctrl-Shift-\\"},name:"jumptomatching"},{bindKey:{mac:"Command-]",win:"Ctrl-]"},name:"blockindent"},{bindKey:{mac:"Command-[",win:"Ctrl-["},name:"blockoutdent"},{bindKey:{mac:"Ctrl-PageDown",win:"Alt-PageDown"},name:"pagedown"},{bindKey:{mac:"Ctrl-PageUp",win:"Alt-PageUp"},name:"pageup"},{bindKey:{mac:"Shift-Option-A",win:"Shift-Alt-A"},name:"toggleBlockComment"},{bindKey:{mac:"Option-Z",win:"Alt-Z"},name:"toggleWordWrap"},{bindKey:{mac:"Command-G",win:"F3|Ctrl-K Ctrl-D"},name:"findnext"},{bindKey:{mac:"Command-Shift-G",win:"Shift-F3"},name:"findprevious"},{bindKey:{mac:"Option-Enter",win:"Alt-Enter"},name:"selectAllMatches"},{bindKey:{mac:"Command-D",win:"Ctrl-D"},name:"selectMoreAfter"},{bindKey:{mac:"Command-K Command-D",win:"Ctrl-K Ctrl-D"},name:"selectOrFindNext"},{bindKey:{mac:"Shift-Option-I",win:"Shift-Alt-I"},name:"splitSelectionIntoLines"},{bindKey:{mac:"Command-K M",win:"Ctrl-K M"},name:"modeSelect"},{bindKey:{mac:"Command-Option-[",win:"Ctrl-Shift-["},name:"toggleFoldWidget"},{bindKey:{mac:"Command-Option-]",win:"Ctrl-Shift-]"},name:"toggleFoldWidget"},{bindKey:{mac:"Command-K Command-0",win:"Ctrl-K Ctrl-0"},name:"foldall"},{bindKey:{mac:"Command-K Command-J",win:"Ctrl-K Ctrl-J"},name:"unfoldall"},{bindKey:{mac:"Command-K Command-1",win:"Ctrl-K Ctrl-1"},name:"foldOther"},{bindKey:{mac:"Command-K Command-Q",win:"Ctrl-K Ctrl-Q"},name:"navigateToLastEditLocation"},{bindKey:{mac:"Command-K Command-R|Command-K Command-S",win:"Ctrl-K Ctrl-R|Ctrl-K Ctrl-S"},name:"showKeyboardShortcuts"},{bindKey:{mac:"Command-K Command-X",win:"Ctrl-K Ctrl-X"},name:"trimTrailingSpace"},{bindKey:{mac:"Shift-Down|Command-Shift-Down",win:"Shift-Down|Ctrl-Shift-Down"},name:"selectdown"},{bindKey:{mac:"Shift-Up|Command-Shift-Up",win:"Shift-Up|Ctrl-Shift-Up"},name:"selectup"},{bindKey:{mac:"Command-Alt-Enter",win:"Ctrl-Alt-Enter"},name:"replaceAll"},{bindKey:{mac:"Command-Shift-1",win:"Ctrl-Shift-1"},name:"replaceOne"},{bindKey:{mac:"Option-C",win:"Alt-C"},name:"toggleFindCaseSensitive"},{bindKey:{mac:"Option-L",win:"Alt-L"},name:"toggleFindInSelection"},{bindKey:{mac:"Option-R",win:"Alt-R"},name:"toggleFindRegex"},{bindKey:{mac:"Option-W",win:"Alt-W"},name:"toggleFindWholeWord"},{bindKey:{mac:"Command-L",win:"Ctrl-L"},name:"expandtoline"},{bindKey:{mac:"Shift-Esc",win:"Shift-Esc"},name:"removeSecondaryCursors"}].forEach(function(e){var n=t.handler.commands[e.name];n&&(n.bindKey=e.bindKey),t.handler.bindKey(e.bindKey,n||e.name)})}); (function() { + window.require(["ace/keyboard/vscode"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/mode-haskell.js b/data/static/vendor/src-min/mode-haskell.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/mode-haskell.js @@ -0,0 +1,8 @@ +define("ace/mode/haskell_highlight_rules",["require","exports","module","ace/lib/oop","ace/mode/text_highlight_rules"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("./text_highlight_rules").TextHighlightRules,s=function(){this.$rules={start:[{token:["punctuation.definition.entity.haskell","keyword.operator.function.infix.haskell","punctuation.definition.entity.haskell"],regex:"(`)([a-zA-Z_']*?)(`)",comment:"In case this regex seems unusual for an infix operator, note that Haskell allows any ordinary function application (elem 4 [1..10]) to be rewritten as an infix expression (4 `elem` [1..10])."},{token:"constant.language.unit.haskell",regex:"\\(\\)"},{token:"constant.language.empty-list.haskell",regex:"\\[\\]"},{token:"keyword.other.haskell",regex:"\\b(module|signature)\\b",push:[{token:"keyword.other.haskell",regex:"\\bwhere\\b",next:"pop"},{include:"#module_name"},{include:"#module_exports"},{token:"invalid",regex:"[a-z]+"},{defaultToken:"meta.declaration.module.haskell"}]},{token:"keyword.other.haskell",regex:"\\bclass\\b",push:[{token:"keyword.other.haskell",regex:"\\bwhere\\b",next:"pop"},{token:"support.class.prelude.haskell",regex:"\\b(?:Monad|Functor|Eq|Ord|Read|Show|Num|(?:Frac|Ra)tional|Enum|Bounded|Real(?:Frac|Float)?|Integral|Floating)\\b"},{token:"entity.other.inherited-class.haskell",regex:"[A-Z][A-Za-z_']*"},{token:"variable.other.generic-type.haskell",regex:"\\b[a-z][a-zA-Z0-9_']*\\b"},{defaultToken:"meta.declaration.class.haskell"}]},{token:"keyword.other.haskell",regex:"\\binstance\\b",push:[{token:"keyword.other.haskell",regex:"\\bwhere\\b|$",next:"pop"},{include:"#type_signature"},{defaultToken:"meta.declaration.instance.haskell"}]},{token:"keyword.other.haskell",regex:"import",push:[{token:"meta.import.haskell",regex:"$|;|^",next:"pop"},{token:"keyword.other.haskell",regex:"qualified|as|hiding"},{include:"#module_name"},{include:"#module_exports"},{defaultToken:"meta.import.haskell"}]},{token:["keyword.other.haskell","meta.deriving.haskell"],regex:"(deriving)(\\s*\\()",push:[{token:"meta.deriving.haskell",regex:"\\)",next:"pop"},{token:"entity.other.inherited-class.haskell",regex:"\\b[A-Z][a-zA-Z_']*"},{defaultToken:"meta.deriving.haskell"}]},{token:"keyword.other.haskell",regex:"\\b(?:deriving|where|data|type|case|of|let|in|newtype|default)\\b"},{token:"keyword.operator.haskell",regex:"\\binfix[lr]?\\b"},{token:"keyword.control.haskell",regex:"\\b(?:do|if|then|else)\\b"},{token:"constant.numeric.float.haskell",regex:"\\b(?:[0-9]+\\.[0-9]+(?:[eE][+-]?[0-9]+)?|[0-9]+[eE][+-]?[0-9]+)\\b",comment:"Floats are always decimal"},{token:"constant.numeric.haskell",regex:"\\b(?:[0-9]+|0(?:[xX][0-9a-fA-F]+|[oO][0-7]+))\\b"},{token:["meta.preprocessor.c","punctuation.definition.preprocessor.c","meta.preprocessor.c"],regex:"^(\\s*)(#)(\\s*\\w+)",comment:'In addition to Haskell\'s "native" syntax, GHC permits the C preprocessor to be run on a source file.'},{include:"#pragma"},{token:"punctuation.definition.string.begin.haskell",regex:'"',push:[{token:"punctuation.definition.string.end.haskell",regex:'"',next:"pop"},{token:"constant.character.escape.haskell",regex:"\\\\(?:NUL|SOH|STX|ETX|EOT|ENQ|ACK|BEL|BS|HT|LF|VT|FF|CR|SO|SI|DLE|DC1|DC2|DC3|DC4|NAK|SYN|ETB|CAN|EM|SUB|ESC|FS|GS|RS|US|SP|DEL|[abfnrtv\\\\\\\"'\\&])"},{token:"constant.character.escape.octal.haskell",regex:"\\\\o[0-7]+|\\\\x[0-9A-Fa-f]+|\\\\[0-9]+"},{token:"constant.character.escape.control.haskell",regex:"\\^[A-Z@\\[\\]\\\\\\^_]"},{defaultToken:"string.quoted.double.haskell"}]},{token:["punctuation.definition.string.begin.haskell","string.quoted.single.haskell","constant.character.escape.haskell","constant.character.escape.octal.haskell","constant.character.escape.hexadecimal.haskell","constant.character.escape.control.haskell","punctuation.definition.string.end.haskell"],regex:"(')(?:([\\ -\\[\\]-~])|(\\\\(?:NUL|SOH|STX|ETX|EOT|ENQ|ACK|BEL|BS|HT|LF|VT|FF|CR|SO|SI|DLE|DC1|DC2|DC3|DC4|NAK|SYN|ETB|CAN|EM|SUB|ESC|FS|GS|RS|US|SP|DEL|[abfnrtv\\\\\\\"'\\&]))|(\\\\o[0-7]+)|(\\\\x[0-9A-Fa-f]+)|(\\^[A-Z@\\[\\]\\\\\\^_]))(')"},{token:["meta.function.type-declaration.haskell","entity.name.function.haskell","meta.function.type-declaration.haskell","keyword.other.double-colon.haskell"],regex:"^(\\s*)([a-z_][a-zA-Z0-9_']*|\\([|!%$+\\-.,=]+\\))(\\s*)(::)",push:[{token:"meta.function.type-declaration.haskell",regex:"$",next:"pop"},{include:"#type_signature"},{defaultToken:"meta.function.type-declaration.haskell"}]},{token:"support.constant.haskell",regex:"\\b(?:Just|Nothing|Left|Right|True|False|LT|EQ|GT|\\(\\)|\\[\\])\\b"},{token:"constant.other.haskell",regex:"\\b[A-Z]\\w*\\b"},{include:"#comments"},{token:"support.function.prelude.haskell",regex:"\\b(?:abs|acos|acosh|all|and|any|appendFile|applyM|asTypeOf|asin|asinh|atan|atan2|atanh|break|catch|ceiling|compare|concat|concatMap|const|cos|cosh|curry|cycle|decodeFloat|div|divMod|drop|dropWhile|elem|encodeFloat|enumFrom|enumFromThen|enumFromThenTo|enumFromTo|error|even|exp|exponent|fail|filter|flip|floatDigits|floatRadix|floatRange|floor|fmap|foldl|foldl1|foldr|foldr1|fromEnum|fromInteger|fromIntegral|fromRational|fst|gcd|getChar|getContents|getLine|head|id|init|interact|ioError|isDenormalized|isIEEE|isInfinite|isNaN|isNegativeZero|iterate|last|lcm|length|lex|lines|log|logBase|lookup|map|mapM|mapM_|max|maxBound|maximum|maybe|min|minBound|minimum|mod|negate|not|notElem|null|odd|or|otherwise|pi|pred|print|product|properFraction|putChar|putStr|putStrLn|quot|quotRem|read|readFile|readIO|readList|readLn|readParen|reads|readsPrec|realToFrac|recip|rem|repeat|replicate|return|reverse|round|scaleFloat|scanl|scanl1|scanr|scanr1|seq|sequence|sequence_|show|showChar|showList|showParen|showString|shows|showsPrec|significand|signum|sin|sinh|snd|span|splitAt|sqrt|subtract|succ|sum|tail|take|takeWhile|tan|tanh|toEnum|toInteger|toRational|truncate|uncurry|undefined|unlines|until|unwords|unzip|unzip3|userError|words|writeFile|zip|zip3|zipWith|zipWith3)\\b"},{include:"#infix_op"},{token:"keyword.operator.haskell",regex:"[|!%$?~+:\\-.=\\\\]+",comment:"In case this regex seems overly general, note that Haskell permits the definition of new operators which can be nearly any string of punctuation characters, such as $%^&*."},{token:"punctuation.separator.comma.haskell",regex:","}],"#block_comment":[{token:"punctuation.definition.comment.haskell",regex:"\\{-(?!#)",push:[{include:"#block_comment"},{token:"punctuation.definition.comment.haskell",regex:"-\\}",next:"pop"},{defaultToken:"comment.block.haskell"}]}],"#comments":[{token:"punctuation.definition.comment.haskell",regex:"--.*",push_:[{token:"comment.line.double-dash.haskell",regex:"$",next:"pop"},{defaultToken:"comment.line.double-dash.haskell"}]},{include:"#block_comment"}],"#infix_op":[{token:"entity.name.function.infix.haskell",regex:"\\([|!%$+:\\-.=]+\\)|\\(,+\\)"}],"#module_exports":[{token:"meta.declaration.exports.haskell",regex:"\\(",push:[{token:"meta.declaration.exports.haskell.end",regex:"\\)",next:"pop"},{token:"entity.name.function.haskell",regex:"\\b[a-z][a-zA-Z_']*"},{token:"storage.type.haskell",regex:"\\b[A-Z][A-Za-z_']*"},{token:"punctuation.separator.comma.haskell",regex:","},{include:"#infix_op"},{token:"meta.other.unknown.haskell",regex:"\\(.*?\\)",comment:"So named because I don't know what to call this."},{defaultToken:"meta.declaration.exports.haskell.end"}]}],"#module_name":[{token:"support.other.module.haskell",regex:"[A-Z][A-Za-z._']*"}],"#pragma":[{token:"meta.preprocessor.haskell",regex:"\\{-#",push:[{token:"meta.preprocessor.haskell",regex:"#-\\}",next:"pop"},{token:"keyword.other.preprocessor.haskell",regex:"\\b(?:LANGUAGE|UNPACK|INLINE)\\b"},{defaultToken:"meta.preprocessor.haskell"}]}],"#type_signature":[{token:["meta.class-constraint.haskell","entity.other.inherited-class.haskell","meta.class-constraint.haskell","variable.other.generic-type.haskell","meta.class-constraint.haskell","keyword.other.big-arrow.haskell"],regex:"(\\(\\s*)([A-Z][A-Za-z]*)(\\s+)([a-z][A-Za-z_']*)(\\)\\s*)(=>)"},{include:"#pragma"},{token:"keyword.other.arrow.haskell",regex:"->"},{token:"keyword.other.big-arrow.haskell",regex:"=>"},{token:"support.type.prelude.haskell",regex:"\\b(?:Int(?:eger)?|Maybe|Either|Bool|Float|Double|Char|String|Ordering|ShowS|ReadS|FilePath|IO(?:Error)?)\\b"},{token:"variable.other.generic-type.haskell",regex:"\\b[a-z][a-zA-Z0-9_']*\\b"},{token:"storage.type.haskell",regex:"\\b[A-Z][a-zA-Z0-9_']*\\b"},{token:"support.constant.unit.haskell",regex:"\\(\\)"},{include:"#comments"}]},this.normalizeRules()};s.metaData={fileTypes:["hs"],keyEquivalent:"^~H",name:"Haskell",scopeName:"source.haskell"},r.inherits(s,i),t.HaskellHighlightRules=s}),define("ace/mode/folding/cstyle",["require","exports","module","ace/lib/oop","ace/range","ace/mode/folding/fold_mode"],function(e,t,n){"use strict";var r=e("../../lib/oop"),i=e("../../range").Range,s=e("./fold_mode").FoldMode,o=t.FoldMode=function(e){e&&(this.foldingStartMarker=new RegExp(this.foldingStartMarker.source.replace(/\|[^|]*?$/,"|"+e.start)),this.foldingStopMarker=new RegExp(this.foldingStopMarker.source.replace(/\|[^|]*?$/,"|"+e.end)))};r.inherits(o,s),function(){this.foldingStartMarker=/([\{\[\(])[^\}\]\)]*$|^\s*(\/\*)/,this.foldingStopMarker=/^[^\[\{\(]*([\}\]\)])|^[\s\*]*(\*\/)/,this.singleLineBlockCommentRe=/^\s*(\/\*).*\*\/\s*$/,this.tripleStarBlockCommentRe=/^\s*(\/\*\*\*).*\*\/\s*$/,this.startRegionRe=/^\s*(\/\*|\/\/)#?region\b/,this._getFoldWidgetBase=this.getFoldWidget,this.getFoldWidget=function(e,t,n){var r=e.getLine(n);if(this.singleLineBlockCommentRe.test(r)&&!this.startRegionRe.test(r)&&!this.tripleStarBlockCommentRe.test(r))return"";var i=this._getFoldWidgetBase(e,t,n);return!i&&this.startRegionRe.test(r)?"start":i},this.getFoldWidgetRange=function(e,t,n,r){var i=e.getLine(n);if(this.startRegionRe.test(i))return this.getCommentRegionBlock(e,i,n);var s=i.match(this.foldingStartMarker);if(s){var o=s.index;if(s[1])return this.openingBracketBlock(e,s[1],n,o);var u=e.getCommentFoldRange(n,o+s[0].length,1);return u&&!u.isMultiLine()&&(r?u=this.getSectionRange(e,n):t!="all"&&(u=null)),u}if(t==="markbegin")return;var s=i.match(this.foldingStopMarker);if(s){var o=s.index+s[0].length;return s[1]?this.closingBracketBlock(e,s[1],n,o):e.getCommentFoldRange(n,o,-1)}},this.getSectionRange=function(e,t){var n=e.getLine(t),r=n.search(/\S/),s=t,o=n.length;t+=1;var u=t,a=e.getLength();while(++tf)break;var l=this.getFoldWidgetRange(e,"all",t);if(l){if(l.start.row<=s)break;if(l.isMultiLine())t=l.end.row;else if(r==f)break}u=t}return new i(s,o,u,e.getLine(u).length)},this.getCommentRegionBlock=function(e,t,n){var r=t.search(/\s*$/),s=e.getLength(),o=n,u=/^\s*(?:\/\*|\/\/|--)#?(end)?region\b/,a=1;while(++no)return new i(o,r,l,t.length)}}.call(o.prototype)}),define("ace/mode/haskell",["require","exports","module","ace/lib/oop","ace/mode/text","ace/mode/haskell_highlight_rules","ace/mode/folding/cstyle"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("./text").Mode,s=e("./haskell_highlight_rules").HaskellHighlightRules,o=e("./folding/cstyle").FoldMode,u=function(){this.HighlightRules=s,this.foldingRules=new o,this.$behaviour=this.$defaultBehaviour};r.inherits(u,i),function(){this.lineCommentStart="--",this.blockComment=null,this.$id="ace/mode/haskell",this.snippetFileId="ace/snippets/haskell"}.call(u.prototype),t.Mode=u}); (function() { + window.require(["ace/mode/haskell"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/mode-sql.js b/data/static/vendor/src-min/mode-sql.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/mode-sql.js @@ -0,0 +1,8 @@ +define("ace/mode/sql_highlight_rules",["require","exports","module","ace/lib/oop","ace/mode/text_highlight_rules"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("./text_highlight_rules").TextHighlightRules,s=function(){var e="select|insert|update|delete|from|where|and|or|group|by|order|limit|offset|having|as|case|when|then|else|end|type|left|right|join|on|outer|desc|asc|union|create|table|primary|key|if|foreign|not|references|default|null|inner|cross|natural|database|drop|grant",t="true|false",n="avg|count|first|last|max|min|sum|ucase|lcase|mid|len|round|rank|now|format|coalesce|ifnull|isnull|nvl",r="int|numeric|decimal|date|varchar|char|bigint|float|double|bit|binary|text|set|timestamp|money|real|number|integer",i=this.createKeywordMapper({"support.function":n,keyword:e,"constant.language":t,"storage.type":r},"identifier",!0);this.$rules={start:[{token:"comment",regex:"--.*$"},{token:"comment",start:"/\\*",end:"\\*/"},{token:"string",regex:'".*?"'},{token:"string",regex:"'.*?'"},{token:"string",regex:"`.*?`"},{token:"constant.numeric",regex:"[+-]?\\d+(?:(?:\\.\\d*)?(?:[eE][+-]?\\d+)?)?\\b"},{token:i,regex:"[a-zA-Z_$][a-zA-Z0-9_$]*\\b"},{token:"keyword.operator",regex:"\\+|\\-|\\/|\\/\\/|%|<@>|@>|<@|&|\\^|~|<|>|<=|=>|==|!=|<>|="},{token:"paren.lparen",regex:"[\\(]"},{token:"paren.rparen",regex:"[\\)]"},{token:"text",regex:"\\s+"}]},this.normalizeRules()};r.inherits(s,i),t.SqlHighlightRules=s}),define("ace/mode/sql",["require","exports","module","ace/lib/oop","ace/mode/text","ace/mode/sql_highlight_rules"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("./text").Mode,s=e("./sql_highlight_rules").SqlHighlightRules,o=function(){this.HighlightRules=s,this.$behaviour=this.$defaultBehaviour};r.inherits(o,i),function(){this.lineCommentStart="--",this.$id="ace/mode/sql",this.snippetFileId="ace/snippets/sql"}.call(o.prototype),t.Mode=o}); (function() { + window.require(["ace/mode/sql"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/snippets/sql.js b/data/static/vendor/src-min/snippets/sql.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/snippets/sql.js @@ -0,0 +1,8 @@ +define("ace/snippets/sql",["require","exports","module"],function(e,t,n){"use strict";t.snippetText="snippet tbl\n create table ${1:table} (\n ${2:columns}\n );\nsnippet col\n ${1:name} ${2:type} ${3:default ''} ${4:not null}\nsnippet ccol\n ${1:name} varchar2(${2:size}) ${3:default ''} ${4:not null}\nsnippet ncol\n ${1:name} number ${3:default 0} ${4:not null}\nsnippet dcol\n ${1:name} date ${3:default sysdate} ${4:not null}\nsnippet ind\n create index ${3:$1_$2} on ${1:table}(${2:column});\nsnippet uind\n create unique index ${1:name} on ${2:table}(${3:column});\nsnippet tblcom\n comment on table ${1:table} is '${2:comment}';\nsnippet colcom\n comment on column ${1:table}.${2:column} is '${3:comment}';\nsnippet addcol\n alter table ${1:table} add (${2:column} ${3:type});\nsnippet seq\n create sequence ${1:name} start with ${2:1} increment by ${3:1} minvalue ${4:1};\nsnippet s*\n select * from ${1:table}\n",t.scope="sql"}); (function() { + window.require(["ace/snippets/sql"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/theme-solarized_dark.js b/data/static/vendor/src-min/theme-solarized_dark.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/theme-solarized_dark.js @@ -0,0 +1,8 @@ +define("ace/theme/solarized_dark",["require","exports","module","ace/lib/dom"],function(e,t,n){t.isDark=!0,t.cssClass="ace-solarized-dark",t.cssText=".ace-solarized-dark .ace_gutter {background: #01313f;color: #d0edf7}.ace-solarized-dark .ace_print-margin {width: 1px;background: #33555E}.ace-solarized-dark {background-color: #002B36;color: #93A1A1}.ace-solarized-dark .ace_entity.ace_other.ace_attribute-name,.ace-solarized-dark .ace_storage {color: #93A1A1}.ace-solarized-dark .ace_cursor,.ace-solarized-dark .ace_string.ace_regexp {color: #D30102}.ace-solarized-dark .ace_marker-layer .ace_active-line,.ace-solarized-dark .ace_marker-layer .ace_selection {background: rgba(255, 255, 255, 0.1)}.ace-solarized-dark.ace_multiselect .ace_selection.ace_start {box-shadow: 0 0 3px 0px #002B36;}.ace-solarized-dark .ace_marker-layer .ace_step {background: rgb(102, 82, 0)}.ace-solarized-dark .ace_marker-layer .ace_bracket {margin: -1px 0 0 -1px;border: 1px solid rgba(147, 161, 161, 0.50)}.ace-solarized-dark .ace_gutter-active-line {background-color: #0d3440}.ace-solarized-dark .ace_marker-layer .ace_selected-word {border: 1px solid #073642}.ace-solarized-dark .ace_invisible {color: rgba(147, 161, 161, 0.50)}.ace-solarized-dark .ace_keyword,.ace-solarized-dark .ace_meta,.ace-solarized-dark .ace_support.ace_class,.ace-solarized-dark .ace_support.ace_type {color: #859900}.ace-solarized-dark .ace_constant.ace_character,.ace-solarized-dark .ace_constant.ace_other {color: #CB4B16}.ace-solarized-dark .ace_constant.ace_language {color: #B58900}.ace-solarized-dark .ace_constant.ace_numeric {color: #D33682}.ace-solarized-dark .ace_fold {background-color: #268BD2;border-color: #93A1A1}.ace-solarized-dark .ace_entity.ace_name.ace_function,.ace-solarized-dark .ace_entity.ace_name.ace_tag,.ace-solarized-dark .ace_support.ace_function,.ace-solarized-dark .ace_variable,.ace-solarized-dark .ace_variable.ace_language {color: #268BD2}.ace-solarized-dark .ace_string {color: #2AA198}.ace-solarized-dark .ace_comment {font-style: italic;color: #657B83}.ace-solarized-dark .ace_indent-guide {background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAEklEQVQImWNg0Db1ZVCxc/sPAAd4AlUHlLenAAAAAElFTkSuQmCC) right repeat-y}";var r=e("../lib/dom");r.importCssString(t.cssText,t.cssClass)}); (function() { + window.require(["ace/theme/solarized_dark"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/src-min/theme-solarized_light.js b/data/static/vendor/src-min/theme-solarized_light.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/src-min/theme-solarized_light.js @@ -0,0 +1,8 @@ +define("ace/theme/solarized_light",["require","exports","module","ace/lib/dom"],function(e,t,n){t.isDark=!1,t.cssClass="ace-solarized-light",t.cssText=".ace-solarized-light .ace_gutter {background: #fbf1d3;color: #333}.ace-solarized-light .ace_print-margin {width: 1px;background: #e8e8e8}.ace-solarized-light {background-color: #FDF6E3;color: #586E75}.ace-solarized-light .ace_cursor {color: #000000}.ace-solarized-light .ace_marker-layer .ace_selection {background: rgba(7, 54, 67, 0.09)}.ace-solarized-light.ace_multiselect .ace_selection.ace_start {box-shadow: 0 0 3px 0px #FDF6E3;}.ace-solarized-light .ace_marker-layer .ace_step {background: rgb(255, 255, 0)}.ace-solarized-light .ace_marker-layer .ace_bracket {margin: -1px 0 0 -1px;border: 1px solid rgba(147, 161, 161, 0.50)}.ace-solarized-light .ace_marker-layer .ace_active-line {background: #EEE8D5}.ace-solarized-light .ace_gutter-active-line {background-color : #EDE5C1}.ace-solarized-light .ace_marker-layer .ace_selected-word {border: 1px solid #7f9390}.ace-solarized-light .ace_invisible {color: rgba(147, 161, 161, 0.50)}.ace-solarized-light .ace_keyword,.ace-solarized-light .ace_meta,.ace-solarized-light .ace_support.ace_class,.ace-solarized-light .ace_support.ace_type {color: #859900}.ace-solarized-light .ace_constant.ace_character,.ace-solarized-light .ace_constant.ace_other {color: #CB4B16}.ace-solarized-light .ace_constant.ace_language {color: #B58900}.ace-solarized-light .ace_constant.ace_numeric {color: #D33682}.ace-solarized-light .ace_fold {background-color: #268BD2;border-color: #586E75}.ace-solarized-light .ace_entity.ace_name.ace_function,.ace-solarized-light .ace_entity.ace_name.ace_tag,.ace-solarized-light .ace_support.ace_function,.ace-solarized-light .ace_variable,.ace-solarized-light .ace_variable.ace_language {color: #268BD2}.ace-solarized-light .ace_storage {color: #073642}.ace-solarized-light .ace_string {color: #2AA198}.ace-solarized-light .ace_string.ace_regexp {color: #D30102}.ace-solarized-light .ace_comment,.ace-solarized-light .ace_entity.ace_other.ace_attribute-name {color: #93A1A1}.ace-solarized-light .ace_indent-guide {background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAACCAYAAACZgbYnAAAAEklEQVQImWNgYGBgYHjy8NJ/AAjgA5fzQUmBAAAAAElFTkSuQmCC) right repeat-y}";var r=e("../lib/dom");r.importCssString(t.cssText,t.cssClass)}); (function() { + window.require(["ace/theme/solarized_light"], function(m) { + if (typeof module == "object" && typeof exports == "object" && module) { + module.exports = m; + } + }); + })(); + diff --git a/data/static/vendor/timeago.js b/data/static/vendor/timeago.js new file mode 100644 --- /dev/null +++ b/data/static/vendor/timeago.js @@ -0,0 +1,1 @@ +!function(t,e){"object"==typeof module&&module.exports?(module.exports=e(),module.exports.default=module.exports):t.timeago=e()}("undefined"!=typeof window?window:this,function(){function t(t){return t instanceof Date?t:isNaN(t)?/^\d+$/.test(t)?new Date(e(t)):(t=(t||"").trim().replace(/\.\d+/,"").replace(/-/,"/").replace(/-/,"/").replace(/(\d)T(\d)/,"$1 $2").replace(/Z/," UTC").replace(/([\+\-]\d\d)\:?(\d\d)/," $1$2"),new Date(t)):new Date(e(t))}function e(t){return parseInt(t)}function n(t,n,r){n=l[n]?n:l[r]?r:"en";for(var o=0,i=t<0?1:0,a=t=Math.abs(t);t>=p[o]&&o(0===o?9:1)&&(o+=1),l[n](t,o,a)[i].replace("%s",t)}function r(e,n){return((n=n?t(n):new Date)-t(e))/1e3}function o(t){for(var e=1,n=0,r=Math.abs(t);t>=p[n]&&n1&&(n+="s"),[t+" "+n+" ago","in "+t+" "+n]},zh_CN:function(t,e){if(0===e)return["刚刚","片刻后"];var n=s[parseInt(e/2)];return[t+n+"前",t+n+"后"]}},p=[60,60,24,7,365/7/12,12],h=6,m="data-tid",w={};return c.prototype.doRender=function(t,e,i){var a,c=r(e,this.nowDate),d=this;t.innerHTML=n(c,i,this.defaultLocale),w[a=setTimeout(function(){d.doRender(t,e,i),delete w[a]},Math.min(1e3*o(c),2147483647))]=0,u(t,a)},c.prototype.format=function(t,e){return n(r(t,this.nowDate),e,this.defaultLocale)},c.prototype.render=function(t,e){void 0===t.length&&(t=[t]);for(var n=0,r=t.length;n=e;t=++e)r+=9===t||14===t||19===t||24===t?"-":15===t?"4":20===t?(Math.floor(4*Math.random())+8).toString(16):Math.floor(15*Math.random()).toString(16);return r}}).call(this),function(){e.Location=function(){function t(t){var e,r;null==t&&(t=""),r=document.createElement("a"),r.href=t.toString(),this.absoluteURL=r.href,e=r.hash.length,2>e?this.requestURL=this.absoluteURL:(this.requestURL=this.absoluteURL.slice(0,-e),this.anchor=r.hash.slice(1))}var e,r,n,o;return t.wrap=function(t){return t instanceof this?t:new this(t)},t.prototype.getOrigin=function(){return this.absoluteURL.split("/",3).join("/")},t.prototype.getPath=function(){var t,e;return null!=(t=null!=(e=this.requestURL.match(/\/\/[^\/]*(\/[^?;]*)/))?e[1]:void 0)?t:"/"},t.prototype.getPathComponents=function(){return this.getPath().split("/").slice(1)},t.prototype.getLastPathComponent=function(){return this.getPathComponents().slice(-1)[0]},t.prototype.getExtension=function(){var t,e;return null!=(t=null!=(e=this.getLastPathComponent().match(/\.[^.]*$/))?e[0]:void 0)?t:""},t.prototype.isHTML=function(){return this.getExtension().match(/^(?:|\.(?:htm|html|xhtml))$/)},t.prototype.isPrefixedBy=function(t){var e;return e=r(t),this.isEqualTo(t)||o(this.absoluteURL,e)},t.prototype.isEqualTo=function(t){return this.absoluteURL===(null!=t?t.absoluteURL:void 0)},t.prototype.toCacheKey=function(){return this.requestURL},t.prototype.toJSON=function(){return this.absoluteURL},t.prototype.toString=function(){return this.absoluteURL},t.prototype.valueOf=function(){return this.absoluteURL},r=function(t){return e(t.getOrigin()+t.getPath())},e=function(t){return n(t,"/")?t:t+"/"},o=function(t,e){return t.slice(0,e.length)===e},n=function(t,e){return t.slice(-e.length)===e},t}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.HttpRequest=function(){function r(r,n,o){this.delegate=r,this.requestCanceled=t(this.requestCanceled,this),this.requestTimedOut=t(this.requestTimedOut,this),this.requestFailed=t(this.requestFailed,this),this.requestLoaded=t(this.requestLoaded,this),this.requestProgressed=t(this.requestProgressed,this),this.url=e.Location.wrap(n).requestURL,this.referrer=e.Location.wrap(o).absoluteURL,this.createXHR()}return r.NETWORK_FAILURE=0,r.TIMEOUT_FAILURE=-1,r.timeout=60,r.prototype.send=function(){var t;return this.xhr&&!this.sent?(this.notifyApplicationBeforeRequestStart(),this.setProgress(0),this.xhr.send(),this.sent=!0,"function"==typeof(t=this.delegate).requestStarted?t.requestStarted():void 0):void 0},r.prototype.cancel=function(){return this.xhr&&this.sent?this.xhr.abort():void 0},r.prototype.requestProgressed=function(t){return t.lengthComputable?this.setProgress(t.loaded/t.total):void 0},r.prototype.requestLoaded=function(){return this.endRequest(function(t){return function(){var e;return 200<=(e=t.xhr.status)&&300>e?t.delegate.requestCompletedWithResponse(t.xhr.responseText,t.xhr.getResponseHeader("Turbolinks-Location")):(t.failed=!0,t.delegate.requestFailedWithStatusCode(t.xhr.status,t.xhr.responseText))}}(this))},r.prototype.requestFailed=function(){return this.endRequest(function(t){return function(){return t.failed=!0,t.delegate.requestFailedWithStatusCode(t.constructor.NETWORK_FAILURE)}}(this))},r.prototype.requestTimedOut=function(){return this.endRequest(function(t){return function(){return t.failed=!0,t.delegate.requestFailedWithStatusCode(t.constructor.TIMEOUT_FAILURE)}}(this))},r.prototype.requestCanceled=function(){return this.endRequest()},r.prototype.notifyApplicationBeforeRequestStart=function(){return e.dispatch("turbolinks:request-start",{data:{url:this.url,xhr:this.xhr}})},r.prototype.notifyApplicationAfterRequestEnd=function(){return e.dispatch("turbolinks:request-end",{data:{url:this.url,xhr:this.xhr}})},r.prototype.createXHR=function(){return this.xhr=new XMLHttpRequest,this.xhr.open("GET",this.url,!0),this.xhr.timeout=1e3*this.constructor.timeout,this.xhr.setRequestHeader("Accept","text/html, application/xhtml+xml"),this.xhr.setRequestHeader("Turbolinks-Referrer",this.referrer),this.xhr.onprogress=this.requestProgressed,this.xhr.onload=this.requestLoaded,this.xhr.onerror=this.requestFailed,this.xhr.ontimeout=this.requestTimedOut,this.xhr.onabort=this.requestCanceled},r.prototype.endRequest=function(t){return this.xhr?(this.notifyApplicationAfterRequestEnd(),null!=t&&t.call(this),this.destroy()):void 0},r.prototype.setProgress=function(t){var e;return this.progress=t,"function"==typeof(e=this.delegate).requestProgressed?e.requestProgressed(this.progress):void 0},r.prototype.destroy=function(){var t;return this.setProgress(1),"function"==typeof(t=this.delegate).requestFinished&&t.requestFinished(),this.delegate=null,this.xhr=null},r}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.ProgressBar=function(){function e(){this.trickle=t(this.trickle,this),this.stylesheetElement=this.createStylesheetElement(),this.progressElement=this.createProgressElement()}var r;return r=300,e.defaultCSS=".turbolinks-progress-bar {\n position: fixed;\n display: block;\n top: 0;\n left: 0;\n height: 3px;\n background: #0076ff;\n z-index: 9999;\n transition: width "+r+"ms ease-out, opacity "+r/2+"ms "+r/2+"ms ease-in;\n transform: translate3d(0, 0, 0);\n}",e.prototype.show=function(){return this.visible?void 0:(this.visible=!0,this.installStylesheetElement(),this.installProgressElement(),this.startTrickling())},e.prototype.hide=function(){return this.visible&&!this.hiding?(this.hiding=!0,this.fadeProgressElement(function(t){return function(){return t.uninstallProgressElement(),t.stopTrickling(),t.visible=!1,t.hiding=!1}}(this))):void 0},e.prototype.setValue=function(t){return this.value=t,this.refresh()},e.prototype.installStylesheetElement=function(){return document.head.insertBefore(this.stylesheetElement,document.head.firstChild)},e.prototype.installProgressElement=function(){return this.progressElement.style.width=0,this.progressElement.style.opacity=1,document.documentElement.insertBefore(this.progressElement,document.body),this.refresh()},e.prototype.fadeProgressElement=function(t){return this.progressElement.style.opacity=0,setTimeout(t,1.5*r)},e.prototype.uninstallProgressElement=function(){return this.progressElement.parentNode?document.documentElement.removeChild(this.progressElement):void 0},e.prototype.startTrickling=function(){return null!=this.trickleInterval?this.trickleInterval:this.trickleInterval=setInterval(this.trickle,r)},e.prototype.stopTrickling=function(){return clearInterval(this.trickleInterval),this.trickleInterval=null},e.prototype.trickle=function(){return this.setValue(this.value+Math.random()/100)},e.prototype.refresh=function(){return requestAnimationFrame(function(t){return function(){return t.progressElement.style.width=10+90*t.value+"%"}}(this))},e.prototype.createStylesheetElement=function(){var t;return t=document.createElement("style"),t.type="text/css",t.textContent=this.constructor.defaultCSS,t},e.prototype.createProgressElement=function(){var t;return t=document.createElement("div"),t.className="turbolinks-progress-bar",t},e}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.BrowserAdapter=function(){function r(r){this.controller=r,this.showProgressBar=t(this.showProgressBar,this),this.progressBar=new e.ProgressBar}var n,o,i;return i=e.HttpRequest,n=i.NETWORK_FAILURE,o=i.TIMEOUT_FAILURE,r.prototype.visitProposedToLocationWithAction=function(t,e){return this.controller.startVisitToLocationWithAction(t,e)},r.prototype.visitStarted=function(t){return t.issueRequest(),t.changeHistory(),t.loadCachedSnapshot()},r.prototype.visitRequestStarted=function(t){return this.progressBar.setValue(0),t.hasCachedSnapshot()||"restore"!==t.action?this.showProgressBarAfterDelay():this.showProgressBar()},r.prototype.visitRequestProgressed=function(t){return this.progressBar.setValue(t.progress)},r.prototype.visitRequestCompleted=function(t){return t.loadResponse()},r.prototype.visitRequestFailedWithStatusCode=function(t,e){switch(e){case n:case o:return this.reload();default:return t.loadResponse()}},r.prototype.visitRequestFinished=function(t){return this.hideProgressBar()},r.prototype.visitCompleted=function(t){return t.followRedirect()},r.prototype.pageInvalidated=function(){return this.reload()},r.prototype.showProgressBarAfterDelay=function(){return this.progressBarTimeout=setTimeout(this.showProgressBar,this.controller.progressBarDelay)},r.prototype.showProgressBar=function(){return this.progressBar.show()},r.prototype.hideProgressBar=function(){return this.progressBar.hide(),clearTimeout(this.progressBarTimeout)},r.prototype.reload=function(){return window.location.reload()},r}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.History=function(){function r(e){this.delegate=e,this.onPageLoad=t(this.onPageLoad,this),this.onPopState=t(this.onPopState,this)}return r.prototype.start=function(){return this.started?void 0:(addEventListener("popstate",this.onPopState,!1),addEventListener("load",this.onPageLoad,!1),this.started=!0)},r.prototype.stop=function(){return this.started?(removeEventListener("popstate",this.onPopState,!1),removeEventListener("load",this.onPageLoad,!1),this.started=!1):void 0},r.prototype.push=function(t,r){return t=e.Location.wrap(t),this.update("push",t,r)},r.prototype.replace=function(t,r){return t=e.Location.wrap(t),this.update("replace",t,r)},r.prototype.onPopState=function(t){var r,n,o,i;return this.shouldHandlePopState()&&(i=null!=(n=t.state)?n.turbolinks:void 0)?(r=e.Location.wrap(window.location),o=i.restorationIdentifier,this.delegate.historyPoppedToLocationWithRestorationIdentifier(r,o)):void 0},r.prototype.onPageLoad=function(t){return e.defer(function(t){return function(){return t.pageLoaded=!0}}(this))},r.prototype.shouldHandlePopState=function(){return this.pageIsLoaded()},r.prototype.pageIsLoaded=function(){return this.pageLoaded||"complete"===document.readyState},r.prototype.update=function(t,e,r){var n;return n={turbolinks:{restorationIdentifier:r}},history[t+"State"](n,null,e)},r}()}.call(this),function(){e.Snapshot=function(){function t(t){var e,r;r=t.head,e=t.body,this.head=null!=r?r:document.createElement("head"),this.body=null!=e?e:document.createElement("body")}return t.wrap=function(t){return t instanceof this?t:this.fromHTML(t)},t.fromHTML=function(t){var e;return e=document.createElement("html"),e.innerHTML=t,this.fromElement(e)},t.fromElement=function(t){return new this({head:t.querySelector("head"),body:t.querySelector("body")})},t.prototype.clone=function(){return new t({head:this.head.cloneNode(!0),body:this.body.cloneNode(!0)})},t.prototype.getRootLocation=function(){var t,r;return r=null!=(t=this.getSetting("root"))?t:"/",new e.Location(r)},t.prototype.getCacheControlValue=function(){return this.getSetting("cache-control")},t.prototype.getElementForAnchor=function(t){try{return this.body.querySelector("[id='"+t+"'], a[name='"+t+"']")}catch(e){}},t.prototype.hasAnchor=function(t){return null!=this.getElementForAnchor(t)},t.prototype.isPreviewable=function(){return"no-preview"!==this.getCacheControlValue()},t.prototype.isCacheable=function(){return"no-cache"!==this.getCacheControlValue()},t.prototype.isVisitable=function(){return"reload"!==this.getSetting("visit-control")},t.prototype.getSetting=function(t){var e,r;return r=this.head.querySelectorAll("meta[name='turbolinks-"+t+"']"),e=r[r.length-1],null!=e?e.getAttribute("content"):void 0},t}()}.call(this),function(){var t=[].slice;e.Renderer=function(){function e(){}var r;return e.render=function(){var e,r,n,o;return n=arguments[0],r=arguments[1],e=3<=arguments.length?t.call(arguments,2):[],o=function(t,e,r){r.prototype=t.prototype;var n=new r,o=t.apply(n,e);return Object(o)===o?o:n}(this,e,function(){}),o.delegate=n,o.render(r),o},e.prototype.renderView=function(t){return this.delegate.viewWillRender(this.newBody),t(),this.delegate.viewRendered(this.newBody)},e.prototype.invalidateView=function(){return this.delegate.viewInvalidated()},e.prototype.createScriptElement=function(t){var e;return"false"===t.getAttribute("data-turbolinks-eval")?t:(e=document.createElement("script"),e.textContent=t.textContent,e.async=!1,r(e,t),e)},r=function(t,e){var r,n,o,i,s,a,u;for(i=e.attributes,a=[],r=0,n=i.length;n>r;r++)s=i[r],o=s.name,u=s.value,a.push(t.setAttribute(o,u));return a},e}()}.call(this),function(){e.HeadDetails=function(){function t(t){var e,r,i,s,a,u,l;for(this.element=t,this.elements={},l=this.element.childNodes,s=0,u=l.length;u>s;s++)i=l[s],i.nodeType===Node.ELEMENT_NODE&&(a=i.outerHTML,r=null!=(e=this.elements)[a]?e[a]:e[a]={type:o(i),tracked:n(i),elements:[]},r.elements.push(i))}var e,r,n,o;return t.prototype.hasElementWithKey=function(t){return t in this.elements},t.prototype.getTrackedElementSignature=function(){var t,e;return function(){var r,n;r=this.elements,n=[];for(t in r)e=r[t].tracked,e&&n.push(t);return n}.call(this).join("")},t.prototype.getScriptElementsNotInDetails=function(t){return this.getElementsMatchingTypeNotInDetails("script",t)},t.prototype.getStylesheetElementsNotInDetails=function(t){return this.getElementsMatchingTypeNotInDetails("stylesheet",t)},t.prototype.getElementsMatchingTypeNotInDetails=function(t,e){var r,n,o,i,s,a;o=this.elements,s=[];for(n in o)i=o[n],a=i.type,r=i.elements,a!==t||e.hasElementWithKey(n)||s.push(r[0]);return s},t.prototype.getProvisionalElements=function(){var t,e,r,n,o,i,s;r=[],n=this.elements;for(e in n)o=n[e],s=o.type,i=o.tracked,t=o.elements,null!=s||i?t.length>1&&r.push.apply(r,t.slice(1)):r.push.apply(r,t);return r},o=function(t){return e(t)?"script":r(t)?"stylesheet":void 0},n=function(t){return"reload"===t.getAttribute("data-turbolinks-track")},e=function(t){var e;return e=t.tagName.toLowerCase(),"script"===e},r=function(t){var e;return e=t.tagName.toLowerCase(),"style"===e||"link"===e&&"stylesheet"===t.getAttribute("rel")},t}()}.call(this),function(){var t=function(t,e){function n(){this.constructor=t}for(var o in e)r.call(e,o)&&(t[o]=e[o]);return n.prototype=e.prototype,t.prototype=new n,t.__super__=e.prototype,t},r={}.hasOwnProperty;e.SnapshotRenderer=function(r){function n(t,r,n){this.currentSnapshot=t,this.newSnapshot=r,this.isPreview=n,this.currentHeadDetails=new e.HeadDetails(this.currentSnapshot.head),this.newHeadDetails=new e.HeadDetails(this.newSnapshot.head),this.newBody=this.newSnapshot.body}return t(n,r),n.prototype.render=function(t){return this.shouldRender()?(this.mergeHead(),this.renderView(function(e){return function(){return e.replaceBody(),e.isPreview||e.focusFirstAutofocusableElement(),t()}}(this))):this.invalidateView()},n.prototype.mergeHead=function(){return this.copyNewHeadStylesheetElements(),this.copyNewHeadScriptElements(),this.removeCurrentHeadProvisionalElements(),this.copyNewHeadProvisionalElements()},n.prototype.replaceBody=function(){return this.activateBodyScriptElements(),this.importBodyPermanentElements(),this.assignNewBody()},n.prototype.shouldRender=function(){return this.newSnapshot.isVisitable()&&this.trackedElementsAreIdentical()},n.prototype.trackedElementsAreIdentical=function(){return this.currentHeadDetails.getTrackedElementSignature()===this.newHeadDetails.getTrackedElementSignature()},n.prototype.copyNewHeadStylesheetElements=function(){var t,e,r,n,o;for(n=this.getNewHeadStylesheetElements(),o=[],e=0,r=n.length;r>e;e++)t=n[e],o.push(document.head.appendChild(t));return o},n.prototype.copyNewHeadScriptElements=function(){var t,e,r,n,o;for(n=this.getNewHeadScriptElements(),o=[],e=0,r=n.length;r>e;e++)t=n[e],o.push(document.head.appendChild(this.createScriptElement(t)));return o},n.prototype.removeCurrentHeadProvisionalElements=function(){var t,e,r,n,o;for(n=this.getCurrentHeadProvisionalElements(),o=[],e=0,r=n.length;r>e;e++)t=n[e],o.push(document.head.removeChild(t));return o},n.prototype.copyNewHeadProvisionalElements=function(){var t,e,r,n,o;for(n=this.getNewHeadProvisionalElements(),o=[],e=0,r=n.length;r>e;e++)t=n[e],o.push(document.head.appendChild(t));return o},n.prototype.importBodyPermanentElements=function(){var t,e,r,n,o,i;for(n=this.getNewBodyPermanentElements(),i=[],e=0,r=n.length;r>e;e++)o=n[e],(t=this.findCurrentBodyPermanentElement(o))?i.push(o.parentNode.replaceChild(t,o)):i.push(void 0);return i},n.prototype.activateBodyScriptElements=function(){var t,e,r,n,o,i;for(n=this.getNewBodyScriptElements(),i=[],e=0,r=n.length;r>e;e++)o=n[e],t=this.createScriptElement(o),i.push(o.parentNode.replaceChild(t,o));return i},n.prototype.assignNewBody=function(){return document.body=this.newBody},n.prototype.focusFirstAutofocusableElement=function(){var t;return null!=(t=this.findFirstAutofocusableElement())?t.focus():void 0},n.prototype.getNewHeadStylesheetElements=function(){return this.newHeadDetails.getStylesheetElementsNotInDetails(this.currentHeadDetails)},n.prototype.getNewHeadScriptElements=function(){return this.newHeadDetails.getScriptElementsNotInDetails(this.currentHeadDetails)},n.prototype.getCurrentHeadProvisionalElements=function(){return this.currentHeadDetails.getProvisionalElements()},n.prototype.getNewHeadProvisionalElements=function(){return this.newHeadDetails.getProvisionalElements()},n.prototype.getNewBodyPermanentElements=function(){return this.newBody.querySelectorAll("[id][data-turbolinks-permanent]")},n.prototype.findCurrentBodyPermanentElement=function(t){return document.body.querySelector("#"+t.id+"[data-turbolinks-permanent]")},n.prototype.getNewBodyScriptElements=function(){return this.newBody.querySelectorAll("script")},n.prototype.findFirstAutofocusableElement=function(){return document.body.querySelector("[autofocus]")},n}(e.Renderer)}.call(this),function(){var t=function(t,e){function n(){this.constructor=t}for(var o in e)r.call(e,o)&&(t[o]=e[o]);return n.prototype=e.prototype,t.prototype=new n,t.__super__=e.prototype,t},r={}.hasOwnProperty;e.ErrorRenderer=function(e){function r(t){this.html=t}return t(r,e),r.prototype.render=function(t){return this.renderView(function(e){return function(){return e.replaceDocumentHTML(),e.activateBodyScriptElements(),t()}}(this))},r.prototype.replaceDocumentHTML=function(){return document.documentElement.innerHTML=this.html},r.prototype.activateBodyScriptElements=function(){var t,e,r,n,o,i;for(n=this.getScriptElements(),i=[],e=0,r=n.length;r>e;e++)o=n[e],t=this.createScriptElement(o),i.push(o.parentNode.replaceChild(t,o));return i},r.prototype.getScriptElements=function(){return document.documentElement.querySelectorAll("script")},r}(e.Renderer)}.call(this),function(){e.View=function(){function t(t){this.delegate=t,this.element=document.documentElement}return t.prototype.getRootLocation=function(){return this.getSnapshot().getRootLocation()},t.prototype.getElementForAnchor=function(t){return this.getSnapshot().getElementForAnchor(t)},t.prototype.getSnapshot=function(){return e.Snapshot.fromElement(this.element)},t.prototype.render=function(t,e){var r,n,o;return o=t.snapshot,r=t.error,n=t.isPreview,this.markAsPreview(n),null!=o?this.renderSnapshot(o,n,e):this.renderError(r,e)},t.prototype.markAsPreview=function(t){return t?this.element.setAttribute("data-turbolinks-preview",""):this.element.removeAttribute("data-turbolinks-preview")},t.prototype.renderSnapshot=function(t,r,n){return e.SnapshotRenderer.render(this.delegate,n,this.getSnapshot(),e.Snapshot.wrap(t),r)},t.prototype.renderError=function(t,r){return e.ErrorRenderer.render(this.delegate,r,t)},t}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.ScrollManager=function(){function r(r){this.delegate=r,this.onScroll=t(this.onScroll,this),this.onScroll=e.throttle(this.onScroll)}return r.prototype.start=function(){return this.started?void 0:(addEventListener("scroll",this.onScroll,!1),this.onScroll(),this.started=!0)},r.prototype.stop=function(){return this.started?(removeEventListener("scroll",this.onScroll,!1),this.started=!1):void 0},r.prototype.scrollToElement=function(t){return t.scrollIntoView()},r.prototype.scrollToPosition=function(t){var e,r;return e=t.x,r=t.y,window.scrollTo(e,r)},r.prototype.onScroll=function(t){return this.updatePosition({x:window.pageXOffset,y:window.pageYOffset})},r.prototype.updatePosition=function(t){var e;return this.position=t,null!=(e=this.delegate)?e.scrollPositionChanged(this.position):void 0},r}()}.call(this),function(){e.SnapshotCache=function(){function t(t){this.size=t,this.keys=[],this.snapshots={}}var r;return t.prototype.has=function(t){var e;return e=r(t),e in this.snapshots},t.prototype.get=function(t){var e;if(this.has(t))return e=this.read(t),this.touch(t),e},t.prototype.put=function(t,e){return this.write(t,e),this.touch(t),e},t.prototype.read=function(t){var e;return e=r(t),this.snapshots[e]},t.prototype.write=function(t,e){var n;return n=r(t),this.snapshots[n]=e},t.prototype.touch=function(t){var e,n;return n=r(t),e=this.keys.indexOf(n),e>-1&&this.keys.splice(e,1),this.keys.unshift(n),this.trim()},t.prototype.trim=function(){var t,e,r,n,o;for(n=this.keys.splice(this.size),o=[],t=0,r=n.length;r>t;t++)e=n[t],o.push(delete this.snapshots[e]);return o},r=function(t){return e.Location.wrap(t).toCacheKey()},t}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.Visit=function(){function r(r,n,o){this.controller=r,this.action=o,this.performScroll=t(this.performScroll,this),this.identifier=e.uuid(),this.location=e.Location.wrap(n),this.adapter=this.controller.adapter,this.state="initialized",this.timingMetrics={}}var n;return r.prototype.start=function(){return"initialized"===this.state?(this.recordTimingMetric("visitStart"),this.state="started",this.adapter.visitStarted(this)):void 0},r.prototype.cancel=function(){var t;return"started"===this.state?(null!=(t=this.request)&&t.cancel(),this.cancelRender(),this.state="canceled"):void 0},r.prototype.complete=function(){var t;return"started"===this.state?(this.recordTimingMetric("visitEnd"),this.state="completed","function"==typeof(t=this.adapter).visitCompleted&&t.visitCompleted(this),this.controller.visitCompleted(this)):void 0},r.prototype.fail=function(){var t;return"started"===this.state?(this.state="failed","function"==typeof(t=this.adapter).visitFailed?t.visitFailed(this):void 0):void 0},r.prototype.changeHistory=function(){var t,e;return this.historyChanged?void 0:(t=this.location.isEqualTo(this.referrer)?"replace":this.action,e=n(t),this.controller[e](this.location,this.restorationIdentifier),this.historyChanged=!0)},r.prototype.issueRequest=function(){return this.shouldIssueRequest()&&null==this.request?(this.progress=0,this.request=new e.HttpRequest(this,this.location,this.referrer),this.request.send()):void 0},r.prototype.getCachedSnapshot=function(){var t;return!(t=this.controller.getCachedSnapshotForLocation(this.location))||null!=this.location.anchor&&!t.hasAnchor(this.location.anchor)||"restore"!==this.action&&!t.isPreviewable()?void 0:t},r.prototype.hasCachedSnapshot=function(){return null!=this.getCachedSnapshot()},r.prototype.loadCachedSnapshot=function(){var t,e;return(e=this.getCachedSnapshot())?(t=this.shouldIssueRequest(),this.render(function(){var r;return this.cacheSnapshot(),this.controller.render({snapshot:e,isPreview:t},this.performScroll),"function"==typeof(r=this.adapter).visitRendered&&r.visitRendered(this),t?void 0:this.complete()})):void 0},r.prototype.loadResponse=function(){return null!=this.response?this.render(function(){var t,e;return this.cacheSnapshot(),this.request.failed?(this.controller.render({error:this.response},this.performScroll),"function"==typeof(t=this.adapter).visitRendered&&t.visitRendered(this),this.fail()):(this.controller.render({snapshot:this.response},this.performScroll),"function"==typeof(e=this.adapter).visitRendered&&e.visitRendered(this),this.complete())}):void 0},r.prototype.followRedirect=function(){return this.redirectedToLocation&&!this.followedRedirect?(this.location=this.redirectedToLocation,this.controller.replaceHistoryWithLocationAndRestorationIdentifier(this.redirectedToLocation,this.restorationIdentifier),this.followedRedirect=!0):void 0},r.prototype.requestStarted=function(){var t;return this.recordTimingMetric("requestStart"),"function"==typeof(t=this.adapter).visitRequestStarted?t.visitRequestStarted(this):void 0},r.prototype.requestProgressed=function(t){var e;return this.progress=t,"function"==typeof(e=this.adapter).visitRequestProgressed?e.visitRequestProgressed(this):void 0},r.prototype.requestCompletedWithResponse=function(t,r){return this.response=t,null!=r&&(this.redirectedToLocation=e.Location.wrap(r)),this.adapter.visitRequestCompleted(this)},r.prototype.requestFailedWithStatusCode=function(t,e){return this.response=e,this.adapter.visitRequestFailedWithStatusCode(this,t)},r.prototype.requestFinished=function(){var t;return this.recordTimingMetric("requestEnd"),"function"==typeof(t=this.adapter).visitRequestFinished?t.visitRequestFinished(this):void 0},r.prototype.performScroll=function(){return this.scrolled?void 0:("restore"===this.action?this.scrollToRestoredPosition()||this.scrollToTop():this.scrollToAnchor()||this.scrollToTop(),this.scrolled=!0)},r.prototype.scrollToRestoredPosition=function(){var t,e;return t=null!=(e=this.restorationData)?e.scrollPosition:void 0,null!=t?(this.controller.scrollToPosition(t),!0):void 0},r.prototype.scrollToAnchor=function(){return null!=this.location.anchor?(this.controller.scrollToAnchor(this.location.anchor),!0):void 0},r.prototype.scrollToTop=function(){return this.controller.scrollToPosition({x:0,y:0})},r.prototype.recordTimingMetric=function(t){var e;return null!=(e=this.timingMetrics)[t]?e[t]:e[t]=(new Date).getTime()},r.prototype.getTimingMetrics=function(){return e.copyObject(this.timingMetrics)},n=function(t){switch(t){case"replace":return"replaceHistoryWithLocationAndRestorationIdentifier";case"advance":case"restore":return"pushHistoryWithLocationAndRestorationIdentifier"}},r.prototype.shouldIssueRequest=function(){return"restore"===this.action?!this.hasCachedSnapshot():!0},r.prototype.cacheSnapshot=function(){return this.snapshotCached?void 0:(this.controller.cacheSnapshot(),this.snapshotCached=!0)},r.prototype.render=function(t){return this.cancelRender(),this.frame=requestAnimationFrame(function(e){return function(){return e.frame=null,t.call(e)}}(this))},r.prototype.cancelRender=function(){return this.frame?cancelAnimationFrame(this.frame):void 0},r}()}.call(this),function(){var t=function(t,e){return function(){return t.apply(e,arguments)}};e.Controller=function(){function r(){this.clickBubbled=t(this.clickBubbled,this),this.clickCaptured=t(this.clickCaptured,this),this.pageLoaded=t(this.pageLoaded,this),this.history=new e.History(this),this.view=new e.View(this),this.scrollManager=new e.ScrollManager(this),this.restorationData={},this.clearCache(),this.setProgressBarDelay(500)}return r.prototype.start=function(){return e.supported&&!this.started?(addEventListener("click",this.clickCaptured,!0),addEventListener("DOMContentLoaded",this.pageLoaded,!1),this.scrollManager.start(),this.startHistory(),this.started=!0,this.enabled=!0):void 0},r.prototype.disable=function(){return this.enabled=!1},r.prototype.stop=function(){return this.started?(removeEventListener("click",this.clickCaptured,!0),removeEventListener("DOMContentLoaded",this.pageLoaded,!1),this.scrollManager.stop(),this.stopHistory(),this.started=!1):void 0},r.prototype.clearCache=function(){return this.cache=new e.SnapshotCache(10)},r.prototype.visit=function(t,r){var n,o;return null==r&&(r={}),t=e.Location.wrap(t),this.applicationAllowsVisitingLocation(t)?this.locationIsVisitable(t)?(n=null!=(o=r.action)?o:"advance",this.adapter.visitProposedToLocationWithAction(t,n)):window.location=t:void 0},r.prototype.startVisitToLocationWithAction=function(t,r,n){var o;return e.supported?(o=this.getRestorationDataForIdentifier(n),this.startVisit(t,r,{restorationData:o})):window.location=t},r.prototype.setProgressBarDelay=function(t){return this.progressBarDelay=t},r.prototype.startHistory=function(){return this.location=e.Location.wrap(window.location),this.restorationIdentifier=e.uuid(),this.history.start(),this.history.replace(this.location,this.restorationIdentifier)},r.prototype.stopHistory=function(){return this.history.stop()},r.prototype.pushHistoryWithLocationAndRestorationIdentifier=function(t,r){return this.restorationIdentifier=r,this.location=e.Location.wrap(t),this.history.push(this.location,this.restorationIdentifier)},r.prototype.replaceHistoryWithLocationAndRestorationIdentifier=function(t,r){return this.restorationIdentifier=r,this.location=e.Location.wrap(t),this.history.replace(this.location,this.restorationIdentifier)},r.prototype.historyPoppedToLocationWithRestorationIdentifier=function(t,r){var n;return this.restorationIdentifier=r,this.enabled?(n=this.getRestorationDataForIdentifier(this.restorationIdentifier),this.startVisit(t,"restore",{restorationIdentifier:this.restorationIdentifier,restorationData:n,historyChanged:!0}),this.location=e.Location.wrap(t)):this.adapter.pageInvalidated()},r.prototype.getCachedSnapshotForLocation=function(t){var e;return e=this.cache.get(t),e?e.clone():void 0},r.prototype.shouldCacheSnapshot=function(){return this.view.getSnapshot().isCacheable()},r.prototype.cacheSnapshot=function(){var t;return this.shouldCacheSnapshot()?(this.notifyApplicationBeforeCachingSnapshot(),t=this.view.getSnapshot(),this.cache.put(this.lastRenderedLocation,t.clone())):void 0},r.prototype.scrollToAnchor=function(t){var e;return(e=this.view.getElementForAnchor(t))?this.scrollToElement(e):this.scrollToPosition({x:0,y:0})},r.prototype.scrollToElement=function(t){return this.scrollManager.scrollToElement(t)},r.prototype.scrollToPosition=function(t){return this.scrollManager.scrollToPosition(t)},r.prototype.scrollPositionChanged=function(t){var e;return e=this.getCurrentRestorationData(),e.scrollPosition=t},r.prototype.render=function(t,e){return this.view.render(t,e)},r.prototype.viewInvalidated=function(){return this.adapter.pageInvalidated()},r.prototype.viewWillRender=function(t){return this.notifyApplicationBeforeRender(t)},r.prototype.viewRendered=function(){return this.lastRenderedLocation=this.currentVisit.location,this.notifyApplicationAfterRender()},r.prototype.pageLoaded=function(){return this.lastRenderedLocation=this.location,this.notifyApplicationAfterPageLoad()},r.prototype.clickCaptured=function(){return removeEventListener("click",this.clickBubbled,!1),addEventListener("click",this.clickBubbled,!1)},r.prototype.clickBubbled=function(t){var e,r,n;return this.enabled&&this.clickEventIsSignificant(t)&&(r=this.getVisitableLinkForNode(t.target))&&(n=this.getVisitableLocationForLink(r))&&this.applicationAllowsFollowingLinkToLocation(r,n)?(t.preventDefault(),e=this.getActionForLink(r), +this.visit(n,{action:e})):void 0},r.prototype.applicationAllowsFollowingLinkToLocation=function(t,e){var r;return r=this.notifyApplicationAfterClickingLinkToLocation(t,e),!r.defaultPrevented},r.prototype.applicationAllowsVisitingLocation=function(t){var e;return e=this.notifyApplicationBeforeVisitingLocation(t),!e.defaultPrevented},r.prototype.notifyApplicationAfterClickingLinkToLocation=function(t,r){return e.dispatch("turbolinks:click",{target:t,data:{url:r.absoluteURL},cancelable:!0})},r.prototype.notifyApplicationBeforeVisitingLocation=function(t){return e.dispatch("turbolinks:before-visit",{data:{url:t.absoluteURL},cancelable:!0})},r.prototype.notifyApplicationAfterVisitingLocation=function(t){return e.dispatch("turbolinks:visit",{data:{url:t.absoluteURL}})},r.prototype.notifyApplicationBeforeCachingSnapshot=function(){return e.dispatch("turbolinks:before-cache")},r.prototype.notifyApplicationBeforeRender=function(t){return e.dispatch("turbolinks:before-render",{data:{newBody:t}})},r.prototype.notifyApplicationAfterRender=function(){return e.dispatch("turbolinks:render")},r.prototype.notifyApplicationAfterPageLoad=function(t){return null==t&&(t={}),e.dispatch("turbolinks:load",{data:{url:this.location.absoluteURL,timing:t}})},r.prototype.startVisit=function(t,e,r){var n;return null!=(n=this.currentVisit)&&n.cancel(),this.currentVisit=this.createVisit(t,e,r),this.currentVisit.start(),this.notifyApplicationAfterVisitingLocation(t)},r.prototype.createVisit=function(t,r,n){var o,i,s,a,u;return i=null!=n?n:{},a=i.restorationIdentifier,s=i.restorationData,o=i.historyChanged,u=new e.Visit(this,t,r),u.restorationIdentifier=null!=a?a:e.uuid(),u.restorationData=e.copyObject(s),u.historyChanged=o,u.referrer=this.location,u},r.prototype.visitCompleted=function(t){return this.notifyApplicationAfterPageLoad(t.getTimingMetrics())},r.prototype.clickEventIsSignificant=function(t){return!(t.defaultPrevented||t.target.isContentEditable||t.which>1||t.altKey||t.ctrlKey||t.metaKey||t.shiftKey)},r.prototype.getVisitableLinkForNode=function(t){return this.nodeIsVisitable(t)?e.closest(t,"a[href]:not([target]):not([download])"):void 0},r.prototype.getVisitableLocationForLink=function(t){var r;return r=new e.Location(t.getAttribute("href")),this.locationIsVisitable(r)?r:void 0},r.prototype.getActionForLink=function(t){var e;return null!=(e=t.getAttribute("data-turbolinks-action"))?e:"advance"},r.prototype.nodeIsVisitable=function(t){var r;return(r=e.closest(t,"[data-turbolinks]"))?"false"!==r.getAttribute("data-turbolinks"):!0},r.prototype.locationIsVisitable=function(t){return t.isPrefixedBy(this.view.getRootLocation())&&t.isHTML()},r.prototype.getCurrentRestorationData=function(){return this.getRestorationDataForIdentifier(this.restorationIdentifier)},r.prototype.getRestorationDataForIdentifier=function(t){var e;return null!=(e=this.restorationData)[t]?e[t]:e[t]={}},r}()}.call(this),function(){!function(){var t,e;if((t=e=document.currentScript)&&!e.hasAttribute("data-turbolinks-suppress-warning"))for(;t=t.parentNode;)if(t===document.body)return console.warn("You are loading Turbolinks from a