taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/daemon/ProjectServer.rb

@@ -16,9 +16,8 @@ require 'drb/acl'
 require 'monitor'
 require 'taskjuggler/daemon/ProcessIntercom'
 require 'taskjuggler/daemon/ReportServer'
-require 'taskjuggler/LogFile'
+require 'taskjuggler/MessageHandler'
 require 'taskjuggler/TaskJuggler'
-require 'taskjuggler/Log'
 require 'taskjuggler/TjTime'
 
 class TaskJuggler
@@ -79,7 +78,7 @@ class TaskJuggler
       rd, wr = IO.pipe
 
       if (@pid = fork) == -1
-        @log.fatal('ProjectServer fork failed')
+        fatal('ps_fork_failed', 'ProjectServer fork failed')
       elsif @pid.nil?
         # This is the child
         if @logConsole
@@ -91,13 +90,12 @@ class TaskJuggler
         begin
           $SAFE = 1
           DRb.install_acl(ACL.new(%w[ deny all allow 127.0.0.1 ]))
-          DRb.start_service
           iFace = ProjectServerIface.new(self)
           begin
             @uri = DRb.start_service('druby://127.0.0.1:0', iFace).uri
-            @log.debug("Project server is listening on #{@uri}")
+            debug('', "Project server is listening on #{@uri}")
           rescue
-            @log.fatal("ProjectServer can't start DRb: #{$!}")
+            error('ps_cannot_start_drb', "ProjectServer can't start DRb: #{$!}")
           end
 
           # Send the URI of the newly started DRb server to the parent process.
@@ -114,12 +112,15 @@ class TaskJuggler
 
           # Cleanup the DRb threads
           DRb.thread.join
-          @log.debug('Project server terminated')
+          debug('', 'Project server terminated')
           exit 0
-        rescue
-          $stderr.print $!.to_s
-          $stderr.print $!.backtrace.join("\n")
-          @log.fatal("ProjectServer can't start DRb: #{$!}")
+        rescue => exception
+          # TjRuntimeError exceptions are simply passed through.
+          if exception.is_a?(TjRuntimeError)
+            raise TjRuntimeError, $!
+          end
+
+          error('ps_cannot_start_drb', "ProjectServer can't start DRb: #{$!}")
         end
       else
         # This is the parent
@@ -144,28 +145,37 @@ class TaskJuggler
       @modifiedCheck = TjTime.new
 
       updateState(:loading, dirAndFiles, false)
-      @tj = TaskJuggler.new(true)
+      begin
+        @tj = TaskJuggler.new
+        # Make sure that trace reports get CSV formats included so there
+        # reports can be generated on request.
+        @tj.generateTraces = true
+
+        # Parse all project files
+        unless @tj.parse(args, true)
+          warning('parse_failed', "Parsing of #{args.join(' ')} failed")
+          updateState(:failed, nil, false)
+          @terminate = true
+          return false
+        end
 
-      # Parse all project files
-      unless @tj.parse(args, true)
-        @log.error("Parsing of #{args.join(' ')} failed")
+        # Then schedule the project
+        unless @tj.schedule
+          warning('schedule_failed',
+                  "Scheduling of project #{@tj.projectId} failed")
+          updateState(:failed, @tj.projectId, false)
+          @terminate = true
+          return false
+        end
+      rescue TjRuntimeError
         updateState(:failed, nil, false)
         @terminate = true
         return false
       end
 
-      # Then schedule the project
-      unless @tj.schedule
-        @log.error("Scheduling of project #{@tj.projectId} failed")
-        updateState(:failed, @tj.projectId, false)
-        Log.exit('scheduler')
-        @terminate = true
-        return false
-      end
-
       # Great, everything went fine. We've got a project to work with.
       updateState(:ready, @tj.projectId, false)
-      @log.info("Project #{@tj.projectId} loaded")
+      debug('', "Project #{@tj.projectId} loaded")
       restartTimer
       true
     end
@@ -201,7 +211,7 @@ class TaskJuggler
       # find it in the @reportServers list, we create a unique tag to identify
       # it.
       tag = rand(99999999999999)
-      @log.debug("Pushing #{tag} onto report server request queue")
+      debug('', "Pushing #{tag} onto report server request queue")
       @reportServerRequests.push(tag)
 
       # Now wait until the new ReportServer shows up in the list.
@@ -216,8 +226,8 @@ class TaskJuggler
         sleep 0.1 if reportServer.nil?
       end
 
-      @log.debug("Got report server with URI #{reportServer.uri} for " +
-                 "tag #{tag}")
+      debug('', "Got report server with URI #{reportServer.uri} for " +
+            "tag #{tag}")
       restartTimer
       [ reportServer.uri, reportServer.authKey ]
     end
@@ -249,9 +259,16 @@ class TaskJuggler
     def updateState(state, filesOrId, modified)
       begin
         @daemon = DRbObject.new(nil, @daemonURI) unless @daemon
-        @daemon.updateState(@daemonAuthKey, @authKey, filesOrId, state, modified)
-      rescue
-        @log.fatal("Can't update state with daemon: #{$!}")
+        @daemon.updateState(@daemonAuthKey, @authKey, filesOrId, state,
+                            modified)
+      rescue => exception
+        # TjRuntimeError exceptions are simply passed through.
+        if exception.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+
+        error('cannot_update_daemon_state',
+              "Can't update state with daemon: #{$!}")
       end
       @stateLock.synchronize do
         @state = state
@@ -265,6 +282,9 @@ class TaskJuggler
       Thread.new do
         begin
           loop do
+            # Exit this thread if the @terminate flag is set.
+            break if @terminate
+
             # Was the project data provided during object creation?
             # Then we load the data here.
             if @projectData
@@ -280,7 +300,7 @@ class TaskJuggler
               @stateLock.synchronize { @modifiedCheck = TjTime.new }
 
               if @tj.project.inputFiles.modified?
-                @log.info("Project #{@tj.projectId} has been modified")
+                debug('', "Project #{@tj.projectId} has been modified")
                 updateState(:ready, @tj.projectId, true)
               end
             end
@@ -288,17 +308,17 @@ class TaskJuggler
             # Check for pending requests for new ReportServers.
             unless @reportServerRequests.empty?
               tag = @reportServerRequests.pop
-              @log.debug("Popped #{tag}")
+              debug('', "Popped #{tag}")
               # Create an new entry for the @reportServers list.
               rsr = ReportServerRecord.new(tag)
-              @log.debug("RSR created")
+              debug('', "RSR created")
               # Create a new ReportServer object that runs as a separate
               # process. The constructor will tell us the URI and authentication
               # key of the new ReportServer.
               rs = ReportServer.new(@tj, @logConsole)
               rsr.uri = rs.uri
               rsr.authKey = rs.authKey
-              @log.debug("Adding ReportServer with URI #{rsr.uri} to list")
+              debug('', "Adding ReportServer with URI #{rsr.uri} to list")
               # Add the new ReportServer to our list.
               @reportServers.synchronize do
                 @reportServers << rsr
@@ -309,25 +329,31 @@ class TaskJuggler
             # can die during the transaction, the server might hang in some
             # states. Here we define timeout for each state. If the timeout is
             # not 0 and exceeded, we immediately terminate the process.
-            timeouts = { :new => 10, :loading => 15 * 60, :failed => 60,
+            timeouts = { :new => 30, :loading => 15 * 60, :failed => 60,
                          :ready => 0 }
             if timeouts[@state] > 0 &&
                TjTime.new - @stateUpdated > timeouts[@state]
-              @log.fatal("Reached timeout for state #{@state}. Terminating.")
+              error('state_timeout',
+                    "Reached timeout for state #{@state}. Terminating.")
             end
 
             # If we have not received a ping from the ProjectBroker for 2
             # minutes, we assume it has died and terminate as well.
             if TjTime.new - @lastPing > 180
-              @log.fatal('Heartbeat from daemon lost. Terminating.')
+              error('daemon_heartbeat_lost',
+                    'Heartbeat from daemon lost. Terminating.')
             end
             sleep 1
           end
-        rescue
+        rescue => exception
+          # TjRuntimeError exceptions are simply passed through.
+          if exception.is_a?(TjRuntimeError)
+            raise TjRuntimeError, $!
+          end
+
           # Make sure we get a backtrace for this thread.
-          $stderr.print $!.to_s
-          $stderr.print $!.backtrace.join("\n")
-          @log.fatal("ProjectServer housekeeping error: #{$!}")
+          fatal('ps_housekeeping_error',
+                "ProjectServer housekeeping error: #{$!}")
         end
       end
     end
@@ -381,6 +407,8 @@ class TaskJuggler
   # the ProjectServer.
   class ReportServerRecord
 
+    include MessageHandler
+
     attr_reader :tag
     attr_accessor :uri, :authKey
 
@@ -393,7 +421,6 @@ class TaskJuggler
       @authKey = nil
       # The DRbObject of the ReportServer.
       @reportServer = nil
-      @log = LogFile.instance
     end
 
     # Send a ping to the ReportServer process to check that it is still
@@ -402,14 +429,19 @@ class TaskJuggler
     def ping
       return true unless @uri
 
-      @log.debug("Sending ping to ReportServer #{@uri}")
+      debug('', "Sending ping to ReportServer #{@uri}")
       begin
         @reportServer = DRbObject.new(nil, @uri) unless @reportServer
         @reportServer.ping(@authKey)
-      rescue
+      rescue => exception
+        # TjRuntimeError exceptions are simply passed through.
+        if exception.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+
         # ReportServer processes terminate on request of their clients. Not
         # responding to a ping is a normal event.
-        @log.debug("ReportServer (#{@uri}) has terminated")
+        debug('', "ReportServer (#{@uri}) has terminated")
         return false
       end
       true

data/lib/taskjuggler/daemon/ReportServer.rb

@@ -43,7 +43,7 @@ class TaskJuggler
       rd, wr = IO.pipe
 
       if (@pid = fork) == -1
-        @log.fatal('ReportServer fork failed')
+        fatal('rs_fork_failed', 'ReportServer fork failed')
       elsif @pid.nil?
         if logConsole
           # If the Broker wasn't daemonized, log stdout and stderr to PID
@@ -56,13 +56,13 @@ class TaskJuggler
           $SAFE = 1
           DRb.install_acl(ACL.new(%w[ deny all
                                       allow 127.0.0.1 ]))
-          DRb.start_service
           iFace = ReportServerIface.new(self)
           begin
             uri = DRb.start_service('druby://127.0.0.1:0', iFace).uri
-            @log.debug("Report server is listening on #{uri}")
+            debug('', "Report server is listening on #{uri}")
           rescue
-            @log.fatal("ReportServer can't start DRb: #{$!}")
+            error('rs_cannot_start_drb',
+                  "ReportServer can't start DRb: #{$!}")
           end
 
           # Send the URI of the newly started DRb server to the parent process.
@@ -77,12 +77,16 @@ class TaskJuggler
 
           # Cleanup the DRb threads
           DRb.thread.join
-          @log.debug('Report server terminated')
+          debug('', 'Report server terminated')
           exit 0
-        rescue
-          $stderr.print $!.to_s
-          $stderr.print $!.backtrace.join("\n")
-          @log.fatal("ReportServer caught unexpected exception: #{$!}")
+        rescue => exception
+          # TjRuntimeError exceptions are simply passed through.
+          if exception.is_a?(TjRuntimeError)
+            raise TjRuntimeError, $!
+          end
+
+          error('rs_unexp_excp',
+                "ReportServer caught unexpected exception: #{$!}")
         end
       else
         Process.detach(@pid)
@@ -100,7 +104,7 @@ class TaskJuggler
     def addFile(file)
       begin
         @tj.parseFile(file, :reportPropertiesFile)
-      rescue TjException
+      rescue TjRuntimeError
         return false
       end
       restartTimer
@@ -108,40 +112,58 @@ class TaskJuggler
     end
 
     def generateReport(id, regExpMode, formats, dynamicAttributes)
-      @log.info("Generating report #{id}")
+      info('generating_report', "Generating report #{id}")
       startTime = Time.now
-      if (ok = @tj.generateReport(id, regExpMode, formats, dynamicAttributes))
-        @log.info("Report #{id} generated in #{Time.now - startTime} seconds")
-      else
-        @log.error("Report generation of #{id} failed")
+      begin
+        if (ok = @tj.generateReport(id, regExpMode, formats, dynamicAttributes))
+          info('report_id_generated',
+               "Report #{id} generated in #{Time.now - startTime} seconds")
+        else
+          error('report_generation_failed', "Report generation of #{id} failed")
+        end
+      rescue TjRuntimeError
+        return false
       end
       restartTimer
       ok
     end
 
     def listReports(id, regExpMode)
-      @log.info("Listing report #{id}")
-      if (ok = @tj.listReports(id, regExpMode))
-        @log.debug("Report list for #{id} generated")
-      else
-        @log.error("Report list compilation of #{id} failed")
+      info('listing_report_id', "Listing report #{id}")
+      begin
+        if (ok = @tj.listReports(id, regExpMode))
+          debug('', "Report list for #{id} generated")
+        else
+          error('repor_list_comp_failed',
+                "Report list compilation of #{id} failed")
+        end
+      rescue TjRuntimeError
+        return false
       end
       restartTimer
       ok
     end
 
     def checkTimeSheet(sheet)
-      @log.info("Checking time sheet #{sheet}")
-      ok = @tj.checkTimeSheet(sheet)
-      @log.debug("Time sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      info('check_time_sheet', "Checking time sheet #{sheet}")
+      begin
+        ok = @tj.checkTimeSheet(sheet)
+        debug('', "Time sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      rescue TjRuntimeError
+        return false
+      end
       restartTimer
       ok
     end
 
     def checkStatusSheet(sheet)
-      @log.info("Checking status sheet #{sheet}")
-      ok = @tj.checkStatusSheet(sheet)
-      @log.debug("Status sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      info('check_status_sheet', "Checking status sheet #{sheet}")
+      begin
+        ok = @tj.checkStatusSheet(sheet)
+        debug('', "Status sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      rescue TjRuntimeError
+        return false
+      end
       restartTimer
       ok
     end
@@ -152,7 +174,8 @@ class TaskJuggler
       Thread.new do
         loop do
           if TjTime.new - @lastPing > 120
-            @log.fatal('Heartbeat from ProjectServer lost. Terminating.')
+            error('ps_heartbeat_lost',
+                  'Heartbeat from ProjectServer lost. Terminating.')
           end
           sleep 30
         end
@@ -181,7 +204,8 @@ class TaskJuggler
       trap { @server.addFile(file) }
     end
 
-    def generateReport(authKey, reportId, regExpMode, formats, dynamicAttributes)
+    def generateReport(authKey, reportId, regExpMode, formats,
+                       dynamicAttributes)
       return false unless @server.checkKey(authKey, 'generateReport')
 
       trap do

data/lib/taskjuggler/daemon/ReportServlet.rb

@@ -12,29 +12,43 @@
 #
 
 require 'webrick'
+require 'taskjuggler/MessageHandler'
+require 'taskjuggler/RichText'
+require 'taskjuggler/HTMLDocument'
+require 'taskjuggler/daemon/DaemonConnector'
 
 class TaskJuggler
 
   class ReportServlet < WEBrick::HTTPServlet::AbstractServlet
 
-    def initialize(config, *options)
+    def initialize(config, options)
       super
-      @broker = options[0]
+      @authKey = options[0]
+      @host = options[1]
+      @port = options[2]
+      @uri = options[3]
     end
 
     def self.get_instance(config, options)
-      self.new(config, *options)
+      self.new(config, options)
     end
 
     def do_GET(req, res)
+      debug('', "Serving URL #{req}")
       @req = req
       @res = res
       begin
-        projectId = req.query['project']
-        reportId = req.query['report']
-        if projectId.nil? || reportId.nil?
+        # WEBrick is returning the query elements as FormData objects. We must
+        # use to_s to explicitely convert them to String objects.
+        projectId = req.query['project'].to_s
+        debug('', "Project ID: #{projectId}")
+        reportId = req.query['report'].to_s
+        debug('', "Report ID: #{reportId}")
+        if projectId.empty? || reportId.empty?
+          debug('', "Project welcome page requested")
           generateWelcomePage(projectId)
         else
+          debug('', "Report #{reportId} of project #{projectId} requested")
           attributes = req.query['attributes'] || ''
           attributes = URLParameter.decode(attributes) unless attributes.empty?
           generateReport(projectId, reportId, attributes)
@@ -45,11 +59,32 @@ class TaskJuggler
 
     private
 
+    def connectToBroker
+      begin
+        broker = DaemonConnector.new(@authKey, @host, @port, @uri)
+      rescue
+        error('cannot_connect_broker',
+              "Cannot connect to the TaskJuggler daemon: #{$!}\n" +
+              "Please make sure you have tj3d running and listening " +
+              "on port #{@port} or URI '#{@uri}'.")
+      end
+
+      broker
+    end
+
     def generateReport(projectId, reportId, attributes)
+      broker = connectToBroker
+
       # Request the Project credentials from the ProbjectBroker.
-      @ps_uri, @ps_authKey = @broker.getProject(projectId)
+      begin
+        @ps_uri, @ps_authKey = broker.getProject(projectId)
+      rescue
+        error('cannot_get_project_server',
+              "Cannot get project server for ID #{projectId}: #{$!}")
+      end
+
       if @ps_uri.nil?
-        error("No project with ID #{projectId} loaded")
+        error('ps_uri_nil', "No project with ID #{projectId} loaded")
       end
       # Get the responsible ReportServer that can generate the report.
       begin
@@ -57,7 +92,8 @@ class TaskJuggler
         @rs_uri, @rs_authKey = @projectServer.getReportServer(@ps_authKey)
         @reportServer = DRbObject.new(nil, @rs_uri)
       rescue
-        error("Cannot get report server")
+        error('cannot_get_report_server',
+              "Cannot get report server: #{$!}")
       end
       # Create two StringIO buffers that will receive the $stdout and $stderr
       # text from the report server. This buffer will contain the generated
@@ -70,8 +106,13 @@ class TaskJuggler
 
       begin
         @reportServer.connect(@rs_authKey, stdOut, stdErr, $stdin, true)
-      rescue
-        error("Can't connect IO: #{$!}")
+      rescue => exception
+        # TjRuntimeError exceptions are simply passed through.
+        if exception.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+
+        error('rs_io_connect_failed', "Can't connect IO: #{$!}")
       end
 
       # Ask the ReportServer to generate the reports with the provided ID.
@@ -81,21 +122,24 @@ class TaskJuggler
       rescue
         stdOut.rewind
         stdErr.rewind
-        error("Report server crashed: #{$!}\n#{stdErr.read}\n#{stdOut.read}")
+        error('rs_generate_report_failed',
+              "Report server crashed: #{$!}\n#{stdErr.read}\n#{stdOut.read}")
       end
       # Disconnect the ReportServer
       begin
         @reportServer.disconnect(@rs_authKey)
       rescue
-        error("Can't disconnect IO: #{$!}")
+        error('rs_io_disconnect_failed', "Can't disconnect IO: #{$!}")
       end
       # And send a termination request.
       begin
         @reportServer.terminate(@rs_authKey)
       rescue
-        error("Report server termination failed: #{$!}")
+        error('report_server_term_failed',
+              "Report server termination failed: #{$!}")
       end
       @reportServer = nil
+      broker.disconnect
 
       @res['content-type'] = 'text/html'
       stdErr.rewind
@@ -107,7 +151,14 @@ class TaskJuggler
     end
 
     def generateWelcomePage(projectId)
-      projects = @broker.getProjectList
+      broker = connectToBroker
+
+      begin
+        projects = broker.getProjectList
+      rescue
+        error('cannot_get_project_list',
+              "Cannot get project list from daemon: #{$!}")
+      end
 
       text = "== Welcome to the TaskJuggler Project Server ==\n----\n"
       projects.each do |id|
@@ -128,6 +179,10 @@ class TaskJuggler
           text << "* [/taskjuggler?project=#{id} #{getProjectName(id)}]\n"
         end
       end
+
+      # We no longer need the broker.
+      broker.disconnect
+
       rt = RichText.new(text)
       rti = rt.generateIntermediateFormat
       rti.sectionNumbers = false
@@ -139,26 +194,42 @@ class TaskJuggler
     end
 
     def getProjectName(id)
-      uri, authKey = @broker.getProject(id)
+      broker = connectToBroker
+
+      uri, authKey = broker.getProject(id)
       return nil unless uri
       projectServer = DRbObject.new(nil, uri)
       return nil unless projectServer
-      projectServer.getProjectName(authKey)
+      res = projectServer.getProjectName(authKey)
+
+      broker.disconnect
+
+      res
     end
 
     def getReportList(id)
-      uri, authKey = @broker.getProject(id)
+      broker = connectToBroker
+
+      uri, authKey = broker.getProject(id)
       return [] unless uri
       projectServer = DRbObject.new(nil, uri)
       return [] unless projectServer
-      projectServer.getReportList(authKey)
+      res = projectServer.getReportList(authKey)
+
+      broker.disconnect
+
+      res
     end
 
-    def error(message)
+    def error(id, message)
       @res.status = 412
       @res.body = "ERROR: #{message}"
       @res['content-type'] = 'text/plain'
-      raise "Error: #{message}"
+      MessageHandlerInstance.instance.error(id, message)
+    end
+
+    def debug(id, message)
+      MessageHandlerInstance.instance.debug(id, message)
     end
 
   end