--- loncom/interface/londocs.pm 2007/07/19 00:08:04 1.293.2.1 +++ loncom/interface/londocs.pm 2008/11/17 14:46:10 1.315 @@ -1,7 +1,7 @@ # The LearningOnline Network # Documents # -# $Id: londocs.pm,v 1.293.2.1 2007/07/19 00:08:04 albertel Exp $ +# $Id: londocs.pm,v 1.315 2008/11/17 14:46:10 jms Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,6 +26,22 @@ # http://www.lon-capa.org/ # + +=head1 NAME + +Apache::londocs + +=head1 SYNOPSIS + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 SUBROUTINES + +=over + +=cut + package Apache::londocs; use strict; @@ -53,15 +69,27 @@ my %alreadyseen=(); my $hadchanges; -# Available help topics + +=pod + +=item %help=() + + Available help topics + +=cut my %help=(); -# Mapread read maps into LONCAPA::map:: global arrays -# @order and @resources, determines status -# sets @order - pointer to resources in right order -# sets @resources - array with the resources with correct idx -# +=pod + +=item mapread() + +Mapread read maps into LONCAPA::map:: global arrays +@order and @resources, determines status +sets @order - pointer to resources in right order +sets @resources - array with the resources with correct idx + +=cut sub mapread { my ($coursenum,$coursedom,$map)=@_; @@ -81,7 +109,14 @@ sub storemap { return ($errtext,0); } -# ----------------------------------------- Return hash with valid author names + +=pod + +=item authorhosts() + + Return hash with valid author names + +=cut sub authorhosts { my %outhash=(); @@ -116,7 +151,13 @@ sub authorhosts { } return ($home,$other,%outhash); } -# ------------------------------------------------------ Generate "dump" button +=pod + +=item dumpbutton() + + Generate "dump" button + +=cut sub dumpbutton { my ($home,$other,%outhash)=&authorhosts(); @@ -141,7 +182,14 @@ sub clean { $title=~s/[^\w\/\!\$\%\^\*\-\_\=\+\;\:\,\\\|\`\~]+/\_/gs; return $title; } -# -------------------------------------------------------- Actually dump course + +=pod + +=item dumpcourse() + + Actually dump course + +=cut sub dumpcourse { my ($r) = @_; @@ -228,11 +276,19 @@ sub dumpcourse { my $title=$origcrsdata{'description'}; $title=~s/[\/\s]+/\_/gs; $title=&clean($title); - $r->print('

'.&mt('Folder in Construction Space').'


'); + $r->print('

'.&mt('Folder in Construction Space').'

' + .'
'); &tiehash(); - $r->print('

'.&mt('Filenames in Construction Space').'

'); + $r->print('

'.&mt('Filenames in Construction Space').'

' + .&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .'' + .'' + .'' + .&Apache::loncommon::end_data_table_header_row()); foreach (&Apache::lonclonecourse::crsdirlist($origcrsid,'userfiles')) { - $r->print(''); + $r->print(&Apache::loncommon::start_data_table_row() + .''); my ($ext)=($_=~/\.(\w+)$/); my $title=$hash{'title_'.$hash{ 'ids_/uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'.$_}}; @@ -245,16 +301,23 @@ sub dumpcourse { $title=~s/\.(\w+)$//; $title=&clean($title); $title.='.'.$ext; - $r->print("\n\n"); + $r->print("\n" + .&Apache::loncommon::end_data_table_row()); } - $r->print("
'.&mt('Internal Filename').''.&mt('Title').''.&mt('Save as ...').'
'.&mt('Internal Filename').''.&mt('Title').''.&mt('Save as ...').'
'.$_.''.$_.'
\n"); + $r->print(&Apache::loncommon::end_data_table()); &untiehash(); $r->print( - '

'); + '

