konn-rupircd 0.6.0 → 0.6.1

data/lib/rupircd/user.rb

@@ -0,0 +1,103 @@
+=begin
+= rupircd -- Ruby Pseudo IRC Deamon
+
+  ver 0.6 2009-08-11T23:45:52+09:00
+  
+  Copyright (c) 2009 Hiromi Ishii
+  
+  You can redistribute it and/or modify it under the same term as Ruby.
+=end
+
+require 'rupircd/channel'
+
+module IRCd
+
+class User
+  attr_reader :user, :host, :identifier, :socket
+  attr_accessor :nick, :away, :invisible, :wallop, :restriction, :operator, :local_operator, :s, :joined_channels, :real
+  @@identifier = 0
+
+  def to_s
+    @nick + "!" + @user + "@" + @host
+  end
+
+  def initialize(nick, user, host, real, socket, mode=0)
+    @nick = nick
+    @user = user
+    @host = host
+    @real = real
+    @identifier = (@@identifier += 1)
+    @away = ""
+    @invisible = false
+    @wallop = false
+    @restriction = false
+    @operator = false
+    @local_operator = false
+    @s = false
+    @socket = socket
+    @joined_channels = []
+  end
+
+  def away?
+    !@away.empty?
+  end
+
+  def to_a
+    [@nick, @user, @host, "*", @real]
+  end
+
+  def set_flags(*flags)
+    rls = []
+    flags.each{|flg|
+      fl = flg[0,1]
+      toggle = flg[0] == ?+
+      flg[1..-1].split("").each{|md|
+        case md
+        when "i"
+          @invisible = toggle
+          fl << "i"
+        when "w"
+          @wallop = toggle
+          fl << "w"
+        when"r"
+          if toggle
+            @restriction = true
+            fl << "r"
+          end
+        when "o"
+          unless toggle
+            @operator = false
+            fl << "o"
+          end
+        when "O"
+          unless toggle
+            @local_operator = false
+            fl << "O"
+          end
+        when "s"
+          @s = toggle
+          fl << "s"
+        end
+      }
+      rls << fl
+    }
+    rls
+  end
+
+  def get_mode_flags
+    mode = ""
+    mode << "i" if @invisible
+    mode << "w" if @wallop
+    mode << "r" if @restriction
+    mode << "o" if @operator
+    mode << "O" if @local_operator
+    mode << "s" if @s
+    mode
+  end
+
+  def ==(other)
+    @identifier == other.identifier
+  end
+
+end
+end

data/lib/rupircd/utils.rb

