[Summary view] [Print] [Text view]

   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   * File containing the form definition to post in the forum.
  20   *
  21   * @package   mod_forum
  22   * @copyright Jamie Pratt <me@jamiep.org>
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  require_once($CFG->libdir . '/formslib.php');
  28  require_once($CFG->dirroot . '/repository/lib.php');
  29  
  30  /**
  31   * Class to post in a forum.
  32   *
  33   * @package   mod_forum
  34   * @copyright Jamie Pratt <me@jamiep.org>
  35   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class mod_forum_post_form extends moodleform {
  38  
  39      /**
  40       * Returns the options array to use in filemanager for forum attachments
  41       *
  42       * @param stdClass $forum
  43       * @return array
  44       */
  45      public static function attachment_options($forum) {
  46          global $COURSE, $PAGE, $CFG;
  47          $maxbytes = get_user_max_upload_file_size($PAGE->context, $CFG->maxbytes, $COURSE->maxbytes, $forum->maxbytes);
  48          return array(
  49              'subdirs' => 0,
  50              'maxbytes' => $maxbytes,
  51              'maxfiles' => $forum->maxattachments,
  52              'accepted_types' => '*',
  53              'return_types' => FILE_INTERNAL
  54          );
  55      }
  56  
  57      /**
  58       * Returns the options array to use in forum text editor
  59       *
  60       * @param context_module $context
  61       * @param int $postid post id, use null when adding new post
  62       * @return array
  63       */
  64      public static function editor_options(context_module $context, $postid) {
  65          global $COURSE, $PAGE, $CFG;
  66          // TODO: add max files and max size support
  67          $maxbytes = get_user_max_upload_file_size($PAGE->context, $CFG->maxbytes, $COURSE->maxbytes);
  68          return array(
  69              'maxfiles' => EDITOR_UNLIMITED_FILES,
  70              'maxbytes' => $maxbytes,
  71              'trusttext'=> true,
  72              'return_types'=> FILE_INTERNAL | FILE_EXTERNAL,
  73              'subdirs' => file_area_contains_subdirs($context, 'mod_forum', 'post', $postid)
  74          );
  75      }
  76  
  77      /**
  78       * Form definition
  79       *
  80       * @return void
  81       */
  82      function definition() {
  83          global $CFG, $OUTPUT;
  84  
  85          $mform =& $this->_form;
  86  
  87          $course = $this->_customdata['course'];
  88          $cm = $this->_customdata['cm'];
  89          $coursecontext = $this->_customdata['coursecontext'];
  90          $modcontext = $this->_customdata['modcontext'];
  91          $forum = $this->_customdata['forum'];
  92          $post = $this->_customdata['post'];
  93          $subscribe = $this->_customdata['subscribe'];
  94          $edit = $this->_customdata['edit'];
  95          $thresholdwarning = $this->_customdata['thresholdwarning'];
  96  
  97          $mform->addElement('header', 'general', '');//fill in the data depending on page params later using set_data
  98  
  99          // If there is a warning message and we are not editing a post we need to handle the warning.
 100          if (!empty($thresholdwarning) && !$edit) {
 101              // Here we want to display a warning if they can still post but have reached the warning threshold.
 102              if ($thresholdwarning->canpost) {
 103                  $message = get_string($thresholdwarning->errorcode, $thresholdwarning->module, $thresholdwarning->additional);
 104                  $mform->addElement('html', $OUTPUT->notification($message));
 105              }
 106          }
 107  
 108          $mform->addElement('text', 'subject', get_string('subject', 'forum'), 'size="48"');
 109          $mform->setType('subject', PARAM_TEXT);
 110          $mform->addRule('subject', get_string('required'), 'required', null, 'client');
 111          $mform->addRule('subject', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
 112  
 113          $mform->addElement('editor', 'message', get_string('message', 'forum'), null, self::editor_options($modcontext, (empty($post->id) ? null : $post->id)));
 114          $mform->setType('message', PARAM_RAW);
 115          $mform->addRule('message', get_string('required'), 'required', null, 'client');
 116  
 117          $manageactivities = has_capability('moodle/course:manageactivities', $coursecontext);
 118  
 119          if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
 120              $mform->addElement('checkbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
 121              $mform->freeze('discussionsubscribe');
 122              $mform->setDefaults('discussionsubscribe', 0);
 123              $mform->addHelpButton('discussionsubscribe', 'forcesubscribed', 'forum');
 124  
 125          } else if (\mod_forum\subscriptions::subscription_disabled($forum) && !$manageactivities) {
 126              $mform->addElement('checkbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
 127              $mform->freeze('discussionsubscribe');
 128              $mform->setDefaults('discussionsubscribe', 0);
 129              $mform->addHelpButton('discussionsubscribe', 'disallowsubscription', 'forum');
 130  
 131          } else {
 132              $mform->addElement('checkbox', 'discussionsubscribe', get_string('discussionsubscription', 'forum'));
 133              $mform->addHelpButton('discussionsubscribe', 'discussionsubscription', 'forum');
 134          }
 135  
 136          if (!empty($forum->maxattachments) && $forum->maxbytes != 1 && has_capability('mod/forum:createattachment', $modcontext))  {  //  1 = No attachments at all
 137              $mform->addElement('filemanager', 'attachments', get_string('attachment', 'forum'), null, self::attachment_options($forum));
 138              $mform->addHelpButton('attachments', 'attachment', 'forum');
 139          }
 140  
 141          if (!$post->parent && has_capability('mod/forum:pindiscussions', $modcontext)) {
 142              $mform->addElement('checkbox', 'pinned', get_string('discussionpinned', 'forum'));
 143              $mform->addHelpButton('pinned', 'discussionpinned', 'forum');
 144          }
 145  
 146          if (empty($post->id) && $manageactivities) {
 147              $mform->addElement('checkbox', 'mailnow', get_string('mailnow', 'forum'));
 148          }
 149  
 150          if (!empty($CFG->forum_enabletimedposts) && !$post->parent && has_capability('mod/forum:viewhiddentimedposts', $coursecontext)) { // hack alert
 151              $mform->addElement('header', 'displayperiod', get_string('displayperiod', 'forum'));
 152  
 153              $mform->addElement('date_time_selector', 'timestart', get_string('displaystart', 'forum'), array('optional' => true));
 154              $mform->addHelpButton('timestart', 'displaystart', 'forum');
 155  
 156              $mform->addElement('date_time_selector', 'timeend', get_string('displayend', 'forum'), array('optional' => true));
 157              $mform->addHelpButton('timeend', 'displayend', 'forum');
 158  
 159          } else {
 160              $mform->addElement('hidden', 'timestart');
 161              $mform->setType('timestart', PARAM_INT);
 162              $mform->addElement('hidden', 'timeend');
 163              $mform->setType('timeend', PARAM_INT);
 164              $mform->setConstants(array('timestart'=> 0, 'timeend'=>0));
 165          }
 166  
 167          if ($groupmode = groups_get_activity_groupmode($cm, $course)) {
 168              $groupdata = groups_get_activity_allowed_groups($cm);
 169  
 170              $groupinfo = array();
 171              foreach ($groupdata as $groupid => $group) {
 172                  // Check whether this user can post in this group.
 173                  // We must make this check because all groups are returned for a visible grouped activity.
 174                  if (forum_user_can_post_discussion($forum, $groupid, null, $cm, $modcontext)) {
 175                      // Build the data for the groupinfo select.
 176                      $groupinfo[$groupid] = $group->name;
 177                  } else {
 178                      unset($groupdata[$groupid]);
 179                  }
 180              }
 181              $groupcount = count($groupinfo);
 182  
 183              // Check whether a user can post to all of their own groups.
 184  
 185              // Posts to all of my groups are copied to each group that the user is a member of. Certain conditions must be met.
 186              // 1) It only makes sense to allow this when a user is in more than one group.
 187              // Note: This check must come before we consider adding accessallgroups, because that is not a real group.
 188              $canposttoowngroups = empty($post->edit) && $groupcount > 1;
 189  
 190              // 2) Important: You can *only* post to multiple groups for a top level post. Never any reply.
 191              $canposttoowngroups = $canposttoowngroups && empty($post->parent);
 192  
 193              // 3) You also need the canposttoowngroups capability.
 194              $canposttoowngroups = $canposttoowngroups && has_capability('mod/forum:canposttomygroups', $modcontext);
 195              if ($canposttoowngroups) {
 196                  // This user is in multiple groups, and can post to all of their own groups.
 197                  // Note: This is not the same as accessallgroups. This option will copy a post to all groups that a
 198                  // user is a member of.
 199                  $mform->addElement('checkbox', 'posttomygroups', get_string('posttomygroups', 'forum'));
 200                  $mform->addHelpButton('posttomygroups', 'posttomygroups', 'forum');
 201                  $mform->disabledIf('groupinfo', 'posttomygroups', 'checked');
 202              }
 203  
 204              // Check whether this user can post to all groups.
 205              // Posts to the 'All participants' group go to all groups, not to each group in a list.
 206              // It makes sense to allow this, even if there currently aren't any groups because there may be in the future.
 207              if (forum_user_can_post_discussion($forum, -1, null, $cm, $modcontext)) {
 208                  // Note: We must reverse in this manner because array_unshift renumbers the array.
 209                  $groupinfo = array_reverse($groupinfo, true );
 210                  $groupinfo[-1] = get_string('allparticipants');
 211                  $groupinfo = array_reverse($groupinfo, true );
 212                  $groupcount++;
 213              }
 214  
 215              // Determine whether the user can select a group from the dropdown. The dropdown is available for several reasons.
 216              // 1) This is a new post (not an edit), and there are at least two groups to choose from.
 217              $canselectgroupfornew = empty($post->edit) && $groupcount > 1;
 218  
 219              // 2) This is editing of an existing post and the user is allowed to movediscussions.
 220              // We allow this because the post may have been moved from another forum where groups are not available.
 221              // We show this even if no groups are available as groups *may* have been available but now are not.
 222              $canselectgroupformove = $groupcount && !empty($post->edit) && has_capability('mod/forum:movediscussions', $modcontext);
 223  
 224              // Important: You can *only* change the group for a top level post. Never any reply.
 225              $canselectgroup = empty($post->parent) && ($canselectgroupfornew || $canselectgroupformove);
 226  
 227              if ($canselectgroup) {
 228                  $mform->addElement('select','groupinfo', get_string('group'), $groupinfo);
 229                  $mform->setDefault('groupinfo', $post->groupid);
 230                  $mform->setType('groupinfo', PARAM_INT);
 231              } else {
 232                  if (empty($post->groupid)) {
 233                      $groupname = get_string('allparticipants');
 234                  } else {
 235                      $groupname = format_string($groupdata[$post->groupid]->name);
 236                  }
 237                  $mform->addElement('static', 'groupinfo', get_string('group'), $groupname);
 238              }
 239          }
 240          //-------------------------------------------------------------------------------
 241          // buttons
 242          if (isset($post->edit)) { // hack alert
 243              $submit_string = get_string('savechanges');
 244          } else {
 245              $submit_string = get_string('posttoforum', 'forum');
 246          }
 247  
 248          $this->add_action_buttons(true, $submit_string);
 249  
 250          $mform->addElement('hidden', 'course');
 251          $mform->setType('course', PARAM_INT);
 252  
 253          $mform->addElement('hidden', 'forum');
 254          $mform->setType('forum', PARAM_INT);
 255  
 256          $mform->addElement('hidden', 'discussion');
 257          $mform->setType('discussion', PARAM_INT);
 258  
 259          $mform->addElement('hidden', 'parent');
 260          $mform->setType('parent', PARAM_INT);
 261  
 262          $mform->addElement('hidden', 'userid');
 263          $mform->setType('userid', PARAM_INT);
 264  
 265          $mform->addElement('hidden', 'groupid');
 266          $mform->setType('groupid', PARAM_INT);
 267  
 268          $mform->addElement('hidden', 'edit');
 269          $mform->setType('edit', PARAM_INT);
 270  
 271          $mform->addElement('hidden', 'reply');
 272          $mform->setType('reply', PARAM_INT);
 273      }
 274  
 275      /**
 276       * Form validation
 277       *
 278       * @param array $data data from the form.
 279       * @param array $files files uploaded.
 280       * @return array of errors.
 281       */
 282      function validation($data, $files) {
 283          $errors = parent::validation($data, $files);
 284          if (($data['timeend']!=0) && ($data['timestart']!=0) && $data['timeend'] <= $data['timestart']) {
 285              $errors['timeend'] = get_string('timestartenderror', 'forum');
 286          }
 287          if (empty($data['message']['text'])) {
 288              $errors['message'] = get_string('erroremptymessage', 'forum');
 289          }
 290          if (empty($data['subject'])) {
 291              $errors['subject'] = get_string('erroremptysubject', 'forum');
 292          }
 293          return $errors;
 294      }
 295  }