diff --git a/.distignore b/.distignore
new file mode 100644
index 0000000..3befb60
--- /dev/null
+++ b/.distignore
@@ -0,0 +1,21 @@
+.git
+.github
+.gitignore
+.aider*
+.DS_Store
+.distignore
+.env
+exelearning/
+vendor/
+node_modules/
+phpmd-rules.xml
+phpmd.xml
+Makefile
+docker-compose.yml
+Dockerfile
+composer.json
+composer.lock
+composer.phar
+CLAUDE.md
+AGENTS.md
+mod_exeweb-*.zip
diff --git a/.env.dist b/.env.dist
index 93647fa..e7ed48b 100644
--- a/.env.dist
+++ b/.env.dist
@@ -13,9 +13,17 @@ XDEBUG_CONFIG="client_host=host.docker.internal"
EXELEARNING_WEB_SOURCECODE_PATH=
EXELEARNING_WEB_CONTAINER_TAG=latest
+EXELEARNING_EDITOR_REPO_URL=https://github.com/exelearning/exelearning.git
+EXELEARNING_EDITOR_DEFAULT_BRANCH=main
+EXELEARNING_EDITOR_REF=
+EXELEARNING_EDITOR_REF_TYPE=auto
+
+# To use a specific Moodle version, set MOODLE_VERSION to git release tag.
+# You can find the list of available tags at:
+# https://api.github.com/repos/moodle/moodle/tags
+MOODLE_VERSION=v5.0.5
# Test user data
TEST_USER_EMAIL=user@exelearning.net
TEST_USER_USERNAME=user
TEST_USER_PASSWORD=1234
-
diff --git a/.github/workflows/check-editor-releases.yml b/.github/workflows/check-editor-releases.yml
new file mode 100644
index 0000000..f03031d
--- /dev/null
+++ b/.github/workflows/check-editor-releases.yml
@@ -0,0 +1,95 @@
+---
+name: Check Editor Releases
+
+on:
+ schedule:
+ - cron: "0 8 * * *" # Daily at 8:00 UTC
+ workflow_dispatch:
+
+permissions:
+ contents: write
+ actions: write
+
+jobs:
+ check_and_build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Get latest exelearning release
+ id: check
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ # Fetch latest release from exelearning/exelearning
+ LATEST=$(gh api repos/exelearning/exelearning/releases/latest --jq '.tag_name' 2>/dev/null || echo "")
+ if [ -z "$LATEST" ]; then
+ echo "No release found"
+ echo "found=false" >> $GITHUB_OUTPUT
+ exit 0
+ fi
+ echo "Latest editor release: $LATEST"
+ echo "tag=$LATEST" >> $GITHUB_OUTPUT
+
+ # Check if we already built this version
+ MARKER_FILE=".editor-version"
+ CURRENT=""
+ if [ -f "$MARKER_FILE" ]; then
+ CURRENT=$(cat "$MARKER_FILE")
+ fi
+ echo "Current built version: $CURRENT"
+
+ if [ "$LATEST" = "$CURRENT" ]; then
+ echo "Already up to date"
+ echo "found=false" >> $GITHUB_OUTPUT
+ else
+ echo "New version available"
+ echo "found=true" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Setup Bun
+ if: steps.check.outputs.found == 'true'
+ uses: oven-sh/setup-bun@v2
+
+ - name: Build static editor
+ if: steps.check.outputs.found == 'true'
+ env:
+ EXELEARNING_EDITOR_REPO_URL: https://github.com/exelearning/exelearning.git
+ EXELEARNING_EDITOR_REF: ${{ steps.check.outputs.tag }}
+ EXELEARNING_EDITOR_REF_TYPE: tag
+ run: make build-editor
+
+ - name: Compute version
+ if: steps.check.outputs.found == 'true'
+ id: version
+ run: |
+ TAG="${{ steps.check.outputs.tag }}"
+ VERSION="${TAG#v}"
+ echo "version=$VERSION" >> $GITHUB_OUTPUT
+ echo "tag=$TAG" >> $GITHUB_OUTPUT
+
+ - name: Create package
+ if: steps.check.outputs.found == 'true'
+ run: make package RELEASE=${{ steps.version.outputs.version }}
+
+ - name: Update editor version marker
+ if: steps.check.outputs.found == 'true'
+ run: |
+ echo "${{ steps.check.outputs.tag }}" > .editor-version
+ git config user.name "github-actions[bot]"
+ git config user.email "github-actions[bot]@users.noreply.github.com"
+ git add .editor-version
+ git commit -m "Update editor version to ${{ steps.check.outputs.tag }}"
+ git push
+
+ - name: Create GitHub Release
+ if: steps.check.outputs.found == 'true'
+ uses: softprops/action-gh-release@v2
+ with:
+ tag_name: ${{ steps.version.outputs.tag }}
+ name: "${{ steps.version.outputs.tag }}"
+ body: |
+ Automated build with eXeLearning editor ${{ steps.version.outputs.tag }}.
+ files: mod_exeweb-${{ steps.version.outputs.version }}.zip
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/pr-playground-preview.yml b/.github/workflows/pr-playground-preview.yml
new file mode 100644
index 0000000..446b03f
--- /dev/null
+++ b/.github/workflows/pr-playground-preview.yml
@@ -0,0 +1,44 @@
+---
+name: PR Playground Preview
+
+on:
+ pull_request:
+ types: [opened, synchronize, reopened]
+
+concurrency:
+ group: playground-${{ github.event.pull_request.number }}
+ cancel-in-progress: true
+
+permissions:
+ contents: read
+ pull-requests: write
+
+jobs:
+ playground-preview:
+ if: github.event.pull_request.head.repo.full_name == github.repository
+ runs-on: ubuntu-latest
+ timeout-minutes: 2
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ ref: ${{ github.event.pull_request.head.sha }}
+
+ - name: Build PR blueprint
+ env:
+ PLUGIN_REPO_OWNER: ${{ github.event.pull_request.head.repo.owner.login }}
+ PLUGIN_REPO_NAME: ${{ github.event.pull_request.head.repo.name }}
+ PLUGIN_BRANCH_NAME: ${{ github.event.pull_request.head.ref }}
+ run: |
+ plugin_url="https://github.com/${PLUGIN_REPO_OWNER}/${PLUGIN_REPO_NAME}/archive/refs/heads/${PLUGIN_BRANCH_NAME}.zip"
+ sed "s|https://github.com/exelearning/mod_exeweb/archive/refs/heads/main.zip|${plugin_url}|" blueprint.json > blueprint.pr.json
+
+ - uses: ateeducacion/action-moodle-playground-pr-preview@main
+ with:
+ blueprint-file: blueprint.pr.json
+ mode: append-to-description
+ github-token: ${{ secrets.GITHUB_TOKEN }}
+ extra-text: >
+ ⚠️ The embedded eXeLearning editor is not included in this preview.
+ You can install it from **Modules > eXeLearning Web > Configure**
+ using the "Download & Install Editor" button.
+ All other module features (ELPX upload, viewer, preview) work normally.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 0000000..9947284
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,81 @@
+---
+name: Release
+
+on:
+ release:
+ types: [published]
+ workflow_dispatch:
+ inputs:
+ release_tag:
+ description: "Release label for package name (e.g. 1.2.3 or 1.2.3-beta)"
+ required: false
+ default: ""
+ editor_repo_url:
+ description: "Editor source repository URL"
+ required: false
+ default: "https://github.com/exelearning/exelearning.git"
+ editor_ref:
+ description: "Editor ref value (main, branch name, or tag)"
+ required: false
+ default: "main"
+ editor_ref_type:
+ description: "Type of editor ref"
+ required: false
+ default: "auto"
+ type: choice
+ options:
+ - auto
+ - branch
+ - tag
+
+permissions:
+ contents: write
+
+jobs:
+ build_and_upload:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Setup Bun
+ uses: oven-sh/setup-bun@v2
+
+ - name: Set environment variables
+ run: |
+ if [ "${{ github.event_name }}" = "release" ]; then
+ RAW_TAG="${GITHUB_REF##*/}"
+ VERSION_TAG="${RAW_TAG#v}"
+ echo "RELEASE_TAG=${VERSION_TAG}" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REPO_URL=https://github.com/exelearning/exelearning.git" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REF=main" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REF_TYPE=branch" >> $GITHUB_ENV
+ else
+ INPUT_RELEASE="${{ github.event.inputs.release_tag }}"
+ if [ -z "$INPUT_RELEASE" ]; then
+ INPUT_RELEASE="manual-$(date +%Y%m%d)-${GITHUB_SHA::7}"
+ fi
+ echo "RELEASE_TAG=${INPUT_RELEASE}" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REPO_URL=${{ github.event.inputs.editor_repo_url }}" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REF=${{ github.event.inputs.editor_ref }}" >> $GITHUB_ENV
+ echo "EXELEARNING_EDITOR_REF_TYPE=${{ github.event.inputs.editor_ref_type }}" >> $GITHUB_ENV
+ fi
+
+ - name: Build static editor
+ run: make build-editor
+
+ - name: Create package
+ run: make package RELEASE=${RELEASE_TAG}
+
+ - name: Upload ZIP as workflow artifact
+ uses: actions/upload-artifact@v4
+ with:
+ name: mod_exeweb-${{ env.RELEASE_TAG }}
+ path: mod_exeweb-${{ env.RELEASE_TAG }}.zip
+
+ - name: Upload ZIP to release
+ if: github.event_name == 'release'
+ uses: softprops/action-gh-release@v2
+ with:
+ files: mod_exeweb-${{ env.RELEASE_TAG }}.zip
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 5567af6..768004c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,4 +7,11 @@ phpmd-rules.xml
# Composer ignores
/vendor/
/composer.lock
-/composer.phar
\ No newline at end of file
+/composer.phar
+
+# Built static editor files
+dist/static/
+
+# Local editor checkout fetched during build
+exelearning/
+.omc/
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..b4d64e0
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,121 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Moodle activity module (`mod_exeweb`) for creating and editing web sites with eXeLearning. Teachers can author educational content via three modes: local upload, eXeLearning Online (remote editor), or an embedded static editor.
+
+**Component**: `mod_exeweb`
+**Moodle compatibility**: 4.2+
+**License**: GNU GPL v3+
+
+## Common Commands
+
+```bash
+# Development environment (Docker-based)
+make up # Start containers interactively
+make upd # Start containers in background
+make down # Stop containers
+make shell # Shell into Moodle container
+make clean # Stop containers + remove volumes
+
+# PHP dependencies
+make install-deps # composer install
+
+# Code quality
+make lint # PHP CodeSniffer (Moodle standard)
+make fix # Auto-fix CodeSniffer violations
+make phpmd # PHP Mess Detector
+
+# Testing
+make test # PHPUnit tests
+make behat # Behat BDD tests
+
+# Embedded editor
+make build-editor # Fetch exelearning source + build to dist/static/
+make clean-editor # Remove built editor artifacts
+
+# Packaging
+make package RELEASE=1.2.3 # Create distributable ZIP
+```
+
+Lint/test/phpmd/behat all delegate to `composer` scripts defined in `composer.json`. Run `make install-deps` first.
+
+## Architecture
+
+### Three Content Origins
+
+| Constant | Mode | How it works |
+|----------|------|-------------|
+| `EXEWEB_ORIGIN_LOCAL` | Upload | ZIP package uploaded via form |
+| `EXEWEB_ORIGIN_EXEONLINE` | Online | Redirects to remote eXeLearning; JWT-authenticated callbacks (`get_ode.php`/`set_ode.php`) sync the package |
+| `EXEWEB_ORIGIN_EMBEDDED` | Embedded | Static HTML5 editor in iframe from `dist/static/`; bridge script + postMessage for Moodle ↔ editor communication |
+
+### Key File Groups
+
+- **Core Moodle hooks**: `lib.php`, `locallib.php` (display/rendering), `mod_form.php` (activity form), `settings.php` (admin config)
+- **Editor integration**: `editor/index.php` (bootstrap), `editor/static.php` (asset server), `editor/save.php` (AJAX save)
+- **Online editor**: `get_ode.php`, `set_ode.php`, `classes/exeonline/` (redirector, JWT token manager)
+- **Frontend JS** (AMD): `amd/src/editor_modal.js` (fullscreen overlay), `amd/src/admin_embedded_editor.js` (settings page AJAX + progress), `amd/src/moodle_exe_bridge.js` (runs inside editor iframe, raw — not AMD)
+- **Package handling**: `classes/exeweb_package.php` (validation, extraction)
+- **Database**: `db/install.xml` (schema), `db/access.php` (capabilities), `db/upgrade.php` (migrations)
+- **Backup/restore**: `backup/moodle2/`
+
+### Embedded Editor: Hybrid Source Model
+
+The embedded editor uses a **hybrid source model** with two possible locations:
+
+1. **Bundled**: `dist/static/` inside the plugin (from release ZIP or `make build-editor`)
+2. **Admin-installed**: `$CFG->dataroot/mod_exeweb/embedded_editor/` (downloaded from GitHub Releases via the admin management page)
+
+**Source precedence**: moodledata (admin-installed) → bundled → not available
+
+Key classes:
+- `classes/local/embedded_editor_source_resolver.php` — single source of truth for which editor source is active
+- `classes/local/embedded_editor_installer.php` — download/install pipeline from GitHub Releases
+
+The resolver is used by `lib.php` helper functions (`exeweb_get_embedded_editor_local_static_dir()`, `exeweb_embedded_editor_uses_local_assets()`, `exeweb_get_embedded_editor_index_source()`), which in turn are used by `editor/static.php` (asset proxy) and `editor/index.php` (bootstrap). This makes the source transparent to the rest of the codebase.
+
+**Admin management (inline settings widget)**: Editor management is integrated directly into the plugin's admin settings page via a custom `admin_setting` subclass — no separate page. Actions (install/update/repair/uninstall) use AJAX external functions; a JS AMD module handles progress display and timeout resilience.
+
+Key files:
+- `classes/external/manage_embedded_editor.php` — AJAX external functions (`execute_action` + `get_status`), modern `\core_external\external_api` pattern (Moodle 4.2+, PSR-4 namespaced `\mod_exeweb\external\manage_embedded_editor`)
+- `classes/admin/admin_setting_embeddededitor.php` — Custom `admin_setting` subclass (PSR-4 namespaced `\mod_exeweb\admin\admin_setting_embeddededitor`), renders inline widget in settings page. `get_setting()`/`write_setting()` return empty string (display-only, no config stored).
+- `templates/admin_embedded_editor.mustache` — Inline widget template (status card, action buttons, progress bar, result area)
+- `amd/src/admin_embedded_editor.js` — AMD module: calls `get_status(checklatest=true)` on page load (async GitHub API check), handles action AJAX calls with 120s JS timeout, falls back to status polling every 10s using `CONFIG_INSTALLING` lock, polling capped at 5 minutes
+
+**Design decisions & rationale**:
+- **Why AJAX instead of synchronous POST**: Keeps user on settings page; the old `manage_embedded_editor.php` navigated away. POST with `NO_OUTPUT_BUFFERING` progress bar was considered but rejected because it still navigates away.
+- **Why indeterminate progress bar**: The installer doesn't expose byte-level progress. Operation typically takes 10-30s. Animated Bootstrap stripes are sufficient.
+- **Why 120s JS timeout + polling**: Reverse proxies (nginx default 60s, Apache 60-120s) may kill long AJAX requests for ~50MB ZIP downloads. The existing `CONFIG_INSTALLING` lock (300s TTL) serves as a "still running" signal. JS polls `get_status` after timeout to distinguish "still running" / "completed" / "failed". Stale lock (>300s) is detected and reported.
+- **Why GitHub API only from JS**: `discover_latest_version()` hits GitHub API (60 req/hr unauthenticated). Calling it on PHP render would fire on every settings page visit. JS calls it once async after page load.
+- **Why modern \core_external\external_api**: Plugin minimum is Moodle 4.2+ (`version.php`). Uses PSR-4 namespaced classes at `classes/external/`. The legacy `classes/external.php` (Frankenstyle) remains for existing external functions but new code uses the modern pattern.
+- **Both capabilities required**: `moodle/site:config` AND `mod/exeweb:manageembeddededitor`, matching the original `admin_externalpage` registration.
+
+### Embedded Editor Build (Development)
+
+`dist/static/` is **not committed**. It's built from the `exelearning/exelearning` repo:
+- `make build-editor` shallow-clones the source (configured via `.env` or env vars: `EXELEARNING_EDITOR_REPO_URL`, `EXELEARNING_EDITOR_REF`, `EXELEARNING_EDITOR_REF_TYPE`)
+- Builds with Bun (`bun install && bun run build:static`)
+- Copies output to `dist/static/`
+
+### File Storage
+
+Uses Moodle's file API — packages stored in `mod_exeweb/package` filearea, expanded content in `mod_exeweb/content`. Revision number in URLs for cache busting. Never serve files directly from disk.
+
+### Capabilities
+
+`mod/exeweb:view`, `mod/exeweb:addinstance`, `mod/exeweb:manageembeddededitor`
+
+## Code Standards
+
+- **PHP**: Moodle coding standard enforced via PHP CodeSniffer (`make lint`/`make fix`)
+- **Strings**: All UI strings in `lang/{ca,en,es,eu,gl}/exeweb.php` — use `get_string('key', 'mod_exeweb')`
+- **JS**: AMD modules in `amd/src/`, compiled to `amd/build/` (exception: `moodle_exe_bridge.js` loads raw in editor iframe)
+
+## Packaging & Release
+
+- `make package RELEASE=X.Y.Z` updates `version.php`, creates ZIP excluding files in `.distignore`, then restores dev values
+- GitHub Actions `release.yml` triggers on git tags: fetches editor, builds, packages, uploads to GitHub Release
+- `check-editor-releases.yml` runs daily to auto-release when new editor versions appear
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000..3bc2163
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,3 @@
+# CLAUDE.md
+
+See [AGENTS.md](AGENTS.md) for detailed guidance on this codebase.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 0000000..bd0d64c
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,122 @@
+# Development Guide
+
+This document covers the development setup for the eXeLearning web sites plugin.
+
+> **Important:** Do not install this plugin by cloning the repository directly. The repository does not include the embedded editor, which is built during the release process. Always install from a [release ZIP](https://github.com/exelearning/mod_exeweb/releases).
+
+## Development using Makefile
+
+To facilitate development, a `Makefile` is included to simplify Docker-based workflows.
+
+### Requirements
+
+- Docker
+- Docker Compose
+
+### Available Commands
+
+- **Pull the latest images**:
+ To pull the latest Docker images from the registry, use:
+
+ ```bash
+ make pull
+ ```
+ > **Note**: Docker need to be logged in ghcr.io *([more info...])(https://docs.github.com/es/packages/working-with-a-github-packages-registry/working-with-the-container-registry)*
+
+- **Start the development environment**:
+ To start the Docker containers in interactive mode, run:
+
+ ```bash
+ make up
+ ```
+
+ To start the containers in the background (daemon mode), run:
+
+ ```bash
+ make upd
+ ```
+
+- **Build the Docker containers**:
+ You can build the Docker containers using the following command. This will also check if the `EXELEARNING_WEB_SOURCECODE_PATH` is defined in the `.env` file:
+
+ ```bash
+ make build
+ ```
+
+ > **Note**: If `EXELEARNING_WEB_SOURCECODE_PATH` is not defined, the build will fail and display an error message.
+
+- **Access a shell in the Moodle container**:
+ To open a shell inside the running Moodle container, use:
+
+ ```bash
+ make shell
+ ```
+
+- **Stop and remove containers**:
+ To stop and remove the running Docker containers, run:
+
+ ```bash
+ make down
+ ```
+
+- **Clean up the environment**:
+ To stop and remove all Docker containers, volumes, and orphaned containers, run:
+
+ ```bash
+ make clean
+ ```
+
+### Environment Variables
+
+You can configure various settings using the `.env` file. If this file does not exist, it will be automatically generated by copying from `.env.dist`. Key variables to configure:
+
+- `EXELEARNING_WEB_SOURCECODE_PATH`: Define the path to the eXeLearning source code if you want to work with a local version.
+- `APP_PORT`: Define the port on which the application will run.
+- `APP_SECRET`: Set a secret key for the application.
+- `EXELEARNING_EDITOR_REPO_URL`: Repository used to fetch embedded editor source code.
+- `EXELEARNING_EDITOR_DEFAULT_BRANCH`: Fallback branch when no specific ref is defined.
+- `EXELEARNING_EDITOR_REF`: Specific branch or tag to build from (if empty, fallback to default branch).
+- `EXELEARNING_EDITOR_REF_TYPE`: `auto`, `branch`, or `tag` to resolve `EXELEARNING_EDITOR_REF`.
+
+## Embedded Editor Source Strategy
+
+The embedded static editor is no longer tied to a git submodule. During `make build-editor` the source is fetched as a shallow checkout from `EXELEARNING_EDITOR_REPO_URL` using:
+
+- `EXELEARNING_EDITOR_REF_TYPE=branch` to force branch mode.
+- `EXELEARNING_EDITOR_REF_TYPE=tag` to force tag mode.
+- `EXELEARNING_EDITOR_REF_TYPE=auto` to try tag first, then branch.
+
+This keeps the plugin repo lighter and lets CI/manual builds choose `main`, a specific tag, or a feature branch without submodule maintenance.
+
+## Manual Plugin Build in GitHub Actions
+
+The `Release` workflow now supports manual execution (`workflow_dispatch`) from the `main` branch. It accepts editor source parameters (`editor_repo_url`, `editor_ref`, `editor_ref_type`) and a `release_tag` for the generated ZIP name.
+
+### Example Workflow
+
+1. Ensure you have Docker running and properly configured.
+2. Define your environment variables in the `.env` file or copy from `.env.dist`.
+3. Pull the latest Docker images:
+
+ ```bash
+ make pull
+ ```
+
+4. Start the environment:
+
+ ```bash
+ make up
+ ```
+
+5. Build the environment if necessary:
+
+ ```bash
+ make build
+ ```
+
+6. Once development is complete, stop and clean up the environment:
+
+ ```bash
+ make down
+ make clean
+ ```
diff --git a/Makefile b/Makefile
index 26b3576..9a8f0fc 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,11 @@
-# Makefile to facilitate the use of Docker in the exelearning-web project
+# Makefile for mod_exeweb Moodle plugin
+
+# Define SED_INPLACE based on the operating system
+ifeq ($(shell uname), Darwin)
+ SED_INPLACE = sed -i ''
+else
+ SED_INPLACE = sed -i
+endif
# Detect the operating system and shell environment
ifeq ($(OS),Windows_NT)
@@ -42,12 +49,12 @@ endif
# Start Docker containers in interactive mode
# This target builds and starts the Docker containers, allowing interaction with the terminal.
-up: check-docker check-env
+up: check-docker check-env build-editor
docker compose up
# Start Docker containers in background mode (daemon)
# This target builds and starts the Docker containers in the background.
-upd: check-docker check-env
+upd: check-docker check-env build-editor
docker compose up -d
# Stop and remove Docker containers
@@ -102,24 +109,131 @@ phpmd:
# Run Behat tests using Composer
behat:
composer behat
+# -------------------------------------------------------
+# Embedded static editor build targets
+# -------------------------------------------------------
+
+EDITOR_SUBMODULE_PATH = exelearning
+EDITOR_DIST_PATH = dist/static
+EDITOR_REPO_DEFAULT = https://github.com/exelearning/exelearning.git
+EDITOR_REF_DEFAULT = main
+
+# Check if bun is installed
+check-bun:
+ @command -v bun > /dev/null 2>&1 || (echo "Error: bun is not installed. Please install bun: https://bun.sh" && exit 1)
+
+# Fetch editor source code from remote repository (branch/tag, shallow clone)
+fetch-editor-source:
+ @set -e; \
+ get_env() { \
+ if [ -f .env ]; then \
+ grep -E "^$$1=" .env | tail -n1 | cut -d '=' -f2-; \
+ fi; \
+ }; \
+ REPO_URL="$${EXELEARNING_EDITOR_REPO_URL:-$$(get_env EXELEARNING_EDITOR_REPO_URL)}"; \
+ REF="$${EXELEARNING_EDITOR_REF:-$$(get_env EXELEARNING_EDITOR_REF)}"; \
+ REF_TYPE="$${EXELEARNING_EDITOR_REF_TYPE:-$$(get_env EXELEARNING_EDITOR_REF_TYPE)}"; \
+ if [ -z "$$REPO_URL" ]; then REPO_URL="$(EDITOR_REPO_DEFAULT)"; fi; \
+ if [ -z "$$REF" ]; then REF="$${EXELEARNING_EDITOR_DEFAULT_BRANCH:-$$(get_env EXELEARNING_EDITOR_DEFAULT_BRANCH)}"; fi; \
+ if [ -z "$$REF" ]; then REF="$(EDITOR_REF_DEFAULT)"; fi; \
+ if [ -z "$$REF_TYPE" ]; then REF_TYPE="auto"; fi; \
+ echo "Fetching editor source from $$REPO_URL (ref=$$REF, type=$$REF_TYPE)"; \
+ rm -rf $(EDITOR_SUBMODULE_PATH); \
+ git init -q $(EDITOR_SUBMODULE_PATH); \
+ git -C $(EDITOR_SUBMODULE_PATH) remote add origin "$$REPO_URL"; \
+ case "$$REF_TYPE" in \
+ tag) \
+ git -C $(EDITOR_SUBMODULE_PATH) fetch --depth 1 origin "refs/tags/$$REF:refs/tags/$$REF"; \
+ git -C $(EDITOR_SUBMODULE_PATH) checkout -q "tags/$$REF"; \
+ ;; \
+ branch) \
+ git -C $(EDITOR_SUBMODULE_PATH) fetch --depth 1 origin "$$REF"; \
+ git -C $(EDITOR_SUBMODULE_PATH) checkout -q FETCH_HEAD; \
+ ;; \
+ auto) \
+ if git -C $(EDITOR_SUBMODULE_PATH) fetch --depth 1 origin "refs/tags/$$REF:refs/tags/$$REF" > /dev/null 2>&1; then \
+ echo "Resolved $$REF as tag"; \
+ git -C $(EDITOR_SUBMODULE_PATH) checkout -q "tags/$$REF"; \
+ else \
+ echo "Resolved $$REF as branch"; \
+ git -C $(EDITOR_SUBMODULE_PATH) fetch --depth 1 origin "$$REF"; \
+ git -C $(EDITOR_SUBMODULE_PATH) checkout -q FETCH_HEAD; \
+ fi; \
+ ;; \
+ *) \
+ echo "Error: EXELEARNING_EDITOR_REF_TYPE must be one of: auto, branch, tag"; \
+ exit 1; \
+ ;; \
+ esac
+
+# Build static editor to dist/static/
+build-editor: check-bun fetch-editor-source
+ cd $(EDITOR_SUBMODULE_PATH) && bun install && bun run build:static
+ @mkdir -p $(EDITOR_DIST_PATH)
+ @rm -rf $(EDITOR_DIST_PATH)/*
+ cp -r $(EDITOR_SUBMODULE_PATH)/dist/static/* $(EDITOR_DIST_PATH)/
+
+# Backward-compatible alias
+build-editor-no-update: build-editor
+
+# Remove build artifacts
+clean-editor:
+ rm -rf $(EDITOR_DIST_PATH)
+
+# -------------------------------------------------------
+# Packaging
+# -------------------------------------------------------
+
+PLUGIN_NAME = mod_exeweb
+
+# Create a distributable ZIP package
+# Usage: make package RELEASE=0.0.2
+# VERSION (YYYYMMDDXX) is auto-generated from current date
+package:
+ @if [ -z "$(RELEASE)" ]; then \
+ echo "Error: RELEASE not specified. Use 'make package RELEASE=0.0.2'"; \
+ exit 1; \
+ fi
+ $(eval DATE_VERSION := $(shell date +%Y%m%d)00)
+ @echo "Packaging release $(RELEASE) (version $(DATE_VERSION))..."
+ $(SED_INPLACE) "s/\(plugin->version[[:space:]]*=[[:space:]]*\)[0-9]*/\1$(DATE_VERSION)/" version.php
+ $(SED_INPLACE) "s/\(plugin->release[[:space:]]*=[[:space:]]*'\)[^']*/\1$(RELEASE)/" version.php
+ @echo "Creating ZIP archive: $(PLUGIN_NAME)-$(RELEASE).zip..."
+ rm -rf /tmp/exeweb-package
+ mkdir -p /tmp/exeweb-package/exeweb
+ rsync -av --exclude-from=.distignore ./ /tmp/exeweb-package/exeweb/
+ cd /tmp/exeweb-package && zip -qr "$(CURDIR)/$(PLUGIN_NAME)-$(RELEASE).zip" exeweb
+ rm -rf /tmp/exeweb-package
+ @echo "Restoring version.php..."
+ $(SED_INPLACE) "s/\(plugin->version[[:space:]]*=[[:space:]]*\)[0-9]*/\19999999999/" version.php
+ $(SED_INPLACE) "s/\(plugin->release[[:space:]]*=[[:space:]]*'\)[^']*/\1dev/" version.php
+ @echo "Package created: $(PLUGIN_NAME)-$(RELEASE).zip"
+
+# -------------------------------------------------------
+
# Display help with available commands
# This target lists all available Makefile commands with a brief description.
help:
@echo "Available commands:"
- @echo " up - Start Docker containers in interactive mode"
- @echo " upd - Start Docker containers in background mode (daemon)"
- @echo " down - Stop and remove Docker containers"
- @echo " build - Build or rebuild Docker containers"
- @echo " pull - Pull the latest images from the registry"
- @echo " clean - Clean up and stop Docker containers, removing volumes and orphan containers"
- @echo " shell - Open a shell inside the exelearning-web container"
- @echo " install-deps - Install PHP dependencies using Composer"
- @echo " lint - Run code linting using Composer"
- @echo " fix - Automatically fix code style issues using Composer"
- @echo " test - Run tests using Composer"
- @echo " phpmd - Run PHP Mess Detector using Composer"
- @echo " behat - Run Behat tests using Composer"
- @echo " help - Display this help with available commands"
+ @echo " up - Start Docker containers in interactive mode"
+ @echo " upd - Start Docker containers in background mode (daemon)"
+ @echo " down - Stop and remove Docker containers"
+ @echo " build - Build or rebuild Docker containers"
+ @echo " pull - Pull the latest images from the registry"
+ @echo " clean - Clean up and stop Docker containers, removing volumes and orphan containers"
+ @echo " shell - Open a shell inside the exelearning-web container"
+ @echo " install-deps - Install PHP dependencies using Composer"
+ @echo " lint - Run code linting using Composer"
+ @echo " fix - Automatically fix code style issues using Composer"
+ @echo " test - Run tests using Composer"
+ @echo " phpmd - Run PHP Mess Detector using Composer"
+ @echo " behat - Run Behat tests using Composer"
+ @echo " build-editor - Build embedded static editor"
+ @echo " build-editor-no-update - Alias of build-editor"
+ @echo " clean-editor - Remove editor build artifacts"
+ @echo " fetch-editor-source - Download editor source from configured repo/ref"
+ @echo " package - Create distributable ZIP (RELEASE=X.Y.Z required)"
+ @echo " help - Display this help with available commands"
# Set help as the default goal if no target is specified
diff --git a/README.md b/README.md
index 5fc3dc0..75429d9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# eXeLearning web sites for Moodle
+[](https://ateeducacion.github.io/moodle-playground/?blueprint-url=https://raw.githubusercontent.com/exelearning/mod_exeweb/refs/heads/main/blueprint.json)
+
Activity-type module to create and edit web sites with eXeLearning (online).
You need the eXeLearning online version installed (ws28 or higher) and access to its configuration files to run
@@ -13,22 +15,25 @@ This plugin version is tested for:
* Moodle 3.11.10+ (Build: 20221007)
* Moodle 3.9.2+ (Build: 20200929)
-## Installing via uploaded ZIP file ##
+## Installation
-1. Log in to your Moodle site as an admin and go to _Site administration >
- Plugins > Install plugins_.
-2. Upload the ZIP file with the plugin code. You should only be prompted to add
- extra details if your plugin type is not automatically detected.
-3. Check the plugin validation report and finish the installation.
+> **Important:** It is recommended to install from a [release ZIP](https://github.com/exelearning/mod_exeweb/releases), which includes the embedded editor pre-built for optimal performance. If the release ZIP does not include the editor, or if you want to install a newer version, administrators can download it from GitHub Releases via the _Manage embedded editor_ page in the plugin settings.
-## Installing manually ##
+### Installing via uploaded ZIP file
-The plugin can be also installed by putting the contents of this directory to
+1. Download the latest ZIP from [Releases](https://github.com/exelearning/mod_exeweb/releases).
+2. Log in to your Moodle site as an admin and go to _Site administration >
+ Plugins > Install plugins_.
+3. Upload the ZIP file with the plugin code. You should only be prompted to add
+ extra details if your plugin type is not automatically detected.
+4. Check the plugin validation report and finish the installation.
- {your/moodle/dirroot}/mod/exeweb
+### Installing manually
-Afterwards, log in to your Moodle site as an admin and go to _Site administration >
-Notifications_ to complete the installation.
+1. Download and extract the latest ZIP from [Releases](https://github.com/exelearning/mod_exeweb/releases).
+2. Place the extracted contents in `{your/moodle/dirroot}/mod/exeweb`.
+3. Log in to your Moodle site as an admin and go to _Site administration >
+ Notifications_ to complete the installation.
Alternatively, you can run
@@ -61,108 +66,29 @@ Go to the URL:
* A mandatory files list can be configurad here. Enter each mandatory file as a PHP regular expression (RE) on a new line.
* Forbidden files RE list: *exeweb | forbiddenfileslist*
-
* A forbidden files list can be configurad here. Enter each forbidden file as a PHP regular expression (RE) on a new line.
+## Embedded Editor Management
-## Development using Makefile
-
-To facilitate development, a `Makefile` is included to simplify Docker-based workflows.
-
-### Requirements
-
-- Docker
-- Docker Compose
-
-### Available Commands
-
-- **Pull the latest images**:
- To pull the latest Docker images from the registry, use:
-
- ```bash
- make pull
- ```
- > **Note**: Docker need to be logged in ghcr.io *([more info...])(https://docs.github.com/es/packages/working-with-a-github-packages-registry/working-with-the-container-registry)*
-
-- **Start the development environment**:
- To start the Docker containers in interactive mode, run:
-
- ```bash
- make up
- ```
-
- To start the containers in the background (daemon mode), run:
-
- ```bash
- make upd
- ```
-
-- **Build the Docker containers**:
- You can build the Docker containers using the following command. This will also check if the `EXELEARNING_WEB_SOURCECODE_PATH` is defined in the `.env` file:
-
- ```bash
- make build
- ```
-
- > **Note**: If `EXELEARNING_WEB_SOURCECODE_PATH` is not defined, the build will fail and display an error message.
-
-- **Access a shell in the Moodle container**:
- To open a shell inside the running Moodle container, use:
-
- ```bash
- make shell
- ```
-
-- **Stop and remove containers**:
- To stop and remove the running Docker containers, run:
-
- ```bash
- make down
- ```
-
-- **Clean up the environment**:
- To stop and remove all Docker containers, volumes, and orphaned containers, run:
-
- ```bash
- make clean
- ```
-
-### Environment Variables
-
-You can configure various settings using the `.env` file. If this file does not exist, it will be automatically generated by copying from `.env.dist`. Key variables to configure:
-
-- `EXELEARNING_WEB_SOURCECODE_PATH`: Define the path to the eXeLearning source code if you want to work with a local version.
-- `APP_PORT`: Define the port on which the application will run.
-- `APP_SECRET`: Set a secret key for the application.
-
-### Example Workflow
-
-1. Ensure you have Docker running and properly configured.
-2. Define your environment variables in the `.env` file or copy from `.env.dist`.
-3. Pull the latest Docker images:
+The plugin supports two editor sources with the following precedence:
- ```bash
- make pull
- ```
+1. **Admin-installed** (moodledata): Downloaded from GitHub Releases via the admin management page. Stored under `moodledata/mod_exeweb/embedded_editor/`.
+2. **Bundled** (plugin): Included in the plugin release ZIP at `dist/static/`.
-4. Start the environment:
+An admin-installed version always takes precedence over the bundled version. If neither source is available, the embedded editor cannot be used.
- ```bash
- make up
- ```
+### Managing the editor
-5. Build the environment if necessary:
+1. Go to _Site administration > Plugins > Activity modules > eXeLearning (website)_.
+2. The settings page shows the current editor status and active source.
+3. Click _Manage embedded editor_ to access the management page.
+4. From there you can install, update, repair, or remove the editor.
- ```bash
- make build
- ```
+The management page requires the `moodle/site:config` and `mod/exeweb:manageembeddededitor` capabilities.
-6. Once development is complete, stop and clean up the environment:
+## Development
- ```bash
- make down
- make clean
- ```
+For development setup, build instructions, and contributing guidelines, see [DEVELOPMENT.md](DEVELOPMENT.md).
## About
diff --git a/amd/build/admin_embedded_editor.min.js b/amd/build/admin_embedded_editor.min.js
new file mode 100644
index 0000000..51ba9a1
--- /dev/null
+++ b/amd/build/admin_embedded_editor.min.js
@@ -0,0 +1,559 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle. If not, see .
+
+/**
+ * AMD module for the admin embedded editor settings widget.
+ *
+ * All install/update flows go through the plugin's AJAX endpoints. In Moodle
+ * Playground, outbound requests are handled by the PHP WASM networking layer
+ * configured by the runtime.
+ *
+ * @module mod_exeweb/admin_embedded_editor
+ * @copyright 2025 eXeLearning
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+define(['jquery', 'core/ajax', 'core/notification', 'core/str'], function($, Ajax, Notification, Str) {
+
+ /** Maximum seconds to wait before switching to polling. */
+ var ACTION_TIMEOUT_MS = 120000;
+
+ /** Polling interval in milliseconds. */
+ var POLL_INTERVAL_MS = 10000;
+
+ /** Maximum number of polling iterations (5 minutes). */
+ var MAX_POLL_ITERATIONS = 30;
+
+ /**
+ * Find the widget container element.
+ *
+ * @returns {jQuery} The container element.
+ */
+ var getContainer = function() {
+ return $('.mod_exeweb-admin-embedded-editor').first();
+ };
+
+ /**
+ * Return runtime configuration derived from PHP context.
+ *
+ * @param {Object} config Configuration object passed from PHP.
+ * @returns {Object}
+ */
+ var getRuntimeConfig = function(config) {
+ return config || {};
+ };
+
+ /**
+ * Return the latest-version UI elements used by the widget.
+ *
+ * @param {jQuery} container The widget container.
+ * @returns {{spinnerEl: jQuery, textEl: jQuery}}
+ */
+ var getLatestVersionElements = function(container) {
+ return {
+ spinnerEl: container.find('.mod_exeweb-latest-version-spinner'),
+ textEl: container.find('.mod_exeweb-latest-version-text'),
+ };
+ };
+
+ /**
+ * Disable all action buttons in the widget.
+ *
+ * @param {jQuery} container The widget container.
+ */
+ var disableButtons = function(container) {
+ container.find('[data-action]').prop('disabled', true);
+ };
+
+ /**
+ * Enable action buttons based on current status data.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {Object} statusData Status object from get_status response.
+ */
+ var enableButtons = function(container, statusData) {
+ container.find('.mod_exeweb-btn-install').prop('disabled', true).hide();
+ container.find('.mod_exeweb-btn-update').prop('disabled', true).hide();
+ container.find('.mod_exeweb-btn-uninstall').prop('disabled', true).hide();
+
+ if (statusData.can_install) {
+ container.find('.mod_exeweb-btn-install').prop('disabled', false).show();
+ }
+ if (statusData.can_update) {
+ container.find('.mod_exeweb-btn-update').prop('disabled', false).show();
+ }
+ if (statusData.can_uninstall) {
+ container.find('.mod_exeweb-btn-uninstall').prop('disabled', false).show();
+ }
+ };
+
+ /**
+ * Show the progress bar area and hide the result area.
+ *
+ * @param {jQuery} container The widget container.
+ */
+ var showProgress = function(container) {
+ container.find('.mod_exeweb-progress-container').show();
+ container.find('.mod_exeweb-result-area').hide();
+ };
+
+ /**
+ * Hide the progress bar area.
+ *
+ * @param {jQuery} container The widget container.
+ */
+ var hideProgress = function(container) {
+ container.find('.mod_exeweb-progress-container').hide();
+ };
+
+ /**
+ * Set the progress bar visual state.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {string} state One of active, success, or error.
+ * @param {string} message Optional message to display below the bar.
+ */
+ var setProgressState = function(container, state, message) {
+ var bar = container.find('.mod_exeweb-progress-container .progress-bar');
+ var msgEl = container.find('.mod_exeweb-progress-message');
+
+ bar.removeClass('bg-success bg-danger progress-bar-striped progress-bar-animated');
+ bar.css('width', '100%');
+ bar.attr('aria-valuenow', 100);
+
+ if (state === 'active') {
+ bar.addClass('progress-bar-striped progress-bar-animated');
+ } else if (state === 'success') {
+ bar.addClass('bg-success');
+ } else if (state === 'error') {
+ bar.addClass('bg-danger');
+ }
+
+ msgEl.text(message || '');
+ };
+
+ /**
+ * Render the latest-version text, optionally with an update badge.
+ *
+ * @param {jQuery} textEl Target element.
+ * @param {string} text Main text to show.
+ * @param {string|null} badgeText Optional badge label.
+ */
+ var setLatestVersionText = function(textEl, text, badgeText) {
+ if (badgeText) {
+ textEl.html(text + ' ' + badgeText + '');
+ } else {
+ textEl.text(text);
+ }
+ };
+
+ /**
+ * Escape HTML special characters in plain text.
+ *
+ * @param {string} value Plain text.
+ * @returns {string}
+ */
+ var escapeHtml = function(value) {
+ return $('
').text(value || '').html();
+ };
+
+ /**
+ * Update the primary status summary shown on the left of the header row.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {Object} statusData Status object from get_status response.
+ */
+ var updateStatusSummary = function(container, statusData) {
+ var summaryEl = container.find('.mod_exeweb-status-primary');
+ if (!summaryEl.length) {
+ return;
+ }
+
+ Str.get_strings([
+ {key: 'editormoodledatasource', component: 'mod_exeweb'},
+ {key: 'editorinstalledat', component: 'mod_exeweb'},
+ {key: 'editorbundledsource', component: 'mod_exeweb'},
+ {key: 'editorbundleddesc', component: 'mod_exeweb'},
+ {key: 'noeditorinstalled', component: 'mod_exeweb'},
+ {key: 'editornotinstalleddesc', component: 'mod_exeweb'},
+ ]).then(function(strings) {
+ var html = '';
+
+ if (statusData.active_source === 'moodledata') {
+ html += '' + escapeHtml(strings[0]) + '';
+ if (statusData.moodledata_version) {
+ html += 'v' +
+ escapeHtml(statusData.moodledata_version) + '';
+ }
+ if (statusData.moodledata_installed_at) {
+ html += '' + escapeHtml(strings[1]) + ' ' +
+ escapeHtml(statusData.moodledata_installed_at) + '';
+ }
+ } else if (statusData.active_source === 'bundled') {
+ html += '' + escapeHtml(strings[2]) + '';
+ html += '' + escapeHtml(strings[3]) + '';
+ } else {
+ html += '' + escapeHtml(strings[4]) + '';
+ html += '' + escapeHtml(strings[5]) + '';
+ }
+
+ summaryEl.html(html);
+ }).catch(function() {
+ // Keep the current markup if the strings cannot be loaded.
+ });
+ };
+
+ /**
+ * Fetch the latest-version prefix label.
+ *
+ * @param {string} version Version string.
+ * @returns {Promise}
+ */
+ var getLatestVersionLabel = function(version) {
+ return Str.get_string('editorlatestversionongithub', 'mod_exeweb')
+ .then(function(prefix) {
+ return prefix + ' v' + version;
+ })
+ .catch(function() {
+ return 'v' + version;
+ });
+ };
+
+ /**
+ * Fetch the optional update-available badge label.
+ *
+ * @param {Object} statusData Status object from get_status response.
+ * @returns {Promise}
+ */
+ var getLatestVersionBadgeLabel = function(statusData) {
+ if (!statusData.update_available) {
+ return Promise.resolve(null);
+ }
+
+ return Str.get_string('updateavailable', 'mod_exeweb')
+ .catch(function() {
+ return Str.get_string('editorupdateavailable', 'mod_exeweb', statusData.latest_version);
+ })
+ .catch(function() {
+ return null;
+ });
+ };
+
+ /**
+ * Update the latest version area in the DOM.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {Object} statusData Status object from get_status response.
+ */
+ var updateLatestVersionArea = function(container, statusData) {
+ var elements = getLatestVersionElements(container);
+ var spinnerEl = elements.spinnerEl;
+ var textEl = elements.textEl;
+
+ spinnerEl.hide();
+ textEl.show();
+
+ if (statusData.latest_error) {
+ textEl.text('(' + statusData.latest_error + ')');
+ } else if (statusData.latest_version) {
+ Promise.all([
+ getLatestVersionLabel(statusData.latest_version),
+ getLatestVersionBadgeLabel(statusData),
+ ]).then(function(results) {
+ setLatestVersionText(textEl, results[0], results[1]);
+ }).catch(function() {
+ textEl.text('v' + statusData.latest_version);
+ });
+ } else {
+ textEl.text('');
+ }
+ };
+
+ /**
+ * Update all DOM elements based on a get_status response.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {Object} statusData Status object from get_status response.
+ */
+ var updateStatus = function(container, statusData) {
+ updateStatusSummary(container, statusData);
+ updateLatestVersionArea(container, statusData);
+ enableButtons(container, statusData);
+ };
+
+ /**
+ * Show a result message in the result area.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {string} message The message text.
+ * @param {string} type Bootstrap alert type.
+ */
+ var showResultMessage = function(container, message, type) {
+ var resultArea = container.find('.mod_exeweb-result-area');
+ var msgEl = container.find('.mod_exeweb-result-message');
+
+ msgEl.removeClass('alert-success alert-danger alert-warning')
+ .addClass('alert-' + type)
+ .text(message);
+ resultArea.show();
+ };
+
+ /**
+ * Call get_status via AJAX and return a Promise.
+ *
+ * @param {boolean} checklatest Whether to query GitHub for the latest version.
+ * @returns {Promise}
+ */
+ var callGetStatus = function(checklatest) {
+ var requests = Ajax.call([{
+ methodname: 'mod_exeweb_manage_embedded_editor_status',
+ args: {checklatest: !!checklatest},
+ }]);
+ return requests[0];
+ };
+
+ /**
+ * Call execute_action via AJAX and return a Promise.
+ *
+ * @param {string} action One of install, update, repair, uninstall.
+ * @returns {Promise}
+ */
+ var callExecuteAction = function(action) {
+ var requests = Ajax.call([{
+ methodname: 'mod_exeweb_manage_embedded_editor_action',
+ args: {action: action},
+ }]);
+ return requests[0];
+ };
+
+ /**
+ * Refresh widget status from the server and optionally enrich latest version.
+ *
+ * @param {jQuery} container The widget container.
+ * @param {boolean} checklatest Whether latest version should be queried.
+ * @param {Object} runtimeConfig Runtime config.
+ * @returns {Promise