taskjuggler 3.1.0 → 3.2.0

data/lib/taskjuggler/apps/Tj3Man.rb

@@ -71,17 +71,17 @@ EOT
       else
         requestedKeywords.each do |keyword|
           if (kws = @keywords[keyword, true]).nil?
-            $stderr.puts "No matches found for '#{keyword}'"
-            exit 1
+            error('tj3man_no_matches', "No matches found for '#{keyword}'")
           elsif kws.length == 1 || kws.include?(keyword)
             showManual(keyword)
           else
-            $stderr.puts "Multiple matches found for '#{keyword}':\n" +
-                         "#{kws.join(', ')}"
-            return 1
+            warning('tj3man_multi_match',
+                    "Multiple matches found for '#{keyword}':\n" +
+                    "#{kws.join(', ')}")
           end
         end
       end
+
       0
     end
 

data/lib/taskjuggler/apps/Tj3SsReceiver.rb

@@ -38,19 +38,16 @@ EOT
     end
 
     def appMain(argv)
-      begin
-        ts = TaskJuggler::StatusSheetReceiver.new('tj3ss_receiver')
-        @rc.configure(ts, 'global')
-        @rc.configure(ts, 'statussheets')
-        @rc.configure(ts, 'statussheets.receiver')
-        ts.workingDir = @workingDir if @workingDir
-        ts.dryRun = @dryRun
-
-        ts.processEmail
-        return 0
-      rescue TjRuntimeError
-        return 1
-      end
+      ts = TaskJuggler::StatusSheetReceiver.new('tj3ss_receiver')
+      @rc.configure(ts, 'global')
+      @rc.configure(ts, 'statussheets')
+      @rc.configure(ts, 'statussheets.receiver')
+      ts.workingDir = @workingDir if @workingDir
+      ts.dryRun = @dryRun
+
+      ts.processEmail
+
+      0
     end
 
   end

data/lib/taskjuggler/apps/Tj3SsSender.rb

@@ -68,23 +68,20 @@ EOT
     end
 
     def appMain(argv)
-      begin
-        ts = StatusSheetSender.new('tj3ss_sender')
-        @rc.configure(ts, 'global')
-        @rc.configure(ts, 'statussheets')
-        @rc.configure(ts, 'statussheets.sender')
-        ts.workingDir = @workingDir if @workingDir
-        ts.dryRun = @dryRun
-        ts.force = @force
-        ts.intervalDuration = @intervalDuration if @intervalDuration
-        ts.date = @date if @date
-        ts.hideResource = @hideResource if @hideResource
+      ts = StatusSheetSender.new('tj3ss_sender')
+      @rc.configure(ts, 'global')
+      @rc.configure(ts, 'statussheets')
+      @rc.configure(ts, 'statussheets.sender')
+      ts.workingDir = @workingDir if @workingDir
+      ts.dryRun = @dryRun
+      ts.force = @force
+      ts.intervalDuration = @intervalDuration if @intervalDuration
+      ts.date = @date if @date
+      ts.hideResource = @hideResource if @hideResource
 
-        ts.sendTemplates(@resourceList)
-        return 0
-      rescue TjRuntimeError
-        return 1
-      end
+      ts.sendTemplates(@resourceList)
+
+      0
     end
 
   end

data/lib/taskjuggler/apps/Tj3TsReceiver.rb

@@ -41,19 +41,16 @@ EOT
     end
 
     def appMain(argv)
-      begin
-        ts = TimeSheetReceiver.new('tj3ts_receiver')
-        @rc.configure(ts, 'global')
-        @rc.configure(ts, 'timesheets')
-        @rc.configure(ts, 'timesheets.receiver')
-        ts.workingDir = @workingDir if @workingDir
-        ts.dryRun = @dryRun
-
-        ts.processEmail
-        return 0
-      rescue TjRuntimeError
-        return 1
-      end
+      ts = TimeSheetReceiver.new('tj3ts_receiver')
+      @rc.configure(ts, 'global')
+      @rc.configure(ts, 'timesheets')
+      @rc.configure(ts, 'timesheets.receiver')
+      ts.workingDir = @workingDir if @workingDir
+      ts.dryRun = @dryRun
+
+      ts.processEmail
+
+      0
     end
 
   end

data/lib/taskjuggler/apps/Tj3TsSender.rb

@@ -56,22 +56,19 @@ EOT
     end
 
     def appMain(argv)
-      begin
-        ts = TimeSheetSender.new('tj3ts_sender')
-        @rc.configure(ts, 'global')
-        @rc.configure(ts, 'timesheets')
-        @rc.configure(ts, 'timesheets.sender')
-        ts.workingDir = @workingDir if @workingDir
-        ts.dryRun = @dryRun
-        ts.force = @force
-        ts.intervalDuration = @intervalDuration if @intervalDuration
-        ts.date = @date if @date
+      ts = TimeSheetSender.new('tj3ts_sender')
+      @rc.configure(ts, 'global')
+      @rc.configure(ts, 'timesheets')
+      @rc.configure(ts, 'timesheets.sender')
+      ts.workingDir = @workingDir if @workingDir
+      ts.dryRun = @dryRun
+      ts.force = @force
+      ts.intervalDuration = @intervalDuration if @intervalDuration
+      ts.date = @date if @date
 
