echo $output;
}
-/**
-* temporary functions until the File API settles
-* to do with moving files around
-*/
-function temp_portfolio_working_directory($unique) {
- return make_upload_directory('temp/portfolio/export/' . $unique);
-}
-
-function temp_portfolio_usertemp_directory($userid) {
- return make_upload_directory('userdata/' . $userid . '/temp');
-}
-
-/**
-*cleans up the working directory
-*/
-function temp_portfolio_cleanup($unique) {
- $workdir = temp_portfolio_working_directory($unique);
- return remove_dir($workdir);
-}
-
/**
* fake the url to portfolio/add.php from data from somewhere else
* you should use portfolio_add_button instead 99% of the time
*/
protected $user;
+ /**
+ * a reference to the exporter object
+ */
+ protected $exporter;
/**
*
*
* @todo determine what to return in the error case
*/
- public final function set($field, $value) {
+ public final function set($field, &$value) {
if (property_exists($this, $field)) {
- $this->{$field} = $value;
+ $this->{$field} =& $value;
$this->dirty = true;
return true;
}
/**
* called before the portfolio plugin gets control
* this function should copy all the files it wants to
- * the temporary directory.
- *
- * @param string $tempdir path to tempdir to put files in
+ * the temporary directory, using {@see copy_existing_file}
+ * or {@see write_new_file}
*/
- public abstract function prepare_package($tempdir);
+ public abstract function prepare_package();
/**
* array of formats this caller supports
*/
protected $user;
+ /**
+ * a reference to the exporter object
+ */
+ protected $exporter;
/**
* array of formats this portfolio supports
}
/**
- * called before the portfolio plugin gets control
- * this function should copy all the files it wants to
- * the temporary directory.
+ * called after the caller has finished having control
+ * of its prepare_package function.
+ * this function should read all the files from the portfolio
+ * working file area and zip them and send them or whatever it wants.
+ * {@see get_tempfiles} to get the list of files.
*
- * @param string $tempdir path to temporary directory
*/
- public abstract function prepare_package($tempdir);
+ public abstract function prepare_package();
/**
* this is the function that is responsible for sending
* @param array $data data from form.
* @return array keyvalue pairs - form element => error string
*/
- public static function admin_config_validation($data) {}
+ public function admin_config_validation($data) {}
/**
* mform to display to the user exporting data using this plugin.
* if your plugin doesn't need user input at this time,
*/
public final function set($field, $value) {
if (property_exists($this, $field)) {
- $this->{$field} = $value;
+ $this->{$field} =& $value;
$this->dirty = true;
return true;
}
private $instance;
private $noconfig;
private $navigation;
- private $uniquekey;
- private $tempdir;
private $user;
public $instancefile;
public $callerfile;
/**
- * id of this export - matches record in portfolio_tempdata
+ * id of this export
+ * matches record in portfolio_tempdata table
+ * and used for itemid for file storage.
*/
private $id;
$this->caller =& $caller;
if ($instance) {
$this->instancefile = 'portfolio/type/' . $instance->get('plugin') . '/lib.php';
+ $this->instance->set('exporter', $this);
}
$this->callerfile = $callerfile;
$this->stage = PORTFOLIO_STAGE_CONFIG;
$this->navigation = $navigation;
+ $this->caller->set('exporter', $this);
}
/*
* @todo determine what to return in the error case
*/
- public function set($field, $value) {
+ public function set($field, &$value) {
if (property_exists($this, $field)) {
- $this->{$field} = $value;
+ $this->{$field} =& $value;
if ($field == 'instance') {
$this->instancefile = 'portfolio/type/' . $this->instance->get('plugin') . '/lib.php';
+ $this->instance->set('exporter', $this);
}
$this->dirty = true;
return true;
// now we've agreed on a format,
// the caller is given control to package it up however it wants
// and then the portfolio plugin is given control to do whatever it wants.
- $unique = $this->user->id . '-' . time();
- $tempdir = temp_portfolio_working_directory($unique);
- $this->uniquekey = $unique;
- $this->tempdir = $tempdir;
- if (!$this->caller->prepare_package($tempdir)) {
+ if (!$this->caller->prepare_package()) {
return $this->raise_error('callercouldnotpackage', 'portfolio', $this->caller->get_return_url());
}
- if (!$package = $this->instance->prepare_package($tempdir)) {
+ if (!$package = $this->instance->prepare_package()) {
return $this->raise_error('plugincouldnotpackage', 'portfolio', $this->caller->get_return_url());
}
return true;
*/
public function process_stage_cleanup() {
global $CFG, $DB, $SESSION;
- // @todo this is unpleasant. fix it.
- require_once($CFG->dirroot . '/backup/lib.php');
- delete_dir_contents($this->tempdir);
// @todo maybe add a hook in the plugin(s)
$DB->delete_records('portfolio_tempdata', array('id' => $this->id));
+ $fs = get_file_storage();
+ $fs->delete_area_files(SYSCONTEXTID, 'portfolio_exporter', $this->id);
unset($SESSION->portfolioexport);
return true;
}
* error handler - decides whether we're running interactively or not
* and behaves accordingly
*/
- public static function raise_error($string, $module='moodle', $continue=null) {
+ public function raise_error($string, $module='moodle', $continue=null) {
if (defined('FULLME') && FULLME == 'cron') {
debugging(get_string($string, $module));
return false;
'expirytime' => time() + (60*60*24),
);
$this->id = $DB->insert_record('portfolio_tempdata', $r);
+ $this->save(); // call again so that id gets added to the save data.
} else {
$DB->set_field('portfolio_tempdata', 'data', base64_encode(serialize($this)), array('id' => $this->id));
}
$exporter = unserialize(serialize($exporter));
return $exporter;
}
+
+ /**
+ * copies a file from somewhere else in moodle
+ * to the portfolio temporary working directory
+ * associated with this export
+ *
+ * @param $oldfile stored_file object
+ */
+ public function copy_existing_file($oldfile) {
+ $fs = get_file_storage();
+ $file_record = $this->new_file_record_base($oldfile->get_filename());
+ try {
+ return $fs->create_file_from_storedfile($file_record, $oldfile->get_id());
+ } catch (file_exception $e) {
+ return false;
+ }
+ }
+
+ /**
+ * writes out some content to a file in the
+ * portfolio temporary working directory
+ * associated with this export
+ *
+ * @param string $content content to write
+ * @param string $name filename to use
+ */
+ public function write_new_file($content, $name) {
+ $fs = get_file_storage();
+ $file_record = $this->new_file_record_base($name);
+ return $fs->create_file_from_string($file_record, $content);
+ }
+
+ /**
+ * returns an arary of files in the temporary working directory
+ * for this export
+ * always use this instead of the files api directly
+ *
+ * @return arary
+ */
+ public function get_tempfiles() {
+ $fs = get_file_storage();
+ $files = $fs->get_area_files(SYSCONTEXTID, 'portfolio_exporter', $this->id, '', false);
+ if (empty($files)) {
+ return array();
+ }
+ return $files;
+ }
+
+ /**
+ * helper function to create the beginnings of a file_record object
+ * to create a new file in the portfolio_temporary working directory
+ * use {@see write_new_file} or {@see copy_existing_file} externally
+ *
+ * @param string $name filename of new record
+ */
+ private function new_file_record_base($name) {
+ return (object)array(
+ 'contextid' => SYSCONTEXTID,
+ 'filearea' => 'portfolio_exporter',
+ 'itemid' => $this->id,
+ 'filepath' => '/',
+ 'filename' => $name,
+ );
+ }
+
}
class portfolio_instance_select extends moodleform {
$path = $browser->encodepath($CFG->wwwroot.'/pluginfile.php', '/'.$this->context->id.'/assignment_submission/'.$userid.'/'.$filename);
$output .= '<a href="'.$path.'" ><img src="'.$CFG->pixpath.'/f/'.$icon.'" class="icon" alt="'.$icon.'" />'.s($filename).'</a>';
if ($this->portfolio_exportable() && true) { // @todo replace with capability check
- $p['file'] = $file;
+ $p['file'] = $file->get_id();
$output .= portfolio_add_button('assignment_portfolio_caller', $p, null, false, true);
}
$output .= '<br />';
$this->file = (array_key_exists('file', $callbackargs)) ? $callbackargs['file'] : null;
}
- public function prepare_package($tempdir) {
+ public function prepare_package() {
global $CFG;
if (is_callable(array($this->assignment, 'portfolio_prepare_package'))) {
- return $this->assignment->portfolio_prepare_package($tempdir);
+ return $this->assignment->portfolio_prepare_package($this->exporter);
}
-error('TODO: covert');
- // default...
- $filearea = $CFG->dataroot . '/' . $this->assignment->file_area_name($this->userid);
- //@todo penny this is a dreadful thing to have to call (replace with files api anyway)
- require_once($CFG->dirroot . '/backup/lib.php');
- if ($this->file) {
- return backup_copy_file($filearea . '/' . $this->file, $tempdir . '/' . $this->file);
+ $fs = get_file_storage();
+ $status = true;
+ if ($files = $fs->get_area_files($this->assignment->context->id, 'assignment_submission', $this->user->id, '', false)) {
+ foreach ($files as $file) {
+ $status = $status && $this->exporter->copy_existing_file($file);
+ }
}
- return backup_copy_file($filearea, $tempdir);
+ return $status;
}
public function get_sha1() {
return $this->assignment->portfolio_get_sha1();
}
-error('TODO: covert');
// default ...
- $filearea = $CFG->dataroot . '/' . $this->assignment->file_area_name($this->userid);
+ $fs = get_file_storage();
+ $status = true;
if ($this->file) {
- return sha1_file($filearea . '/' . $this->file);
+ return $fs->get_file($this->file)->get_contenthash();
}
- $sha1s = array();
- foreach (get_directory_list($filearea) as $file) {
- $sha1s[] = sha1_file($filearea . '/' . $file);
+ if ($files = $fs->get_area_files($this->assignment->context->id, 'assignment_submission', $this->user->id, '', false)) {
+ $sha1s = array();
+ foreach ($files as $file) {
+ $sha1s[] = $file->get_contenthash();
+ }
+ asort($sha1s);
}
- asort($sha1s);
return sha1(implode('', $sha1s));
}
return sha1(format_text($submission->data1, $submission->data2));
}
- function portfolio_prepare_package($tempdir) {
+ function portfolio_prepare_package($exporter) {
$submission = $this->get_submission();
- $handle = fopen($tempdir . '/assignment.html', 'w');
- $status = $handle && fwrite($handle, format_text($submission->data1, $submission->data2));
- $status = $status && fclose($handle);
- return $status;
+ return $exporter->write_new_file(format_text($submission->data1, $submission->data2), 'assignment.html');
}
}
}
$this->add_checkbox_controller(1, null, null, 1);
require_once($CFG->libdir . '/portfoliolib.php');
- if ($portfoliooptions = portfolio_instance_select(portfolio_instances(), call_user_func(array('data_portfolio_caller', 'supported_formats')), 'data_portfolio_caller', '', true, true)) {
- $mform->addElement('header', 'notice', get_string('portfolionotfile', 'portfolio') . ':');
- $portfoliooptions[0] = get_string('none');
- ksort($portfoliooptions);
- $mform->addElement('select', 'portfolio', get_string('portfolio', 'portfolio'), $portfoliooptions);
+ if (false) { // @todo penny replace with permissions check
+ if ($portfoliooptions = portfolio_instance_select(
+ portfolio_instances(),
+ call_user_func(array('data_portfolio_caller', 'supported_formats')),
+ 'data_portfolio_caller', '', true, true)) {
+ $mform->addElement('header', 'notice', get_string('portfolionotfile', 'portfolio') . ':');
+ $portfoliooptions[0] = get_string('none');
+ ksort($portfoliooptions);
+ $mform->addElement('select', 'portfolio', get_string('portfolio', 'portfolio'), $portfoliooptions);
+ }
}
$this->add_action_buttons(true, get_string('exportdatabaserecords', 'data'));
}
return sha1($str . ',' . $this->exporttype);
}
- public function prepare_package($tempdir) {
+ public function prepare_package() {
global $DB;
$count = count($this->exportdata);
switch ($this->exporttype) {
$p = array(
'postid' => $post->id,
);
- $commands[] = portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false, true);
+ //$commands[] = portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false, true);
}
echo '<div class="commands">';
'postid' => $post->id,
'attachment' => 1,
);
- $output .= portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false, true);
+ //$output .= portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false, true);
}
$output .= "<br />";
'postid' => $post->id,
'attachment' => 1,
);
- portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false);
+ //portfolio_add_button('forum_portfolio_caller', $p, '/mod/forum/lib.php', false);
}
echo '<br />';
}
return array($navlinks, $this->cm);
}
- function prepare_package($tempdir) {
+ function prepare_package() {
global $CFG, $SESSION;
// either a whole discussion
// a single post, with or without attachment
// or just an attachment with no post
if (!$this->post) { // whole discussion
portfolio_exporter::raise_error('exoprting whole discussion not implemented - see MDL-15758');
- // @todo see MDL-15758
+ // @todo see MDL-15758
} else {
+
if ($basedir = forum_file_area($this->post)) {
//@todo penny fix all this with files api
require_once($CFG->dirroot . '/backup/lib.php');
return sha1(serialize($this->exportdata));
}
- public function prepare_package($tempdir) {
+ public function prepare_package() {
$entries = $this->exportdata['entries'];
$aliases = array();
$categories = array();
}
}
$csv = glossary_generate_export_csv($entries, $aliases, $categories);
- // @todo - convert to files api.
- $status = ($handle = fopen($tempdir . '/' . clean_filename($this->cm->name) . '.csv', 'w'));
- $status = $status && fwrite($handle, $csv);
- $status = $status && fclose($handle);
- return $status;
+ return $this->exporter->write_new_file($csv, clean_filename($this->cm->name) . '.csv');
}
public function check_permissions() {
return get_string('modname', 'glossary');
}
- public function prepare_package($tempdir) {
- $this->entry->approved = true; // in case we don't have $USER which this function checks
+ public function prepare_package() {
+ // in case we don't have USER this will make the entry be printed
+ $this->entry->approved = true;
define('PORTFOLIO_INTERNAL', true);
ob_start();
glossary_print_entry($this->get('course'), $this->cm, $this->glossary, $this->entry, null, null, false);
$content = ob_get_clean();
- // @todo - convert to files api.
- $status = ($handle = fopen($tempdir . '/' . clean_filename($this->entry->concept) . '.html', 'w'));
- $status = $status && fwrite($handle, $content);
- $status = $status && fclose($handle);
- return $status;
+ return $this->exporter->write_new_file($content, clean_filename($this->entry->concept) . '.html');
}
public function get_sha1() {
//override to add your own options
}
- function portfolio_prepare_package_uploaded($tempdir) {
+ function portfolio_prepare_package_uploaded($exporter) {
// @todo penny implement later - see MDL-15758
}
- function portfolio_prepare_package_online($tempdir, $text=false) {
- //@todo penny use the files api here
- $status = $handle = fopen($tempdir . '/' . clean_filename($this->cm->name . '.' . (($text) ? 'txt' : 'html')), 'w');
+ function portfolio_prepare_package_online($exporter, $text=false) {
+ $filename = clean_filename($this->cm->name . '.' . (($text) ? 'txt' : 'html'));
$formatoptions = (object)array('noclean' => true);
$format = (($text) ? FORMAT_MOODLE : FORMAT_HTML);
$content = format_text($this->resource->alltext, $format, $formatoptions, $this->course->id);
- $status = $status && fwrite($handle, $content);
- $status = $status && fclose($handle);
- return $status;
+ return $exporter->write_new_file($content, $filename);
}
function portfolio_get_sha1_online($text=false) {
return PORTFOLIO_TIME_LOW;
}
- public function prepare_package($tempdir) {
- return $this->resource->portfolio_prepare_package($tempdir);
+ public function prepare_package() {
+ return $this->resource->portfolio_prepare_package($this->exporter);
}
public function check_permissions() {
}
}
-function portfolio_prepare_package($tempdir) {
- return parent::portfolio_prepare_package_online($tempdir);
+function portfolio_prepare_package($exporter) {
+ return parent::portfolio_prepare_package_online($exporter);
}
function portfolio_get_sha1() {
}
-function portfolio_prepare_package($tempdir) {
- return parent::portfolio_prepare_package_online($tempdir, true);
+function portfolio_prepare_package($exporter) {
+ return parent::portfolio_prepare_package_online($exporter, true);
}
function portfolio_get_sha1() {
}
$instance->set('user', $USER);
$exporter->set('instance', $instance);
+ $exporter->save();
}
}
} else {
$SESSION->portfolioexport = $exporter->get('id');
}
-
-$stage = optional_param('stage', PORTFOLIO_STAGE_CONFIG);
-$alreadystolen = false;
-// for places returning control to pass (rather than PORTFOLIO_STAGE_PACKAGE
-// which is unstable if they can't get to the constant (eg external system)
-if ($postcontrol = optional_param('postcontrol', 0, PARAM_INT)) {
- $stage = $exporter->get('stage');
- $exporter->instance()->post_control($stage, array_merge($_GET, $_POST));
- $alreadystolen = true;
-}
-
if (!$exporter->get('instance')) {
+ print_object($exporter);
// we've just arrived but have no instance
// so retrieve everything from the request,
// add them as hidden fields in a new form
}
}
+$stage = optional_param('stage', PORTFOLIO_STAGE_CONFIG);
+$alreadystolen = false;
+// for places returning control to pass (rather than PORTFOLIO_STAGE_PACKAGE
+// which is unstable if they can't get to the constant (eg external system)
+if ($postcontrol = optional_param('postcontrol', 0, PARAM_INT)) {
+ $stage = $exporter->get('stage');
+ $exporter->instance()->post_control($stage, array_merge($_GET, $_POST));
+ $alreadystolen = true;
+}
$exporter->process_stage($stage, $alreadystolen);
?>
private $boxclient;
private $ticket;
private $authtoken;
- private $workdir;
private $folders;
- public function prepare_package($tempdir) {
- $this->workdir = $tempdir;
+ public function prepare_package() {
return true; // don't do anything else for this plugin, we want to send all files as they are.
}
public function send_package() {
$ret = array();
- foreach (get_directory_list($this->workdir) as $file) {
- $file = $this->workdir . '/' . $file;
- $ret[] = $this->boxclient->uploadFile(
+ foreach ($this->exporter->get_tempfiles() as $file) {
+ $return = $this->boxclient->uploadFile(
array(
'file' => $file,
'folder_id' => $this->get_export_config('folder')
)
);
+ if (array_key_exists('status', $return) && $return['status'] == 'upload_ok'
+ && array_key_exists('id', $return) && count($return['id']) == 1) {
+ $return['rename'] = $this->boxclient->renameFile($return['id'][array_pop(array_keys($return['id']))], $file->get_filename());
+ $ret[] = $return;
+ }
}
if ($this->boxclient->isError()) {
return false;
return PORTFOLIO_TIME_LOW;
}
- public function prepare_package($tempdir) {
+ public function prepare_package() {
// just zip up whatever files the caller has created for us
// and move them to the user's temporary area.
$userdir = temp_portfolio_usertemp_directory($this->get('user')->id);
public function get_continue_url() {
return false;
}
+
+ public static function plugin_sanity_check() {
+ return 'notupgradedtousefilesapi';
+ }
}
?>
projects / moodle.git / commitdiff