taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/XMLElement.rb

@@ -23,12 +23,17 @@ class TaskJuggler
     def initialize(name, attributes = {}, selfClosing = false, &block)
       if (name.nil? && attributes.length > 0) ||
          (!name.nil? && !name.is_a?(String))
-        raise "Name must be nil or a String "
+        raise ArgumentError, "Name must be nil or a String "
       end
       @name = name
       attributes.each do |n, v|
         if n.nil? || v.nil?
-          raise "Attribute name (#{n}) or value (#{v}) may not be nil"
+          raise ArgumentError,
+            "Attribute name (#{n}) or value (#{v}) may not be nil"
+        end
+        unless v.is_a?(String)
+          raise ArgumentError,
+            "Attribute value of #{n} must be a String"
         end
       end
       @attributes = attributes
@@ -91,6 +96,8 @@ class TaskJuggler
 
     # Add or change _attribute_ to _value_.
     def []=(attribute, value)
+      raise ArgumentError,
+        "Attribute value #{value} is not a String" unless value.is_a?(String)
       @attributes[attribute] = value
     end
 

data/lib/taskjuggler/apps/Tj3.rb

@@ -35,6 +35,8 @@ class TaskJuggler
       @checkSyntax = false
       # Don't generate reports when previous errors have been found.
       @forceReports = false
+      # Don't generate trace reports by default
+      @generateTraces = false
       # Should a booking file be generated?
       @freeze = false
       # The cut-off date for the freeze
@@ -87,7 +89,8 @@ EOT
           begin
             @freezeDate = TjTime.new(arg).align(3600)
           rescue TjException => msg
-            error("Invalid freeze date: #{msg.message}")
+            error('tj3_ivld_freeze_date',
+                  "Invalid freeze date: #{msg.message}")
           end
         end
         @opts.on('--freezebytask',
@@ -117,6 +120,10 @@ EOT
                        'reports.')) do
          @noReports = true
         end
+        @opts.on('--add-trace',
+                 format('Append a current data set to all trace reports.')) do
+          @generateTraces = true
+        end
         @opts.on('--abort-on-warnings',
                  format('Abort program on warnings like we do on errors.')) do
           @abortOnWarning = true
@@ -133,49 +140,48 @@ EOT
     end
 
     def appMain(files)
-      begin
-        if files.empty?
-          error('You must provide at least one .tjp file', 1)
-        end
-        if @outputDir != '' && !Dir.exists?(@outputDir)
-          error("Output directory #{@outputDir} does not exist!")
-        end
-
-        tj = TaskJuggler.new(true)
-        tj.maxCpuCores = @maxCpuCores
-        tj.warnTsDeltas = @warnTsDeltas
-        tj.messageHandler.abortOnWarning = @abortOnWarning
-        keepParser = !@timeSheets.empty? || !@statusSheets.empty?
-        return 1 unless tj.parse(files, keepParser)
+      if files.empty?
+        error('tj3_tjp_file_missing',
+              'You must provide at least one .tjp file')
+      end
+      if @outputDir != '' && !File.directory?(@outputDir)
+        error('tj3_outdir_missing',
+              "Output directory #{@outputDir} does not exist or is not " +
+              "a directory!")
+      end
 
-        return 0 if @checkSyntax
+      tj = TaskJuggler.new
+      tj.maxCpuCores = @maxCpuCores
+      tj.warnTsDeltas = @warnTsDeltas
+      tj.generateTraces = @generateTraces
+      MessageHandlerInstance.instance.abortOnWarning = @abortOnWarning
+      keepParser = !@timeSheets.empty? || !@statusSheets.empty?
+      return 1 unless tj.parse(files, keepParser)
 
-        if !tj.schedule
-          return 1 unless @forceReports
-        end
+      return 0 if @checkSyntax
 
-        # The checks of time and status sheets is probably only used for
-        # debugging.  Normally, this function is provided by tj3client.
-        @timeSheets.each do |ts|
-          return 1 if !tj.checkTimeSheet(ts) || tj.errors > 0
-        end
-        @statusSheets.each do |ss|
-          return 1 if !tj.checkStatusSheet(ss) || tj.errors > 0
-        end
+      if !tj.schedule
+        return 1 unless @forceReports
+      end
 
