class-wc-customer-download-log-data-store.php
<?php
/**
* Class WC_Customer_Download_Log_Data_Store file.
*
* @version 3.3.0
* @package WooCommerce\Classes
*/
defined( 'ABSPATH' ) || exit;
/**
* WC_Customer_Download_Log_Data_Store class.
*/
class WC_Customer_Download_Log_Data_Store implements WC_Customer_Download_Log_Data_Store_Interface {
// Table name for download logs.
const WC_DOWNLOAD_LOG_TABLE = 'wc_download_log';
/**
* Get the table name for download logs.
*
* @return string
*/
public static function get_table_name() {
return self::WC_DOWNLOAD_LOG_TABLE;
}
/**
* Create download log entry.
*
* @param WC_Customer_Download_Log $download_log Customer download log object.
*/
public function create( WC_Customer_Download_Log &$download_log ) {
global $wpdb;
// Always set a timestamp.
if ( is_null( $download_log->get_timestamp( 'edit' ) ) ) {
$download_log->set_timestamp( time() );
}
$data = array(
'timestamp' => date( 'Y-m-d H:i:s', $download_log->get_timestamp( 'edit' )->getTimestamp() ),
'permission_id' => $download_log->get_permission_id( 'edit' ),
'user_id' => $download_log->get_user_id( 'edit' ),
'user_ip_address' => $download_log->get_user_ip_address( 'edit' ),
);
$format = array(
'%s',
'%s',
'%s',
'%s',
);
$result = $wpdb->insert(
$wpdb->prefix . self::get_table_name(),
apply_filters( 'woocommerce_downloadable_product_download_log_insert_data', $data ),
apply_filters( 'woocommerce_downloadable_product_download_log_insert_format', $format, $data )
);
do_action( 'woocommerce_downloadable_product_download_log_insert', $data );
if ( $result ) {
$download_log->set_id( $wpdb->insert_id );
$download_log->apply_changes();
} else {
wp_die( esc_html__( 'Unable to insert download log entry in database.', 'woocommerce' ) );
}
}
/**
* Method to read a download log from the database.
*
* @param WC_Customer_Download_Log $download_log Download log object.
* @throws Exception Exception when read is not possible.
*/
public function read( &$download_log ) {
global $wpdb;
$download_log->set_defaults();
// Ensure we have an id to pull from the DB.
if ( ! $download_log->get_id() ) {
throw new Exception( __( 'Invalid download log: no ID.', 'woocommerce' ) );
}
$table = $wpdb->prefix . self::get_table_name();
// Query the DB for the download log.
$raw_download_log = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$table} WHERE download_log_id = %d", $download_log->get_id() ) ); // WPCS: unprepared SQL ok.
if ( ! $raw_download_log ) {
throw new Exception( __( 'Invalid download log: not found.', 'woocommerce' ) );
}
$download_log->set_props(
array(
'timestamp' => strtotime( $raw_download_log->timestamp ),
'permission_id' => $raw_download_log->permission_id,
'user_id' => $raw_download_log->user_id,
'user_ip_address' => $raw_download_log->user_ip_address,
)
);
$download_log->set_object_read( true );
}
/**
* Method to update a download log in the database.
*
* @param WC_Customer_Download_Log $download_log Download log object.
*/
public function update( &$download_log ) {
global $wpdb;
$data = array(
'timestamp' => date( 'Y-m-d H:i:s', $download_log->get_timestamp( 'edit' )->getTimestamp() ),
'permission_id' => $download_log->get_permission_id( 'edit' ),
'user_id' => $download_log->get_user_id( 'edit' ),
'user_ip_address' => $download_log->get_user_ip_address( 'edit' ),
);
$format = array(
'%s',
'%s',
'%s',
'%s',
);
$wpdb->update(
$wpdb->prefix . self::get_table_name(),
$data,
array(
'download_log_id' => $download_log->get_id(),
),
$format
);
$download_log->apply_changes();
}
/**
* Get a download log object.
*
* @param array $data From the DB.
* @return WC_Customer_Download_Log
*/
private function get_download_log( $data ) {
return new WC_Customer_Download_Log( $data );
}
/**
* Get array of download log ids by specified args.
*
* @param array $args Arguments to define download logs to retrieve.
* @return array
*/
public function get_download_logs( $args = array() ) {
global $wpdb;
$args = wp_parse_args(
$args,
array(
'permission_id' => '',
'user_id' => '',
'user_ip_address' => '',
'orderby' => 'download_log_id',
'order' => 'ASC',
'limit' => -1,
'page' => 1,
'return' => 'objects',
)
);
$query = array();
$table = $wpdb->prefix . self::get_table_name();
$query[] = "SELECT * FROM {$table} WHERE 1=1";
if ( $args['permission_id'] ) {
$query[] = $wpdb->prepare( 'AND permission_id = %d', $args['permission_id'] );
}
if ( $args['user_id'] ) {
$query[] = $wpdb->prepare( 'AND user_id = %d', $args['user_id'] );
}
if ( $args['user_ip_address'] ) {
$query[] = $wpdb->prepare( 'AND user_ip_address = %s', $args['user_ip_address'] );
}
$allowed_orders = array( 'download_log_id', 'timestamp', 'permission_id', 'user_id' );
$orderby = in_array( $args['orderby'], $allowed_orders, true ) ? $args['orderby'] : 'download_log_id';
$order = 'DESC' === strtoupper( $args['order'] ) ? 'DESC' : 'ASC';
$orderby_sql = sanitize_sql_orderby( "{$orderby} {$order}" );
$query[] = "ORDER BY {$orderby_sql}";
if ( 0 < $args['limit'] ) {
$query[] = $wpdb->prepare( 'LIMIT %d, %d', absint( $args['limit'] ) * absint( $args['page'] - 1 ), absint( $args['limit'] ) );
}
$raw_download_logs = $wpdb->get_results( implode( ' ', $query ) ); // WPCS: unprepared SQL ok.
switch ( $args['return'] ) {
case 'ids':
return wp_list_pluck( $raw_download_logs, 'download_log_id' );
default:
return array_map( array( $this, 'get_download_log' ), $raw_download_logs );
}
}
/**
* Get download logs for a given download permission.
*
* @param int $permission_id Permission to get logs for.
* @return array
*/
public function get_download_logs_for_permission( $permission_id ) {
// If no permission_id is passed, return an empty array.
if ( empty( $permission_id ) ) {
return array();
}
return $this->get_download_logs(
array(
'permission_id' => $permission_id,
)
);
}
/**
* Method to delete download logs for a given permission ID.
*
* @since 3.4.0
* @param int $id download_id of the downloads that will be deleted.
*/
public function delete_by_permission_id( $id ) {
global $wpdb;
$wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->prefix}woocommerce_downloadable_product_permissions WHERE permission_id = %d", $id ) );
// Delete related records in wc_download_log (aka ON DELETE CASCADE).
$wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->prefix}wc_download_log WHERE permission_id = %d", $id ) );
}
}
