Permalink
Browse files

MDL-37602 Add support for browsing the overall feedback files

  • Loading branch information...
1 parent 05837ba commit 88e79d8adbc85d7916f9e9e49b0681146a2b4826 @mudrd8mz mudrd8mz committed Mar 25, 2013
Showing with 220 additions and 0 deletions.
  1. +161 −0 mod/workshop/fileinfolib.php
  2. +2 −0 mod/workshop/lang/en/workshop.php
  3. +57 −0 mod/workshop/lib.php
@@ -179,3 +179,164 @@ public function get_parent() {
return $this->browser->get_file_info($this->context);
}
}
+
+
+/**
+ * Represents virtual root node for all files in overall feedbacks
+ *
+ * Overall feedback uses two fileareas: overallfeedback_content for editor's embeded media
+ * and overallfeedback_attachment for attachments. In both, the itemid represents the assessment id.
+ * This container is used to display the list of all submissions in these areas (ie when
+ * these areas are browsed with itemid == null).
+ */
+class workshop_file_info_overallfeedback_container extends file_info {
+ protected $course;
+ protected $cm;
+ protected $areas;
+ protected $filearea;
+
+ public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
+ parent::__construct($browser, $context);
+ $this->course = $course;
+ $this->cm = $cm;
+ $this->areas = $areas;
+ $this->filearea = $filearea;
+ }
+
+ /**
+ * Returns list of standard virtual file/directory identification
+ *
+ * The difference from stored_file parameters is that null values
+ * are allowed in all fields.
+ *
+ * @return array with keys contextid, filearea, itemid, filepath and filename
+ */
+ public function get_params() {
+ return array('contextid' => $this->context->id,
+ 'component' => 'mod_workshop',
+ 'filearea' => $this->filearea,
+ 'itemid' => null,
+ 'filepath' => null,
+ 'filename' => null);
+ }
+
+ /**
+ * Returns localised visible name
+ *
+ * @return string
+ */
+ public function get_visible_name() {
+ return $this->areas[$this->filearea];
+ }
+
+ /**
+ * Can I add new files or directories?
+ *
+ * @return bool
+ */
+ public function is_writable() {
+ return false;
+ }
+
+ /**
+ * Is directory?
+ *
+ * @return bool
+ */
+ public function is_directory() {
+ return true;
+ }
+
+
+ /**
+ * Returns list of children nodes
+ *
+ * @return array of file_info instances
+ */
+ public function get_children() {
+ return $this->get_filtered_children('*', false, true);
+ }
+
+ /**
+ * Helper function to return files matching extensions or their count
+ *
+ * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
+ * @param bool|int $countonly if false returns the children, if an int returns just the
+ * count of children but stops counting when $countonly number of children is reached
+ * @param bool $returnemptyfolders if true returns items that don't have matching files inside
+ * @return array|int array of file_info instances or the count
+ */
+ private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
+ global $DB;
+
+ $params = array('contextid' => $this->context->id,
+ 'component' => 'mod_workshop',
+ 'filearea' => $this->filearea);
+ $sql = "SELECT DISTINCT itemid
+ FROM {files}
+ WHERE contextid = :contextid
+ AND component = :component
+ AND filearea = :filearea";
+ if (!$returnemptyfolders) {
+ $sql .= " AND filename <> :emptyfilename";
+ $params['emptyfilename'] = '.';
+ }
+ list($sql2, $params2) = $this->build_search_files_sql($extensions);
+ $sql .= ' '.$sql2;
+ $params = array_merge($params, $params2);
+ if ($countonly !== false) {
+ $sql .= " ORDER BY itemid DESC";
+ }
+
+ $rs = $DB->get_recordset_sql($sql, $params);
+ $children = array();
+ foreach ($rs as $record) {
+ if (($child = $this->browser->get_file_info($this->context, 'mod_workshop', $this->filearea, $record->itemid))
+ && ($returnemptyfolders || $child->count_non_empty_children($extensions))) {
+ $children[] = $child;
+ if ($countonly !== false && count($children) >= $countonly) {
+ break;
+ }
+ }
+ }
+ $rs->close();
+ if ($countonly !== false) {
+ return count($children);
+ }
+ return $children;
+ }
+
+ /**
+ * Returns list of children which are either files matching the specified extensions
+ * or folders that contain at least one such file.
+ *
+ * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
+ * @return array of file_info instances
+ */
+ public function get_non_empty_children($extensions = '*') {
+ return $this->get_filtered_children($extensions, false);
+ }
+
+ /**
+ * Returns the number of children which are either files matching the specified extensions
+ * or folders containing at least one such file.
+ *
+ * NOTE: We don't need the exact number of non empty children if it is >=2
+ * In this function 1 is never returned to avoid skipping the single subfolder
+ *
+ * @param string|array $extensions, for example '*' or array('.gif','.jpg')
+ * @param int $limit stop counting after at least $limit non-empty children are found
+ * @return int
+ */
+ public function count_non_empty_children($extensions = '*', $limit = 1) {
+ return $this->get_filtered_children($extensions, $limit);
+ }
+
+ /**
+ * Returns parent file_info instance
+ * @return file_info or null for root
+ */
+ public function get_parent() {
+ return $this->browser->get_file_info($this->context);
+ }
+}
@@ -38,6 +38,8 @@
$string['areaconclusion'] = 'Conclusion text';
$string['areainstructauthors'] = 'Instructions for submission';
$string['areainstructreviewers'] = 'Instructions for assessment';
+$string['areaoverallfeedbackattachment'] = 'Overall feedback attachments';
+$string['areaoverallfeedbackcontent'] = 'Overall feedback texts';
$string['areasubmissionattachment'] = 'Submission attachments';
$string['areasubmissioncontent'] = 'Submission texts';
$string['assess'] = 'Assess';
View
@@ -1184,6 +1184,8 @@ function workshop_get_file_areas($course, $cm, $context) {
$areas['submission_content'] = get_string('areasubmissioncontent', 'workshop');
$areas['submission_attachment'] = get_string('areasubmissionattachment', 'workshop');
$areas['conclusion'] = get_string('areaconclusion', 'workshop');
+ $areas['overallfeedback_content'] = get_string('areaoverallfeedbackcontent', 'workshop');
+ $areas['overallfeedback_attachment'] = get_string('areaoverallfeedbackattachment', 'workshop');
return $areas;
}
@@ -1386,6 +1388,7 @@ function workshop_pluginfile($course, $cm, $context, $filearea, array $args, $fo
*/
function workshop_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
global $CFG, $DB, $USER;
+
/** @var array internal cache for author names */
static $submissionauthors = array();
@@ -1476,6 +1479,60 @@ function workshop_get_file_info($browser, $areas, $course, $cm, $context, $filea
return new file_info_stored($browser, $context, $storedfile, $urlbase, $topvisiblename, true, true, false, false);
}
+ if ($filearea === 'overallfeedback_content' or $filearea === 'overallfeedback_attachment') {
+
+ if (!has_capability('mod/workshop:viewallassessments', $context)) {
+ return null;
+ }
+
+ if (is_null($itemid)) {
+ // No itemid (assessmentid) passed, display the list of all assessments.
+ require_once($CFG->dirroot . '/mod/workshop/fileinfolib.php');
+ return new workshop_file_info_overallfeedback_container($browser, $course, $cm, $context, $areas, $filearea);
+ }
+
+ // Make sure the user can see the particular assessment in separate groups mode.
+ $gmode = groups_get_activity_groupmode($cm, $course);
+ if ($gmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
+ // Check there is at least one common group with both the $USER
+ // and the submission author.
+ $sql = "SELECT 'x'
+ FROM {workshop_submissions} s
+ JOIN {user} a ON (a.id = s.authorid)
+ JOIN {groups_members} agm ON (a.id = agm.userid)
+ JOIN {user} u ON (u.id = ?)
+ JOIN {groups_members} ugm ON (u.id = ugm.userid)
+ WHERE s.example = 0 AND s.workshopid = ? AND s.id = ? AND agm.groupid = ugm.groupid";
+ $params = array($USER->id, $cm->instance, $itemid);
+ if (!$DB->record_exists_sql($sql, $params)) {
+ return null;
+ }
+ }
+
+ // We are inside a particular assessment container.
+ $filepath = is_null($filepath) ? '/' : $filepath;
+ $filename = is_null($filename) ? '.' : $filename;
+
+ if (!$storedfile = $fs->get_file($context->id, 'mod_workshop', $filearea, $itemid, $filepath, $filename)) {
+ if ($filepath === '/' and $filename === '.') {
+ $storedfile = new virtual_root_file($context->id, 'mod_workshop', $filearea, $itemid);
+ } else {
+ // Not found
+ return null;
+ }
+ }
+
+ // Check to see if the user can manage files or is the owner.
+ if (!has_capability('moodle/course:managefiles', $context) and $storedfile->get_userid() != $USER->id) {
+ return null;
+ }
+
+ $urlbase = $CFG->wwwroot . '/pluginfile.php';
+
+ // Do not allow manual modification of any files.
+ return new file_info_stored($browser, $context, $storedfile, $urlbase, $itemid, true, true, false, false);
+ }
+
if ($filearea == 'instructauthors' or $filearea == 'instructreviewers' or $filearea == 'conclusion') {
// always only itemid 0

0 comments on commit 88e79d8

Please sign in to comment.