← All changes | classes/Visualizer/Module.php +326 -9 3.0.6 → 3.3.2 View file →

		@@ -62,8 +62,13 @@
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	+
66	71	}
67	72
68	73	/**
69	74	* Registers an action hook.
		@@ -143,8 +148,17 @@
143	148	return $this;
144	149	}
145	150
146	151	/**
	152	+ * A wrapper around the actual function _getDataAs. This function is invoked as a filter.
	153	+ *
	154	+ * @since 3.2.0
	155	+ */
	156	+ public function getDataAs( $final, $chart_id, $type ) {
	157	+ return $this->_getDataAs( $chart_id, $type );
	158	+ }
	159	+
	160	+ /**
147	161	* Extracts the data for a chart and prepares it for the given type.
148	162	*
149	163	* @access public
150	164	* @param int $chart_id The chart id.
		@@ -154,9 +168,9 @@
154	168	$final = null;
155	169	$success = false;
156	170	if ( $chart_id ) {
157	171	$chart = get_post( $chart_id );
158		- $success = $chart && $chart->post_type == Visualizer_Plugin::CPT_VISUALIZER;
	172	+ $success = $chart && $chart->post_type === Visualizer_Plugin::CPT_VISUALIZER;
159	173	}
160	174	if ( $success ) {
161	175	$settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
162	176	$rows = array();
		@@ -191,10 +205,22 @@
191	205	}
192	206	}
193	207	}
194	208
195		- $filename = isset( $settings['title'] ) && ! empty( $settings['title'] ) ? $settings['title'] : 'visualizer#' . $chart_id;
	209	+ $title = 'visualizer#' . $chart_id;
	210	+ if ( ! empty( $settings['title'] ) ) {
	211	+ $title = $settings['title'];
	212	+ }
	213	+ // for ChartJS, title is an array.
	214	+ if ( is_array( $title ) && isset( $title['text'] ) ) {
	215	+ $title = $title['text'];
	216	+ }
	217	+ if ( empty( $title ) ) {
	218	+ $title = 'visualizer#' . $chart_id;
	219	+ }
196	220
	221	+ $filename = $title;
	222	+
197	223	switch ( $type ) {
198	224	case 'csv':
199	225	$final = $this->_getCSV( $rows, $filename );
200	226	break;
		@@ -218,16 +244,18 @@
218	244	*/
219	245	private function _getCSV( $rows, $filename ) {
220	246	$filename .= '.csv';
221	247
	248	+ $bom = chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF );
222	249	$fp = tmpfile();
223	250	// support for MS Excel
224		- fprintf( $fp, $bom = ( chr( 0xEF ) . chr( 0xBB ) . chr( 0xBF ) ) );
	251	+ fprintf( $fp, $bom );
225	252	foreach ( $rows as $row ) {
226	253	fputcsv( $fp, $row );
227	254	}
228	255	rewind( $fp );
229	256	$csv = '';
	257	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