-        ts.sendTemplates(@resourceList)
-        return 0
-      rescue
-        return 1
-      end
+      ts.sendTemplates(@resourceList)
+
+      0
     end
 
   end

data/lib/taskjuggler/apps/Tj3TsSummary.rb

@@ -65,22 +65,19 @@ EOT
     end
 
     def appMain(argv)
-      begin
-        ts = TimeSheetSummary.new
-        @rc.configure(ts, 'global')
-        @rc.configure(ts, 'timesheets')
-        @rc.configure(ts, 'timesheets.summary')
-        ts.workingDir = @workingDir if @workingDir
-        ts.dryRun = @dryRun
-        ts.date = @date if @date
-        ts.sheetRecipients += @sheetRecipients
-        ts.digestRecipients += @digestRecipients
+      ts = TimeSheetSummary.new
+      @rc.configure(ts, 'global')
+      @rc.configure(ts, 'timesheets')
+      @rc.configure(ts, 'timesheets.summary')
+      ts.workingDir = @workingDir if @workingDir
+      ts.dryRun = @dryRun
+      ts.date = @date if @date
+      ts.sheetRecipients += @sheetRecipients
+      ts.digestRecipients += @digestRecipients
 
-        ts.sendSummary(@resourceList)
-        return 0
-      rescue TjRuntimeError
-        return 1
-      end
+      ts.sendSummary(@resourceList)
+
+      0
     end
 
   end

data/lib/taskjuggler/apps/Tj3WebD.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3Daemon.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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 'drb'
+require 'taskjuggler/Tj3AppBase'
+require 'taskjuggler/MessageHandler'
+require 'taskjuggler/daemon/WebServer'
+
+# Name of the application
+AppConfig.appName = 'tj3webd'
+
+class TaskJuggler
+
+  class Tj3WebD < Tj3AppBase
+
+    def initialize
+      super
+
+      @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
+      @webServerPort = nil
+      @pidFile = nil
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+The TaskJuggler web server can be used to serve the HTTP reports of
+TaskJuggler projects to be viewed by any HTML5 compliant web browser. It uses
+the TaskJuggler daemon (tj3d) for data hosting and report generation.
+EOT
+        @opts.on('-d', '--dont-daemonize',
+                 format("Don't put program into daemon mode. Keep it " +
+                        'connected to the terminal and show debug output.')) do
+          @daemonize = false
+        end
+        @opts.on('-p', '--port <NUMBER>', Integer,
+                 format('Use the specified TCP/IP port to connect to the ' +
+                        'TaskJuggler daemon (Default: 8474).')) do |arg|
+          @port = arg
+        end
+        @opts.on('--pidfile <FILE NAME>', String,
+                 format('Write the process ID of the daemon to the ' +
+                        'specified file.')) do |arg|
+          @pidFile = arg
+        end
+        @opts.on('--urifile', String,
+                 format('If the port is 0, use this file to read the URI ' +
+                        'of the TaskJuggler daemon.')) do |arg|
+          @uriFile = arg
+        end
+        @opts.on('--webserver-port <NUMBER>', Integer,
+                 format('Use the specified TCP/IP port to serve web browser ' +
+                        'requests (Default: 8080).')) do |arg|
+          @webServerPort = arg
+        end
+      end
+    end
+
+    def appMain(files)
+      @rc.configure(self, 'global')
+      @rc.configure(@mhi, 'global.log')
+      webServer = WebServer.new
+      @rc.configure(webServer, 'global')
+      @rc.configure(webServer, 'webd')
+
+      # Set some config variables if corresponding data was provided via the
+      # command line.
+      webServer.port = @port if @port
+      webServer.uriFile = @uriFile.untaint
+      webServer.webServerPort = @webServerPort if @webServerPort
+      webServer.daemonize = @daemonize
+      webServer.pidFile = @pidFile
+      debug('', "pidFile 1: #{@pidFile}")
+
+      webServer.start
+      0
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/daemon/Daemon.rb

@@ -11,7 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'taskjuggler/LogFile'
+require 'taskjuggler/MessageHandler'
 
 class TaskJuggler
 
@@ -20,27 +20,29 @@ class TaskJuggler
   # this class and call the start() method.
   class Daemon
 
-    attr_accessor :daemonize
-    attr_reader :log
+    include MessageHandler
+
+    attr_accessor :pidFile, :daemonize
 
     def initialize
       # You can set this flag to false to prevent the program from
       # disconnecting from the current terminal. This is useful for debugging
       # purposes.
       @daemonize = true
-      @log = LogFile.instance
+      # Save the PID of the running daemon as number into this file.
+      @pidFile = nil
     end
 
     # Call this method to turn the process into a background process.
     def start
