'broadcast_mode']); if (!empty($row) && $row['value'] === self::MODE_DRY_RUN) { return self::MODE_DRY_RUN; } return self::MODE_LIVE; } public static function setWorkerMode(string $mode): void { if (!in_array($mode, [self::MODE_LIVE, self::MODE_DRY_RUN], true)) { throw new InvalidArgumentException('Invalid broadcast mode'); } $table = table_by_key('config'); $row = db_query_one("SELECT value FROM $table WHERE name = :name", ['name' => 'broadcast_mode']); if (empty($row)) { db_execute("INSERT INTO $table (name, value) VALUES (:name, :value)", ['name' => 'broadcast_mode', 'value' => $mode]); } else { db_execute("UPDATE $table SET value = :value WHERE name = :name", ['name' => 'broadcast_mode', 'value' => $mode]); } } public static function isDryRunMode(): bool { return self::workerMode() === self::MODE_DRY_RUN; } public static function statusLabel(string $status): string { $PALANG = Config::read('__LANG'); $key = 'broadcast_status_' . $status; return $PALANG[$key] ?? $status; } public static function getBusyDomains(array $allowedDomains): array { if (empty($allowedDomains)) { return []; } $jobTable = table_by_key('broadcast_job'); $domainTable = table_by_key('broadcast_job_domain'); $params = []; $domainWhere = db_in_clause('d.domain', $allowedDomains, $params); $statusWhere = db_in_clause('j.status', self::activeStatuses(), $params); $rows = db_query_all( "SELECT DISTINCT d.domain FROM $domainTable d INNER JOIN $jobTable j ON d.job_id = j.id WHERE $statusWhere AND $domainWhere", $params ); return array_column($rows, 'domain'); } public static function buildRecipients(array $domains, bool $mailboxesOnly): array { if (empty($domains)) { return []; } $tableMailbox = table_by_key('mailbox'); $tableAlias = table_by_key('alias'); $params = ['active' => true]; $domainWhere = db_in_clause('domain', $domains, $params); $rows = db_query_all("SELECT username FROM $tableMailbox WHERE active = :active AND $domainWhere", $params); $recipients = array_column($rows, 'username'); if (!$mailboxesOnly) { $paramsAlias = ['active' => true]; $domainWhereAlias = db_in_clause('domain', $domains, $paramsAlias); $aliasRows = db_query_all("SELECT goto FROM $tableAlias WHERE active = :active AND $domainWhereAlias", $paramsAlias); foreach ($aliasRows as $row) { foreach (explode(',', (string)$row['goto']) as $goto) { $goto = trim($goto); if ($goto !== '' && !self::hasLineBreak($goto)) { $recipients[] = $goto; } } } } $recipients = array_values(array_unique($recipients)); sort($recipients); return $recipients; } public static function createJob(string $createdBy, string $sender, string $senderName, string $subject, string $body, array $domains, bool $mailboxesOnly, array $recipients): int { $pdo = db_connect(); $jobTable = table_by_key('broadcast_job'); $domainTable = table_by_key('broadcast_job_domain'); $recipientTable = table_by_key('broadcast_recipient'); $pdo->beginTransaction(); try { $stmt = $pdo->prepare( "INSERT INTO $jobTable (created_by, sender, sender_name, subject, body, mailboxes_only, status, total_count, sent_count, failed_count, cancelled_count, created, modified) " . "VALUES (:created_by, :sender, :sender_name, :subject, :body, :mailboxes_only, 'pending', :total_count, 0, 0, 0, " . self::nowSql() . ", " . self::nowSql() . ")" ); $stmt->execute([ 'created_by' => $createdBy, 'sender' => $sender, 'sender_name' => $senderName, 'subject' => $subject, 'body' => $body, 'mailboxes_only' => $mailboxesOnly ? 1 : 0, 'total_count' => count($recipients), ]); $jobId = (int)$pdo->lastInsertId(); $stmtDomain = $pdo->prepare("INSERT INTO $domainTable (job_id, domain, created) VALUES (:job_id, :domain, " . self::nowSql() . ")"); foreach ($domains as $domain) { $stmtDomain->execute(['job_id' => $jobId, 'domain' => $domain]); } $stmtRecipient = $pdo->prepare("INSERT INTO $recipientTable (job_id, recipient, status, created, modified) VALUES (:job_id, :recipient, 'pending', " . self::nowSql() . ", " . self::nowSql() . ")"); foreach ($recipients as $recipient) { $stmtRecipient->execute(['job_id' => $jobId, 'recipient' => $recipient]); } $pdo->commit(); return $jobId; } catch (Exception $e) { $pdo->rollBack(); throw $e; } } public static function getJobs(int $limit = 20, array $allowedDomains = [], bool $globalAdmin = true, string $username = ''): array { if (!$globalAdmin && ($username === '' || empty($allowedDomains))) { return []; } $jobTable = table_by_key('broadcast_job'); $limit = max(0, min($limit, 100)); $limitSql = $limit === 0 ? '' : " LIMIT $limit"; $params = []; $where = ''; if (!$globalAdmin) { $domainTable = table_by_key('broadcast_job_domain'); $params['created_by'] = $username; $domainWhere = db_in_clause('d.domain', $allowedDomains, $params); $where = " WHERE j.created_by = :created_by " . "AND EXISTS (SELECT 1 FROM $domainTable d WHERE d.job_id = j.id) " . "AND NOT EXISTS (SELECT 1 FROM $domainTable d WHERE d.job_id = j.id AND NOT ($domainWhere))"; } $jobs = db_query_all("SELECT j.* FROM $jobTable j$where ORDER BY j.id DESC$limitSql", $params); $visibleJobs = []; foreach ($jobs as $job) { if (!self::canManageJob($job, $allowedDomains, $globalAdmin, $username)) { continue; } $job['status_label'] = self::statusLabel($job['status']); $visibleJobs[] = $job; if ($limit !== 0 && count($visibleJobs) >= $limit) { break; } } return $visibleJobs; } public static function getJob(int $jobId): array { $jobTable = table_by_key('broadcast_job'); $job = db_query_one("SELECT * FROM $jobTable WHERE id = :id", ['id' => $jobId]); if (empty($job)) { return []; } $job['status_label'] = self::statusLabel($job['status']); return $job; } public static function getJobDomains(int $jobId): array { $domainTable = table_by_key('broadcast_job_domain'); $rows = db_query_all("SELECT domain FROM $domainTable WHERE job_id = :job_id ORDER BY domain", ['job_id' => $jobId]); return array_column($rows, 'domain'); } public static function canAccessJob(int $jobId, array $allowedDomains = [], bool $globalAdmin = true, string $username = ''): bool { return self::canManageJob(self::getJob($jobId), $allowedDomains, $globalAdmin, $username); } private static function canManageJob(array $job, array $allowedDomains, bool $globalAdmin, string $username): bool { if ($globalAdmin) { return !empty($job); } if (empty($job) || $username === '' || $job['created_by'] !== $username) { return false; } $jobDomains = self::getJobDomains((int)$job['id']); if (empty($jobDomains)) { return false; } return count(array_diff($jobDomains, $allowedDomains)) === 0; } public static function getUnknownCount(int $jobId): int { $recipientTable = table_by_key('broadcast_recipient'); $row = db_query_one("SELECT COUNT(*) AS count FROM $recipientTable WHERE job_id = :job_id AND status = 'unknown'", ['job_id' => $jobId]); return (int)$row['count']; } public static function getUnknownRecipients(int $jobId): array { $recipientTable = table_by_key('broadcast_recipient'); return db_query_all( "SELECT id, recipient, smtp_response FROM $recipientTable WHERE job_id = :job_id AND status = 'unknown' ORDER BY id", ['job_id' => $jobId] ); } public static function resolveUnknown(int $jobId, int $recipientId, string $action, array $allowedDomains = [], bool $globalAdmin = true, string $username = ''): bool { if (!in_array($action, ['retry', 'discard'], true)) { return false; } $job = self::getJob($jobId); if (!self::canManageJob($job, $allowedDomains, $globalAdmin, $username)) { return false; } $recipientTable = table_by_key('broadcast_recipient'); $jobTable = table_by_key('broadcast_job'); $recipient = db_query_one( "SELECT smtp_response FROM $recipientTable WHERE id = :id AND job_id = :job_id AND status = 'unknown'", ['id' => $recipientId, 'job_id' => $jobId] ); if (empty($recipient)) { return false; } if ($action === 'retry') { if ($job['status'] === 'cancelling') { return false; } $busy = self::getBusyDomains(self::getJobDomains($jobId)); if (!empty($busy) && !in_array($job['status'], self::activeStatuses(), true)) { return false; } } $pdo = db_connect(); $pdo->beginTransaction(); try { if ($action === 'retry') { db_execute( "UPDATE $recipientTable SET status = 'pending', error = NULL, smtp_response = NULL, modified = " . self::nowSql() . " WHERE id = :id AND job_id = :job_id AND status = 'unknown'", ['id' => $recipientId, 'job_id' => $jobId], true ); db_execute( "UPDATE $jobTable SET status = 'pending', cancel_requested = 0, modified = " . self::nowSql() . " WHERE id = :id AND status IN ('finished', 'cancelled')", ['id' => $jobId], true ); } else { db_execute( "UPDATE $recipientTable SET status = 'cancelled', error = NULL, modified = " . self::nowSql() . " WHERE id = :id AND job_id = :job_id AND status = 'unknown'", ['id' => $recipientId, 'job_id' => $jobId], true ); } self::updateCounters($jobId, true); $pdo->commit(); } catch (Throwable $e) { $pdo->rollBack(); throw $e; } $reference = $recipient['smtp_response'] ?: 'no Message-ID recorded'; error_log("PostfixAdmin broadcast: job $jobId recipient $recipientId ($reference) manually $action"); return true; } public static function getRecipients(int $jobId, int $limit = 200, int $offset = 0): array { $recipientTable = table_by_key('broadcast_recipient'); $limit = max(1, min($limit, 1000)); $offset = max(0, $offset); $recipients = db_query_all("SELECT * FROM $recipientTable WHERE job_id = :job_id ORDER BY id LIMIT $limit OFFSET $offset", ['job_id' => $jobId]); foreach ($recipients as $key => $recipient) { $recipients[$key]['status_label'] = self::statusLabel($recipient['status']); } return $recipients; } public static function requestCancel(int $jobId, array $allowedDomains = [], bool $globalAdmin = true, string $username = '', bool $finaliseIfIdle = true): bool { $job = self::getJob($jobId); if (!self::canManageJob($job, $allowedDomains, $globalAdmin, $username)) { return false; } $jobTable = table_by_key('broadcast_job'); $params = ['id' => $jobId]; $statusWhere = db_in_clause('status', self::activeStatuses(), $params); db_execute("UPDATE $jobTable SET status = 'cancelling', cancel_requested = 1, modified = " . self::nowSql() . " WHERE id = :id AND $statusWhere", $params); // An active batch notices the flag and finalises the job itself. If no // batch is running, finalise the cancellation immediately. if ($finaliseIfIdle) { $lock = self::acquireProcessLock(); if ($lock !== null) { try { $fresh = self::getJob($jobId); if (!empty($fresh) && $fresh['status'] === 'cancelling') { self::cancelPending($jobId); } } finally { self::releaseProcessLock($lock); } } } return true; } /** * Try to take the (non-blocking) processing lock. * * @return resource|null the lock handle, or null if another batch holds it */ public static function acquireProcessLock() { $path = sys_get_temp_dir() . '/postfixadmin-broadcast-queue.lock'; if (file_exists($path) ? !is_writable($path) : !is_writable(dirname($path))) { error_log("PostfixAdmin broadcast: cannot write processing lock file $path"); return null; } $lock = fopen($path, 'c'); if ($lock === false) { return null; } if (!flock($lock, LOCK_EX | LOCK_NB)) { fclose($lock); return null; } return $lock; } /** * @param resource $lock */ public static function releaseProcessLock($lock): void { flock($lock, LOCK_UN); fclose($lock); } public static function resetInactive(array $allowedDomains = [], bool $globalAdmin = true, string $username = ''): void { $jobTable = table_by_key('broadcast_job'); $domainTable = table_by_key('broadcast_job_domain'); $recipientTable = table_by_key('broadcast_recipient'); $jobs = self::getJobs(0, $allowedDomains, $globalAdmin, $username); $jobIds = []; foreach ($jobs as $job) { $jobId = (int)$job['id']; if (self::getUnknownCount($jobId) === 0 && !in_array(self::getJob($jobId)['status'], self::activeStatuses(), true)) { $jobIds[] = $jobId; } } if (empty($jobIds)) { return; } $pdo = db_connect(); $pdo->beginTransaction(); try { $params = []; $jobWhere = db_in_clause('job_id', $jobIds, $params); db_execute("DELETE FROM $recipientTable WHERE $jobWhere", $params, true); db_execute("DELETE FROM $domainTable WHERE $jobWhere", $params, true); $params = []; $idWhere = db_in_clause('id', $jobIds, $params); db_execute("DELETE FROM $jobTable WHERE $idWhere", $params, true); $pdo->commit(); } catch (Throwable $e) { $pdo->rollBack(); throw $e; } } public static function recoverInterrupted(int $jobId): void { $recipientTable = table_by_key('broadcast_recipient'); $interrupted = db_query_all( "SELECT id, smtp_response FROM $recipientTable WHERE job_id = :job_id AND status = 'sending'", ['job_id' => $jobId] ); if (empty($interrupted)) { return; } $pdo = db_connect(); $pdo->beginTransaction(); try { db_execute( "UPDATE $recipientTable SET status = 'unknown', error = :error, modified = " . self::nowSql() . " WHERE job_id = :job_id AND status = 'sending'", ['job_id' => $jobId, 'error' => 'Submission interrupted; check SMTP logs before deciding whether to resend'], true ); self::updateCounters($jobId, true); $pdo->commit(); } catch (Throwable $e) { $pdo->rollBack(); throw $e; } foreach ($interrupted as $recipient) { $reference = $recipient['smtp_response'] ?: 'no Message-ID recorded'; error_log("PostfixAdmin broadcast: job $jobId recipient {$recipient['id']} ($reference) has an unknown SMTP result; check SMTP logs before any manual retry"); } } public static function processNext(int $limit = 50, ?bool $dryRun = null, ?int $jobId = null): array { $dryRun = $dryRun ?? self::isDryRunMode(); $jobTable = table_by_key('broadcast_job'); $recipientTable = table_by_key('broadcast_recipient'); $processed = 0; $sent = 0; $failed = 0; $job = $jobId === null ? db_query_one("SELECT * FROM $jobTable WHERE status IN ('pending', 'running', 'cancelling') ORDER BY id ASC LIMIT 1") : db_query_one("SELECT * FROM $jobTable WHERE id = :id AND status IN ('pending', 'running', 'cancelling')", ['id' => $jobId]); if (empty($job)) { return ['job_id' => 0, 'processed' => 0, 'sent' => 0, 'failed' => 0, 'status' => 'idle']; } $jobId = (int)$job['id']; if ($job['status'] === 'cancelling' || (int)$job['cancel_requested'] === 1) { self::cancelPending($jobId); return ['job_id' => $jobId, 'processed' => 0, 'sent' => 0, 'failed' => 0, 'status' => 'cancelled']; } db_execute("UPDATE $jobTable SET started = CASE WHEN status = 'pending' THEN " . self::nowSql() . " ELSE started END, status = 'running', modified = " . self::nowSql() . " WHERE id = :id", ['id' => $jobId]); $limit = max(1, min($limit, 500)); $items = db_query_all("SELECT * FROM $recipientTable WHERE job_id = :job_id AND status = 'pending' ORDER BY id LIMIT $limit", ['job_id' => $jobId]); foreach ($items as $item) { $freshJob = self::getJob($jobId); if (!empty($freshJob) && ((int)$freshJob['cancel_requested'] === 1 || $freshJob['status'] === 'cancelling')) { self::cancelPending($jobId); break; } $recipientId = (int)$item['id']; $recipient = $item['recipient']; $messageId = ''; $invalidRecipient = self::hasLineBreak($recipient) || filter_var($recipient, FILTER_VALIDATE_EMAIL) === false; if ($invalidRecipient) { $ok = false; } else { db_execute("UPDATE $recipientTable SET status = 'sending', smtp_response = :message_id, modified = " . self::nowSql() . " WHERE id = :id", ['id' => $recipientId, 'message_id' => 'Message-ID: ' . $messageId], true); $ok = $dryRun ? true : self::sendRecipient($job, $recipient, $messageId); } $pdo = db_connect(); $pdo->beginTransaction(); try { if ($ok) { db_execute("UPDATE $recipientTable SET status = 'sent', smtp_response = :response, sent_at = " . self::nowSql() . ", modified = " . self::nowSql() . " WHERE id = :id", ['id' => $recipientId, 'response' => ($dryRun ? 'dry-run; ' : 'accepted by SMTP; ') . 'Message-ID: ' . $messageId], true); } else { db_execute("UPDATE $recipientTable SET status = 'failed', error = :error, modified = " . self::nowSql() . " WHERE id = :id", ['id' => $recipientId, 'error' => $invalidRecipient ? 'Invalid recipient address' : 'SMTP submission failed'], true); } self::updateCounters($jobId, true); $pdo->commit(); } catch (Throwable $e) { $pdo->rollBack(); throw $e; } $processed++; $sent += (int)$ok; $failed += (int)!$ok; } $freshJob = self::getJob($jobId); if (!empty($freshJob) && (int)$freshJob['cancel_requested'] === 1) { self::cancelPending($jobId); } else { self::finishIfDone($jobId); } $finalJob = self::getJob($jobId); return ['job_id' => $jobId, 'processed' => $processed, 'sent' => $sent, 'failed' => $failed, 'status' => $finalJob['status'] ?? 'unknown']; } private static function sendRecipient(array $job, string $recipient, string $messageId): bool { if (self::hasLineBreak($recipient)) { return false; } mb_internal_encoding('UTF-8'); $sender = $job['sender']; $name = mb_encode_mimeheader(self::headerValue($job['sender_name']), 'UTF-8', 'Q'); $subject = mb_encode_mimeheader(self::headerValue($job['subject']), 'UTF-8', 'Q'); $message = chunk_split(base64_encode($job['body'])); $headers = 'To: ' . $recipient . "\n"; $headers .= 'From: ' . $name . ' <' . $sender . ">\n"; $headers .= 'Subject: ' . $subject . "\n"; $headers .= 'MIME-Version: 1.0' . "\n"; $headers .= 'Content-Type: text/plain; charset=UTF-8' . "\n"; $headers .= 'Content-Transfer-Encoding: base64' . "\n"; $headers .= 'Date: ' . date('r', time()) . "\n"; $headers .= 'Message-ID: ' . $messageId . "\n\n"; $headers .= $message; return smtp_mail($recipient, $sender, $headers); } private static function cancelPending(int $jobId): void { $jobTable = table_by_key('broadcast_job'); $recipientTable = table_by_key('broadcast_recipient'); self::recoverInterrupted($jobId); $pdo = db_connect(); $pdo->beginTransaction(); try { db_execute("UPDATE $recipientTable SET status = 'cancelled', modified = " . self::nowSql() . " WHERE job_id = :job_id AND status = 'pending'", ['job_id' => $jobId], true); self::updateCounters($jobId, true); db_execute("UPDATE $jobTable SET status = 'cancelled', finished = " . self::nowSql() . ", modified = " . self::nowSql() . " WHERE id = :id", ['id' => $jobId], true); $pdo->commit(); } catch (Throwable $e) { $pdo->rollBack(); throw $e; } } private static function finishIfDone(int $jobId): void { $jobTable = table_by_key('broadcast_job'); $recipientTable = table_by_key('broadcast_recipient'); $pending = db_query_one("SELECT COUNT(*) AS count FROM $recipientTable WHERE job_id = :job_id AND status IN ('pending', 'sending')", ['job_id' => $jobId]); if ((int)$pending['count'] === 0) { self::updateCounters($jobId); db_execute("UPDATE $jobTable SET status = 'finished', finished = " . self::nowSql() . ", modified = " . self::nowSql() . " WHERE id = :id AND status != 'cancelled'", ['id' => $jobId]); } } private static function updateCounters(int $jobId, bool $throwExceptions = false): void { $jobTable = table_by_key('broadcast_job'); $recipientTable = table_by_key('broadcast_recipient'); $rows = db_query_all("SELECT status, COUNT(*) AS count FROM $recipientTable WHERE job_id = :job_id GROUP BY status", ['job_id' => $jobId]); $counts = ['sent' => 0, 'failed' => 0, 'cancelled' => 0]; foreach ($rows as $row) { if (isset($counts[$row['status']])) { $counts[$row['status']] = (int)$row['count']; } } db_execute("UPDATE $jobTable SET sent_count = :sent, failed_count = :failed, cancelled_count = :cancelled, modified = " . self::nowSql() . " WHERE id = :id", ['id' => $jobId, 'sent' => $counts['sent'], 'failed' => $counts['failed'], 'cancelled' => $counts['cancelled']], $throwExceptions); } private static function nowSql(): string { return db_sqlite() ? "datetime('now')" : 'now()'; } private static function headerValue(string $value): string { return str_replace(["\r", "\n"], ' ', $value); } private static function hasLineBreak(string $value): bool { return str_contains($value, "\r") || str_contains($value, "\n"); } }