custom-logging-service.php

<?php
/*
Plugin Name: Custom Logging Service
Plugin URI: https://github.com/ccprog/custom-logging-service
Version: 1.0.3
Author: Claus Colloseus
Author URI: https://browser-unplugged.net
Text Domain: custom-logging-service
Description: Provides a simple API for storing miscellaneous log entries and displays them in a Dashboard subpage.
License: GPL2

Copyright Claus Colloseus 2016
Based on  https://wordpress.org/plugins/wordpress-logging-service/
Copyright 2011-2013 Zaantar (email: zaantar@zaantar.eu)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License, version 2, as
    published by the Free Software Foundation.

    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 St, Fifth Floor, Boston, MA  02110-1301  USA
*/

/*** Bootstrap ***/

define( 'CLGS_VERSION', '1.0.3' );

define( 'CLGS_SETTINGS', 'clgs_settings' );
define( 'CLGS_LOG_PAGE', 'clgs_manager' );
define( 'CLGS_OPTION_PAGE', 'clgs_options' );
define( 'CLGS_GROUP', 'clgs_group' );
define( 'CLGS_CAP', 'clgs_manage' );

define( 'CLGS_NOSEVERITY', 0 );
define( 'CLGS_INFO', 1 );
define( 'CLGS_NOTICE', 2 );
define( 'CLGS_WARNING', 3 );
define( 'CLGS_ERROR', 4 );
define( 'CLGS_FATALERROR', 5 );

global $severity_list, $clgs_db, $clgs_last_log;

/**
 * list of severity level names
 *
 *  @const array
 */
$severity_list = [
    CLGS_NOSEVERITY => 'none',
    CLGS_INFO => 'debug',
    CLGS_NOTICE => 'notice',
    CLGS_WARNING => 'warning',
    CLGS_ERROR => 'error',
    CLGS_FATALERROR => 'fatal'
];

if ( ! function_exists( 'wp_roles' ) ) {
    function wp_roles() {
        global $wp_roles;
    
        if ( ! isset( $wp_roles ) ) {
            $wp_roles = new WP_Roles();
        }
        return $wp_roles;
    }
}

require_once plugin_dir_path( __FILE__ ).'includes/functions.php';
require_once plugin_dir_path( __FILE__ ).'includes/schemas.php';
require_once plugin_dir_path( __FILE__ ).'includes/settings.php';

spl_autoload_register(function ($class_name) {
    $class_map = array(
        'Clgs_DB' => 'includes/class-database.php',
        'Clgs_last_log' => 'includes/class-last-log.php',
        'Clgs_Manager' => 'includes/class-manager.php',
        'Clgs_REST_Controller' => 'includes/class-rest-controller.php',
        'Clgs_REST_Categories' => 'includes/class-rest-categories.php',
        'Clgs_REST_Logs' => 'includes/class-rest-logs.php'  
    );
    if (isset($class_map[$class_name])) {
        require plugin_dir_path( __FILE__ ) . $class_map[$class_name];
    }
});

$plugin_basename = plugin_basename( __FILE__ );

/*** (De)Installation and (De)Activation ***/

/**
 * tests prerequisites and creates DB tables on activation
 *
 * @global Clgs_DB $clgs_db
 *
 * @param bool $network_wide indicates network install
 *
 * @return void
 */
function clgs_activation ( $network_wide = null ) {
    global $clgs_db;

    if ( version_compare( PHP_VERSION, '5.3', '<' ) ) {
        add_action( 'admin_notices', create_function( '', "echo '<div class=\"error\"><p>This plugin requires at least version 5.3 of PHP. Please contact your server administrator before you activate this plugin.</p></div>';" ) );
        trigger_error( 'Plugin could not be activated.', E_USER_ERROR );
    }

    $clgs_db = new Clgs_DB();

    $clgs_db->create();
    clgs_add_settings( $network_wide );
    update_option( 'clgs_version', CLGS_VERSION );
}
register_activation_hook( __FILE__, 'clgs_activation' );

/**
 * global class setup and
 * placeholder routine for update actions
 *
 * @global Clgs_DB $clgs_db
 * @global Clgs_DB $clgs_last_log
 *
 * @return void
 */
function clgs_update () {
    global $clgs_db, $clgs_last_log;

    if (!isset($clgs_db)) $clgs_db = new Clgs_DB();
    if (!isset($clgs_last_log)) $clgs_last_log = new Clgs_last_log();

    $old_version = get_option( 'clgs_version' );
    if ( version_compare( CLGS_VERSION, $old_version , '<' ) ) {
        // placeholder
        update_option( 'clgs_version', CLGS_VERSION );
    }
}
add_action( 'plugins_loaded', 'clgs_update' );

/**
 * deletes management capability and flushes log entry cache on deactivation
 *
 * @global Clgs_DB $clgs_db
 * @global WP_Roles $wp_roles
 *
 * @return void
 */
function clgs_deactivation () {
    global $clgs_last_log, $wp_roles;

    foreach ( $wp_roles->role_objects as $name => $role ) {
        $role->remove_cap( CLGS_CAP );
    }
    $clgs_last_log->flush();
}
register_deactivation_hook( __FILE__, 'clgs_deactivation' );

/**
 * deletes options and DB tables on uninstallation
 *
 * @global Clgs_DB $clgs_db
 *
 * @return void
 */
function clgs_uninstall () {
    global $clgs_db;
    
    delete_option( 'clgs_version' );
    delete_option( CLGS_SETTINGS );
    delete_site_option( CLGS_SETTINGS );
    delete_site_option( Clgs_last_log::OPTION );
    $clgs_db->destroy();
}
register_uninstall_hook( __FILE__, 'clgs_uninstall' );

/*** Loading ***/

/**
 * registers the text domain
 *
 * @return void
 */
function clgs_load_textdomain () {
	$plugin_dir = basename( dirname(__FILE__) );
	load_plugin_textdomain( 'custom-logging-service', false, $plugin_dir.'/languages' );
}
add_action( 'plugins_loaded', 'clgs_load_textdomain' );

/**
 * enqueues script and style files
 *
 * @return void
 */
function clgs_admin_enqueue_styles() {
	if( isset( $_REQUEST["page"] ) && CLGS_LOG_PAGE == $_REQUEST["page"] ) {
        $columns = array();

        foreach ( clgs_get_item_schema( 'column' ) as $key => $attrs ) {
            $columns[$key] = $attrs['title'];
        }

		wp_enqueue_style( "clgs-admin-style", plugins_url( "style.css", __FILE__ ) );
        wp_enqueue_script( "clgs-manager-script",
            plugins_url( "includes/manager.js", __FILE__ ), ['jquery', 'backbone'], false, true );
        wp_localize_script( "clgs-manager-script", "clgs_base", array(
            'l10n' => array(
                'unseen' => str_replace( '%d', '<%= count %>', __( '%d unseen Log entries', 'custom-logging-service' ) ),
                'of' => __('of'),
                'items' => __('items'),
                'item' => __('item'),
                'no_items' => __( 'No items found.' ),
                'new' => __('New Entry', 'custom-logging-service'),
                'more' => __('Show more details'),
            ),
            'rest_base' => get_rest_url() . 'clgs',
            'nonce' => wp_create_nonce( 'wp_rest' ),
            'used_columns' => $columns,
        ) );
	}
}
add_action( "admin_enqueue_scripts", "clgs_admin_enqueue_styles" );

/**
 * registers the log and settings pages and their menu entries
 *
 * @return void
 */
function clgs_admin_menu () {
    $option_heading = __( 'Custom Logging Service', 'custom-logging-service' );
    $log_heading = __( 'Application logs', 'custom-logging-service' );
    $option_page = 'options-general.php';
    $option_cap =  'manage_options';

	if ( clgs_is_network_mode() ) {
        $option_page = 'settings.php';
        $option_cap =  'manage_network_options';
    }

    $manager = new Clgs_Manager();

	add_dashboard_page( $log_heading, $log_heading . clgs_unseen_field(),
        CLGS_CAP, CLGS_LOG_PAGE, array($manager, 'render_page') );
    add_submenu_page( $option_page, $option_heading, $option_heading,
        $option_cap, CLGS_OPTION_PAGE, 'clgs_settings_page' );
}
add_action( 'network_admin_menu', 'clgs_admin_menu' );
add_action( 'admin_menu', 'clgs_admin_menu' );

