Updating channels (visibility)

backend/ChangeLog.md

@@ -1,5 +0,0 @@
-# Revision history for backend
-
-## 0.1.0.0 -- YYYY-mm-dd
-
-* First version. Released on an unsuspecting world.

backend/LICENSE

@@ -1,30 +0,0 @@
-Copyright (c) 2018, Mats Rauhala
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials provided
-      with the distribution.
-
-    * Neither the name of Mats Rauhala nor the names of other
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

backend/Setup.hs

@@ -1,2 +0,0 @@
-import Distribution.Simple
-main = defaultMain

common/LICENSE

@@ -1,30 +0,0 @@
-Copyright (c) 2018, Mats Rauhala
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above
-      copyright notice, this list of conditions and the following
-      disclaimer in the documentation and/or other materials provided
-      with the distribution.
-
-    * Neither the name of Mats Rauhala nor the names of other
-      contributors may be used to endorse or promote products derived
-      from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

common/common.cabal

@@ -1,65 +0,0 @@
-name:                common
-version:             0.1.0.0
--- synopsis:
--- description:
-license:             BSD3
-license-file:        LICENSE
-author:              Mats Rauhala
-maintainer:          mats.rauhala@iki.fi
--- copyright:
-category:            Web
-build-type:          Simple
-extra-source-files:  ChangeLog.md
-cabal-version:       >=1.10
-
-library
-  exposed-modules:     Configuration
-                     , Data.Versioned
-  -- other-extensions:
-  build-depends:       base >=4.10 && <4.11
-                     , aeson
-                     , asn1-data
-                     , asn1-types
-                     , bytestring
-                     , classy-prelude
-                     , cryptonite
-                     , dhall
-                     , directory
-                     , foreign-store
-                     , generic-lens
-                     , http-api-data
-                     , http-media
-                     , jose
-                     , lens
-                     , lucid
-                     , memory
-                     , monad-logger
-                     , mtl
-                     , pandoc
-                     , pandoc-types
-                     , pem
-                     , process
-                     , resource-pool
-                     , selda
-                     , selda-postgresql
-                     , servant
-                     , servant-auth
-                     , servant-auth-server
-                     , servant-docs
-                     , servant-lucid
-                     , servant-multipart
-                     , servant-server
-                     , text
-                     , transformers
-                     , wai
-                     , warp
-                     , x509
-                     , x509-store
-                     , xml-conduit
-                     , xml-hamlet
-  hs-source-dirs:      src
-  default-extensions:  DeriveGeneric
-                     , NoImplicitPrelude
-                     , OverloadedStrings
-                     , RecordWildCards
-  default-language:    Haskell2010

default.nix

