--- loncom/imspackages/imsimport.pm 2006/03/23 23:12:21 1.14
+++ loncom/imspackages/imsimport.pm 2012/10/29 17:38:59 1.38
@@ -1,3 +1,7 @@
+# The LearningOnline Network with CAPA
+#
+# $Id: imsimport.pm,v 1.38 2012/10/29 17:38:59 raeburn Exp $
+#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
@@ -25,36 +29,50 @@ package Apache::imsimport;
use strict;
use Apache::Constants qw(:common :http :methods);
-use Apache::loncacc;
use Apache::loncommon();
use Apache::lonnet;
use Apache::imsprocessor;
+use Apache::lonlocal;
use HTML::Parser;
use HTML::Entities();
use Apache::lonlocal;
use Apache::lonupload;
use File::Basename();
-
+use LONCAPA;
+
# ---------------------------------------------------------------- Jscript One
sub jscript_one {
- my ($fullpath,$jsref) = @_;
+ my ($fullpath,$formname) = @_;
+ my %body_layout = ('rightmargin' => "0",
+ 'leftmargin' => "0",
+ 'marginwidth' => "0",
+ 'topmargin' => "0",
+ 'marginheight' => "0");
my $start_page =
&Apache::loncommon::start_page('Create IMS import directory',undef,
{'only_body' => 1,
- 'add_entries' => "topmargin='0' leftmargin='0' marginheight='0'marginwidth='0' rightmargin='0'",
+ 'add_entries' => \%body_layout,
'js_ready' => 1,});
my $end_page =
&Apache::loncommon::end_page({'js_ready' => 1,});
- $$jsref = <<"END_OF_ONE";
+ my %lt = &Apache::lonlocal::texthash(
+ ddir => 'You must choose a destination directory for the import',
+ cmss => 'You must choose the Course Management System from which the IMS package was exported',
+ loca => 'Location:',
+ newd => 'New Directory',
+ nndi => 'Enter the name of the new directory where you will store the contents of your IMS package.',
+ go => 'Go',
+ );
+ return <<"END_OF_ONE";
function verify() {
- if ((document.forms.dataForm.newdir.value == '') || (!document.forms.dataForm.newdir.value)) {
- alert("You must choose a destination directory for the import")
+ if ((document.forms.$formname.newdir.value == '') || (!document.forms.$formname.newdir.value)) {
+ alert('$lt{'ddir'}')
return false
}
- if (document.forms.dataForm.source.selectedIndex == 0) {
- alert("You must choose the Course Management System from which the IMS package was exported");
+ if (document.forms.$formname.source.selectedIndex == 0) {
+ alert('$lt{'cmss'}');
return false
}
return true
@@ -62,27 +80,27 @@ function verify() {
function nextPage() {
if (verify()) {
- document.forms.dataForm.submit()
+ document.forms.$formname.submit();
}
}
function createWin() {
- document.dataForm.newdir.value = "";
+ document.$formname.newdir.value = "";
newWindow = window.open("","CreateDir","HEIGHT=400,WIDTH=750,scrollbars=yes")
newWindow.document.open()
newWindow.document.write('$start_page')
- newWindow.document.write("\\n\\n")
- newWindow.document.write("
")
newWindow.document.write('$end_page')
@@ -96,7 +114,7 @@ END_OF_ONE
# ---------------------------------------------------------------- Jscript Two
sub jscript_two {
- my ($javascript,$user,$dom,$numcrs) = @_;
+ my ($user,$dom,$numcrs) = @_;
my %crsentry = ();
my $course_list;
my $title_list;
@@ -115,7 +133,7 @@ sub jscript_two {
$course_list = '"'.join('","',@crslist).'"';
$$numcrs = @crslist;
- $$javascript = qq#
+ return <<"END_OF_TWO";
function checkCourse() {
courseID_array = new Array($course_list)
@@ -261,121 +279,39 @@ function nextPage(caller) {
}
}
-#;
+END_OF_TWO
}
-# ---------------------------------------------------------------- Jscript Three
-sub jscript_three {
- my $javascript = shift;
-}
-
# ---------------------------------------------------------------- Display One
sub display_one {
- my ($r,$uname,$fn,$fullpath) = @_;
- $r->print(<<"END_OF_ONE");
-
-END_OF_ONE
+
+
+
+
+
+
+ '."\n".
+ &Apache::lonhtmlcommon::topic_bar(2,&mt('Create a directory where you will unpack your IMS package'))."\n".
+ &mt('Create a destination LON-CAPA directory in which to store the contents of the IMS package file.').'
+
+
+
+
+ ');
}
# ---------------------------------------------------------------- Display Two
sub display_two {
- my ($r,$zipupload,$areas,$areaname,$cmsmap,$uname,$newdir,$numcrs,$fullpath) = @_;
+ my ($r,$zipupload,$areas,$areaname,$cmsmap,$fn,$numcrs,$fullpath) = @_;
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['folder','source']);
my $cms = $env{'form.source'};
- my $dirname = $env{'form.newdir'};
- my $tempdir = &Apache::imsprocessor::create_tempdir('CSTR',$dirname,'');
+ my $tempdir = &Apache::imsprocessor::create_tempdir('CSTR',$env{'form.newdir'},'');
my $fname = &Apache::imsprocessor::uploadzip('CSTR',$tempdir,$zipupload);
my $unzip_result = '';
my $manifest_result = '';
@@ -389,7 +325,24 @@ sub display_two {
my %hrefs = ();
my %resinfo = ();
my %count = ();
- my @bgcolors = ("#eeeeee","#dddddd");
+
+ my %lt = &Apache::lonlocal::texthash(
+ cont => 'Choose which content types you wish to import',
+ impo => 'Import',
+ type => 'Content type',
+ addo => 'Additional options',
+ chec => 'Check Import first',
+ bbus => 'Choose a course to receive bulletin boards and user enrollment',
+ list => 'A listing of possible course targets will be displayed if import of bulletin boards and/or enrollment is checked above (step 3). If you do not plan to import either of these content types, there is no need to specify a course.',
+ chco => 'Choose course:',
+ nreq => 'Not required',
+ yodo => 'You do not have active course coordinator status in any LON-CAPA courses currently, so bulletin boards and enrollment information included in your IMS package will be discarded, regardless of your import choice for these two items above (step 3).',
+ ifyo => "If you wish to import bulletin boards and/or user information into LON-CAPA please click 'Exit now' to quit the current IMS import process, and contact your domain coordinator and request a course coordinator role in a LON-CAPA course into which you can upload bulletin boards and/or enroll users.",
+ impa => 'Import package',
+ unpa => 'Unpacking of your IMS package failed because an IMS manifest file was not located in the package',
+ proc => 'Processing of your IMS package failed because the file you uploaded could not be unzipped',
+ exit => 'Exit now',
+ );
my $counter = 0;
my $iter = 0;
@@ -406,18 +359,20 @@ sub display_two {
users => 0,
);
my $conditions;
-
if ($unzip_result eq 'ok') {
- $manifest_result = &Apache::imsprocessor::process_manifest($cms,$tempdir,\%resources,\%items,\%hrefs,\%resinfo,'choose',\%includedres,\%includeditems);
+ $manifest_result = &Apache::imsprocessor::process_manifest($cms,
+ $tempdir,\%resources,\%items,\%hrefs,\%resinfo,
+ 'choose',\%includedres,\%includeditems);
if ($manifest_result eq 'ok') {
foreach my $res (sort keys %resources) {
- if ($cms eq 'bb5' || $cms eq 'bb6' || $cms eq 'webct4') {
+ if ($cms eq 'bb5' || $cms eq 'bb6' || $cms eq 'webctce4'
+ || $cms eq 'webctvista4') {
foreach my $area (keys %{$$cmsmap{$cms}}) {
if ($resources{$res}{type} eq $$cmsmap{$cms}{$area}) {
$count{$area} ++;
}
}
- } elsif ($cms eq 'angel') {
+ } elsif ($cms eq 'angel5') {
foreach my $area (keys %{$$cmsmap{$cms}}) {
if ($area eq 'doc') {
if (grep/^$resources{$res}{type}$/,@{$$cmsmap{$cms}{doc}}) {
@@ -441,177 +396,82 @@ sub display_two {
$conditions = 'none';
}
- $r->print(<
-
A listing of possible course targets will be displayed if import of bulletin boards and/or enrollment is checked above (step 3). If you do not plan to import either of these content types, there is no need to specify a course.
-
You do not have active course coordinator status in any LON-CAPA courses currently, so bulletin boards and enrollment information included in your IMS package will be discarded, regardless of your import choice for these two items above (step 3). If you wish to import bulletin boards and/or user information into LON-CAPA please click 'Exit now' to quit the current IMS import process, and contact your domain coordinator and request a course coordinator role in a LON-CAPA course into which you can upload bulletin boards and/or enroll users.
- ");
+ $r->print($lt{'yodo'}.' '.$lt{'ifyo'});
}
}
- $r->print(<
-
-
-
-
-
Once you have checked the checkboxes for all areas you wish to import from the IMS package, and selected additional options (if available) you should click the 'Import package' button.
-ENDDOCUMENT
+ $r->print('
+ ');
} else {
- $r->print("Unpacking of your IMS package failed because an IMS manifest file was not located in the package\n");
+ $r->print($lt{'unpa'});
}
} else {
- $r->print("Processing of your IMS package failed because the file you uploaded could not be unzipped\n");
+ $r->print($lt{'proc'});
}
}
# ---------------------------------------------------------------- Display Three
sub display_three {
- my ($r,$uname,$udom,$areas,$areaname,$cmsmap,$destdir,$newdir) = @_;
+ my ($r,$uname,$udom,$areas,$areaname,$cmsmap,$destdir,$dirpath) = @_;
my $crs = '';
my $cdom = '';
my $db_handling = '';
@@ -627,7 +487,7 @@ sub display_three {
if ( defined($env{'form.user_crs'}) ) {
($user_cdom,$user_crs) = split/\//,$env{'form.user_crs'};
}
- my $seqstem = "/res/$udom/$uname/$newdir";
+ my $seqstem = "/res/$udom/$uname/$dirpath";
my %importareas = ();
my %includedres = ();
my %includeditems = ();
@@ -645,17 +505,19 @@ sub display_three {
board => 0,
quiz => 0,
surv => 0,
+ file => 0,
);
my @pages = ();
my @sequences = ();
my @resrcfiles = ();
+ my @assessmentfiles = ();
my $tempdir = $env{'form.tempdir'};
foreach my $area (@{$areas}) {
if (defined($env{"form.$area"}) ) {
- if ($cms eq 'angel' && $area eq 'doc') {
+ if ($cms eq 'angel5' && $area eq 'doc') {
foreach (@{$$cmsmap{$cms}{$area}}) {
$importareas{$_} = 1;
}
@@ -670,11 +532,26 @@ sub display_three {
}
}
- my $manifest_result = &Apache::imsprocessor::process_manifest($cms,$tempdir,\%resources,\%items,\%hrefs,\%resinfo,'prepare',\%includedres);
+ my %lt = &Apache::lonlocal::texthash (
+ yims => 'Your IMS package has been processed successfully.',
+ plsv => 'Please view the imported items and use the LON-CAPA editing tools to make changes.',
+ tseq => "The sequences directory contains a file named 'Top.sequence' which includes links to the items found at the top level of your IMS package. From there you can follow links to display all the imported items. Alternatively, you can browse the pages, sequences, problems and resfiles directories directly. Note if you rename a file, you will need to modify any .sequence files or .page files which include a reference to the renamed file.",
+ tfin => 'The final step in the IMS import process is to publish the materials you have imported into your Construction Space so that you can use them in a course. Once your files are published, subsequent re-publication will result in the storage of information about changes between the different versions.',
+ disp => 'Display new directory',
+ proc => 'Processing of your IMS package failed, because the IMS content package did not contain an IMS manifest file.'
+ );
+ my $manifest_result = &Apache::imsprocessor::process_manifest($cms,$tempdir,
+ \%resources,\%items,\%hrefs,\%resinfo,'prepare',
+ \%includedres);
if ($manifest_result eq 'ok') {
foreach my $res (sort keys %resources) {
if ($importareas{$resources{$res}{type}}) {
$includedres{$res} = 1;
+ if ($resources{$res}{type} eq 'webct.manifest' ||
+ $resources{$res}{type} eq 'webct.assessment' ||
+ $resources{$res}{type} eq 'webct.question') {
+ push(@assessmentfiles,$res);
+ }
}
}
foreach my $itm (sort keys %items) {
@@ -686,7 +563,9 @@ sub display_three {
&Apache::imsprocessor::get_parents(\%includeditems,\%items,$itm);
}
- $manifest_result = &Apache::imsprocessor::process_manifest($cms,$tempdir,\%resources,\%items,\%hrefs,\%resinfo,'build',\%includedres,\%includeditems);
+ $manifest_result = &Apache::imsprocessor::process_manifest($cms,$tempdir,
+ \%resources,\%items,\%hrefs,\%resinfo,'build',
+ \%includedres,\%includeditems);
if ($manifest_result eq 'ok') {
&Apache::imsprocessor::target_resources(\%resources,\%importareas,\@targets);
@@ -705,86 +584,66 @@ sub display_three {
&Apache::imsprocessor::process_resinfo($cms,'CSTR',$tempdir,$destdir,\%items,\%resources,\@targets,\@boards,\@announcements,\@quizzes,\@surveys,\@pools,\@groups,\%messages,\@timestamp,\%boardnum,\%resinfo,$udom,$uname,$cdom,$crs,$db_handling,$user_handling,\%total,$seqstem,$seqstem,\@resrcfiles,\@packages,\%hrefs,\@pages,\@sequences,\%randompicks);
- my $copy_result = &Apache::imsprocessor::copy_resources('CSTR',$cms,\%hrefs,$tempdir,\@targets,\%urls,$crs,$cdom,$destdir,$timenow,\%importareas);
+ my $copy_result = &Apache::imsprocessor::copy_resources('CSTR',$cms,\%hrefs,$tempdir,\@targets,\%urls,$crs,$cdom,$destdir,$timenow,\@assessmentfiles,\%total);
- &Apache::imsprocessor::build_structure($cms,'CSTR',$destdir,\%items,\%resinfo,\%resources,\@targets,\%hrefs,$udom,$uname,$newdir,$timenow,$cdom,$crs,\@timestamp,\%total,\@boards,\@announcements,\@quizzes,\@surveys,\@pools,\%boardnum,\@pages,\@sequences,\@topurls,\@topnames,\@packages,\%includeditems,\%randompicks);
+ &Apache::imsprocessor::build_structure($cms,'CSTR',$destdir,\%items,\%resinfo,\%resources,\@targets,\%hrefs,$udom,$uname,$dirpath,$timenow,$cdom,$crs,\@timestamp,\%total,\@boards,\@announcements,\@quizzes,\@surveys,\@pools,\%boardnum,\@pages,\@sequences,\@topurls,\@topnames,\@packages,\%includeditems,\%randompicks);
$r->print("
IMS import completed
");
- if ($cms eq 'bb5') {
- $r->print("Your IMS package has been processed successfully. A total of $total{seq} sequences, $total{page} pages, $total{board} bulletin boards, $total{quiz} quizzes, $total{surv} surveys and $total{prob} problems have been created.
\n");
- } elsif ($cms eq 'angel') {
- $r->print("Your IMS package has been processed successfully. A total of $total{seq} sequences, $total{page} pages, and $total{board} bulletin boards have been created.
\n");
+ if ($cms eq 'angel5') {
+ $r->print($lt{'yims'}.' '.&mt('A total of [quant,_1,sequence], [quant,_2,composite page], and [quant,_3,bulletin board] have been created, and [quant,_4,file] copied.',$total{seq},$total{page},$total{board},$total{file})."\n");
+ } else {
+ $r->print($lt{'yims'}.' '.&mt('A total of [quant,_1,sequence], [quant,_2,composite page], [quant,_3,bulletin board], [quant,_4,quiz,quizzes], [quant,_5,survey], and [quant,_6,problem] have been created, and [quant,_7,file] copied.',$total{seq},$total{page},$total{board},$total{quiz},$total{surv},$total{prob},$total{file})."\n");
}
- $r->print("Please view the imported items and use the LON-CAPA editing tools to make changes. The sequences directory contains a file named 'Top.sequence' which includes links to the items found at the top level of your IMS package. From there you can follow links to display all the imported items. Alternatively, you can browse the pages, sequences, problems and resfiles directories directly. Note if you rename a file, you will need to modify any .sequence files or .page files which include a reference to the renamed file.
The final step in the IMS import process is to publish the materials you have imported into your Construction Space so that you can use them in a course. Once your file are published, subsequent re-publication will result in the storage of information about changes between the different versions.
Display new directory");
- if ($destdir =~ m-^/home/$uname/public_html/-) {
+ $r->print('
'.$lt{'plsv'}.' '.$lt{'tseq'}.'
'.$lt{'tfin'}.'
'.$lt{'disp'}.'');
+ my $londocroot = $r->dir_config('lonDocRoot');
+ if ($destdir =~ m{^\Q$londocroot/priv/$udom/$uname/$dirpath\E}) {
system (" rm -r -f $destdir/temp");
}
} elsif ($manifest_result eq 'nomanifest') {
- $r->print("Processing of your IMS package failed, because the IMS content package did not contain an IMS manifest file.");
+ $r->print($lt{'proc'});
}
}
# ---------------------------------------------------------------- Get LON-CAPA Course Coordinator roles for this user
sub get_ccroles {
my ($user,$dom,$crsentry,$crslist) = @_;
- my %roles = ();
+ my %roles;
unless ($user eq '') {
- %roles = &Apache::lonnet::dump('roles',$dom,$user);
+ my $ccrole = 'cc';
+ %roles = &Apache::lonnet::get_my_roles($user,$dom,'userroles',undef,[$ccrole]);
}
my $iter = 0;
my @codes = ();
my %courses = ();
my @crslist = ();
my %descrip =();
- foreach my $key (keys %roles ) {
- if ($key =~ m/^\/(\w+)\/(\w+)_cc$/) {
+ foreach my $key (keys(%roles)) {
+ if ($key =~ m{^/($LONCAPA::domain_re)/($LONCAPA::username_re)_cc$}) {
my $cdom = $1;
my $crs = $2;
- my $role_end = 0;
- my $role_start = 0;
- my $active_chk = 1;
- if ( $roles{$key} =~ m/^cc_(\d+)/ ) {
- $role_end = $1;
- if ( $roles{$key} =~ m/^cc_($role_end)_(\d+)$/ )
- {
- $role_start = $2;
- }
- }
- if ($role_start > 0) {
- if (time < $role_start) {
- $active_chk = 0;
- }
- }
- if ($role_end > 0) {
- if (time > $role_end) {
- $active_chk = 0;
- }
+ my $currcode = '';
+ my %settings = &Apache::lonnet::get('environment',['internal.coursecode','description'],$cdom,$crs);
+ if (defined($settings{'description'}) ) {
+ $descrip{$crs} = $settings{'description'};
+ } else {
+ $descrip{$crs} = 'Unknown';
}
- if ($active_chk) {
- my $currcode = '';
- my %settings = &Apache::lonnet::get('environment',['internal.coursecode','description'],$cdom,$crs);
- if (defined($settings{'description'}) ) {
- $descrip{$crs} = $settings{'description'};
- } else {
- $descrip{$crs} = 'Unknown';
- }
- if (defined($settings{'internal.coursecode'}) ) {
- $currcode = $settings{'internal.coursecode'};
- if ($currcode eq '') {
- $currcode = "____".$iter;
- $iter ++;
- }
- } else {
+ if (defined($settings{'internal.coursecode'}) ) {
+ $currcode = $settings{'internal.coursecode'};
+ if ($currcode eq '') {
$currcode = "____".$iter;
$iter ++;
}
- unless (grep/^$currcode$/,@codes) {
- push @codes,$currcode;
- @{$courses{$currcode}} = ();
- }
- push @{$courses{$currcode}}, $cdom.'/'.$crs;
+ } else {
+ $currcode = "____".$iter;
+ $iter ++;
}
+ unless (grep/^$currcode$/,@codes) {
+ push @codes,$currcode;
+ @{$courses{$currcode}} = ();
+ }
+ push @{$courses{$currcode}}, $cdom.'/'.$crs;
}
}
foreach my $code (sort @codes) {
@@ -802,56 +661,43 @@ sub get_ccroles {
# ---------------------------------------------------------------- Main Handler
sub handler {
my $r=shift;
- my $uname;
- my $udom;
- my $javascript = '';
- my $page_name = '';
- my $current_page = '';
- my $loadentries = '';
- my $qcount = '';
-# get personal information for this user
- my $user=$env{'user.name'};
- my $dom=$env{'user.domain'};
+ my $fn=$env{'form.filename'};
-#
-# re-attach user
-#
- if ($env{'form.uploaduname'}) {
- $env{'form.filename'}='/priv/'.$env{'form.uploaduname'}.'/'.
- $env{'form.filename'};
- }
- ($uname,$udom)=
- &Apache::loncacc::constructaccess($env{'form.filename'},
- $r->dir_config('lonDefDomain'));
- unless (($uname) && ($udom)) {
- $r->log_reason($uname.' at '.$udom.
- ' trying to publish file '.$env{'form.filename'}.
- ' - not authorized',
- $r->filename);
- return HTTP_NOT_ACCEPTABLE;
+ if ($env{'form.filename1'}) {
+ $fn=$env{'form.filename1'}.$env{'form.filename2'};
}
-
- my $fn;
- if ($env{'form.filename'}) {
- $fn=$env{'form.filename'};
- $fn=~s/^http\:\/\/[^\/]+\///;
- $fn=~s/^\///;
- $fn=~s/(\~|priv\/)(\w+)//;
- $fn=~s/\/+/\//g;
- } else {
+ $fn=~s{\+}{}g;
+
+ unless ($fn) {
$r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
' unspecified filename for upload', $r->filename);
return HTTP_NOT_FOUND;
}
- my $zipupload = '/home/'.$uname.'/public_html'.$fn;
- my $pathname = &File::Basename::dirname($fn);
- my $fullpath = '/priv/'.$uname.$pathname;
- unless ($pathname eq '/') {
+
+ my ($uname,$udom) = &Apache::lonnet::constructaccess($fn);
+ if (($uname eq '') || ($udom eq '')) {
+ $r->log_reason($uname.' at '.$udom.
+ ' trying to publish file '.$fn.' - not authorized',
+ $r->filename);
+ return HTTP_NOT_ACCEPTABLE;
+ }
+
+ my $londocroot = $r->dir_config('lonDocRoot');
+ my $zipupload = $londocroot.$fn;
+ my $fullpath = &File::Basename::dirname($fn);
+ unless ($fullpath =~ m{/$}) {
$fullpath .= '/';
}
- my $loadentries = '';
+# get personal information for this user
+ my $user=$env{'user.name'};
+ my $dom=$env{'user.domain'};
+
+ my $javascript = '';
+ my $page_name = '';
+ my $current_page = '';
+ my $qcount = '';
my @areas = ();
my %cmsmap = ();
my %areaname = ();
@@ -862,42 +708,50 @@ sub handler {
&Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
+ my $formname_one = 'info';
if ($env{'form.phase'} eq 'two') {
- &jscript_one($fullpath,\$javascript,$uname,$udom);
+ $javascript = &jscript_one($fullpath,$formname_one);
} elsif ($env{'form.phase'} eq 'three') {
- &jscript_two(\$javascript,$user,$dom,\$numcrs);
- } elsif ($env{'form.phase'} eq 'four') {
- &jscript_three(\$javascript);
+ $javascript = &jscript_two($user,$dom,\$numcrs);
+ }
+ if ($javascript ne '') {
+ $javascript = <<"END_JS";
+
+END_JS
}
- $javascript = "\n";
my $title = 'Upload IMS package to Construction Space';
- $r->print(&Apache::loncommon::start_page($title, $javascript,
- {'add_entries' =>
- $loadentries,}));
+ $r->print(&Apache::loncommon::start_page($title, $javascript));
if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
- $r->print('
'.&mt('Co-Author').': '.$uname.
- &mt(' at ').$udom.'