diff lib/redmine/export/pdf.rb @ 441:cbce1fd3b1b7 redmine-1.2

Update to Redmine 1.2-stable branch (Redmine SVN rev 6000)

--- a/lib/redmine/export/pdf.rb	Thu Mar 03 11:42:28 2011 +0000
+++ b/lib/redmine/export/pdf.rb	Mon Jun 06 14:24:13 2011 +0100
@@ -1,72 +1,81 @@
 # encoding: utf-8
 #
 # Redmine - project management software
-# Copyright (C) 2006-2009  Jean-Philippe Lang
+# Copyright (C) 2006-2011  Jean-Philippe Lang
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # as published by the Free Software Foundation; either version 2
 # of the License, or (at your option) any later version.
-# 
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 require 'iconv'
 require 'rfpdf/fpdf'
-require 'rfpdf/chinese'
+require 'fpdf/chinese'
+require 'fpdf/japanese'
+require 'fpdf/korean'
 
 module Redmine
   module Export
     module PDF
       include ActionView::Helpers::TextHelper
       include ActionView::Helpers::NumberHelper
-      
-      class IFPDF < FPDF
+
+      class ITCPDF < TCPDF
         include Redmine::I18n
         attr_accessor :footer_date
-        
+
         def initialize(lang)
-          super()
           set_language_if_valid lang
-          case current_language.to_s.downcase
-          when 'ko'
+          pdf_encoding = l(:general_pdf_encoding).upcase
+          if RUBY_VERSION < '1.9'
+            @ic = Iconv.new(pdf_encoding, 'UTF-8')
+          end
+          super('P', 'mm', 'A4', (pdf_encoding == 'UTF-8'), pdf_encoding)
+          case pdf_encoding
+          when 'UTF-8'
+            @font_for_content = 'FreeSans'
+            @font_for_footer  = 'FreeSans'
+          when 'CP949'
             extend(PDF_Korean)
             AddUHCFont()
             @font_for_content = 'UHC'
-            @font_for_footer = 'UHC'
-          when 'ja'
+            @font_for_footer  = 'UHC'
+          when 'CP932'
             extend(PDF_Japanese)
             AddSJISFont()
             @font_for_content = 'SJIS'
-            @font_for_footer = 'SJIS'
-          when 'zh'
+            @font_for_footer  = 'SJIS'
+          when 'GB18030'
             extend(PDF_Chinese)
             AddGBFont()
             @font_for_content = 'GB'
-            @font_for_footer = 'GB'
-          when 'zh-tw'
+            @font_for_footer  = 'GB'
+          when 'BIG5'
             extend(PDF_Chinese)
             AddBig5Font()
             @font_for_content = 'Big5'
-            @font_for_footer = 'Big5'
+            @font_for_footer  = 'Big5'
           else
             @font_for_content = 'Arial'
-            @font_for_footer = 'Helvetica'              
+            @font_for_footer  = 'Helvetica'
           end
           SetCreator(Redmine::Info.app_name)
           SetFont(@font_for_content)
         end
-        
+
         def SetFontStyle(style, size)
           SetFont(@font_for_content, style, size)
         end
-        
+
         def SetTitle(txt)
           txt = begin
             utf16txt = Iconv.conv('UTF-16BE', 'UTF-8', txt)
@@ -78,7 +87,7 @@
           end || ''
           super(txt)
         end
-    
+
         def textstring(s)
           # Format a text string
           if s =~ /^</  # This means the string is hex-dumped.
@@ -87,80 +96,98 @@
             return '('+escape(s)+')'
           end
         end
-          
-        def Cell(w,h=0,txt='',border=0,ln=0,align='',fill=0,link='')
-          @ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8')
-          # these quotation marks are not correctly rendered in the pdf
-          txt = txt.gsub(/[“�]/, '"') if txt
-          txt = begin
-            # 0x5c char handling
-            txtar = txt.split('\\')
-            txtar << '' if txt[-1] == ?\\
-            txtar.collect {|x| @ic.iconv(x)}.join('\\').gsub(/\\/, "\\\\\\\\")
-          rescue
-            txt
-          end || ''
-          super w,h,txt,border,ln,align,fill,link
+
+        def fix_text_encoding(txt)
+          RDMPdfEncoding::rdm_pdf_iconv(@ic, txt)
         end
-        
+
+        def RDMCell(w,h=0,txt='',border=0,ln=0,align='',fill=0,link='')
+          Cell(w,h,fix_text_encoding(txt),border,ln,align,fill,link)
+        end
+
+        def RDMMultiCell(w,h=0,txt='',border=0,align='',fill=0)
+          MultiCell(w,h,fix_text_encoding(txt),border,align,fill)
+        end
+
         def Footer
           SetFont(@font_for_footer, 'I', 8)
           SetY(-15)
           SetX(15)
-          Cell(0, 5, @footer_date, 0, 0, 'L')
+          RDMCell(0, 5, @footer_date, 0, 0, 'L')
           SetY(-15)
           SetX(-30)
-          Cell(0, 5, PageNo().to_s + '/{nb}', 0, 0, 'C')
+          RDMCell(0, 5, PageNo().to_s + '/{nb}', 0, 0, 'C')
         end
       end
-      
+
       # Returns a PDF string of a list of issues
       def issues_to_pdf(issues, project, query)
-        pdf = IFPDF.new(current_language)
+        pdf = ITCPDF.new(current_language)
         title = query.new_record? ? l(:label_issue_plural) : query.name
         title = "#{project} - #{title}" if project
         pdf.SetTitle(title)
-        pdf.AliasNbPages
+        pdf.alias_nb_pages
         pdf.footer_date = format_date(Date.today)
+        pdf.SetAutoPageBreak(false)
         pdf.AddPage("L")
-        
-        row_height = 6
+
+        # Landscape A4 = 210 x 297 mm
+        page_height   = 210
+        page_width    = 297
+        right_margin  = 10
+        bottom_margin = 20
+        col_id_width  = 10
+        row_height    = 5
+
+        # column widths
+        table_width = page_width - right_margin - 10  # fixed left margin
         col_width = []
         unless query.columns.empty?
-          col_width = query.columns.collect {|column| column.name == :subject ? 4.0 : 1.0 }
-          ratio = 262.0 / col_width.inject(0) {|s,w| s += w}
+          col_width = query.columns.collect do |c|
+            (c.name == :subject || (c.is_a?(QueryCustomFieldColumn) && ['string', 'text'].include?(c.custom_field.field_format)))? 4.0 : 1.0
+          end
+          ratio = (table_width - col_id_width) / col_width.inject(0) {|s,w| s += w}
           col_width = col_width.collect {|w| w * ratio}
         end
-        
+
         # title
-        pdf.SetFontStyle('B',11)    
-        pdf.Cell(190,10, title)
+        pdf.SetFontStyle('B',11)
+        pdf.RDMCell(190,10, title)
         pdf.Ln
-        
+
         # headers
         pdf.SetFontStyle('B',8)
         pdf.SetFillColor(230, 230, 230)
-        pdf.Cell(15, row_height, "#", 1, 0, 'L', 1)
-        query.columns.each_with_index do |column, i|
-          pdf.Cell(col_width[i], row_height, column.caption, 1, 0, 'L', 1)
-        end
-        pdf.Ln
-        
+
+        # render it background to find the max height used
+        base_x = pdf.GetX
+        base_y = pdf.GetY
+        max_height = issues_to_pdf_write_cells(pdf, query.columns, col_width, row_height, true)
+        pdf.Rect(base_x, base_y, table_width, max_height, 'FD');
+        pdf.SetXY(base_x, base_y);
+
+        # write the cells on page
+        pdf.RDMCell(col_id_width, row_height, "#", "T", 0, 'C', 1)
+        issues_to_pdf_write_cells(pdf, query.columns, col_width, row_height, true)
+        issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
+        pdf.SetY(base_y + max_height);
+
         # rows
         pdf.SetFontStyle('',8)
         pdf.SetFillColor(255, 255, 255)
         previous_group = false
         issues.each do |issue|
