Add UI log for internal PDF generation

Author: dimaip

Packages/Application/Sfi.Umo/Classes/Controller/BackendController.php

@@ -138,7 +138,14 @@ class BackendController extends AbstractModuleController
     /**
      * @return void
      */
-    public function indexAction() {}
+    public function indexAction()
+    {
+        $logPath = $this->getInternalSignedPdfsLogPath();
+
+        $this->view->assign('internalSignedPdfsBasePath', $this->getInternalSignedPdfsBasePath());
+        $this->view->assign('internalSignedPdfsLogPath', $logPath);
+        $this->view->assign('internalSignedPdfsLog', $this->readLogTail($logPath));
+    }
 
     /**
      * Trigger background generation of watermarked signed PDFs
@@ -159,11 +166,144 @@ public function generateSignedPdfsAction()
      */
     public function generateInternalSignedPdfsAction()
     {
+        $basePath = $this->getInternalSignedPdfsBasePath();
+        $logPath = $this->getInternalSignedPdfsLogPath();
+
+        if (!$this->appendInternalSignedPdfsLog(sprintf('Запуск генерации внутренних подписанных PDF из интерфейса. Папка: %s', $basePath))) {
+            $this->addFlashMessage(
+                'Не удалось записать лог внутренних подписанных PDF: %s',
+                'Ошибка записи лога',
+                \Neos\Error\Messages\Message::SEVERITY_WARNING,
+                [$logPath]
+            );
+        }
+
         Scripts::executeCommandAsync('sfi.sfi:signature:generateinternalsignedpdfs', $this->flowSettings, []);
-        $this->addFlashMessage('Генерация внутренних подписанных PDF запущена в фоновом режиме. Результаты будут сохранены в /data/www-provisioned/Web/umo/internal/*/signed/');
+        $this->addFlashMessage(sprintf('Генерация внутренних подписанных PDF запущена в фоновом режиме. Результаты будут сохранены в %s/*/signed/. Лог: %s', $basePath, $logPath));
         $this->redirect('index');
     }
 
