portfolio MDL-20850 adding $PAGE->set_url
[moodle.git] / portfolio / add.php
1 <?php
2 /**
3  * Moodle - Modular Object-Oriented Dynamic Learning Environment
4  *          http://moodle.org
5  * Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19  *
20  * @package    moodle
21  * @subpackage portfolio
22  * @author     Penny Leach <penny@catalyst.net.nz>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24  * @copyright  (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
25  *
26  * This file is the main controller to do with the portfolio export wizard.
27  */
28 require_once(dirname(dirname(__FILE__)) . '/config.php');
30 if (empty($CFG->enableportfolios)) {
31     print_error('disabled', 'portfolio');
32 }
34 // this will pull in all the other required libraries
35 require_once($CFG->libdir . '/portfoliolib.php');
36 // so plugins don't have to.
37 require_once($CFG->libdir . '/formslib.php');
39 $cancel        = optional_param('cancel', 0, PARAM_RAW);                      // user has cancelled the request
40 $dataid        = optional_param('id', 0, PARAM_INT);                          // id of partially completed export (in session, everything else in portfolio_tempdata
41 $instanceid    = optional_param('instance', 0, PARAM_INT);                    // instanceof of configured portfolio plugin
42 $courseid      = optional_param('course', 0, PARAM_INT);                      // courseid the data being exported belongs to (caller object should provide this later)
43 $stage         = optional_param('stage', PORTFOLIO_STAGE_CONFIG, PARAM_INT);  // stage of the export we're at (stored in the exporter)
44 $postcontrol   = optional_param('postcontrol', 0, PARAM_INT);                 // when returning from some bounce to an external system, this gets passed
45 $callbackfile  = optional_param('callbackfile', null, PARAM_PATH);            // callback file eg /mod/forum/lib.php - the location of the exporting content
46 $callbackclass = optional_param('callbackclass', null, PARAM_ALPHAEXT);       // callback class eg forum_portfolio_caller - the class to handle the exporting content.
48 require_login();  // this is selectively called again with $course later when we know for sure which one we're in.
49 $PAGE->set_url('/portfolio/add.php', array('id' => $dataid));
50 $exporter = null;
52 // try and find a partial export id in the session if it's not passed explicitly
53 if (empty($dataid)) {
54     if (isset($SESSION->portfolioexport)) {
55         $dataid = $SESSION->portfolioexport;
56     }
57 }
59 // if we have a dataid, it means we're in the middle of an export,
60 // so rewaken it and continue.
61 if (!empty($dataid)) {
62     try {
63         $exporter = portfolio_exporter::rewaken_object($dataid);
64     } catch (portfolio_exception $e) {
65         // this can happen in some cases, a cancel request is sent when something is already broken
66         // so process it elegantly and move on.
67         if ($cancel) {
68             unset($SESSION->portfolioexport);
69             redirect($CFG->wwwroot);
70         } else {
71             portfolio_exporter::print_expired_export();
72         }
73     }
74     // we have to wake it up first before we can cancel it
75     // so temporary directories etc get cleaned up.
76     if ($cancel) {
77         $exporter->cancel_request();
78     }
79     // verify we still belong to the correct user and session
80     $exporter->verify_rewaken();
81     // if we don't have an instanceid in the exporter
82     // it means we've just posted from the 'choose portfolio instance' page
83     // so process that and start up the portfolio plugin
84     if (!$exporter->get('instance')) {
85         if ($instanceid) {
86             try {
87                 $instance = portfolio_instance($instanceid);
88             } catch (portfolio_exception $e) {
89                 portfolio_export_rethrow_exception($exporter, $e);
90             }
91             // this technically shouldn't happen but make sure anyway
92             if ($broken = portfolio_instance_sanity_check($instance)) {
93                 throw new portfolio_export_exception($exporter, $broken[$instance->get('id')], 'portfolio_' . $instance->get('plugin'));
94             }
95             // now we're all set up, ready to go
96             $instance->set('user', $USER);
97             $exporter->set('instance', $instance);
98             $exporter->save();
99         }
100     }
101 // completely new request, look to see what information we've been passed and set up the exporter object.
102 } else {
103     // you cannot get here with no information for us, we must at least have the caller.
104     if (empty($_GET) && empty($_POST)) {
105         portfolio_exporter::print_expired_export();
106     }
107     // we'e just posted here for the first time and have might the instance already
108     if ($instanceid) {
109         // this can throw exceptions but there's no point catching and rethrowing here
110         // as the exporter isn't created yet.
111         $instance = portfolio_instance($instanceid);
112         if ($broken = portfolio_instance_sanity_check($instance)) {
113             throw new portfolio_exception($broken[$instance->get('id')], 'portfolio_' . $instance->get('plugin'));
114         }
115         $instance->set('user', $USER);
116     } else {
117         $instance = null;
118     }
120     // we must be passed this from the caller, we cannot start a new export
121     // without knowing information about what part of moodle we come from.
122     if (empty($callbackfile) || empty($callbackclass)) {
123         portfolio_exporter::print_expired_export();
124     }
126     // so each place in moodle can pass callback args here
127     // process the entire request looking for ca_*
128     // be as lenient as possible while still being secure
129     // so only accept certain parameter types.
130     $callbackargs = array();
131     foreach (array_keys(array_merge($_GET, $_POST)) as $key) {
132         if (strpos($key, 'ca_') === 0) {
133             if (!$value =  optional_param($key, false, PARAM_ALPHAEXT)) {
134                 if (!$value = optional_param($key, false, PARAM_NUMBER)) {
135                     $value = optional_param($key, false, PARAM_PATH);
136                 }
137             }
138             // strip off ca_ for niceness
139             $callbackargs[substr($key, 3)] = $value;
140         }
141     }
142     if (!confirm_sesskey()) {
143         throw new portfolio_caller_exception('confirmsesskeybad', 'error');
144     }
145     // righto, now we have the callback args set up
146     // load up the caller file and class and tell it to set up all the data
147     // it needs
148     require_once($CFG->dirroot . $callbackfile);
149     if (!class_exists($callbackclass) || !is_subclass_of($callbackclass, 'portfolio_caller_base')) {
150         throw new portfolio_caller_exception('callbackclassinvalid', 'portfolio');
151     }
152     $caller = new $callbackclass($callbackargs);
153     $caller->set('user', $USER);
154     $caller->load_data();
155     // this must check capabilities and either throw an exception or return false.
156     if (!$caller->check_permissions()) {
157         throw new portfolio_caller_exception('nopermissions', 'portfolio', $caller->get_return_url());
158     }
160     // for build navigation
161     if (!$course = $caller->get('course')) {
162         $course = $courseid;
163     }
165     // set up the course so that build_navigation works nice
166     $PAGE->set_course($course);
168     list($extranav, $cm) = $caller->get_navigation();
170     // and now we know the course for sure and maybe the cm, call require_login with it
171     // todo this will have to change when we have things exporting content outside the course context (eg blogs)
172     require_login($course, false, $cm);
174     foreach ($extranav as $navitem) {
175         $PAGE->navbar->add($navitem['name']);
176     }
177     $PAGE->navbar->add(get_string('exporting', 'portfolio'));
179     // finally! set up the exporter object with the portfolio instance, and caller information elements
180     $exporter = new portfolio_exporter($instance, $caller, $callbackfile);
182     // set the export-specific variables, and save.
183     $exporter->set('user', $USER);
184     $exporter->set('sesskey', sesskey());
185     $exporter->save();
187     // and finally, put it in the session for waking up again later.
188     $SESSION->portfolioexport = $exporter->get('id');
191 if (!$exporter->get('instance')) {
192     // we've just arrived but have no instance
193     // in this case the exporter object and the caller object have been set up above
194     // so just make a little form to select the portfolio plugin instance,
195     // which is the last thing to do before starting the export.
196     $mform = new portfolio_instance_select('', array('caller' => $exporter->get('caller')));
197     if ($mform->is_cancelled()) {
198         $exporter->cancel_request();
199     } else if ($fromform = $mform->get_data()){
200         redirect($CFG->wwwroot . '/portfolio/add.php?instance=' . $fromform->instance . '&amp;id=' . $exporter->get('id'));
201         exit;
202     }
203     else {
204         $exporter->print_header('selectplugin');
205         echo $OUTPUT->box_start();
206         $mform->display();
207         echo $OUTPUT->box_end();
208         echo $OUTPUT->footer();
209         exit;
210     }
213 // if we haven't been passed &stage= grab it from the exporter.
214 if (!$stage) {
215     $stage = $exporter->get('stage');
218 // for places returning control to pass (rather than PORTFOLIO_STAGE_PACKAGE
219 // which is unstable if they can't get to the constant (eg external system)
220 $alreadystolen = false;
221 if ($postcontrol) { // the magic request variable plugins must pass on returning here
222     try {
223         // allow it to read whatever gets sent back in the request
224         // this is useful for plugins that redirect away and back again
225         // adding a token to the end of the url, for example box.net
226         $exporter->instance()->post_control($stage, array_merge($_GET, $_POST));
227     } catch (portfolio_plugin_exception $e) {
228         portfolio_export_rethrow_exception($exporter, $e);
229     }
230     $alreadystolen = true; // remember this so we don't get caught in a steal control loop!
233 // actually do the work now..
234 $exporter->process_stage($stage, $alreadystolen);