Merge pull request #537 from contactashish13/issue-510

For every chart show the last updated date and any error that exists

Author: contactashish13

classes/Visualizer/Module/Chart.php

@@ -934,6 +934,8 @@ public function uploadData() {
 			exit;
 		}
 
+		do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Uploading data for chart %d with POST = %s and GET = %s', $chart_id, print_r( $_POST, true ), print_r( $_GET, true ) ), 'debug', __FILE__, __LINE__ );
+
 		if ( ! isset( $_POST['vz-import-time'] ) ) {
 			apply_filters( 'visualizer_pro_remove_schedule', $chart_id );
 		}
@@ -954,6 +956,9 @@ public function uploadData() {
 		delete_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_ROOT );
 		delete_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_PAGING );
 
+		// delete last error
+		delete_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR );
+
 		$source = null;
 		$render = new Visualizer_Render_Page_Update();
 		if ( isset( $_POST['remote_data'] ) && filter_var( $_POST['remote_data'], FILTER_VALIDATE_URL ) ) {
@@ -969,8 +974,13 @@ public function uploadData() {
 		} elseif ( isset( $_POST['table_data'] ) && 'yes' === $_POST['table_data'] ) {
 			$source = $this->handleTabularData();
 		} else {
+			do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'CSV file with chart data was not uploaded for chart %d.', $chart_id ), 'error', __FILE__, __LINE__ );
 			$render->message = esc_html__( 'CSV file with chart data was not uploaded. Please try again.', 'visualizer' );
+			update_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, esc_html__( 'CSV file with chart data was not uploaded. Please try again.', 'visualizer' ) );
 		}
+
+		do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Uploaded data for chart %d with source %s', $chart_id, print_r( $source, true ) ), 'debug', __FILE__, __LINE__ );
+
 		if ( $source ) {
 			if ( $source->fetch() ) {
 				$content    = $source->getData();
@@ -981,6 +991,7 @@ public function uploadData() {
 					// if we populate the data even if it is empty, the chart will show "Table has no columns".
 					if ( array_key_exists( 'source', $json ) && ! empty( $json['source'] ) && ( ! array_key_exists( 'data', $json ) || empty( $json['data'] ) ) ) {
 						do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Not populating chart data as source exists (%s) but data is empty!', $json['source'] ), 'warn', __FILE__, __LINE__ );
+						update_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, sprintf( 'Not populating chart data as source exists (%s) but data is empty!', $json['source'] ) );
 						$populate   = false;
 					}
 				}
@@ -992,6 +1003,8 @@ public function uploadData() {
 				update_post_meta( $chart->ID, Visualizer_Plugin::CF_SOURCE, $source->getSourceName() );
 				update_post_meta( $chart->ID, Visualizer_Plugin::CF_DEFAULT_DATA, 0 );
 
+				do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Updated post for chart %d', $chart_id ), 'debug', __FILE__, __LINE__ );
+
 				Visualizer_Module_Utility::set_defaults( $chart, null );
 
 				$settings = get_post_meta( $chart->ID, Visualizer_Plugin::CF_SETTINGS, true );
@@ -1001,11 +1014,16 @@ public function uploadData() {
 				$render->series = json_encode( $source->getSeries() );
 				$render->settings = json_encode( $settings );
 			} else {
-				$render->message = $source->get_error();
-				if ( empty( $render->message ) ) {
-					$render->message = esc_html__( 'CSV file is broken or invalid. Please try again.', 'visualizer' );
+				$error = $source->get_error();
+				if ( empty( $error ) ) {
+					$error = esc_html__( 'CSV file is broken or invalid. Please try again.', 'visualizer' );
 				}
+				$render->message = $error;
+				do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( '%s for chart %d.', $error, $chart_id ), 'error', __FILE__, __LINE__ );
+				update_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, $error );
 			}
+		} else {
+			do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unknown internal error for chart %d.', $chart_id ), 'error', __FILE__, __LINE__ );
 		}
 		$render->render();
 		if ( ! $can_die ) {

classes/Visualizer/Module/Setup.php

@@ -249,6 +249,8 @@ public function refresh_db_for_chart( $chart, $chart_id, $force = false ) {
 			);
 
 			$chart = get_post( $chart_id );
+		} else {
+			update_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, sprintf( 'Error while updating chart: %s', $error ) );
 		}
 
 		return $chart;

classes/Visualizer/Plugin.php

