Changeset 3742801 for langforge/trunk/includes/class-cli.php

Timestamp:

10/13/2026 02:57:34 AM (2 weeks ago)

Author:

avakodeforge

Message:

Release 1.2.10 (trunk + tag; see readme changelog)

File:

• langforge/trunk/includes/class-cli.php (modified) (1 diff)

langforge/trunk/includes/class-cli.php

@@ -406 +406 @@
         if ($result['success']) {
             WP_CLI::success("Imported {$result['imported']} translations.");
+            self::print_import_notes($importer, $result);
         } else {
             WP_CLI::error($result['error'] ?? 'Import failed.');
+        }
+    }
+
+    /**
+ * The rows the importer did not take as the file wrote them (`notes` of its answer), one line each, as the screen of
+ * the importer lists them: the title of the page, the sentence of what happened to the row, and the link to edit the
+ * page. Only what the add-on sent is printed: an add-on that cannot make the sentences (describe_notes) gets the
+ * page, the row and the kind it named, and nothing of ours.
+ *
+ * @param object $importer The importer that answered.
+ * @param array $result Its answer.
+ */
+    private static function print_import_notes($importer, array $result) {
+        $notes = isset($result['notes']) && is_array($result['notes']) ? $result['notes'] : [];
+        if (!$notes) {
+            return;
+        }
+        WP_CLI::log('Some rows of the file need your attention:');
+
+        if (method_exists($importer, 'describe_notes')) {
+            foreach ((array) $importer->describe_notes($notes) as $note) {
+                $title   = isset($note['title']) ? (string) $note['title'] : '';
+                $message = isset($note['message']) && (string) $note['message'] !== '' ? (string) $note['message'] : (isset($note['row']) ? (string) $note['row'] : '');
+                $line    = $title . ': ' . $message;
+                if (!empty($note['edit_url'])) {
+                    $line .= ' (' . $note['edit_url'] . ')';
+                }
+                WP_CLI::warning($line);
+            }
+            return;
+        }
+
+        foreach ($notes as $note) {
+            if (!is_array($note)) {
+                continue;
+            }
+            $about = (int) (!empty($note['translation']) ? $note['translation'] : ($note['post'] ?? 0));
+            $row   = isset($note['row']) ? (string) $note['row'] : '';
+            $kind  = isset($note['kind']) ? (string) $note['kind'] : '';
+            WP_CLI::warning('Post ' . $about . ($row !== '' ? ', row ' . $row : '') . ': ' . $kind);
+        }
+    }
+
+    /**
+ * Show, or finish, the binary key of the string translation table.
+ *
+ * Lang Forge tells "Size" from "size" and "Resume" from "Résumé" in the table of its strings. It changes the key of
+ * the table when an admin page is opened, except on a site whose table has more than 500,000 rows: a web request
+ * must not hold such a table for minutes, so that site stays on the old key until this command is run.
+ *
+ * Without --yes it only shows the number of rows, the key and the answer the admin pages left. With --yes it
+ * rebuilds the key now, whatever the number of rows (the time it takes depends on the server), under the same lock
+ * a web request takes, and says "already" when the key is binary.
+ *
+ * ## OPTIONS
+ *
+ * [--yes]
+ * : Rebuild the key now.
+ *
+ * ## EXAMPLES
+ * wp langforge strings-key
+ * wp langforge strings-key --yes
+ *
+ * @subcommand strings-key
+ */
+    public function strings_key($args, $assoc_args) {
+        $yes = isset($assoc_args['yes']) && filter_var($assoc_args['yes'], FILTER_VALIDATE_BOOLEAN);
+        $overview = LANGFORGE_Schema::strings_key_overview();
+        if (!$overview['table']) {
+            WP_CLI::error('There is no strings table on this site yet: activate Lang Forge once and run this command again.');
+        }
+
+        $state = $overview['state'];
+        $answer = isset($state['status']) ? (string) $state['status'] : 'none yet';
+        if (!empty($state['error'])) {
+            $answer .= ' (' . $state['error'] . ')';
+        }
+        $key = $overview['binary'] === true ? 'binary' : ($overview['binary'] === false ? 'not binary, "Size" and "size" are one string' : 'unknown, the columns could not be read');
+        WP_CLI::log('Strings table: ' . $overview['rows'] . ' rows.');
+        WP_CLI::log('Key: ' . $key . '.');
+        WP_CLI::log('Last answer of the admin pages: ' . $answer . '.');
+
+        if (!$yes) {
+            if ($overview['binary'] !== true) {
+                WP_CLI::log('To rebuild the key now, run: wp langforge strings-key --yes');
+            }
+            return;
+        }
+
+        $result = LANGFORGE_Schema::migrate_strings_key(true);
+        if ($result === 'migrated') {
+            WP_CLI::success('The key is rebuilt: the names and domains of the strings now compare byte for byte; ' . $overview['rows'] . ' rows kept.');
+        } elseif ($result === 'already') {
+            WP_CLI::success('Already done: the key is binary, nothing was changed.');
+        } elseif ($result === 'busy') {
+            WP_CLI::error('Another process is rebuilding the table now (its lock is held; a lock nobody let go of is taken over after 15 minutes). Nothing was changed; run the command again later.');
+        } elseif ($result === 'no_table') {
+            WP_CLI::error('There is no strings table on this site yet: activate Lang Forge once and run this command again.');
+        } else {
+            $after = LANGFORGE_Schema::strings_key_overview();
+            $why = !empty($after['state']['error']) ? (string) $after['state']['error'] : 'the server refused the change';
+            WP_CLI::error('The key was not changed: ' . rtrim($why, '. ') . '. The table is as it was; the site works as before.');
         }
     }