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

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

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