← All changes | classes/Visualizer/Module.php +432 -12 3.0.6 → 3.4.4 View file →

		@@ -62,11 +62,31 @@
62	62	global $wpdb;
63	63
64	64	$this->_wpdb = $wpdb;
65	65	$this->_plugin = $plugin;
	66	+
	67	+ $this->_addFilter( Visualizer_Plugin::FILTER_UNDO_REVISIONS, 'undoRevisions', 10, 2 );
	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') );
	71	+
66	72	}
67	73
68	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['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	+ /**
69	89	* Registers an action hook.
70	90	*
71	91	* @since 1.0.0
72	92	* @uses add_action() To register action hook.
		@@ -143,8 +163,17 @@
143	163	return $this;
144	164	}
145	165
146	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	+ /**
147	176	* Extracts the data for a chart and prepares it for the given type.
148	177	*
149	178	* @access public
150	179	* @param int $chart_id The chart id.
		@@ -154,15 +183,15 @@
154	183	$final = null;
155	184	$success = false;
156	185	if ( $chart_id ) {
157	186	$chart = get_post( $chart_id );
158		- $success = $chart && $chart->post_type == Visualizer_Plugin::CPT_VISUALIZER;
	187	+ $success = $chart && $chart->post_type === Visualizer_Plugin::CPT_VISUALIZER;
159	188	}
160	189	if ( $success ) {
161	190	$settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
162	191	$rows = array();
163	192	$series = get_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, true );
164		- $data = unserialize( $chart->post_content );
	193	+ $data = self::get_chart_data( $chart, $type, false );
165	194	if ( ! empty( $series ) ) {
166	195	$row = array();
167	196	foreach ( $series as $array ) {
168	197	$row[] = $array['label'];
		@@ -191,14 +220,29 @@
191	220	}
192	221	}
193	222	}
194	223
195		- $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	+ }
196	235
	236	+ $filename = $title;
	237	+
197	238	switch ( $type ) {
198	239	case 'csv':
199		- $final = $this->_getCSV( $rows, $filename );
	240	+ $final = $this->_getCSV( $rows, $filename, false );
200	241	break;
	242	+ case 'csv-display':
	243	+ $final = $this->_getCSV( $rows, $filename, true );
	244	+ break;
201	245	case 'xls':
202	246	$final = $this->_getExcel( $rows, $filename );
203	247	break;
204	248	case 'print':
		@@ -214,24 +258,39 @@
214	258	*
215	259	* @access private
216	260	* @param array $rows The array of data.
217	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.
218	263	*/
219		- private function _getCSV( $rows, $filename ) {
	264	+ private function _getCSV( $rows, $filename, $enclose ) {
220	265	$filename .= '.csv';
221	266
	267	+ $bom = chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF );
222	268	$fp = tmpfile();
223	269	// support for MS Excel
224		- fprintf( $fp, $bom = ( chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ) ) );
	270	+ fprintf( $fp, $bom );
225	271	foreach ( $rows as $row ) {
226	272	fputcsv( $fp, $row );
227	273	}
228	274	rewind( $fp );
229	275	$csv = '';
	276	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
230	277	while ( ( $array = fgetcsv( $fp ) ) !== false ) {
231	278	if ( strlen( $csv ) > 0 ) {
232	279	$csv .= PHP_EOL;
233	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	+ }
234	293	$csv .= implode( ',', $array );
235	294	}
236	295	fclose( $fp );
237	296
		@@ -237,8 +296,9 @@
