| @@ -1,84 +1,48 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * Manage DB connections using a provided DB driver. | |
| 4 | + * | |
| 5 | + * @package WP_Stream | |
| 6 | + */ | |
| 7 | + | |
| 2 | 8 | namespace WP_Stream; |
| 3 | 9 | |
| 10 | +/** | |
| 11 | + * Class - DB | |
| 12 | + */ | |
| 4 | 13 | class DB { |
| 5 | 14 | /** |
| 6 | - * Hold Plugin class | |
| 7 | - * @var Plugin | |
| 8 | - */ | |
| 9 | - public $plugin; | |
| 10 | - | |
| 11 | - /** | |
| 12 | - * Hold Query class | |
| 13 | - * @var Query | |
| 14 | - */ | |
| 15 | - public $query; | |
| 16 | - | |
| 17 | - /** | |
| 18 | - * Hold records table name | |
| 15 | + * Holds the driver instance | |
| 19 | 16 | * |
| 20 | - * @var string | |
| 17 | + * @var DB_Driver | |
| 21 | 18 | */ |
| 22 | - public $table; | |
| 19 | + public $driver; | |
| 23 | 20 | |
| 24 | 21 | /** |
| 25 | - * Hold meta table name | |
| 22 | + * Number of records in last request | |
| 26 | 23 | * |
| 27 | - * @var string | |
| 24 | + * @var int | |
| 28 | 25 | */ |
| 29 | - public $table_meta; | |
| 26 | + protected $found_records_count = 0; | |
| 30 | 27 | |
| 31 | 28 | /** |
| 32 | 29 | * Class constructor. |
| 33 | 30 | * |
| 34 | - * @param Plugin $plugin The main Plugin class. | |
| 31 | + * @param DB_Driver $driver Driver we want to use. | |
| 35 | 32 | */ |
| 36 | - public function __construct( $plugin ) { | |
| 37 | - $this->plugin = $plugin; | |
| 38 | - $this->query = new Query( $this ); | |
| 39 | - | |
| 40 | - global $wpdb; | |
| 41 | - | |
| 42 | - /** | |
| 43 | - * Allows devs to alter the tables prefix, default to base_prefix | |
| 44 | - * | |
| 45 | - * @param string $prefix | |
| 46 | - * | |
| 47 | - * @return string | |
| 48 | - */ | |
| 49 | - $prefix = apply_filters( 'wp_stream_db_tables_prefix', $wpdb->base_prefix ); | |
| 50 | - | |
| 51 | - $this->table = $prefix . 'stream'; | |
| 52 | - $this->table_meta = $prefix . 'stream_meta'; | |
| 53 | - | |
| 54 | - $wpdb->stream = $this->table; | |
| 55 | - $wpdb->streammeta = $this->table_meta; | |
| 56 | - | |
| 57 | - // Hack for get_metadata | |
| 58 | - $wpdb->recordmeta = $this->table_meta; | |
| 33 | + public function __construct( $driver ) { | |
| 34 | + $this->driver = $driver; | |
| 59 | 35 | } |
| 60 | 36 | |
| 61 | 37 | /** |
| 62 | - * Public getter to return table names | |
| 63 | - * | |
| 64 | - * @return array | |
| 65 | - */ | |
| 66 | - public function get_table_names() { | |
| 67 | - return array( | |
| 68 | - $this->table, | |
| 69 | - $this->table_meta, | |
| 70 | - ); | |
| 71 | - } | |
| 72 | - | |
| 73 | - /** | |
| 74 | 38 | * Insert a record |
| 75 | 39 | * |
| 76 | - * @param array $recordarr | |
| 40 | + * @param array $record New record. | |
| 77 | 41 | * |
| 78 | 42 | * @return int |
| 79 | 43 | */ |
| 80 | - public function insert( $recordarr ) { | |
| 44 | + public function insert( $record ) { | |
| 81 | 45 | if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) { |
| 82 | 46 | return false; |
| 83 | 47 | } |
| 84 | 48 | |
| @@ -84,84 +48,85 @@ | ||
| 84 | 48 | |
| 85 | 49 | /** |
| 86 | 50 | * Filter allows modification of record information |
| 87 | 51 | * |
| 88 | - * @param array $recordarr | |
| 52 | + * @param array $record | |
| 89 | 53 | * |
| 90 | 54 | * @return array |
| 91 | 55 | */ |
| 92 | - $recordarr = apply_filters( 'wp_stream_record_array', $recordarr ); | |
| 56 | + $record = apply_filters( 'wp_stream_record_array', $record ); | |
| 93 | 57 | |
| 94 | - if ( empty( $recordarr ) ) { | |
| 58 | + $data = $this->sanitize_record( $record ); | |
| 59 | + if ( empty( $data ) ) { | |
| 95 | 60 | return false; |
| 96 | 61 | } |
| 97 | 62 | |
| 98 | - global $wpdb; | |
| 63 | + $record_id = $this->driver->insert_record( $data ); | |
| 99 | 64 | |
| 100 | - $fields = array( 'object_id', 'site_id', 'blog_id', 'user_id', 'user_role', 'created', 'summary', 'ip', 'connector', 'context', 'action' ); | |
| 101 | - $data = array_intersect_key( $recordarr, array_flip( $fields ) ); | |
| 102 | - $data = array_filter( $data ); | |
| 103 | - $result = $wpdb->insert( $this->table, $data ); | |
| 104 | - | |
| 105 | - if ( 1 !== $result ) { | |
| 65 | + if ( ! $record_id ) { | |
| 106 | 66 | /** |
| 107 | 67 | * Fires on a record insertion error |
| 108 | 68 | * |
| 109 | - * @param array $recordarr | |
| 69 | + * @param array $record | |
| 110 | 70 | * @param mixed $result |
| 111 | 71 | */ |
| 112 | - do_action( 'wp_stream_record_insert_error', $recordarr, $result ); | |
| 72 | + do_action( 'wp_stream_record_insert_error', $record, false ); | |
| 113 | 73 | |
| 114 | - return $result; | |
| 74 | + return false; | |
| 115 | 75 | } |
| 116 | 76 | |
| 117 | - $record_id = $wpdb->insert_id; | |
| 118 | - | |
| 119 | - // Insert record meta | |
| 120 | - foreach ( (array) $recordarr['meta'] as $key => $vals ) { | |
| 121 | - // If associative array, serialize it, otherwise loop on its members | |
| 122 | - $vals = ( is_array( $vals ) && 0 !== key( $vals ) ) ? array( $vals ) : $vals; | |
| 123 | - | |
| 124 | - foreach ( (array) $vals as $val ) { | |
| 125 | - $val = maybe_serialize( $val ); | |
| 126 | - | |
| 127 | - $this->insert_meta( $record_id, $key, $val ); | |
| 128 | - } | |
| 129 | - } | |
| 130 | - | |
| 131 | 77 | /** |
| 132 | 78 | * Fires after a record has been inserted |
| 133 | 79 | * |
| 134 | 80 | * @param int $record_id |
| 135 | - * @param array $recordarr | |
| 81 | + * @param array $record | |
| 136 | 82 | */ |
| 137 | - do_action( 'wp_stream_record_inserted', $record_id, $recordarr ); | |
| 83 | + do_action( 'wp_stream_record_inserted', $record_id, $record ); | |
| 138 | 84 | |
| 139 | 85 | return absint( $record_id ); |
| 140 | 86 | } |
| 141 | 87 | |
| 142 | 88 | /** |
| 143 | - * Insert record meta | |
| 89 | + * Ensure the record matches our schema. | |
| 144 | 90 | * |
| 145 | - * @param int $record_id | |
| 146 | - * @param string $key | |
| 147 | - * @param string $val | |
| 91 | + * @param array $record Record to store. | |
| 148 | 92 | * |
| 149 | 93 | * @return array |
| 150 | 94 | */ |
| 151 | - public function insert_meta( $record_id, $key, $val ) { | |
| 152 | - global $wpdb; | |
| 95 | + protected function sanitize_record( $record ) { | |
| 96 | + if ( ! is_array( $record ) ) { | |
| 97 | + return array(); | |
| 98 | + } | |
| 153 | 99 | |
| 154 | - $result = $wpdb->insert( | |
| 155 | - $this->table_meta, | |
| 156 | - array( | |
| 157 | - 'record_id' => $record_id, | |
| 158 | - 'meta_key' => $key, | |
| 159 | - 'meta_value' => $val, | |
| 160 | - ) | |
| 100 | + $record_defaults = array( | |
| 101 | + 'object_id' => null, | |
| 102 | + 'site_id' => null, | |
| 103 | + 'blog_id' => null, | |
| 104 | + 'user_id' => null, | |
| 105 | + 'user_role' => null, | |
| 106 | + 'created' => null, | |
| 107 | + 'summary' => null, | |
| 108 | + 'ip' => null, | |
| 109 | + 'connector' => null, | |
| 110 | + 'context' => null, | |
| 111 | + 'action' => null, | |
| 112 | + 'meta' => array(), | |
| 161 | 113 | ); |
| 162 | 114 | |
| 163 | - return $result; | |
| 115 | + // Records can have only these fields. | |
| 116 | + $record = array_intersect_key( $record, $record_defaults ); | |
| 117 | + | |
| 118 | + // Sanitize all record values. | |
| 119 | + return array_map( | |
| 120 | + function( $value ) { | |
| 121 | + if ( ! is_array( $value ) ) { | |
| 122 | + return wp_strip_all_tags( $value ); | |
| 123 | + } | |
| 124 | + | |
| 125 | + return $value; | |
| 126 | + }, | |
| 127 | + $record | |
| 128 | + ); | |
| 164 | 129 | } |
| 165 | 130 | |
| 166 | 131 | /** |
| 167 | 132 | * Returns array of existing values for requested column. |
| @@ -166,22 +131,26 @@ | ||
| 166 | 131 | /** |
| 167 | 132 | * Returns array of existing values for requested column. |
| 168 | 133 | * Used to fill search filters with only used items, instead of all items. |
| 169 | 134 | * |
| 170 | - * GROUP BY allows query to find just the first occurance of each value in the column, | |
| 135 | + * GROUP BY allows query to find just the first occurrence of each value in the column, | |
| 171 | 136 | * increasing the efficiency of the query. |
| 172 | 137 | * |
| 173 | 138 | * @see assemble_records |
| 174 | 139 | * @since 1.0.4 |
| 175 | 140 | * |
| 176 | - * @param string $column | |
| 141 | + * @param string $column Table column to pull data from. | |
| 177 | 142 | * |
| 178 | 143 | * @return array |
| 179 | 144 | */ |
| 180 | - function existing_records( $column ) { | |
| 181 | - global $wpdb; | |
| 145 | + public function existing_records( $column ) { | |
| 146 | + // Sanitize column. | |
| 147 | + $allowed_columns = array( 'ID', 'site_id', 'blog_id', 'object_id', 'user_id', 'user_role', 'created', 'summary', 'connector', 'context', 'action', 'ip' ); | |
| 148 | + if ( ! in_array( $column, $allowed_columns, true ) ) { | |
| 149 | + return array(); | |
| 150 | + } | |
| 182 | 151 | |
| 183 | - $rows = $wpdb->get_results( "SELECT {$column} FROM $wpdb->stream GROUP BY {$column}", 'ARRAY_A' ); | |
| 152 | + $rows = $this->driver->get_column_values( $column ); | |
| 184 | 153 | |
| 185 | 154 | if ( is_array( $rows ) && ! empty( $rows ) ) { |
| 186 | 155 | $output_array = array(); |
| 187 | 156 | |
| @@ -195,7 +164,115 @@ | ||
| 195 | 164 | } |
| 196 | 165 | |
| 197 | 166 | $column = sprintf( 'stream_%s', $column ); |
| 198 | 167 | |
| 199 | - return isset( $this->plugin->connectors->term_labels[ $column ] ) ? $this->plugin->connectors->term_labels[ $column ] : array(); | |
| 168 | + $term_labels = wp_stream_get_instance()->connectors->term_labels; | |
| 169 | + return isset( $term_labels[ $column ] ) ? $term_labels[ $column ] : array(); | |
| 170 | + } | |
| 171 | + | |
| 172 | + /** | |
| 173 | + * Get stream records | |
| 174 | + * | |
| 175 | + * @param array $args Arguments to filter result by. | |
| 176 | + * | |
| 177 | + * @return array Stream Records | |
| 178 | + */ | |
| 179 | + public function get_records( $args ) { | |
| 180 | + $defaults = array( | |
| 181 | + // Search param. | |
| 182 | + 'search' => null, | |
| 183 | + 'search_field' => 'summary', | |
| 184 | + 'record_after' => null, // Deprecated, use date_after instead | |
| 185 | + // Date-based filters. | |
| 186 | + 'date' => null, // Ex: 2015-07-01. | |
| 187 | + 'date_from' => null, // Ex: 2015-07-01. | |
| 188 | + 'date_to' => null, // Ex: 2015-07-01. | |
| 189 | + 'date_after' => null, // Ex: 2015-07-01T15:19:21+00:00. | |
| 190 | + 'date_before' => null, // Ex: 2015-07-01T15:19:21+00:00. | |
| 191 | + // Record ID filters. | |
| 192 | + 'record' => null, | |
| 193 | + 'record__in' => array(), | |
| 194 | + 'record__not_in' => array(), | |
| 195 | + // Pagination params. | |
| 196 | + 'records_per_page' => get_option( 'posts_per_page', 20 ), | |
| 197 | + 'paged' => 1, | |
| 198 | + // Order. | |
| 199 | + 'order' => 'desc', | |
| 200 | + 'orderby' => 'date', | |
| 201 | + // Fields selection. | |
| 202 | + 'fields' => array(), | |
| 203 | + ); | |
| 204 | + | |
| 205 | + // Additional property fields. | |
| 206 | + $properties = array( | |
| 207 | + 'user_id' => null, | |
| 208 | + 'user_role' => null, | |
| 209 | + 'ip' => null, | |
| 210 | + 'object_id' => null, | |
| 211 | + 'site_id' => null, | |
| 212 | + 'blog_id' => null, | |
| 213 | + 'connector' => null, | |
| 214 | + 'context' => null, | |
| 215 | + 'action' => null, | |
| 216 | + ); | |
| 217 | + | |
| 218 | + /** | |
| 219 | + * Filter allows additional query properties to be added | |
| 220 | + * | |
| 221 | + * @return array Array of query properties | |
| 222 | + */ | |
| 223 | + $properties = apply_filters( 'wp_stream_query_properties', $properties ); | |
| 224 | + | |
| 225 | + // Add property fields to defaults, including their __in/__not_in variations. | |
| 226 | + foreach ( $properties as $property => $default ) { | |
| 227 | + if ( ! isset( $defaults[ $property ] ) ) { | |
| 228 | + $defaults[ $property ] = $default; | |
| 229 | + } | |
| 230 | + | |
| 231 | + $defaults[ "{$property}__in" ] = array(); | |
| 232 | + $defaults[ "{$property}__not_in" ] = array(); | |
| 233 | + } | |
| 234 | + | |
| 235 | + $args = wp_parse_args( $args, $defaults ); | |
| 236 | + | |
| 237 | + /** | |
| 238 | + * Filter allows additional arguments to query $args | |
| 239 | + * | |
| 240 | + * @return array Array of query arguments | |
| 241 | + */ | |
| 242 | + $args = apply_filters( 'wp_stream_query_args', $args ); | |
| 243 | + | |
| 244 | + $result = (array) $this->driver->get_records( $args ); | |
| 245 | + $this->found_records_count = isset( $result['count'] ) ? $result['count'] : 0; | |
| 246 | + | |
| 247 | + return empty( $result['items'] ) ? array() : $result['items']; | |
| 248 | + } | |
| 249 | + | |
| 250 | + /** | |
| 251 | + * Helper function, backwards compatibility | |
| 252 | + * | |
| 253 | + * @param array $args Argument to filter result by. | |
| 254 | + * | |
| 255 | + * @return array Stream Records | |
| 256 | + */ | |
| 257 | + public function query( $args ) { | |
| 258 | + return $this->get_records( $args ); | |
| 259 | + } | |
| 260 | + | |
| 261 | + /** | |
| 262 | + * Return the number of records found in last request | |
| 263 | + * | |
| 264 | + * @return int | |
| 265 | + */ | |
| 266 | + public function get_found_records_count() { | |
| 267 | + return $this->found_records_count; | |
| 268 | + } | |
| 269 | + | |
| 270 | + /** | |
| 271 | + * Public getter to return table names | |
| 272 | + * | |
| 273 | + * @return array | |
| 274 | + */ | |
| 275 | + public function get_table_names() { | |
| 276 | + return $this->driver->get_table_names(); | |
| 200 | 277 | } |
| 201 | 278 | } |
