72668cdfbe
Agent-Logs-Url: https://github.com/GameServerPanel/GSP/sessions/1575c81b-f8a7-433a-8f3b-e068c0992c18 Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>
432 lines
14 KiB
PHP
432 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* Documentation Browser
|
|
* Displays a list of documentation categories and allows viewing individual docs
|
|
*/
|
|
|
|
// Start session using the website session name to match the rest of the site
|
|
if (session_status() === PHP_SESSION_NONE) {
|
|
session_name("opengamepanel_web");
|
|
session_start();
|
|
}
|
|
|
|
// Include config
|
|
require_once(__DIR__ . '/includes/config_loader.php');
|
|
|
|
// Set the docs directory
|
|
$docsDir = __DIR__ . '/docs';
|
|
|
|
// Get action and doc parameters
|
|
$action = $_GET['action'] ?? 'list';
|
|
$doc = $_GET['doc'] ?? '';
|
|
$docsPagePath = '/docs.php';
|
|
$pageTitle = 'Documentation - GSP';
|
|
|
|
/**
|
|
* Get all documentation folders with their metadata
|
|
*/
|
|
function getDocCategories($docsDir) {
|
|
$categories = [];
|
|
|
|
if (!is_dir($docsDir)) {
|
|
return $categories;
|
|
}
|
|
|
|
$folders = array_diff(scandir($docsDir), ['.', '..']);
|
|
|
|
foreach ((array)$folders as $folder) {
|
|
$folderPath = $docsDir . '/' . $folder;
|
|
|
|
// Skip if not a directory
|
|
if (!is_dir($folderPath)) {
|
|
continue;
|
|
}
|
|
|
|
// Check for required files
|
|
$indexPath = $folderPath . '/index.php';
|
|
$metadataPath = $folderPath . '/metadata.json';
|
|
|
|
if (!file_exists($indexPath) || !file_exists($metadataPath)) {
|
|
continue;
|
|
}
|
|
|
|
// Read metadata
|
|
$metadataContent = file_get_contents($metadataPath);
|
|
// Remove UTF-8 BOM if present
|
|
$metadataContent = preg_replace('/^\xEF\xBB\xBF/', '', $metadataContent);
|
|
$metadata = json_decode($metadataContent, true);
|
|
if (!$metadata) {
|
|
$metadata = [];
|
|
}
|
|
|
|
// Get display name (no TODO prefix - just display all docs)
|
|
$displayName = $metadata['name'] ?? ucfirst($folder);
|
|
|
|
// Find icon file
|
|
$icon = '';
|
|
if (file_exists($folderPath . '/icon.png')) {
|
|
$icon = '/docs/' . $folder . '/icon.png';
|
|
} elseif (file_exists($folderPath . '/icon.jpg')) {
|
|
$icon = '/docs/' . $folder . '/icon.jpg';
|
|
}
|
|
|
|
$categories[] = [
|
|
'folder' => $folder,
|
|
'name' => $displayName,
|
|
'description' => $metadata['description'] ?? '',
|
|
'category' => trim($metadata['category'] ?? 'other'),
|
|
'order' => $metadata['order'] ?? 999,
|
|
'icon' => $icon
|
|
];
|
|
}
|
|
|
|
// Sort alphabetically by name within categories
|
|
usort($categories, function($a, $b) {
|
|
if ($a['category'] !== $b['category']) {
|
|
// Keep category grouping (game, mods, other)
|
|
return strcmp($a['category'], $b['category']);
|
|
}
|
|
// Sort alphabetically by name (case-insensitive)
|
|
return strcasecmp($a['name'], $b['name']);
|
|
});
|
|
|
|
return $categories;
|
|
}
|
|
|
|
// Get all categories
|
|
$categories = getDocCategories($docsDir);
|
|
|
|
// Group by category
|
|
$grouped = [];
|
|
foreach ((array)$categories as $cat) {
|
|
$category = $cat['category'];
|
|
if (!isset($grouped[$category])) {
|
|
$grouped[$category] = [];
|
|
}
|
|
$grouped[$category][] = $cat;
|
|
}
|
|
|
|
// Category labels - can be extended via JSON
|
|
$categoryLabels = [
|
|
'todo' => 'TODO',
|
|
'game' => 'Game Servers',
|
|
'mods' => 'Mods & Plugins',
|
|
'panel' => 'Panel Documentation',
|
|
'troubleshooting' => 'Troubleshooting',
|
|
'other' => 'Other'
|
|
];
|
|
|
|
// Define category display order
|
|
$categoryOrder = ['todo', 'panel', 'game', 'mods', 'troubleshooting', 'other'];
|
|
|
|
// Sort categories by defined order
|
|
uksort($grouped, function($a, $b) use ($categoryOrder) {
|
|
$posA = array_search($a, $categoryOrder);
|
|
$posB = array_search($b, $categoryOrder);
|
|
|
|
// If not in order array, put at end
|
|
if ($posA === false) $posA = 999;
|
|
if ($posB === false) $posB = 999;
|
|
|
|
return $posA - $posB;
|
|
});
|
|
?>
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate">
|
|
<meta http-equiv="Pragma" content="no-cache">
|
|
<meta http-equiv="Expires" content="0">
|
|
<title><?php echo htmlspecialchars($pageTitle, ENT_QUOTES, 'UTF-8'); ?></title>
|
|
<link rel="stylesheet" href="css/header.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" integrity="sha512-iecdLmaskl7CVkqkXNQ/ZH/XLlvWZOJyj7Yy7tcenmpD1ypASozpmT/E0iPtmFIB46ZmdtAc9eNBvH0H/ZpiBw==" crossorigin="anonymous" referrerpolicy="no-referrer" />
|
|
<style>
|
|
/* Documentation-specific styles - consistent with site theme */
|
|
|
|
.container {
|
|
max-width: 1200px;
|
|
margin: 0 auto;
|
|
padding: 40px 20px;
|
|
}
|
|
|
|
.header {
|
|
margin-bottom: 40px;
|
|
}
|
|
|
|
.header h1 {
|
|
font-size: 32px;
|
|
margin: 0 0 12px;
|
|
color: #fff;
|
|
}
|
|
|
|
.header p {
|
|
color: rgba(255,255,255,0.7);
|
|
margin: 0;
|
|
}
|
|
|
|
.back-button {
|
|
display: inline-block;
|
|
padding: 10px 20px;
|
|
background: rgba(255,255,255,0.03);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 8px;
|
|
color: #7fb3ff;
|
|
text-decoration: none;
|
|
margin-bottom: 20px;
|
|
transition: all 0.2s;
|
|
}
|
|
|
|
.back-button:hover {
|
|
background: rgba(255,255,255,0.06);
|
|
border-color: #667eea;
|
|
}
|
|
|
|
.category-section {
|
|
margin-bottom: 40px;
|
|
}
|
|
|
|
.category-title {
|
|
font-size: 24px;
|
|
color: #667eea;
|
|
margin: 0 0 20px;
|
|
padding-bottom: 10px;
|
|
border-bottom: 2px solid rgba(255,255,255,0.1);
|
|
}
|
|
|
|
.docs-grid {
|
|
display: grid;
|
|
grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
|
|
gap: 20px;
|
|
}
|
|
|
|
.doc-card {
|
|
background: rgba(255,255,255,0.03);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 12px;
|
|
padding: 20px;
|
|
transition: all 0.2s;
|
|
text-decoration: none;
|
|
display: flex;
|
|
flex-direction: column;
|
|
}
|
|
|
|
.doc-card:hover {
|
|
border-color: #667eea;
|
|
transform: translateY(-2px);
|
|
box-shadow: 0 4px 12px rgba(102, 126, 234, 0.1);
|
|
}
|
|
|
|
.doc-icon-wrapper {
|
|
width: 60px;
|
|
height: 60px;
|
|
background: rgba(0,0,0,0.3);
|
|
border-radius: 8px;
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.doc-icon {
|
|
max-width: 100%;
|
|
max-height: 100%;
|
|
border-radius: 6px;
|
|
}
|
|
|
|
.doc-icon-placeholder {
|
|
font-size: 28px;
|
|
color: rgba(255,255,255,0.6);
|
|
}
|
|
|
|
.doc-title {
|
|
font-size: 18px;
|
|
font-weight: 600;
|
|
color: #fff;
|
|
margin: 0 0 8px;
|
|
}
|
|
|
|
.doc-description {
|
|
font-size: 14px;
|
|
color: rgba(255,255,255,0.7);
|
|
margin: 0;
|
|
flex-grow: 1;
|
|
}
|
|
|
|
.doc-view-container {
|
|
background: rgba(255,255,255,0.03);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 12px;
|
|
padding: 30px;
|
|
min-height: 400px;
|
|
}
|
|
|
|
.doc-view-container h1,
|
|
.doc-view-container h2,
|
|
.doc-view-container h3,
|
|
.doc-view-container h4 {
|
|
color: #fff;
|
|
}
|
|
|
|
.doc-view-container a {
|
|
color: #7fb3ff;
|
|
}
|
|
|
|
.doc-view-container code {
|
|
background: rgba(0,0,0,0.3);
|
|
padding: 2px 6px;
|
|
border-radius: 4px;
|
|
font-family: 'Courier New', monospace;
|
|
color: #a5b4fc;
|
|
}
|
|
|
|
.doc-view-container pre {
|
|
background: rgba(0,0,0,0.3);
|
|
padding: 15px;
|
|
border-radius: 8px;
|
|
overflow-x: auto;
|
|
}
|
|
|
|
.doc-view-container pre code {
|
|
background: none;
|
|
padding: 0;
|
|
}
|
|
|
|
.nav-links {
|
|
background: rgba(255,255,255,0.03);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 8px;
|
|
padding: 20px;
|
|
margin-bottom: 30px;
|
|
}
|
|
|
|
.nav-links h3 {
|
|
margin: 0 0 15px;
|
|
color: #667eea;
|
|
font-size: 18px;
|
|
}
|
|
|
|
.nav-links a {
|
|
display: inline-block;
|
|
padding: 8px 15px;
|
|
margin: 5px 10px 5px 0;
|
|
background: rgba(0,0,0,0.3);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 5px;
|
|
color: #7fb3ff;
|
|
text-decoration: none;
|
|
transition: all 0.2s;
|
|
}
|
|
|
|
.nav-links a:hover {
|
|
background: #667eea;
|
|
color: #fff;
|
|
border-color: #667eea;
|
|
}
|
|
|
|
.return-to-top {
|
|
text-align: center;
|
|
margin: 30px 0;
|
|
}
|
|
|
|
.return-to-top a {
|
|
display: inline-block;
|
|
padding: 10px 20px;
|
|
background: rgba(255,255,255,0.03);
|
|
border: 1px solid rgba(255,255,255,0.1);
|
|
border-radius: 8px;
|
|
color: #7fb3ff;
|
|
text-decoration: none;
|
|
transition: all 0.2s;
|
|
}
|
|
|
|
.return-to-top a:hover {
|
|
background: rgba(255,255,255,0.06);
|
|
border-color: #667eea;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<?php include(__DIR__ . '/includes/menu.php'); ?>
|
|
|
|
<div class="container">
|
|
<?php if ($action === 'view' && !empty($doc)): ?>
|
|
<!-- View specific documentation -->
|
|
<a href="<?php echo htmlspecialchars($docsPagePath, ENT_QUOTES, 'UTF-8'); ?>" class="back-button">← Back to Documentation List</a>
|
|
|
|
<div class="doc-view-container">
|
|
<?php
|
|
// Sanitize doc parameter to prevent directory traversal
|
|
$doc = basename($doc);
|
|
$docPath = $docsDir . '/' . $doc . '/index.php';
|
|
|
|
if (file_exists($docPath)) {
|
|
include($docPath);
|
|
} else {
|
|
echo '<p style="color: #ef4444;">Documentation not found.</p>';
|
|
}
|
|
?>
|
|
</div>
|
|
|
|
<?php else: ?>
|
|
<!-- List all documentation categories -->
|
|
<div class="header">
|
|
<h1 id="top">Documentation</h1>
|
|
<p>Browse our comprehensive documentation for game servers, panel features, and troubleshooting guides.</p>
|
|
</div>
|
|
|
|
<?php if (empty($grouped)): ?>
|
|
<div class="doc-view-container">
|
|
<p>No documentation available yet. Documentation folders should contain:</p>
|
|
<ul>
|
|
<li><code>index.php</code> - The documentation content</li>
|
|
<li><code>metadata.json</code> - Category and ordering information</li>
|
|
<li><code>icon.png</code> or <code>icon.jpg</code> - Category icon</li>
|
|
</ul>
|
|
</div>
|
|
<?php else: ?>
|
|
<!-- Navigation Links -->
|
|
<div class="nav-links">
|
|
<h3>Jump to Section:</h3>
|
|
<?php foreach ((array)$grouped as $category => $docs): ?>
|
|
<a href="#<?php echo htmlspecialchars($category); ?>">
|
|
<?php echo htmlspecialchars($categoryLabels[$category] ?? ucfirst($category)); ?>
|
|
(<?php echo count((array)$docs); ?>)
|
|
</a>
|
|
<?php endforeach; ?>
|
|
</div>
|
|
|
|
<?php foreach ((array)$grouped as $category => $docs): ?>
|
|
<div class="category-section" id="<?php echo htmlspecialchars($category); ?>">
|
|
<h2 class="category-title"><?php echo htmlspecialchars($categoryLabels[$category] ?? ucfirst($category)); ?></h2>
|
|
|
|
<div class="docs-grid">
|
|
<?php foreach ((array)$docs as $doc): ?>
|
|
<a href="<?php echo htmlspecialchars($docsPagePath . '?action=view&doc=' . urlencode($doc['folder']), ENT_QUOTES, 'UTF-8'); ?>" class="doc-card">
|
|
<div class="doc-icon-wrapper">
|
|
<?php if (!empty($doc['icon'])): ?>
|
|
<img src="<?php echo htmlspecialchars($doc['icon']); ?>" alt="" class="doc-icon">
|
|
<?php else: ?>
|
|
<span class="doc-icon-placeholder">📄</span>
|
|
<?php endif; ?>
|
|
</div>
|
|
|
|
<h3 class="doc-title"><?php echo htmlspecialchars($doc['name']); ?></h3>
|
|
<?php if (!empty($doc['description'])): ?>
|
|
<p class="doc-description"><?php echo htmlspecialchars($doc['description']); ?></p>
|
|
<?php endif; ?>
|
|
</a>
|
|
<?php endforeach; ?>
|
|
</div>
|
|
|
|
<div class="return-to-top">
|
|
<a href="#top">↑ Return to Top</a>
|
|
</div>
|
|
</div>
|
|
<?php endforeach; ?>
|
|
<?php endif; ?>
|
|
<?php endif; ?>
|
|
</div>
|
|
</body>
|
|
</html>
|