supportcandy / includes / custom-field-types / class-wpsc-df-os.php

class-wpsc-df-os.php in SupportCandy – AI Customer Support Ticket System & Live Chatbot Agent 3.5.4, at includes/custom-field-types/class-wpsc-df-os.php

587 lines 15.9 KB

Raw Download Zip

1	<?php
2	if ( ! defined( 'ABSPATH' ) ) {
3	exit; // Exit if accessed directly!
4	}
5
6	if ( ! class_exists( 'WPSC_DF_OS' ) ) :
7
8	final class WPSC_DF_OS {
9
10	/**
11	* Slug for this custom field type
12	*
13	* @var string
14	*/
15	public static $slug = 'df_os';
16
17	/**
18	* Set whether this custom field type is of type date
19	*
20	* @var boolean
21	*/
22	public static $is_date = false;
23
24	/**
25	* Set whether this custom field type has applicable to date range
26	*
27	* @var boolean
28	*/
29	public static $has_date_range = false;
30
31	/**
32	* Set whether this custom field type has multiple values
33	*
34	* @var boolean
35	*/
36	public static $has_multiple_val = false;
37
38	/**
39	* Data type for column created in tickets table
40	*
41	* @var string
42	*/
43	public static $data_type = 'VARCHAR(50) NULL';
44
45	/**
46	* Set whether this custom field type has reference to other class
47	*
48	* @var boolean
49	*/
50	public static $has_ref = false;
51
52	/**
53	* Reference class for this custom field type so that its value(s) return with object or array of objects automatically. Empty string indicate no reference.
54	*
55	* @var string
56	*/
57	public static $ref_class = '';
58
59	/**
60	* Set whether this custom field field type is system default (no fields can be created from it).
61	*
62	* @var boolean
63	*/
64	public static $is_default = true;
65
66	/**
67	* Set whether this field type has extra information that can be used in ticket form, edit custom fields, etc.
68	*
69	* @var boolean
70	*/
71	public static $has_extra_info = false;
72
73	/**
74	* Set whether this custom field type can accept personal info.
75	*
76	* @var boolean
77	*/
78	public static $has_personal_info = false;
79
80	/**
81	* Set whether fields created from this custom field type is allowed in create ticket form
82	*
83	* @var boolean
84	*/
85	public static $is_ctf = false;
86
87	/**
88	* Set whether fields created from this custom field type is allowed in ticket list
89	*
90	* @var boolean
91	*/
92	public static $is_list = true;
93
94	/**
95	* Set whether fields created from this custom field type is allowed in ticket filter
96	*
97	* @var boolean
98	*/
99	public static $is_filter = true;
100
101	/**
102	* Set whether fields created from this custom field type can be given character limits
103	*
104	* @var boolean
105	*/
106	public static $has_char_limit = false;
107
108	/**
109	* Set whether fields created from this custom field type has custom options set in options table
110	*
111	* @var boolean
112	*/
113	public static $has_options = false;
114
115	/**
116	* Set whether fields created from this custom field type can be available for ticket list sorting
117	*
118	* @var boolean
119	*/
120	public static $is_sort = false;
121
122	/**
123	* Set whether fields created from this custom field type can be auto-filled
124	*
125	* @var boolean
126	*/
127	public static $is_auto_fill = false;
128
129	/**
130	* Set whether fields created from this custom field type can have placeholder
131	*
132	* @var boolean
133	*/
134	public static $is_placeholder = false;
135
136	/**
137	* Set whether fields created from this custom field type is applicable for visibility conditions in create ticket form
138	*
139	* @var boolean
140	*/
141	public static $is_visibility_conditions = false;
142
143	/**
144	* Set whether fields created from this custom field type is applicable for macros
145	*
146	* @var boolean
147	*/
148	public static $has_macro = true;
149
150	/**
151	* Set whether fields of this custom field type is applicalbe for search on ticket list page.
152	*
153	* @var boolean
154	*/
155	public static $is_search = false;
156
157	/**
158	* Initialize the class
159	*
160	* @return void
161	*/
162	public static function init() {
163
164	// Get object of this class.
165	add_filter( 'wpsc_load_ref_classes', array( __CLASS__, 'load_ref_class' ) );
166
167	// ticket form.
168	add_filter( 'wpsc_create_ticket_data', array( __CLASS__, 'set_create_ticket_data' ), 10, 3 );
169
170	// Set custom field type.
171	add_filter( 'wpsc_default_cf_types', array( __CLASS__, 'default_cf_types' ), 4 );
172	}
173
174	/**
175	* Add default custom field type to list
176	*
177	* @param array $default_cf_types - default custom field types array.
178	* @return array
179	*/
180	public static function default_cf_types( $default_cf_types ) {
181	$default_cf_types[ self::$slug ] = array(
182	'label' => esc_attr__( 'OS', 'supportcandy' ),
183	'class' => __CLASS__,
184	);
185	return $default_cf_types;
186	}
187
188	/**
189	* Print operators for ticket form filter
190	*
191	* @param WPSC_Custom_Field $cf - custom field object.
192	* @param array $filter - Existing filters (if any).
193	* @return void
194	*/
195	public static function get_operators( $cf, $filter = array() ) {
196	?>
197
198	<div class="item conditional">
199	<select class="operator" onchange="wpsc_tc_get_operand(this, '<?php echo esc_attr( $cf->slug ); ?>', '<?php echo esc_attr( wp_create_nonce( 'wpsc_tc_get_operand' ) ); ?>');">
200	<option value=""><?php esc_attr_e( 'Compare As', 'supportcandy' ); ?></option>
201	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], '=' ); ?> value="="><?php esc_attr_e( 'Equals', 'supportcandy' ); ?></option>
202	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], 'IN' ); ?> value="IN"><?php esc_attr_e( 'Matches', 'supportcandy' ); ?></option>
203	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], 'NOT IN' ); ?> value="NOT IN"><?php esc_attr_e( 'Not Matches', 'supportcandy' ); ?></option>
204	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], 'LIKE' ); ?> value="LIKE"><?php esc_attr_e( 'Has Words', 'supportcandy' ); ?></option>
205	</select>
206	</div>
207	<?php
208	}
209
210	/**
211	* Print operators for ticket form filter
212	*
213	* @param string $operator - condition operator on which operands should be returned.
214	* @param WPSC_Custom_Field $cf - custom field object.
215	* @param array $filter - Exising functions (if any).
216	* @return void
217	*/
218	public static function get_operands( $operator, $cf, $filter = array() ) {
219
220	$value = isset( $filter['operand_val_1'] ) ? stripslashes( $filter['operand_val_1'] ) : '';
221	if ( in_array( $operator, array( 'IN', 'NOT IN', 'LIKE' ) ) ) {
222	?>
223
224	<div class="item conditional operand single">
225	<textarea class="operand_val_1" placeholder="<?php esc_attr_e( 'One condition per line!', 'supportcandy' ); ?>" style="width: 100%;"><?php echo esc_attr( $value ); ?></textarea>
226	</div>
227	<?php
228
229	} else {
230	?>
231
232	<div class="item conditional operand single">
233	<input
234	type="text"
235	class="operand_val_1"
236	value="<?php echo esc_attr( $value ); ?>"
237	autocomplete="off"/>
238	</div>
239	<?php
240	}
241	}
242
243	/**
244	* Parse filter and return sql query to be merged in ticket model query builder
245	*
246	* @param WPSC_Custom_Field $cf - custom field of this type.
247	* @param mixed $compare - comparison operator.
248	* @param mixed $val - value to compare.
249	* @return string
250	*/
251	public static function parse_filter( $cf, $compare, $val ) {
252
253	// Validate slug defensively.
254	$slug = is_string( $cf->slug ) ? trim( $cf->slug ) : '';
255	if ( $slug === '' \|\| ! preg_match( '/^[a-zA-Z0-9_]+$/', $slug ) ) {
256	return '1=0';
257	}
258
259	$column = self::get_sql_slug( $cf );
260
261	// Normalize values to array of safe strings.
262	$values = is_array( $val ) ? $val : array( $val );
263	$clean = array();
264
265	foreach ( $values as $v ) {
266	if ( is_string( $v ) ) {
267	$v = trim( $v );
268	if ( $v !== '' ) {
269	$clean[] = esc_sql( $v );
270	}
271	}
272	}
273
274	if ( empty( $clean ) ) {
275	return '1=0';
276	}
277
278	switch ( $compare ) {
279
280	case '=':
281	return "$column = '{$clean[0]}'";
282
283	case 'IN':
284	return "CONVERT($column USING utf8) IN ('" . implode( "', '", $clean ) . "')";
285
286	case 'NOT IN':
287	return "CONVERT($column USING utf8) NOT IN ('" . implode( "', '", $clean ) . "')";
288
289	case 'LIKE':
290	$likes = array();
291
292	$lines = is_string( $val ) ? explode( PHP_EOL, $val ) : $values;
293
294	foreach ( $lines as $term ) {
295	if ( is_string( $term ) ) {
296	$term = trim( str_replace( '*', '%', $term ) );
297	if ( $term !== '' ) {
298	$likes[] = "CONVERT($column USING utf8) LIKE '%" . esc_sql( $term ) . "%'";
299	}
300	}
301	}
302
303	return empty( $likes )
304	? '1=0'
305	: '(' . implode( ' OR ', $likes ) . ')';
306
307	default:
308	return '1=1';
309	}
310	}
311
312	/**
313	* Check ticket condition
314	*
315	* @param array $condition - array with condition data.
316	* @param WPSC_Custom_Field $cf - custom field object.
317	* @param WPSC_Ticket $ticket - ticket object.
318	* @return boolean
319	*/
320	public static function is_valid_ticket_condition( $condition, $cf, $ticket ) {
321
322	$flag = true;
323	$value = stripslashes( $ticket->{$cf->slug} );
324	$terms = explode( PHP_EOL, $condition['operand_val_1'] );
325
326	switch ( $condition['operator'] ) {
327
328	case '=':
329	$flag = $condition['operand_val_1'] == $value ? true : false;
330	break;
331
332	case 'IN':
333	$flag = false;
334	foreach ( $terms as $term ) {
335	$term = trim( $term );
336	if ( $term == $value ) {
337	$flag = true;
338	break;
339	}
340	}
341	break;
342
343	case 'NOT IN':
344	foreach ( $terms as $term ) {
345	$term = trim( $term );
346	if ( $term == $value ) {
347	$flag = false;
348	break;
349	}
350	}
351	break;
352
353	case 'LIKE':
354	$flag = false;
355	foreach ( $terms as $term ) {
356	$index = strpos( $value, trim( stripslashes( $term ) ) );
357	if ( is_numeric( $index ) ) {
358	$flag = true;
359	break;
360	}
361	}
362	break;
363
364	default:
365	$flag = true;
366	}
367
368	return $flag;
369	}
370
371	/**
372	* Load current class to reference classes
373	*
374	* @param array $classes - Associative array of class names indexed by its slug.
375	* @return array
376	*/
377	public static function load_ref_class( $classes ) {
378
379	$classes[ self::$slug ] = array(
380	'class' => __CLASS__,
381	'save-key' => 'id',
382	);
383	return $classes;
384	}
385
386	/**
387	* Return default value for custom field of this type
388	*
389	* @param WPSC_Custom_Field $cf - custom field object.
390	* @return mixed
391	*/
392	public static function get_default_value( $cf ) {
393
394	return '';
395	}
396
397	/**
398	* Check and return custom field value for new ticket to be created.
399	* This function is used by filter for set create ticket form and called directly by my-profile for each applicable custom fields.
400	* Ignore phpcs nonce issue as we already checked where it is called from.
401	*
402	* @param array $data - Array of values to to stored in ticket in an insert function.
403	* @param array $custom_fields - Array containing all applicable custom fields indexed by unique custom field types.
404	* @param boolean $is_my_profile - Whether it or not it is created from my-profile. This function is used by create ticket as well as my-profile. Due to customer fields handling is done same way, this flag gives apportunity to identify where it being called.
405	* @return array
406	*/
407	public static function set_create_ticket_data( $data, $custom_fields, $is_my_profile ) {
408
409	$data['os'] = self::get_user_platform();
410	return $data;
411	}
412
413	/**
414	* Get operating system from user agent
415	*
416	* @return String
417	*/
418	public static function get_user_platform() {
419
420	$os_platform = '';
421
422	$user_agent = isset( $_SERVER['HTTP_USER_AGENT'] ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : '';
423
424	$os_array = array(
425	'/windows nt 10/i' => 'Windows 10',
426	'/windows nt 6.3/i' => 'Windows 8.1',
427	'/windows nt 6.2/i' => 'Windows 8',
428	'/windows nt 6.1/i' => 'Windows 7',
429	'/windows nt 6.0/i' => 'Windows Vista',
430	'/windows nt 5.2/i' => 'Windows Server 2003/XP x64',
431	'/windows nt 5.1/i' => 'Windows XP',
432	'/windows xp/i' => 'Windows XP',
433	'/windows nt 5.0/i' => 'Windows 2000',
434	'/windows me/i' => 'Windows ME',
435	'/win98/i' => 'Windows 98',
436	'/win95/i' => 'Windows 95',
437	'/win16/i' => 'Windows 3.11',
438	'/macintosh\|mac os x/i' => 'Mac OS X',
439	'/mac_powerpc/i' => 'Mac OS 9',
440	'/linux/i' => 'Linux',
441	'/ubuntu/i' => 'Ubuntu',
442	'/iphone/i' => 'iPhone',
443	'/ipod/i' => 'iPod',
444	'/ipad/i' => 'iPad',
445	'/android/i' => 'Android',
446	'/blackberry/i' => 'BlackBerry',
447	'/webos/i' => 'Mobile',
448	);
449
450	foreach ( $os_array as $regex => $value ) {
451	if ( preg_match( $regex, $user_agent ) ) {
452	$os_platform = $value;
453	break;
454	}
455	}
456
457	return $os_platform;
458	}
459
460	/**
461	* Return slug string to be used in where condition of ticket model for this type of field
462	*
463	* @param WPSC_Custom_Field $cf - custom field object.
464	* @return string
465	*/
466	public static function get_sql_slug( $cf ) {
467
468	return 't.' . $cf->slug;
469	}
470
471	/**
472	* Return val field for meta query of this type of custom field
473	*
474	* @param array $condition - condition data.
475	* @return mixed
476	*/
477	public static function get_meta_value( $condition ) {
478
479	$operator = $condition['operator'];
480	switch ( $operator ) {
481
482	case '=':
483	return $condition['operand_val_1'];
484
485	case 'IN':
486	case 'NOT IN':
487	$val = explode( PHP_EOL, $condition['operand_val_1'] );
488	$temp_val = array();
489	foreach ( $val as $value ) {
490	$value = trim( $value );
491	if ( $value ) {
492	$temp_val[] = $value;
493	}
494	}
495	return $temp_val ? $temp_val : false;
496
497	case 'LIKE':
498	return trim( $condition['operand_val_1'] );
499	}
500	return false;
501	}
502
503	/**
504	* Print edit custom field properties
505	*
506	* @param WPSC_Custom_Fields $cf - custom field object.
507	* @param string $field_class - class name of field category.
508	* @return void
509	*/
510	public static function get_edit_custom_field_properties( $cf, $field_class ) {
511
512	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) :
513	?>
514	<div data-type="number" data-required="false" class="wpsc-input-group tl_width">
515	<div class="label-container">
516	<label for="">
517	<?php esc_attr_e( 'Ticket list width (pixels)', 'supportcandy' ); ?>
518	</label>
519	</div>
520	<input type="number" name="tl_width" value="<?php echo intval( $cf->tl_width ); ?>" autocomplete="off">
521	</div>
522	<?php
523	endif;
524	}
525
526	/**
527	* Set custom field properties. Can be used by add/edit custom field.
528	* Ignore phpcs nonce issue as we already checked where it is called from.
529	*
530	* @param WPSC_Custom_Field $cf - custom field object.
531	* @param string $field_class - class of field category.
532	* @return void
533	*/
534	public static function set_cf_properties( $cf, $field_class ) {
535
536	// tl_width!
537	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) {
538	$tl_width = isset( $_POST['tl_width'] ) ? intval( $_POST['tl_width'] ) : 0; // phpcs:ignore
539	$cf->tl_width = $tl_width ? $tl_width : 100;
540	}
541
542	// save!
543	$cf->save();
544	}
545
546	/**
547	* Returns printable ticket value for custom field. Can be used in export tickets, replace macros etc.
548	*
549	* @param WPSC_Custom_Field $cf - custom field object.
550	* @param WPSC_Ticket $ticket - ticket object.
551	* @param string $module - module name.
552	* @return string
553	*/
554	public static function get_ticket_field_val( $cf, $ticket, $module = '' ) {
555
556	return $ticket->{$cf->slug};
557	}
558
559	/**
560	* Print ticket value for given custom field on ticket list
561	*
562	* @param WPSC_Custom_Field $cf - custom field object.
563	* @param WPSC_Ticket $ticket - ticket object.
564	* @return void
565	*/
566	public static function print_tl_ticket_field_val( $cf, $ticket ) {
567
568	echo esc_attr( self::get_ticket_field_val( $cf, $ticket ) );
569	}
570
571	/**
572	* Print ticket value for given custom field on widget
573	*
574	* @param WPSC_Custom_Field $cf - custom field object.
575	* @param WPSC_Ticket $ticket - ticket object.
576	* @return void
577	*/
578	public static function print_widget_ticket_field_val( $cf, $ticket ) {
579
580	$os = $ticket->{$cf->slug};
581	echo $os ? esc_attr( $os ) : esc_attr__( 'Not Applicable', 'supportcandy' );
582	}
583	}
584	endif;
585
586	WPSC_DF_OS::init();
587