Annotation of loncom/interface/lonhtmlcommon.pm, revision 1.265.2.1

1.2       www         1: # The LearningOnline Network with CAPA
                      2: # a pile of common html routines
                      3: #
1.265.2.1! faziophi    4: # $Id: lonhtmlcommon.pm,v 1.265 2010/01/26 13:08:08 wenzelju Exp $
1.2       www         5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.10      matthew    28: ######################################################################
                     29: ######################################################################
                     30: 
                     31: =pod
                     32: 
                     33: =head1 NAME
                     34: 
                     35: Apache::lonhtmlcommon - routines to do common html things
                     36: 
                     37: =head1 SYNOPSIS
                     38: 
                     39: Referenced by other mod_perl Apache modules.
                     40: 
                     41: =head1 INTRODUCTION
                     42: 
                     43: lonhtmlcommon is a collection of subroutines used to present information
                     44: in a consistent html format, or provide other functionality related to
                     45: html.
                     46: 
                     47: =head2 General Subroutines
                     48: 
                     49: =over 4
                     50: 
                     51: =cut 
                     52: 
                     53: ######################################################################
                     54: ######################################################################
1.2       www        55: 
1.1       stredwic   56: package Apache::lonhtmlcommon;
                     57: 
1.104     albertel   58: use strict;
1.10      matthew    59: use Time::Local;
1.47      sakharuk   60: use Time::HiRes;
1.30      www        61: use Apache::lonlocal;
1.104     albertel   62: use Apache::lonnet;
1.130     www        63: use LONCAPA;
1.1       stredwic   64: 
1.247     www        65: 
                     66: sub coursepreflink {
                     67:    my ($text,$category)=@_;
                     68:    if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
1.262     raeburn    69:       return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'">'.$text.'</a>';
1.247     www        70:    } else {
                     71:       return '';
                     72:    }
                     73: }
                     74: 
1.253     www        75: sub raw_href_to_link {
                     76:    my ($message)=@_;
1.264     faziophi   77:    $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
1.253     www        78:    return $message;
                     79: }
                     80: 
1.208     www        81: ##############################################
                     82: ##############################################
                     83: 
                     84: =item confirm_success
                     85: 
                     86: Successful completion of an operation message
                     87: 
                     88: =cut
                     89: 
                     90: sub confirm_success {
1.209     www        91:    my ($message,$failure)=@_;
                     92:    if ($failure) {
1.265     wenzelju   93:       return '<span class="LC_error" style="font-size: inherit;">'."\n"
1.218     bisitz     94:             .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
1.211     bisitz     95:             .$message."\n"
                     96:             .'</span>'."\n";
1.209     www        97:    } else {
1.211     bisitz     98:       return '<span class="LC_success">'."\n"
1.233     raeburn    99:             .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
1.211     bisitz    100:             .$message."\n"
                    101:             .'</span>'."\n";
1.209     www       102:    }
1.208     www       103: }
1.176     foxr      104: 
                    105: ##############################################
                    106: ##############################################
                    107: 
                    108: =pod
                    109: 
1.177     raeburn   110: =item dragmath_button
1.176     foxr      111: 
1.177     raeburn   112: Creates a button that launches a dragmath popup-window, in which an 
                    113: expression can be edited and pasted as LaTeX into a specified textarea. 
                    114: 
                    115:   textarea - Name of the textarea to edit.
                    116:   helpicon - If true, show a help icon to the right of the button.
1.176     foxr      117: 
                    118: =cut
                    119: 
1.177     raeburn   120: sub dragmath_button {
                    121:     my ($textarea,$helpicon) = @_;
                    122:     my $help_text; 
                    123:     if ($helpicon) {
                    124:         $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor');
                    125:     }
1.178     bisitz    126:     my $buttontext=&mt('Edit Math');
1.177     raeburn   127:     return <<ENDDRAGMATH;
1.246     bisitz    128:                 <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
1.177     raeburn   129: ENDDRAGMATH
                    130: }
                    131: 
1.176     foxr      132: ##############################################
                    133: 
1.177     raeburn   134: =pod
                    135: 
                    136: =item dragmath_js
                    137: 
                    138: Javascript used to open pop-up window containing dragmath applet which 
                    139: can be used to paste LaTeX into a textarea.
                    140: =cut
1.176     foxr      141: 
1.177     raeburn   142: sub dragmath_js {
1.182     foxr      143:     my ($popup) = @_;
1.177     raeburn   144:     return <<ENDDRAGMATHJS;
                    145:                 <script type="text/javascript">
1.218     bisitz    146:                 // <![CDATA[
1.176     foxr      147:                   function mathedit(textarea, doc) {
                    148:                      targetEntry = textarea;
1.177     raeburn   149:                      targetDoc   = doc;
1.182     foxr      150:                      newwin  = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");
1.176     foxr      151:                   }
1.218     bisitz    152:                 // ]]>
1.176     foxr      153:                 </script>
1.177     raeburn   154: 
                    155: ENDDRAGMATHJS
1.176     foxr      156: }
                    157: 
1.182     foxr      158: 
1.40      www       159: ##############################################
                    160: ##############################################
                    161: 
                    162: =pod
                    163: 
                    164: =item authorbombs
                    165: 
                    166: =cut
                    167: 
                    168: ##############################################
                    169: ##############################################
                    170: 
                    171: sub authorbombs {
                    172:     my $url=shift;
                    173:     $url=&Apache::lonnet::declutter($url);
1.155     albertel  174:     my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
1.40      www       175:     my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
1.232     raeburn   176:     foreach my $bomb (keys(%bombs)) {
                    177: 	if ($bomb =~ /^$udom\/$uname\//) {
1.40      www       178: 	    return '<a href="/adm/bombs/'.$url.
1.218     bisitz    179: 		'"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
1.40      www       180: 		&Apache::loncommon::help_open_topic('About_Bombs');
                    181: 	}
                    182:     }
                    183:     return '';
                    184: }
1.26      matthew   185: 
                    186: ##############################################
                    187: ##############################################
                    188: 
1.41      www       189: sub recent_filename {
                    190:     my $area=shift;
1.130     www       191:     return 'nohist_recent_'.&escape($area);
1.41      www       192: }
                    193: 
                    194: sub store_recent {
1.136     albertel  195:     my ($area,$name,$value,$freeze)=@_;
1.41      www       196:     my $file=&recent_filename($area);
                    197:     my %recent=&Apache::lonnet::dump($file);
1.111     www       198:     if (scalar(keys(%recent))>20) {
1.41      www       199: # remove oldest value
1.136     albertel  200: 	my $oldest=time();
1.41      www       201: 	my $delkey='';
1.136     albertel  202: 	foreach my $item (keys(%recent)) {
                    203: 	    my $thistime=(split(/\&/,$recent{$item}))[0];
                    204: 	    if (($thistime ne "always_include") && ($thistime<$oldest)) {
1.41      www       205: 		$oldest=$thistime;
1.136     albertel  206: 		$delkey=$item;
1.41      www       207: 	    }
                    208: 	}
                    209: 	&Apache::lonnet::del($file,[$delkey]);
                    210:     }
                    211: # store new value
1.136     albertel  212:     my $timestamp;
                    213:     if ($freeze) {
                    214:         $timestamp = "always_include";
                    215:     } else {
                    216:         $timestamp = time();
                    217:     }   
1.41      www       218:     &Apache::lonnet::put($file,{ $name => 
1.136     albertel  219: 				 $timestamp.'&'.&escape($value) });
1.41      www       220: }
                    221: 
1.89      banghart  222: sub remove_recent {
                    223:     my ($area,$names)=@_;
                    224:     my $file=&recent_filename($area);
                    225:     return &Apache::lonnet::del($file,$names);
                    226: }
                    227: 
1.41      www       228: sub select_recent {
                    229:     my ($area,$fieldname,$event)=@_;
                    230:     my %recent=&Apache::lonnet::dump(&recent_filename($area));
                    231:     my $return="\n<select name='$fieldname'".
1.96      albertel  232: 	($event?" onchange='$event'":'').
1.41      www       233: 	">\n<option value=''>--- ".&mt('Recent')." ---</option>";
1.136     albertel  234:     foreach my $value (sort(keys(%recent))) {
                    235: 	unless ($value =~/^error\:/) {
                    236: 	    my $escaped = &Apache::loncommon::escape_url($value);
1.160     albertel  237: 	    &Apache::loncommon::inhibit_menu_check(\$escaped);
1.251     raeburn   238:             if ($area eq 'residx') {
                    239:                 next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
                    240:             }
1.94      foxr      241: 	    $return.="\n<option value='$escaped'>".
1.136     albertel  242: 		&unescape((split(/\&/,$recent{$value}))[1]).
1.41      www       243: 		'</option>';
                    244: 	}
                    245:     }
                    246:     $return.="\n</select>\n";
                    247:     return $return;
                    248: }
                    249: 
1.97      albertel  250: sub get_recent {
                    251:     my ($area, $n) = @_;
                    252:     my %recent=&Apache::lonnet::dump(&recent_filename($area));
                    253: 
                    254: # Create hash with key as time and recent as value
1.136     albertel  255: # Begin filling return_hash with any 'always_include' option
1.97      albertel  256:     my %time_hash = ();
1.136     albertel  257:     my %return_hash = ();
1.232     raeburn   258:     foreach my $item (keys(%recent)) {
1.136     albertel  259:         my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
                    260:         if ($thistime eq 'always_include') {
                    261:             $return_hash{$item} = &unescape($thisvalue);
                    262:             $n--;
                    263:         } else {
                    264:             $time_hash{$thistime} = $item;
1.133     albertel  265:         }
1.97      albertel  266:     }
                    267: 
                    268: # Sort by decreasing time and return key value pairs
                    269:     my $idx = 1;
1.136     albertel  270:     foreach my $item (reverse(sort(keys(%time_hash)))) {
                    271:        $return_hash{$time_hash{$item}} =
                    272:                   &unescape((split(/\&/,$recent{$time_hash{$item}}))[1]);
1.97      albertel  273:        if ($n && ($idx++ >= $n)) {last;}
                    274:     }
                    275: 
                    276:     return %return_hash;
                    277: }
                    278: 
1.136     albertel  279: sub get_recent_frozen {
                    280:     my ($area) = @_;
                    281:     my %recent=&Apache::lonnet::dump(&recent_filename($area));
                    282: 
                    283: # Create hash with all 'frozen' items
                    284:     my %return_hash = ();
                    285:     foreach my $item (keys(%recent)) {
                    286:         my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
                    287:         if ($thistime eq 'always_include') {
                    288:             $return_hash{$item} = &unescape($thisvalue);
                    289:         }
                    290:     }
                    291:     return %return_hash;
                    292: }
                    293: 
1.97      albertel  294: 
1.41      www       295: 
1.26      matthew   296: =pod
                    297: 
                    298: =item textbox
                    299: 
                    300: =cut
                    301: 
                    302: ##############################################
                    303: ##############################################
                    304: sub textbox {
                    305:     my ($name,$value,$size,$special) = @_;
                    306:     $size = 40 if (! defined($size));
1.128     albertel  307:     $value = &HTML::Entities::encode($value,'<>&"');
1.26      matthew   308:     my $Str = '<input type="text" name="'.$name.'" size="'.$size.'" '.
                    309:         'value="'.$value.'" '.$special.' />';
                    310:     return $Str;
                    311: }
                    312: 
                    313: ##############################################
                    314: ##############################################
                    315: 
                    316: =pod
                    317: 
                    318: =item checkbox
                    319: 
                    320: =cut
                    321: 
                    322: ##############################################
                    323: ##############################################
                    324: sub checkbox {
1.68      matthew   325:     my ($name,$checked,$value) = @_;
                    326:     my $Str = '<input type="checkbox" name="'.$name.'" ';
                    327:     if (defined($value)) {
                    328:         $Str .= 'value="'.$value.'"';
                    329:     } 
                    330:     if ($checked) {
1.206     bisitz    331:         $Str .= ' checked="checked"';
1.68      matthew   332:     }
                    333:     $Str .= ' />';
1.26      matthew   334:     return $Str;
                    335: }
                    336: 
1.120     albertel  337: 
                    338: =pod
                    339: 
                    340: =item radiobutton
                    341: 
                    342: =cut
                    343: 
                    344: ##############################################
                    345: ##############################################
                    346: sub radio {
                    347:     my ($name,$checked,$value) = @_;
                    348:     my $Str = '<input type="radio" name="'.$name.'" ';
                    349:     if (defined($value)) {
                    350:         $Str .= 'value="'.$value.'"';
                    351:     } 
                    352:     if ($checked eq $value) {
1.206     bisitz    353:         $Str .= ' checked="checked"';
1.120     albertel  354:     }
                    355:     $Str .= ' />';
                    356:     return $Str;
                    357: }
                    358: 
1.10      matthew   359: ##############################################
                    360: ##############################################
                    361: 
                    362: =pod
                    363: 
                    364: =item &date_setter
                    365: 
1.22      matthew   366: &date_setter returns html and javascript for a compact date-setting form.
                    367: To retrieve values from it, use &get_date_from_form().
                    368: 
1.10      matthew   369: Inputs
                    370: 
                    371: =over 4
                    372: 
                    373: =item $dname 
                    374: 
                    375: The name to prepend to the form elements.  
                    376: The form elements defined will be dname_year, dname_month, dname_day,
                    377: dname_hour, dname_min, and dname_sec.
                    378: 
                    379: =item $currentvalue
                    380: 
                    381: The current setting for this time parameter.  A unix format time
                    382: (time in seconds since the beginning of Jan 1st, 1970, GMT.  
1.257     faziophi  383: An undefined value is taken to indicate the value is the current time
                    384: unless it is requested to leave it empty. See $includeempty.
1.10      matthew   385: Also, to be explicit, a value of 'now' also indicates the current time.
                    386: 
1.26      matthew   387: =item $special
                    388: 
                    389: Additional html/javascript to be associated with each element in
                    390: the date_setter.  See lonparmset for example usage.
                    391: 
1.59      matthew   392: =item $includeempty 
                    393: 
1.257     faziophi  394: If it is set (true) and no date/time value is provided,
                    395: the date/time fields are left empty.
                    396: 
1.59      matthew   397: =item $state
                    398: 
                    399: Specifies the initial state of the form elements.  Either 'disabled' or empty.
                    400: Defaults to empty, which indiciates the form elements are not disabled. 
                    401: 
1.22      matthew   402: =back
                    403: 
                    404: Bugs
                    405: 
                    406: The method used to restrict user input will fail in the year 2400.
                    407: 
1.10      matthew   408: =cut
                    409: 
                    410: ##############################################
                    411: ##############################################
                    412: sub date_setter {
1.67      matthew   413:     my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
1.134     raeburn   414:         $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
1.175     raeburn   415:     my $now = time;
1.257     faziophi  416: 
                    417:     my $tzname;
                    418:     my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
                    419:     #other potentially useful values:    wkday,yrday,is_daylight_savings
                    420: 
1.59      matthew   421:     if (! defined($state) || $state ne 'disabled') {
                    422:         $state = '';
                    423:     }
1.67      matthew   424:     if (! defined($no_hh_mm_ss)) {
                    425:         $no_hh_mm_ss = 0;
                    426:     }
1.110     www       427:     if ($currentvalue eq 'now') {
1.257     faziophi  428:         $currentvalue = $now;
1.110     www       429:     }
1.257     faziophi  430:     
                    431:     # Default value: Set empty date field to current time
                    432:     # unless empty inclusion is requested
                    433:     if ((!$includeempty) && (!$currentvalue)) {
                    434:         $currentvalue = $now;
1.10      matthew   435:     }
1.257     faziophi  436:     # Do we have a date? Split it!
1.39      www       437:     if ($currentvalue) {
1.257     faziophi  438: 	($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
                    439: 
                    440:         #No values provided for hour, min, sec? Use default 0
                    441:         if (($defhour) || ($defmin) || ($defsec)) {
                    442:             $sec  = ($defsec  ? $defsec  : 0);
                    443:             $min  = ($defmin  ? $defmin  : 0);
                    444:             $hour = ($defhour ? $defhour : 0);
                    445:         }
1.107     www       446:     }
1.10      matthew   447:     my $result = "\n<!-- $dname date setting form -->\n";
                    448:     $result .= <<ENDJS;
1.135     albertel  449: <script type="text/javascript">
1.218     bisitz    450: // <![CDATA[
1.10      matthew   451:     function $dname\_checkday() {
                    452:         var day   = document.$formname.$dname\_day.value;
                    453:         var month = document.$formname.$dname\_month.value;
                    454:         var year  = document.$formname.$dname\_year.value;
                    455:         var valid = true;
                    456:         if (day < 1) {
                    457:             document.$formname.$dname\_day.value = 1;
                    458:         } 
                    459:         if (day > 31) {
                    460:             document.$formname.$dname\_day.value = 31;
                    461:         }
                    462:         if ((month == 1)  || (month == 3)  || (month == 5)  ||
                    463:             (month == 7)  || (month == 8)  || (month == 10) ||
                    464:             (month == 12)) {
                    465:             if (day > 31) {
                    466:                 document.$formname.$dname\_day.value = 31;
                    467:                 day = 31;
                    468:             }
                    469:         } else if (month == 2 ) {
                    470:             if ((year % 4 == 0) && (year % 100 != 0)) {
                    471:                 if (day > 29) {
                    472:                     document.$formname.$dname\_day.value = 29;
                    473:                 }
                    474:             } else if (day > 29) {
                    475:                 document.$formname.$dname\_day.value = 28;
                    476:             }
                    477:         } else if (day > 30) {
                    478:             document.$formname.$dname\_day.value = 30;
                    479:         }
                    480:     }
1.95      matthew   481:     
1.59      matthew   482:     function $dname\_disable() {
                    483:         document.$formname.$dname\_month.disabled=true;
                    484:         document.$formname.$dname\_day.disabled=true;
                    485:         document.$formname.$dname\_year.disabled=true;
                    486:         document.$formname.$dname\_hour.disabled=true;
                    487:         document.$formname.$dname\_minute.disabled=true;
                    488:         document.$formname.$dname\_second.disabled=true;
                    489:     }
                    490: 
                    491:     function $dname\_enable() {
                    492:         document.$formname.$dname\_month.disabled=false;
                    493:         document.$formname.$dname\_day.disabled=false;
                    494:         document.$formname.$dname\_year.disabled=false;
                    495:         document.$formname.$dname\_hour.disabled=false;
                    496:         document.$formname.$dname\_minute.disabled=false;
                    497:         document.$formname.$dname\_second.disabled=false;        
                    498:     }
                    499: 
1.29      www       500:     function $dname\_opencalendar() {
1.59      matthew   501:         if (! document.$formname.$dname\_month.disabled) {
                    502:             var calwin=window.open(
1.29      www       503: "/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
                    504: document.$formname.$dname\_month.value+"&year="+
                    505: document.$formname.$dname\_year.value,
                    506:              "LONCAPAcal",
                    507:               "height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
1.59      matthew   508:         }
1.29      www       509: 
                    510:     }
1.218     bisitz    511: // ]]>
1.10      matthew   512: </script>
                    513: ENDJS
1.192     bisitz    514:     $result .= '  <span class="LC_nobreak">';
1.96      albertel  515:     my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
1.67      matthew   516:     # Month
1.10      matthew   517:     my @Months = qw/January February  March     April   May      June 
                    518:                     July    August    September October November December/;
                    519:     # Pad @Months with a bogus value to make indexing easier
                    520:     unshift(@Months,'If you can read this an error occurred');
1.95      matthew   521:     if ($includeempty) { $monthselector.="<option value=''></option>"; }
1.10      matthew   522:     for(my $m = 1;$m <=$#Months;$m++) {
1.228     bisitz    523:         $monthselector .= qq{      <option value="$m"};
                    524:         $monthselector .= ' selected="selected"' if ($m-1 eq $month);
                    525:         $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
1.10      matthew   526:     }
1.95      matthew   527:     $monthselector.= '  </select>';
1.67      matthew   528:     # Day
1.96      albertel  529:     my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
1.67      matthew   530:     # Year
1.226     bisitz    531:     my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
1.95      matthew   532:     #
                    533:     my $hourselector = qq{<select name="$dname\_hour" $special $state >};
                    534:     if ($includeempty) { 
                    535:         $hourselector.=qq{<option value=''></option>};
                    536:     }
                    537:     for (my $h = 0;$h<24;$h++) {
1.228     bisitz    538:         $hourselector .= qq{<option value="$h"};
                    539:         $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
1.95      matthew   540:         $hourselector .= ">";
                    541:         my $timest='';
                    542:         if ($h == 0) {
                    543:             $timest .= "12 am";
                    544:         } elsif($h == 12) {
                    545:             $timest .= "12 noon";
                    546:         } elsif($h < 12) {
                    547:             $timest .= "$h am";
                    548:         } else {
                    549:             $timest .= $h-12 ." pm";
                    550:         }
                    551:         $timest=&mt($timest);
                    552:         $hourselector .= $timest." </option>\n";
                    553:     }
                    554:     $hourselector .= "  </select>\n";
                    555:     my $minuteselector = qq{<input type="text" name="$dname\_minute" $special $state value="$min" size="3" />};
                    556:     my $secondselector= qq{<input type="text" name="$dname\_second" $special $state value="$sec" size="3" />};
1.134     raeburn   557:     my $cal_link;
                    558:     if (!$nolink) {
                    559:         $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
                    560:     }
1.95      matthew   561:     #
1.175     raeburn   562:     my $tzone = ' '.$tzname.' ';
1.95      matthew   563:     if ($no_hh_mm_ss) {
1.134     raeburn   564:         $result .= &mt('[_1] [_2] [_3] ',
1.174     raeburn   565:                        $monthselector,$dayselector,$yearselector).
                    566:                    $tzone;
1.134     raeburn   567:         if (!$nolink) {
1.141     albertel  568:             $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
1.134     raeburn   569:         }
1.95      matthew   570:     } else {
1.134     raeburn   571:         $result .= &mt('[_1] [_2] [_3] [_4] [_5]m [_6]s ',
                    572:                       $monthselector,$dayselector,$yearselector,
1.174     raeburn   573:                       $hourselector,$minuteselector,$secondselector).
                    574:                    $tzone;
1.134     raeburn   575:         if (!$nolink) {
1.141     albertel  576:             $result .= &mt('[_1]Select Date[_2]',$cal_link,'</a>');
1.134     raeburn   577:         }
1.67      matthew   578:     }
1.135     albertel  579:     $result .= "</span>\n<!-- end $dname date setting form -->\n";
1.10      matthew   580:     return $result;
                    581: }
                    582: 
1.175     raeburn   583: sub get_timedates {
                    584:     my ($epoch) = @_;
                    585:     my $dt = DateTime->from_epoch(epoch => $epoch)
                    586:                      ->set_time_zone(&Apache::lonlocal::gettimezone());
                    587:     my $tzname = $dt->time_zone_short_name();
                    588:     my $sec = $dt->second;
                    589:     my $min = $dt->minute;
                    590:     my $hour = $dt->hour;
                    591:     my $mday = $dt->day;
                    592:     my $month = $dt->month;
                    593:     if ($month) {
                    594:         $month --;
                    595:     }
                    596:     my $year = $dt->year;
                    597:     return ($tzname,$sec,$min,$hour,$mday,$month,$year);
                    598: }
1.166     banghart  599: 
                    600: sub build_url {
                    601:     my ($base, $fields)=@_;
                    602:     my $url;
                    603:     $url = $base.'?';
1.168     albertel  604:     foreach my $key (keys(%$fields)) {
                    605:         $url.=&escape($key).'='.&escape($$fields{$key}).'&amp;';
1.166     banghart  606:     }
                    607:     $url =~ s/&amp;$//;
                    608:     return $url;
                    609: }
                    610: 
                    611: 
1.10      matthew   612: ##############################################
                    613: ##############################################
                    614: 
1.22      matthew   615: =pod
                    616: 
1.10      matthew   617: =item &get_date_from_form
1.22      matthew   618: 
                    619: get_date_from_form retrieves the date specified in an &date_setter form.
1.10      matthew   620: 
                    621: Inputs:
                    622: 
                    623: =over 4
                    624: 
                    625: =item $dname
                    626: 
1.226     bisitz    627: The name passed to &date_setter, which prefixes the form elements.
1.10      matthew   628: 
                    629: =item $defaulttime
                    630: 
                    631: The unix time to use as the default in case of poor inputs.
                    632: 
                    633: =back
                    634: 
                    635: Returns: Unix time represented in the form.
                    636: 
                    637: =cut
                    638: 
                    639: ##############################################
                    640: ##############################################
                    641: sub get_date_from_form {
                    642:     my ($dname) = @_;
                    643:     my ($sec,$min,$hour,$day,$month,$year);
                    644:     #
1.104     albertel  645:     if (defined($env{'form.'.$dname.'_second'})) {
                    646:         my $tmpsec = $env{'form.'.$dname.'_second'};
1.10      matthew   647:         if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
                    648:             $sec = $tmpsec;
                    649:         }
1.64      albertel  650: 	if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
1.67      matthew   651:     } else {
                    652:         $sec = 0;
1.10      matthew   653:     }
1.104     albertel  654:     if (defined($env{'form.'.$dname.'_minute'})) {
                    655:         my $tmpmin = $env{'form.'.$dname.'_minute'};
1.10      matthew   656:         if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
                    657:             $min = $tmpmin;
                    658:         }
1.64      albertel  659: 	if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
1.67      matthew   660:     } else {
                    661:         $min = 0;
1.10      matthew   662:     }
1.104     albertel  663:     if (defined($env{'form.'.$dname.'_hour'})) {
                    664:         my $tmphour = $env{'form.'.$dname.'_hour'};
1.33      matthew   665:         if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
1.10      matthew   666:             $hour = $tmphour;
                    667:         }
1.67      matthew   668:     } else {
                    669:         $hour = 0;
1.10      matthew   670:     }
1.104     albertel  671:     if (defined($env{'form.'.$dname.'_day'})) {
                    672:         my $tmpday = $env{'form.'.$dname.'_day'};
1.10      matthew   673:         if (($tmpday =~ /^\d+$/) && ($tmpday > 0) && ($tmpday < 32)) {
                    674:             $day = $tmpday;
                    675:         }
                    676:     }
1.104     albertel  677:     if (defined($env{'form.'.$dname.'_month'})) {
                    678:         my $tmpmonth = $env{'form.'.$dname.'_month'};
1.10      matthew   679:         if (($tmpmonth =~ /^\d+$/) && ($tmpmonth > 0) && ($tmpmonth < 13)) {
1.175     raeburn   680:             $month = $tmpmonth;
1.10      matthew   681:         }
                    682:     }
1.104     albertel  683:     if (defined($env{'form.'.$dname.'_year'})) {
                    684:         my $tmpyear = $env{'form.'.$dname.'_year'};
1.175     raeburn   685:         if (($tmpyear =~ /^\d+$/) && ($tmpyear >= 1970)) {
                    686:             $year = $tmpyear;
1.10      matthew   687:         }
                    688:     }
1.175     raeburn   689:     if (($year<1970) || ($year>2037)) { return undef; }
1.33      matthew   690:     if (defined($sec) && defined($min)   && defined($hour) &&
1.175     raeburn   691:         defined($day) && defined($month) && defined($year)) {
                    692:         my $timezone = &Apache::lonlocal::gettimezone();
                    693:         my $dt = DateTime->new( year   => $year,
                    694:                                 month  => $month,
                    695:                                 day    => $day,
                    696:                                 hour   => $hour,
                    697:                                 minute => $min,
                    698:                                 second => $sec,
                    699:                                 time_zone => $timezone,
                    700:                               );
                    701:         my $epoch_time  = $dt->epoch;
                    702:         if ($epoch_time ne '') {
                    703:             return $epoch_time;
                    704:         } else {
                    705:             return undef;
                    706:         }
1.10      matthew   707:     } else {
                    708:         return undef;
                    709:     }
1.20      matthew   710: }
                    711: 
                    712: ##############################################
                    713: ##############################################
                    714: 
                    715: =pod
                    716: 
                    717: =item &pjump_javascript_definition()
                    718: 
                    719: Returns javascript defining the 'pjump' function, which opens up a
                    720: parameter setting wizard.
                    721: 
                    722: =cut
                    723: 
                    724: ##############################################
                    725: ##############################################
                    726: sub pjump_javascript_definition {
                    727:     my $Str = <<END;
1.109     www       728:     function pjump(type,dis,value,marker,ret,call,hour,min,sec) {
1.20      matthew   729:         parmwin=window.open("/adm/rat/parameter.html?type="+escape(type)
                    730:                  +"&value="+escape(value)+"&marker="+escape(marker)
                    731:                  +"&return="+escape(ret)
1.109     www       732:                  +"&call="+escape(call)+"&name="+escape(dis)
                    733:                  +"&defhour="+escape(hour)+"&defmin="+escape(min)
                    734:                  +"&defsec="+escape(sec),"LONCAPAparms",
1.20      matthew   735:                  "height=350,width=350,scrollbars=no,menubar=no");
                    736:     }
                    737: END
                    738:     return $Str;
1.10      matthew   739: }
                    740: 
                    741: ##############################################
                    742: ##############################################
1.17      matthew   743: 
                    744: =pod
                    745: 
                    746: =item &javascript_nothing()
                    747: 
                    748: Return an appropriate null for the users browser.  This is used
                    749: as the first arguement for window.open calls when you want a blank
                    750: window that you can then write to.
                    751: 
                    752: =cut
                    753: 
                    754: ##############################################
                    755: ##############################################
                    756: sub javascript_nothing {
                    757:     # mozilla and other browsers work with "''", but IE on mac does not.
                    758:     my $nothing = "''";
                    759:     my $user_browser;
                    760:     my $user_os;
1.104     albertel  761:     $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
                    762:     $user_os      = $env{'browser.os'}   if (exists($env{'browser.os'}));
1.17      matthew   763:     if (! defined($user_browser) || ! defined($user_os)) {
                    764:         (undef,$user_browser,undef,undef,undef,$user_os) = 
                    765:                            &Apache::loncommon::decode_user_agent();
                    766:     }
                    767:     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
                    768:         $nothing = "'javascript:void(0);'";
                    769:     }
                    770:     return $nothing;
                    771: }
                    772: 
1.90      www       773: ##############################################
                    774: ##############################################
                    775: sub javascript_docopen {
1.171     albertel  776:     my ($mimetype) = @_;
                    777:     $mimetype ||= 'text/html';
1.90      www       778:     # safari does not understand document.open() and loads "text/html"
                    779:     my $nothing = "''";
                    780:     my $user_browser;
                    781:     my $user_os;
1.104     albertel  782:     $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
                    783:     $user_os      = $env{'browser.os'}   if (exists($env{'browser.os'}));
1.90      www       784:     if (! defined($user_browser) || ! defined($user_os)) {
                    785:         (undef,$user_browser,undef,undef,undef,$user_os) = 
                    786:                            &Apache::loncommon::decode_user_agent();
                    787:     }
                    788:     if ($user_browser eq 'safari' && $user_os =~ 'mac') {
                    789:         $nothing = "document.clear()";
                    790:     } else {
1.171     albertel  791: 	$nothing = "document.open('$mimetype','replace')";
1.90      www       792:     }
                    793:     return $nothing;
                    794: }
                    795: 
1.21      matthew   796: 
1.17      matthew   797: ##############################################
                    798: ##############################################
                    799: 
1.21      matthew   800: =pod
1.17      matthew   801: 
1.21      matthew   802: =item &StatusOptions()
1.10      matthew   803: 
1.21      matthew   804: Returns html for a selection box which allows the user to choose the
                    805: enrollment status of students.  The selection box name is 'Status'.
1.6       stredwic  806: 
1.21      matthew   807: Inputs:
1.6       stredwic  808: 
1.21      matthew   809: $status: the currently selected status.  If undefined the value of
1.104     albertel  810: $env{'form.Status'} is taken.  If that is undefined, a value of 'Active'
1.21      matthew   811: is used.
1.6       stredwic  812: 
1.21      matthew   813: $formname: The name of the form.  If defined the onchange attribute of
                    814: the selection box is set to document.$formname.submit().
1.6       stredwic  815: 
1.21      matthew   816: $size: the size (number of lines) of the selection box.
1.6       stredwic  817: 
1.27      matthew   818: $onchange: javascript to use when the value is changed.  Enclosed in 
                    819: double quotes, ""s, not single quotes.
                    820: 
1.21      matthew   821: Returns: a perl string as described.
1.1       stredwic  822: 
1.21      matthew   823: =cut
1.9       stredwic  824: 
1.21      matthew   825: ##############################################
                    826: ##############################################
                    827: sub StatusOptions {
1.165     banghart  828:     my ($status, $formName,$size,$onchange,$mult)=@_;
1.21      matthew   829:     $size = 1 if (!defined($size));
                    830:     if (! defined($status)) {
                    831:         $status = 'Active';
1.104     albertel  832:         $status = $env{'form.Status'} if (exists($env{'form.Status'}));
1.9       stredwic  833:     }
1.1       stredwic  834: 
                    835:     my $Str = '';
                    836:     $Str .= '<select name="Status"';
1.165     banghart  837:     if (defined($mult)){
                    838:         $Str .= ' multiple="multiple" ';
                    839:     }
1.27      matthew   840:     if(defined($formName) && $formName ne '' && ! defined($onchange)) {
1.1       stredwic  841:         $Str .= ' onchange="document.'.$formName.'.submit()"';
1.27      matthew   842:     }
                    843:     if (defined($onchange)) {
                    844:         $Str .= ' onchange="'.$onchange.'"';
1.1       stredwic  845:     }
1.21      matthew   846:     $Str .= ' size="'.$size.'" ';
1.1       stredwic  847:     $Str .= '>'."\n";
1.153     raeburn   848:     foreach my $type (['Active',  &mt('Currently Has Access')],
                    849: 		      ['Future',  &mt('Will Have Future Access')],
                    850: 		      ['Expired', &mt('Previously Had Access')],
                    851: 		      ['Any',     &mt('Any Access Status')]) {
1.151     albertel  852: 	my ($name,$label) = @$type;
                    853: 	$Str .= '<option value="'.$name.'" ';
                    854: 	if ($status eq $name) {
                    855: 	    $Str .= 'selected="selected" ';
                    856: 	}
                    857: 	$Str .= '>'.$label.'</option>'."\n";
                    858:     }
                    859: 
1.1       stredwic  860:     $Str .= '</select>'."\n";
1.7       stredwic  861: }
1.12      matthew   862: 
                    863: ########################################################
                    864: ########################################################
1.7       stredwic  865: 
1.23      matthew   866: =pod
                    867: 
                    868: =item Progess Window Handling Routines
                    869: 
                    870: These routines handle the creation, update, increment, and closure of 
                    871: progress windows.  The progress window reports to the user the number
                    872: of items completed and an estimate of the time required to complete the rest.
                    873: 
                    874: =over 4
                    875: 
                    876: 
                    877: =item &Create_PrgWin
                    878: 
                    879: Writes javascript to the client to open a progress window and returns a
                    880: data structure used for bookkeeping.
                    881: 
                    882: Inputs
                    883: 
                    884: =over 4
                    885: 
                    886: =item $r Apache request
                    887: 
                    888: =item $title The title of the progress window
                    889: 
                    890: =item $heading A description (usually 1 line) of the process being initiated.
                    891: 
                    892: =item $number_to_do The total number of items being processed.
1.50      albertel  893: 
                    894: =item $type Either 'popup' or 'inline' (popup is assumed if nothing is
                    895:        specified)
                    896: 
1.51      albertel  897: =item $width Specify the width in charaters of the input field.
                    898: 
1.50      albertel  899: =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
                    900: 
                    901: =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 
1.23      matthew   902: 
                    903: =back
                    904: 
                    905: Returns a hash containing the progress state data structure.
                    906: 
                    907: 
                    908: =item &Update_PrgWin
                    909: 
                    910: Updates the text in the progress indicator.  Does not increment the count.
                    911: See &Increment_PrgWin.
                    912: 
                    913: Inputs:
                    914: 
                    915: =over 4
                    916: 
                    917: =item $r Apache request
                    918: 
                    919: =item $prog_state Pointer to the data structure returned by &Create_PrgWin
                    920: 
                    921: =item $displaystring The string to write to the status indicator
                    922: 
                    923: =back
                    924: 
                    925: Returns: none
                    926: 
                    927: 
                    928: =item Increment_PrgWin
                    929: 
                    930: Increment the count of items completed for the progress window by 1.  
                    931: 
                    932: Inputs:
                    933: 
                    934: =over 4
                    935: 
                    936: =item $r Apache request
                    937: 
                    938: =item $prog_state Pointer to the data structure returned by Create_PrgWin
                    939: 
                    940: =item $extraInfo A description of the items being iterated over.  Typically
                    941: 'student'.
                    942: 
                    943: =back
                    944: 
                    945: Returns: none
                    946: 
                    947: 
                    948: =item Close_PrgWin
                    949: 
                    950: Closes the progress window.
                    951: 
                    952: Inputs:
                    953: 
                    954: =over 4 
                    955: 
                    956: =item $r Apache request
                    957: 
                    958: =item $prog_state Pointer to the data structure returned by Create_PrgWin
                    959: 
                    960: =back
                    961: 
                    962: Returns: none
                    963: 
                    964: =back
                    965: 
                    966: =cut
                    967: 
                    968: ########################################################
                    969: ########################################################
                    970: 
1.51      albertel  971: my $uniq=0;
                    972: sub get_uniq_name {
                    973:     $uniq++;
                    974:     return 'uniquename'.$uniq;
                    975: }
                    976: 
1.7       stredwic  977: # Create progress
                    978: sub Create_PrgWin {
1.51      albertel  979:     my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
                    980: 	$inputname)=@_;
1.49      albertel  981:     if (!defined($type)) { $type='popup'; }
1.51      albertel  982:     if (!defined($width)) { $width=55; }
1.49      albertel  983:     my %prog_state;
                    984:     $prog_state{'type'}=$type;
                    985:     if ($type eq 'popup') {
                    986: 	$prog_state{'window'}='popwin';
1.122     albertel  987: 	my $start_page =
                    988: 	    &Apache::loncommon::start_page($title,undef,
                    989: 					   {'only_body' => 1,
                    990: 					    'bgcolor'   => '#88DDFF',
                    991: 					    'js_ready'  => 1});
                    992: 	my $end_page = &Apache::loncommon::end_page({'js_ready'  => 1});
                    993: 
1.49      albertel  994: 	#the whole function called through timeout is due to issues
                    995: 	#in mozilla Read BUG #2665 if you want to know the whole story
1.230     bisitz    996: 	&r_print($r,&Apache::lonhtmlcommon::scripttag(
1.49      albertel  997:         "var popwin;
                    998:          function openpopwin () {
                    999:          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
1.122     albertel 1000:         "popwin.document.writeln(\'".$start_page.
1.170     albertel 1001:               "<h4>".&mt("$heading")."<\/h4>".
1.212     bisitz   1002:               "<form action=\"\" name=\"popremain\" method=\"post\">".
1.51      albertel 1003:               '<input type="text" size="'.$width.'" name="remaining" value="'.
1.131     albertel 1004: 	      &mt('Starting').'" /><\\/form>'.$end_page.
1.122     albertel 1005:               "\');".
1.49      albertel 1006:         "popwin.document.close();}".
1.230     bisitz   1007:         "\nwindow.setTimeout(openpopwin,0)"
                   1008:     ));
1.49      albertel 1009: 	$prog_state{'formname'}='popremain';
                   1010: 	$prog_state{'inputname'}="remaining";
                   1011:     } elsif ($type eq 'inline') {
                   1012: 	$prog_state{'window'}='window';
                   1013: 	if (!$formname) {
1.51      albertel 1014: 	    $prog_state{'formname'}=&get_uniq_name();
1.159     banghart 1015: 	    &r_print($r,'<form action="" name="'.$prog_state{'formname'}.'">');
1.49      albertel 1016: 	} else {
                   1017: 	    $prog_state{'formname'}=$formname;
                   1018: 	}
                   1019: 	if (!$inputname) {
1.51      albertel 1020: 	    $prog_state{'inputname'}=&get_uniq_name();
1.170     albertel 1021: 	    &r_print($r,&mt("$heading [_1]",' <input type="text" name="'.$prog_state{'inputname'}.'" size="'.$width.'" />'));
1.49      albertel 1022: 	} else {
                   1023: 	    $prog_state{'inputname'}=$inputname;
                   1024: 	    
                   1025: 	}
                   1026: 	if (!$formname) { &r_print($r,'</form>'); }
                   1027: 	&Update_PrgWin($r,\%prog_state,&mt('Starting'));
                   1028:     }
1.7       stredwic 1029: 
1.16      albertel 1030:     $prog_state{'done'}=0;
1.23      matthew  1031:     $prog_state{'firststart'}=&Time::HiRes::time();
                   1032:     $prog_state{'laststart'}=&Time::HiRes::time();
1.16      albertel 1033:     $prog_state{'max'}=$number_to_do;
1.49      albertel 1034:     
1.14      albertel 1035:     return %prog_state;
1.7       stredwic 1036: }
                   1037: 
                   1038: # update progress
                   1039: sub Update_PrgWin {
1.14      albertel 1040:     my ($r,$prog_state,$displayString)=@_;
1.230     bisitz   1041:     &r_print($r,&Apache::lonhtmlcommon::scripttag(
1.218     bisitz   1042:         $$prog_state{'window'}.'.document.'.
1.230     bisitz   1043:         $$prog_state{'formname'}.'.'.
                   1044:         $$prog_state{'inputname'}.'.value="'.
                   1045:         $displayString.'";'
                   1046:     ));
1.23      matthew  1047:     $$prog_state{'laststart'}=&Time::HiRes::time();
1.14      albertel 1048: }
                   1049: 
                   1050: # increment progress state
                   1051: sub Increment_PrgWin {
                   1052:     my ($r,$prog_state,$extraInfo)=@_;
1.16      albertel 1053:     $$prog_state{'done'}++;
1.23      matthew  1054:     my $time_est= (&Time::HiRes::time() - $$prog_state{'firststart'})/
                   1055:         $$prog_state{'done'} *
1.16      albertel 1056: 	($$prog_state{'max'}-$$prog_state{'done'});
                   1057:     $time_est = int($time_est);
1.80      matthew  1058:     #
                   1059:     my $min = int($time_est/60);
                   1060:     my $sec = $time_est % 60;
                   1061:     # 
                   1062:     my $str;
1.91      albertel 1063:     if ($min == 0 && $sec > 1) {
1.80      matthew  1064:         $str = '[_2] seconds';
1.91      albertel 1065:     } elsif ($min == 1 && $sec > 1) {
                   1066:         $str = '1 minute [_2] seconds';
1.80      matthew  1067:     } elsif ($min == 1 && $sec < 2) {
                   1068:         $str = '1 minute';
                   1069:     } elsif ($min < 10 && $sec > 1) {
                   1070:         $str = '[_1] minutes, [_2] seconds';
1.81      matthew  1071:     } elsif ($min >= 10 || $sec < 2) {
1.80      matthew  1072:         $str = '[_1] minutes';
1.16      albertel 1073:     }
1.80      matthew  1074:     $time_est = &mt($str,$min,$sec);
                   1075:     #
1.23      matthew  1076:     my $lasttime = &Time::HiRes::time()-$$prog_state{'laststart'};
                   1077:     if ($lasttime > 9) {
                   1078:         $lasttime = int($lasttime);
                   1079:     } elsif ($lasttime < 0.01) {
                   1080:         $lasttime = 0;
                   1081:     } else {
                   1082:         $lasttime = sprintf("%3.2f",$lasttime);
                   1083:     }
1.19      matthew  1084:     if ($lasttime == 1) {
1.32      www      1085:         $lasttime = '('.$lasttime.' '.&mt('second for').' '.$extraInfo.')';
1.19      matthew  1086:     } else {
1.32      www      1087:         $lasttime = '('.$lasttime.' '.&mt('seconds for').' '.$extraInfo.')';
1.28      matthew  1088:     }
                   1089:     #
1.104     albertel 1090:     my $user_browser = $env{'browser.type'} if (exists($env{'browser.type'}));
                   1091:     my $user_os      = $env{'browser.os'}   if (exists($env{'browser.os'}));
1.28      matthew  1092:     if (! defined($user_browser) || ! defined($user_os)) {
                   1093:         (undef,$user_browser,undef,undef,undef,$user_os) = 
                   1094:                            &Apache::loncommon::decode_user_agent();
                   1095:     }
                   1096:     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
                   1097:         $lasttime = '';
1.19      matthew  1098:     }
1.230     bisitz   1099:     &r_print($r,&Apache::lonhtmlcommon::scripttag(
1.218     bisitz   1100:         $$prog_state{'window'}.'.document.'.
1.230     bisitz   1101:         $$prog_state{'formname'}.'.'.
                   1102:         $$prog_state{'inputname'}.'.value="'.
                   1103:         $$prog_state{'done'}.'/'.$$prog_state{'max'}.
                   1104:         ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'
                   1105:     ));