@@ -1,8 +1,10 @@
-{ nixpkgs, haskellPackages }:
-
-(import ./project.nix nixpkgs) {
-  packages = {
-    common = ./common;
-    backend = ./backend;
-  };
+{ mkDerivation, base, stdenv }:
+mkDerivation {
+  pname = "ebook-manager";
+  version = "0.1.0.0";
+  src = ./.;
+  isLibrary = false;
+  isExecutable = true;
+  executableHaskellDepends = [ base ];
+  license = stdenv.lib.licenses.bsd3;
 }

ebook-manager.cabal

@@ -1,7 +1,7 @@
--- Initial backend.cabal generated by cabal init.  For further
+-- Initial ebook-manager.cabal generated by cabal init.  For further
 -- documentation, see http://haskell.org/cabal/users-guide/
 
-name:                backend
+name:                ebook-manager
 version:             0.1.0.0
 -- synopsis:
 -- description:
@@ -15,7 +15,7 @@ build-type:          Simple
 extra-source-files:  ChangeLog.md
 cabal-version:       >=1.10
 
-executable backend
+executable ebook-manager
   main-is:             Main.hs
   other-modules:       Devel.Main
                      , API
@@ -23,6 +23,8 @@ executable backend
                      , API.Catalogue
                      , API.Channels
                      , API.Users
+                     , Configuration
+                     , Data.Versioned
                      , Database
                      , Database.Book
                      , Database.Channel
@@ -37,7 +39,6 @@ executable backend
                      , View
   -- other-extensions:
   build-depends:       base >=4.10 && <4.11
-                     , common
                      , aeson
                      , asn1-data
                      , asn1-types
@@ -79,8 +80,8 @@ executable backend
                      , xml-conduit
                      , xml-hamlet
   hs-source-dirs:      src
-  default-language:    Haskell2010
   default-extensions:  DeriveGeneric
                      , NoImplicitPrelude
                      , OverloadedStrings
                      , RecordWildCards
+  default-language:    Haskell2010

project.nix

@@ -1,37 +0,0 @@
-nixpkgs:
-
-let
-
-  inherit (nixpkgs.lib) mapAttrs mapAttrsToList escapeShellArg optionalString concatStringsSep concatMapStringsSep;
-
-in
-
-{ packages
-, overrides ? _ : _ : {}
-}:
-
-let
-
-  overrides' = nixpkgs.lib.foldr nixpkgs.lib.composeExtensions (_: _: {}) [
-    (self: super: mapAttrs (name: path: self.callCabal2nix name path {}) packages)
-  ];
-  haskellPackages = nixpkgs.haskellPackages.override { overrides = overrides'; };
-  packages' = mapAttrs (name: _: haskellPackages."${name}") packages;
-  mkShell = name: pkg:
-  let
-    n =  "${name}-shell";
-    deps = haskellPackages.ghcWithPackages (pkgs: pkg.nativeBuildInputs);
-  in
-  {
-    name = "${n}";
-    value = nixpkgs.buildEnv {
-      name = "${n}";
-      paths = [];
-      buildInputs = [deps];
-    };
-  };
-  shells = nixpkgs.lib.listToAttrs (mapAttrsToList mkShell packages');
-
-in
-
-packages' // shells

release.nix

@@ -1,15 +0,0 @@
-{ nixpkgs ? import <nixpkgs> {} }:
-
-let
-
-  pinnedVersion = nixpkgs.lib.importJSON ./nixpkgs-version.json;
-  pinnedPkgs = import (nixpkgs.fetchFromGitHub {
-    owner = "NixOS";
-    repo = "nixpkgs";
-    inherit (pinnedVersion) rev sha256;
-  }) {};
-  inherit (pinnedPkgs) pkgs;
-
-  in
-
-import ./default.nix { nixpkgs = pinnedPkgs; haskellPackages = pinnedPkgs.haskellPackages; }

src/API.hs

@@ -27,8 +27,8 @@ data Index = Index
 
 type API = Get '[HTML] (AppView Index)
       :<|> Users.API
-      :<|> "api" :> "current" :> Channels.API
-      :<|> "api" :> "current" :> Books.API
+      :<|> "api" :> Channels.API
+      :<|> "api" :> Books.API
       :<|> "api" :> "1" :> Catalogue.VersionedAPI 1
       :<|> "api" :> "current" :> Catalogue.VersionedAPI 1
 

src/API/Books.hs

@@ -36,14 +36,14 @@ import Crypto.Hash (digestFromByteString)
 
 data JsonBook = JsonBook { identifier :: BookID
                          , contentType :: Text
-                         , title :: Text
+                         , title :: Maybe Text
                          , description :: Maybe Text
                          , channels :: [Text]
                          , tags :: [Text] }
               deriving (Generic, Show)
 
 data PostBook = PostBook { contentType :: Text
-                         , title :: Text
+                         , title :: Maybe Text
                          , description :: Maybe Text
                          , channels :: [Text]
                          , tags :: [Text] }
@@ -61,9 +61,7 @@ type BaseAPI = "books" :> Get '[JSON] [JsonBook]
        :<|> "books" :> ReqBody '[JSON] PostBook :> Post '[JSON] JsonBook
        :<|> "books" :> Capture "book_id" BookID :> "meta" :> ReqBody '[JSON] JsonBook :> Put '[JSON] JsonBook
        :<|> "books" :> Capture "book_id" BookID :> ReqBody '[OctetStream] ByteString :> Put '[JSON] NoContent
-       :<|> GetBook
-
-type GetBook = "books" :> Capture "book_id" BookID :> Get '[OctetStream] ByteString
+       :<|> "books" :> Capture "book_id" BookID :> Get '[OctetStream] ByteString
 
 handler :: ServerT API AppM
 handler user = listBooksHandler user

src/API/Catalogue.hs

@@ -17,16 +17,14 @@
 module API.Catalogue (VersionedAPI, handler) where
 
 import Types
-import Servant hiding (contentType)
+import Servant
 import ClassyPrelude
 import GHC.TypeLits
 import Server.Auth
 import Servant.Auth as SA
 import Servant.XML
 import qualified Database.Channel as Channel
-import Database.Book (Book(..))
 import Database
-import qualified API.Books
 
 -- This is my first try on going to versioned apis, things might change
 -- I think my rule of thumb is that you can add new things as you want, but
@@ -98,40 +96,15 @@ instance ToNode (Catalog 1) where
 
 class Monad m => VersionedCatalog m (v :: Nat) where
   getChannels :: SafeUser -> m (Catalog v)
-  getBooks :: Channel.ChannelID -> SafeUser -> m (Catalog v)
 
 instance VersionedCatalog AppM 1 where
-  getChannels = getChannelsV1
-  getBooks = getBooksV1
-
-relUrl :: Link -> Rel
-relUrl x = Rel ("/api/current/" <> (pack . uriPath . linkURI $ x))
-
-getBooksV1 :: Channel.ChannelID -> SafeUser -> AppM (Catalog 1)
-getBooksV1 channelID SafeUser{username} = do
+  getChannels SafeUser{username} = do
     updated <- liftIO getCurrentTime
-  let self = relUrl selfUrl
-      start = relUrl startUrl
-      selfUrl = safeLink (Proxy @(BaseAPI 1)) (Proxy @(ChannelCatalog 1)) channelID
-      startUrl = safeLink (Proxy @(BaseAPI 1)) (Proxy @(RootCatalog 1))
-      pagination = Pagination Nothing Nothing
-  entries <- map (toEntry updated) <$> runDB (Channel.channelBooks username channelID)
-  pure CatalogV1{..}
-  where
-    toEntry updated Book{description,title,identifier=bookId} =
-      let content = fromMaybe "no content" description
-          identifier = pack . show $ bookId
-          link = Right (Acquisition (relUrl (safeLink (Proxy @API.Books.BaseAPI) (Proxy @API.Books.GetBook) bookId)))
-      in EntryV1{..}
-
-getChannelsV1 :: SafeUser -> AppM (Catalog 1)
-getChannelsV1 SafeUser{username} = do
-  updated <- liftIO getCurrentTime
-  let self = relUrl selfUrl
+    let self = Rel ("/api/current/" <> selfUrl)
         -- I'm not sure if this safe link approach is really useable with this
         -- api hierarchy since I can't access the topmost api from here. Also
         -- authentication would bring a little bit of extra effort as well
-      selfUrl = safeLink (Proxy @(BaseAPI 1)) (Proxy @(RootCatalog 1))
+        selfUrl = pack . uriPath . linkURI $ safeLink (Proxy @(BaseAPI 1)) (Proxy @(RootCatalog 1))
         start = self
         pagination = Pagination Nothing Nothing
     entries <- map (fromChannel updated) <$> runDB (Channel.userChannels username)
@@ -139,16 +112,14 @@ getChannelsV1 SafeUser{username} = do
     where
       fromChannel :: UTCTime -> Channel.Channel -> Entry 1
       fromChannel updated Channel.Channel{..} =
-      let url = safeLink (Proxy @(BaseAPI 1)) (Proxy @(ChannelCatalog 1)) identifier
-          self = relUrl url
+        let url = pack . uriPath . linkURI $ safeLink (Proxy @(BaseAPI 1)) (Proxy @(ChannelCatalog 1)) identifier
+            self = Rel ("/api/current/" <> url)
         in EntryV1 channel channel updated channel (Left $ SubSection self)
 
 type VersionedAPI (v :: Nat) = Auth '[SA.BasicAuth, SA.JWT] SafeUser :> BaseAPI v
 
-type CatalogContent = '[XML, OPDS]
-
-type RootCatalog (v :: Nat) = "catalog" :> Get CatalogContent (Catalog v)
-type ChannelCatalog (v :: Nat) = "catalog" :> "channel" :> Capture "channel_id" Channel.ChannelID :> Get CatalogContent (Catalog v)
+type RootCatalog (v :: Nat) = "catalog" :> Get '[XML] (Catalog v)
+type ChannelCatalog (v :: Nat) = "catalog" :> "channel" :> Capture "channel_id" Channel.ChannelID :> Get '[XML] (Catalog v)
 type BaseAPI (v :: Nat) = RootCatalog v
                     :<|> ChannelCatalog v
 
@@ -156,8 +127,6 @@ handler :: forall v. VersionedCatalog AppM v => ServerT (VersionedAPI v) AppM
 handler auth = catalogRoot :<|> catalogChannels
   where
     catalogChannels :: Channel.ChannelID -> AppM (Catalog v)
-    -- Channel specific catalog returns tags inside the catalog
-    catalogChannels identifier = flip requireLoggedIn auth (getBooks identifier)
+    catalogChannels _ = throwM err403{errBody="Not implemented"}
     catalogRoot :: AppM (Catalog v)
-    -- catalog root returns channels
     catalogRoot = flip requireLoggedIn auth getChannels

src/Database/Book.hs

@@ -51,7 +51,7 @@ getBook identifier owner = listToMaybe . fromRels <$> query q
       return book
 
 data InsertBook = InsertBook { contentType :: Text
-                             , title :: Text
+                             , title :: Maybe Text
                              , description :: Maybe Text
                              , owner :: Username }
 
@@ -68,7 +68,7 @@ insertBook InsertBook{..} = do
 
 data UpdateBook = UpdateBook { identifier :: BookID
                              , contentType :: Text
-                             , title :: Text
+                             , title :: Maybe Text
                              , description :: Maybe Text
                              , owner :: Username
                              , tags :: [Text]

src/Database/Channel.hs

@@ -11,9 +11,8 @@ module Database.Channel
   , Visibility(..)
   , clearChannels
   , booksChannels
-  , channelBooks
   , Channel(..)
-  , ChannelID(..) )
+  , ChannelID )
   where
 
 import ClassyPrelude
@@ -81,19 +80,6 @@ insertChannel username channel visibility = runMaybeT $ do
       restrict (user .== literal username)
       return userId
 
-channelBooks :: (MonadSelda m, MonadMask m, MonadIO m) => Username -> ChannelID -> m [Book]
-channelBooks username identifier = fromRels <$> query q
-  where
-    q = do
-      channelId :*: bookId' <- select (gen bookChannels)
-      channelId' :*: _ :*: owner :*: _ <- select (gen channels)
-      userId :*: _ :*: username' :*: _ <- select (gen users)
-      book@(bookId :*: _) <- select (gen books)
-      restrict (username' .== literal username .&& owner .== userId)
-      restrict (channelId .== literal identifier .&& channelId .== channelId')
-      restrict (bookId .== bookId')
-      return book
-
 booksChannels :: (MonadSelda m, MonadMask m, MonadIO m) => BookID -> m [Channel]
 booksChannels bookId = fromRels <$> query q
   where

src/Database/Schema.hs

@@ -42,7 +42,7 @@ instance SqlType Username where
 
 newtype UserID = UserID {unUserID :: Int} deriving (Show)
 
-newtype BookID = BookID {unBookID :: Int} deriving (Show, ToJSON, FromJSON, FromHttpApiData, Eq, Ord, ToHttpApiData)
+newtype BookID = BookID {unBookID :: Int} deriving (Show, ToJSON, FromJSON, FromHttpApiData, Eq, Ord)
 
 newtype ChannelID = ChannelID {unChannelID :: Int} deriving (Show, ToHttpApiData, FromHttpApiData, ToJSON, FromJSON)
 
@@ -101,7 +101,7 @@ newtype HashDigest = HashDigest { unHex :: ByteString } deriving Show
 data Book = Book { identifier :: BookID
                  , contentHash :: Maybe HashDigest
                  , contentType :: Text
-                 , title :: Text
+                 , title :: Maybe Text
                  , description :: Maybe Text
                  , owner :: UserID }
           deriving (Show, Generic)

src/Devel/Main.hs

@@ -37,7 +37,7 @@ update = do
 
 develMain :: IO ()
 develMain = do
-  conf <- input auto "../config/devel.dhall"
+  conf <- input auto "./config/devel.dhall"
   withApp conf $ \app -> do
     void $ runReaderT (runDB migrate) app
     defaultMain app

src/Servant/XML.hs

@@ -1,11 +1,9 @@
 {-# Language OverloadedStrings #-}
 {-# Language FlexibleInstances #-}
 {-# Language MultiParamTypeClasses #-}
-{-# Language TypeApplications #-}
 module Servant.XML
   ( ToNode(..)
   , XML
-  , OPDS
   , Text.Hamlet.XML.xml
   , iso8601 )
   where
@@ -18,22 +16,14 @@ import Network.HTTP.Media.MediaType
 
 data XML
 
-data OPDS
-
 instance (ToNode a) => MimeRender XML a where
   mimeRender _ a =
     let [NodeElement root] = toNode a
     in renderLBS def (Document (Prologue [] Nothing []) root [])
 
-instance (ToNode a) => MimeRender OPDS a where
-  mimeRender _ a = mimeRender (Proxy @XML) a
-
 instance Accept XML where
   contentType _ = "application" // "xml" /: ("charset", "utf-8")
 
-instance Accept OPDS where
-  contentType _ = "application" // "atom+xml" /: ("charset", "utf-8") /: ("profile", "opds-catalog")
-
 iso8601 :: UTCTime -> Text
 iso8601 = pack . formatTime defaultTimeLocale "%Y-%m-%dT%H:%M:%SZ"