Redmine之報表應用研究

近來將RedMine的原始碼下下來進行研究，主要目的是研究它的Report功能是如何實現的

目前研究結果總結為幾點：

1）Remine介面上支援PDF，CSV，HTML輸出，但沒有單獨的報表執行中心，只有在Issue及Gant介面有報表輸出功能

2）新建兩個使用者a和b，a使用者在建立時預設語言選擇“English”，b使用者選擇"Chinese(Simple)"，進行報表列印時發現第一個使用者列印出來的PDF報表中文顯示為亂碼，第二個使用者列印的PDF報表中文顯示正常

 

對於以上兩點，進行了程式碼跟蹤，得出了以下結論

1）報表輸出的程式碼寫在IssuesController，關鍵程式碼如下：

respond_to do |format| format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? } format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") } format.csv { send_data(issues_to_csv(@issues, @project), :type => 'text/csv; header=present', :filename => 'export.csv') } format.pdf { send_data(issues_to_pdf(@issues, @project, @query), :type => 'application/pdf', :filename => 'export.pdf') } end

 

程式碼中很清晰看到CSV、PDF 的輸出呼叫的是 issues_to_csv,issues_to_pdf（Gant介面的報表呼叫的是gant_to_pdf）

從名字可猜測Redmine中的報表列印並不通用，只是針對特定的報表進行了固定的輸出處理

 

issue_to_pdf，issues_to_pdf，gant_to_pdf都包含在pdf.rb中，程式碼如下：

# encoding: utf-8 # # Redmine - project management software # Copyright (C) 2006-2009 Jean-Philippe Lang # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. require 'iconv' require 'rfpdf/fpdf' require 'rfpdf/chinese' module Redmine module Export module PDF include ActionView::Helpers::TextHelper include ActionView::Helpers::NumberHelper class IFPDF < FPDF include Redmine::I18n attr_accessor :footer_date def initialize(lang) super() set_language_if_valid lang puts "=============================Current Language #{current_language.to_s.downcase}" #current_language = 'zh' case current_language.to_s.downcase when 'ko' extend(PDF_Korean) AddUHCFont() @font_for_content = 'UHC' @font_for_footer = 'UHC' when 'ja' extend(PDF_Japanese) AddSJISFont() @font_for_content = 'SJIS' @font_for_footer = 'SJIS' when 'zh' extend(PDF_Chinese) AddGBFont() @font_for_content = 'GB' @font_for_footer = 'GB' puts "=========================AddGBFont()" when 'zh-tw' extend(PDF_Chinese) AddBig5Font() @font_for_content = 'Big5' @font_for_footer = 'Big5' else @font_for_content = 'Arial' @font_for_footer = 'Helvetica' end SetCreator(Redmine::Info.app_name) SetFont(@font_for_content) end def SetFontStyle(style, size) SetFont(@font_for_content, style, size) end def SetTitle(txt) txt = begin utf16txt = Iconv.conv('UTF-16BE', 'UTF-8', txt) hextxt = "<FEFF" # FEFF is BOM hextxt << utf16txt.unpack("C*").map {|x| sprintf("%02X",x) }.join hextxt << ">" rescue txt end || '' super(txt) end def textstring(s) # Format a text string if s =~ /^</ # This means the string is hex-dumped. return s else return '('+escape(s)+')' end end def Cell(w,h=0,txt='',border=0,ln=0,align='',fill=0,link='') puts ":general_pdf_encoding==================#{l(:general_pdf_encoding)}" @ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8') # these quotation marks are not correctly rendered in the pdf txt = txt.gsub(/[“�]/, '"') if txt txt = begin # 0x5c char handling txtar = txt.split('//') txtar << '' if txt[-1] == ?// txtar.collect {|x| @ic.iconv(x)}.join('//').gsub(////, "////////") rescue txt end || '' super w,h,txt,border,ln,align,fill,link end def Footer SetFont(@font_for_footer, 'I', 8) SetY(-15) SetX(15) Cell(0, 5, @footer_date, 0, 0, 'L') SetY(-15) SetX(-30) Cell(0, 5, PageNo().to_s + '/{nb}', 0, 0, 'C') end end # Returns a PDF string of a list of issues def issues_to_pdf(issues, project, query) pdf = IFPDF.new(current_language) title = query.new_record? ? l(:label_issue_plural) : query.name title = "#{project} - #{title}" if project pdf.SetTitle(title) pdf.AliasNbPages pdf.footer_date = format_date(Date.today) pdf.AddPage("L") row_height = 6 col_width = [] unless query.columns.empty? col_width = query.columns.collect {|column| column.name == :subject ? 4.0 : 1.0 } ratio = 262.0 / col_width.inject(0) {|s,w| s += w} col_width = col_width.collect {|w| w * ratio} end # title pdf.SetFontStyle('B',11) pdf.Cell(190,10, title) pdf.Ln # headers pdf.SetFontStyle('B',8) pdf.SetFillColor(230, 230, 230) pdf.Cell(15, row_height, "#", 1, 0, 'L', 1) query.columns.each_with_index do |column, i| pdf.Cell(col_width[i], row_height, column.caption, 1, 0, 'L', 1) end pdf.Ln # rows pdf.SetFontStyle('',8) pdf.SetFillColor(255, 255, 255) previous_group = false issues.each do |issue| if query.grouped? && (group = query.group_by_column.value(issue)) != previous_group pdf.SetFontStyle('B',9) pdf.Cell(277, row_height, (group.blank? ? 'None' : group.to_s) + " (#{@issue_count_by_group[group]})", 1, 1, 'L') pdf.SetFontStyle('',8) previous_group = group end pdf.Cell(15, row_height, issue.id.to_s, 1, 0, 'L', 1) query.columns.each_with_index do |column, i| s = if column.is_a?(QueryCustomFieldColumn) cv = issue.custom_values.detect {|v| v.custom_field_id == column.custom_field.id} show_value(cv) else value = issue.send(column.name) if value.is_a?(Date) format_date(value) elsif value.is_a?(Time) format_time(value) else value end end pdf.Cell(col_width[i], row_height, s.to_s, 1, 0, 'L', 1) end pdf.Ln end if issues.size == Setting.issues_export_limit.to_i pdf.SetFontStyle('B',10) pdf.Cell(0, row_height, '...') end pdf.Output end # Returns a PDF string of a single issue 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_field_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 # Returns a PDF string of a gantt chart 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 end end end

 

而issues_to_csv包含在IssuesHelper中

def issues_to_csv(issues, project = nil) ic = Iconv.new(l(:general_csv_encoding), 'UTF-8') decimal_separator = l(:general_csv_decimal_separator) export = FCSV.generate(:col_sep => l(:general_csv_separator)) do |csv| # csv header fields headers = [ "#", l(:field_status), l(:field_project), l(:field_tracker), l(:field_priority), l(:field_subject), l(:field_assigned_to), l(:field_category), l(:field_fixed_version), l(:field_author), l(:field_start_date), l(:field_due_date), l(:field_done_ratio), l(:field_estimated_hours), l(:field_created_on), l(:field_updated_on) ] # Export project custom fields if project is given # otherwise export custom fields marked as "For all projects" custom_fields = project.nil? ? IssueCustomField.for_all : project.all_issue_custom_fields custom_fields.each {|f| headers << f.name} # Description in the last column headers << l(:field_description) csv << headers.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end } # csv lines issues.each do |issue| fields = [issue.id, issue.status.name, issue.project.name, issue.tracker.name, issue.priority.name, issue.subject, issue.assigned_to, issue.category, issue.fixed_version, issue.author.name, format_date(issue.start_date), format_date(issue.due_date), issue.done_ratio, issue.estimated_hours.to_s.gsub('.', decimal_separator), format_time(issue.created_on), format_time(issue.updated_on) ] custom_fields.each {|f| fields << show_value(issue.custom_value_for(f)) } fields << issue.description csv << fields.collect {|c| begin; ic.iconv(c.to_s); rescue; c.to_s; end } end end export end

 

由以上的程式碼可以得出結論：RedMine中只有甘特圖、問題介面支援報表輸出，而且不是每一個地方都支援PDF與CSV兩種格式的

 

2）為什麼預設語言型別不同的使用者輸出相同的報表會得到不一樣的結果（關於中文亂碼）

要解釋這個問題，重點在pdf.rb中

RedMine中對PDF的輸出用的是FPDF，FPDF中支援中文輸出，它內嵌了GB、Big5字型，對於中文的輸出需要做兩步

1、在輸出PDF之前設定輸出字型為 GB或Big5

2、對於中文在輸出之前進行字符集轉換，從UTF-8轉換成支援中文的字符集（如GBK，GB2312）

 

那麼PDF是怎麼做的呢？

首先，看以下程式碼：

def initialize(lang) super() set_language_if_valid lang puts "=============================Current Language #{current_language.to_s.downcase}" #current_language = 'zh' case current_language.to_s.downcase when 'ko' extend(PDF_Korean) AddUHCFont() @font_for_content = 'UHC' @font_for_footer = 'UHC' when 'ja' extend(PDF_Japanese) AddSJISFont() @font_for_content = 'SJIS' @font_for_footer = 'SJIS' when 'zh' extend(PDF_Chinese) AddGBFont() @font_for_content = 'GB' @font_for_footer = 'GB' puts "=========================AddGBFont()" when 'zh-tw' extend(PDF_Chinese) AddBig5Font() @font_for_content = 'Big5' @font_for_footer = 'Big5' else @font_for_content = 'Arial' @font_for_footer = 'Helvetica' end SetCreator(Redmine::Info.app_name) SetFont(@font_for_content) end

 

對於預設語言為“English”的使用者，登陸後觀察current_language的值，發現為"en"

對於預設語言為"Chinese(Simple)"的使用者，登陸後觀察current_language的值，發現為"zh"

 

那麼current_language的值是怎麼得到的呢？

在Redmine中有些配置檔案，其中涉及到default_language的設定，預設都設定為"en"，嘗試改為"zh"，發現current_language的值沒有發生改變

在研究了其他的原始碼發現current_language的值與資料表users中的LANGUAGE欄位關聯

在ApplicationController中發現以下程式碼：

def set_localization lang = nil if User.current.logged? lang = find_language(User.current.language) end if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE'] accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first.downcase if !accept_lang.blank? lang = find_language(accept_lang) || find_language(accept_lang.split('-').first) end end lang ||= Setting.default_language set_language_if_valid(lang) end

 

既然a使用者和b使用者因為預設語言不一樣導致current_language不一樣，那麼如果在PDF.initilize中將current_language強制設定為"zh"，是否就能得到一樣的結果呢？測試結果發現，即使這樣設定，a使用者列印的PDF報表中文仍然是亂碼，不同的是，亂碼與之前的不一樣。

 

問題到底出在哪呢？

繼續研究，發現PDF中的Cell方法（FPDF輸出的關鍵方法之一）中有這麼一句：

@ic ||= Iconv.new(l(:general_pdf_encoding), 'UTF-8')

 

原來在這裡進行了字符集轉換，那麼a使用者與b使用者得到的 l(:general_pdf_encoding)是否用相同呢，測試發現，

a使用者進入系統後得到的值為"ISO-8859-1"

b使用者進入系統後得到的值為"gb18030"

 

單獨FPDF輸出報表進行測試，發現

在選擇 GB 字型的情況下，

Iconv.conv("gb18030","UTF-8","測試")與 Iconv.conv("ISO-8859-1","UTF-8","測試")得到的結果不一樣，前者是正常顯示中文，後者則顯示亂碼

 

至此，以上兩點疑問都得到了解釋，這些就是到目前研究RedMine報表應用得到的結論