taskjuggler 3.3.0 → 3.4.0

data/lib/taskjuggler/daemon/ReportServer.rb

@@ -179,10 +179,13 @@ class TaskJuggler
       Thread.new do
         loop do
           if TjTime.new - @lastPing > 120
-            error('ps_heartbeat_lost',
-                  "Report server (Project #{@tj.project['projectid']} " +
-                  "report #{@reportId}) lost heartbeat " +
-                  'from ProjectServer. Terminating.')
+            # Since the abort via error() is not thread safe, we issue a
+            # warning and abort manually.
+            warning('ps_heartbeat_lost',
+                    "Report server (Project #{@tj.project['projectid']} " +
+                    "report #{@reportId}) lost heartbeat " +
+                    'from ProjectServer. Terminating.')
+            exit 1
           end
           sleep 30
         end

data/lib/taskjuggler/reports/AccountListRE.rb

@@ -27,6 +27,8 @@ class TaskJuggler
     def initialize(report)
       super
       @table = ReportTable.new
+      @table.selfcontained = report.get('selfcontained')
+      @table.auxDir = report.get('auxdir')
     end
 
     # Generate the table in the intermediate format.

data/lib/taskjuggler/reports/CSVFile.rb

@@ -27,9 +27,11 @@ class TaskJuggler
     # +separator+ and a +quote+ string for the CSV file.
     def initialize(data = nil, separator = ';', quote = '"')
       @data = data
-      raise "Illegal separator: #{separator}" if '."'.include?(separator)
+      if !separator.nil? && '."'.include?(separator)
+        raise "Illegal separator: #{separator}"
+      end
       @separator = separator
-      raise "Illegal quote: #{separator}" if quote == '.'
+      raise "Illegal quote: #{quote}" if quote == '.'
       @quote = quote
     end
 
@@ -64,6 +66,8 @@ class TaskJuggler
 
     # Convert the CSV data into a CSV formatted String.
     def to_s
+      raise "No seperator defined." if @separator.nil?
+
       s = ''
       @data.each do |line|
         first = true
@@ -90,6 +94,9 @@ class TaskJuggler
       # Make sure the input is terminated with a record end.
       str += "\n" unless str[-1] == ?\n
 
+      # If the user hasn't defined a separator, we try to detect it.
+      @separator = detectSeparator(str) unless @separator
+
       line = 1
       str.each_utf8_char do |c|
         #puts "c: #{c}  State: #{state}"
@@ -232,6 +239,21 @@ class TaskJuggler
       end
     end
 
+    def detectSeparator(str)
+      # Pick the separator that was found the most.
+      best = nil
+      bestCount = 0
+
+      "\t;:".each_char do |c|
+        if best.nil? || str.count(c) > bestCount
+          best = c
+          bestCount = str.count(c)
+        end
+      end
+
+      return best
+    end
+
   end
 
 end

data/lib/taskjuggler/reports/GanttChart.rb

@@ -43,11 +43,12 @@ class TaskJuggler
     # is the date that should be used as current date. _weekStartsMonday_ is
     # true if the weeks should start on Mondays instead of Sundays. _table_ is a
     # reference to the TableReport that the chart is part of.
-    def initialize(now, weekStartsMonday, table = nil)
+    def initialize(now, weekStartsMonday, columnDef, table = nil)
       # The start and end dates of the reported interval.
       @start = nil
       @end = nil
       @now = now
+      @columnDef = columnDef
       @table = table
 
       # This defines the possible horizontal scales that the Gantt chart can
@@ -135,7 +136,7 @@ class TaskJuggler
       steps = @start.send(@scale['stepsToFunc'], @end)
       @width = @stepSize * steps
 
-      @header = GanttHeader.new(self)
+      @header = GanttHeader.new(@columnDef, self)
     end
 
     # Convert the chart into an HTML representation.

data/lib/taskjuggler/reports/GanttHeader.rb

@@ -25,7 +25,8 @@ class TaskJuggler
     attr_accessor :height
 
     # Create a GanttHeader object and generate the scales for the header.
-    def initialize(chart)
+    def initialize(columnDef, chart)
+      @columnDef = columnDef
       @chart = chart
 
       @largeScale = []
