@relvehq/agent-ready 0.0.0-stage → 0.2.1

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

@@ -0,0 +1,363 @@
+<?php
+/**
+ * Admin: Settings -> Agent Ready.
+ *
+ * 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.
+ *
+ * @package Relve_Agent_Ready
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * Settings page.
+ */
+class Relve_AR_Admin {
+
+	const PAGE   = 'relve-agent-ready';
+	const GROUP  = 'relve_agent_ready_group';
+	const NOTICE = 'relve_ar_notice_';
+
+	/**
+	 * Register hooks.
+	 *
+	 * @return void
+	 */
+	public static function init() {
+		add_action( 'admin_menu', array( __CLASS__, 'menu' ) );
+		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_filter( 'plugin_action_links_' . plugin_basename( RELVE_AR_FILE ), array( __CLASS__, 'action_links' ) );
+	}
+
+	/**
+	 * Settings link on the Plugins screen.
+	 *
+	 * @param array $links Links.
+	 * @return array
+	 */
+	public static function action_links( $links ) {
+		$url = admin_url( 'options-general.php?page=' . self::PAGE );
+		array_unshift( $links, '<a href="' . esc_url( $url ) . '">' . esc_html__( 'Settings', 'relve-agent-ready' ) . '</a>' );
+		return $links;
+	}
+
+	/**
+	 * Menu entry.
+	 *
+	 * @return void
+	 */
+	public static function menu() {
+		add_options_page(
+			__( 'Agent Ready', 'relve-agent-ready' ),
+			__( 'Agent Ready', 'relve-agent-ready' ),
+			'manage_options',
+			self::PAGE,
+			array( __CLASS__, 'render' )
+		);
+	}
+
+	/**
+	 * Register the option.
+	 *
+	 * @return void
+	 */
+	public static function register() {
+		register_setting(
+			self::GROUP,
+			Relve_AR_Settings::OPTION,
+			array(
+				'type'              => 'array',
+				'sanitize_callback' => array( 'Relve_AR_Settings', 'sanitize' ),
+				'default'           => Relve_AR_Settings::defaults(),
+				'show_in_rest'      => false,
+			)
+		);
+	}
+
+	// ── actions ───────────────────────────────────────────────────────────
+
+	/**
+	 * Refined-files zip upload.
+	 *
+	 * @return void
+	 */
+	public static function handle_upload() {
+		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_upload' );
+
+		$notice = array(
+			'type'    => 'error',
+			'message' => __( 'No file was uploaded.', 'relve-agent-ready' ),
+			'reasons' => array(),
+		);
+		// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- file array; tmp_name checked with is_uploaded_file().
+		$file = isset( $_FILES['relve_ar_zip'] ) && is_array( $_FILES['relve_ar_zip'] ) ? $_FILES['relve_ar_zip'] : null;
+		if ( $file && isset( $file['error'], $file['tmp_name'], $file['name'] ) && UPLOAD_ERR_OK === (int) $file['error'] ) {
+			$name = sanitize_file_name( (string) $file['name'] );
+			if ( '.zip' !== strtolower( substr( $name, -4 ) ) ) {
+				$notice['message'] = __( 'Upload a .zip file.', 'relve-agent-ready' );
+			} elseif ( ! is_uploaded_file( $file['tmp_name'] ) ) {
+				$notice['message'] = __( 'The upload could not be verified.', 'relve-agent-ready' );
+			} else {
+				$store = new Relve_AR_Store();
+				$store->ensure();
+				$r = $store->import_zip( $file['tmp_name'] );
+				if ( $r['ok'] ) {
+					$notice['type'] = 'success';
+					/* translators: 1: files stored, 2: files skipped, 3: entries rejected. */
+					$notice['message'] = sprintf( __( 'Stored %1$d refined files (skipped %2$d other files, rejected %3$d entries).', 'relve-agent-ready' ), $r['stored'], $r['skipped'], $r['rejected'] );
+				} else {
+					$notice['message'] = $r['error'];
+				}
+				$notice['reasons'] = array_slice( $r['reasons'], 0, 20 );
+			}
+		} elseif ( $file && isset( $file['error'] ) && UPLOAD_ERR_NO_FILE !== (int) $file['error'] ) {
+			$notice['message'] = __( 'The upload failed (it may be larger than the server allows).', 'relve-agent-ready' );
+		}
+		self::redirect_with( $notice );
+	}
+
+	/**
+	 * Clear refined files.
+	 *
+	 * @return void
+	 */
+	public static function handle_clear() {
+		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_clear' );
+		$store = new Relve_AR_Store();
+		$store->clear();
+		self::redirect_with(
+			array(
+				'type'    => 'success',
+				'message' => __( 'Refined files cleared.', 'relve-agent-ready' ),
+				'reasons' => array(),
+			)
+		);
+	}
+
+	/**
+	 * Keep a notice for this user and go back to the settings page.
+	 *
+	 * @param array $notice Notice.
+	 * @return void
+	 */
+	private static function redirect_with( $notice ) {
+		set_transient( self::NOTICE . get_current_user_id(), $notice, 120 );
+		wp_safe_redirect( admin_url( 'options-general.php?page=' . self::PAGE ) );
+		exit;
+	}
+
+	// ── page ──────────────────────────────────────────────────────────────
+
+	/**
+	 * Render the page.
+	 *
+	 * @return void
+	 */
+	public static function render() {
+		if ( ! current_user_can( 'manage_options' ) ) {
+			return;
+		}
+		$s     = Relve_AR_Settings::get();
+		$store = new Relve_AR_Store();
+		$count = $store->count();
+		$key   = self::NOTICE . get_current_user_id();
+		$note  = get_transient( $key );
+		if ( $note ) {
+			delete_transient( $key );
+		}
+		$types = get_post_types( array( 'public' => true ), 'objects' );
+		$opt   = Relve_AR_Settings::OPTION;
+		?>
+		<div class="wrap">
+			<h1><?php esc_html_e( 'Agent Ready', 'relve-agent-ready' ); ?></h1>
+			<p><?php esc_html_e( 'Serves a Markdown version of your posts and pages to AI agents that ask for it (Accept: text/markdown, a .md URL or ?format=md), plus an llms.txt. Browsers always get the normal page.', 'relve-agent-ready' ); ?></p>
+
+			<?php if ( is_array( $note ) ) : ?>
+				<div class="notice notice-<?php echo esc_attr( 'success' === $note['type'] ? 'success' : 'error' ); ?> is-dismissible">
+					<p><?php echo esc_html( $note['message'] ); ?></p>
+					<?php if ( ! empty( $note['reasons'] ) ) : ?>
+						<ul style="list-style:disc;margin-left:2em">
+							<?php foreach ( $note['reasons'] as $reason ) : ?>
+								<li><code><?php echo esc_html( $reason ); ?></code></li>
+							<?php endforeach; ?>
+						</ul>
+					<?php endif; ?>
+				</div>
+			<?php endif; ?>
+
+			<?php self::render_status( $s, $count ); ?>
+
+			<h2><?php esc_html_e( 'Settings', 'relve-agent-ready' ); ?></h2>
+			<form method="post" action="<?php echo esc_url( admin_url( 'options.php' ) ); ?>">
+				<?php settings_fields( self::GROUP ); ?>
+				<table class="form-table" role="presentation">
+					<tr>
+						<th scope="row"><?php esc_html_e( 'Enabled', 'relve-agent-ready' ); ?></th>
+						<td>
+							<label>
+								<input type="checkbox" name="<?php echo esc_attr( $opt ); ?>[enabled]" value="1" <?php checked( $s['enabled'] ); ?> />
+								<?php esc_html_e( 'Serve Markdown and llms.txt. While unchecked, no request is changed.', 'relve-agent-ready' ); ?>
+							</label>
+						</td>
+					</tr>
+					<tr>
+						<th scope="row"><?php esc_html_e( 'Post types', 'relve-agent-ready' ); ?></th>
+						<td>
+							<?php foreach ( $types as $type ) : ?>
+								<?php
+								if ( 'attachment' === $type->name ) {
+									continue;
+								}
+								?>
+								<label style="display:block">
+									<input type="checkbox" name="<?php echo esc_attr( $opt ); ?>[post_types][]" value="<?php echo esc_attr( $type->name ); ?>" <?php checked( in_array( $type->name, $s['post_types'], true ) ); ?> />
+									<?php echo esc_html( $type->labels->name ); ?> <code><?php echo esc_html( $type->name ); ?></code>
+								</label>
+							<?php endforeach; ?>
+							<p class="description"><?php esc_html_e( 'The front page and category, tag and author archives are served when Posts is enabled.', 'relve-agent-ready' ); ?></p>
+						</td>
+					</tr>
+					<tr>
+						<th scope="row"><label for="relve-ar-excluded"><?php esc_html_e( 'Excluded paths', 'relve-agent-ready' ); ?></label></th>
+						<td>
+							<textarea id="relve-ar-excluded" class="large-text code" rows="8" name="<?php echo esc_attr( $opt ); ?>[excluded_paths]"><?php echo esc_textarea( $s['excluded_paths'] ); ?></textarea>
+							<p class="description"><?php esc_html_e( 'One path per line. A path excludes itself and everything below it ("/cart" excludes /cart and /cart/x, not /cartoon). Matched against the full path and the path below your home URL.', 'relve-agent-ready' ); ?></p>
+						</td>
+					</tr>
+					<tr>
+						<th scope="row"><?php esc_html_e( 'llms.txt', 'relve-agent-ready' ); ?></th>
+						<td>
+							<?php
+							$modes = array(
+								'auto' => __( 'Auto: serve it unless Yoast SEO (or a real llms.txt file) already does', 'relve-agent-ready' ),
+								'on'   => __( 'On: always serve it', 'relve-agent-ready' ),
+								'off'  => __( 'Off', 'relve-agent-ready' ),
+							);
+							foreach ( $modes as $value => $label ) :
+								?>
+								<label style="display:block">
+									<input type="radio" name="<?php echo esc_attr( $opt ); ?>[llms_mode]" value="<?php echo esc_attr( $value ); ?>" <?php checked( $s['llms_mode'], $value ); ?> />
+									<?php echo esc_html( $label ); ?>
+								</label>
+							<?php endforeach; ?>
+						</td>
+					</tr>
+				</table>
+				<?php submit_button(); ?>
+			</form>
+
+			<h2><?php esc_html_e( 'Refined files from Relve', 'relve-agent-ready' ); ?></h2>
+			<p>
+				<?php
+				printf(
+					/* translators: %d: number of files. */
+					esc_html( _n( '%d refined file is stored. Refined files are served before the Markdown built from WordPress.', '%d refined files are stored. Refined files are served before the Markdown built from WordPress.', $count, 'relve-agent-ready' ) ),
+					(int) $count
+				);
+				?>
+			</p>
+			<form method="post" action="<?php echo esc_url( admin_url( 'admin-post.php' ) ); ?>" enctype="multipart/form-data">
+				<input type="hidden" name="action" value="relve_ar_upload" />
+				<?php wp_nonce_field( 'relve_ar_upload' ); ?>
+				<input type="file" name="relve_ar_zip" accept=".zip,application/zip" required />
+				<?php submit_button( __( 'Upload zip', 'relve-agent-ready' ), 'secondary', 'submit', false ); ?>
+				<p class="description"><?php esc_html_e( 'The zip from Relve (refined-md.zip): a top-level md/ folder of .md files. Uploading replaces the stored set. Max 20 MB, 2 MB per file.', 'relve-agent-ready' ); ?></p>
+			</form>
+			<form method="post" action="<?php echo esc_url( admin_url( 'admin-post.php' ) ); ?>" style="margin-top:1em">
+				<input type="hidden" name="action" value="relve_ar_clear" />
+				<?php wp_nonce_field( 'relve_ar_clear' ); ?>
+				<?php submit_button( __( 'Clear refined files', 'relve-agent-ready' ), 'delete', 'submit', false, array( 'onclick' => "return confirm('" . esc_js( __( 'Delete all refined files?', 'relve-agent-ready' ) ) . "');" ) ); ?>
+			</form>
+		</div>
+		<?php
+	}
+
+	/**
+	 * Status panel.
+	 *
+	 * @param array $s     Settings.
+	 * @param int   $count Refined file count.
+	 * @return void
+	 */
+	private static function render_status( $s, $count ) {
+		$yoast    = Relve_AR_Llms::yoast_serves();
+		$physical = Relve_AR_Llms::physical_file_exists();
+		$serves   = Relve_AR_Llms::should_serve( $s['llms_mode'], $yoast, $physical );
+		$origin   = Relve_AR_Router::home_origin();
+		$llms     = array();
+		foreach ( Relve_AR_Router::llms_paths( $s ) as $path ) {
+			$llms[] = $origin . $path;
+		}
+
+		$sample = get_posts(
+			array(
+				'post_type'      => in_array( 'post', $s['post_types'], true ) ? 'post' : ( $s['post_types'] ? $s['post_types'] : 'post' ),
+				'post_status'    => 'publish',
+				'has_password'   => false,
+				'numberposts'    => 1,
+				'orderby'        => 'date',
+				'order'          => 'DESC',
+				'suppress_filters' => false,
+			)
+		);
+		$page = $sample ? get_permalink( $sample[0] ) : home_url( '/' );
+		$md   = Relve_AR_Llms::md_url( $page, home_url( '/' ) );
+		?>
+		<div class="card" style="max-width:none">
+			<h2 class="title"><?php esc_html_e( 'Status', 'relve-agent-ready' ); ?></h2>
+			<table class="widefat striped" style="max-width:60em">
+				<tbody>
+					<tr>
+						<td><?php esc_html_e( 'Serving Markdown', 'relve-agent-ready' ); ?></td>
+						<td><strong><?php echo $s['enabled'] ? esc_html__( 'On', 'relve-agent-ready' ) : esc_html__( 'Off (tick Enabled below)', 'relve-agent-ready' ); ?></strong></td>
+					</tr>
+					<tr>
+						<td><?php esc_html_e( 'Refined files', 'relve-agent-ready' ); ?></td>
+						<td><?php echo esc_html( (string) (int) $count ); ?></td>
+					</tr>
+					<tr>
+						<td><?php esc_html_e( 'llms.txt', 'relve-agent-ready' ); ?></td>
+						<td>
+							<?php
+							if ( ! $s['enabled'] ) {
+								esc_html_e( 'Off while the plugin is disabled.', 'relve-agent-ready' );
+							} elseif ( $serves ) {
+								echo esc_html( implode( '  ', $llms ) );
+							} elseif ( 'off' === $s['llms_mode'] ) {
+								esc_html_e( 'Off (setting).', 'relve-agent-ready' );
+							} elseif ( $yoast ) {
+								esc_html_e( 'Served by Yoast SEO; this plugin stays out of the way (choose "On" to take over).', 'relve-agent-ready' );
+							} else {
+								esc_html_e( 'A real llms.txt file exists in the WordPress folder; the web server serves that one.', 'relve-agent-ready' );
+							}
+							?>
+						</td>
+					</tr>
+				</tbody>
+			</table>
+			<p><?php esc_html_e( 'Test from a terminal (expect Content-Type: text/markdown and x-agent-ready-source):', 'relve-agent-ready' ); ?></p>
+			<pre style="white-space:pre-wrap;background:#f6f7f7;padding:1em;max-width:60em"><?php
+				echo esc_html(
+					'curl -sI -H "Accept: text/markdown" "' . $page . "\"\n"
+					. 'curl -s "' . $md . "\"\n"
+					. 'curl -s "' . ( $llms ? $llms[0] : $origin . Relve_AR_Router::home_path() . '/llms.txt' ) . '"'
+				);
+				?></pre>
+			<p class="description"><?php esc_html_e( 'A page cache or CDN in front of WordPress may still answer an Accept request with cached HTML. That is safe; the .md URL always works. Behind a proxy or Worker, make sure it forwards the Accept header, .md paths and llms.txt to WordPress.', 'relve-agent-ready' ); ?></p>
+		</div>
+		<?php
+	}
+}