Log tool output to a single file in $workdir

For each tool run, log information about the run into a single file in $workdir. This simplifies debugging and troubleshooting.
DistributedProofreaders · Dec 12, 2020 · 1495464 · 1495464
1 parent 4e54cc4
commit 1495464
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 24 deletions.
diff --git a/base.inc b/base.inc
@@ -197,6 +197,11 @@ function log_tool_access($tool, $upid)
     file_put_contents("$base_workdir/access.log", $s, FILE_APPEND);
 }
 
+function log_tool_action($workdir, $label, $message)
+{
+    file_put_contents("$workdir/messages.log", "$label: $message\n", FILE_APPEND);
+}
+
 class UploadError extends Exception {}
 
 function process_file_upload($formid, $workdir, $allowed_extensions=[])
@@ -261,6 +266,8 @@ function process_file_upload($formid, $workdir, $allowed_extensions=[])
         throw $e;
     }
 
+    log_tool_action($workdir, "uploaded file", $final_filepath);
+
     return $final_filepath;
 }
 
@@ -277,6 +284,7 @@ function ensure_utf8_file($filename) {
         );
         exec(escapeshellcmd($cmd), $ppf_output, $ppf_exitcode);
         rename($tmpfname, $filename);
+        log_tool_action(dirname($filename), "UTF-8 conversion", "$filename converted from ISO-8859-1");
         return true;
     }
     return false;

diff --git a/ppcomp-action.php b/ppcomp-action.php
@@ -64,11 +64,12 @@
     "2>&1"
 ]);
 
-// echo $command;
-file_put_contents("$workdir/command.txt", $command);
+log_tool_action($workdir, "command", $command);
 
 $output = shell_exec($command);
 
+log_tool_action($workdir, "output", $output);
+
 // ----- display results -------------------------------------------
 
 output_header("ppcomp Results");
@@ -81,11 +82,11 @@
    $reportok = true;
 }
 if ($reportok) {
-    echo "Left click to view. Right click to download.</p>";
+    echo "Left click to view. Right click to download.";
 } else {
     echo "<p>Whoops! Something went wrong and no output was generated.
     The error message was<br/><br/>
     <tt>${output}</tt></p>
-    </p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
+    <p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
 }
-
+echo "</p>";
diff --git a/pphtml-action.php b/pphtml-action.php
@@ -64,12 +64,13 @@
     "2>&1"
 ]);
 
-// echo $command;
-file_put_contents("$workdir/command.txt", $command);
+log_tool_action($workdir, "command", $command);
 
 // and finally, run pphtml
 $output = shell_exec($command);
 
+log_tool_action($workdir, "output", $output);
+
 // ----- display results -------------------------------------------
 
 output_header("pphtml Results");
@@ -82,11 +83,11 @@
    $reportok = true;
 }
 if ($reportok) {
-    echo "Left click to view. Right click to download.</p>";
+    echo "Left click to view. Right click to download.";
 } else {
     echo "<p>Whoops! Something went wrong and no output was generated.
     The error message was<br/><br/>
     <tt>${output}</tt></p>
-    </p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
+    <p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
 }
-
+echo "</p>";
diff --git a/ppsmq-action.php b/ppsmq-action.php
@@ -27,11 +27,13 @@
     "2>&1"
 ]);
 
-// echo $command;
+log_tool_action($workdir, "command", $command);
 
 // and finally, run ppsmq
 $output = shell_exec($command);
 
+log_tool_action($workdir, "output", $output);
+
 // ----- display results -------------------------------------------
 
 output_header("ppsmq Results");
@@ -44,11 +46,11 @@
    $reportok = true;
 }
 if ($reportok) {
-    echo "Left click to view. Right click to download.</p>";
+    echo "Left click to view. Right click to download.";
 } else {
     echo "<p>Whoops! Something went wrong and no output was generated.
     The error message was<br/><br/>
     <tt>${output}</tt></p>
-    </p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
+    <p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
 }
-
+echo "</p>";
diff --git a/pptext-action.php b/pptext-action.php
@@ -23,13 +23,11 @@
 // ----- user has option of uploading a Latin-1 file -------------------
 
 // main file
-if(ensure_utf8_file($target_name)) {
-    file_put_contents("$workdir/converted-main.txt", "text file converted from ISO-8859\n");
-}
+ensure_utf8_file($target_name);
 
 // good words file
-if ($gtarget_name && ensure_utf8_file($gtarget_name)) {
-    file_put_contents("$workdir/converted-gwf.txt", "good words file converted from ISO-8859\n");
+if ($gtarget_name) {
+    ensure_utf8_file($gtarget_name);
 }
 
 // ----- process user options ------------------------------------------
@@ -104,12 +102,13 @@
     "2>&1"
 ]);
 
-// echo $command;
-file_put_contents("$workdir/command.txt", $command);
+log_tool_action($workdir, "command", $command);
 
 // and finally, run pptext
 $output = shell_exec($command);
 
+log_tool_action($workdir, "output", $output);
+
 // ----- display results -------------------------------------------
 
 output_header("pptext Results");
@@ -126,11 +125,11 @@
    $reportok = true;
 }
 if ($reportok) {
-    echo "Left click to view. Right click to download.</p>";
+    echo "Left click to view. Right click to download.";
 } else {
     echo "<p>Whoops! Something went wrong and no output was generated.
     The error message was<br/><br/>
     <tt>${output}</tt></p>
-    </p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
+    <p>For more assistance, ask in the <a href='$help_url'>discussion topic</a> and include this identifier: ${upid}</p>";
 }
-
+echo "</p>";