← All changes | classes/Visualizer/Module/Setup.php +274 -42 3.1.1 → 3.11.7 View file →

		@@ -44,15 +44,21 @@
44	44
45	45	register_activation_hook( VISUALIZER_BASEFILE, array( $this, 'activate' ) );
46	46	register_deactivation_hook( VISUALIZER_BASEFILE, array( $this, 'deactivate' ) );
47	47	$this->_addAction( 'visualizer_schedule_refresh_db', 'refreshDbChart' );
48		- $this->_addFilter( 'visualizer_schedule_refresh_chart', 'refresh_db_for_chart', null, 10, 3 );
	48	+ $this->_addFilter( 'visualizer_schedule_refresh_chart', 'refresh_db_for_chart', 10, 3 );
49	49
	50	+ $this->_addAction( 'admin_init', 'adminInit' );
50	51	$this->_addAction( 'init', 'setupCustomPostTypes' );
	52	+ $this->_addFilter( 'cron_schedules', 'custom_cron_schedules' );
51	53	$this->_addAction( 'plugins_loaded', 'loadTextDomain' );
52	54	$this->_addFilter( 'visualizer_logger_data', 'getLoggerData' );
53		- $this->_addFilter( 'visualizer_get_chart_counts', 'getChartCountsByTypeAndMeta' );
	55	+ $this->_addFilter( 'visualizer_get_chart_counts', 'getUsage', 10, 2 );
54	56
	57	+ $this->_addAction( 'init', 'checkIsExistingUser' );
	58	+
	59	+ // only for testing
	60	+ // $this->_addAction( 'admin_init', 'getUsage' );
55	61	}
56	62	/**
57	63	* Fetches the SDK logger data.
58	64	*
		@@ -60,36 +66,82 @@
60	66	*
61	67	* @access public
62	68	*/
63	69	public function getLoggerData( $data ) {
64		- return $this->getChartCountsByTypeAndMeta();
	70	+ return $this->getUsage( $data );
65	71	}
66	72
67	73	/**
68		- * Fetches the types of charts created and their counts.
	74	+ * Fetches the usage of charts.
69	75	*
	76	+ * @param array $data The default data that needs to be sent.
70	77	* @param array $meta_keys An array of name vs. meta keys - to return how many charts have these keys.
71		- * @access private
	78	+ *
	79	+ * @access public
72	80	*/
73		- public function getChartCountsByTypeAndMeta( $meta_keys = array() ) {
74		- $charts = array();
75		- $charts['chart_types'] = array();
76		- // the initial query arguments to fetch charts
	81	+ public function getUsage( $data, $meta_keys = array() ) {
	82	+ $charts = array( 'types' => array(), 'sources' => array(), 'library' => array(), 'permissions' => 0, 'manual_config' => 0, 'scheduled' => 0 );
77	83	$query_args = array(
78	84	'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
79	85	'posts_per_page' => 300,
	86	+ 'post_status' => 'publish',
80	87	'fields' => 'ids',
81	88	'no_rows_found' => false,
82	89	'update_post_meta_cache' => false,
83	90	'update_post_term_cache' => false,
	91	+ );
84	92
	93	+ // default permissions.
	94	+ $default_perms = array(
	95	+ 'read' => 'all',
	96	+ 'read-specific' => null,
	97	+ 'edit' => 'roles',
	98	+ 'edit-specific' => array( 'administrator' ),
85	99	);
86	100
	101	+ // collect all schedules chart ids.
	102	+ $scheduled = array_merge(
	103	+ array_keys( get_option( Visualizer_Plugin::CF_CHART_SCHEDULE, array() ) ),
	104	+ array_keys( get_option( Visualizer_Plugin::CF_DB_SCHEDULE, array() ) )
	105	+ );
87	106	$query = new WP_Query( $query_args );
88	107	while ( $query->have_posts() ) {
89	108	$chart_id = $query->next_post();
90	109	$type = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_TYPE, true );
91		- $charts['chart_types'][ $type ] = isset( $charts['chart_types'][ $type ] ) ? $charts['chart_types'][ $type ] + 1 : 1;
	110	+ $charts['types'][ $type ] = isset( $charts['types'][ $type ] ) ? $charts['types'][ $type ] + 1 : 1;
	111	+ $source = get_post_meta( $chart_id, Visualizer_Plugin::CF_SOURCE, true );
	112	+ $charts['sources'][ $source ] = isset( $charts['sources'][ $source ] ) ? $charts['sources'][ $source ] + 1 : 1;
	113	+ $lib = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_LIBRARY, true );
	114	+ $charts['library'][ $lib ] = isset( $charts['library'][ $lib ] ) ? $charts['library'][ $lib ] + 1 : 1;
	115	+ $settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
	116	+ if ( array_key_exists( 'manual', $settings ) && ! empty( $settings['manual'] ) ) {
	117	+ $charts['manual_config'] = $charts['manual_config'] + 1;
	118	+ }
	119	+
	120	+ // phpcs:ignore WordPress.PHP.StrictInArray.FoundNonStrictFalse
	121	+ if ( in_array( $chart_id, $scheduled, false ) ) {
	122	+ $charts['scheduled'] = $charts['scheduled'] + 1;
	123	+ }
	124	+
	125	+ if ( Visualizer_Module::is_pro() ) {
	126	+ $permissions = get_post_meta( $chart_id, Visualizer_PRO::CF_PERMISSIONS, true );
	127	+ if ( empty( $permissions ) ) {
	128	+ continue;
	129	+ }
	130	+ $permissions = $permissions['permissions'];
	131	+ $customized = false;
	132	+ foreach ( $default_perms as $key => $val ) {
	133	+ if ( ! is_array( $val ) && ! is_null( $val ) && isset( $permissions[ $key ] ) && $permissions[ $key ] !== $val ) {
	134	+ $customized = true;
	135	+ } elseif ( is_array( $val ) && ! is_null( $val ) && isset( $permissions[ $key ] ) && count( $permissions[ $key ] ) !== count( $val ) ) {
	136	+ $customized = true;
	137	+ }
	138	+ }
	139	+ if ( $customized ) {
	140	+ $charts['permissions'] = $charts['permissions'] + 1;
	141	+ }
	142	+ }
	143	+
92	144	if ( ! empty( $meta_keys ) ) {
93	145	foreach ( $meta_keys as $name => $key ) {
94	146	$data = get_post_meta( $chart_id, $key, true );
95	147	if ( ! empty( $data ) ) {
		@@ -99,8 +151,9 @@
99	151	}
100	152	}
101	153	}
102	154	}
	155	+
