first version

Author: J0celyn

.gitignore

@@ -0,0 +1,3 @@
+.idea
+/vendor/
+config.php

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jocelyn Flament
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+# ibd2mysql
+
+[![Latest Packagist release](https://img.shields.io/packagist/v/j0celyn/ibd2mysql.svg)](https://packagist.org/packages/j0celyn/ibd2mysql)
+[![Latest Packagist release](https://img.shields.io/packagist/dependency-v/j0celyn/ibd2mysql/php)](https://packagist.org/packages/j0celyn/ibd2mysql)
+[![Latest Packagist release](https://img.shields.io/github/license/j0celyn/ibd2mysql)](https://packagist.org/packages/j0celyn/ibd2mysql)
+
+## Description
+
+MySQL provides the configuration flag [innodb_force_recovery](https://dev.mysql.com/doc/refman/8.0/en/forcing-innodb-recovery.html) to help you fix several kinds of errors.  
+You should first check if it can help you fix your problems.
+
+**ibd2mysql** is a tool to try to recover InnoDB tables under the following conditions:
+- MySQL Server v8.0.0 or newer
+- your tables are using the InnoDB engine
+- [innodb_file_per_table](https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_file_per_table) was enabled in the MySQL Server configuration **before** you ran into problems  
+  (in the MySQL data directory, you should see at least one IBD file for each of your tables)
+- the MySQL data dictionary is corrupted or missing (the server no longer knows what tables each database contains, despite the IBD files still being there)
+
+
+## Requirements
+
+- PHP 8
+- MySQL 8
+
+## Installation
+
+#### Install via composer:
+    composer require j0celyn/ibd2mysql
+
+## Setup
+
+⚠️ The IBD file format evolving with each MySQL version, it is highly recommended to run this script using the version of the MySQL Server that created the IBD files you are trying to recover.  
+If using a different MySQL version, you will probably still be able to extract the SDI information and create the SQL files. However the **--repair** option is likely to fail with fatal errors when importing your IBD files into the MySQL Server.
+
+Rename `config-empty.php` to `config.php`, then edit its values:
+- **DB_HOST**: your MySQL server host
+- **DB_PORT**: your MySQL server port
+- **DB_USER**: your MySQL server user
+- **DB_PASSWORD**: your MySQL server password
+- **MYSQL_DATA_DIR**: full path to the MySQL data directory of your server
+- **IBD2SDI_PATH**: full path to the directory that holds the [ibd2sdi](https://dev.mysql.com/doc/refman/8.0/en/ibd2sdi.html) program. It was probably installed together with your MySQL server
+- **BACKUP_DIR**: full path to the directory of backup IBD files (the IBD files that contain your MySQL data)
+- **OUTPUT_DIR**: full path to the directory where this script will create SDI and SQL files
+
+### Usage
+Here are the available options:
+- **--sdi**: extracts SDI information from IBD files. **Note: Existing SDI files will be overwritten.**
+- **--sql**: creates MySQL files from SDI files. **Note: Existing SQL files will be overwritten.**
+- **--repair**: for each table:
+    - runs the MySQL files to create the table
+    - moves IBD file(s) to replace the empty tablespace with your saved tablespace
+    - if needed, optimizes the table to fix some issues
+ 
+      **Note: Existing MySQL tables will not be altered.**
+
+When the script is called with more than one option, they will always run in the same order: **sdi sql repair**
+
+To run the script, use one or more options.
+
+#### Examples:
+
+    php vendor/j0celyn/ibd2mysql/convert.php --sdi
+    php vendor/j0celyn/ibd2mysql/convert.php --sdi --sql

composer.json

@@ -0,0 +1,22 @@
+{
+  "name": "j0celyn/ibd2mysql",
+  "description": "Tool to recover InnoDB tables in a corrupted MySQL database or MySQL server",
+  "keywords": ["MySQL","InnoDB"],
+    "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Jocelyn Flament",
+      "role": "Developer"
+    }
+  ],
+  "autoload": {
+        "psr-4": {
+            "j0celyn\\ibd2mysql\\": "src/"
+    }
+    },
+    "require": {
+        "php": ">=8.0.0",
+        "ext-pdo": "*"
+  }
+}

config-empty.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * @author Jocelyn Flament
+ * @since 12/07/2023
+ */
+
+/*
+ * Fill in the necessary values below, then rename this file to config.php
+ * A valid MySQL connection is necessary to generate the SQL files or create the MySQL tables
+ */
+
+const DB_HOST = 'localhost'; // your MySQL server host - change it if necessary
+const DB_PORT = 3306; // your MySQL server port - change it if necessary
+const DB_USER = ''; // your MySQL server user - it must have database creation and table creation permissions
+const DB_PASSWORD = ''; // your MySQL server password
+const MYSQL_DATA_DIR = ''; // full path to the MySQL data directory of your server
+const IBD2SDI_PATH = ''; // full path to the directory that holds the ibd2sdi program. It was probably installed together with your MySQL server
+const BACKUP_DIR = ''; // full path to the directory of backup IBD files (the IBD files that contain your MySQL data)
+const OUTPUT_DIR = ''; // full path to the directory where this script will create SDI and SQL files
+
+/*
+ * if DB_NAMES is empty, it will process all subdirectories (databases) found in BACKUP_DIR
+ * otherwise, il will only process the subdirectories (databases) listed below
+ *
+ * example: ['my_database', 'another_database', 'third_db']
+*/
+const DB_NAMES = [];

convert.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * @package ibd2mysql
+ * @author Jocelyn Flament
+ *
+ * This is the file that must be called in the console
+ */
+
+require __DIR__ . '/../../autoload.php';
+
+use j0celyn\ibd2mysql\ibd2mysql;
+
+if (!file_exists(__DIR__ . '/config.php')) {
+    die('ERROR: you must set up the config file first. Open config-empty.php and read the comments, then run this script again when the config is ready.');
+}
+
+require __DIR__ . '/config.php';
+require __DIR__ . '/src/utils.php';
+
+const OPTIONS = [
+    'sdi' => [
+        'cmd' => '--sdi',
+        'text' => 'generate SDI files from IBD data',
+    ],
+    'sql' => [
+        'cmd' => '--sql',
+        'text' => 'generate SQL files from SDI files',
+    ],
+    'repair' => [
+        'cmd' => '--repair',
+        'text' => 'recreate the tables from SQL files, with their data (using your IBD files)',
+    ],
+];
+
+$ibd2mysql = new ibd2mysql(DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, IBD2SDI_PATH, BACKUP_DIR, OUTPUT_DIR,
+    MYSQL_DATA_DIR, DB_NAMES);
+
+$options = getopt('', array_keys(OPTIONS));
+if (empty($options)) {
+    echo "Use one or more options to run this script:\n";
+    foreach (OPTIONS as $option) {
+        printf("%s : %s\n", $option['cmd'], $option['text']);
+    }
+    exit;
+}
+if (array_key_exists('sdi', $options)) {
+    $ibd2mysql->getSDI()->dumpFiles();
+}
+if (array_key_exists('sql', $options)) {
+    $ibd2mysql->getSQL()->dumpFiles();
+}
+if (array_key_exists('repair', $options)) {
+    $ibd2mysql->getRepair()->repairTables();
+}

src/Paths.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * @package ibd2mysql
+ * @author Jocelyn Flament
+ */
+
+namespace j0celyn\ibd2mysql;
+
+/**
+ * Helper class to easily retrieve paths to the various directories used by the script
+ */
+class Paths
+{
+    public function __construct(protected string $ibd2sdi_path, protected string $backup_dir, protected string $output_dir,
+                                protected string $mysql_data_dir)
+    {
+        if (!is_executable($this->ibd2sdi_path)) {
+            die(sprintf('ERROR: ibd2sdi program "%s" could not be located or the file is not executable, check config.', $this->ibd2sdi_path));
+        }
+
+        if (!is_dir($this->backup_dir)) {
+            die(sprintf('ERROR: backup directory "%s" does not exist, check config.', $this->backup_dir));
+        }
+
+        if (!@mkdir($this->output_dir, 0777, true) && !is_dir($this->output_dir)) {
+            die(sprintf('ERROR: Output directory "%s" could not be created, check config.', $this->output_dir));
+        }
+    }
+
+    public function getIbd2sdiPath(): string
+    {
+        return $this->ibd2sdi_path;
+    }
+
+    public function getBackupDir(): string
+    {
+        return $this->backup_dir;
+    }
+
+    public function getOutputDir(): string
+    {
+        return $this->output_dir;
+    }
+
+    public function getOutputPath(string $database, string $table, string $ext = 'sdi'): string
+    {
+        return $this->getPath($this->output_dir, $database, $table, $ext);
+    }
+
+    protected function getPath(string $base_dir, string $database, string $table, string $ext): string
+    {
+        return $base_dir . DIRECTORY_SEPARATOR . $database . DIRECTORY_SEPARATOR . $table . ($ext !== '' ? '.' . $ext : '');
+    }
+
+    public function getBackupPath(string $database, string $table, string $ext = 'ibd'): string
+    {
+        return $this->getPath($this->backup_dir, $database, $table, $ext);
+    }
+
+    public function getMysqlDataDirPath(string $database, string $table, string $ext = 'ibd'): string
+    {
+        return $this->getPath($this->mysql_data_dir, $database, $table, $ext);
+    }
+}