View source for KitsNet Operations:Services:Mail Gateway:No-Subscription Warning Suppression

__FORCETOC__
== Purpose ==

This local customization suppresses Proxmox Mail Gateway (PMG) '''"No valid subscription"''' warnings in the web interface without pretending that the system has a valid subscription and without changing PMG mail filtering, repository configuration, licensing state, or subscription data.

The customization is intended for the KitsNet PMG host '''dusse'''.

Initially tested with:

{| class="wikitable"
! Component
! Version
|-
| proxmox-mailgateway
| 9.1
|-
| pmg-api
| 9.1.2
|-
| pmg-gui
| 5.2.2
|-
| proxmox-widget-toolkit
| 5.2.8
|-
| pmg-mobile-quarantine-ui
| 0.5.3
|}

== Files Installed ==

; Main patcher
: <code>/usr/local/sbin/kitsnet-pmg-nosub-patch</code>

; APT/DPKG wrapper
: <code>/usr/local/sbin/kitsnet-pmg-nosub-apt-hook</code>

; APT hook
: <code>/etc/apt/apt.conf.d/99-kitsnet-pmg-nosub</code>

; Log
: <code>/var/log/kitsnet-pmg-nosub-patch.log</code>

== Files Modified by the Patcher ==

=== Proxmox Widget Toolkit ===

File:

<pre>
/usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js
</pre>

Modification:

<code>Proxmox.Utils.checked_command()</code> is changed so that the requested command executes immediately instead of displaying the generic '''"No valid subscription"''' warning.

=== PMG GUI ===

File:

<pre>
/usr/share/javascript/pmg-gui/js/pmgmanagerlib.js
</pre>

Modifications:

* The PMG dashboard subscription-warning panel is hidden.
* The explicit subscription check performed while changing into a logged-in/user view is suppressed.

The actual PMG '''Subscription''' configuration page remains available and continues to report the real subscription state.

== Normal Use ==

The patch is normally reapplied automatically after Debian/Proxmox package operations by the APT post-invoke hook.

No routine manual action should be required.

== Manual Check ==

To verify that all expected KitsNet modifications are currently present:

<syntaxhighlight lang="bash">
sudo /usr/local/sbin/kitsnet-pmg-nosub-patch --check
</syntaxhighlight>

Expected successful output:

<pre>
OK: all KitsNet PMG subscription-suppression patches are present.
</pre>

A nonzero return code means one or more expected modifications are absent.

== Manual Apply / Reapply ==

To apply or reapply the customization manually:

<syntaxhighlight lang="bash">
sudo /usr/local/sbin/kitsnet-pmg-nosub-patch
</syntaxhighlight>

The patcher is '''idempotent'''. Running it when all patches are already present does not make additional changes.

== After Applying the Patch ==

Browser JavaScript may remain cached.

After applying or reapplying the patch, hard-refresh PMG browser sessions:

<pre>
Ctrl+Shift+R
</pre>

Do this for both:

* administrator sessions
* quarantine / ordinary-user sessions

== Automatic Reapplication After Updates ==

APT runs:

<pre>
/usr/local/sbin/kitsnet-pmg-nosub-apt-hook
</pre>

after package operations.

That wrapper runs:

<pre>
/usr/local/sbin/kitsnet-pmg-nosub-patch
</pre>

and records the result in:

<pre>
/var/log/kitsnet-pmg-nosub-patch.log
</pre>

The wrapper always exits successfully so that a cosmetic local PMG GUI customization can never cause an APT or Proxmox package upgrade to fail.

== Safe Failure Behavior ==

The patcher only modifies files when the expected source-code structures are found exactly.

If a future Proxmox release changes the relevant JavaScript enough that the known patterns no longer match, the patcher:

* makes no speculative modification
* reports the mismatch
* returns an error
* records the problem in the log when run automatically
* allows the package upgrade itself to complete normally

This is intentional.

After a major PMG or <code>proxmox-widget-toolkit</code> update, inspect the new source before changing the patcher to match the new implementation.

== Checking the Log ==

Recent results:

<syntaxhighlight lang="bash">
sudo tail -100 /var/log/kitsnet-pmg-nosub-patch.log
</syntaxhighlight>

Search the system journal for automatic-patch warnings:

<syntaxhighlight lang="bash">
sudo journalctl -t kitsnet-pmg-nosub-patch
</syntaxhighlight>

== Backups ==

Whenever the patcher modifies one of the PMG JavaScript files, it creates a timestamped backup alongside that file.

Examples:

<pre>
/usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js.kitsnet-prepatch-YYYYMMDD-HHMMSS

/usr/share/javascript/pmg-gui/js/pmgmanagerlib.js.kitsnet-prepatch-YYYYMMDD-HHMMSS
</pre>

Earlier manual backups may also exist with names such as:

<pre>
*.kitsnet-nosub-backup-YYYYMMDD-HHMMSS
</pre>

These backups are intended for troubleshooting and rollback.

== Removing / Disabling Automatic Reapplication ==

To stop automatically reapplying the customization after package updates, remove or rename the APT hook:

<syntaxhighlight lang="bash">
sudo rm /etc/apt/apt.conf.d/99-kitsnet-pmg-nosub
</syntaxhighlight>

This does '''not''' restore the original JavaScript files. It only disables the automatic post-package invocation.

== Restoring Stock Proxmox Files ==

The cleanest way to restore current package-provided versions is normally to reinstall the packages that own the modified files.

First identify the installed package versions:

<syntaxhighlight lang="bash">
dpkg-query -W proxmox-widget-toolkit pmg-gui
</syntaxhighlight>

Disable the KitsNet APT hook before reinstalling packages, otherwise the patch will be reapplied immediately:

<syntaxhighlight lang="bash">
sudo mv /etc/apt/apt.conf.d/99-kitsnet-pmg-nosub \
    /etc/apt/apt.conf.d/99-kitsnet-pmg-nosub.disabled
</syntaxhighlight>

Then reinstall the affected packages using the normal Proxmox/Debian package-management procedure.

Afterward, hard-refresh the browser.

== What This Patch Does NOT Do ==

This customization does '''not''':

* install or emulate a Proxmox subscription
* alter the PMG API subscription result
* enable the enterprise repository
* disable repository warnings unless separately customized
* change SpamAssassin, ClamAV, SMTP, quarantine, filtering, or delivery
* alter licensing or support entitlement
* modify the PMG mobile quarantine bundle unless explicitly extended

== Known Separate Warning ==

The yellow dashboard message:

<blockquote>
Non production-ready repository enabled!
</blockquote>

is a separate repository-status warning. It is not part of the no-subscription suppression described here.

== Source Markers ==

The installed JavaScript modifications are intentionally marked with '''KITSNET''' comments so they are easy to locate.

Examples:

<pre>
KITSNET: suppress no-subscription warning

KITSNET: hide no-subscription dashboard panel

KITSNET: suppress subscription check when changing views
</pre>

== Quick Reference ==

{| class="wikitable"
! Task
! Command
|-
| Check patch status
| <code>sudo /usr/local/sbin/kitsnet-pmg-nosub-patch --check</code>
|-
| Apply / reapply
| <code>sudo /usr/local/sbin/kitsnet-pmg-nosub-patch</code>
|-
| View log
| <code>sudo tail -100 /var/log/kitsnet-pmg-nosub-patch.log</code>
|-
| Hard-refresh browser
| <code>Ctrl+Shift+R</code>
|}

== Maintenance Note ==

This is a local KitsNet customization to package-managed JavaScript files.

Proxmox updates are expected to replace those files. The patcher and APT hook exist specifically so the customization can be safely and repeatably reapplied after updates.