carps 0.2.1

data/lib/carps/email/config.rb

@@ -0,0 +1,122 @@
+# 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/email/imap"
+require "carps/email/smtp"
+
+require "carps/util/config"
+
+require "carps/ui/question"
+
+require "carps/crypt/mailer"
+require "carps/crypt/mailbox"
+
+require "yaml"
+
+class Hash
+   # Like member? but for array of members.
+   def members? elements
+      present = elements.map {|field| member? field}
+      present.all?
+   end
+end
+
+module CARPS
+
+   # Class to read email config.
+   class EmailConfig < SystemConfig
+
+      def EmailConfig.filepath
+         "email.yaml"
+      end
+
+      def initialize address, same_pass, imap_options, smtp_options
+         load_resources address, same_pass, imap_options, smtp_options
+      end
+
+      # Parse the email config file
+      def parse_yaml conf
+         address = read_conf conf, "address"
+         same_pass = read_conf conf, "same_pass"
+         imap = read_conf conf, "imap"
+         unless imap.members?(["user", "server", "port", "tls", "certificate", "verify", "login", "cram_md5"])
+            raise Expected, "Expected IMAP section to be valid."
+         end
+         smtp = read_conf conf, "smtp"
+         unless smtp.members?(["user", "server", "port", "tls", "starttls", "login", "cram_md5"])
+            raise Expected, "Expected SMTP section to be valid."
+         end
+         # Untaint the imap and smtp data
+         untaint_all imap
+         untaint_all smtp
+         [address, same_pass, imap, smtp]        
+      end
+
+      # Connect to the imap and smtp servers
+      def load_resources address, same_pass, imap_settings, smtp_settings
+         @file_struct = {"address" => address, "same_pass" => same_pass, "imap" => imap_settings, "smtp" => smtp_settings}
+         @address = address
+         smtp_password = ""
+         imap_password = ""
+         if same_pass
+            imap_password = smtp_password = UI::secret("Enter password for #{address}:")
+         else
+            imap_password = UI::secret "Enter password for IMAP account at #{address}:"
+            smtp_password = UI::secret "Enter password for SMTP account at #{address}:"
+         end
+         @imap = IMAP.new imap_settings, imap_password
+         @smtp = SMTP.new smtp_settings, smtp_password
+      end
+
+      # Relentlessly continue until we can connect to IMAP and SMTP
+      def connect!
+         @smtp.with_connection {|smtp|}
+         @imap.with_connection {|imap|}
+      end
+
+      # Emit options as hash
+      def emit
+         @file_struct
+      end
+
+      # Expose the IMAP client
+      def imap
+         @imap
+      end
+
+      # Expose the SMTP client
+      def smtp
+         @smtp
+      end
+
+      # Return the high level mail client
+      def mailer message_parser, session_manager
+         mailbox = Mailbox.new @smtp, @imap, message_parser, session_manager
+         Mailer.new @address, mailbox
+      end
+
+      # Untaint every value in a hash
+      def untaint_all hsh
+         hsh.each_value do |val|
+            val.untaint
+         end
+      end
+
+   end
+
+end

data/lib/carps/email/imap.rb

@@ -0,0 +1,156 @@
+# 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/email"
+
+require "carps/protocol/message"
+
+require "carps/ui/warn"
+
+require "carps/email/string"
+
+require "carps/util/timeout"
+
+
+require "net/imap"
+
+module CARPS
+
+   # Administer IMAP connections
+   class IMAP
+
+      # Initialize with a hash of IMAP settings and password
+      #
+      # Uh, poorly documented.  See source.
+      def initialize settings, password
+         @port = settings["port"]
+         @server = settings["server"]
+         @tls = settings["tls"]
+         @username = settings["user"]
+         @cert = settings["certificate"]
+         @verify = settings["verify"]
+         @login = settings["login"]
+         @cram_md5 = settings["cram_md5"]
+         @password = password
+      end
+
+      # Are the settings okay?
+      def ok?
+         good = false
+         begin
+            attempt_connection
+            good = true
+         rescue StandardError => e
+            UI::put_error e.to_s
+         end
+         good
+      end
+
+      # Return the a list of email message bodies
+      #
+      # Blocks until messages become available 
+      def read
+         if $DEBUG
+            puts "Reading mail."
+         end
+         mails = []
+         # Block 'till we get one
+         while mails.empty?
+            with_connection do |imap|
+               imap.select("inbox")
+               # Get all mails
+               messages = imap.search(["ALL"])
+               if messages.empty?
+                  sleep delay
+               else
+                  mails = imap.fetch messages, "BODY[TEXT]"
+                  mails = mails.map do |mail|
+                     from_mail mail.attr["BODY[TEXT]"]
+                  end
+                  # Delete all mails
+                  messages.each do |message_id|
+                     imap.store(message_id, "+FLAGS", [:Deleted])
+                  end
+                  imap.expunge
+               end
+            end
+         end
+         mails
+      end
+
+      # Perform an action with an IMAP connection 
+      def with_connection
+         imap = nil
+         begin
+            imap = attempt_connection
+            yield imap
+         rescue Net::IMAP::NoResponseError => e
+            if e.message =~ /(A|a)uthentication failed/
+               UI::put_error e.message, false
+               @password = UI::secret "Enter IMAP password for #{@username}" 
+            else
+               warn_delay
+            end
+            UI::put_error e.message, false
+         rescue StandardError => e
+            warn_delay
+            UI::put_error e.message, false
+         ensure
+            if imap
+               imap.logout
+               imap.disconnect
+            end
+         end 
+      end
+
+
+      private
+
+      # Attempt a connection
+      def attempt_connection
+         imap = nil
+         CARPS::timeout 30, "IMAP connection attempt" do
+            if not @tls or @password.empty?
+               UI::warn "IMAP connection is insecure."
+            end
+            imap = Net::IMAP.new @server, @port, @tls, @certs, @verify
+            if @cram_md5
+               imap.authenticate "CRAM-MD5", @username, @password
+            elsif @login
+               imap.authenticate "LOGIN", @username, @password
+            else
+               imap.login @username, @password
+            end
+         end
+         imap
+      end
+
+
+      def delay
+         30
+      end
+
+      # Warn that we're going to delay before trying again
+      def warn_delay
+         UI::warn "Could not connect to IMAP server", "Attempting to reconnect in 10 seconds."
+         sleep 10
+      end
+
+   end
+
+end

data/lib/carps/email/smtp.rb

@@ -0,0 +1,119 @@
+# 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/ui"
+
+require "carps/email"
+
+require "carps/util"
+
+require "net/smtp"
+
+require "socket"
+
+module CARPS
+   # SMTP connection
+   class SMTP
+
+      # Connects to the server
+      def initialize settings, password
+         @port = settings["port"]
+         @username = settings["user"]
+         @password = password
+         @server = settings["server"]
+         @starttls = settings["starttls"]
+         @tls = settings["tls"]
+         @login = settings["login"]
+         @cram_md5 = settings["cram_md5"]
+      end
+
+      # Send an email message
+      #
+      # Untaints its arguments
+      def send to, message
+         to.untaint
+         message.untaint
+         if $DEBUG
+            puts "Sending mail to #{to}"
+         end
+         with_connection do |smtp|
+            message = to_mail "Content-Type: application/octet-stream\r\n" + message
+            smtp.send_message message, @username, [to]
+         end
+      end
+
+      # Are the settings okay?
+      def ok?
+         good = false
+         begin
+            with_attempt_connection {}
+            good = true
+         rescue StandardError => e
+            UI::put_error e.to_s
+         end
+         good
+      end
+
+      # Perform an action with a connection
+      def with_connection &todo
+         until false 
+            begin
+               with_attempt_connection &todo
+               return
+            rescue Net::SMTPAuthenticationError => e
+               UI::put_error e.message, false
+               @password = UI::secret "Enter SMTP password for #{@username}:"
+            rescue StandardError => e
+               UI::warn "Could not connect to SMTP server", "Attempting to reconnect in 10 seconds."
+               UI::put_error e.message, false
+               sleep 10
+            end
+         end
+      end
+
+
+
+      private
+
+      def with_attempt_connection &todo
+         CARPS::timeout 30, "SMTP connection attempt" do
+            # Create smtp object
+            smtp = Net::SMTP.new @server, @port
+            # Security measures
+            if @starttls
+               smtp.enable_starttls
+            elsif @tls
+               smtp.enable_tls
+            end
+
+            auth = :plain
+            if @login
+               auth = :login
+            elsif @cram_md5
+               auth = :cram_md5
+            end
+
+            if not (@starttls or @tls) or @password.empty?
+               UI::warn "SMTP connection is insecure."
+            end
+            smtp.start Socket.gethostname, @username, @password, auth, &todo
+         end
+      end
+
+   end
+
+end

data/lib/carps/email/string.rb

@@ -0,0 +1,30 @@
+# 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 "base64"
+
+module CARPS
+
+   def to_mail msg
+      Base64.encode64 msg 
+   end
+
+   def from_mail msg
+      Base64.decode64 msg    
+   end
+
+end

data/lib/carps/email.rb

@@ -0,0 +1,21 @@
+# 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/email/config"
+require "carps/email/imap"
+require "carps/email/smtp"
+require "carps/email/string"

data/lib/carps/mod/action.rb

@@ -0,0 +1,36 @@
+# 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
+
+   # Actions taken when a rule is applied. 
+   #
+   # Subclasses must provide methods:
+   #
+   # summary, returns string.  The idea is to describe the effects of this Action.
+   #
+   # execute which takes the dice result and then the parameters given to the Rule.  The idea is to manipulate them here.
+   class Action
+
+      def apply *params
+         puts summary
+         execute *params
+      end
+
+   end
+
+end

data/lib/carps/mod/answers.rb

@@ -0,0 +1,76 @@
+# 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/protocol"
+
+require "carps/ui"
+
+require "highline"
+
+require "yaml"
+
+module CARPS
+
+   # A series of answers to questions asked by the DM.
+   class Answers < Message
+
+      # Extend the protocol
+      protoval :answers
+
+      # The answers hash gives the initial answers
+      def initialize answers_hash = {}
+         @answers = answers_hash
+      end
+
+      # Parse
+      def Answers.parse blob
+         yaml, blob = find K.answers, blob
+         answers = YAML::load yaml
+         [Answers.new(answers), blob]
+      end
+
+      # Emit
+      def emit
+         V.answers @answers.to_yaml
+      end
+
+      # Set an answer to a question
+      def answer question, response
+         @answers[question] = response
+      end
+
+      # Display answers
+      def display
+         if @answers.empty?
+            UI::highlight "#{from} did not return any answers."
+         else
+            UI::highlight "#{from}'s answers:"
+            h = HighLine.new
+            @answers.each do |que, ans|
+               puts ""
+               puts h.color(que, :green)
+               ans.each_line do |ln|
+                  puts ">  " + ln
+               end
+            end
+            puts ""
+         end
+      end
+
+   end
+
+end

data/lib/carps/mod/client_turn.rb

@@ -0,0 +1,88 @@
+# 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/>.
+
+# A status report, followed by a list of questions
+
+require "carps/protocol"
+
+require "carps/mod"
+
+module CARPS
+
+   class ClientTurn < Message
+
+      # Extend the protocol
+      protoword :client_turn
+
+      # Create a client turn
+      def initialize sheet, status, questions
+         @sheet = sheet
+         @status = status
+         @questions = questions
+      end
+
+      # Expose the character sheet
+      def sheet
+         @sheet
+      end
+
+      # Parse
+      def ClientTurn.parse blob
+         forget, blob = find K.client_turn, blob
+         sheet, blob = Sheet::NewSheet.parse blob
+         status, blob = StatusReport.parse blob
+         more = true
+         questions = []
+         while more
+            begin
+               que, blob = Question.parse blob
+               questions.push que
+            rescue Expected
+               more = false
+            end
+         end
+         [ClientTurn.new(sheet, status, questions), blob] 
+      end
+
+      # Emit
+      def emit
+         question_text = (@questions.map {|q| q.emit}).join
+         status = @status.emit
+         K.client_turn + @sheet.emit + status + question_text
+      end
+
+      # Preview the turn
+      def preview
+         @status.display
+         @questions.each do |q|
+            q.preview
+         end
+      end
+
+      # Take the turn, return list of answers
+      def take
+         @status.display
+         answers = Answers.new
+         @questions.each do |q|
+            q.ask answers
+         end
+         answers
+      end
+
+   end
+
+end