@@ -40,6 +40,7 @@ class Visualizer_Plugin {
 	const CF_DEFAULT_DATA = 'visualizer-default-data';
 	const CF_SETTINGS = 'visualizer-settings';
 	const CF_CHART_LIBRARY = 'visualizer-chart-library';
+	const CF_ERROR = 'visualizer-error';
 
 	const CF_SOURCE_FILTER = 'visualizer-source-filter';
 	const CF_FILTER_CONFIG = 'visualizer-filter-config';

classes/Visualizer/Render/Library.php

@@ -220,6 +220,13 @@ private function _renderChartBox( $placeholder_id, $chart_id ) {
 			),
 			admin_url( 'admin-ajax.php' )
 		);
+
+		$chart_status   = array( 'date' => get_the_modified_date( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), $chart_id ), 'error' => get_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, true ), 'icon' => 'dashicons-yes-alt', 'title' => '' );
+		if ( ! empty( $chart_status['error'] ) ) {
+			$chart_status['icon'] = 'error dashicons-dismiss';
+			$chart_status['title'] = __( 'Click to view the error', 'visualizer' );
+		}
+
 		echo '<div class="visualizer-chart"><div class="visualizer-chart-title">', esc_html( $title ), '</div>';
 		echo '<div id="', $placeholder_id, '" class="visualizer-chart-canvas">';
 		echo '<img src="', VISUALIZER_ABSURL, 'images/ajax-loader.gif" class="loader">';
@@ -232,6 +239,7 @@ private function _renderChartBox( $placeholder_id, $chart_id ) {
 		echo '<span class="visualizer-chart-shortcode" title="', esc_attr__( 'Click to select', 'visualizer' ), '">';
 		echo '&nbsp;[visualizer id=&quot;', $chart_id, '&quot;]&nbsp;';
 		echo '</span>';
+		echo '<hr><div class="visualizer-chart-status"><span class="visualizer-date" title="' . __( 'Last Updated', 'visualizer' ) . '">' . $chart_status['date'] . '</span><span class="visualizer-error"><i class="dashicons ' . $chart_status['icon'] . '" data-viz-error="' . esc_attr( str_replace( '"', "'", $chart_status['error'] ) ) . '" title="' . esc_attr( $chart_status['title'] ) . '"></i></span></div>';
 		echo '</div>';
 		echo '</div>';
 	}

css/library.css

@@ -311,3 +311,21 @@ div#visualizer-types ul, div#visualizer-types form p {
 	vertical-align: middle;
 	margin: 0;
 }
+
+.visualizer-chart-status {
+	padding: 3px 0;
+	color: #aaa;
+	text-shadow: 0 1px 0 #fff;
+}
+
+.visualizer-chart-status span.visualizer-error {
+	float: right;
+}
+
+.visualizer-error i {
+	color: green;
+}
+.visualizer-error i.error {
+	color: red;
+	cursor: pointer;
+}

index.php

@@ -91,6 +91,9 @@ function visualizer_launch() {
 	define( 'VISUALIZER_DB_QUERY_DOC_URL', 'https://docs.themeisle.com/article/970-visualizer-sample-queries-to-generate-charts' );
 	define( 'VISUALIZER_MAIN_DOC', 'https://docs.themeisle.com/category/657-visualizer' );
 
+	// to redirect all themeisle_log_event to error log.
+	define( 'VISUALIZER_LOCAL_DEBUG', false );
+
 	// instantiate the plugin
 	$plugin = Visualizer_Plugin::instance();
 
@@ -153,3 +156,17 @@ function visualizer_register_parrot( $plugins ) {
 spl_autoload_register( 'visualizer_autoloader' );
 // launch the plugin
 visualizer_launch();
+
+
+if ( VISUALIZER_LOCAL_DEBUG ) {
+	add_action( 'themeisle_log_event', 'visualizer_themeisle_log_event', 10, 5 );
+
+	/**
+	 * Redirect themeisle_log_event to error log.
+	 */
+	function visualizer_themeisle_log_event( $name, $msg, $type, $file, $line ) {
+		if ( $name === Visualizer_Plugin::NAME ) {
+			error_log( sprintf( '%s (%s:%d): %s', $type, $file, $line, $msg ) );
+		}
+	}
+}

js/library.js

@@ -1,4 +1,6 @@
 /* global visualizer */
+/* global alert */
+
 (function (wpmv) {
     var vm, vmv;
 
@@ -129,5 +131,9 @@
                 $('.visualizer-chart-canvas').adjust();
             }, 100);
         });
+
+        $('.visualizer-error i.error').on('click', function(){
+            alert( $(this).attr('data-viz-error') );
+        });
     });
 })(jQuery, visualizer.media.view, visualizer.urls);