taskjuggler 0.0.6 → 0.0.7

data/lib/daemon/ProjectServer.rb

@@ -37,7 +37,7 @@ class TaskJuggler
 
     attr_reader :authKey, :uri
 
-    def initialize(projectData = nil)
+    def initialize(projectData = nil, logConsole = false)
       @projectData = projectData
       # Since we are still in the ProjectBroker process, the current DRb
       # server is still the ProjectBroker DRb server.
@@ -46,6 +46,7 @@ class TaskJuggler
       @daemon = nil
       initIntercom
 
+      @logConsole = logConsole
       @pid = nil
       @uri = nil
 
@@ -79,34 +80,45 @@ class TaskJuggler
         @log.fatal('ProjectServer fork failed')
       elsif @pid.nil?
         # This is the child
-        $SAFE = 1
-        DRb.install_acl(ACL.new(%w[ deny all
-                                    allow 127.0.0.1 ]))
-        DRb.start_service
-        iFace = ProjectServerIface.new(self)
+        if @logConsole
+          # If the Broker wasn't daemonized, log stdout and stderr to PID
+          # specific files.
+          $stderr.reopen("tj3d.ps.#{$$}.stderr", 'w')
+          $stdout.reopen("tj3d.ps.#{$$}.stdout", 'w')
+        end
         begin
-          @uri = DRb.start_service('druby://127.0.0.1:0', iFace).uri
-          @log.debug("Project server is listening on #{@uri}")
+          $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}")
+          rescue
+            @log.fatal("ProjectServer can't start DRb: #{$!}")
+          end
+
+          # Send the URI of the newly started DRb server to the parent process.
+          rd.close
+          wr.write @uri
+          wr.close
+
+          # Start a Thread that waits for the @terminate flag to be set and does
+          # other background tasks.
+          startTerminator
+          # Start another Thread that will be used to fork-off ReportServer
+          # processes.
+          startHousekeeping
+
+          # Cleanup the DRb threads
+          DRb.thread.join
+          @log.debug('Project server terminated')
+          exit 0
         rescue
+          $stderr.print $!.to_s
+          $stderr.print $!.backtrace.join("\n")
           @log.fatal("ProjectServer can't start DRb: #{$!}")
         end
-
-        # Send the URI of the newly started DRb server to the parent process.
-        rd.close
-        wr.write @uri
-        wr.close
-
-        # Start a Thread that waits for the @terminate flag to be set and does
-        # other background tasks.
-        startTerminator
-        # Start another Thread that will be used to fork-off ReportServer
-        # processes.
-        startHousekeeping
-
-        # Cleanup the DRb threads
-        DRb.thread.join
-        @log.debug('Project server terminated')
-        exit 0
       else
         # This is the parent
         Process.detach(@pid)
@@ -122,16 +134,20 @@ class TaskJuggler
     # directory. The second one is the master project file (.tjp file).
     # Additionally a list of optional .tji files can be provided.
     def loadProject(args)
+      dirAndFiles = args.dup.untaint
       # The first argument is the working directory
       Dir.chdir(args.shift.untaint)
 
-      updateState(:loading, File.basename(args[0]))
+      # Save a time stamp of when the project file loading started.
+      @modifiedCheck = TjTime.now
+
+      updateState(:loading, dirAndFiles, false)
       @tj = TaskJuggler.new(true)
 
       # Parse all project files
       unless @tj.parse(args, true)
         @log.error("Parsing of #{args.join(' ')} failed")
-        updateState(:failed, File.basename(args[0]))
+        updateState(:failed, nil, false)
         @terminate = true
         return false
       end
@@ -139,14 +155,14 @@ class TaskJuggler
       # Then schedule the project
       unless @tj.schedule
         @log.error("Scheduling of project #{@tj.projectId} failed")
-        updateState(:failed, @tj.projectId)
+        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)
+      updateState(:ready, @tj.projectId, false)
       @log.info("Project #{@tj.projectId} loaded")
       restartTimer
       true
@@ -164,7 +180,7 @@ class TaskJuggler
       return [] unless @tj && (project = @tj.project)
       list = []
       project.reports.each do |report|
-        if report.get('formats').include?(:html)
+        unless report.get('formats').empty?
           list << [ report.fullId, report.name ]
         end
       end
@@ -198,7 +214,8 @@ class TaskJuggler
         sleep 0.1 if reportServer.nil?
       end
 
-      @log.debug("Got report server with URI #{reportServer.uri} for tag #{tag}")
+      @log.debug("Got report server with URI #{reportServer.uri} for " +
+                 "tag #{tag}")
       restartTimer
       [ reportServer.uri, reportServer.authKey ]
     end
@@ -225,67 +242,90 @@ class TaskJuggler
 
     private
 
-    # Update the _state_ and _id_ of the project locally and remotely.
-    def updateState(state, id)
+    # Update the _state_, _id_ and _modified_ state of the project locally and
+    # remotely.
+    def updateState(state, filesOrId, modified)
       begin
         @daemon = DRbObject.new(nil, @daemonURI) unless @daemon
