blur 1.8.6 → 2.1.6

data/library/blur/encryption/base64.rb

@@ -1,71 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  module Encryption
-    # The +Encryption::Base64+ module differs from the original Base64
-    # implementation. I'm not sure how exactly, perhaps the charset?
-    #
-    # I originally found the Ruby implementation of FiSH on a website where
-    # it was graciously submitted by an anonymous user, since then I've
-    # implemented it in a weechat script, and now I've refactored it for use in
-    # Blur.
-    #
-    # @see http://maero.dk/pub/sources/weechat/ruby/autoload/fish.rb
-    module Base64
-      # The difference I suspect between the original Base64 implementation
-      # and the one used in FiSH.
-      Charset = "./0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
-
-      # Decode a base64-encoded string.
-      #
-      # @return [String] Base64-decoded string.
-      def self.decode string
-        unless string.length % 12 == 0
-          raise BadInputError, "input has to be a multiple of 12 characters."
-        end
-
-        String.new.tap do |buffer|
-          j = -1
-          
-          while j < string.length - 1
-            right, left = 0, 0
-
-            6.times{|i| right |= Charset.index(string[j += 1]) << (i * 6) }
-            6.times{|i| left  |= Charset.index(string[j += 1]) << (i * 6) }
-
-            4.times do |i|
-              buffer << ((left & (0xFF << ((3 - i) * 8))) >> ((3 - i) * 8)).chr
-            end
-
-            4.times do |i|
-              buffer << ((right & (0xFF << ((3 - i) * 8))) >> ((3 - i) * 8)).chr
-            end
-          end
-        end
-      end
-
-      # Encode a string-cipher.
-      #
-      # @return [String] Base64-encoded string.
-      def self.encode string
-        unless string.length % 8 == 0
-          raise BadInputError, "input has to be a multiple of 8 characters."
-        end
-
-        left = 0
-        right = 0
-        decimals = [24, 16, 8, 0]
-
-        String.new.tap do |buffer|
-          string.each_block do |block|
-            4.times{|i| left  += (block[i].ord << decimals[i]) }
-            4.times{|i| right += (block[i+4].ord << decimals[i]) }
-
-            6.times{|i| buffer << Charset[right & 0x3F].chr; right = right >> 6 }
-            6.times{|i| buffer << Charset[left  & 0x3F].chr; left = left >> 6 }
-          end
-        end
-      end
-    end
-  end
-end

data/library/blur/encryption/fish.rb

@@ -1,80 +0,0 @@
-# encoding: utf-8
-
-require 'crypt/blowfish'
-
-module Blur
-  module Encryption
-    # The +FiSH+ algorithm is a combination of Base64 encoding
-    # and the blowfish encryption.
-    #
-    # Shared text messages are prepended by "++OK+", an older implementation
-    # prepends it with "+mcps+" - Blur drops support for that implementation.
-    #
-    # There's multiple client-implementations available on the official FiSH
-    # homepage.
-    #
-    # == DH1080 Key exchange
-    # The newer FiSH implementation introduces a 1080bit Diffie-Hellman 
-    # key-exchange mechanism.
-    #
-    # Blur does currently not support key exchanges.
-    class FiSH
-      # The standard FiSH block-size.
-      BlockSize = 8
-
-      # @return [String] the blowfish salt-key.
-      attr_accessor :keyphrase      
-
-      # Change the keyphrase and instantiate a new blowfish object.
-      def keyphrase= keyphrase
-        @keyphrase = keyphrase
-        @blowfish = Crypt::Blowfish.new @keyphrase
-      end
-
-      # Instantiate a new fish-encryption object.
-      def initialize keyphrase
-        @keyphrase = keyphrase
-        @blowfish = Crypt::Blowfish.new keyphrase
-      end
-
-      # Encrypt an input string using the keyphrase stored in the +@blowfish+
-      # object.
-      #
-      # @return [String] the encrypted string.
-      def encrypt string
-        String.new.tap do |buffer|
-          nullpad(string).each_block do |block|
-            chunk = @blowfish.encrypt_block block
-            buffer.concat Base64.encode chunk
-          end
-        end
-      end
-
-      # Decrypt an input string using the keyphrase stored in the +@blowfish+
-      # object.
-      #
-      # @return [String] the decrypted string.
-      def decrypt string
-        unless string.length % 12 == 0
-          raise BadInputError, "input has to be a multiple of 12 characters."
-        end
-          
-        String.new.tap do |buffer|
-          string.each_block 12 do |block|
-            chunk = @blowfish.decrypt_block Base64.decode block
-            buffer.concat chunk
-          end
-        end.rstrip
-      end
-      
-    private
-      # Fill up the last block with null-bytes until it's a multiple of 8.
-      #
-      # @return [String] the nullpadded string.
-      def nullpad string
-        length = string.length + BlockSize - string.length % BlockSize
-        string.ljust length, ?\0
-      end
-    end
-  end
-end

