73c2ffdbda1d0f96d0d4340329673846d8053528
[moodle.git] / mod / resource / mod_form.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 /**
19  * Resource configuration form
20  *
21  * @package    mod_resource
22  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die;
28 require_once($CFG->dirroot.'/course/moodleform_mod.php');
29 require_once($CFG->dirroot.'/mod/resource/locallib.php');
30 require_once($CFG->libdir.'/filelib.php');
32 class mod_resource_mod_form extends moodleform_mod {
33     function definition() {
34         global $CFG, $DB;
35         $mform =& $this->_form;
37         $config = get_config('resource');
39         if ($this->current->instance and $this->current->tobemigrated) {
40             // resource not migrated yet
41             $resource_old = $DB->get_record('resource_old', array('oldid'=>$this->current->instance));
42             $mform->addElement('static', 'warning', '', get_string('notmigrated', 'resource', $resource_old->type));
43             $mform->addElement('cancel');
44             $this->standard_hidden_coursemodule_elements();
45             return;
46         }
48         //-------------------------------------------------------
49         $mform->addElement('header', 'general', get_string('general', 'form'));
50         $mform->addElement('text', 'name', get_string('name'), array('size'=>'48'));
51         if (!empty($CFG->formatstringstriptags)) {
52             $mform->setType('name', PARAM_TEXT);
53         } else {
54             $mform->setType('name', PARAM_CLEANHTML);
55         }
56         $mform->addRule('name', null, 'required', null, 'client');
57         $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
58         $this->standard_intro_elements();
60         //-------------------------------------------------------
61         $mform->addElement('header', 'contentsection', get_string('contentheader', 'resource'));
62         $mform->setExpanded('contentsection');
64         $filemanager_options = array();
65         $filemanager_options['accepted_types'] = '*';
66         $filemanager_options['maxbytes'] = 0;
67         $filemanager_options['maxfiles'] = -1;
68         $filemanager_options['mainfile'] = true;
70         $mform->addElement('filemanager', 'files', get_string('selectfiles'), null, $filemanager_options);
72         // add legacy files flag only if used
73         if (isset($this->current->legacyfiles) and $this->current->legacyfiles != RESOURCELIB_LEGACYFILES_NO) {
74             $options = array(RESOURCELIB_LEGACYFILES_DONE   => get_string('legacyfilesdone', 'resource'),
75                              RESOURCELIB_LEGACYFILES_ACTIVE => get_string('legacyfilesactive', 'resource'));
76             $mform->addElement('select', 'legacyfiles', get_string('legacyfiles', 'resource'), $options);
77         }
79         //-------------------------------------------------------
80         $mform->addElement('header', 'optionssection', get_string('appearance'));
82         if ($this->current->instance) {
83             $options = resourcelib_get_displayoptions(explode(',', $config->displayoptions), $this->current->display);
84         } else {
85             $options = resourcelib_get_displayoptions(explode(',', $config->displayoptions));
86         }
88         if (count($options) == 1) {
89             $mform->addElement('hidden', 'display');
90             $mform->setType('display', PARAM_INT);
91             reset($options);
92             $mform->setDefault('display', key($options));
93         } else {
94             $mform->addElement('select', 'display', get_string('displayselect', 'resource'), $options);
95             $mform->setDefault('display', $config->display);
96             $mform->addHelpButton('display', 'displayselect', 'resource');
97         }
99         $mform->addElement('checkbox', 'showsize', get_string('showsize', 'resource'));
100         $mform->setDefault('showsize', $config->showsize);
101         $mform->addHelpButton('showsize', 'showsize', 'resource');
102         $mform->addElement('checkbox', 'showtype', get_string('showtype', 'resource'));
103         $mform->setDefault('showtype', $config->showtype);
104         $mform->addHelpButton('showtype', 'showtype', 'resource');
105         $mform->addElement('checkbox', 'showdate', get_string('showdate', 'resource'));
106         $mform->setDefault('showdate', $config->showdate);
107         $mform->addHelpButton('showdate', 'showdate', 'resource');
109         if (array_key_exists(RESOURCELIB_DISPLAY_POPUP, $options)) {
110             $mform->addElement('text', 'popupwidth', get_string('popupwidth', 'resource'), array('size'=>3));
111             if (count($options) > 1) {
112                 $mform->disabledIf('popupwidth', 'display', 'noteq', RESOURCELIB_DISPLAY_POPUP);
113             }
114             $mform->setType('popupwidth', PARAM_INT);
115             $mform->setDefault('popupwidth', $config->popupwidth);
116             $mform->setAdvanced('popupwidth', true);
118             $mform->addElement('text', 'popupheight', get_string('popupheight', 'resource'), array('size'=>3));
119             if (count($options) > 1) {
120                 $mform->disabledIf('popupheight', 'display', 'noteq', RESOURCELIB_DISPLAY_POPUP);
121             }
122             $mform->setType('popupheight', PARAM_INT);
123             $mform->setDefault('popupheight', $config->popupheight);
124             $mform->setAdvanced('popupheight', true);
125         }
127         if (array_key_exists(RESOURCELIB_DISPLAY_AUTO, $options) or
128           array_key_exists(RESOURCELIB_DISPLAY_EMBED, $options) or
129           array_key_exists(RESOURCELIB_DISPLAY_FRAME, $options)) {
130             $mform->addElement('checkbox', 'printintro', get_string('printintro', 'resource'));
131             $mform->disabledIf('printintro', 'display', 'eq', RESOURCELIB_DISPLAY_POPUP);
132             $mform->disabledIf('printintro', 'display', 'eq', RESOURCELIB_DISPLAY_DOWNLOAD);
133             $mform->disabledIf('printintro', 'display', 'eq', RESOURCELIB_DISPLAY_OPEN);
134             $mform->disabledIf('printintro', 'display', 'eq', RESOURCELIB_DISPLAY_NEW);
135             $mform->setDefault('printintro', $config->printintro);
136         }
138         $options = array('0' => get_string('none'), '1' => get_string('allfiles'), '2' => get_string('htmlfilesonly'));
139         $mform->addElement('select', 'filterfiles', get_string('filterfiles', 'resource'), $options);
140         $mform->setDefault('filterfiles', $config->filterfiles);
141         $mform->setAdvanced('filterfiles', true);
143         //-------------------------------------------------------
144         $this->standard_coursemodule_elements();
146         //-------------------------------------------------------
147         $this->add_action_buttons();
149         //-------------------------------------------------------
150         $mform->addElement('hidden', 'revision');
151         $mform->setType('revision', PARAM_INT);
152         $mform->setDefault('revision', 1);
153     }
155     function data_preprocessing(&$default_values) {
156         if ($this->current->instance and !$this->current->tobemigrated) {
157             $draftitemid = file_get_submitted_draft_itemid('files');
158             file_prepare_draft_area($draftitemid, $this->context->id, 'mod_resource', 'content', 0, array('subdirs'=>true));
159             $default_values['files'] = $draftitemid;
160         }
161         if (!empty($default_values['displayoptions'])) {
162             $displayoptions = unserialize($default_values['displayoptions']);
163             if (isset($displayoptions['printintro'])) {
164                 $default_values['printintro'] = $displayoptions['printintro'];
165             }
166             if (!empty($displayoptions['popupwidth'])) {
167                 $default_values['popupwidth'] = $displayoptions['popupwidth'];
168             }
169             if (!empty($displayoptions['popupheight'])) {
170                 $default_values['popupheight'] = $displayoptions['popupheight'];
171             }
172             if (!empty($displayoptions['showsize'])) {
173                 $default_values['showsize'] = $displayoptions['showsize'];
174             } else {
175                 // Must set explicitly to 0 here otherwise it will use system
176                 // default which may be 1.
177                 $default_values['showsize'] = 0;
178             }
179             if (!empty($displayoptions['showtype'])) {
180                 $default_values['showtype'] = $displayoptions['showtype'];
181             } else {
182                 $default_values['showtype'] = 0;
183             }
184             if (!empty($displayoptions['showdate'])) {
185                 $default_values['showdate'] = $displayoptions['showdate'];
186             } else {
187                 $default_values['showdate'] = 0;
188             }
189         }
190     }
192     function definition_after_data() {
193         if ($this->current->instance and $this->current->tobemigrated) {
194             // resource not migrated yet
195             return;
196         }
198         parent::definition_after_data();
199     }
201     function validation($data, $files) {
202         global $USER;
204         $errors = parent::validation($data, $files);
206         $usercontext = context_user::instance($USER->id);
207         $fs = get_file_storage();
208         if (!$files = $fs->get_area_files($usercontext->id, 'user', 'draft', $data['files'], 'sortorder, id', false)) {
209             $errors['files'] = get_string('required');
210             return $errors;
211         }
212         if (count($files) == 1) {
213             // no need to select main file if only one picked
214             return $errors;
215         } else if(count($files) > 1) {
216             $mainfile = false;
217             foreach($files as $file) {
218                 if ($file->get_sortorder() == 1) {
219                     $mainfile = true;
220                     break;
221                 }
222             }
223             // set a default main file
224             if (!$mainfile) {
225                 $file = reset($files);
226                 file_set_sortorder($file->get_contextid(), $file->get_component(), $file->get_filearea(), $file->get_itemid(),
227                                    $file->get_filepath(), $file->get_filename(), 1);
228             }
229         }
230         return $errors;
231     }