taskjuggler 0.0.3 → 0.0.4

data/lib/{RTPNavigator.rb → RTFNavigator.rb}

@@ -1,31 +1,32 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = RTPNavigator.rb -- The TaskJuggler III Project Management Software
+# = RTFNavigator.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 'RichTextProtocolHandler'
+require 'RichTextFunctionHandler'
 require 'XMLElement'
 require 'reports/Navigator'
 
 class TaskJuggler
 
-  # This class is a specialized RichTextProtocolHandler that generates a
+  # This class is a specialized RichTextFunctionHandler that generates a
   # navigation bar for all reports that match the specified LogicalExpression.
   # It currently only supports HTML.
-  class RTPNavigator < RichTextProtocolHandler
+  class RTFNavigator < RichTextFunctionHandler
 
-    def initialize(project, sourceFileInfo)
+    def initialize(project, sourceFileInfo = nil)
       super(project, 'navigator', sourceFileInfo)
+      @blockFunction = true
     end
 
-    # Not supported for this protocol
+    # Not supported for this function
     def to_s(args)
       ''
     end
@@ -33,16 +34,16 @@ class TaskJuggler
     # Return a XMLElement tree that represents the navigator in HTML code.
     def to_html(args)
       if args.nil? || (id = args['id']).nil?
-        error('rtp_nav_id_missing',
+        error('rtf_nav_id_missing',
               "Argument 'id' missing to specify the navigator to be used.")
       end
       unless (navBar = @project['navigators'][id])
-        error('rtp_nav_unknown_id', "Unknown navigator #{id}")
+        error('rtf_nav_unknown_id', "Unknown navigator #{id}")
       end
       navBar.to_html
     end
 
-    # Not supported for this protocol.
+    # Not supported for this function.
     def to_tagged(args)
       nil
     end

data/lib/RTFQuery.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = RTFQuery.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 'RichTextFunctionHandler'
+require 'XMLElement'
+require 'Query'
+
+class TaskJuggler
+
+  # This class is a specialized RichTextFunctionHandler that can be used to
+  # query the value of a project or property attribute.
+  class RTFQuery < RichTextFunctionHandler
+
+    def initialize(project, sourceFileInfo = nil)
+      super(project, 'query', sourceFileInfo)
+      @blockMode = false
+      @query = nil
+    end
+
+    # This function must be called to register the Query object that will be
+    # used to resolve the queries. It will create a copy of the object since
+    # it will modify it.
+    def setQuery(query)
+      @query = query.dup
+    end
+
+    # Return the result of the query as String.
+    def to_s(args)
+      return '' unless prepareQuery(args)
+      if @query.ok
+        @query.to_s
+      else
+        error('query_error', @query.errorMessage + recreateQuerySyntax(args))
+        'Query Error: ' + @query.errorMessage
+      end
+    end
+
+    # Return a XMLElement tree that represents the navigator in HTML code.
+    def to_html(args)
+      return nil unless prepareQuery(args)
+      if @query.ok
+        if (rti = @query.to_rti)
+          rti.to_html
+        elsif (str = @query.to_s)
+          XMLText.new(str)
+        else
+          nil
+        end
+      else
+        error('query_error', @query.errorMessage + recreateQuerySyntax(args))
+        font = XMLElement.new('font', 'color' => '#FF0000')
+        font << XMLText.new('Query Error: ' + @query.errorMessage)
+        font
+      end
+    end
+
+    # Not supported for this function.
+    def to_tagged(args)
+      nil
+    end
+
+    private
+
+    def prepareQuery(args)
+      unless @query
+        raise "No Query has been registered for this RichText yet!"
+      end
+
+      # Check the user provided arguments. Only the following list is allowed.
+      validArgs = %w( family property scopeproperty attribute scenario
+                      start end loadunit numberformat timeformat currencyformat )
+      args.each_key do |arg|
+        unless validArgs.include?(arg)
+          error('bad_query_parameter', "Unknown query parameter '#{arg}'. " +
+                "Use one of #{validArgs.join(', ')}!")
+          return nil
+        end
+      end
+
+      # Every provided query parameter will overwrite the corresponding value
+      # in the Query that was provided by the ReportContext.  The name of the
+      # arguments don't always exactly match the Query variables Let's start
+      # with the easy ones.
+      @query.propertyId = args['property'] if args['property']
+      @query.scopeProperty = args['scopeproperty'] if args['scopeproperty']
+      @query.attributeId = args['attribute'] if args['attribute']
+      @query.start = args['start'] if args['start']
+      @query.end = args['end'] if args['end']
+      @query.numberFormat = args['numberformat'] if args['numberformat']
+      @query.timeFormat = args['timeformat'] if args['timeformat']
+      @query.currencyFormat = args['currencyformat'] if args['currencyformat']
+
+      # And now the slighly more complicated ones.
+      setScenarioIdx(args)
+      setPropertyType(args)
+      setLoadUnit(args)
+
+      # Now that we have put together the query, we can process it and return
+      # the query object for result extraction.
+      @query.process
+      @query
+    end
+
+    # Regenerate the original query text based on the argument list.
+    def recreateQuerySyntax(args)
+      queryText = "\n<-query"
+      args.each do |a, v|
+        queryText += " #{a}=\"#{v}\""
+      end
+      queryText += "->"
+    end
+
+    def setPropertyType(args)
+      validTypes = { 'account' => :Account,
+                     'task' => :Task,
+                     'resource' => :Resource }
+
+      if args['family']
+        unless validTypes[args['family']]
+          error('rtfq_bad_query_family',
+                "Unknown query family type '#{args['family']}'. " +
+                "Use one of #{validTypes}.join(', ')!")
+        end
+        @query.propertyType = validTypes[args['family']]
+        if @query.propertyType == :Task
+          @query.scopePropertyType = :Resource
+        elsif @query.propertyType == :Resource
+          @query.scopePropertyType = :Task
+        end
+      end
+    end
+
+    def setLoadUnit(args)
+      units = {
+        'days' => :days, 'hours' => :hours, 'longauto' => :longauto,
+        'minutes' => :minutes, 'months' => :months, 'shortauto' => :shortauto,
+        'weeks' => :weeks, 'years' => :years
+      }
+      @query.loadUnit = units[args['loadunit']] if args['loadunit']
+    end
+
+    def setScenarioIdx(args)
+      if args['scenario']
+        scenarioIdx = @project.scnearioIdx(args['scenario'])
+        unless scenarioIdx
+          error('rtfq_bad_scenario', "Unknown scenario #{args['scenario']}")
+        end
+        @query.scenarioIdx = scenarioIdx
+      end
+      # Default to 0 in case no scenario was provided.
+      @query.scenarioIdx = 0 unless @query.scenarioIdx
+    end
+
+  end
+
+end
+

data/lib/{RTPReport.rb → RTFReport.rb}

@@ -1,29 +1,30 @@
 #!/usr/bin/env ruby -w
 # encoding: UTF-8
 #
-# = RTPReport.rb -- The TaskJuggler III Project Management Software
+# = RTFReport.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 'RichTextProtocolHandler'
+require 'RichTextFunctionHandler'
 require 'XMLElement'
 
 class TaskJuggler
 
-  # This class is a specialized RichTextProtocolHandler that includes a
+  # This class is a specialized RichTextFunctionHandler that includes a
   # report into the RichText output for supported formats.
-  class RTPReport < RichTextProtocolHandler
+  class RTFReport < RichTextFunctionHandler
 
-    def initialize(project, sourceFileInfo)
+    def initialize(project, sourceFileInfo = nil)
       super(project, 'report', sourceFileInfo)
+      @blockFunction = true
     end
 
-    # Not supported for this protocol
+    # Not supported for this function
     def to_s(args)
       ''
     end
@@ -33,9 +34,11 @@ class TaskJuggler
       if args.nil? || (id = args['id']).nil?
         error('rtp_report_id',
               "Argument 'id' missing to specify the report to be used.")
+        nil
       end
       unless (report = @project.report(id))
         error('rtp_report_unknown_id', "Unknown report #{id}")
+        nil
       end
 
       # Save the old report context record
@@ -51,7 +54,7 @@ class TaskJuggler
       html
     end
 
-    # Not supported for this protocol.
+    # Not supported for this function.
     def to_tagged(args)
       nil
     end

data/lib/RealFormat.rb

@@ -3,7 +3,7 @@
 #
 # = RealFormat.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/RemoteServiceManager.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = RemoteServiceManager.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 'ReportServer'
+
+class TaskJuggler
+
+# The RemoteServiceManager only waits for service requests from DRb clients.
+# When this function is called, the process forks so all changes happen on a
+# copy of the data. The original Project remains unchanged.
+# The child process starts another DRb server that than handles the further
+# requests.
+class RemoteServiceManager
+
+  attr_writer :terminate
+
+  def initialize(parser, project)
+    @parser = parser
+    @project = project
+    @terminate = false
+    @childPIDs = []
+  end
+
+  # This function should be called by the DRb client.
+  def requestService
+    rd, wr = IO.pipe
+    if (pid = fork)
+      # We are in the parent
+      @childPIDs << pid
+      wr.close
+      # Return the URI of the child's DRb ReportServer
+      Thread.new { waitForChild }
+      # TODO: Need to add some security and make it more robust.
+      return rd.read
+    else
+      # We are in the child
+      rd.close
+      DRb.stop_service
+      server = ReportServer.new(self, @parser, @project)
+      uri = DRb.start_service(nil, server).uri
+      # Send URI of new server to parent
+      wr.puts uri
+      wr.close
+
+      # Now we have to wait for the @terminate flag to be set to true by a DRb
+      # thread.
+      until @terminate do
+        sleep(0.5)
+      end
+      # Stop DRb service and wait for threads to finish
+      DRb.stop_service
+      DRb.thread.join
+    end
+  end
+
+  # This function needs to be called by the DRb thread to terminate the child
+  # process.
+  def terminateService
+    @terminate = true
+  end
+
+  # Run forever in the parent and pick-up the terminated childs.
+  def waitForChild
+    while true do
+      Process.wait2
+    end
+  end
+
+end
+
+end

data/lib/ReportServer.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ReportServer.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.
+#
+
+class TaskJuggler
+
+class ReportServer
+
+  def initialize(serviceManager, parser, project)
+    @serviceManager = serviceManager
+    @parser = parser
+    @project = project
+  end
+
+  def connect(stdout, stderr)
+    # Make sure that all output to STDOUT and STDERR is sent to the client.
+    @stdout = $stdout
+    @stderr = $stderr
+    $stdout = stdout
+    $stderr = stderr
+  end
+
+  def disconnect
+    # Signal to the RemoteServiceManager to exit the process.
+    $stdout = @stdout
+    $stderr = @stderr
+    @serviceManager.terminate = true
+  end
+
+  def parse(tjiFileContent)
+    begin
+      Log.enter('parser', 'Parsing buffer ...')
+      @parser.open(tjiFileContent, false, true)
+      @parser.setGlobalMacros
+      @parser.parse('properties')
+      @parser.close
+    rescue TjException
+      Log.exit('parser')
+      return false
+    end
+    true
+  end
+
+  def generateReport(reportId)
+    begin
+      Log.enter('generateReport', "Generating report #{reportId} ...")
+      @project.generateReport(reportId)
+    rescue
+      Log.exit('generateReport', "#{reportId} failed")
+      return false
+    end
+    Log.exit('generateReport', "Generating report #{reportId} ...")
+    true
+  end
+
+end
+
+end

data/lib/Resource.rb

@@ -3,7 +3,7 @@
 #
 # = Resource.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