mirror of
https://github.com/Shadowss/TravianZ.git
synced 2026-07-24 05:26:19 +00:00
Add Cron Jobs for Automation
Add Cron Jobs for Automation
This commit is contained in:
novgorodschi catalin
@@ -3,18 +3,40 @@
|
||||
#################################################################################
|
||||
## -= YOU MAY NOT REMOVE OR CHANGE THIS NOTICE =- ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## Filename : cron.php ##
|
||||
## Type : Standalone automation runner (P2 - performance) ##
|
||||
## Filename : cron.php ##
|
||||
## Type : Standalone automation runner (P2 - Performance) ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## Scop : Ruleaza Automation.php separat de request-urile ##
|
||||
## jucatorilor. Se apeleaza dintr-un cron job cPanel la ##
|
||||
## fiecare minut, astfel incat procesarea (batalii, miscari, ##
|
||||
## antrenamente) nu mai e carata de pagina unui jucator. ##
|
||||
## Purpose : Runs Automation.php independently from player requests ##
|
||||
## so processing (battles, troop movements, training, etc.) ##
|
||||
## is no longer handled by a player's page request. ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## Instalare cron cPanel (la fiecare minut): ##
|
||||
## * * * * * /usr/bin/php /home/USER/public_html/cron.php >/dev/null 2>&1 ##
|
||||
## sau prin wget/curl daca php-cli nu e disponibil: ##
|
||||
## * * * * * wget -q -O /dev/null "https://DOMENIU/cron.php?key=SECRET" ##
|
||||
## WHY AN INTERNAL LOOP: ##
|
||||
## Automation is designed to run approximately every 60 seconds (its ##
|
||||
## internal guard checks "time() - filemtime > 60"). Many cPanel hosting ##
|
||||
## providers do not allow 1-minute cron jobs, only a minimum interval of ##
|
||||
## 5 minutes. If Automation were executed only once every 5 minutes, ##
|
||||
## attacks and building completions could be delayed by up to 5 minutes. ##
|
||||
## For this reason, a single cron invocation performs one TICK every 60 ##
|
||||
## seconds for approximately 5 minutes, then exits and waits for the next ##
|
||||
## scheduled cron execution. ##
|
||||
## ##
|
||||
## Each tick rewrites Prevention/cron_active.txt, keeping the marker file ##
|
||||
## fresh so player page requests will no longer trigger Automation at all. ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## cPanel Cron Installation (every 5 minutes - recommended with the ##
|
||||
## internal loop): ##
|
||||
##*/5 * * * * /usr/local/bin/php /home/USER/public_html/cron.php>/dev/null 2>&1##
|
||||
## ##
|
||||
## If your hosting provider allows a 1-minute cron, set the Minute field to ##
|
||||
## "*" and add the following to GameEngine/config.php: ##
|
||||
## define('CRON_LOOP_SECONDS', 0); ##
|
||||
## (0 = a single tick per invocation, without the internal loop) ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## Optional configuration in GameEngine/config.php: ##
|
||||
## define('CRON_LOOP_SECONDS', 300); // Duration of one invocation ##
|
||||
## // (0 = single tick) ##
|
||||
## define('CRON_TICK_SECONDS', 60); // Tick interval inside the loop ##
|
||||
## define('CRON_KEY', 'secret'); // Required only for HTTP execution ##
|
||||
## --------------------------------------------------------------------------- ##
|
||||
## Contact : cata7007@gmail.com ##
|
||||
## Project : TravianZ ##
|
||||
@@ -22,18 +44,44 @@
|
||||
#################################################################################
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 1. Detectare mod de rulare
|
||||
// - CLI (php cron.php): mereu permis, e apelat doar de cron-ul serverului.
|
||||
// - HTTP (wget/curl): permis DOAR daca cheia din config se potriveste, ca sa
|
||||
// nu poata declansa oricine automation-ul de pe internet.
|
||||
// 1. Execution Mode
|
||||
// - CLI (php cron.php): Invoked by the server's cron scheduler and always
|
||||
// allowed.
|
||||
// - HTTP (wget/curl): Allowed ONLY when the correct CRON_KEY is provided,
|
||||
// preventing anyone on the Internet from triggering Automation.
|
||||
// - "--once" / "?once=1": Executes a single tick without the internal loop
|
||||
// (useful for a "Force Run" button in the admin panel).
|
||||
// -----------------------------------------------------------------------------
|
||||
$isCli = (PHP_SAPI === 'cli');
|
||||
|
||||
if ($isCli) {
|
||||
$forceSingleTick = isset($argv) && in_array('--once', $argv, true);
|
||||
} else {
|
||||
$forceSingleTick = isset($_GET['once']);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 2. Bootstrap minimal - NU includem Session.php (porneste sesiune, se leaga de
|
||||
// request si de un user logat). Automation are nevoie doar de config (constante
|
||||
// SQL_*, TB_PREFIX, AUTOMATION_LOCK_FILE_NAME) si de $database; restul (buidata,
|
||||
// unitdata, Units, Battle, etc.) si le include Automation.php singur.
|
||||
// 1b. IMPORTANT: The server's cron launches this script with the current working
|
||||
// directory set to the account's HOME directory (e.g. /home/user), NOT the
|
||||
// game's directory. Without the line below, the relative lookups in step 2
|
||||
// (file_exists('autoloader.php'), etc.) fail, the script exits with exit(1),
|
||||
// and the error message is swallowed by ">/dev/null"—making it appear that
|
||||
// the cron job "does nothing" with no trace in the logs.
|
||||
// This problem does not occur when accessed via HTTP (where the current
|
||||
// working directory is the script's directory), which is why running it from
|
||||
// the browser works while the cron job does not.
|
||||
// -----------------------------------------------------------------------------
|
||||
if (@chdir(__DIR__) === false) {
|
||||
if ($isCli) { fwrite(STDERR, "cron: unable to change to directory " . __DIR__ . "\n"); }
|
||||
exit(1);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 2. Minimal Bootstrap
|
||||
// - We do NOT include Session.php, as it starts a session and is tied to
|
||||
// HTTP requests and authenticated users.
|
||||
// - Automation.php loads everything else it needs on its own
|
||||
// (buidata, unitdata, Units, Battle, etc.).
|
||||
// -----------------------------------------------------------------------------
|
||||
$autoprefix = '';
|
||||
for ($i = 0; $i < 5; $i++) {
|
||||
@@ -46,7 +94,7 @@ for ($i = 0; $i < 5; $i++) {
|
||||
require_once($autoprefix . 'autoloader.php');
|
||||
|
||||
if (!file_exists($autoprefix . 'GameEngine/config.php')) {
|
||||
// instalarea nu e finalizata - nu avem ce rula
|
||||
// Installation is not yet complete - there is nothing to run.
|
||||
if ($isCli) { fwrite(STDERR, "cron: config.php lipseste, jocul nu e instalat\n"); }
|
||||
exit(1);
|
||||
}
|
||||
@@ -54,61 +102,185 @@ if (!file_exists($autoprefix . 'GameEngine/config.php')) {
|
||||
include_once($autoprefix . 'GameEngine/config.php');
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 3. Verificare cheie pentru accesul HTTP (nu se aplica in CLI)
|
||||
// Defineste in GameEngine/config.php: define('CRON_KEY', 'un-secret-lung');
|
||||
// Apoi apeleaza: https://domeniu/cron.php?key=un-secret-lung
|
||||
// Daca CRON_KEY nu e definit, accesul HTTP este refuzat (doar CLI merge).
|
||||
// 3. Verify the access key for HTTP requests (not applicable in CLI mode)
|
||||
// -----------------------------------------------------------------------------
|
||||
if (!$isCli) {
|
||||
$providedKey = isset($_GET['key']) ? (string)$_GET['key'] : '';
|
||||
|
||||
if (!defined('CRON_KEY') || CRON_KEY === '' || !hash_equals(CRON_KEY, $providedKey)) {
|
||||
header('HTTP/1.1 403 Forbidden');
|
||||
exit('Forbidden');
|
||||
}
|
||||
// nu tinem conexiunea deschisa pentru client - raspundem si continuam in fundal
|
||||
// Do not keep the client connection open - send the response immediately and continue processing in the background.
|
||||
ignore_user_abort(true);
|
||||
@set_time_limit(0);
|
||||
header('Content-Type: text/plain');
|
||||
echo "OK\n";
|
||||
|
||||
if (function_exists('fastcgi_finish_request')) {
|
||||
fastcgi_finish_request();
|
||||
}
|
||||
|
||||
// When executed via HTTP, we do not keep the process running for 5 minutes
|
||||
// (PHP-FPM has its own execution timeouts).
|
||||
// An HTTP request performs only a single tick.
|
||||
// The internal loop is intended for CLI execution only.
|
||||
$forceSingleTick = true;
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 4. Conexiune la baza de date (acelasi mod ca in Database.php - variabila globala
|
||||
// $database folosita de Automation prin "global $database").
|
||||
// 4. Loop Parameters
|
||||
// -----------------------------------------------------------------------------
|
||||
$loopSeconds = defined('CRON_LOOP_SECONDS') ? (int)CRON_LOOP_SECONDS : 300;
|
||||
$tickSeconds = defined('CRON_TICK_SECONDS') ? (int)CRON_TICK_SECONDS : 60;
|
||||
|
||||
if ($tickSeconds < 15) { $tickSeconds = 15; } // sub 15s nu aduce nimic, doar incarca serverul
|
||||
if ($loopSeconds < 0) { $loopSeconds = 0; }
|
||||
if ($forceSingleTick) { $loopSeconds = 0; }
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 5. Overlap Lock
|
||||
// If the previous invocation is still running its loop (e.g., on a slow
|
||||
// server), the next invocation exits immediately instead of processing
|
||||
// everything twice. The flock() lock is automatically released, even if
|
||||
// the process terminates unexpectedly.
|
||||
// -----------------------------------------------------------------------------
|
||||
$runLockPath = $autoprefix . 'GameEngine/Prevention/cron_running.lock';
|
||||
$runLockHandle = @fopen($runLockPath, 'c');
|
||||
|
||||
if ($runLockHandle === false) {
|
||||
if ($isCli) { fwrite(STDERR, "cron: nu pot deschide lock-ul ($runLockPath)\n"); }
|
||||
exit(1);
|
||||
}
|
||||
|
||||
if (!flock($runLockHandle, LOCK_EX | LOCK_NB)) {
|
||||
fclose($runLockHandle);
|
||||
if ($isCli) { echo "cron: o invocare anterioara inca ruleaza, ies\n"; }
|
||||
exit(0);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 6. Database Connection
|
||||
// Initializes the database connection ($database), which is accessed by
|
||||
// Automation.php through the global scope.
|
||||
// -----------------------------------------------------------------------------
|
||||
include_once($autoprefix . 'GameEngine/Database.php');
|
||||
|
||||
if (!isset($database) || !$database) {
|
||||
if ($isCli) { fwrite(STDERR, "cron: conexiunea la baza de date a esuat\n"); }
|
||||
flock($runLockHandle, LOCK_UN);
|
||||
fclose($runLockHandle);
|
||||
exit(1);
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 5. Marcam ca suntem sursa oficiala de automation. AUTOMATION_MANUAL_RUN spune
|
||||
// Automation.php sa NU mai treaca prin gardul de lock file (acela era pentru
|
||||
// coordonarea request-urilor concurente ale jucatorilor; cron-ul e sursa unica,
|
||||
// o data pe minut, deci nu are nevoie de el).
|
||||
//
|
||||
// In plus scriem un marker cu timestamp, ca Village.php sa stie ca exista un
|
||||
// cron activ si sa NU mai declanseze automation din paginile jucatorilor
|
||||
// (fallback: daca cron-ul se opreste > 90s, paginile preiau automat).
|
||||
// -----------------------------------------------------------------------------
|
||||
// AUTOMATION_MANUAL_RUN tells Automation.php to bypass its own lock-file guard.
|
||||
// That guard is designed to coordinate concurrent player requests, whereas
|
||||
// this script is the only execution source and is already protected by the
|
||||
// overlap lock implemented above.
|
||||
if (!defined('AUTOMATION_MANUAL_RUN')) {
|
||||
define('AUTOMATION_MANUAL_RUN', true);
|
||||
}
|
||||
|
||||
$cronMarker = $autoprefix . 'GameEngine/Prevention/cron_active.txt';
|
||||
@file_put_contents($cronMarker, (string)time(), LOCK_EX);
|
||||
$cronMarkerPath = $autoprefix . 'GameEngine/Prevention/cron_active.txt';
|
||||
|
||||
/**
|
||||
* Clears the database class's request-level caches.
|
||||
*
|
||||
* The static caches in MYSQLi_DB are designed to live only for the duration
|
||||
* of a single request. In a process that executes multiple ticks in sequence,
|
||||
* they would remain populated, causing subsequent ticks to operate on stale
|
||||
* data (for example, building levels already modified by the previous tick).
|
||||
* Therefore, the caches are reset between ticks so that each tick starts with
|
||||
* the same clean state as a new request.
|
||||
*
|
||||
* Only static array properties whose names contain "cache" are reset.
|
||||
*/
|
||||
function cron_reset_db_caches()
|
||||
{
|
||||
if (!class_exists('MYSQLi_DB')) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$ref = new ReflectionClass('MYSQLi_DB');
|
||||
|
||||
foreach ($ref->getProperties(ReflectionProperty::IS_STATIC) as $prop) {
|
||||
if (stripos($prop->getName(), 'cache') === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$prop->setAccessible(true);
|
||||
|
||||
if (is_array($prop->getValue())) {
|
||||
$prop->setValue(null, []);
|
||||
}
|
||||
}
|
||||
} catch (Throwable $e) {
|
||||
// If reflection fails, it is better to continue than to stop Automation.
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A tick represents one complete execution of Automation.
|
||||
*
|
||||
* The first tick includes Automation.php (the file ends with "new Automation",
|
||||
* so including it starts the processing automatically). Subsequent ticks simply
|
||||
* instantiate the Automation class again, since include_once would not execute
|
||||
* the file a second time.
|
||||
*/
|
||||
function cron_run_tick(&$firstTick, $autoprefix, $cronMarkerPath)
|
||||
{
|
||||
@file_put_contents($cronMarkerPath, (string)time(), LOCK_EX);
|
||||
|
||||
if ($firstTick) {
|
||||
include_once($autoprefix . 'GameEngine/Automation.php');
|
||||
$firstTick = false;
|
||||
return;
|
||||
}
|
||||
|
||||
cron_reset_db_caches();
|
||||
new Automation();
|
||||
}
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 6. Rulam automation-ul propriu-zis. Constructorul din Automation.php face toata
|
||||
// treaba (procNewClimbers, buildComplete, trainingComplete, batalii, miscari...).
|
||||
// 7. Execution
|
||||
// -----------------------------------------------------------------------------
|
||||
include_once($autoprefix . 'GameEngine/Automation.php');
|
||||
$firstTick = true;
|
||||
$startedAt = time();
|
||||
$ticks = 0;
|
||||
|
||||
do {
|
||||
$tickStart = time();
|
||||
|
||||
cron_run_tick($firstTick, $autoprefix, $cronMarkerPath);
|
||||
$ticks++;
|
||||
|
||||
if ($loopSeconds <= 0) {
|
||||
break;
|
||||
}
|
||||
|
||||
// Is there enough time remaining in the invocation budget for another complete tick?
|
||||
$elapsed = time() - $startedAt;
|
||||
if (($elapsed + $tickSeconds) >= $loopSeconds) {
|
||||
break;
|
||||
}
|
||||
|
||||
// Sleep until the next tick, subtracting the time spent executing the current tick.
|
||||
$spent = time() - $tickStart;
|
||||
$sleep = $tickSeconds - $spent;
|
||||
|
||||
if ($sleep > 0) {
|
||||
sleep($sleep);
|
||||
}
|
||||
|
||||
} while (true);
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// 8. Release the Lock
|
||||
// -----------------------------------------------------------------------------
|
||||
flock($runLockHandle, LOCK_UN);
|
||||
fclose($runLockHandle);
|
||||
|
||||
if ($isCli) {
|
||||
echo "cron: automation rulat la " . date('Y-m-d H:i:s') . "\n";
|
||||
echo "cron: " . $ticks . " tick(uri) in " . (time() - $startedAt) . "s, terminat la " . date('Y-m-d H:i:s') . "\n";
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user