@@ -70,29 +71,32 @@ class TaskJuggler
       case @chart.scale['name']
       when 'hour'
         genHeaderScale(@largeScale, 0, h, :midnight, :sameTimeNextDay,
-                       :weekdayAndDate)
+                       @columnDef.timeformat1 || '%A %Y-%m-%d')
         genHeaderScale(@smallScale, h + 1, h, :beginOfHour, :sameTimeNextHour,
-                       :hour)
+                       @columnDef.timeformat2 || '%H')
       when 'day'
         genHeaderScale(@largeScale, 0, h, :beginOfMonth, :sameTimeNextMonth,
-                       :monthAndYear)
-        genHeaderScale(@smallScale, h + 1, h, :midnight, :sameTimeNextDay, :day)
+                       @columnDef.timeformat1 || '%b %Y')
+        genHeaderScale(@smallScale, h + 1, h, :midnight, :sameTimeNextDay,
+                       @columnDef.timeformat2 || '%d')
       when 'week'
         genHeaderScale(@largeScale, 0, h, :beginOfMonth, :sameTimeNextMonth,
-                       :monthAndYear)
+                       @columnDef.timeformat1 || '%b %Y')
         genHeaderScale(@smallScale, h + 1, h, :beginOfWeek, :sameTimeNextWeek,
-                       :week)
+                       @columnDef.timeformat2 || '%d')
       when 'month'
-        genHeaderScale(@largeScale, 0, h, :beginOfYear, :sameTimeNextYear, :year)
+        genHeaderScale(@largeScale, 0, h, :beginOfYear, :sameTimeNextYear,
+                       @columnDef.timeformat1 || '%Y')
         genHeaderScale(@smallScale, h + 1, h, :beginOfMonth, :sameTimeNextMonth,
-                       :shortMonthName)
+                       @columnDef.timeformat2 || '%b')
       when 'quarter'
-        genHeaderScale(@largeScale, 0, h, :beginOfYear, :sameTimeNextYear, :year)
+        genHeaderScale(@largeScale, 0, h, :beginOfYear, :sameTimeNextYear,
+                       @columnDef.timeformat1 || '%Y')
         genHeaderScale(@smallScale, h + 1, h, :beginOfQuarter,
-                       :sameTimeNextQuarter, :quarterName)
+                       :sameTimeNextQuarter, @columnDef.timeformat2 || 'Q%Q')
       when 'year'
         genHeaderScale(@smallScale, h + 1, h, :beginOfYear, :sameTimeNextYear,
-                       :year)
+                       @columnDef.timeformat1 || '%Y')
       else
         raise "Unknown scale: #{@chart.scale['name']}"
       end
@@ -102,7 +106,7 @@ class TaskJuggler
     end
 
     # Generate the actual scale cells.
-    def genHeaderScale(scale, y, h, beginOfFunc, sameTimeNextFunc, nameFunc)
+    def genHeaderScale(scale, y, h, beginOfFunc, sameTimeNextFunc, timeformat)
       # The beginOfWeek function needs a parameter, so we have to handle it as a
       # special case.
       if beginOfFunc == :beginOfWeek
@@ -125,11 +129,7 @@ class TaskJuggler
         else
           @cellStartDates << t
         end
-        # Again, nameFunc needs special handling for the week case due to the
-        # extra parameter.
-        name = nameFunc == :week ? t.send(nameFunc, @chart.weekStartsMonday) :
-                                   t.send(nameFunc)
-        scale << GanttHeaderScaleItem.new(name, x, y, w, h)
+        scale << GanttHeaderScaleItem.new(t.to_s(timeformat), x, y, w, h)
         t = nextT
       end
       # Add the end date of the last cell when generating the small scale.

data/lib/taskjuggler/reports/GanttLoadStack.rb

@@ -30,7 +30,7 @@ class TaskJuggler
       @lineHeight = line.height
       @x = x
       @y = @line.y
-      @w = w
+      @w = w <= 0 ? 1 : w
       @drawFrame = false
       if values.length != categories.length
         raise "Values and categories must have the same number of entries!"

data/lib/taskjuggler/reports/MspXmlRE.rb

@@ -25,7 +25,11 @@ class TaskJuggler
     # Create a new object and set some default values.
     def initialize(report)
       super(report)
-      @scenarioIdx = 0
+
+      # This report type currently only supports a single scenario. Use the
+      # first specified one.
+      @scenarioIdx = a('scenarios').first
+
       # Hash to map calendar names to UIDs (numbers).
       @calendarUIDs = {}
       @timeformat = "%Y-%m-%dT%H:%M:%S"

data/lib/taskjuggler/reports/Report.rb

@@ -78,7 +78,7 @@ class TaskJuggler
         if @name.empty?
           error('empty_report_file_name',
                 "Report #{@id} has output formats requested, but the " +
-                "file name is empty.")
+                "file name is empty.", sourceFileInfo)
         end
 
         case format
@@ -179,8 +179,10 @@ class TaskJuggler
 
       html = HTMLDocument.new
       head = html.generateHead(@project['name'] + " - #{get('title') || @name}",
-                               'description' => 'TaskJuggler Report',
-                               'keywords' => 'taskjuggler, project, management')
+                               { 'description' => 'TaskJuggler Report',
+                                 'keywords' =>
+                                   'taskjuggler, project, management' },
+                               a('rawHtmlHead'))
       if a('selfcontained')
         auxSrcDir = AppConfig.dataDirs('data/css')[0]
         cssFileName = (auxSrcDir ? auxSrcDir + '/tjreport.css' : '')
