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  * saves/updates plagiarism settings from a modules config page - called by course/modedit.php
  58  *
  59  * @param object $data - form data
  60  */
  61 function plagiarism_save_form_elements($data) {
  62     global $CFG;
  63     if (empty($CFG->enableplagiarism)) {
  64         return '';
  65     }
  66     $plagiarismplugins = plagiarism_load_available_plugins();
  67     foreach($plagiarismplugins as $plugin => $dir) {
  68         require_once($dir.'/lib.php');
  69         $plagiarismclass = "plagiarism_plugin_$plugin";
  70         $plagiarismplugin = new $plagiarismclass;
  71         $plagiarismplugin->save_form_elements($data);
  72     }
  73 }
  74
  75 /**
  76  * adds the list of plagiarism settings to a form - called inside modules that have enabled plagiarism
  77  *
  78  * @param object $mform - Moodle form object
  79  * @param object $context - context object
  80  */
  81 function plagiarism_get_form_elements_module($mform, $context) {
  82     global $CFG;
  83     if (empty($CFG->enableplagiarism)) {
  84         return '';
  85     }
  86     $plagiarismplugins = plagiarism_load_available_plugins();
  87     foreach($plagiarismplugins as $plugin => $dir) {
  88         require_once($dir.'/lib.php');
  89         $plagiarismclass = "plagiarism_plugin_$plugin";
  90         $plagiarismplugin = new $plagiarismclass;
  91         $plagiarismplugin->get_form_elements_module($mform, $context);
  92     }
  93 }
  94 /**
  95  * updates the status of all files within a module
  96  *
  97  * @param object $course - full Course object
  98  * @param object $cm - full cm object
  99  */
 100 function plagiarism_update_status($course, $cm) {
 101     global $CFG;
 102     if (empty($CFG->enableplagiarism)) {
 103         return '';
 104     }
 105     $plagiarismplugins = plagiarism_load_available_plugins();
 106     foreach($plagiarismplugins as $plugin => $dir) {
 107         require_once($dir.'/lib.php');
 108         $plagiarismclass = "plagiarism_plugin_$plugin";
 109         $plagiarismplugin = new $plagiarismclass;
 110         $plagiarismplugin->update_status($course, $cm);
 111     }
 112 }
 113
 114 /**
 115 * Function that prints the student disclosure notifying that the files will be checked for plagiarism
 116 * @param integer $cmid - the cmid of this module
 117 */
 118 function plagiarism_print_disclosure($cmid) {
 119     global $CFG;
 120     if (empty($CFG->enableplagiarism)) {
 121         return '';
 122     }
 123     $plagiarismplugins = plagiarism_load_available_plugins();
 124     foreach($plagiarismplugins as $plugin => $dir) {
 125         require_once($dir.'/lib.php');
 126         $plagiarismclass = "plagiarism_plugin_$plugin";
 127         $plagiarismplugin = new $plagiarismclass;
 128         $plagiarismplugin->print_disclosure($cmid);
 129     }
 130 }
 131 /**
 132  * used by admin/cron.php to get similarity scores from submitted files.
 133  *
 134  */
 135 function plagiarism_cron() {
 136     global $CFG;
 137     if (empty($CFG->enableplagiarism)) {
 138         return '';
 139     }
 140     $plagiarismplugins = plagiarism_load_available_plugins();
 141     foreach($plagiarismplugins as $plugin => $dir) {
 142         require_once($dir.'/lib.php');
 143         $plagiarismclass = "plagiarism_plugin_$plugin";
 144         $plagiarismplugin = new $plagiarismclass;
 145         $plagiarismplugin->cron();
 146     }
 147 }
 148 /**
 149  * helper function - also loads lib file of plagiarism plugin
 150  * @return array of available plugins
 151  */
 152 function plagiarism_load_available_plugins() {
 153     global $CFG;
 154     if (empty($CFG->enableplagiarism)) {
 155         return array();
 156     }
 157     $plagiarismplugins = get_plugin_list('plagiarism');
 158     $availableplugins = array();
 159     foreach($plagiarismplugins as $plugin => $dir) {
 160         //check this plugin is enabled and a lib file exists.
 161         if (get_config('plagiarism', $plugin."_use") && file_exists($dir."/lib.php")) {
 162             require_once($dir.'/lib.php');
 163             $plagiarismclass = "plagiarism_plugin_$plugin";
 164             if (class_exists($plagiarismclass)) {
 165                 $availableplugins[$plugin] = $dir;
 166             }
 167         }
 168     }
 169     return $availableplugins;
 170 }