@@ -0,0 +1,32 @@
+=begin
+= rupircd -- Ruby Pseudo IRC Deamon
+
+  ver 0.6 2009-08-11T23:45:52+09:00
+  
+  Copyright (c) 2009 Hiromi Ishii
+  
+  You can redistribute it and/or modify it under the same term as Ruby.
+=end
+
+module IRCd
+
+module Utils
+
+  def channame?(str)
+    str =~ /^[#+!\+]/
+  end
+
+  def correct_nick?(nick)
+    nick =~ /^[a-zA-Z\x5B-\x60\x7B-\x7D][-\w\x5B-\x60\x7B-\x7D]{0,14}$/
+  end
+
+  def mask_to_regex(mask)
+    mask = Regexp.escape(mask)
+    mask.gsub!('\*', '.*')
+    mask.gsub!('\?', '.')
+    return Regexp.new('^' + mask + '$')
+  end
+
+end
+
+end

data/lib/rupircd.rb

@@ -0,0 +1,12 @@
+=begin
+= rupircd -- Ruby Pseudo IRC Deamon
+
+  ver 0.6 2009-08-11T23:45:52+09:00
+  
+  Copyright (c) 2009 Hiromi Ishii
+  
+  You can redistribute it and/or modify it under the same term as Ruby.
+=end
+
+require 'rupircd/server.rb'
+require 'rupircd/conf.rb'

data/mkpassword.rb

@@ -0,0 +1,3 @@
+require "digest/md5"
+
+p Digest::MD5.hexdigest(ARGV.shift)

data/motd.txt

@@ -0,0 +1,16 @@
+************** ほげほげほげほげ **************
+みんな！
+ほげほげしてるかい！？
+ほげほげしてないのなら
+いまからほげほげすればいいさ！
+
+ほげほげはせかいのほげほげだ！
+さあ、Let's ほげほげ！
+
+
+かの有名なパスカルは、
+　　　　「人間は、考えるほげほげである！」
+　　とさとったそうだよ！
+みんなも、パスカルに習って
+ほげほげしようぜ！！！！
+************** ほげほげほげほげ **************

data/rupircd.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rupircd}
+  s.version = "0.6.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["konn"]
+  s.date = %q{2009-08-12}
+  s.description = %q{rupircd is a light IRC daemon written in 100% pure ruby.}
+  s.email = %q{mr_konn[at]jcom[dot]home[dot]ne[dot]jp}
+  s.executables = ["mkpassword", "rupircd"]
+  s.extra_rdoc_files = [
+    "Changes.ja.rd",
+     "Changes.rd",
+     "README.ja.rd",
+     "README.rd",
+     "Usage.ja.rd",
+     "Usage.rd"
+  ]
+  s.files = [
+    "Changes.ja.rd",
+     "Changes.rd",
+     "Manifest",
+     "README.ja.rd",
+     "README.rd",
+     "Rakefile",
+     "Usage.ja.rd",
+     "Usage.rd",
+     "VERSION",
+     "bin/mkpassword",
+     "bin/rupircd",
+     "changes.html",
+     "changes.ja.html",
+     "index.html",
+     "index.ja.html",
+     "info.txt",
+     "ircd.rb",
+     "lib/rupircd.rb",
+     "lib/rupircd/channel.rb",
+     "lib/rupircd/conf.rb",
+     "lib/rupircd/message.rb",
+     "lib/rupircd/server.rb",
+     "lib/rupircd/user.rb",
+     "lib/rupircd/utils.rb",
+     "mkpassword.rb",
+     "motd.txt",
+     "rupircd.gemspec",
+     "sample.conf",
+     "usage.html",
+     "usage.ja.html"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/konn/rupircd}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{rupircd - RUby Pseudo IRC Daemon}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/sample.conf

@@ -0,0 +1,10 @@
+Conf = {
+  :Motd => open("motd.txt"){|f| f.read },
+  :Info => open("info.txt"){|f| f.read },
+  :Port => 6667,
+  :Opers => {"superoper*"=>"329435e5e66be809a656af105f42401e"},
+#  :Encoding => "UTF-8",
+  :MaxClients => 100,
+  :PINGInterval => 10,
+  :PINGLimit => 90,
+}

data/usage.html

