Merge branch 'MDL-60667_master' of git://github.com/dmonllao/moodle
[moodle.git] / calendar / classes / local / event / forms / managesubscriptions.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Allows the user to manage calendar subscriptions.
19  *
20  * @copyright 2012 Jonathan Harker
21  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  * @package calendar
23  */
24 namespace core_calendar\local\event\forms;
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->libdir . '/formslib.php');
30 /**
31  * Form for adding a subscription to a Moodle course calendar.
32  * @copyright 2012 Jonathan Harker
33  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class managesubscriptions extends \moodleform {
37     use eventtype;
39     /**
40      * Defines the form used to add calendar subscriptions.
41      */
42     public function definition() {
43         $mform = $this->_form;
44         $eventtypes = calendar_get_all_allowed_types();
45         if (empty($eventtypes)) {
46             print_error('nopermissiontoupdatecalendar');
47         }
49         $mform->addElement('header', 'addsubscriptionform', get_string('importcalendarheading', 'calendar'));
51         // Name.
52         $mform->addElement('text', 'name', get_string('subscriptionname', 'calendar'), array('maxsize' => '255', 'size' => '40'));
53         $mform->addRule('name', get_string('required'), 'required');
54         $mform->setType('name', PARAM_TEXT);
56         // Import from (url | importfile).
57         $mform->addElement('html', get_string('importfrominstructions', 'calendar'));
58         $choices = array(CALENDAR_IMPORT_FROM_FILE => get_string('importfromfile', 'calendar'),
59             CALENDAR_IMPORT_FROM_URL  => get_string('importfromurl',  'calendar'));
60         $mform->addElement('select', 'importfrom', get_string('importcalendarfrom', 'calendar'), $choices);
61         $mform->setDefault('importfrom', CALENDAR_IMPORT_FROM_URL);
63         // URL.
64         $mform->addElement('text', 'url', get_string('importfromurl', 'calendar'), array('maxsize' => '255', 'size' => '50'));
65         // Cannot set as PARAM_URL since we need to allow webcal:// protocol.
66         $mform->setType('url', PARAM_RAW);
67         $mform->setForceLtr('url');
69         // Poll interval
70         $choices = calendar_get_pollinterval_choices();
71         $mform->addElement('select', 'pollinterval', get_string('pollinterval', 'calendar'), $choices);
72         $mform->setDefault('pollinterval', 604800);
73         $mform->addHelpButton('pollinterval', 'pollinterval', 'calendar');
74         $mform->setType('pollinterval', PARAM_INT);
76         // Import file
77         $mform->addElement('filepicker', 'importfile', get_string('importfromfile', 'calendar'), null, array('accepted_types' => '.ics'));
79         // Disable appropriate elements depending on import from value.
80         $mform->disabledIf('pollinterval', 'importfrom', 'eq', CALENDAR_IMPORT_FROM_FILE);
81         $mform->disabledIf('url',  'importfrom', 'eq', CALENDAR_IMPORT_FROM_FILE);
82         $mform->disabledIf('importfile', 'importfrom', 'eq', CALENDAR_IMPORT_FROM_URL);
84         // Add the select elements for the available event types.
85         $this->add_event_type_elements($mform, $eventtypes);
87         // Eventtype: 0 = user, 1 = global, anything else = course ID.
88         $mform->addElement('submit', 'add', get_string('add'));
89     }
91     /**
92      * Validates the returned data.
93      *
94      * @param array $data
95      * @param array $files
96      * @return array
97      */
98     public function validation($data, $files) {
99         global $USER;
101         $errors = parent::validation($data, $files);
103         $coursekey = isset($data['groupcourseid']) ? 'groupcourseid' : 'courseid';
104         $eventtypes = calendar_get_all_allowed_types();
105         $eventtype = isset($data['eventtype']) ? $data['eventtype'] : null;
107         if (empty($eventtype) || !isset($eventtypes[$eventtype])) {
108             $errors['eventtype'] = get_string('invalideventtype', 'calendar');
109         }
111         if ($data['importfrom'] == CALENDAR_IMPORT_FROM_FILE) {
112             if (empty($data['importfile'])) {
113                 $errors['importfile'] = get_string('errorrequiredurlorfile', 'calendar');
114             } else {
115                 // Make sure the file area is not empty and contains only one file.
116                 $draftitemid = $data['importfile'];
117                 $fs = get_file_storage();
118                 $usercontext = \context_user::instance($USER->id);
119                 $files = $fs->get_area_files($usercontext->id, 'user', 'draft', $draftitemid, 'id DESC', false);
120                 if (count($files) !== 1) {
121                     $errors['importfile'] = get_string('errorrequiredurlorfile', 'calendar');
122                 }
123             }
124         } else if (($data['importfrom'] == CALENDAR_IMPORT_FROM_URL)) {
125             // Clean input calendar url.
126             $url = clean_param($data['url'], PARAM_URL);
127             if (empty($url) || ($url !== $data['url'])) {
128                 $errors['url']  = get_string('invalidurl', 'error');
129             }
130         } else {
131             // Shouldn't happen.
132             $errors['url'] = get_string('errorrequiredurlorfile', 'calendar');
133         }
135         return $errors;
136     }
138     public function definition_after_data() {
139         $mform =& $this->_form;
141         $mform->applyFilter('url', static::class . '::strip_webcal');
142         $mform->applyFilter('url', 'trim');
143     }
145     /**
146      * Replace webcal:// urls with http:// as
147      * curl does not understand this protocol
148      *
149      * @param string @url url to examine
150      * @return string url with webcal:// replaced
151      */
152     public static function strip_webcal($url) {
153         if (strpos($url, 'webcal://') === 0) {
154             $url = str_replace('webcal://', 'http://', $url);
155         }
156         return $url;
157     }