-      return unless @daemonize
+      return 0 unless @daemonize
 
       # Fork and have the parent exit
       if (pid = fork) == -1
-        @log.fatal('First fork failed')
+        fatal('first_fork_failed', 'First fork failed')
       elsif !pid.nil?
         # This is the parent. We can exit now.
-        @log.debug("Forked a child process with PID #{pid}")
+        debug('', "Forked a child process with PID #{pid}")
         exit! 0
       end
 
@@ -48,15 +50,17 @@ class TaskJuggler
       Process.setsid
       # Fork again to make sure we lose the controlling terminal
       if (pid = fork) == -1
-        @log.fatal('Second fork failed')
+        fatal('second_fork_failed', 'Second fork failed')
       elsif !pid.nil?
         # This is the parent. We can exit now.
-        @log.debug("Forked a child process with PID #{pid}")
+        debug('', "Forked a child process with PID #{pid}")
         exit! 0
       end
 
       @pid = Process.pid
 
+      writePidFile
+
       # Change current working directory to the file system root
       Dir.chdir '/'
       # Make sure we can create files with any permission
@@ -67,13 +71,49 @@ class TaskJuggler
       $stdout.reopen('/dev/null', 'a')
       $stderr.reopen($stdout)
 
-      @log.info("The process is running as daemon now with PID #{@pid}")
+      info('daemon_pid',
+           "The process is running as daemon now with PID #{@pid}")
+
       0
     end
 
     # This method may provide some cleanup functionality in the future. You
     # better call it before you exit.
     def stop
+      if @pidFile
+        begin
+          File.delete(@pidFile)
+        rescue
+          warning('cannot_delete_pidfile',
+                  "Cannote delete the PID file (#{@pidFile}): #{$!}")
+        end
+        info('daemon_deleted_pidfile', "PID file #{@pidFile} deleted")
+      end
+    end
+
+    private
+
+    def writePidFile
+      if @pidFile
+        # Prepend the current working dir to @pidFile unless it's already an
+        # absolute path. The working dir is changed to '/' later. We need the
+        # absolute name to be able to delete it on exit again.
+        if @pidFile[0] != '/'
+          @pidFile = File.join(Dir.getwd, @pidFile)
+        end
+
+        # If requested, write the PID of the daemon to the specified file.
+        begin
+          File.open(@pidFile, 'w') do |f|
+            f.puts @pid
+          end
+        rescue
+          warning('cannot_save_pidfile', "Cannot write PID to #{@pidFile}")
+        end
+        info('daemon_wrote_pidfile',
+             "PID file #{@pidFile} written with PID #{@pid}")
+      end
+
     end
 
   end

data/lib/taskjuggler/daemon/DaemonConnector.rb

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = DaemonConnector.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012
+#               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 'drb'
+require 'drb/acl'
+require 'taskjuggler/MessageHandler'
+
+class TaskJuggler
+
+  module DaemonConnectorMixin
+
+    include MessageHandler
+
+    def connectDaemon
+      unless @authKey
+        error('missing_auth_key', <<'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('tjc_port_0',
+                'The server port is configured to be 0, but no ' +
+                ".tj3d.uri file can be found: #{$!}")
+        end
+      end
+      debug('', "DRb URI determined as #{uri}")
+
+      # 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')
+      debug('', 'DRb service started')
+
+      broker = nil
+      begin
+        # Get the ProjectBroker object from the tj3d.
+        broker = DRbObject.new_with_uri(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('tjc_too_old',
+                'This client is too old for the server. Please ' +
+                'upgrade to a more recent version of the software.')
+        elsif check == 0
+          error('tjc_auth_fail',
+                'Authentication failed. Please check your authentication ' +
+                'key to match the server key.')
+        end
+        debug('', "Connection with report broker on #{uri} established")
+      rescue => e
+        # If we ended up here due to a previously reported TjRuntimeError, we
+        # just pass it through.
+        if e.is_a?(TjRuntimeError)
+          raise TjRuntimeError, $!
+        end
+        error('tjc_srv_not_responding',
+              "TaskJuggler server (tj3d) on URI '#{uri}' is not " +
+              "responding:\n#{$!}")
+      end
+
+      broker
+    end
+
+    def disconnectDaemon
+      DRb.stop_service
+    end
+
+  end
+
+  class DaemonConnector
+
+    include DaemonConnectorMixin
+
+    def initialize(authKey, host, port, uri)
+      @authKey = authKey
+      @host = host
+      @port = port
+      @uri = uri
+      @unsafeMode = true
+
+      @broker = connectDaemon
+    end
+
+    def disconnect
+      disconnectDaemon
+      @broker = nil
+    end
+
+    def getProject(projectId)
+      @broker.getProject(@authKey, projectId)
+    end
+
+    def getProjectList
+      @broker.getProjectList(@authKey)
+    end
+
+  end
+
+end
+