@@ -0,0 +1,112 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>Usage.rd</title>
+</head>
+<body>
+<h1><a name="label-0" id="label-0">Usage</a></h1><!-- RDLabel: "Usage" -->
+<h2><a name="label-1" id="label-1">Start up</a></h2><!-- RDLabel: "Start up" -->
+<p>To start up server on 6667, to execute this command: </p>
+<pre>$ ruby ircd.rb [Configuration File(e.g. sample.conf)]</pre>
+<p>It might shut down when it received ^C (SIGINT).</p>
+<h2><a name="label-2" id="label-2">How to write configuration file</a></h2><!-- RDLabel: "How to write configuration file" -->
+<p>Contents of sample.conf might be like this:</p>
+<pre>Conf = {
+  :Motd =&gt; open("motd.txt"){|f| f.read }.tojis,
+  :Info =&gt; open("info.txt"){|f| f.read }.tojis,
+  :Port =&gt; 6667,
+  :Opers =&gt; {"superoper*"=&gt;"ea703e7aa1efda0064eaa507d9e8ab7e"},
+  :MaxClients =&gt; 100,
+  :PINGInterval =&gt; 300,
+  :PINGLimit =&gt; 90,
+}</pre>
+<p>As you can see, its contents is written in Ruby Hash Object.
+To configure, write like this;</p>
+<pre>　
+:name =&gt; value, </pre>
+<p>between "{" and "}" .</p>
+<p>For now, you can configure these items: </p>
+<dl>
+<dt><a name="label-3" id="label-3">:Motd</a></dt><!-- RDLabel: ":Motd" -->
+<dd>
+Set down the paragraph shown first when user connected to Server.  It's good to write the information, greetings, your poem, line-shoot, bla bla bla...
+In sample.conf, it is set to contents of "info.txt".
+</dd>
+<dt><a name="label-4" id="label-4">:Info</a></dt><!-- RDLabel: ":Info" -->
+<dd>
+Set down the paragraph for answer to INFO command.
+It's good to write server's information or history.
+In sample.conf, it is set to contents of "info.txt".
+</dd>
+<dt><a name="label-5" id="label-5">:Port</a></dt><!-- RDLabel: ":Port" -->
+<dd>
+The port server will be running on. Please select unused port. (recommended: 6660 ~ 6669).
+In sample.conf, it is set to 6667.
+</dd>
+<dt><a name="label-6" id="label-6">:Opers</a></dt><!-- RDLabel: ":Opers" -->
+<dd>
+Hash of password and the mask of server operator's name.
+To know more detail, read "((How to use OPER))".
+</dd>
+<dt><a name="label-7" id="label-7">:MaxClients</a></dt><!-- RDLabel: ":MaxClients" -->
+<dd>
+Number of the clients which can connect to server in same time.
+In sample.conf, it is set to 100.
+</dd>
+<dt><a name="label-8" id="label-8">:PINGInterval</a></dt><!-- RDLabel: ":PINGInterval" -->
+<dd>
+Interval of time to ping (sec).
+After some seconds(set down in :PINGLimit) server send to PING, server disconnect the clients if clients doesn't respond PONG.
+In sample.conf, it's set to 300sec.
+</dd>
+<dt><a name="label-9" id="label-9">:PINGLimit</a></dt><!-- RDLabel: ":PINGLimit" -->
+<dd>
+Seconds the server wait for PONG message from clients after server sent PING. 
+In sample.conf, it's set to 90 seconds.
+</dd>
+</dl>
+<p>I will add items when in the mood.</p>
+<h1><a name="label-10" id="label-10">How to use OPER</a></h1><!-- RDLabel: "How to use OPER" -->
+<h2><a name="label-11" id="label-11">Configuration</a></h2><!-- RDLabel: "Configuration" -->
+<p>Oper means Server Operator. It is user who has the authority to restart, stop  and rehash server.</p>
+<p>To become an Oper requires the pair of correct OPER nick name and password. Conversely, anybody can become an Oper if he/she knows those.
+To get authority of Oper, you have to send OPER message to the server.
+For example, if Oper nick name is oper and password is foo, to send this:</p>
+<pre>OPER oper1 hoge</pre>
+<p>to be an Oper.</p>
+<p>You can set these combination in the configuration file. Like this:</p>
+<dl>
+<dt><a name="label-12" id="label-12">Opers =&gt; {OPER1 =&gt; pass1, OPER2 =&gt; pass2, ...},</a></dt><!-- RDLabel: "Opers => {OPER1 => pass1, OPER2 => pass2, ...}," -->
+</dl>
+<p>For example, in sample.conf:</p>
+<dl>
+<dt><a name="label-13" id="label-13">Opers =&gt; {"superoper*" =&gt; "ea703e7aa1efda0064eaa507d9e8ab7e"},</a></dt><!-- RDLabel: "Opers => {"superoper*" => "ea703e7aa1efda0064eaa507d9e8ab7e"}," -->
+</dl>
+<p>In this case, relate Oper name starts from "superoper" and password "hoge".</p>
+<p>Password is encrypted by MD5. To know the MD5-value for any password, use included program "mkpassword.rb" :</p>
+<pre>$ ruby mkpassword.rb password</pre>
+<h2><a name="label-14" id="label-14">Available commands on Oper</a></h2><!-- RDLabel: "Available commands on Oper" -->
+<dl>
+<dt><a name="label-15" id="label-15">REHASH</a></dt><!-- RDLabel: "REHASH" -->
+<dd>
+Reload the configuration file.
+</dd>
+<dt><a name="label-16" id="label-16">CLOSE</a></dt><!-- RDLabel: "CLOSE" -->
+<dd>
+Close the connection between all clients and the server.
+</dd>
+<dt><a name="label-17" id="label-17">RESTART</a></dt><!-- RDLabel: "RESTART" -->
+<dd>
+Restart the server.
+</dd>
+<dt><a name="label-18" id="label-18">DIE</a></dt><!-- RDLabel: "DIE" -->
+<dd>
+Shut down the server.
+</dd>
+</dl>
+
+</body>
+</html>

