taskjuggler 0.0.5 → 0.0.6

data/lib/URLParameter.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = URLParameter.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of version 2 of the GNU General Public License as
+# published by the Free Software Foundation.
+#
+
+require 'zlib'
+
+class TaskJuggler
+
+  class URLParameter
+
+    def URLParameter.encode(data)
+      [Zlib::Deflate.deflate(data)].pack('m')
+    end
+
+    def URLParameter.decode(data)
+      Zlib::Inflate.inflate(data.unpack('m')[0])
+    end
+
+  end
+
+end
+

data/lib/XMLDocument.rb

@@ -42,11 +42,11 @@ class TaskJuggler
 
     # Write the XMLDocument to the specified file.
     def write(filename)
-      f = File.new(filename.untaint, 'w')
+      f = filename == '.' ? $stdout : File.new(filename.untaint, 'w')
       @elements.each do |element|
         f.puts element.to_s(0)
       end
-      f.close
+      f.close unless f == $stdout
     end
 
   end

data/lib/daemon/ProcessIntercom.rb

@@ -47,6 +47,13 @@ class TaskJuggler
       # This flag will be set to true by DRb method calls to terminate the
       # process.
       @terminate = false
+
+      # This mutex is locked while a client is connected.
+      @clientConnection = Mutex.new
+      # This lock protects the @timerStart
+      @timeLock = Monitor.new
+      # The time stamp of the last client interaction.
+      @timerStart = nil
     end
 
     def terminate
@@ -55,6 +62,8 @@ class TaskJuggler
     end
 
     def connect(stdout, stderr, stdin, silent)
+      # Set the client lock.
+      @clientConnection.lock
       @log.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
@@ -62,9 +71,9 @@ class TaskJuggler
       @stdout = $stdout
       @stderr = $stderr
       @stdin = $stdin
-      $stdout = stdout
-      $stderr = stderr
-      $stdin = stdin
+      $stdout = stdout if stdout
+      $stderr = stderr if stdout
+      $stdin = stdin if stdin
       @log.debug('IO is now routed to the client')
       Log.silent = silent
       true
@@ -73,10 +82,12 @@ class TaskJuggler
     def disconnect
       @log.debug('Restoring IO')
       Log.silent = true
-      $stdout = @stdout
-      $stderr = @stderr
-      $stdin = @stdin
+      $stdout = @stdout if @stdout
+      $stderr = @stderr if @stderr
+      $stdin = @stdin if @stdin
       @log.debug('Standard IO has been restored')
+      # Release the client lock
+      @clientConnection.unlock
       true
     end
 
@@ -95,13 +106,43 @@ class TaskJuggler
       true
     end
 
+    # This function must be called after each client interaction to restart the
+    # client connection timer.
+    def restartTimer
+      @timeLock.synchronize do
+        @log.debug('Reseting client connection timer')
+        @timerStart = Time.new
+      end
+    end
+
+    # Check if the client interaction timer has already expired.
+    def timerExpired?
+      res = nil
+      @timeLock.synchronize do
+        res = (Time.new > @timerStart + 2 * 60 * 60)
+      end
+      res
+    end
+
+    # This method starts a new thread and waits for the @terminate variable to
+    # be true. If that happens, it waits for the @clientConnection lock or
+    # forces an exit after the timeout has been reached. It shuts down the DRb
+    # server.
     def startTerminator
       Thread.new do
         loop do
           if @terminate
-            # Give the caller a chance to properly terminate the connection.
-            sleep 1
-            @log.debug('Shutting down DRb server')
+            # We wait for the client to propery disconnect. In case this does
+            # not happen, we'll wait for the timeout and exit anyway.
+            restartTimer
+            while @clientConnection.locked? && !timerExpired? do
+              sleep 1
+            end
+            if timerExpired?
+              @log.warning('Shutting down DRb server due to timeout')
+            else
+              @log.debug('Shutting down DRb server')
+            end
             DRb.stop_service
             break
           else

data/lib/daemon/ProjectBroker.rb

@@ -16,6 +16,7 @@ require 'drb'
 require 'drb/acl'
 require 'daemon/Daemon'
 require 'daemon/ProjectServer'
+require 'daemon/WebServer'
 require 'TjTime'
 
 class TaskJuggler
@@ -35,14 +36,15 @@ class TaskJuggler
   # daemon.
   class ProjectBroker < Daemon
 
-    attr_accessor :port
+    attr_accessor :port, :enableWebServer, :webServerPort, :projectFiles
+    attr_reader :authKey
 
     def initialize
       super
       # We don't have a default key. The user must provice a key in the config
       # file. Otherwise the daemon will not start.
       @authKey = nil
-      # The default TCP/IP port. ASCII decimal codes for 'T' and 'J'.
+      # The default TCP/IP port. ASCII code decimals for 'T' and 'J'.
       @port = 8474
       # A list of loaded projects as Array of ProjectRecord objects.
       @projects = []
@@ -50,15 +52,27 @@ class TaskJuggler
       # the access to the list.
       @projects.extend(MonitorMixin)
 
+      # A list of the initial projects. Array with Array of files names.
+      @projectFiles = []
+
       # This Queue is used to load new projects. The DRb thread pushes load
       # requests that the housekeeping thread will then perform.
       @projectsToLoad = Queue.new
 
+      # Referece 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
 
-    def start(projects)
+    def start
       # To ensure a certain level of security, the user must provide an
       # authentication key to authenticate the client to this server.
       unless @authKey
@@ -73,9 +87,19 @@ EOT
                   )
       end
 
+      # In daemon mode, we fork twice and only the 2nd child continues here.
       super()
       @log.debug("Starting project broker")
 
+      begin
+        # The web server must be started before we turn SAFE mode on.
+        @webServer = WebServer.new(self, @webServerPort) if @enableWebServer
+        @log.info("TaskJuggler web server is listening on port " +
+                  "#{@webServerPort}")
+      rescue
+        @log.fatal("Cannot start web server: #{$!}")
+      end
+
       # Setup a DRb server to handle the incomming requests from the clients.
       brokerIface = ProjectBrokerIface.new(self)
       begin
@@ -90,8 +114,8 @@ EOT
 
       # If project files were specified on the command line, we add them here.
       i = 0
-      projects.each do |project|
-        @projectsToLoad.push([ i += 1, project ])
+      @projectFiles.each do |project|
+        @projectsToLoad.push(project)
       end
 
       # Start a Thread that waits for the @terminate flag to be set and does
@@ -121,6 +145,11 @@ EOT
     def stop
       @log.debug('Terminating on client request')
 
+      # Shut down the web server if we've started one.
+      if @webServer
+        @webServer.stop
+      end
+
       # Send termination signal to all ProjectServer instances
       @projects.synchronize do
         @projects.each { |p| p.terminateServer }
@@ -223,6 +252,21 @@ EOT
       [ project.uri, project.authKey ]
     end
 
+    # Return a list of IDs of projects that are in state :ready.
+    def getProjectList
+      list = []
+      @projects.synchronize do
+        @projects.each do |project|
+          list << project.id if project.state == :ready
+        end
+      end
+      list
+    end
+
+    def report(projectId, reportId)
+      uri, key = getProject(projectId)
+    end
+
     # This is a callback from the ProjectServer process. It's used to update
     # the current state of the ProjectServer in the ProjectRecord list.
     def updateState(authKey, id, state)
@@ -296,9 +340,9 @@ EOT
             # And then send them a termination command.
             termList.each { |p| p.terminateServer }
 
-            # Check every 60 seconds that the ProjectServer processes are
+            # Check every 30 seconds that the ProjectServer processes are
             # still alive. If not, remove them from the list.
-            if (cntr += 1) > 60
+            if (cntr += 1) > 30
               @projects.synchronize do
                 @projects.each do |p|
                   unless p.ping
@@ -322,10 +366,19 @@ EOT
       end
     end
 
-    def loadProject(tag)
-      @log.debug("Loading project for tag #{tag}")
+    def loadProject(tagOrProject)
+      if tagOrProject.is_a?(Array)
+        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}")
+      else
+        tag = tagOrProject
+        project = nil
+        @log.debug("Loading project for tag #{tag}")
+      end
       pr = ProjectRecord.new(tag)
-      ps = ProjectServer.new
+      ps = ProjectServer.new(project)
       # The ProjectServer can be reached via this DRb URI
       pr.uri = ps.uri
       # Method calls must be authenticated with this key

data/lib/daemon/ProjectServer.rb

@@ -37,7 +37,8 @@ class TaskJuggler
 
     attr_reader :authKey, :uri
 
-    def initialize
+    def initialize(projectData = nil)
+      @projectData = projectData
       # Since we are still in the ProjectBroker process, the current DRb
       # server is still the ProjectBroker DRb server.
       @daemonURI = DRb.current_server.uri
@@ -147,9 +148,30 @@ class TaskJuggler
       # Great, everything went fine. We've got a project to work with.
       updateState(:ready, @tj.projectId)
       @log.info("Project #{@tj.projectId} loaded")
+      restartTimer
       true
     end
 