230	258	while ( ( $array = fgetcsv( $fp ) ) !== false ) {
231	259	if ( strlen( $csv ) > 0 ) {
232	260	$csv .= PHP_EOL;
233	261	}
		@@ -237,8 +265,9 @@
237	265
238	266	return array(
239	267	'csv' => $csv,
240	268	'name' => $filename,
	269	+ 'string' => str_replace( $bom, '', $csv ),
241	270	);
242	271	}
243	272
244	273	/**
		@@ -248,30 +277,36 @@
248	277	* @param array $rows The array of data.
249	278	* @param string $filename The name of the file to use.
250	279	*/
251	280	private function _getExcel( $rows, $filename ) {
252		- // PHPExcel does not like sheet names longer than 31 characters.
	281	+ // PHPExcel did not like sheet names longer than 31 characters and we will assume the same with PhpSpreadsheet
253	282	$chart = substr( $filename, 0, 30 );
254	283	$filename .= '.xlsx';
255	284
	285	+ $vendor_file = VISUALIZER_ABSPATH . '/vendor/autoload.php';
	286	+ if ( is_readable( $vendor_file ) ) {
	287	+ include_once( $vendor_file );
	288	+ }
	289	+
256	290	$xlsData = '';
257		- if ( class_exists( 'PHPExcel' ) ) {
258		- $doc = new PHPExcel();
	291	+ if ( class_exists( 'PhpOffice\PhpSpreadsheet\Spreadsheet' ) ) {
	292	+ $doc = new PhpOffice\PhpSpreadsheet\Spreadsheet();
259	293	$doc->getActiveSheet()->fromArray( $rows, null, 'A1' );
260	294	$doc->getActiveSheet()->setTitle( sanitize_title( $chart ) );
261	295	$doc = apply_filters( 'visualizer_excel_doc', $doc );
262		- $writer = PHPExcel_IOFactory::createWriter( $doc, 'Excel2007' );
	296	+ $writer = PhpOffice\PhpSpreadsheet\IOFactory::createWriter( $doc, 'Xlsx' );
263	297	ob_start();
264	298	$writer->save( 'php://output' );
265	299	$xlsData = ob_get_contents();
266	300	ob_end_clean();
267	301	} 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!' );
	302	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!', 'error', __FILE__, __LINE__ );
	303	+ error_log( 'Class PhpOffice\PhpSpreadsheet\Spreadsheet does not exist!' );
270	304	}
271	305	return array(
272	306	'csv' => 'data:application/vnd.ms-excel;base64,' . base64_encode( $xlsData ),
273	307	'name' => $filename,
	308	+ 'raw' => base64_encode( $xlsData ),
274	309	);
275	310	}
276	311
277	312	/**
		@@ -301,8 +336,14 @@
301	336
302	337	$table = '<table class="visualizer-print">';
303	338	$index = 0;
304	339	foreach ( $rows as $row ) {
	340	+ // skip the data type row.
	341	+ if ( 1 === $index ) {
	342	+ $index++;
	343	+ continue;
	344	+ }
	345	+
305	346	$table .= '<tr>';
306	347	foreach ( $row as $col ) {
307	348	if ( $index === 0 ) {
308	349	$table .= '<th>' . $col . '</th>';
		@@ -320,7 +361,283 @@
320	361	</html>';
321	362	return array(
322	363	'csv' => $html,
323	364	);
	365	+ }
	366	+
	367	+ /**
	368	+ * Undo revisions for the chart, and if necessary, restore the earliest version.
	369	+ *
	370	+ * @return bool If any revisions were found.
	371	+ */
	372	+ public final function undoRevisions( $chart_id, $restore = false ) {
	373	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'undoRevisions for %d with%s restore', $chart_id, ( $restore ? '' : 'out' ) ), 'debug', __FILE__, __LINE__ );
	374	+
	375	+ $revisions = wp_get_post_revisions( $chart_id, array( 'order' => 'ASC' ) );
	376	+ if ( count( $revisions ) > 1 ) {
	377	+ $revision_ids = array_keys( $revisions );
	378	+
	379	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'found %d revisions = %s', count( $revisions ), print_r( $revision_ids, true ) ), 'debug', __FILE__, __LINE__ );
	380	+
	381	+ // when we restore, a new revision is likely to be created. so, let's disable revisions for the time being.
	382	+ add_filter( 'wp_revisions_to_keep', '__return_false' );
	383	+
	384	+ if ( $restore ) {
	385	+ // restore to the oldest one i.e. the first one.
	386	+ wp_restore_post_revision( array_shift( $revision_ids ) );
	387	+ }
	388	+
	389	+ // delete all revisions.
	390	+ foreach ( $revision_ids as $id ) {
	391	+ wp_delete_post_revision( $id );
	392	+ }
	393	+
	394	+ return true;
	395	+ }
	396	+ return false;
	397	+ }
	398	+
	399	+ /**
	400	+ * If existing revisions exist for the chart, restore the earliest version and then create a new revision to initiate editing.
	401	+ */
	402	+ public final function handleExistingRevisions( $chart_id, $chart ) {
	403	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'handleExistingRevisions for %d', $chart_id ), 'debug', __FILE__, __LINE__ );
	404	+
	405	+ // undo revisions.
	406	+ $revisions_found = $this->undoRevisions( $chart_id, true );
	407	+
	408	+ // create revision for the edit action.
	409	+ wp_save_post_revision( $chart_id );
	410	+
	411	+ if ( $revisions_found ) {
	412	+ // fetch chart data again in case it was updated by an earlier revision.
	413	+ $chart = get_post( $chart_id );
	414	+ }
	415	+ return $chart;
	416	+ }
	417	+
	418	+ /**
	419	+ * Returns the language of the locale.
	420	+ *
	421	+ * @access protected
	422	+ */
	423	+ protected function get_language() {
	424	+ $locale = get_locale();
	425	+ if ( empty( $locale ) ) {
	426	+ return '';
	427	+ }
	428	+ $array = explode( '_', $locale );
	429	+ if ( count( $array ) < 2 ) {
	430	+ return '';
	431	+ }
	432	+ return reset( $array );
	433	+ }
	434	+
	435	+ /**
	436	+ * Gets/creates the JS where user-specific customizations can be/have been added.
	437	+ */
	438	+ protected function get_user_customization_js() {
	439	+ // use this as the JS file in case we are not able to create the file in uploads.
	440	+ $default = VISUALIZER_ABSURL . 'js/customization.js';
	441	+
	442	+ $uploads = wp_get_upload_dir();
	443	+ $specific = $uploads['baseurl'] . '/visualizer/customization.js';
	444	+
	445	+ // for testing on user sites (before we send them the correctly customized file).
	446	+ if ( VISUALIZER_TEST_JS_CUSTOMIZATION ) {
	447	+ return $default;
	448	+ }
	449	+
	450	+ require_once( ABSPATH . 'wp-admin/includes/file.php' );
	451	+ WP_Filesystem();
	452	+ global $wp_filesystem;
	453	+
	454	+ $multisite_arg = '/';
	455	+ if ( is_multisite() && ! is_main_site() ) {
	456	+ $multisite_arg = '/sites/' . get_current_blog_id() . '/';
	457	+ }
	458	+
	459	+ $dir = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer';
	460	+ $file = $wp_filesystem->wp_content_dir() . 'uploads' . $multisite_arg . 'visualizer/customization.js';
	461	+
	462	+ if ( $wp_filesystem->is_readable( $file ) ) {
	463	+ return $specific;
	464	+ }
	465	+
	466	+ if ( $wp_filesystem->exists( $file ) && ! $wp_filesystem->is_readable( $file ) ) {
	467	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to read file %s', $file ), 'error', __FILE__, __LINE__ );
	468	+ return $default;
	469	+ }
	470	+
	471	+ if ( ! $wp_filesystem->exists( $dir ) ) {
	472	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	473	+ if ( ( $done = $wp_filesystem->mkdir( $dir ) ) === false ) {
	474	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to create directory %s', $dir ), 'error', __FILE__, __LINE__ );
	475	+ return $default;
	476	+ }
	477	+ }
	478	+
	479	+ // if file does not exist, copy.
	480	+ if ( ! $wp_filesystem->exists( $file ) ) {
	481	+ $src = str_replace( ABSPATH, $wp_filesystem->abspath(), VISUALIZER_ABSPATH . '/js/customization.js' );
	482	+ // phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.Found
	483	+ if ( ( $done = $wp_filesystem->copy( $src, $file ) ) === false ) {
	484	+ do_action( 'themeisle_log_event', Visualizer_Plugin::NAME, sprintf( 'Unable to copy file %s to %s', $src, $file ), 'error', __FILE__, __LINE__ );
	485	+ return $default;
	486	+ }
	487	+ }
	488	+
	489	+ return $specific;
	490	+ }
	491	+
	492	+ /**
	493	+ * Load the class for the given chart's chart type so that its assets can be loaded.
	494	+ */
	495	+ protected function load_chart_type( $chart_id ) {
	496	+ $name = $this->load_chart_class_name( $chart_id );
	497	+ $class = null;
	498	+ if ( class_exists( $name ) || true === apply_filters( 'visualizer_load_chart', false, $name ) ) {
	499	+ $class = new $name;
	500	+ }
	501	+
	502	+ if ( is_null( $class ) && Visualizer_Module::is_pro() ) {
	503	+ // lets see if this type exists in pro. New Lite(3.1.0+) & old Pro(1.8.0-).
	504	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	505	+ $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 ) ) );
	506	+ }
	507	+
	508	+ return is_null( $class ) ? null : $class->getLibrary();
	509	+ }
	510	+
	511	+ /**
	512	+ * Returns the class name for the given chart's chart type.
	513	+ */
	514	+ protected function load_chart_class_name( $chart_id ) {
	515	+ $type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
	516	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	517	+
	518	+ // backward compatibility.
	519	+ if ( empty( $lib ) ) {
	520	+ $lib = 'GoogleCharts';
	521	+ if ( 'dataTable' === $type ) {
	522	+ $lib = 'DataTable';
	523	+ }
	524	+ }
	525	+ $name = 'Visualizer_Render_Sidebar_Type_' . $lib . '_' . ucwords( $type );
	526	+ return $name;
	527	+ }
	528	+
	529	+ /**
	530	+ * Generates the inline CSS to apply to the chart and adds these classes to the settings.
	531	+ *
	532	+ * @access public
	533	+ * @param int $id The id of the chart.
	534	+ * @param array $settings The settings of the chart.
	535	+ */
	536	+ protected function get_inline_custom_css( $id, $settings ) {
	537	+ $css = '';
	538	+
	539	+ $arguments = array( '', $settings );
	540	+ if ( ! isset( $settings['customcss'] ) ) {
	541	+ return $arguments;
	542	+ }
	543	+
	544	+ $classes = array();
	545	+ $css = '<style type="text/css" name="visualizer-custom-css" id="customcss-' . $id . '">';
	546	+ foreach ( $settings['customcss'] as $name => $element ) {
	547	+ $attributes = array();
	548	+ foreach ( $element as $property => $value ) {
	549	+ $attributes[] = $this->handle_css_property( $property, $value );
	550	+ }
	551	+ $class_name = $id . $name;
	552	+ $properties = implode( ' !important; ', array_filter( $attributes ) );
	553	+ if ( ! empty( $properties ) ) {
	554	+ $css .= '.' . $class_name . ' {' . $properties . ' !important;}';
	555	+ $classes[ $name ] = $class_name;
	556	+ }
	557	+ }
	558	+ $css .= '</style>';
	559	+
	560	+ $settings['cssClassNames'] = $classes;
	561	+
	562	+ $arguments = array( $css, $settings );
	563	+ apply_filters_ref_array( 'visualizer_inline_css', array( &$arguments ) );
	564	+
	565	+ return $arguments;
	566	+ }
	567	+
	568	+ /**
	569	+ * Handles CSS properties that might need special syntax.
	570	+ *
	571	+ * @access private
	572	+ * @param string $property The name of the css property.
	573	+ * @param string $value The value of the css property.
	574	+ */
	575	+ private function handle_css_property( $property, $value ) {
	576	+ if ( empty( $property ) || empty( $value ) ) {
	577	+ return '';
	578	+ }
	579	+
	580	+ switch ( $property ) {
	581	+ case 'transform':
	582	+ $value = 'rotate(' . $value . 'deg)';
	583	+ break;
	584	+ }
	585	+ return $property . ': ' . $value;
	586	+ }
	587	+
	588	+ /**
	589	+ * Determines if charts have been created of the particular chart type.
	590	+ */
	591	+ protected static function hasChartType( $type ) {
	592	+ $args = array(
	593	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	594	+ 'fields' => 'ids',
	595	+ 'post_status' => 'publish',
	596	+ 'meta_query' => array(
	597	+ array(
	598	+ 'key' => Visualizer_Plugin::CF_CHART_TYPE,
	599	+ 'value' => $type,
	600	+ ),
	601	+ ),
	602	+ );
	603	+
	604	+ $q = new WP_Query( $args );
	605	+ return $q->found_posts > 0;
	606	+ }
	607	+
	608	+ /**
	609	+ * Determines how many charts have been created.
	610	+ */
	611	+ protected static function numberOfCharts() {
	612	+ $args = array(
	613	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	614	+ 'fields' => 'ids',
	615	+ 'post_status' => 'publish',
	616	+ 'posts_per_page' => 300,
	617	+ );
	618	+
	619	+ $q = new WP_Query( $args );
	620	+ return $q->found_posts;
	621	+ }
	622	+
	623	+ /**
	624	+ * Checks if the PRO version is active.
	625	+ *
	626	+ * @since 3.3.0
	627	+ */
	628	+ public static function is_pro() {
	629	+ // versions of pro before 1.9.0 will use the constant VISUALIZER_PRO
	630	+ // versions of pro 1.9.0 onwards will use the filter
	631	+ return apply_filters( 'visualizer_is_pro', VISUALIZER_PRO );
	632	+ }
	633	+
	634	+ /**
	635	+ * Checks if the PRO version is older than a particular version.
	636	+ *
	637	+ * @since 3.3.0
	638	+ */
	639	+ public static function is_pro_older_than( $version ) {
	640	+ return version_compare( VISUALIZER_PRO_VERSION, $version, '<' );
324	641	}
325	642
326	643	}