@@ -192,7 +194,7 @@ class TaskJuggler
         if cssFile.empty?
           error('css_file_error',
                 "Cannot read '#{cssFileName}'. Make sure the file is not " +
-                "empty and you have read access permission.")
+                "empty and you have read access permission.", sourceFileInfo)
         end
         head << XMLElement.new('meta', 'http-equiv' => 'Content-Style-Type',
                                'content' => 'text/css; charset=utf-8')
@@ -201,7 +203,7 @@ class TaskJuggler
       else
         head << XMLElement.new('link', 'rel' => 'stylesheet',
                                'type' => 'text/css',
-                               'href' => 'css/tjreport.css')
+                               'href' => "#{a('auxdir')}css/tjreport.css")
       end
       html.html <<
         XMLComment.new("Dynamic Report ID: " +
@@ -210,7 +212,7 @@ class TaskJuggler
 
       unless a('selfcontained')
         body << XMLElement.new('script', 'type' => 'text/javascript',
-                               'src' => 'scripts/wz_tooltip.js')
+                               'src' => "#{a('auxdir')}scripts/wz_tooltip.js")
         body << (noscript = XMLElement.new('noscript'))
         noscript << (nsdiv = XMLElement.new('div',
                                             'style' => 'text-align:center; ' +
@@ -252,7 +254,8 @@ EOT
       begin
         html.write(fileName)
       rescue IOError, SystemCallError
-        error('write_html', "Cannot write to file #{fileName}.\n#{$!}")
+        error('write_html', "Cannot write to file #{fileName}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -278,7 +281,8 @@ EOT
                                   @name + '.csv').untaint
         CSVFile.new(csv, ';').write(fileName)
       rescue IOError, SystemCallError
-        error('write_csv', "Cannot write to file #{fileName}.\n#{$!}")
+        error('write_csv', "Cannot write to file #{fileName}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -302,7 +306,8 @@ EOT
           File.open(fileName, 'w') { |f| f.write(@content.to_tjp) }
         end
       rescue IOError, SystemCallError
-        error('write_tjp', "Cannot write to file #{fileName}.\n#{$!}")
+        error('write_tjp', "Cannot write to file #{fileName}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -325,7 +330,8 @@ EOT
           File.open(fileName, 'w') { |f| f.write(@content.to_mspxml) }
         end
       rescue IOError, SystemCallError
-        error('write_mspxml', "Cannot write to file #{fileName}.\n#{$!}")
+        error('write_mspxml', "Cannot write to file #{fileName}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -344,7 +350,8 @@ EOT
                     @name + '.xml').untaint, 'w')
         f.puts "#{@content.to_niku}"
       rescue IOError, SystemCallError
-        error('write_niku', "Cannot write to file #{@name}.\n#{$!}")
+        error('write_niku', "Cannot write to file #{@name}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -363,7 +370,8 @@ EOT
                     @name + '.ics').untaint, 'w')
         f.puts "#{@content.to_iCal}"
       rescue IOError, SystemCallError
-        error('write_ical', "Cannot write to file #{@name}.\n#{$!}")
+        error('write_ical', "Cannot write to file #{@name}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
@@ -382,13 +390,15 @@ EOT
                     @name).untaint, 'w')
         f.puts "#{@content.to_ctags}"
       rescue IOError, SystemCallError
-        error('write_ctags', "Cannot write to file #{@name}.\n#{$!}")
+        error('write_ctags', "Cannot write to file #{@name}.\n#{$!}",
+              sourceFileInfo)
       end
     end
 
     def copyAuxiliaryFiles
-      # Don't copy files if output is stdout.
-      return if @name == '.' || a('interactive')
+      # Don't copy files if output is stdout, the requested by the web server
+      # or the user has specified a custom aux directory.
+      return if @name == '.' || a('interactive') || !a('auxdir').empty?
 
       copyDirectory('css')
       copyDirectory('icons')
@@ -413,7 +423,7 @@ EOT
         FileUtils.cp_r(auxSrcDir, auxDstDir)
       rescue IOError, SystemCallError
         error('copy_dir', "Cannot copy directory #{auxSrcDir} to " +
-                          "#{auxDstDir}.\n#{$!}")
+                          "#{auxDstDir}.\n#{$!}", sourceFileInfo)
       end
     end
 
@@ -432,7 +442,7 @@ EOT
     end
 
     def dataDirError(dirName, dirs)