103	156	return $charts;
104	157	}
105	158
106	159	/**
		@@ -139,27 +192,100 @@
139	192
140	193	/**
141	194	* Activate the plugin
142	195	*/
143		- public function activate() {
	196	+ public function activate( $network_wide ) {
	197	+ if ( is_multisite() && $network_wide ) {
	198	+ foreach ( get_sites( array( 'fields' => 'ids' ) ) as $blog_id ) {
	199	+ switch_to_blog( $blog_id );
	200	+ $this->activate_on_site();
	201	+ restore_current_blog();
	202	+ }
	203	+ } else {
	204	+ $this->activate_on_site();
	205	+ }
	206	+ }
	207	+
	208	+ /**
	209	+ * Activates the plugin on a particular blog instance (supports multisite and single site).
	210	+ */
	211	+ private function activate_on_site() {
144	212	wp_clear_scheduled_hook( 'visualizer_schedule_refresh_db' );
145		- wp_schedule_event( strtotime( 'midnight' ) - get_option( 'gmt_offset' ) * HOUR_IN_SECONDS, 'hourly', 'visualizer_schedule_refresh_db' );
	213	+ wp_schedule_event( strtotime( 'midnight' ) - get_option( 'gmt_offset' ) * HOUR_IN_SECONDS, apply_filters( 'visualizer_chart_schedule_interval', 'visualizer_ten_minutes' ), 'visualizer_schedule_refresh_db' );
	214	+ add_option( 'visualizer-activated', true );
	215	+ $is_fresh_install = get_option( 'visualizer_fresh_install', false );
	216	+ if ( ! defined( 'TI_CYPRESS_TESTING' ) && false === $is_fresh_install ) {
	217	+ update_option( 'visualizer_fresh_install', '1' );
	218	+ }
146	219	}
147	220
148	221	/**
149	222	* Deactivate the plugin
150	223	*/
151		- public function deactivate() {
	224	+ public function deactivate( $network_wide ) {
	225	+ if ( is_multisite() && $network_wide ) {
	226	+ foreach ( get_sites( array( 'fields' => 'ids' ) ) as $blog_id ) {
	227	+ switch_to_blog( $blog_id );
	228	+ $this->deactivate_on_site();
	229	+ restore_current_blog();
	230	+ }
	231	+ } else {
	232	+ $this->deactivate_on_site();
	233	+ }
	234	+ }
	235	+
	236	+ /**
	237	+ * Deactivates the plugin on a particular blog instance (supports multisite and single site).
	238	+ */
	239	+ private function deactivate_on_site() {
152	240	wp_clear_scheduled_hook( 'visualizer_schedule_refresh_db' );
	241	+ delete_option( 'visualizer-activated', true );
153	242	}
154	243
155	244	/**
156		- * Refresh the specific chart from the db. This is mostly for charts that have 0 refresh time i.e. live data.
	245	+ * Check if plugin has been activated and then redirect to the correct page.
	246	+ */
	247	+ public function adminInit() {
	248	+ if ( defined( 'TI_UNIT_TESTING' ) ) {
	249	+ return;
	250	+ }
	251	+
	252	+ define( 'VISUALIZER_SURVEY', Visualizer_Module::is_pro() ? 'https://forms.gle/7Zo7FuZbvQ8DTvRi6' : 'https://forms.gle/muMtbcyvHn1aTvmJ7' );
	253	+ // fire any upgrades necessary.
	254	+ Visualizer_Module_Upgrade::upgrade();
	255	+
	256	+ if ( get_option( 'visualizer-activated' ) ) {
	257	+ delete_option( 'visualizer-activated' );
	258	+ if ( ! headers_sent() ) {
	259	+ if ( ! Visualizer_Module::is_pro() && ! empty( get_option( 'visualizer_fresh_install', false ) ) ) {
	260	+ $redirect_url = array(
	261	+ 'page' => 'visualizer-setup-wizard',
	262	+ 'tab' => '#step-1',
	263	+ );
	264	+ } else {
	265	+ $page_name = Visualizer_Module::numberOfCharts() > 0 ? Visualizer_Plugin::NAME : 'viz-support';
	266	+ $redirect_url = array(
	267	+ 'page' => $page_name,
	268	+ );
	269	+ }
	270	+ wp_safe_redirect(
	271	+ add_query_arg(
	272	+ $redirect_url,
	273	+ admin_url( 'admin.php' )
	274	+ )
	275	+ );
	276	+ exit();
	277	+ }
	278	+ }
	279	+ }
	280	+
	281	+
	282	+ /**
	283	+ * Refresh the specific chart from the db.
157	284	*
158		- * @param WP_Post $chart The chart object.
159		- * @param int $chart_id The chart id.
160		- * @param bool $force If this is true, then the chart data will be refreshed no matter if the chart requests live data or cached data.
161		- * If false, data will be refreshed only if the chart requests live data.
	285	+ * @param WP_Post|null $chart The chart object.
	286	+ * @param int $chart_id The chart id.
	287	+ * @param bool $force If this is true, then the chart data will be force refreshed. If false, data will be refreshed only if the chart requests live data.
162	288	*
163	289	* @access public
164	290	*/
165	291	public function refresh_db_for_chart( $chart, $chart_id, $force = false ) {
		@@ -170,38 +296,97 @@
170	296	if ( ! $chart ) {
171	297	$chart = get_post( $chart_id );
172	298	}
173	299
174		- // check if its a live-data chart or a cached-data chart.
175		- if ( ! $force ) {
176		- $hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_SCHEDULE, true );
177		- if ( ! empty( $hours ) ) {
178		- // cached, bail!
179		- return $chart;
180		- }
	300	+ if ( ! $chart ) {
	301	+ return $chart;
181	302	}
182	303
183	304	// check if the source is correct.
184	305	$source = get_post_meta( $chart_id, Visualizer_Plugin::CF_SOURCE, true );
185		- if ( $source !== 'Visualizer_Source_Query_Params' ) {
186		- return $chart;
	306	+ $load_series = false;
	307	+ switch ( $source ) {
	308	+ case 'Visualizer_Source_Query':
	309	+ // check if its a live-data chart or a cached-data chart.
	310	+ if ( ! $force ) {
	311	+ $hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_SCHEDULE, true );
	312	+ if ( ! empty( $hours ) ) {
	313	+ // cached, bail!
	314	+ return $chart;
	315	+ }
	316	+ }
	317	+
	318	+ $params = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_QUERY, true );
	319	+ $source = new Visualizer_Source_Query( $params, $chart_id );
	320	+ $source->fetch( false );
	321	+ $load_series = true;
	322	+ break;
	323	+ case 'Visualizer_Source_Json':
	324	+ // check if its a live-data chart or a cached-data chart.
	325	+ if ( ! $force ) {
	326	+ $hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_SCHEDULE, true );
	327	+ if ( ! empty( $hours ) ) {
	328	+ // cached, bail!
	329	+ return $chart;
	330	+ }
	331	+ }
	332	+
	333	+ $url = get_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_URL, true );
	334	+ $root = get_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_ROOT, true );
	335	+ $paging = get_post_meta( $chart_id, Visualizer_Plugin::CF_JSON_PAGING, true );
	336	+ $series = get_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, true );
	337	+ $source = new Visualizer_Source_Json( array( 'url' => $url, 'root' => $root, 'paging' => $paging ) );
	338	+ $source->refresh( $series );
	339	+ break;
	340	+ case 'Visualizer_Source_Csv_Remote':
	341	+ // check if its a live-data chart or a cached-data chart.
	342	+ if ( ! $force ) {
	343	+ $hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_CHART_SCHEDULE, true );
	344	+ if ( ! empty( $hours ) ) {
	345	+ // cached, bail!
	346	+ return $chart;
	347	+ }
	348	+ }
	349	+ do_action( 'visualizer_schedule_import' );
	350	+ return get_post( $chart_id );
	351	+ default:
	352	+ return $chart;
