← All changes | includes/core/class-activator.php +213 -15 1.28.0 → 2.9.0 View file →

		@@ -29,19 +29,35 @@
29	29	*/
30	30	class Activator {
31	31
32	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	+ /**
33	42	* Plugin activation tasks
34		- *
	43	+ *
35	44	* @return void
36	45	* @throws \Exception If activation fails
37	46	*/
38	47	public function activate(): void {
	48	+ delete_option(self::UNINSTALLED_OPTION);
	49	+
39	50	$this->check_requirements();
40	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();
41	56	$this->set_default_options();
42	57	$this->setup_indexnow_key();
43	58	$this->schedule_cron_jobs();
	59	+ $this->restore_webroot_artifacts();
44	60	$this->set_activation_flag();
45	61
46	62	// Grant the admin capabilities here rather than waiting for the `init`
47	63	// hook Role_Manager registers, so the menu is reachable on the very
		@@ -103,10 +119,10 @@
103	119	* @throws \Exception If requirements not met
104	120	*/
105	121	private function check_requirements(): void {
106	122	// PHP version check
107		- if (version_compare(PHP_VERSION, '8.0', '<')) {
108		- throw new \Exception('ThinkRank requires PHP 8.0 or higher');
	123	+ if (version_compare(PHP_VERSION, '7.4', '<')) {
	124	+ throw new \Exception('ThinkRank requires PHP 7.4 or higher');
109	125	}
110	126
111	127	// WordPress version check
112	128	if (version_compare(get_bloginfo('version'), '6.0', '<')) {
		@@ -120,15 +136,34 @@
120	136	throw new \Exception(sprintf("Required PHP extension '%s' is not loaded", esc_html($extension)));
121	137	}
122	138	}
123	139
124		- // Check if we can write to WordPress root directory (for robots.txt, llms.txt, sitemaps)
125		- if (!wp_is_writable(ABSPATH)) {
126		- // Log warning but don't block activation — some hosts restrict ABSPATH writes
127		- // and file-writing features will gracefully degrade via WP_Filesystem checks
	140	+ // Check if we can write to WordPress root directory (for robots.txt, llms.txt,
	141	+ // the Instant Indexing key file). Never blocks activation — some hosts restrict
	142	+ // ABSPATH writes by design.
	143	+ //
	144	+ // The result is recorded rather than only logged. It used to reach error_log()
	145	+ // and only under WP_DEBUG, so on a production site nobody was ever told, and the
	146	+ // features that need it failed later with messages describing the symptom rather
	147	+ // than the cause (#753). Webroot_Writable_Notice re-evaluates the condition live —
	148	+ // permissions change without a reactivation — and this value only distinguishes
	149	+ // "never worked here" from "worked until the host changed something".
	150	+ $writable = wp_is_writable(ABSPATH);
	151	+
	152	+ update_option(
	153	+ \ThinkRank\Admin\Webroot_Writable_Notice::OPT_ACTIVATION_STATE,
	154	+ $writable ? 'writable' : 'not-writable',
	155	+ false
	156	+ );
	157	+
	158	+ if (!$writable) {
	159	+ // A fresh activation on a broken root should warn even if a previous
	160	+ // install's dismissal is still on record.
	161	+ delete_option(\ThinkRank\Admin\Webroot_Writable_Notice::OPT_DISMISSED);
	162	+
128	163	if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
129	164	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
130		- error_log('ThinkRank: WordPress root directory is not writable. Some features (robots.txt, llms.txt, sitemaps) may not work.');
	165	+ error_log('ThinkRank: WordPress root directory is not writable. robots.txt, llms.txt and the Instant Indexing key file cannot be published; the sitemap falls back to dynamic delivery.');
131	166	}
132	167	}
133	168	}
134	169
		@@ -153,12 +188,11 @@
153	188	throw new \Exception($error_message);
154	189	}
155	190
156	191	// Add performance indexes for Phase 2 optimization
157		- $index_results = $schema->add_performance_indexes();
158		- if (!$index_results) {
159		- // Performance indexes could not be created - activation continues
160		- }
	192	+ // Best effort: activation continues if the performance indexes
	193	+ // cannot be created.
	194	+ $schema->add_performance_indexes();
161	195
162	196	// Database tables created successfully
163	197
164	198	} catch (\Exception $e) {
		@@ -168,8 +202,100 @@
168	202
169	203
170	204
171	205	/**
	206	+ * On a brand-new install, close the pre-2.1.1 sitemap ownership fallback
	207	+ * before it can ever open.
	208	+ *
	209	+ * {@see thinkrank_webroot_sitemap_is_ours()} keeps one narrow escape hatch:
	210	+ * a sitemap written before 2.1.1 with `enable_styling` off carries neither
	211	+ * the marker nor our XSL href, so it can only be recognised by the name the
	212	+ * stored settings derive. That fallback is gated on this install never
	213	+ * having written a marked sitemap — but "never written one" describes two
	214	+ * completely different sites:
	215	+ *
	216	+ * - a pre-2.1.1 install that has not regenerated since upgrading, which
	217	+ * is exactly what the fallback exists to recover; and
	218	+ * - a fresh install that simply has not generated yet, which cannot have
	219	+ * a legacy file of ours on disk at all.
	220	+ *
	221	+ * On the second, the fallback has nothing to recover and can only delete
	222	+ * somebody else's sitemap from one of the canonical names — #515 again, in
	223	+ * a site that never had the problem the fallback addresses. It is not a
	224	+ * narrow window either: `regenerate_sitemap_from_settings()` returns early
	225	+ * while the master `enabled` flag is off, so a site with sitemaps disabled
	226	+ * and styling saved off never records a marked write, and stays exposed for
	227	+ * as long as it stays in that configuration.
	228	+ *
	229	+ * Recording the marker here on a fresh install separates the two cases. An
	230	+ * upgrade does not reach this code — WordPress does not re-run the
	231	+ * activation hook on update — so a genuine pre-2.1.1 site keeps the
	232	+ * fallback until its first marked write, exactly as before.
	233	+ *
	234	+ * `thinkrank_version` is the signal: set_default_options() adds it only
	235	+ * when absent and never updates it, so it is missing on the very first
	236	+ * activation and present on every one after.
	237	+ *
	238	+ * @since 2.1.1
	239	+ *
	240	+ * @return void
	241	+ */
	242	+ private function retire_sitemap_legacy_fallback(): void {
	243	+ if (get_option('thinkrank_version') !== false) {
	244	+ return;
	245	+ }
	246	+
	247	+ require_once THINKRANK_PLUGIN_DIR . 'includes/cleanup-webroot.php';
	248	+
	249	+ add_option(THINKRANK_SITEMAP_MARKED_WRITE_OPTION, '1', '', false);
	250	+ }
	251	+
	252	+ /**
	253	+ * Give a brand-new install the feed posture the competitors ship with.
	254	+ *
	255	+ * The feed controls (#635) default to off in
	256	+ * {@see Site_Identity_Manager::get_default_settings()}, and they have to:
	257	+ * two of the three change what a site already publishes. Signing every
	258	+ * entry adds a line to what existing subscribers receive, and noindexing
	259	+ * feeds withdraws URLs a site may have had indexed for years — on a podcast
	260	+ * site, whose feed has to stay indexable, silently at that. Neither belongs
	261	+ * in a plugin update.
	262	+ *
	263	+ * A first install has no subscribers and no indexed feed, so there is
	264	+ * nothing to change and the protective defaults are simply the right
	265	+ * starting point — which is what The SEO Framework, Yoast and Rank Math all
	266	+ * ship. Seeding them here rather than in the defaults is what separates the
	267	+ * two cases.
	268	+ *
	269	+ * Excerpt-only is left off even here: it changes what readers get rather
	270	+ * than what scrapers can take, and that is the site owner's call.
	271	+ *
	272	+ * Same signal and same reasoning as {@see self::retire_sitemap_legacy_fallback()}:
	273	+ * `thinkrank_version` is absent only on the very first activation, and an
	274	+ * upgrade does not re-run the activation hook at all.
	275	+ *
	276	+ * @since 2.7.0
	277	+ *
	278	+ * @return void
	279	+ */
	280	+ private function seed_feed_defaults(): void {
	281	+ if (get_option('thinkrank_version') !== false) {
	282	+ return;
	283	+ }
	284	+
	285	+ $manager = new \ThinkRank\SEO\Site_Identity_Manager();
	286	+
	287	+ $manager->save_settings(
	288	+ 'site',
	289	+ null,
	290	+ [
	291	+ 'feed_source_link' => true,
	292	+ 'feed_noindex' => true,
	293	+ ]
	294	+ );
	295	+ }
	296	+
	297	+ /**
172	298	* Set default plugin options
173	299	*
174	300	* @return void
175	301	*/
		@@ -176,11 +302,11 @@
176	302	private function set_default_options(): void {
177	303	$default_options = [
178	304	'thinkrank_version' => THINKRANK_VERSION,
179	305
180		- 'thinkrank_ai_provider' => 'openai',
	306	+ 'thinkrank_ai_provider' => \ThinkRank\Core\Settings::AI_PROVIDER_NONE,
181	307	'thinkrank_cache_duration' => 3600, // 1 hour
182		- 'thinkrank_max_requests_per_minute' => 10,
	308	+ 'thinkrank_max_requests_per_minute' => 0,
183	309	'thinkrank_enable_logging' => true,
184	310	'thinkrank_auto_optimize' => false,
185	311	'thinkrank_seo_score_threshold' => 70,
186	312	];
		@@ -193,10 +319,82 @@
193	319	}
194	320
195	321
196	322	/**
	323	+ * Republish the web-root artifacts deactivation took away.
	324	+ *
	325	+ * Deactivation removes the published sitemap, robots.txt and llms.txt so an
	326	+ * inactive ThinkRank stops shadowing whatever the user switched to (#510).
	327	+ * That is only safe if switching the plugin back on puts them back, which is
	328	+ * what this does.
	329	+ *
	330	+ * Restores strictly what {@see Deactivator::REPUBLISH_OPTION} recorded as
	331	+ * having been removed — never "everything the settings would allow", which
	332	+ * on a fresh install would publish files the site never had.
	333	+ *
	334	+ * The sitemap goes through schedule_regeneration() rather than being built
	335	+ * inline: a full rebuild on a large site is far too slow to sit inside an
	336	+ * activation request, and the debounced hook already respects the master
	337	+ * `enabled` flag. robots.txt and llms.txt are single small writes, so they
	338	+ * happen here.
	339	+ *
	340	+ * @since 2.1.0
	341	+ *
	342	+ * @return void
	343	+ */
	344	+ private function restore_webroot_artifacts(): void {
	345	+ $republish = get_option(Deactivator::REPUBLISH_OPTION, null);
	346	+
	347	+ if ($republish === null) {
	348	+ // No recorded deactivation — a first install, or an activation that
	349	+ // already consumed the record.
	350	+ return;
	351	+ }
	352	+
	353	+ // Consume it first. A restore that fatals must not re-run on every
	354	+ // subsequent activation, and each entry below is independently guarded.
	355	+ delete_option(Deactivator::REPUBLISH_OPTION);
	356	+
	357	+ if (!is_array($republish)) {
	358	+ return;
	359	+ }
	360	+
	361	+ try {
	362	+ if (in_array('sitemap', $republish, true) && class_exists('ThinkRank\\SEO\\Sitemap_Generator')) {
	363	+ // Read-only instance: the hook-registering one would bind a
	364	+ // second set of content-change listeners to this request.
	365	+ (new \ThinkRank\SEO\Sitemap_Generator(false))->schedule_regeneration();
	366	+ }
	367	+
	368	+ if (in_array('robots', $republish, true) && class_exists('ThinkRank\\SEO\\Site_Identity_Manager')) {
	369	+ (new \ThinkRank\SEO\Site_Identity_Manager())->sync_robots_txt_file();
	370	+ }
	371	+
	372	+ if (in_array('llms', $republish, true) && class_exists('ThinkRank\\SEO\\LLMs_Txt_Manager')) {
	373	+ $llms = new \ThinkRank\SEO\LLMs_Txt_Manager();
	374	+ $content = $llms->get_published_content();
	375	+
	376	+ // write_llms_txt_to_file() enforces the enabled toggle and the
	377	+ // delivery mode itself, so an empty document is the only case
	378	+ // worth short-circuiting here.
	379	+ if ($content !== '') {
	380	+ $llms->write_llms_txt_to_file($content);
	381	+ }
	382	+ }
	383	+ } catch (\Throwable $e) {
	384	+ // A failed republish must not block activation — the user would be
	385	+ // left unable to switch the plugin on at all. The artifacts rebuild
	386	+ // on the next content or settings save.
	387	+ if (defined('WP_DEBUG') && WP_DEBUG) {
	388	+ // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
	389	+ error_log('ThinkRank: failed to restore web-root artifacts: ' . $e->getMessage());
	390	+ }
	391	+ }
	392	+ }
	393	+
	394	+ /**
197	395	* Schedule cron jobs
198		- *
	396	+ *
199	397	* @return void
200	398	*/
201	399	private function schedule_cron_jobs(): void {
202	400