]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/botuser.rb
* move 'version' help to the module that actually supports the command
[user/henk/code/ruby/rbot.git] / lib / rbot / botuser.rb
index a6a3bf4accb2c286ab31c88aab00a5a9bba35d3d..6131a7b76436cbb6a5f4be9856d71aa5694f0226 100644 (file)
@@ -19,23 +19,24 @@ module Irc
 \r
     BotConfig.register BotConfigStringValue.new( 'auth.password',\r
       :default => 'rbotauth', :wizard => true,\r
-      :desc => 'Password for the bot owner' )\r
+      :on_change => Proc.new {|bot, v| bot.auth.botowner.password = v},\r
+      :desc => _('Password for the bot owner'))\r
     BotConfig.register BotConfigBooleanValue.new( 'auth.login_by_mask',\r
-      :default => 'false',\r
-      :desc => 'Set true if new botusers should allow logging in without a password when the user netmask is known')\r
-    BotConfig.register BotConfigBooleanValue.new( 'auth.login_auto',\r
-      :default => 'false',\r
-      :desc => 'Set true if new botusers should try to recognize IRC users without a need to manually login')\r
+      :default => 'true',\r
+      :desc => _('Set false to prevent new botusers from logging in without a password when the user netmask is known'))\r
+    BotConfig.register BotConfigBooleanValue.new( 'auth.autologin',\r
+      :default => 'true',\r
+      :desc => _('Set false to prevent new botusers from recognizing IRC users without a need to manually login'))\r
     # BotConfig.register BotConfigIntegerValue.new( 'auth.default_level',\r
     #   :default => 10, :wizard => true,\r
     #   :desc => 'The default level for new/unknown users' )\r
 \r
     # Generate a random password of length _l_\r
     #\r
-    def random_password(l=8)\r
+    def Auth.random_password(l=8)\r
       pwd = ""\r
-      8.times do\r
-        pwd += (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr\r
+      l.times do\r
+        pwd << (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr\r
       end\r
       return pwd\r
     end\r
@@ -76,7 +77,7 @@ module Irc
           k.to_sym\r
         }\r
         @command = path.last\r
-        debug "Created command #{@command.inspect} with path #{@path.join(', ')}"\r
+        debug "Created command #{@command.inspect} with path #{@path.pretty_inspect}"\r
       end\r
 \r
       # Returs self\r
@@ -101,6 +102,16 @@ class String
 end\r
 \r
 \r
+class Symbol\r
+\r
+  # Returns an Irc::Auth::Comand from the receiver\r
+  def to_irc_auth_command\r
+    Irc::Auth::Command.new(self)\r
+  end\r
+\r
+end\r
+\r
+\r
 module Irc\r
 \r
 \r
@@ -110,6 +121,7 @@ module Irc
     # This class describes a permission set\r
     class PermissionSet\r
 \r
+      attr_reader :perm\r
       # Create a new (empty) PermissionSet\r
       #\r
       def initialize\r
@@ -159,6 +171,12 @@ module Irc
     end\r
 \r
 \r
+    # This is the error that gets raised when an invalid password is met\r
+    #\r
+    class InvalidPassword < RuntimeError\r
+    end\r
+\r
+\r
     # This is the basic class for bot users: they have a username, a password,\r
     # a list of netmasks to match against, and a list of permissions.\r
     #\r
@@ -167,6 +185,7 @@ module Irc
       attr_reader :username\r
       attr_reader :password\r
       attr_reader :netmasks\r
+      attr_reader :perm\r
       attr_writer :login_by_mask\r
       attr_writer :autologin\r
 \r
@@ -176,8 +195,8 @@ module Irc
         @password = nil\r
         @netmasks = NetmaskList.new\r
         @perm = {}\r
-        @login_by_mask = Auth.manager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)\r
-        @autologin = Auth.manager.bot.config['auth.login_auto'] unless defined?(@autologin)\r
+        reset_login_by_mask\r
+        reset_autologin\r
       end\r
 \r
       # Inspection\r
@@ -191,6 +210,11 @@ module Irc
         str << ">"\r
       end\r
 \r
