← All changes | classes/Visualizer/Module.php +314 -11 3.0.8 → 3.4.2 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['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,9 +183,9 @@
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();
		@@ -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>';
		@@ -392,7 +460,242 @@
392	460	if ( count( $array ) < 2 ) {
393	461	return '';
394	462	}
395	463	return reset( $array );
	464	+ }
	465	+
	466	+ /**
	467	+ * Gets/creates the JS where user-specific customizations can be/have been added.
	468	+ */
	469	+ protected function get_user_customization_js() {
	470	+ // use this as the JS file in case we are not able to create the file in uploads.
	471	+ $default = VISUALIZER_ABSURL . 'js/customization.js';
	472	+
	473	+ $uploads = wp_get_upload_dir();
	474	+ $specific = $uploads['baseurl'] . '/visualizer/customization.js';
	475	+
	476	+ // for testing on user sites (before we send them the correctly customized file).
	477	+ if ( VISUALIZER_TEST_JS_CUSTOMIZATION ) {
	478	+ return $default;
	479	+ }
	480	+
	481	+ require_once( ABSPATH . 'wp-admin/includes/file.php' );
	482	+ WP_Filesystem();
	483	+ global $wp_filesystem;
	484	+
	485	+ $multisite_arg = '/';
	486	+ if ( is_multisite() && ! is_main_site() ) {
	487	+ $multisite_arg = '/sites/' . get_current_blog_id() . '/';
	488	+ }
	489	+
	490	+ $dir = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer';
	491	+ $file = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer/customization.js';
	492	+
	493	+ if ( $wp_filesystem->is_readable( $file ) ) {
	494	+ return $specific;
	495	+ }
	496	+
	497	+ if ( $wp_filesystem->exists( $file ) && ! $wp_filesystem->is_readable( $file ) ) {
	498	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to read file %s', $file ), 'error', __FILE__, __LINE__ );
	499	+ return $default;
	500	+ }
	501	+
	502	+ if ( ! $wp_filesystem->exists( $dir ) ) {
	503	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	504	+ if ( ( $done = $wp_filesystem->mkdir( $dir ) ) === false ) {
	505	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to create directory %s', $dir ), 'error', __FILE__, __LINE__ );
	506	+ return $default;
	507	+ }
	508	+ }
	509	+
	510	+ // if file does not exist, copy.
	511	+ if ( ! $wp_filesystem->exists( $file ) ) {
	512	+ $src = str_replace( ABSPATH, $wp_filesystem->abspath(), VISUALIZER_ABSPATH . '/js/customization.js' );
	513	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	514	+ if ( ( $done = $wp_filesystem->copy( $src, $file ) ) === false ) {
	515	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to copy file %s to %s', $src, $file ), 'error', __FILE__, __LINE__ );
	516	+ return $default;
	517	+ }
	518	+ }
	519	+
	520	+ return $specific;
	521	+ }
	522	+
	523	+ /**
	524	+ * Load the class for the given chart's chart type so that its assets can be loaded.
	525	+ */
	526	+ protected function load_chart_type( $chart_id ) {
	527	+ $name = $this->load_chart_class_name( $chart_id );
	528	+ $class = null;
	529	+ if ( class_exists( $name ) || true === apply_filters( 'visualizer_load_chart', false, $name ) ) {
	530	+ $class = new $name;
	531	+ }
	532	+
	533	+ if ( is_null( $class ) && Visualizer_Module::is_pro() ) {
	534	+ // lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-).
	535	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	536	+ $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 ) ) );
	537	+ }
	538	+
	539	+ return is_null( $class ) ? null : $class->getLibrary();
	540	+ }
	541	+
	542	+ /**
	543	+ * Returns the class name for the given chart's chart type.
	544	+ */
	545	+ protected function load_chart_class_name( $chart_id ) {
	546	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	547	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	548	+
	549	+ // backward compatibility.
	550	+ if ( empty( $lib ) ) {
	551	+ $lib = 'GoogleCharts';
	552	+ if ( 'dataTable' === $type ) {
	553	+ $lib = 'DataTable';
	554	+ }
	555	+ }
	556	+ $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type );
	557	+ return $name;
	558	+ }
	559	+
	560	+ /**
	561	+ * Generates the inline CSS to apply to the chart and adds these classes to the settings.
	562	+ *
	563	+ * @access public
	564	+ * @param int $id The id of the chart.
	565	+ * @param array $settings The settings of the chart.
	566	+ */
	567	+ protected function get_inline_custom_css( $id, $settings ) {
	568	+ $css = '';
	569	+
	570	+ $arguments = array( '', $settings );
	571	+ if ( ! isset( $settings['customcss'] ) ) {
	572	+ return $arguments;
	573	+ }
	574	+
	575	+ $classes = array();
	576	+ $css = '<style type="text/css" name="visualizer-custom-css" id="customcss-' . $id . '">';
	577	+ foreach ( $settings['customcss'] as $name => $element ) {
	578	+ $attributes = array();
	579	+ foreach ( $element as $property => $value ) {
	580	+ $attributes[] = $this->handle_css_property( $property, $value );
	581	+ }
	582	+ $class_name = $id . $name;
	583	+ $properties = implode( ' !important; ', array_filter( $attributes ) );
	584	+ if ( ! empty( $properties ) ) {
	585	+ $css .= '.' . $class_name . ' {' . $properties . ' !important;}';
	586	+ $classes[ $name ] = $class_name;
	587	+ }
	588	+ }
	589	+ $css .= '</style>';
	590	+
	591	+ $settings['cssClassNames'] = $classes;
	592	+
	593	+ $arguments = array( $css, $settings );
	594	+ apply_filters_ref_array( 'visualizer_inline_css', array( &$arguments ) );
	595	+
	596	+ return $arguments;
	597	+ }
	598	+
	599	+ /**
	600	+ * Handles CSS properties that might need special syntax.
	601	+ *
	602	+ * @access private
	603	+ * @param string $property The name of the css property.
	604	+ * @param string $value The value of the css property.
	605	+ */
	606	+ private function handle_css_property( $property, $value ) {
	607	+ if ( empty( $property ) || empty( $value ) ) {
	608	+ return '';
	609	+ }
	610	+
	611	+ switch ( $property ) {
	612	+ case 'transform':
	613	+ $value = 'rotate(' . $value . 'deg)';
	614	+ break;
	615	+ }
	616	+ return $property . ': ' . $value;
	617	+ }
	618	+
	619	+ /**
	620	+ * Determines if charts have been created of the particular chart type.
	621	+ */
	622	+ protected static function hasChartType( $type ) {
	623	+ $args = array(
	624	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	625	+ 'fields' => 'ids',
	626	+ 'post_status' => 'publish',
	627	+ 'meta_query' => array(
	628	+ array(
	629	+ 'key' => Visualizer_Plugin::CF_CHART_TYPE,
	630	+ 'value' => $type,
	631	+ ),
	632	+ ),
	633	+ );
	634	+
	635	+ $q = new WP_Query( $args );
	636	+ return $q->found_posts > 0;
	637	+ }
	638	+
	639	+ /**
	640	+ * Determines how many charts have been created.
	641	+ */
	642	+ protected static function numberOfCharts() {
	643	+ $args = array(
	644	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	645	+ 'fields' => 'ids',
	646	+ 'post_status' => 'publish',
	647	+ 'posts_per_page' => 300,
	648	+ );
	649	+
	650	+ $q = new WP_Query( $args );
	651	+ return $q->found_posts;
	652	+ }
	653	+
	654	+ /**
	655	+ * Checks if the PRO version is active.
	656	+ *
	657	+ * @since 3.3.0
	658	+ */
	659	+ public static function is_pro() {
	660	+ // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO
	661	+ // versions of pro 1.9.0 onwards will use the filter
	662	+ return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO );
	663	+ }
	664	+
	665	+ /**
	666	+ * Checks if the PRO version is older than a particular version.
	667	+ *
	668	+ * @since 3.3.0
	669	+ */
	670	+ public static function is_pro_older_than( $version ) {
	671	+ return version_compare( VISUALIZER_PRO_VERSION, $version, '<' );
	672	+ }
	673	+
	674	+ /**
	675	+ * Should we show some specific feature on the basis of the version?
	676	+ *
	677	+ * @since 3.4.0
	678	+ */
	679	+ public static function can_show_feature( $feature ) {
	680	+ switch ( $feature ) {
	681	+ case 'simple-editor':
	682	+ // if user has pro but an older version, then don't load the simple editor functionality
	683	+ // as the select box will not behave as expected because the pro editor's functionality will supercede.
	684	+ return ! Visualizer_Module::is_pro() || ! Visualizer_Module::is_pro_older_than( '1.9.2' );
	685	+ }
	686	+ return false;
	687	+ }
	688	+
	689	+ /**
	690	+ * Gets the features for the provided license type.
	691	+ */
	692	+ public static final function get_features_for_license( $plan ) {
	693	+ switch ( $plan ) {
	694	+ case 1:
	695	+ return array( 'import-wp', 'db-query' );
	696	+ case 2:
	697	+ return array( 'schedule-chart', 'chart-permissions' );
	698	+ }
396	699	}
397	700
398	701	}