187	353	}
188	354
189		- $params = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_QUERY, true );
190		- $source = new Visualizer_Source_Query( $params );
191		- $source->fetch( false );
192	355	$error = $source->get_error();
193	356	if ( empty( $error ) ) {
194		- update_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, $source->getSeries() );
	357	+ $this->disableRevisionsTemporarily();
	358	+ if ( $load_series ) {
	359	+ update_post_meta( $chart_id, Visualizer_Plugin::CF_SERIES, $source->getSeries() );
	360	+ }
195	361
	362	+ $allow_html = false;
	363	+ $settings = get_post_meta( $chart_id, Visualizer_Plugin::CF_SETTINGS, true );
	364	+ if ( isset( $settings['allowHtml'] ) && intval( $settings['allowHtml'] ) === 1 ) {
	365	+ $allow_html = true;
	366	+ }
	367	+
	368	+ $allow_html = apply_filters( 'visualizer_allow_html_content', $allow_html, $chart_id, $chart );
	369	+
	370	+ if ( $allow_html ) {
	371	+ kses_remove_filters();
	372	+ }
	373	+
196	374	wp_update_post(
197	375	array(
198	376	'ID' => $chart_id,
199		- 'post_content' => $source->getData(),
	377	+ 'post_content' => $source->getData( get_post_meta( $chart_id, Visualizer_Plugin::CF_EDITABLE_TABLE, true ) ),
200	378	)
201	379	);
202	380
	381	+ if ( $allow_html ) {
	382	+ kses_init_filters();
	383	+ }
	384	+
