Fix expenses export with multi page pdf (64085)

Author: anna-dev

app/assets/javascripts/expenses.js.coffee

@@ -13,16 +13,13 @@ $(document).on 'ready, turbolinks:load', ->
   toggle_project_display = () ->
 
     if expense_kind_input.val() == 'project'
-      # if order_input.value and not order_selectized_input.value
-      #   input[0].value = ' '
-
       order_form_group.show()
       order_selectized_input.attr('disabled', false)
     else
       order_form_group.hide()
       order_selectized_input.attr('disabled', true)
 
-  check_file_type = (initial = false) ->
+  check_file_type = () ->
     warning_popup.addClass('hidden')
 
     return unless (typeof receipt_input != "undefined" && receipt_input != null) && receipt_input[0].files.length > 0
@@ -32,7 +29,7 @@ $(document).on 'ready, turbolinks:load', ->
     unless /^image/.test(file_type) or file_type == 'application/pdf'
       warning_popup.removeClass('hidden')
 
-  check_file_type(true)
+  check_file_type()
   toggle_project_display()
 
   expense_kind_input.change (e) ->

app/controllers/expenses_controller.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 class ExpensesController < ManageController
+  require 'ruby-vips'
   include Filterable
+
   self.optional_nesting = [Employee]
 
   self.permitted_attrs = %i[payment_date employee_id kind order_id description amount receipt]
@@ -117,69 +119,39 @@ def receipt_param
     params.dig(model_identifier, :receipt)
   end
 
-  def pdf_pages_amount(filepath_pdf)
-    first_page = Vips::Image.new_from_file(filepath_pdf, page: 0, n: 1)
-    first_page.get('n-pages')
-  end
+  def attach_resized_receipt
+    return unless receipt_param
 
-  def get_pdf_pages_as_images(filepath_pdf)
-    images = []
-    total_pages = pdf_pages_amount(filepath_pdf)
-    (0...total_pages).each do |page_num|
-      image = Vips::Image.new_from_file(filepath_pdf, page: page_num)
-      image = image.thumbnail_image(Settings.expenses.receipt.max_pixel)
-      images << image
+    case receipt_param.content_type
+    when 'application/pdf' then attach_pdf
+    when /image/ then attach_image
     end
-    images
   end
 
-  def combine_images(images, rows, columns)
-    rows_of_images = []
-    (0...rows).each do |row_num|
-      start_index = row_num * columns
-      row_images = images[start_index, columns] || []
-      # Ensure all rows are the same length by padding with blank images (if necessary)
-      row_images += [Vips::Image.black(images.first.width, images.first.height)] * (columns - row_images.size)
+  def attach_image
+    resized = ::ImageProcessing::Vips
+              .source(receipt_param.tempfile)
+              .resize_to_limit(Settings.expenses.receipt.max_pixel, Settings.expenses.receipt.max_pixel)
+              .saver(quality: Settings.expenses.receipt.quality)
+              .convert('jpg')
+              .loader(page: 0)
+              .call
 
-      row_image = row_images.reduce { |a, b| a.join(b, :horizontal) }
-      rows_of_images << row_image
-    end
+    target_filename = "#{File.basename(receipt_param.original_filename.to_s, '.*')}.jpg"
 
-    rows_of_images.reduce { |a, b| a.join(b, :vertical) }
+    entry.receipt.attach(io: File.open(resized), filename: target_filename, content_type: 'image/jpeg')
   end
 
-  def attach_resized_receipt
-    return unless receipt_param
-
-    if receipt_param.content_type == 'application/pdf'
-      pdf_path = receipt_param.tempfile.path
-      images = get_pdf_pages_as_images(pdf_path)
-      basename = File.basename(receipt_param.original_filename.to_s, '.*')
+  def attach_pdf
+    tmp_file = receipt_param.tempfile
+    filename = "#{File.basename(receipt_param.original_filename.to_s, '.*')}.pdf"
+    page_count = pdf_pages_amount(tmp_file.path)
 
