← All changes | includes/functions.php +371 -229 1.3.1 → 3.0.2 View file →

		@@ -1,313 +1,455 @@
1	1	<?php
2	2
3	3	defined('ABSPATH') or die('Jog on!');
4	4
5		-function sh_cd_get_all_shortcodes()
6		-{
7		- global $wpdb;
	5	+/**
	6	+ * Save / Insert a shortcode
	7	+ *
	8	+ * @return bool
	9	+ */
	10	+function sh_cd_shortcodes_save_post() {
8	11
9		- $sql = 'SELECT * FROM ' . $wpdb->prefix . SH_CD_TABLE . ' order by slug asc';
	12	+ // Capture the raw $_POST fields, the save functions will process and validate the data
	13	+ $shortcode = sh_cd_get_values_from_post( [ 'id', 'slug', 'previous_slug', 'data', 'disabled', 'multisite' ] );
10	14
11		- $rows = $wpdb->get_results( $sql );
	15	+ return sh_cd_db_shortcodes_save( $shortcode );
	16	+}
12	17
13		- if (!is_null($rows))
14		- return $rows;
15		-
16		- return false;
17		-
	18	+/**
	19	+ * Replace user parameters within a shortcode e.g. look for %%parameter%% and replace
	20	+ *
	21	+ * @param $shortcode
	22	+ * @param $user_defined_parameters
	23	+ *
	24	+ * @return mixed
	25	+ */
	26	+function sh_cd_apply_user_defined_parameters( $shortcode, $user_defined_parameters ){
	27	+
	28	+ // Ensure we have something to do!
	29	+ if ( true === empty( $user_defined_parameters ) || false === is_array( $user_defined_parameters ) ) {
	30	+ return $shortcode;
	31	+ }
	32	+
	33	+ foreach ( $user_defined_parameters as $key => $value ) {
	34	+ $shortcode = str_replace( '%%' . $key . '%%', $value, $shortcode );
	35	+ }
	36	+
	37	+ return $shortcode;
18	38	}
19	39
20		-function sh_cd_get_shortcode($id)
21		-{
22		- if (!is_admin())
23		- return false;
	40	+/**
	41	+ * Generate a unique slug
	42	+ *
	43	+ * @param $slug
	44	+ *
	45	+ * @return string
	46	+ */
	47	+function sh_cd_slug_generate( $slug, $exising_id = NULL ) {
24	48
25		- global $wpdb;
	49	+ if ( true === empty( $slug ) ) {
	50	+ return NULL;
	51	+ }
26	52
27		- $sql = $wpdb->prepare('SELECT slug, data FROM ' . $wpdb->prefix . SH_CD_TABLE . ' where id = %d', $id);
	53	+ $slug = sanitize_title( $slug );
28	54
29		- $row = $wpdb->get_row( $sql );
	55	+ $original_slug = $slug;
30	56
31		- if (!is_null($row))
32		- return $row;
33		-
34		- return false;
35		-
	57	+ $try = 1;
	58	+
	59	+ // Ensure the slug is unique
	60	+ while ( false === sh_cd_slug_is_unique( $slug, $exising_id ) ) {
	61	+
	62	+ $slug = sprintf( '%s_%d', $original_slug, $try );
	63	+
	64	+ $try++;
	65	+ }
	66	+
	67	+ return $slug;
36	68	}
37		-function sh_cd_get_shortcode_by_slug($slug)
38		-{
39		- global $wpdb;
40	69
41		- $sql = $wpdb->prepare('SELECT data FROM ' . $wpdb->prefix . SH_CD_TABLE . ' where slug = %s', $slug);
	70	+/**
	71	+ * Clone an existing shortcode!
	72	+ *
	73	+ * @param $id
	74	+ *
	75	+ * @return bool
	76	+ */
	77	+function sh_cd_clone( $id ) {
42	78
43		- $row = $wpdb->get_var( $sql );
	79	+ if( false === sh_cd_license_is_premium() ) {
	80	+ return true;
	81	+ }
44	82
45		- if (!is_null($row))
46		- return stripslashes($row);
47		-
48		- return false;
49		-
	83	+ if ( false === is_numeric( $id ) ) {
	84	+ return false;
	85	+ }
	86	+
	87	+ $to_be_cloned = sh_cd_db_shortcodes_by_id( $id );
	88	+
	89	+ if ( true === empty( $to_be_cloned ) ) {
	90	+ return false;
	91	+ }
	92	+
	93	+ unset( $to_be_cloned['id'] );
	94	+
	95	+ return sh_cd_db_shortcodes_save( $to_be_cloned );
50	96	}
51		-function sh_cd_get_slug_by_id($id)
52		-{
53		- global $wpdb;
54	97
55		- $sql = $wpdb->prepare('SELECT slug FROM ' . $wpdb->prefix . SH_CD_TABLE . ' where id = %d', $id);
	98	+/**
	99	+ * Display message in admin UI
	100	+ *
	101	+ * @param $text
	102	+ * @param bool $error
	103	+ */
	104	+function sh_cd_message_display( $text, $error = false ) {
56	105
57		- $row = $wpdb->get_var( $sql );
	106	+ if ( true === empty( $text ) ) {
	107	+ return;
	108	+ }
58	109
59		- if (!is_null($row))
60		- return $row;
61		-
62		- return false;
63		-
	110	+ printf( '<div class="%s"><p>%s</p></div>',
	111	+ true === $error ? 'error' : 'updated',
	112	+ esc_html( $text )
	113	+ );
	114	+
	115	+ //TODO: Hook this to use admin_notices
64	116	}
65	117
66		-function sh_cd_save_shortcode($slug, $data, $id = false)
67		-{
68		- if (!is_admin())
69		- return false;
	118	+/**
	119	+ * Fetch cache item
	120	+ *
	121	+ * @param $key
	122	+ *
	123	+ * @return mixed
	124	+ */
	125	+function sh_cd_cache_get( $key ) {
70	126
71		- if (false == $id && empty($slug))
72		- return false;
	127	+ $key = sh_cd_cache_generate_key( $key );
73	128
74		- global $wpdb;
	129	+ return get_transient( $key );
	130	+}
75	131
76		- $slug = sh_cd_get_slug($slug);
	132	+/**
	133	+ * Set cache item
	134	+ *
	135	+ * @param $key
	136	+ * @param $data
	137	+ */
	138	+function sh_cd_cache_set( $key, $data, $expire = NULL ) {
77	139
78		- $result = false;
79	140
80		- if ($id)
81		- {
82		- //Update data (Slug can never be updated!)
83		- $result = $wpdb->update(
84		- $wpdb->prefix . SH_CD_TABLE,
85		- array(
86		- 'data' => $data
87		- ),
88		- array( 'id' => $id),
89		- array(
90		- '%s'
91		- ),
92		- array( '%d' )
93		- );
	141	+ $expire = ( false === empty( $expire ) ) ? (int) $expire : 1 * HOUR_IN_SECONDS;
94	142
95		- sh_cd_delete_cache(sh_cd_get_slug_by_id($id));
	143	+ $key = sh_cd_cache_generate_key( $key );
	144	+
	145	+ set_transient( $key, $data, $expire );
	146	+}
	147	+
	148	+/**
	149	+ * Delete cache for given shortcode slug / ID
	150	+ *
	151	+ * @param $slug_or_key
	152	+ */
	153	+function sh_cd_cache_delete_by_slug_or_key( $slug_or_key ) {
	154	+
	155	+ if ( true === is_numeric( $slug_or_key ) ) {
	156	+
	157	+ $slug_or_key = sh_cd_db_shortcodes_get_slug_by_id( $slug_or_key );
	158	+
	159	+ sh_cd_cache_delete( $slug_or_key );
	160	+
	161	+ } else {
	162	+ sh_cd_cache_delete( $slug_or_key );
96	163	}
97		- else
98		- {
99		- $result = $wpdb->insert(
100		- $wpdb->prefix . SH_CD_TABLE,
101		- array(
102		- 'slug' => $slug,
103		- 'data' => $data
104		- ),
105		- array(
106		- '%s',
107		- '%s'
108		- )
109		- );
110	164
111		- sh_cd_delete_cache($slug);
112		- }
	165	+ // Delete site option
	166	+ $slug_or_key = SH_CD_PREFIX . $slug_or_key;
113	167
114		- if (false === $result) {
115		- return false;
116		- }
117		- else
118		- {
119		- return true;
120		- }
121		-
	168	+ delete_site_option( $slug_or_key );
	169	+
122	170	}
123	171
124		-function sh_cd_delete_shortcode($id)
125		-{
126		- if (!is_admin() || !is_numeric($id))
127		- return false;
	172	+/**
	173	+ * Delete cache item
	174	+ *
	175	+ * @param $key
	176	+ *
	177	+ * @return mixed
	178	+ */
	179	+function sh_cd_cache_delete( $key ) {
128	180
129		- global $wpdb;
	181	+ $key = sh_cd_cache_generate_key( $key );
130	182
131		- if (false === $wpdb->delete( $wpdb->prefix . SH_CD_TABLE, array( 'id' => $id ) )) {
132		- return false;
133		- }
134		- else {
135		- return true;
136		- }
137		-
	183	+ return delete_transient( $key );
138	184	}
139	185
140		-function sh_cd_get_slug($text)
141		-{
142		- if(!empty($text))
143		- {
144		- $text = sanitize_title($text);
	186	+/**
	187	+ * Generate cache key
	188	+ *
	189	+ * @param $key
	190	+ *
	191	+ * @return string
	192	+ */
	193	+function sh_cd_cache_generate_key( $key ) {
	194	+ return SH_CD_SHORTCODE . SH_CD_PLUGIN_VERSION . $key;
	195	+}
145	196
146		- $original_slug = $text;
	197	+/**
	198	+ * Return link to list own shortcodes
	199	+ *
	200	+ * @return mixed
	201	+ */
	202	+function sh_cd_link_your_shortcodes() {
147	203
148		- $try = 1;
149		- var_dump(in_array($text, sh_cd_shortcode_presets()));
	204	+ $link = admin_url('admin.php?page=sh-cd-shortcode-variables-your-shortcodes');
150	205
151		- // If slug exists, then fetch a unique one!
152		- // v1.1: and ensure slug isn't a preset
153		- while (!sh_cd_is_slug_unique($text))
154		- {
155		- $text = $original_slug . '_' . $try;
156		-
157		- $try++;
158		- }
159		- }
	206	+ return esc_url( $link );
	207	+}
160	208
161		- return $text;
	209	+/**
	210	+ * Return link to add own shortcode
	211	+ *
	212	+ * @return mixed
	213	+ */
	214	+function sh_cd_link_your_shortcodes_add() {
	215	+
	216	+ $link = admin_url('admin.php?page=sh-cd-shortcode-variables-your-shortcodes&action=add');
	217	+
	218	+ return esc_url( $link );
162	219	}
163	220
164		-function sh_cd_is_slug_unique($slug)
165		-{
166		- if (!is_admin() || empty($slug))
167		- return false;
	221	+/**
	222	+ * Return link to edit own shortcode
	223	+ *
	224	+ * @return mixed
	225	+ */
	226	+function sh_cd_link_your_shortcodes_edit( $id ) {
168	227
169		- // 1.1 Ensure slug is not a prefix
170		- if (sh_cd_is_shortcode_preset($slug))
171		- return false;
	228	+ $link = admin_url('admin.php?page=sh-cd-shortcode-variables-your-shortcodes&action=edit&id=' . (int) $id );
172	229
173		- global $wpdb;
	230	+ return esc_url( $link );
	231	+}
174	232
175		- $sql = $wpdb->prepare('SELECT count(slug) FROM ' . $wpdb->prefix . SH_CD_TABLE . ' where slug = %s', $slug);
	233	+/**
	234	+ * Return link to delete own shortcode
	235	+ *
	236	+ * @return mixed
	237	+ */
	238	+function sh_cd_link_your_shortcodes_delete( $id ) {
176	239
177		- $row = $wpdb->get_var( $sql );
	240	+ $link = admin_url('admin.php?page=sh-cd-shortcode-variables-your-shortcodes&action=delete&id=' . (int) $id );
178	241
179		- if(0 == $row)
180		- {
181		- return true;
182		- }
183		- else
184		- {
185		- return false;
186		- }
	242	+ return esc_url( $link );
	243	+}
187	244
	245	+/**
	246	+ * Either fetch data from the $_POST object or from the array passed in!
	247	+ *
	248	+ * @param $object
	249	+ * @param $key
	250	+ * @return string
	251	+ */
	252	+function sh_cd_get_value_from_post_or_obj( $object, $key ) {
188	253
	254	+ if ( true === isset( $_POST[ $key ] ) ) {
	255	+ return $_POST[ $key ];
	256	+ }
	257	+
	258	+ if ( true === isset( $object[ $key ] ) ) {
	259	+ return $object[ $key ];
	260	+ }
	261	+
	262	+ return '';
189	263	}
190	264
191		-function sh_cd_create_database_table()
192		-{
193		- global $wpdb;
	265	+/**
	266	+ * Either fetch data from the $_POST object for the given object keys
	267	+ *
	268	+ * @param $meta_field
	269	+ * @return string
	270	+ */
	271	+function sh_cd_get_values_from_post( $keys ) {
194	272
195		- $table_name = $wpdb->prefix . SH_CD_TABLE;
196		-
197		- $charset_collate = $wpdb->get_charset_collate();
	273	+ $data = [];
198	274
199		- $sql = "CREATE TABLE $table_name (
200		- id mediumint(9) NOT NULL AUTO_INCREMENT,
201		- slug varchar(100) NOT NULL,
202		- data text,
203		- UNIQUE KEY id (id)
204		- ) $charset_collate;";
	275	+ foreach ( $keys as $key ) {
205	276
206		- $wpdb->query($sql);
	277	+ if ( true === isset( $_POST[ $key ] ) ) {
	278	+ $data[ $key ] = $_POST[ $key ];
	279	+ } else {
	280	+ $data[ $key ] = '';
	281	+ }
207	282
208		- update_option('sh-cd-version', SH_CD_PLUGIN_VERSION);
	283	+ }
209	284
	285	+ return $data;
210	286	}
211	287
212		-function sh_cd_display_message($text, $error = false)
213		-{
214		- if (!empty($text))
215		- {
216		- $class = (($error) ? 'error' : 'updated');
	288	+/**
	289	+ * Toggle the status of a shortcode
	290	+ *
	291	+ * @param $id
	292	+ */
	293	+function sh_cd_toggle_status( $id ) {
217	294
218		- echo '<div class="' . $class . '">
219		- <p>' . $text . '</p>
220		- </div>';
	295	+ $slug = sh_cd_db_shortcodes_by_id( (int) $id );
	296	+
	297	+ if ( false === empty( $slug ) ) {
	298	+
	299	+ $status = ( 1 === (int) $slug['disabled'] ) ? 0 : 1 ;
	300	+
	301	+ sh_cd_db_shortcodes_update_status( $id, $status );
	302	+
	303	+ return $status;
221	304	}
	305	+
	306	+ return NULL;
222	307	}
223	308
224		-function sh_cd_create_dialog_jquery_code($title, $message, $class_used_to_prompt_confirmation, $js_call = false)
225		-{
226		- global $wp_scripts;
227		- $queryui = $wp_scripts->query('jquery-ui-core');
228		- $url = "//ajax.googleapis.com/ajax/libs/jqueryui/".$queryui->ver."/themes/smoothness/jquery-ui.css";
229		- wp_enqueue_script( 'jquery-ui-dialog' );
230		- wp_enqueue_style('jquery-ui-smoothness', $url, false, null);
	309	+/**
	310	+ * Toggle the multisite of a shortcode
	311	+ *
	312	+ * @param $id
	313	+ */
	314	+function sh_cd_toggle_multisite( $id ) {
231	315
232		- $id_hash = md5($title . $message . $class_used_to_prompt_confirmation);
	316	+ $slug = sh_cd_db_shortcodes_by_id( (int) $id );
233	317
234		- ?>
235		- <div id='<?php echo $id_hash; ?>' title='<?php echo $title; ?>'>
236		- <p><?php echo $message; ?></p>
237		- </div>
238		- <script>
239		- jQuery(function($) {
240		-
241		- var $info = $('#<?php echo $id_hash; ?>');
242		-
243		- $info.dialog({
244		- 'dialogClass' : 'wp-dialog',
245		- 'modal' : true,
246		- 'autoOpen' : false
247		- });
248		-
249		- $('.<?php echo $class_used_to_prompt_confirmation; ?>').click(function(event) {
250		-
251		- event.preventDefault();
	318	+ if ( false === empty( $slug ) ) {
252	319
253		- target_url = $(this).attr('href');
254		-
255		- var $info = $('#<?php echo $id_hash; ?>');
256		-
257		- $info.dialog({
258		- 'dialogClass' : 'wp-dialog',
259		- 'modal' : true,
260		- 'autoOpen' : false,
261		- 'closeOnEscape' : true,
262		- 'buttons' : {
263		- 'Yes': function() {
	320	+ $multisite = ( 1 === (int) $slug['multisite'] ) ? 0 : 1 ;
264	321
265		- <?php if ($js_call != false): ?>
266		- <?php echo $js_call; ?>
	322	+ sh_cd_db_shortcodes_update_multisite( $id, $multisite );
267	323
268		- $(this).dialog('close');
269		- <?php else: ?>
270		- window.location.href = target_url;
271		- <?php endif; ?>
272		- },
273		- 'No': function() {
274		- $(this).dialog('close');
275		- }
276		- }
277		- });
	324	+ return $multisite;
	325	+ }
278	326
279		- $info.dialog('open');
280		- });
	327	+ return NULL;
	328	+}
281	329
282		- });
283	330
	331	+/**
	332	+ * Display a table of premade shortcodes
	333	+ *
	334	+ * @param string $display
	335	+ */
	336	+function sh_cd_display_premade_shortcodes( $display = 'all' ) {
284	337
	338	+ $premium_user = sh_cd_license_is_premium();
	339	+ $upgrade_link = sprintf( '<a class="button" href="%s"><i class="fas fa-check"></i> Upgrade now</a>', sh_cd_license_upgrade_link() );
285	340
	341	+ switch ( $display ) {
	342	+ case 'free':
	343	+ $shortcodes = sh_cd_shortcode_presets_free_list();
	344	+ $show_premium_col = false;
	345	+ break;
	346	+ case 'premium':
	347	+ $shortcodes = sh_cd_shortcode_presets_premium_list();
	348	+ $show_premium_col = false;
	349	+ break;
	350	+ default:
	351	+ $shortcodes = sh_cd_presets_both_lists();
	352	+ $show_premium_col = true;
	353	+ }
286	354
287		- </script>
	355	+ $html = '<table class="widefat sh-cd-table" width="100%">
	356	+ <tr class="row-title">
	357	+ <th class="row-title" width="30%">Shortcode</th>';
288	358
289		- <?php
	359	+ if ( true === $show_premium_col) {
	360	+ $html .= '<th class="row-title">Premium</th>';
	361	+ }
	362	+
	363	+ $html .= '<th width="*">Description</th>
	364	+ </tr>';
	365	+
	366	+ $class = '';
	367	+
	368	+ foreach ( $shortcodes as $key => $data ) {
	369	+
	370	+ $class = ($class == 'alternate') ? '' : 'alternate';
	371	+
	372	+ $shortcode = '[' . SH_CD_SHORTCODE. ' slug="' . $key . '"]';
	373	+
	374	+ $premium_shortcode = ( true === $data['premium'] );
	375	+
	376	+ $html .= sprintf( '<tr class="%s"><td>%s</td>', $class, esc_html( $shortcode ) );
	377	+
	378	+
	379	+ if ( true === $show_premium_col) {
	380	+
	381	+ $html .= sprintf( '<td align="middle">%s%s</td>',
	382	+ ( true === $premium_shortcode && true === $premium_user ) ? '<i class="fas fa-check"></i>' : '',
	383	+ ( true == $premium_shortcode && false === $premium_user ) ? $upgrade_link : ''
	384	+ );
	385	+ }
	386	+
	387	+ $html .= sprintf( '<td>%s</td></tr>', wp_kses_post( $data['description'] ) );
	388	+
	389	+ }
	390	+
	391	+ $html .= '</table>';
	392	+
	393	+ return $html;
290	394	}
291	395
292		-function sh_cd_get_cache($key)
293		-{
294		- $key = sh_cd_generate_cache_key($key);
	396	+/**
	397	+ * Display an upgrade button
	398	+ */
	399	+function sh_cd_upgrade_button( $css_class = '', $link = NULL ) {
295	400
296		- return get_transient($key);
	401	+ $link = ( false === empty( $link ) ) ? $link : SH_CD_UPGRADE_LINK . '?hash=' . sh_cd_generate_site_hash() ;
	402	+
	403	+ echo sprintf('<a href="%s" class="button-primary sh-cd-upgrade-button%s"><i class="far fa-credit-card"></i> %s £%d %s</a>',
	404	+ esc_url( $link ),
	405	+ esc_attr( ' ' . $css_class ),
	406	+ __('Upgrade to Premium for ', SH_CD_SLUG),
	407	+ SH_CD_PREMIUM_PRICE,
	408	+ __('a year ', SH_CD_SLUG)
	409	+ );
297	410	}
298		-function sh_cd_set_cache($key, $data)
299		-{
300		- $key = sh_cd_generate_cache_key($key);
301	411
302		- set_transient($key, $data, SH_CD_CACHING_TIME);
	412	+/**
	413	+ * Is multsite functionality active for this install?
	414	+ *
	415	+ * @return bool
	416	+ */
	417	+function sh_cd_is_multisite_enabled() {
	418	+
	419	+ if ( false === is_multisite() ) {
	420	+ return false;
	421	+ }
	422	+
	423	+ if ( false === sh_cd_license_is_premium() ) {
	424	+ return false;
	425	+ }
	426	+
	427	+ return true;
303	428	}
304		-function sh_cd_delete_cache($key)
305		-{
306		- $key = sh_cd_generate_cache_key($key);
307	429
308		- return delete_transient($key);
309		-}
310		-function sh_cd_generate_cache_key($key)
311		-{
312		- return SH_CD_SHORTCODE . $key;
	430	+/**
	431	+ * Fetch all multisite slugs
	432	+ *
	433	+ * @return array|null
	434	+ */
	435	+function sh_cd_multisite_slugs() {
	436	+
	437	+ if ( false === is_multisite() ) {
	438	+ return [];
	439	+ }
	440	+
	441	+ $cache = sh_cd_cache_get( 'sh-cd-multisite-slugs' );
	442	+
	443	+ if ( false !== $cache ) {
	444	+ return $cache;
	445	+ }
	446	+
	447	+ $slugs = sh_cd_db_shortcodes_multisite_slugs();
	448	+
	449	+ $slugs = ( false === empty( $slugs ) ) ? wp_list_pluck( $slugs, 'slug' ) : NULL;
	450	+
	451	+ // Cache this for a short time
	452	+ sh_cd_cache_set( 'sh-cd-multisite-slugs', $slugs, 30 );
	453	+
	454	+ return ( true === is_array( $slugs ) ) ? $slugs : [];
313	455	}