'); } } -# ------------------------------------------------------ Generate "export" button +=pod + +=item exportbutton() + + Generate "export" button + +=cut sub exportbutton { my $type = &Apache::loncommon::course_type(); @@ -264,6 +327,12 @@ sub exportbutton { &Apache::loncommon::help_open_topic('Docs_Export_Course_Docs').''; } +=pod + +=item exportcourse() + +=cut + sub exportcourse { my $r=shift; my $type = &Apache::loncommon::course_type(); @@ -309,10 +378,10 @@ sub exportcourse { chdir $cwd; $outcome .= &mt('Download the zip file from IMS '.lc($type).' archive
',$imszipfile,); if ($copyresult) { - $outcome .= 'The following errors occurred during export - '.$copyresult; + $outcome .= &mt('The following errors occurred during export - [_1]',$copyresult); } } else { - $outcome = '
Unfortunately you will not be able to retrieve an IMS archive of this posts at this time, because there was a problem creating a manifest file.
'; + $outcome = '
'.&mt('Unfortunately you will not be able to retrieve an IMS archive of this posts at this time, because there was a problem creating a manifest file.').'
'; } } $r->print(&Apache::loncommon::start_page('Export '.lc($type).' to IMS content package')); @@ -818,7 +887,7 @@ sub extract_media { $dirpath = $url; $container = ''; } - &Apache::lonnet::extract_embedded_items(undef,undef,\%allfiles,\%codebase,$content); + &Apache::lonnet::extract_embedded_items(undef,\%allfiles,\%codebase,$content); foreach my $embed_file (keys(%allfiles)) { my $filename; if ($embed_file =~ m#([^/]+)$#) { @@ -902,8 +971,15 @@ sub store_template { } } -# Imports the given (name, url) resources into the course -# coursenum, coursedom, and folder must precede the list +=pod + +=item group_import() + + Imports the given (name, url) resources into the course + coursenum, coursedom, and folder must precede the list + +=cut + sub group_import { my ($coursenum, $coursedom, $folder, $container, $caller, @files) = @_; @@ -924,7 +1000,7 @@ sub group_import { my $result=&Apache::lonnet::finishuserfileupload($coursenum,$coursedom, 'output',$1.$2); if ($result != m|^/uploaded/|) { - $errtext.='Map not saved: A network error occured when trying to save the new map. '; + $errtext.='Map not saved: A network error occurred when trying to save the new map. '; $fatal = 2; } if ($fatal) { @@ -949,7 +1025,7 @@ sub group_import { } sub breadcrumbs { - my ($where)=@_; + my ($where,$allowed,$type)=@_; &Apache::lonhtmlcommon::clear_breadcrumbs(); my (@folders); if ($env{'form.pagepath'}) { @@ -966,7 +1042,7 @@ sub breadcrumbs { my $is_random_order=0; while (@folders) { my $folder=shift(@folders); - my $foldername=shift(@folders); + my $foldername=shift(@folders); if ($folderpath) {$folderpath.='&';} $folderpath.=$folder.'&'.$foldername; my $url='/adm/coursedocs?folderpath='. @@ -982,6 +1058,13 @@ sub breadcrumbs { if ($2) { $ishidden=1; } if ($3) { $isencrypted=1; } if ($4 ne '') { $is_random_order = 1; } + if ($folder eq 'supplemental') { + if ($allowed) { + $name = &mt('Supplemental '.$type.' Documents'); + } else { + $name = &mt($type.' Documents'); + } + } &Apache::lonhtmlcommon::add_breadcrumb( {'href'=>$url.$cpinfo, 'title'=>$name, @@ -1057,10 +1140,12 @@ sub log_docs { } } +=pod + +=item docs_change_log() + +=cut -# -# Docs Change Log -# sub docs_change_log { my ($r)=@_; my $folder=$env{'form.folder'}; @@ -1201,12 +1286,15 @@ sub update_paste_buffer { # Mark for copying my ($title,$url)=split(':',$LONCAPA::map::resources[$LONCAPA::map::order[$env{'form.markcopy'}]]); if (&is_supplemental_title($title)) { + &Apache::lonnet::appenv({'docs.markedcopy_supplemental' => $title}); ($title) = &parse_supplemental_title($title); + } elsif ($env{'docs.markedcopy_supplemental'}) { + &Apache::lonnet::delenv('docs\\.markedcopy_supplemental'); } $url=~s{http(:|:)//https(:|:)//}{https$2//}; - &Apache::lonnet::appenv('docs.markedcopy_title' => $title, - 'docs.markedcopy_url' => $url); + &Apache::lonnet::appenv({'docs.markedcopy_title' => $title, + 'docs.markedcopy_url' => $url}); delete($env{'form.markcopy'}); } @@ -1227,9 +1315,13 @@ ENDPASTE &LONCAPA::map::qtescape($env{'docs.markedcopy_url'}).')'); } else { my $extension = (split(/\./,$env{'docs.markedcopy_url'}))[-1]; - my $type = &Apache::loncommon::filedescription($extension); - my $icon = ''; + my $icon = &Apache::loncommon::icon($extension); + if ($extension eq 'sequence' && + $env{'docs.markedcopy_url'} =~ m{/default_\d+\.sequence$ }x) { + $icon = &Apache::loncommon::lonhttpdurl($r->dir_config('lonIconsURL')); + $icon .= '/folder_closed.gif'; + } + $icon = ''; $r->print($icon.$type.': '. &parse_supplemental_title(&LONCAPA::map::qtescape($env{'docs.markedcopy_title'}))); } if ($container eq 'page') { @@ -1246,7 +1338,7 @@ ENDPASTE } sub do_paste_from_buffer { - my ($coursenum,$coursedom) = @_; + my ($coursenum,$coursedom,$folder) = @_; return 0 if (!$env{'form.pastemarked'}); @@ -1288,6 +1380,20 @@ sub do_paste_from_buffer { $url = &LONCAPA::map::qtunescape($url); # Now insert the URL at the bottom my $newidx = &LONCAPA::map::getresidx($url); + if ($env{'docs.markedcopy_supplemental'}) { + if ($folder =~ /^supplemental/) { + $title = $env{'docs.markedcopy_supplemental'}; + } else { + (undef,undef,$title) = + &parse_supplemental_title($env{'docs.markedcopy_supplemental'}); + } + } else { + if ($folder=~/^supplemental/) { + $title=time.'___&&&___'.$env{'user.name'}.'___&&&___'. + $env{'user.domain'}.'___&&&___'.$title; + } + } + $LONCAPA::map::resources[$newidx]= $title.':'.$url.':'.$ext.':normal:res'; push(@LONCAPA::map::order, $newidx); # Store the result @@ -1366,7 +1472,7 @@ sub handle_edit_cmd { } sub editor { - my ($r,$coursenum,$coursedom,$folder,$allowed,$upload_output,$which)=@_; + my ($r,$coursenum,$coursedom,$folder,$allowed,$upload_output,$type)=@_; my $container= ($env{'form.pagepath'}) ? 'page' : 'sequence'; @@ -1383,7 +1489,7 @@ sub editor { } my ($breadcrumbtrail,$randompick,$ishidden,$isencrypted,$plain,$is_random_order)= - &breadcrumbs($folder); + &breadcrumbs($folder,$allowed,$type); $r->print($breadcrumbtrail); # ------------------------------------------------------------ Process commands @@ -1408,7 +1514,7 @@ sub editor { } if ($env{'form.pastemarked'}) { - &do_paste_from_buffer($coursenum,$coursedom); + &do_paste_from_buffer($coursenum,$coursedom,$folder); ($errtext,$fatal) = &storemap($coursenum,$coursedom,$folder.'.'.$container); return $errtext if ($fatal); } @@ -1467,7 +1573,7 @@ sub editor { $r->print('

'.&mt('Caution: this folder is set to randomly pick a subset of resources. Adding or removing resources from this folder will change the set of resources that the students see, resulting in spurious or missing credit for completed problems, not limited to ones you modify. Do not modify the contents of this folder if it is in active student use.').'

'); } if ($is_random_order) { - $r->print('

'.&mt('Caution: this folder is set to randomly order its contents. Adding or removing resources from this folder will change the order of resources shown. Do not modify the contents of this folder if it is in active student use.').'

'); + $r->print('

'.&mt('Caution: this folder is set to randomly order its contents. Adding or removing resources from this folder will change the order of resources shown.').'

'); } $r->print(''); foreach my $res (@LONCAPA::map::order) { @@ -1485,8 +1591,9 @@ sub editor { $r->print(''); } $r->print("\n
'.&mt('Currently no documents.').'
\n"); - - &print_paste_buffer($r,$container); + if ($allowed) { + &print_paste_buffer($r,$container); + } return; } @@ -1567,8 +1674,8 @@ sub process_file_upload { $$upload_output .= 'This file contains embedded multimedia objects, which need to be uploaded to LON-CAPA.
'. - &ask_for_embedded_content('/adm/coursedocs', - $state,$allfiles,$codebase); + &Apache::loncommon::ask_for_embedded_content( + '/adm/coursedocs',$state,$allfiles,$codebase); } else { $$upload_output .= 'No embedded items identified
'; } @@ -1578,55 +1685,6 @@ sub process_file_upload { return $phase_status; } -sub ask_for_embedded_content { - my ($actionurl,$state,$allfiles,$codebase,$args)=@_; - my $upload_output = ' -
'; - $upload_output .= $state; - $upload_output .= 'Upload embedded files:
'. - &Apache::loncommon::start_data_table(); - - my $num = 0; - foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) { - $upload_output .= &Apache::loncommon::start_data_table_row(). - ''.$embed_file.''; - if ($args->{'ignore_remote_references'} - && $embed_file =~ m{^\w+://}) { - $upload_output.=''.&mt("URL points to other server.").''; - } elsif ($args->{'error_on_invalid_names'} - && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) { - - $upload_output.=''.&mt("Invalid characters").''; - - } else { - - $upload_output .=' - - '; - my $attrib = join(':',@{$$allfiles{$embed_file}}); - $upload_output .= - "\n\t\t". - ''; - if (exists($$codebase{$embed_file})) { - $upload_output .= - "\n\t\t". - ''; - } - } - $upload_output .= ''.&Apache::loncommon::end_data_table_row(); - $num++; - } - $upload_output .= &Apache::loncommon::end_data_table().'
- - - '.&mt('(only files for which a location has been provided will be uploaded)').' -
'; - return $upload_output; -} - sub process_secondary_uploads { my ($upload_output,$coursedom,$coursenum,$formname,$num,$newidx) = @_; my $folder=$env{'form.folder'}; @@ -1698,7 +1756,6 @@ sub entryline { my $line=''; my ($form_start,$form_end); # Edit commands - my $container; my ($container, $type, $esc_path, $path, $symb); if ($env{'form.folderpath'}) { $type = 'folder'; @@ -1751,7 +1808,7 @@ sub entryline { # no copy for published maps $nocopy = 1; } else { - foreach (&Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$url))) { + foreach (&Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$url),1)) { my ($title,$url,$ext,$type)=split(/\:/,$_); if (($url=~/\.(page|sequence)/) && ($type ne 'zombie')) { $nocopy=1; @@ -1976,7 +2033,13 @@ ENDPARMS return $line; } -# ---------------------------------------------------------------- tie the hash +=pod + +=item tiehash() + +tie the hash + +=cut sub tiehash { my ($mode)=@_; @@ -2002,7 +2065,15 @@ sub untiehash { return OK; } -# --------------------------------------------------------------- check on this + +=pod + +=item checkonthis() + +check on this + +=cut + sub checkonthis { my ($r,$url,$level,$title)=@_; @@ -2011,6 +2082,9 @@ sub checkonthis { $r->rflush(); if (($url) && ($url!~/^\/uploaded\//) && ($url!~/\*$/)) { $r->print("\n
"); + if ($level==0) { + $r->print("
"); + } for (my $i=0;$i<=$level*5;$i++) { $r->print(' '); } @@ -2020,7 +2094,7 @@ sub checkonthis { my $result=&Apache::lonnet::repcopy( &Apache::lonnet::filelocation('',$url)); if ($result eq 'ok') { - $r->print(''.&mt('ok').''); + $r->print(''.&mt('ok').''); $r->rflush(); &Apache::lonnet::countacc($url); $url=~/\.(\w+)$/; @@ -2030,7 +2104,7 @@ sub checkonthis { for (my $i=0;$i<=$level*5;$i++) { $r->print(' '); } - $r->print('- '.&mt('Rendering').': '); + $r->print('- '.&mt('Rendering:').' '); my ($errorcount,$warningcount)=split(/:/, &Apache::lonnet::ssi_body($url, ('grade_target'=>'web', @@ -2039,13 +2113,11 @@ sub checkonthis { ($warningcount)) { if ($errorcount) { $r->print(''. - $errorcount.' '. - &mt('error(s)').' '); + &mt('[quant,_1,error]',$errorcount).''); } if ($warningcount) { $r->print(''. - $warningcount.' '. - &mt('warning(s)').''); + &mt('[quant,_1,warning]',$warningcount).''); } } else { $r->print(''.&mt('ok').''); @@ -2063,21 +2135,27 @@ sub checkonthis { $r->print(''.&mt('connection down').''); } elsif ($result eq 'not_found') { unless ($url=~/\$/) { - $r->print(''.&mt('not found').''); + $r->print(''.&mt('not found').''); } else { $r->print(''.&mt('unable to verify variable URL').''); } } else { $r->print(''.&mt('access denied').''); } - } - } + } + } } -# -# ----------------------------------------------------------------- List Symbs -# + +=pod + +=item list_symbs() + +List Symbs + +=cut + sub list_symbs { my ($r) = @_; @@ -2093,9 +2171,14 @@ sub list_symbs { } -# -# -------------------------------------------------------------- Verify Content -# +=pod + +=item verifycontent() + +Verify Content + +=cut + sub verifycontent { my ($r) = @_; my $type = &Apache::loncommon::course_type(); @@ -2125,8 +2208,13 @@ sub verifycontent { &mt('Return to DOCS').''); } +=pod -# -------------------------------------------------------------- Check Versions +=item devalidateversioncache() & checkversions() + +Check Versions + +=cut sub devalidateversioncache { my $src=shift; @@ -2430,13 +2518,19 @@ sub changewarning { $help{'Caching'}.''."\n\n"); } -# =========================================== Breadcrumbs for special functions +=pod + +=item init_breadcrumbs() + +Breadcrumbs for special functions + +=cut sub init_breadcrumbs { my ($form,$text)=@_; &Apache::lonhtmlcommon::clear_breadcrumbs(); &Apache::lonhtmlcommon::add_breadcrumb({href=>"/adm/coursedocs", - text=>&Apache::loncommon::course_type()." Documents", + text=>"Edit ".&Apache::loncommon::course_type(), faq=>273, bug=>'Instructor Interface', help => 'Docs_Adding_Course_Doc'}); @@ -2446,7 +2540,15 @@ sub init_breadcrumbs { bug=>'Instructor Interface'}); } -# ================================================================ Main Handler + +=pod + +=item handler() + +Main Handler + +=cut + sub handler { my $r = shift; &Apache::loncommon::content_type($r,'text/html'); @@ -2510,6 +2612,26 @@ sub handler { &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['folderpath','pagepath', 'pagesymb']); +# No folderpath, no pagepath, see if we have something stored + if ((!$env{'form.folderpath'}) && (!$env{'form.pagepath'})) { + &Apache::loncommon::restore_course_settings('docs_folderpath', + {'folderpath' => 'scalar'}); + } + if (!$env{'form.folderpath'}) { + &Apache::loncommon::restore_course_settings('docs_folderpath', + {'pagepath' => 'scalar'}); + } + if ($env{'form.pagepath'}) { + $env{'form.folderpath'}=''; + } + if ($env{'form.folderpath'} =~ /^supplemental_\d+/) { + $env{'form.folderpath'} = 'supplemental&'. + &escape(&mt('Supplemental '.$type.' Documents')).'&'. + $env{'form.folderpath'}; + } + &Apache::loncommon::store_course_settings('docs_folderpath', + {'pagepath' => 'scalar', + 'folderpath' => 'scalar'}); if ($env{'form.folderpath'}) { my (@folderpath)=split('&',$env{'form.folderpath'}); $env{'form.foldername'}=&unescape(pop(@folderpath)); @@ -2571,9 +2693,13 @@ sub handler { if (($env{'form.uploaddoc.filename'}) && ($env{'form.cmd'}=~/^upload_(\w+)/)) { # Process file upload - phase one - upload and parse primary file. + undef($hadchanges); $upload_result = &process_file_upload(\$upload_output,$coursenum, $coursedom,\%allfiles, \%codebase,$1); + if ($hadchanges) { + &mark_hash_old(); + } if ($upload_result eq 'phasetwo') { $r->print($upload_output); } @@ -2675,6 +2801,7 @@ sub handler { 'bull' => 'Bulletin Board', 'mypi' => 'My Personal Info', 'grpo' => 'Group Files', + 'rost' => 'Course Roster', 'abou' => 'About User', 'imsf' => 'Import IMS package', 'file' => 'File', @@ -2766,7 +2893,7 @@ ENDCOURSEVERIFY } $hadchanges=0; my $error = &editor($r,$coursenum,$coursedom,$folder,$allowed, - $upload_output); + $upload_output,$type); if ($error) { $r->print('

'.$error.'

'); } @@ -2803,7 +2930,7 @@ $uploadtag

@@ -2883,7 +3010,7 @@ value="$lt{'newp'}" />$help{'Adding_Page
$uploadtag +value="$lt{'syll'}=/public/$coursedom/$coursenum/syllabus" /> $help{'Syllabus'} @@ -2892,7 +3019,7 @@ value="Syllabus=/public/$coursedom/$cour
$uploadtag +value="$lt{'navc'}=/adm/navmaps" /> $help{'Navigate_Content'} @@ -2960,12 +3087,21 @@ onClick="javascript:makeabout();" />
$uploadtag +value="$lt{'grpo'}=/adm/$coursedom/$coursenum/aboutme" /> $help{'Group Files'} +
+$uploadtag + + + +$help{'Course Roster'} + +
ENDFORM } if ($env{'form.pagepath'}) { @@ -3003,11 +3139,11 @@ ENDBLOCK $folder='supplemental'; } if ($folder =~ /^supplemental$/ && - $env{'form.folderpath'} =~ /^default\&/) { - $env{'form.folderpath'}='supplemental&'. - &escape(&mt('Supplemental '.$type.' Documents')); + (($env{'form.folderpath'} =~ /^default\&/) || ($env{'form.folderpath'} eq ''))) { + $env{'form.folderpath'} = 'supplemental&'. + &escape(&mt('Supplemental '.$type.' Documents')); } - my $error = &editor($r,$coursenum,$coursedom,$folder,$allowed); + my $error = &editor($r,$coursenum,$coursedom,$folder,$allowed,'',$type); if ($error) { $r->print('

'.$error.'

'); } @@ -3115,10 +3251,33 @@ ENDSUPFORM sub editing_js { my ($udom,$uname) = @_; my $now = time(); + my %lt = &Apache::lonlocal::texthash( + p_mnf => 'Name of New Folder', + t_mnf => 'New Folder', + p_mnp => 'Name of New Page', + t_mnp => 'New Page', + p_mxu => 'Title for the Uploaded Score', + p_msp => 'Title for the Page', + p_msb => 'Title for the Problem', + p_mdb => 'Title for the Drop Box', + p_mbb => 'Title for the Bulletin Board', + p_mab => "Enter user:domain for User's 'About Me' Page", + p_mab2 => "About [_99]", + p_mab_alrt1 => 'Not a valid user:domain', + p_mab_alrt2 => 'Please enter both user and domain in the format user:domain', + p_chn => 'New Title', + p_rmr1 => 'WARNING: Removing a resource makes associated grades and scores inaccessible!', + p_rmr2a => 'Remove[_99]', + p_rmr2b => '?[_99]', + p_ctr1a => 'WARNING: Cutting a resource makes associated grades and scores inaccessible!', + p_ctr1b => 'Grades remain inaccessible if resource is pasted into another folder.', + p_ctr2a => 'Cut[_98]', + p_ctr2b => '?[_98]' + ); return <