-      # Calculate the number of rows and columns to fit all images in a square grid
-      total_pages = pdf_pages_amount(pdf_path)
-      grid_size = Math.sqrt(total_pages).ceil
-      rows = grid_size
-      columns = (total_pages.to_f / grid_size).ceil
-
-      combined_image = combine_images(images, rows, columns)
-
-      output_path = Rails.root.join('tmp', "#{basename}.jpg")
-      combined_image.write_to_file(output_path.to_s, Q: Settings.expenses.receipt.quality)
-
-      entry.receipt.attach(io: File.open(output_path), filename: "#{basename}.jpg", content_type: 'image/jpeg')
-    else
-      resized = ImageProcessing::Vips
-                .source(receipt_param.tempfile)
-                .resize_to_limit(Settings.expenses.receipt.max_pixel, Settings.expenses.receipt.max_pixel)
-                .saver(quality: Settings.expenses.receipt.quality)
-                .convert('jpg')
-                .loader(page: 0)
-                .call
-
-      target_filename = "#{File.basename(receipt_param.original_filename.to_s, '.*')}.jpg"
+    entry.receipt.attach(io: File.open(tmp_file), filename:, content_type: 'application/pdf', metadata: { page_count: })
+  end
 
-      entry.receipt.attach(io: File.open(resized), filename: target_filename, content_type: 'image/jpeg')
-    end
+  def pdf_pages_amount(filepath_pdf)
+    first_page = ::Vips::Image.new_from_file(filepath_pdf, page: 0, n: 1)
+    first_page.get('n-pages')
   end
 end

app/domain/expenses/pdf_export.rb

@@ -32,16 +32,32 @@ def expenses
     def build
       validate
       setup_fonts
-      expenses.each_with_index do |e, i|
-        @expense = e
+      pages.each_with_index do |e, i|
+        @expense = e[:expense]
         pdf.start_new_page unless i.zero?
-        add_header
-        add_receipt
+        add_header if e[:header]
+        add_receipt(e[:page])
         reset_model_data
       end
       pdf.number_pages('Seite <page>/<total>', at: [pdf.bounds.right - 60, pdf.bounds.bottom + 5])
     end
 
+    def pages
+      expenses.flat_map do |exp|
+        if exp.receipt.content_type == 'application/pdf' && page_count(exp) > 1
+          (1..exp.receipt.metadata[:page_count]).to_a.flat_map do |page_num|
+            { header: page_num == 1, expense: exp, page: page_num }
+          end
+        else
+          { header: true, expense: exp, page: 1 }
+        end
+      end
+    end
+
+    def page_count(exp)
+      exp.receipt.metadata[:page_count]
+    end
+
     def generate
       build
       pdf.render_file FILENAME
@@ -157,7 +173,7 @@ def attribute(title, value)
     end
 
     def receipt_printable?
-      receipt.attached? && receipt.image? # Currently, previewables will not be handled
+      receipt.attached? && (receipt.image? || receipt.content_type == 'application/pdf') # Currently, previewables will not be handled
     end
 
     def receipt
@@ -171,23 +187,45 @@ def receipt_text
       'Es wurde kein Beleg beigelegt.'
     end
 
-    def add_receipt
+    def add_receipt(page)
       return unless receipt_printable?
 
+      case receipt.content_type
+      when 'application/pdf' then add_pdf_receipt(page - 1)
+      when /image/ then add_image_receipt
+      end
+    end
+
+    def add_image_receipt
       blob.open do |file|
         # Vips auto rotates by default
         image = ::Vips::Image.new_from_file(file.path)
-        rotated = ImageProcessing::Vips.source(image)
+        rotated = ::ImageProcessing::Vips.source(image)
         rotated.write_to_file(file.path)
         pdf.image file.path, position: :center, fit: [image_width, image_height]
       end
     rescue StandardError => e
-      add_text "Error while adding picture for expense #{@expense.id}"
-      add_text "Message: #{e.message}"
+      add_receipt_adding_errors(e, 'image')
+    end
+
+    def add_pdf_receipt(page_num)
+      blob.open do |file|
+        pdf_image = ::Vips::Image.new_from_file(file.path, page: page_num)
+        image = pdf_image.thumbnail_image(Settings.expenses.receipt.max_pixel)
+        source = ::ImageProcessing::Vips.source(image)
+        pdf.image source.call, position: :center, fit: [image_width, image_height]
+      end
+    rescue StandardError => e
+      add_receipt_adding_errors(e, 'pdf')
+    end
+
+    def add_receipt_adding_errors(error, file_type)
+      add_text "Error while adding #{file_type} for expense #{@expense.id}"
+      add_text "Message: #{error.message}"
 
-      Rails.logger.info "Error while adding picture for expense #{@expense.id}"
-      Rails.logger.info "Message: #{e.message}"
-      Rails.logger.info "Backtrace: #{e.backtrace.inspect}"
+      Rails.logger.info "Error while adding #{file_type} for expense #{@expense.id}"
+      Rails.logger.info "Message: #{error.message}"
+      Rails.logger.info "Backtrace: #{error.backtrace.inspect}"
     end
 
     def blob

config/locales/views.de-CH.yml

@@ -8,47 +8,46 @@ de-CH:
   version:
     model:
       create:
-        employee: "Der Member #%{id} wurde erstellt."
-        employment: "Die Anstellung #%{id} wurde erstellt."
-        employmentrolesemployment: "Der Funktionsanteil \"%{role}\" der Anstellung #%{employment_id} wurde erstellt."
+        employee: 'Der Member #%{id} wurde erstellt.'
+        employment: 'Die Anstellung #%{id} wurde erstellt.'
+        employmentrolesemployment: 'Der Funktionsanteil "%{role}" der Anstellung #%{employment_id} wurde erstellt.'
       update:
-        employee: "Der Member #%{id} wurde bearbeitet."
-        employment: "Die Anstellung #%{id} wurde bearbeitet."
-        employmentrolesemployment: "Der Funktionsanteil \"%{role}\" der Anstellung #%{employment_id} wurde bearbeitet."
+        employee: 'Der Member #%{id} wurde bearbeitet.'
+        employment: 'Die Anstellung #%{id} wurde bearbeitet.'
+        employmentrolesemployment: 'Der Funktionsanteil "%{role}" der Anstellung #%{employment_id} wurde bearbeitet.'
       destroy:
-        employee: "Der Member #%{id} wurde gelöscht."
-        employment: "Die Anstellung #%{id} wurde gelöscht."
-        employmentrolesemployment: "Der Funktionsanteil \"%{role}\" der Anstellung #%{employment_id} wurde gelöscht."
+        employee: 'Der Member #%{id} wurde gelöscht.'
+        employment: 'Die Anstellung #%{id} wurde gelöscht.'
+        employmentrolesemployment: 'Der Funktionsanteil "%{role}" der Anstellung #%{employment_id} wurde gelöscht.'
     model_reference:
-      employee: "des Members"
-      employment: "der Anstellung"
-      employmentrolesemployment: "des Funktionsanteils"
+      employee: 'des Members'
+      employment: 'der Anstellung'
+      employmentrolesemployment: 'des Funktionsanteils'
     attribute_change:
-      from_to: "%{attr} %{model_ref} wurde von «%{from}» auf «%{to}» geändert."
-      from: "%{attr} %{model_ref} «%{from}» wurde gelöscht."
-      to: "%{attr} %{model_ref} wurde auf «%{to}» gesetzt."
+      from_to: '%{attr} %{model_ref} wurde von «%{from}» auf «%{to}» geändert.'
+      from: '%{attr} %{model_ref} «%{from}» wurde gelöscht.'
+      to: '%{attr} %{model_ref} wurde auf «%{to}» gesetzt.'
 
   expenses: &expenses
     new:
-      title: "%{model} erfassen"
+      title: '%{model} erfassen'
     create:
-      title: "%{model} erfassen"
+      title: '%{model} erfassen'
       flash:
-        success: "%{model} wurden erfolgreich erfasst."
+        success: '%{model} wurden erfolgreich erfasst.'
     update:
       flash:
-        success: "%{model} wurden erfolgreich aktualisiert."
+        success: '%{model} wurden erfolgreich aktualisiert.'
     destroy:
       flash:
-        success: "%{model} wurden erfolgreich gelöscht."
-        failure: "%{model} konnten nicht gelöscht werden."
+        success: '%{model} wurden erfolgreich gelöscht.'
+        failure: '%{model} konnten nicht gelöscht werden.'
     attachment:
-      name: "Anhang"
-      show: "Anzeigen"
-      hint: "Der Beleg muss ein Bild und gut lesbar sein und den Kaufpreis, das Kaufdatum und die MWST-Nummer enthalten."
+      name: 'Anhang'
+      show: 'Anzeigen'
+      hint: 'Der Beleg muss ein gut lesbares Bild oder PDF sein und den Kaufpreis, das Kaufdatum und die MWST-Nummer enthalten.'
     global:
       link:
         add: Erfassen
 
   expenses_reviews: *expenses
-...