diff --git a/AUTHORS b/AUTHORS new file mode 100644 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +The Freepost community . Specifically, the following people: + +fr33domlover diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,6 @@ +If you have a local clone of the repository, you can see a detailed list of +changes using: + + $ git log + +There is also a web interface in NotABug which can display commit history. diff --git a/INSTALL b/INSTALL new file mode 100644 --- /dev/null +++ b/INSTALL @@ -0,0 +1,13 @@ +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/NEWS b/NEWS new file mode 100644 --- /dev/null +++ b/NEWS @@ -0,0 +1,23 @@ +This file lists the user-visible interesting changes between releases. For a +full list of changes to the source, see the ChangeLog. + + + +funbot 0.1.0.0 -- 0.1.0.0 +========================= + +General, build and documentation changes: + +* (This is the first release, so everything is new) + +New APIs, 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 new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# funbot + +An IRC bot for learning, fun and collaboration in the Freepost community. +There is a project page [here][proj]. + +## Using + +See the .cabal file for more info and link to project website and version +control. + +The official download location is the Git repository: + + + +Occasionally, releases may be made to Hackage, the Haskell package repository. +See . + +Some of the dependency libraries may have recent features not released to +Hackage yet. See the guide linked at the bottom for their clone URLs. If you +use a released version of funbot, you can safely install all the dependencies +from Hackage as usual. + +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'. + +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. + +## Reporting Bugs and Suggesting Features + +If you found a bug, or you have an idea, a feature request or a wishlist item, +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. + +## 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]. + +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 +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/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/funbot.cabal b/funbot.cabal new file mode 100644 --- /dev/null +++ b/funbot.cabal @@ -0,0 +1,74 @@ +name: funbot +version: 0.1.0.0 +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 + the serious features IRC bots provide, but we could develop an IRC bot + collaboratively, for fun and for learning new skills and languages! I also + thought this is a great chance for people to quickly see their code in real + use, which is motivating when learning programming, and it's a chance to + introduce Haskell to the community. + . + While the bot is made for and by the community, + it is fully intended for use any anyone else! For experienced Haskell + developers, this bot can perhaps provide space for creativity and custom + advanced plugins and features. + . + Since this bot is meant for collaborative development while really running + it, the running instance in @#freepost@ is built from the git repository. + 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/ +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 +build-type: Simple +extra-source-files: AUTHORS ChangeLog COPYING INSTALL NEWS README.md +cabal-version: >=1.10 + +source-repository head + type: git + location: https://notabug.org/fr33domlover/funbot.git + +executable funbot + main-is: Main.hs + other-modules: FunBot.Commands + , FunBot.Config + , FunBot.ExtHandlers + , FunBot.IrcHandlers + , FunBot.Memos + , FunBot.Settings + , FunBot.Sources + , FunBot.Sources.FeedWatcher + , FunBot.Sources.WebListener + , FunBot.Sources.WebListener.Client + , FunBot.Sources.WebListener.Gogs + , FunBot.Sources.WebListener.GitLab + , FunBot.Types + , FunBot.Util + -- other-extensions: + build-depends: aeson + , base >=4.7 && <5 + , bytestring + , feed + , feed-collect + , HTTP + , http-listen + , irc-fun-bot >=0.2 + , irc-fun-color + , network-uri + , settings + , text + , time + , time-interval + , time-units + , transformers + , unordered-containers >=0.2.5 + , vcs-web-hook-parse + hs-source-dirs: src + default-language: Haskell2010 diff --git a/src/FunBot/Commands.hs b/src/FunBot/Commands.hs new file mode 100644 --- /dev/null +++ b/src/FunBot/Commands.hs @@ -0,0 +1,223 @@ +{- This file is part of funbot. + - + - Written in 2015 by fr33domlover . + - + - ♡ Copying is an act of love. Please copy, reuse and share. + - + - The author(s) have dedicated all copyright and related and neighboring + - rights to this software to the public domain worldwide. This software is + - distributed without any warranty. + - + - You should have received a copy of the CC0 Public Domain Dedication along + - with this software. If not, see + - . + -} + +module FunBot.Commands + ( commandSet + ) +where + +import Data.List (find, intercalate) +import Data.Settings.Types (showOption) +import FunBot.Memos (submitMemo) +import FunBot.Settings +import FunBot.Types (BotSession) +import Network.IRC.Fun.Bot.Behavior +import Network.IRC.Fun.Bot.Chat +import Network.IRC.Fun.Bot.Types +import Text.Printf (printf) + +-- | The main command set, the only one currently +commandSet = CommandSet + { prefix = '!' + , commands = + [ makeCmdHelp commandSet + , cmdInfo + , cmdEcho + , cmdTell + , cmdGet + , cmdSet + , cmdReset + , cmdEnable + , cmdDisable + ] + } + +------------------------------------------------------------------------------- +-- Echo command +-- Send the input back to the IRC channel +------------------------------------------------------------------------------- + +respondEcho :: String -> String -> [String] -> BotSession () +respondEcho chan _ [] = sendToChannel chan " " +respondEcho chan _ [param] = sendToChannel chan param +respondEcho chan _ params = sendToChannel chan $ 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." + } + +------------------------------------------------------------------------------- +-- Help command +-- Show command help strings +------------------------------------------------------------------------------- + +respondHelp :: CommandSet e s -> String -> String -> [String] -> BotSession () +respondHelp cset chan _ [cname] = + case find (any (== cname) . names) $ commands cset of + Just cmd -> sendToChannel chan $ + help cmd + ++ "\nCommand names: " + ++ listNames Nothing Nothing True (names cmd) + Nothing -> sendToChannel chan "No such command, try just ‘help’ \ + \without a parameter." +respondHelp cset chan _ _ = + sendToChannel chan $ + help (makeCmdHelp cset) + ++ "\nAvailable commands: " + ++ listPrimaryNames (Just $ prefix cset) Nothing False (commands cset) + +makeCmdHelp cset = Command + { names = ["help", "h", "?"] + , respond = respondHelp cset + , help = "‘help []’ - display help for the given command. \ + \Passing no parameters, or passing 2 or more, displays the \ + \general help (i.e. this text)." + } + +------------------------------------------------------------------------------- +-- Info command +-- Ask the bot to display some information +------------------------------------------------------------------------------- + +respondInfo :: String -> String -> [String] -> BotSession () +respondInfo chan _ ["intro"] = sendToChannel chan $ + "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 chan _ ["features"] = sendToChannel chan $ + "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 chan _ ["contrib"] = sendToChannel chan $ + "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 chan _ ["copying"] = sendToChannel chan $ + "♡ Copying is an act of love. Please copy, reuse and share me! \ + \Grab a copy of me from ." +respondInfo chan _ ["links"] = sendToChannel chan $ + "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 chan nick [arg] = + failToChannel chan nick $ InvalidArg (Just 1) (Just arg) +respondInfo chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) (Just 1) + +cmdInfo = Command + { names = ["info", "i"] + , respond = respondInfo + , help = "‘info ( intro | features | contrib | copying | links)’ - \ + \display information." + } + +------------------------------------------------------------------------------- +-- Tell command +-- Tell something to some other user +------------------------------------------------------------------------------- + +respondTell :: String -> String -> [String] -> BotSession () +respondTell chan sender (recip:msghead:msgtail) = + submitMemo sender (Just chan) recip (unwords $ msghead : msgtail) +respondTell chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) Nothing + +cmdTell = Command + { names = ["tell"] + , respond = respondTell + , help = "‘tell ’ - leave a memo for a user to see later" + } + +------------------------------------------------------------------------------- +-- Get, set, enable and disable commands +-- Manage bot settings +------------------------------------------------------------------------------- + +respondGet :: String -> String -> [String] -> BotSession () +respondGet chan _ [] = respondGet' "" chan +respondGet chan _ [path] = respondGet' path chan +respondGet chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) (Just 1) + +respondSet :: String -> String -> [String] -> BotSession () +respondSet chan _ [name, val] = respondSet' name val chan +respondSet chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) (Just 2) + +respondReset :: String -> String -> [String] -> BotSession () +respondReset chan _ [name] = respondReset' name chan +respondReset chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) (Just 1) + +respondBool :: Bool -> String -> String -> [String] -> BotSession () +respondBool val chan _ [name] = respondSet' name (showOption val) chan +respondBool _ chan nick args = + failToChannel chan nick $ WrongNumArgsN (Just $ length args) (Just 1) + +respondEnable = respondBool True + +respondDisable = respondBool False + +cmdGet = Command + { names = ["get"] + , respond = respondGet + , help = "‘get