taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/daemon/ProcessIntercom.rb

@@ -11,24 +11,36 @@
 # published by the Free Software Foundation.
 #
 
+require 'taskjuggler/AppConfig'
 require 'taskjuggler/Log'
-require 'taskjuggler/LogFile'
+require 'taskjuggler/MessageHandler'
 
 class TaskJuggler
 
   module ProcessIntercomIface
 
+    include MessageHandler
+
     # This function catches all unhandled exceptions in the passed block.
     def trap
-      log = LogFile.instance
-
       begin
-        yield
-      rescue
-        $stderr.print $!.to_s
-        $stderr.print $!.backtrace.join("\n")
-        log.debug($!.backtrace.join("\n"))
-        log.fatal("Unexpected exception: #{$!}")
+        MessageHandlerInstance.instance.trapSetup = true
+        res = yield
+        MessageHandlerInstance.instance.trapSetup = false
+        res
+      rescue => e
+        # Any exception here is a fata error. We try hard to terminate the DRb
+        # thread and then exit the program.
+        begin
+          fatal('pi_crash_trap', "#{e}\n#{e.backtrace.join("\n")}\n\n" +
+                "#{'*' * 79}\nYou have triggered a bug in " +
+                "#{AppConfig.softwareName} version #{AppConfig.version}!\n" +
+                "Please see the user manual on how to get this bug fixed!\n" +
+                "#{'*' * 79}\n")
+        rescue RuntimeError
+          @server.terminate
+          return false
+        end
       end
     end
 
@@ -54,12 +66,13 @@ class TaskJuggler
 
   module ProcessIntercom
 
+    include MessageHandler
+
     def initIntercom
       # This is the authentication key that clients will need to provide to
       # execute DRb methods.
       @authKey = generateAuthKey
 
-      @log = LogFile.instance
       # This flag will be set to true by DRb method calls to terminate the
       # process.
       @terminate = false
@@ -73,14 +86,14 @@ class TaskJuggler
     end
 
     def terminate
-      @log.debug('Terminating on external request')
+      debug('', 'Terminating on external request')
       @terminate = true
     end
 
     def connect(stdout, stderr, stdin, silent)
       # Set the client lock.
       @clientConnection.lock
-      @log.debug('Rerouting ProjectServer standard IO to client')
+      debug('', 'Rerouting ProjectServer standard IO to client')
       # Make sure that all output to STDOUT and STDERR is sent to the client.
       # Input is read from the client STDIN.  We save a copy of the old file
       # handles so we can restore then later again.
@@ -90,18 +103,18 @@ class TaskJuggler
       $stdout = stdout if stdout
       $stderr = stderr if stdout
       $stdin = stdin if stdin
-      @log.debug('IO is now routed to the client')
+      debug('', 'IO is now routed to the client')
       Log.silent = silent
       true
     end
 
     def disconnect
-      @log.debug('Restoring IO')
+      debug('', 'Restoring IO')
       Log.silent = true
       $stdout = @stdout if @stdout
       $stderr = @stderr if @stderr
       $stdin = @stdin if @stdin
-      @log.debug('Standard IO has been restored')
+      debug('', 'Standard IO has been restored')
       # Release the client lock
       @clientConnection.unlock
       true
@@ -113,10 +126,11 @@ class TaskJuggler
 
     def checkKey(authKey, command)
       if authKey == @authKey
-        @log.debug("Accepted authentication key for command '#{command}'")
+        debug('', "Accepted authentication key for command '#{command}'")
       else
-        @log.warning("Rejected wrong authentication key #{authKey}" +
-                     "for command '#{command}'")
+        warning('auth_key_rejected',
+                "Rejected wrong authentication key #{authKey}" +
+                "for command '#{command}'")
         return false
       end
       true
@@ -126,7 +140,7 @@ class TaskJuggler
     # client connection timer.
     def restartTimer
       @timeLock.synchronize do
-        @log.debug('Reseting client connection timer')
+        debug('', 'Reseting client connection timer')
         @timerStart = Time.new
       end
     end
