Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Initializers;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Conditionals\Front_End_Conditional;

[4] Fix | Delete

use Yoast\WP\SEO\Helpers\Crawl_Cleanup_Helper;

[5] Fix | Delete

use Yoast\WP\SEO\Helpers\Options_Helper;

[6] Fix | Delete

use Yoast\WP\SEO\Helpers\Redirect_Helper;

[7] Fix | Delete

use Yoast\WP\SEO\Helpers\Url_Helper;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Class Crawl_Cleanup_Permalinks.

[11] Fix | Delete

[12] Fix | Delete

class Crawl_Cleanup_Permalinks implements Initializer_Interface {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* The options helper.

[16] Fix | Delete

[17] Fix | Delete

* @var Options_Helper

[18] Fix | Delete

[19] Fix | Delete

private $options_helper;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* The URL helper.

[23] Fix | Delete

[24] Fix | Delete

* @var Url_Helper

[25] Fix | Delete

[26] Fix | Delete

private $url_helper;

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* The Redirect_Helper.

[30] Fix | Delete

[31] Fix | Delete

* @var Redirect_Helper

[32] Fix | Delete

[33] Fix | Delete

private $redirect_helper;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* The Crawl_Cleanup_Helper.

[37] Fix | Delete

[38] Fix | Delete

* @var Crawl_Cleanup_Helper

[39] Fix | Delete

[40] Fix | Delete

private $crawl_cleanup_helper;

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Crawl Cleanup Basic integration constructor.

[44] Fix | Delete

[45] Fix | Delete

* @param Options_Helper $options_helper The option helper.

[46] Fix | Delete

* @param Url_Helper $url_helper The URL helper.

[47] Fix | Delete

* @param Redirect_Helper $redirect_helper The Redirect Helper.

[48] Fix | Delete

* @param Crawl_Cleanup_Helper $crawl_cleanup_helper The Crawl_Cleanup_Helper.

[49] Fix | Delete

[50] Fix | Delete

public function __construct(

[51] Fix | Delete

Options_Helper $options_helper,

[52] Fix | Delete

Url_Helper $url_helper,

[53] Fix | Delete

Redirect_Helper $redirect_helper,

[54] Fix | Delete

Crawl_Cleanup_Helper $crawl_cleanup_helper

[55] Fix | Delete

) {

[56] Fix | Delete

$this->options_helper = $options_helper;

[57] Fix | Delete

$this->url_helper = $url_helper;

[58] Fix | Delete

$this->redirect_helper = $redirect_helper;

[59] Fix | Delete

$this->crawl_cleanup_helper = $crawl_cleanup_helper;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Initializes the integration.

[64] Fix | Delete

[65] Fix | Delete

* @return void

[66] Fix | Delete

[67] Fix | Delete

public function initialize() {

[68] Fix | Delete

// We need to hook after 10 because otherwise our options helper isn't available yet.

[69] Fix | Delete

\add_action( 'plugins_loaded', [ $this, 'register_hooks' ], 15 );

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Hooks our required hooks.

[74] Fix | Delete

[75] Fix | Delete

* This is the place to register hooks and filters.

[76] Fix | Delete

[77] Fix | Delete

* @return void

[78] Fix | Delete

[79] Fix | Delete

public function register_hooks() {

[80] Fix | Delete

if ( $this->options_helper->get( 'clean_campaign_tracking_urls' ) && ! empty( \get_option( 'permalink_structure' ) ) ) {

[81] Fix | Delete

\add_action( 'template_redirect', [ $this, 'utm_redirect' ], 0 );

[82] Fix | Delete

}

[83] Fix | Delete

if ( $this->options_helper->get( 'clean_permalinks' ) && ! empty( \get_option( 'permalink_structure' ) ) ) {

[84] Fix | Delete

\add_action( 'template_redirect', [ $this, 'clean_permalinks' ], 1 );

[85] Fix | Delete

}

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

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

[90] Fix | Delete

[91] Fix | Delete

* @return array The array of conditionals.

[92] Fix | Delete

[93] Fix | Delete

public static function get_conditionals() {

[94] Fix | Delete

return [ Front_End_Conditional::class ];

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Redirect utm variables away.

[99] Fix | Delete

[100] Fix | Delete

* @return void

[101] Fix | Delete

[102] Fix | Delete

public function utm_redirect() {

[103] Fix | Delete

// Prevents WP CLI from throwing an error.

[104] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput

[105] Fix | Delete

if ( ! isset( $_SERVER['REQUEST_URI'] ) || \strpos( $_SERVER['REQUEST_URI'], '?' ) === false ) {

[106] Fix | Delete

return;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput

[110] Fix | Delete

if ( ! \stripos( $_SERVER['REQUEST_URI'], 'utm_' ) ) {

[111] Fix | Delete

return;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

// phpcs:ignore WordPress.Security.ValidatedSanitizedInput

[115] Fix | Delete

$parsed = \wp_parse_url( $_SERVER['REQUEST_URI'] );

[116] Fix | Delete

[117] Fix | Delete

$query = \explode( '&', $parsed['query'] );

[118] Fix | Delete

$utms = [];

[119] Fix | Delete

$other_args = [];

[120] Fix | Delete

[121] Fix | Delete

foreach ( $query as $query_arg ) {

[122] Fix | Delete

if ( \stripos( $query_arg, 'utm_' ) === 0 ) {

[123] Fix | Delete

$utms[] = $query_arg;

[124] Fix | Delete

continue;

[125] Fix | Delete

}

[126] Fix | Delete

$other_args[] = $query_arg;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

if ( empty( $utms ) ) {

[130] Fix | Delete

return;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

$other_args_str = '';

[134] Fix | Delete

if ( \count( $other_args ) > 0 ) {

[135] Fix | Delete

$other_args_str = '?' . \implode( '&', $other_args );

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

$new_path = $parsed['path'] . $other_args_str . '#' . \implode( '&', $utms );

[139] Fix | Delete

[140] Fix | Delete

$message = \sprintf(

[141] Fix | Delete

/* translators: %1$s: Yoast SEO */

[142] Fix | Delete

\__( '%1$s: redirect utm variables to #', 'wordpress-seo' ),

[143] Fix | Delete

'Yoast SEO'

[144] Fix | Delete

);

[145] Fix | Delete

[146] Fix | Delete

$this->redirect_helper->do_safe_redirect( \trailingslashit( $this->url_helper->recreate_current_url( false ) ) . \ltrim( $new_path, '/' ), 301, $message );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Removes unneeded query variables from the URL.

[151] Fix | Delete

[152] Fix | Delete

* @return void

[153] Fix | Delete

[154] Fix | Delete

public function clean_permalinks() {

[155] Fix | Delete

[156] Fix | Delete

if ( $this->crawl_cleanup_helper->should_avoid_redirect() ) {

[157] Fix | Delete

return;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$current_url = $this->url_helper->recreate_current_url();

[161] Fix | Delete

$allowed_params = $this->crawl_cleanup_helper->allowed_params( $current_url );

[162] Fix | Delete

[163] Fix | Delete

// If we had only allowed params, let's just bail out, no further processing needed.

[164] Fix | Delete

if ( empty( $allowed_params['query'] ) ) {

[165] Fix | Delete

return;

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

$url_type = $this->crawl_cleanup_helper->get_url_type();

[169] Fix | Delete

[170] Fix | Delete

switch ( $url_type ) {

[171] Fix | Delete

case 'singular_url':

[172] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->singular_url();

[173] Fix | Delete

break;

[174] Fix | Delete

case 'front_page_url':

[175] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->front_page_url();

[176] Fix | Delete

break;

[177] Fix | Delete

case 'page_for_posts_url':

[178] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->page_for_posts_url();

[179] Fix | Delete

break;

[180] Fix | Delete

case 'taxonomy_url':

[181] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->taxonomy_url();

[182] Fix | Delete

break;

[183] Fix | Delete

case 'search_url':

[184] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->search_url();

[185] Fix | Delete

break;

[186] Fix | Delete

case 'page_not_found_url':

[187] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->page_not_found_url( $current_url );

[188] Fix | Delete

break;

[189] Fix | Delete

default:

[190] Fix | Delete

$proper_url = '';

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

if ( $this->crawl_cleanup_helper->is_query_var_page( $proper_url ) ) {

[194] Fix | Delete

$proper_url = $this->crawl_cleanup_helper->query_var_page_url( $proper_url );

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

$proper_url = \add_query_arg( $allowed_params['allowed_query'], $proper_url );

[198] Fix | Delete

[199] Fix | Delete

if ( empty( $proper_url ) || $current_url === $proper_url ) {

[200] Fix | Delete

return;

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

$this->crawl_cleanup_helper->do_clean_redirect( $proper_url );

[204] Fix | Delete

}

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete