d88e50df38
* Update translation text domain * Escape everything that should be escaped. * Add nonce checks where needed. * Sanitize all inputs. * Apply Code style changes across the codebase. * Correct many deprecation notices. * Optimize load order of many filters. * Add Proper Build script * Use emojii flags * Fix i18n deprecation notice for translating too early * Put all scripts in footer and load async
416 lines
9.9 KiB
PHP
416 lines
9.9 KiB
PHP
<?php
|
|
/**
|
|
* WP Multisite WaaS Dashboard Widgets
|
|
*
|
|
* Log string messages to a file with a timestamp. Useful for debugging.
|
|
*
|
|
* @package WP_Ultimo
|
|
* @subpackage Logger
|
|
* @since 2.0.0
|
|
*/
|
|
|
|
namespace WP_Ultimo;
|
|
|
|
// Exit if accessed directly
|
|
defined('ABSPATH') || exit;
|
|
|
|
/**
|
|
* WP Multisite WaaS Dashboard Widgets
|
|
*
|
|
* @since 2.0.0
|
|
*/
|
|
class Dashboard_Widgets {
|
|
|
|
use \WP_Ultimo\Traits\Singleton;
|
|
|
|
/**
|
|
* Network Dashboard Screen Id
|
|
*
|
|
* @since 2.0.0
|
|
* @var string
|
|
*/
|
|
public $screen_id = 'dashboard-network';
|
|
|
|
/**
|
|
* Undocumented variable
|
|
*
|
|
* @since 2.0.0
|
|
* @var array
|
|
*/
|
|
public $core_metaboxes = [];
|
|
|
|
/**
|
|
* Runs on singleton instantiation.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function init(): void {
|
|
|
|
add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts']);
|
|
|
|
add_action('wp_network_dashboard_setup', [$this, 'register_network_widgets']);
|
|
|
|
add_action('wp_dashboard_setup', [$this, 'register_widgets']);
|
|
|
|
add_action('wp_ajax_wu_fetch_rss', [$this, 'process_ajax_fetch_rss']);
|
|
|
|
add_action('wp_ajax_wu_fetch_activity', [$this, 'process_ajax_fetch_events']);
|
|
|
|
add_action('wp_ajax_wu_generate_csv', [$this, 'handle_table_csv']);
|
|
}
|
|
|
|
/**
|
|
* Enqueues the JavaScript code that sends the dismiss call to the ajax endpoint.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function enqueue_scripts(): void {
|
|
|
|
global $pagenow;
|
|
|
|
if ( ! $pagenow || 'index.php' !== $pagenow) {
|
|
return;
|
|
}
|
|
|
|
wp_enqueue_script('wu-vue');
|
|
|
|
wp_enqueue_script('moment');
|
|
}
|
|
|
|
/**
|
|
* Register the widgets
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function register_network_widgets(): void {
|
|
|
|
add_meta_box('wp-ultimo-setup', __('WP Multisite WaaS - First Steps', 'wp-multisite-waas'), [$this, 'output_widget_first_steps'], $this->screen_id, 'normal', 'high');
|
|
|
|
add_meta_box('wp-ultimo-summary', __('WP Multisite WaaS - Summary', 'wp-multisite-waas'), [$this, 'output_widget_summary'], $this->screen_id, 'normal', 'high');
|
|
|
|
add_meta_box('wp-ultimo-activity-stream', __('WP Multisite WaaS - Activity Stream', 'wp-multisite-waas'), [$this, 'output_widget_activity_stream'], $this->screen_id, 'normal', 'high');
|
|
|
|
\WP_Ultimo\UI\Tours::get_instance()->create_tour(
|
|
'dashboard',
|
|
[
|
|
[
|
|
'id' => 'welcome',
|
|
'title' => __('Welcome!', 'wp-multisite-waas'),
|
|
'text' => [
|
|
__('Welcome to your new network dashboard!', 'wp-multisite-waas'),
|
|
__('You will notice that <strong>WP Multisite WaaS</strong> adds a couple of useful widgets here so you can keep an eye on how your network is doing.', 'wp-multisite-waas'),
|
|
],
|
|
],
|
|
[
|
|
'id' => 'finish-your-setup',
|
|
'title' => __('Finish your setup', 'wp-multisite-waas'),
|
|
'text' => [
|
|
__('You still have a couple of things to do configuration-wise. Check the steps on this list and make sure you complete them all.', 'wp-multisite-waas'),
|
|
],
|
|
'attachTo' => [
|
|
'element' => '#wp-ultimo-setup',
|
|
'on' => 'left',
|
|
],
|
|
],
|
|
[
|
|
'id' => 'wp-ultimo-menu',
|
|
'title' => __('Our home', 'wp-multisite-waas'),
|
|
'text' => [
|
|
__('You can always find WP Multisite WaaS settings and other pages under our menu item, here on the Network-level dashboard. 😃', 'wp-multisite-waas'),
|
|
],
|
|
'attachTo' => [
|
|
'element' => '.toplevel_page_wp-ultimo',
|
|
'on' => 'left',
|
|
],
|
|
],
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Adds the customer's site's dashboard widgets.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function register_widgets(): void {
|
|
|
|
$screen = get_current_screen();
|
|
|
|
if (wu_get_current_site()->get_type() !== 'customer_owned') {
|
|
return;
|
|
}
|
|
|
|
/*
|
|
* Account Summary
|
|
*/
|
|
\WP_Ultimo\UI\Account_Summary_Element::get_instance()->as_metabox($screen->id, 'normal');
|
|
|
|
/*
|
|
* Limits & Quotas
|
|
*/
|
|
\WP_Ultimo\UI\Limits_Element::get_instance()->as_metabox($screen->id, 'side');
|
|
|
|
/*
|
|
* Maintenance Mode Widget
|
|
*/
|
|
if (wu_get_setting('maintenance_mode')) {
|
|
\WP_Ultimo\UI\Site_Maintenance_Element::get_instance()->as_metabox($screen->id, 'side');
|
|
}
|
|
|
|
/*
|
|
* Domain Mapping Widget
|
|
*/
|
|
if (wu_get_setting('enable_domain_mapping') && wu_get_setting('custom_domains')) {
|
|
\WP_Ultimo\UI\Domain_Mapping_Element::get_instance()->as_metabox($screen->id, 'side');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Widget First Steps Output.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function output_widget_first_steps(): void {
|
|
|
|
$initial_setup_done = get_network_option(null, 'wu_setup_finished', false);
|
|
|
|
$steps = [
|
|
'inital-setup' => [
|
|
'title' => __('Initial Setup', 'wp-multisite-waas'),
|
|
'desc' => __('Go through the initial Setup Wizard to configure the basic settings of your network.', 'wp-multisite-waas'),
|
|
'action_label' => __('Finish the Setup Wizard', 'wp-multisite-waas'),
|
|
'action_link' => wu_network_admin_url('wp-ultimo-setup'),
|
|
'done' => wu_string_to_bool($initial_setup_done),
|
|
],
|
|
'payment-method' => [
|
|
'title' => __('Payment Method', 'wp-multisite-waas'),
|
|
'desc' => __('You will need to configure at least one payment gateway to be able to receive money from your customers.', 'wp-multisite-waas'),
|
|
'action_label' => __('Add a Payment Method', 'wp-multisite-waas'),
|
|
'action_link' => wu_network_admin_url(
|
|
'wp-ultimo-settings',
|
|
[
|
|
'tab' => 'payment-gateways',
|
|
]
|
|
),
|
|
'done' => ! empty(wu_get_active_gateways()),
|
|
],
|
|
'your-first-customer' => [
|
|
'done' => ! empty(wu_get_customers()),
|
|
'title' => __('Your First Customer', 'wp-multisite-waas'),
|
|
'desc' => __('Open the link below in an incognito tab and go through your newly created signup form.', 'wp-multisite-waas'),
|
|
'action_link' => wp_registration_url(),
|
|
'action_label' => __('Create a test Account', 'wp-multisite-waas'),
|
|
],
|
|
];
|
|
|
|
$done = \Arrch\Arrch::find(
|
|
$steps,
|
|
[
|
|
'where' => [
|
|
['done', true],
|
|
],
|
|
]
|
|
);
|
|
|
|
wu_get_template(
|
|
'dashboard-widgets/first-steps',
|
|
[
|
|
'steps' => $steps,
|
|
'percentage' => round(count($done) / count($steps) * 100),
|
|
'all_done' => count($done) === count($steps),
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Widget Activity Stream Output.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function output_widget_activity_stream(): void {
|
|
|
|
wu_get_template('dashboard-widgets/activity-stream');
|
|
}
|
|
|
|
/**
|
|
* Widget Summary Output
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function output_widget_summary(): void {
|
|
/*
|
|
* Get today's signups.
|
|
*/
|
|
$signups = wu_get_customers(
|
|
[
|
|
'count' => true,
|
|
'date_query' => [
|
|
'column' => 'date_registered',
|
|
'after' => 'today',
|
|
'inclusive' => true,
|
|
],
|
|
]
|
|
);
|
|
|
|
wu_get_template(
|
|
'dashboard-widgets/summary',
|
|
[
|
|
'signups' => $signups,
|
|
'mrr' => wu_calculate_mrr(),
|
|
'gross_revenue' => wu_calculate_revenue('today'),
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Process Ajax Filters for rss.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function process_ajax_fetch_rss(): void {
|
|
|
|
$atts = wp_parse_args(
|
|
$_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended
|
|
[
|
|
'url' => 'https://community.wpultimo.com/topics/feed',
|
|
'title' => __('Forum Discussions', 'wp-multisite-waas'),
|
|
'items' => 3,
|
|
'show_summary' => 1,
|
|
'show_author' => 0,
|
|
'show_date' => 1,
|
|
]
|
|
);
|
|
|
|
wp_widget_rss_output($atts);
|
|
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Process Ajax Filters for rss.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function process_ajax_fetch_events(): void {
|
|
|
|
check_ajax_referer('wu_activity_stream');
|
|
|
|
$count = wu_get_events(
|
|
[
|
|
'count' => true,
|
|
'number' => -1,
|
|
]
|
|
);
|
|
|
|
$data = wu_get_events(
|
|
[
|
|
'offset' => (wu_request('page', 1) - 1) * 5,
|
|
'number' => 5,
|
|
]
|
|
);
|
|
|
|
wp_send_json_success(
|
|
[
|
|
'events' => $data,
|
|
'count' => $count,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Handle ajax endpoint to generate table CSV.
|
|
*
|
|
* @since 2.0.0
|
|
* @return void
|
|
*/
|
|
public function handle_table_csv(): void {
|
|
|
|
$date_range = wu_request('date_range');
|
|
$headers = json_decode(stripslashes((string) wu_request('headers')));
|
|
$data = json_decode(stripslashes((string) wu_request('data')));
|
|
|
|
$file_name = sprintf('wp-ultimo-%s_%s_(%s)', wu_request('slug'), $date_range, gmdate('Y-m-d', wu_get_current_time('timestamp')));
|
|
|
|
$data = array_merge([$headers], $data);
|
|
|
|
wu_generate_csv($file_name, $data);
|
|
|
|
die;
|
|
}
|
|
|
|
/**
|
|
* Get the registered widgets.
|
|
*
|
|
* @since 2.0.0
|
|
* @return array
|
|
*/
|
|
public static function get_registered_dashboard_widgets() {
|
|
|
|
global $wp_meta_boxes, $wp_registered_widgets;
|
|
|
|
ob_start();
|
|
|
|
if ( ! function_exists('wp_add_dashboard_widget')) {
|
|
require_once ABSPATH . '/wp-admin/includes/dashboard.php';
|
|
}
|
|
|
|
do_action('wp_network_dashboard_setup'); // phpcs:ignore
|
|
|
|
ob_clean(); // Prevent eventual echos.
|
|
|
|
$dashboard_widgets = wu_get_isset($wp_meta_boxes, 'dashboard-network', []);
|
|
|
|
$options = [
|
|
'normal:core:dashboard_right_now' => __('At a Glance'),
|
|
'normal:core:network_dashboard_right_now' => __('Right Now'),
|
|
'normal:core:dashboard_activity' => __('Activity'),
|
|
'normal:core:dashboard_primary' => __('WordPress Events and News'),
|
|
];
|
|
|
|
foreach ($dashboard_widgets as $position => $priorities) {
|
|
foreach ($priorities as $priority => $widgets) {
|
|
foreach ($widgets as $widget_key => $widget) {
|
|
if (empty($widget) || wu_get_isset($widget, 'title') === false) {
|
|
continue;
|
|
}
|
|
|
|
$key = implode(
|
|
':',
|
|
[
|
|
$position,
|
|
$priority,
|
|
$widget_key,
|
|
]
|
|
);
|
|
|
|
/**
|
|
* For some odd reason, in some cases, $options
|
|
* becomes a bool and the assignment below throws a fatal error.
|
|
* This checks prevents that error from happening.
|
|
* I don't know why $options would ever be a boolean here, though.
|
|
*/
|
|
if ( ! is_array($options)) {
|
|
$options = [];
|
|
}
|
|
|
|
$options[ $key ] = $widget['title'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $options;
|
|
}
|
|
}
|