+    /**
+     * Check internal signed PDF input folders without generating files
+     *
+     * @return void
+     */
+    public function dryRunInternalSignedPdfsAction()
+    {
+        $basePath = $this->getInternalSignedPdfsBasePath();
+        $logPath = $this->getInternalSignedPdfsLogPath();
+
+        $this->appendInternalSignedPdfsLog(sprintf('Проверка внутренних PDF без генерации запущена из интерфейса. Папка: %s', $basePath));
+
+        $bufferLevel = ob_get_level();
+        ob_start();
+
+        try {
+            Scripts::executeCommand('sfi.sfi:signature:generateinternalsignedpdfs', $this->flowSettings, true, ['dry-run' => 'true']);
+            $output = trim($this->collectOutputBuffer($bufferLevel));
+
+            $this->appendInternalSignedPdfsLog($output !== '' ? "Результат проверки:\n" . $output : 'Результат проверки: команда не вернула вывода.');
+            $this->addFlashMessage(sprintf('Проверка внутренних PDF завершена. Результат записан в лог: %s', $logPath));
+        } catch (\Exception $exception) {
+            $output = trim($this->collectOutputBuffer($bufferLevel));
+            $message = 'Ошибка проверки внутренних PDF: ' . $exception->getMessage();
+            if ($output !== '') {
+                $message .= "\nВывод команды:\n" . $output;
+            }
+            $this->appendInternalSignedPdfsLog($message);
+            $this->addFlashMessage(
+                'Проверка внутренних PDF завершилась с ошибкой. Подробности записаны в лог: %s',
+                'Ошибка проверки',
+                \Neos\Error\Messages\Message::SEVERITY_ERROR,
+                [$logPath]
+            );
+        }
+
+        $this->redirect('index');
+    }
+
+    protected function getInternalSignedPdfsBasePath(): string
+    {
+        return rtrim(FLOW_PATH_WEB, '/') . '/umo/internal';
+    }
+
+    protected function getInternalSignedPdfsLogPath(): string
+    {
+        return $this->getInternalSignedPdfsBasePath() . '/generation.log';
+    }
+
+    protected function appendInternalSignedPdfsLog(string $message): bool
+    {
+        $message = trim($message);
+        if ($message === '') {
+            return true;
+        }
+
+        $basePath = $this->getInternalSignedPdfsBasePath();
+        if (!is_dir($basePath) && !@mkdir($basePath, 0775, true) && !is_dir($basePath)) {
+            return false;
+        }
+
+        $timestamp = date('Y-m-d H:i:s');
+        $entry = '';
+        foreach (preg_split('/\r\n|\r|\n/', $message) as $line) {
+            $entry .= $timestamp . ' ' . $line . PHP_EOL;
+        }
+
+        return @file_put_contents($this->getInternalSignedPdfsLogPath(), $entry, FILE_APPEND | LOCK_EX) !== false;
+    }
+
+    protected function readLogTail(string $logPath, int $maxBytes = 65536): string
+    {
+        if (!is_file($logPath)) {
+            return '';
+        }
+
+        $size = filesize($logPath);
+        if ($size === false) {
+            return '';
+        }
+
+        $handle = fopen($logPath, 'rb');
+        if ($handle === false) {
+            return '';
+        }
+
+        if ($size > $maxBytes) {
+            fseek($handle, -$maxBytes, SEEK_END);
+        }
+
+        $contents = stream_get_contents($handle);
+        fclose($handle);
+
+        if ($contents === false) {
+            return '';
+        }
+
+        if ($size > $maxBytes) {
+            $firstLineBreak = strpos($contents, "\n");
+            if ($firstLineBreak !== false) {
+                $contents = substr($contents, $firstLineBreak + 1);
+            }
+            $contents = "... показаны последние строки лога\n" . $contents;
+        }
+
+        return $contents;
+    }
+
+    protected function collectOutputBuffer(int $bufferLevel): string
+    {
+        $output = '';
+        while (ob_get_level() > $bufferLevel) {
+            $buffer = ob_get_clean();
+            if ($buffer !== false) {
+                $output = $buffer . $output;
+            }
+        }
+
+        return $output;
+    }
+
     protected $collectionByType = [
         'W' => 'assetRpd',
         'P' => 'assetsPracticeAnnotations',

Packages/Application/Sfi.Umo/README.md

@@ -52,8 +52,17 @@ PDF-файлы должны лежать прямо в той же папке, 
 ## Как запустить генерацию
 
 1. Откройте модуль импорта УМО в административной части сайта.
-2. Нажмите кнопку `Генерировать внутренние подписанные PDF`.
-3. Генерация запустится в фоновом режиме.
+2. Если нужно сначала проверить, какие файлы будут найдены, нажмите кнопку `Проверить внутренние PDF без генерации`.
+3. Для запуска генерации нажмите кнопку `Генерировать внутренние подписанные PDF`.
+4. Генерация запустится в фоновом режиме.
+
+Внизу страницы модуля показывается путь к рабочей папке, путь к логу и последние строки лога. После запуска генерации можно нажимать `Обновить лог`, чтобы увидеть текущий результат.
+
+Лог записывается в файл:
+
+```text
+/data/www-provisioned/Web/umo/internal/generation.log
+```
 
 ## Что появится в результате
 
@@ -102,6 +111,7 @@ umo/
 
 Проверьте:
 
+- есть ли записи в логе на странице модуля;
 - папка находится внутри `umo/internal`;
 - в папке есть `index.csv`;
 - в `index.csv` есть заголовок и одна строка данных;

Packages/Application/Sfi.Umo/Resources/Private/Templates/Backend/Index.html

@@ -33,4 +33,30 @@
     >
         <div><f:form.submit class="button" value="Генерировать внутренние подписанные PDF"/></div>
     </f:form>
+
+    <br/>
+
+    <f:form
+        method="post"
+        action="dryRunInternalSignedPdfs"
+        controller="Backend"
+        package="Sfi.Umo"
+    >
+        <div><f:form.submit class="button" value="Проверить внутренние PDF без генерации"/></div>
+    </f:form>
+
+    <h2>Внутренние подписанные PDF</h2>
+    <p>Папка с исходными файлами: <code>{internalSignedPdfsBasePath}</code></p>
+    <p>Лог генерации: <code>{internalSignedPdfsLogPath}</code></p>
+
+    <f:link.action action="index" class="button">Обновить лог</f:link.action>
+
+    <f:if condition="{internalSignedPdfsLog}">
+        <f:then>
+            <pre style="margin-top: 16px; padding: 12px; max-height: 480px; overflow: auto; background: #f7f7f7; border: 1px solid #ccc; white-space: pre-wrap;">{internalSignedPdfsLog}</pre>
+        </f:then>
+        <f:else>
+            <p>Лог пока пуст. Нажмите кнопку проверки или генерации, чтобы создать первую запись.</p>
+        </f:else>
+    </f:if>
 </f:section>

Packages/Sites/Sfi.Sfi/Classes/Sfi/Sfi/Command/SignatureCommandController.php

@@ -188,6 +188,8 @@ public function generateInternalSignedPdfsCommand(bool $force = false, bool $dry
             return;
         }
 
+        $this->log($logFile, $dryRun, 'Starting internal signed PDF generation. Base path: %s', [$internalBasePath]);
+
         $items = $this->collectInternalSignatureItems($internalBasePath, $logFile, $dryRun);
         $total = count($items);
         $this->log($logFile, $dryRun, 'Found %d internal PDF files to process.', [$total]);
@@ -599,7 +601,15 @@ protected function log(string $logFile, bool $dryRun, string $format, array $arg
         $message = vsprintf($format, $args);
         $this->outputLine($message);
         if (!$dryRun && $logFile) {
-            file_put_contents($logFile, date('Y-m-d H:i:s') . ' ' . $message . "\n", FILE_APPEND);
+            $logDirectory = dirname($logFile);
+            if (!is_dir($logDirectory) && !mkdir($logDirectory, 0775, true) && !is_dir($logDirectory)) {
+                $this->outputLine('Could not create log directory: %s', [$logDirectory]);
+                return;
+            }
+
+            if (file_put_contents($logFile, date('Y-m-d H:i:s') . ' ' . $message . "\n", FILE_APPEND | LOCK_EX) === false) {
+                $this->outputLine('Could not write log file: %s', [$logFile]);
+            }
         }
     }