Jump to: navigation, search

Difference between revisions of "IRC bot"

(Added feature req for eclipse help search)
Line 100: Line 100:
  
 
*eclipse help search:
 
*eclipse help search:
  # ~eh .*
+
  # ~eh <search terms?
 
  EclipseHelp = Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={0}
 
  EclipseHelp = Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={0}
 
  EclipseHelp_Reply = {0}: Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={1}
 
  EclipseHelp_Reply = {0}: Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={1}

Revision as of 13:26, 15 April 2007

An IRC bot named KOS-MOS has recently been created using the Eclipse Communication Framework project's Bot Framework. The bot sits in the Freenode IRC Eclipse channels and is intended to help make the lives of everyone in the channel a little easier by being able to access Bugzilla and provide helpful links that users often needs to go to such as the Eclipse platform's APIs.

For any questions, please contact rcjsuen on IRC.

Status

The bot is currently running on ecf.eclipse.org.

Code

Bug 180585 is tracking this issue and we hope to resolve it as soon as possible.

Channels

KOS-MOS is set to autojoin the following channels on Freenode (irc.freenode.net):

  • #easyeclipse
  • #eclipse
  • #eclipse-de
  • #eclipse-dev
  • #eclipse-ecf
  • #eclipse-linux
  • #eclipse-soc

Available Commands

At the moment, the regular expression contained within the plug-in's plugin.xml is:

((~bug|~bug[0-9]+|~bug[0-9]+c[0-9]+|~[0-9]+|~[0-9]+c[0-9]+|~manage|~log|~logs|~about|~paste|~pastebin|~tell .*|~snippet|~snippets|~javadoc|~api|~plugin|~bot|~wtp|~php|~svn|~news|~newsgroup|~cmd|~commands|~help|~g .*|~wiki .*)

To prepend a user's name to the message that the bot will output, use a syntax of ~tell name about item.

If a valid http connection can be made to Bugzilla, the bot will output the bug's summary into its message, otherwise, it will fall back to simply providing a link to the bug.

Below is a list of all possible commands at the moment. This page will be updated as often as possible.

# ~bug
EclipseBugzilla = Eclipse Bugzilla - https://bugs.eclipse.org/bugs/
EclipseBugzilla_Reply = {0}: Eclipse Bugzilla - https://bugs.eclipse.org/bugs/

# ~bug[0-9]+|~[0-9]+
Bug = See bug {0} - {1}
Bug_Reply = {0}: See bug {1} - {2}

# ~bug[0-9]+c[0-9]+|~[0-9]+c[0-9]+
BugContent = Bug {0} - {1} - {2}
BugContent_Reply = {0}: Bug {1} - {2} - {3}

# ~manage
Manage = Manage your Eclipse environment - http://www-128.ibm.com/developerworks/opensource/library/os-ecl-manage/
Manage_Reply = {0}: Manage your Eclipse environment - http://www-128.ibm.com/developerworks/opensource/library/os-ecl-manage/

# ~log|~logs
Logs = Eclipse logs - http://wiki.eclipse.org/index.php/FAQ_Where_can_I_find_that_elusive_.log_file%3F - http://wiki.eclipse.org/index.php/IRC_FAQ#Where_are_Eclipse.27s_log_files_located_at.3F
Logs_Reply = {0}: Eclipse logs - http://wiki.eclipse.org/index.php/FAQ_Where_can_I_find_that_elusive_.log_file%3F - http://wiki.eclipse.org/index.php/IRC_FAQ#Where_are_Eclipse.27s_log_files_located_at.3F

# ~about|~bot
About = I am an IRC bot written by rcjsuen using the ECF bot framework. See http://wiki.eclipse.org/index.php/Bot_Framework
About_Reply = {0}: am an IRC bot written by rcjsuen using the ECF bot framework. See http://wiki.eclipse.org/index.php/Bot_Framework

# ~paste|~pastebin
Pastebin = Please paste the relevant information to a pastebin - http://rafb.net/paste/ - http://pastebin.com - http://pastebin.ca
Pastebin_Reply = {0}: Please paste the relevant information to a pastebin - http://rafb.net/paste/ - http://pastebin.com - http://pastebin.ca

# ~snippet|~snippets
Snippets = SWT Snippets - http://www.eclipse.org/swt/snippets/
Snippets_Reply = {0}: SWT Snippets - http://www.eclipse.org/swt/snippets/

# ~javadoc|~api
Javadoc = The Eclipse Platform APIs are at - http://help.eclipse.org/help32/nftopic/org.eclipse.platform.doc.isv/reference/api/index.html
Javadoc_Reply = {0}: The Eclipse Platform APIs are at - http://help.eclipse.org/help32/nftopic/org.eclipse.platform.doc.isv/reference/api/index.html

# ~plugin
Plugins = Look for plug-ins at the Eclipse Plug-in Central (http://www.eclipseplugincentral.com/) and EclipsePlugins (http://eclipse-plugins.info)
Plugins_Reply = {0}: Look for plug-ins at the Eclipse Plug-in Central (http://www.eclipseplugincentral.com/) and EclipsePlugins (http://eclipse-plugins.info)

# ~wtp
Webtools = Check out Eclipse's Web Tools Platform - http://www.eclipse.org/wtp/
Webtools_Reply = {0}: Check out Eclipse's Web Tools Platform - http://www.eclipse.org/wtp/

# ~php
PHP = Take a look at PDT (http://www.eclipse.org/pdt/) or PHPEclipse (http://www.phpeclipse.de)
PHP_Reply = {0}: Take a look at PDT (http://www.eclipse.org/pdt/) or PHPEclipse (http://www.phpeclipse.de)

# ~svn
Subversion = For Subversion support, try Subclipse (http://subclipse.tigris.org/) or Subversive (http://www.polarion.org/index.php?page=overview&project=subversive)
Subversion_Reply = {0}: For Subversion support, try Subclipse (http://subclipse.tigris.org/) or Subversive (http://www.polarion.org/index.php?page=overview&project=subversive)

# ~news|~newsgroup
Newsgroup = Try asking for help on the newsgroups - http://www.eclipse.org/newsgroups/
Newsgroup_Reply = {0}: Try asking for help on the newsgroups - http://www.eclipse.org/newsgroups/

# ~cmd|~commands|~help
Help = For a list of the available commands that I provide, see http://wiki.eclipse.org/index.php/IRC_bot
Help_Reply = {0}: For a list of the available commands that I provide, see http://wiki.eclipse.org/index.php/IRC_bot

# ~g .*
Google = Try googling - http://google.com/search?q={0}
Google_Reply = {0}: Try googling - http://google.com/search?q={1}

# ~wiki .*
Wiki = Check out this wiki article - http://wiki.eclipse.org/index.php/{0}
Wiki_Reply = {0}: Check out this wiki article - http://wiki.eclipse.org/index.php/{1}

Feature Requests

  • eclipse help search:
# ~eh <search terms?
EclipseHelp = Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={0}
EclipseHelp_Reply = {0}: Check out the fine manual - http://help.eclipse.org/help32/advanced/searchView.jsp?maxHits=20&searchWord={1}


  • Would like to see a set of commands supported for every project...e.g.
    • ~ecf javadocs
    • ~wtp home
    • ~dsdp wiki
  • IRC session logging and control...e.g. ~startlogging, ~stoplogging, ~sendlog
  • Execute commands only if sender user has permission to do so
  • Commands for project build: start build, run tests. Restricted by channel and user.