taskjuggler 0.0.3 → 0.0.4

data/lib/reports/GanttLoadStack.rb

@@ -3,7 +3,7 @@
 #
 # = GanttLoadStack.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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/reports/GanttMilestone.rb

@@ -3,7 +3,7 @@
 #
 # = GanttMilestone.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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/reports/GanttRouter.rb

@@ -3,7 +3,7 @@
 #
 # = GanttRouter.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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/reports/GanttTaskBar.rb

@@ -3,7 +3,7 @@
 #
 # = GanttTaskBar.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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/reports/HTMLGraphics.rb

@@ -3,7 +3,7 @@
 #
 # = HTMLGraphics.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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/reports/Navigator.rb

@@ -3,7 +3,7 @@
 #
 # = Navigator.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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
@@ -14,43 +14,155 @@ require 'reports/ReportContext'
 
 class TaskJuggler
 
+  class NavigatorElement
+
+    attr_reader :parent, :label
+    attr_accessor :url, :elements, :current
+
+    def initialize(parent, label = nil, url = nil)
+      @parent = parent
+      @label = label
+      @url = url
+      @elements = []
+      # True if the current report is included in this NavigatorElement or any
+      # of its sub elements.
+      @current = false
+    end
+
+    def to_html
+      first = true
+      html = (div = XMLElement.new('div'))
+
+      @elements.each do |element|
+        next unless label
+
+        if first
+          first = false
+        else
+          div << XMLText.new('|')
+        end
+
+        url = element.url
+        if !url
+          nEl = element
+          while nEl.elements[0]
+            break if nEl.current
+
+            if nEl.elements[0].url
+              url = nEl.elements[0].url
+              break
+            end
+            nEl = nEl.elements[0]
+          end
+        end
+        if url && url != currentUrl
+          div << (span = XMLElement.new('span', 'class' => 'navbar_other'))
+          span << (a = XMLElement.new('a', 'href' => url))
+          a << XMLText.new(element.label)
+        else
+          div << (span = XMLElement.new('span',
+                                        'class' => 'navbar_current'))
+          span << XMLText.new(element.label)
+        end
+      end
+      @elements.each do |element|
+        if element.current && !element.elements.empty?
+          html << XMLElement.new('hr') unless first
+          html << element.to_html
+        end
+      end
+      html
+    end
+
+    # Return a text version of the tree. Currently used for debugging only.
+    def to_s(indent = 0)
+      @elements.each do |element|
+        puts "#{' ' * indent}#{element.current ? '<' : ''}" +
+             "#{element.label}#{element.current ? '>' : ''}" +
+             " -> #{element.url}"
+        element.to_s(indent + 1)
+      end
+    end
+
+    # Store the URL for the current report. Since the URL entry in the root
+    # node of the NavigatorElement tree is never used, we use it to store the
+    # current URL there.
+    def currentUrl=(url)
+      root.url = url
+    end
+
+    # Get the URL of the current report from the root node.
+    def currentUrl
+      root.url
+    end
+
+    # Traverse the tree all the way to the top and return the root element.
+    def root
+      p = self
+      while p.parent
+        p = p.parent
+      end
+      p
+    end
+
+  end
+
+  # A Navigator is an automatically generated menu to navigate a list of
+  # reports. The hierarchical structure of the reports will be reused to
+  # group them. The actual structure of the Navigator depends on the output
+  # format.
   class Navigator
 
     attr_reader :id
-    attr_accessor :hideReport
+    attr_accessor :hideReport, :reportRoot
 
     def initialize(id, project)
       @id = id
       @project = project
       @hideReport = LogicalExpression.new(LogicalOperation.new(0))
+      @reportRoot = nil
+      @elements = []
     end
 
-    def to_html
-      reports = filterReports
-      return nil if reports.empty?
+    # Generate an output format independant version of the navigator. This is
+    # a tree of NavigatorElement objects.
+    def generate(reports, reportRoot, parentElement)
+      raise "Report context missing" unless @project.reportContext.report
 
-      first = true
-      html = []
-      html << (div = XMLElement.new('div'))
       reports.each do |report|
-        next unless report.get('formats').include?(:html)
+        hasURL = report.get('formats').include?(:html)
+        next if (report.parent != reportRoot) ||
+                (report.leaf? && !hasURL)
 
-        if first
-          first = false
-        else
-          div << XMLText.new('|')
+        label = report.get('title') || report.name
+        # Determine the URL for this element.
+        if hasURL
+          url = report.name + '.html'
+          url = normalizeURL(url, @project.reportContext.report.name)
         end
+        parentElement.elements <<
+          (element =  NavigatorElement.new(parentElement, label, url))
+
         if report == @project.reportContext.report
-          div << (span = XMLElement.new('span',
-                                         'style' => 'class:navbar_current'))
-          span << XMLText.new(report.name)
-        else
-          div << (span = XMLElement.new('span', 'style' => 'class:navbar_other'))
-          span << (a = XMLElement.new('a', 'href' => report.name + '.html'))
-          a << XMLText.new(report.name)
+          element.currentUrl = url
+          # Mark this element and all its parents as current.
+          nEl = element
+          while nEl
+            nEl.current = true
+            nEl = nEl.parent
+          end
         end
+
+        generate(reports, report, element)
       end
-      html
+    end
+
+    def to_html
+      reports = filterReports
+      return nil if reports.empty?
+
+      generate(reports, nil, content = NavigatorElement.new(nil))
+      content.to_html
     end
 
     private
@@ -60,12 +172,27 @@ class TaskJuggler
       list.setSorting([[ 'seqno', true, -1 ]])
       list.sort!
       # Remove all reports that the user doesn't want to have include.
+      query = @project.reportContext.query.dup
+      query.scopeProperty = nil
       list.delete_if do |property|
-        @hideReport.eval(property, nil)
+        query.property = property
+        @hideReport.eval(query)
       end
       list
     end
 
+    # Remove the URL or directory path from _url1_ that is identical to
+    # _url2_.
+    def normalizeURL(url1, url2)
+      cut = 0
+      0.upto(url1.length - 1) do |i|
+        return url1[cut, url1.length - cut] if url1[i] != url2[i]
+        cut = i + 1 if url1[i] == ?/
+      end
+
+      url1
+    end
+
   end
 
 end

data/lib/reports/Report.rb

@@ -3,18 +3,20 @@
 #
 # = Report.rb -- The TaskJuggler III Project Management Software
 #
-# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+# Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs@kde.org>
 #
 # 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 'fileutils'
 require 'PropertyTreeNode'
 require 'reports/TextReport'
 require 'reports/TaskListRE'
 require 'reports/ResourceListRE'
 require 'reports/TjpExportRE'
+require 'reports/TimeSheetReport'
 require 'reports/CSVFile'
 require 'reports/Navigator'
 require 'reports/ReportContext'
@@ -46,14 +48,16 @@ class TaskJuggler
       begin
         @content = nil
         case @typeSpec
-        when :export
-          # Does not have an intermediate representation. Nothing to do here.
         when :resourcereport
           @content = ResourceListRE.new(self)
         when :textreport
           @content = TextReport.new(self)
         when :taskreport
           @content = TaskListRE.new(self)
+        when :export
+          @content = TjpExportRE.new(self)
+        when :timeSheet
+          @content = TimeSheetReport.new(self)
         else
           raise "Unknown report type"
         end
@@ -67,19 +71,19 @@ class TaskJuggler
           case format
           when :html
             generateHTML
+            copyAuxiliaryFiles
           when :csv
             generateCSV
-          when :export
-            generateExport
+          when :tjp
+            generateTJP
           else
             raise 'Unknown report output format.'
           end
         end
       rescue TjException
-        @project.messageHandler.send(Message.new('reporting_failed', 'error',
-                                                 $!.message, nil, nil,
-                                                 @sourceFileInfo))
+        error('reporting_failed', $!.message)
       end
+      0
     end
 
     # Render the content of the report as HTML (without the framing).
@@ -99,176 +103,68 @@ class TaskJuggler
       html = HTMLDocument.new(:transitional)
       html << (head = XMLElement.new('head'))
       head << XMLNamedText.new("TaskJuggler Report - #{@name}", 'title')
