/lib/plagiarismlib.php
PHP | 219 lines | 132 code | 13 blank | 74 comment | 18 complexity | 4e67fa9ef31c07a91b1d11dcfb4cb29f MD5 | raw file
Possible License(s): MIT, AGPL-3.0, MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, Apache-2.0, LGPL-2.1, BSD-3-Clause
- <?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/>.
- /**
- * plagiarismlib.php - Contains core Plagiarism related functions.
- *
- * @since Moodle 2.0
- * @package core
- * @subpackage plagiarism
- * @copyright 2010 Dan Marsden http://danmarsden.com
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- if (!defined('MOODLE_INTERNAL')) {
- die('Direct access to this script is forbidden.');
- }
- /**
- * displays the similarity score and provides a link to the full report if allowed.
- *
- * @param object $linkarray contains all relevant information for the plugin to generate a link
- * @return string - url to allow login/viewing of a similarity report
- */
- function plagiarism_get_links($linkarray) {
- global $CFG;
- if (empty($CFG->enableplagiarism)) {
- return '';
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- $output = '';
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $output .= $plagiarismplugin->get_links($linkarray);
- }
- return $output;
- }
- /**
- * returns array of plagiarism details about specified file
- *
- * @param int $cmid
- * @param int $userid
- * @param object $file moodle file object
- * @return array - sets of details about specified file, one array of details per plagiarism plugin
- * - each set contains at least 'analyzed', 'score', 'reporturl'
- */
- function plagiarism_get_file_results($cmid, $userid, $file) {
- global $CFG;
- $allresults = array();
- if (empty($CFG->enableplagiarism)) {
- return $allresults;
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $allresults[] = $plagiarismplugin->get_file_results($cmid, $userid, $file);
- }
- return $allresults;
- }
- /**
- * saves/updates plagiarism settings from a modules config page - called by course/modedit.php
- *
- * @deprecated Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_edit_post_actions() instead.
- * @todo MDL-67526 This is to be moved from here to deprecatedlib.php in Moodle 4.3
- * @param object $data - form data
- */
- function plagiarism_save_form_elements($data) {
- global $CFG;
- if (empty($CFG->enableplagiarism)) {
- return '';
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $reflectionmethod = new ReflectionMethod($plagiarismplugin, 'save_form_elements');
- if ($reflectionmethod->getDeclaringClass()->getName() == get_class($plagiarismplugin)) {
- $text = 'plagiarism_plugin::save_form_elements() is deprecated.';
- $text .= ' Use plagiarism_' . $plugin . '_coursemodule_edit_post_actions() instead';
- debugging($text, DEBUG_DEVELOPER);
- }
- $plagiarismplugin->save_form_elements($data);
- }
- }
- /**
- * adds the list of plagiarism settings to a form - called inside modules that have enabled plagiarism
- *
- * @deprecated Since Moodle 3.9. MDL-65835 Please use {plugin name}_coursemodule_standard_elements() instead.
- * @todo MDL-67526 This is to be moved from here to deprecatedlib.php in Moodle 4.3
- * @param object $mform - Moodle form object
- * @param object $context - context object
- * @param string $modulename - Name of the module
- */
- function plagiarism_get_form_elements_module($mform, $context, $modulename = "") {
- global $CFG;
- if (empty($CFG->enableplagiarism)) {
- return '';
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $reflectionmethod = new ReflectionMethod($plagiarismplugin, 'get_form_elements_module');
- if ($reflectionmethod->getDeclaringClass()->getName() == get_class($plagiarismplugin)) {
- $text = 'plagiarism_plugin::get_form_elements_module() is deprecated.';
- $text .= ' Use plagiarism_' . $plugin . '_coursemodule_standard_elements() instead';
- debugging($text, DEBUG_DEVELOPER);
- }
- $plagiarismplugin->get_form_elements_module($mform, $context, $modulename);
- }
- }
- /**
- * updates the status of all files within a module
- *
- * @param object $course - full Course object
- * @param object $cm - full cm object
- * @return string
- */
- function plagiarism_update_status($course, $cm) {
- global $CFG;
- if (empty($CFG->enableplagiarism)) {
- return '';
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- $output = '';
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $output .= $plagiarismplugin->update_status($course, $cm);
- }
- return $output;
- }
- /**
- * Function that prints the student disclosure notifying that the files will be checked for plagiarism
- * @param integer $cmid - the cmid of this module
- * @return string
- */
- function plagiarism_print_disclosure($cmid) {
- global $CFG;
- if (empty($CFG->enableplagiarism)) {
- return '';
- }
- $plagiarismplugins = plagiarism_load_available_plugins();
- $output = '';
- foreach ($plagiarismplugins as $plugin => $dir) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- $plagiarismplugin = new $plagiarismclass;
- $output .= $plagiarismplugin->print_disclosure($cmid);
- }
- return $output;
- }
- /**
- * Helper function - also loads lib file of plagiarism plugin
- *
- * @todo MDL-67872 the deprecated code in this function to be removed in Moodle 4.3
- * @return array of available plugins
- */
- function plagiarism_load_available_plugins() {
- global $CFG;
- static $showndeprecatedmessage = array(); // Only show message once per page load.
- if (empty($CFG->enableplagiarism)) {
- return array();
- }
- $plagiarismplugins = core_component::get_plugin_list('plagiarism');
- $availableplugins = array();
- foreach ($plagiarismplugins as $plugin => $dir) {
- // Check this plugin is enabled and a lib file exists.
- if (get_config('plagiarism', $plugin."_use")) {
- // Deprecated Since Moodle 3.9.
- $pluginenabled = true;
- if (empty($showndeprecatedmessage[$plugin])) {
- $text = 'The setting plagiarism:'.$plugin.'_use is deprecated.';
- $text .= ' Use plagiarism_' . $plugin . ':enabled instead';
- debugging($text, DEBUG_DEVELOPER);
- $showndeprecatedmessage[$plugin] = true;
- }
- } else {
- $pluginenabled = get_config('plagiarism_'.$plugin, 'enabled');
- }
- if ($pluginenabled && file_exists($dir."/lib.php")) {
- require_once($dir.'/lib.php');
- $plagiarismclass = "plagiarism_plugin_$plugin";
- if (class_exists($plagiarismclass)) {
- $availableplugins[$plugin] = $dir;
- }
- }
- }
- return $availableplugins;
- }