455 lines
18 KiB
PHP
455 lines
18 KiB
PHP
<?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 'solution' :
|
|
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 ) ? explode( ',', $emails ) : $emails;
|
|
$to = array_map( 'sanitize_email', $to );
|
|
$to = implode( ',', $to );
|
|
|
|
$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' ),
|
|
'solution' => __( 'Solution', '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 ( ! current_user_can( Postman::MANAGE_POSTMAN_CAPABILITY_LOGS ) ) {
|
|
wp_die( sprintf( 'You need to add to this user the %s capability. You can try disable and enable the plugin or you can do it with a plugin like `user role editor`.', Postman::MANAGE_POSTMAN_CAPABILITY_LOGS ) );
|
|
}
|
|
|
|
/**
|
|
* First, lets decide how many records per page to show
|
|
*/
|
|
$per_page = isset( $_GET['postman_page_records'] ) ? absint( $_GET['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( $_GET['from_date'] ) && ! empty( $_GET['from_date'] ) ) {
|
|
$from_date = sanitize_text_field( $_GET['from_date'] );
|
|
|
|
$args['date_query']['after'] = $from_date;
|
|
$args['date_query']['column'] = 'post_date';
|
|
$args['date_query']['inclusive'] = false;
|
|
}
|
|
|
|
if ( isset( $_GET['to_date'] ) && ! empty( $_GET['to_date'] ) ) {
|
|
$to_date = sanitize_text_field( $_GET['to_date'] );
|
|
|
|
$args['date_query']['before'] = $to_date;
|
|
$args['date_query']['column'] = 'post_date';
|
|
$args['date_query']['inclusive'] = true;
|
|
}
|
|
|
|
if ( ! empty( $_GET['search'] ) ) {
|
|
|
|
if ( isset( $args['date_query'] ) ) {
|
|
unset( $args['date_query'] ); }
|
|
|
|
$args['s'] = sanitize_text_field( $_GET['search'] );
|
|
}
|
|
|
|
if ( isset( $_GET['postman_trash_all'] ) ) {
|
|
$args['posts_per_page'] = -1;
|
|
}
|
|
$posts = new WP_query( $args );
|
|
|
|
$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] ) );
|
|
$solution_meta = $meta_values ['solution'] [0];
|
|
|
|
if ( empty( $solution_meta ) && empty( $post->post_excerpt ) ) {
|
|
$solution = 'No need - Mail sent';
|
|
} else {
|
|
$solution = $solution_meta;
|
|
}
|
|
|
|
$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 ),
|
|
'solution' => $solution,
|
|
// 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 );
|
|
}
|
|
|
|
/**
|
|
* *********************************************************************
|
|
* ---------------------------------------------------------------------
|
|
* 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
|
|
}
|
|
}
|
|
|