diff --git a/NEWS b/NEWS --- a/NEWS +++ b/NEWS @@ -3,6 +3,39 @@ +funbot 0.3 -- 2015-10-17 +======================== + +General, build and documentation changes: + +* User options JSON state file +* New !info topics + +New UIs, features and enhancements: + +* New repo event announcement controls: !add-repo, !delete-repo +* Channel commands: !visit, !leave, !join +* Support "please" prefix in bot references +* Minimal quoting feature, !quote command +* Channel history display and user option control commands +* Accept private prefixed and ref+prefix commands +* Respond to "thanks" +* Support /me + +Bug fixes: + +* Warn when sending a memo from an untracked channel + +Dependency changes: + +* Add containers >= 0.5 +* Require irc-fun-bot >= 0.4 +* Require settings >= 0.2.1 + + + + + funbot 0.2 -- 2015-09-22 ======================== diff --git a/default-memos.json b/default-memos.json new file mode 100644 --- /dev/null +++ b/default-memos.json @@ -0,0 +1,1 @@ +{} diff --git a/default-settings.json b/default-settings.json new file mode 100644 --- /dev/null +++ b/default-settings.json @@ -0,0 +1,4 @@ +{ + "repos" : {}, + "feeds" : {} +} diff --git a/default-state.json b/default-state.json new file mode 100644 --- /dev/null +++ b/default-state.json @@ -0,0 +1,4 @@ +{ + "chan-state" : {}, + "chans-join" : [] +} diff --git a/default-user-options.json b/default-user-options.json new file mode 100644 --- /dev/null +++ b/default-user-options.json @@ -0,0 +1,1 @@ +{} diff --git a/funbot.cabal b/funbot.cabal --- a/funbot.cabal +++ b/funbot.cabal @@ -1,5 +1,5 @@ name: funbot -version: 0.2 +version: 0.3 synopsis: IRC bot for fun, learning, creativity and collaboration. description: One day an idea came up on the #freepost IRC channel: We didn't need much of @@ -28,7 +28,17 @@ copyright: ♡ Copying is an act of love. Please copy, reuse and share. category: Network build-type: Simple -extra-source-files: AUTHORS ChangeLog COPYING INSTALL NEWS README.md +extra-source-files: + AUTHORS + ChangeLog + COPYING + INSTALL + NEWS + README.md + default-memos.json + default-settings.json + default-state.json + default-user-options.json cabal-version: >=1.10 source-repository head @@ -40,6 +50,7 @@ other-modules: FunBot.Commands , FunBot.Config , FunBot.ExtHandlers + , FunBot.History , FunBot.IrcHandlers , FunBot.Memos , FunBot.Settings @@ -50,11 +61,13 @@ , FunBot.Sources.WebListener.Gogs , FunBot.Sources.WebListener.GitLab , FunBot.Types + , FunBot.UserOptions , FunBot.Util -- other-extensions: build-depends: aeson , base >=4.7 && <5 , bytestring + , containers >=0.5 , feed , feed-collect , funbot-ext-events @@ -62,11 +75,11 @@ , http-client >=0.4.19 , http-client-tls >=0.2.2 , http-listen - , irc-fun-bot >=0.3 && <0.4 + , irc-fun-bot >=0.4 && <0.5 , irc-fun-color , json-state , network-uri - , settings + , settings >=0.2.1 , tagsoup >=0.13 , text , time diff --git a/src/FunBot/Commands.hs b/src/FunBot/Commands.hs --- a/src/FunBot/Commands.hs +++ b/src/FunBot/Commands.hs @@ -21,18 +21,22 @@ import Control.Monad (unless) import Data.List (find, intercalate) import Data.Settings.Types (showOption) +import FunBot.History (quote) import FunBot.Memos (submitMemo) import FunBot.Settings import FunBot.Types (BotSession) +import FunBot.UserOptions import Network.IRC.Fun.Bot.Behavior import Network.IRC.Fun.Bot.Chat +import Network.IRC.Fun.Bot.State import Network.IRC.Fun.Bot.Types import Text.Printf (printf) +import Text.Read (readMaybe) -- | The main command set, the only one currently commandSet = CommandSet - { prefix = '!' - , commands = + { csetPrefix = '!' + , csetCommands = [ makeCmdHelp commandSet , cmdInfo , cmdEcho @@ -43,6 +47,19 @@ , cmdReset , cmdEnable , cmdDisable + , cmdAddSpec + , cmdDeleteSpec + , cmdAddRepo + , cmdDeleteRepo + , cmdVisit + , cmdJoin + , cmdLeave + , cmdQuote + , cmdShowOpts + , cmdEnableHistory + , cmdDisableHistory + , cmdSetLines + , cmdEraseOpts ] } @@ -56,10 +73,10 @@ respondEcho _mchan _nick params send = send $ unwords params cmdEcho = Command - { names = ["echo"] - , respond = respondEcho - , help = "‘echo ’ - display the given text. Probably not a \ - \useful command. Exists as an example and for testing." + { cmdNames = ["echo"] + , cmdRespond = respondEcho + , cmdHelp = "‘echo ’ - display the given text. Probably not a \ + \useful command. Exists as an example and for testing." } ------------------------------------------------------------------------------- @@ -69,34 +86,38 @@ -- Return a response function given a CommandSet respondHelp cset _mchan _nick [cname] send = - case find ((cname' `elem`) . names) $ commands cset of - Just cmd -> send $ help cmd + case find ((cname' `elem`) . cmdNames) $ csetCommands cset of + Just cmd -> send $ cmdHelp cmd ++ "\nCommand names: " - ++ listNames Nothing Nothing True (names cmd) + ++ listNames Nothing Nothing True (cmdNames cmd) Nothing -> do succ <- respondSettingsHelp cname send unless succ $ send $ printf "No such command, or invalid settings path. \ \Maybe try just ‘%vhelp’ without a parameter." - (prefix cset) + (csetPrefix cset) where cname' = case cname of [] -> cname - (c:cs) -> if c == prefix cset then cs else cname + (c:cs) -> if c == csetPrefix cset then cs else cname respondHelp cset _mchan _nick _params send = - send $ help (makeCmdHelp cset) + send $ cmdHelp (makeCmdHelp cset) ++ "\nAvailable commands: " - ++ listPrimaryNames (Just $ prefix cset) Nothing False (commands cset) + ++ listPrimaryNames + (Just $ csetPrefix cset) + Nothing False + (csetCommands cset) makeCmdHelp cset = Command - { names = ["help", "Help", "h", "?"] - , respond = respondHelp cset - , help = "‘help [ | ]’ - display help for the given \ - \command or settings option/section.\n\ - \FunBot intends to provide interactive help, but some topics \ - \may be missing. If that's the case, check out the user \ - \manual (call ‘!info links’ for the URL) or ask in #freepost." + { cmdNames = ["help", "Help", "h", "?"] + , cmdRespond = respondHelp cset + , cmdHelp = + "‘help [ | ]’ - display help for the given \ + \command or settings option/section. Also see ‘info’.\n\ + \FunBot intends to provide interactive help, but some topics \ + \may be missing. If that's the case, check out the user \ + \manual (call ‘!info links’ for the URL) or ask in #freepost." } ------------------------------------------------------------------------------- @@ -104,49 +125,115 @@ -- Ask the bot to display some information ------------------------------------------------------------------------------- -respondInfo _mchan _nick ["intro"] send = send $ - "I’m fpbot. An instance of funbot, written in Haskell. I run in #freepost \ - \(and some extra channels). Developed in the Freepost community, I exist \ - \for fun, collaboration and learning. But I also aim to provide useful \ - \tools, in particular to Freepost and related projects and communities.\n\ - \You can start by trying ‘!help’." -respondInfo _mchan _nick ["features"] send = send $ - "This is a high-level list of features and subsystems I provide. It will \ - \hopefully be kept up-to-date by updating it every time new features are \ - \added.\n\ - \• Help and information system (!help, !info)\n\ - \• A settings system (!get, !set, etc.)\n\ - \• Announcing commits in Git repositories\n\ - \• Announcing RSS/Atom feed items\n\ - \• Leaving memos (requires enabling nick tracking for the channel)\n\ - \There is also an overview of the bot API features, useful to \ - \contributors/developers, in the guide at \ - \." -respondInfo _mchan _nick ["contrib"] send = send $ - "Thinking about contributing to my development? Opening a ticket, fixing \ - \a bug, implementing a feature? Check out the project page at \ - \, which links to the contribution \ - \guide, to the tickets page and more." -respondInfo _mchan _nick ["copying"] send = send $ - "♡ Copying is an act of love. Please copy, reuse and share me! \ - \Grab a copy of me from ." -respondInfo _mchan _nick ["links"] send = send $ - "Website: http://rel4tion.org/projects/funbot\n\ - \Code: https://notabug.org/fr33domlover/funbot\n\ - \Tickets: http://rel4tion.org/projects/funbot/tickets\n\ - \Roadmap: http://rel4tion.org/projects/funbot/ideas\n\ - \Dev guide: http://rel4tion.org/projects/funbot/guide\n\ - \User manual: http://rel4tion.org/projects/funbot/manual" -respondInfo mchan nick [arg] _send = - failBack mchan nick $ InvalidArg (Just 1) (Just arg) +topics = + [ ( "intro" + , "I’m fpbot. An instance of funbot, written in Haskell. I run in \ + \#freepost (and some extra channels). Developed in the Freepost \ + \community, I exist for fun, collaboration and learning. But I also \ + \aim to provide useful tools, in particular to Freepost and related \ + \projects and communities.\n\ + \You can start by trying ‘!help’." + ) + , ( "features" + , "This is a high-level list of features and subsystems I provide. It \ + \will hopefully be kept up-to-date by updating it every time new \ + \features are added.\n\ + \• Help and information system (!help, !info)\n\ + \• A settings system (!get, !set, etc.)\n\ + \• Announcing commits, tags, merge requests, etc. in Git \ + \repositories\n\ + \• Announcing RSS/Atom feed items\n\ + \• Leaving memos (requires enabling nick tracking for the channel)\n\ + \• Announcing titles of URLs\n\ + \• Logging and reporting channel activity\n\ + \• Accepting events via an HTTP API, e.g. pastes added to a paste \ + \bin\n\ + \There is also an overview of the bot API features, useful to \ + \contributors/developers, in the guide at \ + \." + ) + , ( "contrib" + , "Thinking about contributing to my development? Opening a ticket, \ + \fixing a bug, implementing a feature? Check out the project page at \ + \, which links to the \ + \contribution guide, to the tickets page and more." + ) + , ( "copying" + , "♡ Copying is an act of love. Please copy, reuse and share me! Grab a \ + \copy of me from ." + ) + , ( "links" + , "Website: http://rel4tion.org/projects/funbot\n\ + \Code: https://notabug.org/fr33domlover/funbot\n\ + \Tickets: http://rel4tion.org/projects/funbot/tickets\n\ + \Roadmap: http://rel4tion.org/projects/funbot/ideas\n\ + \Dev guide: http://rel4tion.org/projects/funbot/guide\n\ + \User manual: http://rel4tion.org/projects/funbot/manual" + ) + , ( "git-ann" + , "I can announce development related events, such as git commits and \ + \merge requests. To see the list of repos being announced and their \ + \settings, run ‘!get repos’. Each repo has a list of specifications, \ + \one per target channel (most projects announce to a single channel, \ + \some announce to two). You can modify the spec details using the \ + \settings system (!get, !set, etc.). To add a new spec (channel) to \ + \an existing repo, use the !add-spec command. To remove a spec, use \ + \!delete-spec. To add and remove repos, use !add-repo and \ + \!delete-repo respectively." + ) + , ( "feeds" + , "TODO" + ) + , ( "memos" + , "TODO" + ) + , ( "channels" + , "Using bot commands, you can ask me to leave and join channels. The \ + \list of channels I'm present in can therefore be controlled \ + \dynamically. However, there is also an additional list of channels \ + \in my configuration (in the source). Using !visit, you can ask me to \ + \briefly join a channel. But I won't remember it next time. To make \ + \me a permanent member, use !join. You can ask me to leave a channel \ + \using !leave." + ) + , ( "chan-history" + , "When you join a channel, I can send you the last messages sent there \ + \so that you’ll know what was happenig before you came. You can \ + \enable this per channel, and set the number of last messages you’d \ + \like to see per channel. Note that the number of messages you’ll get \ + \also depends on how many messages I myself remember for this \ + \purpose (which is set in the Config.hs source file). See \ + \‘!info user-options’ for usage instructions." + ) + , ( "user-options" + , "I keep private per-user options which affect our interaction. These \ + \options are /separate/ from the public settings system. The commands \ + \for managing them are available only in private messages to me, and \ + \don't work in IRC channels. You can view your preferences using \ + \!show-opts. Edit them using !enable-history, !disable-history and \ + \!set-history-lines. Reset them to defaults using !erase-opts." + ) + , ( "quotes" + , "See the !quote command. It works, but quotes aren’t being \ + \automatically published, so perhaps it isn’t very useful at the \ + \moment. Perhaps unless you setup the publishing yourself." + ) + ] + +respondInfo _mchan _nick [] send = + send $ "Topics: " ++ intercalate ", " (map fst topics) +respondInfo mchan nick [arg] send = + case lookup arg topics of + Just msg -> send msg + Nothing -> failBack mchan nick $ InvalidArg (Just 1) (Just arg) respondInfo mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 1) + failBack mchan nick $ WrongNumArgsN (Just $ length args) Nothing cmdInfo = Command - { names = ["info", "i"] - , respond = respondInfo - , help = "‘info ( intro | features | contrib | copying | links)’ - \ - \display information." + { cmdNames = ["info", "i"] + , cmdRespond = respondInfo + , cmdHelp = "‘info’ - list topics. Also see ‘help’.\n\ + \‘info ’ - display topic information." } ------------------------------------------------------------------------------- @@ -161,27 +248,29 @@ failBack mchan nick $ WrongNumArgsN (Just $ length args) Nothing cmdPTell = Command - { names = ["tell", "ptell"] - , respond = respondTell True - , help = "‘tell ’ - leave a memo for a user to see later. \ - \Memos can be sent to the recipient privately, or publicly \ - \in the channel in which they were submitted. With this \ - \command, the memo will be sent privately. If that isn't your \ - \intention, see the ctell command." + { cmdNames = ["tell", "ptell"] + , cmdRespond = respondTell True + , cmdHelp = + "‘tell ’ - leave a memo for a user to see later. \ + \Memos can be sent to the recipient privately, or publicly \ + \in the channel in which they were submitted. With this \ + \command, the memo will be sent privately. If that isn't your \ + \intention, see the ctell command." } cmdCTell = Command - { names = ["ctell"] - , respond = respondTell False - , help = "‘tell ’ - leave a memo for a user to see later. \ - \Memos can be sent to the recipient privately, or publicly \ - \in the channel in which they were submitted. With this \ - \command, the memo will be sent in the same way it was \ - \submitted: If you submit it in a channel, it will be sent to \ - \the recipient in the same channel. If you submit using a \ - \private message to me, I will also send it privately to the \ - \recipient.\n\ - \If that isn't your intention, see the tell command." + { cmdNames = ["ctell"] + , cmdRespond = respondTell False + , cmdHelp = + "‘tell ’ - leave a memo for a user to see later. \ + \Memos can be sent to the recipient privately, or publicly \ + \in the channel in which they were submitted. With this \ + \command, the memo will be sent in the same way it was \ + \submitted: If you submit it in a channel, it will be sent to \ + \the recipient in the same channel. If you submit using a \ + \private message to me, I will also send it privately to the \ + \recipient.\n\ + \If that isn't your intention, see the tell command." } ------------------------------------------------------------------------------- @@ -213,36 +302,293 @@ respondDisable = respondBool False cmdGet = Command - { names = ["get"] - , respond = respondGet - , help = "‘get