annotate lib/redmine/export/pdf.rb @ 1459:cf78a7ade302 luisf

Merge from branch "bug_794"
author luisf <luis.figueira@eecs.qmul.ac.uk>
date Mon, 11 Nov 2013 18:25:50 +0000
parents 3e4c3460b6ca
children 622f24f53b42 261b3d9a4903
rev   line source
Chris@0 1 # encoding: utf-8
Chris@0 2 #
Chris@0 3 # Redmine - project management software
Chris@1115 4 # Copyright (C) 2006-2012 Jean-Philippe Lang
Chris@0 5 #
Chris@0 6 # This program is free software; you can redistribute it and/or
Chris@0 7 # modify it under the terms of the GNU General Public License
Chris@0 8 # as published by the Free Software Foundation; either version 2
Chris@0 9 # of the License, or (at your option) any later version.
Chris@441 10 #
Chris@0 11 # This program is distributed in the hope that it will be useful,
Chris@0 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@0 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@0 14 # GNU General Public License for more details.
Chris@441 15 #
Chris@0 16 # You should have received a copy of the GNU General Public License
Chris@0 17 # along with this program; if not, write to the Free Software
Chris@0 18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@0 19
Chris@0 20 require 'iconv'
Chris@1115 21 require 'tcpdf'
Chris@441 22 require 'fpdf/chinese'
Chris@441 23 require 'fpdf/japanese'
Chris@441 24 require 'fpdf/korean'
Chris@0 25
Chris@0 26 module Redmine
Chris@0 27 module Export
Chris@0 28 module PDF
Chris@0 29 include ActionView::Helpers::TextHelper
Chris@0 30 include ActionView::Helpers::NumberHelper
Chris@909 31 include IssuesHelper
Chris@441 32
Chris@441 33 class ITCPDF < TCPDF
Chris@0 34 include Redmine::I18n
Chris@0 35 attr_accessor :footer_date
Chris@441 36
Chris@1115 37 def initialize(lang, orientation='P')
Chris@909 38 @@k_path_cache = Rails.root.join('tmp', 'pdf')
Chris@909 39 FileUtils.mkdir_p @@k_path_cache unless File::exist?(@@k_path_cache)
Chris@0 40 set_language_if_valid lang
Chris@441 41 pdf_encoding = l(:general_pdf_encoding).upcase
Chris@1115 42 super(orientation, 'mm', 'A4', (pdf_encoding == 'UTF-8'), pdf_encoding)
Chris@507 43 case current_language.to_s.downcase
Chris@507 44 when 'vi'
Chris@507 45 @font_for_content = 'DejaVuSans'
Chris@507 46 @font_for_footer = 'DejaVuSans'
Chris@0 47 else
Chris@507 48 case pdf_encoding
Chris@507 49 when 'UTF-8'
Chris@507 50 @font_for_content = 'FreeSans'
Chris@507 51 @font_for_footer = 'FreeSans'
Chris@507 52 when 'CP949'
Chris@507 53 extend(PDF_Korean)
Chris@507 54 AddUHCFont()
Chris@507 55 @font_for_content = 'UHC'
Chris@507 56 @font_for_footer = 'UHC'
Chris@507 57 when 'CP932', 'SJIS', 'SHIFT_JIS'
Chris@507 58 extend(PDF_Japanese)
Chris@507 59 AddSJISFont()
Chris@507 60 @font_for_content = 'SJIS'
Chris@507 61 @font_for_footer = 'SJIS'
Chris@507 62 when 'GB18030'
Chris@507 63 extend(PDF_Chinese)
Chris@507 64 AddGBFont()
Chris@507 65 @font_for_content = 'GB'
Chris@507 66 @font_for_footer = 'GB'
Chris@507 67 when 'BIG5'
Chris@507 68 extend(PDF_Chinese)
Chris@507 69 AddBig5Font()
Chris@507 70 @font_for_content = 'Big5'
Chris@507 71 @font_for_footer = 'Big5'
Chris@507 72 else
Chris@507 73 @font_for_content = 'Arial'
Chris@507 74 @font_for_footer = 'Helvetica'
Chris@507 75 end
Chris@0 76 end
Chris@0 77 SetCreator(Redmine::Info.app_name)
Chris@0 78 SetFont(@font_for_content)
Chris@1115 79 @outlines = []
Chris@1115 80 @outlineRoot = nil
Chris@0 81 end
Chris@441 82
Chris@0 83 def SetFontStyle(style, size)
Chris@0 84 SetFont(@font_for_content, style, size)
Chris@0 85 end
Chris@441 86
Chris@0 87 def SetTitle(txt)
Chris@0 88 txt = begin
Chris@0 89 utf16txt = Iconv.conv('UTF-16BE', 'UTF-8', txt)
Chris@0 90 hextxt = "<FEFF" # FEFF is BOM
Chris@0 91 hextxt << utf16txt.unpack("C*").map {|x| sprintf("%02X",x) }.join
Chris@0 92 hextxt << ">"
Chris@0 93 rescue
Chris@0 94 txt
Chris@0 95 end || ''
Chris@0 96 super(txt)
Chris@0 97 end
Chris@441 98
Chris@0 99 def textstring(s)
Chris@0 100 # Format a text string
Chris@0 101 if s =~ /^</ # This means the string is hex-dumped.
Chris@0 102 return s
Chris@0 103 else
Chris@0 104 return '('+escape(s)+')'
Chris@0 105 end
Chris@0 106 end
Chris@441 107
Chris@441 108 def fix_text_encoding(txt)
Chris@909 109 RDMPdfEncoding::rdm_from_utf8(txt, l(:general_pdf_encoding))
Chris@0 110 end
Chris@441 111
Chris@1294 112 def formatted_text(text)
Chris@1294 113 html = Redmine::WikiFormatting.to_html(Setting.text_formatting, text)
Chris@1294 114 # Strip {{toc}} tags
Chris@1294 115 html.gsub!(/<p>\{\{([<>]?)toc\}\}<\/p>/i, '')
Chris@1294 116 html
Chris@1294 117 end
Chris@1294 118
Chris@507 119 def RDMCell(w ,h=0, txt='', border=0, ln=0, align='', fill=0, link='')
Chris@507 120 Cell(w, h, fix_text_encoding(txt), border, ln, align, fill, link)
Chris@441 121 end
Chris@441 122
Chris@507 123 def RDMMultiCell(w, h=0, txt='', border=0, align='', fill=0, ln=1)
Chris@507 124 MultiCell(w, h, fix_text_encoding(txt), border, align, fill, ln)
Chris@441 125 end
Chris@441 126
Chris@909 127 def RDMwriteHTMLCell(w, h, x, y, txt='', attachments=[], border=0, ln=1, fill=0)
Chris@909 128 @attachments = attachments
Chris@909 129 writeHTMLCell(w, h, x, y,
Chris@1294 130 fix_text_encoding(formatted_text(txt)),
Chris@909 131 border, ln, fill)
Chris@909 132 end
Chris@909 133
Chris@909 134 def getImageFilename(attrname)
Chris@909 135 # attrname: general_pdf_encoding string file/uri name
Chris@909 136 atta = RDMPdfEncoding.attach(@attachments, attrname, l(:general_pdf_encoding))
Chris@909 137 if atta
Chris@909 138 return atta.diskfile
Chris@909 139 else
Chris@909 140 return nil
Chris@909 141 end
Chris@909 142 end
Chris@909 143
Chris@0 144 def Footer
Chris@0 145 SetFont(@font_for_footer, 'I', 8)
Chris@0 146 SetY(-15)
Chris@0 147 SetX(15)
Chris@441 148 RDMCell(0, 5, @footer_date, 0, 0, 'L')
Chris@0 149 SetY(-15)
Chris@0 150 SetX(-30)
Chris@441 151 RDMCell(0, 5, PageNo().to_s + '/{nb}', 0, 0, 'C')
Chris@0 152 end
Chris@1115 153
Chris@1115 154 def Bookmark(txt, level=0, y=0)
Chris@1115 155 if (y == -1)
Chris@1115 156 y = GetY()
Chris@1115 157 end
Chris@1115 158 @outlines << {:t => txt, :l => level, :p => PageNo(), :y => (@h - y)*@k}
Chris@1115 159 end
Chris@1115 160
Chris@1115 161 def bookmark_title(txt)
Chris@1115 162 txt = begin
Chris@1115 163 utf16txt = Iconv.conv('UTF-16BE', 'UTF-8', txt)
Chris@1115 164 hextxt = "<FEFF" # FEFF is BOM
Chris@1115 165 hextxt << utf16txt.unpack("C*").map {|x| sprintf("%02X",x) }.join
Chris@1115 166 hextxt << ">"
Chris@1115 167 rescue
Chris@1115 168 txt
Chris@1115 169 end || ''
Chris@1115 170 end
Chris@1115 171
Chris@1115 172 def putbookmarks
Chris@1115 173 nb=@outlines.size
Chris@1115 174 return if (nb==0)
Chris@1115 175 lru=[]
Chris@1115 176 level=0
Chris@1115 177 @outlines.each_with_index do |o, i|
Chris@1115 178 if(o[:l]>0)
Chris@1115 179 parent=lru[o[:l]-1]
Chris@1115 180 #Set parent and last pointers
Chris@1115 181 @outlines[i][:parent]=parent
Chris@1115 182 @outlines[parent][:last]=i
Chris@1115 183 if (o[:l]>level)
Chris@1115 184 #Level increasing: set first pointer
Chris@1115 185 @outlines[parent][:first]=i
Chris@1115 186 end
Chris@1115 187 else
Chris@1115 188 @outlines[i][:parent]=nb
Chris@1115 189 end
Chris@1115 190 if (o[:l]<=level && i>0)
Chris@1115 191 #Set prev and next pointers
Chris@1115 192 prev=lru[o[:l]]
Chris@1115 193 @outlines[prev][:next]=i
Chris@1115 194 @outlines[i][:prev]=prev
Chris@1115 195 end
Chris@1115 196 lru[o[:l]]=i
Chris@1115 197 level=o[:l]
Chris@1115 198 end
Chris@1115 199 #Outline items
Chris@1115 200 n=self.n+1
Chris@1115 201 @outlines.each_with_index do |o, i|
Chris@1115 202 newobj()
Chris@1115 203 out('<</Title '+bookmark_title(o[:t]))
Chris@1115 204 out("/Parent #{n+o[:parent]} 0 R")
Chris@1115 205 if (o[:prev])
Chris@1115 206 out("/Prev #{n+o[:prev]} 0 R")
Chris@1115 207 end
Chris@1115 208 if (o[:next])
Chris@1115 209 out("/Next #{n+o[:next]} 0 R")
Chris@1115 210 end
Chris@1115 211 if (o[:first])
Chris@1115 212 out("/First #{n+o[:first]} 0 R")
Chris@1115 213 end
Chris@1115 214 if (o[:last])
Chris@1115 215 out("/Last #{n+o[:last]} 0 R")
Chris@1115 216 end
Chris@1115 217 out("/Dest [%d 0 R /XYZ 0 %.2f null]" % [1+2*o[:p], o[:y]])
Chris@1115 218 out('/Count 0>>')
Chris@1115 219 out('endobj')
Chris@1115 220 end
Chris@1115 221 #Outline root
Chris@1115 222 newobj()
Chris@1115 223 @outlineRoot=self.n
Chris@1115 224 out("<</Type /Outlines /First #{n} 0 R");
Chris@1115 225 out("/Last #{n+lru[0]} 0 R>>");
Chris@1115 226 out('endobj');
Chris@1115 227 end
Chris@1115 228
Chris@1115 229 def putresources()
Chris@1115 230 super
Chris@1115 231 putbookmarks()
Chris@1115 232 end
Chris@1115 233
Chris@1115 234 def putcatalog()
Chris@1115 235 super
Chris@1115 236 if(@outlines.size > 0)
Chris@1115 237 out("/Outlines #{@outlineRoot} 0 R");
Chris@1115 238 out('/PageMode /UseOutlines');
Chris@1115 239 end
Chris@1115 240 end
Chris@1115 241 end
Chris@1115 242
Chris@1115 243 # fetch row values
Chris@1115 244 def fetch_row_values(issue, query, level)
Chris@1115 245 query.inline_columns.collect do |column|
Chris@1115 246 s = if column.is_a?(QueryCustomFieldColumn)
Chris@1115 247 cv = issue.custom_field_values.detect {|v| v.custom_field_id == column.custom_field.id}
Chris@1115 248 show_value(cv)
Chris@1115 249 else
Chris@1115 250 value = issue.send(column.name)
Chris@1115 251 if column.name == :subject
Chris@1115 252 value = " " * level + value
Chris@1115 253 end
Chris@1115 254 if value.is_a?(Date)
Chris@1115 255 format_date(value)
Chris@1115 256 elsif value.is_a?(Time)
Chris@1115 257 format_time(value)
Chris@1115 258 else
Chris@1115 259 value
Chris@1115 260 end
Chris@1115 261 end
Chris@1115 262 s.to_s
Chris@1115 263 end
Chris@1115 264 end
Chris@1115 265
Chris@1115 266 # calculate columns width
Chris@1115 267 def calc_col_width(issues, query, table_width, pdf)
Chris@1115 268 # calculate statistics
Chris@1115 269 # by captions
Chris@1115 270 pdf.SetFontStyle('B',8)
Chris@1115 271 col_padding = pdf.GetStringWidth('OO')
Chris@1115 272 col_width_min = query.inline_columns.map {|v| pdf.GetStringWidth(v.caption) + col_padding}
Chris@1115 273 col_width_max = Array.new(col_width_min)
Chris@1115 274 col_width_avg = Array.new(col_width_min)
Chris@1115 275 word_width_max = query.inline_columns.map {|c|
Chris@1115 276 n = 10
Chris@1115 277 c.caption.split.each {|w|
Chris@1115 278 x = pdf.GetStringWidth(w) + col_padding
Chris@1115 279 n = x if n < x
Chris@1115 280 }
Chris@1115 281 n
Chris@1115 282 }
Chris@1115 283
Chris@1115 284 # by properties of issues
Chris@1115 285 pdf.SetFontStyle('',8)
Chris@1115 286 col_padding = pdf.GetStringWidth('OO')
Chris@1115 287 k = 1
Chris@1115 288 issue_list(issues) {|issue, level|
Chris@1115 289 k += 1
Chris@1115 290 values = fetch_row_values(issue, query, level)
Chris@1115 291 values.each_with_index {|v,i|
Chris@1115 292 n = pdf.GetStringWidth(v) + col_padding
Chris@1115 293 col_width_max[i] = n if col_width_max[i] < n
Chris@1115 294 col_width_min[i] = n if col_width_min[i] > n
Chris@1115 295 col_width_avg[i] += n
Chris@1115 296 v.split.each {|w|
Chris@1115 297 x = pdf.GetStringWidth(w) + col_padding
Chris@1115 298 word_width_max[i] = x if word_width_max[i] < x
Chris@1115 299 }
Chris@1115 300 }
Chris@1115 301 }
Chris@1115 302 col_width_avg.map! {|x| x / k}
Chris@1115 303
Chris@1115 304 # calculate columns width
Chris@1115 305 ratio = table_width / col_width_avg.inject(0) {|s,w| s += w}
Chris@1115 306 col_width = col_width_avg.map {|w| w * ratio}
Chris@1115 307
Chris@1115 308 # correct max word width if too many columns
Chris@1115 309 ratio = table_width / word_width_max.inject(0) {|s,w| s += w}
Chris@1115 310 word_width_max.map! {|v| v * ratio} if ratio < 1
Chris@1115 311
Chris@1115 312 # correct and lock width of some columns
Chris@1115 313 done = 1
Chris@1115 314 col_fix = []
Chris@1115 315 col_width.each_with_index do |w,i|
Chris@1115 316 if w > col_width_max[i]
Chris@1115 317 col_width[i] = col_width_max[i]
Chris@1115 318 col_fix[i] = 1
Chris@1115 319 done = 0
Chris@1115 320 elsif w < word_width_max[i]
Chris@1115 321 col_width[i] = word_width_max[i]
Chris@1115 322 col_fix[i] = 1
Chris@1115 323 done = 0
Chris@1115 324 else
Chris@1115 325 col_fix[i] = 0
Chris@1115 326 end
Chris@1115 327 end
Chris@1115 328
Chris@1115 329 # iterate while need to correct and lock coluns width
Chris@1115 330 while done == 0
Chris@1115 331 # calculate free & locked columns width
Chris@1115 332 done = 1
Chris@1115 333 fix_col_width = 0
Chris@1115 334 free_col_width = 0
Chris@1115 335 col_width.each_with_index do |w,i|
Chris@1115 336 if col_fix[i] == 1
Chris@1115 337 fix_col_width += w
Chris@1115 338 else
Chris@1115 339 free_col_width += w
Chris@1115 340 end
Chris@1115 341 end
Chris@1115 342
Chris@1115 343 # calculate column normalizing ratio
Chris@1115 344 if free_col_width == 0
Chris@1115 345 ratio = table_width / col_width.inject(0) {|s,w| s += w}
Chris@1115 346 else
Chris@1115 347 ratio = (table_width - fix_col_width) / free_col_width
Chris@1115 348 end
Chris@1115 349
Chris@1115 350 # correct columns width
Chris@1115 351 col_width.each_with_index do |w,i|
Chris@1115 352 if col_fix[i] == 0
Chris@1115 353 col_width[i] = w * ratio
Chris@1115 354
Chris@1115 355 # check if column width less then max word width
Chris@1115 356 if col_width[i] < word_width_max[i]
Chris@1115 357 col_width[i] = word_width_max[i]
Chris@1115 358 col_fix[i] = 1
Chris@1115 359 done = 0
Chris@1115 360 elsif col_width[i] > col_width_max[i]
Chris@1115 361 col_width[i] = col_width_max[i]
Chris@1115 362 col_fix[i] = 1
Chris@1115 363 done = 0
Chris@1115 364 end
Chris@1115 365 end
Chris@1115 366 end
Chris@1115 367 end
Chris@1115 368 col_width
Chris@1115 369 end
Chris@1115 370
Chris@1115 371 def render_table_header(pdf, query, col_width, row_height, col_id_width, table_width)
Chris@1115 372 # headers
Chris@1115 373 pdf.SetFontStyle('B',8)
Chris@1115 374 pdf.SetFillColor(230, 230, 230)
Chris@1115 375
Chris@1115 376 # render it background to find the max height used
Chris@1115 377 base_x = pdf.GetX
Chris@1115 378 base_y = pdf.GetY
Chris@1115 379 max_height = issues_to_pdf_write_cells(pdf, query.inline_columns, col_width, row_height, true)
Chris@1115 380 pdf.Rect(base_x, base_y, table_width + col_id_width, max_height, 'FD');
Chris@1115 381 pdf.SetXY(base_x, base_y);
Chris@1115 382
Chris@1115 383 # write the cells on page
Chris@1115 384 pdf.RDMCell(col_id_width, row_height, "#", "T", 0, 'C', 1)
Chris@1115 385 issues_to_pdf_write_cells(pdf, query.inline_columns, col_width, row_height, true)
Chris@1115 386 issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
Chris@1115 387 pdf.SetY(base_y + max_height);
Chris@1115 388
Chris@1115 389 # rows
Chris@1115 390 pdf.SetFontStyle('',8)
Chris@1115 391 pdf.SetFillColor(255, 255, 255)
Chris@0 392 end
Chris@441 393
Chris@0 394 # Returns a PDF string of a list of issues
Chris@0 395 def issues_to_pdf(issues, project, query)
Chris@1115 396 pdf = ITCPDF.new(current_language, "L")
Chris@0 397 title = query.new_record? ? l(:label_issue_plural) : query.name
Chris@0 398 title = "#{project} - #{title}" if project
Chris@0 399 pdf.SetTitle(title)
Chris@441 400 pdf.alias_nb_pages
Chris@0 401 pdf.footer_date = format_date(Date.today)
Chris@441 402 pdf.SetAutoPageBreak(false)
Chris@0 403 pdf.AddPage("L")
Chris@441 404
Chris@441 405 # Landscape A4 = 210 x 297 mm
Chris@441 406 page_height = 210
Chris@441 407 page_width = 297
Chris@441 408 right_margin = 10
Chris@441 409 bottom_margin = 20
Chris@441 410 col_id_width = 10
Chris@1115 411 row_height = 4
Chris@441 412
Chris@441 413 # column widths
Chris@441 414 table_width = page_width - right_margin - 10 # fixed left margin
Chris@0 415 col_width = []
Chris@1115 416 unless query.inline_columns.empty?
Chris@1115 417 col_width = calc_col_width(issues, query, table_width - col_id_width, pdf)
Chris@1115 418 table_width = col_width.inject(0) {|s,v| s += v}
Chris@1115 419 end
Chris@1115 420
Chris@1115 421 # use full width if the description is displayed
Chris@1115 422 if table_width > 0 && query.has_column?(:description)
Chris@1115 423 col_width = col_width.map {|w| w = w * (page_width - right_margin - 10 - col_id_width) / table_width}
Chris@1115 424 table_width = col_width.inject(0) {|s,v| s += v}
Chris@0 425 end
Chris@441 426
Chris@0 427 # title
Chris@441 428 pdf.SetFontStyle('B',11)
Chris@441 429 pdf.RDMCell(190,10, title)
Chris@0 430 pdf.Ln
Chris@1115 431 render_table_header(pdf, query, col_width, row_height, col_id_width, table_width)
Chris@0 432 previous_group = false
Chris@909 433 issue_list(issues) do |issue, level|
Chris@441 434 if query.grouped? &&
Chris@441 435 (group = query.group_by_column.value(issue)) != previous_group
Chris@1115 436 pdf.SetFontStyle('B',10)
Chris@1115 437 group_label = group.blank? ? 'None' : group.to_s.dup
Chris@1115 438 group_label << " (#{query.issue_count_by_group[group]})"
Chris@1115 439 pdf.Bookmark group_label, 0, -1
Chris@1115 440 pdf.RDMCell(table_width + col_id_width, row_height * 2, group_label, 1, 1, 'L')
Chris@0 441 pdf.SetFontStyle('',8)
Chris@0 442 previous_group = group
Chris@0 443 end
Chris@1115 444
Chris@1115 445 # fetch row values
Chris@1115 446 col_values = fetch_row_values(issue, query, level)
Chris@441 447
Chris@441 448 # render it off-page to find the max height used
Chris@441 449 base_x = pdf.GetX
Chris@441 450 base_y = pdf.GetY
Chris@441 451 pdf.SetY(2 * page_height)
Chris@441 452 max_height = issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
Chris@441 453 pdf.SetXY(base_x, base_y)
Chris@441 454
Chris@441 455 # make new page if it doesn't fit on the current one
Chris@441 456 space_left = page_height - base_y - bottom_margin
Chris@441 457 if max_height > space_left
Chris@441 458 pdf.AddPage("L")
Chris@1115 459 render_table_header(pdf, query, col_width, row_height, col_id_width, table_width)
Chris@441 460 base_x = pdf.GetX
Chris@441 461 base_y = pdf.GetY
Chris@441 462 end
Chris@441 463
Chris@441 464 # write the cells on page
Chris@441 465 pdf.RDMCell(col_id_width, row_height, issue.id.to_s, "T", 0, 'C', 1)
Chris@441 466 issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
Chris@441 467 issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
Chris@441 468 pdf.SetY(base_y + max_height);
Chris@1115 469
Chris@1115 470 if query.has_column?(:description) && issue.description?
Chris@1115 471 pdf.SetX(10)
Chris@1115 472 pdf.SetAutoPageBreak(true, 20)
Chris@1115 473 pdf.RDMwriteHTMLCell(0, 5, 10, 0, issue.description.to_s, issue.attachments, "LRBT")
Chris@1115 474 pdf.SetAutoPageBreak(false)
Chris@1115 475 end
Chris@0 476 end
Chris@441 477
Chris@0 478 if issues.size == Setting.issues_export_limit.to_i
Chris@0 479 pdf.SetFontStyle('B',10)
Chris@441 480 pdf.RDMCell(0, row_height, '...')
Chris@0 481 end
Chris@0 482 pdf.Output
Chris@0 483 end
chris@22 484
Chris@441 485 # Renders MultiCells and returns the maximum height used
Chris@441 486 def issues_to_pdf_write_cells(pdf, col_values, col_widths,
Chris@441 487 row_height, head=false)
Chris@441 488 base_y = pdf.GetY
Chris@441 489 max_height = row_height
Chris@441 490 col_values.each_with_index do |column, i|
Chris@441 491 col_x = pdf.GetX
Chris@441 492 if head == true
Chris@441 493 pdf.RDMMultiCell(col_widths[i], row_height, column.caption, "T", 'L', 1)
Chris@441 494 else
Chris@441 495 pdf.RDMMultiCell(col_widths[i], row_height, column, "T", 'L', 1)
Chris@441 496 end
Chris@441 497 max_height = (pdf.GetY - base_y) if (pdf.GetY - base_y) > max_height
Chris@441 498 pdf.SetXY(col_x + col_widths[i], base_y);
Chris@441 499 end
Chris@441 500 return max_height
Chris@441 501 end
Chris@441 502
Chris@441 503 # Draw lines to close the row (MultiCell border drawing in not uniform)
Chris@441 504 def issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y,
Chris@441 505 id_width, col_widths)
Chris@441 506 col_x = top_x + id_width
Chris@441 507 pdf.Line(col_x, top_y, col_x, lower_y) # id right border
Chris@441 508 col_widths.each do |width|
Chris@441 509 col_x += width
Chris@441 510 pdf.Line(col_x, top_y, col_x, lower_y) # columns right border
Chris@441 511 end
Chris@441 512 pdf.Line(top_x, top_y, top_x, lower_y) # left border
Chris@441 513 pdf.Line(top_x, lower_y, col_x, lower_y) # bottom border
Chris@441 514 end
Chris@441 515
Chris@0 516 # Returns a PDF string of a single issue
Chris@1115 517 def issue_to_pdf(issue, assoc={})
Chris@441 518 pdf = ITCPDF.new(current_language)
Chris@1115 519 pdf.SetTitle("#{issue.project} - #{issue.tracker} ##{issue.id}")
Chris@441 520 pdf.alias_nb_pages
Chris@0 521 pdf.footer_date = format_date(Date.today)
Chris@0 522 pdf.AddPage
Chris@441 523 pdf.SetFontStyle('B',11)
Chris@1115 524 buf = "#{issue.project} - #{issue.tracker} ##{issue.id}"
Chris@909 525 pdf.RDMMultiCell(190, 5, buf)
Chris@909 526 pdf.SetFontStyle('',8)
Chris@909 527 base_x = pdf.GetX
Chris@909 528 i = 1
Chris@1115 529 issue.ancestors.visible.each do |ancestor|
Chris@909 530 pdf.SetX(base_x + i)
Chris@909 531 buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}"
Chris@909 532 pdf.RDMMultiCell(190 - i, 5, buf)
Chris@909 533 i += 1 if i < 35
Chris@909 534 end
Chris@1115 535 pdf.SetFontStyle('B',11)
Chris@1115 536 pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
Chris@1115 537 pdf.SetFontStyle('',8)
Chris@1115 538 pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
Chris@0 539 pdf.Ln
Chris@441 540
Chris@1115 541 left = []
Chris@1115 542 left << [l(:field_status), issue.status]
Chris@1115 543 left << [l(:field_priority), issue.priority]
Chris@1115 544 left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?('assigned_to_id')
Chris@1115 545 left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?('category_id')
Chris@1115 546 left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?('fixed_version_id')
Chris@441 547
Chris@1115 548 right = []
Chris@1115 549 right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?('start_date')
Chris@1115 550 right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?('due_date')
Chris@1115 551 right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?('done_ratio')
Chris@1115 552 right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?('estimated_hours')
Chris@1115 553 right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
Chris@441 554
Chris@1115 555 rows = left.size > right.size ? left.size : right.size
Chris@1115 556 while left.size < rows
Chris@1115 557 left << nil
Chris@1115 558 end
Chris@1115 559 while right.size < rows
Chris@1115 560 right << nil
Chris@0 561 end
Chris@441 562
Chris@1115 563 half = (issue.custom_field_values.size / 2.0).ceil
Chris@1115 564 issue.custom_field_values.each_with_index do |custom_value, i|
Chris@1115 565 (i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value)]
Chris@1115 566 end
Chris@507 567
Chris@1115 568 rows = left.size > right.size ? left.size : right.size
Chris@1115 569 rows.times do |i|
Chris@1115 570 item = left[i]
Chris@1115 571 pdf.SetFontStyle('B',9)
Chris@1115 572 pdf.RDMCell(35,5, item ? "#{item.first}:" : "", i == 0 ? "LT" : "L")
Chris@1115 573 pdf.SetFontStyle('',9)
Chris@1115 574 pdf.RDMCell(60,5, item ? item.last.to_s : "", i == 0 ? "RT" : "R")
Chris@1115 575
Chris@1115 576 item = right[i]
Chris@1115 577 pdf.SetFontStyle('B',9)
Chris@1115 578 pdf.RDMCell(35,5, item ? "#{item.first}:" : "", i == 0 ? "LT" : "L")
Chris@1115 579 pdf.SetFontStyle('',9)
Chris@1115 580 pdf.RDMCell(60,5, item ? item.last.to_s : "", i == 0 ? "RT" : "R")
Chris@1115 581 pdf.Ln
Chris@1115 582 end
Chris@441 583
Chris@0 584 pdf.SetFontStyle('B',9)
Chris@507 585 pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
Chris@0 586 pdf.SetFontStyle('',9)
Chris@909 587
Chris@909 588 # Set resize image scale
Chris@909 589 pdf.SetImageScale(1.6)
Chris@909 590 pdf.RDMwriteHTMLCell(35+155, 5, 0, 0,
Chris@909 591 issue.description.to_s, issue.attachments, "LRB")
Chris@909 592
Chris@909 593 unless issue.leaf?
Chris@909 594 # for CJK
Chris@909 595 truncate_length = ( l(:general_pdf_encoding).upcase == "UTF-8" ? 90 : 65 )
Chris@1115 596
Chris@909 597 pdf.SetFontStyle('B',9)
Chris@909 598 pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR")
Chris@909 599 pdf.Ln
Chris@1115 600 issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
Chris@909 601 buf = truncate("#{child.tracker} # #{child.id}: #{child.subject}",
Chris@909 602 :length => truncate_length)
Chris@909 603 level = 10 if level >= 10
Chris@909 604 pdf.SetFontStyle('',8)
Chris@909 605 pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, "L")
Chris@909 606 pdf.SetFontStyle('B',8)
Chris@909 607 pdf.RDMCell(20,5, child.status.to_s, "R")
Chris@909 608 pdf.Ln
Chris@909 609 end
Chris@909 610 end
Chris@909 611
Chris@909 612 relations = issue.relations.select { |r| r.other_issue(issue).visible? }
Chris@909 613 unless relations.empty?
Chris@909 614 # for CJK
Chris@909 615 truncate_length = ( l(:general_pdf_encoding).upcase == "UTF-8" ? 80 : 60 )
Chris@1115 616
Chris@909 617 pdf.SetFontStyle('B',9)
Chris@909 618 pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR")
Chris@909 619 pdf.Ln
Chris@909 620 relations.each do |relation|
Chris@909 621 buf = ""
Chris@909 622 buf += "#{l(relation.label_for(issue))} "
Chris@909 623 if relation.delay && relation.delay != 0
Chris@909 624 buf += "(#{l('datetime.distance_in_words.x_days', :count => relation.delay)}) "
Chris@909 625 end
Chris@909 626 if Setting.cross_project_issue_relations?
Chris@909 627 buf += "#{relation.other_issue(issue).project} - "
Chris@909 628 end
Chris@909 629 buf += "#{relation.other_issue(issue).tracker}" +
Chris@909 630 " # #{relation.other_issue(issue).id}: #{relation.other_issue(issue).subject}"
Chris@909 631 buf = truncate(buf, :length => truncate_length)
Chris@909 632 pdf.SetFontStyle('', 8)
Chris@909 633 pdf.RDMCell(35+155-60, 5, buf, "L")
Chris@909 634 pdf.SetFontStyle('B',8)
Chris@909 635 pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "")
Chris@909 636 pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "")
Chris@909 637 pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), "R")
Chris@909 638 pdf.Ln
Chris@909 639 end
Chris@909 640 end
Chris@909 641 pdf.RDMCell(190,5, "", "T")
Chris@0 642 pdf.Ln
Chris@441 643
Chris@441 644 if issue.changesets.any? &&
Chris@441 645 User.current.allowed_to?(:view_changesets, issue.project)
Chris@0 646 pdf.SetFontStyle('B',9)
Chris@441 647 pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
Chris@0 648 pdf.Ln
Chris@0 649 for changeset in issue.changesets
Chris@0 650 pdf.SetFontStyle('B',8)
Chris@507 651 csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
Chris@507 652 csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
Chris@507 653 pdf.RDMCell(190, 5, csstr)
Chris@0 654 pdf.Ln
Chris@0 655 unless changeset.comments.blank?
Chris@0 656 pdf.SetFontStyle('',8)
Chris@909 657 pdf.RDMwriteHTMLCell(190,5,0,0,
Chris@909 658 changeset.comments.to_s, issue.attachments, "")
Chris@441 659 end
Chris@0 660 pdf.Ln
Chris@0 661 end
Chris@0 662 end
Chris@441 663
Chris@1115 664 if assoc[:journals].present?
Chris@1115 665 pdf.SetFontStyle('B',9)
Chris@1115 666 pdf.RDMCell(190,5, l(:label_history), "B")
Chris@0 667 pdf.Ln
Chris@1115 668 assoc[:journals].each do |journal|
Chris@1115 669 pdf.SetFontStyle('B',8)
Chris@1115 670 title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
Chris@1115 671 title << " (#{l(:field_private_notes)})" if journal.private_notes?
Chris@1115 672 pdf.RDMCell(190,5, title)
Chris@1115 673 pdf.Ln
Chris@1115 674 pdf.SetFontStyle('I',8)
Chris@1115 675 details_to_strings(journal.details, true).each do |string|
Chris@1115 676 pdf.RDMMultiCell(190,5, "- " + string)
Chris@1115 677 end
Chris@1115 678 if journal.notes?
Chris@1115 679 pdf.Ln unless journal.details.empty?
Chris@1115 680 pdf.SetFontStyle('',8)
Chris@1115 681 pdf.RDMwriteHTMLCell(190,5,0,0,
Chris@1115 682 journal.notes.to_s, issue.attachments, "")
Chris@1115 683 end
Chris@1115 684 pdf.Ln
Chris@0 685 end
Chris@0 686 end
Chris@441 687
Chris@0 688 if issue.attachments.any?
Chris@0 689 pdf.SetFontStyle('B',9)
Chris@441 690 pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
Chris@0 691 pdf.Ln
Chris@0 692 for attachment in issue.attachments
Chris@0 693 pdf.SetFontStyle('',8)
Chris@441 694 pdf.RDMCell(80,5, attachment.filename)
Chris@441 695 pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
Chris@441 696 pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
Chris@441 697 pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
Chris@0 698 pdf.Ln
Chris@0 699 end
Chris@0 700 end
Chris@0 701 pdf.Output
Chris@0 702 end
chris@22 703
Chris@1115 704 # Returns a PDF string of a set of wiki pages
Chris@1115 705 def wiki_pages_to_pdf(pages, project)
Chris@1115 706 pdf = ITCPDF.new(current_language)
Chris@1115 707 pdf.SetTitle(project.name)
Chris@1115 708 pdf.alias_nb_pages
Chris@1115 709 pdf.footer_date = format_date(Date.today)
Chris@1115 710 pdf.AddPage
Chris@1115 711 pdf.SetFontStyle('B',11)
Chris@1115 712 pdf.RDMMultiCell(190,5, project.name)
Chris@1115 713 pdf.Ln
Chris@1115 714 # Set resize image scale
Chris@1115 715 pdf.SetImageScale(1.6)
Chris@1115 716 pdf.SetFontStyle('',9)
Chris@1115 717 write_page_hierarchy(pdf, pages.group_by(&:parent_id))
Chris@1115 718 pdf.Output
Chris@1115 719 end
Chris@1115 720
Chris@909 721 # Returns a PDF string of a single wiki page
Chris@1115 722 def wiki_page_to_pdf(page, project)
Chris@909 723 pdf = ITCPDF.new(current_language)
Chris@909 724 pdf.SetTitle("#{project} - #{page.title}")
Chris@909 725 pdf.alias_nb_pages
Chris@909 726 pdf.footer_date = format_date(Date.today)
Chris@909 727 pdf.AddPage
Chris@909 728 pdf.SetFontStyle('B',11)
Chris@909 729 pdf.RDMMultiCell(190,5,
Chris@909 730 "#{project} - #{page.title} - # #{page.content.version}")
Chris@909 731 pdf.Ln
Chris@909 732 # Set resize image scale
Chris@909 733 pdf.SetImageScale(1.6)
Chris@909 734 pdf.SetFontStyle('',9)
Chris@1115 735 write_wiki_page(pdf, page)
Chris@1115 736 pdf.Output
Chris@1115 737 end
Chris@1115 738
Chris@1115 739 def write_page_hierarchy(pdf, pages, node=nil, level=0)
Chris@1115 740 if pages[node]
Chris@1115 741 pages[node].each do |page|
Chris@1115 742 if @new_page
Chris@1115 743 pdf.AddPage
Chris@1115 744 else
Chris@1115 745 @new_page = true
Chris@1115 746 end
Chris@1115 747 pdf.Bookmark page.title, level
Chris@1115 748 write_wiki_page(pdf, page)
Chris@1115 749 write_page_hierarchy(pdf, pages, page.id, level + 1) if pages[page.id]
Chris@1115 750 end
Chris@1115 751 end
Chris@1115 752 end
Chris@1115 753
Chris@1115 754 def write_wiki_page(pdf, page)
Chris@909 755 pdf.RDMwriteHTMLCell(190,5,0,0,
Chris@1115 756 page.content.text.to_s, page.attachments, 0)
Chris@909 757 if page.attachments.any?
Chris@909 758 pdf.Ln
Chris@909 759 pdf.SetFontStyle('B',9)
Chris@909 760 pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
Chris@909 761 pdf.Ln
Chris@909 762 for attachment in page.attachments
Chris@909 763 pdf.SetFontStyle('',8)
Chris@909 764 pdf.RDMCell(80,5, attachment.filename)
Chris@909 765 pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
Chris@909 766 pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
Chris@909 767 pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
Chris@909 768 pdf.Ln
Chris@909 769 end
Chris@909 770 end
Chris@909 771 end
Chris@909 772
Chris@441 773 class RDMPdfEncoding
Chris@909 774 def self.rdm_from_utf8(txt, encoding)
Chris@441 775 txt ||= ''
Chris@909 776 txt = Redmine::CodesetUtil.from_utf8(txt, encoding)
Chris@441 777 if txt.respond_to?(:force_encoding)
Chris@441 778 txt.force_encoding('ASCII-8BIT')
Chris@441 779 end
Chris@441 780 txt
Chris@441 781 end
Chris@909 782
Chris@909 783 def self.attach(attachments, filename, encoding)
Chris@909 784 filename_utf8 = Redmine::CodesetUtil.to_utf8(filename, encoding)
Chris@909 785 atta = nil
Chris@909 786 if filename_utf8 =~ /^[^\/"]+\.(gif|jpg|jpe|jpeg|png)$/i
Chris@909 787 atta = Attachment.latest_attach(attachments, filename_utf8)
Chris@909 788 end
Chris@909 789 if atta && atta.readable? && atta.visible?
Chris@909 790 return atta
Chris@909 791 else
Chris@909 792 return nil
Chris@909 793 end
Chris@909 794 end
Chris@441 795 end
Chris@0 796 end
Chris@0 797 end
Chris@0 798 end