@@ -156,9 +170,10 @@ class TaskJuggler
               sleep 1
             end
             if timerExpired?
-              @log.warning('Shutting down DRb server due to timeout')
+              warning('drb_timeout_shutdown',
+                      'Shutting down DRb server due to timeout')
             else
-              @log.debug('Shutting down DRb server')
+              debug('', 'Shutting down the DRb server')
             end
             DRb.stop_service
             break

data/lib/taskjuggler/daemon/ProjectBroker.rb

@@ -17,8 +17,8 @@ require 'drb'
 require 'drb/acl'
 require 'taskjuggler/daemon/Daemon'
 require 'taskjuggler/daemon/ProjectServer'
-require 'taskjuggler/daemon/WebServer'
 require 'taskjuggler/TjTime'
+require 'taskjuggler/MessageHandler'
 
 class TaskJuggler
 
@@ -37,8 +37,9 @@ class TaskJuggler
   # daemon.
   class ProjectBroker < Daemon
 
-    attr_accessor :authKey, :port, :uriFile, :enableWebServer, :webServerPort,
-                  :projectFiles, :logStdIO
+    include MessageHandler
+
+    attr_accessor :authKey, :port, :uriFile, :projectFiles, :logStdIO
 
     def initialize
       super
@@ -66,15 +67,6 @@ class TaskJuggler
       # will be seperate set of files for each process.
       @logStdIO = !@daemonize
 
-      # Reference to WEBrick object.
-      @webServer = nil
-
-      # Port used by the web server
-      @webServerPort = 8080
-
-      # True if web server should be activated
-      @enableWebServer = false
-
       # This flag will be set to true to terminate the daemon.
       @terminate = false
     end
@@ -83,7 +75,7 @@ class TaskJuggler
       # To ensure a certain level of security, the user must provide an
       # authentication key to authenticate the client to this server.
       unless @authKey