-          if query.grouped? && (group = query.group_by_column.value(issue)) != previous_group
+          if query.grouped? &&
+               (group = query.group_by_column.value(issue)) != previous_group
             pdf.SetFontStyle('B',9)
-            pdf.Cell(277, row_height, 
+            pdf.RDMCell(277, row_height,
               (group.blank? ? 'None' : group.to_s) + " (#{query.issue_count_by_group[group]})",
               1, 1, 'L')
             pdf.SetFontStyle('',8)
             previous_group = group
           end
-          pdf.Cell(15, row_height, issue.id.to_s, 1, 0, 'L', 1)
-          query.columns.each_with_index do |column, i|
+          # fetch all the row values
+          col_values = query.columns.collect do |column|
             s = if column.is_a?(QueryCustomFieldColumn)
               cv = issue.custom_values.detect {|v| v.custom_field_id == column.custom_field.id}
               show_value(cv)
@@ -174,144 +201,230 @@
                 value
               end
             end
-            pdf.Cell(col_width[i], row_height, s.to_s, 1, 0, 'L', 1)
+            s.to_s
           end
-          pdf.Ln
+
+          # render it off-page to find the max height used
+          base_x = pdf.GetX
+          base_y = pdf.GetY
+          pdf.SetY(2 * page_height)
+          max_height = issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
+          pdf.SetXY(base_x, base_y)
+
+          # make new page if it doesn't fit on the current one
+          space_left = page_height - base_y - bottom_margin
+          if max_height > space_left
+            pdf.AddPage("L")
+            base_x = pdf.GetX
+            base_y = pdf.GetY
+          end
+
+          # write the cells on page
+          pdf.RDMCell(col_id_width, row_height, issue.id.to_s, "T", 0, 'C', 1)
+          issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
+          issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
+          pdf.SetY(base_y + max_height);
         end
+
         if issues.size == Setting.issues_export_limit.to_i
           pdf.SetFontStyle('B',10)
-          pdf.Cell(0, row_height, '...')
+          pdf.RDMCell(0, row_height, '...')
         end
         pdf.Output
       end
 
+      # Renders MultiCells and returns the maximum height used
+      def issues_to_pdf_write_cells(pdf, col_values, col_widths,
+                                    row_height, head=false)
+        base_y = pdf.GetY
+        max_height = row_height
+        col_values.each_with_index do |column, i|
+          col_x = pdf.GetX
+          if head == true
+            pdf.RDMMultiCell(col_widths[i], row_height, column.caption, "T", 'L', 1)
+          else
+            pdf.RDMMultiCell(col_widths[i], row_height, column, "T", 'L', 1)
+          end
+          max_height = (pdf.GetY - base_y) if (pdf.GetY - base_y) > max_height
+          pdf.SetXY(col_x + col_widths[i], base_y);
+        end
+        return max_height
+      end
+
+      # Draw lines to close the row (MultiCell border drawing in not uniform)
+      def issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y,
+                                     id_width, col_widths)
+        col_x = top_x + id_width
+        pdf.Line(col_x, top_y, col_x, lower_y)    # id right border
+        col_widths.each do |width|
+          col_x += width
+          pdf.Line(col_x, top_y, col_x, lower_y)  # columns right border
+        end
+        pdf.Line(top_x, top_y, top_x, lower_y)    # left border
+        pdf.Line(top_x, lower_y, col_x, lower_y)  # bottom border
+      end
+
       # Returns a PDF string of a single issue
       def issue_to_pdf(issue)
-        pdf = IFPDF.new(current_language)
+        pdf = ITCPDF.new(current_language)
         pdf.SetTitle("#{issue.project} - ##{issue.tracker} #{issue.id}")
-        pdf.AliasNbPages
+        pdf.alias_nb_pages
         pdf.footer_date = format_date(Date.today)
         pdf.AddPage
