diff options
| author | Giuseppe Bilotta <giuseppe.bilotta@gmail.com> | 2006-07-30 12:58:32 +0000 |
|---|---|---|
| committer | Giuseppe Bilotta <giuseppe.bilotta@gmail.com> | 2006-07-30 12:58:32 +0000 |
| commit | 02cc5b84c790595dda468e03a361b9e6f3429fce (patch) | |
| tree | aea6bce7cc14dbf8515a317e36410e84d86a350c | |
| parent | 39c7880d82b5db2163e5c5869b622daceb3477ef (diff) | |
Initial commit of the new Irc framework. Only add the file, no changes to the actual rbot code
| -rw-r--r-- | lib/rbot/irc.rb | 973 |
1 files changed, 973 insertions, 0 deletions
diff --git a/lib/rbot/irc.rb b/lib/rbot/irc.rb new file mode 100644 index 00000000..31c4953e --- /dev/null +++ b/lib/rbot/irc.rb @@ -0,0 +1,973 @@ +#-- vim:sw=2:et
+# General TODO list
+# * when Users are deleted, we have to delete them from the appropriate
+# channel lists too
+# * do we want to handle a Channel list for each User telling which
+# Channels is the User on (of those the client is on too)?
+#++
+# :title: IRC module
+#
+# Basic IRC stuff
+#
+# This module defines the fundamental building blocks for IRC
+#
+# Author:: Giuseppe Bilotta (giuseppe.bilotta@gmail.com)
+# Copyright:: Copyright (c) 2006 Giuseppe Bilotta
+# License:: GPLv2
+
+
+# We start by extending the String class
+# with some IRC-specific methods
+#
+class String
+
+ # This method returns a string which is the downcased version of the
+ # receiver, according to IRC rules: due to the Scandinavian origin of IRC,
+ # the characters <tt>{}|^</tt> are considered the uppercase equivalent of
+ # <tt>[]\~</tt>.
+ #
+ # Since IRC is mostly case-insensitive (the Windows way: case is preserved,
+ # but it's actually ignored to check equality), this method is rather
+ # important when checking if two strings refer to the same entity
+ # (User/Channel)
+ #
+ # Modern server allow different casemaps, too, in which some or all
+ # of the extra characters are not converted
+ #
+ def irc_downcase(casemap='rfc1459')
+ case casemap
+ when 'rfc1459'
+ self.tr("\x41-\x5e", "\x61-\x7e")
+ when 'strict-rfc1459'
+ self.tr("\x41-\x5d", "\x61-\x7d")
+ when 'ascii'
+ self.tr("\x41-\x5a", "\x61-\x7a")
+ else
+ raise TypeError, "Unknown casemap #{casemap}"
+ end
+ end
+
+ # This is the same as the above, except that the string is altered in place
+ #
+ # See also the discussion about irc_downcase
+ #
+ def irc_downcase!(casemap='rfc1459')
+ case casemap
+ when 'rfc1459'
+ self.tr!("\x41-\x5e", "\x61-\x7e")
+ when 'strict-rfc1459'
+ self.tr!("\x41-\x5d", "\x61-\x7d")
+ when 'ascii'
+ self.tr!("\x41-\x5a", "\x61-\x7a")
+ else
+ raise TypeError, "Unknown casemap #{casemap}"
+ end
+ end
+
+ # Upcasing functions are provided too
+ #
+ # See also the discussion about irc_downcase
+ #
+ def irc_upcase(casemap='rfc1459')
+ case casemap
+ when 'rfc1459'
+ self.tr("\x61-\x7e", "\x41-\x5e")
+ when 'strict-rfc1459'
+ self.tr("\x61-\x7d", "\x41-\x5d")
+ when 'ascii'
+ self.tr("\x61-\x7a", "\x41-\x5a")
+ else
+ raise TypeError, "Unknown casemap #{casemap}"
+ end
+ end
+
+ # In-place upcasing
+ #
+ # See also the discussion about irc_downcase
+ #
+ def irc_upcase!(casemap='rfc1459')
+ case casemap
+ when 'rfc1459'
+ self.tr!("\x61-\x7e", "\x41-\x5e")
+ when 'strict-rfc1459'
+ self.tr!("\x61-\x7d", "\x41-\x5d")
+ when 'ascii'
+ self.tr!("\x61-\x7a", "\x41-\x5a")
+ else
+ raise TypeError, "Unknown casemap #{casemap}"
+ end
+ end
+
+ # This method checks if the receiver contains IRC glob characters
+ #
+ # IRC has a very primitive concept of globs: a <tt>*</tt> stands for "any
+ # number of arbitrary characters", a <tt>?</tt> stands for "one and exactly
+ # one arbitrary character". These characters can be escaped by prefixing them
+ # with a slash (<tt>\\</tt>).
+ #
+ # A known limitation of this glob syntax is that there is no way to escape
+ # the escape character itself, so it's not possible to build a glob pattern
+ # where the escape character precedes a glob.
+ #
+ def has_irc_glob?
+ self =~ /^[*?]|[^\\][*?]/
+ end
+
+ # This method is used to convert the receiver into a Regular Expression
+ # that matches according to the IRC glob syntax
+ #
+ def to_irc_regexp
+ regmask = Regexp.escape(self)
+ regmask.gsub!(/(\\\\)?\\[*?]/) { |m|
+ case m
+ when /\\(\\[*?])/
+ $1
+ when /\\\*/
+ '.*'
+ when /\\\?/
+ '.'
+ else
+ raise "Unexpected match #{m} when converting #{self}"
+ end
+ }
+ Regexp.new(regmask)
+ end
+end
+
+
+# ArrayOf is a subclass of Array whose elements are supposed to be all
+# of the same class. This is not intended to be used directly, but rather
+# to be subclassed as needed (see for example Irc::UserList and Irc::NetmaskList)
+#
+# Presently, only very few selected methods from Array are overloaded to check
+# if the new elements are the correct class. An orthodox? method is provided
+# to check the entire ArrayOf against the appropriate class.
+#
+class ArrayOf < Array
+
+ attr_reader :element_class
+
+ # Create a new ArrayOf whose elements are supposed to be all of type _kl_,
+ # optionally filling it with the elements from the Array argument.
+ #
+ def initialize(kl, ar=[])
+ raise TypeError, "#{kl.inspect} must be a class name" unless kl.class <= Class
+ super()
+ @element_class = kl
+ case ar
+ when Array
+ send(:+, ar)
+ else
+ raise TypeError, "#{self.class} can only be initialized from an Array"
+ end
+ end
+
+ # Private method to check the validity of the elements passed to it
+ # and optionally raise an error
+ #
+ # TODO should it accept nils as valid?
+ #
+ def internal_will_accept?(raising, *els)
+ els.each { |el|
+ unless el.class <= @element_class
+ raise TypeError if raising
+ return false
+ end
+ }
+ return true
+ end
+ private :internal_will_accept?
+
+ # This method checks if the passed arguments are acceptable for our ArrayOf
+ #
+ def will_accept?(*els)
+ internal_will_accept?(false, *els)
+ end
+
+ # This method checks that all elements are of the appropriate class
+ #
+ def valid?
+ will_accept?(*self)
+ end
+
+ # This method is similar to the above, except that it raises an exception
+ # if the receiver is not valid
+ def validate
+ raise TypeError unless valid?
+ end
+
+ # Overloaded from Array#<<, checks for appropriate class of argument
+ #
+ def <<(el)
+ super(el) if internal_will_accept?(true, el)
+ end
+
+ # Overloaded from Array#unshift, checks for appropriate class of argument(s)
+ #
+ def unshift(*els)
+ els.each { |el|
+ super(el) if internal_will_accept?(true, *els)
+ }
+ end
+
+ # Overloaded from Array#+, checks for appropriate class of argument elements
+ #
+ def +(ar)
+ super(ar) if internal_will_accept?(true, *ar)
+ end
+end
+
+# The Irc module is used to keep all IRC-related classes
+# in the same namespace
+#
+module Irc
+
+
+ # A Netmask identifies each user by collecting its nick, username and
+ # hostname in the form <tt>nick!user@host</tt>
+ #
+ # Netmasks can also contain glob patterns in any of their components; in this
+ # form they are used to refer to more than a user or to a user appearing
+ # under different
+ # forms.
+ #
+ # Example:
+ # * <tt>*!*@*</tt> refers to everybody
+ # * <tt>*!someuser@somehost</tt> refers to user +someuser+ on host +somehost+
+ # regardless of the nick used.
+ #
+ class Netmask
+ attr_reader :nick, :user, :host
+ attr_reader :casemap
+
+ # call-seq:
+ # Netmask.new(netmask) => new_netmask
+ # Netmask.new(hash={}, casemap=nil) => new_netmask
+ # Netmask.new("nick!user@host", casemap=nil) => new_netmask
+ #
+ # Create a new Netmask in any of these forms
+ # 1. from another Netmask (does a .dup)
+ # 2. from a Hash with any of the keys <tt>:nick</tt>, <tt>:user</tt> and
+ # <tt>:host</tt>
+ # 3. from a String in the form <tt>nick!user@host</tt>
+ #
+ # In all but the first forms a casemap may be speficied, the default
+ # being 'rfc1459'.
+ #
+ # The nick is downcased following IRC rules and according to the given casemap.
+ #
+ # FIXME check if user and host need to be downcased too.
+ #
+ # Empty +nick+, +user+ or +host+ are converted to the generic glob pattern
+ #
+ def initialize(str={}, casemap=nil)
+ case str
+ when Netmask
+ raise ArgumentError, "Can't set casemap when initializing from other Netmask" if casemap
+ @casemap = str.casemap.dup
+ @nick = str.nick.dup
+ @user = str.user.dup
+ @host = str.host.dup
+ when Hash
+ @casemap = casemap || str[:casemap] || 'rfc1459'
+ @nick = str[:nick].to_s.irc_downcase(@casemap)
+ @user = str[:user].to_s
+ @host = str[:host].to_s
+ when String
+ if str.match(/(\S+)(?:!(\S+)@(?:(\S+))?)?/)
+ @casemap = casemap || 'rfc1459'
+ @nick = $1.irc_downcase(@casemap)
+ @user = $2
+ @host = $3
+ else
+ raise ArgumentError, "#{str} is not a valid netmask"
+ end
+ else
+ raise ArgumentError, "#{str} is not a valid netmask"
+ end
+
+ @nick = "*" if @nick.to_s.empty?
+ @user = "*" if @user.to_s.empty?
+ @host = "*" if @host.to_s.empty?
+ end
+
+ # This method changes the nick of the Netmask, downcasing the argument
+ # following IRC rules and defaulting to the generic glob pattern if
+ # the result is the null string.
+ #
+ def nick=(newnick)
+ @nick = newnick.to_s.irc_downcase(@casemap)
+ @nick = "*" if @nick.empty?
+ end
+
+ # This method changes the user of the Netmask, defaulting to the generic
+ # glob pattern if the result is the null string.
+ #
+ def user=(newuser)
+ @user = newuser.to_s
+ @user = "*" if @user.empty?
+ end
+
+ # This method changes the hostname of the Netmask, defaulting to the generic
+ # glob pattern if the result is the null string.
+ #
+ def host=(newhost)
+ @host = newhost.to_s
+ @host = "*" if @host.empty?
+ end
+
+ # This method checks if a Netmask is definite or not, by seeing if
+ # any of its components are defined by globs
+ #
+ def has_irc_glob?
+ return @nick.has_irc_glob? || @user.has_irc_glob? || @host.has_irc_glob?
+ end
+
+ # A Netmask is easily converted to a String for the usual representation
+ #
+ def to_s
+ return "#{nick}@#{user}!#{host}"
+ end
+
+ # This method is used to match the current Netmask against another one
+ #
+ # The method returns true if each component of the receiver matches the
+ # corresponding component of the argument. By _matching_ here we mean that
+ # any netmask described by the receiver is also described by the argument.
+ #
+ # In this sense, matching is rather simple to define in the case when the
+ # receiver has no globs: it is just necessary to check if the argument
+ # describes the receiver, which can be done by matching it against the
+ # argument converted into an IRC Regexp (see String#to_irc_regexp).
+ #
+ # The situation is also easy when the receiver has globs and the argument
+ # doesn't, since in this case the result is false.
+ #
+ # The more complex case in which both the receiver and the argument have
+ # globs is not handled yet.
+ #
+ def matches?(arg)
+ cmp = Netmask(arg)
+ raise TypeError, "#{arg} and #{self} have different casemaps" if @casemap != cmp.casemap
+ raise TypeError, "#{arg} is not a valid Netmask" unless cmp.class <= Netmask
+ [:nick, :user, :host].each { |component|
+ us = self.send(:component)
+ them = cmp.send(:component)
+ raise NotImplementedError if us.has_irc_glob? && them.has_irc_glob?
+ return false if us.has_irc_glob? && !them.has_irc_glob?
+ return false unless us =~ them.to_irc_regexp
+ }
+ return true
+ end
+
+ # Case equality. Checks if arg matches self
+ #
+ def ===(arg)
+ Netmask(arg).matches?(self)
+ end
+ end
+
+
+ # A NetmaskList is an ArrayOf <code>Netmask</code>s
+ #
+ class NetmaskList < ArrayOf
+
+ # Create a new NetmaskList, optionally filling it with the elements from
+ # the Array argument fed to it.
+ def initialize(ar=[])
+ super(Netmask, ar)
+ end
+ end
+
+
+ # An IRC User is identified by his/her Netmask (which must not have
+ # globs). In fact, User is just a subclass of Netmask. However,
+ # a User will not allow one's host or user data to be changed: only the
+ # nick can be dynamic
+ #
+ # TODO list:
+ # * see if it's worth to add the other USER data
+ # * see if it's worth to add AWAY status
+ # * see if it's worth to add NICKSERV status
+ #
+ class User < Netmask
+ private :host=, :user=
+
+ # Create a new IRC User from a given Netmask (or anything that can be converted
+ # into a Netmask) provided that the given Netmask does not have globs.
+ #
+ def initialize(str, casemap=nil)
+ super
+ raise ArgumentError, "#{str.inspect} must not have globs (unescaped * or ?)" if has_irc_glob?
+ end
+ end
+
+
+ # A UserList is an ArrayOf <code>User</code>s
+ #
+ class UserList < ArrayOf
+
+ # Create a new UserList, optionally filling it with the elements from
+ # the Array argument fed to it.
+ def initialize(ar=[])
+ super(User, ar)
+ end
+ end
+
+
+ # An IRC Channel is identified by its name, and it has a set of properties:
+ # * a topic
+ # * a UserList
+ # * a set of modes
+ #
+ class Channel
+ attr_reader :name, :type, :casemap
+
+ # Create a new method. Auxiliary function for the following
+ # auxiliary functions ...
+ #
+ def create_method(name, &block)
+ self.class.send(:define_method, name, &block)
+ end
+ private :create_method
+
+ # Create a new channel boolean flag
+ #
+ def new_bool_flag(sym, acc=nil, default=false)
+ @flags[sym.to_sym] = default
+ racc = (acc||sym).to_s << "?"
+ wacc = (acc||sym).to_s << "="
+ create_method(racc.to_sym) { @flags[sym.to_sym] }
+ create_method(wacc.to_sym) { |val|
+ @flags[sym.to_sym] = val
+ }
+ end
+
+ # Create a new channel flag with data
+ #
+ def new_data_flag(sym, acc=nil, default=false)
+ @flags[sym.to_sym] = default
+ racc = (acc||sym).to_s
+ wacc = (acc||sym).to_s << "="
+ create_method(racc.to_sym) { @flags[sym.to_sym] }
+ create_method(wacc.to_sym) { |val|
+ @flags[sym.to_sym] = val
+ }
+ end
+
+ # Create a new variable with accessors
+ #
+ def new_variable(name, default=nil)
+ v = "@#{name}".to_sym
+ instance_variable_set(v, default)
+ create_method(name.to_sym) { instance_variable_get(v) }
+ create_method("#{name}=".to_sym) { |val|
+ instance_variable_set(v, val)
+ }
+ end
+
+ # Create a new UserList
+ #
+ def new_userlist(name, default=UserList.new)
+ new_variable(name, default)
+ end
+
+ # Create a new NetmaskList
+ #
+ def new_netmasklist(name, default=NetmaskList.new)
+ new_variable(name, default)
+ end
+
+ # Creates a new channel with the given name, optionally setting the topic
+ # and an initial users list.
+ #
+ # No additional info is created here, because the channel flags and userlists
+ # allowed depend on the server.
+ #
+ # FIXME doesn't check if users have the same casemap as the channel yet
+ #
+ def initialize(name, topic="", users=[], casemap=nil)
+ @casemap = casemap || 'rfc1459'
+
+ raise ArgumentError, "Channel name cannot be empty" if name.to_s.empty?
+ raise ArgumentError, "Unknown channel prefix #{name[0].chr}" if name !~ /^[&#+!]/
+ raise ArgumentError, "Invalid character in #{name.inspect}" if name =~ /[ \x07,]/
+
+ @name = name.irc_downcase(@casemap)
+
+ new_variable(:topic, topic)
+
+ new_userlist(:users)
+ case users
+ when UserList
+ @users = users.dup
+ when Array
+ @users = UserList.new(users)
+ else
+ raise ArgumentError, "Invalid user list #{users.inspect}"
+ end
+
+ # new_variable(:creator)
+
+ # # Special users
+ # new_userlist(:super_ops)
+ # new_userlist(:ops)
+ # new_userlist(:half_ops)
+ # new_userlist(:voices)
+
+ # # Ban and invite lists
+ # new_netmasklist(:banlist)
+ # new_netmasklist(:exceptlist)
+ # new_netmasklist(:invitelist)
+
+ # # Flags
+ @flags = {}
+ # new_bool_flag(:a, :anonymous)
+ # new_bool_flag(:i, :invite_only)
+ # new_bool_flag(:m, :moderated)
+ # new_bool_flag(:n, :no_externals)
+ # new_bool_flag(:q, :quiet)
+ # new_bool_flag(:p, :private)
+ # new_bool_flag(:s, :secret)
+ # new_bool_flag(:r, :will_reop)
+ # new_bool_flag(:t, :free_topic)
+
+ # new_data_flag(:k, :key)
+ # new_data_flag(:l, :limit)
+ end
+
+ # A channel is local to a server if it has the '&' prefix
+ #
+ def local?
+ name[0] = 0x26
+ end
+
+ # A channel is modeless if it has the '+' prefix
+ #
+ def modeless?
+ name[0] = 0x2b
+ end
+
+ # A channel is safe if it has the '!' prefix
+ #
+ def safe?
+ name[0] = 0x21
+ end
+
+ # A channel is safe if it has the '#' prefix
+ #
+ def normal?
+ name[0] = 0x23
+ end
+ end
+
+
+ # A ChannelList is an ArrayOf <code>Channel</code>s
+ #
+ class ChannelList < ArrayOf
+
+ # Create a new ChannelList, optionally filling it with the elements from
+ # the Array argument fed to it.
+ def initialize(ar=[])
+ super(Channel, ar)
+ end
+ end
+
+
+ # An IRC Server represents the Server the client is connected to.
+ #
+ class Server
+
+ attr_reader :hostname, :version, :usermodes, :chanmodes
+ attr_reader :supports, :capab
+
+ attr_reader :channels, :users
+
+ # Create a new Server, with all instance variables reset
+ # to nil (for scalar variables), the channel and user lists
+ # are empty, and @supports is initialized to the default values
+ # for all known supported features.
+ #
+ def initialize
+ @hostname = @version = @usermodes = @chanmodes = nil
+ @supports = {
+ :casemapping => 'rfc1459',
+ :chanlimit => {},
+ :chanmodes => {
+ :addr_list => nil, # Type A
+ :has_param => nil, # Type B
+ :set_param => nil, # Type C
+ :no_params => nil # Type D
+ },
+ :channellen => 200,
+ :chantypes => "#&",
+ :excepts => nil,
+ :idchan => {},
+ :invex => nil,
+ :kicklen => nil,
+ :maxlist => {},
+ :modes => 3,
+ :network => nil,
+ :nicklen => 9,
+ :prefix => {
+ :modes => 'ov'.scan(/./),
+ :prefixes => '@+'.scan(/./)
+ },
+ :safelist => nil,
+ :statusmsg => nil,
+ :std => nil,
+ :targmax => {},
+ :topiclen => nil
+ }
+ @capab = {}
+
+ @channels = ChannelList.new
+ @channel_names = Array.new
+
+ @users = UserList.new
+ @user_nicks = Array.new
+ end
+
+ # This method is used to parse a 004 RPL_MY_INFO line
+ #
+ def parse_my_info(line)
+ ar = line.split(' ')
+ @hostname = ar[0]
+ @version = ar[1]
+ @usermodes = ar[2]
+ @chanmodes = ar[3]
+ end
+
+ def noval_warn(key, val, &block)
+ if val
+ yield if block_given?
+ else
+ warn "No #{key.to_s.upcase} value"
+ end
+ end
+
+ def val_warn(key, val, &block)
+ if val == true or val == false or val.nil?
+ yield if block_given?
+ else
+ warn "No #{key.to_s.upcase} value must be specified, got #{val}"
+ end
+ end
+ private :noval_warn, :val_warn
+
+ # This method is used to parse a 005 RPL_ISUPPORT line
+ #
+ # See the RPL_ISUPPORT draft[http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt]
+ #
+ # TODO this is just an initial draft that does nothing special.
+ # We want to properly parse most of the supported capabilities
+ # for later reuse.
+ #
+ def parse_isupport(line)
+ ar = line.split(' ')
+ reparse = ""
+ ar.each { |en|
+ prekey, val = en.split('=', 2)
+ if prekey =~ /^-(.*)/
+ key = $1.downcase.to_sym
+ val = false
+ else
+ key = prekey.downcase.to_sym
+ end
+ case key
+ when :casemapping, :network
+ noval_warn(key, val) {
+ @supports[key] = val
+ }
+ when :chanlimit, :idchan, :maxlist, :targmax
+ noval_warn(key, val) {
+ groups = val.split(',')
+ groups.each { |g|
+ k, v = g.split(':')
+ @supports[key][k] = v.to_i
+ }
+ }
+ when :maxchannels
+ noval_warn(key, val) {
+ reparse += "CHANLIMIT=(chantypes):#{val} "
+ }
+ when :maxtargets
+ noval_warn(key, val) {
+ @supports[key]['PRIVMSG'] = val.to_i
+ @supports[key]['NOTICE'] = val.to_i
+ }
+ when :chanmodes
+ noval_warn(key, val) {
+ groups = val.split(',')
+ @supports[key][:addr_list] = groups[0].scan(/./)
+ @supports[key][:has_param] = groups[1].scan(/./)
+ @supports[key][:set_param] = groups[2].scan(/./)
+ @supports[key][:no_params] = groups[3].scan(/./)
+ }
+ when :channellen, :kicklen, :modes, :topiclen
+ if val
+ @supports[key] = val.to_i
+ else
+ @supports[key] = nil
+ end
+ when :chantypes
+ @supports[key] = val # can also be nil
+ when :excepts
+ val ||= 'e'
+ @supports[key] = val
+ when :invex
+ val ||= 'I'
+ @supports[key] = val
+ when :nicklen
+ noval_warn(key, val) {
+ @supports[key] = val.to_i
+ }
+ when :prefix
+ if val
+ val.scan(/\((.*)\)(.*)/) { |m, p|
+ @supports[key][:modes] = m.scan(/./)
+ @supports[key][:prefixes] = p.scan(/./)
+ }
+ else
+ @supports[key][:modes] = nil
+ @supports[key][:prefixes] = nil
+ end
+ when :safelist
+ val_warn(key, val) {
+ @supports[key] = val.nil? ? true : val
+ }
+ when :statusmsg
+ noval_warn(key, val) {
+ @supports[key] = val.scan(/./)
+ }
+ when :std
+ noval_warn(key, val) {
+ @supports[key] = val.split(',')
+ }
+ else
+ @supports[key] = val.nil? ? true : val
+ end
+ }
+ reparse.gsub!("(chantypes)",@supports[:chantypes])
+ parse_isupport(reparse) unless reparse.empty?
+ end
+
+ # Returns the casemap of the server.
+ #
+ def casemap
+ @supports[:casemapping] || 'rfc1459'
+ end
+
+ # Checks if the receiver already has a channel with the given _name_
+ #
+ def has_channel?(name)
+ @channel_names.index(name)
+ end
+ alias :has_chan? :has_channel?
+
+ # Returns the channel with name _name_, if available
+ #
+ def get_channel(name)
+ idx = @channel_names.index(name)
+ @channels[idx] if idx
+ end
+ alias :get_chan :get_channel
+
+ # Create a new Channel object and add it to the list of
+ # <code>Channel</code>s on the receiver, unless the channel
+ # was present already. In this case, the default action is
+ # to raise an exception, unless _fails_ is set to false
+ #
+ # The Channel is automatically created with the appropriate casemap
+ #
+ def new_channel(name, topic="", users=[], fails=true)
+ if !has_chan?(name)
+
+ prefix = name[0].chr
+
+ # Give a warning if the new Channel goes over some server limits.
+ #
+ # FIXME might need to raise an exception
+ #
+ warn "#{self} doesn't support channel prefix #{prefix}" unless @supports[:chantypes].includes?(prefix)
+ warn "#{self} doesn't support channel names this long (#{name.length} > #{@support[:channellen]}" unless name.length <= @supports[:channellen]
+
+ # Next, we check if we hit the limit for channels of type +prefix+
+ # if the server supports +chanlimit+
+ #
+ @supports[:chanlimit].keys.each { |k|
+ next unless k.includes?(prefix)
+ count = 0
+ @channel_names.each { |n|
+ count += 1 if k.includes?(n[0].chr)
+ }
+ raise IndexError, "Already joined #{count} channels with prefix #{k}" if count == @supports[:chanlimits][k]
+ }
+
+ # So far, everything is fine. Now create the actual Channel
+ #
+ chan = Channel.new(name, topic, users, self.casemap)
+
+ # We wade through +prefix+ and +chanmodes+ to create appropriate
+ # lists and flags for this channel
+
+ @supports[:prefix][:modes].each { |mode|
+ chan.new_userlist(mode)
+ } if @supports[:prefix][:modes]
+
+ @supports[:chanmodes].each { |k, val|
+ if val
+ case k
+ when :addr_list
+ val.each { |mode|
+ chan.new_netmasklist(mode)
+ }
+ when :has_param, :set_param
+ val.each { |mode|
+ chan.new_data_flag(mode)
+ }
+ when :no_params
+ val.each { |mode|
+ chan.new_bool_flag(mode)
+ }
+ end
+ end
+ }
+
+ # * appropriate @flags
+ # * a UserList for each @supports[:prefix]
+ # * a NetmaskList for each @supports[:chanmodes] of type A
+
+ @channels << newchan
+ @channel_names << name
+ return newchan
+ end
+
+ raise "Channel #{name} already exists on server #{self}" if fails
+ return get_channel(name)
+ end
+
+ # Remove Channel _name_ from the list of <code>Channel</code>s
+ #
+ def delete_channel(name)
+ idx = has_channel?(name)
+ raise "Tried to remove unmanaged channel #{name}" unless idx
+ @channel_names.delete_at(idx)
+ @channels.delete_at(idx)
+ end
+
+ # Checks if the receiver already has a user with the given _nick_
+ #
+ def has_user?(nick)
+ @user_nicks.index(nick)
+ end
+
+ # Returns the user with nick _nick_, if available
+ #
+ def get_user(nick)
+ idx = @user_nicks.index(name)
+ @users[idx] if idx
+ end
+
+ # Create a new User object and add it to the list of
+ # <code>User</code>s on the receiver, unless the User
+ # was present already. In this case, the default action is
+ # to raise an exception, unless _fails_ is set to false
+ #
+ # The User is automatically created with the appropriate casemap
+ #
+ def new_user(str, fails=true)
+ tmp = User.new(str, self.casemap)
+ if !has_user?(tmp.nick)
+ warn "#{self} doesn't support nicknames this long (#{tmp.nick.length} > #{@support[:nicklen]}" unless tmp.nick.length <= @supports[:nicklen]
+ @users << tmp
+ @user_nicks << tmp.nick
+ return @users.last
+ end
+ old = get_user(tmp.nick)
+ raise "User #{tmp.nick} has inconsistent Netmasks! #{self} knows #{old} but access was tried with #{tmp}" if old != tmp
+ raise "User #{tmp} already exists on server #{self}" if fails
+ return get_user(tmp)
+ end
+
+ # Returns the User with the given Netmask on the server,
+ # creating it if necessary. This is a short form for
+ # new_user(_str_, +false+)
+ #
+ def user(str)
+ new_user(str, false)
+ end
+
+ # Remove User _someuser_ from the list of <code>User</code>s.
+ # _someuser_ must be specified with the full Netmask.
+ #
+ def delete_user(someuser)
+ idx = has_user?(user.nick)
+ raise "Tried to remove unmanaged user #{user}" unless idx
+ have = self.user(user)
+ raise "User #{someuser.nick} has inconsistent Netmasks! #{self} knows #{have} but access was tried with #{someuser}" if have != someuser
+ @user_nicks.delete_at(idx)
+ @users.delete_at(idx)
+ end
+
+ # Create a new Netmask object with the appropriate casemap
+ #
+ def new_netmask(str)
+ if str.class <= Netmask
+ raise "Wrong casemap for Netmask #{str.inspect}" if str.casemap != self.casemap
+ return str
+ end
+ Netmask.new(str, self.casemap)
+ end
+
+ # Finds all <code>User</code>s on server whose Netmask matches _mask_
+ #
+ def find_users(mask)
+ nm = new_netmask(mask)
+ @users.inject(UserList.new) {
+ |list, user|
+ list << user if user.matches?(nm)
+ list
+ }
+ end
+ end
+end
+
+# TODO test cases
+
+if __FILE__ == $0
+
+include Irc
+
+ # puts " -- irc_regexp tests"
+ # ["*", "a?b", "a*b", "a\\*b", "a\\?b", "a?\\*b", "*a*\\**b?"].each { |s|
+ # puts " --"
+ # puts s.inspect
+ # puts s.to_irc_regexp.inspect
+ # puts "aUb".match(s.to_irc_regexp)[0] if "aUb" =~ s.to_irc_regexp
+ # }
+
+ # puts " -- Netmasks"
+ # masks = []
+ # masks << Netmask.new("start")
+ # masks << masks[0].dup
+ # masks << Netmask.new(masks[0])
+ # puts masks.join("\n")
+
+ # puts " -- Changing 1"
+ # masks[1].nick = "me"
+ # puts masks.join("\n")
+
+ # puts " -- Changing 2"
+ # masks[2].nick = "you"
+ # puts masks.join("\n")
+
+ # puts " -- Channel example"
+ # ch = Channel.new("#prova")
+ # p ch
+ # puts " -- Methods"
+ # puts ch.methods.sort.join("\n")
+ # puts " -- Instance variables"
+ # puts ch.instance_variables.join("\n")
+
+end
|