wp-dashboard-request-stats.php

<?php
/**
* Plugin Name: WP Dashboard Request Stats
* Plugin URI: https://github.com/Seravo/wp-dashboard-request-stats
* Description: Draws a graph from access log data into a dashboard widget
* Author: Tari Zahabi / Seravo Oy
* Author URI: http://seravo.fi
* Version: 0.1.0
* License: GPLv2 or later
*/
/** Copyright 2014-2016 Seravo Oy
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
*/


/**
 * Class to store parsed data
 */
class time_data {
    public $time = NULL;
    public $request_count = 0;
    public $avg_resp = 0;
    //public $get_count= 0;
}

class dashboard_request_stats{

  //define defaults here
  const DEFAULT_AMOUNT = 7;
  const DEFAULT_TIME_REGEX = "#[0-3][0-9]/.{3}/20[0-9]{2}#"; //regex for timestamp
  const DEFAULT_RESPONSE_REGEX = "#[0-9]+.[0-9]+$#"; //regex for responsetime

  public static function get_instance() {
    static $drs_instance = null;
    if (null === $drs_instance) {
      $drs_instance = new dashboard_request_stats();
    }
    return $drs_instance;
  }

  /**
  * Initialize the plugin
  */
  public function __construct() {
    add_action( 'admin_enqueue_scripts', array( $this, 'init' ) );
    add_action( 'wp_dashboard_setup', array( $this,'add_dashboard_widget') );
    add_action( 'wp_ajax_get_chart_data',array( $this,'get_chart_data_callback') );
  }

  /**
  * Load external scripts and styles
  */
  public function init( $page_hook ) {

    //make sure the scripts/stylesheets are loaded only where needed
    if ( 'index.php' == $page_hook ){
      //external scripts
      wp_register_script( 'chartjs', plugins_url( '/script/Chart.js' , __FILE__), null, null, true );
      wp_register_script( 'drawjs', plugins_url( '/script/draw.js' , __FILE__), null, null, true );
      wp_enqueue_script( 'chartjs' );
      wp_enqueue_script( 'drawjs' );
      //styles
      wp_register_style( 'wpdrs_css', plugins_url('/styles/wpdrs.css', __FILE__) );
      wp_enqueue_style( 'wpdrs_css');

    //wp_localize_script( 'ajax-script', 'ajax_object', array( 'ajax_url' => admin_url( 'admin-ajax.php' )) );
    }

    else{
      return;
    }
  }

  /**
  * Add a widget to the dashboard.
  * This function is hooked into the 'wp_dashboard_setup' action below.
  */
  public function add_dashboard_widget() {
    wp_add_dashboard_widget(
                 'wp-dashboard-request-stats',     // Widget slug.
                 'Request Stats',                  // Title.
                 array($this,'create_widget_content') // Display function.
        );
  }

  /**
  * Create the function to output the contents of our Dashboard Widget.
  */
  public function create_widget_content() {
    require_once('widget.php');
  }

  /**
  * Parse a logfile and return an array of day_data objects
  */
  private function parse_log_file( $path , $regex_array ){
    //if the log file is gzipped
    if(preg_match('#gz#',$path)){
      $lines = gzfile( $path );
    }
    else{
      $lines = file( $path );
    }
    if($lines==false){
      return false;
    }
    
    $unit = new time_data;
    $time_array = array();
    
    foreach ( $lines as $line ){
    //do the parsing
    $parsed_line = $this->wpdrs_parser($line,$regex_array);
    $parsed_line['time'] = str_replace('/',' ',$parsed_line['time']);
  
    if(is_null($unit->time))
      $unit->time = $parsed_line['time'];
    if($unit->time != $parsed_line['time']){
      $unit->avg_resp = $unit->avg_resp / $unit->request_count;
      $time_array[] = $unit;
      $unit = new time_data;
    }  
    //one request = one line in logfile
    $unit->request_count++;
    $unit->avg_resp = $unit->avg_resp + $parsed_line['response'];
    }
    $unit->avg_resp = $unit->avg_resp / $unit->request_count;
    $time_array[] = $unit;
    
    return $time_array;
  }


