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

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

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