1.23      matthew  1106:     $$prog_state{'laststart'}=&Time::HiRes::time();
1.7       stredwic 1107: }
                   1108: 
                   1109: # close Progress Line
                   1110: sub Close_PrgWin {
1.14      albertel 1111:     my ($r,$prog_state)=@_;
1.49      albertel 1112:     if ($$prog_state{'type'} eq 'popup') {
1.230     bisitz   1113:         &r_print($r,&Apache::lonhtmlcommon::scripttag(
                   1114:             'popwin.close()'
                   1115:         ));
1.49      albertel 1116:     } elsif ($$prog_state{'type'} eq 'inline') {
                   1117: 	&Update_PrgWin($r,$prog_state,&mt('Done'));
                   1118:     }
1.48      albertel 1119:     undef(%$prog_state);
                   1120: }
                   1121: 
                   1122: sub r_print {
                   1123:     my ($r,$to_print)=@_;
                   1124:     if ($r) {
                   1125: 	$r->print($to_print);
                   1126: 	$r->rflush();
1.47      sakharuk 1127:     } else {
1.48      albertel 1128: 	print($to_print);
1.47      sakharuk 1129:     }
1.1       stredwic 1130: }
1.34      www      1131: 
                   1132: # ------------------------------------------------------- Puts directory header
                   1133: 
                   1134: sub crumbs {
1.252     bisitz   1135:     my ($uri,$target,$prefix,$form,$skiplast)=@_;
1.100     raeburn  1136:     if ($target) {
                   1137:         $target = ' target="'.
                   1138:                   &Apache::loncommon::escape_single($target).'"';
                   1139:     }
1.252     bisitz   1140:     my $output='<span class="LC_filename">';
                   1141:     $output.=$prefix.'/';
1.249     raeburn  1142:     if (($env{'user.adv'}) || ($env{'user.author'})) {
1.252     bisitz   1143:         my $path=$prefix.'/';
                   1144:         foreach my $dir (split('/',$uri)) {
1.99      matthew  1145:             if (! $dir) { next; }
                   1146:             $path .= $dir;
1.252     bisitz   1147:             if ($path eq $uri) {
                   1148:                 if ($skiplast) {
                   1149:                     $output.=$dir;
1.132     www      1150:                     last;
1.252     bisitz   1151:                 } 
                   1152:             } else {
                   1153:                 $path.='/'; 
                   1154:             }
1.157     albertel 1155:             my $href_path = &HTML::Entities::encode($path,'<>&"');
1.252     bisitz   1156:             &Apache::loncommon::inhibit_menu_check(\$href_path);
                   1157:             if ($form) {
                   1158:                 my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
                   1159:                 $output.=qq{<a href="$href"$target>$dir</a>/};
                   1160:             } else {
                   1161:                 $output.=qq{<a href="$href_path"$target>$dir</a>/};
                   1162:             }
                   1163:         }
1.35      www      1164:     } else {
1.252     bisitz   1165:         foreach my $dir (split('/',$uri)) {
1.149     albertel 1166:             if (! $dir) { next; }
1.252     bisitz   1167:             $output.=$dir.'/';
                   1168:         }
1.34      www      1169:     }
1.149     albertel 1170:     if ($uri !~ m|/$|) { $output=~s|/$||; }
1.252     bisitz   1171:     $output.='</span>';
                   1172: 
                   1173:     return $output;
1.34      www      1174: }
                   1175: 
1.85      www      1176: # --------------------- A function that generates a window for the spellchecker
                   1177: 
                   1178: sub spellheader {
1.123     albertel 1179:     my $start_page=
                   1180: 	&Apache::loncommon::start_page('Speller Suggestions',undef,
1.140     albertel 1181: 				       {'only_body'   => 1,
                   1182: 					'js_ready'    => 1,
                   1183: 					'bgcolor'     => '#DDDDDD',
                   1184: 				        'add_entries' => {
                   1185: 					    'onload' => 
                   1186:                                                'document.forms.spellcheckform.submit()',
                   1187:                                              }
                   1188: 				        });
1.123     albertel 1189:     my $end_page=
                   1190: 	&Apache::loncommon::end_page({'js_ready'  => 1}); 
                   1191: 
1.105     www      1192:     my $nothing=&javascript_nothing();
1.85      www      1193:     return (<<ENDCHECK);
                   1194: <script type="text/javascript"> 
1.218     bisitz   1195: // <![CDATA[
1.92      albertel 1196: //<!-- BEGIN LON-CAPA Internal
1.85      www      1197: var checkwin;
                   1198: 
1.140     albertel 1199: function spellcheckerwindow(string) {
                   1200:     var esc_string = string.replace(/\"/g,'&quot;');
1.105     www      1201:     checkwin=window.open($nothing,'spellcheckwin','height=320,width=280,resizable=yes,scrollbars=yes,location=no,menubar=no,toolbar=no');
1.154     albertel 1202:     checkwin.document.writeln('$start_page<form name="spellcheckform" action="/adm/spellcheck" method="post"><input type="hidden" name="text" value="'+esc_string+'" /><\\/form>$end_page');
1.85      www      1203:     checkwin.document.close();
                   1204: }
1.92      albertel 1205: // END LON-CAPA Internal -->
1.218     bisitz   1206: // ]]>
1.85      www      1207: </script>
                   1208: ENDCHECK
                   1209: }
                   1210: 
                   1211: # ---------------------------------- Generate link to spell checker for a field
                   1212: 
                   1213: sub spelllink {
                   1214:     my ($form,$field)=@_;
                   1215:     my $linktext=&mt('Check Spelling');
                   1216:     return (<<ENDLINK);
1.140     albertel 1217: <a href="javascript:if (typeof(document.$form.onsubmit)!='undefined') { if (document.$form.onsubmit!=null) { document.$form.onsubmit();}};spellcheckerwindow(this.document.forms.$form.$field.value);">$linktext</a>
1.85      www      1218: ENDLINK
                   1219: }
                   1220: 
1.52      www      1221: # ------------------------------------------------- Output headers for HTMLArea
                   1222: 
1.124     albertel 1223: {
                   1224:     my @htmlareafields;
                   1225:     sub init_htmlareafields {
                   1226: 	undef(@htmlareafields);
                   1227:     }
                   1228:     
                   1229:     sub add_htmlareafields {
                   1230: 	my (@newfields) = @_;
                   1231: 	push(@htmlareafields,@newfields);
                   1232:     }
                   1233: 
                   1234:     sub get_htmlareafields {
                   1235: 	return @htmlareafields;
                   1236:     }
                   1237: }
                   1238: 
1.52      www      1239: sub htmlareaheaders {
1.255     faziophi 1240: 	my $s="";
1.260     faziophi 1241: 	if (&htmlareabrowser()) {
1.255     faziophi 1242: 		$s.=(<<ENDEDITOR);
                   1243: <script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
                   1244: ENDEDITOR
                   1245: 	}
                   1246:     $s.=(<<ENDJQUERY);
                   1247: <script type="text/javascript" src="/adm/jQuery/js/jquery-1.3.2.min.js"></script>
                   1248: <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.7.2.custom.min.js"></script>
1.259     faziophi 1249: <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.7.2.custom.css" />
1.255     faziophi 1250: ENDJQUERY
                   1251: 	return $s;
1.52      www      1252: }
                   1253: 
1.76      www      1254: # ----------------------------------------------------------------- Preferences
                   1255: 
                   1256: sub disablelink {
1.77      www      1257:     my @fields=@_;
                   1258:     if (defined($#fields)) {
                   1259: 	unless ($#fields>=0) { return ''; }
                   1260:     }
1.265.2.1! faziophi 1261:     return ''; #'<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=off&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Disable WYSIWYG Editor').'</a>';
1.76      www      1262: }
                   1263: 
                   1264: sub enablelink {
1.77      www      1265:     my @fields=@_;
                   1266:     if (defined($#fields)) {
                   1267: 	unless ($#fields>=0) { return ''; }
                   1268:     }
1.130     www      1269:     return '<a href="'.&HTML::Entities::encode('/adm/preferences?action=set_wysiwyg&wysiwyg=on&returnurl=','<>&"').&escape($ENV{'REQUEST_URI'}).'">'.&mt('Enable WYSIWYG Editor').'</a>';
1.76      www      1270: }
                   1271: 
1.167     albertel 1272: # ------------------------------------------------- lang to use in html editor
                   1273: sub htmlarea_lang {
                   1274:     my $lang='en';
                   1275:     if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
                   1276: 	$lang=&mt('htmlarea_lang');
                   1277:     }
                   1278:     return $lang;
                   1279: }
                   1280: 
1.72      www      1281: # ----------------------------------------- Script to activate only some fields
                   1282: 
                   1283: sub htmlareaselectactive {
1.73      www      1284:     my @fields=@_;
1.76      www      1285:     unless (&htmlareabrowser()) { return ''; }
1.260     faziophi 1286:     #if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
1.262     raeburn  1287:     my $output='<script type="text/javascript" defer="defer">'."\n"
1.230     bisitz   1288:               .'// <![CDATA['."\n";
1.167     albertel 1289:     my $lang = &htmlarea_lang();
1.255     faziophi 1290:     $output.='
                   1291:     
                   1292:     function containsBlockHtml(id) {
                   1293: 		var re = $("#"+id).html().search(/(?:\&lt\;|\<)(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div)[\s]*((?:\/[\s]*(?:\&gt\;|\>)|(?:\&gt\;|\>)[\s\S]*(?:\&lt\;|\<)\/[\s]*\1[\s]*\(?:\&gt\;|\>))/im);
                   1294:     	return (re >= 0);
                   1295:     }
                   1296:     
                   1297:     function startRichEditor(id) {
                   1298:     	CKEDITOR.replace(id, 
                   1299:     		{
1.258     faziophi 1300:     			customConfig: "/ckeditor/loncapaconfig.js"
1.255     faziophi 1301:     		}
                   1302:     	);
                   1303:     }
                   1304:     
                   1305:     function destroyRichEditor(id) {
                   1306:     	CKEDITOR.instances[id].destroy();
1.72      www      1307:     }
1.255     faziophi 1308:     
                   1309:     function editorHandler(event) {
                   1310:     	var rawid = $(this).attr("id");
                   1311:     	var id = new RegExp("LC_rt_(.*)").exec(rawid)[1]
                   1312:     	event.preventDefault();
                   1313:     	if ($(this).hasClass("LC_enable_rt")) {
                   1314:     		startRichEditor(id);
                   1315: 			$("#LC_rt_"+id).html("<b>&laquo; Plain text</b>");
                   1316: 			$("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
                   1317: 			$("#LC_rt_"+id).addClass("LC_disable_rt");
                   1318: 			$("#LC_rt_"+id).removeClass("LC_enable_rt");
                   1319:     	} else {
                   1320: 			destroyRichEditor(id);
                   1321: 			$("#LC_rt_"+id).html("<b>Rich formatting &raquo;</b>");
                   1322: 			$("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
                   1323: 			$("#LC_rt_"+id).addClass("LC_enable_rt");
                   1324: 			$("#LC_rt_"+id).removeClass("LC_disable_rt");
                   1325: 		}
                   1326: 	}
                   1327:     
                   1328:     $(document).ready(function(){
                   1329: 		$(".LC_richAlwaysOn").each(function() {
                   1330: 			startRichEditor($(this).attr("id"));
                   1331: 		});
                   1332: 		$(".LC_richDetectHtml").each(function() {
                   1333: 			var id = $(this).attr("id");
                   1334: 			if(containsBlockHtml(id)) {
                   1335: 				$(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>&laquo; Plain text</b></a></div>");				
                   1336: 				startRichEditor(id);
                   1337: 				$("#LC_rt_"+id).click(editorHandler);				
                   1338: 			}
                   1339: 			else {
                   1340: 				$(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");
                   1341: 				$("#LC_rt_"+id).click(editorHandler);
                   1342: 			}
                   1343: 		});
                   1344: 		$(".LC_richDefaultOn").each(function() {
                   1345: 			var id = $(this).attr("id");
                   1346: 			$(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>&laquo; Plain text</b></a></div>");				
                   1347: 			startRichEditor(id);
                   1348: 			$("#LC_rt_"+id).click(editorHandler);
                   1349: 		});
                   1350: 		$(".LC_richDefaultOff").each(function() {
                   1351: 			var id = $(this).attr("id");
                   1352: 			$(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");
                   1353: 			$("#LC_rt_"+id).click(editorHandler);			
                   1354: 		});
1.256     faziophi 1355: 		
1.255     faziophi 1356: 	});
1.263     faziophi 1357: '; 
1.218     bisitz   1358:     $output.="\nwindow.status='Activated Editfields';\n"
1.230     bisitz   1359:             .'// ]]>'."\n"
1.218     bisitz   1360:             .'</script><br />'.
1.77      www      1361: 	&disablelink(@fields);
1.72      www      1362:     return $output;
                   1363: }
                   1364: 
1.61      www      1365: # --------------------------------------------------------------------- Blocked
                   1366: 
                   1367: sub htmlareablocked {
1.104     albertel 1368:     unless ($env{'environment.wysiwygeditor'} eq 'on') { return 1; }
1.71      www      1369:     return 0;
1.52      www      1370: }
                   1371: 
                   1372: # ---------------------------------------- Browser capable of running HTMLArea?
                   1373: 
                   1374: sub htmlareabrowser {
                   1375:     return 1;
                   1376: }
1.53      matthew  1377: 
                   1378: ############################################################
                   1379: ############################################################
                   1380: 
                   1381: =pod
                   1382: 
                   1383: =item breadcrumbs
                   1384: 
                   1385: Compiles the previously registered breadcrumbs into an series of links.
                   1386: Additionally supports a 'component', which will be displayed on the
1.223     droeschl 1387: right side of the breadcrumbs enclosing div (without a link).
1.53      matthew  1388: A link to help for the component will be included if one is specified.
                   1389: 
                   1390: All inputs can be undef without problems.
                   1391: 
1.223     droeschl 1392: Inputs: $component (the text on the right side of the breadcrumbs trail),
1.53      matthew  1393:         $component_help
1.63      albertel 1394:         $menulink (boolean, controls whether to include a link to /adm/menu)
1.138     albertel 1395:         $helplink (if 'nohelp' don't include the orange help link)
                   1396:         $css_class (optional name for the class to apply to the table for CSS)
1.197     raeburn  1397:         $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
                   1398:            when including the text on the right.
1.53      matthew  1399: Returns a string containing breadcrumbs for the current page.
                   1400: 
                   1401: =item clear_breadcrumbs
                   1402: 
                   1403: Clears the previously stored breadcrumbs.
                   1404: 
                   1405: =item add_breadcrumb
                   1406: 
                   1407: Pushes a breadcrumb on the stack of crumbs.
                   1408: 
                   1409: input: $breadcrumb, a hash reference.  The keys 'href','title', and 'text'
                   1410: are required.  If present the keys 'faq' and 'bug' will be used to provide
1.156     albertel 1411: links to the FAQ and bug sites. If the key 'no_mt' is present the 'title' 
                   1412: and 'text' values won't be sent through &mt()
1.53      matthew  1413: 
                   1414: returns: nothing    
                   1415: 
                   1416: =cut
                   1417: 
                   1418: ############################################################
                   1419: ############################################################
                   1420: {
                   1421:     my @Crumbs;
1.242     droeschl 1422:     my %tools = ();
1.57      matthew  1423:     
1.53      matthew  1424:     sub breadcrumbs {
1.216     bisitz   1425:         my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
1.53      matthew  1426:         #
1.215     droeschl 1427:         $css_class ||= 'LC_breadcrumbs';
1.205     amueller 1428: 
1.57      matthew  1429:         # Make the faq and bug data cascade
1.223     droeschl 1430:         my $faq  = '';
                   1431:         my $bug  = '';
                   1432:         my $help = '';
1.215     droeschl 1433:         # Crumb Symbol
1.223     droeschl 1434:         my $crumbsymbol = '&raquo;';
1.60      www      1435:         # The last breadcrumb does not have a link, so handle it separately.
1.53      matthew  1436:         my $last = pop(@Crumbs);
1.57      matthew  1437:         #
1.70      matthew  1438:         # The first one should be the course or a menu link
1.215     droeschl 1439:         if (!defined($menulink)) { $menulink=1; }
1.70      matthew  1440:         if ($menulink) {
                   1441:             my $description = 'Menu';
1.172     raeburn  1442:             my $no_mt_descr = 0;
1.104     albertel 1443:             if (exists($env{'request.course.id'}) && 
                   1444:                 $env{'request.course.id'} ne '') {
1.70      matthew  1445:                 $description = 
1.104     albertel 1446:                     $env{'course.'.$env{'request.course.id'}.'.description'};
1.172     raeburn  1447:                 $no_mt_descr = 1;
1.70      matthew  1448:             }
1.215     droeschl 1449:             $menulink =  {  href   =>'/adm/menu',
                   1450:                             title  =>'Go to main menu',
                   1451:                             target =>'_top',
                   1452:                             text   =>$description,
                   1453:                             no_mt  =>$no_mt_descr, };
                   1454:             if($last) {
                   1455:                 #$last set, so we have some crumbs
                   1456:                 unshift(@Crumbs,$menulink);
                   1457:             } else {
                   1458:                 #only menulink crumb present
                   1459:                 $last = $menulink;
                   1460:             }
1.53      matthew  1461:         }
1.219     droeschl 1462:         my $links = join "", 
1.261     droeschl 1463:              map {
                   1464:                  $faq  = $_->{'faq'}  if (exists($_->{'faq'}));
                   1465:                  $bug  = $_->{'bug'}  if (exists($_->{'bug'}));
                   1466:                  $help = $_->{'help'} if (exists($_->{'help'}));
                   1467: 
                   1468:                  my $result = $_->{no_mt} ? $_->{text} : mt($_->{text});
                   1469: 
                   1470:                  if ($_->{href}){
                   1471:                      $result = htmltag( 'a', $result, 
                   1472:                        { href   => $_->{href},
                   1473:                          title  => $_->{no_mt} ? $_->{title} : mt($_->{title}),
                   1474:                          target => $_->{target}, });
                   1475:                  }
                   1476: 
                   1477:                  $result = htmltag( 'li', "$result $crumbsymbol");
                   1478:              } @Crumbs;
1.223     droeschl 1479: 
                   1480:         #should the last Element be translated?
1.261     droeschl 1481: 
                   1482:         my $lasttext = $last->{'no_mt'} ? $last->{'text'} 
                   1483:                      : mt( $last->{'text'} );
                   1484: 
                   1485:         $links .= htmltag( 'li', htmltag('b', $lasttext), {title => $lasttext});
1.223     droeschl 1486: 
1.54      matthew  1487:         my $icons = '';
1.223     droeschl 1488:         $faq  = $last->{'faq'}  if (exists($last->{'faq'}));
                   1489:         $bug  = $last->{'bug'}  if (exists($last->{'bug'}));
1.106     www      1490:         $help = $last->{'help'} if (exists($last->{'help'}));
                   1491:         $component_help=($component_help?$component_help:$help);
1.145     albertel 1492: #        if ($faq ne '') {
                   1493: #            $icons .= &Apache::loncommon::help_open_faq($faq);
                   1494: #        }
1.79      raeburn  1495: #        if ($bug ne '') {
                   1496: #            $icons .= &Apache::loncommon::help_open_bug($bug);
                   1497: #        }
1.223     droeschl 1498:         if ($faq ne '' || $component_help ne '' || $bug ne '') {
                   1499:             $icons .= &Apache::loncommon::help_open_menu($component,
                   1500:                                                          $component_help,
                   1501:                                                          $faq,$bug);
                   1502:         }
1.54      matthew  1503:         #
1.205     amueller 1504: 		
                   1505: 
1.223     droeschl 1506:         unless ($CourseBreadcrumbs) {
                   1507:             $links = htmltag('ol',  $links, { id => "LC_MenuBreadcrumbs"   });
                   1508:         } else {
1.227     bisitz   1509:             $links = htmltag('ul',  $links, { class => "LC_CourseBreadcrumbs" });
1.53      matthew  1510:         }
1.223     droeschl 1511: 
                   1512:         if ($component) {
                   1513:             $links = htmltag('span', 
                   1514:                              ( $no_mt ? $component : mt($component) ).
                   1515:                              ( $icons ? $icons : '' ),
                   1516:                              { class => 'LC_breadcrumbs_component' } )
                   1517:                              .$links;
                   1518:         }
                   1519:         
1.261     droeschl 1520:         render_tools(\$links);
1.223     droeschl 1521:         $links = htmltag('div', $links, 
1.225     bisitz   1522:                         { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
1.261     droeschl 1523:         render_advtools(\$links);
1.223     droeschl 1524: 
1.53      matthew  1525:         # Return the @Crumbs stack to what we started with
                   1526:         push(@Crumbs,$last);
                   1527:         shift(@Crumbs);
1.223     droeschl 1528:         # Return the breadcrumb's line
                   1529:         return "$links";
1.53      matthew  1530:     }
                   1531: 
                   1532:     sub clear_breadcrumbs {
                   1533:         undef(@Crumbs);
1.242     droeschl 1534:         undef(%tools);
1.53      matthew  1535:     }
                   1536: 
                   1537:     sub add_breadcrumb {
1.232     raeburn  1538:         push(@Crumbs,@_);
1.53      matthew  1539:     }
1.242     droeschl 1540:     
1.261     droeschl 1541: =item add_breadcrumb_tool($category, $html)
                   1542: 
                   1543: Adds $html to $category of the breadcrumb toolbar container.
                   1544: 
                   1545: $html is usually a link to a page that invokes a function on the currently 
                   1546: displayed data (e.g. print when viewing a problem)
                   1547: 
                   1548: Currently there are 3 possible values for $category: 
                   1549: 
                   1550: =over 
                   1551: 
                   1552: =item navigation 
                   1553: left of breadcrumbs line
                   1554: 
                   1555: =item tools 
                   1556: right of breadcrumbs line
                   1557: 
                   1558: =item advtools 
                   1559: advanced tools shown in a separate box below breadcrumbs line 
                   1560: 
                   1561: =back
                   1562:  
                   1563: returns: nothing
                   1564: 
                   1565: =cut
1.242     droeschl 1566: 
                   1567:     sub add_breadcrumb_tool {
1.261     droeschl 1568:         my ($category, @html) = @_;
                   1569:         return unless @html;
1.242     droeschl 1570:         if (!defined(%tools)) { 
1.261     droeschl 1571:             %tools = ( navigation => [], tools => [], advtools => []);
1.242     droeschl 1572:         }
1.261     droeschl 1573: 
                   1574:         #this cleans data received from lonmenu::innerregister
                   1575:         @html = grep {defined $_ && $_ ne ''} @html;
                   1576:         for (@html) { 
                   1577:             s/align="(right|left)"//; 
                   1578:             s/<span.*?\/span>// if $category ne 'advtools'; 
                   1579:         } 
                   1580: 
                   1581:         push @{$tools{$category}}, @html;
1.242     droeschl 1582:     }
                   1583: 
1.261     droeschl 1584: =item clear_breadcrumb_tools()
                   1585: 
                   1586: Clears the breadcrumb toolbar container.
                   1587: 
                   1588: returns: nothing
                   1589: 
                   1590: =cut
                   1591: 
1.245     droeschl 1592:     sub clear_breadcrumb_tools {
                   1593:         undef(%tools);
                   1594:     }
                   1595: 
1.261     droeschl 1596: =item render_tools(\$breadcrumbs)
                   1597: 
                   1598: Creates html for breadcrumb tools (categories navigation and tools) and inserts 
                   1599: \$breadcrumbs at the correct position.
                   1600: 
                   1601: input: \$breadcrumbs - a reference to the string containing prepared 
                   1602: breadcrumbs.
                   1603: 
                   1604: returns: nothing
                   1605: =cut
                   1606: 
                   1607: #TODO might split this in separate functions for each category
                   1608:     sub render_tools {
                   1609:         my ($breadcrumbs) = @_;
1.242     droeschl 1610:         return unless defined %tools;
1.261     droeschl 1611: 
                   1612:         my $navigation = list_from_array($tools{navigation}, 
                   1613:                    { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
                   1614:         my $tools = list_from_array($tools{tools}, 
                   1615:                    { listattr => { class=>"LC_breadcrumb_tools_tools" } });
                   1616:         $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs], 
                   1617:                    { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
                   1618:     }
                   1619: 
                   1620: =item render_advtools(\$breadcrumbs)
                   1621: 
                   1622: Creates html for advanced tools (category advtools) and inserts \$breadcrumbs 
                   1623: at the correct position.
                   1624: 
                   1625: input: \$breadcrumbs - a reference to the string containing prepared 
                   1626: breadcrumbs (after render_tools call).
                   1627: 
                   1628: returns: nothing
                   1629: =cut
                   1630: 
                   1631:     sub render_advtools {
                   1632:         my ($breadcrumbs) = @_;
                   1633:         return unless     (defined $tools{'advtools'}) 
                   1634:                       and (scalar(@{$tools{'advtools'}}) > 0);
                   1635: 
                   1636:         $$breadcrumbs .= Apache::loncommon::head_subbox(
                   1637:                             funclist_from_array($tools{'advtools'}) );
1.242     droeschl 1638:     }
1.53      matthew  1639: 
1.57      matthew  1640: } # End of scope for @Crumbs
1.53      matthew  1641: 
                   1642: ############################################################
                   1643: ############################################################
                   1644: 
1.112     raeburn  1645: # Nested table routines.
                   1646: #
                   1647: # Routines to display form items in a multi-row table with 2 columns.
                   1648: # Uses nested tables to divide form elements into segments.
                   1649: # For examples of use see loncom/interface/lonnotify.pm 
                   1650: #
                   1651: # Can be used in following order: ...
                   1652: # &start_pick_box()
                   1653: # row1
                   1654: # row2
                   1655: # row3   ... etc.
1.173     raeburn  1656: # &submit_row()
1.161     raeburn  1657: # &end_pick_box()
1.112     raeburn  1658: #
                   1659: # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row,
                   1660: # &status_select_row and &email_default_row
                   1661: #
                   1662: # Can also be used in following order:
                   1663: #
                   1664: # &start_pick_box()
                   1665: # &row_title()
                   1666: # &row_closure()
                   1667: # &row_title()
                   1668: # &row_closure()  ... etc.
                   1669: # &submit_row()
                   1670: # &end_pick_box()
                   1671: #
                   1672: # In general a &submit_row() call should proceed the call to &end_pick_box(),
                   1673: # as this routine adds a button for form submission.
1.113     raeburn  1674: # &submit_row() does not require a &row_closure after it.
1.112     raeburn  1675: #  
                   1676: # &start_pick_box() creates a bounding table with 1-pixel wide black border.
                   1677: # rows should be placed between calls to &start_pick_box() and &end_pick_box.
                   1678: #
                   1679: # &row_title() adds a title in the left column for each segment.
                   1680: # &row_closure() closes a row with a 1-pixel wide black line.
                   1681: #
                   1682: # &role_select_row() provides a select box from which to choose 1 or more roles 
                   1683: # &course_select_row provides ways of picking groups of courses
                   1684: #    radio buttons: all, by category or by picking from a course picker pop-up
                   1685: #      note: by category option is only displayed if a domain has implemented 
                   1686: #                selection by year, semester, department, number etc.
                   1687: #
                   1688: # &status_select_row() provides a select box from which to choose 1 or more
                   1689: #  access types (current access, prior access, and future access)  
                   1690: #
                   1691: # &email_default_row() provides text boxes for default e-mail suffixes for
                   1692: #  different authentication types in a domain.
                   1693: #
                   1694: # &row_title() and &row_closure() are called internally by the &*_select_row
                   1695: # routines, but can also be called directly to start and end rows which have 
                   1696: # needs that are not accommodated by the *_select_row() routines.    
                   1697: 
1.193     bisitz   1698: { # Start: row_count block for pick_box
                   1699: my @row_count;
                   1700: 
1.112     raeburn  1701: sub start_pick_box {
1.142     albertel 1702:     my ($css_class) = @_;
                   1703:     if (defined($css_class)) {
                   1704: 	$css_class = 'class="'.$css_class.'"';
                   1705:     } else {
                   1706: 	$css_class= 'class="LC_pick_box"';
                   1707:     }
1.193     bisitz   1708:     unshift(@row_count,0);
1.112     raeburn  1709:     my $output = <<"END";
1.142     albertel 1710:  <table $css_class>
1.112     raeburn  1711: END
                   1712:     return $output;
                   1713: }
                   1714: 
                   1715: sub end_pick_box {
1.193     bisitz   1716:     shift(@row_count);
1.112     raeburn  1717:     my $output = <<"END";
                   1718:        </table>
                   1719: END
                   1720:     return $output;
                   1721: }
                   1722: 
1.181     bisitz   1723: sub row_headline {
                   1724:     my $output = <<"END";
                   1725:            <tr><td colspan="2">
                   1726: END
                   1727:     return $output;
                   1728: }
                   1729: 
1.112     raeburn  1730: sub row_title {
1.243     amueller 1731:     my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
1.193     bisitz   1732:     $row_count[0]++;
                   1733:     my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.142     albertel 1734:     $css_title_class ||= 'LC_pick_box_title';
                   1735:     $css_title_class = 'class="'.$css_title_class.'"';
                   1736: 
                   1737:     $css_value_class ||= 'LC_pick_box_value';
                   1738: 
1.173     raeburn  1739:     if ($title ne '') {
                   1740:         $title .= ':';
                   1741:     }
1.112     raeburn  1742:     my $output = <<"ENDONE";
1.243     amueller 1743:            <tr class="LC_pick_box_row" $css_value_furtherAttributes> 
1.142     albertel 1744:             <td $css_title_class>
1.173     raeburn  1745: 	       $title
1.112     raeburn  1746:             </td>
1.193     bisitz   1747:             <td class="$css_value_class $css_class">
1.112     raeburn  1748: ENDONE
                   1749:     return $output;
                   1750: }
                   1751: 
                   1752: sub row_closure {
1.143     albertel 1753:     my ($no_separator) =@_;
1.113     raeburn  1754:     my $output = <<"ENDTWO";
1.112     raeburn  1755:             </td>
                   1756:            </tr>
1.143     albertel 1757: ENDTWO
                   1758:     if (!$no_separator) {
                   1759:         $output .= <<"ENDTWO";
1.112     raeburn  1760:            <tr>
1.143     albertel 1761:             <td colspan="2" class="LC_pick_box_separator">
1.112     raeburn  1762:             </td>
                   1763:            </tr>
                   1764: ENDTWO
1.143     albertel 1765:     }
1.112     raeburn  1766:     return $output;
                   1767: }
                   1768: 
1.193     bisitz   1769: } # End: row_count block for pick_box
                   1770: 
                   1771: 
1.112     raeburn  1772: sub role_select_row {
1.147     raeburn  1773:     my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
1.236     raeburn  1774:     my $crstype = 'Course';
                   1775:     if ($cdom ne '' && $cnum ne '') {
                   1776:         $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
                   1777:     }
1.116     raeburn  1778:     my $output;
                   1779:     if (defined($title)) {
1.142     albertel 1780:         $output = &row_title($title,$css_class);
1.116     raeburn  1781:     }
1.142     albertel 1782:     $output .= qq|
1.198     bisitz   1783:                                   <select name="roles" multiple="multiple">\n|;
1.113     raeburn  1784:     foreach my $role (@$roles) {
1.114     raeburn  1785:         my $plrole;
                   1786:         if ($role eq 'ow') {
                   1787:             $plrole = &mt('Course Owner');
1.147     raeburn  1788:         } elsif ($role eq 'cr') {
                   1789:             if ($show_separate_custom) {
                   1790:                 if ($cdom ne '' && $cnum ne '') {
                   1791:                     my %course_customroles = &course_custom_roles($cdom,$cnum);
                   1792:                     foreach my $crrole (sort(keys(%course_customroles))) {
                   1793:                         my ($plcrrole) = ($crrole =~ m|^cr/[^/]+/[^/]+/(.+)$|);
                   1794:                         $output .= '  <option value="'.$crrole.'">'.$plcrrole.
                   1795:                                    '</option>';
                   1796:                     }
                   1797:                 }
                   1798:             } else {
                   1799:                 $plrole = &mt('Custom Role');
                   1800:             }
1.114     raeburn  1801:         } else {
1.236     raeburn  1802:             $plrole=&Apache::lonnet::plaintext($role,$crstype);
1.114     raeburn  1803:         }
1.147     raeburn  1804:         if (($role ne 'cr') || (!$show_separate_custom)) {
                   1805:             $output .= '  <option value="'.$role.'">'.$plrole.'</option>';
                   1806:         }
1.112     raeburn  1807:     }
1.142     albertel 1808:     $output .= qq|                </select>\n|;
1.116     raeburn  1809:     if (defined($title)) {
                   1810:         $output .= &row_closure();
                   1811:     }
1.112     raeburn  1812:     return $output;
                   1813: }
                   1814: 
                   1815: sub course_select_row {
1.142     albertel 1816:     my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
1.237     raeburn  1817: 	$css_class,$crstype) = @_;
1.142     albertel 1818:     my $output = &row_title($title,$css_class);
1.237     raeburn  1819:     $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype);
1.169     raeburn  1820:     $output .= &row_closure();
                   1821:     return $output;
                   1822: }
                   1823: 
                   1824: sub course_selection {
1.237     raeburn  1825:     my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_;
1.169     raeburn  1826:     my $output = qq|
1.142     albertel 1827: <script type="text/javascript">
1.218     bisitz   1828: // <![CDATA[
1.112     raeburn  1829:     function coursePick (formname) {
                   1830:         for  (var i=0; i<formname.coursepick.length; i++) {
1.114     raeburn  1831:             if (formname.coursepick[i].value == 'category') {
                   1832:                 courseSet('');
                   1833:             }
1.112     raeburn  1834:             if (!formname.coursepick[i].checked) {
                   1835:                 if (formname.coursepick[i].value == 'specific') {
                   1836:                     formname.coursetotal.value = 0;
                   1837:                     formname.courselist = '';
                   1838:                 }
                   1839:             }
                   1840:         }
                   1841:     }
1.114     raeburn  1842:     function setPick (formname) {
                   1843:         for  (var i=0; i<formname.coursepick.length; i++) {
                   1844:             if (formname.coursepick[i].value == 'category') {
                   1845:                 formname.coursepick[i].checked = true;
                   1846:             }
                   1847:             formname.coursetotal.value = 0;
                   1848:             formname.courselist = '';
                   1849:         }
                   1850:     }
1.218     bisitz   1851: // ]]>
1.112     raeburn  1852: </script>
                   1853:     |;
1.237     raeburn  1854: 
                   1855:     my ($allcrs,$pickspec);
                   1856:     if ($crstype eq 'Community') {
                   1857:         $allcrs = &mt('All communities');
                   1858:         $pickspec = &mt('Pick specific communities:');
                   1859:     } else {
                   1860:         $allcrs = &mt('All courses');
                   1861:         $pickspec = &mt('Pick specific course(s):');
                   1862:     }
                   1863: 
1.112     raeburn  1864:     my $courseform='<b>'.&Apache::loncommon::selectcourse_link
1.237     raeburn  1865:                      ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
                   1866:         $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
1.112     raeburn  1867:     if ($totcodes > 0) {
                   1868:         my $numtitles = @$codetitles;
                   1869:         if ($numtitles > 0) {
1.129     raeburn  1870:             $output .= '<input type="radio" name="coursepick" value="category" onclick="coursePick(this.form);alert('."'".&mt('Choose categories, from left to right')."'".')" />'.&mt('Pick courses by category:').' <br />';
1.112     raeburn  1871:             $output .= '<table><tr><td>'.$$codetitles[0].'<br />'."\n".
                   1872:                '<select name="'.$$codetitles[0].
1.114     raeburn  1873:                '" onChange="setPick(this.form);courseSet('."'$$codetitles[0]'".')">'."\n".
1.112     raeburn  1874:                ' <option value="-1" />Select'."\n";
                   1875:             my @items = ();
                   1876:             my @longitems = ();
                   1877:             if ($$idlist{$$codetitles[0]} =~ /","/) {
1.113     raeburn  1878:                 @items = split(/","/,$$idlist{$$codetitles[0]});
1.112     raeburn  1879:             } else {
                   1880:                 $items[0] = $$idlist{$$codetitles[0]};
                   1881:             }
                   1882:             if (defined($$idlist_titles{$$codetitles[0]})) {
                   1883:                 if ($$idlist_titles{$$codetitles[0]} =~ /","/) {
1.113     raeburn  1884:                     @longitems = split(/","/,$$idlist_titles{$$codetitles[0]});
1.112     raeburn  1885:                 } else {
                   1886:                     $longitems[0] = $$idlist_titles{$$codetitles[0]};
                   1887:                 }
                   1888:                 for (my $i=0; $i<@longitems; $i++) {
                   1889:                     if ($longitems[$i] eq '') {
                   1890:                         $longitems[$i] = $items[$i];
                   1891:                     }
                   1892:                 }
                   1893:             } else {
                   1894:                 @longitems = @items;
                   1895:             }
                   1896:             for (my $i=0; $i<@items; $i++) {
                   1897:                 $output .= ' <option value="'.$items[$i].'">'.$longitems[$i].'</option>';
                   1898:             }
                   1899:             $output .= '</select></td>';
                   1900:             for (my $i=1; $i<$numtitles; $i++) {
                   1901:                 $output .= '<td>'.$$codetitles[$i].'<br />'."\n".
                   1902:                           '<select name="'.$$codetitles[$i].
                   1903:                           '" onChange="courseSet('."'$$codetitles[$i]'".')">'."\n".
                   1904:                           '<option value="-1">&lt;-Pick '.$$codetitles[$i-1].'</option>'."\n".
                   1905:                           '</select>'."\n".
                   1906:                           '</td>';
                   1907:             }
                   1908:             $output .= '</tr></table><br />';
                   1909:         }
                   1910:     }
1.238     raeburn  1911:     $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'.$pickspec.' '.$courseform.'&nbsp;&nbsp;<input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
1.112     raeburn  1912:     return $output;
                   1913: }
                   1914: 
                   1915: sub status_select_row {
1.142     albertel 1916:     my ($types,$title,$css_class) = @_;
1.117     raeburn  1917:     my $output; 
                   1918:     if (defined($title)) {
1.142     albertel 1919:         $output = &row_title($title,$css_class,'LC_pick_box_select');
1.117     raeburn  1920:     }
1.142     albertel 1921:     $output .= qq|
1.198     bisitz   1922:                                     <select name="types" multiple="multiple">\n|;
1.113     raeburn  1923:     foreach my $status_type (sort(keys(%{$types}))) {
1.112     raeburn  1924:         $output .= '  <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
                   1925:     }
1.142     albertel 1926:     $output .= qq|                   </select>\n|; 
1.117     raeburn  1927:     if (defined($title)) {
                   1928:         $output .= &row_closure();
                   1929:     }
1.112     raeburn  1930:     return $output;
                   1931: }
                   1932: 
                   1933: sub email_default_row {
1.142     albertel 1934:     my ($authtypes,$title,$descrip,$css_class) = @_;
                   1935:     my $output = &row_title($title,$css_class);
                   1936:     $output .= $descrip.
                   1937: 	&Apache::loncommon::start_data_table().
                   1938: 	&Apache::loncommon::start_data_table_header_row().
                   1939: 	'<th>'.&mt('Authentication Method').'</th>'.
                   1940: 	'<th align="right">'.&mt('Username -> e-mail conversion').'</th>'."\n".
                   1941: 	&Apache::loncommon::end_data_table_header_row();
1.112     raeburn  1942:     my $rownum = 0;
1.113     raeburn  1943:     foreach my $auth (sort(keys(%{$authtypes}))) {
1.112     raeburn  1944:         my ($userentry,$size);
                   1945:         if ($auth =~ /^krb/) {
                   1946:             $userentry = '';
                   1947:             $size = 25;
                   1948:         } else {
                   1949:             $userentry = 'username@';
                   1950:             $size = 15;
                   1951:         }
1.142     albertel 1952:         $output .= &Apache::loncommon::start_data_table_row().
                   1953: 	    '<td>  '.$$authtypes{$auth}.'</td>'.
                   1954: 	    '<td align="right">'.$userentry.
                   1955: 	    '<input type="text" name="'.$auth.'" size="'.$size.'" /></td>'.
                   1956: 	    &Apache::loncommon::end_data_table_row();
1.112     raeburn  1957:     }
1.142     albertel 1958:     $output .= &Apache::loncommon::end_data_table();
1.112     raeburn  1959:     $output .= &row_closure();
                   1960:     return $output;
                   1961: }
                   1962: 
                   1963: 
                   1964: sub submit_row {
1.142     albertel 1965:     my ($title,$cmd,$submit_text,$css_class) = @_;
                   1966:     my $output = &row_title($title,$css_class,'LC_pick_box_submit');
1.112     raeburn  1967:     $output .= qq|
                   1968:              <br />
                   1969:              <input type="hidden" name="command" value="$cmd" />
                   1970:              <input type="submit" value="$submit_text"/> &nbsp;
                   1971:              <br /><br />
1.142     albertel 1972:             \n|;
1.112     raeburn  1973:     return $output;
                   1974: }
1.1       stredwic 1975: 
1.147     raeburn  1976: sub course_custom_roles {
                   1977:     my ($cdom,$cnum) = @_;
                   1978:     my %returnhash=();
                   1979:     my %coursepersonnel=&Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   1980:     foreach my $person (sort(keys(%coursepersonnel))) {
                   1981:         my ($role) = ($person =~ /^([^:]+):/);
                   1982:         my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   1983:         if ($end == -1 && $start == -1) {
                   1984:             next;
                   1985:         }
                   1986:         if ($role =~ m|^cr/[^/]+/[^/]+/[^/]|) {
                   1987:             $returnhash{$role} ++;
                   1988:         }
                   1989:     }
                   1990:     return %returnhash;
                   1991: }
                   1992: 
                   1993: 
1.119     raeburn  1994: ##############################################
                   1995: ##############################################
1.179     raeburn  1996: 
                   1997: # topic_bar
                   1998: #
1.248     wenzelju 1999: # Generates a div containing an (optional) number with a white background followed by a 
1.240     raeburn  2000: # title with a background color defined in the corresponding CSS: LC_topic_bar
                   2001: # Inputs:
1.248     wenzelju 2002: # 1. number to display.
                   2003: #    If input for number is empty only the title will be displayed. 
1.240     raeburn  2004: # 2. title text to display.
                   2005: # Outputs - a scalar containing html mark-up for the div.
                   2006: 
1.179     raeburn  2007: sub topic_bar {
1.248     wenzelju 2008:     my ($num,$title) = @_;
                   2009:     my $number = '';
                   2010:     if ($num ne '') {
                   2011:         $number = '<span>'.$num.'</span>';
1.239     amueller 2012:     }
1.248     wenzelju 2013:     return '<div class="LC_topic_bar">'.$number.$title.'</div>';
1.179     raeburn  2014: }
                   2015: 
                   2016: ##############################################
                   2017: ##############################################
1.119     raeburn  2018: # echo_form_input
                   2019: #
                   2020: # Generates html markup to add form elements from the referrer page
                   2021: # as hidden form elements (values encoded) in the new page.
                   2022: #
                   2023: # Intended to support two types of use 
                   2024: # (a) to allow backing up to earlier pages in a multi-page 
                   2025: # form submission process using a breadcrumb trail.
                   2026: #
                   2027: # (b) to allow the current page to be reloaded with form elements
                   2028: # set on previous page to remain unchanged.  An example would
                   2029: # be where the a page containing a dynamically-built table of data is 
                   2030: # is to be redisplayed, with only the sort order of the data changed. 
                   2031: #  
                   2032: # Inputs:
                   2033: # 1. Reference to array of form elements in the submitted form on 
                   2034: # the referrer page which are to be excluded from the echoed elements.
                   2035: #
                   2036: # 2. Reference to array of regular expressions, which if matched in the  
                   2037: # name of the form element n the referrer page will be omitted from echo. 
                   2038: #
                   2039: # Outputs: A scalar containing the html markup for the echoed form
                   2040: # elements (all as hidden elements, with values encoded). 
                   2041: 
                   2042: 
                   2043: sub echo_form_input {
                   2044:     my ($excluded,$regexps) = @_;
                   2045:     my $output = '';
                   2046:     foreach my $key (keys(%env)) {
                   2047:         if ($key =~ /^form\.(.+)$/) {
                   2048:             my $name = $1;
                   2049:             my $match = 0;
                   2050:             if ((!@{$excluded}) || (!grep/^$name$/,@{$excluded})) {
                   2051:                 if (defined($regexps)) {
                   2052:                     if (@{$regexps} > 0) {
                   2053:                         foreach my $regexp (@{$regexps}) {
                   2054:                             if ($name =~ /\Q$regexp\E/) {
                   2055:                                 $match = 1;
                   2056:                                 last;
                   2057:                             }
                   2058:                         }
                   2059:                     }
                   2060:                 }
                   2061:                 if (!$match) {
                   2062:                     if (ref($env{$key})) {
                   2063:                         foreach my $value (@{$env{$key}}) {
                   2064:                             $value = &HTML::Entities::encode($value,'<>&"');
                   2065:                             $output .= '<input type="hidden" name="'.$name.
                   2066:                                              '" value="'.$value.'" />'."\n";
                   2067:                         }
                   2068:                     } else {
                   2069:                         my $value = &HTML::Entities::encode($env{$key},'<>&"');
                   2070:                         $output .= '<input type="hidden" name="'.$name.
                   2071:                                              '" value="'.$value.'" />'."\n";
                   2072:                     }
                   2073:                 }
                   2074:             }
                   2075:         }
                   2076:     }
                   2077:     return $output;
                   2078: }
                   2079: 
                   2080: ##############################################
                   2081: ##############################################
                   2082: # set_form_elements
                   2083: #
                   2084: # Generates javascript to set form elements to values based on
                   2085: # corresponding values for the same form elements when the page was
                   2086: # previously submitted.
                   2087: #     
                   2088: # Last submission values are read from hidden form elements in referring 
                   2089: # page which have the same name, i.e., generated by &echo_form_input(). 
                   2090: #
                   2091: # Intended to be called by onload event.
                   2092: #
1.121     raeburn  2093: # Inputs:
                   2094: # (a) Reference to hash of echoed form elements to be set.
1.119     raeburn  2095: #
                   2096: # In the hash, keys are the form element names, and the values are the
                   2097: # element type (selectbox, radio, checkbox or text -for textbox, textarea or
                   2098: # hidden).
1.121     raeburn  2099: #
                   2100: # (b) Optional reference to hash of stored elements to be set.
                   2101: #
                   2102: # If the page being displayed is a page which permits modification of
                   2103: # previously stored data, e.g., the first page in a multi-page submission,
                   2104: # then if stored is supplied, form elements will be set to the last stored
                   2105: # values.  If user supplied values are also available for the same elements
                   2106: # these will replace the stored values. 
                   2107: #        
1.119     raeburn  2108: # Output:
                   2109: #  
                   2110: # javascript function - set_form_elements() which sets form elements,
                   2111: # expects an argument: formname - the name of the form according to 
                   2112: # the DOM, e.g., document.compose
                   2113: 
                   2114: sub set_form_elements {
1.121     raeburn  2115:     my ($elements,$stored) = @_;
                   2116:     my %values;
1.119     raeburn  2117:     my $output .= 'function setFormElements(courseForm) {
1.121     raeburn  2118: ';
                   2119:     if (defined($stored)) {
                   2120:         foreach my $name (keys(%{$stored})) {
                   2121:             if (exists($$elements{$name})) {
                   2122:                 if (ref($$stored{$name}) eq 'ARRAY') {
                   2123:                     $values{$name} = $$stored{$name};
                   2124:                 } else {
                   2125:                     @{$values{$name}} = ($$stored{$name});
                   2126:                 }
                   2127:             }
                   2128:         }
                   2129:     }
                   2130: 
1.119     raeburn  2131:     foreach my $key (keys(%env)) {
                   2132:         if ($key =~ /^form\.(.+)$/) {
                   2133:             my $name = $1;
                   2134:             if (exists($$elements{$name})) {
1.121     raeburn  2135:                 @{$values{$name}} = &Apache::loncommon::get_env_multiple($key);
                   2136:             }
                   2137:         }
                   2138:     }
                   2139: 
                   2140:     foreach my $name (keys(%values)) {
                   2141:         for (my $i=0; $i<@{$values{$name}}; $i++) {
                   2142:             $values{$name}[$i] = &HTML::Entities::decode($values{$name}[$i],'<>&"');
                   2143:             $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
                   2144:             $values{$name}[$i] =~ s/"/\\"/g;
                   2145:         }
1.234     raeburn  2146:         if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
1.121     raeburn  2147:             my $numvalues = @{$values{$name}};
                   2148:             if ($numvalues > 1) {
                   2149:                 my $valuestring = join('","',@{$values{$name}});
                   2150:                 $output .= qq|
1.119     raeburn  2151:   var textvalues = new Array ("$valuestring");
1.147     raeburn  2152:   var total = courseForm.elements['$name'].length;
1.119     raeburn  2153:   if (total > $numvalues) {
                   2154:       total = $numvalues;
                   2155:   }    
                   2156:   for (var i=0; i<total; i++) {
1.147     raeburn  2157:       courseForm.elements['$name']\[i].value = textvalues[i];
1.119     raeburn  2158:   }
                   2159: |;
1.121     raeburn  2160:             } else {
                   2161:                 $output .= qq|
1.147     raeburn  2162:   courseForm.elements['$name'].value = "$values{$name}[0]";
1.119     raeburn  2163: |;
1.121     raeburn  2164:             }
                   2165:         } else {
                   2166:             $output .=  qq|
1.147     raeburn  2167:   var elementLength = courseForm.elements['$name'].length;
1.119     raeburn  2168:   if (elementLength==undefined) {
                   2169: |;
1.121     raeburn  2170:             foreach my $value (@{$values{$name}}) {
                   2171:                 if ($$elements{$name} eq 'selectbox') {
                   2172:                     $output .=  qq|
1.147     raeburn  2173:       if (courseForm.elements['$name'].options[0].value == "$value") {
                   2174:           courseForm.elements['$name'].options[0].selected = true;
1.119     raeburn  2175:       }|;
1.121     raeburn  2176:                 } elsif (($$elements{$name} eq 'radio') ||
                   2177:                          ($$elements{$name} eq 'checkbox')) {
                   2178:                     $output .= qq|
1.147     raeburn  2179:       if (courseForm.elements['$name'].value == "$value") {
1.148     albertel 2180:           courseForm.elements['$name'].checked = true;
1.234     raeburn  2181:       } else {
                   2182:           courseForm.elements['$name'].checked = false;
1.119     raeburn  2183:       }|;
1.121     raeburn  2184:                 }
                   2185:             }
                   2186:             $output .= qq|
1.119     raeburn  2187:   }
                   2188:   else {
1.147     raeburn  2189:       for (var i=0; i<courseForm.elements['$name'].length; i++) {
1.119     raeburn  2190: |;
1.121     raeburn  2191:             if ($$elements{$name} eq 'selectbox') {
                   2192:                 $output .=  qq|
1.147     raeburn  2193:           courseForm.elements['$name'].options[i].selected = false;|;
1.121     raeburn  2194:             } elsif (($$elements{$name} eq 'radio') || 
                   2195:                      ($$elements{$name} eq 'checkbox')) {
                   2196:                 $output .= qq|
1.147     raeburn  2197:           courseForm.elements['$name']\[i].checked = false;|; 
1.121     raeburn  2198:             }
                   2199:             $output .= qq|
1.119     raeburn  2200:       }
1.147     raeburn  2201:       for (var j=0; j<courseForm.elements['$name'].length; j++) {
1.119     raeburn  2202: |;
1.121     raeburn  2203:             foreach my $value (@{$values{$name}}) {
                   2204:                 if ($$elements{$name} eq 'selectbox') {
                   2205:                     $output .=  qq|
1.147     raeburn  2206:           if (courseForm.elements['$name'].options[j].value == "$value") {
                   2207:               courseForm.elements['$name'].options[j].selected = true;
1.119     raeburn  2208:           }|;
1.121     raeburn  2209:                 } elsif (($$elements{$name} eq 'radio') ||
                   2210:                          ($$elements{$name} eq 'checkbox')) { 
                   2211:                       $output .= qq|
1.147     raeburn  2212:           if (courseForm.elements['$name']\[j].value == "$value") {
                   2213:               courseForm.elements['$name']\[j].checked = true;
1.119     raeburn  2214:           }|;
1.121     raeburn  2215:                 }
                   2216:             }
                   2217:             $output .= qq|
1.119     raeburn  2218:       }
                   2219:   }
                   2220: |;
                   2221:         }
                   2222:     }
                   2223:     $output .= "
1.235     raeburn  2224:     return;
1.119     raeburn  2225: }\n";
                   2226:     return $output;
                   2227: }
                   2228: 
1.158     raeburn  2229: ##############################################
                   2230: ##############################################
                   2231: 
                   2232: # javascript_valid_email
                   2233: #
                   2234: # Generates javascript to validate an e-mail address.
                   2235: # Returns a javascript function which accetps a form field as argumnent, and
                   2236: # returns false if field.value does not satisfy two regular expression matches
                   2237: # for a valid e-mail address.  Backwards compatible with old browsers without
                   2238: # support for javascript RegExp (just checks for @ in field.value in this case). 
                   2239: 
                   2240: sub javascript_valid_email {
                   2241:     my $scripttag .= <<'END';
                   2242: function validmail(field) {
                   2243:     var str = field.value;
                   2244:     if (window.RegExp) {
                   2245:         var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
                   2246:         var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
                   2247:         var reg1 = new RegExp(reg1str);
                   2248:         var reg2 = new RegExp(reg2str);
                   2249:         if (!reg1.test(str) && reg2.test(str)) {
                   2250:             return true;
                   2251:         }
                   2252:         return false;
                   2253:     }
                   2254:     else
                   2255:     {
                   2256:         if(str.indexOf("@") >= 0) {
                   2257:             return true;
                   2258:         }
                   2259:         return false;
                   2260:     }
                   2261: }
                   2262: END
                   2263:     return $scripttag;
                   2264: }
                   2265: 
1.219     droeschl 2266: 
                   2267: # USAGE: htmltag(element, content, {attribute => value,...});
                   2268: #
                   2269: # EXAMPLES: 
                   2270: #  - htmltag('a', 'this is an anchor', {href  => 'www.example.com', 
                   2271: #                                       title => 'this is a title'})
                   2272: #
                   2273: #  - You might want to set up needed tags like: 
                   2274: #
                   2275: #     my $h3  = sub { return htmltag( "h3",  @_ ) };
                   2276: #
                   2277: #    ... and use them: $h3->("This is a headline")
                   2278: #
                   2279: #  - To set up a couple of tags, see sub inittags
                   2280: #
                   2281: # NOTES:
                   2282: # - Empty elements, such as <br/> are correctly terminated, 
                   2283: #   i.e. htmltag('br') returns <br/> 
                   2284: # - Empty attributes (title="") are filtered out.
                   2285: # - The function will not check for deprecated attributes.
                   2286: #
                   2287: # OUTPUT: content enclosed in xhtml conform tags
                   2288: sub htmltag{
                   2289:     return
                   2290:         qq|<$_[0]|
                   2291:         . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
                   2292:         . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
                   2293: };
                   2294: 
                   2295: 
                   2296: # USAGE: inittags(@tags);
                   2297: #
                   2298: # EXAMPLES:
1.261     droeschl 2299: #  - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
1.219     droeschl 2300: #    $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
                   2301: #
                   2302: # NOTES: See sub htmltag for further information.
                   2303: #
                   2304: # OUTPUT: List of subroutines. 
                   2305: sub inittags {
                   2306:     my @tags = @_;
                   2307:     return map { my $tag = $_;
                   2308:                  sub { return htmltag( $tag, @_ ) }
                   2309:                } @tags;
                   2310: }
                   2311: 
                   2312: 
1.231     droeschl 2313: # USAGE: scripttag(scriptcode, [start|end|both]);
1.229     droeschl 2314: #
                   2315: # EXAMPLES: 
1.231     droeschl 2316: #  - scripttag("alert('Hello World!')", 'both') 
                   2317: #    returns:
                   2318: #    <script type="text/javascript">
                   2319: #    // BEGIN LON-CAPA Internal
                   2320: #    alert(Hello World!')
                   2321: #    // END LON-CAPA Internal
                   2322: #    </script>
1.229     droeschl 2323: #
                   2324: # NOTES:
                   2325: # - works currently only for javascripts
                   2326: #
1.231     droeschl 2327: # OUTPUT: 
                   2328: # Scriptcode properly enclosed in <script> and CDATA tags (and LC
                   2329: # Internal markers if 2nd argument is given)
1.229     droeschl 2330: sub scripttag {
1.231     droeschl 2331:     my ( $content, $marker ) = @_;
                   2332:     return unless defined $content;
                   2333: 
                   2334:     my $begin = "\n// BEGIN LON-CAPA Internal\n";
                   2335:     my $end   = "\n// END LON-CAPA Internal\n";
                   2336: 
                   2337:     if ($marker) {
                   2338:         $content  = $begin . $content if $marker eq 'start' or $marker eq 'both';
                   2339:         $content .= $end              if $marker eq 'end'   or $marker eq 'both';
                   2340:     }
                   2341: 
1.229     droeschl 2342:     $content = "\n// <![CDATA[\n$content\n// ]]>\n";
1.231     droeschl 2343: 
                   2344:     return htmltag('script', $content, {type => 'text/javascript'});
1.229     droeschl 2345: };
                   2346: 
                   2347: 
1.261     droeschl 2348: =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
                   2349: 
                   2350: Constructs a XHTML list from \@array.
                   2351: 
                   2352: input: 
                   2353: 
                   2354: =over
                   2355: 
                   2356: =item \@array 
                   2357: 
                   2358: A reference to the array containing text that will be wrapped in <li></li> tags.
                   2359: 
                   2360: =item { listattr => {}, itemattr =>{} } 
                   2361: 
                   2362: Attributes for <ul> and <li> passed in as hash references. 
                   2363: See htmltag() for more details.
                   2364: 
                   2365: =back
                   2366:  
                   2367: returns: XHTML list as String. 
                   2368: 
                   2369: =cut   
                   2370: 
                   2371: # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
                   2372: sub list_from_array {
                   2373:     my ($items, $args) = @_;
                   2374:     my ($ul, $li) = inittags( qw(ul li) );
                   2375:     my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
                   2376:     return $ul->( $listitems, $args->{listattr} );
                   2377: }
                   2378: 
                   2379: 
1.183     droeschl 2380: ##############################################
                   2381: ##############################################
                   2382: 
                   2383: # generate_menu
                   2384: #
                   2385: # Generates html markup for a menu. 
                   2386: #
                   2387: # Inputs:
                   2388: # An array of following structure:
                   2389: #   ({	categorytitle => 'Categorytitle',
                   2390: #	items => [
1.201     droeschl 2391: #		    {	
                   2392: #           linktext    =>	'Text to be displayed',
                   2393: #			url	        =>	'URL the link is pointing to, i.e. /adm/site?action=dosomething',
1.183     droeschl 2394: #			permission  =>	'Contains permissions as returned from lonnet::allowed(),
1.201     droeschl 2395: #					         must evaluate to true in order to activate the link',
1.184     droeschl 2396: #			icon        =>  'icon filename',
1.186     droeschl 2397: #			alttext	    =>	'alt text for the icon',
1.183     droeschl 2398: #			help	    =>	'Name of the corresponding helpfile',
                   2399: #			linktitle   =>	'Description of the link (used for title tag)'
                   2400: #		    },
                   2401: #		    ...
                   2402: #		]
                   2403: #   }, 
                   2404: #   ...
                   2405: #   )
                   2406: #
                   2407: # Outputs: A scalar containing the html markup for the menu.
                   2408: 
                   2409: sub generate_menu {
                   2410:     my @menu = @_;
1.201     droeschl 2411:     # subs for specific html elements
1.219     droeschl 2412:     my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) ); 
1.201     droeschl 2413:     
                   2414:     my @categories; # each element represents the entire markup for a category
                   2415:    
                   2416:     foreach my $category (@menu) {
                   2417:         my @links;  # contains the links for the current $category
                   2418:         foreach my $link (@{$$category{items}}) {
                   2419:             next unless $$link{permission};
                   2420:             
                   2421:             # create the markup for the current $link and push it into @links.
                   2422:             # each entry consists of an image and a text optionally followed 
                   2423:             # by a help link.
1.232     raeburn  2424:             push(@links,$li->(
1.201     droeschl 2425:                         $a->(
                   2426:                             $img->("", {
                   2427:                                 class => "LC_noBorder LC_middle",
                   2428:                                 src   => "/res/adm/pages/$$link{icon}",
1.202     droeschl 2429:                                 alt   => mt(defined($$link{alttext}) ?
                   2430:                                 $$link{alttext} : $$link{linktext})
1.201     droeschl 2431:                             }), {
                   2432:                             href  => $$link{url},
1.202     droeschl 2433:                             title => mt($$link{linktitle})
1.201     droeschl 2434:                             }).
1.202     droeschl 2435:                         $a->(mt($$link{linktext}), {
1.201     droeschl 2436:                             href  => $$link{url},
1.202     droeschl 2437:                             title => mt($$link{linktitle}),
1.201     droeschl 2438:                             class => "LC_menubuttons_link"
                   2439:                             }).
                   2440:                          (defined($$link{help}) ? 
                   2441:                          Apache::loncommon::help_open_topic($$link{help}) : ''),
1.232     raeburn  2442:                          {class => "LC_menubuttons_inline_text"}));
1.201     droeschl 2443:         }
                   2444: 
                   2445:         # wrap categorytitle in <h3>, concatenate with 
                   2446:         # joined and in <ul> tags wrapped @links
                   2447:         # and wrap everything in an enclosing <div> and push it into
                   2448:         # @categories
                   2449:         # such that each element looks like:
                   2450:         # <div><h3>title</h3><ul><li>...</li>...</ul></div>
                   2451:         # the category won't be added if there aren't any links
1.232     raeburn  2452:         push(@categories, 
1.202     droeschl 2453:             $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
1.201     droeschl 2454:             $ul->(join('' ,@links),  {class =>"LC_ListStyleNormal" }),
1.232     raeburn  2455:             {class=>"LC_Box LC_400Box"})) if scalar(@links);
1.183     droeschl 2456:     }
1.201     droeschl 2457: 
                   2458:     # wrap the joined @categories in another <div> (column layout)
                   2459:     return $div->(join('', @categories), {class => "LC_columnSection"});
1.183     droeschl 2460: }
1.176     foxr     2461: 
1.224     bisitz   2462: ##############################################
                   2463: ##############################################
                   2464: 
                   2465: =pod
                   2466: 
                   2467: =item &start_funclist
                   2468: 
                   2469: Start list of available functions
                   2470: 
                   2471: Typically used to offer a simple list of available functions
                   2472: at top or bottom of page.
                   2473: All available functions/actions for the current page
                   2474: should be included in this list.
                   2475: 
                   2476: If the optional headline text is not provided, a default text will be used.
                   2477: 
                   2478: 
                   2479: Related routines:
                   2480: =over 4
                   2481: add_item_funclist
                   2482: end_funclist
                   2483: =back
                   2484: 
                   2485: 
                   2486: Inputs: (optional) headline text
                   2487: 
                   2488: Returns: HTML code with function list start
                   2489: 
                   2490: =cut
                   2491: 
                   2492: ##############################################
                   2493: ##############################################
                   2494: 
                   2495: sub start_funclist {
                   2496:     my($legendtext)=@_;
                   2497:     $legendtext=&mt('Functions') if !$legendtext;
1.244     droeschl 2498:     return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
1.224     bisitz   2499: }
                   2500: 
                   2501: 
                   2502: ##############################################
                   2503: ##############################################
                   2504: 
                   2505: =pod
                   2506: 
                   2507: =item &add_item_funclist
                   2508: 
                   2509: Adds an item to the list of available functions
                   2510: 
                   2511: Related routines:
                   2512: =over 4
                   2513: start_funclist
                   2514: end_funclist
                   2515: =back
                   2516: 
                   2517: Inputs: content item with text and link to function
                   2518: 
                   2519: Returns: HTML code with list item for funclist
                   2520: 
                   2521: =cut
                   2522: 
                   2523: ##############################################
                   2524: ##############################################
                   2525: 
                   2526: sub add_item_funclist {
                   2527:     my($content) = @_;
                   2528:     return '<li>'.$content.'</li>'."\n";
                   2529: }
                   2530: 
                   2531: =pod
                   2532: 
                   2533: =item &end_funclist
                   2534: 
                   2535: End list of available functions
                   2536: 
                   2537: Related routines:
                   2538: =over 4
                   2539: start_funclist
                   2540: add_item_funclist
                   2541: =back
                   2542: 
                   2543: Inputs: ./.
                   2544: 
                   2545: Returns: HTML code with function list end
                   2546: =cut
                   2547: 
                   2548: sub end_funclist {
1.246     bisitz   2549:     return "</ul>\n";
1.224     bisitz   2550: }
                   2551: 
1.261     droeschl 2552: =pod
                   2553: 
                   2554: =item funclist_from_array( \@array, {legend => 'text for legend'} )
                   2555: 
                   2556: Constructs a XHTML list from \@array with the first item being visually
                   2557: highlighted and set to the value of legend or 'Functions' if legend is
                   2558: empty. 
                   2559: 
                   2560: =over
                   2561: 
                   2562: =item \@array
                   2563: 
                   2564: A reference to the array containing text that will be wrapped in <li></li> tags.
                   2565: 
                   2566: =item { legend => 'text' }
                   2567: 
                   2568: A string that's used as visually highlighted first item. 'Functions' is used if
                   2569: it's value evaluates to false.
                   2570: 
                   2571: =back
                   2572:  
                   2573: returns: XHTML list as string. 
                   2574: 
                   2575: =back
                   2576: 
                   2577: =cut  
                   2578: 
                   2579: sub funclist_from_array {
                   2580:     my ($items, $args) = @_;
                   2581:     $args->{legend} ||= mt('Functions');
                   2582:     return list_from_array( [$args->{legend}, @$items], 
                   2583:                { listattr => {class => 'LC_funclist'} });
                   2584: }   
                   2585: 
1.1       stredwic 2586: 1;
1.23      matthew  2587: 
1.1       stredwic 2588: __END__

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>