-        
-        pdf.SetFontStyle('B',11)    
-        pdf.Cell(190,10, "#{issue.project} - #{issue.tracker} # #{issue.id}: #{issue.subject}")
+        pdf.SetFontStyle('B',11)
+        pdf.RDMMultiCell(190,5,
+             "#{issue.project} - #{issue.tracker} # #{issue.id}: #{issue.subject}")
         pdf.Ln
-        
+
         y0 = pdf.GetY
-        
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_status) + ":","LT")
+        pdf.RDMCell(35,5, l(:field_status) + ":","LT")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, issue.status.to_s,"RT")
+        pdf.RDMCell(60,5, issue.status.to_s,"RT")
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_priority) + ":","LT")
+        pdf.RDMCell(35,5, l(:field_priority) + ":","LT")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, issue.priority.to_s,"RT")        
+        pdf.RDMCell(60,5, issue.priority.to_s,"RT")
         pdf.Ln
-        
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_author) + ":","L")
+        pdf.RDMCell(35,5, l(:field_author) + ":","L")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, issue.author.to_s,"R")
+        pdf.RDMCell(60,5, issue.author.to_s,"R")
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_category) + ":","L")
+        pdf.RDMCell(35,5, l(:field_category) + ":","L")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, issue.category.to_s,"R")
-        pdf.Ln   
-        
+        pdf.RDMCell(60,5, issue.category.to_s,"R")
+        pdf.Ln
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_created_on) + ":","L")
+        pdf.RDMCell(35,5, l(:field_created_on) + ":","L")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, format_date(issue.created_on),"R")
+        pdf.RDMCell(60,5, format_date(issue.created_on),"R")
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_assigned_to) + ":","L")
+        pdf.RDMCell(35,5, l(:field_assigned_to) + ":","L")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, issue.assigned_to.to_s,"R")
+        pdf.RDMCell(60,5, issue.assigned_to.to_s,"R")
         pdf.Ln
-        
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_updated_on) + ":","LB")
+        pdf.RDMCell(35,5, l(:field_updated_on) + ":","LB")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, format_date(issue.updated_on),"RB")
+        pdf.RDMCell(60,5, format_date(issue.updated_on),"RB")
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_due_date) + ":","LB")
+        pdf.RDMCell(35,5, l(:field_due_date) + ":","LB")
         pdf.SetFontStyle('',9)
-        pdf.Cell(60,5, format_date(issue.due_date),"RB")
+        pdf.RDMCell(60,5, format_date(issue.due_date),"RB")
         pdf.Ln
-        
+
         for custom_value in issue.custom_field_values
           pdf.SetFontStyle('B',9)
-          pdf.Cell(35,5, custom_value.custom_field.name + ":","L")
+          pdf.RDMCell(35,5, custom_value.custom_field.name + ":","L")
           pdf.SetFontStyle('',9)
-          pdf.MultiCell(155,5, (show_value custom_value),"R")
+          pdf.RDMMultiCell(155,5, (show_value custom_value),"R")
         end
-        
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_subject) + ":","LTB")
+        pdf.RDMCell(35,5, l(:field_subject) + ":","LT")
         pdf.SetFontStyle('',9)
-        pdf.Cell(155,5, issue.subject,"RTB")
-        pdf.Ln    
-        
+        pdf.RDMMultiCell(155,5, issue.subject,"RT")
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(35,5, l(:field_description) + ":")
+        pdf.RDMCell(35,5, l(:field_description) + ":","LT")
         pdf.SetFontStyle('',9)
-        pdf.MultiCell(155,5, issue.description.to_s,"BR")
-        
+        pdf.RDMMultiCell(155,5, issue.description.to_s,"RT")
+
         pdf.Line(pdf.GetX, y0, pdf.GetX, pdf.GetY)
-        pdf.Line(pdf.GetX, pdf.GetY, 170, pdf.GetY)
+        pdf.Line(pdf.GetX, pdf.GetY, pdf.GetX + 190, pdf.GetY)
         pdf.Ln
-        
-        if issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
+
+        if issue.changesets.any? &&
+             User.current.allowed_to?(:view_changesets, issue.project)
           pdf.SetFontStyle('B',9)
-          pdf.Cell(190,5, l(:label_associated_revisions), "B")
+          pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
           pdf.Ln
           for changeset in issue.changesets
             pdf.SetFontStyle('B',8)
-            pdf.Cell(190,5, format_time(changeset.committed_on) + " - " + changeset.author.to_s)
+            pdf.RDMCell(190,5,
+              format_time(changeset.committed_on) + " - " + changeset.author.to_s)
             pdf.Ln
             unless changeset.comments.blank?
               pdf.SetFontStyle('',8)
-              pdf.MultiCell(190,5, changeset.comments.to_s)
-            end   
+              pdf.RDMMultiCell(190,5, changeset.comments.to_s)
+            end
             pdf.Ln
           end
         end
-        
+
         pdf.SetFontStyle('B',9)
-        pdf.Cell(190,5, l(:label_history), "B")
-        pdf.Ln  
-        for journal in issue.journals.find(:all, :include => [:user, :details], :order => "#{Journal.table_name}.created_on ASC")
+        pdf.RDMCell(190,5, l(:label_history), "B")
+        pdf.Ln
+        for journal in issue.journals.find(
+                          :all, :include => [:user, :details],
+                          :order => "#{Journal.table_name}.created_on ASC")
           pdf.SetFontStyle('B',8)
-          pdf.Cell(190,5, format_time(journal.created_on) + " - " + journal.user.name)
+          pdf.RDMCell(190,5,
+             format_time(journal.created_on) + " - " + journal.user.name)
           pdf.Ln
           pdf.SetFontStyle('I',8)
           for detail in journal.details
-            pdf.Cell(190,5, "- " + show_detail(detail, true))
-            pdf.Ln
+            pdf.RDMMultiCell(190,5, "- " + show_detail(detail, true))
           end
           if journal.notes?
+            pdf.Ln unless journal.details.empty?
             pdf.SetFontStyle('',8)
-            pdf.MultiCell(190,5, journal.notes.to_s)
-          end   
+            pdf.RDMMultiCell(190,5, journal.notes.to_s)
+          end
           pdf.Ln
         end
-        
+
         if issue.attachments.any?
           pdf.SetFontStyle('B',9)
-          pdf.Cell(190,5, l(:label_attachment_plural), "B")
+          pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
           pdf.Ln
           for attachment in issue.attachments
             pdf.SetFontStyle('',8)
-            pdf.Cell(80,5, attachment.filename)
-            pdf.Cell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
-            pdf.Cell(25,5, format_date(attachment.created_on),0,0,"R")
-            pdf.Cell(65,5, attachment.author.name,0,0,"R")
+            pdf.RDMCell(80,5, attachment.filename)
+            pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
+            pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
+            pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
             pdf.Ln
           end
         end
         pdf.Output
       end
 
+      class RDMPdfEncoding
+        include Redmine::I18n
+        def self.rdm_pdf_iconv(ic, txt)
+          txt ||= ''
+          if txt.respond_to?(:force_encoding)
+            txt.force_encoding('UTF-8')
+            if l(:general_pdf_encoding).upcase != 'UTF-8'
+              txt = txt.encode(l(:general_pdf_encoding), :invalid => :replace,
+                               :undef => :replace, :replace => '?')
+            else
+              txt = Redmine::CodesetUtil.replace_invalid_utf8(txt)
+            end
+            txt.force_encoding('ASCII-8BIT')
+          else
+            ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8')
+            txtar = ""
+            begin
+              txtar += ic.iconv(txt)
+            rescue Iconv::IllegalSequence
+              txtar += $!.success
+              txt = '?' + $!.failed[1,$!.failed.length]
+              retry
+            rescue
+              txtar += $!.success
+            end
+            txt = txtar
+          end
+          txt
+        end
+      end
     end
   end
 end