Merge branch 'release-1.2.1'

Author: iMattPro

CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
+## 1.2.1 - 2025-06-04
+
+- Modernized codebase, ensuring compatibility with future phpBB releases
+- Removed XHTML artifacts
+- Added Estonian translation
+
 ## 1.2.0 - 2019-04-30
 
 - Supports running from the command line interface using the command: `db:tool`
-- phpBB 3.2.0 or newer required. Support for phpBB 3.1 has ended.
+- phpBB 3.2.0 or newer is required. Support for phpBB 3.1 has ended.
 - Added Dutch translation
 
 ## 1.1.3 - 2018-06-28
@@ -28,7 +34,7 @@
 
 ## 1.1.0 - 2014-11-26
 
-- Added a confirm dialog prior to running a table operation
+- Added a confirmation dialog before running a table operation
 - Various code improvements and fixes
 
 ## 1.1.0-b2 - 2014-07-12

README.md

@@ -1,19 +1,19 @@
 ## ![alt text](https://imattpro.github.io/logo/database_check_1.png "DB Tool") Database Optimize & Repair Tool for phpBB
 
-A phpBB extension that will allow you to check, optimize and repair phpBB's MySQL database tables from a phpMyAdmin-like interface in the Administration Control Panel or from the CLI.
+A phpBB extension that will allow you to check, optimize and repair phpBB's MySQL database tables in the Administration Control Panel or from the Command Line Interface.
 
 [![Build Status](https://github.com/iMattPro/dbtool/actions/workflows/tests.yml/badge.svg)](https://github.com/iMattPro/dbtool/actions)
 [![codecov](https://codecov.io/gh/iMattPro/dbtool/branch/master/graph/badge.svg?token=hlMnGtSzhE)](https://codecov.io/gh/iMattPro/dbtool)
 [![Maintainability](https://qlty.sh/badges/66a0a813-4834-4175-8efc-4b6b0461d035/maintainability.svg)](https://qlty.sh/gh/iMattPro/projects/dbtool)
 [![Latest Stable Version](https://poser.pugx.org/vse/dbtool/v/stable)](https://www.phpbb.com/customise/db/extension/database_optimize_and_repair_tool/)
 
 ## Features
-* Optimize, Repair and Check tables directly from the ACP or the CLI
+* Optimize, Repair, and Check tables directly from the ACP or the CLI
 * Select individual tables or all tables at once
 * Displays table size and table overhead values in the ACP
 * Option to safely disable board during the optimize/repair process
 * Results are logged to the Admin log
-* Enhanced javascript interactions
+* Enhanced JavaScript interactions
 
 ## Minimum Requirements
 * phpBB 3.2.0
@@ -31,7 +31,12 @@ After installation, you can find the Optimize & Repair Tool in:
 
 `ACP -> Maintenance -> Database -> Optimize & Repair`.
 
-> Use this extension at your own risk! There have been cases with certain shared web hosts where a database table could crash for a very large forum. This extension will perform the same functions on your database as phpMyAdmin, so if you have been using phpMyAdmin on your database with no problems, then it should be safe to use this extension. It is always safest to run a backup of your database before performing any Optimize or Repair functions just in case anything goes wrong.
+> Use this extension at your own risk! There have been cases with certain shared web 
+> hosts where a database table could crash for a huge forum. This extension will perform 
+> the same functions on your database as phpMyAdmin, so if you have been using phpMyAdmin 
+> on your database with no problems, then it should be safe to use this extension. It is 
+> always safest to run a backup of your database before performing any Optimize or Repair 
+> functions just in case anything goes wrong.
 
 > Note: InnoDB table types do not support the Repair option.
 
@@ -40,21 +45,29 @@ The Optimize & Repair Tool can also be run from the command line interface in
 phpBB using the `db:tool` command. The tool will prompt you to choose an operation:
 Optimize, Repair, or Check.
 
-To check, optimize or repair all tables:
+To check, optimize, or repair all tables:
 
-`$ php bin/phpbbcli.php db:tool`
+```bash
+php bin/phpbbcli.php db:tool
+```
 
-To check, optimize or repair a specific table:
+To check, optimize, or repair a specific table:
 
-`$ php bin/phpbbcli.php db:tool table_name`
+```bash
+php bin/phpbbcli.php db:tool table_name
+```
 
 To disable the board during an operation, use the `--disable-board` or `-D` option:
 
-`$ php bin/phpbbcli.php db:tool --disable-board`
+```bash
+php bin/phpbbcli.php db:tool --disable-board
+```
 
-For help with the Optimize & Repair Tool command:
+To see help for the Optimize & Repair Tool command:
 
-`$ php bin/phpbbcli.php db:tool --help`
+```bash
+php bin/phpbbcli.php db:tool --help
+```
 
 ## Uninstall
 1. Navigate in the ACP to `Customise -> Manage extensions`.

composer.json

@@ -3,7 +3,7 @@
 	"type": "phpbb-extension",
 	"description": "A phpBB extension that allows you to check, optimize and repair phpBB's MySQL database tables from a phpMyAdmin-like interface in the Administration Control Panel or from the CLI.",
 	"homepage": "https://github.com/iMattPro/dbtool",
-	"version": "1.2.1-dev",
+	"version": "1.2.1",
 	"keywords": ["phpbb", "extension", "database", "mysql", "optimize", "repair", "phpmyadmin"],
 	"license": "GPL-2.0-only",
 	"authors": [

tool/tool.php

@@ -55,7 +55,7 @@ public function __construct(cache $cache, config $config, db $db, log $log, user
 	/**
 	 * Perform table SQL query and return any messages
 	 *
-	 * @param string $operation     OPTIMIZE, REPAIR, or CHECK
+	 * @param string $operation     OPTIMIZE, REPAIR or CHECK
 	 * @param array  $tables        Array of all tables to be processed
 	 * @param int    $disable_board The users option to disable the board during run time
 	 * @return array Any errors or status information, otherwise the array of tables processed
@@ -72,7 +72,7 @@ public function run($operation, $tables, $disable_board = 0)
 		$result = $this->db->sql_query($operation . ' TABLE ' . $this->db->sql_escape($tablestr));
 		while ($row = $this->db->sql_fetchrow($result))
 		{
-			// Build a message only for optimize/repair errors, or if check table is run
+			// Build a message only for optimize/repair errors or if a check table is run
 			if ($operation === ext::CHECK || in_array(strtolower($row['Msg_type']), ['error', 'info', 'note', 'warning']))
 			{
 				$output[] = substr($row['Table'], strpos($row['Table'], '.') + 1) . ' ... ' . $row['Msg_type'] . ': ' . $row['Msg_text'];
@@ -84,7 +84,7 @@ public function run($operation, $tables, $disable_board = 0)
 
 		$this->disable_board($disable_board, $disabled);
 
-		// Clear cache to ensure board is re-enabled for all users
+		// Clear cache to ensure the board is re-enabled for all users
 		$this->cache->purge();
 
 		return $output ?: $tables;
@@ -109,7 +109,7 @@ public function disable_board($disable, $disabled)
 	}
 
 	/**
-	 * Is the database using MySQL
+	 * Is the database using MySQL?
 	 *
 	 * @return bool True if MySQL, false otherwise
 	 * @access public
@@ -120,7 +120,7 @@ public function is_mysql()
 	}
 
 	/**
-	 * Is requested operation to optimize, repair or check tables
+	 * Is the requested operation to optimize, repair or check tables?
 	 *
 	 * @param string $operation The name of the operation
 	 * @return bool True if valid operation, false otherwise

tool/tool_interface.php

@@ -15,7 +15,7 @@ interface tool_interface
 	/**
 	 * Perform table SQL query and return any messages
 	 *
-	 * @param string $operation     OPTIMIZE, REPAIR, or CHECK
+	 * @param string $operation     OPTIMIZE, REPAIR or CHECK
 	 * @param array  $tables        Array of all tables to be processed
 	 * @param int    $disable_board The users option to disable the board during run time
 	 * @return array Any errors or status information
@@ -34,15 +34,15 @@ public function run($operation, $tables, $disable_board = 0);
 	public function disable_board($disable, $disabled);
 
 	/**
-	 * Is the database using MySQL
+	 * Is the database using MySQL?
 	 *
 	 * @return bool True if MySQL, false otherwise
 	 * @access public
 	 */
 	public function is_mysql();
 
 	/**
-	 * Is requested operation to optimize, repair or check tables
+	 * Is the requested operation to optimize, repair or check tables?
 	 *
 	 * @param string $operation The name of the operation
 	 * @return bool True if valid operation, false otherwise