← All changes | classes/Visualizer/Module.php +260 -23 3.1.2 → 3.6.1 View file →

		@@ -65,12 +65,28 @@
65	65	$this->_plugin = $plugin;
66	66
67	67	$this->_addFilter( Visualizer_Plugin::FILTER_UNDO_REVISIONS, 'undoRevisions', 10, 2 );
68	68	$this->_addFilter( Visualizer_Plugin::FILTER_HANDLE_REVISIONS, 'handleExistingRevisions', 10, 2 );
	69	+ $this->_addFilter( Visualizer_Plugin::FILTER_GET_CHART_DATA_AS, 'getDataAs', 10, 3 );
	70	+ register_shutdown_function( array($this, 'onShutdown') );
69	71
70	72	}
71	73
72	74	/**
	75	+ * Register a shutdown hook to catch fatal errors.
	76	+ *
	77	+ * @since ?
	78	+ *
	79	+ * @access public
	80	+ */
	81	+ public function onShutdown() {
	82	+ $error = error_get_last();
	83	+ if ( $error && $error['type'] === E_ERROR && false !== strpos( $error['file'], 'Visualizer/' ) ) {
	84	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Critical error %s', print_r( $error, true ) ), 'error', __FILE__, __LINE__ );
	85	+ }
	86	+ }
	87	+
	88	+ /**
73	89	* Registers an action hook.
74	90	*
75	91	* @since 1.0.0
76	92	* @uses add_action() To register action hook.
		@@ -147,8 +163,17 @@
147	163	return $this;
148	164	}
149	165
150	166	/**
	167	+ * A wrapper around the actual function _getDataAs. This function is invoked as a filter.
	168	+ *
	169	+ * @since 3.2.0
	170	+ */
	171	+ public function getDataAs( $final, $chart_id, $type ) {
	172	+ return $this->_getDataAs( $chart_id, $type );
	173	+ }
	174	+
	175	+ /**
151	176	* Extracts the data for a chart and prepares it for the given type.
152	177	*
153	178	* @access public
154	179	* @param int $chart_id The chart id.
		@@ -158,15 +183,15 @@
158	183	$final = null;
159	184	$success = false;
160	185	if ( $chart_id ) {
161	186	$chart = get_post( $chart_id );
162		- $success = $chart && $chart->post_type == Visualizer_Plugin::CPT_VISUALIZER;
	187	+ $success = $chart && $chart->post_type === Visualizer_Plugin::CPT_VISUALIZER;
163	188	}
164	189	if ( $success ) {
165	190	$settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
166	191	$rows = array();
167	192	$series = get_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, true );
168		- $data = unserialize( $chart->post_content );
	193	+ $data = self::get_chart_data( $chart, $type, false );
169	194	if ( ! empty( $series ) ) {
170	195	$row = array();
171	196	foreach ( $series as $array ) {
172	197	$row[] = $array['label'];
		@@ -195,14 +220,29 @@
195	220	}
196	221	}
197	222	}
198	223
199		- $filename = isset( $settings['title'] ) && ! empty( $settings['title'] ) ? $settings['title'] : 'visualizer#' . $chart_id;
	224	+ $title = 'visualizer#' . $chart_id;
	225	+ if ( ! empty( $settings['title'] ) ) {
	226	+ $title = $settings['title'];
	227	+ }
	228	+ // for ChartJS, title is an array.
	229	+ if ( is_array( $title ) && isset( $title['text'] ) ) {
	230	+ $title = $title['text'];
	231	+ }
	232	+ if ( empty( $title ) ) {
	233	+ $title = 'visualizer#' . $chart_id;
	234	+ }
200	235
	236	+ $filename = $title;
	237	+
201	238	switch ( $type ) {
202	239	case 'csv':
203		- $final = $this->_getCSV( $rows, $filename );
	240	+ $final = $this->_getCSV( $rows, $filename, false );
204	241	break;
	242	+ case 'csv-display':
	243	+ $final = $this->_getCSV( $rows, $filename, true );
	244	+ break;
205	245	case 'xls':
206	246	$final = $this->_getExcel( $rows, $filename );
207	247	break;
208	248	case 'print':
		@@ -207,8 +247,11 @@
207	247	break;
208	248	case 'print':
209	249	$final = $this->_getHTML( $rows );
210	250	break;
	251	+ case 'image':
	252	+ $final = $this->_getImage( $chart );
	253	+ break;
211	254	}
212	255	}
213	256	return $final;
214	257	}
		@@ -218,24 +261,43 @@
218	261	*
219	262	* @access private
220	263	* @param array $rows The array of data.
221	264	* @param string $filename The name of the file to use.
	265	+ * @param bool $enclose Enclose strings that have commas in them in double quotes.
222	266	*/
223		- private function _getCSV( $rows, $filename ) {
	267	+ private function _getCSV( $rows, $filename, $enclose ) {
224	268	$filename .= '.csv';
225	269
	270	+ $bom = chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF );
226	271	$fp = tmpfile();
	272	+ if ( ! apply_filters( 'vizualizer_export_include_series_type', true ) ) {
	273	+ unset( $rows[1] );
	274	+ $rows = array_values( $rows );
	275	+ }
227	276	// support for MS Excel
228		- fprintf( $fp, $bom = ( chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ) ) );
	277	+ fprintf( $fp, $bom );
