Files
atheos-blog-lxc/docs/known-issues.md
T
hermes 5ff6a06e82 feat: document plugin failures and fix the Terminal plugin + macro dialog crash
Diagnosed two independent faults reported from the running editor.

1. Terminal plugin (market) did not work as shipped.
   Root cause: it is a port of Fluidbyte/Codiad-Terminal and calls Common::execute(),
   which Atheos REMOVED (renamed to raw_execute with a different return shape).
     plugin calls : Common::execute(...)      -> MISSING
     available    : Common::raw_execute(...)  -> ["code"=>int, "output"=>array]
   Fixed to raw_execute + implode of the output array. Verified against the real
   method: pwd/echo return correctly, and after chdir it reports the blog repo path,
   so the terminal opens in the right directory.

   Two further upstream defects found and deliberately NOT fixed, but documented so
   nobody trusts them: the block-list is dead code (`explode(",", BLOCKED === true)`
   passes a boolean, so ssh/telnet are never blocked), and `strtolower($command ===
   "exit")` means typing exit does not clear the auth flag.

   Security note recorded: this plugin is a browser shell as the php-fpm user, gated
   by a hardcoded in-app constant (PASSWORD="terminal"). It is not a secret. Strongest
   argument yet for keeping the container LAN-only.

2. Settings -> Macro dialog returned HTTP 500.
   Root cause: Atheos's own components/macro/dialog.php:35 does implode(", ",
   $macro["fTypes"]) which requires an ARRAY, but class.macro.php::save() writes the
   STRING "N/A" for folder macros. So ANY folder-type macro makes that dialog fatal:
     PHP Fatal error: Uncaught TypeError: implode(): Argument #2 ($array) must be of
     type ?array, string given in .../components/macro/dialog.php:35
   Our writer macros are all folder-scoped, so adding them exposed it.

   Fixed by correcting the DATA (fTypes ""N/A"" -> "[]") rather than patching Atheos's
   code, so the fix survives an Atheos update. Verified implode() now succeeds for all
   8 macros. The trade-off and the proper upstream fix are both documented.

Also records the diagnostic order for any future plugin problem, and the rule of
thumb: a Codiad-era plugin's Common:: calls are probably stale.

Adds:
  docs/known-issues.md                  both faults, root causes, fixes, verification
  patches/Terminal-terminal.php.patched the patched plugin file
  files/macros.db.php                   regenerated with the corrected fTypes
2026-09-29 16:19:34 +10:00

6.6 KiB

Known Issues & Patches

Upstream Atheos is an actively-moving project with no releases, and its plugin market ships plugins that are ports from Codiad (Atheos's predecessor). Two of those plugins use APIs that Atheos has since removed or changed. This file records what we hit, what we changed, and why the fix is done the way it is.

Pinned Atheos commit: f90cd1806dbe0e25673a77e27390e8b1a240c3f6 (build 611).


1. 🔴 Plugin market: the Terminal plugin does not work as shipped

Symptom: installed the Terminal plugin from the market; it failed / did not function.

Root cause — a removed API. plugins/Terminal/terminal.php calls Common::execute(...), which no longer exists in Atheos (it was renamed):

plugin calls : Common::execute(...)      ->  MISSING
available    : Common::raw_execute(...)  ->  returns ["code" => int, "output" => array]
                Common::safe_execute(...)

The plugin's header says it is a port of Fluidbyte/Codiad-Terminal, so it targets the old API. Its return-shape assumption is also stale (the old execute() returned text; raw_execute() returns output as an array).

Fix applied (patches/Terminal-terminal.php.patched):

-  $output = Common::execute("pwd");
+  $output = Common::raw_execute("pwd");
-  $_SESSION["activeDir"] = array([$_SESSION["project"]] => $output["text"]);
+  $_SESSION["activeDir"] = array([$_SESSION["project"]] => implode("\n", (array)$output["output"]));

-  $output = Common::execute($cmd);
-  return $output["text"];
+  $output = Common::raw_execute($cmd);
+  return implode("\n", (array)$output["output"]);

Verified against the real method (php83 -l clean; both call patterns exercised):

Call Result
raw_execute("pwd") code=0, output=["/root",""]
raw_execute("echo ...") code=0, returns the text
after chdir to the repo returns /var/www/atheos/workspace/blog — so the terminal opens in the blog

Re-apply after an Atheos update — scripts/update-atheos.sh replaces the application files, so this patch is lost on update. Re-apply it, or drop the plugin.

Two further defects in the same plugin (NOT fixed — upstream, and mostly harmless)

  1. terminal.php:95 — $blocked = explode(",", BLOCKED === true); passes a boolean to explode(). This evaluates to explode(",", false), so the intended block-list (define("BLOCKED","ssh,telnet")) never actually blocks anything. The plugin's own guard is dead code. Cosmetic in effect (the command would just fail on its own), but worth knowing rather than trusting.
  2. terminal.php:124 — if (strtolower($command === "exit")) passes a boolean to strtolower(). Should be strtolower($command) === "exit". Result: typing exit does not clear term_auth; the session stays authenticated until the browser session ends.

Left as-is: they are upstream bugs, and fixing them changes the plugin's behaviour beyond the minimum needed to make it run. Recorded here so nobody "fixes" them by accident or trusts the block-list.

⚠️ Security note

This plugin gives a browser terminal that executes shell commands as the php-fpm user (atheos) — and its own password gate is a hardcoded, in-app constant:

define("PASSWORD", "terminal");   // terminal.php:24 — you type this once per session

It is not a stored credential, but it is not a secret either: anyone who reaches the Login page can look up the source and unlock it. This is the strongest argument yet for keeping the container LAN-only. It also means plugin installation should be treated as a privilege decision, not a convenience one — see docs/security-notes.md §2 (S-7 covers disabling exec/proc_open, which would neutralise macros and this plugin).


2. 🟠 The Macro dialog crashed when folder-scoped macros existed

Symptom: the Settings → Macro dialog returned HTTP 500.

Root cause — invalid data by Atheos's own design. components/macro/dialog.php:35 does:

implode(", ", $macro["fTypes"])     // requires an ARRAY

but components/macro/class.macro.php save() writes the string "N/A" for folder macros:

"fTypes" => $type === "file" ? explode(",", $fTypes) : "N/A",

So any folder-type macro makes that dialog fatal:

PHP Fatal error: Uncaught TypeError: implode(): Argument #2 ($array) must be of type ?array,
string given in /var/www/atheos/components/macro/dialog.php:35

Fix applied — correct the DATA, not Atheos's code. The stored fTypes for folder macros is now [] (an empty array) instead of "N/A":

sed -i 's/"fTypes": "N\/A"/"fTypes": []/g' /var/www/atheos/data/macros.db.php

Verified: implode() now succeeds for all 8 macros.

Why data rather than code: patching dialog.php would be overwritten by update-atheos.sh (and by any Atheos update), whereas valid data keeps working. The trade-off is that the UI's own "save" path could re-introduce "N/A" if a macro is edited in the UI — see the follow-up below.

Follow-up (not done): the real upstream fix is $type === "file" ? explode(",", $fTypes) : [] in class.macro.php::save(). Applying it would stop the UI re-introducing the bad value, at the cost of a patch that must be re-applied after updates. Worth doing if the dialog starts 500-ing again after editing a macro in the UI.


3. Checking for plugin problems in future

The plugin's JS is bundled into public/plugins.min.js (built by classes/sourcemanager.php), and its rightbar button is rendered by components/sidebars/sb-right.php from plugin.json. Both were verified working:

plugins.min.js contains 'plugins/Terminal/init.js'   -> YES   (bundle is fine)
rightbar HTML                                        -> <a onclick="atheos.Terminal.open();">
                                                        <i class="fas fa-terminal"></i>Terminal</a>

So when a plugin misbehaves, check in this order:

# 1. did it install?
tail /var/www/atheos/data/log/market.log.php

# 2. is its JS in the served bundle?
grep -c "plugins/<Name>/init.js" /var/www/atheos/public/plugins.min.js

# 3. is it a stale-API port? (Codiad-era plugins are the risk)
grep -rhoE 'Common::[a-zA-Z_]+' /var/www/atheos/plugins/<Name>/ | sort -u
#    then check each exists:  grep -rn "function <name>" /var/www/atheos/common.php /var/www/atheos/traits/

# 4. is there a PHP fatal?
grep -E 'PHP Fatal' /var/log/nginx/atheos.error.log | tail

Rule of thumb: if a plugin was ported from Codiad, assume its Common:: calls are stale and verify them before trusting it.