data/library/blur/encryption.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  # The +Encryption+ module extends the communication-functionality of
-  # the client. It is intended to enable helpers but also core functionality
-  # that encrypts the incoming and outgoing data of Blur.
-  #
-  # Encryption modules are not loaded into the VM until it's required.
-  module Encryption
-    # Indicates that user-input (a channel user message, e.g.) is in invalid
-    # format to a certain encryption algorithm.
-    class BadInputError < StandardError; end
-
-    autoload :FiSH,   "blur/encryption/fish"
-    autoload :Base64, "blur/encryption/base64"
-  end
-end

data/library/blur/enhancements.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-
-# Reopens the scope of the standard Exception-class to extend it with helpful
-# methods.
-class Exception
-  # The pattern to match against the backtrace log.
-  Pattern = /^.*?:(\d+):/
-  
-  # Retrieve the line on which the exception was raised from when raised inside
-  # a script.
-  #
-  # @return Fixnum the line of the script the exception was raised on.
-  def line
-    if result = backtrace[0].match(Pattern)
-      result[1].to_i + 1
-    end
-  end
-end
-
-# Reopens the scope of the standard String-class to extend it with helpful
-# methods.
-class String
-  # Checks if the string contains nothing but a numeric value.
-  #
-  # @return true if it is a numeric value.
-  def numeric?
-    self =~ /^\d+$/
-  end
-
-  # Split a string up in n chunks and then iterate through them, exactly like
-  # Enumerable#each_slice.
-  #
-  # @return [Enumerator] list of slices.
-  # @yieldreturn [Array] list of elements in each slice consecutively.
-  def each_slice size = 8
-    self.chars.each_slice(size).each{|slice| yield slice.join }
-  end
-
-  alias_method :starts_with?, :start_with?
-  alias_method :each_block, :each_slice
-end

data/library/blur/evaluable.rb

@@ -1,13 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  module Evaluable
-    # Evaluate the contents of the input file in the context of +self+.
-    def evaluate_source_file path
-      instance_eval File.read(path), File.basename(path), 0
-      @__evaluated = true
-    rescue Exception => exception
-      puts "#{exception.message ^ :bold} on line #{exception.line.to_s ^ :bold}"
-    end
-  end
-end

data/library/blur/extension.rb

@@ -1,42 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  # +Extension+ provides a sort of modules for scripts, for common functionality.
-  #
-  # Think of it as a kind of scripts for scripts.
-  class Extension
-    include Evaluable
-    include Script::DSL
-    include Logging
-
-    # @return the path in which the script remains.
-    attr_accessor :__path
-    # Can be used inside the script to act with the client itself.
-    # @return [Network::Client] the client delegate.
-    attr_accessor :__client
-
-    # Instantiates a new extension context and evaluates the +path+ extension
-    # file.
-    def initialize path
-      @__path = path
-
-      if evaluate_source_file path
-        log.info "Loaded extension #{@__path}"
-      end
-    end
-
-    # Purely for DSL purposes.
-    #
-    # @example
-    #   Extension :http do
-    #     …
-    #   end
-    def Extension name, &block
-      @__name = name
-      
-      instance_eval &block
-      
-      true
-    end
-  end
-end

