--- rat/lonratedt.pm 2002/05/14 15:19:13 1.16 +++ rat/lonratedt.pm 2012/12/16 16:02:15 1.105.2.3 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Edit Handler for RAT Maps # -# $Id: lonratedt.pm,v 1.16 2002/05/14 15:19:13 www Exp $ +# $Id: lonratedt.pm,v 1.105.2.3 2012/12/16 16:02:15 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,167 +25,50 @@ # # http://www.lon-capa.org/ # -# (TeX Content Handler -# -# 05/29/00,05/30 Gerd Kortemeyer) -# 7/1,6/30 Gerd Kortemeyer + package Apache::lonratedt; use strict; use Apache::Constants qw(:common); use Apache::lonnet; -use Apache::lonratsrv; - -my @order=(); -my @resources=(); - - -# Mapread read maps into global arrays @links and @resources, determines status -# sets @order - pointer to resources in right order -# sets @resources - array with the resources with correct idx -# -sub mapread { - my $fn=shift; - - my @links; - undef @links; - undef @resources; - undef @order; - - my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,''); - if ($errtext) { return ($errtext,2); } - -# -------------------------------------------------------------------- Read map - foreach (split(/\<\&\>/,$outtext)) { - my ($command,$number,$content)=split(/\<\:\>/,$_); - if ($command eq 'objcont') { - $resources[$number]=$content; - } - if ($command eq 'objlinks') { - $links[$number]=$content; - } - } -# ------------------------------------------------------- Is this a linear map? - my @starters=(); - my @endings=(); - undef @starters; - undef @endings; - - foreach (@links) { - if (defined($_)) { - my ($start,$end,$cond)=split(/\:/,$_); - if ((defined($starters[$start])) || (defined($endings[$end]))) { - return - ('Map has branchings. Use advanced editor.',1); - } - $starters[$start]=1; - $endings[$end]=1; - if ($cond) { - return - ('Map has conditions. Use advanced editor.',1); - } - } - - } - for (my $i=0; $i<=$#resources; $i++) { - if (defined($resources[$i])) { - unless (($starters[$i]) || ($endings[$i])) { - return - ('Map has unconnected resources. Use advanced editor.',1); - } - } - } - -# -------------------------------------------------- This is a linear map, sort - - my $startidx=0; - my $endidx=0; - for (my $i=0; $i<=$#resources; $i++) { - if (defined($resources[$i])) { - my ($title,$url,$ext,$type)=split(/\:/,$resources[$i]); - if ($type eq 'start') { $startidx=$i; } - if ($type eq 'finish') { $endidx=$i; } - } - } - my $k=0; - my $currentidx=$startidx; - $order[$k]=$currentidx; - for (my $i=0; $i<=$#resources; $i++) { - foreach (@links) { - my ($start,$end)=split(/\:/,$_); - if ($start==$currentidx) { - $currentidx=$end; - $k++; - $order[$k]=$currentidx; - last; - } - } - if ($currentidx==$endidx) { last; } - } - return $errtext; -} - -# ---------------------------------------------- Read a map as well as possible - -sub attemptread { - my $fn=shift; - - my @links; - undef @links; - my @theseres; - undef @theseres; - - my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,''); - if ($errtext) { return @theseres } - -# -------------------------------------------------------------------- Read map - foreach (split(/\<\&\>/,$outtext)) { - my ($command,$number,$content)=split(/\<\:\>/,$_); - if ($command eq 'objcont') { - $theseres[$number]=$content; - } - if ($command eq 'objlinks') { - $links[$number]=$content; - } - } - -# --------------------------------------------------------------- Sort, sort of - - my $startidx=0; - my $endidx=0; - for (my $i=0; $i<=$#theseres; $i++) { - if (defined($theseres[$i])) { - my ($title,$url,$ext,$type)=split(/\:/,$theseres[$i]); - if ($type eq 'start') { $startidx=$i; } - if ($type eq 'finish') { $endidx=$i; } - } - } - - - return @theseres; - -} - +use Apache::lonsequence(); +use Apache::loncommon(); +use Apache::lonlocal; +use LONCAPA::map(); +use File::Copy; +use LONCAPA; +use HTML::Entities(); # --------------------------------------------------------- Build up RAT screen sub ratedt { my ($r,$url)=@_; - $r->print(< - - - - - - - - - +'; + + my $start_page = + &Apache::loncommon::start_page('Edit Sequence',$js, + {'frameset' => 1, + 'add_entries' => \%layout}); + + my $end_page = + &Apache::loncommon::end_page({'frameset' => 1}); + $r->print(< + + +$end_page ENDDOCUMENT } @@ -193,131 +76,37 @@ ENDDOCUMENT sub buttons { my $adv=shift; - my $output='
'; + my $output=''; if ($adv==1) { - $output.=''; + $output.= + '' + .&Apache::loncommon::help_open_topic( + 'Sequence_Advanced_Editor_Creation'); } else { unless ($adv==2) { - $output.=''; - } - $output.=''; - } - return $output.'
'; -} - -sub smpedt { - my ($r,$errtext)=@_; - my $buttons=&buttons(2); - -# ---------------------------------------------------------- Process form input - - my @importselect=(); - my @targetselect=(); - undef @importselect; - undef @targetselect; - if (defined($ENV{'form.import'})) { - if (ref($ENV{'form.import'})) { - @importselect=sort($ENV->{'form.import'}); - } else { - @importselect=($ENV{'form.import'}); - } - } - if (defined($ENV{'form.target'})) { - if (ref($ENV{'form.target'})) { - @targetselect=sort($ENV->{'form.target'}); - } else { - @targetselect=($ENV{'form.target'}); - } - } -# ============================================================ Process commands - - my $targetdetail=$ENV{'form.targetdetail'}; - my $importdetail=$ENV{'form.curimpdetail'}; - -# ---------------------------------------------------- Importing from groupsort - if (($ENV{'form.importdetail'}) && (!$ENV{'form.impfortarget'})) { - - $importdetail=''; - my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); - - my $lastsel; - - if (defined($importselect[-1])) { - $lastsel=$importselect[-1]; - } else { - $lastsel=$#curimport; - } - - for (my $i=0;$i<=$lastsel;$i++) { - my ($name,$url)=split(/\=/,$curimport[$i]); - if ($url) { - $importdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); - } - } - - $importdetail.='&'.$ENV{'form.importdetail'}; - - for (my $i=$lastsel+1;$i<=$#curimport;$i++) { - my ($name,$url)=split(/\=/,$curimport[$i]); - if ($url) { - $importdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); - } - } - $importdetail=~s/\&+/\&/g; - $importdetail=~s/^\&//; - -# ------------------------------------------------------------------- Clear all - } elsif ($ENV{'form.clear'}) { - $importdetail=''; -# ------------------------------------------------------------ Discard selected - } elsif ($ENV{'form.discard'}) { - $importdetail=''; - my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); - foreach (@importselect) { - $curimport[$_]=''; - } - for (my $i=0;$i<=$#curimport;$i++) { - my ($name,$url)=split(/\=/,$curimport[$i]); - if ($url) { - $importdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); - } - } -# --------------------------- - } - -# ------------------------------------------------------------ Assemble windows - - my $idx=-1; - my $importwindow=join("\n",map { - $idx++; - if ($_) { - my ($name,$url)=split(/\=/,$_); - unless ($name) { $name=(split(/\//,$url))[-1]; } - unless ($name) { $name='EMPTY'; } - ''; - } - } split(/\&/,$importdetail)); - - $idx=0; - my $targetwindow=join("\n",map { - my ($name,$url)=split(/\:/,$resources[$_]); - unless ($name) { $name=(split(/\//,$url))[-1]; } - unless ($name) { $name='EMPTY'; } - $targetdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); - $idx++; - ''; - } @order); - -# ----------------------------------------------------- Start simple RAT screen - $r->print(< - - - - -$buttons -$errtext -
- +ENDJS + + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Construction Space', + href => &Apache::loncommon::authorspace($url), + faq => 6, + bug => 'RAT', + help => 'Sequence_Simple_Editor_Creation',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'RAT', + title => 'Resource Assembly Tool', + href => '',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Editor', + title => 'Simple Editor', + href => '',}); + + # Breadcrumbs are included by &start_page + my $start_page = &Apache::loncommon::start_page('Construction Space',$js) + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader() + .&buttons(2)); + my $end_page = &Apache::loncommon::end_page(); + + $r->print(<$errtext + + + + + - + - + - -
Import
$lt{'ta'}  Target
File: $url
- - -after selected -
- -
- - - + + +$lt{'as'} +
+ +
+ + + 		  - - -after selected -
+ + + + +$lt{'as'} +
+ + + +
$targetmsg + + +
-Cut selected
-

