--- loncom/interface/lonhtmlcommon.pm 2003/02/20 14:34:59 1.13 +++ loncom/interface/lonhtmlcommon.pm 2006/05/12 16:45:41 1.128 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.13 2003/02/20 14:34:59 matthew Exp $ +# $Id: lonhtmlcommon.pm,v 1.128 2006/05/12 16:45:41 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -55,8 +55,180 @@ html. package Apache::lonhtmlcommon; -use Time::Local; use strict; +use Time::Local; +use Time::HiRes; +use Apache::lonlocal; +use Apache::lonnet; + +############################################## +############################################## + +=pod + +=item authorbombs + +=cut + +############################################## +############################################## + +sub authorbombs { + my $url=shift; + $url=&Apache::lonnet::declutter($url); + my ($udom,$uname)=($url=~/^(\w+)\/(\w+)\//); + my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom); + foreach (keys %bombs) { + if ($_=~/^$udom\/$uname\//) { + return ''. + &Apache::loncommon::help_open_topic('About_Bombs'); + } + } + return ''; +} + +############################################## +############################################## + +sub recent_filename { + my $area=shift; + return 'nohist_recent_'.&Apache::lonnet::escape($area); +} + +sub store_recent { + my ($area,$name,$value)=@_; + my $file=&recent_filename($area); + my %recent=&Apache::lonnet::dump($file); + if (scalar(keys(%recent))>20) { +# remove oldest value + my $oldest=time; + my $delkey=''; + foreach (keys %recent) { + my $thistime=(split(/\&/,$recent{$_}))[0]; + if ($thistime<$oldest) { + $oldest=$thistime; + $delkey=$_; + } + } + &Apache::lonnet::del($file,[$delkey]); + } +# store new value + &Apache::lonnet::put($file,{ $name => + time.'&'.&Apache::lonnet::escape($value) }); +} + +sub remove_recent { + my ($area,$names)=@_; + my $file=&recent_filename($area); + return &Apache::lonnet::del($file,$names); +} + +sub select_recent { + my ($area,$fieldname,$event)=@_; + my %recent=&Apache::lonnet::dump(&recent_filename($area)); + my $return="\n\n"; + return $return; +} + +sub get_recent { + my ($area, $n) = @_; + my %recent=&Apache::lonnet::dump(&recent_filename($area)); + +# Create hash with key as time and recent as value + my %time_hash = (); + foreach (keys %recent) { + my $thistime=(split(/\&/,$recent{$_}))[0]; + $time_hash{$thistime} = $_; + } + +# Sort by decreasing time and return key value pairs + my %return_hash = (); + my $idx = 1; + foreach (reverse sort keys %time_hash) { + $return_hash{$time_hash{$_}} = + &Apache::lonnet::unescape((split(/\&/,$recent{$_}))[1]); + if ($n && ($idx++ >= $n)) {last;} + } + + return %return_hash; +} + + + +=pod + +=item textbox + +=cut + +############################################## +############################################## +sub textbox { + my ($name,$value,$size,$special) = @_; + $size = 40 if (! defined($size)); + $value = &HTML::Entities::encode($value,'<>&"'); + my $Str = ''; + return $Str; +} + +############################################## +############################################## + +=pod + +=item checkbox + +=cut + +############################################## +############################################## +sub checkbox { + my ($name,$checked,$value) = @_; + my $Str = ' @@ -128,57 +354,106 @@ sub date_setter { document.$formname.$dname\_day.value = 30; } } + + function $dname\_disable() { + document.$formname.$dname\_month.disabled=true; + document.$formname.$dname\_day.disabled=true; + document.$formname.$dname\_year.disabled=true; + document.$formname.$dname\_hour.disabled=true; + document.$formname.$dname\_minute.disabled=true; + document.$formname.$dname\_second.disabled=true; + } + + function $dname\_enable() { + document.$formname.$dname\_month.disabled=false; + document.$formname.$dname\_day.disabled=false; + document.$formname.$dname\_year.disabled=false; + document.$formname.$dname\_hour.disabled=false; + document.$formname.$dname\_minute.disabled=false; + document.$formname.$dname\_second.disabled=false; + } + + function $dname\_opencalendar() { + if (! document.$formname.$dname\_month.disabled) { + var calwin=window.open( +"/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+ +document.$formname.$dname\_month.value+"&year="+ +document.$formname.$dname\_year.value, + "LONCAPAcal", + "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no"); + } + + } ENDJS - $result .= " }; + # Month my @Months = qw/January February March April May June July August September October November December/; # Pad @Months with a bogus value to make indexing easier unshift(@Months,'If you can read this an error occurred'); + if ($includeempty) { $monthselector.=""; } for(my $m = 1;$m <=$#Months;$m++) { - $result .= " \n"; + } + $hourselector .= " \n"; + my $minuteselector = qq{}; + my $secondselector= qq{}; + my $cal_link = qq{}; + # + if ($no_hh_mm_ss) { + $result .= &mt('[_1] [_2] [_3] [_4]Select Date[_5]', + $monthselector,$dayselector,$yearselector, + $cal_link,''); + } else { + $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s [_7]Select Date[_8]', + $monthselector,$dayselector,$yearselector, + $hourselector,$minuteselector,$secondselector, + $cal_link,''); + } + $result .= "\n\n"; return $result; } ############################################## ############################################## +=pod + =item &get_date_from_form +get_date_from_form retrieves the date specified in an &date_setter form. + Inputs: =over 4 @@ -203,43 +478,54 @@ sub get_date_from_form { my ($dname) = @_; my ($sec,$min,$hour,$day,$month,$year); # - if (defined($ENV{'form.'.$dname.'_second'})) { - my $tmpsec = $ENV{'form.'.$dname.'_second'}; + if (defined($env{'form.'.$dname.'_second'})) { + my $tmpsec = $env{'form.'.$dname.'_second'}; if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) { $sec = $tmpsec; } + if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; } + } else { + $sec = 0; } - if (defined($ENV{'form.'.$dname.'_minute'})) { - my $tmpmin = $ENV{'form.'.$dname.'_minute'}; + if (defined($env{'form.'.$dname.'_minute'})) { + my $tmpmin = $env{'form.'.$dname.'_minute'}; if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) { $min = $tmpmin; } + if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; } + } else { + $min = 0; } - if (defined($ENV{'form.'.$dname.'_hour'})) { - my $tmphour = $ENV{'form.'.$dname.'_hour'}; - if (($tmphour =~ /^\d+$/) && ($tmphour > 0) && ($tmphour < 32)) { + if (defined($env{'form.'.$dname.'_hour'})) { + my $tmphour = $env{'form.'.$dname.'_hour'}; + if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) { $hour = $tmphour; } + } else { + $hour = 0; } - if (defined($ENV{'form.'.$dname.'_day'})) { - my $tmpday = $ENV{'form.'.$dname.'_day'}; + if (defined($env{'form.'.$dname.'_day'})) { + my $tmpday = $env{'form.'.$dname.'_day'}; if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) { $day = $tmpday; } } - if (defined($ENV{'form.'.$dname.'_month'})) { - my $tmpmonth = $ENV{'form.'.$dname.'_month'}; + if (defined($env{'form.'.$dname.'_month'})) { + my $tmpmonth = $env{'form.'.$dname.'_month'}; if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) { $month = $tmpmonth - 1; } } - if (defined($ENV{'form.'.$dname.'_year'})) { - my $tmpyear = $ENV{'form.'.$dname.'_year'}; + if (defined($env{'form.'.$dname.'_year'})) { + my $tmpyear = $env{'form.'.$dname.'_year'}; if (($tmpyear =~ /^\d+$/) && ($tmpyear > 1900)) { $year = $tmpyear - 1900; } } - if (eval(&timelocal($sec,$min,$hour,$day,$month,$year))) { + if (($year<70) || ($year>137)) { return undef; } + if (defined($sec) && defined($min) && defined($hour) && + defined($day) && defined($month) && defined($year) && + eval('&timelocal($sec,$min,$hour,$day,$month,$year)')) { return &timelocal($sec,$min,$hour,$day,$month,$year); } else { return undef; @@ -249,174 +535,123 @@ sub get_date_from_form { ############################################## ############################################## -sub AscendOrderOptions { - my ($order, $page, $formName)=@_; +=pod - my $OpSel1 = ''; - my $OpSel2 = ''; +=item &pjump_javascript_definition() - if($order eq 'Ascending') { - $OpSel1 = ' selected'; - } else { - $OpSel2 = ' selected'; - } +Returns javascript defining the 'pjump' function, which opens up a +parameter setting wizard. - my $Str = ''; - $Str .= ''."\n"; +=cut +############################################## +############################################## +sub pjump_javascript_definition { + my $Str = <{'orderedSequences'})) { - $Str .= '{$page.'Maps'} eq $data->{$sequence.':title'}) { - $Str .= ' selected'; - $selected = 1; - } - $Str .= '>'.$data->{$sequence.':title'}.''."\n"; - } - $Str .= '{'orderedSequences'})) { - if($data->{$sequence.':title'} eq $map || $map eq 'All Maps') { - foreach my $problem (split(':', $data->{$sequence.':problems'})) { - $Str .= '{$page.'ProblemSelect'} eq - $data->{$problem.':title'}) { - $Str .= ' selected'; - $selected = 1; - } - $Str .= '>'.$data->{$problem.':title'}.''."\n"; - } - } +############################################## +############################################## +sub javascript_nothing { + # mozilla and other browsers work with "''", but IE on mac does not. + my $nothing = "''"; + my $user_browser; + my $user_os; + $user_browser = $env{'browser.type'} if (exists($env{'browser.type'})); + $user_os = $env{'browser.os'} if (exists($env{'browser.os'})); + if (! defined($user_browser) || ! defined($user_os)) { + (undef,$user_browser,undef,undef,undef,$user_os) = + &Apache::loncommon::decode_user_agent(); } - $Str .= '{$page.'PartSelect'} eq $part) { - $Str .= ' selected'; - $selected = 1; - } - $Str .= '>'.$part.''."\n"; - } - $Str .= '{$_.':fullname'}; - $Str .= ''."\n"; - } +$status: the currently selected status. If undefined the value of +$env{'form.Status'} is taken. If that is undefined, a value of 'Active' +is used. - $Str .= 'Active'."\n"; - $Str .= 'Expired'."\n"; - $Str .= 'Any'."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; $Str .= ''."\n"; } - ######################################################## ######################################################## =pod -=item &MultipleSectionSelect() +=item Progess Window Handling Routines -Inputs: +These routines handle the creation, update, increment, and closure of +progress windows. The progress window reports to the user the number +of items completed and an estimate of the time required to complete the rest. =over 4 -=item $sections A references to an array containing the names of all the -sections used in a class. -=item $selectedSections A reference to an array containing the names of the -currently selected sections. +=item &Create_PrgWin -=back +Writes javascript to the client to open a progress window and returns a +data structure used for bookkeeping. -Returns: a string containing HTML for a multiple select box for -selecting sections of a course. +Inputs -The form element name is 'Section'. @$sections is sorted prior to output. +=over 4 -=cut +=item $r Apache request -######################################################## -######################################################## -sub MultipleSectionSelect { - my ($sections,$selectedSections)=@_; +=item $title The title of the progress window - my $Str = ''; - $Str .= ''."\n"; - - return $Str; -} +=item $number_to_do The total number of items being processed. -######################################################## -######################################################## +=item $type Either 'popup' or 'inline' (popup is assumed if nothing is + specified) -=pod +=item $width Specify the width in charaters of the input field. + +=item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own -=item &Title() +=item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field -Inputs: $pageName a string containing the name of the page to be sent -to &Apache::loncommon::bodytag. +=back -Returns: string containing being and complete and -as well as a <script> to focus the current window and change its width -and height to 500. Why? I do not know. If you find out, please update -this documentation. +Returns a hash containing the progress state data structure. -=cut -######################################################## -######################################################## -sub Title { - my ($pageName)=@_; +=item &Update_PrgWin - my $Str = ''; +Updates the text in the progress indicator. Does not increment the count. +See &Increment_PrgWin. - $Str .= '<html><head><title>'.$pageName.''."\n"; - $Str .= &Apache::loncommon::bodytag($pageName)."\n"; - $Str .= ''."\n"; +Inputs: - return $Str; -} +=over 4 -######################################################## -######################################################## +=item $r Apache request -=pod +=item $prog_state Pointer to the data structure returned by &Create_PrgWin + +=item $displaystring The string to write to the status indicator -=item &CreateHeadings() +=back + +Returns: none + + +=item Increment_PrgWin -This function generates the column headings for the chart. +Increment the count of items completed for the progress window by 1. + +Inputs: =over 4 -Inputs: $CacheData, $keyID, $headings, $spacePadding +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by Create_PrgWin -$CacheData: pointer to a hash tied to the cached data database +=item $extraInfo A description of the items being iterated over. Typically +'student'. -$keyID: a pointer to an array containing the names of the data -held in a column and is used as part of a key into $CacheData +=back + +Returns: none -$headings: The names of the headings for the student information -$spacePadding: The spaces to go between columns +=item Close_PrgWin -Output: $Str +Closes the progress window. + +Inputs: -$Str: A formatted string of the table column headings. +=over 4 + +=item $r Apache request + +=item $prog_state Pointer to the data structure returned by Create_PrgWin + +=back + +Returns: none =back @@ -551,124 +787,973 @@ $Str: A formatted string of the table co ######################################################## ######################################################## -sub CreateHeadings { - my ($data,$keyID,$headings,$displayString,$format)=@_; - my $Str=''; - my $formatting = ''; - - for(my $index=0; $index<(scalar @$headings); $index++) { - my $currentHeading=$headings->[$index]; - if($format eq 'preformatted') { - my @dataLength=split(//,$currentHeading); - my $length=scalar @dataLength; - $formatting = (' 'x - ($data->{$keyID->[$index].':columnWidth'}-$length)); - } - my $linkdata=$keyID->[$index]; - - my $tempString = $displayString; - $tempString =~ s/LINKDATA/$linkdata/; - $tempString =~ s/DISPLAYDATA/$currentHeading/; - $tempString =~ s/FORMATTING/$formatting/; - $Str .= $tempString; +my $uniq=0; +sub get_uniq_name { + $uniq++; + return 'uniquename'.$uniq; +} + +# Create progress +sub Create_PrgWin { + my ($r, $title, $heading, $number_to_do,$type,$width,$formname, + $inputname)=@_; + if (!defined($type)) { $type='popup'; } + if (!defined($width)) { $width=55; } + my %prog_state; + $prog_state{'type'}=$type; + if ($type eq 'popup') { + $prog_state{'window'}='popwin'; + my $start_page = + &Apache::loncommon::start_page($title,undef, + {'only_body' => 1, + 'bgcolor' => '#88DDFF', + 'js_ready' => 1}); + my $end_page = &Apache::loncommon::end_page({'js_ready' => 1}); + + #the whole function called through timeout is due to issues + #in mozilla Read BUG #2665 if you want to know the whole story + &r_print($r,'"); + $prog_state{'formname'}='popremain'; + $prog_state{'inputname'}="remaining"; + } elsif ($type eq 'inline') { + $prog_state{'window'}='window'; + if (!$formname) { + $prog_state{'formname'}=&get_uniq_name(); + &r_print($r,'
'); + } else { + $prog_state{'formname'}=$formname; + } + if (!$inputname) { + $prog_state{'inputname'}=&get_uniq_name(); + &r_print($r,$heading.' '); + } else { + $prog_state{'inputname'}=$inputname; + + } + if (!$formname) { &r_print($r,'
'); } + &Update_PrgWin($r,\%prog_state,&mt('Starting')); } - return $Str; + $prog_state{'done'}=0; + $prog_state{'firststart'}=&Time::HiRes::time(); + $prog_state{'laststart'}=&Time::HiRes::time(); + $prog_state{'max'}=$number_to_do; + + return %prog_state; } -######################################################## -######################################################## +# update progress +sub Update_PrgWin { + my ($r,$prog_state,$displayString)=@_; + &r_print($r,''); + $$prog_state{'laststart'}=&Time::HiRes::time(); +} -=pod +# increment progress state +sub Increment_PrgWin { + my ($r,$prog_state,$extraInfo)=@_; + $$prog_state{'done'}++; + my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/ + $$prog_state{'done'} * + ($$prog_state{'max'}-$$prog_state{'done'}); + $time_est = int($time_est); + # + my $min = int($time_est/60); + my $sec = $time_est % 60; + # + my $str; + if ($min == 0 && $sec > 1) { + $str = '[_2] seconds'; + } elsif ($min == 1 && $sec > 1) { + $str = '1 minute [_2] seconds'; + } elsif ($min == 1 && $sec < 2) { + $str = '1 minute'; + } elsif ($min < 10 && $sec > 1) { + $str = '[_1] minutes, [_2] seconds'; + } elsif ($min >= 10 || $sec < 2) { + $str = '[_1] minutes'; + } + $time_est = &mt($str,$min,$sec); + # + my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'}; + if ($lasttime > 9) { + $lasttime = int($lasttime); + } elsif ($lasttime < 0.01) { + $lasttime = 0; + } else { + $lasttime = sprintf("%3.2f",$lasttime); + } + if ($lasttime == 1) { + $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')'; + } else { + $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')'; + } + # + my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'})); + my $user_os = $env{'browser.os'} if (exists($env{'browser.os'})); + if (! defined($user_browser) || ! defined($user_os)) { + (undef,$user_browser,undef,undef,undef,$user_os) = + &Apache::loncommon::decode_user_agent(); + } + if ($user_browser eq 'explorer' && $user_os =~ 'mac') { + $lasttime = ''; + } + &r_print($r,''); + $$prog_state{'laststart'}=&Time::HiRes::time(); +} -=item &FormatStudentInformation() +# close Progress Line +sub Close_PrgWin { + my ($r,$prog_state)=@_; + if ($$prog_state{'type'} eq 'popup') { + &r_print($r,''."\n"); + } elsif ($$prog_state{'type'} eq 'inline') { + &Update_PrgWin($r,$prog_state,&mt('Done')); + } + undef(%$prog_state); +} -This function produces a formatted string of the student\'s information: -username, domain, section, full name, and PID. +sub r_print { + my ($r,$to_print)=@_; + if ($r) { + $r->print($to_print); + $r->rflush(); + } else { + print($to_print); + } +} -=over 4 +# ------------------------------------------------------- Puts directory header + +sub crumbs { + my ($uri,$target,$prefix,$form,$size,$noformat)=@_; + if (! defined($size)) { + $size = '+2'; + } + if ($target) { + $target = ' target="'. + &Apache::loncommon::escape_single($target).'"'; + } + my $output=''; + unless ($noformat) { $output.='
'; } + $output.=''.$prefix.'/'; + if ($env{'user.adv'}) { + my $path=$prefix.'/'; + foreach my $dir (split('/',$uri)) { + if (! $dir) { next; } + $path .= $dir; + unless ($path eq $uri) { $path.='/'; } + my $linkpath = &Apache::loncommon::escape_single($path); + if ($form) { + $linkpath= + qq{javascript:$form.action='$linkpath';$form.submit();}; + } + $output.=qq{$dir/}; + } + } else { + $output.=$uri; + } + unless ($uri=~/\/$/) { $output=~s/\/$//; } + return $output.''.($noformat?'':'
'); +} -Input: $cache, $name, $keyID, $spacePadding +# --------------------- A function that generates a window for the spellchecker -$cache: This is a pointer to a hash that is tied to the cached data +sub spellheader { + my $start_page= + &Apache::loncommon::start_page('Speller Suggestions',undef, + {'only_body' => 1, + 'js_ready' => 1, + 'bgcolor' => '#DDDDDD',}); + my $end_page= + &Apache::loncommon::end_page({'js_ready' => 1}); + + my $nothing=&javascript_nothing(); + return (< +// + +ENDCHECK +} -$name: The name and domain of the current student in name:domain format +# ---------------------------------- Generate link to spell checker for a field -$keyID: A pointer to an array holding the names used to +sub spelllink { + my ($form,$field)=@_; + my $linktext=&mt('Check Spelling'); + return (<$linktext +ENDLINK +} -remove data from the hash. They represent the name of the data to be removed. +# ------------------------------------------------- Output headers for HTMLArea -$spacePadding: Extra spaces that represent the space between columns +{ + my @htmlareafields; + sub init_htmlareafields { + undef(@htmlareafields); + } + + sub add_htmlareafields { + my (@newfields) = @_; + push(@htmlareafields,@newfields); + } -Output: $Str + sub get_htmlareafields { + return @htmlareafields; + } +} -$Str: Formatted string. +sub htmlareaheaders { + if (&htmlareablocked()) { return ''; } + unless (&htmlareabrowser()) { return ''; } + my $lang='en'; + if (&mt('htmlarea_lang') ne 'htmlarea_lang') { + $lang=&mt('htmlarea_lang'); + } + return (< +_editor_url='/htmlarea/'; +_editor_lang='$lang'; + + +ENDHEADERS +} -=back +# ------------------------------------------------- Activate additional buttons -=cut +sub htmlareaaddbuttons { + if (&htmlareablocked()) { return ''; } + unless (&htmlareabrowser()) { return ''; } + return (<\$','\$ '); + } + ); + config.registerButton('ed_math_eqn','LaTeX Equation', + '/htmlarea/images/ed_math_eqn.gif',false, + function(editor,id) { + editor.surroundHTML( + ' \\n
\\\\[','\\\\]
\\n '); + } + ); + config.toolbar.push(['ed_math','ed_math_eqn']); +ENDADDBUTTON +} -######################################################## -######################################################## -sub FormatStudentInformation { - my ($data,$name,$keyID,$displayString,$format)=@_; - my $Str=''; - my $currentColumn; +# ----------------------------------------------------------------- Preferences + +sub disablelink { + my @fields=@_; + if (defined($#fields)) { + unless ($#fields>=0) { return ''; } + } + return ''.&mt('Disable WYSIWYG Editor').''; +} + +sub enablelink { + my @fields=@_; + if (defined($#fields)) { + unless ($#fields>=0) { return ''; } + } + return ''.&mt('Enable WYSIWYG Editor').''; +} + +# ----------------------------------------- Script to activate only some fields + +sub htmlareaselectactive { + my @fields=@_; + unless (&htmlareabrowser()) { return ''; } + if (&htmlareablocked()) { return '
'.&enablelink(@fields); } + my $output='
". + &disablelink(@fields); + return $output; +} - for(my $index=0; $index<(scalar @$keyID); $index++) { - $currentColumn=$data->{$name.':'.$keyID->[$index]}; +# --------------------------------------------------------------------- Blocked - if($format eq 'preformatted') { - my @dataLength=split(//,$currentColumn); - my $length=scalar @dataLength; - $currentColumn.= (' 'x - ($data->{$keyID->[$index].':columnWidth'}-$length)); +sub htmlareablocked { + unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; } + return 0; +} + +# ---------------------------------------- Browser capable of running HTMLArea? + +sub htmlareabrowser { + return 1; +} + +############################################################ +############################################################ + +=pod + +=item breadcrumbs + +Compiles the previously registered breadcrumbs into an series of links. +FAQ and BUG links will be placed on the left side of the table if they +are defined for the last registered breadcrumb. +Additionally supports a 'component', which will be displayed on the +right side of the table (without a link). +A link to help for the component will be included if one is specified. + +All inputs can be undef without problems. + +Inputs: $color (the background color of the table returned), + $component (the large text on the right side of the table), + $component_help + $function (role to get colors from) + $domain (domian of role) + $menulink (boolean, controls whether to include a link to /adm/menu) + +Returns a string containing breadcrumbs for the current page. + +=item clear_breadcrumbs + +Clears the previously stored breadcrumbs. + +=item add_breadcrumb + +Pushes a breadcrumb on the stack of crumbs. + +input: $breadcrumb, a hash reference. The keys 'href','title', and 'text' +are required. If present the keys 'faq' and 'bug' will be used to provide +links to the FAQ and bug sites. + +returns: nothing + +=cut + +############################################################ +############################################################ +{ + my @Crumbs; + + sub breadcrumbs { + my ($component,$component_help,$menulink,$helplink) = @_; + # + my $Str = "\n".''; + # + if (defined($component)) { + $Str .= ''; } + $Str .= '
'; + # + # Make the faq and bug data cascade + my $faq = ''; + my $bug = ''; + my $help=''; + # The last breadcrumb does not have a link, so handle it separately. + my $last = pop(@Crumbs); + # + # The first one should be the course or a menu link + if (!defined($menulink)) { $menulink=1; } + if ($menulink) { + my $description = 'Menu'; + if (exists($env{'request.course.id'}) && + $env{'request.course.id'} ne '') { + $description = + $env{'course.'.$env{'request.course.id'}.'.description'}; + } + unshift(@Crumbs,{ + href =>'/adm/menu', + title =>'Go to main menu', + target =>'_top', + text =>$description, + }); + } + my $links .= + join('->', + map { + $faq = $_->{'faq'} if (exists($_->{'faq'})); + $bug = $_->{'bug'} if (exists($_->{'bug'})); + $help = $_->{'help'} if (exists($_->{'help'})); + my $result = '{'target'}) && $_->{'target'} ne '') { + $result .= 'target="'.$_->{'target'}.'" '; + } + $result .='title="'.&mt($_->{'title'}).'">'. + &mt($_->{'text'}).''; + $result; + } @Crumbs + ); + $links .= '->' if ($links ne ''); + $links .= ''.&mt($last->{'text'}).''; + # + my $icons = ''; + $faq = $last->{'faq'} if (exists($last->{'faq'})); + $bug = $last->{'bug'} if (exists($last->{'bug'})); + $help = $last->{'help'} if (exists($last->{'help'})); + $component_help=($component_help?$component_help:$help); +# if ($faq ne '') { +# $icons .= &Apache::loncommon::help_open_faq($faq); +# } +# if ($bug ne '') { +# $icons .= &Apache::loncommon::help_open_bug($bug); +# } + if ($helplink ne 'nohelp') { + $icons .= &Apache::loncommon::help_open_menu(undef,$component, + $component_help, + undef,$faq,$bug); + } + if ($icons ne '') { + $Str .= $icons.' '; + } + # + $Str .= $links.''. + &mt($component).'
'."\n"; + # + # Return the @Crumbs stack to what we started with + push(@Crumbs,$last); + shift(@Crumbs); + # + return $Str; + } - my $tempString = $displayString; - $tempString =~ s/DISPLAYDATA/$currentColumn/; + sub clear_breadcrumbs { + undef(@Crumbs); + } - $Str .= $tempString; + sub add_breadcrumb { + push (@Crumbs,@_); } - return $Str; +} # End of scope for @Crumbs + +############################################################ +############################################################ + +# Nested table routines. +# +# Routines to display form items in a multi-row table with 2 columns. +# Uses nested tables to divide form elements into segments. +# For examples of use see loncom/interface/lonnotify.pm +# +# Can be used in following order: ... +# &start_pick_box() +# row1 +# row2 +# row3 ... etc. +# &submit_row(0 +# &end_pickbox() +# +# where row1, row 2 etc. are chosen from &role_select_row,&course_select_row, +# &status_select_row and &email_default_row +# +# Can also be used in following order: +# +# &start_pick_box() +# &row_title() +# &row_closure() +# &row_title() +# &row_closure() ... etc. +# &submit_row() +# &end_pick_box() +# +# In general a &submit_row() call should proceed the call to &end_pick_box(), +# as this routine adds a button for form submission. +# &submit_row() does not require a &row_closure after it. +# +# &start_pick_box() creates a bounding table with 1-pixel wide black border. +# rows should be placed between calls to &start_pick_box() and &end_pick_box. +# +# &row_title() adds a title in the left column for each segment. +# &row_closure() closes a row with a 1-pixel wide black line. +# +# &role_select_row() provides a select box from which to choose 1 or more roles +# &course_select_row provides ways of picking groups of courses +# radio buttons: all, by category or by picking from a course picker pop-up +# note: by category option is only displayed if a domain has implemented +# selection by year, semester, department, number etc. +# +# &status_select_row() provides a select box from which to choose 1 or more +# access types (current access, prior access, and future access) +# +# &email_default_row() provides text boxes for default e-mail suffixes for +# different authentication types in a domain. +# +# &row_title() and &row_closure() are called internally by the &*_select_row +# routines, but can also be called directly to start and end rows which have +# needs that are not accommodated by the *_select_row() routines. + +sub start_pick_box { + my ($table_width) = @_; + my $output = <<"END"; + + + + +
+ + + + +
+ +END + return $output; } -######################################################## -######################################################## +sub end_pick_box { + my $output = <<"END"; +
+
+
+END + return $output; +} -# Create progress -sub Create_PrgWin { - my ($r, $title, $heading)=@_; - $r->print('"); +sub row_title { + my ($col_width,$tablecolor,$title) = @_; + my $output = <<"ENDONE"; + + + + + + +
$title: +
+ + + + +ENDONE + return $output; +} - $r->rflush(); +sub row_closure { + my $output = <<"ENDTWO"; + +
+ + + + +
+ + +ENDTWO + return $output; } -# update progress -sub Update_PrgWin { - my ($displayString,$r)=@_; - $r->print(''); - $r->rflush(); +sub role_select_row { + my ($roles,$col_width,$tablecolor,$title) = @_; + my $output; + if (defined($title)) { + $output = &row_title($col_width,$tablecolor,$title); + } + $output .= qq| + + \n|; + if (defined($title)) { + $output .= &row_closure(); + } + return $output; } -# close Progress Line -sub Close_PrgWin { - my ($r)=@_; - $r->print(''."\n"); - $r->rflush(); +sub course_select_row { + my ($col_width,$tablecolor,$title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= " \n"; + $output .= qq| + + |; + my $courseform=''.&Apache::loncommon::selectcourse_link + ($formname,'pickcourse','pickdomain','coursedesc','',1).''; + if ($totcodes > 0) { + $output .= ''.&mt('All courses'); + my $numtitles = @$codetitles; + if ($numtitles > 0) { + $output .= '
'.&mt('Pick courses by category:').'
'; + $output .= ''; + for (my $i=1; $i<$numtitles; $i++) { + $output .= ''; + } + $output .= '
'.$$codetitles[0].'
'."\n". + '		'.$$codetitles[$i].'
'."\n". + ''."\n". + '

'; + } + } + $output .= ''.&mt('Pick specific course(s):').' '.$courseform.'  selected.
'."\n"; + $output .= &row_closure(); + return $output; +} + +sub status_select_row { + my ($types,$col_width,$tablecolor,$title) = @_; + my $output; + if (defined($title)) { + $output = &row_title($col_width,$tablecolor,$title); + } + $output .= qq| + + \n|; + if (defined($title)) { + $output .= &row_closure(); + } + return $output; +} + +sub email_default_row { + my ($authtypes,$col_width,$tablecolor,$title,$descrip) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + my @rowcols = ('#eeeeee','#dddddd'); + $output .= ' '.$descrip; + $output .= &start_pick_box(''); + $output .= ' + '.&mt('Authentication Method').''.&mt('Username -> e-mail conversion').' + '."\n"; + my $rownum = 0; + foreach my $auth (sort(keys(%{$authtypes}))) { + my ($userentry,$size); + my $rowiter = $rownum%2; + if ($auth =~ /^krb/) { + $userentry = ''; + $size = 25; + } else { + $userentry = 'username@'; + $size = 15; + } + $output .= ' '.$$authtypes{$auth}.''.$userentry.''; + $rownum ++; + } + $output .= &end_pick_box(); + $output .= "
\n"; + $output .= &row_closure(); + return $output; +} + + +sub submit_row { + my ($col_width,$tablecolor,$title,$cmd,$submit_text) = @_; + my $output = &row_title($col_width,$tablecolor,$title); + $output .= qq| + +
+ +   +

+ \n|; + return $output; +} + +############################################## +############################################## + +# echo_form_input +# +# Generates html markup to add form elements from the referrer page +# as hidden form elements (values encoded) in the new page. +# +# Intended to support two types of use +# (a) to allow backing up to earlier pages in a multi-page +# form submission process using a breadcrumb trail. +# +# (b) to allow the current page to be reloaded with form elements +# set on previous page to remain unchanged. An example would +# be where the a page containing a dynamically-built table of data is +# is to be redisplayed, with only the sort order of the data changed. +# +# Inputs: +# 1. Reference to array of form elements in the submitted form on +# the referrer page which are to be excluded from the echoed elements. +# +# 2. Reference to array of regular expressions, which if matched in the +# name of the form element n the referrer page will be omitted from echo. +# +# Outputs: A scalar containing the html markup for the echoed form +# elements (all as hidden elements, with values encoded). + + +sub echo_form_input { + my ($excluded,$regexps) = @_; + my $output = ''; + foreach my $key (keys(%env)) { + if ($key =~ /^form\.(.+)$/) { + my $name = $1; + my $match = 0; + if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) { + if (defined($regexps)) { + if (@{$regexps} > 0) { + foreach my $regexp (@{$regexps}) { + if ($name =~ /\Q$regexp\E/) { + $match = 1; + last; + } + } + } + } + if (!$match) { + if (ref($env{$key})) { + foreach my $value (@{$env{$key}}) { + $value = &HTML::Entities::encode($value,'<>&"'); + $output .= ''."\n"; + } + } else { + my $value = &HTML::Entities::encode($env{$key},'<>&"'); + $output .= ''."\n"; + } + } + } + } + } + return $output; +} + +############################################## +############################################## + +# set_form_elements +# +# Generates javascript to set form elements to values based on +# corresponding values for the same form elements when the page was +# previously submitted. +# +# Last submission values are read from hidden form elements in referring +# page which have the same name, i.e., generated by &echo_form_input(). +# +# Intended to be called by onload event. +# +# Inputs: +# (a) Reference to hash of echoed form elements to be set. +# +# In the hash, keys are the form element names, and the values are the +# element type (selectbox, radio, checkbox or text -for textbox, textarea or +# hidden). +# +# (b) Optional reference to hash of stored elements to be set. +# +# If the page being displayed is a page which permits modification of +# previously stored data, e.g., the first page in a multi-page submission, +# then if stored is supplied, form elements will be set to the last stored +# values. If user supplied values are also available for the same elements +# these will replace the stored values. +# +# Output: +# +# javascript function - set_form_elements() which sets form elements, +# expects an argument: formname - the name of the form according to +# the DOM, e.g., document.compose + +sub set_form_elements { + my ($elements,$stored) = @_; + my %values; + my $output .= 'function setFormElements(courseForm) { +'; + if (defined($stored)) { + foreach my $name (keys(%{$stored})) { + if (exists($$elements{$name})) { + if (ref($$stored{$name}) eq 'ARRAY') { + $values{$name} = $$stored{$name}; + } else { + @{$values{$name}} = ($$stored{$name}); + } + } + } + } + + foreach my $key (keys(%env)) { + if ($key =~ /^form\.(.+)$/) { + my $name = $1; + if (exists($$elements{$name})) { + @{$values{$name}} = &Apache::loncommon::get_env_multiple($key); + } + } + } + + foreach my $name (keys(%values)) { + for (my $i=0; $i<@{$values{$name}}; $i++) { + $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"'); + $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g; + $values{$name}[$i] =~ s/"/\\"/g; + } + if ($$elements{$name} eq 'text') { + my $numvalues = @{$values{$name}}; + if ($numvalues > 1) { + my $valuestring = join('","',@{$values{$name}}); + $output .= qq| + var textvalues = new Array ("$valuestring"); + var total = courseForm.$name.length; + if (total > $numvalues) { + total = $numvalues; + } + for (var i=0; i