taskjuggler 0.0.6 → 0.0.7

data/lib/UTF8String.rb

@@ -89,7 +89,6 @@ class String
     def reverse
       a = []
       each_utf8_char { |c| a << c }
-      s = ''
       a.reverse.join
     end
 

data/lib/UserManual.rb

@@ -37,8 +37,8 @@ class TaskJuggler
       # Directory where to find the manual RichText sources. Must be relative
       # to lib directory.
       srcDir = AppConfig.dataDirs('manual')[0]
-      # Directory where to put the generated HTML files. Must be relative to lib
-      # directory.
+      # Directory where to put the generated HTML files. Must be relative to
+      # lib directory.
       destDir = directory + (directory[-1] == '/' ? '' : '/')
       # A list of all source files. The order is important.
       %w(
@@ -51,6 +51,7 @@ class TaskJuggler
         Tutorial
         The_TaskJuggler_Syntax
         Rich_Text_Attributes
+        Software
         Day_To_Day_Juggling
         TaskJuggler_Internals
         fdl
@@ -58,7 +59,7 @@ class TaskJuggler
         snip = addSnip(srcDir + file)
         snip.cssClass = 'manual'
       end
-      # Generate the table of contense
+      # Generate the table of contents
       tableOfContents
       # Generate the HTML files.
       generateHTML(destDir)
@@ -210,7 +211,7 @@ class TaskJuggler
       super
       # Let's call the reference 'Appendix A'
       @reference.tableOfContents(@toc, 'A')
-      @snipNames += @reference.all
+      @anchors += @reference.all
     end
 
     # Generate the HTML pages for the syntax reference and a navigation page

data/lib/VimSyntax.rb

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = KeywordDocumentation.rb -- The TaskJuggler III Project Management Software
+#
+# 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 'SyntaxReference'
+
+class TaskJuggler
+
+  # This class is a generator for vim (http://www.vim.org) TaskJuggler syntax
+  # highlighting files.
+  class VimSyntax
+
+    # Create a generator object.
+    def initialize
+      @reference = SyntaxReference.new
+
+      @properties = []
+      @attributes = []
+      @optionBlocks = []
+
+      @reference.keywords.each_value do |kw|
+        if kw.isProperty?
+          @properties << kw
+        else
+          @attributes << kw
+        end
+        if !kw.optionalAttributes.empty?
+          @optionBlocks << kw
+        end
+      end
+
+      @file = nil
+    end
+
+    # Generate the vim syntax file into _file_.
+    def generate(file)
+      @file = File.open(file, 'w')
+
+      header
+      setLocal
+      keywords
+      matches
+      regions
+      highlights
+
+      @file.close
+    end
+
+    private
+
+    def header
+      @file.write <<"EOT"
+" Vim syntax file
+" Language:     TaskJuggler
+" Maintainer:   TaskJuggler Developers <taskjuggler-devel@googlegroups.com>
+" Last Change:  #{Time.now}
+" This file was automatically generated by VimSyntax.rb
+
+if exists("b:current_syntax")
+  finish
+endif
+
+EOT
+    end
+
+    def setLocal
+      cinwords = []
+      @optionBlocks.each { |kw| cinwords += kw.names }
+      cinwords.uniq!.sort!
+      @file.write <<'EOT'
+setlocal softtabstop=2
+setlocal cindent shiftwidth=2
+setlocal tabstop=2
+setlocal expandtab
+setlocal cinoptions=g0,t0,+0,(0,c0,C1
+EOT
+      @file.write "setlocal cinwords=#{cinwords.join(',')}\n"
+      @file.write <<'EOT'
+setlocal cinkeys=0{,0},!^F,o,O
+setlocal cindent
+
+EOT
+    end
+
+    def regions
+      @optionBlocks.each do |kw|
+        single = kw.names.length == 1
+        kw.names.each do |name|
+          normalizedName = "#{normalize(kw.keyword)}" +
+                           "#{single ? '' : "_#{name}"}"
+          tag = name == 'supplement' ?
+                        kw.keyword.gsub(/\./, ' ') : name
+          @file.write "syn region tjpblk_#{normalizedName}" +
+                      " start=/^\\s*#{tag}\\s.*{/ end=/^\\s*}/ transparent"
+          # We allow properties and special attributes to be folded.
+          foldable = %w( task.timesheet project )
+          @file.write " fold" if @properties.include?(kw) ||
+                                 foldable.include?(kw.keyword)
+          # The header is part of the region. So we must make sure that common
+          # parameters and the property/attribute name are contained as well.
+          @file.write " contains=@tjpcommon,tjp_#{normalizedName}"
+          kw.optionalAttributes.each do |oa|
+            tag = normalize(oa.keyword)
+            @file.write ",tjp_#{tag}"
+            if !oa.optionalAttributes.empty?
+              # Option blocks may be contained as block or non-block.
+              @file.write ",tjpblk_#{tag}"
+            end
+          end
+          if name == 'supplement'
+            @file.write(',tjp_supplement')
+          end
+          if !kw.globalScope?
+            # Every region but a property and 'project' is contained.
+            @file.write " contained"
+          end
+          @file.puts
+        end
+      end
+
+      @file.write <<'EOT'
+syn region tjpblk_macro start=/macro\s\+\h\w*\s*\[/ end=/\]$/ transparent fold contains=ALL
+syn region tjpstring start=/"/ skip=/\\"/ end=/"/
+syn region tjpstring start=/'/ skip=/\\'/ end=/'/
+syn region tjpstring start=/\s-8<-$/ end=/^\s*->8-/
+syn region tjpmlcomment start=+/\*+ end=+\*/+
+
+syn sync fromstart
+set foldmethod=syntax
+
+EOT
+    end
+
+    def keywords
+      %w( macro project supplement ).each do |kw|
+        @file.puts "syn keyword tjp_#{kw} #{kw} contained"
+      end
+      @file.puts
+
+      # Property keywords
+      @properties.each do |kw|
+        single = kw.names.length == 1
+        kw.names.each do |name|
+          # Ignore the 'supplement' entries. They are not real properties.
+          next if name == 'supplement'
+          @file.puts "syn keyword tjp_#{normalize(kw.keyword)}" +
+                     "#{single ? '' : "_#{name}"} #{name} contained"
+          @file.puts "hi def link tjp_#{normalize(kw.keyword)}" +
+                     "#{single ? '' : "_#{name}"} Function"
+        end
+      end
+      @file.puts
+
+      # Attribute keywords
+      @attributes.each do |kw|
+        next if %w( resourcereport taskreport textreport ).include?(kw.keyword)
+        single = kw.names.length == 1
+        kw.names.each do |name|
+          break if [ '%', '(', '~', 'include', 'macro', 'project',
+                     'supplement' ].include?(name)
+          @file.puts "syn keyword tjp_#{normalize(kw.keyword)}" +
+                     "#{single ? '' : "_#{name}"} #{name}" +
+                     "#{kw.globalScope? && !@optionBlocks.include?(kw) ?
+                        '' : ' contained'}"
+          @file.puts "hi def link tjp_#{normalize(kw.keyword)}" +
+                     "#{single ? '' : "_#{name}"} Type"
+        end
+      end
+      @file.puts
+    end
+
+    def matches
+      @file.write <<'EOT'
+syn match tjparg contained /\${.*}/
+syn match tjpcomment /#.*$/
+syn match tjpcomment "//.*$"
+syn match tjpinclude /include.*$/
+syn match tjpnumber /\s[-+]\?\d\+\(\.\d\+\)\?\([hdwmy]\|min\)\?/
+syn match tjpdate /\s\d\{4}-\d\{1,2}-\d\{1,2}\(-\d\{1,2}:\d\{1,2}\(:\d\{1,2}\)\?\(-[-+]\?\d\{4}\)\?\)\?/
+syn match tjptime /\s\d\{1,2}:\d\d\(:\d\d\)\?/
+
+syn cluster tjpcommon contains=tjpcomment,tjpdate,tjptime,tjpstring,tjpnumber
+EOT
+    end
+
+    def highlights
+      @file.write <<'EOT'
+hi def link tjp_macro PreProc
+hi def link tjp_supplement Function
+hi def link tjp_project Function
+hi def link tjpproperty Function
+hi def link tjpattribute Type
+hi def link tjparg Special
+hi def link tjpstring String
+hi def link tjpcomment Comment
+hi def link tjpmlcomment Comment
+hi def link tjpinclude Include
+hi def link tjpdate Constant
+hi def link tjptime Constant
+hi def link tjpnumber Number
+
+let b:current_syntax = "tjp"
+
+EOT
+    end
+
+    def normalize(str)
+      str.gsub(/\./, '_')
+    end
+
+  end
+
+end
+
+TaskJuggler::VimSyntax.new.generate('tjp.vim')

data/lib/daemon/Daemon.rb

@@ -14,15 +14,22 @@ require 'LogFile'
 
 class TaskJuggler
 
+  # This class provides the basic functionality to turn the current process
+  # into a background process (daemon). To use it, derive you main class from
+  # this class and call the start() method.
   class Daemon
 
     attr_accessor :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
     end
 
+    # Call this method to turn the process into a background process.
     def start
       return unless @daemonize
 
@@ -61,6 +68,8 @@ class TaskJuggler
       @log.info("The process is running as daemon now with PID #{@pid}")
     end
 
+    # This method may provide some cleanup functionality in the future. You
+    # better call it before you exit.
     def stop
     end
 

data/lib/daemon/ProcessIntercom.rb

@@ -16,22 +16,36 @@ class TaskJuggler
 
   module ProcessIntercomIface
 
+    # This function catches all unhandled exceptions in the passed block.
+    def trap
+      log = LogFile.instance
+
+      begin
+        yield
+      rescue
+        $stderr.print $!.to_s
+        $stderr.print $!.backtrace.join("\n")
+        log.debug($!.backtrace.join("\n"))
+        log.fatal("Unexpected exception: #{$!}")
+      end
+    end
+
     def terminate(authKey)
       return false unless @server.checkKey(authKey, 'terminate')
 
-      @server.terminate
+      trap { @server.terminate }
     end
 
     def connect(authKey, stdout, stderr, stdin, silent)
       return false unless @server.checkKey(authKey, 'connect')
 
-      @server.connect(stdout, stderr, stdin, silent)
+      trap { @server.connect(stdout, stderr, stdin, silent) }
     end
 
     def disconnect(authKey)
       return false unless @server.checkKey(authKey, 'disconnect')
 
-      @server.disconnect
+      trap { @server.disconnect }
     end
 
   end
@@ -119,7 +133,8 @@ class TaskJuggler
     def timerExpired?
       res = nil
       @timeLock.synchronize do
-        res = (Time.new > @timerStart + 2 * 60 * 60)
+        # We should see client interaction every 2 minutes.
+        res = (Time.new > @timerStart + 2 * 60)
       end
       res
     end

data/lib/daemon/ProjectBroker.rb

@@ -36,7 +36,8 @@ class TaskJuggler
   # daemon.
   class ProjectBroker < Daemon
 
-    attr_accessor :port, :enableWebServer, :webServerPort, :projectFiles
+    attr_accessor :port, :uriFile, :enableWebServer, :webServerPort,
+                  :projectFiles
     attr_reader :authKey
 
     def initialize
@@ -46,6 +47,8 @@ class TaskJuggler
       @authKey = nil
       # The default TCP/IP port. ASCII code decimals for 'T' and 'J'.
       @port = 8474
+      # The name of the URI file.
+      @uriFile = nil
       # A list of loaded projects as Array of ProjectRecord objects.
       @projects = []
       # We operate with multiple threads so we need a Monitor to synchronize
@@ -112,6 +115,16 @@ EOT
         @log.fatal("Cannot listen on port #{@port}: #{$!}")
       end
 
+      if @port == 0
+        # If the port is set to 0 (any port) we save the ProjectBroker URI in
+        # the file .tj3d.uri. tj3client will look for it.
+        begin
+          File.open(@uriFile, 'w') { |f| f.write @uri }
+        rescue
+          @log.fatal("Cannot write URI file #{@uriFile}: #{$!}")
+        end
+      end
+
       # If project files were specified on the command line, we add them here.
       i = 0
       @projectFiles.each do |project|
@@ -124,6 +137,16 @@ EOT
 
       # Cleanup the DRb threads
       DRb.thread.join
+
+      # If we have created a URI file, we need to delete it again.
+      if @port == 0
+        begin
+          File.delete(@uriFile)
+        rescue
+          @log.fatal("Cannot delete URI file .tj3d.uri: #{$!}")
+        end
+      end
+
       @log.info('TaskJuggler daemon terminated')
     end
 
@@ -166,10 +189,10 @@ EOT
       if @projects.empty?
         "No projects registered\n"
       else
-        format = "  %3s | %-25s | %-14s | %-20s\n"
-        out = sprintf(format, 'No.', 'Project ID', 'Status', 'Loaded since')
-        out += "  " + '-' * 4 + '+' + '-' * 27 + '+' + '-' * 16 + '+' +
-               '-' * 20 + "\n"
+        format = "  %3s | %-25s | %-14s | %s | %-20s\n"
+        out = sprintf(format, 'No.', 'Project ID', 'Status', 'M',
+                              'Loaded since')
+        out += "  #{'-' * 4}+#{'-' * 27}+#{'-' * 16}+#{'-' * 3}+#{'-' * 20}\n"
         @projects.synchronize do
           i = 0
           @projects.each do |project|
@@ -252,6 +275,19 @@ EOT
       [ project.uri, project.authKey ]
     end
 
+    # Reload all projects that have modified files and are not already being
+    # reloaded.
+    def update
+      @projects.synchronize do
+        @projects.each do |project|
+          if project.modified && !project.reloading
+            project.reloading = true
+            @projectsToLoad.push(project.files)
+          end
+        end
+      end
+    end
+
     # Return a list of IDs of projects that are in state :ready.
     def getProjectList
       list = []
@@ -269,8 +305,19 @@ EOT
 
     # This is a callback from the ProjectServer process. It's used to update
     # the current state of the ProjectServer in the ProjectRecord list.
-    def updateState(authKey, id, state)
+    def updateState(authKey, filesOrId, state, modified)
       result = false
+      if filesOrId.is_a?(Array)
+        files = filesOrId
+        # Use the name of the master files for now.
+        id = files[1]
+      elsif filesOrId.is_a?(String)
+        id = filesOrId
+        files = nil
+      else
+        id = files = nil
+      end
+
       @projects.synchronize do
         @projects.each do |project|
           # Don't accept updates for already obsolete entries.
@@ -279,7 +326,9 @@ EOT
           @log.debug("Updating state for #{id} to #{state}")
           # Only update the record that has the matching authKey
           if project.authKey == authKey
-            project.id = id
+            project.id = id if id
+            # An Array of [ workingDir, tjpFile, ... other tji files ]
+            project.files = files if files
 
             # If the state is being changed from something to :ready, this is
             # now the current project for the project ID.
@@ -299,6 +348,7 @@ EOT
             project.uri = nil if state == :failed
 
             project.state = state
+            project.modified = modified
             result = true
             break
           end
@@ -312,56 +362,62 @@ EOT
 
     def startHousekeeping
       Thread.new do
-        cntr = 0
-        loop do
-          if @terminate
-            # Give the caller a chance to properly terminate the connection.
-            sleep 0.5
-            @log.debug('Shutting down DRb server')
-            DRb.stop_service
-            break
-          elsif !@projectsToLoad.empty?
-            loadProject(@projectsToLoad.pop)
-          else
-            # Send termination command to all obsolute ProjectServer objects.
-            # To minimize the locking of @projects we collect the obsolete
-            # items first.
-            termList = []
-            @projects.synchronize do
-              @projects.each do |p|
-                if p.state == :obsolete
-                  termList << p
-                elsif p.state == :failed
-                  # Start removal of entries that didn't parse.
-                  p.state = :obsolete
-                end
-              end
-            end
-            # And then send them a termination command.
-            termList.each { |p| p.terminateServer }
-
-            # Check every 30 seconds that the ProjectServer processes are
-            # still alive. If not, remove them from the list.
-            if (cntr += 1) > 30
+        begin
+          cntr = 0
+          loop do
+            if @terminate
+              # Give the caller a chance to properly terminate the connection.
+              sleep 0.5
+              @log.debug('Shutting down DRb server')
+              DRb.stop_service
+              break
+            elsif !@projectsToLoad.empty?
+              loadProject(@projectsToLoad.pop)
+            else
+              # Send termination command to all obsolute ProjectServer
+              # objects.  To minimize the locking of @projects we collect the
+              # obsolete items first.
+              termList = []
               @projects.synchronize do
                 @projects.each do |p|
-                  unless p.ping
-                    termList << p unless termList.include?(p)
+                  if p.state == :obsolete
+                    termList << p
+                  elsif p.state == :failed
+                    # Start removal of entries that didn't parse.
+                    p.state = :obsolete
                   end
                 end
               end
-              cntr = 0
-            end
+              # And then send them a termination command.
+              termList.each { |p| p.terminateServer }
+
+              # Check every 10 seconds that the ProjectServer processes are
+              # still alive. If not, remove them from the list.
+              if (cntr += 1) > 10
+                @projects.synchronize do
+                  @projects.each do |p|
+                    unless p.ping
+                      termList << p unless termList.include?(p)
+                    end
+                  end
+                end
+                cntr = 0
+              end
 
-            # The housekeeping thread rarely needs to so something. Make sure
-            # it's sleeping most of the time.
-            sleep 1
+              # The housekeeping thread rarely needs to so something. Make
+              # sure it's sleeping most of the time.
+              sleep 1
 
-            # Remove the obsolete records from the @projects list.
-            @projects.synchronize do
-              @projects.delete_if { |p| termList.include?(p) }
+              # Remove the obsolete records from the @projects list.
+              @projects.synchronize do
+                @projects.delete_if { |p| termList.include?(p) }
+              end
             end
           end
+        rescue
+          $stderr.print $!.to_s
+          $stderr.print $!.backtrace.join("\n")
+          @log.fatal("ProjectBroker housekeeping error: #{$!}")
         end
       end
     end
@@ -378,7 +434,7 @@ EOT
         @log.debug("Loading project for tag #{tag}")
       end
       pr = ProjectRecord.new(tag)
-      ps = ProjectServer.new(project)
+      ps = ProjectServer.new(project, !@daemonize)
       # The ProjectServer can be reached via this DRb URI
       pr.uri = ps.uri
       # Method calls must be authenticated with this key
@@ -411,27 +467,45 @@ EOT
       version == 1 ? 1 : -1
     end
 
+    # This function catches all unhandled exceptions in the passed block.
+    def trap
+      log = LogFile.instance
+
+      begin
+        yield
+      rescue
+        $stderr.print $!.to_s
+        $stderr.print $!.backtrace.join("\n")
+        log.debug($!.backtrace.join("\n"))
+        log.fatal("Unexpected exception: #{$!}")
+      end
+    end
+
     def command(authKey, cmd, args)
       return false unless @broker.checkKey(authKey, cmd)
 
-      case cmd
-      when :status
-        @broker.status
-      when :stop
-        @broker.stop
-      when :addProject
-        @broker.addProject
-      when :removeProject
-        @broker.removeProject(args)
-      when :getProject
-        @broker.getProject(args)
-      else
-        LogFile.instance.fatal('Unknown command #{cmd} called')
+      trap do
+        case cmd
+        when :status
+          @broker.status
+        when :stop
+          @broker.stop
+        when :addProject
+          @broker.addProject
+        when :removeProject
+          @broker.removeProject(args)
+        when :getProject
+          @broker.getProject(args)
+        when :update
+          @broker.update
+        else
+          LogFile.instance.fatal('Unknown command #{cmd} called')
+        end
       end
     end
 
-    def updateState(authKey, id, status)
-      @broker.updateState(authKey, id, status)
+    def updateState(authKey, id, status, modified)
+      trap { @broker.updateState(authKey, id, status, modified) }
     end
 
   end
@@ -440,13 +514,16 @@ EOT
   # one entry for each project in the @projects list.
   class ProjectRecord < Monitor
 
-    attr_accessor :authKey, :uri, :id, :state, :readySince
+    attr_accessor :authKey, :uri, :files, :id, :state, :readySince, :modified,
+                  :reloading
     attr_reader :tag
 
     def initialize(tag)
       # Before we know the project ID we use this tag to uniquely identify the
       # project.
       @tag = tag
+      # Array of [ workingDir, tjp file, ... tji files ]
+      @files = nil
       # The authentication key for the ProjectServer process.
       @authKey = nil
       # The DRb URI where the ProjectServer process is listening.
@@ -458,6 +535,10 @@ EOT
       @state = :new
       # A time stamp when the project became ready for service.
       @readySince = nil
+      # True if any of the input files have been modified after the load.
+      @modified = false
+      # True if the reload has already been triggered.
+      @reloading = false
 
       @log = LogFile.instance
       @projectServer = nil
@@ -466,7 +547,7 @@ EOT
     def ping
       return true unless @uri
 
-      @log.debug("Sending ping to ProcessServer #{@uri}")
+      @log.debug("Sending ping to ProjectServer #{@uri}")
       begin
         @projectServer = DRbObject.new(nil, @uri) unless @projectServer
         @projectServer.ping(@authKey)
@@ -482,7 +563,7 @@ EOT
       return unless @uri
 
       begin
-        @log.debug("Sending termination request to ProcessServer #{@uri}")
+        @log.debug("Sending termination request to ProjectServer #{@uri}")
         @projectServer = DRbObject.new(nil, @uri) unless @projectServer
         @projectServer.terminate(@authKey)
       rescue
@@ -493,7 +574,7 @@ EOT
 
     # This is used to generate the status table.
     def to_s(format, index)
-      sprintf(format, index, @id, @state,
+      sprintf(format, index, @id, @state, @modified ? '*' : ' ',
               @readySince ? @readySince.to_s('%Y-%m-%d %H:%M:%S') : '')
     end