'; + // $occasions_html .= sprintf( + // /* translators: 1 is link to add-on page */ + // __( + // 'Set number of login attempts to store using the Extended Settings add-on.', + // 'simple-history' + // ), + // 'https://simple-history.com/add-ons/extended-settings/?utm_source=wpadmin' + // ); + // $occasions_html .= '
'; + // $occasions_html .= '' . wp_kses( + $message, + [ + 'a' => [ + 'href' => [], + 'target' => [], + 'class' => [], + ], + ] + ) . '
'; + } else { esc_html_e( 'Items in the database are kept forever.', 'simple-history' ); } diff --git a/js/scripts.js b/js/scripts.js index b73156d4..ee8fdd23 100644 --- a/js/scripts.js +++ b/js/scripts.js @@ -399,7 +399,7 @@ var simple_history = (function ($) { }, events: { - 'click .SimpleHistoryLogitem__occasions a': 'showOccasions', + 'click .SimpleHistoryLogitem__occasionsLink': 'showOccasions', 'click .SimpleHistoryLogitem__permalink': 'permalink' }, diff --git a/loggers/class-logger.php b/loggers/class-logger.php index cc760ed2..f291f2a9 100644 --- a/loggers/class-logger.php +++ b/loggers/class-logger.php @@ -1306,7 +1306,7 @@ public function log( $level = 'info', $message = '', $context = array() ) { $this->last_insert_context = $context; $this->last_insert_data = $data; - Helpers::get_cache_incrementor( true ); + Helpers::clear_cache(); /** * Fired after an event has been logged. diff --git a/loggers/class-simple-history-logger.php b/loggers/class-simple-history-logger.php index ef9b05be..d7e91a4b 100644 --- a/loggers/class-simple-history-logger.php +++ b/loggers/class-simple-history-logger.php @@ -160,10 +160,34 @@ public function on_updated_option( $option, $old_value, $new_value ) { /** * Get the log row details for this logger. * - * @param array $row Log row. + * @param object $row Log row. * @return Event_Details_Group */ public function get_log_row_details_output( $row ) { + + $message_key = $row->context_message_key; + + if ( $message_key === 'purged_events' ) { + // For message "Removed 24318 events that were older than 60 days" + // add a text with a link with information on how to modify this. + $message = sprintf( + /* translators: 1 is a link to webpage with info about how to modify number of days to keep the log */ + __( 'The number of days the log is kept can be changed using a filter or an add-on. More info.', 'simple-history' ), + esc_url( 'https://simple-history.com/support/change-number-of-days-to-keep-log/?utm_source=wpadmin' ) + ); + + return '' . wp_kses( + $message, + [ + 'a' => [ + 'href' => [], + 'target' => [], + 'class' => [], + ], + ] + ) . '
'; + } + $event_details_group = ( new Event_Details_Group() ) ->add_items( [ diff --git a/package.json b/package.json index 6a3fdd6b..8f13bf86 100644 --- a/package.json +++ b/package.json @@ -53,7 +53,11 @@ "test:functional": "docker-compose run --rm php-cli vendor/bin/codecept run functional", "test:acceptance": "docker-compose run --rm php-cli vendor/bin/codecept run acceptance", "spell-check": "typos", - "spell-check:write-changes": "typos --write-changes" + "spell-check:write-changes": "typos --write-changes", + "test:log-query-mysq55": "PHP_CLI_VERSION=81 PHP_VERSION=8.1 DB_IMAGE=biarms/mysql:5.5 DB_DATA_DIR=./data/mysql-5.5 npm run test:wpunit-logquery", + "test:log-query-mysq57": "PHP_CLI_VERSION=81 PHP_VERSION=8.1 DB_IMAGE=biarms/mysql:5.7 DB_DATA_DIR=./data/mysql-5.7 npm run test:wpunit-logquery", + "test:log-query-mariadb105": "PHP_CLI_VERSION=81 PHP_VERSION=8.1 DB_IMAGE=mariadb:10.5 DB_DATA_DIR=./data/mysql npm run test:wpunit-logquery", + "test:wpunit-logquery": "docker-compose run --rm php-cli vendor/bin/codecept run wpunit:LogQueryTest" }, "lint-staged": { "*.php": [ diff --git a/phpstan.neon b/phpstan.neon index 6596b40c..daa26dab 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -13,3 +13,5 @@ parameters: bootstrapFiles: - tests/phpstan/bootstrap.php level: 2 + ignoreErrors: + - '#Access to an undefined property object::\$context_message_key.#' diff --git a/readme.txt b/readme.txt index 5424af92..e53558da 100644 --- a/readme.txt +++ b/readme.txt @@ -14,7 +14,7 @@ Simple History shows recent changes made within WordPress, directly on your dash The plugin works as a log/history/audit log/version history of the most important events that occur in WordPress. -It’s a plugin that is good to have on websites where several people are involved in editing the content. +It's a plugin that is good to have on websites where several people are involved in editing the content. Out of the box Simple History has support for: @@ -164,12 +164,14 @@ If you want to translate Simple History to your language then read about how thi Development of this plugin takes place at GitHub. Please join in with feature requests, bug reports, or even pull requests! https://github.com/bonny/WordPress-Simple-History -### Donation +### Sponsor this project If you like this plugin please consider donating to support the development. You can [donate using PayPal](https://www.paypal.me/eskapism) or you can [become a GitHub sponsor](https://github.com/sponsors/bonny). +There is also some [add-ons](https://simple-history.com/add-ons/) that you can buy to support the development of this plugin and get some extra features. + ## Frequently Asked Questions = Can I add my own events to the log? = @@ -209,6 +211,22 @@ This can be modified using the filter [`simple_history/db_purge_days_interval`]( ## Changelog +4.9.0 Unreleased + +This release comes with improvements to the SQL queries that the plugin use to fetch events. These optimizations enhance query performance and reliability on both MySQL and MariaDB. + +Additionally, the plugin now provides support for SQLite databases. + +- Added: support for SQLite Database. Tested with the WordPress [SQLite Database Integration](https://wordpress.org/plugins/sqlite-database-integration/) feature plugin. See [Let's make WordPress officially support SQLite](https://make.wordpress.org/core/2022/09/12/lets-make-wordpress-officially-support-sqlite/) and [Help us test the SQLite implementation](https://make.wordpress.org/core/2022/12/20/help-us-test-the-sqlite-implementation/) for more information about the SQLite integration in WordPress and the current status. Fixes [#394](https://github.com/bonny/WordPress-Simple-History/issues/394) and [#411](https://github.com/bonny/WordPress-Simple-History/issues/411). +- Added: Support for plugin preview button that soon will be available in the WordPress.org plugin directory. This is a very nice way to quickly test plugins in your web browser. Read more in blog post ["Plugin Directory: Preview button revisited"](https://make.wordpress.org/meta/2023/11/22/plugin-directory-preview-button-revisited/) and follow progress in [trac ticket "Add a Preview in Playground button to the plugin directory"](https://meta.trac.wordpress.org/ticket/7251). You can however already test the functionality using this link: [Preview Simple History plugin](https://playground.wordpress.net/?plugin=simple-history&blueprint-url=https://wordpress.org/plugins/wp-json/plugins/v1/plugin/simple-history/blueprint.json). +- Added: IP addresses are now shown on occasions. +- Added: Helper functions `get_cache_group()`, `clear_cache()`. +- Changed: Better support for MariaDB and MySQL 8 by using full group by in the query. Fixes multiple database related errors. Fixes [#397](https://github.com/bonny/WordPress-Simple-History/issues/397), [#409](https://github.com/bonny/WordPress-Simple-History/issues/409), and [#405](https://github.com/bonny/WordPress-Simple-History/issues/405). +- Changed: Misc code cleanup and improvements and GUI changes. +- Removed: Usage of `SQL_CALC_FOUND_ROWS` since it's deprecated in MySQL 8.0.17. Also [this should make the query faster](https://stackoverflow.com/a/188682). Fixes [#312](https://github.com/bonny/WordPress-Simple-History/issues/312). +- Removed: Columns "rep", "repeated" and "occasionsIDType" are removed from return value in `Log_Query()`. +- Fixed: Stats widget counting could be wrong due to incorrect loggers included in stats query. + ### 4.8.0 (December 2023) 🧩 This release contains minor fixes, some code cleanup, and adds [support for add-ons](https://simple-history.com/2023/simple-history-4-8-0-introducing-add-ons/)! diff --git a/templates/template-settings-tab-debug.php b/templates/template-settings-tab-debug.php index fece243a..ca399001 100644 --- a/templates/template-settings-tab-debug.php +++ b/templates/template-settings-tab-debug.php @@ -97,7 +97,11 @@ echo ''; +/** + * Number of rows in database + */ $logQuery = new Log_Query(); + $rows = $logQuery->query( array( 'posts_per_page' => 1, diff --git a/tests/wpunit/APHPVersionTest.php b/tests/wpunit/APHPVersionTest.php index 22af4385..51ba1e49 100644 --- a/tests/wpunit/APHPVersionTest.php +++ b/tests/wpunit/APHPVersionTest.php @@ -11,7 +11,7 @@ public function test_a_php_version() { // Output MySQL/MariaDB version. global $wpdb; if ( empty( $wpdb->use_mysqli ) ) { - $mysqlVersion = mysql_get_server_info(); + // $mysqlVersion = mysql_get_server_info(); } else { $mysqlVersion = mysqli_get_server_info( $wpdb->dbh ); } diff --git a/tests/wpunit/LogQueryTest.php b/tests/wpunit/LogQueryTest.php index a3174b89..dfb6f81e 100644 --- a/tests/wpunit/LogQueryTest.php +++ b/tests/wpunit/LogQueryTest.php @@ -1,35 +1,27 @@ markTestIncomplete('This test will fail in Mysql >5.5 and MariaDB until SQL bug is fixed.'); - // Add and set current user to admin user, so user can read all logs. $user_id = $this->factory->user->create( array( @@ -46,7 +38,7 @@ function test_query() { "num_new_rows": 1, "num_mysql_queries": 50, (what? why so many??) */ - $added_rows_id = []; + $added_rows_ids = []; $num_rows_to_add = 10; for ($i = 0; $i < $num_rows_to_add; $i++) { $logger = SimpleLogger()->info( @@ -56,31 +48,214 @@ function test_query() { 'message_num' => $i, ] ); - // sh_d('$logger', $logger->last_insert_context, $logger->last_insert_data, $logger->last_insert_id); - $added_rows_id[] = $logger->last_insert_id; + $added_rows_ids[] = $logger->last_insert_id; } // Now query the log and see what id we get as the latest. - $log_query_args = array( - 'posts_per_page' => 1, + $query_results = (new Log_Query())->query( ['posts_per_page' => 1] ); + $first_log_row_from_query = $query_results['log_rows'][0]; + + $this->assertEquals( + $added_rows_ids[$num_rows_to_add-1], + $first_log_row_from_query->id, + 'The id of the first row in query result should be the same as the id of the last added row.' ); + + // Add more. + for ($i = 0; $i < 4; $i++) { + $logger = SimpleLogger()->info( + 'Another test info message ' . $i, + [ + '_occasionsID' => 'my_occasion_id_2', + 'message_num' => $i, + ] + ); + } + + $logger = SimpleLogger()->info( + 'Single message ' . 0, + [ + '_occasionsID' => 'my_occasion_id_3', + 'message_num' => 0, + ] + ); + - $log_query = new Log_Query(); - $query_results = $log_query->query( $log_query_args ); - $first_log_row = $query_results['log_rows'][0]; + $hello_some_messages_message_count = 7; + for ($i = 0; $i < $hello_some_messages_message_count; $i++) { + $logger = SimpleLogger()->info( + 'Hello some messages ' . $i, + [ + '_occasionsID' => 'my_occasion_id_5', + 'message_num' => $i, + ] + ); + } + + $oh_such_logging_rows_num_to_add = 3; + for ($i = 0; $i < $oh_such_logging_rows_num_to_add; $i++) { + $logger = SimpleLogger()->info( + 'Oh such logging things ' . $i, + [ + '_occasionsID' => 'my_occasion_id_6', + 'message_num' => $i, + ] + ); + } + + // Get first result and check that it has 3 subsequentOccasions + // and that the message is + // "Oh such logging things {$i-1}" + // and that context contains message_num = {$i-1}. + $results = (new Log_Query())->query([ + 'posts_per_page' => 3 + ]); + + $first_log_row_from_query = $results['log_rows'][0]; + $second_log_row_from_query = $results['log_rows'][1]; + $third_log_row_from_query = $results['log_rows'][2]; + + $this->assertEquals( + 3, + $first_log_row_from_query->subsequentOccasions, + 'The first log row should have 3 subsequentOccasions.' + ); + + $this->assertIsNumeric($first_log_row_from_query->subsequentOccasions); + + $this->assertEquals( + 'Oh such logging things ' . ($i-1), + $first_log_row_from_query->message, + 'The first log row should have the message "Oh such logging things" ' . $i-1 + ); + + $this->assertEquals( + $i-1, + $first_log_row_from_query->context['message_num'], + 'The first log row should have the context message_num = ' . ($i-1) + ); + + // Test second message. + $this->assertEquals( + $hello_some_messages_message_count, + $second_log_row_from_query->subsequentOccasions, + "The second log row should have $hello_some_messages_message_count subsequentOccasions." + ); + + $this->assertIsNumeric($second_log_row_from_query->subsequentOccasions); - // On MariaDB $first_log_row->id is the same as the value in $added_rows_id[0] (the first added row) - // but it should be the id from the last added row, i.e. the value in $added_rows_id[9]. - sh_d('$first_log_row id', $first_log_row->id); - sh_d('$added_rows_id[0]', $added_rows_id[0]); - sh_d('$added_rows_id[max]', $added_rows_id[$num_rows_to_add-1]); + $this->assertEquals( + 'Hello some messages 6', + $second_log_row_from_query->message, + 'The first log row should have the message "Hello some messages 6"' + ); + + // Test third message. + $this->assertEquals( + 1, + $third_log_row_from_query->subsequentOccasions, + 'The third log row should have 1 subsequentOccasions.' + ); + + $this->assertIsNumeric($third_log_row_from_query->subsequentOccasions); - // $this->markTestIncomplete('This test will fail in MariaDB until bug is fixed.'); $this->assertEquals( - $added_rows_id[$num_rows_to_add-1], - $first_log_row->id, - 'The id of the first row should be the same as the id of the last added row.' + 'Single message 0', + $third_log_row_from_query->message, + 'The third log row should have the message "Single message 0"' + ); + + + // Test occasions query arg. for first returned row. + $query_results = (new Log_Query())->query([ + 'type' => 'occasions', + // Get history rows with id:s less than this, i.e. get earlier/previous rows. + 'logRowID' => $first_log_row_from_query->id, + 'occasionsID' => $first_log_row_from_query->occasionsID, // The occasions id is md5:ed so we need to use log query to get the last row, and then get occasions id.. + 'occasionsCount' => $first_log_row_from_query->subsequentOccasions - 1, + ]); + + $this->assertCount( + $oh_such_logging_rows_num_to_add - 1, + $query_results['log_rows'], + 'The number of rows returned when getting occasions should be ' . ($oh_such_logging_rows_num_to_add - 1) + ); + + // Test occasions query arg. for second returned row. + $query_results = (new Log_Query())->query([ + 'type' => 'occasions', + 'logRowID' => $second_log_row_from_query->id, + 'occasionsID' => $second_log_row_from_query->occasionsID, // The occasions id is md5:ed so we need to use log query to get the last row, and then get occasions id.. + 'occasionsCount' => $second_log_row_from_query->subsequentOccasions - 1, + ]); + + $this->assertCount( + $hello_some_messages_message_count - 1, + $query_results['log_rows'], + 'The number of rows returned when getting occasions should be ' . ($hello_some_messages_message_count - 1) + ); + + // Test occasions query arg. for third returned row. + $query_results = (new Log_Query())->query([ + 'type' => 'occasions', + 'logRowID' => $third_log_row_from_query->id, + 'occasionsID' => $third_log_row_from_query->occasionsID, // The occasions id is md5:ed so we need to use log query to get the last row, and then get occasions id. + 'occasionsCount' => $third_log_row_from_query->subsequentOccasions - 1, + ]); + + // No further occasions for this row. + $this->assertSame( + "1", + $third_log_row_from_query->subsequentOccasions, + 'The number of rows returned when getting occasions should be 0' + ); + + $this->assertCount( + 0, + $query_results['log_rows'], + 'The number of rows returned when getting occasions should be 0' + ); + } + + function test_since_id() { + // Add and set current user to admin user, so user can read all logs. + $user_id = $this->factory->user->create( + array( + 'role' => 'administrator', + ) + ); + wp_set_current_user( $user_id ); + + $logger = SimpleLogger()->info( + 'Test info message 1', + [ + '_occasionsID' => 'my_occasion_id', + 'message_num' => 1, + ] ); + + $last_insert_id = $logger->last_insert_id; + + // Query log again and use $last_insert_id as since_id. + // It should not have any new rows yet. + $query_results = (new Log_Query())->query( ['since_id' => $last_insert_id] ); + $this->assertEmpty($query_results['log_rows'], 'There should be no new rows yet.'); + + // Add two new events. + for ($i=0; $i<2; $i++) { + echo "log $i"; + $logger = SimpleLogger()->info( + 'Test info message ' . $i, + [ + '_occasionsID' => 'my_occasion_id_in_loop_' . $i, + 'message_num' => $i, + ] + ); + } + + // Test that we get two new rows. + $query_results = (new Log_Query())->query( ['since_id' => $last_insert_id] ); + $this->assertEquals(2, $query_results['total_row_count'], 'There should be two new rows now.'); } /** @@ -130,9 +305,6 @@ function test_log_query() { $this->assertTrue( property_exists( $first_log_row, 'initiator' ) ); $this->assertTrue( property_exists( $first_log_row, 'occasionsID' ) ); $this->assertTrue( property_exists( $first_log_row, 'subsequentOccasions' ) ); - $this->assertTrue( property_exists( $first_log_row, 'rep' ) ); - $this->assertTrue( property_exists( $first_log_row, 'repeated' ) ); - $this->assertTrue( property_exists( $first_log_row, 'occasionsIDType' ) ); $this->assertTrue( property_exists( $first_log_row, 'context' ) ); } } diff --git a/tests/wpunit/OldLoggerTest.php b/tests/wpunit/OldLoggerTest.php index 267b472c..b131c216 100644 --- a/tests/wpunit/OldLoggerTest.php +++ b/tests/wpunit/OldLoggerTest.php @@ -65,7 +65,7 @@ public function test_old_log_query_class() { $expected_object->initiator = 'wp_user'; $actual = $query_results['log_rows'][0]; - unset($actual->id, $actual->date, $actual->occasionsID, $actual->subsequentOccasions, $actual->rep, $actual->repeated, $actual->occasionsIDType, $actual->context); + unset($actual->id, $actual->date, $actual->occasionsID, $actual->subsequentOccasions, $actual->rep, $actual->repeated, $actual->context); $this->assertEquals($expected_object, $actual); }