taskjuggler 0.0.10 → 0.0.11

data/lib/taskjuggler/apps/Tj3Daemon.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3Daemon.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 'drb'
+require 'taskjuggler/Tj3AppBase'
+require 'taskjuggler/LogFile'
+require 'taskjuggler/daemon/ProjectBroker'
+
+# Name of the application
+AppConfig.appName = 'tj3d'
+
+class TaskJuggler
+
+  class Tj3Daemon < Tj3AppBase
+
+    def initialize
+      super
+      @mandatoryArgs = '[<tjp file> [<tji file> ...] ...]'
+
+      @log = LogFile.instance
+      @log.logFile = File.join(Dir.getwd, "/#{AppConfig.appName}.log")
+      @log.appName = AppConfig.appName
+      @daemonize = true
+      @uriFile = File.join(Dir.getwd, '.tj3d.uri')
+      @port = nil
+      @webServer = false
+      @webServerPort = nil
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+The TaskJuggler daemon can be used to quickly generate reports for a number
+of scheduled projects that are resident in memory. Once the daemon has been
+started tj3client can be used to control it.
+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 serve tj3client ' +
+                        'requests (Default: 8474).')) do |arg|
+          @port = arg
+        end
+        @opts.on('--urifile', String,
+                 format('If the port is 0, use this file to store the URI ' +
+                        'of the server.')) do |arg|
+          @uriFile = arg
+        end
+        @opts.on('-w', '--webserver',
+                 format('Start a web server that serves the reports of ' +
+                        'the loaded projects.')) do
+          @webServer = true
+        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 main(argv = ARGV)
+      files = super
+      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
+
+      broker.start
+    end
+
+    private
+
+    # Sort the provided input files into groups of projects. Each *.tjp file
+    # starts a new project. A *.tjp file may be followed by any number of
+    # *.tji files. The result is an Array of projects. Each consists of an
+    # Array like this: [ <working directory>, <tjp file> (, <tji file> ...) ].
+    def sortInputFiles(files)
+      projects = []
+      project = nil
+      files.each do |file|
+        if file[-4..-1] == '.tjp'
+          # The project master file determines the working directory. If it's
+          # an absolute file name, that directory will become the working
+          # directory. If it's a relative file name, the current working
+          # directory will be kept.
+          if file[0] == '/'
+            # Absolute file name
+            workingDir = File.dirname(file)
+            fileName = File.basename(file)
+          else
+            # Relative file name
+            workingDir = Dir.getwd
+            fileName = file
+          end
+          project = [ workingDir, fileName ]
+          projects << project
+        elsif file[-4..-1] == '.tji'
+          # .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")
+          end
+          project << file
+        else
+          error("Project files must have a '.tjp' or '.tji' extension")
+        end
+      end
+
+      projects
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/apps/Tj3SsReceiver.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3SsReiver.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 'taskjuggler/Tj3SheetAppBase'
+require 'taskjuggler/StatusSheetReceiver'
+
+# Name of the application
+AppConfig.appName = 'tj3ss_receiver'
+
+class TaskJuggler
+
+  class Tj3SsReceiver < Tj3SheetAppBase
+
+    def initialize
+      super
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+This program can be used to receive filled-out status sheets via email.
+It reads the emails from STDIN and extracts the status sheet from the
+attached files. The status sheet is checked for correctness. Good status
+sheets are filed away. The sender be informed by email that the status
+sheets was accepted or rejected.
+EOT
+      end
+    end
+
+    def main(argv = ARGV)
+      super
+      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
+
+end
+

