extended-evaluation-for-statify.php

<?php
/**
 * Plugin Name: Statify – Extended Evaluation
 * Plugin URI: https://patrick-robrecht.de/wordpress/
 * Description: Extended evaluation for the compact, easy-to-use and privacy-compliant Statify plugin.
 * Version: 2.6.4
 * Author: Patrick Robrecht
 * Author URI: https://patrick-robrecht.de/
 * License: GPLv3
 * License URI: https://www.gnu.org/licenses/gpl-3.0.html
 * Text Domain: extended-evaluation-for-statify
 *
 * @package extended-evaluation-for-statify
 */

// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;

define( 'EEFSTATFIFY_VERSION', '2.6.4' );

// Includes.
require_once 'inc/queries.php';
require_once 'inc/formatting.php';

/**
 * Requires Statify to be installed and activated during installation.
 */
function eefstatify_activate() {
	if ( ! eefstatify_is_statify_active() ) {
		deactivate_plugins( __FILE__ );
		wp_die(
			esc_html(
				__(
					'Statify – Extended Evaluation requires the plugin Statify which has to be installed and activated! Please install and activate Statify before activating this plugin!',
					'extended-evaluation-for-statify'
				)
			),
			esc_html(
				__(
					'Activation Error: Statify – Extended Evaluation requires Statify!',
					'extended-evaluation-for-statify'
				)
			),
			array(
				'response'  => 200,
				'back_link' => true,
			)
		);
	}
}

// Hook to run during plugin activation.
register_activation_hook( __FILE__, 'eefstatify_activate' );

/**
 * Delete database entries created by the plugin on uninstall.
 */
function eefstatify_uninstall() {
	// Nothing to do.
}

// Hook to run during plugin uninstall.
register_uninstall_hook( __FILE__, 'eefstatify_uninstall' );

/**
 * Check for Statify plugin being installed.
 * If it isn't, display message and deactivate this plugin.
 */
function eefstatify_check_status() {
	if ( ! eefstatify_is_statify_active() ) {
		// Display warning in the admin area.
		echo '<div class="error"><p>'
			. esc_html(
				__(
					'Statify – Extended Evaluation requires the plugin Statify which has to be installed and activated! Please install and activate Statify before activating this plugin!',
					'extended-evaluation-for-statify'
				)
			)
			 . '</p></div>';
		// Deactivate this plugin.
		deactivate_plugins( __FILE__ );
	}
}

// Add status check to the admin notices.
add_action( 'admin_notices', 'eefstatify_check_status' );

/**
 * Test whether Statify is active.
 *
 * @return boolean true if and only if Statify is installed and active.
 */
function eefstatify_is_statify_active() {
	return is_plugin_active( 'statify/statify.php' );
}

/**
 * Load text domain for translation.
 */
function eefstatify_load_plugin_textdomain() {
	load_plugin_textdomain( 'extended-evaluation-for-statify' );
}

// Add text domain during initialization.
add_action( 'init', 'eefstatify_load_plugin_textdomain' );

/**
 * Register and load the style sheets and JavaScript libraries.
 */
function eefstatify_register_and_load_assets() {
	if ( eefstatify_current_user_can_see_evaluation() ) {
		eefstatify_enqueue_style(
			'chartist',
			'/lib/chartist.min.css'
		);
		eefstatify_enqueue_style(
			'chartist-plugin-tooltip',
			'lib/chartist-plugin-tooltip.min.css'
		);
		eefstatify_enqueue_style(
			'eefstatify',
			'/css/style.min.css'
		);

		eefstatify_enqueue_script(
			'chartist',
			'/lib/chartist.min.js'
		);
		eefstatify_enqueue_script(
			'chartist-plugin-tooltip',
			'lib/chartist-plugin-tooltip.min.js'
		);
		eefstatify_enqueue_script(
			'eefstatify_functions',
			'/js/functions.min.js',
			[ 'chartist', 'chartist-plugin-tooltip', 'jquery' ]
		);

		wp_localize_script(
			'eefstatify_functions',
			'eefStatifyTranslations',
			array(
				'view'  => strip_tags( esc_html__( 'View', 'extended-evaluation-for-statify' ) ),
				'views' => strip_tags( esc_html__( 'Views', 'extended-evaluation-for-statify' ) ),
			)
		);
	}
}

/**
 * Loads the CSS file.
 *
 * @param string $style_name the name of the style.
 * @param string $style_path the plugin-relative path of the CSS file.
 */
function eefstatify_enqueue_style( $style_name, $style_path ) {
	wp_enqueue_style(
		$style_name,
		plugins_url(
			$style_path,
			__FILE__
		),
		[],
		EEFSTATFIFY_VERSION
	);
}

/**
 * Loads the JavaScript file.
 *
 * @param string $script_name the name of the script.
 * @param string $script_path the plugin-relative path of the JavaScript.
 * @param array  $dependencies the dependencies.
 */
function eefstatify_enqueue_script( $script_name, $script_path, $dependencies = [] ) {
	wp_enqueue_script(
		$script_name,
		plugins_url(
			$script_path,
			__FILE__
		),
		$dependencies,
		EEFSTATFIFY_VERSION
	);
}

/**
 * Create an item and submenu items in the WordPress admin menu.
 */
function eefstatify_add_menu() {
	$page_hook_suffixes   = [];
	$page_hook_suffixes[] = add_menu_page(
		__( 'Statify – Extended Evaluation', 'extended-evaluation-for-statify' ), // page title.
		'Statify', // title in the menu.
		'see_statify_evaluation',
		'extended_evaluation_for_statify_dashboard',
		'eefstatify_show_dashboard',
		'dashicons-chart-bar',
		50
	);
	$page_hook_suffixes[] = add_submenu_page(
		'extended_evaluation_for_statify_dashboard',
		__( 'Content', 'extended-evaluation-for-statify' )
		. ' &mdash; ' . __( 'Statify – Extended Evaluation', 'extended-evaluation-for-statify' ),
		__( 'Content', 'extended-evaluation-for-statify' ),
		'see_statify_evaluation',
		'extended_evaluation_for_statify_content',
		'eefstatify_show_content'
	);
	$page_hook_suffixes[] = add_submenu_page(
		'extended_evaluation_for_statify_dashboard',
		__( 'Referrers', 'extended-evaluation-for-statify' )
		. ' &mdash; ' . __( 'Statify – Extended Evaluation', 'extended-evaluation-for-statify' ),
		__( 'Referrers', 'extended-evaluation-for-statify' ),
		'see_statify_evaluation',
		'extended_evaluation_for_statify_referrer',
		'eefstatify_show_referrer'
	);

	// Load CSS and JavaScript on plugin pages.
	foreach ( $page_hook_suffixes as $page_hook_suffix ) {
		add_action( "admin_print_styles-{$page_hook_suffix}", 'eefstatify_register_and_load_assets' );
	}
}

// Register the menu building function.
add_action( 'admin_menu', 'eefstatify_add_menu' );

/**
 * Adds a custom capability for users who see the evaluation pages.
 */
function eefstatify_add_capability() {
	// Only administrators can see the evaluation by default.
	$role = get_role( 'administrator' );
	if ( $role ) {
		$role->add_cap( 'see_statify_evaluation' );
	}

	// Remove old role Statify Analyst.
	$role = get_role( 'statify_evaluator' );
	if ( $role ) {
		remove_role( 'statify_evaluator' );
	}
}

// Adds the capability.
add_action( 'admin_init', 'eefstatify_add_capability' );

/**
 * Checks whether the current user is in the admin area and has the capability to see the evaluation.
 *
 * @return true if and only if the current user is allowed to see plugin pages
 */
function eefstatify_current_user_can_see_evaluation() {
	return is_admin() && current_user_can( 'see_statify_evaluation' );
}

/**
 * Show the dashboard page.
 */
function eefstatify_show_dashboard() {
	eefstatify_load_view( __DIR__ . '/views/dashboard.php' );
}

/**
 * Show the most popular content statistics page.
 */
function eefstatify_show_content() {
	eefstatify_load_view( __DIR__ . '/views/content.php' );
}

/**
 * Show the referrer statistics page.
 */
function eefstatify_show_referrer() {
	eefstatify_load_view( __DIR__ . '/views/referrers.php' );
}

/**
 * Loads the view template.
 *
 * @param string $view_path the path to the view template.
 */
function eefstatify_load_view( $view_path ) {
	if ( eefstatify_current_user_can_see_evaluation() ) {
		load_template(
			wp_normalize_path( $view_path )
		);
	}
}