@relvehq/agent-ready 0.2.1 → 0.3.0

package/dist/wp/relve-agent-ready/includes/class-relve-ar-admin.php

@@ -4,8 +4,10 @@
  *
  * Settings form (Settings API, sanitised by Relve_AR_Settings::sanitize), a
  * status panel with this site's three test commands, and the refined-files
- * upload / clear actions (admin-post.php, each checking manage_options and
- * its own nonce). All output is escaped.
+ * upload / clear actions, the OpenAI key rows (masked, never echoed), the
+ * rewrite status and "Rewrite all now" (admin-post.php, each checking
+ * manage_options and its own nonce), and a notice while rewriting is paused.
+ * All output is escaped.
  *
  * @package Relve_Agent_Ready
  */
@@ -33,6 +35,8 @@ class Relve_AR_Admin {
 		add_action( 'admin_init', array( __CLASS__, 'register' ) );
 		add_action( 'admin_post_relve_ar_upload', array( __CLASS__, 'handle_upload' ) );
 		add_action( 'admin_post_relve_ar_clear', array( __CLASS__, 'handle_clear' ) );
+		add_action( 'admin_post_relve_ar_refine_all', array( __CLASS__, 'handle_refine_all' ) );
+		add_action( 'admin_notices', array( __CLASS__, 'pause_notice' ) );
 		add_filter( 'plugin_action_links_' . plugin_basename( RELVE_AR_FILE ), array( __CLASS__, 'action_links' ) );
 	}
 
@@ -138,6 +142,7 @@ class Relve_AR_Admin {
 		check_admin_referer( 'relve_ar_clear' );
 		$store = new Relve_AR_Store();
 		$store->clear();
+		Relve_AR_Refiner::forget_all_meta();
 		self::redirect_with(
 			array(
 				'type'    => 'success',
@@ -147,6 +152,63 @@ class Relve_AR_Admin {
 		);
 	}
 
+	/**
+	 * "Rewrite all now": queue every published post; WP-Cron does the work.
+	 *
+	 * @return void
+	 */
+	public static function handle_refine_all() {
+		if ( ! current_user_can( 'manage_options' ) ) {
+			wp_die( esc_html__( 'You are not allowed to do this.', 'relve-agent-ready' ), 403 );
+		}
+		check_admin_referer( 'relve_ar_refine_all' );
+		$s = Relve_AR_Settings::get();
+		if ( '' === $s['openai_key'] ) {
+			self::redirect_with(
+				array(
+					'type'    => 'error',
+					'message' => __( 'Save an OpenAI key first.', 'relve-agent-ready' ),
+					'reasons' => array(),
+				)
+			);
+		}
+		$n = Relve_AR_Refiner::start_all();
+		self::redirect_with(
+			array(
+				'type'    => $n ? 'success' : 'error',
+				/* translators: %d: number of posts. */
+				'message' => $n ? sprintf( _n( 'Rewriting %d post in the background, 5 at a time. Reload this page to see progress.', 'Rewriting %d posts in the background, 5 at a time. Reload this page to see progress.', $n, 'relve-agent-ready' ), $n ) : __( 'No published posts of the enabled types were found.', 'relve-agent-ready' ),
+				'reasons' => array(),
+			)
+		);
+	}
+
+	/**
+	 * Admin notice while rewriting is paused on a key problem.
+	 *
+	 * @return void
+	 */
+	public static function pause_notice() {
+		if ( ! current_user_can( 'manage_options' ) ) {
+			return;
+		}
+		$state = Relve_AR_Refiner::state();
+		if ( '' === $state['paused'] ) {
+			return;
+		}
+		$url = admin_url( 'options-general.php?page=' . self::PAGE );
+		?>
+		<div class="notice notice-error">
+			<p>
+				<strong><?php esc_html_e( 'Agent Ready paused rewriting posts.', 'relve-agent-ready' ); ?></strong>
+				<?php echo esc_html( Relve_AR_Refiner::error_label( $state['paused'] ) ); ?>
+				<code><?php echo esc_html( $state['paused'] ); ?></code>
+				<a href="<?php echo esc_url( $url ); ?>"><?php esc_html_e( 'Open Agent Ready settings', 'relve-agent-ready' ); ?></a>
+			</p>
+		</div>
+		<?php
+	}
+
 	/**
 	 * Keep a notice for this user and go back to the settings page.
 	 *
@@ -255,10 +317,21 @@ class Relve_AR_Admin {
 							<?php endforeach; ?>
 						</td>
 					</tr>
+					<?php self::render_refine_fields( $s ); ?>
 				</table>
 				<?php submit_button(); ?>
 			</form>
 
+			<h2><?php esc_html_e( 'Better Markdown with your own OpenAI key', 'relve-agent-ready' ); ?></h2>
+			<p><?php esc_html_e( 'Each published post is sent to Relve\'s refine service, which rewrites it with Relve\'s prompt using your OpenAI key and returns clean Markdown. The result is stored as that post\'s refined file and served first. Your key passes through Relve\'s server for that single call only; it is not stored or logged there. You pay OpenAI for the tokens.', 'relve-agent-ready' ); ?></p>
+			<?php self::render_refine_status( $s, Relve_AR_Refiner::state(), Relve_AR_Refiner::queue(), Relve_AR_Refiner::count_rewritten() ); ?>
+			<form method="post" action="<?php echo esc_url( admin_url( 'admin-post.php' ) ); ?>">
+				<input type="hidden" name="action" value="relve_ar_refine_all" />
+				<?php wp_nonce_field( 'relve_ar_refine_all' ); ?>
+				<?php submit_button( __( 'Rewrite all now', 'relve-agent-ready' ), 'secondary', 'submit', false, '' === $s['openai_key'] ? array( 'disabled' => 'disabled' ) : array() ); ?>
+				<p class="description"><?php esc_html_e( 'Queues every published post of the enabled types; WP-Cron rewrites 5 per run. Pages that have not changed since their last rewrite cost nothing. To start again from scratch, use "Clear refined files" below.', 'relve-agent-ready' ); ?></p>
+			</form>
+
 			<h2><?php esc_html_e( 'Refined files from Relve', 'relve-agent-ready' ); ?></h2>
 			<p>
 				<?php
@@ -285,6 +358,120 @@ class Relve_AR_Admin {
 		<?php
 	}
 
+	/**
+	 * Settings rows: OpenAI key (masked, never echoed), model, rewrite on save.
+	 *
+	 * @param array $s Settings.
+	 * @return void
+	 */
+	public static function render_refine_fields( $s ) {
+		$opt    = Relve_AR_Settings::OPTION;
+		$masked = Relve_AR_Settings::mask_key( $s['openai_key'] );
+		?>
+		<tr>
+			<th scope="row"><label for="relve-ar-openai-key"><?php esc_html_e( 'OpenAI key', 'relve-agent-ready' ); ?></label></th>
+			<td>
+				<?php if ( '' !== $masked ) : ?>
+					<p><?php esc_html_e( 'Saved key:', 'relve-agent-ready' ); ?> <code><?php echo esc_html( $masked ); ?></code></p>
+					<label>
+						<input type="checkbox" name="<?php echo esc_attr( $opt ); ?>[openai_key_remove]" value="1" />
+						<?php esc_html_e( 'Remove the saved key', 'relve-agent-ready' ); ?>
+					</label>
+				<?php endif; ?>
+				<p>
+					<input type="password" id="relve-ar-openai-key" class="regular-text code" name="<?php echo esc_attr( $opt ); ?>[openai_key_new]" value="" autocomplete="new-password" spellcheck="false" placeholder="<?php echo esc_attr( '' !== $masked ? __( 'Replace key', 'relve-agent-ready' ) : 'sk-...' ); ?>" />
+				</p>
+				<p class="description"><?php esc_html_e( 'Stored in this site\'s own database. Sent only to Relve\'s refine endpoint over https, for one call at a time; Relve does not store or log it. Leave empty to keep the saved key.', 'relve-agent-ready' ); ?></p>
+			</td>
+		</tr>
+		<tr>
+			<th scope="row"><label for="relve-ar-model"><?php esc_html_e( 'Model', 'relve-agent-ready' ); ?></label></th>
+			<td>
+				<select id="relve-ar-model" name="<?php echo esc_attr( $opt ); ?>[refine_model]">
+					<?php foreach ( Relve_AR_Settings::MODELS as $model ) : ?>
+						<option value="<?php echo esc_attr( $model ); ?>" <?php selected( $s['refine_model'], $model ); ?>><?php echo esc_html( $model ); ?></option>
+					<?php endforeach; ?>
+				</select>
+			</td>
+		</tr>
+		<tr>
+			<th scope="row"><?php esc_html_e( 'Rewrite on publish', 'relve-agent-ready' ); ?></th>
+			<td>
+				<label>
+					<input type="checkbox" name="<?php echo esc_attr( $opt ); ?>[refine_on_save]" value="1" <?php checked( $s['refine_on_save'] ); ?> />
+					<?php esc_html_e( 'Rewrite a post in the background (WP-Cron, about 30 seconds later) when it is published or updated. Needs a saved key and "Enabled".', 'relve-agent-ready' ); ?>
+				</label>
+			</td>
+		</tr>
+		<?php
+	}
+
+	/**
+	 * Rewrite status: key, posts rewritten, last run, last error, progress.
+	 *
+	 * @param array $s         Settings.
+	 * @param array $state     Refiner state.
+	 * @param array $q         Refiner queue.
+	 * @param int   $rewritten Posts with a rewritten file.
+	 * @return void
+	 */
+	public static function render_refine_status( $s, $state, $q, $rewritten ) {
+		$format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
+		?>
+		<table class="widefat striped" style="max-width:60em">
+			<tbody>
+				<tr>
+					<td><?php esc_html_e( 'OpenAI key saved', 'relve-agent-ready' ); ?></td>
+					<td><strong><?php echo '' !== $s['openai_key'] ? esc_html__( 'Yes', 'relve-agent-ready' ) : esc_html__( 'No', 'relve-agent-ready' ); ?></strong></td>
+				</tr>
+				<tr>
+					<td><?php esc_html_e( 'Posts rewritten', 'relve-agent-ready' ); ?></td>
+					<td><?php echo esc_html( (string) (int) $rewritten ); ?></td>
+				</tr>
+				<tr>
+					<td><?php esc_html_e( 'Last run', 'relve-agent-ready' ); ?></td>
+					<td><?php echo $state['last_run'] ? esc_html( wp_date( $format, (int) $state['last_run'] ) ) : esc_html__( 'Never', 'relve-agent-ready' ); ?></td>
+				</tr>
+				<tr>
+					<td><?php esc_html_e( 'Last error', 'relve-agent-ready' ); ?></td>
+					<td>
+						<?php if ( '' === $state['last_error'] ) : ?>
+							<?php esc_html_e( 'None', 'relve-agent-ready' ); ?>
+						<?php else : ?>
+							<code><?php echo esc_html( $state['last_error'] ); ?></code>
+							<?php echo esc_html( Relve_AR_Refiner::error_label( $state['last_error'] ) ); ?>
+							<?php if ( $state['last_error_at'] ) : ?>
+								(<?php echo esc_html( wp_date( $format, (int) $state['last_error_at'] ) ); ?><?php echo $state['last_error_post'] ? esc_html( ', post #' . (int) $state['last_error_post'] ) : ''; ?>)
+							<?php endif; ?>
+						<?php endif; ?>
+					</td>
+				</tr>
+				<tr>
+					<td><?php esc_html_e( 'Rewrite all', 'relve-agent-ready' ); ?></td>
+					<td>
+						<?php
+						if ( $q['ids'] ) {
+							/* translators: 1: posts done, 2: posts queued. */
+							echo esc_html( sprintf( __( 'In progress: %1$d / %2$d', 'relve-agent-ready' ), $q['done'], $q['total'] ) );
+							if ( '' !== $state['paused'] ) {
+								echo ' ';
+								/* translators: %s: error code. */
+								echo esc_html( sprintf( __( '(paused: %s; fix the key and it resumes)', 'relve-agent-ready' ), $state['paused'] ) );
+							}
+						} elseif ( is_array( $state['last_batch'] ) && isset( $state['last_batch']['done'], $state['last_batch']['total'] ) ) {
+							/* translators: 1: posts done, 2: posts queued. */
+							echo esc_html( sprintf( __( 'Finished: %1$d / %2$d', 'relve-agent-ready' ), (int) $state['last_batch']['done'], (int) $state['last_batch']['total'] ) );
+						} else {
+							esc_html_e( 'Not run yet', 'relve-agent-ready' );
+						}
+						?>
+					</td>
+				</tr>
+			</tbody>
+		</table>
+		<?php
+	}
+
 	/**
 	 * Status panel.
 	 *

package/dist/wp/relve-agent-ready/includes/class-relve-ar-markdown-builder.php

@@ -271,20 +271,8 @@ class Relve_AR_Markdown_Builder {
 	 * @return string
 	 */
 	public static function for_post( $post, $canonical ) {
-		$title = html_entity_decode( wp_strip_all_tags( get_the_title( $post ) ), ENT_QUOTES, 'UTF-8' );
-
-		// Render the content the way the theme would (blocks, shortcodes,
-		// embeds), with the post set up as the global post.
-		$previous_post   = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
-		$GLOBALS['post'] = $post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
-		setup_postdata( $post );
-		$html = apply_filters( 'the_content', $post->post_content ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- core hook.
-		$html = str_replace( ']]>', ']]>', (string) $html );
-		$GLOBALS['post'] = $previous_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
-		if ( $previous_post instanceof WP_Post ) {
-			setup_postdata( $previous_post );
-		}
-
+		$title   = html_entity_decode( wp_strip_all_tags( get_the_title( $post ) ), ENT_QUOTES, 'UTF-8' );
+		$html    = self::render_content( $post );
 		$content = Relve_AR_Converter::convert( $html, $canonical, array( 'demote_h1' => true ) );
 
 		$image_url = null;
@@ -332,6 +320,26 @@ class Relve_AR_Markdown_Builder {
 		return self::assemble( $fields, apply_filters( 'relve_agent_ready_markdown_body', $body, $post ) );
 	}
 
+	/**
+	 * The post's content rendered the way the theme would (blocks, shortcodes,
+	 * embeds), with the post set up as the global post.
+	 *
+	 * @param WP_Post $post Post.
+	 * @return string HTML.
+	 */
+	public static function render_content( $post ) {
+		$previous_post   = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
+		$GLOBALS['post'] = $post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+		setup_postdata( $post );
+		$html = apply_filters( 'the_content', $post->post_content ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- core hook.
+		$html = str_replace( ']]>', ']]>', (string) $html );
+		$GLOBALS['post'] = $previous_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+		if ( $previous_post instanceof WP_Post ) {
+			setup_postdata( $previous_post );
+		}
+		return $html;
+	}
+
 	/**
 	 * Front matter for a stored (refined) file that has none of its own.
 	 *