carps 0.2.1

data/lib/carps/service/mod.rb

@@ -0,0 +1,43 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/util/init"
+
+require "drb"
+
+require "yaml"
+
+module CARPS
+
+   # Load the available mods
+   #
+   # Performs untaint
+   def load_mods
+      mod_file = CARPS::root_config + "/mods.yaml"
+      mods = {}
+      begin
+         mods = YAML.load(File.read mod_file)
+      rescue
+         UI::warn "Cannot find mods: could not read #{mod_file}"
+      end
+      mods.each_value do |mod|
+         mod.untaint
+      end
+      mods
+   end
+
+end

data/lib/carps/service/player/config.rb

@@ -0,0 +1,78 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/service/game"
+require "carps/service/start/config"
+
+require "yaml"
+
+module CARPS
+
+   module Player
+
+      # Class to read game configuration files
+      class GameConfig < SessionConfig
+
+         # Create a new GameConfig
+         def initialize filename, mod, dm, about, session
+            super session, filename
+            @mod = mod
+            @dm = dm
+            @about = about
+         end
+
+         # Set the file name
+         def filename= fn
+            @filename = fn
+         end
+
+         # Parse a game config file
+         def parse_yaml conf
+            super
+            @mod = read_conf conf, "mod"
+            @about = read_conf conf, "about"
+            @dm = read_conf conf, "dm"
+         end
+
+         # Display information on this configuration
+         def display
+            puts "Mod: " + @mod
+            puts "Description:"
+            puts @about
+            puts "DM: " + @dm
+         end
+
+         # Spawn a game object so we can resume the game
+         def spawn
+            GameClient.new @dm, @mod, self
+         end
+
+         protected
+
+         # Emit as hash 
+         def emit
+             {"mod" => @mod, 
+             "about" => @about, 
+             "dm" => @dm
+             }.merge super
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/player/mailer.rb

@@ -0,0 +1,49 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/service/start/mailer"
+
+module CARPS
+
+   module Player
+
+      # A bridge between the Player mod and CARPS 
+      class Mailer < ModMailer
+
+         # Create from the email address of the dungeon master,
+         # a mailer,
+         # and a configuration file
+         def initialize dm, mailer, conf
+            @dm = dm
+            super mailer, conf
+         end
+
+         # Check for mail from the dm
+         def check type
+            @mailer.check type, @dm
+         end
+
+         # Send mail to the dm
+         def relay message
+            @mailer.send @dm, message
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/player/start.rb

@@ -0,0 +1,60 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/service/start/interface"
+
+require "carps/service/game"
+
+require "carps/ui/question"
+
+module CARPS
+
+   module Player
+
+      # Interface for the player to join games
+      class StartInterface < StartGameInterface
+
+         def initialize continuation, mailer, game_config, manager
+            super
+            add_command "mail", "Check for mail."
+         end
+
+         protected
+
+         def mail 
+            invite = @mailer.check Invite
+            if invite
+               if config = invite.ask
+                  config.register_session @manager
+                  config.save
+                  game = config.spawn
+                  @continuation.call lambda {
+                     game.join_game @mailer
+                  }
+               end
+            elsif shake = @mailer.check_handshake
+               @mailer.handle_handshake shake
+            else
+               puts "No new mail."
+            end
+         end
+
+      end
+
+   end
+
+end

data/lib/carps/service/server_parser.rb

@@ -0,0 +1,33 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/crypt"
+
+require "carps/mod"
+
+module CARPS
+
+   module DM
+
+      # Create a parser which parses messages for the server 
+      def DM::parser
+         MessageParser.new default_messages + [Sheet::NewSheet, Answers]
+      end
+
+   end
+
+end

data/lib/carps/service/session.rb

@@ -0,0 +1,96 @@
+# Copyright 2010 John Morrice
+ 
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "thread"
+
+module CARPS
+
+   # A session manager
+   #
+   # It coordinates sessions between the game and the email system
+   # The idea is to prevent a game from receiving messages
+   # intended for another game.
+   #
+   # Its methods are reentrant
+   class SessionManager
+
+      def initialize
+         @session = ""
+         @semaphore = Mutex.new
+         @syms = (" ".."~").to_a
+      end
+
+      # Generate a number of random symbols 
+      def randoms size
+         ras = Array.new size do |forget|
+            @syms[rand(95)]
+         end
+         ras.join
+      end
+
+      # Generate a new session from a key
+      def generate key
+         t = Time.new
+         # It will be unlikely that anyone will guess this session
+         ra = randoms 1000
+         new_session = ra + key + t.to_f.to_s
+         @semaphore.synchronize do
+            @session = new_session 
+         end
+         @session
+      end
+
+      # Set the current session
+      def session= sess
+         @semaphore.synchronize do
+            @session = sess
+         end
+      end
+
+      # Get the session key
+      def key
+         @session
+      end
+
+      # Remove the current session
+      def none
+         @semaphore.synchronize do
+            @session = "" 
+         end
+      end
+
+      # Is this message appropriate for the current session
+      def belong? message
+         @semaphore.synchronize do
+            if not message.session
+               false
+            elsif not @session.empty?
+               message.session == @session
+            else
+               true
+            end
+         end
+      end
+
+      # Tag a string with a message 
+      def tag message
+         V.session(@session) + message
+      end
+
+   end
+
+end

data/lib/carps/service/start/config.rb

@@ -0,0 +1,71 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/util/config"
+
+module CARPS
+
+   # A configuration file for games which keeps track of sessions, 
+   # and the mod's saved state
+   class SessionConfig < UserConfig
+
+      # Create from session ID and filename
+      def initialize session, filename
+         @session = session
+         @filename = filename
+      end
+
+      # Set the session used by a session manager
+      def register_session manager
+         manager.session = @session
+      end
+
+      def parse_yaml conf
+         @filename = read_conf conf, "filename"
+         @session = read_conf conf, "session"
+         @save = conf["save"]
+      end
+
+      # Save the mod
+      #
+      # Also saves the file
+      def save_mod mod 
+         @save = mod
+         save 
+      end
+
+      # Load the mod
+      def load_mod
+         @save
+      end
+
+      # Save this game
+      def save
+         save_file "games/" + @filename + ".yaml"
+      end
+
+      protected
+
+      def emit
+         {"filename" => @filename,
+         "save" => @save,
+         "session" => @session}
+      end
+
+   end
+
+end

data/lib/carps/service/start/interface.rb

@@ -0,0 +1,101 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/service/interface"
+
+require "carps/ui/highlight"
+require "carps/ui/error"
+
+require "continuation"
+
+module CARPS
+
+   # Interface to start games
+   class StartGameInterface < QuitInterface
+
+      include ControlInterface
+
+      # Start interface
+      def StartGameInterface.start_game_interface mailer, config, manager
+         loop do
+            choice = callcc do |continuation|
+               interface = self.new continuation, mailer, config, manager
+               interface.run
+            end
+            choice.call
+         end
+      end
+
+      def initialize continuation, mailer, game_config, manager
+         @manager = manager
+         @manager.none
+         @mailer = mailer
+         @game_config = game_config
+         @continuation = continuation
+         super()
+         add_command "games", "List existing games."
+         add_command "load", "Load an existing game.", "NAME"
+      end
+
+      protected
+
+      def help
+         puts ""
+         UI::highlight "Welcome to CARPS #{VERSION}"
+         super
+      end
+
+      def games
+         dir = $CONFIG + "/games"
+         fs = files dir
+         fs.each do |f|
+            name = File.basename(f, ".yaml")
+            puts ""
+            UI::highlight "Name: " + name
+            g = nil
+            begin
+               g = @game_config.load "games/" + File.basename(f)
+            rescue StandardError => e
+               UI::put_error "#{e}"
+            end
+            if g
+               g.display
+            end
+         end
+
+      end
+
+      def load name
+         filename = "games/" + name + ".yaml"
+         config = nil
+         begin
+            config = @game_config.load filename
+         rescue StandardError => e
+            UI::put_error e.to_s
+         end
+         if config
+            game = config.spawn
+            @continuation.call lambda {
+               config.register_session @manager
+               game.resume @mailer
+            }
+         end
+      end
+
+   end
+
+end

data/lib/carps/service/start/mailer.rb

@@ -0,0 +1,46 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drb"
+
+module CARPS
+
+   # ModMailer acts as a bridge between the Mod and CARPS
+   class ModMailer
+
+      include DRbUndumped
+
+      # Initialize with a mailer and a configuration file
+      #
+      # FIXME: Doesn't use mailer (only subclasses use it)
+      def initialize mailer, config
+         @mailer = mailer
+         @config = config
+      end
+
+      # Save the mod
+      def save mod
+         @config.save_mod mod
+      end
+
+      # Load a previously saved state
+      def load
+         @config.load_mod
+      end
+
+   end
+end

data/lib/carps/service.rb

@@ -0,0 +1,35 @@
+# Copyright 2010 John Morrice
+ 
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps/service/start/config"
+require "carps/service/start/interface"
+require "carps/service/start/mailer"
+require "carps/service/dm/new_game"
+require "carps/service/dm/config"
+require "carps/service/dm/mailer"
+require "carps/service/dm/start"
+require "carps/service/player/config"
+require "carps/service/player/mailer"
+require "carps/service/player/start"
+require "carps/service/start/interface"
+require "carps/service/client_parser"
+require "carps/service/game"
+require "carps/service/interface"
+require "carps/service/mod"
+require "carps/service/server_parser"
+require "carps/service/session"
+require "carps/service/invite"

data/lib/carps/test.rb

@@ -0,0 +1,34 @@
+# Copyright 2010 John Morrice
+
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+module CARPS
+
+   # Utilities which belong to the testing utility AND to the wizard
+   module Test
+
+         # There can sometimes be more than one reason why the test has failed.
+         def Test::multi_fail *reasons
+            Test::test_failed "Either:\n\t" + reasons.join("\nor\t")
+         end
+
+         def Test::test_failed msg
+            UI::put_error msg
+         end
+
+   end
+
+end

data/lib/carps/ui/colour.rb

@@ -0,0 +1,28 @@
+# Copyright 2010 John Morrice
+ 
+# This file is part of CARPS.
+
+# CARPS is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# CARPS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with CARPS.  If not, see <http://www.gnu.org/licenses/>.
+
+require "highline"
+
+require "carps/util/windows"
+
+# If it's windows, we need ansi support
+if CARPS::windows?
+   require "Win32/Console/ANSI"
+end
+
+# Set up highline colours
+HighLine.color_scheme = HighLine::SampleColorScheme.new