237	296
238	297	return array(
239	298	'csv' => $csv,
240	299	'name' => $filename,
	300	+ 'string' => str_replace( $bom, '', $csv ),
241	301	);
242	302	}
243	303
244	304	/**
		@@ -248,30 +308,36 @@
248	308	* @param array $rows The array of data.
249	309	* @param string $filename The name of the file to use.
250	310	*/
251	311	private function _getExcel( $rows, $filename ) {
252		- // 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
253	313	$chart = substr( $filename, 0, 30 );
254	314	$filename .= '.xlsx';
255	315
	316	+ $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php';
	317	+ if ( is_readable( $vendor_file ) ) {
	318	+ include_once( $vendor_file );
	319	+ }
	320	+
256	321	$xlsData = '';
257		- if ( class_exists( 'PHPExcel' ) ) {
258		- $doc = new PHPExcel();
	322	+ if ( class_exists( 'PhpOffice\PhpSpreadsheet\Spreadsheet' ) ) {
	323	+ $doc = new PhpOffice\PhpSpreadsheet\Spreadsheet();
259	324	$doc->getActiveSheet()->fromArray( $rows, null, 'A1' );
260	325	$doc->getActiveSheet()->setTitle( sanitize_title( $chart ) );
261	326	$doc = apply_filters( 'visualizer_excel_doc', $doc );
262		- $writer = PHPExcel_IOFactory::createWriter( $doc, 'Excel2007' );
	327	+ $writer = PhpOffice\PhpSpreadsheet\IOFactory::createWriter( $doc, 'Xlsx' );
263	328	ob_start();
264	329	$writer->save( 'php://output' );
265	330	$xlsData = ob_get_contents();
266	331	ob_end_clean();
267	332	} else {
268		- do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PHPExcel does not exist!', 'error', __FILE__, __LINE__ );
269		- 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!' );
270	335	}
271	336	return array(
272	337	'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ),
273	338	'name' => $filename,
	339	+ 'raw' => base64_encode( $xlsData ),
274	340	);
275	341	}
276	342
277	343	/**
		@@ -301,8 +367,14 @@
301	367
302	368	$table = '<table class="visualizer-print">';
303	369	$index = 0;
304	370	foreach ( $rows as $row ) {
	371	+ // skip the data type row.
	372	+ if ( 1 === $index ) {
	373	+ $index++;
	374	+ continue;
	375	+ }
	376	+
305	377	$table .= '<tr>';
306	378	foreach ( $row as $col ) {
307	379	if ( $index === 0 ) {
308	380	$table .= '<th>' . $col . '</th>';
		@@ -322,5 +394,353 @@
322	394	'csv' => $html,
323	395	);
324	396	}
325	397
	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	+ /**
	413	+ * Undo revisions for the chart, and if necessary, restore the earliest version.
	414	+ *
	415	+ * @return bool If any revisions were found.
	416	+ */
	417	+ public final function undoRevisions( $chart_id, $restore = false ) {
	418	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'undoRevisions for %d with%s restore', $chart_id, ( $restore ? '' : 'out' ) ), 'debug', __FILE__, __LINE__ );
	419	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	420	+ return false;
	421	+ }
	422	+ $revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) );
	423	+ if ( count( $revisions ) > 1 ) {
	424	+ $revision_ids = array_keys( $revisions );
	425	+
	426	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'found %d revisions = %s', count( $revisions ), print_r( $revision_ids, true ) ), 'debug', __FILE__, __LINE__ );
	427	+
	428	+ // when we restore, a new revision is likely to be created. so, let's disable revisions for the time being.
	429	+ $this->disableRevisionsTemporarily();
	430	+
	431	+ if ( $restore ) {
	432	+ // restore to the oldest one i.e. the first one.
	433	+ wp_restore_post_revision( array_shift( $revision_ids ) );
	434	+ }
	435	+
	436	+ // delete all revisions.
	437	+ foreach ( $revision_ids as $id ) {
	438	+ wp_delete_post_revision( $id );
	439	+ }
	440	+
	441	+ return true;
	442	+ }
	443	+ return false;
	444	+ }
	445	+
	446	+ /**
	447	+ * If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing.
	448	+ */
	449	+ public final function handleExistingRevisions( $chart_id, $chart ) {
	450	+
	451	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'handleExistingRevisions for %d', $chart_id ), 'debug', __FILE__, __LINE__ );
	452	+ if ( get_post_type( $chart_id ) !== Visualizer_Plugin::CPT_VISUALIZER ) {
	453	+ return $chart_id;
	454	+ }
	455	+ // undo revisions.
	456	+ $revisions_found = $this->undoRevisions( $chart_id, true );
	457	+
	458	+ // create revision for the edit action.
	459	+ wp_save_post_revision( $chart_id );
	460	+
	461	+ if ( $revisions_found ) {
	462	+ // fetch chart data again in case it was updated by an earlier revision.
	463	+ $chart = get_post( $chart_id );
	464	+ }
	465	+ return $chart;
	466	+ }
	467	+
	468	+ /**
	469	+ * Returns the language of the locale.
	470	+ *
	471	+ * @access protected
	472	+ */
	473	+ protected function get_language() {
	474	+ $locale = get_locale();
	475	+ if ( empty( $locale ) ) {
	476	+ return '';
	477	+ }
	478	+ $array = explode( '_', $locale );
	479	+ if ( count( $array ) < 2 ) {
	480	+ return '';
	481	+ }
	482	+ return reset( $array );
	483	+ }
	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	+ $class = new $name;
	550	+ }
	551	+
	552	+ if ( is_null( $class ) && Visualizer_Module::is_pro() ) {
	553	+ // lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-).
	554	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	555	+ $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 ) ) );
	556	+ }
	557	+
	558	+ return is_null( $class ) ? null : $class->getLibrary();
	559	+ }
	560	+
	561	+ /**
	562	+ * Returns the class name for the given chart's chart type.
	563	+ */
	564	+ protected function load_chart_class_name( $chart_id ) {
	565	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	566	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	567	+
	568	+ // backward compatibility.
	569	+ if ( empty( $lib ) ) {
	570	+ $lib = 'GoogleCharts';
	571	+ if ( 'dataTable' === $type ) {
	572	+ $lib = 'DataTable';
	573	+ }
	574	+ }
	575	+ $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type );
	576	+ return $name;
	577	+ }
	578	+
	579	+ /**
	580	+ * Generates the inline CSS to apply to the chart and adds these classes to the settings.
	581	+ *
	582	+ * @access public
	583	+ * @param int $id The id of the chart.
	584	+ * @param array $settings The settings of the chart.
	585	+ */
	586	+ protected function get_inline_custom_css( $id, $settings ) {
	587	+ $css = '';
	588	+
	589	+ $arguments = array( '', $settings );
	590	+ if ( ! isset( $settings['customcss'] ) ) {
	591	+ return $arguments;
	592	+ }
	593	+
	594	+ $classes = array();
	595	+ $css = '<style type="text/css" name="visualizer-custom-css" id="customcss-' . $id . '">';
	596	+ foreach ( $settings['customcss'] as $name => $element ) {
	597	+ $attributes = array();
	598	+ foreach ( $element as $property => $value ) {
	599	+ $attributes[] = $this->handle_css_property( $property, $value );
	600	+ }
	601	+ $class_name = $id . $name;
	602	+ $properties = implode( ' !important; ', array_filter( $attributes ) );
	603	+ if ( ! empty( $properties ) ) {
	604	+ $css .= '.' . $class_name . ' {' . $properties . ' !important;}';
	605	+ $classes[ $name ] = $class_name;
	606	+ }
	607	+ }
	608	+ $css .= '</style>';
	609	+
	610	+ $settings['cssClassNames'] = $classes;
	611	+
	612	+ $arguments = array( $css, $settings );
	613	+ apply_filters_ref_array( 'visualizer_inline_css', array( &$arguments ) );
	614	+
	615	+ return $arguments;
	616	+ }
	617	+
	618	+ /**
	619	+ * Handles CSS properties that might need special syntax.
	620	+ *
	621	+ * @access private
	622	+ * @param string $property The name of the css property.
	623	+ * @param string $value The value of the css property.
	624	+ */
	625	+ private function handle_css_property( $property, $value ) {
	626	+ if ( empty( $property ) || empty( $value ) ) {
	627	+ return '';
	628	+ }
	629	+
	630	+ switch ( $property ) {
	631	+ case 'transform':
	632	+ $value = 'rotate(' . $value . 'deg)';
	633	+ break;
	634	+ }
	635	+ return $property . ': ' . $value;
	636	+ }
	637	+
	638	+ /**
	639	+ * Determines if charts have been created of the particular chart type.
	640	+ */
	641	+ protected static function hasChartType( $type ) {
	642	+ $args = array(
	643	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	644	+ 'fields' => 'ids',
	645	+ 'post_status' => 'publish',
	646	+ 'meta_query' => array(
	647	+ array(
	648	+ 'key' => Visualizer_Plugin::CF_CHART_TYPE,
	649	+ 'value' => $type,
	650	+ ),
	651	+ ),
	652	+ );
	653	+
	654	+ $q = new WP_Query( $args );
	655	+ return $q->found_posts > 0;
	656	+ }
	657	+
	658	+ /**
	659	+ * Determines how many charts have been created.
	660	+ */
	661	+ protected static function numberOfCharts() {
	662	+ $args = array(
	663	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	664	+ 'fields' => 'ids',
	665	+ 'post_status' => 'publish',
	666	+ 'posts_per_page' => 300,
	667	+ );
	668	+
	669	+ $q = new WP_Query( $args );
	670	+ return $q->found_posts;
	671	+ }
	672	+
	673	+ /**
	674	+ * Checks if the PRO version is active.
	675	+ *
	676	+ * @since 3.3.0
	677	+ */
	678	+ public static function is_pro() {
	679	+ // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO
	680	+ // versions of pro 1.9.0 onwards will use the filter
	681	+ return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO );
	682	+ }
	683	+
	684	+ /**
	685	+ * Checks if the PRO version is older than a particular version.
	686	+ *
	687	+ * @since 3.3.0
	688	+ */
	689	+ public static function is_pro_older_than( $version ) {
	690	+ return version_compare( VISUALIZER_PRO_VERSION, $version, '<' );
	691	+ }
	692	+
	693	+ /**
	694	+ * Should we show some specific feature on the basis of the version?
	695	+ *
	696	+ * @since 3.4.0
	697	+ */
	698	+ public static function can_show_feature( $feature ) {
	699	+ switch ( $feature ) {
	700	+ case 'simple-editor':
	701	+ // if user has pro but an older version, then don't load the simple editor functionality
	702	+ // as the select box will not behave as expected because the pro editor's functionality will supercede.
	703	+ return ! Visualizer_Module::is_pro() || ! Visualizer_Module::is_pro_older_than( '1.9.2' );
	704	+ }
	705	+ return false;
	706	+ }
	707	+
	708	+ /**
	709	+ * Gets the features for the provided license type.
	710	+ */
	711	+ public static final function get_features_for_license( $plan ) {
	712	+ switch ( $plan ) {
	713	+ case 1:
	714	+ return array( 'import-wp', 'db-query' );
	715	+ case 2:
	716	+ return array( 'schedule-chart', 'chart-permissions' );
	717	+ }
	718	+ }
	719	+
	720	+ /**
	721	+ * Gets the chart content after common manipulations.
	722	+ */
	723	+ public static function get_chart_data( $chart, $type, $run_filter = true ) {
	724	+ // change HTML entities
	725	+ $data = unserialize( html_entity_decode( $chart->post_content ) );
	726	+ $altered = array();
	727	+ foreach ( $data as $index => $array ) {
	728	+ if ( ! is_array( $index ) && is_array( $array ) ) {
	729	+ foreach ( $array as &$datum ) {
	730	+ if ( is_string( $datum ) ) {
	731	+ $datum = stripslashes( $datum );
	732	+ }
	733	+ }
	734	+ $altered[ $index ] = $array;
	735	+ }
	736	+ }
	737	+ // if something goes wrong and the end result is empty, be safe and use the original data
	738	+ if ( empty( $altered ) ) {
	739	+ $altered = $data;
	740	+ }
	741	+ if ( $run_filter ) {
	742	+ return apply_filters( Visualizer_Plugin::FILTER_GET_CHART_DATA, $altered, $chart->ID, $type );
	743	+ }
	744	+ return $altered;
	745	+ }
326	746	}