-      head << XMLElement.new('meta', 'http-equiv' => 'Content-Style-Type',
-                             'content' => 'text/css; charset=utf-8')
-      head << (style = XMLElement.new('style', 'type' => 'text/css'))
-      style << XMLBlob.new(<<'EOT'
-  body {
-    font-family:Bitstream Vera Sans, Tahoma, sans-serif;
-    font-size:15px;
-  }
-  h1, h2, table, tr, td, div, span {
-    font-family: Bitstream Vera Sans, Tahoma, sans-serif;
-  }
-  table {
-    font-size:13px;
-  }
-  td, div { white-space:nowrap; padding:0px; margin:0px; }
-  h1 { font-size:22px; }
-  h2 { font-size:18px; }
-  h3 { font-size:16px; }
-
-  .tabback { background-color:#9a9a9a; }
-  .tabfront { background-color:#d4dde6; }
-  .tabhead {
-    white-space:nowrap;
-    background-color:#7a7a7a;
-    color:#ffffff;
-    text-align:center;
-  }
-  .tabhead_offduty {
-    white-space:nowrap;
-    background-color:#dde375;
-    color:#000000;
-  }
-  .tabfooter {
-    white-space:nowrap;
-    background-color:#9a9a9a;
-    color:#ffffff;
-    text-align:center;
-  }
-  .headercelldiv {
-    padding-top:1px;
-    padding-right:3px;
-    padding-left:3px;
-    padding-bottom:0px;
-    white-space:nowrap;
-    overflow:auto;
-  }
-  .celldiv {
-    padding-top:3px;
-    padding-right:3px;
-    padding-left:3px;
-    padding-bottom:0px;
-    white-space:nowrap;
-    overflow:auto;
-  }
-  .tabline { color:#000000 }
-  .tabcell {
-    white-space:nowrap;
-    overflow:hidden;
-    padding:0px;
-  }
-  .taskcell1 {
-    background-color:#ebf2ff;
-    white-space:nowrap;
-    padding:0px;
-  }
-  .taskcell2 {
-    background-color:#d9dfeb;
-    white-space:nowrap;
-    padding:0px;
-  }
-  .resourcecell1 {
-    background-color:#fff2eb;
-    white-space:nowrap;
-    padding:0px;
-  }
-  .resourcecell2 {
-    background-color:#ebdfd9;
-    white-space:nowrap;
-    padding:0px;
-  }
-  .busy1 { background-color:#ff3b3b; }
-  .busy2 { background-color:#eb4545; }
-  .loaded1 { background-color:#ff9b9b; }
-  .loaded2 { background-color:#eb8f8f; }
-  .free1 { background-color:#a5ffb4; }
-  .free2 { background-color:#98eba6; }
-  .offduty1 { background-color:#f3f990; }
-  .offduty2 { background-color:#dde375; }
-  .calconttask1 { background-color:#abbeae; }
-  .calconttask2 { background-color:#99aa9c; }
-  .caltask1 { background-color:#2050e5; }
-  .caltask2 { background-color:#2f57ea; }
-  .todo1 { background-color:#beabab; }
-  .todo2 { background-color:#aa9999; }
-
-  .tabvline {
-    background-color:#9a9a9a;
-    position:absolute;
-  }
-  .containerbar {
-    background-color:#09090a;
-    position:absolute;
-  }
-  .taskbarframe {
-    background-color:#09090a;
-    position:absolute;
-  }
-  .taskbar {
-    background-color:#2f57ea;
-    position:absolute;
-  }
-  .progressbar {
-    background-color:#36363f;
-    position:absolute;
-  }
-  .milestone {
-    background-color:#09090a;
-    position:absolute;
-  }
-  .loadstackframe {
-    background-color:#452a2a;
-    position:absolute;
-  }
-  .free {
-    background-color:#a5ffb5;
-    position:absolute;
-  }
-  .busy {
-    background-color:#ff9b9b;
-    position:absolute;
-  }
-  .assigned {
-    background-color:#ff3b3b;
-    position:absolute;
-  }
-  .offduty {
-    background-color:#f3f990;
-    white-space:nowrap;
-    position:absolute;
-  }
-  .depline {
-    background-color:#000000;
-    position:absolute;
-  }
-  .nowline {
-    background-color:#EE0000;
-    position:absolute;
-  }
-  .white {
-    background-color:#FFFFFF;
-    position:absolute;
-  }
-
-  .legendback { background-color:#d4dde6; }
-  .caption {
-     padding: 5px 13px 5px 13px;
-     background-color:#ebf2ff;
-     white-space:normal;
-     font-size:13px
-  }
+      if a('selfcontained')
+        auxSrcDir = AppConfig.dataDirs('data/css')[0]
+        cssFileName = auxSrcDir + '/tjreport.css'
+        if auxSrcDir.nil? || !File.exists?(cssFileName)
+          raise TjException.new, <<"EOT"
+Cannot find '#{cssFileName}'. This is usually the result of an improper
+TaskJuggler installation. If you know where to find the data directory, you
+can use the TASKJUGGLER_DATA_PATH environment variable to specify the
+location.
 EOT
-                          )
+        end
+        cssFile = IO.read(cssFileName)
+        if cssFile.empty?
+          raise TjException.new, <<"EOT"
+Cannot read '#{cssFileName}'. Make sure the file is not empty and you have
+read access permission.
+EOT
+        end
+        head << XMLElement.new('meta', 'http-equiv' => 'Content-Style-Type',
+                               'content' => 'text/css; charset=utf-8')
+        head << (style = XMLElement.new('style', 'type' => 'text/css'))
+        style << XMLBlob.new("\n" + cssFile)
+      else
+        head << XMLElement.new('link', 'rel' => 'stylesheet',
+                               'type' => 'text/css',
+                               'href' => 'css/tjreport.css')
+      end
       html << (body = XMLElement.new('body'))
 
+      unless a('selfcontained')
+        body << (script = XMLElement.new('script', 'type' => 'text/javascript',
+                                         'src' => 'scripts/wz_tooltip.js'))
+        script.mayNotBeEmpty = true
+        body << (noscript = XMLElement.new('noscript'))
+        noscript << (nsdiv = XMLElement.new('div',
+                                            'style' => 'text-align:center; ' +
+                                            'color:#FF0000'))
+        nsdiv << XMLText.new(<<'EOT'
+This page requires Javascript for full functionality. Please enable it
+in your browser settings!
+EOT
+                            )
+      end
+
+
       # Make sure we have some margins around the report.
       body << (frame = XMLElement.new('div',
                                       'style' => 'margin: 35px 5% 25px 5%; '))
 
       frame << @content.to_html if @content
 
+      # The footer with some administrative information.
+      frame << (div = XMLElement.new('div', 'class' => 'copyright'))
+      div << XMLText.new(@project['copyright'] + " - ") if @project['copyright']
+      div << XMLText.new("Project: #{@project['name']} " +
+                        "Version: #{@project['version']} - " +
+                        "Created on #{TjTime.now.to_s("%Y-%m-%d %H:%M:%S")} " +
+                        "with ")
+      div << XMLNamedText.new("#{AppConfig.softwareName}", 'a',
+                             'href' => "#{AppConfig.contact}")
+      div << XMLText.new(" v#{AppConfig.version}")
+
       html.write((@name[0] == '/' ? '' : @project.outputDir) +
                  @name + (@name == '.' ? '' : '.html'))
     end
@@ -314,15 +210,62 @@ EOT
                                   @name + (@name == '.' ? '' : '.csv'))
     end
 
-    # Generate an export report
-    def generateExport
-      @content = TjpExportRE.new(self)
+    # Generate time sheet drafts.
+    def generateTJP
       f = @name == '.' ? $stdout :
                          File.new((@name[0] == '/' ? '' : @project.outputDir) +
                                   @name, 'w')
       f.puts "#{@content.to_tjp}"
     end
 
+    def copyAuxiliaryFiles
+      return if @name == '.' # Don't copy files if output is stdout.
+
+      copyDirectory('css')
+      copyDirectory('icons')
+      copyDirectory('scripts')
+    end
+
+    def copyDirectory(dirName)
+      # The directory needs to be in the same directory as the HTML report.
+      auxDstDir = File.dirname((@name[0] == '/' ? '' : @project.outputDir) +
+                               @name) + '/'
+      # Find the data directory that came with the TaskJuggler installation.
+      auxSrcDir = AppConfig.dataDirs("data/#{dirName}")[0]
+      if auxSrcDir.nil? || !File.exists?(auxSrcDir)
+        raise TjException.new, <<"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.
+EOT
+      end
+      # Don't copy directory if all files are up-to-date.
+      return if directoryUpToDate?(auxSrcDir, auxDstDir + dirName)
+
+      # Recursively copy the directory and all content.
+      FileUtils.cp_r(auxSrcDir, auxDstDir)
+    end
+
+    def directoryUpToDate?(auxSrcDir, auxDstDir)
+      return false unless File.exists?(auxDstDir.untaint)
+
+      Dir.entries(auxSrcDir).each do |file|
+        next if file == '.' || file == '..'
+
+        srcFile = (auxSrcDir + '/' + file).untaint
+        dstFile = (auxDstDir + '/' + file).untaint
+        return false if !File.exist?(dstFile) ||
+                        File.mtime(srcFile) > File.mtime(dstFile)
+      end
+      true
+    end
+
+    def error(id, message)
+        @project.messageHandler.send(Message.new(id, 'error', message, nil, nil,
+                                                 @sourceFileInfo))
+    end
+
   end
 
 end