+      # In strings\r
+      def to_s\r
+        @username\r
+      end\r
+\r
       # Convert into a hash\r
       def to_hash\r
         {\r
@@ -209,6 +233,18 @@ module Irc
         @login_by_mask\r
       end\r
 \r
+      # Reset the login-by-mask option\r
+      #\r
+      def reset_login_by_mask\r
+        @login_by_mask = Auth.authmanager.bot.config['auth.login_by_mask'] unless defined?(@login_by_mask)\r
+      end\r
+\r
+      # Reset the autologin option\r
+      #\r
+      def reset_autologin\r
+        @autologin = Auth.authmanager.bot.config['auth.autologin'] unless defined?(@autologin)\r
+      end\r
+\r
       # Do we allow automatic logging in?\r
       #\r
       def autologin?\r
@@ -228,24 +264,25 @@ module Irc
       # This method sets the password if the proposed new password\r
       # is valid\r
       def password=(pwd=nil)\r
-        if pwd\r
+        pass = pwd.to_s\r
+        if pass.empty?\r
+          reset_password\r
+        else\r
           begin\r
-            raise InvalidPassword, "#{pwd} contains invalid characters" if pwd !~ /^[A-Za-z0-9]+$/\r
-            raise InvalidPassword, "#{pwd} too short" if pwd.length < 4\r
-            @password = pwd\r
+            raise InvalidPassword, "#{pass} contains invalid characters" if pass !~ /^[\x21-\x7e]+$/\r
+            raise InvalidPassword, "#{pass} too short" if pass.length < 4\r
+            @password = pass\r
           rescue InvalidPassword => e\r
             raise e\r
           rescue => e\r
-            raise InvalidPassword, "Exception #{e.inspect} while checking #{pwd}"\r
+            raise InvalidPassword, "Exception #{e.inspect} while checking #{pass.inspect} (#{pwd.inspect})"\r
           end\r
-        else\r
-          reset_password\r
         end\r
       end\r
 \r
       # Resets the password by creating a new onw\r
       def reset_password\r
-        @password = random_password\r
+        @password = Auth.random_password\r
       end\r
 \r
       # Sets the permission for command _cmd_ to _val_ on channel _chan_\r
@@ -293,7 +330,7 @@ module Irc
 \r
       # Removes all <code>Netmask</code>s\r
       #\r
-      def reset_netmask_list\r
+      def reset_netmasks\r
         @netmasks = NetmaskList.new\r
       end\r
 \r
@@ -316,7 +353,7 @@ module Irc
       # is right. If it is, the Netmask of the user is added to the\r
       # list of acceptable Netmask unless it's already matched.\r
       def login(user, password)\r
-        if password == @password or (password.nil? and @login_by_mask and knows?(user))\r
+        if password == @password or (password.nil? and (@login_by_mask || @autologin) and knows?(user))\r
           add_netmask(user) unless knows?(user)\r
           debug "#{user} logged in as #{self.inspect}"\r
           return true\r
@@ -334,7 +371,9 @@ module Irc
       # and replacing any nonalphanumeric character with _\r
       #\r
       def BotUser.sanitize_username(name)\r
-        return name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")\r
+        candidate = name.to_s.chomp.downcase.gsub(/[^a-z0-9]/,"_")\r
+        raise "sanitized botusername #{candidate} too short" if candidate.length < 3\r
+        return candidate\r
       end\r
 \r
     end\r
@@ -345,16 +384,15 @@ module Irc
     #\r
     class DefaultBotUserClass < BotUser\r
 \r
-      private :login, :add_netmask, :delete_netmask\r
+      private :add_netmask, :delete_netmask\r
 \r
       include Singleton\r
 \r
-      # The default BotUser is named 'everyone', it doesn't allow autologin\r
-      # (meaningless) and it allows login-by-mask\r
+      # The default BotUser is named 'everyone'\r
       #\r
       def initialize\r
-        @login_by_mask = true\r
-        @autologin = false\r
+        reset_login_by_mask\r
+        reset_autologin\r
         super("everyone")\r
         @default_perm = PermissionSet.new\r
       end\r
@@ -366,6 +404,12 @@ module Irc
         return @login_by_mask\r
       end\r
 \r
+      # The default botuser allows logins by mask\r
+      #\r
+      def reset_login_by_mask\r
+        @login_by_mask = true\r
+      end\r
+\r
       # This method returns without changing anything\r
       #\r
       def autologin=(val)\r
@@ -373,12 +417,18 @@ module Irc
         return\r
       end\r
 \r
+      # The default botuser doesn't allow autologin (meaningless)\r
+      #\r
+      def reset_autologin\r
+        @autologin = false\r
+      end\r
+\r
       # Sets the default permission for the default user (i.e. the ones\r
       # set by the BotModule writers) on all channels\r
       #\r
       def set_default_permission(cmd, val)\r
         @default_perm.set_permission(Command.new(cmd), val)\r
-        debug "Default permissions now:\n#{@default_perm.inspect}"\r
+        debug "Default permissions now: #{@default_perm.pretty_inspect}"\r
       end\r
 \r
       # default knows everybody\r
@@ -393,7 +443,7 @@ module Irc
       end\r
 \r
       # Resets the NetmaskList\r
-      def reset_netmask_list\r
+      def reset_netmasks\r
         super\r
         add_netmask("*!*@*")\r
       end\r
@@ -426,7 +476,7 @@ module Irc
 \r
       def initialize\r
         @login_by_mask = false\r
-        @autologin = false\r
+        @autologin = true\r
         super("owner")\r
       end\r
 \r
@@ -452,6 +502,7 @@ module Irc
 \r
       attr_reader :everyone\r
       attr_reader :botowner\r
+      attr_reader :bot\r
 \r
       # The instance manages two <code>Hash</code>es: one that maps\r
       # <code>Irc::User</code>s onto <code>BotUser</code>s, and the other that maps\r
@@ -497,6 +548,10 @@ module Irc
       end\r
 \r
       def load_array(ary, forced)\r
+        unless ary\r
+          warning "Tried to load an empty array"\r
+          return\r
+        end\r
         raise "Won't load with unsaved changes" if @has_changes and not forced\r
         reset_hashes\r
         ary.each { |x|\r
@@ -523,18 +578,20 @@ module Irc
 \r
       # Maps <code>Irc::User</code> to BotUser\r
       def irc_to_botuser(ircuser)\r
-        # TODO check netmasks\r
-        @botusers[ircuser.to_irc_user] || everyone\r
+        logged = @botusers[ircuser.to_irc_user]\r
+        return logged if logged\r
+        return autologin(ircuser)\r
       end\r
 \r
       # creates a new BotUser\r
       def create_botuser(name, password=nil)\r
         n = BotUser.sanitize_username(name)\r
         k = n.to_sym\r
-        raise "BotUser #{n} exists" if include?(k)\r
+        raise "botuser #{n} exists" if include?(k)\r
         bu = BotUser.new(n)\r
         bu.password = password\r
         @allbotusers[k] = bu\r
+        return bu\r
       end\r
 \r
       # returns the botuser with name _name_\r
@@ -548,13 +605,13 @@ module Irc
       #\r
       # It is possible to autologin by Netmask, on request\r
       #\r
-      def login(user, botusername, pwd)\r
+      def login(user, botusername, pwd=nil)\r
         ircuser = user.to_irc_user\r
         n = BotUser.sanitize_username(botusername)\r
         k = n.to_sym\r
         raise "No such BotUser #{n}" unless include?(k)\r
         if @botusers.has_key?(ircuser)\r
-          return true if @botusers[ircuser].name = n\r
+          return true if @botusers[ircuser].username == n\r
           # TODO\r
           # @botusers[ircuser].logout(ircuser)\r
         end\r
@@ -571,7 +628,7 @@ module Irc
       #\r
       def autologin(user)\r
         ircuser = user.to_irc_user\r
-        debug "Trying to autlogin #{ircuser}"\r
+        debug "Trying to autologin #{ircuser}"\r
         return @botusers[ircuser] if @botusers.has_key?(ircuser)\r
         @allbotusers.each { |n, bu|\r
           debug "Checking with #{n}"\r
@@ -590,7 +647,11 @@ module Irc
       # * everyone on all channels\r
       #\r
       def permit?(user, cmdtxt, channel=nil)\r
-        botuser = irc_to_botuser(user)\r
+        if user.class <= BotUser\r
+          botuser = user\r
+        else\r
+          botuser = irc_to_botuser(user)\r
+        end\r
         cmd = cmdtxt.to_irc_auth_command\r
 \r
         chan = channel\r
@@ -618,9 +679,19 @@ module Irc
         raise "Could not check permission for user #{user.inspect} to run #{cmdtxt.inspect} on #{chan.inspect}"\r
       end\r
 \r
-      # Checks if command _cmd_ is allowed to User _user_ on _chan_\r
+      # Checks if command _cmd_ is allowed to User _user_ on _chan_, optionally\r
+      # telling if the user is authorized\r
+      #\r
       def allow?(cmdtxt, user, chan=nil)\r
-        permit?(user, cmdtxt, chan)\r
+        if permit?(user, cmdtxt, chan)\r
+          return true\r
+        else\r
+          # cmds = cmdtxt.split('::')\r
+          # @bot.say chan, "you don't have #{cmds.last} (#{cmds.first}) permissions here" if chan\r
+          @bot.say chan, _("%{user}, you don't have '%{command}' permissions here") %\r
+                        {:user=>user, :command=>cmdtxt} if chan\r
+          return false\r
+        end\r
       end\r
 \r
     end\r