-        @daemon.updateState(@authKey, id, state)
+        @daemon.updateState(@authKey, filesOrId, state, modified)
       rescue
         @log.fatal("Can't update state with daemon: #{$!}")
       end
       @stateLock.synchronize do
         @state = state
         @stateUpdated = TjTime.now
+        @modified = modified
+        @modifiedCheck = TjTime.now
       end
     end
 
     def startHousekeeping
       Thread.new do
-        loop do
-          # Was the project data provided during object creation?
-          # Then we load the data here.
-          if @projectData
-            loadProject(@projectData)
-            @projectData = nil
-          end
+        begin
+          loop do
+            # Was the project data provided during object creation?
+            # Then we load the data here.
+            if @projectData
+              loadProject(@projectData)
+              @projectData = nil
+            end
 
-          # Check for pending requests for new ReportServers.
-          unless @reportServerRequests.empty?
-            tag = @reportServerRequests.pop
-            @log.debug("Popped #{tag}")
-            # Create an new entry for the @reportServers list.
-            rsr = ReportServerRecord.new(tag)
-            @log.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)
-            rsr.uri = rs.uri
-            rsr.authKey = rs.authKey
-            @log.debug("Adding ReportServer with URI #{rsr.uri} to list")
-            # Add the new ReportServer to our list.
-            @reportServers.synchronize do
-              @reportServers << rsr
+            # Check every 60 seconds if the input files have been modified.
+            # Don't check if we already know it has been modified.
+            if @stateLock.synchronize { @state == :ready && !@modified &&
+                                        @modifiedCheck + 60 < TjTime.now }
+              # Reset the timer
+              @stateLock.synchronize { @modifiedCheck = TjTime.now }
+
+              if @tj.project.inputFiles.modified?
+                @log.info("Project #{@tj.projectId} has been modified")
+                updateState(:ready, @tj.projectId, true)
+              end
             end
-          end
 
-          # Some state changing operations are not atomic. Since the client
-          # 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,
-                       :ready => 0 }
-          if timeouts[@state] > 0 &&
-             TjTime.now - @stateUpdated > timeouts[@state]
-            @log.fatal("Reached timeout for state #{@state}. Terminating.")
-          end
+            # Check for pending requests for new ReportServers.
+            unless @reportServerRequests.empty?
+              tag = @reportServerRequests.pop
+              @log.debug("Popped #{tag}")
+              # Create an new entry for the @reportServers list.
+              rsr = ReportServerRecord.new(tag)
+              @log.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")
+              # Add the new ReportServer to our list.
+              @reportServers.synchronize do
+                @reportServers << rsr
+              end
+            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.now - @lastPing > 180
-            @log.fatal('Heartbeat from daemon lost. Terminating.')
+            # Some state changing operations are not atomic. Since the client
+            # 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,
+                         :ready => 0 }
+            if timeouts[@state] > 0 &&
+               TjTime.now - @stateUpdated > timeouts[@state]
+              @log.fatal("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.now - @lastPing > 180
+              @log.fatal('Heartbeat from daemon lost. Terminating.')
+            end
+            sleep 1
           end
-          sleep 1
+        rescue
+          # Make sure we get a backtrace for this thread.
+          $stderr.print $!.to_s
+          $stderr.print $!.backtrace.join("\n")
+          @log.fatal("ProjectServer housekeeping error: #{$!}")
         end
       end
     end
@@ -305,31 +345,31 @@ class TaskJuggler
     def loadProject(authKey, args)
       return false unless @server.checkKey(authKey, 'loadProject')
 
-      @server.loadProject(args)
+      trap { @server.loadProject(args) }
     end
 
     def getProjectName(authKey)
       return false unless @server.checkKey(authKey, 'getReportServer')
 
-      @server.getProjectName
+      trap { @server.getProjectName }
     end
 
     def getReportList(authKey)
       return false unless @server.checkKey(authKey, 'getReportServer')
 
-      @server.getReportList
+      trap { @server.getReportList }
     end
 
     def getReportServer(authKey)
       return false unless @server.checkKey(authKey, 'getReportServer')
 
-      @server.getReportServer
+      trap { @server.getReportServer }
     end
 
     def ping(authKey)
       return false unless @server.checkKey(authKey, 'ping')
 
-      @server.ping
+      trap { @server.ping }
       true
     end
 

data/lib/daemon/ReportServer.rb

@@ -12,7 +12,6 @@
 
 require 'daemon/ProcessIntercom'
 require 'TjException'
-require 'Message'
 require 'TjTime'
 
 class TaskJuggler
@@ -23,7 +22,7 @@ class TaskJuggler
 
     attr_reader :uri, :authKey
 
-    def initialize(tj)
+    def initialize(tj, logConsole = false)
       initIntercom
 
       @pid = nil
@@ -45,33 +44,45 @@ class TaskJuggler
       if (@pid = fork) == -1
         @log.fatal('ReportServer fork failed')
       elsif @pid.nil?
-        # This is the child
-        $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}")
-        rescue
-          @log.fatal("ReportServer can't start DRb: #{$!}")
+        if logConsole
+          # If the Broker wasn't daemonized, log stdout and stderr to PID
+          # specific files.
+          $stderr.reopen("tj3d.rs.#{$$}.stderr", 'w')
+          $stdout.reopen("tj3d.rs.#{$$}.stdout", 'w')
         end
+        begin
+          # This is the child
+          $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}")
+          rescue
+            @log.fatal("ReportServer can't start DRb: #{$!}")
+          end
 
-        # Send the URI of the newly started DRb server to the parent process.
-        rd.close
-        wr.write uri
-        wr.close
+          # Send the URI of the newly started DRb server to the parent process.
+          rd.close
+          wr.write uri
+          wr.close
 
-        # Start a Thread that waits for the @terminate flag to be set and does
-        # other background tasks.
-        startTerminator
-        startWatchDog
+          # Start a Thread that waits for the @terminate flag to be set and does
+          # other background tasks.
+          startTerminator
+          startWatchDog
 
-        # Cleanup the DRb threads
-        DRb.thread.join
-        @log.debug('Report server terminated')
-        exit 0
+          # Cleanup the DRb threads
+          DRb.thread.join
+          @log.debug('Report server terminated')
+          exit 0
+        rescue
+          $stderr.print $!.to_s
+          $stderr.print $!.backtrace.join("\n")
+          @log.fatal("ReportServer caught unexpected exception: #{$!}")
+        end
       else
         Process.detach(@pid)
         # This is the parent
@@ -159,38 +170,38 @@ class TaskJuggler
     def ping(authKey)
       return false unless @server.checkKey(authKey, 'addFile')
 
-      @server.ping
+      trap { @server.ping }
     end
 
     def addFile(authKey, file)
       return false unless @server.checkKey(authKey, 'addFile')
 
-      @server.addFile(file)
+      trap { @server.addFile(file) }
     end
 
     def generateReport(authKey, reportId, regExpMode, dynamicAttributes)
       return false unless @server.checkKey(authKey, 'generateReport')
 
-      @server.generateReport(reportId, regExpMode, dynamicAttributes)
+      trap { @server.generateReport(reportId, regExpMode, dynamicAttributes) }
     end
 
 
     def listReports(authKey, reportId, regExpMode)
       return false unless @server.checkKey(authKey, 'generateReport')
 
-      @server.listReports(reportId, regExpMode)
+      trap { @server.listReports(reportId, regExpMode) }
     end
 
     def checkTimeSheet(authKey, sheet)
       return false unless @server.checkKey(authKey, 'checkTimeSheet')
 
-      @server.checkTimeSheet(sheet)
+      trap { @server.checkTimeSheet(sheet) }
     end
 
     def checkStatusSheet(authKey, sheet)
       return false unless @server.checkKey(authKey, 'checkStatusSheet')
 
-      @server.checkStatusSheet(sheet)
+      trap { @server.checkStatusSheet(sheet) }
     end
 
   end

data/lib/daemon/WebServer.rb

@@ -32,6 +32,7 @@ class TaskJuggler
 
     # Create a web server object that runs in a separate thread.
     def initialize(broker, port)
+      @log = LogFile.instance
       @broker = broker
 
       config = { :Port => port }
@@ -40,12 +41,29 @@ class TaskJuggler
 
       # Serve some directories via the FileHandler servlet.
       %w( css icons scripts ).each do |dir|
-        fullDir = AppConfig.dataDirs("data/#{dir}")[0]
+        unless (fullDir = AppConfig.dataDirs("data/#{dir}")[0])
+          @log.fatal(<<"EOT"
+Cannot find the #{dir} directory. This is usually the result of an
+improper TaskJuggler installation. If you know the directory, you can use the
+TASKJUGGLER_DATA_PATH environment variable to specify the location. The
+variable should be set to the path without the /data at the end. Multiple
+directories must be separated by colons.
+EOT
+                    )
+        end
         @server.mount("/#{dir}", WEBrick::HTTPServlet::FileHandler, fullDir)
       end
 
       # Start the web server in a new thread so we don't block this thread.
-      @thread = Thread.new { @server.start }
+      @thread = Thread.new do
+        begin
+          @server.start
+        rescue
+          $stderr.print $!.to_s
+          $stderr.print $!.backtrace.join("\n")
+          @log.fatal("Web server error: #{$!}")
+        end
+      end
     end
 
     # Stop the web server.
@@ -79,6 +97,7 @@ class TaskJuggler
           generateWelcomePage(projectId)
         else
           attributes = req.query['attributes'] || ''
+          attributes = URLParameter.decode(attributes) unless attributes.empty?
           generateReport(projectId, reportId, attributes)
         end
       rescue