Moodle 2.2.5 release

Conflicts:
	lib/db/upgrade.php
	version.php

Conflicts:
	version.php

.eslintrc

@@ -1,312 +0,0 @@
-{
-  'plugins': [
-    'babel',
-    'promise',
-    'jsdoc',
-  ],
-  'env': {
-    'browser': true,
-    // Enable ES6+ features by default.
-    // See http://eslint.org/docs/user-guide/configuring#specifying-environments
-    // Note: The YUI override must exactly match this when disabling the ES6+ version because those features are not supported by Shifter.
-    'es2020': true,
-    'amd': true
-  },
-  'globals': {
-    'M': true,
-    'Y': true
-  },
-  'rules': {
-    // See http://eslint.org/docs/rules/ for all rules and explanations of all
-    // rules.
-
-    // === Possible Errors ===
-    'comma-dangle': 'off',
-    'no-compare-neg-zero': 'error',
-    'no-cond-assign': 'error',
-    'no-console': 'error',
-    'no-constant-condition': 'error',
-    'no-control-regex': 'error',
-    'no-debugger': 'error',
-    'no-dupe-args': 'error',
-    'no-dupe-keys': 'error',
-    'no-duplicate-case': 'error',
-    'no-empty': 'warn',
-    'no-empty-character-class': 'error',
-    'no-ex-assign': 'error',
-    'no-extra-boolean-cast': 'error',
-    'no-extra-parens': 'off',
-    'no-extra-semi': 'error',
-    'no-func-assign': 'error',
-    'no-inner-declarations': 'error',
-    'no-invalid-regexp': 'error',
-    'no-irregular-whitespace': 'error',
-    'no-obj-calls': 'error',
-    'no-prototype-builtins': 'off',
-    'no-regex-spaces': 'error',
-    'no-sparse-arrays': 'error',
-    'no-unexpected-multiline': 'error',
-    'no-unreachable': 'warn',
-    'no-unsafe-finally': 'error',
-    'no-unsafe-negation': 'error',
-    'use-isnan': 'error',
-    'valid-jsdoc': ['warn', { 'requireReturn': false, 'requireParamDescription': false, 'requireReturnDescription': false }],
-    'valid-typeof': 'error',
-
-    // === Best Practices ===
-    // (these mostly match our jshint config)
-    'array-callback-return': 'warn',
-    'block-scoped-var': 'warn',
-    'complexity': 'warn',
-    'consistent-return': 'warn',
-    'curly': 'error',
-    'dot-notation': 'warn',
-    'no-alert': 'warn',
-    'no-caller': 'error',
-    'no-case-declarations': 'error',
-    'no-div-regex': 'error',
-    'no-empty-pattern': 'error',
-    'no-empty-function': 'warn',
-    'no-eq-null': 'error',
-    'no-eval': 'error',
-    'no-extend-native': 'error',
-    'no-extra-bind': 'warn',
-    'no-fallthrough': 'error',
-    'no-floating-decimal': 'warn',
-    'no-global-assign': 'warn',
-    'no-implied-eval': 'error',
-    'no-invalid-this': 'error',
-    'no-iterator': 'error',
-    'no-labels': 'error',
-    'no-loop-func': 'error',
-    'no-multi-spaces': 'warn',
-    'no-multi-str': 'error',
-    'no-new-func': 'error',
-    'no-new-wrappers': 'error',
-    'no-octal': 'error',
-    'no-octal-escape': 'error',
-    'no-proto': 'error',
-    'no-redeclare': 'warn',
-    'no-restricted-globals': ['error', { 'name': 'Notification' }],
-    'no-return-assign': 'error',
-    'no-script-url': 'error',
-    'no-self-assign': 'error',
-    'no-self-compare': 'error',
-    'no-sequences': 'warn',
-    'no-throw-literal': 'warn',
-    'no-unmodified-loop-condition': 'error',
-    'no-unused-expressions': 'error',
-    'no-unused-labels': 'error',
-    'no-useless-call': 'warn',
-    'no-useless-escape': 'warn',
-    'no-with': 'error',
-    'wrap-iife': ['error', 'any'],
-
-    // === Variables ===
-    'no-delete-var': 'error',
-    'no-undef': 'error',
-    'no-undef-init': 'error',
-    'no-unused-vars': ['error', { 'caughtErrors': 'none' }],
-
-    // === Stylistic Issues ===
-    'array-bracket-spacing': 'warn',
-    'block-spacing': 'warn',
-    'brace-style': ['warn', '1tbs'],
-    'camelcase': 'warn',
-    'capitalized-comments': ['warn', 'always', { 'ignoreConsecutiveComments': true }],
-    'comma-spacing': ['warn', { 'before': false, 'after': true }],
-    'comma-style': ['warn', 'last'],
-    'computed-property-spacing': 'error',
-    'consistent-this': 'off',
-    'eol-last': 'off',
-    'func-call-spacing': ['warn', 'never'],
-    'func-names': 'off',
-    'func-style': 'off',
-    // indent currently not doing well with our wrapping style, so disabled.
-    'indent': ['off', 4, { 'SwitchCase': 1 }],
-    'key-spacing': ['warn', { 'beforeColon': false, 'afterColon': true, 'mode': minimum }],
-    'keyword-spacing': 'warn',
-    'linebreak-style': ['error', 'unix'],
-    'lines-around-comment': 'off',
-    'max-len': ['error', 132],
-    'max-lines': 'off',
-    'max-depth': 'warn',
-    'max-nested-callbacks': ['warn', 5],
-    'max-params': 'off',
-    'max-statements': 'off',
-    'max-statements-per-line': ['warn', { max: 2 }],
-    'new-cap': ['warn', { 'properties': false }],
-    'new-parens': 'warn',
-    'newline-after-var': 'off',
-    'newline-before-return': 'off',
-    'newline-per-chained-call': 'off',
-    'no-array-constructor': 'off',
-    'no-bitwise': 'error',
-    'no-continue': 'off',
-    'no-inline-comments': 'off',
-    'no-lonely-if': 'off',
-    'no-mixed-operators': 'off',
-    'no-mixed-spaces-and-tabs': 'error',
-    'no-multiple-empty-lines': 'warn',
-    'no-negated-condition': 'off',
-    'no-nested-ternary': 'warn',
-    'no-new-object': 'off',
-    'no-plusplus': 'off',
-    'no-tabs': 'error',
-    'no-ternary': 'off',
-    'no-trailing-spaces': 'error',
-    'no-underscore-dangle': 'off',
-    'no-unneeded-ternary': 'off',
-    'no-whitespace-before-property': 'warn',
-    'object-curly-newline': 'off',
-    'object-curly-spacing': 'warn',
-    'object-property-newline': 'off',
-    'one-var': 'off',
-    'one-var-declaration-per-line': ['warn', 'initializations'],
-    'operator-assignment': 'off',
-    'operator-linebreak': 'off',
-    'padded-blocks': 'off',
-    'quote-props': ['warn', 'as-needed', {'unnecessary': false, 'keywords': true, 'numbers': true}],
-    'quotes': 'off',
-    'require-jsdoc': 'warn',
-    'semi': 'error',
-    'semi-spacing': ['warn', {'before': false, 'after': true}],
-    'sort-vars': 'off',
-    'space-before-blocks': 'warn',
-    'space-before-function-paren': ['warn', 'never'],
-    'space-in-parens': 'warn',
-    'space-infix-ops': 'warn',
-    'space-unary-ops': 'warn',
-    'spaced-comment': 'warn',
-    'unicode-bom': 'error',
-    'wrap-regex': 'off',
-
-    // === Promises ===
-    'promise/always-return': 'warn',
-    'promise/no-return-wrap': 'warn',
-    'promise/param-names': 'warn',
-    'promise/catch-or-return': ['warn', {terminationMethod: ['catch', 'fail']}],
-    'promise/no-native': 'warn',
-    'promise/no-promise-in-callback': 'warn',
-    'promise/no-callback-in-promise': 'warn',
-    'promise/avoid-new': 'warn',
-
-    // === Deprecations ===
-    "no-restricted-properties": ['warn', {
-        'object': 'M',
-        'property': 'str',
-        'message': 'Use AMD module "core/str" or M.util.get_string()'
-    }],
-  },
-  overrides: [
-    {
-      files: ["**/yui/src/**/*.js"],
-      'env': {
-        // Disable ES6+ for YUI files.
-        'es2020': false,
-      },
-      // Disable some rules which we can't safely define for YUI rollups.
-      rules: {
-        'no-undef': 'off',
-        'no-unused-vars': 'off',
-        'no-unused-expressions': 'off',
-
-        // === JSDocs ===
-        "jsdoc/check-access": 'off',
-        "jsdoc/check-alignment": 'off',
-        "jsdoc/check-param-names": 'off',
-        "jsdoc/check-property-names": 'off',
-        "jsdoc/empty-tags": 'off',
-        "jsdoc/implements-on-classes": 'off',
-        "jsdoc/multiline-blocks": 'off',
-        "jsdoc/require-jsdoc": 'off',
-        "jsdoc/require-param": 'off',
-        "jsdoc/require-param-name": 'off',
-        "jsdoc/require-param-type": 'off',
-        "jsdoc/require-property": 'off',
-        "jsdoc/require-property-name": 'off',
-        "jsdoc/require-property-type": 'off',
-      }
-    },
-    {
-      files: ["**/amd/src/*.js", "**/amd/src/**/*.js", "Gruntfile.js", ".grunt/*.js", ".grunt/tasks/*.js", "jsdoc.conf.js"],
-      // We're using babel transpiling so use their parser
-      // for linting.
-      parser: '@babel/eslint-parser',
-      // Check AMD with some slightly stricter rules.
-      rules: {
-        'no-unused-vars': 'error',
-        'no-implicit-globals': 'error',
-        // Disable all of the rules that have babel versions.
-        'new-cap': 'off',
-        // Not using this rule for the time being because it isn't
-        // compatible with jQuery and ES6.
-        'no-invalid-this': 'off',
-        'object-curly-spacing': 'off',
-        'quotes': 'off',
-        'semi': 'off',
-        'no-unused-expressions': 'off',
-        // Enable all of the babel version of these rules.
-        'babel/new-cap': ['warn', { 'properties': false }],
-        // Not using this rule for the time being because it isn't
-        // compatible with jQuery and ES6.
-        'babel/no-invalid-this': 'off',
-        'babel/object-curly-spacing': 'warn',
-        // This is off in the original style int.
-        'babel/quotes': 'off',
-        'babel/semi': 'error',
-        'babel/no-unused-expressions': 'error',
-        // === Promises ===
-        // We have Promise now that we're using ES6.
-        'promise/no-native': 'off',
-        'promise/avoid-new': 'off',
-
-        // === JSDocs ===
-        "jsdoc/check-access": [
-          'error',
-        ],
-        "jsdoc/check-alignment": 1, // Recommended.
-        "jsdoc/check-param-names": [
-          'error',
-        ],
-        "jsdoc/check-property-names": [
-          'error',
-        ],
-        "jsdoc/empty-tags": [
-          'error',
-        ],
-        "jsdoc/implements-on-classes": [
-          'error',
-        ],
-        "jsdoc/multiline-blocks": [
-          'error',
-        ],
-        "jsdoc/require-jsdoc": [
-          'error',
-        ],
-        "jsdoc/require-param": [
-          'error',
-        ],
-        "jsdoc/require-param-name": [
-          'error',
-        ],
-        "jsdoc/require-param-type": [
-          'error',
-        ],
-        "jsdoc/require-property": [
-          'error',
-        ],
-        "jsdoc/require-property-name": [
-          'error',
-        ],
-        "jsdoc/require-property-type": [
-          'error',
-        ],
-      },
-      parserOptions: {
-        'sourceType': 'module',
-        'requireConfigFile': false,
-      }
-    }
-  ]
-}

.gherkin-lintrc

@@ -1,24 +0,0 @@
-{
-  "indentation": ["on",{
-    "Feature": 0,
-    "Background": 2,
-    "Scenario": 2,
-    "Examples": 4,
-    "example": 6,
-    "Step": 4,
-    "given": 4,
-    "and": 4
-  }],
-  "no-dupe-feature-names": "on",
-  "no-dupe-scenario-names": "off",
-  "no-empty-file": "on",
-  "no-files-without-scenarios": "on",
-  "no-multiple-empty-lines": "on",
-  "no-partially-commented-tag-lines": "on",
-  "no-trailing-spaces": "on",
-  "no-unnamed-features": "on",
-  "no-unnamed-scenarios": "on",
-  "no-scenario-outlines-without-examples": "on",
-  "no-examples-in-scenarios": "on",
-  "new-line-at-eof": ["on", "yes"]
-}

.gitattributes

@@ -1,3 +0,0 @@
-**/yui/build/** -diff
-**/amd/build/** -diff
-lib/dml/oci_native_moodle_package.sql text eol=lf

.github/FUNDING.yml

@@ -1,2 +0,0 @@
-# Primary donations pages.
-custom: ["https://moodle.com/donations/", moodle.org]

.github/workflows/config-template.php

@@ -1,71 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Template configuraton file for github actions CI/CD.
- *
- * @package    core
- * @copyright  2020 onwards Eloy Lafuente (stronk7) {@link https://stronk7.com}
- * @license    https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-// This cannot be used out from a github actions workflow, so just exit.
-getenv('GITHUB_WORKFLOW') || die; // phpcs:ignore moodle.Files.MoodleInternal.MoodleInternalGlobalState
-
-unset($CFG);
-global $CFG;
-$CFG = new stdClass();
-
-$CFG->dbtype    = getenv('dbtype');
-$CFG->dblibrary = 'native';
-$CFG->dbhost    = '127.0.0.1';
-$CFG->dbname    = 'test';
-$CFG->dbuser    = 'test';
-$CFG->dbpass    = 'test';
-$CFG->prefix    = 'm_';
-$CFG->dboptions = ['dbcollation' => 'utf8mb4_bin'];
-
-$host = 'localhost';
-$CFG->wwwroot   = "http://{$host}";
-$CFG->dataroot  = realpath(dirname(__DIR__)) . '/moodledata';
-$CFG->admin     = 'admin';
-$CFG->directorypermissions = 0777;
-
-// Debug options - possible to be controlled by flag in future.
-$CFG->debug = (E_ALL | E_STRICT); // DEBUG_DEVELOPER.
-$CFG->debugdisplay = 1;
-$CFG->debugstringids = 1; // Add strings=1 to url to get string ids.
-$CFG->perfdebug = 15;
-$CFG->debugpageinfo = 1;
-$CFG->allowthemechangeonurl = 1;
-$CFG->passwordpolicy = 0;
-$CFG->cronclionly = 0;
-$CFG->pathtophp = getenv('pathtophp');
-
-$CFG->phpunit_dataroot  = realpath(dirname(__DIR__)) . '/phpunitdata';
-$CFG->phpunit_prefix = 't_';
-
-define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost:8080');
-define('TEST_EXTERNAL_FILES_HTTPS_URL', 'http://localhost:8080');
-
-define('TEST_SESSION_REDIS_HOST', 'localhost');
-define('TEST_CACHESTORE_REDIS_TESTSERVERS', 'localhost');
-
-// TODO: add others (solr, mongodb, memcached, ldap...).
-
-// Too much for now: define('PHPUNIT_LONGTEST', true); // Only leaves a few tests out and they are run later by CI.
-
-require_once(__DIR__ . '/lib/setup.php');

.github/workflows/push.yml

@@ -1,118 +0,0 @@
-name: Core
-
-on:
-  push:
-    branches-ignore:
-      - master
-      - MOODLE_[0-9]+_STABLE
-    tags-ignore:
-      - v[0-9]+.[0-9]+.[0-9]+*
-
-env:
-  php: 8.2
-
-jobs:
-  Grunt:
-    runs-on: ubuntu-22.04
-
-    steps:
-      - name: Checking out code
-        uses: actions/checkout@v3
-
-      - name: Configuring node & npm
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-
-      - name: Installing node stuff
-        run: npm install
-
-      - name: Running grunt
-        run: npx grunt
-
-      - name: Looking for uncommitted changes
-        # Add all files to the git index and then run diff --cached to see all changes.
-        # This ensures that we get the status of all files, including new files.
-        # We ignore npm-shrinkwrap.json to make the tasks immune to npm changes.
-        run: |
-          git add .
-          git reset -- npm-shrinkwrap.json
-          git diff --cached --exit-code
-
-  PHPUnit:
-    runs-on: ${{ matrix.os }}
-    services:
-      exttests:
-        image: moodlehq/moodle-exttests
-        ports:
-          - 8080:80
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          # MySQL builds always run with the lowest PHP supported version.
-          - os: ubuntu-22.04
-            php: 8.0
-            extensions:
-            db: mysqli
-          # PostgreSQL builds always run with the highest PHP supported version.
-          - os: ubuntu-22.04
-            php: 8.2
-            db: pgsql
-
-    steps:
-      - name: Setting up DB mysql
-        if: ${{ matrix.db == 'mysqli' }}
-        uses: moodlehq/mysql-action@v1
-        with:
-          collation server: utf8mb4_bin
-          mysql version: 8.0
-          mysql database: test
-          mysql user: test
-          mysql password: test
-          use tmpfs: true
-          tmpfs size: '1024M'
-          extra conf: --skip-log-bin
-
-      - name: Setting up DB pgsql
-        if: ${{ matrix.db == 'pgsql' }}
-        uses: m4nu56/postgresql-action@v1
-        with:
-          postgresql version: 13
-          postgresql db: test
-          postgresql user: test
-          postgresql password: test
-
-      - name: Configuring git vars
-        uses: rlespinasse/github-slug-action@v4
-
-      - name: Setting up PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          extensions: ${{ matrix.extensions }}
-          ini-values: max_input_vars=5000
-          coverage: none
-
-      - name: Checking out code from ${{ env.GITHUB_REF_SLUG }}
-        uses: actions/checkout@v3
-
-      - name: Setting up PHPUnit
-        env:
-          dbtype: ${{ matrix.db }}
-        run: |
-          echo "pathtophp=$(which php)" >> $GITHUB_ENV # Inject installed pathtophp to env. The template config needs it.
-          cp .github/workflows/config-template.php config.php
-          mkdir ../moodledata
-          sudo locale-gen en_AU.UTF-8
-          php admin/tool/phpunit/cli/init.php --no-composer-self-update
-
-      - name: Running PHPUnit tests
-        env:
-          dbtype: ${{ matrix.db }}
-          phpunit_options: ${{ secrets.phpunit_options }}
-        run: vendor/bin/phpunit $phpunit_options

.github/workflows/windows.yml

@@ -1,144 +0,0 @@
-name: Windows Testing
-
-on:
-  workflow_dispatch
-env:
-  php: 8.2
-
-jobs:
-  Grunt:
-    runs-on: windows-latest
-
-    steps:
-      - name: Set git to use LF
-        run: |
-          git config --global core.autocrlf false
-          git config --global core.eol lf
-
-      - name: Checking out code
-        uses: actions/checkout@v3
-
-      - name: Configuring node & npm
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-
-      - name: Installing node stuff
-        run: npm ci
-
-      - name: Running grunt
-        run: npx grunt
-
-      - name: Looking for uncommitted changes
-        # Add all files to the git index and then run diff --cached to see all changes.
-        # This ensures that we get the status of all files, including new files.
-        # We ignore npm-shrinkwrap.json to make the tasks immune to npm changes.
-        run: |
-          git add .
-          git reset -- npm-shrinkwrap.json
-          git diff --cached --exit-code
-
-  PHPUnit:
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: windows-latest
-            php: 8.2
-            # Ideally we should use mysql/mariadb, but they are 4x slower without tweaks and configuration
-            # so let's run only postgres (1.5h vs 6h) only, If some day we want to improve the mysql runs,
-            # this is the place to enable them.
-            # db: mysqli
-            db: pgsql
-            extensions: exif, fileinfo, gd, intl, pgsql, mysql, redis, soap, sodium, zip
-          - os: windows-latest
-            php: 8.0
-            db: pgsql
-            extensions: exif, fileinfo, gd, intl, pgsql, mysql, redis, soap, sodium
-
-    steps:
-      - name: Setting up DB mysql
-        if: ${{ matrix.db == 'mysqli' }}
-        uses: shogo82148/actions-setup-mysql@v1
-        with:
-          mysql-version: 8.0
-          user: test
-          password: test
-
-      - name: Creating DB mysql
-        if: ${{ matrix.db == 'mysqli' }}
-        run: mysql --host 127.0.0.1 -utest -ptest -e 'CREATE DATABASE IF NOT EXISTS test COLLATE = utf8mb4_bin;';
-
-      - name: Setting up DB pgsql
-        if: ${{ matrix.db == 'pgsql' }}
-        run: |
-          # TODO: Remove these conf. modifications when php74 or php80 are lowest.
-          # Change to old md5 auth, because php73 does not support it.
-          # #password_encryption = scram-sha-256
-          (Get-Content "$env:PGDATA\postgresql.conf"). `
-              replace('#password_encryption = scram-sha-256', 'password_encryption = md5') | `
-              Set-Content "$env:PGDATA\postgresql.conf"
-          (Get-Content "$env:PGDATA\pg_hba.conf"). `
-              replace('scram-sha-256', 'md5') | `
-              Set-Content "$env:PGDATA\pg_hba.conf"
-          $pgService = Get-Service -Name postgresql*
-          Set-Service -InputObject $pgService -Status running -StartupType automatic
-          Start-Process -FilePath "$env:PGBIN\pg_isready" -Wait -PassThru
-          & $env:PGBIN\psql --command="CREATE USER test PASSWORD 'test'" --command="\du"
-
-      - name: Creating DB pgsql
-        if: ${{ matrix.db == 'pgsql' }}
-        run: |
-          & $env:PGBIN\createdb --owner=test test
-          $env:PGPASSWORD = 'test'
-          & $env:PGBIN\psql --username=test --host=localhost --list test
-
-      - name: Configuring git vars
-        uses: rlespinasse/github-slug-action@v4
-
-      - name: Setting up PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php }}
-          extensions: ${{ matrix.extensions }}
-          ini-values: max_input_vars=5000
-          coverage: none
-
-      - name: Set git to use LF
-        run: |
-          git config --global core.autocrlf false
-          git config --global core.eol lf
-
-      - name: Checking out code from ${{ env.GITHUB_REF_SLUG }}
-        uses: actions/checkout@v3
-
-      # Needs to be done after php is available, git configured and Moodle checkout has happened.
-      - name: Setting up moodle-exttests service
-        run: |
-          git clone https://github.com/moodlehq/moodle-exttests.git
-          nssm install php-built-in C:\tools\php\php.exe -S localhost:8080 -t D:\a\moodle\moodle\moodle-exttests
-          nssm start php-built-in
-
-      - name: Setting up redis service
-        run: |
-          choco install redis-64 --version 3.0.503 --no-progress
-          nssm install redis redis-server
-          nssm start redis
-
-      - name: Setting up PHPUnit
-        env:
-          dbtype: ${{ matrix.db }}
-        shell: bash
-        run: |
-          echo "pathtophp=$(which php)" >> $GITHUB_ENV # Inject installed pathtophp to env. The template config needs it.
-          cp .github/workflows/config-template.php config.php
-          mkdir ../moodledata
-          php admin/tool/phpunit/cli/init.php --no-composer-self-update
-
-      - name: Running PHPUnit tests
-        env:
-          dbtype: ${{ matrix.db }}
-          phpunit_options: ${{ secrets.phpunit_options }}
-        run: vendor/bin/phpunit $phpunit_options

.gitignore

@@ -9,23 +9,15 @@
 #
 # See gitignore(5) man page for more details
 #
-
-# Swap files (vim)
-[._]*.s[a-v][a-z]
-[._]*.sw[a-p]
-[._]s[a-rt-v][a-z]
-[._]ss[a-gi-z]
-[._]sw[a-p]
-# Temporary files including undo
-*~
-#
 /config.php
+/lib/editor/tinymce/extra/tools/temp/
+*~
+*.swp
 /tags
 /TAGS
 /cscope.*
 /.patches/
 /.idea/
-.phpstorm.*
 /nbproject/
 CVS
 .DS_Store
@@ -33,25 +25,3 @@ CVS
 /.project
 /.buildpath
 /.cache
-.phpunit.result.cache
-phpunit.xml
-# Composer support. Do not ignore composer.json, or composer.lock. These should be shipped by us.
-composer.phar
-/vendor/
-/behat.yml
-*/yui/build/*/*-coverage.js
-/lib/yuilib/*/build/*/*-coverage.js
-# lib/yuilib/version/module/module-coverage.js
-/lib/yuilib/*/*/*-coverage.js
-atlassian-ide-plugin.xml
-/node_modules/
-/.vscode/
-moodle-plugin-ci.phar
-.eslintignore
-.stylelintignore
-/jsdoc
-/admin/tool/componentlibrary/docs
-/admin/tool/componentlibrary/hugo/site/data/my-index.json
-.hugo_build.lock
-phpcs.xml
-jsconfig.json

.grunt/babel-plugin-add-module-to-define.js

@@ -1,169 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This is a babel plugin to add the Moodle module names to the AMD modules
- * as part of the transpiling process.
- *
- * In addition it will also add a return statement for the default export if the
- * module is using default exports. This is a highly specific Moodle thing because
- * we're transpiling to AMD and none of the existing Babel 7 plugins work correctly.
- *
- * This will fix the issue where an ES6 module using "export default Foo" will be
- * transpiled into an AMD module that returns {default: Foo}; Instead it will now
- * just simply return Foo.
- *
- * Note: This means all other named exports in that module are ignored and won't be
- * exported.
- *
- * @copyright  2018 Ryan Wyllie <ryan@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-"use strict";
-/* eslint-env node */
-
-module.exports = ({template, types}) => {
-    const fs = require('fs');
-    const path = require('path');
-    const cwd = process.cwd();
-    const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
-
-    /**
-     * Search the list of components that match the given file name
-     * and return the Moodle component for that file, if found.
-     *
-     * Throw an exception if no matching component is found.
-     *
-     * @throws {Error}
-     * @param {string} searchFileName The file name to look for.
-     * @return {string} Moodle component
-     */
-    function getModuleNameFromFileName(searchFileName) {
-        searchFileName = fs.realpathSync(searchFileName);
-        const relativeFileName = searchFileName.replace(`${cwd}${path.sep}`, '').replace(/\\/g, '/');
-        const [componentPath, file] = relativeFileName.split('/amd/src/');
-        const fileName = file.replace('.js', '');
-
-        // Check subsystems first which require an exact match.
-        const componentName = ComponentList.getComponentFromPath(componentPath);
-        if (componentName) {
-            return `${componentName}/${fileName}`;
-        }
-
-        // This matches the previous PHP behaviour that would throw an exception
-        // if it couldn't parse an AMD file.
-        throw new Error(`Unable to find module name for ${searchFileName} (${componentPath}::${file}}`);
-    }
-
-    /**
-     * This is heavily inspired by the babel-plugin-add-module-exports plugin.
-     * See: https://github.com/59naga/babel-plugin-add-module-exports
-     *
-     * This is used when we detect a module using "export default Foo;" to make
-     * sure the transpiled code just returns Foo directly rather than an object
-     * with the default property (i.e. {default: Foo}).
-     *
-     * Note: This means that we can't support modules that combine named exports
-     * with a default export.
-     *
-     * @param {String} path
-     * @param {String} exportObjectName
-     */
-    function addModuleExportsDefaults(path, exportObjectName) {
-        const rootPath = path.findParent(path => {
-            return path.key === 'body' || !path.parentPath;
-        });
-
-        // HACK: `path.node.body.push` instead of path.pushContainer(due doesn't work in Plugin.post).
-        // This is hardcoded to work specifically with AMD.
-        rootPath.node.body.push(template(`return ${exportObjectName}.default`)());
-    }
-
-    return {
-        pre() {
-            this.seenDefine = false;
-            this.addedReturnForDefaultExport = false;
-        },
-        visitor: {
-            // Plugin ordering is only respected if we visit the "Program" node.
-            // See: https://babeljs.io/docs/en/plugins.html#plugin-preset-ordering
-            //
-            // We require this to run after the other AMD module transformation so
-            // let's visit the "Program" node.
-            Program: {
-                exit(path) {
-                    path.traverse({
-                        CallExpression(path) {
-                            // If we find a "define" function call.
-                            if (!this.seenDefine && path.get('callee').isIdentifier({name: 'define'})) {
-                                // We only want to modify the first instance of define that we find.
-                                this.seenDefine = true;
-
-                                // Get the Moodle component for the file being processed.
-                                var moduleName = getModuleNameFromFileName(this.file.opts.filename);
-
-                                // The function signature of `define()` is:
-                                // define = function (name, deps, callback) {...}
-                                // Ensure that if the moduel supplied its own name that it is replaced.
-                                if (path.node.arguments.length > 0) {
-                                    // Ensure that there is only one name.
-                                    if (path.node.arguments[0].type === 'StringLiteral') {
-                                        // eslint-disable-next-line
-                                        console.log(`Replacing module name '${path.node.arguments[0].extra.rawValue}' with ${moduleName}`);
-                                        path.node.arguments.shift();
-                                    }
-                                }
-
-                                // Add the module name as the first argument to the define function.
-                                path.node.arguments.unshift(types.stringLiteral(moduleName));
-                                // Add a space after the define function in the built file so that previous versions
-                                // of Moodle will not try to add the module name to the file when it's being served
-                                // by PHP. This forces the regex in PHP to not match for this file.
-                                path.node.callee.name = 'define ';
-                            }
-
-                            // Check for any Object.defineProperty('exports', 'default') calls.
-                            if (!this.addedReturnForDefaultExport && path.get('callee').matchesPattern('Object.defineProperty')) {
-                                const [identifier, prop] = path.get('arguments');
-                                const objectName = identifier.get('name').node;
-                                const propertyName = prop.get('value').node;
-
-                                if ((objectName === 'exports' || objectName === '_exports') && propertyName === 'default') {
-                                    addModuleExportsDefaults(path, objectName);
-                                    this.addedReturnForDefaultExport = true;
-                                }
-                            }
-                        },
-                        AssignmentExpression(path) {
-                            // Check for an exports.default assignments.
-                            if (
-                                !this.addedReturnForDefaultExport &&
-                                (
-                                    path.get('left').matchesPattern('exports.default') ||
-                                    path.get('left').matchesPattern('_exports.default')
-                                )
-                            ) {
-                                const objectName = path.get('left.object.name').node;
-                                addModuleExportsDefaults(path, objectName);
-                                this.addedReturnForDefaultExport = true;
-                            }
-                        }
-                    }, this);
-                }
-            }
-        }
-    };
-};

.grunt/components.js

@@ -1,394 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Helper functions for working with Moodle component names, directories, and sources.
- *
- * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-"use strict";
-/* eslint-env node */
-
-/** @var {Object} A list of subsystems in Moodle */
-const componentData = {};
-
-/**
- * Load details of all moodle modules.
- *
- * @returns {object}
- */
-const fetchComponentData = () => {
-    const fs = require('fs');
-    const path = require('path');
-    const glob = require('glob');
-    const gruntFilePath = process.cwd();
-
-    if (!Object.entries(componentData).length) {
-        componentData.subsystems = {};
-        componentData.pathList = [];
-
-        // Fetch the component definiitions from the distributed JSON file.
-        const components = JSON.parse(fs.readFileSync(`${gruntFilePath}/lib/components.json`));
-
-        // Build the list of moodle subsystems.
-        componentData.subsystems.lib = 'core';
-        componentData.pathList.push(process.cwd() + path.sep + 'lib');
-        for (const [component, thisPath] of Object.entries(components.subsystems)) {
-            if (thisPath) {
-                // Prefix "core_" to the front of the subsystems.
-                componentData.subsystems[thisPath] = `core_${component}`;
-                componentData.pathList.push(process.cwd() + path.sep + thisPath);
-            }
-        }
-
-        // The list of components incldues the list of subsystems.
-        componentData.components = componentData.subsystems;
-
-        // Go through each of the plugintypes.
-        Object.entries(components.plugintypes).forEach(([pluginType, pluginTypePath]) => {
-            // We don't allow any code in this place..?
-            glob.sync(`${pluginTypePath}/*/version.php`).forEach(versionPath => {
-                const componentPath = fs.realpathSync(path.dirname(versionPath));
-                const componentName = path.basename(componentPath);
-                const frankenstyleName = `${pluginType}_${componentName}`;
-                componentData.components[`${pluginTypePath}/${componentName}`] = frankenstyleName;
-                componentData.pathList.push(componentPath);
-
-                // Look for any subplugins.
-                const subPluginConfigurationFile = `${componentPath}/db/subplugins.json`;
-                if (fs.existsSync(subPluginConfigurationFile)) {
-                    const subpluginList = JSON.parse(fs.readFileSync(fs.realpathSync(subPluginConfigurationFile)));
-
-                    Object.entries(subpluginList.plugintypes).forEach(([subpluginType, subpluginTypePath]) => {
-                        glob.sync(`${subpluginTypePath}/*/version.php`).forEach(versionPath => {
-                            const componentPath = fs.realpathSync(path.dirname(versionPath));
-                            const componentName = path.basename(componentPath);
-                            const frankenstyleName = `${subpluginType}_${componentName}`;
-
-                            componentData.components[`${subpluginTypePath}/${componentName}`] = frankenstyleName;
-                            componentData.pathList.push(componentPath);
-                        });
-                    });
-                }
-            });
-        });
-
-    }
-
-    return componentData;
-};
-
-/**
- * Get the list of component paths.
- *
- * @param   {string} relativeTo
- * @returns {array}
- */
-const getComponentPaths = (relativeTo = '') => fetchComponentData().pathList.map(componentPath => {
-    return componentPath.replace(relativeTo, '');
-});
-
-/**
- * Get the list of paths to build AMD sources.
- *
- * @returns {Array}
- */
-const getAmdSrcGlobList = () => {
-    const globList = [];
-    fetchComponentData().pathList.forEach(componentPath => {
-        globList.push(`${componentPath}/amd/src/*.js`);
-        globList.push(`${componentPath}/amd/src/**/*.js`);
-    });
-
-    return globList;
-};
-
-/**
- * Get the list of paths to build YUI sources.
- *
- * @param {String} relativeTo
- * @returns {Array}
- */
-const getYuiSrcGlobList = relativeTo => {
-    const globList = [];
-    fetchComponentData().pathList.forEach(componentPath => {
-        const relativeComponentPath = componentPath.replace(relativeTo, '');
-        globList.push(`${relativeComponentPath}/yui/src/**/*.js`);
-    });
-
-    return globList;
-};
-
-/**
- * Get the list of paths to thirdpartylibs.xml.
- *
- * @param {String} relativeTo
- * @returns {Array}
- */
-const getThirdPartyLibsList = relativeTo => {
-    const fs = require('fs');
-    const path = require('path');
-
-    return fetchComponentData().pathList
-        .map(componentPath => path.relative(relativeTo, componentPath) + '/thirdpartylibs.xml')
-        .map(componentPath => componentPath.replace(/\\/g, '/'))
-        .filter(path => fs.existsSync(path))
-        .sort();
-};
-
-/**
- * Get the list of thirdparty library paths.
- *
- * @returns {array}
- */
-const getThirdPartyPaths = () => {
-    const DOMParser = require('@xmldom/xmldom').DOMParser;
-    const fs = require('fs');
-    const path = require('path');
-    const xpath = require('xpath');
-
-    const thirdpartyfiles = getThirdPartyLibsList(fs.realpathSync('./'));
-    const libs = ['node_modules/', 'vendor/'];
-
-    const addLibToList = lib => {
-        if (!lib.match('\\*') && fs.statSync(lib).isDirectory()) {
-            // Ensure trailing slash on dirs.
-            lib = lib.replace(/\/?$/, '/');
-        }
-
-        // Look for duplicate paths before adding to array.
-        if (libs.indexOf(lib) === -1) {
-            libs.push(lib);
-        }
-    };
-
-    thirdpartyfiles.forEach(function(file) {
-        const dirname = path.dirname(file);
-
-        const xmlContent = fs.readFileSync(file, 'utf8');
-        const doc = new DOMParser().parseFromString(xmlContent);
-        const nodes = xpath.select("/libraries/library/location/text()", doc);
-
-        nodes.forEach(function(node) {
-            let lib = path.posix.join(dirname, node.toString());
-            addLibToList(lib);
-        });
-    });
-
-    return libs;
-
-};
-
-/**
- * Find the name of the component matching the specified path.
- *
- * @param {String} path
- * @returns {String|null} Name of matching component.
- */
-const getComponentFromPath = path => {
-    const componentList = fetchComponentData().components;
-
-    if (componentList.hasOwnProperty(path)) {
-        return componentList[path];
-    }
-
-    return null;
-};
-
-/**
- * Check whether the supplied path, relative to the Gruntfile.js, is in a known component.
- *
- * @param {String} checkPath The path to check. This can be with either Windows, or Linux directory separators.
- * @returns {String|null}
- */
-const getOwningComponentDirectory = checkPath => {
-    const path = require('path');
-
-    // Fetch all components into a reverse sorted array.
-    // This ensures that components which are within the directory of another component match first.
-    const pathList = Object.keys(fetchComponentData().components).sort().reverse();
-    for (const componentPath of pathList) {
-        // If the componentPath is the directory being checked, it will be empty.
-        // If the componentPath is a parent of the directory being checked, the relative directory will not start with ..
-        if (!path.relative(componentPath, checkPath).startsWith('..')) {
-            return componentPath;
-        }
-    }
-
-    return null;
-};
-
-/**
- * Get the latest tag in a remote GitHub repository.
- *
- * @param {string} url The remote repository.
- * @returns {Array}
- */
-const getRepositoryTags = async(url) => {
-    const gtr = require('git-tags-remote');
-    try {
-        const tags = await gtr.get(url);
-        if (tags !== undefined) {
-            return tags;
-        }
-    } catch (error) {
-        return [];
-    }
-    return [];
-};
-
-/**
- * Get the list of thirdparty libraries that could be upgraded.
- *
- * @returns {Array}
- */
-const getThirdPartyLibsUpgradable = async() => {
-    const libraries = getThirdPartyLibsData().filter((library) => !!library.repository);
-    const upgradableLibraries = [];
-    const versionCompare = (a, b) => {
-        if (a === b) {
-            return 0;
-        }
-
-        const aParts = a.split('.');
-        const bParts = b.split('.');
-
-        for (let i = 0; i < Math.min(aParts.length, bParts.length); i++) {
-            const aPart = parseInt(aParts[i], 10);
-            const bPart = parseInt(bParts[i], 10);
-            if (aPart > bPart) {
-                // 1.1.0 > 1.0.9
-                return 1;
-            } else if (aPart < bPart) {
-                // 1.0.9 < 1.1.0
-                return -1;
-            } else {
-                // Same version.
-                continue;
-            }
-        }
-
-        if (aParts.length > bParts.length) {
-            // 1.0.1 > 1.0
-            return 1;
-        }
-
-        // 1.0 < 1.0.1
-        return -1;
-    };
-
-    for (let library of libraries) {
-        upgradableLibraries.push(
-            getRepositoryTags(library.repository).then((tagMap) => {
-                library.version = library.version.replace(/^v/, '');
-                const currentVersion = library.version.replace(/moodle-/, '');
-                const currentMajorVersion = library.version.split('.')[0];
-                const tags = [...tagMap]
-                    .map((tagData) => tagData[0])
-                    .filter((tag) => !tag.match(/(alpha|beta|rc)/))
-                    .map((tag) => tag.replace(/^v/, ''))
-                    .sort((a, b) => versionCompare(b, a));
-                if (!tags.length) {
-                    library.warning = "Unable to find any comparable tags.";
-                    return library;
-                }
-
-                library.latestVersion = tags[0];
-                tags.some((tag) => {
-                    if (!tag) {
-                        return false;
-                    }
-
-                    // See if the version part matches.
-                    const majorVersion = tag.split('.')[0];
-                    if (majorVersion === currentMajorVersion) {
-                        library.latestSameMajorVersion = tag;
-                        return true;
-                    }
-                    return false;
-                });
-
-
-                if (versionCompare(currentVersion, library.latestVersion) > 0) {
-                    // Moodle somehow has a newer version than the latest version.
-                    library.warning = `Newer version found: ${currentVersion} > ${library.latestVersion} for ${library.name}`;
-                    return library;
-                }
-
-
-                if (library.version !== library.latestVersion) {
-                    // Delete version and add it again at the end of the array. That way, current and new will stay closer.
-                    delete library.version;
-                    library.version = currentVersion;
-                    return library;
-                }
-                return null;
-            })
-        );
-    }
-
-    return (await Promise.all(upgradableLibraries)).filter((library) => !!library);
-};
-
-/**
- * Get the list of thirdparty libraries.
- *
- * @returns {Array}
- */
-const getThirdPartyLibsData = () => {
-    const DOMParser = require('@xmldom/xmldom').DOMParser;
-    const fs = require('fs');
-    const xpath = require('xpath');
-    const path = require('path');
-
-    const libraryList = [];
-    const libraryFields = [
-        'location',
-        'name',
-        'version',
-        'repository',
-    ];
-
-    const thirdpartyfiles = getThirdPartyLibsList(fs.realpathSync('./'));
-    thirdpartyfiles.forEach(function(libraryPath) {
-        const xmlContent = fs.readFileSync(libraryPath, 'utf8');
-        const doc = new DOMParser().parseFromString(xmlContent);
-        const libraries = xpath.select("/libraries/library", doc);
-        for (const library of libraries) {
-            const libraryData = [];
-            for (const field of libraryFields) {
-                libraryData[field] = xpath.select(`${field}/text()`, library)?.toString();
-            }
-            libraryData.location = path.join(path.dirname(libraryPath), libraryData.location);
-            libraryList.push(libraryData);
-        }
-    });
-
-    return libraryList.sort((a, b) => a.location.localeCompare(b.location));
-};
-
-module.exports = {
-    fetchComponentData,
-    getAmdSrcGlobList,
-    getComponentFromPath,
-    getComponentPaths,
-    getOwningComponentDirectory,
-    getYuiSrcGlobList,
-    getThirdPartyLibsList,
-    getThirdPartyPaths,
-    getThirdPartyLibsUpgradable,
-};

.grunt/jsdoc/README.md

@@ -1,19 +0,0 @@
-# Moodle JavaScript Documentation
-
-```
-                                 .-..-.
-   _____                         | || |
-  /____/-.---_  .---.  .---.  .-.| || | .---.
-  | |  _   _  |/  _  \/  _  \/  _  || |/  __ \
-  * | | | | | || |_| || |_| || |_| || || |___/
-    |_| |_| |_|\_____/\_____/\_____||_|\_____)
-
-Moodle - the world's open source learning platform
-
-```
-
-## About
-This generated documentation includes API documentation for JavaScript written in the AMD and ES2015 module formats within Moodle.
-
-## Related information
-See [https://moodledev.io](https://moodledev.io) for other related Developer Documentation.

.grunt/jsdoc/jsdoc.conf.js

@@ -1,131 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Helper functions for working with Moodle component names, directories, and sources.
- *
- * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-"use strict";
-/* eslint-env node */
-
-// Do not include any plugins as stanard.
-const plugins = [];
-
-plugins.push('plugins/markdown');
-
-/**
- * Get the source configuration.
- *
- * @return {Object}
- */
-const getSource = () => {
-    const glob = require('glob');
-    const path = require('path');
-    const ComponentList = require(path.resolve('.grunt/components.js'));
-    const thirdPartyPaths = ComponentList.getThirdPartyPaths();
-
-    const source = {
-        include: [],
-        includePattern: ".+\\.js$",
-    };
-
-    let includeList = [];
-
-    ComponentList.getAmdSrcGlobList().forEach(async pattern => {
-        includeList.push(...glob.sync(pattern));
-    });
-
-    const cwdLength = process.cwd().length + 1;
-    includeList.forEach(path => {
-        if (source.include.indexOf(path) !== -1) {
-            // Ensure no duplicates.
-            return;
-        }
-
-        const relPath = path.substring(cwdLength);
-        if (thirdPartyPaths.indexOf(relPath) !== -1) {
-            return;
-        }
-
-        source.include.push(path);
-    });
-
-    source.include.push('.grunt/jsdoc/README.md');
-    return source;
-};
-
-const tags = {
-    // Allow the use of unknown tags.
-    // We have a lot of legacy uses of these.
-    allowUnknownTags: true,
-
-    // We make use of jsdoc and closure dictionaries as standard.
-    dictionaries: [
-        'jsdoc',
-        'closure',
-    ],
-};
-
-// Template configuraiton.
-const templates = {
-    cleverLinks: false,
-    monospaceLinks: false,
-};
-
-module.exports = {
-    opts: {
-        destination: "./jsdoc/",
-        template: "node_modules/docdash",
-    },
-    plugins,
-    recurseDepth: 10,
-    source: getSource(),
-    sourceType: 'module',
-    tags,
-    templates,
-    docdash: {
-        collapse: true,
-        search: true,
-        sort: true,
-        sectionOrder: [
-            "Namespaces",
-            "Modules",
-            "Events",
-            "Classes",
-            "Externals",
-            "Mixins",
-            "Tutorials",
-            "Interfaces"
-        ],
-        "menu": {
-            "Developer Docs": {
-                href: "https://moodledev.io",
-                target: "_blank",
-                "class": "menu-item",
-                id: "devdocs"
-            },
-            "MDN Docs": {
-                href: "https://developer.mozilla.org/en-US/docs/Web/JavaScript",
-                target: "_blank",
-                "class": "menu-item",
-                id: "mdndocs",
-            },
-        },
-        typedefs: true,
-    },
-};

.grunt/tasks/componentlibrary.js

@@ -1,142 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * Component Library build tasks.
- *
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-
-    /**
-     * Get a child path of the component library.
-     *
-     * @param   {string} path
-     * @returns {string}
-     */
-    const getCLPath = path => `admin/tool/componentlibrary/${path}`;
-
-    /**
-     * Get a spawn handler.
-     *
-     * This is a generic function to write the spawn output, and then to exit if required and mark the async task as
-     * complete.
-     *
-     * @param   {Promise} done
-     * @returns {function}
-     */
-    const getSpawnHandler = done => (error, result, code) => {
-        grunt.log.write(result);
-
-        if (error) {
-            grunt.log.error(result.stdout);
-            process.exit(code);
-        }
-        done();
-    };
-
-    /**
-     * Spawn a function against Node with the provided args.
-     *
-     * @param   {array} args
-     * @returns {object}
-     */
-    const spawnNodeCall = (args) => grunt.util.spawn({
-        cmd: 'node',
-        args,
-    }, getSpawnHandler(grunt.task.current.async()));
-
-    /**
-     * Build the docs using Hugo.
-     *
-     * @returns {Object} Reference to the spawned task
-     */
-    const docsBuild = () => spawnNodeCall([
-        'node_modules/hugo-bin/cli.js',
-        '--config', getCLPath('config.yml'),
-        '--cleanDestinationDir',
-    ]);
-
-    /**
-     * Build the docs index using the hugo-lunr-indexer.
-     *
-     * @returns {Object} Reference to the spawned task
-     */
-    const indexBuild = () => spawnNodeCall([
-        'node_modules/hugo-lunr-indexer/bin/hli.js',
-        '-i', getCLPath('content/**'),
-        '-o', getCLPath('hugo/site/data/my-index.json'),
-        '-l', 'yaml',
-        '-d', '---',
-    ]);
-
-    /**
-     * Build the hugo CSS.
-     *
-     * @returns {Object} Reference to the spawned task
-     */
-    const cssBuild = () => spawnNodeCall([
-        'node_modules/sass/sass.js',
-        '--style', 'expanded',
-        '--source-map',
-        '--embed-sources',
-        '--precision', 6,
-        '--load-path', process.cwd(),
-        getCLPath('hugo/scss/docs.scss'),
-        getCLPath('hugo/dist/css/docs.css'),
-    ]);
-
-    // Register the various component library tasks.
-    grunt.registerTask('componentlibrary:docsBuild', 'Build the component library', docsBuild);
-    grunt.registerTask('componentlibrary:cssBuild', 'Build the component library', cssBuild);
-    grunt.registerTask('componentlibrary:indexBuild', 'Build the component library', indexBuild);
-    grunt.registerTask('componentlibrary', 'Build the component library', [
-        'componentlibrary:docsBuild',
-        'componentlibrary:cssBuild',
-        'componentlibrary:indexBuild',
-    ]);
-
-    grunt.config.merge({
-        watch: {
-            componentLibraryDocs: {
-                files: [
-                    getCLPath('content/**/*.md'),
-                    getCLPath('hugo'),
-                ],
-                tasks: ['componentlibrary:docsBuild', 'componentlibrary:indexBuild'],
-            },
-            componentLibraryCSS: {
-                files: [
-                    getCLPath('hugo/scss/**/*.scss'),
-                    'hugo',
-                ],
-                tasks: ['componentlibrary:cssBuild'],
-            },
-        },
-    });
-
-    // Add the 'componentlibrary' task as a startup task.
-    grunt.moodleEnv.startupTasks.push('componentlibrary');
-
-    return {
-        docsBuild,
-        cssBuild,
-        indexBuild,
-    };
-};

.grunt/tasks/eslint.js

@@ -1,64 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    const files = grunt.moodleEnv.files;
-
-    // Project configuration.
-    grunt.config.merge({
-        eslint: {
-            // Even though warnings dont stop the build we don't display warnings by default because
-            // at this moment we've got too many core warnings.
-            // To display warnings call: grunt eslint --show-lint-warnings
-            // To fail on warnings call: grunt eslint --max-lint-warnings=0
-            // Also --max-lint-warnings=-1 can be used to display warnings but not fail.
-            options: {
-                quiet: (!grunt.option('show-lint-warnings')) && (typeof grunt.option('max-lint-warnings') === 'undefined'),
-                maxWarnings: ((typeof grunt.option('max-lint-warnings') !== 'undefined') ? grunt.option('max-lint-warnings') : -1)
-            },
-
-            // Check AMD src files.
-            amd: {src: files ? files : grunt.moodleEnv.amdSrc},
-
-            // Check YUI module source files.
-            yui: {src: files ? files : grunt.moodleEnv.yuiSrc},
-        },
-    });
-
-    grunt.loadNpmTasks('grunt-eslint');
-
-    // On watch, we dynamically modify config to build only affected files. This
-    // method is slightly complicated to deal with multiple changed files at once (copied
-    // from the grunt-contrib-watch readme).
-    let changedFiles = Object.create(null);
-    const onChange = grunt.util._.debounce(function() {
-        const files = Object.keys(changedFiles);
-        grunt.config('eslint.amd.src', files);
-        grunt.config('eslint.yui.src', files);
-        changedFiles = Object.create(null);
-    }, 200);
-
-    grunt.event.on('watch', (action, filepath) => {
-        changedFiles[filepath] = action;
-        onChange();
-    });
-};

.grunt/tasks/gherkinlint.js

@@ -1,92 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    /**
-     * Get the list of feature files to pass to the gherkin linter.
-     *
-     * @returns {Array}
-     */
-    const getGherkinLintTargets = () => {
-        if (grunt.moodleEnv.files) {
-            // Specific files were requested. Only check these.
-            return grunt.moodleEnv.files;
-        }
-
-        if (grunt.moodleEnv.inComponent) {
-            return [`${grunt.moodleEnv.runDir}/tests/behat/*.feature`];
-        }
-
-        return ['**/tests/behat/*.feature'];
-    };
-
-    const handler = function() {
-        const done = this.async();
-        const options = grunt.config('gherkinlint.options');
-
-        // Grab the gherkin-lint linter and required scaffolding.
-        const linter = require('gherkin-lint/dist/linter.js');
-        const featureFinder = require('gherkin-lint/dist/feature-finder.js');
-        const configParser = require('gherkin-lint/dist/config-parser.js');
-        const formatter = require('gherkin-lint/dist/formatters/stylish.js');
-
-        // Run the linter.
-        return linter.lint(
-            featureFinder.getFeatureFiles(grunt.file.expand(options.files)),
-            configParser.getConfiguration(configParser.defaultConfigFileName)
-        )
-        .then(results => {
-            // Print the results out uncondtionally.
-            formatter.printResults(results);
-
-            return results;
-        })
-        .then(results => {
-            // Report on the results.
-            // The done function takes a bool whereby a falsey statement causes the task to fail.
-            return results.every(result => result.errors.length === 0);
-        })
-        .then(done); // eslint-disable-line promise/no-callback-in-promise
-    };
-
-    grunt.registerTask('gherkinlint', 'Run gherkinlint against the current directory', handler);
-
-    grunt.config.set('gherkinlint', {
-        options: {
-            files: getGherkinLintTargets(),
-        }
-    });
-
-    grunt.config.merge({
-        watch: {
-            gherkinlint: {
-                files: [grunt.moodleEnv.inComponent ? 'tests/behat/*.feature' : '**/tests/behat/*.feature'],
-                tasks: ['gherkinlint'],
-            },
-        },
-    });
-
-    // Add the 'gherkinlint' task as a startup task.
-    grunt.moodleEnv.startupTasks.push('gherkinlint');
-
-    return handler;
-};

.grunt/tasks/ignorefiles.js

@@ -1,100 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-
-    /**
-     * Generate the PHPCS configuration.
-     *
-     * @param {Object} thirdPartyPaths
-     */
-    const phpcsIgnore = (thirdPartyPaths) => {
-        const {toXML} = require('jstoxml');
-
-        const config = {
-            _name: 'ruleset',
-            _attrs: {
-                name: "MoodleCore",
-            },
-            _content: [
-                {
-                    rule: {
-                        _attrs: {
-                            ref: './phpcs.xml.dist',
-                        },
-                    },
-                },
-            ],
-        };
-
-        thirdPartyPaths.forEach(library => {
-            config._content.push({
-                'exclude-pattern': library,
-            });
-        });
-
-        grunt.file.write('phpcs.xml', toXML(config, {
-            header: true,
-            indent: '  ',
-        }) + "\n");
-    };
-
-    /**
-     * Generate ignore files (utilising thirdpartylibs.xml data)
-     */
-    const handler = function() {
-        const path = require('path');
-        const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
-
-        // An array of paths to third party directories.
-        const thirdPartyPaths = ComponentList.getThirdPartyPaths();
-
-        // Generate .eslintignore.
-        const eslintIgnores = [
-            '# Generated by "grunt ignorefiles"',
-            // Do not ignore the .grunt directory.
-            '!/.grunt',
-
-            // Ignore all yui/src meta directories and build directories.
-            '*/**/yui/src/*/meta/',
-            '*/**/build/',
-        ].concat(thirdPartyPaths);
-        grunt.file.write('.eslintignore', eslintIgnores.join('\n') + '\n');
-
-        // Generate .stylelintignore.
-        const stylelintIgnores = [
-            '# Generated by "grunt ignorefiles"',
-            '**/yui/build/*',
-            'theme/boost/style/moodle.css',
-            'theme/classic/style/moodle.css',
-            'jsdoc/styles/*.css',
-            'admin/tool/componentlibrary/hugo/dist/css/docs.css',
-        ].concat(thirdPartyPaths);
-        grunt.file.write('.stylelintignore', stylelintIgnores.join('\n') + '\n');
-
-        phpcsIgnore(thirdPartyPaths);
-    };
-
-    grunt.registerTask('ignorefiles', 'Generate ignore files for linters', handler);
-
-    return handler;
-};

.grunt/tasks/javascript.js

@@ -1,227 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-/**
- * Function to generate the destination for the uglify task
- * (e.g. build/file.min.js). This function will be passed to
- * the rename property of files array when building dynamically:
- * http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically
- *
- * @param {String} destPath the current destination
- * @param {String} srcPath the  matched src path
- * @return {String} The rewritten destination path.
- */
-const babelRename = function(destPath, srcPath) {
-    destPath = srcPath.replace(`amd/src`, `amd/build`);
-    destPath = destPath.replace(/\.js$/, '.min.js');
-    return destPath;
-};
-
-module.exports = grunt => {
-    // Load the Ignorefiles tasks.
-    require('./ignorefiles')(grunt);
-
-    // Load the Shifter tasks.
-    require('./shifter')(grunt);
-
-    // Load ESLint.
-    require('./eslint')(grunt);
-
-    // Load jsconfig.
-    require('./jsconfig')(grunt);
-
-    // Load JSDoc.
-    require('./jsdoc')(grunt);
-
-    const path = require('path');
-
-    // Register JS tasks.
-    grunt.registerTask('yui', ['eslint:yui', 'shifter']);
-    grunt.registerTask('amd', ['ignorefiles', 'eslint:amd', 'rollup']);
-    grunt.registerTask('js', ['amd', 'yui']);
-
-    // Register NPM tasks.
-    grunt.loadNpmTasks('grunt-contrib-uglify');
-    grunt.loadNpmTasks('grunt-contrib-watch');
-    grunt.loadNpmTasks('grunt-rollup');
-
-    const babelTransform = require('@babel/core').transform;
-    const babel = (options = {}) => {
-        return {
-            name: 'babel',
-
-            transform: (code, id) => {
-                grunt.log.debug(`Transforming ${id}`);
-                options.filename = id;
-                const transformed = babelTransform(code, options);
-
-                return {
-                    code: transformed.code,
-                    map: transformed.map
-                };
-            }
-        };
-    };
-
-    // Note: We have to use a rate limit plugin here because rollup runs all tasks asynchronously and in parallel.
-    // When we kick off a full run, if we kick off a rollup of every file this will fork-bomb the machine.
-    // To work around this we use a concurrent Promise queue based on the number of available processors.
-    const rateLimit = () => {
-        const queue = [];
-        let queueRunner;
-
-        const startQueue = () => {
-            if (queueRunner) {
-                return;
-            }
-
-            queueRunner = setTimeout(() => {
-                const limit = Math.max(1, require('os').cpus().length / 2);
-                grunt.log.debug(`Starting rollup with queue size of ${limit}`);
-                runQueue(limit);
-            }, 100);
-        };
-
-        // The queue runner will run the next `size` items in the queue.
-        const runQueue = (size = 1) => {
-            queue.splice(0, size).forEach(resolve => {
-                resolve();
-            });
-        };
-
-        return {
-            name: 'ratelimit',
-
-            // The options hook is run in parallel.
-            // We can return an unresolved Promise which is queued for later resolution.
-            options: async() => {
-                return new Promise(resolve => {
-                    queue.push(resolve);
-                    startQueue();
-                });
-            },
-
-            // When an item in the queue completes, start the next item in the queue.
-            buildEnd: () => {
-                runQueue();
-            },
-        };
-    };
-
-    const terser = require('rollup-plugin-terser').terser;
-    grunt.config.merge({
-        rollup: {
-            options: {
-                format: 'esm',
-                dir: 'output',
-                sourcemap: true,
-                treeshake: false,
-                context: 'window',
-                plugins: [
-                    rateLimit(),
-                    babel({
-                        sourceMaps: true,
-                        comments: false,
-                        compact: false,
-                        plugins: [
-                            'transform-es2015-modules-amd-lazy',
-                            'system-import-transformer',
-                            // This plugin modifies the Babel transpiling for "export default"
-                            // so that if it's used then only the exported value is returned
-                            // by the generated AMD module.
-                            //
-                            // It also adds the Moodle plugin name to the AMD module definition
-                            // so that it can be imported as expected in other modules.
-                            path.resolve('.grunt/babel-plugin-add-module-to-define.js'),
-                            '@babel/plugin-syntax-dynamic-import',
-                            '@babel/plugin-syntax-import-meta',
-                            ['@babel/plugin-proposal-class-properties', {'loose': false}],
-                            '@babel/plugin-proposal-json-strings'
-                        ],
-                        presets: [
-                            ['@babel/preset-env', {
-                                targets: {
-                                    browsers: [
-                                        ">0.3%",
-                                        "last 2 versions",
-                                        "not ie >= 0",
-                                        "not op_mini all",
-                                        "not Opera > 0",
-                                        "not dead"
-                                    ]
-                                },
-                                modules: false,
-                                useBuiltIns: false
-                            }]
-                        ]
-                    }),
-
-                    terser({
-                        // Do not mangle variables.
-                        // Makes debugging easier.
-                        mangle: false,
-                    }),
-                ],
-            },
-            dist: {
-                files: [{
-                    expand: true,
-                    src: grunt.moodleEnv.files ? grunt.moodleEnv.files : grunt.moodleEnv.amdSrc,
-                    rename: babelRename
-                }],
-            },
-        },
-    });
-
-    grunt.config.merge({
-        watch: {
-            amd: {
-                files: grunt.moodleEnv.inComponent
-                    ? ['amd/src/*.js', 'amd/src/**/*.js']
-                    : ['**/amd/src/**/*.js'],
-                tasks: ['amd']
-            },
-        },
-    });
-
-    // Add the 'js' task as a startup task.
-    grunt.moodleEnv.startupTasks.push('js');
-
-    // On watch, we dynamically modify config to build only affected files. This
-    // method is slightly complicated to deal with multiple changed files at once (copied
-    // from the grunt-contrib-watch readme).
-    let changedFiles = Object.create(null);
-    const onChange = grunt.util._.debounce(function() {
-        const files = Object.keys(changedFiles);
-        grunt.config('rollup.dist.files', [{expand: true, src: files, rename: babelRename}]);
-        changedFiles = Object.create(null);
-    }, 200);
-
-    grunt.event.on('watch', function(action, filepath) {
-        changedFiles[filepath] = action;
-        onChange();
-    });
-
-    return {
-        babelRename,
-    };
-};

.grunt/tasks/jsconfig.js

@@ -1,53 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2022 Andrew Lyons <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-const configuration = {
-    compilerOptions: {
-        baseUrl: ".",
-        paths: {
-        },
-        target: "es2015",
-        allowSyntheticDefaultImports: false,
-    },
-    exclude: [
-        "node_modules",
-    ],
-    include: [],
-};
-
-module.exports = (grunt) => {
-    const handler = () => {
-        const jsconfigData = Object.assign({}, configuration);
-
-        const path = require('path');
-        const {fetchComponentData} = require(path.join(process.cwd(), '.grunt', 'components.js'));
-
-        const componentData = fetchComponentData().components;
-        for (const [thisPath, component] of Object.entries(componentData)) {
-            jsconfigData.compilerOptions.paths[`${component}/*`] = [`${thisPath}/amd/src/*`];
-            jsconfigData.include.push(`${thisPath}/amd/src/**/*`);
-        }
-
-        grunt.file.write('jsconfig.json', JSON.stringify(jsconfigData, null, "  ") + "\n");
-    };
-    grunt.registerTask('jsconfig', 'Generate a jsconfig configuration compatible with the LSP', handler);
-};

.grunt/tasks/jsdoc.js

@@ -1,36 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    // Project configuration.
-    grunt.config.merge({
-        jsdoc: {
-            dist: {
-                options: {
-                    configure: ".grunt/jsdoc/jsdoc.conf.js",
-                },
-            },
-        },
-    });
-
-    grunt.loadNpmTasks('grunt-jsdoc');
-};

.grunt/tasks/sass.js

@@ -1,40 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    grunt.loadNpmTasks('grunt-sass');
-
-    grunt.config.merge({
-        sass: {
-            dist: {
-                files: {
-                    "theme/boost/style/moodle.css": "theme/boost/scss/preset/default.scss",
-                    "theme/classic/style/moodle.css": "theme/classic/scss/classicgrunt.scss"
-                }
-            },
-            options: {
-                implementation: require('sass'),
-                includePaths: ["theme/boost/scss/", "theme/classic/scss/"]
-            }
-        },
-    });
-};

.grunt/tasks/shifter.js

@@ -1,155 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-/* eslint-env node */
-
-module.exports = grunt => {
-    /**
-     * Shifter task. Is configured with a path to a specific file or a directory,
-     * in the case of a specific file it will work out the right module to be built.
-     *
-     * Note that this task runs the invidiaul shifter jobs async (becase it spawns
-     * so be careful to to call done().
-     */
-    const handler = function() {
-        const done = this.async();
-        const options = grunt.config('shifter.options');
-        const async = require('async');
-        const path = require('path');
-
-        // Run the shifter processes one at a time to avoid confusing output.
-        async.eachSeries(options.paths, function(src, filedone) {
-            var args = [];
-            args.push(path.normalize(process.cwd() + '/node_modules/shifter/bin/shifter'));
-
-            // Always ignore the node_modules directory.
-            args.push('--excludes', 'node_modules');
-
-            // Determine the most appropriate options to run with based upon the current location.
-            if (grunt.file.isMatch('**/yui/**/*.js', src)) {
-                // When passed a JS file, build our containing module (this happen with
-                // watch).
-                grunt.log.debug('Shifter passed a specific JS file');
-                src = path.dirname(path.dirname(src));
-                options.recursive = false;
-            } else if (grunt.file.isMatch('**/yui/src', src)) {
-                // When in a src directory --walk all modules.
-                grunt.log.debug('In a src directory');
-                args.push('--walk');
-                options.recursive = false;
-            } else if (grunt.file.isMatch('**/yui/src/*', src)) {
-                // When in module, only build our module.
-                grunt.log.debug('In a module directory');
-                options.recursive = false;
-            } else if (grunt.file.isMatch('**/yui/src/*/js', src)) {
-                // When in module src, only build our module.
-                grunt.log.debug('In a source directory');
-                src = path.dirname(src);
-                options.recursive = false;
-            }
-
-            if (grunt.option('watch')) {
-                grunt.fail.fatal('The --watch option has been removed, please use `grunt watch` instead');
-            }
-
-            // Add the stderr option if appropriate
-            if (grunt.option('verbose')) {
-                args.push('--lint-stderr');
-            }
-
-            if (grunt.option('no-color')) {
-                args.push('--color=false');
-            }
-
-            var execShifter = function() {
-
-                grunt.log.ok("Running shifter on " + src);
-                grunt.util.spawn({
-                    cmd: "node",
-                    args: args,
-                    opts: {cwd: src, stdio: 'inherit', env: process.env}
-                }, function(error, result, code) {
-                    if (code) {
-                        grunt.fail.fatal('Shifter failed with code: ' + code);
-                    } else {
-                        grunt.log.ok('Shifter build complete.');
-                        filedone();
-                    }
-                });
-            };
-
-            // Actually run shifter.
-            if (!options.recursive) {
-                execShifter();
-            } else {
-                // Check that there are yui modules otherwise shifter ends with exit code 1.
-                if (grunt.file.expand({cwd: src}, '**/yui/src/**/*.js').length > 0) {
-                    args.push('--recursive');
-                    execShifter();
-                } else {
-                    grunt.log.ok('No YUI modules to build.');
-                    filedone();
-                }
-            }
-        }, done);
-    };
-
-    // Register the shifter task.
-    grunt.registerTask('shifter', 'Run Shifter against the current directory', handler);
-
-    // Configure it.
-    grunt.config.set('shifter', {
-        options: {
-            recursive: true,
-            // Shifter takes a relative path.
-            paths: grunt.moodleEnv.files ? grunt.moodleEnv.files : [grunt.moodleEnv.runDir]
-        }
-    });
-
-    grunt.config.merge({
-        watch: {
-            yui: {
-                files: grunt.moodleEnv.inComponent
-                    ? ['yui/src/*.json', 'yui/src/**/*.js']
-                    : ['**/yui/src/**/*.js'],
-                tasks: ['yui']
-            },
-        },
-    });
-
-    // On watch, we dynamically modify config to build only affected files. This
-    // method is slightly complicated to deal with multiple changed files at once (copied
-    // from the grunt-contrib-watch readme).
-    let changedFiles = Object.create(null);
-    const onChange = grunt.util._.debounce(function() {
-        const files = Object.keys(changedFiles);
-        grunt.config('shifter.options.paths', files);
-        changedFiles = Object.create(null);
-    }, 200);
-
-    grunt.event.on('watch', (action, filepath) => {
-        changedFiles[filepath] = action;
-        onChange();
-    });
-
-    return handler;
-};

.grunt/tasks/startup.js

@@ -1,46 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    /**
-     * Generate ignore files (utilising thirdpartylibs.xml data)
-     */
-    const handler = function() {
-        const path = require('path');
-
-        // Are we in a YUI directory?
-        if (path.basename(path.resolve(grunt.moodleEnv.cwd, '../../')) == 'yui') {
-            grunt.task.run('yui');
-        // Are we in an AMD directory?
-        } else if (grunt.moodleEnv.inAMD) {
-            grunt.task.run('amd');
-        } else {
-            // Run all of the requested startup tasks.
-            grunt.moodleEnv.startupTasks.forEach(taskName => grunt.task.run(taskName));
-        }
-    };
-
-    // Register the startup task.
-    grunt.registerTask('startup', 'Run the correct tasks for the current directory', handler);
-
-    return handler;
-};

.grunt/tasks/style.js

@@ -1,35 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    // Load the ignorefiles tasks.
-    require('./ignorefiles')(grunt);
-
-    // Load the Style Lint tasks.
-    require('./stylelint')(grunt);
-
-    // Load the SASS tasks.
-    require('./sass')(grunt);
-
-    // Add the 'css' task as a startup task.
-    grunt.moodleEnv.startupTasks.push('css');
-};

.grunt/tasks/stylelint.js

@@ -1,183 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2021 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-
-    const getCssConfigForFiles = files => {
-        return {
-            stylelint: {
-                css: {
-                    // Use a fully-qualified path.
-                    src: files,
-                    options: {
-                        configOverrides: {
-                            rules: {
-                                // These rules have to be disabled in .stylelintrc for scss compat.
-                                "at-rule-no-unknown": true,
-                            }
-                        }
-                    }
-                },
-            },
-        };
-    };
-
-    const getScssConfigForFiles = files => {
-        return {
-            stylelint: {
-                scss: {
-                    options: {syntax: 'scss'},
-                    src: files,
-                },
-            },
-        };
-    };
-
-    /**
-     * Register any stylelint tasks.
-     *
-     * @param {Object} grunt
-     * @param {Array} files
-     * @param {String} fullRunDir
-     */
-    const registerStyleLintTasks = () => {
-        const glob = require('glob');
-
-        // The stylelinters do not handle the case where a configuration was provided but no files were included.
-        // Keep track of whether any files were found.
-        let hasCss = false;
-        let hasScss = false;
-
-        // The stylelint processors do not take a path argument. They always check all provided values.
-        // As a result we must check through each glob and determine if any files match the current directory.
-        const scssFiles = [];
-        const cssFiles = [];
-
-        const requestedFiles = grunt.moodleEnv.files;
-        if (requestedFiles) {
-            // Grunt was called with a files argument.
-            // Check whether each of the requested files matches either the CSS or SCSS source file list.
-
-            requestedFiles.forEach(changedFilePath => {
-                let matchesGlob;
-
-                // Check whether this watched path matches any watched SCSS file.
-                matchesGlob = grunt.moodleEnv.scssSrc.some(watchedPathGlob => {
-                    return glob.sync(watchedPathGlob).indexOf(changedFilePath) !== -1;
-                });
-                if (matchesGlob) {
-                    scssFiles.push(changedFilePath);
-                    hasScss = true;
-                }
-
-                // Check whether this watched path matches any watched CSS file.
-                matchesGlob = grunt.moodleEnv.cssSrc.some(watchedPathGlob => {
-                    return glob.sync(watchedPathGlob).indexOf(changedFilePath) !== -1;
-                });
-                if (matchesGlob) {
-                    cssFiles.push(changedFilePath);
-                    hasCss = true;
-                }
-            });
-        } else {
-            // Grunt was called without a list of files.
-            // The start directory (runDir) may be a child dir of the project.
-            // Check each scssSrc file to see if it's in the start directory.
-            // This means that we can lint just mod/*/styles.css if started in the mod directory.
-
-            grunt.moodleEnv.scssSrc.forEach(path => {
-                if (path.startsWith(grunt.moodleEnv.runDir)) {
-                    scssFiles.push(path);
-                    hasScss = true;
-                }
-            });
-
-            grunt.moodleEnv.cssSrc.forEach(path => {
-                if (path.startsWith(grunt.moodleEnv.runDir)) {
-                    cssFiles.push(path);
-                    hasCss = true;
-                }
-            });
-        }
-
-        // Register the tasks.
-        const scssTasks = ['sass'];
-        if (hasScss) {
-            grunt.config.merge(getScssConfigForFiles(scssFiles));
-            scssTasks.unshift('stylelint:scss');
-        }
-        scssTasks.unshift('ignorefiles');
-
-        const cssTasks = ['ignorefiles'];
-        if (hasCss) {
-            grunt.config.merge(getCssConfigForFiles(cssFiles));
-            cssTasks.push('stylelint:css');
-        }
-
-        // The tasks must be registered, even if empty to ensure a consistent command list.
-        // They jsut won't run anything.
-        grunt.registerTask('scss', scssTasks);
-        grunt.registerTask('rawcss', cssTasks);
-    };
-
-    // Register CSS tasks.
-    grunt.loadNpmTasks('grunt-stylelint');
-
-    // Register the style lint tasks.
-    registerStyleLintTasks();
-    grunt.registerTask('css', ['scss', 'rawcss']);
-
-    const getCoreThemeMatches = () => {
-        const scssMatch = 'scss/**/*.scss';
-
-        if (grunt.moodleEnv.inTheme) {
-            return [scssMatch];
-        }
-
-        if (grunt.moodleEnv.runDir.startsWith('theme')) {
-            return [`*/${scssMatch}`];
-        }
-
-        return [`theme/*/${scssMatch}`];
-    };
-
-    // Add the watch configuration for rawcss, and scss.
-    grunt.config.merge({
-        watch: {
-            rawcss: {
-                files: [
-                    '**/*.css',
-                ],
-                excludes: [
-                    '**/moodle.css',
-                    '**/editor.css',
-                    'jsdoc/styles/*.css',
-                ],
-                tasks: ['rawcss']
-            },
-            scss: {
-                files: getCoreThemeMatches(),
-                tasks: ['scss']
-            },
-        },
-    });
-};

.grunt/tasks/upgradablelibs.js

@@ -1,42 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * @copyright  2023 Sara Arjona <sara@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-module.exports = grunt => {
-    /**
-     * Generate upgradable third-party libraries (utilising thirdpartylibs.xml data)
-     */
-    grunt.registerTask('upgradablelibs', 'Generate upgradable third-party libraries', async function() {
-        const done = this.async();
-
-        const path = require('path');
-        const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
-
-        // An array of third party libraries that have a newer version in their repositories.
-        const thirdPartyLibs = await ComponentList.getThirdPartyLibsUpgradable({progress: true});
-        for (let library of thirdPartyLibs) {
-            grunt.log.ok(JSON.stringify(Object.assign({}, library), null, 4));
-        }
-
-        done();
-    });
-
-};

.grunt/tasks/watch.js

@@ -1,272 +0,0 @@
-/**
- * This is a wrapper task to handle the grunt watch command. It attempts to use
- * Watchman to monitor for file changes, if it's installed, because it's much faster.
- *
- * If Watchman isn't installed then it falls back to the grunt-contrib-watch file
- * watcher for backwards compatibility.
- */
-
-/* eslint-env node */
-
-module.exports = grunt => {
-    /**
-     * This is a wrapper task to handle the grunt watch command. It attempts to use
-     * Watchman to monitor for file changes, if it's installed, because it's much faster.
-     *
-     * If Watchman isn't installed then it falls back to the grunt-contrib-watch file
-     * watcher for backwards compatibility.
-     */
-    const watchHandler = function() {
-        const async = require('async');
-        const watchTaskDone = this.async();
-        let watchInitialised = false;
-        let watchTaskQueue = {};
-        let processingQueue = false;
-
-        const watchman = require('fb-watchman');
-        const watchmanClient = new watchman.Client();
-
-        // Grab the tasks and files that have been queued up and execute them.
-        var processWatchTaskQueue = function() {
-            if (!Object.keys(watchTaskQueue).length || processingQueue) {
-                // If there is nothing in the queue or we're already processing then wait.
-                return;
-            }
-
-            processingQueue = true;
-
-            // Grab all tasks currently in the queue.
-            var queueToProcess = watchTaskQueue;
-            // Reset the queue.
-            watchTaskQueue = {};
-
-            async.forEachSeries(
-                Object.keys(queueToProcess),
-                function(task, next) {
-                    var files = queueToProcess[task];
-                    var filesOption = '--files=' + files.join(',');
-                    grunt.log.ok('Running task ' + task + ' for files ' + filesOption);
-
-                    // Spawn the task in a child process so that it doesn't kill this one
-                    // if it failed.
-                    grunt.util.spawn(
-                        {
-                            // Spawn with the grunt bin.
-                            grunt: true,
-                            // Run from current working dir and inherit stdio from process.
-                            opts: {
-                                cwd: grunt.moodleEnv.fullRunDir,
-                                stdio: 'inherit'
-                            },
-                            args: [task, filesOption]
-                        },
-                        function(err, res, code) {
-                            if (code !== 0) {
-                                // The grunt task failed.
-                                grunt.log.error(err);
-                            }
-
-                            // Move on to the next task.
-                            next();
-                        }
-                    );
-                },
-                function() {
-                    // No longer processing.
-                    processingQueue = false;
-                    // Once all of the tasks are done then recurse just in case more tasks
-                    // were queued while we were processing.
-                    processWatchTaskQueue();
-                }
-            );
-        };
-
-        const originalWatchConfig = grunt.config.get(['watch']);
-        const watchConfig = Object.keys(originalWatchConfig).reduce(function(carry, key) {
-            if (key == 'options') {
-                return carry;
-            }
-
-            const value = originalWatchConfig[key];
-
-            const taskNames = value.tasks;
-            const files = value.files;
-            let excludes = [];
-            if (value.excludes) {
-                excludes = value.excludes;
-            }
-
-            taskNames.forEach(function(taskName) {
-                carry[taskName] = {
-                    files,
-                    excludes,
-                };
-            });
-
-            return carry;
-        }, {});
-
-        watchmanClient.on('error', function(error) {
-            // We have to add an error handler here and parse the error string because the
-            // example way from the docs to check if Watchman is installed doesn't actually work!!
-            // See: https://github.com/facebook/watchman/issues/509
-            if (error.message.match('Watchman was not found')) {
-                // If watchman isn't installed then we should fallback to the other watch task.
-                grunt.log.ok('It is recommended that you install Watchman for better performance using the "watch" command.');
-
-                // Fallback to the old grunt-contrib-watch task.
-                grunt.renameTask('watch-grunt', 'watch');
-                grunt.task.run(['watch']);
-                // This task is finished.
-                watchTaskDone(0);
-            } else {
-                grunt.log.error(error);
-                // Fatal error.
-                watchTaskDone(1);
-            }
-        });
-
-        watchmanClient.on('subscription', function(resp) {
-            if (resp.subscription !== 'grunt-watch') {
-                return;
-            }
-
-            resp.files.forEach(function(file) {
-                grunt.log.ok('File changed: ' + file.name);
-
-                var fullPath = grunt.moodleEnv.fullRunDir + '/' + file.name;
-                Object.keys(watchConfig).forEach(function(task) {
-
-                    const fileGlobs = watchConfig[task].files;
-                    var match = fileGlobs.some(function(fileGlob) {
-                        return grunt.file.isMatch(`**/${fileGlob}`, fullPath);
-                    });
-
-                    if (match) {
-                        // If we are watching a subdirectory then the file.name will be relative
-                        // to that directory. However the grunt tasks  expect the file paths to be
-                        // relative to the Gruntfile.js location so let's normalise them before
-                        // adding them to the queue.
-                        var relativePath = fullPath.replace(grunt.moodleEnv.gruntFilePath + '/', '');
-                        if (task in watchTaskQueue) {
-                            if (!watchTaskQueue[task].includes(relativePath)) {
-                                watchTaskQueue[task] = watchTaskQueue[task].concat(relativePath);
-                            }
-                        } else {
-                            watchTaskQueue[task] = [relativePath];
-                        }
-                    }
-                });
-            });
-
-            processWatchTaskQueue();
-        });
-
-        process.on('SIGINT', function() {
-            // Let the user know that they may need to manually stop the Watchman daemon if they
-            // no longer want it running.
-            if (watchInitialised) {
-                grunt.log.ok('The Watchman daemon may still be running and may need to be stopped manually.');
-            }
-
-            process.exit();
-        });
-
-        // Initiate the watch on the current directory.
-        watchmanClient.command(['watch-project', grunt.moodleEnv.fullRunDir], function(watchError, watchResponse) {
-            if (watchError) {
-                grunt.log.error('Error initiating watch:', watchError);
-                watchTaskDone(1);
-                return;
-            }
-
-            if ('warning' in watchResponse) {
-                grunt.log.error('warning: ', watchResponse.warning);
-            }
-
-            var watch = watchResponse.watch;
-            var relativePath = watchResponse.relative_path;
-            watchInitialised = true;
-
-            watchmanClient.command(['clock', watch], function(clockError, clockResponse) {
-                if (clockError) {
-                    grunt.log.error('Failed to query clock:', clockError);
-                    watchTaskDone(1);
-                    return;
-                }
-
-                // Generate the expression query used by watchman.
-                // Documentation is limited, but see https://facebook.github.io/watchman/docs/expr/allof.html for examples.
-                // We generate an expression to match any value in the files list of all of our tasks, but excluding
-                // all value in the  excludes list of that task.
-                //
-                // [anyof, [
-                //      [allof, [
-                //          [anyof, [
-                //              ['match', validPath, 'wholename'],
-                //              ['match', validPath, 'wholename'],
-                //          ],
-                //          [not,
-                //              [anyof, [
-                //                  ['match', invalidPath, 'wholename'],
-                //                  ['match', invalidPath, 'wholename'],
-                //              ],
-                //          ],
-                //      ],
-                var matchWholeName = fileGlob => ['match', fileGlob, 'wholename'];
-                var matches = Object.keys(watchConfig).map(function(task) {
-                    const matchAll = [];
-                    matchAll.push(['anyof'].concat(watchConfig[task].files.map(matchWholeName)));
-
-                    if (watchConfig[task].excludes.length) {
-                        matchAll.push(['not', ['anyof'].concat(watchConfig[task].excludes.map(matchWholeName))]);
-                    }
-
-                    return ['allof'].concat(matchAll);
-                });
-
-                matches = ['anyof'].concat(matches);
-
-                var sub = {
-                    expression: matches,
-                    // Which fields we're interested in.
-                    fields: ["name", "size", "type"],
-                    // Add our time constraint.
-                    since: clockResponse.clock
-                };
-
-                if (relativePath) {
-                    /* eslint-disable camelcase */
-                    sub.relative_root = relativePath;
-                }
-
-                watchmanClient.command(['subscribe', watch, 'grunt-watch', sub], function(subscribeError) {
-                    if (subscribeError) {
-                        // Probably an error in the subscription criteria.
-                        grunt.log.error('failed to subscribe: ', subscribeError);
-                        watchTaskDone(1);
-                        return;
-                    }
-
-                    grunt.log.ok('Listening for changes to files in ' + grunt.moodleEnv.fullRunDir);
-                });
-            });
-        });
-    };
-
-    // Rename the grunt-contrib-watch "watch" task because we're going to wrap it.
-    grunt.renameTask('watch', 'watch-grunt');
-
-    // Register the new watch handler.
-    grunt.registerTask('watch', 'Run tasks on file changes', watchHandler);
-
-    grunt.config.merge({
-        watch: {
-            options: {
-                nospawn: true // We need not to spawn so config can be changed dynamically.
-            },
-        },
-    });
-
-    return watchHandler;
-};

.jshintignore

@@ -1,2 +0,0 @@
-**/amd/**
-/*.js

.jshintrc

@@ -1,58 +0,0 @@
-// NOTE: We use eslint now. This file is used only by shifter. We keep the configuration
-// here because shifter uses jshint after modules have been concating. Eslint can't
-// currently do this.
-{
-    "asi":          false,
-    "bitwise":      true,
-    "boss":         false,
-    "browser":      true,
-    "curly":        true,
-    "debug":        false,
-    "eqeqeq":       false,
-    "eqnull":       false,
-    "es5":          false,
-    "esnext":       false,
-    "evil":         false,
-    "expr":         false,
-    "forin":        false,
-    "funcscope":    false,
-    "globalstrict": false,
-    "immed":        true,
-    "indent":       4,
-    "iterator":     false,
-    "lastsemic":    false,
-    "latedef":      true,
-    "laxbreak":     true,
-    "laxcomma":     false,
-    "loopfunc":     false,
-    "maxerr":       500,
-    "maxlen":       132,
-    "multistr":     false,
-    "newcap":       true,
-    "noarg":        true,
-    "noempty":      true,
-    "nomen":        false,
-    "onecase":      false,
-    "onevar":       false,
-    "passfail":     false,
-    "plusplus":     false,
-    "predef": [
-        "M",
-        "define",
-        "require"
-    ],
-    "proto":        false,
-    "regexdash":    false,
-    "regexp":       false,
-    "scripturl":    false,
-    "shadow":       false,
-    "smarttabs":    false,
-    "strict":       false,
-    "sub":          false,
-    "supernew":     false,
-    "trailing":     true,
-    "undef":        true,
-    "unused":       true,
-    "white":        false,
-    "yui":          true
-}

.nvmrc

@@ -1 +0,0 @@
-lts/gallium

.shifter.json

@@ -1,5 +0,0 @@
-{
-    "coverage": false,
-    "lint": "config",
-    "clean": true
-}

.stylelintrc

@@ -1,95 +0,0 @@
-{
-    "plugins": [
-        "stylelint-csstree-validator"
-    ],
-    "rules": {
-        "csstree/validator": true,
-        "at-rule-empty-line-before": [ "always",
-          {"except": [ "blockless-after-blockless"], ignore: ["after-comment", "inside-block"]}
-        ],
-        "at-rule-name-case": "lower",
-        "at-rule-name-space-after": "always-single-line",
-        "at-rule-no-unknown": null, # Enabled for non-scss in grunt.
-        "at-rule-semicolon-newline-after": "always",
-        "at-rule-semicolon-space-before": "never",
-        "block-closing-brace-newline-after": "always",
-        "block-closing-brace-newline-before": "always",
-        "block-closing-brace-space-before": "always-single-line",
-        "block-no-empty": true,
-        "block-opening-brace-newline-after": "always",
-        "block-opening-brace-space-after": "always-single-line",
-        "block-opening-brace-space-before": "always",
-        "color-hex-case": ["lower", { "severity": "warning" }],
-        "color-hex-length": ["short", { "severity": "warning" }],
-        "color-no-invalid-hex": true,
-        "declaration-bang-space-after": "never",
-        "declaration-bang-space-before": "always",
-        "declaration-block-no-duplicate-properties": true,
-        "declaration-block-no-shorthand-property-overrides": true,
-        "declaration-block-semicolon-newline-after": "always-multi-line",
-        "declaration-block-semicolon-space-after": "always-single-line",
-        "declaration-block-semicolon-space-before": "never",
-        "declaration-block-single-line-max-declarations": 1,
-        "declaration-block-trailing-semicolon": "always",
-        "declaration-colon-newline-after": "always-multi-line",
-        "declaration-colon-space-after": "always-single-line",
-        "declaration-colon-space-before": "never",
-        "declaration-no-important": true,
-        "font-family-no-duplicate-names": true,
-        "function-calc-no-unspaced-operator": true,
-        "function-comma-newline-after": "always-multi-line",
-        "function-comma-space-after": "always-single-line",
-        "function-comma-space-before": "never",
-        "function-linear-gradient-no-nonstandard-direction": true,
-        "function-max-empty-lines": 0,
-        "function-name-case": "lower",
-        "function-parentheses-newline-inside": "always-multi-line",
-        "function-parentheses-space-inside": "never-single-line",
-        "function-url-scheme-blacklist": ["data"],
-        "function-whitespace-after": "always",
-        "indentation": 4,
-        "keyframe-declaration-no-important": true,
-        "length-zero-no-unit": [true, { "severity": "warning" }],
-        "max-empty-lines": 2,
-        "max-line-length": [132, { "severity": "warning" }],
-        "media-feature-colon-space-after": "always",
-        "media-feature-colon-space-before": "never",
-        "media-feature-parentheses-space-inside": "never",
-        "media-feature-range-operator-space-after": "always",
-        "media-feature-range-operator-space-before": "always",
-        "media-query-list-comma-newline-after": "always-multi-line",
-        "media-query-list-comma-space-after": "always-single-line",
-        "media-query-list-comma-space-before": "never",
-        "no-empty-source": true,
-        "no-eol-whitespace": true,
-        "no-extra-semicolons": [true, { "severity": "warning" }],
-        "no-invalid-double-slash-comments": true,
-        "no-unknown-animations": true,
-        "property-case": "lower",
-        "property-no-unknown": true,
-        "selector-attribute-brackets-space-inside": "never",
-        "selector-attribute-operator-space-after": "never",
-        "selector-attribute-operator-space-before": "never",
-        "selector-combinator-space-after": "always",
-        "selector-combinator-space-before": "always",
-        "selector-list-comma-newline-after": "always",
-        "selector-list-comma-space-before": "never",
-        "selector-max-empty-lines": 0,
-        "selector-pseudo-class-case": "lower",
-        "selector-pseudo-class-no-unknown": true,
-        "selector-pseudo-class-parentheses-space-inside": "never",
-        "selector-pseudo-element-case": "lower",
-        "selector-pseudo-element-no-unknown": true,
-        "selector-type-case": "lower",
-        "selector-type-no-unknown": true,
-        "string-no-newline": true,
-        "time-min-milliseconds": 100,
-        "unit-blacklist": ["pt"],
-        "unit-case": "lower",
-        "unit-no-unknown": true,
-        "value-keyword-case": ["lower", {"ignoreKeywords": ["/(@|$)/"]}],
-        "value-list-comma-newline-after": "always-multi-line",
-        "value-list-comma-space-after": "always-single-line",
-        "value-list-comma-space-before": "never",
-  }
-}

CONTRIBUTING.txt

@@ -1,56 +0,0 @@
-CONTRIBUTING TO MOODLE
-======================
-
-Moodle is made by people like you. We are members of a big worldwide community
-of developers, designers, teachers, testers, translators and other users. We
-work in universities, schools, companies and other places. You are very welcome
-to join us and contribute to the project.
-
-See <https://moodledev.io/general/community/contribute> for the many ways you
-can help, not only with coding.
-
-Moodle is open to community contributions to core, though all code must go
-through peer-review, automated behaviour testing, continuous integration and
-human post-integration checks.
-
-Pull requests
--------------
-
-Please do not open pull requests via Github. The repository there is just a
-mirror of the official repository at <https://git.moodle.org>. Issues are
-reported and patches provided via <https://tracker.moodle.org>. See below for
-more information.
-
-Moodle core bug fixes and new features
---------------------------------------
-
-During the years of intensive development, a mature process of including
-submitted patches has evolved.
-
-* Every bug fix or new feature must have a tracker issue.
-* You publish the branch implementing the fix or new feature in your public
-  clone of the moodle.git repository (typically on Github).
-* Your patch is peer-reviewed, discussed, integrated, tested and then released
-  as a part of moodle.git.
-* New features are developed on the master branch. Bug fixes are also
-  backported to currently supported maintenance (stable) branches.
-
-For further details, see <https://moodledev.io/general/development/process>.
-
-Moodle plugins
---------------
-
-Moodle has a framework for additional plugins to extend its functionality. We
-have a Moodle plugins directory <https://moodle.org/plugins/> where you can
-register and maintain your plugin. Plugins hosted in the plugins directory can
-be easily installed and updated via the Moodle administration interface.
-
-* You are expected to have a public source code repository with your plugin
-  code.
-* After registering your plugin in the plugins directory it is reviewed before
-  being published.
-* You are expected to continuously release updated versions of the plugin via
-  the plugins directory. We do not pull from your code repository; you must do
-  it explicitly.
-
-For further details, see <https://moodledev.io/general/community/plugincontribution>.

Gruntfile.js

@@ -1,267 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-/* jshint node: true, browser: false */
-/* eslint-env node */
-
-/**
- * Grunt configuration for Moodle.
- *
- * @copyright  2014 Andrew Nicols
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-/**
- * Setup the Grunt Moodle environment.
- *
- * @param   {Grunt} grunt
- * @returns {Object}
- */
-const setupMoodleEnvironment = grunt => {
-    const fs = require('fs');
-    const path = require('path');
-    const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
-
-    const getAmdConfiguration = () => {
-        // If the cwd is the amd directory in the current component then it will be empty.
-        // If the cwd is a child of the component's AMD directory, the relative directory will not start with ..
-        let inAMD = !path.relative(`${componentDirectory}/amd`, cwd).startsWith('..');
-
-        // Globbing pattern for matching all AMD JS source files.
-        let amdSrc = [];
-        if (inComponent) {
-            amdSrc.push(
-                componentDirectory + "/amd/src/*.js",
-                componentDirectory + "/amd/src/**/*.js"
-            );
-        } else {
-            amdSrc = ComponentList.getAmdSrcGlobList();
-        }
-
-        return {
-            inAMD,
-            amdSrc,
-        };
-    };
-
-    const getYuiConfiguration = () => {
-        let yuiSrc = [];
-        if (inComponent) {
-            yuiSrc.push(componentDirectory + "/yui/src/**/*.js");
-        } else {
-            yuiSrc = ComponentList.getYuiSrcGlobList(gruntFilePath + '/');
-        }
-
-        return {
-            yuiSrc,
-        };
-    };
-
-    const getStyleConfiguration = () => {
-        const ComponentList = require(path.join(process.cwd(), '.grunt', 'components.js'));
-        // Build the cssSrc and scssSrc.
-        // Valid paths are:
-        // [component]/styles.css; and either
-        // [theme/[themename]]/scss/**/*.scss; or
-        // [theme/[themename]]/style/*.css.
-        //
-        // If a theme has scss, then it is assumed that the style directory contains generated content.
-        let cssSrc = [];
-        let scssSrc = [];
-
-        const checkComponentDirectory = componentDirectory => {
-            const isTheme = componentDirectory.startsWith('theme/');
-            if (isTheme) {
-                const scssDirectory = `${componentDirectory}/scss`;
-
-                if (fs.existsSync(scssDirectory)) {
-                    // This theme has an SCSS directory.
-                    // Include all scss files within it recursively, but do not check for css files.
-                    scssSrc.push(`${scssDirectory}/*.scss`);
-                    scssSrc.push(`${scssDirectory}/**/*.scss`);
-                } else {
-                    // This theme has no SCSS directory.
-                    // Only hte CSS files in the top-level directory are checked.
-                    cssSrc.push(`${componentDirectory}/style/*.css`);
-                }
-            } else {
-                // This is not a theme.
-                // All other plugin types are restricted to a single styles.css in their top level.
-                cssSrc.push(`${componentDirectory}/styles.css`);
-            }
-        };
-
-        if (inComponent) {
-            checkComponentDirectory(componentDirectory);
-        } else {
-            ComponentList.getComponentPaths(`${gruntFilePath}/`).forEach(componentPath => {
-                checkComponentDirectory(componentPath);
-            });
-        }
-
-        return {
-            cssSrc,
-            scssSrc,
-        };
-    };
-
-    /**
-     * Calculate the cwd, taking into consideration the `root` option (for Windows).
-     *
-     * @param {Object} grunt
-     * @returns {String} The current directory as best we can determine
-     */
-    const getCwd = grunt => {
-        let cwd = fs.realpathSync(process.env.PWD || process.cwd());
-
-        // Windows users can't run grunt in a subdirectory, so allow them to set
-        // the root by passing --root=path/to/dir.
-        if (grunt.option('root')) {
-            const root = grunt.option('root');
-            if (grunt.file.exists(__dirname, root)) {
-                cwd = fs.realpathSync(path.join(__dirname, root));
-                grunt.log.ok('Setting root to ' + cwd);
-            } else {
-                grunt.fail.fatal('Setting root to ' + root + ' failed - path does not exist');
-            }
-        }
-
-        return cwd;
-    };
-
-    // Detect directories:
-    // * gruntFilePath          The real path on disk to this Gruntfile.js
-    // * cwd                    The current working directory, which can be overridden by the `root` option
-    // * relativeCwd            The cwd, relative to the Gruntfile.js
-    // * componentDirectory     The root directory of the component if the cwd is in a valid component
-    // * inComponent            Whether the cwd is in a valid component
-    // * runDir                 The componentDirectory or cwd if not in a component, relative to Gruntfile.js
-    // * fullRunDir             The full path to the runDir
-    const gruntFilePath = fs.realpathSync(process.cwd());
-    const cwd = getCwd(grunt);
-    const relativeCwd = path.relative(gruntFilePath, cwd);
-    const componentDirectory = ComponentList.getOwningComponentDirectory(relativeCwd);
-    const inComponent = !!componentDirectory;
-    const inTheme = !!componentDirectory && componentDirectory.startsWith('theme/');
-    const runDir = inComponent ? componentDirectory : relativeCwd;
-    const fullRunDir = fs.realpathSync(gruntFilePath + path.sep + runDir);
-    const {inAMD, amdSrc} = getAmdConfiguration();
-    const {yuiSrc} = getYuiConfiguration();
-    const {cssSrc, scssSrc} = getStyleConfiguration();
-
-    let files = null;
-    if (grunt.option('files')) {
-        // Accept a comma separated list of files to process.
-        files = grunt.option('files').split(',');
-    }
-
-    grunt.log.debug('============================================================================');
-    grunt.log.debug(`= Node version:        ${process.versions.node}`);
-    grunt.log.debug(`= grunt version:       ${grunt.package.version}`);
-    grunt.log.debug(`= process.cwd:         '` + process.cwd() + `'`);
-    grunt.log.debug(`= process.env.PWD:     '${process.env.PWD}'`);
-    grunt.log.debug(`= path.sep             '${path.sep}'`);
-    grunt.log.debug('============================================================================');
-    grunt.log.debug(`= gruntFilePath:       '${gruntFilePath}'`);
-    grunt.log.debug(`= relativeCwd:         '${relativeCwd}'`);
-    grunt.log.debug(`= componentDirectory:  '${componentDirectory}'`);
-    grunt.log.debug(`= inComponent:         '${inComponent}'`);
-    grunt.log.debug(`= runDir:              '${runDir}'`);
-    grunt.log.debug(`= fullRunDir:          '${fullRunDir}'`);
-    grunt.log.debug('============================================================================');
-
-    if (inComponent) {
-        grunt.log.ok(`Running tasks for component directory ${componentDirectory}`);
-    }
-
-    return {
-        amdSrc,
-        componentDirectory,
-        cwd,
-        cssSrc,
-        files,
-        fullRunDir,
-        gruntFilePath,
-        inAMD,
-        inComponent,
-        inTheme,
-        relativeCwd,
-        runDir,
-        scssSrc,
-        yuiSrc,
-    };
-};
-
-/**
- * Verify tha tthe current NodeJS version matches the required version in package.json.
- *
- * @param   {Grunt} grunt
- */
-const verifyNodeVersion = grunt => {
-    const semver = require('semver');
-
-    // Verify the node version is new enough.
-    var expected = semver.validRange(grunt.file.readJSON('package.json').engines.node);
-    var actual = semver.valid(process.version);
-    if (!semver.satisfies(actual, expected)) {
-        grunt.fail.fatal('Node version not satisfied. Require ' + expected + ', version installed: ' + actual);
-    }
-};
-
-/**
- * Grunt configuration.
- *
- * @param {Grunt} grunt
- */
-module.exports = function(grunt) {
-    // Verify that the Node version meets our requirements.
-    verifyNodeVersion(grunt);
-
-    // Setup the Moodle environemnt within the Grunt object.
-    grunt.moodleEnv = setupMoodleEnvironment(grunt);
-
-    /**
-     * Add the named task.
-     *
-     * @param   {string} name
-     * @param   {Grunt} grunt
-     */
-    const addTask = (name, grunt) => {
-        const path = require('path');
-        const taskPath = path.resolve(`./.grunt/tasks/${name}.js`);
-
-        grunt.log.debug(`Including tasks for ${name} from ${taskPath}`);
-
-        require(path.resolve(`./.grunt/tasks/${name}.js`))(grunt);
-    };
-
-    // Startup tasks.
-    grunt.moodleEnv.startupTasks = [];
-
-    // Add Moodle task configuration.
-    addTask('gherkinlint', grunt);
-    addTask('ignorefiles', grunt);
-
-    addTask('javascript', grunt);
-    addTask('style', grunt);
-    addTask('componentlibrary', grunt);
-
-    addTask('watch', grunt);
-    addTask('startup', grunt);
-
-    addTask('upgradablelibs', grunt);
-
-    // Register the default task.
-    grunt.registerTask('default', ['startup']);
-};

INSTALL.txt

@@ -1,20 +0,0 @@
-MOODLE INSTALLATION
-===================
-
-Here is a short summary of the installation process (which can take just a few
-minutes):
-
-1. Move the Moodle files into your web directory.
-
-2. Create a single database for Moodle to store all its tables in (or choose an
-   existing database).
-
-3. Visit your Moodle site with a browser. You should be taken to the
-   install.php script, which will lead you through creating a config.php file
-   and then setting up Moodle, creating an admin account etc.
-
-4. Set up a cron task to call the file admin/cron.php every minute.
-
-For more information, see <https://docs.moodle.org/en/Installing_Moodle>.
-
-Good luck and have fun!

PULL_REQUEST_TEMPLATE.txt

@@ -1,7 +0,0 @@
-*** PLEASE DO NOT OPEN PULL REQUESTS VIA GITHUB ***
-
-The moodle.git repository at Github is just a mirror of the official repository. We do not accept pull requests at Github.
-
-See CONTRIBUTING.txt guidelines for how to contribute patches for Moodle. Thank you.
-
---

README.txt

@@ -1,28 +1,29 @@
-                                 .-..-.
-   _____                         | || |
-  /____/-.---_  .---.  .---.  .-.| || | .---.
-  | |  _   _  |/  _  \/  _  \/  _  || |/  __ \
-  * | | | | | || |_| || |_| || |_| || || |___/
-    |_| |_| |_|\_____/\_____/\_____||_|\_____)
+QUICK INSTALL
+=============
 
-Moodle - the world's open source learning platform
+For the impatient, here is a basic outline of the
+installation process, which normally takes me only
+a few minutes:
 
-Moodle <https://moodle.org> is a learning platform designed to provide
-educators, administrators and learners with a single robust, secure and
-integrated system to create personalised learning environments.
+1) Move the Moodle files into your web directory.
 
-You can download Moodle <https://download.moodle.org> and run it on your own
-web server, ask one of our Moodle Partners <https://moodle.com/partners/> to
-assist you, or have a MoodleCloud site <https://moodle.com/cloud/> set up for
-you.
+2) Create a single database for Moodle to store all
+   it's tables in (or choose an existing database).
 
-Moodle is widely used around the world by universities, schools, companies and
-all manner of organisations and individuals.
+3) Visit your Moodle site with a browser, you should
+   be taken to the install.php script, which will lead
+   you through creating a config.php file and then
+   setting up Moodle, creating an admin account etc.
 
-Moodle is provided freely as open source software, under the GNU General Public
-License <https://moodledev.io/general/license>.
+4) Set up a cron task to call the file admin/cron.php
+   every five minutes or so.
 
-Moodle is written in PHP and JavaScript and uses an SQL database for storing
-the data.
 
-See <https://docs.moodle.org> for details of Moodle's many features.
+For more information, see the INSTALL DOCUMENTATION:
+
+   http://docs.moodle.org/en/Installing_Moodle
+
+
+Good luck and have fun!
+Martin Dougiamas, Lead Developer
+

TRADEMARK.txt

@@ -1,66 +1,34 @@
-MOODLE TRADEMARKS POLICY
-========================
-
-The Moodle Trademark
---------------------
-
-The brand and word "Moodle" has trade mark protection in many countries around
-the world. Various Moodle™ trade marks are owned by either Moodle Pty Ltd or
-one of its associated entities. The law obligates trade mark owners to police
-their trade marks and prevent the use of confusingly similar names by
-third parties.
-
-We have created a more concise and thorough set of Trademark Guidelines
-(https://moodle.com/wp-content/uploads/2023/02/Moodle-Trademark-Guidelines-2023-4.pdf)
-to help you understand how to comply with Moodle's trade mark requirements.
-The Trademark Guidelines will also assist our Moodle Certified Partners and the
-community to understand some of the principles that inform Moodle's stance
-whenever potential infringement has been detected by us or our community.
-
-We need to be clear about use of the word "Moodle" and how we restrict its use
-when promoting commercial Moodle™ branded services. The proper use of
-trade marks reliably assures consumers about the quality of the associated
-products or services and where they have been derived from. Because the
-Moodle LMS is made available under the open source ‘GNU General Public License'
-that permits you to modify the copyrighted software, the distribution of such
-modified software in combination with Moodle trade marks can potentially
-mislead others in the community. To be clear, the GNU GPL does not include an
-implied right or licence to use Moodle's trade marks.
-
-We do all this to protect the very business model that allows us to continue
-developing various Moodle software solutions for you.
-
-Allowed uses of "Moodle"
+------------------------
+Moodle Trademark License
 ------------------------
 
-The following uses don't require any permission at all:
+The name Moodle™ is a registered trademark of the Moodle Trust.
 
-* Referring to the software or the Moodle project as the "Moodle™ software"
-  or the "Moodle™ project"
-* Describing your own implementation of the Moodle™ software platform
-  (including within corporate settings).
-* Describing a Moodle-based community hub.
-* Describing certain software you've made that integrates with Moodle™
-  branded software (e.g. a Moodle™ integration feature on another system).
+A key part of the business model that allows us to produce and
+distribute Moodle as completely Free open source software is that
+we restrict the commercial use of the Moodle trademark to those
+who have contracted to support Moodle development (Moodle Partners).
 
-Restricted uses of "Moodle"
----------------------------
+If you are intending to use the name (and/or logo) to advertise
+generic Moodle™ services (eg Moodle Hosting, Moodle Support,
+Moodle Certification, Moodle Training, Moodle Consulting,
+Moodle Customisation, Moodle Courseware Development, Moodle
+Theme design, Moodle Integrations, Moodle Installations, etc)
+or as the name of a software package, then you must seek
+direct permission in writing from the Moodle Trust via the
+moodle.com helpdesk, in accordance with normal trademark
+restrictions.
 
-The following uses are generally prohibited without explicit and direct
-permission being granted to you by Moodle Pty Ltd. We do this to protect the
-Moodle™ project from software and sites which could confuse people. If in
-doubt, reach out for clarification at <trademarks@moodle.com>
+There are no restrictions on how you use the name in other
+contexts (for example, if you use Moodle just to provide
+courses then you can use the name freely to refer to it.)
 
-* You can't use the word "Moodle" or any Moodle logos for commercial purposes
-  without prior written permission from Moodle HQ.
-* You can't use "Moodle" in the name of your software (including Mobile apps).
-* You can't use "Moodle" in your company name.
-* You can't use "Moodle" in your domain name.
-* You can't use "Moodle" in advertising-related keywords (such as Adsense).
-* You can't use "Moodle" to describe services around Moodle
-  (such as hosting, training, support, consulting, course creation services,
-  theme development, customisation, installation, integration, analytics
-  and certification) that cause consumers to be confused that you are
-  associated with Moodle HQ if you are not.
-  This applies even if you do not charge for the services.
-  Note that usually only Moodle Partners have this permission.
+If you aren't sure of a particular case, please ask us via
+http://moodle.com/helpdesk: we'll be happy to either provide
+you with official permission in writing or help you fix
+your wording.
+
+Martin Dougiamas
+Executive Director
+Moodle Trust
+http://moodle.com

admin/amd/build/block_management_table.min.js

@@ -1,3 +0,0 @@
-define("core_admin/block_management_table",["exports","./plugin_management_table","core_table/dynamic","core/ajax","core/pending","core/notification"],(function(_exports,_plugin_management_table,_dynamic,_ajax,_pending,_notification){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,_plugin_management_table=_interopRequireDefault(_plugin_management_table),_pending=_interopRequireDefault(_pending);class _default extends _plugin_management_table.default{constructor(){super(),this.addClickHandler(this.handleBlockProtectToggle)}setBlockProtectState(plugin,state){return(0,_ajax.call)([{methodname:"core_admin_set_block_protection",args:{plugin:plugin,state:state}}])[0]}async handleBlockProtectToggle(tableRoot,e){const stateToggle=e.target.closest('[data-action="toggleprotectstate"]');if(stateToggle){e.preventDefault();const pendingPromise=new _pending.default("core_table/dynamic:processAction");await this.setBlockProtectState(stateToggle.dataset.plugin,"1"===stateToggle.dataset.targetState?1:0);const[updatedRoot]=await Promise.all([(0,_dynamic.refreshTableContent)(tableRoot),(0,_notification.fetchNotifications)()]);updatedRoot.querySelector('[data-action="toggleprotectstate"][data-plugin="'.concat(stateToggle.dataset.plugin,'"]')).focus(),pendingPromise.resolve()}}}return _exports.default=_default,_exports.default}));
-
-//# sourceMappingURL=block_management_table.min.js.map

admin/amd/build/block_management_table.min.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"block_management_table.min.js","sources":["../src/block_management_table.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\nimport PluginManagementTable from './plugin_management_table';\nimport {refreshTableContent} from 'core_table/dynamic';\nimport {call as fetchMany} from 'core/ajax';\nimport Pending from 'core/pending';\nimport {fetchNotifications} from 'core/notification';\n\nexport default class extends PluginManagementTable {\n    constructor() {\n        super();\n        this.addClickHandler(this.handleBlockProtectToggle);\n    }\n\n    /**\n     * Set the block protection state.\n     *\n     * @param {string} plugin\n     * @param {number} state\n     * @returns {Promise}\n     */\n    setBlockProtectState(plugin, state) {\n        return fetchMany([{\n            methodname: 'core_admin_set_block_protection',\n            args: {\n                plugin,\n                state,\n            },\n        }])[0];\n    }\n\n    /**\n     * Handle toggling of block protection.\n     *\n     * @param {HTMLElement} tableRoot\n     * @param {Event} e\n     */\n    async handleBlockProtectToggle(tableRoot, e) {\n        const stateToggle = e.target.closest('[data-action=\"toggleprotectstate\"]');\n        if (stateToggle) {\n            e.preventDefault();\n            const pendingPromise = new Pending('core_table/dynamic:processAction');\n\n            await this.setBlockProtectState(\n                stateToggle.dataset.plugin,\n                stateToggle.dataset.targetState === '1' ? 1 : 0\n            );\n\n            const [updatedRoot] = await Promise.all([\n                refreshTableContent(tableRoot),\n                fetchNotifications(),\n            ]);\n\n            // Refocus on the link that as pressed in the first place.\n            updatedRoot.querySelector(`[data-action=\"toggleprotectstate\"][data-plugin=\"${stateToggle.dataset.plugin}\"]`).focus();\n            pendingPromise.resolve();\n        }\n    }\n}\n"],"names":["PluginManagementTable","constructor","addClickHandler","this","handleBlockProtectToggle","setBlockProtectState","plugin","state","methodname","args","tableRoot","e","stateToggle","target","closest","preventDefault","pendingPromise","Pending","dataset","targetState","updatedRoot","Promise","all","querySelector","focus","resolve"],"mappings":"uhBAqB6BA,iCACzBC,2BAESC,gBAAgBC,KAAKC,0BAU9BC,qBAAqBC,OAAQC,cAClB,cAAU,CAAC,CACdC,WAAY,kCACZC,KAAM,CACFH,OAAAA,OACAC,MAAAA,UAEJ,kCASuBG,UAAWC,SAChCC,YAAcD,EAAEE,OAAOC,QAAQ,yCACjCF,YAAa,CACbD,EAAEI,uBACIC,eAAiB,IAAIC,iBAAQ,0CAE7Bd,KAAKE,qBACPO,YAAYM,QAAQZ,OACgB,MAApCM,YAAYM,QAAQC,YAAsB,EAAI,SAG3CC,mBAAqBC,QAAQC,IAAI,EACpC,gCAAoBZ,YACpB,wCAIJU,YAAYG,wEAAiEX,YAAYM,QAAQZ,cAAYkB,QAC7GR,eAAeS"}

admin/amd/build/plugin_management_table.min.js

@@ -1,3 +0,0 @@
-define("core_admin/plugin_management_table",["exports","core_table/dynamic","core_table/local/dynamic/selectors","core/ajax","core/pending","core/notification"],(function(_exports,_dynamic,Selectors,_ajax,_pending,_notification){var obj;function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0,Selectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(Selectors),_pending=(obj=_pending)&&obj.__esModule?obj:{default:obj};let watching=!1;return _exports.default=class{constructor(){!function(obj,key,value){key in obj?Object.defineProperty(obj,key,{value:value,enumerable:!0,configurable:!0,writable:!0}):obj[key]=value}(this,"clickHandlers",[]),this.addClickHandler(this.handleStateToggle),this.addClickHandler(this.handleMoveUpDown),this.registerEventListeners()}static init(){watching||(watching=!0,new this)}addClickHandler(handler){this.clickHandlers.push(handler.bind(this))}registerEventListeners(){document.addEventListener("click",function(e){const tableRoot=this.getTableRoot(e);tableRoot&&this.clickHandlers.forEach((handler=>handler(tableRoot,e)))}.bind(this))}getTableRoot(e){const tableRoot=e.target.closest(Selectors.main.region);return tableRoot||!1}setPluginState(methodname,plugin,state){return(0,_ajax.call)([{methodname:methodname,args:{plugin:plugin,state:state}}])[0]}setPluginOrder(methodname,plugin,direction){return(0,_ajax.call)([{methodname:methodname,args:{plugin:plugin,direction:direction}}])[0]}async handleStateToggle(tableRoot,e){const stateToggle=e.target.closest('[data-action="togglestate"][data-toggle-method]');if(stateToggle){e.preventDefault();const pendingPromise=new _pending.default("core_table/dynamic:togglestate");await this.setPluginState(stateToggle.dataset.toggleMethod,stateToggle.dataset.plugin,"1"===stateToggle.dataset.state?0:1);const[updatedRoot]=await Promise.all([(0,_dynamic.refreshTableContent)(tableRoot),(0,_notification.fetchNotifications)()]);updatedRoot.querySelector('[data-action="togglestate"][data-plugin="'.concat(stateToggle.dataset.plugin,'"]')).focus(),pendingPromise.resolve()}}async handleMoveUpDown(tableRoot,e){const actionLink=e.target.closest('[data-action="move"][data-method][data-direction]');if(!actionLink)return;e.preventDefault();const pendingPromise=new _pending.default("core_table/dynamic:processAction");await this.setPluginOrder(actionLink.dataset.method,actionLink.dataset.plugin,"up"===actionLink.dataset.direction?-1:1);const[updatedRoot]=await Promise.all([(0,_dynamic.refreshTableContent)(tableRoot),(0,_notification.fetchNotifications)()]),exactMatch=updatedRoot.querySelector('[data-action="move"][data-plugin="'.concat(actionLink.dataset.plugin,'"][data-direction="').concat(actionLink.dataset.direction,'"]'));var _updatedRoot$querySel;exactMatch?exactMatch.focus():null===(_updatedRoot$querySel=updatedRoot.querySelector('[data-action="move"][data-plugin="'.concat(actionLink.dataset.plugin,'"]')))||void 0===_updatedRoot$querySel||_updatedRoot$querySel.focus();pendingPromise.resolve()}},_exports.default}));
-
-//# sourceMappingURL=plugin_management_table.min.js.map

admin/amd/src/block_management_table.js

@@ -1,72 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-import PluginManagementTable from './plugin_management_table';
-import {refreshTableContent} from 'core_table/dynamic';
-import {call as fetchMany} from 'core/ajax';
-import Pending from 'core/pending';
-import {fetchNotifications} from 'core/notification';
-
-export default class extends PluginManagementTable {
-    constructor() {
-        super();
-        this.addClickHandler(this.handleBlockProtectToggle);
-    }
-
-    /**
-     * Set the block protection state.
-     *
-     * @param {string} plugin
-     * @param {number} state
-     * @returns {Promise}
-     */
-    setBlockProtectState(plugin, state) {
-        return fetchMany([{
-            methodname: 'core_admin_set_block_protection',
-            args: {
-                plugin,
-                state,
-            },
-        }])[0];
-    }
-
-    /**
-     * Handle toggling of block protection.
-     *
-     * @param {HTMLElement} tableRoot
-     * @param {Event} e
-     */
-    async handleBlockProtectToggle(tableRoot, e) {
-        const stateToggle = e.target.closest('[data-action="toggleprotectstate"]');
-        if (stateToggle) {
-            e.preventDefault();
-            const pendingPromise = new Pending('core_table/dynamic:processAction');
-
-            await this.setBlockProtectState(
-                stateToggle.dataset.plugin,
-                stateToggle.dataset.targetState === '1' ? 1 : 0
-            );
-
-            const [updatedRoot] = await Promise.all([
-                refreshTableContent(tableRoot),
-                fetchNotifications(),
-            ]);
-
-            // Refocus on the link that as pressed in the first place.
-            updatedRoot.querySelector(`[data-action="toggleprotectstate"][data-plugin="${stateToggle.dataset.plugin}"]`).focus();
-            pendingPromise.resolve();
-        }
-    }
-}

admin/amd/src/plugin_management_table.js

@@ -1,179 +0,0 @@
-// 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 <http://www.gnu.org/licenses/>.
-
-import {refreshTableContent} from 'core_table/dynamic';
-import * as Selectors from 'core_table/local/dynamic/selectors';
-import {call as fetchMany} from 'core/ajax';
-import Pending from 'core/pending';
-import {fetchNotifications} from 'core/notification';
-
-let watching = false;
-
-export default class {
-    /**
-     * @property {function[]} clickHandlers a list of handlers to call on click.
-     */
-    clickHandlers = [];
-
-    constructor() {
-        this.addClickHandler(this.handleStateToggle);
-        this.addClickHandler(this.handleMoveUpDown);
-        this.registerEventListeners();
-    }
-
-    /**
-     * Initialise an instance of the class.
-     *
-     * This is just a way of making it easier to initialise an instance of the class from PHP.
-     */
-    static init() {
-        if (watching) {
-            return;
-        }
-        watching = true;
-        new this();
-    }
-
-    /**
-     * Add a click handler to the list of handlers.
-     *
-     * @param {Function} handler A handler to call on a click event
-     */
-    addClickHandler(handler) {
-        this.clickHandlers.push(handler.bind(this));
-    }
-
-    /**
-     * Register the event listeners for this instance.
-     */
-    registerEventListeners() {
-        document.addEventListener('click', function(e) {
-            const tableRoot = this.getTableRoot(e);
-
-            if (!tableRoot) {
-                return;
-            }
-
-            this.clickHandlers.forEach((handler) => handler(tableRoot, e));
-        }.bind(this));
-    }
-
-    /**
-     * Get the table root from an event.
-     *
-     * @param {Event} e
-     * @returns {HTMLElement|bool}
-     */
-    getTableRoot(e) {
-        const tableRoot = e.target.closest(Selectors.main.region);
-        if (!tableRoot) {
-            return false;
-        }
-
-        return tableRoot;
-    }
-
-    /**
-     * Set the plugin state (enabled or disabled)
-     *
-     * @param {string} methodname The web service to call
-     * @param {string} plugin The name of the plugin to set the state for
-     * @param {number} state The state to set
-     * @returns {Promise}
-     */
-    setPluginState(methodname, plugin, state) {
-        return fetchMany([{
-            methodname,
-            args: {
-                plugin,
-                state,
-            },
-        }])[0];
-    }
-
-    setPluginOrder(methodname, plugin, direction) {
-        return fetchMany([{
-            methodname,
-            args: {
-                plugin,
-                direction,
-            },
-        }])[0];
-    }
-
-    /**
-     * Handle state toggling.
-     *
-     * @param {HTMLElement} tableRoot
-     * @param {Event} e
-     */
-    async handleStateToggle(tableRoot, e) {
-        const stateToggle = e.target.closest('[data-action="togglestate"][data-toggle-method]');
-        if (stateToggle) {
-            e.preventDefault();
-            const pendingPromise = new Pending('core_table/dynamic:togglestate');
-
-            await this.setPluginState(
-                stateToggle.dataset.toggleMethod,
-                stateToggle.dataset.plugin,
-                stateToggle.dataset.state === '1' ? 0 : 1
-            );
-
-            const [updatedRoot] = await Promise.all([
-                refreshTableContent(tableRoot),
-                fetchNotifications(),
-            ]);
-
-            // Refocus on the link that as pressed in the first place.
-            updatedRoot.querySelector(`[data-action="togglestate"][data-plugin="${stateToggle.dataset.plugin}"]`).focus();
-            pendingPromise.resolve();
-        }
-    }
-
-    async handleMoveUpDown(tableRoot, e) {
-        const actionLink = e.target.closest('[data-action="move"][data-method][data-direction]');
-        if (!actionLink) {
-            return;
-        }
-
-        e.preventDefault();
-
-        const pendingPromise = new Pending('core_table/dynamic:processAction');
-
-        await this.setPluginOrder(
-            actionLink.dataset.method,
-            actionLink.dataset.plugin,
-            actionLink.dataset.direction === 'up' ? -1 : 1,
-        );
-
-        const [updatedRoot] = await Promise.all([
-            refreshTableContent(tableRoot),
-            fetchNotifications(),
-        ]);
-
-        // Refocus on the link that as pressed in the first place.
-        const exactMatch = updatedRoot.querySelector(
-            `[data-action="move"][data-plugin="${actionLink.dataset.plugin}"][data-direction="${actionLink.dataset.direction}"]`
-        );
-        if (exactMatch) {
-            exactMatch.focus();
-        } else {
-            // The move link is not present anymore, so we need to focus on the other one.
-            updatedRoot.querySelector(`[data-action="move"][data-plugin="${actionLink.dataset.plugin}"]`)?.focus();
-        }
-
-        pendingPromise.resolve();
-    }
-}

admin/antiviruses.php

@@ -1,113 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Allows admin to configure antiviruses.
- *
- * @package    core_antivirus
- * @copyright  2015 Ruslan Kabalin, Lancaster University.
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-require_once('../config.php');
-require_once($CFG->libdir.'/adminlib.php');
-require_once($CFG->libdir.'/tablelib.php');
-
-$action  = required_param('action', PARAM_ALPHANUMEXT);
-$antivirus  = required_param('antivirus', PARAM_PLUGIN);
-$confirm = optional_param('confirm', 0, PARAM_BOOL);
-
-$PAGE->set_url('/admin/antiviruses.php', array('action' => $action, 'antivirus' => $antivirus));
-$PAGE->set_context(context_system::instance());
-
-require_admin();
-
-$returnurl = "$CFG->wwwroot/$CFG->admin/settings.php?section=manageantiviruses";
-
-// Get currently installed and enabled antivirus plugins.
-$availableantiviruses = \core\antivirus\manager::get_available();
-if (!empty($antivirus) and empty($availableantiviruses[$antivirus])) {
-    redirect ($returnurl);
-}
-
-$activeantiviruses = explode(',', $CFG->antiviruses);
-foreach ($activeantiviruses as $key => $active) {
-    if (empty($availableantiviruses[$active])) {
-        unset($activeantiviruses[$key]);
-    }
-}
-
-if (!confirm_sesskey()) {
-    redirect($returnurl);
-}
-
-$needsupdate = false;
-switch ($action) {
-    case 'disable':
-        // Remove from enabled list.
-        $class = \core_plugin_manager::resolve_plugininfo_class('antivirus');
-        $class::enable_plugin($antivirus, false);
-        break;
-
-    case 'enable':
-        // Add to enabled list.
-        if (!in_array($antivirus, $activeantiviruses)) {
-            $class = \core_plugin_manager::resolve_plugininfo_class('antivirus');
-            $class::enable_plugin($antivirus, true);
-        }
-        break;
-
-    case 'down':
-        $key = array_search($antivirus, $activeantiviruses);
-        // Check auth plugin is valid.
-        if ($key !== false) {
-            // Move down the list.
-            if ($key < (count($activeantiviruses) - 1)) {
-                $fsave = $activeantiviruses[$key];
-                $activeantiviruses[$key] = $activeantiviruses[$key + 1];
-                $activeantiviruses[$key + 1] = $fsave;
-                $needsupdate = true;
-            }
-        }
-        break;
-
-    case 'up':
-        $key = array_search($antivirus, $activeantiviruses);
-        // Check auth is valid.
-        if ($key !== false) {
-            // Move up the list.
-            if ($key >= 1) {
-                $fsave = $activeantiviruses[$key];
-                $activeantiviruses[$key] = $activeantiviruses[$key - 1];
-                $activeantiviruses[$key - 1] = $fsave;
-                $needsupdate = true;
-            }
-        }
-        break;
-
-    default:
-        break;
-}
-
-if ($needsupdate) {
-    $new = implode(',', $activeantiviruses);
-    add_to_config_log('antiviruses', $CFG->antiviruses, $new, 'core');
-    set_config('antiviruses', $new);
-    core_plugin_manager::reset_caches();
-}
-
-
-redirect ($returnurl);

admin/auth.php

@@ -11,13 +11,14 @@ require_once('../config.php');
 require_once($CFG->libdir.'/adminlib.php');
 require_once($CFG->libdir.'/tablelib.php');
 
-require_admin();
+require_login();
+require_capability('moodle/site:config', get_context_instance(CONTEXT_SYSTEM));
 
 $returnurl = new moodle_url('/admin/settings.php', array('section'=>'manageauths'));
 
 $PAGE->set_url($returnurl);
 
-$action = optional_param('action', '', PARAM_ALPHANUMEXT);
+$action = optional_param('action', '', PARAM_ACTION);
 $auth   = optional_param('auth', '', PARAM_PLUGIN);
 
 get_enabled_auth_plugins(true); // fix the list of enabled auths
@@ -28,7 +29,7 @@ if (empty($CFG->auth)) {
 }
 
 if (!empty($auth) and !exists_auth_plugin($auth)) {
-    throw new \moodle_exception('pluginnotinstalled', 'auth', $returnurl, $auth);
+    print_error('pluginnotinstalled', 'auth', $returnurl, $auth);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -40,31 +41,41 @@ if (!confirm_sesskey()) {
 
 switch ($action) {
     case 'disable':
-        // Remove from enabled list.
-        $class = \core_plugin_manager::resolve_plugininfo_class('auth');
-        $class::enable_plugin($auth, false);
+        // remove from enabled list
+        $key = array_search($auth, $authsenabled);
+        if ($key !== false) {
+            unset($authsenabled[$key]);
+            set_config('auth', implode(',', $authsenabled));
+        }
+
+        if ($auth == $CFG->registerauth) {
+            set_config('registerauth', '');
+        }
+        session_gc(); // remove stale sessions
         break;
 
     case 'enable':
-        // Add to enabled list.
-        $class = \core_plugin_manager::resolve_plugininfo_class('auth');
-        $class::enable_plugin($auth, true);
+        // add to enabled list
+        if (!in_array($auth, $authsenabled)) {
+            $authsenabled[] = $auth;
+            $authsenabled = array_unique($authsenabled);
+            set_config('auth', implode(',', $authsenabled));
+        }
+        session_gc(); // remove stale sessions
         break;
 
     case 'down':
         $key = array_search($auth, $authsenabled);
         // check auth plugin is valid
         if ($key === false) {
-            throw new \moodle_exception('pluginnotenabled', 'auth', $returnurl, $auth);
+            print_error('pluginnotenabled', 'auth', $returnurl, $auth);
         }
         // move down the list
         if ($key < (count($authsenabled) - 1)) {
             $fsave = $authsenabled[$key];
             $authsenabled[$key] = $authsenabled[$key + 1];
             $authsenabled[$key + 1] = $fsave;
-            $value = implode(',', $authsenabled);
-            add_to_config_log('auth', $CFG->auth, $value, 'core');
-            set_config('auth', $value);
+            set_config('auth', implode(',', $authsenabled));
         }
         break;
 
@@ -72,16 +83,14 @@ switch ($action) {
         $key = array_search($auth, $authsenabled);
         // check auth is valid
         if ($key === false) {
-            throw new \moodle_exception('pluginnotenabled', 'auth', $returnurl, $auth);
+            print_error('pluginnotenabled', 'auth', $returnurl, $auth);
         }
         // move up the list
         if ($key >= 1) {
             $fsave = $authsenabled[$key];
             $authsenabled[$key] = $authsenabled[$key - 1];
             $authsenabled[$key - 1] = $fsave;
-            $value = implode(',', $authsenabled);
-            add_to_config_log('auth', $CFG->auth, $value, 'core');
-            set_config('auth', $value);
+            set_config('auth', implode(',', $authsenabled));
         }
         break;
 
@@ -90,3 +99,5 @@ switch ($action) {
 }
 
 redirect($returnurl);
+
+

admin/auth_config.php

@@ -0,0 +1,179 @@
+<?php
+/**
+ * Edit configuration for an individual auth plugin
+ */
+
+require_once '../config.php';
+require_once $CFG->libdir.'/adminlib.php';
+
+$auth = required_param('auth', PARAM_PLUGIN);
+$PAGE->set_pagetype('admin-auth-' . $auth);
+
+admin_externalpage_setup('authsetting'.$auth);
+
+$authplugin = get_auth_plugin($auth);
+$err = array();
+
+$returnurl = "$CFG->wwwroot/$CFG->admin/settings.php?section=manageauths";
+
+// save configuration changes
+if ($frm = data_submitted() and confirm_sesskey()) {
+
+    $authplugin->validate_form($frm, $err);
+
+    if (count($err) == 0) {
+
+        // save plugin config
+        if ($authplugin->process_config($frm)) {
+
+            // save field lock configuration
+            foreach ($frm as $name => $value) {
+                if (preg_match('/^lockconfig_(.+?)$/', $name, $matches)) {
+                    $plugin = "auth/$auth";
+                    $name   = $matches[1];
+                    set_config($name, $value, $plugin);
+                }
+            }
+            redirect($returnurl);
+            exit;
+        }
+    } else {
+        foreach ($err as $key => $value) {
+            $focus = "form.$key";
+        }
+    }
+} else {
+    $frmlegacystyle = get_config('auth/'.$auth);
+    $frmnewstyle    = get_config('auth_'.$auth);
+    $frm = (object)array_merge((array)$frmlegacystyle, (array)$frmnewstyle);
+}
+
+$user_fields = $authplugin->userfields;
+//$user_fields = array("firstname", "lastname", "email", "phone1", "phone2", "institution", "department", "address", "city", "country", "description", "idnumber", "lang");
+
+/// Get the auth title (from core or own auth lang files)
+    $authtitle = $authplugin->get_title();
+/// Get the auth descriptions (from core or own auth lang files)
+    $authdescription = $authplugin->get_description();
+
+// output configuration form
+echo $OUTPUT->header();
+
+// choose an authentication method
+echo "<form id=\"authmenu\" method=\"post\" action=\"auth_config.php\">\n";
+echo "<div>\n";
+echo "<input type=\"hidden\" name=\"sesskey\" value=\"".sesskey()."\" />\n";
+echo "<input type=\"hidden\" name=\"auth\" value=\"".$auth."\" />\n";
+
+// auth plugin description
+echo $OUTPUT->box_start();
+echo $OUTPUT->heading($authtitle);
+echo $OUTPUT->box_start('informationbox');
+echo $authdescription;
+echo $OUTPUT->box_end();
+echo "<hr />\n";
+$authplugin->config_form($frm, $err, $user_fields);
+echo $OUTPUT->box_end();
+echo '<p style="text-align: center"><input type="submit" value="' . get_string("savechanges") . "\" /></p>\n";
+echo "</div>\n";
+echo "</form>\n";
+
+echo $OUTPUT->footer();
+exit;
+
+/// Functions /////////////////////////////////////////////////////////////////
+
+// Good enough for most auth plugins
+// but some may want a custom one if they are offering
+// other options
+// Note: lockconfig_ fields have special handling.
+function print_auth_lock_options ($auth, $user_fields, $helptext, $retrieveopts, $updateopts) {
+    global $OUTPUT;
+    echo '<tr><td colspan="3">';
+    if ($retrieveopts) {
+        echo $OUTPUT->heading(get_string('auth_data_mapping', 'auth'));
+    } else {
+        echo $OUTPUT->heading(get_string('auth_fieldlocks', 'auth'));
+    }
+    echo '</td></tr>';
+
+    $lockoptions = array ('unlocked'        => get_string('unlocked', 'auth'),
+                          'unlockedifempty' => get_string('unlockedifempty', 'auth'),
+                          'locked'          => get_string('locked', 'auth'));
+    $updatelocaloptions = array('oncreate'  => get_string('update_oncreate', 'auth'),
+                                'onlogin'   => get_string('update_onlogin', 'auth'));
+    $updateextoptions = array('0'  => get_string('update_never', 'auth'),
+                              '1'   => get_string('update_onupdate', 'auth'));
+
+    $pluginconfig = get_config("auth/$auth");
+
+    // helptext is on a field with rowspan
+    if (empty($helptext)) {
+                $helptext = '&nbsp;';
+    }
+
+    foreach ($user_fields as $field) {
+
+        // Define some vars we'll work with
+        if (!isset($pluginconfig->{"field_map_$field"})) {
+            $pluginconfig->{"field_map_$field"} = '';
+        }
+        if (!isset($pluginconfig->{"field_updatelocal_$field"})) {
+            $pluginconfig->{"field_updatelocal_$field"} = '';
+        }
+        if (!isset($pluginconfig->{"field_updateremote_$field"})) {
+            $pluginconfig->{"field_updateremote_$field"} = '';
+        }
+        if (!isset($pluginconfig->{"field_lock_$field"})) {
+            $pluginconfig->{"field_lock_$field"} = '';
+        }
+
+        // define the fieldname we display to the  user
+        $fieldname = $field;
+        if ($fieldname === 'lang') {
+            $fieldname = get_string('language');
+        } elseif (preg_match('/^(.+?)(\d+)$/', $fieldname, $matches)) {
+            $fieldname =  get_string($matches[1]) . ' ' . $matches[2];
+        } elseif ($fieldname == 'url') {
+            $fieldname = get_string('webpage');
+        } else {
+            $fieldname = get_string($fieldname);
+        }
+        if ($retrieveopts) {
+            $varname = 'field_map_' . $field;
+
+            echo '<tr valign="top"><td align="right">';
+            echo '<label for="lockconfig_'.$varname.'">'.$fieldname.'</label>';
+            echo '</td><td>';
+
+            echo "<input id=\"lockconfig_{$varname}\" name=\"lockconfig_{$varname}\" type=\"text\" size=\"30\" value=\"{$pluginconfig->$varname}\" />";
+            echo '<div style="text-align: right">';
+            echo '<label for="menulockconfig_field_updatelocal_'.$field.'">'.get_string('auth_updatelocal', 'auth') . '</label>&nbsp;';
+            echo html_writer::select($updatelocaloptions, "lockconfig_field_updatelocal_{$field}", $pluginconfig->{"field_updatelocal_$field"}, false);
+            echo '<br />';
+            if ($updateopts) {
+                echo '<label for="menulockconfig_field_updateremote_'.$field.'">'.get_string('auth_updateremote', 'auth') . '</label>&nbsp;';
+                echo html_writer::select($updateextoptions, "lockconfig_field_updateremote_{$field}", $pluginconfig->{"field_updateremote_$field"}, false);
+                echo '<br />';
+
+
+            }
+            echo '<label for="menulockconfig_field_lock_'.$field.'">'.get_string('auth_fieldlock', 'auth') . '</label>&nbsp;';
+            echo html_writer::select($lockoptions, "lockconfig_field_lock_{$field}", $pluginconfig->{"field_lock_$field"}, false);
+            echo '</div>';
+        } else {
+            echo '<tr valign="top"><td align="right">';
+            echo '<label for="menulockconfig_field_lock_'.$field.'">'.$fieldname.'</label>';
+            echo '</td><td>';
+            echo html_writer::select($lockoptions, "lockconfig_field_lock_{$field}", $pluginconfig->{"field_lock_$field"}, false);
+        }
+        echo '</td>';
+        if (!empty($helptext)) {
+            echo '<td rowspan="' . count($user_fields) . '">' . $helptext . '</td>';
+            $helptext = '';
+        }
+        echo '</tr>';
+    }
+}
+
+

admin/block.php

@@ -0,0 +1,76 @@
+<?php
+
+// block.php - allows admin to edit all local configuration variables for a block
+
+    require_once('../config.php');
+    require_once($CFG->libdir.'/adminlib.php');
+
+    $blockid = required_param('block', PARAM_INT);
+
+    if(!$blockrecord = blocks_get_record($blockid)) {
+        print_error('blockdoesnotexist', 'error');
+    }
+
+    admin_externalpage_setup('blocksetting'.$blockrecord->name);
+
+    $block = block_instance($blockrecord->name);
+    if($block === false) {
+        print_error('blockcannotinistantiate', 'error');
+    }
+
+    // Define the data we're going to silently include in the instance config form here,
+    // so we can strip them from the submitted data BEFORE handling it.
+    $hiddendata = array(
+        'block' => $blockid,
+        'sesskey' => sesskey()
+    );
+
+    /// If data submitted, then process and store.
+
+    if ($config = data_submitted()) {
+
+        if (!confirm_sesskey()) {
+             print_error('confirmsesskeybad', 'error');
+        }
+        if(!$block->has_config()) {
+            print_error('blockcannotconfig', 'error');
+        }
+        $remove = array_keys($hiddendata);
+        foreach($remove as $item) {
+            unset($config->$item);
+        }
+        $block->config_save($config);
+        redirect("$CFG->wwwroot/$CFG->admin/blocks.php", get_string("changessaved"), 1);
+        exit;
+    }
+
+    /// Otherwise print the form.
+
+    $strmanageblocks = get_string('manageblocks');
+    $strblockname = $block->get_title();
+
+    echo $OUTPUT->header();
+
+    echo $OUTPUT->heading($strblockname);
+
+    echo $OUTPUT->notification('This block still uses an old-style config_global.html file. ' .
+            'It must be updated by a developer to use a settings.php file.');
+
+    echo $OUTPUT->box(get_string('configwarning', 'admin'), 'generalbox boxwidthnormal boxaligncenter');
+    echo '<br />';
+
+    echo '<form method="post" action="block.php">';
+    echo '<p>';
+    foreach($hiddendata as $name => $val) {
+        echo '<input type="hidden" name="'. $name .'" value="'. $val .'" />';
+    }
+    echo '</p>';
+
+    echo $OUTPUT->box_start();
+    include($CFG->dirroot.'/blocks/'. $block->name() .'/config_global.html');
+    echo $OUTPUT->box_end();
+
+    echo '</form>';
+    echo $OUTPUT->footer();
+
+

admin/blocks.php

@@ -1,94 +1,259 @@
 <?php
-// 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 <http://www.gnu.org/licenses/>.
 
-/**
- * Allows the admin to configure blocks (hide/show, uninstall and configure)
- *
- * @package   core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
+    // Allows the admin to configure blocks (hide/show, delete and configure)
 
-require_once('../config.php');
-require_once("{$CFG->libdir}/adminlib.php");
-require_once("{$CFG->libdir}/blocklib.php");
-require_once("{$CFG->libdir}/tablelib.php");
+    require_once('../config.php');
+    require_once($CFG->libdir.'/adminlib.php');
+    require_once($CFG->libdir.'/tablelib.php');
 
-admin_externalpage_setup('manageblocks');
+    admin_externalpage_setup('manageblocks');
 
-$plugin = optional_param('plugin', '', PARAM_PLUGIN);
-$action = optional_param('action', '', PARAM_ALPHA);
-$unprotect = optional_param('unprotect', 0, PARAM_PLUGIN);
-$protect = optional_param('protect', 0, PARAM_PLUGIN);
+    $confirm  = optional_param('confirm', 0, PARAM_BOOL);
+    $hide     = optional_param('hide', 0, PARAM_INT);
+    $show     = optional_param('show', 0, PARAM_INT);
+    $delete   = optional_param('delete', 0, PARAM_INT);
+    $unprotect = optional_param('unprotect', 0, PARAM_INT);
+    $protect = optional_param('protect', 0, PARAM_INT);
 
-$strmanageblocks = get_string('manageblocks');
+/// Print headings
 
-// If data submitted, then process and store.
-if (!empty($plugin) && !empty($action) && confirm_sesskey()) {
-    $manager = \core_plugin_manager::resolve_plugininfo_class('block');
-    $pluginname = get_string('pluginname', "block_{$plugin}");
+    $strmanageblocks = get_string('manageblocks');
+    $strdelete = get_string('delete');
+    $strversion = get_string('version');
+    $strhide = get_string('hide');
+    $strshow = get_string('show');
+    $strsettings = get_string('settings');
+    $strcourses = get_string('blockinstances', 'admin');
+    $strname = get_string('name');
+    $strshowblockcourse = get_string('showblockcourse');
+    $strprotecthdr = get_string('blockprotect', 'admin'). $OUTPUT->help_icon('blockprotect','admin');
+    $strprotect = get_string('blockprotect', 'admin');
+    $strunprotect = get_string('blockunprotect', 'admin');
 
-    if ($action === 'disable' && $manager::enable_plugin($plugin, 0)) {
-        \core\notification::add(
-            get_string('plugin_disabled', 'core_admin', $pluginname),
-            \core\notification::SUCCESS
-        );
-        // Settings not required - only pages.
-        admin_get_root(true, false);
-    } else if ($action === 'enable' && $manager::enable_plugin($plugin, 1)) {
-        \core\notification::add(
-            get_string('plugin_enabled', 'core_admin', $pluginname),
-            \core\notification::SUCCESS
-        );
+/// If data submitted, then process and store.
 
-        // Settings not required - only pages.
-        admin_get_root(true, false);
+    if (!empty($hide) && confirm_sesskey()) {
+        if (!$block = $DB->get_record('block', array('id'=>$hide))) {
+            print_error('blockdoesnotexist', 'error');
+        }
+        $DB->set_field('block', 'visible', '0', array('id'=>$block->id));      // Hide block
+        admin_get_root(true, false);  // settings not required - only pages
     }
 
-    // Redirect back to the page with out any params.
-    redirect(new moodle_url('/admin/blocks.php'));
-}
+    if (!empty($show) && confirm_sesskey() ) {
+        if (!$block = $DB->get_record('block', array('id'=>$show))) {
+            print_error('blockdoesnotexist', 'error');
+        }
+        $DB->set_field('block', 'visible', '1', array('id'=>$block->id));      // Show block
+        admin_get_root(true, false);  // settings not required - only pages
+    }
 
-if (!empty($protect) && confirm_sesskey()) {
-    block_manager::protect_block($protect);
-    $pluginname = get_string('pluginname', "block_{$protect}");
-    \core\notification::add(
-        get_string('blockprotected', 'core_admin', $pluginname),
-        \core\notification::SUCCESS
-    );
-    // Settings not required - only pages.
-    admin_get_root(true, false);
-}
+    if (!isset($CFG->undeletableblocktypes) || (!is_array($CFG->undeletableblocktypes) && !is_string($CFG->undeletableblocktypes))) {
+        $undeletableblocktypes = array('navigation', 'settings');
+    } else if (is_string($CFG->undeletableblocktypes)) {
+        $undeletableblocktypes = explode(',', $CFG->undeletableblocktypes);
+    } else {
+        $undeletableblocktypes = $CFG->undeletableblocktypes;
+    }
 
-if (!empty($unprotect) && confirm_sesskey()) {
-    block_manager::unprotect_block($unprotect);
-    $pluginname = get_string('pluginname', "block_{$unprotect}");
-    \core\notification::add(
-        get_string('blockunprotected', 'core_admin', $pluginname),
-        \core\notification::SUCCESS
-    );
-    // Settings not required - only pages.
-    admin_get_root(true, false);
-}
+    if (!empty($protect) && confirm_sesskey()) {
+        if (!$block = $DB->get_record('block', array('id'=>$protect))) {
+            print_error('blockdoesnotexist', 'error');
+        }
+        if (!in_array($block->name, $undeletableblocktypes)) {
+            $undeletableblocktypes[] = $block->name;
+            set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
+        }
+        admin_get_root(true, false);  // settings not required - only pages
+    }
+
+    if (!empty($unprotect) && confirm_sesskey()) {
+        if (!$block = $DB->get_record('block', array('id'=>$unprotect))) {
+            print_error('blockdoesnotexist', 'error');
+        }
+        if (in_array($block->name, $undeletableblocktypes)) {
+            $undeletableblocktypes = array_diff($undeletableblocktypes, array($block->name));
+            set_config('undeletableblocktypes', implode(',', $undeletableblocktypes));
+        }
+        admin_get_root(true, false);  // settings not required - only pages
+    }
+
+    if (!empty($delete) && confirm_sesskey()) {
+        echo $OUTPUT->header();
+        echo $OUTPUT->heading($strmanageblocks);
+
+        if (!$block = blocks_get_record($delete)) {
+            print_error('blockdoesnotexist', 'error');
+        }
+
+        if (get_string_manager()->string_exists('pluginname', "block_$block->name")) {
+            $strblockname = get_string('pluginname', "block_$block->name");
+        } else {
+            $strblockname = $block->name;
+        }
+
+        if (!$confirm) {
+            echo $OUTPUT->confirm(get_string('blockdeleteconfirm', '', $strblockname), 'blocks.php?delete='.$block->id.'&confirm=1', 'blocks.php');
+            echo $OUTPUT->footer();
+            exit;
+
+        } else {
+            uninstall_plugin('block', $block->name);
+
+            $a = new stdClass();
+            $a->block = $strblockname;
+            $a->directory = $CFG->dirroot.'/blocks/'.$block->name;
+            notice(get_string('blockdeletefiles', '', $a), 'blocks.php');
+        }
+    }
+
+    echo $OUTPUT->header();
+    echo $OUTPUT->heading($strmanageblocks);
+
+/// Main display starts here
+
+/// Get and sort the existing blocks
+
+    if (!$blocks = $DB->get_records('block', array(), 'name ASC')) {
+        print_error('noblocks', 'error');  // Should never happen
+    }
+
+    $incompatible = array();
+
+/// Print the table of all blocks
+
+    $table = new flexible_table('admin-blocks-compatible');
+
+    $table->define_columns(array('name', 'instances', 'version', 'hideshow', 'undeletable', 'delete', 'settings'));
+    $table->define_headers(array($strname, $strcourses, $strversion, $strhide.'/'.$strshow, $strprotecthdr, $strdelete, $strsettings));
+    $table->define_baseurl($CFG->wwwroot.'/'.$CFG->admin.'/blocks.php');
+    $table->set_attribute('class', 'compatibleblockstable blockstable generaltable');
+    $table->setup();
+    $tablerows = array();
+
+    foreach ($blocks as $blockid=>$block) {
+        $blockname = $block->name;
+
+        if (!file_exists("$CFG->dirroot/blocks/$blockname/block_$blockname.php")) {
+            $blockobject  = false;
+            $strblockname = '<span class="notifyproblem">'.$blockname.' ('.get_string('missingfromdisk').')</span>';
+            $plugin = new stdClass();
+            $plugin->version = $block->version;
+
+        } else {
+            $plugin = new stdClass();
+            $plugin->version = '???';
+            if (file_exists("$CFG->dirroot/blocks/$blockname/version.php")) {
+                include("$CFG->dirroot/blocks/$blockname/version.php");
+            }
+
+            if (!$blockobject  = block_instance($block->name)) {
+                $incompatible[] = $block;
+                continue;
+            }
+            $strblockname = get_string('pluginname', 'block_'.$blockname);
+        }
+
+        $delete = '<a href="blocks.php?delete='.$blockid.'&amp;sesskey='.sesskey().'">'.$strdelete.'</a>';
+
+        $settings = ''; // By default, no configuration
+        if ($blockobject and $blockobject->has_config()) {
+            $blocksettings = admin_get_root()->locate('blocksetting' . $block->name);
+
+            if ($blocksettings instanceof admin_externalpage) {
+                $settings = '<a href="' . $blocksettings->url .  '">' . get_string('settings') . '</a>';
+            } else if ($blocksettings instanceof admin_settingpage) {
+                $settings = '<a href="'.$CFG->wwwroot.'/'.$CFG->admin.'/settings.php?section=blocksetting'.$block->name.'">'.$strsettings.'</a>';
+            } else {
+                $settings = '<a href="block.php?block='.$blockid.'">'.$strsettings.'</a>';
+            }
+        }
+
+        // MDL-11167, blocks can be placed on mymoodle, or the blogs page
+        // and it should not show up on course search page
+
+        $totalcount = $DB->count_records('block_instances', array('blockname'=>$blockname));
+        $count = $DB->count_records('block_instances', array('blockname'=>$blockname, 'pagetypepattern'=>'course-view-*'));
+
+        if ($count>0) {
+            $blocklist = "<a href=\"{$CFG->wwwroot}/course/search.php?blocklist=$blockid&amp;sesskey=".sesskey()."\" ";
+            $blocklist .= "title=\"$strshowblockcourse\" >$totalcount</a>";
+        }
+        else {
+            $blocklist = "$totalcount";
+        }
+        $class = ''; // Nothing fancy, by default
+
+        if (!$blockobject) {
+            // ignore
+            $visible = '';
+        } else if ($blocks[$blockid]->visible) {
+            $visible = '<a href="blocks.php?hide='.$blockid.'&amp;sesskey='.sesskey().'" title="'.$strhide.'">'.
+                       '<img src="'.$OUTPUT->pix_url('i/hide') . '" class="icon" alt="'.$strhide.'" /></a>';
+        } else {
+            $visible = '<a href="blocks.php?show='.$blockid.'&amp;sesskey='.sesskey().'" title="'.$strshow.'">'.
+                       '<img src="'.$OUTPUT->pix_url('i/show') . '" class="icon" alt="'.$strshow.'" /></a>';
+            $class = ' class="dimmed_text"'; // Leading space required!
+        }
+
+        if ($block->version == $plugin->version) {
+            $version = $block->version;
+        } else {
+            $version = "$block->version ($plugin->version)";
+        }
+
+        if (!$blockobject) {
+            // ignore
+            $undeletable = '';
+        } else if (in_array($blockname, $undeletableblocktypes)) {
+            $undeletable = '<a href="blocks.php?unprotect='.$blockid.'&amp;sesskey='.sesskey().'" title="'.$strunprotect.'">'.
+                       '<img src="'.$OUTPUT->pix_url('t/unlock') . '" class="icon" alt="'.$strunprotect.'" /></a>';
+        } else {
+            $undeletable = '<a href="blocks.php?protect='.$blockid.'&amp;sesskey='.sesskey().'" title="'.$strprotect.'">'.
+                       '<img src="'.$OUTPUT->pix_url('t/unlock_gray') . '" class="icon" alt="'.$strprotect.'" /></a>';
+        }
+
+        $row = array(
+            '<span'.$class.'>'.$strblockname.'</span>',
+            $blocklist,
+            '<span'.$class.'>'.$version.'</span>',
+            $visible,
+            $undeletable,
+            $delete,
+            $settings
+        );
+        $tablerows[] = array(strip_tags($strblockname), $row); // first element will be used for sorting
+    }
+
+    collatorlib::asort($tablerows);
+    foreach ($tablerows as $row) {
+        $table->add_data($row[1]);
+    }
+
+    $table->print_html();
+
+    if (!empty($incompatible)) {
+        echo $OUTPUT->heading(get_string('incompatibleblocks', 'blockstable', 'admin'));
+
+        $table = new flexible_table('admin-blocks-incompatible');
+
+        $table->define_columns(array('block', 'delete'));
+        $table->define_headers(array($strname, $strdelete));
+        $table->define_baseurl($CFG->wwwroot.'/'.$CFG->admin.'/blocks.php');
+
+        $table->set_attribute('class', 'incompatibleblockstable generaltable');
+
+        $table->setup();
+
+        foreach ($incompatible as $block) {
+            $table->add_data(array(
+                $block->name,
+                '<a href="blocks.php?delete='.$block->id.'&amp;sesskey='.sesskey().'">'.$strdelete.'</a>',
+            ));
+        }
+        $table->print_html();
+    }
+
+    echo $OUTPUT->footer();
 
-echo $OUTPUT->header();
-echo $OUTPUT->heading($strmanageblocks);
-echo $OUTPUT->notification(get_string('noteunneededblocks', 'admin'), 'info', false);
 
-// Print the table of all blocks.
-$table = new \core_admin\table\block_management_table();
-$table->out();
-echo $OUTPUT->footer();

admin/category.php

@@ -1,163 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This file is used to display a categories sub categories, external pages, and settings.
- *
- * @since      Moodle 2.3
- * @package    admin
- * @copyright  2011 Sam Hemelryk
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-require_once('../config.php');
-require_once($CFG->libdir.'/adminlib.php');
-
-$category = required_param('category', PARAM_SAFEDIR);
-$return = optional_param('return','', PARAM_ALPHA);
-$adminediting = optional_param('adminedit', -1, PARAM_BOOL);
-
-require_login(0, false);
-$PAGE->set_context(context_system::instance());
-$PAGE->set_url('/admin/category.php', array('category' => $category));
-$PAGE->set_pagetype('admin-setting-' . $category);
-$PAGE->set_pagelayout('admin');
-$PAGE->navigation->clear_cache();
-
-$adminroot = admin_get_root(); // need all settings
-$settingspage = $adminroot->locate($category, true);
-
-if (empty($settingspage) or !($settingspage instanceof admin_category)) {
-    throw new \moodle_exception('categoryerror', 'error', "$CFG->wwwroot/$CFG->admin/");
-}
-
-if (!($settingspage->check_access())) {
-    throw new \moodle_exception('accessdenied', 'admin');
-}
-
-$hassiteconfig = has_capability('moodle/site:config', $PAGE->context);
-if ($hassiteconfig) {
-    $PAGE->add_header_action($OUTPUT->render_from_template('core_admin/header_search_input', [
-        'action' => new moodle_url('/admin/search.php'),
-    ]));
-}
-
-$statusmsg = '';
-$errormsg  = '';
-
-if ($data = data_submitted() and confirm_sesskey()) {
-    $count = admin_write_settings($data);
-    if (empty($adminroot->errors)) {
-        // No errors. Did we change any setting?  If so, then indicate success.
-        if ($count) {
-            $statusmsg = get_string('changessaved');
-        } else {
-            switch ($return) {
-                case 'site': redirect("$CFG->wwwroot/");
-                case 'admin': redirect("$CFG->wwwroot/$CFG->admin/");
-            }
-        }
-    } else {
-        $errormsg = get_string('errorwithsettings', 'admin');
-        $firsterror = reset($adminroot->errors);
-    }
-    $settingspage = $adminroot->locate($category, true);
-}
-
-if ($PAGE->user_allowed_editing() && $adminediting != -1) {
-    $USER->editing = $adminediting;
-}
-$buttons = null;
-if ($PAGE->user_allowed_editing() && !$PAGE->theme->haseditswitch) {
-    $url = clone($PAGE->url);
-    if ($PAGE->user_is_editing()) {
-        $caption = get_string('blockseditoff');
-        $url->param('adminedit', 'off');
-    } else {
-        $caption = get_string('blocksediton');
-        $url->param('adminedit', 'on');
-    }
-    $buttons = $OUTPUT->single_button($url, $caption, 'get');
-}
-
-$savebutton = false;
-$outputhtml = '';
-foreach ($settingspage->children as $childpage) {
-    if ($childpage->is_hidden() || !$childpage->check_access()) {
-        continue;
-    }
-    if ($childpage instanceof admin_externalpage) {
-        $outputhtml .= $OUTPUT->heading(html_writer::link($childpage->url, $childpage->visiblename), 3);
-    } else if ($childpage instanceof admin_settingpage) {
-        $outputhtml .= $OUTPUT->heading(html_writer::link(new moodle_url('/'.$CFG->admin.'/settings.php', array('section' => $childpage->name)), $childpage->visiblename), 3);
-        // If its a settings page and has settings lets display them.
-        if (!empty($childpage->settings)) {
-            $outputhtml .= html_writer::start_tag('fieldset', array('class' => 'adminsettings'));
-            foreach ($childpage->settings as $setting) {
-                if (empty($setting->nosave)) {
-                    $savebutton = true;
-                }
-                $fullname = $setting->get_full_name();
-                if (array_key_exists($fullname, $adminroot->errors)) {
-                    $data = $adminroot->errors[$fullname]->data;
-                } else {
-                    $data = $setting->get_setting();
-                }
-                $outputhtml .= html_writer::tag('div', '<!-- -->', array('class' => 'clearer'));
-                $outputhtml .= $setting->output_html($data);
-            }
-            $outputhtml .= html_writer::end_tag('fieldset');
-        }
-    } else if ($childpage instanceof admin_category) {
-        $outputhtml .= $OUTPUT->heading(html_writer::link(new moodle_url('/'.$CFG->admin.'/category.php', array('category' => $childpage->name)), get_string('admincategory', 'admin', $childpage->visiblename)), 3);
-    }
-}
-if ($savebutton) {
-    $outputhtml .= html_writer::start_tag('div', array('class' => 'form-buttons'));
-    $outputhtml .= html_writer::empty_tag('input', array('class' => 'btn btn-primary form-submit', 'type' => 'submit', 'value' => get_string('savechanges','admin')));
-    $outputhtml .= html_writer::end_tag('div');
-}
-
-$PAGE->set_title(implode(moodle_page::TITLE_SEPARATOR, $settingspage->visiblepath));
-$PAGE->set_heading($SITE->fullname);
-if ($buttons) {
-    $PAGE->set_button($buttons);
-}
-
-echo $OUTPUT->header();
-
-if ($errormsg !== '') {
-    echo $OUTPUT->notification($errormsg);
-} else if ($statusmsg !== '') {
-    echo $OUTPUT->notification($statusmsg, 'notifysuccess');
-}
-
-echo $OUTPUT->heading(get_string('admincategory', 'admin', $settingspage->visiblename), 2);
-
-echo html_writer::start_tag('form', array('action' => '', 'method' => 'post', 'id' => 'adminsettings'));
-echo html_writer::start_tag('div');
-echo html_writer::input_hidden_params(new moodle_url($PAGE->url, array('sesskey' => sesskey(), 'return' => $return)));
-echo html_writer::end_tag('div');
-echo html_writer::start_tag('fieldset');
-echo html_writer::tag('div', '<!-- -->', array('class' => 'clearer'));
-echo $outputhtml;
-echo html_writer::end_tag('fieldset');
-echo html_writer::end_tag('form');
-
-// Add the form change checker.
-$PAGE->requires->js_call_amd('core_form/changechecker', 'watchFormById', ['adminsettings']);
-
-echo $OUTPUT->footer();

admin/classes/admin/admin_setting_plugin_manager.php

@@ -1,127 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\admin;
-
-use admin_setting;
-use core_plugin_manager;
-use core_text;
-
-/**
- * Admin setting plugin manager.
- *
- * @package    core_admin
- * @subpackage admin
- * @copyright  2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class admin_setting_plugin_manager extends admin_setting {
-    /** @var core_plugin_manager The plugin manager instance */
-    protected core_plugin_manager $pluginmanager;
-
-    /** @var string The plugintype that this manager covers */
-    protected string $plugintype;
-
-    /** @var string The class of the management table to use */
-    protected string $tableclass;
-
-    public function __construct(
-        string $plugintype,
-        string $tableclass,
-        string $name,
-        string $visiblename,
-        string $description = '',
-        string $defaultsetting = '',
-    ) {
-        $this->nosave = true;
-        $this->pluginmanager = core_plugin_manager::instance();
-        $this->plugintype = $plugintype;
-        $this->tableclass = $tableclass;
-
-        parent::__construct($name, $visiblename, $description, $defaultsetting);
-    }
-
-    /**
-     * Always returns true, does nothing
-     *
-     * @return true
-     */
-    public function get_setting(): bool {
-        return true;
-    }
-
-    /**
-     * Always returns true, does nothing
-     *
-     * @return true
-     */
-    public function get_defaultsetting(): bool {
-        return true;
-    }
-
-    /**
-     * Always returns '', does not write anything
-     *
-     * @return string Always returns ''
-     */
-    // phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-    public function write_setting($data): string {
-        // Do not write any setting.
-        return '';
-    }
-
-    /**
-     * Checks if $query is one of the available editors
-     *
-     * @param string $query The string to search for
-     * @return bool Returns true if found, false if not
-     */
-    public function is_related($query) {
-        if (parent::is_related($query)) {
-            return true;
-        }
-
-        $plugins = $this->pluginmanager->get_installed_plugins($this->plugintype);
-        foreach (array_keys($plugins) as $plugin) {
-            $plugin = "{$this->plugintype}_{$plugin}";
-            if (str_contains($plugin, $query)) {
-                return true;
-            }
-
-            $pluginname = get_string('pluginname', $plugin);
-            if (strpos(core_text::strtolower($pluginname), $query) !== false) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Builds the XHTML to display the control
-     *
-     * @param string $data Unused
-     * @param string $query
-     * @return string
-     */
-    public function output_html($data, $query = ''): string {
-        $table = new $this->tableclass();
-        if (!($table instanceof \core_admin\table\plugin_management_table)) {
-            throw new \coding_exception("{$this->tableclass} must be an instance of \\core_admin\\table\\plugin_management_table");
-        }
-        return highlight($query, $table->get_content());
-    }
-}

admin/classes/external/set_block_protection.php

@@ -1,97 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\external;
-
-use block_manager;
-use core_external\external_api;
-use core_external\external_function_parameters;
-use core_external\external_single_structure;
-use core_external\external_value;
-
-/**
- * Web Service to control the state of a plugin.
- *
- * @package   core_admin
- * @category  external
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class set_block_protection extends external_api {
-    /**
-     * Returns description of method parameters
-     *
-     * @return external_function_parameters
-     */
-    public static function execute_parameters(): external_function_parameters {
-        return new external_function_parameters([
-            'plugin' => new external_value(PARAM_PLUGIN, 'The name of the plugin', VALUE_REQUIRED),
-            'state' => new external_value(PARAM_INT, 'The target state', VALUE_REQUIRED),
-        ]);
-    }
-
-    /**
-     * Set the block protection state.
-     *
-     * @param string $plugin The name of the plugin
-     * @param int $state The target state
-     * @return null
-     */
-    public static function execute(
-        string $plugin,
-        int $state,
-    ): array {
-        [
-            'plugin' => $plugin,
-            'state' => $state,
-        ] = self::validate_parameters(self::execute_parameters(), [
-            'plugin' => $plugin,
-            'state' => $state,
-        ]);
-
-        $context = \context_system::instance();
-        self::validate_context($context);
-        require_capability('moodle/site:config', $context);
-
-        [, $pluginname] = explode('_', \core_component::normalize_componentname($plugin), 2);
-        $displayname = get_string('pluginname', $plugin);
-
-        if ($state) {
-            block_manager::protect_block($pluginname);
-            \core\notification::add(
-                get_string('blockprotected', 'core_admin', $displayname),
-                \core\notification::SUCCESS
-            );
-        } else {
-            block_manager::unprotect_block($pluginname);
-            \core\notification::add(
-                get_string('blockunprotected', 'core_admin', $displayname),
-                \core\notification::SUCCESS
-            );
-        }
-
-        return [];
-    }
-
-    /**
-     * Describe the return structure of the external service.
-     *
-     * @return external_single_structure
-     */
-    public static function execute_returns(): external_single_structure {
-        return new external_single_structure([]);
-    }
-}

admin/classes/external/set_plugin_order.php

@@ -1,84 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\external;
-
-use core_external\external_api;
-use core_external\external_function_parameters;
-use core_external\external_single_structure;
-use core_external\external_value;
-
-/**
- * Web Service to control the order of a plugin.
- *
- * @package   core_admin
- * @category  external
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class set_plugin_order extends external_api {
-    /**
-     * Returns description of method parameters
-     *
-     * @return external_function_parameters
-     */
-    public static function execute_parameters(): external_function_parameters {
-        return new external_function_parameters([
-            'plugin' => new external_value(PARAM_PLUGIN, 'The name of the plugin', VALUE_REQUIRED),
-            'direction' => new external_value(PARAM_INT, 'The direction to move', VALUE_REQUIRED),
-        ]);
-    }
-
-    /**
-     * Set the plugin state.
-     *
-     * @param string $plugin The name of the plugin
-     * @param int $direction The direction to move the plugin
-     * @return array
-     */
-    public static function execute(
-        string $plugin,
-        int $direction,
-    ): array {
-        [
-            'plugin' => $plugin,
-            'direction' => $direction,
-        ] = self::validate_parameters(self::execute_parameters(), [
-            'plugin' => $plugin,
-            'direction' => $direction,
-        ]);
-
-        $context = \context_system::instance();
-        self::validate_context($context);
-        require_capability('moodle/site:config', $context);
-
-        [$plugintype, $pluginname] = explode('_', \core_component::normalize_componentname($plugin), 2);
-
-        $manager = \core_plugin_manager::resolve_plugininfo_class($plugintype);
-        $manager::change_plugin_order($pluginname, $direction);
-
-        return [];
-    }
-
-    /**
-     * Describe the return structure of the external service.
-     *
-     * @return external_single_structure
-     */
-    public static function execute_returns(): external_single_structure {
-        return new external_single_structure([]);
-    }
-}

admin/classes/external/set_plugin_state.php

@@ -1,98 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\external;
-
-use core_external\external_api;
-use core_external\external_function_parameters;
-use core_external\external_single_structure;
-use core_external\external_value;
-
-/**
- * Web Service to control the state of a plugin.
- *
- * @package   core_admin
- * @category  external
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class set_plugin_state extends external_api {
-    /**
-     * Returns description of method parameters
-     *
-     * @return external_function_parameters
-     */
-    public static function execute_parameters(): external_function_parameters {
-        return new external_function_parameters([
-            'plugin' => new external_value(PARAM_PLUGIN, 'The name of the plugin', VALUE_REQUIRED),
-            'state' => new external_value(PARAM_INT, 'The target state', VALUE_REQUIRED),
-        ]);
-    }
-
-    /**
-     * Set the plugin state.
-     *
-     * @param string $plugin The name of the plugin
-     * @param int $state The target state
-     * @return null
-     */
-    public static function execute(
-        string $plugin,
-        int $state,
-    ): array {
-        [
-            'plugin' => $plugin,
-            'state' => $state,
-        ] = self::validate_parameters(self::execute_parameters(), [
-            'plugin' => $plugin,
-            'state' => $state,
-        ]);
-
-        $context = \context_system::instance();
-        self::validate_context($context);
-        require_capability('moodle/site:config', $context);
-
-        [$plugintype, $pluginname] = explode('_', \core_component::normalize_componentname($plugin), 2);
-
-        $manager = \core_plugin_manager::resolve_plugininfo_class($plugintype);
-        $displayname = get_string('pluginname', $plugin);
-
-        if ($manager::enable_plugin($pluginname, $state)) {
-            if (!empty($state)) {
-                \core\notification::add(
-                    get_string('plugin_enabled', 'core_admin', $displayname),
-                    \core\notification::SUCCESS
-                );
-            } else {
-                \core\notification::add(
-                    get_string('plugin_disabled', 'core_admin', $displayname),
-                    \core\notification::SUCCESS
-                );
-            }
-        }
-
-        return [];
-    }
-
-    /**
-     * Describe the return structure of the external service.
-     *
-     * @return external_single_structure
-     */
-    public static function execute_returns(): external_single_structure {
-        return new external_single_structure([]);
-    }
-}

admin/classes/form/purge_caches.php

@@ -1,76 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Form for selective purging of caches.
- *
- * @package    core
- * @copyright  2018 The Open University
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\form;
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->libdir.'/formslib.php');
-
-/**
- * Form for selecting which caches to purge on admin/purgecaches.php
- *
- * @package   core
- * @copyright 2018 The Open University
- * @author    Mark Johnson <mark.johnson@open.ac.uk>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class purge_caches extends \moodleform {
-    /**
-     * Define a "Purge all caches" button, and a fieldset with checkboxes for selectively purging separate caches.
-     */
-    public function definition() {
-        $mform = $this->_form;
-        $mform->addElement('hidden', 'returnurl', $this->_customdata['returnurl']);
-        $mform->setType('returnurl', PARAM_LOCALURL);
-        $mform->addElement('submit', 'all', get_string('purgecaches', 'admin'));
-        $mform->addElement('header', 'purgecacheheader', get_string('purgeselectedcaches', 'admin'));
-        $checkboxes = [
-            $mform->createElement('advcheckbox', 'theme', '', get_string('purgethemecache', 'admin')),
-            $mform->createElement('advcheckbox', 'lang', '', get_string('purgelangcache', 'admin')),
-            $mform->createElement('advcheckbox', 'js', '', get_string('purgejscache', 'admin')),
-            $mform->createElement('advcheckbox', 'template', '', get_string('purgetemplates', 'admin')),
-            $mform->createElement('advcheckbox', 'filter', '', get_string('purgefiltercache', 'admin')),
-            $mform->createElement('advcheckbox', 'muc', '', get_string('purgemuc', 'admin')),
-            $mform->createElement('advcheckbox', 'other', '', get_string('purgeothercaches', 'admin'))
-        ];
-        $mform->addGroup($checkboxes, 'purgeselectedoptions');
-        $mform->addElement('submit', 'purgeselectedcaches', get_string('purgeselectedcaches', 'admin'));
-    }
-
-    /**
-     * If the "Purge selected caches" button was pressed, ensure at least one cache was selected.
-     *
-     * @param array $data
-     * @param array $files
-     * @return array Error messages
-     */
-    public function validation($data, $files) {
-        $errors = [];
-        if (isset($data['purgeselectedcaches']) && empty(array_filter($data['purgeselectedoptions']))) {
-            $errors['purgeselectedoptions'] = get_string('purgecachesnoneselected', 'admin');
-        }
-        return $errors;
-    }
-}

admin/classes/form/testoutgoingmailconf_form.php

@@ -1,92 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Testing outgoing mail configuration form
- *
- * @package    core
- * @copyright  2019 Victor Deniz <victor@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\form;
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->libdir.'/formslib.php');
-
-/**
- * Test mail form
- *
- * @package    core
- * @copyright 2019 Victor Deniz <victor@moodle.com>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class testoutgoingmailconf_form extends \moodleform {
-    /**
-     * Add elements to form
-     */
-    public function definition() {
-        $mform = $this->_form;
-
-        // Recipient.
-        $options = ['maxlength' => '100', 'size' => '25', 'autocomplete' => 'email'];
-        $mform->addElement('text', 'recipient', get_string('testoutgoingmailconf_toemail', 'admin'), $options);
-        $mform->setType('recipient', PARAM_EMAIL);
-        $mform->addRule('recipient', get_string('required'), 'required');
-
-        // From user.
-        $options = ['maxlength' => '100', 'size' => '25'];
-        $mform->addElement('text', 'from', get_string('testoutgoingmailconf_fromemail', 'admin'), $options);
-        $mform->setType('from', PARAM_TEXT);
-        $mform->addHelpButton('from', 'testoutgoingmailconf_fromemail', 'admin');
-
-        // Additional subject text.
-        $options = ['size' => '25'];
-        $mform->addElement('text', 'additionalsubject', get_string('testoutgoingmailconf_subjectadditional', 'admin'), $options);
-        $mform->setType('additionalsubject', PARAM_TEXT);
-
-        $buttonarray = array();
-        $buttonarray[] = $mform->createElement('submit', 'send', get_string('testoutgoingmailconf_sendtest', 'admin'));
-        $buttonarray[] = $mform->createElement('cancel');
-
-        $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
-        $mform->closeHeaderBefore('buttonar');
-
-    }
-
-    /**
-     * Validate Form field, should be a valid email format or a username that matches with a Moodle user.
-     *
-     * @param array $data
-     * @param array $files
-     * @return array
-     * @throws \dml_exception|\coding_exception
-     */
-    public function validation($data, $files): array {
-        $errors = parent::validation($data, $files);
-
-        if (isset($data['from']) && $data['from']) {
-            $userfrom = \core_user::get_user_by_username($data['from']);
-
-            if (!$userfrom && !validate_email($data['from'])) {
-                $errors['from'] = get_string('testoutgoingmailconf_fromemail_invalid', 'admin');
-            }
-        }
-
-        return $errors;
-    }
-}

admin/classes/local/externalpage/accesscallback.php

@@ -1,71 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * External admin page class that allows a callback to be provided to determine whether page can be accessed
- *
- * @package     core_admin
- * @copyright   2019 Marina Glancy
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\local\externalpage;
-
-use admin_externalpage;
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once("{$CFG->libdir}/adminlib.php");
-
-/**
- * Admin externalpage class
- *
- * @package     core_admin
- * @copyright   2019 Marina Glancy
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class accesscallback extends admin_externalpage {
-
-    /** @var callable $accesscheckcallback */
-    protected $accesscheckcallback;
-
-    /**
-     * Class constructor
-     *
-     * @param string $name
-     * @param string $visiblename
-     * @param string $url
-     * @param callable $accesscheckcallback The callback method that will be executed to check whether user has access to
-     *     this page. The setting instance ($this) is passed as an argument to the callback. Should return boolean value
-     * @param bool $hidden
-     */
-    public function __construct(string $name, string $visiblename, string $url, callable $accesscheckcallback,
-            bool $hidden = false) {
-
-        $this->accesscheckcallback = $accesscheckcallback;
-
-        parent::__construct($name, $visiblename, $url, [], $hidden);
-    }
-
-    /**
-     * Determines if the current user has access to this external page based on access callback
-     *
-     * @return bool
-     */
-    public function check_access() {
-        return ($this->accesscheckcallback)($this);
-    }
-}

admin/classes/local/settings/autocomplete.php

@@ -1,206 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Auto complete admin setting.
- *
- * @package    core_admin
- * @copyright  2020 The Open University
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\local\settings;
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->libdir . '/adminlib.php');
-/**
- * Auto complete setting class.
- *
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @copyright 2020 The Open University
- */
-class autocomplete extends \admin_setting_configmultiselect {
-    /** @var boolean Should we allow typing new entries to the field? */
-    protected $tags = false;
-    /** @var string Name of an AMD module to send/process ajax requests. */
-    protected $ajax = '';
-    /** @var string Placeholder text for an empty list. */
-    protected $placeholder = '';
-    /** @var bool Whether the search has to be case-sensitive. */
-    protected $casesensitive = false;
-    /** @var bool Show suggestions by default - but this can be turned off. */
-    protected $showsuggestions = true;
-    /** @var string String that is shown when there are no selections. */
-    protected $noselectionstring = '';
-    /** @var string Delimiter to store values in database. */
-    protected $delimiter = ',';
-    /** @var string Should be multiple choices? */
-    protected $multiple = true;
-    /** @var string The link to manage choices. */
-    protected $manageurl = true;
-    /** @var string The text to display in manage link. */
-    protected $managetext = true;
-
-    /**
-     * Constructor
-     *
-     * @param string $name unique ascii name, either 'mysetting' for settings that in config, or 'myplugin/mysetting'
-     * for ones in config_plugins.
-     * @param string $visiblename localised
-     * @param string $description long localised info
-     * @param array $defaultsetting array of selected items
-     * @param array $choices options for autocomplete field
-     * @param array $attributes settings for autocomplete field
-     */
-    public function __construct($name, $visiblename, $description, $defaultsetting, $choices, $attributes = null) {
-
-        if ($attributes === null) {
-            $attributes = [];
-        }
-
-        $this->placeholder = get_string('search');
-        $this->noselectionstring = get_string('noselection', 'form');
-        $defaultattributes = [
-                'tags',
-                'showsuggestions',
-                'placeholder',
-                'noselectionstring',
-                'ajax',
-                'casesensitive',
-                'delimiter',
-                'multiple',
-                'manageurl',
-                'managetext'
-        ];
-
-        foreach ($defaultattributes as $attributename) {
-            if (isset($attributes[$attributename])) {
-                $this->$attributename = $attributes[$attributename];
-            }
-        }
-
-        parent::__construct($name, $visiblename, $description, $defaultsetting, $choices);
-    }
-
-    /**
-     * Returns the select setting(s)
-     *
-     * @return mixed null or array. Null if no settings else array of setting(s)
-     */
-    public function get_setting() {
-        $result = $this->config_read($this->name);
-        if (is_null($result)) {
-            return null;
-        }
-        if ($result === '') {
-            return [];
-        }
-        return explode($this->delimiter, $result);
-    }
-
-    /**
-     * Saves setting(s) provided through $data
-     *
-     * @param array $data
-     */
-    public function write_setting($data) {
-        if (!is_array($data)) {
-            return ''; // Ignore it.
-        }
-        if (!$this->load_choices() || empty($this->choices)) {
-            return '';
-        }
-
-        unset($data['xxxxx']);
-
-        $save = [];
-        foreach ($data as $value) {
-            if (!array_key_exists($value, $this->choices)) {
-                continue; // Ignore it.
-            }
-            $save[] = $value;
-        }
-
-        return ($this->config_write($this->name, implode($this->delimiter, $save)) ? '' : get_string('errorsetting', 'admin'));
-    }
-
-    /**
-     * Returns XHTML autocomplete field
-     *
-     * @param array $data Array of values to select by default
-     * @param string $query
-     * @return string XHTML autocomplete field
-     */
-    public function output_html($data, $query = '') {
-        global $OUTPUT;
-
-        if (!$this->load_choices() or empty($this->choices)) {
-            return '';
-        }
-
-        $default = $this->get_defaultsetting();
-        if (empty($default)) {
-            $default = [];
-        }
-
-        if (is_null($data)) {
-            $data = [];
-        }
-
-        $context = [
-                'id' => $this->get_id(),
-                'name' => $this->get_full_name()
-        ];
-
-        $defaults = [];
-        $options = [];
-        $template = 'core_admin/local/settings/autocomplete';
-
-        foreach ($this->choices as $value => $name) {
-            if (in_array($value, $default)) {
-                $defaults[] = $name;
-            }
-            $options[] = [
-                    'value' => $value,
-                    'text' => $name,
-                    'selected' => in_array($value, $data),
-                    'disabled' => false
-            ];
-        }
-
-        $context['options'] = $options;
-        $context['tags'] = $this->tags;
-        $context['placeholder'] = $this->placeholder;
-        $context['casesensitive'] = $this->casesensitive;
-        $context['multiple'] = $this->multiple;
-        $context['showsuggestions'] = $this->showsuggestions;
-        $context['manageurl'] = $this->manageurl;
-        $context['managetext'] = $this->managetext;
-
-        if (is_null($default)) {
-            $defaultinfo = null;
-        } if (!empty($defaults)) {
-            $defaultinfo = implode(', ', $defaults);
-        } else {
-            $defaultinfo = get_string('none');
-        }
-
-        $element = $OUTPUT->render_from_template($template, $context);
-
-        return format_admin_setting($this, $this->visiblename, $element, $this->description, true, '', $defaultinfo, $query);
-    }
-}

admin/classes/local/settings/filesize.php

@@ -1,197 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * File size admin setting.
- *
- * @package    core_admin
- * @copyright  2019 Shamim Rezaie <shamim@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\local\settings;
-
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->libdir . '/adminlib.php');
-
-/**
- * An admin setting to support entering and displaying of file sizes in Bytes, KB, MB or GB.
- *
- * @copyright   2019 Shamim Rezaie <shamim@moodle.com>
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class filesize extends \admin_setting {
-
-    /** @var int The byte unit. Number of bytes in a byte */
-    const UNIT_B = 1;
-
-    /** @var int The kilobyte unit (number of bytes in a kilobyte) */
-    const UNIT_KB = 1024;
-
-    /** @var int The megabyte unit (number of bytes in a megabyte) */
-    const UNIT_MB = 1048576;
-
-    /** @var int The gigabyte unit (number of bytes in a gigabyte) */
-    const UNIT_GB = 1073741824;
-
-    /** @var int default size unit */
-    protected $defaultunit;
-
-    /**
-     * Constructor
-     *
-     * @param string    $name           unique ascii name, either 'mysetting' for settings that in config,
-     *                                  or 'myplugin/mysetting' for ones in config_plugins.
-     * @param string    $visiblename    localised name
-     * @param string    $description    localised long description
-     * @param int|null  $defaultvalue   Value of the settings in bytes
-     * @param int|null  $defaultunit    GB, MB, etc. (in bytes)
-     */
-    public function __construct(string $name, string $visiblename, string $description,
-            int $defaultvalue = null, int $defaultunit = null) {
-
-        $defaultsetting = self::parse_bytes($defaultvalue);
-
-        if ($defaultunit && array_key_exists($defaultunit, self::get_units())) {
-            $this->defaultunit = $defaultunit;
-        } else {
-            $this->defaultunit = self::UNIT_MB;
-        }
-        parent::__construct($name, $visiblename, $description, $defaultsetting);
-    }
-
-    /**
-     * Returns selectable units.
-     *
-     * @return  array
-     */
-    protected static function get_units(): array {
-        return [
-            self::UNIT_GB => get_string('sizegb'),
-            self::UNIT_MB => get_string('sizemb'),
-            self::UNIT_KB => get_string('sizekb'),
-            self::UNIT_B  => get_string('sizeb'),
-        ];
-    }
-
-    /**
-     * Converts bytes to some more user friendly string.
-     *
-     * @param   int     $bytes  The number of bytes we want to convert from
-     * @return  string
-     */
-    protected static function get_size_text(int $bytes): string {
-        if (empty($bytes)) {
-            return get_string('none');
-        }
-        return display_size($bytes, 0);
-    }
-
-    /**
-     * Finds suitable units for given file size.
-     *
-     * @param   int     $bytes  The number of bytes
-     * @return  array           Parsed file size in the format of ['v' => value, 'u' => unit]
-     */
-    protected static function parse_bytes(int $bytes): array {
-        foreach (self::get_units() as $unit => $unused) {
-            if ($bytes % $unit === 0) {
-                return ['v' => (int)($bytes / $unit), 'u' => $unit];
-            }
-        }
-        return ['v' => (int)$bytes, 'u' => self::UNIT_B];
-    }
-
-    /**
-     * Get the selected file size as array.
-     *
-     * @return  array|null  An array containing 'v' => xx, 'u' => xx, or null if not set
-     */
-    public function get_setting(): ?array {
-        $bytes = $this->config_read($this->name);
-        if (is_null($bytes)) {
-            return null;
-        }
-        $bytes = intval($bytes);
-
-        return self::parse_bytes($bytes);
-    }
-
-    /**
-     * Store the file size as bytes.
-     *
-     * @param   array   $data   Must be form 'h' => xx, 'm' => xx
-     * @return  string          The error string if any
-     */
-    public function write_setting($data): string {
-        if (!is_array($data)) {
-            return '';
-        }
-
-        if (!is_numeric($data['v']) || $data['v'] < 0) {
-            return get_string('errorsetting', 'admin');
-        }
-
-        // Calculate size in bytes, ensuring we don't overflow PHP_INT_MAX.
-        $bytes = $data['v'] * $data['u'];
-        $result = (is_int($bytes) && $this->config_write($this->name, $bytes));
-
-        return ($result ? '' : get_string('errorsetting', 'admin'));
-    }
-
-    /**
-     * Returns file size text+select fields.
-     *
-     * @param   array   $data   The current setting value. Must be form 'v' => xx, 'u' => xx.
-     * @param   string  $query  Admin search query to be highlighted.
-     * @return  string          File size text+select fields and wrapping div(s).
-     */
-    public function output_html($data, $query = ''): string {
-        global $OUTPUT;
-
-        $default = $this->get_defaultsetting();
-        if (is_number($default)) {
-            $defaultinfo = self::get_size_text($default);
-        } else if (is_array($default)) {
-            $defaultinfo = self::get_size_text($default['v'] * $default['u']);
-        } else {
-            $defaultinfo = null;
-        }
-
-        $inputid = $this->get_id() . 'v';
-        $units = self::get_units();
-        $defaultunit = $this->defaultunit;
-
-        $context = (object) [
-            'id' => $this->get_id(),
-            'name' => $this->get_full_name(),
-            'value' => $data['v'],
-            'readonly' => $this->is_readonly(),
-            'options' => array_map(function($unit, $title) use ($data, $defaultunit) {
-                return [
-                    'value' => $unit,
-                    'name' => $title,
-                    'selected' => ($data['v'] == 0 && $unit == $defaultunit) || $unit == $data['u']
-                ];
-            }, array_keys($units), $units)
-        ];
-
-        $element = $OUTPUT->render_from_template('core_admin/setting_configfilesize', $context);
-
-        return format_admin_setting($this, $this->visiblename, $element, $this->description, $inputid, '', $defaultinfo, $query);
-    }
-}

admin/classes/local/settings/linkable_settings_page.php

@@ -1,37 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * A settings page which can be viewed with a link directly.
- *
- * @package    core_admin
- * @copyright  2021 Andrew Lyons <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\local\settings;
-
-use moodle_url;
-
-interface linkable_settings_page {
-
-    /**
-     * Get the URL to view this settings page.
-     *
-     * @return moodle_url
-     */
-    public function get_settings_page_url(): moodle_url;
-}

admin/classes/local/settings/manage_payment_gateway_plugins.php

@@ -1,74 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Payment gateway admin setting.
- *
- * @package    core_admin
- * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-namespace core_admin\local\settings;
-
-/**
- * Generic class for managing plugins in a table that allows re-ordering and enable/disable of each plugin.
- */
-class manage_payment_gateway_plugins extends \admin_setting_manage_plugins {
-    /**
-     * Get the admin settings section title (use get_string).
-     *
-     * @return string
-     */
-    public function get_section_title() {
-        return get_string('type_paygw_plural', 'plugin');
-    }
-
-    /**
-     * Get the type of plugin to manage.
-     *
-     * @return string
-     */
-    public function get_plugin_type() {
-        return 'paygw';
-    }
-
-    /**
-     * Get the name of the second column.
-     *
-     * @return string
-     */
-    public function get_info_column_name() {
-        return get_string('supportedcurrencies', 'core_payment');
-    }
-
-    /**
-     * Get the type of plugin to manage.
-     *
-     * @param plugininfo The plugin info class.
-     * @return string
-     */
-    public function get_info_column($plugininfo) {
-        $codes = $plugininfo->get_supported_currencies();
-
-        $currencies = [];
-        foreach ($codes as $c) {
-            $currencies[$c] = new \lang_string($c, 'core_currencies');
-        }
-
-        return implode(get_string('listsep', 'langconfig') . ' ', $currencies);
-    }
-}

admin/classes/local/settings/setting_scheduled_task_status.php

@@ -1,121 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Admin setting to show current scheduled task's status.
- *
- * @package core
- * @copyright 2021 Universitat Rovira i Virgili
- * @author Jordi Pujol-Ahulló <jpahullo@gmail.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-namespace core_admin\local\settings;
-
-defined('MOODLE_INTERNAL') || die();
-
-global $CFG;
-require_once($CFG->libdir . '/adminlib.php');
-require_once($CFG->libdir . '/moodlelib.php');
-
-use admin_setting_description;
-use core\task\manager;
-use core\task\scheduled_task;
-use html_writer;
-use lang_string;
-use moodle_url;
-use stdClass;
-
-/**
- * This admin setting tells whether a given scheduled task is enabled, providing a link to its configuration page.
- *
- * The goal of this setting is to help contextualizing the configuration settings with related scheduled task status,
- * providing the big picture of that part of the system.
- *
- * @package core
- * @copyright 2021 Universitat Rovira i Virgili
- * @author Jordi Pujol-Ahulló <jpahullo@gmail.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class setting_scheduled_task_status extends admin_setting_description {
-    /**
-     * @var string fully qualified class name of a scheduled task.
-     */
-    private $classname;
-    /**
-     * @var string additional text to append to the description.
-     */
-    private $extradescription;
-
-    /**
-     * setting_scheduled_task_status constructor.
-     * @param string $name unique setting name.
-     * @param string $scheduledtaskclassname full classpath class name of the scheduled task.
-     * @param string $extradescription extra detail to append to the scheduled task status to add context in the setting
-     * page.
-     */
-    public function __construct(string $name, string $scheduledtaskclassname, string $extradescription = '') {
-        $visiblename = new lang_string('task_status', 'admin');
-        $this->classname = $scheduledtaskclassname;
-        $this->extradescription = $extradescription;
-
-        parent::__construct($name, $visiblename, '');
-    }
-
-    /**
-     * Calculates lazily the content of the description.
-     * @param mixed $data nothing expected in this case.
-     * @param string $query nothing expected in this case.
-     * @return string the HTML content to print for this setting.
-     */
-    public function output_html($data, $query = ''): string {
-        if (empty($this->description)) {
-            $this->description = $this->get_task_description();
-        }
-
-        return parent::output_html($data, $query);
-    }
-
-    /**
-     * Returns the HTML to print as the description.
-     * @return string description to be printed.
-     */
-    private function get_task_description(): string {
-        $task = manager::get_scheduled_task($this->classname);
-        if ($task->is_enabled()) {
-            $taskenabled = get_string('enabled', 'admin');
-        } else {
-            $taskenabled = get_string('disabled', 'admin');
-        }
-        $taskenabled = strtolower($taskenabled);
-        $gotourl = new moodle_url(
-            '/admin/tool/task/scheduledtasks.php',
-            [],
-            scheduled_task::get_html_id($this->classname)
-        );
-        if (!empty($this->extradescription)) {
-            $this->extradescription = '<br />' . $this->extradescription;
-        }
-
-        $taskdetail = new stdClass();
-        $taskdetail->class = $this->classname;
-        $taskdetail->name = $task->get_name();
-        $taskdetail->status = $taskenabled;
-        $taskdetail->gotourl = $gotourl->out(false);
-        $taskdetail->extradescription = $this->extradescription;
-
-        return html_writer::tag('p', get_string('task_status_desc', 'admin', $taskdetail));
-    }
-}

admin/classes/privacy/provider.php

@@ -1,41 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-/**
- * Privacy Subsystem implementation for core_admin.
- *
- * @package    core_admin
- * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-namespace core_admin\privacy;
-defined('MOODLE_INTERNAL') || die();
-/**
- * Privacy Subsystem for core_admin implementing null_provider.
- *
- * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class provider implements \core_privacy\local\metadata\null_provider {
-    /**
-     * Get the language string identifier with the component's language
-     * file to explain why this plugin stores no data.
-     *
-     * @return  string
-     */
-    public static function get_reason() : string {
-        return 'privacy:metadata';
-    }
-}

admin/classes/reportbuilder/datasource/task_logs.php

@@ -1,117 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-declare(strict_types=1);
-
-namespace core_admin\reportbuilder\datasource;
-
-use core_admin\reportbuilder\local\entities\task_log;
-use core_reportbuilder\datasource;
-use core_reportbuilder\local\entities\user;
-use core_reportbuilder\local\filters\select;
-
-/**
- * Task logs datasource
- *
- * @package     core_admin
- * @copyright   2022 Paul Holden <paulh@moodle.com>
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class task_logs extends datasource {
-
-    /**
-     * Return user friendly name of the report source
-     *
-     * @return string
-     */
-    public static function get_name(): string {
-        return get_string('tasklogs', 'core_admin');
-    }
-
-    /**
-     * Initialise report
-     */
-    protected function initialise(): void {
-        $tasklogentity = new task_log();
-
-        $tasklogalias = $tasklogentity->get_table_alias('task_log');
-        $this->set_main_table('task_log', $tasklogalias);
-
-        $this->add_entity($tasklogentity);
-
-        // Join the user entity to represent the associated user.
-        $userentity = new user();
-        $useralias = $userentity->get_table_alias('user');
-        $this->add_entity($userentity->add_join("
-            LEFT JOIN {user} {$useralias}
-                   ON {$useralias}.id = {$tasklogalias}.userid")
-        );
-
-        // Add report elements from each of the entities we added to the report.
-        $this->add_all_from_entities();
-    }
-
-    /**
-     * Return the columns that will be added to the report upon creation
-     *
-     * @return string[]
-     */
-    public function get_default_columns(): array {
-        return [
-            'task_log:name',
-            'task_log:starttime',
-            'task_log:duration',
-            'task_log:result',
-        ];
-    }
-
-    /**
-     * Return the filters that will be added to the report upon creation
-     *
-     * @return string[]
-     */
-    public function get_default_filters(): array {
-        return [
-            'task_log:timestart',
-            'task_log:result',
-        ];
-    }
-
-    /**
-     * Return the conditions that will be added to the report upon creation
-     *
-     * @return string[]
-     */
-    public function get_default_conditions(): array {
-        return [
-            'task_log:type',
-            'task_log:timestart',
-            'task_log:result',
-        ];
-    }
-
-    /**
-     * Return the condition values that will be set for the report upon creation
-     *
-     * @return array
-     */
-    public function get_default_condition_values(): array {
-        return [
-            'task_log:type_operator' => select::EQUAL_TO,
-            'task_log:type_value' => \core\task\database_logger::TYPE_SCHEDULED,
-        ];
-    }
-}

admin/classes/reportbuilder/local/entities/task_log.php

@@ -1,427 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\reportbuilder\local\entities;
-
-use core_reportbuilder\local\filters\date;
-use core_reportbuilder\local\filters\duration;
-use core_reportbuilder\local\filters\number;
-use core_reportbuilder\local\filters\select;
-use core_reportbuilder\local\filters\text;
-use core_reportbuilder\local\filters\autocomplete;
-use core_reportbuilder\local\helpers\format;
-use lang_string;
-use core_reportbuilder\local\entities\base;
-use core_reportbuilder\local\report\column;
-use core_reportbuilder\local\report\filter;
-use stdClass;
-use core_collator;
-
-/**
- * Task log entity class implementation
- *
- * @package    core_admin
- * @copyright  2021 David Matamoros <davidmc@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class task_log extends base {
-
-    /** @var int Result success */
-    protected const SUCCESS = 0;
-
-    /** @var int Result failed */
-    protected const FAILED = 1;
-
-    /**
-     * Database tables that this entity uses and their default aliases
-     *
-     * @return array
-     */
-    protected function get_default_table_aliases(): array {
-        return ['task_log' => 'tl'];
-    }
-
-    /**
-     * The default title for this entity in the list of columns/conditions/filters in the report builder
-     *
-     * @return lang_string
-     */
-    protected function get_default_entity_title(): lang_string {
-        return new lang_string('entitytasklog', 'admin');
-    }
-
-    /**
-     * Initialise the entity
-     *
-     * @return base
-     */
-    public function initialise(): base {
-        $columns = $this->get_all_columns();
-        foreach ($columns as $column) {
-            $this->add_column($column);
-        }
-
-        // All the filters defined by the entity can also be used as conditions.
-        $filters = $this->get_all_filters();
-        foreach ($filters as $filter) {
-            $this
-                ->add_filter($filter)
-                ->add_condition($filter);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Returns list of all available columns
-     *
-     * @return column[]
-     */
-    protected function get_all_columns(): array {
-        global $DB;
-
-        $tablealias = $this->get_table_alias('task_log');
-
-        // Name column.
-        $columns[] = (new column(
-            'name',
-            new lang_string('name'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TEXT)
-            ->add_field("$tablealias.classname")
-            ->set_is_sortable(true)
-            ->add_callback(static function(string $classname): string {
-                $output = '';
-                if (class_exists($classname)) {
-                    $task = new $classname;
-                    if ($task instanceof \core\task\task_base) {
-                        $output = $task->get_name();
-                    }
-                }
-                $output .= \html_writer::tag('div', "\\{$classname}", [
-                    'class' => 'small text-muted',
-                ]);
-                return $output;
-            });
-
-        // Component column.
-        $columns[] = (new column(
-            'component',
-            new lang_string('plugin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TEXT)
-            ->add_field("{$tablealias}.component")
-            ->set_is_sortable(true);
-
-        // Type column.
-        $columns[] = (new column(
-            'type',
-            new lang_string('tasktype', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TEXT)
-            ->add_field("{$tablealias}.type")
-            ->set_is_sortable(true)
-            ->add_callback(static function($value): string {
-                if (\core\task\database_logger::TYPE_SCHEDULED === (int) $value) {
-                    return get_string('task_type:scheduled', 'admin');
-                }
-                return get_string('task_type:adhoc', 'admin');
-            });
-
-        // Start time column.
-        $columns[] = (new column(
-            'starttime',
-            new lang_string('task_starttime', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TIMESTAMP)
-            ->add_field("{$tablealias}.timestart")
-            ->set_is_sortable(true)
-            ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
-
-        // End time column.
-        $columns[] = (new column(
-            'endtime',
-            new lang_string('task_endtime', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TIMESTAMP)
-            ->add_field("{$tablealias}.timeend")
-            ->set_is_sortable(true)
-            ->add_callback([format::class, 'userdate'], get_string('strftimedatetimeshortaccurate', 'core_langconfig'));
-
-        // Duration column.
-        $columns[] = (new column(
-            'duration',
-            new lang_string('task_duration', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_FLOAT)
-            ->add_field("{$tablealias}.timeend - {$tablealias}.timestart", 'duration')
-            ->set_is_sortable(true)
-            ->add_callback(static function(float $value): string {
-                $duration = round($value, 2);
-                if (empty($duration)) {
-                    // The format_time function returns 'now' when the difference is exactly 0.
-                    // Note: format_time performs concatenation in exactly this fashion so we should do this for consistency.
-                    return '0 ' . get_string('secs', 'moodle');
-                }
-                return format_time($duration);
-            });
-
-        // Hostname column.
-        $columns[] = (new column(
-            'hostname',
-            new lang_string('hostname', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_TEXT)
-            ->add_field("$tablealias.hostname")
-            ->set_is_sortable(true);
-
-        // PID column.
-        $columns[] = (new column(
-            'pid',
-            new lang_string('pid', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
-            ->add_field("{$tablealias}.pid")
-            ->set_is_sortable(true)
-            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
-            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
-
-        // Database column.
-        $columns[] = (new column(
-            'database',
-            new lang_string('task_dbstats', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
-            ->add_fields("{$tablealias}.dbreads, {$tablealias}.dbwrites")
-            ->set_is_sortable(true, ["{$tablealias}.dbreads", "{$tablealias}.dbwrites"])
-            ->add_callback(static function(int $value, stdClass $row): string {
-                $output = '';
-                $output .= \html_writer::div(get_string('task_stats:dbreads', 'admin', $row->dbreads));
-                $output .= \html_writer::div(get_string('task_stats:dbwrites', 'admin', $row->dbwrites));
-                return $output;
-            })
-            // Although this is an integer column, it doesn't make sense to perform numeric aggregation on it.
-            ->set_disabled_aggregation(['avg', 'count', 'countdistinct', 'max', 'min', 'sum']);
-
-        // Database reads column.
-        $columns[] = (new column(
-            'dbreads',
-            new lang_string('task_dbreads', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
-            ->add_fields("{$tablealias}.dbreads")
-            ->set_is_sortable(true);
-
-        // Database writes column.
-        $columns[] = (new column(
-            'dbwrites',
-            new lang_string('task_dbwrites', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_INTEGER)
-            ->add_fields("{$tablealias}.dbwrites")
-            ->set_is_sortable(true);
-
-        // Result column.
-        $columns[] = (new column(
-            'result',
-            new lang_string('task_result', 'admin'),
-            $this->get_entity_name()
-        ))
-            ->add_joins($this->get_joins())
-            ->set_type(column::TYPE_BOOLEAN)
-            // For accurate aggregation, we need to return boolean success = true by xor'ing the field value.
-            ->add_field($DB->sql_bitxor("{$tablealias}.result", 1), 'success')
-            ->set_is_sortable(true)
-            ->add_callback(static function(bool $success): string {
-                if (!$success) {
-                    return get_string('task_result:failed', 'admin');
-                }
-                return get_string('success');
-            });
-
-        return $columns;
-    }
-
-    /**
-     * Return list of all available filters
-     *
-     * @return filter[]
-     */
-    protected function get_all_filters(): array {
-        global $DB;
-
-        $tablealias = $this->get_table_alias('task_log');
-
-        // Name filter (Filter by classname).
-        $filters[] = (new filter(
-            autocomplete::class,
-            'name',
-            new lang_string('classname', 'tool_task'),
-            $this->get_entity_name(),
-            "{$tablealias}.classname"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_options_callback(static function(): array {
-                global $DB;
-                $classnames = $DB->get_fieldset_sql('SELECT DISTINCT classname FROM {task_log} ORDER BY classname ASC');
-
-                $options = [];
-                foreach ($classnames as $classname) {
-                    if (class_exists($classname)) {
-                        $task = new $classname;
-                        $options[$classname] = $task->get_name();
-                    }
-                }
-
-                core_collator::asort($options);
-                return $options;
-            });
-
-        // Component filter.
-        $filters[] = (new filter(
-            text::class,
-            'component',
-            new lang_string('plugin'),
-            $this->get_entity_name(),
-            "{$tablealias}.component"
-        ))
-            ->add_joins($this->get_joins());
-
-        // Type filter.
-        $filters[] = (new filter(
-            select::class,
-            'type',
-            new lang_string('tasktype', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.type"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_options([
-                \core\task\database_logger::TYPE_ADHOC => new lang_string('task_type:adhoc', 'admin'),
-                \core\task\database_logger::TYPE_SCHEDULED => new lang_string('task_type:scheduled', 'admin'),
-            ]);
-
-        // Output filter (Filter by task output).
-        $filters[] = (new filter(
-            text::class,
-            'output',
-            new lang_string('task_logoutput', 'admin'),
-            $this->get_entity_name(),
-            $DB->sql_cast_to_char("{$tablealias}.output")
-        ))
-            ->add_joins($this->get_joins());
-
-        // Start time filter.
-        $filters[] = (new filter(
-            date::class,
-            'timestart',
-            new lang_string('task_starttime', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.timestart"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_limited_operators([
-                date::DATE_ANY,
-                date::DATE_RANGE,
-                date::DATE_PREVIOUS,
-                date::DATE_CURRENT,
-            ]);
-
-        // End time.
-        $filters[] = (new filter(
-            date::class,
-            'timeend',
-            new lang_string('task_endtime', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.timeend"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_limited_operators([
-                date::DATE_ANY,
-                date::DATE_RANGE,
-                date::DATE_PREVIOUS,
-                date::DATE_CURRENT,
-            ]);
-
-        // Duration filter.
-        $filters[] = (new filter(
-            duration::class,
-            'duration',
-            new lang_string('task_duration', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.timeend - {$tablealias}.timestart"
-        ))
-            ->add_joins($this->get_joins());
-
-        // Database reads.
-        $filters[] = (new filter(
-            number::class,
-            'dbreads',
-            new lang_string('task_dbreads', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.dbreads"
-        ))
-            ->add_joins($this->get_joins());
-
-        // Database writes.
-        $filters[] = (new filter(
-            number::class,
-            'dbwrites',
-            new lang_string('task_dbwrites', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.dbwrites"
-        ))
-            ->add_joins($this->get_joins());
-
-        // Result filter.
-        $filters[] = (new filter(
-            select::class,
-            'result',
-            new lang_string('task_result', 'admin'),
-            $this->get_entity_name(),
-            "{$tablealias}.result"
-        ))
-            ->add_joins($this->get_joins())
-            ->set_options([
-                self::SUCCESS => get_string('success'),
-                self::FAILED => get_string('task_result:failed', 'admin'),
-            ]);
-
-        return $filters;
-    }
-}

admin/classes/reportbuilder/local/systemreports/task_logs.php

@@ -1,159 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\reportbuilder\local\systemreports;
-
-use context_system;
-use core_admin\reportbuilder\local\entities\task_log;
-use core_reportbuilder\local\entities\user;
-use core_reportbuilder\local\report\action;
-use lang_string;
-use moodle_url;
-use pix_icon;
-use core_reportbuilder\system_report;
-
-/**
- * Task logs system report class implementation
- *
- * @package    core_admin
- * @copyright  2021 David Matamoros <davidmc@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class task_logs extends system_report {
-
-    /**
-     * Initialise report, we need to set the main table, load our entities and set columns/filters
-     */
-    protected function initialise(): void {
-        // Our main entity, it contains all of the column definitions that we need.
-        $entitymain = new task_log();
-        $entitymainalias = $entitymain->get_table_alias('task_log');
-
-        $this->set_main_table('task_log', $entitymainalias);
-        $this->add_entity($entitymain);
-
-        // Any columns required by actions should be defined here to ensure they're always available.
-        $this->add_base_fields("{$entitymainalias}.id");
-
-        // We can join the "user" entity to our "main" entity and use the fullname column from the user entity.
-        $entityuser = new user();
-        $entituseralias = $entityuser->get_table_alias('user');
-        $this->add_entity($entityuser->add_join(
-            "LEFT JOIN {user} {$entituseralias} ON {$entituseralias}.id = {$entitymainalias}.userid"
-        ));
-
-        // Now we can call our helper methods to add the content we want to include in the report.
-        $this->add_columns();
-        $this->add_filters();
-        $this->add_actions();
-
-        // Set if report can be downloaded.
-        $this->set_downloadable(true, get_string('tasklogs', 'admin'));
-    }
-
-    /**
-     * Validates access to view this report
-     *
-     * @return bool
-     */
-    protected function can_view(): bool {
-        return has_capability('moodle/site:config', context_system::instance());
-    }
-
-    /**
-     * Get the visible name of the report
-     *
-     * @return string
-     */
-    public static function get_name(): string {
-        return get_string('entitytasklog', 'admin');
-    }
-
-    /**
-     * Adds the columns we want to display in the report
-     *
-     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
-     * unique identifier
-     */
-    public function add_columns(): void {
-        $columns = [
-            'task_log:name',
-            'task_log:type',
-            'user:fullname',
-            'task_log:starttime',
-            'task_log:duration',
-            'task_log:hostname',
-            'task_log:pid',
-            'task_log:database',
-            'task_log:result',
-        ];
-
-        $this->add_columns_from_entities($columns);
-
-        // It's possible to override the display name of a column, if you don't want to use the value provided by the entity.
-        if ($column = $this->get_column('user:fullname')) {
-            $column->set_title(new lang_string('user', 'admin'));
-        }
-
-        // It's possible to set a default initial sort direction for one column.
-        $this->set_initial_sort_column('task_log:starttime', SORT_DESC);
-    }
-
-    /**
-     * Adds the filters we want to display in the report
-     *
-     * They are all provided by the entities we previously added in the {@see initialise} method, referencing each by their
-     * unique identifier
-     */
-    protected function add_filters(): void {
-        $filters = [
-            'task_log:name',
-            'task_log:type',
-            'task_log:output',
-            'task_log:result',
-            'task_log:timestart',
-            'task_log:duration',
-        ];
-
-        $this->add_filters_from_entities($filters);
-    }
-
-    /**
-     * Add the system report actions. An extra column will be appended to each row, containing all actions added here
-     *
-     * Note the use of ":id" placeholder which will be substituted according to actual values in the row
-     */
-    protected function add_actions(): void {
-
-        // Action to view individual task log on a popup window.
-        $this->add_action((new action(
-            new moodle_url('/admin/tasklogs.php', ['logid' => ':id']),
-            new pix_icon('e/search', ''),
-            [],
-            true,
-            new lang_string('view'),
-        )));
-
-        // Action to download individual task log.
-        $this->add_action((new action(
-            new moodle_url('/admin/tasklogs.php', ['logid' => ':id', 'download' => true]),
-            new pix_icon('t/download', ''),
-            [],
-            false,
-            new lang_string('download'),
-        )));
-    }
-}

admin/classes/table/activity_management_table.php

@@ -1,118 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use core_plugin_manager;
-use dml_exception;
-use html_writer;
-use moodle_url;
-use stdClass;
-
-/**
- * Activity Module admin settings.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class activity_management_table extends plugin_management_table {
-
-    public function setup() {
-        $this->set_attribute('id', 'modules');
-        $this->set_attribute('class', 'admintable generaltable');
-        parent::setup();
-    }
-
-    protected function get_table_id(): string {
-        return 'module-administration-table';
-    }
-
-    protected function get_plugintype(): string {
-        return 'mod';
-    }
-
-    public function guess_base_url(): void {
-        $this->define_baseurl(
-            new moodle_url('/admin/modules.php')
-        );
-    }
-
-    protected function get_action_url(array $params = []): moodle_url {
-        return new moodle_url('/admin/modules.php', $params);
-    }
-
-    protected function get_column_list(): array {
-        $columns = parent::get_column_list();
-        return array_merge(
-            array_slice($columns, 0, 1, true),
-            ['activities' => get_string('activities')],
-            array_slice($columns, 1, null, true),
-        );
-    }
-
-    protected function col_name(stdClass $row): string {
-        global $OUTPUT;
-
-        $status = $row->plugininfo->get_status();
-        if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
-            return html_writer::span(
-                get_string('pluginmissingfromdisk', 'core', $row->plugininfo),
-                'notifyproblem'
-            );
-        }
-
-        return html_writer::span(
-            html_writer::img(
-                $OUTPUT->image_url('monologo', $row->plugininfo->name),
-                '',
-                [
-                    'class' => 'icon',
-                ],
-            ) . get_string('modulename', $row->plugininfo->name)
-        );
-    }
-
-    /**
-     * Show the number of activities present, with a link to courses containing activity if relevant.
-     *
-     * @param mixed $row
-     * @return string
-     */
-    protected function col_activities(stdClass $row): string {
-        global $DB, $OUTPUT;
-        try {
-            $count = $DB->count_records_select($row->plugininfo->name, "course <> 0");
-        } catch (dml_exception $e) {
-            $count = -1;
-        }
-
-        if ($count > 0) {
-            return $OUTPUT->action_link(
-                new moodle_url('/course/search.php', [
-                    'modulelist' => $row->plugininfo->name,
-                ]),
-                $count,
-                null,
-                ['title' => get_string('showmodulecourse')]
-            );
-        } else if ($count < 0) {
-            return get_string('error');
-        } else {
-            return $count;
-        }
-    }
-}

admin/classes/table/block_management_table.php

@@ -1,153 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use html_writer;
-use moodle_url;
-use stdClass;
-
-/**
- * Tiny admin settings.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class block_management_table extends \core_admin\table\plugin_management_table {
-
-    /** @var plugininfo[] A list of blocks which cannot be deleted */
-    protected array $undeletableblocktypes;
-
-    /** @var stdClass[] A list of basic block data */
-    protected array $blockdata;
-
-    /** @var array<string,int> A list of course counts */
-    protected array $courseblocks;
-
-    public function __construct() {
-        global $DB;
-        parent::__construct();
-        $this->undeletableblocktypes = \block_manager::get_undeletable_block_types();
-
-        $sql = 'SELECT b.name,
-                       b.id,
-                       COUNT(DISTINCT binst.id) as totalcount
-                  FROM {block} b
-             LEFT JOIN {block_instances} binst ON binst.blockname = b.name
-              GROUP BY b.id,
-                       b.name
-              ORDER BY b.name ASC';
-        $this->blockdata = $DB->get_records_sql($sql);
-
-        $sql = "SELECT blockname
-                  FROM {block_instances}
-                 WHERE pagetypepattern = 'course-view-*'
-              GROUP BY blockname";
-        $this->courseblocks = $DB->get_records_sql($sql);
-    }
-
-    protected function get_plugintype(): string {
-        return 'block';
-    }
-
-    public function guess_base_url(): void {
-        $this->define_baseurl(
-            new moodle_url('/admin/blocks.php')
-        );
-    }
-
-    protected function get_action_url(array $params = []): moodle_url {
-        return new moodle_url('/admin/blocks.php', $params);
-    }
-
-
-    protected function get_table_js_module(): string {
-        return 'core_admin/block_management_table';
-    }
-
-    protected function get_column_list(): array {
-        $columns = parent::get_column_list();
-        return array_merge(
-            array_slice($columns, 0, 1, true),
-            ['instances' => get_string('blockinstances', 'admin')],
-            array_slice($columns, 1, 2, true),
-            ['protect' => get_string('blockprotect', 'admin')],
-            array_slice($columns, 3, null, true),
-        );
-    }
-
-    protected function get_columns_with_help(): array {
-        return [
-            'protect' => new \help_icon('blockprotect', 'admin'),
-        ];
-    }
-
-    /**
-     * Render the instances column
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_instances(stdClass $row): string {
-        $blockdata = $this->blockdata[$row->plugininfo->name];
-        if (array_key_exists($blockdata->name, $this->courseblocks)) {
-            return html_writer::link(
-                new moodle_url('/course/search.php', [
-                    'blocklist' => $blockdata->id,
-                ]),
-                $blockdata->totalcount,
-            );
-        }
-
-        return $blockdata->totalcount;
-    }
-
-    /**
-     * Render the protect column.
-     *
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_protect(stdClass $row): string {
-        global $OUTPUT;
-
-        $params = [
-            'sesskey' => sesskey(),
-        ];
-
-        $protected = in_array($row->plugininfo->name, $this->undeletableblocktypes);
-
-        $pluginname = $row->plugininfo->displayname;
-        if ($protected) {
-            $params['unprotect'] = $row->plugininfo->name;
-            $icon = $OUTPUT->pix_icon('t/unlock', get_string('blockunprotectblock', 'admin', $pluginname));
-        } else {
-            $params['protect'] = $row->plugininfo->name;
-            $icon = $OUTPUT->pix_icon('t/lock', get_string('blockprotectblock', 'admin', $pluginname));
-        }
-
-        return html_writer::link(
-            $this->get_action_url($params),
-            $icon,
-            [
-                'data-action' => 'toggleprotectstate',
-                'data-plugin' => $row->plugin,
-                'data-target-state' => $protected ? 0 : 1,
-            ],
-        );
-        return '';
-    }
-}

admin/classes/table/editor_management_table.php

@@ -1,63 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use moodle_url;
-
-/**
- * Tiny admin settings.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class editor_management_table extends \core_admin\table\plugin_management_table {
-    protected function get_plugintype(): string {
-        return 'editor';
-    }
-
-    public function guess_base_url(): void {
-        $this->define_baseurl(
-            new moodle_url('/admin/settings.php', ['section' => 'manageeditors'])
-        );
-    }
-
-    protected function get_action_url(array $params = []): moodle_url {
-        return new moodle_url('/admin/editors.php', $params);
-    }
-
-    protected function order_plugins(array $plugins): array {
-        global $CFG;
-
-        // The Editor list is stored in an ordered string.
-        $activeeditors = explode(',', $CFG->texteditors);
-
-        $sortedplugins = [];
-        foreach ($activeeditors as $editor) {
-            if (isset($plugins[$editor])) {
-                $sortedplugins[$editor] = $plugins[$editor];
-                unset($plugins[$editor]);
-            }
-        }
-
-        $otherplugins = parent::order_plugins($plugins);
-        return array_merge(
-            $sortedplugins,
-            $otherplugins
-        );
-    }
-}

admin/classes/table/media_management_table.php

@@ -1,71 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use moodle_url;
-use stdClass;
-
-/**
- * Media plugin admin settings.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class media_management_table extends \core_admin\table\plugin_management_table {
-    /** @var array The list of used extensions */
-    protected array $usedextensions = [];
-
-    protected function get_plugintype(): string {
-        return 'media';
-    }
-
-    protected function get_action_url(array $params = []): moodle_url {
-        return new moodle_url('/admin/media.php', $params);
-    }
-
-    protected function get_column_list(): array {
-        $columns = parent::get_column_list();
-        return array_merge(
-            array_slice($columns, 0, 1, true),
-            ['supports' => get_string('supports', 'core_media')],
-            array_slice($columns, 1, null, true),
-        );
-    }
-
-    protected function col_name(stdClass $row): string {
-        global $OUTPUT, $PAGE;
-
-        $name = $row->plugininfo->name;
-        if ($PAGE->theme->resolve_image_location('icon', 'media_' . $name, false)) {
-            $icon = $OUTPUT->pix_icon('icon', '', "media_{$name}", ['class' => 'icon pluginicon']);
-        } else {
-            $icon = $OUTPUT->pix_icon('spacer', '', 'moodle', ['class' => 'icon pluginicon noicon']);
-        }
-
-        $help = '';
-        if (get_string_manager()->string_exists('pluginname_help', 'media_' . $name)) {
-            $help = '&nbsp;' . $OUTPUT->help_icon('pluginname', 'media_' . $name);
-        }
-
-        return $icon . $row->plugininfo->displayname . $help;
-    }
-
-    protected function col_supports(stdClass $row): string {
-        return $row->plugininfo->supports($this->usedextensions);
-    }
-}

admin/classes/table/plugin_management_table.php

@@ -1,503 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use context_system;
-use core_plugin_manager;
-use core_table\dynamic as dynamic_table;
-use flexible_table;
-use html_writer;
-use moodle_url;
-use stdClass;
-
-defined('MOODLE_INTERNAL') || die();
-require_once("{$CFG->libdir}/tablelib.php");
-
-/**
- * Plugin Management table.
- *
- * @package    core_admin
- * @copyright  2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-abstract class plugin_management_table extends flexible_table implements dynamic_table {
-
-    /** @var \core\plugininfo\base[] The plugin list */
-    protected array $plugins = [];
-
-    /** @var int The number of enabled plugins of this type */
-    protected int $enabledplugincount = 0;
-
-    /** @var core_plugin_manager */
-    protected core_plugin_manager $pluginmanager;
-
-    /** @var string The plugininfo class for this plugintype */
-    protected string $plugininfoclass;
-
-    public function __construct() {
-        global $CFG;
-
-        parent::__construct($this->get_table_id());
-        require_once($CFG->libdir . '/adminlib.php');
-
-        // Fetch the plugininfo class.
-        $this->pluginmanager = core_plugin_manager::instance();
-        $this->plugininfoclass = $this->pluginmanager::resolve_plugininfo_class($this->get_plugintype());
-
-        $this->guess_base_url();
-
-        $this->plugins = $this->get_sorted_plugins();
-        $this->enabledplugincount = count(array_filter($this->plugins, function ($plugin) {
-            return $plugin->is_enabled();
-        }));
-
-        $this->setup_column_configuration();
-        $this->set_filterset(new plugin_management_table_filterset());
-        $this->setup();
-    }
-
-    /**
-     * Get the list of sorted plugins.
-     *
-     * @return \core\plugininfo\base[]
-     */
-    protected function get_sorted_plugins(): array {
-        if ($this->plugininfoclass::plugintype_supports_ordering()) {
-            return $this->plugininfoclass::get_sorted_plugins();
-        } else {
-            $plugins = $this->pluginmanager->get_plugins_of_type($this->get_plugintype());
-            return self::sort_plugins($plugins);
-        }
-    }
-
-    /**
-     * Sort the plugins list.
-     *
-     * Note: This only applies to plugins which do not support ordering.
-     *
-     * @param \core\plugininfo\base[] $plugins
-     * @return \core\plugininfo\base[]
-     */
-    protected function sort_plugins(array $plugins): array {
-        // The asort functions work by reference.
-        \core_collator::asort_objects_by_property($plugins, 'displayname');
-
-        return $plugins;
-    }
-
-    /**
-     * Set up the column configuration for this table.
-     */
-    protected function setup_column_configuration(): void {
-        $columnlist = $this->get_column_list();
-        $this->define_columns(array_keys($columnlist));
-        $this->define_headers(array_values($columnlist));
-
-        $columnswithhelp = $this->get_columns_with_help();
-        $columnhelp = array_map(function (string $column) use ($columnswithhelp): ?\renderable {
-            if (array_key_exists($column, $columnswithhelp)) {
-                return $columnswithhelp[$column];
-            }
-
-            return null;
-        }, array_keys($columnlist));
-        $this->define_help_for_headers($columnhelp);
-    }
-
-    /**
-     * Set the standard order of the plugins.
-     *
-     * @param array $plugins
-     * @return array
-     */
-    protected function order_plugins(array $plugins): array {
-        uasort($plugins, function ($a, $b) {
-            if ($a->is_enabled() && !$b->is_enabled()) {
-                return -1;
-            } else if (!$a->is_enabled() && $b->is_enabled()) {
-                return 1;
-            }
-            return strnatcasecmp($a->name, $b->name);
-        });
-
-        return $plugins;
-    }
-
-    /**
-     * Get the plugintype for this table.
-     *
-     * @return string
-     */
-    abstract protected function get_plugintype(): string;
-
-    /**
-     * Get the action URL for this table.
-     *
-     * The action URL is used to perform all actions when JS is not available.
-     *
-     * @param array $params
-     * @return moodle_url
-     */
-    abstract protected function get_action_url(array $params = []): moodle_url;
-
-    /**
-     * Provide a default implementation for guessing the base URL from the action URL.
-     */
-    public function guess_base_url(): void {
-        $this->define_baseurl($this->get_action_url());
-    }
-
-    /**
-     * Get the web service method used to toggle state.
-     *
-     * @return null|string
-     */
-    protected function get_toggle_service(): ?string {
-        return 'core_admin_set_plugin_state';
-    }
-
-    /**
-     * Get the web service method used to order plugins.
-     *
-     * @return null|string
-     */
-    protected function get_sortorder_service(): ?string {
-        return 'core_admin_set_plugin_order';
-    }
-
-    /**
-     * Get the ID of the table.
-     *
-     * @return string
-     */
-    protected function get_table_id(): string {
-        return 'plugin_management_table-' . $this->get_plugintype();
-    }
-
-    /**
-     * Get a list of the column titles
-     * @return string[]
-     */
-    protected function get_column_list(): array {
-        $columns = [
-            'name' => get_string('name', 'core'),
-            'version' => get_string('version', 'core'),
-        ];
-
-        if ($this->supports_disabling()) {
-            $columns['enabled'] = get_string('pluginenabled', 'core_plugin');
-        }
-
-        if ($this->supports_ordering()) {
-            $columns['order'] = get_string('order', 'core');
-        }
-
-        $columns['settings'] = get_string('settings', 'core');
-        $columns['uninstall'] = get_string('uninstallplugin', 'core_admin');
-
-        return $columns;
-    }
-
-    protected function get_columns_with_help(): array {
-        return [];
-    }
-
-    /**
-     * Get the context for this table.
-     *
-     * @return context_system
-     */
-    public function get_context(): context_system {
-        return context_system::instance();
-    }
-
-    /**
-     * Get the table content.
-     */
-    public function get_content(): string {
-        ob_start();
-        $this->out();
-        $content = ob_get_contents();
-        ob_end_clean();
-        return $content;
-    }
-
-    /**
-     * Print the table.
-     */
-    public function out(): void {
-        $plugintype = $this->get_plugintype();
-        foreach ($this->plugins as $plugininfo) {
-            $plugin = "{$plugintype}_{$plugininfo->name}";
-            $rowdata = (object) [
-                'plugin' => $plugin,
-                'plugininfo' => $plugininfo,
-                'name' => $plugininfo->displayname,
-                'version' => $plugininfo->versiondb,
-            ];
-            $this->add_data_keyed(
-                $this->format_row($rowdata),
-                $this->get_row_class($rowdata)
-            );
-        }
-
-        $this->finish_output(false);
-    }
-
-    /**
-     * This table is not downloadable.
-     * @param bool $downloadable
-     * @return bool
-     */
-    // phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-    public function is_downloadable($downloadable = null): bool {
-        return false;
-    }
-
-    /**
-     * Show the name column content.
-     *
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_name(stdClass $row): string {
-        $status = $row->plugininfo->get_status();
-        if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
-            return html_writer::span(
-                get_string('pluginmissingfromdisk', 'core', $row->plugininfo),
-                'notifyproblem'
-            );
-        }
-
-        if ($row->plugininfo->is_installed_and_upgraded()) {
-            return $row->plugininfo->displayname;
-        }
-
-        return html_writer::span(
-            $row->plugininfo->displayname,
-            'notifyproblem'
-        );
-    }
-
-    /**
-     * Show the enable/disable column content.
-     *
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_enabled(stdClass $row): string {
-        global $OUTPUT;
-
-        $enabled = $row->plugininfo->is_enabled();
-        $params = [
-            'sesskey' => sesskey(),
-            'plugin' => $row->plugininfo->name,
-            'action' => $enabled ? 'disable' : 'enable',
-        ];
-
-        if ($enabled) {
-            $icon = $OUTPUT->pix_icon('t/hide', get_string('disableplugin', 'core_admin', $row->plugininfo->displayname));
-        } else {
-            $icon = $OUTPUT->pix_icon('t/show', get_string('enableplugin', 'core_admin', $row->plugininfo->displayname));
-        }
-
-        return html_writer::link(
-            $this->get_action_url($params),
-            $icon,
-            [
-                'data-toggle-method' => $this->get_toggle_service(),
-                'data-action' => 'togglestate',
-                'data-plugin' => $row->plugin,
-                'data-state' => $enabled ? 1 : 0,
-            ],
-        );
-    }
-
-    protected function col_order(stdClass $row): string {
-        global $OUTPUT;
-
-        if (!$this->supports_ordering()) {
-            return '';
-        }
-
-        if (!$row->plugininfo->is_enabled()) {
-            return '';
-        }
-
-        if ($this->enabledplugincount <= 1) {
-            // There is only one row.
-            return '';
-        }
-
-        $hasup = true;
-        $hasdown = true;
-
-        if (empty($this->currentrow)) {
-            // This is the top row.
-            $hasup = false;
-        }
-
-        if ($this->currentrow === ($this->enabledplugincount - 1)) {
-            // This is the last row.
-            $hasdown = false;
-        }
-
-        if ($this->supports_ordering()) {
-            $dataattributes = [
-                'data-method' => $this->get_sortorder_service(),
-                'data-action' => 'move',
-                'data-plugin' => $row->plugin,
-            ];
-        } else {
-            $dataattributes = [];
-        }
-
-        if ($hasup) {
-            $upicon = html_writer::link(
-                $this->get_action_url([
-                    'sesskey' => sesskey(),
-                    'action' => 'up',
-                    'plugin' => $row->plugininfo->name,
-                ]),
-                $OUTPUT->pix_icon('t/up', get_string('moveup')),
-                array_merge($dataattributes, ['data-direction' => 'up']),
-            );
-        } else {
-            $upicon = $OUTPUT->spacer();
-        }
-
-        if ($hasdown) {
-            $downicon = html_writer::link(
-                $this->get_action_url([
-                    'sesskey' => sesskey(),
-                    'action' => 'down',
-                    'plugin' => $row->plugininfo->name,
-                ]),
-                $OUTPUT->pix_icon('t/down', get_string('movedown')),
-                array_merge($dataattributes, ['data-direction' => 'down']),
-            );
-        } else {
-            $downicon = $OUTPUT->spacer();
-        }
-
-        // For now just add the up/down icons.
-        return html_writer::span($upicon . $downicon);
-    }
-
-    /**
-     * Show the settings column content.
-     *
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_settings(stdClass $row): string {
-        if ($settingsurl = $row->plugininfo->get_settings_url()) {
-            return html_writer::link($settingsurl, get_string('settings'));
-        }
-
-        return '';
-    }
-
-    /**
-     * Show the Uninstall column content.
-     *
-     * @param stdClass $row
-     * @return string
-     */
-    protected function col_uninstall(stdClass $row): string {
-        $status = $row->plugininfo->get_status();
-
-        if ($status === core_plugin_manager::PLUGIN_STATUS_NEW) {
-            return get_string('status_new', 'core_plugin');
-        }
-
-        if ($status === core_plugin_manager::PLUGIN_STATUS_MISSING) {
-            $uninstall = get_string('status_missing', 'core_plugin') . '<br/>';
-        } else {
-            $uninstall = '';
-        }
-
-        if ($uninstallurl = $this->pluginmanager->get_uninstall_url($row->plugin)) {
-            $uninstall .= html_writer::link($uninstallurl, get_string('uninstallplugin', 'core_admin'));
-        }
-
-        return $uninstall;
-    }
-
-    /**
-     * Get the JS module used to manage this table.
-     *
-     * This should be a class which extends 'core_admin/plugin_management_table'.
-     *
-     * @return string
-     */
-    protected function get_table_js_module(): string {
-        return 'core_admin/plugin_management_table';
-    }
-
-    /**
-     * Add JS specific to this implementation.
-     *
-     * @return string
-     */
-    protected function get_dynamic_table_html_end(): string {
-        global $PAGE;
-
-        $PAGE->requires->js_call_amd($this->get_table_js_module(), 'init');
-        return parent::get_dynamic_table_html_end();
-    }
-
-    /**
-     * Get any class to add to the row.
-     *
-     * @param mixed $row
-     * @return string
-     */
-    protected function get_row_class($row): string {
-        $plugininfo = $row->plugininfo;
-        if ($plugininfo->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
-            return '';
-        }
-
-        if (!$plugininfo->is_enabled()) {
-            return 'dimmed_text';
-        }
-        return '';
-    }
-
-    public static function get_filterset_class(): string {
-        return self::class . '_filterset';
-    }
-
-    /**
-     * Whether this plugin type supports the disabling of plugins.
-     *
-     * @return bool
-     */
-    protected function supports_disabling(): bool {
-        return $this->plugininfoclass::plugintype_supports_disabling();
-    }
-
-    /**
-     * Whether this table should show ordering fields.
-     *
-     * @return bool
-     */
-    protected function supports_ordering(): bool {
-        return $this->plugininfoclass::plugintype_supports_ordering();
-    }
-}

admin/classes/table/plugin_management_table_filterset.php

@@ -1,27 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-/**
- * This file contains the dynamic interface.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class plugin_management_table_filterset extends \core_table\local\filter\filterset {
-}

admin/classes/table/tool_plugin_management_table.php

@@ -1,50 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-namespace core_admin\table;
-
-use moodle_url;
-
-/**
- * Tiny admin settings.
- *
- * @package core_admin
- * @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-class tool_plugin_management_table extends \core_admin\table\plugin_management_table {
-    protected function get_plugintype(): string {
-        return 'tool';
-    }
-
-    public function guess_base_url(): void {
-        $this->define_baseurl(
-            new moodle_url('/admin/tools.php')
-        );
-    }
-
-    protected function get_column_list(): array {
-        $columns = parent::get_column_list();
-
-        unset($columns['settings']);
-
-        return $columns;
-    }
-
-    protected function get_action_url(array $params = []): moodle_url {
-        return new moodle_url('/admin/tool.php', $params);
-    }
-}

admin/cli/adhoc_task.php

@@ -1,174 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Task executor for adhoc tasks.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once("{$CFG->libdir}/clilib.php");
-
-list($options, $unrecognized) = cli_get_params(
-    [
-        'help' => false,
-        'showsql' => false,
-        'showdebugging' => false,
-        'execute' => false,
-        'keep-alive' => 0,
-        'ignorelimits' => false,
-        'force' => false,
-        'id' => null,
-        'classname' => null,
-        'taskslimit' => null,
-        'failed' => false,
-    ], [
-        'h' => 'help',
-        'e' => 'execute',
-        'k' => 'keep-alive',
-        'i' => 'ignorelimits',
-        'f' => 'force',
-        'c' => 'classname',
-        'l' => 'taskslimit',
-    ]
-);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-$help = <<<EOT
-Ad hoc cron tasks.
-
-Options:
- -h, --help                Print out this help
-     --showsql             Show sql queries before they are executed
-     --showdebugging       Show developer level debugging information
- -e, --execute             Run all queued adhoc tasks
- -k, --keep-alive=N        Keep this script alive for N seconds and poll for new adhoc tasks
- -i  --ignorelimits        Ignore task_adhoc_concurrency_limit and task_adhoc_max_runtime limits
- -f, --force               Run even if cron is disabled
-     --id                  Run (failed) task with id
- -c, --classname           Run tasks with a certain classname (FQN)
- -l, --taskslimit=N        Run at most N tasks
-     --failed              Run only tasks that failed, ie those with a fail delay
-
-Run all queued tasks:
-\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --execute
-
-Run all queued tasks of specific class:
-\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --classname=\\\\core_course\\\\task\\\\course_delete_modules
-
-Double backslash for the shell escape reasons.
-Run a specific task:
-\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --id=123456
-
-Run a specific task with debugging:
-\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --id=123456 --showsql --showdebugging
-
-To profile a long running task:
-\$sudo -u www-data /usr/bin/php admin/cli/adhoc_task.php --taskslimit=1 --classname='\\some\\class\\name' --ignorelimits
-
-EOT;
-
-if ($options['help']) {
-    echo $help;
-    exit(0);
-}
-
-if (CLI_MAINTENANCE) {
-    echo "CLI maintenance mode active, cron execution suspended.\n";
-    exit(1);
-}
-
-if (moodle_needs_upgrading()) {
-    echo "Moodle upgrade pending, cron execution suspended.\n";
-    exit(1);
-}
-
-if (!get_config('core', 'cron_enabled') && !$options['force']) {
-    mtrace('Cron is disabled. Use --force to override.');
-    exit(1);
-}
-
-// Common debugging options.
-if ($options['showdebugging']) {
-    set_debugging(DEBUG_DEVELOPER, true);
-}
-
-if ($options['showsql']) {
-    $DB->set_debug(true);
-}
-
-if (!empty($CFG->showcronsql)) {
-    $DB->set_debug(true);
-}
-if (!empty($CFG->showcrondebugging)) {
-    set_debugging(DEBUG_DEVELOPER, true);
-}
-
-// Process params.
-core_php_time_limit::raise();
-
-// Increase memory limit.
-raise_memory_limit(MEMORY_EXTRA);
-
-// Emulate normal session - we use admin account by default.
-\core\cron::setup_user();
-
-\core\local\cli\shutdown::script_supports_graceful_exit();
-$humantimenow = date('r', time());
-mtrace("Server Time: {$humantimenow}\n");
-
-$classname = $options['classname'];
-
-// Run a single adhoc task only, if requested.
-if (!empty($options['id'])) {
-    $taskid = (int) $options['id'];
-    \core\cron::run_adhoc_task($taskid);
-    exit(0);
-}
-
-// Run all failed tasks.
-if (!empty($options['failed'])) {
-    \core\cron::run_failed_adhoc_tasks($classname);
-    exit(0);
-}
-
-// Examine params and determine if we should run.
-$execute = (bool) $options['execute'];
-$keepalive = empty($options['keep-alive']) ? 0 : (int) $options['keep-alive'];
-$taskslimit = empty($options['taskslimit']) ? null : (int) $options['taskslimit'];
-$checklimits = empty($options['ignorelimits']);
-
-if ($classname || $keepalive || $taskslimit) {
-    $execute = true;
-}
-
-// Output the help text if no criteria for running the adhoc tasks are given.
-if (!$execute) {
-    echo $help;
-    exit(0);
-}
-
-\core\cron::run_adhoc_tasks(time(), $keepalive, $checklimits, null, $taskslimit, $classname);

admin/cli/alternative_component_cache.php

@@ -1,111 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This hack is intended for clustered sites that do not want
- * to use shared cachedir for component cache.
- *
- * This file needs to be called after any change in PHP files in dataroot,
- * that is before upgrade and install.
- *
- * @package   core
- * @copyright 2013 Petr Skoda (skodak)  {@link http://skodak.org}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-
-define('CLI_SCRIPT', true);
-define('ABORT_AFTER_CONFIG', true); // We need just the values from config.php.
-define('CACHE_DISABLE_ALL', true); // This prevents reading of existing caches.
-define('IGNORE_COMPONENT_CACHE', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-// Now get cli options.
-list($options, $unrecognized) = cli_get_params(
-    array(
-        'file'    => false,
-        'rebuild' => false,
-        'print'   => false,
-        'help'    => false
-    ),
-    array(
-        'h' => 'help'
-    )
-);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized), 2);
-}
-
-if (!$options['rebuild'] and !$options['file'] and !$options['print']) {
-    $help =
-"Create alternative component cache file
-
-Options:
--h, --help            Print out this help
---rebuild             Rebuild \$CFG->alternative_component_cache file
---file=filepath       Save component cache to file
---print               Print component cache file content
-
-Example:
-\$ php admin/cli/rebuild_alternative_component_cache.php --rebuild
-";
-
-    echo $help;
-    exit(0);
-}
-
-error_reporting(E_ALL | E_STRICT);
-ini_set('display_errors', 1);
-
-$content = core_component::get_cache_content();
-
-if ($options['print']) {
-    echo $content;
-    exit(0);
-}
-
-if ($options['rebuild']) {
-    if (empty($CFG->alternative_component_cache)) {
-        fwrite(STDERR, 'config.php does not contain $CFG->alternative_component_cache setting');
-        fwrite(STDERR, "\n");
-        exit(2);
-    }
-    $target = $CFG->alternative_component_cache;
-} else {
-    $target = $options['file'];
-}
-
-if (!$target) {
-    fwrite(STDERR, "Invalid target file $target");
-    fwrite(STDERR, "\n");
-    exit(1);
-}
-
-$bytes = file_put_contents($target, $content);
-
-if (!$bytes) {
-    fwrite(STDERR, "Error writing to $target");
-    fwrite(STDERR, "\n");
-    exit(1);
-}
-
-// Success.
-echo "File $target was updated\n";
-exit(0);

admin/cli/automated_backups.php

@@ -28,8 +28,9 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__.'/../../config.php');
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
 require_once($CFG->libdir.'/clilib.php');      // cli only functions
+require_once($CFG->libdir.'/cronlib.php');
 
 // now get cli options
 list($options, $unrecognized) = cli_get_params(array('help'=>false),
@@ -74,15 +75,16 @@ if (!empty($CFG->showcronsql)) {
     $DB->set_debug(true);
 }
 if (!empty($CFG->showcrondebugging)) {
-    set_debugging(DEBUG_DEVELOPER, true);
+    $CFG->debug = DEBUG_DEVELOPER;
+    $CFG->debugdisplay = true;
 }
 
 $starttime = microtime();
 
-// Emulate normal session.
-\core\cron::setup_user();
+/// emulate normal session
+cron_setup_user();
 
-// Start output log.
+/// Start output log
 $timenow = time();
 
 mtrace("Server Time: ".date('r',$timenow)."\n\n");
@@ -95,4 +97,4 @@ backup_cron_automated_helper::run_automated_backup(backup_cron_automated_helper:
 mtrace("Automated cron backups completed correctly");
 
 $difftime = microtime_diff($starttime, microtime());
-mtrace("Execution took ".$difftime." seconds");
+mtrace("Execution took ".$difftime." seconds");

admin/cli/backup.php

@@ -1,119 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script allows to do backup.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2013 Lancaster University
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', 1);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
-
-// Now get cli options.
-list($options, $unrecognized) = cli_get_params(array(
-    'courseid' => false,
-    'courseshortname' => '',
-    'destination' => '',
-    'help' => false,
-    ), array('h' => 'help'));
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help'] || !($options['courseid'] || $options['courseshortname'])) {
-    $help = <<<EOL
-Perform backup of the given course.
-
-Options:
---courseid=INTEGER          Course ID for backup.
---courseshortname=STRING    Course shortname for backup.
---destination=STRING        Path where to store backup file. If not set the backup
-                            will be stored within the course backup file area.
--h, --help                  Print out this help.
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/backup.php --courseid=2 --destination=/moodle/backup/\n
-EOL;
-
-    echo $help;
-    die;
-}
-
-$admin = get_admin();
-if (!$admin) {
-    mtrace("Error: No admin account was found");
-    die;
-}
-
-// Do we need to store backup somewhere else?
-$dir = rtrim($options['destination'], '/');
-if (!empty($dir)) {
-    if (!file_exists($dir) || !is_dir($dir) || !is_writable($dir)) {
-        mtrace("Destination directory does not exists or not writable.");
-        die;
-    }
-}
-
-// Check that the course exists.
-if ($options['courseid']) {
-    $course = $DB->get_record('course', array('id' => $options['courseid']), '*', MUST_EXIST);
-} else if ($options['courseshortname']) {
-    $course = $DB->get_record('course', array('shortname' => $options['courseshortname']), '*', MUST_EXIST);
-}
-
-cli_heading('Performing backup...');
-$bc = new backup_controller(backup::TYPE_1COURSE, $course->id, backup::FORMAT_MOODLE,
-                            backup::INTERACTIVE_YES, backup::MODE_GENERAL, $admin->id);
-// Set the default filename.
-$format = $bc->get_format();
-$type = $bc->get_type();
-$id = $bc->get_id();
-$users = $bc->get_plan()->get_setting('users')->get_value();
-$anonymised = $bc->get_plan()->get_setting('anonymize')->get_value();
-$filename = backup_plan_dbops::get_default_backup_filename($format, $type, $id, $users, $anonymised);
-$bc->get_plan()->get_setting('filename')->set_value($filename);
-
-// Execution.
-$bc->finish_ui();
-$bc->execute_plan();
-$results = $bc->get_results();
-$file = $results['backup_destination']; // May be empty if file already moved to target location.
-
-// Do we need to store backup somewhere else?
-if (!empty($dir)) {
-    if ($file) {
-        mtrace("Writing " . $dir.'/'.$filename);
-        if ($file->copy_content_to($dir.'/'.$filename)) {
-            $file->delete();
-            mtrace("Backup completed.");
-        } else {
-            mtrace("Destination directory does not exist or is not writable. Leaving the backup in the course backup file area.");
-        }
-    }
-} else {
-    mtrace("Backup completed, the new file is listed in the backup area of the given course");
-}
-$bc->destroy();
-exit(0);

admin/cli/build_theme_css.php

@@ -1,119 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Build and store theme CSS.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once("$CFG->libdir/clilib.php");
-require_once("$CFG->libdir/csslib.php");
-require_once("$CFG->libdir/outputlib.php");
-
-$longparams = [
-    'themes'    => null,
-    'direction' => null,
-    'help'      => false,
-    'verbose'   => false
-];
-
-$shortmappings = [
-    't' => 'themes',
-    'd' => 'direction',
-    'h' => 'help',
-    'v' => 'verbose'
-];
-
-// Get CLI params.
-list($options, $unrecognized) = cli_get_params($longparams, $shortmappings);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help']) {
-    echo
-"Compile the CSS for one or more installed themes.
-Existing CSS caches will replaced.
-By default all themes will be recompiled unless otherwise specified.
-
-Options:
--t, --themes    A comma separated list of themes to be compiled
--d, --direction Only compile a single direction (either ltr or rtl)
--v, --verbose   Print info comments to stdout
--h, --help      Print out this help
-
-Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/build_theme_css.php --themes=boost --direction=ltr
-";
-
-    die;
-}
-
-if (empty($options['verbose'])) {
-    $trace = new null_progress_trace();
-} else {
-    $trace = new text_progress_trace();
-}
-
-cli_heading('Build theme css');
-
-// Determine which themes we need to build.
-$themenames = [];
-if (is_null($options['themes'])) {
-    $trace->output('No themes specified. Finding all installed themes.');
-    $themenames = array_keys(core_component::get_plugin_list('theme'));
-} else {
-    if (is_string($options['themes'])) {
-        $themenames = explode(',', $options['themes']);
-    } else {
-        cli_error('--themes must be a comma separated list of theme names');
-    }
-}
-
-$trace->output('Checking that each theme is correctly installed...');
-$themeconfigs = [];
-foreach ($themenames as $themename) {
-    if (is_null(theme_get_config_file_path($themename))) {
-        cli_error("Unable to find theme config for {$themename}");
-    }
-
-    // Load the config for the theme.
-    $themeconfigs[] = theme_config::load($themename);
-}
-
-$directions = ['ltr', 'rtl'];
-
-if (!is_null($options['direction'])) {
-    if (!in_array($options['direction'], $directions)) {
-         cli_error("--direction must be either ltr or rtl");
-    }
-
-    $directions = [$options['direction']];
-}
-
-$trace->output('Building CSS for themes: ' . implode(', ', $themenames));
-theme_build_css_for_themes($themeconfigs, $directions);
-
-exit(0);

admin/cli/cfg.php

@@ -1,185 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI script allowing to get and set config values.
- *
- * This is technically just a thin wrapper for {@link get_config()} and
- * {@link set_config()} functions.
- *
- * @package     core
- * @subpackage  cli
- * @copyright   2017 David Mudrák <david@moodle.com>
- * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-$usage = "Displays the current value of the given site setting. Allows to set it to the given value, too.
-
-Usage:
-    # php cfg.php [--component=<componentname>] [--json] [--shell-arg]
-    # php cfg.php --name=<configname> [--component=<componentname>] [--shell-arg] [--no-eol]
-    # php cfg.php --name=<configname> [--component=<componentname>] --set=<value>
-    # php cfg.php --name=<configname> [--component=<componentname>] --unset
-    # php cfg.php [--help|-h]
-
-Options:
-    -h --help                   Print this help.
-    --component=<frankenstyle>  Name of the component the variable is part of. Defaults to core.
-    --name=<configname>         Name of the configuration variable to get/set. If missing, print all
-                                configuration variables of the given component.
-    --set=<value>               Set the given variable to this value.
-    --unset                     Unset the given variable.
-    --shell-arg                 Escape output values so that they can be directly used as shell script arguments.
-    --json                      Encode output list of values using JSON notation.
-    --no-eol                    Do not include the trailing new line character when printing the value.
-
-The list of all variables of the given component can be printed as
-tab-separated list (default) or JSON object (--json). Particular values are
-printed as raw text values, optionally escaped so that they can be directly
-used as shell script arguments (--shell-arg). Single values are displayed with
-trailing new line by default, unless explicitly disabled (--no-eol).
-
-In the read mode, the script exits with success status 0 if the requested value
-is found. If the requested variable is not set, the script exits with status 3.
-When listing all variables of the component, the exit status is always 0 even
-if no variables for the given component are found. When setting/unsetting a
-value, the exit status is 0. When attempting to set/unset a value that has
-already been hard-set in config.php, the script exits with error status 4. In
-case of unexpected error, the script exits with error status 1.
-
-Examples:
-
-    # php cfg.php
-        Prints tab-separated list of all core configuration variables and their values.
-
-    # php cfg.php --json
-        Prints list of all core configuration variables and their values as a JSON object.
-
-    # php cfg.php --name=release
-        Prints the given configuration variable - e.g. \$CFG->release in this case.
-
-    # php cfg.php --component=tool_recyclebin
-    #   Prints tab-separated list of the plugin's configuration variables.
-
-    # export DATAROOT=\$(php cfg.php --name=dataroot --shell-arg --no-eol)
-        Stores the given configuration variable in the shell variable, escaped
-        so that it can be safely used as a shell argument.
-
-    # php cfg.php --name=theme --set=classic
-        Sets the given configuration variable to the given value.
-
-    # php cfg.php --name=noemailever --unset
-        Unsets the previously configured variable.
-";
-
-list($options, $unrecognised) = cli_get_params([
-    'help' => false,
-    'component' => null,
-    'name' => null,
-    'set' => null,
-    'unset' => false,
-    'shell-arg' => false,
-    'json' => false,
-    'no-eol' => false,
-], [
-    'h' => 'help'
-]);
-
-if ($unrecognised) {
-    $unrecognised = implode(PHP_EOL.'  ', $unrecognised);
-    cli_error(get_string('cliunknowoption', 'core_admin', $unrecognised));
-}
-
-if ($options['help']) {
-    cli_writeln($usage);
-    exit(2);
-}
-
-if ($options['unset'] || $options['set'] !== null) {
-    // Unset the variable or set it to the given value.
-    if (empty($options['name'])) {
-        cli_error('Missing configuration variable name', 2);
-    }
-
-    // Check that the variable is not hard-set in the main config.php already.
-    $component = $options['component'];
-    if (!empty($component)) {
-        $componentsettings = $CFG->forced_plugin_settings[$component] ?? [];
-        $settinginconfig = array_key_exists($options['name'], $componentsettings);
-    } else {
-        $settinginconfig = array_key_exists($options['name'], $CFG->config_php_settings);
-    }
-    if ($settinginconfig) {
-        cli_error('The configuration variable is hard-set in the config.php, unable to change.', 4);
-    }
-
-    $new = $options['set'];
-    $old = get_config($options['component'], $options['name']);
-    if ($new !== $old) {
-        set_config($options['name'], $options['set'], $options['component']);
-        add_to_config_log($options['name'], $old, $new, $options['component']);
-    }
-    exit(0);
-}
-
-if ($options['name'] === null) {
-    // List all variables provided by the component (defaults to core).
-    $got = get_config($options['component']);
-
-    if ($options['json']) {
-        cli_writeln(json_encode($got));
-
-    } else {
-        foreach ($got as $name => $value) {
-            if ($options['shell-arg']) {
-                $value = escapeshellarg($value);
-            }
-            cli_writeln($name."\t".$value);
-        }
-    }
-
-    exit(0);
-
-} else {
-    // Display the value of a single variable.
-
-    $got = get_config($options['component'], $options['name']);
-
-    if ($got === false) {
-        cli_error('No such configuration variable found.', 3);
-    }
-
-    if ($options['shell-arg']) {
-        $got = escapeshellarg($got);
-    }
-
-    if ($options['json']) {
-        $got = json_encode($got);
-    }
-
-    if ($options['no-eol']) {
-        cli_write($got);
-    } else {
-        cli_writeln($got);
-    }
-
-    exit(0);
-}

admin/cli/check_database_schema.php

@@ -1,76 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Validate that the current db structure matches the install.xml files.
- *
- * @package   core
- * @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @author    Petr Skoda <petr.skoda@totaralms.com>
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-$help = "Validate database structure
-
-Options:
--h, --help            Print out this help.
-
-Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/check_database_schema.php
-";
-
-list($options, $unrecognized) = cli_get_params(
-    array(
-        'help' => false,
-    ),
-    array(
-        'h' => 'help',
-    )
-);
-
-if ($options['help']) {
-    echo $help;
-    exit(0);
-}
-
-if (empty($CFG->version)) {
-    echo "Database is not yet installed.\n";
-    exit(2);
-}
-
-$dbmanager = $DB->get_manager();
-$schema = $dbmanager->get_install_xml_schema();
-
-if (!$errors = $dbmanager->check_database_schema($schema)) {
-    echo "Database structure is ok.\n";
-    exit(0);
-}
-
-foreach ($errors as $table => $items) {
-    cli_separator();
-    echo "$table\n";
-    foreach ($items as $item) {
-        echo " * $item\n";
-    }
-}
-cli_separator();
-
-exit(1);

admin/cli/checks.php

@@ -1,171 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI tool for system checks
- *
- * @package    core
- * @category   check
- * @copyright  2020 Brendan Heywood (brendan@catalyst-au.net)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-use core\check\result;
-
-list($options, $unrecognized) = cli_get_params([
-    'help'    => false,
-    'filter'  => '',
-    'type'    => 'status',
-    'verbose' => false,
-], [
-    'h' => 'help',
-    'f' => 'filter',
-    'v' => 'verbose',
-    't' => 'type',
-]);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-$checks = \core\check\manager::get_checks($options['type']);
-$types = join(', ', \core\check\manager::TYPES);
-
-$help = "Run Moodle system checks
-
-Options:
- -h, --help      Print out this help
- -f, --filter    Filter to a subset of checks
- -t, --type      Which set of checks? Defaults to 'status'
-                 One of $types
- -v, --verbose   Show details of all checks, not just failed checks
-
-Example:
-
-  sudo -u www-data php admin/cli/checks.php
-  sudo -u www-data php admin/cli/checks.php -v
-  sudo -u www-data php admin/cli/checks.php -v --filter=environment
-
-";
-
-if ($options['help']) {
-    echo $help;
-    die();
-}
-
-$filter = $options['filter'];
-if ($filter) {
-    $checks = array_filter($checks, function($check, $key) use ($filter) {
-        $ref = $check->get_ref();
-        return (strpos($ref, $filter) !== false);
-    }, 1);
-}
-
-// These shell exit codes and labels align with the NRPE standard.
-$exitcodes = [
-    result::NA        => 0,
-    result::OK        => 0,
-    result::INFO      => 0,
-    result::UNKNOWN   => 3,
-    result::WARNING   => 1,
-    result::ERROR     => 2,
-    result::CRITICAL  => 2,
-];
-$exitlabel = [
-    result::NA        => 'OK',
-    result::OK        => 'OK',
-    result::INFO      => 'OK',
-    result::UNKNOWN   => 'UNKNOWN',
-    result::WARNING   => 'WARNING',
-    result::ERROR     => 'CRITICAL',
-    result::CRITICAL  => 'CRITICAL',
-];
-
-$format = "%      10s| % -60s\n";
-$spacer = "----------+--------------------------------------------------------------------\n";
-$prefix = '          |';
-
-$output = '';
-$header = $exitlabel[result::OK] . ': ' . get_string('checksok', '', $options['type']) . "\n";
-$exitcode = $exitcodes[result::OK];
-
-foreach ($checks as $check) {
-    $ref = $check->get_ref();
-    $result = $check->get_result();
-
-    $status = $result->get_status();
-    $checkexitcode = $exitcodes[$status];
-
-    // Summary is treated as html.
-    $summary = $result->get_summary();
-    $summary = html_to_text($summary, 60, false);
-
-    if ($checkexitcode > $exitcode) {
-        $exitcode = $checkexitcode;
-        $header = $exitlabel[$status] . ': ' . $check->get_name() . " (" . $check->get_ref() . ")\n";
-    }
-
-    if (empty($messages[$status])) {
-        $messages[$status] = $result;
-    }
-
-    $len = strlen(get_string('status' . $status));
-
-    if ($options['verbose'] ||
-        $status == result::WARNING ||
-        $status == result::CRITICAL ||
-        $status == result::ERROR) {
-
-        $output .= sprintf(
-            $format,
-            $OUTPUT->check_result($result),
-            sprintf('%s (%s)', $check->get_name(), $ref)
-        );
-
-        $summary = str_replace("\n", "\n" . $prefix . '     ', $summary);
-        $output .= sprintf( $format, '', '    ' . $summary);
-
-        if ($options['verbose']) {
-            $actionlink = $check->get_action_link();
-            if ($actionlink) {
-                $output .= sprintf( $format, '', '    ' . $actionlink->url);
-            }
-            $output .= sprintf( $format, '', '');
-        }
-    }
-}
-
-// Print NRPE header.
-print $header;
-
-// Only show the table header if there is anything to show.
-if ($output) {
-    print sprintf($format,
-        get_string('status'). ' ',
-        get_string('check')
-    ) .  $spacer;
-    print $output;
-}
-
-// NRPE shell exit code.
-exit($exitcode);
-

admin/cli/cron.php

@@ -1,4 +1,5 @@
 <?php
+
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -29,32 +30,13 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir . '/clilib.php');
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
+require_once($CFG->libdir.'/clilib.php');      // cli only functions
+require_once($CFG->libdir.'/cronlib.php');
 
-// Now get cli option.
-[$options, $unrecognized] = cli_get_params(
-    [
-        'help' => false,
-        'stop' => false,
-        'list' => false,
-        'force' => false,
-        'enable' => false,
-        'disable' => false,
-        'disable-wait' => false,
-        'keep-alive' => null,
-    ],
-    [
-        'h' => 'help',
-        's' => 'stop',
-        'l' => 'list',
-        'f' => 'force',
-        'e' => 'enable',
-        'd' => 'disable',
-        'w' => 'disable-wait',
-        'k' => 'keep-alive',
-    ]
-);
+// now get cli options
+list($options, $unrecognized) = cli_get_params(array('help'=>false),
+                                               array('h'=>'help'));
 
 if ($unrecognized) {
     $unrecognized = implode("\n  ", $unrecognized);
@@ -63,19 +45,10 @@ if ($unrecognized) {
 
 if ($options['help']) {
     $help =
-    "Execute periodic cron actions.
+"Execute periodic cron actions.
 
 Options:
--h, --help               Print out this help
--s, --stop               Notify all other running cron processes to stop after the current task
--l, --list               Show the list of currently running tasks and how long they have been running
--f, --force              Execute task even if cron is disabled
--e, --enable             Enable cron
--d, --disable            Disable cron
--w, --disable-wait=600   Disable cron and wait until all tasks finished or fail after N seconds (optional param)
--k, --keep-alive=N       Keep this script alive for N seconds and poll for new tasks
-                         The default value can be set by administrators in:
-                         Site administration > Server > Tasks > Task processing > Keep alive time
+-h, --help            Print out this help
 
 Example:
 \$sudo -u www-data /usr/bin/php admin/cli/cron.php
@@ -85,102 +58,4 @@ Example:
     die;
 }
 
-if ($options['stop']) {
-    // By clearing the caches this signals to other running processes
-    // to exit after finishing the current task.
-    \core\task\manager::clear_static_caches();
-    die;
-}
-
-if ($options['enable']) {
-    set_config('cron_enabled', 1);
-    mtrace('Cron has been enabled for the site.');
-    exit(0);
-}
-
-if ($options['disable']) {
-    set_config('cron_enabled', 0);
-    \core\task\manager::clear_static_caches();
-    mtrace('Cron has been disabled for the site.');
-    exit(0);
-}
-
-if ($options['list']) {
-    $tasks = \core\task\manager::get_running_tasks();
-    mtrace('The list of currently running tasks:');
-    $format = "%7s %-12s %-9s %-20s %-52s\n";
-    printf(
-        $format,
-        'PID',
-        'HOST',
-        'TYPE',
-        'TIME',
-        'CLASSNAME'
-    );
-    foreach ($tasks as $task) {
-        printf(
-            $format,
-            $task->pid,
-            substr($task->hostname, 0, 12),
-            $task->type,
-            format_time(time() - $task->timestarted),
-            substr($task->classname, 0, 52)
-        );
-    }
-    exit(0);
-}
-
-if ($wait = $options['disable-wait']) {
-    $started = time();
-    if (true === $wait) {
-        // Default waiting time.
-        $waitsec = 600;
-    } else {
-        $waitsec = $wait;
-        $wait = true;
-    }
-
-    set_config('cron_enabled', 0);
-    \core\task\manager::clear_static_caches();
-    mtrace('Cron has been disabled for the site.');
-    mtrace('Allocating ' . format_time($waitsec) . ' for the tasks to finish.');
-
-    $lastcount = 0;
-    while ($wait) {
-        $tasks = \core\task\manager::get_running_tasks();
-
-        if (count($tasks) == 0) {
-            mtrace('');
-            mtrace('All scheduled and adhoc tasks finished.');
-            exit(0);
-        }
-
-        if (time() - $started >= $waitsec) {
-            mtrace('');
-            mtrace('Wait time (' . format_time($waitsec) . ') elapsed, but ' . count($tasks) . ' task(s) still running.');
-            mtrace('Exiting with code 1.');
-            exit(1);
-        }
-
-        if (count($tasks) !== $lastcount) {
-            mtrace('');
-            mtrace(count($tasks) . " tasks currently running.", '');
-            $lastcount = count($tasks);
-        } else {
-            mtrace('.', '');
-        }
-
-        sleep(1);
-    }
-}
-
-if (!get_config('core', 'cron_enabled') && !$options['force']) {
-    mtrace('Cron is disabled. Use --force to override.');
-    exit(1);
-}
-
-\core\local\cli\shutdown::script_supports_graceful_exit();
-
-
-$keepalive = $options['keep-alive'];
-\core\cron::run_main_process($keepalive);
+cron_run();

admin/cli/dashboard_reset.php

@@ -1,65 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI script to reset dashboards.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2021 Brendan Heywood (brendan@catalyst-au.net)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-require_once($CFG->dirroot.'/my/lib.php');
-
-list($options, $unrecognized) = cli_get_params([
-    'help'    => false,
-    'execute' => false,
-], [
-    'h' => 'help',
-    'e' => 'execute',
-]);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized), 2);
-}
-
-if (!$options['execute']) {
-    $help = <<<EOF
-Resets Moodle dashboards for all users
-
-Options:
--h, --help          Print out this help
--e, --execute       Actually run the reset
-
-Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/dashboard_reset.php -e
-
-EOF;
-
-    echo $help;
-    exit(0);
-}
-
-$progressbar = new progress_bar();
-$progressbar->create();
-my_reset_page_for_all_users(MY_PAGE_PRIVATE, 'my-index', $progressbar);
-

admin/cli/delete_course.php

@@ -1,123 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI script to delete a course.
- *
- * @package    core
- * @subpackage cli
- * @author     Mikhail Golenkov <mikhailgolenkov@catalyst-au.net>
- * @copyright  2022 Catalyst IT
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir . '/clilib.php');
-
-list($options, $unrecognized) = cli_get_params(
-    [
-        'courseid' => false,
-        'help' => false,
-        'showsql' => false,
-        'showdebugging' => false,
-        'disablerecyclebin' => false,
-        'non-interactive' => false,
-    ], [
-        'c' => 'courseid',
-        'h' => 'help',
-    ]
-);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help'] || empty($options['courseid'])) {
-    $help = <<<EOT
-CLI script to delete a course.
-
-Options:
- -h, --help                Print out this help
-     --showsql             Show sql queries before they are executed
-     --showdebugging       Show developer level debugging information
-     --disablerecyclebin   Skip backing up the course
-     --non-interactive     No interactive questions or confirmations
- -c, --courseid            Course id to be deleted
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/delete_course.php --courseid=123456
-\$sudo -u www-data /usr/bin/php admin/cli/delete_course.php --courseid=123456 --showdebugging
-\$sudo -u www-data /usr/bin/php admin/cli/delete_course.php --courseid=123456 --disablerecyclebin
-
-EOT;
-
-    echo $help;
-    die;
-}
-
-$interactive = empty($options['non-interactive']);
-
-if ($options['showdebugging']) {
-    mtrace('Enabling debugging...');
-    set_debugging(DEBUG_DEVELOPER, true);
-}
-
-if ($options['showsql']) {
-    mtrace('Enabling SQL debugging...');
-    $DB->set_debug(true);
-}
-
-if (CLI_MAINTENANCE) {
-    cli_error('CLI maintenance mode active, CLI execution suspended');
-}
-
-if (moodle_needs_upgrading()) {
-    cli_error('Moodle upgrade pending, CLI execution suspended');
-}
-
-$course = $DB->get_record('course', array('id' => $options['courseid']));
-if (empty($course)) {
-    cli_error('Course not found');
-}
-
-mtrace('Deleting course id ' . $course->id);
-mtrace('Course name: ' . $course->fullname);
-mtrace('Short name: ' . $course->shortname);
-
-if ($interactive) {
-    mtrace('');
-    $input = cli_input('Are you sure you wish to delete this course? (y/N)', 'N', ['y', 'Y', 'n', 'N']);
-    if (strtolower($input) != 'y') {
-        exit(0);
-    }
-}
-
-if ($options['disablerecyclebin']) {
-    mtrace('Disabling recycle bin...');
-    $overrideconfig = ['tool_recyclebin' => ['coursebinenable' => false, 'categorybinenable' => false]];
-    $CFG->forced_plugin_settings = array_merge($CFG->forced_plugin_settings, $overrideconfig);
-}
-
-core_php_time_limit::raise();
-delete_course($course);
-
-mtrace('Updating course count in categories...');
-fix_course_sortorder();
-
-mtrace('Done!');

admin/cli/emailstop.php

@@ -1,209 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script allows you to view and change the emailstop flag of any user.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2023 Stephan Robotta (stephan.robotta@bfh.ch)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-// Define the input options.
-$longparams = [
-    'email' => '',
-    'help' => false,
-    'id' => '',
-    'quiet' => false,
-    'stop' => '',
-    'username' => '',
-];
-
-$shortparams = [
-    'e' => 'email',
-    'h' => 'help',
-    'i' => 'id',
-    'q' => 'quiet',
-    's' => 'stop',
-    'u' => 'username',
-];
-
-// Define exit codes.
-$exitsuccess = 0;
-$exitunknownoption = 1;
-$exitmissinguserarg = 2;
-$exittoomanyuserarg = 3;
-$exitnosearchargs = 4;
-$exitnousersfound = 5;
-$exitinvalidstopflag = 6;
-$exiterrordb = 7;
-
-// Now get cli options that are set by the caller.
-list($options, $unrecognized) = cli_get_params($longparams, $shortparams);
-
-$verbose = empty($options['quiet']);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    if ($verbose) {
-        cli_error(get_string('cliunknowoption', 'admin', $unrecognized), $exitunknownoption);
-    }
-    exit($exitunknownoption);
-}
-
-if ($options['help']) {
-    $help =
-        "Set/unset or show status of emailstop flag for a user, identified by username or email.
-
-There are no security checks here because anybody who is able to
-execute this file may execute any PHP too.
-
-Options:
--h, --help                    Print out this help
--e, --email=email             Specify user by email, separate many users by comma
--i, --id=id                   Specify user by id, separate many users by comma
--q, --quiet                   No output to stdout
--s, --stop=0|1|off|on         Set new value for emailstop flag
--u, --username=username       Specify user by username, separate many users by comma
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/emailstop.php --email=student1@example.com --stop=1
-\$sudo -u www-data /usr/bin/php admin/cli/emailstop.php --email=student1@example.com,student2@example.com
-\$sudo -u www-data /usr/bin/php admin/cli/emailstop.php --u=student1,student2 -s=on
-";
-
-    echo $help;
-    exit($exitsuccess);
-}
-
-$cntempty = 0;
-$cntfilled = 0;
-$searchargs = [];
-
-// Try to find out which option is used to fetch the users from. Also do sanitize etc.
-foreach (['email', 'username', 'id'] as $option) {
-    if (empty($options[$option])) {
-        $cntempty++;
-    } else {
-        $cntfilled++;
-        $argname = $option;
-        // The search args must be: split by the comma, trimmed, and empty elements filtered out.
-        $searchargs = array_flip(array_filter(
-            array_map(
-                function ($item) {
-                    return trim($item);
-                },
-                explode(',', $options[$option])
-            ),
-            function ($item) {
-                return $item !== '';
-            }
-        ));
-    }
-}
-if ($cntempty === 3) {
-    if ($verbose) {
-        cli_error('One of username, email, or id must be set.', $exitmissinguserarg);
-    }
-    exit($exitmissinguserarg);
-}
-if ($cntfilled > 1) {
-    if ($verbose) {
-        cli_error('Only one of email, username, or id can be set to identify a user.', $exittoomanyuserarg);
-    }
-    exit($exittoomanyuserarg);
-}
-if (empty($searchargs)) {
-    if ($verbose) {
-        cli_error('No values are provided for users.', $exitnosearchargs);
-    }
-    exit($exitnosearchargs);
-}
-try {
-    $users = $DB->get_records_list('user', $argname, array_keys($searchargs));
-} catch (Exception $e) {
-    if ($verbose) {
-        cli_error("Could not fetch data from db by {$argname}: '{$options[$argname]}'.", $exiterrordb);
-    }
-    exit($exiterrordb);
-}
-if (empty($users)) {
-    if ($verbose) {
-        cli_error("Can not find any user by {$argname}: '{$options[$argname]}'.", $exitnousersfound);
-    }
-    exit($exitnousersfound);
-}
-
-// No stop flag set, then just print the user and the current emailstop flag state.
-if ($options['stop'] === '') {
-    foreach ($users as $user) {
-        if ($verbose) {
-            echo 'user=' . $user->{$argname} . ' - emailstop=' . (int)$user->emailstop . PHP_EOL;
-            unset($searchargs[$user->{$argname}]);
-        }
-    }
-    if ($verbose) {
-        foreach (array_keys($searchargs) as $arg) {
-            echo 'user=' . $arg . ' - not found' . PHP_EOL;
-        }
-    }
-    exit($exitsuccess);
-}
-
-// Allowed values for the stop flag enabled are 1 and on, for disabled are 0 and off.
-$validvalues = ['0', '1', 'off', 'on'];
-$stopflag = strtolower($options['stop']);
-if (!in_array($stopflag, $validvalues)) {
-    if ($verbose) {
-        cli_error('Value for the emailstop flag must be one of: ' . implode(', ', $validvalues) . '.', $exitinvalidstopflag);
-    }
-    exit($exitinvalidstopflag);
-}
-
-foreach ($validvalues as $value) {
-    if ($value === $stopflag) {
-        $stopflag = ($value === '1' || $value === 'on') ? 1 : 0;
-        break;
-    }
-}
-// Update each user with the stop flag to be set if it is necessary.
-foreach ($users as $user) {
-    $line = 'Update user ' . $user->{$argname} . ($argname !== 'id' ? ' (' . $user->id . ')' : '') . ' - ';
-    if ((int)$user->emailstop !== $stopflag) {
-        $DB->set_field('user', 'emailstop', $stopflag, ['id' => $user->id]);
-        $line .= 'ok';
-    } else {
-        $line .= 'already done';
-    }
-    if ($verbose) {
-        echo $line . PHP_EOL;
-        unset($searchargs[$user->{$argname}]);
-    }
-
-}
-if ($verbose) {
-    foreach (array_keys($searchargs) as $arg) {
-        echo 'user=' . $arg . ' - not found' . PHP_EOL;
-    }
-}
-exit($exitsuccess);
-

admin/cli/fix_course_sequence.php

@@ -1,125 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script fixed incorrectly deleted users.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2013 Marina Glancy
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-// Get cli options.
-list($options, $unrecognized) = cli_get_params(
-    array(
-        'courses'           => false,
-        'fix'               => false,
-        'help'              => false
-    ),
-    array(
-        'h' => 'help',
-        'c' => 'courses',
-        'f' => 'fix'
-    )
-);
-
-if ($options['help'] || empty($options['courses'])) {
-    $help =
-"Checks and fixes that course modules and sections reference each other correctly.
-
-Compares DB fields course_sections.sequence and course_modules.section
-checking that:
-- course_sections.sequence contains each module id not more than once in the course
-- for each moduleid from course_sections.sequence the field course_modules.section
-  refers to the same section id (this means course_sections.sequence is more
-  important if they are different)
-- each module in the course is present in one of course_sections.sequence
-- section sequences do not contain non-existing course modules
-
-If there are any mismatches, the message is displayed. If --fix is specified,
-the records in DB are corrected.
-
-This script may run for a long time on big systems if called for all courses.
-
-Avoid executing the script when another user may simultaneously edit any of the
-courses being checked (recommended to run in mainenance mode).
-
-Options:
--c, --courses         List courses that need to be checked (comma-separated
-                      values or * for all). Required
--f, --fix             Fix the mismatches in DB. If not specified check only and
-                      report problems to STDERR
--h, --help            Print out this help
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/fix_course_sequence.php --courses=*
-\$sudo -u www-data /usr/bin/php admin/cli/fix_course_sequence.php --courses=2,3,4 --fix
-";
-
-    echo $help;
-    die;
-}
-
-$courseslist = preg_split('/\s*,\s*/', $options['courses'], -1, PREG_SPLIT_NO_EMPTY);
-if (in_array('*', $courseslist)) {
-    $where = '';
-    $params = array();
-} else {
-    list($sql, $params) = $DB->get_in_or_equal($courseslist, SQL_PARAMS_NAMED, 'id');
-    $where = 'WHERE id '. $sql;
-}
-$coursescount = $DB->get_field_sql('SELECT count(id) FROM {course} '. $where, $params);
-
-if (!$coursescount) {
-    cli_error('No courses found');
-}
-echo "Checking $coursescount courses...\n\n";
-
-require_once($CFG->dirroot. '/course/lib.php');
-
-$problems = array();
-$courses = $DB->get_fieldset_sql('SELECT id FROM {course} '. $where, $params);
-foreach ($courses as $courseid) {
-    $errors = course_integrity_check($courseid, null, null, true, empty($options['fix']));
-    if ($errors) {
-        if (!empty($options['fix'])) {
-            // Reset the course cache to make sure cache is recalculated next time the course is viewed.
-            rebuild_course_cache($courseid, true);
-        }
-        foreach ($errors as $error) {
-            cli_problem($error);
-        }
-        $problems[] = $courseid;
-    } else {
-        echo "Course [$courseid] is OK\n";
-    }
-}
-if (!count($problems)) {
-    echo "\n...All courses are OK\n";
-} else {
-    if (!empty($options['fix'])) {
-        echo "\n...Found and fixed ".count($problems)." courses with problems". "\n";
-    } else {
-        echo "\n...Found ".count($problems)." courses with problems. To fix run:\n";
-        echo "\$sudo -u www-data /usr/bin/php admin/cli/fix_course_sequence.php --courses=".join(',', $problems)." --fix". "\n";
-    }
-}

admin/cli/fix_deleted_users.php

@@ -1,92 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script fixed incorrectly deleted users.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2013 Petr Skoda (http://skodak.org)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-
-// Now get cli options.
-list($options, $unrecognized) = cli_get_params(array('help'=>false),
-    array('h'=>'help'));
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help']) {
-    $help =
-        "Fix incorrectly deleted users.
-
-        This scripts detects users that are marked as deleted instead
-        of calling delete_user().
-
-        Deleted users do not have original username, idnumber or email,
-        we must also delete all roles, enrolments, group memberships, etc.
-
-        Please note this script does not delete any public information
-        such as forum posts.
-
-        Options:
-        -h, --help            Print out this help
-
-        Example:
-        \$sudo -u www-data /usr/bin/php admin/cli/fix_deleted_users.php
-        ";
-
-    echo $help;
-    die;
-}
-
-cli_heading('Looking for sloppy user deletes');
-
-// Look for sloppy deleted users where somebody only flipped the deleted flag.
-$sql = "SELECT *
-          FROM {user}
-         WHERE deleted = 1 AND email LIKE '%@%' AND username NOT LIKE '%@%'";
-$rs = $DB->get_recordset_sql($sql);
-foreach ($rs as $user) {
-    echo "Redeleting user $user->id: $user->username ($user->email)\n";
-    delete_user($user);
-}
-$rs->close();
-
-cli_heading('Deleting all leftovers');
-
-$DB->set_field('user', 'idnumber', '', array('deleted'=>1));
-
-$DB->delete_records_select('role_assignments', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('cohort_members', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('groups_members', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('user_enrolments', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('user_preferences', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('user_info_data', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('user_lastaccess', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('external_tokens', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-$DB->delete_records_select('external_services_users', "userid IN (SELECT id FROM {user} WHERE deleted = 1)");
-
-exit(0);

admin/cli/fix_orphaned_calendar_events.php

@@ -1,138 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Fix orphaned calendar events that were broken by MDL-67494.
- *
- * This script will look for all the calendar events which userids
- * where broken by a wrong upgrade step, affecting to Moodle 3.9.5
- * and up.
- *
- * It performs checks to both:
- *    a) Detect if the site was affected (ran the wrong upgrade step).
- *    b) Look for orphaned calendar events, categorising them as:
- *       - standard: site / category / course / group / user events
- *       - subscription: events created via subscriptions.
- *       - action: normal action events, created to show common important dates.
- *       - override: user and group override events, particular, that some activities support.
- *       - custom: other events, not being any of the above, common or particular.
- * By specifying it (--fix) try to recover as many broken events (missing userid) as
- * possible. Standard, subscription, action, override events in core are fully supported but
- * override or custom events should be fixed by each plugin as far as there isn't any standard
- * API (plugin-wise) to launch a rebuild of the calendar events.
- *
- * @package core
- * @copyright 2021 onwards Simey Lameze <simey@moodle.com>
- * @license    https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require_once(__DIR__ . '/../../config.php');
-require_once($CFG->libdir . "/clilib.php");
-require_once($CFG->libdir . '/db/upgradelib.php');
-
-// Supported options.
-$long = ['fix'  => false, 'help' => false];
-$short = ['f' => 'fix', 'h' => 'help'];
-
-// CLI options.
-[$options, $unrecognized] = cli_get_params($long, $short);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help']) {
-    $help = <<<EOT
-Fix orphaned calendar events.
-
-  This script detects calendar events that have had their
-  userid lost. By default it will perform various checks
-  and report them, showing the site status in an easy way.
-
-  Also, optionally (--fix), it wil try to recover as many
-  lost userids as possible from different sources. Note that
-  this script aims to process well-know events in core,
-  leaving custom events in 3rd part plugins mostly unmodified
-  because there isn't any consistent way to regenerate them.
-
-  For more details:  https://tracker.moodle.org/browse/MDL-71156
-
-Options:
-  -h, --help    Print out this help.
-  -f, --fix     Fix the orphaned calendar events in the DB.
-                If not specified only check and report problems to STDERR.
-
-Usage:
-  - Only report:    \$ sudo -u www-data /usr/bin/php admin/cli/fix_orphaned_calendar_events.php
-  - Report and fix: \$ sudo -u www-data /usr/bin/php admin/cli/fix_orphaned_calendar_events.php -f
-EOT;
-
-    cli_writeln($help);
-    die;
-}
-
-// Check various usual pre-requisites.
-if (empty($CFG->version)) {
-    cli_error('Database is not yet installed.');
-}
-
-$admin = get_admin();
-if (!$admin) {
-    cli_error('Error: No admin account was found.');
-}
-
-if (moodle_needs_upgrading()) {
-    cli_error('Moodle upgrade pending, script execution suspended.');
-}
-
-// Do everything as admin by default.
-\core\session\manager::set_user($admin);
-
-// Report current site status.
-cli_heading('Checking the site status');
-$needsfix = upgrade_calendar_site_status();
-
-// Report current calendar events status.
-cli_heading('Checking the calendar events status');
-$info = upgrade_calendar_events_status();
-$hasbadevents = $info['total']->bad > 0 || $info['total']->bad != $info['other']->bad;
-$needsfix = $needsfix || $hasbadevents;
-
-// If, selected, fix as many calendar events as possible.
-if ($options['fix']) {
-
-    // If the report has told us that the fix was not needed... ask for confirmation!
-    if (!$needsfix) {
-        cli_writeln("This site DOES NOT NEED to run the calendar events fix.");
-        $input = cli_input('Are you completely sure that you want to run the fix? (y/N)', 'N', ['y', 'Y', 'n', 'N']);
-        if (strtolower($input) != 'y') {
-            exit(0);
-        }
-        cli_writeln("");
-    }
-    cli_heading('Fixing as many as possible calendar events');
-    upgrade_calendar_events_fix_remaining($info);
-    // Report current (after fix) calendar events status.
-    cli_heading('Checking the calendar events status (after fix)');
-    upgrade_calendar_events_status();
-} else if ($needsfix) {
-    // Fix option was not provided but problem events have been found. Notify the user and provide info how to fix these events.
-    cli_writeln("This site NEEDS to run the calendar events fix!");
-    cli_writeln("To fix the calendar events, re-run this script with the --fix option.");
-}

admin/cli/fix_orphaned_question_categories.php

@@ -1,103 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script fixes orphaned question categories.
- *
- * Orphaned question categories have had their associated context deleted
- * but the category itself remains in the database with an invalid context.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2013 Tyler Bannister (tyler.bannister@remote-learner.net)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-require_once($CFG->libdir.'/questionlib.php');
-
-$long = array('fix'  => false, 'help' => false);
-$short = array('f' => 'fix', 'h' => 'help');
-
-// Now get cli options.
-list($options, $unrecognized) = cli_get_params($long, $short);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help']) {
-    $help =
-        "Fix orphaned question categories.
-
-        This scripts detects question categories that have had their
-        context deleted, thus severing them from their original purpose.
-
-        This script will find the orphaned categories and delete the unused
-        questions in each category found.  Used questions will not be
-        deleted, instead they will be moved to a rescue question category.
-
-        Options:
-        -h, --help            Print out this help
-        -f, --fix             Fix the orphaned question categories in the DB.
-                              If not specified only check and report problems to STDERR.
-        Example:
-        \$sudo -u www-data /usr/bin/php admin/cli/fix_orphaned_question_categories.php
-        \$sudo -u www-data /usr/bin/php admin/cli/fix_orphaned_question_categories.php -f
-        ";
-
-    echo $help;
-    die;
-}
-
-cli_heading('Checking for orphaned categories');
-
-
-$sql = 'SELECT qc.id, qc.contextid, qc.name
-          FROM {question_categories} qc
-     LEFT JOIN {context} c ON qc.contextid = c.id
-         WHERE c.id IS NULL';
-$categories = $DB->get_recordset_sql($sql);
-
-$i = 0;
-foreach ($categories as $category) {
-    $i += 1;
-    echo "Found orphaned category: {$category->name}\n";
-    if (!empty($options['fix'])) {
-        echo "Cleaning...";
-        // One transaction per category.
-        $transaction = $DB->start_delegated_transaction();
-        question_category_delete_safe($category);
-        $transaction->allow_commit();
-        echo "  Done!\n";
-    }
-}
-
-if (($i > 0) && !empty($options['fix'])) {
-    echo "Found and removed {$i} orphaned question categories\n";
-} else if ($i > 0) {
-    echo "Found {$i} orphaned question categories. To fix, run:\n";
-    echo "\$sudo -u www-data /usr/bin/php admin/cli/fix_orphaned_question_categories.php --fix\n";
-} else {
-    echo "No orphaned question categories found.\n";
-}
-
-
-$categories->close();

admin/cli/generate_key.php

@@ -1,79 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * Generates a secure key for the current server (presuming it does not already exist).
- *
- * @package core_admin
- * @copyright 2020 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-use \core\encryption;
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir . '/clilib.php');
-
-// Get cli options.
-[$options, $unrecognized] = cli_get_params(
-        ['help' => false, 'method' => null],
-        ['h' => 'help']);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-// TODO: MDL-71421 - Remove the openssl alternative once sodium becomes a requirement in Moodle 4.2.
-
-if ($options['help']) {
-    echo "Generate secure key
-
-This script manually creates a secure key within the secret data root folder (configured in
-config.php as \$CFG->secretdataroot). You must run it using an account with access to write
-to that folder.
-
-In normal use Moodle automatically creates the key; this script is intended when setting up
-a new Moodle system, for cases where the secure folder is not on shared storage and the key
-may be manually installed on multiple servers.
-
-Options:
--h, --help         Print out this help
---method <method>  Generate key for specified encryption method instead of default.
-                   * sodium
-                   * openssl-aes-256-ctr
-
-Example:
-php admin/cli/generate_key.php
-";
-    exit;
-}
-
-$method = $options['method'];
-
-if (encryption::key_exists($method)) {
-    echo 'Key already exists: ' . encryption::get_key_file($method) . "\n";
-    exit;
-}
-
-// Creates key with default permissions (no chmod).
-echo "Generating key...\n";
-encryption::create_key($method, false);
-
-echo "\nKey created: " . encryption::get_key_file($method) . "\n\n";
-echo "If the key folder is not shared storage, then key files should be copied to all servers.\n";

admin/cli/install.php

@@ -36,12 +36,6 @@ if (isset($_SERVER['REMOTE_ADDR'])) {
     exit(1);
 }
 
-// Force OPcache reset if used, we do not want any stale caches
-// when preparing test environment.
-if (function_exists('opcache_reset')) {
-    opcache_reset();
-}
-
 $help =
 "Command line Moodle installer, creates config.php and initializes database.
 Please note you must execute this script with the same uid as apache
@@ -64,26 +58,19 @@ Options:
 --dbname=NAME         Database name. Default is moodle
 --dbuser=USERNAME     Database user. Default is root
 --dbpass=PASSWORD     Database password. Default is blank
---dbport=NUMBER       Use database port.
---dbsocket=PATH       Use database socket, 1 means default. Available for some databases only.
+--dbsocket            Use database sockets. Available for some databases only.
 --prefix=STRING       Table prefix for above database tables. Default is mdl_
 --fullname=STRING     The fullname of the site
 --shortname=STRING    The shortname of the site
---summary=STRING      The summary to be displayed on the front page
 --adminuser=USERNAME  Username for the moodle admin account. Default is admin
 --adminpass=PASSWORD  Password for the moodle admin account,
                       required in non-interactive mode.
---adminemail=STRING   Email address for the moodle admin account.
---sitepreset=STRING   Admin site preset to be applied during the installation process.
---supportemail=STRING Email address for support and help.
---upgradekey=STRING   The upgrade key to be set in the config.php, leave empty to not set it.
 --non-interactive     No interactive questions, installation fails if any
                       problem encountered.
 --agree-license       Indicates agreement with software license,
                       required in non-interactive mode.
 --allow-unstable      Install even if the version is not marked as stable yet,
                       required in non-interactive mode.
---skip-database       Stop the installation before installing the database.
 -h, --help            Print out this help
 
 Example:
@@ -92,7 +79,7 @@ Example:
 
 
 // distro specific customisation
-$distrolibfile = __DIR__.'/../../install/distrolib.php';
+$distrolibfile = dirname(dirname(dirname(__FILE__))).'/install/distrolib.php';
 $distro = null;
 if (file_exists($distrolibfile)) {
     require_once($distrolibfile);
@@ -102,7 +89,7 @@ if (file_exists($distrolibfile)) {
 }
 
 // Nothing to do if config.php exists
-$configfile = __DIR__.'/../../config.php';
+$configfile = dirname(dirname(dirname(__FILE__))).'/config.php';
 if (file_exists($configfile)) {
     require($configfile);
     require_once($CFG->libdir.'/clilib.php');
@@ -126,11 +113,10 @@ $olddir = getcwd();
 chdir(dirname($_SERVER['argv'][0]));
 
 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
-if (!function_exists('date_default_timezone_set') or !function_exists('date_default_timezone_get')) {
-    fwrite(STDERR, "Timezone functions are not available.\n");
-    exit(1);
+// This is a quick hack.  Ideally we should ask the admin for a value.  See MDL-22625 for more on this.
+if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
+    @date_default_timezone_set(@date_default_timezone_get());
 }
-date_default_timezone_set(@date_default_timezone_get());
 
 // make sure PHP errors are displayed - helps with diagnosing of problems
 @error_reporting(E_ALL);
@@ -141,87 +127,53 @@ date_default_timezone_set(@date_default_timezone_get());
 /** Used by library scripts to check they are being called by Moodle */
 define('MOODLE_INTERNAL', true);
 
-// Disables all caching.
-define('CACHE_DISABLE_ALL', true);
-
-define('PHPUNIT_TEST', false);
-
-define('IGNORE_COMPONENT_CACHE', true);
-
-// Check that PHP is of a sufficient version as soon as possible.
-require_once(__DIR__.'/../../lib/phpminimumversionlib.php');
-moodle_require_minimum_php_version();
+// Check that PHP is of a sufficient version
+if (version_compare(phpversion(), "5.3.2") < 0) {
+    $phpversion = phpversion();
+    // do NOT localise - lang strings would not work here and we CAN NOT move it after installib
+    fwrite(STDERR, "Moodle 2.1 or later requires at least PHP 5.3.2 (currently using version $phpversion).\n");
+    fwrite(STDERR, "Please upgrade your server software or install older Moodle version.\n");
+    exit(1);
+}
 
 // set up configuration
-global $CFG;
 $CFG = new stdClass();
 $CFG->lang                 = 'en';
-$CFG->dirroot              = dirname(dirname(__DIR__));
+$CFG->dirroot              = dirname(dirname(dirname(__FILE__)));
 $CFG->libdir               = "$CFG->dirroot/lib";
 $CFG->wwwroot              = "http://localhost";
 $CFG->httpswwwroot         = $CFG->wwwroot;
 $CFG->docroot              = 'http://docs.moodle.org';
 $CFG->running_installer    = true;
 $CFG->early_install_lang   = true;
-$CFG->ostype               = (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) ? 'WINDOWS' : 'UNIX';
-$CFG->dboptions            = array();
-$CFG->debug                = (E_ALL | E_STRICT);
-$CFG->debugdisplay         = true;
-$CFG->debugdeveloper       = true;
 
-$parts = explode('/', str_replace('\\', '/', dirname(__DIR__)));
+$parts = explode('/', str_replace('\\', '/', dirname(dirname(__FILE__))));
 $CFG->admin                = array_pop($parts);
 
 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
 //the problem is that we need specific version of quickforms and hacked excel files :-(
 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
 
-require_once($CFG->libdir.'/classes/component.php');
-require_once($CFG->libdir.'/classes/text.php');
-require_once($CFG->libdir.'/classes/string_manager.php');
-require_once($CFG->libdir.'/classes/string_manager_install.php');
-require_once($CFG->libdir.'/classes/string_manager_standard.php');
 require_once($CFG->libdir.'/installlib.php');
 require_once($CFG->libdir.'/clilib.php');
 require_once($CFG->libdir.'/setuplib.php');
+require_once($CFG->libdir.'/textlib.class.php');
 require_once($CFG->libdir.'/weblib.php');
 require_once($CFG->libdir.'/dmllib.php');
 require_once($CFG->libdir.'/moodlelib.php');
 require_once($CFG->libdir.'/deprecatedlib.php');
 require_once($CFG->libdir.'/adminlib.php');
 require_once($CFG->libdir.'/componentlib.class.php');
-require_once($CFG->dirroot.'/cache/lib.php');
-
-// Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
-// Required because the database checks below lead to session interaction which is going to lead us to requiring autoloaded classes.
-if (defined('COMPONENT_CLASSLOADER')) {
-    spl_autoload_register(COMPONENT_CLASSLOADER);
-} else {
-    spl_autoload_register('core_component::classloader');
-}
 
 require($CFG->dirroot.'/version.php');
 $CFG->target_release = $release;
 
-\core\session\manager::init_empty_session();
-global $SESSION;
-global $USER;
-
-global $COURSE;
-$COURSE = new stdClass();
-$COURSE->id = 1;
-
-global $SITE;
-$SITE = $COURSE;
-define('SITEID', 1);
-
 //Database types
 $databases = array('mysqli' => moodle_database::get_driver_instance('mysqli', 'native'),
-                   'auroramysql' => moodle_database::get_driver_instance('auroramysql', 'native'),
-                   'mariadb'=> moodle_database::get_driver_instance('mariadb', 'native'),
                    'pgsql'  => moodle_database::get_driver_instance('pgsql',  'native'),
                    'oci'    => moodle_database::get_driver_instance('oci',    'native'),
                    'sqlsrv' => moodle_database::get_driver_instance('sqlsrv', 'native'), // MS SQL*Server PHP driver
+                   'mssql'  => moodle_database::get_driver_instance('mssql',  'native'), // FreeTDS driver
                   );
 foreach ($databases as $type=>$database) {
     if ($database->driver_installed() !== true) {
@@ -241,28 +193,21 @@ list($options, $unrecognized) = cli_get_params(
         'chmod'             => isset($distro->directorypermissions) ? sprintf('%04o',$distro->directorypermissions) : '2777', // let distros set dir permissions
         'lang'              => $CFG->lang,
         'wwwroot'           => '',
-        'dataroot'          => empty($distro->dataroot) ? str_replace('\\', '/', dirname(dirname(dirname(__DIR__))).'/moodledata'): $distro->dataroot, // initialised later after including libs or by distro
+        'dataroot'          => empty($distro->dataroot) ? str_replace('\\', '/', dirname(dirname(dirname(dirname(__FILE__)))).'/moodledata'): $distro->dataroot, // initialised later after including libs or by distro
         'dbtype'            => empty($distro->dbtype) ? $defaultdb : $distro->dbtype, // let distro skip dbtype selection
         'dbhost'            => empty($distro->dbhost) ? 'localhost' : $distro->dbhost, // let distros set dbhost
         'dbname'            => 'moodle',
         'dbuser'            => empty($distro->dbuser) ? 'root' : $distro->dbuser, // let distros set dbuser
         'dbpass'            => '',
-        'dbport'            => '',
-        'dbsocket'          => '',
+        'dbsocket'          => false,
         'prefix'            => 'mdl_',
         'fullname'          => '',
         'shortname'         => '',
-        'summary'           => '',
         'adminuser'         => 'admin',
         'adminpass'         => '',
-        'adminemail'        => '',
-        'sitepreset'        => '',
-        'supportemail'      => '',
-        'upgradekey'        => '',
         'non-interactive'   => false,
         'agree-license'     => false,
         'allow-unstable'    => false,
-        'skip-database'     => false,
         'help'              => false
     ),
     array(
@@ -271,21 +216,13 @@ list($options, $unrecognized) = cli_get_params(
 );
 
 $interactive = empty($options['non-interactive']);
-$skipdatabase = $options['skip-database'];
 
 // set up language
 $lang = clean_param($options['lang'], PARAM_SAFEDIR);
-$languages = get_string_manager()->get_list_of_translations();
-if (array_key_exists($lang, $languages)) {
+if (file_exists($CFG->dirroot.'/install/lang/'.$lang)) {
     $CFG->lang = $lang;
 }
 
-// Set up site admin preset.
-$sitepreset = clean_param($options['sitepreset'], PARAM_RAW);
-if (!empty($sitepreset)) {
-    $CFG->setsitepresetduringinstall = $sitepreset;
-}
-
 if ($unrecognized) {
     $unrecognized = implode("\n  ", $unrecognized);
     cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
@@ -297,41 +234,38 @@ if ($options['help']) {
 }
 
 //Print header
-cli_logo();
-echo PHP_EOL;
 echo get_string('cliinstallheader', 'install', $CFG->target_release)."\n";
 
 //Fist select language
 if ($interactive) {
     cli_separator();
-    // Do not put the langs into columns because it is not compatible with RTL.
+    $languages = get_string_manager()->get_list_of_translations();
+    // format the langs nicely - 3 per line
+    $c = 0;
+    $langlist = '';
+    foreach ($languages as $key=>$lang) {
+        $c++;
+        $length = iconv_strlen($lang, 'UTF-8');
+        $padded = $lang.str_repeat(' ', 38-$length);
+        $langlist .= $padded;
+        if ($c % 3 == 0) {
+            $langlist .= "\n";
+        }
+    }
     $default = $CFG->lang;
-    cli_heading(get_string('chooselanguagehead', 'install'));
-    if (array_key_exists($default, $languages)) {
-        echo $default.' - '.$languages[$default]."\n";
-    }
-    if ($default !== 'en') {
-        echo 'en - English (en)'."\n";
-    }
-    echo '? - '.get_string('availablelangs', 'install')."\n";
+    cli_heading(get_string('availablelangs', 'install'));
+    echo $langlist."\n";
     $prompt = get_string('clitypevaluedefault', 'admin', $CFG->lang);
     $error = '';
     do {
         echo $error;
         $input = cli_input($prompt, $default);
+        $input = clean_param($input, PARAM_SAFEDIR);
 
-        if ($input === '?') {
-            echo implode("\n", $languages)."\n";
-            $error = "\n";
-
+        if (!file_exists($CFG->dirroot.'/install/lang/'.$input)) {
+            $error = get_string('cliincorrectvalueretry', 'admin')."\n";
         } else {
-            $input = clean_param($input, PARAM_SAFEDIR);
-
-            if (!array_key_exists($input, $languages)) {
-                $error = get_string('cliincorrectvalueretry', 'admin')."\n";
-            } else {
-                $error = '';
-            }
+            $error = '';
         }
     } while ($error !== '');
     $CFG->lang = $input;
@@ -365,8 +299,6 @@ if ($interactive) {
     }
 }
 $CFG->directorypermissions = $chmod;
-$CFG->filepermissions      = ($CFG->directorypermissions & 0666);
-$CFG->umaskpermissions     = (($CFG->directorypermissions & 0777) ^ 0777);
 
 //We need wwwroot before we test dataroot
 $wwwroot = clean_param($options['wwwroot'], PARAM_URL);
@@ -403,6 +335,7 @@ if ($interactive) {
 $CFG->wwwroot       = $wwwroot;
 $CFG->httpswwwroot  = $CFG->wwwroot;
 
+
 //We need dataroot before lang download
 $CFG->dataroot = $options['dataroot'];
 if ($interactive) {
@@ -452,10 +385,8 @@ if ($interactive) {
         cli_error(get_string('pathserrcreatedataroot', 'install', $a));
     }
 }
-$CFG->tempdir       = $CFG->dataroot.'/temp';
-$CFG->backuptempdir = $CFG->tempdir.'/backup';
-$CFG->cachedir      = $CFG->dataroot.'/cache';
-$CFG->localcachedir = $CFG->dataroot.'/localcache';
+$CFG->tempdir  = $CFG->dataroot.'/temp';
+$CFG->cachedir = $CFG->dataroot.'/cache';
 
 // download required lang packs
 if ($CFG->lang !== 'en') {
@@ -494,8 +425,7 @@ if (isset($maturity)) {
                 exit(1);
             }
         } else {
-            cli_problem(get_string('maturitycorewarning', 'admin', $maturitylevel));
-            cli_error(get_string('maturityallowunstable', 'admin'));
+            cli_error(get_string('maturitycorewarning', 'admin'));
         }
     }
 }
@@ -525,105 +455,72 @@ if ($interactive) {
 $database = $databases[$CFG->dbtype];
 
 
-// We cannot do any validation until all DB connection data is provided.
-$hintdatabase = '';
-do {
-    echo $hintdatabase;
-
-    // Ask for db host.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('databasehost', 'install'));
-        if ($options['dbhost'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['dbhost']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-        $CFG->dbhost = cli_input($prompt, $options['dbhost']);
-
+// ask for db host
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('databasehost', 'install'));
+    if ($options['dbhost'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['dbhost']);
     } else {
-        $CFG->dbhost = $options['dbhost'];
+        $prompt = get_string('clitypevalue', 'admin');
     }
+    $CFG->dbhost = cli_input($prompt, $options['dbhost']);
 
-    // Ask for db name.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('databasename', 'install'));
-        if ($options['dbname'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['dbname']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-        $CFG->dbname = cli_input($prompt, $options['dbname']);
+} else {
+    $CFG->dbhost = $options['dbhost'];
+}
 
+// ask for db name
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('databasename', 'install'));
+    if ($options['dbname'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['dbname']);
     } else {
-        $CFG->dbname = $options['dbname'];
+        $prompt = get_string('clitypevalue', 'admin');
     }
+    $CFG->dbname = cli_input($prompt, $options['dbname']);
 
-    // Ask for db prefix.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('dbprefix', 'install'));
-        //TODO: solve somehow the prefix trouble for oci.
-        if ($options['prefix'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['prefix']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-        $CFG->prefix = cli_input($prompt, $options['prefix']);
+} else {
+    $CFG->dbname = $options['dbname'];
+}
 
+// ask for db prefix
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('dbprefix', 'install'));
+    //TODO: solve somehow the prefix trouble for oci
+    if ($options['prefix'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['prefix']);
     } else {
-        $CFG->prefix = $options['prefix'];
+        $prompt = get_string('clitypevalue', 'admin');
     }
+    $CFG->prefix = cli_input($prompt, $options['prefix']);
 
-    // Ask for db port.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('databaseport', 'install'));
-        $prompt = get_string('clitypevaluedefault', 'admin', $options['dbport']);
-        $CFG->dboptions['dbport'] = (int) cli_input($prompt, $options['dbport']);
+} else {
+    $CFG->prefix = $options['prefix'];
+}
 
+// ask for db user
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('databaseuser', 'install'));
+    if ($options['dbuser'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['dbuser']);
     } else {
-        $CFG->dboptions['dbport'] = (int) $options['dbport'];
-    }
-    if ($CFG->dboptions['dbport'] <= 0) {
-        $CFG->dboptions['dbport'] = '';
+        $prompt = get_string('clitypevalue', 'admin');
     }
+    $CFG->dbuser = cli_input($prompt, $options['dbuser']);
 
-    // Ask for db socket.
-    if ($CFG->ostype === 'WINDOWS') {
-        $CFG->dboptions['dbsocket'] = '';
-
-    } else if ($interactive and empty($CFG->dboptions['dbport'])) {
-        cli_separator();
-        cli_heading(get_string('databasesocket', 'install'));
-        $prompt = get_string('clitypevaluedefault', 'admin', $options['dbsocket']);
-        $CFG->dboptions['dbsocket'] = cli_input($prompt, $options['dbsocket']);
-
-    } else {
-        $CFG->dboptions['dbsocket'] = $options['dbsocket'];
-    }
-
-    // Ask for db user.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('databaseuser', 'install'));
-        if ($options['dbuser'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['dbuser']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-        $CFG->dbuser = cli_input($prompt, $options['dbuser']);
-
-    } else {
-        $CFG->dbuser = $options['dbuser'];
-    }
-
-    // Ask for db password.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('databasepass', 'install'));
+} else {
+    $CFG->dbuser = $options['dbuser'];
+}
 
+// ask for db password
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('databasepass', 'install'));
+    do {
         if ($options['dbpass'] !== '') {
             $prompt = get_string('clitypevaluedefault', 'admin', $options['dbpass']);
         } else {
@@ -631,171 +528,113 @@ do {
         }
 
         $CFG->dbpass = cli_input($prompt, $options['dbpass']);
-        if (function_exists('distro_pre_create_db')) { // Hook for distros needing to do something before DB creation.
-            $distro = distro_pre_create_db($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix,
-                    array('dbpersist' => 0, 'dbport' => $CFG->dboptions['dbport'], 'dbsocket' => $CFG->dboptions['dbsocket']),
-                    $distro);
+        if (function_exists('distro_pre_create_db')) { // Hook for distros needing to do something before DB creation
+            $distro = distro_pre_create_db($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix, array('dbpersist'=>0, 'dbsocket'=>$options['dbsocket']), $distro);
         }
-        $hintdatabase = install_db_validate($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix,
-                array('dbpersist' => 0, 'dbport' => $CFG->dboptions['dbport'], 'dbsocket' => $CFG->dboptions['dbsocket']));
+        $hint_database = install_db_validate($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix, array('dbpersist'=>0, 'dbsocket'=>$options['dbsocket']));
+    } while ($hint_database !== '');
 
-    } else {
-        $CFG->dbpass = $options['dbpass'];
-        $hintdatabase = install_db_validate($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix,
-                array('dbpersist' => 0, 'dbport' => $CFG->dboptions['dbport'], 'dbsocket' => $CFG->dboptions['dbsocket']));
-        if ($hintdatabase !== '') {
-            cli_error(get_string('dbconnectionerror', 'install'));
-        }
-    }
-} while ($hintdatabase !== '');
-
-// If --skip-database option is provided, we do not need to ask for site fullname, shortname, adminuser, adminpass, adminemail.
-// These fields will be requested during the database install part.
-if (!$skipdatabase) {
-    // Ask for fullname.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('fullsitename', 'moodle'));
-
-        if ($options['fullname'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['fullname']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-
-        do {
-            $options['fullname'] = cli_input($prompt, $options['fullname']);
-        } while (empty($options['fullname']));
-    } else {
-        if (empty($options['fullname'])) {
-            $a = (object)['option' => 'fullname', 'value' => $options['fullname']];
-            cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-        }
-    }
-
-    // Ask for shortname.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('shortsitename', 'moodle'));
-
-        if ($options['shortname'] !== '') {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['shortname']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-
-        do {
-            $options['shortname'] = cli_input($prompt, $options['shortname']);
-        } while (empty($options['shortname']));
-    } else {
-        if (empty($options['shortname'])) {
-            $a = (object)['option' => 'shortname', 'value' => $options['shortname']];
-            cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-        }
-    }
-
-    // Ask for admin user name.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('cliadminusername', 'install'));
-        if (!empty($options['adminuser'])) {
-            $prompt = get_string('clitypevaluedefault', 'admin', $options['adminuser']);
-        } else {
-            $prompt = get_string('clitypevalue', 'admin');
-        }
-        do {
-            $options['adminuser'] = cli_input($prompt, $options['adminuser']);
-        } while (empty($options['adminuser']) or $options['adminuser'] === 'guest');
-    } else {
-        if ((empty($options['adminuser']) || $options['adminuser'] === 'guest')) {
-            $a = (object)['option' => 'adminuser', 'value' => $options['adminuser']];
-            cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-        }
-    }
-
-    // Ask for admin user password.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('cliadminpassword', 'install'));
-        $prompt = get_string('clitypevalue', 'admin');
-        do {
-            $options['adminpass'] = cli_input($prompt);
-        } while (empty($options['adminpass']) or $options['adminpass'] === 'admin');
-    } else {
-        if ((empty($options['adminpass']) or $options['adminpass'] === 'admin')) {
-            $a = (object)['option' => 'adminpass', 'value' => $options['adminpass']];
-            cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-        }
-    }
-
-    // Ask for the admin email address.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('cliadminemail', 'install'));
-        $prompt = get_string('clitypevaluedefault', 'admin', $options['adminemail']);
-        $options['adminemail'] = cli_input($prompt, $options['adminemail']);
-    }
-
-    // Validate that the address provided was an e-mail address.
-    if (!empty($options['adminemail']) && !validate_email($options['adminemail'])) {
-        $a = (object)['option' => 'adminemail', 'value' => $options['adminemail']];
-        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-    }
-
-    // Ask for the support email address.
-    if ($interactive) {
-        cli_separator();
-        cli_heading(get_string('clisupportemail', 'install'));
-        $prompt = get_string('clitypevaluedefault', 'admin', $options['supportemail']);
-        $options['supportemail'] = cli_input($prompt, $options['supportemail']);
-    }
-
-    // Validate that the support email address provided is valid.
-    if (!empty($options['supportemail']) && !validate_email($options['supportemail'])) {
-        $a = (object)['option' => 'supportemail', 'value' => $options['supportemail']];
-        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
+} else {
+    $CFG->dbpass = $options['dbpass'];
+    $hint_database = install_db_validate($database, $CFG->dbhost, $CFG->dbuser, $CFG->dbpass, $CFG->dbname, $CFG->prefix, array('dbpersist'=>0, 'dbsocket'=>$options['dbsocket']));
+    if ($hint_database !== '') {
+        cli_error(get_string('dbconnectionerror', 'install'));
     }
 }
 
-// Ask for the upgrade key.
+// ask for fullname
 if ($interactive) {
     cli_separator();
-    cli_heading(get_string('upgradekeyset', 'admin'));
-    if ($options['upgradekey'] !== '') {
-        $prompt = get_string('clitypevaluedefault', 'admin', $options['upgradekey']);
-        $options['upgradekey'] = cli_input($prompt, $options['upgradekey']);
+    cli_heading(get_string('fullsitename', 'moodle'));
+
+    if ($options['fullname'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['fullname']);
     } else {
         $prompt = get_string('clitypevalue', 'admin');
-        $options['upgradekey'] = cli_input($prompt);
+    }
+
+    do {
+        $options['fullname'] = cli_input($prompt, $options['fullname']);
+    } while (empty($options['fullname']));
+} else {
+    if (empty($options['fullname'])) {
+        $a = (object)array('option'=>'fullname', 'value'=>$options['fullname']);
+        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
     }
 }
 
-// Set the upgrade key if it was provided.
-if ($options['upgradekey'] !== '') {
-    $CFG->upgradekey = $options['upgradekey'];
+// ask for shortname
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('shortsitename', 'moodle'));
+
+    if ($options['shortname'] !== '') {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['shortname']);
+    } else {
+        $prompt = get_string('clitypevalue', 'admin');
+    }
+
+    do {
+        $options['shortname'] = cli_input($prompt, $options['shortname']);
+    } while (empty($options['shortname']));
+} else {
+    if (empty($options['shortname'])) {
+        $a = (object)array('option'=>'shortname', 'value'=>$options['shortname']);
+        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
+    }
 }
 
-// The user does not also need to pass agree-license when --skip-database is provided as the user will need to accept
-// the license again in the database install part.
-if (!$skipdatabase) {
-    if ($interactive) {
-        if (!$options['agree-license']) {
-            cli_separator();
-            cli_heading(get_string('copyrightnotice'));
-            echo "Moodle  - Modular Object-Oriented Dynamic Learning Environment\n";
-            echo get_string('gpl3')."\n\n";
-            echo get_string('doyouagree')."\n";
-            $prompt = get_string('cliyesnoprompt', 'admin');
-            $input = cli_input($prompt, '', array(get_string('clianswerno', 'admin'), get_string('cliansweryes', 'admin')));
-            if ($input == get_string('clianswerno', 'admin')) {
-                exit(1);
-            }
-        }
+// ask for admin user name
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('cliadminusername', 'install'));
+    if (!empty($options['adminuser'])) {
+        $prompt = get_string('clitypevaluedefault', 'admin', $options['adminuser']);
     } else {
-        if (!$options['agree-license'] && !$skipdatabase) {
-            cli_error(get_string('climustagreelicense', 'install'));
+        $prompt = get_string('clitypevalue', 'admin');
+    }
+    do {
+        $options['adminuser'] = cli_input($prompt, $options['adminuser']);
+    } while (empty($options['adminuser']) or $options['adminuser'] === 'guest');
+} else {
+    if (empty($options['adminuser']) or $options['adminuser'] === 'guest') {
+        $a = (object)array('option'=>'adminuser', 'value'=>$options['adminuser']);
+        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
+    }
+}
+
+// ask for admin user password
+if ($interactive) {
+    cli_separator();
+    cli_heading(get_string('cliadminpassword', 'install'));
+    $prompt = get_string('clitypevalue', 'admin');
+    do {
+        $options['adminpass'] = cli_input($prompt);
+    } while (empty($options['adminpass']) or $options['adminpass'] === 'admin');
+} else {
+    if (empty($options['adminpass']) or $options['adminpass'] === 'admin') {
+        $a = (object)array('option'=>'adminpass', 'value'=>$options['adminpass']);
+        cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
+    }
+}
+
+if ($interactive) {
+    if (!$options['agree-license']) {
+        cli_separator();
+        cli_heading(get_string('copyrightnotice'));
+        echo "Moodle  - Modular Object-Oriented Dynamic Learning Environment\n";
+        echo get_string('gpl3')."\n\n";
+        echo get_string('doyouagree')."\n";
+        $prompt = get_string('cliyesnoprompt', 'admin');
+        $input = cli_input($prompt, '', array(get_string('clianswerno', 'admin'), get_string('cliansweryes', 'admin')));
+        if ($input == get_string('clianswerno', 'admin')) {
+            exit(1);
         }
     }
+} else {
+    if (!$options['agree-license']) {
+        cli_error(get_string('climustagreelicense', 'install'));
+    }
 }
 
 // Finally we have all info needed for config.php
@@ -837,23 +676,12 @@ if (!$envstatus) {
 }
 
 // Test plugin dependencies.
-$failed = array();
-if (!core_plugin_manager::instance()->all_plugins_ok($version, $failed)) {
-    cli_problem(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
+require_once($CFG->libdir . '/pluginlib.php');
+if (!plugin_manager::instance()->all_plugins_ok($version)) {
     cli_error(get_string('pluginschecktodo', 'admin'));
 }
 
-if (!$skipdatabase) {
-    install_cli_database($options, $interactive);
-    // This needs to happen at the end to ensure it occurs after all caches
-    // have been purged for the last time.
-    // This will build a cached version of the current theme for the user
-    // to immediately start browsing the site.
-    require_once($CFG->libdir.'/upgradelib.php');
-    upgrade_themes();
-} else {
-    echo get_string('cliskipdatabase', 'install')."\n";
-}
+install_cli_database($options, $interactive);
 
 echo get_string('cliinstallfinished', 'install')."\n";
 exit(0); // 0 means success

admin/cli/install_database.php

@@ -29,19 +29,12 @@
  */
 
 define('CLI_SCRIPT', true);
-define('CACHE_DISABLE_ALL', true);
 
 // extra execution prevention - we can not just require config.php here
 if (isset($_SERVER['REMOTE_ADDR'])) {
     exit(1);
 }
 
-// Force OPcache reset if used, we do not want any stale caches
-// when preparing test environment.
-if (function_exists('opcache_reset')) {
-    opcache_reset();
-}
-
 $help =
 "Advanced command line Moodle database installer.
 Please note you must execute this script with the same uid as apache.
@@ -52,24 +45,26 @@ Options:
 --lang=CODE           Installation and default site language. Default is en.
 --adminuser=USERNAME  Username for the moodle admin account. Default is admin.
 --adminpass=PASSWORD  Password for the moodle admin account.
---adminemail=STRING   Email address for the moodle admin account.
 --agree-license       Indicates agreement with software license.
 --fullname=STRING     Name of the site
 --shortname=STRING    Name of the site
---summary=STRING      The summary to be displayed on the front page
---supportemail=STRING Email address for support and help.
 -h, --help            Print out this help
 
 Example:
 \$sudo -u www-data /usr/bin/php admin/cli/install_database.php --lang=cs --adminpass=soMePass123 --agree-license
 ";
 
-// Check that PHP is of a sufficient version as soon as possible.
-require_once(__DIR__.'/../../lib/phpminimumversionlib.php');
-moodle_require_minimum_php_version();
+// Check that PHP is of a sufficient version
+if (version_compare(phpversion(), "5.3.2") < 0) {
+    $phpversion = phpversion();
+    // do NOT localise - lang strings would not work here and we CAN NOT move it after installib
+    fwrite(STDERR, "Moodle 2.1 or later requires at least PHP 5.3.2 (currently using version $phpversion).\n");
+    fwrite(STDERR, "Please upgrade your server software or install older Moodle version.\n");
+    exit(1);
+}
 
 // Nothing to do if config.php does not exist
-$configfile = __DIR__.'/../../config.php';
+$configfile = dirname(dirname(dirname(__FILE__))).'/config.php';
 if (!file_exists($configfile)) {
     fwrite(STDERR, 'config.php does not exist, can not continue'); // do not localize
     fwrite(STDERR, "\n");
@@ -84,6 +79,11 @@ require_once($CFG->libdir.'/installlib.php');
 require_once($CFG->libdir.'/adminlib.php');
 require_once($CFG->libdir.'/componentlib.class.php');
 
+// make sure no tables are installed yet
+if ($DB->get_tables() ) {
+    cli_error(get_string('clitablesexist', 'install'));
+}
+
 $CFG->early_install_lang = true;
 get_string_manager(true);
 
@@ -95,11 +95,8 @@ list($options, $unrecognized) = cli_get_params(
         'lang'              => 'en',
         'adminuser'         => 'admin',
         'adminpass'         => '',
-        'adminemail'        => '',
         'fullname'          => '',
         'shortname'         => '',
-        'summary'           => '',
-        'supportemail'      => '',
         'agree-license'     => false,
         'help'              => false
     ),
@@ -108,22 +105,12 @@ list($options, $unrecognized) = cli_get_params(
     )
 );
 
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
 
-// We show help text even if tables are installed.
 if ($options['help']) {
     echo $help;
     die;
 }
 
-// Make sure no tables are installed yet.
-if ($DB->get_tables() ) {
-    cli_error(get_string('clitablesexist', 'install'));
-}
-
 if (!$options['agree-license']) {
     cli_error('You have to agree to the license. --help prints out the help'); // TODO: localize
 }
@@ -132,21 +119,6 @@ if ($options['adminpass'] === true or $options['adminpass'] === '') {
     cli_error('You have to specify admin password. --help prints out the help'); // TODO: localize
 }
 
-// Validate that the address provided was an e-mail address.
-if (!empty($options['adminemail']) && !validate_email($options['adminemail'])) {
-    $a = (object) array('option' => 'adminemail', 'value' => $options['adminemail']);
-    cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-}
-
-// Validate that the supportemail provided was an e-mail address.
-if (!empty($options['supportemail']) && !validate_email($options['supportemail'])) {
-    $a = (object) [
-        'option' => 'supportemail',
-        'value' => $options['supportemail']
-    ];
-    cli_error(get_string('cliincorrectvalueerror', 'admin', $a));
-}
-
 $options['lang'] = clean_param($options['lang'], PARAM_SAFEDIR);
 if (!file_exists($CFG->dirroot.'/install/lang/'.$options['lang'])) {
     $options['lang'] = 'en';
@@ -188,20 +160,12 @@ if (!$envstatus) {
 }
 
 // Test plugin dependencies.
-$failed = array();
-if (!core_plugin_manager::instance()->all_plugins_ok($version, $failed)) {
-    cli_problem(get_string('pluginscheckfailed', 'admin', array('pluginslist' => implode(', ', array_unique($failed)))));
+require_once($CFG->libdir . '/pluginlib.php');
+if (!plugin_manager::instance()->all_plugins_ok($version)) {
     cli_error(get_string('pluginschecktodo', 'admin'));
 }
 
 install_cli_database($options, true);
 
-// This needs to happen at the end to ensure it occurs after all caches
-// have been purged for the last time.
-// This will build a cached version of the current theme for the user
-// to immediately start browsing the site.
-require_once($CFG->libdir.'/upgradelib.php');
-upgrade_themes();
-
 echo get_string('cliinstallfinished', 'install')."\n";
 exit(0); // 0 means success

admin/cli/kill_all_sessions.php

@@ -1,55 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI script to kill all user sessions without asking for confirmation.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2017 Alexander Bias <alexander.bias@uni-ulm.de>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir.'/clilib.php');
-
-list($options, $unrecognized) = cli_get_params(array('help' => false), array('h' => 'help'));
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized), 2);
-}
-
-if ($options['help']) {
-    $help =
-"Kill all Moodle sessions
-
-Options:
--h, --help            Print out this help
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/kill_all_sessions.php
-";
-
-    echo $help;
-    exit(0);
-}
-
-\core\session\manager::kill_all_sessions();
-
-exit(0);

admin/cli/maintenance.php

@@ -1,4 +1,5 @@
 <?php
+
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -15,7 +16,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Enable or disable maintenance mode.
+ * Enable or disable maintenance mode
  *
  * @package    core
  * @subpackage cli
@@ -25,13 +26,12 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__.'/../../config.php');
-require_once("$CFG->libdir/clilib.php");
-require_once("$CFG->libdir/adminlib.php");
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
+require_once($CFG->libdir.'/clilib.php');      // cli only functions
 
 
-// Now get cli options.
-list($options, $unrecognized) = cli_get_params(array('enable'=>false, 'enablelater'=>0, 'enableold'=>false, 'disable'=>false, 'help'=>false),
+// now get cli options
+list($options, $unrecognized) = cli_get_params(array('enable'=>false, 'disable'=>false, 'help'=>false),
                                                array('h'=>'help'));
 
 if ($unrecognized) {
@@ -45,14 +45,12 @@ if ($options['help']) {
 Current status displayed if not option specified.
 
 Options:
---enable              Enable CLI maintenance mode
---enablelater=MINUTES Number of minutes before entering CLI maintenance mode
---enableold           Enable legacy half-maintenance mode
+--enable              Enable maintenance mode
 --disable             Disable maintenance mode
 -h, --help            Print out this help
 
 Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/maintenance.php
+\$sudo -u www-data /usr/bin/php admin/cli/maintenance.php
 "; //TODO: localize - to be translated later when everything is finished
 
     echo $help;
@@ -61,52 +59,18 @@ Example:
 
 cli_heading(get_string('sitemaintenancemode', 'admin')." ($CFG->wwwroot)");
 
-if ($options['enablelater']) {
-    if (file_exists("$CFG->dataroot/climaintenance.html")) {
-        // Already enabled, sorry.
-        echo get_string('clistatusenabled', 'admin')."\n";
-        return 1;
-    }
-
-    $time = time() + ($options['enablelater']*60);
-    set_config('maintenance_later', $time);
-
-    echo get_string('clistatusenabledlater', 'admin', userdate($time))."\n";
-    return 0;
-
-} else if ($options['enable']) {
-    if (file_exists("$CFG->dataroot/climaintenance.html")) {
-        // The maintenance is already enabled, nothing to do.
-    } else {
-        enable_cli_maintenance_mode();
-    }
-    set_config('maintenance_enabled', 0);
-    unset_config('maintenance_later');
-    echo get_string('sitemaintenanceoncli', 'admin')."\n";
-    exit(0);
-
-} else if ($options['enableold']) {
+if ($options['enable']) {
     set_config('maintenance_enabled', 1);
-    unset_config('maintenance_later');
     echo get_string('sitemaintenanceon', 'admin')."\n";
     exit(0);
-
 } else if ($options['disable']) {
     set_config('maintenance_enabled', 0);
-    unset_config('maintenance_later');
-    if (file_exists("$CFG->dataroot/climaintenance.html")) {
-        unlink("$CFG->dataroot/climaintenance.html");
-    }
     echo get_string('sitemaintenanceoff', 'admin')."\n";
     exit(0);
 }
 
-if (!empty($CFG->maintenance_enabled) or file_exists("$CFG->dataroot/climaintenance.html")) {
+if (!empty($CFG->maintenance_enabled)) {
     echo get_string('clistatusenabled', 'admin')."\n";
-
-} else if (isset($CFG->maintenance_later)) {
-    echo get_string('clistatusenabledlater', 'admin', userdate($CFG->maintenance_later))."\n";
-
 } else {
     echo get_string('clistatusdisabled', 'admin')."\n";
 }

admin/cli/mysql_collation.php

@@ -24,7 +24,7 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__.'/../../config.php');
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
 require_once($CFG->libdir.'/clilib.php');      // cli only functions
 
 if ($DB->get_dbfamily() !== 'mysql') {
@@ -53,7 +53,7 @@ Options:
 -h, --help            Print out this help
 
 Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/mysql_collation.php --collation=utf8mb4_unicode_ci
+\$ sudo -u www-data /usr/bin/php admin/cli/mysql_collation.php --collation=utf8_general_ci
 ";
 
 if (!empty($options['collation'])) {
@@ -64,71 +64,6 @@ if (!empty($options['collation'])) {
         cli_error("Error: collation '$collation' is not available on this server!");
     }
 
-    $collationinfo = explode('_', $collation);
-    $charset = reset($collationinfo);
-
-    $engine = strtolower($DB->get_dbengine());
-
-    // Do checks for utf8mb4.
-    if (strpos($collation, 'utf8mb4') === 0) {
-        // Do we have the right engine?
-        if ($engine !== 'innodb' && $engine !== 'xtradb') {
-            cli_error("Error: '$collation' requires InnoDB or XtraDB set as the engine.");
-        }
-        // Are we using Barracuda?
-        if ($DB->get_row_format() != 'Barracuda') {
-            // Try setting it here.
-            try {
-                $DB->execute("SET GLOBAL innodb_file_format=Barracuda");
-            } catch (dml_exception $e) {
-                cli_error("Error: '$collation' requires the file format to be set to Barracuda.
-                        An attempt was made to change the format, but it failed. Please try doing this manually.");
-            }
-            echo "GLOBAL SETTING: innodb_file_format changed to Barracuda\n";
-        }
-        // Is one file per table being used?
-        if (!$DB->is_file_per_table_enabled()) {
-            try {
-                $DB->execute("SET GLOBAL innodb_file_per_table=1");
-            } catch (dml_exception $e) {
-                cli_error("Error: '$collation' requires the setting 'innodb_file_per_table' be set to 'ON'.
-                        An attempt was made to change the format, but it failed. Please try doing this manually.");
-            }
-            echo "GLOBAL SETTING: innodb_file_per_table changed to 1\n";
-        }
-        // Is large prefix set?
-        if (!$DB->is_large_prefix_enabled()) {
-            try {
-                $DB->execute("SET GLOBAL innodb_large_prefix=1");
-            } catch (dml_exception $e) {
-                cli_error("Error: '$collation' requires the setting 'innodb_large_prefix' be set to 'ON'.
-                        An attempt was made to change the format, but it failed. Please try doing this manually.");
-            }
-            echo "GLOBAL SETTING: innodb_large_prefix changed to 1\n";
-        }
-    }
-
-    $sql = "SHOW VARIABLES LIKE 'collation_database'";
-    if (!$dbcollation = $DB->get_record_sql($sql)) {
-        cli_error("Error: Could not access collation information on the database.");
-    }
-    $sql = "SHOW VARIABLES LIKE 'character_set_database'";
-    if (!$dbcharset = $DB->get_record_sql($sql)) {
-        cli_error("Error: Could not access character set information on the database.");
-    }
-    if ($dbcollation->value !== $collation || $dbcharset->value !== $charset) {
-        // Try to convert the DB.
-        echo "Converting database to '$collation' for $CFG->wwwroot:\n";
-        $sql = "ALTER DATABASE `$CFG->dbname` DEFAULT CHARACTER SET $charset DEFAULT COLLATE = $collation";
-        try {
-            $DB->change_database_structure($sql);
-        } catch (exception $e) {
-            cli_error("Error: Tried to alter the database with no success. Please try manually changing the database
-                    to the new collation and character set and then run this script again.");
-        }
-        echo "DATABASE CONVERTED\n";
-    }
-
     echo "Converting tables and columns to '$collation' for $CFG->wwwroot:\n";
     $prefix = $DB->get_prefix();
     $prefix = str_replace('_', '\\_', $prefix);
@@ -145,25 +80,12 @@ if (!empty($options['collation'])) {
             $skipped++;
 
         } else {
-            try {
-                $DB->change_database_structure("ALTER TABLE `$table->name` CONVERT TO CHARACTER SET $charset COLLATE $collation");
-                echo "CONVERTED\n";
-                $converted++;
-            } catch (ddl_exception $e) {
-                $result = mysql_set_row_format($table->name, $charset, $collation, $engine);
-                if ($result) {
-                    echo "CONVERTED\n";
-                    $converted++;
-                } else {
-                    // We don't know what the problem is. Stop the conversion.
-                    cli_error("Error: Tried to convert $table->name, but there was a problem. Please check the details of this
-                            table and try again.");
-                    die();
-                }
-            }
+            $DB->change_database_structure("ALTER TABLE $table->name DEFAULT COLLATE = $collation");
+            echo "CONVERTED\n";
+            $converted++;
         }
 
-        $sql = "SHOW FULL COLUMNS FROM `$table->name` WHERE collation IS NOT NULL";
+        $sql = "SHOW FULL COLUMNS FROM $table->name WHERE collation IS NOT NULL";
         $rs2 = $DB->get_recordset_sql($sql);
         foreach ($rs2 as $column) {
             $column = (object)array_change_key_case((array)$column, CASE_LOWER);
@@ -174,36 +96,22 @@ if (!empty($options['collation'])) {
                 continue;
             }
 
-            // Check for utf8mb4 collation.
-            $rowformat = $DB->get_row_format_sql($engine, $collation);
-
             if ($column->type === 'tinytext' or $column->type === 'mediumtext' or $column->type === 'text' or $column->type === 'longtext') {
                 $notnull = ($column->null === 'NO') ? 'NOT NULL' : 'NULL';
                 $default = (!is_null($column->default) and $column->default !== '') ? "DEFAULT '$column->default'" : '';
                 // primary, unique and inc are not supported for texts
-                $sql = "ALTER TABLE `$table->name`
-                        MODIFY COLUMN $column->field $column->type
-                        CHARACTER SET $charset
-                        COLLATE $collation $notnull $default";
+                $sql = "ALTER TABLE $table->name MODIFY COLUMN $column->field $column->type COLLATE $collation $notnull $default";
                 $DB->change_database_structure($sql);
 
             } else if (strpos($column->type, 'varchar') === 0) {
                 $notnull = ($column->null === 'NO') ? 'NOT NULL' : 'NULL';
                 $default = !is_null($column->default) ? "DEFAULT '$column->default'" : '';
-
-                if ($rowformat != '') {
-                    $sql = "ALTER TABLE `$table->name` $rowformat";
-                    $DB->change_database_structure($sql);
-                }
-
-                $sql = "ALTER TABLE `$table->name`
-                        MODIFY COLUMN $column->field $column->type
-                        CHARACTER SET $charset
-                        COLLATE $collation $notnull $default";
+                // primary, unique and inc are not supported for texts
+                $sql = "ALTER TABLE $table->name MODIFY COLUMN $column->field $column->type COLLATE $collation $notnull $default";
                 $DB->change_database_structure($sql);
             } else {
                 echo "ERROR (unknown column type: $column->type)\n";
-                $errors++;
+                $error++;
                 continue;
             }
             echo "CONVERTED\n";
@@ -272,9 +180,7 @@ function mysql_get_collations() {
     global $DB;
 
     $collations = array();
-    $sql = "SHOW COLLATION
-            WHERE Collation LIKE 'utf8\_%' AND Charset = 'utf8'
-               OR Collation LIKE 'utf8mb4\_%' AND Charset = 'utf8mb4'";
+    $sql = "SHOW COLLATION WHERE Collation LIKE 'utf8\_%' AND Charset = 'utf8'";
     $rs = $DB->get_recordset_sql($sql);
     foreach ($rs as $collation) {
         $collations[$collation->collation] = $collation->collation;
@@ -303,26 +209,3 @@ function mysql_get_column_collations($tablename) {
     $rs->close();
     return $collations;
 }
-
-function mysql_set_row_format($tablename, $charset, $collation, $engine) {
-    global $DB;
-
-    $sql = "SELECT row_format
-              FROM INFORMATION_SCHEMA.TABLES
-             WHERE table_schema = DATABASE() AND table_name = ?";
-    $rs = $DB->get_record_sql($sql, array($tablename));
-    if ($rs) {
-        if ($rs->row_format == 'Compact' || $rs->row_format == 'Redundant') {
-            $rowformat = $DB->get_row_format_sql($engine, $collation);
-            // Try to convert to compressed format and then try updating the collation again.
-            $DB->change_database_structure("ALTER TABLE `$tablename` $rowformat");
-            $DB->change_database_structure("ALTER TABLE `$tablename` CONVERT TO CHARACTER SET $charset COLLATE $collation");
-        } else {
-            // Row format may not be the problem. Can not diagnose problem. Send fail reply.
-            return false;
-        }
-    } else {
-        return false;
-    }
-    return true;
-}

admin/cli/mysql_compressed_rows.php

@@ -1,202 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * MySQL table row compression tool tool.
- *
- * @package   core
- * @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @author    Petr Skoda <petr.skoda@totaralms.com>
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__.'/../../config.php');
-require_once($CFG->libdir . '/clilib.php');
-
-if ($DB->get_dbfamily() !== 'mysql') {
-    cli_error('This script is used for MySQL databases only.');
-}
-
-$engine = strtolower($DB->get_dbengine());
-if ($engine !== 'innodb' and $engine !== 'xtradb') {
-    cli_error('This script is for MySQL servers using InnoDB or XtraDB engines only.');
-}
-
-list($options, $unrecognized) = cli_get_params(
-    array('help' => false, 'info' => false, 'list' => false, 'fix' => false, 'showsql' => false),
-    array('h' => 'help', 'i' => 'info', 'l' => 'list', 'f' => 'fix', 's' => 'showsql')
-);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-$help =
-    "Script for detection of row size problems in MySQL InnoDB tables.
-
-By default InnoDB storage table is using legacy Antelope file format
-which has major restriction on database row size.
-Use this script to detect and fix database tables with potential data
-overflow problems.
-
-Options:
--i, --info            Show database information
--l, --list            List problematic tables
--f, --fix             Attempt to fix all tables (requires SUPER privilege)
--s, --showsql         Print SQL statements for fixing of tables
--h, --help            Print out this help
-
-Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/mysql_compressed_rows.php -l
-";
-
-/** @var mysql_sql_generator $generator */
-$generator = $DB->get_manager()->generator;
-
-$info = $DB->get_server_info();
-$filepertable = $DB->get_record_sql("SHOW VARIABLES LIKE 'innodb_file_per_table'");
-$filepertable = $filepertable ? $filepertable->value : '';
-$fileformat = $DB->get_record_sql("SHOW VARIABLES LIKE 'innodb_file_format'");
-$fileformat = $fileformat ? $fileformat->value : '';
-$prefix = $DB->get_prefix();
-$database = $CFG->dbname;
-
-if (!empty($options['info'])) {
-    echo "Database version:      " . $info['description'] . "\n";
-    echo "Database name:         $database\n";
-    echo "Database engine:       " . $DB->get_dbengine() . "\n";
-    echo "innodb_file_per_table: $filepertable\n";
-    echo "innodb_file_format:    $fileformat\n";
-
-    exit(0);
-
-} else if (!empty($options['list'])) {
-    $problem = false;
-    foreach ($DB->get_tables(false) as $table) {
-        $columns = $DB->get_columns($table, false);
-        $size = $generator->guess_antelope_row_size($columns);
-        $format = $DB->get_row_format($table);
-        if ($size <= $generator::ANTELOPE_MAX_ROW_SIZE) {
-            continue;
-        }
-
-        echo str_pad($prefix . $table, 32, ' ', STR_PAD_RIGHT);
-        echo str_pad($format, 11, ' ', STR_PAD_RIGHT);
-
-        if ($format === 'Compact' or $format === 'Redundant') {
-            $problem = true;
-            echo " (needs fixing)\n";
-
-        } else if ($format !== 'Compressed' and $format !== 'Dynamic') {
-            echo " (unknown)\n";
-
-        } else {
-            echo "\n";
-        }
-    }
-
-    if ($problem) {
-        exit(1);
-    }
-    exit(0);
-
-} else if (!empty($options['fix'])) {
-    $fixtables = array();
-    foreach ($DB->get_tables(false) as $table) {
-        $columns = $DB->get_columns($table, false);
-        $size = $generator->guess_antelope_row_size($columns);
-        $format = $DB->get_row_format($table);
-        if ($size <= $generator::ANTELOPE_MAX_ROW_SIZE) {
-            continue;
-        }
-        if ($format === 'Compact' or $format === 'Redundant') {
-            $fixtables[$table] = $table;
-        }
-    }
-
-    if (!$fixtables) {
-        echo "No changes necessary\n";
-        exit(0);
-    }
-
-    if ($filepertable !== 'ON') {
-        try {
-            $DB->execute("SET GLOBAL innodb_file_per_table=1");
-        } catch (dml_exception $e) {
-            echo "Cannot enable GLOBAL innodb_file_per_table setting, use --showsql option and execute the statements manually.";
-            throw $e;
-        }
-    }
-    if ($fileformat !== 'Barracuda') {
-        try {
-            $DB->execute("SET GLOBAL innodb_file_format=Barracuda");
-        } catch (dml_exception $e) {
-            echo "Cannot change GLOBAL innodb_file_format setting, use --showsql option and execute the statements manually.";
-            throw $e;
-        }
-    }
-
-    if (!$DB->is_compressed_row_format_supported(false)) {
-        echo "MySQL server is not compatible with compressed row format.";
-        exit(1);
-    }
-
-    foreach ($fixtables as $table) {
-        $DB->change_database_structure("ALTER TABLE `{$prefix}$table` ROW_FORMAT=Compressed");
-        echo str_pad($prefix . $table, 32, ' ', STR_PAD_RIGHT) . " ... Compressed\n";
-    }
-
-    exit(0);
-
-} else if (!empty($options['showsql'])) {
-    $fixtables = array();
-
-    foreach ($DB->get_tables(false) as $table) {
-        $columns = $DB->get_columns($table, false);
-        $size = $generator->guess_antelope_row_size($columns);
-        $format = $DB->get_row_format($table);
-        if ($size <= $generator::ANTELOPE_MAX_ROW_SIZE) {
-            continue;
-        }
-        if ($format === 'Compact' or $format === 'Redundant') {
-            $fixtables[$table] = $table;
-        }
-    }
-    if (!$fixtables) {
-        echo "No changes necessary\n";
-        exit(0);
-    }
-
-    echo "Copy the following SQL statements and execute them using account with SUPER privilege:\n\n";
-    echo "USE $database;\n";
-    echo "SET SESSION sql_mode=STRICT_ALL_TABLES;\n";
-    echo "SET GLOBAL innodb_file_per_table=1;\n";
-    echo "SET GLOBAL innodb_file_format=Barracuda;\n";
-    foreach ($fixtables as $table) {
-        echo "ALTER TABLE `{$prefix}$table` ROW_FORMAT=Compressed;\n";
-    }
-    echo "\n";
-    exit(0);
-
-} else {
-    echo $help;
-    die;
-}
-
-

admin/cli/mysql_engine.php

@@ -0,0 +1,121 @@
+<?php
+
+// 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 <http://www.gnu.org/licenses/>.
+
+/**
+ * MySQL engine conversion tool.
+ *
+ * @package    core
+ * @subpackage cli
+ * @copyright  2009 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+define('CLI_SCRIPT', true);
+
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
+require_once($CFG->libdir.'/clilib.php');      // cli only functions
+
+if ($DB->get_dbfamily() !== 'mysql') {
+    cli_error('This function is designed for MySQL databases only!');
+}
+
+// now get cli options
+list($options, $unrecognized) = cli_get_params(array('help'=>false, 'list'=>false, 'engine'=>false),
+                                               array('h'=>'help', 'l'=>'list'));
+
+if ($unrecognized) {
+    $unrecognized = implode("\n  ", $unrecognized);
+    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
+}
+
+$help =
+"MySQL engine conversions script.
+
+It is recommended to stop the web server before the conversion.
+Do not use MyISAM if possible, because it is not ACID compliant
+and does not support transactions.
+
+Options:
+--engine=ENGINE       Convert MySQL tables to different engine
+-l, --list            Show table information
+-h, --help            Print out this help
+
+Example:
+\$sudo -u www-data /usr/bin/php admin/cli/mysql_engine.php --engine=InnoDB
+";
+
+if (!empty($options['engine'])) {
+    $engine = clean_param($options['engine'], PARAM_ALPHA);
+
+    echo "Converting tables to '$engine' for $CFG->wwwroot:\n";
+    $prefix = $DB->get_prefix();
+    $prefix = str_replace('_', '\\_', $prefix);
+    $sql = "SHOW TABLE STATUS WHERE Name LIKE BINARY '$prefix%'";
+    $rs = $DB->get_recordset_sql($sql);
+    $converted = 0;
+    $skipped   = 0;
+    foreach ($rs as $table) {
+        if ($table->engine === $engine) {
+            echo str_pad($table->name, 40). " - NO CONVERSION NEEDED\n";
+            $skipped++;
+            continue;
+        }
+        echo str_pad($table->name, 40). " - ";
+
+        try {
+            $DB->change_database_structure("ALTER TABLE {$table->name} ENGINE = $engine");
+        } catch (moodle_exception $e) {
+            echo $e->getMessage()."\n";
+            $skipped++;
+            continue;
+        }
+        echo "DONE\n";
+        $converted++;
+    }
+    $rs->close();
+    echo "Converted: $converted, skipped: $skipped\n";
+    exit(0); // success
+
+} else if (!empty($options['list'])) {
+    echo "List of tables for $CFG->wwwroot:\n";
+    $prefix = $DB->get_prefix();
+    $prefix = str_replace('_', '\\_', $prefix);
+    $sql = "SHOW TABLE STATUS WHERE Name LIKE BINARY '$prefix%'";
+    $rs = $DB->get_recordset_sql($sql);
+    $counts = array();
+    foreach ($rs as $table) {
+        if (isset($counts[$table->engine])) {
+            $counts[$table->engine]++;
+        } else {
+            $counts[$table->engine] = 1;
+        }
+        echo str_pad($table->engine, 10);
+        echo $table->name .  "\n";
+    }
+    $rs->close();
+
+    echo "\n";
+    echo "Table engines summary for $CFG->wwwroot:\n";
+    foreach ($counts as $engine => $count) {
+        echo "$engine: $count\n";
+    }
+    exit(0); // success
+
+} else {
+    echo $help;
+    die;
+}

admin/cli/purge_caches.php

@@ -15,8 +15,6 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * CLI script to purge caches without asking for confirmation.
- *
  * @package    core
  * @subpackage cli
  * @copyright  2011 David Mudrak <david@moodle.com>
@@ -25,19 +23,10 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__.'/../../config.php');
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
 require_once($CFG->libdir.'/clilib.php');
 
-$longoptions = [
-    'help' => false,
-    'muc' => false,
-    'theme' => false,
-    'lang' => false,
-    'js' => false,
-    'filter' => false,
-    'other' => false
-];
-list($options, $unrecognized) = cli_get_params($longoptions, ['h' => 'help']);
+list($options, $unrecognized) = cli_get_params(array('help' => false), array('h' => 'help'));
 
 if ($unrecognized) {
     $unrecognized = implode("\n  ", $unrecognized);
@@ -45,32 +34,20 @@ if ($unrecognized) {
 }
 
 if ($options['help']) {
-    // The indentation of this string is "wrong" but this is to avoid a extra whitespace in console output.
-    $help = <<<EOF
-Invalidates Moodle internal caches
-
-Specific caches can be defined (alone or in combination) using arguments. If none are specified,
-all caches will be purged.
+    $help =
+"Invalidates all Moodle internal caches
 
 Options:
 -h, --help            Print out this help
-    --muc             Purge all MUC caches (includes lang cache)
-    --theme           Purge theme cache
-    --lang            Purge language string cache
-    --js              Purge JavaScript cache
-    --filter          Purge text filter cache
-    --other           Purge all file caches and other miscellaneous caches (may include MUC
-                      if using cachestore_file).
 
 Example:
-\$ sudo -u www-data /usr/bin/php admin/cli/purge_caches.php
-
-EOF;
+\$sudo -u www-data /usr/bin/php admin/cli/purge_caches.php
+";
 
     echo $help;
     exit(0);
 }
 
-purge_caches(array_filter($options));
+purge_all_caches();
 
-exit(0);
+exit(0);

admin/cli/reset_password.php

@@ -26,26 +26,13 @@
 
 define('CLI_SCRIPT', true);
 
-require(__DIR__.'/../../config.php');
+require(dirname(dirname(dirname(__FILE__))).'/config.php');
 require_once($CFG->libdir.'/clilib.php');      // cli only functions
 
-// Define the input options.
-$longparams = array(
-        'help' => false,
-        'username' => '',
-        'password' => '',
-        'ignore-password-policy' => false
-);
-
-$shortparams = array(
-        'h' => 'help',
-        'u' => 'username',
-        'p' => 'password',
-        'i' => 'ignore-password-policy'
-);
 
 // now get cli options
-list($options, $unrecognized) = cli_get_params($longparams, $shortparams);
+list($options, $unrecognized) = cli_get_params(array('help'=>false),
+                                               array('h'=>'help'));
 
 if ($unrecognized) {
     $unrecognized = implode("\n  ", $unrecognized);
@@ -60,43 +47,29 @@ There are no security checks here because anybody who is able to
 execute this file may execute any PHP too.
 
 Options:
--h, --help                    Print out this help
--u, --username=username       Specify username to change
--p, --password=newpassword    Specify new password
---ignore-password-policy      Ignore password policy when setting password
+-h, --help            Print out this help
 
 Example:
 \$sudo -u www-data /usr/bin/php admin/cli/reset_password.php
-\$sudo -u www-data /usr/bin/php admin/cli/reset_password.php --username=rosaura --password=jiu3jiu --ignore-password-policy
-";
+"; //TODO: localize - to be translated later when everything is finished
 
     echo $help;
     die;
 }
-if ($options['username'] == '' ) {
-    cli_heading('Password reset');
-    $prompt = "Enter username (manual authentication only)";
-    $username = cli_input($prompt);
-} else {
-    $username = $options['username'];
-}
+cli_heading('Password reset'); // TODO: localize
+$prompt = "enter username (manual authentication only)"; // TODO: localize
+$username = cli_input($prompt);
 
 if (!$user = $DB->get_record('user', array('auth'=>'manual', 'username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id))) {
     cli_error("Can not find user '$username'");
 }
 
-if ($options['password'] == '' ) {
-    $prompt = "Enter new password";
-    $password = cli_input($prompt);
-} else {
-    $password = $options['password'];
-}
+$prompt = "Enter new password"; // TODO: localize
+$password = cli_input($prompt);
 
 $errmsg = '';//prevent eclipse warning
-if (!$options['ignore-password-policy'] ) {
-    if (!check_password_policy($password, $errmsg, $user)) {
-        cli_error(html_to_text($errmsg, 0));
-    }
+if (!check_password_policy($password, $errmsg)) {
+    cli_error($errmsg);
 }
 
 $hashedpassword = hash_internal_user_password($password);
@@ -105,4 +78,4 @@ $DB->set_field('user', 'password', $hashedpassword, array('id'=>$user->id));
 
 echo "Password changed\n";
 
-exit(0); // 0 means success.
+exit(0); // 0 means success

admin/cli/restore_backup.php

@@ -1,109 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * This script allows to restore a course from CLI.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2020 Catalyst IT
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', 1);
-
-require(__DIR__ . '/../../config.php');
-require_once($CFG->libdir . '/clilib.php');
-require_once($CFG->dirroot . "/backup/util/includes/restore_includes.php");
-
-list($options, $unrecognized) = cli_get_params([
-    'file' => '',
-    'categoryid' => '',
-    'showdebugging' => false,
-    'help' => false,
-], [
-    'f' => 'file',
-    'c' => 'categoryid',
-    's' => 'showdebugging',
-    'h' => 'help',
-]);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help'] || !($options['file']) || !($options['categoryid'])) {
-    $help = <<<EOL
-Restore backup into provided category.
-
-Options:
--f, --file=STRING           Path to the backup file.
--c, --categoryid=INT        ID of the category to restore too.
--s, --showdebugging         Show developer level debugging information
--h, --help                  Print out this help.
-
-Example:
-\$sudo -u www-data /usr/bin/php admin/cli/restore_backup.php --file=/path/to/backup/file.mbz --categoryid=1\n
-EOL;
-
-    echo $help;
-    exit(0);
-}
-
-if ($options['showdebugging']) {
-    set_debugging(DEBUG_DEVELOPER, true);
-}
-
-if (!$admin = get_admin()) {
-    throw new \moodle_exception('noadmins');
-}
-
-if (!file_exists($options['file'])) {
-    throw new \moodle_exception('filenotfound');
-}
-
-if (!$category = $DB->get_record('course_categories', ['id' => $options['categoryid']], 'id')) {
-    throw new \moodle_exception('invalidcategoryid');
-}
-
-$backupdir = "restore_" . uniqid();
-$path = $CFG->tempdir . DIRECTORY_SEPARATOR . "backup" . DIRECTORY_SEPARATOR . $backupdir;
-
-cli_heading(get_string('extractingbackupfileto', 'backup', $path));
-$fp = get_file_packer('application/vnd.moodle.backup');
-$fp->extract_to_pathname($options['file'], $path);
-
-cli_heading(get_string('preprocessingbackupfile'));
-try {
-    list($fullname, $shortname) = restore_dbops::calculate_course_names(0, get_string('restoringcourse', 'backup'),
-        get_string('restoringcourseshortname', 'backup'));
-
-    $courseid = restore_dbops::create_new_course($fullname, $shortname, $category->id);
-
-    $rc = new restore_controller($backupdir, $courseid, backup::INTERACTIVE_NO,
-        backup::MODE_GENERAL, $admin->id, backup::TARGET_NEW_COURSE);
-    $rc->execute_precheck();
-    $rc->execute_plan();
-    $rc->destroy();
-} catch (Exception $e) {
-    cli_heading(get_string('cleaningtempdata'));
-    fulldelete($path);
-    throw new \moodle_exception('generalexceptionmessage', 'error', '', $e->getMessage());
-}
-
-cli_heading(get_string('restoredcourseid', 'backup', $courseid));
-exit(0);

admin/cli/scheduled_task.php

@@ -1,167 +0,0 @@
-<?php
-// 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 <http://www.gnu.org/licenses/>.
-
-/**
- * CLI task execution.
- *
- * @package    core
- * @subpackage cli
- * @copyright  2014 Petr Skoda
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-define('CLI_SCRIPT', true);
-
-require(__DIR__ . '/../../config.php');
-require_once("$CFG->libdir/clilib.php");
-
-list($options, $unrecognized) = cli_get_params(
-    [
-        'help' => false,
-        'list' => false,
-        'execute' => false,
-        'showsql' => false,
-        'showdebugging' => false,
-        'force' => false,
-    ], [
-        'h' => 'help',
-        'f' => 'force',
-    ]
-);
-
-if ($unrecognized) {
-    $unrecognized = implode("\n  ", $unrecognized);
-    cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
-}
-
-if ($options['help'] or (!$options['list'] and !$options['execute'])) {
-    $help =
-    "Scheduled cron tasks.
-
-    Options:
-    --execute=\\some\\task  Execute scheduled task manually
-    --list                List all scheduled tasks
-    --showsql             Show sql queries before they are executed
-    --showdebugging       Show developer level debugging information
-    -h, --help            Print out this help
-    -f, --force           Execute task even if cron is disabled
-
-    Example:
-    \$sudo -u www-data /usr/bin/php admin/cli/scheduled_task.php --execute=\\core\\task\\session_cleanup_task
-
-    ";
-
-    echo $help;
-    die;
-}
-
-if ($options['showdebugging'] || !empty($CFG->showcrondebugging)) {
-    set_debugging(DEBUG_DEVELOPER, true);
-}
-
-if ($options['showsql'] || !empty($CFG->showcronsql)) {
-    $DB->set_debug(true);
-}
-if ($options['list']) {
-    cli_heading("List of scheduled tasks ($CFG->wwwroot)");
-
-    $shorttime = get_string('strftimedatetimeshort');
-
-    $tasks = \core\task\manager::get_all_scheduled_tasks();
-    echo str_pad(get_string('scheduledtasks', 'tool_task'), 50, ' ') . ' ' . str_pad(get_string('runpattern', 'tool_task'), 17, ' ')
-        . ' ' . str_pad(get_string('lastruntime', 'tool_task'), 40, ' ') . get_string('nextruntime', 'tool_task') . "\n";
-    foreach ($tasks as $task) {
-        $class = '\\' . get_class($task);
-        $schedule = $task->get_minute() . ' '
-            . $task->get_hour() . ' '
-            . $task->get_day() . ' '
-            . $task->get_day_of_week() . ' '
-            . $task->get_month() . ' '
-            . $task->get_day_of_week();
-        $nextrun = $task->get_next_run_time();
-        $lastrun = $task->get_last_run_time();
-
-        $plugininfo = core_plugin_manager::instance()->get_plugin_info($task->get_component());
-        $plugindisabled = $plugininfo && $plugininfo->is_enabled() === false && !$task->get_run_if_component_disabled();
-
-        if ($plugindisabled) {
-            $nextrun = get_string('plugindisabled', 'tool_task');
-        } else if ($task->get_disabled()) {
-            $nextrun = get_string('taskdisabled', 'tool_task');
-        } else if ($nextrun > time()) {
-            $nextrun = userdate($nextrun);
-        } else {
-            $nextrun = get_string('asap', 'tool_task');
-        }
-
-        if ($lastrun) {
-            $lastrun = userdate($lastrun);
-        } else {
-            $lastrun = get_string('never');
-        }
-
-        echo str_pad($class, 50, ' ') . ' ' . str_pad($schedule, 17, ' ') .
-            ' ' . str_pad($lastrun, 40, ' ') . ' ' . $nextrun . "\n";
-    }
-    exit(0);
-}
-
-if ($execute = $options['execute']) {
-    if (!$task = \core\task\manager::get_scheduled_task($execute)) {
-        mtrace("Task '$execute' not found");
-        exit(1);
-    }
-
-    if (moodle_needs_upgrading()) {
-        mtrace("Moodle upgrade pending, cannot execute tasks.");
-        exit(1);
-    }
-
-    if (!get_config('core', 'cron_enabled') && !$options['force']) {
-        mtrace('Cron is disabled. Use --force to override.');
-        exit(1);
-    }
-
-    \core\task\manager::scheduled_task_starting($task);
-
-    // Increase memory limit.
-    raise_memory_limit(MEMORY_EXTRA);
-
-    // Emulate normal session - we use admin account by default.
-    \core\cron::setup_user();
-
-    // Execute the task.
-    \core\local\cli\shutdown::script_supports_graceful_exit();
-    $cronlockfactory = \core\lock\lock_config::get_lock_factory('cron');
-    if (!$cronlock = $cronlockfactory->get_lock('core_cron', 10)) {
-        mtrace('Cannot obtain cron lock');
-        exit(129);
-    }
-    if (!$lock = $cronlockfactory->get_lock('\\' . get_class($task), 10)) {
-        $cronlock->release();
-        mtrace('Cannot obtain task lock');
-        exit(130);
-    }
-
-    $task->set_lock($lock);
-    if (!$task->is_blocking()) {
-        $cronlock->release();
-    } else {
-        $task->set_cron_lock($cronlock);
-    }
-
-    \core\cron::run_inner_scheduled_task($task);
-}