/**
 * returns notification bubble for log page menu entry
 *
 * @global Clgs_DB $clgs_db
 *
 * @return string bubble markup
 */
function clgs_unseen_field () {
    $unseen = clgs_get_unseen();

    if( $unseen > 0 ) {
        $title = sprintf( __( '%d unseen Log entries', 'custom-logging-service' ), $unseen );
        return " <span class=\"awaiting-mod count-$unseen\" aria-label=\"$title\"><span>$unseen</span></span>";
    } else {
        return '';
    }
}

/**
 * registers the REST routes
 *
 * @return void
 */
function clgs_register_rest_routes($server) {
    $controller = new Clgs_REST_Categories();
    $controller->register_routes();
    $controller = new Clgs_REST_Logs();
    $controller->register_routes();
}
add_action( 'rest_api_init', 'clgs_register_rest_routes' );

/*** Public API ***/

define( 'CLGS', true );

/**
 * @global Clgs_DB $clgs_db
 *
 * @param string $category
 *
 * @return boolean true if $category is registered.
 */
function clgs_is_registered ( $category ) {
    global $clgs_db;

	return $clgs_db->is_registered( $category );
}

/**
 * registers $category as a log category. $description will be shown in the
 * management page.
 *
 * @global Clgs_DB $clgs_db
 *
 * @param string $category At most 190 (unicode) characters
 * @param string $description can contain HTML same as comments (filtered by
 * wp_kses_data)
 *
 * @return boolean false if $category is already registered or it is too long.
 */
function clgs_register ( $category, $description ) {
    global $clgs_db;

    $description = clgs_sanitize( $description, 'kses_string' );
    return !$clgs_db->is_registered( $category ) &&
        $clgs_db->category_fits( $category ) &&
        $clgs_db->register( $category, $description );
}

/**
 * deletes all log entries and then removes $category.
 *
 * @global Clgs_DB $clgs_db
 *
 * @param string $category a registered category name
 *
 * @return boolean false if false if action failed.
 */
function clgs_unregister ( $category ) {
    global $clgs_db;

	return $clgs_db->bulk_category( 'unregister', $category );
}

/**
 * deletes all log entries of $category.
 *
 * @global Clgs_DB $clgs_db
 *
 * @param string $category a registered category name
 *
 * @return mixed number of deleted entries or false if action failed.
 */
function clgs_clear ( $category ) {
    global $clgs_db;

	return $clgs_db->bulk_category( 'clear', $category );
}

/**
 * writes a new log entry in the specified category.
 *
 * @global Clgs_DB $clgs_db
 * @global Clgs_Last_Log $clgs_last_log
 *
 * @param string $category a registered category name
 * @param string $message the logged message, can contain HTML same as comments
 * (filtered by wp_kses_data)
 * @param int $severity one of defined severity levels (see above); if missing
 * defaults to CLGS_NOCATEGORY
 * @param mixed $user user id, slug or WP user object are aceptable; if missing
 * defaults to current user (or a placeholder if none is logged in)
 * @param int $blog_id blog id; if missing defaults to current blog
 * @param mixed $date a UNIX timestamp or a string recognized by strtotime();
 * if missing defaults to current time
 *
 * @return boolean false if entering the log failed.
 */
function clgs_log ( $category, $message, $severity = null, $user = null, $blog_id = null, $date = null ) {
    global $clgs_db, $clgs_last_log;

    $args = compact('category', 'message', 'severity', 'user', 'blog_id', 'date');
    $data = clgs_prepare_data($args);
    if (false === $data) return false;

    if( $clgs_last_log->compare( $data ) ) {
        $clgs_last_log->write();

        $first =  $clgs_last_log->data['date'];
        $data['message'] = '(' . $clgs_last_log->count . '× ' .
            __('since ', 'custom-logging-service' ) . 
            '<span data-date="'. $first .'"></span>):<br/>' . $data['message'];

        $ok = (bool)$clgs_db->update_entry( $clgs_last_log->entry_id, $data );
    } else {
	    $entry_id = $clgs_db->insert_entry( $data );
        $ok = (bool)$entry_id;
        if ( $ok ) {
            $clgs_last_log->set( $data, $entry_id );
        }
    }
    return $ok;
}