nadoka 0.8.0

data/nadoka.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'ndk/version'
+
+Gem::Specification.new do |s|
+  s.name        = "nadoka"
+  s.version     = Nadoka::VERSION
+  s.authors     = ["Kazuhiro NISHIYAMA", "SASADA Koichi"]
+  s.email       = ["kzhr.nsym\@gmail.com"]
+  s.homepage    = "https://github.com/nadoka/nadoka"
+  s.summary     = %q{IRC logger, monitor and proxy program ("bot")}
+  s.description = %q{
+ Nadoka is a tool for monitoring and logging IRC conversations and
+ responding to specially formatted requests. You define and customize
+ these responses in Ruby. Nadoka is conceptually similar to Madoka, an
+ older proxy written in Perl.
+}.tr_s(" \n", " ").strip
+
+  s.rubyforge_project = "nadoka"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/nadoka.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+#
+##
+## Nadoka:
+##  Irc Client Server Program
+##
+#
+# Copyright (c) 2004-2005 SASADA Koichi <ko1 at atdot.net>
+#
+# This program is free software with ABSOLUTELY NO WARRANTY.
+# You can re-distribute and/or modify this program under
+# the same terms of the Ruby's license.
+#
+#
+# $Id$
+# Create : K.S. 03/07/10 20:29:07
+#
+
+unless "".respond_to?(:force_encoding)
+  class String
+    def force_encoding(enc)
+      self
+    end
+  end
+end
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'ndk/version'
+
+if $0 == __FILE__
+
+require 'optparse'
+
+require 'ndk/server'
+require 'ndk/bot'
+
+$stdout.sync=true
+$NDK_Debug  = false
+
+unless defined? Process.daemon
+  def Process.daemon(nochdir = nil, noclose = nil)
+    exit!(0) if fork
+    Process.setsid
+    exit!(0) if fork
+    Dir.chdir('/') unless nochdir
+    File.umask(0)
+    unless noclose
+      STDIN.reopen('/dev/null')
+      STDOUT.reopen('/dev/null', 'w')
+      STDERR.reopen('/dev/null', 'w')
+    end
+  end
+end
+
+rcfile = nil
+daemon = false
+optparse = OptionParser.new{|opts|
+  opts.banner = "Usage: ruby #{$0} [options]"
+
+  opts.separator ""
+  opts.separator "Require options:"
+
+  opts.on("-r", "--rc [RCFILE]",
+          "Specify rcfile(required)"){|f|
+    rcfile = f
+  }
+
+  opts.separator ""
+  opts.separator "Optional:"
+
+  opts.on("-d", "--debug",
+          "Debug Nadoka"){
+    $NDK_Debug = true
+    $DEBUG = true
+    
+    puts 'Enter Nadoka Debug mode'
+  }
+  opts.on("--daemon", "run as daemon"){
+    daemon = true
+  }
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on_tail("-h", "--help", "Show this message"){
+    puts Nadoka.version
+    puts opts
+    exit
+  }
+  opts.on_tail("-v", "--version", "Show version"){
+    puts Nadoka.version
+  }
+}
+optparse.parse!(ARGV)
+
+unless rcfile
+  puts Nadoka.version
+  puts optparse
+  exit
+end
+
+if daemon
+  Process.daemon
+end
+
+begin
+  GC.start
+  Nadoka::NDK_Server.new(rcfile).start
+rescue Nadoka::NDK_QuitProgram
+  #
+rescue Nadoka::NDK_RestartProgram
+  GC.start
+  ObjectSpace.each_object(Socket) {|sock| sock.close}
+  retry
+rescue Exception => e
+  open('nadoka_fatal_error', 'w'){|f|
+    f.puts e
+    f.puts e.backtrace.join("\n")
+  } 
+end
+
+end
+

data/nadokarc

@@ -0,0 +1,267 @@
+## -*-ruby-*- vim: set filetype=ruby :
+##
+## Nadoka Sample resource file
+## $Id$
+#
+# Copyright (c) 2004-2005 SASADA Koichi <ko1 at atdot.net>
+#
+# This program is free software with ABSOLUTELY NO WARRANTY.
+# You can re-distribute and/or modify this program under
+# the same terms of the Ruby's lisence.
+#
+#
+
+class NADOKA_Config < Nadoka::NDK_ConfigBase
+
+  ###############################################
+  # System setting
+  
+  # Setting_name = 'IRCNet'
+  #  # If you don't specify Setting_name,
+  #  # system use rc file name as setting name
+  #  # if your rc file is "test.rc", setting name is "test"
+  #  # (remove last .rc)
+  #
+  
+  # 0: quiet
+  # 1: ch log only
+  # 2: normal
+  # 3: debug
+  Loglevel = 2
+
+
+  ###############################################
+  # client server setting
+  Client_server_port = 6667 # or nil (no listen)
+  Client_server_host = nil # You can specify binding host(interface)
+  Client_server_pass = 'NadokaPassWord'
+  Client_server_acl  = nil
+
+  # ACL(Access Control List) example:
+  # Client_server_acl = %q{
+  #   deny all
+  #   allow 192.168.1.1
+  #   allow 192.168.2.0/24
+  # } # ACL setting must be String
+  #
+  # or you can set acl directly like follows:
+  #
+  # ACL_Object = ::ACL.new(...)
+  #
+
+
+  ###############################################
+  # server setting
+
+  # IRCnet servers in Japan
+  Servers = [
+    { :host => 'irc.ircnet.ne.jp',
+      :port => 6667,                       # default: 6667
+      :pass => nil,                        # default: nil
+    },
+    { :host => 'irc.media.kyoto-u.ac.jp',
+      :port => (6660 .. 6669),
+    },
+    { :host => 'irc.huie.hokudai.ac.jp',
+      # without :port, use 6667 as default port
+    },
+    # IPv6 Sample
+    # {
+    #   :host => 'irc6.ircnet.ne.jp',
+    #   :port => 6667,
+    # },
+    # {
+    #   :host => 'irc6.livedoor.ne.jp',
+    #   :port => (6660 .. 6669),
+    # },
+  ]
+
+  #Servers = [
+    # SSL Sample
+    # {
+    #   :host => 'ircs.example.net',
+    #   :port => 6697,
+    #   :ssl_params => { # with :ssl_params hash, use ssl
+    #     # :ca_cert => "/etc/ssl/certs", # default: openssl's default certificates
+    #  },
+    # },
+  #]
+
+
+  ###############################################
+  # userinfo
+  User     = ENV['USER'] || ENV['USERNAME'] || 'nadokatest'
+  Nick     = ENV['USER'] || ENV['USERNAME'] || 'ndk_nick'
+  Hostname = Socket.gethostname
+  Realname = 'nadoka user'
+  Mode     = nil
+
+  Away_Message = 'away'
+
+  # If this item is String, your nick will
+  # be that when no clients are connected.
+  Away_Nick    = nil
+
+  # Quit_Message = "Quit Nadoka"
+
+
+  ###############################################
+  # channel info
+
+  # log filename format
+  #  ${setting_name} : Setting name
+  #  ${channel_name} : Channel name
+  #  %? : Time#strftime format(see ruby reference)
+  #
+
+
+  Default_log = {
+    :file           => '${setting_name}-${channel_name}/%y%m%d.log',
+    :time_format    => '%H:%M:%S',
+    :message_format => {
+      'PRIVMSG' => '<{nick}> {msg}',
+      'NOTICE'  => '{{nick}} {msg}',
+      'JOIN'    => '+ {nick} ({prefix:user}@{prefix:host})',
+      'NICK'    => '* {nick} -> {newnick}',
+      'QUIT'    => '- {nick} (QUIT: {msg}) ({prefix:user}@{prefix:host})',
+      'PART'    => '- {nick} (PART: {msg}) ({prefix:user}@{prefix:host})',
+      'KICK'    => '- {nick} was kicked by {kicker} ({msg})',
+      'MODE'    => '* {nick} changed mode ({msg})',
+      'TOPIC'   => '* TOPIC: {msg} (by {nick})',
+      'SYSTEM'  => '[NDK] {orig}',
+      'OTHER'   => '{orig}',
+      'SIMPLE'  => '{orig}',
+    },
+  }
+
+  System_log = {
+    :file           => '${setting_name}-system.log',
+    :time_format    => '%y/%m/%d-%H:%M:%S',
+    :message_format => {
+      'PRIVMSG' => '{ch} <{nick}> {msg}',
+      'NOTICE'  => '{ch} {{nick}} {msg}',
+      'JOIN'    => '{ch} + {nick} ({prefix:user}@{prefix:host})',
+      'NICK'    => '{ch} * {nick} -> {newnick}',
+      'QUIT'    => '{ch} - {nick} (QUIT: {msg}) ({prefix:user}@{prefix:host})',
+      'PART'    => '{ch} - {nick} (PART: {msg}) ({prefix:user}@{prefix:host})',
+      'KICK'    => '{ch} - {nick} was kicked by {kicker} ({msg})',
+      'MODE'    => '{ch} * {nick} changed mode ({msg})',
+      'TOPIC'   => '{ch} * TOPIC:  {msg} (by {nick})',
+      'SYSTEM'  => '[NDK] {orig}',
+      'OTHER'   => nil,
+      'SIMPLE'  => nil,
+    },
+  }
+
+  Talk_log = {
+    :file           => '${setting_name}-talk/%y%m%d.log',
+    :time_format    => Default_log[:time_format],
+    :message_format => {
+      'PRIVMSG' => '[{sender} => {receiver}] {msg}',
+      'NOTICE'  => '{{sender} => {receiver}} {msg}',
+    }
+  }
+
+  Channel_info = {
+    # nadoka talk (from Japanese server only)
+    '#nadoka' => {
+      # timing
+      #  :startup / when nadoka start up <= default
+      #  :login   / when user login
+      #  otherwise nadoka won't login automatically
+      :timing  => :startup,
+      :log     => '${setting_name}-nadoka-chan/%y%m%d.log',
+      # :part_message => "bye bye"
+      # :initial_mode => "+s"
+    },
+    '#nadoka:*.jp' => {
+      :timing  => :startup,
+      :log     => '${setting_name}-nadoka-chan-jp/%y%m%d.log',
+    },
+
+    # nadoka bot channel
+    '#nadoka_check' => {
+      :timing => :startup,
+      :log => '${setting_name}-nadoka-check/%y%m%d.log',
+      # you can specify store backlog lines
+      :backlog_lines => 5,
+    },
+
+    # 
+    # '#log_setting_example' => {
+    #   :log => {
+    #      :file        => 'logfilename',   # log filename
+    #      # :io => $stderr, # or IO object is supported
+    #      :time_format => '%H:%M:%S',
+    #      # :channel_name_in_file_name => 'hoge'
+    #
+    #      :message_format => {
+    #        'PRIVMSG' => '<{nick}> {msg}',
+    #        'NOTICE'  => '{{nick}} {msg}',
+    #        'JOIN'    => '+ {nick} to {ch}',
+    #        'NICK'    => '* {nick} -> {newnick}',
+    #        'QUIT'    => '- {nick} ({msg})',
+    #        'PART'    => '- {nick} from {ch} ({msg})',
+    #        'KICK'    => '- {nick} kicked by {kicker} ({msg}) from {ch}',
+    #        'MODE'    => '* {nick} changed mode ({msg})',
+    #        'TOPIC'   => '<{ch} TOPIC> {msg}',
+    #        'SYSTEM'  => '[NDK] {msg}',
+    #        'OTHER'   => nil,
+    #        'SIMPLE'  => nil,
+    #   
+    #     # for more complex log output:
+    #     # :logwriterclass => your_log_writer_class,
+    #     # :logwriter      => your_log_writer_instance,
+    #     # :other_logwriterclass_specific_setting => ...,
+    #   },
+    # },
+  }
+
+  BackLog_Lines = 20
+
+  #
+  # FilenameEncoding = 'euc'
+  # FilenameEncoding = 'sjis'
+  # FilenameEncoding = 'utf8'
+  #
+  # If you not specify FilenameEncoding, nadoka infers
+  # suitable encoding (see ndk/config.rb).
+  #
+  
+  ###############################################
+  # Directory
+  Log_dir     = './log'
+
+  #Plugins_dir = './plugins'
+  Plugins_dir = Default_Plugins_dir
+  # You can set Plugins_dir as Enumerable object.
+  # ex: ['./dir1', './dir2', ...]
+
+
+  ###############################################
+  # Bots
+  BotConfig = [
+    # :BotName1,
+    # :BotName1,
+    # 'BotName1',
+    # :BotName2,
+    # { :name => :BotName3,
+    #   :set1 => setting1,
+    # },
+    # { :name => :BotName3,
+    #   :set1 => setting2,
+    # },
+    # { :name => :BotName4,
+    #   :set1 => setting3,
+    # },
+
+    :BackLogBot, # strongly recommended
+  ]
+
+
+  ###############################################
+  # Misc
+
+  Privmsg_Filter = nil
+  Notice_Filter  = nil
+end