data/usage.ja.html

@@ -0,0 +1,112 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>Usage.ja.rd</title>
+</head>
+<body>
+<h1><a name="label-0" id="label-0">Usage</a></h1><!-- RDLabel: "Usage" -->
+<h2><a name="label-1" id="label-1">起動</a></h2><!-- RDLabel: "起動" -->
+<pre>$ ruby ircd.rb [設定ファイル(sample.conf など)]</pre>
+<p>と実行すると、ローカルのポート6667でサーバが開始されます。
+終了するときは^Cで落ちるとおもいます。</p>
+<h2><a name="label-2" id="label-2">設定ファイルの書き方</a></h2><!-- RDLabel: "設定ファイルの書き方" -->
+<p>sample.confを開けるとこんな感じに成っていると思います。</p>
+<pre>Conf = {
+  :Motd =&gt; open("motd.txt"){|f| f.read }.tojis,
+  :Info =&gt; open("info.txt"){|f| f.read }.tojis,
+  :Port =&gt; 6667,
+  :Opers =&gt; {"superoper*"=&gt;"ea703e7aa1efda0064eaa507d9e8ab7e"},
+  :MaxClients =&gt; 100,
+  :PINGInterval =&gt; 300,
+  :PINGLimit =&gt; 90,
+}</pre>
+<p>設定はRubyのHashオブジェクトになっています。{}の中に</p>
+<pre>　
+:設定名 =&gt; 値, </pre>
+<p>という感じで設定を書いていきます。</p>
+<p>設定項目はこんなかんじです。</p>
+<dl>
+<dt><a name="label-3" id="label-3">:Motd</a></dt><!-- RDLabel: ":Motd" -->
+<dd>
+MOTD(Message of the day)で出力される文章を指定します。
+サーバに接続すると最初に渡されるメッセージです。お知らせとか時候の挨拶とか詩とかプチ自慢とかを書くといいでしょう。
+サンプルでは"motd.txt"の内容が出力されるようになっています。
+</dd>
+<dt><a name="label-4" id="label-4">:Info</a></dt><!-- RDLabel: ":Info" -->
+<dd>
+INFOで出力される文章を指定します。
+サーバの情報とか沿革を書くといいんじゃないでしょうか。
+サンプルでは"info.txt"の内容が出力される設定になっています。
+</dd>
+<dt><a name="label-5" id="label-5">:Port</a></dt><!-- RDLabel: ":Port" -->
+<dd>
+サーバを実行するポートです。空いているポートを指定してください(6660 ~ 6669 辺りが良いと思います。)
+サンプルでは 6667 です。
+</dd>
+<dt><a name="label-6" id="label-6">:Opers</a></dt><!-- RDLabel: ":Opers" -->
+<dd>
+サーバオペレータの名前マスクとパスワードのHashを指定します。
+詳しくはOperの使い方を参照。
+</dd>
+<dt><a name="label-7" id="label-7">:MaxClients</a></dt><!-- RDLabel: ":MaxClients" -->
+<dd>
+同時に繋げるクライアント数。サンプルでは100。
+</dd>
+<dt><a name="label-8" id="label-8">:PINGInterval</a></dt><!-- RDLabel: ":PINGInterval" -->
+<dd>
+クライアントにPINGを打つ間隔(秒)。PINGとは、クライアントとの接続が切れていないか確認するためのメッセージです。
+PINGを打って一定時間(PINGLimitで指定された秒数)経過しても返答(PONG)が無ければ、クライアントとの接続を切ります。
+サンプルでは300秒に一回です。
+</dd>
+<dt><a name="label-9" id="label-9">:PINGLimit</a></dt><!-- RDLabel: ":PINGLimit" -->
+<dd>
+PINGを打ってからPONGが返ってくるまで待つ時間(秒)。指定された時間を過ぎても返ってこない場合、クライアントとの接続を打ち切ります。
+サンプルでは90秒です。
+</dd>
+</dl>
+<p>気が向いたらもっと増やします。</p>
+<h1><a name="label-10" id="label-10">Operの使い方</a></h1><!-- RDLabel: "Operの使い方" -->
+<h2><a name="label-11" id="label-11">Operの設定法</a></h2><!-- RDLabel: "Operの設定法" -->
+<p>Operとは、サーバオペレータの事で、平たく云ってしまえばサーバを再起動させたり終了させたり、再読込みさせたりする権限のあるユーザの事です。</p>
+<p>Operに成るには、正しい OPER名 とパスワードの組合せが必要です。逆に云えば、それさえ分かれば誰でもOperに成れると云うことです。
+Operになるには、サーバにOPERコマンドを打つ必要があります。
+例えば、OPER名が oper1, パスワードが hoge の場合、</p>
+<pre>OPER oper1 hoge</pre>
+<p>とすると、OPER権限が貰えるわけです。</p>
+<p>この組合せの設定は設定ファイルのOpersの欄で行います。こんな書式です：</p>
+<dl>
+<dt><a name="label-12" id="label-12">Opers =&gt; {OPER名1 =&gt; パスワード1, OPER名2 =&gt; パスワード2, ...},</a></dt><!-- RDLabel: "Opers => {OPER名1 => パスワード1, OPER名2 => パスワード2, ...}," -->
+</dl>
+<p>サンプルではこうなっています。</p>
+<dl>
+<dt><a name="label-13" id="label-13">Opers =&gt; {"superoper*" =&gt; "ea703e7aa1efda0064eaa507d9e8ab7e"},</a></dt><!-- RDLabel: "Opers => {"superoper*" => "ea703e7aa1efda0064eaa507d9e8ab7e"}," -->
+</dl>
+<p>この例では、 superoper で始まるOPER名と、hogeというパスワードが関連付けられています。</p>
+<p>パスワードの欄がなにやら複雑なことになっていますが、此れはMD5という方式で暗号化されているからです。任意のパスワードについてそのMD5値を知るには、同梱のmkpassword.rbを使ってください。</p>
+<pre>$ ruby mkpassword.rb パスワード</pre>
+<p>とすると分かります。</p>
+<h2><a name="label-14" id="label-14">Operの使えるコマンド</a></h2><!-- RDLabel: "Operの使えるコマンド" -->
+<dl>
+<dt><a name="label-15" id="label-15">REHASH</a></dt><!-- RDLabel: "REHASH" -->
+<dd>
+サーバの設定を再読込みさせます
+</dd>
+<dt><a name="label-16" id="label-16">CLOSE</a></dt><!-- RDLabel: "CLOSE" -->
+<dd>
+サーバに接続している全クライアントとの接続を切ります
+</dd>
+<dt><a name="label-17" id="label-17">RESTART</a></dt><!-- RDLabel: "RESTART" -->
+<dd>
+サーバを再起動させます
+</dd>
+<dt><a name="label-18" id="label-18">DIE</a></dt><!-- RDLabel: "DIE" -->
+<dd>
+サーバを終了します
+</dd>
+</dl>
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: konn-rupircd
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - konn
@@ -30,10 +30,34 @@ extra_rdoc_files:
 files: 
 - Changes.ja.rd
 - Changes.rd
+- Manifest
 - README.ja.rd
 - README.rd
+- Rakefile
 - Usage.ja.rd
 - Usage.rd
+- VERSION
+- bin/mkpassword
+- bin/rupircd
+- changes.html
+- changes.ja.html
+- index.html
+- index.ja.html
+- info.txt
+- ircd.rb
+- lib/rupircd.rb
+- lib/rupircd/channel.rb
+- lib/rupircd/conf.rb
+- lib/rupircd/message.rb
+- lib/rupircd/server.rb
+- lib/rupircd/user.rb
+- lib/rupircd/utils.rb
+- mkpassword.rb
+- motd.txt
+- rupircd.gemspec
+- sample.conf
+- usage.html
+- usage.ja.html
 has_rdoc: true
 homepage: http://github.com/konn/rupircd
 licenses: