377 lines
12 KiB
PHP
377 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* This file is part of Avatar Privacy.
|
|
*
|
|
* Copyright 2018-2023 Peter Putzer.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* ***
|
|
*
|
|
* @package mundschenk-at/avatar-privacy
|
|
* @license http://www.gnu.org/licenses/gpl-2.0.html
|
|
*/
|
|
|
|
namespace Avatar_Privacy\Components;
|
|
|
|
use Avatar_Privacy\Component;
|
|
|
|
use Avatar_Privacy\Core\Settings;
|
|
|
|
use Avatar_Privacy\Data_Storage\Network_Options;
|
|
use Avatar_Privacy\Data_Storage\Transients;
|
|
|
|
use Avatar_Privacy\Tools\Multisite;
|
|
use Avatar_Privacy\Tools\Template;
|
|
use Avatar_Privacy\Tools\HTML\Dependencies;
|
|
|
|
use Avatar_Privacy\Vendor\Mundschenk\UI\Control; // phpcs:ignore ImportDetection.Imports.RequireImports.Import -- necessary for type hints.
|
|
use Avatar_Privacy\Vendor\Mundschenk\UI\Controls;
|
|
use Avatar_Privacy\Vendor\Mundschenk\UI\Control_Factory;
|
|
|
|
/**
|
|
* Handles the network settings page on multisite installations.
|
|
*
|
|
* @since 2.1.0
|
|
*
|
|
* @author Peter Putzer <github@mundschenk.at>
|
|
*
|
|
* @phpstan-type SettingsSectionInfo array{ id: string, title: string, callback: callable }
|
|
*/
|
|
class Network_Settings_Page implements Component {
|
|
|
|
const OPTION_GROUP = 'avatar-privacy-network-settings';
|
|
const SECTION = 'general';
|
|
const ACTION = 'edit-avatar-privacy-network-settings';
|
|
|
|
/**
|
|
* The options handler.
|
|
*
|
|
* @var Network_Options
|
|
*/
|
|
private Network_Options $network_options;
|
|
|
|
/**
|
|
* The (standard) transietns handler.
|
|
*
|
|
* @var Transients
|
|
*/
|
|
private Transients $transients;
|
|
|
|
/**
|
|
* The default settings.
|
|
*
|
|
* @var Settings
|
|
*/
|
|
private Settings $settings;
|
|
|
|
/**
|
|
* The multisite tools.
|
|
*
|
|
* @var Multisite
|
|
*/
|
|
private Multisite $multisite;
|
|
|
|
/**
|
|
* The UI controls for the settings.
|
|
*
|
|
* @var Control[]
|
|
*/
|
|
private array $controls;
|
|
|
|
/**
|
|
* An array to keep track of triggered admin notices.
|
|
*
|
|
* @var bool[]
|
|
*/
|
|
private array $triggered_notice = [];
|
|
|
|
/**
|
|
* The script & style registration helper.
|
|
*
|
|
* @since 2.4.0
|
|
*
|
|
* @var Dependencies
|
|
*/
|
|
private Dependencies $dependencies;
|
|
|
|
/**
|
|
* The templating handler.
|
|
*
|
|
* @since 2.4.0
|
|
*
|
|
* @var Template
|
|
*/
|
|
private Template $template;
|
|
|
|
/**
|
|
* Creates a new instance.
|
|
*
|
|
* @since 2.1.0 Parameter $plugin_file removed.
|
|
* @since 2.4.0 Parameter $core removed, parameters $dependencies, and $template
|
|
* added.
|
|
*
|
|
* @param Network_Options $network_options The network options handler.
|
|
* @param Transients $transients The transients handler.
|
|
* @param Settings $settings The default settings.
|
|
* @param Multisite $multisite The the multisite handler.
|
|
* @param Dependencies $dependencies The script & style registration helper.
|
|
* @param Template $template The templating handler.
|
|
*/
|
|
public function __construct( Network_Options $network_options, Transients $transients, Settings $settings, Multisite $multisite, Dependencies $dependencies, Template $template ) {
|
|
$this->network_options = $network_options;
|
|
$this->transients = $transients;
|
|
$this->settings = $settings;
|
|
$this->multisite = $multisite;
|
|
$this->dependencies = $dependencies;
|
|
$this->template = $template;
|
|
}
|
|
|
|
/**
|
|
* Sets up the various hooks for the plugin component.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function run() {
|
|
if ( \is_network_admin() ) {
|
|
// Load the field definitions.
|
|
$fields = $this->settings->get_network_fields();
|
|
|
|
// Initialize the controls.
|
|
$this->controls = Control_Factory::initialize( $fields, $this->network_options, '' );
|
|
|
|
// Add some actions.
|
|
\add_action( 'network_admin_menu', [ $this, 'register_network_settings' ] );
|
|
\add_action( 'network_admin_edit_' . self::ACTION, [ $this, 'save_network_settings' ] );
|
|
\add_action( 'network_admin_notices', 'settings_errors' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Registers the settings with the settings API. This is only used to display
|
|
* an explanation of the wrong gravatar settings.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function register_network_settings() {
|
|
// Create our options page.
|
|
$page = \add_submenu_page( 'settings.php', \__( 'Avatar Privacy Network Settings', 'avatar-privacy' ), \__( 'Avatar Privacy', 'avatar-privacy' ), 'manage_network_options', self::OPTION_GROUP, [ $this, 'print_settings_page' ] );
|
|
|
|
// Add the section(s).
|
|
\add_settings_section( self::SECTION, '', [ $this, 'print_settings_section' ], self::OPTION_GROUP );
|
|
|
|
// Register control render callbacks.
|
|
foreach ( $this->controls as $option => $control ) {
|
|
$option_name = $this->network_options->get_name( $option );
|
|
$sanitize = [ $control, 'sanitize' ];
|
|
|
|
// Register the setting ...
|
|
\register_setting( self::OPTION_GROUP, $option_name, $sanitize );
|
|
|
|
// ... and the control.
|
|
$control->register( self::OPTION_GROUP );
|
|
}
|
|
|
|
// Trigger table migration if the settings are changed.
|
|
$use_global_table = $this->network_options->get_name( Network_Options::USE_GLOBAL_TABLE );
|
|
\add_action( "update_site_option_{$use_global_table}", [ $this, 'start_migration_from_global_table' ], 10, 3 );
|
|
|
|
// Use the registered $page handle to hook stylesheet and script loading.
|
|
\add_action( "admin_print_styles-{$page}", [ $this, 'print_styles' ] );
|
|
}
|
|
|
|
/**
|
|
* Displays the network options page.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function print_settings_page() {
|
|
// Load the settings page HTML.
|
|
$this->template->print_partial( 'admin/partials/network/settings-page.php' );
|
|
}
|
|
|
|
/**
|
|
* Saves the network settings.
|
|
*
|
|
* @global array $_POST Post request superglobal.
|
|
* @global array $new_whitelist_options The options whitelisted by the settings API.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function save_network_settings() {
|
|
// Check if the user has the correct permissions.
|
|
if ( ! \current_user_can( 'manage_network_options' ) ) {
|
|
\wp_die( \esc_html( \__( 'Sorry, you are not allowed to access this page.', 'avatar-privacy' ) ), 403 );
|
|
}
|
|
|
|
// Make sure we are posting from our options page.
|
|
\check_admin_referer( self::OPTION_GROUP . '-options' );
|
|
|
|
// This is the list of registered options.
|
|
global $new_whitelist_options;
|
|
|
|
// Go through the posted data and save only our options.
|
|
foreach ( $new_whitelist_options[ self::OPTION_GROUP ] as $option ) {
|
|
if ( isset( $_POST[ $option ] ) ) {
|
|
// The registered callback function to sanitize the option's value will be called here.
|
|
$this->network_options->set( $option, \wp_unslash( $_POST[ $option ] ), false, true ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
|
|
} else {
|
|
// Set false for checkboxes and unset everything else.
|
|
$id = $this->network_options->remove_prefix( $option );
|
|
if ( $this->controls[ $id ] instanceof Controls\Checkbox_Input ) {
|
|
$this->network_options->set( $option, false, false, true );
|
|
} else {
|
|
$this->network_options->delete( $option, true );
|
|
}
|
|
}
|
|
}
|
|
|
|
$settings_errors = \get_settings_errors();
|
|
if ( empty( $settings_errors ) ) { // @phpstan-ignore-line - $settings_errors array can be empty.
|
|
\add_settings_error( self::OPTION_GROUP, 'settings_updated', \__( 'Settings saved.', 'avatar-privacy' ), 'updated' );
|
|
}
|
|
|
|
// Save the settings errors until after the redirect.
|
|
$this->persist_settings_errors();
|
|
|
|
// At last we redirect back to our options page.
|
|
\wp_safe_redirect(
|
|
\add_query_arg( // @codeCoverageIgnoreStart
|
|
[
|
|
'page' => self::OPTION_GROUP,
|
|
'settings-updated' => 'true',
|
|
],
|
|
\network_admin_url( 'settings.php' )
|
|
) // @codeCoverageIgnoreEnd
|
|
);
|
|
|
|
// And we are done.
|
|
$this->exit_request();
|
|
}
|
|
|
|
/**
|
|
* Prints any additional markup for the given form section.
|
|
*
|
|
* @param array $section The section information.
|
|
*
|
|
* @return void
|
|
*
|
|
* @phpstan-param SettingsSectionInfo $section
|
|
*/
|
|
public function print_settings_section( $section ) {
|
|
// Set up variables used by the included partial.
|
|
$args = [
|
|
'section_id' => ! empty( $section['id'] ) ? $section['id'] : '',
|
|
'description' => \__( 'General settings applying to all sites in the network.', 'avatar-privacy' ),
|
|
];
|
|
|
|
// Load the settings page HTML.
|
|
$this->template->print_partial( 'admin/partials/network/section.php', $args );
|
|
}
|
|
|
|
/**
|
|
* Stops executing the current request early.
|
|
*
|
|
* @codeCoverageIgnore
|
|
*
|
|
* @param int $status Optional. A status code in the range 0 to 254. Default 0.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function exit_request( $status = 0 ) {
|
|
exit( $status ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
}
|
|
|
|
/**
|
|
* Enqueue stylesheet for options page.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function print_styles() {
|
|
$this->dependencies->register_style( 'avatar-privacy-settings', 'admin/css/settings.css' );
|
|
$this->dependencies->enqueue_style( 'avatar-privacy-settings' );
|
|
}
|
|
|
|
/**
|
|
* Use sanitization callback to trigger an admin notice.
|
|
*
|
|
* @param string $setting_name The setting used to trigger the notice (without the prefix).
|
|
* @param string $notice_id HTML ID attribute for the notice.
|
|
* @param string $message Translated message string.
|
|
* @param string $notice_level 'updated', 'notice-info', etc.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function trigger_admin_notice( $setting_name, $notice_id, $message, $notice_level ) {
|
|
if ( empty( $this->triggered_notice[ $setting_name ] ) ) {
|
|
\add_settings_error( self::OPTION_GROUP, $notice_id, $message, $notice_level );
|
|
|
|
// Workaround for https://core.trac.wordpress.org/ticket/21989.
|
|
$this->triggered_notice[ $setting_name ] = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Persists the settings errors across the redirect.
|
|
*
|
|
* Uses a regular transient to stay compatible with core.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function persist_settings_errors() {
|
|
// A regular transient is used here, since it is automatically cleared right after the redirect.
|
|
$this->transients->set( 'settings_errors', \get_settings_errors(), 30, true );
|
|
}
|
|
|
|
/**
|
|
* Triggers the migration from global to site specific tables when global table
|
|
* use is changed from enbled to disabled.
|
|
*
|
|
* @param string $option Name of the network option.
|
|
* @param mixed $value New value of the network option.
|
|
* @param mixed $old_value Old value of the network option.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function start_migration_from_global_table( $option, $value, $old_value ) {
|
|
if ( $option !== $this->network_options->get_name( Network_Options::USE_GLOBAL_TABLE ) ) {
|
|
// This should never happen.
|
|
return;
|
|
}
|
|
|
|
// Only trigger migration if USE_GLOBAL_TABLE was changed from "on" to "off".
|
|
if ( empty( $value ) && ! empty( $old_value ) ) {
|
|
// Add all sites in the current network to the queue.
|
|
$site_ids = $this->multisite->get_site_ids();
|
|
$queue = (array) \array_combine( $site_ids, $site_ids );
|
|
|
|
// Remove the main site ID from the queue.
|
|
unset( $queue[ \get_main_site_id() ] );
|
|
|
|
// Store new queue, overwriting any existing queue (since this per
|
|
// network and we already got all sites currently in the network).
|
|
// If the new queue is empty, the next page load will clean up the
|
|
// network options.
|
|
$this->network_options->set( Network_Options::START_GLOBAL_TABLE_MIGRATION, $queue );
|
|
|
|
// Notify admins.
|
|
$this->trigger_admin_notice( Network_Options::USE_GLOBAL_TABLE, 'settings_updated', \__( 'Settings saved. Consent data will be migrated to site-specific tables.', 'avatar-privacy' ), 'updated' );
|
|
} elseif ( ! empty( $value ) && empty( $old_value ) ) {
|
|
// Clean up any running migrations on the next page load.
|
|
$this->network_options->set( Network_Options::START_GLOBAL_TABLE_MIGRATION, [] );
|
|
}
|
|
}
|
|
}
|