data/library/blur/network/channel.rb

@@ -1,91 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Network
-    # The +Channel+ class is used for encapsulating a channel and its properties.
-    #
-    # Users inside the channel is stored in the {#channels} attribute.
-    #
-    # Modes can be set for a channel, but Blur is not 
-    # {http://www.irc.org/tech_docs/005.html ISupport}-compliant yet.
-    #
-    # @todo make so that channels *and* users belongs to the network, and not
-    #   like now where the user belongs to the channel, resulting in multiple
-    #   user instances.
-    class Channel
-      # @return [String] the channels name.
-      attr_accessor :name
-      # @return [Array] a list of users in the channel.
-      attr_accessor :users
-      # @return [String] the channels topic.
-      attr_accessor :topic
-      # @return [String] all the modes set on the channel.
-      attr_accessor :modes
-      # @return [Network] a reference to the network.
-      attr_accessor :network
-      # @return [Encryption::Fish] the channel encryption, if any.
-      attr_accessor :encryption
-
-      # Check whether or not this is an encrypted channel.
-      def encrypted?; not @encryption.nil? end
-
-      # Instantiate a user with a nickname, a network and a user list.
-      def initialize name, network = nil, users = []
-        @name    = name
-        @users   = users
-        @modes   = ""
-        @network = network
-
-        users.each { |user| user.channel = self }
-      end
-
-      # Merge the channels mode corresponding to the leading character (+ or -).
-      #
-      # @param [String] modes the modes to merge with.
-      def merge_modes modes
-        addition = true
-
-        modes.each_char do |char|
-          case char
-          when ?+
-            addition = true
-          when ?-
-            addition = false
-          else
-            addition ? @modes.concat(char) : @modes.delete!(char)
-          end
-        end
-      end
-
-      # Send a message to the channel.
-      #
-      # @param [String] message the message to send.
-      def say message
-        @network.say self, message
-      end
-
-      # Find a user with +nick+ as its nickname.
-      #
-      # @param [String] nick the nickname to find the user of.
-      def user_by_nick nick
-        @users.find { |user| user.nick == nick }
-      end
-
-      # Convert it to a debug-friendly format.
-      def inspect
-        %{#<#{self.class.name} @name=#{@name.inspect} @users=#{@users.inspect}}
-      end
-      
-      # Called when YAML attempts to save the object, which happens when a
-      # scripts cache contains this user and the script is unloaded.
-      def to_yaml options = {}
-        @name.to_yaml options
-      end
-
-      # Get the channels name.
-      def to_s
-        @name
-      end
-    end
-  end
-end

data/library/blur/network/command.rb

@@ -1,83 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Network
-    # The +Command+ class is used for encapsulating the command-lines.
-    #
-    # Blur is using regular-expression for parsing, this is to be replaced
-    # with a more native way of parsing, making it much, much easier on the
-    # processor.
-    class Command
-      # @return [Symbol, Fixnum] the command name.
-      # @example
-      #   332 or :quit
-      attr_accessor :name
-      # @return [Array] a list of parameters.
-      attr_accessor :params
-      # @return [String] a hostname or a hostmask.
-      attr_accessor :prefix
-
-      # The arbitrary regex pattern.
-      Pattern = /^(?:[:@]([^\s]+) )?([^\s]+)(?: ((?:[^:\s][^\s]* ?)*))?(?: ?:(.*))?$/
-      
-      # Parse a line and encapsulate it as a Command.
-      #
-      # @return [Command] the parsed command.
-      # @example
-      #   Command.parse "ChanServ!ChanServ@services.uplink.io MODE #uplink +v mk"
-      #   # => #<Blur::Network::Command … >
-      def self.parse data
-        match = data.strip.match Pattern
-        prefix, name, args, extra = match.captures
-        params = extra ? args.split << extra : args.split
-
-        new(name, params).tap do |this|
-          this.prefix = prefix
-        end
-      end
-
-      # Get a parameter by its +index+.
-      def [] index; @params[index] end
-
-      # Instantiate a command.
-      #
-      # @see Command.parse
-      def initialize name, params = []
-        @name, @params = name, params
-      end
-
-      # Get the sender of the command.
-      #
-      # @note the return value is a string if it's a hostname, and an openstruct
-      #   with the attributes #nickname, #username and #hostname if it's a
-      #   hostmask.
-      #
-      # @return [String, OpenStruct] the sender.
-      def sender
-        return @sender if @sender
-
-        if prefix =~ /^(\S+)!(\S+)@(\S+)$/
-          @sender = OpenStruct.new nickname: $1, username: $2, hostname: $3
-        else
-          @sender = prefix
-        end
-      end
-
-      # Convert it to an IRC-compliant line.
-      #
-      # @return [String] the command line.
-      def to_s
-        String.new.tap do |line|
-          line << "#{prefix} " if prefix
-          line << name.to_s
-
-          params.each_with_index do |param, index|
-            line << ' '
-            line << ?: if index == params.length - 1 and param =~ /[ :]/
-            line << param.to_s
-          end
-        end
-      end
-    end
-  end
-end

data/library/blur/network/user.rb

@@ -1,106 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Network
-    # The +User+ class is used for encapsulating a user and its properties.
-    #
-    # The user owns a reference to its parent channel.
-    #
-    # Modes can be set for a user, but Blur is not 
-    # {http://www.irc.org/tech_docs/005.html ISupport}-compliant yet.
-    #
-    # @todo make so that channels *and* users belongs to the network, and not
-    #   like now where the user belongs to the channel, resulting in multiple
-    #   user instances.
-    class User
-      # @return [String] the users nickname.
-      attr_accessor :nick
-      # @return [String] the users username.
-      attr_accessor :name
-      # @return [String] the users hostname.
-      attr_accessor :host
-      # @return [String] all the modes set on the user.
-      attr_accessor :modes
-      # @return [Channel] a reference to the users channel.
-      attr_accessor :channel
-      # @return [Network] a reference to the network.
-      attr_accessor :network
-
-      # Check to see if the user is an admin (+a)
-      def admin?; @modes.include? "a" end
-      # Check to see if the user has voice (+v)
-      def voice?; @modes.include? "v" end
-      # Check to see if the user is the owner (+q)
-      def owner?; @modes.include? "q" end
-      # Check to see if the user is an operator (+o)
-      def operator?; @modes.include? "o" end
-      # Check to see if the user is an half-operator (+h)
-      def half_operator?; @modes.include? "h" end
-
-      # Instantiate a user with a nickname.
-      def initialize nick
-        @nick  = nick
-        @modes = ""
-        
-        if modes = prefix_to_mode(nick[0])
-          @nick  = nick[1..-1]
-          @modes = modes
-        end
-      end
-
-      # Merge the users mode corresponding to the leading character (+ or -).
-      #
-      # @param [String] modes the modes to merge with.
-      def merge_modes modes
-        addition = true
-
-        modes.each_char do |char|
-          case char
-          when ?+
-            addition = true
-          when ?-
-            addition = false
-          else
-            addition ? @modes.concat(char) : @modes.delete!(char)
-          end
-        end
-      end
-      
-      # Send a private message to the user.
-      #
-      # @param [String] message the message to send.
-      def say message
-        @network.say self, message
-      end
-      
-      # Convert it to a debug-friendly format.
-      def inspect
-        %{#<#{self.class.name} @nick=#{@nick.inspect} @channel=#{@channel.name.inspect}>}
-      end
-
-      # Called when YAML attempts to save the object, which happens when a
-      # scripts cache contains this user and the script is unloaded.
-      def to_yaml options = {}
-        @nick.to_yaml options
-      end
-      
-      # Get the users nickname.
-      def to_s
-        @nick
-      end
-
-    private
-
-      # Translate a nickname-prefix to a mode character.
-      def prefix_to_mode prefix
-        case prefix
-        when '@' then 'o'
-        when '+' then 'v'
-        when '%' then 'h'
-        when '&' then 'a'
-        when '~' then 'q'
-        end
-      end
-    end
-  end
-end

data/library/blur/script/cache.rb

@@ -1,77 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Script
-    # The +Cache+ class enables data storing inside Blur and it scripts.
-    #
-    # What it does is simply store a hash, and act like it is that hash.
-    #
-    # When the client closes, it sends a message to all available scripts
-    # and then those scripts tells the cache to save, in order to remember
-    # that data and reload it at the next run.
-    #
-    # Cache can then save the contents of the hash to a yaml file that persists
-    # in the ./cache/ directory.
-    #
-    # That same file is then loaded once needed again.
-    class Cache
-      # Get the path to the cache directory (./cache/)
-      def self.path
-        %{#{File.dirname File.expand_path $0}/cache}
-      end
-      
-      # Check if there exists a cache file for the script with name +name+.
-      def self.exists? name
-        File.exists? "#{path}/#{name}.yml"
-      end
-      
-      # Get a cache value by key.
-      def [] key; @hash[key] end
-
-      # Set a cache value by key.
-      def []= key, value; @hash[key] = value end
-      
-      # Instantiate a cache with a script reference.
-      def initialize script
-        @hash   = {}
-        @script = script
-      end
-      
-      # Save all internal data to a yaml file in the cache directory.
-      def save
-        directory = File.dirname path
-        
-        unless File.directory? directory
-          Dir.mkdir directory
-        end
-        
-        File.open path, ?w do |file|
-          YAML.dump @hash, file
-        end
-      end
-      
-      # Load a yaml file as internal data from the cache directory.
-      #
-      # @return [Hash] the loaded data.
-      def load
-        if yaml = YAML.load_file(path)
-          @hash = yaml
-        end
-      rescue
-        File.unlink path
-      end
-      
-      # Let Hash#to_s do the job.
-      def to_s; @hash end
-      
-    private
-    
-      # The current caches file path.
-      #
-      # @return [String] the file path.
-      def path
-        %{#{Cache.path}/#{@script.__name}.yml}
-      end
-    end
-  end
-end

data/library/blur/script/commands.rb

@@ -1,77 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Script
-    # The +Commands+ module is a module that gives the ability to turn a
-    # script into a DSL-like framework.
-    module Commands
-      class Command
-        DefaultOptions = { prefix: '.', hostmask: nil }
-
-        def initialize triggers, options = {}, &block
-          @triggers = Array === triggers ? triggers : [triggers]
-          @options = DefaultOptions.merge options
-          @block = block
-        end
-
-        # Called by the Commands module.
-        #
-        # Calls the command block if the trigger matches the criteria.
-        def received_message user, channel, message
-          prefix = @options[:prefix]
-
-          # Return if the prefix don't match.
-          return unless message.start_with? prefix
-
-          # Return if the hostmask don't match.
-          # FIXME: Maybe use globbing instead of regular expressions?
-          unless @options[:hostmask].nil?
-            hostmask = "#{user.nick}!#{user.name}@#{user.host}"
-
-            return unless hostmask =~ @options[:hostmask]
-          end
-
-          command, args = split_message message
-
-          # Strip the prefix and compare the trigger name.
-          if self.matches_trigger? command
-            @block.call user, channel, args
-          end
-        end
-
-      protected
-
-        def split_message message
-          prefix = @options[:prefix]
-          command, args = message[prefix.length..-1].split $;, 2
-
-          return command, args
-        end
-
-        def matches_trigger? command
-          return @triggers.find{|trigger| trigger.to_s == command }
-        end
-      end
-
-      # Extend +base+ with self.
-      def self.extended base
-        base.instance_variable_set :@__commands, []
-      end
-
-      # Add a new command handler and trigger.
-      def command name, *args, &block
-        @__commands << Command.new(name, *args, &block)
-      end
-      
-      # Handle all calls to the scripts +message+ method, check to see if
-      # the message containts a valid command, serialize it and pass it to
-      # the script as command_name with the parameters +user+, +channel+
-      # and +message+.
-      def message user, channel, line
-        @__commands.each do |command|
-          command.received_message user, channel, line
-        end
-      end
-    end
-  end
-end