packages feed

space (empty) → 0.1.0

raw patch · 10 files changed

+551/−0 lines, 10 filesdep +aesondep +attoparsecdep +basesetup-changed

Dependencies added: aeson, attoparsec, base, base64-bytestring, bytestring, cryptonite, directory, http-date, http-types, lucid, memory, network, space, stm, template-haskell, text, unix, wai, warp

Files

+ LICENSE view
@@ -0,0 +1,200 @@+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright [yyyy] [name of copyright owner]++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.
+ README.md view
@@ -0,0 +1,5 @@+# WARNING++An experimental simple web framework.++Everything, including the name of this project, is under construction. They are likely to change.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ space.cabal view
@@ -0,0 +1,69 @@+-- This file has been generated from package.yaml by hpack version 0.17.1.+--+-- see: https://github.com/sol/hpack++name:           space+version:        0.1.0+synopsis:       Experimental library+description:    Please see README.md+category:       Web+homepage:       https://github.com/xtendo-org/space#readme+bug-reports:    https://github.com/xtendo-org/space/issues+author:         XT+maintainer:     e@xtendo.org+copyright:      2017 XT+license:        Apache-2.0+license-file:   LICENSE+build-type:     Simple+cabal-version:  >= 1.10++extra-source-files:+    README.md++source-repository head+  type: git+  location: https://github.com/xtendo-org/space++library+  hs-source-dirs:+      src+  default-extensions: OverloadedStrings+  build-depends:+      aeson+    , attoparsec+    , bytestring+    , base64-bytestring+    , cryptonite+    , directory+    , http-date+    , http-types+    , lucid+    , memory+    , network+    , stm+    , template-haskell+    , text+    , unix+    , wai+    , warp+    , base >=4.7 && <5+  exposed-modules:+      Space.Server+      Space.View+  other-modules:+      Space.Import+      Space.ModifiedTime+      Space.UnixSocket+      Paths_space+  default-language: Haskell2010++test-suite space-test+  type: exitcode-stdio-1.0+  main-is: Spec.hs+  hs-source-dirs:+      test+  ghc-options: -threaded -rtsopts -with-rtsopts=-N+  build-depends:+      base+    , space+  default-language: Haskell2010
+ src/Space/Import.hs view
@@ -0,0 +1,36 @@+-- The import statements that are used so often that it's better to have a+-- module for importing all of them. Including the data types (ByteString,+-- Text, etc.) and the harmless base modules (Control.Monad, System.IO, etc.).+-- Intended to be imported globally across all modules.++module Space.Import+    ( module Module+    , Builder+    , ByteString+    , Text+    ) where++-- base modules++import Data.Char as Module+import Data.Either as Module+import Data.Foldable as Module+import Data.Int as Module+import Data.List as Module+import Data.Maybe as Module+import Data.Monoid as Module+import Data.Word as Module+import Control.Applicative as Module+import Control.Monad as Module+import Control.Exception as Module+import System.Exit as Module+import System.IO as Module+import System.IO.Error as Module++-- extra data types++import Data.ByteString (ByteString)+import Data.ByteString.Builder (Builder)+import Data.Text (Text)+import Control.Concurrent.STM as Module+-- import Time.Types as Module
+ src/Space/ModifiedTime.hs view
@@ -0,0 +1,33 @@+module Space.ModifiedTime+    ( Modified(..)+    , EpochTime+    , getMTime+    , formattedMTime+    , modifiedSince+    ) where++import Data.ByteString (ByteString)+import System.Posix.Types (EpochTime)+import System.Posix.Files.ByteString+import Network.HTTP.Types+import Network.HTTP.Date+import Network.Wai (Request, requestHeaders)++data Modified = NotModified | Modified++getMTime :: ByteString -> IO EpochTime+getMTime = fmap modificationTime . getFileStatus++formattedMTime :: EpochTime -> ByteString+formattedMTime = formatHTTPDate . epochTimeToHTTPDate++modifiedSince :: Request -> EpochTime -> Modified+modifiedSince req mtime = case since of+    Nothing -> Modified+    Just rawReqTime -> case parseHTTPDate rawReqTime of+        Nothing -> Modified+        Just reqTime -> if reqTime < epochTimeToHTTPDate mtime+            then Modified+            else NotModified+  where+    since = lookup hIfModifiedSince (requestHeaders req)
+ src/Space/Server.hs view
@@ -0,0 +1,122 @@+module Space.Server+    ( run+    , OpenAt(..)+    , parseOpenAt+    ) where++import Space.Import++import qualified Data.ByteString.Char8 as B++import Text.Read (readMaybe)++import Network.HTTP.Types+import qualified Network.Wai as Wai+import qualified Network.Wai.Handler.Warp as Warp++import Space.UnixSocket+import Space.ModifiedTime++-- OpenAt configuration++data OpenAt+    = OpenAtPort Warp.Port+    | OpenAtUnixSocket FilePath++parseOpenAt :: String -> OpenAt+parseOpenAt s = case readMaybe s :: Maybe Warp.Port of+    Just p  -> OpenAtPort p+    Nothing -> OpenAtUnixSocket s++instance Show OpenAt where+    show (OpenAtPort port) = "port " ++ show port+    show (OpenAtUnixSocket path) = "Unix socket " ++ show path++-- logic++run :: OpenAt -> ByteString -> Wai.Application -> IO ()+run openAt urlPrefix app = do+    B.putStrLn $ mconcat ["Server is opening at ", B.pack (show openAt), ".."]+    case openAt of+        OpenAtPort p -> Warp.runSettings+            (Warp.setPort p Warp.defaultSettings) go+        OpenAtUnixSocket s -> do+            sock <- unixSocket s+            Warp.runSettingsSocket Warp.defaultSettings sock go+  where+    go req respond+        | not (urlPrefix `B.isPrefixOf` url) = respond notFound+        | not (isSafeURL url) = respond notFound+        | (urlPrefix <> "/static/") `B.isPrefixOf` url = serveThis+        | (urlPrefix <> "/asset/") `B.isPrefixOf` url = serveThis+        | otherwise = app appReq respond+      where+        url = Wai.rawPathInfo req+        appReq = req { Wai.rawPathInfo = B.drop (B.length urlPrefix) url }+        serveThis = serve (B.drop (B.length urlPrefix + 1) url) req respond++serve :: ByteString -> Wai.Application+serve path req respond = case mimetype (extension path) of+    Just ctype -> do+        fileMTime <- getMTime path+        respond $ case modifiedSince req fileMTime of+            NotModified -> notModified+            Modified -> Wai.responseFile status200+                [ (hContentType, ctype)+                , (hLastModified, formattedMTime fileMTime)+                ]+                (B.unpack path) Nothing+    Nothing -> respond notFound++-- HTTP responses++notFound :: Wai.Response+notFound = Wai.responseLBS status404+    [(hContentType, "text/plain")]+    "Page not found"++notModified :: Wai.Response+notModified = Wai.responseLBS status304 [] ""++-- utilities++isSafeURL :: ByteString -> Bool+isSafeURL url = and+    [ B.all urlChar url+    , not $ "//" `B.isInfixOf` url+    , not $ "../" `B.isInfixOf` url+    , not $ ".." `B.isSuffixOf` url+    ]++urlChar :: Char -> Bool+urlChar c = or+    [ ord 'a' <= n && n <= ord 'z'+    , ord 'A' <= n && n <= ord 'Z'+    , ord '0' <= n && n <= ord '9'+    , c `B.elem` "-_./"+    ]+  where+    n = ord c++mimetype :: ByteString -> Maybe ByteString+mimetype ext = case ext of+    "jpg"   -> Just "image/jpeg"+    "png"   -> Just "image/png"+    "svg"   -> Just "image/svg+xml"+    "js"    -> Just "application/javascript; charset=utf-8"+    "css"   -> Just "text/css"+    "pdf"   -> Just "application/pdf"+    "eot"   -> Just "application/vnd.ms-fontobject"+    "ttf"   -> Just "application/octet-stream"+    "woff"  -> Just "application/font-woff"+    "woff2" -> Just "application/font-woff2"+    "txt"   -> Just "text/plain"+    "ico"   -> Just "image/vnd.microsoft.icon"+    _       -> Nothing++cExtensionLongest :: Int+cExtensionLongest = 5++extension :: ByteString -> ByteString+extension path = snd $ B.breakEnd (== '.') $+    B.drop (B.length path - cExtensionLongest) path
+ src/Space/UnixSocket.hs view
@@ -0,0 +1,20 @@+module Space.UnixSocket+    ( Socket+    , unixSocket+    ) where++import Space.Import++import Network.Socket+import System.Directory++unixSocket :: FilePath -> IO Socket+unixSocket path = do+    tryRemoveFile path+    s <- socket AF_UNIX Stream defaultProtocol+    bind s (SockAddrUnix path)+    listen s maxListenQueue+    return s++tryRemoveFile :: FilePath -> IO ()+tryRemoveFile path = catchIOError (removeFile path) (const (return ()))
+ src/Space/View.hs view
@@ -0,0 +1,62 @@+module Space.View+    ( ByteString+    , module Network.HTTP.Types+    , module Network.Wai+    , Html+    , render+    , jsonResponse+    , jsonCType+    , notFound+    , methodNotAllowed+    , intArg+    ) where++import qualified Data.Aeson as Aeson+import Data.Attoparsec.ByteString (parseOnly)+import Data.Attoparsec.ByteString.Char8 (decimal)+import Data.ByteString (ByteString)+import qualified Data.ByteString.Builder as B+import Network.HTTP.Types+import Network.Wai+    ( Application+    , Request+    , Response+    , rawPathInfo+    , requestHeaders+    , requestMethod+    , responseBuilder+    , responseLBS+    , strictRequestBody+    )+import Lucid (Html, renderBS)++render :: Status -> ResponseHeaders -> Html a -> Response+render s h c = responseLBS s (ctype : h) (renderBS c)+  where+    ctype = (hContentType, "text/html; charset=utf-8")++jsonResponse :: Aeson.ToJSON x => Status -> x -> Response+jsonResponse status = responseBuilder status [jsonCType] .+    Aeson.fromEncoding . Aeson.toEncoding++-- utility++notFound :: Response+notFound = responseBuilder status404 [] "Not Found"++methodNotAllowed :: Response+methodNotAllowed = render status405 [] "Method Not Allowed"++jsonCType :: Header+jsonCType = (hContentType, "application/json; charset=utf-8")++intArg :: Integral int => ByteString -> (int -> IO Response) -> IO Response+intArg rawArg handler = case parseOnly decimal rawArg of+    Left _ -> return $ responseBuilder status400 [jsonCType] msg+    Right i -> handler i+  where+    msg = mconcat+        [ "{\"message\":\"could not parse "+        , B.byteString rawArg+        ," as an integral value\"}"+        ]
+ test/Spec.hs view
@@ -0,0 +1,2 @@+main :: IO ()+main = putStrLn "Test suite not yet implemented"