-        # Check for freeze mode and generate the booking file if requested.
-        if @freeze
-          return 1 unless tj.freeze(@freezeDate, @freezeByTask) &&
-                          tj.errors == 0
-        end
+      # The checks of time and status sheets is probably only used for
+      # debugging.  Normally, this function is provided by tj3client.
+      @timeSheets.each do |ts|
+        return 1 if !tj.checkTimeSheet(ts) || tj.errors > 0
+      end
+      @statusSheets.each do |ss|
+        return 1 if !tj.checkStatusSheet(ss) || tj.errors > 0
+      end
 
-        return 0 if @noReports
+      # Check for freeze mode and generate the booking file if requested.
+      if @freeze
+        return 1 unless tj.freeze(@freezeDate, @freezeByTask) &&
+                        tj.errors == 0
+      end
 
-        return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
+      return 0 if @noReports
 
-      rescue TjRuntimeError
-        return 1
-      end
+      return 1 if !tj.generateReports(@outputDir) || tj.errors > 0
 
       0
     end

data/lib/taskjuggler/apps/Tj3Client.rb

@@ -14,7 +14,7 @@
 require 'drb'
 require 'drb/acl'
 require 'taskjuggler/Tj3AppBase'
-require 'taskjuggler/LogFile'
+require 'taskjuggler/daemon/DaemonConnector'
 
 # Name of the application
 AppConfig.appName = 'tj3client'
@@ -28,6 +28,8 @@ class TaskJuggler
   # requires a properly configured tj3d to work.
   class Tj3Client < Tj3AppBase
 
+    include DaemonConnectorMixin
+
     def initialize
       super
 
@@ -136,8 +138,8 @@ EOT
           @uriFile = arg
         end
         @opts.on('-r', '--regexp',
-                 format('The report IDs are not fixed but regular expressions ' +
-                        'that match a set of reports')) do |arg|
+                 format('The report IDs are not fixed but regular ' +
+                        'expressions that match a set of reports')) do |arg|
           @regExpMode = true
         end
         @opts.on('--unsafe',
@@ -151,8 +153,8 @@ EOT
                  format('Request the report to be generated in the specified' +
                         'format. Use multiple options to request multiple ' +
                         'formats. Supported formats are csv, html, niku and ' +
-                        'tjp. By default, the formats specified in the report ' +
-                        'definition are used.')) do |arg|
+                        'tjp. By default, the formats specified in the ' +
+                        'report definition are used.')) do |arg|
           @formats = [] unless @formats
           @formats << arg
         end
@@ -160,21 +162,18 @@ EOT
     end
 
     def appMain(args)
-      begin
-        # Run a first check of the non-optional command line arguments.
-        checkCommand(args)
-        # Read some configuration variables. Except for the authKey, they are
-        # all optional.
-        @rc.configure(self, 'global')
-
-        connectDaemon
-        retVal = executeCommand(args[0], args[1..-1])
-        disconnectDaemon
-
-        return retVal
-      rescue TjRuntimeError
-        return 1
-      end
+      # Run a first check of the non-optional command line arguments.
+      checkCommand(args)
+      # Read some configuration variables. Except for the authKey, they are
+      # all optional.
+      @rc.configure(self, 'global')
+
+      @broker = connectDaemon
+      retVal = executeCommand(args[0], args[1..-1])
+      disconnectDaemon
+      @broker = nil
+
+      retVal
     end
 
     private
@@ -205,64 +204,7 @@ EOT
         end
       end
 
