Imm

Meta-module that reexports many Imm sub-modules.

To get started, please consult Imm.Boot.

Documentation

data LogLevel

Constructors

Debug

Info

Warning

Error

Instances

Eq LogLevel

Defined in Imm.Logger

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

Defined in Imm.Logger

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Defined in Imm.Logger

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Defined in Imm.Logger

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

Pretty LogLevel

Defined in Imm.Logger

Methods

pretty :: LogLevel -> Doc ann

prettyList :: [LogLevel] -> Doc ann

log :: Handle m -> LogLevel -> Doc AnsiStyle -> m ()

getLogLevel :: Handle m -> m LogLevel

setLogLevel :: Handle m -> LogLevel -> m ()

setColorizeLogs :: Handle m -> Bool -> m ()

flushLogs :: Handle m -> m ()

httpGet :: Handle m -> URI -> m LByteString

get :: Monad m => Handle m -> Handle m -> URI -> m LByteString

Simple wrapper around httpGet that also logs the requested URI.

data FeedElement

Constructors

RssElement (RssItem '[ContentModule, DublinCoreModule])

AtomElement AtomEntry

Instances

Eq FeedElement

Defined in Imm.Feed

Methods

(==) :: FeedElement -> FeedElement -> Bool

(/=) :: FeedElement -> FeedElement -> Bool

Show FeedElement

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedElement -> ShowS

show :: FeedElement -> String

showList :: [FeedElement] -> ShowS

data Feed

Constructors

Rss (RssDocument '[ContentModule, DublinCoreModule])

Atom AtomFeed

Instances

Eq Feed

Defined in Imm.Feed

Methods

(==) :: Feed -> Feed -> Bool

(/=) :: Feed -> Feed -> Bool

Show Feed

Defined in Imm.Feed

Methods

showsPrec :: Int -> Feed -> ShowS

show :: Feed -> String

showList :: [Feed] -> ShowS

data FeedRef

Feed reference: either its URI, or its UID from database

Constructors

ByUID Int

ByURI URI

Instances

Eq FeedRef

Defined in Imm.Feed

Methods

(==) :: FeedRef -> FeedRef -> Bool

(/=) :: FeedRef -> FeedRef -> Bool

Show FeedRef

Defined in Imm.Feed

Methods

showsPrec :: Int -> FeedRef -> ShowS

show :: FeedRef -> String

showList :: [FeedRef] -> ShowS

Pretty FeedRef

Defined in Imm.Feed

Methods

pretty :: FeedRef -> Doc ann

prettyList :: [FeedRef] -> Doc ann

getFeedTitle :: Feed -> Text

getElements :: Feed -> [FeedElement]

getDate :: FeedElement -> Maybe UTCTime

getTitle :: FeedElement -> Text

getContent :: FeedElement -> Text

getHashes :: FeedElement -> [Int]

prettyElement :: FeedElement -> Doc a

processNewElement :: Handle m -> Feed -> FeedElement -> m ()

Action triggered for each unread feed element

onNewElement :: Monad m => Handle m -> Handle m -> Feed -> FeedElement -> m ()

data DatabaseException t

Constructors

NotCommitted t

NotDeleted t [Key t]

NotFound t [Key t]

NotInserted t [(Key t, Entry t)]

NotPurged t

NotUpdated t (Key t)

UnableFetchAll t

Instances

(Eq t, Eq (Key t), Eq (Entry t)) => Eq (DatabaseException t)

Defined in Imm.Database

Methods

(==) :: DatabaseException t -> DatabaseException t -> Bool

(/=) :: DatabaseException t -> DatabaseException t -> Bool

(Show t, Show (Key t), Show (Entry t)) => Show (DatabaseException t)

Defined in Imm.Database

Methods

showsPrec :: Int -> DatabaseException t -> ShowS

show :: DatabaseException t -> String

showList :: [DatabaseException t] -> ShowS

(Table t, Show (Key t), Show (Entry t), Pretty (Key t), Typeable t) => Exception (DatabaseException t)

Defined in Imm.Database

Methods

toException :: DatabaseException t -> SomeException

fromException :: SomeException -> Maybe (DatabaseException t)

displayException :: DatabaseException t -> String

(Pretty t, Pretty (Key t)) => Pretty (DatabaseException t)

Defined in Imm.Database

Methods

pretty :: DatabaseException t -> Doc ann

prettyList :: [DatabaseException t] -> Doc ann

_describeDatabase :: Handle m t -> forall a. m (Doc a)

_fetchList :: Handle m t -> [Key t] -> m (Map (Key t) (Entry t))

_fetchAll :: Handle m t -> m (Map (Key t) (Entry t))

_update :: Handle m t -> Key t -> (Entry t -> Entry t) -> m ()

_insertList :: Handle m t -> [(Key t, Entry t)] -> m ()

_deleteList :: Handle m t -> [Key t] -> m ()

_purge :: Handle m t -> m ()

_commit :: Handle m t -> m ()

class (Ord (Key t), Show (Key t), Show (Entry t), Typeable t, Show t, Pretty t, Pretty (Key t)) => Table t where

Generic database table

Associated Types

type Key t :: *

type Entry t :: *

Methods

rep :: t

Instances

Table FeedTable

Defined in Imm.Database.FeedTable

Associated Types

type Key FeedTable :: Type

type Entry FeedTable :: Type

Methods

rep :: FeedTable

fetch :: Monad m => Table t => MonadThrow m => Handle m t -> Key t -> m (Entry t)

fetchList :: Monad m => Handle m t -> [Key t] -> m (Map (Key t) (Entry t))

fetchAll :: Monad m => Handle m t -> m (Map (Key t) (Entry t))

update :: Monad m => Handle m t -> Key t -> (Entry t -> Entry t) -> m ()

insert :: Monad m => Handle m -> Handle m t -> Key t -> Entry t -> m ()

insertList :: Monad m => Handle m -> Handle m t -> [(Key t, Entry t)] -> m ()

delete :: Monad m => Handle m -> Handle m t -> Key t -> m ()

deleteList :: Monad m => Handle m -> Handle m t -> [Key t] -> m ()

purge :: Monad m => Handle m -> Handle m t -> m ()

commit :: Monad m => Handle m -> Handle m t -> m ()

table :: Table t => Handle m t -> t

printVersions :: MonadBase IO m => m ()

showFeed :: MonadThrow m => Handle m -> Handle m FeedTable -> [FeedID] -> m ()

Print database status for given feed(s)

subscribe :: MonadCatch m => Handle m -> Handle m FeedTable -> URI -> Set Text -> m ()

Register the given feed URI in database

check :: (MonadAsync m, MonadCatch m) => Handle m -> Handle m FeedTable -> Handle m -> Handle m -> [FeedID] -> m ()

Check for unread elements without processing them

run :: (MonadTime m, MonadAsync m, MonadCatch m) => Handle m -> Handle m FeedTable -> Handle m -> Handle m -> Handle m -> [FeedID] -> m ()

importOPML :: MonadCatch m => Handle m -> Handle m FeedTable -> ConduitT () ByteString m () -> m ()

subscribe to all feeds described by the OPML document provided in input

imm :: Handle IO -> Handle IO FeedTable -> Handle IO -> Handle IO -> Handle IO -> IO ()

Main function, meant to be used in your personal configuration file.

Here is an example:

import           Imm.Boot
import           Imm.Database.JsonFile as Database
import           Imm.Feed
import           Imm.Hooks.SendMail as Hooks
import           Imm.HTTP.Simple as HTTP
import           Imm.Logger.Simple as Logger
import           Imm.XML.Conduit as XML

main :: IO ()
main = do
  logger     <- Logger.mkHandle <$> defaultLogger
  database   <- Database.mkHandle <$> defaultDatabase
  httpClient <- HTTP.mkHandle <$> defaultManager

  imm logger database httpClient hooks xmlParser

xmlParser :: XML.Handle IO
xmlParser = XML.mkHandle defaultXmlParser

hooks :: Hooks.Handle IO
hooks = Hooks.mkHandle $ SendMailSettings smtpServer formatMail

formatMail :: FormatMail
formatMail = FormatMail
  (\a b -> (defaultFormatFrom a b) { addressEmail = "user@host" } )
  defaultFormatSubject
  defaultFormatBody
  (\_ _ -> [Address Nothing "user@host"])

smtpServer :: Feed -> FeedElement -> SMTPServer
smtpServer _ _ = SMTPServer
  (Just $ Authentication PLAIN "user" "password")
  (StartTls "smtp.host" defaultSettingsSMTPSTARTTLS)