229	278	foreach ( $rows as $row ) {
230	279	fputcsv( $fp, $row );
231	280	}
232	281	rewind( $fp );
233	282	$csv = '';
	283	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
234	284	while ( ( $array = fgetcsv( $fp ) ) !== false ) {
235	285	if ( strlen( $csv ) > 0 ) {
236	286	$csv .= PHP_EOL;
237	287	}
	288	+ // if enclosure is required, check every item of this line
	289	+ // if a comma exists in the item, add enclosure.
	290	+ if ( $enclose ) {
	291	+ $temp_array = array();
	292	+ foreach ( $array as $item ) {
	293	+ if ( strpos( $item, ',' ) !== false ) {
	294	+ $item = VISUALIZER_CSV_ENCLOSURE . $item . VISUALIZER_CSV_ENCLOSURE;
	295	+ }
	296	+ $temp_array[] = $item;
	297	+ }
	298	+ $array = $temp_array;
	299	+ }
238	300	$csv .= implode( ',', $array );
239	301	}
240	302	fclose( $fp );
241	303
		@@ -241,8 +303,9 @@
241	303
242	304	return array(
243	305	'csv' => $csv,
244	306	'name' => $filename,
	307	+ 'string' => str_replace( $bom, '', $csv ),
245	308	);
246	309	}
247	310
248	311	/**
		@@ -252,30 +315,44 @@
252	315	* @param array $rows The array of data.
253	316	* @param string $filename The name of the file to use.
254	317	*/
255	318	private function _getExcel( $rows, $filename ) {
256		- // PHPExcel does not like sheet names longer than 31 characters.
	319	+ // PHPExcel did not like sheet names longer than 31 characters and we will assume the same with PhpSpreadsheet
257	320	$chart = substr( $filename, 0, 30 );
258	321	$filename .= '.xlsx';
259		-
	322	+ if ( ! apply_filters( 'vizualizer_export_include_series_type', true ) ) {
	323	+ unset( $rows[1] );
	324	+ $rows = array_values( $rows );
	325	+ $rows = array_map(
	326	+ function( $r ) {
	327	+ return array_map( 'strval', $r );
	328	+ },
	329	+ $rows
	330	+ );
	331	+ }
	332	+ $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php';
	333	+ if ( is_readable( $vendor_file ) ) {
	334	+ include_once( $vendor_file );
	335	+ }
260	336	$xlsData = '';
261		- if ( class_exists( 'PHPExcel' ) ) {
262		- $doc = new PHPExcel();
	337	+ if ( class_exists( 'PhpOffice\PhpSpreadsheet\Spreadsheet' ) ) {
	338	+ $doc = new PhpOffice\PhpSpreadsheet\Spreadsheet();
263	339	$doc->getActiveSheet()->fromArray( $rows, null, 'A1' );
264	340	$doc->getActiveSheet()->setTitle( sanitize_title( $chart ) );
265	341	$doc = apply_filters( 'visualizer_excel_doc', $doc );
266		- $writer = PHPExcel_IOFactory::createWriter( $doc, 'Excel2007' );
	342	+ $writer = PhpOffice\PhpSpreadsheet\IOFactory::createWriter( $doc, 'Xlsx' );
267	343	ob_start();
268	344	$writer->save( 'php://output' );
269	345	$xlsData = ob_get_contents();
270	346	ob_end_clean();
271	347	} else {
272		- do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PHPExcel does not exist!', 'error', __FILE__, __LINE__ );
273		- error_log( 'Class PHPExcel does not exist!' );
	348	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!', 'error', __FILE__, __LINE__ );
	349	+ error_log( 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!' );
274	350	}
275	351	return array(
276	352	'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ),
277	353	'name' => $filename,
	354	+ 'raw' => base64_encode( $xlsData ),
278	355	);
279	356	}
280	357
281	358	/**
		@@ -305,8 +382,14 @@
305	382
306	383	$table = '<table class="visualizer-print">';
307	384	$index = 0;
308	385	foreach ( $rows as $row ) {
	386	+ // skip the data type row.
	387	+ if ( 1 === $index ) {
	388	+ $index++;
	389	+ continue;
	390	+ }
	391	+
309	392	$table .= '<tr>';
310	393	foreach ( $row as $col ) {
311	394	if ( $index === 0 ) {
312	395	$table .= '<th>' . $col . '</th>';
		@@ -327,8 +410,22 @@
327	410	);
328	411	}
329	412
330	413	/**
	414	+ * Disable revisions temporarily for visualizer post type.
	415	+ */
	416	+ protected final function disableRevisionsTemporarily() {
	417	+ add_filter(
	418	+ 'wp_revisions_to_keep', function( $num, $post ) {
	419	+ if ( $post->post_type === Visualizer_Plugin::CPT_VISUALIZER ) {
	420	+ return 0;
	421	+ }
	422	+ return $num;
	423	+ }, 10, 2
	424	+ );
	425	+ }
	426	+
	427	+ /**
331	428	* Undo revisions for the chart, and if necessary, restore the earliest version.
332	429	*
333	430	* @return bool If any revisions were found.
334	431	*/
		@@ -333,9 +430,11 @@
333	430	* @return bool If any revisions were found.
334	431	*/
335	432	public final function undoRevisions( $chart_id, $restore = false ) {
336	433	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'undoRevisions for %d with%s restore', $chart_id, ( $restore ? '' : 'out' ) ), 'debug', __FILE__, __LINE__ );
337		-
	434	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	435	+ return false;
	436	+ }