-        @log.fatal(<<'EOT'
+        error('pb_no_auth_key', <<'EOT'
 You must set an authentication key in the configuration file. Create a file
 named .taskjugglerrc or taskjuggler.rc that contains at least the following
 lines. Replace 'your_secret_key' with some random character sequence.
@@ -96,18 +88,7 @@ EOT
 
       # In daemon mode, we fork twice and only the 2nd child continues here.
       super()
-      @log.debug("Starting project broker")
-
-      if @enableWebServer
-        begin
-          # The web server must be started before we turn SAFE mode on.
-          @webServer = WebServer.new(self, @webServerPort)
-          @log.info("TaskJuggler web server is listening on port " +
-                    "#{@webServerPort}")
-        rescue
-          @log.fatal("Cannot start web server: #{$!}")
-        end
-      end
+      debug('', "Starting project broker")
 
       # Setup a DRb server to handle the incomming requests from the clients.
       brokerIface = ProjectBrokerIface.new(self)
@@ -116,9 +97,9 @@ EOT
         DRb.install_acl(ACL.new(%w[ deny all
                                     allow 127.0.0.1 ]))
         @uri = DRb.start_service("druby://127.0.0.1:#{@port}", brokerIface).uri
-        @log.info("TaskJuggler daemon is listening on #{@uri}")
+        info('daemon_uri', "TaskJuggler daemon is listening on #{@uri}")
       rescue
-        @log.fatal("Cannot listen on port #{@port}: #{$!}")
+        error('port_in_use', "Cannot listen on port #{@port}: #{$!}")
       end
 
       if @port == 0 && @uriFile
@@ -127,7 +108,7 @@ EOT
         begin
           File.open(@uriFile, 'w') { |f| f.write @uri }
         rescue
-          @log.fatal("Cannot write URI file #{@uriFile}: #{$!}")
+          error('cannot_write_uri', "Cannot write URI file #{@uriFile}: #{$!}")
         end
       end
 
@@ -141,19 +122,19 @@ EOT
       # some other work asynchronously.
       startHousekeeping
 
-      # Cleanup the DRb threads
-      DRb.thread.join
+      debug('', 'Shutting down ProjectBroker DRb server')
+      DRb.stop_service
 
       # If we have created a URI file, we need to delete it again.
       if @port == 0 && @uriFile
         begin
           File.delete(@uriFile)
         rescue
-          @log.fatal("Cannot delete URI file .tj3d.uri: #{$!}")
+          error('cannot_delete_uri', "Cannot delete URI file .tj3d.uri: #{$!}")
         end
       end
 
-      @log.info('TaskJuggler daemon terminated')
+      info('daemon_terminated', 'TaskJuggler daemon terminated')
     end
 
     # All remote commands must provide the proper authentication key. Usually
@@ -161,10 +142,11 @@ EOT
     # configuration file.
     def checkKey(authKey, command)
       if authKey == @authKey
-        @log.debug("Accepted authentication key for command '#{command}'")
+        debug('', "Accepted authentication key for command '#{command}'")
       else
-        @log.warning("Rejected wrong authentication key '#{authKey}' " +
-                     "for command '#{command}'")
+        warning('wrong_auth_key',
+                "Rejected wrong authentication key '#{authKey}' " +
+                "for command '#{command}'")
         return false
       end
       true
@@ -172,7 +154,7 @@ EOT
 
     # This command will initiate the termination of the daemon.
     def stop
-      @log.debug('Terminating on client request')
+      debug('', 'Terminating on client request')
 
       # Shut down the web server if we've started one.
       if @webServer
@@ -216,7 +198,7 @@ EOT
       # associated to. Just use a large enough random number.
       tag = rand(9999999999999)
 
-      @log.debug("Pushing #{tag} to load Queue")
+      debug('', "Pushing #{tag} to load Queue")
       @projectsToLoad.push(tag)
 
       # Now we have to wait until the project shows up in the @projects
@@ -236,23 +218,23 @@ EOT
         sleep 0.1 unless pr
       end
 
-      @log.debug("Found tag #{tag} in list of loaded projects with URI " +
-                 "#{pr.uri}")
-      # Return the URI and the authentication key of the new ProjectServer.
-      [ pr.uri, pr.authKey ]
+      debug('', "Found tag #{tag} in list of loaded projects with URI " +
+            "#{pr.uri}")
+
+      res = false
 
       # Open a DRb connection to the ProjectServer process
       begin
         projectServer = DRbObject.new(nil, pr.uri)
       rescue
-        stdErr.puts "Can't get ProjectServer object: #{$!}"
+        warning('pb_cannot_get_ps', "Can't get ProjectServer object: #{$!}")
         return false
       end
       begin
         # Hook up IO from requestor to the ProjectServer process.
         projectServer.connect(pr.authKey, stdOut, stdErr, stdIn, silent)
       rescue
-        stdErr.puts "Can't connect IO: #{$!}"
+        warning('pb_cannot_connect_io', "Can't connect IO: #{$!}")
         return false
       end
 
@@ -261,7 +243,7 @@ EOT
       begin
         res = projectServer.loadProject(pr.authKey, [ cwd, *args ])
       rescue
-        stdErr.puts "Loading of project failed: #{$!}"
+        warning('pb_load_failed', "Loading of project failed: #{$!}")
         return false
       end
 
@@ -269,7 +251,7 @@ EOT
       begin
         projectServer.disconnect(pr.authKey)
       rescue
-        stdErr.puts "Can't disconnect IO: #{$!}"
+        warning('pb_cannot_disconnect_io', "Can't disconnect IO: #{$!}")
         return false
       end
 
@@ -278,7 +260,8 @@ EOT
 
     def removeProject(indexOrId)
       @projects.synchronize do
-        # Find all projects with the IDs in indexOrId and mark them as :obsolete.
+        # Find all projects with the IDs in indexOrId and mark them as
+        # :obsolete.
         if /^[0-9]$/.match(indexOrId)
           index = indexOrId.to_i - 1
           if index >= 0 && index < @projects.length
@@ -315,7 +298,7 @@ EOT
       end
 
       if project.nil?
-        @log.debug("No project with ID #{projectId} found")
+        debug('', "No project with ID #{projectId} found")
         return [ nil, nil ]
       end
       [ project.uri, project.authKey ]
@@ -371,7 +354,7 @@ EOT
           # Don't accept updates for already obsolete entries.
           next if project.state == :obsolete
 
-          @log.debug("Updating state for #{id} to #{state}")
+          debug('', "Updating state for #{id} to #{state}")
           # Only update the record that has the matching key
           if project.authKey == projectKey
             project.id = id if id
@@ -385,7 +368,7 @@ EOT
               @projects.each do |p|
                 if p != project && p.id == id
                   p.state = :obsolete
-                  @log.debug("Marking entry with ID #{id} as obsolete")
+                  debug('', "Marking entry with ID #{id} as obsolete")
                 end
               end
               project.readySince = TjTime.new
@@ -409,64 +392,64 @@ EOT
     private
 
     def startHousekeeping
-      Thread.new do
-        begin
-          cntr = 0
-          loop do
-            if @terminate
-              # Give the caller a chance to properly terminate the connection.
-              sleep 0.5
-              @log.debug('Shutting down DRb server')
-              DRb.stop_service
-              break
-            elsif !@projectsToLoad.empty?
-              loadProject(@projectsToLoad.pop)
-            else
-              # Send termination command to all obsolute ProjectServer
-              # objects.  To minimize the locking of @projects we collect the
-              # obsolete items first.
-              termList = []
-              @projects.synchronize do
-                @projects.each do |p|
-                  if p.state == :obsolete
-                    termList << p
-                  elsif p.state == :failed
-                    # Start removal of entries that didn't parse.
-                    p.state = :obsolete
-                  end
+      begin
+        cntr = 0
+        loop do
+          if @terminate
+            # Give the caller a chance to properly terminate the connection.
+            sleep 0.5
+            break
+          elsif !@projectsToLoad.empty?
+            loadProject(@projectsToLoad.pop)
+          else
+            # Send termination command to all obsolute ProjectServer
+            # objects.  To minimize the locking of @projects we collect the
+            # obsolete items first.
+            termList = []
+            @projects.synchronize do
+              @projects.each do |p|
+                if p.state == :obsolete
+                  termList << p
+                elsif p.state == :failed
+                  # Start removal of entries that didn't parse.
+                  p.state = :obsolete
                 end
               end
-              # And then send them a termination command.
-              termList.each { |p| p.terminateServer }
-
-              # Check every 10 seconds that the ProjectServer processes are
-              # still alive. If not, remove them from the list.
-              if (cntr += 1) > 10
-                @projects.synchronize do
-                  @projects.each do |p|
-                    unless p.ping
-                      termList << p unless termList.include?(p)
-                    end
+            end
+            # And then send them a termination command.
+            termList.each { |p| p.terminateServer }
+
+            # Check every 10 seconds that the ProjectServer processes are
+            # still alive. If not, remove them from the list.
+            if (cntr += 1) > 10
+              @projects.synchronize do
+                @projects.each do |p|
+                  unless p.ping
+                    termList << p unless termList.include?(p)
                   end
                 end
-                cntr = 0
               end
+              cntr = 0
+            end
 
-              # The housekeeping thread rarely needs to so something. Make
-              # sure it's sleeping most of the time.
-              sleep 1
+            # The housekeeping thread rarely needs to so something. Make
+            # sure it's sleeping most of the time.
+            sleep 1
 
-              # Remove the obsolete records from the @projects list.
-              @projects.synchronize do
-                @projects.delete_if { |p| termList.include?(p) }
-              end
+            # Remove the obsolete records from the @projects list.
+            @projects.synchronize do
+              @projects.delete_if { |p| termList.include?(p) }
             end
           end
-        rescue
-          $stderr.print $!.to_s
-          $stderr.print $!.backtrace.join("\n")
-          @log.fatal("ProjectBroker housekeeping error: #{$!}")
         end
+      rescue => exception
+        # TjRuntimeError exceptions are simply passed through.
+        if exception.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+
+        fatal('pb_housekeeping_error',
+              "ProjectBroker housekeeping error: #{$!}")
       end
     end
 
@@ -475,11 +458,11 @@ EOT
         tag = rand(9999999999999)
         project = tagOrProject
         # The 2nd element of the Array is the *.tjp file name.
-        @log.debug("Loading project #{tagOrProject[1]} with tag #{tag}")
+        debug('', "Loading project #{tagOrProject[1]} with tag #{tag}")
       else
         tag = tagOrProject
         project = nil
-        @log.debug("Loading project for tag #{tag}")
+        debug('', "Loading project for tag #{tag}")
       end
       pr = ProjectRecord.new(tag)
       ps = ProjectServer.new(@authKey, project, @logStdIO)
@@ -500,6 +483,8 @@ EOT
   # these methods for remote access.
   class ProjectBrokerIface
 
+    include MessageHandler
+
     def initialize(broker)
       @broker = broker
     end
@@ -517,15 +502,25 @@ EOT
 
     # This function catches all unhandled exceptions in the passed block.
     def trap
-      log = LogFile.instance
-
       begin
         yield
-      rescue
-        $stderr.print $!.to_s
-        $stderr.print $!.backtrace.join("\n")
-        log.debug($!.backtrace.join("\n"))
-        log.fatal("Unexpected exception: #{$!}")
+      rescue => e
+        # TjRuntimeError exceptions are simply passed through.
+        if e.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+
+        # Any exception here is a fata error. We try hard to terminate the DRb
+        # thread and then exit the program.
+        begin
+          fatal('pb_crash_trap', "#{e}\n#{e.backtrace.join("\n")}\n\n" +
+                "#{'*' * 79}\nYou have triggered a bug in " +
+                "#{AppConfig.softwareName} version #{AppConfig.version}!\n" +
+                "Please see the user manual on how to get this bug fixed!\n" +
+                "#{'*' * 79}\n")
+        rescue RuntimeError
+          @broker.stop
+        end
       end
     end
 
@@ -549,11 +544,24 @@ EOT
         when :update
           @broker.update
         else
-          LogFile.instance.fatal('Unknown command #{cmd} called')
+          fatal('unknown_command', 'Unknown command #{cmd} called')
         end
       end
     end
 
+    def getProjectList(authKey)
+      return false unless @broker.checkKey(authKey, 'getProjectList')
+
+      trap { @broker.getProjectList }
+    end
+
+    def getProject(authKey, id)
+      return false unless @broker.checkKey(authKey, 'getProject')
+
+      debug('', "PID: #{id} Class: #{id.class}")
+      trap { @broker.getProject(id) }
+    end
+
     def updateState(authKey, projectKey, id, status, modified)
       return false unless @broker.checkKey(authKey, 'updateState')
 
@@ -566,6 +574,8 @@ EOT
   # one entry for each project in the @projects list.
   class ProjectRecord < Monitor
 
+    include MessageHandler
+
     attr_accessor :authKey, :uri, :files, :id, :state, :readySince, :modified,
                   :reloading
     attr_reader :tag
@@ -592,19 +602,18 @@ EOT
       # True if the reload has already been triggered.
       @reloading = false
 
-      @log = LogFile.instance
       @projectServer = nil
     end
 
     def ping
       return true unless @uri
 
-      @log.debug("Sending ping to ProjectServer #{@uri}")
+      debug('', "Sending ping to ProjectServer #{@uri}")
       begin
         @projectServer = DRbObject.new(nil, @uri) unless @projectServer
         @projectServer.ping(@authKey)
       rescue
-        @log.error("Ping failed: #{$!}")
+        warning('ping_failed', "Ping failed: #{$!}")
         return false
       end
       true
@@ -615,11 +624,12 @@ EOT
       return unless @uri
 
       begin
-        @log.debug("Sending termination request to ProjectServer #{@uri}")
+        debug('', "Sending termination request to ProjectServer #{@uri}")
         @projectServer = DRbObject.new(nil, @uri) unless @projectServer
         @projectServer.terminate(@authKey)
       rescue
-        @log.error("Termination of ProjectServer failed: #{$!}")
+        error('proj_serv_term_failed',
+              "Termination of ProjectServer failed: #{$!}")
       end
       @uri = nil
     end