New plugin: print part labels on a Brother QL printer

Print label in the top-right actions of issues, estimates and invoices
prints the customer's last name and the PO number (W/E/I + number) in big
bold letters on a 62mm continuous roll, with a preview of the label and
its status until it's printed. A print agent on the printer's network
(redmine_qbo_label_agent) asks Redmine for labels every couple of seconds
with its printer's token, so labels print from anywhere.

Administration » Label printers: printers, agent tokens and status,
recent labels. Settings: label lengths, capitals, poll interval, how long
a label waits for an offline agent, and logging the agents' requests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-16 08:42:16 -05:00
commit 3e29f14f76
41 files changed
+2194

No files matched your search

+61
View File
@@ -0,0 +1,61 @@
#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.
# The print agent's API (redmine-qbo-label-agent). The agent runs on the printer's network, so Redmine never
# needs to reach the printer: the agent signs in with its printer's token (Authorization: Bearer <token>),
# asks for the next label every couple of seconds, prints it, and reports back.
#
# POST /label_agent/poll { "agent": { "version", "printer_model", "printer_address",
# "printer_status" } } (agent is optional)
# => { "job": { "id", "lines", "copies", "max_length_mm", "min_length_mm" } | null, "poll_seconds" }
# POST /label_agent/jobs/:id/result { "status": "printed" | "failed", "error": "..." }
# => { "ok": true }
class LabelAgentController < ActionController::API
before_action :authenticate_agent
def poll
@printer.seen!(ip: request.remote_ip, agent: agent_params)
job = LabelJob.claim_next(@printer)
log_request(job ? "sent job #{job.id}" : 'no job')
render json: { job: job&.to_agent_json, poll_seconds: RedmineQboLabels::Settings.poll_seconds }
end
def result
job = @printer.label_jobs.find_by(id: params[:id])
return render(json: { error: 'not found' }, status: :not_found) unless job
# A repeated report (the agent retrying after a dropped connection) changes nothing
job.finish!(printed: params[:status] == 'printed', error: params[:error]) unless job.finished?
log_request("job #{job.id} #{job.status}#{" (#{job.error})" if job.error.present?}")
render json: { ok: true, status: job.status }
end
private
def authenticate_agent
token = request.authorization.to_s[/\ABearer\s+(\S+)\z/, 1]
@printer = LabelPrinter.authenticate(token)
return if @printer
Rails.logger.warn "[redmine_qbo_labels] Print agent from #{request.remote_ip} has an unknown token"
render json: { error: 'unauthorized' }, status: :unauthorized
end
def agent_params
agent = params[:agent]
agent.respond_to?(:permit) ? agent.permit(:version, :printer_model, :printer_address, :printer_status).to_h : nil
end
def log_request(message)
return unless RedmineQboLabels::Settings.log_requests?
Rails.logger.info "[redmine_qbo_labels] #{@printer.name} agent (#{request.remote_ip}): #{message}"
end
end
+59
View File
@@ -0,0 +1,59 @@
#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.
# The Print label dialog: opened from an issue, estimate or invoice (new), sends the label to a printer's
# queue (create), and follows it until it's printed (show, polled by the dialog). The dialog asks for show's
# JSON with an Accept header, not a .json URL: Redmine treats .json as the REST API, without the session.
class LabelJobsController < ApplicationController
before_action :authorize_global
before_action :find_source, only: [:new, :create]
before_action :find_printers, only: [:new, :create]
def new
@lines = @source.lines
@copies = 1
respond_to { |format| format.js }
end
def create
@lines = Array(params[:lines]).first(LabelJob::MAX_LINES)
@copies = params[:copies].to_i.clamp(1, LabelJob::MAX_COPIES)
printer = @printers.find { |p| p.id == params[:printer_id].to_i } || @printers.first
@job = LabelJob.new(label_printer: printer, user: User.current, lines: @lines, copies: @copies,
source_type: @source.type, source_id: @source.id.to_s)
@job.save if printer
respond_to { |format| format.js }
end
def show
@job = LabelJob.find_by(id: params[:id])
return render_404 unless @job && (@job.user_id == User.current.id || User.current.admin?)
LabelJob.expire_lapsed unless @job.finished?
@job.reload
respond_to do |format|
format.json do
render json: { id: @job.id, status: @job.status, status_label: @job.status_label, error: @job.error,
finished: @job.finished?, printer_online: @job.label_printer.online? }
end
end
end
private
def find_source
@source = RedmineQboLabels::LabelSource.find(params[:source_type], params[:source_id])
render_404 unless @source
end
def find_printers
@printers = LabelPrinter.active.sorted.to_a
end
end
@@ -0,0 +1,82 @@
#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.
# Administration » Label printers: the printers (one print agent each), their agents' tokens and status, and
# the labels printed lately
class LabelPrintersController < ApplicationController
layout 'admin'
self.main_menu = false
menu_item :label_printers
before_action :require_admin
before_action :find_printer, only: [:edit, :update, :destroy, :regenerate_token]
def index
@printers = LabelPrinter.sorted.to_a
LabelJob.expire_lapsed
@jobs = LabelJob.recent.includes(:label_printer, :user).limit(50)
end
def new
@printer = LabelPrinter.new
end
def create
@printer = LabelPrinter.new(printer_params)
@printer.generate_token
if @printer.save
render_token
else
render action: 'new'
end
end
def edit; end
def update
if @printer.update(printer_params)
flash[:notice] = l(:notice_successful_update)
redirect_to label_printers_path
else
render action: 'edit'
end
end
# A new token for the printer's agent; the old one stops working right away
def regenerate_token
@printer.generate_token
@printer.save!
render_token
end
def destroy
@printer.destroy
flash[:notice] = l(:notice_successful_delete)
redirect_to label_printers_path
end
private
def find_printer
@printer = LabelPrinter.find(params[:id])
rescue ActiveRecord::RecordNotFound
render_404
end
def printer_params
params.require(:label_printer).permit(:name, :active)
end
# The token is only ever shown here, right after it's made
def render_token
response.headers['Cache-Control'] = 'no-store'
render action: 'token'
end
end