@relvehq/agent-ready 0.3.0 → 0.4.0

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

@@ -1,192 +1,192 @@
-<?php
-/**
- * llms.txt (https://llmstxt.org): "# Site name", "> tagline", then sections
- * of links to the `.md` URLs of recent posts and pages (up to 200).
- *
- * Port of @relvehq/agent-ready core/llms.ts (buildLlmsTxt) plus the WordPress
- * side: which posts to list and whether this plugin should answer at all
- * (mode auto|on|off; auto stays off when Yoast serves its own llms.txt or a
- * physical llms.txt file exists).
- *
- * @package Relve_Agent_Ready
- */
-
-if ( ! defined( 'ABSPATH' ) ) {
-	exit;
-}
-
-/**
- * llms.txt builder and mode decision.
- */
-class Relve_AR_Llms {
-
-	/** Max links listed. */
-	const MAX_ENTRIES = 200;
-
-	// ── pure helpers (unit-tested) ────────────────────────────────────────
-
-	/**
-	 * Should the plugin answer llms.txt?
-	 *
-	 * @param string $mode          auto|on|off.
-	 * @param bool   $yoast_serves  Yoast's llms.txt feature is on.
-	 * @param bool   $physical_file A real llms.txt file sits in the web root.
-	 * @return bool
-	 */
-	public static function should_serve( $mode, $yoast_serves, $physical_file = false ) {
-		if ( 'on' === $mode ) {
-			return true;
-		}
-		if ( 'off' === $mode ) {
-			return false;
-		}
-		return ! $yoast_serves && ! $physical_file;
-	}
-
-	/**
-	 * Build the file.
-	 *
-	 * @param string $title    Site name.
-	 * @param string $summary  Tagline.
-	 * @param array  $sections Section name => list of { title, url, description }.
-	 * @return string
-	 */
-	public static function build( $title, $summary, $sections ) {
-		$title = self::one_line( $title );
-		$out   = array( '# ' . ( '' === $title ? 'Site' : $title ) );
-		$sum   = self::one_line( $summary );
-		if ( '' !== $sum ) {
-			$out[] = '> ' . $sum;
-		}
-		foreach ( $sections as $name => $entries ) {
-			$lines = array();
-			foreach ( $entries as $e ) {
-				if ( empty( $e['title'] ) || empty( $e['url'] ) ) {
-					continue;
-				}
-				$t    = str_replace( array( '[', ']' ), '', self::one_line( $e['title'] ) );
-				$desc = isset( $e['description'] ) ? self::one_line( $e['description'] ) : '';
-				$lines[] = '- [' . $t . '](' . Relve_AR_Converter::url_for_markdown( $e['url'] ) . ')' . ( '' !== $desc ? ': ' . $desc : '' );
-			}
-			if ( $lines ) {
-				$out[] = '## ' . self::one_line( $name );
-				$out[] = implode( "\n", $lines );
-			}
-		}
-		return implode( "\n\n", $out ) . "\n";
-	}
-
-	/**
-	 * The `.md` URL of a permalink: "https://s/a/b/" -> "https://s/a/b.md";
-	 * the home URL -> ".../index.md"; a permalink with a query string (plain
-	 * permalinks) gets "format=md" instead.
-	 *
-	 * @param string $permalink Permalink.
-	 * @param string $home_url  Home URL.
-	 * @return string
-	 */
-	public static function md_url( $permalink, $home_url ) {
-		$permalink = explode( '#', (string) $permalink, 2 )[0];
-		if ( false !== strpos( $permalink, '?' ) ) {
-			return $permalink . '&format=md';
-		}
-		if ( rtrim( $permalink, '/' ) === rtrim( (string) $home_url, '/' ) ) {
-			return rtrim( $permalink, '/' ) . '/index.md';
-		}
-		return rtrim( $permalink, '/' ) . '.md';
-	}
-
-	/**
-	 * Collapse whitespace.
-	 *
-	 * @param string $s Text.
-	 * @return string
-	 */
-	private static function one_line( $s ) {
-		return Relve_AR_Markdown_Builder::one_line( (string) $s );
-	}
-
-	// ── WordPress-bound ───────────────────────────────────────────────────
-
-	/**
-	 * Does Yoast SEO serve llms.txt on this site? Checked defensively: Yoast
-	 * active and its "enable_llms_txt" option on. Unsure means no.
-	 *
-	 * @return bool
-	 */
-	public static function yoast_serves() {
-		$serves = false;
-		if ( defined( 'WPSEO_VERSION' ) || class_exists( 'WPSEO_Options' ) ) {
-			$opt    = get_option( 'wpseo' );
-			$serves = is_array( $opt ) && ! empty( $opt['enable_llms_txt'] );
-		}
-		return (bool) apply_filters( 'relve_agent_ready_yoast_serves_llms', $serves );
-	}
-
-	/**
-	 * Is there a physical llms.txt in the WordPress root (the web server
-	 * would answer it before WordPress anyway)?
-	 *
-	 * @return bool
-	 */
-	public static function physical_file_exists() {
-		return defined( 'ABSPATH' ) && file_exists( ABSPATH . 'llms.txt' );
-	}
-
-	/**
-	 * Build this site's llms.txt.
-	 *
-	 * @param array $settings Plugin settings.
-	 * @return string
-	 */
-	public static function generate( $settings ) {
-		$home     = home_url( '/' );
-		$types    = array_values( array_intersect( (array) $settings['post_types'], get_post_types( array( 'public' => true ) ) ) );
-		$sections = array();
-		$left     = self::MAX_ENTRIES;
-		$home_path = Relve_AR_Router::home_path();
-		foreach ( $types as $type ) {
-			if ( $left <= 0 ) {
-				break;
-			}
-			$obj   = get_post_type_object( $type );
-			$name  = $obj && isset( $obj->labels->name ) ? $obj->labels->name : $type;
-			$query = new WP_Query(
-				array(
-					'post_type'           => $type,
-					'post_status'         => 'publish',
-					'has_password'        => false,
-					'posts_per_page'      => $left,
-					'orderby'             => 'post' === $type ? 'date' : 'modified',
-					'order'               => 'DESC',
-					'ignore_sticky_posts' => true,
-					'no_found_rows'       => true,
-				)
-			);
-			$entries = array();
-			foreach ( $query->posts as $p ) {
-				$permalink = get_permalink( $p );
-				if ( ! $permalink ) {
-					continue;
-				}
-				$path = Relve_AR_Negotiation::normalize_path( (string) wp_parse_url( $permalink, PHP_URL_PATH ) );
-				if ( null !== $path && Relve_AR_Negotiation::is_excluded( $path, $settings['excluded'], $home_path ) ) {
-					continue;
-				}
-				$entries[] = array(
-					'title'       => html_entity_decode( wp_strip_all_tags( get_the_title( $p ) ), ENT_QUOTES, 'UTF-8' ),
-					'url'         => self::md_url( $permalink, $home ),
-					'description' => Relve_AR_Markdown_Builder::shorten( Relve_AR_Markdown_Builder::description_for( $p ), 200 ),
-				);
-			}
-			$left             -= count( $entries );
-			$sections[ $name ] = $entries;
-		}
-		$sections = apply_filters( 'relve_agent_ready_llms_sections', $sections );
-		return self::build(
-			html_entity_decode( get_bloginfo( 'name' ), ENT_QUOTES, 'UTF-8' ),
-			html_entity_decode( get_bloginfo( 'description' ), ENT_QUOTES, 'UTF-8' ),
-			$sections
-		);
-	}
-}
+<?php
+/**
+ * llms.txt (https://llmstxt.org): "# Site name", "> tagline", then sections
+ * of links to the `.md` URLs of recent posts and pages (up to 200).
+ *
+ * Port of @relvehq/agent-ready core/llms.ts (buildLlmsTxt) plus the WordPress
+ * side: which posts to list and whether this plugin should answer at all
+ * (mode auto|on|off; auto stays off when Yoast serves its own llms.txt or a
+ * physical llms.txt file exists).
+ *
+ * @package Relve_Agent_Ready
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * llms.txt builder and mode decision.
+ */
+class Relve_AR_Llms {
+
+	/** Max links listed. */
+	const MAX_ENTRIES = 200;
+
+	// ── pure helpers (unit-tested) ────────────────────────────────────────
+
+	/**
+	 * Should the plugin answer llms.txt?
+	 *
+	 * @param string $mode          auto|on|off.
+	 * @param bool   $yoast_serves  Yoast's llms.txt feature is on.
+	 * @param bool   $physical_file A real llms.txt file sits in the web root.
+	 * @return bool
+	 */
+	public static function should_serve( $mode, $yoast_serves, $physical_file = false ) {
+		if ( 'on' === $mode ) {
+			return true;
+		}
+		if ( 'off' === $mode ) {
+			return false;
+		}
+		return ! $yoast_serves && ! $physical_file;
+	}
+
+	/**
+	 * Build the file.
+	 *
+	 * @param string $title    Site name.
+	 * @param string $summary  Tagline.
+	 * @param array  $sections Section name => list of { title, url, description }.
+	 * @return string
+	 */
+	public static function build( $title, $summary, $sections ) {
+		$title = self::one_line( $title );
+		$out   = array( '# ' . ( '' === $title ? 'Site' : $title ) );
+		$sum   = self::one_line( $summary );
+		if ( '' !== $sum ) {
+			$out[] = '> ' . $sum;
+		}
+		foreach ( $sections as $name => $entries ) {
+			$lines = array();
+			foreach ( $entries as $e ) {
+				if ( empty( $e['title'] ) || empty( $e['url'] ) ) {
+					continue;
+				}
+				$t    = str_replace( array( '[', ']' ), '', self::one_line( $e['title'] ) );
+				$desc = isset( $e['description'] ) ? self::one_line( $e['description'] ) : '';
+				$lines[] = '- [' . $t . '](' . Relve_AR_Converter::url_for_markdown( $e['url'] ) . ')' . ( '' !== $desc ? ': ' . $desc : '' );
+			}
+			if ( $lines ) {
+				$out[] = '## ' . self::one_line( $name );
+				$out[] = implode( "\n", $lines );
+			}
+		}
+		return implode( "\n\n", $out ) . "\n";
+	}
+
+	/**
+	 * The `.md` URL of a permalink: "https://s/a/b/" -> "https://s/a/b.md";
+	 * the home URL -> ".../index.md"; a permalink with a query string (plain
+	 * permalinks) gets "format=md" instead.
+	 *
+	 * @param string $permalink Permalink.
+	 * @param string $home_url  Home URL.
+	 * @return string
+	 */
+	public static function md_url( $permalink, $home_url ) {
+		$permalink = explode( '#', (string) $permalink, 2 )[0];
+		if ( false !== strpos( $permalink, '?' ) ) {
+			return $permalink . '&format=md';
+		}
+		if ( rtrim( $permalink, '/' ) === rtrim( (string) $home_url, '/' ) ) {
+			return rtrim( $permalink, '/' ) . '/index.md';
+		}
+		return rtrim( $permalink, '/' ) . '.md';
+	}
+
+	/**
+	 * Collapse whitespace.
+	 *
+	 * @param string $s Text.
+	 * @return string
+	 */
+	private static function one_line( $s ) {
+		return Relve_AR_Markdown_Builder::one_line( (string) $s );
+	}
+
+	// ── WordPress-bound ───────────────────────────────────────────────────
+
+	/**
+	 * Does Yoast SEO serve llms.txt on this site? Checked defensively: Yoast
+	 * active and its "enable_llms_txt" option on. Unsure means no.
+	 *
+	 * @return bool
+	 */
+	public static function yoast_serves() {
+		$serves = false;
+		if ( defined( 'WPSEO_VERSION' ) || class_exists( 'WPSEO_Options' ) ) {
+			$opt    = get_option( 'wpseo' );
+			$serves = is_array( $opt ) && ! empty( $opt['enable_llms_txt'] );
+		}
+		return (bool) apply_filters( 'relve_agent_ready_yoast_serves_llms', $serves );
+	}
+
+	/**
+	 * Is there a physical llms.txt in the WordPress root (the web server
+	 * would answer it before WordPress anyway)?
+	 *
+	 * @return bool
+	 */
+	public static function physical_file_exists() {
+		return defined( 'ABSPATH' ) && file_exists( ABSPATH . 'llms.txt' );
+	}
+
+	/**
+	 * Build this site's llms.txt.
+	 *
+	 * @param array $settings Plugin settings.
+	 * @return string
+	 */
+	public static function generate( $settings ) {
+		$home     = home_url( '/' );
+		$types    = array_values( array_intersect( (array) $settings['post_types'], get_post_types( array( 'public' => true ) ) ) );
+		$sections = array();
+		$left     = self::MAX_ENTRIES;
+		$home_path = Relve_AR_Router::home_path();
+		foreach ( $types as $type ) {
+			if ( $left <= 0 ) {
+				break;
+			}
+			$obj   = get_post_type_object( $type );
+			$name  = $obj && isset( $obj->labels->name ) ? $obj->labels->name : $type;
+			$query = new WP_Query(
+				array(
+					'post_type'           => $type,
+					'post_status'         => 'publish',
+					'has_password'        => false,
+					'posts_per_page'      => $left,
+					'orderby'             => 'post' === $type ? 'date' : 'modified',
+					'order'               => 'DESC',
+					'ignore_sticky_posts' => true,
+					'no_found_rows'       => true,
+				)
+			);
+			$entries = array();
+			foreach ( $query->posts as $p ) {
+				$permalink = get_permalink( $p );
+				if ( ! $permalink ) {
+					continue;
+				}
+				$path = Relve_AR_Negotiation::normalize_path( (string) wp_parse_url( $permalink, PHP_URL_PATH ) );
+				if ( null !== $path && Relve_AR_Negotiation::is_excluded( $path, $settings['excluded'], $home_path ) ) {
+					continue;
+				}
+				$entries[] = array(
+					'title'       => html_entity_decode( wp_strip_all_tags( get_the_title( $p ) ), ENT_QUOTES, 'UTF-8' ),
+					'url'         => self::md_url( $permalink, $home ),
+					'description' => Relve_AR_Markdown_Builder::shorten( Relve_AR_Markdown_Builder::description_for( $p ), 200 ),
+				);
+			}
+			$left             -= count( $entries );
+			$sections[ $name ] = $entries;
+		}
+		$sections = apply_filters( 'relve_agent_ready_llms_sections', $sections );
+		return self::build(
+			html_entity_decode( get_bloginfo( 'name' ), ENT_QUOTES, 'UTF-8' ),
+			html_entity_decode( get_bloginfo( 'description' ), ENT_QUOTES, 'UTF-8' ),
+			$sections
+		);
+	}
+}