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