Compare commits
42 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1a4c02a098 | |||
| 99f3bd47e0 | |||
| 6907046dae | |||
| 7e597674ac | |||
| 47aeb98201 | |||
| 58f2571dc4 | |||
| e3ba98499e | |||
| 5b17f5c5ec | |||
| 9b9e8764da | |||
| 26646eac57 | |||
| e0518c20fe | |||
| 278e5d45f6 | |||
| 0d24862302 | |||
| 94d45169ef | |||
| 17fd3d6b0e | |||
| f26595bed4 | |||
| 70748938d2 | |||
| dcdc3debb8 | |||
| e2782b4fb7 | |||
| 178ca0499e | |||
| 324baff9b9 | |||
| 22f0bb9a6f | |||
| 616e82ae26 | |||
| ec5a22b37f | |||
| 445f5e7060 | |||
| eaf46e7ea3 | |||
| 303af17971 | |||
| 7e0aa36ffa | |||
| 102bea980b | |||
| ed95dcb7af | |||
| 56abe3af7f | |||
| 5b5245c170 | |||
| 167a7c0dfd | |||
| 62788853ea | |||
| 6f7cb11e39 | |||
| df22d7f7c0 | |||
| 5984529569 | |||
| 8be05b75b7 | |||
| a02e466456 | |||
| 2ede62b8b9 | |||
| f5d06e6e25 | |||
| 7370757e46 |
@@ -8,7 +8,7 @@
|
||||
<name>MokoWaaS</name>
|
||||
<org>MokoConsulting</org>
|
||||
<description>White-label identity, security hardening, and tenant restriction layer for WaaS-managed Joomla environments</description>
|
||||
<version>02.12.00</version>
|
||||
<version>02.15.00</version>
|
||||
<license spdx="GPL-3.0-or-later">GNU General Public License v3</license>
|
||||
</identity>
|
||||
<governance>
|
||||
|
||||
@@ -140,6 +140,10 @@ jobs:
|
||||
- name: Detect platform
|
||||
id: platform
|
||||
run: |
|
||||
if [ ! -f ".mokogitea/manifest.xml" ]; then
|
||||
echo "::error::.mokogitea/manifest.xml not found — cannot release without platform manifest"
|
||||
exit 1
|
||||
fi
|
||||
php /tmp/moko-platform-api/cli/manifest_read.php --path . --github-output
|
||||
MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" -exec grep -l '<extension' {} \; 2>/dev/null | head -1 || true)
|
||||
MOD_FILE=$(find . -maxdepth 4 -name "mod*.class.php" ! -path "./.git/*" -exec grep -l 'extends DolibarrModules' {} \; 2>/dev/null | head -1 || true)
|
||||
@@ -259,26 +263,8 @@ jobs:
|
||||
php /tmp/moko-platform-api/cli/badge_update.php --path . --version "${VERSION}" 2>/dev/null || true
|
||||
php /tmp/moko-platform-api/cli/version_check.php --path . --fix 2>/dev/null || true
|
||||
|
||||
# Step 5 (updates.xml) moved after Step 8 to include SHA-256 checksum
|
||||
|
||||
- name: Commit release changes
|
||||
if: >-
|
||||
steps.version.outputs.skip != 'true' &&
|
||||
steps.check.outputs.already_released != 'true'
|
||||
run: |
|
||||
if git diff --quiet && git diff --cached --quiet; then
|
||||
echo "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}"
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
# Set push URL with token for branch-protected repos
|
||||
git remote set-url origin "https://jmiller:${{ secrets.GA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
||||
git add -A
|
||||
git commit -m "chore(release): build ${VERSION} [skip ci]" \
|
||||
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>"
|
||||
git push -u origin HEAD
|
||||
# NOTE: Commit is deferred until after updates.xml is written (after Step 8)
|
||||
# so all changes (version bump + manifests + updates.xml) go in one atomic push.
|
||||
|
||||
# -- STEP 6: Create tag ---------------------------------------------------
|
||||
- name: "Step 6: Create git tag"
|
||||
@@ -348,13 +334,10 @@ jobs:
|
||||
VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}"
|
||||
SHA256="${{ steps.package.outputs.sha256_zip }}"
|
||||
|
||||
# Fetch latest updates.xml from main so preserve logic has all channels
|
||||
GA_TOKEN="${{ secrets.GA_TOKEN }}"
|
||||
API="${GITEA_URL}/api/v1/repos/${{ github.repository }}"
|
||||
curl -sf -H "Authorization: token ${GA_TOKEN}" \
|
||||
"${API}/contents/updates.xml?ref=main" 2>/dev/null | \
|
||||
python3 -c "import sys,json,base64; print(base64.b64decode(json.load(sys.stdin)['content']).decode())" \
|
||||
> updates.xml 2>/dev/null || true
|
||||
if [ ! -f "updates.xml" ]; then
|
||||
echo "No updates.xml — skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
SHA_FLAG=""
|
||||
[ -n "$SHA256" ] && SHA_FLAG="--sha ${SHA256}"
|
||||
@@ -364,17 +347,40 @@ jobs:
|
||||
--gitea-url "${GITEA_URL}" --org "${GITEA_ORG}" --repo "${GITEA_REPO}" \
|
||||
${SHA_FLAG} --github-output
|
||||
|
||||
# Commit updates.xml if changed
|
||||
if ! git diff --quiet updates.xml 2>/dev/null; then
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
git remote set-url origin "https://jmiller:${{ secrets.GA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
||||
git add updates.xml
|
||||
git commit -m "chore: update stable channel ${VERSION} [skip ci]" \
|
||||
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>"
|
||||
git push origin HEAD 2>&1 || true
|
||||
# -- Commit all release changes (version bump + manifests + updates.xml) --
|
||||
- name: "Commit release changes"
|
||||
if: >-
|
||||
steps.version.outputs.skip != 'true' &&
|
||||
steps.check.outputs.already_released != 'true'
|
||||
run: |
|
||||
VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}"
|
||||
|
||||
# Re-align all version files (second pass catches anything the build touched)
|
||||
php /tmp/moko-platform-api/cli/version_set_platform.php \
|
||||
--path . --version "$VERSION" --branch main 2>/dev/null || true
|
||||
php /tmp/moko-platform-api/cli/version_check.php --path . --fix 2>/dev/null || true
|
||||
|
||||
echo "=== Pre-commit version check ==="
|
||||
php /tmp/moko-platform-api/cli/version_check.php --path . || true
|
||||
echo "=== Files changed ==="
|
||||
git status --short
|
||||
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
git remote set-url origin "https://jmiller:${{ secrets.GA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git"
|
||||
git add -A
|
||||
|
||||
if git diff --cached --quiet; then
|
||||
echo "No changes to commit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
git commit -m "chore(release): build ${VERSION} [skip ci]" \
|
||||
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>"
|
||||
# Push to main explicitly — Gitea Actions checks out a detached HEAD
|
||||
# for PR merge events, so "git push origin HEAD" creates a dangling ref
|
||||
git push origin HEAD:refs/heads/main
|
||||
|
||||
# -- STEP 8b: Update release description with changelog ----------------------
|
||||
- name: "Step 8b: Update release body"
|
||||
if: steps.version.outputs.skip != 'true'
|
||||
@@ -454,25 +460,25 @@ jobs:
|
||||
"${API_BASE}/branches" \
|
||||
-d '{"new_branch_name":"dev","old_branch_name":"main"}' 2>/dev/null && echo "Recreated dev from main"
|
||||
|
||||
echo "Dev branch reset from main (keeps dev ahead after release)" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
- name: "Step 12: Create version branch from main"
|
||||
if: steps.version.outputs.skip != 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
TOKEN="${{ secrets.GA_TOKEN }}"
|
||||
VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}"
|
||||
BRANCH_NAME="version/${VERSION}"
|
||||
MAIN_SHA=$(git rev-parse HEAD)
|
||||
|
||||
# Delete old version branch if it exists (same version re-release)
|
||||
curl -sf -X DELETE -H "Authorization: token ${TOKEN}" "${API_BASE}/branches/${BRANCH_NAME}" 2>/dev/null && echo "Deleted old ${BRANCH_NAME}"
|
||||
|
||||
# Create version/XX.YY.ZZ from main
|
||||
curl -sf -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" "${API_BASE}/branches" -d "{\"new_branch_name\":\"${BRANCH_NAME}\",\"old_branch_name\":\"main\"}" 2>/dev/null && echo "Created ${BRANCH_NAME} from main (${MAIN_SHA})" || echo "WARNING: ${BRANCH_NAME} creation failed"
|
||||
|
||||
echo "Version branch created: ${BRANCH_NAME} (${MAIN_SHA})" >> $GITHUB_STEP_SUMMARY
|
||||
echo "Dev branch reset from main (keeps dev ahead after release)" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
- name: "Step 12: Create version branch from main"
|
||||
if: steps.version.outputs.skip != 'true'
|
||||
continue-on-error: true
|
||||
run: |
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
TOKEN="${{ secrets.GA_TOKEN }}"
|
||||
VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}"
|
||||
BRANCH_NAME="version/${VERSION}"
|
||||
MAIN_SHA=$(git rev-parse HEAD)
|
||||
|
||||
# Delete old version branch if it exists (same version re-release)
|
||||
curl -sf -X DELETE -H "Authorization: token ${TOKEN}" "${API_BASE}/branches/${BRANCH_NAME}" 2>/dev/null && echo "Deleted old ${BRANCH_NAME}"
|
||||
|
||||
# Create version/XX.YY.ZZ from main
|
||||
curl -sf -X POST -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" "${API_BASE}/branches" -d "{\"new_branch_name\":\"${BRANCH_NAME}\",\"old_branch_name\":\"main\"}" 2>/dev/null && echo "Created ${BRANCH_NAME} from main (${MAIN_SHA})" || echo "WARNING: ${BRANCH_NAME} creation failed"
|
||||
|
||||
echo "Version branch created: ${BRANCH_NAME} (${MAIN_SHA})" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,18 +4,16 @@
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: Gitea.Workflow
|
||||
# INGROUP: MokoStandards.Universal
|
||||
# INGROUP: moko-platform.Universal
|
||||
# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform
|
||||
# PATH: /templates/workflows/update-server.yml
|
||||
# VERSION: 04.07.00
|
||||
# BRIEF: Update server XML feed with stable/rc/beta/alpha/dev entries (universal)
|
||||
# VERSION: 05.00.00
|
||||
# BRIEF: Pre-release build + update server XML for dev/alpha/beta/rc branches
|
||||
#
|
||||
# Writes updates.xml with multiple <update> entries:
|
||||
# - <tag>stable</tag> on push to main (from auto-release)
|
||||
# - <tag>rc</tag> on push to rc/**
|
||||
# - <tag>development</tag> on push to dev or dev/**
|
||||
# Thin wrapper around moko-platform CLI tools.
|
||||
# Builds packages, updates updates.xml, and optionally deploys via SFTP.
|
||||
#
|
||||
# Joomla filters by user's "Minimum Stability" setting.
|
||||
# Joomla filters update entries by the user's "Minimum Stability" setting.
|
||||
|
||||
name: "Update Server"
|
||||
|
||||
@@ -66,7 +64,7 @@ permissions:
|
||||
|
||||
jobs:
|
||||
update-xml:
|
||||
name: Update updates.xml
|
||||
name: Update Server
|
||||
runs-on: release
|
||||
if: >-
|
||||
github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch' || github.event_name == 'push'
|
||||
@@ -97,28 +95,29 @@ jobs:
|
||||
if [ -d "/tmp/moko-platform" ] && [ -f "/tmp/moko-platform/composer.json" ]; then
|
||||
cd /tmp/moko-platform && composer install --no-dev --no-interaction --quiet 2>/dev/null || true
|
||||
fi
|
||||
echo "MOKO_CLI=/tmp/moko-platform/cli" >> "$GITHUB_ENV"
|
||||
|
||||
- name: Generate updates.xml entry
|
||||
id: update
|
||||
- name: Detect platform
|
||||
id: platform
|
||||
run: php ${MOKO_CLI}/manifest_read.php --path . --github-output
|
||||
|
||||
- name: Resolve stability and bump version
|
||||
id: meta
|
||||
run: |
|
||||
BRANCH="${{ github.ref_name }}"
|
||||
REPO="${{ github.repository }}"
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
VERSION=$(php /tmp/moko-platform/cli/version_read.php --path . 2>/dev/null || echo "0.0.0")
|
||||
|
||||
# Auto-bump patch on all branches (dev, alpha, beta, rc)
|
||||
# Auto-bump patch version
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
BUMPED=$(php /tmp/moko-platform/cli/version_bump.php --path . 2>/dev/null || true)
|
||||
if [ -n "$BUMPED" ]; then
|
||||
VERSION=$(php /tmp/moko-platform/cli/version_read.php --path . 2>/dev/null || echo "$VERSION")
|
||||
git add -A
|
||||
git commit -m "chore(version): auto-bump patch ${VERSION} [skip ci]" \
|
||||
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>" 2>/dev/null || true
|
||||
git push 2>/dev/null || true
|
||||
fi
|
||||
php ${MOKO_CLI}/version_bump.php --path . 2>/dev/null || true
|
||||
|
||||
# Determine stability from branch or input
|
||||
VERSION=$(php ${MOKO_CLI}/version_read.php --path . 2>/dev/null || echo "0.0.0")
|
||||
|
||||
# Propagate version to all manifest files
|
||||
php ${MOKO_CLI}/version_set_platform.php --path . --version "$VERSION" --branch "$BRANCH" 2>/dev/null || true
|
||||
php ${MOKO_CLI}/version_check.php --path . --fix 2>/dev/null || true
|
||||
|
||||
# Determine stability from branch or manual input
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
STABILITY="${{ inputs.stability }}"
|
||||
elif [[ "$BRANCH" == rc/* ]]; then
|
||||
@@ -127,258 +126,83 @@ jobs:
|
||||
STABILITY="beta"
|
||||
elif [[ "$BRANCH" == alpha/* ]]; then
|
||||
STABILITY="alpha"
|
||||
elif [[ "$BRANCH" == dev/* ]] || [[ "$BRANCH" == "dev" ]]; then
|
||||
else
|
||||
STABILITY="development"
|
||||
else
|
||||
STABILITY="stable"
|
||||
fi
|
||||
|
||||
# Version suffix
|
||||
case "$STABILITY" in
|
||||
development) SUFFIX="-dev"; TAG="development" ;;
|
||||
alpha) SUFFIX="-alpha"; TAG="alpha" ;;
|
||||
beta) SUFFIX="-beta"; TAG="beta" ;;
|
||||
rc) SUFFIX="-rc"; TAG="release-candidate" ;;
|
||||
*) SUFFIX=""; TAG="stable" ;;
|
||||
esac
|
||||
|
||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT"
|
||||
echo "suffix=${SUFFIX}" >> "$GITHUB_OUTPUT"
|
||||
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||
echo "display_version=${VERSION}${SUFFIX}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
# Parse manifest (portable — no grep -P)
|
||||
MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" ! -path "./build/*" -exec grep -l '<extension' {} \; 2>/dev/null | head -1)
|
||||
if [ -z "$MANIFEST" ]; then
|
||||
echo "No Joomla manifest found — skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Extract fields using sed (works on all runners)
|
||||
EXT_NAME=$(sed -n 's/.*<name>\([^<]*\)<\/name>.*/\1/p' "$MANIFEST" | head -1)
|
||||
EXT_TYPE=$(sed -n 's/.*<extension[^>]*type="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1)
|
||||
EXT_ELEMENT=$(sed -n 's/.*<element>\([^<]*\)<\/element>.*/\1/p' "$MANIFEST" | head -1)
|
||||
EXT_CLIENT=$(sed -n 's/.*<extension[^>]*client="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1)
|
||||
EXT_FOLDER=$(sed -n 's/.*<extension[^>]*group="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1)
|
||||
EXT_VERSION=$(sed -n 's/.*<version>\([^<]*\)<\/version>.*/\1/p' "$MANIFEST" | head -1)
|
||||
TARGET_PLATFORM=$(sed -n 's/.*\(<targetplatform[^/]*\/>\).*/\1/p' "$MANIFEST" | head -1)
|
||||
PHP_MINIMUM=$(sed -n 's/.*<php_minimum>\([^<]*\)<\/php_minimum>.*/\1/p' "$MANIFEST" | head -1)
|
||||
|
||||
# Fallbacks
|
||||
[ -z "$EXT_NAME" ] && EXT_NAME="${{ github.event.repository.name }}"
|
||||
[ -z "$EXT_TYPE" ] && EXT_TYPE="component"
|
||||
|
||||
# Derive element if not in manifest: try XML filename, then repo name
|
||||
if [ -z "$EXT_ELEMENT" ]; then
|
||||
EXT_ELEMENT=$(basename "$MANIFEST" .xml | tr '[:upper:]' '[:lower:]')
|
||||
case "$EXT_ELEMENT" in
|
||||
templatedetails|manifest|*.xml) EXT_ELEMENT=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]' | tr -d ' -') ;;
|
||||
esac
|
||||
fi
|
||||
|
||||
# Use manifest version if README version is empty
|
||||
[ "$VERSION" = "0.0.0" ] && [ -n "$EXT_VERSION" ] && VERSION="$EXT_VERSION"
|
||||
|
||||
[ -z "$TARGET_PLATFORM" ] && TARGET_PLATFORM=$(printf '<targetplatform name="joomla" version="((5.[0-9])|(6.[0-9]))" %s>' "/")
|
||||
|
||||
# Joomla requires <client> on ALL extension types for update matching
|
||||
if [ -n "$EXT_CLIENT" ]; then
|
||||
CLIENT_TAG="<client>${EXT_CLIENT}</client>"
|
||||
else
|
||||
CLIENT_TAG="<client>site</client>"
|
||||
fi
|
||||
|
||||
FOLDER_TAG=""
|
||||
[ -n "$EXT_FOLDER" ] && [ "$EXT_TYPE" = "plugin" ] && FOLDER_TAG="<folder>${EXT_FOLDER}</folder>"
|
||||
|
||||
PHP_TAG=""
|
||||
[ -n "$PHP_MINIMUM" ] && PHP_TAG="<php_minimum>${PHP_MINIMUM}</php_minimum>"
|
||||
|
||||
# Version suffix for non-stable
|
||||
DISPLAY_VERSION="$VERSION"
|
||||
case "$STABILITY" in
|
||||
development) DISPLAY_VERSION="${VERSION}-dev" ;;
|
||||
alpha) DISPLAY_VERSION="${VERSION}-alpha" ;;
|
||||
beta) DISPLAY_VERSION="${VERSION}-beta" ;;
|
||||
rc) DISPLAY_VERSION="${VERSION}-rc" ;;
|
||||
esac
|
||||
|
||||
MAJOR=$(echo "$VERSION" | awk -F. '{print $1}')
|
||||
|
||||
# Each stability level has its own release tag
|
||||
case "$STABILITY" in
|
||||
development) RELEASE_TAG="development" ;;
|
||||
alpha) RELEASE_TAG="alpha" ;;
|
||||
beta) RELEASE_TAG="beta" ;;
|
||||
rc) RELEASE_TAG="release-candidate" ;;
|
||||
*) RELEASE_TAG="v${MAJOR}" ;;
|
||||
esac
|
||||
|
||||
PACKAGE_NAME="${EXT_ELEMENT}-${DISPLAY_VERSION}.zip"
|
||||
DOWNLOAD_URL="${GITEA_URL}/${GITEA_ORG}/${GITEA_REPO}/releases/download/${RELEASE_TAG}/${PACKAGE_NAME}"
|
||||
INFO_URL="${GITEA_URL}/${GITEA_ORG}/${GITEA_REPO}"
|
||||
|
||||
# -- Build install packages (ZIP + tar.gz) --------------------
|
||||
SOURCE_DIR="src"
|
||||
[ ! -d "$SOURCE_DIR" ] && SOURCE_DIR="htdocs"
|
||||
if [ -d "$SOURCE_DIR" ]; then
|
||||
EXCLUDES=".ftpignore sftp-config* *.ppk *.pem *.key .env*"
|
||||
TAR_NAME="${EXT_ELEMENT}-${DISPLAY_VERSION}.tar.gz"
|
||||
|
||||
cd "$SOURCE_DIR"
|
||||
zip -r "/tmp/${PACKAGE_NAME}" . -x $EXCLUDES
|
||||
cd ..
|
||||
tar -czf "/tmp/${TAR_NAME}" -C "$SOURCE_DIR" \
|
||||
--exclude='.ftpignore' --exclude='sftp-config*' \
|
||||
--exclude='*.ppk' --exclude='*.pem' --exclude='*.key' --exclude='.env*' .
|
||||
|
||||
SHA256=$(sha256sum "/tmp/${PACKAGE_NAME}" | cut -d' ' -f1)
|
||||
|
||||
# Ensure release exists on Gitea
|
||||
RELEASE_JSON=$(curl -sf -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
"${API_BASE}/releases/tags/${RELEASE_TAG}" 2>/dev/null || true)
|
||||
RELEASE_ID=$(echo "$RELEASE_JSON" | python3 -c "import sys,json; print(json.load(sys.stdin).get('id',''))" 2>/dev/null || true)
|
||||
|
||||
if [ -z "$RELEASE_ID" ]; then
|
||||
# Create release
|
||||
RELEASE_JSON=$(curl -sf -X POST -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
-H "Content-Type: application/json" \
|
||||
"${API_BASE}/releases" \
|
||||
-d "$(python3 -c "import json; print(json.dumps({
|
||||
'tag_name': '${RELEASE_TAG}',
|
||||
'name': '${RELEASE_TAG} (${DISPLAY_VERSION})',
|
||||
'body': '${STABILITY} release',
|
||||
'prerelease': True,
|
||||
'target_commitish': 'main'
|
||||
}))")" 2>/dev/null || true)
|
||||
RELEASE_ID=$(echo "$RELEASE_JSON" | python3 -c "import sys,json; print(json.load(sys.stdin).get('id',''))" 2>/dev/null || true)
|
||||
fi
|
||||
|
||||
if [ -n "$RELEASE_ID" ]; then
|
||||
# Delete existing assets with same name before uploading
|
||||
ASSETS=$(curl -sf -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
"${API_BASE}/releases/${RELEASE_ID}/assets" 2>/dev/null || echo "[]")
|
||||
for ASSET_FILE in "$PACKAGE_NAME" "$TAR_NAME"; do
|
||||
ASSET_ID=$(echo "$ASSETS" | python3 -c "
|
||||
import sys,json
|
||||
assets = json.load(sys.stdin)
|
||||
for a in assets:
|
||||
if a['name'] == '${ASSET_FILE}':
|
||||
print(a['id']); break
|
||||
" 2>/dev/null || true)
|
||||
if [ -n "$ASSET_ID" ]; then
|
||||
curl -sf -X DELETE -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
"${API_BASE}/releases/${RELEASE_ID}/assets/${ASSET_ID}" 2>/dev/null || true
|
||||
fi
|
||||
done
|
||||
|
||||
# Upload both formats
|
||||
curl -sf -X POST -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"/tmp/${PACKAGE_NAME}" \
|
||||
"${API_BASE}/releases/${RELEASE_ID}/assets?name=${PACKAGE_NAME}" > /dev/null 2>&1 || true
|
||||
|
||||
curl -sf -X POST -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"/tmp/${TAR_NAME}" \
|
||||
"${API_BASE}/releases/${RELEASE_ID}/assets?name=${TAR_NAME}" > /dev/null 2>&1 || true
|
||||
fi
|
||||
|
||||
echo "Packages: ${PACKAGE_NAME} + ${TAR_NAME} (SHA: ${SHA256})" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
SHA256=""
|
||||
fi
|
||||
|
||||
# -- Build the new entry (canonical format matching release.yml) --
|
||||
NEW_ENTRY=""
|
||||
NEW_ENTRY="${NEW_ENTRY} <update>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <name>${EXT_NAME}</name>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <description>${EXT_NAME} ${STABILITY} build.</description>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <element>${EXT_ELEMENT}</element>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <type>${EXT_TYPE}</type>\n"
|
||||
[ -n "$CLIENT_TAG" ] && NEW_ENTRY="${NEW_ENTRY} ${CLIENT_TAG}\n"
|
||||
[ -n "$FOLDER_TAG" ] && NEW_ENTRY="${NEW_ENTRY} ${FOLDER_TAG}\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <version>${VERSION}</version>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <creationDate>$(date +%Y-%m-%d)</creationDate>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <infourl title='${EXT_NAME}'>https://git.mokoconsulting.tech/${GITEA_ORG}/${GITEA_REPO}/releases/tag/${RELEASE_TAG}</infourl>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <downloads>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <downloadurl type='full' format='zip'>${DOWNLOAD_URL}</downloadurl>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} </downloads>\n"
|
||||
[ -n "$SHA256" ] && NEW_ENTRY="${NEW_ENTRY} <sha256>${SHA256}</sha256>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <tags><tag>${STABILITY}</tag></tags>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <maintainer>Moko Consulting</maintainer>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <maintainerurl>https://mokoconsulting.tech</maintainerurl>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} <targetplatform name='joomla' version='(5|6).*'/>\n"
|
||||
[ -n "$PHP_MINIMUM" ] && NEW_ENTRY="${NEW_ENTRY} <php_minimum>${PHP_MINIMUM}</php_minimum>\n"
|
||||
NEW_ENTRY="${NEW_ENTRY} </update>"
|
||||
|
||||
# -- Write new entry to temp file --------------------------------
|
||||
printf '%b' "$NEW_ENTRY" > /tmp/new_entry.xml
|
||||
|
||||
# -- Merge into updates.xml ----------------------------------------
|
||||
# Cascade: stable→all | rc→rc+lower | beta→beta+lower | alpha→alpha+dev | dev→dev
|
||||
CASCADE_MAP="stable:development,alpha,beta,rc,stable rc:development,alpha,beta,rc beta:development,alpha,beta alpha:development,alpha development:development"
|
||||
TARGETS=""
|
||||
for entry in $CASCADE_MAP; do
|
||||
key="${entry%%:*}"
|
||||
vals="${entry#*:}"
|
||||
if [ "$key" = "${STABILITY}" ]; then
|
||||
TARGETS="$vals"
|
||||
break
|
||||
fi
|
||||
done
|
||||
[ -z "$TARGETS" ] && TARGETS="${STABILITY}"
|
||||
|
||||
echo "Cascade: ${STABILITY} → ${TARGETS}"
|
||||
|
||||
# Create updates.xml if missing
|
||||
if [ ! -f "updates.xml" ]; then
|
||||
printf '%s\n' "<?xml version='1.0' encoding='UTF-8'?>" > updates.xml
|
||||
printf '%s\n' "<!-- Copyright (C) $(date +%Y) Moko Consulting -->" >> updates.xml
|
||||
printf '%s\n' "<updates>" >> updates.xml
|
||||
printf '%s\n' "</updates>" >> updates.xml
|
||||
fi
|
||||
|
||||
# Update existing blocks or create missing ones
|
||||
export PY_TARGETS="$TARGETS" PY_VERSION="$VERSION" PY_DATE="$(date +%Y-%m-%d)"
|
||||
python3 << 'PYEOF'
|
||||
import re, os
|
||||
|
||||
targets = os.environ["PY_TARGETS"].split(",")
|
||||
version = os.environ["PY_VERSION"]
|
||||
date = os.environ["PY_DATE"]
|
||||
|
||||
with open("updates.xml") as f:
|
||||
content = f.read()
|
||||
with open("/tmp/new_entry.xml") as f:
|
||||
new_entry_template = f.read()
|
||||
|
||||
for tag in targets:
|
||||
tag = tag.strip()
|
||||
# Build entry with this tag's name
|
||||
new_entry = re.sub(r"<tag>[^<]*</tag>", f"<tag>{tag}</tag>", new_entry_template)
|
||||
|
||||
# Try to find existing block (handles both single-line and multi-line <tags>)
|
||||
block_pattern = r"(<update>(?:(?!</update>).)*?<tag>" + re.escape(tag) + r"</tag>.*?</update>)"
|
||||
match = re.search(block_pattern, content, re.DOTALL)
|
||||
|
||||
if match:
|
||||
# Update in place — replace entire block
|
||||
content = content.replace(match.group(1), new_entry.strip())
|
||||
print(f" UPDATED: <tag>{tag}</tag> → {version}")
|
||||
else:
|
||||
# Create — insert before </updates>
|
||||
content = content.replace("</updates>", "\n" + new_entry.strip() + "\n\n</updates>")
|
||||
print(f" CREATED: <tag>{tag}</tag> → {version}")
|
||||
|
||||
# Clean up excessive blank lines
|
||||
content = re.sub(r"\n{3,}", "\n\n", content)
|
||||
|
||||
with open("updates.xml", "w") as f:
|
||||
f.write(content)
|
||||
PYEOF
|
||||
|
||||
# Commit
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
git add updates.xml
|
||||
# Commit version bump if changed
|
||||
git add -A
|
||||
git diff --cached --quiet || {
|
||||
git commit -m "chore: update updates.xml (${STABILITY}: ${DISPLAY_VERSION}) [skip ci]" \
|
||||
git commit -m "chore(version): auto-bump ${VERSION} [skip ci]" \
|
||||
--author="gitea-actions[bot] <gitea-actions[bot]@mokoconsulting.tech>"
|
||||
git push
|
||||
}
|
||||
|
||||
# -- Sync updates.xml to main (for non-main branches) ----------------------
|
||||
- name: Create release and upload package
|
||||
id: package
|
||||
run: |
|
||||
VERSION="${{ steps.meta.outputs.version }}"
|
||||
TAG="${{ steps.meta.outputs.tag }}"
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
|
||||
# Create or update Gitea release
|
||||
php ${MOKO_CLI}/release_create.php \
|
||||
--path . --version "$VERSION" --tag "$TAG" \
|
||||
--token "${{ secrets.GA_TOKEN }}" --api-base "$API_BASE" \
|
||||
--repo "${GITEA_REPO}" --branch "${{ github.ref_name }}" --prerelease
|
||||
|
||||
# Build package and upload
|
||||
php ${MOKO_CLI}/release_package.php \
|
||||
--path . --version "$VERSION" --tag "$TAG" \
|
||||
--token "${{ secrets.GA_TOKEN }}" --api-base "$API_BASE" \
|
||||
--repo "${GITEA_REPO}" --output /tmp || true
|
||||
|
||||
- name: Update updates.xml
|
||||
if: steps.platform.outputs.platform == 'joomla'
|
||||
run: |
|
||||
VERSION="${{ steps.meta.outputs.version }}"
|
||||
STABILITY="${{ steps.meta.outputs.stability }}"
|
||||
SHA256="${{ steps.package.outputs.sha256_zip }}"
|
||||
|
||||
if [ ! -f "updates.xml" ]; then
|
||||
echo "No updates.xml — skipping"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
SHA_FLAG=""
|
||||
[ -n "$SHA256" ] && SHA_FLAG="--sha ${SHA256}"
|
||||
|
||||
php ${MOKO_CLI}/updates_xml_build.php \
|
||||
--path . --version "${VERSION}" --stability "${STABILITY}" \
|
||||
--gitea-url "${GITEA_URL}" --org "${GITEA_ORG}" --repo "${GITEA_REPO}" \
|
||||
${SHA_FLAG}
|
||||
|
||||
# Commit and push updates.xml
|
||||
git config --local user.email "gitea-actions[bot]@mokoconsulting.tech"
|
||||
git config --local user.name "gitea-actions[bot]"
|
||||
git add updates.xml
|
||||
git diff --cached --quiet || {
|
||||
git commit -m "chore: update ${STABILITY} channel ${VERSION} [skip ci]"
|
||||
git push
|
||||
}
|
||||
|
||||
- name: Sync updates.xml to main
|
||||
if: github.ref_name != 'main'
|
||||
if: github.ref_name != 'main' && steps.platform.outputs.platform == 'joomla'
|
||||
run: |
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
GA_TOKEN="${{ secrets.GA_TOKEN }}"
|
||||
@@ -394,7 +218,7 @@ jobs:
|
||||
payload = json.dumps({
|
||||
'content': content,
|
||||
'sha': '${FILE_SHA}',
|
||||
'message': 'chore: sync updates.xml from ${STABILITY} [skip ci]',
|
||||
'message': 'chore: sync updates.xml from ${{ steps.meta.outputs.stability }} [skip ci]',
|
||||
'branch': 'main'
|
||||
}).encode()
|
||||
req = urllib.request.Request(
|
||||
@@ -408,13 +232,8 @@ jobs:
|
||||
urllib.request.urlopen(req)
|
||||
print('updates.xml synced to main')
|
||||
except Exception as e:
|
||||
print(f'ERROR: failed to sync updates.xml to main: {e}', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
" \
|
||||
&& echo "updates.xml synced to main (${STABILITY})" >> $GITHUB_STEP_SUMMARY \
|
||||
|| echo "::error::failed to sync updates.xml to main" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "::error::could not get updates.xml SHA from main — file may not exist on main yet" >> $GITHUB_STEP_SUMMARY
|
||||
print(f'WARNING: sync to main failed: {e}', file=sys.stderr)
|
||||
"
|
||||
fi
|
||||
|
||||
- name: SFTP deploy to dev server
|
||||
@@ -428,9 +247,8 @@ jobs:
|
||||
DEV_KEY: ${{ secrets.DEV_FTP_KEY }}
|
||||
DEV_PASS: ${{ secrets.DEV_FTP_PASSWORD }}
|
||||
run: |
|
||||
# -- Permission check: admin or maintain role required --------
|
||||
# Permission check: admin or maintain role required
|
||||
ACTOR="${{ github.actor }}"
|
||||
REPO="${{ github.repository }}"
|
||||
API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}"
|
||||
|
||||
PERMISSION=$(curl -sf -H "Authorization: token ${{ secrets.GA_TOKEN }}" \
|
||||
@@ -463,198 +281,24 @@ jobs:
|
||||
printf ',"password":"%s"}' "$DEV_PASS" >> /tmp/sftp-config.json
|
||||
fi
|
||||
|
||||
PLATFORM=$(php /tmp/moko-platform/cli/platform_detect.php --path . 2>/dev/null || true)
|
||||
if [ "$PLATFORM" = "waas-component" ] && [ -f "/tmp/moko-platform/deploy/deploy-joomla.php" ]; then
|
||||
php /tmp/moko-platform/deploy/deploy-joomla.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||
elif [ -f "/tmp/moko-platform/deploy/deploy-sftp.php" ]; then
|
||||
php /tmp/moko-platform/deploy/deploy-sftp.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||
PLATFORM=$(php ${MOKO_CLI}/platform_detect.php --path . 2>/dev/null || true)
|
||||
if [ "$PLATFORM" = "waas-component" ] && [ -f "${MOKO_CLI}/../deploy/deploy-joomla.php" ]; then
|
||||
php ${MOKO_CLI}/../deploy/deploy-joomla.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||
elif [ -f "${MOKO_CLI}/../deploy/deploy-sftp.php" ]; then
|
||||
php ${MOKO_CLI}/../deploy/deploy-sftp.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json
|
||||
fi
|
||||
rm -f /tmp/deploy_key /tmp/sftp-config.json
|
||||
echo "SFTP deploy to dev complete" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
- name: Validate updates.xml integrity
|
||||
run: |
|
||||
ERRORS=0
|
||||
|
||||
if [ ! -f "updates.xml" ]; then
|
||||
echo "::error::updates.xml not found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Well-formed XML
|
||||
if ! python3 -c "import xml.etree.ElementTree as ET; ET.parse('updates.xml')" 2>/dev/null; then
|
||||
echo "::error::updates.xml is not valid XML"
|
||||
ERRORS=$((ERRORS+1))
|
||||
fi
|
||||
|
||||
python3 << 'PYEOF'
|
||||
import xml.etree.ElementTree as ET, sys, re, os
|
||||
|
||||
tree = ET.parse("updates.xml")
|
||||
root = tree.getroot()
|
||||
updates = root.findall("update")
|
||||
errors = 0
|
||||
warnings = 0
|
||||
seen_tags = set()
|
||||
|
||||
# All 5 channels MUST be present
|
||||
REQUIRED_CHANNELS = {"stable", "rc", "beta", "alpha", "dev"}
|
||||
VALID_TAGS = REQUIRED_CHANNELS | {"development"} # accept legacy alias
|
||||
REPO = os.environ.get("GITEA_REPO", "")
|
||||
ORG = os.environ.get("GITEA_ORG", "MokoConsulting")
|
||||
REPO_BASE = f"https://git.mokoconsulting.tech/{ORG}/"
|
||||
|
||||
# Gitea release tag names per channel (Moko standard)
|
||||
RELEASE_TAG_MAP = {
|
||||
"stable": "stable",
|
||||
"rc": "release-candidate",
|
||||
"beta": "beta",
|
||||
"alpha": "alpha",
|
||||
"dev": "development",
|
||||
"development": "development",
|
||||
}
|
||||
|
||||
# Joomla update XML required fields per
|
||||
# https://docs.joomla.org/Deploying_an_Update_Server
|
||||
REQUIRED_FIELDS = ["name", "element", "type", "version", "infourl"]
|
||||
|
||||
for i, u in enumerate(updates):
|
||||
tag_el = u.find("tags/tag")
|
||||
tag = tag_el.text.strip() if tag_el is not None and tag_el.text else None
|
||||
label = f"Entry {i+1} (<tag>{tag or '?'}</tag>)"
|
||||
|
||||
# -- Required Joomla fields --
|
||||
for field in REQUIRED_FIELDS:
|
||||
el = u.find(field)
|
||||
if el is None or not (el.text or "").strip():
|
||||
print(f"::error::{label}: missing required <{field}>")
|
||||
errors += 1
|
||||
|
||||
# -- <downloads><downloadurl> --
|
||||
dl = u.find("downloads/downloadurl")
|
||||
if dl is None or not (dl.text or "").strip():
|
||||
print(f"::error::{label}: missing <downloads><downloadurl>")
|
||||
errors += 1
|
||||
else:
|
||||
dl_url = dl.text.strip()
|
||||
# Must point to org repo
|
||||
if REPO_BASE not in dl_url:
|
||||
print(f"::error::{label}: download URL not under {REPO_BASE}: {dl_url}")
|
||||
errors += 1
|
||||
# Must end in .zip
|
||||
if not dl_url.endswith(".zip"):
|
||||
print(f"::error::{label}: download URL must end in .zip: {dl_url}")
|
||||
errors += 1
|
||||
# Must use correct Gitea release tag in path
|
||||
if tag and tag in RELEASE_TAG_MAP:
|
||||
expected_tag = RELEASE_TAG_MAP[tag]
|
||||
if f"/download/{expected_tag}/" not in dl_url:
|
||||
print(f"::error::{label}: download URL should contain /download/{expected_tag}/ but got: {dl_url}")
|
||||
errors += 1
|
||||
|
||||
# -- <client> (required for Joomla to match update) --
|
||||
client = u.find("client")
|
||||
if client is None or not (client.text or "").strip():
|
||||
print(f"::error::{label}: missing <client> (required for Joomla update matching)")
|
||||
errors += 1
|
||||
|
||||
# -- <targetplatform> --
|
||||
tp = u.find("targetplatform")
|
||||
if tp is None:
|
||||
print(f"::error::{label}: missing <targetplatform>")
|
||||
errors += 1
|
||||
else:
|
||||
tp_name = tp.get("name", "")
|
||||
tp_ver = tp.get("version", "")
|
||||
if tp_name != "joomla":
|
||||
print(f"::error::{label}: targetplatform name should be 'joomla', got '{tp_name}'")
|
||||
errors += 1
|
||||
if not tp_ver:
|
||||
print(f"::error::{label}: targetplatform missing version regex")
|
||||
errors += 1
|
||||
elif "5" not in tp_ver or "6" not in tp_ver:
|
||||
print(f"::warning::{label}: targetplatform version may not cover Joomla 5+6: {tp_ver}")
|
||||
warnings += 1
|
||||
|
||||
# -- <type> must be valid Joomla type --
|
||||
type_el = u.find("type")
|
||||
if type_el is not None and type_el.text:
|
||||
valid_types = {"component", "module", "plugin", "template", "library", "package", "file"}
|
||||
if type_el.text.strip() not in valid_types:
|
||||
print(f"::error::{label}: invalid type '{type_el.text}' (expected: {valid_types})")
|
||||
errors += 1
|
||||
|
||||
# -- <version> format (XX.YY.ZZ with optional suffix) --
|
||||
ver_el = u.find("version")
|
||||
if ver_el is not None and ver_el.text:
|
||||
if not re.match(r"^\d{2}\.\d{2}\.\d{2}(-\w+)?$", ver_el.text.strip()):
|
||||
print(f"::warning::{label}: version '{ver_el.text}' does not match XX.YY.ZZ format")
|
||||
warnings += 1
|
||||
|
||||
# -- <maintainer> and <maintainerurl> --
|
||||
for field in ["maintainer", "maintainerurl"]:
|
||||
el = u.find(field)
|
||||
if el is None or not (el.text or "").strip():
|
||||
print(f"::warning::{label}: missing <{field}>")
|
||||
warnings += 1
|
||||
|
||||
# -- Valid stability tag --
|
||||
if tag is None:
|
||||
print(f"::error::{label}: missing <tags><tag>")
|
||||
errors += 1
|
||||
elif tag not in VALID_TAGS:
|
||||
print(f"::error::{label}: invalid tag '{tag}' (expected: {VALID_TAGS})")
|
||||
errors += 1
|
||||
|
||||
# -- Duplicate tag check --
|
||||
norm_tag = "dev" if tag == "development" else tag
|
||||
if norm_tag in seen_tags:
|
||||
print(f"::error::{label}: duplicate channel '{tag}'")
|
||||
errors += 1
|
||||
if norm_tag:
|
||||
seen_tags.add(norm_tag)
|
||||
|
||||
# -- All 5 channels must exist --
|
||||
missing = REQUIRED_CHANNELS - seen_tags
|
||||
if missing:
|
||||
print(f"::error::Missing required update channels: {', '.join(sorted(missing))}")
|
||||
errors += 1
|
||||
|
||||
# -- Version ordering: higher stability must not exceed dev version --
|
||||
channel_versions = {}
|
||||
for u in updates:
|
||||
tag_el = u.find("tags/tag")
|
||||
ver_el = u.find("version")
|
||||
if tag_el is not None and ver_el is not None and tag_el.text and ver_el.text:
|
||||
norm = "dev" if tag_el.text.strip() == "development" else tag_el.text.strip()
|
||||
# Strip suffix for comparison (01.00.18-dev -> 01.00.18)
|
||||
base_ver = re.sub(r"-\w+$", "", ver_el.text.strip())
|
||||
channel_versions[norm] = base_ver
|
||||
|
||||
# Cascade check: dev >= alpha >= beta >= rc >= stable
|
||||
ORDER = ["dev", "alpha", "beta", "rc", "stable"]
|
||||
for j in range(1, len(ORDER)):
|
||||
current = ORDER[j]
|
||||
previous = ORDER[j - 1]
|
||||
if current in channel_versions and previous in channel_versions:
|
||||
if channel_versions[current] > channel_versions[previous]:
|
||||
print(f"::error::{current} version ({channel_versions[current]}) is ahead of {previous} ({channel_versions[previous]})")
|
||||
errors += 1
|
||||
|
||||
# -- Summary --
|
||||
print(f"\nupdates.xml validation: {len(updates)} entries, {errors} error(s), {warnings} warning(s)")
|
||||
if errors > 0:
|
||||
sys.exit(1)
|
||||
PYEOF
|
||||
|
||||
- name: Summary
|
||||
if: always()
|
||||
run: |
|
||||
echo "## Joomla Update Server" >> $GITHUB_STEP_SUMMARY
|
||||
VERSION="${{ steps.meta.outputs.version }}"
|
||||
STABILITY="${{ steps.meta.outputs.stability }}"
|
||||
DISPLAY="${{ steps.meta.outputs.display_version }}"
|
||||
echo "## Update Server" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Field | Value |" >> $GITHUB_STEP_SUMMARY
|
||||
echo "|-------|-------|" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Stability | \`${STABILITY}\` |" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Version | \`${DISPLAY_VERSION}\` |" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Element | \`${EXT_ELEMENT}\` |" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Download | [ZIP](${DOWNLOAD_URL}) |" >> $GITHUB_STEP_SUMMARY
|
||||
echo "| Version | \`${DISPLAY}\` |" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
@@ -34,6 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
### Added
|
||||
- `branch-cleanup.yml`: auto-delete merged feature branches after PR merge
|
||||
- `plg_webservices_perfectpublisher`: REST API for Perfect Publisher (com_autotweet) — channels, posts, requests, rules, feeds, and stats
|
||||
|
||||
### Planned
|
||||
- License/subscription check
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
DEFGROUP: Joomla.Plugin
|
||||
INGROUP: MokoWaaS
|
||||
REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS
|
||||
VERSION: 02.12.00
|
||||
VERSION: 02.15.00
|
||||
PATH: /README.md
|
||||
BRIEF: MokoWaaS platform plugin for Joomla
|
||||
-->
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
<license>GPL-3.0-or-later</license>
|
||||
<authorEmail>hello@mokoconsulting.tech</authorEmail>
|
||||
<authorUrl>https://mokoconsulting.tech</authorUrl>
|
||||
<version>02.12.00</version>
|
||||
<version>02.15.00</version>
|
||||
<description>Minimal API-only component for MokoWaaS. Provides REST endpoints for site health, cache, updates, and backups.</description>
|
||||
<namespace path="api/src">Moko\Component\MokoWaaS\Api</namespace>
|
||||
<administration>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<license>GNU General Public License version 3 or later; see LICENSE.md</license>
|
||||
<authorEmail>hello@mokoconsulting.tech</authorEmail>
|
||||
<authorUrl>https://mokoconsulting.tech</authorUrl>
|
||||
<version>02.12.00</version>
|
||||
<version>02.15.00</version>
|
||||
<description>This plugin rebrands the Joomla system interface with MokoWaaS identity. It applies language overrides and ensures consistent branding across the platform.</description>
|
||||
<namespace path=".">Moko\Plugin\System\MokoWaaS</namespace>
|
||||
<scriptfile>script.php</scriptfile>
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
<license>GPL-3.0-or-later</license>
|
||||
<authorEmail>hello@mokoconsulting.tech</authorEmail>
|
||||
<authorUrl>https://mokoconsulting.tech</authorUrl>
|
||||
<version>02.12.00</version>
|
||||
<version>02.15.00</version>
|
||||
<description>Joomla Web Services API routes for MokoWaaS site management — health checks, cache, updates, backups, and site info.</description>
|
||||
<namespace path="src">Moko\Plugin\WebServices\MokoWaaS</namespace>
|
||||
<files>
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<extension type="plugin" group="webservices" method="upgrade">
|
||||
<name>Web Services - Perfect Publisher</name>
|
||||
<author>Moko Consulting</author>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<copyright>Copyright (C) 2026 Moko Consulting. All rights reserved.</copyright>
|
||||
<license>GPL-3.0-or-later</license>
|
||||
<authorEmail>hello@mokoconsulting.tech</authorEmail>
|
||||
<authorUrl>https://mokoconsulting.tech</authorUrl>
|
||||
<version>02.15.00</version>
|
||||
<description>Joomla Web Services API routes for Perfect Publisher (com_autotweet) — channels, posts, requests, rules, and feeds.</description>
|
||||
<namespace path="src">Moko\Plugin\WebServices\PerfectPublisher</namespace>
|
||||
<files>
|
||||
<folder plugin="perfectpublisher">services</folder>
|
||||
<folder>src</folder>
|
||||
</files>
|
||||
</extension>
|
||||
@@ -0,0 +1,42 @@
|
||||
<?php
|
||||
/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
* FILE INFORMATION
|
||||
* DEFGROUP: Joomla.Plugin
|
||||
* INGROUP: MokoWaaS
|
||||
* REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS
|
||||
* PATH: /src/packages/plg_webservices_perfectpublisher/services/provider.php
|
||||
* VERSION: 02.13.01
|
||||
* BRIEF: DI service provider for Perfect Publisher Web Services plugin
|
||||
*/
|
||||
|
||||
defined('_JEXEC') or die;
|
||||
|
||||
use Joomla\CMS\Extension\PluginInterface;
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Plugin\PluginHelper;
|
||||
use Joomla\DI\Container;
|
||||
use Joomla\DI\ServiceProviderInterface;
|
||||
use Joomla\Event\DispatcherInterface;
|
||||
use Moko\Plugin\WebServices\PerfectPublisher\Extension\PerfectPublisherApi;
|
||||
|
||||
return new class implements ServiceProviderInterface
|
||||
{
|
||||
public function register(Container $container): void
|
||||
{
|
||||
$container->set(
|
||||
PluginInterface::class,
|
||||
function (Container $container) {
|
||||
$dispatcher = $container->get(DispatcherInterface::class);
|
||||
$plugin = new PerfectPublisherApi(
|
||||
$dispatcher,
|
||||
(array) PluginHelper::getPlugin('webservices', 'perfectpublisher')
|
||||
);
|
||||
$plugin->setApplication(Factory::getApplication());
|
||||
return $plugin;
|
||||
}
|
||||
);
|
||||
}
|
||||
};
|
||||
@@ -0,0 +1,539 @@
|
||||
<?php
|
||||
/* Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||
*
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*
|
||||
* FILE INFORMATION
|
||||
* DEFGROUP: Joomla.Plugin
|
||||
* INGROUP: MokoWaaS
|
||||
* REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS
|
||||
* PATH: /src/packages/plg_webservices_perfectpublisher/src/Extension/PerfectPublisherApi.php
|
||||
* VERSION: 02.13.01
|
||||
* BRIEF: Web Services API plugin for Perfect Publisher (com_autotweet)
|
||||
*/
|
||||
|
||||
namespace Moko\Plugin\WebServices\PerfectPublisher\Extension;
|
||||
|
||||
defined('_JEXEC') or die;
|
||||
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Plugin\CMSPlugin;
|
||||
use Joomla\CMS\Event\Application\BeforeApiRouteEvent;
|
||||
use Joomla\CMS\Router\ApiRouter;
|
||||
use Joomla\Event\SubscriberInterface;
|
||||
|
||||
/**
|
||||
* Perfect Publisher Web Services API Plugin
|
||||
*
|
||||
* Registers REST API routes for Perfect Publisher (com_autotweet) data.
|
||||
* Provides read access to channels, posts, requests, rules, and feeds.
|
||||
* Provides write access to create publish requests.
|
||||
*
|
||||
* Routes:
|
||||
* GET /v1/perfectpublisher/channels List social channels
|
||||
* GET /v1/perfectpublisher/channels/:id Get channel detail
|
||||
* GET /v1/perfectpublisher/posts List published posts
|
||||
* GET /v1/perfectpublisher/posts/:id Get post detail
|
||||
* GET /v1/perfectpublisher/requests List pending requests
|
||||
* POST /v1/perfectpublisher/requests Create a publish request
|
||||
* GET /v1/perfectpublisher/rules List publishing rules
|
||||
* GET /v1/perfectpublisher/feeds List RSS feeds
|
||||
* GET /v1/perfectpublisher/channeltypes List channel type definitions
|
||||
* GET /v1/perfectpublisher/stats Dashboard statistics
|
||||
*
|
||||
* @since 02.13.01
|
||||
*/
|
||||
final class PerfectPublisherApi extends CMSPlugin implements SubscriberInterface
|
||||
{
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public static function getSubscribedEvents(): array
|
||||
{
|
||||
return [
|
||||
'onBeforeApiRoute' => 'onBeforeApiRoute',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Register API routes.
|
||||
*
|
||||
* @param BeforeApiRouteEvent $event The API route event
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function onBeforeApiRoute(BeforeApiRouteEvent $event): void
|
||||
{
|
||||
$router = $event->getRouter();
|
||||
|
||||
// All routes are handled by this plugin directly via custom callbacks
|
||||
// because com_autotweet uses FOF, not standard Joomla MVC
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/channels',
|
||||
[$this, 'getChannels']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/channels/:id',
|
||||
[$this, 'getChannel']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/posts',
|
||||
[$this, 'getPosts']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/posts/:id',
|
||||
[$this, 'getPost']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/requests',
|
||||
[$this, 'getRequests']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['POST'],
|
||||
'v1/perfectpublisher/requests',
|
||||
[$this, 'createRequest']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/rules',
|
||||
[$this, 'getRules']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/feeds',
|
||||
[$this, 'getFeeds']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/channeltypes',
|
||||
[$this, 'getChannelTypes']
|
||||
)
|
||||
);
|
||||
|
||||
$router->addRoute(
|
||||
new \Joomla\Router\Route(
|
||||
['GET'],
|
||||
'v1/perfectpublisher/stats',
|
||||
[$this, 'getStats']
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/channels
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getChannels(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
$app = Factory::getApplication();
|
||||
$limit = (int) $app->input->get('limit', 20);
|
||||
$offset = (int) $app->input->get('offset', 0);
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('c.*, ct.name AS channeltype_name, ct.max_chars')
|
||||
->from($db->quoteName('#__autotweet_channels', 'c'))
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channeltypes', 'ct')
|
||||
. ' ON ' . $db->quoteName('c.channeltype_id')
|
||||
. ' = ' . $db->quoteName('ct.id')
|
||||
)
|
||||
->order($db->quoteName('c.ordering') . ' ASC');
|
||||
|
||||
$published = $app->input->get('published', null);
|
||||
if ($published !== null) {
|
||||
$query->where($db->quoteName('c.published') . ' = ' . (int) $published);
|
||||
}
|
||||
|
||||
$db->setQuery($query, $offset, $limit);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/channels/:id
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getChannel(): void
|
||||
{
|
||||
$id = (int) Factory::getApplication()->input->get('id', 0);
|
||||
$db = Factory::getDbo();
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('c.*, ct.name AS channeltype_name, ct.max_chars, ct.description AS channeltype_desc')
|
||||
->from($db->quoteName('#__autotweet_channels', 'c'))
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channeltypes', 'ct')
|
||||
. ' ON ' . $db->quoteName('c.channeltype_id')
|
||||
. ' = ' . $db->quoteName('ct.id')
|
||||
)
|
||||
->where($db->quoteName('c.id') . ' = ' . $id);
|
||||
|
||||
$db->setQuery($query);
|
||||
$result = $db->loadObject();
|
||||
|
||||
if (!$result) {
|
||||
$this->sendJsonError('Channel not found', 404);
|
||||
return;
|
||||
}
|
||||
|
||||
// Strip sensitive OAuth params
|
||||
if (isset($result->params)) {
|
||||
$params = json_decode($result->params, true);
|
||||
if (is_array($params)) {
|
||||
foreach (['access_token', 'access_secret', 'client_secret', 'api_secret', 'password'] as $key) {
|
||||
if (isset($params[$key])) {
|
||||
$params[$key] = '***';
|
||||
}
|
||||
}
|
||||
$result->params = json_encode($params);
|
||||
}
|
||||
}
|
||||
|
||||
$this->sendJsonResponse($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/posts
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getPosts(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
$app = Factory::getApplication();
|
||||
$limit = (int) $app->input->get('limit', 20);
|
||||
$offset = (int) $app->input->get('offset', 0);
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('p.*, c.name AS channel_name')
|
||||
->from($db->quoteName('#__autotweet_posts', 'p'))
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channels', 'c')
|
||||
. ' ON ' . $db->quoteName('p.channel_id')
|
||||
. ' = ' . $db->quoteName('c.id')
|
||||
)
|
||||
->order($db->quoteName('p.postdate') . ' DESC');
|
||||
|
||||
$pubstate = $app->input->get('pubstate', '');
|
||||
if ($pubstate !== '') {
|
||||
$query->where($db->quoteName('p.pubstate') . ' = ' . $db->quote($pubstate));
|
||||
}
|
||||
|
||||
$channel = (int) $app->input->get('channel_id', 0);
|
||||
if ($channel > 0) {
|
||||
$query->where($db->quoteName('p.channel_id') . ' = ' . $channel);
|
||||
}
|
||||
|
||||
$db->setQuery($query, $offset, $limit);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/posts/:id
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getPost(): void
|
||||
{
|
||||
$id = (int) Factory::getApplication()->input->get('id', 0);
|
||||
$db = Factory::getDbo();
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('p.*, c.name AS channel_name, ct.name AS channeltype_name')
|
||||
->from($db->quoteName('#__autotweet_posts', 'p'))
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channels', 'c')
|
||||
. ' ON ' . $db->quoteName('p.channel_id')
|
||||
. ' = ' . $db->quoteName('c.id')
|
||||
)
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channeltypes', 'ct')
|
||||
. ' ON ' . $db->quoteName('c.channeltype_id')
|
||||
. ' = ' . $db->quoteName('ct.id')
|
||||
)
|
||||
->where($db->quoteName('p.id') . ' = ' . $id);
|
||||
|
||||
$db->setQuery($query);
|
||||
$result = $db->loadObject();
|
||||
|
||||
if (!$result) {
|
||||
$this->sendJsonError('Post not found', 404);
|
||||
return;
|
||||
}
|
||||
|
||||
$this->sendJsonResponse($result);
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/requests
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getRequests(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
$app = Factory::getApplication();
|
||||
$limit = (int) $app->input->get('limit', 20);
|
||||
$offset = (int) $app->input->get('offset', 0);
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('*')
|
||||
->from($db->quoteName('#__autotweet_requests'))
|
||||
->order($db->quoteName('publish_up') . ' ASC');
|
||||
|
||||
$published = $app->input->get('published', null);
|
||||
if ($published !== null) {
|
||||
$query->where($db->quoteName('published') . ' = ' . (int) $published);
|
||||
}
|
||||
|
||||
$db->setQuery($query, $offset, $limit);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* POST /v1/perfectpublisher/requests
|
||||
*
|
||||
* Create a new publish request. Required fields: description.
|
||||
* Optional: url, image_url, publish_up, plugin, priority.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function createRequest(): void
|
||||
{
|
||||
$app = Factory::getApplication();
|
||||
$db = Factory::getDbo();
|
||||
$data = json_decode($app->input->json->getRaw(), true);
|
||||
|
||||
if (empty($data['description'])) {
|
||||
$this->sendJsonError('Field "description" is required', 400);
|
||||
return;
|
||||
}
|
||||
|
||||
$now = Factory::getDate()->toSql();
|
||||
$user = Factory::getUser();
|
||||
|
||||
$row = (object) [
|
||||
'ref_id' => $data['ref_id'] ?? null,
|
||||
'plugin' => $data['plugin'] ?? 'manual-api',
|
||||
'priority' => (int) ($data['priority'] ?? 5),
|
||||
'publish_up' => $data['publish_up'] ?? $now,
|
||||
'description' => $data['description'],
|
||||
'typeinfo' => (int) ($data['typeinfo'] ?? 0),
|
||||
'url' => $data['url'] ?? null,
|
||||
'image_url' => $data['image_url'] ?? null,
|
||||
'created' => $now,
|
||||
'created_by' => $user->id,
|
||||
'params' => json_encode($data['params'] ?? []),
|
||||
'published' => (int) ($data['published'] ?? 1),
|
||||
];
|
||||
|
||||
$db->insertObject('#__autotweet_requests', $row, 'id');
|
||||
|
||||
$this->sendJsonResponse(
|
||||
['id' => $row->id, 'status' => 'created'],
|
||||
201
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/rules
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getRules(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('r.*, rt.name AS ruletype_name, rt.description AS ruletype_desc, c.name AS channel_name')
|
||||
->from($db->quoteName('#__autotweet_rules', 'r'))
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_ruletypes', 'rt')
|
||||
. ' ON ' . $db->quoteName('r.ruletype_id')
|
||||
. ' = ' . $db->quoteName('rt.id')
|
||||
)
|
||||
->leftJoin(
|
||||
$db->quoteName('#__autotweet_channels', 'c')
|
||||
. ' ON ' . $db->quoteName('r.channel_id')
|
||||
. ' = ' . $db->quoteName('c.id')
|
||||
)
|
||||
->order($db->quoteName('r.ordering') . ' ASC');
|
||||
|
||||
$db->setQuery($query);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/feeds
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getFeeds(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('*')
|
||||
->from($db->quoteName('#__autotweet_feeds'))
|
||||
->order($db->quoteName('ordering') . ' ASC');
|
||||
|
||||
$db->setQuery($query);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/channeltypes
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getChannelTypes(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
|
||||
$query = $db->getQuery(true)
|
||||
->select('*')
|
||||
->from($db->quoteName('#__autotweet_channeltypes'))
|
||||
->order($db->quoteName('id') . ' ASC');
|
||||
|
||||
$db->setQuery($query);
|
||||
|
||||
$this->sendJsonResponse($db->loadObjectList());
|
||||
}
|
||||
|
||||
/**
|
||||
* GET /v1/perfectpublisher/stats
|
||||
*
|
||||
* Dashboard statistics: post counts by status, channel counts, recent activity.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function getStats(): void
|
||||
{
|
||||
$db = Factory::getDbo();
|
||||
|
||||
// Posts by status
|
||||
$db->setQuery(
|
||||
$db->getQuery(true)
|
||||
->select('pubstate, COUNT(*) AS total')
|
||||
->from($db->quoteName('#__autotweet_posts'))
|
||||
->group($db->quoteName('pubstate'))
|
||||
);
|
||||
$postsByStatus = $db->loadObjectList('pubstate');
|
||||
|
||||
// Active channels
|
||||
$db->setQuery(
|
||||
$db->getQuery(true)
|
||||
->select('COUNT(*) AS total')
|
||||
->from($db->quoteName('#__autotweet_channels'))
|
||||
->where($db->quoteName('published') . ' = 1')
|
||||
);
|
||||
$activeChannels = (int) $db->loadResult();
|
||||
|
||||
// Pending requests
|
||||
$db->setQuery(
|
||||
$db->getQuery(true)
|
||||
->select('COUNT(*) AS total')
|
||||
->from($db->quoteName('#__autotweet_requests'))
|
||||
->where($db->quoteName('published') . ' = 1')
|
||||
);
|
||||
$pendingRequests = (int) $db->loadResult();
|
||||
|
||||
// Posts last 24h
|
||||
$db->setQuery(
|
||||
$db->getQuery(true)
|
||||
->select('COUNT(*) AS total')
|
||||
->from($db->quoteName('#__autotweet_posts'))
|
||||
->where($db->quoteName('postdate') . ' >= DATE_SUB(NOW(), INTERVAL 1 DAY)')
|
||||
);
|
||||
$posts24h = (int) $db->loadResult();
|
||||
|
||||
// Posts last 7d
|
||||
$db->setQuery(
|
||||
$db->getQuery(true)
|
||||
->select('COUNT(*) AS total')
|
||||
->from($db->quoteName('#__autotweet_posts'))
|
||||
->where($db->quoteName('postdate') . ' >= DATE_SUB(NOW(), INTERVAL 7 DAY)')
|
||||
);
|
||||
$posts7d = (int) $db->loadResult();
|
||||
|
||||
$this->sendJsonResponse([
|
||||
'posts_by_status' => $postsByStatus,
|
||||
'active_channels' => $activeChannels,
|
||||
'pending_requests' => $pendingRequests,
|
||||
'posts_24h' => $posts24h,
|
||||
'posts_7d' => $posts7d,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a JSON API response.
|
||||
*
|
||||
* @param mixed $data Response data
|
||||
* @param int $status HTTP status code
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function sendJsonResponse($data, int $status = 200): void
|
||||
{
|
||||
$app = Factory::getApplication();
|
||||
$app->setHeader('Content-Type', 'application/json; charset=utf-8');
|
||||
$app->setHeader('Status', (string) $status);
|
||||
echo json_encode(['data' => $data], JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
|
||||
$app->close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a JSON error response.
|
||||
*
|
||||
* @param string $message Error message
|
||||
* @param int $status HTTP status code
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function sendJsonError(string $message, int $status = 400): void
|
||||
{
|
||||
$app = Factory::getApplication();
|
||||
$app->setHeader('Content-Type', 'application/json; charset=utf-8');
|
||||
$app->setHeader('Status', (string) $status);
|
||||
echo json_encode(['error' => $message], JSON_UNESCAPED_SLASHES);
|
||||
$app->close();
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,7 @@
|
||||
<extension type="package" method="upgrade">
|
||||
<name>MokoWaaS</name>
|
||||
<packagename>mokowaas</packagename>
|
||||
<version>02.12.00</version>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-23</creationDate>
|
||||
<author>Moko Consulting</author>
|
||||
<authorEmail>hello@mokoconsulting.tech</authorEmail>
|
||||
@@ -16,6 +16,7 @@
|
||||
<file type="plugin" id="plg_system_mokowaas" group="system">plg_system_mokowaas.zip</file>
|
||||
<file type="component" id="com_mokowaas">com_mokowaas.zip</file>
|
||||
<file type="plugin" id="plg_webservices_mokowaas" group="webservices">plg_webservices_mokowaas.zip</file>
|
||||
<file type="plugin" id="plg_webservices_perfectpublisher" group="webservices">plg_webservices_perfectpublisher.zip</file>
|
||||
</files>
|
||||
|
||||
<updateservers>
|
||||
|
||||
+50
-41
@@ -1,89 +1,98 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<!-- Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech>
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
VERSION: 02.12.00
|
||||
VERSION: 02.15.00
|
||||
-->
|
||||
|
||||
<updates>
|
||||
<update>
|
||||
<name>MokoWaaS</name>
|
||||
<description>MokoWaaS update</description>
|
||||
<name>Package - MokoWaaS</name>
|
||||
<description>Package - MokoWaaS development build.</description>
|
||||
<element>pkg_mokowaas</element>
|
||||
<type>package</type>
|
||||
<version>02.12.00</version>
|
||||
<client>site</client>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<infourl title='Package - MokoWaaS'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.15.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<sha256>2bd856769eaeb1de09df0d4335dc6eb92f67c7e7a4f72f286f8b703c05854e06</sha256>
|
||||
<tags><tag>dev</tag></tags>
|
||||
<infourl title="MokoWaaS">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.12.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
<maintainer>Moko Consulting</maintainer>
|
||||
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
</update>
|
||||
<update>
|
||||
<name>MokoWaaS</name>
|
||||
<description>MokoWaaS update</description>
|
||||
<name>Package - MokoWaaS</name>
|
||||
<description>Package - MokoWaaS alpha build.</description>
|
||||
<element>pkg_mokowaas</element>
|
||||
<type>package</type>
|
||||
<version>02.12.00</version>
|
||||
<client>site</client>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<infourl title='Package - MokoWaaS'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.15.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<sha256>2bd856769eaeb1de09df0d4335dc6eb92f67c7e7a4f72f286f8b703c05854e06</sha256>
|
||||
<tags><tag>alpha</tag></tags>
|
||||
<infourl title="MokoWaaS">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.12.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
<maintainer>Moko Consulting</maintainer>
|
||||
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
</update>
|
||||
<update>
|
||||
<name>MokoWaaS</name>
|
||||
<description>MokoWaaS update</description>
|
||||
<name>Package - MokoWaaS</name>
|
||||
<description>Package - MokoWaaS beta build.</description>
|
||||
<element>pkg_mokowaas</element>
|
||||
<type>package</type>
|
||||
<version>02.12.00</version>
|
||||
<client>site</client>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<infourl title='Package - MokoWaaS'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.15.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<sha256>2bd856769eaeb1de09df0d4335dc6eb92f67c7e7a4f72f286f8b703c05854e06</sha256>
|
||||
<tags><tag>beta</tag></tags>
|
||||
<infourl title="MokoWaaS">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.12.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
<maintainer>Moko Consulting</maintainer>
|
||||
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
</update>
|
||||
<update>
|
||||
<name>MokoWaaS</name>
|
||||
<description>MokoWaaS update</description>
|
||||
<name>Package - MokoWaaS</name>
|
||||
<description>Package - MokoWaaS rc build.</description>
|
||||
<element>pkg_mokowaas</element>
|
||||
<type>package</type>
|
||||
<version>02.12.00</version>
|
||||
<client>site</client>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<infourl title='Package - MokoWaaS'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.15.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<sha256>2bd856769eaeb1de09df0d4335dc6eb92f67c7e7a4f72f286f8b703c05854e06</sha256>
|
||||
<tags><tag>rc</tag></tags>
|
||||
<infourl title="MokoWaaS">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.12.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
<maintainer>Moko Consulting</maintainer>
|
||||
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
</update>
|
||||
<update>
|
||||
<name>MokoWaaS</name>
|
||||
<description>MokoWaaS update</description>
|
||||
<name>Package - MokoWaaS</name>
|
||||
<description>Package - MokoWaaS stable build.</description>
|
||||
<element>pkg_mokowaas</element>
|
||||
<type>package</type>
|
||||
<version>02.12.00</version>
|
||||
<client>site</client>
|
||||
<tags><tag>stable</tag></tags>
|
||||
<infourl title="MokoWaaS">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<version>02.15.00</version>
|
||||
<creationDate>2026-05-28</creationDate>
|
||||
<infourl title='Package - MokoWaaS'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/tag/stable</infourl>
|
||||
<downloads>
|
||||
<downloadurl type="full" format="zip">https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.12.00.zip</downloadurl>
|
||||
<downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-02.15.00.zip</downloadurl>
|
||||
</downloads>
|
||||
<sha256>4dfa0a615dacdc0476b8da8580e2b1c0c362235bc55185937804c1190a6b2758</sha256>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
<sha256>2bd856769eaeb1de09df0d4335dc6eb92f67c7e7a4f72f286f8b703c05854e06</sha256>
|
||||
<tags><tag>stable</tag></tags>
|
||||
<maintainer>Moko Consulting</maintainer>
|
||||
<maintainerurl>https://mokoconsulting.tech</maintainerurl>
|
||||
<targetplatform name="joomla" version="(5|6)\..*" />
|
||||
</update>
|
||||
</updates>
|
||||
|
||||
@@ -0,0 +1,181 @@
|
||||
# API Endpoints
|
||||
|
||||
MokoWaaS provides 6 remote management endpoints accessible via query string parameter. All endpoints require HTTPS and Bearer token authentication.
|
||||
|
||||
## Authentication
|
||||
|
||||
All endpoints require the `health_api_token` as a Bearer token in the Authorization header:
|
||||
|
||||
```
|
||||
Authorization: Bearer <health_api_token>
|
||||
```
|
||||
|
||||
The token is auto-generated during plugin installation and stored as a read-only parameter in the plugin configuration. It can also be passed as a `token` query parameter as a fallback.
|
||||
|
||||
Token validation uses `hash_equals()` for timing-safe comparison. If no token is configured, the endpoint returns HTTP 503. An invalid token returns HTTP 401.
|
||||
|
||||
## Endpoints
|
||||
|
||||
### 1. Health Check
|
||||
|
||||
```
|
||||
GET /?mokowaas=health
|
||||
```
|
||||
|
||||
Runs 16 diagnostic checks and returns a comprehensive health report. See [Health Monitoring](Health-Monitoring) for full documentation of all checks and response format.
|
||||
|
||||
**Response**: JSON object with `status` (`ok`/`degraded`/`error`), `reason`, `timestamp`, `checks`, and `meta`.
|
||||
|
||||
**HTTP Status**: 200 (ok/degraded), 503 (error).
|
||||
|
||||
---
|
||||
|
||||
### 2. Site Info
|
||||
|
||||
```
|
||||
GET /?mokowaas=info
|
||||
```
|
||||
|
||||
Returns a compact summary of the Joomla site.
|
||||
|
||||
**Response**:
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `site_name` | Joomla site name |
|
||||
| `site_url` | Site root URL |
|
||||
| `joomla_version` | Joomla CMS version |
|
||||
| `php_version` | PHP version |
|
||||
| `db_type` | Database driver (e.g. `pdomysql`) |
|
||||
| `debug` | Whether debug mode is on |
|
||||
| `sef` | Whether SEF URLs are enabled |
|
||||
| `caching` | Whether caching is enabled |
|
||||
| `articles` | Total article count |
|
||||
| `users` | Total user count |
|
||||
| `extensions` | Number of enabled extensions |
|
||||
| `brand` | Configured brand name |
|
||||
| `plugin_version` | MokoWaaS plugin version |
|
||||
|
||||
---
|
||||
|
||||
### 3. Remote Install
|
||||
|
||||
```
|
||||
POST /?mokowaas=install
|
||||
Content-Type: application/json
|
||||
|
||||
{"url": "https://example.com/extension.zip"}
|
||||
```
|
||||
|
||||
Downloads and installs a Joomla extension from the provided URL. The extension is downloaded to a temporary directory, extracted, and installed using Joomla's installer API.
|
||||
|
||||
**Response**: JSON object with `status`, `extension` name, and `message`.
|
||||
|
||||
**HTTP Status**: 200 (success), 400 (missing URL), 405 (not POST), 500 (install failed).
|
||||
|
||||
---
|
||||
|
||||
### 4. Update Check
|
||||
|
||||
```
|
||||
POST /?mokowaas=update
|
||||
```
|
||||
|
||||
Clears the Joomla update cache and triggers a fresh update check via `Updater::findUpdates()`.
|
||||
|
||||
**Response**:
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` |
|
||||
| `updates_found` | Number of available updates |
|
||||
| `message` | Human-readable summary |
|
||||
|
||||
**HTTP Status**: 200 (success), 405 (not POST), 500 (failed).
|
||||
|
||||
---
|
||||
|
||||
### 5. Cache Clear
|
||||
|
||||
```
|
||||
POST /?mokowaas=cache
|
||||
```
|
||||
|
||||
Clears the Joomla site cache, admin cache, and PHP OPcache (if available).
|
||||
|
||||
**Response**:
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` |
|
||||
| `message` | `Cache cleared` |
|
||||
|
||||
**HTTP Status**: 200 (success), 405 (not POST), 500 (failed).
|
||||
|
||||
---
|
||||
|
||||
### 6. Backup (Akeeba)
|
||||
|
||||
```
|
||||
POST /?mokowaas=backup
|
||||
Content-Type: application/json
|
||||
|
||||
{"profile": 1}
|
||||
```
|
||||
|
||||
Triggers an Akeeba Backup using the specified profile (defaults to profile 1). Requires Akeeba Backup to be installed.
|
||||
|
||||
**Response**:
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `started` |
|
||||
| `profile` | Backup profile ID used |
|
||||
| `message` | `Backup started` |
|
||||
|
||||
**HTTP Status**: 200 (started), 404 (Akeeba not installed), 405 (not POST), 500 (failed), 501 (Akeeba Engine not loadable).
|
||||
|
||||
## Error Responses
|
||||
|
||||
All endpoints return errors in a consistent format:
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "Error description",
|
||||
"message": "Additional detail (optional)"
|
||||
}
|
||||
```
|
||||
|
||||
### Common Error Codes
|
||||
|
||||
| HTTP Status | Meaning |
|
||||
|---|---|
|
||||
| 400 | Bad request (unknown action, missing parameters) |
|
||||
| 401 | Invalid or missing authentication token |
|
||||
| 405 | Wrong HTTP method (e.g. GET when POST is required) |
|
||||
| 500 | Server error during operation |
|
||||
| 503 | No API token configured |
|
||||
|
||||
## Unknown Actions
|
||||
|
||||
Requesting an unknown action returns HTTP 400 with the list of available actions:
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "Unknown action",
|
||||
"action": "invalid",
|
||||
"available": ["health", "install", "update", "cache", "backup", "info"]
|
||||
}
|
||||
```
|
||||
|
||||
## Joomla REST API Routes
|
||||
|
||||
In addition to the query-string endpoints above, MokoWaaS registers standard Joomla API routes via the `plg_webservices_mokowaas` plugin:
|
||||
|
||||
| Route | Controller |
|
||||
|---|---|
|
||||
| `GET /api/v1/mokowaas/health` | HealthController |
|
||||
| `POST /api/v1/mokowaas/cache` | CacheController |
|
||||
| `POST /api/v1/mokowaas/update` | UpdateController |
|
||||
|
||||
These routes use Joomla's standard API authentication (API token in `X-Joomla-Token` header) and are useful for integrations that already use the Joomla API framework.
|
||||
@@ -0,0 +1,94 @@
|
||||
# Configuration
|
||||
|
||||
All MokoWaaS settings are managed in the Joomla plugin configuration under **System > Plugins > System - MokoWaaS**. Settings are organized into tabs (fieldsets).
|
||||
|
||||
## Basic (Branding)
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `enable_branding` | Yes/No | Yes | Enable white-label branding (language overrides, logos, colors) |
|
||||
| `brand_name` | Text | `MokoWaaS` | Brand name displayed throughout the admin interface |
|
||||
| `company_name` | Text | `Moko Consulting` | Company name used in footers and copyright notices |
|
||||
| `support_url` | URL | `https://mokoconsulting.tech` | Support link shown on the admin login page and dashboard |
|
||||
|
||||
## WaaS Access
|
||||
|
||||
Controls the master user system that designates a single operator account.
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `enforce_master_user` | Yes/No | Yes | Enable master user enforcement; non-master Super Admins are restricted |
|
||||
| `master_username` | Text | `mokoconsulting` | Username of the designated master operator |
|
||||
| `master_email` | Email | `webmaster@mokoconsulting.tech` | Email address of the master user (for verification) |
|
||||
| `emergency_access` | Yes/No | Yes | Enable emergency access via database password + file-based 2FA |
|
||||
| `allowed_ips_display` | Display | -- | Read-only display of whitelisted IP addresses for emergency access |
|
||||
|
||||
## Maintenance
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `dev_mode` | Yes/No | No | Disable Joomla caching at runtime (does not modify `configuration.php`) |
|
||||
| `reset_hits` | Yes/No | No | Reset article hit counters on next admin load |
|
||||
| `delete_versions` | Yes/No | No | Purge content version history on next admin load |
|
||||
|
||||
## Visual Branding
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `color_primary` | Color | `#1a2744` | Primary brand color (buttons, accents) |
|
||||
| `color_sidebar` | Color | `#0f1b2d` | Admin sidebar background color |
|
||||
| `color_header` | Color | `#1a2744` | Admin header bar color |
|
||||
| `color_link` | Color | `#0051ad` | Link text color |
|
||||
| `brand_icon` | Text | -- | FontAwesome unicode code point (e.g. `f6d5`) for the brand icon |
|
||||
| `custom_css` | Textarea | -- | Custom CSS injected into every admin page |
|
||||
|
||||
## Tenant Restrictions
|
||||
|
||||
Controls what non-master Super Admin users can access.
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `restrict_installer` | Yes/No | Yes | Block access to Extension Manager for non-master users |
|
||||
| `hide_sysinfo` | Yes/No | Yes | Hide System Information page from non-master users |
|
||||
| `restrict_global_config` | Yes/No | Yes | Block access to Global Configuration for non-master users |
|
||||
| `restrict_template_editing` | Yes/No | Yes | Prevent non-master users from editing template files |
|
||||
| `disable_install_url` | Yes/No | Yes | Remove the "Install from URL" tab in Extension Manager |
|
||||
| `hidden_menu_items` | Textarea | -- | Comma-separated list of admin menu item IDs to hide from non-master users |
|
||||
|
||||
## Site Aliases
|
||||
|
||||
Multi-domain support. See [Site Aliases](Site-Aliases) for full documentation.
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `primary_domain` | Text | -- | The canonical domain for the site (e.g. `waas.dev.mokoconsulting.tech`) |
|
||||
| `site_aliases` | Subform | -- | Repeatable table of alias domains with per-alias settings |
|
||||
|
||||
Each alias entry contains:
|
||||
|
||||
| Field | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `domain` | Text | -- | Alias domain name (e.g. `www.example.com`) |
|
||||
| `offline` | Yes/No | No | Show offline page for this alias |
|
||||
| `offline_message` | Textarea | -- | Custom offline message (shown when `offline` is Yes) |
|
||||
| `robots` | List | `index, follow` | Robots meta directive for this alias |
|
||||
| `redirect_backend` | Yes/No | Yes | Redirect admin requests on this alias to the primary domain |
|
||||
|
||||
## Diagnostics
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `health_api_token` | Text (read-only) | -- | Auto-generated Bearer token for API authentication. Provisioned on install/update. Cannot be manually edited. |
|
||||
|
||||
## Security
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `force_https` | Yes/No | Yes | Redirect all HTTP requests to HTTPS (301 redirect) |
|
||||
| `admin_session_timeout` | Number | `60` | Idle timeout in minutes for admin sessions (0 = use Joomla default). Master user is exempt. |
|
||||
| `password_min_length` | Number | `12` | Minimum password length for user accounts |
|
||||
| `password_require_uppercase` | Yes/No | Yes | Require at least one uppercase letter |
|
||||
| `password_require_number` | Yes/No | Yes | Require at least one digit |
|
||||
| `password_require_special` | Yes/No | Yes | Require at least one special character |
|
||||
| `upload_allowed_types` | Text | `jpg,jpeg,png,gif,webp,svg,pdf,doc,docx,xls,xlsx` | Comma-separated list of allowed upload file extensions |
|
||||
| `upload_max_size_mb` | Number | `100` | Maximum upload file size in megabytes |
|
||||
@@ -0,0 +1,127 @@
|
||||
# Grafana Integration
|
||||
|
||||
MokoWaaS integrates with a Grafana monitoring stack hosted at `bench.mokoconsulting.tech`. The integration is automatic: on install or update, the plugin sends a heartbeat that provisions a Grafana datasource for the site.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
MokoWaaS Plugin (Joomla)
|
||||
|
|
||||
| POST /api/waas-heartbeat/register
|
||||
v
|
||||
Heartbeat Receiver (bench.mokoconsulting.tech)
|
||||
|
|
||||
|-- Writes Grafana Infinity datasource YAML
|
||||
|-- Restarts Grafana to pick up new datasource
|
||||
|-- Sends ntfy notification (mokowaas-heartbeat topic)
|
||||
v
|
||||
Grafana Dashboard
|
||||
|
|
||||
| GET /?mokowaas=health (per site, on schedule)
|
||||
v
|
||||
Health JSON from each registered site
|
||||
```
|
||||
|
||||
## Heartbeat Registration
|
||||
|
||||
### When It Fires
|
||||
|
||||
The heartbeat is sent automatically during:
|
||||
|
||||
- Plugin installation (`postflight` with type `install`)
|
||||
- Plugin update (`postflight` with type `update`)
|
||||
- Package installation (via `Pkg_MokowaasInstallerScript::sendHeartbeat()`)
|
||||
|
||||
### Payload
|
||||
|
||||
The plugin sends a POST request to `https://bench.mokoconsulting.tech/api/waas-heartbeat/register` with:
|
||||
|
||||
```json
|
||||
{
|
||||
"site_url": "https://example.com",
|
||||
"site_name": "Example Site",
|
||||
"health_token": "<health_api_token>",
|
||||
"action": "register"
|
||||
}
|
||||
```
|
||||
|
||||
Authentication uses a shared secret sent in the `X-MokoWaaS-Key` header.
|
||||
|
||||
### What the Receiver Does
|
||||
|
||||
On receiving a registration request, the heartbeat receiver:
|
||||
|
||||
1. Validates the `X-MokoWaaS-Key` header
|
||||
2. Generates a unique datasource UID from the site URL
|
||||
3. Writes a Grafana Infinity datasource YAML file to the Grafana provisioning directory
|
||||
4. Restarts Grafana to load the new datasource
|
||||
5. Sends an ntfy notification to the `mokowaas-heartbeat` topic with registration details
|
||||
|
||||
The datasource YAML configures a Grafana Infinity datasource that polls `/?mokowaas=health` on the registered site using the provided Bearer token.
|
||||
|
||||
### Response
|
||||
|
||||
On success (HTTP 200):
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"ds_uid": "mokowaas-example-com"
|
||||
}
|
||||
```
|
||||
|
||||
The `ds_uid` is logged in the Joomla admin message queue for reference.
|
||||
|
||||
## Grafana Dashboard
|
||||
|
||||
The MokoWaaS Grafana dashboard is organized into 9 rows covering all health metrics:
|
||||
|
||||
| Row | Panels |
|
||||
|---|---|
|
||||
| 1. Overview | Overall status, uptime, plugin version, Joomla version |
|
||||
| 2. Database | Connectivity, latency, driver, user count |
|
||||
| 3. Filesystem | Disk space, writable directories, site size |
|
||||
| 4. Extensions | Extension counts by type, pending updates |
|
||||
| 5. Backup | Last backup status, age, Akeeba health |
|
||||
| 6. Security | Admin Tools WAF, SSL certificate, blocked requests |
|
||||
| 7. Content | Article counts, categories, user activity |
|
||||
| 8. Infrastructure | Cache status, mail config, scheduled tasks, error log |
|
||||
| 9. Configuration | SEO settings, template info, config drift |
|
||||
|
||||
Each row contains panels that query the site's Infinity datasource using JSONPath expressions to extract values from the health check response.
|
||||
|
||||
## ntfy Notifications
|
||||
|
||||
Registration events trigger a notification to the `mokowaas-heartbeat` ntfy topic. Notifications include:
|
||||
|
||||
- Site URL
|
||||
- Site name
|
||||
- Registration action (new or update)
|
||||
- Datasource UID
|
||||
|
||||
Subscribe to notifications at `https://ntfy.sh/mokowaas-heartbeat` or use the ntfy app.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Heartbeat failed: connection error
|
||||
|
||||
The receiver at `bench.mokoconsulting.tech` may be unreachable. Check:
|
||||
|
||||
- DNS resolution for `bench.mokoconsulting.tech`
|
||||
- Outbound HTTPS connectivity from the Joomla server
|
||||
- Firewall rules allowing outbound port 443
|
||||
|
||||
Heartbeat failures are logged as warnings in Joomla's log and displayed in the admin message queue. They do not block plugin installation.
|
||||
|
||||
### Datasource not appearing in Grafana
|
||||
|
||||
- Verify the heartbeat completed successfully (check Joomla admin messages after install)
|
||||
- Check the Grafana provisioning directory on `bench.mokoconsulting.tech`
|
||||
- Ensure Grafana was restarted after provisioning
|
||||
- Verify the health endpoint is accessible from the Grafana server
|
||||
|
||||
### Health data not loading in dashboard
|
||||
|
||||
- Confirm the `health_api_token` matches between the plugin configuration and the Grafana datasource
|
||||
- Test the health endpoint directly: `curl -sk -H "Authorization: Bearer <token>" "https://example.com/?mokowaas=health"`
|
||||
- Check for SSL certificate issues between the Grafana server and the monitored site
|
||||
@@ -0,0 +1,33 @@
|
||||
# Health Endpoint
|
||||
|
||||
## Stable Release: 02.01.37
|
||||
|
||||
16 diagnostic checks via /?mokowaas=health (token-authenticated, HTTPS-only).
|
||||
|
||||
### Checks
|
||||
|
||||
Core: database, filesystem, cache, extensions
|
||||
Security: backup (Akeeba), security (Admin Tools), SSL certificate
|
||||
Operations: scheduled tasks, error log, database size, mail
|
||||
Content: articles, categories, users, sessions, failed logins
|
||||
Config: SEO, templates, debug mode, force SSL, caching
|
||||
|
||||
### Grafana Dashboard (9 rows)
|
||||
|
||||
Site Overview | Health Metrics | Infrastructure | Backup | Security | SSL/Cron | Content/Users | Mail/SEO/Config | DB/Errors
|
||||
|
||||
### Heartbeat
|
||||
|
||||
Auto-registers with Grafana via bench.mokoconsulting.tech/api/waas-heartbeat/register
|
||||
ntfy notifications on mokowaas-heartbeat topic
|
||||
|
||||
### Plugin Protection
|
||||
|
||||
Hidden from non-master users, settings blocked, self-healing lock, uninstall blocked.
|
||||
|
||||
---
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Minimum Version | 02.01.37 |
|
||||
| Platform | joomla |
|
||||
@@ -0,0 +1,267 @@
|
||||
# Health Monitoring
|
||||
|
||||
MokoWaaS includes a built-in health monitoring system that runs 16 diagnostic checks against the Joomla site. Results are returned as a JSON payload via the `/?mokowaas=health` endpoint.
|
||||
|
||||
## Endpoint
|
||||
|
||||
```
|
||||
GET https://example.com/?mokowaas=health
|
||||
Authorization: Bearer <health_api_token>
|
||||
```
|
||||
|
||||
The `health_api_token` is auto-generated during plugin installation and stored as a read-only plugin parameter. See [API Endpoints](API-Endpoints) for authentication details.
|
||||
|
||||
## Response Structure
|
||||
|
||||
The response includes an overall status, a human-readable reason string, a UTC timestamp, individual check results, and instance metadata.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | Overall status: `ok`, `degraded`, or `error` |
|
||||
| `reason` | Human-readable summary of issues (null when status is `ok`) |
|
||||
| `timestamp` | ISO 8601 UTC timestamp |
|
||||
| `checks` | Object containing all 16 check results |
|
||||
| `meta` | Instance metadata (brand, versions, server name) |
|
||||
|
||||
### Status Determination
|
||||
|
||||
- If any check returns `error`, the overall status is `error` and the HTTP status code is **503**.
|
||||
- If any check returns `degraded` (and none are `error`), the overall status is `degraded` with HTTP **200**.
|
||||
- Otherwise the overall status is `ok` with HTTP **200**.
|
||||
|
||||
## The 16 Checks
|
||||
|
||||
### 1. database
|
||||
|
||||
Tests database connectivity and query latency.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `error` |
|
||||
| `latency_ms` | Query round-trip time in milliseconds |
|
||||
| `driver` | Database driver name (e.g. `mysqli`, `pdomysql`) |
|
||||
| `users` | Total user count (sanity check) |
|
||||
|
||||
### 2. filesystem
|
||||
|
||||
Checks writable directories and disk space.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok`, `degraded` (low disk), or `error` (not writable) |
|
||||
| `tmp_writable` | Whether `/tmp` is writable |
|
||||
| `log_writable` | Whether `/administrator/logs` is writable |
|
||||
| `cache_writable` | Whether `/cache` is writable |
|
||||
| `free_disk_mb` | Free disk space in MB |
|
||||
| `total_disk_mb` | Total disk space in MB |
|
||||
| `site_size_mb` | Estimated site size in MB (images, media, tmp, cache, logs) |
|
||||
|
||||
Degraded when free disk is below 100 MB. Error when required directories are not writable.
|
||||
|
||||
### 3. cache
|
||||
|
||||
Reports Joomla cache configuration.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | Always `ok` |
|
||||
| `enabled` | Whether Joomla caching is active |
|
||||
| `handler` | Cache handler type (e.g. `file`, `redis`) |
|
||||
|
||||
### 4. extensions
|
||||
|
||||
Counts enabled extensions by type and checks for pending updates.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` (pending updates) |
|
||||
| `by_type` | Object with counts per extension type |
|
||||
| `pending_updates` | Number of available extension updates |
|
||||
|
||||
### 5. backup (Akeeba)
|
||||
|
||||
Checks Akeeba Backup status.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok`, `degraded`, or `error` |
|
||||
| `last_status` | Status of the last backup record (`complete`, `fail`, etc.) |
|
||||
| `days_since` | Days since the last backup |
|
||||
| `message` | Human-readable backup status |
|
||||
|
||||
Degraded when the last backup is older than 7 days or did not complete successfully.
|
||||
|
||||
### 6. security (Admin Tools)
|
||||
|
||||
Checks Admin Tools WAF status if installed.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok`, `degraded`, or `error` |
|
||||
| `waf_enabled` | Whether the Web Application Firewall is active |
|
||||
| `blocked_24h` | Number of blocked requests in the last 24 hours |
|
||||
|
||||
### 7. ssl
|
||||
|
||||
Checks SSL certificate validity and expiration.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok`, `degraded`, or `error` |
|
||||
| `days_left` | Days until certificate expiration |
|
||||
| `issuer` | Certificate issuer |
|
||||
| `valid_from` | Certificate start date |
|
||||
| `valid_to` | Certificate expiration date |
|
||||
|
||||
Degraded when the certificate expires within 30 days.
|
||||
|
||||
### 8. cron (Scheduled Tasks)
|
||||
|
||||
Checks Joomla scheduled task execution.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `total_tasks` | Total number of scheduled tasks |
|
||||
| `failed_24h` | Tasks that failed in the last 24 hours |
|
||||
|
||||
### 9. errors (Error Log)
|
||||
|
||||
Analyzes recent Joomla error log entries.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `recent_errors` | Count of recent error log entries |
|
||||
| `last_error` | Most recent error message |
|
||||
|
||||
### 10. db_size
|
||||
|
||||
Reports database size metrics.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `total_mb` | Total database size in MB |
|
||||
| `tables` | Number of database tables |
|
||||
|
||||
### 11. content
|
||||
|
||||
Reports content statistics.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | Always `ok` |
|
||||
| `articles` | Total article count |
|
||||
| `categories` | Total category count |
|
||||
| `published` | Number of published articles |
|
||||
| `unpublished` | Number of unpublished articles |
|
||||
|
||||
### 12. users (User Activity)
|
||||
|
||||
Reports user statistics.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | Always `ok` |
|
||||
| `total` | Total user count |
|
||||
| `active_30d` | Users active in the last 30 days |
|
||||
| `blocked` | Number of blocked user accounts |
|
||||
|
||||
### 13. mail
|
||||
|
||||
Checks Joomla mail configuration.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `mailer` | Mail handler type (e.g. `smtp`, `mail`, `sendmail`) |
|
||||
| `from` | Configured sender address |
|
||||
|
||||
### 14. seo
|
||||
|
||||
Checks SEO configuration.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `sef` | Whether SEF URLs are enabled |
|
||||
| `sef_rewrite` | Whether URL rewriting is enabled |
|
||||
| `sitemap` | Whether a sitemap is detected |
|
||||
|
||||
### 15. template
|
||||
|
||||
Reports active template information.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | Always `ok` |
|
||||
| `site_template` | Active frontend template name |
|
||||
| `admin_template` | Active admin template name |
|
||||
|
||||
### 16. config (Config Drift)
|
||||
|
||||
Detects configuration anomalies.
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `status` | `ok` or `degraded` |
|
||||
| `issues` | Array of detected configuration problems |
|
||||
|
||||
Checks for issues such as debug mode enabled in production, error reporting set too high, or default database prefix still in use.
|
||||
|
||||
## Example Response
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "degraded",
|
||||
"reason": "2 extension updates available; SSL expires in 14 days",
|
||||
"timestamp": "2026-05-24T12:00:00Z",
|
||||
"checks": {
|
||||
"database": {
|
||||
"status": "ok",
|
||||
"latency_ms": 1.23,
|
||||
"driver": "pdomysql",
|
||||
"users": 5
|
||||
},
|
||||
"filesystem": {
|
||||
"status": "ok",
|
||||
"tmp_writable": true,
|
||||
"log_writable": true,
|
||||
"cache_writable": true,
|
||||
"free_disk_mb": 4500,
|
||||
"total_disk_mb": 20000,
|
||||
"site_size_mb": 320
|
||||
},
|
||||
"ssl": {
|
||||
"status": "degraded",
|
||||
"days_left": 14,
|
||||
"issuer": "Let's Encrypt",
|
||||
"valid_to": "2026-06-07"
|
||||
}
|
||||
},
|
||||
"meta": {
|
||||
"brand": "MokoWaaS",
|
||||
"plugin_version": "02.03.11",
|
||||
"joomla_version": "5.2.4",
|
||||
"php_version": "8.2.20",
|
||||
"server_name": "Example Site",
|
||||
"server_time": "2026-05-24T12:00:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
(Remaining checks omitted for brevity.)
|
||||
|
||||
## Metadata
|
||||
|
||||
The `meta` object is included in every health response:
|
||||
|
||||
| Field | Description |
|
||||
|---|---|
|
||||
| `brand` | Configured brand name |
|
||||
| `plugin_version` | MokoWaaS plugin version |
|
||||
| `joomla_version` | Joomla CMS version |
|
||||
| `php_version` | PHP version |
|
||||
| `server_name` | Joomla site name |
|
||||
| `server_time` | Server UTC time |
|
||||
@@ -0,0 +1,52 @@
|
||||
# MokoWaaS
|
||||
|
||||
MokoWaaS is a Joomla 5.x / 6.x extension package that provides a configurable white-label identity layer, tenant management, health monitoring, and remote administration API for the MokoWaaS platform.
|
||||
|
||||
Developed by [Moko Consulting](https://mokoconsulting.tech). Licensed under GPL-3.0-or-later.
|
||||
|
||||
## Features
|
||||
|
||||
- **White-label branding** -- customizable brand name, colors, favicon, login page, and admin template theming
|
||||
- **Master user enforcement** -- designate a single operator account with elevated privileges; restrict other Super Admins
|
||||
- **Tenant restrictions** -- hide system info, block installer access, restrict global config and template editing, hide menu items
|
||||
- **Site aliases** -- multi-domain support with per-alias offline mode, robots directives, and backend redirects
|
||||
- **Health monitoring** -- 16 diagnostic checks exposed via authenticated JSON API
|
||||
- **Remote management API** -- 6 endpoints for health, info, install, update, cache clear, and backup
|
||||
- **Grafana integration** -- automatic heartbeat registration with Grafana Infinity datasource provisioning
|
||||
- **Plugin protection** -- protected flag, self-healing, hidden from non-master users, blocks disable/uninstall
|
||||
- **Security hardening** -- forced HTTPS, session timeouts, password policy, upload restrictions
|
||||
- **Emergency access** -- file-based two-factor verification for master user recovery
|
||||
- **Automatic updates** -- via Joomla update server hosted on Gitea
|
||||
|
||||
## Requirements
|
||||
|
||||
| Requirement | Minimum |
|
||||
|---|---|
|
||||
| Joomla | 5.0.0+ (5.x and 6.x supported) |
|
||||
| PHP | 8.1.0+ |
|
||||
|
||||
## Package Contents
|
||||
|
||||
The `pkg_mokowaas` package installs three extensions:
|
||||
|
||||
| Extension | Type | Purpose |
|
||||
|---|---|---|
|
||||
| `plg_system_mokowaas` | System Plugin | Core branding, restrictions, health checks, API endpoints |
|
||||
| `com_mokowaas` | Component | REST API controllers (health, cache, update) |
|
||||
| `plg_webservices_mokowaas` | Webservices Plugin | Registers Joomla API routes for `v1/mokowaas/*` |
|
||||
|
||||
## Wiki Pages
|
||||
|
||||
- [Configuration](Configuration) -- All plugin settings organized by tab
|
||||
- [Health Monitoring](Health-Monitoring) -- The 16 diagnostic checks
|
||||
- [Site Aliases](Site-Aliases) -- Multi-domain management
|
||||
- [API Endpoints](API-Endpoints) -- The 6 remote management endpoints
|
||||
- [Grafana Integration](Grafana-Integration) -- Monitoring dashboard setup
|
||||
- [Plugin Protection](Plugin-Protection) -- Security measures preventing disable/uninstall
|
||||
- [Installation](Installation) -- Step-by-step install and upgrade guide
|
||||
|
||||
## Links
|
||||
|
||||
- **Repository**: [MokoWaaS on Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS)
|
||||
- **Update Server**: [updates.xml](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/raw/branch/main/updates.xml)
|
||||
- **Author**: [Moko Consulting](https://mokoconsulting.tech)
|
||||
@@ -0,0 +1,100 @@
|
||||
# Installation
|
||||
|
||||
MokoWaaS is distributed as a Joomla package (`pkg_mokowaas`) containing three extensions. It can be installed via the standard Joomla Extension Manager.
|
||||
|
||||
## Requirements
|
||||
|
||||
| Requirement | Minimum |
|
||||
|---|---|
|
||||
| Joomla | 5.0.0+ |
|
||||
| PHP | 8.1.0+ |
|
||||
|
||||
The installer checks both requirements during `preflight` and aborts with an error message if either is not met.
|
||||
|
||||
## Method 1: Upload Package File
|
||||
|
||||
1. Download the latest `pkg_mokowaas.zip` from the [Gitea Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases) page.
|
||||
2. In Joomla admin, navigate to **System > Install > Extensions**.
|
||||
3. On the **Upload Package File** tab, drag and drop or browse to select `pkg_mokowaas.zip`.
|
||||
4. Click **Upload & Install**.
|
||||
5. Verify the success message. The package installs three extensions:
|
||||
- `plg_system_mokowaas` (System Plugin)
|
||||
- `com_mokowaas` (Component)
|
||||
- `plg_webservices_mokowaas` (Webservices Plugin)
|
||||
|
||||
## Method 2: Install from URL
|
||||
|
||||
1. In Joomla admin, navigate to **System > Install > Extensions**.
|
||||
2. On the **Install from URL** tab, enter the direct download URL for the package ZIP, e.g.:
|
||||
```
|
||||
https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/releases/download/stable/pkg_mokowaas-latest.zip
|
||||
```
|
||||
3. Click **Install**.
|
||||
4. Verify the success message.
|
||||
|
||||
## Post-Installation Verification
|
||||
|
||||
After installation, verify the following:
|
||||
|
||||
1. **Plugin enabled**: Navigate to **System > Plugins** and confirm "System - MokoWaaS" is enabled (it is auto-enabled during installation).
|
||||
2. **Health token generated**: Open the plugin configuration and check the **Diagnostics** tab. The `health_api_token` field should contain an auto-generated token.
|
||||
3. **Branding applied**: The admin login page and dashboard should reflect MokoWaaS branding (logo, colors, footer text).
|
||||
4. **Health endpoint**: Test the health endpoint:
|
||||
```
|
||||
curl -sk -H "Authorization: Bearer <token>" "https://yoursite.com/?mokowaas=health"
|
||||
```
|
||||
5. **Grafana heartbeat**: Check the admin message queue for a Grafana heartbeat confirmation message.
|
||||
|
||||
## What the Installer Does
|
||||
|
||||
During `postflight`, the installer script performs these operations:
|
||||
|
||||
| Step | Description |
|
||||
|---|---|
|
||||
| Enable and protect plugin | Sets `enabled=1`, `protected=1`, `locked=0` in `#__extensions` |
|
||||
| Install MokoOnyx template | Installs the bundled MokoOnyx site template from the plugin payload, sets it as default |
|
||||
| Language overrides | Deploys language override files for en-GB and en-US |
|
||||
| Login support URLs | Updates `mod_loginsupport` to point to Moko Consulting support/docs/news URLs |
|
||||
| Atum branding | Applies brand colors to the Atum admin template |
|
||||
| Action log registration | Registers MokoWaaS in the Joomla action log system |
|
||||
| Health token provisioning | Generates a random API token if one does not exist |
|
||||
| Heartbeat | Sends a registration heartbeat to the Grafana monitoring receiver |
|
||||
|
||||
## Automatic Updates
|
||||
|
||||
MokoWaaS includes an update server configuration that enables automatic update notifications through Joomla's built-in update system.
|
||||
|
||||
The update server URL is:
|
||||
```
|
||||
https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/raw/branch/main/updates.xml
|
||||
```
|
||||
|
||||
When a new version is available:
|
||||
|
||||
1. Joomla's update checker detects the new version from `updates.xml`.
|
||||
2. A notification appears in the admin dashboard.
|
||||
3. Navigate to **System > Update > Extensions** to install the update.
|
||||
4. The `postflight` script runs again, re-applying all configuration steps.
|
||||
|
||||
## Upgrading from Standalone Plugin to Package
|
||||
|
||||
If you previously installed the standalone `plg_system_mokowaas` plugin (before it was packaged as `pkg_mokowaas`), the package installer handles migration automatically:
|
||||
|
||||
1. Install the `pkg_mokowaas.zip` package using either method above.
|
||||
2. The package installer detects the existing standalone plugin and upgrades it in place.
|
||||
3. The additional extensions (`com_mokowaas`, `plg_webservices_mokowaas`) are installed alongside.
|
||||
4. All existing plugin settings are preserved.
|
||||
5. The `protected` flag is set on all package extensions.
|
||||
|
||||
No manual cleanup of the old standalone plugin is required.
|
||||
|
||||
## Uninstallation
|
||||
|
||||
Uninstallation is restricted to the master user. See [Plugin Protection](Plugin-Protection) for details.
|
||||
|
||||
When the master user uninstalls via the Extension Manager:
|
||||
|
||||
1. Language override files are removed from Joomla's global override directories.
|
||||
2. Action log registration is cleaned up.
|
||||
3. An uninstall notification is sent to the monitoring system.
|
||||
4. The package and all sub-extensions are removed.
|
||||
@@ -0,0 +1,89 @@
|
||||
# Plugin Protection
|
||||
|
||||
MokoWaaS uses multiple layers of protection to prevent accidental or unauthorized disabling and uninstallation. The master user retains full control over the plugin at all times.
|
||||
|
||||
## Protection Layers
|
||||
|
||||
### 1. Protected Flag (`protected=1`)
|
||||
|
||||
During installation and on every admin session, MokoWaaS sets the `protected` column to `1` in the `#__extensions` database table for both `mokowaas` and `pkg_mokowaas` entries.
|
||||
|
||||
The Joomla framework itself enforces this flag: protected extensions cannot be disabled or uninstalled through the standard admin interface.
|
||||
|
||||
The `locked` column is set to `0` so the extension can still receive updates and configuration changes.
|
||||
|
||||
### 2. Self-Healing
|
||||
|
||||
The `ensureProtectedFlag()` method runs once per admin session (using a static flag to avoid repeated queries). If the `protected` column has been reset to `0` (e.g., by a database modification), it is automatically restored to `1`.
|
||||
|
||||
This runs in the `protectPlugin()` method, which is called from `onBeforeRender()` on every admin page load.
|
||||
|
||||
### 3. Hidden from Plugin List
|
||||
|
||||
For non-master users, MokoWaaS injects JavaScript on the `com_plugins` and `com_installer` pages that hides any table row containing "mokowaas" or "MokoWaaS". This prevents non-master users from seeing the plugin in the extension list.
|
||||
|
||||
The `hidePluginFromList()` method adds an inline script that runs on `DOMContentLoaded`:
|
||||
|
||||
```javascript
|
||||
document.querySelectorAll('tr').forEach(function(row) {
|
||||
var text = row.textContent || '';
|
||||
if (text.indexOf('mokowaas') !== -1 || text.indexOf('MokoWaaS') !== -1) {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### 4. onExtensionBeforeSave Interception
|
||||
|
||||
The `onExtensionBeforeSave` event handler intercepts save attempts on the plugin configuration. If a non-master user attempts to save the plugin with `enabled = 0`, the handler:
|
||||
|
||||
1. Displays an error message: "MokoWaaS cannot be disabled."
|
||||
2. Forces `enabled` back to `1` on the table object
|
||||
3. Returns `true` to allow the save to proceed (with the corrected value)
|
||||
|
||||
### 5. protectPlugin() -- Uninstall and Disable Blocking
|
||||
|
||||
The `protectPlugin()` method runs on every admin page request and checks for active uninstall or disable attempts:
|
||||
|
||||
**Uninstall blocking**: If the current request is to `com_installer` with task `manage.remove`, and the extension IDs include any MokoWaaS extension, the request is blocked with an error message and a redirect back to the installer manage view.
|
||||
|
||||
**Disable blocking**: If the current request is to `com_plugins` with task `plugins.publish`, and the extension IDs include MokoWaaS, the request is blocked with an error message and a redirect back to the plugins list.
|
||||
|
||||
The `isOurExtension()` helper method checks extension IDs against the database to determine if they belong to MokoWaaS (matching on element name `mokowaas` or `pkg_mokowaas`).
|
||||
|
||||
## Master User Exemption
|
||||
|
||||
All protection checks call `isMasterUser()` first. If the current user is the designated master user (matching the configured `master_username`), all protections are bypassed. The master user can:
|
||||
|
||||
- See MokoWaaS in the plugin and extension lists
|
||||
- Disable the plugin via the configuration page
|
||||
- Uninstall the plugin via the Extension Manager
|
||||
- Modify all plugin settings
|
||||
|
||||
## Installation-Time Protection
|
||||
|
||||
The package installer script (`Pkg_MokowaasInstallerScript`) and the plugin installer script both set `protected=1` during `postflight`:
|
||||
|
||||
- `enableAndLockPlugin()` sets `enabled=1`, `locked=1`, `protected=1` on the system plugin
|
||||
- `protectExtensions()` sets `protected=1`, `locked=0` on all MokoWaaS extensions (plugin and package)
|
||||
|
||||
This ensures protection is active immediately after installation, before the first admin page load triggers the self-healing logic.
|
||||
|
||||
## Summary of Protection Flow
|
||||
|
||||
```
|
||||
Installation
|
||||
-> postflight sets protected=1, enabled=1
|
||||
|
||||
Every admin page load (onBeforeRender)
|
||||
-> protectPlugin()
|
||||
-> ensureProtectedFlag() (once per session, restores protected=1 if needed)
|
||||
-> if not master user:
|
||||
-> block uninstall attempts (com_installer manage.remove)
|
||||
-> block disable attempts (com_plugins plugins.publish)
|
||||
-> hidePluginFromList() for non-master users
|
||||
|
||||
Plugin config save (onExtensionBeforeSave)
|
||||
-> if not master user and enabled=0:
|
||||
-> force enabled=1, show error
|
||||
```
|
||||
@@ -0,0 +1,69 @@
|
||||
# Site Aliases
|
||||
|
||||
MokoWaaS supports multi-domain configurations through the Site Aliases system. This allows a single Joomla installation to respond to multiple domain names, each with independent settings for offline mode, robots directives, and backend access.
|
||||
|
||||
## Configuration
|
||||
|
||||
Site aliases are configured in the plugin settings under the **Site Aliases** tab.
|
||||
|
||||
### Primary Domain
|
||||
|
||||
Set `primary_domain` to the canonical domain for the site (e.g. `waas.dev.mokoconsulting.tech`). This is the domain that:
|
||||
|
||||
- Serves as the canonical URL for SEO purposes
|
||||
- Hosts the admin backend (when `redirect_backend` is enabled on aliases)
|
||||
- Is used in heartbeat registration with Grafana
|
||||
|
||||
### Alias Entries
|
||||
|
||||
Add alias domains using the repeatable subform table. Each alias entry has the following options:
|
||||
|
||||
| Field | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `domain` | Text | (required) | The alias domain name, e.g. `www.example.com` |
|
||||
| `offline` | Yes/No | No | When Yes, visitors to this alias see the offline page |
|
||||
| `offline_message` | Textarea | -- | Custom message displayed when the alias is offline (only shown when `offline` is Yes) |
|
||||
| `robots` | List | `index, follow` | Robots meta tag directive for this alias |
|
||||
| `redirect_backend` | Yes/No | Yes | When Yes, admin URLs (`/administrator`) on this alias redirect to the primary domain |
|
||||
|
||||
### Robots Options
|
||||
|
||||
Each alias can have its own robots directive:
|
||||
|
||||
| Value | Effect |
|
||||
|---|---|
|
||||
| `index, follow` | Normal indexing (default) |
|
||||
| `noindex, follow` | Do not index pages, but follow links |
|
||||
| `index, nofollow` | Index pages, do not follow links |
|
||||
| `noindex, nofollow` | Do not index or follow |
|
||||
| `none` | Equivalent to `noindex, nofollow` |
|
||||
|
||||
## How Canonical URLs Work
|
||||
|
||||
When a request arrives on an alias domain, MokoWaaS:
|
||||
|
||||
1. Matches the `HTTP_HOST` against configured alias domains
|
||||
2. Applies the alias-specific robots meta tag
|
||||
3. If the alias is marked offline, renders the offline page with the custom message
|
||||
4. If `redirect_backend` is enabled and the request is for `/administrator`, issues a 301 redirect to the primary domain's admin
|
||||
5. Sets the canonical URL to the primary domain equivalent of the current page
|
||||
|
||||
This prevents duplicate content issues when the same site is accessible from multiple domains.
|
||||
|
||||
## Grafana Monitoring for Aliases
|
||||
|
||||
When the plugin sends a heartbeat to the Grafana monitoring receiver, it registers both the primary domain and all alias domains. The monitoring dashboard can then track health status for each domain independently.
|
||||
|
||||
Each alias appears as a separate entry in the Grafana Infinity datasource, pointing to the same health endpoint but accessed via the alias domain. This ensures SSL certificate checks and DNS resolution are validated per-domain.
|
||||
|
||||
## DreamHost Mirror Setup
|
||||
|
||||
For sites hosted on DreamHost, alias domains are typically configured as "mirror" domains in the DreamHost panel:
|
||||
|
||||
1. In DreamHost panel, add the alias domain as a **Mirror** of the primary domain
|
||||
2. Ensure DNS for the alias domain points to the DreamHost server
|
||||
3. Add the alias domain to the MokoWaaS Site Aliases configuration
|
||||
4. Set `redirect_backend` to Yes (recommended) so admin access always uses the primary domain
|
||||
5. Set `robots` to `noindex, nofollow` if the alias is a staging or preview domain
|
||||
|
||||
DreamHost mirrors serve the same filesystem, so no additional Joomla configuration is needed beyond the MokoWaaS alias entry.
|
||||
Reference in New Issue
Block a user