-

-Paste after selected
- +$lt{'cs'}
+

+

+$lt{'ps'}
+

+ +$lt{'pas'}
+

- - - - + + + + - +$end_page ENDSMPHEAD } # ----------------------------------------------------------------- No such dir sub nodir { my ($r,$dir)=@_; - $dir=~s/^\/home\/\w+\/public\_html//; - $r->print(< - -

No such directory: $dir

- - -ENDNODIR + my $londocroot = $r->dir_config('lonDocRoot'); + my ($path) = ($dir =~ m{^\Q$londocroot\E?(/priv/[^/]+/[^/]+/)}); + $dir=~s{^\Q$londocroot/priv/\E[^/]+/[^/]+}{}; + my $brcrum = [{'href' => &Apache::loncommon::authorspace($path), + 'text' => 'Construction Space'}]; +# {'href' => '', +# 'text' => 'No such directory'}]; + $r->print(&Apache::loncommon::start_page('Construction Space', + undef, + {'bread_crumbs' => $brcrum,}) + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader()) + .'

' + .&mt('No such directory: [_1]',''.$dir.'' + .'

' + .&Apache::loncommon::end_page()) + ); } # ---------------------------------------------------------------- View Handler sub viewmap { - my ($r,$adv,$errtext)=@_; - $r->print(''.&buttons($adv)); + my ($r,$url,$adv,$errtext)=@_; + + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'Construction Space', + href => &Apache::loncommon::authorspace($url), + faq => 6, + bug => 'RAT', + help => 'Sequence_Simple_Editor_Creation',}); + &Apache::lonhtmlcommon::add_breadcrumb({ + text => 'RAT', + title => 'Resource Assembly Tool', + href => '',}); + + # Breadcrumbs are included by &start_page + $r->print(&Apache::loncommon::start_page('Edit Content of a Map') + .&Apache::loncommon::head_subbox( + &Apache::loncommon::CSTR_pageheader() + .&buttons($adv)) + ); if ($errtext) { - $r->print($errtext.'
'); - } - foreach (@resources) { + $r->print('
' + .$errtext + .'
' + .'
' + ); + } + my $idx=0; + $r->print('

