hostinger / includes / LlmsTxtGenerator.php

LlmsTxtGenerator.php in Hostinger Tools 3.0.76, at includes/LlmsTxtGenerator.php

189 lines 5.0 KB

Raw Download Zip

1	<?php
2
3	namespace Hostinger;
4
5	use Hostinger\Admin\PluginSettings;
6
7	defined( 'ABSPATH' ) \|\| exit;
8
9	class LlmsTxtGenerator {
10
11	public const HOSTINGER_LLMSTXT_FILENAME = 'llms.txt';
12	public const HOSTINGER_LLMSTXT_SIGNATURE = '[comment]: # (Generated by Hostinger Tools Plugin)';
13
14	protected const HOSTINGER_LLMSTXT_SUPPORTED_POST_TYPES = array(
15	'post',
16	'page',
17	);
18	protected const UTF8_BOM = "\xEF\xBB\xBF";
19
20	protected PluginSettings $plugin_settings;
21
22
23	public function __construct( PluginSettings $plugin_settings ) {
24	$this->plugin_settings = $plugin_settings;
25	add_action( 'init', array( $this, 'init' ) );
26	}
27
28	public function init(): void {
29	if ( wp_doing_ajax() \|\| wp_doing_cron() \|\| ! current_user_can( 'manage_options' ) ) {
30	return;
31	}
32
33	$settings = $this->plugin_settings->get_plugin_settings();
34
35	if ( $settings->get_enable_llms_txt() && ! $this->llmstxt_file_exists() ) {
36	$this->generate();
37	}
38
39	$this->init_hooks();
40	}
41
42	public function on_settings_update( bool $is_enabled ): void {
43	if ( $is_enabled ) {
44	$this->generate();
45	} else {
46	$this->delete();
47	}
48	}
49
50	public function is_user_generated_file(): bool {
51	if ( ! $this->llmstxt_file_exists() ) {
52	return false;
53	}
54
55	global $wp_filesystem;
56	$this->init_wp_filesystem();
57	$content = $wp_filesystem->get_contents( $this->get_llmstxt_file_path() );
58
59	if ( $content === false ) {
60	return false;
61	}
62
63	return ! str_contains( $content, self::HOSTINGER_LLMSTXT_SIGNATURE );
64	}
65
66	public function on_post_status_change( string $new_status, string $old_status, \WP_Post $post ): void {
67	if ( ! $this->is_post_type_supported( $post->post_type ) ) {
68	return;
69	}
70
71	if ( $new_status === 'publish' \|\| $old_status === 'publish' ) {
72	$this->generate();
73	}
74	}
75
76	public function on_blog_change( mixed $old_value, mixed $new_value ): void {
77	if ( $old_value !== $new_value ) {
78	$this->generate();
79	}
80	}
81
82	public function get_content(): string {
83	$content = self::UTF8_BOM;
84	$content .= $this->inject_title();
85	$content .= $this->inject_site_description();
86	$content .= $this->inject_items( $this->get_by_post_type( 'post' ), 'Posts' );
87	$content .= $this->inject_items( $this->get_by_post_type( 'page' ), 'Pages' );
88	$content .= $this->inject_signature();
89
90	return $content;
91	}
92
93	public function init_hooks(): void {
94	add_action( 'transition_post_status', array( $this, 'on_post_status_change' ), 10, 3 );
95	add_action( 'hostinger_tools_setting_enable_llms_txt_update', array( $this, 'on_settings_update' ) );
96	add_action( 'update_option_blogname', array( $this, 'on_blog_change' ), 10, 2 );
97	add_action( 'update_option_blogdescription', array( $this, 'on_blog_change' ), 10, 2 );
98	}
99
100	protected function generate(): void {
101	if ( $this->is_user_generated_file() ) {
102	return;
103	}
104
105	global $wp_filesystem;
106	$this->init_wp_filesystem();
107	$wp_filesystem->put_contents( $this->get_llmstxt_file_path(), $this->get_content() );
108	}
109
110	protected function delete(): void {
111	if ( $this->llmstxt_file_exists() && ! $this->is_user_generated_file() ) {
112	global $wp_filesystem;
113	$this->init_wp_filesystem();
114	$wp_filesystem->delete( $this->get_llmstxt_file_path() );
115	}
116	}
117
118	protected function get_llmstxt_file_path(): string {
119	return ABSPATH . self::HOSTINGER_LLMSTXT_FILENAME;
120	}
121
122	protected function llmstxt_file_exists(): bool {
123	return file_exists( $this->get_llmstxt_file_path() );
124	}
125
126	protected function is_post_type_supported( string $post_type ): bool {
127	return in_array( $post_type, self::HOSTINGER_LLMSTXT_SUPPORTED_POST_TYPES, true );
128	}
129
130	protected function get_by_post_type( string $post_type, int $limit = 100 ): array {
131	$args = array(
132	'post_type' => $post_type,
133	'post_status' => 'publish',
134	'fields' => 'ids',
135	'posts_per_page' => apply_filters( 'hostinger_llmstext_item_limit', $limit, $post_type ),
136	);
137
138	return get_posts( $args );
139	}
140
141	protected function inject_site_description(): string {
142	$description = get_bloginfo( 'description' );
143	return $description ? "> $description\n\n" : '';
144	}
145
146	protected function inject_title(): string {
147	$title = get_bloginfo( 'name' ) ? get_bloginfo( 'name' ) : site_url();
148	return "# $title\n\n";
149	}
150
151	protected function inject_signature(): string {
152	return "\n\n" . self::HOSTINGER_LLMSTXT_SIGNATURE;
153	}
154
155	protected function inject_items( array $items, string $title ): string {
156	if ( empty( $items ) ) {
157	return '';
158	}
159
160	$content = "\n## $title\n\n";
161
162	foreach ( $items as $item ) {
163	$post = get_post( $item );
164	$title = $post->post_title;
165	$permalink = get_permalink( $post );
166	$excerpt = $this->prepare_excerpt( $post );
167
168	$content .= "- [$title]($permalink)";
169	if ( $excerpt ) {
170	$content .= ": $excerpt";
171	}
172
173	$content .= "\n";
174	}
175
176	return $content;
177	}
178
179	protected function prepare_excerpt( \WP_Post $item ): string {
180	return html_entity_decode( wp_trim_excerpt( $item->post_excerpt, $item ) );
181	}
182
183	protected function init_wp_filesystem() {
184	global $wp_filesystem;
185	require_once ABSPATH . '/wp-admin/includes/file.php';
186	WP_Filesystem();
187	}
188	}
189