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

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

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