'.$url.'

'); + if ($adv) { + $r->print('

' + .&mt('Map contents are not shown in order.') + .'


' + ); + } + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .''.&mt('Type').'' + .''.&mt('Title in map').'' + .''.&mt('Filename of resource').'' + .''.&mt('Link to published resource').'' + .''.&mt('Link to resource in Construction Space').'' + .&Apache::loncommon::end_data_table_header_row() + ); + foreach (&LONCAPA::map::attemptread(&Apache::lonnet::filelocation('',$url))) { if (defined($_)) { - my ($title,$url)=split(/\:/,$_); - $title=~s/\&colon\;/\:/g; - $url=~s/\&colon\;/\:/g; + $idx++; + my ($title,$url,$cond)=split(/\:/,$_); + if ($cond eq 'cond') { next; } + $title= &LONCAPA::map::qtescape($title); + $url = &LONCAPA::map::qtescape($url); unless ($title) { $title=(split(/\//,$url))[-1] }; - unless ($title) { $title='Empty'; } + unless ($title) { $title=''.&mt('Empty').''; } + my $resurl = $url; + my $resfilepath = $Apache::lonnet::perlvar{'lonDocRoot'}.$resurl; + my $filename; + if ($resurl =~ m#/([^/]+)$#) { + $filename = $1; + } + my $cstrurl = $resurl; + $cstrurl =~ s{^/res/}{/priv/}; + $r->print(&Apache::loncommon::start_data_table_row() + .'' + .'' + .'' + .'' + .&HTML::Entities::encode(&LONCAPA::map::qtescape($title)) + .'' + .''.$filename.'' + .'' + ); if ($url) { - $r->print(''); + $r->print(''.&mt('Resource space').''); + } else { + $r->print(' '); } - $r->print(&Apache::lonratsrv::qtescape($title)); - if ($url) { $r->print(''); } - $r->print('
'); + $r->print(''); + if ($url) { + $r->print(''. + &mt('Construction space').''); + } else { + $r->print(' '); + } + $r->print('' + .&Apache::loncommon::end_data_table_row() + ); } } - $r->print(''); + $r->print(&Apache::loncommon::end_data_table()); + $r->print(&Apache::loncommon::end_page()); } # ================================================================ Main Handler sub handler { my $r=shift; - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK if $r->header_only; - + my $target = $env{'form.grade_target'}; + if ($target eq 'meta') { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + return OK; + } + my $url=$r->uri; my $fn=&Apache::lonnet::filelocation('',$url); @@ -538,8 +790,8 @@ sub handler { # ------------------------------------------- Determine which tools can be used my $adv=0; - unless ($ENV{'form.forcesmp'}) { - if ($ENV{'form.forceadv'}) { + unless ($env{'form.forcesmp'}) { + if ($env{'form.forceadv'}) { $adv=1; } elsif (my $fh=Apache::File->new($fn)) { my $allmap=join('',<$fh>); @@ -551,18 +803,18 @@ sub handler { my $fatal=0; # -------------------------------------------------------------------- Load map - ($errtext,$fatal)=&mapread($fn,$errtext); + ($errtext,$fatal)=&LONCAPA::map::mapread($fn,$errtext); if ($fatal==1) { $adv=1; } # ----------------------------------- adv==1 now means "graphical MUST be used" - if ($ENV{'form.forceadv'}) { + if ($env{'form.forceadv'}) { &ratedt($r,$url); - } elsif ($ENV{'form.forcesmp'}) { - &smpedt($r,$errtext); + } elsif ($env{'form.forcesmp'}) { + &smpedt($r,$url,$errtext); } else { - &viewmap($r,$adv,$errtext); + &viewmap($r,$url,$adv,$errtext); } return OK; } @@ -572,7 +824,140 @@ __END__ +=pod + +=head1 NAME + +Apache::lonratedt: simple resource assembly tool + +=head1 SYNOPSIS + +lonratedt provides the routines and the handler for the Advanced + Resource Assembly Tool (RAT), and ties the various pieces together + with Javascript. + +=head1 OVERVIEW + +=head2 Map Representation + +=begin latex + +% +\begin{figure} +\begin{center}\includegraphics[% + width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center} + + +\caption{\label{Map_In_Advanced_Editor}Example of a Map in the Advanced Editor} +\end{figure} +% +\begin{figure} +\begin{lyxcode} + + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~ + +~~ + +~~ + +~~ +\end{lyxcode} + +\caption{\label{XML}XML for Map in Figure \ref{Map_In_Advanced_Editor}} +\end{figure} + +=end latex + +Fig. "XML for Map in Figure" shows the XML representation of the +resource map shown in Fig. "Example of a Map in the Advanced Editor", +which is the format in which maps are stored. In the figure, however, +additional graphical map layout information generated by the Advanced +Resource Assembly Tool is not displayed. This graphical information is +optional to re-generate the same graphical layout when the map is +brought up again in the Resource Assembly Tool, and is not needed for +any other system functionality. + +Maps can be generated by tools other than the Resource Assembly +Tool. In particular, an author might have some other representation of +a course sequence, which can be converted into a map using scripts. If +this map then were to be brought up in the Resource Assembly Tool, the +Tool would automatically generate a graphical layout for it. Each +entry of the map (resources, conditions and links) is stored in a +separate tag. + +Resources and conditionsX have to have unique ID +numbers. These numbers are automatically generated by the Resource +Assembly Tool when the entry is first created, or added to the entries +when a map generated outside the Resource Assembly Tool is first +retrieved. They can also be assigned by custom scripts or added in by +hand. + +In the XML example, entry 1 is the start resource of the map. When +this map is accessed, the source (src) URL of this tag will be the +first resource rendered. Entry 2 is the finish resource of this +map. This resource will be the last resource in the sequence of +resources. Entry 6 is a problem resource with the given URL and title, +as well as the priority "mandatory". Entry 19 is a condition, which is +used by the link between entries 6, the problem, and 9, a +sequence. I +=cut