-      error(errorMessage)
-    end
-
-    def connectDaemon
-      unless @authKey
-        $stderr.puts <<'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.
-
-_global:
-  authKey: your_secret_key
-EOT
-      end
-
-      uri = "druby://#{@host}:#{@port}"
-      if @port == 0
-        # If the @port is configured to 0, we need to read the URI to connect
-        # to the server from the .tj3d.uri file that has been generated by the
-        # server.
-        begin
-          uri = File.read(@uriFile).chomp
-        rescue
-          error('The server port is configured to be 0, but no ' +
-                ".tj3d.uri file can be found: #{$!}")
-        end
-      end
-
-      # We try to play it safe here. The client also starts a DRb server, so
-      # we need to make sure it's constricted to localhost only. We require
-      # the DRb server for the standard IO redirection to work.
-      $SAFE = 1 unless @unsafeMode
-      DRb.install_acl(ACL.new(%w[ deny all
-                                  allow 127.0.0.1 ]))
-      DRb.start_service('druby://127.0.0.1:0')
-
-      begin
-        # Get the ProjectBroker object from the tj3d.
-        @broker = DRbObject.new(nil, uri)
-        # Client and server should always come from the same Gem. Since we
-        # restict communication to localhost, that's probably not a problem.
-        if (check = @broker.apiVersion(@authKey, 1)) < 0
-          error('This client is too old for the server. Please ' +
-                'upgrade to a more recent version of the software.')
-        elsif check == 0
-          error('Authentication failed. Please check your authentication ' +
-                'key to match the server key.')
-        end
-      rescue
-        error("TaskJuggler server on host '#{@host}' port " +
-              "#{@port} is not responding")
-      end
-    end
-
-    def disconnectDaemon
-      @broker = nil
-
-      DRb.stop_service
+      error('tjc_cmd_error', errorMessage)
     end
 
     def executeCommand(command, args)
@@ -271,22 +213,28 @@ EOT
         $stdout.puts callDaemon(:status, [])
       when 'terminate'
         callDaemon(:stop, [])
-        info('Daemon terminated')
+        info('tjc_daemon_term', 'Daemon terminated')
       when 'add'
         res = callDaemon(:addProject, [ Dir.getwd, args,
                                         $stdout, $stderr, $stdin, @silent ])
-        info("Project(s) #{args.join(', ')} added")
-        return res ? 0 : 1
+        if res
+          info('tjc_proj_added', "Project(s) #{args.join(', ')} added")
+          return 0
+        else
+          warning('tjc_proj_adding_failed',
+                  "Projects(s) #{args.join(', ')} could not be added")
+          return 1
+        end
       when 'remove'
         args.each do |arg|
           unless callDaemon(:removeProject, arg)
-            error("Project '#{arg}' not found in list")
+            error('tjc_prj_not_found', "Project '#{arg}' not found in list")
           end
         end
-        info('Project removed')
+        info('tjc_prj_removed', 'Project removed')
       when 'update'
         callDaemon(:update, [])
-        info('Reload requested')
+        info('tjc_reload_req', 'Reload requested')
       when 'report'
         # The first value of args is the project ID. The following values
         # could be either report IDs or TJI file # names ('.' or '*.tji').
@@ -298,17 +246,22 @@ EOT
         reportIds, tjiFiles = splitIdsAndFiles(args)
         if reportIds.empty?
           disconnectReportServer
-          error('You must provide at least one report ID')
+          error('tjc_no_rep_id', 'You must provide at least one report ID')
         end
         # Send the provided .tji files to the ReportServer.
         failed = !addFiles(tjiFiles)
         # Ask the ReportServer to generate the reports with the provided IDs.
         unless failed
           reportIds.each do |reportId|
-            unless @reportServer.generateReport(@rs_authKey, reportId,
-                                                @regExpMode, @formats, nil)
-              failed = true
-              break
+            begin
+              unless @reportServer.generateReport(@rs_authKey, reportId,
+                                                  @regExpMode, @formats, nil)
+                failed = true
+                break
+              end
+            rescue
+              error('tjc_gen_rep_failed',
+                    "Could not generate report #{reportId}: #{$!}")
             end
           end
         end
@@ -334,9 +287,15 @@ EOT
         # Ask the ReportServer to generate the reports with the provided IDs.
         unless failed
           reportIds.each do |reportId|
