annotate lib/redmine/export/pdf.rb @ 1628:9c5f8e24dadc live tip

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