Skip to content

AGILEDROP/moodle-local_moopanel

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

106 Commits
classes
classes
 
 
db
db
 
 
lang/en
lang/en
 
 
pages
pages
 
 
script
script
 
 
README.md
README.md
 
 
index.php
index.php
 
 
lib.php
lib.php
 
 
server.php
server.php
 
 
settings.php
settings.php
 
 
version.php
version.php
 
 

Repository files navigation

MooPanel API

Overview

This plugin provide an API to enable communication between Moodle and MooPanel Application.

Install

  • Clone this repository into the folder '/local'.
  • Access the notification area in moodle and install (or run admin/cli/update.php)

Getting started

To enable communication with MooPanel, first go in Moopanel App and follow steps to add new instance (you must copy url of Moodle). Moopanel App provide you an API-key which you must paste into plugin config.

Authorisation

Moopanel API use API-key authorisation type. Please add X-API-KEY key and its value to request header.

General responses

By default, all responses are in json format. Here is a list of possible responses.

Status code Status Message
200 ok Response contain requested data.
400 bad request Missing some request details.
401 unaothorized Authorization failed.
401 unaothorized Authorization key required.
404 not found Endpoint not found.
405 not allowed Method not allowed.
423 locked Api is disabled.
501 not implemented Not implemented yet.

Available endpoints

All endpoints url starts with Moodle root url + /local/moopanel/server.php.

Endpoint / or /test_connection

GET / 
GET /test_connection

Return response with basic information about Moodle installation. No parameters needed.

Example response:

{
  "url": "https://moodle.ddev.site",
  "site_fullname": "Moodle test page",
  "logo": "https://moodle.ddev.site/pluginfile.php/1/theme_mtul_slim/logo/300x300/1717771447/logo.png",
  "theme": "mtul_slim",
  "moodle_version": "4.3.2 (Build: 20231222)"
}

Endpoint /dashboard

GET /dashboard

Return response with some additional information about Moodle installation. No parameters needed.

Example response:

{
  "url": "https://moodle.ddev.site",
  "site_fullname": "Moodle test page",
  "site_shortname": "TitleShort",
  "logo": "https://moodle.ddev.site/pluginfile.php/1/theme_mtul_slim/logo/300x300/1717771447/logo.png",
  "logocompact": "https://moodle.ddev.site/pluginfile.php/1/theme_mtul_slim/logo/300x300/1717771447/logocompact.png",
  "theme": "mtul_slim",
  "moodle_version": "4.3.2 (Build: 20231222)"
}

Endpoint /api_key_status

GET /api_key_status

Return information about API key (currently only 'key_expiration_date').

Example 1 response:

{
  "key_expiration_date": "04/10/2024 13:34:50"
}

Example 2 response:

{
  "key_expiration_date": "permanent"
}
POST /api_key_status

Update existing API key.

Request body parameters

Parameter Type Description
key_expiration_date timestamp \ null Required. Validation end date timestamp or null for permanent.

Possible response errors

Status code Status Message
400 bad request Missing API key expiration_date.

Request body example 1 (fixed date)

{
    "data": {
        "key_expiration_date": 1234567899
        }
}

request body example 2 (api key is permanent)

{
    "data": {
        "key_expiration_date": null
        }
}

Response example

{
    "status": true,
    "key_expiration_date": "permanent"
}

Endpoint /users

GET /users

Return list of all Moodle users with all available fields if no parameters provided.

Available parameters

Parameter Type Description Example
search string Optional. A simple string to search for users. ?search=abc
sort string Optional. A SQL snippet for the sorting criteria to use. ?sort=firstname
fields string Optional. A comma separated list of fields to be returned from the chosen table. ?fields=id,firstname,lastname

Example request:

GET /users?search=ab&sort=firstname DESC&fields=id,firstname,lastname

Example response:

{
    "number_of_users": 2,
    "users": [
        {
            "id": "1234",
            "firstname": "Name 1",
            "lastname": "Lastname 1"
        },
        {
            "id": "5678",
            "firstname": "Name 2",
            "lastname": "Lastname 2"
        }
    ]
}

Endpoint /users/online

GET /users/online

Return number of online users. If no parameters provided, get online users for last 5 minutes. If both parameters provided, return online users between timeStart and timeEnd.

Available parameters