338	437	$revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) );
339	438	if ( count( $revisions ) > 1 ) {
340	439	$revision_ids = array_keys( $revisions );
341	440
		@@ -341,9 +440,9 @@
341	440
342	441	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'found %d revisions = %s', count( $revisions ), print_r( $revision_ids, true ) ), 'debug', __FILE__, __LINE__ );
343	442
344	443	// when we restore, a new revision is likely to be created. so, let's disable revisions for the time being.
345		- add_filter( 'wp_revisions_to_keep', '__return_false' );
	444	+ $this->disableRevisionsTemporarily();
346	445
347	446	if ( $restore ) {
348	447	// restore to the oldest one i.e. the first one.
349	448	wp_restore_post_revision( array_shift( $revision_ids ) );
		@@ -362,10 +461,13 @@
362	461	/**
363	462	* If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing.
364	463	*/
365	464	public final function handleExistingRevisions( $chart_id, $chart ) {
	465	+
366	466	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'handleExistingRevisions for %d', $chart_id ), 'debug', __FILE__, __LINE__ );
367		-
	467	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	468	+ return $chart_id;
	469	+ }
368	470	// undo revisions.
369	471	$revisions_found = $this->undoRevisions( $chart_id, true );
370	472
371	473	// create revision for the edit action.
		@@ -413,11 +515,16 @@
413	515	require_once( ABSPATH . 'wp-admin/includes/file.php' );
414	516	WP_Filesystem();
415	517	global $wp_filesystem;
416	518
417		- $dir = $wp_filesystem->wp_content_dir() . 'uploads/visualizer';
418		- $file = $wp_filesystem->wp_content_dir() . 'uploads/visualizer/customization.js';
	519	+ $multisite_arg = '/';
	520	+ if ( is_multisite() && ! is_main_site() ) {
	521	+ $multisite_arg = '/sites/' . get_current_blog_id() . '/';
	522	+ }
419	523
	524	+ $dir = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer';
	525	+ $file = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer/customization.js';
	526	+
420	527	if ( $wp_filesystem->is_readable( $file ) ) {
421	528	return $specific;
422	529	}
423	530
		@@ -426,8 +533,9 @@
426	533	return $default;
427	534	}
428	535
429	536	if ( ! $wp_filesystem->exists( $dir ) ) {
	537	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
430	538	if ( ( $done = $wp_filesystem->mkdir( $dir ) ) === false ) {
431	539	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to create directory %s', $dir ), 'error', __FILE__, __LINE__ );
432	540	return $default;
433	541	}
		@@ -435,8 +543,9 @@
435	543
436	544	// if file does not exist, copy.
437	545	if ( ! $wp_filesystem->exists( $file ) ) {
438	546	$src = str_replace( ABSPATH, $wp_filesystem->abspath(), VISUALIZER_ABSPATH . '/js/customization.js' );
	547	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
439	548	if ( ( $done = $wp_filesystem->copy( $src, $file ) ) === false ) {
440	549	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to copy file %s to %s', $src, $file ), 'error', __FILE__, __LINE__ );
441	550	return $default;
442	551	}
		@@ -448,18 +557,21 @@
448	557	/**
449	558	* Load the class for the given chart's chart type so that its assets can be loaded.
450	559	*/
451	560	protected function load_chart_type( $chart_id ) {
452		- $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
453		- $name = 'Visualizer_Render_Sidebar_Type_' . ucwords( $type );
	561	+ $name = $this->load_chart_class_name( $chart_id );
454	562	$class = null;
455	563	if ( class_exists( $name ) || true === apply_filters( 'visualizer_load_chart', false, $name ) ) {
	564	+ if ( 'Visualizer_Render_Sidebar_Type_DataTable_DataTable' === $name ) {
	565	+ $name = 'Visualizer_Render_Sidebar_Type_DataTable_Tabular';
	566	+ }
456	567	$class = new $name;
457	568	}
458	569
459		- if ( is_null( $class ) && VISUALIZER_PRO ) {
	570	+ if ( is_null( $class ) && Visualizer_Module::is_pro() ) {
460	571	// lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-).
461		- $class = apply_filters( 'visualizer_pro_chart_type_sidebar', null, array( 'type' => $type, 'settings' => get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true ) ) );
	572	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	573	+ $class = apply_filters( 'visualizer_pro_chart_type_sidebar', null, array( 'id' => $chart_id, 'type' => $type, 'settings' => get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true ) ) );
462	574	}
463	575
464	576	return is_null( $class ) ? null : $class->getLibrary();
465	577	}
		@@ -464,8 +576,26 @@
464	576	return is_null( $class ) ? null : $class->getLibrary();
465	577	}
466	578
467	579	/**
	580	+ * Returns the class name for the given chart's chart type.
	581	+ */
	582	+ protected function load_chart_class_name( $chart_id ) {
	583	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	584	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	585	+
	586	+ // backward compatibility.
	587	+ if ( empty( $lib ) ) {
	588	+ $lib = 'GoogleCharts';
	589	+ if ( 'dataTable' === $type ) {
	590	+ $lib = 'DataTable';
	591	+ }
	592	+ }
	593	+ $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type );
	594	+ return $name;
	595	+ }
	596	+
	597	+ /**
468	598	* Generates the inline CSS to apply to the chart and adds these classes to the settings.
469	599	*
470	600	* @access public
471	601	* @param int $id The id of the chart.
		@@ -486,9 +616,9 @@
486	616	foreach ( $element as $property => $value ) {
487	617	$attributes[] = $this->handle_css_property( $property, $value );
488	618	}
489	619	$class_name = $id . $name;
490		- $properties = implode( '; ', array_filter( $attributes ) );
	620	+ $properties = implode( ' !important; ', array_filter( $attributes ) );
491	621	if ( ! empty( $properties ) ) {
492	622	$css .= '.' . $class_name . ' {' . $properties . ' !important;}';
493	623	$classes[ $name ] = $class_name;
494	624	}
		@@ -542,5 +672,112 @@
542	672	$q = new WP_Query( $args );
543	673	return $q->found_posts > 0;
544	674	}
545	675
	676	+ /**
	677	+ * Determines how many charts have been created.
	678	+ */
	679	+ protected static function numberOfCharts() {
	680	+ $args = array(
	681	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	682	+ 'fields' => 'ids',
	683	+ 'post_status' => 'publish',
	684	+ 'posts_per_page' => 300,
	685	+ );
	686	+
	687	+ $q = new WP_Query( $args );
	688	+ return $q->found_posts;
	689	+ }
	690	+
	691	+ /**
	692	+ * Checks if the PRO version is active.
	693	+ *
	694	+ * @since 3.3.0
	695	+ */
	696	+ public static function is_pro() {
	697	+ // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO
	698	+ // versions of pro 1.9.0 onwards will use the filter
	699	+ return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO );
	700	+ }
	701	+
	702	+ /**
	703	+ * Checks if the PRO version is older than a particular version.
	704	+ *
	705	+ * @since 3.3.0
	706	+ */
	707	+ public static function is_pro_older_than( $version ) {
	708	+ return version_compare( VISUALIZER_PRO_VERSION, $version, '<' );
	709	+ }
	710	+
	711	+ /**
	712	+ * Should we show some specific feature on the basis of the version?
	713	+ *
	714	+ * @since 3.4.0
	715	+ */
	716	+ public static function can_show_feature( $feature ) {
	717	+ switch ( $feature ) {
	718	+ case 'simple-editor':
	719	+ // if user has pro but an older version, then don't load the simple editor functionality
	720	+ // as the select box will not behave as expected because the pro editor's functionality will supercede.
	721	+ return ! Visualizer_Module::is_pro() || ! Visualizer_Module::is_pro_older_than( '1.9.2' );
	722	+ }
	723	+ return false;
	724	+ }
	725	+
	726	+ /**
	727	+ * Gets the features for the provided license type.
	728	+ */
	729	+ public static final function get_features_for_license( $plan ) {
	730	+ switch ( $plan ) {
	731	+ case 1:
	732	+ return array( 'import-wp', 'db-query' );
	733	+ case 2:
	734	+ return array( 'schedule-chart', 'chart-permissions' );
	735	+ }
	736	+ }
	737	+
	738	+ /**
	739	+ * Gets the chart content after common manipulations.
	740	+ */
	741	+ public static function get_chart_data( $chart, $type, $run_filter = true ) {
	742	+ // change HTML entities
	743	+ $data = unserialize( html_entity_decode( $chart->post_content ) );
	744	+ $altered = array();
	745	+ foreach ( $data as $index => $array ) {
	746	+ if ( ! is_array( $index ) && is_array( $array ) ) {
	747	+ foreach ( $array as &$datum ) {
	748	+ if ( is_string( $datum ) ) {
	749	+ $datum = stripslashes( $datum );
	750	+ }
	751	+ }
	752	+ $altered[ $index ] = $array;
	753	+ }
	754	+ }
	755	+ // if something goes wrong and the end result is empty, be safe and use the original data
	756	+ if ( empty( $altered ) ) {
	757	+ $altered = $data;
	758	+ }
	759	+ if ( $run_filter ) {
	760	+ return apply_filters( Visualizer_Plugin::FILTER_GET_CHART_DATA, $altered, $chart->ID, $type );
	761	+ }
	762	+ return $altered;
	763	+ }
	764	+
	765	+ /**
	766	+ * Get chart image.
	767	+ *
	768	+ * @param object $chart Chart data.
	769	+ * @return string
	770	+ */
	771	+ public function _getImage( $chart = null ) {
	772	+ $image = '';
	773	+ if ( $chart ) {
	774	+ $chart_image = get_post_meta( $chart->ID, Visualizer_Plugin::CF_CHART_IMAGE, true );
	775	+ if ( ! empty( $chart_image ) ) {
	776	+ $image = wp_get_attachment_image( $chart_image, 'full' );
	777	+ }
	778	+ }
	779	+ return array(
	780	+ 'csv' => $image,
	781	+ );
	782	+ }
546	783	}