lib/plagiarismlib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * plagiarismlib.php - Contains core Plagiarism related functions.
  20  *
  21  * @since 2.0
  22  * @package    moodlecore
  23  * @subpackage plagiarism
  24  * @copyright  2010 Dan Marsden http://danmarsden.com
  25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 ///// GENERIC PLAGIARISM FUNCTIONS ////////////////////////////////////////////////////
  29
  30 if (!defined('MOODLE_INTERNAL')) {
  31     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  32 }
  33
  34 /**
  35  * displays the similarity score and provides a link to the full report if allowed.
  36  *
  37  * @param object  $linkarray contains all relevant information for the plugin to generate a link
  38  * @return string - url to allow login/viewing of a similarity report
  39  */
  40 function plagiarism_get_links($linkarray) {
  41     global $CFG;
  42     if (empty($CFG->enableplagiarism)) {
  43         return '';
  44     }
  45     $plagiarismplugins = plagiarism_load_available_plugins();
  46     $output = '';
  47     foreach($plagiarismplugins as $plugin => $dir) {
  48         require_once($dir.'/lib.php');
  49         $plagiarismclass = "plagiarism_plugin_$plugin";
  50         $plagiarismplugin = new $plagiarismclass;
  51         $output .= $plagiarismplugin->get_links($linkarray);
  52     }
  53     return $output;
  54 }
  55
  56 /**
  57  * returns array of plagiarism details about specified file
  58  *
  59  * @param int $cmid
  60  * @param int $userid
  61  * @param object $file moodle file object
  62  * @return array - sets of details about specified file, one array of details per plagiarism plugin
  63  *  - each set contains at least 'analyzed', 'score', 'reporturl'
  64  */
  65 function plagiarism_get_file_results($cmid, $userid, $file) {
  66     global $CFG;
  67     $allresults = array();
  68     if (empty($CFG->enableplagiarism)) {
  69         return $allresults;
  70     }
  71     $plagiarismplugins = plagiarism_load_available_plugins();
  72     foreach($plagiarismplugins as $plugin => $dir) {
  73         require_once($dir.'/lib.php');
  74         $plagiarismclass = "plagiarism_plugin_$plugin";
  75         $plagiarismplugin = new $plagiarismclass;
  76         $allresults[] = $plagiarismplugin->get_file_results($cmid, $userid, $file);
  77     }
  78     return $allresults;
  79 }
  80
  81 /**
  82  * saves/updates plagiarism settings from a modules config page - called by course/modedit.php
  83  *
  84  * @param object $data - form data
  85  */
  86 function plagiarism_save_form_elements($data) {
  87     global $CFG;
  88     if (empty($CFG->enableplagiarism)) {
  89         return '';
  90     }
  91     $plagiarismplugins = plagiarism_load_available_plugins();
  92     foreach($plagiarismplugins as $plugin => $dir) {
  93         require_once($dir.'/lib.php');
  94         $plagiarismclass = "plagiarism_plugin_$plugin";
  95         $plagiarismplugin = new $plagiarismclass;
  96         $plagiarismplugin->save_form_elements($data);
  97     }
  98 }
  99
 100 /**
 101  * adds the list of plagiarism settings to a form - called inside modules that have enabled plagiarism
 102  *
 103  * @param object $mform - Moodle form object
 104  * @param object $context - context object
 105  */
 106 function plagiarism_get_form_elements_module($mform, $context) {
 107     global $CFG;
 108     if (empty($CFG->enableplagiarism)) {
 109         return '';
 110     }
 111     $plagiarismplugins = plagiarism_load_available_plugins();
 112     foreach($plagiarismplugins as $plugin => $dir) {
 113         require_once($dir.'/lib.php');
 114         $plagiarismclass = "plagiarism_plugin_$plugin";
 115         $plagiarismplugin = new $plagiarismclass;
 116         $plagiarismplugin->get_form_elements_module($mform, $context);
 117     }
 118 }
 119 /**
 120  * updates the status of all files within a module
 121  *
 122  * @param object $course - full Course object
 123  * @param object $cm - full cm object
 124  * @return string
 125  */
 126 function plagiarism_update_status($course, $cm) {
 127     global $CFG;
 128     if (empty($CFG->enableplagiarism)) {
 129         return '';
 130     }
 131     $plagiarismplugins = plagiarism_load_available_plugins();
 132     $output = '';
 133     foreach($plagiarismplugins as $plugin => $dir) {
 134         require_once($dir.'/lib.php');
 135         $plagiarismclass = "plagiarism_plugin_$plugin";
 136         $plagiarismplugin = new $plagiarismclass;
 137         $output .= $plagiarismplugin->update_status($course, $cm);
 138     }
 139     return $output;
 140 }
 141
 142 /**
 143 * Function that prints the student disclosure notifying that the files will be checked for plagiarism
 144 * @param integer $cmid - the cmid of this module
 145 * @return string
 146 */
 147 function plagiarism_print_disclosure($cmid) {
 148     global $CFG;
 149     if (empty($CFG->enableplagiarism)) {
 150         return '';
 151     }
 152     $plagiarismplugins = plagiarism_load_available_plugins();
 153     $output = '';
 154     foreach($plagiarismplugins as $plugin => $dir) {
 155         require_once($dir.'/lib.php');
 156         $plagiarismclass = "plagiarism_plugin_$plugin";
 157         $plagiarismplugin = new $plagiarismclass;
 158         $output .= $plagiarismplugin->print_disclosure($cmid);
 159     }
 160     return $output;
 161 }
 162 /**
 163  * used by admin/cron.php to get similarity scores from submitted files.
 164  *
 165  */
 166 function plagiarism_cron() {
 167     global $CFG;
 168     if (empty($CFG->enableplagiarism)) {
 169         return '';
 170     }
 171     $plagiarismplugins = plagiarism_load_available_plugins();
 172     foreach($plagiarismplugins as $plugin => $dir) {
 173         require_once($dir.'/lib.php');
 174         $plagiarismclass = "plagiarism_plugin_$plugin";
 175         $plagiarismplugin = new $plagiarismclass;
 176         $plagiarismplugin->cron();
 177     }
 178 }
 179 /**
 180  * helper function - also loads lib file of plagiarism plugin
 181  * @return array of available plugins
 182  */
 183 function plagiarism_load_available_plugins() {
 184     global $CFG;
 185     if (empty($CFG->enableplagiarism)) {
 186         return array();
 187     }
 188     $plagiarismplugins = get_plugin_list('plagiarism');
 189     $availableplugins = array();
 190     foreach($plagiarismplugins as $plugin => $dir) {
 191         //check this plugin is enabled and a lib file exists.
 192         if (get_config('plagiarism', $plugin."_use") && file_exists($dir."/lib.php")) {
 193             require_once($dir.'/lib.php');
 194             $plagiarismclass = "plagiarism_plugin_$plugin";
 195             if (class_exists($plagiarismclass)) {
 196                 $availableplugins[$plugin] = $dir;
 197             }
 198         }
 199     }
 200     return $availableplugins;
 201 }