Parameter Type Description Example
timeStart timestamp Optional. User last access greater than timeStart. ?timeStart=1716796022
timeEnd timestamp Optional. User last access lower then timeEnd. ?timeEnd=1716796022

Possible response errors

Status code Status Message
400 bad request StartTime must be less than endTime.

Example request

GET /users/online?timeStart=1716796022&timeEnd=1716796022

Example response

{
    "all_users": 1136,
    "online": 719
}

Endpoint /users/count

GET /users/count

Return number of all Moodle users. No parameters needed.

Exapmpe response

{
    "number_of_users": 1135
}

Endpoint /user

[GET request]

Return details for selected user. Filter can be provided in parameters. One of available parameters ins required.

Available parameters

Parameter Type Description Example
id integer Id of selected user. ?id=1234
username string Username of selected user. ?username=user123
upn string Upn of selected user. ?upn=user123
email email Email of selected user. ?email=[email protected]

Possible response errors

Status code Status Message
400 bad request No parameters provided.
400 bad request User not found.

Examples request:

GET /[email protected]

Example response

{
    "user": {
        "id": "2",
        "auth": "manual",
        "username": "user1",
        "firstname": "Username 1",
        "lastname": "Lastname 1",
        "email": "[email protected]",
        "...": "..."
    }
}

Endpoint /plugins

GET /plugins

Return list of all moodle plugins. Display options can be provided via parameters. Parameters are like flags, no need for special values.

Available parameters

Parameter Type Description
displayupdates flag Optional. Display available updates for each plugin.
displayupdateslog flag Optional. Display updates log for each plugin.

Exaples reqest:

GET /plugins?displayupdates
GET /plugins?displayupdateslog
GET /plugins?displayupdates&displayupdateslog

Example response:

{
    "last_check_for_updates": "1718014816",
    "plugins": [
        {
          "plugin": "multitopic",
          "plugintype": "format",
          "display_name": "Multitopic format",
          "component": "format_multitopic",
          "version": "2023111301",
          "enabled": true,
          "is_standard": false,
          "has_updates": true,
          "settings_section": "formatsettingmultitopic",
          "directory": "/course/format/multitopic",
          "update_available": [
            {
              "component": "format_multitopic",
              "version": "2024051601",
              "release": "v4.4.1",
              "maturity": 200,
              "url": "https://moodle.org/plugins/pluginversion.php?id=32099",
              "download": "https://moodle.org/plugins/download.php/32099/format_multitopic_moodle44_2024051601.zip",
              "downloadmd5": "bca35e6f08eb2749376c492219058042",
              "type": "plugin"
            }
          ],
          "update_log": [
            {
              "id": 1343,
              "type": 0,
              "plugin": "format_multitopic",
              "version": "2023111301",
              "targetversion": "2023111301",
              "info": "Plugin installed",
              "details": null,
              "backtrace": "",
              "userid": 2,
              "timemodified": 1707745358,
              "username": "admin",
              "email": "[email protected]"
            }
          ]
        }
    ]
}

Endpoint /plugins/updates

POST /plugins/updates

Install plugin updates provided in request body.

Possible response errors

Status code Status Message
400 bad request No updates specified.

Example request body

{
    "data": {
      "updates": [
        {
          "model_id": 1234,
          "component": "theme_learnr",
          "version": "2024021300",
          "release": "4.3.3",
          "download" : "https://moodle.org/plugins/download.php/31128/theme_learnr_moodle43_2024021300.zip"
        },
        {
          "model_id": 4567,
          "component": "theme_learnr",
          "version": "2024021300",
          "release": "4.3.3",
          "download" : "https://moodle.org/plugins/download.php/31128/theme_learnr_moodle43_2024021300.zip"
        }
     ]
   }
}

Example response

{
    "updates": [
        {
            "1234": {
                "status": true,
                "component": "tool_opencast",
                "error": null
            }
        },
        {
            "4567": {
                "status": false,
                "component": "tool_opencast",
                "error": "Plugin not exist in Moodle."
            }
        }
    ]
}

Endpoint /plugins/installzip

POST /plugins/installzip

Install plugins from zip files, provided in request body.

Possible response errors

Status code Status Message
400 bad request No zip files urls specified.

Example request body

{
  "data": {
    "updates": [
      "https://moodle.org/plugins/download.php/31629/theme_adaptable_moodle43_2023111805.zip",
      "https://link2.zip"
    ]
  }
}

Example response body

