taskjuggler 0.0.6 → 0.0.7

data/lib/RichTextSnip.rb

@@ -39,13 +39,9 @@ class TaskJuggler
       File.open(fileName) do |file|
         file.each_line { |line| text += line }
       end
-      begin
-        rText = RichText.new(text, @document.functionHandlers)
-        @richText = rText.generateIntermediateFormat(sectionCounter)
-      rescue RichTextException => msg
-        $stderr.puts "Error in RichText of file '#{fileName}'\n" +
-                     "Line #{msg.lineNo}: #{msg.text}\n" +
-                     "#{msg.line}"
+      rText = RichText.new(text, @document.functionHandlers,
+                           MessageHandler.new(true))
+      unless (@richText = rText.generateIntermediateFormat(sectionCounter))
         exit
       end
 

data/lib/RichTextSyntaxRules.rb

@@ -30,8 +30,8 @@ class TaskJuggler
 
     # This is the entry node.
     def rule_richtext
-      pattern(%w( !sections !blankLines . ), lambda {
-        el = RichTextElement.new(@richTextI, :richtext, @val[0])
+      pattern(%w( !sections . ), lambda {
+        RichTextElement.new(@richTextI, :richtext, @val[0])
       })
     end
 
@@ -46,16 +46,17 @@ class TaskJuggler
       pattern(%w( $HLINE !blankLines ), lambda {
         RichTextElement.new(@richTextI, :hline, @val[0])
       })
-      pattern(%w( !paragraph ), lambda {
+      pattern(%w( !paragraph !blankLines ), lambda {
         @val[0]
       })
-      pattern(%w( $PRE ), lambda {
-        RichTextElement.new(@richTextI, :pre, @val[0])
+      pattern(%w( !pre !blankLines ), lambda {
+        RichTextElement.new(@richTextI, :pre, @val[0].join)
       })
-      pattern(%w( !bulletList1 ), lambda {
+      pattern(%w( !bulletList1 !blankLines ), lambda {
+
         RichTextElement.new(@richTextI, :bulletlist1, @val[0])
       })
-      pattern(%w( !numberList1 ), lambda {
+      pattern(%w( !numberList1 !blankLines ), lambda {
         @numberListCounter = [ 0, 0, 0, 0 ]
         RichTextElement.new(@richTextI, :numberlist1, @val[0])
       })
@@ -79,9 +80,15 @@ class TaskJuggler
       })
     end
 
+    def rule_pre
+      repeatable
+      pattern(%w( $PRE ), lambda {
+        @val[0]
+      })
+    end
+
     def rule_title1
       pattern(%w( $TITLE1 !space !text $TITLE1END ), lambda {
-        @val[2][-1].appendSpace = false
         el = RichTextElement.new(@richTextI, :title1, @val[2])
         @sectionCounter[0] += 1
         @sectionCounter[1] = @sectionCounter[2] = 0
@@ -92,7 +99,6 @@ class TaskJuggler
 
     def rule_title2
       pattern(%w( $TITLE2 !space !text $TITLE2END ), lambda {
-        @val[2][-1].appendSpace = false
         el = RichTextElement.new(@richTextI, :title2, @val[2])
         @sectionCounter[1] += 1
         @sectionCounter[2] = 0
@@ -103,7 +109,6 @@ class TaskJuggler
 
     def rule_title3
       pattern(%w( $TITLE3 !space !text $TITLE3END ), lambda {
-        @val[2][-1].appendSpace = false
         el = RichTextElement.new(@richTextI, :title3, @val[2])
         @sectionCounter[2] += 1
         @sectionCounter[3] = 0
@@ -114,7 +119,6 @@ class TaskJuggler
 
     def rule_title4
       pattern(%w( $TITLE4 !space !text $TITLE4END ), lambda {
-        @val[2][-1].appendSpace = false
         el = RichTextElement.new(@richTextI, :title4, @val[2])
         @sectionCounter[3] += 1
         el.data = @sectionCounter.dup
@@ -125,7 +129,7 @@ class TaskJuggler
     def rule_bulletList1
       optional
       repeatable
-      pattern(%w( $BULLET1 !text $LINEBREAK), lambda {
+      pattern(%w( $BULLET1 !text ), lambda {
         RichTextElement.new(@richTextI, :bulletitem1, @val[1])
       })
       pattern(%w( !bulletList2 ), lambda {
@@ -135,7 +139,7 @@ class TaskJuggler
 
     def rule_bulletList2
       repeatable
-      pattern(%w( $BULLET2 !text $LINEBREAK), lambda {
+      pattern(%w( $BULLET2 !text ), lambda {
         RichTextElement.new(@richTextI, :bulletitem2, @val[1])
       })
       pattern(%w( !bulletList3 ), lambda {
@@ -145,7 +149,7 @@ class TaskJuggler
 
     def rule_bulletList3
       repeatable
-      pattern(%w( $BULLET3 !text $LINEBREAK), lambda {
+      pattern(%w( $BULLET3 !text ), lambda {
         RichTextElement.new(@richTextI, :bulletitem3, @val[1])
       })
       pattern(%w( !bulletList4 ), lambda {
@@ -155,15 +159,14 @@ class TaskJuggler
 
     def rule_bulletList4
       repeatable
-      pattern(%w( $BULLET4 !text $LINEBREAK), lambda {
+      pattern(%w( $BULLET4 !text ), lambda {
         RichTextElement.new(@richTextI, :bulletitem4, @val[1])
       })
     end
 
     def rule_numberList1
-      optional
       repeatable
-      pattern(%w( $NUMBER1 !text $LINEBREAK), lambda {
+      pattern(%w( $NUMBER1 !text ), lambda {
         el = RichTextElement.new(@richTextI, :numberitem1, @val[1])
         @numberListCounter[0] += 1
         el.data = @numberListCounter.dup
@@ -177,7 +180,7 @@ class TaskJuggler
 
     def rule_numberList2
       repeatable
-      pattern(%w( $NUMBER2 !text $LINEBREAK), lambda {
+      pattern(%w( $NUMBER2 !text ), lambda {
         el = RichTextElement.new(@richTextI, :numberitem2, @val[1])
         @numberListCounter[1] += 1
         el.data = @numberListCounter.dup
@@ -191,7 +194,7 @@ class TaskJuggler
 
     def rule_numberList3
       repeatable
-      pattern(%w( $NUMBER3 !text $LINEBREAK), lambda {
+      pattern(%w( $NUMBER3 !text ), lambda {
         el = RichTextElement.new(@richTextI, :numberitem3, @val[1])
         @numberListCounter[2] += 1
         el.data = @numberListCounter.dup
@@ -205,7 +208,7 @@ class TaskJuggler
 
     def rule_numberList4
       repeatable
-      pattern(%w( $NUMBER4 !text $LINEBREAK), lambda {
+      pattern(%w( $NUMBER4 !text ), lambda {
         el = RichTextElement.new(@richTextI, :numberitem4, @val[1])
         @numberListCounter[3] += 1
         el.data = @numberListCounter.dup
@@ -214,12 +217,19 @@ class TaskJuggler
     end
 
     def rule_paragraph
-      pattern(%w( !text $LINEBREAK ), lambda {
+      pattern(%w( !text ), lambda {
         RichTextElement.new(@richTextI, :paragraph, @val[0])
       })
     end
 
     def rule_text
+      pattern(%w( !textWithSpace ), lambda {
+        @val[0].last.appendSpace = false
+        @val[0]
+      })
+    end
+
+    def rule_textWithSpace
       repeatable
       pattern(%w( !plainTextWithLinks ), lambda {
         @val[0]
@@ -264,33 +274,41 @@ class TaskJuggler
         @val[0]
       })
       pattern(%w( $REF !refToken !moreRefToken $REFEND !space ), lambda {
-        if @val[1].index(':')
-          protocol, locator = @val[1].split(':')
+        v1 = @val[1].join
+        if v1.index(':')
+          protocol, locator = v1.split(':')
         else
           protocol = nil
         end
         el = nil
         if protocol == 'File'
           el = RichTextElement.new(@richTextI, :img)
+          unless (index = locator.rindex('.'))
+            error('rt_file_no_ext', "File name without extension: #{locator}")
+          end
+          extension = locator[index + 1..-1].downcase
+          unless %w( jpg gif png svg ).include?(extension)
+            error('rt_file_bad_ext', "Unsupported file type: #{extension}")
+          end
           el.data = img = RichTextImage.new(locator)
           @val[2].each do |token|
             if token[0, 4] == 'alt='
               img.altText = token[4..-1]
-            elsif %w( top middle bottom baseline sub super text-top text-bottom).
-                  include?(token)
+            elsif %w( top middle bottom baseline sub super text-top
+                      text-bottom ).include?(token)
               img.verticalAlign = token
             else
               error('rt_bad_file_option',
                     "Unknown option '#{token}' for file reference " +
-                    "#{@val[1]}.")
+                    "#{v1}.")
             end
           end
         else
           el = RichTextElement.new(@richTextI, :ref,
                                    RichTextElement.new(@richTextI,
                                                        :text, @val[2].empty? ?
-                                                       @val[1] : @val[2]))
-          el.data = @val[1]
+                                                       v1 : @val[2]))
+          el.data = v1
           el.appendSpace = !@val[4].empty?
         end
         el
@@ -309,11 +327,12 @@ class TaskJuggler
       repeatable
       optional
       pattern(%w( _| !refToken ), lambda {
-        @val[1]
+        @val[1].join
       })
     end
 
     def rule_refToken
+      repeatable
       pattern(%w( $WORD ), lambda {
         @val[0]
       })
@@ -325,9 +344,9 @@ class TaskJuggler
         RichTextElement.new(@richTextI, :text, @val[0])
       })
       pattern(%w( $QUERY ), lambda {
-        # The ${attribute} syntax is a shortcut for an embedded query inline
-        # function. It can only be used within a ReportTableCell context that
-        # provides a property and a scope property.
+        # The <-attributeID-> syntax is a shortcut for an embedded query
+        # inline function. It can only be used within a ReportTableCell
+        # context that provides a property and a scope property.
         el = RichTextElement.new(@richTextI, :inlinefunc)
         # Data is a 2 element Array with the function name and a Hash for the
         # arguments.

data/lib/ScenarioData.rb

@@ -12,7 +12,7 @@
 
 
 require 'TjException'
-require 'Message'
+require 'MessageHandler'
 
 class TaskJuggler
 
@@ -31,36 +31,27 @@ class TaskJuggler
       @attributes[attributeName].value
     end
 
-    def error(id, text, abort = true, sourceFileInfo = nil)
-      message = Message.new(id, 'error', text, @property,
-                            @project.scenario(@scenarioIdx),
-                            sourceFileInfo.nil? ?
-                            @property.sourceFileInfo : sourceFileInfo)
-      @project.sendMessage(message)
-      raise TjException.new, "Scheduling error" if abort
+    def error(id, text, sourceFileInfo = nil, property = nil)
+      @project.messageHandler.error(
+        id, text, sourceFileInfo || @property.sourceFileInfo, nil,
+        property || @property,
+        @project.scenario(@scenarioIdx))
     end
 
-    def warning(id, text)
-      message = Message.new(id, 'warning', text, @property,
-                            @project.scenario(@scenarioIdx),
-                            @property.sourceFileInfo)
-      @project.sendMessage(message)
+    def warning(id, text, sourceFileInfo = nil, property = nil)
+      @project.messageHandler.warning(
+        id, text, sourceFileInfo || @property.sourceFileInfo, nil,
+        property || @property,
+        @project.scenario(@scenarioIdx))
     end
 
-    def info(id, text, property = nil)
-      property = @property if property.nil?
-      message = Message.new(id, 'info', text, property,
-                            @project.scenario(@scenarioIdx),
-                            property.sourceFileInfo)
-      @project.sendMessage(message)
+    def info(id, text, sourceFileInfo = nil, property = nil)
+      @project.messageHandler.info(
+        id, text, sourceFileInfo || @property.sourceFileInfo, nil,
+        property || @property,
+        @project.scenario(@scenarioIdx))
     end
 
-    # Not sure why this method was put there. If needed, it should in
-    # PropertyTreeNode!
-    #def query_id(query)
-    #  query.sortable = query.string = @property.fullId
-    #end
-
   end
 
 end

data/lib/SheetHandlerBase.rb

@@ -11,8 +11,9 @@
 #
 
 require 'mail'
-
 require 'UTF8String'
+require 'RichText'
+require 'HTMLDocument'
 
 class TaskJuggler
 
@@ -152,6 +153,24 @@ class TaskJuggler
       end
     end
 
+    # Like SheetHandlerBase::sendEmail but interpretes the _message_ as
+    # RichText markup. The generated mail will have a text/plain and a
+    # text/html part.
+    def sendRichTextEmail(to, subject, message, attachment = nil, from = nil,
+                          inReplyTo = nil)
+      rti = RichText.new(message).generateIntermediateFormat
+      rti.lineWidth = 72
+      rti.indent = 2
+      rti.titleIndent = 0
+      rti.listIndent = 2
+      rti.parIndent = 2
+      rti.preIndent = 4
+      rti.sectionNumbers = false
+
+      # Send out the email.
+      sendEmail(to, subject, rti, attachment, from, inReplyTo)
+    end
+
     def sendEmail(to, subject, message, attachment = nil, from = nil,
                   inReplyTo = nil)
       Mail.defaults do
@@ -162,12 +181,20 @@ class TaskJuggler
       end
 
       begin
+        self_ = self
         mail = Mail.new do
           subject subject
           text_part do
             content_type [ 'text', 'plain', { 'charset' => 'UTF-8' } ]
             content_transfer_encoding 'quoted-printable'
-            body message.to_quoted_printable
+            body message.to_s.to_quoted_printable
+          end
+          if message.is_a?(RichTextIntermediate)
+            html_part do
+              content_type 'text/html; charset=UTF-8'
+              content_transfer_encoding 'quoted-printable'
+              body self_.htmlMailBody(message).to_quoted_printable
+            end
           end
         end
         mail.to = to
@@ -210,6 +237,36 @@ class TaskJuggler
       end
     end
 
+    def htmlMailBody(message)
+      html = HTMLDocument.new
+      head = html.generateHead("TaskJuggler Report - #{@name}",
+                               'description' => 'TaskJuggler Report',
+                               'keywords' => 'taskjuggler, project, management')
+
+      auxSrcDir = AppConfig.dataDirs('data/css')[0]
+      cssFileName = (auxSrcDir ? auxSrcDir + '/tjreport.css' : '')
+      # Raise an error if we haven't found the data directory
+      if auxSrcDir.nil? || !File.exists?(cssFileName)
+        dataDirError(cssFileName)
+      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)
+
+      html << (body = XMLElement.new('body'))
+      body << message.to_html
+
+      html.to_s
+    end
+
   end
 
 end

data/lib/SheetReceiver.rb

@@ -15,6 +15,7 @@ require 'mail'
 require 'open4'
 require 'yaml'
 require 'SheetHandlerBase'
+require 'RichText'
 
 class TaskJuggler
 
@@ -42,7 +43,7 @@ class TaskJuggler
       # The subject of the confirmation email
       @emailSubject = nil
 
-      # Regular expressions to identify a status sheet.
+      # Regular expressions to identify a sheet.
       @sheetHeader = nil
       # Regular expression to extract the sheet signature (date).
       @signatureFilter = nil
@@ -75,14 +76,34 @@ class TaskJuggler
 
       createDirectories
 
+      # Read the RFC 822 compliant mail from STDIN.
+      rawMail = $stdin.read
+
+      # To get line-accurate error reports for encoding errors, we scan the
+      # email for obvious ecoding errors and try to get a sender fallback
+      # address. This will not find encoding problems inside encoded mime
+      # parts.
+      fromLine = nil
       begin
-        rawMail = $stdin.read
+        rawMail.each_line do |line|
+          unless fromLine
+            matches = line.encode('UTF-8', :invalid => :replace,
+                                            :replace => '?').match('^From: .*')
+            fromLine = matches[0] if matches
+          end
+          begin
+            # Try the encoding. If it fails, we'll get an exception.
+            line.encode!('UTF-8')
+          rescue
+            raise "Encoding error in line: #{line.encode('UTF-8', :invalid)}"
+          end
+        end
+
         mail = Mail.new(rawMail)
       rescue
         # Try to extract the mail sender the dirty way so we can at least send
         # a response to the submitter.
-        fromLine = rawMail.match('^From: .*')[0]
-        @submitter = fromLine[6..-1] if fromLine.is_a?(String)
+        @submitter = fromLine[6..-1] if fromLine && fromLine.is_a?(String)
         error("Incoming mail could not be processed: #{$!}")
       end
 
@@ -125,14 +146,6 @@ EOT
 
     # Isolate the actual syntax from _sheet_ and process it.
     def processSheet(sheet)
-      # Make sure the sheet is really valid UTF-8
-      begin
-        sheet.encode!('UTF-8')
-      rescue
-        error("The sheet contains badly encoded characters. #{$!}")
-      end
-      # Store the detected sheet so we can include it with error reports if
-      # needed.
       @sheet = fixLineBreaks(sheet)
       @sheet = cutOut(@sheet) unless @sheetWasAttached
       # A valid sheet must have the poper header line.
@@ -170,6 +183,8 @@ EOT
           # Send the report to the tj3client process via stdin.
           stdin.write(sheet)
           stdin.close
+          # Without errors, the incoming report is pretty printed and returned
+          # in RichText format.
           @report = stdout.read
           @warnings = stderr.read
         end
@@ -217,27 +232,29 @@ EOT
       end
 
       text = <<"EOT"
-Report from #{getResourceName} for the period ending #{@date}:
+== Report from #{getResourceName} for the period ending #{@date} ==
 
 EOT
 
       # Add warnings if we had any.
       unless @warnings.empty?
         text += <<"EOT"
+----
 Your report does contain some issues that you may want to fix or address with
 your manager or project manager:
 
-#{@warnings}
+<nowiki>#{@warnings}</nowiki>
 
+----
 EOT
       end
 
-      # Append the pretty printed version of the submitted status sheet.
+      # Append the pretty printed version of the submitted sheet.
       text += @report
 
       # Send out the email.
-      sendEmail(@submitter, sprintf(@emailSubject, getResourceName, @date), text,
-                nil, nil, @messageId)
+      sendRichTextEmail(@submitter, sprintf(@emailSubject, getResourceName,
+                                            @date), text, nil, nil, @messageId)
       true
     end
 
@@ -312,7 +329,8 @@ EOT
       rescue
       end
 
-      sendEmail(@submitter, "Your #{@sheetType} sheet submission failed!", message)
+      sendEmail(@submitter, "Your #{@sheetType} sheet submission failed!",
+                message)
 
       exit 1
     end