Files
Umbra-Bookshelf/umbra-bookshelf/includes/books/class-umbra-migration.php
bdm 0bd78e587a Resolve the known issues; switch licence to GPL
Closes the three problems that blocked the consolidation and records the rest
as tasks.

Licence: GPLv2 or later (WordPress.org compatible)

  LICENSE is now the full GPLv2 text and NOTICE is gone (it was Apache
  specific). All 101 SPDX headers read GPL-2.0-or-later and every shipped
  header says "GPLv2 or later".

  This also fixes an inconsistency that predated the consolidation: the theme's
  style.css declared GPLv2 while its PHP files carried Apache headers.

  Old/ and archive/pre-umbra-releases/ keep their original Apache headers on
  purpose -- they are frozen snapshots, not shipped code.

Schema: the catalogue schema is canonical for bd_books and bd_series

  Adds Umbra_Schema_Migration. The catalogue and library modules previously
  both created those two tables with different columns, so whichever plugin
  activated first won and the other read and wrote against the wrong shape.

  The migration detects a library-shaped table, RENAMES it aside (never drops
  it), creates the canonical table and copies rows across:

    - book IDs preserved, keeping bd_book_meta, bd_reviews, bd_ratings and
      bd_review_shortlinks valid
    - title/slug/description resolved from the linked post
    - the library's single isbn/asin land on the ebook columns; amazon_asin is
      also set so existing product links keep working
    - series migrated first so books.series_id still resolves
    - post linkage rewritten as _bd_bookshelf_book_id (preserved meta key)
    - publish_date kept as _bd_bookshelf_publish_date (no catalogue column)
    - bd_ratings goodreads/amazon folded into rating_goodreads/rating_amazon
    - rows whose post is gone are skipped with a log line, not turned into
      unusable books
    - duplicate slugs de-duplicated, since catalogue slug is UNIQUE

  It runs before dbDelta, and on admin_init as well as activation, because
  plugin updates do not re-run activation hooks. Ordering matters: dbDelta adds
  columns but never drops them, so pointed at a library-shaped table it would
  graft on catalogue columns and leave a table satisfying neither schema.

  Umbra_Bookshelf_Helper_Install no longer creates bd_books or bd_series.

Scraping: Goodreads only, one implementation

  There were three Goodreads implementations and two Amazon ones; both library
  "scrapers" were empty stubs attached to cron events that fired on schedule to
  do nothing, and both real scraper classes were never called at all.

  Umbra_Amazon_Scraper is deleted and the duplicate HTML parsing is gone from
  Umbra_Rating_Sync, which now delegates to Umbra_Goodreads_Scraper. The two
  library stubs and their cron registrations are removed. One schedule
  survives: bd_bookshelf_sync_ratings, every 12 hours.

  The rating_amazon column is retained (it holds data and is populated during
  migration) and Amazon retail links are unaffected.

  A new rating fetch failure keeps the last known value instead of writing zero.
  The admin ratings notice no longer warns about Amazon scraping.

Umbra_SEO is now instantiated

  It registers its hooks from a constructor and the bootstrap never constructed
  it, so the class was dead code and no SEO output was produced. Its meta, Open
  Graph, Twitter card and sitemap hooks now attach. Completing SEO for generated
  book detail pages is docs/TASKS.md #2.

Assets that 404'd

  - assets/images/default-cover.png now holds a real 512x815 cover
    (WorkingTitleCover_512x815.png). The helper returned this path but the
    repository contained no images at all.
  - email/assets/js/admin.js is committed as an empty placeholder. It was
    enqueued on every email admin page but had never been committed.

Tests

  - tests/schema_migration_test.php: 42 checks against a real database, driven
    through the sqlite3 CLI on a throwaway file. Covers shape detection, row
    mapping, ID preservation, orphan handling, rating folding, idempotency and
    slug collisions.
  - tests/run_all.sh runs every suite.
  - The declared version is now checked against the plugin header rather than a
    literal, so a version bump cannot silently break the suite.

Docs

  - KNOWN-ISSUES.md rewritten: three resolved, three remaining.
  - TASKS.md added: email admin behaviour, book detail page SEO, batching the
    rating sync, reclaiming legacy tables, reconciling the two book models,
    retiring the Old/ archive.
  - SPEC and ARCHITECTURE updated for schema ownership, the migration ordering
    constraint, and the single scraper.

