diff --git a/INSTALL b/INSTALL deleted file mode 100644 --- a/INSTALL +++ /dev/null @@ -1,13 +0,0 @@ -Install from Hackage: - - $ cabal install funbot - -Install from unpacked release tarball or source repo: - - $ cd funbot - $ cabal install - -Just play with it without installing: - - $ cabal build - $ cabal repl diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,273 @@ +# Intro + +This guide explains how to create a setup for running and developing the bot. +Whether you want to just run it, or also develop it and test your changes, this +guide lists the steps. + +Since one of the bot's goals is provide an introductory space for Haskell, it +details all the steps of starting to work with Haskell and provides honts. Even +if you're just starting, this guide is friendly and useful to follow. + +# Programming Interface + +Here is a quick summary of what the bot API offers. It is being developed and +more components will probably be added. + +- Bot commands with multiple prefixes and multiple names +- Reaction to various events: joins, parts, private messages, etc. +- Can run in multiple IRC channels (but on a single IRC server) +- Bot commands can run any I/O (network, files, terminal, etc.) +- Bot commands can run any IRC commands: Join, part, notice, etc. +- Persistent state can be managed by the bot commands while the bot runs +- The state includes a hierarchical central settings system +- Extra event sources: Web listener, newsfeed watcher + +# Haskell + +If you already have the Haskell tools installed, you can skip this section. + +The bot is written in Haskell, a functional programming language. A good place +to start learning it is the +[Haskell Wikibook](https://wikibooks.org/wiki/Haskell). The definition of +Haskell is published in the form of reports, the latest being +the [Haskell 2010 Report](http://haskell.org/onlinereport/haskell2010/). While +learning, and actually in general, a very useful resource to keep open in a +browser tab is the API reference of the `base` package, +[here](http://hackage.haskell.org/package/base#module-list). + +To work with Haskell you'll need 2 primary tools: + +1. GHC - a compiler, interpreter, package manager and more +2. Cabal - project manager for installing packages and packaging your own + +You'll need to install them both. Preferrably *GHC 7.8.4* and +*cabal-install 1.22*. If you use a Debian based distro, you can install them +easily from a [PPA](http://launchpad.net/%7Ehvr/+archive/ghc). Trisquel should +import them for you, so all you need to do is apt-get install. + +For Parabola, check the versions supplied by the distro's packages. +Instructions for more distros can be found online. + +Add `~/.cabal/bin:/opt/cabal/1.22/bin:/opt/ghc/7.8.4/bin` to your PATH. For +example, add this to the bottom of your `.bashrc`: + + # add haskell programs to PATH + export PATH=~/.cabal/bin:/opt/cabal/1.22/bin:/opt/ghc/7.8.4/bin:$PATH + +The Haskell community has: + +- IRC channels on Freenode: `#haskell`, `#haskell-beginners` +- [Mailing lists](https://haskell.org/mailing-lists) +- A [wiki](https://wiki.haskell.org) +- [Hackage](https://hackage.haskell.org), where people upload package releases + +There are 3 types of package repositories you can maintain using Cabal: + +- Global repository for the system. Install there stable programs you are + going to use. This is like like installing distro packages. What you install + there will be available to all users on your system (if you update their + PATH too), like with distro packages. +- User repository just for your system user. You can install there packages you + want to experiment with, or run without installing system-wide. By default, + this is where `cabal install`ed packages go. +- Sandbox for package development. When you use and develop various Haskell + packages, eventually you'll encounter version conflicts. You can avoid the + mess by installing packages into separate sandboxes. When working on several + packages together/with consistent dependencies, they can share a sandbox. + +Update your list of packages: + + $ cabal update + +# Installation + +You can either use a release version, or the latest development version. + +Create a directory for the bot: + + $ mkdir /home/joe/bot + $ cd /home/joe/bot + +The development version many require recent dependency versions which aren't +available on Hackage yet. If building fails, it's probably because you need +those recent versions. These commands will download the dependencies most +likely to be needed. In the same way you can download more. + +If you'll be using the release version, there is no need for this. + +Install Darcs, a version control system. The bot itself is in a Git repository, +but some of these dependencies are in Darcs repositories. You can either +download their files using regular HTTP, e.g. with `wget`) or use Darcs. Since +Darcs is a popular version control system for Haskell projects (and is itself +written in Haskell), the latter option is demonstrated below (just change the +Darcs specific lines if you chose the former option). + +If your distro has a recent enough version (preferrably 2.8.5, maybe 2.8.4 will +work too): + + $ sudo apt-get install darcs + +Otherwise install Darcs from Hackage: + + $ cabal install darcs-2.8.5 + +Get dependency source repos if/as needed: + + $ darcs get http://hub.darcs.net/fr33domlover/irc-fun-messages/ + $ darcs get http://hub.darcs.net/fr33domlover/irc-fun-client/ + $ darcs get http://hub.darcs.net/fr33domlover/irc-fun-bot/ + $ darcs get http://hub.darcs.net/fr33domlover/settings/ + $ git clone https://notabug.org/fr33domlover/funbot-ext-events + +Get the bot itself: + + $ git clone https://notabug.org/fr33domlover/funbot.git + +You now have the latest development version. You can switch to the latest +release version (use `git tag --list` to find out its number), e.g.: + + $ git checkout 0.3 + +Now your bot directory should look like this: + + $ ls /home/joe/bot + funbot + funbot-ext-events + irc-fun-bot + irc-fun-client + irc-fun-messages + settings + +Create a sandbox: + + $ cd funbot + $ cabal sandbox init + +In order for all the extra packages to work in the sandbox, add the local +dependencies you downloaded (if any) as sources: + + $ cabal sandbox add-source ../irc-fun-messages + $ cabal sandbox add-source ../irc-fun-client + $ cabal sandbox add-source ../irc-fun-bot + $ cabal sandbox add-source ../settings + $ cabal sandbox add-source ../funbot-ext-events + +Run `cabal install --only-dependencies` and `cabal build` to build funbot and +its dependencies in the sandbox. + +# Configuration + +The bot has state data in JSON files and in a Haskell source file, +`src/FunBot/Config.hs`. + +Create initial state data: + + $ cd funbot + $ cp -r state-default state + +In the `Config.hs` file there are safe defaults you can use as-is, but you +should probably at least change the bot's nickname. See +[here](http://hackage.haskell.org/package/irc-fun-bot/docs/Network-IRC-Fun-Bot-Types.html#t:Config) +for documentation of the config options. + + $ vim src/FunBot/Config.hs + +You'll need to rebuild the bot for changes in that file to take effect. + +You can also customize the event matching and behavior definitions in +`src/Main.hs`. + +If you make a git commit, make sure you don't commit your personal changes to +the configuration. In particular if you set a nickname password there! + +Rebuild the bot: + + $ cabal build + +Some features (like channel logs and quotes) place files in separate +subdirectories. + + $ mkdir state/chanlogs state/quotes + +# Running and Exploring + +Now you can do things like running it, debugging it, exploring it in the REPL +(i.e. interpreter). + +To run the bot: + + $ cabal run + +You can also run the executable directly: + + $ dist/build/funbot/funbot + +To load the source into the GHCi, the REPL, and play/explore it: + + $ cabal repl + +For the explorers, there is an IRC server package in Haskell, +[hulk](http://hackage.haskell.org/package/hulk). You could run the bot against +a locally running instance of the server. + +# Deployment + +The Git repository contains a shell script `run.sh` you can run in a cron job. +There is also a `supervisord` configuration file. See these files for details. +If you want to run the bot as a separate system user (and not as your own +user), the steps are: + +1. Create a Linux system user with its own home directory. For example, + `/var/lib/ircbot` +2. Edit its PATH (e.g. by creating minimal `.profile` and `.bashrc`) and + install the setup as described above. But you don't need: + - a Cabal sandbox. You can install to the new user's user package + repository. Simply skip the sandbox creation steps. + - Write access to the git repo. Clone the repositories using read-only + access. It's safer not to give this new user write access to its own code, + just in case anything bad happens. +3. Switch to the system user in the terminal and run the bot. Edit the + configuration source file (nickname, password, channels, etc.). Setup the + cron job. +4. When there are updates to the bot or its dependencies, `darcs pull` or + `git pull` them, build/install and relaunch (e.g. + `pkill funbot && dist/build/funbot/funbot &`) + +# Collaboration + +There are basically 3 ways to contribute code: + +- If you prefer to have your code checked by someone else for any reason, you + can create a merge request (i.e. work in a clone or branch). +- Or create a patch with `git format-patch` +- Otherwise, this project just gives commit access to any interested community + member / contributor. + +The details follow. + +## Merge Requests + +The steps are: + +1. Create a branch with your changes +2. Open an issue containing the URL of the branch + +The branch can be in: + +- The upstream funbot repository at NotABug. Feature/wip branches can be added + as needed. +- A repository in NotABug (e.g. your personal clone of funbot) or some other + free-software hosting platform instance online. Merge requests from + proprietary ones, such as githu8, won't be accepted. Please use NotABug or + GNU savannah or Rel4tion's server or your own server or some other + free-as-in-freedom option. + +## Direct Commits + +This means access to pushing to the `master` branch of the upstream repository. +Ask fr33domlover. + +## Patches + +Open an issue in NotABugwith the patch file attached (or post a link to it, if +you host it somewhere else). diff --git a/NEWS b/NEWS deleted file mode 100644 --- a/NEWS +++ /dev/null @@ -1,86 +0,0 @@ -This file lists the user-visible interesting changes between releases. For a -full list of changes to the source, see the ChangeLog. - - - -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 -======================== - -General, build and documentation changes: - -* Some config values moved to Config.hs from other files -* Git repo details moved from Config.hs into JSON file - -New UIs, features and enhancements: - -* Git repo details have settings options and can be partially edited -* Help command now includes settings options -* New bot command !ctell -* Settings and memos JSON files support version control -* Report titles of URLs send into channels -* New external event type, paste - -Bug fixes: - -* Gitlab MR update events not announced to IRC, it's too much channel spam -* Memos are now reported if needed when a user changes their nickname - -Dependency changes: - -* Add funbot-ext-events -* Add json-state -* Require irc-fun-bot >= 0.3 - - - -funbot 0.1 -- 2015-09-11 -======================== - -General, build and documentation changes: - -* (This is the first release, so everything is new) - -New UIs, features and enhancements: - -* (This is the first release, so everything is a new feature) - -Bug fixes: - -* (This is just the first release) - -Dependency changes: - -* (This is the first release) diff --git a/NEWS.md b/NEWS.md new file mode 100644 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,121 @@ +This file lists the user-visible interesting changes between releases. For a +full list of changes to the source, see the ChangeLog. + + + +funbot 0.4 -- 2015-12-17 +======================== + +General, build and documentation changes: + +* (None) + +New UIs, features and enhancements: + +* IRC debug log +* In git push reports, align ellipsis pseudo-commits with real ones +* New feature: Recognize and expand shortcuts in IRC channel messages +* New command !show-history to see channel history any time +* Message counting control settings option +* Colors in settings command output messages +* !add-feed and !delete-feed new commands +* More settings options to control feeds +* Saying titles on/off switch per channel +* Welcome new nicks + +Bug fixes: + +* (None) + +Dependency changes: + +* Add auto-update + clocks >= 0.5 + data-default-class +* Require feed-collect >= 0.2 + irc-fun-bot >= 0.5 + settings >= 0.2.2 + + + +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 +======================== + +General, build and documentation changes: + +* Some config values moved to Config.hs from other files +* Git repo details moved from Config.hs into JSON file + +New UIs, features and enhancements: + +* Git repo details have settings options and can be partially edited +* Help command now includes settings options +* New bot command !ctell +* Settings and memos JSON files support version control +* Report titles of URLs send into channels +* New external event type, paste + +Bug fixes: + +* Gitlab MR update events not announced to IRC, it's too much channel spam +* Memos are now reported if needed when a user changes their nickname + +Dependency changes: + +* Add funbot-ext-events +* Add json-state +* Require irc-fun-bot >= 0.3 + + + +funbot 0.1 -- 2015-09-11 +======================== + +General, build and documentation changes: + +* (This is the first release, so everything is new) + +New UIs, features and enhancements: + +* (This is the first release, so everything is a new feature) + +Bug fixes: + +* (This is just the first release) + +Dependency changes: + +* (This is the first release) diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -22,11 +22,11 @@ This program is free software, and is committed to software freedom. It is released to the public domain using the CC0 Public Domain Dedication. For the -boring "legal" details see the file 'COPYING'. +boring "legal" details see the file `COPYING`. -See the file 'INSTALL' for hints on installation. The file 'ChangeLog' explains -how to see the history log of the changes done in the code. 'NEWS' provides a -friendly overview of the changes for each release. +See the file `INSTALL.md` for a detailed usage and deployment guide. The file +`ChangeLog` explains how to see the history log of the changes done in the +code. `NEWS.md` provides a friendly overview of the changes for each release. ## Reporting Bugs and Suggesting Features @@ -34,25 +34,16 @@ open a ticket for it! Even if you're goint to implement something or try to solve it. -This project uses [Rel4tion][rel4tion]'s [ticket system][rel4tkt]. See the -[project page][proj] for details. - -You *can* open an issue in NotABug if you prefer, and it will then be moved to -Rel4tion's ticket system. But it is generally preferred you use that system -directly. +Use NotABug's issue system. ## User/Contributor Guide There is a detailed guide for running the bot and creating a development setup. -It's [here][guide]. If anything happens and it's unavailable, there is a -(maybe lagging 1-2 hours behind) mirror of the guide source [here][mirror]. +It's in the `INSTALL.md` file. If you're going to implement some feature or fix some bug you found, -**start by opening a ticket** so that other people will know which features are +**start by opening an issue** so that other people will know which features are being developed and who does what. [proj]: http://rel4tion.org/projects/funbot/ [rel4tion]: http://rel4tion.org/ -[rel4tkt]: http://rel4tion.org/tickets/ -[guide]: http://rel4tion.org/projects/funbot/guide/ -[mirror]: https://notabug.org/fr33domlover/Rel4tion-Wiki/src/master/projects/funbot.mdwn diff --git a/default-memos.json b/default-memos.json deleted file mode 100644 --- a/default-memos.json +++ /dev/null @@ -1,1 +0,0 @@ -{} diff --git a/default-settings.json b/default-settings.json deleted file mode 100644 --- a/default-settings.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "repos" : {}, - "feeds" : {} -} diff --git a/default-state.json b/default-state.json deleted file mode 100644 --- a/default-state.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "chan-state" : {}, - "chans-join" : [] -} diff --git a/default-user-options.json b/default-user-options.json deleted file mode 100644 --- a/default-user-options.json +++ /dev/null @@ -1,1 +0,0 @@ -{} diff --git a/funbot.cabal b/funbot.cabal --- a/funbot.cabal +++ b/funbot.cabal @@ -1,5 +1,5 @@ name: funbot -version: 0.3 +version: 0.4 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 @@ -19,26 +19,26 @@ Occasionally releases will be made to Hackage. If you want to be sure you have all the latest features, check out the git repository (and/or ask us to make a release if you think it's been long enough). -homepage: https://notabug.org/fr33domlover/funbot/ -bug-reports: https://notabug.org/fr33domlover/funbot/issues/ +homepage: https://notabug.org/fr33domlover/funbot +bug-reports: https://notabug.org/fr33domlover/funbot/issues license: PublicDomain license-file: COPYING author: The Freepost community, see AUTHORS file maintainer: fr33domlover@riseup.net copyright: ♡ Copying is an act of love. Please copy, reuse and share. -category: Network +category: Network, IRC build-type: Simple extra-source-files: AUTHORS ChangeLog COPYING - INSTALL - NEWS + INSTALL.md + NEWS.md README.md - default-memos.json - default-settings.json - default-state.json - default-user-options.json + state-default/memos.json + state-default/settings.json + state-default/state.json + state-default/user-options.json cabal-version: >=1.10 source-repository head @@ -52,10 +52,12 @@ , FunBot.ExtHandlers , FunBot.History , FunBot.IrcHandlers + , FunBot.KnownNicks , FunBot.Memos , FunBot.Settings , FunBot.Sources , FunBot.Sources.FeedWatcher + , FunBot.Sources.Loopback , FunBot.Sources.WebListener , FunBot.Sources.WebListener.Client , FunBot.Sources.WebListener.Gogs @@ -65,21 +67,24 @@ , FunBot.Util -- other-extensions: build-depends: aeson + , auto-update , base >=4.7 && <5 , bytestring + , clock >=0.5 , containers >=0.5 + , data-default-class , feed - , feed-collect + , feed-collect >=0.2 , funbot-ext-events , HTTP , http-client >=0.4.19 , http-client-tls >=0.2.2 , http-listen - , irc-fun-bot >=0.4 && <0.5 + , irc-fun-bot >=0.5 && <0.6 , irc-fun-color , json-state , network-uri - , settings >=0.2.1 + , settings >=0.2.2 , 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 @@ -18,14 +18,15 @@ ) where -import Control.Monad (unless) +import Control.Monad (unless, when) import Data.List (find, intercalate) import Data.Settings.Types (showOption) -import FunBot.History (quote) +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 @@ -37,7 +38,7 @@ commandSet = CommandSet { csetPrefix = '!' , csetCommands = - [ makeCmdHelp commandSet + [ cmdHelp' , cmdInfo , cmdEcho , cmdPTell @@ -60,6 +61,11 @@ , cmdDisableHistory , cmdSetLines , cmdEraseOpts + , cmdAddShortcut + , cmdDeleteShortcut + , cmdShowHistory + , cmdAddFeed + , cmdDeleteFeed ] } @@ -84,34 +90,31 @@ -- Show command help strings ------------------------------------------------------------------------------- --- Return a response function given a CommandSet -respondHelp cset _mchan _nick [cname] send = - case find ((cname' `elem`) . cmdNames) $ csetCommands cset of +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 $ printf + unless succ $ send "No such command, or invalid settings path. \ - \Maybe try just ‘%vhelp’ without a parameter." - (csetPrefix cset) + \Maybe try just ‘!help’ without a parameter." where cname' = case cname of [] -> cname - (c:cs) -> if c == csetPrefix cset then cs else cname + (c:cs) -> if c == csetPrefix commandSet then cs else cname -respondHelp cset _mchan _nick _params send = - send $ cmdHelp (makeCmdHelp cset) - ++ "\nAvailable commands: " - ++ listPrimaryNames - (Just $ csetPrefix cset) - Nothing False - (csetCommands cset) +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." -makeCmdHelp cset = Command +cmdHelp' = Command { cmdNames = ["help", "Help", "h", "?"] - , cmdRespond = respondHelp cset + , cmdRespond = respondHelp , cmdHelp = "‘help [ | ]’ - display help for the given \ \command or settings option/section. Also see ‘info’.\n\ @@ -145,31 +148,49 @@ \• 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 tickets page and more." + \, 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: 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\ + , "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 \ @@ -182,10 +203,22 @@ \!delete-repo respectively." ) , ( "feeds" - , "TODO" + , "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" - , "TODO" + , "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 \ @@ -198,12 +231,13 @@ ) , ( "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 \ + \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 the Config.hs source file). See \ - \‘!info user-options’ for usage instructions." + \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 \ @@ -218,6 +252,19 @@ \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 = @@ -507,7 +554,7 @@ ------------------------------------------------------------------------------- -- Show-opts, enable-history, disable-history, set-history-lines, --- set-history-lines, erase-opts commands +-- get-history-lines, erase-opts commands -- Manage user options ------------------------------------------------------------------------------- @@ -540,7 +587,14 @@ respondHistory _enable (Just _chan) _nick _args send = send priv respondHistory enable Nothing nick [chan] send = if looksLikeChan chan - then setEnabled nick chan enable + then do + setEnabled nick chan enable + hls <- getHistoryLines chan + when (enable && hls < 1) $ send + "Note that while you enabled personal history display, \ + \history logging is disabled for that channel, therefore you \ + \won't be getting history messages. Ask the bot maintainer(s) \ + \to enable it." else send $ notchan chan respondHistory _enable Nothing nick args _send = failToUser nick $ WrongNumArgsN (Just $ length args) (Just 1) @@ -591,4 +645,127 @@ { cmdNames = ["erase-opts", "erase-options"] , cmdRespond = respondEraseOpts , cmdHelp = "‘erase-opts’ - reset all your options back to defaults." + } + +------------------------------------------------------------------------------- +-- Add-shortcut, delete-shortcut commands +-- Manage shortcuts +------------------------------------------------------------------------------- + +respondAddShortcut mchan nick [label, chan] send = + if looksLikeChan chan + then do + succ <- addShortcut label chan + if succ + then send "Shortcut added." + else failBack mchan nick $ OtherFail + "This shortcut is already registered." + else send $ notchan chan +respondAddShortcut mchan nick args _send = + failBack mchan nick $ WrongNumArgsN (Just $ length args) (Just 2) + +cmdAddShortcut = Command + { cmdNames = ["add-shortcut"] + , cmdRespond = respondAddShortcut + , cmdHelp = "‘add-shortcut