##// END OF EJS Templates
pdf: lib: add a method to export wiki (#401)...
Toshi MARUYAMA -
r7620:1713432ab009
parent child
Show More
@@ -1,452 +1,486
1 1 # encoding: utf-8
2 2 #
3 3 # Redmine - project management software
4 4 # Copyright (C) 2006-2011 Jean-Philippe Lang
5 5 #
6 6 # This program is free software; you can redistribute it and/or
7 7 # modify it under the terms of the GNU General Public License
8 8 # as published by the Free Software Foundation; either version 2
9 9 # of the License, or (at your option) any later version.
10 10 #
11 11 # This program is distributed in the hope that it will be useful,
12 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 14 # GNU General Public License for more details.
15 15 #
16 16 # You should have received a copy of the GNU General Public License
17 17 # along with this program; if not, write to the Free Software
18 18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 19
20 20 require 'iconv'
21 21 require 'rfpdf/fpdf'
22 22 require 'fpdf/chinese'
23 23 require 'fpdf/japanese'
24 24 require 'fpdf/korean'
25 25
26 26 module Redmine
27 27 module Export
28 28 module PDF
29 29 include ActionView::Helpers::TextHelper
30 30 include ActionView::Helpers::NumberHelper
31 31
32 32 class ITCPDF < TCPDF
33 33 include Redmine::I18n
34 34 attr_accessor :footer_date
35 35
36 36 def initialize(lang)
37 37 set_language_if_valid lang
38 38 pdf_encoding = l(:general_pdf_encoding).upcase
39 39 if RUBY_VERSION < '1.9'
40 40 @ic = Iconv.new(pdf_encoding, 'UTF-8')
41 41 end
42 42 super('P', 'mm', 'A4', (pdf_encoding == 'UTF-8'), pdf_encoding)
43 43 case current_language.to_s.downcase
44 44 when 'vi'
45 45 @font_for_content = 'DejaVuSans'
46 46 @font_for_footer = 'DejaVuSans'
47 47 else
48 48 case pdf_encoding
49 49 when 'UTF-8'
50 50 @font_for_content = 'FreeSans'
51 51 @font_for_footer = 'FreeSans'
52 52 when 'CP949'
53 53 extend(PDF_Korean)
54 54 AddUHCFont()
55 55 @font_for_content = 'UHC'
56 56 @font_for_footer = 'UHC'
57 57 when 'CP932', 'SJIS', 'SHIFT_JIS'
58 58 extend(PDF_Japanese)
59 59 AddSJISFont()
60 60 @font_for_content = 'SJIS'
61 61 @font_for_footer = 'SJIS'
62 62 when 'GB18030'
63 63 extend(PDF_Chinese)
64 64 AddGBFont()
65 65 @font_for_content = 'GB'
66 66 @font_for_footer = 'GB'
67 67 when 'BIG5'
68 68 extend(PDF_Chinese)
69 69 AddBig5Font()
70 70 @font_for_content = 'Big5'
71 71 @font_for_footer = 'Big5'
72 72 else
73 73 @font_for_content = 'Arial'
74 74 @font_for_footer = 'Helvetica'
75 75 end
76 76 end
77 77 SetCreator(Redmine::Info.app_name)
78 78 SetFont(@font_for_content)
79 79 end
80 80
81 81 def SetFontStyle(style, size)
82 82 SetFont(@font_for_content, style, size)
83 83 end
84 84
85 85 def SetTitle(txt)
86 86 txt = begin
87 87 utf16txt = Iconv.conv('UTF-16BE', 'UTF-8', txt)
88 88 hextxt = "<FEFF" # FEFF is BOM
89 89 hextxt << utf16txt.unpack("C*").map {|x| sprintf("%02X",x) }.join
90 90 hextxt << ">"
91 91 rescue
92 92 txt
93 93 end || ''
94 94 super(txt)
95 95 end
96 96
97 97 def textstring(s)
98 98 # Format a text string
99 99 if s =~ /^</ # This means the string is hex-dumped.
100 100 return s
101 101 else
102 102 return '('+escape(s)+')'
103 103 end
104 104 end
105 105
106 106 def fix_text_encoding(txt)
107 107 RDMPdfEncoding::rdm_pdf_iconv(@ic, txt)
108 108 end
109 109
110 110 def RDMCell(w ,h=0, txt='', border=0, ln=0, align='', fill=0, link='')
111 111 Cell(w, h, fix_text_encoding(txt), border, ln, align, fill, link)
112 112 end
113 113
114 114 def RDMMultiCell(w, h=0, txt='', border=0, align='', fill=0, ln=1)
115 115 MultiCell(w, h, fix_text_encoding(txt), border, align, fill, ln)
116 116 end
117 117
118 118 def RDMwriteHTMLCell(w, h, x, y, html='', border=0, ln=1, fill=0)
119 119 writeHTMLCell(w, h, x, y, fix_text_encoding(html), border, ln, fill)
120 120 end
121 121
122 122 def Footer
123 123 SetFont(@font_for_footer, 'I', 8)
124 124 SetY(-15)
125 125 SetX(15)
126 126 RDMCell(0, 5, @footer_date, 0, 0, 'L')
127 127 SetY(-15)
128 128 SetX(-30)
129 129 RDMCell(0, 5, PageNo().to_s + '/{nb}', 0, 0, 'C')
130 130 end
131 131 end
132 132
133 133 # Returns a PDF string of a list of issues
134 134 def issues_to_pdf(issues, project, query)
135 135 pdf = ITCPDF.new(current_language)
136 136 title = query.new_record? ? l(:label_issue_plural) : query.name
137 137 title = "#{project} - #{title}" if project
138 138 pdf.SetTitle(title)
139 139 pdf.alias_nb_pages
140 140 pdf.footer_date = format_date(Date.today)
141 141 pdf.SetAutoPageBreak(false)
142 142 pdf.AddPage("L")
143 143
144 144 # Landscape A4 = 210 x 297 mm
145 145 page_height = 210
146 146 page_width = 297
147 147 right_margin = 10
148 148 bottom_margin = 20
149 149 col_id_width = 10
150 150 row_height = 5
151 151
152 152 # column widths
153 153 table_width = page_width - right_margin - 10 # fixed left margin
154 154 col_width = []
155 155 unless query.columns.empty?
156 156 col_width = query.columns.collect do |c|
157 157 (c.name == :subject || (c.is_a?(QueryCustomFieldColumn) && ['string', 'text'].include?(c.custom_field.field_format)))? 4.0 : 1.0
158 158 end
159 159 ratio = (table_width - col_id_width) / col_width.inject(0) {|s,w| s += w}
160 160 col_width = col_width.collect {|w| w * ratio}
161 161 end
162 162
163 163 # title
164 164 pdf.SetFontStyle('B',11)
165 165 pdf.RDMCell(190,10, title)
166 166 pdf.Ln
167 167
168 168 # headers
169 169 pdf.SetFontStyle('B',8)
170 170 pdf.SetFillColor(230, 230, 230)
171 171
172 172 # render it background to find the max height used
173 173 base_x = pdf.GetX
174 174 base_y = pdf.GetY
175 175 max_height = issues_to_pdf_write_cells(pdf, query.columns, col_width, row_height, true)
176 176 pdf.Rect(base_x, base_y, table_width, max_height, 'FD');
177 177 pdf.SetXY(base_x, base_y);
178 178
179 179 # write the cells on page
180 180 pdf.RDMCell(col_id_width, row_height, "#", "T", 0, 'C', 1)
181 181 issues_to_pdf_write_cells(pdf, query.columns, col_width, row_height, true)
182 182 issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
183 183 pdf.SetY(base_y + max_height);
184 184
185 185 # rows
186 186 pdf.SetFontStyle('',8)
187 187 pdf.SetFillColor(255, 255, 255)
188 188 previous_group = false
189 189 issues.each do |issue|
190 190 if query.grouped? &&
191 191 (group = query.group_by_column.value(issue)) != previous_group
192 192 pdf.SetFontStyle('B',9)
193 193 pdf.RDMCell(277, row_height,
194 194 (group.blank? ? 'None' : group.to_s) + " (#{query.issue_count_by_group[group]})",
195 195 1, 1, 'L')
196 196 pdf.SetFontStyle('',8)
197 197 previous_group = group
198 198 end
199 199 # fetch all the row values
200 200 col_values = query.columns.collect do |column|
201 201 s = if column.is_a?(QueryCustomFieldColumn)
202 202 cv = issue.custom_values.detect {|v| v.custom_field_id == column.custom_field.id}
203 203 show_value(cv)
204 204 else
205 205 value = issue.send(column.name)
206 206 if value.is_a?(Date)
207 207 format_date(value)
208 208 elsif value.is_a?(Time)
209 209 format_time(value)
210 210 else
211 211 value
212 212 end
213 213 end
214 214 s.to_s
215 215 end
216 216
217 217 # render it off-page to find the max height used
218 218 base_x = pdf.GetX
219 219 base_y = pdf.GetY
220 220 pdf.SetY(2 * page_height)
221 221 max_height = issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
222 222 pdf.SetXY(base_x, base_y)
223 223
224 224 # make new page if it doesn't fit on the current one
225 225 space_left = page_height - base_y - bottom_margin
226 226 if max_height > space_left
227 227 pdf.AddPage("L")
228 228 base_x = pdf.GetX
229 229 base_y = pdf.GetY
230 230 end
231 231
232 232 # write the cells on page
233 233 pdf.RDMCell(col_id_width, row_height, issue.id.to_s, "T", 0, 'C', 1)
234 234 issues_to_pdf_write_cells(pdf, col_values, col_width, row_height)
235 235 issues_to_pdf_draw_borders(pdf, base_x, base_y, base_y + max_height, col_id_width, col_width)
236 236 pdf.SetY(base_y + max_height);
237 237 end
238 238
239 239 if issues.size == Setting.issues_export_limit.to_i
240 240 pdf.SetFontStyle('B',10)
241 241 pdf.RDMCell(0, row_height, '...')
242 242 end
243 243 pdf.Output
244 244 end
245 245
246 246 # Renders MultiCells and returns the maximum height used
247 247 def issues_to_pdf_write_cells(pdf, col_values, col_widths,
248 248 row_height, head=false)
249 249 base_y = pdf.GetY
250 250 max_height = row_height
251 251 col_values.each_with_index do |column, i|
252 252 col_x = pdf.GetX
253 253 if head == true
254 254 pdf.RDMMultiCell(col_widths[i], row_height, column.caption, "T", 'L', 1)
255 255 else
256 256 pdf.RDMMultiCell(col_widths[i], row_height, column, "T", 'L', 1)
257 257 end
258 258 max_height = (pdf.GetY - base_y) if (pdf.GetY - base_y) > max_height
259 259 pdf.SetXY(col_x + col_widths[i], base_y);
260 260 end
261 261 return max_height
262 262 end
263 263
264 264 # Draw lines to close the row (MultiCell border drawing in not uniform)
265 265 def issues_to_pdf_draw_borders(pdf, top_x, top_y, lower_y,
266 266 id_width, col_widths)
267 267 col_x = top_x + id_width
268 268 pdf.Line(col_x, top_y, col_x, lower_y) # id right border
269 269 col_widths.each do |width|
270 270 col_x += width
271 271 pdf.Line(col_x, top_y, col_x, lower_y) # columns right border
272 272 end
273 273 pdf.Line(top_x, top_y, top_x, lower_y) # left border
274 274 pdf.Line(top_x, lower_y, col_x, lower_y) # bottom border
275 275 end
276 276
277 277 # Returns a PDF string of a single issue
278 278 def issue_to_pdf(issue)
279 279 pdf = ITCPDF.new(current_language)
280 280 pdf.SetTitle("#{issue.project} - ##{issue.tracker} #{issue.id}")
281 281 pdf.alias_nb_pages
282 282 pdf.footer_date = format_date(Date.today)
283 283 pdf.AddPage
284 284 pdf.SetFontStyle('B',11)
285 285 pdf.RDMMultiCell(190,5,
286 286 "#{issue.project} - #{issue.tracker} # #{issue.id}: #{issue.subject}")
287 287 pdf.Ln
288 288
289 289 pdf.SetFontStyle('B',9)
290 290 pdf.RDMCell(35,5, l(:field_status) + ":","LT")
291 291 pdf.SetFontStyle('',9)
292 292 pdf.RDMCell(60,5, issue.status.to_s,"RT")
293 293 pdf.SetFontStyle('B',9)
294 294 pdf.RDMCell(35,5, l(:field_priority) + ":","LT")
295 295 pdf.SetFontStyle('',9)
296 296 pdf.RDMCell(60,5, issue.priority.to_s,"RT")
297 297 pdf.Ln
298 298
299 299 pdf.SetFontStyle('B',9)
300 300 pdf.RDMCell(35,5, l(:field_author) + ":","L")
301 301 pdf.SetFontStyle('',9)
302 302 pdf.RDMCell(60,5, issue.author.to_s,"R")
303 303 pdf.SetFontStyle('B',9)
304 304 pdf.RDMCell(35,5, l(:field_category) + ":","L")
305 305 pdf.SetFontStyle('',9)
306 306 pdf.RDMCell(60,5, issue.category.to_s,"R")
307 307 pdf.Ln
308 308
309 309 pdf.SetFontStyle('B',9)
310 310 pdf.RDMCell(35,5, l(:field_created_on) + ":","L")
311 311 pdf.SetFontStyle('',9)
312 312 pdf.RDMCell(60,5, format_date(issue.created_on),"R")
313 313 pdf.SetFontStyle('B',9)
314 314 pdf.RDMCell(35,5, l(:field_assigned_to) + ":","L")
315 315 pdf.SetFontStyle('',9)
316 316 pdf.RDMCell(60,5, issue.assigned_to.to_s,"R")
317 317 pdf.Ln
318 318
319 319 pdf.SetFontStyle('B',9)
320 320 pdf.RDMCell(35,5, l(:field_updated_on) + ":","LB")
321 321 pdf.SetFontStyle('',9)
322 322 pdf.RDMCell(60,5, format_date(issue.updated_on),"RB")
323 323 pdf.SetFontStyle('B',9)
324 324 pdf.RDMCell(35,5, l(:field_due_date) + ":","LB")
325 325 pdf.SetFontStyle('',9)
326 326 pdf.RDMCell(60,5, format_date(issue.due_date),"RB")
327 327 pdf.Ln
328 328
329 329 for custom_value in issue.custom_field_values
330 330 pdf.SetFontStyle('B',9)
331 331 pdf.RDMCell(35,5, custom_value.custom_field.name + ":","L")
332 332 pdf.SetFontStyle('',9)
333 333 pdf.RDMMultiCell(155,5, (show_value custom_value),"R")
334 334 end
335 335
336 336 y0 = pdf.GetY
337 337
338 338 pdf.SetFontStyle('B',9)
339 339 pdf.RDMCell(35,5, l(:field_subject) + ":","LT")
340 340 pdf.SetFontStyle('',9)
341 341 pdf.RDMMultiCell(155,5, issue.subject,"RT")
342 342 pdf.Line(pdf.GetX, y0, pdf.GetX, pdf.GetY)
343 343
344 344 pdf.SetFontStyle('B',9)
345 345 pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
346 346 pdf.SetFontStyle('',9)
347 347 pdf.RDMwriteHTMLCell(35+155, 5, 0, 0,
348 348 Redmine::WikiFormatting.to_html(
349 349 Setting.text_formatting, issue.description.to_s),"LRB")
350 350 pdf.Ln
351 351
352 352 if issue.changesets.any? &&
353 353 User.current.allowed_to?(:view_changesets, issue.project)
354 354 pdf.SetFontStyle('B',9)
355 355 pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
356 356 pdf.Ln
357 357 for changeset in issue.changesets
358 358 pdf.SetFontStyle('B',8)
359 359 csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
360 360 csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
361 361 pdf.RDMCell(190, 5, csstr)
362 362 pdf.Ln
363 363 unless changeset.comments.blank?
364 364 pdf.SetFontStyle('',8)
365 365 pdf.RDMwriteHTMLCell(190,5,0,0,
366 366 Redmine::WikiFormatting.to_html(
367 367 Setting.text_formatting, changeset.comments.to_s), "")
368 368 end
369 369 pdf.Ln
370 370 end
371 371 end
372 372
373 373 pdf.SetFontStyle('B',9)
374 374 pdf.RDMCell(190,5, l(:label_history), "B")
375 375 pdf.Ln
376 376 for journal in issue.journals.find(
377 377 :all, :include => [:user, :details],
378 378 :order => "#{Journal.table_name}.created_on ASC")
379 379 pdf.SetFontStyle('B',8)
380 380 pdf.RDMCell(190,5,
381 381 format_time(journal.created_on) + " - " + journal.user.name)
382 382 pdf.Ln
383 383 pdf.SetFontStyle('I',8)
384 384 for detail in journal.details
385 385 pdf.RDMMultiCell(190,5, "- " + show_detail(detail, true))
386 386 end
387 387 if journal.notes?
388 388 pdf.Ln unless journal.details.empty?
389 389 pdf.SetFontStyle('',8)
390 390 pdf.RDMwriteHTMLCell(190,5,0,0,
391 391 Redmine::WikiFormatting.to_html(
392 392 Setting.text_formatting, journal.notes.to_s), "")
393 393 end
394 394 pdf.Ln
395 395 end
396 396
397 397 if issue.attachments.any?
398 398 pdf.SetFontStyle('B',9)
399 399 pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
400 400 pdf.Ln
401 401 for attachment in issue.attachments
402 402 pdf.SetFontStyle('',8)
403 403 pdf.RDMCell(80,5, attachment.filename)
404 404 pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
405 405 pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
406 406 pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
407 407 pdf.Ln
408 408 end
409 409 end
410 410 pdf.Output
411 411 end
412 412
413 # Returns a PDF string of a single wiki page
414 def wiki_to_pdf(page, project)
415 pdf = ITCPDF.new(current_language)
416 pdf.SetTitle("#{project} - #{page.title}")
417 pdf.alias_nb_pages
418 pdf.footer_date = format_date(Date.today)
419 pdf.AddPage
420 pdf.SetFontStyle('B',11)
421 pdf.RDMMultiCell(190,5,
422 "#{project} - #{page.title} - # #{page.content.version}")
423 pdf.Ln
424 # Set resize image scale
425 pdf.SetImageScale(1.6)
426 pdf.SetFontStyle('',9)
427 pdf.RDMwriteHTMLCell(190,5,0,0,
428 Redmine::WikiFormatting.to_html(
429 Setting.text_formatting, page.content.text.to_s), "TLRB")
430 if page.attachments.any?
431 pdf.Ln
432 pdf.SetFontStyle('B',9)
433 pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
434 pdf.Ln
435 for attachment in page.attachments
436 pdf.SetFontStyle('',8)
437 pdf.RDMCell(80,5, attachment.filename)
438 pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
439 pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
440 pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
441 pdf.Ln
442 end
443 end
444 pdf.Output
445 end
446
413 447 class RDMPdfEncoding
414 448 include Redmine::I18n
415 449 def self.rdm_pdf_iconv(ic, txt)
416 450 txt ||= ''
417 451 if txt.respond_to?(:force_encoding)
418 452 txt.force_encoding('UTF-8')
419 453 if l(:general_pdf_encoding).upcase != 'UTF-8'
420 454 txt = txt.encode(l(:general_pdf_encoding), :invalid => :replace,
421 455 :undef => :replace, :replace => '?')
422 456 else
423 457 txt = Redmine::CodesetUtil.replace_invalid_utf8(txt)
424 458 end
425 459 txt.force_encoding('ASCII-8BIT')
426 460 elsif RUBY_PLATFORM == 'java'
427 461 begin
428 462 ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8')
429 463 txt = ic.iconv(txt)
430 464 rescue
431 465 txt = txt.gsub(%r{[^\r\n\t\x20-\x7e]}, '?')
432 466 end
433 467 else
434 468 ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8')
435 469 txtar = ""
436 470 begin
437 471 txtar += ic.iconv(txt)
438 472 rescue Iconv::IllegalSequence
439 473 txtar += $!.success
440 474 txt = '?' + $!.failed[1,$!.failed.length]
441 475 retry
442 476 rescue
443 477 txtar += $!.success
444 478 end
445 479 txt = txtar
446 480 end
447 481 txt
448 482 end
449 483 end
450 484 end
451 485 end
452 486 end
General Comments 0
You need to be logged in to leave comments. Login now