diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..998448a --- /dev/null +++ b/.gitattributes @@ -0,0 +1,62 @@ +# Auto detect text files and perform LF normalization +* text=auto + +# PHP files +*.php text eol=lf + +# XML manifests +*.xml text eol=lf + +# Language files +*.ini text eol=lf + +# SQL files +*.sql text eol=lf + +# Shell scripts +*.sh text eol=lf + +# Markdown +*.md text eol=lf + +# YAML +*.yml text eol=lf +*.yaml text eol=lf + +# CSS/JS +*.css text eol=lf +*.js text eol=lf + +# JSON +*.json text eol=lf + +# Windows scripts +*.bat text eol=crlf +*.cmd text eol=crlf +*.ps1 text eol=crlf + +# Binary files +*.zip binary +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.ico binary +*.webp binary +*.woff binary +*.woff2 binary +*.ttf binary +*.eot binary + +# Export ignore (not included in archives) +.mokogitea/ export-ignore +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +.gitmessage export-ignore +CLAUDE.md export-ignore +CONTRIBUTING.md export-ignore +CODE_OF_CONDUCT.md export-ignore +Makefile export-ignore +composer.json export-ignore +phpstan.neon export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..726a684 --- /dev/null +++ b/.gitignore @@ -0,0 +1,204 @@ +# ============================================================ +# Local task tracking (not version controlled) +# ============================================================ +TODO.md + +# ============================================================ +# Environment and secrets +# ============================================================ +.env +.env.local +.env.*.local +*.local.php +*.secret.php +configuration.php +configuration.*.php +configuration.local.php +conf/conf.php +conf/conf*.php +secrets/ +*.secrets.* + +# ============================================================ +# Logs, dumps and databases +# ============================================================ +*.db +*.db-journal +*.dump +*.log +*.pid +*.seed + + +# ============================================================ +# OS / Editor / IDE cruft +# ============================================================ +.DS_Store +Thumbs.db +desktop.ini +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db +$RECYCLE.BIN/ +System Volume Information/ +*.lnk +Icon? +.idea/ +.settings/ +.claude/ +.vscode/* +!.vscode/tasks.json +!.vscode/settings.json.example +!.vscode/extensions.json +*.code-workspace +*.sublime* +.project +.buildpath +.classpath +*.bak +*.swp +*.swo +*.tmp +*.old +*.orig + +# ============================================================ +# Dev scripts and scratch +# ============================================================ +TODO.md +todo* +*ffs* + +# ============================================================ +# SFTP / sync tools +# ============================================================ +sftp-config*.json +sftp-config.json.template +sftp-settings.json + +# ============================================================ +# Sublime SFTP / FTP sync +# ============================================================ +*.sublime-project +*.sublime-workspace +*.sublime-settings +.libsass.json +*.ffs* + +# ============================================================ +# Replit / cloud IDE +# ============================================================ +.replit +replit.md + +# ============================================================ +# Archives / release artifacts +# ============================================================ +*.7z +*.rar +*.tar +*.tar.gz +*.tgz +*.zip +artifacts/ +release/ +releases/ + +# ============================================================ +# Build outputs and site generators +# ============================================================ +.mkdocs-build/ +.cache/ +.parcel-cache/ +build/ +dist/ +out/ +site/ +*.map +*.css.map +*.js.map +*.tsbuildinfo + +# ============================================================ +# CI / test artifacts +# ============================================================ +.coverage +.coverage.* +coverage/ +coverage.xml +htmlcov/ +junit.xml +reports/ +test-results/ +tests/_output/ +.github/local/ +.github/workflows/*.log + +# ============================================================ +# Node / JavaScript +# ============================================================ +node_modules/ +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +.pnpm-store/ +.yarn/ +.npmrc +.eslintcache +package-lock.json + +# ============================================================ +# PHP / Composer tooling +# ============================================================ +vendor/ +!src/media/vendor/ +composer.lock +*.phar +codeception.phar +.phpunit.result.cache +.php_cs.cache +.php-cs-fixer.cache +.phpstan.cache +.phplint-cache +phpmd-cache/ +.psalm/ +.rector/ + +# ============================================================ +# Python +# ============================================================ +__pycache__/ +*.py[cod] +*.pyc +*$py.class +*.so +.Python +.eggs/ +*.egg +*.egg-info/ +.installed.cfg +MANIFEST +develop-eggs/ +downloads/ +eggs/ +parts/ +sdist/ +var/ +wheels/ +ENV/ +env/ +.venv/ +venv/ +.pytest_cache/ +.mypy_cache/ +.ruff_cache/ +.pyright/ +.tox/ +.nox/ +*.cover +*.coverage +hypothesis/ + +profile.ps1 +.mcp.json diff --git a/.mokogitea/manifest.xml b/.mokogitea/manifest.xml index 7404636..97027dd 100644 --- a/.mokogitea/manifest.xml +++ b/.mokogitea/manifest.xml @@ -5,9 +5,11 @@ --> - MokoOpenGraph + MokoJoomOpenGraph + Package - MokoJoomOpenGraph MokoConsulting Open Graph, SEO meta tags, and social sharing image management for Joomla articles and menu items + 01.00.01 GNU General Public License v3 diff --git a/.mokogitea/workflows/auto-release.yml b/.mokogitea/workflows/auto-release.yml index 7049eb3..44a2d64 100644 --- a/.mokogitea/workflows/auto-release.yml +++ b/.mokogitea/workflows/auto-release.yml @@ -1,634 +1,285 @@ -# Copyright (C) 2026 Moko Consulting -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: moko-platform.Release -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/moko-platform -# PATH: /templates/workflows/universal/auto-release.yml.template -# VERSION: 05.00.00 -# BRIEF: Universal build & release � detects platform from manifest.xml -# -# +========================================================================+ -# | UNIVERSAL BUILD & RELEASE PIPELINE | -# +========================================================================+ -# | | -# | Reads manifest.xml (joomla|dolibarr|generic) to branch logic. | -# | | -# | Platform-specific: | -# | joomla: XML manifest, updates.xml, type-prefixed packages | -# | dolibarr: mod*.class.php, update.txt, dev version reset | -# | generic: README-only, no update stream | -# | | -# +========================================================================+ - -name: "Universal: Build & Release" - -on: - pull_request: - types: [closed] - branches: - - main - paths: - - 'src/**' - - 'htdocs/**' - workflow_dispatch: - -env: - FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true - GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} - GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }} - GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }} - -permissions: - contents: write - -jobs: - release: - name: Build & Release Pipeline - runs-on: release - if: >- - github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch' - - steps: - - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - token: ${{ secrets.GA_TOKEN }} - fetch-depth: 0 - - - name: Setup moko-platform tools - env: - MOKO_CLONE_TOKEN: ${{ secrets.GA_TOKEN }} - MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting - COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_TOKEN }}"}}' - run: | - # Ensure PHP + Composer are available - if ! command -v composer &> /dev/null; then - sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1 - fi - git clone --depth 1 --branch main --quiet \ - "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \ - /tmp/moko-platform-api - cd /tmp/moko-platform-api - composer install --no-dev --no-interaction --quiet - - - # -- PLATFORM DETECTION --------------------------------------------------- - - name: Detect platform - id: platform - run: | - # Read platform from manifest.xml element; fallback to generic - PLATFORM=$(sed -n 's/.*\([^<]*\)<\/platform>.*//p' .mokogitea/manifest.xml 2>/dev/null | head -1 | tr -d '[:space:]') - [ -z "$PLATFORM" ] && PLATFORM="generic" - echo "platform=$PLATFORM" >> "$GITHUB_OUTPUT" - echo "Platform detected: ${PLATFORM}" - # For packages: prefer pkg_*.xml in src/; fallback to any manifest - MANIFEST=$(find ./src -maxdepth 1 -name "pkg_*.xml" -exec grep -l '/dev/null | head -1) - [ -z "$MANIFEST" ] && MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" ! -path "*/packages/*" -exec grep -l '/dev/null | head -1) - [ -z "$MANIFEST" ] && MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" -exec grep -l '/dev/null | head -1) - MOD_FILE=$(find . -maxdepth 4 -name "mod*.class.php" ! -path "./.git/*" -exec grep -l 'extends DolibarrModules' {} \; 2>/dev/null | head -1) - echo "manifest=${MANIFEST}" >> "$GITHUB_OUTPUT" - echo "mod_file=${MOD_FILE}" >> "$GITHUB_OUTPUT" - - # -- STEP 1: Read version ----------------------------------------------- - - name: "Step 1: Read version from README.md" - id: version - run: | - VERSION=$(php /tmp/moko-platform-api/cli/version_read.php --path . 2>/dev/null) - if [ -z "$VERSION" ]; then - echo "No VERSION in README.md — skipping release" - echo "skip=true" >> "$GITHUB_OUTPUT" - exit 0 - fi - # Derive major.minor for branch naming (patches update existing branch) - MINOR=$(echo "$VERSION" | awk -F. '{printf "%s.%s", $1, $2}') - PATCH=$(echo "$VERSION" | awk -F. '{print $3}') - - MAJOR=$(echo "$VERSION" | awk -F. '{print $1}') - MINOR_NUM=$(echo "$VERSION" | awk -F. '{print $2}') - - echo "version=$VERSION" >> "$GITHUB_OUTPUT" - echo "branch=version/${MAJOR}" >> "$GITHUB_OUTPUT" - echo "minor=$MINOR" >> "$GITHUB_OUTPUT" - echo "major=$MAJOR" >> "$GITHUB_OUTPUT" - echo "release_tag=stable" >> "$GITHUB_OUTPUT" - echo "stability=stable" >> "$GITHUB_OUTPUT" - echo "skip=false" >> "$GITHUB_OUTPUT" - if [ "$PATCH" = "00" ] || [ "$PATCH" = "01" ]; then - echo "is_minor=true" >> "$GITHUB_OUTPUT" - echo "Version: $VERSION (first release for this minor — full pipeline)" - else - echo "is_minor=false" >> "$GITHUB_OUTPUT" - echo "Version: $VERSION (patch — platform version + badges only)" - fi - - # -- STEP 1b: Bump minor version (stable = minor bump, reset patch) ------ - - name: "Step 1b: Bump minor version for stable release" - if: steps.version.outputs.skip != 'true' - id: bump - run: | - CLI="/tmp/moko-platform-api/cli" - CURRENT=$(php $CLI/version_read.php --path . 2>/dev/null) - [ -z "$CURRENT" ] && { echo "skip=true" >> "$GITHUB_OUTPUT"; exit 0; } - - # Minor bump via CLI (updates README.md in-place) - BUMP_OUT=$(php $CLI/version_bump.php --path . --minor) - VERSION=$(php $CLI/version_read.php --path . 2>/dev/null) - TODAY=$(date +%Y-%m-%d) - echo "Stable bump: ${BUMP_OUT}" - - # Set platform-specific version (Joomla XML, Dolibarr mod*.class.php) - php $CLI/version_set_platform.php --path . --version "$VERSION" --stability stable --branch main - - # Promote [Unreleased] in CHANGELOG.md - php $CLI/changelog_promote.php --path . --version "$VERSION" --date "$TODAY" 2>/dev/null || true - - # Commit and push - 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 - git diff --cached --quiet || { - git commit -m "chore(version): bump ${CURRENT} → ${VERSION} [skip ci]" - git push origin HEAD:main 2>&1 - } - - # Override version output for rest of pipeline - MAJOR=$(echo "$VERSION" | cut -d. -f1) - echo "version=${VERSION}" >> "$GITHUB_OUTPUT" - echo "major=${MAJOR}" >> "$GITHUB_OUTPUT" - - - name: Check if already released - if: steps.version.outputs.skip != 'true' - id: check - run: | - TAG="${{ steps.version.outputs.release_tag }}" - BRANCH="${{ steps.version.outputs.branch }}" - - TAG_EXISTS=false - BRANCH_EXISTS=false - - git rev-parse "$TAG" >/dev/null 2>&1 && TAG_EXISTS=true - git ls-remote --heads origin "$BRANCH" 2>/dev/null | grep -q "$BRANCH" && BRANCH_EXISTS=true - - echo "tag_exists=$TAG_EXISTS" >> "$GITHUB_OUTPUT" - echo "branch_exists=$BRANCH_EXISTS" >> "$GITHUB_OUTPUT" - - # Tag and branch may persist across patch releases — never skip - echo "already_released=false" >> "$GITHUB_OUTPUT" - - # -- SANITY CHECKS ------------------------------------------------------- - - name: "Sanity: Pre-release validation" - if: >- - steps.version.outputs.skip != 'true' && - steps.check.outputs.already_released != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - ERRORS=0 - - PLATFORM="${{ steps.platform.outputs.platform }}" - MANIFEST="${{ steps.platform.outputs.manifest }}" - MOD_FILE="${{ steps.platform.outputs.mod_file }}" - echo "## Pre-Release Sanity Checks (${PLATFORM})" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - - # -- Version drift check (must pass before release) -------- - README_VER=$(sed -n 's/.*VERSION:[[:space:]]*\([0-9][0-9]\.[0-9][0-9]\.[0-9][0-9]\).*/\1/p' README.md 2>/dev/null | head -1) - if [ "$README_VER" != "$VERSION" ]; then - echo "- Version drift: README says \`${README_VER}\` but releasing \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - else - echo "- Version consistent: \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - fi - - # Check CHANGELOG version matches - CL_VER=$(sed -n 's/.*VERSION:[[:space:]]*\([0-9][0-9]\.[0-9][0-9]\.[0-9][0-9]\).*/\1/p' CHANGELOG.md 2>/dev/null | head -1) - if [ -n "$CL_VER" ] && [ "$CL_VER" != "$VERSION" ]; then - echo "- CHANGELOG drift: \`${CL_VER}\` != \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - fi - - # Check composer.json version if present - if [ -f "composer.json" ]; then - COMP_VER=$(sed -n 's/.*"version"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' composer.json 2>/dev/null | head -1) - if [ -n "$COMP_VER" ] && [ "$COMP_VER" != "$VERSION" ]; then - echo "- composer.json drift: \`${COMP_VER}\` != \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - fi - fi - - # Common checks - if [ ! -f "LICENSE" ]; then - echo "- Missing LICENSE file" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - else - echo "- LICENSE present" >> $GITHUB_STEP_SUMMARY - fi - - if [ ! -d "src" ] && [ ! -d "htdocs" ]; then - echo "- Warning: No src/ or htdocs/ directory" >> $GITHUB_STEP_SUMMARY - else - echo "- Source directory present" >> $GITHUB_STEP_SUMMARY - fi - - # -- Platform-specific checks -------- - case "$PLATFORM" in - joomla) - if [ -n "$MANIFEST" ]; then - XML_VER=$(sed -n 's/.*\([^<]*\)<\/version>.*/\1/p' "$MANIFEST" 2>/dev/null | head -1) - if [ -n "$XML_VER" ] && [ "$XML_VER" != "$VERSION" ]; then - echo "- Manifest drift: \`${XML_VER}\` != \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - else - echo "- Manifest version: \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - fi - TYPE=$(sed -n 's/.*]*type="\([^"]*\)".*/\1/p' "$MANIFEST" 2>/dev/null) - echo "- Extension type: ${TYPE:-unknown}" >> $GITHUB_STEP_SUMMARY - else - echo "- No Joomla XML manifest (WaaS site)" >> $GITHUB_STEP_SUMMARY - fi ;; - dolibarr) - if [ -n "$MOD_FILE" ]; then - MOD_VER=$(sed -n "s/.*\\\$this->version = '\([^']*\)'.*/\1/p" "$MOD_FILE" 2>/dev/null | head -1) - if [ -n "$MOD_VER" ] && [ "$MOD_VER" != "$VERSION" ]; then - echo "- Module drift: \`${MOD_VER}\` != \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - else - echo "- Module version: \`${VERSION}\`" >> $GITHUB_STEP_SUMMARY - fi - else - echo "- No mod*.class.php found" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - fi - if [ ! -f "update.txt" ]; then - echo "- Missing update.txt" >> $GITHUB_STEP_SUMMARY - ERRORS=$((ERRORS+1)) - fi ;; - *) echo "- Generic platform � no manifest checks" >> $GITHUB_STEP_SUMMARY ;; - esac - - echo "" >> $GITHUB_STEP_SUMMARY - if [ "$ERRORS" -gt 0 ]; then - echo "**${ERRORS} error(s) — release may be incomplete**" >> $GITHUB_STEP_SUMMARY - else - echo "**All sanity checks passed**" >> $GITHUB_STEP_SUMMARY - fi - - # -- STEP 2: Create or update version/XX.YY archive branch --------------- - # Always runs — every version change on main archives to version/XX.YY - - name: "Step 2: Version archive branch" - if: steps.check.outputs.already_released != 'true' - run: | - BRANCH="${{ steps.version.outputs.branch }}" - IS_MINOR="${{ steps.version.outputs.is_minor }}" - PATCH="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - PATCH_NUM=$(echo "$PATCH" | awk -F. '{print $3}') - - # Check if branch exists - if git ls-remote --heads origin "$BRANCH" | grep -q "$BRANCH"; then - git push origin HEAD:"$BRANCH" --force - echo "Updated archive branch: ${BRANCH} (patch ${PATCH_NUM})" >> $GITHUB_STEP_SUMMARY - else - git checkout -b "$BRANCH" 2>/dev/null || git checkout "$BRANCH" - git push origin "$BRANCH" --force - echo "Created archive branch: ${BRANCH}" >> $GITHUB_STEP_SUMMARY - fi - - # -- STEP 3: Set platform version ---------------------------------------- - - name: "Step 3: Set platform version" - if: >- - steps.version.outputs.skip != 'true' && - steps.check.outputs.already_released != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - php /tmp/moko-platform-api/cli/version_set_platform.php \ - --path . --version "$VERSION" --branch main - - # -- STEP 4: Update version badges ---------------------------------------- - - name: "Step 4: Update version badges" - if: >- - steps.version.outputs.skip != 'true' && - steps.check.outputs.already_released != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - php /tmp/moko-platform-api/cli/badge_update.php --path . --version "$VERSION" - - # -- STEP 5: Write updates.xml (Joomla update server) --------------------- - - name: "Step 5: Write update stream" - id: updates - if: >- - steps.version.outputs.skip != 'true' && - steps.check.outputs.already_released != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - CLI="/tmp/moko-platform-api/cli" - - # Generate updates.xml with all stability channels + suffixed versions - # Also exports ext_element, ext_name, ext_type, ext_folder to GITHUB_OUTPUT - php $CLI/updates_xml_build.php \ - --path . \ - --version "$VERSION" \ - --stability stable \ - --gitea-url "${GITEA_URL}" \ - --org "${GITEA_ORG}" \ - --repo "${GITEA_REPO}" \ - --github-output - - echo "updates.xml: ${VERSION} (all channels updated to stable)" >> $GITHUB_STEP_SUMMARY - - # -- Commit all changes --------------------------------------------------- - - 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] " - git push -u origin HEAD - - # -- STEP 6: Create tag --------------------------------------------------- - - name: "Step 6: Create git tag" - if: >- - steps.version.outputs.skip != 'true' && - steps.check.outputs.tag_exists != 'true' && - steps.version.outputs.is_minor == 'true' - run: | - RELEASE_TAG="${{ steps.version.outputs.release_tag }}" - # Only create the major release tag if it doesn't exist yet - if ! git rev-parse "$RELEASE_TAG" >/dev/null 2>&1; then - git tag "$RELEASE_TAG" - git push origin "$RELEASE_TAG" - echo "Tag created: ${RELEASE_TAG}" >> $GITHUB_STEP_SUMMARY - else - echo "Tag ${RELEASE_TAG} already exists" >> $GITHUB_STEP_SUMMARY - fi - echo "Tag: ${TAG}" >> $GITHUB_STEP_SUMMARY - - # -- STEP 7: Create or update Gitea Release -------------------------------- - - name: "Step 7: Gitea Release" - if: >- - steps.version.outputs.skip != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - RELEASE_TAG="${{ steps.version.outputs.release_tag }}" - BRANCH="${{ steps.version.outputs.branch }}" - CLI="/tmp/moko-platform-api/cli" - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - - # Reuse metadata from Step 5 - EXT_NAME="${{ steps.updates.outputs.ext_name }}" - TYPE_PREFIX="${{ steps.updates.outputs.type_prefix }}" - EXT_ELEMENT="${{ steps.updates.outputs.ext_element }}" - [ -z "$EXT_NAME" ] && EXT_NAME="${GITEA_REPO}" - [ -z "$EXT_ELEMENT" ] && EXT_ELEMENT=$(echo "${GITEA_REPO}" | tr '[:upper:]' '[:lower:]' | tr -d ' -') - - RELEASE_NAME="${EXT_NAME} ${VERSION} (${TYPE_PREFIX}${EXT_ELEMENT}-${VERSION})" - NOTES=$(php $CLI/release_notes.php --path . --version "$VERSION" 2>/dev/null) - [ -z "$NOTES" ] && NOTES="Release ${VERSION}" - - php $CLI/release_manage.php \ - --action create \ - --tag "$RELEASE_TAG" \ - --name "$RELEASE_NAME" \ - --body "## ${VERSION} ($(date +%Y-%m-%d))\n${NOTES}" \ - --target "$BRANCH" \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "$API_BASE" - - echo "Release created: ${RELEASE_NAME}" >> $GITHUB_STEP_SUMMARY - - # -- STEP 8: Build package, upload, and update checksums ------------------- - - name: "Step 8: Build package and upload" - if: >- - steps.version.outputs.skip != 'true' - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - RELEASE_TAG="${{ steps.version.outputs.release_tag }}" - CLI="/tmp/moko-platform-api/cli" - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - - # Build ZIP + tar.gz via CLI (handles single and multi-extension packages) - php $CLI/package_build.php --path . --version "$VERSION" --output-dir /tmp --github-output - - # Read outputs from package_build - ZIP_NAME="${{ steps.updates.outputs.type_prefix }}${{ steps.updates.outputs.ext_element }}-${VERSION}.zip" - TAR_NAME="${{ steps.updates.outputs.type_prefix }}${{ steps.updates.outputs.ext_element }}-${VERSION}.tar.gz" - - # Upload assets to release (handles dedup automatically) - php $CLI/release_manage.php \ - --action upload \ - --tag "$RELEASE_TAG" \ - --files "/tmp/${ZIP_NAME},/tmp/${TAR_NAME}" \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "$API_BASE" - - # Regenerate updates.xml with SHA-256 from built package - SHA256_ZIP=$(sha256sum "/tmp/${ZIP_NAME}" | cut -d' ' -f1) - php $CLI/updates_xml_build.php \ - --path . \ - --version "$VERSION" \ - --stability stable \ - --sha "$SHA256_ZIP" \ - --gitea-url "${GITEA_URL}" \ - --org "${GITEA_ORG}" \ - --repo "${GITEA_REPO}" - - # Commit updated updates.xml - git add updates.xml - git commit -m "chore(release): ZIP + tar.gz for ${VERSION} [skip ci]" \ - --author="gitea-actions[bot] " || true - git push || true - - # Sync updates.xml to main via API (may be on version/XX branch) - GA_TOKEN="${{ secrets.GA_TOKEN }}" - API="${GITEA_URL:-https://git.mokoconsulting.tech}/api/v1/repos/${{ github.repository }}" - FILE_SHA=$(curl -sf -H "Authorization: token ${GA_TOKEN}" \ - "${API}/contents/updates.xml?ref=main" | jq -r '.sha // empty') - if [ -n "$FILE_SHA" ]; then - CONTENT=$(base64 -w0 updates.xml) - curl -sf -X PUT -H "Authorization: token ${GA_TOKEN}" \ - -H "Content-Type: application/json" \ - "${API}/contents/updates.xml" \ - -d "$(jq -n \ - --arg content "$CONTENT" \ - --arg sha "$FILE_SHA" \ - --arg msg "chore: sync updates.xml ${VERSION} [skip ci]" \ - --arg branch "main" \ - '{content: $content, sha: $sha, message: $msg, branch: $branch}' - )" > /dev/null 2>&1 \ - && echo "updates.xml synced to main via API" \ - || echo "WARNING: failed to sync updates.xml to main" - fi - - # Build release body with changelog + SHA - NOTES=$(php $CLI/release_notes.php --path . --version "$VERSION" 2>/dev/null) - SHA256_TAR="" - [ -f "/tmp/${TAR_NAME}" ] && SHA256_TAR=$(sha256sum "/tmp/${TAR_NAME}" | cut -d' ' -f1) - - BODY="## ${VERSION} ($(date +%Y-%m-%d))\n\n${NOTES}\n\n---\n\n### Checksums\n\n" - BODY="${BODY}| File | SHA-256 |\n|------|--------|\n" - BODY="${BODY}| \`${ZIP_NAME}\` | \`${SHA256_ZIP}\` |\n" - [ -n "$SHA256_TAR" ] && BODY="${BODY}| \`${TAR_NAME}\` | \`${SHA256_TAR}\` |\n" - - printf '%b' "$BODY" > /tmp/release_body.md - php $CLI/release_manage.php \ - --action update-body \ - --tag "$RELEASE_TAG" \ - --body-file /tmp/release_body.md \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "$API_BASE" - - echo "### Packages" >> $GITHUB_STEP_SUMMARY - echo "| Package | SHA-256 |" >> $GITHUB_STEP_SUMMARY - echo "|---------|---------|" >> $GITHUB_STEP_SUMMARY - echo "| \`${ZIP_NAME}\` | \`${SHA256_ZIP}\` |" >> $GITHUB_STEP_SUMMARY - echo "| \`${TAR_NAME}\` | \`${SHA256_TAR}\` |" >> $GITHUB_STEP_SUMMARY - - # -- STEP 9: Mirror to GitHub (stable only) -------------------------------- - - name: "Step 9: Mirror release to GitHub" - if: >- - steps.version.outputs.skip != 'true' && - steps.version.outputs.stability == 'stable' && - secrets.GH_TOKEN != '' - continue-on-error: true - env: - GH_TOKEN: ${{ secrets.GH_TOKEN }} - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - RELEASE_TAG="${{ steps.version.outputs.release_tag }}" - MAJOR="${{ steps.version.outputs.major }}" - BRANCH="${{ steps.version.outputs.branch }}" - GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}" - - NOTES=$(php /tmp/moko-platform-api/cli/release_notes.php --path . --version "$VERSION" 2>/dev/null || true) - [ -z "$NOTES" ] && NOTES="Release ${VERSION}" - echo "$NOTES" > /tmp/release_notes.md - - EXISTING=$(curl -sf -H "Authorization: token ${{ secrets.GA_TOKEN }}" "${GITEA_URL:-https://git.mokoconsulting.tech}/api/v1/repos/${{ github.repository }}/releases/tags/$RELEASE_TAG" 2>/dev/null | jq -r ".tag_name // empty" || true) - - if [ -z "$EXISTING" ]; then - gh release create "$RELEASE_TAG" \ - --repo "$GH_REPO" \ - --title "v${MAJOR} (latest: ${VERSION})" \ - --notes-file /tmp/release_notes.md \ - --target "$BRANCH" || true - else - gh release edit "$RELEASE_TAG" \ - --repo "$GH_REPO" \ - --title "v${MAJOR} (latest: ${VERSION})" || true - fi - - # Upload assets to GitHub mirror - for PKG in /tmp/${EXT_ELEMENT:-pkg}-${VERSION}.*; do - if [ -f "$PKG" ]; then - _RELID=$(curl -sf -H "Authorization: token ${{ secrets.GA_TOKEN }}" "${GITEA_URL:-https://git.mokoconsulting.tech}/api/v1/repos/${{ github.repository }}/releases/tags/$RELEASE_TAG" 2>/dev/null | jq -r ".id // empty") - [ -n "$_RELID" ] && curl -sf -X POST -H "Authorization: token ${{ secrets.GA_TOKEN }}" -H "Content-Type: application/octet-stream" "${GITEA_URL:-https://git.mokoconsulting.tech}/api/v1/repos/${{ github.repository }}/releases/${_RELID}/assets?name=$(basename $PKG)" --data-binary "@$PKG" > /dev/null 2>&1 || true - fi - done - echo "GitHub mirror updated: ${GH_REPO} ${RELEASE_TAG}" >> $GITHUB_STEP_SUMMARY - - # -- STEP 10: Sync main branch to GitHub mirror ---------------------------- - - name: "Step 10: Push main to GitHub mirror" - if: >- - steps.version.outputs.skip != 'true' && - secrets.GH_TOKEN != '' - continue-on-error: true - run: | - GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}" - GH_ORG=$(echo "$GH_REPO" | cut -d/ -f1) - GH_NAME=$(echo "$GH_REPO" | cut -d/ -f2) - git remote add github "https://x-access-token:${{ secrets.GH_TOKEN }}@github.com/${GH_ORG}/${GH_NAME}.git" 2>/dev/null || \ - git remote set-url github "https://x-access-token:${{ secrets.GH_TOKEN }}@github.com/${GH_ORG}/${GH_NAME}.git" - git fetch origin main --depth=1 - git push github origin/main:refs/heads/main --force 2>/dev/null \ - && echo "main branch pushed to GitHub mirror" \ - || echo "WARNING: GitHub mirror push failed" - - # -- Clean up lesser pre-releases (cascade) --------------------------------- - - name: "Delete lesser pre-release channels" - if: steps.version.outputs.skip != 'true' - continue-on-error: true - run: | - php /tmp/moko-platform-api/cli/release_cascade.php \ - --stability stable \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - - # -- STEP 11: Reset dev branch from main ------------------------------------ - - name: "Step 11: Delete and recreate dev 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 }}" - - # Delete dev branch - curl -sf -X DELETE -H "Authorization: token ${TOKEN}" \ - "${API_BASE}/branches/dev" 2>/dev/null && echo "Deleted dev branch" - - # Recreate dev from main (now includes version bump + changelog promotion) - curl -sf -X POST -H "Authorization: token ${TOKEN}" \ - -H "Content-Type: application/json" \ - "${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 - - - # -- Dolibarr post-release: Reset dev version ----------------------------- - - name: "Dolibarr: Reset dev version" - if: >- - steps.version.outputs.skip != 'true' && - steps.platform.outputs.platform == 'dolibarr' && - steps.platform.outputs.mod_file != '' - continue-on-error: true - run: | - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - TOKEN="${{ secrets.GA_TOKEN }}" - MOD_FILE="${{ steps.platform.outputs.mod_file }}" - ENCODED_PATH=$(echo "$MOD_FILE" | sed 's|^\./||' | python3 -c "import sys,urllib.parse; print(urllib.parse.quote(sys.stdin.read().strip()))") - FILE_RESP=$(curl -sf -H "Authorization: token ${TOKEN}" "${API_BASE}/contents/${ENCODED_PATH}?ref=dev" 2>/dev/null || true) - FILE_SHA=$(echo "$FILE_RESP" | python3 -c "import sys,json; print(json.load(sys.stdin).get('sha',''))" 2>/dev/null || true) - FILE_CONTENT=$(echo "$FILE_RESP" | python3 -c "import sys,json,base64; print(base64.b64decode(json.load(sys.stdin).get('content','')).decode())" 2>/dev/null || true) - if [ -n "$FILE_SHA" ] && [ -n "$FILE_CONTENT" ]; then - UPDATED=$(echo "$FILE_CONTENT" | sed "s/\$this->version = '[^']*'/\$this->version = 'development'/") - ENCODED=$(echo "$UPDATED" | base64 -w0) - curl -sf -X PUT -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" "${API_BASE}/contents/${ENCODED_PATH}" \ - -d "$(jq -n --arg content \"$ENCODED\" --arg sha \"$FILE_SHA\" --arg msg \"chore(version): reset dev version [skip ci]\" --arg branch \"dev\" '{content:$content,sha:$sha,message:$msg,branch:$branch}')" > /dev/null 2>&1 || true - fi - - # -- Summary -------------------------------------------------------------- - - name: Pipeline Summary - if: always() - run: | - VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" - PLATFORM="${{ steps.platform.outputs.platform }}" - if [ "${{ steps.version.outputs.skip }}" = "true" ]; then - echo "## Release Skipped" >> $GITHUB_STEP_SUMMARY - echo "No VERSION in README.md" >> $GITHUB_STEP_SUMMARY - elif [ "${{ steps.check.outputs.already_released }}" = "true" ]; then - echo "## Already Released — ${VERSION}" >> $GITHUB_STEP_SUMMARY - else - echo "" >> $GITHUB_STEP_SUMMARY - echo "## Build & Release Complete (${PLATFORM})" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "| Step | Result |" >> $GITHUB_STEP_SUMMARY - echo "|------|--------|" >> $GITHUB_STEP_SUMMARY - echo "| Platform | \`${PLATFORM}\` |" >> $GITHUB_STEP_SUMMARY - echo "| Version | \`${VERSION}\` |" >> $GITHUB_STEP_SUMMARY - echo "| Branch | \`${{ steps.version.outputs.branch }}\` |" >> $GITHUB_STEP_SUMMARY - echo "| Tag | \`${{ steps.version.outputs.tag }}\` |" >> $GITHUB_STEP_SUMMARY - echo "| Release | [View](${GITEA_URL}/${GITEA_ORG}/${GITEA_REPO}/releases/tag/${{ steps.version.outputs.tag }}) |" >> $GITHUB_STEP_SUMMARY - fi +# Copyright (C) 2026 Moko Consulting +# +# SPDX-License-Identifier: GPL-3.0-or-later +# +# FILE INFORMATION +# DEFGROUP: Gitea.Workflow +# INGROUP: moko-platform.Release +# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/moko-platform +# PATH: /templates/workflows/universal/auto-release.yml.template +# VERSION: 05.00.00 +# BRIEF: Universal build & release � detects platform from manifest.xml +# +# +========================================================================+ +# | UNIVERSAL BUILD & RELEASE PIPELINE | +# +========================================================================+ +# | | +# | Reads manifest.xml (joomla|dolibarr|generic) to branch logic. | +# | | +# | Platform-specific: | +# | joomla: XML manifest, updates.xml, type-prefixed packages | +# | dolibarr: mod*.class.php, update.txt, dev version reset | +# | generic: README-only, no update stream | +# | | +# +========================================================================+ + +name: "Universal: Build & Release" + +on: + pull_request: + types: [opened, closed] + branches: + - main + workflow_dispatch: + inputs: + action: + description: 'Action to perform' + required: false + type: choice + default: release + options: + - release + - promote-rc + +env: + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true + GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} + GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }} + GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }} + +permissions: + contents: write + +jobs: + # ── PR Opened → Rename branch to RC and build RC release ───────────────────── + promote-rc: + name: Promote to RC + runs-on: release + if: >- + (github.event.action == 'opened' && github.event.pull_request.merged != true) || + (github.event_name == 'workflow_dispatch' && inputs.action == 'promote-rc') + + steps: + - name: Checkout repository + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + with: + token: ${{ secrets.MOKOGITEA_TOKEN }} + fetch-depth: 1 + + - name: Setup moko-platform tools + env: + MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} + MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting + run: | + if ! command -v composer &> /dev/null; then + sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1 + fi + # Always fetch latest CLI tools — never use stale cache from previous runs + rm -rf /tmp/moko-platform-api + git clone --depth 1 --branch main --quiet \ + "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \ + /tmp/moko-platform-api + cd /tmp/moko-platform-api + composer install --no-dev --no-interaction --quiet + + - name: Rename branch to rc + run: | + php /tmp/moko-platform-api/cli/branch_rename.php \ + --from "${{ github.event.pull_request.head.ref || 'dev' }}" --to rc \ + --token "${{ secrets.MOKOGITEA_TOKEN }}" \ + --api-base "${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" \ + --pr "${{ github.event.pull_request.number }}" + + - name: Checkout rc and configure git + run: | + git fetch origin rc + git checkout rc + git config --local user.email "gitea-actions[bot]@mokoconsulting.tech" + git config --local user.name "gitea-actions[bot]" + git remote set-url origin "https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git" + + - name: Publish RC release + run: | + php /tmp/moko-platform-api/cli/release_publish.php \ + --path . --stability rc --bump minor --branch rc \ + --token "${{ secrets.MOKOGITEA_TOKEN }}" \ + --skip-update-stream + + - name: Summary + if: always() + run: | + echo "## Promoted to Release Candidate" >> $GITHUB_STEP_SUMMARY + echo "Branch renamed to rc, minor bump, RC release built (updates.xml managed by Gitea Pages)" >> $GITHUB_STEP_SUMMARY + + # ── Merged PR → Build & Release (or promote RC to stable) ──────────────────── + release: + name: Build & Release Pipeline + runs-on: release + if: >- + github.event.pull_request.merged == true || + (github.event_name == 'workflow_dispatch' && inputs.action != 'promote-rc') + + steps: + - name: Checkout repository + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + with: + token: ${{ secrets.MOKOGITEA_TOKEN }} + fetch-depth: 0 + + - name: Configure git for bot pushes + run: | + git config --local user.email "gitea-actions[bot]@mokoconsulting.tech" + git config --local user.name "gitea-actions[bot]" + git remote set-url origin "https://x-access-token:${{ secrets.MOKOGITEA_TOKEN }}@git.mokoconsulting.tech/${{ github.repository }}.git" + + - name: Check for merge conflict markers + run: | + CONFLICTS=$(grep -rn '<<<<<<< \|>>>>>>> \|^=======$' --include='*.php' --include='*.xml' --include='*.css' --include='*.js' --include='*.json' --include='*.md' --include='*.yml' --include='*.yaml' --include='*.ini' --include='*.txt' . 2>/dev/null | grep -v '.git/' || true) + if [ -n "$CONFLICTS" ]; then + echo "::error::Merge conflict markers found — aborting release" + echo "## Release Blocked: Conflict Markers" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + echo "$CONFLICTS" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + exit 1 + fi + echo "No conflict markers found" + + - name: Setup moko-platform tools + env: + MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} + MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting + COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN }}"}}' + run: | + # Ensure PHP + Composer are available + if ! command -v composer &> /dev/null; then + sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1 + fi + # Always fetch latest CLI tools — never use stale cache from previous runs + rm -rf /tmp/moko-platform-api + git clone --depth 1 --branch main --quiet \ + "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \ + /tmp/moko-platform-api + cd /tmp/moko-platform-api + composer install --no-dev --no-interaction --quiet + + + - name: "Publish stable release" + run: | + php /tmp/moko-platform-api/cli/release_publish.php \ + --path . --stability stable --bump minor --branch main \ + --token "${{ secrets.MOKOGITEA_TOKEN }}" \ + --skip-update-stream + + # -- STEP 9: Mirror to GitHub (stable only) -------------------------------- + - name: "Step 9: Mirror release to GitHub" + if: >- + steps.version.outputs.skip != 'true' && + secrets.GH_MIRROR_TOKEN != '' + continue-on-error: true + run: | + VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" + RELEASE_TAG="${{ steps.version.outputs.release_tag }}" + GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}" + API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" + php /tmp/moko-platform-api/cli/release_mirror.php \ + --version "$VERSION" --tag "$RELEASE_TAG" \ + --token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "$API_BASE" \ + --gh-token "${{ secrets.GH_MIRROR_TOKEN }}" --gh-repo "$GH_REPO" \ + --branch main 2>&1 || true + echo "GitHub mirror updated" >> $GITHUB_STEP_SUMMARY + + # -- STEP 10: Sync main branch to GitHub mirror ---------------------------- + - name: "Step 10: Push main to GitHub mirror" + if: >- + steps.version.outputs.skip != 'true' && + secrets.GH_MIRROR_TOKEN != '' + continue-on-error: true + run: | + GH_REPO="${{ vars.GH_MIRROR_REPO || github.repository }}" + GH_ORG=$(echo "$GH_REPO" | cut -d/ -f1) + GH_NAME=$(echo "$GH_REPO" | cut -d/ -f2) + git remote add github "https://x-access-token:${{ secrets.GH_MIRROR_TOKEN }}@github.com/${GH_ORG}/${GH_NAME}.git" 2>/dev/null || \ + git remote set-url github "https://x-access-token:${{ secrets.GH_MIRROR_TOKEN }}@github.com/${GH_ORG}/${GH_NAME}.git" + git fetch origin main --depth=1 + git push github origin/main:refs/heads/main --force 2>/dev/null \ + && echo "main branch pushed to GitHub mirror" \ + || echo "WARNING: GitHub mirror push failed" + + - name: "Step 11: Delete rc branch and recreate dev 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.MOKOGITEA_TOKEN }}" + + # Delete rc branch (ephemeral — created by promote-rc) + curl -sf -X DELETE -H "Authorization: token ${TOKEN}" \ + "${API_BASE}/branches/rc" 2>/dev/null \ + && echo "Deleted rc branch" || echo "rc branch not found" + + # Delete dev branch + curl -sf -X DELETE -H "Authorization: token ${TOKEN}" \ + "${API_BASE}/branches/dev" 2>/dev/null && echo "Deleted dev branch" + + # Recreate dev from main (now includes version bump + changelog promotion) + curl -sf -X POST -H "Authorization: token ${TOKEN}" \ + -H "Content-Type: application/json" \ + "${API_BASE}/branches" \ + -d '{"new_branch_name":"dev","old_branch_name":"main"}' 2>/dev/null && echo "Recreated dev from main" + + echo "Pre-release branches cleaned, dev reset from main" >> $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.MOKOGITEA_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 + + + + # -- Dolibarr post-release: Reset dev version ----------------------------- + - name: "Post-release: Reset dev version" + if: steps.version.outputs.skip != 'true' + continue-on-error: true + run: | + API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" + php /tmp/moko-platform-api/cli/version_reset_dev.php \ + --token "${{ secrets.MOKOGITEA_TOKEN }}" --api-base "${API_BASE}" \ + --branch dev --path . 2>&1 || true + + # -- Summary -------------------------------------------------------------- + - name: Pipeline Summary + if: always() + run: | + VERSION="${{ steps.bump.outputs.version || steps.version.outputs.version }}" + PLATFORM="${{ steps.platform.outputs.platform }}" + if [ "${{ steps.version.outputs.skip }}" = "true" ]; then + echo "## Release Skipped" >> $GITHUB_STEP_SUMMARY + echo "No VERSION in README.md" >> $GITHUB_STEP_SUMMARY + elif [ "${{ steps.check.outputs.already_released }}" = "true" ]; then + echo "## Already Released — ${VERSION}" >> $GITHUB_STEP_SUMMARY + else + echo "" >> $GITHUB_STEP_SUMMARY + echo "## Build & Release Complete (${PLATFORM})" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "| Step | Result |" >> $GITHUB_STEP_SUMMARY + echo "|------|--------|" >> $GITHUB_STEP_SUMMARY + echo "| Platform | \`${PLATFORM}\` |" >> $GITHUB_STEP_SUMMARY + echo "| Version | \`${VERSION}\` |" >> $GITHUB_STEP_SUMMARY + echo "| Branch | \`${{ steps.version.outputs.branch }}\` |" >> $GITHUB_STEP_SUMMARY + echo "| Tag | \`${{ steps.version.outputs.tag }}\` |" >> $GITHUB_STEP_SUMMARY + echo "| Release | [View](${GITEA_URL}/${GITEA_ORG}/${GITEA_REPO}/releases/tag/${{ steps.version.outputs.tag }}) |" >> $GITHUB_STEP_SUMMARY + fi diff --git a/.mokogitea/workflows/cascade-dev.yml b/.mokogitea/workflows/cascade-dev.yml deleted file mode 100644 index 4dbb135..0000000 --- a/.mokogitea/workflows/cascade-dev.yml +++ /dev/null @@ -1,213 +0,0 @@ -# Copyright (C) 2026 Moko Consulting -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Maintenance -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/MokoStandards-API -# PATH: /templates/workflows/cascade-dev.yml.template -# VERSION: 02.00.00 -# BRIEF: Forward-merge main → all open branches after every push to main -# -# +========================================================================+ -# | CASCADE MAIN → ALL BRANCHES | -# +========================================================================+ -# | | -# | Triggers on every push to main (PR merges, bot commits, etc.) | -# | | -# | 1. List all branches matching: dev, rc/*, beta/*, alpha/* | -# | 2. For each: create PR (main → branch), auto-merge if clean | -# | 3. On conflict: leave PR open for manual resolution | -# | | -# +========================================================================+ - -name: "Universal: Cascade Main → Dev" - -on: - push: - branches: - - main - workflow_dispatch: - -env: - FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true - GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} - GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }} - GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }} - -permissions: - contents: write - pull-requests: write - -jobs: - cascade: - name: Cascade main → branches - runs-on: ubuntu-latest - if: >- - !contains(github.event.head_commit.message, '[skip ci]') && - !contains(github.event.head_commit.message, '[skip cascade]') - - steps: - - name: Discover target branches - id: branches - env: - GA_TOKEN: ${{ secrets.GA_TOKEN }} - run: | - API="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - - # Fetch all branches (paginated) - PAGE=1 - ALL_BRANCHES="" - while true; do - BATCH=$(curl -sS \ - -H "Authorization: token ${GA_TOKEN}" \ - "${API}/branches?page=${PAGE}&limit=50" \ - | jq -r '.[].name // empty') - [ -z "$BATCH" ] && break - ALL_BRANCHES="$ALL_BRANCHES $BATCH" - PAGE=$((PAGE + 1)) - done - - # Filter to cascade targets: dev, dev/*, rc/*, beta/*, alpha/* - TARGETS="" - for BRANCH in $ALL_BRANCHES; do - case "$BRANCH" in - dev|dev/*|rc/*|beta/*|alpha/*) - TARGETS="$TARGETS $BRANCH" - ;; - esac - done - - TARGETS=$(echo "$TARGETS" | xargs) # trim whitespace - - if [ -z "$TARGETS" ]; then - echo "targets=" >> "$GITHUB_OUTPUT" - echo "ℹ️ No cascade target branches found" - else - echo "targets=$TARGETS" >> "$GITHUB_OUTPUT" - COUNT=$(echo "$TARGETS" | wc -w) - echo "📋 Found ${COUNT} target branch(es): ${TARGETS}" - fi - - - name: Cascade to all target branches - if: steps.branches.outputs.targets != '' - env: - GA_TOKEN: ${{ secrets.GA_TOKEN }} - run: | - API="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - SHORT_SHA="${GITHUB_SHA:0:7}" - TARGETS="${{ steps.branches.outputs.targets }}" - - SUCCESS=0 - CONFLICTS=0 - SKIPPED=0 - FAILED=0 - - for BRANCH in $TARGETS; do - echo "" - echo "═══ main → ${BRANCH} ═══" - - # Check if branch is already up to date - ENCODED_BRANCH=$(echo "$BRANCH" | sed 's|/|%2F|g') - RESPONSE=$(curl -sS \ - -H "Authorization: token ${GA_TOKEN}" \ - "${API}/compare/${ENCODED_BRANCH}...main") - - AHEAD=$(echo "$RESPONSE" | jq '.total_commits // 0') - - if [ "$AHEAD" -eq 0 ]; then - echo " ✅ Already up to date" - SKIPPED=$((SKIPPED + 1)) - continue - fi - - echo " ℹ️ main is ${AHEAD} commit(s) ahead" - - # Check for existing cascade PR - EXISTING=$(curl -sS \ - -H "Authorization: token ${GA_TOKEN}" \ - "${API}/pulls?state=open&head=${GITEA_ORG}:main&base=${ENCODED_BRANCH}&limit=1") - - EXISTING_COUNT=$(echo "$EXISTING" | jq 'length') - PR_NUMBER="" - - if [ "$EXISTING_COUNT" -gt 0 ]; then - PR_NUMBER=$(echo "$EXISTING" | jq -r '.[0].number') - echo " ℹ️ Reusing existing PR #${PR_NUMBER}" - else - # Create cascade PR - PR_RESPONSE=$(curl -sS -w "\n%{http_code}" \ - -X POST \ - -H "Authorization: token ${GA_TOKEN}" \ - -H "Content-Type: application/json" \ - -d "{ - \"title\": \"chore: cascade main → ${BRANCH} (${SHORT_SHA}) [skip ci]\", - \"body\": \"## Automatic cascade\\n\\nForward-merging \`main\` (${SHORT_SHA}) into \`${BRANCH}\`.\\n\\nIf conflicts exist, resolve manually and merge.\\n\\n> Auto-created by **Cascade Main → Dev**.\", - \"head\": \"main\", - \"base\": \"${BRANCH}\" - }" \ - "${API}/pulls") - - HTTP_CODE=$(echo "$PR_RESPONSE" | tail -1) - BODY=$(echo "$PR_RESPONSE" | sed '$d') - PR_NUMBER=$(echo "$BODY" | jq -r '.number // empty') - - if [ "$HTTP_CODE" != "201" ] || [ -z "$PR_NUMBER" ]; then - MSG=$(echo "$BODY" | jq -r '.message // .' 2>/dev/null | head -1) - echo " ❌ Failed to create PR (HTTP ${HTTP_CODE}): ${MSG}" - FAILED=$((FAILED + 1)) - continue - fi - - echo " ✅ Created PR #${PR_NUMBER}" - fi - - # Try auto-merge - PR_DATA=$(curl -sS \ - -H "Authorization: token ${GA_TOKEN}" \ - "${API}/pulls/${PR_NUMBER}") - - MERGEABLE=$(echo "$PR_DATA" | jq -r '.mergeable // false') - - if [ "$MERGEABLE" != "true" ]; then - echo " ⚠️ Conflicts — PR #${PR_NUMBER} left open" - CONFLICTS=$((CONFLICTS + 1)) - continue - fi - - MERGE_RESPONSE=$(curl -sS -w "\n%{http_code}" \ - -X POST \ - -H "Authorization: token ${GA_TOKEN}" \ - -H "Content-Type: application/json" \ - -d "{ - \"Do\": \"merge\", - \"merge_message_field\": \"chore: cascade main → ${BRANCH} [skip ci]\", - \"delete_branch_after_merge\": false - }" \ - "${API}/pulls/${PR_NUMBER}/merge") - - MERGE_HTTP=$(echo "$MERGE_RESPONSE" | tail -1) - - if [ "$MERGE_HTTP" = "200" ] || [ "$MERGE_HTTP" = "204" ]; then - echo " ✅ Merged — ${BRANCH} is in sync" - SUCCESS=$((SUCCESS + 1)) - else - MERGE_BODY=$(echo "$MERGE_RESPONSE" | sed '$d') - echo " ⚠️ Merge failed (HTTP ${MERGE_HTTP}) — PR #${PR_NUMBER} left open" - CONFLICTS=$((CONFLICTS + 1)) - fi - done - - # Summary - echo "" - echo "════════════════════════════════════════" - echo " ✅ Merged: ${SUCCESS}" - echo " ⚠️ Conflicts: ${CONFLICTS}" - echo " ⏭️ Up to date: ${SKIPPED}" - echo " ❌ Failed: ${FAILED}" - echo "════════════════════════════════════════" - - if [ "$FAILED" -gt 0 ]; then - exit 1 - fi diff --git a/.mokogitea/workflows/ci-joomla.yml b/.mokogitea/workflows/ci-joomla.yml index 5c66f14..f679e86 100644 --- a/.mokogitea/workflows/ci-joomla.yml +++ b/.mokogitea/workflows/ci-joomla.yml @@ -43,9 +43,9 @@ jobs: - name: Clone MokoStandards env: - GA_TOKEN: ${{ secrets.GA_TOKEN || secrets.GA_TOKEN || github.token }} - MOKO_CLONE_TOKEN: ${{ secrets.GA_TOKEN || secrets.GA_TOKEN || github.token }} - MOKO_CLONE_HOST: ${{ secrets.GA_TOKEN && 'git.mokoconsulting.tech/MokoConsulting' || 'github.com/mokoconsulting-tech' }} + GA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN || secrets.MOKOGITEA_TOKEN || github.token }} + MOKO_CLONE_TOKEN: ${{ secrets.MOKOGITEA_TOKEN || secrets.MOKOGITEA_TOKEN || github.token }} + MOKO_CLONE_HOST: ${{ secrets.MOKOGITEA_TOKEN && 'git.mokoconsulting.tech/MokoConsulting' || 'github.com/mokoconsulting-tech' }} run: | git clone --depth 1 --branch main --quiet \ "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/MokoStandards-API.git" \ @@ -53,7 +53,7 @@ jobs: - name: Install dependencies env: - COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GA_TOKEN || github.token }}"}}' + COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN || github.token }}"}}' run: | if [ -f "composer.json" ]; then composer install \ @@ -124,8 +124,13 @@ jobs: echo "Manifest is well-formed XML." >> $GITHUB_STEP_SUMMARY fi - # Check required tags: name, version, author, namespace (Joomla 5+) - for TAG in name version author namespace; do + # Check required tags + REQUIRED_TAGS="name version author" + # namespace is only required for non-package extensions + if ! grep -q 'type="package"' "$MANIFEST" 2>/dev/null; then + REQUIRED_TAGS="$REQUIRED_TAGS namespace" + fi + for TAG in $REQUIRED_TAGS; do if ! grep -q "<${TAG}>" "$MANIFEST" 2>/dev/null; then echo "Missing required tag: \`<${TAG}>\`" >> $GITHUB_STEP_SUMMARY ERRORS=$((ERRORS + 1)) @@ -197,6 +202,37 @@ jobs: echo "**Language file check passed.**" >> $GITHUB_STEP_SUMMARY fi + - name: Check en-GB and en-US language directories exist + run: | + echo "### Language Directory Check" >> $GITHUB_STEP_SUMMARY + ERRORS=0 + + for DIR in src/ htdocs/; do + [ -d "$DIR" ] || continue + # Find all language directories + while IFS= read -r -d '' LANG_DIR; do + HAS_GB=false + HAS_US=false + [ -d "${LANG_DIR}/en-GB" ] && HAS_GB=true + [ -d "${LANG_DIR}/en-US" ] && HAS_US=true + if [ "$HAS_GB" = false ]; then + echo "Missing \`en-GB\` in: \`${LANG_DIR}\`" >> $GITHUB_STEP_SUMMARY + ERRORS=$((ERRORS + 1)) + fi + if [ "$HAS_US" = false ]; then + echo "Missing \`en-US\` in: \`${LANG_DIR}\`" >> $GITHUB_STEP_SUMMARY + ERRORS=$((ERRORS + 1)) + fi + done < <(find "$DIR" -type d -name "language" -print0) + done + + if [ "${ERRORS}" -gt 0 ]; then + echo "**${ERRORS} missing language director(ies).**" >> $GITHUB_STEP_SUMMARY + exit 1 + else + echo "All language directories have en-GB and en-US." >> $GITHUB_STEP_SUMMARY + fi + - name: Check index.html files in directories run: | echo "### Index.html Check" >> $GITHUB_STEP_SUMMARY @@ -240,8 +276,8 @@ jobs: echo "" >> $GITHUB_STEP_SUMMARY ERRORS=0 - # Extract version from README.md - README_VERSION=$(grep -oP '^\s*VERSION:\s*\K[0-9]{2}\.[0-9]{2}\.[0-9]{2}' README.md | head -1) + # Extract version from README.md (supports both FILE INFORMATION block and HTML comment format) + README_VERSION=$(sed -n 's/.*VERSION:\s*\([0-9]\{2\}\.[0-9]\{2\}\.[0-9]\{2\}\).*/\1/p' README.md | head -1) if [ -z "$README_VERSION" ]; then echo "No VERSION found in README.md FILE INFORMATION block." >> $GITHUB_STEP_SUMMARY ERRORS=$((ERRORS + 1)) @@ -265,7 +301,7 @@ jobs: echo "Manifest: \`${MANIFEST}\`" >> $GITHUB_STEP_SUMMARY # Check matches README VERSION - MANIFEST_VERSION=$(grep -oP '\K[^<]+' "$MANIFEST" | head -1) + MANIFEST_VERSION=$(sed -n 's/.*\([^<]*\)<\/version>.*/\1/p' "$MANIFEST" | head -1) if [ -z "$MANIFEST_VERSION" ]; then echo "No \`\` tag in manifest." >> $GITHUB_STEP_SUMMARY ERRORS=$((ERRORS + 1)) @@ -346,7 +382,7 @@ jobs: - name: Install dependencies env: - COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GA_TOKEN || github.token }}"}}' + COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN || github.token }}"}}' run: | if [ -f "composer.json" ]; then composer install \ @@ -391,7 +427,7 @@ jobs: - name: Install dependencies env: - COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GA_TOKEN || github.token }}"}}' + COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_MIRROR_TOKEN || github.token }}"}}' run: | if [ -f "composer.json" ]; then composer install --no-interaction --prefer-dist --optimize-autoloader diff --git a/.mokogitea/workflows/cleanup.yml b/.mokogitea/workflows/cleanup.yml index 3a81856..29ca4d4 100644 --- a/.mokogitea/workflows/cleanup.yml +++ b/.mokogitea/workflows/cleanup.yml @@ -4,8 +4,8 @@ # # FILE INFORMATION # DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Maintenance -# REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoStandards +# INGROUP: moko-platform.Maintenance +# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform # PATH: /.gitea/workflows/cleanup.yml # VERSION: 01.00.00 # BRIEF: Scheduled cleanup — delete merged branches and old workflow runs @@ -33,17 +33,17 @@ jobs: uses: actions/checkout@v4 with: fetch-depth: 0 - token: ${{ secrets.GA_TOKEN }} + token: ${{ secrets.MOKOGITEA_TOKEN }} - name: Delete merged branches env: - GA_TOKEN: ${{ secrets.GA_TOKEN }} + GA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} run: | echo "=== Merged Branch Cleanup ===" API="${GITEA_URL}/api/v1/repos/${{ github.repository }}" # List branches via API - BRANCHES=$(curl -sS -H "Authorization: token ${GA_TOKEN}" \ + BRANCHES=$(curl -sS -H "Authorization: token ${GITEA_TOKEN}" \ "${API}/branches?limit=50" | jq -r '.[].name') DELETED=0 @@ -56,7 +56,7 @@ jobs: # Check if branch is merged into main if git merge-base --is-ancestor "origin/${BRANCH}" origin/main 2>/dev/null; then echo " Deleting merged branch: ${BRANCH}" - curl -sS -X DELETE -H "Authorization: token ${GA_TOKEN}" \ + curl -sS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \ "${API}/branches/${BRANCH}" 2>/dev/null || true DELETED=$((DELETED + 1)) fi @@ -66,20 +66,20 @@ jobs: - name: Clean old workflow runs env: - GA_TOKEN: ${{ secrets.GA_TOKEN }} + GA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} run: | echo "=== Workflow Run Cleanup ===" API="${GITEA_URL}/api/v1/repos/${{ github.repository }}" CUTOFF=$(date -d "30 days ago" +%Y-%m-%dT%H:%M:%SZ 2>/dev/null || date -v-30d +%Y-%m-%dT%H:%M:%SZ) # Get old completed runs - RUNS=$(curl -sS -H "Authorization: token ${GA_TOKEN}" \ + RUNS=$(curl -sS -H "Authorization: token ${GITEA_TOKEN}" \ "${API}/actions/runs?status=completed&limit=50" | \ jq -r ".workflow_runs[] | select(.created_at < \"${CUTOFF}\") | .id" 2>/dev/null) DELETED=0 for RUN_ID in $RUNS; do - curl -sS -X DELETE -H "Authorization: token ${GA_TOKEN}" \ + curl -sS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \ "${API}/actions/runs/${RUN_ID}" 2>/dev/null || true DELETED=$((DELETED + 1)) done diff --git a/.mokogitea/workflows/gitleaks.yml b/.mokogitea/workflows/gitleaks.yml index 0c07612..e0fdd1d 100644 --- a/.mokogitea/workflows/gitleaks.yml +++ b/.mokogitea/workflows/gitleaks.yml @@ -4,8 +4,8 @@ # # FILE INFORMATION # DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Security -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/MokoStandards-API +# INGROUP: moko-platform.Security +# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/moko-platform # PATH: /templates/workflows/gitleaks.yml.template # VERSION: 01.00.00 # BRIEF: Secret scanning — detect leaked credentials, API keys, and tokens diff --git a/.mokogitea/workflows/notify.yml b/.mokogitea/workflows/notify.yml index 463a900..cde4541 100644 --- a/.mokogitea/workflows/notify.yml +++ b/.mokogitea/workflows/notify.yml @@ -4,8 +4,8 @@ # # FILE INFORMATION # DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Notifications -# REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoStandards +# INGROUP: moko-platform.Notifications +# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform # PATH: /.gitea/workflows/notify.yml # VERSION: 01.00.00 # BRIEF: Push notifications via ntfy on release success or workflow failure @@ -18,7 +18,6 @@ on: - "Joomla Build & Release" - "Joomla Extension CI" - "Deploy" - - "Cascade Main → Dev" types: - completed diff --git a/.mokogitea/workflows/pr-check.yml b/.mokogitea/workflows/pr-check.yml index 014f6b0..4d78d7a 100644 --- a/.mokogitea/workflows/pr-check.yml +++ b/.mokogitea/workflows/pr-check.yml @@ -1,194 +1,508 @@ -# Copyright (C) 2026 Moko Consulting -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.CI -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/MokoStandards-API -# PATH: /templates/workflows/universal/pr-check.yml.template -# VERSION: 05.00.00 -# BRIEF: PR gate — branch policy + code validation before merge - -name: "Universal: PR Check" - -on: - pull_request: - types: [opened, synchronize, reopened, edited] - -permissions: - contents: read - pull-requests: write - -env: - FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true - -jobs: - # ── Branch Policy ────────────────────────────────────────────────────── - branch-policy: - name: Branch Policy - runs-on: ubuntu-latest - steps: - - name: Check branch merge target - run: | - HEAD="${{ github.head_ref }}" - BASE="${{ github.base_ref }}" - - echo "PR: ${HEAD} → ${BASE}" - - ALLOWED=true - REASON="" - - case "$HEAD" in - feature/*|feat/*) - if [ "$BASE" != "dev" ]; then - ALLOWED=false - REASON="Feature branches must target 'dev', not '${BASE}'" - fi - ;; - fix/*|bugfix/*) - if [ "$BASE" != "dev" ]; then - ALLOWED=false - REASON="Fix branches must target 'dev', not '${BASE}'" - fi - ;; - hotfix/*) - if [ "$BASE" != "dev" ] && [ "$BASE" != "main" ]; then - ALLOWED=false - REASON="Hotfix branches can only target 'dev' or 'main', not '${BASE}'" - fi - ;; - alpha/*|beta/*) - if [ "$BASE" != "dev" ]; then - ALLOWED=false - REASON="Pre-release branches must target 'dev', not '${BASE}'" - fi - ;; - rc/*) - if [ "$BASE" != "main" ]; then - ALLOWED=false - REASON="Release candidate branches must target 'main', not '${BASE}'" - fi - ;; - dev) - if [ "$BASE" != "main" ]; then - ALLOWED=false - REASON="Dev branch can only merge into 'main', not '${BASE}'" - fi - ;; - esac - - if [ "$ALLOWED" = false ]; then - echo "::error::${REASON}" - echo "## Branch Policy Violation" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "${REASON}" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "### Allowed merge paths:" >> $GITHUB_STEP_SUMMARY - echo "- \`feature/*\` → \`dev\`" >> $GITHUB_STEP_SUMMARY - echo "- \`fix/*\` → \`dev\`" >> $GITHUB_STEP_SUMMARY - echo "- \`hotfix/*\` → \`dev\` or \`main\`" >> $GITHUB_STEP_SUMMARY - echo "- \`dev\` → \`main\`" >> $GITHUB_STEP_SUMMARY - echo "- \`rc/*\` → \`main\`" >> $GITHUB_STEP_SUMMARY - exit 1 - fi - - echo "Branch policy: OK (${HEAD} → ${BASE})" - echo "## Branch Policy: Passed" >> $GITHUB_STEP_SUMMARY - - # ── Code Validation ──────────────────────────────────────────────────── - validate: - name: Validate PR - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Detect platform - id: platform - run: | - PLATFORM=$(cat .mokogitea/.moko-platform 2>/dev/null | tr -d '[:space:]') - [ -z "$PLATFORM" ] && PLATFORM="generic" - echo "platform=$PLATFORM" >> "$GITHUB_OUTPUT" - - - name: Setup PHP - if: steps.platform.outputs.platform == 'joomla' || steps.platform.outputs.platform == 'dolibarr' - run: | - if ! command -v php &> /dev/null; then - sudo apt-get update -qq - sudo apt-get install -y -qq php-cli php-mbstring php-xml >/dev/null 2>&1 - fi - - - name: PHP syntax check - if: steps.platform.outputs.platform == 'joomla' || steps.platform.outputs.platform == 'dolibarr' - run: | - ERRORS=0 - while IFS= read -r -d '' file; do - if ! php -l "$file" 2>&1 | grep -q "No syntax errors"; then - ERRORS=$((ERRORS + 1)) - fi - done < <(find . -name "*.php" -not -path "./.git/*" -not -path "./vendor/*" -print0) - echo "PHP lint: ${ERRORS} error(s)" - [ "$ERRORS" -eq 0 ] || { echo "::error::PHP syntax errors found"; exit 1; } - - - name: Validate platform manifest - run: | - PLATFORM="${{ steps.platform.outputs.platform }}" - case "$PLATFORM" in - joomla) - MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" -exec grep -l '/dev/null | head -1) - if [ -z "$MANIFEST" ]; then - echo "::warning::No Joomla manifest found (WaaS site)" - exit 0 - fi - echo "Manifest: ${MANIFEST}" - if command -v php &> /dev/null; then - php -r "libxml_use_internal_errors(true); \$x = simplexml_load_file('$MANIFEST'); if(!\$x){foreach(libxml_get_errors() as \$e) echo \$e->message; exit(1);}" || { echo "::error::Manifest XML is malformed"; exit 1; } - fi - for ELEMENT in name version description; do - grep -q "<${ELEMENT}>" "$MANIFEST" || { echo "::error::Missing <${ELEMENT}> in manifest"; exit 1; } - done - echo "Joomla manifest valid" - ;; - dolibarr) - MOD_FILE=$(find . -maxdepth 4 -name "mod*.class.php" ! -path "./.git/*" -exec grep -l 'extends DolibarrModules' {} \; 2>/dev/null | head -1) - if [ -z "$MOD_FILE" ]; then - echo "::error::No mod*.class.php found" - exit 1 - fi - echo "Dolibarr module: ${MOD_FILE}" - ;; - *) - echo "Generic platform — no manifest validation" - ;; - esac - - - name: Check update stream format - run: | - PLATFORM="${{ steps.platform.outputs.platform }}" - case "$PLATFORM" in - joomla) - if [ -f "updates.xml" ]; then - if command -v php &> /dev/null; then - php -r "libxml_use_internal_errors(true); \$x = simplexml_load_file('updates.xml'); if(!\$x){foreach(libxml_get_errors() as \$e) echo \$e->message; exit(1);}" || { echo "::error::updates.xml is malformed"; exit 1; } - fi - echo "updates.xml valid" - fi - ;; - dolibarr) - [ -f "update.txt" ] && echo "update.txt present" || echo "::warning::No update.txt" - ;; - esac - - - name: Verify package source - run: | - SOURCE_DIR="src" - [ ! -d "$SOURCE_DIR" ] && SOURCE_DIR="htdocs" - if [ ! -d "$SOURCE_DIR" ]; then - echo "::warning::No src/ or htdocs/ directory" - exit 0 - fi - FILE_COUNT=$(find "$SOURCE_DIR" -type f | wc -l) - echo "Source: ${FILE_COUNT} files" - [ "$FILE_COUNT" -gt 0 ] || { echo "::error::Source directory is empty"; exit 1; } +# Copyright (C) 2026 Moko Consulting +# +# SPDX-License-Identifier: GPL-3.0-or-later +# +# FILE INFORMATION +# DEFGROUP: Gitea.Workflow +# INGROUP: moko-platform.CI +# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/moko-platform +# PATH: /templates/workflows/universal/pr-check.yml.template +# VERSION: 09.23.00 +# BRIEF: PR gate — branch policy + code validation before merge + +name: "Universal: PR Check" + +on: + pull_request: + types: [opened, synchronize, reopened, edited] + +permissions: + contents: read + pull-requests: write + +env: + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true + +jobs: + # ── Branch Policy ────────────────────────────────────────────────────── + branch-policy: + name: Branch Policy + runs-on: ubuntu-latest + steps: + - name: Check branch merge target + run: | + HEAD="${{ github.head_ref }}" + BASE="${{ github.base_ref }}" + + echo "PR: ${HEAD} → ${BASE}" + + ALLOWED=true + REASON="" + + case "$HEAD" in + feature/*|feat/*) + if [ "$BASE" != "dev" ]; then + ALLOWED=false + REASON="Feature branches must target 'dev', not '${BASE}'" + fi + ;; + fix/*|bugfix/*) + if [ "$BASE" != "dev" ]; then + ALLOWED=false + REASON="Fix branches must target 'dev', not '${BASE}'" + fi + ;; + patch/*) + if [ "$BASE" != "dev" ] && [ "$BASE" != "rc" ]; then + ALLOWED=false + REASON="Patch branches must target 'dev' or 'rc', not '${BASE}'" + fi + ;; + hotfix/*) + if [ "$BASE" != "dev" ] && [ "$BASE" != "main" ]; then + ALLOWED=false + REASON="Hotfix branches can only target 'dev' or 'main', not '${BASE}'" + fi + ;; + rc) + if [ "$BASE" != "main" ]; then + ALLOWED=false + REASON="RC branch can only merge into 'main', not '${BASE}'" + fi + ;; + dev) + if [ "$BASE" != "main" ]; then + ALLOWED=false + REASON="Dev branch can only merge into 'main', not '${BASE}'" + fi + ;; + esac + + if [ "$ALLOWED" = false ]; then + echo "::error::${REASON}" + echo "## Branch Policy Violation" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "${REASON}" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "### Allowed merge paths:" >> $GITHUB_STEP_SUMMARY + echo "- \`feature/*\` → \`dev\`" >> $GITHUB_STEP_SUMMARY + echo "- \`fix/*\` → \`dev\`" >> $GITHUB_STEP_SUMMARY + echo "- \`hotfix/*\` → \`dev\` or \`main\`" >> $GITHUB_STEP_SUMMARY + echo "- \`dev\` → \`main\`" >> $GITHUB_STEP_SUMMARY + echo "- \`rc/*\` → \`main\`" >> $GITHUB_STEP_SUMMARY + exit 1 + fi + + echo "Branch policy: OK (${HEAD} → ${BASE})" + echo "## Branch Policy: Passed" >> $GITHUB_STEP_SUMMARY + + # ── Code Validation ──────────────────────────────────────────────────── + validate: + name: Validate PR + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Check for merge conflict markers + run: | + CONFLICTS=$(grep -rn '<<<<<<< \|>>>>>>> \|^=======$' --include='*.php' --include='*.xml' --include='*.css' --include='*.js' --include='*.json' --include='*.md' --include='*.yml' --include='*.yaml' --include='*.ini' --include='*.txt' . 2>/dev/null | grep -v '.git/' || true) + if [ -n "$CONFLICTS" ]; then + echo "::error::Merge conflict markers found in source files" + echo "## Conflict Markers Found" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + echo "$CONFLICTS" >> $GITHUB_STEP_SUMMARY + echo '```' >> $GITHUB_STEP_SUMMARY + exit 1 + fi + echo "No conflict markers found" + + - name: Detect platform + id: platform + run: | + # Read platform from XML manifest ( tag) or plain text fallback + PLATFORM=$(sed -n 's/.*\([^<]*\)<\/platform>.*/\1/p' .mokogitea/manifest.xml 2>/dev/null | head -1) + [ -z "$PLATFORM" ] && PLATFORM=$(cat .mokogitea/manifest.xml 2>/dev/null | tr -d '[:space:]') + [ -z "$PLATFORM" ] && PLATFORM="generic" + echo "platform=$PLATFORM" >> "$GITHUB_OUTPUT" + + - name: Setup PHP + if: steps.platform.outputs.platform == 'joomla' || steps.platform.outputs.platform == 'dolibarr' + run: | + if ! command -v php &> /dev/null; then + sudo apt-get update -qq + sudo apt-get install -y -qq php-cli php-mbstring php-xml >/dev/null 2>&1 + fi + + - name: PHP syntax check + if: steps.platform.outputs.platform == 'joomla' || steps.platform.outputs.platform == 'dolibarr' + run: | + ERRORS=0 + while IFS= read -r -d '' file; do + if ! php -l "$file" 2>&1 | grep -q "No syntax errors"; then + ERRORS=$((ERRORS + 1)) + fi + done < <(find . -name "*.php" -not -path "./.git/*" -not -path "./vendor/*" -print0) + echo "PHP lint: ${ERRORS} error(s)" + [ "$ERRORS" -eq 0 ] || { echo "::error::PHP syntax errors found"; exit 1; } + + - name: Joomla JEXEC guard check + if: steps.platform.outputs.platform == 'joomla' + run: | + ERRORS=0 + while IFS= read -r -d '' file; do + # Skip vendor, node_modules, and index.html stub files + case "$file" in ./vendor/*|./node_modules/*) continue ;; esac + # Check first 10 lines for JEXEC or JPATH guard + if ! head -20 "$file" | grep -qE "defined\s*\(\s*['\"](_JEXEC|JPATH_BASE|\\\\JPATH_PLATFORM)['\"]"; then + echo "::error file=${file}::Missing JEXEC guard: ${file}" + ERRORS=$((ERRORS + 1)) + fi + done < <(find . -name "*.php" -path "*/src/*" -not -path "./.git/*" -not -path "./vendor/*" -print0) + if [ "$ERRORS" -gt 0 ]; then + echo "::error::${ERRORS} PHP file(s) missing defined('_JEXEC') or die guard" + echo "## JEXEC Guard Check: Failed" >> $GITHUB_STEP_SUMMARY + echo "${ERRORS} file(s) in src/ are missing the Joomla execution guard." >> $GITHUB_STEP_SUMMARY + exit 1 + fi + echo "JEXEC guard: OK" + + - name: Joomla directory listing protection + if: steps.platform.outputs.platform == 'joomla' + run: | + MISSING=0 + SOURCE_DIR="src" + [ ! -d "$SOURCE_DIR" ] && exit 0 + while IFS= read -r dir; do + if [ ! -f "${dir}/index.html" ]; then + echo "::warning::Missing index.html in ${dir} (directory listing protection)" + MISSING=$((MISSING + 1)) + fi + done < <(find "$SOURCE_DIR" -type d -not -path "./.git/*" -not -path "*/vendor/*" -not -path "*/node_modules/*") + if [ "$MISSING" -gt 0 ]; then + echo "## Directory Protection" >> $GITHUB_STEP_SUMMARY + echo "${MISSING} director(ies) missing index.html" >> $GITHUB_STEP_SUMMARY + fi + echo "Directory protection: ${MISSING} missing (advisory)" + + - name: Joomla script file and asset checks + if: steps.platform.outputs.platform == 'joomla' + run: | + ERRORS=0 + MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" -exec grep -l '/dev/null | head -1) + [ -z "$MANIFEST" ] && exit 0 + MANIFEST_DIR=$(dirname "$MANIFEST") + + # Check scriptfile exists if declared + SCRIPTFILE=$(sed -n 's/.*\([^<]*\)<\/scriptfile>.*/\1/p' "$MANIFEST" 2>/dev/null) + if [ -n "$SCRIPTFILE" ]; then + if [ ! -f "${MANIFEST_DIR}/${SCRIPTFILE}" ]; then + echo "::error::Manifest declares ${SCRIPTFILE} but file not found at ${MANIFEST_DIR}/${SCRIPTFILE}" + ERRORS=$((ERRORS + 1)) + else + echo "Script file: ${MANIFEST_DIR}/${SCRIPTFILE} (OK)" + fi + fi + + # Require joomla.asset.json and validate it + ASSET_JSON=$(find "$MANIFEST_DIR" -name "joomla.asset.json" -not -path "./.git/*" 2>/dev/null | head -1) + if [ -z "$ASSET_JSON" ]; then + echo "::error::joomla.asset.json not found — Joomla asset system is required" + ERRORS=$((ERRORS + 1)) + else + if command -v php &> /dev/null; then + php -r "json_decode(file_get_contents('$ASSET_JSON')); if(json_last_error()!==JSON_ERROR_NONE){echo json_last_error_msg();exit(1);}" 2>&1 || { + echo "::error::joomla.asset.json is not valid JSON" + ERRORS=$((ERRORS + 1)) + } + fi + echo "joomla.asset.json: valid" + fi + + # Validate all XML files in src/ are well-formed + XML_ERRORS=0 + if command -v php &> /dev/null; then + while IFS= read -r -d '' xmlfile; do + if ! php -r "libxml_use_internal_errors(true); \$x = simplexml_load_file('$xmlfile'); if(!\$x){foreach(libxml_get_errors() as \$e) echo trim(\$e->message) . ' in $xmlfile'; exit(1);}" 2>&1; then + XML_ERRORS=$((XML_ERRORS + 1)) + fi + done < <(find "$MANIFEST_DIR" -name "*.xml" -not -path "./.git/*" -print0) + fi + if [ "$XML_ERRORS" -gt 0 ]; then + echo "::error::${XML_ERRORS} XML file(s) are malformed" + ERRORS=$((ERRORS + 1)) + else + echo "XML well-formedness: OK" + fi + + [ "$ERRORS" -gt 0 ] && exit 1 + echo "Joomla asset checks: OK" + + - name: Validate platform manifest + run: | + PLATFORM="${{ steps.platform.outputs.platform }}" + case "$PLATFORM" in + joomla) + MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" -exec grep -l '/dev/null | head -1) + if [ -z "$MANIFEST" ]; then + echo "::warning::No Joomla manifest found (WaaS site)" + exit 0 + fi + echo "Manifest: ${MANIFEST}" + if command -v php &> /dev/null; then + php -r "libxml_use_internal_errors(true); \$x = simplexml_load_file('$MANIFEST'); if(!\$x){foreach(libxml_get_errors() as \$e) echo \$e->message; exit(1);}" || { echo "::error::Manifest XML is malformed"; exit 1; } + fi + for ELEMENT in name version description; do + grep -q "<${ELEMENT}>" "$MANIFEST" || { echo "::error::Missing <${ELEMENT}> in manifest"; exit 1; } + done + # Block legacy raw/branch update server URLs on MokoGitea + RAW_URLS=$(grep -n 'raw/branch' "$MANIFEST" | grep -i 'mokoconsulting\|mokogitea\|git\.mokoconsulting\.tech' || true) + if [ -n "$RAW_URLS" ]; then + echo "::error::Manifest contains legacy raw/branch update server URL on MokoGitea. Use the Gitea Pages URL instead (e.g. /{REPO}/updates.xml not /{REPO}/raw/branch/main/updates.xml)" + echo "$RAW_URLS" + exit 1 + fi + echo "Joomla manifest valid" + ;; + dolibarr) + MOD_FILE=$(find . -maxdepth 4 -name "mod*.class.php" ! -path "./.git/*" -exec grep -l 'extends DolibarrModules' {} \; 2>/dev/null | head -1) + if [ -z "$MOD_FILE" ]; then + echo "::error::No mod*.class.php found" + exit 1 + fi + echo "Dolibarr module: ${MOD_FILE}" + ;; + *) + echo "Generic platform — no manifest validation" + ;; + esac + + - name: Check update stream format + run: | + PLATFORM="${{ steps.platform.outputs.platform }}" + case "$PLATFORM" in + joomla) + if [ -f "updates.xml" ]; then + if command -v php &> /dev/null; then + php -r "libxml_use_internal_errors(true); \$x = simplexml_load_file('updates.xml'); if(!\$x){foreach(libxml_get_errors() as \$e) echo \$e->message; exit(1);}" || { echo "::error::updates.xml is malformed"; exit 1; } + fi + echo "updates.xml valid" + fi + ;; + dolibarr) + [ -f "update.txt" ] && echo "update.txt present" || echo "::warning::No update.txt" + ;; + esac + + - name: Validate Joomla language files + if: steps.platform.outputs.platform == 'joomla' + run: | + ERRORS=0 + WARNINGS=0 + + # Require both en-GB and en-US language directories + LANG_ROOT=$(find . -path "*/language" -type d -not -path "./.git/*" 2>/dev/null | head -1) + if [ -z "$LANG_ROOT" ]; then + echo "No language/ directory found — skipping" + exit 0 + fi + + if [ ! -d "$LANG_ROOT/en-GB" ]; then + echo "::error::Missing en-GB language directory (${LANG_ROOT}/en-GB)" + ERRORS=$((ERRORS + 1)) + fi + if [ ! -d "$LANG_ROOT/en-US" ]; then + echo "::error::Missing en-US language directory (${LANG_ROOT}/en-US)" + ERRORS=$((ERRORS + 1)) + fi + + # Check that en-GB and en-US have matching .ini files + if [ -d "$LANG_ROOT/en-GB" ] && [ -d "$LANG_ROOT/en-US" ]; then + for GB_INI in "$LANG_ROOT/en-GB"/*.ini; do + [ ! -f "$GB_INI" ] && continue + US_INI="$LANG_ROOT/en-US/$(basename "$GB_INI")" + if [ ! -f "$US_INI" ]; then + echo "::error::$(basename "$GB_INI") exists in en-GB but missing from en-US" + ERRORS=$((ERRORS + 1)) + fi + done + for US_INI in "$LANG_ROOT/en-US"/*.ini; do + [ ! -f "$US_INI" ] && continue + GB_INI="$LANG_ROOT/en-GB/$(basename "$US_INI")" + if [ ! -f "$GB_INI" ]; then + echo "::error::$(basename "$US_INI") exists in en-US but missing from en-GB" + ERRORS=$((ERRORS + 1)) + fi + done + fi + + # Find all .ini language files + INI_FILES=$(find . -path "*/language/*/*.ini" -not -path "./.git/*" 2>/dev/null) + if [ -z "$INI_FILES" ]; then + echo "No .ini language files found" + [ "$ERRORS" -gt 0 ] && exit 1 + exit 0 + fi + + echo "Found $(echo "$INI_FILES" | wc -l) language file(s)" + + for FILE in $INI_FILES; do + FNAME=$(basename "$FILE") + LINENUM=0 + SEEN_KEYS="" + + while IFS= read -r line || [ -n "$line" ]; do + LINENUM=$((LINENUM + 1)) + + # Skip empty lines and comments + [ -z "$line" ] && continue + echo "$line" | grep -qE '^\s*;' && continue + echo "$line" | grep -qE '^\s*$' && continue + + # Must match KEY="VALUE" format + if ! echo "$line" | grep -qE '^[A-Z_][A-Z0-9_]*=".*"$'; then + echo "::error file=${FILE},line=${LINENUM}::Malformed line: ${line}" + ERRORS=$((ERRORS + 1)) + continue + fi + + # Extract key and check for duplicates + KEY=$(echo "$line" | sed 's/=.*//') + if echo "$SEEN_KEYS" | grep -qx "$KEY"; then + echo "::error file=${FILE},line=${LINENUM}::Duplicate key: ${KEY}" + ERRORS=$((ERRORS + 1)) + fi + SEEN_KEYS="${SEEN_KEYS} + ${KEY}" + done < "$FILE" + + echo " ${FILE}: checked ${LINENUM} lines" + done + + # Cross-check en-GB vs en-US key consistency + GB_DIR=$(find . -path "*/language/en-GB" -type d -not -path "./.git/*" 2>/dev/null | head -1) + US_DIR=$(find . -path "*/language/en-US" -type d -not -path "./.git/*" 2>/dev/null | head -1) + + if [ -n "$GB_DIR" ] && [ -n "$US_DIR" ]; then + for GB_FILE in "$GB_DIR"/*.ini; do + [ ! -f "$GB_FILE" ] && continue + FNAME=$(basename "$GB_FILE") + US_FILE="$US_DIR/$FNAME" + [ ! -f "$US_FILE" ] && continue + + GB_KEYS=$(grep -oP '^[A-Z_][A-Z0-9_]*(?==)' "$GB_FILE" 2>/dev/null | sort) + US_KEYS=$(grep -oP '^[A-Z_][A-Z0-9_]*(?==)' "$US_FILE" 2>/dev/null | sort) + + # Keys in en-GB but not en-US + MISSING_US=$(comm -23 <(echo "$GB_KEYS") <(echo "$US_KEYS")) + if [ -n "$MISSING_US" ]; then + echo "::warning::Keys in en-GB/$FNAME but missing from en-US/$FNAME:" + echo "$MISSING_US" | while read -r k; do echo " - $k"; done + WARNINGS=$((WARNINGS + 1)) + fi + + # Keys in en-US but not en-GB + MISSING_GB=$(comm -13 <(echo "$GB_KEYS") <(echo "$US_KEYS")) + if [ -n "$MISSING_GB" ]; then + echo "::warning::Keys in en-US/$FNAME but missing from en-GB/$FNAME:" + echo "$MISSING_GB" | while read -r k; do echo " - $k"; done + WARNINGS=$((WARNINGS + 1)) + fi + done + fi + + { + echo "### Language File Validation" + echo "| Metric | Count |" + echo "|---|---|" + echo "| Files checked | $(echo "$INI_FILES" | wc -l) |" + echo "| Errors | ${ERRORS} |" + echo "| Warnings | ${WARNINGS} |" + } >> $GITHUB_STEP_SUMMARY + + if [ "$ERRORS" -gt 0 ]; then + echo "::error::Language validation failed with ${ERRORS} error(s)" + exit 1 + fi + echo "Language files: OK (${WARNINGS} warning(s))" + + - name: Check changelog has unreleased entry + run: | + if [ ! -f "CHANGELOG.md" ]; then + echo "::warning::No CHANGELOG.md found" + exit 0 + fi + # Check for content under [Unreleased] section + if ! grep -q "## \[Unreleased\]" CHANGELOG.md; then + echo "::error::CHANGELOG.md missing [Unreleased] section" + exit 1 + fi + # Check there's at least one entry (Added/Changed/Fixed/Removed) under Unreleased + UNRELEASED_CONTENT=$(sed -n '/## \[Unreleased\]/,/## \[/p' CHANGELOG.md | grep -cE '^\s*-\s' || true) + if [ "$UNRELEASED_CONTENT" -eq 0 ]; then + echo "::error::CHANGELOG.md [Unreleased] section has no entries. Add a changelog entry describing your changes." + echo "## Changelog Check: Failed" >> $GITHUB_STEP_SUMMARY + echo "The \`[Unreleased]\` section in CHANGELOG.md has no entries." >> $GITHUB_STEP_SUMMARY + echo "Add a line like \`- Description of your change\` under a heading (\`### Added\`, \`### Changed\`, \`### Fixed\`, etc.)" >> $GITHUB_STEP_SUMMARY + exit 1 + fi + echo "Changelog: ${UNRELEASED_CONTENT} entry/entries in [Unreleased]" + + - name: Verify package source + run: | + SOURCE_DIR="src" + [ ! -d "$SOURCE_DIR" ] && SOURCE_DIR="htdocs" + if [ ! -d "$SOURCE_DIR" ]; then + echo "::warning::No src/ or htdocs/ directory" + exit 0 + fi + FILE_COUNT=$(find "$SOURCE_DIR" -type f | wc -l) + echo "Source: ${FILE_COUNT} files" + [ "$FILE_COUNT" -gt 0 ] || { echo "::error::Source directory is empty"; exit 1; } + + # ── Pre-Release RC Build ───────────────────────────────────────────────── + pre-release: + name: Build RC Package + runs-on: ubuntu-latest + needs: [branch-policy, validate] + + steps: + - name: Trigger RC pre-release + env: + GA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} + REPO: ${{ github.repository }} + BRANCH: ${{ github.head_ref }} + GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} + run: | + curl -s -X POST "${GITEA_URL}/api/v1/repos/${REPO}/actions/workflows/pre-release.yml/dispatches" -H "Authorization: token ${GITEA_TOKEN}" -H "Content-Type: application/json" -d "{\"ref\":\"${BRANCH}\",\"inputs\":{\"stability\":\"release-candidate\"}}" + echo "### Pre-Release" >> $GITHUB_STEP_SUMMARY + echo "Triggered RC build on branch \`${BRANCH}\`" >> $GITHUB_STEP_SUMMARY + + # ── Issue Reporter ────────────────────────────────────────────────────── + report-issues: + name: Report Issues + runs-on: ubuntu-latest + needs: [branch-policy, validate] + if: >- + always() && + needs.validate.result == 'failure' + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + sparse-checkout: automation/ci-issue-reporter.sh + sparse-checkout-cone-mode: false + + - name: "File issue for PR validation failure" + env: + GITEA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} + GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} + run: | + chmod +x automation/ci-issue-reporter.sh + ./automation/ci-issue-reporter.sh \ + --gate "PR Validation" \ + --workflow "PR Check" \ + --severity error \ + --details "PR validation failed (syntax, manifest, changelog, or source checks). See the CI run for the specific check that failed." diff --git a/.mokogitea/workflows/pre-release.yml b/.mokogitea/workflows/pre-release.yml deleted file mode 100644 index 234a949..0000000 --- a/.mokogitea/workflows/pre-release.yml +++ /dev/null @@ -1,225 +0,0 @@ -# Copyright (C) 2026 Moko Consulting -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: moko-platform.Release -# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform -# PATH: /templates/workflows/universal/pre-release.yml.template -# VERSION: 05.01.00 -# BRIEF: Manual pre-release — builds dev/alpha/beta/rc packages from any branch - -name: "Universal: Pre-Release" - -on: - workflow_dispatch: - inputs: - stability: - description: 'Pre-release channel' - required: true - type: choice - options: - - development - - alpha - - beta - - release-candidate - -permissions: - contents: write - -env: - GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} - GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }} - GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }} - -jobs: - build: - name: "Build Pre-Release (${{ inputs.stability }})" - runs-on: release - - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - token: ${{ secrets.GA_TOKEN }} - - - name: Setup moko-platform tools - env: - MOKO_CLONE_TOKEN: ${{ secrets.GA_TOKEN }} - MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting - COMPOSER_AUTH: '{"github-oauth":{"github.com":"${{ secrets.GH_TOKEN }}"}}' - run: | - if ! command -v composer &> /dev/null; then - sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1 - fi - git clone --depth 1 --branch main --quiet \ - "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/moko-platform.git" \ - /tmp/moko-platform-api - cd /tmp/moko-platform-api - composer install --no-dev --no-interaction --quiet - - - name: Detect platform - id: platform - run: | - PLATFORM=$(sed -n 's/.*\([^<]*\)<\/platform>.*/\1/p' .mokogitea/manifest.xml 2>/dev/null | head -1 | tr -d '[:space:]') - [ -z "$PLATFORM" ] && PLATFORM=$(sed -n 's/.*\([^<]*\)<\/platform>.*/\1/p' .gitea/manifest.xml 2>/dev/null | head -1 | tr -d '[:space:]') - [ -z "$PLATFORM" ] && PLATFORM="generic" - echo "platform=$PLATFORM" >> "$GITHUB_OUTPUT" - - - name: Resolve metadata and bump version - id: meta - run: | - CLI="/tmp/moko-platform-api/cli" - STABILITY="${{ inputs.stability }}" - - case "$STABILITY" in - development) SUFFIX="-dev"; TAG="development" ;; - alpha) SUFFIX="-alpha"; TAG="alpha" ;; - beta) SUFFIX="-beta"; TAG="beta" ;; - release-candidate) SUFFIX="-rc"; TAG="release-candidate" ;; - esac - - # Bump patch version via CLI - CURRENT=$(php $CLI/version_read.php --path . 2>/dev/null) - [ -z "$CURRENT" ] && CURRENT="00.00.00" - php $CLI/version_bump.php --path . - VERSION=$(php $CLI/version_read.php --path . 2>/dev/null) - echo "Bumping: ${CURRENT} → ${VERSION} (patch)" - - # Set platform-specific version with stability suffix - php $CLI/version_set_platform.php \ - --path . --version "$VERSION" --stability "$STABILITY" --branch "${{ github.ref_name }}" - - # Commit version bump - 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 - git diff --cached --quiet || { - git commit -m "chore(version): bump ${CURRENT} → ${VERSION}${SUFFIX} [skip ci]" - git push origin HEAD 2>&1 - } - - echo "version=${VERSION}" >> "$GITHUB_OUTPUT" - echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT" - echo "suffix=${SUFFIX}" >> "$GITHUB_OUTPUT" - echo "tag=${TAG}" >> "$GITHUB_OUTPUT" - - - name: Build package - id: package - run: | - CLI="/tmp/moko-platform-api/cli" - VERSION="${{ steps.meta.outputs.version }}" - SUFFIX="${{ steps.meta.outputs.suffix }}" - - # Build ZIP + tar.gz via CLI (handles type prefix, excludes, multi-extension packages) - php $CLI/package_build.php \ - --path . \ - --version "${VERSION}${SUFFIX}" \ - --output-dir build \ - --github-output - - - name: Create release and upload - run: | - CLI="/tmp/moko-platform-api/cli" - VERSION="${{ steps.meta.outputs.version }}" - SUFFIX="${{ steps.meta.outputs.suffix }}" - TAG="${{ steps.meta.outputs.tag }}" - STABILITY="${{ steps.meta.outputs.stability }}" - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - EXT_ELEMENT="${{ steps.package.outputs.ext_element }}" - [ -z "$EXT_ELEMENT" ] && EXT_ELEMENT=$(echo "${GITEA_REPO}" | tr '[:upper:]' '[:lower:]' | tr -d ' -') - - SHA256="${{ steps.package.outputs.sha256_zip }}" - ZIP_PATH="${{ steps.package.outputs.zip_path }}" - TAR_PATH="${{ steps.package.outputs.tar_path }}" - - # Create release - php $CLI/release_manage.php \ - --action create \ - --tag "$TAG" \ - --name "${EXT_ELEMENT} ${VERSION}${SUFFIX} (${STABILITY})" \ - --body "## ${VERSION}${SUFFIX} ($(date +%Y-%m-%d))\n**Channel:** ${STABILITY}\n**SHA-256:** \`${SHA256}\`" \ - --target "${{ github.ref_name }}" \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "$API_BASE" - - # Upload assets - FILES="${ZIP_PATH}" - [ -f "$TAR_PATH" ] && FILES="${FILES},${TAR_PATH}" - php $CLI/release_manage.php \ - --action upload \ - --tag "$TAG" \ - --files "$FILES" \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "$API_BASE" - - - name: Update updates.xml - if: steps.platform.outputs.platform == 'joomla' - run: | - CLI="/tmp/moko-platform-api/cli" - VERSION="${{ steps.meta.outputs.version }}" - STABILITY="${{ steps.meta.outputs.stability }}" - SHA256="${{ steps.package.outputs.sha256_zip }}" - - # Map stability names - case "$STABILITY" in - release-candidate) CLI_STABILITY="rc" ;; - *) CLI_STABILITY="$STABILITY" ;; - esac - - # Generate updates.xml with stability-suffixed versions - php $CLI/updates_xml_build.php \ - --path . \ - --version "$VERSION" \ - --stability "$CLI_STABILITY" \ - --sha "$SHA256" \ - --gitea-url "${GITEA_URL}" \ - --org "${GITEA_ORG}" \ - --repo "${GITEA_REPO}" - - # Commit and push - if ! git diff --quiet updates.xml 2>/dev/null; then - git add updates.xml - git commit -m "chore: update ${STABILITY} channel ${VERSION} [skip ci]" - git push origin HEAD 2>&1 || echo "WARNING: push failed" - fi - - - name: "Sync updates.xml to all branches" - if: steps.platform.outputs.platform == 'joomla' - run: | - CURRENT_BRANCH="${{ github.ref_name }}" - git config --local user.email "gitea-actions[bot]@mokoconsulting.tech" - git config --local user.name "gitea-actions[bot]" - - for BRANCH in main dev; do - [ "$BRANCH" = "$CURRENT_BRANCH" ] && continue - echo "Syncing updates.xml → ${BRANCH}" - git fetch origin "${BRANCH}" 2>/dev/null || continue - git checkout "origin/${BRANCH}" -- . 2>/dev/null || continue - git checkout "${CURRENT_BRANCH}" -- updates.xml - if ! git diff --quiet updates.xml 2>/dev/null; then - git add updates.xml - git commit -m "chore: sync updates.xml from ${CURRENT_BRANCH} [skip ci]" - git push origin HEAD:refs/heads/${BRANCH} 2>&1 || echo "WARNING: push to ${BRANCH} failed" - fi - git checkout "${CURRENT_BRANCH}" 2>/dev/null - done - - - name: "Delete lesser pre-release channels (cascade)" - continue-on-error: true - run: | - STABILITY="${{ steps.meta.outputs.stability }}" - - # Map workflow stability names to CLI names - case "$STABILITY" in - release-candidate) CLI_STABILITY="rc" ;; - *) CLI_STABILITY="$STABILITY" ;; - esac - - php /tmp/moko-platform-api/cli/release_cascade.php \ - --stability "$CLI_STABILITY" \ - --token "${{ secrets.GA_TOKEN }}" \ - --api-base "${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" diff --git a/.mokogitea/workflows/repo-health.yml b/.mokogitea/workflows/repo-health.yml index e5e1c73..8d57aaf 100644 --- a/.mokogitea/workflows/repo-health.yml +++ b/.mokogitea/workflows/repo-health.yml @@ -1,766 +1,711 @@ -# ============================================================================ -# Copyright (C) 2025 Moko Consulting -# -# This file is part of a Moko Consulting project. -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Validation -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/MokoStandards-API -# PATH: /templates/workflows/joomla/repo_health.yml.template -# VERSION: 04.06.00 -# BRIEF: Enforces repository guardrails by validating release configuration, scripts governance, tooling availability, and core repository health artifacts. -# ============================================================================ - -name: "Joomla: Repo Health" - -concurrency: - group: repo-health-${{ github.repository }}-${{ github.ref }} - cancel-in-progress: true - -defaults: - run: - shell: bash - -on: - workflow_dispatch: - inputs: - profile: - description: 'Validation profile: all, release, scripts, or repo' - required: true - default: all - type: choice - options: - - all - - release - - scripts - - repo - pull_request: - push: - -permissions: - contents: read - -env: - # Release policy - Repository Variables Only - RELEASE_REQUIRED_REPO_VARS: RS_FTP_PATH_SUFFIX - RELEASE_OPTIONAL_REPO_VARS: DEV_FTP_SUFFIX - - # Scripts governance policy - SCRIPTS_REQUIRED_DIRS: - SCRIPTS_ALLOWED_DIRS: scripts,scripts/fix,scripts/lib,scripts/release,scripts/run,scripts/validate - - # Repo health policy - REPO_REQUIRED_ARTIFACTS: README.md,LICENSE,CHANGELOG.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,.gitea/workflows/ - REPO_OPTIONAL_FILES: SECURITY.md,GOVERNANCE.md,.editorconfig,.gitattributes,.gitignore,README.md,docs/ - REPO_DISALLOWED_DIRS: - REPO_DISALLOWED_FILES: TODO.md,todo.md - - # Extended checks toggles - EXTENDED_CHECKS: "true" - - # File / directory variables - DOCS_INDEX: docs/docs-index.md - SCRIPT_DIR: scripts - WORKFLOWS_DIR: .gitea/workflows - SHELLCHECK_PATTERN: '*.sh' - SPDX_FILE_GLOBS: '*.sh,*.php,*.js,*.ts,*.css,*.xml,*.yml,*.yaml' - FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true - -jobs: - access_check: - name: Access control - runs-on: ubuntu-latest - timeout-minutes: 10 - permissions: - contents: read - - outputs: - allowed: ${{ steps.perm.outputs.allowed }} - permission: ${{ steps.perm.outputs.permission }} - - steps: - - name: Check actor permission (admin only) - id: perm - env: - TOKEN: ${{ secrets.GA_TOKEN || secrets.GA_TOKEN || github.token }} - REPO: ${{ github.repository }} - ACTOR: ${{ github.actor }} - run: | - set -euo pipefail - ALLOWED=false - PERMISSION=unknown - METHOD="" - - # Hardcoded authorized users — always allowed - case "$ACTOR" in - jmiller|gitea-actions[bot]) - ALLOWED=true - PERMISSION=admin - METHOD="hardcoded allowlist" - ;; - *) - # Detect platform and check permissions via API - API_BASE="${GITHUB_API_URL:-${GITEA_API_URL:-https://api.github.com}}" - RESP=$(curl -sf -H "Authorization: token ${TOKEN}" \ - "${API_BASE}/repos/${REPO}/collaborators/${ACTOR}/permission" 2>/dev/null || echo '{}') - PERMISSION=$(echo "$RESP" | grep -oP '"permission"\s*:\s*"\K[^"]+' || echo "unknown") - if [ "$PERMISSION" = "admin" ] || [ "$PERMISSION" = "maintain" ] || [ "$PERMISSION" = "owner" ]; then - ALLOWED=true - fi - METHOD="collaborator API" - ;; - esac - - echo "permission=${PERMISSION}" >> "$GITHUB_OUTPUT" - echo "allowed=${ALLOWED}" >> "$GITHUB_OUTPUT" - - { - echo "## Access Authorization" - echo "" - echo "| Field | Value |" - echo "|-------|-------|" - echo "| **Actor** | \`${ACTOR}\` |" - echo "| **Repository** | \`${REPO}\` |" - echo "| **Permission** | \`${PERMISSION}\` |" - echo "| **Method** | ${METHOD} |" - echo "| **Authorized** | ${ALLOWED} |" - echo "" - if [ "$ALLOWED" = "true" ]; then - echo "${ACTOR} authorized (${METHOD})" - else - echo "${ACTOR} is NOT authorized. Requires admin or maintain role." - fi - } >> "${GITHUB_STEP_SUMMARY}" - - - name: Deny execution when not permitted - if: ${{ steps.perm.outputs.allowed != 'true' }} - run: | - set -euo pipefail - printf '%s\n' 'ERROR: Access denied. Admin permission required.' >> "${GITHUB_STEP_SUMMARY}" - exit 1 - - release_config: - name: Release configuration - needs: access_check - if: ${{ needs.access_check.outputs.allowed == 'true' }} - runs-on: ubuntu-latest - timeout-minutes: 20 - permissions: - contents: read - - steps: - - name: Checkout - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - fetch-depth: 0 - - - name: Guardrails release vars - env: - PROFILE_RAW: ${{ github.event.inputs.profile }} - RS_FTP_PATH_SUFFIX: ${{ vars.RS_FTP_PATH_SUFFIX }} - DEV_FTP_SUFFIX: ${{ vars.DEV_FTP_SUFFIX }} - run: | - set -euo pipefail - - profile="${PROFILE_RAW:-all}" - case "${profile}" in - all|release|scripts|repo) ;; - *) - printf '%s\n' "ERROR: Unknown profile: ${profile}" >> "${GITHUB_STEP_SUMMARY}" - exit 1 - ;; - esac - - if [ "${profile}" = 'scripts' ] || [ "${profile}" = 'repo' ]; then - { - printf '%s\n' '### Release configuration (Repository Variables)' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' 'Status: SKIPPED' - printf '%s\n' 'Reason: profile excludes release validation' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - exit 0 - fi - - IFS=',' read -r -a required <<< "${RELEASE_REQUIRED_REPO_VARS}" - IFS=',' read -r -a optional <<< "${RELEASE_OPTIONAL_REPO_VARS}" - - missing=() - missing_optional=() - - for k in "${required[@]}"; do - v="${!k:-}" - [ -z "${v}" ] && missing+=("${k}") - done - - for k in "${optional[@]}"; do - v="${!k:-}" - [ -z "${v}" ] && missing_optional+=("${k}") - done - - { - printf '%s\n' '### Release configuration (Repository Variables)' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' '| Variable | Status |' - printf '%s\n' '|---|---|' - printf '%s\n' "| RS_FTP_PATH_SUFFIX | ${RS_FTP_PATH_SUFFIX:-NOT SET} |" - printf '%s\n' "| DEV_FTP_SUFFIX | ${DEV_FTP_SUFFIX:-NOT SET} |" - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - - if [ "${#missing_optional[@]}" -gt 0 ]; then - { - printf '%s\n' '### Missing optional repository variables' - for m in "${missing_optional[@]}"; do printf '%s\n' "- ${m}"; done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - if [ "${#missing[@]}" -gt 0 ]; then - { - printf '%s\n' '### Missing required repository variables' - for m in "${missing[@]}"; do printf '%s\n' "- ${m}"; done - printf '%s\n' 'ERROR: Guardrails failed. Missing required repository variables.' - } >> "${GITHUB_STEP_SUMMARY}" - exit 1 - fi - - { - printf '%s\n' '### Repository variables validation result' - printf '%s\n' 'Status: OK' - printf '%s\n' 'All required repository variables present.' - printf '%s\n' '' - printf '%s\n' '**Note**: Organization secrets (RS_FTP_HOST, RS_FTP_USER, etc.) are validated at deployment time, not in repository health checks.' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - - scripts_governance: - name: Scripts governance - needs: access_check - if: ${{ needs.access_check.outputs.allowed == 'true' }} - runs-on: ubuntu-latest - timeout-minutes: 15 - permissions: - contents: read - - steps: - - name: Checkout - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - fetch-depth: 0 - - - name: Scripts folder checks - env: - PROFILE_RAW: ${{ github.event.inputs.profile }} - run: | - set -euo pipefail - - profile="${PROFILE_RAW:-all}" - case "${profile}" in - all|release|scripts|repo) ;; - *) - printf '%s\n' "ERROR: Unknown profile: ${profile}" >> "${GITHUB_STEP_SUMMARY}" - exit 1 - ;; - esac - - if [ "${profile}" = 'release' ] || [ "${profile}" = 'repo' ]; then - { - printf '%s\n' '### Scripts governance' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' 'Status: SKIPPED' - printf '%s\n' 'Reason: profile excludes scripts governance' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - exit 0 - fi - - if [ ! -d "${SCRIPT_DIR}" ]; then - { - printf '%s\n' '### Scripts governance' - printf '%s\n' 'Status: OK (advisory)' - printf '%s\n' 'scripts/ directory not present. No scripts governance enforced.' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - exit 0 - fi - - IFS=',' read -r -a required_dirs <<< "${SCRIPTS_REQUIRED_DIRS}" - IFS=',' read -r -a allowed_dirs <<< "${SCRIPTS_ALLOWED_DIRS}" - - missing_dirs=() - unapproved_dirs=() - - for d in "${required_dirs[@]}"; do - req="${d%/}" - [ ! -d "${req}" ] && missing_dirs+=("${req}/") - done - - while IFS= read -r d; do - allowed=false - for a in "${allowed_dirs[@]}"; do - a_norm="${a%/}" - [ "${d%/}" = "${a_norm}" ] && allowed=true - done - [ "${allowed}" = false ] && unapproved_dirs+=("${d%/}/") - done < <(find "${SCRIPT_DIR}" -maxdepth 1 -mindepth 1 -type d 2>/dev/null | sed 's#^\./##') - - { - printf '%s\n' '### Scripts governance' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' '| Area | Status | Notes |' - printf '%s\n' '|---|---|---|' - - if [ "${#missing_dirs[@]}" -gt 0 ]; then - printf '%s\n' '| Required directories | Warning | Missing required subfolders |' - else - printf '%s\n' '| Required directories | OK | All required subfolders present |' - fi - - if [ "${#unapproved_dirs[@]}" -gt 0 ]; then - printf '%s\n' '| Directory policy | Warning | Unapproved directories detected |' - else - printf '%s\n' '| Directory policy | OK | No unapproved directories |' - fi - - printf '%s\n' '| Enforcement mode | Advisory | scripts folder is optional |' - printf '\n' - - if [ "${#missing_dirs[@]}" -gt 0 ]; then - printf '%s\n' 'Missing required script directories:' - for m in "${missing_dirs[@]}"; do printf '%s\n' "- ${m}"; done - printf '\n' - else - printf '%s\n' 'Missing required script directories: none.' - printf '\n' - fi - - if [ "${#unapproved_dirs[@]}" -gt 0 ]; then - printf '%s\n' 'Unapproved script directories detected:' - for m in "${unapproved_dirs[@]}"; do printf '%s\n' "- ${m}"; done - printf '\n' - else - printf '%s\n' 'Unapproved script directories detected: none.' - printf '\n' - fi - - printf '%s\n' 'Scripts governance completed in advisory mode.' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - - repo_health: - name: Repository health - needs: access_check - if: ${{ needs.access_check.outputs.allowed == 'true' }} - runs-on: ubuntu-latest - timeout-minutes: 20 - permissions: - contents: read - - steps: - - name: Checkout - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - fetch-depth: 0 - - - name: Repository health checks - env: - PROFILE_RAW: ${{ github.event.inputs.profile }} - run: | - set -euo pipefail - - profile="${PROFILE_RAW:-all}" - case "${profile}" in - all|release|scripts|repo) ;; - *) - printf '%s\n' "ERROR: Unknown profile: ${profile}" >> "${GITHUB_STEP_SUMMARY}" - exit 1 - ;; - esac - - if [ "${profile}" = 'release' ] || [ "${profile}" = 'scripts' ]; then - { - printf '%s\n' '### Repository health' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' 'Status: SKIPPED' - printf '%s\n' 'Reason: profile excludes repository health' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - exit 0 - fi - - # Source directory: src/ or htdocs/ (either is valid) - if [ -d "src" ]; then - SOURCE_DIR="src" - elif [ -d "htdocs" ]; then - SOURCE_DIR="htdocs" - else - missing_required+=("src/ or htdocs/ (source directory required)") - fi - - IFS=',' read -r -a required_artifacts <<< "${REPO_REQUIRED_ARTIFACTS}" - IFS=',' read -r -a optional_files <<< "${REPO_OPTIONAL_FILES}" - IFS=',' read -r -a disallowed_dirs <<< "${REPO_DISALLOWED_DIRS}" - IFS=',' read -r -a disallowed_files <<< "${REPO_DISALLOWED_FILES}" - - missing_required=() - missing_optional=() - - for item in "${required_artifacts[@]}"; do - if printf '%s' "${item}" | grep -q '/$'; then - d="${item%/}" - [ ! -d "${d}" ] && missing_required+=("${item}") - else - [ ! -f "${item}" ] && missing_required+=("${item}") - fi - done - - for f in "${optional_files[@]}"; do - if printf '%s' "${f}" | grep -q '/$'; then - d="${f%/}" - [ ! -d "${d}" ] && missing_optional+=("${f}") - else - [ ! -f "${f}" ] && missing_optional+=("${f}") - fi - done - - for d in "${disallowed_dirs[@]}"; do - d_norm="${d%/}" - [ -d "${d_norm}" ] && missing_required+=("${d_norm}/ (disallowed)") - done - - for f in "${disallowed_files[@]}"; do - [ -f "${f}" ] && missing_required+=("${f} (disallowed)") - done - - git fetch origin --prune - - dev_paths=() - dev_branches=() - - while IFS= read -r b; do - name="${b#origin/}" - if [ "${name}" = 'dev' ]; then - dev_branches+=("${name}") - else - dev_paths+=("${name}") - fi - done < <(git branch -r --list 'origin/dev*' | sed 's/^ *//') - - if [ "${#dev_paths[@]}" -eq 0 ]; then - missing_required+=("dev/* branch (e.g. dev/01.00.00)") - fi - - if [ "${#dev_branches[@]}" -gt 0 ]; then - missing_required+=("invalid branch dev (must be dev/)") - fi - - content_warnings=() - - if [ -f 'CHANGELOG.md' ] && ! grep -Eq '^# Changelog' CHANGELOG.md; then - content_warnings+=("CHANGELOG.md missing '# Changelog' header") - fi - - if [ -f 'CHANGELOG.md' ] && grep -Eq '^[# ]*Unreleased' CHANGELOG.md; then - content_warnings+=("CHANGELOG.md contains Unreleased section (review release readiness)") - fi - - if [ -f 'LICENSE' ] && ! grep -qiE 'GNU GENERAL PUBLIC LICENSE|GPL' LICENSE; then - content_warnings+=("LICENSE does not look like a GPL text") - fi - - if [ -f 'README.md' ] && ! grep -qiE 'moko|Moko' README.md; then - content_warnings+=("README.md missing expected brand keyword") - fi - - export PROFILE_RAW="${profile}" - export MISSING_REQUIRED="$(printf '%s\n' "${missing_required[@]:-}")" - export MISSING_OPTIONAL="$(printf '%s\n' "${missing_optional[@]:-}")" - export CONTENT_WARNINGS="$(printf '%s\n' "${content_warnings[@]:-}")" - - report_json="$(python3 - <<'PY' - import json - import os - - profile = os.environ.get('PROFILE_RAW') or 'all' - - missing_required = os.environ.get('MISSING_REQUIRED', '').splitlines() if os.environ.get('MISSING_REQUIRED') else [] - missing_optional = os.environ.get('MISSING_OPTIONAL', '').splitlines() if os.environ.get('MISSING_OPTIONAL') else [] - content_warnings = os.environ.get('CONTENT_WARNINGS', '').splitlines() if os.environ.get('CONTENT_WARNINGS') else [] - - out = { - 'profile': profile, - 'missing_required': [x for x in missing_required if x], - 'missing_optional': [x for x in missing_optional if x], - 'content_warnings': [x for x in content_warnings if x], - } - - print(json.dumps(out, indent=2)) - PY - )" - - { - printf '%s\n' '### Repository health' - printf '%s\n' "Profile: ${profile}" - printf '%s\n' '| Metric | Value |' - printf '%s\n' '|---|---|' - printf '%s\n' "| Missing required | ${#missing_required[@]} |" - printf '%s\n' "| Missing optional | ${#missing_optional[@]} |" - printf '%s\n' "| Content warnings | ${#content_warnings[@]} |" - printf '\n' - - printf '%s\n' '### Guardrails report (JSON)' - printf '%s\n' '```json' - printf '%s\n' "${report_json}" - printf '%s\n' '```' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - - if [ "${#missing_required[@]}" -gt 0 ]; then - { - printf '%s\n' '### Missing required repo artifacts' - for m in "${missing_required[@]}"; do printf '%s\n' "- ${m}"; done - printf '%s\n' 'ERROR: Guardrails failed. Missing required repository artifacts.' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - exit 1 - fi - - if [ "${#missing_optional[@]}" -gt 0 ]; then - { - printf '%s\n' '### Missing optional repo artifacts' - for m in "${missing_optional[@]}"; do printf '%s\n' "- ${m}"; done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - if [ "${#content_warnings[@]}" -gt 0 ]; then - { - printf '%s\n' '### Repo content warnings' - for m in "${content_warnings[@]}"; do printf '%s\n' "- ${m}"; done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - # -- Joomla-specific checks -- - joomla_findings=() - - MANIFEST="$(find . -maxdepth 2 -name '*.xml' -exec grep -l '/dev/null | head -1 || true)" - if [ -z "${MANIFEST}" ]; then - joomla_findings+=("Joomla XML manifest not found (no *.xml with tag)") - else - if ! grep -qP '' "${MANIFEST}"; then - joomla_findings+=("XML manifest: tag missing") - fi - if ! grep -qP 'type="(component|module|plugin|library|package|template|language)"' "${MANIFEST}"; then - joomla_findings+=("XML manifest: type attribute missing or invalid") - fi - if ! grep -qP '' "${MANIFEST}"; then - joomla_findings+=("XML manifest: tag missing") - fi - if ! grep -qP '' "${MANIFEST}"; then - joomla_findings+=("XML manifest: tag missing") - fi - if ! grep -qP ' missing (required for Joomla 5+)") - fi - fi - - INI_COUNT="$(find . -name '*.ini' -type f 2>/dev/null | wc -l)" - if [ "${INI_COUNT}" -eq 0 ]; then - joomla_findings+=("No .ini language files found") - fi - - if [ ! -f 'updates.xml' ]; then - joomla_findings+=("updates.xml missing in root (required for Joomla update server)") - fi - - INDEX_DIRS=("${SOURCE_DIR}" "${SOURCE_DIR}/admin" "${SOURCE_DIR}/site") - for dir in "${INDEX_DIRS[@]}"; do - if [ -d "${dir}" ] && [ ! -f "${dir}/index.html" ]; then - joomla_findings+=("${dir}/index.html missing (directory listing protection)") - fi - done - - if [ "${#joomla_findings[@]}" -gt 0 ]; then - { - printf '%s\n' '### Joomla extension checks' - printf '%s\n' '| Check | Status |' - printf '%s\n' '|---|---|' - for f in "${joomla_findings[@]}"; do - printf '%s\n' "| ${f} | Warning |" - done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - else - { - printf '%s\n' '### Joomla extension checks' - printf '%s\n' 'All Joomla-specific checks passed.' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - extended_enabled="${EXTENDED_CHECKS:-true}" - extended_findings=() - - if [ "${extended_enabled}" = 'true' ]; then - if [ -f '.github/CODEOWNERS' ] || [ -f 'CODEOWNERS' ] || [ -f 'docs/CODEOWNERS' ]; then - : - else - extended_findings+=("CODEOWNERS not found (.github/CODEOWNERS preferred)") - fi - - if ls "${WORKFLOWS_DIR}"/*.yml >/dev/null 2>&1 || ls "${WORKFLOWS_DIR}"/*.yaml >/dev/null 2>&1; then - bad_refs="$(grep -RIn --include='*.yml' --include='*.yaml' -E '^[[:space:]]*uses:[[:space:]]*[^#]+@(main|master)\b' "${WORKFLOWS_DIR}" 2>/dev/null || true)" - if [ -n "${bad_refs}" ]; then - extended_findings+=("Workflows reference actions @main/@master (pin versions): see log excerpt") - { - printf '%s\n' '### Workflow pinning advisory' - printf '%s\n' 'Found uses: entries pinned to main/master:' - printf '%s\n' '```' - printf '%s\n' "${bad_refs}" - printf '%s\n' '```' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - fi - - if [ -f "${DOCS_INDEX}" ]; then - missing_links="$(python3 - <<'PY' - import os - import re - - idx = os.environ.get('DOCS_INDEX', 'docs/docs-index.md') - base = os.getcwd() - - bad = [] - pat = re.compile(r'\[[^\]]+\]\(([^)]+)\)') - - with open(idx, 'r', encoding='utf-8') as f: - for line in f: - for m in pat.findall(line): - link = m.strip() - if link.startswith('http://') or link.startswith('https://') or link.startswith('#') or link.startswith('mailto:'): - continue - if link.startswith('/'): - rel = link.lstrip('/') - else: - rel = os.path.normpath(os.path.join(os.path.dirname(idx), link)) - rel = rel.split('#', 1)[0] - rel = rel.split('?', 1)[0] - if not rel: - continue - p = os.path.join(base, rel) - if not os.path.exists(p): - bad.append(rel) - - print('\n'.join(sorted(set(bad)))) - PY - )" - if [ -n "${missing_links}" ]; then - extended_findings+=("docs/docs-index.md contains broken relative links") - { - printf '%s\n' '### Docs index link integrity' - printf '%s\n' 'Broken relative links:' - while IFS= read -r l; do [ -n "${l}" ] && printf '%s\n' "- ${l}"; done <<< "${missing_links}" - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - fi - - if [ -d "${SCRIPT_DIR}" ]; then - if ! command -v shellcheck >/dev/null 2>&1; then - sudo apt-get update -qq - sudo apt-get install -y shellcheck >/dev/null - fi - - sc_out='' - while IFS= read -r shf; do - [ -z "${shf}" ] && continue - out_one="$(shellcheck -S warning -x "${shf}" 2>/dev/null || true)" - if [ -n "${out_one}" ]; then - sc_out="${sc_out}${out_one}\n" - fi - done < <(find "${SCRIPT_DIR}" -type f -name "${SHELLCHECK_PATTERN}" 2>/dev/null | sort) - - if [ -n "${sc_out}" ]; then - extended_findings+=("ShellCheck warnings detected (advisory)") - sc_head="$(printf '%s' "${sc_out}" | head -n 200)" - { - printf '%s\n' '### ShellCheck (advisory)' - printf '%s\n' '```' - printf '%s\n' "${sc_head}" - printf '%s\n' '```' - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - fi - - spdx_missing=() - IFS=',' read -r -a spdx_globs <<< "${SPDX_FILE_GLOBS}" - spdx_args=() - for g in "${spdx_globs[@]}"; do spdx_args+=("${g}"); done - - while IFS= read -r f; do - [ -z "${f}" ] && continue - if ! head -n 40 "${f}" | grep -q 'SPDX-License-Identifier:'; then - spdx_missing+=("${f}") - fi - done < <(git ls-files "${spdx_args[@]}" 2>/dev/null || true) - - if [ "${#spdx_missing[@]}" -gt 0 ]; then - extended_findings+=("SPDX header missing in some tracked files (advisory)") - { - printf '%s\n' '### SPDX header advisory' - printf '%s\n' 'Files missing SPDX-License-Identifier (first 40 lines scan):' - for f in "${spdx_missing[@]}"; do printf '%s\n' "- ${f}"; done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - stale_cutoff_days=180 - stale_branches="$(git for-each-ref --format='%(refname:short) %(committerdate:unix)' refs/remotes/origin 2>/dev/null | awk -v now="$(date +%s)" -v days="${stale_cutoff_days}" '{if (now-$2 > days*86400) print $1}' | head -50)" - if [ -n "${stale_branches}" ]; then - extended_findings+=("Stale remote branches detected (advisory)") - { - printf '%s\n' '### Git hygiene advisory' - printf '%s\n' "Branches with last commit older than ${stale_cutoff_days} days (sample up to 50):" - while IFS= read -r b; do [ -n "${b}" ] && printf '%s\n' "- ${b}"; done <<< "${stale_branches}" - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - fi - - { - printf '%s\n' '### Guardrails coverage matrix' - printf '%s\n' '| Domain | Status | Notes |' - printf '%s\n' '|---|---|---|' - printf '%s\n' '| Access control | OK | Admin-only execution gate |' - printf '%s\n' '| Release variables | OK | Repository variables validation |' - printf '%s\n' '| Scripts governance | OK | Directory policy and advisory reporting |' - printf '%s\n' '| Repo required artifacts | OK | Required, optional, disallowed enforcement |' - printf '%s\n' '| Repo content heuristics | OK | Brand, license, changelog structure |' - if [ "${extended_enabled}" = 'true' ]; then - if [ "${#extended_findings[@]}" -gt 0 ]; then - printf '%s\n' '| Extended checks | Warning | See extended findings below |' - else - printf '%s\n' '| Extended checks | OK | No findings |' - fi - else - printf '%s\n' '| Extended checks | SKIPPED | EXTENDED_CHECKS disabled |' - fi - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - - if [ "${extended_enabled}" = 'true' ] && [ "${#extended_findings[@]}" -gt 0 ]; then - { - printf '%s\n' '### Extended findings (advisory)' - for f in "${extended_findings[@]}"; do printf '%s\n' "- ${f}"; done - printf '\n' - } >> "${GITHUB_STEP_SUMMARY}" - fi - - printf '%s\n' 'Repository health guardrails passed.' >> "${GITHUB_STEP_SUMMARY}" +# ============================================================================ +# Copyright (C) 2025 Moko Consulting +# +# This file is part of a Moko Consulting project. +# +# SPDX-License-Identifier: GPL-3.0-or-later +# +# FILE INFORMATION +# DEFGROUP: Gitea.Workflow +# INGROUP: moko-platform.Validation +# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/moko-platform +# PATH: /templates/workflows/joomla/repo_health.yml.template +# VERSION: 09.23.00 +# BRIEF: Enforces repository guardrails by validating scripts governance, tooling availability, and core repository health artifacts. +# ============================================================================ + +name: "Generic: Repo Health" + +defaults: + run: + shell: bash + +on: + workflow_dispatch: + inputs: + profile: + description: 'Validation profile: all, scripts, or repo' + required: true + default: all + type: choice + options: + - all + - scripts + - repo + pull_request: + push: + +permissions: + contents: read + +env: + # Scripts governance policy + SCRIPTS_REQUIRED_DIRS: + SCRIPTS_ALLOWED_DIRS: scripts,scripts/fix,scripts/lib,scripts/release,scripts/run,scripts/validate + + # Repo health policy + REPO_REQUIRED_ARTIFACTS: README.md,LICENSE,CHANGELOG.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,.mokogitea/workflows/ + REPO_OPTIONAL_FILES: SECURITY.md,GOVERNANCE.md,.editorconfig,.gitattributes,.gitignore,README.md,docs/ + REPO_DISALLOWED_DIRS: + REPO_DISALLOWED_FILES: TODO.md,todo.md + + # Extended checks toggles + EXTENDED_CHECKS: "true" + + # File / directory variables + DOCS_INDEX: docs/docs-index.md + SCRIPT_DIR: scripts + WORKFLOWS_DIR: .mokogitea/workflows + SHELLCHECK_PATTERN: '*.sh' + SPDX_FILE_GLOBS: '*.sh,*.php,*.js,*.ts,*.css,*.xml,*.yml,*.yaml' + FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true + +jobs: + access_check: + name: Access control + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + contents: read + + outputs: + allowed: ${{ steps.perm.outputs.allowed }} + permission: ${{ steps.perm.outputs.permission }} + + steps: + - name: Check actor permission (admin only) + id: perm + env: + TOKEN: ${{ secrets.MOKOGITEA_TOKEN || secrets.MOKOGITEA_TOKEN || github.token }} + REPO: ${{ github.repository }} + ACTOR: ${{ github.actor }} + run: | + set -euo pipefail + ALLOWED=false + PERMISSION=unknown + METHOD="" + + # Hardcoded authorized users — always allowed + case "$ACTOR" in + jmiller|gitea-actions[bot]) + ALLOWED=true + PERMISSION=admin + METHOD="hardcoded allowlist" + ;; + *) + # Detect platform and check permissions via API + API_BASE="${GITHUB_API_URL:-${GITEA_API_URL:-https://api.github.com}}" + RESP=$(curl -sf -H "Authorization: token ${TOKEN}" \ + "${API_BASE}/repos/${REPO}/collaborators/${ACTOR}/permission" 2>/dev/null || echo '{}') + PERMISSION=$(echo "$RESP" | grep -oP '"permission"\s*:\s*"\K[^"]+' || echo "unknown") + if [ "$PERMISSION" = "admin" ] || [ "$PERMISSION" = "maintain" ] || [ "$PERMISSION" = "owner" ]; then + ALLOWED=true + fi + METHOD="collaborator API" + ;; + esac + + echo "permission=${PERMISSION}" >> "$GITHUB_OUTPUT" + echo "allowed=${ALLOWED}" >> "$GITHUB_OUTPUT" + + { + echo "## Access Authorization" + echo "" + echo "| Field | Value |" + echo "|-------|-------|" + echo "| **Actor** | \`${ACTOR}\` |" + echo "| **Repository** | \`${REPO}\` |" + echo "| **Permission** | \`${PERMISSION}\` |" + echo "| **Method** | ${METHOD} |" + echo "| **Authorized** | ${ALLOWED} |" + echo "" + if [ "$ALLOWED" = "true" ]; then + echo "${ACTOR} authorized (${METHOD})" + else + echo "${ACTOR} is NOT authorized. Requires admin or maintain role." + fi + } >> "${GITHUB_STEP_SUMMARY}" + + - name: Deny execution when not permitted + if: ${{ steps.perm.outputs.allowed != 'true' }} + run: | + set -euo pipefail + printf '%s\n' 'ERROR: Access denied. Admin permission required.' >> "${GITHUB_STEP_SUMMARY}" + exit 1 + + scripts_governance: + name: Scripts governance + needs: access_check + if: ${{ needs.access_check.outputs.allowed == 'true' }} + runs-on: ubuntu-latest + timeout-minutes: 15 + permissions: + contents: read + + steps: + - name: Checkout + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + with: + fetch-depth: 0 + + - name: Scripts folder checks + env: + PROFILE_RAW: ${{ github.event.inputs.profile }} + run: | + set -euo pipefail + + profile="${PROFILE_RAW:-all}" + case "${profile}" in + all|scripts|repo) ;; + *) + printf '%s\n' "ERROR: Unknown profile: ${profile}" >> "${GITHUB_STEP_SUMMARY}" + exit 1 + ;; + esac + + if [ "${profile}" = 'repo' ]; then + { + printf '%s\n' '### Scripts governance' + printf '%s\n' "Profile: ${profile}" + printf '%s\n' 'Status: SKIPPED' + printf '%s\n' 'Reason: profile excludes scripts governance' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + exit 0 + fi + + if [ ! -d "${SCRIPT_DIR}" ]; then + { + printf '%s\n' '### Scripts governance' + printf '%s\n' 'Status: OK (advisory)' + printf '%s\n' 'scripts/ directory not present. No scripts governance enforced.' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + exit 0 + fi + + if [ -n "${SCRIPTS_REQUIRED_DIRS:-}" ]; then IFS=',' read -r -a required_dirs <<< "${SCRIPTS_REQUIRED_DIRS}"; else required_dirs=(); fi + IFS=',' read -r -a allowed_dirs <<< "${SCRIPTS_ALLOWED_DIRS}" + + missing_dirs=() + unapproved_dirs=() + + for d in "${required_dirs[@]}"; do + req="${d%/}" + [ ! -d "${req}" ] && missing_dirs+=("${req}/") + done + + while IFS= read -r d; do + allowed=false + for a in "${allowed_dirs[@]}"; do + a_norm="${a%/}" + [ "${d%/}" = "${a_norm}" ] && allowed=true + done + [ "${allowed}" = false ] && unapproved_dirs+=("${d%/}/") + done < <(find "${SCRIPT_DIR}" -maxdepth 1 -mindepth 1 -type d 2>/dev/null | sed 's#^\./##') + + { + printf '%s\n' '### Scripts governance' + printf '%s\n' "Profile: ${profile}" + printf '%s\n' '| Area | Status | Notes |' + printf '%s\n' '|---|---|---|' + + if [ "${#missing_dirs[@]}" -gt 0 ]; then + printf '%s\n' '| Required directories | Warning | Missing required subfolders |' + else + printf '%s\n' '| Required directories | OK | All required subfolders present |' + fi + + if [ "${#unapproved_dirs[@]}" -gt 0 ]; then + printf '%s\n' '| Directory policy | Warning | Unapproved directories detected |' + else + printf '%s\n' '| Directory policy | OK | No unapproved directories |' + fi + + printf '%s\n' '| Enforcement mode | Advisory | scripts folder is optional |' + printf '\n' + + if [ "${#missing_dirs[@]}" -gt 0 ]; then + printf '%s\n' 'Missing required script directories:' + for m in "${missing_dirs[@]}"; do printf '%s\n' "- ${m}"; done + printf '\n' + else + printf '%s\n' 'Missing required script directories: none.' + printf '\n' + fi + + if [ "${#unapproved_dirs[@]}" -gt 0 ]; then + printf '%s\n' 'Unapproved script directories detected:' + for m in "${unapproved_dirs[@]}"; do printf '%s\n' "- ${m}"; done + printf '\n' + else + printf '%s\n' 'Unapproved script directories detected: none.' + printf '\n' + fi + + printf '%s\n' 'Scripts governance completed in advisory mode.' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + + repo_health: + name: Repository health + needs: access_check + if: ${{ needs.access_check.outputs.allowed == 'true' }} + runs-on: ubuntu-latest + timeout-minutes: 20 + permissions: + contents: read + + steps: + - name: Checkout + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + with: + fetch-depth: 0 + + - name: Repository health checks + env: + PROFILE_RAW: ${{ github.event.inputs.profile }} + run: | + set -euo pipefail + + profile="${PROFILE_RAW:-all}" + case "${profile}" in + all|scripts|repo) ;; + *) + printf '%s\n' "ERROR: Unknown profile: ${profile}" >> "${GITHUB_STEP_SUMMARY}" + exit 1 + ;; + esac + + if [ "${profile}" = 'scripts' ]; then + { + printf '%s\n' '### Repository health' + printf '%s\n' "Profile: ${profile}" + printf '%s\n' 'Status: SKIPPED' + printf '%s\n' 'Reason: profile excludes repository health' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + exit 0 + fi + + IFS=',' read -r -a required_artifacts <<< "${REPO_REQUIRED_ARTIFACTS}" + IFS=',' read -r -a optional_files <<< "${REPO_OPTIONAL_FILES}" + if [ -n "${REPO_DISALLOWED_DIRS:-}" ]; then IFS=',' read -r -a disallowed_dirs <<< "${REPO_DISALLOWED_DIRS}"; else disallowed_dirs=(); fi + IFS=',' read -r -a disallowed_files <<< "${REPO_DISALLOWED_FILES:-}" + + missing_required=() + missing_optional=() + + # Source directory: src/ or htdocs/ (either is valid for extension repos) + SOURCE_DIR="" + if [ -d "src" ]; then + SOURCE_DIR="src" + elif [ -d "htdocs" ]; then + SOURCE_DIR="htdocs" + elif [ -d "deploy" ] || [ -d "cli" ] || [ -d "monitoring" ]; then + # Platform/tooling repos don't need src/ + SOURCE_DIR="" + else + missing_required+=("src/ or htdocs/ (source directory required)") + fi + + for item in "${required_artifacts[@]}"; do + if printf '%s' "${item}" | grep -q '/$'; then + d="${item%/}" + [ ! -d "${d}" ] && missing_required+=("${item}") + else + [ ! -f "${item}" ] && missing_required+=("${item}") + fi + done + + for f in "${optional_files[@]}"; do + if printf '%s' "${f}" | grep -q '/$'; then + d="${f%/}" + [ ! -d "${d}" ] && missing_optional+=("${f}") + else + [ ! -f "${f}" ] && missing_optional+=("${f}") + fi + done + + for d in "${disallowed_dirs[@]}"; do + d_norm="${d%/}" + [ -d "${d_norm}" ] && missing_required+=("${d_norm}/ (disallowed)") + done + + for f in "${disallowed_files[@]}"; do + [ -f "${f}" ] && missing_required+=("${f} (disallowed)") + done + + git fetch origin --prune + + dev_paths=() + dev_branches=() + + while IFS= read -r b; do + name="${b#origin/}" + if [ "${name}" = 'dev' ]; then + dev_branches+=("${name}") + else + dev_paths+=("${name}") + fi + done < <(git branch -r --list 'origin/dev*' | sed 's/^ *//') + + if [ "${#dev_paths[@]}" -eq 0 ] && [ "${#dev_branches[@]}" -eq 0 ]; then + missing_required+=("dev or dev/* branch") + fi + + content_warnings=() + + if [ -f 'CHANGELOG.md' ] && ! grep -Eq '^# Changelog' CHANGELOG.md; then + content_warnings+=("CHANGELOG.md missing '# Changelog' header") + fi + + if [ -f 'CHANGELOG.md' ] && grep -Eq '^[# ]*Unreleased' CHANGELOG.md; then + content_warnings+=("CHANGELOG.md contains Unreleased section (review release readiness)") + fi + + if [ -f 'LICENSE' ] && ! grep -qiE 'GNU GENERAL PUBLIC LICENSE|GPL' LICENSE; then + content_warnings+=("LICENSE does not look like a GPL text") + fi + + if [ -f 'README.md' ] && ! grep -qiE 'moko|Moko' README.md; then + content_warnings+=("README.md missing expected brand keyword") + fi + + export PROFILE_RAW="${profile}" + export MISSING_REQUIRED="$(printf '%s\n' "${missing_required[@]:-}")" + export MISSING_OPTIONAL="$(printf '%s\n' "${missing_optional[@]:-}")" + export CONTENT_WARNINGS="$(printf '%s\n' "${content_warnings[@]:-}")" + + report_json=$(printf '{"profile":"%s","missing_required":%d,"missing_optional":%d,"content_warnings":%d}' "$profile" "${#missing_required[@]}" "${#missing_optional[@]}" "${#content_warnings[@]}") + + { + printf '%s\n' '### Repository health' + printf '%s\n' "Profile: ${profile}" + printf '%s\n' '| Metric | Value |' + printf '%s\n' '|---|---|' + printf '%s\n' "| Missing required | ${#missing_required[@]} |" + printf '%s\n' "| Missing optional | ${#missing_optional[@]} |" + printf '%s\n' "| Content warnings | ${#content_warnings[@]} |" + printf '\n' + + printf '%s\n' '### Guardrails report (JSON)' + printf '%s\n' '```json' + printf '%s\n' "${report_json}" + printf '%s\n' '```' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + + if [ "${#missing_required[@]}" -gt 0 ]; then + { + printf '%s\n' '### Missing required repo artifacts' + for m in "${missing_required[@]}"; do printf '%s\n' "- ${m}"; done + printf '%s\n' 'ERROR: Guardrails failed. Missing required repository artifacts.' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + exit 1 + fi + + if [ "${#missing_optional[@]}" -gt 0 ]; then + { + printf '%s\n' '### Missing optional repo artifacts' + for m in "${missing_optional[@]}"; do printf '%s\n' "- ${m}"; done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + + if [ "${#content_warnings[@]}" -gt 0 ]; then + { + printf '%s\n' '### Repo content warnings' + for m in "${content_warnings[@]}"; do printf '%s\n' "- ${m}"; done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + + # -- Joomla-specific checks -- + joomla_findings=() + + MANIFEST="$(find . -maxdepth 2 -name '*.xml' -exec grep -l '/dev/null | head -1 || true)" + if [ -z "${MANIFEST}" ]; then + joomla_findings+=("Joomla XML manifest not found (no *.xml with tag)") + else + if ! grep -qP '' "${MANIFEST}"; then + joomla_findings+=("XML manifest: tag missing") + fi + if ! grep -qP 'type="(component|module|plugin|library|package|template|language)"' "${MANIFEST}"; then + joomla_findings+=("XML manifest: type attribute missing or invalid") + fi + if ! grep -qP '' "${MANIFEST}"; then + joomla_findings+=("XML manifest: tag missing") + fi + if ! grep -qP '' "${MANIFEST}"; then + joomla_findings+=("XML manifest: tag missing") + fi + if ! grep -qP ' missing (required for Joomla 5+)") + fi + fi + + INI_COUNT="$(find . -name '*.ini' -type f 2>/dev/null | wc -l)" + if [ "${INI_COUNT}" -eq 0 ]; then + joomla_findings+=("No .ini language files found") + fi + + if [ ! -f 'updates.xml' ]; then + joomla_findings+=("updates.xml missing in root (required for Joomla update server)") + fi + + if [ -n "${SOURCE_DIR}" ]; then + INDEX_DIRS=("${SOURCE_DIR}" "${SOURCE_DIR}/admin" "${SOURCE_DIR}/site") + for dir in "${INDEX_DIRS[@]}"; do + if [ -d "${dir}" ] && [ ! -f "${dir}/index.html" ]; then + joomla_findings+=("${dir}/index.html missing (directory listing protection)") + fi + done + fi + + if [ "${#joomla_findings[@]}" -gt 0 ]; then + { + printf '%s\n' '### Joomla extension checks' + printf '%s\n' '| Check | Status |' + printf '%s\n' '|---|---|' + for f in "${joomla_findings[@]}"; do + printf '%s\n' "| ${f} | Warning |" + done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + else + { + printf '%s\n' '### Joomla extension checks' + printf '%s\n' 'All Joomla-specific checks passed.' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + + extended_enabled="${EXTENDED_CHECKS:-true}" + extended_findings=() + + if [ "${extended_enabled}" = 'true' ]; then + if [ -f '.github/CODEOWNERS' ] || [ -f 'CODEOWNERS' ] || [ -f 'docs/CODEOWNERS' ]; then + : + else + extended_findings+=("CODEOWNERS not found (.github/CODEOWNERS preferred)") + fi + + if ls "${WORKFLOWS_DIR}"/*.yml >/dev/null 2>&1 || ls "${WORKFLOWS_DIR}"/*.yaml >/dev/null 2>&1; then + bad_refs="$(grep -RIn --include='*.yml' --include='*.yaml' -E '^[[:space:]]*uses:[[:space:]]*[^#]+@(main|master)\b' "${WORKFLOWS_DIR}" 2>/dev/null || true)" + if [ -n "${bad_refs}" ]; then + extended_findings+=("Workflows reference actions @main/@master (pin versions): see log excerpt") + { + printf '%s\n' '### Workflow pinning advisory' + printf '%s\n' 'Found uses: entries pinned to main/master:' + printf '%s\n' '```' + printf '%s\n' "${bad_refs}" + printf '%s\n' '```' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + fi + + if [ -f "${DOCS_INDEX}" ]; then + missing_links="" + while IFS= read -r docline; do + for link in $(echo "$docline" | grep -oE '\]\([^)]+\)' | sed 's/\](//' | sed 's/)$//' || true); do + case "$link" in http://*|https://*|"#"*|mailto:*) continue ;; esac + linkpath="${link%%#*}" + linkpath="${linkpath%%\?*}" + [ -z "$linkpath" ] && continue + if [ "${linkpath:0:1}" = "/" ]; then + testpath="${linkpath#/}" + else + testpath="$(dirname "${DOCS_INDEX}")/${linkpath}" + fi + [ ! -e "$testpath" ] && missing_links="${missing_links}${testpath} " + done + done < "${DOCS_INDEX}" + if [ -n "${missing_links}" ]; then + extended_findings+=("docs/docs-index.md contains broken relative links") + { + printf '%s\n' '### Docs index link integrity' + printf '%s\n' 'Broken relative links:' + for bl in ${missing_links}; do + printf '%s\n' "- ${bl}" + done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + fi + + if [ -d "${SCRIPT_DIR}" ]; then + if ! command -v shellcheck >/dev/null 2>&1; then + sudo apt-get update -qq + sudo apt-get install -y shellcheck >/dev/null + fi + + sc_out='' + while IFS= read -r shf; do + [ -z "${shf}" ] && continue + out_one="$(shellcheck -S warning -x "${shf}" 2>/dev/null || true)" + if [ -n "${out_one}" ]; then + sc_out="${sc_out}${out_one}\n" + fi + done < <(find "${SCRIPT_DIR}" -type f -name "${SHELLCHECK_PATTERN}" 2>/dev/null | sort) + + if [ -n "${sc_out}" ]; then + extended_findings+=("ShellCheck warnings detected (advisory)") + sc_head="$(printf '%s' "${sc_out}" | head -n 200)" + { + printf '%s\n' '### ShellCheck (advisory)' + printf '%s\n' '```' + printf '%s\n' "${sc_head}" + printf '%s\n' '```' + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + fi + + spdx_missing=() + IFS=',' read -r -a spdx_globs <<< "${SPDX_FILE_GLOBS}" + spdx_args=() + for g in "${spdx_globs[@]}"; do spdx_args+=("${g}"); done + + while IFS= read -r f; do + [ -z "${f}" ] && continue + if ! head -n 40 "${f}" | grep -q 'SPDX-License-Identifier:'; then + spdx_missing+=("${f}") + fi + done < <(git ls-files "${spdx_args[@]}" 2>/dev/null || true) + + if [ "${#spdx_missing[@]}" -gt 0 ]; then + extended_findings+=("SPDX header missing in some tracked files (advisory)") + { + printf '%s\n' '### SPDX header advisory' + printf '%s\n' 'Files missing SPDX-License-Identifier (first 40 lines scan):' + for f in "${spdx_missing[@]}"; do printf '%s\n' "- ${f}"; done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + + stale_cutoff_days=180 + stale_branches="$(git for-each-ref --format='%(refname:short) %(committerdate:unix)' refs/remotes/origin 2>/dev/null | awk -v now="$(date +%s)" -v days="${stale_cutoff_days}" '{if (now-$2 > days*86400) print $1}' | head -50)" + if [ -n "${stale_branches}" ]; then + extended_findings+=("Stale remote branches detected (advisory)") + { + printf '%s\n' '### Git hygiene advisory' + printf '%s\n' "Branches with last commit older than ${stale_cutoff_days} days (sample up to 50):" + while IFS= read -r b; do [ -n "${b}" ] && printf '%s\n' "- ${b}"; done <<< "${stale_branches}" + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + fi + + { + printf '%s\n' '### Guardrails coverage matrix' + printf '%s\n' '| Domain | Status | Notes |' + printf '%s\n' '|---|---|---|' + printf '%s\n' '| Access control | OK | Admin-only execution gate |' + printf '%s\n' '| Release policy | N/A | Releases handled by MokoGitea |' + printf '%s\n' '| Scripts governance | OK | Directory policy and advisory reporting |' + printf '%s\n' '| Repo required artifacts | OK | Required, optional, disallowed enforcement |' + printf '%s\n' '| Repo content heuristics | OK | Brand, license, changelog structure |' + if [ "${extended_enabled}" = 'true' ]; then + if [ "${#extended_findings[@]}" -gt 0 ]; then + printf '%s\n' '| Extended checks | Warning | See extended findings below |' + else + printf '%s\n' '| Extended checks | OK | No findings |' + fi + else + printf '%s\n' '| Extended checks | SKIPPED | EXTENDED_CHECKS disabled |' + fi + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + + if [ "${extended_enabled}" = 'true' ] && [ "${#extended_findings[@]}" -gt 0 ]; then + { + printf '%s\n' '### Extended findings (advisory)' + for f in "${extended_findings[@]}"; do printf '%s\n' "- ${f}"; done + printf '\n' + } >> "${GITHUB_STEP_SUMMARY}" + fi + + printf '%s\n' 'Repository health guardrails passed.' >> "${GITHUB_STEP_SUMMARY}" + + + site-health: + name: Site Health + runs-on: ubuntu-latest + if: github.event_name == 'workflow_dispatch' + steps: + - uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '8.3' + + - name: Uptime check + if: env.URLS != '' + run: | + echo "$URLS" > /tmp/urls.txt + php monitoring/uptime-probe.php --urls /tmp/urls.txt --timeout 15 || echo "::warning::Some sites are down" + rm -f /tmp/urls.txt + env: + URLS: ${{ vars.MONITORED_URLS }} + + - name: SSL certificate check + if: env.DOMAINS != '' + run: | + echo "$DOMAINS" > /tmp/domains.txt + php monitoring/ssl-check.php --domains /tmp/domains.txt --warn-days 30 || echo "::warning::SSL certificates expiring soon" + rm -f /tmp/domains.txt + env: + DOMAINS: ${{ vars.MONITORED_DOMAINS }} + + - name: Summary + if: always() + run: | + echo "### Site Health" >> $GITHUB_STEP_SUMMARY + echo "Uptime and SSL checks completed." >> $GITHUB_STEP_SUMMARY + + # ═══════════════════════════════════════════════════════════════════════ + # Issue Reporter — file issues for failed gates + # ═══════════════════════════════════════════════════════════════════════ + report-issues: + name: "Report Issues" + runs-on: ubuntu-latest + needs: [access_check, scripts_governance, repo_health] + if: >- + always() && + (needs.scripts_governance.result == 'failure' || + needs.repo_health.result == 'failure') + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + sparse-checkout: automation/ci-issue-reporter.sh + sparse-checkout-cone-mode: false + + - name: "File issues for failed gates" + env: + GITEA_TOKEN: ${{ secrets.MOKOGITEA_TOKEN }} + GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} + run: | + chmod +x automation/ci-issue-reporter.sh + REPORTER="./automation/ci-issue-reporter.sh" + WF="Repo Health" + + report_gate() { + local gate="$1" result="$2" details="$3" + if [ "$result" = "failure" ]; then + "$REPORTER" --gate "$gate" --details "$details" --workflow "$WF" --severity error + fi + } + + report_gate "Scripts Governance" \ + "${{ needs.scripts_governance.result }}" \ + "Scripts directory policy violations detected. Review required and allowed directories." + + report_gate "Repository Health" \ + "${{ needs.repo_health.result }}" \ + "Repository health checks failed — missing required artifacts, disallowed files, or content warnings. Check the CI run summary." diff --git a/.mokogitea/workflows/security-audit.yml b/.mokogitea/workflows/security-audit.yml index 789325a..714d407 100644 --- a/.mokogitea/workflows/security-audit.yml +++ b/.mokogitea/workflows/security-audit.yml @@ -4,8 +4,8 @@ # # FILE INFORMATION # DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Security -# REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoStandards +# INGROUP: moko-platform.Security +# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform # PATH: /.gitea/workflows/security-audit.yml # VERSION: 01.00.00 # BRIEF: Dependency vulnerability scanning for composer and npm packages @@ -80,3 +80,19 @@ jobs: -H "Priority: high" \ -d "Security audit found vulnerabilities. Review dependency updates." \ "${NTFY_URL}/${NTFY_TOPIC}" || true + + + - name: Joomla version audit + if: always() + run: | + if [ -f "monitoring/joomla-version-audit.php" ] && [ -n "$JOOMLA_SITES" ]; then + echo "$JOOMLA_SITES" > /tmp/sites.json + php monitoring/joomla-version-audit.php --sites /tmp/sites.json || true + echo "### Joomla Version Audit" >> $GITHUB_STEP_SUMMARY + rm -f /tmp/sites.json + else + echo "Joomla audit skipped (no script or JOOMLA_SITES_JSON not configured)" + fi + env: + JOOMLA_SITES: ${{ vars.JOOMLA_SITES_JSON }} + diff --git a/.mokogitea/workflows/update-server.yml b/.mokogitea/workflows/update-server.yml deleted file mode 100644 index 6e617f6..0000000 --- a/.mokogitea/workflows/update-server.yml +++ /dev/null @@ -1,464 +0,0 @@ -# Copyright (C) 2026 Moko Consulting -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# FILE INFORMATION -# DEFGROUP: Gitea.Workflow -# INGROUP: MokoStandards.Joomla -# REPO: https://git.mokoconsulting.tech/mokoconsulting-tech/MokoStandards-API -# PATH: /templates/workflows/joomla/update-server.yml.template -# VERSION: 04.06.00 -# BRIEF: Update Joomla update server XML feed with stable/rc/dev entries -# -# Writes updates.xml with multiple entries: -# - stable on push to main (from auto-release) -# - rc on push to rc/** -# - development on push to dev or dev/** -# -# Joomla filters by user's "Minimum Stability" setting. - -name: "Joomla: Update Server" - -on: - push: - branches: - - 'dev' - - 'dev/**' - - 'alpha/**' - - 'beta/**' - - 'rc/**' - paths: - - 'src/**' - - 'htdocs/**' - pull_request: - types: [closed] - branches: - - 'dev' - - 'dev/**' - - 'alpha/**' - - 'beta/**' - - 'rc/**' - paths: - - 'src/**' - - 'htdocs/**' - workflow_dispatch: - inputs: - stability: - description: 'Stability tag' - required: true - default: 'development' - type: choice - options: - - development - - alpha - - beta - - rc - - stable - -env: - FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true - GITEA_URL: ${{ vars.GITEA_URL || 'https://git.mokoconsulting.tech' }} - GITEA_ORG: ${{ vars.GITEA_ORG || github.repository_owner }} - GITEA_REPO: ${{ vars.GITEA_REPO || github.event.repository.name }} - -permissions: - contents: write - -jobs: - update-xml: - name: Update updates.xml - runs-on: release - if: >- - github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch' || github.event_name == 'push' - - steps: - - name: Checkout repository - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - with: - token: ${{ secrets.GA_TOKEN }} - fetch-depth: 0 - - - name: Setup MokoStandards tools - env: - MOKO_CLONE_TOKEN: ${{ secrets.GA_TOKEN }} - MOKO_CLONE_HOST: git.mokoconsulting.tech/MokoConsulting - COMPOSER_AUTH: '{"http-basic":{"git.mokoconsulting.tech":{"username":"token","password":"${{ secrets.GA_TOKEN }}"}}}' - run: | - if ! command -v composer &> /dev/null; then - sudo apt-get update -qq && sudo apt-get install -y -qq php-cli php-mbstring php-xml php-zip php-curl composer >/dev/null 2>&1 - fi - git clone --depth 1 --branch main --quiet \ - "https://x-access-token:${MOKO_CLONE_TOKEN}@${MOKO_CLONE_HOST}/MokoStandards-API.git" \ - /tmp/mokostandards-api 2>/dev/null || true - if [ -d "/tmp/mokostandards-api" ] && [ -f "/tmp/mokostandards-api/composer.json" ]; then - cd /tmp/mokostandards-api && composer install --no-dev --no-interaction --quiet 2>/dev/null || true - fi - - - name: Generate updates.xml entry - id: update - run: | - BRANCH="${{ github.ref_name }}" - REPO="${{ github.repository }}" - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - VERSION=$(php /tmp/mokostandards-api/cli/version_read.php --path . 2>/dev/null || echo "0.0.0") - - # Auto-bump patch on all branches (dev, alpha, beta, rc) - git config --local user.email "gitea-actions[bot]@mokoconsulting.tech" - git config --local user.name "gitea-actions[bot]" - BUMPED=$(php /tmp/mokostandards-api/cli/version_bump.php --path . 2>/dev/null || true) - if [ -n "$BUMPED" ]; then - VERSION=$(php /tmp/mokostandards-api/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] " 2>/dev/null || true - git push 2>/dev/null || true - fi - - # Determine stability from branch or input - if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then - STABILITY="${{ inputs.stability }}" - elif [[ "$BRANCH" == rc/* ]]; then - STABILITY="rc" - elif [[ "$BRANCH" == beta/* ]]; then - STABILITY="beta" - elif [[ "$BRANCH" == alpha/* ]]; then - STABILITY="alpha" - elif [[ "$BRANCH" == dev/* ]] || [[ "$BRANCH" == "dev" ]]; then - STABILITY="development" - else - STABILITY="stable" - fi - - echo "stability=${STABILITY}" >> "$GITHUB_OUTPUT" - - # Parse manifest (portable — no grep -P) - MANIFEST=$(find . -maxdepth 3 -name "*.xml" ! -path "./.git/*" ! -path "./build/*" -exec grep -l '/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>.*/\1/p' "$MANIFEST" | head -1) - EXT_TYPE=$(sed -n 's/.*]*type="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1) - EXT_ELEMENT=$(sed -n 's/.*\([^<]*\)<\/element>.*/\1/p' "$MANIFEST" | head -1) - EXT_CLIENT=$(sed -n 's/.*]*client="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1) - EXT_FOLDER=$(sed -n 's/.*]*group="\([^"]*\)".*/\1/p' "$MANIFEST" | head -1) - EXT_VERSION=$(sed -n 's/.*\([^<]*\)<\/version>.*/\1/p' "$MANIFEST" | head -1) - TARGET_PLATFORM=$(sed -n 's/.*\(\).*/\1/p' "$MANIFEST" | head -1) - PHP_MINIMUM=$(sed -n 's/.*\([^<]*\)<\/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 '' "/") - - CLIENT_TAG="" - [ -n "$EXT_CLIENT" ] && CLIENT_TAG="${EXT_CLIENT}" - [ -z "$CLIENT_TAG" ] && ([ "$EXT_TYPE" = "module" ] || [ "$EXT_TYPE" = "plugin" ]) && CLIENT_TAG="site" - - FOLDER_TAG="" - [ -n "$EXT_FOLDER" ] && [ "$EXT_TYPE" = "plugin" ] && FOLDER_TAG="${EXT_FOLDER}" - - PHP_TAG="" - [ -n "$PHP_MINIMUM" ] && PHP_TAG="${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} \n" - NEW_ENTRY="${NEW_ENTRY} ${EXT_NAME}\n" - NEW_ENTRY="${NEW_ENTRY} ${EXT_NAME} ${STABILITY} build.\n" - NEW_ENTRY="${NEW_ENTRY} ${EXT_ELEMENT}\n" - NEW_ENTRY="${NEW_ENTRY} ${EXT_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}\n" - NEW_ENTRY="${NEW_ENTRY} $(date +%Y-%m-%d)\n" - NEW_ENTRY="${NEW_ENTRY} https://git.mokoconsulting.tech/${GITEA_ORG}/${GITEA_REPO}/releases/tag/${RELEASE_TAG}\n" - NEW_ENTRY="${NEW_ENTRY} \n" - NEW_ENTRY="${NEW_ENTRY} ${DOWNLOAD_URL}\n" - NEW_ENTRY="${NEW_ENTRY} \n" - [ -n "$SHA256" ] && NEW_ENTRY="${NEW_ENTRY} ${SHA256}\n" - NEW_ENTRY="${NEW_ENTRY} ${STABILITY}\n" - NEW_ENTRY="${NEW_ENTRY} Moko Consulting\n" - NEW_ENTRY="${NEW_ENTRY} https://mokoconsulting.tech\n" - NEW_ENTRY="${NEW_ENTRY} \n" - [ -n "$PHP_MINIMUM" ] && NEW_ENTRY="${NEW_ENTRY} ${PHP_MINIMUM}\n" - NEW_ENTRY="${NEW_ENTRY} " - - # -- 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' "" > updates.xml - printf '%s\n' "" >> updates.xml - printf '%s\n' "" >> updates.xml - printf '%s\n' "" >> 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"[^<]*", f"{tag}", new_entry_template) - - # Try to find existing block (handles both single-line and multi-line ) - block_pattern = r"((?:(?!).)*?" + re.escape(tag) + r".*?)" - 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} → {version}") - else: - # Create — insert before - content = content.replace("", "\n" + new_entry.strip() + "\n\n") - print(f" CREATED: {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 - git diff --cached --quiet || { - git commit -m "chore: update updates.xml (${STABILITY}: ${DISPLAY_VERSION}) [skip ci]" \ - --author="gitea-actions[bot] " - git push - } - - # -- Sync updates.xml to main (for non-main branches) ---------------------- - - name: Sync updates.xml to main - if: github.ref_name != 'main' - run: | - API_BASE="${GITEA_URL}/api/v1/repos/${GITEA_ORG}/${GITEA_REPO}" - GA_TOKEN="${{ secrets.GA_TOKEN }}" - - FILE_SHA=$(curl -sf -H "Authorization: token ${GA_TOKEN}" \ - "${API_BASE}/contents/updates.xml?ref=main" | python3 -c "import sys,json; print(json.load(sys.stdin).get('sha',''))" 2>/dev/null || true) - - if [ -n "$FILE_SHA" ] && [ -f "updates.xml" ]; then - CONTENT=$(base64 -w0 updates.xml) - curl -sf -X PUT -H "Authorization: token ${GA_TOKEN}" \ - -H "Content-Type: application/json" \ - "${API_BASE}/contents/updates.xml" \ - -d "$(python3 -c "import json; print(json.dumps({ - 'content': '${CONTENT}', - 'sha': '${FILE_SHA}', - 'message': 'chore: sync updates.xml from ${STABILITY} [skip ci]', - 'branch': 'main' - }))")" > /dev/null 2>&1 \ - && echo "updates.xml synced to main (${STABILITY})" >> $GITHUB_STEP_SUMMARY \ - || echo "WARNING: failed to sync updates.xml to main" >> $GITHUB_STEP_SUMMARY - else - echo "WARNING: could not get updates.xml SHA from main" >> $GITHUB_STEP_SUMMARY - fi - - - name: SFTP deploy to dev server - if: contains(github.ref, 'dev/') || github.ref == 'refs/heads/dev' - env: - DEV_HOST: ${{ vars.DEV_FTP_HOST }} - DEV_PATH: ${{ vars.DEV_FTP_PATH }} - DEV_SUFFIX: ${{ vars.DEV_FTP_SUFFIX }} - DEV_USER: ${{ vars.DEV_FTP_USERNAME }} - DEV_PORT: ${{ vars.DEV_FTP_PORT }} - DEV_KEY: ${{ secrets.DEV_FTP_KEY }} - DEV_PASS: ${{ secrets.DEV_FTP_PASSWORD }} - run: | - # -- 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 }}" \ - "${API_BASE}/collaborators/${ACTOR}/permission" 2>/dev/null | \ - python3 -c "import sys,json; print(json.load(sys.stdin).get('permission','read'))" 2>/dev/null || echo "read") - case "$PERMISSION" in - admin|maintain|write) ;; - *) - echo "Deploy denied: ${ACTOR} has '${PERMISSION}' — requires admin, maintain, or write" - exit 0 - ;; - esac - - [ -z "$DEV_HOST" ] || [ -z "$DEV_PATH" ] && { echo "DEV FTP not configured — skipping SFTP"; exit 0; } - - SOURCE_DIR="src" - [ ! -d "$SOURCE_DIR" ] && SOURCE_DIR="htdocs" - [ ! -d "$SOURCE_DIR" ] && exit 0 - - PORT="${DEV_PORT:-22}" - REMOTE="${DEV_PATH%/}" - [ -n "$DEV_SUFFIX" ] && REMOTE="${REMOTE}/${DEV_SUFFIX#/}" - - printf '{"host":"%s","port":%s,"username":"%s","remotePath":"%s"' \ - "$DEV_HOST" "$PORT" "$DEV_USER" "$REMOTE" > /tmp/sftp-config.json - if [ -n "$DEV_KEY" ]; then - echo "$DEV_KEY" > /tmp/deploy_key && chmod 600 /tmp/deploy_key - printf ',"privateKeyPath":"/tmp/deploy_key"}' >> /tmp/sftp-config.json - else - printf ',"password":"%s"}' "$DEV_PASS" >> /tmp/sftp-config.json - fi - - PLATFORM=$(php /tmp/mokostandards-api/cli/platform_detect.php --path . 2>/dev/null || true) - if [ "$PLATFORM" = "waas-component" ] && [ -f "/tmp/mokostandards-api/deploy/deploy-joomla.php" ]; then - php /tmp/mokostandards-api/deploy/deploy-joomla.php --path . --src-dir "$SOURCE_DIR" --config /tmp/sftp-config.json - elif [ -f "/tmp/mokostandards-api/deploy/deploy-sftp.php" ]; then - php /tmp/mokostandards-api/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: Summary - if: always() - run: | - echo "## Joomla 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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 926a08c..92962d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,24 +1,44 @@ # Changelog - + -All notable changes to MokoOpenGraph will be documented in this file. +All notable changes to MokoJoomOpenGraph will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## [Unreleased] -### Removed -- Removed deploy-manual.yml workflow — switching to Joomla update server method for extension distribution +### Security +- Fix JSON-LD XSS vulnerability via `` injection in content data (#34) +- Add ACL permission checks to Batch and ImportExport controllers (#37) +- Add CSV import file type, MIME type, size, and content_type validation (#35) +- Fix multilingual data corruption in content plugin load/save (#41) ### Added -- Initial package structure with component, system plugin, and content plugin -- Open Graph meta tag injection via system plugin (`onBeforeCompileHead`) -- Twitter/X Card meta tag support (Summary and Summary with Large Image) -- Per-article OG fields in the article editor -- Per-menu-item OG fields in the menu item editor -- Auto-generation of OG tags from article title, description, and images +- Site-wide default OG title and description plugin parameters +- Discord embed color via `theme-color` meta tag (color picker in plugin config) +- LinkedIn article tags: `article:published_time`, `article:modified_time`, `article:author` +- `og:image:width` and `og:image:height` for faster social preview rendering +- `onMokoOGAfterRender` event for third-party plugin extensibility +- Joomla Web Services API for OG tags — full CRUD at `/api/v1/mokoog/tags` (#27) +- Live social preview in article/menu editors (Facebook and Twitter/X card mockups) (#3) +- CSV import/export for bulk OG tag management (#12) +- OG image text overlay generator (#7) +- Multilingual OG tag support with per-language records (#11) +- JSON-LD structured data: Article, WebPage, BreadcrumbList schemas (#6) +- Social platform debugger quick links (Facebook, LinkedIn, Google) (#9) +- Content type adapter architecture for K2, VirtueMart, HikaShop (#5) +- WhatsApp and Telegram link preview optimization (#10) +- Category-level OG tag support (#4) +- Batch OG tag generation for existing articles (#1) +- Auto-resize OG images to 1200x630px with center crop (#2) +- SEO meta tag management: title, description, robots, canonical URL (#8) +- Per-article and per-menu-item OG fields in the editor +- Auto-generation of OG tags from article content, title, and images - Default fallback image configuration -- Admin tag manager component for viewing all OG records -- Facebook App ID support -- Database table `#__mokoog_tags` for storing custom OG data +- Admin tag manager component with filtering, search, and pagination +- Facebook App ID and Telegram channel support +- Database table `#__mokoog_tags` with multilingual unique key + +### Removed +- Removed deploy-manual.yml workflow — using Joomla update server for distribution diff --git a/CLAUDE.md b/CLAUDE.md index 1d6447f..cdaa011 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,7 +4,7 @@ This file provides guidance to Claude Code when working with this repository. ## Project Overview -**MokoOpenGraph** -- Open Graph, Twitter Card, and social sharing meta tag management for Joomla +**MokoJoomOpenGraph** -- Open Graph, Twitter Card, and social sharing meta tag management for Joomla | Field | Value | |---|---| @@ -12,7 +12,7 @@ This file provides guidance to Claude Code when working with this repository. | **Language** | PHP | | **Default branch** | main | | **License** | GPL-3.0-or-later | -| **Wiki** | [MokoOpenGraph Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/wiki) | +| **Wiki** | [MokoJoomOpenGraph Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomOpenGraph/wiki) | | **Standards** | [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home) | ## Common Commands diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2d63a38 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,28 @@ +# Code of Conduct + +## Our Pledge + +We pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community + +Examples of unacceptable behavior: + +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information without explicit permission + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at hello@mokoconsulting.tech. All complaints will be reviewed and investigated. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e566bdf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing to MokoJoomOpenGraph + +Thank you for your interest in contributing to MokoJoomOpenGraph. + +## Getting Started + +1. Fork the repository on Gitea +2. Create a feature branch from `dev` (`feature/your-feature`) +3. Make your changes following the coding standards below +4. Submit a pull request targeting `dev` + +## Branch Strategy + +- `main` — stable releases only +- `dev` — active development +- `feature/*` — new features (target `dev`) +- `fix/*` — bug fixes (target `dev`) +- `hotfix/*` — urgent fixes (target `dev` or `main`) + +## Coding Standards + +- PHP 8.1+ required +- Follow Joomla coding standards +- SPDX license headers on all PHP files +- Use `SubscriberInterface` for event subscription +- Use `bind() -> check() -> store()` for Table operations + +## Reporting Issues + +Report bugs and feature requests via [Issues](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomOpenGraph/issues). + +## License + +By contributing, you agree that your contributions will be licensed under GPL-3.0-or-later. diff --git a/Makefile b/Makefile index 67abb20..43340a6 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ # Copyright (C) 2026 Moko Consulting # SPDX-License-Identifier: GPL-3.0-or-later # -# MokoOpenGraph — Open Graph & social sharing meta tag management +# MokoJoomOpenGraph — Open Graph & social sharing meta tag management # ============================================================================== # CONFIGURATION - Customize these for your extension diff --git a/README.md b/README.md index 89b9bda..b51c8a2 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,69 @@ -# MokoOpenGraph +# MokoJoomOpenGraph - + Open Graph, Twitter Card, and social sharing meta tag management for Joomla 4/5/6. ## Overview -MokoOpenGraph gives you full control over how your Joomla content appears when shared on Facebook, Twitter/X, LinkedIn, WhatsApp, and other social platforms. Set custom titles, descriptions, and images per article and menu item — or let the extension auto-generate them from your existing content. +MokoJoomOpenGraph gives you full control over how your Joomla content appears when shared on Facebook, Twitter/X, LinkedIn, Discord, WhatsApp, Telegram, and other social platforms. Set custom titles, descriptions, and images per article, menu item, and category — or let the extension auto-generate them from your existing content. ## Features -- **Open Graph tags** — `og:title`, `og:description`, `og:image`, `og:url`, `og:type`, `og:site_name` +### Social Meta Tags +- **Open Graph tags** — `og:title`, `og:description`, `og:image`, `og:url`, `og:type`, `og:site_name`, `og:locale` - **Twitter/X Cards** — Summary and Summary with Large Image card types -- **Per-article control** — Custom OG fields in the article editor +- **LinkedIn** — `article:published_time`, `article:modified_time`, `article:author` +- **Discord** — Custom embed color via `theme-color` meta tag +- **Telegram** — `telegram:channel` for link previews +- **Facebook** — `fb:app_id` support, `og:image:width`/`og:image:height` for instant previews + +### Content Management +- **Per-article control** — Custom OG fields tab in the article editor - **Per-menu-item control** — Custom OG fields in the menu item editor -- **Auto-generation** — Automatically builds tags from article content, title, and images -- **Default fallback image** — Site-wide default when no article image exists -- **Admin tag manager** — View and manage all OG records from a central dashboard -- **Facebook App ID** — Optional `fb:app_id` meta tag support -- **Joomla 4/5/6** — Modern DI container architecture, Joomla coding standards +- **Per-category control** — Category-level OG tag overrides +- **Multilingual support** — Per-language OG data with language-aware fallback +- **Auto-generation** — Builds tags from article content, title, and images automatically +- **Site-wide defaults** — Default OG title, description, and image for all pages + +### SEO +- **SEO title override** — Custom `` tag per page +- **Meta description** — Per-page meta description control +- **Robots directive** — Per-page noindex/nofollow settings +- **Canonical URL** — Custom canonical URL overrides +- **JSON-LD structured data** — Article, WebPage, BreadcrumbList, Organization schemas + +### Admin Tools +- **Tag manager dashboard** — View and manage all OG records centrally +- **Batch generation** — Auto-generate OG tags for all existing articles +- **CSV import/export** — Bulk manage OG data via CSV files +- **SEO health badges** — Visual indicators for missing descriptions, long titles, noindex +- **Debug links** — Quick links to Facebook Debugger, LinkedIn Inspector, Google Rich Results +- **Live preview** — Real-time Facebook and Twitter/X card preview in the editor + +### Developer Features +- **REST API** — Full CRUD via Joomla Web Services (`/api/v1/mokoog/tags`) +- **Content type adapters** — Extensible architecture for K2, VirtueMart, HikaShop +- **Plugin event** — `onMokoOGAfterRender` for third-party plugins to add custom social tags +- **OG image generator** — Text overlay on template backgrounds with auto-resize to 1200x630 ## Installation -1. Download the latest `pkg_mokoog-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases) +1. Download the latest `pkg_mokoog-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomOpenGraph/releases) 2. In Joomla Administrator → Extensions → Install → Upload Package File -3. The system plugin is enabled automatically on install +3. All plugins are enabled automatically on install ## Configuration -Navigate to **Extensions → Plugins → System - MokoOpenGraph** to configure: +Navigate to **Extensions → Plugins → System - MokoJoomOpenGraph** to configure: - Site name override +- Default OG title and description (site-wide fallback) - Default fallback image - Twitter Card type and @username - Facebook App ID -- Auto-generation behavior -- Description length limit +- Discord embed color +- Telegram channel +- Auto-generation, image resize, JSON-LD, and description length settings ## License diff --git a/automation/ci-issue-reporter.sh b/automation/ci-issue-reporter.sh new file mode 100644 index 0000000..65c47ba --- /dev/null +++ b/automation/ci-issue-reporter.sh @@ -0,0 +1,237 @@ +#!/usr/bin/env bash +# ============================================================================ +# Copyright (C) 2026 Moko Consulting <hello@mokoconsulting.tech> +# +# SPDX-License-Identifier: GPL-3.0-or-later +# +# FILE INFORMATION +# DEFGROUP: Automation.CI +# INGROUP: moko-platform.Automation +# REPO: https://git.mokoconsulting.tech/MokoConsulting/moko-platform +# PATH: /automation/ci-issue-reporter.sh +# VERSION: 09.23.00 +# BRIEF: Creates or updates a Gitea issue when a CI gate fails. +# Deduplicates by searching open issues with the "ci-auto" label +# whose title matches the gate. If a matching issue exists, a comment +# is appended instead of opening a duplicate. +# ============================================================================ + +set -euo pipefail + +# ── Defaults ──────────────────────────────────────────────────────────────── +GITEA_URL="${GITEA_URL:-https://git.mokoconsulting.tech}" +GITEA_TOKEN="${GITEA_TOKEN:-}" +REPO="${GITHUB_REPOSITORY:-}" +RUN_URL="${GITHUB_SERVER_URL:-${GITEA_URL}}/${REPO}/actions/runs/${GITHUB_RUN_ID:-0}" +LABEL_NAME="ci-auto" +LABEL_COLOR="#e11d48" + +GATE="" +DETAILS="" +SEVERITY="error" +WORKFLOW="" + +# ── Parse arguments ───────────────────────────────────────────────────────── +usage() { + cat <<EOF +Usage: ci-issue-reporter.sh --gate NAME --details TEXT [OPTIONS] + +Required: + --gate CI gate name (e.g. "Code Quality", "Self-Health") + --details Human-readable failure description + +Optional: + --severity "error" (default) or "warning" + --workflow Workflow name for the issue title + --repo owner/repo (default: \$GITHUB_REPOSITORY) + --run-url URL to the CI run (auto-detected from env) + --token Gitea API token (default: \$GITEA_TOKEN) + --url Gitea base URL (default: \$GITEA_URL) +EOF + exit 1 +} + +while [[ $# -gt 0 ]]; do + case "$1" in + --gate) GATE="$2"; shift 2 ;; + --details) DETAILS="$2"; shift 2 ;; + --severity) SEVERITY="$2"; shift 2 ;; + --workflow) WORKFLOW="$2"; shift 2 ;; + --repo) REPO="$2"; shift 2 ;; + --run-url) RUN_URL="$2"; shift 2 ;; + --token) GITEA_TOKEN="$2"; shift 2 ;; + --url) GITEA_URL="$2"; shift 2 ;; + -h|--help) usage ;; + *) echo "Unknown option: $1"; usage ;; + esac +done + +[[ -z "$GATE" ]] && { echo "ERROR: --gate is required"; usage; } +[[ -z "$DETAILS" ]] && { echo "ERROR: --details is required"; usage; } +[[ -z "$GITEA_TOKEN" ]] && { echo "ERROR: GITEA_TOKEN not set"; exit 1; } +[[ -z "$REPO" ]] && { echo "ERROR: GITHUB_REPOSITORY not set"; exit 1; } + +API="${GITEA_URL}/api/v1/repos/${REPO}" + +# ── Build title ───────────────────────────────────────────────────────────── +if [[ -n "$WORKFLOW" ]]; then + TITLE="[CI] ${WORKFLOW}: ${GATE} failed" +else + TITLE="[CI] ${GATE} failed" +fi + +# ── Ensure label exists ───────────────────────────────────────────────────── +ensure_label() { + local exists + exists=$(curl -sf -o /dev/null -w '%{http_code}' \ + -H "Authorization: token ${GITEA_TOKEN}" \ + "${API}/labels" 2>/dev/null || echo "000") + + if [[ "$exists" == "200" ]]; then + # Check if label already exists + local found + found=$(curl -sf \ + -H "Authorization: token ${GITEA_TOKEN}" \ + "${API}/labels" 2>/dev/null \ + | grep -o "\"name\":\"${LABEL_NAME}\"" || true) + + if [[ -z "$found" ]]; then + curl -sf -X POST \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H "Content-Type: application/json" \ + "${API}/labels" \ + -d "{\"name\":\"${LABEL_NAME}\",\"color\":\"${LABEL_COLOR}\",\"description\":\"Auto-created by CI issue reporter\"}" \ + > /dev/null 2>&1 || true + fi + fi +} + +# ── Search for existing open issue ────────────────────────────────────────── +find_existing_issue() { + # URL-encode the gate name for the query + local query + query=$(printf '%s' "[CI] ${GATE}" | sed 's/ /%20/g; s/\[/%5B/g; s/\]/%5D/g') + + local response + response=$(curl -sf \ + -H "Authorization: token ${GITEA_TOKEN}" \ + "${API}/issues?type=issues&state=open&labels=${LABEL_NAME}&q=${query}&limit=5" \ + 2>/dev/null || echo "[]") + + # Extract the first matching issue number + echo "$response" \ + | grep -oP '"number":\s*\K[0-9]+' \ + | head -1 +} + +# ── Build issue body ──────────────────────────────────────────────────────── +build_body() { + local severity_badge + if [[ "$SEVERITY" == "error" ]]; then + severity_badge="**Severity:** Error" + else + severity_badge="**Severity:** Warning" + fi + + cat <<BODY +## CI Gate Failure: ${GATE} + +${severity_badge} +**Workflow:** ${WORKFLOW:-unknown} +**Branch:** ${GITHUB_REF_NAME:-unknown} +**Commit:** \`${GITHUB_SHA:0:8}\` +**Run:** [View CI run](${RUN_URL}) + +### Details + +${DETAILS} + +### Resolution + +Fix the issue described above and push a new commit. This issue will be closed automatically when the gate passes, or can be closed manually. + +--- +*Auto-created by [ci-issue-reporter](${GITEA_URL}/${REPO}/src/branch/main/automation/ci-issue-reporter.sh)* +BODY +} + +# ── Build comment body (for existing issues) ──────────────────────────────── +build_comment() { + cat <<COMMENT +### CI failure recurrence + +**Branch:** ${GITHUB_REF_NAME:-unknown} +**Commit:** \`${GITHUB_SHA:0:8}\` +**Run:** [View CI run](${RUN_URL}) + +${DETAILS} +COMMENT +} + +# ── Main ──────────────────────────────────────────────────────────────────── +ensure_label + +EXISTING=$(find_existing_issue) + +if [[ -n "$EXISTING" ]]; then + # Append comment to existing issue + COMMENT_BODY=$(build_comment) + COMMENT_JSON=$(printf '%s' "$COMMENT_BODY" | python3 -c " +import sys, json +print(json.dumps({'body': sys.stdin.read()}))" 2>/dev/null) + + HTTP=$(curl -sf -o /dev/null -w '%{http_code}' -X POST \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H "Content-Type: application/json" \ + "${API}/issues/${EXISTING}/comments" \ + -d "${COMMENT_JSON}" 2>/dev/null || echo "000") + + if [[ "$HTTP" == "201" ]]; then + echo "Commented on existing issue #${EXISTING}" + else + echo "WARNING: Failed to comment on issue #${EXISTING} (HTTP ${HTTP})" + fi +else + # Create new issue + ISSUE_BODY=$(build_body) + ISSUE_JSON=$(python3 -c " +import sys, json +body = sys.stdin.read() +print(json.dumps({ + 'title': sys.argv[1], + 'body': body, + 'labels': [] +}))" "$TITLE" <<< "$ISSUE_BODY" 2>/dev/null) + + # Create the issue + RESPONSE=$(curl -sf -X POST \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H "Content-Type: application/json" \ + "${API}/issues" \ + -d "${ISSUE_JSON}" 2>/dev/null || echo "{}") + + ISSUE_NUM=$(echo "$RESPONSE" | grep -oP '"number":\s*\K[0-9]+' | head -1) + + if [[ -n "$ISSUE_NUM" ]]; then + # Apply label (separate call — more reliable across Gitea versions) + LABEL_ID=$(curl -sf \ + -H "Authorization: token ${GITEA_TOKEN}" \ + "${API}/labels" 2>/dev/null \ + | grep -oP "\"id\":\s*\K[0-9]+(?=[^}]*\"name\":\s*\"${LABEL_NAME}\")" \ + | head -1 || true) + + if [[ -n "$LABEL_ID" ]]; then + curl -sf -X POST \ + -H "Authorization: token ${GITEA_TOKEN}" \ + -H "Content-Type: application/json" \ + "${API}/issues/${ISSUE_NUM}/labels" \ + -d "{\"labels\":[${LABEL_ID}]}" \ + > /dev/null 2>&1 || true + fi + + echo "Created issue #${ISSUE_NUM}: ${TITLE}" + else + echo "WARNING: Failed to create issue" + echo "Response: ${RESPONSE}" + fi +fi diff --git a/composer.json b/composer.json index 132b2d7..c21717f 100644 --- a/composer.json +++ b/composer.json @@ -17,8 +17,10 @@ "require-dev": { "squizlabs/php_codesniffer": "^3.7", "phpstan/phpstan": "^1.10", - "joomla/coding-standards": "^4.0" + "joomla/coding-standards": "^3.0" }, + "minimum-stability": "alpha", + "prefer-stable": true, "config": { "sort-packages": true } diff --git a/src/index.html b/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/language/en-GB/index.html b/src/language/en-GB/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/language/en-GB/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/language/en-GB/pkg_mokoog.sys.ini b/src/language/en-GB/pkg_mokoog.sys.ini index 76e8e3d..47aa587 100644 --- a/src/language/en-GB/pkg_mokoog.sys.ini +++ b/src/language/en-GB/pkg_mokoog.sys.ini @@ -1,7 +1,7 @@ -; MokoOpenGraph - Package System Language File +; MokoJoomOpenGraph - Package System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PKG_MOKOOG="MokoOpenGraph" +PKG_MOKOOG="MokoJoomOpenGraph" PKG_MOKOOG_DESCRIPTION="Complete Open Graph, Twitter Card, and social sharing meta tag management for Joomla. Control how every page appears when shared on Facebook, Twitter/X, LinkedIn, WhatsApp, and more." -PKG_MOKOOG_PHP_VERSION_ERROR="MokoOpenGraph requires PHP %s or later." +PKG_MOKOOG_PHP_VERSION_ERROR="MokoJoomOpenGraph requires PHP %s or later." diff --git a/src/language/en-US/index.html b/src/language/en-US/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/language/en-US/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/language/en-US/pkg_mokoog.sys.ini b/src/language/en-US/pkg_mokoog.sys.ini index 76e8e3d..47aa587 100644 --- a/src/language/en-US/pkg_mokoog.sys.ini +++ b/src/language/en-US/pkg_mokoog.sys.ini @@ -1,7 +1,7 @@ -; MokoOpenGraph - Package System Language File +; MokoJoomOpenGraph - Package System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PKG_MOKOOG="MokoOpenGraph" +PKG_MOKOOG="MokoJoomOpenGraph" PKG_MOKOOG_DESCRIPTION="Complete Open Graph, Twitter Card, and social sharing meta tag management for Joomla. Control how every page appears when shared on Facebook, Twitter/X, LinkedIn, WhatsApp, and more." -PKG_MOKOOG_PHP_VERSION_ERROR="MokoOpenGraph requires PHP %s or later." +PKG_MOKOOG_PHP_VERSION_ERROR="MokoJoomOpenGraph requires PHP %s or later." diff --git a/src/language/index.html b/src/language/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/language/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/api/index.html b/src/packages/com_mokoog/api/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/api/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/api/src/Controller/TagsController.php b/src/packages/com_mokoog/api/src/Controller/TagsController.php new file mode 100644 index 0000000..9fbe168 --- /dev/null +++ b/src/packages/com_mokoog/api/src/Controller/TagsController.php @@ -0,0 +1,68 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog.api + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Api\Controller; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; +use Joomla\CMS\MVC\Controller\ApiController; + +class TagsController extends ApiController +{ + /** + * The content type for JSON:API output. + * + * @var string + */ + protected $contentType = 'tags'; + + /** + * The default view for the API. + * + * @var string + */ + protected $default_view = 'tags'; + + /** + * Lookup an OG tag by content_type and content_id. + * + * GET /api/index.php/v1/mokoog/lookup/:content_type/:content_id + * + * @return static + */ + public function lookup(): static + { + $contentType = $this->input->getString('content_type', ''); + $contentId = $this->input->getInt('content_id', 0); + + if (empty($contentType) || $contentId <= 0) { + throw new \RuntimeException('content_type and content_id are required', 400); + } + + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('id')) + ->from($db->quoteName('#__mokoog_tags')) + ->where($db->quoteName('content_type') . ' = ' . $db->quote($contentType)) + ->where($db->quoteName('content_id') . ' = ' . $contentId); + + $db->setQuery($query); + $id = $db->loadResult(); + + if (!$id) { + throw new \RuntimeException('OG tag not found for ' . $contentType . ':' . $contentId, 404); + } + + $this->input->set('id', $id); + + return $this->displayItem(); + } +} diff --git a/src/packages/com_mokoog/api/src/Controller/index.html b/src/packages/com_mokoog/api/src/Controller/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/api/src/Controller/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/api/src/View/Tags/JsonapiView.php b/src/packages/com_mokoog/api/src/View/Tags/JsonapiView.php new file mode 100644 index 0000000..97a0aa2 --- /dev/null +++ b/src/packages/com_mokoog/api/src/View/Tags/JsonapiView.php @@ -0,0 +1,66 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog.api + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Api\View\Tags; + +defined('_JEXEC') or die; + +use Joomla\CMS\MVC\View\JsonApiView as BaseApiView; + +class JsonapiView extends BaseApiView +{ + /** + * The fields to render in the API response. + * + * Whitelist of fields from #__mokoog_tags that are safe to expose. + * + * @var array + */ + protected $fieldsToRenderItem = [ + 'id', + 'content_type', + 'content_id', + 'og_title', + 'og_description', + 'og_image', + 'og_type', + 'seo_title', + 'meta_description', + 'robots', + 'canonical_url', + 'language', + 'published', + 'created', + 'modified', + ]; + + /** + * The fields to render in list responses. + * + * @var array + */ + protected $fieldsToRenderList = [ + 'id', + 'content_type', + 'content_id', + 'og_title', + 'og_description', + 'og_image', + 'og_type', + 'seo_title', + 'meta_description', + 'robots', + 'canonical_url', + 'language', + 'published', + 'created', + 'modified', + ]; +} diff --git a/src/packages/com_mokoog/api/src/View/Tags/index.html b/src/packages/com_mokoog/api/src/View/Tags/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/api/src/View/Tags/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/api/src/View/index.html b/src/packages/com_mokoog/api/src/View/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/api/src/View/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/api/src/index.html b/src/packages/com_mokoog/api/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/api/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/forms/filter_tags.xml b/src/packages/com_mokoog/forms/filter_tags.xml index d7e87b4..b4d4015 100644 --- a/src/packages/com_mokoog/forms/filter_tags.xml +++ b/src/packages/com_mokoog/forms/filter_tags.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/forms/index.html b/src/packages/com_mokoog/forms/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/forms/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/forms/tag.xml b/src/packages/com_mokoog/forms/tag.xml index 363ef5f..87d8068 100644 --- a/src/packages/com_mokoog/forms/tag.xml +++ b/src/packages/com_mokoog/forms/tag.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -70,4 +70,37 @@ <option value="0">JUNPUBLISHED</option> </field> </fieldset> + <fieldset name="seo" label="SEO Meta Tags"> + <field + name="seo_title" + type="text" + label="PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE" + description="PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE_DESC" + filter="string" + maxlength="70" + /> + <field + name="meta_description" + type="textarea" + label="PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION" + description="PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION_DESC" + filter="string" + rows="3" + maxlength="200" + /> + <field + name="robots" + type="text" + label="PLG_CONTENT_MOKOOG_FIELD_ROBOTS" + description="PLG_CONTENT_MOKOOG_FIELD_ROBOTS_DESC" + filter="string" + /> + <field + name="canonical_url" + type="url" + label="PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL" + description="PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL_DESC" + filter="url" + /> + </fieldset> </form> diff --git a/src/packages/com_mokoog/index.html b/src/packages/com_mokoog/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/language/en-GB/com_mokoog.ini b/src/packages/com_mokoog/language/en-GB/com_mokoog.ini index 0e56059..f970f01 100644 --- a/src/packages/com_mokoog/language/en-GB/com_mokoog.ini +++ b/src/packages/com_mokoog/language/en-GB/com_mokoog.ini @@ -1,9 +1,9 @@ -; MokoOpenGraph - Component Language File +; MokoJoomOpenGraph - Component Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -COM_MOKOOG="MokoOpenGraph" -COM_MOKOOG_TAGS_TITLE="MokoOpenGraph - Tag Manager" +COM_MOKOOG="MokoJoomOpenGraph" +COM_MOKOOG_TAGS_TITLE="MokoJoomOpenGraph - Tag Manager" COM_MOKOOG_SUBMENU_TAGS="Tags" COM_MOKOOG_NO_TAGS="No Open Graph tags have been created yet. Tags are created automatically when you edit articles or menu items." COM_MOKOOG_TABLE_CAPTION="Table of Open Graph tags" @@ -13,4 +13,47 @@ COM_MOKOOG_HEADING_CONTENT_TYPE="Content Type" COM_MOKOOG_HEADING_CONTENT_ID="Content ID" COM_MOKOOG_HEADING_OG_TITLE="OG Title" COM_MOKOOG_HEADING_IMAGE="Image" +COM_MOKOOG_HEADING_SEO="SEO" +COM_MOKOOG_HEADING_DEBUG="Debug" COM_MOKOOG_HEADING_MODIFIED="Modified" + +COM_MOKOOG_SEO_OK="OK" +COM_MOKOOG_SEO_MISSING_DESC="No meta description" +COM_MOKOOG_SEO_TITLE_LONG="SEO title too long" +COM_MOKOOG_SEO_NOINDEX="noindex" + +COM_MOKOOG_FIELD_CONTENT_TYPE="Content Type" +COM_MOKOOG_FIELD_CONTENT_ID="Content ID" +COM_MOKOOG_FIELD_OG_TITLE="OG Title" +COM_MOKOOG_FIELD_OG_TITLE_DESC="Custom title for social sharing." +COM_MOKOOG_FIELD_OG_DESCRIPTION="OG Description" +COM_MOKOOG_FIELD_OG_DESCRIPTION_DESC="Custom description for social sharing." +COM_MOKOOG_FIELD_OG_IMAGE="OG Image" +COM_MOKOOG_FIELD_OG_IMAGE_DESC="Custom image for social sharing." +COM_MOKOOG_FIELD_OG_TYPE="OG Type" +COM_MOKOOG_FIELD_OG_TYPE_DESC="The Open Graph content type." + +COM_MOKOOG_FILTER_SEARCH="Search OG titles" +COM_MOKOOG_FILTER_CONTENT_TYPE="Content Type" +COM_MOKOOG_FILTER_SELECT_TYPE="- Select Type -" +COM_MOKOOG_HEADING_OG_TITLE_ASC="OG Title ascending" +COM_MOKOOG_HEADING_OG_TITLE_DESC="OG Title descending" +COM_MOKOOG_HEADING_MODIFIED_ASC="Modified ascending" +COM_MOKOOG_HEADING_MODIFIED_DESC="Modified descending" + +COM_MOKOOG_TOOLBAR_BATCH_GENERATE="Batch Generate" +COM_MOKOOG_BATCH_TITLE="Batch OG Tag Generation" +COM_MOKOOG_BATCH_COUNTING="Counting articles without OG tags..." +COM_MOKOOG_BATCH_NONE="All articles already have OG tags." +COM_MOKOOG_BATCH_FOUND="articles found without OG tags." +COM_MOKOOG_BATCH_PROCESSED="processed" +COM_MOKOOG_BATCH_COMPLETE="Batch generation complete!" +COM_MOKOOG_BATCH_ERROR="Error:" + +COM_MOKOOG_TOOLBAR_EXPORT="Export CSV" +COM_MOKOOG_TOOLBAR_IMPORT="Import CSV" +COM_MOKOOG_IMPORT_NO_FILE="No CSV file was uploaded." +COM_MOKOOG_IMPORT_INVALID_TYPE="Invalid file type. Please upload a .csv file." +COM_MOKOOG_IMPORT_FILE_TOO_LARGE="File is too large. Maximum allowed size is %s." +COM_MOKOOG_IMPORT_READ_ERROR="Could not read the uploaded CSV file." +COM_MOKOOG_IMPORT_RESULT="Import complete: %d created, %d updated, %d skipped." diff --git a/src/packages/com_mokoog/language/en-GB/com_mokoog.sys.ini b/src/packages/com_mokoog/language/en-GB/com_mokoog.sys.ini index be6c090..0aacbc4 100644 --- a/src/packages/com_mokoog/language/en-GB/com_mokoog.sys.ini +++ b/src/packages/com_mokoog/language/en-GB/com_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - Component System Language File +; MokoJoomOpenGraph - Component System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -COM_MOKOOG="MokoOpenGraph" +COM_MOKOOG="MokoJoomOpenGraph" COM_MOKOOG_DESCRIPTION="Manage Open Graph and social sharing tags for all your content. View, edit, and batch-process OG metadata." diff --git a/src/packages/com_mokoog/language/en-GB/index.html b/src/packages/com_mokoog/language/en-GB/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/language/en-GB/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/language/en-US/com_mokoog.ini b/src/packages/com_mokoog/language/en-US/com_mokoog.ini index 0e56059..f970f01 100644 --- a/src/packages/com_mokoog/language/en-US/com_mokoog.ini +++ b/src/packages/com_mokoog/language/en-US/com_mokoog.ini @@ -1,9 +1,9 @@ -; MokoOpenGraph - Component Language File +; MokoJoomOpenGraph - Component Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -COM_MOKOOG="MokoOpenGraph" -COM_MOKOOG_TAGS_TITLE="MokoOpenGraph - Tag Manager" +COM_MOKOOG="MokoJoomOpenGraph" +COM_MOKOOG_TAGS_TITLE="MokoJoomOpenGraph - Tag Manager" COM_MOKOOG_SUBMENU_TAGS="Tags" COM_MOKOOG_NO_TAGS="No Open Graph tags have been created yet. Tags are created automatically when you edit articles or menu items." COM_MOKOOG_TABLE_CAPTION="Table of Open Graph tags" @@ -13,4 +13,47 @@ COM_MOKOOG_HEADING_CONTENT_TYPE="Content Type" COM_MOKOOG_HEADING_CONTENT_ID="Content ID" COM_MOKOOG_HEADING_OG_TITLE="OG Title" COM_MOKOOG_HEADING_IMAGE="Image" +COM_MOKOOG_HEADING_SEO="SEO" +COM_MOKOOG_HEADING_DEBUG="Debug" COM_MOKOOG_HEADING_MODIFIED="Modified" + +COM_MOKOOG_SEO_OK="OK" +COM_MOKOOG_SEO_MISSING_DESC="No meta description" +COM_MOKOOG_SEO_TITLE_LONG="SEO title too long" +COM_MOKOOG_SEO_NOINDEX="noindex" + +COM_MOKOOG_FIELD_CONTENT_TYPE="Content Type" +COM_MOKOOG_FIELD_CONTENT_ID="Content ID" +COM_MOKOOG_FIELD_OG_TITLE="OG Title" +COM_MOKOOG_FIELD_OG_TITLE_DESC="Custom title for social sharing." +COM_MOKOOG_FIELD_OG_DESCRIPTION="OG Description" +COM_MOKOOG_FIELD_OG_DESCRIPTION_DESC="Custom description for social sharing." +COM_MOKOOG_FIELD_OG_IMAGE="OG Image" +COM_MOKOOG_FIELD_OG_IMAGE_DESC="Custom image for social sharing." +COM_MOKOOG_FIELD_OG_TYPE="OG Type" +COM_MOKOOG_FIELD_OG_TYPE_DESC="The Open Graph content type." + +COM_MOKOOG_FILTER_SEARCH="Search OG titles" +COM_MOKOOG_FILTER_CONTENT_TYPE="Content Type" +COM_MOKOOG_FILTER_SELECT_TYPE="- Select Type -" +COM_MOKOOG_HEADING_OG_TITLE_ASC="OG Title ascending" +COM_MOKOOG_HEADING_OG_TITLE_DESC="OG Title descending" +COM_MOKOOG_HEADING_MODIFIED_ASC="Modified ascending" +COM_MOKOOG_HEADING_MODIFIED_DESC="Modified descending" + +COM_MOKOOG_TOOLBAR_BATCH_GENERATE="Batch Generate" +COM_MOKOOG_BATCH_TITLE="Batch OG Tag Generation" +COM_MOKOOG_BATCH_COUNTING="Counting articles without OG tags..." +COM_MOKOOG_BATCH_NONE="All articles already have OG tags." +COM_MOKOOG_BATCH_FOUND="articles found without OG tags." +COM_MOKOOG_BATCH_PROCESSED="processed" +COM_MOKOOG_BATCH_COMPLETE="Batch generation complete!" +COM_MOKOOG_BATCH_ERROR="Error:" + +COM_MOKOOG_TOOLBAR_EXPORT="Export CSV" +COM_MOKOOG_TOOLBAR_IMPORT="Import CSV" +COM_MOKOOG_IMPORT_NO_FILE="No CSV file was uploaded." +COM_MOKOOG_IMPORT_INVALID_TYPE="Invalid file type. Please upload a .csv file." +COM_MOKOOG_IMPORT_FILE_TOO_LARGE="File is too large. Maximum allowed size is %s." +COM_MOKOOG_IMPORT_READ_ERROR="Could not read the uploaded CSV file." +COM_MOKOOG_IMPORT_RESULT="Import complete: %d created, %d updated, %d skipped." diff --git a/src/packages/com_mokoog/language/en-US/com_mokoog.sys.ini b/src/packages/com_mokoog/language/en-US/com_mokoog.sys.ini index be6c090..0aacbc4 100644 --- a/src/packages/com_mokoog/language/en-US/com_mokoog.sys.ini +++ b/src/packages/com_mokoog/language/en-US/com_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - Component System Language File +; MokoJoomOpenGraph - Component System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -COM_MOKOOG="MokoOpenGraph" +COM_MOKOOG="MokoJoomOpenGraph" COM_MOKOOG_DESCRIPTION="Manage Open Graph and social sharing tags for all your content. View, edit, and batch-process OG metadata." diff --git a/src/packages/com_mokoog/language/en-US/index.html b/src/packages/com_mokoog/language/en-US/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/language/en-US/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/language/index.html b/src/packages/com_mokoog/language/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/language/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/mokoog.xml b/src/packages/com_mokoog/mokoog.xml index 3089e4f..1bccaae 100644 --- a/src/packages/com_mokoog/mokoog.xml +++ b/src/packages/com_mokoog/mokoog.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -8,7 +8,7 @@ --> <extension type="component" method="upgrade"> <name>com_mokoog</name> - <version>01.00.00</version> + <version>01.00.01-dev</version> <creationDate>2026-05-23</creationDate> <author>Moko Consulting</author> <authorEmail>hello@mokoconsulting.tech</authorEmail> @@ -42,6 +42,7 @@ <filename>provider.php</filename> </files> <files folder="src"> + <folder>ContentType</folder> <folder>Controller</folder> <folder>Extension</folder> <folder>Model</folder> @@ -68,4 +69,10 @@ <menu link="option=com_mokoog&view=tags">COM_MOKOOG_SUBMENU_TAGS</menu> </submenu> </administration> + + <api> + <files folder="api"> + <folder>src</folder> + </files> + </api> </extension> diff --git a/src/packages/com_mokoog/script.php b/src/packages/com_mokoog/script.php index 1dc0a47..5073df5 100644 --- a/src/packages/com_mokoog/script.php +++ b/src/packages/com_mokoog/script.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -23,7 +23,7 @@ class Com_MokoOGInstallerScript */ public function install(InstallerAdapter $parent): void { - echo '<p>MokoOpenGraph component installed successfully.</p>'; + echo '<p>MokoJoomOpenGraph component installed successfully.</p>'; } /** @@ -35,6 +35,6 @@ class Com_MokoOGInstallerScript */ public function update(InstallerAdapter $parent): void { - echo '<p>MokoOpenGraph component updated successfully.</p>'; + echo '<p>MokoJoomOpenGraph component updated successfully.</p>'; } } diff --git a/src/packages/com_mokoog/services/index.html b/src/packages/com_mokoog/services/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/services/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/services/provider.php b/src/packages/com_mokoog/services/provider.php index 249c8a1..27c3354 100644 --- a/src/packages/com_mokoog/services/provider.php +++ b/src/packages/com_mokoog/services/provider.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/sql/index.html b/src/packages/com_mokoog/sql/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/sql/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/sql/install.mysql.sql b/src/packages/com_mokoog/sql/install.mysql.sql index 884d369..cc3558a 100644 --- a/src/packages/com_mokoog/sql/install.mysql.sql +++ b/src/packages/com_mokoog/sql/install.mysql.sql @@ -1,5 +1,5 @@ -- --- MokoOpenGraph - Database Schema +-- MokoJoomOpenGraph - Database Schema -- Copyright (C) 2026 Moko Consulting. All rights reserved. -- License: GPL-3.0-or-later -- @@ -12,10 +12,15 @@ CREATE TABLE IF NOT EXISTS `#__mokoog_tags` ( `og_description` TEXT NOT NULL, `og_image` VARCHAR(512) NOT NULL DEFAULT '', `og_type` VARCHAR(50) NOT NULL DEFAULT 'article', + `seo_title` VARCHAR(70) NOT NULL DEFAULT '', + `meta_description` VARCHAR(200) NOT NULL DEFAULT '', + `robots` VARCHAR(100) NOT NULL DEFAULT '', + `canonical_url` VARCHAR(512) NOT NULL DEFAULT '', + `language` CHAR(7) NOT NULL DEFAULT '*', `published` TINYINT(1) NOT NULL DEFAULT 1, `created` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', `modified` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', PRIMARY KEY (`id`), - UNIQUE KEY `idx_content` (`content_type`, `content_id`), + UNIQUE KEY `idx_content_lang` (`content_type`, `content_id`, `language`), KEY `idx_published` (`published`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci; diff --git a/src/packages/com_mokoog/sql/uninstall.mysql.sql b/src/packages/com_mokoog/sql/uninstall.mysql.sql index ab50f15..8652ac6 100644 --- a/src/packages/com_mokoog/sql/uninstall.mysql.sql +++ b/src/packages/com_mokoog/sql/uninstall.mysql.sql @@ -1,5 +1,5 @@ -- --- MokoOpenGraph - Uninstall +-- MokoJoomOpenGraph - Uninstall -- DROP TABLE IF EXISTS `#__mokoog_tags`; diff --git a/src/packages/com_mokoog/sql/updates/index.html b/src/packages/com_mokoog/sql/updates/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/sql/updates/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/sql/updates/mysql/01.01.00.sql b/src/packages/com_mokoog/sql/updates/mysql/01.01.00.sql new file mode 100644 index 0000000..5bac763 --- /dev/null +++ b/src/packages/com_mokoog/sql/updates/mysql/01.01.00.sql @@ -0,0 +1,9 @@ +-- +-- MokoJoomOpenGraph 01.01.00 — Add SEO meta management columns +-- + +ALTER TABLE `#__mokoog_tags` + ADD COLUMN `seo_title` VARCHAR(70) NOT NULL DEFAULT '' AFTER `og_type`, + ADD COLUMN `meta_description` VARCHAR(200) NOT NULL DEFAULT '' AFTER `seo_title`, + ADD COLUMN `robots` VARCHAR(100) NOT NULL DEFAULT '' AFTER `meta_description`, + ADD COLUMN `canonical_url` VARCHAR(512) NOT NULL DEFAULT '' AFTER `robots`; diff --git a/src/packages/com_mokoog/sql/updates/mysql/01.02.00.sql b/src/packages/com_mokoog/sql/updates/mysql/01.02.00.sql new file mode 100644 index 0000000..ca87208 --- /dev/null +++ b/src/packages/com_mokoog/sql/updates/mysql/01.02.00.sql @@ -0,0 +1,10 @@ +-- +-- MokoJoomOpenGraph 01.02.00 — Add multilingual OG tag support +-- + +ALTER TABLE `#__mokoog_tags` + ADD COLUMN `language` CHAR(7) NOT NULL DEFAULT '*' AFTER `canonical_url`; + +ALTER TABLE `#__mokoog_tags` + DROP INDEX `idx_content`, + ADD UNIQUE KEY `idx_content_lang` (`content_type`, `content_id`, `language`); diff --git a/src/packages/com_mokoog/sql/updates/mysql/index.html b/src/packages/com_mokoog/sql/updates/mysql/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/sql/updates/mysql/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/ContentType/ContentTypeInterface.php b/src/packages/com_mokoog/src/ContentType/ContentTypeInterface.php new file mode 100644 index 0000000..6689aad --- /dev/null +++ b/src/packages/com_mokoog/src/ContentType/ContentTypeInterface.php @@ -0,0 +1,60 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\ContentType; + +defined('_JEXEC') or die; + +interface ContentTypeInterface +{ + /** + * Check if this adapter can handle the given component/view. + * + * @param string $option Component option (e.g. com_virtuemart) + * @param string $view View name (e.g. productdetails) + * + * @return bool + */ + public function canHandle(string $option, string $view): bool; + + /** + * Get the content type identifier for database storage. + * + * @return string + */ + public function getContentType(): string; + + /** + * Get the title for the content item. + * + * @param int $id Content item ID + * + * @return string + */ + public function getTitle(int $id): string; + + /** + * Get a description for the content item. + * + * @param int $id Content item ID + * + * @return string + */ + public function getDescription(int $id): string; + + /** + * Get the primary image for the content item. + * + * @param int $id Content item ID + * + * @return string Image path relative to JPATH_ROOT, or empty string + */ + public function getImage(int $id): string; +} diff --git a/src/packages/com_mokoog/src/ContentType/HikaShopAdapter.php b/src/packages/com_mokoog/src/ContentType/HikaShopAdapter.php new file mode 100644 index 0000000..07150b3 --- /dev/null +++ b/src/packages/com_mokoog/src/ContentType/HikaShopAdapter.php @@ -0,0 +1,76 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\ContentType; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; + +class HikaShopAdapter implements ContentTypeInterface +{ + public function canHandle(string $option, string $view): bool + { + return $option === 'com_hikashop' && $view === 'product'; + } + + public function getContentType(): string + { + return 'com_hikashop'; + } + + public function getTitle(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('product_name')) + ->from($db->quoteName('#__hikashop_product')) + ->where($db->quoteName('product_id') . ' = ' . $id); + + $db->setQuery($query); + + return $db->loadResult() ?: ''; + } + + public function getDescription(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('product_description')) + ->from($db->quoteName('#__hikashop_product')) + ->where($db->quoteName('product_id') . ' = ' . $id); + + $db->setQuery($query); + $text = $db->loadResult() ?: ''; + $text = strip_tags($text); + $text = trim(preg_replace('/\s+/', ' ', $text)); + + if (\strlen($text) > 160) { + $text = mb_substr($text, 0, 157) . '...'; + } + + return $text; + } + + public function getImage(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('f.file_path')) + ->from($db->quoteName('#__hikashop_file', 'f')) + ->where($db->quoteName('f.file_ref_id') . ' = ' . $id) + ->where($db->quoteName('f.file_type') . ' = ' . $db->quote('product')) + ->order($db->quoteName('f.file_ordering') . ' ASC'); + + $db->setQuery($query, 0, 1); + + return $db->loadResult() ?: ''; + } +} diff --git a/src/packages/com_mokoog/src/ContentType/K2Adapter.php b/src/packages/com_mokoog/src/ContentType/K2Adapter.php new file mode 100644 index 0000000..ec3f017 --- /dev/null +++ b/src/packages/com_mokoog/src/ContentType/K2Adapter.php @@ -0,0 +1,73 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\ContentType; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; + +class K2Adapter implements ContentTypeInterface +{ + public function canHandle(string $option, string $view): bool + { + return $option === 'com_k2' && $view === 'item'; + } + + public function getContentType(): string + { + return 'com_k2'; + } + + public function getTitle(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('title')) + ->from($db->quoteName('#__k2_items')) + ->where($db->quoteName('id') . ' = ' . $id); + + $db->setQuery($query); + + return $db->loadResult() ?: ''; + } + + public function getDescription(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('introtext')) + ->from($db->quoteName('#__k2_items')) + ->where($db->quoteName('id') . ' = ' . $id); + + $db->setQuery($query); + $text = $db->loadResult() ?: ''; + $text = strip_tags($text); + $text = trim(preg_replace('/\s+/', ' ', $text)); + + if (\strlen($text) > 160) { + $text = mb_substr($text, 0, 157) . '...'; + } + + return $text; + } + + public function getImage(int $id): string + { + // K2 stores images as media/k2/items/cache/{md5}_L.jpg + $imagePath = 'media/k2/items/cache/' . md5('Image' . $id) . '_L.jpg'; + + if (is_file(JPATH_ROOT . '/' . $imagePath)) { + return $imagePath; + } + + return ''; + } +} diff --git a/src/packages/com_mokoog/src/ContentType/VirtueMartAdapter.php b/src/packages/com_mokoog/src/ContentType/VirtueMartAdapter.php new file mode 100644 index 0000000..d68a03d --- /dev/null +++ b/src/packages/com_mokoog/src/ContentType/VirtueMartAdapter.php @@ -0,0 +1,82 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\ContentType; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; + +class VirtueMartAdapter implements ContentTypeInterface +{ + public function canHandle(string $option, string $view): bool + { + return $option === 'com_virtuemart' && $view === 'productdetails'; + } + + public function getContentType(): string + { + return 'com_virtuemart'; + } + + public function getTitle(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('product_name')) + ->from($db->quoteName('#__virtuemart_products_' . $this->getLangTag())) + ->where($db->quoteName('virtuemart_product_id') . ' = ' . $id); + + $db->setQuery($query); + + return $db->loadResult() ?: ''; + } + + public function getDescription(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('product_s_desc')) + ->from($db->quoteName('#__virtuemart_products_' . $this->getLangTag())) + ->where($db->quoteName('virtuemart_product_id') . ' = ' . $id); + + $db->setQuery($query); + $desc = $db->loadResult() ?: ''; + + return strip_tags($desc); + } + + public function getImage(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('m.file_url')) + ->from($db->quoteName('#__virtuemart_product_medias', 'pm')) + ->join('INNER', $db->quoteName('#__virtuemart_medias', 'm') . ' ON ' . $db->quoteName('m.virtuemart_media_id') . ' = ' . $db->quoteName('pm.virtuemart_media_id')) + ->where($db->quoteName('pm.virtuemart_product_id') . ' = ' . $id) + ->order($db->quoteName('pm.ordering') . ' ASC'); + + $db->setQuery($query, 0, 1); + + return $db->loadResult() ?: ''; + } + + /** + * Get the VirtueMart language table suffix. + * + * @return string + */ + private function getLangTag(): string + { + $lang = Factory::getLanguage()->getTag(); + + return strtolower(str_replace('-', '_', $lang)); + } +} diff --git a/src/packages/com_mokoog/src/ContentType/index.html b/src/packages/com_mokoog/src/ContentType/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/ContentType/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Controller/BatchController.php b/src/packages/com_mokoog/src/Controller/BatchController.php new file mode 100644 index 0000000..ca9aaeb --- /dev/null +++ b/src/packages/com_mokoog/src/Controller/BatchController.php @@ -0,0 +1,177 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\Controller; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; +use Joomla\CMS\Language\Text; +use Joomla\CMS\MVC\Controller\BaseController; +use Joomla\CMS\Response\JsonResponse; +use Joomla\CMS\Session\Session; + +class BatchController extends BaseController +{ + /** + * Count the total articles eligible for batch generation. + * + * @return void + */ + public function count(): void + { + Session::checkToken('get') || jexit(Text::_('JINVALID_TOKEN')); + + if (!Factory::getApplication()->getIdentity()->authorise('core.create', 'com_mokoog')) { + throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 403); + } + + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select('COUNT(*)') + ->from($db->quoteName('#__content', 'c')) + ->leftJoin( + $db->quoteName('#__mokoog_tags', 't') + . ' ON ' . $db->quoteName('t.content_type') . ' = ' . $db->quote('com_content') + . ' AND ' . $db->quoteName('t.content_id') . ' = ' . $db->quoteName('c.id') + ) + ->where($db->quoteName('c.state') . ' = 1') + ->where($db->quoteName('t.id') . ' IS NULL'); + + $db->setQuery($query); + $total = (int) $db->loadResult(); + + echo new JsonResponse(['total' => $total]); + + Factory::getApplication()->close(); + } + + /** + * Process a chunk of articles for batch OG generation. + * + * @return void + */ + public function process(): void + { + Session::checkToken('get') || jexit(Text::_('JINVALID_TOKEN')); + + if (!Factory::getApplication()->getIdentity()->authorise('core.create', 'com_mokoog')) { + throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 403); + } + + $app = Factory::getApplication(); + $offset = $app->getInput()->getInt('offset', 0); + $limit = $app->getInput()->getInt('limit', 50); + + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName([ + 'c.id', 'c.title', 'c.metadesc', 'c.introtext', 'c.fulltext', 'c.images', + ])) + ->from($db->quoteName('#__content', 'c')) + ->leftJoin( + $db->quoteName('#__mokoog_tags', 't') + . ' ON ' . $db->quoteName('t.content_type') . ' = ' . $db->quote('com_content') + . ' AND ' . $db->quoteName('t.content_id') . ' = ' . $db->quoteName('c.id') + ) + ->where($db->quoteName('c.state') . ' = 1') + ->where($db->quoteName('t.id') . ' IS NULL') + ->order($db->quoteName('c.id') . ' ASC'); + + $db->setQuery($query, $offset, $limit); + $articles = $db->loadObjectList(); + + $created = 0; + $now = Factory::getDate()->toSql(); + + foreach ($articles as $article) { + $ogTitle = $article->title; + $ogDescription = $this->extractDescription($article); + $ogImage = $this->extractImage($article); + + $record = (object) [ + 'content_type' => 'com_content', + 'content_id' => (int) $article->id, + 'og_title' => $ogTitle, + 'og_description' => $ogDescription, + 'og_image' => $ogImage, + 'og_type' => 'article', + 'seo_title' => '', + 'meta_description' => $article->metadesc ?: '', + 'robots' => '', + 'canonical_url' => '', + 'published' => 1, + 'created' => $now, + 'modified' => $now, + ]; + + $db->insertObject('#__mokoog_tags', $record); + $created++; + } + + echo new JsonResponse([ + 'created' => $created, + 'offset' => $offset, + 'processed' => $offset + $created, + ]); + + $app->close(); + } + + /** + * Extract a description from article content. + * + * @param object $article Article record + * + * @return string + */ + private function extractDescription(object $article): string + { + // Prefer meta description if set + if (!empty($article->metadesc)) { + return $article->metadesc; + } + + // Fall back to intro text + $text = $article->introtext ?: $article->fulltext; + $text = strip_tags($text); + $text = trim(preg_replace('/\s+/', ' ', $text)); + + if (\strlen($text) > 160) { + $text = mb_substr($text, 0, 157) . '...'; + } + + return $text; + } + + /** + * Extract the best image from article data. + * + * @param object $article Article record + * + * @return string + */ + private function extractImage(object $article): string + { + if (!empty($article->images)) { + $images = json_decode($article->images, true); + + if (!empty($images['image_fulltext'])) { + return $images['image_fulltext']; + } + + if (!empty($images['image_intro'])) { + return $images['image_intro']; + } + } + + return ''; + } +} diff --git a/src/packages/com_mokoog/src/Controller/DisplayController.php b/src/packages/com_mokoog/src/Controller/DisplayController.php index d65ffaf..28b73c9 100644 --- a/src/packages/com_mokoog/src/Controller/DisplayController.php +++ b/src/packages/com_mokoog/src/Controller/DisplayController.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/src/Controller/ImportExportController.php b/src/packages/com_mokoog/src/Controller/ImportExportController.php new file mode 100644 index 0000000..b135575 --- /dev/null +++ b/src/packages/com_mokoog/src/Controller/ImportExportController.php @@ -0,0 +1,245 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\Controller; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; +use Joomla\CMS\Language\Text; +use Joomla\CMS\MVC\Controller\BaseController; +use Joomla\CMS\Session\Session; + +class ImportExportController extends BaseController +{ + /** + * Maximum upload file size in bytes (2 MB). + */ + private const MAX_FILE_SIZE = 2 * 1024 * 1024; + + /** + * Allowed content_type patterns for import. + */ + private const CONTENT_TYPE_PATTERN = '/^[a-z][a-z0-9_.]*$/'; + + /** + * Export all OG tags as CSV. + * + * @return void + */ + public function export(): void + { + Session::checkToken('get') || jexit(Text::_('JINVALID_TOKEN')); + + if (!Factory::getApplication()->getIdentity()->authorise('core.manage', 'com_mokoog')) { + throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 403); + } + + $app = Factory::getApplication(); + $db = Factory::getDbo(); + + // Join with #__content to get article titles for reference + $query = $db->getQuery(true) + ->select([ + $db->quoteName('t.content_type'), + $db->quoteName('t.content_id'), + 'COALESCE(' . $db->quoteName('c.title') . ', ' . $db->quote('') . ') AS ' . $db->quoteName('article_title'), + $db->quoteName('t.og_title'), + $db->quoteName('t.og_description'), + $db->quoteName('t.og_image'), + $db->quoteName('t.og_type'), + $db->quoteName('t.seo_title'), + $db->quoteName('t.meta_description'), + $db->quoteName('t.robots'), + $db->quoteName('t.canonical_url'), + ]) + ->from($db->quoteName('#__mokoog_tags', 't')) + ->leftJoin( + $db->quoteName('#__content', 'c') + . ' ON ' . $db->quoteName('t.content_type') . ' = ' . $db->quote('com_content') + . ' AND ' . $db->quoteName('t.content_id') . ' = ' . $db->quoteName('c.id') + ) + ->order($db->quoteName('t.content_type') . ', ' . $db->quoteName('t.content_id')); + + $db->setQuery($query); + $rows = $db->loadAssocList(); + + // Send CSV headers + $app->setHeader('Content-Type', 'text/csv; charset=utf-8'); + $app->setHeader('Content-Disposition', 'attachment; filename="mokoog_tags_export.csv"'); + $app->sendHeaders(); + + $output = fopen('php://output', 'w'); + + // Header row + fputcsv($output, [ + 'content_type', 'content_id', 'article_title', + 'og_title', 'og_description', 'og_image', 'og_type', + 'seo_title', 'meta_description', 'robots', 'canonical_url', + ]); + + foreach ($rows as $row) { + fputcsv($output, $row); + } + + fclose($output); + $app->close(); + } + + /** + * Import OG tags from uploaded CSV. + * + * @return void + */ + public function import(): void + { + Session::checkToken() || jexit(Text::_('JINVALID_TOKEN')); + + $identity = Factory::getApplication()->getIdentity(); + + if (!$identity->authorise('core.create', 'com_mokoog') || !$identity->authorise('core.edit', 'com_mokoog')) { + throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_ACCESS_FORBIDDEN'), 403); + } + + $app = Factory::getApplication(); + $input = $app->getInput(); + $files = $input->files->get('jform', [], 'array'); + + if (empty($files['csv_file']['tmp_name'])) { + $app->enqueueMessage(Text::_('COM_MOKOOG_IMPORT_NO_FILE'), 'error'); + $app->redirect('index.php?option=com_mokoog&view=tags'); + + return; + } + + $csvFile = $files['csv_file']; + + // Validate file extension + $ext = strtolower(pathinfo($csvFile['name'] ?? '', PATHINFO_EXTENSION)); + + if ($ext !== 'csv') { + $app->enqueueMessage(Text::_('COM_MOKOOG_IMPORT_INVALID_TYPE'), 'error'); + $app->redirect('index.php?option=com_mokoog&view=tags'); + + return; + } + + // Validate MIME type + $allowedMimes = ['text/csv', 'text/plain', 'application/csv', 'application/vnd.ms-excel']; + + if (!empty($csvFile['type']) && !\in_array($csvFile['type'], $allowedMimes, true)) { + $app->enqueueMessage(Text::_('COM_MOKOOG_IMPORT_INVALID_TYPE'), 'error'); + $app->redirect('index.php?option=com_mokoog&view=tags'); + + return; + } + + // Validate file size + if (($csvFile['size'] ?? 0) > self::MAX_FILE_SIZE) { + $app->enqueueMessage(Text::sprintf('COM_MOKOOG_IMPORT_FILE_TOO_LARGE', '2 MB'), 'error'); + $app->redirect('index.php?option=com_mokoog&view=tags'); + + return; + } + + $tmpFile = $csvFile['tmp_name']; + $handle = fopen($tmpFile, 'r'); + + if (!$handle) { + $app->enqueueMessage(Text::_('COM_MOKOOG_IMPORT_READ_ERROR'), 'error'); + $app->redirect('index.php?option=com_mokoog&view=tags'); + + return; + } + + $db = Factory::getDbo(); + $header = fgetcsv($handle); + $created = 0; + $updated = 0; + $skipped = 0; + $now = Factory::getDate()->toSql(); + + while (($row = fgetcsv($handle)) !== false) { + if (\count($row) < 7) { + $skipped++; + + continue; + } + + $contentType = trim($row[0]); + $contentId = (int) $row[1]; + // $row[2] = article_title (informational, skip) + $ogTitle = trim($row[3] ?? ''); + $ogDescription = trim($row[4] ?? ''); + $ogImage = trim($row[5] ?? ''); + $ogType = trim($row[6] ?? 'article'); + $seoTitle = trim($row[7] ?? ''); + $metaDesc = trim($row[8] ?? ''); + $robots = trim($row[9] ?? ''); + $canonicalUrl = trim($row[10] ?? ''); + + if (empty($contentType) || $contentId <= 0) { + $skipped++; + + continue; + } + + // Validate content_type against allowed pattern + if (!preg_match(self::CONTENT_TYPE_PATTERN, $contentType)) { + $skipped++; + + continue; + } + + // Check for existing record + $query = $db->getQuery(true) + ->select($db->quoteName('id')) + ->from($db->quoteName('#__mokoog_tags')) + ->where($db->quoteName('content_type') . ' = ' . $db->quote($contentType)) + ->where($db->quoteName('content_id') . ' = ' . $contentId); + + $db->setQuery($query); + $existingId = $db->loadResult(); + + $record = (object) [ + 'content_type' => $contentType, + 'content_id' => $contentId, + 'og_title' => $ogTitle, + 'og_description' => $ogDescription, + 'og_image' => $ogImage, + 'og_type' => $ogType, + 'seo_title' => $seoTitle, + 'meta_description' => $metaDesc, + 'robots' => $robots, + 'canonical_url' => $canonicalUrl, + 'published' => 1, + 'modified' => $now, + ]; + + if ($existingId) { + $record->id = $existingId; + $db->updateObject('#__mokoog_tags', $record, 'id'); + $updated++; + } else { + $record->created = $now; + $db->insertObject('#__mokoog_tags', $record); + $created++; + } + } + + fclose($handle); + + $app->enqueueMessage( + Text::sprintf('COM_MOKOOG_IMPORT_RESULT', $created, $updated, $skipped), + 'success' + ); + $app->redirect('index.php?option=com_mokoog&view=tags'); + } +} diff --git a/src/packages/com_mokoog/src/Controller/index.html b/src/packages/com_mokoog/src/Controller/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Controller/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Extension/MokoOGComponent.php b/src/packages/com_mokoog/src/Extension/MokoOGComponent.php index 65307b3..f8e3a9e 100644 --- a/src/packages/com_mokoog/src/Extension/MokoOGComponent.php +++ b/src/packages/com_mokoog/src/Extension/MokoOGComponent.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/src/Extension/index.html b/src/packages/com_mokoog/src/Extension/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Extension/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Field/index.html b/src/packages/com_mokoog/src/Field/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Field/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Model/TagModel.php b/src/packages/com_mokoog/src/Model/TagModel.php new file mode 100644 index 0000000..c56b682 --- /dev/null +++ b/src/packages/com_mokoog/src/Model/TagModel.php @@ -0,0 +1,68 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage com_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Component\MokoOG\Administrator\Model; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; +use Joomla\CMS\MVC\Model\AdminModel; + +class TagModel extends AdminModel +{ + /** + * Get the form for the item. + * + * @param array $data Form data + * @param bool $loadData Load data from state + * + * @return \Joomla\CMS\Form\Form|false + */ + public function getForm($data = [], $loadData = true) + { + $form = $this->loadForm( + 'com_mokoog.tag', + 'tag', + ['control' => 'jform', 'load_data' => $loadData] + ); + + return $form ?: false; + } + + /** + * Load the form data. + * + * @return object + */ + protected function loadFormData(): object + { + $data = Factory::getApplication()->getUserState('com_mokoog.edit.tag.data', []); + + if (empty($data)) { + $data = $this->getItem(); + } + + return $data; + } + + /** + * Get the table class name. + * + * @param string $name Table name + * @param string $prefix Table prefix + * @param array $options Table options + * + * @return \Joomla\CMS\Table\Table + */ + public function getTable($name = 'Tag', $prefix = 'Administrator', $options = []) + { + return parent::getTable($name, $prefix, $options); + } +} diff --git a/src/packages/com_mokoog/src/Model/TagsModel.php b/src/packages/com_mokoog/src/Model/TagsModel.php index 6294af5..4171c21 100644 --- a/src/packages/com_mokoog/src/Model/TagsModel.php +++ b/src/packages/com_mokoog/src/Model/TagsModel.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/src/Model/index.html b/src/packages/com_mokoog/src/Model/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Model/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Service/index.html b/src/packages/com_mokoog/src/Service/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Service/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/Table/TagTable.php b/src/packages/com_mokoog/src/Table/TagTable.php index 32817a2..29d68e4 100644 --- a/src/packages/com_mokoog/src/Table/TagTable.php +++ b/src/packages/com_mokoog/src/Table/TagTable.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/com_mokoog/src/Table/index.html b/src/packages/com_mokoog/src/Table/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/Table/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/View/Tags/HtmlView.php b/src/packages/com_mokoog/src/View/Tags/HtmlView.php index 14ff7cb..eca4100 100644 --- a/src/packages/com_mokoog/src/View/Tags/HtmlView.php +++ b/src/packages/com_mokoog/src/View/Tags/HtmlView.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -39,6 +39,20 @@ class HtmlView extends BaseHtmlView */ protected $state; + /** + * The filter form. + * + * @var \Joomla\CMS\Form\Form|null + */ + public $filterForm; + + /** + * The active filters. + * + * @var array + */ + public $activeFilters = []; + /** * Display the view. * @@ -48,9 +62,11 @@ class HtmlView extends BaseHtmlView */ public function display($tpl = null): void { - $this->items = $this->get('Items'); - $this->pagination = $this->get('Pagination'); - $this->state = $this->get('State'); + $this->items = $this->get('Items'); + $this->pagination = $this->get('Pagination'); + $this->state = $this->get('State'); + $this->filterForm = $this->get('FilterForm'); + $this->activeFilters = $this->get('ActiveFilters'); $this->addToolbar(); @@ -65,6 +81,8 @@ class HtmlView extends BaseHtmlView protected function addToolbar(): void { ToolbarHelper::title(Text::_('COM_MOKOOG_TAGS_TITLE'), 'bookmark'); + ToolbarHelper::custom('batch.generate', 'refresh', '', 'COM_MOKOOG_TOOLBAR_BATCH_GENERATE', false); + ToolbarHelper::custom('importexport.export', 'download', '', 'COM_MOKOOG_TOOLBAR_EXPORT', false); ToolbarHelper::deleteList('JGLOBAL_CONFIRM_DELETE', 'tags.delete'); ToolbarHelper::preferences('com_mokoog'); } diff --git a/src/packages/com_mokoog/src/View/Tags/index.html b/src/packages/com_mokoog/src/View/Tags/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/View/Tags/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/View/Tags/tmpl/index.html b/src/packages/com_mokoog/src/View/Tags/tmpl/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/View/Tags/tmpl/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/View/index.html b/src/packages/com_mokoog/src/View/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/View/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/src/index.html b/src/packages/com_mokoog/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/tmpl/index.html b/src/packages/com_mokoog/tmpl/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/tmpl/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/com_mokoog/tmpl/tags/default.php b/src/packages/com_mokoog/tmpl/tags/default.php index cfec7f7..0543271 100644 --- a/src/packages/com_mokoog/tmpl/tags/default.php +++ b/src/packages/com_mokoog/tmpl/tags/default.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage com_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -14,14 +14,18 @@ use Joomla\CMS\HTML\HTMLHelper; use Joomla\CMS\Language\Text; use Joomla\CMS\Layout\LayoutHelper; use Joomla\CMS\Router\Route; +use Joomla\CMS\Uri\Uri; +use Joomla\CMS\Session\Session; /** @var \Joomla\Component\MokoOG\Administrator\View\Tags\HtmlView $this */ +$token = Session::getFormToken(); ?> <form action="<?php echo Route::_('index.php?option=com_mokoog&view=tags'); ?>" method="post" name="adminForm" id="adminForm"> <div class="row"> <div class="col-md-12"> <div id="j-main-container" class="j-main-container"> + <?php echo LayoutHelper::render('joomla.searchtools.default', ['view' => $this]); ?> <?php if (empty($this->items)) : ?> <div class="alert alert-info"> @@ -50,9 +54,15 @@ use Joomla\CMS\Router\Route; <th scope="col" class="w-10"> <?php echo Text::_('COM_MOKOOG_HEADING_IMAGE'); ?> </th> + <th scope="col" class="w-10"> + <?php echo Text::_('COM_MOKOOG_HEADING_SEO'); ?> + </th> <th scope="col" class="w-10"> <?php echo Text::_('JSTATUS'); ?> </th> + <th scope="col" class="w-10"> + <?php echo Text::_('COM_MOKOOG_HEADING_DEBUG'); ?> + </th> <th scope="col" class="w-10"> <?php echo Text::_('COM_MOKOOG_HEADING_MODIFIED'); ?> </th> @@ -83,9 +93,50 @@ use Joomla\CMS\Router\Route; <span class="icon-minus-circle text-muted" aria-hidden="true"></span> <?php endif; ?> </td> + <td> + <?php + $seoIssues = []; + + if (empty($item->meta_description)) { + $seoIssues[] = Text::_('COM_MOKOOG_SEO_MISSING_DESC'); + } + + if (!empty($item->seo_title) && \strlen($item->seo_title) > 60) { + $seoIssues[] = Text::_('COM_MOKOOG_SEO_TITLE_LONG'); + } + + if (!empty($item->robots) && str_contains($item->robots, 'noindex')) { + $seoIssues[] = Text::_('COM_MOKOOG_SEO_NOINDEX'); + } + + if (empty($seoIssues)) : ?> + <span class="badge bg-success"><?php echo Text::_('COM_MOKOOG_SEO_OK'); ?></span> + <?php else : ?> + <?php foreach ($seoIssues as $issue) : ?> + <span class="badge bg-warning text-dark"><?php echo $issue; ?></span> + <?php endforeach; ?> + <?php endif; ?> + </td> <td> <?php echo $item->published ? Text::_('JPUBLISHED') : Text::_('JUNPUBLISHED'); ?> </td> + <td class="mokoog-debug-links"> + <?php + // Build frontend URL for this content item + if ($item->content_type === 'com_content') { + $debugUrl = Uri::root() . 'index.php?option=com_content&view=article&id=' . (int) $item->content_id; + } elseif ($item->content_type === 'menu') { + $debugUrl = Uri::root() . 'index.php?Itemid=' . (int) $item->content_id; + } elseif ($item->content_type === 'com_content.category') { + $debugUrl = Uri::root() . 'index.php?option=com_content&view=category&id=' . (int) $item->content_id; + } else { + $debugUrl = Uri::root(); + } + ?> + <a href="https://developers.facebook.com/tools/debug/?q=<?php echo urlencode($debugUrl); ?>" target="_blank" rel="noopener" title="Facebook Debugger" class="btn btn-sm btn-outline-primary">FB</a> + <a href="https://www.linkedin.com/post-inspector/inspect/<?php echo urlencode($debugUrl); ?>" target="_blank" rel="noopener" title="LinkedIn Inspector" class="btn btn-sm btn-outline-info">LI</a> + <a href="https://search.google.com/test/rich-results?url=<?php echo urlencode($debugUrl); ?>" target="_blank" rel="noopener" title="Google Rich Results" class="btn btn-sm btn-outline-success">G</a> + </td> <td> <?php echo HTMLHelper::_('date', $item->modified, Text::_('DATE_FORMAT_LC4')); ?> </td> @@ -107,3 +158,85 @@ use Joomla\CMS\Router\Route; </div> </div> </form> + +<!-- Batch Generation Progress --> +<div id="mokoog-batch-panel" style="display:none;" class="card mt-3"> + <div class="card-body"> + <h4><?php echo Text::_('COM_MOKOOG_BATCH_TITLE'); ?></h4> + <div class="progress mb-2"> + <div id="mokoog-batch-bar" class="progress-bar progress-bar-striped progress-bar-animated" role="progressbar" style="width: 0%">0%</div> + </div> + <p id="mokoog-batch-status"></p> + </div> +</div> + +<script> +document.addEventListener('DOMContentLoaded', function() { + // Intercept the batch.generate toolbar button + var origSubmitbutton = Joomla.submitbutton; + Joomla.submitbutton = function(task) { + if (task === 'batch.generate') { + mokoogBatchGenerate(); + return; + } + if (origSubmitbutton) { + origSubmitbutton(task); + } + }; + + function mokoogBatchGenerate() { + var panel = document.getElementById('mokoog-batch-panel'); + var bar = document.getElementById('mokoog-batch-bar'); + var status = document.getElementById('mokoog-batch-status'); + var token = '<?php echo $token; ?>'; + var chunkSize = 50; + + panel.style.display = 'block'; + status.textContent = '<?php echo Text::_('COM_MOKOOG_BATCH_COUNTING', true); ?>'; + + // Step 1: Count eligible articles + fetch('index.php?option=com_mokoog&task=batch.count&format=json&' + token + '=1') + .then(function(r) { return r.json(); }) + .then(function(resp) { + var total = resp.data.total; + if (total === 0) { + bar.style.width = '100%'; + bar.textContent = '100%'; + bar.classList.remove('progress-bar-animated'); + bar.classList.add('bg-success'); + status.textContent = '<?php echo Text::_('COM_MOKOOG_BATCH_NONE', true); ?>'; + return; + } + status.textContent = total + ' <?php echo Text::_('COM_MOKOOG_BATCH_FOUND', true); ?>'; + processChunk(0, total, chunkSize, token, bar, status); + }) + .catch(function(err) { + status.textContent = '<?php echo Text::_('COM_MOKOOG_BATCH_ERROR', true); ?> ' + err.message; + }); + } + + function processChunk(offset, total, chunkSize, token, bar, status) { + fetch('index.php?option=com_mokoog&task=batch.process&format=json&offset=' + offset + '&limit=' + chunkSize + '&' + token + '=1') + .then(function(r) { return r.json(); }) + .then(function(resp) { + var processed = resp.data.processed; + var pct = Math.min(100, Math.round((processed / total) * 100)); + bar.style.width = pct + '%'; + bar.textContent = pct + '%'; + status.textContent = processed + ' / ' + total + ' <?php echo Text::_('COM_MOKOOG_BATCH_PROCESSED', true); ?>'; + + if (processed < total) { + processChunk(processed, total, chunkSize, token, bar, status); + } else { + bar.classList.remove('progress-bar-animated'); + bar.classList.add('bg-success'); + status.textContent = '<?php echo Text::_('COM_MOKOOG_BATCH_COMPLETE', true); ?> ' + total + ' articles.'; + setTimeout(function() { location.reload(); }, 2000); + } + }) + .catch(function(err) { + status.textContent = '<?php echo Text::_('COM_MOKOOG_BATCH_ERROR', true); ?> ' + err.message; + }); + } +}); +</script> diff --git a/src/packages/com_mokoog/tmpl/tags/index.html b/src/packages/com_mokoog/tmpl/tags/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/com_mokoog/tmpl/tags/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/index.html b/src/packages/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/forms/index.html b/src/packages/plg_content_mokoog/forms/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/forms/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/forms/mokoog.xml b/src/packages/plg_content_mokoog/forms/mokoog.xml index 1e9f026..90be310 100644 --- a/src/packages/plg_content_mokoog/forms/mokoog.xml +++ b/src/packages/plg_content_mokoog/forms/mokoog.xml @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_content_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -50,5 +50,48 @@ <option value="video.other">Video</option> </field> </fieldset> + <fieldset name="mokoog_seo" label="PLG_CONTENT_MOKOOG_FIELDSET_SEO_LABEL" + description="PLG_CONTENT_MOKOOG_FIELDSET_SEO_DESC"> + <field + name="seo_title" + type="text" + label="PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE" + description="PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE_DESC" + filter="string" + maxlength="70" + /> + <field + name="meta_description" + type="textarea" + label="PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION" + description="PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION_DESC" + filter="string" + rows="3" + maxlength="200" + /> + <field + name="robots" + type="list" + label="PLG_CONTENT_MOKOOG_FIELD_ROBOTS" + description="PLG_CONTENT_MOKOOG_FIELD_ROBOTS_DESC" + default="" + multiple="true" + > + <option value="">PLG_CONTENT_MOKOOG_ROBOTS_DEFAULT</option> + <option value="noindex">noindex</option> + <option value="nofollow">nofollow</option> + <option value="nosnippet">nosnippet</option> + <option value="noarchive">noarchive</option> + <option value="noimageindex">noimageindex</option> + </field> + <field + name="canonical_url" + type="url" + label="PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL" + description="PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL_DESC" + filter="url" + validate="url" + /> + </fieldset> </fields> </form> diff --git a/src/packages/plg_content_mokoog/index.html b/src/packages/plg_content_mokoog/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/language/en-GB/index.html b/src/packages/plg_content_mokoog/language/en-GB/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/language/en-GB/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.ini b/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.ini index 6ea916c..1da4c1e 100644 --- a/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.ini +++ b/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.ini @@ -1,4 +1,4 @@ -; MokoOpenGraph - Content Plugin Language File +; MokoJoomOpenGraph - Content Plugin Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later @@ -13,3 +13,16 @@ PLG_CONTENT_MOKOOG_FIELD_OG_IMAGE="OG Image" PLG_CONTENT_MOKOOG_FIELD_OG_IMAGE_DESC="Custom image for social sharing. Recommended: 1200x630px. Leave blank to use the article image." PLG_CONTENT_MOKOOG_FIELD_OG_TYPE="OG Type" PLG_CONTENT_MOKOOG_FIELD_OG_TYPE_DESC="The Open Graph content type for this page." + +PLG_CONTENT_MOKOOG_FIELDSET_SEO_LABEL="SEO Meta Tags" +PLG_CONTENT_MOKOOG_FIELDSET_SEO_DESC="Control search engine meta tags for this page." + +PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE="SEO Title" +PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE_DESC="Custom <title> tag. 50-60 characters recommended. Leave blank to use the default page title." +PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION="Meta Description" +PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION_DESC="Custom meta description. 150-160 characters recommended. Leave blank to use the default." +PLG_CONTENT_MOKOOG_FIELD_ROBOTS="Robots Directive" +PLG_CONTENT_MOKOOG_FIELD_ROBOTS_DESC="Search engine indexing directives for this page. Leave blank for default (index, follow)." +PLG_CONTENT_MOKOOG_ROBOTS_DEFAULT="- Use default (index, follow) -" +PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL="Canonical URL" +PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL_DESC="Override the canonical URL for this page. Leave blank to use the current URL." diff --git a/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.sys.ini b/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.sys.ini index 418df7f..5d16a1b 100644 --- a/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.sys.ini +++ b/src/packages/plg_content_mokoog/language/en-GB/plg_content_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - Content Plugin System Language File +; MokoJoomOpenGraph - Content Plugin System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PLG_CONTENT_MOKOOG="Content - MokoOpenGraph" +PLG_CONTENT_MOKOOG="Content - MokoJoomOpenGraph" PLG_CONTENT_MOKOOG_DESCRIPTION="Adds Open Graph fields to article and menu item edit forms for per-page social sharing control." diff --git a/src/packages/plg_content_mokoog/language/en-US/index.html b/src/packages/plg_content_mokoog/language/en-US/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/language/en-US/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.ini b/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.ini index 6ea916c..1da4c1e 100644 --- a/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.ini +++ b/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.ini @@ -1,4 +1,4 @@ -; MokoOpenGraph - Content Plugin Language File +; MokoJoomOpenGraph - Content Plugin Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later @@ -13,3 +13,16 @@ PLG_CONTENT_MOKOOG_FIELD_OG_IMAGE="OG Image" PLG_CONTENT_MOKOOG_FIELD_OG_IMAGE_DESC="Custom image for social sharing. Recommended: 1200x630px. Leave blank to use the article image." PLG_CONTENT_MOKOOG_FIELD_OG_TYPE="OG Type" PLG_CONTENT_MOKOOG_FIELD_OG_TYPE_DESC="The Open Graph content type for this page." + +PLG_CONTENT_MOKOOG_FIELDSET_SEO_LABEL="SEO Meta Tags" +PLG_CONTENT_MOKOOG_FIELDSET_SEO_DESC="Control search engine meta tags for this page." + +PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE="SEO Title" +PLG_CONTENT_MOKOOG_FIELD_SEO_TITLE_DESC="Custom <title> tag. 50-60 characters recommended. Leave blank to use the default page title." +PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION="Meta Description" +PLG_CONTENT_MOKOOG_FIELD_META_DESCRIPTION_DESC="Custom meta description. 150-160 characters recommended. Leave blank to use the default." +PLG_CONTENT_MOKOOG_FIELD_ROBOTS="Robots Directive" +PLG_CONTENT_MOKOOG_FIELD_ROBOTS_DESC="Search engine indexing directives for this page. Leave blank for default (index, follow)." +PLG_CONTENT_MOKOOG_ROBOTS_DEFAULT="- Use default (index, follow) -" +PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL="Canonical URL" +PLG_CONTENT_MOKOOG_FIELD_CANONICAL_URL_DESC="Override the canonical URL for this page. Leave blank to use the current URL." diff --git a/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.sys.ini b/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.sys.ini index 418df7f..5d16a1b 100644 --- a/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.sys.ini +++ b/src/packages/plg_content_mokoog/language/en-US/plg_content_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - Content Plugin System Language File +; MokoJoomOpenGraph - Content Plugin System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PLG_CONTENT_MOKOOG="Content - MokoOpenGraph" +PLG_CONTENT_MOKOOG="Content - MokoJoomOpenGraph" PLG_CONTENT_MOKOOG_DESCRIPTION="Adds Open Graph fields to article and menu item edit forms for per-page social sharing control." diff --git a/src/packages/plg_content_mokoog/language/index.html b/src/packages/plg_content_mokoog/language/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/language/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/media/css/index.html b/src/packages/plg_content_mokoog/media/css/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/media/css/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/media/css/preview.css b/src/packages/plg_content_mokoog/media/css/preview.css new file mode 100644 index 0000000..0ad41bb --- /dev/null +++ b/src/packages/plg_content_mokoog/media/css/preview.css @@ -0,0 +1,104 @@ +/** + * @package MokoJoomOpenGraph + * @subpackage plg_content_mokoog + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GPL-3.0-or-later + */ + +.mokoog-preview-wrapper { + margin: 15px 0; + padding: 15px; + background: #f8f9fa; + border-radius: 8px; + border: 1px solid #dee2e6; +} + +.mokoog-preview-heading { + margin: 0 0 12px; + font-size: 14px; + color: #666; +} + +.mokoog-platform-label { + display: block; + color: #999; + text-transform: uppercase; + font-size: 11px; + font-weight: 600; + margin-top: 16px; + margin-bottom: 4px; +} + +.mokoog-platform-label:first-of-type { + margin-top: 0; +} + +.mokoog-card { + overflow: hidden; + max-width: 500px; + background: #fff; +} + +.mokoog-card-fb { + border: 1px solid #ddd; + border-radius: 3px; +} + +.mokoog-card-tw { + border: 1px solid #cfd9de; + border-radius: 16px; +} + +.mokoog-card-img { + height: 260px; + background: #e4e6eb center / cover no-repeat; +} + +.mokoog-card-body { + padding: 10px 12px; + border-top: 1px solid #ddd; +} + +.mokoog-card-tw .mokoog-card-body { + border-top-color: #cfd9de; +} + +.mokoog-card-domain { + font-size: 11px; + color: #65676b; + text-transform: uppercase; +} + +.mokoog-card-tw .mokoog-card-domain { + font-size: 13px; + text-transform: none; + margin-top: 4px; +} + +.mokoog-card-title { + font-size: 16px; + font-weight: 600; + color: #1d2129; + margin: 3px 0 2px; + line-height: 1.3; +} + +.mokoog-card-tw .mokoog-card-title { + font-size: 15px; + font-weight: 700; + color: #0f1419; +} + +.mokoog-card-desc { + font-size: 14px; + color: #65676b; + line-height: 1.4; + max-height: 2.8em; + overflow: hidden; +} + +.mokoog-card-tw .mokoog-card-desc { + font-size: 15px; + color: #536471; + margin-top: 2px; +} diff --git a/src/packages/plg_content_mokoog/media/index.html b/src/packages/plg_content_mokoog/media/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/media/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/media/joomla.asset.json b/src/packages/plg_content_mokoog/media/joomla.asset.json new file mode 100644 index 0000000..626a0fc --- /dev/null +++ b/src/packages/plg_content_mokoog/media/joomla.asset.json @@ -0,0 +1,20 @@ +{ + "$schema": "https://developer.joomla.org/schemas/json-schema/web_assets.json", + "name": "plg_content_mokoog", + "version": "01.00.00", + "description": "MokoJoomOpenGraph Content Plugin Assets", + "license": "GPL-3.0-or-later", + "assets": [ + { + "name": "plg_content_mokoog.preview", + "type": "style", + "uri": "plg_content_mokoog/css/preview.css" + }, + { + "name": "plg_content_mokoog.preview", + "type": "script", + "uri": "plg_content_mokoog/js/preview.js", + "dependencies": ["core"] + } + ] +} diff --git a/src/packages/plg_content_mokoog/media/js/index.html b/src/packages/plg_content_mokoog/media/js/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/media/js/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/media/js/preview.js b/src/packages/plg_content_mokoog/media/js/preview.js new file mode 100644 index 0000000..a10c3f1 --- /dev/null +++ b/src/packages/plg_content_mokoog/media/js/preview.js @@ -0,0 +1,170 @@ +/** + * @package MokoJoomOpenGraph + * @subpackage plg_content_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GPL-3.0-or-later + * + * Live social sharing preview for article/menu item editor. + */ +document.addEventListener('DOMContentLoaded', function () { + 'use strict'; + + var fields = { + ogTitle: document.getElementById('jform_mokoog_og_title'), + ogDesc: document.getElementById('jform_mokoog_og_description'), + ogImage: document.getElementById('jform_mokoog_og_image'), + articleTitle: document.getElementById('jform_title'), + metaDesc: document.getElementById('jform_metadesc') + }; + + // Find the mokoog fieldset and insert preview after it + var fieldset = document.querySelector('[data-showon-id="mokoog"]') || + document.getElementById('attrib-mokoog') || + document.querySelector('fieldset.mokoog') || + document.querySelector('[id*="mokoog"]'); + + if (!fieldset) { + return; + } + + // Build preview DOM safely (no innerHTML with user data) + var preview = document.createElement('div'); + preview.id = 'mokoog-preview'; + + var wrapper = document.createElement('div'); + wrapper.className = 'mokoog-preview-wrapper'; + + var heading = document.createElement('h4'); + heading.className = 'mokoog-preview-heading'; + heading.textContent = 'Social Sharing Preview'; + wrapper.appendChild(heading); + + // Facebook preview card + var fbLabel = document.createElement('small'); + fbLabel.className = 'mokoog-platform-label'; + fbLabel.textContent = 'Facebook'; + wrapper.appendChild(fbLabel); + + var fbCard = document.createElement('div'); + fbCard.className = 'mokoog-card mokoog-card-fb'; + + var fbImg = document.createElement('div'); + fbImg.id = 'mokoog-fb-img'; + fbImg.className = 'mokoog-card-img'; + fbCard.appendChild(fbImg); + + var fbBody = document.createElement('div'); + fbBody.className = 'mokoog-card-body'; + + var fbDomain = document.createElement('div'); + fbDomain.id = 'mokoog-fb-domain'; + fbDomain.className = 'mokoog-card-domain'; + fbBody.appendChild(fbDomain); + + var fbTitle = document.createElement('div'); + fbTitle.id = 'mokoog-fb-title'; + fbTitle.className = 'mokoog-card-title'; + fbBody.appendChild(fbTitle); + + var fbDesc = document.createElement('div'); + fbDesc.id = 'mokoog-fb-desc'; + fbDesc.className = 'mokoog-card-desc'; + fbBody.appendChild(fbDesc); + + fbCard.appendChild(fbBody); + wrapper.appendChild(fbCard); + + // Twitter preview card + var twLabel = document.createElement('small'); + twLabel.className = 'mokoog-platform-label'; + twLabel.textContent = 'Twitter / X'; + wrapper.appendChild(twLabel); + + var twCard = document.createElement('div'); + twCard.className = 'mokoog-card mokoog-card-tw'; + + var twImg = document.createElement('div'); + twImg.id = 'mokoog-tw-img'; + twImg.className = 'mokoog-card-img'; + twCard.appendChild(twImg); + + var twBody = document.createElement('div'); + twBody.className = 'mokoog-card-body'; + + var twTitle = document.createElement('div'); + twTitle.id = 'mokoog-tw-title'; + twTitle.className = 'mokoog-card-title'; + twBody.appendChild(twTitle); + + var twDesc = document.createElement('div'); + twDesc.id = 'mokoog-tw-desc'; + twDesc.className = 'mokoog-card-desc'; + twBody.appendChild(twDesc); + + var twDomain = document.createElement('div'); + twDomain.id = 'mokoog-tw-domain'; + twDomain.className = 'mokoog-card-domain'; + twBody.appendChild(twDomain); + + twCard.appendChild(twBody); + wrapper.appendChild(twCard); + + preview.appendChild(wrapper); + fieldset.parentNode.insertBefore(preview, fieldset.nextSibling); + + var domain = window.location.hostname; + + function updatePreview() { + var title = (fields.ogTitle && fields.ogTitle.value) || + (fields.articleTitle && fields.articleTitle.value) || 'Page Title'; + var desc = (fields.ogDesc && fields.ogDesc.value) || + (fields.metaDesc && fields.metaDesc.value) || 'Page description will appear here...'; + var img = ''; + + if (fields.ogImage) { + img = fields.ogImage.value; + } + + if (title.length > 65) title = title.substring(0, 62) + '...'; + if (desc.length > 160) desc = desc.substring(0, 157) + '...'; + + // Facebook + document.getElementById('mokoog-fb-title').textContent = title; + document.getElementById('mokoog-fb-desc').textContent = desc; + document.getElementById('mokoog-fb-domain').textContent = domain; + var fbImgEl = document.getElementById('mokoog-fb-img'); + if (img) { + fbImgEl.style.backgroundImage = 'url(' + encodeURI(img) + ')'; + fbImgEl.style.display = ''; + } else { + fbImgEl.style.display = 'none'; + } + + // Twitter + document.getElementById('mokoog-tw-title').textContent = title; + document.getElementById('mokoog-tw-desc').textContent = desc; + document.getElementById('mokoog-tw-domain').textContent = domain; + var twImgEl = document.getElementById('mokoog-tw-img'); + if (img) { + twImgEl.style.backgroundImage = 'url(' + encodeURI(img) + ')'; + twImgEl.style.display = ''; + } else { + twImgEl.style.display = 'none'; + } + } + + Object.values(fields).forEach(function (el) { + if (el) { + el.addEventListener('input', updatePreview); + el.addEventListener('change', updatePreview); + } + }); + + if (fields.ogImage) { + var observer = new MutationObserver(updatePreview); + observer.observe(fields.ogImage, { attributes: true, attributeFilter: ['value'] }); + } + + updatePreview(); +}); diff --git a/src/packages/plg_content_mokoog/mokoog.php b/src/packages/plg_content_mokoog/mokoog.php index 4800146..0f81e14 100644 --- a/src/packages/plg_content_mokoog/mokoog.php +++ b/src/packages/plg_content_mokoog/mokoog.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_content_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/plg_content_mokoog/mokoog.xml b/src/packages/plg_content_mokoog/mokoog.xml index 651e9ba..1d1e2e1 100644 --- a/src/packages/plg_content_mokoog/mokoog.xml +++ b/src/packages/plg_content_mokoog/mokoog.xml @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_content_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. * @license GNU General Public License version 3 or later; see LICENSE --> <extension type="plugin" group="content" method="upgrade"> - <name>Content - MokoOpenGraph</name> - <version>01.00.00</version> + <name>Content - MokoJoomOpenGraph</name> + <version>01.00.01-dev</version> <creationDate>2026-05-23</creationDate> <author>Moko Consulting</author> <authorEmail>hello@mokoconsulting.tech</authorEmail> @@ -27,6 +27,12 @@ <folder>language</folder> </files> + <media destination="plg_content_mokoog" folder="media"> + <filename>joomla.asset.json</filename> + <folder>js</folder> + <folder>css</folder> + </media> + <languages> <language tag="en-GB">language/en-GB/plg_content_mokoog.ini</language> <language tag="en-GB">language/en-GB/plg_content_mokoog.sys.ini</language> diff --git a/src/packages/plg_content_mokoog/services/index.html b/src/packages/plg_content_mokoog/services/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/services/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/services/provider.php b/src/packages/plg_content_mokoog/services/provider.php index d6f7e90..aca7a7d 100644 --- a/src/packages/plg_content_mokoog/services/provider.php +++ b/src/packages/plg_content_mokoog/services/provider.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_content_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/plg_content_mokoog/src/Extension/MokoOGContent.php b/src/packages/plg_content_mokoog/src/Extension/MokoOGContent.php index 07c1161..7bd1b9b 100644 --- a/src/packages/plg_content_mokoog/src/Extension/MokoOGContent.php +++ b/src/packages/plg_content_mokoog/src/Extension/MokoOGContent.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_content_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -56,10 +56,11 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface $formName = $form->getName(); - // Add OG fields to article and menu item edit forms + // Add OG fields to article, menu item, and category edit forms $supportedForms = [ 'com_content.article', 'com_menus.item', + 'com_categories.categorycom_content', ]; if (!\in_array($formName, $supportedForms, true)) { @@ -71,6 +72,12 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface Form::addFormPath($formPath); $form->loadFile('mokoog', false); + // Load live preview assets + $wa = $this->getApplication()->getDocument()->getWebAssetManager(); + $wa->getRegistry()->addRegistryFile('media/plg_content_mokoog/joomla.asset.json'); + $wa->useStyle('plg_content_mokoog.preview'); + $wa->useScript('plg_content_mokoog.preview'); + // If editing an existing item, load saved OG data $id = 0; @@ -81,8 +88,14 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface } if ($id > 0) { - $contentType = ($formName === 'com_menus.item') ? 'menu' : 'com_content'; - $ogData = $this->loadOgData($contentType, $id); + $formTypeMap = [ + 'com_content.article' => 'com_content', + 'com_menus.item' => 'menu', + 'com_categories.categorycom_content' => 'com_content.category', + ]; + $contentType = $formTypeMap[$formName] ?? 'com_content'; + $language = $this->getContentLanguage($data); + $ogData = $this->loadOgData($contentType, $id, $language); if ($ogData) { $form->bind(['mokoog' => (array) $ogData]); @@ -102,8 +115,9 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface [$context, $article, $isNew] = array_values($event->getArguments()); $supportedContexts = [ - 'com_content.article' => 'com_content', - 'com_menus.item' => 'menu', + 'com_content.article' => 'com_content', + 'com_menus.item' => 'menu', + 'com_categories.categorycom_content' => 'com_content.category', ]; if (!isset($supportedContexts[$context])) { @@ -119,6 +133,7 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface $contentType = $supportedContexts[$context]; $contentId = (int) $article->id; + $language = $this->getContentLanguage($article); $input = $app->getInput(); $jform = $input->get('jform', [], 'array'); @@ -128,7 +143,7 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface return; } - $this->saveOgData($contentType, $contentId, $ogData); + $this->saveOgData($contentType, $contentId, $ogData, $language); } /** @@ -143,8 +158,9 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface [$context, $article] = array_values($event->getArguments()); $supportedContexts = [ - 'com_content.article' => 'com_content', - 'com_menus.item' => 'menu', + 'com_content.article' => 'com_content', + 'com_menus.item' => 'menu', + 'com_categories.categorycom_content' => 'com_content.category', ]; if (!isset($supportedContexts[$context])) { @@ -165,23 +181,30 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface } /** - * Load existing OG data for a content item. + * Load existing OG data for a content item, filtered by language. * * @param string $contentType Content type identifier * @param int $contentId Content ID + * @param string $language Language tag (e.g. 'en-GB') or '*' for all * * @return object|null */ - private function loadOgData(string $contentType, int $contentId): ?object + private function loadOgData(string $contentType, int $contentId, string $language = '*'): ?object { $db = Factory::getDbo(); $query = $db->getQuery(true) - ->select($db->quoteName(['og_title', 'og_description', 'og_image', 'og_type'])) + ->select($db->quoteName([ + 'og_title', 'og_description', 'og_image', 'og_type', + 'seo_title', 'meta_description', 'robots', 'canonical_url', + ])) ->from($db->quoteName('#__mokoog_tags')) ->where($db->quoteName('content_type') . ' = ' . $db->quote($contentType)) - ->where($db->quoteName('content_id') . ' = ' . $contentId); + ->where($db->quoteName('content_id') . ' = ' . $contentId) + ->where('(' . $db->quoteName('language') . ' = ' . $db->quote($language) + . ' OR ' . $db->quoteName('language') . ' = ' . $db->quote('*') . ')') + ->order('CASE WHEN ' . $db->quoteName('language') . ' = ' . $db->quote('*') . ' THEN 1 ELSE 0 END ASC'); - $db->setQuery($query); + $db->setQuery($query, 0, 1); return $db->loadObject(); } @@ -192,32 +215,46 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface * @param string $contentType Content type identifier * @param int $contentId Content ID * @param array $ogData OG field values + * @param string $language Language tag (e.g. 'en-GB') or '*' for all * * @return void */ - private function saveOgData(string $contentType, int $contentId, array $ogData): void + private function saveOgData(string $contentType, int $contentId, array $ogData, string $language = '*'): void { $db = Factory::getDbo(); - // Check if record exists + // Check if record exists for this content + language $query = $db->getQuery(true) ->select('id') ->from($db->quoteName('#__mokoog_tags')) ->where($db->quoteName('content_type') . ' = ' . $db->quote($contentType)) - ->where($db->quoteName('content_id') . ' = ' . $contentId); + ->where($db->quoteName('content_id') . ' = ' . $contentId) + ->where($db->quoteName('language') . ' = ' . $db->quote($language)); $db->setQuery($query); $existingId = $db->loadResult(); + // Robots may come as array from multi-select, join with comma + $robots = $ogData['robots'] ?? ''; + + if (\is_array($robots)) { + $robots = implode(', ', array_filter($robots)); + } + $record = (object) [ - 'content_type' => $contentType, - 'content_id' => $contentId, - 'og_title' => trim($ogData['og_title'] ?? ''), - 'og_description' => trim($ogData['og_description'] ?? ''), - 'og_image' => trim($ogData['og_image'] ?? ''), - 'og_type' => trim($ogData['og_type'] ?? 'article'), - 'published' => 1, - 'modified' => Factory::getDate()->toSql(), + 'content_type' => $contentType, + 'content_id' => $contentId, + 'language' => $language, + 'og_title' => trim($ogData['og_title'] ?? ''), + 'og_description' => trim($ogData['og_description'] ?? ''), + 'og_image' => trim($ogData['og_image'] ?? ''), + 'og_type' => trim($ogData['og_type'] ?? 'article'), + 'seo_title' => trim($ogData['seo_title'] ?? ''), + 'meta_description' => trim($ogData['meta_description'] ?? ''), + 'robots' => trim($robots), + 'canonical_url' => trim($ogData['canonical_url'] ?? ''), + 'published' => 1, + 'modified' => Factory::getDate()->toSql(), ]; if ($existingId) { @@ -228,4 +265,24 @@ final class MokoOGContent extends CMSPlugin implements SubscriberInterface $db->insertObject('#__mokoog_tags', $record); } } + + /** + * Extract the language tag from content data. + * + * @param object|array $data Content data from form or article object + * + * @return string Language tag (e.g. 'en-GB') or '*' for all languages + */ + private function getContentLanguage($data): string + { + $language = '*'; + + if (\is_object($data) && isset($data->language)) { + $language = $data->language; + } elseif (\is_array($data) && isset($data['language'])) { + $language = $data['language']; + } + + return !empty($language) ? $language : '*'; + } } diff --git a/src/packages/plg_content_mokoog/src/Extension/index.html b/src/packages/plg_content_mokoog/src/Extension/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/src/Extension/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/src/Field/index.html b/src/packages/plg_content_mokoog/src/Field/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/src/Field/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_content_mokoog/src/index.html b/src/packages/plg_content_mokoog/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_content_mokoog/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/index.html b/src/packages/plg_system_mokoog/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/language/en-GB/index.html b/src/packages/plg_system_mokoog/language/en-GB/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/language/en-GB/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.ini b/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.ini index 4983711..3d1c0f6 100644 --- a/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.ini +++ b/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.ini @@ -1,4 +1,4 @@ -; MokoOpenGraph - System Plugin Language File +; MokoJoomOpenGraph - System Plugin Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later @@ -7,6 +7,10 @@ PLG_SYSTEM_MOKOOG_FIELDSET_ADVANCED="Advanced Settings" PLG_SYSTEM_MOKOOG_FIELD_SITE_NAME="Site Name" PLG_SYSTEM_MOKOOG_FIELD_SITE_NAME_DESC="The og:site_name value. Leave blank to use the Joomla site name." +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE="Default OG Title" +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE_DESC="Site-wide fallback title for social sharing. Used when a page has no custom OG title. Leave blank to use the page title." +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION="Default OG Description" +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION_DESC="Site-wide fallback description for social sharing. Used when a page has no custom OG description and no meta description. Leave blank to auto-generate from page content." PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_IMAGE="Default Image" PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_IMAGE_DESC="Fallback image used when no article or page image is found." PLG_SYSTEM_MOKOOG_FIELD_TWITTER_CARD="Twitter Card Type" @@ -17,9 +21,19 @@ PLG_SYSTEM_MOKOOG_FIELD_TWITTER_SITE="Twitter @username" PLG_SYSTEM_MOKOOG_FIELD_TWITTER_SITE_DESC="Your site's Twitter handle (e.g. @mokoconsulting)." PLG_SYSTEM_MOKOOG_FIELD_FB_APP_ID="Facebook App ID" PLG_SYSTEM_MOKOOG_FIELD_FB_APP_ID_DESC="Your Facebook App ID for fb:app_id meta tag." +PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR="Discord Embed Color" +PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR_DESC="The color of the embed sidebar when shared on Discord. Sets the theme-color meta tag. Leave blank to use Discord defaults." PLG_SYSTEM_MOKOOG_FIELD_AUTO_GENERATE="Auto-generate Tags" PLG_SYSTEM_MOKOOG_FIELD_AUTO_GENERATE_DESC="Automatically generate OG tags from article content when no custom tags are set." PLG_SYSTEM_MOKOOG_FIELD_STRIP_HTML="Strip HTML from Description" PLG_SYSTEM_MOKOOG_FIELD_STRIP_HTML_DESC="Remove HTML tags from the auto-generated description." PLG_SYSTEM_MOKOOG_FIELD_DESC_LENGTH="Description Length" PLG_SYSTEM_MOKOOG_FIELD_DESC_LENGTH_DESC="Maximum character length for the auto-generated og:description." +PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL="Telegram Channel" +PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL_DESC="Your Telegram channel handle (e.g. @mokoconsulting). Outputs a telegram:channel meta tag for Telegram link previews." +PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE="Auto-resize Images" +PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE_DESC="Automatically resize images to 1200x630px (Facebook recommended) using center crop. Generated images are saved to images/mokoog/generated/." +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED="Enable JSON-LD" +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED_DESC="Output JSON-LD structured data (Article, WebPage) for Google rich results." +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS="JSON-LD Breadcrumbs" +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS_DESC="Output BreadcrumbList JSON-LD schema from Joomla's pathway." diff --git a/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.sys.ini b/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.sys.ini index 51efd5f..2a356e2 100644 --- a/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.sys.ini +++ b/src/packages/plg_system_mokoog/language/en-GB/plg_system_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - System Plugin System Language File +; MokoJoomOpenGraph - System Plugin System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PLG_SYSTEM_MOKOOG="System - MokoOpenGraph" +PLG_SYSTEM_MOKOOG="System - MokoJoomOpenGraph" PLG_SYSTEM_MOKOOG_DESCRIPTION="Injects Open Graph and Twitter Card meta tags into every page for optimal social media sharing previews." diff --git a/src/packages/plg_system_mokoog/language/en-US/index.html b/src/packages/plg_system_mokoog/language/en-US/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/language/en-US/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.ini b/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.ini index 4983711..3d1c0f6 100644 --- a/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.ini +++ b/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.ini @@ -1,4 +1,4 @@ -; MokoOpenGraph - System Plugin Language File +; MokoJoomOpenGraph - System Plugin Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later @@ -7,6 +7,10 @@ PLG_SYSTEM_MOKOOG_FIELDSET_ADVANCED="Advanced Settings" PLG_SYSTEM_MOKOOG_FIELD_SITE_NAME="Site Name" PLG_SYSTEM_MOKOOG_FIELD_SITE_NAME_DESC="The og:site_name value. Leave blank to use the Joomla site name." +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE="Default OG Title" +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE_DESC="Site-wide fallback title for social sharing. Used when a page has no custom OG title. Leave blank to use the page title." +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION="Default OG Description" +PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION_DESC="Site-wide fallback description for social sharing. Used when a page has no custom OG description and no meta description. Leave blank to auto-generate from page content." PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_IMAGE="Default Image" PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_IMAGE_DESC="Fallback image used when no article or page image is found." PLG_SYSTEM_MOKOOG_FIELD_TWITTER_CARD="Twitter Card Type" @@ -17,9 +21,19 @@ PLG_SYSTEM_MOKOOG_FIELD_TWITTER_SITE="Twitter @username" PLG_SYSTEM_MOKOOG_FIELD_TWITTER_SITE_DESC="Your site's Twitter handle (e.g. @mokoconsulting)." PLG_SYSTEM_MOKOOG_FIELD_FB_APP_ID="Facebook App ID" PLG_SYSTEM_MOKOOG_FIELD_FB_APP_ID_DESC="Your Facebook App ID for fb:app_id meta tag." +PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR="Discord Embed Color" +PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR_DESC="The color of the embed sidebar when shared on Discord. Sets the theme-color meta tag. Leave blank to use Discord defaults." PLG_SYSTEM_MOKOOG_FIELD_AUTO_GENERATE="Auto-generate Tags" PLG_SYSTEM_MOKOOG_FIELD_AUTO_GENERATE_DESC="Automatically generate OG tags from article content when no custom tags are set." PLG_SYSTEM_MOKOOG_FIELD_STRIP_HTML="Strip HTML from Description" PLG_SYSTEM_MOKOOG_FIELD_STRIP_HTML_DESC="Remove HTML tags from the auto-generated description." PLG_SYSTEM_MOKOOG_FIELD_DESC_LENGTH="Description Length" PLG_SYSTEM_MOKOOG_FIELD_DESC_LENGTH_DESC="Maximum character length for the auto-generated og:description." +PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL="Telegram Channel" +PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL_DESC="Your Telegram channel handle (e.g. @mokoconsulting). Outputs a telegram:channel meta tag for Telegram link previews." +PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE="Auto-resize Images" +PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE_DESC="Automatically resize images to 1200x630px (Facebook recommended) using center crop. Generated images are saved to images/mokoog/generated/." +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED="Enable JSON-LD" +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED_DESC="Output JSON-LD structured data (Article, WebPage) for Google rich results." +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS="JSON-LD Breadcrumbs" +PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS_DESC="Output BreadcrumbList JSON-LD schema from Joomla's pathway." diff --git a/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.sys.ini b/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.sys.ini index 51efd5f..2a356e2 100644 --- a/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.sys.ini +++ b/src/packages/plg_system_mokoog/language/en-US/plg_system_mokoog.sys.ini @@ -1,6 +1,6 @@ -; MokoOpenGraph - System Plugin System Language File +; MokoJoomOpenGraph - System Plugin System Language File ; Copyright (C) 2026 Moko Consulting. All rights reserved. ; License: GPL-3.0-or-later -PLG_SYSTEM_MOKOOG="System - MokoOpenGraph" +PLG_SYSTEM_MOKOOG="System - MokoJoomOpenGraph" PLG_SYSTEM_MOKOOG_DESCRIPTION="Injects Open Graph and Twitter Card meta tags into every page for optimal social media sharing previews." diff --git a/src/packages/plg_system_mokoog/language/index.html b/src/packages/plg_system_mokoog/language/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/language/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/mokoog.php b/src/packages/plg_system_mokoog/mokoog.php index 47d238c..bfc5577 100644 --- a/src/packages/plg_system_mokoog/mokoog.php +++ b/src/packages/plg_system_mokoog/mokoog.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_system_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/plg_system_mokoog/mokoog.xml b/src/packages/plg_system_mokoog/mokoog.xml index 50a2120..2b1246f 100644 --- a/src/packages/plg_system_mokoog/mokoog.xml +++ b/src/packages/plg_system_mokoog/mokoog.xml @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_system_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. * @license GNU General Public License version 3 or later; see LICENSE --> <extension type="plugin" group="system" method="upgrade"> - <name>System - MokoOpenGraph</name> - <version>01.00.00</version> + <name>System - MokoJoomOpenGraph</name> + <version>01.00.01-dev</version> <creationDate>2026-05-23</creationDate> <author>Moko Consulting</author> <authorEmail>hello@mokoconsulting.tech</authorEmail> @@ -41,6 +41,23 @@ description="PLG_SYSTEM_MOKOOG_FIELD_SITE_NAME_DESC" default="" /> + <field + name="default_og_title" + type="text" + label="PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE" + description="PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_TITLE_DESC" + default="" + filter="string" + /> + <field + name="default_og_description" + type="textarea" + label="PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION" + description="PLG_SYSTEM_MOKOOG_FIELD_DEFAULT_OG_DESCRIPTION_DESC" + default="" + filter="string" + rows="3" + /> <field name="default_image" type="media" @@ -74,6 +91,21 @@ default="" filter="string" /> + <field + name="telegram_channel" + type="text" + label="PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL" + description="PLG_SYSTEM_MOKOOG_FIELD_TELEGRAM_CHANNEL_DESC" + default="" + filter="string" + /> + <field + name="discord_color" + type="color" + label="PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR" + description="PLG_SYSTEM_MOKOOG_FIELD_DISCORD_COLOR_DESC" + default="" + /> </fieldset> <fieldset name="advanced" label="PLG_SYSTEM_MOKOOG_FIELDSET_ADVANCED"> <field @@ -107,6 +139,39 @@ min="50" max="300" /> + <field + name="auto_resize" + type="radio" + label="PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE" + description="PLG_SYSTEM_MOKOOG_FIELD_AUTO_RESIZE_DESC" + default="1" + class="btn-group" + > + <option value="1">JYES</option> + <option value="0">JNO</option> + </field> + <field + name="jsonld_enabled" + type="radio" + label="PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED" + description="PLG_SYSTEM_MOKOOG_FIELD_JSONLD_ENABLED_DESC" + default="1" + class="btn-group" + > + <option value="1">JYES</option> + <option value="0">JNO</option> + </field> + <field + name="jsonld_breadcrumbs" + type="radio" + label="PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS" + description="PLG_SYSTEM_MOKOOG_FIELD_JSONLD_BREADCRUMBS_DESC" + default="1" + class="btn-group" + > + <option value="1">JYES</option> + <option value="0">JNO</option> + </field> </fieldset> </fields> </config> diff --git a/src/packages/plg_system_mokoog/services/index.html b/src/packages/plg_system_mokoog/services/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/services/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/services/provider.php b/src/packages/plg_system_mokoog/services/provider.php index 2650be2..390b1d3 100644 --- a/src/packages/plg_system_mokoog/services/provider.php +++ b/src/packages/plg_system_mokoog/services/provider.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_system_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. diff --git a/src/packages/plg_system_mokoog/src/Extension/MokoOG.php b/src/packages/plg_system_mokoog/src/Extension/MokoOG.php index 818e263..0b68cc7 100644 --- a/src/packages/plg_system_mokoog/src/Extension/MokoOG.php +++ b/src/packages/plg_system_mokoog/src/Extension/MokoOG.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @subpackage plg_system_mokoog * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. @@ -17,6 +17,8 @@ use Joomla\CMS\Plugin\CMSPlugin; use Joomla\CMS\Uri\Uri; use Joomla\Event\Event; use Joomla\Event\SubscriberInterface; +use Joomla\Plugin\System\MokoOG\Helper\ImageHelper; +use Joomla\Plugin\System\MokoOG\Helper\JsonLdBuilder; final class MokoOG extends CMSPlugin implements SubscriberInterface { @@ -67,9 +69,29 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface // Try to load custom OG data from the database $ogData = $this->loadOgData($option, $view, $id); - // Build tag values — custom overrides auto-generated - $title = $ogData->og_title ?: $doc->getTitle(); - $description = $ogData->og_description ?: $this->buildDescription($doc); + // For category views, also try category-level OG data as fallback + if ($option === 'com_content' && $view === 'category' && $id > 0) { + $catOg = $this->loadOgDataByType('com_content.category', $id); + + if ($catOg) { + // Merge: category fills any gaps in the content-level data + foreach (['og_title', 'og_description', 'og_image', 'og_type', 'seo_title', 'meta_description', 'robots', 'canonical_url'] as $field) { + if (empty($ogData->$field) && !empty($catOg->$field)) { + $ogData->$field = $catOg->$field; + } + } + } + } + + // --- SEO meta tags (set first, before OG) --- + $this->applySeoTags($doc, $ogData); + + // Build tag values — custom OG data → site-wide defaults → auto-generated + $defaultTitle = $this->params->get('default_og_title', ''); + $defaultDesc = $this->params->get('default_og_description', ''); + + $title = $ogData->og_title ?: ($doc->getTitle() ?: $defaultTitle); + $description = $ogData->og_description ?: ($this->buildDescription($doc) ?: $defaultDesc); $image = $ogData->og_image ?: $this->findImage($option, $view, $id); $url = Uri::getInstance()->toString(); $siteName = $this->params->get('og_site_name', $app->get('sitename', '')); @@ -85,8 +107,17 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface if ($image) { $imageUrl = $this->resolveImageUrl($image); $doc->setMetaData('og:image', $imageUrl, 'property'); + + // Image dimensions help Facebook, LinkedIn, and Discord render previews faster + $doc->setMetaData('og:image:width', '1200', 'property'); + $doc->setMetaData('og:image:height', '630', 'property'); } + // og:locale from current language + $langTag = Factory::getLanguage()->getTag(); + $ogLocale = str_replace('-', '_', $langTag); + $doc->setMetaData('og:locale', $ogLocale, 'property'); + // Facebook App ID $fbAppId = $this->params->get('fb_app_id', ''); @@ -109,6 +140,107 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface if ($twitterSite) { $doc->setMetaData('twitter:site', $twitterSite); } + + // Telegram channel tag + $telegramChannel = $this->params->get('telegram_channel', ''); + + if ($telegramChannel) { + $doc->setMetaData('telegram:channel', $telegramChannel); + } + + // Discord embed color (theme-color meta tag) + $discordColor = $this->params->get('discord_color', ''); + + if ($discordColor) { + $doc->setMetaData('theme-color', $discordColor); + } + + // LinkedIn article tags + if ($option === 'com_content' && $view === 'article' && $id > 0) { + $doc->setMetaData('article:published_time', $this->getArticleDate($id, 'publish_up'), 'property'); + $doc->setMetaData('article:modified_time', $this->getArticleDate($id, 'modified'), 'property'); + + $author = $this->getArticleAuthor($id); + + if ($author) { + $doc->setMetaData('article:author', $author, 'property'); + } + } + + // Fire event so third-party plugins can add custom OG/social tags + $eventData = [ + 'subject' => $doc, + 'title' => $title, + 'description' => $description, + 'image' => $image ? $this->resolveImageUrl($image) : '', + 'url' => $url, + 'type' => $type, + 'option' => $option, + 'view' => $view, + 'id' => $id, + ]; + $app->getDispatcher()->dispatch('onMokoOGAfterRender', new Event('onMokoOGAfterRender', $eventData)); + + // JSON-LD structured data + if ($this->params->get('jsonld_enabled', 1)) { + $imageUrl = $image ? $this->resolveImageUrl($image) : ''; + + if ($option === 'com_content' && $view === 'article' && $id > 0) { + $schema = JsonLdBuilder::buildArticle($id, $title, $description, $imageUrl); + } else { + $schema = JsonLdBuilder::buildWebPage($title, $description); + } + + if ($schema) { + $doc->addCustomTag(JsonLdBuilder::toScriptTag($schema)); + } + + if ($this->params->get('jsonld_breadcrumbs', 1)) { + $breadcrumbs = JsonLdBuilder::buildBreadcrumbs(); + + if ($breadcrumbs) { + $doc->addCustomTag(JsonLdBuilder::toScriptTag($breadcrumbs)); + } + } + } + } + + /** + * Apply SEO meta tags (title, description, robots, canonical) to the document. + * + * @param \Joomla\CMS\Document\HtmlDocument $doc The document + * @param object $ogData The loaded OG/SEO data + * + * @return void + */ + private function applySeoTags($doc, object $ogData): void + { + // Custom SEO title overrides the page <title> + if (!empty($ogData->seo_title)) { + $doc->setTitle($ogData->seo_title); + } + + // Custom meta description + if (!empty($ogData->meta_description)) { + $doc->setDescription($ogData->meta_description); + } + + // Robots directive + if (!empty($ogData->robots)) { + $doc->setMetaData('robots', $ogData->robots); + } + + // Canonical URL + if (!empty($ogData->canonical_url)) { + // Remove any existing canonical link first + foreach ($doc->_links as $link => $attribs) { + if (isset($attribs['relation']) && $attribs['relation'] === 'canonical') { + unset($doc->_links[$link]); + } + } + + $doc->addHeadLink($ogData->canonical_url, 'canonical'); + } } /** @@ -123,10 +255,14 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface private function loadOgData(string $option, string $view, int $id): object { $empty = (object) [ - 'og_title' => '', - 'og_description' => '', - 'og_image' => '', - 'og_type' => '', + 'og_title' => '', + 'og_description' => '', + 'og_image' => '', + 'og_type' => '', + 'seo_title' => '', + 'meta_description' => '', + 'robots' => '', + 'canonical_url' => '', ]; if (!$id) { @@ -146,11 +282,37 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface ->from($db->quoteName('#__mokoog_tags')) ->where($db->quoteName('content_type') . ' = ' . $db->quote($option)) ->where($db->quoteName('content_id') . ' = ' . (int) $id) + ->where($db->quoteName('published') . ' = 1') + ->where('(' . $db->quoteName('language') . ' = ' . $db->quote(Factory::getLanguage()->getTag()) + . ' OR ' . $db->quoteName('language') . ' = ' . $db->quote('*') . ')') + ->order('CASE WHEN ' . $db->quoteName('language') . ' = ' . $db->quote('*') . ' THEN 1 ELSE 0 END ASC'); + + $db->setQuery($query, 0, 1); + + return $db->loadObject() ?: $empty; + } + + /** + * Load OG data by content type and ID. + * + * @param string $contentType Content type identifier + * @param int $contentId Content ID + * + * @return object|null + */ + private function loadOgDataByType(string $contentType, int $contentId): ?object + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select('*') + ->from($db->quoteName('#__mokoog_tags')) + ->where($db->quoteName('content_type') . ' = ' . $db->quote($contentType)) + ->where($db->quoteName('content_id') . ' = ' . $contentId) ->where($db->quoteName('published') . ' = 1'); $db->setQuery($query); - return $db->loadObject() ?: $empty; + return $db->loadObject(); } /** @@ -237,13 +399,33 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface return $imagesData['image_intro']; } } + + // Fallback: check the article's category for an image + if ($view === 'article') { + $catQuery = $db->getQuery(true) + ->select($db->quoteName('cat.params')) + ->from($db->quoteName('#__categories', 'cat')) + ->join('INNER', $db->quoteName('#__content', 'a') . ' ON ' . $db->quoteName('a.catid') . ' = ' . $db->quoteName('cat.id')) + ->where($db->quoteName('a.id') . ' = ' . (int) $id); + + $db->setQuery($catQuery); + $catParams = $db->loadResult(); + + if ($catParams) { + $catData = json_decode($catParams, true); + + if (!empty($catData['image'])) { + return $catData['image']; + } + } + } } return $this->params->get('default_image', ''); } /** - * Resolve a relative image path to a full URL. + * Resolve a relative image path to a full URL, resizing for OG if needed. * * @param string $image Image path * @@ -255,6 +437,54 @@ final class MokoOG extends CMSPlugin implements SubscriberInterface return $image; } + // Auto-resize to OG recommended dimensions if enabled + if ($this->params->get('auto_resize', 1)) { + $image = ImageHelper::resize($image); + } + return rtrim(Uri::root(), '/') . '/' . ltrim($image, '/'); } + + /** + * Get a date field from an article. + * + * @param int $id Article ID + * @param string $field Date field name (publish_up, modified, created) + * + * @return string ISO 8601 date string + */ + private function getArticleDate(int $id, string $field): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName($field)) + ->from($db->quoteName('#__content')) + ->where($db->quoteName('id') . ' = ' . $id); + + $db->setQuery($query); + $date = $db->loadResult(); + + return $date ?: ''; + } + + /** + * Get the author name for an article. + * + * @param int $id Article ID + * + * @return string + */ + private function getArticleAuthor(int $id): string + { + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName('u.name')) + ->from($db->quoteName('#__content', 'a')) + ->join('LEFT', $db->quoteName('#__users', 'u') . ' ON ' . $db->quoteName('u.id') . ' = ' . $db->quoteName('a.created_by')) + ->where($db->quoteName('a.id') . ' = ' . $id); + + $db->setQuery($query); + + return $db->loadResult() ?: ''; + } } diff --git a/src/packages/plg_system_mokoog/src/Extension/index.html b/src/packages/plg_system_mokoog/src/Extension/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/src/Extension/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/src/Helper/ImageGenerator.php b/src/packages/plg_system_mokoog/src/Helper/ImageGenerator.php new file mode 100644 index 0000000..ece760e --- /dev/null +++ b/src/packages/plg_system_mokoog/src/Helper/ImageGenerator.php @@ -0,0 +1,160 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_system_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Plugin\System\MokoOG\Helper; + +defined('_JEXEC') or die; + +use Joomla\CMS\Filesystem\Folder; + +class ImageGenerator +{ + private const WIDTH = 1200; + private const HEIGHT = 630; + private const OUTPUT_DIR = 'images/mokoog/generated'; + + /** + * Generate an OG image with title text overlaid on a template background. + * + * @param string $title Article title to overlay + * @param string $templateImage Path to template/background image relative to JPATH_ROOT + * @param string $fontFile Absolute path to TTF font file + * @param int $fontSize Font size in points (default 42) + * @param array $fontColor RGB array [r, g, b] (default white) + * @param int $quality JPEG quality (default 90) + * + * @return string Path to generated image relative to JPATH_ROOT, or empty on failure + */ + public static function generate( + string $title, + string $templateImage, + string $fontFile = '', + int $fontSize = 42, + array $fontColor = [255, 255, 255], + int $quality = 90 + ): string { + $templateAbs = JPATH_ROOT . '/' . ltrim($templateImage, '/'); + + if (!is_file($templateAbs)) { + return ''; + } + + if (!$fontFile || !is_file($fontFile)) { + return ''; + } + + $outputDir = JPATH_ROOT . '/' . self::OUTPUT_DIR; + + if (!is_dir($outputDir)) { + Folder::create($outputDir); + } + + $hash = md5($title . $templateImage . $fontSize); + $outputName = 'overlay_' . $hash . '.jpg'; + $outputPath = $outputDir . '/' . $outputName; + $outputRel = self::OUTPUT_DIR . '/' . $outputName; + + // Skip if already generated + if (is_file($outputPath)) { + return $outputRel; + } + + // Load template image + $imageInfo = @getimagesize($templateAbs); + + if (!$imageInfo) { + return ''; + } + + $source = match ($imageInfo[2]) { + IMAGETYPE_JPEG => @imagecreatefromjpeg($templateAbs), + IMAGETYPE_PNG => @imagecreatefrompng($templateAbs), + IMAGETYPE_WEBP => @imagecreatefromwebp($templateAbs), + default => false, + }; + + if (!$source) { + return ''; + } + + // Create output canvas at target dimensions + $canvas = imagecreatetruecolor(self::WIDTH, self::HEIGHT); + + imagecopyresampled( + $canvas, + $source, + 0, 0, 0, 0, + self::WIDTH, self::HEIGHT, + $imageInfo[0], $imageInfo[1] + ); + + imagedestroy($source); + + // Semi-transparent overlay for text readability + $overlay = imagecolorallocatealpha($canvas, 0, 0, 0, 64); + imagefilledrectangle($canvas, 0, (int) (self::HEIGHT * 0.55), self::WIDTH, self::HEIGHT, $overlay); + + // Render title text with word wrapping + $textColor = imagecolorallocate($canvas, $fontColor[0], $fontColor[1], $fontColor[2]); + $wrappedTitle = self::wrapText($title, $fontFile, $fontSize, (int) (self::WIDTH * 0.85)); + $textX = (int) (self::WIDTH * 0.075); + $textY = (int) (self::HEIGHT * 0.72); + + imagettftext($canvas, $fontSize, 0, $textX, $textY, $textColor, $fontFile, $wrappedTitle); + + // Save + imagejpeg($canvas, $outputPath, $quality); + imagedestroy($canvas); + + return $outputRel; + } + + /** + * Wrap text to fit within a maximum pixel width. + * + * @param string $text Text to wrap + * @param string $fontFile Path to TTF font + * @param int $fontSize Font size in points + * @param int $maxWidth Maximum width in pixels + * + * @return string Wrapped text with newlines + */ + private static function wrapText(string $text, string $fontFile, int $fontSize, int $maxWidth): string + { + $words = explode(' ', $text); + $lines = []; + $line = ''; + + foreach ($words as $word) { + $testLine = $line ? $line . ' ' . $word : $word; + $bbox = imagettfbbox($fontSize, 0, $fontFile, $testLine); + $lineWidth = abs($bbox[4] - $bbox[0]); + + if ($lineWidth > $maxWidth && $line !== '') { + $lines[] = $line; + $line = $word; + } else { + $line = $testLine; + } + } + + if ($line !== '') { + $lines[] = $line; + } + + // Limit to 3 lines, truncate last line if needed + if (\count($lines) > 3) { + $lines = \array_slice($lines, 0, 3); + $lines[2] = mb_substr($lines[2], 0, -3) . '...'; + } + + return implode("\n", $lines); + } +} diff --git a/src/packages/plg_system_mokoog/src/Helper/ImageHelper.php b/src/packages/plg_system_mokoog/src/Helper/ImageHelper.php new file mode 100644 index 0000000..3ea0325 --- /dev/null +++ b/src/packages/plg_system_mokoog/src/Helper/ImageHelper.php @@ -0,0 +1,222 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_system_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Plugin\System\MokoOG\Helper; + +defined('_JEXEC') or die; + +use Joomla\CMS\Filesystem\File; +use Joomla\CMS\Filesystem\Folder; + +class ImageHelper +{ + /** + * Target width for OG images (Facebook recommended). + */ + private const TARGET_WIDTH = 1200; + + /** + * Target height for OG images (Facebook recommended). + */ + private const TARGET_HEIGHT = 630; + + /** + * JPEG quality for generated images. + */ + private const JPEG_QUALITY = 85; + + /** + * Output directory relative to JPATH_ROOT. + */ + private const OUTPUT_DIR = 'images/mokoog/generated'; + + /** + * Resize an image to OG-optimized dimensions if needed. + * + * Returns the path to the resized image relative to JPATH_ROOT, + * or the original path if no resize was needed or possible. + * + * @param string $imagePath Image path relative to JPATH_ROOT + * @param int $targetWidth Target width (default 1200) + * @param int $targetHeight Target height (default 630) + * @param int $quality JPEG quality 1-100 (default 85) + * + * @return string Path to the output image (relative to JPATH_ROOT) + */ + public static function resize( + string $imagePath, + int $targetWidth = self::TARGET_WIDTH, + int $targetHeight = self::TARGET_HEIGHT, + int $quality = self::JPEG_QUALITY + ): string { + // Resolve absolute path + $absPath = JPATH_ROOT . '/' . ltrim($imagePath, '/'); + + if (!is_file($absPath)) { + return $imagePath; + } + + $imageInfo = @getimagesize($absPath); + + if (!$imageInfo) { + return $imagePath; + } + + [$origWidth, $origHeight, $type] = $imageInfo; + + // Skip if already at or below target size + if ($origWidth <= $targetWidth && $origHeight <= $targetHeight) { + return $imagePath; + } + + // Ensure output directory exists + $outputDir = JPATH_ROOT . '/' . self::OUTPUT_DIR; + + if (!is_dir($outputDir)) { + Folder::create($outputDir); + } + + // Generate output filename based on source hash + dimensions + $hash = md5($imagePath . $targetWidth . $targetHeight); + $outputName = $hash . '.jpg'; + $outputPath = $outputDir . '/' . $outputName; + $outputRel = self::OUTPUT_DIR . '/' . $outputName; + + // Skip if already generated + if (is_file($outputPath) && filemtime($outputPath) >= filemtime($absPath)) { + return $outputRel; + } + + // Load source image + $source = self::loadImage($absPath, $type); + + if (!$source) { + return $imagePath; + } + + // Calculate crop dimensions (center crop to target aspect ratio) + $targetRatio = $targetWidth / $targetHeight; + $sourceRatio = $origWidth / $origHeight; + + if ($sourceRatio > $targetRatio) { + // Source is wider — crop sides + $cropHeight = $origHeight; + $cropWidth = (int) round($origHeight * $targetRatio); + $cropX = (int) round(($origWidth - $cropWidth) / 2); + $cropY = 0; + } else { + // Source is taller — crop top/bottom + $cropWidth = $origWidth; + $cropHeight = (int) round($origWidth / $targetRatio); + $cropX = 0; + $cropY = (int) round(($origHeight - $cropHeight) / 2); + } + + // Create output canvas and resample + $output = imagecreatetruecolor($targetWidth, $targetHeight); + + imagecopyresampled( + $output, + $source, + 0, + 0, + $cropX, + $cropY, + $targetWidth, + $targetHeight, + $cropWidth, + $cropHeight + ); + + // Save as JPEG + imagejpeg($output, $outputPath, $quality); + + imagedestroy($source); + imagedestroy($output); + + return $outputRel; + } + + /** + * Remove a generated image file. + * + * @param string $generatedPath Path relative to JPATH_ROOT + * + * @return void + */ + public static function cleanup(string $generatedPath): void + { + if (empty($generatedPath) || !str_starts_with($generatedPath, self::OUTPUT_DIR)) { + return; + } + + $absPath = JPATH_ROOT . '/' . $generatedPath; + + if (is_file($absPath)) { + File::delete($absPath); + } + } + + /** + * Check if an image meets minimum OG size requirements. + * + * @param string $imagePath Image path relative to JPATH_ROOT + * + * @return array{valid: bool, width: int, height: int, message: string} + */ + public static function validate(string $imagePath): array + { + $absPath = JPATH_ROOT . '/' . ltrim($imagePath, '/'); + + if (!is_file($absPath)) { + return ['valid' => false, 'width' => 0, 'height' => 0, 'message' => 'File not found']; + } + + $imageInfo = @getimagesize($absPath); + + if (!$imageInfo) { + return ['valid' => false, 'width' => 0, 'height' => 0, 'message' => 'Not a valid image']; + } + + [$width, $height] = $imageInfo; + + // Facebook minimum: 200x200, recommended: 1200x630 + // WhatsApp minimum: 300x200 + if ($width < 200 || $height < 200) { + return [ + 'valid' => false, + 'width' => $width, + 'height' => $height, + 'message' => "Image too small ({$width}x{$height}). Minimum: 200x200px.", + ]; + } + + return ['valid' => true, 'width' => $width, 'height' => $height, 'message' => 'OK']; + } + + /** + * Load an image resource from a file. + * + * @param string $path Absolute file path + * @param int $type IMAGETYPE_* constant + * + * @return \GdImage|false + */ + private static function loadImage(string $path, int $type) + { + return match ($type) { + IMAGETYPE_JPEG => @imagecreatefromjpeg($path), + IMAGETYPE_PNG => @imagecreatefrompng($path), + IMAGETYPE_GIF => @imagecreatefromgif($path), + IMAGETYPE_WEBP => @imagecreatefromwebp($path), + default => false, + }; + } +} diff --git a/src/packages/plg_system_mokoog/src/Helper/JsonLdBuilder.php b/src/packages/plg_system_mokoog/src/Helper/JsonLdBuilder.php new file mode 100644 index 0000000..b9cf789 --- /dev/null +++ b/src/packages/plg_system_mokoog/src/Helper/JsonLdBuilder.php @@ -0,0 +1,171 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_system_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Plugin\System\MokoOG\Helper; + +defined('_JEXEC') or die; + +use Joomla\CMS\Factory; +use Joomla\CMS\Uri\Uri; + +class JsonLdBuilder +{ + /** + * Build Article schema for a com_content article. + * + * @param int $articleId Article ID + * @param string $title Page title + * @param string $description Page description + * @param string $image Image URL (absolute) + * + * @return array|null + */ + public static function buildArticle(int $articleId, string $title, string $description, string $image): ?array + { + if ($articleId <= 0) { + return null; + } + + $db = Factory::getDbo(); + $query = $db->getQuery(true) + ->select($db->quoteName([ + 'a.created', 'a.modified', 'a.publish_up', + 'u.name', + ])) + ->from($db->quoteName('#__content', 'a')) + ->join('LEFT', $db->quoteName('#__users', 'u') . ' ON ' . $db->quoteName('u.id') . ' = ' . $db->quoteName('a.created_by')) + ->where($db->quoteName('a.id') . ' = ' . $articleId); + + $db->setQuery($query); + $article = $db->loadObject(); + + if (!$article) { + return null; + } + + $schema = [ + '@context' => 'https://schema.org', + '@type' => 'Article', + 'headline' => $title, + 'description' => $description, + 'url' => Uri::getInstance()->toString(), + 'datePublished' => $article->publish_up ?: $article->created, + 'dateModified' => $article->modified ?: $article->created, + ]; + + if (!empty($article->name)) { + $schema['author'] = [ + '@type' => 'Person', + 'name' => $article->name, + ]; + } + + if (!empty($image)) { + $schema['image'] = $image; + } + + return $schema; + } + + /** + * Build WebPage schema for non-article pages. + * + * @param string $title Page title + * @param string $description Page description + * + * @return array + */ + public static function buildWebPage(string $title, string $description): array + { + return [ + '@context' => 'https://schema.org', + '@type' => 'WebPage', + 'name' => $title, + 'description' => $description, + 'url' => Uri::getInstance()->toString(), + ]; + } + + /** + * Build BreadcrumbList schema from Joomla's pathway. + * + * @return array|null + */ + public static function buildBreadcrumbs(): ?array + { + $app = Factory::getApplication(); + $pathway = $app->getPathway(); + $items = $pathway->getPathway(); + + if (empty($items)) { + return null; + } + + $listItems = []; + $position = 1; + + foreach ($items as $item) { + $url = $item->link; + + if ($url && !str_starts_with($url, 'http')) { + $url = rtrim(Uri::root(), '/') . '/' . ltrim($url, '/'); + } + + $listItems[] = [ + '@type' => 'ListItem', + 'position' => $position, + 'name' => $item->name, + 'item' => $url ?: Uri::getInstance()->toString(), + ]; + + $position++; + } + + return [ + '@context' => 'https://schema.org', + '@type' => 'BreadcrumbList', + 'itemListElement' => $listItems, + ]; + } + + /** + * Build Organization schema from site configuration. + * + * @param string $siteName Site name + * + * @return array + */ + public static function buildOrganization(string $siteName): array + { + return [ + '@context' => 'https://schema.org', + '@type' => 'Organization', + 'name' => $siteName, + 'url' => Uri::root(), + ]; + } + + /** + * Encode a schema array to a JSON-LD script tag string. + * + * @param array $schema Schema data + * + * @return string + */ + public static function toScriptTag(array $schema): string + { + $json = json_encode($schema, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT); + + // Escape </ sequences to prevent XSS via </script> in content data + $json = str_replace('</', '<\/', $json); + + return '<script type="application/ld+json">' . $json . '</script>'; + } +} diff --git a/src/packages/plg_system_mokoog/src/Helper/index.html b/src/packages/plg_system_mokoog/src/Helper/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/src/Helper/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_system_mokoog/src/index.html b/src/packages/plg_system_mokoog/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_system_mokoog/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/index.html b/src/packages/plg_webservices_mokoog/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/language/en-GB/index.html b/src/packages/plg_webservices_mokoog/language/en-GB/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-GB/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.ini b/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.ini new file mode 100644 index 0000000..97f99e3 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.ini @@ -0,0 +1,5 @@ +; MokoJoomOpenGraph - Web Services Plugin Language File +; Copyright (C) 2026 Moko Consulting. All rights reserved. +; License: GPL-3.0-or-later + +PLG_WEBSERVICES_MOKOOG="Web Services - MokoJoomOpenGraph" diff --git a/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.sys.ini b/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.sys.ini new file mode 100644 index 0000000..086ffe8 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-GB/plg_webservices_mokoog.sys.ini @@ -0,0 +1,6 @@ +; MokoJoomOpenGraph - Web Services Plugin System Language File +; Copyright (C) 2026 Moko Consulting. All rights reserved. +; License: GPL-3.0-or-later + +PLG_WEBSERVICES_MOKOOG="Web Services - MokoJoomOpenGraph" +PLG_WEBSERVICES_MOKOOG_DESCRIPTION="Exposes MokoJoomOpenGraph OG tag data via Joomla's REST API at /api/index.php/v1/mokoog/tags." diff --git a/src/packages/plg_webservices_mokoog/language/en-US/index.html b/src/packages/plg_webservices_mokoog/language/en-US/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-US/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.ini b/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.ini new file mode 100644 index 0000000..97f99e3 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.ini @@ -0,0 +1,5 @@ +; MokoJoomOpenGraph - Web Services Plugin Language File +; Copyright (C) 2026 Moko Consulting. All rights reserved. +; License: GPL-3.0-or-later + +PLG_WEBSERVICES_MOKOOG="Web Services - MokoJoomOpenGraph" diff --git a/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.sys.ini b/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.sys.ini new file mode 100644 index 0000000..086ffe8 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/en-US/plg_webservices_mokoog.sys.ini @@ -0,0 +1,6 @@ +; MokoJoomOpenGraph - Web Services Plugin System Language File +; Copyright (C) 2026 Moko Consulting. All rights reserved. +; License: GPL-3.0-or-later + +PLG_WEBSERVICES_MOKOOG="Web Services - MokoJoomOpenGraph" +PLG_WEBSERVICES_MOKOOG_DESCRIPTION="Exposes MokoJoomOpenGraph OG tag data via Joomla's REST API at /api/index.php/v1/mokoog/tags." diff --git a/src/packages/plg_webservices_mokoog/language/index.html b/src/packages/plg_webservices_mokoog/language/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/language/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/mokoog.php b/src/packages/plg_webservices_mokoog/mokoog.php new file mode 100644 index 0000000..945c592 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/mokoog.php @@ -0,0 +1,19 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_webservices_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + * + * Legacy entry point — not executed under DI container. + */ + +defined('_JEXEC') or die; + +use Joomla\CMS\Plugin\CMSPlugin; + +class PlgWebservicesMokoog extends CMSPlugin +{ +} diff --git a/src/packages/plg_webservices_mokoog/mokoog.xml b/src/packages/plg_webservices_mokoog/mokoog.xml new file mode 100644 index 0000000..08008aa --- /dev/null +++ b/src/packages/plg_webservices_mokoog/mokoog.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * @package MokoJoomOpenGraph + * @subpackage plg_webservices_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + --> +<extension type="plugin" group="webservices" method="upgrade"> + <name>Web Services - MokoJoomOpenGraph</name> + <version>01.00.01-dev</version> + <creationDate>2026-05-23</creationDate> + <author>Moko Consulting</author> + <authorEmail>hello@mokoconsulting.tech</authorEmail> + <authorUrl>https://mokoconsulting.tech</authorUrl> + <copyright>Copyright (C) 2026 Moko Consulting. All rights reserved.</copyright> + <license>GPL-3.0-or-later</license> + <description>PLG_WEBSERVICES_MOKOOG_DESCRIPTION</description> + + <namespace path="src">Joomla\Plugin\WebServices\MokoOG</namespace> + + <files> + <filename plugin="mokoog">mokoog.php</filename> + <folder>src</folder> + <folder>services</folder> + <folder>language</folder> + </files> + + <languages> + <language tag="en-GB">language/en-GB/plg_webservices_mokoog.ini</language> + <language tag="en-GB">language/en-GB/plg_webservices_mokoog.sys.ini</language> + </languages> +</extension> diff --git a/src/packages/plg_webservices_mokoog/services/index.html b/src/packages/plg_webservices_mokoog/services/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/services/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/services/provider.php b/src/packages/plg_webservices_mokoog/services/provider.php new file mode 100644 index 0000000..be36a42 --- /dev/null +++ b/src/packages/plg_webservices_mokoog/services/provider.php @@ -0,0 +1,44 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_webservices_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +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 Joomla\Plugin\WebServices\MokoOG\Extension\MokoOGWebServices; + +return new class () implements ServiceProviderInterface { + /** + * Register the service provider. + * + * @param Container $container The DI container + * + * @return void + */ + public function register(Container $container): void + { + $container->set( + PluginInterface::class, + function (Container $container) { + $plugin = new MokoOGWebServices( + $container->get(DispatcherInterface::class), + (array) PluginHelper::getPlugin('webservices', 'mokoog') + ); + $plugin->setApplication(Factory::getApplication()); + + return $plugin; + } + ); + } +}; diff --git a/src/packages/plg_webservices_mokoog/src/Extension/MokoOGWebServices.php b/src/packages/plg_webservices_mokoog/src/Extension/MokoOGWebServices.php new file mode 100644 index 0000000..b5cc48f --- /dev/null +++ b/src/packages/plg_webservices_mokoog/src/Extension/MokoOGWebServices.php @@ -0,0 +1,81 @@ +<?php + +/** + * @package MokoJoomOpenGraph + * @subpackage plg_webservices_mokoog + * @author Moko Consulting <hello@mokoconsulting.tech> + * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. + * @license GNU General Public License version 3 or later; see LICENSE + */ + +namespace Joomla\Plugin\WebServices\MokoOG\Extension; + +defined('_JEXEC') or die; + +use Joomla\CMS\Plugin\CMSPlugin; +use Joomla\CMS\Router\ApiRouter; +use Joomla\Event\Event; +use Joomla\Event\SubscriberInterface; +use Joomla\Router\Route; + +final class MokoOGWebServices extends CMSPlugin implements SubscriberInterface +{ + /** + * @var bool + */ + protected $autoloadLanguage = true; + + /** + * Returns the events this plugin subscribes to. + * + * @return array<string, string> + */ + public static function getSubscribedEvents(): array + { + return [ + 'onBeforeApiRoute' => 'onBeforeApiRoute', + ]; + } + + /** + * Register API routes for MokoJoomOpenGraph. + * + * Endpoints: + * GET /api/index.php/v1/mokoog/tags - List all OG tags + * GET /api/index.php/v1/mokoog/tags/:id - Get single OG tag + * POST /api/index.php/v1/mokoog/tags - Create OG tag + * PATCH /api/index.php/v1/mokoog/tags/:id - Update OG tag + * DELETE /api/index.php/v1/mokoog/tags/:id - Delete OG tag + * + * @param Event $event The event object + * + * @return void + */ + public function onBeforeApiRoute(Event $event): void + { + [$router] = array_values($event->getArguments()); + + $defaults = [ + 'component' => 'com_mokoog', + 'public' => false, + ]; + + // CRUD routes for OG tags + $router->createCRUDRoutes( + 'v1/mokoog/tags', + 'tags', + $defaults + ); + + // GET by content type + content ID (lookup endpoint) + $router->addRoute( + new Route( + ['GET'], + 'v1/mokoog/lookup/:content_type/:content_id', + 'tags.lookup', + ['content_type' => '[a-z_.]+', 'content_id' => '(\d+)'], + $defaults + ) + ); + } +} diff --git a/src/packages/plg_webservices_mokoog/src/Extension/index.html b/src/packages/plg_webservices_mokoog/src/Extension/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/src/Extension/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/packages/plg_webservices_mokoog/src/index.html b/src/packages/plg_webservices_mokoog/src/index.html new file mode 100644 index 0000000..94906bc --- /dev/null +++ b/src/packages/plg_webservices_mokoog/src/index.html @@ -0,0 +1 @@ +<html><body bgcolor="#FFFFFF"></body></html> diff --git a/src/pkg_mokoog.xml b/src/pkg_mokoog.xml index 355f556..4f7a54a 100644 --- a/src/pkg_mokoog.xml +++ b/src/pkg_mokoog.xml @@ -1,14 +1,14 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. * @license GNU General Public License version 3 or later; see LICENSE --> <extension type="package" method="upgrade"> - <name>MokoOpenGraph</name> + <name>Package - MokoJoomOpenGraph</name> <packagename>mokoog</packagename> - <version>01.00.00</version> + <version>01.00.01-dev</version> <creationDate>2026-05-23</creationDate> <author>Moko Consulting</author> <authorEmail>hello@mokoconsulting.tech</authorEmail> @@ -23,6 +23,7 @@ <file type="component" id="com_mokoog">com_mokoog.zip</file> <file type="plugin" id="mokoog" group="system">plg_system_mokoog.zip</file> <file type="plugin" id="mokoog" group="content">plg_content_mokoog.zip</file> + <file type="plugin" id="mokoog" group="webservices">plg_webservices_mokoog.zip</file> </files> <languages> @@ -30,6 +31,8 @@ </languages> <updateservers> - <server type="extension" name="MokoOpenGraph Updates">https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/raw/branch/main/updates.xml</server> + <server type="extension" name="MokoJoomOpenGraph Updates">https://git.mokoconsulting.tech/MokoConsulting/MokoJoomOpenGraph/updates.xml</server> </updateservers> + <dlid prefix="dlid=" suffix=""/> + <blockChildUninstall>true</blockChildUninstall> </extension> diff --git a/src/script.php b/src/script.php index c5a505f..d515031 100644 --- a/src/script.php +++ b/src/script.php @@ -1,7 +1,7 @@ <?php /** - * @package MokoOpenGraph + * @package MokoJoomOpenGraph * @author Moko Consulting <hello@mokoconsulting.tech> * @copyright Copyright (C) 2026 Moko Consulting. All rights reserved. * @license GNU General Public License version 3 or later; see LICENSE @@ -73,6 +73,28 @@ class Pkg_MokoOGInstallerScript $db->setQuery($query); $db->execute(); + + // Enable the content plugin automatically + $query = $db->getQuery(true) + ->update($db->quoteName('#__extensions')) + ->set($db->quoteName('enabled') . ' = 1') + ->where($db->quoteName('type') . ' = ' . $db->quote('plugin')) + ->where($db->quoteName('folder') . ' = ' . $db->quote('content')) + ->where($db->quoteName('element') . ' = ' . $db->quote('mokoog')); + + $db->setQuery($query); + $db->execute(); + + // Enable the webservices plugin automatically + $query = $db->getQuery(true) + ->update($db->quoteName('#__extensions')) + ->set($db->quoteName('enabled') . ' = 1') + ->where($db->quoteName('type') . ' = ' . $db->quote('plugin')) + ->where($db->quoteName('folder') . ' = ' . $db->quote('webservices')) + ->where($db->quoteName('element') . ' = ' . $db->quote('mokoog')); + + $db->setQuery($query); + $db->execute(); } } } diff --git a/updates.xml b/updates.xml deleted file mode 100644 index 3c7fe4e..0000000 --- a/updates.xml +++ /dev/null @@ -1,95 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<updates> - <!-- Managed by CI/CD pipeline — do not edit manually --> - -<update> - <name>MokoOpenGraph</name> - <description>MokoOpenGraph development build.</description> - <element>pkg_mokoog</element> - <type>package</type> - <version>01.00.00</version> - <creationDate>2026-05-24</creationDate> - <infourl title='MokoOpenGraph'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/tag/development</infourl> - <downloads> - <downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/download/development/pkg_mokoog-01.00.00-dev.zip</downloadurl> - </downloads> - <sha256>3a910f6c075d2cddbda905c175e666b9cbf1ae79e465132f18293ac3be15266e</sha256> - <tags><tag>development</tag></tags> - <maintainer>Moko Consulting</maintainer> - <maintainerurl>https://mokoconsulting.tech</maintainerurl> - <targetplatform name='joomla' version='(5|6).*'/> - </update> - -<update> - <name>MokoOpenGraph</name> - <description>MokoOpenGraph stable build.</description> - <element>pkg_mokoog</element> - <type>package</type> - <version>01.00.00</version> - <creationDate>2026-05-23</creationDate> - <infourl title='MokoOpenGraph'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/tag/v01</infourl> - <downloads> - <downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/download/v01/pkg_mokoog-01.00.00.zip</downloadurl> - </downloads> - <sha256>e2262d9e515af284d6837627d63fb7ef7376aea5c50bebd1f4ea4e92a4ae4a6d</sha256> - <tags><tag>alpha</tag></tags> - <maintainer>Moko Consulting</maintainer> - <maintainerurl>https://mokoconsulting.tech</maintainerurl> - <targetplatform name='joomla' version='(5|6).*'/> - </update> - -<update> - <name>MokoOpenGraph</name> - <description>MokoOpenGraph stable build.</description> - <element>pkg_mokoog</element> - <type>package</type> - <version>01.00.00</version> - <creationDate>2026-05-23</creationDate> - <infourl title='MokoOpenGraph'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/tag/v01</infourl> - <downloads> - <downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/download/v01/pkg_mokoog-01.00.00.zip</downloadurl> - </downloads> - <sha256>e2262d9e515af284d6837627d63fb7ef7376aea5c50bebd1f4ea4e92a4ae4a6d</sha256> - <tags><tag>beta</tag></tags> - <maintainer>Moko Consulting</maintainer> - <maintainerurl>https://mokoconsulting.tech</maintainerurl> - <targetplatform name='joomla' version='(5|6).*'/> - </update> - -<update> - <name>MokoOpenGraph</name> - <description>MokoOpenGraph stable build.</description> - <element>pkg_mokoog</element> - <type>package</type> - <version>01.00.00</version> - <creationDate>2026-05-23</creationDate> - <infourl title='MokoOpenGraph'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/tag/v01</infourl> - <downloads> - <downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/download/v01/pkg_mokoog-01.00.00.zip</downloadurl> - </downloads> - <sha256>e2262d9e515af284d6837627d63fb7ef7376aea5c50bebd1f4ea4e92a4ae4a6d</sha256> - <tags><tag>rc</tag></tags> - <maintainer>Moko Consulting</maintainer> - <maintainerurl>https://mokoconsulting.tech</maintainerurl> - <targetplatform name='joomla' version='(5|6).*'/> - </update> - -<update> - <name>MokoOpenGraph</name> - <description>MokoOpenGraph stable build.</description> - <element>pkg_mokoog</element> - <type>package</type> - <version>01.00.00</version> - <creationDate>2026-05-23</creationDate> - <infourl title='MokoOpenGraph'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/tag/v01</infourl> - <downloads> - <downloadurl type='full' format='zip'>https://git.mokoconsulting.tech/MokoConsulting/MokoOpenGraph/releases/download/v01/pkg_mokoog-01.00.00.zip</downloadurl> - </downloads> - <sha256>e2262d9e515af284d6837627d63fb7ef7376aea5c50bebd1f4ea4e92a4ae4a6d</sha256> - <tags><tag>stable</tag></tags> - <maintainer>Moko Consulting</maintainer> - <maintainerurl>https://mokoconsulting.tech</maintainerurl> - <targetplatform name='joomla' version='(5|6).*'/> - </update> - -</updates>