MDL-31873 added mod_assign_get_grades web service function
[moodle.git] / grade / import / lib.php
1 <?php
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/>.
18 require_once($CFG->libdir.'/gradelib.php');
20 /**
21  * Returns new improtcode for current user
22  * @return int importcode
23  */
24 function get_new_importcode() {
25     global $USER, $DB;
27     $importcode = time();
28     while ($DB->get_record('grade_import_values', array('importcode' => $importcode, 'importer' => $USER->id))) {
29         $importcode--;
30     }
32     return $importcode;
33 }
35 /**
36  * given an import code, commits all entries in buffer tables
37  * (grade_import_value and grade_import_newitem)
38  * If this function is called, we assume that all data collected
39  * up to this point is fine and we can go ahead and commit
40  * @param int courseid - id of the course
41  * @param string importcode - import batch identifier
42  * @param feedback print feedback and continue button
43  * @return bool success
44  */
45 function grade_import_commit($courseid, $importcode, $importfeedback=true, $verbose=true) {
46     global $CFG, $USER, $DB, $OUTPUT;
48     $commitstart = time(); // start time in case we need to roll back
49     $newitemids = array(); // array to hold new grade_item ids from grade_import_newitem table, mapping array
51     /// first select distinct new grade_items with this batch
52     $params = array($importcode, $USER->id);
53     if ($newitems = $DB->get_records_sql("SELECT *
54                                            FROM {grade_import_newitem}
55                                           WHERE importcode = ? AND importer=?", $params)) {
57         // instances of the new grade_items created, cached
58         // in case grade_update fails, so that we can remove them
59         $instances = array();
60         $failed = false;
61         foreach ($newitems as $newitem) {
62             // get all grades with this item
64             if ($grades = $DB->get_records('grade_import_values', array('newgradeitem' => $newitem->id))) {
65                 /// create a new grade item for this - must use false as second param!
66                 /// TODO: we need some bounds here too
67                 $gradeitem = new grade_item(array('courseid'=>$courseid, 'itemtype'=>'manual', 'itemname'=>$newitem->itemname), false);
68                 $gradeitem->insert('import');
69                 $instances[] = $gradeitem;
71                 // insert each individual grade to this new grade item
72                 foreach ($grades as $grade) {
73                     if (!$gradeitem->update_final_grade($grade->userid, $grade->finalgrade, 'import', $grade->feedback, FORMAT_MOODLE)) {
74                         $failed = true;
75                         break 2;
76                     }
77                 }
78             }
79         }
81         if ($failed) {
82             foreach ($instances as $instance) {
83                 $gradeitem->delete('import');
84             }
85             import_cleanup($importcode);
86             return false;
87         }
88     }
90     /// then find all existing items
92     if ($gradeitems = $DB->get_records_sql("SELECT DISTINCT (itemid)
93                                              FROM {grade_import_values}
94                                             WHERE importcode = ? AND importer=? AND itemid > 0",
95                                             array($importcode, $USER->id))) {
97         $modifieditems = array();
99         foreach ($gradeitems as $itemid=>$notused) {
101             if (!$gradeitem = new grade_item(array('id'=>$itemid))) {
102                 // not supposed to happen, but just in case
103                 import_cleanup($importcode);
104                 return false;
105             }
106             // get all grades with this item
107             if ($grades = $DB->get_records('grade_import_values', array('itemid' => $itemid))) {
109                 // make the grades array for update_grade
110                 foreach ($grades as $grade) {
111                     if (!$importfeedback) {
112                         $grade->feedback = false; // ignore it
113                     }
114                     if (!$gradeitem->update_final_grade($grade->userid, $grade->finalgrade, 'import', $grade->feedback)) {
115                         $failed = 1;
116                         break 2;
117                     }
118                 }
119                 //$itemdetails -> idnumber = $gradeitem->idnumber;
120                 $modifieditems[] = $itemid;
122             }
124             if (!empty($failed)) {
125                 import_cleanup($importcode);
126                 return false;
127             }
128         }
129     }
131     if ($verbose) {
132         echo $OUTPUT->notification(get_string('importsuccess', 'grades'), 'notifysuccess');
133         $unenrolledusers = get_unenrolled_users_in_import($importcode, $courseid);
134         if ($unenrolledusers) {
135             $list = array();
136             foreach ($unenrolledusers as $u) {
137                 $u->fullname = fullname($u);
138                 $list[] = get_string('usergrade', 'grades', $u);
139             }
140             echo $OUTPUT->notification(get_string('unenrolledusersinimport', 'grades', html_writer::alist($list)), 'notifysuccess');
141         }
142         echo $OUTPUT->continue_button($CFG->wwwroot.'/grade/index.php?id='.$courseid);
143     }
144     // clean up
145     import_cleanup($importcode);
147     return true;
150 /**
151  * This function returns an array of grades that were included in the import,
152  * but where the user does not currently have a graded role on the course. These grades
153  * are still stored in the database, but will not be visible in the gradebook unless
154  * this user subsequently enrols on the course in a graded roles.
155  *
156  * The returned objects have fields user firstname, lastname and useridnumber, and gradeidnumber.
157  *
158  * @param integer $importcode import batch identifier
159  * @param integer $courseid the course we are importing to.
160  * @return mixed and array of user objects, or false if none.
161  */
162 function get_unenrolled_users_in_import($importcode, $courseid) {
163     global $CFG, $DB;
164     $relatedctxcondition = get_related_contexts_string(context_course::instance($courseid));
166     //users with a gradeable role
167     list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
169     //enrolled users
170     $context = context_course::instance($courseid);
171     list($enrolledsql, $enrolledparams) = get_enrolled_sql($context);
173     $sql = "SELECT giv.id, u.firstname, u.lastname, u.idnumber AS useridnumber,
174                    COALESCE(gi.idnumber, gin.itemname) AS gradeidnumber
175               FROM {grade_import_values} giv
176               JOIN {user} u
177                    ON giv.userid = u.id
178               LEFT JOIN {grade_items} gi
179                         ON gi.id = giv.itemid
180               LEFT JOIN {grade_import_newitem} gin
181                         ON gin.id = giv.newgradeitem
182               LEFT JOIN ($enrolledsql) je
183                         ON je.id = u.id
184               LEFT JOIN {role_assignments} ra
185                         ON (giv.userid = ra.userid AND ra.roleid $gradebookrolessql AND ra.contextid $relatedctxcondition)
186              WHERE giv.importcode = :importcode
187                    AND (ra.id IS NULL OR je.id IS NULL)
188           ORDER BY gradeidnumber, u.lastname, u.firstname";
189     $params = array_merge($gradebookrolesparams, $enrolledparams);
190     $params['importcode'] = $importcode;
192     return $DB->get_records_sql($sql, $params);
195 /**
196  * removes entries from grade import buffer tables grade_import_value and grade_import_newitem
197  * after a successful import, or during an import abort
198  * @param string importcode - import batch identifier
199  */
200 function import_cleanup($importcode) {
201     global $USER, $DB;
203     // remove entries from buffer table
204     $DB->delete_records('grade_import_values', array('importcode' => $importcode, 'importer' => $USER->id));
205     $DB->delete_records('grade_import_newitem', array('importcode' => $importcode, 'importer' => $USER->id));