3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Library of functions for forum outside of the core api
22 require_once($CFG->dirroot
. '/mod/forum/lib.php');
23 require_once($CFG->libdir
. '/portfolio/caller.php');
27 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30 class forum_portfolio_caller
extends portfolio_module_caller_base
{
33 protected $discussionid;
34 protected $attachment;
40 private $keyedfiles; // just using multifiles isn't enough if we're exporting a full thread
45 public static function expected_callbackargs() {
48 'discussionid' => false,
49 'attachment' => false,
53 * @param array $callbackargs
55 function __construct($callbackargs) {
56 parent
::__construct($callbackargs);
57 if (!$this->postid
&& !$this->discussionid
) {
58 throw new portfolio_caller_exception('mustprovidediscussionorpost', 'forum');
64 public function load_data() {
68 if (!$this->post
= $DB->get_record('forum_posts', array('id' => $this->postid
))) {
69 throw new portfolio_caller_exception('invalidpostid', 'forum');
74 if ($this->discussionid
) {
75 $dbparams = array('id' => $this->discussionid
);
76 } else if ($this->post
) {
77 $dbparams = array('id' => $this->post
->discussion
);
79 throw new portfolio_caller_exception('mustprovidediscussionorpost', 'forum');
82 if (!$this->discussion
= $DB->get_record('forum_discussions', $dbparams)) {
83 throw new portfolio_caller_exception('invaliddiscussionid', 'forum');
86 if (!$this->forum
= $DB->get_record('forum', array('id' => $this->discussion
->forum
))) {
87 throw new portfolio_caller_exception('invalidforumid', 'forum');
90 if (!$this->cm
= get_coursemodule_from_instance('forum', $this->forum
->id
)) {
91 throw new portfolio_caller_exception('invalidcoursemodule');
94 $this->modcontext
= context_module
::instance($this->cm
->id
);
95 $fs = get_file_storage();
97 if ($this->attachment
) {
98 $this->set_file_and_format_data($this->attachment
);
100 $attach = $fs->get_area_files($this->modcontext
->id
, 'mod_forum', 'attachment', $this->post
->id
, 'timemodified', false);
101 $embed = $fs->get_area_files($this->modcontext
->id
, 'mod_forum', 'post', $this->post
->id
, 'timemodified', false);
102 $files = array_merge($attach, $embed);
103 $this->set_file_and_format_data($files);
105 if (!empty($this->multifiles
)) {
106 $this->keyedfiles
[$this->post
->id
] = $this->multifiles
;
107 } else if (!empty($this->singlefile
)) {
108 $this->keyedfiles
[$this->post
->id
] = array($this->singlefile
);
110 } else { // whole thread
111 $fs = get_file_storage();
112 $this->posts
= forum_get_all_discussion_posts($this->discussion
->id
, 'p.created ASC');
113 $this->multifiles
= array();
114 foreach ($this->posts
as $post) {
115 $attach = $fs->get_area_files($this->modcontext
->id
, 'mod_forum', 'attachment', $post->id
, 'timemodified', false);
116 $embed = $fs->get_area_files($this->modcontext
->id
, 'mod_forum', 'post', $post->id
, 'timemodified', false);
117 $files = array_merge($attach, $embed);
119 $this->keyedfiles
[$post->id
] = $files;
123 $this->multifiles
= array_merge($this->multifiles
, array_values($this->keyedfiles
[$post->id
]));
126 if (empty($this->multifiles
) && !empty($this->singlefile
)) {
127 $this->multifiles
= array($this->singlefile
); // copy_files workaround
129 // depending on whether there are files or not, we might have to change richhtml/plainhtml
130 if (empty($this->attachment
)) {
131 if (!empty($this->multifiles
)) {
132 $this->add_format(PORTFOLIO_FORMAT_RICHHTML
);
134 $this->add_format(PORTFOLIO_FORMAT_PLAINHTML
);
143 function get_return_url() {
145 return $CFG->wwwroot
. '/mod/forum/discuss.php?d=' . $this->discussion
->id
;
151 function get_navigation() {
156 'name' => format_string($this->discussion
->name
),
157 'link' => $CFG->wwwroot
. '/mod/forum/discuss.php?d=' . $this->discussion
->id
,
160 return array($navlinks, $this->cm
);
163 * either a whole discussion
164 * a single post, with or without attachment
165 * or just an attachment with no post
169 * @uses PORTFOLIO_FORMAT_RICH
172 function prepare_package() {
175 // set up the leap2a writer if we need it
176 $writingleap = false;
177 if ($this->exporter
->get('formatclass') == PORTFOLIO_FORMAT_LEAP2A
) {
178 $leapwriter = $this->exporter
->get('format')->leap2a_writer();
181 if ($this->attachment
) { // simplest case first - single file attachment
182 $this->copy_files(array($this->singlefile
), $this->attachment
);
183 if ($writingleap) { // if we're writing leap, make the manifest to go along with the file
184 $entry = new portfolio_format_leap2a_file($this->singlefile
->get_filename(), $this->singlefile
);
185 $leapwriter->add_entry($entry);
186 return $this->exporter
->write_new_file($leapwriter->to_xml(), $this->exporter
->get('format')->manifest_name(), true);
189 } else if (empty($this->post
)) { // exporting whole discussion
190 $content = ''; // if we're just writing HTML, start a string to add each post to
191 $ids = array(); // if we're writing leap2a, keep track of all entryids so we can add a selection element
192 foreach ($this->posts
as $post) {
193 $posthtml = $this->prepare_post($post);
195 $ids[] = $this->prepare_post_leap2a($leapwriter, $post, $posthtml);
197 $content .= $posthtml . '<br /><br />';
200 $this->copy_files($this->multifiles
);
201 $name = 'discussion.html';
202 $manifest = ($this->exporter
->get('format') instanceof PORTFOLIO_FORMAT_RICH
);
204 // add on an extra 'selection' entry
205 $selection = new portfolio_format_leap2a_entry('forumdiscussion' . $this->discussionid
,
206 get_string('discussion', 'forum') . ': ' . $this->discussion
->name
, 'selection');
207 $leapwriter->add_entry($selection);
208 $leapwriter->make_selection($selection, $ids, 'Grouping');
209 $content = $leapwriter->to_xml();
210 $name = $this->get('exporter')->get('format')->manifest_name();
212 $this->get('exporter')->write_new_file($content, $name, $manifest);
214 } else { // exporting a single post
215 $posthtml = $this->prepare_post($this->post
);
217 $content = $posthtml;
219 $manifest = ($this->exporter
->get('format') instanceof PORTFOLIO_FORMAT_RICH
);
222 $this->prepare_post_leap2a($leapwriter, $this->post
, $posthtml);
223 $content = $leapwriter->to_xml();
224 $name = $this->exporter
->get('format')->manifest_name();
226 $this->copy_files($this->multifiles
);
227 $this->get('exporter')->write_new_file($content, $name, $manifest);
232 * helper function to add a leap2a entry element
233 * that corresponds to a single forum post,
234 * including any attachments
236 * the entry/ies are added directly to the leapwriter, which is passed by ref
238 * @param portfolio_format_leap2a_writer $leapwriter writer object to add entries to
239 * @param object $post the stdclass object representing the database record
240 * @param string $posthtml the content of the post (prepared by {@link prepare_post}
242 * @return int id of new entry
244 private function prepare_post_leap2a(portfolio_format_leap2a_writer
$leapwriter, $post, $posthtml) {
245 $entry = new portfolio_format_leap2a_entry('forumpost' . $post->id
, $post->subject
, 'resource', $posthtml);
246 $entry->published
= $post->created
;
247 $entry->updated
= $post->modified
;
248 $entry->author
= $post->author
;
249 if (is_array($this->keyedfiles
) && array_key_exists($post->id
, $this->keyedfiles
) && is_array($this->keyedfiles
[$post->id
])) {
250 $leapwriter->link_files($entry, $this->keyedfiles
[$post->id
], 'forumpost' . $post->id
. 'attachment');
252 $entry->add_category('web', 'resource_type');
253 $leapwriter->add_entry($entry);
258 * @param array $files
259 * @param mixed $justone false of id of single file to copy
262 private function copy_files($files, $justone=false) {
266 foreach ($files as $f) {
267 if ($justone && $f->get_id() != $justone) {
270 $this->get('exporter')->copy_existing_file($f);
271 if ($justone && $f->get_id() == $justone) {
272 return true; // all we need to do
277 * this is a very cut down version of what is in forum_make_mail_post
283 private function prepare_post($post, $fileoutputextras=null) {
287 $users = array($this->user
->id
=> $this->user
);
289 if (!array_key_exists($post->userid
, $users)) {
290 $users[$post->userid
] = $DB->get_record('user', array('id' => $post->userid
));
292 // add the user object on to the post so we can pass it to the leap writer if necessary
293 $post->author
= $users[$post->userid
];
294 $viewfullnames = true;
295 // format the post body
296 $options = portfolio_format_text_options();
297 $format = $this->get('exporter')->get('format');
298 $formattedtext = format_text($post->message
, $post->messageformat
, $options, $this->get('course')->id
);
299 $formattedtext = portfolio_rewrite_pluginfile_urls($formattedtext, $this->modcontext
->id
, 'mod_forum', 'post', $post->id
, $format);
301 $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
303 $output .= '<tr class="header"><td>';// can't print picture.
307 $output .= '<td class="topic">';
309 $output .= '<td class="topic starter">';
311 $output .= '<div class="subject">'.format_string($post->subject
).'</div>';
313 $fullname = fullname($users[$post->userid
], $viewfullnames);
314 $by = new stdClass();
315 $by->name
= $fullname;
316 $by->date
= userdate($post->modified
, '', core_date
::get_user_timezone($this->user
));
317 $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
319 $output .= '</td></tr>';
321 $output .= '<tr><td class="left side" valign="top">';
323 $output .= '</td><td class="content">';
325 $output .= $formattedtext;
327 if (is_array($this->keyedfiles
) && array_key_exists($post->id
, $this->keyedfiles
) && is_array($this->keyedfiles
[$post->id
]) && count($this->keyedfiles
[$post->id
]) > 0) {
328 $output .= '<div class="attachments">';
329 $output .= '<br /><b>' . get_string('attachments', 'forum') . '</b>:<br /><br />';
330 foreach ($this->keyedfiles
[$post->id
] as $file) {
331 $output .= $format->file_output($file) . '<br/ >';
336 $output .= '</td></tr></table>'."\n\n";
343 function get_sha1() {
346 $filesha = $this->get_sha1_file();
347 } catch (portfolio_caller_exception
$e) { } // no files
350 return sha1($filesha . ',' . $this->post
->subject
. ',' . $this->post
->message
);
352 $sha1s = array($filesha);
353 foreach ($this->posts
as $post) {
354 $sha1s[] = sha1($post->subject
. ',' . $post->message
);
356 return sha1(implode(',', $sha1s));
360 function expected_time() {
361 $filetime = $this->expected_time_file();
363 $posttime = portfolio_expected_time_db(count($this->posts
));
364 if ($filetime < $posttime) {
371 * @uses CONTEXT_MODULE
374 function check_permissions() {
375 $context = context_module
::instance($this->cm
->id
);
377 return (has_capability('mod/forum:exportpost', $context)
378 ||
($this->post
->userid
== $this->user
->id
379 && has_capability('mod/forum:exportownpost', $context)));
381 return has_capability('mod/forum:exportdiscussion', $context);
386 public static function display_name() {
387 return get_string('modulename', 'forum');
390 public static function base_supported_formats() {
391 return array(PORTFOLIO_FORMAT_FILE
, PORTFOLIO_FORMAT_RICHHTML
, PORTFOLIO_FORMAT_PLAINHTML
, PORTFOLIO_FORMAT_LEAP2A
);
397 * Class representing the virtual node with all itemids in the file browser
400 * @copyright 2012 David Mudrak <david@moodle.com>
401 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
403 class forum_file_info_container
extends file_info
{
404 /** @var file_browser */
411 protected $component;
420 * Constructor (in case you did not realize it ;-)
422 * @param file_browser $browser
423 * @param stdClass $course
424 * @param stdClass $cm
425 * @param stdClass $context
426 * @param array $areas
427 * @param string $filearea
429 public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
430 parent
::__construct($browser, $context);
431 $this->browser
= $browser;
432 $this->course
= $course;
434 $this->component
= 'mod_forum';
435 $this->context
= $context;
436 $this->areas
= $areas;
437 $this->filearea
= $filearea;
441 * @return array with keys contextid, filearea, itemid, filepath and filename
443 public function get_params() {
445 'contextid' => $this->context
->id
,
446 'component' => $this->component
,
447 'filearea' => $this->filearea
,
455 * Can new files or directories be added via the file browser
459 public function is_writable() {
464 * Should this node be considered as a folder in the file browser
468 public function is_directory() {
473 * Returns localised visible name of this node
477 public function get_visible_name() {
478 return $this->areas
[$this->filearea
];
482 * Returns list of children nodes
484 * @return array of file_info instances
486 public function get_children() {
487 return $this->get_filtered_children('*', false, true);
490 * Help function to return files matching extensions or their count
492 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
493 * @param bool|int $countonly if false returns the children, if an int returns just the
494 * count of children but stops counting when $countonly number of children is reached
495 * @param bool $returnemptyfolders if true returns items that don't have matching files inside
496 * @return array|int array of file_info instances or the count
498 private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
500 $params = array('contextid' => $this->context
->id
,
501 'component' => $this->component
,
502 'filearea' => $this->filearea
);
503 $sql = 'SELECT DISTINCT itemid
505 WHERE contextid = :contextid
506 AND component = :component
507 AND filearea = :filearea';
508 if (!$returnemptyfolders) {
509 $sql .= ' AND filename <> :emptyfilename';
510 $params['emptyfilename'] = '.';
512 list($sql2, $params2) = $this->build_search_files_sql($extensions);
514 $params = array_merge($params, $params2);
515 if ($countonly !== false) {
516 $sql .= ' ORDER BY itemid DESC';
519 $rs = $DB->get_recordset_sql($sql, $params);
521 foreach ($rs as $record) {
522 if (($child = $this->browser
->get_file_info($this->context
, 'mod_forum', $this->filearea
, $record->itemid
))
523 && ($returnemptyfolders ||
$child->count_non_empty_children($extensions))) {
524 $children[] = $child;
526 if ($countonly !== false && count($children) >= $countonly) {
531 if ($countonly !== false) {
532 return count($children);
538 * Returns list of children which are either files matching the specified extensions
539 * or folders that contain at least one such file.
541 * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
542 * @return array of file_info instances
544 public function get_non_empty_children($extensions = '*') {
545 return $this->get_filtered_children($extensions, false);
549 * Returns the number of children which are either files matching the specified extensions
550 * or folders containing at least one such file.
552 * @param string|array $extensions, for example '*' or array('.gif','.jpg')
553 * @param int $limit stop counting after at least $limit non-empty children are found
556 public function count_non_empty_children($extensions = '*', $limit = 1) {
557 return $this->get_filtered_children($extensions, $limit);
561 * Returns parent file_info instance
563 * @return file_info or null for root
565 public function get_parent() {
566 return $this->browser
->get_file_info($this->context
);
571 * Returns forum posts tagged with a specified tag.
573 * This is a callback used by the tag area mod_forum/forum_posts to search for forum posts
574 * tagged with a specific tag.
576 * @param core_tag_tag $tag
577 * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
578 * are displayed on the page and the per-page limit may be bigger
579 * @param int $fromctx context id where the link was displayed, may be used by callbacks
580 * to display items in the same context first
581 * @param int $ctx context id where to search for records
582 * @param bool $rec search in subcontexts as well
583 * @param int $page 0-based number of page being displayed
584 * @return \core_tag\output\tagindex
586 function mod_forum_get_tagged_posts($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
588 $perpage = $exclusivemode ?
20 : 5;
590 // Build the SQL query.
591 $ctxselect = context_helper
::get_preload_record_columns_sql('ctx');
592 $query = "SELECT fp.id, fp.subject, fd.forum, fp.discussion, f.type, fd.timestart, fd.timeend, fd.groupid, fp.parent, fp.userid,
593 cm.id AS cmid, c.id AS courseid, c.shortname, c.fullname, $ctxselect
594 FROM {forum_posts} fp
595 JOIN {forum_discussions} fd ON fp.discussion = fd.id
596 JOIN {forum} f ON f.id = fd.forum
597 JOIN {modules} m ON m.name='forum'
598 JOIN {course_modules} cm ON cm.module = m.id AND cm.instance = f.id
599 JOIN {tag_instance} tt ON fp.id = tt.itemid
600 JOIN {course} c ON cm.course = c.id
601 JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :coursemodulecontextlevel
602 WHERE tt.itemtype = :itemtype AND tt.tagid = :tagid AND tt.component = :component
603 AND cm.deletioninprogress = 0
604 AND fp.id %ITEMFILTER% AND c.id %COURSEFILTER%";
606 $params = array('itemtype' => 'forum_posts', 'tagid' => $tag->id
, 'component' => 'mod_forum',
607 'coursemodulecontextlevel' => CONTEXT_MODULE
);
610 $context = $ctx ? context
::instance_by_id($ctx) : context_system
::instance();
611 $query .= $rec ?
' AND (ctx.id = :contextid OR ctx.path LIKE :path)' : ' AND ctx.id = :contextid';
612 $params['contextid'] = $context->id
;
613 $params['path'] = $context->path
.'/%';
616 $query .= " ORDER BY ";
618 // In order-clause specify that modules from inside "fromctx" context should be returned first.
619 $fromcontext = context
::instance_by_id($fromctx);
620 $query .= ' (CASE WHEN ctx.id = :fromcontextid OR ctx.path LIKE :frompath THEN 0 ELSE 1 END),';
621 $params['fromcontextid'] = $fromcontext->id
;
622 $params['frompath'] = $fromcontext->path
.'/%';
624 $query .= ' c.sortorder, cm.id, fp.id';
626 $totalpages = $page +
1;
628 // Use core_tag_index_builder to build and filter the list of items.
629 $builder = new core_tag_index_builder('mod_forum', 'forum_posts', $query, $params, $page * $perpage, $perpage +
1);
630 while ($item = $builder->has_item_that_needs_access_check()) {
631 context_helper
::preload_from_record($item);
632 $courseid = $item->courseid
;
633 if (!$builder->can_access_course($courseid)) {
634 $builder->set_accessible($item, false);
637 $modinfo = get_fast_modinfo($builder->get_course($courseid));
638 // Set accessibility of this item and all other items in the same course.
639 $builder->walk(function ($taggeditem) use ($courseid, $modinfo, $builder) {
640 if ($taggeditem->courseid
== $courseid) {
641 $cm = $modinfo->get_cm($taggeditem->cmid
);
642 $forum = (object)['id' => $taggeditem->forum
,
643 'course' => $taggeditem->courseid
,
644 'type' => $taggeditem->type
646 $discussion = (object)['id' => $taggeditem->discussion
,
647 'timestart' => $taggeditem->timestart
,
648 'timeend' => $taggeditem->timeend
,
649 'groupid' => $taggeditem->groupid
651 $post = (object)['id' => $taggeditem->id
,
652 'parent' => $taggeditem->parent
,
653 'userid' => $taggeditem->userid
,
654 'groupid' => $taggeditem->groupid
657 $accessible = forum_user_can_see_post($forum, $discussion, $post, null, $cm);
658 $builder->set_accessible($taggeditem, $accessible);
663 $items = $builder->get_items();
664 if (count($items) > $perpage) {
665 $totalpages = $page +
2; // We don't need exact page count, just indicate that the next page exists.
669 // Build the display contents.
671 $tagfeed = new core_tag\output\tagfeed
();
672 foreach ($items as $item) {
673 context_helper
::preload_from_record($item);
674 $modinfo = get_fast_modinfo($item->courseid
);
675 $cm = $modinfo->get_cm($item->cmid
);
676 $pageurl = new moodle_url('/mod/forum/discuss.php', array('d' => $item->discussion
), 'p' . $item->id
);
677 $pagename = format_string($item->subject
, true, array('context' => context_module
::instance($item->cmid
)));
678 $pagename = html_writer
::link($pageurl, $pagename);
679 $courseurl = course_get_url($item->courseid
, $cm->sectionnum
);
680 $cmname = html_writer
::link($cm->url
, $cm->get_formatted_name());
681 $coursename = format_string($item->fullname
, true, array('context' => context_course
::instance($item->courseid
)));
682 $coursename = html_writer
::link($courseurl, $coursename);
683 $icon = html_writer
::link($pageurl, html_writer
::empty_tag('img', array('src' => $cm->get_icon_url())));
684 $tagfeed->add($icon, $pagename, $cmname.'<br>'.$coursename);
687 $content = $OUTPUT->render_from_template('core_tag/tagfeed',
688 $tagfeed->export_for_template($OUTPUT));
690 return new core_tag\output\tagindex
($tag, 'mod_forum', 'forum_posts', $content,
691 $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);