203	385	$chart = get_post( $chart_id );
	386	+ delete_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR );
	387	+ } else {
	388	+ update_post_meta( $chart_id, Visualizer_Plugin::CF_ERROR, sprintf( 'Error while updating chart: %s', $error ) );
204	389	}
205	390
206	391	return $chart;
207	392	}
		@@ -206,17 +391,19 @@
206	391	return $chart;
207	392	}
208	393
209	394	/**
210		- * Refresh the db chart.
	395	+ * Refresh the Database chart type.
211	396	*
212	397	* @access public
213	398	*/
214	399	public function refreshDbChart() {
215		- $schedules = get_option( Visualizer_Plugin::CF_DB_SCHEDULE, array() );
216		- if ( ! $schedules ) {
	400	+ // NOTE: This use a different key from normal schedule. Updated only by Database chart. Check `visualizer_schedule_import` action.
	401	+ $chart_schedules = get_option( Visualizer_Plugin::CF_DB_SCHEDULE, array() );
	402	+ if ( ! $chart_schedules ) {
217	403	return;
218	404	}
	405	+
219	406	if ( ! defined( 'VISUALIZER_DO_NOT_DIE' ) ) {
220	407	// define this so that the ajax call does not die
221	408	// this means that if the new version of pro and the old version of free are installed, only the first chart will be updated
222	409	define( 'VISUALIZER_DO_NOT_DIE', true );
		@@ -222,19 +409,64 @@
222	409	define( 'VISUALIZER_DO_NOT_DIE', true );
223	410	}
224	411
225	412	$new_schedules = array();
226		- $now = time();
227		- foreach ( $schedules as $chart_id => $time ) {
228		- $new_schedules[ $chart_id ] = $time;
229		- if ( $time > $now ) {
	413	+ $current_time = time();
	414	+ foreach ( $chart_schedules as $chart_id => $scheduled_time ) {
	415	+
	416	+ // Skip deleted charts.
	417	+ if ( false === get_post_status( $chart_id ) ) {
230	418	continue;
231	419	}
232	420
233		- $this->refresh_db_for_chart( null, $chart_id, false );
234		- $hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_SCHEDULE, true );
235		- $new_schedules[ $chart_id ] = time() + $hours * HOUR_IN_SECONDS;
	421	+ $new_schedules[ $chart_id ] = $scheduled_time;
	422	+
	423	+ // Should we do an update?
	424	+ if ( $scheduled_time > $current_time ) {
	425	+ continue;
	426	+ }
	427	+
	428	+ $this->refresh_db_for_chart( null, $chart_id, true );
	429	+
	430	+ // Clear existing chart cache.
	431	+ $cache_key = Visualizer_Plugin::CF_CHART_CACHE . '_' . $chart_id;
	432	+ if ( get_transient( $cache_key ) ) {
	433	+ delete_transient( $cache_key );
	434	+ }
	435	+
	436	+ $scheduled_hours = get_post_meta( $chart_id, Visualizer_Plugin::CF_DB_SCHEDULE, true );
	437	+ $new_schedules[ $chart_id ] = $current_time + $scheduled_hours * HOUR_IN_SECONDS;
236	438	}
237	439	update_option( Visualizer_Plugin::CF_DB_SCHEDULE, $new_schedules );
238	440	}
239	441
	442	+ /**
	443	+ * Save flag for existing users.
	444	+ */
	445	+ public function checkIsExistingUser() {
	446	+ $chart_exists = get_option( 'visualizer-new-user', '' );
	447	+ if ( '' === $chart_exists ) {
	448	+ $charts = get_posts(
	449	+ array(
	450	+ 'post_type' => Visualizer_Plugin::CPT_VISUALIZER,
	451	+ 'fields' => 'ids',
	452	+ )
	453	+ );
	454	+ update_option( 'visualizer-new-user', ! empty( $charts ) ? 'no' : 'yes' );
	455	+ }
	456	+ }
	457	+
	458	+ /**
	459	+ * Add custom cron schedules.
	460	+ *
	461	+ * @param array $schedules The current schedules options.
	462	+ * @return array The modified schedules options.
	463	+ */
	464	+ public function custom_cron_schedules( $schedules ) {
	465	+ $schedules['visualizer_ten_minutes'] = array(
	466	+ 'interval' => 600,
	467	+ 'display' => __( 'Every 10 minutes', 'visualizer' ),
	468	+ );
	469	+
	470	+ return $schedules;
	471	+ }
240	472	}