JezK

Edit File: admin.php

<?php
/**
 * Admin class
 *
 * Handles admin settings related REST API endpoints for the SureRank plugin.
 *
 * @package SureRank\Inc\API
 */

namespace SureRank\Inc\API;

use SureRank\Inc\Admin\Update_Timestamp;
use SureRank\Inc\Functions\Cache_Purge;
use SureRank\Inc\Functions\Get;
use SureRank\Inc\Functions\Helper;
use SureRank\Inc\Functions\Send_Json;
use SureRank\Inc\Functions\Settings;
use SureRank\Inc\Functions\Update;
use SureRank\Inc\Meta_Variables\Post;
use SureRank\Inc\Meta_Variables\Site;
use SureRank\Inc\Meta_Variables\Term;
use SureRank\Inc\Meta_Variables\User;
use SureRank\Inc\Schema\Validator;
use SureRank\Inc\Traits\Get_Instance;
use WP_REST_Request;
use WP_REST_Server;

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

/**
 * Class Admin
 *
 * Handles admin settings related REST API endpoints.
 */
class Admin extends Api_Base {
	use Get_Instance;

/**
	 * Route Editor
	 */
	protected const EDITOR = '/admin/editor';

/**
	 * Route Get Admin Settings
	 */
	protected const ADMIN_SETTINGS = '/admin/global-settings';

/**
	 * Route Get Site Settings
	 */
	protected const SITE_SETTINGS = '/admin/site-settings';

/**
	 * Constructor
	 *
	 * @since 1.0.0
	 */
	public function __construct() {
	}

/**
	 * Register API routes.
	 *
	 * @since 1.0.0
	 * @return void
	 */
	public function register_routes() {
		$namespace = $this->get_api_namespace();
		$this->register_all_admin_routes( $namespace );
	}

/**
	 * Retrieves email logs with optional filters and search.
	 *
	 * @param WP_REST_Request<array<string, mixed>> $request The REST request object.
	 * @return void
	 */
	public function get_initials( $request ) {

$post_id = $request->get_param( 'post_id' );
		$term_id = $request->get_param( 'term_id' );
		$user_id = $request->get_param( 'user_id' );

if ( empty( $post_id ) && empty( $term_id ) && empty( $user_id ) ) {
			Send_Json::error( [ 'message' => __( 'Post id, term id or user id is required', 'surerank' ) ] );
		}

// Object-level guard: returning a user's variables is gated by the same
		// per-user capability as the dedicated user SEO routes, so a role with
		// only route-level access cannot read variables for arbitrary users.
		if ( ! empty( $user_id ) && ! User_Seo::can_manage_user_seo( (int) $user_id ) ) {
			Send_Json::error( [ 'message' => __( 'You are not allowed to manage SEO settings for this user.', 'surerank' ) ] );
		}

$data = [
			'variables' => $this->get_variables( $request->get_param( 'post_id' ), $request->get_param( 'term_id' ), $request->get_param( 'user_id' ) ),
			'other'     => $this->get_other_data(),
		];

Send_Json::success( $data );
	}

/**
	 * Get variables
	 *
	 * @param int|null $post_id Post ID.
	 * @param int|null $term_id Term ID.
	 * @param int|null $user_id User ID.
	 * @since 1.0.0
	 * @return array<string, array<string, mixed>> Array of variable groups keyed by type (e.g., term, post, site).
	 */
	public function get_variables( $post_id = null, $term_id = null, $user_id = null ) {

$meta_variable_instances = [];
		if ( ! empty( $term_id ) ) {
			$meta_variable_instances['term'] = Term::get_instance();
		}
		if ( ! empty( $post_id ) ) {
			$meta_variable_instances['post'] = Post::get_instance();
		}
		if ( ! empty( $user_id ) ) {
			$meta_variable_instances['user'] = User::get_instance();
		}
		$meta_variable_instances['site'] = Site::get_instance();

$variables = [];
		foreach ( $meta_variable_instances as $key => $instance ) {
			if ( ! empty( $post_id ) && method_exists( $instance, 'set_post' ) ) {
				$instance->set_post( $post_id );
			}
			if ( ! empty( $term_id ) && method_exists( $instance, 'set_term' ) ) {
				$instance->set_term( $term_id );
			}
			if ( ! empty( $user_id ) && method_exists( $instance, 'set_user' ) ) {
				$instance->set_user( $user_id );
			}
			$variables[ $key ] = $instance->get_all_values();

// Add custom fields if available.
			if ( method_exists( $instance, 'get_all_custom_fields' ) ) {
				$custom_fields = $instance->get_all_custom_fields();
				if ( ! empty( $custom_fields ) ) {
					$variables[ $key ] = array_merge( $variables[ $key ], $custom_fields );
				}
			}
		}

return $variables;
	}

/**
	 * Get other data.
	 *
	 * @since 1.0.0
	 * @return array<string, string>
	 */
	public function get_other_data() {
		$data = [];

// Get site favicon icon.
		$data['favicon_url'] = $this->get_favicon();

return $data;
	}

/**
	 * Get admin settings
	 *
	 * @param WP_REST_Request<array<string, mixed>> $request Request object.
	 * @since 1.0.0
	 * @return void
	 */
	public function get_admin_settings( $request ) {
		$data                                 = Settings::get();
		$data['surerank_usage_optin']         = Get::option( 'surerank_usage_optin' ) === 'yes' ? true : false;
		$data['surerank_delete_on_uninstall'] = Get::option( SURERANK_DELETE_ON_UNINSTALL ) === 'yes' ? true : false;
		$data                                 = apply_filters( 'surerank_get_admin_settings_data', $data );
		$decode_data                          = Utils::decode_html_entities_recursive( $data ) ?? $data;
		Send_Json::success( [ 'data' => $decode_data ] );
	}

/**
	 * Update admin settings
	 *
	 * REST endpoint handler. Extracts params from the request, delegates
	 * to the transport-free save_admin_settings() helper, and emits the
	 * result as JSON. The helper is shared with the AJAX fallback
	 * registered in inc/ajax/save-endpoints.php so both paths produce
	 * identical side effects for identical input.
	 *
	 * @param WP_REST_Request<array<string, mixed>> $request Request object.
	 * @since 1.0.0
	 * @return void
	 */
	public function update_admin_settings( $request ) {
		$data   = $request->get_param( 'data' );
		$result = self::save_admin_settings( is_array( $data ) ? $data : [] );

if ( $result['success'] ) {
			\SureRank\Inc\Functions\Rest_Observation::mark_reachable();
			Send_Json::success( [ 'message' => $result['message'] ] );
		}

Send_Json::error( [ 'message' => $result['message'] ] );
	}

/**
	 * Update global options.
	 *
	 * Thin alias for backward compatibility. Existing callers that invoked
	 * update_global_options() get the same behaviour — data is persisted
	 * and a success JSON response is emitted.
	 *
	 * @param array<string, mixed> $data Data.
	 * @since 1.0.0
	 * @return void
	 */
	public function update_global_options( $data ) {
		$result = self::save_admin_settings( $data );

if ( $result['success'] ) {
			Send_Json::success( [ 'message' => $result['message'] ] );
		}

Send_Json::error( [ 'message' => $result['message'] ] );
	}

/**
	 * Save global admin settings — transport-free core logic.
	 *
	 * Called by the REST endpoint handler above, by the
	 * backward-compatibility alias update_global_options(), and by the
	 * AJAX fallback in inc/ajax/save-endpoints.php. Returns a result array
	 * rather than emitting a response.
	 *
	 * @param array<string, mixed> $data Settings payload (already sanitised).
	 * @return array{success: bool, message: string}
	 * @since 1.x.x
	 */
	public static function save_admin_settings( array $data ): array {
		if ( empty( $data ) ) {
			return [
				'success' => false,
				'message' => __( 'No data found', 'surerank' ),
			];
		}

// Allow Pro plugin to handle extended meta templates toggle detection BEFORE getting any settings.
		do_action( 'surerank_admin_settings_before_processing', $data );
		$data       = apply_filters( 'surerank_update_admin_settings_data', $data );
		$db_options = Settings::get();

if ( isset( $data['schemas'] ) ) {
			$validation = Validator::validate_schemas_payload( $data['schemas'], $db_options['schemas'] ?? [] );
			if ( ! $validation['valid'] ) {
				return [
					'success' => false,
					'message' => '' !== $validation['message'] ? $validation['message'] : __( 'Invalid schema payload.', 'surerank' ),
				];
			}
		}

$instance        = self::get_instance();
		$updated_options = $instance->get_updated_options( $data, $db_options );

Helper::update_flush_rules( $updated_options );

$data = $instance->process_social_profile_updates( $data, $updated_options );
		$data = array_merge( $db_options, $data );
		$data = $instance->process_surerank_usage_optin( $data );
		$data = $instance->process_surerank_delete_on_uninstall( $data );

if ( Update::option( SURERANK_SETTINGS, $data ) ) {
			Update_Timestamp::timestamp_option();

// Record a deliberate user settings edit for analytics ("Active" signal).
			// Anchored here (not on the generic updated_option hook) so programmatic
			// writers (onboarding, importers, integrations) do not create false edits.
			update_option( 'surerank_settings_edited_at', time() );
		}

// Global SEO defaults affect every page — purge cached output when they change.
		if ( ! empty( $updated_options ) ) {
			Cache_Purge::purge_all();
		}
		/**
		 * Fires after admin settings are saved.
		 *
		 * Lets other features react to specific setting changes — e.g. the Pro
		 * sitemap module triggers a cache rebuild when the sitemap include/
		 * exclude settings change, so changes reflect without waiting for cron.
		 *
		 * @param array<string, mixed> $data            Full saved settings.
		 * @param array<string, mixed> $db_options      Settings as they were before the save.
		 * @param array<int, string>   $updated_options List of top-level keys that changed.
		 * @since 1.9.2
		 */
		do_action( 'surerank_admin_settings_updated', $data, $db_options, $updated_options );

return [
			'success' => true,
			'message' => __( 'Settings updated', 'surerank' ),
		];
	}

/**
	 * Process surerank analytics optin
	 *
	 * @param array<string, mixed> $data Data.
	 * @since 1.0.0
	 * @return array<string, mixed>
	 */
	public function process_surerank_usage_optin( $data ) {

if ( ! isset( $data['surerank_usage_optin'] ) ) {
			return $data;
		}

$surerank_usage_optin = $data['surerank_usage_optin'] ? 'yes' : 'no';
		Update::option( 'surerank_usage_optin', $surerank_usage_optin );
		unset( $data['surerank_usage_optin'] );

return $data;
	}

/**
	 * Process the "delete plugin data on uninstall" toggle.
	 *
	 * Mirrors the boolean to its own standalone option so uninstall.php can
	 * read it cheaply without unserializing the full settings blob.
	 *
	 * @param array<string, mixed> $data Data.
	 * @since 1.9.0
	 * @return array<string, mixed>
	 */
	public function process_surerank_delete_on_uninstall( $data ) {

if ( ! isset( $data['surerank_delete_on_uninstall'] ) ) {
			return $data;
		}

$value = $data['surerank_delete_on_uninstall'] ? 'yes' : 'no';
		Update::option( SURERANK_DELETE_ON_UNINSTALL, $value );
		unset( $data['surerank_delete_on_uninstall'] );

return $data;
	}

/**
	 * Get site settings
	 *
	 * @param WP_REST_Request<array<string, mixed>> $request Request object.
	 * @since 1.0.0
	 * @return void
	 */
	public function get_site_settings( $request ) {
		$data = $this->prepare_site_settings_data();
		Send_Json::success( [ 'data' => $data ] );
	}

/**
	 * Get updated options
	 *
	 * @param array<string, mixed|array> $data       First array.
	 * @param array<string, mixed|array> $db_options Second array.
	 * @param string                     $parent_key  Parent key.
	 *
	 * @return array<int, string> Updated option keys.
	 */
	public function get_updated_options( $data, $db_options, $parent_key = '' ) {
		$diff_keys = [];

foreach ( $data as $key => $value ) {
			if ( 'default_global_meta' === $key ) {
				continue;
			}
			if ( is_array( $value ) ) {
				if ( isset( $db_options[ $key ] ) && is_array( $db_options[ $key ] ) ) {
					$nested_diff = $this->get_updated_options( $value, $db_options[ $key ], $key );
					if ( ! empty( $nested_diff ) ) {
						$diff_keys[] = $key;
					}
				} else {
					$diff_keys[] = $key;
				}
			} else {
				if ( ! isset( $db_options[ $key ] ) || $db_options[ $key ] !== $value ) {
					$diff_keys[] = $key;
				}
			}
		}
		return array_unique( $diff_keys );
	}

/**
	 * Process Onboarding Data
	 *
	 * @param array<string, mixed> $data Data.
	 * @param array<string, mixed> $settings Settings.
	 * @since 1.0.0
	 * @return void
	 */
	public function process_onboarding_data( $data, &$settings ) {
		Onboarding::get_instance()->set_social_schema( $data, $settings );
	}

/**
	 * Register all admin routes
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_all_admin_routes( $namespace ) {
		$this->register_editor_route( $namespace );
		$this->register_admin_settings_routes( $namespace );
		$this->register_site_settings_route( $namespace );
	}

/**
	 * Register editor route
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_editor_route( $namespace ) {
		register_rest_route(
			$namespace,
			self::EDITOR,
			[
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_initials' ],
				'permission_callback' => [ $this, 'validate_permission' ],
				'args'                => $this->get_editor_args(),
				'role_capability'     => 'content_setting',
			]
		);
	}

/**
	 * Register admin settings routes
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_admin_settings_routes( $namespace ) {
		$this->register_get_admin_settings_route( $namespace );
		$this->register_update_admin_settings_route( $namespace );
	}

/**
	 * Register get admin settings route
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_get_admin_settings_route( $namespace ) {
		register_rest_route(
			$namespace,
			self::ADMIN_SETTINGS,
			[
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_admin_settings' ],
				'permission_callback' => [ $this, 'validate_permission' ],
				'role_capability'     => 'global_setting',
			]
		);
	}

/**
	 * Register update admin settings route
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_update_admin_settings_route( $namespace ) {
		register_rest_route(
			$namespace,
			self::ADMIN_SETTINGS,
			[
				'methods'             => WP_REST_Server::CREATABLE,
				'callback'            => [ $this, 'update_admin_settings' ],
				'permission_callback' => [ $this, 'validate_permission' ],
				'args'                => $this->get_admin_settings_update_args(),
				'role_capability'     => 'global_setting',
			]
		);
	}

/**
	 * Register site settings route
	 *
	 * @param string $namespace The API namespace.
	 * @return void
	 */
	private function register_site_settings_route( $namespace ) {
		register_rest_route(
			$namespace,
			self::SITE_SETTINGS,
			[
				'methods'             => WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_site_settings' ],
				'permission_callback' => [ $this, 'validate_permission' ],
				'role_capability'     => 'global_setting',
			]
		);
	}

/**
	 * Get editor route arguments
	 *
	 * @return array<string, array<string, mixed>>
	 */
	private function get_editor_args() {
		return [
			'post_id' => [
				'type'              => 'integer',
				'sanitize_callback' => 'absint',
			],
			'term_id' => [
				'type'              => 'integer',
				'sanitize_callback' => 'absint',
			],
			'user_id' => [
				'type'              => 'integer',
				'sanitize_callback' => 'absint',
			],
		];
	}

/**
	 * Get admin settings update arguments
	 *
	 * @return array<string, array<string, mixed>>
	 */
	private function get_admin_settings_update_args() {
		return [
			'data' => [
				'type'              => 'object',
				'required'          => true,
				'sanitize_callback' => [ $this, 'sanitize_array_data' ],
			],
		];
	}

/**
	 * Process social profile updates
	 *
	 * @param array<string, mixed> $data Data.
	 * @param array<string>        $updated_options Updated options.
	 * @return array<string, mixed>
	 */
	private function process_social_profile_updates( $data, $updated_options ) {
		if ( $this->should_update_social_profiles( $updated_options ) ) {
			$data = $this->update_social_profile_data( $data );
			$this->process_onboarding_data( $data, $data );
		}
		return $data;
	}

/**
	 * Check if social profiles should be updated
	 *
	 * @param array<string> $updated_options Updated options.
	 * @return bool
	 */
	private function should_update_social_profiles( $updated_options ) {
		return is_array( $updated_options ) && array_intersect(
			[ 'social_profiles', 'facebook_page_url', 'twitter_profile_username' ],
			$updated_options
		);
	}

/**
	 * Update social profile data
	 *
	 * @param array<string, mixed> $data Data.
	 * @return array<string, mixed>
	 */
	private function update_social_profile_data( $data ) {
		$data['social_profiles']['facebook'] = $data['facebook_page_url'] ?? '';

if ( ! empty( $data['twitter_profile_username'] ) ) {
			$data['social_profiles']['twitter'] = str_replace( '@', '', $data['twitter_profile_username'] );
		}

return $data;
	}

/**
	 * Prepare site settings data
	 *
	 * @return array<string, mixed>
	 */
	private function prepare_site_settings_data() {
		$data = [];

$data['site']         = $this->get_site_variables();
		$data['is_wc_active'] = class_exists( 'WooCommerce' );

$home_page_data = $this->get_home_page_data();
		return array_merge( $data, $home_page_data );
	}

/**
	 * Get home page data
	 *
	 * @return array<string, mixed>
	 */
	private function get_home_page_data() {
		$show_option   = Get::option( 'show_on_front' );
		$page_on_front = Get::option( 'page_on_front' );
		$home_page_id  = intval( $page_on_front );

$featured_image = get_the_post_thumbnail_url( $home_page_id, 'full' );
		$data           = [
			'home_page_static'         => $show_option,
			'home_page_featured_image' => $featured_image ? $featured_image : false,
		];

if ( $this->is_static_home_page( $show_option, $page_on_front ) ) {
			$data = array_merge( $data, $this->get_static_home_page_data( $home_page_id ) );
		}

return $data;
	}

/**
	 * Check if home page is static
	 *
	 * @param string $show_option Show on front option.
	 * @param mixed  $page_on_front Page on front ID.
	 * @return bool
	 */
	private function is_static_home_page( $show_option, $page_on_front ) {
		return 'page' === $show_option &&
			! empty( $page_on_front ) &&
			( is_string( $page_on_front ) || is_int( $page_on_front ) );
	}

/**
	 * Get static home page data
	 *
	 * @param int $home_page_id Home page ID.
	 * @return array<string, mixed>
	 */
	private function get_static_home_page_data( $home_page_id ) {
		$page_url = get_edit_post_link( $home_page_id );
		return [
			'home_page_id'       => $home_page_id,
			'home_page_edit_url' => $this->sanitize_edit_url( $page_url ),
		];
	}

/**
	 * Sanitize edit URL
	 *
	 * @param mixed $page_url Page URL.
	 * @return string
	 */
	private function sanitize_edit_url( $page_url ) {
		return '' !== $page_url && is_string( $page_url )
			? html_entity_decode( $page_url, ENT_QUOTES | ENT_HTML5, 'UTF-8' )
			: '';
	}
}

https://personalfinance365.com/post-type-page-sitemap-1.xml 2026-09-27T18:16:25+05:30 https://personalfinance365.com/post-type-post-sitemap-1.xml 2026-09-27T18:16:25+05:30 https://personalfinance365.com/post-type-post-sitemap-2.xml 2026-09-27T18:16:25+05:30 https://personalfinance365.com/taxonomy-type-category-sitemap-1.xml 2026-09-27T18:16:25+05:30 https://personalfinance365.com/taxonomy-type-post_tag-sitemap-1.xml 2026-09-27T18:16:25+05:30 https://personalfinance365.com/taxonomy-type-post_tag-sitemap-2.xml 2026-09-27T18:16:25+05:30