From 86381b775c55faa8067b58f41d875a9deb2887cd Mon Sep 17 00:00:00 2001 From: johnnyq Date: Sun, 18 Oct 2026 11:53:51 -0400 Subject: [PATCH] Canned responses stage 1: Admin > Canned Responses on the standard list showing what each says, the ticket categories it is offered on, how often it has gone into a reply and when it last did, searched, filtered by where it is offered (a category or every ticket), sorted by name, use or last use, paged, with Active and Archived tabs; a response can be offered on several ticket categories or on every ticket (migration 3.2.2 moves canned_response_category_id into canned_response_categories, one whose category had been deleted staying on every ticket, and adds canned_response_uses); one shared add and edit window with the placeholders under the editor to click in where the cursor is; Copy, Archive and Restore alongside Delete; [Contact], [First Name], [Client], [Ticket], [Subject], [Ticket Link], [Asset], [Site], [Project], [Agent] (the agent replying), [Date], [Month], [Quarter] and [Year] filled in from the ticket as a response goes into a reply after the client access check, anything else in brackets left for the agent to fill in; the picker lists the ticket's own category first then every ticket's, and each reply records which responses went into it; Admin > Categories counts the canned responses on a ticket category, links to them and moves them on merge through link-table support in categoryKinds(); new functions/canned_response.php and js/canned_response_form.js; changelog updated --- CHANGELOG.md | 18 +- admin/canned_responses.php | 225 +++++++++++------- admin/database_updates/3.2.2.php | 40 ++++ .../canned_response/canned_response_add.php | 36 +-- .../canned_response/canned_response_edit.php | 57 ++--- .../canned_response/canned_response_form.php | 56 +++++ admin/post/canned_response.php | 84 ++++--- agent/ajax.php | 35 +-- agent/post/ticket.php | 3 + agent/ticket.php | 48 ++-- api/v1/categories/categories_model.php | 2 +- db.sql | 41 +++- functions.php | 1 + functions/canned_response.php | 215 +++++++++++++++++ functions/categories.php | 31 ++- js/canned_response_form.js | 20 ++ 16 files changed, 678 insertions(+), 234 deletions(-) create mode 100644 admin/database_updates/3.2.2.php create mode 100644 admin/modals/canned_response/canned_response_form.php create mode 100644 functions/canned_response.php create mode 100644 js/canned_response_form.js diff --git a/CHANGELOG.md b/CHANGELOG.md index a6e247bad..110daf4ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,9 +6,9 @@ This file documents all notable changes made to ITFlow. ### Upgrading to 26.11 -Update from Maintenance > Update — Queue Update hands the job to cron, which updates the files and applies this release's database changes (2.7.9 to 3.2.1) in the same pass. Nothing else is required. +Update from Maintenance > Update — Queue Update hands the job to cron, which updates the files and applies this release's database changes (2.7.9 to 3.2.2) in the same pass. Nothing else is required. -This is a big release, with forty-two database steps in one go, so take a backup before you update. +This is a big release, with forty-three database steps in one go, so take a backup before you update. The update also clears out data that deletes in older versions left behind, all of it pointing at something that no longer exists: @@ -45,6 +45,8 @@ What the API makes from now on - tickets, replies, clients and the rest - is sta Ticket templates keep their subject, details and tasks, and set nothing else on a ticket until you give them a category, priority, agent, due time or tags. Words in square brackets already in a template, like [Employee Name], are asked for as plain, optional text when a ticket is raised from it, until you set them up on the template's page (see New Features, Ticket templates). Tickets raised before the update don't know which template they came from, so a template's use is counted from the update on. The starter ticket templates you added from Maintenance > Starter Content stay as they are; Update on that page brings them up to the new versions, which ask what they need and come with request forms. +Canned responses keep their names, what they say and their ticket category. One whose category had been deleted is offered on every ticket, as it already was. How often each is used is counted from the update. + If you are coming from 26.08 or earlier, the database update still has to be run from the command line one time, exactly as described under Upgrading to 26.09 below. ### Breaking Changes and Notes @@ -503,6 +505,12 @@ If you are coming from 26.08 or earlier, the database update still has to be run - The MSP starter templates in Starter Content are rebuilt on all of this: each asks what it needs (New Hire Onboarding asks the start date, job title, manager, whose access to copy and whether they need a computer or a phone extension), is set up with its category, priority, tags and due time, adds the tasks for the answers given, and the ones clients raise come with a request form - Onboard a new employee, Someone is leaving, Ask for a new computer and Report a suspicious email. Two new ones, Software Request and Access Change Request, have request forms too. An install that added the starter templates before can bring them up to date with Update - their tickets, agent and request form switch stay. - A ticket keeps which template it came from, and its history says so. Admin > Ticket Templates shows what each sets up, its tasks and their time, how many tickets it has raised and when it was last used, and the recurring tickets and project templates that raise it - searched, sorted by name, tasks, use or last use from the column headings, a page at a time, with Active and Archived tabs. A template's page shows the ticket it starts with its placeholders marked, its tasks (added with their time, dragged into order) and its latest tickets, and New ticket from it opens New Ticket with it filled in. - Templates can be copied, archived - not offered for new tickets, while the recurring tickets and project templates that use them keep them - restored and deleted. +- **Canned responses** + - Admin > Canned Responses lists what each says, the ticket categories it is offered on, how often it has gone into a reply and when it last did - searched, filtered by where it is offered, sorted by name, use or last use, a page at a time, with Active and Archived tabs. + - A response can be offered on several ticket categories, or on every ticket. + - [Contact], [First Name], [Client], [Ticket], [Subject], [Ticket Link], [Asset], [Site], [Project], [Agent], [Date], [Month], [Quarter] and [Year] are filled in from the ticket as a response goes into a reply. [Agent] is you, the agent replying, and [Ticket Link] is a link to the ticket, as its emails have. The response window lists them under the editor to click in where the cursor is. Anything else in square brackets - [Date of visit] - stays as it is, for you to fill in before sending. + - Responses can be copied, archived - no longer offered on tickets - restored and deleted. + - Admin > Categories counts the canned responses offered on each ticket category, linked to the list of them, and merging categories moves them over. - **Assets** - The asset list has: - type icons, colored status pills and OS icons @@ -1455,6 +1463,12 @@ If you are coming from 26.08 or earlier, the database update still has to be run - Database 3.2.1: request forms. `ticket_templates` gains `ticket_template_portal`, `ticket_template_portal_title`, `ticket_template_portal_description`, `ticket_template_portal_icon` (one of `TICKET_TEMPLATE_PORTAL_ICONS`), `ticket_template_portal_who` (`everyone` or `managers`) and `ticket_template_portal_all_clients`; new `ticket_template_portal_clients` (cascading with the template and the client). `fill_in_client`, `ticket_fill_in_client` and `recurring_ticket_fill_in_client` say whether the client is asked a fill-in and sees its answer (default yes). - Request forms: `ticketTemplatePortalForms($client_id, $manager)` and `ticketTemplatePortalForm()` (what a contact may use - `$manager` is `portalSeesAllTickets()`), `ticketTemplatePortalTitle()`, `ticketTemplatePortalIcon()`, `ticketTemplateMentionsAsset()`, `ticketTemplatePortalAnswers()` (the client's answers checked, the agents' left blank), `ticketTemplatePortalRaise()` and `ticketTemplatePortalRequests($ids)`; `ticketTemplatePortalClientIds()` and `ticketTemplateSetPortalClients()`. `ticketTemplateFields()` and `ticketTemplateSave()` take the portal fields, and `ticketTemplateFinish()` takes the history line. `client/ticket_add.php` takes `?form=` (`problem` for the usual form) and posts `add_ticket_from_form` to `client/post.php`; its What happens next is `client/includes/ticket_next_steps.php`. `[Agent]` is no longer filled in with a client's name for a ticket raised in the portal with no agent - only an agent who raised it counts. - `inc_ticket_template_select.php` draws a `[data-fill-ins-box]` under the picker (`$ticket_template_fill_in_values` starts it with answers) and the options carry `data-template-fill-ins`; `ticket_tasks_modal.js` draws the fields, hides and disables the task rows for other answers, and binds its document listeners once (a window flag). `js/app.js` opens the tab of a required field left empty on a hidden tab (a capturing `invalid` listener). +- Canned responses: + - Database 3.2.2: `canned_response_categories` (`canned_response_id`, `category_id`) takes over from `canned_responses.canned_response_category_id`, which is dropped - a response with none is offered on every ticket. `canned_response_uses` (`canned_response_use_canned_response_id`, `canned_response_use_user_id`, `canned_response_use_ticket_id`, `canned_response_use_created_at`) keeps each time one goes into a reply. + - New `functions/canned_response.php`: `CANNED_RESPONSE_PLACEHOLDERS`, `cannedResponseRow()`, `cannedResponseCategoryIds()`, `cannedResponseCategoriesFor($ids)`, `cannedResponseFields($post, &$error)` (`name`, `body`, `category_ids`), `cannedResponseSave($id, $fields)`, `cannedResponseSetCategories()`, `cannedResponseCopy()`, `cannedResponsePreview()`, `cannedResponsesForTicket($category_id)` (`category` and `general`), `cannedResponseValues($ticket_id, $agent_name)`, `cannedResponseFill($html, $ticket_id, $agent_name)` (purified, then filled through `ticketPlaceholderFill()`) and `cannedResponseRecordUses($ids, $ticket_id, $user_id)`. + - Admin: `admin/canned_responses.php` takes `q`, `category` (an id, or `every`), `sort` - `canned_response_name`, `use_count` or `last_used` - `order`, `page` and `show=archived`. `admin/modals/canned_response/canned_response_form.php` is shared by `canned_response_add.php` (`category`) and `canned_response_edit.php` (`id`), with `js/canned_response_form.js`. `admin/post/canned_response.php`: `add_canned_response` and `edit_canned_response` (`canned_response_id`, `name`, `body`, `category_ids[]`), GET `copy_canned_response`, `archive_canned_response`, `restore_canned_response` and `delete_canned_response`. Audit entries are Canned Response Create, Edit, Archive, Restore and Delete. + - `agent/ajax.php?get_canned_response` takes `ticket_id` and answers the body filled in for that ticket, after the client access check. The picker adds `canned_response_ids[]` to the reply form, and `add_ticket_reply` records them when there is a reply. + - Categories: a use in `categoryKinds()` can be a link table - `link` (`owner`, `records`, `join`). `categoryUsage()` joins it, `categoryMoveRecords()` adds the new category and takes the old ones off, and the API's `used_by` counts them under `records` (still `canned_responses`). - Empty states: every list page sets `$empty_state` before including `includes/filter_footer.php`, and `includes/inc_empty_state.php` draws it with `emptyStateHtml()` (`functions/format.php`) when the list has nothing - `thing`, `icon`, `title`, `text`, `actions` (`label`, `modal` or `href`, `size`, `icon`; the first is the main one), `archived`, `view`, `filtered`, `views`, `match_title`, `match_text` and `clear_url`. `emptyStateFiltered($views)` reads the GET string for a search or filter, leaving out paging, sorting, `client_id`, `archived` and the page's views, and `emptyStateClearUrl($views)` is the page without them. `emptyStatePill($pills, $key, $default, $good)` builds a pill's own state from the page's pill array (`label`, `icon`, `title`, `alarm`), with a tick for `alarm` pills and the keys in `$good`. Files, notifications and racks call `emptyStateHtml()` in their own layout; files and notifications set `$empty_state_skip`. A page that sets nothing still gets one, worded from `$page_title`. The pages' own empty blocks (`.itflow-asset-empty` under a list) are gone. CSS: `.itflow-empty-state` with `-icon` (a grey round tile), `-title`, `-text` and `-actions`. - Removed unused helpers and files: - `credentialLink()`, `projectLink()`, `linkCounts()`, `assetContactAvatar()`, `clientOverviewPersonInitials()`, and `getMonthlyTax()` and `getQuarterlyTax()`, which looked a tax up by name diff --git a/admin/canned_responses.php b/admin/canned_responses.php index 9a76e38bc..7810849f8 100644 --- a/admin/canned_responses.php +++ b/admin/canned_responses.php @@ -1,128 +1,187 @@ Canned Responses - replies an agent puts into a ticket in one go, + * from the picker above the reply box. Each is offered on tickets in the + * ticket categories it is set to, or on every ticket, and its placeholders + * are filled in from the ticket as it goes in. Each row shows what it says, + * where it is offered, and how often it has gone into a reply. A response + * can be changed, copied as the start of another, archived - not offered on + * tickets - or deleted. The work is in functions/canned_response.php; the + * handlers are admin/post/canned_response.php. + */ + // Default Column Sortby Filter $sort = "canned_response_name"; $order = "ASC"; require_once "includes/inc_all_admin.php"; -/* - * A canned response either belongs to one ticket category or, with category id 0, offers - * itself on every ticket. The LEFT JOIN is what puts the category name on the row; a - * response whose category was deleted since falls back to the general case below. - */ -$sql = mysqli_query( - $mysqli, - "SELECT SQL_CALC_FOUND_ROWS canned_response_id, canned_response_name, canned_response_body, - canned_response_category_id, category_name - FROM canned_responses - LEFT JOIN categories ON canned_response_category_id = category_id AND category_type = 'Ticket' - WHERE (canned_response_name LIKE '%$q%' OR canned_response_body LIKE '%$q%') - AND canned_response_archived_at IS NULL - ORDER BY $sort $order - LIMIT $record_from, $record_to" -); +$show_archived = ($_GET['show'] ?? '') === 'archived'; + +// Where it is offered: any, every ticket (no category), or one ticket category +$category_filter = (string) ($_GET['category'] ?? ''); +$category_filter = $category_filter === 'every' || intval($category_filter) > 0 ? ($category_filter === 'every' ? 'every' : (string) intval($category_filter)) : ''; + +// Only these sort - an unknown column would take the page down +$sortable_columns = [ + 'canned_response_name' => "canned_response_name $order", + 'use_count' => "use_count $order, canned_response_name ASC", + 'last_used' => "last_used IS NULL, last_used $order, canned_response_name ASC", +]; +if (!isset($sortable_columns[$sort])) { + $sort = 'canned_response_name'; +} + +$filters = "(canned_response_name LIKE '%$q%' OR canned_response_body LIKE '%$q%')"; +if ($category_filter === 'every') { + $filters .= " AND NOT EXISTS (SELECT 1 FROM canned_response_categories c WHERE c.canned_response_id = canned_responses.canned_response_id)"; +} elseif ($category_filter !== '') { + $filters .= " AND EXISTS (SELECT 1 FROM canned_response_categories c WHERE c.canned_response_id = canned_responses.canned_response_id AND c.category_id = " . intval($category_filter) . ")"; +} + +$sql = mysqli_query($mysqli, "SELECT SQL_CALC_FOUND_ROWS canned_responses.canned_response_id, canned_response_name, canned_response_body, canned_response_created_at, canned_response_updated_at, canned_response_archived_at, + COALESCE(used.use_count, 0) AS use_count, used.last_used + FROM canned_responses + LEFT JOIN ( + SELECT canned_response_use_canned_response_id AS used_id, COUNT(*) AS use_count, MAX(canned_response_use_created_at) AS last_used + FROM canned_response_uses GROUP BY canned_response_use_canned_response_id + ) used ON used.used_id = canned_responses.canned_response_id + WHERE $filters AND canned_response_archived_at IS " . ($show_archived ? 'NOT NULL' : 'NULL') . " + ORDER BY {$sortable_columns[$sort]}, canned_responses.canned_response_id ASC + LIMIT $record_from, $record_to"); $num_rows = mysqli_fetch_row(mysqli_query($mysqli, "SELECT FOUND_ROWS()")); +$responses = []; +while ($row = mysqli_fetch_assoc($sql)) { + $responses[intval($row['canned_response_id'])] = $row; +} +$response_categories = cannedResponseCategoriesFor(array_keys($responses)); + +$counts = mysqli_fetch_row(mysqli_query($mysqli, "SELECT COALESCE(SUM(canned_response_archived_at IS NULL), 0), COALESCE(SUM(canned_response_archived_at IS NOT NULL), 0) FROM canned_responses WHERE $filters")); + +$sort_link = function ($column, $label) use ($url_query_strings_sort, $sort, $disp, $order_icon) { + return '' + . $label . ($sort === $column ? " $order_icon" : '') . ''; +}; +$pill_url = function ($archived) use ($category_filter) { + return '?' . http_build_query(array_filter(['q' => $_GET['q'] ?? '', 'category' => $category_filter, 'show' => $archived ? 'archived' : ''])); +}; + +$add_url = 'modals/canned_response/canned_response_add.php' . (intval($category_filter) > 0 ? '?category=' . intval($category_filter) : ''); +$csrf = $_SESSION['csrf_token']; + ?>

Canned Responses

- +
+
- -
+
- - + +
- -
+
+
-
+
-
- - "> +
+
+ "> - - - + + + + + - $row) { + $name = escapeHtml($row['canned_response_name']); + $edit_url = "modals/canned_response/canned_response_edit.php?id=$canned_response_id"; + $use_count = intval($row['use_count']); + $used_text = $use_count ? $use_count . ' time' . ($use_count === 1 ? '' : 's') : ''; + $categories = $response_categories[$canned_response_id] ?? []; + $offered_html = $categories + ? '' . implode('', array_map(function ($category) { + return '' . categoryChip($category) . ''; + }, $categories)) . '' + : 'Every ticket'; + $preview = cannedResponsePreview($row['canned_response_body']); ?> - + - - + + + - -
- - Response - - - - Ticket Category - - ActionOffered on
-
- -
-
- - - -
-
+
+ +
+ + +
+ + +
Archived
+ + +
+
- - - - All ticket categories - - -
- +
Not yet' ?>> +
+
- - Edit + + Edit - + + Copy + +
+ + + Restore + + + + Archive + + + Delete
@@ -130,12 +189,14 @@ $num_rows = mysqli_fetch_row(mysqli_query($mysqli, "SELECT FOUND_ROWS()")); $empty_state = [ 'thing' => 'canned responses', 'icon' => 'fa-comment-dots', - 'text' => 'Replies agents drop into a ticket in one click.', - 'actions' => [['label' => 'New Canned Response', 'modal' => 'modals/canned_response/canned_response_add.php', 'size' => 'lg']], + 'filtered' => $q !== '' || $category_filter !== '', + 'archived' => $show_archived, + 'views' => ['show'], + 'text' => 'Replies agents put into a ticket in one go - "Password reset done", "Waiting on you". [Contact], [Ticket], [Agent] and the like are filled in from the ticket.', + 'actions' => [['label' => 'New Canned Response', 'modal' => $add_url, 'size' => 'lg']], ]; + require_once "../includes/filter_footer.php"; ?> -
0"); + + mysqli_query($mysqli, "ALTER TABLE `canned_responses` DROP KEY `canned_response_category_id`, DROP `canned_response_category_id`"); + + // Each time one goes into a reply - who, on which ticket and when + mysqli_query($mysqli, "CREATE TABLE `canned_response_uses` ( + `canned_response_use_id` int(11) NOT NULL AUTO_INCREMENT, + `canned_response_use_canned_response_id` int(11) NOT NULL, + `canned_response_use_user_id` int(11) NOT NULL DEFAULT 0, + `canned_response_use_ticket_id` int(11) NOT NULL DEFAULT 0, + `canned_response_use_created_at` datetime NOT NULL DEFAULT current_timestamp(), + PRIMARY KEY (`canned_response_use_id`), + KEY `canned_response_use_canned_response_id` (`canned_response_use_canned_response_id`,`canned_response_use_created_at`), + KEY `canned_response_use_user_id` (`canned_response_use_user_id`), + CONSTRAINT `canned_response_uses_ibfk_1` FOREIGN KEY (`canned_response_use_canned_response_id`) REFERENCES `canned_responses` (`canned_response_id`) ON DELETE CASCADE + ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci"); diff --git a/admin/modals/canned_response/canned_response_add.php b/admin/modals/canned_response/canned_response_add.php index a5d9b1d9e..739b25171 100644 --- a/admin/modals/canned_response/canned_response_add.php +++ b/admin/modals/canned_response/canned_response_add.php @@ -1,7 +1,15 @@ @@ -13,33 +21,7 @@ ob_start();
- -
- -
- - -
-
- -
- -
- - - -
- Leave this on all categories for a response that should be offered on every ticket. -
- -
- - -
- +
diff --git a/admin/modals/canned_response/canned_response_edit.php b/admin/modals/canned_response/canned_response_edit.php index bf7740899..8f143eb3e 100644 --- a/admin/modals/canned_response/canned_response_edit.php +++ b/admin/modals/canned_response/canned_response_edit.php @@ -1,25 +1,23 @@ + +if (!$response) { ?> +
That canned response is gone - it may have been deleted.
+
-
Editing Canned Response:
+
Canned response:
@@ -27,33 +25,7 @@ ob_start();
- -
- -
- - -
-
- -
- -
- - - -
- Leave this on all categories for a response that should be offered on every ticket. -
- -
- - -
- +
@@ -61,5 +33,6 @@ ob_start();
- + +
+ +
+ + +
+
+ +
+ +
+ + + +
+ Tickets in these categories. Leave it empty to offer it on every ticket. +
+ +
+ + +
+ +
Filled in from the ticket as it goes in - click one to put it where the cursor is:
+
+ $means) { ?> + + +
+
Anything else in square brackets - [Date of visit] - stays as it is, for whoever replies to fill in.
+ + diff --git a/admin/post/canned_response.php b/admin/post/canned_response.php index 72c17a813..02085d0a8 100644 --- a/admin/post/canned_response.php +++ b/admin/post/canned_response.php @@ -1,48 +1,76 @@ Canned Responses) - making, changing, copying, + * archiving and deleting them. The work is in functions/canned_response.php. + */ defined('FROM_POST_HANDLER') || die("Direct file access is not allowed"); -if (isset($_POST['add_canned_response'])) { +/* The response a request is for - or back to the list, saying it is gone. */ +function cannedResponseForRequest($canned_response_id) { + $row = cannedResponseRow($canned_response_id); + if (!$row) { + flashAlert('That canned response no longer exists.', 'error'); + redirect('canned_responses.php'); + } + return $row; +} + +if (isset($_POST['add_canned_response']) || isset($_POST['edit_canned_response'])) { validateCSRFToken(); - $name = escapeSql($_POST['name']); + $editing = isset($_POST['edit_canned_response']); + $canned_response_id = $editing ? intval(cannedResponseForRequest($_POST['canned_response_id'] ?? 0)['canned_response_id']) : 0; - // The body is TinyMCE HTML, so it goes in the way ticket replies and ticket template - // details do - escaped for the query only, and purified where it is rendered - $body = mysqli_real_escape_string($mysqli, $_POST['body']); + $fields = cannedResponseFields($_POST, $error); + if (!$fields) { + flashAlert(escapeHtml($error), 'error'); + redirect(); + } + $canned_response_id = cannedResponseSave($canned_response_id, $fields); + $name = escapeSql($fields['name']); - // 0 is the general case: offered on every ticket whatever its category - $category_id = intval($_POST['category']); + logAudit("Canned Response", $editing ? "Edit" : "Create", "$session_name " . ($editing ? 'edited' : 'created') . " canned response $name", 0, $canned_response_id); - mysqli_query($mysqli, "INSERT INTO canned_responses SET canned_response_name = '$name', canned_response_body = '$body', canned_response_category_id = $category_id"); - - $canned_response_id = mysqli_insert_id($mysqli); - - logAudit("Canned Response", "Create", "$session_name created canned response $name", 0, $canned_response_id); - - flashAlert("Canned Response $name created"); + flashAlert("Canned response " . escapeHtml($fields['name']) . " " . ($editing ? 'saved' : 'created')); redirect(); } -if (isset($_POST['edit_canned_response'])) { +if (isset($_GET['copy_canned_response'])) { validateCSRFToken(); - $canned_response_id = intval($_POST['canned_response_id']); - $name = escapeSql($_POST['name']); - $body = mysqli_real_escape_string($mysqli, $_POST['body']); - $category_id = intval($_POST['category']); + $row = cannedResponseForRequest($_GET['copy_canned_response']); + $new_id = cannedResponseCopy($row['canned_response_id']); + $new_name = (string) cannedResponseRow($new_id)['canned_response_name']; - mysqli_query($mysqli, "UPDATE canned_responses SET canned_response_name = '$name', canned_response_body = '$body', canned_response_category_id = $category_id WHERE canned_response_id = $canned_response_id"); + logAudit("Canned Response", "Create", "$session_name copied canned response " . escapeSql($row['canned_response_name']) . " as " . escapeSql($new_name), 0, $new_id); - logAudit("Canned Response", "Edit", "$session_name edited canned response $name", 0, $canned_response_id); + flashAlert("Canned response " . escapeHtml($row['canned_response_name']) . " copied as " . escapeHtml($new_name) . ""); - flashAlert("Canned Response $name edited"); + redirect(); + +} + +if (isset($_GET['archive_canned_response']) || isset($_GET['restore_canned_response'])) { + + validateCSRFToken(); + + $archive = isset($_GET['archive_canned_response']); + $row = cannedResponseForRequest($archive ? $_GET['archive_canned_response'] : $_GET['restore_canned_response']); + $canned_response_id = intval($row['canned_response_id']); + $name = escapeSql($row['canned_response_name']); + + // Archived, it isn't offered on tickets; restoring it is all it takes to offer it again + mysqli_query($mysqli, "UPDATE canned_responses SET canned_response_archived_at = " . ($archive ? 'NOW()' : 'NULL') . " WHERE canned_response_id = $canned_response_id"); + + logAudit("Canned Response", $archive ? "Archive" : "Restore", "$session_name " . ($archive ? 'archived' : 'restored') . " canned response $name", 0, $canned_response_id); + + flashAlert("Canned response " . escapeHtml($row['canned_response_name']) . " " . ($archive ? 'archived' : 'restored'), $archive ? 'error' : 'success'); redirect(); @@ -52,15 +80,15 @@ if (isset($_GET['delete_canned_response'])) { validateCSRFToken(); - $canned_response_id = intval($_GET['delete_canned_response']); - - $name = escapeSql(getFieldById('canned_responses', $canned_response_id, 'canned_response_name')); + $row = cannedResponseForRequest($_GET['delete_canned_response']); + $canned_response_id = intval($row['canned_response_id']); + // Its categories and its record of use go with it, by their foreign keys; replies it went into stay as they are mysqli_query($mysqli, "DELETE FROM canned_responses WHERE canned_response_id = $canned_response_id"); - logAudit("Canned Response", "Delete", "$session_name deleted canned response $name", 0, $canned_response_id); + logAudit("Canned Response", "Delete", "$session_name deleted canned response " . escapeSql($row['canned_response_name'])); - flashAlert("Canned Response $name deleted", 'error'); + flashAlert("Canned response " . escapeHtml($row['canned_response_name']) . " deleted", 'error'); redirect(); diff --git a/agent/ajax.php b/agent/ajax.php index 7c3f132e0..63acac28f 100644 --- a/agent/ajax.php +++ b/agent/ajax.php @@ -1020,31 +1020,34 @@ if (isset($_GET['global_search'])) { } /* - * Returns the body of one canned response, for the picker on the ticket reply form. - * Fetched on demand rather than rendered into every ticket page, because the bodies are - * full HTML replies and an install can have a lot of them. + * Returns the body of one canned response, for the picker on the ticket reply form, + * filled in for the ticket (ticket_id) - cannedResponseFill(). Fetched on demand rather + * than rendered into every ticket page, because the bodies are full HTML replies and an + * install can have a lot of them. */ if (isset($_GET['get_canned_response'])) { enforceUserPermission('module_support'); - $canned_response_id = intval($_GET['get_canned_response']); + $canned_row = cannedResponseRow($_GET['get_canned_response']); + if ($canned_row && $canned_row['canned_response_archived_at']) { + $canned_row = null; + } - $canned_sql = mysqli_query($mysqli, "SELECT canned_response_body FROM canned_responses - WHERE canned_response_id = $canned_response_id AND canned_response_archived_at IS NULL LIMIT 1"); - - $canned_row = mysqli_fetch_assoc($canned_sql); + // The ticket it goes into, if this agent may see it - otherwise nothing is filled in + $canned_ticket_id = 0; + $canned_ticket = ticketRow(intval($_GET['ticket_id'] ?? 0)); + if ($canned_ticket) { + $client_id = intval($canned_ticket['ticket_client_id']); + if ($client_id) { + enforceClientAccess(); + } + $canned_ticket_id = intval($canned_ticket['ticket_id']); + } // Purified here rather than at save time, the same way ticket replies and ticket // template details are - what lands in the editor is what would have been rendered - require_once "../libs/htmlpurifier/HTMLPurifier.standalone.php"; - - $canned_purifier_config = HTMLPurifier_Config::createDefault(); - $canned_purifier_config->set('Cache.DefinitionImpl', null); - $canned_purifier_config->set('URI.AllowedSchemes', ['data' => true, 'src' => true, 'http' => true, 'https' => true]); - $canned_purifier = new HTMLPurifier($canned_purifier_config); - $response = []; - $response['body'] = $canned_row ? $canned_purifier->purify($canned_row['canned_response_body']) : ''; + $response['body'] = $canned_row ? cannedResponseFill($canned_row['canned_response_body'], $canned_ticket_id, stripslashes($session_name)) : ''; echo json_encode($response); diff --git a/agent/post/ticket.php b/agent/post/ticket.php index 8d08939df..d4cd888f3 100644 --- a/agent/post/ticket.php +++ b/agent/post/ticket.php @@ -1099,6 +1099,9 @@ if (isset($_POST['add_ticket_reply'])) { // a public reply can carry them $emailable_attachments = filterEmailableAttachments(saveTicketAttachments($ticket_id, $ticket_reply_id)); + // The canned responses picked into it, for how often each is used + cannedResponseRecordUses((array) ($_POST['canned_response_ids'] ?? []), $ticket_id, $session_user_id); + // Email the client and the watchers if ($send_email) { // The reply as saved - with the signature - read back diff --git a/agent/ticket.php b/agent/ticket.php index 37342b940..02ac984a8 100644 --- a/agent/ticket.php +++ b/agent/ticket.php @@ -750,32 +750,20 @@ if (isset($_GET['ticket_id'])) {
- @@ -785,7 +773,7 @@ if (isset($_GET['ticket_id'])) { - + @@ -1799,8 +1787,9 @@ if (!empty($can_edit_ticket) && !empty($ticket_is_open)) { ?> } // Canned responses - insert at the cursor rather than replacing, so picking one into a - // half-written reply adds to it. The body is fetched on demand; TinyMCE owns the field - // by now, so setting the textarea value directly would do nothing visible. + // half-written reply adds to it. The body is fetched on demand, filled in for this + // ticket; TinyMCE owns the field by now, so setting the textarea value directly would + // do nothing visible. The reply carries which ones went in, for how often each is used. const cannedPicker = document.getElementById('canned_response_picker'); if (cannedPicker) { cannedPicker.addEventListener('change', function () { @@ -1809,9 +1798,18 @@ if (!empty($can_edit_ticket) && !empty($ticket_is_open)) { ?> cannedPicker.disabled = true; - fetch('ajax.php?get_canned_response=' + encodeURIComponent(cannedId)) + fetch('ajax.php?get_canned_response=' + encodeURIComponent(cannedId) + '&ticket_id=' + encodeURIComponent(cannedPicker.dataset.ticketId || '')) .then(response => response.json()) .then(data => { + const form = cannedPicker.closest('form'); + if (form && !form.querySelector('input[name="canned_response_ids[]"][value="' + cannedId + '"]')) { + const used = document.createElement('input'); + used.type = 'hidden'; + used.name = 'canned_response_ids[]'; + used.value = cannedId; + form.appendChild(used); + } + const editor = window.tinymce ? tinymce.get('ticket_reply') : null; if (editor) { diff --git a/api/v1/categories/categories_model.php b/api/v1/categories/categories_model.php index 44e1d185d..8ba18fecb 100644 --- a/api/v1/categories/categories_model.php +++ b/api/v1/categories/categories_model.php @@ -60,7 +60,7 @@ function categoryApiRow(array $row, $usage) { $used_by = []; foreach ($config['uses'] ?? [] as $index => $use) { if (!empty($mine['uses'][$index]['all'])) { - $used_by[$use['table']] = intval($mine['uses'][$index]['all']); + $used_by[$use['records']] = intval($mine['uses'][$index]['all']); } } // {} rather than [] when nothing has it diff --git a/db.sql b/db.sql index 4d535f67e..a57610c51 100644 --- a/db.sql +++ b/db.sql @@ -533,6 +533,43 @@ CREATE TABLE `calendars` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci; /*!40101 SET character_set_client = @saved_cs_client */; +-- +-- Table structure for table `canned_response_categories` +-- + +DROP TABLE IF EXISTS `canned_response_categories`; +/*!40101 SET @saved_cs_client = @@character_set_client */; +/*!40101 SET character_set_client = utf8mb4 */; +CREATE TABLE `canned_response_categories` ( + `canned_response_id` int(11) NOT NULL, + `category_id` int(11) NOT NULL, + PRIMARY KEY (`canned_response_id`,`category_id`), + KEY `category_id` (`category_id`), + CONSTRAINT `canned_response_categories_ibfk_1` FOREIGN KEY (`canned_response_id`) REFERENCES `canned_responses` (`canned_response_id`) ON DELETE CASCADE, + CONSTRAINT `canned_response_categories_ibfk_2` FOREIGN KEY (`category_id`) REFERENCES `categories` (`category_id`) ON DELETE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci; +/*!40101 SET character_set_client = @saved_cs_client */; + +-- +-- Table structure for table `canned_response_uses` +-- + +DROP TABLE IF EXISTS `canned_response_uses`; +/*!40101 SET @saved_cs_client = @@character_set_client */; +/*!40101 SET character_set_client = utf8mb4 */; +CREATE TABLE `canned_response_uses` ( + `canned_response_use_id` int(11) NOT NULL AUTO_INCREMENT, + `canned_response_use_canned_response_id` int(11) NOT NULL, + `canned_response_use_user_id` int(11) NOT NULL DEFAULT 0, + `canned_response_use_ticket_id` int(11) NOT NULL DEFAULT 0, + `canned_response_use_created_at` datetime NOT NULL DEFAULT current_timestamp(), + PRIMARY KEY (`canned_response_use_id`), + KEY `canned_response_use_canned_response_id` (`canned_response_use_canned_response_id`,`canned_response_use_created_at`), + KEY `canned_response_use_user_id` (`canned_response_use_user_id`), + CONSTRAINT `canned_response_uses_ibfk_1` FOREIGN KEY (`canned_response_use_canned_response_id`) REFERENCES `canned_responses` (`canned_response_id`) ON DELETE CASCADE +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci; +/*!40101 SET character_set_client = @saved_cs_client */; + -- -- Table structure for table `canned_responses` -- @@ -544,12 +581,10 @@ CREATE TABLE `canned_responses` ( `canned_response_id` int(11) NOT NULL AUTO_INCREMENT, `canned_response_name` varchar(200) NOT NULL, `canned_response_body` longtext DEFAULT NULL, - `canned_response_category_id` int(11) NOT NULL DEFAULT 0, `canned_response_created_at` datetime NOT NULL DEFAULT current_timestamp(), `canned_response_updated_at` datetime DEFAULT NULL ON UPDATE current_timestamp(), `canned_response_archived_at` datetime DEFAULT NULL, - PRIMARY KEY (`canned_response_id`), - KEY `canned_response_category_id` (`canned_response_category_id`) + PRIMARY KEY (`canned_response_id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci; /*!40101 SET character_set_client = @saved_cs_client */; diff --git a/functions.php b/functions.php index bafd56f3f..9bc0904c4 100644 --- a/functions.php +++ b/functions.php @@ -53,6 +53,7 @@ require_once __DIR__ . '/functions/ticket_fields.php'; require_once __DIR__ . '/functions/ticket.php'; require_once __DIR__ . '/functions/ticket_template.php'; require_once __DIR__ . '/functions/ticket_template_transfer.php'; +require_once __DIR__ . '/functions/canned_response.php'; require_once __DIR__ . '/functions/project.php'; require_once __DIR__ . '/functions/service.php'; require_once __DIR__ . '/functions/client_export.php'; diff --git a/functions/canned_response.php b/functions/canned_response.php new file mode 100644 index 000000000..cc407ab5d --- /dev/null +++ b/functions/canned_response.php @@ -0,0 +1,215 @@ + Canned Responses): replies an agent puts + * into a ticket in one go. Each is offered on tickets in the ticket + * categories it is set to, or on every ticket when it has none. The + * placeholders in it - [Contact], [Ticket], [Agent] and the like - are filled + * in from the ticket as it goes in, and each time one goes into a reply is + * kept, for how often each is used and when it last was. + * + * Shared by admin/canned_responses.php, admin/modals/canned_response/*, + * admin/post/canned_response.php, agent/ticket.php, agent/ajax.php and the + * reply handler (agent/post/ticket.php). + */ + +/** The placeholders filled in from the ticket as a response goes in - what each becomes. */ +const CANNED_RESPONSE_PLACEHOLDERS = [ + 'Contact' => "the contact's name", + 'First Name' => "the contact's first name", + 'Client' => "the client's name", + 'Ticket' => 'its number - TCK-123', + 'Subject' => "the ticket's subject", + 'Ticket Link' => 'a link to the ticket, as its emails have', + 'Asset' => "the asset's name", + 'Site' => "the site's name", + 'Project' => "the project's name", + 'Agent' => 'you - the agent replying', + 'Date' => "today's date", + 'Month' => 'the month - October 2026', + 'Quarter' => 'the quarter - Q4 2026', + 'Year' => 'the year', +]; + +/** One response, archived or not, or null. */ +function cannedResponseRow($canned_response_id) { + global $mysqli; + $canned_response_id = intval($canned_response_id); + if ($canned_response_id <= 0) { + return null; + } + $row = mysqli_fetch_assoc(mysqli_query($mysqli, "SELECT canned_response_id, canned_response_name, canned_response_body, canned_response_created_at, canned_response_updated_at, canned_response_archived_at + FROM canned_responses WHERE canned_response_id = $canned_response_id")); + return $row ?: null; +} + +/** The ticket categories one is offered on - category ids; none for every ticket. */ +function cannedResponseCategoryIds($canned_response_id) { + global $mysqli; + $ids = []; + $sql = mysqli_query($mysqli, "SELECT category_id FROM canned_response_categories WHERE canned_response_id = " . intval($canned_response_id) . " ORDER BY category_id"); + while ($row = mysqli_fetch_row($sql)) { + $ids[] = intval($row[0]); + } + return $ids; +} + +/** The ticket categories of several responses - canned_response_id => [category rows, by name]; one with none isn't in it. */ +function cannedResponseCategoriesFor(array $canned_response_ids) { + global $mysqli; + $ids = array_values(array_filter(array_map('intval', $canned_response_ids))); + $categories = []; + if (!$ids) { + return $categories; + } + $sql = mysqli_query($mysqli, "SELECT canned_response_id, categories.category_id, category_name, category_type, category_color, category_icon, category_archived_at + FROM canned_response_categories JOIN categories ON categories.category_id = canned_response_categories.category_id + WHERE canned_response_id IN (" . implode(',', $ids) . ") ORDER BY category_name"); + while ($row = mysqli_fetch_assoc($sql)) { + $categories[intval($row['canned_response_id'])][] = $row; + } + return $categories; +} + +/* + * The response window's fields, checked - [$fields, $error]. $post: name, + * body (the editor's HTML, kept as written - it is purified where it is + * shown) and category_ids[] (ticket categories; none for every ticket). + */ +function cannedResponseFields(array $post, &$error = '') { + global $mysqli; + $error = ''; + $name = trim(preg_replace('/\s+/u', ' ', strip_tags((string) ($post['name'] ?? '')))); + if ($name === '') { + $error = 'A canned response needs a name'; + return null; + } + if (mb_strlen($name) > 200) { + $error = 'Keep the name to 200 characters'; + return null; + } + // Ticket categories that are there + $category_ids = array_values(array_unique(array_filter(array_map('intval', (array) ($post['category_ids'] ?? []))))); + if ($category_ids) { + $known = []; + $sql = mysqli_query($mysqli, "SELECT category_id FROM categories WHERE category_type = 'Ticket' AND category_id IN (" . implode(',', $category_ids) . ")"); + while ($row = mysqli_fetch_row($sql)) { + $known[] = intval($row[0]); + } + $category_ids = array_values(array_intersect($category_ids, $known)); + } + return ['name' => $name, 'body' => (string) ($post['body'] ?? ''), 'category_ids' => $category_ids]; +} + +/* Save a response's fields (cannedResponseFields()) - a new one with $canned_response_id 0. Its id. */ +function cannedResponseSave($canned_response_id, array $f) { + global $mysqli; + $canned_response_id = intval($canned_response_id); + $set = "canned_response_name = '" . escapeSql($f['name']) . "', canned_response_body = '" . mysqli_real_escape_string($mysqli, $f['body']) . "'"; + if ($canned_response_id) { + mysqli_query($mysqli, "UPDATE canned_responses SET $set WHERE canned_response_id = $canned_response_id"); + } else { + mysqli_query($mysqli, "INSERT INTO canned_responses SET $set"); + $canned_response_id = mysqli_insert_id($mysqli); + } + cannedResponseSetCategories($canned_response_id, $f['category_ids']); + return $canned_response_id; +} + +/* Offer a response on these ticket categories (ids) - none for every ticket. */ +function cannedResponseSetCategories($canned_response_id, array $category_ids) { + global $mysqli; + $canned_response_id = intval($canned_response_id); + mysqli_query($mysqli, "DELETE FROM canned_response_categories WHERE canned_response_id = $canned_response_id"); + foreach (array_unique(array_filter(array_map('intval', $category_ids))) as $category_id) { + mysqli_query($mysqli, "INSERT IGNORE INTO canned_response_categories SET canned_response_id = $canned_response_id, category_id = $category_id"); + } +} + +/* A new response starting from this one - "Copy of", for the same categories. Its id, or 0. */ +function cannedResponseCopy($canned_response_id) { + $row = cannedResponseRow($canned_response_id); + if (!$row) { + return 0; + } + return cannedResponseSave(0, [ + 'name' => mb_substr('Copy of ' . $row['canned_response_name'], 0, 200), + 'body' => (string) $row['canned_response_body'], + 'category_ids' => cannedResponseCategoryIds($row['canned_response_id']), + ]); +} + +/* What a response says, as a line of plain text - for the lists. */ +function cannedResponsePreview($html, $length = 140) { + $text = trim(preg_replace('/\s+/u', ' ', html_entity_decode(strip_tags(str_replace('<', ' <', (string) $html)), ENT_QUOTES, 'UTF-8'))); + return mb_strimwidth($text, 0, $length, '...'); +} + +/* + * The responses offered on a ticket in a category - ['category' => rows for + * its category, 'general' => rows for every ticket], each by name. Current + * ones only; names, not bodies. + */ +function cannedResponsesForTicket($category_id) { + global $mysqli; + $category_id = intval($category_id); + $offered = ['category' => [], 'general' => []]; + $sql = mysqli_query($mysqli, "SELECT canned_response_id, canned_response_name, + EXISTS (SELECT 1 FROM canned_response_categories c WHERE c.canned_response_id = canned_responses.canned_response_id) AS has_categories, + EXISTS (SELECT 1 FROM canned_response_categories c WHERE c.canned_response_id = canned_responses.canned_response_id AND c.category_id = $category_id) AS in_category + FROM canned_responses + WHERE canned_response_archived_at IS NULL + ORDER BY canned_response_name ASC"); + while ($row = mysqli_fetch_assoc($sql)) { + if (intval($row['in_category'])) { + $offered['category'][] = $row; + } elseif (!intval($row['has_categories'])) { + $offered['general'][] = $row; + } + } + return $offered; +} + +/* What the placeholders become on a ticket for $agent_name replying - lowercase name => value, as ticketPlaceholderFill() takes them; [] for no ticket. Raw. */ +function cannedResponseValues($ticket_id, $agent_name) { + global $mysqli; + $values = ticketPlaceholderValues($ticket_id); + if (!$values) { + return []; + } + $row = mysqli_fetch_assoc(mysqli_query($mysqli, "SELECT ticket_subject FROM tickets WHERE ticket_id = " . intval($ticket_id))); + $contact = trim($values['contact']); + $values['first name'] = $contact !== '' ? preg_split('/\s+/u', $contact)[0] : ''; + $values['subject'] = (string) ($row['ticket_subject'] ?? ''); + $values['agent'] = (string) $agent_name; + return $values; +} + +/* + * A response's HTML made safe and filled in for a ticket, as it goes into a + * reply: [Ticket Link] a link to the ticket (ticketEmailUrl()), the rest as + * cannedResponseValues() has them. A placeholder with nothing to put in - + * [Asset] on a ticket with no asset, or one that is no placeholder at all - + * stays as it is, for the agent to fill in. + */ +function cannedResponseFill($html, $ticket_id, $agent_name) { + $html = documentHtmlPurify($html); + $ticket = ticketRow($ticket_id); + if (!$ticket) { + return $html; + } + $url = escapeHtml(ticketEmailUrl($ticket)); + $html = preg_replace('/\[ticket(?: | |\x{00A0})+link\]/iu', '' . $url . '', $html); + return ticketPlaceholderFill($html, cannedResponseValues($ticket['ticket_id'], $agent_name), true); +} + +/* Keep that these responses went into a reply on a ticket - each once, the ones that are there. */ +function cannedResponseRecordUses(array $canned_response_ids, $ticket_id, $user_id) { + global $mysqli; + $ids = array_slice(array_values(array_unique(array_filter(array_map('intval', $canned_response_ids)))), 0, 20); + if (!$ids) { + return; + } + mysqli_query($mysqli, "INSERT INTO canned_response_uses (canned_response_use_canned_response_id, canned_response_use_user_id, canned_response_use_ticket_id) + SELECT canned_response_id, " . intval($user_id) . ", " . intval($ticket_id) . " FROM canned_responses WHERE canned_response_id IN (" . implode(',', $ids) . ")"); +} diff --git a/functions/categories.php b/functions/categories.php index 2c29167f5..bae7b3f08 100644 --- a/functions/categories.php +++ b/functions/categories.php @@ -31,11 +31,16 @@ * uses where records hold it - table, column, one/many (the record, * in a sentence), url (the list showing them, {id} or {name} * filled in; null when there is no such list), archived and - * updated (columns, or null), text (an id held as text) + * updated (columns, or null), text (an id held as text), and for + * records that take several of a kind through a table of their + * own (canned_response_categories), link - that table's column + * for the record (owner), the records' table (records) and the + * join to it (join); records is what the API counts them as */ function categoryKinds() { - $use = function ($table, $column, $one, $many, $url = null, $archived = null, $updated = null, $text = false) { - return ['table' => $table, 'column' => $column, 'one' => $one, 'many' => $many, 'url' => $url, 'archived' => $archived, 'updated' => $updated, 'text' => $text]; + $use = function ($table, $column, $one, $many, $url = null, $archived = null, $updated = null, $text = false, $link = null) { + return ['table' => $table, 'column' => $column, 'one' => $one, 'many' => $many, 'url' => $url, 'archived' => $archived, 'updated' => $updated, 'text' => $text, + 'link' => $link, 'records' => $link['records'] ?? $table, 'join' => $link['join'] ?? '']; }; return [ 'Expense' => [ @@ -74,12 +79,13 @@ function categoryKinds() { ], 'Ticket' => [ 'label' => 'Ticket', 'one' => 'ticket category', 'many' => 'ticket categories', 'icon' => 'fa-life-ring', - 'about' => 'What a ticket is about. Tickets, recurring tickets and canned responses have one, and the ticket reports add up by them.', + 'about' => 'What a ticket is about. Tickets and recurring tickets have one, canned responses are offered by them, and the ticket reports add up by them.', 'by' => 'id', 'ordered' => false, 'max' => 200, 'modules' => ['module_support'], 'uses' => [ $use('tickets', 'ticket_category', 'ticket', 'tickets', '/agent/tickets.php?category={id}&show=all', 'ticket_archived_at', 'ticket_updated_at', true), $use('recurring_tickets', 'recurring_ticket_category', 'recurring ticket', 'recurring tickets', '/agent/recurring_tickets.php?category={id}', null, 'recurring_ticket_updated_at', true), - $use('canned_responses', 'canned_response_category_id', 'canned response', 'canned responses', '/admin/canned_responses.php', 'canned_response_archived_at', 'canned_response_updated_at'), + $use('canned_response_categories', 'category_id', 'canned response', 'canned responses', '/admin/canned_responses.php?category={id}', 'canned_response_archived_at', null, false, + ['owner' => 'canned_response_id', 'records' => 'canned_responses', 'join' => 'JOIN canned_responses USING (canned_response_id)']), ], ], 'network_interface' => [ @@ -277,7 +283,7 @@ function categoryUsage($kind) { $usage = []; foreach ($config['uses'] as $index => $use) { $archived = $use['archived'] ? "SUM({$use['archived']} IS NOT NULL)" : '0'; - $sql = mysqli_query($mysqli, "SELECT {$use['column']}, COUNT(*), $archived FROM {$use['table']} + $sql = mysqli_query($mysqli, "SELECT {$use['column']}, COUNT(*), $archived FROM {$use['table']} {$use['join']} WHERE {$use['column']} IS NOT NULL AND {$use['column']} <> " . ($config['by'] === 'name' || $use['text'] ? "''" : '0') . " GROUP BY {$use['column']}"); while ($row = mysqli_fetch_row($sql)) { @@ -319,7 +325,7 @@ function categoryLooseNames($kind) { $spelling = []; foreach ($config['uses'] as $index => $use) { $archived = $use['archived'] ? "SUM({$use['archived']} IS NOT NULL)" : '0'; - $sql = mysqli_query($mysqli, "SELECT {$use['column']}, COUNT(*), $archived FROM {$use['table']} + $sql = mysqli_query($mysqli, "SELECT {$use['column']}, COUNT(*), $archived FROM {$use['table']} {$use['join']} WHERE {$use['column']} IS NOT NULL AND TRIM({$use['column']}) <> '' GROUP BY {$use['column']} ORDER BY COUNT(*) DESC"); while ($row = mysqli_fetch_row($sql)) { $key = categoryNameKey($row[0]); @@ -473,12 +479,21 @@ function categoryUpdate(array $row, array $fields) { /* * Point every record of a kind whose category matches $where_sql (" = 'x'", * " IN (1, 2)") at $to_sql instead - leaving when each was last changed as - * it was, as the record itself didn't change. How many records moved. + * it was, as the record itself didn't change. A record that takes several + * (a use with a link) has the new one added - once, if it had it already - + * and the old ones taken off. How many records moved. */ function categoryMoveRecords(array $config, $where_sql, $to_sql) { global $mysqli; $moved = 0; foreach ($config['uses'] as $use) { + if (!empty($use['link'])) { + mysqli_query($mysqli, "INSERT IGNORE INTO {$use['table']} ({$use['link']['owner']}, {$use['column']}) + SELECT {$use['link']['owner']}, $to_sql FROM {$use['table']} WHERE {$use['column']} $where_sql"); + mysqli_query($mysqli, "DELETE FROM {$use['table']} WHERE {$use['column']} $where_sql"); + $moved += max(0, mysqli_affected_rows($mysqli)); + continue; + } $keep = $use['updated'] ? ", {$use['updated']} = {$use['updated']}" : ''; mysqli_query($mysqli, "UPDATE {$use['table']} SET {$use['column']} = $to_sql$keep WHERE {$use['column']} $where_sql"); $moved += max(0, mysqli_affected_rows($mysqli)); diff --git a/js/canned_response_form.js b/js/canned_response_form.js new file mode 100644 index 000000000..f49ecf415 --- /dev/null +++ b/js/canned_response_form.js @@ -0,0 +1,20 @@ +/* + * The canned response window (admin/modals/canned_response/canned_response_form.php): + * a placeholder under the editor goes in where the cursor is. The window is an + * ajax modal that runs this each time it opens, so the listener is bound once. + */ +itflowBindOnce('itflowCannedPlaceholder', 'click', '[data-canned-placeholder]', function () { + const text = '[' + this.dataset.cannedPlaceholder + ']'; + const editor = window.tinymce ? tinymce.get('cannedResponseBody') : null; + if (editor) { + editor.insertContent(text); + editor.focus(); + return; + } + const textarea = document.getElementById('cannedResponseBody'); + if (textarea) { + const at = textarea.selectionStart ?? textarea.value.length; + textarea.value = textarea.value.slice(0, at) + text + textarea.value.slice(textarea.selectionEnd ?? at); + textarea.focus(); + } +});