-            unless @reportServer.listReports(@rs_authKey, reportId, @regExpMode)
-              failed = true
-              break
+            begin
+              unless @reportServer.listReports(@rs_authKey, reportId,
+                                               @regExpMode)
+                failed = true
+                break
+              end
+            rescue
+              error('tjc_report_list_failed',
+                    "Getting report list failed: #{$!}")
             end
           end
         end
@@ -348,7 +307,7 @@ EOT
         begin
           res = @reportServer.checkTimeSheet(@rs_authKey, args[1])
         rescue
-          error("Time sheet check failed: #{$!}")
+          error('tjc_tschck_failed', "Time sheet check failed: #{$!}")
         end
         disconnectReportServer
         return res ? 0 : 1
@@ -357,7 +316,7 @@ EOT
         begin
           res = @reportServer.checkStatusSheet(@rs_authKey, args[1])
         rescue
-          error("Status sheet check failed: #{$!}")
+          error('tjc_sschck_failed', "Status sheet check failed: #{$!}")
         end
         disconnectReportServer
         return res ? 0 : 1
@@ -370,19 +329,19 @@ EOT
     def connectToReportServer(projectId)
       @ps_uri, @ps_authKey = callDaemon(:getProject, projectId)
       if @ps_uri.nil?
-        error("No project with ID #{projectId} loaded")
+        error('tjc_prj_id_not_loaded', "No project with ID #{projectId} loaded")
       end
       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")
+        error('tjc_no_rep_srv', "Cannot get report server: #{$!}")
       end
       begin
         @reportServer.connect(@rs_authKey, $stdout, $stderr, $stdin, @silent)
       rescue
-        error("Can't connect IO: #{$!}")
+        error('tjc_no_io_connect', "Can't connect IO: #{$!}")
       end
     end
 
@@ -390,12 +349,12 @@ EOT
       begin
         @reportServer.disconnect(@rs_authKey)
       rescue
-        error("Can't disconnect IO: #{$!}")
+        error('tjc_no_io_disconnect', "Can't disconnect IO: #{$!}")
       end
       begin
         @reportServer.terminate(@rs_authKey)
       rescue
-        error("Report server termination failed: #{$!}")
+        error('tjc_srv_term_failed', "Report server termination failed: #{$!}")
       end
       @reportServer = nil
       @rs_uri = nil
@@ -411,7 +370,8 @@ EOT
       begin
         return @broker.command(@authKey, command, args)
       rescue
-        error("Call to TaskJuggler server on host '#{@host}' " +
+        error('tjc_call_srv_failed',
+              "Call to TaskJuggler server on host '#{@host}' " +
               "port #{@port} failed: #{$!}")
       end
     end
@@ -445,23 +405,13 @@ EOT
             return false
           end
         rescue
-          error("Cannot add file #{file} to ReportServer")
+          error('tjc_canont_add_file',
+                "Cannot add file #{file} to ReportServer")
         end
       end
       true
     end
 
-    def info(message)
-      return if @silent
-      $stdout.puts "#{message}"
-    end
-
-    def error(message, exitVal = 1)
-      $stderr.puts "ERROR: #{message}"
-      # Don't call exit in unsafe mode. Raise a StandardError instead.
-      raise TjRuntimeError
-    end
-
   end
 
 end

data/lib/taskjuggler/apps/Tj3Daemon.rb

@@ -13,7 +13,7 @@
 
 require 'drb'
 require 'taskjuggler/Tj3AppBase'
-require 'taskjuggler/LogFile'
+require 'taskjuggler/MessageHandler'
 require 'taskjuggler/daemon/ProjectBroker'
 
 # Name of the application
@@ -27,14 +27,17 @@ class TaskJuggler
       super
       @mandatoryArgs = '[<tjp file> [<tji file> ...] ...]'
 
-      @log = LogFile.instance
-      @log.logFile = File.join(Dir.getwd, "/#{AppConfig.appName}.log")
-      @log.appName = AppConfig.appName
+      @mhi = MessageHandlerInstance.instance
+      @mhi.logFile = File.join(Dir.getwd, "/#{AppConfig.appName}.log")
+      @mhi.appName = AppConfig.appName
+      # By default show only warnings and more serious messages.
+      @mhi.outputLevel = :warning
       @daemonize = true
       @uriFile = File.join(Dir.getwd, '.tj3d.uri')
       @port = nil
       @webServer = false
-      @webServerPort = nil
+      @webServerPort = 8080
+      @webdPidFile = File.join(Dir.getwd, ".tj3webd-#{$$}.pid").untaint
     end
 
     def processArguments(argv)
@@ -69,33 +72,65 @@ EOT
                         'requests (Default: 8080).')) do |arg|
           @webServerPort = arg
         end
+
       end
     end
 
     def appMain(files)
-      begin
-        broker = ProjectBroker.new
-        @rc.configure(self, 'global')
-        @rc.configure(@log, 'global.log')
-        @rc.configure(broker, 'global')
-        @rc.configure(broker, 'daemon')
-
-        # Set some config variables if corresponding data was provided via the
-        # command line.
-        broker.port = @port if @port
-        broker.uriFile = @uriFile.untaint
-        broker.enableWebServer = @webServer
-        broker.webServerPort = @webServerPort if @webServerPort
-        broker.projectFiles = sortInputFiles(files) unless files.empty?
-        broker.daemonize = @daemonize
-        # Create log files for standard IO for each child process if the daemon
-        # is not disconnected from the terminal.
-        broker.logStdIO = !@daemonize
-
-        return broker.start
-      rescue TjRuntimeError
-        return 1
+      broker = ProjectBroker.new
+      @rc.configure(self, 'global')
+      @rc.configure(@mhi, 'global.log')
+      @rc.configure(broker, 'global')
+      @rc.configure(broker, 'daemon')
+
+      # Set some config variables if corresponding data was provided via the
+      # command line.
+      broker.port = @port if @port
+      broker.uriFile = @uriFile.untaint
+      broker.projectFiles = sortInputFiles(files) unless files.empty?
+      broker.daemonize = @daemonize
+      # Create log files for standard IO for each child process if the daemon
+      # is not disconnected from the terminal.
+      broker.logStdIO = !@daemonize
+
+      if @webServer
+        webdCommand = "tj3webd --webserver-port #{@webServerPort} " +
+                               "--pidfile #{@webdPidFile}"
+        # Also start the web server as a separate process. We keep the PID, so
+        # we can terminate that process again when we exit the daemon.
+        begin
+          `#{webdCommand}`
+        rescue
+          error('tj3webd_start_failed', "Could not start tj3webd: #{$!}")
+        end
+        info('web_server_started', "Web server started as '#{webdCommand}'")
       end
+
+      broker.start
+
+      if @webServer
+        pid = nil
+        begin
+          # Read the PID of the web server from the PID file.
+          File.open(@webdPidFile, 'r') do |f|
+            pid = f.read.to_i
+          end
+        rescue
+          warning('cannot_read_webd_pidfile',
+                  "Cannot read tj3webd PID file (#{@webdPidFile}): #{$!}")
+        end
+        # If we have started the web server, we are also trying to terminate
+        # that process again.
+        begin
+          Process.kill("TERM", pid)
+        rescue
+          warning('tj3webd_term_failed',
+                  "Could not terminate web server: #{$!}")
+        end
+        info('web_server_terminated', "Web server with PID #{pid} terminated")
+      end
+
+      0
     end
 
     private
@@ -128,11 +163,13 @@ EOT
           # .tji files are optional. But if they are specified, they must
           # always follow the master file in the list.
           if project.nil?
-            error("You must specify a '.tjp' file before the '.tji' files")
+            error('tj3d_tji_before_tjp',
+                  "You must specify a '.tjp' file before the '.tji' files")
           end
           project << file
         else
-          error("Project files must have a '.tjp' or '.tji' extension")
+          error('tj3d_no_file_Ext',
+                "Project files must have a '.tjp' or '.tji' extension")
         end
       end