WIP

- Relates to #2
2018-08-14 22:12:43 +03:00
11 changed files with 65 additions and 184 deletions
--- a/ebook-manager.cabal
+++ b/ebook-manager.cabal
@ -1,6 +1,3 @@
-- Initial ebook-manager.cabal generated by cabal init.  For further
-- documentation, see http://haskell.org/cabal/users-guide/
-
 name:                ebook-manager
 version:             0.1.0.0
 -- synopsis:
@ -28,7 +25,6 @@ executable ebook-manager
                     , Database
                     , Database.Book
                     , Database.Channel
-                     , Database.Tag
                     , Database.Schema
                     , Database.User
                     , Datastore
--- a/migrations/V1.1__Channel_visibility.sql
+++ b/migrations/V1.1__Channel_visibility.sql
@ -1 +0,0 @@
-alter table channels add column visibility text NOT NULL default 'Private';
--- a/src/API/Books.hs
+++ b/src/API/Books.hs
@ -21,9 +21,9 @@ import ClassyPrelude
 import Server.Auth
 import Servant.Auth as SA
 import Data.Aeson
+import API.Channels (JsonChannel(..))
 import Database.Book
 import Database.Channel
-import Database.Tag
 import Database
 import Control.Lens
 import Data.Generics.Product
@ -38,15 +38,13 @@ data JsonBook = JsonBook { identifier :: BookID
                         , contentType :: Text
                         , title :: Maybe Text
                         , description :: Maybe Text
-                         , channels :: [Text]
-                         , tags :: [Text] }
+                         , channels :: [JsonChannel] }
              deriving (Generic, Show)

 data PostBook = PostBook { contentType :: Text
                         , title :: Maybe Text
                         , description :: Maybe Text
-                         , channels :: [Text]
-                         , tags :: [Text] }
+                         , channels :: [JsonChannel] }
              deriving (Generic, Show)


@ -97,9 +95,9 @@ postBookMetaHandler auth PostBook{..} = flip requireLoggedIn auth $ \SafeUser{us


 putBookMetaHandler :: AuthResult SafeUser -> BookID -> JsonBook -> AppM JsonBook
-putBookMetaHandler auth bookId JsonBook{..}
+putBookMetaHandler auth bookId b@JsonBook{..}
  | bookId == identifier = requireBookOwner auth bookId $ \SafeUser{username=owner} ->
-        maybe (throwM err403) (return . view (super @JsonBook)) =<< runDB (updateBook UpdateBook{..})
+        maybe (throwM err403) (const (return b)) =<< runDB (updateBook UpdateBook{..})
  | otherwise = throwM err403

 listBooksHandler :: AuthResult SafeUser -> AppM [JsonBook]
@ -107,6 +105,5 @@ listBooksHandler = requireLoggedIn $ \user -> do
  runDB (usersBooks (view (field @"username") user) >>= mapM augment)
    where
      augment Book{identifier=bookId,contentType,title,description} = do
-        channels <- fmap (view (field @"channel")) <$> booksChannels bookId
-        tags <- fmap (view (field @"tag")) <$> booksTags bookId
+        channels <- fmap (\Channel{..} -> JsonChannel{..}) <$> booksChannels bookId
        pure JsonBook{identifier=bookId,..}
--- a/src/API/Catalogue.hs
+++ b/src/API/Catalogue.hs
@ -98,28 +98,33 @@ class Monad m => VersionedCatalog m (v :: Nat) where
  getChannels :: SafeUser -> m (Catalog v)

 instance VersionedCatalog AppM 1 where
-  getChannels SafeUser{username} = do
-    updated <- liftIO getCurrentTime
-    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 = pack . uriPath . linkURI $ safeLink (Proxy @(BaseAPI 1)) (Proxy @(RootCatalog 1))
-        start = self
-        pagination = Pagination Nothing Nothing
-    entries <- map (fromChannel updated) <$> runDB (Channel.userChannels username)
-    pure CatalogV1{..}
-    where
-      fromChannel :: UTCTime -> Channel.Channel -> Entry 1
-      fromChannel updated Channel.Channel{..} =
-        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)
+  getChannels = getChannelsV1
+
+getChannelsV1 :: SafeUser -> AppM (Catalog 1)
+getChannelsV1 SafeUser{username} = do
+  updated <- liftIO getCurrentTime
+  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 = pack . uriPath . linkURI $ safeLink (Proxy @(BaseAPI 1)) (Proxy @(RootCatalog 1))
+      start = self
+      pagination = Pagination Nothing Nothing
+  entries <- map (fromChannel updated) <$> runDB (Channel.userChannels username)
+  pure CatalogV1{..}
+  where
+    fromChannel :: UTCTime -> Channel.Channel -> Entry 1
+    fromChannel updated Channel.Channel{..} =
+      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 RootCatalog (v :: Nat) = "catalog" :> Get '[XML] (Catalog v)
-type ChannelCatalog (v :: Nat) = "catalog" :> "channel" :> Capture "channel_id" Channel.ChannelID :> Get '[XML] (Catalog 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 BaseAPI (v :: Nat) = RootCatalog v
                    :<|> ChannelCatalog v

@ -127,6 +132,8 @@ 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 _ = throwM err403{errBody="Not implemented"}
    catalogRoot :: AppM (Catalog v)
+    -- catalog root returns channels
    catalogRoot = flip requireLoggedIn auth getChannels
--- a/src/API/Channels.hs
+++ b/src/API/Channels.hs
@ -25,16 +25,14 @@ import Data.Aeson
 import Control.Lens
 import Data.Generics.Product

-data JsonChannel = JsonChannel { channel :: Text
-                               , visibility :: Visibility }
-                 deriving (Show, Generic)
+data JsonChannel = JsonChannel { channel :: Text } deriving (Show, Generic)

 instance ToJSON JsonChannel
 instance FromJSON JsonChannel

 type API = Auth '[SA.BasicAuth, SA.Cookie, SA.JWT] SafeUser :> BaseAPI

-type BaseAPI = "channels" :> ReqBody '[JSON] JsonChannel :> Post '[JSON] JsonChannel
+type BaseAPI = "channels" :> ReqBody '[JSON] JsonChannel :> Put '[JSON] JsonChannel
          :<|> "channels" :> Get '[JSON] [JsonChannel]

 handler :: ServerT API AppM
@ -49,5 +47,5 @@ listChannelsHandler = requireLoggedIn $ \user ->
 newChannelHandler :: AuthResult SafeUser -> JsonChannel -> AppM JsonChannel
 newChannelHandler auth ch@JsonChannel{..} = flip requireLoggedIn auth $ \user -> do
  $logInfo $ "Creating channel for user " <> pack (show user)
-  runDB (insertChannel (view (field @"username") user) channel visibility)
+  runDB (insertChannel (view (field @"username") user) channel)
  return ch
--- a/src/Database.hs
+++ b/src/Database.hs
@ -11,7 +11,6 @@ module Database
  , fromRel
  , fromRels
  , toRel
-  , transaction
  , SeldaT )
  where

@ -19,7 +18,7 @@ import Data.Generics.Product
 import Control.Lens (view)
 import Data.Pool (Pool, withResource)
 import Database.Selda.Backend (SeldaConnection, runSeldaT, SeldaT)
-import Database.Selda (query, select, transaction)
+import Database.Selda (query, select)
 import Database.Selda.Generic (gen, fromRel, fromRels, toRel)
 import ClassyPrelude

--- a/src/Database/Book.hs
+++ b/src/Database/Book.hs
@ -18,17 +18,11 @@ module Database.Book
  , BookID) where

 import ClassyPrelude
-import Database.Schema (books, users, Username, Book(..), BookID(..), UserID, HashDigest(..))
+import Database.Schema
 import Database
 import Database.Selda
 import Database.Selda.Generic

-import Control.Lens (view)
-import Data.Generics.Product
-
-import Database.Tag (booksTags, attachTag, clearTags)
-import Database.Channel (booksChannels, attachChannel, clearChannels)
-
 usersBooks :: (MonadSelda m, MonadMask m, MonadIO m) => Username -> m [Book]
 usersBooks username = fromRels <$> query q
  where
@ -70,10 +64,7 @@ data UpdateBook = UpdateBook { identifier :: BookID
                             , contentType :: Text
                             , title :: Maybe Text
                             , description :: Maybe Text
-                             , owner :: Username
-                             , tags :: [Text]
-                             , channels :: [Text] }
-                deriving (Show, Generic)
+                             , owner :: Username }

 bookExists :: (MonadSelda m, MonadMask m, MonadIO m) => BookID -> m Bool
 bookExists identifier = not . null <$> query q
@ -96,32 +87,17 @@ bookOwner' identifier username = do
  return (userId :*: bookId)

 updateBook :: (MonadSelda m, MonadMask m, MonadIO m) => UpdateBook -> m (Maybe UpdateBook)
-updateBook UpdateBook{..} = do
-  clearTags identifier >> connectTags
-  clearChannels identifier >> connectChannels
-  updateBook'
-  getUpdateBook identifier owner
+updateBook book@UpdateBook{..} = do
+  mUserId <- query (bookOwner' identifier owner)
+  forM (listToMaybe mUserId) $ \_userId -> do
+    update_ (gen books) predicate (\b -> b `with` [ pContentType := literal contentType
+                                                  , pTitle := literal title
+                                                  , pDescription := literal description ])
+    return book
  where
-    connectTags = mapM_ (attachTag owner identifier) tags
-    connectChannels = mapM_ (attachChannel owner identifier) channels
-    updateBook' = do
-      mUserId <- query (bookOwner' identifier owner)
-      forM_ (listToMaybe mUserId) $ \_userId -> do
-        update_ (gen books) predicate (\b -> b `with` [ pContentType := literal contentType
-                                                      , pTitle := literal title
-                                                      , pDescription := literal description ])
    _ :*: _ :*: pContentType :*: pTitle :*: pDescription :*: _ = selectors (gen books)
    predicate (bookId :*: _) = bookId .== literal identifier

-
-getUpdateBook :: (MonadMask m, MonadIO m, MonadSelda m) => BookID -> Username -> m (Maybe UpdateBook)
-getUpdateBook bookId username = do
-  mBook <- getBook bookId username
-  forM mBook $ \Book{..} -> do
-    channels <- map (view (field @"channel")) <$> booksChannels bookId
-    tags <- map (view (field @"tag")) <$> booksTags bookId
-    return UpdateBook{owner=username,..}
-
 setContent :: (MonadSelda m, MonadMask m, MonadIO m) => BookID -> Username -> HashDigest -> m ()
 setContent identifier owner digest = do
  mOwner <- query (bookOwner' identifier owner)
--- a/src/Database/Channel.hs
+++ b/src/Database/Channel.hs
@ -1,12 +1,8 @@
 {-# Language TypeApplications #-}
 {-# Language DataKinds #-}
-{-# Language NamedFieldPuns #-}
 module Database.Channel
  ( userChannels
  , insertChannel
-  , attachChannel
-  , Visibility(..)
-  , clearChannels
  , booksChannels
  , Channel(..)
  , ChannelID )
@ -16,58 +12,35 @@ import ClassyPrelude
 import Database.Schema
 import Database
 import Database.Selda
-import Database.Selda.Generic

 userChannels :: (MonadMask m, MonadIO m) => Username -> SeldaT m [Channel]
 userChannels username = fromRels <$> query q
  where
    q = do
      userId :*: _ :*: username' :*: _ <- select (gen users)
-      channel@(_ :*: _ :*: owner :*: _) <- select (gen channels)
+      channel@(_ :*: _ :*: owner) <- select (gen channels)
      restrict (owner .== userId)
      restrict (username' .== literal username)
      return channel

-insertChannel :: (MonadMask m, MonadIO m) => Username -> Text -> Visibility -> SeldaT m ()
-insertChannel username channel visibility = do
+insertChannel :: (MonadMask m, MonadIO m) => Username -> Text -> SeldaT m ()
+insertChannel username channel = do
  mUserId <- listToMaybe <$> getUser
  void $ forM mUserId $ \userId ->
-    insertUnless (gen channels) (doesNotExist userId) [ def :*: channel :*: userId :*: visibility ]
+    insertUnless (gen channels) (doesNotExist userId) [ def :*: channel :*: userId ]
  where
-    doesNotExist userId (_ :*: channel' :*: userId' :*: _) = channel' .== literal channel .&& userId' .== literal userId
+    doesNotExist userId (_ :*: channel' :*: userId') = channel' .== literal channel .&& userId' .== literal userId
    getUser = query $ do
      userId :*: _ :*: user :*: _ <- select (gen users)
      restrict (user .== literal username)
      return userId

-booksChannels :: (MonadSelda m, MonadMask m, MonadIO m) => BookID -> m [Channel]
-booksChannels bookId = fromRels <$> query q
+booksChannels :: (MonadMask m, MonadIO m) => BookID -> SeldaT m [Channel]
+booksChannels contentHash = fromRels <$> query q
  where
    q = do
-      channelId :*: bookId' <- select (gen bookChannels)
+      channelId :*: contentHash' <- select (gen bookChannels)
      ch@(channelId' :*: _) <- select (gen channels)
      restrict (channelId .== channelId')
-      restrict (bookId' .== literal bookId)
+      restrict (contentHash' .== literal contentHash)
      return ch
-
-attachChannel :: (MonadMask m, MonadIO m, MonadSelda m) => Username -> BookID -> Text -> m ()
-attachChannel username bookId channel = do
-  mCh <- fromRels <$> query channelQ
-  forM_ mCh $ \Channel{identifier} ->
-    whenM (null <$> query (attachQ identifier)) $
-      void $ insertGen bookChannels [BookChannel identifier bookId]
-  where
-    attachQ channelId = do
-      (channelId' :*: bookId') <- select (gen bookChannels)
-      restrict (channelId' .== literal channelId .&& bookId' .== literal bookId)
-      return channelId'
-    channelQ = do
-      userId :*: _ :*: username' :*: _ <- select (gen users)
-      ch@(_ :*: channel' :*: owner :*: _) <- select (gen channels)
-      restrict (username' .== literal username)
-      restrict (owner .== userId)
-      restrict (channel' .== literal channel)
-      return ch
-
-clearChannels :: (MonadMask m, MonadIO m, MonadSelda m) => BookID -> m Int
-clearChannels bookId = deleteFrom (gen bookChannels) (\(_ :*: bookId') -> bookId' .== literal bookId)
--- a/src/Database/Schema.hs
+++ b/src/Database/Schema.hs
@ -124,22 +124,9 @@ data Tag = Tag { identifier :: TagID
               , owner :: UserID }
         deriving (Show, Generic)

-data Visibility = Public | Private | Followers
-                deriving (Show, Read, Generic)
-
-instance ToJSON Visibility
-instance FromJSON Visibility
-
-instance SqlType Visibility where
-  mkLit = LCustom . LText . pack . show
-  fromSql (SqlString x) = fromMaybe (error "fromSql: Not a valid visibility token") . readMay . unpack $ x
-  fromSql _             = error "fromSql: Not a valid visibility token"
-  defaultValue = mkLit Private
-
 data Channel = Channel { identifier :: ChannelID
                       , channel :: Text
-                       , owner :: UserID
-                       , visibility :: Visibility }
+                       , owner :: UserID }
             deriving (Show, Generic)

 tags :: GenTable Tag
--- a/src/Database/Tag.hs
+++ b/src/Database/Tag.hs
@ -1,61 +0,0 @@
-{-# Language TypeApplications #-}
-{-# Language TypeOperators #-}
-{-# Language DataKinds #-}
-{-# Language DuplicateRecordFields #-}
-{-# Language NamedFieldPuns #-}
-module Database.Tag
-  ( def
-  , booksTags
-  , attachTag
-  , upsertTag
-  , clearTags
-  , Tag(..) ) where
-
-import ClassyPrelude
-import Database.Schema
-import Database
-import Database.Selda
-import Database.Selda.Generic
-import Control.Monad.Trans.Maybe
-
-upsertTag :: (MonadMask m, MonadIO m, MonadSelda m) => Username -> Text -> m (Maybe Tag)
-upsertTag username tag = runMaybeT $ do
-  userId <- MaybeT (listToMaybe <$> query userQ)
-  void $ lift $ upsert (gen tags) (predicate userId) id [toRel (Tag def tag userId)]
-  MaybeT (listToMaybe . fromRels <$> query (tagQ userId))
-  where
-    predicate userId (_ :*: tag' :*: owner) = tag' .== literal tag .&& owner .== literal userId
-    tagQ userId = do
-      t@(_ :*: tag' :*: owner) <- select (gen tags)
-      restrict (tag' .== literal tag .&& owner .== literal userId)
-      return t
-    userQ = do
-      userId :*: _ :*: username' :*: _ <- select (gen users)
-      restrict (username' .== literal username)
-      return userId
-
-booksTags :: (MonadMask m, MonadIO m, MonadSelda m) => BookID -> m [Tag]
-booksTags bookId = fromRels <$> query q
-  where
-    q = do
-      tagId :*: bookId' <- select (gen bookTags)
-      tag@(tagId' :*: _) <- select (gen tags)
-      restrict (tagId .== tagId')
-      restrict (bookId' .== literal bookId)
-      return tag
-
-attachTag :: (MonadMask m, MonadIO m, MonadSelda m) => Username -> BookID -> Text -> m ()
-attachTag username bookId tag = do
-  maybeT <- upsertTag username tag
-  forM_ maybeT $ \Tag{identifier} -> do
-    whenM (null <$> query (tagQ identifier)) $
-      void $ insertGen bookTags [BookTag identifier bookId]
-  where
-    tagQ tagId = do
-      (tagId' :*: bookId') <- select (gen bookTags)
-      restrict (tagId' .== literal tagId .&& bookId' .== literal bookId)
-      return tagId'
-
-clearTags :: (MonadMask m, MonadIO m, MonadSelda m) => BookID -> m Int
-clearTags bookId = deleteFrom (gen bookTags) (\(_ :*: bookId') -> bookId' .== literal bookId)
-
--- a/src/Servant/XML.hs
+++ b/src/Servant/XML.hs
@ -1,9 +1,11 @@
 {-# Language OverloadedStrings #-}
 {-# Language FlexibleInstances #-}
 {-# Language MultiParamTypeClasses #-}
+{-# Language TypeApplications #-}
 module Servant.XML
  ( ToNode(..)
  , XML
+  , OPDS
  , Text.Hamlet.XML.xml
  , iso8601 )
  where
@ -16,14 +18,22 @@ 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"
				`@ -1 +0,0 @@`
				`alter table channels add column visibility text NOT NULL default 'Private';`