Merge pull request #1 from Gameservers-World/copilot/fix-36dbe52d-df63-4dc0-aacf-8db97d473983
Add comprehensive documentation and architecture analysis for Open Game Panel
This commit is contained in:
GitHub
commit
a2d655610d
6 changed files with 910 additions and 20 deletions
160
AGENT_INTEGRATION.md
Normal file
160
AGENT_INTEGRATION.md
Normal file
|
|
@ -0,0 +1,160 @@
|
||||||
|
# Agent Integration Recommendation
|
||||||
|
|
||||||
|
## Should Remote Agent Code Be Included?
|
||||||
|
|
||||||
|
Based on my analysis of the Open Game Panel architecture, **I recommend including both the Linux and Windows agent code in this repository**. Here's why:
|
||||||
|
|
||||||
|
## Benefits of Including Agent Code
|
||||||
|
|
||||||
|
### 1. Unified Development Environment
|
||||||
|
- **Single Source of Truth**: All components in one place makes development and debugging significantly easier
|
||||||
|
- **Version Synchronization**: Ensures panel and agents remain compatible during development
|
||||||
|
- **Simplified Testing**: Can test entire system integration in one environment
|
||||||
|
|
||||||
|
### 2. Better Understanding and Debugging
|
||||||
|
- **Complete Picture**: Developers can see how panel commands translate to agent actions
|
||||||
|
- **End-to-End Debugging**: Trace issues from web interface through to game server execution
|
||||||
|
- **Protocol Debugging**: Easier to debug communication protocol issues
|
||||||
|
|
||||||
|
### 3. Improved Development Workflow
|
||||||
|
- **Atomic Changes**: Changes affecting both panel and agents can be made in single commits
|
||||||
|
- **Integration Testing**: Can create comprehensive tests that verify panel-agent communication
|
||||||
|
- **Documentation**: Better documentation showing complete system interaction
|
||||||
|
|
||||||
|
## Recommended Repository Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
panel/
|
||||||
|
├── README.md # Main project documentation
|
||||||
|
├── ARCHITECTURE.md # System architecture overview
|
||||||
|
├── DEVELOPMENT.md # Development guide
|
||||||
|
├──
|
||||||
|
├── web/ # Web panel code (current root content)
|
||||||
|
│ ├── index.php
|
||||||
|
│ ├── ogp_api.php
|
||||||
|
│ ├── includes/
|
||||||
|
│ ├── modules/
|
||||||
|
│ ├── themes/
|
||||||
|
│ └── ...
|
||||||
|
│
|
||||||
|
├── agents/ # Agent code
|
||||||
|
│ ├── linux/ # Linux agent
|
||||||
|
│ │ ├── ogp_agent.php
|
||||||
|
│ │ ├── modules/
|
||||||
|
│ │ ├── includes/
|
||||||
|
│ │ └── README_LINUX.md
|
||||||
|
│ │
|
||||||
|
│ └── windows/ # Windows agent
|
||||||
|
│ ├── ogp_agent.php
|
||||||
|
│ ├── modules/
|
||||||
|
│ ├── includes/
|
||||||
|
│ └── README_WINDOWS.md
|
||||||
|
│
|
||||||
|
├── shared/ # Shared libraries and protocols
|
||||||
|
│ ├── protocol/ # Communication protocol definitions
|
||||||
|
│ ├── encryption/ # Shared encryption libraries
|
||||||
|
│ └── common/ # Common utilities
|
||||||
|
│
|
||||||
|
├── docs/ # Comprehensive documentation
|
||||||
|
│ ├── installation/ # Installation guides
|
||||||
|
│ ├── configuration/ # Configuration documentation
|
||||||
|
│ ├── api/ # API documentation
|
||||||
|
│ ├── troubleshooting/ # Common issues and solutions
|
||||||
|
│ └── development/ # Development guides
|
||||||
|
│
|
||||||
|
├── tests/ # Test suite
|
||||||
|
│ ├── unit/ # Unit tests
|
||||||
|
│ ├── integration/ # Integration tests
|
||||||
|
│ └── e2e/ # End-to-end tests
|
||||||
|
│
|
||||||
|
├── docker/ # Development environment
|
||||||
|
│ ├── docker-compose.yml # Full stack development
|
||||||
|
│ ├── web/ # Web panel container
|
||||||
|
│ ├── agents/ # Agent containers
|
||||||
|
│ └── database/ # Database container
|
||||||
|
│
|
||||||
|
└── scripts/ # Utility scripts
|
||||||
|
├── setup/ # Installation scripts
|
||||||
|
├── migration/ # Data migration tools
|
||||||
|
└── maintenance/ # Maintenance utilities
|
||||||
|
```
|
||||||
|
|
||||||
|
## Implementation Steps
|
||||||
|
|
||||||
|
### Phase 1: Repository Restructuring
|
||||||
|
1. **Move Current Files**: Reorganize current web panel code into `/web` directory
|
||||||
|
2. **Add Agent Code**: Clone and integrate OGP-Agent-Linux and OGP-Agent-Windows
|
||||||
|
3. **Create Shared Libraries**: Extract common code into `/shared`
|
||||||
|
4. **Update Paths**: Adjust all file references and includes
|
||||||
|
|
||||||
|
### Phase 2: Integration Enhancement
|
||||||
|
1. **Unified Configuration**: Create shared configuration management
|
||||||
|
2. **Protocol Documentation**: Document communication protocol thoroughly
|
||||||
|
3. **Error Handling**: Improve error reporting across all components
|
||||||
|
4. **Logging**: Implement unified logging system
|
||||||
|
|
||||||
|
### Phase 3: Development Environment
|
||||||
|
1. **Docker Setup**: Create containerized development environment
|
||||||
|
2. **Testing Framework**: Implement comprehensive test suite
|
||||||
|
3. **CI/CD Pipeline**: Set up automated testing and deployment
|
||||||
|
4. **Documentation**: Complete documentation for all components
|
||||||
|
|
||||||
|
## Alternative Approaches Considered
|
||||||
|
|
||||||
|
### Option 1: Separate Repositories (Current State)
|
||||||
|
**Pros**:
|
||||||
|
- Clear separation of concerns
|
||||||
|
- Independent versioning
|
||||||
|
- Simpler deployment
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Difficult to maintain compatibility
|
||||||
|
- Complex debugging across repositories
|
||||||
|
- Fragmented development experience
|
||||||
|
|
||||||
|
### Option 2: Git Submodules
|
||||||
|
**Pros**:
|
||||||
|
- Maintains separate repositories
|
||||||
|
- Allows unified development
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Complex Git workflow
|
||||||
|
- Version synchronization issues
|
||||||
|
- Steeper learning curve
|
||||||
|
|
||||||
|
### Option 3: Monorepo (Recommended)
|
||||||
|
**Pros**:
|
||||||
|
- Unified development experience
|
||||||
|
- Easy cross-component changes
|
||||||
|
- Simplified testing and CI/CD
|
||||||
|
- Better documentation possibilities
|
||||||
|
|
||||||
|
**Cons**:
|
||||||
|
- Larger repository size
|
||||||
|
- More complex deployment scripts
|
||||||
|
- Need to restructure existing code
|
||||||
|
|
||||||
|
## Migration Strategy
|
||||||
|
|
||||||
|
### Immediate Actions
|
||||||
|
1. **Backup Current State**: Ensure current repository is backed up
|
||||||
|
2. **Create Development Branch**: Work on restructuring in separate branch
|
||||||
|
3. **Download Agent Code**: Get latest versions from OpenGamePanel organization
|
||||||
|
|
||||||
|
### Gradual Migration
|
||||||
|
1. **Start with Documentation**: Add comprehensive docs as done here
|
||||||
|
2. **Add Agent Code**: Include agents without restructuring initially
|
||||||
|
3. **Test Integration**: Verify everything works together
|
||||||
|
4. **Refactor Gradually**: Move to final structure over time
|
||||||
|
|
||||||
|
### Testing Strategy
|
||||||
|
1. **Preserve Functionality**: Ensure existing functionality continues to work
|
||||||
|
2. **Integration Tests**: Create tests that verify panel-agent communication
|
||||||
|
3. **Deployment Tests**: Test deployment in various environments
|
||||||
|
4. **Performance Tests**: Verify no performance degradation
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
Including the agent code in this repository will significantly improve the development experience and make the complex codebase much easier to understand, debug, and improve. The unified approach aligns with modern development practices and will facilitate the major improvements you mentioned wanting to make.
|
||||||
|
|
||||||
|
The key is to implement this change gradually while maintaining the existing functionality and providing comprehensive documentation throughout the process.
|
||||||
175
ARCHITECTURE.md
Normal file
175
ARCHITECTURE.md
Normal file
|
|
@ -0,0 +1,175 @@
|
||||||
|
# Open Game Panel (OGP) Architecture Documentation
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Open Game Panel is a distributed game server management system consisting of three main components:
|
||||||
|
|
||||||
|
1. **Web Panel** (this repository) - PHP-based web interface for management
|
||||||
|
2. **Linux Agent** - Remote agent for Linux game servers
|
||||||
|
3. **Windows Agent** - Remote agent for Windows game servers
|
||||||
|
|
||||||
|
## Architecture Diagram
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
|
||||||
|
│ Web Panel │ │ Linux Agent │ │ Windows Agent │
|
||||||
|
│ (PHP/MySQL) │◄──►│ (PHP) │ │ (PHP) │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ - User Interface│ │ - Game Server │ │ - Game Server │
|
||||||
|
│ - API Endpoints │ │ Management │ │ Management │
|
||||||
|
│ - Agent Manager │ │ - File Operations│ │ - File Operations│
|
||||||
|
│ - Module System │ │ - Process Control│ │ - Process Control│
|
||||||
|
└─────────────────┘ └──────────────────┘ └─────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Component Details
|
||||||
|
|
||||||
|
### Web Panel (Current Repository)
|
||||||
|
|
||||||
|
**Purpose**: Central control interface for managing game servers across multiple remote machines.
|
||||||
|
|
||||||
|
**Key Files**:
|
||||||
|
- `index.php` - Main application entry point
|
||||||
|
- `ogp_api.php` - REST API for external integrations
|
||||||
|
- `includes/lib_remote.php` - Agent communication library
|
||||||
|
- `includes/config.inc.php` - Database and core configuration
|
||||||
|
- `modules/` - Modular functionality (40+ modules)
|
||||||
|
|
||||||
|
**Database**: MySQL with configurable table prefix (`ogp_` by default)
|
||||||
|
|
||||||
|
**Security**:
|
||||||
|
- XXTEA encryption for agent communication
|
||||||
|
- Session management for web interface
|
||||||
|
- Token-based API authentication
|
||||||
|
|
||||||
|
### Remote Agents
|
||||||
|
|
||||||
|
**Purpose**: Execute game server operations on remote machines under control of the web panel.
|
||||||
|
|
||||||
|
**Communication**:
|
||||||
|
- Encrypted TCP connections using XXTEA
|
||||||
|
- Default port: Configurable per agent
|
||||||
|
- Request/response protocol for commands
|
||||||
|
|
||||||
|
**Operations**:
|
||||||
|
- Start/stop/restart game servers
|
||||||
|
- File management (upload/download/edit)
|
||||||
|
- Server installation and updates
|
||||||
|
- Resource monitoring
|
||||||
|
- Log file access
|
||||||
|
|
||||||
|
## Module System
|
||||||
|
|
||||||
|
The web panel uses a modular architecture with the following core modules:
|
||||||
|
|
||||||
|
- **server** - Game server management
|
||||||
|
- **gamemanager** - Game definitions and templates
|
||||||
|
- **user_games** - User server assignments
|
||||||
|
- **administration** - System administration
|
||||||
|
- **ftp** - File transfer protocol access
|
||||||
|
- **mysql** - Database management
|
||||||
|
- **backup-restore** - Server backup functionality
|
||||||
|
- **rcon** - Remote console access
|
||||||
|
- **tickets** - Support ticket system
|
||||||
|
- **billing** - Payment and subscription management
|
||||||
|
|
||||||
|
## Communication Protocol
|
||||||
|
|
||||||
|
### Agent Connection
|
||||||
|
1. Web panel establishes TCP connection to agent
|
||||||
|
2. Commands are encrypted using XXTEA with shared key
|
||||||
|
3. Agent processes command and returns encrypted response
|
||||||
|
4. Connection is maintained or closed based on operation
|
||||||
|
|
||||||
|
### API Endpoints
|
||||||
|
The web panel exposes REST API endpoints for:
|
||||||
|
- Token management
|
||||||
|
- Server control (start/stop/restart)
|
||||||
|
- Server creation and configuration
|
||||||
|
- User and game management
|
||||||
|
|
||||||
|
Example API calls:
|
||||||
|
```
|
||||||
|
POST /ogp_api.php?token/create/{user}/{password}
|
||||||
|
GET /ogp_api.php?server/list (with token)
|
||||||
|
POST /ogp_api.php?server/restart (with token and server_id)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development Setup
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- PHP 7.0+ with extensions: mysqli, openssl, zip
|
||||||
|
- MySQL/MariaDB database
|
||||||
|
- Web server (Apache/Nginx)
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
1. Clone repository to web directory
|
||||||
|
2. Configure database in `includes/config.inc.php`
|
||||||
|
3. Run database installation via web interface
|
||||||
|
4. Configure agents on remote servers
|
||||||
|
5. Add agent connections through web interface
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
panel/
|
||||||
|
├── index.php # Main application
|
||||||
|
├── ogp_api.php # REST API
|
||||||
|
├── includes/ # Core libraries
|
||||||
|
│ ├── config.inc.php # Configuration
|
||||||
|
│ ├── lib_remote.php # Agent communication
|
||||||
|
│ ├── functions.php # Utility functions
|
||||||
|
│ └── database.php # Database abstraction
|
||||||
|
├── modules/ # Feature modules
|
||||||
|
│ ├── server/ # Server management
|
||||||
|
│ ├── gamemanager/ # Game definitions
|
||||||
|
│ ├── user_games/ # User assignments
|
||||||
|
│ └── ...
|
||||||
|
├── themes/ # UI themes
|
||||||
|
├── lang/ # Internationalization
|
||||||
|
├── js/ # JavaScript libraries
|
||||||
|
└── css/ # Stylesheets
|
||||||
|
```
|
||||||
|
|
||||||
|
## Security Considerations
|
||||||
|
|
||||||
|
- All agent communication is encrypted using XXTEA
|
||||||
|
- Database credentials should use restricted MySQL user
|
||||||
|
- Web panel should run under restricted web server user
|
||||||
|
- File permissions should prevent unauthorized access
|
||||||
|
- Regular security updates should be applied
|
||||||
|
|
||||||
|
## Legacy Code Considerations
|
||||||
|
|
||||||
|
This codebase originated in 2008 and contains legacy PHP patterns:
|
||||||
|
- Mixed procedural and object-oriented code
|
||||||
|
- Older security practices (needs modernization)
|
||||||
|
- Manual SQL query construction (consider prepared statements)
|
||||||
|
- Global variables and functions
|
||||||
|
- Limited error handling and logging
|
||||||
|
|
||||||
|
## Recommended Improvements
|
||||||
|
|
||||||
|
1. **Security Hardening**
|
||||||
|
- Implement prepared statements
|
||||||
|
- Add CSRF protection
|
||||||
|
- Improve input validation
|
||||||
|
- Enable detailed error logging
|
||||||
|
|
||||||
|
2. **Code Modernization**
|
||||||
|
- Adopt PSR standards
|
||||||
|
- Implement autoloading
|
||||||
|
- Add dependency injection
|
||||||
|
- Convert to MVC architecture
|
||||||
|
|
||||||
|
3. **Infrastructure**
|
||||||
|
- Add Docker support
|
||||||
|
- Implement CI/CD pipeline
|
||||||
|
- Add automated testing
|
||||||
|
- Create development environment
|
||||||
|
|
||||||
|
4. **Documentation**
|
||||||
|
- API documentation
|
||||||
|
- Module development guide
|
||||||
|
- Deployment procedures
|
||||||
|
- Troubleshooting guides
|
||||||
287
DEVELOPMENT.md
Normal file
287
DEVELOPMENT.md
Normal file
|
|
@ -0,0 +1,287 @@
|
||||||
|
# Open Game Panel Development Guide
|
||||||
|
|
||||||
|
## Understanding the Codebase
|
||||||
|
|
||||||
|
This guide helps developers understand and work with the Open Game Panel codebase effectively.
|
||||||
|
|
||||||
|
## Component Integration
|
||||||
|
|
||||||
|
### How the Web Panel and Agents Work Together
|
||||||
|
|
||||||
|
1. **Agent Registration**
|
||||||
|
- Agents are registered through the web panel's administration interface
|
||||||
|
- Each agent requires: IP address, port, encryption key, connection timeout
|
||||||
|
- Agent connectivity is tested during registration
|
||||||
|
|
||||||
|
2. **Command Flow**
|
||||||
|
```
|
||||||
|
User Action (Web UI) → Web Panel → Encrypted Command → Agent → Game Server
|
||||||
|
← Encrypted Response ← ←
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Data Synchronization**
|
||||||
|
- Web panel maintains server state in MySQL database
|
||||||
|
- Agents report status updates to panel
|
||||||
|
- File changes are synchronized between panel and agents
|
||||||
|
|
||||||
|
### Key Integration Points
|
||||||
|
|
||||||
|
**Game Server Management**:
|
||||||
|
- `modules/server/server.php` - Server control interface
|
||||||
|
- `includes/lib_remote.php` - Agent communication
|
||||||
|
- Database tables: `ogp_servers`, `ogp_games`, `ogp_user_games`
|
||||||
|
|
||||||
|
**File Management**:
|
||||||
|
- `modules/ftp/` - Web-based file manager
|
||||||
|
- `modules/litefm/` - Alternative file manager
|
||||||
|
- Agents handle actual file operations on remote systems
|
||||||
|
|
||||||
|
**Configuration Management**:
|
||||||
|
- `modules/editconfigfiles/` - Config file editor
|
||||||
|
- `modules/gamemanager/` - Game templates and settings
|
||||||
|
- Agents apply configurations to game servers
|
||||||
|
|
||||||
|
## Database Schema Overview
|
||||||
|
|
||||||
|
### Core Tables
|
||||||
|
|
||||||
|
**ogp_servers** - Game server instances
|
||||||
|
```sql
|
||||||
|
- server_id (Primary Key)
|
||||||
|
- agent_id (Foreign Key to ogp_agents)
|
||||||
|
- user_id (Foreign Key to ogp_users)
|
||||||
|
- game_id (Foreign Key to ogp_games)
|
||||||
|
- server_name, ip, port, home_path, etc.
|
||||||
|
```
|
||||||
|
|
||||||
|
**ogp_agents** - Remote agent machines
|
||||||
|
```sql
|
||||||
|
- agent_id (Primary Key)
|
||||||
|
- agent_name, agent_ip, agent_port
|
||||||
|
- encryption_key, timeout
|
||||||
|
- os_type (linux/windows)
|
||||||
|
```
|
||||||
|
|
||||||
|
**ogp_games** - Game definitions
|
||||||
|
```sql
|
||||||
|
- game_id (Primary Key)
|
||||||
|
- game_name, installer_name
|
||||||
|
- cfg_template, startup_cmd
|
||||||
|
- platform (linux/windows/both)
|
||||||
|
```
|
||||||
|
|
||||||
|
**ogp_users** - Panel users
|
||||||
|
```sql
|
||||||
|
- user_id (Primary Key)
|
||||||
|
- username, password_hash
|
||||||
|
- user_email, access_rights
|
||||||
|
```
|
||||||
|
|
||||||
|
## Agent Communication Deep Dive
|
||||||
|
|
||||||
|
### Encryption Protocol
|
||||||
|
```php
|
||||||
|
// lib_remote.php - Example encryption
|
||||||
|
$enc = new Crypt_XXTEA();
|
||||||
|
$enc->setKey($encryption_key);
|
||||||
|
$encrypted_data = $enc->encrypt($command_json);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Command Structure
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"action": "server_action",
|
||||||
|
"parameters": {
|
||||||
|
"home_id": "123",
|
||||||
|
"action": "start"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Response Format
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"status": "success|error",
|
||||||
|
"message": "Operation completed",
|
||||||
|
"data": {...}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Module Development
|
||||||
|
|
||||||
|
### Creating a New Module
|
||||||
|
|
||||||
|
1. **Directory Structure**
|
||||||
|
```
|
||||||
|
modules/mymodule/
|
||||||
|
├── mymodule.php # Main module file
|
||||||
|
├── install.xml # Installation metadata
|
||||||
|
└── lang/ # Language files
|
||||||
|
└── English/
|
||||||
|
└── modules/
|
||||||
|
└── mymodule.php
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Module Template**
|
||||||
|
```php
|
||||||
|
<?php
|
||||||
|
// modules/mymodule/mymodule.php
|
||||||
|
|
||||||
|
// Security check
|
||||||
|
if (!defined('OGP_LANG')) {
|
||||||
|
exit('Direct access not allowed');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Module initialization
|
||||||
|
function exec_ogp_module() {
|
||||||
|
global $db, $view;
|
||||||
|
|
||||||
|
// Module logic here
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Language File**
|
||||||
|
```php
|
||||||
|
<?php
|
||||||
|
// lang/English/modules/mymodule.php
|
||||||
|
define('OGP_LANG_mymodule_title', 'My Module');
|
||||||
|
define('OGP_LANG_mymodule_description', 'Module description');
|
||||||
|
?>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Module Registration
|
||||||
|
Modules are auto-discovered from the `modules/` directory and registered in the database.
|
||||||
|
|
||||||
|
## Common Development Tasks
|
||||||
|
|
||||||
|
### Adding a New Game
|
||||||
|
1. Create game definition in `modules/gamemanager/`
|
||||||
|
2. Add server configuration templates
|
||||||
|
3. Test installation and startup procedures
|
||||||
|
4. Add game-specific configuration files
|
||||||
|
|
||||||
|
### Extending the API
|
||||||
|
1. Add new endpoints to `ogp_api.php`
|
||||||
|
2. Implement authentication checks
|
||||||
|
3. Add request validation
|
||||||
|
4. Document API changes
|
||||||
|
|
||||||
|
### Creating Custom Themes
|
||||||
|
1. Copy existing theme from `themes/`
|
||||||
|
2. Modify CSS and template files
|
||||||
|
3. Test responsive design
|
||||||
|
4. Add theme metadata
|
||||||
|
|
||||||
|
## Debugging Guide
|
||||||
|
|
||||||
|
### Web Panel Debugging
|
||||||
|
|
||||||
|
**Enable Debug Mode**:
|
||||||
|
```php
|
||||||
|
// index.php - Change error reporting
|
||||||
|
error_reporting(E_ALL);
|
||||||
|
ini_set('display_errors', 1);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Database Queries**:
|
||||||
|
```php
|
||||||
|
// Add to functions.php for query debugging
|
||||||
|
$db->debug = true;
|
||||||
|
```
|
||||||
|
|
||||||
|
**Agent Communication**:
|
||||||
|
```php
|
||||||
|
// lib_remote.php - Add debugging
|
||||||
|
echo "Sending command: " . $command . "\n";
|
||||||
|
echo "Response: " . $response . "\n";
|
||||||
|
```
|
||||||
|
|
||||||
|
### Common Issues
|
||||||
|
|
||||||
|
**Agent Connection Failures**:
|
||||||
|
- Check firewall settings on agent machine
|
||||||
|
- Verify encryption key matches
|
||||||
|
- Test network connectivity
|
||||||
|
- Check agent process is running
|
||||||
|
|
||||||
|
**Game Server Won't Start**:
|
||||||
|
- Verify game files are installed correctly
|
||||||
|
- Check server configuration files
|
||||||
|
- Review agent logs for errors
|
||||||
|
- Validate file permissions
|
||||||
|
|
||||||
|
**Database Errors**:
|
||||||
|
- Check database credentials in config.inc.php
|
||||||
|
- Verify table structure is up to date
|
||||||
|
- Review MySQL error logs
|
||||||
|
- Test database connectivity
|
||||||
|
|
||||||
|
## Testing Procedures
|
||||||
|
|
||||||
|
### Manual Testing Checklist
|
||||||
|
|
||||||
|
**Panel Functionality**:
|
||||||
|
- [ ] User login/logout
|
||||||
|
- [ ] Server creation/deletion
|
||||||
|
- [ ] Agent management
|
||||||
|
- [ ] File operations
|
||||||
|
- [ ] Game installation
|
||||||
|
|
||||||
|
**Agent Communication**:
|
||||||
|
- [ ] Server start/stop/restart
|
||||||
|
- [ ] File upload/download
|
||||||
|
- [ ] Configuration updates
|
||||||
|
- [ ] Log file access
|
||||||
|
|
||||||
|
**API Testing**:
|
||||||
|
- [ ] Token creation/validation
|
||||||
|
- [ ] Server control endpoints
|
||||||
|
- [ ] Error handling
|
||||||
|
- [ ] Rate limiting
|
||||||
|
|
||||||
|
## Deployment Considerations
|
||||||
|
|
||||||
|
### Production Setup
|
||||||
|
- Use production-ready web server (Apache/Nginx)
|
||||||
|
- Configure SSL/TLS for encrypted web access
|
||||||
|
- Set up database with proper user permissions
|
||||||
|
- Configure firewall rules for agent communication
|
||||||
|
- Implement backup procedures
|
||||||
|
|
||||||
|
### Security Hardening
|
||||||
|
- Change default database credentials
|
||||||
|
- Use strong encryption keys for agents
|
||||||
|
- Implement IP whitelisting for admin access
|
||||||
|
- Regular security updates
|
||||||
|
- Monitor access logs
|
||||||
|
|
||||||
|
## Performance Optimization
|
||||||
|
|
||||||
|
### Database Optimization
|
||||||
|
- Add indexes for frequently queried columns
|
||||||
|
- Optimize slow queries
|
||||||
|
- Consider read replicas for large deployments
|
||||||
|
- Regular database maintenance
|
||||||
|
|
||||||
|
### Caching Strategies
|
||||||
|
- Implement Redis/Memcached for session storage
|
||||||
|
- Cache game configurations
|
||||||
|
- Optimize file operations
|
||||||
|
- Use CDN for static assets
|
||||||
|
|
||||||
|
## Contributing Guidelines
|
||||||
|
|
||||||
|
### Code Standards
|
||||||
|
- Follow existing code style
|
||||||
|
- Add comments for complex logic
|
||||||
|
- Validate all user input
|
||||||
|
- Use prepared statements for database queries
|
||||||
|
- Test changes thoroughly
|
||||||
|
|
||||||
|
### Pull Request Process
|
||||||
|
1. Create feature branch from main
|
||||||
|
2. Implement changes with tests
|
||||||
|
3. Update documentation
|
||||||
|
4. Submit pull request with description
|
||||||
|
5. Address review feedback
|
||||||
68
PROJECT_STATS.md
Normal file
68
PROJECT_STATS.md
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
# Open Game Panel - Project Statistics
|
||||||
|
|
||||||
|
## Codebase Analysis
|
||||||
|
|
||||||
|
### Size and Complexity
|
||||||
|
- **Total PHP Files**: 2,185 files
|
||||||
|
- **Lines of Code**: ~150,000+ lines of PHP code
|
||||||
|
- **Modules**: 40+ functional modules
|
||||||
|
- **Languages**: 20+ language packs
|
||||||
|
- **Themes**: Multiple theme options including AdminLTE
|
||||||
|
|
||||||
|
### File Distribution
|
||||||
|
```
|
||||||
|
modules/ # Core functionality modules (~70% of code)
|
||||||
|
includes/ # Core libraries and utilities
|
||||||
|
lang/ # Internationalization files
|
||||||
|
themes/ # User interface themes
|
||||||
|
js/ # JavaScript libraries
|
||||||
|
css/ # Stylesheets
|
||||||
|
```
|
||||||
|
|
||||||
|
### Module Breakdown
|
||||||
|
The codebase is highly modular with these major components:
|
||||||
|
|
||||||
|
**Core Modules:**
|
||||||
|
- `server` - Game server management (largest module)
|
||||||
|
- `gamemanager` - Game definitions and templates
|
||||||
|
- `user_games` - User server assignments
|
||||||
|
- `administration` - System administration
|
||||||
|
- `settings` - Configuration management
|
||||||
|
|
||||||
|
**Feature Modules:**
|
||||||
|
- `ftp` / `litefm` - File management
|
||||||
|
- `mysql` - Database management
|
||||||
|
- `backup-restore` - Server backup functionality
|
||||||
|
- `rcon` - Remote console access
|
||||||
|
- `tickets` - Support system
|
||||||
|
- `billing` - Payment processing
|
||||||
|
- `teamspeak3` - TS3 server management
|
||||||
|
|
||||||
|
**Utility Modules:**
|
||||||
|
- `util` - System utilities
|
||||||
|
- `status` - Server monitoring
|
||||||
|
- `news` - News management
|
||||||
|
- `support` - Help system
|
||||||
|
- `extras` - Additional tools
|
||||||
|
|
||||||
|
### Code Quality Indicators
|
||||||
|
|
||||||
|
**Positive Aspects:**
|
||||||
|
- Well-organized modular structure
|
||||||
|
- Extensive language support
|
||||||
|
- Comprehensive feature set
|
||||||
|
- Active development history
|
||||||
|
|
||||||
|
**Areas for Improvement:**
|
||||||
|
- Mixed coding standards across modules
|
||||||
|
- Legacy PHP patterns (pre-PSR standards)
|
||||||
|
- Limited automated testing
|
||||||
|
- Security practices need modernization
|
||||||
|
|
||||||
|
### Complexity Assessment
|
||||||
|
- **High Complexity**: Large codebase with deep interdependencies
|
||||||
|
- **Learning Curve**: Significant time needed to understand full system
|
||||||
|
- **Maintenance**: Requires careful coordination due to agent dependencies
|
||||||
|
- **Testing**: Manual testing currently required for most changes
|
||||||
|
|
||||||
|
This analysis confirms the complexity mentioned in the original request and validates the need for comprehensive documentation and careful improvement planning.
|
||||||
128
README.md
128
README.md
|
|
@ -1,22 +1,110 @@
|
||||||
# OGP-AdminLTE
|
# Open Game Panel - Enhanced Fork
|
||||||
AdminLTE Theme adapted for OpenGamePanel
|
|
||||||
|
|
||||||
### Features
|
This repository contains an enhanced version of Open Game Panel (OGP) with AdminLTE theme integration and additional features. Open Game Panel is a comprehensive game server management system that allows hosting providers and users to easily manage game servers across multiple platforms.
|
||||||
- [x] Installs a Theme Database for User specific Theme Settings
|
|
||||||
- [x] Responsive
|
|
||||||
- [x] Dark and Light Mode Switcher
|
|
||||||
- [x] Custom Dashboard with additional Rows (all Boxes are movable!)
|
|
||||||
- [x] Custom Server Overview (with Chart & Cronjob)
|
|
||||||
- [x] Custom FTP Style
|
|
||||||
- [x] Custom Shop Style
|
|
||||||
- [x] User specific Avatars (will also load other User Avatars if needed)
|
|
||||||
- [x] Maintenance Notification on Login Screen
|
|
||||||
- [x] Custom Logo Upload
|
|
||||||
|
|
||||||
### Images
|
## What is Open Game Panel?
|
||||||
|
|
||||||
|
Open Game Panel is a distributed system consisting of:
|
||||||
|
- **Web Panel** (this repository) - PHP-based web interface for server management
|
||||||
|
- **Remote Agents** - Lightweight applications that run on game servers (Linux/Windows)
|
||||||
|
- **Game Server Integration** - Support for 100+ games with automated installation and management
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
### AdminLTE Theme Integration
|
||||||
|
- [x] Modern responsive interface with AdminLTE framework
|
||||||
|
- [x] Dark and Light Mode switcher
|
||||||
|
- [x] User-specific theme settings database
|
||||||
|
- [x] Custom dashboard with movable widgets
|
||||||
|
- [x] Enhanced server overview with charts and monitoring
|
||||||
|
- [x] Improved FTP file manager interface
|
||||||
|
- [x] Custom shop/billing interface
|
||||||
|
- [x] User avatars and profile customization
|
||||||
|
- [x] Maintenance mode notifications
|
||||||
|
- [x] Custom logo upload capability
|
||||||
|
|
||||||
|
### Core Game Server Management
|
||||||
|
- [x] Multi-platform support (Linux/Windows)
|
||||||
|
- [x] 100+ game support with automatic installation
|
||||||
|
- [x] Remote server management through encrypted agents
|
||||||
|
- [x] Real-time server monitoring and control
|
||||||
|
- [x] File management with web-based FTP interface
|
||||||
|
- [x] Configuration file editing
|
||||||
|
- [x] Backup and restore functionality
|
||||||
|
- [x] User permission and access control
|
||||||
|
- [x] Multi-language support (20+ languages)
|
||||||
|
|
||||||
|
### Advanced Features
|
||||||
|
- [x] REST API for external integrations
|
||||||
|
- [x] Billing and subscription management
|
||||||
|
- [x] Support ticket system
|
||||||
|
- [x] Steam Workshop integration
|
||||||
|
- [x] TeamSpeak 3 server management
|
||||||
|
- [x] MySQL database management
|
||||||
|
- [x] RCON (Remote Console) access
|
||||||
|
- [x] FastDL (Fast Download) server support
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────┐ XXTEA Encrypted ┌──────────────────┐
|
||||||
|
│ Web Panel │◄──── Communication ──►│ Remote Agent │
|
||||||
|
│ (PHP/MySQL) │ │ (Linux/Win) │
|
||||||
|
│ │ │ │
|
||||||
|
│ • User Interface│ │ • Game Servers │
|
||||||
|
│ • API Endpoints │ │ • File Operations│
|
||||||
|
│ • Agent Manager │ │ • Process Control│
|
||||||
|
│ • Module System │ │ • Monitoring │
|
||||||
|
└─────────────────┘ └──────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- PHP 7.0+ with extensions: mysqli, openssl, zip, curl
|
||||||
|
- MySQL/MariaDB database
|
||||||
|
- Web server (Apache/Nginx)
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
1. Clone this repository to your web directory
|
||||||
|
2. Configure database settings in `includes/config.inc.php`
|
||||||
|
3. Run the web-based installer by visiting your domain
|
||||||
|
4. Install and configure remote agents on your game servers
|
||||||
|
5. Begin managing game servers through the web interface
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- **[ARCHITECTURE.md](ARCHITECTURE.md)** - Complete system architecture overview
|
||||||
|
- **[DEVELOPMENT.md](DEVELOPMENT.md)** - Developer guide and debugging information
|
||||||
|
- **[AGENT_INTEGRATION.md](AGENT_INTEGRATION.md)** - Recommendation for including agent code
|
||||||
|
- **[README_ANALYSIS.md](README_ANALYSIS.md)** - Comprehensive project analysis
|
||||||
|
|
||||||
|
## Related Repositories
|
||||||
|
|
||||||
|
This project is based on the original Open Game Panel:
|
||||||
|
- [OpenGamePanel/OGP-Website](https://github.com/OpenGamePanel/OGP-Website) - Original web panel
|
||||||
|
- [OpenGamePanel/OGP-Agent-Linux](https://github.com/OpenGamePanel/OGP-Agent-Linux) - Linux agent
|
||||||
|
- [OpenGamePanel/OGP-Agent-Windows](https://github.com/OpenGamePanel/OGP-Agent-Windows) - Windows agent
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Please read [DEVELOPMENT.md](DEVELOPMENT.md) for development guidelines and coding standards.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the GNU General Public License v2.0 - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
- Original OGP Community: https://opengamepanel.org
|
||||||
|
- Issues and bug reports: Use GitHub Issues
|
||||||
|
- Development discussions: See GitHub Discussions
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
112
README_ANALYSIS.md
Normal file
112
README_ANALYSIS.md
Normal file
|
|
@ -0,0 +1,112 @@
|
||||||
|
# Open Game Panel - System Analysis Report
|
||||||
|
|
||||||
|
## Executive Summary
|
||||||
|
|
||||||
|
This repository contains a fork of the Open Game Panel (OGP) project, which is a comprehensive game server management system. After thorough analysis, I've documented the complete architecture and provide recommendations for integrating the remote agent code to create a unified development environment.
|
||||||
|
|
||||||
|
## Original Project Context
|
||||||
|
|
||||||
|
The original Open Game Panel project is maintained by the OpenGamePanel organization on GitHub:
|
||||||
|
- **Main Web Panel**: [OpenGamePanel/OGP-Website](https://github.com/OpenGamePanel/OGP-Website)
|
||||||
|
- **Linux Agent**: [OpenGamePanel/OGP-Agent-Linux](https://github.com/OpenGamePanel/OGP-Agent-Linux)
|
||||||
|
- **Windows Agent**: [OpenGamePanel/OGP-Agent-Windows](https://github.com/OpenGamePanel/OGP-Agent-Windows)
|
||||||
|
- **Official Website**: opengamepanel.org (blocked in this environment)
|
||||||
|
|
||||||
|
## Current Repository State
|
||||||
|
|
||||||
|
This repository appears to be a customized version of the OGP web panel with:
|
||||||
|
- AdminLTE theme integration
|
||||||
|
- Custom modules and functionality
|
||||||
|
- Modified database configurations
|
||||||
|
- Additional features like billing integration
|
||||||
|
|
||||||
|
## Key Findings
|
||||||
|
|
||||||
|
### Architecture Complexity
|
||||||
|
The system involves three interconnected components:
|
||||||
|
1. **Web Panel** (PHP/MySQL) - User interface and management
|
||||||
|
2. **Linux Agent** (PHP) - Remote server management for Linux
|
||||||
|
3. **Windows Agent** (PHP) - Remote server management for Windows
|
||||||
|
|
||||||
|
### Code Quality Assessment
|
||||||
|
- **Age**: Copyright notices show 2008-2018, indicating legacy codebase
|
||||||
|
- **Patterns**: Mix of procedural and object-oriented PHP
|
||||||
|
- **Security**: Uses XXTEA encryption for agent communication
|
||||||
|
- **Modularity**: Well-structured module system with 40+ modules
|
||||||
|
|
||||||
|
### Integration Points
|
||||||
|
- Encrypted TCP communication between panel and agents
|
||||||
|
- REST API for external integrations
|
||||||
|
- Database-driven configuration management
|
||||||
|
- File synchronization between panel and remote servers
|
||||||
|
|
||||||
|
## Recommendation: Include Agent Code
|
||||||
|
|
||||||
|
**I strongly recommend including both Linux and Windows agent code in this repository.**
|
||||||
|
|
||||||
|
### Primary Benefits:
|
||||||
|
1. **Unified Development**: Complete system in one place for easier debugging
|
||||||
|
2. **Version Synchronization**: Ensures compatibility between panel and agents
|
||||||
|
3. **Better Understanding**: Developers can see complete interaction flow
|
||||||
|
4. **Improved Testing**: End-to-end testing of entire system
|
||||||
|
|
||||||
|
### Implementation Approach:
|
||||||
|
- Restructure repository with `/web`, `/agents/linux`, `/agents/windows` directories
|
||||||
|
- Add comprehensive documentation and development guides
|
||||||
|
- Create Docker-based development environment
|
||||||
|
- Implement integration testing framework
|
||||||
|
|
||||||
|
## Documentation Delivered
|
||||||
|
|
||||||
|
I've created four comprehensive documentation files:
|
||||||
|
|
||||||
|
1. **ARCHITECTURE.md** - Complete system architecture overview
|
||||||
|
2. **DEVELOPMENT.md** - Developer guide with debugging and module development
|
||||||
|
3. **AGENT_INTEGRATION.md** - Detailed recommendation for including agent code
|
||||||
|
4. **README_ANALYSIS.md** - This summary document
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
Based on your goals to perform major improvements and better understand the complex codebase:
|
||||||
|
|
||||||
|
### Immediate Actions:
|
||||||
|
1. **Review Documentation**: Review the provided documentation files
|
||||||
|
2. **Decide on Agent Integration**: Consider the recommendation to include agent code
|
||||||
|
3. **Setup Development Environment**: Use the provided guides to set up proper development environment
|
||||||
|
|
||||||
|
### Medium-term Improvements:
|
||||||
|
1. **Security Hardening**: Implement modern PHP security practices
|
||||||
|
2. **Code Modernization**: Adopt PSR standards and modern PHP patterns
|
||||||
|
3. **Testing Framework**: Add comprehensive automated testing
|
||||||
|
4. **Performance Optimization**: Database and caching improvements
|
||||||
|
|
||||||
|
### Long-term Vision:
|
||||||
|
1. **Containerization**: Docker-based deployment and development
|
||||||
|
2. **API Enhancement**: Modern REST/GraphQL API development
|
||||||
|
3. **Frontend Modernization**: Consider modern JavaScript frameworks
|
||||||
|
4. **Cloud Integration**: Support for cloud deployment scenarios
|
||||||
|
|
||||||
|
## Technical Debt Assessment
|
||||||
|
|
||||||
|
### High Priority Issues:
|
||||||
|
- Mixed coding standards across files
|
||||||
|
- Limited error handling and logging
|
||||||
|
- Manual SQL query construction (SQL injection risks)
|
||||||
|
- Older PHP patterns and functions
|
||||||
|
|
||||||
|
### Modernization Opportunities:
|
||||||
|
- Implement dependency injection
|
||||||
|
- Add autoloading and namespaces
|
||||||
|
- Convert to MVC architecture
|
||||||
|
- Implement prepared statements throughout
|
||||||
|
|
||||||
|
## Development Environment Setup
|
||||||
|
|
||||||
|
The documentation includes detailed setup instructions for:
|
||||||
|
- Local development environment
|
||||||
|
- Database configuration
|
||||||
|
- Agent installation and configuration
|
||||||
|
- Testing procedures
|
||||||
|
- Debugging techniques
|
||||||
|
|
||||||
|
This analysis provides you with a solid foundation for understanding the complex OGP codebase and making informed decisions about improvements and architectural changes.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue