<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Integrations\Admin;

[2] Fix | Delete

[3] Fix | Delete

use WPSEO_Admin_Asset_Manager;

[4] Fix | Delete

use WPSEO_Option;

[5] Fix | Delete

use WPSEO_Shortlinker;

[6] Fix | Delete

use Yoast\WP\SEO\Conditionals\Admin_Conditional;

[7] Fix | Delete

use Yoast\WP\SEO\Integrations\Integration_Interface;

[8] Fix | Delete

use Yoast\WP\SEO\Presenters\Admin\Alert_Presenter;

[9] Fix | Delete

use Yoast_Form;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Crawl_Settings_Integration class

[13] Fix | Delete

*/

[14] Fix | Delete

class Crawl_Settings_Integration implements Integration_Interface {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* The admin asset manager.

[18] Fix | Delete

*

[19] Fix | Delete

* @var WPSEO_Admin_Asset_Manager

[20] Fix | Delete

*/

[21] Fix | Delete

private $admin_asset_manager;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Holds the settings + labels for the head clean up piece.

[25] Fix | Delete

*

[26] Fix | Delete

* @var array

[27] Fix | Delete

*/

[28] Fix | Delete

private $basic_settings;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Holds the settings + labels for the feeds clean up.

[32] Fix | Delete

*

[33] Fix | Delete

* @var array

[34] Fix | Delete

*/

[35] Fix | Delete

private $feed_settings;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Holds the settings + labels for permalink cleanup settings.

[39] Fix | Delete

*

[40] Fix | Delete

* @var array

[41] Fix | Delete

*/

[42] Fix | Delete

private $permalink_cleanup_settings;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Holds the settings + labels for search cleanup settings.

[46] Fix | Delete

*

[47] Fix | Delete

* @var array

[48] Fix | Delete

*/

[49] Fix | Delete

private $search_cleanup_settings;

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Holds the settings + labels for unused resources settings.

[53] Fix | Delete

*

[54] Fix | Delete

* @var array

[55] Fix | Delete

*/

[56] Fix | Delete

private $unused_resources_settings;

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* The shortlinker.

[60] Fix | Delete

*

[61] Fix | Delete

* @var WPSEO_Shortlinker

[62] Fix | Delete

*/

[63] Fix | Delete

private $shortlinker;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Returns the conditionals based in which this loadable should be active.

[67] Fix | Delete

*

[68] Fix | Delete

* In this case: when on an admin page.

[69] Fix | Delete

*

[70] Fix | Delete

* @return array<string>

[71] Fix | Delete

*/

[72] Fix | Delete

public static function get_conditionals() {

[73] Fix | Delete

return [ Admin_Conditional::class ];

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Crawl_Settings_Integration constructor.

[78] Fix | Delete

*

[79] Fix | Delete

* @param WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager.

[80] Fix | Delete

* @param WPSEO_Shortlinker $shortlinker The shortlinker.

[81] Fix | Delete

*/

[82] Fix | Delete

public function __construct( WPSEO_Admin_Asset_Manager $admin_asset_manager, WPSEO_Shortlinker $shortlinker ) {

[83] Fix | Delete

$this->admin_asset_manager = $admin_asset_manager;

[84] Fix | Delete

$this->shortlinker = $shortlinker;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Registers an action to add a new tab to the General page.

[89] Fix | Delete

*

[90] Fix | Delete

* @return void

[91] Fix | Delete

*/

[92] Fix | Delete

public function register_hooks() {

[93] Fix | Delete

$this->register_setting_labels();

[94] Fix | Delete

[95] Fix | Delete

\add_action( 'wpseo_settings_tab_crawl_cleanup_network', [ $this, 'add_crawl_settings_tab_content_network' ] );

[96] Fix | Delete

\add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Enqueue the workouts app.

[101] Fix | Delete

*

[102] Fix | Delete

* @return void

[103] Fix | Delete

*/

[104] Fix | Delete

public function enqueue_assets() {

[105] Fix | Delete

if ( ! \is_network_admin() ) {

[106] Fix | Delete

return;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Page is not processed or saved.

[110] Fix | Delete

if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpseo_dashboard' ) {

[111] Fix | Delete

return;

[112] Fix | Delete

}

[113] Fix | Delete

$this->admin_asset_manager->enqueue_script( 'crawl-settings' );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Connects the settings to their labels.

[118] Fix | Delete

*

[119] Fix | Delete

* @return void

[120] Fix | Delete

*/

[121] Fix | Delete

private function register_setting_labels() {

[122] Fix | Delete

$this->feed_settings = [

[123] Fix | Delete

'remove_feed_global' => \__( 'Global feed', 'wordpress-seo' ),

[124] Fix | Delete

'remove_feed_global_comments' => \__( 'Global comment feeds', 'wordpress-seo' ),

[125] Fix | Delete

'remove_feed_post_comments' => \__( 'Post comments feeds', 'wordpress-seo' ),

[126] Fix | Delete

'remove_feed_authors' => \__( 'Post authors feeds', 'wordpress-seo' ),

[127] Fix | Delete

'remove_feed_post_types' => \__( 'Post type feeds', 'wordpress-seo' ),

[128] Fix | Delete

'remove_feed_categories' => \__( 'Category feeds', 'wordpress-seo' ),

[129] Fix | Delete

'remove_feed_tags' => \__( 'Tag feeds', 'wordpress-seo' ),

[130] Fix | Delete

'remove_feed_custom_taxonomies' => \__( 'Custom taxonomy feeds', 'wordpress-seo' ),

[131] Fix | Delete

'remove_feed_search' => \__( 'Search results feeds', 'wordpress-seo' ),

[132] Fix | Delete

'remove_atom_rdf_feeds' => \__( 'Atom/RDF feeds', 'wordpress-seo' ),

[133] Fix | Delete

];

[134] Fix | Delete

[135] Fix | Delete

$this->basic_settings = [

[136] Fix | Delete

'remove_shortlinks' => \__( 'Shortlinks', 'wordpress-seo' ),

[137] Fix | Delete

'remove_rest_api_links' => \__( 'REST API links', 'wordpress-seo' ),

[138] Fix | Delete

'remove_rsd_wlw_links' => \__( 'RSD / WLW links', 'wordpress-seo' ),

[139] Fix | Delete

'remove_oembed_links' => \__( 'oEmbed links', 'wordpress-seo' ),

[140] Fix | Delete

'remove_generator' => \__( 'Generator tag', 'wordpress-seo' ),

[141] Fix | Delete

'remove_pingback_header' => \__( 'Pingback HTTP header', 'wordpress-seo' ),

[142] Fix | Delete

'remove_powered_by_header' => \__( 'Powered by HTTP header', 'wordpress-seo' ),

[143] Fix | Delete

];

[144] Fix | Delete

[145] Fix | Delete

$this->permalink_cleanup_settings = [

[146] Fix | Delete

'clean_campaign_tracking_urls' => \__( 'Campaign tracking URL parameters', 'wordpress-seo' ),

[147] Fix | Delete

'clean_permalinks' => \__( 'Unregistered URL parameters', 'wordpress-seo' ),

[148] Fix | Delete

];

[149] Fix | Delete

[150] Fix | Delete

$this->search_cleanup_settings = [

[151] Fix | Delete

'search_cleanup' => \__( 'Filter search terms', 'wordpress-seo' ),

[152] Fix | Delete

'search_cleanup_emoji' => \__( 'Filter searches with emojis and other special characters', 'wordpress-seo' ),

[153] Fix | Delete

'search_cleanup_patterns' => \__( 'Filter searches with common spam patterns', 'wordpress-seo' ),

[154] Fix | Delete

'deny_search_crawling' => \__( 'Prevent search engines from crawling site search URLs', 'wordpress-seo' ),

[155] Fix | Delete

'redirect_search_pretty_urls' => \__( 'Redirect pretty URLs for search pages to raw format', 'wordpress-seo' ),

[156] Fix | Delete

];

[157] Fix | Delete

[158] Fix | Delete

$this->unused_resources_settings = [

[159] Fix | Delete

'remove_emoji_scripts' => \__( 'Emoji scripts', 'wordpress-seo' ),

[160] Fix | Delete

'deny_wp_json_crawling' => \__( 'Prevent search engines from crawling /wp-json/', 'wordpress-seo' ),

[161] Fix | Delete

'deny_adsbot_crawling' => \__( 'Prevent Google AdsBot from crawling', 'wordpress-seo' ),

[162] Fix | Delete

];

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Adds content to the Crawl Cleanup network tab.

[167] Fix | Delete

*

[168] Fix | Delete

* @param Yoast_Form $yform The yoast form object.

[169] Fix | Delete

*

[170] Fix | Delete

* @return void

[171] Fix | Delete

*/

[172] Fix | Delete

public function add_crawl_settings_tab_content_network( $yform ) {

[173] Fix | Delete

$this->add_crawl_settings( $yform );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Print the settings sections.

[178] Fix | Delete

*

[179] Fix | Delete

* @param Yoast_Form $yform The Yoast form class.

[180] Fix | Delete

*

[181] Fix | Delete

* @return void

[182] Fix | Delete

*/

[183] Fix | Delete

private function add_crawl_settings( $yform ) {

[184] Fix | Delete

$this->print_toggles( $this->basic_settings, $yform, \__( 'Basic crawl settings', 'wordpress-seo' ) );

[185] Fix | Delete

[186] Fix | Delete

$this->print_toggles( $this->feed_settings, $yform, \__( 'Feed crawl settings', 'wordpress-seo' ) );

[187] Fix | Delete

$this->print_toggles( $this->unused_resources_settings, $yform, \__( 'Remove unused resources', 'wordpress-seo' ) );

[188] Fix | Delete

[189] Fix | Delete

$first_search_setting = \array_slice( $this->search_cleanup_settings, 0, 1 );

[190] Fix | Delete

$rest_search_settings = \array_slice( $this->search_cleanup_settings, 1 );

[191] Fix | Delete

$search_settings_toggles = [

[192] Fix | Delete

'off' => \__( 'Disabled', 'wordpress-seo' ),

[193] Fix | Delete

'on' => \__( 'Enabled', 'wordpress-seo' ),

[194] Fix | Delete

];

[195] Fix | Delete

[196] Fix | Delete

$this->print_toggles( $first_search_setting, $yform, \__( 'Search cleanup settings', 'wordpress-seo' ), $search_settings_toggles );

[197] Fix | Delete

[198] Fix | Delete

$this->print_toggles( $rest_search_settings, $yform, '', $search_settings_toggles );

[199] Fix | Delete

[200] Fix | Delete

$permalink_warning = \sprintf(

[201] Fix | Delete

/* Translators: %1$s expands to an opening anchor tag for a link leading to the Yoast SEO page of the Permalink Cleanup features, %2$s expands to a closing anchor tag. */

[202] Fix | Delete

\esc_html__(

[203] Fix | Delete

'These are expert features, so make sure you know what you\'re doing before removing the parameters. %1$sRead more about how your site can be affected%2$s.',

[204] Fix | Delete

'wordpress-seo'

[205] Fix | Delete

),

[206] Fix | Delete

'<a href="' . \esc_url( $this->shortlinker->build_shortlink( 'https://yoa.st/permalink-cleanup' ) ) . '" target="_blank" rel="noopener noreferrer">',

[207] Fix | Delete

'</a>'

[208] Fix | Delete

);

[209] Fix | Delete

[210] Fix | Delete

$this->print_toggles( $this->permalink_cleanup_settings, $yform, \__( 'Permalink cleanup settings', 'wordpress-seo' ), [], $permalink_warning );

[211] Fix | Delete

[212] Fix | Delete

// Add the original option as hidden, so as not to lose any values if it's disabled and the form is saved.

[213] Fix | Delete

$yform->hidden( 'clean_permalinks_extra_variables', 'clean_permalinks_extra_variables' );

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Prints a list of toggles for an array of settings with labels.

[218] Fix | Delete

*

[219] Fix | Delete

* @param array $settings The settings being displayed.

[220] Fix | Delete

* @param Yoast_Form $yform The Yoast form class.

[221] Fix | Delete

* @param string $title Optional title for the settings being displayed.

[222] Fix | Delete

* @param array $toggles Optional naming of the toggle buttons.

[223] Fix | Delete

* @param string $warning Optional warning to be displayed above the toggles.

[224] Fix | Delete

*

[225] Fix | Delete

* @return void

[226] Fix | Delete

*/

[227] Fix | Delete

private function print_toggles( array $settings, Yoast_Form $yform, $title = '', $toggles = [], $warning = '' ) {

[228] Fix | Delete

if ( ! empty( $title ) ) {

[229] Fix | Delete

echo '<h3 class="yoast-crawl-settings">', \esc_html( $title ), '</h3>';

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

if ( ! empty( $warning ) ) {

[233] Fix | Delete

// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output escaped in Alert_Presenter.

[234] Fix | Delete

echo new Alert_Presenter( $warning, 'warning' );

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

if ( empty( $toggles ) ) {

[238] Fix | Delete

$toggles = [

[239] Fix | Delete

'off' => \__( 'Keep', 'wordpress-seo' ),

[240] Fix | Delete

'on' => \__( 'Remove', 'wordpress-seo' ),

[241] Fix | Delete

];

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

$setting_prefix = WPSEO_Option::ALLOW_KEY_PREFIX;

[245] Fix | Delete

$toggles = [

[246] Fix | Delete

// phpcs:ignore WordPress.WP.I18n.TextDomainMismatch -- Reason: text is originally from Yoast SEO.

[247] Fix | Delete

'on' => \__( 'Allow Control', 'wordpress-seo' ),

[248] Fix | Delete

// phpcs:ignore WordPress.WP.I18n.TextDomainMismatch -- Reason: text is originally from Yoast SEO.

[249] Fix | Delete

'off' => \__( 'Disable', 'wordpress-seo' ),

[250] Fix | Delete

];

[251] Fix | Delete

[252] Fix | Delete

foreach ( $settings as $setting => $label ) {

[253] Fix | Delete

$attr = [];

[254] Fix | Delete

$variable = $setting_prefix . $setting;

[255] Fix | Delete

[256] Fix | Delete

if ( $this->should_feature_be_disabled_permalink( $setting ) ) {

[257] Fix | Delete

$attr = [

[258] Fix | Delete

'disabled' => true,

[259] Fix | Delete

];

[260] Fix | Delete

$variable = $setting_prefix . $setting . '_disabled';

[261] Fix | Delete

[262] Fix | Delete

// Also add the original option as hidden, so as not to lose any values if it's disabled and the form is saved.

[263] Fix | Delete

$yform->hidden( $setting_prefix . $setting, $setting_prefix . $setting );

[264] Fix | Delete

}

[265] Fix | Delete

elseif ( $this->should_feature_be_disabled_multisite( $setting ) ) {

[266] Fix | Delete

$attr = [

[267] Fix | Delete

'disabled' => true,

[268] Fix | Delete

'preserve_disabled_value' => false,

[269] Fix | Delete

];

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

$yform->toggle_switch(

[273] Fix | Delete

$variable,

[274] Fix | Delete

$toggles,

[275] Fix | Delete

$label,

[276] Fix | Delete

'',

[277] Fix | Delete

$attr

[278] Fix | Delete

);

[279] Fix | Delete

if ( $this->should_feature_be_disabled_permalink( $setting ) ) {

[280] Fix | Delete

echo '<p class="yoast-crawl-settings-help">';

[281] Fix | Delete

if ( \current_user_can( 'manage_options' ) ) {

[282] Fix | Delete

\printf(

[283] Fix | Delete

/* translators: 1: Link start tag to the Permalinks settings page, 2: Link closing tag. */

[284] Fix | Delete

\esc_html__( 'This feature is disabled when your site is not using %1$spretty permalinks%2$s.', 'wordpress-seo' ),

[285] Fix | Delete

'<a href="' . \esc_url( \admin_url( 'options-permalink.php' ) ) . '">',

[286] Fix | Delete

'</a>'

[287] Fix | Delete

);

[288] Fix | Delete

}

[289] Fix | Delete

else {

[290] Fix | Delete

echo \esc_html__( 'This feature is disabled when your site is not using pretty permalinks.', 'wordpress-seo' );

[291] Fix | Delete

}

[292] Fix | Delete

echo '</p>';

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

/**

[298] Fix | Delete

* Checks if the feature should be disabled due to non-pretty permalinks.

[299] Fix | Delete

*

[300] Fix | Delete

* @param string $setting The setting to be displayed.

[301] Fix | Delete

*

[302] Fix | Delete

* @return bool

[303] Fix | Delete

*/

[304] Fix | Delete

protected function should_feature_be_disabled_permalink( $setting ) {

[305] Fix | Delete

return (

[306] Fix | Delete

\in_array( $setting, [ 'clean_permalinks', 'clean_campaign_tracking_urls' ], true )

[307] Fix | Delete

&& empty( \get_option( 'permalink_structure' ) )

[308] Fix | Delete

);

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

/**

[312] Fix | Delete

* Checks if the feature should be disabled due to the site being a multisite.

[313] Fix | Delete

*

[314] Fix | Delete

* @param string $setting The setting to be displayed.

[315] Fix | Delete

*

[316] Fix | Delete

* @return bool

[317] Fix | Delete

*/

[318] Fix | Delete

protected function should_feature_be_disabled_multisite( $setting ) {

[319] Fix | Delete

return (

[320] Fix | Delete

\in_array( $setting, [ 'deny_search_crawling', 'deny_wp_json_crawling', 'deny_adsbot_crawling' ], true )

[321] Fix | Delete

&& \is_multisite()

[322] Fix | Delete

);

[323] Fix | Delete

}

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete