thinkrank / includes / core / class-activator.php

class-activator.php in ThinkRank AI SEO – AI SEO Plugin for WordPress: Schema, XML Sitemaps, Meta Tags, Search Console & Local SEO 2.7.0, at includes/core/class-activator.php

414 lines 15.3 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Plugin Activator Class
5	*
6	* Handles plugin activation tasks
7	*
8	* @package ThinkRank\Core
9	* @since 1.0.0
10	*/
11
12	declare(strict_types=1);
13
14	namespace ThinkRank\Core;
15
16	use ThinkRank\Database\Database_Schema;
17
18	// Prevent direct access
19	if (!defined('ABSPATH')) {
20	exit;
21	}
22
23	/**
24	* Activator Class
25	*
26	* Single Responsibility: Handle plugin activation tasks only
27	*
28	* @since 1.0.0
29	*/
30	class Activator {
31
32	/**
33	* Option the uninstaller sets to record a deliberate removal.
34	*
35	* Pro's Free_Plugin_Installer skips its silent auto-install while this is
36	* set, so activating again — the user asking for the plugin back — has to
37	* clear it. Keep in sync with uninstall.php.
38	*/
39	public const UNINSTALLED_OPTION = 'thinkrank_uninstalled';
40
41	/**
42	* Plugin activation tasks
43	*
44	* @return void
45	* @throws \Exception If activation fails
46	*/
47	public function activate(): void {
48	delete_option(self::UNINSTALLED_OPTION);
49
50	$this->check_requirements();
51	$this->create_database_tables();
52	// Both must precede set_default_options(): they read
53	// `thinkrank_version`, which that method creates.
54	$this->retire_sitemap_legacy_fallback();
55	$this->seed_feed_defaults();
56	$this->set_default_options();
57	$this->setup_indexnow_key();
58	$this->schedule_cron_jobs();
59	$this->restore_webroot_artifacts();
60	$this->set_activation_flag();
61
62	// Grant the admin capabilities here rather than waiting for the `init`
63	// hook Role_Manager registers, so the menu is reachable on the very
64	// first admin request after activation.
65	Capability_Manager::ensure();
66	}
67
68	/**
69	* Setup IndexNow API Key
70	*
71	* Generates a unique 128-bit key and creates the key file in the root directory.
72	*
73	* @return void
74	*/
75	private function setup_indexnow_key(): void {
76	$option_name = 'thinkrank_instant_indexing_settings';
77	$settings = get_option($option_name, []);
78
79	// Check if key exists
80	if (empty($settings['api_key'])) {
81	try {
82	// Generate 128-bit key (32 hex characters)
83	// Using bin2hex(random_bytes(16)) as requested
84	$key = bin2hex(random_bytes(16));
85
86	// Save to options
87	$settings['api_key'] = $key;
88
89	// Initialize default post types if not set
90	if (!isset($settings['auto_submit_post_types'])) {
91	$settings['auto_submit_post_types'] = ['post', 'page'];
92	}
93
94	update_option($option_name, $settings);
95
96	// Create the key file in WordPress root using WP_Filesystem
97	$file_path = ABSPATH . $key . '.txt';
98	global $wp_filesystem;
99	if (!function_exists('WP_Filesystem')) {
100	require_once ABSPATH . 'wp-admin/includes/file.php';
101	}
102	WP_Filesystem();
103	if ($wp_filesystem && $wp_filesystem->is_writable(ABSPATH)) {
104	$wp_filesystem->put_contents($file_path, $key, FS_CHMOD_FILE);
105	}
106	} catch (\Exception $e) {
107	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
108	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
109	error_log('ThinkRank: Failed to create IndexNow key file: ' . $e->getMessage());
110	}
111	}
112	}
113	}
114
115	/**
116	* Check system requirements
117	*
118	* @return void
119	* @throws \Exception If requirements not met
120	*/
121	private function check_requirements(): void {
122	// PHP version check
123	if (version_compare(PHP_VERSION, '7.4', '<')) {
124	throw new \Exception('ThinkRank requires PHP 7.4 or higher');
125	}
126
127	// WordPress version check
128	if (version_compare(get_bloginfo('version'), '6.0', '<')) {
129	throw new \Exception('ThinkRank requires WordPress 6.0 or higher');
130	}
131
132	// Required PHP extensions
133	$required_extensions = ['curl', 'json', 'mbstring'];
134	foreach ($required_extensions as $extension) {
135	if (!extension_loaded($extension)) {
136	throw new \Exception(sprintf("Required PHP extension '%s' is not loaded", esc_html($extension)));
137	}
138	}
139
140	// Check if we can write to WordPress root directory (for robots.txt, llms.txt, sitemaps)
141	if (!wp_is_writable(ABSPATH)) {
142	// Log warning but don't block activation — some hosts restrict ABSPATH writes
143	// and file-writing features will gracefully degrade via WP_Filesystem checks
144	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
145	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
146	error_log('ThinkRank: WordPress root directory is not writable. Some features (robots.txt, llms.txt, sitemaps) may not work.');
147	}
148	}
149	}
150
151	/**
152	* Create database tables
153	*
154	* Uses the consolidated Database_Schema class to create all 11 ThinkRank tables:
155	* - SEO Tables (7): Settings, Analysis, Keywords, Schema, Social, Performance, Local
156	* - AI/Core Tables (4): AI Cache, AI Usage, Content Briefs, SEO Scores
157	*
158	* @return void
159	* @throws \Exception If table creation fails
160	*/
161	private function create_database_tables(): void {
162	try {
163	// Use the Database_Schema class to create all 11 ThinkRank tables
164	$schema = new Database_Schema();
165	$results = $schema->create_tables();
166
167	if (!$results['success']) {
168	$error_message = 'Failed to create database tables: ' . implode(', ', $results['errors']);
169	throw new \Exception($error_message);
170	}
171
172	// Add performance indexes for Phase 2 optimization
173	// Best effort: activation continues if the performance indexes
174	// cannot be created.
175	$schema->add_performance_indexes();
176
177	// Database tables created successfully
178
179	} catch (\Exception $e) {
180	throw new \Exception('Database table creation failed: ' . esc_html($e->getMessage()));
181	}
182	}
183
184
185
186	/**
187	* On a brand-new install, close the pre-2.1.1 sitemap ownership fallback
188	* before it can ever open.
189	*
190	* {@see thinkrank_webroot_sitemap_is_ours()} keeps one narrow escape hatch:
191	* a sitemap written before 2.1.1 with `enable_styling` off carries neither
192	* the marker nor our XSL href, so it can only be recognised by the name the
193	* stored settings derive. That fallback is gated on this install never
194	* having written a marked sitemap — but "never written one" describes two
195	* completely different sites:
196	*
197	* - a pre-2.1.1 install that has not regenerated since upgrading, which
198	* is exactly what the fallback exists to recover; and
199	* - a fresh install that simply has not generated yet, which cannot have
200	* a legacy file of ours on disk at all.
201	*
202	* On the second, the fallback has nothing to recover and can only delete
203	* somebody else's sitemap from one of the canonical names — #515 again, in
204	* a site that never had the problem the fallback addresses. It is not a
205	* narrow window either: `regenerate_sitemap_from_settings()` returns early
206	* while the master `enabled` flag is off, so a site with sitemaps disabled
207	* and styling saved off never records a marked write, and stays exposed for
208	* as long as it stays in that configuration.
209	*
210	* Recording the marker here on a fresh install separates the two cases. An
211	* upgrade does not reach this code — WordPress does not re-run the
212	* activation hook on update — so a genuine pre-2.1.1 site keeps the
213	* fallback until its first marked write, exactly as before.
214	*
215	* `thinkrank_version` is the signal: set_default_options() adds it only
216	* when absent and never updates it, so it is missing on the very first
217	* activation and present on every one after.
218	*
219	* @since 2.1.1
220	*
221	* @return void
222	*/
223	private function retire_sitemap_legacy_fallback(): void {
224	if (get_option('thinkrank_version') !== false) {
225	return;
226	}
227
228	require_once THINKRANK_PLUGIN_DIR . 'includes/cleanup-webroot.php';
229
230	add_option(THINKRANK_SITEMAP_MARKED_WRITE_OPTION, '1', '', false);
231	}
232
233	/**
234	* Give a brand-new install the feed posture the competitors ship with.
235	*
236	* The feed controls (#635) default to off in
237	* {@see Site_Identity_Manager::get_default_settings()}, and they have to:
238	* two of the three change what a site already publishes. Signing every
239	* entry adds a line to what existing subscribers receive, and noindexing
240	* feeds withdraws URLs a site may have had indexed for years — on a podcast
241	* site, whose feed has to stay indexable, silently at that. Neither belongs
242	* in a plugin update.
243	*
244	* A first install has no subscribers and no indexed feed, so there is
245	* nothing to change and the protective defaults are simply the right
246	* starting point — which is what The SEO Framework, Yoast and Rank Math all
247	* ship. Seeding them here rather than in the defaults is what separates the
248	* two cases.
249	*
250	* Excerpt-only is left off even here: it changes what readers get rather
251	* than what scrapers can take, and that is the site owner's call.
252	*
253	* Same signal and same reasoning as {@see self::retire_sitemap_legacy_fallback()}:
254	* `thinkrank_version` is absent only on the very first activation, and an
255	* upgrade does not re-run the activation hook at all.
256	*
257	* @since 2.7.0
258	*
259	* @return void
260	*/
261	private function seed_feed_defaults(): void {
262	if (get_option('thinkrank_version') !== false) {
263	return;
264	}
265
266	$manager = new \ThinkRank\SEO\Site_Identity_Manager();
267
268	$manager->save_settings(
269	'site',
270	null,
271	[
272	'feed_source_link' => true,
273	'feed_noindex' => true,
274	]
275	);
276	}
277
278	/**
279	* Set default plugin options
280	*
281	* @return void
282	*/
283	private function set_default_options(): void {
284	$default_options = [
285	'thinkrank_version' => THINKRANK_VERSION,
286
287	'thinkrank_ai_provider' => \ThinkRank\Core\Settings::AI_PROVIDER_NONE,
288	'thinkrank_cache_duration' => 3600, // 1 hour
289	'thinkrank_max_requests_per_minute' => 10,
290	'thinkrank_enable_logging' => true,
291	'thinkrank_auto_optimize' => false,
292	'thinkrank_seo_score_threshold' => 70,
293	];
294
295	foreach ($default_options as $option_name => $option_value) {
296	if (get_option($option_name) === false) {
297	add_option($option_name, $option_value);
298	}
299	}
300	}
301
302
303	/**
304	* Republish the web-root artifacts deactivation took away.
305	*
306	* Deactivation removes the published sitemap, robots.txt and llms.txt so an
307	* inactive ThinkRank stops shadowing whatever the user switched to (#510).
308	* That is only safe if switching the plugin back on puts them back, which is
309	* what this does.
310	*
311	* Restores strictly what {@see Deactivator::REPUBLISH_OPTION} recorded as
312	* having been removed — never "everything the settings would allow", which
313	* on a fresh install would publish files the site never had.
314	*
315	* The sitemap goes through schedule_regeneration() rather than being built
316	* inline: a full rebuild on a large site is far too slow to sit inside an
317	* activation request, and the debounced hook already respects the master
318	* `enabled` flag. robots.txt and llms.txt are single small writes, so they
319	* happen here.
320	*
321	* @since 2.1.0
322	*
323	* @return void
324	*/
325	private function restore_webroot_artifacts(): void {
326	$republish = get_option(Deactivator::REPUBLISH_OPTION, null);
327
328	if ($republish === null) {
329	// No recorded deactivation — a first install, or an activation that
330	// already consumed the record.
331	return;
332	}
333
334	// Consume it first. A restore that fatals must not re-run on every
335	// subsequent activation, and each entry below is independently guarded.
336	delete_option(Deactivator::REPUBLISH_OPTION);
337
338	if (!is_array($republish)) {
339	return;
340	}
341
342	try {
343	if (in_array('sitemap', $republish, true) && class_exists('ThinkRank\\SEO\\Sitemap_Generator')) {
344	// Read-only instance: the hook-registering one would bind a
345	// second set of content-change listeners to this request.
346	(new \ThinkRank\SEO\Sitemap_Generator(false))->schedule_regeneration();
347	}
348
349	if (in_array('robots', $republish, true) && class_exists('ThinkRank\\SEO\\Site_Identity_Manager')) {
350	(new \ThinkRank\SEO\Site_Identity_Manager())->sync_robots_txt_file();
351	}
352
353	if (in_array('llms', $republish, true) && class_exists('ThinkRank\\SEO\\LLMs_Txt_Manager')) {
354	$llms = new \ThinkRank\SEO\LLMs_Txt_Manager();
355	$content = $llms->get_published_content();
356
357	// write_llms_txt_to_file() enforces the enabled toggle and the
358	// delivery mode itself, so an empty document is the only case
359	// worth short-circuiting here.
360	if ($content !== '') {
361	$llms->write_llms_txt_to_file($content);
362	}
363	}
364	} catch (\Throwable $e) {
365	// A failed republish must not block activation — the user would be
366	// left unable to switch the plugin on at all. The artifacts rebuild
367	// on the next content or settings save.
368	if (defined('WP_DEBUG') && WP_DEBUG) {
369	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
370	error_log('ThinkRank: failed to restore web-root artifacts: ' . $e->getMessage());
371	}
372	}
373	}
374
375	/**
376	* Schedule cron jobs
377	*
378	* @return void
379	*/
380	private function schedule_cron_jobs(): void {
381
382	// Schedule cache cleanup
383	if (!wp_next_scheduled('thinkrank_cache_cleanup')) {
384	wp_schedule_event(time(), 'daily', 'thinkrank_cache_cleanup');
385	}
386
387	// Schedule usage analytics
388	if (!wp_next_scheduled('thinkrank_usage_analytics')) {
389	wp_schedule_event(time(), 'weekly', 'thinkrank_usage_analytics');
390	}
391	}
392
393	/**
394	* Set activation flag for first-time setup
395	*
396	* @return void
397	*/
398	private function set_activation_flag(): void {
399	update_option('thinkrank_activated', true);
400	update_option('thinkrank_activation_time', time());
401
402	// Set flag for showing welcome screen
403	update_option('thinkrank_show_welcome', true);
404
405	// Trigger a one-time redirect to the Setup Wizard on the next admin load,
406	// but only when the wizard has not already been completed. A short-lived
407	// transient is used so it auto-expires and never fires for bulk/network
408	// activations that skip the redirect window.
409	if (!get_option('thinkrank_setup_wizard_completed')) {
410	set_transient('thinkrank_setup_wizard_redirect', 1, 60);
411	}
412	}
413	}
414