diff --git a/NEWS.md b/NEWS.md --- a/NEWS.md +++ b/NEWS.md @@ -3,6 +3,57 @@ +funbot 0.5 -- 2016-01-27 +======================== + +General, build and documentation changes: + +* Move the code from `String` everywhere into strict `Text`, often wrapped in + dedicated semantic `newtype`s for more type safety (since so many values are + just text otherwise) and for readability + +New UIs, features and enhancements: + +* Send history-on-join as a notice +* Log web source errors into a file instead of stdout +* Merge request announcements mention repo name +* Add issue ext event announcements +* Add note ext event announcements +* Return an HTTP response to gitlab web hook, it seems to want it +* TLS now implemented in `irc-fun-client` +* Key-URL map for which link references +* Puppet system for relaying arbitrary messages +* More goodies... :) + +Bug fixes: + +* Git repo names and usernames are now compared in a case-insensitive manner, + which allows them to be specified in a human-friendly form while also + accepting all-lowercase versions used in generated URLs. Previously this + caused issues with !add-repo because of hacks made in an attempt to make + hashmaps pseudo-ignore letter case. +* Display and store repo IDs as `user/repo` and not `repo/user`. The latter + seems to be confusing since git repo URLs use the former. +* When `!get`ing a settings section, display the section and option lists in + sorted order. It's consistent and easier to find items with the eyes. + +Dependency changes: + +* Add case-insensitive >= 1 + formatting >= 6.2 + hashable + irc-fun-client >= 0.5 + irc-fun-types <0.2 +* Require funbot-ext-events >= 0.3 + irc-fun-bot >= 0.6 + irc-fun-color >= 0.2 + settings >= 0.3 + vcs-web-hook-parse >= 0.2 + + + + + funbot 0.4.0.1 -- 2015-12-17 ============================ diff --git a/funbot.cabal b/funbot.cabal --- a/funbot.cabal +++ b/funbot.cabal @@ -1,5 +1,5 @@ name: funbot -version: 0.4.0.1 +version: 0.5 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 @@ -48,13 +48,38 @@ executable funbot main-is: Main.hs other-modules: FunBot.Commands + , FunBot.Commands.Channels + , FunBot.Commands.Feeds + , FunBot.Commands.History + , FunBot.Commands.Info + , FunBot.Commands.Locations + , FunBot.Commands.Memos + , FunBot.Commands.Misc + , FunBot.Commands.Puppet + , FunBot.Commands.Repos + , FunBot.Commands.Settings + , FunBot.Commands.Shortcuts + , FunBot.Commands.UserOptions , FunBot.Config , FunBot.ExtHandlers , FunBot.History , FunBot.IrcHandlers , FunBot.KnownNicks + , FunBot.Locations , FunBot.Memos + , FunBot.Puppet , FunBot.Settings + , FunBot.Settings.Help + , FunBot.Settings.Instances + , FunBot.Settings.MkOption + , FunBot.Settings.Sections + , FunBot.Settings.Sections.Channels + , FunBot.Settings.Sections.DevHosts + , FunBot.Settings.Sections.Feeds + , FunBot.Settings.Sections.Locations + , FunBot.Settings.Sections.Repos + , FunBot.Settings.Sections.Shortcuts + , FunBot.Settings.Persist , FunBot.Sources , FunBot.Sources.FeedWatcher , FunBot.Sources.Loopback @@ -62,6 +87,7 @@ , FunBot.Sources.WebListener.Client , FunBot.Sources.WebListener.Gogs , FunBot.Sources.WebListener.GitLab + , FunBot.Sources.WebListener.Util , FunBot.Types , FunBot.UserOptions , FunBot.Util @@ -70,21 +96,26 @@ , auto-update , base >=4.7 && <5 , bytestring + , case-insensitive >=1 , clock >=0.5 , containers >=0.5 , data-default-class , feed , feed-collect >=0.2 - , funbot-ext-events >=0.2 + , formatting >=6.2 + , funbot-ext-events >=0.3 + , hashable , HTTP , http-client >=0.4.19 , http-client-tls >=0.2.2 , http-listen - , irc-fun-bot >=0.5 && <0.6 - , irc-fun-color + , irc-fun-bot >=0.6 && <0.7 + , irc-fun-client >=0.5 && <0.6 + , irc-fun-color >=0.2 && <0.3 + , irc-fun-types <0.2 , json-state , network-uri - , settings >=0.2.2 + , settings >=0.3 , tagsoup >=0.13 , text , time @@ -93,6 +124,6 @@ , transformers , unordered-containers >=0.2.5 , utf8-string >=1 - , vcs-web-hook-parse + , vcs-web-hook-parse >=0.2 hs-source-dirs: src default-language: Haskell2010 diff --git a/src/FunBot/Commands.hs b/src/FunBot/Commands.hs --- a/src/FunBot/Commands.hs +++ b/src/FunBot/Commands.hs @@ -1,6 +1,6 @@ {- This file is part of funbot. - - - Written in 2015 by fr33domlover . + - Written in 2015, 2016 by fr33domlover . - - ♡ Copying is an act of love. Please copy, reuse and share. - @@ -13,26 +13,27 @@ - . -} +{-# LANGUAGE OverloadedStrings #-} + module FunBot.Commands ( commandSet ) where -import Control.Monad (unless, when) -import Data.List (find, intercalate) -import Data.Settings.Types (showOption) -import FunBot.History (quote, reportHistory') -import FunBot.Memos (submitMemo) -import FunBot.Settings -import FunBot.Types (BotSession) -import FunBot.UserOptions -import FunBot.Util (getHistoryLines) -import Network.IRC.Fun.Bot.Behavior -import Network.IRC.Fun.Bot.Chat -import Network.IRC.Fun.Bot.State +import FunBot.Commands.Channels +import FunBot.Commands.Feeds +import FunBot.Commands.History +import FunBot.Commands.Info +import FunBot.Commands.Locations +import FunBot.Commands.Memos +import FunBot.Commands.Misc +import FunBot.Commands.Puppet +import FunBot.Commands.Repos +import FunBot.Commands.Settings +import FunBot.Commands.Shortcuts +import FunBot.Commands.UserOptions +import FunBot.Types import Network.IRC.Fun.Bot.Types -import Text.Printf (printf) -import Text.Read (readMaybe) -- | The main command set, the only one currently commandSet = CommandSet @@ -66,706 +67,16 @@ , cmdShowHistory , cmdAddFeed , cmdDeleteFeed + , cmdWhere + , cmdWhereLocal + , cmdWhereGlobal + , cmdAddWhereLocal + , cmdRemoveWhereLocal + , cmdAddWhereGlobal + , cmdRemoveWhereGlobal + , cmdPuppetStart + , cmdPuppetEnd + , cmdPuppetSay + , cmdPuppetEcho ] - } - -------------------------------------------------------------------------------- --- Echo command --- Send the input back to the IRC channel -------------------------------------------------------------------------------- - -respondEcho _mchan _nick [] send = send " " -respondEcho _mchan _nick [param] send = send param -respondEcho _mchan _nick params send = send $ unwords params - -cmdEcho = Command - { cmdNames = ["echo"] - , cmdRespond = respondEcho - , cmdHelp = "‘echo ’ - display the given text. Probably not a \ - \useful command. Exists as an example and for testing." - } - -------------------------------------------------------------------------------- --- Help command --- Show command help strings -------------------------------------------------------------------------------- - -respondHelp _mchan _nick [cname] send = - case find ((cname' `elem`) . cmdNames) $ csetCommands commandSet of - Just cmd -> send $ cmdHelp cmd - ++ "\nCommand names: " - ++ listNames Nothing Nothing True (cmdNames cmd) - Nothing -> do - succ <- respondSettingsHelp cname send - unless succ $ send - "No such command, or invalid settings path. \ - \Maybe try just ‘!help’ without a parameter." - where - cname' = case cname of - [] -> cname - (c:cs) -> if c == csetPrefix commandSet then cs else cname - -respondHelp _mchan nick _params send = - send "!info intro - about me\n\ - \!info commands - how to ask me to do things\n\ - \!info - list of help/information topics\n\ - \!help help - how to use this command\n\ - \All of these work both in channels and in private messages to me." - -cmdHelp' = Command - { cmdNames = ["help", "Help", "h", "?"] - , cmdRespond = respondHelp - , 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." - } - -------------------------------------------------------------------------------- --- Info command --- Ask the bot to display some information -------------------------------------------------------------------------------- - -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\ - \• Expanding shortcuts (e.g. easily get a bug URL by its ID)\n\ - \• Logging and reporting channel activity\n\ - \• Welcoming new users\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 issues page and more." - ) - , ( "copying" - , "♡ Copying is an act of love. Please copy, reuse and share me! Grab a \ - \copy of me from ." - ) - , ( "links" - , "Website: https://notabug.org/fr33domlover/funbot\n\ - \Issues: https://notabug.org/fr33domlover/funbot/issues\n\ - \Dev guide: https://notabug.org/fr33domlover/funbot/src/master/INSTALL.md\n\ - \User manual: http://rel4tion.org/projects/funbot/manual" - ) - , ( "commands" - , "A bot command is a specially formatted message sent either into an \ - \IRC channel, or privately to me. Such a message specifies at least \ - \the command name and a possibly empty list of whitespace-separated \ - \parameters. Commands may have more than one name, e.g. the ‘help’ \ - \command also has an alias ‘h’, among others. To see the details \ - \about which parameters a specific command takes, which name aliases \ - \it has and what it does, use ‘!help ’.\n\ - \A command can be sent to me using a message starting with a command \ - \prefix, e.g. ‘!echo hello’, or by starting a message with my \ - \nickname, e.g. ‘funbot: echo hello’. Some commands work only when \ - \used in a channel, some work only privately, some work in both \ - \cases.\n\ - \Use the ‘!info’ command to explore various aspects and features I \ - \provide. Both !help and !info can be used privately.\n\ - \Available commands: " ++ - unwords (map (head . cmdNames) $ csetCommands commandSet) - ) - , ( "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" - , "I can periodically visit news feeds (Atom, RSS, etc.) and report new \ - \items to IRC channels. You can add and remove feeds using !add-feed \ - \and !delete-feed respectively. You can use the settings system \ - \(!get, !set, etc.) to control feed item display: activate and \ - \deactivate feeds, change feed URLs, choose IRC channels in which new \ - \items of a given feed are reported and control which information is \ - \shown about new feed items reported." - ) - , ( "memos" - , "You can leave a message for an offline user, and I will send them \ - \the message when they come back. I can send them the message \ - \privately or in the same channel you sent it to me. See the !tell \ - \and !ctell commands. If you leave a memo for an online user, I will \ - \send it to them instantly instead of storing it for later - but for \ - \that to work, channel user list tracking needs to be enabled in my \ - \settings for the relevant channel(s)." - ) - , ( "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 happening 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 my data files). See ‘!info user-options’ \ - \for usage instructions. If you'd like to see channel history once, \ - \without enabling the automatic service, see ‘!help show-history’." - ) - , ( "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." - ) - , ( "shortcuts" - , "I can detect special strings in your messages and send longer forms \ - \of them, allowing you to define shortcuts. For example, you can \ - \mention a bug ID and I will send a bug tracker URL for that bug. I \ - \detect shortcuts by their prefix: Once you define a string, \ - \I find occurrences of in channel messages, and resend \ - \ into the channel, with and strings \ - \surrounding it, thus expanding the shortcut. For example, if \ - \=BUG =http://bug.org/ =.html, then if you \ - \send a message containing BUG142, I will send \ - \http://bug.org/142.html into the channel. See the !add-shortcut and \ - \!delete-shortcut commands, and relevant settings." - ) - ] - -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) Nothing - -cmdInfo = Command - { cmdNames = ["info", "i"] - , cmdRespond = respondInfo - , cmdHelp = "‘info’ - list topics. Also see ‘help’.\n\ - \‘info ’ - display topic information." - } - -------------------------------------------------------------------------------- --- Tell command --- Tell something to some other user -------------------------------------------------------------------------------- - --- Given whether to always send privately, return a command response -respondTell priv mchan sender (recip:msghead:msgtail) _send = - submitMemo sender mchan recip priv (unwords $ msghead : msgtail) -respondTell _priv mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) Nothing - -cmdPTell = 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 - { 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." - } - -------------------------------------------------------------------------------- --- Get, set, enable and disable commands --- Manage bot settings -------------------------------------------------------------------------------- - -respondGet _mchan _nick [] send = respondGet' "" send -respondGet _mchan _nick [path] send = respondGet' path send -respondGet mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 1) - -respondSet _mchan _nick [name, val] send = respondSet' name val send -respondSet mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 2) - -respondReset _mchan _nick [name] send = respondReset' name send -respondReset mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 1) - --- Given a boolean, create an enable/disable response accordingly -respondBool val _mchan _nick [name] send = - respondSet' name (showOption val) send -respondBool _val mchan nick args _send = - failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 1) - -respondEnable = respondBool True - -respondDisable = respondBool False - -cmdGet = Command - { cmdNames = ["get"] - , cmdRespond = respondGet - , cmdHelp = "‘get