summaryrefslogtreecommitdiff
path: root/Postman/Postman-Email-Log/PostmanEmailLogView.php
blob: 52cdd4defa010d36ce5b03b6e9d501be94e95eb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
<?php
if ( ! defined( 'ABSPATH' ) ) {
    exit; // Exit if accessed directly
}
require_once dirname(__DIR__) . '/PostmanLogFields.php';

/**
 * See http://wpengineer.com/2426/wp_list_table-a-step-by-step-guide/
 */
if ( ! class_exists( 'WP_List_Table' ) ) {
	require_once( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
}
class PostmanEmailLogView extends WP_List_Table {
	private $logger;

	/**
	 * ************************************************************************
	 * REQUIRED.
	 * Set up a constructor that references the parent constructor. We
	 * use the parent reference to set some default configs.
	 * *************************************************************************
	 */
	function __construct() {
		$this->logger = new PostmanLogger( get_class( $this ) );

		// Set parent defaults
		parent::__construct( array(
				'singular' => 'email_log_entry', // singular name of the listed records
				'plural' => 'email_log_entries', // plural name of the listed records
				'ajax' => false,
		) ); // does this table support ajax?
	}

	/**
	 * ************************************************************************
	 * Recommended.
	 * This method is called when the parent class can't find a method
	 * specifically build for a given column. Generally, it's recommended to include
	 * one method for each column you want to render, keeping your package class
	 * neat and organized. For example, if the class needs to process a column
	 * named 'title', it would first see if a method named $this->column_title()
	 * exists - if it does, that method will be used. If it doesn't, this one will
	 * be used. Generally, you should try to use custom column methods as much as
	 * possible.
	 *
	 * Since we have defined a column_title() method later on, this method doesn't
	 * need to concern itself with any column with a name of 'title'. Instead, it
	 * needs to handle everything else.
	 *
	 * For more detailed insight into how columns are handled, take a look at
	 * WP_List_Table::single_row_columns()
	 *
	 * @param array $item
	 *        	A singular item (one full row's worth of data)
	 * @param array $column_name
	 *        	The name/slug of the column to be processed
	 * @return string Text or HTML to be placed inside the column <td>
	 *         ************************************************************************
	 */
	function column_default( $item, $column_name ) {
		switch ( $column_name ) {
			case 'sent_to' :
			case 'date' :
			case 'status' :
				return $item [ $column_name ];
			default :
				return print_r( $item, true ); // Show the whole array for troubleshooting purposes
		}
	}

	/**
	 * ************************************************************************
	 * Recommended.
	 * This is a custom column method and is responsible for what
	 * is rendered in any column with a name/slug of 'title'. Every time the class
	 * needs to render a column, it first looks for a method named
	 * column_{$column_title} - if it exists, that method is run. If it doesn't
	 * exist, column_default() is called instead.
	 *
	 * This example also illustrates how to implement rollover actions. Actions
	 * should be an associative array formatted as 'slug'=>'link html' - and you
	 * will need to generate the URLs yourself. You could even ensure the links
	 *
	 * @see WP_List_Table::::single_row_columns()
	 * @param array $item
	 *        	A singular item (one full row's worth of data)
	 * @return string Text to be placed inside the column <td> (movie title only)
	 *         ************************************************************************
	 */
	function column_title( $item ) {

		// Build row actions
		$iframeUri = 'admin-post.php?page=postman_email_log&action=%s&email=%s&TB_iframe=true&width=700&height=550';
		$deleteUrl = wp_nonce_url( admin_url( sprintf( 'admin-post.php?page=postman_email_log&action=%s&email=%s', 'delete', $item ['ID'] ) ), 'delete_email_log_item_' . $item ['ID'] );
		$viewUrl = admin_url( sprintf( $iframeUri, 'view', $item ['ID'] ) );
		$transcriptUrl = admin_url( sprintf( $iframeUri, 'transcript', $item ['ID'] ) );
		$resendUrl = admin_url( sprintf( $iframeUri, 'resend', $item ['ID'] ) );

		$meta_values = PostmanLogFields::get_instance()->get( $item ['ID'] );

		$actions = array(
				'delete' => sprintf( '<a href="%s">%s</a>', $deleteUrl, _x( 'Delete', 'Delete an item from the email log', 'post-smtp' ) ),
				'view' => sprintf( '<a href="%s" class="thickbox">%s</a>', $viewUrl, _x( 'View', 'View an item from the email log', 'post-smtp' ) ),
		);

		if ( ! empty( $meta_values ['session_transcript'] [0] ) ) {
			$actions ['transcript'] = sprintf( '<a href="%1$s" class="thickbox">%2$s</a>', $transcriptUrl, __( 'Session Transcript', 'post-smtp' ) );
		} else {
			$actions ['transcript'] = sprintf( '%2$s', $transcriptUrl, __( 'Session Transcript', 'post-smtp' ) );
		}
		if ( ! (empty( $meta_values ['original_to'] [0] ) && empty( $meta_values ['originalHeaders'] [0] )) ) {
			// $actions ['resend'] = sprintf ( '<a href="%s">%s</a>', $resendUrl, __ ( 'Resend', 'post-smtp' ) );
			$emails = $meta_values ['original_to'] [0];
            $to = is_array( $emails ) ? implode( ',', array_walk($emails, 'sanitize_email') ) : sanitize_email( $emails );

            $actions ['resend'] = sprintf( '<span id="%3$s"><a class="postman-open-resend" href="#">%2$s</a></span><div style="display:none;"><input type="hidden" name="security" value="%6$s"><input type="text" name="mail_to" class="regular-text ltr" data-id="%1$s" value="%4$s"><button class="postman-resend button button-primary">%2$s</button><i style="color: black;">%5$s</i></div>', $item ['ID'], __( 'Resend', 'post-smtp' ), 'resend-' . $item ['ID'], esc_attr( $to ), __( 'comma-separated for multiple emails', 'post-smtp' ), wp_create_nonce( 'resend' ) );
		} else {
			$actions ['resend'] = sprintf( '%2$s', $resendUrl, __( 'Resend', 'post-smtp' ) );
		}

		// Return the title contents
		return sprintf( '%1$s %3$s',
			/*$1%s*/ $item ['title'],
			/*$2%s*/ $item ['ID'],
		/*$3%s*/ $this->row_actions( $actions ) );
	}

	/**
	 * ************************************************************************
	 * REQUIRED if displaying checkboxes or using bulk actions! The 'cb' column
	 * is given special treatment when columns are processed.
	 * It ALWAYS needs to
	 * have it's own method.
	 *
	 * @see WP_List_Table::::single_row_columns()
	 * @param array $item
	 *        	A singular item (one full row's worth of data)
	 * @return string Text to be placed inside the column <td> (movie title only)
	 *         ************************************************************************
	 */
	function column_cb( $item ) {
		return sprintf( '<input type="checkbox" name="%1$s[]" value="%2$s" />',
			/*$1%s*/ $this->_args ['singular'], // Let's simply repurpose the table's singular label ("movie")
			/* $2%s */
		$item ['ID'] ); // The value of the checkbox should be the record's id
	}

	/**
	 * ************************************************************************
	 * REQUIRED! This method dictates the table's columns and titles.
	 * This should
	 * return an array where the key is the column slug (and class) and the value
	 * is the column's title text. If you need a checkbox for bulk actions, refer
	 * to the $columns array below.
	 *
	 * The 'cb' column is treated differently than the rest. If including a checkbox
	 * column in your table you must create a column_cb() method. If you don't need
	 * bulk actions or checkboxes, simply leave the 'cb' entry out of your array.
	 *
	 * @see WP_List_Table::::single_row_columns()
	 * @return array An associative array containing column information: 'slugs'=>'Visible Titles'
	 *         ************************************************************************
	 */
	function get_columns() {
		$columns = array(
				'cb' => '<input type="checkbox" />', // Render a checkbox instead of text
				'title' => _x( 'Subject', 'What is the subject of this message?', 'post-smtp' ),
				'sent_to' => __( 'Sent To', 'post-smtp' ),
				'status' => __( 'Status', 'post-smtp' ),
				'date' => _x( 'Delivery Time', 'When was this email sent?', 'post-smtp' ),
		);
		return $columns;
	}

	/**
	 * ************************************************************************
	 * Optional.
	 * If you want one or more columns to be sortable (ASC/DESC toggle),
	 * you will need to register it here. This should return an array where the
	 * key is the column that needs to be sortable, and the value is db column to
	 * sort by. Often, the key and value will be the same, but this is not always
	 * the case (as the value is a column name from the database, not the list table).
	 *
	 * This method merely defines which columns should be sortable and makes them
	 * clickable - it does not handle the actual sorting. You still need to detect
	 * the ORDERBY and ORDER querystring variables within prepare_items() and sort
	 * your data accordingly (usually by modifying your query).
	 *
	 * @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values',bool)
	 *         ************************************************************************
	 */
	function get_sortable_columns() {
		return array();
		$sortable_columns = array(
				'title' => array(
						'title',
						false,
				), // true means it's already sorted
				'status' => array(
						'status',
						false,
				),
				'date' => array(
						'date',
						false,
				),
		);
		return $sortable_columns;
	}

	/**
	 * ************************************************************************
	 * Optional.
	 * If you need to include bulk actions in your list table, this is
	 * the place to define them. Bulk actions are an associative array in the format
	 * 'slug'=>'Visible Title'
	 *
	 * If this method returns an empty value, no bulk action will be rendered. If
	 * you specify any bulk actions, the bulk actions box will be rendered with
	 * the table automatically on display().
	 *
	 * Also note that list tables are not automatically wrapped in <form> elements,
	 * so you will need to create those manually in order for bulk actions to function.
	 *
	 * @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles'
	 *         ************************************************************************
	 */
	function get_bulk_actions() {
		$actions = array(
				'bulk_delete' => _x( 'Delete', 'Delete an item from the email log', 'post-smtp' ),
		);
		return $actions;
	}

	/**
	 * ************************************************************************
	 * Optional.
	 * You can handle your bulk actions anywhere or anyhow you prefer.
	 * For this example package, we will handle it in the class to keep things
	 * clean and organized.
	 *
	 * @see $this->prepare_items() ************************************************************************
	 */
	function process_bulk_action() {
	}

	/**
	 * ************************************************************************
	 * REQUIRED! This is where you prepare your data for display.
	 * This method will
	 * usually be used to query the database, sort and filter the data, and generally
	 * get it ready to be displayed. At a minimum, we should set $this->items and
	 * $this->set_pagination_args(), although the following properties and methods
	 * are frequently interacted with here...
	 *
	 * @global WPDB $wpdb
	 * @uses $this->_column_headers
	 * @uses $this->items
	 * @uses $this->get_columns()
	 * @uses $this->get_sortable_columns()
	 * @uses $this->get_pagenum()
	 * @uses $this->set_pagination_args()
	 *       ************************************************************************
	 */
	function prepare_items() {
        if ( ! empty( $_POST ) && ! wp_verify_nonce( $_REQUEST['post-smtp-log'], 'post-smtp' ) )
            die( 'Security check' );

            /**
		 * First, lets decide how many records per page to show
		 */
		$per_page = isset( $_POST['postman_page_records'] ) ? absint( $_POST['postman_page_records'] ) : 10;

		/**
		 * REQUIRED.
		 * Now we need to define our column headers. This includes a complete
		 * array of columns to be displayed (slugs & titles), a list of columns
		 * to keep hidden, and a list of columns that are sortable. Each of these
		 * can be defined in another method (as we've done here) before being
		 * used to build the value for our _column_headers property.
		 */
		$columns = $this->get_columns();
		$hidden = array();
		$sortable = $this->get_sortable_columns();

		/**
		 * REQUIRED.
		 * Finally, we build an array to be used by the class for column
		 * headers. The $this->_column_headers property takes an array which contains
		 * 3 other arrays. One for all columns, one for hidden columns, and one
		 * for sortable columns.
		 */
		$this->_column_headers = array(
				$columns,
				$hidden,
				$sortable,
		);

		/**
		 * Optional.
		 * You can handle your bulk actions however you see fit. In this
		 * case, we'll handle them within our package just to keep things clean.
		 */
		$this->process_bulk_action();

		/**
		 * Instead of querying a database, we're going to fetch the example data
		 * property we created for use in this plugin.
		 * This makes this example
		 * package slightly different than one you might build on your own. In
		 * this example, we'll be using array manipulation to sort and paginate
		 * our data. In a real-world implementation, you will probably want to
		 * use sort and pagination data to build a custom query instead, as you'll
		 * be able to use your precisely-queried data immediately.
		 */
		$data = array();

		$args = array(
				'posts_per_page' => -1,
				'orderby' => 'date',
				'order' => 'DESC',
				'post_type' => PostmanEmailLogPostType::POSTMAN_CUSTOM_POST_TYPE_SLUG,
				'post_status' => 'private',
				'suppress_filters' => true,
		);

		if ( isset( $_POST['from_date'] ) && ! empty( $_POST['from_date'] ) ) {
			$from_date = sanitize_text_field( $_POST['from_date'] );

		    $args['date_query']['after'] = $from_date;
		    $args['date_query']['column']  = 'post_date';
		    $args['date_query']['inclusive'] = false;
		}

		if ( isset( $_POST['to_date'] ) && ! empty( $_POST['to_date'] ) ) {
			$to_date = sanitize_text_field( $_POST['to_date'] );

		    $args['date_query']['before'] = $to_date;
			$args['date_query']['column']  = 'post_date';
		    $args['date_query']['inclusive'] = true;
		}

		if ( ! empty( $_POST['search'] ) ) {

			if ( isset( $args['date_query'] ) ) {
				unset( $args['date_query'] ); }

			$args['s'] = sanitize_text_field( $_POST['search'] );
		}

		if ( isset( $_POST['postman_trash_all'] ) ) {
			$args['posts_per_page'] = -1;
		}
		$posts = new WP_query( $args );

		if ( isset( $_POST['postman_trash_all'] ) ) {
			foreach ( $posts->posts as $post ) {
				wp_delete_post( $post->ID, true );
			}

			$posts->posts = array();
		}

		$date_format = get_option( 'date_format' );
		$time_format = get_option( 'time_format' );

		foreach ( $posts->posts as $post ) {
			$date = $post->post_date;
			$humanTime = human_time_diff( strtotime( $post->post_date_gmt ) );
			// if this PHP system support humanTime, than use it
			if ( ! empty( $humanTime ) ) {
				/* Translators: where %s indicates the relative time from now */
				$date = sprintf( _x( '%s ago', 'A relative time as in "five days ago"', 'post-smtp' ), $humanTime );
			}
			$meta_values = PostmanLogFields::get_instance()->get( $post->ID );
			$sent_to = array_map( 'esc_html', explode( ',' , $meta_values ['to_header'] [0] ) );
			$flattenedPost = array(
					// the post title must be escaped as they are displayed in the HTML output
					'sent_to' => implode( ', ', $sent_to ),
					'title' => esc_html( $post->post_title ),
					// the post status must be escaped as they are displayed in the HTML output
					'status' => ($post->post_excerpt != null ? esc_html( $post->post_excerpt ) : __( 'Sent', 'post-smtp' )),
					'date' => date( "$date_format $time_format", strtotime( $post->post_date ) ),
					'ID' => $post->ID,
			);
			array_push( $data, $flattenedPost );
		}

		/**
		 * This checks for sorting input and sorts the data in our array accordingly.
		 *
		 * In a real-world situation involving a database, you would probably want
		 * to handle sorting by passing the 'orderby' and 'order' values directly
		 * to a custom query. The returned data will be pre-sorted, and this array
		 * sorting technique would be unnecessary.
		 */
		function usort_reorder( $a, $b ) {
			$orderby = ( ! empty( $_REQUEST ['orderby'] )) ? sanitize_text_field($_REQUEST ['orderby']) : 'title'; // If no sort, default to title
			$order = ( ! empty( $_REQUEST ['order'] )) ? sanitize_text_field($_REQUEST ['order']) : 'asc'; // If no order, default to asc
			$result = strcmp( $a [ $orderby ], $b [ $orderby ] ); // Determine sort order
			return ($order === 'asc') ? $result : - $result; // Send final sort direction to usort
		}
		// usort($data, 'usort_reorder');
		/**
		 * *********************************************************************
		 * ---------------------------------------------------------------------
		 * vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
		 *
		 * In a real-world situation, this is where you would place your query.
		 *
		 * For information on making queries in WordPress, see this Codex entry:
		 * http://codex.wordpress.org/Class_Reference/wpdb
		 *
		 * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
		 * ---------------------------------------------------------------------
		 * ********************************************************************
		 */

		/**
		 * REQUIRED for pagination.
		 * Let's figure out what page the user is currently
		 * looking at. We'll need this later, so you should always include it in
		 * your own package classes.
		 */
		$current_page = $this->get_pagenum();

		/**
		 * REQUIRED for pagination.
		 * Let's check how many items are in our data array.
		 * In real-world use, this would be the total number of items in your database,
		 * without filtering. We'll need this later, so you should always include it
		 * in your own package classes.
		 */
		$total_items = count( $data );

		/**
		 * The WP_List_Table class does not handle pagination for us, so we need
		 * to ensure that the data is trimmed to only the current page.
		 * We can use
		 * array_slice() to
		 */
		$data = array_slice( $data, (($current_page - 1) * $per_page), $per_page );

		/**
		 * REQUIRED.
		 * Now we can add our *sorted* data to the items property, where
		 * it can be used by the rest of the class.
		 */
		$this->items = $data;

		/**
		 * REQUIRED.
		 * We also have to register our pagination options & calculations.
		 */
		$this->set_pagination_args( array(
				'total_items' => $total_items, // WE have to calculate the total number of items
				'per_page' => $per_page, // WE have to determine how many items to show on a page
				'total_pages' => ceil( $total_items / $per_page ),
		) ); // WE have to calculate the total number of pages
	}
}