Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Actions\Configuration;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Helpers\Options_Helper;

[4] Fix | Delete

use Yoast\WP\SEO\Helpers\Social_Profiles_Helper;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class First_Time_Configuration_Action.

[8] Fix | Delete

[9] Fix | Delete

class First_Time_Configuration_Action {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* The fields for the site representation payload.

[13] Fix | Delete

[14] Fix | Delete

public const SITE_REPRESENTATION_FIELDS = [

[15] Fix | Delete

'company_or_person',

[16] Fix | Delete

'company_name',

[17] Fix | Delete

'website_name',

[18] Fix | Delete

'company_logo',

[19] Fix | Delete

'company_logo_id',

[20] Fix | Delete

'person_logo',

[21] Fix | Delete

'person_logo_id',

[22] Fix | Delete

'company_or_person_user_id',

[23] Fix | Delete

'description',

[24] Fix | Delete

];

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* The Options_Helper instance.

[28] Fix | Delete

[29] Fix | Delete

* @var Options_Helper

[30] Fix | Delete

[31] Fix | Delete

protected $options_helper;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* The Social_Profiles_Helper instance.

[35] Fix | Delete

[36] Fix | Delete

* @var Social_Profiles_Helper

[37] Fix | Delete

[38] Fix | Delete

protected $social_profiles_helper;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* First_Time_Configuration_Action constructor.

[42] Fix | Delete

[43] Fix | Delete

* @param Options_Helper $options_helper The WPSEO options helper.

[44] Fix | Delete

* @param Social_Profiles_Helper $social_profiles_helper The social profiles helper.

[45] Fix | Delete

[46] Fix | Delete

public function __construct( Options_Helper $options_helper, Social_Profiles_Helper $social_profiles_helper ) {

[47] Fix | Delete

$this->options_helper = $options_helper;

[48] Fix | Delete

$this->social_profiles_helper = $social_profiles_helper;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Stores the values for the site representation.

[53] Fix | Delete

[54] Fix | Delete

* @param array $params The values to store.

[55] Fix | Delete

[56] Fix | Delete

* @return object The response object.

[57] Fix | Delete

[58] Fix | Delete

public function set_site_representation( $params ) {

[59] Fix | Delete

$failures = [];

[60] Fix | Delete

$old_values = $this->get_old_values( self::SITE_REPRESENTATION_FIELDS );

[61] Fix | Delete

[62] Fix | Delete

foreach ( self::SITE_REPRESENTATION_FIELDS as $field_name ) {

[63] Fix | Delete

if ( isset( $params[ $field_name ] ) ) {

[64] Fix | Delete

$result = $this->options_helper->set( $field_name, $params[ $field_name ] );

[65] Fix | Delete

[66] Fix | Delete

if ( ! $result ) {

[67] Fix | Delete

$failures[] = $field_name;

[68] Fix | Delete

}

[69] Fix | Delete

}

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

// Delete cached logos in the db.

[73] Fix | Delete

$this->options_helper->set( 'company_logo_meta', false );

[74] Fix | Delete

$this->options_helper->set( 'person_logo_meta', false );

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Action: 'wpseo_post_update_site_representation' - Allows for Hiive event tracking.

[78] Fix | Delete

[79] Fix | Delete

* @param array $params The new values of the options.

[80] Fix | Delete

* @param array $old_values The old values of the options.

[81] Fix | Delete

* @param array $failures The options that failed to be saved.

[82] Fix | Delete

[83] Fix | Delete

* @internal

[84] Fix | Delete

[85] Fix | Delete

\do_action( 'wpseo_ftc_post_update_site_representation', $params, $old_values, $failures );

[86] Fix | Delete

[87] Fix | Delete

if ( \count( $failures ) === 0 ) {

[88] Fix | Delete

return (object) [

[89] Fix | Delete

'success' => true,

[90] Fix | Delete

'status' => 200,

[91] Fix | Delete

];

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

return (object) [

[95] Fix | Delete

'success' => false,

[96] Fix | Delete

'status' => 500,

[97] Fix | Delete

'error' => 'Could not save some options in the database',

[98] Fix | Delete

'failures' => $failures,

[99] Fix | Delete

];

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Stores the values for the social profiles.

[104] Fix | Delete

[105] Fix | Delete

* @param array $params The values to store.

[106] Fix | Delete

[107] Fix | Delete

* @return object The response object.

[108] Fix | Delete

[109] Fix | Delete

public function set_social_profiles( $params ) {

[110] Fix | Delete

$old_values = $this->get_old_values( \array_keys( $this->social_profiles_helper->get_organization_social_profile_fields() ) );

[111] Fix | Delete

$failures = $this->social_profiles_helper->set_organization_social_profiles( $params );

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Action: 'wpseo_post_update_social_profiles' - Allows for Hiive event tracking.

[115] Fix | Delete

[116] Fix | Delete

* @param array $params The new values of the options.

[117] Fix | Delete

* @param array $old_values The old values of the options.

[118] Fix | Delete

* @param array $failures The options that failed to be saved.

[119] Fix | Delete

[120] Fix | Delete

* @internal

[121] Fix | Delete

[122] Fix | Delete

\do_action( 'wpseo_ftc_post_update_social_profiles', $params, $old_values, $failures );

[123] Fix | Delete

[124] Fix | Delete

if ( empty( $failures ) ) {

[125] Fix | Delete

return (object) [

[126] Fix | Delete

'success' => true,

[127] Fix | Delete

'status' => 200,

[128] Fix | Delete

];

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

return (object) [

[132] Fix | Delete

'success' => false,

[133] Fix | Delete

'status' => 200,

[134] Fix | Delete

'error' => 'Could not save some options in the database',

[135] Fix | Delete

'failures' => $failures,

[136] Fix | Delete

];

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Stores the values for the social profiles.

[141] Fix | Delete

[142] Fix | Delete

* @param array $params The values to store.

[143] Fix | Delete

[144] Fix | Delete

* @return object The response object.

[145] Fix | Delete

[146] Fix | Delete

public function set_person_social_profiles( $params ) {

[147] Fix | Delete

$social_profiles = \array_filter(

[148] Fix | Delete

$params,

[149] Fix | Delete

static function ( $key ) {

[150] Fix | Delete

return $key !== 'user_id';

[151] Fix | Delete

[152] Fix | Delete

\ARRAY_FILTER_USE_KEY

[153] Fix | Delete

);

[154] Fix | Delete

[155] Fix | Delete

$failures = $this->social_profiles_helper->set_person_social_profiles( $params['user_id'], $social_profiles );

[156] Fix | Delete

[157] Fix | Delete

if ( \count( $failures ) === 0 ) {

[158] Fix | Delete

return (object) [

[159] Fix | Delete

'success' => true,

[160] Fix | Delete

'status' => 200,

[161] Fix | Delete

];

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

return (object) [

[165] Fix | Delete

'success' => false,

[166] Fix | Delete

'status' => 200,

[167] Fix | Delete

'error' => 'Could not save some options in the database',

[168] Fix | Delete

'failures' => $failures,

[169] Fix | Delete

];

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Gets the values for the social profiles.

[174] Fix | Delete

[175] Fix | Delete

* @param int $user_id The person ID.

[176] Fix | Delete

[177] Fix | Delete

* @return object The response object.

[178] Fix | Delete

[179] Fix | Delete

public function get_person_social_profiles( $user_id ) {

[180] Fix | Delete

[181] Fix | Delete

return (object) [

[182] Fix | Delete

'success' => true,

[183] Fix | Delete

'status' => 200,

[184] Fix | Delete

'social_profiles' => $this->social_profiles_helper->get_person_social_profiles( $user_id ),

[185] Fix | Delete

];

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Stores the values to enable/disable tracking.

[190] Fix | Delete

[191] Fix | Delete

* @param array $params The values to store.

[192] Fix | Delete

[193] Fix | Delete

* @return object The response object.

[194] Fix | Delete

[195] Fix | Delete

public function set_enable_tracking( $params ) {

[196] Fix | Delete

$success = true;

[197] Fix | Delete

$option_value = $this->options_helper->get( 'tracking' );

[198] Fix | Delete

[199] Fix | Delete

if ( $option_value !== $params['tracking'] ) {

[200] Fix | Delete

$this->options_helper->set( 'toggled_tracking', true );

[201] Fix | Delete

$success = $this->options_helper->set( 'tracking', $params['tracking'] );

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Action: 'wpseo_post_update_enable_tracking' - Allows for Hiive event tracking.

[206] Fix | Delete

[207] Fix | Delete

* @param array $new_value The new value.

[208] Fix | Delete

* @param array $old_value The old value.

[209] Fix | Delete

* @param bool $failure Whether the option failed to be stored.

[210] Fix | Delete

[211] Fix | Delete

* @internal

[212] Fix | Delete

[213] Fix | Delete

// $success is negated to be aligned with the other two actions which pass $failures.

[214] Fix | Delete

\do_action( 'wpseo_ftc_post_update_enable_tracking', $params['tracking'], $option_value, ! $success );

[215] Fix | Delete

[216] Fix | Delete

if ( $success ) {

[217] Fix | Delete

return (object) [

[218] Fix | Delete

'success' => true,

[219] Fix | Delete

'status' => 200,

[220] Fix | Delete

];

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

return (object) [

[224] Fix | Delete

'success' => false,

[225] Fix | Delete

'status' => 500,

[226] Fix | Delete

'error' => 'Could not save the option in the database',

[227] Fix | Delete

];

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

/**

[231] Fix | Delete

* Checks if the current user has the capability a specific user.

[232] Fix | Delete

[233] Fix | Delete

* @param int $user_id The id of the user to be edited.

[234] Fix | Delete

[235] Fix | Delete

* @return object The response object.

[236] Fix | Delete

[237] Fix | Delete

public function check_capability( $user_id ) {

[238] Fix | Delete

if ( $this->can_edit_profile( $user_id ) ) {

[239] Fix | Delete

return (object) [

[240] Fix | Delete

'success' => true,

[241] Fix | Delete

'status' => 200,

[242] Fix | Delete

];

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

return (object) [

[246] Fix | Delete

'success' => false,

[247] Fix | Delete

'status' => 403,

[248] Fix | Delete

];

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

/**

[252] Fix | Delete

* Stores the first time configuration state.

[253] Fix | Delete

[254] Fix | Delete

* @param array $params The values to store.

[255] Fix | Delete

[256] Fix | Delete

* @return object The response object.

[257] Fix | Delete

[258] Fix | Delete

public function save_configuration_state( $params ) {

[259] Fix | Delete

// If the finishedSteps param is not present in the REST request, it's a malformed request.

[260] Fix | Delete

if ( ! isset( $params['finishedSteps'] ) ) {

[261] Fix | Delete

return (object) [

[262] Fix | Delete

'success' => false,

[263] Fix | Delete

'status' => 400,

[264] Fix | Delete

'error' => 'Bad request',

[265] Fix | Delete

];

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

// Sanitize input.

[269] Fix | Delete

$finished_steps = \array_map( '\sanitize_text_field', \wp_unslash( $params['finishedSteps'] ) );

[270] Fix | Delete

[271] Fix | Delete

$success = $this->options_helper->set( 'configuration_finished_steps', $finished_steps );

[272] Fix | Delete

[273] Fix | Delete

if ( ! $success ) {

[274] Fix | Delete

return (object) [

[275] Fix | Delete

'success' => false,

[276] Fix | Delete

'status' => 500,

[277] Fix | Delete

'error' => 'Could not save the option in the database',

[278] Fix | Delete

];

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

// If all the five steps of the configuration have been completed, set first_time_install option to false.

[282] Fix | Delete

if ( \count( $params['finishedSteps'] ) === 3 ) {

[283] Fix | Delete

$this->options_helper->set( 'first_time_install', false );

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

return (object) [

[287] Fix | Delete

'success' => true,

[288] Fix | Delete

'status' => 200,

[289] Fix | Delete

];

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Gets the first time configuration state.

[294] Fix | Delete

[295] Fix | Delete

* @return object The response object.

[296] Fix | Delete

[297] Fix | Delete

public function get_configuration_state() {

[298] Fix | Delete

$configuration_option = $this->options_helper->get( 'configuration_finished_steps' );

[299] Fix | Delete

[300] Fix | Delete

if ( ! \is_null( $configuration_option ) ) {

[301] Fix | Delete

return (object) [

[302] Fix | Delete

'success' => true,

[303] Fix | Delete

'status' => 200,

[304] Fix | Delete

'data' => $configuration_option,

[305] Fix | Delete

];

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

return (object) [

[309] Fix | Delete

'success' => false,

[310] Fix | Delete

'status' => 500,

[311] Fix | Delete

'error' => 'Could not get data from the database',

[312] Fix | Delete

];

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* Checks if the current user has the capability to edit a specific user.

[317] Fix | Delete

[318] Fix | Delete

* @param int $person_id The id of the person to edit.

[319] Fix | Delete

[320] Fix | Delete

* @return bool

[321] Fix | Delete

[322] Fix | Delete

private function can_edit_profile( $person_id ) {

[323] Fix | Delete

return \current_user_can( 'edit_user', $person_id );

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

/**

[327] Fix | Delete

* Gets the old values for the given fields.

[328] Fix | Delete

[329] Fix | Delete

* @param array $fields_names The fields to get the old values for.

[330] Fix | Delete

[331] Fix | Delete

* @return array The old values.

[332] Fix | Delete

[333] Fix | Delete

private function get_old_values( array $fields_names ): array {

[334] Fix | Delete

$old_values = [];

[335] Fix | Delete

[336] Fix | Delete

foreach ( $fields_names as $field_name ) {

[337] Fix | Delete

$old_values[ $field_name ] = $this->options_helper->get( $field_name );

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

return $old_values;

[341] Fix | Delete

}

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete