taskjuggler 0.0.8 → 0.0.9

data/lib/URLParameter.rb

@@ -3,7 +3,8 @@
 #
 # = URLParameter.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/UTF8String.rb

@@ -3,7 +3,8 @@
 #
 # = UTF8String.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/UserManual.rb

@@ -3,7 +3,8 @@
 #
 # = UserManual.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/VimSyntax.rb

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = KeywordDocumentation.rb -- The TaskJuggler III Project Management Software
+# = VimSyntax.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/WorkingHours.rb

@@ -3,7 +3,8 @@
 #
 # = WorkingHours.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/XMLDocument.rb

@@ -3,7 +3,8 @@
 #
 # = XMLDocument.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/XMLElement.rb

@@ -3,7 +3,8 @@
 #
 # = XMLElement.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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

data/lib/daemon/Daemon.rb

@@ -3,7 +3,8 @@
 #
 # = Daemon.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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
@@ -20,6 +21,7 @@ class TaskJuggler
   class Daemon
 
     attr_accessor :daemonize
+    attr_reader :log
 
     def initialize
       # You can set this flag to false to prevent the program from

data/lib/daemon/ProcessIntercom.rb

@@ -3,7 +3,8 @@
 #
 # = ProcessIntercom.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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
@@ -11,6 +12,7 @@
 #
 
 require 'Log'
+require 'LogFile'
 
 class TaskJuggler
 

data/lib/daemon/ProjectBroker.rb

@@ -3,7 +3,8 @@
 #
 # = ProjectBroker.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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
@@ -36,9 +37,8 @@ class TaskJuggler
   # daemon.
   class ProjectBroker < Daemon
 
-    attr_accessor :port, :uriFile, :enableWebServer, :webServerPort,
-                  :projectFiles
-    attr_reader :authKey
+    attr_accessor :authKey, :port, :uriFile, :enableWebServer, :webServerPort,
+                  :projectFiles, :logStdIO
 
     def initialize
       super
@@ -62,7 +62,11 @@ class TaskJuggler
       # requests that the housekeeping thread will then perform.
       @projectsToLoad = Queue.new
 
-      # Referece to WEBrick object.
+      # Set this flag to true to have standard IO logged into files. There
+      # will be seperate set of files for each process.
+      @logStdIO = !@daemonize
+
+      # Reference to WEBrick object.
       @webServer = nil
 
       # Port used by the web server
@@ -94,13 +98,15 @@ EOT
       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: #{$!}")
+      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
 
       # Setup a DRb server to handle the incomming requests from the clients.
@@ -115,7 +121,7 @@ EOT
         @log.fatal("Cannot listen on port #{@port}: #{$!}")
       end
 
-      if @port == 0
+      if @port == 0 && @uriFile
         # If the port is set to 0 (any port) we save the ProjectBroker URI in
         # the file .tj3d.uri. tj3client will look for it.
         begin
@@ -139,7 +145,7 @@ EOT
       DRb.thread.join
 
       # If we have created a URI file, we need to delete it again.
-      if @port == 0
+      if @port == 0 && @uriFile
         begin
           File.delete(@uriFile)
         rescue
@@ -205,7 +211,7 @@ EOT
 
     # Adding a new project or replacing an existing one. The command waits
     # until the project has been loaded or the load has failed.
-    def addProject
+    def addProject(cwd, args, stdOut, stdErr, stdIn, silent)
       # We need some tag to identify the ProjectRecord that this project was
       # associated to. Just use a large enough random number.
       tag = rand(9999999999999)
@@ -213,7 +219,7 @@ EOT
       @log.debug("Pushing #{tag} to load Queue")
       @projectsToLoad.push(tag)
 
-      # Now we have to wait until the loaded project shows up in the @projects
+      # Now we have to wait until the project shows up in the @projects
       # list. We use our tag to identify the right entry.
       pr = nil
       while pr.nil?
@@ -234,20 +240,60 @@ EOT
                  "#{pr.uri}")
       # Return the URI and the authentication key of the new ProjectServer.
       [ pr.uri, pr.authKey ]
+
+      # Open a DRb connection to the ProjectServer process
+      begin
+        projectServer = DRbObject.new(nil, pr.uri)
+      rescue
+        stdErr.puts "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: #{$!}"
+        return false
+      end
+
+      # Ask the ProjectServer to load the files in _args_ into the
+      # ProjectServer.
+      begin
+        res = projectServer.loadProject(pr.authKey, [ cwd, *args ])
+      rescue
+        stdErr.puts "Loading of project failed: #{$!}"
+        return false
+      end
+
+      # Disconnect the IO from the ProjectServer and close the DRb connection.
+      begin
+        projectServer.disconnect(pr.authKey)
+      rescue
+        stdErr.puts "Can't disconnect IO: #{$!}"
+        return false
+      end
+
+      res
     end
 
     def removeProject(indexOrId)
-      # 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
-          @projects[index].state = :obsolete
-          return true
-        end
-      else
-        @projects.synchronize do
+      @projects.synchronize do
+        # 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
+            # If we have marked the project as obsolete, we return false to
+            # indicate the double remove.
+            return false if p.state == :obsolete
+            @projects[index].state = :obsolete
+            return true
+          end
+        else
           @projects.each do |p|
             if indexOrId == p.id
+              # If we have marked the project as obsolete, we return false to
+              # indicate the double remove.
+              return false if p.state == :obsolete
               p.state = :obsolete
               return true
             end
@@ -305,7 +351,9 @@ EOT
 
     # 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, filesOrId, state, modified)
+    # _projectKey_ is the authentication key for that project. It is used to
+    # idenfity the entry in the ProjectRecord list to be updated.
+    def updateState(projectKey, filesOrId, state, modified)
       result = false
       if filesOrId.is_a?(Array)
         files = filesOrId
@@ -324,8 +372,8 @@ EOT
           next if project.state == :obsolete
 
           @log.debug("Updating state for #{id} to #{state}")
-          # Only update the record that has the matching authKey
-          if project.authKey == authKey
+          # Only update the record that has the matching key
+          if project.authKey == projectKey
             project.id = id if id
             # An Array of [ workingDir, tjpFile, ... other tji files ]
             project.files = files if files
@@ -434,7 +482,7 @@ EOT
         @log.debug("Loading project for tag #{tag}")
       end
       pr = ProjectRecord.new(tag)
-      ps = ProjectServer.new(project, !@daemonize)
+      ps = ProjectServer.new(@authKey, project, @logStdIO)
       # The ProjectServer can be reached via this DRb URI
       pr.uri = ps.uri
       # Method calls must be authenticated with this key
@@ -491,7 +539,9 @@ EOT
         when :stop
           @broker.stop
         when :addProject
-          @broker.addProject
+          # To pass the DRbObject as separate arguments we need to convert it
+          # into a real Array again.
+          @broker.addProject(*Array.new(args))
         when :removeProject
           @broker.removeProject(args)
         when :getProject
@@ -504,8 +554,10 @@ EOT
       end
     end
 
-    def updateState(authKey, id, status, modified)
-      trap { @broker.updateState(authKey, id, status, modified) }
+    def updateState(authKey, projectKey, id, status, modified)
+      return false unless @broker.checkKey(authKey, 'updateState')
+
+      trap { @broker.updateState(projectKey, id, status, modified) }
     end
 
   end

data/lib/daemon/ProjectServer.rb

@@ -3,7 +3,8 @@
 #
 # = ProjectServer.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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
@@ -37,7 +38,8 @@ class TaskJuggler
 
     attr_reader :authKey, :uri
 
-    def initialize(projectData = nil, logConsole = false)
+    def initialize(daemonAuthKey, projectData = nil, logConsole = false)
+      @daemonAuthKey = daemonAuthKey
       @projectData = projectData
       # Since we are still in the ProjectBroker process, the current DRb
       # server is still the ProjectBroker DRb server.
@@ -247,7 +249,7 @@ class TaskJuggler
     def updateState(state, filesOrId, modified)
       begin
         @daemon = DRbObject.new(nil, @daemonURI) unless @daemon
-        @daemon.updateState(@authKey, filesOrId, state, modified)
+        @daemon.updateState(@daemonAuthKey, @authKey, filesOrId, state, modified)
       rescue
         @log.fatal("Can't update state with daemon: #{$!}")
       end

data/lib/daemon/ReportServer.rb

@@ -3,7 +3,8 @@
 #
 # = ReportServer.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
 #
 # 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
@@ -106,10 +107,10 @@ class TaskJuggler
       true
     end
 
-    def generateReport(id, regExpMode, dynamicAttributes)
+    def generateReport(id, regExpMode, formats, dynamicAttributes)
       @log.info("Generating report #{id}")
       startTime = Time.now
-      if (ok = @tj.generateReport(id, regExpMode, dynamicAttributes))
+      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")
@@ -180,10 +181,12 @@ class TaskJuggler
       trap { @server.addFile(file) }
     end
 
-    def generateReport(authKey, reportId, regExpMode, dynamicAttributes)
+    def generateReport(authKey, reportId, regExpMode, formats, dynamicAttributes)
       return false unless @server.checkKey(authKey, 'generateReport')
 
-      trap { @server.generateReport(reportId, regExpMode, dynamicAttributes) }
+      trap do
+        @server.generateReport(reportId, regExpMode, formats, dynamicAttributes)
+      end
     end
 
 

