indifferentketchup/broccolini-bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync broccolini-bot: rename from zammad, docs in docs/, security gitignore, remove zammad deps

Browse Source 
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
samkintop
2026-02-12 02:56:00 -06:00
parent 08a16b4a75
commit 29a13768f7
37 changed files with 1093 additions and 3229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
services/gmail.js
View File

@@ -3,7 +3,7 @@
*/
const { google } = require('googleapis');
const { CONFIG } = require('../config');
const { extractRawEmail } = require('../utils');
const { extractRawEmail, escapeHtml } = require('../utils');
function getGmailClient() {
const auth = new google.auth.OAuth2(
@@ -27,19 +27,23 @@ async function sendGmailReply(
const utf8Subject = `=?utf-8?B?${Buffer.from(
`Re: ${subject}`
).toString('base64')}?=`;
const safeUser = escapeHtml(discordUser);
const safeReply = escapeHtml(replyText).replace(/\n/g, '<br>');
const safeLogoUrl = escapeHtml(CONFIG.LOGO_URL || '');
const safeSignature = escapeHtml(CONFIG.SIGNATURE || '');
const htmlBody = `
<div style="font-family: sans-serif; font-size: 14px; color: #333;">
<p><strong>From:</strong> ${discordUser} on Discord</p>
<p>${replyText.replace(/\n/g, '<br>')}</p>
<p><strong>From:</strong> ${safeUser} on Discord</p>
<p>${safeReply}</p>
<hr style="border:none; border-top:1px solid #ddd; margin:20px 0;">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td style="padding-right: 12px;">
<img src="${CONFIG.LOGO_URL}" width="65">
${safeLogoUrl ? `<img src="${safeLogoUrl}" width="65">` : ''}
</td>
<td style="border-left: 1px solid #ddd; padding-left: 12px;">
<p style="margin: 0; font-weight: bold;">${discordUser}</p>
<div style="color: #666; font-size: 12px;">${CONFIG.SIGNATURE}</div>
<p style="margin: 0; font-weight: bold;">${safeUser}</p>
<div style="color: #666; font-size: 12px;">${safeSignature}</div>
</td>
</tr>
</table>
@@ -100,23 +104,27 @@ async function sendTicketClosedEmail(ticket, discordDisplayName) {
finalSubject
).toString('base64')}?=`;
const serverDisplayName = discordDisplayName || 'Support';
const serverDisplayName = escapeHtml(discordDisplayName || 'Support');
const safeLogoUrl = escapeHtml(CONFIG.LOGO_URL || '');
const safeSignature = escapeHtml(CONFIG.SIGNATURE || '');
const safeCloseMessage = escapeHtml(CONFIG.TICKET_CLOSE_MESSAGE || '').replace(/\n/g, '<br>');
const safeCloseSignature = escapeHtml(CONFIG.TICKET_CLOSE_SIGNATURE || '');
const htmlBody = `
<div style="font-family: sans-serif; font-size: 14px; color: #333;">
<p><strong>From:</strong> ${serverDisplayName} on Discord</p>
<p><strong>Message:</strong></p>
<p>${CONFIG.TICKET_CLOSE_MESSAGE.replace(/\n/g, '<br>')}</p>
<p style="margin-top: 16px;">${CONFIG.TICKET_CLOSE_SIGNATURE}</p>
<p>${safeCloseMessage}</p>
<p style="margin-top: 16px;">${safeCloseSignature}</p>
<hr style="border:none; border-top:1px solid #ddd; margin:20px 0;">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td style="padding-right: 12px;">
<img src="${CONFIG.LOGO_URL}" width="65">
${safeLogoUrl ? `<img src="${safeLogoUrl}" width="65">` : ''}
</td>
<td style="border-left: 1px solid #ddd; padding-left: 12px;">
<p style="margin: 0; font-weight: bold;">${serverDisplayName}</p>
<div style="color: #666; font-size: 12px;">${CONFIG.SIGNATURE}</div>
<div style="color: #666; font-size: 12px;">${safeSignature}</div>
</td>
</tr>
</table>
@@ -180,20 +188,23 @@ async function sendTicketNotificationEmail(ticket, subjectLine, messageBody, fro
const finalSubject = subjectLine || subjectHeader;
const utf8Subject = `=?utf-8?B?${Buffer.from(finalSubject).toString('base64')}?=`;
const label = fromLabel || CONFIG.SUPPORT_NAME || 'Support';
const label = escapeHtml(fromLabel || CONFIG.SUPPORT_NAME || 'Support');
const safeBody = escapeHtml(messageBody || '').replace(/\n/g, '<br>');
const safeLogoUrl = escapeHtml(CONFIG.LOGO_URL || '');
const safeSignature = escapeHtml(CONFIG.SIGNATURE || '');
const htmlBody = `
<div style="font-family: sans-serif; font-size: 14px; color: #333;">
<p><strong>From:</strong> ${label} on Discord</p>
<p>${(messageBody || '').replace(/\n/g, '<br>')}</p>
<p>${safeBody}</p>
<hr style="border:none; border-top:1px solid #ddd; margin:20px 0;">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td style="padding-right: 12px;">
<img src="${CONFIG.LOGO_URL}" width="65">
${safeLogoUrl ? `<img src="${safeLogoUrl}" width="65">` : ''}
</td>
<td style="border-left: 1px solid #ddd; padding-left: 12px;">
<p style="margin: 0; font-weight: bold;">${label}</p>
<div style="color: #666; font-size: 12px;">${CONFIG.SIGNATURE}</div>
<div style="color: #666; font-size: 12px;">${safeSignature}</div>
</td>
</tr>
</table>

17
services/tickets.js
View File

@@ -22,13 +22,6 @@ async function getNextTicketNumber(senderEmail) {
return { local: senderLocal, number: counter.counter };
}
async function saveZammadId(gmailThreadId, zammadId) {
await Ticket.updateOne(
{ gmailThreadId },
{ $set: { zammadTicketId: zammadId } }
);
}
// --- RENAME + NAMING ---
// Discord rate limit: 2 channel renames per 10 minutes per channel (see https://discord.com/developers/docs/topics/rate-limits).
// When limit is reached we skip the rename and post: "Channel renamed too quickly. Try again <t:unlock:R>."
@@ -322,7 +315,7 @@ async function checkAutoClose(client, sendTicketClosedEmail) {
const channel = await guild.channels.fetch(ticket.discordThreadId).catch(() => null);
if (channel) {
await channel.send(CONFIG.AUTO_CLOSE_MESSAGE);
await channel.send(CONFIG.DISCORD_AUTO_CLOSE_MESSAGE);
await Ticket.updateOne(
{ gmailThreadId: ticket.gmailThreadId },
@@ -356,7 +349,12 @@ async function checkReminders(client) {
const channel = await guild.channels.fetch(ticket.discordThreadId).catch(() => null);
if (channel) {
const message = CONFIG.REMINDER_MESSAGE.replace('{hours}', CONFIG.REMINDER_AFTER_HOURS);
const ping = ticket.claimedBy
? `<@${ticket.claimedBy}>`
: (CONFIG.ROLE_ID_TO_PING ? `<@&${CONFIG.ROLE_ID_TO_PING}>` : 'everyone');
const message = CONFIG.REMINDER_MESSAGE
.replace(/\{hours\}/g, String(CONFIG.REMINDER_AFTER_HOURS))
.replace(/\{ping\}/g, ping);
await channel.send(message);
await Ticket.updateOne(
@@ -406,7 +404,6 @@ async function checkAutoUnclaim(client) {
module.exports = {
getNextTicketNumber,
saveZammadId,
pickTicketCategoryId,
createDiscordTicketAsThread,
createEmailTicketAsThread,

99
services/zammad-sync.js
View File

@@ -1,99 +0,0 @@
/**
* Syncs Zammad agent replies to Discord (for Discord tickets) and Gmail (for email tickets).
* Polls Zammad ticket articles and pushes new customer-visible Agent replies to the right channel.
*/
const { mongoose } = require('../db-connection');
const { getZammadTicketArticles } = require('./zammad');
const { sendGmailReply } = require('./gmail');
const { htmlToTextWithBlocks } = require('../utils');
const Ticket = mongoose.model('Ticket');
function bodyToText(body, contentType) {
if (!body) return '';
const isHtml = (contentType || '').toLowerCase().includes('html');
return isHtml ? htmlToTextWithBlocks(body).trim() : String(body).trim();
}
/**
* Run once: find open tickets with Zammad ID, fetch new agent (customer-visible) articles,
* post to Discord or send via Gmail, then update lastSyncedZammadArticleId.
* @param {import('discord.js').Client} client - Discord client (for posting to ticket channels)
*/
async function syncZammadReplies(client) {
if (!client?.channels) return;
const tickets = await Ticket.find({
zammadTicketId: { $exists: true, $ne: null },
status: 'open'
})
.select('gmailThreadId discordThreadId zammadTicketId lastSyncedZammadArticleId senderEmail subject')
.lean();
for (const ticket of tickets) {
try {
const articles = await getZammadTicketArticles(ticket.zammadTicketId);
// Only agent replies that are customer-visible (not internal notes)
const agentReplies = articles.filter(
(a) => a.sender === 'Agent' && a.internal === false && a.body
);
if (agentReplies.length === 0) continue;
const lastSynced = ticket.lastSyncedZammadArticleId || 0;
const newReplies = agentReplies.filter((a) => a.id > lastSynced);
const maxId = Math.max(lastSynced, ...agentReplies.map((a) => a.id));
// First run: just advance cursor so we don't resend existing articles
if (newReplies.length === 0) {
if (maxId > lastSynced) {
await Ticket.updateOne(
{ gmailThreadId: ticket.gmailThreadId },
{ $set: { lastSyncedZammadArticleId: maxId } }
);
}
continue;
}
const isDiscordTicket = ticket.gmailThreadId.startsWith('discord-');
for (const article of newReplies) {
const text = bodyToText(article.body, article.content_type);
if (!text) continue;
const fromLabel = article.created_by || 'Support';
if (isDiscordTicket && ticket.discordThreadId) {
const channel = await client.channels.fetch(ticket.discordThreadId).catch(() => null);
if (channel) {
await channel.send(`**${fromLabel}** (via Zammad):\n${text}`).catch((err) => {
console.error('Zammad sync: Discord send failed:', err.message);
});
}
} else {
// Email ticket: send reply via Gmail
try {
await sendGmailReply(
ticket.gmailThreadId,
text,
ticket.senderEmail,
ticket.subject || 'Support',
fromLabel,
null
);
} catch (err) {
console.error('Zammad sync: Gmail send failed:', err.message);
}
}
}
await Ticket.updateOne(
{ gmailThreadId: ticket.gmailThreadId },
{ $set: { lastSyncedZammadArticleId: maxId } }
);
} catch (err) {
console.error('Zammad sync error for ticket', ticket.gmailThreadId, err.message);
}
}
}
module.exports = { syncZammadReplies };

213
services/zammad.js
View File

@@ -1,213 +0,0 @@
/**
* Zammad API service – create/close tickets, manage users, post articles.
*/
const axios = require('axios');
const { ZAMMAD } = require('../config');
const zammadHeaders = () =>
ZAMMAD.URL && ZAMMAD.TOKEN
? { Authorization: `Token token=${ZAMMAD.TOKEN}`, 'Content-Type': 'application/json' }
: null;
function baseUrl() {
return ZAMMAD.URL ? ZAMMAD.URL.replace(/\/+$/, '') : '';
}
async function createZammadTicket({ subject, body, email, name, gameName, gameKey, group, discordUsername }) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN) {
console.warn('Zammad not configured; skipping ticket create.');
return null;
}
const url = `${baseUrl()}/api/v1/tickets`;
const isDiscordTicket = Boolean(discordUsername);
const firstname = isDiscordTicket ? '' : (name || 'Email Customer').split(' ')[0];
const lastname = isDiscordTicket ? '' : (name || 'Email Customer').split(' ').slice(1).join(' ') || 'Customer';
const payload = {
title: subject || 'Support',
group,
customer: {
email,
firstname: firstname || '–',
lastname: lastname || '–',
role_ids: [3]
},
state: 'new',
priority: '2 normal',
article: {
subject: subject || 'Support',
body: `Email: ${email}\nGame: ${gameName}\n\nMessage:\n${body}`,
type: 'note',
internal: false,
sender: 'Customer',
from: isDiscordTicket ? `${discordUsername} <${email}>` : `${name} <${email}>`
}
};
if (gameKey) payload.gameid = gameKey;
if (discordUsername) payload.discordusername = String(discordUsername).slice(0, 120);
const res = await axios.post(url, payload, {
headers: {
Authorization: `Token token=${ZAMMAD.TOKEN}`,
'Content-Type': 'application/json'
}
});
return res.data;
}
async function closeZammadTicket(zammadTicketId) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !zammadTicketId) return;
const url = `${baseUrl()}/api/v1/tickets/${zammadTicketId}`;
await axios.patch(url, { state: 'closed' }, {
headers: {
Authorization: `Token token=${ZAMMAD.TOKEN}`,
'Content-Type': 'application/json'
}
});
}
async function updateZammadUserDiscordId(zammadUserId, discordId) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !zammadUserId || !discordId) return;
const url = `${baseUrl()}/api/v1/users/${zammadUserId}`;
await axios.patch(url, { discord_id: String(discordId) }, {
headers: {
Authorization: `Token token=${ZAMMAD.TOKEN}`,
'Content-Type': 'application/json'
}
});
}
async function updateZammadUser(zammadUserId, attrs) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !zammadUserId || !attrs || Object.keys(attrs).length === 0) return;
const url = `${baseUrl()}/api/v1/users/${zammadUserId}`;
const body = {};
if (attrs.discord_id != null) body.discord_id = String(attrs.discord_id);
if (attrs.discord_username != null) body.discord_username = String(attrs.discord_username).slice(0, 120);
if (Object.keys(body).length === 0) return;
await axios.patch(url, body, {
headers: {
Authorization: `Token token=${ZAMMAD.TOKEN}`,
'Content-Type': 'application/json'
}
});
}
async function searchZammadUsers(query) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !query) return [];
try {
const { data } = await axios.get(`${baseUrl()}/api/v1/users/search`, {
params: { query: String(query).trim() },
headers: zammadHeaders()
});
return Array.isArray(data) ? data : data?.users || [];
} catch (e) {
if (e.response?.status === 404) return [];
throw e;
}
}
async function createZammadUser({ email, firstname, lastname, login, discordId, discordUsername }) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !email) return null;
const isDiscord = Boolean(discordUsername);
const payload = {
login: login || email,
email: email.trim(),
firstname: (firstname || '').trim() || (isDiscord ? '–' : 'Customer'),
lastname: (lastname || '').trim() || (isDiscord ? '–' : 'User'),
role_ids: [3]
};
if (discordId) payload.discord_id = String(discordId);
if (discordUsername) payload.discord_username = String(discordUsername).slice(0, 120);
const { data } = await axios.post(`${baseUrl()}/api/v1/users`, payload, { headers: zammadHeaders() });
return data;
}
async function ensureZammadUserForDiscordUser(websiteUser, opts = {}) {
if (!websiteUser?.email || !ZAMMAD.URL || !ZAMMAD.TOKEN) return null;
const email = String(websiteUser.email).trim().toLowerCase();
const discordId = websiteUser.discordID ? String(websiteUser.discordID) : null;
const discordUsername = opts.discordUsername ? String(opts.discordUsername).slice(0, 120) : null;
const firstname = (websiteUser.firstname || '').trim();
const lastname = (websiteUser.lastname || '').trim();
let zammadUser = null;
try {
const list = await searchZammadUsers(email);
zammadUser = list.find((u) => (u.email || '').toLowerCase() === email) || null;
} catch (e) {
console.error('Zammad user search failed:', e.response?.data || e.message);
return null;
}
if (!zammadUser) {
try {
zammadUser = await createZammadUser({
email,
firstname: firstname || (discordUsername ? '–' : 'Customer'),
lastname: lastname || (discordUsername ? '–' : 'User'),
login: email,
discordId,
discordUsername
});
} catch (e) {
console.error('Zammad user create failed:', e.response?.data || e.message);
return null;
}
}
if (zammadUser?.id && (discordId || discordUsername)) {
try {
await updateZammadUser(zammadUser.id, {
...(discordId && { discord_id: discordId }),
...(discordUsername && { discord_username: discordUsername })
});
} catch (_) {
/* custom attributes may not exist in Zammad */
}
}
return zammadUser?.id ?? null;
}
async function getZammadTicketArticles(zammadTicketId) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !zammadTicketId) return [];
const url = `${baseUrl()}/api/v1/ticket_articles/by_ticket/${zammadTicketId}`;
const res = await axios.get(url, {
headers: { Authorization: `Token token=${ZAMMAD.TOKEN}` }
});
return Array.isArray(res.data) ? res.data : [];
}
async function addZammadArticle(zammadTicketId, body, { from: fromDisplay } = {}) {
if (!ZAMMAD.URL || !ZAMMAD.TOKEN || !zammadTicketId) return;
const url = `${baseUrl()}/api/v1/ticket_articles`;
const payload = {
ticket_id: zammadTicketId,
body: body || '',
content_type: 'text/plain',
type: 'note',
internal: false,
sender: 'Agent'
};
if (fromDisplay) {
payload.subject = `Discord reply from ${fromDisplay}`;
}
await axios.post(url, payload, {
headers: {
Authorization: `Token token=${ZAMMAD.TOKEN}`,
'Content-Type': 'application/json'
}
});
}
module.exports = {
createZammadTicket,
closeZammadTicket,
updateZammadUserDiscordId,
updateZammadUser,
searchZammadUsers,
createZammadUser,
ensureZammadUserForDiscordUser,
getZammadTicketArticles,
addZammadArticle,
zammadHeaders
};