mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-04-02 08:21:57 -04:00
Updated patches and hooks
This commit is contained in:
8
init.rb
8
init.rb
@@ -43,10 +43,4 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
|
||||
end
|
||||
|
||||
# Dynamically load all Hooks & Patches recursively
|
||||
base_dir = File.join(File.dirname(__FILE__), 'lib')
|
||||
|
||||
# '**' looks inside subdirectories, '*.rb' matches Ruby files
|
||||
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
|
||||
require file
|
||||
end
|
||||
RedmineQbo.setup
|
||||
33
lib/redmine_qbo.rb
Normal file
33
lib/redmine_qbo.rb
Normal file
@@ -0,0 +1,33 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
module RedmineQbo
|
||||
def self.setup
|
||||
# === Models ===
|
||||
Issue.prepend RedmineQbo::Patches::IssuePatch
|
||||
User.prepend RedmineQbo::Patches::UserPatch
|
||||
|
||||
# === Queries ===
|
||||
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
|
||||
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
|
||||
|
||||
# === Controllers ===
|
||||
RedmineQbo::Patches::IssuesControllerPatch.apply
|
||||
RedmineQbo::Patches::AttachmentsControllerPatch.apply
|
||||
|
||||
# === Helpers / Exports ===
|
||||
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
|
||||
|
||||
# === Hooks ===
|
||||
RedmineQbo::Hooks::IssuesHookListener
|
||||
RedmineQbo::Hooks::UsersShowHookListener
|
||||
RedmineQbo::Hooks::ViewHookListener
|
||||
end
|
||||
end
|
||||
@@ -8,41 +8,32 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'attachments_controller'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
|
||||
module AttachmentsControllerPatch
|
||||
module Helper
|
||||
# Check if login is globally required to access the application
|
||||
def check_if_login_required
|
||||
# Return true if the user is already logged in
|
||||
return true if User.current.logged?
|
||||
|
||||
def self.included(base)
|
||||
# Pull up the attachment and verify if we have a valid token for the issue
|
||||
attachment = Attachment.find_by(id: params[:id])
|
||||
return require_login if attachment.nil?
|
||||
|
||||
base.class_eval do
|
||||
token = CustomerToken.where("token = ? AND expires_at > ?", session[:token], Time.current).first
|
||||
return true if token&.issue_id == attachment.container_id
|
||||
|
||||
# check if login is globally required to access the application
|
||||
def check_if_login_required
|
||||
# no check needed if user is already logged in
|
||||
return true if User.current.logged?
|
||||
|
||||
# Pull up the attachmet, & verify if we have a valid token for the Issue
|
||||
attachment = Attachment.find(params[:id])
|
||||
token = CustomerToken.where("token = ? and expires_at > ?", session[:token], Time.now)
|
||||
token = token.first
|
||||
unless token.nil?
|
||||
return true if token.issue_id == attachment.container_id
|
||||
end
|
||||
|
||||
require_login if Setting.login_required?
|
||||
end
|
||||
|
||||
# Default to requiring login if all else fails
|
||||
require_login if Setting.login_required?
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to AttachmentsController
|
||||
AttachmentsController.send(:include, AttachmentsControllerPatch)
|
||||
|
||||
def self.apply
|
||||
AttachmentsController.class_eval do
|
||||
helper Helper
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,60 +8,39 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'issue'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module IssuePatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def self.included(base)
|
||||
base.extend(ClassMethods)
|
||||
base.send(:include, InstanceMethods)
|
||||
prepended do
|
||||
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
|
||||
belongs_to :customer_token, primary_key: :id, optional: true
|
||||
belongs_to :estimate, primary_key: :id, optional: true
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
base.class_eval do
|
||||
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
|
||||
belongs_to :customer_token, primary_key: :id
|
||||
belongs_to :estimate, primary_key: :id
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs billing for ##{id}"
|
||||
return unless closed? && customer.present? && assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
module InstanceMethods
|
||||
|
||||
# Enqueue a background job to bill the time spent on this issue to the associated customer in Quickbooks, if the issue is closed and has a customer assigned.
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs to be billed for issue ##{id}"
|
||||
return unless closed?
|
||||
return unless customer.present?
|
||||
return unless assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
# Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks
|
||||
def titlize_subject
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
|
||||
self.subject = subject.split(/\s+/).map do |word|
|
||||
if word =~ /[A-Z]/ && word =~ /[0-9]/
|
||||
word
|
||||
else
|
||||
word.capitalize
|
||||
end
|
||||
end.join(' ')
|
||||
end
|
||||
# Titlize the subject for consistent formatting in billing descriptions
|
||||
def titlize_subject
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
self.subject = subject.split(/\s+/).map do |word|
|
||||
(word =~ /[A-Z]/ && word =~ /[0-9]/) ? word : word.capitalize
|
||||
end.join(' ')
|
||||
end
|
||||
|
||||
# This method is used to generate a shareable token for the customer associated with this issue, which can be used to link the issue to the corresponding customer in Quickbooks for billing and tracking purposes.
|
||||
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||
def share_token
|
||||
CustomerToken.get_token(self)
|
||||
end
|
||||
@@ -69,10 +48,8 @@ module RedmineQbo
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
end
|
||||
end
|
||||
|
||||
Issue.send(:include, IssuePatch)
|
||||
end
|
||||
end
|
||||
@@ -7,30 +7,31 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
require_dependency 'issues_controller'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module IssuesControllerPatch
|
||||
|
||||
module Helper
|
||||
# Extend the watcher links to include billing and share options
|
||||
def watcher_link(issue, user)
|
||||
link = ''
|
||||
link = link_to(I18n.t(:label_bill_time), bill_path( issue.id ), method: :get, class: 'icon icon-email-add') if user.admin?
|
||||
link << link_to(I18n.t(:label_share), share_path( issue.id ), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
|
||||
link.html_safe + super
|
||||
links = ''
|
||||
|
||||
# Admin users can bill time
|
||||
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :get, class: 'icon icon-email-add') if user.admin?
|
||||
|
||||
# Logged-in users can share the issue
|
||||
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
|
||||
|
||||
# Append to the original watcher links
|
||||
(links.html_safe + super).html_safe
|
||||
end
|
||||
end
|
||||
|
||||
def self.included(base)
|
||||
base.class_eval do
|
||||
def self.apply
|
||||
IssuesController.class_eval do
|
||||
helper Helper
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Add module to IssuessController
|
||||
IssuesController.send(:include, IssuesControllerPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,278 +8,307 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'redmine/export/pdf'
|
||||
require_dependency 'redmine/export/pdf/issues_pdf_helper'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module PdfPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def self.included(base)
|
||||
base.send(:include, InstanceMethods)
|
||||
base.class_eval do
|
||||
alias_method :issue_to_pdf, :issue_to_pdf_with_patch
|
||||
alias_method :issue_to_pdf_with_patch, :issue_to_pdf
|
||||
end
|
||||
end
|
||||
def issue_to_pdf(issue, assoc={})
|
||||
pdf = setup_pdf(issue)
|
||||
|
||||
module InstanceMethods
|
||||
render_header(pdf, issue)
|
||||
render_ancestors_and_subject(pdf, issue)
|
||||
|
||||
left, right = build_issue_attributes(issue)
|
||||
render_attributes_grid(pdf, left, right)
|
||||
|
||||
def issue_to_pdf_with_patch(issue, assoc={})
|
||||
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
||||
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.alias_nb_pages
|
||||
pdf.footer_date = format_date(Date.today)
|
||||
pdf.add_page
|
||||
pdf.SetFontStyle('B',11)
|
||||
buf = "#{issue.project} - #{issue.tracker} ##{issue.id}"
|
||||
pdf.RDMMultiCell(190, 5, buf)
|
||||
pdf.SetFontStyle('',8)
|
||||
base_x = pdf.get_x
|
||||
i = 1
|
||||
issue.ancestors.visible.each do |ancestor|
|
||||
pdf.set_x(base_x + i)
|
||||
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}"
|
||||
pdf.RDMMultiCell(190 - i, 5, buf)
|
||||
i += 1 if i < 35
|
||||
end
|
||||
pdf.SetFontStyle('B',11)
|
||||
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
||||
pdf.ln
|
||||
|
||||
customer = issue.customer.name if issue.customer
|
||||
left = []
|
||||
left << [l(:field_status), issue.status]
|
||||
left << [l(:field_priority), issue.priority]
|
||||
left << [l(:field_customer), customer]
|
||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
|
||||
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id)
|
||||
|
||||
log "Calling :pdf_left hook"
|
||||
left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue }
|
||||
unless left_hook_output.nil?
|
||||
left_hook_output.each do |l|
|
||||
left.concat l unless l.nil?
|
||||
end
|
||||
end
|
||||
|
||||
right = []
|
||||
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
||||
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
||||
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
||||
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
||||
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
||||
|
||||
log "Calling :pdf_right hook"
|
||||
right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue }
|
||||
unless right_hook_output.nil?
|
||||
right_hook_output.each do |r|
|
||||
right.concat r unless r.nil?
|
||||
end
|
||||
end
|
||||
|
||||
rows = left.size > right.size ? left.size : right.size
|
||||
while left.size < rows
|
||||
left << nil
|
||||
end
|
||||
while right.size < rows
|
||||
right << nil
|
||||
end
|
||||
|
||||
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
||||
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
||||
(i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)]
|
||||
end
|
||||
|
||||
if pdf.get_rtl
|
||||
border_first_top = 'RT'
|
||||
border_last_top = 'LT'
|
||||
border_first = 'R'
|
||||
border_last = 'L'
|
||||
else
|
||||
border_first_top = 'LT'
|
||||
border_last_top = 'RT'
|
||||
border_first = 'L'
|
||||
border_last = 'R'
|
||||
end
|
||||
|
||||
rows = left.size > right.size ? left.size : right.size
|
||||
rows.times do |i|
|
||||
heights = []
|
||||
pdf.SetFontStyle('B',9)
|
||||
item = left[i]
|
||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
||||
item = right[i]
|
||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
||||
pdf.SetFontStyle('',9)
|
||||
item = left[i]
|
||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
||||
item = right[i]
|
||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
||||
height = heights.max
|
||||
|
||||
item = left[i]
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
||||
pdf.SetFontStyle('',9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0)
|
||||
|
||||
item = right[i]
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
||||
pdf.SetFontStyle('',9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2)
|
||||
|
||||
pdf.set_x(base_x)
|
||||
end
|
||||
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
|
||||
pdf.SetFontStyle('',9)
|
||||
|
||||
# Set resize image scale
|
||||
pdf.set_image_scale(1.6)
|
||||
text = textilizable(issue, :description,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false
|
||||
)
|
||||
pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue.attachments, "LRB")
|
||||
|
||||
unless issue.leaf?
|
||||
truncate_length = (!is_cjk? ? 90 : 65)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR")
|
||||
pdf.ln
|
||||
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
||||
buf = "#{child.tracker} # #{child.id}: #{child.subject}".
|
||||
truncate(truncate_length)
|
||||
level = 10 if level >= 10
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, border_first)
|
||||
pdf.SetFontStyle('B',8)
|
||||
pdf.RDMCell(20,5, child.status.to_s, border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
||||
unless relations.empty?
|
||||
truncate_length = (!is_cjk? ? 80 : 60)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR")
|
||||
pdf.ln
|
||||
relations.each do |relation|
|
||||
buf = relation.to_s(issue) {|other|
|
||||
text = ""
|
||||
if Setting.cross_project_issue_relations?
|
||||
text += "#{relation.other_issue(issue).project} - "
|
||||
end
|
||||
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
||||
text
|
||||
}
|
||||
buf = buf.truncate(truncate_length)
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(35+155-60, 5, buf, border_first)
|
||||
pdf.SetFontStyle('B',8)
|
||||
pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "")
|
||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "")
|
||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
pdf.RDMCell(190,5, "", "T")
|
||||
pdf.ln
|
||||
|
||||
if issue.changesets.any? &&
|
||||
User.current.allowed_to?(:view_changesets, issue.project)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
|
||||
pdf.ln
|
||||
for changeset in issue.changesets
|
||||
pdf.SetFontStyle('B',8)
|
||||
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
|
||||
csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
|
||||
pdf.RDMCell(190, 5, csstr)
|
||||
pdf.ln
|
||||
unless changeset.comments.blank?
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMwriteHTMLCell(190,5,'','',
|
||||
changeset.comments.to_s, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
if assoc[:journals].present?
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_history), "B")
|
||||
pdf.ln
|
||||
assoc[:journals].each do |journal|
|
||||
pdf.SetFontStyle('B',8)
|
||||
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
||||
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
||||
pdf.RDMCell(190,5, title)
|
||||
pdf.ln
|
||||
pdf.SetFontStyle('I',8)
|
||||
details_to_strings(journal.visible_details, true).each do |string|
|
||||
pdf.RDMMultiCell(190,5, "- " + string)
|
||||
end
|
||||
if journal.notes?
|
||||
pdf.ln unless journal.details.empty?
|
||||
pdf.SetFontStyle('',8)
|
||||
text = textilizable(journal, :notes,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false
|
||||
)
|
||||
pdf.RDMwriteFormattedCell(190,5,'','', text, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
if issue.attachments.any?
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
|
||||
pdf.ln
|
||||
for attachment in issue.attachments
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMCell(80,5, attachment.filename)
|
||||
pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
|
||||
pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
|
||||
pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
# Check to see if there is an estimate attached, then combine them
|
||||
if issue.estimate
|
||||
e_pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
|
||||
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
||||
pdf << CombinePDF.parse(e_pdf)
|
||||
return pdf.to_pdf
|
||||
end
|
||||
|
||||
return pdf.output
|
||||
end
|
||||
render_description(pdf, issue)
|
||||
render_subtasks(pdf, issue)
|
||||
render_relations(pdf, issue)
|
||||
render_changesets(pdf, issue)
|
||||
render_journals(pdf, issue, assoc)
|
||||
render_attachments(pdf, issue)
|
||||
|
||||
merge_estimate_if_present(pdf, issue)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[PdfPatch] #{msg}"
|
||||
Rails.logger.info "[PdfPatch] #{msg}"
|
||||
end
|
||||
|
||||
def setup_pdf(issue)
|
||||
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
||||
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.alias_nb_pages
|
||||
pdf.footer_date = format_date(Date.today)
|
||||
pdf.add_page
|
||||
pdf
|
||||
end
|
||||
|
||||
def render_header(pdf, issue)
|
||||
pdf.SetFontStyle('B', 11)
|
||||
pdf.RDMMultiCell(190, 5, "#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.SetFontStyle('', 8)
|
||||
end
|
||||
|
||||
def render_ancestors_and_subject(pdf, issue)
|
||||
base_x = pdf.get_x
|
||||
i = 1
|
||||
|
||||
# Render ancestors
|
||||
issue.ancestors.visible.each do |ancestor|
|
||||
pdf.set_x(base_x + i)
|
||||
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}"
|
||||
pdf.RDMMultiCell(190 - i, 5, buf)
|
||||
i += 1 if i < 35
|
||||
end
|
||||
|
||||
# Render current issue subject and meta
|
||||
pdf.SetFontStyle('B', 11)
|
||||
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
||||
pdf.ln
|
||||
end
|
||||
|
||||
def build_issue_attributes(issue)
|
||||
left = build_left_attributes(issue)
|
||||
right = build_right_attributes(issue)
|
||||
|
||||
# Pad arrays to equal length
|
||||
rows = [left.size, right.size].max
|
||||
left.fill(nil, left.size...rows)
|
||||
right.fill(nil, right.size...rows)
|
||||
|
||||
# Distribute custom fields evenly
|
||||
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
||||
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
||||
target_column = i < half ? left : right
|
||||
target_column << [custom_value.custom_field.name, show_value(custom_value, false)]
|
||||
end
|
||||
|
||||
[left, right]
|
||||
end
|
||||
|
||||
def build_left_attributes(issue)
|
||||
left = []
|
||||
left << [l(:field_status), issue.status]
|
||||
left << [l(:field_priority), issue.priority]
|
||||
left << [l(:field_customer), issue.customer&.name]
|
||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
|
||||
log "Calling :pdf_left hook"
|
||||
left_hook_output = Redmine::Hook.call_hook(:pdf_left, { issue: issue })
|
||||
Array(left_hook_output).compact.each { |l| left.concat(l) }
|
||||
|
||||
left
|
||||
end
|
||||
|
||||
def build_right_attributes(issue)
|
||||
right = []
|
||||
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
||||
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
||||
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
||||
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
||||
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
||||
|
||||
log "Calling :pdf_right hook"
|
||||
right_hook_output = Redmine::Hook.call_hook(:pdf_right, { issue: issue })
|
||||
Array(right_hook_output).compact.each { |r| right.concat(r) }
|
||||
|
||||
right
|
||||
end
|
||||
|
||||
def render_attributes_grid(pdf, left, right)
|
||||
base_x = pdf.get_x
|
||||
borders = determine_borders(pdf.get_rtl)
|
||||
rows = [left.size, right.size].max
|
||||
|
||||
rows.times do |i|
|
||||
item_left = left[i]
|
||||
item_right = right[i]
|
||||
|
||||
# Calculate dynamic row height
|
||||
pdf.SetFontStyle('B', 9)
|
||||
hl1 = pdf.get_string_height(35, item_left ? "#{item_left.first}:" : "")
|
||||
hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
hl2 = pdf.get_string_height(60, item_left ? item_left.last.to_s : "")
|
||||
hr2 = pdf.get_string_height(60, item_right ? item_right.last.to_s : "")
|
||||
|
||||
height = [hl1, hr1, hl2, hr2].max
|
||||
|
||||
# Render cells
|
||||
render_grid_cell(pdf, item_left, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 0)
|
||||
render_grid_cell(pdf, item_right, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 2)
|
||||
|
||||
pdf.set_x(base_x)
|
||||
end
|
||||
end
|
||||
|
||||
def determine_borders(is_rtl)
|
||||
if is_rtl
|
||||
{ first_top: 'RT', last_top: 'LT', first: 'R', last: 'L' }
|
||||
else
|
||||
{ first_top: 'LT', last_top: 'RT', first: 'L', last: 'R' }
|
||||
end
|
||||
end
|
||||
|
||||
def render_grid_cell(pdf, item, height, border_label, border_val, ln_type)
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", border_val, '', 0, ln_type)
|
||||
end
|
||||
|
||||
def render_description(pdf, issue)
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:field_description), "LRT", 1)
|
||||
pdf.SetFontStyle('', 9)
|
||||
|
||||
pdf.set_image_scale(1.6)
|
||||
text = textilizable(issue, :description,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false)
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
|
||||
end
|
||||
|
||||
def render_subtasks(pdf, issue)
|
||||
return if issue.leaf?
|
||||
|
||||
truncate_length = !is_cjk? ? 90 : 65
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, "#{l(:label_subtask_plural)}:", "LTR")
|
||||
pdf.ln
|
||||
|
||||
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||
|
||||
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
||||
buf = "#{child.tracker} # #{child.id}: #{child.subject}".truncate(truncate_length)
|
||||
level = 10 if level >= 10
|
||||
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(170, 5, (level >= 1 ? " " * level : "") + buf, border_first)
|
||||
pdf.SetFontStyle('B', 8)
|
||||
pdf.RDMCell(20, 5, child.status.to_s, border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_relations(pdf, issue)
|
||||
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
||||
return if relations.empty?
|
||||
|
||||
truncate_length = !is_cjk? ? 80 : 60
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, "#{l(:label_related_issues)}:", "LTR")
|
||||
pdf.ln
|
||||
|
||||
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||
|
||||
relations.each do |relation|
|
||||
other = relation.other_issue(issue)
|
||||
text = Setting.cross_project_issue_relations? ? "#{other.project} - " : ""
|
||||
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
||||
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(130, 5, text.truncate(truncate_length), border_first)
|
||||
pdf.SetFontStyle('B', 8)
|
||||
pdf.RDMCell(20, 5, other.status.to_s, "")
|
||||
pdf.RDMCell(20, 5, format_date(other.start_date), "")
|
||||
pdf.RDMCell(20, 5, format_date(other.due_date), border_last)
|
||||
pdf.ln
|
||||
end
|
||||
pdf.RDMCell(190, 5, "", "T")
|
||||
pdf.ln
|
||||
end
|
||||
|
||||
def render_changesets(pdf, issue)
|
||||
return unless issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_associated_revisions), "B")
|
||||
pdf.ln
|
||||
|
||||
issue.changesets.each do |changeset|
|
||||
pdf.SetFontStyle('B', 8)
|
||||
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - #{format_time(changeset.committed_on)} - #{changeset.author}"
|
||||
pdf.RDMCell(190, 5, csstr)
|
||||
pdf.ln
|
||||
|
||||
unless changeset.comments.blank?
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMwriteHTMLCell(190, 5, '', '', changeset.comments.to_s, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_journals(pdf, issue, assoc)
|
||||
return unless assoc[:journals].present?
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_history), "B")
|
||||
pdf.ln
|
||||
|
||||
assoc[:journals].each do |journal|
|
||||
pdf.SetFontStyle('B', 8)
|
||||
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
||||
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
||||
pdf.RDMCell(190, 5, title)
|
||||
pdf.ln
|
||||
|
||||
pdf.SetFontStyle('I', 8)
|
||||
details_to_strings(journal.visible_details, true).each do |string|
|
||||
pdf.RDMMultiCell(190, 5, "- " + string)
|
||||
end
|
||||
|
||||
if journal.notes?
|
||||
pdf.ln unless journal.details.empty?
|
||||
pdf.SetFontStyle('', 8)
|
||||
text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_attachments(pdf, issue)
|
||||
return unless issue.attachments.any?
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_attachment_plural), "B")
|
||||
pdf.ln
|
||||
|
||||
issue.attachments.each do |attachment|
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(80, 5, attachment.filename)
|
||||
pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R")
|
||||
pdf.RDMCell(25, 5, format_date(attachment.created_on), 0, 0, "R")
|
||||
pdf.RDMCell(65, 5, attachment.author.name, 0, 0, "R")
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def merge_estimate_if_present(pdf, issue)
|
||||
if issue.estimate
|
||||
e_pdf, _ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
|
||||
combined = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
||||
combined << CombinePDF.parse(e_pdf)
|
||||
combined.to_pdf
|
||||
else
|
||||
pdf.output
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,11 +8,10 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'issue_query'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module QueryPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def base_scope
|
||||
scope = super
|
||||
@@ -59,12 +58,6 @@ module RedmineQbo
|
||||
|
||||
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
IssueQuery.send(:prepend, QueryPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,11 +8,10 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'time_entry_query'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module TimeEntryQueryPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
# Add QBO options to columns
|
||||
def available_columns
|
||||
@@ -28,11 +27,6 @@ module RedmineQbo
|
||||
add_available_filter "billed", type: :boolean
|
||||
super
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to TimeEntryQuery
|
||||
TimeEntryQuery.send(:prepend, QueryPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,37 +8,14 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'user'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
|
||||
# Patches Redmine's User dynamically.
|
||||
# Adds a relationships
|
||||
module UserPatch
|
||||
def self.included(base) # :nodoc:
|
||||
base.extend(ClassMethods)
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
base.send(:include, InstanceMethods)
|
||||
|
||||
# Same as typing in the class
|
||||
base.class_eval do
|
||||
prepended do
|
||||
belongs_to :employee, primary_key: :id
|
||||
end
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
|
||||
end
|
||||
|
||||
module InstanceMethods
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
User.send(:include, UserPatch)
|
||||
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user