+    # Return the name of the loaded project or nil.
+    def getProjectName
+      return nil unless @tj
+      restartTimer
+      @tj.projectName
+    end
+
+    # Return a list of the HTML reports defined for the project.
+    def getReportList
+      return [] unless @tj && (project = @tj.project)
+      list = []
+      project.reports.each do |report|
+        if report.get('formats').include?(:html)
+          list << [ report.fullId, report.name ]
+        end
+      end
+      restartTimer
+      list
+    end
+
     # This function triggers the creation of a new ReportServer process. It
     # will return the URI and the authentication key of this new server.
     def getReportServer
@@ -177,22 +199,15 @@ class TaskJuggler
       end
 
       @log.debug("Got report server with URI #{reportServer.uri} for tag #{tag}")
+      restartTimer
       [ reportServer.uri, reportServer.authKey ]
     end
 
-    # Remove a ReportServer that's no longer needed. The client is responsible
-    # for terminating it.
-    def dropReportServer(uri)
-      @reportServers.synchronize do
-        @reportServers.delete_if { |rs| rs.uri == uri }
-      end
-    end
-
     # This function is called regularly by the ProjectBroker process to check
     # that the ProjectServer is still operating properly.
     def ping
       # Store the time stamp. If we don't get the ping for some time, we
-      # assume the ProjectServer has died.
+      # assume the ProjectBroker has died.
       @lastPing = TjTime.now
 
       # Now also check our ReportServers if they are still there. If not, we
@@ -227,6 +242,13 @@ class TaskJuggler
     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
+
           # Check for pending requests for new ReportServers.
           unless @reportServerRequests.empty?
             tag = @reportServerRequests.pop
@@ -286,16 +308,22 @@ class TaskJuggler
       @server.loadProject(args)
     end
 
-    def getReportServer(authKey)
+    def getProjectName(authKey)
       return false unless @server.checkKey(authKey, 'getReportServer')
 
-      @server.getReportServer
+      @server.getProjectName
+    end
+
+    def getReportList(authKey)
+      return false unless @server.checkKey(authKey, 'getReportServer')
+
+      @server.getReportList
     end
 
-    def dropReportServer(authKey, uri)
+    def getReportServer(authKey)
       return false unless @server.checkKey(authKey, 'getReportServer')
 
-      @server.dropReportServer(uri)
+      @server.getReportServer
     end
 
     def ping(authKey)
@@ -327,7 +355,8 @@ class TaskJuggler
     end
 
     # Send a ping to the ReportServer process to check that it is still
-    # functioning properly.
+    # functioning properly. If not, it has probably terminated and we can
+    # remove it from the list of active ReportServers.
     def ping
       return true unless @uri
 
@@ -336,7 +365,9 @@ class TaskJuggler
         @reportServer = DRbObject.new(nil, @uri) unless @reportServer
         @reportServer.ping(@authKey)
       rescue
-        @log.error("Ping failed: #{$!}")
+        # ReportServer processes terminate on request of their clients. Not
+        # responding to a ping is a normal event.
+        @log.debug("ReportServer (#{@uri}) has terminated")
         return false
       end
       true

data/lib/daemon/ReportServer.rb

@@ -91,16 +91,18 @@ class TaskJuggler
       rescue TjException
         return false
       end
+      restartTimer
       true
     end
 
-    def generateReport(id, regExpMode)
+    def generateReport(id, regExpMode, dynamicAttributes)
       @log.info("Generating report #{id}")
-      if (ok = @tj.generateReport(id, regExpMode))
+      if (ok = @tj.generateReport(id, regExpMode, dynamicAttributes))
         @log.debug("Report #{id} generated")
       else
         @log.error("Report generation of #{id} failed")
       end
+      restartTimer
       ok
     end
 
@@ -111,6 +113,7 @@ class TaskJuggler
       else
         @log.error("Report list compilation of #{id} failed")
       end
+      restartTimer
       ok
     end
 
@@ -118,6 +121,7 @@ class TaskJuggler
       @log.info("Checking time sheet #{sheet}")
       ok = @tj.checkTimeSheet(sheet)
       @log.debug("Time sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      restartTimer
       ok
     end
 
@@ -125,6 +129,7 @@ class TaskJuggler
       @log.info("Checking status sheet #{sheet}")
       ok = @tj.checkStatusSheet(sheet)
       @log.debug("Status sheet #{sheet} is #{ok ? '' : 'not '}ok")
+      restartTimer
       ok
     end
 
@@ -163,10 +168,10 @@ class TaskJuggler
       @server.addFile(file)
     end
 
-    def generateReport(authKey, reportId, regExpMode)
+    def generateReport(authKey, reportId, regExpMode, dynamicAttributes)
       return false unless @server.checkKey(authKey, 'generateReport')
 
-      @server.generateReport(reportId, regExpMode)
+      @server.generateReport(reportId, regExpMode, dynamicAttributes)
     end