data/lib/daemon/ReportServlet.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ReportServlet.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011
+#               by Chris Schlaeger <chris@linux.com>
+#
+# 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 'webrick'
+
+class TaskJuggler
+
+  class ReportServlet < WEBrick::HTTPServlet::AbstractServlet
+
+    def initialize(config, *options)
+      super
+      @broker = options[0]
+    end
+
+    def self.get_instance(config, options)
+      self.new(config, *options)
+    end
+
+    def do_GET(req, res)
+      @req = req
+      @res = res
+      begin
+        projectId = req.query['project']
+        reportId = req.query['report']
+        if projectId.nil? || reportId.nil?
+          generateWelcomePage(projectId)
+        else
+          attributes = req.query['attributes'] || ''
+          attributes = URLParameter.decode(attributes) unless attributes.empty?
+          generateReport(projectId, reportId, attributes)
+        end
+      rescue
+      end
+    end
+
+    private
+
+    def generateReport(projectId, reportId, attributes)
+      # Request the Project credentials from the ProbjectBroker.
+      @ps_uri, @ps_authKey = @broker.getProject(projectId)
+      if @ps_uri.nil?
+        error("No project with ID #{projectId} loaded")
+      end
+      # Get the responsible ReportServer that can generate the report.
+      begin
+        @projectServer = DRbObject.new(nil, @ps_uri)
+        @rs_uri, @rs_authKey = @projectServer.getReportServer(@ps_authKey)
+        @reportServer = DRbObject.new(nil, @rs_uri)
+      rescue
+        error("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
+      # report as HTML encoded text. They will be send via DRb, so we have to
+      # extend them with DRbUndumped.
+      stdOut = StringIO.new('')
+      stdOut.include DRbUndumped
+      stdErr = StringIO.new('')
+      stdErr.include DRbUndumped
+
+      begin
+        @reportServer.connect(@rs_authKey, stdOut, stdErr, $stdin, true)
+      rescue
+        error("Can't connect IO: #{$!}")
+      end
+
+      # Ask the ReportServer to generate the reports with the provided ID.
+      begin
+        @reportServer.generateReport(@rs_authKey, reportId, false, nil,
+                                     attributes)
+      rescue
+        stdOut.rewind
+        stdErr.rewind
+        error("Report server crashed: #{$!}\n#{stdErr.read}\n#{stdOut.read}")
+      end
+      # Disconnect the ReportServer
+      begin
+        @reportServer.disconnect(@rs_authKey)
+      rescue
+        error("Can't disconnect IO: #{$!}")
+      end
+      # And send a termination request.
+      begin
+        @reportServer.terminate(@rs_authKey)
+      rescue
+        error("Report server termination failed: #{$!}")
+      end
+      @reportServer = nil
+
+      @res['content-type'] = 'text/html'
+      stdErr.rewind
+      $stderr.puts stdErr.read
+      # To read the $stdout of the ReportServer we need to rewind the buffer
+      # and then read the full text.
+      stdOut.rewind
+      @res.body = stdOut.read
+    end
+
+    def generateWelcomePage(projectId)
+      projects = @broker.getProjectList
+
+      text = "== Welcome to the TaskJuggler Project Server ==\n----\n"
+      projects.each do |id|
+        if id == projectId
+          # Show the list of reports for this project.
+          text << "* [/taskjuggler #{getProjectName(id)}]\n"
+          reports = getReportList(id)
+          if reports.empty?
+            text << "** This project has no reports defined.\n"
+          else
+            reports.each do |reportId, reportName|
+              text << "** [/taskjuggler?project=#{id};report=#{reportId} " +
+                      "#{reportName}]\n"
+            end
+          end
+        else
+          # Just show a link to open the report list.
+          text << "* [/taskjuggler?project=#{id} #{getProjectName(id)}]\n"
+        end
+      end
+      rt = RichText.new(text)
+      rti = rt.generateIntermediateFormat
+      rti.sectionNumbers = false
+      page = HTMLDocument.new
+      page.generateHead("The TaskJuggler Project Server")
+      page << rti.to_html
+      @res['content-type'] = 'text/html'
+      @res.body = page.to_s
+    end
+
+    def getProjectName(id)
+      uri, authKey = @broker.getProject(id)
+      return nil unless uri
+      projectServer = DRbObject.new(nil, uri)
+      return nil unless projectServer
+      projectServer.getProjectName(authKey)
+    end
+
+    def getReportList(id)
+      uri, authKey = @broker.getProject(id)
+      return [] unless uri
+      projectServer = DRbObject.new(nil, uri)
+      return [] unless projectServer
+      projectServer.getReportList(authKey)
+    end
+
+    def error(message)
+      @res.status = 412
+      @res.body = "ERROR: #{message}"
+      @res['content-type'] = 'text/plain'
+      raise "Error: #{message}"
+    end
+
+  end
+
+end