data/lib/taskjuggler/apps/Tj3SsSender.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3SsSender.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.
+#
+
+# This script is used to send out the time sheet templates to the employees.
+# It should be run from a cron job once a week.
+
+require 'taskjuggler/Tj3SheetAppBase'
+require 'taskjuggler/StatusSheetSender'
+
+# Name of the application
+AppConfig.appName = 'tj3ss_sender'
+
+class TaskJuggler
+
+  class Tj3SsSender < Tj3SheetAppBase
+
+    def initialize
+      super
+      @optsSummaryWidth = 25
+      @force = false
+      @intervalDuration = nil
+
+      @hideResource = nil
+      # The default report period end is next Wednesday 0:00.
+      @date = TjTime.new.nextDayOfWeek(3).to_s('%Y-%m-%d')
+      @resourceList = []
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+This program can be used to out status sheets templates via email. It will
+generate status sheet templates for managers of the project. The project data
+will be accesses via tj3client from a running TaskJuggler server process.
+EOT
+        @opts.on('-r', '--resource <ID>', String,
+                 format('Only generate template for given resource')) do |arg|
+          @resourceList << arg
+        end
+        @opts.on('-f', '--force',
+                format('Send out a new template even if one exists ' +
+                       'already')) do |arg|
+          @force = true
+        end
+        @opts.on('--hideresource <EXPR>', String,
+                 format('Filter expression to limit the resource list')) do |arg|
+          @hideResource = arg
+        end
+        @opts.on('-i', '--interval <DURATION>', String,
+                 format('The duration of the interval. This is a number ' +
+                        'directly followed by a unit. 1w means one week ' +
+                        '(the default), 5d means 5 days and 72h means 72 ' +
+                        'hours.')) do |arg|
+          @intervalDuration = arg
+        end
+        optsEndDate
+      end
+    end
+
+    def main(argv = ARGV)
+      super
+      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)
+      0
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/apps/Tj3TsReceiver.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3TsReceiver.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.
+#
+
+# This script is used to send out the time sheet templates to the employees.
+# It should be run from a cron job once a week.
+
+require 'taskjuggler/Tj3SheetAppBase'
+require 'taskjuggler/TimeSheetReceiver'
+
+# Name of the application suite
+AppConfig.appName = 'tj3ts_receiver'
+
+class TaskJuggler
+
+  class Tj3TsReceiver < Tj3SheetAppBase
+
+    def initialize
+      super
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+This program can be used to receive filled-out time sheets via email.  It
+reads the emails from STDIN and extracts the time sheet from the attached
+files. The time sheet is checked for correctness. Good time sheets are filed
+away. The sender will be informed by email that the time sheets was accepted
+or rejected.
+EOT
+      end
+    end
+
+    def main(argv = ARGV)
+      super
+      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
+
+end
+

data/lib/taskjuggler/apps/Tj3TsSender.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3TsSender.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.
+#
+
+# This script is used to send out the time sheet templates to the employees.
+# It should be run from a cron job once a week.
+
+require 'taskjuggler/Tj3SheetAppBase'
+require 'taskjuggler/TimeSheetSender'
+
+# Name of the application suite
+AppConfig.appName = 'tj3ts_sender'
+
+class TaskJuggler
+
+  class Tj3TsSender < Tj3SheetAppBase
+
+    def initialize
+      super
+      @optsSummaryWidth = 22
+      @force = false
+      @intervalDuration = nil
+
+      # The default report period end is next Monday 0:00.
+      @date = TjTime.new.nextDayOfWeek(1).to_s('%Y-%m-%d')
+      @resourceList = []
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+This program can be used to send out time sheets templates via email. It will
+generate time sheet templates for all resources of the project. The project
+data will be accesses via tj3client from a running TaskJuggler server process.
+EOT
+        @opts.on('-r', '--resource <ID>', String,
+                format('Only generate template for given resource')) do |arg|
+          @resourceList << arg
+        end
+        @opts.on('-f', '--force',
+                format('Send out a new template even if one exists ' +
+                       'already')) do |arg|
+          @force = true
+        end
+        optsEndDate
+      end
+    end
+
+    def main(argv = ARGV)
+      super
+      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)
+      0
+    end
+
+  end
+
+end
+

data/lib/taskjuggler/apps/Tj3TsSummary.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = Tj3TsSummary.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.
+#
+
+# This script is used to send out the time sheet templates to the employees.
+# It should be run from a cron job once a week.
+
+require 'taskjuggler/Tj3SheetAppBase'
+require 'taskjuggler/TimeSheetSummary'
+
+# Name of the application
+AppConfig.appName = 'tj3ts_summary'
+
+class TaskJuggler
+
+  class Tj3TsSummary < Tj3SheetAppBase
+
+    def initialize
+      super
+
+      # The default report period end is next Monday 0:00.
+      @date = TjTime.new.nextDayOfWeek(1).to_s('%Y-%m-%d')
+      @resourceList = []
+      @sheetRecipients = []
+      @digestRecipients = []
+    end
+
+    def processArguments(argv)
+      super do
+        @opts.banner += <<'EOT'
+This program can be used to send out individual copies and a summary of all
+accepted time sheets a list of email addresses. The directory structures for
+templates and submitted time sheets must be present. The project data will be
+accesses via tj3client from a running TaskJuggler server process.
+EOT
+        @opts.on('-r', '--resource <ID>', String,
+                 format('Only generate summary for given resource')) do |arg|
+          @resourceList << arg
+        end
+        @opts.on('-t', '--to <EMAIL>', String,
+                 format('Send all individual reports and a summary report ' +
+                        'to this email address')) do |arg|
+          @sheetRecipients << arg
+          @digestRecipients << arg
+        end
+        @opts.on('--sheet <EMAIL>', String,
+                 format('Send all reports to this email address')) do |arg|
+          @sheetRecipients << arg
+        end
+        @opts.on('--digest <EMAIL>', String,
+                 format('Send a summary report to this email address')) do |arg|
+          @digestRecipients << arg
+        end
+        optsEndDate
+      end
+    end
+
+    def main(argv = ARGV)
+      super
+      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)
+      0
+    end
+
+  end
+
+end
+