<?php

[0] Fix | Delete

[1] Fix | Delete

// phpcs:ignore Generic.Commenting.DocComment.MissingShort

[2] Fix | Delete

/** @noinspection PhpIllegalPsrClassPathInspection */

[3] Fix | Delete

[4] Fix | Delete

namespace WPForms\Logger;

[5] Fix | Delete

[6] Fix | Delete

use WPForms\Helpers\DB;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class Repository.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.6.3

[12] Fix | Delete

*/

[13] Fix | Delete

class Repository {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Cache key name for total logs.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.6.3

[19] Fix | Delete

*/

[20] Fix | Delete

const CACHE_TOTAL_KEY = 'wpforms_logs_total';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Records query.

[24] Fix | Delete

*

[25] Fix | Delete

* @since 1.6.3

[26] Fix | Delete

*

[27] Fix | Delete

* @var RecordQuery

[28] Fix | Delete

*/

[29] Fix | Delete

private $records_query;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Records.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.6.3

[35] Fix | Delete

*

[36] Fix | Delete

* @var Records

[37] Fix | Delete

*/

[38] Fix | Delete

private $records;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Get a not-limited total query.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 1.6.4.1

[44] Fix | Delete

*

[45] Fix | Delete

* @var int

[46] Fix | Delete

*/

[47] Fix | Delete

private $full_total;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Log constructor.

[51] Fix | Delete

*

[52] Fix | Delete

* @since 1.6.3

[53] Fix | Delete

* @since 1.9.0 Removed the argument.

[54] Fix | Delete

*/

[55] Fix | Delete

public function __construct() {

[56] Fix | Delete

[57] Fix | Delete

$this->full_total = false;

[58] Fix | Delete

$this->records_query = new RecordQuery();

[59] Fix | Delete

$this->records = new Records();

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Get log table name.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 1.6.3

[66] Fix | Delete

*

[67] Fix | Delete

* @return string

[68] Fix | Delete

*/

[69] Fix | Delete

public static function get_table_name(): string {

[70] Fix | Delete

[71] Fix | Delete

global $wpdb;

[72] Fix | Delete

[73] Fix | Delete

return $wpdb->prefix . 'wpforms_logs';

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Create table in the database.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.6.3

[80] Fix | Delete

*/

[81] Fix | Delete

public function create_table() {

[82] Fix | Delete

[83] Fix | Delete

global $wpdb;

[84] Fix | Delete

[85] Fix | Delete

$table = self::get_table_name();

[86] Fix | Delete

[87] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/upgrade.php';

[88] Fix | Delete

[89] Fix | Delete

$charset_collate = $wpdb->get_charset_collate();

[90] Fix | Delete

[91] Fix | Delete

$sql = "CREATE TABLE $table (

[92] Fix | Delete

id BIGINT(20) NOT NULL AUTO_INCREMENT,

[93] Fix | Delete

title VARCHAR(255) NOT NULL,

[94] Fix | Delete

message LONGTEXT NOT NULL,

[95] Fix | Delete

types VARCHAR(255) NOT NULL,

[96] Fix | Delete

create_at DATETIME NOT NULL,

[97] Fix | Delete

form_id BIGINT(20),

[98] Fix | Delete

entry_id BIGINT(20),

[99] Fix | Delete

user_id BIGINT(20),

[100] Fix | Delete

PRIMARY KEY (id)

[101] Fix | Delete

) $charset_collate;";

[102] Fix | Delete

[103] Fix | Delete

dbDelta( $sql );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Create new record.

[108] Fix | Delete

*

[109] Fix | Delete

* @since 1.6.3

[110] Fix | Delete

*

[111] Fix | Delete

* @param string $title Record title.

[112] Fix | Delete

* @param string $message Record message.

[113] Fix | Delete

* @param array|string $types Array, string, or string separated by comma types.

[114] Fix | Delete

* @param int $form_id Record form ID.

[115] Fix | Delete

* @param int $entry_id Record entry ID.

[116] Fix | Delete

* @param int $user_id Record user ID.

[117] Fix | Delete

*/

[118] Fix | Delete

public function add( $title, $message, $types, $form_id, $entry_id, $user_id ) {

[119] Fix | Delete

[120] Fix | Delete

$this->records->push(

[121] Fix | Delete

Record::create( $title, $message, $types, $form_id, $entry_id, $user_id )

[122] Fix | Delete

);

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Get records.

[127] Fix | Delete

*

[128] Fix | Delete

* @since 1.6.3

[129] Fix | Delete

*

[130] Fix | Delete

* @param int $limit Query limit of records.

[131] Fix | Delete

* @param int $offset Offset of records.

[132] Fix | Delete

* @param string $search Search.

[133] Fix | Delete

* @param string $type Type of records.

[134] Fix | Delete

*

[135] Fix | Delete

* @return Records

[136] Fix | Delete

*/

[137] Fix | Delete

public function records( $limit, $offset = 0, $search = '', $type = '' ) {

[138] Fix | Delete

[139] Fix | Delete

$data = $this->records_query->get( $limit, $offset, $search, $type );

[140] Fix | Delete

$this->full_total = true;

[141] Fix | Delete

$records = new Records();

[142] Fix | Delete

[143] Fix | Delete

// As we got raw data, we need to convert to Record.

[144] Fix | Delete

foreach ( $data as $row ) {

[145] Fix | Delete

$records->push(

[146] Fix | Delete

$this->prepare_record( $row )

[147] Fix | Delete

);

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

return $records;

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Get record.

[155] Fix | Delete

*

[156] Fix | Delete

* @since 1.6.3

[157] Fix | Delete

*

[158] Fix | Delete

* @param int $id Record ID.

[159] Fix | Delete

*

[160] Fix | Delete

* @return Record|null

[161] Fix | Delete

*/

[162] Fix | Delete

public function record( $id ) {

[163] Fix | Delete

[164] Fix | Delete

global $wpdb;

[165] Fix | Delete

//phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[166] Fix | Delete

$item = $wpdb->get_row(

[167] Fix | Delete

$wpdb->prepare(

[168] Fix | Delete

'SELECT * FROM ' . self::get_table_name() . ' WHERE id = %d', //phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[169] Fix | Delete

absint( $id )

[170] Fix | Delete

)

[171] Fix | Delete

);

[172] Fix | Delete

[173] Fix | Delete

if ( $item ) {

[174] Fix | Delete

$item = $this->prepare_record( $item );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

return $item;

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Create record from DB row.

[182] Fix | Delete

*

[183] Fix | Delete

* @since 1.6.3

[184] Fix | Delete

*

[185] Fix | Delete

* @param object $row Row from DB.

[186] Fix | Delete

*

[187] Fix | Delete

* @return Record

[188] Fix | Delete

*/

[189] Fix | Delete

private function prepare_record( $row ) {

[190] Fix | Delete

[191] Fix | Delete

return new Record(

[192] Fix | Delete

absint( $row->id ),

[193] Fix | Delete

$row->title,

[194] Fix | Delete

$row->message,

[195] Fix | Delete

$row->types,

[196] Fix | Delete

$row->create_at,

[197] Fix | Delete

absint( $row->form_id ),

[198] Fix | Delete

absint( $row->entry_id ),

[199] Fix | Delete

absint( $row->user_id )

[200] Fix | Delete

);

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

* Save records to the database.

[205] Fix | Delete

*

[206] Fix | Delete

* @since 1.6.3

[207] Fix | Delete

*/

[208] Fix | Delete

public function save() {

[209] Fix | Delete

[210] Fix | Delete

global $wpdb;

[211] Fix | Delete

[212] Fix | Delete

// We can't use the empty function because it doesn't work with a Countable object.

[213] Fix | Delete

if ( ! count( $this->records ) ) {

[214] Fix | Delete

return;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

$sql = 'INSERT INTO ' . self::get_table_name() . ' ( `id`, `title`, `message`, `types`, `create_at`, `form_id`, `entry_id`, `user_id` ) VALUES ';

[218] Fix | Delete

[219] Fix | Delete

foreach ( $this->records as $record ) {

[220] Fix | Delete

$sql .= $wpdb->prepare(

[221] Fix | Delete

'( NULL, %s, %s, %s, %s, %d, %d, %d ),',

[222] Fix | Delete

$record->get_title(),

[223] Fix | Delete

$record->get_message(),

[224] Fix | Delete

implode( ',', $record->get_types() ),

[225] Fix | Delete

$record->get_date( 'sql' ),

[226] Fix | Delete

$record->get_form_id(),

[227] Fix | Delete

$record->get_entry_id(),

[228] Fix | Delete

$record->get_user_id()

[229] Fix | Delete

);

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

$sql = rtrim( $sql, ',' );

[233] Fix | Delete

[234] Fix | Delete

//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared

[235] Fix | Delete

$wpdb->query( $sql );

[236] Fix | Delete

//phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared

[237] Fix | Delete

wp_cache_delete( self::CACHE_TOTAL_KEY );

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Check if the database table exists.

[242] Fix | Delete

*

[243] Fix | Delete

* @since 1.6.4

[244] Fix | Delete

*

[245] Fix | Delete

* @return bool

[246] Fix | Delete

*/

[247] Fix | Delete

public function table_exists() {

[248] Fix | Delete

[249] Fix | Delete

return DB::table_exists( self::get_table_name() );

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Get total count of logs.

[254] Fix | Delete

*

[255] Fix | Delete

* @since 1.6.3

[256] Fix | Delete

*

[257] Fix | Delete

* @return int

[258] Fix | Delete

*/

[259] Fix | Delete

public function get_total() {

[260] Fix | Delete

[261] Fix | Delete

global $wpdb;

[262] Fix | Delete

[263] Fix | Delete

$total = wp_cache_get( self::CACHE_TOTAL_KEY );

[264] Fix | Delete

[265] Fix | Delete

if ( ! $total ) {

[266] Fix | Delete

//phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.NotPrepared

[267] Fix | Delete

$total = $this->full_total ? $wpdb->get_var( 'SELECT FOUND_ROWS()' ) : $wpdb->get_var( 'SELECT COUNT( ID ) FROM ' . self::get_table_name() );

[268] Fix | Delete

//phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.NotPrepared

[269] Fix | Delete

wp_cache_set( self::CACHE_TOTAL_KEY, $total, 'wpforms', DAY_IN_SECONDS );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

return absint( $total );

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

* Clear all records in the Database.

[277] Fix | Delete

*

[278] Fix | Delete

* @since 1.6.3

[279] Fix | Delete

*/

[280] Fix | Delete

public function clear_all() {

[281] Fix | Delete

[282] Fix | Delete

global $wpdb;

[283] Fix | Delete

[284] Fix | Delete

//phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared

[285] Fix | Delete

$wpdb->query( 'TRUNCATE TABLE ' . self::get_table_name() );

[286] Fix | Delete

}

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete