Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * Defines classes used for plugin info.
 *
 * @package    core_antivirus
 * @copyright  2015 Ruslan Kabalin, Lancaster University.
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
namespace core\plugininfo;

use moodle_url, part_of_admin_tree, admin_settingpage;

defined('MOODLE_INTERNAL') || die();


/**
 * Class for Antiviruses
 *
 * @package    core_antivirus
 * @copyright  2015 Ruslan Kabalin, Lancaster University.
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class antivirus extends base {
    /**
     * Finds all enabled plugins, the result may include missing plugins.
     * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
     */
    public static function get_enabled_plugins() {
        global $CFG;

        if (empty($CFG->antiviruses)) {
            return array();
        }

        $enabled = array();
        foreach (explode(',', $CFG->antiviruses) as $antivirus) {
            $enabled[$antivirus] = $antivirus;
        }

        return $enabled;
    }

> public static function enable_plugin(string $pluginname, int $enabled): bool { /** > global $CFG; * Return the node name to use in admin settings menu for this plugin. > * > $haschanged = false; * @return string node name > $plugins = []; */ > if (!empty($CFG->antiviruses)) { public function get_settings_section_name() { > $plugins = array_flip(explode(',', $CFG->antiviruses)); return 'antivirussettings' . $this->name; > } } > // Only set visibility if it's different from the current value. > if ($enabled && !array_key_exists($pluginname, $plugins)) { /** > $plugins[$pluginname] = $pluginname; * Loads plugin settings to the settings tree > $haschanged = true; * > } else if (!$enabled && array_key_exists($pluginname, $plugins)) { * This function usually includes settings.php file in plugins folder. > unset($plugins[$pluginname]); * Alternatively it can create a link to some settings page (instance of admin_externalpage) > $haschanged = true; * > } * @param \part_of_admin_tree $adminroot > * @param string $parentnodename > if ($haschanged) { * @param bool $hassiteconfig whether the current user has moodle/site:config capability > $new = implode(',', array_flip($plugins)); */ > add_to_config_log('antiviruses', $CFG->antiviruses, $new, 'core'); public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) { > set_config('antiviruses', $new); global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them. > // Reset caches. $ADMIN = $adminroot; // May be used in settings.php. > \core_plugin_manager::reset_caches(); $plugininfo = $this; // Also can be used inside settings.php. > } $antivirus = $this; // Also can be used inside settings.php. > > return $haschanged; if (!$this->is_installed_and_upgraded()) { > } return; >
} if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) { return; } $section = $this->get_settings_section_name(); $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false); include($this->full_path('settings.php')); // This may also set $settings to null. if ($settings) { $ADMIN->add($parentnodename, $settings); } } /** * Clamav antivirus can not be uninstalled. */ public function is_uninstall_allowed() { if ($this->name === 'clamav') { return false; } else { return true; } } /** * Return URL used for management of plugins of this type. * @return moodle_url */ public static function get_manage_url() { return new moodle_url('/admin/settings.php', array('section' => 'manageantiviruses')); } /** * Pre-uninstall hook. */ public function uninstall_cleanup() { global $CFG; if (!empty($CFG->antiviruses)) { $antiviruses = explode(',', $CFG->antiviruses); $antiviruses = array_unique($antiviruses); } else { $antiviruses = array(); } if (($key = array_search($this->name, $antiviruses)) !== false) { unset($antiviruses[$key]); set_config('antiviruses', implode(',', $antiviruses)); } parent::uninstall_cleanup(); } }