mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-17 18:20:36 -05:00
Security, permission and search fixes
Security - Connecting to QuickBooks (authenticate/oauth_callback) and all syncs are admin-only; the OAuth state is stored and verified on callback - New "Bill issue time to QuickBooks" project permission; billing is now a POST and checks the permission and issue visibility - Estimate/invoice PDFs require a logged-in user, or a customer share link limited to the estimate and invoices attached to that issue (the old require_user check never ran) - Attachments patch keeps the share token per request instead of in Thread.current, so it can't leak into other requests Permissions and share links - customers#autocomplete and the filter_* actions are part of View customers, so non-admins can pick customers on forms - customers#view no longer goes through authorize_global; share needs the new "Share issues with customers" permission and a visible issue - Removed a check in customers#view that compared a value to itself Bugs - Subjects and customer names capitalize each word without lowercasing the rest (LED, JL, 4x4 stay as typed); subjects only when changed - Settings page shows Invoice/Estimate sync times (Item/Account models no longer exist) - customers#update shows validation errors instead of reporting success - Billing marks each activity billed once sent to QBO, so retries and token refreshes don't create duplicate TimeActivities Search - New CustomerSearchService for autocomplete and the customer search page: nicknames (Bill/William), typos, word order, partial words, accents, and phone digits in any format; ranked, with the candidate list cached until a customer changes Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
This commit is contained in:
18 files changed
+412
-111
No files matched your search
@@ -26,9 +26,11 @@ class CustomersController < ApplicationController
|
||||
helper :timelog
|
||||
|
||||
# This tells Redmine to check global permissions for the current controller/action
|
||||
before_action :authorize_global
|
||||
# customers#view is the public share-link page: it is authorized by its token, not by Redmine permissions
|
||||
before_action :authorize_global, except: [:view]
|
||||
before_action :add_customer, only: [:new, :create]
|
||||
before_action :view_customer, except: [:new, :create, :view]
|
||||
before_action :view_customer, except: [:new, :create, :view, :share, :sync]
|
||||
before_action :require_admin, only: :sync
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||
|
||||
def address_to_s(address)
|
||||
@@ -61,45 +63,12 @@ class CustomersController < ApplicationController
|
||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||
end
|
||||
|
||||
# Used for autocomplete form
|
||||
# Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
|
||||
# staff spot an existing customer before creating a duplicate. See CustomerSearchService.
|
||||
def autocomplete
|
||||
# Support both existing 'q' param and new 'name'/'phone' params
|
||||
name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
|
||||
phone_query = params[:phone].to_s.gsub(/\D/, '')
|
||||
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
|
||||
|
||||
sql_matches = []
|
||||
|
||||
# 1. Check for phone number matches via SQL
|
||||
if phone_query.present?
|
||||
sql_matches += Customer.where("phone_number LIKE :p OR mobile_phone_number LIKE :p", p: "%#{phone_query}%")
|
||||
end
|
||||
|
||||
# 2. Check for exact or partial name matches via SQL
|
||||
if name_query.present?
|
||||
safe_name = ActiveRecord::Base.sanitize_sql_like(name_query)
|
||||
sql_matches += Customer.where("name LIKE :t", t: "%#{safe_name}%")
|
||||
end
|
||||
|
||||
sql_matches = sql_matches.uniq
|
||||
|
||||
# 3. Handle spelling errors using built-in string distance
|
||||
fuzzy_matches = []
|
||||
if name_query.present?
|
||||
require 'did_you_mean/jaro_winkler'
|
||||
|
||||
# Only scan records we haven't already matched
|
||||
unmatched = Customer.all - sql_matches
|
||||
|
||||
fuzzy_matches = unmatched.select do |c|
|
||||
# 0.6 is the threshold. 1.0 is an exact match.
|
||||
DidYouMean::JaroWinkler.distance(c.name.to_s.downcase, name_query.downcase) > 0.6
|
||||
end
|
||||
end
|
||||
|
||||
# Combine results and limit to top 20
|
||||
items = (sql_matches + fuzzy_matches).first(20)
|
||||
|
||||
# Return JSON formatted for both existing usage and new jQuery UI requirements
|
||||
render json: items.map { |i|
|
||||
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
|
||||
}
|
||||
@@ -150,7 +119,7 @@ class CustomersController < ApplicationController
|
||||
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
@customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
@@ -200,8 +169,10 @@ class CustomersController < ApplicationController
|
||||
end
|
||||
|
||||
def share
|
||||
issue = Issue.find(params[:id])
|
||||
issue = Issue.visible.find(params[:id])
|
||||
token = issue.share_token
|
||||
return render_403 unless token
|
||||
|
||||
redirect_to view_path(token.token)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
flash[:error] = t(:notice_issue_not_found)
|
||||
@@ -247,9 +218,14 @@ class CustomersController < ApplicationController
|
||||
|
||||
def update
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
return render_404 unless @customer
|
||||
|
||||
if @customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
else
|
||||
render :edit, status: :unprocessable_entity
|
||||
end
|
||||
rescue => e
|
||||
log "Failed to update customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
@@ -262,7 +238,6 @@ class CustomersController < ApplicationController
|
||||
return render_403 unless @token
|
||||
@issue = @token.issue
|
||||
return render_403 unless @issue
|
||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
||||
session[:token] = @token.token
|
||||
load_issue_data
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
|
||||
@@ -10,7 +10,8 @@
|
||||
class EmployeesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin
|
||||
|
||||
def sync
|
||||
Employee.sync
|
||||
|
||||
@@ -10,9 +10,14 @@
|
||||
class EstimatesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
# PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate).
|
||||
# Redmine's own login check is replaced by require_login_or_customer_token for these actions.
|
||||
skip_before_action :check_if_login_required, only: [:show, :doc]
|
||||
before_action :require_login_or_customer_token, only: [:show, :doc]
|
||||
before_action :load_estimate, only: [:show, :doc]
|
||||
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin, only: :sync
|
||||
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def doc
|
||||
@@ -34,6 +39,10 @@ class EstimatesController < ApplicationController
|
||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||
def load_estimate
|
||||
log "Attempting to load Estimate with params: #{params.inspect}"
|
||||
|
||||
# Share-link customers may only open the estimate attached to their issue (checked before any sync)
|
||||
return load_customer_estimate if customer_token_only?
|
||||
|
||||
@estimate = find_estimate || sync_and_find_estimate
|
||||
|
||||
unless @estimate
|
||||
@@ -41,6 +50,21 @@ class EstimatesController < ApplicationController
|
||||
end
|
||||
end
|
||||
|
||||
# For share-link customers: only the estimate attached to the token's issue, by ID or doc number.
|
||||
def load_customer_estimate
|
||||
estimate = customer_token.issue&.estimate
|
||||
requested =
|
||||
if params[:search].present?
|
||||
estimate && estimate.doc_number.to_s == params[:search].to_s
|
||||
else
|
||||
estimate && estimate.id.to_s == params[:id].to_s
|
||||
end
|
||||
|
||||
return render_403 unless requested
|
||||
|
||||
@estimate = estimate
|
||||
end
|
||||
|
||||
# Attempts to find the estimate locally by ID or doc number.
|
||||
def find_estimate
|
||||
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
||||
|
||||
@@ -10,14 +10,19 @@
|
||||
class InvoicesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
# PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices).
|
||||
# Redmine's own login check is replaced by require_login_or_customer_token for this action.
|
||||
skip_before_action :check_if_login_required, only: :show
|
||||
before_action :require_login_or_customer_token, only: :show
|
||||
before_action :authorize_customer_invoices, only: :show
|
||||
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin, only: :sync
|
||||
|
||||
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
log "Processing request for #{request.original_url}"
|
||||
|
||||
invoice_ids = Array(params[:invoice_ids] || params[:id])
|
||||
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
|
||||
|
||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
@@ -34,6 +39,18 @@ class InvoicesController < ApplicationController
|
||||
|
||||
private
|
||||
|
||||
def invoice_ids
|
||||
@invoice_ids ||= Array(params[:invoice_ids] || params[:id]).map(&:to_s).reject(&:blank?)
|
||||
end
|
||||
|
||||
# Share-link customers may only open invoices attached to their issue
|
||||
def authorize_customer_invoices
|
||||
return true unless customer_token_only?
|
||||
|
||||
allowed = customer_token.issue&.invoice_ids.to_a.map(&:to_s)
|
||||
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceController] #{msg}"
|
||||
|
||||
@@ -11,16 +11,31 @@
|
||||
class QboController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, except: :webhook
|
||||
# Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
|
||||
# The webhook is called by Intuit, not a user, and is verified by its signature instead.
|
||||
before_action :require_admin, except: [:webhook, :bill]
|
||||
before_action :require_login, only: :bill
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
||||
|
||||
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
|
||||
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
|
||||
|
||||
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
|
||||
def authenticate
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
|
||||
state = SecureRandom.urlsafe_base64(32)
|
||||
session[OAUTH_STATE_SESSION_KEY] = state
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
|
||||
end
|
||||
|
||||
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
|
||||
def oauth_callback
|
||||
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
|
||||
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
|
||||
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
|
||||
log "OAuth callback rejected: state did not match"
|
||||
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
|
||||
end
|
||||
|
||||
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
||||
|
||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||
@@ -32,8 +47,10 @@ class QboController < ApplicationController
|
||||
|
||||
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
|
||||
def bill
|
||||
issue = Issue.find_by(id: params[:id])
|
||||
raise I18n.t(:notice_error_issue_not_found) unless issue
|
||||
issue = Issue.visible.find_by(id: params[:id])
|
||||
return render_404 unless issue
|
||||
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
|
||||
|
||||
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||
|
||||
Reference in new issue
Block a user