Skip to content

GitLab

Commit c92b7874 authored by Francois Marier's avatar Francois Marier
Browse files
Options

bulkimport: use a local zipfile instead of a local directory 

This change is to match what the bulkexport page generates.
Signed-off-by: default avatarFrancois Marier <francois@catalyst.net.nz>
parent d4a6f866
Hide whitespace changes
Inline Side-by-side
Showing with 53 additions and 73 deletions
htdocs/admin/users/bulkimport.php
View file @ c92b7874
......@@ -62,10 +62,11 @@ $form = array(
'name' => 'bulkimport',
'elements' => array(
'authinstance' => $authinstanceelement,
'directory' => array(
'file' => array(
'type' => 'text',
'title' => get_string('Directory', 'admin'),
'description' => get_string('bulkleap2aimportdirdescription', 'admin'),
'title' => get_string('importfile', 'admin'),
'size' => 40,
'description' => get_string('bulkleap2aimportfiledescription', 'admin'),
'rules' => array(
'required' => true
)
......@@ -92,7 +93,7 @@ $form = array(
* @param array $values The values submitted
*/
function bulkimport_validate(Pieform $form, $values) {
global $LEAP2AFILES;
global $LEAP2AFILES, $USER;
// Don't even start attempting to parse if there are previous errors
if ($form->has_errors()) {
......@@ -101,22 +102,46 @@ function bulkimport_validate(Pieform $form, $values) {
require_once('csvfile.php');
$strdirectory = hsc($values['directory']);
if (!is_dir($values['directory'])) {
$form->set_error('directory', get_string('bulkimportdirdoesntexist', 'admin', $strdirectory));
$zipfile = $values['file'];
if (!is_file($zipfile)) {
$form->set_error('file', get_string('importfilenotafile', 'admin'));
return;
}
if (!$dh = opendir($values['directory'])) {
$form->set_error('directory', get_string('unabletoreadbulkimportdir', 'admin', $strdirectory));
if (!is_readable($zipfile)) {
$form->set_error('file', get_string('importfilenotreadable', 'admin'));
return;
}
closedir($dh);
$csvfilename = $values['directory'] . '/import.csv';
// Create temporary directory
$importdir = get_config('dataroot') . 'import/'
. $USER->get('id') . '/' . time() . '/';
if (!check_dir_exists($importdir)) {
throw new SystemException("Couldn't create the temporary export directory $importdir");
}
$command = sprintf('%s %s %s',
escapeshellcmd(get_config('pathtounzip')),
escapeshellarg($zipfile),
'-d ' . escapeshellarg($importdir)
);
$output = array();
exec($command, $output, $returnvar);
if ($returnvar != 0) {
log_debug("unzip command failed with return value $returnvar");
// Let's make it obvious if the cause is obvious :)
if ($returnvar == 127) {
log_debug("This means that 'unzip' isn't installed, or the config var \$cfg->pathtounzip is not"
. " pointing at unzip (see Mahara's file lib/config-defaults.php)");
}
throw new SystemException(get_string('unzipfailed', 'admin', hsc($zipfile)));
}
else {
log_debug("Unzipped $zipfile into $importdir");
}
$csvfilename = $importdir . '/usernames.csv';
if (!is_readable($csvfilename)) {
$form->set_error('directory', get_string('unabletoreadcsvfile', 'admin', hsc($csvfilename)));
$form->set_error('file', get_string('importfilemissinglisting', 'admin'));
return;
}
......@@ -126,65 +151,16 @@ function bulkimport_validate(Pieform $form, $values) {
$csvdata = $csvusers->get_data();
if (!empty($csvdata->errors['file'])) {
$form->set_error('directory', $csvdata->errors['file']);
$form->set_error('file', get_string('invalidlistingfile', 'admin'));
return;
}
$ziptypes = PluginArtefactFile::get_mimetypes_from_description('zip');
$csverrors = array();
$LEAP2AFILES = array();
$authobj = AuthFactory::create((int) $values['authinstance']);
foreach ($csvdata->data as $key => $line) {
$i = $key + 1;
$username = $line[0];
$filename = $values['directory'] . '/' . $line[1];
if (method_exists($authobj, 'is_username_valid') && !$authobj->is_username_valid($username)) {
$csverrors[] = get_string('uploadcsverrorinvalidusername', 'admin', $i);
}
if (record_exists_select('usr', 'LOWER(username) = ?', strtolower($username)) || isset($LEAP2AFILES[strtolower($username)])) {
$csverrors[] = get_string('uploadcsverroruseralreadyexists', 'admin', $i, hsc($username));
}
if (!is_readable($filename)) {
$csverrors[] = get_string('importfilenotreadable', 'admin', $i, hsc($filename));
}
if (!in_array(mime_content_type($filename), $ziptypes)) {
$csverrors[] = get_string('importfileisnotazipfile', 'admin', hsc($filename));
}
$LEAP2AFILES[strtolower($username)] = $filename;
}
if (empty($csverrors) && !empty($LEAP2AFILES)) {
// Try the unzip command just to check it's installed
$testfile = current($LEAP2AFILES);
$command = sprintf('%s %s %s',
escapeshellcmd(get_config('pathtounzip')),
get_config('unziplistarg'),
escapeshellarg($testfile)
);
$output = array();
exec($command, $output, $returnvar);
if ($returnvar != 0) {
log_debug("unzip command failed with return value $returnvar");
// Let's make it obvious if the cause is obvious :)
if ($returnvar == 127) {
log_debug("This means that 'unzip' isn't installed, or the config var \$cfg->pathtounzip is not"
. " pointing at unzip (see Mahara's file lib/config-defaults.php)");
}
$csverrors[] = get_string('unzipfailed', 'admin', hsc($testfile));
}
foreach ($csvdata->data as $user) {
$username = $user[0];
$filename = $user[1];
$LEAP2AFILES[$username] = "$importdir/users/$filename";
}
if (!empty($csverrors)) {
$form->set_error('directory', implode("<br />\n", $csverrors));
$LEAP2AFILES = array();
}
}
/**
......
htdocs/lang/en.utf8/admin.php
View file @ c92b7874
......@@ -330,16 +330,20 @@ $string['uploadcsvfailedusersexceedmaxallowed'] = 'No users have been added beca
// Bulk leap2a import
$string['bulkleap2aimport'] = 'Import users from LEAP2A files';
$string['bulkleap2aimportdescription'] = '<p>You can import users in bulk from a collection of LEAP2A files on your server. You must specify a directory on the filesystem which contains all the LEAP2A zip files, and a single CSV file called import.csv, mapping usernames to filenames.</p>
<p>import.csv will look something like this:</p>
$string['bulkleap2aimportdescription'] = '<p>You can import users in bulk from a collection of LEAP2A files on your server. You must specify a zip file on the server filesystem which contains all the LEAP2A zip files, and a single CSV file called usernames.csv, mapping usernames to filenames.</p>
<p>usernames.csv will look something like this:</p>
<pre>
&nbsp;&nbsp;bob,mahara-export-leap-user8-1265165366.zip<br>
&nbsp;&nbsp;nigel,mahara-export-leap-user1-1266458159.zip
</pre>
<p>where mahara-export-leap-user8-1265165366.zip and mahara-export-leap-user1-1266458159.zip are files in the same directory as import.csv.</p>
<p>where mahara-export-leap-user8-1265165366.zip and mahara-export-leap-user1-1266458159.zip are files in a subdirectory called users.</p>
<p>This zip file should normally be generated using the bulk export built into Mahara.</p>
<p>If you are importing a lot of users, please be patient. The import process can take a long time.</p>';
$string['Directory'] = 'Directory';
$string['bulkleap2aimportdirdescription'] = 'The directory on your server containing import.csv and your LEAP2A files';
$string['importfile'] = 'Bulk export file';
$string['importfilemissinglisting'] = 'The bulk export file is missing a file named usernames.csv. Did you use the Mahara bulk exporter to export these users?';
$string['importfilenotafile'] = 'Error during form submission: file was not recognised';
$string['importfilenotreadable'] = 'Error during form submission: file was not readable';
$string['bulkleap2aimportfiledescription'] = 'The zip file on your server containing all exported users (in LEAP2A format) along with a CSV listing of usernames';
$string['importednuserssuccessfully'] = 'Imported %d of %d users successfully';
$string['Import'] = 'Import';
$string['bulkimportdirdoesntexist'] = 'The directory %s does not exist';
......@@ -349,7 +353,7 @@ $string['importfilenotreadable'] = 'Unable to read LEAP2A file %s';
$string['importfileisnotazipfile'] = 'Import file %s was not detected as a zip file';
$string['unzipfailed'] = 'Failed to unzip the LEAP2A file %s. See the error log for more information.';
$string['importfailedfornusers'] = 'Import failed for %d of %d users';
$string['invalidlistingfile'] = 'Invalid username listing. Did you use the Mahara bulk exporter to export these users?';
// Admin Users
$string['adminuserspagedescription'] = '<p>Here you can choose which users are administrators for the site. The current administrators are listed on the right, and potential administrators are on the left.</p><p>The system must have at least one administrator.</p>';
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment