comboy-autumn 3.1

data/lib/autumn/stem_facade.rb

@@ -0,0 +1,176 @@
+# Defines the Autumn::StemFacade class, which provides additional convenience
+# methods to Autumn::Stem.
+
+module Autumn
+  
+  # A collection of convenience methods that are added to the Stem class. These
+  # methods serve two purposes; one, to allow easier backwards compatibility
+  # with Autumn Leaves 1.0 (which had a simpler one-stem-per-leaf approach), and
+  # two, to make it easier or more Ruby-like to perform certain IRC actions.
+  
+  module StemFacade
+    
+    # Sends a message to one or more channels or nicks. If no channels or nicks
+    # are specified, broadcasts the message to every channel the stem is in. If
+    # you are sending a message to a channel you must prefix it correctly; the
+    # "#" will not be added before the channel name for you.
+    #
+    #  message "Look at me!" # Broadcasts to all channels
+    #  message "I love kitties", '#kitties' # Sends a message to one channel or person
+    #  message "Learn to RTFM", '#help', 'NoobGuy' # Sends a message to two channels or people
+    
+    def message(msg, *chans)
+      return if msg.nil? or msg.empty?
+      chans = channels if chans.empty?
+      if @throttle then
+        Thread.exclusive { msg.each_line { |line| privmsgt chans.to_a, line.strip unless line.strip.empty? } }
+      else
+        msg.each_line { |line| privmsg chans.to_a, line.strip unless line.strip.empty? }
+      end
+    end
+    
+    # Sets the topic for one or more channels. If no channels are specified,
+    # sets the topic of every channel the stem is in.
+    #
+    #  set_topic "Bots sure are fun!", 'bots', 'morebots'
+    
+    def set_topic(motd, *chans)
+      return if motd.nil?
+      chans = chans.empty? ? channels : chans.map { |chan| normalized_channel_name chan }
+      chans.each { |chan| topic chan, motd }
+    end
+    
+    # Joins a channel by name. If the channel is password-protected, specify the
+    # +password+ parameter. Of course, you could always just call the +join+
+    # method (since each IRC command has a method named after it), but the
+    # advantage to using this method is that it will also update the
+    # <tt>@channel_passwords</tt> instance variable. Internal consistency is a
+    # good thing, so please use this method.
+    
+    def join_channel(channel, password=nil)
+      channel = normalized_channel_name(channel)
+      return if channels.include? channel
+      join channel, password
+      @channel_passwords[channel] = password if password
+    end
+
+    # Leaves a channel, specified by name.
+    
+    def leave_channel(channel)
+      channel = normalized_channel_name(channel)
+      return unless channels.include? channel
+      part channel
+    end
+
+    # Changes this stem's IRC nick. Note that the stem's original nick will
+    # still be used by the logger.
+    
+    def change_nick(new_nick)
+      nick new_nick
+    end
+
+    # Grants a privilege to a channel member, such as voicing a member. The stem
+    # must have the required privilege level to perform this command.
+    # +privilege+ can either be a symbol from the Daemon instance or a string
+    # with the letter code for the privilege.
+    #
+    #  grant_user_privilege 'mychannel', 'Somedude', :operator
+    #  grant_user_privilege '#mychannel', 'Somedude', 'oa'
+    
+    def grant_user_privilege(channel, nick, privilege)
+      channel = normalized_channel_name(channel)
+      privcode = server_type.privilege.index(privilege).chr if server_type.privilege.value? privilege
+      privcode ||= privilege
+      mode channel, "+#{privcode}", nick
+    end
+
+    # Removes a privilege to a channel member, such as voicing a member. The
+    # stem must have the required privilege level to perform this command.
+    # +privilege+ can either be a symbol from the Daemon instance or a string
+    # with the letter code for the privilege.
+    
+    def remove_user_privilege(channel, nick, privilege)
+      channel = normalized_channel_name(channel)
+      privcode = server_type.privilege.index(privilege).chr if server_type.privilege.value? privilege
+      privcode ||= privilege
+      mode channel, "-#{privcode}", nick
+    end
+    
+    # Grants a usermode to an IRC nick, such as making a nick invisible.
+    # The stem must have the required privilege level to perform this command.
+    # (Generally, one can only change his own usermode unless he is a server
+    # op.) +mode+ can either be a symbol from the Daemon instance or a string
+    # with the letter code for the usermode.
+    #
+    #  grant_usermode 'Spycloak', :invisible
+    #  grant_usermode 'UpMobility', 'os'
+    
+    def grant_usermode(nick, property)
+      propcode = server_type.usermode.index(property).chr if server_type.usermode.value? property
+      propcode ||= property
+      mode nick, "+#{property}"
+    end
+
+    # Revokes a usermode from an IRC nick, such as removing invisibility. The
+    # stem must have the required privilege level to perform this command.
+    # (Generally, one can only change his own usermode unless he is a server
+    # op.) +mode+ can either be a symbol from the Daemon instance or a string
+    # with the letter code for the usermode.
+    
+    def remove_usermode(nick, property)
+      propcode = server_type.usermode.index(property).chr if server_type.usermode.value? property
+      propcode ||= property
+      mode nick, "-#{property}"
+    end
+
+    # Sets a property of a channel, such as moderated. The stem must have the
+    # required privilege level to perform this command. +property+ can either be
+    # a symbol from the Daemon instance or a string with the letter code for the
+    # property. If the property takes an argument (such as when setting a
+    # channel password), pass it as the +argument+ paramter.
+    #
+    #  set_channel_property '#mychannel', :secret
+    #  set_channel_property 'mychannel', :keylock, 'mypassword'
+    #  set_channel_property '#mychannel', 'ntr'
+    
+    def set_channel_property(channel, property, argument=nil)
+      channel = normalized_channel_name(channel)
+      propcode = server_type.channel_property.index(property).chr if server_type.channel_property.value? property
+      propcode ||= property
+      mode channel, "+#{propcode}", argument
+    end
+
+    # Removes a property of a channel, such as moderated. The stem must have the
+    # required privilege level to perform this command. +property+ can either be
+    # a symbol from the Daemon instance or a string with the letter code for the
+    # property. If the property takes an argument (such as when removing a
+    # channel password), pass it as the +argument+ paramter.
+    
+    def unset_channel_property(channel, property, argument=nil)
+      channel = normalized_channel_name(channel)
+      propcode = server_type.channel_property.index(property).chr if server_type.channel_property.value? property
+      propcode ||= property
+      mode channel, "-#{propcode}", argument
+    end
+    
+    # Returns an array of nicks for users that are in a channel.
+    
+    def users(channel)
+      channel = normalized_channel_name(channel)
+      @chan_mutex.synchronize { @channel_members[channel] && @channel_members[channel].keys }
+    end
+  
+    # Returns the privilege level of a channel member. The privilege level will
+    # be a symbol from the Daemon instance. Returns nil if the channel member
+    # doesn't exist or if the bot is not on the given channel. Returns an array
+    # of privileges if the server supports multiple privileges per user, and the
+    # user has more than one privilege.
+    #
+    # +user+ can be a nick or a sender hash.
+    
+    def privilege(channel, user)
+      user = user[:nick] if user.kind_of? Hash
+      @chan_mutex.synchronize { @channel_members[channel] && @channel_members[channel][user] }
+    end
+  end
+end

data/resources/daemons/Anothernet.yml

@@ -0,0 +1,3 @@
+--- 
+event: 
+  320: :rpl_whois_hidden

data/resources/daemons/AustHex.yml

@@ -0,0 +1,29 @@
+--- 
+channel_mode: 
+  e: :event
+event: 
+  434: :err_servicenameinuse
+  357: :rpl_map
+  385: :rpl_notoperanymore
+  380: :rpl_yourhelper
+  358: :rpl_mapmore
+  430: :err_eventnickchange
+  320: :rpl_whoisvirt
+  309: :rpl_whoishelper
+  480: :err_nouline
+  359: :rpl_mapend
+  310: :rpl_whoisservice
+  503: :err_vworldwarn
+  520: :err_whotrunc
+  377: :rpl_spam
+  328: :rpl_channel_url
+  240: :rpl_statsxline
+  378: :rpl_motd
+  307: :rpl_suserhost
+usermode: 
+  v: :host_hiding
+  l: :listall
+  a: :errors
+  h: :helper
+  T: :w_lined
+  t: :z_lined

data/resources/daemons/Bahamut.yml

@@ -0,0 +1,67 @@
+--- 
+channel_mode: 
+  L: :listed
+  M: :modreg
+  c: :nocolour
+  O: :oper_only
+  R: :regonly
+  r: :registered
+event: 
+  522: :err_whosyntax
+  225: :rpl_statszline
+  605: :rpl_nowoff
+  484: :err_desync
+  440: :err_servicesdown
+  429: :err_toomanyaway
+  308: :rpl_whoisadmin
+  220: :rpl_statsbline
+  600: :rpl_logon
+  523: :err_wholimexceed
+  512: :err_toomanywatch
+  468: :err_onlyserverscanchange
+  435: :err_banonchan
+  226: :rpl_statscount
+  617: :rpl_dccstatus
+  606: :rpl_watchlist
+  408: :err_nocolorsonchan
+  309: :rpl_whoissadmin
+  265: :rpl_localusers
+  601: :rpl_logoff
+  227: :rpl_statsgline
+  618: :rpl_dcclist
+  607: :rpl_endofwatchlist
+  310: :rpl_whoissvcmsg
+  266: :rpl_globalusers
+  222: :rpl_statsbline
+  602: :rpl_watchoff
+  514: :err_toomanydcc
+  338: :rpl_whoisactually
+  619: :rpl_endofdcclist
+  487: :err_msgservices
+  245: :rpl_statssline
+  223: :rpl_statseline
+  999: :err_numeric_err
+  603: :rpl_watchstat
+  328: :rpl_channel_url
+  620: :rpl_dccinfo
+  521: :err_listsyntax
+  477: :err_needreggednick
+  334: :rpl_commandsyntax
+  224: :rpl_statsfline
+  604: :rpl_nowon
+  329: :rpl_creationtime
+  307: :rpl_whoisregnick
+usermode: 
+  k: :kills
+  A: :server_admin
+  a: :services_admin
+  m: :spambots
+  b: :chatops
+  y: :stats_links
+  n: :routing
+  d: :debug
+  f: :floods
+  R: :no_non_registered
+  r: :registered
+  g: :globops
+  h: :helper

data/resources/daemons/Dancer.yml

@@ -0,0 +1,3 @@
+--- 
+channel_mode: 
+  J: :join_throttle

data/resources/daemons/GameSurge.yml

@@ -0,0 +1,3 @@
+--- 
+event: 
+  345: :rpl_invited

data/resources/daemons/IRCnet.yml

@@ -0,0 +1,3 @@
+--- 
+channel_mode: 
+  R: :reop_list

data/resources/daemons/Ithildin.yml

@@ -0,0 +1,7 @@
+--- 
+event: 
+  771: :rpl_xinfo
+  672: :rpl_unknownmodes
+  673: :rpl_cannotsetmodes
+  773: :rpl_xinfostart
+  774: :rpl_xinfoend

data/resources/daemons/KineIRCd.yml

@@ -0,0 +1,56 @@
+--- 
+server_mode: 
+  L: :default_language
+  l: :lazy_leaf
+  A: :auto_tbs
+  a: :autoconnect
+  M: :modes_locked
+  n: :no_oper
+  D: :debugging
+  F: :full
+  H: :hidden
+  T: :testlink
+channel_mode: 
+  "!": :service
+event: 
+  973: :err_cannotchangeumode
+  687: :rpl_yourlanguageis
+  665: :rpl_otherumodeis
+  979: :err_servermodelock
+  682: :rpl_networks
+  671: :rpl_whoissecure
+  660: :rpl_traceroute_hop
+  974: :err_cannotchangechanmode
+  688: :rpl_language
+  666: :rpl_endof_generic
+  980: :err_badcharencoding
+  661: :rpl_traceroute_start
+  975: :err_cannotchangeservermode
+  689: :rpl_whoisstaff
+  678: :rpl_luserstaff
+  981: :err_toomanylanguages
+  662: :rpl_modechangewarn
+  976: :err_cannotsendtonick
+  690: :rpl_whoislanguage
+  679: :rpl_timeonserveris
+  982: :err_nolanguage
+  663: :rpl_chanredir
+  977: :err_unknownservermode
+  983: :err_texttooshort
+  664: :rpl_servmodeis
+  301: :rpl_away
+  4: :rpl_myinfo
+  670: :rpl_whowasdetails
+user_prefix: 
+  "!": :service
+usermode: 
+  d: :deaf
+  R: :no_non_registered
+  g: :callerid
+  s: :server_notices
+  h: :helper
+channel_prefix: 
+  .: :softchan
+  "~": :global
+privilege: 
+  "!": :service

data/resources/daemons/PTlink.yml

@@ -0,0 +1,6 @@
+--- 
+event: 
+  247: :rpl_statsxline
+  484: :err_desync
+  485: :err_cantkickadmin
+  615: :rpl_mapmore

data/resources/daemons/QuakeNet.yml

@@ -0,0 +1,20 @@
+--- 
+channel_mode: 
+  D: :deljoins
+  d: :has_hidden
+  u: :noquitparts
+event: 
+  291: :rpl_endofcheck
+  550: :err_badhostmask
+  286: :rpl_chkhead
+  551: :err_hostunavail
+  485: :err_isrealservice
+  287: :rpl_chanuser
+  552: :err_usingsline
+  486: :err_accountonly
+  288: :rpl_patchhead
+  553: :err_statssline
+  355: :rpl_namreply_
+  289: :rpl_patchcon
+  290: :rpl_datastr
+  285: :rpl_newhostis

data/resources/daemons/RFC1459.yml

@@ -0,0 +1,158 @@
+--- 
+channel_mode: 
+  v: :voice
+  k: :keylock
+  l: :limit
+  m: :moderated
+  b: :ban
+  n: :no_external_msgs
+  o: :oper
+  p: :private
+  s: :secret
+  t: :topic_lock
+  i: :invite_only
+event: 
+  462: :err_alreadyregistered
+  203: :rpl_traceunknown
+  314: :rpl_whowasuser
+  351: :rpl_version
+  481: :err_noprivileges
+  407: :err_toomanytargets
+  444: :err_nologin
+  259: :rpl_adminemail
+  463: :err_nopermforhost
+  204: :rpl_traceoperator
+  241: :rpl_statslline
+  315: :rpl_endofwho
+  352: :rpl_whoreply
+  482: :err_chanoprivsneeded
+  445: :err_summondisabled
+  371: :rpl_info
+  501: :err_umodeunknownflag
+  464: :err_passwdmismatch
+  205: :rpl_traceuser
+  242: :rpl_statsuptime
+  316: :rpl_whoischanop
+  353: :rpl_namreply
+  483: :err_cantkillserver
+  261: :rpl_tracelog
+  372: :rpl_motd
+  409: :err_noorigin
+  446: :err_usersdisabled
+  502: :err_usersdontmatch
+  465: :err_yourebannedcreep
+  206: :rpl_traceserver
+  243: :rpl_statsoline
+  317: :rpl_whoisidle
+  391: :rpl_time
+  373: :rpl_infostart
+  466: :err_youwillbebanned
+  244: :rpl_statshline
+  318: :rpl_endofwhois
+  392: :rpl_usersstart
+  300: :rpl_none
+  374: :rpl_endofinfo
+  411: :err_norecipient
+  467: :err_keyset
+  208: :rpl_tracenewtype
+  319: :rpl_whoischannels
+  393: :rpl_users
+  301: :rpl_away
+  375: :rpl_motdstart
+  412: :err_notexttosend
+  394: :rpl_endofusers
+  431: :err_nonicknamegiven
+  302: :rpl_userhost
+  376: :rpl_endofmotd
+  413: :err_notoplevel
+  321: :rpl_liststart
+  395: :rpl_nousers
+  432: :err_erroneusnickname
+  303: :rpl_ison
+  414: :err_wildtoplevel
+  451: :err_notregistered
+  322: :rpl_list
+  433: :err_nicknameinuse
+  211: :rpl_statslinkinfo
+  341: :rpl_inviting
+  471: :err_channelisfull
+  212: :rpl_statscommands
+  323: :rpl_listend
+  231: :rpl_serviceinfo
+  305: :rpl_unaway
+  342: :rpl_summoning
+  472: :err_unknownmode
+  213: :rpl_statscline
+  324: :rpl_channelmodeis
+  361: :rpl_killdone
+  491: :err_nooperhost
+  232: :rpl_endofservices
+  306: :rpl_nowaway
+  473: :err_inviteonlychan
+  436: :err_nickcollision
+  214: :rpl_statsnline
+  251: :rpl_luserclient
+  362: :rpl_closing
+  492: :err_noservicehost
+  233: :rpl_service
+  381: :rpl_youreoper
+  474: :err_bannedfromchan
+  215: :rpl_statsiline
+  252: :rpl_luserop
+  363: :rpl_closeend
+  382: :rpl_rehashing
+  475: :err_badchannelkey
+  216: :rpl_statskline
+  253: :rpl_luserunknown
+  364: :rpl_links
+  401: :err_nosuchnick
+  217: :rpl_statsqline
+  254: :rpl_luserchannels
+  365: :rpl_endoflinks
+  402: :err_nosuchserver
+  384: :rpl_myportis
+  421: :err_unknowncommand
+  255: :rpl_luserme
+  366: :rpl_endofnames
+  403: :err_nosuchchannel
+  218: :rpl_statsyline
+  311: :rpl_whoisuser
+  422: :err_nomotd
+  200: :rpl_tracelink
+  367: :rpl_banlist
+  404: :err_cannotsendtochan
+  441: :err_usernotinchannel
+  219: :rpl_endofstats
+  256: :rpl_adminme
+  312: :rpl_whoisserver
+  423: :err_noadmininfo
+  201: :rpl_traceconnecting
+  331: :rpl_notopic
+  368: :rpl_endofbanlist
+  405: :err_toomanychannels
+  442: :err_notonchannel
+  257: :rpl_adminloc1
+  424: :err_fileerror
+  461: :err_needmoreparams
+  202: :rpl_tracehandshake
+  313: :rpl_whoisoperator
+  369: :rpl_endofwhowas
+  406: :err_wasnosuchnick
+  443: :err_useronchannel
+  221: :rpl_umodeis
+  258: :rpl_adminloc2
+  332: :rpl_topic
+user_prefix: 
+  "@": :operator
+  +: :voiced
+usermode: 
+  w: :wallops
+  o: :global_operator
+  s: :server_notices
+  i: :invisible
+channel_prefix: 
+  "#": :network
+  "&": :local
+privilege: 
+  v: :voiced
+  o: :operator