thinkrank / includes / abilities / settings / class-update-llms-txt-settings.php

class-update-llms-txt-settings.php in ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO 2.4.0, at includes/abilities/settings/class-update-llms-txt-settings.php

206 lines 5.4 KB

Raw Download Zip

1	<?php
2	/**
3	* Update llms.txt settings ability.
4	*
5	* @package ThinkRank\Abilities\Settings
6	*/
7
8	declare(strict_types=1);
9
10	namespace ThinkRank\Abilities\Settings;
11
12	use ThinkRank\Abilities\Ability_Base;
13	use ThinkRank\SEO\LLMs_Txt_Manager;
14
15	if ( ! defined( 'ABSPATH' ) ) {
16	exit; // Exit if accessed directly.
17	}
18
19	/**
20	* Updates ThinkRank llms.txt settings.
21	*
22	* These settings feed the AI-oriented llms.txt file describing the site to
23	* language models, persisted through the LLMs_Txt_Manager SEO manager.
24	*/
25	class Update_Llms_Txt_Settings extends Ability_Base {
26	/**
27	* Boolean-typed llms.txt keys.
28	*/
29	private const BOOL_KEYS = [
30	'enabled',
31	'auto_generate',
32	];
33
34	/**
35	* String-typed llms.txt keys (multi-line content preserved).
36	*/
37	private const STRING_KEYS = [
38	'delivery_mode',
39	'site_name',
40	'website_description',
41	'key_features',
42	'target_audience',
43	'business_type',
44	'technical_stack',
45	'development_approach',
46	'setup_instructions',
47	'ai_context_custom',
48	'documentation_links',
49	'technical_links',
50	'optional_links',
51	'custom_sections',
52	];
53
54	/**
55	* Constructor.
56	*/
57	public function __construct() {
58	$this->id = 'thinkrank/update-llms-txt-settings';
59	$this->label = __( 'Update ThinkRank llms.txt Settings', 'thinkrank' );
60	$this->description = __( 'Update ThinkRank llms.txt settings, which describe the site to AI language models via the llms.txt file. Read the current values with get-llms-txt-settings first, then publish-llms-txt to write the file.', 'thinkrank' );
61	}
62
63	/**
64	* {@inheritDoc}
65	*
66	* @return array<string, bool\|float\|string>
67	*/
68	public function get_annotations() {
69	return [
70	'readonly' => false,
71	'destructive' => true,
72	'idempotent' => true,
73	'priority' => 2.0,
74	'openWorldHint' => false,
75	];
76	}
77
78	/**
79	* Build the JSON schema properties for llms.txt settings.
80	*
81	* @return array<string, mixed>
82	*/
83	private static function schema_properties() {
84	$props = [];
85
86	foreach ( self::BOOL_KEYS as $key ) {
87	$props[ $key ] = [ 'type' => 'boolean' ];
88	}
89	foreach ( self::STRING_KEYS as $key ) {
90	$props[ $key ] = [ 'type' => 'string' ];
91	}
92
93	$props['delivery_mode']['enum'] = [ 'auto', 'static', 'dynamic' ];
94	$props['delivery_mode']['description'] = __( 'How /llms.txt is served: "static" writes a physical file the web server answers, "dynamic" keeps the document in WordPress and serves it from PHP as UTF-8, "auto" prefers static on Apache/LiteSpeed but falls back to dynamic when the published file turns out to be served without a character set.', 'thinkrank' );
95
96	return $props;
97	}
98
99	/**
100	* {@inheritDoc}
101	*
102	* @return array<string, mixed>
103	*/
104	public function get_input_schema() {
105	return [
106	'type' => 'object',
107	'additionalProperties' => false,
108	'properties' => [
109	'settings' => [
110	'type' => 'object',
111	'description' => __( 'llms.txt settings to update.', 'thinkrank' ),
112	'properties' => self::schema_properties(),
113	],
114	],
115	'required' => [ 'settings' ],
116	];
117	}
118
119	/**
120	* {@inheritDoc}
121	*
122	* @return array<string, mixed>
123	*/
124	public function get_output_schema() {
125	return [
126	'type' => 'object',
127	'properties' => [
128	'success' => [ 'type' => 'boolean' ],
129	'message' => [ 'type' => 'string' ],
130	],
131	];
132	}
133
134	/**
135	* Execute ability.
136	*
137	* @param array<string, mixed> $input Ability input payload.
138	* @return array<string, mixed>\|\WP_Error
139	*/
140	public function execute( $input ) {
141	$settings = isset( $input['settings'] ) && is_array( $input['settings'] ) ? $input['settings'] : [];
142
143	if ( empty( $settings ) ) {
144	return new \WP_Error(
145	'thinkrank_missing_llms_txt_settings_payload',
146	__( 'A llms.txt settings payload is required.', 'thinkrank' ),
147	[ 'status' => 400 ]
148	);
149	}
150
151	$mgr = new LLMs_Txt_Manager();
152	$merged = $mgr->get_settings( 'site', null );
153	$found = false;
154
155	foreach ( self::BOOL_KEYS as $key ) {
156	if ( array_key_exists( $key, $settings ) ) {
157	$merged[ $key ] = (bool) $settings[ $key ];
158	$found = true;
159	}
160	}
161	foreach ( self::STRING_KEYS as $key ) {
162	if ( array_key_exists( $key, $settings ) ) {
163	$merged[ $key ] = sanitize_textarea_field( (string) $settings[ $key ] );
164	$found = true;
165	}
166	}
167
168	if ( ! $found ) {
169	return new \WP_Error(
170	'thinkrank_no_valid_llms_txt_setting_keys',
171	__( 'No valid llms.txt setting keys were provided.', 'thinkrank' ),
172	[ 'status' => 400 ]
173	);
174	}
175
176	$result = $mgr->save_settings( 'site', null, $merged );
177
178	// A disable-save may persist the settings yet fail to remove the published
179	// file, so surface that partial failure instead of reporting plain success.
180	if ( $result && $mgr->unpublish_failed() ) {
181	return [
182	'success' => true,
183	'file_unpublished' => false,
184	'message' => __( 'Settings were saved, but the published llms.txt file could not be removed and may still be served. Please remove it manually.', 'thinkrank' ),
185	];
186	}
187
188	// Likewise for a delivery-mode switch that could not move the published
189	// document — /llms.txt is still on the old path.
190	$delivery_warning = $mgr->delivery_switch_warning();
191	if ( $result && '' !== $delivery_warning ) {
192	return [
193	'success' => true,
194	'message' => $delivery_warning,
195	];
196	}
197
198	return [
199	'success' => (bool) $result,
200	'message' => (bool) $result
201	? __( 'llms.txt settings updated.', 'thinkrank' )
202	: __( 'Failed to update llms.txt settings.', 'thinkrank' ),
203	];
204	}
205	}
206