← All changes | classes/Visualizer/Module.php +366 -15 3.0.9 → 3.4.8 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':
		@@ -218,24 +258,39 @@
218	258	*
219	259	* @access private
220	260	* @param array $rows The array of data.
221	261	* @param string $filename The name of the file to use.
	262	+ * @param bool $enclose Enclose strings that have commas in them in double quotes.
222	263	*/
223		- private function _getCSV( $rows, $filename ) {
	264	+ private function _getCSV( $rows, $filename, $enclose ) {
224	265	$filename .= '.csv';
225	266
	267	+ $bom = chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF );
226	268	$fp = tmpfile();
227	269	// support for MS Excel
228		- fprintf( $fp, $bom = ( chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ) ) );
	270	+ fprintf( $fp, $bom );
229	271	foreach ( $rows as $row ) {
230	272	fputcsv( $fp, $row );
231	273	}
232	274	rewind( $fp );
233	275	$csv = '';
	276	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
234	277	while ( ( $array = fgetcsv( $fp ) ) !== false ) {
235	278	if ( strlen( $csv ) > 0 ) {
236	279	$csv .= PHP_EOL;
237	280	}
	281	+ // if enclosure is required, check every item of this line
	282	+ // if a comma exists in the item, add enclosure.
	283	+ if ( $enclose ) {
	284	+ $temp_array = array();
	285	+ foreach ( $array as $item ) {
	286	+ if ( strpos( $item, ',' ) !== false ) {
	287	+ $item = VISUALIZER_CSV_ENCLOSURE . $item . VISUALIZER_CSV_ENCLOSURE;
	288	+ }
	289	+ $temp_array[] = $item;
	290	+ }
	291	+ $array = $temp_array;
	292	+ }
238	293	$csv .= implode( ',', $array );
239	294	}
240	295	fclose( $fp );
241	296
		@@ -241,8 +296,9 @@
241	296
242	297	return array(
243	298	'csv' => $csv,
244	299	'name' => $filename,
	300	+ 'string' => str_replace( $bom, '', $csv ),
245	301	);
246	302	}
247	303
248	304	/**
		@@ -252,30 +308,36 @@
252	308	* @param array $rows The array of data.
253	309	* @param string $filename The name of the file to use.
254	310	*/
255	311	private function _getExcel( $rows, $filename ) {
256		- // PHPExcel does not like sheet names longer than 31 characters.
	312	+ // PHPExcel did not like sheet names longer than 31 characters and we will assume the same with PhpSpreadsheet
257	313	$chart = substr( $filename, 0, 30 );
258	314	$filename .= '.xlsx';
259	315
	316	+ $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php';
	317	+ if ( is_readable( $vendor_file ) ) {
	318	+ include_once( $vendor_file );
	319	+ }
	320	+
260	321	$xlsData = '';
261		- if ( class_exists( 'PHPExcel' ) ) {
262		- $doc = new PHPExcel();
	322	+ if ( class_exists( 'PhpOffice\PhpSpreadsheet\Spreadsheet' ) ) {
	323	+ $doc = new PhpOffice\PhpSpreadsheet\Spreadsheet();
263	324	$doc->getActiveSheet()->fromArray( $rows, null, 'A1' );
264	325	$doc->getActiveSheet()->setTitle( sanitize_title( $chart ) );
265	326	$doc = apply_filters( 'visualizer_excel_doc', $doc );
266		- $writer = PHPExcel_IOFactory::createWriter( $doc, 'Excel2007' );
	327	+ $writer = PhpOffice\PhpSpreadsheet\IOFactory::createWriter( $doc, 'Xlsx' );
267	328	ob_start();
268	329	$writer->save( 'php://output' );
269	330	$xlsData = ob_get_contents();
270	331	ob_end_clean();
271	332	} 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!' );
	333	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!', 'error', __FILE__, __LINE__ );
	334	+ error_log( 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!' );
274	335	}
275	336	return array(
276	337	'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ),
277	338	'name' => $filename,
	339	+ 'raw' => base64_encode( $xlsData ),
278	340	);
279	341	}
280	342
281	343	/**
		@@ -305,8 +367,14 @@
305	367
306	368	$table = '<table class="visualizer-print">';
307	369	$index = 0;
308	370	foreach ( $rows as $row ) {
	371	+ // skip the data type row.
	372	+ if ( 1 === $index ) {
	373	+ $index++;
	374	+ continue;
	375	+ }
	376	+
309	377	$table .= '<tr>';
310	378	foreach ( $row as $col ) {
311	379	if ( $index === 0 ) {
312	380	$table .= '<th>' . $col . '</th>';
		@@ -327,8 +395,22 @@
327	395	);
328	396	}
329	397
330	398	/**
	399	+ * Disable revisions temporarily for visualizer post type.
	400	+ */
	401	+ protected final function disableRevisionsTemporarily() {
	402	+ add_filter(
	403	+ 'wp_revisions_to_keep', function( $num, $post ) {
	404	+ if ( $post->post_type === Visualizer_Plugin::CPT_VISUALIZER ) {
	405	+ return 0;
	406	+ }
	407	+ return $num;
	408	+ }, 10, 2
	409	+ );
	410	+ }
	411	+
	412	+ /**
331	413	* Undo revisions for the chart, and if necessary, restore the earliest version.
332	414	*
333	415	* @return bool If any revisions were found.
334	416	*/
		@@ -333,9 +415,11 @@
333	415	* @return bool If any revisions were found.
334	416	*/
335	417	public final function undoRevisions( $chart_id, $restore = false ) {
336	418	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'undoRevisions for %d with%s restore', $chart_id, ( $restore ? '' : 'out' ) ), 'debug', __FILE__, __LINE__ );
337		-
	419	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	420	+ return false;
	421	+ }
338	422	$revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) );
339	423	if ( count( $revisions ) > 1 ) {
340	424	$revision_ids = array_keys( $revisions );
341	425
		@@ -341,9 +425,9 @@
341	425
342	426	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'found %d revisions = %s', count( $revisions ), print_r( $revision_ids, true ) ), 'debug', __FILE__, __LINE__ );
343	427
344	428	// 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' );
	429	+ $this->disableRevisionsTemporarily();
346	430
347	431	if ( $restore ) {
348	432	// restore to the oldest one i.e. the first one.
349	433	wp_restore_post_revision( array_shift( $revision_ids ) );
		@@ -362,10 +446,13 @@
362	446	/**
363	447	* If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing.
364	448	*/
365	449	public final function handleExistingRevisions( $chart_id, $chart ) {
	450	+
366	451	do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'handleExistingRevisions for %d', $chart_id ), 'debug', __FILE__, __LINE__ );
367		-
	452	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	453	+ return $chart_id;
	454	+ }
368	455	// undo revisions.
369	456	$revisions_found = $this->undoRevisions( $chart_id, true );
370	457
371	458	// create revision for the edit action.
		@@ -394,5 +481,269 @@
394	481	}
395	482	return reset( $array );
396	483	}
397	484
	485	+ /**
	486	+ * Gets/creates the JS where user-specific customizations can be/have been added.
	487	+ */
	488	+ protected function get_user_customization_js() {
	489	+ // use this as the JS file in case we are not able to create the file in uploads.
	490	+ $default = VISUALIZER_ABSURL . 'js/customization.js';
	491	+
	492	+ $uploads = wp_get_upload_dir();
	493	+ $specific = $uploads['baseurl'] . '/visualizer/customization.js';
	494	+
	495	+ // for testing on user sites (before we send them the correctly customized file).
	496	+ if ( VISUALIZER_TEST_JS_CUSTOMIZATION ) {
	497	+ return $default;
	498	+ }
	499	+
	500	+ require_once( ABSPATH . 'wp-admin/includes/file.php' );
	501	+ WP_Filesystem();
	502	+ global $wp_filesystem;
	503	+
	504	+ $multisite_arg = '/';
	505	+ if ( is_multisite() && ! is_main_site() ) {
	506	+ $multisite_arg = '/sites/' . get_current_blog_id() . '/';
	507	+ }
	508	+
	509	+ $dir = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer';
	510	+ $file = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer/customization.js';
	511	+
	512	+ if ( $wp_filesystem->is_readable( $file ) ) {
	513	+ return $specific;
	514	+ }
	515	+
	516	+ if ( $wp_filesystem->exists( $file ) && ! $wp_filesystem->is_readable( $file ) ) {
	517	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to read file %s', $file ), 'error', __FILE__, __LINE__ );
	518	+ return $default;
	519	+ }
	520	+
	521	+ if ( ! $wp_filesystem->exists( $dir ) ) {
	522	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	523	+ if ( ( $done = $wp_filesystem->mkdir( $dir ) ) === false ) {
	524	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to create directory %s', $dir ), 'error', __FILE__, __LINE__ );
	525	+ return $default;
	526	+ }
	527	+ }
	528	+
	529	+ // if file does not exist, copy.
	530	+ if ( ! $wp_filesystem->exists( $file ) ) {
	531	+ $src = str_replace( ABSPATH, $wp_filesystem->abspath(), VISUALIZER_ABSPATH . '/js/customization.js' );
	532	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	533	+ if ( ( $done = $wp_filesystem->copy( $src, $file ) ) === false ) {
	534	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to copy file %s to %s', $src, $file ), 'error', __FILE__, __LINE__ );
	535	+ return $default;
	536	+ }
	537	+ }
	538	+
	539	+ return $specific;
	540	+ }
	541	+
	542	+ /**
	543	+ * Load the class for the given chart's chart type so that its assets can be loaded.
	544	+ */
	545	+ protected function load_chart_type( $chart_id ) {
	546	+ $name = $this->load_chart_class_name( $chart_id );
	547	+ $class = null;
	548	+ if ( class_exists( $name ) || true === apply_filters( 'visualizer_load_chart', false, $name ) ) {
	549	+ if ( 'Visualizer_Render_Sidebar_Type_DataTable_DataTable' === $name ) {
	550	+ $name = 'Visualizer_Render_Sidebar_Type_DataTable_Tabular';
	551	+ }
	552	+ $class = new $name;
	553	+ }
	554	+
	555	+ if ( is_null( $class ) && Visualizer_Module::is_pro() ) {
	556	+ // lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-).
	557	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	558	+ $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 ) ) );
	559	+ }
	560	+
	561	+ return is_null( $class ) ? null : $class->getLibrary();
	562	+ }
	563	+
	564	+ /**
	565	+ * Returns the class name for the given chart's chart type.
	566	+ */
	567	+ protected function load_chart_class_name( $chart_id ) {
	568	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	569	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	570	+
	571	+ // backward compatibility.
	572	+ if ( empty( $lib ) ) {
	573	+ $lib = 'GoogleCharts';
	574	+ if ( 'dataTable' === $type ) {
	575	+ $lib = 'DataTable';
	576	+ }
	577	+ }
	578	+ $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type );
	579	+ return $name;
	580	+ }
	581	+
	582	+ /**
	583	+ * Generates the inline CSS to apply to the chart and adds these classes to the settings.
	584	+ *
	585	+ * @access public
	586	+ * @param int $id The id of the chart.
	587	+ * @param array $settings The settings of the chart.
	588	+ */
	589	+ protected function get_inline_custom_css( $id, $settings ) {
	590	+ $css = '';
	591	+
	592	+ $arguments = array( '', $settings );
	593	+ if ( ! isset( $settings['customcss'] ) ) {
	594	+ return $arguments;
	595	+ }
	596	+
	597	+ $classes = array();
	598	+ $css = '<style type="text/css" name="visualizer-custom-css" id="customcss-' . $id . '">';
	599	+ foreach ( $settings['customcss'] as $name => $element ) {
	600	+ $attributes = array();
	601	+ foreach ( $element as $property => $value ) {
	602	+ $attributes[] = $this->handle_css_property( $property, $value );
	603	+ }
	604	+ $class_name = $id . $name;
	605	+ $properties = implode( ' !important; ', array_filter( $attributes ) );
	606	+ if ( ! empty( $properties ) ) {
	607	+ $css .= '.' . $class_name . ' {' . $properties . ' !important;}';
	608	+ $classes[ $name ] = $class_name;
	609	+ }
	610	+ }
	611	+ $css .= '</style>';
	612	+
	613	+ $settings['cssClassNames'] = $classes;
	614	+
	615	+ $arguments = array( $css, $settings );
	616	+ apply_filters_ref_array( 'visualizer_inline_css', array( &$arguments ) );
	617	+
	618	+ return $arguments;
	619	+ }
	620	+
	621	+ /**
	622	+ * Handles CSS properties that might need special syntax.
	623	+ *
	624	+ * @access private
	625	+ * @param string $property The name of the css property.
	626	+ * @param string $value The value of the css property.
	627	+ */
	628	+ private function handle_css_property( $property, $value ) {
	629	+ if ( empty( $property ) || empty( $value ) ) {
	630	+ return '';
	631	+ }
	632	+
	633	+ switch ( $property ) {
	634	+ case 'transform':
	635	+ $value = 'rotate(' . $value . 'deg)';
	636	+ break;
	637	+ }
	638	+ return $property . ': ' . $value;
	639	+ }
	640	+
	641	+ /**
	642	+ * Determines if charts have been created of the particular chart type.
	643	+ */
	644	+ protected static function hasChartType( $type ) {
	645	+ $args = array(
	646	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	647	+ 'fields' => 'ids',
	648	+ 'post_status' => 'publish',
	649	+ 'meta_query' => array(
	650	+ array(
	651	+ 'key' => Visualizer_Plugin::CF_CHART_TYPE,
	652	+ 'value' => $type,
	653	+ ),
	654	+ ),
	655	+ );
	656	+
	657	+ $q = new WP_Query( $args );
	658	+ return $q->found_posts > 0;
	659	+ }
	660	+
	661	+ /**
	662	+ * Determines how many charts have been created.
	663	+ */
	664	+ protected static function numberOfCharts() {
	665	+ $args = array(
	666	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	667	+ 'fields' => 'ids',
	668	+ 'post_status' => 'publish',
	669	+ 'posts_per_page' => 300,
	670	+ );
	671	+
	672	+ $q = new WP_Query( $args );
	673	+ return $q->found_posts;
	674	+ }
	675	+
	676	+ /**
	677	+ * Checks if the PRO version is active.
	678	+ *
	679	+ * @since 3.3.0
	680	+ */
	681	+ public static function is_pro() {
	682	+ // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO
	683	+ // versions of pro 1.9.0 onwards will use the filter
	684	+ return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO );
	685	+ }
	686	+
	687	+ /**
	688	+ * Checks if the PRO version is older than a particular version.
	689	+ *
	690	+ * @since 3.3.0
	691	+ */
	692	+ public static function is_pro_older_than( $version ) {
	693	+ return version_compare( VISUALIZER_PRO_VERSION, $version, '<' );
	694	+ }
	695	+
	696	+ /**
	697	+ * Should we show some specific feature on the basis of the version?
	698	+ *
	699	+ * @since 3.4.0
	700	+ */
	701	+ public static function can_show_feature( $feature ) {
	702	+ switch ( $feature ) {
	703	+ case 'simple-editor':
	704	+ // if user has pro but an older version, then don't load the simple editor functionality
	705	+ // as the select box will not behave as expected because the pro editor's functionality will supercede.
	706	+ return ! Visualizer_Module::is_pro() || ! Visualizer_Module::is_pro_older_than( '1.9.2' );
	707	+ }
	708	+ return false;
	709	+ }
	710	+
	711	+ /**
	712	+ * Gets the features for the provided license type.
	713	+ */
	714	+ public static final function get_features_for_license( $plan ) {
	715	+ switch ( $plan ) {
	716	+ case 1:
	717	+ return array( 'import-wp', 'db-query' );
	718	+ case 2:
	719	+ return array( 'schedule-chart', 'chart-permissions' );
	720	+ }
	721	+ }
	722	+
	723	+ /**
	724	+ * Gets the chart content after common manipulations.
	725	+ */
	726	+ public static function get_chart_data( $chart, $type, $run_filter = true ) {
	727	+ // change HTML entities
	728	+ $data = unserialize( html_entity_decode( $chart->post_content ) );
	729	+ $altered = array();
	730	+ foreach ( $data as $index => $array ) {
	731	+ if ( ! is_array( $index ) && is_array( $array ) ) {
	732	+ foreach ( $array as &$datum ) {
	733	+ if ( is_string( $datum ) ) {
	734	+ $datum = stripslashes( $datum );
	735	+ }
	736	+ }
	737	+ $altered[ $index ] = $array;
	738	+ }
	739	+ }
	740	+ // if something goes wrong and the end result is empty, be safe and use the original data
	741	+ if ( empty( $altered ) ) {
	742	+ $altered = $data;
	743	+ }
	744	+ if ( $run_filter ) {
	745	+ return apply_filters( Visualizer_Plugin::FILTER_GET_CHART_DATA, $altered, $chart->ID, $type );
	746	+ }
	747	+ return $altered;
	748	+ }
398	749	}