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

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

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