{
  "updates": {
    "https://moodle.org/plugins/download.php/31629/theme_adaptable_moodle43_2023111805.zip": {
      "component": "theme_adaptable",
      "status": true,
      "error": null
    },
    "https://link2.zip": {
      "component": null,
      "status": false,
      "error": "Invalid zip file."
    }
  }
}

Endpoint /plugin

GET /plugin

Return detailed information for selected plugin. Please use component name (frankenstyle) for selected plugin (see example)

Available parameters

Parameter Type Description Example
plugin integer Required. Plugin component name.. ?plugin=theme_mtul
displayupdates flag Optional. Display available updates. ?displayupdates
displayupdateslog flag Optional. Display updates log. ?displayupdateslog
displayconfig flag Optional.. Display current config. ?displayconfig

Possible response errors

Status code Status Message
400 bad request Plugin not specified.
400 bad request Plugin not exist.

Example request:

GET /plugin?plugin=theme_mtul&displayupdates&displayupdateslog&displayconfig

Example response:

{
    "plugininfo": {
        "type": "theme",
        "typerootdir": "/var/www/html/public/theme",
        "name": "mtul",
        "displayname": "MTUL",
        "source": "ext",
        "rootdir": "/var/www/html/public/theme/mtul",
        "versiondisk": 2024032700,
        "versiondb": "2024032700",
        "versionrequires": 2016070700,
        "pluginsupported": null,
        "pluginincompatible": null,
        "release": "1.1.0",
        "instances": null,
        "sortorder": null,
        "supported": null,
        "incompatible": null,
        "component": "theme_mtul"
    },
    "last_check_for_updates": "1718015575",
    "update_available": [],
    "update_log": [
        {
            "id": 1550,
            "type": 0,
            "plugin": "theme_mtul",
            "version": "2024032700",
            "targetversion": "2024032700",
            "info": "Plugin upgraded",
            "details": null,
            "backtrace": "",
            "userid": null,
            "timemodified": 1711534904,
            "username": null,
            "email": null
        }
    ],
    "pluginconfig": {
        "brandcolor": "",
        "faq_type": "login_page",
        "logo": "/UL_AGRFT-logoVER-RGB_barv.svg",
        "logocompact": "/UL_AGRFT_logoHOR-RGB_barv.svg",
        "preset": "default.scss",
        "summaryheight": "50px",
        "welcome_message_en": "Welcome in English language."
    }
}

Endpoint /moodle_core

GET /moodle_core

Return:

  • details about current moodle version.
  • check for available updates for moodle core
  • update logs

ToDo

  • create parameters (displayupdates, displayupdateslog)

Endpoint /moodle_core/update

POST /moodle_core/update

Update Moodle Core. Not implemented yet.

ToDo

  • create update install script

Endpoint /admin_presets

GET /admin_presets

Create request for generate admin presets xml configuration export for Moodle core and all installed plugins. Return status for accepted request and then make post request to Moopanel app when xml is generated.

Available parameters

Parameter Type Description Example
instanceid integer Required. Id of Moodle instance page in Moopanel. ?instanceid=1234

Possible response errors

Status code Status Message
501 not implemented Admin presets plugin not found.
503 service unavailable Service Unavailable - try again later.
403 bad request Please provide a valid instance ID.

Example request

GET /admin_presets?instanceid=1234

Example response (step 1)

{
    "status": true,
    "message": "Admin presets creation in progress"
}

Example response (step 2)

If "status" = true in step 1, then start building xml content for admin presets and Send post request with xml content to Moopanel.

POST [moopanel_url]/api/instances/[instanceid]/admin_preset
<?xml version="1.0" encoding="UTF-8"?>
<PRESET>
    <NAME>Moopanel</NAME>
    <COMMENTS>Preset for MooPanel application created on 13.06.2024 - 01:23:45</COMMENTS>
    <PRESET_DATE>1718235518</PRESET_DATE>
    <SITE_URL>https://example.com</SITE_URL>
    <AUTHOR>Moopanel App</AUTHOR>
    <MOODLE_VERSION>2023100904.04</MOODLE_VERSION>
    <MOODLE_RELEASE>4.3.4+ (Build: 20240516)</MOODLE_RELEASE>
    <ADMIN_SETTINGS>
        <NONE>
            <SETTINGS>
                ...
            </SETTINGS>
        </NONE>
    </ADMIN_SETTINGS>
</PRESET>

