Fix code-review findings: ajax error handling, translated comment, docs

- js/index.js: the occ-command ajax call used the wrong jQuery .fail()
  signature ((response, code) instead of (jqXHR, textStatus,
  errorThrown)), so any failure printed the literal string
  "[object Object]" instead of a useful message.
- js/index.js: the initial bootstrap call that builds the terminal had
  no .fail() handler at all - a failure there (expired session/CSRF
  token, network error, rejected admin check) left #app-content
  permanently blank with zero diagnostic information. This is exactly
  what made today's NC34 debugging session harder than it needed to
  be; now it shows the actual HTTP status/reason in the page.
- OccController.php: translated a leftover Dutch comment (missed by
  the earlier Russian->English pass since it wasn't Russian), and
  documented why requireAdmin() is intentional defense-in-depth rather
  than a misunderstanding of the framework: verified against
  Nextcloud's own SecurityMiddleware source that any controller method
  without @NoAdminRequired already rejects non-admins by default, so
  this check (and the original "security fix" commit that added it)
  was addressing a non-issue for THIS controller specifically.
  DbController's equivalent check is still genuinely load-bearing -
  that controller originally shipped with @PublicPage, which does
  bypass the default protection - so it gets a note explaining the
  distinction instead.
- README: added compatibility matrix rows for 0.4.0 (app id rename to
  extended_occweb) and 0.4.1 (these fixes), both verified on NC 34.0.4.

Deferred to when a test instance exists (tracked, not fixed here): no
documented migration path from the old occweb id to extended_occweb
for existing installs, OccController's constructor doing expensive
work before the (redundant) admin check runs, and js/jquery.js loading
unconditionally on NC30-33 where core still provides jQuery.

Version bump to 0.4.1.

.gitignore

@@ -30,5 +30,8 @@ js/*.log
 .env
 *.local
 
+# Internal deploy notes (hostnames, paths) - never publish these
+notes/
+
 # Misc logs
 *.log

INSTALL-AIO.md

@@ -0,0 +1,95 @@
+# Installing/updating occweb on Nextcloud AIO (Docker)
+
+Nextcloud's official All-in-One (AIO) distribution runs core in its own container
+(`nextcloud-aio-nextcloud` by convention), so the generic [install instructions](README.md)
+(`git clone` straight into the server) don't apply as-is. This covers the differences.
+
+## Where the app belongs
+
+`/var/www/html/custom_apps/` inside the core container — **not** `/var/www/html/apps/`.
+AIO's `config.php` sets `apps_paths` with `apps/` as `writable: false` (managed by
+Nextcloud's own core/appstore sync, which can overwrite custom code placed there) and
+`custom_apps/` as `writable: true` — the intended location for third-party apps like
+this one.
+
+## Deploy/update procedure
+
+The AIO container has no working git access to GitHub, so deploy a tarball instead of
+`git clone`/`git pull` inside it:
+
+```bash
+# 1. On your machine: clean checkout of the branch/tag you want, dev files stripped
+STAGE=$(mktemp -d)
+git archive main | tar -x -C "$STAGE"
+rm -rf "$STAGE"/{tests,.travis.yml,phpunit.xml,phpunit.integration.xml,composer.json,composer.lock,Makefile}
+tar -C "$STAGE" -cf /tmp/occweb-deploy.tar .
+
+# 2. Copy it onto the Docker host, then into the container
+scp /tmp/occweb-deploy.tar <docker-host>:/tmp/occweb-deploy.tar
+ssh <docker-host> "docker cp /tmp/occweb-deploy.tar nextcloud-aio-nextcloud:/tmp/occweb-deploy.tar && \
+  docker exec nextcloud-aio-nextcloud sh -c 'mkdir -p /var/www/html/custom_apps/extended_occweb && \
+  tar -xf /tmp/occweb-deploy.tar -C /var/www/html/custom_apps/extended_occweb && rm /tmp/occweb-deploy.tar'"
+
+# 3. Fix ownership - tar preserves the source uid/gid, not www-data
+ssh <docker-host> "docker exec nextcloud-aio-nextcloud chown -R www-data:www-data /var/www/html/custom_apps/extended_occweb"
+
+# 4. Fresh install only (skip when updating an already-enabled app):
+ssh <docker-host> "docker exec -u www-data nextcloud-aio-nextcloud php occ app:enable extended_occweb"
+```
+
+> **Gotcha**: never copy a file into a container with `ssh host "docker exec container bash -c 'cat > file'"`
+> piped from local stdin — that produces an empty file. Always `scp` to the host, then
+> `docker cp` into the container, as above.
+
+## ⚠️ Critical after bumping `<version>` in `appinfo/info.xml`
+
+This step is **not optional** — skipping it doesn't just block occ commands, it can
+block **logging into the web UI entirely** (Nextcloud shows an upgrade screen to every
+user instead of the login page).
+
+Nextcloud tracks each app's installed version in the database (`installed_version` in
+`oc_appconfig`), separately from `<version>` in `info.xml`. If you replace files in place
+(instead of going through the app store or `occ upgrade`), those two fall out of sync,
+and Nextcloud puts the whole instance into a "needs upgrade" state until you sync it
+manually:
+
+```bash
+ssh <docker-host> "docker exec -u www-data nextcloud-aio-nextcloud php occ config:app:set extended_occweb installed_version --value='X.Y.Z'"
+```
+
+(use the same `X.Y.Z` as the new `<version>`). Verify with `occ status` that
+`needsDbUpgrade: false` again.
+
+## Restart PHP-FPM after every deploy
+
+`occ app:disable`/`app:enable` does not clear PHP's opcache — an update can silently
+fail to take effect without a restart (routes 404ing is the typical symptom). Prefer a
+graceful reload over a hard restart (keeps in-flight requests alive):
+
+```bash
+ssh <docker-host> "docker exec nextcloud-aio-nextcloud ps aux | grep 'php-fpm: master'"   # find the PID
+ssh <docker-host> "docker exec nextcloud-aio-nextcloud kill -USR2 <master-pid>"
+```
+
+`supervisorctl` won't work directly inside this container (its socket isn't at the
+default path) — hence the manual PID lookup.
+
+## Removing the app
+
+```bash
+ssh <docker-host> "docker exec -u www-data nextcloud-aio-nextcloud php occ app:disable extended_occweb && \
+  docker exec nextcloud-aio-nextcloud rm -rf /var/www/html/custom_apps/extended_occweb"
+```
+
+## `max-version` policy
+
+See the comment next to `<dependencies>` in `appinfo/info.xml`: it must always equal the
+highest Nextcloud core version this fork has actually been verified against — never a
+value inherited from upstream, and never a guess ahead of what's been tested. Test
+against the next major's beta ahead of time and bump it before that major goes final,
+rather than reacting after the fact.
+
+## SQL query mode
+
+Type `sql` in the OCCWeb terminal to run raw SQL directly against the Nextcloud
+database. Separate statements with `;`, use Shift+Enter for a new line and Enter to run.

README.md

@@ -2,7 +2,7 @@
 
 ### A web terminal for admins to launch Nextcloud's occ commands
 
-![occweb](https://github.com/Adphi/OCCWeb/raw/main/appinfo/screenshot.png)
+![occweb](https://github.com/dillardblom/occweb/raw/main/appinfo/screenshot.png)
 
 ## About this fork
 
@@ -33,13 +33,19 @@ has background on why Nextcloud has no native async support for occ tasks.
 
 ## Install
 
+Running Nextcloud AIO (Docker)? See [INSTALL-AIO.md](INSTALL-AIO.md) instead — the app
+path and deploy steps differ from the generic instructions below.
+
 No build step required (plain PHP + vanilla JS). Clone straight into the
 target server's `apps/` directory and run the install script:
 
+Nextcloud requires the app's directory name to match its id (`extended_occweb`), so
+clone into that name explicitly rather than the repo's own name:
+
 ```bash
 cd /var/www/nextcloud/apps
-git clone https://github.com/fanategorius/occweb.git
+git clone https://github.com/dillardblom/occweb.git extended_occweb
-bash occweb/install.sh
+bash extended_occweb/install.sh
 ```
 
 `install.sh` removes the dev/CI-only files that don't belong in a running
@@ -50,7 +56,7 @@ server user, and runs `occ app:enable`. It assumes Nextcloud lives at
 values as arguments if that's not the case:
 
 ```bash
-bash occweb/install.sh /path/to/nextcloud custom-web-user
+bash extended_occweb/install.sh /path/to/nextcloud custom-web-user
 ```
 
 `occ app:enable` takes care of registering the app's version correctly, so
@@ -99,7 +105,7 @@ So if your instance is pretty big, commands like `occ files:scan` will time out
 
 ## Deploying updates
 
-After pulling/copying new code into `nextcloud/apps/occweb/`, restart PHP so
+After pulling/copying new code into `nextcloud/apps/extended_occweb/`, restart PHP so
 the changes actually take effect. `occ app:disable`/`app:enable` is **not**
 enough — it does not clear PHP's opcode cache, so a stale, cached version of
 the code can keep running (routes silently 404ing is a typical symptom).
@@ -121,12 +127,31 @@ CLI-upgrade wizard, even though nothing about Nextcloud core actually
 changed. After bumping the version, sync it manually:
 
 ```bash
-sudo -u www-data php /var/www/nextcloud/occ config:app:set occweb installed_version --value="X.Y.Z"
+sudo -u www-data php /var/www/nextcloud/occ config:app:set extended_occweb installed_version --value="X.Y.Z"
 ```
 
 (use the same `X.Y.Z` as the new `<version>`), then restart PHP as above.
 This does not apply on a fresh `occ app:enable` install — that command sets
 `installed_version` correctly on its own.
 
+## Compatibility matrix
+
+`max-version` in `appinfo/info.xml` only ever reflects the highest version we've actually
+tested (see the policy comment right above it) - this table is the actual history of what
+was verified, so a rollback target is obvious if a newer major causes problems.
+
+| occweb version | Tag | NC version tested | Result |
+|---|---|---|---|
+| 0.3.4 | `v0.3.4` | 33.0.8 | ✅ Verified (nc01, 2026-09-25) |
+| 0.3.4 | `v0.3.4` | 34.0.4 | ❌ Blank terminal - global jQuery gone on NC34 (`jQuery is not defined`), then a 412 "CSRF check failed" on every ajax call once jQuery was vendored. Fixed in 0.3.5. |
+| 0.3.5 | `v0.3.5-nc34` | 34.0.4 | ✅ Verified (nc01, 2026-09-26) - vendors its own jQuery + sends the CSRF `requesttoken` header explicitly on every ajax call |
+| 0.3.5 | `v0.3.5-nc34` | 33.0.8 | ⚠️ Believed compatible (the 0.3.5 change is additive-only, nothing removed that NC30-33 depended on) but not re-verified - nc01 no longer runs NC33 to test against |
+| 0.4.0 | (untagged) | 34.0.4 | ✅ Verified (nc01, 2026-09-26) - app id renamed `occweb` → `extended_occweb` (App Store prep), no functional changes to the 0.3.5 fixes otherwise |
+| 0.4.1 | `v0.4.1-nc34` | 34.0.4 | ✅ Verified (nc01, 2026-09-26) - code review fixes: correct jQuery `.fail()` signature, added a missing `.fail()` handler on the initial terminal-load request |
+| 0.4.1 | `v0.4.1-nc34` | 33.0.8 | ⚠️ Same caveat as 0.3.5/0.4.0 - not re-verified, no NC33 test environment available. Also unresolved: `js/jquery.js` now loads unconditionally on every supported version, even NC30-33 where core still provides jQuery - flagged in code review, needs an NC33 environment to confirm it's harmless there. |
+
+If a future major breaks something, `git checkout v0.3.4` is the last version confirmed
+working on NC33 and older.
+
 ## TODOs:
 See [open issues](https://github.com/dillardblom/occweb/issues)

appinfo/info.xml

@@ -1,11 +1,11 @@
 <?xml version="1.0"?>
 <info xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
-    <id>occweb</id>
+    <id>extended_occweb</id>
     <name>Extended OCC Web</name>
     <summary>OCC Commands in a web terminal</summary>
     <description><![CDATA[Run OCC Commands in a web terminal]]></description>
-    <version>0.3.4</version>
+    <version>0.4.1</version>
     <licence>agpl</licence>
     <author mail="dillard.blom@ensembia.com" >Dillard Blom</author>
     <namespace>OCCWeb</namespace>
@@ -15,12 +15,17 @@
     <repository>https://github.com/dillardblom/occweb</repository>
     <screenshot>https://github.com/dillardblom/occweb/raw/main/appinfo/screenshot.png</screenshot>
     <dependencies>
-        <nextcloud min-version="30" max-version="33"/>
+        <!-- max-version must equal the highest NC core version this fork has
+             actually been verified on - never a value inherited from upstream
+             or guessed ahead. Test against the next major's beta and bump
+             this BEFORE it goes final, so occ:upgrade never has to fall back
+             to auto-disabling the app. -->
+        <nextcloud min-version="30" max-version="34"/>
     </dependencies>
     <navigations>
         <navigation role="admin">
-            <name>OCCWeb</name>
+            <name>OCC Web</name>
-            <route>occweb.occ.index</route>
+            <route>extended_occweb.occ.index</route>
             <icon>app.svg</icon>
             <type>link</type>
         </navigation>

composer.json

@@ -6,6 +6,10 @@
     "authors": [
         {
             "name": "Adphi"
+        },
+        {
+            "name": "Dillard Blom",
+            "email": "dillard.blom@ensembia.com"
         }
     ],
     "require": {},

install.sh

@@ -1,10 +1,11 @@
 #!/usr/bin/env bash
 #
-# Post-clone install script for occweb.
+# Post-clone install script for occweb (Nextcloud app id: extended_occweb).
 #
-# Usage (from nextcloud/apps/):
+# Usage (from nextcloud/apps/) - clone into "extended_occweb", not the repo's
-#   git clone https://github.com/fanategorius/occweb.git
+# own name, since Nextcloud requires the app directory to match its id:
-#   bash occweb/install.sh [nextcloud-root] [web-user]
+#   git clone https://github.com/dillardblom/occweb.git extended_occweb
+#   bash extended_occweb/install.sh [nextcloud-root] [web-user]
 #
 # Defaults: nextcloud-root=/var/www/nextcloud, web-user=www-data
 #

js/index.js

@@ -1,11 +1,18 @@
 (function (OC, window, $, undefined) {
   'use strict';
   $(function() {
+    // Nextcloud core only auto-attaches the CSRF requesttoken header to ajax
+    // calls made through its own globally-loaded jQuery. Since NC34 that
+    // global jQuery is no longer guaranteed to be the one still active by
+    // the time our own calls fire (other apps loading their own jQuery can
+    // replace window.jQuery afterwards - see js/jquery.js), ajaxSetup() here
+    // isn't reliable; every $.ajax() call below sets the header explicitly.
+
     function scrollToBottom(){
       var html = $('html');
       html.scrollTop(html.prop('scrollHeight'));
     }
-    var baseUrl = OC.generateUrl('/apps/occweb');
+    var baseUrl = OC.generateUrl('/apps/extended_occweb');
 
     // Current terminal mode: 'occ' (regular occ commands) or 'sql'
     // (running arbitrary SQL queries via /db/query).
@@ -287,6 +294,7 @@
         type: 'POST',
         contentType: 'application/json',
         timeout: SQL_REQUEST_TIMEOUT_MS,
+        headers: { requesttoken: OC.requestToken },
         data: JSON.stringify({ sql: sql, confirm: !!confirmed })
       }).done(function (response) {
         if (response && response.requiresConfirmation) {
@@ -319,7 +327,7 @@
       });
     }
 
-    $.get(baseUrl + '/cmd', function(response){
+    $.ajax({ url: baseUrl + '/cmd', headers: { requesttoken: OC.requestToken } }).done(function(response){
       $('#app-content').terminal(function(command, term) {
         if (mode === 'sql') {
           var trimmed = command.trim();
@@ -375,11 +383,12 @@
             url: baseUrl + '/cmd',
             type: 'POST',
             contentType: 'application/json',
+            headers: { requesttoken: OC.requestToken },
             data: JSON.stringify(occCommand)
           }).done(function (response) {
             term.echo('\n' + response).resume();
-          }).fail(function (response, code) {
+          }).fail(function (xhr, status) {
-            term.echo('\n' + response).resume();
+            term.echo('\n[[;#ff5555;]Request failed: ]' + $.terminal.escape_formatting(xhr.status + ' ' + xhr.statusText)).resume();
           });
         }
       }, {
@@ -401,6 +410,16 @@
           scrollToBottom()
         }
       });
+    }).fail(function (xhr, status) {
+      // Without this, a failure here (expired session/CSRF token, network
+      // error, a rejected admin check) leaves #app-content permanently
+      // empty with no visible error and nothing in the console pointing
+      // at the cause - exactly what happened during NC34 testing before
+      // this handler existed.
+      $('#app-content').text(
+        'Failed to load the terminal: ' + xhr.status + ' ' + xhr.statusText +
+        '. Try reloading the page; if that keeps happening, check the server logs.'
+      );
     });
     $('html').keypress(function(){
       scrollToBottom()

lib/Controller/DbController.php

@@ -162,7 +162,12 @@ class DbController extends Controller
 
     public function query()
     {
-        // Check admin privileges
+        // Deliberate defense-in-depth (see the equivalent check in
+        // OccController::requireAdmin() for why it's kept even though
+        // Nextcloud's SecurityMiddleware already enforces this by default
+        // absent @NoAdminRequired) - this one is also the direct fix for
+        // this controller having shipped with @PublicPage originally,
+        // which did bypass that default protection entirely.
         $user = $this->userSession->getUser();
         if (!$user) {
             return new JSONResponse(['error' => 'Not authenticated'], 401);
@@ -189,8 +194,8 @@ class DbController extends Controller
         // Audit: log the fact that execution was attempted BEFORE any checks,
         // so blocked/rejected queries are recorded in the log too, not just
         // the ones that succeeded.
-        $this->logger->warning('[occweb] SQL submitted by {user}: {sql}', [
+        $this->logger->warning('[extended_occweb] SQL submitted by {user}: {sql}', [
-            'app' => 'occweb',
+            'app' => 'extended_occweb',
             'user' => $user->getUID(),
             'sql' => $sql,
         ]);
@@ -207,8 +212,8 @@ class DbController extends Controller
         foreach ($queries as $query) {
             $forbidden = $this->findForbiddenConstruct($query);
             if ($forbidden !== null) {
-                $this->logger->error('[occweb] Blocked forbidden construct ({construct}) from {user}: {sql}', [
+                $this->logger->error('[extended_occweb] Blocked forbidden construct ({construct}) from {user}: {sql}', [
-                    'app' => 'occweb',
+                    'app' => 'extended_occweb',
                     'construct' => $forbidden,
                     'user' => $user->getUID(),
                     'sql' => $sql,
@@ -277,8 +282,8 @@ class DbController extends Controller
             $this->db->beginTransaction();
             $transactionStarted = true;
         } catch (\Exception $e) {
-            $this->logger->warning('[occweb] beginTransaction() failed, proceeding without an explicit transaction: {error}', [
+            $this->logger->warning('[extended_occweb] beginTransaction() failed, proceeding without an explicit transaction: {error}', [
-                'app' => 'occweb',
+                'app' => 'extended_occweb',
                 'error' => $e->getMessage(),
             ]);
         }
@@ -353,8 +358,8 @@ class DbController extends Controller
                         // permanently applied — we deliberately do NOT set
                         // rolledBack to true, since that would be untrue.
                         $rollbackFailed = true;
-                        $this->logger->warning('[occweb] rollBack() failed after an error — earlier statements in this batch may already be permanently applied: {error}', [
+                        $this->logger->warning('[extended_occweb] rollBack() failed after an error — earlier statements in this batch may already be permanently applied: {error}', [
-                            'app' => 'occweb',
+                            'app' => 'extended_occweb',
                             'error' => $rollbackError->getMessage(),
                         ]);
                     }
@@ -371,8 +376,8 @@ class DbController extends Controller
                 // a DDL statement on MySQL/MariaDB) — the effects are
                 // already saved, this isn't an error in executing the batch
                 // itself.
-                $this->logger->info('[occweb] commit() had nothing to commit (likely auto-committed by a DDL statement): {error}', [
+                $this->logger->info('[extended_occweb] commit() had nothing to commit (likely auto-committed by a DDL statement): {error}', [
-                    'app' => 'occweb',
+                    'app' => 'extended_occweb',
                     'error' => $e->getMessage(),
                 ]);
             }

lib/Controller/OccController.php

@@ -50,8 +50,17 @@ class OccController extends Controller
 
   private function requireAdmin(): ?JSONResponse
   {
-    // Services via OC::$server zodat de constructor-signatuur ongewijzigd blijft
+    // Deliberate defense-in-depth, not a workaround for a missing framework
-    // en NC's DI-container (zonder application.php) de class kan resolven.
+    // check: Nextcloud's own SecurityMiddleware already rejects non-admins
+    // here by default (no method below has @NoAdminRequired), so this is
+    // redundant today. Kept anyway given what this app can do (arbitrary
+    // occ/SQL execution) - if the framework check ever regresses, this
+    // still holds. If you ever want to intentionally open one of these
+    // routes to non-admins, remove the call below AND add
+    // @NoAdminRequired, or this will keep silently blocking it.
+    //
+    // Services via OC::$server so the constructor signature stays unchanged
+    // and NC's DI container (without an application.php) can resolve the class.
     $userSession = OC::$server->get(\OCP\IUserSession::class);
     $user = $userSession->getUser();
     if ($user === null) {
@@ -70,7 +79,7 @@ class OccController extends Controller
   public function index()
   {
     if ($err = $this->requireAdmin()) return $err;
-    return new TemplateResponse('occweb', 'index');
+    return new TemplateResponse('extended_occweb', 'index');
   }
 
   /**

templates/index.php

@@ -1,8 +1,13 @@
 <?php
-script('occweb', 'index');
+// Nextcloud's global jQuery has been deprecated since NC19 and is no longer
-script('occweb', 'term');
+// reliably present on NC34+ (see e.g. serverinfo needing to bundle its own) -
-script('occweb', 'unix_formatting');
+// term.js (jquery.terminal) and index.js both require jQuery to be loaded
-style('occweb', 'style');
+// first, so ship and load our own copy rather than relying on core.
+script('extended_occweb', 'jquery');
+script('extended_occweb', 'index');
+script('extended_occweb', 'term');
+script('extended_occweb', 'unix_formatting');
+style('extended_occweb', 'style');
 ?>
 
 <div id="app" class="full-width">