Version 1.1.0.
2026-10-22 09:47:00 -07:00

267 lines
10 KiB
PHP

<?php
// Copyright 2026 Umbra Tools (umbratools.com)
// SPDX-License-Identifier: GPL-2.0-or-later
/**
* Migration Manager class
*
* @package Umbra_Bookshelf
*/
if (!defined('ABSPATH')) {
exit;
}
class Umbra_Migration {
/**
* Constructor
*
* The "Import" admin page itself is registered once by Umbra_Admin
* (slug: umbra-bookshelf-import), which is the variant wired to
* admin/js/umbra-bookshelf-admin.js. This class only supplies the
* two-phase preview/run AJAX endpoints that page has no equivalent for.
*
* Note: the bd_bookshelf_import_csv action is intentionally NOT
* registered here -- Umbra_Admin already owns that action. Registering
* it twice silently overwrote one of the two handlers.
*/
public function __construct() {
// AJAX handlers
add_action('wp_ajax_bd_bookshelf_preview_import', [$this, 'ajax_import_posts']);
add_action('wp_ajax_bd_bookshelf_run_import', [$this, 'ajax_run_import_posts']);
}
/**
* Render import page
*/
public function render_import_page() {
if (!current_user_can('manage_options')) {
wp_die(__('You do not have sufficient permissions to access this page.', 'umbra-bookshelf'));
}
?>
<div class="wrap">
<h1><?php esc_html_e('Import Books', 'umbra-bookshelf'); ?></h1>
<div class="bd-bookshelf-import-section">
<h2><?php esc_html_e('Import from WordPress Posts', 'umbra-bookshelf'); ?></h2>
<p><?php esc_html_e('Import books from existing WordPress posts or custom post types.', 'umbra-bookshelf'); ?></p>
<form id="bd-bookshelf-import-posts-form">
<?php wp_nonce_field('bd_bookshelf_import_posts', 'nonce'); ?>
<table class="form-table">
<tr>
<th><label for="post_type"><?php esc_html_e('Post Type', 'umbra-bookshelf'); ?></label></th>
<td>
<select name="post_type" id="post_type">
<option value="post"><?php esc_html_e('Posts', 'umbra-bookshelf'); ?></option>
<option value="page"><?php esc_html_e('Pages', 'umbra-bookshelf'); ?></option>
<option value="book"><?php esc_html_e('Books (if available)', 'umbra-bookshelf'); ?></option>
</select>
</td>
</tr>
<tr>
<th><label for="limit"><?php esc_html_e('Limit', 'umbra-bookshelf'); ?></label></th>
<td>
<input type="number" name="limit" id="limit" value="100" min="1" max="1000">
</td>
</tr>
</table>
<p class="submit">
<button type="submit" class="button button-primary"><?php esc_html_e('Preview Import', 'umbra-bookshelf'); ?></button>
</p>
</form>
<div id="bd-bookshelf-import-preview" style="display: none;">
<h3><?php esc_html_e('Preview', 'umbra-bookshelf'); ?></h3>
<div id="bd-bookshelf-import-results"></div>
<p class="submit">
<button type="button" id="bd-bookshelf-run-import" class="button button-primary"><?php esc_html_e('Run Import', 'umbra-bookshelf'); ?></button>
</p>
</div>
</div>
<div class="bd-bookshelf-import-section">
<h2><?php esc_html_e('Import from CSV', 'umbra-bookshelf'); ?></h2>
<p><?php esc_html_e('Import books from a CSV file.', 'umbra-bookshelf'); ?></p>
<form id="bd-bookshelf-import-csv-form" enctype="multipart/form-data">
<?php wp_nonce_field('bd_bookshelf_import_csv', 'nonce'); ?>
<table class="form-table">
<tr>
<th><label for="csv_file"><?php esc_html_e('CSV File', 'umbra-bookshelf'); ?></label></th>
<td>
<input type="file" name="csv_file" id="csv_file" accept=".csv">
<p class="description"><?php esc_html_e('Required columns: title. Optional: description, isbn_ebook, isbn_paperback, isbn_hardcover, isbn_audio, amazon_asin, goodreads_id.', 'umbra-bookshelf'); ?></p>
</td>
</tr>
</table>
<p class="submit">
<button type="submit" class="button button-primary"><?php esc_html_e('Import CSV', 'umbra-bookshelf'); ?></button>
</p>
</form>
</div>
</div>
<?php
}
/**
* AJAX handler for previewing post import
*/
public function ajax_import_posts() {
check_ajax_referer('bd_bookshelf_import_posts', 'nonce');
if (!current_user_can('manage_options')) {
wp_send_json_error(['message' => 'Insufficient permissions']);
}
$post_type = sanitize_text_field($_POST['post_type'] ?? 'post');
$limit = absint($_POST['limit'] ?? 100);
$posts = get_posts([
'post_type' => $post_type,
'post_status' => 'publish',
'numberposts' => $limit,
]);
$preview = [];
foreach ($posts as $post) {
$preview[] = [
'id' => $post->ID,
'title' => $post->post_title,
'date' => $post->post_date,
'content' => wp_trim_words($post->post_content, 20),
];
}
wp_send_json_success(['posts' => $preview, 'count' => count($preview)]);
}
/**
* AJAX handler for running post import
*/
public function ajax_run_import_posts() {
check_ajax_referer('bd_bookshelf_import_posts', 'nonce');
if (!current_user_can('manage_options')) {
wp_send_json_error(['message' => 'Insufficient permissions']);
}
$post_type = sanitize_text_field($_POST['post_type'] ?? 'post');
$limit = absint($_POST['limit'] ?? 100);
$posts = get_posts([
'post_type' => $post_type,
'post_status' => 'publish',
'numberposts' => $limit,
]);
$imported = 0;
$skipped = 0;
foreach ($posts as $post) {
// Check if already imported
$existing = Umbra_Book_Manager::get_book_by_title($post->post_title);
if ($existing) {
$skipped++;
continue;
}
// Import book
$book_id = Umbra_Book_Manager::create_book([
'title' => $post->post_title,
'description' => $post->post_content,
]);
if ($book_id) {
// Link to WordPress post
update_post_meta($post->ID, '_bd_bookshelf_book_id', $book_id);
$imported++;
}
}
wp_send_json_success([
'message' => sprintf('Imported %d books, skipped %d', $imported, $skipped),
'imported' => $imported,
'skipped' => $skipped,
]);
}
/**
* AJAX handler for CSV import
*/
public function ajax_import_csv() {
check_ajax_referer('bd_bookshelf_import_csv', 'nonce');
if (!current_user_can('manage_options')) {
wp_send_json_error(['message' => 'Insufficient permissions']);
}
if (empty($_FILES['csv_file']['tmp_name'])) {
wp_send_json_error(['message' => 'No file uploaded']);
}
$file = $_FILES['csv_file']['tmp_name'];
$handle = fopen($file, 'r');
if (!$handle) {
wp_send_json_error(['message' => 'Unable to open file']);
}
// Get header row
$header = fgetcsv($handle);
$imported = 0;
$skipped = 0;
$errors = [];
while (($row = fgetcsv($handle)) !== false) {
$data = array_combine($header, $row);
if (empty($data['title'])) {
$errors[] = 'Row ' . ($imported + $skipped + 1) . ': Missing title';
continue;
}
// Check if already imported
$existing = Umbra_Book_Manager::get_book_by_title($data['title']);
if ($existing) {
$skipped++;
continue;
}
// Create book
$book_id = Umbra_Book_Manager::create_book([
'title' => $data['title'],
'description' => $data['description'] ?? '',
'isbn_ebook' => $data['isbn_ebook'] ?? '',
'isbn_paperback' => $data['isbn_paperback'] ?? '',
'isbn_hardcover' => $data['isbn_hardcover'] ?? '',
'isbn_audio' => $data['isbn_audio'] ?? '',
'amazon_asin' => $data['amazon_asin'] ?? '',
'goodreads_id' => $data['goodreads_id'] ?? '',
]);
if ($book_id) {
$imported++;
} else {
$errors[] = 'Row ' . ($imported + $skipped + 1) . ': Failed to create book';
}
}
fclose($handle);
wp_send_json_success([
'message' => sprintf('Imported %d books, skipped %d, %d errors', $imported, $skipped, count($errors)),
'imported' => $imported,
'skipped' => $skipped,
'errors' => $errors,
]);
}
}