ToDo

  • send POST request custom headers (X-API-KEX )

Endpoint /tasks/check

GET /tasks/check

Return information for selected adhoc task.

Available parameters

Parameter Type Description Example
id integer Required. Adhoc task id. ?id=1234
type string Required. Adhoc task type. ?type=plugins_update

Possible response errors

Status code Status Message
400 bad request Id not specified.
400 bad request Type not specified.

Example request:

GET /tasks/check?id=1234&type=plugins_update

Example response:

{
    "status": 1,
    "error": ""
}

Endpoint /courses

GET /courses

Return information about courses and course categories. If no parameters provided, return only number of all courses and al course categories.

Available parameters

Parameter Type Description Example
displaycourses flag Optional. Display courses list. ?displaycourses
displaycategories flag Optional. Display course categories list. ?displaycategories

Example 1 request:

GET /courses

Example 1 response:

{
  "number_of_categories": 4,
  "number_of_courses": 666
}

Example 2 request:

GET /courses?displaycategories&displaycourses

Example 2 response:

{
  "number_of_categories": 4,
  "number_of_courses": 666,
  "categories": [
    {
      "id": 1,
      "parent": 1,
      "name": "Category 1",
      "sort": 10000,
      "path": "/1",
      "depth": 1
    },
    {
      "id": 2,
      "parent": 0,
      "name": "2023/2024",
      "sort": 20000,
      "path": "/2",
      "depth": 1
    },
    "..."
  ],
  "courses": [
    {
      "id": 1,
      "category": 1,
      "name": "Course title 1"
    },
    {
      "id": 2,
      "category": 1,
      "name": "Course title 2"
    },
    "..."
  ]
}

Endpoint /backups

GET /backups

Return information about courses backup in progress. No parameters needed.

Example response:

{
  "backups_in_progress": [
    {
      "id": 2206,
      "message": "in progress"
    },
    {
      "id": 2207,
      "message": "in progress"
    },
    {
      "id": 2208,
      "message": "in progress"
    }
  ]
}
POST /backups

Specify moodle course ids in request body for which you wan to create backups. No parameters needed.

Request body example

{
  "data": {
    "instance_id": 666,
    "storage": "local",
    "mode": "auto",
    "credentials": {
      "url": "https://test-link-for-storage.com/folder",
      "api-key": "abcd1234",
      "key2": "efgh5678"
    },

    "courses": [ 5, 6, 7, 2206, 2207, 2208 ]
  }
}

Moodle adhoc task will be created for existing course.

Response body example (step 1)

{
  "backups": [
    {
      "id": 2206,
      "message": "Backup will be created."
    },
    {
      "id": 2207,
      "message": "Backup will be created."
    },
    {
      "id": 2208,
      "message": "Backup will be created."
    }
  ],
  "errors": [
    {
      "id": 5,
      "message": "Course not exist."
    },
    {
      "id": 6,
      "message": "Course not need backup."
    },
    {
      "id": 7,
      "message": "Course not exist."
    }
  ]
}

Moodle will process taks ASAP. When finished each task, send post request to Moopanel app.

Example response (step 2)

Send report to Moopanel for each course.

POST [moopanel_url]/api/backups/courses/[instanceid]
{
  "status":true,
  "courseid":2208,
  "link":"https:\/\/test.si\/123-2024-06-21.zip",
  "password":"abcdefgh12345678",
  "filesize": "3.25 GB"
}
PUT /backups

Specify moodle course id in request body which do you want to restore.

Request body example

{
    "data": {
        "instance_id": 123,
        "storage": "local",
        "backup_mode": "manual",
        "credentials": {},
        "moodle_course_id": 2898,
        "link": "/moopanel_course_backups/manual/course_2898__2024_07_19_16_47.mbz",
        "password": "examplePassword",
        "user_id": 202,
        "backup_result_id": 303
    }
}

Moodle will process task ASAP. When finished task, send post request to Moopanel app.

Response body example (step 1)

{
  "status": true,
  "message": "Course backup will be restored."
}

Example response (step 2)

Send report to Moopanel for restored course.

/api/backups/restore/instance/
POST [moopanel_url]/api/backups/restore/instance/[instanceid]
{
  "status":true,
  "courseid":2208,
  "link":"https:\/\/test.si\/123-2024-06-21.zip",
  "password":"abcdefgh12345678",
  "filesize": "3.25 GB"
}

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages