OSDN Git Service

0533040dfd2b1fbffab6658672ff3d6b093e150e
[shogi-server/shogi-server.git] / shogi-server
1 #! /usr/bin/env ruby
2 # $Id$
3 #
4 # Author:: NABEYA Kenichi, Daigo Moriwaki
5 # Homepage:: http://sourceforge.jp/projects/shogi-server/
6 #
7 #--
8 # Copyright (C) 2004 NABEYA Kenichi (aka nanami@2ch)
9 # Copyright (C) 2007-2008 Daigo Moriwaki (daigo at debian dot org)
10 #
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2 of the License, or
14 # (at your option) any later version.
15 #
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20 #
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 #++
25 #
26 #
27
28 $topdir = nil
29 $league = nil
30 $logger = nil
31 $:.unshift File.dirname(__FILE__)
32 require 'shogi_server'
33 require 'tempfile'
34
35 #################################################
36 # MAIN
37 #
38
39 ShogiServer.reload
40
41 def gets_safe(socket, timeout=nil)
42   if r = select([socket], nil, nil, timeout)
43     return r[0].first.gets
44   else
45     return :timeout
46   end
47 rescue Exception => ex
48   log_error("gets_safe: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
49   return :exception
50 end
51
52 def usage
53     print <<EOM
54 NAME
55         shogi-server - server for CSA server protocol
56
57 SYNOPSIS
58         shogi-server [OPTIONS] event_name port_number
59
60 DESCRIPTION
61         server for CSA server protocol
62
63 OPTIONS
64         --pid-file file
65                 specify filename for logging process ID
66         --daemon dir
67                 run as a daemon. Log files will be put in dir.
68         --player-log-dir dir
69                 log network messages for each player. Log files
70                 will be put in the dir.
71         --floodgate-history
72                 file name to record Floodgate game history
73                 default: './floodgate_history.yaml'
74
75 LICENSE
76         GPL versoin 2 or later
77
78 SEE ALSO
79
80 RELEASE
81         #{ShogiServer::Release}
82
83 REVISION
84         #{ShogiServer::Revision}
85
86 EOM
87 end
88
89
90 def log_debug(str)
91   $logger.debug(str)
92 end
93
94 def log_message(str)
95   $logger.info(str)
96 end
97 def log_info(str)
98   log_message(str)
99 end
100
101 def log_warning(str)
102   $logger.warn(str)
103 end
104
105 def log_error(str)
106   $logger.error(str)
107 end
108
109
110 # Parse command line options. Return a hash containing the option strings
111 # where a key is the option name without the first two slashes. For example,
112 # {"pid-file" => "foo.pid"}.
113 #
114 def parse_command_line
115   options = Hash::new
116   parser = GetoptLong.new(
117     ["--daemon",            GetoptLong::REQUIRED_ARGUMENT],
118     ["--pid-file",          GetoptLong::REQUIRED_ARGUMENT],
119     ["--player-log-dir",    GetoptLong::REQUIRED_ARGUMENT],
120     ["--floodgate-history", GetoptLong::REQUIRED_ARGUMENT])
121   parser.quiet = true
122   begin
123     parser.each_option do |name, arg|
124       name.sub!(/^--/, '')
125       options[name] = arg.dup
126     end
127   rescue
128     usage
129     raise parser.error_message
130   end
131   return options
132 end
133
134 # Check command line options.
135 # If any of them is invalid, exit the process.
136 #
137 def check_command_line
138   if (ARGV.length != 2)
139     usage
140     exit 2
141   end
142
143   if $options["daemon"]
144     $options["daemon"] = File.expand_path($options["daemon"], File.dirname(__FILE__))
145     unless is_writable_dir? $options["daemon"]
146       usage
147       $stderr.puts "Can not create a file in the daemon directory: %s" % [$options["daemon"]]
148       exit 5
149     end
150   end
151
152   $topdir = $options["daemon"] || File.expand_path(File.dirname(__FILE__))
153
154   if $options["player-log-dir"]
155     $options["player-log-dir"] = File.expand_path($options["player-log-dir"], $topdir)
156     unless is_writable_dir?($options["player-log-dir"])
157       usage
158       $stderr.puts "Can not write a file in the player log dir: %s" % [$options["player-log-dir"]]
159       exit 3
160     end 
161   end
162
163   if $options["pid-file"] 
164     $options["pid-file"] = File.expand_path($options["pid-file"], $topdir)
165     unless is_writable_file? $options["pid-file"]
166       usage
167       $stderr.puts "Can not create the pid file: %s" % [$options["pid-file"]]
168       exit 4
169     end
170   end
171
172   $options["floodgate-history"] ||= File.join($topdir, "floodgate_history.yaml")
173   $options["floodgate-history"] = File.expand_path($options["floodgate-history"], $topdir)
174   unless is_writable_file? $options["floodgate-history"]
175     usage
176     $stderr.puts "Can not create the floodgate history file: %s" % [$options["floodgate-history"]]
177     exit 6
178   end
179 end
180
181 # See if the file is writable. The file will be created if it does not exist
182 # yet.
183 # Return true if the file is writable, otherwise false.
184 #
185 def is_writable_file?(file)
186   begin
187     open(file, "w") {|fh| } 
188   rescue
189     return false
190   end
191   unless FileTest.file? file
192     return false
193   end
194
195   return true
196 end
197
198 # See if a file can be created in the directory.
199 # Return true if a file is writable in the directory, otherwise false.
200 #
201 def is_writable_dir?(dir)
202   unless File.directory? dir
203     return false
204   end
205
206   result = true
207
208   begin
209     temp_file = Tempfile.new("dummy-shogi-server", dir)
210     temp_file.close true
211   rescue
212     result = false
213   end
214
215   return result
216 end
217
218 def write_pid_file(file)
219   open(file, "w") do |fh|
220     fh.puts "#{$$}"
221   end
222 end
223
224 def mutex_watchdog(mutex, sec)
225   sec = 1 if sec < 1
226   queue = []
227   while true
228     if mutex.try_lock
229       queue.clear
230       mutex.unlock
231     else
232       queue.push(Object.new)
233       if queue.size > sec
234         # timeout
235         log_error("mutex watchdog timeout: %d sec" % [sec])
236         queue.clear
237       end
238     end
239     sleep(1)
240   end
241 end
242
243 def login_loop(client)
244   player = login = nil
245  
246   while r = select([client], nil, nil, ShogiServer::Login_Time) do
247     break unless str = r[0].first.gets
248     $mutex.lock # guards $league
249     begin
250       str =~ /([\r\n]*)$/
251       eol = $1
252       if (ShogiServer::Login::good_login?(str))
253         player = ShogiServer::Player::new(str, client, eol)
254         login  = ShogiServer::Login::factory(str, player)
255         if (current_player = $league.find(player.name))
256           if (current_player.password == player.password &&
257               current_player.status != "game")
258             log_message(sprintf("user %s login forcely", player.name))
259             current_player.kill
260           else
261             login.incorrect_duplicated_player(str)
262             player = nil
263             break
264           end
265         end
266         $league.add(player)
267         break
268       else
269         client.write("LOGIN:incorrect" + eol)
270         client.write("type 'LOGIN name password' or 'LOGIN name password x1'" + eol) if (str.split.length >= 4)
271       end
272     ensure
273       $mutex.unlock
274     end
275   end                       # login loop
276   return [player, login]
277 end
278
279 def setup_logger(log_file)
280   logger = ShogiServer::Logger.new(log_file, 'daily')
281   logger.formatter = ShogiServer::Formatter.new
282   logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO  
283   logger.datetime_format = "%Y-%m-%d %H:%M:%S"
284   return logger
285 end
286
287 def setup_watchdog_for_giant_lock
288   $mutex = Mutex::new
289   Thread::start do
290     Thread.pass
291     mutex_watchdog($mutex, 10)
292   end
293 end
294
295 def setup_floodgate
296   return Thread.start do 
297     Thread.pass
298     floodgate = ShogiServer::League::Floodgate.new($league)
299     log_message("Flooddgate reloaded. The next match will start at %s." % 
300                 [floodgate.next_time])
301
302     while (true)
303       begin
304         diff = floodgate.next_time - Time.now
305         if diff > 0
306           sleep(diff/2)
307           next
308         end
309         $league.reload
310         floodgate.match_game
311         floodgate.charge
312         next_time = floodgate.next_time
313         $mutex.synchronize do
314           log_message("Reloading source...")
315           ShogiServer.reload
316         end
317         floodgate = ShogiServer::League::Floodgate.new($league, next_time)
318         log_message("Floodgate: The next match will start at %s." % 
319                     [floodgate.next_time])
320       rescue Exception => ex 
321         # ignore errors
322         log_error("[in Floodgate's thread] #{ex} #{ex.backtrace}")
323       end
324     end
325   end
326 end
327
328 def main
329   
330   $options = parse_command_line
331   check_command_line
332
333   $league = ShogiServer::League.new($topdir)
334
335   $league.event = ARGV.shift
336   port = ARGV.shift
337
338   log_file = $options["daemon"] ? File.join($options["daemon"], "shogi-server.log") : STDOUT
339   $logger = setup_logger(log_file)
340
341   $league.dir = $topdir
342
343   config = {}
344   config[:Port]       = port
345   config[:ServerType] = WEBrick::Daemon if $options["daemon"]
346   config[:Logger]     = $logger
347
348   fg_thread = nil
349
350   config[:StartCallback] = Proc.new do
351     srand
352     if $options["pid-file"]
353       write_pid_file($options["pid-file"])
354     end
355     setup_watchdog_for_giant_lock
356     $league.setup_players_database
357     fg_thread = setup_floodgate
358   end
359
360   config[:StopCallback] = Proc.new do
361     if $options["pid-file"]
362       FileUtils.rm($options["pid-file"], :force => true)
363     end
364   end
365
366   srand
367   server = WEBrick::GenericServer.new(config)
368   ["INT", "TERM"].each do |signal| 
369     trap(signal) do
370       server.shutdown
371       fg_thread.kill if fg_thread
372     end
373   end
374   trap("HUP") do
375     Dependencies.clear
376   end
377   $stderr.puts("server started as a deamon [Revision: #{ShogiServer::Revision}]") if $options["daemon"] 
378   log_message("server started [Revision: #{ShogiServer::Revision}]")
379
380   server.start do |client|
381       # client.sync = true # this is already set in WEBrick 
382       client.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
383         # Keepalive time can be set by /proc/sys/net/ipv4/tcp_keepalive_time
384       player, login = login_loop(client) # loop
385       next unless player
386
387       log_message(sprintf("user %s login", player.name))
388       login.process
389       player.setup_logger($options["player-log-dir"]) if $options["player-log-dir"]
390       player.run(login.csa_1st_str) # loop
391       $mutex.lock
392       begin
393         if (player.game)
394           player.game.kill(player)
395         end
396         player.finish # socket has been closed
397         $league.delete(player)
398         log_message(sprintf("user %s logout", player.name))
399       ensure
400         $mutex.unlock
401       end
402   end
403 end
404
405
406 if ($0 == __FILE__)
407   STDOUT.sync = true
408   STDERR.sync = true
409   TCPSocket.do_not_reverse_lookup = true
410   Thread.abort_on_exception = $DEBUG ? true : false
411
412   begin
413     main
414   rescue Exception => ex
415     if $logger
416       log_error("main: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}")
417     else
418       $stderr.puts "main: #{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"
419     end
420   end
421 end