window.wpbrSaveFilters = function(key, state){
try { window.localStorage.setItem('wpbr_filters_' + key, JSON.stringify(state)); }
catch (e) { /* private mode or storage full - filters just won't persist */ }
};
window.wpbrLoadFilters = function(key){
try {
var raw = window.localStorage.getItem('wpbr_filters_' + key);
return raw ? JSON.parse(raw) : null;
} catch (e) { return null; }
};
window.wpbrClearFilters = function(key){
try { window.localStorage.removeItem('wpbr_filters_' + key); } catch (e) {}
};
__('Upload', 'wpbr-bulk-replace'),
'match' => __('Match', 'wpbr-bulk-replace'),
'review' => __('Review & Resolve', 'wpbr-bulk-replace'),
'replace' => __('Backup & Replace', 'wpbr-bulk-replace'),
);
}
/** One step's title, for prose that names a step the reader has to click. */
function wpbr_wizard_step_title($step) {
$steps = wpbr_wizard_steps();
return isset($steps[$step]) ? $steps[$step] : $step;
}
/**
* Prints one filter chip.
*
* The chips are toggles, so they are real buttons carrying aria-pressed: as
* plain spans they could not be reached or operated from the keyboard at all,
* and a screen reader had no way to tell an engaged filter from an idle one.
* The count is decorative next to the label the button already announces.
*
* $attrs are the data- attributes the filtering script reads; they are stable
* selector keys, never translated.
*
* It prints rather than returns, so every dynamic part is escaped at the
* point it is written out and not somewhere a caller has to trust.
*/
function wpbr_filter_chip($attrs, $count, $label, $dot_style) {
echo '';
}
/**
* Prints the sprintf-alike the inline scripts format their translated templates with.
*
* It understands both %s and the numbered %1$s form, because a translator may
* need to reorder placeholders that PHP wrote in one order, and collapses %%
* to a literal percent sign so the strings follow the same convention as the
* ones PHP formats. A fixed JavaScript literal: nothing is interpolated.
*/
function wpbr_js_fmt_helper() {
echo 'function fmt(tpl){ var a = arguments; return String(tpl).replace(/%%|%(\d+)\$s|%s/g, function(m, n){ return m === "%%" ? "%" : a[n ? Number(n) : 1]; }); }';
}
function wpbr_step_url($batch_id, $step) {
return admin_url('admin.php?page=wpbr-batch-detail&batch_id='.$batch_id.'&step='.$step);
}
/**
* The inline-error styling, emitted at most once per request.
*
* Both the Match step and the Review step show inline validation, and they
* render in separate requests. A rule defined inside one step's style block
* is simply absent on the other, which is how an error message ends up
* rendering as unstyled body text exactly when it matters.
*/
function wpbr_print_inline_error_style() {
static $printed = false;
if ($printed) return;
$printed = true;
wpbr_inline_open('style');
echo ".wpbr-inline-error{display:inline-block;margin-left:8px;color:#b32d2e;font-weight:600;}";
echo "p.wpbr-inline-error{display:block;margin-left:0;}";
wpbr_inline_close();
}
function wpbr_render_batch_detail_page() {
if (!current_user_can('manage_options')) return;
global $wpdb;
$batch_id = isset($_GET['batch_id']) ? intval($_GET['batch_id']) : 0;
if (!$batch_id) {
echo "
" . sprintf(
/* translators: %s is a filesystem path, already wrapped in tags. */
esc_html__('Alternatively, files can be dropped straight into %s over FTP or a mapped drive.', 'wpbr-bulk-replace'),
"".esc_html(wpbr_staging_dir()).""
) . "
";
echo "";
if ($items) {
echo "
" . esc_html(sprintf(
/* translators: %s is a number of files. */
_n('Files in this batch (%s)', 'Files in this batch (%s)', count($items), 'wpbr-bulk-replace'),
number_format_i18n(count($items))
)) . "
";
}
}
// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- Shared step-renderer signature; the four steps take the same arguments whether or not each uses them.
function wpbr_render_step_match($batch, $batch_id, $candidates) {
echo "
" . esc_html__('Choose what these files should be matched against.', 'wpbr-bulk-replace') . "
";
echo "
";
echo "
" . wp_kses_post(__('Safe to re-run. Run Matching again any time you change abbreviations or the fields above.', 'wpbr-bulk-replace')) . "
";
echo "
" . wp_kses_post(__('Left alone: rows you set by hand, plus anything marked Skip, New Page Needed, Confirmed (New Attachment), combined, replaced or verified. ', 'wpbr-bulk-replace'));
echo wp_kses_post(__('Re-matched: rows still carrying an automatic match — Matched and Needs Review.', 'wpbr-bulk-replace')) . "
";
echo "
";
// Public types, plus any a provider can act on — see wpbr_configurable_post_types().
$post_types = wpbr_configurable_post_types();
// WHAT CAN BE CONFIGURED, ASKED OF THE SEAM RATHER THAN OF POST META. This
// was `wpbr_get_meta_key_suggestions()` called directly, which is why an
// add-on holding a reference somewhere else could be read and written
// perfectly and still not be configurable: the only list this screen knew
// how to draw was meta keys. `wpbr_reference_choices()` asks every
// registered provider, the built-in one included, so post meta keeps
// behaving exactly as it did and anything else appears beside it.
$location_choices = array();
foreach ($post_types as $pt) {
$location_choices[$pt->name] = wpbr_reference_choices($pt->name);
}
// Resolved here rather than read off the registry: a provider's label is
// produced at draw time so that registering one does not translate at
// `plugins_loaded`. See `wpbr_reference_provider_label()`.
$provider_labels = array();
foreach (array_keys(wpbr_reference_providers()) as $provider_id) {
$provider_labels[$provider_id] = wpbr_reference_provider_label($provider_id);
}
// If a submission was rejected, keep what was chosen rather than resetting
// the form to defaults - otherwise the post type silently reverts and it
// looks as though the selection never registered.
$selected_post_type = $batch->post_type;
$existing_keys = wpbr_split_meta_keys($batch->meta_key_name);
$pending_text = '';
// What the handler was just sent, held for this redraw (see wpbr_match_submission()).
$submission = wpbr_match_submission();
if ($submission !== null) {
if (!empty($submission['post_type'])) {
$selected_post_type = $submission['post_type'];
}
// What was submitted: the chips and anything typed beside them. Accepted,
// it is the list the batch now holds. Rejected, the chips stay as they
// were and the text stays in the box, so a person corrects what they
// typed instead of typing it again.
$submitted_keys = wpbr_combine_meta_keys($submission['chips'], $submission['pending']);
if ('' === wpbr_meta_keys_problem($submitted_keys)) {
$existing_keys = $submitted_keys;
} else {
if (!empty($submission['chips'])) {
$existing_keys = wpbr_split_meta_keys($submission['chips']);
}
if (!empty($submission['pending'])) {
$pending_text = $submission['pending'];
}
}
}
// A SAVED BATCH HOLDS IDENTIFIERS, AND A PERSON NEEDS NAMES. Resolved here
// rather than in the browser so that a location whose add-on has gone away
// still renders as itself instead of as an empty chip.
$selected_choices = isset($location_choices[$selected_post_type])
? $location_choices[$selected_post_type] : array();
$existing_chips = array();
foreach ($existing_keys as $existing_key) {
$existing_chips[] = array(
'key' => $existing_key,
'label' => wpbr_reference_choice_label($existing_key, $selected_post_type, $selected_choices),
);
}
echo "";
wpbr_inline_open('style');
echo ".wpbr-chip{display:flex;align-items:center;gap:6px;background:#2271b1;color:#fff;padding:4px 10px;border-radius:14px;font-size:13px;cursor:grab;}";
echo ".wpbr-chip.dragging{opacity:0.4;}";
echo ".wpbr-chip button{background:transparent;border:0;color:#fff;cursor:pointer;padding:0 2px;font-size:13px;line-height:1;}";
echo ".wpbr-chip button:focus{outline:2px solid #fff;outline-offset:1px;}";
wpbr_inline_close();
wpbr_print_inline_error_style();
wpbr_inline_open('script');
echo "var wpbrLocationChoices = ".wp_json_encode($location_choices, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT).";";
echo "var wpbrProviderLabels = ".wp_json_encode($provider_labels, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT).";";
echo "var wpbrExistingChips = ".wp_json_encode($existing_chips, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT).";";
echo "var wpbrMetaL10n = " . wp_json_encode(wpbr_meta_js_l10n(), JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ";";
// A number, not text, so it travels beside the translated strings rather than in them.
echo "var wpbrMetaMaxLength = " . (int) wpbr_meta_keys_max_length() . ";";
echo "(function(){";
echo "var L = wpbrMetaL10n;";
echo "var list = document.getElementById('wpbr_meta_chip_list');";
echo "var hidden = document.getElementById('wpbr_meta_keys_hidden');";
echo "var addInput = document.getElementById('wpbr_meta_key_add');";
echo "var datalist = document.getElementById('wpbr_meta_key_list');";
echo "var errBox = document.getElementById('wpbr_meta_error');";
echo "var live = document.getElementById('wpbr_meta_live');";
echo "var postTypeSelect = document.getElementById('wpbr_post_type');";
echo "var picker = document.getElementById('wpbr_location_picker');";
echo "var pickerSelect = document.getElementById('wpbr_location_select');";
echo "var pickerDetail = document.getElementById('wpbr_location_detail');";
echo "var indexWrap = document.getElementById('wpbr_location_index_wrap');";
echo "var indexLabel = document.getElementById('wpbr_location_index_label');";
echo "var indexInput = document.getElementById('wpbr_location_index');";
echo "var pickerAdd = document.getElementById('wpbr_location_add');";
wpbr_js_fmt_helper();
echo "function announce(msg){ live.textContent = ''; window.setTimeout(function(){ live.textContent = msg; }, 50); }";
echo "function showError(msg, target){";
echo "target = target || addInput;";
echo "errBox.textContent = msg; errBox.style.display = 'block';";
echo "target.setAttribute('aria-invalid', 'true');";
echo "target.focus();";
echo "}";
echo "function clearError(){";
echo "errBox.textContent = ''; errBox.style.display = 'none';";
echo "addInput.removeAttribute('aria-invalid');";
echo "indexInput.removeAttribute('aria-invalid');";
echo "}";
echo "function syncHidden(){";
echo "var keys = Array.prototype.map.call(list.children, function(chip){ return chip.dataset.key; });";
echo "hidden.value = keys.join(',');";
echo "}";
// NAMED BY WHAT IS ON SCREEN. These used to read the identifier, which for a
// meta key is the same string and for a generated one is an announcement of
// "Remove field_68c1f0a9b2e41".
echo "function chipName(chip){ return chip.dataset.label || chip.dataset.key; }";
echo "function relabel(){";
echo "Array.prototype.slice.call(list.children).forEach(function(chip){";
echo "var name = chipName(chip);";
echo "chip.querySelector('.wpbr-chip-remove').setAttribute('aria-label', fmt(L.remove, name));";
echo "chip.querySelector('.wpbr-chip-up').setAttribute('aria-label', fmt(L.moveUp, name));";
echo "chip.querySelector('.wpbr-chip-down').setAttribute('aria-label', fmt(L.moveDown, name));";
echo "});";
echo "}";
echo "function moveChip(chip, delta){";
echo "var sibling = delta < 0 ? chip.previousElementSibling : chip.nextElementSibling;";
echo "if (!sibling) { announce(delta < 0 ? L.atTop : L.atBottom); return; }";
echo "if (delta < 0) { list.insertBefore(chip, sibling); } else { list.insertBefore(sibling, chip); }";
echo "syncHidden();";
echo "var pos = Array.prototype.indexOf.call(list.children, chip) + 1;";
echo "announce(fmt(L.moved, chipName(chip), pos, list.children.length));";
echo "}";
echo "function addChip(key, label){";
echo "key = key.trim();";
echo "if (!key) return;";
echo "label = (label || key).trim() || key;";
echo "var existing = Array.prototype.map.call(list.children, function(c){ return c.dataset.key; });";
echo "if (existing.indexOf(key) !== -1) return;";
echo "var chip = document.createElement('li');";
echo "chip.className = 'wpbr-chip';";
echo "chip.draggable = true;";
echo "chip.dataset.key = key;";
echo "chip.dataset.label = label;";
// The identifier is on the chip as a title, which is where a diagnostic
// belongs: reachable when somebody is working out why a field is not
// matching, and not the thing they read while configuring a batch.
echo "chip.title = key;";
echo "var span = document.createElement('span'); span.textContent = label;";
// Buttons, not spans. A span with a click handler is invisible to the
// keyboard and unnamed to a screen reader, so the only way to remove a
// field was to reach for a mouse.
echo "var up = document.createElement('button'); up.type='button'; up.className='wpbr-chip-up'; up.innerHTML='\\u2039';";
echo "var dn = document.createElement('button'); dn.type='button'; dn.className='wpbr-chip-down'; dn.innerHTML='\\u203A';";
echo "var remove = document.createElement('button'); remove.type='button'; remove.className='wpbr-chip-remove'; remove.innerHTML='\\u00D7';";
echo "up.addEventListener('click', function(){ moveChip(chip, -1); up.focus(); });";
echo "dn.addEventListener('click', function(){ moveChip(chip, 1); dn.focus(); });";
echo "remove.addEventListener('click', function(){";
echo "var name = chipName(chip);";
echo "chip.remove(); syncHidden(); relabel();";
echo "announce(fmt(L.removed, name));";
echo "addInput.focus();";
echo "});";
echo "chip.appendChild(span); chip.appendChild(up); chip.appendChild(dn); chip.appendChild(remove);";
echo "chip.addEventListener('dragstart', function(e){ chip.classList.add('dragging'); e.dataTransfer.effectAllowed = 'move'; });";
echo "chip.addEventListener('dragend', function(){ chip.classList.remove('dragging'); syncHidden(); });";
echo "list.appendChild(chip);";
echo "syncHidden(); relabel();";
echo "clearError();";
echo "announce(fmt(L.added, label, list.children.length, list.children.length));";
echo "}";
// Text typed but not committed with Enter would otherwise be silently
// discarded on submit, posting an empty field list. Enter, a pick from the
// list and Run Matching all go through the one function, so the keyboard and
// the mouse cannot disagree about what was typed: it is split on commas the
// way the server splits the saved list, each name is trimmed, and a name
// already in the list is not added again.
echo "function commitPending(){";
echo "var typed = addInput.value;";
echo "addInput.value = '';";
echo "typed.split(',').forEach(function(name){ addChip(name); });";
echo "}";
echo "var matchForm = addInput.closest('form');";
echo "if (matchForm) {";
echo "matchForm.addEventListener('submit', function(e){";
echo "commitPending();";
echo "syncHidden();";
echo "if (!hidden.value.trim()) {";
echo "e.preventDefault();";
echo "showError(L.needOne);";
echo "} else if (hidden.value.length > wpbrMetaMaxLength) {";
echo "e.preventDefault();";
echo "showError(fmt(L.tooLong, wpbrMetaMaxLength));";
echo "}";
echo "});";
echo "}";
echo "list.addEventListener('dragover', function(e){";
echo "e.preventDefault();";
echo "var dragging = list.querySelector('.dragging');";
echo "if (!dragging) return;";
echo "var after = Array.prototype.find.call(list.children, function(c){ return c !== dragging && e.clientX < c.getBoundingClientRect().left + c.getBoundingClientRect().width/2; });";
echo "if (after) { list.insertBefore(dragging, after); } else { list.appendChild(dragging); }";
echo "});";
echo "addInput.addEventListener('keydown', function(e){";
echo "if (e.key === 'Enter') { e.preventDefault(); commitPending(); }";
echo "});";
// PICKING FROM THE LIST IS A CHOICE, NOT TYPING. A datalist pick arrives as an
// input event of type insertReplacementText (a browser that gives no type at
// all is taken to have picked when the value is exactly one of the offered
// names), and it becomes a chip at once - the same thing Enter and Add field
// do. Typing and pasting still wait for Enter or Run Matching.
echo "addInput.addEventListener('input', function(e){";
echo "clearError();";
echo "var offered = Array.prototype.map.call(datalist.children, function(o){ return o.value; });";
echo "var picked = e.inputType === 'insertReplacementText' || (typeof e.inputType === 'undefined' && offered.indexOf(addInput.value.trim()) !== -1);";
echo "if (picked) { commitPending(); }";
echo "});";
// --- the picker ---------------------------------------------------------
// Built from whatever the seam could enumerate for the selected post type,
// grouped by the provider that offered it so that "Post meta" and an
// add-on's fields are told apart without either being privileged.
echo "function choicesFor(postType){ return wpbrLocationChoices[postType] || []; }";
echo "function currentChoice(){";
echo "var choices = choicesFor(postTypeSelect.value);";
echo "var i = parseInt(pickerSelect.value, 10);";
echo "return (isNaN(i) || !choices[i]) ? null : choices[i];";
echo "}";
echo "function syncPicker(){";
echo "var c = currentChoice();";
echo "if (!c) { indexWrap.style.display = 'none'; pickerDetail.textContent = ''; return; }";
// A position is asked for only where one exists to ask about. Everything
// else would be a question with no answer.
echo "if (c.template) { indexWrap.style.display = ''; indexLabel.textContent = c.index_label; }";
echo "else { indexWrap.style.display = 'none'; }";
echo "var id = c.value || c.template;";
echo "pickerDetail.textContent = c.detail ? (c.detail + ' \u2014 ' + id) : id;";
echo "}";
echo "function buildPicker(){";
echo "var choices = choicesFor(postTypeSelect.value);";
echo "pickerSelect.innerHTML = '';";
echo "datalist.innerHTML = '';";
echo "var groups = {};";
echo "choices.forEach(function(c, i){";
// The text box has always offered meta keys and still does; a provider's
// locations belong in the list, not in a free-text box that would accept a
// half-typed identifier.
echo "if (c.provider === " . wp_json_encode(WPBR_REFERENCE_PROVIDER_META) . " && c.value) {";
echo "var d = document.createElement('option'); d.value = c.value; datalist.appendChild(d);";
echo "}";
echo "if (!groups[c.provider]) {";
echo "var g = document.createElement('optgroup');";
echo "g.label = wpbrProviderLabels[c.provider] || c.provider;";
echo "groups[c.provider] = g; pickerSelect.appendChild(g);";
echo "}";
echo "var o = document.createElement('option'); o.value = String(i); o.textContent = c.label;";
echo "groups[c.provider].appendChild(o);";
echo "});";
// Hidden rather than shown empty: a select with nothing in it is a control
// that looks broken, and the text box below it still works.
echo "picker.style.display = choices.length ? '' : 'none';";
echo "syncPicker();";
echo "}";
echo "pickerSelect.addEventListener('change', syncPicker);";
echo "pickerAdd.addEventListener('click', function(){";
echo "var c = currentChoice();";
echo "if (!c) return;";
echo "var key = c.value, label = c.label;";
echo "if (c.template) {";
echo "var n = parseInt(indexInput.value, 10);";
echo "if (!n || n < 1) { showError(fmt(L.needIndex, c.index_label), indexInput); return; }";
echo "key = c.template.replace('{n}', String(n));";
echo "label = fmt(L.indexed, c.label, c.index_label, n);";
echo "}";
echo "addChip(key, label);";
echo "});";
echo "indexInput.addEventListener('input', clearError);";
// Enter in this box is "add the field", as it is in the name box. Left alone
// it is implicit form submission: Run Matching, from a half-filled picker.
echo "indexInput.addEventListener('keydown', function(e){";
echo "if (e.key === 'Enter') { e.preventDefault(); pickerAdd.click(); }";
echo "});";
echo "postTypeSelect.addEventListener('change', buildPicker);";
echo "buildPicker();";
echo "wpbrExistingChips.forEach(function(c){ addChip(c.key, c.label); });";
echo "live.textContent = '';";
echo "})();";
wpbr_inline_close();
}
function wpbr_filename_safe($str) {
$str = (string) $str;
$str = str_replace(array('.', "'", '(', ')', ','), '', $str);
$str = str_replace('&', 'and', $str);
$str = preg_replace('/\s+/', '-', trim($str));
$str = preg_replace('/-+/', '-', $str);
return sanitize_file_name($str);
}
function wpbr_apply_rename_template($template, $post_id, $original_filename, $ext) {
$name_no_ext = preg_replace('/\.[a-z0-9]+$/i', '', $original_filename);
$result = $template;
$result = str_replace('{title}', $post_id ? wpbr_filename_safe(wpbr_clean_title(get_the_title($post_id))) : '', $result);
$result = str_replace('{id}', $post_id ? intval($post_id) : '', $result);
$result = str_replace('{original}', wpbr_filename_safe($name_no_ext), $result);
$result = str_replace('{ext}', $ext ? $ext : 'pdf', $result);
// current_time(), not date(): a filename dated "today" should mean today in
// the timezone the site is configured for, not the server's.
$result = str_replace('{date}', current_time('Y-m-d'), $result);
$result = str_replace('{date:Ymd}', current_time('Ymd'), $result);
$result = str_replace('{date:Y}', current_time('Y'), $result);
if ($post_id && preg_match_all('/\{meta:([a-zA-Z0-9_-]+)\}/', $result, $matches)) {
foreach ($matches[1] as $i => $meta_key) {
$val = get_post_meta($post_id, $meta_key, true);
$result = str_replace($matches[0][$i], wpbr_filename_safe($val), $result);
}
}
return sanitize_file_name($result);
}
/**
* Display labels for the stored item statuses.
*
* The keys are persisted and queried on, so they are never translated; only
* what the reader sees is.
*/
function wpbr_status_labels() {
return array(
'staged' => __('Staged', 'wpbr-bulk-replace'),
'matched' => __('Matched', 'wpbr-bulk-replace'),
'needs_review' => __('Needs Review', 'wpbr-bulk-replace'),
'confirmed_new_attach' => __('Confirmed (New Attachment)', 'wpbr-bulk-replace'),
'skip' => __('Skip', 'wpbr-bulk-replace'),
'new_page_needed' => __('New Page Needed', 'wpbr-bulk-replace'),
'replaced' => __('Replaced', 'wpbr-bulk-replace'),
'verified' => __('Verified', 'wpbr-bulk-replace'),
'cleaned_up' => __('Cleaned Up', 'wpbr-bulk-replace'),
'combined' => __('Combined', 'wpbr-bulk-replace'),
'needs_attention' => __('Needs attention', 'wpbr-bulk-replace'),
);
}
function wpbr_selectable_statuses() {
return array('matched', 'needs_review', 'skip', 'new_page_needed');
}
/**
* The status a review-form submission may leave a row in.
*
* The form offers wpbr_selectable_statuses(), plus - for a row already past
* review, such as one that has been replaced - that row's own status, so it
* round-trips unchanged. Anything else in the request is not something the form
* could have produced: a row cannot be declared "replaced" or "verified" by
* posting the word, since those are set only by the run that did the work.
* The row keeps the status it has.
*
* @param string $submitted The status the form sent, already sanitized.
* @param string|null $current The row's stored status, or null for an unknown row.
*/
function wpbr_review_status($submitted, $current) {
// A file waiting for attention leaves that state only through Retry restore or its own recovery action. No form
// field, however it was posted, moves it: that would hide the damage and release the batch.
if ($current === 'needs_attention') return $current;
if (in_array($submitted, wpbr_selectable_statuses(), true)) return $submitted;
if ($current !== null && $submitted === $current) return $submitted;
return $current !== null ? $current : 'needs_review';
}
function wpbr_item_needs_new_attach($item, $batch) {
if (!$item->matched_post_id || !$batch || !$batch->meta_key_name) return false;
// `found` rather than a truthy location: on a post with nothing anywhere the
// resolved location is still the first configured one, because that is where
// a write would go.
return !wpbr_reference_current($batch, $item->matched_post_id)['found'];
}
function wpbr_match_kind_of($item) {
return isset($item->match_kind) && $item->match_kind !== null ? (string) $item->match_kind : '';
}
function wpbr_confidence_info($item) {
if (!$item->matched_post_id) {
// AN AMBIGUOUS REFUSAL IS NOT THE SAME AS NOTHING RESEMBLING THIS FILE,
// and the reader fixes them in completely different places, so the
// screen says which one happened.
if (wpbr_match_kind_of($item) === WPBR_MATCH_AMBIGUOUS) {
return array('color' => '#d63638', 'label' => __('Ambiguous identifier', 'wpbr-bulk-replace'));
}
return array('color' => '#c3c4c7', 'label' => __('No match', 'wpbr-bulk-replace'));
}
// AN EXACT IDENTIFIER IS NOT A CONFIDENCE. Rendering it as "High confidence
// (100%)" invites the reader to wonder what the missing 0% was, and puts it
// on the same scale as a coincidence of spelling.
if (wpbr_match_kind_of($item) === WPBR_MATCH_EXACT) {
return array('color' => '#00a32a', 'label' => __('Exact identifier', 'wpbr-bulk-replace'));
}
if (wpbr_match_kind_of($item) === WPBR_MATCH_REMEMBERED) {
return array('color' => '#00a32a', 'label' => __('From a previous decision', 'wpbr-bulk-replace'));
}
if ($item->confidence_score === null || $item->confidence_score === '') {
return array('color' => '#00a32a', 'label' => __('Set manually', 'wpbr-bulk-replace'));
}
$score = floatval($item->confidence_score);
if ($score >= wpbr_high_threshold()) return array('color' => '#00a32a', 'label' => __('High confidence', 'wpbr-bulk-replace'));
if ($score >= wpbr_confidence_threshold()) return array('color' => '#dba617', 'label' => __('Medium confidence', 'wpbr-bulk-replace'));
return array('color' => '#d63638', 'label' => __('Low confidence', 'wpbr-bulk-replace'));
}
/**
* The short, visible form of a row's score: "Exact", "High 91%", "Medium 72%", "Low 51%", "No match".
*
* @param object $item The row's item.
* @param array $conf wpbr_confidence_info($item).
* @return string
*/
function wpbr_score_short_label($item, $conf) {
$tier = wpbr_confidence_tier_key($item);
$names = array(
'exact' => __('Exact', 'wpbr-bulk-replace'),
'high' => __('High', 'wpbr-bulk-replace'),
'medium' => __('Medium', 'wpbr-bulk-replace'),
'low' => __('Low', 'wpbr-bulk-replace'),
'none' => $conf['label'],
);
$name = isset($names[$tier]) ? $names[$tier] : $conf['label'];
if (in_array($tier, array('high', 'medium', 'low'), true) && $item->confidence_score !== null && $item->confidence_score !== '') {
return $name . ' ' . round($item->confidence_score * 100) . '%';
}
return $name;
}
function wpbr_confidence_tier_key($item) {
if (!$item->matched_post_id) return 'none';
if (wpbr_match_kind_of($item) === WPBR_MATCH_EXACT) return 'exact';
if ($item->confidence_score === null || $item->confidence_score === '') return 'high';
$score = floatval($item->confidence_score);
if ($score >= wpbr_high_threshold()) return 'high';
if ($score >= wpbr_confidence_threshold()) return 'medium';
return 'low';
}
/**
* The attributes that disable a control on a row waiting for attention. Printed rather than returned: it is output.
*/
function wpbr_echo_held_attributes($held, $reason) {
if (!$held) return;
echo ' disabled aria-disabled="true" title="' . esc_attr($reason) . '"';
}
/**
* An accessible name for a control in a review row: what it is, and for which file.
*
* The visible column heading is not associated with a field in a table cell, so a screen reader would announce "edit text" with
* no hint which row it belongs to.
*
* @param string $what The control's role in words ("Rename to", "Status", "Notes", "Select").
* @param object $item The row's item.
* @return string Plain text; callers escape it.
*/
function wpbr_row_control_label($what, $item) {
return sprintf(
/* translators: 1: what a field in the table is ("Rename to", "Status", "Notes"), 2: the staged file's name. */
__('%1$s: %2$s', 'wpbr-bulk-replace'),
$what,
$item->staged_filename
);
}
function wpbr_render_review_row($item, $candidates, $batch, $conflict_ids = array()) {
/* translators: %s is the singular label of the post type being matched, e.g. "product". */
$matched_col = sprintf(__('Matched %s', 'wpbr-bulk-replace'), wpbr_post_type_label($batch->post_type));
$ext = strtolower(pathinfo($item->staged_filename, PATHINFO_EXTENSION));
$needs_new_attach = wpbr_item_needs_new_attach($item, $batch);
$confirmed_new = ($item->status === 'confirmed_new_attach');
$tier = wpbr_confidence_tier_key($item);
$matched_permalink = '';
if ($item->matched_post_id) {
foreach ($candidates as $c) {
if ($c['id'] == $item->matched_post_id) { $matched_permalink = $c['permalink']; break; }
}
}
$has_conflict = isset($conflict_ids[$item->id]);
$conflict_group = $has_conflict ? $conflict_ids[$item->id]['group'] : '';
// A file waiting for attention is resolved from the panel above the table, not here. Its controls are shown but disabled,
// with the reason on them, so nothing invites an edit that would be ignored.
$held = ($item->status === 'needs_attention');
$held_reason = __('Deal with this file in the panel at the top of the page first.', 'wpbr-bulk-replace');
echo "
";
echo " ";
echo esc_html(sprintf(
/* translators: 1: a post title, 2: how many other files are matched to it. */
_n('Also matched to “%1$s” by %2$s other file.', 'Also matched to “%1$s” by %2$s other files.', (int) $ci['count'], 'wpbr-bulk-replace'),
$ci['post_title'],
number_format_i18n($ci['count'])
)) . " ";
echo "" . esc_html(
_n('Show it', 'Show them', $ci['count'], 'wpbr-bulk-replace')
) . "";
echo "
";
$view_style = $matched_permalink ? '' : 'display:none;';
$open_label = sprintf(
/* translators: %s is the singular label of a post type, e.g. "product". */
__('Open this %s in a new tab', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type)
);
echo "";
echo "
";
if ($orphan_id) {
echo "
";
echo esc_html(sprintf(
/* translators: 1: the singular label of a post type, e.g. "product", 2: a numeric post ID. */
__('Matched to %1$s ID %2$s, but that %1$s has no title — it may be unpublished or deleted. Pick another one above to replace it.', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type),
$orphan_id
));
echo "
";
}
echo "
";
echo "
";
$conf = wpbr_confidence_info($item);
// Colour alone must not carry the meaning: the same fact is text, in the
// accessible name and in a screen-reader span.
if ($item->confidence_score !== null && $item->confidence_score !== '') {
$conf_text = sprintf(
/* translators: 1: a confidence label such as "High confidence", 2: a percentage. */
__('%1$s (%2$s)', 'wpbr-bulk-replace'),
$conf['label'], round($item->confidence_score * 100) . '%'
);
} else {
// NO PERCENTAGE RATHER THAN "n/a". A scoreless match has a reason -
// exact, remembered, or a person - and the label already says which;
// pairing it with "(n/a)" only suggests a number went missing.
$conf_text = $conf['label'];
}
echo "";
echo "".esc_html($conf_text)."";
// The same fact as visible text: colour is never the only signal. aria-hidden because the line above already says it.
echo "".esc_html(wpbr_score_short_label($item, $conf))."";
echo "
" . esc_html(sprintf(
/* translators: %s is the singular label of a post type, e.g. "product". */
__('Suggested from the %s title — edit if needed, then Save Changes.', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type)
)) . "
";
}
if ($needs_new_attach && !$confirmed_new) {
echo "
";
if ($item->status === 'needs_attention') {
// Nothing to choose: the recovery panel above the table is the only way out, and a dropdown would suggest otherwise.
echo "
" . esc_html(sprintf(
/* translators: %s is a number of conflicts. */
_n('%s conflict needs resolving.', '%s conflicts need resolving.', $blocking_count, 'wpbr-bulk-replace'),
number_format_i18n($blocking_count)
)) . " ";
echo wp_kses_post(sprintf(
/* translators: 1: the singular label of a post type, e.g. "product", 2: the name of the final wizard step, e.g. "Backup & Replace". */
__('More than one file is matched to the same %1$s, so they would overwrite each other. %2$s is blocked until these are fixed. Use the Conflicts filter below to work through them.', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type),
esc_html(wpbr_wizard_step_title('replace'))
)) . " ";
wpbr_help_link_echo('error.collision-detected', __('Why this blocks the run', 'wpbr-bulk-replace'));
echo "
";
echo "
";
foreach ($collisions['blocking'] as $c) {
echo "
" . wp_kses_post(__('Send the file to whoever knows this content best, then import their filled-in copy — matches rows by staged filename and updates the match, status, and notes.', 'wpbr-bulk-replace')) . "
";
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; the screen shows live state, and a cached copy would lag the write the person just made.
$import_history = $wpdb->get_results($wpdb->prepare(
"SELECT import_uuid, source_filename, created_at, created_by, COUNT(*) AS row_count
FROM {$wpdb->prefix}wpbr_import_log
WHERE batch_id = %d
GROUP BY import_uuid, source_filename, created_at, created_by
ORDER BY created_at DESC",
$batch_id
));
if ($import_history) {
echo "
";
echo "
" . esc_html__('Import history', 'wpbr-bulk-replace') . " ";
echo "— " . esc_html__('undo restores every row that import changed, back to how it was before it ran. Rows combined, replaced, or verified since then are left alone.', 'wpbr-bulk-replace') . " ";
wpbr_help_link_echo('core.review.import', __('The reviewer round trip', 'wpbr-bulk-replace'));
echo "
" . esc_html__('Before you send this to a reviewer', 'wpbr-bulk-replace') . "
";
echo "
" . esc_html__('What the reviewer should edit', 'wpbr-bulk-replace') . "
";
echo "
";
echo "
" . wp_kses_post(__('staged_filename — do not edit or reorder this column, it\'s how their answers get matched back up.', 'wpbr-bulk-replace')) . "
";
echo "
" . wp_kses_post(__('matched_post_id — the correct numeric ID if the automatic match is wrong. Leave blank if none applies.', 'wpbr-bulk-replace')) . "
";
echo "
" . wp_kses_post(__('status — one of the values listed below.', 'wpbr-bulk-replace')) . "
";
echo "
" . wp_kses_post(__('notes — any comments back to you.', 'wpbr-bulk-replace')) . "
";
echo "
";
echo "
" . esc_html__('Valid status values', 'wpbr-bulk-replace') . "
";
// The suggested email is prose the site owner sends to a colleague, so it
// is translated. The column names inside it are the CSV's own headers and
// stay in English: renaming them would break the import.
$email_body = __('Hi,', 'wpbr-bulk-replace') . "\n\n";
$email_body .= sprintf(
/* translators: 1: a number of files, 2: the batch name. */
_n('Attached is a spreadsheet of %1$s file ("%2$s") that needs your review. Please only edit these columns:',
'Attached is a spreadsheet of %1$s files ("%2$s") that need your review. Please only edit these columns:',
count($items), 'wpbr-bulk-replace'),
number_format_i18n(count($items)),
$batch->label
) . "\n\n";
$email_body .= '- ' . __('matched_post_id: the correct numeric ID if the automatic match is wrong. Leave blank if none applies.', 'wpbr-bulk-replace') . "\n";
$email_body .= '- ' . sprintf(
/* translators: %s is a comma-separated list of status values such as "matched, needs_review". */
__('status: one of %s', 'wpbr-bulk-replace'),
implode(', ', wpbr_selectable_statuses())
) . "\n";
$email_body .= '- ' . __('notes: any comments back to me', 'wpbr-bulk-replace') . "\n\n";
$email_body .= __('Please do not edit the staged_filename column or rename the file itself.', 'wpbr-bulk-replace') . "\n\n";
$email_body .= __('Status meanings:', 'wpbr-bulk-replace') . "\n";
foreach (wpbr_selectable_statuses() as $slug) {
$email_body .= '- ' . $slug . ': ' . $status_labels_all[$slug] . "\n";
}
$email_body .= "\n" . __('When you are done, just save and send the file back to me in the same format (CSV or Excel both work).', 'wpbr-bulk-replace');
$email_body .= "\n\n" . __('Thanks!', 'wpbr-bulk-replace');
echo "
" . wp_kses_post(__('Make sure the file still has these columns: staged_filename, matched_post_id, status, notes. Accepted formats: .csv, .xlsx (first sheet only).', 'wpbr-bulk-replace')) . "
";
echo "";
echo "
";
echo "
";
wpbr_inline_open('script');
echo "(function(){";
echo "var openBtn = document.getElementById('wpbr_open_import_modal');";
echo "var modal = document.getElementById('wpbr_import_modal');";
echo "var cancelBtn = document.getElementById('wpbr_import_cancel');";
echo "var dropzone = document.getElementById('wpbr_import_dropzone');";
echo "var input = document.getElementById('wpbr_import_file_input');";
echo "var filenameLabel = document.getElementById('wpbr_import_filename');";
echo "var submitBtn = document.getElementById('wpbr_import_submit');";
echo "function setFile(files){";
echo "if (!files || !files.length) return;";
echo "input.files = files;";
echo "filenameLabel.textContent = 'Selected: ' + files[0].name;";
echo "filenameLabel.style.display = 'block';";
echo "submitBtn.disabled = false;";
echo "}";
echo "function closeImport(){";
echo "input.value = '';";
echo "filenameLabel.style.display = 'none';";
echo "submitBtn.disabled = true;";
echo "window.wpbrDialog.hide(modal);";
echo "}";
echo "openBtn.addEventListener('click', function(){ window.wpbrDialog.show(modal, { opener: openBtn, initial: cancelBtn, cancel: closeImport }); });";
echo "cancelBtn.addEventListener('click', closeImport);";
echo "modal.addEventListener('click', function(e){ if (e.target === modal) { closeImport(); } });";
echo "dropzone.addEventListener('click', function(){ input.click(); });";
echo "dropzone.addEventListener('keydown', function(e){ if (e.key === 'Enter' || e.key === ' ') { e.preventDefault(); input.click(); } });";
echo "input.addEventListener('change', function(){ setFile(input.files); });";
echo "['dragenter','dragover'].forEach(function(evt){";
echo "dropzone.addEventListener(evt, function(e){ e.preventDefault(); e.stopPropagation(); dropzone.style.background = '#eaf2fa'; dropzone.style.borderColor = '#2271b1'; });";
echo "});";
echo "['dragleave','drop'].forEach(function(evt){";
echo "dropzone.addEventListener(evt, function(e){ e.preventDefault(); e.stopPropagation(); dropzone.style.background = '#fafafa'; dropzone.style.borderColor = '#c3c4c7'; });";
echo "});";
echo "dropzone.addEventListener('drop', function(e){ setFile(e.dataTransfer.files); });";
echo "})();";
wpbr_inline_close();
wpbr_dialog_support_print();
$active_items = array();
foreach ($items as $item) {
if ($item->status === 'combined') continue;
$active_items[] = $item;
}
// `exact` IS A TIER AND IT HAS TO BE DECLARED HERE, which the identifier
// work did not do. `wpbr_confidence_tier_key()` started returning it, this
// array did not have the key, and every exact match raised an undefined-key
// warning and was counted in no chip at all — so the filter row undercounted
// the batch and offered no way to see the matches it was most sure of. Found
// by driving the screen in a browser; no unit test renders this row.
$tier_counts = array('exact' => 0, 'high' => 0, 'medium' => 0, 'low' => 0, 'none' => 0);
$no_file_count = 0;
foreach ($active_items as $ai) {
if ($ai->status === 'skip') continue;
$tier_counts[wpbr_confidence_tier_key($ai)]++;
if (wpbr_item_needs_new_attach($ai, $batch) && $ai->status !== 'confirmed_new_attach') $no_file_count++;
}
echo "
";
echo "" . esc_html__('Filter:', 'wpbr-bulk-replace') . "";
// FIRST, AND IN THE BRAND BLUE RATHER THAN THE CONFIDENCE GREEN, because it
// is not the top of the confidence scale — it is off it.
wpbr_filter_chip(array('data-filter-tier' => 'exact'), $tier_counts['exact'], __('Exact', 'wpbr-bulk-replace'), 'background:#006DF5;color:#fff;');
wpbr_filter_chip(array('data-filter-tier' => 'high'), $tier_counts['high'], __('High', 'wpbr-bulk-replace'), 'background:#00a32a;color:#fff;');
wpbr_filter_chip(array('data-filter-tier' => 'medium'), $tier_counts['medium'], __('Medium', 'wpbr-bulk-replace'), 'background:#dba617;color:#1d2327;');
wpbr_filter_chip(array('data-filter-tier' => 'low'), $tier_counts['low'], __('Low', 'wpbr-bulk-replace'), 'background:#d63638;color:#fff;');
wpbr_filter_chip(array('data-filter-tier' => 'none'), $tier_counts['none'], __('No match', 'wpbr-bulk-replace'), 'background:#c3c4c7;color:#1d2327;');
wpbr_filter_chip(array('data-filter-attach' => '1'), $no_file_count, __('No existing file', 'wpbr-bulk-replace'), 'background:#b32d2e;color:#fff;');
if ($conflict_ids) {
wpbr_filter_chip(array('data-filter-conflict' => '1'), count($conflict_ids), __('Conflicts', 'wpbr-bulk-replace'), 'background:#b32d2e;color:#fff;');
}
echo "";
echo "
";
$status_counts = array();
foreach ($active_items as $ai) {
if (!isset($status_counts[$ai->status])) $status_counts[$ai->status] = 0;
$status_counts[$ai->status]++;
}
if (count($status_counts) > 1) {
echo "
";
}
echo "";
// Strings the script shows the user, translated server-side and handed
// over as data. Leaving English literals in the script would make this
// dialog the one part of the screen that cannot be translated.
echo "
";
echo "
";
echo "
" . esc_html__('Combine into one PDF', 'wpbr-bulk-replace') . "
";
echo "
" . esc_html__('These will be merged in the order shown — first in the list becomes the first page. Use the Move up and Move down buttons to reorder, or drag the rows if you prefer.', 'wpbr-bulk-replace') . "
";
echo "";
// Reordering is otherwise a silent visual change: the list rearranges and
// nothing says so. Announced politely, so it does not interrupt a key
// press already in progress.
echo "";
echo "
" . esc_html__('The originals stay in the batch marked as combined, so this can be undone by deleting the merged row and setting them back.', 'wpbr-bulk-replace') . "
";
echo "
";
echo "";
echo "";
echo "
";
wpbr_inline_open('style');
echo "#wpbr_combine_list li{display:flex;align-items:center;gap:8px;background:#f6f7f7;border:1px solid #dcdcde;border-radius:4px;padding:8px 10px;margin-bottom:6px;cursor:grab;}";
echo "#wpbr_combine_list li.dragging{opacity:.45;}";
echo "#wpbr_combine_list .wpbr-pos{min-width:22px;height:22px;border-radius:50%;background:#2271b1;color:#fff;font-size:11px;font-weight:600;display:inline-flex;align-items:center;justify-content:center;}";
echo "#wpbr_combine_list .wpbr-nm{flex:1;font-size:13px;word-break:break-all;}";
echo "#wpbr_combine_list button{padding:0 6px;line-height:1.6;}";
wpbr_inline_close();
wpbr_print_inline_error_style();
wpbr_inline_open('script');
echo "var wpbrCombineL10n = " . wp_json_encode(wpbr_combine_js_l10n(), JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ";";
echo "(function(){";
echo "var L = wpbrCombineL10n;";
echo "var modal = document.getElementById('wpbr_combine_modal');";
echo "var panel = document.getElementById('wpbr_combine_panel');";
echo "var list = document.getElementById('wpbr_combine_list');";
echo "var live = document.getElementById('wpbr_combine_live');";
echo "var btn = document.getElementById('wpbr_btn_combine');";
echo "var errBox = document.getElementById('wpbr_combine_error');";
echo "var orderField = document.getElementById('wpbr_combine_order');";
echo "var form = document.getElementById('wpbr_review_form');";
echo "if (!btn || !modal) return;";
wpbr_js_fmt_helper();
echo "function announce(msg){ live.textContent = ''; window.setTimeout(function(){ live.textContent = msg; }, 50); }";
echo "function showError(msg){";
echo "if (!errBox) return;";
echo "errBox.textContent = msg; errBox.style.display = 'inline-block';";
echo "btn.focus();";
echo "}";
echo "function clearError(){ if (errBox) { errBox.textContent = ''; errBox.style.display = 'none'; } }";
// Position is shown as a numbered circle, which is decoration; the same
// information has to reach a screen reader as text, and both have to be
// rewritten after every move.
echo "function renumber(){";
echo "var items = Array.prototype.slice.call(list.children);";
echo "items.forEach(function(li, i){";
echo "var name = li.dataset.name || '';";
echo "li.querySelector('.wpbr-pos').textContent = (i + 1);";
echo "li.querySelector('.wpbr-sr-pos').textContent = fmt(L.position, i + 1, items.length) + ' ';";
echo "li.querySelector('.wpbr-up').setAttribute('aria-label', fmt(L.moveUp, name));";
echo "li.querySelector('.wpbr-down').setAttribute('aria-label', fmt(L.moveDown, name));";
echo "});";
echo "}";
echo "function move(li, delta){";
echo "var sibling = delta < 0 ? li.previousElementSibling : li.nextElementSibling;";
echo "if (!sibling) { announce(delta < 0 ? L.atTop : L.atBottom); return; }";
echo "if (delta < 0) { list.insertBefore(li, sibling); } else { list.insertBefore(sibling, li); }";
echo "renumber();";
echo "var pos = Array.prototype.indexOf.call(list.children, li) + 1;";
echo "announce(fmt(L.moved, li.dataset.name || '', pos, list.children.length));";
echo "}";
echo "function build(){";
echo "list.innerHTML = '';";
echo "document.querySelectorAll('.wpbr-row-check:checked').forEach(function(cb){";
echo "var row = cb.closest('tr');";
echo "var cell = row ? row.querySelector('td[data-colname=\"Staged filename\"] span') : null;";
echo "var name = cell ? cell.textContent : '';";
echo "if (!name) { name = fmt(L.itemLabel, cb.value); }";
echo "var li = document.createElement('li');";
echo "li.draggable = true;";
echo "li.dataset.id = cb.value;";
echo "li.dataset.name = name;";
echo "var pos = document.createElement('span'); pos.className = 'wpbr-pos'; pos.setAttribute('aria-hidden', 'true');";
echo "var srPos = document.createElement('span'); srPos.className = 'wpbr-sr-pos screen-reader-text';";
echo "var nm = document.createElement('span'); nm.className = 'wpbr-nm'; nm.textContent = name;";
echo "var up = document.createElement('button'); up.type='button'; up.className='button button-small wpbr-up'; up.innerHTML='\\u2191';";
echo "var dn = document.createElement('button'); dn.type='button'; dn.className='button button-small wpbr-down'; dn.innerHTML='\\u2193';";
echo "up.addEventListener('click', function(){ move(li, -1); up.focus(); });";
echo "dn.addEventListener('click', function(){ move(li, 1); dn.focus(); });";
echo "li.appendChild(pos); li.appendChild(srPos); li.appendChild(nm); li.appendChild(up); li.appendChild(dn);";
echo "list.appendChild(li);";
echo "});";
echo "renumber();";
echo "}";
// Drag stays as an enhancement. Everything it does, the buttons already do.
echo "var dragged = null;";
echo "list.addEventListener('dragstart', function(e){ dragged = e.target.closest('li'); if (dragged) dragged.classList.add('dragging'); });";
echo "list.addEventListener('dragend', function(){";
echo "if (dragged) { dragged.classList.remove('dragging'); renumber();";
echo "var pos = Array.prototype.indexOf.call(list.children, dragged) + 1;";
echo "announce(fmt(L.moved, dragged.dataset.name || '', pos, list.children.length)); }";
echo "dragged = null;";
echo "});";
echo "list.addEventListener('dragover', function(e){";
echo "e.preventDefault();";
echo "var over = e.target.closest('li');";
echo "if (!over || !dragged || over === dragged) return;";
echo "var rect = over.getBoundingClientRect();";
echo "var after = (e.clientY - rect.top) > (rect.height / 2);";
echo "list.insertBefore(dragged, after ? over.nextSibling : over);";
echo "});";
// Focus is returned to whatever opened the dialog. Without this, closing
// drops the caret at the top of the document and a keyboard user has to
// tab back through the whole table.
echo "var returnFocusTo = null;";
echo "function openModal(){";
echo "returnFocusTo = document.activeElement;";
echo "build();";
echo "modal.style.display = 'block';";
echo "panel.focus();";
echo "}";
echo "function closeModal(){";
echo "modal.style.display = 'none';";
echo "if (returnFocusTo && returnFocusTo.focus) returnFocusTo.focus();";
echo "returnFocusTo = null;";
echo "}";
echo "btn.addEventListener('click', function(){";
echo "clearError();";
echo "var n = document.querySelectorAll('.wpbr-row-check:checked').length;";
echo "if (n < 2) { showError(L.needTwo); return; }";
echo "openModal();";
echo "});";
echo "document.getElementById('wpbr_combine_cancel').addEventListener('click', closeModal);";
echo "modal.addEventListener('click', function(e){ if (e.target === modal) closeModal(); });";
// Escape closes, and Tab is kept inside the dialog: a modal a keyboard
// user can tab out of is not modal, and they end up operating a table
// they cannot see behind the overlay.
echo "modal.addEventListener('keydown', function(e){";
echo "if (e.key === 'Escape') { e.preventDefault(); closeModal(); return; }";
echo "if (e.key !== 'Tab') return;";
echo "var focusable = panel.querySelectorAll('button, [href], input, select, textarea, [tabindex]:not([tabindex=\"-1\"])');";
echo "if (!focusable.length) return;";
echo "var first = focusable[0], last = focusable[focusable.length - 1];";
echo "if (e.shiftKey && (document.activeElement === first || document.activeElement === panel)) { e.preventDefault(); last.focus(); }";
echo "else if (!e.shiftKey && document.activeElement === last) { e.preventDefault(); first.focus(); }";
echo "});";
echo "document.getElementById('wpbr_combine_go').addEventListener('click', function(){";
echo "var ids = Array.prototype.slice.call(list.children).map(function(li){ return li.dataset.id; });";
echo "orderField.value = ids.join(',');";
echo "var hidden = document.createElement('input');";
echo "hidden.type = 'hidden'; hidden.name = 'wpbr_sub'; hidden.value = 'combine_files';";
echo "form.appendChild(hidden);";
echo "form.submit();";
echo "});";
echo "})();";
wpbr_inline_close();
wpbr_print_review_js_l10n();
wpbr_inline_open('script');
echo "(function(){";
echo "var L = window.wpbrReviewL10n;";
echo "var checks = document.querySelectorAll('.wpbr-row-check');";
echo "var countLabel = document.getElementById('wpbr_selected_count');";
echo "var btnCombine = document.getElementById('wpbr_btn_combine');";
echo "var btnSkip = document.getElementById('wpbr_btn_skip');";
echo "var btnConfirmNew = document.getElementById('wpbr_btn_confirm_new');";
echo "var btnDelete = document.getElementById('wpbr_btn_delete');";
echo "var checkAll = document.getElementById('wpbr_check_all');";
echo "function refreshToolbar(){";
echo "var checked = Array.prototype.filter.call(checks, function(c){ return c.checked; });";
echo "var bulkActions = document.getElementById('wpbr_bulk_actions');";
echo "if (bulkActions) { bulkActions.style.display = checked.length > 0 ? 'flex' : 'none'; }";
echo "window.wpbrSetLive(countLabel, window.wpbrFmt(L.nSelected, checked.length));";
echo "if (btnCombine) {";
echo "var allPdf = checked.length > 0 && checked.every(function(c){ return c.dataset.ext === 'pdf'; });";
echo "btnCombine.disabled = !(checked.length >= 2 && allPdf);";
echo "var why = document.getElementById('wpbr_combine_reason');";
echo "var need = (btnCombine.disabled && checked.length > 0 && window.wpbrCombineL10n) ? window.wpbrCombineL10n.needTwo : '';";
echo "if (why && why.textContent !== need) { why.textContent = need; }";
echo "}";
echo "btnSkip.disabled = checked.length === 0;";
echo "if (btnConfirmNew) { btnConfirmNew.disabled = checked.length === 0; }";
echo "btnDelete.disabled = checked.length === 0;";
echo "}";
echo "checks.forEach(function(c){ c.addEventListener('change', refreshToolbar); });";
echo "if (checkAll) { checkAll.addEventListener('change', function(){";
echo "checks.forEach(function(c){";
echo "var row = c.closest('tr');";
echo "if (row && row.style.display === 'none') { c.checked = false; return; }";
echo "c.checked = checkAll.checked;";
echo "});";
echo "refreshToolbar();";
echo "}); }";
echo "refreshToolbar();";
echo "})();";
wpbr_inline_close();
wpbr_print_review_js_l10n();
wpbr_inline_open('script');
echo "var wpbrAllCandidates = ".wp_json_encode(array_map(function($c){ return array('id' => $c['id'], 'title' => $c['title'], 'permalink' => $c['permalink']); }, $candidates), JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT).";";
echo "var wpbrRenameNonce = '".esc_js(wp_create_nonce('wpbr_compute_rename'))."';";
echo "var wpbrConfirmNewAttachNonce = '".esc_js(wp_create_nonce('wpbr_confirm_new_attach'))."';";
echo "var wpbrBatchIdForRename = ".intval($batch_id).";";
echo "(function(){";
echo "var L = window.wpbrReviewL10n;";
echo "function wpbrCloseAllLists(except){";
echo "document.querySelectorAll('.wpbr-combo-list').forEach(function(l){ if (l !== except) l.style.display = 'none'; });";
echo "}";
echo "function wpbrTriggerRenameCompute(hiddenInput){";
echo "var row = hiddenInput.closest('tr');";
echo "if (!row) return;";
echo "var renameInput = row.querySelector('.wpbr-rename-input');";
echo "if (!renameInput) return;";
echo "var combo = hiddenInput.closest('.wpbr-combobox');";
echo "var textInput = combo ? combo.querySelector('.wpbr-combo-input') : null;";
echo "var filename = textInput ? textInput.dataset.filename : '';";
echo "var postId = hiddenInput.value;";
echo "if (!postId) return;";
echo "var templateInput = document.getElementById('wpbr_rename_template');";
echo "var template = templateInput ? templateInput.value : '';";
echo "var body = 'action=wpbr_compute_rename' +";
echo "'&nonce=' + encodeURIComponent(wpbrRenameNonce) +";
echo "'&batch_id=' + encodeURIComponent(wpbrBatchIdForRename) +";
echo "'&post_id=' + encodeURIComponent(postId) +";
echo "'&original_filename=' + encodeURIComponent(filename) +";
echo "'&template=' + encodeURIComponent(template);";
echo "fetch(ajaxurl, {method:'POST', headers:{'Content-Type':'application/x-www-form-urlencoded'}, body: body})";
echo ".then(function(r){ return r.json(); })";
echo ".then(function(resp){";
echo "if (!resp.success) return;";
echo "if (resp.data.rename_to) { renameInput.value = resp.data.rename_to; }";
echo "var cell = renameInput.parentNode;";
echo "var oldBadge = cell.querySelector('.wpbr-new-attach-badge');";
echo "if (oldBadge) oldBadge.remove();";
echo "var oldHint = cell.querySelector('.wpbr-rename-hint');";
echo "if (oldHint) oldHint.remove();";
echo "if (resp.data.has_existing_file) {";
echo "renameInput.style.display = '';";
echo "if (row) { row.dataset.needsAttach = '0'; }";
echo "} else {";
echo "renameInput.style.display = 'none';";
echo "if (row) { row.dataset.needsAttach = '1'; }";
echo "var badge = document.createElement('div');";
echo "badge.className = 'wpbr-new-attach-badge';";
echo "badge.style.fontSize = '12px';";
echo "badge.style.color = '#b32d2e';";
echo "badge.textContent = L.noExistingFile + ' \u2014 ';";
echo "var btn2 = document.createElement('button');";
echo "btn2.type = 'button';";
echo "btn2.className = 'button button-small wpbr-confirm-new-attach';";
echo "btn2.dataset.itemId = row ? row.dataset.itemId : '';";
echo "btn2.textContent = L.confirmAttach;";
echo "badge.appendChild(btn2);";
echo "cell.appendChild(badge);";
echo "}";
echo "});";
echo "}";
echo "document.addEventListener('input', function(e){";
echo "if (!e.target.classList.contains('wpbr-combo-input')) return;";
echo "var input = e.target;";
echo "var combo = input.closest('.wpbr-combobox');";
echo "var list = combo.querySelector('.wpbr-combo-list');";
echo "var term = input.value.trim().toLowerCase();";
echo "list.innerHTML = '';";
echo "if (!term) { list.style.display = 'none'; return; }";
echo "var matches = wpbrAllCandidates.filter(function(c){ return c.title.toLowerCase().indexOf(term) !== -1; }).slice(0, 50);";
echo "if (!matches.length) {";
echo "var none = document.createElement('div');";
echo "none.textContent = L.noMatches;";
echo "none.style.padding = '6px 8px';";
echo "none.style.color = '#787c82';";
echo "list.appendChild(none);";
echo "list.style.display = 'block';";
echo "return;";
echo "}";
echo "matches.forEach(function(c){";
echo "var opt = document.createElement('div');";
echo "opt.textContent = c.title;";
echo "opt.dataset.id = c.id;";
echo "opt.dataset.title = c.title;";
echo "opt.dataset.permalink = c.permalink || '';";
echo "opt.style.padding = '6px 8px';";
echo "opt.style.cursor = 'pointer';";
echo "opt.addEventListener('mouseenter', function(){ opt.style.background = '#f0f0f1'; });";
echo "opt.addEventListener('mouseleave', function(){ opt.style.background = ''; });";
echo "list.appendChild(opt);";
echo "});";
echo "list.style.display = 'block';";
echo "wpbrCloseAllLists(list);";
echo "});";
echo "document.addEventListener('mousedown', function(e){";
echo "var picked = e.target.closest('.wpbr-combo-list > div[data-id]');";
echo "if (!picked) return;";
echo "var combo = picked.closest('.wpbr-combobox');";
echo "var textInput = combo.querySelector('.wpbr-combo-input');";
echo "var hiddenInput = combo.querySelector('.wpbr-combo-hidden');";
echo "var viewLink = combo.querySelector('.wpbr-view-post-icon');";
echo "textInput.value = picked.dataset.title;";
echo "hiddenInput.value = picked.dataset.id;";
echo "if (viewLink) {";
echo "if (picked.dataset.permalink) { viewLink.href = picked.dataset.permalink; viewLink.style.display = ''; }";
echo "else { viewLink.style.display = 'none'; }";
echo "}";
echo "picked.closest('.wpbr-combo-list').style.display = 'none';";
echo "var row = hiddenInput.closest('tr');";
echo "var statusSelect = row ? row.querySelector('.wpbr-status-select') : null;";
echo "if (statusSelect) { statusSelect.value = 'matched'; }";
echo "var dot = row ? row.querySelector('.wpbr-confidence-dot') : null;";
echo "if (dot) { dot.style.background = '#00a32a'; dot.title = L.setManually;";
// The dot is aria-hidden; its screen-reader companion carries the words.
echo "var srDot = dot.nextElementSibling;";
echo "if (srDot && srDot.classList.contains('screen-reader-text')) { srDot.textContent = L.setManually; var vis = srDot.nextElementSibling; if (vis && vis.classList.contains('wpbr-score-label')) { vis.textContent = L.setManually; } } }";
echo "if (row) { row.dataset.tier = 'high'; }";
echo "var jsonField = document.getElementById('wpbr_manual_picks_json');";
echo "if (jsonField && row && row.dataset.itemId) {";
echo "var picks = [];";
echo "try { picks = jsonField.value ? JSON.parse(jsonField.value) : []; } catch(err) { picks = []; }";
echo "if (picks.indexOf(row.dataset.itemId) === -1) { picks.push(row.dataset.itemId); }";
echo "jsonField.value = JSON.stringify(picks);";
echo "}";
echo "wpbrTriggerRenameCompute(hiddenInput);";
echo "});";
echo "document.addEventListener('focusout', function(e){";
echo "if (!e.target.classList.contains('wpbr-combo-input')) return;";
echo "var combo = e.target.closest('.wpbr-combobox');";
echo "var list = combo.querySelector('.wpbr-combo-list');";
echo "var hiddenInput = combo.querySelector('.wpbr-combo-hidden');";
echo "setTimeout(function(){";
echo "list.style.display = 'none';";
echo "if (e.target.value.trim() === '' && hiddenInput.value !== '') {";
echo "hiddenInput.value = '';";
echo "var viewLink = combo.querySelector('.wpbr-view-post-icon');";
echo "if (viewLink) { viewLink.style.display = 'none'; }";
echo "}";
echo "}, 200);";
echo "});";
echo "document.addEventListener('click', function(e){";
echo "if (!e.target.closest('.wpbr-combobox')) { wpbrCloseAllLists(); }";
echo "});";
echo "document.addEventListener('click', function(e){";
echo "if (!e.target.classList.contains('wpbr-confirm-new-attach')) return;";
echo "var btn = e.target;";
echo "var itemId = btn.dataset.itemId;";
echo "btn.disabled = true;";
echo "var body = 'action=wpbr_confirm_new_attach&nonce=' + encodeURIComponent(wpbrConfirmNewAttachNonce) + '&item_id=' + encodeURIComponent(itemId);";
echo "fetch(ajaxurl, {method:'POST', headers:{'Content-Type':'application/x-www-form-urlencoded'}, body: body})";
echo ".then(function(r){ return r.json(); })";
echo ".then(function(resp){";
echo "if (!resp.success) { btn.disabled = false; return; }";
echo "var row = btn.closest('tr');";
echo "var statusSelect = row ? row.querySelector('.wpbr-status-select') : null;";
echo "if (statusSelect) { statusSelect.value = 'confirmed_new_attach'; }";
echo "var renameInput = row ? row.querySelector('.wpbr-rename-input') : null;";
echo "if (renameInput) { renameInput.style.display = ''; }";
echo "var hiddenInput = row ? row.querySelector('.wpbr-combo-hidden') : null;";
echo "if (hiddenInput && hiddenInput.value && renameInput && !renameInput.value) { wpbrTriggerRenameCompute(hiddenInput); }";
echo "var badge = btn.closest('.wpbr-new-attach-badge');";
echo "if (row) { row.dataset.needsAttach = '0'; }";
echo "if (badge) {";
echo "badge.style.color = '#2271b1';";
echo "badge.style.transition = 'opacity .5s ease';";
echo "badge.textContent = '\u2713 ' + L.confirmedAttach;";
echo "setTimeout(function(){ badge.style.opacity = '0'; }, 3000);";
echo "setTimeout(function(){ if (badge.parentNode) { badge.parentNode.removeChild(badge); } }, 3600);";
echo "}";
echo "});";
echo "});";
echo "})();";
wpbr_inline_close();
// Last thing on the step, after the work rather than in front of it.
wpbr_render_pro_matching_cta();
}
function wpbr_resolve_destination($item, $batch) {
if (!$item->matched_post_id) return null;
// Not memoised. This reads post meta, and a run rewrites post meta as it
// goes: unsharing repoints a post, a rename repoints another. A cache keyed
// on the row - which is what it was keyed on, since the row does not change
// - kept answering with the destination the post had before it was
// repointed. A retry inside the same request then saw the old shared path,
// decided the file was still shared, and unshared a second time: another
// attachment created, and previous_meta_value overwritten with the URL from
// the first attempt, so the original was no longer recoverable.
//
// The saving was negligible - two calls per row, over meta WordPress has
// already cached - and the same mistake has now been made three times in
// this file (and once more in the sharing lookup). Reading the state
// each time is the rule here.
$meta_keys = wpbr_reference_locations($batch);
foreach (wpbr_reference_map($batch, $item->matched_post_id) as $mk => $val) {
if ($val) {
$resolved = wpbr_url_to_upload_path($val);
if ($resolved) {
return array(
'path' => $resolved,
// A host-managed reference is not stat-ed here: this runs for every row of a batch on every chunk, and a stat on a
// stream wrapper is a network call. The engine looks properly, once, when the row is processed.
'mode' => (wpbr_ref_is_stream_uri($resolved) || file_exists($resolved)) ? 'overwrite' : 'repair',
);
}
}
}
$desired = $item->rename_to ? $item->rename_to : $item->staged_filename;
$upload_dir = wp_upload_dir();
return array('path' => $upload_dir['path'] . '/' . sanitize_file_name($desired), 'mode' => 'new');
}
/**
* Which posts point at this file, through any of the batch's meta fields?
*
* Asked before overwriting anything, because a file referenced by a post the
* reader did not select is not this batch's to change: overwriting it edits
* that page too, and the reader is never told. Sharing inside the batch is a
* different matter and is handled by unsharing - there, every affected post is
* one the reader chose.
*
* The query narrows on meta_key, which is indexed, and then matches the
* filename. The path comparison afterwards is what decides: two files in
* different folders can share a basename, and one file can be stored as http,
* https or protocol-relative by different plugins, so the URL text is not
* comparable but the resolved path is.
*
* @param string[] $meta_keys The batch's configured meta fields.
* @param string $path An absolute path inside the uploads directory.
* @return array Post ID => the meta field it points through.
*/
function wpbr_posts_referencing_file($meta_keys, $path) {
global $wpdb;
if (!$path || !$meta_keys) return array();
// Deliberately not memoised. The answer depends on post meta, which a run
// changes as it goes - unsharing repoints a post, a rename repoints
// another - so a cache keyed on the question would hand back an answer
// about a site that has since moved on. That is the mistake a static in
// wpbr_destination_shared_with_another_post() once made, and it is
// worth one query per row not to repeat it on the path that decides
// whether to overwrite somebody's file.
// One query per field rather than one IN (...) over all of them: the list
// is as long as the batch has fields, so the statement would otherwise be
// written differently for each length. Each is answered from postmeta's
// meta_key index, which is how the single query was answered too.
$like = '%' . $wpdb->esc_like('/' . basename($path));
$found = array();
foreach (array_unique(array_map('strval', $meta_keys)) as $meta_key) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Core's postmeta has no API for the posts holding a file in any of these fields; deliberately not cached, because a run repoints posts as it goes and a stale answer decides whether to overwrite somebody's file.
$rows = $wpdb->get_results($wpdb->prepare(
"SELECT post_id, meta_key, meta_value FROM {$wpdb->postmeta}
WHERE meta_key = %s AND meta_value LIKE %s",
$meta_key,
$like
));
foreach ((array) $rows as $row) {
$resolved = wpbr_url_to_upload_path($row->meta_value);
if ($resolved && $resolved === $path) {
$found[(int) $row->post_id] = $row->meta_key;
}
}
}
return $found;
}
/**
* Posts outside this batch that also point at this file.
*
* "Outside the batch" means having no row here at all. A post with a row is one
* the reader selected, whatever state that row is in.
*
* @param string[] $meta_keys
* @param string $path
* @param int $mine The post this row is matched to, which is not a sharer.
* @param object[] $all_items Every row in the batch.
* @return array Post ID => the meta field it points through.
*/
function wpbr_outside_batch_sharers($meta_keys, $path, $mine, $all_items) {
$sharers = wpbr_posts_referencing_file($meta_keys, $path);
unset($sharers[(int) $mine]);
if (!$sharers) return array();
foreach ((array) $all_items as $row) {
if ($row->matched_post_id) {
unset($sharers[(int) $row->matched_post_id]);
}
}
return $sharers;
}
/**
* Name the posts sharing a file, for a refusal the reader can act on.
*
* Bounded at three plus a count: the point is to make the situation
* recognisable, and a run that refuses forty rows should not print forty
* lists.
*
* @param array $sharers
* @return string Plain text; the caller escapes it.
*/
function wpbr_describe_sharers($sharers) {
$names = array();
$shown = array_slice($sharers, 0, 3, true);
foreach ($shown as $post_id => $meta_key) {
$names[] = sprintf(
/* translators: 1: a post title, 2: its numeric ID, 3: a meta field name. */
__('"%1$s" (ID %2$s, field %3$s)', 'wpbr-bulk-replace'),
wpbr_clean_title(get_the_title($post_id)),
number_format_i18n($post_id),
$meta_key
);
}
$list = implode('; ', $names);
$extra = count($sharers) - count($shown);
if ($extra > 0) {
$list .= ' ' . sprintf(
/* translators: %s is a number of further posts not listed. */
_n('and %s other', 'and %s others', $extra, 'wpbr-bulk-replace'),
number_format_i18n($extra)
);
}
return $list;
}
/**
* Destination paths in this batch that more than one post is aiming at.
*
* Separate from the question below because the answer depends only on the
* batch, while the question is asked once per item. The caller processing a
* chunk computes this once and passes it in; anything asking about a single
* item can let the function below work it out.
*
* @param object $batch
* @param object[] $all_items Every row in the batch.
* @return array Destination path => true.
*/
function wpbr_shared_destination_paths($batch, $all_items) {
$by_path = array();
foreach ($all_items as $other) {
if (!in_array($other->status, array('matched', 'confirmed_new_attach'), true)) continue;
$d = wpbr_resolve_destination($other, $batch);
if (!$d) continue;
$by_path[$d['path']][$other->matched_post_id] = true;
}
$shared = array();
foreach ($by_path as $path => $posts) {
if (count($posts) > 1) $shared[$path] = true;
}
return $shared;
}
/**
* Would replacing this item's destination also change another post's page?
*
* Note the scope: sharing is detected among the rows of this batch. A post that
* references the same file but has no row here is not seen.
*
* The shared set is passed in rather than worked out here, because the caller
* asks this once per item and the set costs a scan of the whole batch. It used
* to be a function-level static, which made the answer for the first batch the
* answer for every batch the same process went on to see - correct in
* production only because each chunk is its own request, and wrong the moment
* anything called it twice.
*
* @param object $item
* @param object $batch
* @param array $shared_paths From wpbr_shared_destination_paths().
* @return bool
*/
function wpbr_destination_shared_with_another_post($item, $batch, $shared_paths) {
$mine = wpbr_resolve_destination($item, $batch);
if (!$mine || !in_array($mine['mode'], array('overwrite','repair'), true)) return false;
return isset($shared_paths[$mine['path']]);
}
function wpbr_detect_collisions($batch_id, $items, $batch) {
if (!$batch || !$batch->post_type || !$batch->meta_key_name) {
return array('blocking' => array(), 'auto' => array(), 'shared_paths' => array());
}
$eligible = array();
foreach ($items as $item) {
if (!in_array($item->status, array('matched', 'confirmed_new_attach'), true)) continue;
$eligible[] = $item;
}
$by_post = array();
$by_dest = array();
foreach ($eligible as $item) {
if ($item->matched_post_id) {
$by_post[$item->matched_post_id][] = $item;
}
$dest = wpbr_resolve_destination($item, $batch);
if ($dest) {
$by_dest[$dest['path']][] = $item;
}
}
$blocking = array();
$auto = array();
foreach ($by_post as $post_id => $group) {
if (count($group) > 1) {
$blocking[] = array(
'type' => 'same_post',
'key' => $post_id,
// Plain text, not markup: both callers escape it, because a
// post title is whatever an editor typed.
'label' => sprintf(
/* translators: 1: the singular label of a post type, e.g. "product", 2: the title of that post, 3: its numeric ID. */
__('These files are all matched to the same %1$s: "%2$s" (ID %3$s)', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type),
$group[0]->matched_post_title,
$post_id
),
'items' => $group,
);
}
}
foreach ($by_dest as $path => $group) {
if (count($group) < 2) continue;
$post_ids = array();
foreach ($group as $g) $post_ids[$g->matched_post_id] = true;
if (count($post_ids) <= 1) continue;
$auto[] = array(
'type' => 'shared_file',
'key' => $path,
'label' => sprintf(
/* translators: 1: the plural label of a post type, e.g. "products", 2: a filename. */
__('These %1$s currently share one file on the site (%2$s). Each will be given its own new file named after itself instead of overwriting the shared one.', 'wpbr-bulk-replace'),
wpbr_post_type_label_plural($batch->post_type),
basename($path)
),
'items' => $group,
);
}
// The shared-destination set falls out of $by_dest, which this function has
// already built. Returning it means the chunk processor resolves every
// item's destination once per chunk rather than twice - it needs both
// answers, and they come from the same pass.
$shared_paths = array();
foreach ($by_dest as $path => $group) {
$post_ids = array();
foreach ($group as $g) $post_ids[$g->matched_post_id] = true;
if (count($post_ids) > 1) $shared_paths[$path] = true;
}
return array('blocking' => $blocking, 'auto' => $auto, 'shared_paths' => $shared_paths);
}
function wpbr_render_collision_report($collisions, $batch_id, $batch = null) {
$post_type = $batch ? $batch->post_type : '';
$status_labels = wpbr_status_labels();
echo "
";
echo "
" . esc_html(sprintf(
/* translators: %s is a number of conflicts. */
_n('%s conflict must be resolved before replacing files',
'%s conflicts must be resolved before replacing files',
count($collisions), 'wpbr-bulk-replace'),
number_format_i18n(count($collisions))
)) . "
";
echo "
" . wp_kses_post(sprintf(
/* translators: 1: the singular label of a post type, e.g. "product", 2: the title of the Review step. */
__('More than one file is matched to the same %1$s, so they would overwrite each other. Fix each group below on the %2$s step (reassign to the correct one, or set the ones you do not want to process to Skip).', 'wpbr-bulk-replace'),
esc_html(wpbr_post_type_label($post_type)),
esc_html(wpbr_wizard_step_title('review'))
)) . "
";
}
/**
* Strings the Replace step's script writes into the page.
*
* The script is echoed inline rather than enqueued, so wp.i18n is not
* available to it: translations are resolved here and handed over as data.
*
* Counts only exist once the reader has made a selection, so anything counted
* travels as a singular/plural pair and the script picks one. That covers
* languages with two plural forms; languages with more fall back to the plural
* form, which is why the pairs stay short and never carry the whole sentence.
*
* The four actions each carry their own complete title, progress and
* completion sentences. They used to share one past-tense English verb that
* the script turned into a gerund with verb.replace(/ed$/,'ing'), which
* produces nothing usable outside English.
*/
/**
* Strings the Review step's scripts write into the page.
*
* Emitted once as a global because that step renders several separate script
* blocks that share this vocabulary; the alternative is the same strings
* duplicated in each.
*/
/**
* Small helpers both the Review and Replace steps' scripts use, emitted once.
*
* wpbrCfWrap builds a custom-filter field's box. It replaced six copies of
* wrap.innerHTML = '' + field + '...', which put a meta key
* straight into innerHTML: the keys come from whatever plugins wrote them, so
* that was a markup-injection path as well as duplication.
*/
/** Strings the combine dialog's script writes into the page. */
function wpbr_combine_js_l10n() {
return array(
'needTwo' => __('Select at least two PDFs to combine.', 'wpbr-bulk-replace'),
/* translators: %s is a filename. */
'moveUp' => __('Move %s up', 'wpbr-bulk-replace'),
/* translators: %s is a filename. */
'moveDown' => __('Move %s down', 'wpbr-bulk-replace'),
/* translators: 1: position number, 2: total number of files. */
'position' => __('Position %1$s of %2$s:', 'wpbr-bulk-replace'),
/* translators: 1: filename, 2: new position, 3: total number of files. */
'moved' => __('%1$s moved to position %2$s of %3$s', 'wpbr-bulk-replace'),
'atTop' => __('Already first.', 'wpbr-bulk-replace'),
'atBottom' => __('Already last.', 'wpbr-bulk-replace'),
/* translators: %s is a row id, used when a filename cannot be read from the row. */
'itemLabel' => __('item %s', 'wpbr-bulk-replace'),
);
}
/** Strings the upload step's script writes into the page. */
function wpbr_upload_js_l10n() {
return array(
'badResponse' => __('Bad server response', 'wpbr-bulk-replace'),
'networkError' => __('Network error', 'wpbr-bulk-replace'),
/* translators: 1: a percentage, 2: how much has been uploaded, 3: the total size. */
'progress' => __('%1$s%% (%2$s of %3$s)', 'wpbr-bulk-replace'),
/* translators: %s is a size in megabytes. */
'mb' => __('%s MB', 'wpbr-bulk-replace'),
/* translators: %s is a size in kilobytes. */
'kb' => __('%s KB', 'wpbr-bulk-replace'),
/* translators: %s is a size in bytes. */
'bytes' => __('%s B', 'wpbr-bulk-replace'),
/* translators: %s is a filename. */
'uploaded' => __('%s — uploaded', 'wpbr-bulk-replace'),
/* translators: 1: a filename, 2: what the server said went wrong. */
'uploadFailed' => __('%1$s — ERROR: %2$s', 'wpbr-bulk-replace'),
'allComplete' => __('All uploads complete.', 'wpbr-bulk-replace'),
'failedOne' => __('The file could not be uploaded:', 'wpbr-bulk-replace'),
/* translators: 1: how many files failed, 2: how many were being uploaded. */
'failedSome' => __('%1$s of %2$s files could not be uploaded:', 'wpbr-bulk-replace'),
'continueLabel' => __('Continue', 'wpbr-bulk-replace'),
);
}
/** Strings the meta-field chip editor's script writes into the page. */
function wpbr_meta_js_l10n() {
return array(
'needOne' => __('Add at least one field. Pick one from the list and press Add field, or type a meta field name and press Enter.', 'wpbr-bulk-replace'),
/* translators: %s is a number of characters. */
'tooLong' => __('Those field names are too long to save together. The names can be at most %s characters in all, commas included. Remove one, or use a shorter name.', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'remove' => __('Remove %s', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'moveUp' => __('Move %s earlier', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'moveDown' => __('Move %s later', 'wpbr-bulk-replace'),
/* translators: 1: field name, 2: position, 3: total. */
'added' => __('%1$s added at position %2$s of %3$s', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'removed' => __('%s removed', 'wpbr-bulk-replace'),
/* translators: 1: field name, 2: new position, 3: total. */
'moved' => __('%1$s moved to position %2$s of %3$s', 'wpbr-bulk-replace'),
'atTop' => __('Already first.', 'wpbr-bulk-replace'),
'atBottom' => __('Already last.', 'wpbr-bulk-replace'),
// THE SAME MSGID AS `wpbr_reference_choice_label()` USES, deliberately.
// A field added by the picker and the same field read back off a saved
// batch must read identically, or reloading the screen looks like it
// changed something.
/* translators: 1: field name, 2: what the position is called, e.g. Row, 3: the position. */
'indexed' => __('%1$s (%2$s %3$s)', 'wpbr-bulk-replace'),
/* translators: %s is what the position is called, e.g. Row. */
'needIndex' => __('Enter which %s this file is in. Counting starts at 1.', 'wpbr-bulk-replace'),
);
}
/** Strings the Review step's scripts write into the page. */
function wpbr_review_js_l10n() {
return array(
'showRename' => __('Bulk Rename', 'wpbr-bulk-replace'),
'hideRename' => __('Hide Bulk Rename', 'wpbr-bulk-replace'),
'showFilter' => __('Custom Filter', 'wpbr-bulk-replace'),
'hideFilter' => __('Hide Custom Filter', 'wpbr-bulk-replace'),
'loading' => __('loading…', 'wpbr-bulk-replace'),
'noValues' => __('no usable values', 'wpbr-bulk-replace'),
'anyValue' => __('-- any --', 'wpbr-bulk-replace'),
'noMatches' => __('No matches', 'wpbr-bulk-replace'),
'noExistingFile' => __('No existing file', 'wpbr-bulk-replace'),
'confirmAttach' => __('Confirm new attachment', 'wpbr-bulk-replace'),
'confirmedAttach'=> __('Confirmed — will create new attachment', 'wpbr-bulk-replace'),
'setManually' => __('Set manually', 'wpbr-bulk-replace'),
/* translators: 1: how many rows are visible, 2: how many there are in total. */
'showingOf' => __('showing %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: 1: the current page number, 2: how many pages there are, 3: how many rows match the current filters. */
'pageOf' => __('Page %1$s of %2$s (%3$s rows)', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'filterByField' => __('Filter by %s', 'wpbr-bulk-replace'),
/* translators: %s is a number of selected rows. */
'nSelected' => __('%s selected', 'wpbr-bulk-replace'),
);
}
function wpbr_print_js_helpers() {
static $printed = false;
if ($printed) return;
$printed = true;
wpbr_inline_open('script');
echo "(function(){";
wpbr_js_fmt_helper();
echo "window.wpbrFmt = fmt;";
// Live regions are rewritten with the same words on every refresh (a filter change that leaves the count as it was);
// a screen reader can announce that again. Write only when the words are different.
echo "window.wpbrSetLive = function(el, text){ if (el && el.textContent !== text) { el.textContent = text; } };";
echo "})();";
echo "window.wpbrCfWrap = function(wrap, field, note){";
echo "wrap.textContent = '';";
echo "var strong = document.createElement('strong'); strong.textContent = field;";
echo "wrap.appendChild(strong);";
echo "wrap.appendChild(document.createElement('br'));";
echo "if (note) { var em = document.createElement('em'); em.textContent = note; wrap.appendChild(em); }";
echo "};";
wpbr_inline_close();
}
function wpbr_print_review_js_l10n() {
static $printed = false;
if ($printed) return;
$printed = true;
wpbr_print_js_helpers();
wpbr_inline_open('script');
echo "window.wpbrReviewL10n = " . wp_json_encode(wpbr_review_js_l10n(), JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ";";
wpbr_inline_close();
}
function wpbr_replace_js_l10n() {
return array(
'noneSelected' => __('none selected', 'wpbr-bulk-replace'),
'selectFirst' => __('Select one or more rows to enable these actions.', 'wpbr-bulk-replace'),
/* translators: 1: how many rows are visible, 2: how many there are in total. */
'showingOf' => __('showing %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: %s is a number of selected rows. */
'nSelected' => __('%s selected', 'wpbr-bulk-replace'),
'showDetails' => __('Show details', 'wpbr-bulk-replace'),
'hideDetails' => __('Hide details', 'wpbr-bulk-replace'),
'leaveWarning' => __('A run is in progress. Files already done are saved, but the rest will stop.', 'wpbr-bulk-replace'),
'requestFailed'=> __('Request failed', 'wpbr-bulk-replace'),
'networkError' => __('Network error', 'wpbr-bulk-replace'),
'resultDone' => __('done', 'wpbr-bulk-replace'),
'resultFailed' => __('failed', 'wpbr-bulk-replace'),
'resultSkipped'=> __('skipped', 'wpbr-bulk-replace'),
/* translators: 1: a filename, 2: what happened to that file. */
'currentFile' => __('%1$s — %2$s', 'wpbr-bulk-replace'),
/* translators: %s is a whole number of minutes. */
'etaMinuteOne' => __(' — about %s minute left', 'wpbr-bulk-replace'),
/* translators: %s is a whole number of minutes. */
'etaMinutesMany'=> __(' — about %s minutes left', 'wpbr-bulk-replace'),
/* translators: %s is a number of seconds. */
'etaSecondOne' => __(' — about %s second left', 'wpbr-bulk-replace'),
/* translators: %s is a number of seconds. */
'etaSecondsMany'=> __(' — about %s seconds left', 'wpbr-bulk-replace'),
/* translators: 1: how many rows will be skipped, 2: how many were selected. */
'skipNoteOne' => __('%1$s of the %2$s selected will be left alone — it is not in a suitable state for this action.', 'wpbr-bulk-replace'),
/* translators: 1: how many rows will be skipped, 2: how many were selected. */
'skipNoteMany' => __('%1$s of the %2$s selected will be left alone — they are not in a suitable state for this action.', 'wpbr-bulk-replace'),
'buttons' => array(
'run' => array(
'label' => __('Backup & Replace', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'labelN' => __('Backup & Replace (%s)', 'wpbr-bulk-replace'),
/* translators: 1: how many of the selection this action applies to, 2: how many were selected. */
'hint' => __('%1$s of the %2$s selected have not been processed yet', 'wpbr-bulk-replace'),
'hintNone' => __('None of the selected rows are waiting to be processed', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleOne' => __('Backing up and replacing %s file', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleMany' => __('Backing up and replacing %s files', 'wpbr-bulk-replace'),
/* translators: 1: how many are done, 2: how many in total. */
'progress' => __('Replaced %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: 1: how many were done, 2: how many were attempted. */
'complete' => __('Replacing complete (%1$s of %2$s). Reloading…', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'confirmOne' => __('Back up and replace %s file?', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'confirmMany' => __('Back up and replace %s files?', 'wpbr-bulk-replace'),
),
'roll' => array(
'label' => __('Roll Back', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'labelN' => __('Roll Back (%s)', 'wpbr-bulk-replace'),
/* translators: 1: how many of the selection this action applies to, 2: how many were selected. */
'hint' => __('%1$s of the %2$s selected can be rolled back', 'wpbr-bulk-replace'),
'hintNone' => __('None of the selected rows can be rolled back', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleOne' => __('Rolling back %s file', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleMany' => __('Rolling back %s files', 'wpbr-bulk-replace'),
/* translators: 1: how many are done, 2: how many in total. */
'progress' => __('Rolled back %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: 1: how many were done, 2: how many were attempted. */
'complete' => __('Roll back complete (%1$s of %2$s). Reloading…', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'confirmOne' => __('Roll back %s file?', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'confirmMany' => __('Roll back %s files?', 'wpbr-bulk-replace'),
'confirmNote' => __('Previous files are restored from backup, and newly created attachments are deleted.', 'wpbr-bulk-replace'),
),
'verify' => array(
'label' => __('Mark Verified', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'labelN' => __('Mark Verified (%s)', 'wpbr-bulk-replace'),
/* translators: 1: how many of the selection this action applies to, 2: how many were selected. */
'hint' => __('%1$s of the %2$s selected can be marked verified', 'wpbr-bulk-replace'),
'hintNone' => __('None of the selected rows are processed and unverified', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleOne' => __('Marking %s file verified', 'wpbr-bulk-replace'),
/* translators: %s is a number of files. */
'titleMany' => __('Marking %s files verified', 'wpbr-bulk-replace'),
/* translators: 1: how many are done, 2: how many in total. */
'progress' => __('Marked %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: 1: how many were done, 2: how many were attempted. */
'complete' => __('Marking complete (%1$s of %2$s). Reloading…', 'wpbr-bulk-replace'),
),
'delete' => array(
'label' => __('Delete Backups', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'labelN' => __('Delete Backups (%s)', 'wpbr-bulk-replace'),
/* translators: 1: how many of the selection this action applies to, 2: how many were selected. */
'hint' => __('%1$s of the %2$s selected are verified and still have a backup', 'wpbr-bulk-replace'),
'hintNone' => __('Mark rows verified before deleting their backups', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'titleOne' => __('Deleting the backup for %s row', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'titleMany' => __('Deleting backups for %s rows', 'wpbr-bulk-replace'),
/* translators: 1: how many are done, 2: how many in total. */
'progress' => __('Cleaned up %1$s of %2$s', 'wpbr-bulk-replace'),
/* translators: 1: how many were done, 2: how many were attempted. */
'complete' => __('Cleanup complete (%1$s of %2$s). Reloading…', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'confirmOne' => __('Delete the backup for %s row?', 'wpbr-bulk-replace'),
/* translators: %s is a number of rows. */
'confirmMany' => __('Delete backups for %s rows?', 'wpbr-bulk-replace'),
'confirmNote' => __('This cannot be undone, and those rows can no longer be rolled back afterwards.', 'wpbr-bulk-replace'),
),
),
'customFilter' => array(
'show' => __('Custom Filter', 'wpbr-bulk-replace'),
'hide' => __('Hide Custom Filter', 'wpbr-bulk-replace'),
'loading' => __('loading…', 'wpbr-bulk-replace'),
'noValues'=> __('no usable values', 'wpbr-bulk-replace'),
'any' => __('-- any --', 'wpbr-bulk-replace'),
/* translators: %s is a meta field name. */
'filterBy'=> __('Filter by %s', 'wpbr-bulk-replace'),
),
);
}
function wpbr_render_step_replace($batch_id, $eligible_count, $items, $batch) {
echo "
";
wpbr_help_link_echo('core.batches.run', __('What happens when you run this', 'wpbr-bulk-replace'));
if (!$batch->post_type || !$batch->meta_key_name) {
echo "
" . esc_html__('Set the post type and meta field on the Match step first.', 'wpbr-bulk-replace') . "
";
return;
}
$collisions = wpbr_detect_collisions($batch_id, $items, $batch);
if ($collisions['blocking']) {
wpbr_render_collision_report($collisions['blocking'], $batch_id, $batch);
return;
}
$rows = array();
foreach ($items as $it) {
if (in_array($it->status, array('matched','confirmed_new_attach','replaced','verified','cleaned_up'), true)) {
$rows[] = $it;
}
}
if (!$rows) {
echo "
" . esc_html(sprintf(
/* translators: %s is the title of the Review step, e.g. "Review & Resolve". */
__('Nothing here yet. Resolve some matches on the %s step first.', 'wpbr-bulk-replace'),
wpbr_wizard_step_title('review')
)) . "
" . wp_kses_post(__('Select rows and choose an action. Start with one or two to confirm the result on the live site before doing the rest — there is no penalty for running this several times. Everything processed keeps a backup until you delete it.', 'wpbr-bulk-replace')) . "
" . esc_html(sprintf(
/* translators: 1: a number of groups, 2: the plural label of a post type, e.g. "products". */
_n('%1$s set of %2$s shares a file.', '%1$s sets of %2$s share a file.', $auto_count, 'wpbr-bulk-replace'),
number_format_i18n($auto_count),
wpbr_post_type_label_plural($batch->post_type)
)) . " " . esc_html__('Each will get its own new file named after itself rather than overwriting the shared one.', 'wpbr-bulk-replace') . " ";
wpbr_help_link_echo('error.shared-file-outside-batch', __('What happens if a page outside this batch shares it', 'wpbr-bulk-replace'));
echo "
" . wp_kses_post(__('Narrow by the matched post’s own fields — for example process one category, or one supplier, at a time.', 'wpbr-bulk-replace')) . "
";
echo "";
echo "";
echo "";
echo "";
echo "";
echo "" . esc_html__('none selected', 'wpbr-bulk-replace') . "";
// Why the disabled buttons above are disabled: the tooltip text, visible. Filled by refreshButtons().
echo "";
echo "
";
echo "
";
// A run that cannot continue says so here, in words, where it can be seen and is announced. It is always rendered (empty
// until needed): an alert that is created or unhidden at the moment it speaks is announced less reliably than one that
// is already on the page. The details are still in the log below.
echo "";
echo "
";
echo "" . esc_html__('Working…', 'wpbr-bulk-replace') . "";
// The bar is drawn with two
s rather than
";
// Deliberately not a live region: it changes once per row, and announcing
// every filename would talk over the progress label that carries the count.
// One line that ends in an ellipsis when the file name or the reason is long; wpbr_truncate_support_print() adds a "⋯" button when it is cut.
echo "
";
echo "";
echo "
";
echo "
";
// ---------- table ----------
echo "
";
echo "
";
/* translators: %s is the singular label of the post type being matched. */
$matched_col = sprintf(__('Matched %s', 'wpbr-bulk-replace'), wpbr_post_type_label($batch->post_type));
echo "
";
if ($is_ready) {
if ($mode === 'overwrite') {
$want = $it->rename_to ? sanitize_file_name($it->rename_to) : '';
if ($want && $dest && $want !== basename($dest['path'])) {
$rename_note = sprintf(
/* translators: %s is the singular label of a post type, e.g. "product". */
__('A different filename was entered, so a new file is written under that name and the %s is pointed at it. The old file is left in place.', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type)
);
echo "" . esc_html__('Replace & rename', 'wpbr-bulk-replace') . "";
} else {
echo "" . esc_html__('Replace file', 'wpbr-bulk-replace') . "";
}
} elseif ($mode === 'repair') {
$repair_note = sprintf(
/* translators: %s is the singular label of a post type, e.g. "product". */
__('This %s links to this file but it is not on the server. Processing writes it there and makes sure it has a Media Library entry.', 'wpbr-bulk-replace'),
wpbr_post_type_label($batch->post_type)
);
echo "" . esc_html__('Add missing file', 'wpbr-bulk-replace') . "";
} else {
echo "" . esc_html__('New attachment', 'wpbr-bulk-replace') . "";
}
} elseif ($created) {
echo "✓ " . esc_html__('Attached', 'wpbr-bulk-replace') . "";
} else {
echo "✓ " . esc_html__('Replaced', 'wpbr-bulk-replace') . "";
}
echo "
" . wp_kses_post(__('At least one meta field is required. Type the field name into the box, or pick one from the list, then press Run Matching.', 'wpbr-bulk-replace')) . "
";
return;
}
if ('too_long' === $problem) {
/* translators: %d is a number of characters. */
echo "
" . wp_kses_post(sprintf(__('Those field names are too long to save together. The names can be at most %d characters in all, commas included. Remove one, or use a shorter name, then press Run Matching.', 'wpbr-bulk-replace'), wpbr_meta_keys_max_length())) . "
";
return;
}
wpbr_set_batch_matching_config($batch_id, $post_type, $meta_keys);
wpbr_run_matching_core($batch_id, $post_type, $meta_keys);
}
function wpbr_rerun_matching_from_batch($batch_id) {
global $wpdb;
$batch = wpbr_get_batch($batch_id);
if (!$batch || !$batch->post_type || !$batch->meta_key_name) {
echo "
" . wp_kses_post(__('This batch has no matching configuration yet — set the post type and meta field on the Match step first.', 'wpbr-bulk-replace')) . "
";
return;
}
wpbr_run_matching_core($batch_id, $batch->post_type, wpbr_split_meta_keys($batch->meta_key_name));
}
function wpbr_run_matching_core($batch_id, $post_type, $meta_keys) {
$counts = wpbr_match_batch_items($batch_id, $post_type, $meta_keys);
$matched_count = $counts['matched'];
$review_count = $counts['review'];
$learned_count = $counts['learned'];
$protected_count = $counts['protected'];
$msg = sprintf(
/* translators: 1: number of files matched above the confidence threshold, 2: number needing review. */
__('Matching complete: %1$s matched above threshold, %2$s need review.', 'wpbr-bulk-replace'),
number_format_i18n($matched_count),
number_format_i18n($review_count)
);
if ($learned_count > 0) {
$msg .= ' ' . sprintf(
/* translators: %s is a number of files. */
_n('%s matched from a remembered manual decision.', '%s matched from remembered manual decisions.', $learned_count, 'wpbr-bulk-replace'),
number_format_i18n($learned_count)
);
}
if ($protected_count > 0) {
$msg .= ' ' . sprintf(
/* translators: %s is a number of rows. */
_n('%s row left untouched because you had already set it by hand.', '%s rows left untouched because you had already set them by hand.', $protected_count, 'wpbr-bulk-replace'),
number_format_i18n($protected_count)
);
}
$msg .= ' ' . __('Skipped and already-replaced items were also left untouched.', 'wpbr-bulk-replace');
echo "
".esc_html($msg)."
";
}
function wpbr_export_batch_csv($batch_id) {
global $wpdb;
$batch = wpbr_get_batch($batch_id);
$items = wpbr_get_batch_items($batch_id);
$filename_base = $batch ? sanitize_file_name($batch->label) : ('batch-' . $batch_id);
if (!$filename_base) $filename_base = 'batch-' . $batch_id;
header('Content-Type: text/csv');
header('Content-Disposition: attachment; filename='.$filename_base.'.csv');
$out = fopen('php://output', 'w');
fputcsv($out, array('staged_filename','matched_post_id','matched_post_title','confidence_score','match_kind','rename_to','status','notes'), ',', '"', WPBR_CSV_ESCAPE);
foreach ($items as $i) {
fputcsv($out, array_map('wpbr_csv_safe', array(
$i->staged_filename, $i->matched_post_id, $i->matched_post_title,
$i->confidence_score, (isset($i->match_kind) ? $i->match_kind : ''), $i->rename_to, $i->status, $i->notes,
)), ',', '"', WPBR_CSV_ESCAPE);
}
fclose($out); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fclose -- Closes php://output, the response stream; WP_Filesystem works on files on disk and has no handle to hand back.
}
function wpbr_run_shell($cmd) {
if (!function_exists('exec')) return null;
$disabled = array_map('trim', explode(',', (string) ini_get('disable_functions')));
if (in_array('exec', $disabled, true)) return null;
$output = array();
$return_var = null;
@exec($cmd . ' 2>&1', $output, $return_var);
return array('output' => implode("\n", $output), 'return_var' => $return_var);
}
/**
* " did not produce an output file."
*
* The library name is a product name, so it is a placeholder rather than part
* of the translated sentence.
*/
function wpbr_merge_no_output_error($library) {
return sprintf(
/* translators: %s is the name of a PDF library, e.g. "FPDI". */
__('%s did not produce an output file', 'wpbr-bulk-replace'),
$library
);
}
/** " error: ". */
function wpbr_merge_backend_error($library, $message) {
return sprintf(
/* translators: 1: the name of a PDF library, e.g. "FPDI", 2: the error text that library reported. */
__('%1$s error: %2$s', 'wpbr-bulk-replace'),
$library,
$message
);
}
/**
* The smallest PDF that is genuinely parseable, for asking a backend whether
* it can read one at all.
*
* One empty 9x9 page with a correct cross-reference table - 325 bytes. It has
* to be real, because the question being asked is whether ImageMagick's PDF
* delegate runs and whether its security policy permits PDF, and neither can
* be answered by looking at a version string.
*/
function wpbr_probe_pdf() {
$objects = array(
"1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n",
"2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n",
"3 0 obj\n<< /Type /Page /Parent 2 0 R /MediaBox [0 0 9 9] >>\nendobj\n",
);
$pdf = "%PDF-1.4\n";
$offsets = array();
foreach ($objects as $object) {
$offsets[] = strlen($pdf);
$pdf .= $object;
}
$xref = strlen($pdf);
$pdf .= "xref\n0 4\n0000000000 65535 f \n";
foreach ($offsets as $offset) {
$pdf .= sprintf("%010d 00000 n \n", $offset);
}
$pdf .= "trailer\n<< /Size 4 /Root 1 0 R >>\nstartxref\n".$xref."\n%%EOF\n";
return $pdf;
}
/**
* Can this server merge PDFs, by which method, and at what cost to the file?
*
* Every backend is asked before anything is merged, so the Settings screen can
* say what will happen rather than the reader finding out from a failure. The
* answers carry a `fidelity` because the methods are not interchangeable: four
* of them combine the page objects, and one rebuilds the pages as images.
*
* @return array Keyed by method id, in the order they are tried.
*/
function wpbr_pdf_merge_backends() {
$backends = array();
// --- FPDI, bundled with the plugin ------------------------------------
wpbr_load_vendor_autoload();
$backends['fpdi'] = array(
'label' => 'FPDI',
'fidelity' => 'structural',
'available' => class_exists('setasign\\Fpdi\\Fpdi'),
'detail' => class_exists('setasign\\Fpdi\\Fpdi')
? __('Bundled with the plugin, so it is always here. Keeps text, fonts and links. Cannot read PDFs that use compressed object streams, which most recent software produces - those need Ghostscript or pdftk.', 'wpbr-bulk-replace')
: __('The bundled copy could not be loaded, which should not happen in a released build.', 'wpbr-bulk-replace'),
'remedy' => '',
);
// --- libmergepdf, only if a site has installed it ----------------------
$backends['libmergepdf'] = array(
'label' => 'libmergepdf',
'fidelity' => 'structural',
'available' => class_exists('LibMergePDF\\Merger'),
'detail' => class_exists('LibMergePDF\\Merger')
? __('Found. Built on FPDI, so it reads the same PDFs FPDI can and fails on the same ones.', 'wpbr-bulk-replace')
: __('Not installed. Optional - it uses the same parser as FPDI, so it does not read anything FPDI cannot.', 'wpbr-bulk-replace'),
'remedy' => '',
);
// --- pdftk -------------------------------------------------------------
$pdftk = wpbr_run_shell('pdftk --version');
$backends['pdftk'] = array(
'label' => 'pdftk',
'fidelity' => 'structural',
'available' => ($pdftk !== null && $pdftk['return_var'] === 0),
'detail' => ($pdftk === null)
? __('Cannot be checked: PHP is not allowed to run external commands on this server, so neither pdftk nor Ghostscript can be used.', 'wpbr-bulk-replace')
: (($pdftk['return_var'] === 0)
? __('Installed. Concatenates pages as they are, which is the most faithful of these methods, and reads recent PDFs.', 'wpbr-bulk-replace')
: __('Not installed.', 'wpbr-bulk-replace')),
'remedy' => ($pdftk !== null && $pdftk['return_var'] !== 0)
? __('Ask your host to install pdftk (the pdftk-java package on most systems).', 'wpbr-bulk-replace')
: '',
);
// --- Ghostscript -------------------------------------------------------
$gs = wpbr_run_shell('gs --version');
$backends['ghostscript'] = array(
'label' => 'Ghostscript',
'fidelity' => 'structural',
'available' => ($gs !== null && $gs['return_var'] === 0),
'detail' => ($gs === null)
? __('Cannot be checked: PHP is not allowed to run external commands on this server.', 'wpbr-bulk-replace')
: (($gs['return_var'] === 0)
? sprintf(
/* translators: %s is a version number reported by Ghostscript. */
__('Installed, version %s. Reads recent PDFs and keeps text and fonts. It rewrites the file rather than copying pages, so some form fields and annotations may not survive.', 'wpbr-bulk-replace'),
trim((string) $gs['output'])
)
: __('Not installed.', 'wpbr-bulk-replace')),
'remedy' => ($gs !== null && $gs['return_var'] !== 0)
? __('Ask your host to install Ghostscript (the ghostscript package on most systems). This is the usual fix when recent PDFs will not combine.', 'wpbr-bulk-replace')
: '',
);
// --- Imagick, last, and asked properly ---------------------------------
$backends['imagick'] = wpbr_imagick_pdf_status();
return $backends;
}
/**
* Three separate questions about Imagick, which the class alone cannot answer.
*
* Whether the PHP extension is loaded, whether ImageMagick was built with a
* PDF coder, and whether its security policy permits reading one, are
* different things. Most distributions ship a policy.xml that denies PDF -
* added after the 2016 ImageTragick reports and the Ghostscript sandbox
* escapes that followed - so an extension that is present and a merge that
* works are a long way apart. The only reliable answer is to hand it a PDF.
*
* @return array
*/
function wpbr_imagick_pdf_status() {
$raster_note = __('Rebuilds every page as a 150 DPI image, so the result has no selectable or searchable text, no embedded fonts, and no links, form fields or bookmarks. Line art becomes pixels and the file is typically many times larger. It is tried last, and only when nothing else on this server can do the job.', 'wpbr-bulk-replace');
if (!class_exists('Imagick')) {
return array(
'label' => 'Imagick', 'fidelity' => 'raster', 'available' => false,
'detail' => __('The PHP Imagick extension is not installed.', 'wpbr-bulk-replace'),
'remedy' => '',
);
}
try {
$imagick = new Imagick();
$formats = $imagick->queryFormats('PDF');
if (!in_array('PDF', (array) $formats, true)) {
return array(
'label' => 'Imagick', 'fidelity' => 'raster', 'available' => false,
'detail' => __('The PHP Imagick extension is installed, but the ImageMagick behind it was built without PDF support.', 'wpbr-bulk-replace'),
'remedy' => __('Nothing to change here. Install Ghostscript or pdftk instead - both keep the text, which this method would not.', 'wpbr-bulk-replace'),
);
}
$imagick->readImageBlob(wpbr_probe_pdf());
$imagick->clear();
} catch (Exception $e) {
$message = $e->getMessage();
// ImageMagick says "not authorized" or "security policy" when
// policy.xml denies the PDF coder, and complains about a delegate or a
// failed command when Ghostscript is missing behind it. The two need
// different things from the host, so they are reported differently.
$policy = (stripos($message, 'security policy') !== false || stripos($message, 'not authorized') !== false);
return array(
'label' => 'Imagick', 'fidelity' => 'raster', 'available' => false,
'detail' => $policy
? __('The PHP Imagick extension is installed and supports PDF, but this server\'s ImageMagick security policy blocks reading PDFs. That is a deliberate default on many hosts.', 'wpbr-bulk-replace')
: sprintf(
/* translators: %s is the error ImageMagick reported, quoted as the tool said it. */
__('The PHP Imagick extension is installed but could not read a PDF: %s', 'wpbr-bulk-replace'),
$message
),
'remedy' => $policy
? __('It can be re-enabled by removing the PDF line from ImageMagick\'s policy.xml, but there is usually no need: installing Ghostscript or pdftk gives a better result, because this method cannot keep the text.', 'wpbr-bulk-replace')
: __('Usually means Ghostscript is missing, which ImageMagick needs in order to read PDFs. Installing Ghostscript fixes this and also gives a better method than this one.', 'wpbr-bulk-replace'),
);
}
return array(
'label' => 'Imagick', 'fidelity' => 'raster', 'available' => true,
'detail' => $raster_note,
'remedy' => '',
);
}
/**
* Is any method available that keeps the text?
*
* @return bool
*/
function wpbr_has_structural_pdf_merge() {
foreach (wpbr_pdf_merge_backends() as $backend) {
if ($backend['available'] && $backend['fidelity'] === 'structural') return true;
}
return false;
}
/**
* Combine PDFs with the best method this server has.
*
* Order matters, and it used to be wrong. Imagick was tried first, so on any
* server that had it every combine was rasterised - pages rebuilt as 150 DPI
* images - even when FPDI, Ghostscript or pdftk were sitting right there and
* would have kept the text. Measured on two one-page text PDFs: the Imagick
* output had no extractable text, no embedded fonts, four image XObjects and
* was 190,854 bytes; the Ghostscript output kept every word and was 2,908.
*
* So the four methods that combine the page objects come first, most faithful
* first, and the one that rebuilds them as pictures comes last - where it is a
* better answer than refusing, but only just, and the reader is told.
*/
function wpbr_merge_pdfs($input_paths, $output_path) {
// Bundled, no external dependency, keeps everything - but its free parser
// cannot read compressed object streams, which most recent software emits.
$fpdi_result = wpbr_merge_pdfs_fpdi($input_paths, $output_path);
if ($fpdi_result !== null && $fpdi_result['success']) return $fpdi_result;
$vendor_result = wpbr_merge_pdfs_vendor_library($input_paths, $output_path);
if ($vendor_result !== null && $vendor_result['success']) return $vendor_result;
$escaped_inputs = implode(' ', array_map('escapeshellarg', $input_paths));
$escaped_output = escapeshellarg($output_path);
// pdftk before Ghostscript: it concatenates the pages as they are, while
// Ghostscript rewrites the file, which can drop some form fields and
// annotations even though the text survives.
$pdftk_cmd = "pdftk ".$escaped_inputs." cat output ".$escaped_output;
$pdftk_result = wpbr_run_shell($pdftk_cmd);
if ($pdftk_result !== null && $pdftk_result['return_var'] === 0 && file_exists($output_path)) {
return array('success' => true, 'method' => 'pdftk', 'error' => null);
}
// -dSAFER because these are PDFs somebody else produced, and Ghostscript
// without it will follow instructions inside them that reach the
// filesystem. Versions from 9.50 assume it, older ones do not, and saying
// so costs nothing. -dPDFSETTINGS=/prepress stops it downsampling images
// that were fine as they were.
$gs_cmd = "gs -q -dNOPAUSE -dBATCH -dSAFER -dPDFSETTINGS=/prepress -sDEVICE=pdfwrite -sOutputFile=".$escaped_output." ".$escaped_inputs;
$gs_result = wpbr_run_shell($gs_cmd);
if ($gs_result !== null && $gs_result['return_var'] === 0 && file_exists($output_path)) {
return array('success' => true, 'method' => 'Ghostscript', 'error' => null);
}
// Last, because this one does not combine the pages - it photographs them.
$imagick_result = wpbr_merge_pdfs_imagick($input_paths, $output_path);
if ($imagick_result['success']) return $imagick_result;
$not_installed = __('not installed', 'wpbr-bulk-replace');
$err = sprintf(
/* translators: 1: what the FPDI attempt reported, 2: what the optional vendor library reported, 3: what the Imagick attempt reported. The library names are product names. */
__('No working PDF merge method found on this server. Tried, in order: FPDI (%1$s), libmergepdf (%2$s), pdftk, Ghostscript, and the PHP Imagick extension (%3$s). Installing Ghostscript is the usual fix, and it keeps the text. See Settings for what this server has.', 'wpbr-bulk-replace'),
$fpdi_result !== null ? $fpdi_result['error'] : $not_installed,
$vendor_result !== null ? $vendor_result['error'] : $not_installed,
$imagick_result['error']
);
// The two shell backends print their own diagnostics; those are the tools'
// own output, quoted rather than translated.
if ($gs_result !== null) $err .= ' gs: '.$gs_result['output'];
if ($pdftk_result !== null) $err .= ' pdftk: '.$pdftk_result['output'];
return array('success' => false, 'method' => null, 'error' => trim($err));
}
/**
* Load the plugin's Composer-installed libraries (FPDF and FPDI), once.
*
* The release zip carries them in vendor/, installed by Composer from a committed
* lock and copied in by the build, so nobody who installs the plugin needs
* Composer (docs/THIRD-PARTY.md). A development checkout gets the same
* vendor/autoload.php from `composer install`. Where it is missing the merge
* backends that depend on it report "not installed" and the others are tried.
*/
function wpbr_load_vendor_autoload() {
static $loaded = false;
if ($loaded) return;
$composer_autoload = WPBR_PLUGIN_DIR . 'vendor/autoload.php';
if (file_exists($composer_autoload)) {
require_once $composer_autoload;
}
$loaded = true;
}
function wpbr_merge_pdfs_fpdi($input_paths, $output_path) {
wpbr_load_vendor_autoload();
if (!class_exists('setasign\\Fpdi\\Fpdi')) return null;
try {
$fpdi_class = 'setasign\\Fpdi\\Fpdi';
$pdf = new $fpdi_class();
foreach ($input_paths as $path) {
$page_count = $pdf->setSourceFile($path);
for ($i = 1; $i <= $page_count; $i++) {
$tpl_id = $pdf->importPage($i);
$size = $pdf->getTemplateSize($tpl_id);
$pdf->AddPage($size['orientation'], array($size['width'], $size['height']));
$pdf->useTemplate($tpl_id);
}
}
$pdf->Output($output_path, 'F');
if (file_exists($output_path)) {
return array('success' => true, 'method' => 'FPDI', 'error' => null);
}
return array('success' => false, 'method' => null, 'error' => wpbr_merge_no_output_error('FPDI'));
} catch (Exception $e) {
return array('success' => false, 'method' => null, 'error' => wpbr_merge_backend_error('FPDI', $e->getMessage()));
}
}
/**
* Combine by photographing every page.
*
* Imagick::readImage() on a PDF runs it through ImageMagick's delegate and
* hands back a bitmap per page; setImageFormat('pdf') then wraps those bitmaps
* in a PDF container. The pages are images from that point on, so nothing that
* was not a picture survives: no selectable text, no fonts, no links, no form
* fields, no bookmarks, and line art at whatever the resolution below happens
* to be. This is the last method tried for that reason, and callers disclose
* it when it is what ran.
*/
function wpbr_merge_pdfs_imagick($input_paths, $output_path) {
if (!class_exists('Imagick')) {
return array('success' => false, 'method' => null, 'error' => __('Imagick class not available', 'wpbr-bulk-replace'));
}
try {
$combined = new Imagick();
foreach ($input_paths as $path) {
$pages = new Imagick();
$pages->setResolution(150, 150);
$pages->readImage($path);
foreach ($pages as $page) {
$combined->addImage($page->getImage());
}
}
$combined->setImageFormat('pdf');
$written = $combined->writeImages($output_path, true);
$combined->clear();
if ($written && file_exists($output_path)) {
return array('success' => true, 'method' => 'PHP Imagick', 'error' => null, 'lossy' => true);
}
return array('success' => false, 'method' => null, 'error' => wpbr_merge_no_output_error('Imagick'));
} catch (Exception $e) {
return array('success' => false, 'method' => null, 'error' => wpbr_merge_backend_error('Imagick', $e->getMessage()));
}
}
function wpbr_merge_pdfs_vendor_library($input_paths, $output_path) {
wpbr_load_vendor_autoload();
if (!class_exists('LibMergePDF\\Merger')) return null;
try {
$merger_class = 'LibMergePDF\\Merger';
$merger = new $merger_class();
foreach ($input_paths as $path) {
$merger->addFile($path);
}
file_put_contents($output_path, $merger->merge());
if (file_exists($output_path)) {
return array('success' => true, 'method' => 'libmergepdf', 'error' => null);
}
return array('success' => false, 'method' => null, 'error' => wpbr_merge_no_output_error('libmergepdf'));
} catch (Exception $e) {
return array('success' => false, 'method' => null, 'error' => wpbr_merge_backend_error('libmergepdf', $e->getMessage()));
}
}
function wpbr_longest_common_prefix($strings) {
if (empty($strings)) return '';
$prefix = $strings[0];
foreach ($strings as $s) {
while ($prefix !== '' && strpos($s, $prefix) !== 0) {
$prefix = substr($prefix, 0, -1);
}
if ($prefix === '') return '';
}
return $prefix;
}
function wpbr_derive_combined_filename($original_filenames) {
$names_no_ext = array_map(function($f) {
return preg_replace('/\.[a-z0-9]+$/i', '', $f);
}, $original_filenames);
$prefix = rtrim(wpbr_longest_common_prefix($names_no_ext));
$delims = array(' ', '-', '_', '(');
$last_delim = false;
for ($i = strlen($prefix) - 1; $i >= 0; $i--) {
if (in_array($prefix[$i], $delims, true)) {
$last_delim = $i;
break;
}
}
if ($last_delim !== false) {
$prefix = substr($prefix, 0, $last_delim);
}
$prefix = trim(rtrim($prefix, " -_("));
if (strlen($prefix) >= 8) {
$base = $prefix;
} else {
$base = implode('-', array_map('wpbr_filename_safe', $names_no_ext));
$base = substr($base, 0, 120);
}
return wpbr_filename_safe($base) . '.pdf';
}
/**
* Read the page order supplied by the reorder step.
*
* Every id is checked against the rows actually selected, so a tampered POST
* cannot pull in rows the user did not tick.
*
* @param string $raw Comma-separated item ids.
* @param int[] $selected_ids The rows genuinely selected.
* @return int[]
*/
function wpbr_parse_combine_order($raw, $selected_ids) {
$requested_order = array();
if ($raw === '' || $raw === null) return $requested_order;
$allowed = array_map('intval', (array) $selected_ids);
foreach (explode(',', (string) $raw) as $oid) {
$oid = (int) trim($oid);
if ($oid && in_array($oid, $allowed, true) && !in_array($oid, $requested_order, true)) {
$requested_order[] = $oid;
}
}
return $requested_order;
}
/**
* Put the rows into the requested page order.
*
* Without this the IN() query returns rows in whatever order the database
* chooses, which is not a sensible page order for a merged document. Rows not
* named in the order fall to the end rather than being dropped, so a partial
* order can never silently lose a page.
*
* @param object[] $items
* @param int[] $requested_order
* @return object[]
*/
function wpbr_apply_combine_order($items, $requested_order) {
if (!$requested_order) return $items;
$by_id = array();
foreach ($items as $it) $by_id[(int) $it->id] = $it;
$ordered = array();
foreach ($requested_order as $oid) {
if (isset($by_id[$oid])) { $ordered[] = $by_id[$oid]; unset($by_id[$oid]); }
}
foreach ($by_id as $leftover) $ordered[] = $leftover; // anything not listed goes last
return $ordered;
}
/**
* The notice shown when no merge method worked.
*
* `$error` is what the backends reported, quoted. It is not ours, and it is not
* safe: a library that is parsing a PDF quotes the part of the PDF it choked on,
* so a crafted file can put markup into the message (FPDI's "Unexpected data in
* xref table (%s)" is one). It is therefore escaped here, where it is printed,
* and nowhere earlier - escaping at the throw would double-escape at every other
* place the same text is shown. tests/integration/LibraryErrorTextTest.php puts
* a real hostile PDF through it.
*
* @param string $error The merge attempt's own diagnostic text.
*/
function wpbr_render_combine_failed($error) {
echo "
" . esc_html(sprintf(
/* translators: %s is the diagnostic text from the merge attempt. */
__('Combine failed: %s', 'wpbr-bulk-replace'),
$error
)) . " " . esc_html__('Tried the PHP Imagick extension, FPDI, a LibMergePDF-based vendor library, Ghostscript, and pdftk — none worked on this server. Ask your server admin which of these is available, or merge these files locally and re-upload the result as one file.', 'wpbr-bulk-replace') . "
";
}
function wpbr_handle_combine_files($batch_id, $selected_ids, $combine_order = '') {
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
$items_table = wpbr_table_items();
if (count($selected_ids) < 2) {
echo "
" . esc_html__('Select at least two files to combine.', 'wpbr-bulk-replace') . "
";
return;
}
// An explicit order can be supplied by the reorder step. Without it the
// IN() query returns rows in whatever order the database chooses, which
// is not a sensible page order for a merged document.
$requested_order = wpbr_parse_combine_order($combine_order, $selected_ids);
$items = wpbr_get_batch_items_in($batch_id, $selected_ids);
if (count($items) < 2) {
echo "
" . esc_html__('Could not find the selected rows.', 'wpbr-bulk-replace') . "
" . esc_html(sprintf(
/* translators: 1: a filename, 2: a file extension without the dot, e.g. "docx". */
__('Only PDF files can be combined — "%1$s" is a .%2$s file.', 'wpbr-bulk-replace'),
$item->staged_filename,
$ext
)) . "
";
return;
}
if (!file_exists($item->staged_path)) {
echo "
" . esc_html(sprintf(
/* translators: %s is a filename. */
__('File missing on disk: %s', 'wpbr-bulk-replace'),
$item->staged_filename
)) . "
";
return;
}
$paths[] = $item->staged_path;
$names[] = $item->staged_filename;
}
$output_filename = wpbr_derive_combined_filename($names);
$output_path = wpbr_staging_dir() . '/' . $output_filename;
$merge_result = wpbr_merge_pdfs($paths, $output_path);
if (!$merge_result['success']) {
wpbr_render_combine_failed($merge_result['error']);
return;
}
$batch = wpbr_get_batch($batch_id);
$new_status = 'staged';
$match_data = array(
'matched_post_id' => null, 'matched_post_title' => null,
'confidence_score' => null, 'match_kind' => null, 'rename_to' => null,
);
$combined_match = null;
if ($batch && $batch->post_type && $batch->meta_key_name) {
$meta_keys = wpbr_split_meta_keys($batch->meta_key_name);
$candidates = wpbr_get_post_candidates($batch->post_type, $meta_keys);
$combined_match = wpbr_match_file($output_filename, $candidates, $batch->post_type);
$decision = wpbr_match_row_update($combined_match);
$new_status = $decision['settled'] ? 'matched' : 'needs_review';
$match_data = $decision['update'];
}
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery -- Plugin-owned table with no WordPress API; an insert, so there is no cached read to invalidate.
$wpdb->insert($items_table, array_merge(array(
'batch_id' => $batch_id,
'staged_filename' => $output_filename,
'staged_path' => $output_path,
'status' => $new_status,
'notes' => trim(sprintf(
/* translators: 1: a list of filenames joined by " + ", 2: the name of the PDF library used, e.g. "Ghostscript". */
__('Combined from, in page order: %1$s (via %2$s)', 'wpbr-bulk-replace'),
implode(' + ', $names),
$merge_result['method']
) . (empty($merge_result['lossy']) ? '' : ' | ' . __('This was the only method available on this server, and it rebuilds each page as an image: the combined file has no selectable text, no embedded fonts and no links. Installing Ghostscript would avoid that.', 'wpbr-bulk-replace'))),
), $match_data));
$new_id = $wpdb->insert_id;
foreach ($items as $item) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->update($items_table, array(
'status' => 'combined',
'notes' => trim(($item->notes ? $item->notes.' | ' : '').sprintf(
/* translators: %s is a row's numeric ID. */
__('Combined into item #%s', 'wpbr-bulk-replace'),
$new_id
)),
), array('id' => $item->id));
}
if ($new_status === 'matched') {
$result_msg = ($match_data['match_kind'] === WPBR_MATCH_EXACT)
? sprintf(
/* translators: %s is the title of the post it matched. */
__('matched to "%s" by an exact identifier in its name', 'wpbr-bulk-replace'),
$match_data['matched_post_title']
)
: sprintf(
/* translators: 1: the title of the post it matched, 2: a confidence score. */
__('matched to "%1$s" (score %2$s)', 'wpbr-bulk-replace'),
$match_data['matched_post_title'],
$match_data['confidence_score']
);
} elseif ($new_status === 'needs_review') {
$result_msg = ($combined_match && isset($combined_match['kind']) && $combined_match['kind'] === WPBR_MATCH_AMBIGUOUS)
? __('needs manual review — the identifier in its name matches more than one candidate', 'wpbr-bulk-replace')
: __('needs manual review — no confident match found', 'wpbr-bulk-replace');
} else {
$result_msg = __('unmatched — set up matching on this batch first, then re-run it', 'wpbr-bulk-replace');
}
echo "
" . esc_html(sprintf(
/* translators: 1: a number of files, 2: the new combined filename, 3: the PDF library used, e.g. "Ghostscript", 4: how the new row matched, e.g. "needs manual review". */
_n('Combined %1$s file into a new row (%2$s) via %3$s. It is %4$s at the top of the table below — open the file to verify it looks right before trusting the match.',
'Combined %1$s files into a new row (%2$s) via %3$s. It is %4$s at the top of the table below — open the file to verify it looks right before trusting the match.',
count($items), 'wpbr-bulk-replace'),
number_format_i18n(count($items)),
$output_filename,
$merge_result['method'],
$result_msg
));
if (!empty($merge_result['lossy'])) {
echo "
" . esc_html__('The combined file has no selectable text.', 'wpbr-bulk-replace') . " "
. esc_html__('The only merge method available on this server rebuilds every page as an image, so the result cannot be searched, copied from or read by a screen reader, and it will be much larger than the files it came from. Installing Ghostscript on the server avoids all of that. Settings lists what this server has.', 'wpbr-bulk-replace');
}
echo "
";
}
function wpbr_handle_confirm_new_attach_bulk($batch_id, $selected_ids) {
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
if (empty($selected_ids)) {
echo "
";
return;
}
$ids = wpbr_clean_ids($selected_ids);
if ($ids) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->query($wpdb->prepare(
"UPDATE {$wpdb->prefix}wpbr_batch_items SET status = 'confirmed_new_attach' WHERE batch_id = %d AND status <> 'needs_attention' AND id IN (" . implode(',', array_fill(0, count($ids), '%d')) . ')',
array_merge(array($batch_id), $ids)
));
}
echo "
" . esc_html(sprintf(
/* translators: %s is a number of rows. */
_n('%s row confirmed for first-time attachment.', '%s rows confirmed for first-time attachment.', count($selected_ids), 'wpbr-bulk-replace'),
number_format_i18n(count($selected_ids))
)) . "
";
}
function wpbr_handle_delete_items($batch_id, $selected_ids) {
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
$items_table = wpbr_table_items();
if (empty($selected_ids)) {
echo "
";
return;
}
$items = wpbr_get_batch_items_in($batch_id, $selected_ids);
$deleted = 0;
$blocked = 0;
$held = 0;
foreach ($items as $item) {
if ($item->status === 'needs_attention') {
$held++;
continue;
}
if (in_array($item->status, array('replaced', 'verified'), true)) {
$blocked++;
continue;
}
if ($item->staged_path && file_exists($item->staged_path)) {
wp_delete_file($item->staged_path);
}
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->delete($items_table, array('id' => $item->id, 'batch_id' => $batch_id));
$deleted++;
}
$msg = sprintf(
/* translators: %s is a number of rows. */
_n('Deleted %s row.', 'Deleted %s rows.', $deleted, 'wpbr-bulk-replace'),
number_format_i18n($deleted)
);
if ($blocked) {
// THE STEP IS NAMED BY THE FUNCTION THAT NAMES STEPS, not by these
// sentences. They used to send the reader to "Verify & Cleanup", a
// fifth step of a four-step wizard: verifying and deleting backups are
// toolbar actions on the processed table inside Backup & Replace, and
// have been since the wizard lost its fifth step. A screen name spelled
// out in prose is a screen name that stops being true silently.
$msg .= ' ' . sprintf(
/* translators: 1: a number of rows, 2: the title of the Backup & Replace step. */
_n('%1$s row was skipped because it has already been replaced live — roll it back or clean it up on the %2$s step instead.',
'%1$s rows were skipped because they have already been replaced live — roll them back or clean them up on the %2$s step instead.',
$blocked, 'wpbr-bulk-replace'),
number_format_i18n($blocked),
wpbr_wizard_step_title('replace')
);
}
if ($held) {
$msg .= ' ' . esc_html__('A file that needs attention was left in place: deal with it from the panel above the table first.', 'wpbr-bulk-replace');
}
echo "
".esc_html($msg)."
";
}
function wpbr_handle_skip_items($batch_id, $selected_ids) {
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
if (empty($selected_ids)) {
echo "
";
return;
}
$ids = wpbr_clean_ids($selected_ids);
if ($ids) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->query($wpdb->prepare(
"UPDATE {$wpdb->prefix}wpbr_batch_items SET status = 'skip' WHERE batch_id = %d AND status <> 'needs_attention' AND id IN (" . implode(',', array_fill(0, count($ids), '%d')) . ')',
array_merge(array($batch_id), $ids)
));
}
echo "
" . esc_html(sprintf(
/* translators: %s is a number of rows. "Skipped" is a status name. */
_n('%s row moved to Skipped.', '%s rows moved to Skipped.', count($selected_ids), 'wpbr-bulk-replace'),
number_format_i18n(count($selected_ids))
)) . "
";
}
function wpbr_handle_save_review($batch_id) {
check_admin_referer('wpbr_save_review');
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
$wpbr_sub = isset($_POST['wpbr_sub']) ? sanitize_key(wp_unslash($_POST['wpbr_sub'])) : '';
$selected_ids = isset($_POST['item_ids']) ? array_map('intval', (array) $_POST['item_ids']) : array();
// Delete and Refresh Matching are asked about in the page (admin-dialog.php), and the dialog's Confirm is the only thing that
// sends this field, naming the action it confirmed. It is checked here, not just in the browser: if the dialog's script
// did not run (an error earlier on the page, a blocked or cached-stale file), the button is a plain submit button, and a
// plain submit must not delete or re-match.
$confirmed = isset($_POST['wpbr_confirmed']) && sanitize_key(wp_unslash($_POST['wpbr_confirmed'])) === $wpbr_sub;
if (wpbr_combine_enabled() && $wpbr_sub === 'combine_files') {
$combine_order = isset($_POST['combine_order']) ? sanitize_text_field(wp_unslash($_POST['combine_order'])) : '';
wpbr_handle_combine_files($batch_id, $selected_ids, $combine_order);
return;
}
if ($wpbr_sub === 'confirm_new_attach_bulk') {
wpbr_handle_confirm_new_attach_bulk($batch_id, $selected_ids);
return;
}
if ($wpbr_sub === 'delete_selected') {
if (!$confirmed) {
echo "
" . esc_html__('Nothing was deleted. Deleting files needs your confirmation, and the confirmation window did not open. Reload the page and try again.', 'wpbr-bulk-replace') . "
" . esc_html__('Nothing was saved.', 'wpbr-bulk-replace') . " " . esc_html(sprintf(
/* translators: 1: how many rows arrived, 2: how many were expected. */
__('The browser sent data for only %1$s of %2$s rows, which means PHP truncated the submission before it arrived. Saving a partial form could have quietly overwritten rows with blank values, so the save was canceled.', 'wpbr-bulk-replace'),
number_format_i18n(count($post_ids)),
number_format_i18n($expected)
)) . "
";
$limit_note = $limit
? sprintf(
/* translators: %s is the current max_input_vars value. */
__('(currently %s)', 'wpbr-bulk-replace'),
number_format_i18n($limit)
)
: '';
echo "
" . wp_kses_post(sprintf(
/* translators: 1: "(currently 1,000)", or empty when PHP does not report a limit, 2: an approximate number of form fields. max_input_vars and php.ini are literal names and stay untranslated. */
__('This is PHP’s max_input_vars limit %1$s being exceeded: this batch submits roughly %2$s fields. Ask your server admin to raise max_input_vars to 5000 — it is a one-line php.ini change and costs nothing.', 'wpbr-bulk-replace'),
esc_html($limit_note),
esc_html(number_format_i18n($expected * 4))
)) . "
";
echo "
" . wp_kses_post(__('Changing Rows per page won\'t help: rows hidden by paging and filtering are still part of the form and still get submitted.', 'wpbr-bulk-replace')) . "
";
return;
}
$statuses = isset($_POST['status']) ? array_map('sanitize_text_field', (array) wp_unslash($_POST['status'])) : array();
$renames = isset($_POST['rename_to']) ? array_map('sanitize_text_field', (array) wp_unslash($_POST['rename_to'])) : array();
$notes = isset($_POST['notes']) ? array_map('sanitize_text_field', (array) wp_unslash($_POST['notes'])) : array();
$manual_picks = array();
if (!empty($_POST['manual_picks_json'])) {
$decoded = json_decode(sanitize_text_field(wp_unslash($_POST['manual_picks_json'])), true);
if (is_array($decoded)) {
foreach ($decoded as $mid) { $manual_picks[intval($mid)] = '1'; }
}
}
$apply_template = ($wpbr_sub === 'apply_template');
$template = isset($_POST['rename_template']) ? trim(sanitize_text_field(wp_unslash($_POST['rename_template']))) : '';
$batch_row = wpbr_get_batch($batch_id);
$prior = array();
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; this read decides what the next write does, so it is never cached (docs/PLUGIN-CHECK.md).
$rows = $wpdb->get_results($wpdb->prepare("SELECT id, staged_filename, matched_post_id, status FROM {$wpdb->prefix}wpbr_batch_items WHERE batch_id = %d", $batch_id));
$staged_filenames = array();
$current_status = array();
foreach ($rows as $r) {
$staged_filenames[$r->id] = $r->staged_filename;
$prior[$r->id] = $r->matched_post_id;
$current_status[$r->id] = $r->status;
}
foreach ($post_ids as $item_id => $post_id) {
$item_id = intval($item_id);
if (!isset($current_status[$item_id])) continue; // Not a row of this batch: nothing to save.
wpbr_set_row_match($batch_id, $item_id, $post_id, array(
'status' => isset($statuses[$item_id]) ? $statuses[$item_id] : null,
'rename_to' => isset($renames[$item_id]) ? (string) $renames[$item_id] : '',
'rename_template' => $apply_template ? $template : '',
'notes' => isset($notes[$item_id]) ? $notes[$item_id] : '',
'manual_pick' => isset($manual_picks[$item_id]),
), array(
'row' => (object) array(
'id' => $item_id,
'staged_filename' => $staged_filenames[$item_id],
'matched_post_id' => $prior[$item_id],
'status' => $current_status[$item_id],
),
'batch' => $batch_row,
));
}
if ($apply_template && $template) {
echo "
" . esc_html__('Rename template applied to all matched rows and changes saved.', 'wpbr-bulk-replace') . "
";
}
if ($wpbr_sub === 'rerun_matching') {
if ($confirmed) {
wpbr_rerun_matching_from_batch($batch_id);
} else {
// The save above is what the Save Changes button does and is safe to keep; the re-match is what needs the question.
echo "
" . esc_html__('Your changes were saved, but matching was not re-run. Re-running needs your confirmation, and the confirmation window did not open. Reload the page and try again.', 'wpbr-bulk-replace') . "
";
}
}
}
function wpbr_col_letter_to_index($ref) {
preg_match('/^([A-Z]+)/', $ref, $m);
$letters = isset($m[1]) ? $m[1] : 'A';
$index = 0;
for ($i = 0; $i < strlen($letters); $i++) {
$index = $index * 26 + (ord($letters[$i]) - 64);
}
return $index - 1;
}
function wpbr_read_xlsx_rows($path) {
if (!class_exists('ZipArchive')) return null;
$zip = new ZipArchive();
if ($zip->open($path) !== true) return null;
$shared_strings = array();
$ss_xml = $zip->getFromName('xl/sharedStrings.xml');
if ($ss_xml) {
$ss = @simplexml_load_string($ss_xml, 'SimpleXMLElement', LIBXML_NONET);
if ($ss) {
foreach ($ss->si as $si) {
if (isset($si->t)) {
$shared_strings[] = (string) $si->t;
} else {
$text = '';
foreach ($si->r as $r) { $text .= (string) $r->t; }
$shared_strings[] = $text;
}
}
}
}
$sheet_name = null;
for ($i = 0; $i < $zip->numFiles; $i++) {
$name = $zip->getNameIndex($i);
if (preg_match('#^xl/worksheets/sheet\d+\.xml$#', $name)) { $sheet_name = $name; break; }
}
if (!$sheet_name) { $zip->close(); return null; }
$sheet_xml = $zip->getFromName($sheet_name);
$zip->close();
if (!$sheet_xml) return null;
$sheet = @simplexml_load_string($sheet_xml, 'SimpleXMLElement', LIBXML_NONET);
if (!$sheet) return null;
$rows_raw = array();
foreach ($sheet->sheetData->row as $row) {
$row_data = array();
foreach ($row->c as $c) {
$ref = (string) $c['r'];
$col_index = wpbr_col_letter_to_index($ref);
$type = (string) $c['t'];
if ($type === 's') {
$idx = (int) $c->v;
$value = isset($shared_strings[$idx]) ? $shared_strings[$idx] : '';
} elseif ($type === 'inlineStr') {
$value = isset($c->is->t) ? (string) $c->is->t : '';
} else {
$value = (string) $c->v;
}
$row_data[$col_index] = $value;
}
$rows_raw[] = $row_data;
}
if (empty($rows_raw)) return array();
$header_row = $rows_raw[0];
if (empty($header_row)) return array();
$max_col = max(array_keys($header_row));
$headers = array();
for ($i = 0; $i <= $max_col; $i++) {
$headers[$i] = isset($header_row[$i]) ? trim($header_row[$i]) : '';
}
$result = array();
for ($r = 1; $r < count($rows_raw); $r++) {
$row_data = $rows_raw[$r];
$assoc = array();
foreach ($headers as $i => $h) {
if ($h === '') continue;
$assoc[$h] = isset($row_data[$i]) ? $row_data[$i] : '';
}
if (!empty($assoc)) $result[] = $assoc;
}
return $result;
}
/**
* The escape character for this plugin's CSV reading and writing.
*
* PHP defaults to a backslash, which no spreadsheet program uses and RFC 4180
* does not describe: a field ending in one swallows the quote that closes it,
* and every column after that lands in the wrong place. Passing an empty
* string turns that off and parses the way Excel and Google Sheets write.
*
* It also has to be passed explicitly. PHP 8.4 deprecates leaving it out - an
* import on 8.4 fills the error log with notices - and the default changes in
* PHP 9, which would change how files parse without a line of this plugin
* being edited.
*/
if (!defined('WPBR_CSV_ESCAPE')) define('WPBR_CSV_ESCAPE', '');
function wpbr_read_csv_rows($path) {
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fopen -- A streaming read of an uploaded CSV: fgetcsv() needs a handle, and WP_Filesystem can only return the whole file as a string, which cannot be parsed row by row without holding every row of a large spreadsheet in memory.
$handle = fopen($path, 'r');
if (!$handle) return array();
$header = fgetcsv($handle, 0, ',', '"', WPBR_CSV_ESCAPE);
if (!$header) { fclose($handle); return array(); } // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fclose -- Closes the CSV handle opened above, which WP_Filesystem could not stream.
$header = array_map('trim', $header);
$width = count($header);
$result = array();
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition -- The idiomatic read loop: fgetcsv() returns false at EOF, so the assignment is the condition.
while (($row = fgetcsv($handle, 0, ',', '"', WPBR_CSV_ESCAPE)) !== false) {
// A blank line reads as a single null cell. Every editor leaves one at
// the end of a file.
if (array() === array_filter($row, function ($cell) { return null !== $cell && '' !== trim((string) $cell); })) {
continue;
}
// Squared off against the header rather than handed to array_combine(),
// which returns false on a length mismatch in PHP 7 and throws a
// ValueError in PHP 8 - so a row with a trailing comma, an empty last
// column or a half-deleted cell took the whole admin screen down
// instead of producing a message about the file. Spreadsheets produce
// these constantly.
$row = array_slice(array_pad($row, $width, ''), 0, $width);
$result[] = array_combine($header, $row);
}
fclose($handle); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_fclose -- Closes the CSV handle opened above, which WP_Filesystem could not stream.
return $result;
}
function wpbr_parse_import_file($tmp_path, $original_filename) {
$ext = strtolower(pathinfo($original_filename, PATHINFO_EXTENSION));
if ($ext === 'xlsx') {
$rows = wpbr_read_xlsx_rows($tmp_path);
return $rows !== null ? $rows : array();
}
return wpbr_read_csv_rows($tmp_path);
}
function wpbr_handle_import_csv($batch_id) {
check_admin_referer('wpbr_import_csv');
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
// One file, whole: present, with its name and path as strings (a "csv_file[]"
// upload would make them arrays).
if (!isset($_FILES['csv_file']['name'], $_FILES['csv_file']['tmp_name'])
|| !is_string($_FILES['csv_file']['name']) || !is_string($_FILES['csv_file']['tmp_name'])
|| $_FILES['csv_file']['tmp_name'] === '') return;
$items_table = wpbr_table_items();
$import_log_table = wpbr_table_import_log();
// The uploaded name is whatever the browser sent. It only ever picks a
// parser and gets recorded, and both the history table and the log escape
// it on the way out, but it is cleaned once here so nothing downstream has
// to remember that.
$source_filename = sanitize_file_name(wp_unslash($_FILES['csv_file']['name']));
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- tmp_name is the path PHP itself chose for this upload, not text the browser sent; it is opened for reading and nothing else.
$tmp_path = $_FILES['csv_file']['tmp_name'];
$rows = wpbr_parse_import_file($tmp_path, $source_filename);
if (empty($rows)) {
echo "
" . esc_html__('Could not read that file, or it had no data rows. Accepted formats: .csv, .xlsx (first sheet only).', 'wpbr-bulk-replace') . "
";
return;
}
$import_uuid = wp_generate_uuid4();
$now = current_time('mysql');
$user_id = get_current_user_id();
// What the file is allowed to say. Both the on-screen instructions and the
// suggested email already tell the reviewer exactly this set; until now
// nothing checked that the file came back inside it.
$batch = wpbr_get_batch($batch_id);
$selectable = wpbr_selectable_statuses();
$updated = 0;
$protected_skipped = 0;
$rejected = 0;
$unrecorded = 0;
foreach ($rows as $data) {
if (empty($data['staged_filename'])) continue;
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; this read decides what the next write does, so it is never cached (docs/PLUGIN-CHECK.md).
$existing = $wpdb->get_row($wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}wpbr_batch_items WHERE batch_id = %d AND staged_filename = %s",
$batch_id, trim($data['staged_filename'])
));
if (!$existing) continue;
if (in_array($existing->status, array('combined', 'replaced', 'verified', 'needs_attention'), true)) {
$protected_skipped++;
continue;
}
$update = array();
if (isset($data['matched_post_id']) && $data['matched_post_id'] !== '') {
// A post that exists, of the type this batch is working on. Neither
// was checked, so a typo'd or stale ID silently retargeted the file
// at whatever happened to hold that number - or at nothing, leaving
// the row pointed somewhere the Replace step cannot write.
$candidate_id = intval($data['matched_post_id']);
$candidate = $candidate_id ? get_post($candidate_id) : null;
if (!$candidate || ($batch && $batch->post_type && $candidate->post_type !== $batch->post_type)) {
$rejected++;
} else {
$update['matched_post_id'] = $candidate_id;
$update['matched_post_title'] = wpbr_clean_title(get_the_title($candidate_id));
if (intval($existing->matched_post_id) !== $candidate_id) {
/** Both columns, for the reason given in wpbr_handle_save_review(). */
$update['confidence_score'] = null;
$update['match_kind'] = WPBR_MATCH_MANUAL;
if ($batch && $batch->post_type) {
/** This method documented in wpbr_handle_bulk_reassign(). */
do_action('wpbr_match_confirmed', $existing->staged_filename, $candidate_id, $batch->post_type);
}
}
}
}
if (isset($data['status']) && $data['status'] !== '') {
// Status drives which rows process, which can be rolled back and
// which can have their backup deleted. A value outside the set the
// reviewer was given leaves the row somewhere no query matches and
// no screen offers an action for; "replaced" and "verified" are
// records of something having happened on disk, and a file cannot
// assert them into being.
$candidate_status = sanitize_text_field($data['status']);
if (in_array($candidate_status, $selectable, true)) {
$update['status'] = $candidate_status;
} else {
$rejected++;
}
}
if (isset($data['notes'])) $update['notes'] = sanitize_text_field($data['notes']);
if ($update) {
// The undo record goes in first and is checked, because it is the
// only copy of what this row held. Written after the change, or
// written and not checked, a failure here leaves a row altered by
// somebody else's spreadsheet with no way back.
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery -- Plugin-owned table with no WordPress API; an insert, so there is no cached read to invalidate.
$recorded = $wpdb->insert($import_log_table, array(
'import_uuid' => $import_uuid,
'batch_id' => $batch_id,
'item_id' => $existing->id,
'source_filename' => $source_filename,
'prev_matched_post_id' => $existing->matched_post_id,
'prev_matched_post_title' => $existing->matched_post_title,
'prev_status' => $existing->status,
'prev_notes' => $existing->notes,
'created_at' => $now,
'created_by' => $user_id,
));
if (false === $recorded) {
$unrecorded++;
continue;
}
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->update($items_table, $update, array('id' => $existing->id));
$updated++;
}
}
$log_detail = sprintf(
/* translators: %s is a number of rows. */
_n('Updated %s row', 'Updated %s rows', $updated, 'wpbr-bulk-replace'),
number_format_i18n($updated)
);
if ($protected_skipped) {
$log_detail .= ', ' . sprintf(
/* translators: %s is a number of rows that were deliberately left as they were. */
_n('left %s protected row alone', 'left %s protected rows alone', $protected_skipped, 'wpbr-bulk-replace'),
number_format_i18n($protected_skipped)
);
}
if ($rejected) {
$log_detail .= ', ' . sprintf(
/* translators: %s is a number of values in the file that were not accepted. */
_n('ignored %s value the file was not allowed to set', 'ignored %s values the file was not allowed to set', $rejected, 'wpbr-bulk-replace'),
number_format_i18n($rejected)
);
}
wpbr_log($batch_id, null, $source_filename, 'import', 'success', $log_detail);
$msg = sprintf(
/* translators: %s is a number of rows. */
_n('Imported changes for %s row.', 'Imported changes for %s rows.', $updated, 'wpbr-bulk-replace'),
number_format_i18n($updated)
);
if ($protected_skipped > 0) {
$msg .= ' ' . sprintf(
/* translators: %s is a number of rows. */
_n('Left %s row untouched because it has already been combined, replaced, or verified — a reviewer’s file cannot override work you have already done past that point.',
'Left %s rows untouched because they have already been combined, replaced, or verified — a reviewer’s file cannot override work you have already done past that point.',
$protected_skipped, 'wpbr-bulk-replace'),
number_format_i18n($protected_skipped)
);
}
if ($unrecorded > 0) {
$msg .= ' ' . sprintf(
/* translators: %s is a number of rows. */
_n('Left %s row unchanged because its undo record could not be saved — a change that cannot be undone is not one this plugin will make on a spreadsheet\'s word. Try the import again.',
'Left %s rows unchanged because their undo records could not be saved — a change that cannot be undone is not one this plugin will make on a spreadsheet\'s word. Try the import again.',
$unrecorded, 'wpbr-bulk-replace'),
number_format_i18n($unrecorded)
);
}
if ($rejected > 0) {
$msg .= ' ' . sprintf(
/* translators: %s is a number of values in the file. */
_n('Ignored %s value the file was not allowed to set — a status outside the listed set, or a match to a post that does not exist or is not the type this batch is processing. Everything else in the file was applied.',
'Ignored %s values the file was not allowed to set — statuses outside the listed set, or matches to posts that do not exist or are not the type this batch is processing. Everything else in the file was applied.',
$rejected, 'wpbr-bulk-replace'),
number_format_i18n($rejected)
);
}
if ($updated > 0) {
$msg .= ' ' . __('You can undo this from the Import history table below if something looks wrong.', 'wpbr-bulk-replace');
}
echo "
".wp_kses_post($msg)."
";
}
function wpbr_handle_undo_import($batch_id, $import_uuid) {
if (!current_user_can('manage_options')) wp_die(esc_html__('You are not allowed to do that.', 'wpbr-bulk-replace'), '', array('response' => 403));
global $wpdb;
$items_table = wpbr_table_items();
$import_log_table = wpbr_table_import_log();
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; this read decides what the next write does, so it is never cached (docs/PLUGIN-CHECK.md).
$log_rows = $wpdb->get_results($wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}wpbr_import_log WHERE batch_id = %d AND import_uuid = %s",
$batch_id, $import_uuid
));
if (!$log_rows) {
echo "
" . wp_kses_post(__('Could not find that import to undo — it may have already been undone, or this is an old page load.', 'wpbr-bulk-replace')) . "
";
return;
}
$restored = 0;
foreach ($log_rows as $log) {
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; this read decides what the next write does, so it is never cached (docs/PLUGIN-CHECK.md).
$current = $wpdb->get_row($wpdb->prepare("SELECT status FROM {$wpdb->prefix}wpbr_batch_items WHERE id = %d", $log->item_id));
if ($current && in_array($current->status, array('combined', 'replaced', 'verified'), true)) {
continue;
}
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->update($items_table, array(
'matched_post_id' => $log->prev_matched_post_id,
'matched_post_title' => $log->prev_matched_post_title,
'status' => $log->prev_status,
'notes' => $log->prev_notes,
), array('id' => $log->item_id));
$restored++;
}
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Plugin-owned table with no WordPress API; a write, and nothing here is cached, so there is nothing to invalidate.
$wpdb->delete($import_log_table, array('import_uuid' => $import_uuid));
wpbr_log($batch_id, null, null, 'undo_import', 'success', sprintf(
/* translators: %s is a number of rows. */
_n('Restored %s row', 'Restored %s rows', $restored, 'wpbr-bulk-replace'),
number_format_i18n($restored)
));
echo "
" . esc_html(sprintf(
/* translators: %s is a number of rows. */
_n('Undid the import — restored %s row to its state before it ran.',
'Undid the import — restored %s rows to their state before it ran.',
$restored, 'wpbr-bulk-replace'),
number_format_i18n($restored)
)) . "
";
}
function wpbr_find_attachment_id_by_url($url) {
global $wpdb;
$path = wp_parse_url($url, PHP_URL_PATH);
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- Core's attachment_url_to_postid() only matches URLs under this site's current uploads URL, and this finds a file by the end of its stored address whatever the host; it runs on the replace path, so it is not cached.
$id = $wpdb->get_var($wpdb->prepare("SELECT ID FROM ".$wpdb->posts." WHERE post_type = 'attachment' AND guid LIKE %s", '%'.$wpdb->esc_like($path)));
return $id ? intval($id) : null;
}