Module: Redmine::Export::PDF

Includes:
ActionView::Helpers::NumberHelper, ActionView::Helpers::TextHelper
Included in:
IssuesController
Defined in:
lib/redmine/export/pdf.rb

Defined Under Namespace

Classes: IFPDF

Instance Method Summary (collapse)

Instance Method Details

- (Object) gantt_to_pdf(gantt, project)

Returns a PDF string of a gantt chart



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/redmine/export/pdf.rb', line 285

def gantt_to_pdf(gantt, project)
  pdf = IFPDF.new(current_language)
  pdf.SetTitle("#{l(:label_gantt)} #{project}")
  pdf.AliasNbPages
  pdf.footer_date = format_date(Date.today)
  pdf.AddPage("L")
  pdf.SetFontStyle('B',12)
  pdf.SetX(15)
  pdf.Cell(70, 20, project.to_s)
  pdf.Ln
  pdf.SetFontStyle('B',9)
  
  subject_width = 70
  header_heigth = 5
  
  headers_heigth = header_heigth
  show_weeks = false
  show_days = false
  
  if gantt.months < 7
    show_weeks = true
    headers_heigth = 2*header_heigth
    if gantt.months < 3
      show_days = true
      headers_heigth = 3*header_heigth
    end
  end
  
  g_width = 210
  zoom = (g_width) / (gantt.date_to - gantt.date_from + 1)
  g_height = 120
  t_height = g_height + headers_heigth
  
  y_start = pdf.GetY
  
  # Months headers
  month_f = gantt.date_from
  left = subject_width
  height = header_heigth
  gantt.months.times do 
    width = ((month_f >> 1) - month_f) * zoom 
    pdf.SetY(y_start)
    pdf.SetX(left)
    pdf.Cell(width, height, "#{month_f.year}-#{month_f.month}", "LTR", 0, "C")
    left = left + width
    month_f = month_f >> 1
  end  
  
  # Weeks headers
  if show_weeks
    left = subject_width
    height = header_heigth
    if gantt.date_from.cwday == 1
      # gantt.date_from is monday
      week_f = gantt.date_from
    else
      # find next monday after gantt.date_from
      week_f = gantt.date_from + (7 - gantt.date_from.cwday + 1)
      width = (7 - gantt.date_from.cwday + 1) * zoom-1
      pdf.SetY(y_start + header_heigth)
      pdf.SetX(left)
      pdf.Cell(width + 1, height, "", "LTR")
      left = left + width+1
    end
    while week_f <= gantt.date_to
      width = (week_f + 6 <= gantt.date_to) ? 7 * zoom : (gantt.date_to - week_f + 1) * zoom
      pdf.SetY(y_start + header_heigth)
      pdf.SetX(left)
      pdf.Cell(width, height, (width >= 5 ? week_f.cweek.to_s : ""), "LTR", 0, "C")
      left = left + width
      week_f = week_f+7
    end
  end
  
  # Days headers
  if show_days
    left = subject_width
    height = header_heigth
    wday = gantt.date_from.cwday
    pdf.SetFontStyle('B',7)
    (gantt.date_to - gantt.date_from + 1).to_i.times do 
      width = zoom
      pdf.SetY(y_start + 2 * header_heigth)
      pdf.SetX(left)
      pdf.Cell(width, height, day_name(wday).first, "LTR", 0, "C")
      left = left + width
      wday = wday + 1
      wday = 1 if wday > 7
    end
  end
  
  pdf.SetY(y_start)
  pdf.SetX(15)
  pdf.Cell(subject_width+g_width-15, headers_heigth, "", 1)
  
  # Tasks
  top = headers_heigth + y_start
  pdf.SetFontStyle('B',7)
  gantt.events.each do |i|
    pdf.SetY(top)
    pdf.SetX(15)
    
    if i.is_a? Issue
      pdf.Cell(subject_width-15, 5, "#{i.tracker} #{i.id}: #{i.subject}".sub(/^(.{30}[^\s]*\s).*$/, '\1 (...)'), "LR")
    else
      pdf.Cell(subject_width-15, 5, "#{l(:label_version)}: #{i.name}", "LR")
    end
  
    pdf.SetY(top)
    pdf.SetX(subject_width)
    pdf.Cell(g_width, 5, "", "LR")
  
    pdf.SetY(top+1.5)
    
    if i.is_a? Issue
      i_start_date = (i.start_date >= gantt.date_from ? i.start_date : gantt.date_from )
      i_end_date = (i.due_before <= gantt.date_to ? i.due_before : gantt.date_to )
      
      i_done_date = i.start_date + ((i.due_before - i.start_date+1)*i.done_ratio/100).floor
      i_done_date = (i_done_date <= gantt.date_from ? gantt.date_from : i_done_date )
      i_done_date = (i_done_date >= gantt.date_to ? gantt.date_to : i_done_date )
      
      i_late_date = [i_end_date, Date.today].min if i_start_date < Date.today
      
      i_left = ((i_start_date - gantt.date_from)*zoom) 
      i_width = ((i_end_date - i_start_date + 1)*zoom)
      d_width = ((i_done_date - i_start_date)*zoom)
      l_width = ((i_late_date - i_start_date+1)*zoom) if i_late_date
      l_width ||= 0
    
      pdf.SetX(subject_width + i_left)
      pdf.SetFillColor(200,200,200)
      pdf.Cell(i_width, 2, "", 0, 0, "", 1)
    
      if l_width > 0
        pdf.SetY(top+1.5)
        pdf.SetX(subject_width + i_left)
        pdf.SetFillColor(255,100,100)
        pdf.Cell(l_width, 2, "", 0, 0, "", 1)
      end 
      if d_width > 0
        pdf.SetY(top+1.5)
        pdf.SetX(subject_width + i_left)
        pdf.SetFillColor(100,100,255)
        pdf.Cell(d_width, 2, "", 0, 0, "", 1)
      end
      
      pdf.SetY(top+1.5)
      pdf.SetX(subject_width + i_left + i_width)
      pdf.Cell(30, 2, "#{i.status} #{i.done_ratio}%")
    else
      i_left = ((i.start_date - gantt.date_from)*zoom) 
      
      pdf.SetX(subject_width + i_left)
      pdf.SetFillColor(50,200,50)
      pdf.Cell(2, 2, "", 0, 0, "", 1) 
  
      pdf.SetY(top+1.5)
      pdf.SetX(subject_width + i_left + 3)
      pdf.Cell(30, 2, "#{i.name}")
    end
    
    top = top + 5
    pdf.SetDrawColor(200, 200, 200)
    pdf.Line(15, top, subject_width+g_width, top)
    if pdf.GetY() > 180
      pdf.AddPage("L")
      top = 20
      pdf.Line(15, top, subject_width+g_width, top)
    end
    pdf.SetDrawColor(0, 0, 0)
  end
  
  pdf.Line(15, top, subject_width+g_width, top)
  pdf.Output
end

- (Object) issue_to_pdf(issue)

Returns a PDF string of a single issue



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/redmine/export/pdf.rb', line 158

def issue_to_pdf(issue)
  pdf = IFPDF.new(current_language)
  pdf.SetTitle("#{issue.project} - ##{issue.tracker} #{issue.id}")
  pdf.AliasNbPages
  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.Ln
  
  y0 = pdf.GetY
  
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_status) + ":","LT")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, issue.status.to_s,"RT")
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_priority) + ":","LT")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, issue.priority.to_s,"RT")        
  pdf.Ln
    
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_author) + ":","L")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, issue.author.to_s,"R")
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_category) + ":","L")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, issue.category.to_s,"R")
  pdf.Ln   
  
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_created_on) + ":","L")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, format_date(issue.created_on),"R")
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_assigned_to) + ":","L")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, issue.assigned_to.to_s,"R")
  pdf.Ln
  
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_updated_on) + ":","LB")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, format_date(issue.updated_on),"RB")
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_due_date) + ":","LB")
  pdf.SetFontStyle('',9)
  pdf.Cell(60,5, format_date(issue.due_date),"RB")
  pdf.Ln
    
  for custom_value in issue.custom_values
    pdf.SetFontStyle('B',9)
    pdf.Cell(35,5, custom_value.custom_field.name + ":","L")
    pdf.SetFontStyle('',9)
    pdf.MultiCell(155,5, (show_value custom_value),"R")
  end
    
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_subject) + ":","LTB")
  pdf.SetFontStyle('',9)
  pdf.Cell(155,5, issue.subject,"RTB")
  pdf.Ln    
  
  pdf.SetFontStyle('B',9)
  pdf.Cell(35,5, l(:field_description) + ":")
  pdf.SetFontStyle('',9)
  pdf.MultiCell(155,5, @issue.description,"BR")
  
  pdf.Line(pdf.GetX, y0, pdf.GetX, pdf.GetY)
  pdf.Line(pdf.GetX, pdf.GetY, 170, pdf.GetY)
  pdf.Ln
  
  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.Ln
    for changeset in issue.changesets
      pdf.SetFontStyle('B',8)
      pdf.Cell(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)
      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.SetFontStyle('B',8)
    pdf.Cell(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
    end
    if journal.notes?
      pdf.SetFontStyle('',8)
      pdf.MultiCell(190,5, journal.notes)
    end   
    pdf.Ln
  end
  
  if issue.attachments.any?
    pdf.SetFontStyle('B',9)
    pdf.Cell(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.Ln
    end
  end
  pdf.Output
end

- (Object) issues_to_pdf(issues, project)

Returns a PDF string of a list of issues



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/redmine/export/pdf.rb', line 111

def issues_to_pdf(issues, project)
  pdf = IFPDF.new(current_language)
  title = project ? "#{project} - #{l(:label_issue_plural)}" : "#{l(:label_issue_plural)}"
  pdf.SetTitle(title)
  pdf.AliasNbPages
  pdf.footer_date = format_date(Date.today)
  pdf.AddPage("L")
  row_height = 7
  
  # title
  pdf.SetFontStyle('B',11)    
  pdf.Cell(190,10, title)
  pdf.Ln
  
  # headers
  pdf.SetFontStyle('B',10)
  pdf.SetFillColor(230, 230, 230)
  pdf.Cell(15, row_height, "#", 0, 0, 'L', 1)
  pdf.Cell(30, row_height, l(:field_tracker), 0, 0, 'L', 1)
  pdf.Cell(30, row_height, l(:field_status), 0, 0, 'L', 1)
  pdf.Cell(30, row_height, l(:field_priority), 0, 0, 'L', 1)
  pdf.Cell(40, row_height, l(:field_assigned_to), 0, 0, 'L', 1)
  pdf.Cell(25, row_height, l(:field_updated_on), 0, 0, 'L', 1)
  pdf.Cell(0, row_height, l(:field_subject), 0, 0, 'L', 1)
  pdf.Line(10, pdf.GetY, 287, pdf.GetY)
  pdf.Ln
  pdf.Line(10, pdf.GetY, 287, pdf.GetY)
  pdf.SetY(pdf.GetY() + 1)
  
  # rows
  pdf.SetFontStyle('',9)
  pdf.SetFillColor(255, 255, 255)
  issues.each do |issue|   
    pdf.Cell(15, row_height, issue.id.to_s, 0, 0, 'L', 1)
    pdf.Cell(30, row_height, issue.tracker.name, 0, 0, 'L', 1)
    pdf.Cell(30, row_height, issue.status.name, 0, 0, 'L', 1)
    pdf.Cell(30, row_height, issue.priority.name, 0, 0, 'L', 1)
    pdf.Cell(40, row_height, issue.assigned_to ? issue.assigned_to.to_s : '', 0, 0, 'L', 1)
    pdf.Cell(25, row_height, format_date(issue.updated_on), 0, 0, 'L', 1)
    pdf.MultiCell(0, row_height, (project == issue.project ? issue.subject : "#{issue.project} - #{issue.subject}"))
    pdf.Line(10, pdf.GetY, 287, pdf.GetY)
    pdf.SetY(pdf.GetY() + 1)
  end
  pdf.Output
end