data/ndk/bot.rb

@@ -0,0 +1,241 @@
+#
+# Copyright (c) 2004-2005 SASADA Koichi <ko1 at atdot.net>
+#
+# This program is free software with ABSOLUTELY NO WARRANTY.
+# You can re-distribute and/or modify this program under
+# the same terms of the Ruby's licence.
+#
+#
+# $Id$
+# Create : K.S. 04/04/19 00:39:48
+#
+#
+# To make bot for nadoka, see this code.
+#
+
+module Nadoka
+  class NDK_Bot
+    # To initialize bot instance, please override this.
+    def bot_initialize
+      # do something
+    end
+
+    # This method will be called when reload configuration.
+    def bot_destruct
+      # do something
+    end
+
+    # override me
+    def bot_state
+      info = "#<#{self.class}: #{@bot_config.inspect}>"
+      if info.length > 100
+        info[0..100] + '...'
+      else
+        info
+      end
+    end
+
+    # To access bot configuration, please use this.
+    #
+    # in configuration file,
+    # BotConfig = [
+    # :BotClassName1,
+    # :BotClassName2,
+    # {
+    #   :name => :BotClassName3,
+    #   :setX => X,
+    #   :setY => Y,
+    #   ...
+    # },
+    # ]
+    #
+    # You can access above setting via @bot_config
+    #
+
+    def bot_init_utils
+      bot_init_available_channel
+      bot_init_same_bot
+    end
+
+    def bot_init_available_channel
+      if @bot_config.key?(:channels)
+        channels = '\A(?:' + @bot_config[:channels].collect{|ch|
+          Regexp.quote(ch)
+        }.join('|') + ')\z'
+        @available_channel = Regexp.compile(channels)
+      else
+        @available_channel = @bot_config[:ch] || //
+      end
+    end
+
+    def bot_init_same_bot
+      @same_bot = @bot_config[:same_bot] || /(?!)/
+    end
+
+    def same_bot?(ch)
+      if @state.channel_users(ccn(ch)).find{|x| @same_bot =~ x }
+        true
+      else
+        false
+      end
+    end
+
+    def ccn2rcn ccn
+      chs = @manager.state.current_channels[ccn]
+      chs ? chs.name : ccn
+    end
+
+    # Mostly, you need this method.
+    def send_notice ch, msg
+      rch = ccn2rcn(ch)
+      msg = Cmd.notice(rch, msg)
+      @manager.send_to_server  msg
+      @manager.send_to_clients_otherwise msg, nil
+    end
+
+    # Usually, you must not use this
+    def send_privmsg ch, msg
+      rch = ccn2rcn(ch)
+      msg = Cmd.privmsg(rch, msg)
+      @manager.send_to_server  msg
+      @manager.send_to_clients_otherwise msg, nil
+    end
+
+    # Change user's mode as 'mode' on ch.
+    def change_mode ch, mode, user
+      rch = ccn2rcn(ch)
+      send_msg Cmd.mode(rch, mode, user)
+    end
+
+    # Change your nick to 'nick'.
+    def change_nick nick
+      send_msg Cmd.nick(nick)
+    end
+
+    # Send command or reply(?) to server.
+    def send_msg msg
+      @manager.send_to_server msg
+    end
+
+    # ccn or canonical_channel_name
+    def canonical_channel_name ch
+      @config.canonical_channel_name ch
+    end
+    alias ccn canonical_channel_name
+
+=begin
+    # ...
+    # def on_[IRC Command or Reply(3 digits)] prefix(nick only), param1, param2, ...
+    #   
+    # end
+    #
+
+    # like these
+    def on_privmsg prefix, ch, msg
+      
+    end
+    
+    def on_join prefix, ch
+      
+    end
+    
+    def on_part prefix, ch, msg=''
+      
+    end
+    
+    def on_quit prefix, msg=''
+      
+    end
+    
+    def on_xxx prefix, *params
+      
+    end
+    
+    In above methods, you can access nick, user, host information
+    via prefix argument variable like this.
+
+    - prefix.nick
+    - prefix.user
+    - prefix.host
+
+    
+    ######
+    # special event
+
+    # This method will be called when received every message
+    def on_every_message prefix, command, *args
+      # 
+    end
+
+    # if 'nick' user quit client and part ch, this event is called.
+    def on_quit_from_channel ch, nick, qmsg
+      # do something
+    end
+    
+    # It's special event that will be called about a minute.
+    def on_timer timeobj
+      # do something
+    end
+
+    # It's special event that will be called when new client join.
+    def on_client_login client_count, client
+      # do something
+    end
+
+    # It's special event that will be called when a client part.
+    def on_client_logout client_count, client
+      # do something
+    end
+
+    # undocumented
+    def on_client_privmsg client, ch, msg
+      # do something
+    end
+    # undocumented
+    def on_nadoka_command client, command, *params
+      # do something
+    end
+
+    # undocumented
+    def on_server_connected
+      # do something
+    end
+
+    # on signal 'sigusr[12]' trapped
+    def on_sigusr[12] # no arguments
+      # do something
+    end
+    
+    You can access your current state on IRC server via @state.
+    - @state.nick         # your current nick
+    - @state.channels     # channels which you are join        ['ch1', 'ch2', ...]
+
+    # need canonicalized channel name
+    - @state.channel_users(ch) # channel users ['user1', ...]
+    - @state.channel_user_mode(ch, nick)
+    
+=end
+
+    Cmd = ::Nadoka::Cmd
+    Rpl = ::Nadoka::Rpl
+
+    def initialize manager, config, bot_config
+      @manager    = manager
+      @config     = config
+      @logger     = config.logger
+      @state      = manager.state
+      @bot_config = bot_config
+
+      bot_initialize
+    end
+
+    def config
+      @bot_config
+    end
+
+    def self.inherited klass
+      NDK_Config::BotClasses[klass.name.downcase.intern] = klass
+    end
+  end
+end
+