Backup Documentation

Backup Controller Documentation

File: /controllers/backupController.php

Purpose: Manages database backup creation, restoration, and database switching

Last Updated: December 19, 2024

Total Functions: 5

Lines of Code: ~169

---

📋 Overview

The Backup Controller is a critical system administration component for managing database backups and multi-database environments in the ERP system. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Direct Operations)

Table NamePurposeKey Columns
**newdbbackup**Backup metadatanewdbbackupid, backupname, backupdate
### Backup Environment Structure

Environment TypePurposeDatabase Pattern
**Production**Live systemOriginal database name
**Backup Copies**Historical data`erp{backupId}` pattern
**Development**Testing environment`storesdb{backupId}` pattern
---

🔧 Key Functions

1. add() - Create New Backup

Location: Line 112

Purpose: Create a complete database backup with metadata tracking

Function Signature: 

function add()

Parameters (via $_POST):

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Validate Input
(Backup Name)
└─────────────────┘ └──────────────────┘ └─────────────────┘
▼
┌─────────────────┐ ┌──────────────────┐ │
Success
Response
└─────────────────┘ └──────────────────┘

Key Features:

2. duplicateTables() - Database Replication Engine

Location: Line 128

Purpose: Create complete copy of database including structure and data

Function Signature: 

function duplicateTables($sourceDB = NULL, $targetDB = NULL)

Parameters:

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Connect MySQL
(Admin Level)
└─────────────────┘ └──────────────────┘ └─────────────────┘
▼
┌─────────────────────────────┐
For Each Table:
1Drop if exists
2Create structure
3Copy all data
4Optimize table
└─────────────────────────────┘

SQL Operations Performed: 

-- 1. Create backup database
CREATE DATABASE erp{backupId}

-- 2. For each table:
DROP TABLE IF EXISTS `erp{backupId}`.`tablename`
CREATE TABLE `erp{backupId}`.`tablename` LIKE `sourceDB`.`tablename`
INSERT INTO `erp{backupId}`.`tablename` SELECT * FROM `sourceDB`.`tablename`
OPTIMIZE TABLE `erp{backupId}`.`tablename`

3. loadDatabase() - List Available Backups

Location: Line 152

Purpose: Retrieve all available backup databases for selection

Returns: Array of backup metadata for display

4. changedb() - Switch Database Environment

Location: Line 160

Purpose: Switch the active database environment

Parameters (via $_POST):

Logic Flow:

┌─────────────────┐
Backup ID
Selection
└─────────┬───────┘
▼
┌─────▼─────┐
ID = -2?
└───────────┘ │
┌─────────▼───────┐ │ ┌─────────────────┐
Set Session
dbname =
"storesdb{ID}"
└─────────────────┘ └─────────────────┘

5. Default Display - Backup Management Interface

Location: Line 52

Purpose: Display backup creation interface with authentication

---

🔄 Business Logic Flow

Backup Creation Workflow

┌─────────────────┐
User Initiates
Backup Request
└─────────┬───────┘
▼
┌─────────▼───────┐ ┌──────────────────┐
Authentication
Check
└─────────────────┘ └──────────────────┘
┌─────────▼───────┐ ┌──────────▼──────┐
Create Metadata
Record
└─────────────────┘ └─────────────────┘
┌─────────▼───────┐ │
Generate
Success Message
└─────────────────┘

Database Environment Architecture

┌─────────────────┐
Production
Database
└─────────┬───────┘
▼
┌───────────────────────┼───────────────────────┐
│
┌─────▼─────┐ ┌─────────▼────────┐ ┌─────▼─────┐
Backup 1
erp1
└───────────┘ └──────────────────┘ └───────────┘
│
┌─────▼─────┐ ┌─────────▼────────┐ ┌─────▼─────┐
Dev Env 1
│ storesdb2
└───────────┘ └──────────────────┘ └───────────┘

---

⚠️ Common Issues

MySQL Version Compatibility

Issue: Code uses deprecated mysql_* functions 

// ⚠️ DEPRECATED: Lines 129-147 use old MySQL extension
$link = mysql_connect(ConnectionProperty::getHost(), ConnectionProperty::getUser(), ConnectionProperty::getPassword());

Recommendation: Upgrade to MySQLi or PDO for PHP 8.2 compatibility

Memory and Performance

Issue: Large database duplication can exhaust memory/time limits

Security Considerations

Issue: Direct database creation requires elevated privileges

Session Management

Issue: Database switching affects all subsequent operations 

// ✅ IMPLEMENTED: Line 166 - Session-based database switching
$_SESSION['dbname'] = "storesdb" . $backupId;

---

🔗 Dependencies

Required DAOs

Required Files

System Requirements

Security Model

---

🚀 Performance Notes

Backup Strategy Recommendations

1. Regular Backups: Schedule during low-usage periods

2. Retention Policy: Implement backup rotation/cleanup

3. Monitoring: Track backup completion and file sizes

4. Testing: Regular restore testing for backup validation

5. Documentation: Maintain backup/restore procedures

The Backup Controller is essential for data protection and system recovery, providing robust database management capabilities for enterprise environments.