  /**
  * Fetch the chart data for ajax-calls
  */
  public function get_chart_data_callback() {
    //define logpath in wp-config
    if( !defined( 'WPDRS_LOGPATH' ) ){
      $log_location = dirname( ini_get( 'error_log' ) );
    }
    else{
      $log_location = WPDRS_LOGPATH;
    }
  
    $log_file = '/total-access.log*';
    $log_files = glob( $log_location . $log_file ); // all available logfiles, including gzipped ones
    $amount = self::DEFAULT_AMOUNT;
    
    //if a certain amount is requested
    if( isset($_GET['amount']) ){
      $amount = $_GET['amount'];
    }
  
    $unit_data = $this->get_log_data( $log_files, $amount );
  
    echo ( json_encode( $unit_data ) );
    wp_die();
  }

  /**
  * Remove duplicate values from an array and make sure the entries in the array are in proper order
  */
  private function clean_array( $array ){
  
    if(!is_array($array)){
      return false;
    }

    $temp_array = array();
    $temp_array2 = array();
  
    
    //get a list of unique dates
    for( $x = 0; $x < count($array) ; $x++ ){
      $temp_array[]= $array[$x]->time;
    }
  
    $temp_array = array_unique($temp_array);
    $temp_array = array_values($temp_array);
    //sort the array entries by date
    /*for( $x = 0; $x < count($temp_array); $x++ ){
    strtotime($temp_array[$x]);
    }*/
    //sort($temp_array);
  
    //sort the array entries by date
    usort($temp_array, function($item1, $item2) {
      $ts1 = strtotime($item1);
      $ts2 = strtotime($item2);
      return $ts2 - $ts1;
    });
    
    //usort reverses the values,
    $temp_array  = array_reverse($temp_array,false);

    //remove duplicates from array
    foreach( $temp_array as $date ){
      $asd = new time_data();
      $asd->time = $date;
      for( $x = 0; $x < count( $array );$x++ ){
        if( $date == $array[$x]->time ){
          $asd->request_count = $asd->request_count + $array[$x]->request_count;
          $asd->avg_resp = $asd->avg_resp + $array[$x]->avg_resp;
        }
      }
      $temp_array2[] = $asd;
    }
    $array = $temp_array2;
    return $array;
  }
  
  /**
  * Return desired amount of data specified in days
  */
  private function get_log_data( $logfiles, $amount ){
    //$time_exp = '#[0-3][0-9]/.{3}/20[0-9]{2}#';
    $regex_array = array('time' => self::DEFAULT_TIME_REGEX,'response' => self::DEFAULT_RESPONSE_REGEX);
    $temp_array = array();
    $unit_data = array();
    if( count($logfiles) == 0 ){
      return false;
    }
    
    foreach($logfiles as $file){
      //returns the contents of a logfile
      $temp_array = $this->parse_log_file( $file, $regex_array );
      foreach($temp_array as $entry){
        $unit_data[] = $entry;
        //makes sure the correct amount of days is returned
        //and that there are no duplicate entries in the array
        if(count($unit_data) >= $amount){
          $unit_data = $this->clean_array($unit_data); 
          if(count($unit_data) >= $amount){
            break 2;
          }
        }
      }
    }

    return $unit_data;
  }

  /**
  * Parses a line with regexs defined in the $regex_array
  */
  private function wpdrs_parser( $line, $regex_array){
    $matches;
    $results = array();
    foreach($regex_array as $key => $exp){
      if(preg_match($exp, $line,$matches)){
        $results[$key] = $matches[0];
      }
    }
    return $results;
  }
}

$dashboard_request_stats = dashboard_request_stats::get_instance();