-      error('data_dir_error', <<"EOT"
+      error('data_dir_error', <<"EOT",
 Cannot find the #{dirName} directory. This is usually the result of an
 improper TaskJuggler installation. If you know the directory, you can use the
 TASKJUGGLER_DATA_PATH environment variable to specify the location.  The
@@ -442,6 +452,7 @@ tried:
 
 #{dirs.join("\n")}
 EOT
+            sourceFileInfo
            )
     end
 
@@ -449,7 +460,7 @@ EOT
       if name =~ /[\\?%*:|"<>]/
         error('invalid_file_name',
               'File names may not contain any of the following characters: ' +
-              '\?%*:|\"<>')
+              '\?%*:|\"<>', sourceFileInfo)
       end
     end
 

data/lib/taskjuggler/reports/ReportTable.rb

@@ -27,7 +27,7 @@ class TaskJuggler
     SCROLLBARHEIGHT = 20
 
     attr_reader :maxIndent, :headerLineHeight, :headerFontSize
-    attr_accessor :equiLines, :embedded
+    attr_accessor :equiLines, :embedded, :selfcontained, :auxDir
 
     # Create a new ReportTable object.
     def initialize
@@ -44,6 +44,10 @@ class TaskJuggler
       @equiLines = false
       # True if the table is embedded as a column of another ReportTable.
       @embedded = false
+      # True if the report does not rely on the data of other files.
+      @selfcontained = false
+      # Path to the auxiliary data directory.
+      @auxDir = ''
     end
 
     # This function should only be called by the ReportTableColumn constructor.

data/lib/taskjuggler/reports/ReportTableCell.rb

@@ -23,7 +23,7 @@ class TaskJuggler
     attr_reader :line
     attr_accessor :data, :category, :hidden, :alignment, :padding,
                   :text, :tooltip, :showTooltipHint,
-                  :iconTooltip, :selfcontained,
+                  :iconTooltip,
                   :cellColor, :indent, :icon, :fontSize, :fontColor,
                   :bold, :width,
                   :rows, :columns, :special
@@ -81,9 +81,6 @@ class TaskJuggler
       @rows = 1
       # The number of columns the cell spans
       @columns = 1
-      # True of the resulting report should not contain any information from
-      # other files.
-      @selfcontained = false
       # Ignore everything and use this reference to generate the output.
       @special = nil
     end
@@ -134,10 +131,11 @@ class TaskJuggler
 
       # Overwrite the tooltip if the user has specified a custom tooltip.
       tooltip = @tooltip if @tooltip
-      if tooltip && !tooltip.empty? && !@selfcontained
+      if tooltip && !tooltip.empty? && !selfcontained
         if @showTooltipHint
           row << (td = XMLElement.new('td'))
-          td << XMLElement.new('img', 'src' => 'icons/details.png',
+          td << XMLElement.new('img',
+                               'src' => "#{auxDir}icons/details.png",
                                'class' => 'tj_table_cell_tooltip')
           addHtmlTooltip(tooltip, td, cell)
         else
@@ -195,6 +193,14 @@ class TaskJuggler
 
     private
 
+    def selfcontained
+      @line && @line.table.selfcontained
+    end
+
+    def auxDir
+      @line ? @line.table.auxDir : nil
+    end
+
     def calculateIndentation
       # In tree sorting mode, some cells have to be indented to reflect the
       # tree nesting structure. The indentation is achieved with padding cells
@@ -220,9 +226,9 @@ class TaskJuggler
     end
 
     def cellIcon(cell)
-      if @icon && !@selfcontained
+      if @icon && !selfcontained
         td = XMLElement.new('td', 'class' => 'tj_table_cell_icon')
-        td << XMLElement.new('img', 'src' => "icons/#{@icon}.png",
+        td << XMLElement.new('img', 'src' => "#{auxDir}icons/#{@icon}.png",
                                     'alt' => "Icon")
         addHtmlTooltip(@iconTooltip, td, cell)
         return td
@@ -279,7 +285,7 @@ class TaskJuggler
         labelWidth = @width - 8
         labelWidth -= @leftIndent if @leftIndent
         labelWidth -= @rightIndent if @rightIndent
-        if !@selfcontained
+        if !selfcontained
           # The icons are 20 pixels width including padding.
           labelWidth -= 20 if @icon
           labelWidth -= 20 if tooltip || @tooltip
@@ -342,7 +348,7 @@ class TaskJuggler
     end
 
     def addHtmlTooltip(tooltip, trigger, hook = nil)
-      return unless tooltip && !tooltip.empty? && !@selfcontained
+      return unless tooltip && !tooltip.empty? && !selfcontained
 
       hook = trigger if hook.nil?
       if tooltip.respond_to?('functionHandler')