Types.hs

{-# LANGUAGE DeriveAnyClass    #-}
{-# LANGUAGE DeriveGeneric     #-}
{-# LANGUAGE OverloadedStrings #-}

-----------------------------------------------------------------------------
-- |
-- Module : FeedReader.Data.DB
-- Copyright : (c) 2015 Călin Ardelean
-- License : BSD-style
--
-- Maintainer : Călin Ardelean <calinucs@gmail.com>
-- Stability : experimental
-- Portability : portable
--
-- This module provides the core types and functions for Feed Reader.
----------------------------------------------------------------------------

module FeedReader.Types
  ( Cat (..)
  , Feed (..)
  , Person (..)
  , Item (..)
  , ItemStatus (..)
  , ItemStatusKey (..)
  , URL
  , Language
  , Tag
  , Content (..)
  , HTTPAuth (..)
  , Image (..)
  , Sortable (..)
  , Unique (..)
  ) where

import           Data.Hashable         (Hashable (..))
import           Data.Serialize        (Serialize (..))
import           Database.Muesli.Types
import           GHC.Generics          (Generic)

type URL      = String
type Language = String
type Tag      = String

data Content  = Text String | HTML String | XHTML String
  deriving (Show, Generic, Serialize, Indexable)

data Cat = Cat
  { catName   :: Sortable String
  , catParent :: Maybe (Reference Cat)
  } deriving (Show, Generic, Serialize)

instance Document Cat

data Person = Person
  { personName  :: Unique (Sortable String)
  , personURL   :: URL
  , personEmail :: String
  } deriving (Show, Generic, Serialize)

instance Document Person

data Image = Image
  { imageURL         :: URL
  , imageTitle       :: String
  , imageDescription :: String
  , imageLink        :: URL
  , imageWidth       :: Int
  , imageHeight      :: Int
  } deriving (Show, Generic, Serialize, Indexable)

data HTTPAuth = HTTPAuth
  { authUserName :: String
  , authPassword :: String
  } deriving (Show, Generic, Serialize, Indexable)

data Feed = Feed
  { feedCat          :: Maybe (Reference Cat)
  , feedURL          :: Unique URL
  , feedHTTPAuth     :: Maybe HTTPAuth
  , feedWebURL       :: URL
  , feedTitle        :: Sortable Content
  , feedDescription  :: Content
  , feedLanguage     :: Language
  , feedAuthors      :: [Reference Person]
  , feedContributors :: [Reference Person]
  , feedRights       :: Content
  , feedImage        :: Maybe Image
  , feedUpdated      :: Sortable DateTime
  , feedUnsubscribed :: Bool
  , feedLastError    :: Maybe String
  } deriving (Show, Generic, Serialize)

-- TODO: Sortable -> Sorted, Reference -> Ref
-- TODO: filter on Sorted columns
-- TODO: File backend: process file locking
-- TODO: optimize getDocument (hash id => multiple caches)

instance Document Feed

data ItemStatusKey = StatusNew | StatusUnread | StatusRead | StatusStarred
  deriving (Show, Generic, Serialize, Indexable, Hashable)

data ItemStatus = ItemStatus
  { statusKey :: Unique ItemStatusKey
  } deriving (Show, Generic, Serialize)

instance Document ItemStatus

data Item = Item
  { itemFeed         :: Reference Feed
  , itemURL          :: Unique URL
  , itemTitle        :: Content
  , itemSummary      :: Content
  , itemTags         :: [Sortable Tag]
  , itemAuthors      :: [Reference Person]
  , itemContributors :: [Reference Person]
  , itemRights       :: Content
  , itemContent      :: Content
  , itemPublished    :: Sortable DateTime
  , itemUpdated      :: Sortable DateTime
  , itemStatus       :: Reference ItemStatus
  } deriving (Show, Generic, Serialize)

instance Document Item