Annotation of loncom/interface/loncommon.pm, revision 1.820

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.820   ! raeburn     4: # $Id: loncommon.pm,v 1.819 2009/05/16 18:06:41 tempelho Exp $
1.10      albertel    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.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.74      www       410:     var stdeditbrowser;
1.793     raeburn   411:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       412:         var url = '/adm/pickstudent?';
                    413:         var filter;
1.558     albertel  414: 	if (!ignorefilter) {
                    415: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    416: 	}
1.74      www       417:         if (filter != null) {
                    418:            if (filter != '') {
                    419:                url += 'filter='+filter+'&';
                    420: 	   }
                    421:         }
                    422:         url += 'form=' + formname + '&unameelement='+uname+
                    423:                                     '&udomelement='+udom;
1.111     www       424: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   425:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       426:         var title = 'Student_Browser';
1.74      www       427:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    428:         options += ',width=700,height=600';
                    429:         stdeditbrowser = open(url,title,options,'1');
                    430:         stdeditbrowser.focus();
                    431:     }
                    432: </script>
                    433: ENDSTDBRW
                    434: }
1.42      matthew   435: 
1.74      www       436: sub selectstudent_link {
1.793     raeburn   437:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    438:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  439:    if ($env{'request.course.id'}) {  
1.302     albertel  440:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    441: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    442: 					'/'.$env{'request.course.sec'})) {
1.111     www       443: 	   return '';
                    444:        }
1.793     raeburn   445:        if ($courseadvonly)  {
                    446:            $callargs .= ",'',1,1";
                    447:        }
                    448:        return '<span class="LC_nobreak">'.
                    449:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    450:               &mt('Select User').'</a></span>';
1.74      www       451:    }
1.258     albertel  452:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   453:        $callargs .= ",1"; 
                    454:        return '<span class="LC_nobreak">'.
                    455:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    456:               &mt('Select User').'</a></span>';
1.111     www       457:    }
                    458:    return '';
1.91      www       459: }
                    460: 
1.653     raeburn   461: sub authorbrowser_javascript {
                    462:     return <<"ENDAUTHORBRW";
1.776     bisitz    463: <script type="text/javascript" language="JavaScript">
1.653     raeburn   464: var stdeditbrowser;
                    465: 
                    466: function openauthorbrowser(formname,udom) {
                    467:     var url = '/adm/pickauthor?';
                    468:     url += 'form='+formname+'&roledom='+udom;
                    469:     var title = 'Author_Browser';
                    470:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    471:     options += ',width=700,height=600';
                    472:     stdeditbrowser = open(url,title,options,'1');
                    473:     stdeditbrowser.focus();
                    474: }
                    475: 
                    476: </script>
                    477: ENDAUTHORBRW
                    478: }
                    479: 
1.91      www       480: sub coursebrowser_javascript {
1.468     raeburn   481:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   482:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468     raeburn   483:    my $output = '
1.776     bisitz    484: <script type="text/javascript" language="JavaScript">
1.468     raeburn   485:     var stdeditbrowser;'."\n";
                    486:    $output .= <<"ENDSTDBRW";
1.377     raeburn   487:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       488:         var url = '/adm/pickcourse?';
1.468     raeburn   489:         var domainfilter = '';
                    490:         var formid = getFormIdByName(formname);
                    491:         if (formid > -1) {
                    492:             var domid = getIndexByName(formid,udom);
                    493:             if (domid > -1) {
                    494:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    495:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    496:                 }
                    497:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    498:                     domainfilter=document.forms[formid].elements[domid].value;
                    499:                 }
                    500:             }
1.91      www       501:         }
1.128     albertel  502:         if (domainfilter != null) {
                    503:            if (domainfilter != '') {
                    504:                url += 'domainfilter='+domainfilter+'&';
                    505: 	   }
                    506:         }
1.91      www       507:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  508: 	                            '&cdomelement='+udom+
                    509:                                     '&cnameelement='+desc;
1.468     raeburn   510:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   511:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   512:                 url += '&roleelement='+extra_element;
                    513:                 if (domainfilter == null || domainfilter == '') {
                    514:                     url += '&domainfilter='+extra_element;
                    515:                 }
1.234     raeburn   516:             }
1.468     raeburn   517:             else {
                    518:                 if (formname == 'portform') {
                    519:                     url += '&setroles='+extra_element;
1.800     raeburn   520:                 } else {
                    521:                     if (formname == 'rules') {
                    522:                         url += '&fixeddom='+extra_element; 
                    523:                     }
1.468     raeburn   524:                 }
                    525:             }     
1.230     raeburn   526:         }
1.293     raeburn   527:         if (multflag !=null && multflag != '') {
                    528:             url += '&multiple='+multflag;
                    529:         }
1.377     raeburn   530:         if (crstype == 'Course/Group') {
                    531:             if (formname == 'cu') {
                    532:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    533:                 if (crstype == "") {
                    534:                     alert("$crs_or_grp_alert");
                    535:                     return;
                    536:                 }
                    537:             }
                    538:         }
                    539:         if (crstype !=null && crstype != '') {
                    540:             url += '&type='+crstype;
                    541:         }
1.102     www       542:         var title = 'Course_Browser';
1.91      www       543:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    544:         options += ',width=700,height=600';
                    545:         stdeditbrowser = open(url,title,options,'1');
                    546:         stdeditbrowser.focus();
                    547:     }
1.468     raeburn   548: 
                    549:     function getFormIdByName(formname) {
                    550:         for (var i=0;i<document.forms.length;i++) {
                    551:             if (document.forms[i].name == formname) {
                    552:                 return i;
                    553:             }
                    554:         }
                    555:         return -1; 
                    556:     }
                    557: 
                    558:     function getIndexByName(formid,item) {
                    559:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    560:             if (document.forms[formid].elements[i].name == item) {
                    561:                 return i;
                    562:             }
                    563:         }
                    564:         return -1;
                    565:     }
1.91      www       566: ENDSTDBRW
1.468     raeburn   567:     if ($sec_element ne '') {
                    568:         $output .= &setsec_javascript($sec_element,$formname);
                    569:     }
                    570:     $output .= '
                    571: </script>';
                    572:     return $output;
                    573: }
                    574: 
                    575: sub setsec_javascript {
                    576:     my ($sec_element,$formname) = @_;
                    577:     my $setsections = qq|
                    578: function setSect(sectionlist) {
1.629     raeburn   579:     var sectionsArray = new Array();
                    580:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    581:         sectionsArray = sectionlist.split(",");
                    582:     }
1.468     raeburn   583:     var numSections = sectionsArray.length;
                    584:     document.$formname.$sec_element.length = 0;
                    585:     if (numSections == 0) {
                    586:         document.$formname.$sec_element.multiple=false;
                    587:         document.$formname.$sec_element.size=1;
                    588:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    589:     } else {
                    590:         if (numSections == 1) {
                    591:             document.$formname.$sec_element.multiple=false;
                    592:             document.$formname.$sec_element.size=1;
                    593:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    594:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    595:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    596:         } else {
                    597:             for (var i=0; i<numSections; i++) {
                    598:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    599:             }
                    600:             document.$formname.$sec_element.multiple=true
                    601:             if (numSections < 3) {
                    602:                 document.$formname.$sec_element.size=numSections;
                    603:             } else {
                    604:                 document.$formname.$sec_element.size=3;
                    605:             }
                    606:             document.$formname.$sec_element.options[0].selected = false
                    607:         }
                    608:     }
1.91      www       609: }
1.468     raeburn   610: |;
                    611:     return $setsections;
                    612: }
                    613: 
1.91      www       614: 
                    615: sub selectcourse_link {
1.377     raeburn   616:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.787     bisitz    617:    return '<span class="LC_nobreak">'
                    618:          ."<a href='"
                    619:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    620:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    621:          .'","'.$multflag.'","'.$selecttype.'");'
                    622:          ."'>".&mt('Select Course').'</a>'
                    623:          .'</span>';
1.74      www       624: }
1.42      matthew   625: 
1.653     raeburn   626: sub selectauthor_link {
                    627:    my ($form,$udom)=@_;
                    628:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    629:           &mt('Select Author').'</a>';
                    630: }
                    631: 
1.273     raeburn   632: sub check_uncheck_jscript {
                    633:     my $jscript = <<"ENDSCRT";
                    634: function checkAll(field) {
                    635:     if (field.length > 0) {
                    636:         for (i = 0; i < field.length; i++) {
                    637:             field[i].checked = true ;
                    638:         }
                    639:     } else {
                    640:         field.checked = true
                    641:     }
                    642: }
                    643:  
                    644: function uncheckAll(field) {
                    645:     if (field.length > 0) {
                    646:         for (i = 0; i < field.length; i++) {
                    647:             field[i].checked = false ;
1.543     albertel  648:         }
                    649:     } else {
1.273     raeburn   650:         field.checked = false ;
                    651:     }
                    652: }
                    653: ENDSCRT
                    654:     return $jscript;
                    655: }
                    656: 
1.656     www       657: sub select_timezone {
1.659     raeburn   658:    my ($name,$selected,$onchange,$includeempty)=@_;
                    659:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    660:    if ($includeempty) {
                    661:        $output .= '<option value=""';
                    662:        if (($selected eq '') || ($selected eq 'local')) {
                    663:            $output .= ' selected="selected" ';
                    664:        }
                    665:        $output .= '> </option>';
                    666:    }
1.657     raeburn   667:    my @timezones = DateTime::TimeZone->all_names;
                    668:    foreach my $tzone (@timezones) {
                    669:        $output.= '<option value="'.$tzone.'"';
                    670:        if ($tzone eq $selected) {
                    671:            $output.=' selected="selected"';
                    672:        }
                    673:        $output.=">$tzone</option>\n";
1.656     www       674:    }
                    675:    $output.="</select>";
                    676:    return $output;
                    677: }
1.273     raeburn   678: 
1.687     raeburn   679: sub select_datelocale {
                    680:     my ($name,$selected,$onchange,$includeempty)=@_;
                    681:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    682:     if ($includeempty) {
                    683:         $output .= '<option value=""';
                    684:         if ($selected eq '') {
                    685:             $output .= ' selected="selected" ';
                    686:         }
                    687:         $output .= '> </option>';
                    688:     }
                    689:     my (@possibles,%locale_names);
                    690:     my @locales = DateTime::Locale::Catalog::Locales;
                    691:     foreach my $locale (@locales) {
                    692:         if (ref($locale) eq 'HASH') {
                    693:             my $id = $locale->{'id'};
                    694:             if ($id ne '') {
                    695:                 my $en_terr = $locale->{'en_territory'};
                    696:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   697:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   698:                 if (grep(/^en$/,@languages) || !@languages) {
                    699:                     if ($en_terr ne '') {
                    700:                         $locale_names{$id} = '('.$en_terr.')';
                    701:                     } elsif ($native_terr ne '') {
                    702:                         $locale_names{$id} = $native_terr;
                    703:                     }
                    704:                 } else {
                    705:                     if ($native_terr ne '') {
                    706:                         $locale_names{$id} = $native_terr.' ';
                    707:                     } elsif ($en_terr ne '') {
                    708:                         $locale_names{$id} = '('.$en_terr.')';
                    709:                     }
                    710:                 }
                    711:                 push (@possibles,$id);
                    712:             }
                    713:         }
                    714:     }
                    715:     foreach my $item (sort(@possibles)) {
                    716:         $output.= '<option value="'.$item.'"';
                    717:         if ($item eq $selected) {
                    718:             $output.=' selected="selected"';
                    719:         }
                    720:         $output.=">$item";
                    721:         if ($locale_names{$item} ne '') {
                    722:             $output.="  $locale_names{$item}</option>\n";
                    723:         }
                    724:         $output.="</option>\n";
                    725:     }
                    726:     $output.="</select>";
                    727:     return $output;
                    728: }
                    729: 
1.792     raeburn   730: sub select_language {
                    731:     my ($name,$selected,$includeempty) = @_;
                    732:     my %langchoices;
                    733:     if ($includeempty) {
                    734:         %langchoices = ('' => 'No language preference');
                    735:     }
                    736:     foreach my $id (&languageids()) {
                    737:         my $code = &supportedlanguagecode($id);
                    738:         if ($code) {
                    739:             $langchoices{$code} = &plainlanguagedescription($id);
                    740:         }
                    741:     }
                    742:     return &select_form($selected,$name,%langchoices);
                    743: }
                    744: 
1.42      matthew   745: =pod
1.36      matthew   746: 
1.648     raeburn   747: =item * &linked_select_forms(...)
1.36      matthew   748: 
                    749: linked_select_forms returns a string containing a <script></script> block
                    750: and html for two <select> menus.  The select menus will be linked in that
                    751: changing the value of the first menu will result in new values being placed
                    752: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   753: order unless a defined order is provided.
1.36      matthew   754: 
                    755: linked_select_forms takes the following ordered inputs:
                    756: 
                    757: =over 4
                    758: 
1.112     bowersj2  759: =item * $formname, the name of the <form> tag
1.36      matthew   760: 
1.112     bowersj2  761: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   762: 
1.112     bowersj2  763: =item * $firstdefault, the default value for the first menu
1.36      matthew   764: 
1.112     bowersj2  765: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   766: 
1.112     bowersj2  767: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   768: 
1.112     bowersj2  769: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   770: 
1.609     raeburn   771: =item * $menuorder, the order of values in the first menu
                    772: 
1.41      ng        773: =back 
                    774: 
1.36      matthew   775: Below is an example of such a hash.  Only the 'text', 'default', and 
                    776: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    777: values for the first select menu.  The text that coincides with the 
1.41      ng        778: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   779: and text for the second menu are given in the hash pointed to by 
                    780: $menu{$choice1}->{'select2'}.  
                    781: 
1.112     bowersj2  782:  my %menu = ( A1 => { text =>"Choice A1" ,
                    783:                        default => "B3",
                    784:                        select2 => { 
                    785:                            B1 => "Choice B1",
                    786:                            B2 => "Choice B2",
                    787:                            B3 => "Choice B3",
                    788:                            B4 => "Choice B4"
1.609     raeburn   789:                            },
                    790:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  791:                    },
                    792:                A2 => { text =>"Choice A2" ,
                    793:                        default => "C2",
                    794:                        select2 => { 
                    795:                            C1 => "Choice C1",
                    796:                            C2 => "Choice C2",
                    797:                            C3 => "Choice C3"
1.609     raeburn   798:                            },
                    799:                        order => ['C2','C1','C3'],
1.112     bowersj2  800:                    },
                    801:                A3 => { text =>"Choice A3" ,
                    802:                        default => "D6",
                    803:                        select2 => { 
                    804:                            D1 => "Choice D1",
                    805:                            D2 => "Choice D2",
                    806:                            D3 => "Choice D3",
                    807:                            D4 => "Choice D4",
                    808:                            D5 => "Choice D5",
                    809:                            D6 => "Choice D6",
                    810:                            D7 => "Choice D7"
1.609     raeburn   811:                            },
                    812:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  813:                    }
                    814:                );
1.36      matthew   815: 
                    816: =cut
                    817: 
                    818: sub linked_select_forms {
                    819:     my ($formname,
                    820:         $middletext,
                    821:         $firstdefault,
                    822:         $firstselectname,
                    823:         $secondselectname, 
1.609     raeburn   824:         $hashref,
                    825:         $menuorder,
1.36      matthew   826:         ) = @_;
                    827:     my $second = "document.$formname.$secondselectname";
                    828:     my $first = "document.$formname.$firstselectname";
                    829:     # output the javascript to do the changing
                    830:     my $result = '';
1.776     bisitz    831:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.36      matthew   832:     $result.="var select2data = new Object();\n";
                    833:     $" = '","';
                    834:     my $debug = '';
                    835:     foreach my $s1 (sort(keys(%$hashref))) {
                    836:         $result.="select2data.d_$s1 = new Object();\n";        
                    837:         $result.="select2data.d_$s1.def = new String('".
                    838:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   839:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   840:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   841:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    842:             @s2values = @{$hashref->{$s1}->{'order'}};
                    843:         }
1.36      matthew   844:         $result.="\"@s2values\");\n";
                    845:         $result.="select2data.d_$s1.texts = new Array(";        
                    846:         my @s2texts;
                    847:         foreach my $value (@s2values) {
                    848:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    849:         }
                    850:         $result.="\"@s2texts\");\n";
                    851:     }
                    852:     $"=' ';
                    853:     $result.= <<"END";
                    854: 
                    855: function select1_changed() {
                    856:     // Determine new choice
                    857:     var newvalue = "d_" + $first.value;
                    858:     // update select2
                    859:     var values     = select2data[newvalue].values;
                    860:     var texts      = select2data[newvalue].texts;
                    861:     var select2def = select2data[newvalue].def;
                    862:     var i;
                    863:     // out with the old
                    864:     for (i = 0; i < $second.options.length; i++) {
                    865:         $second.options[i] = null;
                    866:     }
                    867:     // in with the nuclear
                    868:     for (i=0;i<values.length; i++) {
                    869:         $second.options[i] = new Option(values[i]);
1.143     matthew   870:         $second.options[i].value = values[i];
1.36      matthew   871:         $second.options[i].text = texts[i];
                    872:         if (values[i] == select2def) {
                    873:             $second.options[i].selected = true;
                    874:         }
                    875:     }
                    876: }
                    877: </script>
                    878: END
                    879:     # output the initial values for the selection lists
                    880:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   881:     my @order = sort(keys(%{$hashref}));
                    882:     if (ref($menuorder) eq 'ARRAY') {
                    883:         @order = @{$menuorder};
                    884:     }
                    885:     foreach my $value (@order) {
1.36      matthew   886:         $result.="    <option value=\"$value\" ";
1.253     albertel  887:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       888:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   889:     }
                    890:     $result .= "</select>\n";
                    891:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    892:     $result .= $middletext;
                    893:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    894:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   895:     
                    896:     my @secondorder = sort(keys(%select2));
                    897:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    898:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    899:     }
                    900:     foreach my $value (@secondorder) {
1.36      matthew   901:         $result.="    <option value=\"$value\" ";        
1.253     albertel  902:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       903:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   904:     }
                    905:     $result .= "</select>\n";
                    906:     #    return $debug;
                    907:     return $result;
                    908: }   #  end of sub linked_select_forms {
                    909: 
1.45      matthew   910: =pod
1.44      bowersj2  911: 
1.648     raeburn   912: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  913: 
1.112     bowersj2  914: Returns a string corresponding to an HTML link to the given help
                    915: $topic, where $topic corresponds to the name of a .tex file in
                    916: /home/httpd/html/adm/help/tex, with underscores replaced by
                    917: spaces. 
                    918: 
                    919: $text will optionally be linked to the same topic, allowing you to
                    920: link text in addition to the graphic. If you do not want to link
                    921: text, but wish to specify one of the later parameters, pass an
                    922: empty string. 
                    923: 
                    924: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    925: the link will not open a new window. If false, the link will open
                    926: a new window using Javascript. (Default is false.) 
                    927: 
                    928: $width and $height are optional numerical parameters that will
                    929: override the width and height of the popped up window, which may
                    930: be useful for certain help topics with big pictures included. 
1.44      bowersj2  931: 
                    932: =cut
                    933: 
                    934: sub help_open_topic {
1.48      bowersj2  935:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    936:     $text = "" if (not defined $text);
1.44      bowersj2  937:     $stayOnPage = 0 if (not defined $stayOnPage);
                    938:     $width = 350 if (not defined $width);
                    939:     $height = 400 if (not defined $height);
                    940:     my $filename = $topic;
                    941:     $filename =~ s/ /_/g;
                    942: 
1.48      bowersj2  943:     my $template = "";
                    944:     my $link;
1.572     banghart  945:     
1.159     www       946:     $topic=~s/\W/\_/g;
1.44      bowersj2  947: 
1.572     banghart  948:     if (!$stayOnPage) {
1.72      bowersj2  949: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart  950:     } else {
1.48      bowersj2  951: 	$link = "/adm/help/${filename}.hlp";
                    952:     }
                    953: 
                    954:     # Add the text
1.755     neumanie  955:     if ($text ne "") {	
1.763     bisitz    956: 	$template.='<span class="LC_help_open_topic">'
                    957:                   .'<a target="_top" href="'.$link.'">'
                    958:                   .$text.'</a>';
1.48      bowersj2  959:     }
                    960: 
1.763     bisitz    961:     # (Always) Add the graphic
1.179     matthew   962:     my $title = &mt('Online Help');
1.667     raeburn   963:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz    964:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                    965:               .'<img src="'.$helpicon.'" border="0"'
                    966:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller  967:               .' title="'.$title.'"' 
1.763     bisitz    968:               .' /></a>';
                    969:     if ($text ne "") {	
                    970:         $template.='</span>';
                    971:     }
1.44      bowersj2  972:     return $template;
                    973: 
1.106     bowersj2  974: }
                    975: 
                    976: # This is a quicky function for Latex cheatsheet editing, since it 
                    977: # appears in at least four places
                    978: sub helpLatexCheatsheet {
1.732     raeburn   979:     my ($topic,$text,$not_author) = @_;
                    980:     my $out;
1.106     bowersj2  981:     my $addOther = '';
1.732     raeburn   982:     if ($topic) {
1.763     bisitz    983: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                    984: 							       undef, undef, 600).
                    985: 								   '</span> ';
                    986:     }
                    987:     $out = '<span>' # Start cheatsheet
                    988: 	  .$addOther
                    989:           .'<span>'
                    990: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                    991: 					       undef,undef,600)
                    992: 	  .'</span> <span>'
                    993: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                    994: 					       undef,undef,600)
                    995: 	  .'</span>';
1.732     raeburn   996:     unless ($not_author) {
1.763     bisitz    997:         $out .= ' <span>'
                    998: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                    999: 	                                            undef,undef,600)
                   1000: 	       .'</span>';
1.732     raeburn  1001:     }
1.763     bisitz   1002:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1003:     return $out;
1.172     www      1004: }
                   1005: 
1.430     albertel 1006: sub general_help {
                   1007:     my $helptopic='Student_Intro';
                   1008:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1009: 	$helptopic='Authoring_Intro';
                   1010:     } elsif ($env{'request.role'}=~/^cc/) {
                   1011: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1012:     } elsif ($env{'request.role'}=~/^dc/) {
                   1013:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1014:     }
                   1015:     return $helptopic;
                   1016: }
                   1017: 
                   1018: sub update_help_link {
                   1019:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1020:     my $origurl = $ENV{'REQUEST_URI'};
                   1021:     $origurl=~s|^/~|/priv/|;
                   1022:     my $timestamp = time;
                   1023:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1024:         $$datum = &escape($$datum);
                   1025:     }
                   1026: 
                   1027:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1028:     my $output .= <<"ENDOUTPUT";
                   1029: <script type="text/javascript">
                   1030: banner_link = '$banner_link';
                   1031: </script>
                   1032: ENDOUTPUT
                   1033:     return $output;
                   1034: }
                   1035: 
                   1036: # now just updates the help link and generates a blue icon
1.193     raeburn  1037: sub help_open_menu {
1.430     albertel 1038:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1039: 	= @_;    
1.430     albertel 1040:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1041:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1042:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1043:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1044:         $stayOnPage=1;
1.430     albertel 1045:     }
                   1046:     my $output;
                   1047:     if ($component_help) {
                   1048: 	if (!$text) {
                   1049: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1050: 				       $width,$height);
                   1051: 	} else {
                   1052: 	    my $help_text;
                   1053: 	    $help_text=&unescape($topic);
                   1054: 	    $output='<table><tr><td>'.
                   1055: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1056: 				 $width,$height).'</td></tr></table>';
                   1057: 	}
                   1058:     }
                   1059:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1060:     return $output.$banner_link;
                   1061: }
                   1062: 
                   1063: sub top_nav_help {
                   1064:     my ($text) = @_;
1.436     albertel 1065:     $text = &mt($text);
1.572     banghart 1066:     my $stay_on_page = 
1.798     tempelho 1067: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1068:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1069: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1070:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1071: 
1.201     raeburn  1072:     my $title = &mt('Get help');
1.436     albertel 1073: 
                   1074:     return <<"END";
                   1075: $banner_link
                   1076:  <a href="$link" title="$title">$text</a>
                   1077: END
                   1078: }
                   1079: 
                   1080: sub help_menu_js {
                   1081:     my ($text) = @_;
                   1082: 
                   1083:     my $stayOnPage = 
1.798     tempelho 1084: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1085: 
                   1086:     my $width = 620;
                   1087:     my $height = 600;
1.430     albertel 1088:     my $helptopic=&general_help();
                   1089:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1090:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1091:     my $start_page =
                   1092:         &Apache::loncommon::start_page('Help Menu', undef,
                   1093: 				       {'frameset'    => 1,
                   1094: 					'js_ready'    => 1,
                   1095: 					'add_entries' => {
                   1096: 					    'border' => '0',
1.579     raeburn  1097: 					    'rows'   => "110,*",},});
1.331     albertel 1098:     my $end_page =
                   1099:         &Apache::loncommon::end_page({'frameset' => 1,
                   1100: 				      'js_ready' => 1,});
                   1101: 
1.436     albertel 1102:     my $template .= <<"ENDTEMPLATE";
                   1103: <script type="text/javascript">
1.253     albertel 1104: // <!-- BEGIN LON-CAPA Internal
                   1105: // <![CDATA[
1.430     albertel 1106: var banner_link = '';
1.243     raeburn  1107: function helpMenu(target) {
                   1108:     var caller = this;
                   1109:     if (target == 'open') {
                   1110:         var newWindow = null;
                   1111:         try {
1.262     albertel 1112:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1113:         }
                   1114:         catch(error) {
                   1115:             writeHelp(caller);
                   1116:             return;
                   1117:         }
                   1118:         if (newWindow) {
                   1119:             caller = newWindow;
                   1120:         }
1.193     raeburn  1121:     }
1.243     raeburn  1122:     writeHelp(caller);
                   1123:     return;
                   1124: }
                   1125: function writeHelp(caller) {
1.430     albertel 1126:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1127:     caller.document.close()
                   1128:     caller.focus()
1.193     raeburn  1129: }
1.253     albertel 1130: // ]]>
1.219     albertel 1131: // END LON-CAPA Internal -->
1.436     albertel 1132: </script>
1.193     raeburn  1133: ENDTEMPLATE
                   1134:     return $template;
                   1135: }
                   1136: 
1.172     www      1137: sub help_open_bug {
                   1138:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1139:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1140:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1141:     $text = "" if (not defined $text);
                   1142:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1143:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1144: 	$stayOnPage=1;
                   1145:     }
1.184     albertel 1146:     $width = 600 if (not defined $width);
                   1147:     $height = 600 if (not defined $height);
1.172     www      1148: 
                   1149:     $topic=~s/\W+/\+/g;
                   1150:     my $link='';
                   1151:     my $template='';
1.379     albertel 1152:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1153: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1154:     if (!$stayOnPage)
                   1155:     {
                   1156: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1157:     }
                   1158:     else
                   1159:     {
                   1160: 	$link = $url;
                   1161:     }
                   1162:     # Add the text
                   1163:     if ($text ne "")
                   1164:     {
                   1165: 	$template .= 
                   1166:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1167:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1168:     }
                   1169: 
                   1170:     # Add the graphic
1.179     matthew  1171:     my $title = &mt('Report a Bug');
1.215     albertel 1172:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1173:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1174:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1175: ENDTEMPLATE
                   1176:     if ($text ne '') { $template.='</td></tr></table>' };
                   1177:     return $template;
                   1178: 
                   1179: }
                   1180: 
                   1181: sub help_open_faq {
                   1182:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1183:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1184:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1185:     $text = "" if (not defined $text);
                   1186:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1187:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1188: 	$stayOnPage=1;
                   1189:     }
                   1190:     $width = 350 if (not defined $width);
                   1191:     $height = 400 if (not defined $height);
                   1192: 
                   1193:     $topic=~s/\W+/\+/g;
                   1194:     my $link='';
                   1195:     my $template='';
                   1196:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1197:     if (!$stayOnPage)
                   1198:     {
                   1199: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1200:     }
                   1201:     else
                   1202:     {
                   1203: 	$link = $url;
                   1204:     }
                   1205: 
                   1206:     # Add the text
                   1207:     if ($text ne "")
                   1208:     {
                   1209: 	$template .= 
1.173     www      1210:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1211:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1212:     }
                   1213: 
                   1214:     # Add the graphic
1.179     matthew  1215:     my $title = &mt('View the FAQ');
1.215     albertel 1216:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1217:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1218:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1219: ENDTEMPLATE
                   1220:     if ($text ne '') { $template.='</td></tr></table>' };
                   1221:     return $template;
                   1222: 
1.44      bowersj2 1223: }
1.37      matthew  1224: 
1.180     matthew  1225: ###############################################################
                   1226: ###############################################################
                   1227: 
1.45      matthew  1228: =pod
                   1229: 
1.648     raeburn  1230: =item * &change_content_javascript():
1.256     matthew  1231: 
                   1232: This and the next function allow you to create small sections of an
                   1233: otherwise static HTML page that you can update on the fly with
                   1234: Javascript, even in Netscape 4.
                   1235: 
                   1236: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1237: must be written to the HTML page once. It will prove the Javascript
                   1238: function "change(name, content)". Calling the change function with the
                   1239: name of the section 
                   1240: you want to update, matching the name passed to C<changable_area>, and
                   1241: the new content you want to put in there, will put the content into
                   1242: that area.
                   1243: 
                   1244: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1245: to contain room for the original contents. You need to "make space"
                   1246: for whatever changes you wish to make, and be B<sure> to check your
                   1247: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1248: it's adequate for updating a one-line status display, but little more.
                   1249: This script will set the space to 100% width, so you only need to
                   1250: worry about height in Netscape 4.
                   1251: 
                   1252: Modern browsers are much less limiting, and if you can commit to the
                   1253: user not using Netscape 4, this feature may be used freely with
                   1254: pretty much any HTML.
                   1255: 
                   1256: =cut
                   1257: 
                   1258: sub change_content_javascript {
                   1259:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1260:     if ($env{'browser.type'} eq 'netscape' &&
                   1261: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1262: 	return (<<NETSCAPE4);
                   1263: 	function change(name, content) {
                   1264: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1265: 	    doc.open();
                   1266: 	    doc.write(content);
                   1267: 	    doc.close();
                   1268: 	}
                   1269: NETSCAPE4
                   1270:     } else {
                   1271: 	# Otherwise, we need to use semi-standards-compliant code
                   1272: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1273: 	# is really scary, and every useful browser supports it
                   1274: 	return (<<DOMBASED);
                   1275: 	function change(name, content) {
                   1276: 	    element = document.getElementById(name);
                   1277: 	    element.innerHTML = content;
                   1278: 	}
                   1279: DOMBASED
                   1280:     }
                   1281: }
                   1282: 
                   1283: =pod
                   1284: 
1.648     raeburn  1285: =item * &changable_area($name,$origContent):
1.256     matthew  1286: 
                   1287: This provides a "changable area" that can be modified on the fly via
                   1288: the Javascript code provided in C<change_content_javascript>. $name is
                   1289: the name you will use to reference the area later; do not repeat the
                   1290: same name on a given HTML page more then once. $origContent is what
                   1291: the area will originally contain, which can be left blank.
                   1292: 
                   1293: =cut
                   1294: 
                   1295: sub changable_area {
                   1296:     my ($name, $origContent) = @_;
                   1297: 
1.258     albertel 1298:     if ($env{'browser.type'} eq 'netscape' &&
                   1299: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1300: 	# If this is netscape 4, we need to use the Layer tag
                   1301: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1302:     } else {
                   1303: 	return "<span id='$name'>$origContent</span>";
                   1304:     }
                   1305: }
                   1306: 
                   1307: =pod
                   1308: 
1.648     raeburn  1309: =item * &viewport_geometry_js 
1.590     raeburn  1310: 
                   1311: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1312: 
                   1313: =cut
                   1314: 
                   1315: 
                   1316: sub viewport_geometry_js { 
                   1317:     return <<"GEOMETRY";
                   1318: var Geometry = {};
                   1319: function init_geometry() {
                   1320:     if (Geometry.init) { return };
                   1321:     Geometry.init=1;
                   1322:     if (window.innerHeight) {
                   1323:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1324:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1325:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1326:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1327:     }
                   1328:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1329:         Geometry.getViewportHeight =
                   1330:             function() { return document.documentElement.clientHeight; };
                   1331:         Geometry.getViewportWidth =
                   1332:             function() { return document.documentElement.clientWidth; };
                   1333: 
                   1334:         Geometry.getHorizontalScroll =
                   1335:             function() { return document.documentElement.scrollLeft; };
                   1336:         Geometry.getVerticalScroll =
                   1337:             function() { return document.documentElement.scrollTop; };
                   1338:     }
                   1339:     else if (document.body.clientHeight) {
                   1340:         Geometry.getViewportHeight =
                   1341:             function() { return document.body.clientHeight; };
                   1342:         Geometry.getViewportWidth =
                   1343:             function() { return document.body.clientWidth; };
                   1344:         Geometry.getHorizontalScroll =
                   1345:             function() { return document.body.scrollLeft; };
                   1346:         Geometry.getVerticalScroll =
                   1347:             function() { return document.body.scrollTop; };
                   1348:     }
                   1349: }
                   1350: 
                   1351: GEOMETRY
                   1352: }
                   1353: 
                   1354: =pod
                   1355: 
1.648     raeburn  1356: =item * &viewport_size_js()
1.590     raeburn  1357: 
                   1358: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1359: 
                   1360: =cut
                   1361: 
                   1362: sub viewport_size_js {
                   1363:     my $geometry = &viewport_geometry_js();
                   1364:     return <<"DIMS";
                   1365: 
                   1366: $geometry
                   1367: 
                   1368: function getViewportDims(width,height) {
                   1369:     init_geometry();
                   1370:     width.value = Geometry.getViewportWidth();
                   1371:     height.value = Geometry.getViewportHeight();
                   1372:     return;
                   1373: }
                   1374: 
                   1375: DIMS
                   1376: }
                   1377: 
                   1378: =pod
                   1379: 
1.648     raeburn  1380: =item * &resize_textarea_js()
1.565     albertel 1381: 
                   1382: emits the needed javascript to resize a textarea to be as big as possible
                   1383: 
                   1384: creates a function resize_textrea that takes two IDs first should be
                   1385: the id of the element to resize, second should be the id of a div that
                   1386: surrounds everything that comes after the textarea, this routine needs
                   1387: to be attached to the <body> for the onload and onresize events.
                   1388: 
1.648     raeburn  1389: =back
1.565     albertel 1390: 
                   1391: =cut
                   1392: 
                   1393: sub resize_textarea_js {
1.590     raeburn  1394:     my $geometry = &viewport_geometry_js();
1.565     albertel 1395:     return <<"RESIZE";
                   1396:     <script type="text/javascript">
1.590     raeburn  1397: $geometry
1.565     albertel 1398: 
1.588     albertel 1399: function getX(element) {
                   1400:     var x = 0;
                   1401:     while (element) {
                   1402: 	x += element.offsetLeft;
                   1403: 	element = element.offsetParent;
                   1404:     }
                   1405:     return x;
                   1406: }
                   1407: function getY(element) {
                   1408:     var y = 0;
                   1409:     while (element) {
                   1410: 	y += element.offsetTop;
                   1411: 	element = element.offsetParent;
                   1412:     }
                   1413:     return y;
                   1414: }
                   1415: 
                   1416: 
1.565     albertel 1417: function resize_textarea(textarea_id,bottom_id) {
                   1418:     init_geometry();
                   1419:     var textarea        = document.getElementById(textarea_id);
                   1420:     //alert(textarea);
                   1421: 
1.588     albertel 1422:     var textarea_top    = getY(textarea);
1.565     albertel 1423:     var textarea_height = textarea.offsetHeight;
                   1424:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1425:     var bottom_top      = getY(bottom);
1.565     albertel 1426:     var bottom_height   = bottom.offsetHeight;
                   1427:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1428:     var fudge           = 23;
1.565     albertel 1429:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1430:     if (new_height < 300) {
                   1431: 	new_height = 300;
                   1432:     }
                   1433:     textarea.style.height=new_height+'px';
                   1434: }
                   1435: </script>
                   1436: RESIZE
                   1437: 
                   1438: }
                   1439: 
                   1440: =pod
                   1441: 
1.256     matthew  1442: =head1 Excel and CSV file utility routines
                   1443: 
                   1444: =over 4
                   1445: 
                   1446: =cut
                   1447: 
                   1448: ###############################################################
                   1449: ###############################################################
                   1450: 
                   1451: =pod
                   1452: 
1.648     raeburn  1453: =item * &csv_translate($text) 
1.37      matthew  1454: 
1.185     www      1455: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1456: format.
                   1457: 
                   1458: =cut
                   1459: 
1.180     matthew  1460: ###############################################################
                   1461: ###############################################################
1.37      matthew  1462: sub csv_translate {
                   1463:     my $text = shift;
                   1464:     $text =~ s/\"/\"\"/g;
1.209     albertel 1465:     $text =~ s/\n/ /g;
1.37      matthew  1466:     return $text;
                   1467: }
1.180     matthew  1468: 
                   1469: ###############################################################
                   1470: ###############################################################
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &define_excel_formats()
1.180     matthew  1475: 
                   1476: Define some commonly used Excel cell formats.
                   1477: 
                   1478: Currently supported formats:
                   1479: 
                   1480: =over 4
                   1481: 
                   1482: =item header
                   1483: 
                   1484: =item bold
                   1485: 
                   1486: =item h1
                   1487: 
                   1488: =item h2
                   1489: 
                   1490: =item h3
                   1491: 
1.256     matthew  1492: =item h4
                   1493: 
                   1494: =item i
                   1495: 
1.180     matthew  1496: =item date
                   1497: 
                   1498: =back
                   1499: 
                   1500: Inputs: $workbook
                   1501: 
                   1502: Returns: $format, a hash reference.
                   1503: 
                   1504: =cut
                   1505: 
                   1506: ###############################################################
                   1507: ###############################################################
                   1508: sub define_excel_formats {
                   1509:     my ($workbook) = @_;
                   1510:     my $format;
                   1511:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1512:                                                 bottom    => 1,
                   1513:                                                 align     => 'center');
                   1514:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1515:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1516:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1517:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1518:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1519:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1520:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1521:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1522:     return $format;
                   1523: }
                   1524: 
                   1525: ###############################################################
                   1526: ###############################################################
1.113     bowersj2 1527: 
                   1528: =pod
                   1529: 
1.648     raeburn  1530: =item * &create_workbook()
1.255     matthew  1531: 
                   1532: Create an Excel worksheet.  If it fails, output message on the
                   1533: request object and return undefs.
                   1534: 
                   1535: Inputs: Apache request object
                   1536: 
                   1537: Returns (undef) on failure, 
                   1538:     Excel worksheet object, scalar with filename, and formats 
                   1539:     from &Apache::loncommon::define_excel_formats on success
                   1540: 
                   1541: =cut
                   1542: 
                   1543: ###############################################################
                   1544: ###############################################################
                   1545: sub create_workbook {
                   1546:     my ($r) = @_;
                   1547:         #
                   1548:     # Create the excel spreadsheet
                   1549:     my $filename = '/prtspool/'.
1.258     albertel 1550:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1551:         time.'_'.rand(1000000000).'.xls';
                   1552:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1553:     if (! defined($workbook)) {
                   1554:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1555:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1556:                             "This error has been logged.  ".
                   1557:                             "Please alert your LON-CAPA administrator").
                   1558:                   '</p>');
                   1559:         return (undef);
                   1560:     }
                   1561:     #
                   1562:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1563:     #
                   1564:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1565:     return ($workbook,$filename,$format);
                   1566: }
                   1567: 
                   1568: ###############################################################
                   1569: ###############################################################
                   1570: 
                   1571: =pod
                   1572: 
1.648     raeburn  1573: =item * &create_text_file()
1.113     bowersj2 1574: 
1.542     raeburn  1575: Create a file to write to and eventually make available to the user.
1.256     matthew  1576: If file creation fails, outputs an error message on the request object and 
                   1577: return undefs.
1.113     bowersj2 1578: 
1.256     matthew  1579: Inputs: Apache request object, and file suffix
1.113     bowersj2 1580: 
1.256     matthew  1581: Returns (undef) on failure, 
                   1582:     Filehandle and filename on success.
1.113     bowersj2 1583: 
                   1584: =cut
                   1585: 
1.256     matthew  1586: ###############################################################
                   1587: ###############################################################
                   1588: sub create_text_file {
                   1589:     my ($r,$suffix) = @_;
                   1590:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1591:     my $fh;
                   1592:     my $filename = '/prtspool/'.
1.258     albertel 1593:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1594:         time.'_'.rand(1000000000).'.'.$suffix;
                   1595:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1596:     if (! defined($fh)) {
                   1597:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1598:         $r->print(&mt('Problems occurred in creating the output file. '
                   1599:                      .'This error has been logged. '
                   1600:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1601:     }
1.256     matthew  1602:     return ($fh,$filename)
1.113     bowersj2 1603: }
                   1604: 
                   1605: 
1.256     matthew  1606: =pod 
1.113     bowersj2 1607: 
                   1608: =back
                   1609: 
                   1610: =cut
1.37      matthew  1611: 
                   1612: ###############################################################
1.33      matthew  1613: ##        Home server <option> list generating code          ##
                   1614: ###############################################################
1.35      matthew  1615: 
1.169     www      1616: # ------------------------------------------
                   1617: 
                   1618: sub domain_select {
                   1619:     my ($name,$value,$multiple)=@_;
                   1620:     my %domains=map { 
1.514     albertel 1621: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1622:     } &Apache::lonnet::all_domains();
1.169     www      1623:     if ($multiple) {
                   1624: 	$domains{''}=&mt('Any domain');
1.550     albertel 1625: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1626: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1627:     } else {
1.550     albertel 1628: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1629: 	return &select_form($name,$value,%domains);
                   1630:     }
                   1631: }
                   1632: 
1.282     albertel 1633: #-------------------------------------------
                   1634: 
                   1635: =pod
                   1636: 
1.519     raeburn  1637: =head1 Routines for form select boxes
                   1638: 
                   1639: =over 4
                   1640: 
1.648     raeburn  1641: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1642: 
                   1643: Returns a string containing a <select> element int multiple mode
                   1644: 
                   1645: 
                   1646: Args:
                   1647:   $name - name of the <select> element
1.506     raeburn  1648:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1649:   $size - number of rows long the select element is
1.283     albertel 1650:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1651:           (shown text should already have been &mt())
1.506     raeburn  1652:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1653: 
1.282     albertel 1654: =cut
                   1655: 
                   1656: #-------------------------------------------
1.169     www      1657: sub multiple_select_form {
1.284     albertel 1658:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1659:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1660:     my $output='';
1.191     matthew  1661:     if (! defined($size)) {
                   1662:         $size = 4;
1.283     albertel 1663:         if (scalar(keys(%$hash))<4) {
                   1664:             $size = scalar(keys(%$hash));
1.191     matthew  1665:         }
                   1666:     }
1.734     bisitz   1667:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1668:     my @order;
1.506     raeburn  1669:     if (ref($order) eq 'ARRAY')  {
                   1670:         @order = @{$order};
                   1671:     } else {
                   1672:         @order = sort(keys(%$hash));
1.501     banghart 1673:     }
                   1674:     if (exists($$hash{'select_form_order'})) {
                   1675:         @order = @{$$hash{'select_form_order'}};
                   1676:     }
                   1677:         
1.284     albertel 1678:     foreach my $key (@order) {
1.356     albertel 1679:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1680:         $output.='selected="selected" ' if ($selected{$key});
                   1681:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1682:     }
                   1683:     $output.="</select>\n";
                   1684:     return $output;
                   1685: }
                   1686: 
1.88      www      1687: #-------------------------------------------
                   1688: 
                   1689: =pod
                   1690: 
1.648     raeburn  1691: =item * &select_form($defdom,$name,%hash)
1.88      www      1692: 
                   1693: Returns a string containing a <select name='$name' size='1'> form to 
                   1694: allow a user to select options from a hash option_name => displayed text.  
                   1695: See lonrights.pm for an example invocation and use.
                   1696: 
                   1697: =cut
                   1698: 
                   1699: #-------------------------------------------
                   1700: sub select_form {
                   1701:     my ($def,$name,%hash) = @_;
                   1702:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1703:     my @keys;
                   1704:     if (exists($hash{'select_form_order'})) {
                   1705: 	@keys=@{$hash{'select_form_order'}};
                   1706:     } else {
                   1707: 	@keys=sort(keys(%hash));
                   1708:     }
1.356     albertel 1709:     foreach my $key (@keys) {
                   1710:         $selectform.=
                   1711: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1712:             ($key eq $def ? 'selected="selected" ' : '').
                   1713:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1714:     }
                   1715:     $selectform.="</select>";
                   1716:     return $selectform;
                   1717: }
                   1718: 
1.475     www      1719: # For display filters
                   1720: 
                   1721: sub display_filter {
                   1722:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1723:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1724:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1725: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1726: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1727: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1728:            &mt('Filter [_1]',
1.477     www      1729: 	   &select_form($env{'form.displayfilter'},
                   1730: 			'displayfilter',
                   1731: 			('currentfolder' => 'Current folder/page',
                   1732: 			 'containing' => 'Containing phrase',
                   1733: 			 'none' => 'None'))).
1.714     bisitz   1734: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1735: }
                   1736: 
1.167     www      1737: sub gradeleveldescription {
                   1738:     my $gradelevel=shift;
                   1739:     my %gradelevels=(0 => 'Not specified',
                   1740: 		     1 => 'Grade 1',
                   1741: 		     2 => 'Grade 2',
                   1742: 		     3 => 'Grade 3',
                   1743: 		     4 => 'Grade 4',
                   1744: 		     5 => 'Grade 5',
                   1745: 		     6 => 'Grade 6',
                   1746: 		     7 => 'Grade 7',
                   1747: 		     8 => 'Grade 8',
                   1748: 		     9 => 'Grade 9',
                   1749: 		     10 => 'Grade 10',
                   1750: 		     11 => 'Grade 11',
                   1751: 		     12 => 'Grade 12',
                   1752: 		     13 => 'Grade 13',
                   1753: 		     14 => '100 Level',
                   1754: 		     15 => '200 Level',
                   1755: 		     16 => '300 Level',
                   1756: 		     17 => '400 Level',
                   1757: 		     18 => 'Graduate Level');
                   1758:     return &mt($gradelevels{$gradelevel});
                   1759: }
                   1760: 
1.163     www      1761: sub select_level_form {
                   1762:     my ($deflevel,$name)=@_;
                   1763:     unless ($deflevel) { $deflevel=0; }
1.167     www      1764:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1765:     for (my $i=0; $i<=18; $i++) {
                   1766:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1767:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1768:                 ">".&gradeleveldescription($i)."</option>\n";
                   1769:     }
                   1770:     $selectform.="</select>";
                   1771:     return $selectform;
1.163     www      1772: }
1.167     www      1773: 
1.35      matthew  1774: #-------------------------------------------
                   1775: 
1.45      matthew  1776: =pod
                   1777: 
1.743     raeburn  1778: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35      matthew  1779: 
                   1780: Returns a string containing a <select name='$name' size='1'> form to 
                   1781: allow a user to select the domain to preform an operation in.  
                   1782: See loncreateuser.pm for an example invocation and use.
                   1783: 
1.90      www      1784: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1785: selected");
                   1786: 
1.743     raeburn  1787: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1788: 
                   1789: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
1.563     raeburn  1790: 
1.35      matthew  1791: =cut
                   1792: 
                   1793: #-------------------------------------------
1.34      matthew  1794: sub select_dom_form {
1.743     raeburn  1795:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
                   1796:     my $onchange;
                   1797:     if ($autosubmit) {
                   1798:         $onchange = ' onchange="this.form.submit()"';
                   1799:     }
1.550     albertel 1800:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1801:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1802:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1803:     foreach my $dom (@domains) {
                   1804:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1805:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1806:         if ($showdomdesc) {
                   1807:             if ($dom ne '') {
                   1808:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1809:                 if ($domdesc ne '') {
                   1810:                     $selectdomain .= ' ('.$domdesc.')';
                   1811:                 }
                   1812:             } 
                   1813:         }
                   1814:         $selectdomain .= "</option>\n";
1.34      matthew  1815:     }
                   1816:     $selectdomain.="</select>";
                   1817:     return $selectdomain;
                   1818: }
                   1819: 
1.35      matthew  1820: #-------------------------------------------
                   1821: 
1.45      matthew  1822: =pod
                   1823: 
1.648     raeburn  1824: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1825: 
1.586     raeburn  1826: input: 4 arguments (two required, two optional) - 
                   1827:     $domain - domain of new user
                   1828:     $name - name of form element
                   1829:     $default - Value of 'default' causes a default item to be first 
                   1830:                             option, and selected by default. 
                   1831:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1832:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1833: output: returns 2 items: 
1.586     raeburn  1834: (a) form element which contains either:
                   1835:    (i) <select name="$name">
                   1836:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1837:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1838:        </select>
                   1839:        form item if there are multiple library servers in $domain, or
                   1840:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1841:        if there is only one library server in $domain.
                   1842: 
                   1843: (b) number of library servers found.
                   1844: 
                   1845: See loncreateuser.pm for example of use.
1.35      matthew  1846: 
                   1847: =cut
                   1848: 
                   1849: #-------------------------------------------
1.586     raeburn  1850: sub home_server_form_item {
                   1851:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1852:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1853:     my $result;
                   1854:     my $numlib = keys(%servers);
                   1855:     if ($numlib > 1) {
                   1856:         $result .= '<select name="'.$name.'" />'."\n";
                   1857:         if ($default) {
1.804     bisitz   1858:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1859:                        '</option>'."\n";
                   1860:         }
                   1861:         foreach my $hostid (sort(keys(%servers))) {
                   1862:             $result.= '<option value="'.$hostid.'">'.
                   1863: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1864:         }
                   1865:         $result .= '</select>'."\n";
                   1866:     } elsif ($numlib == 1) {
                   1867:         my $hostid;
                   1868:         foreach my $item (keys(%servers)) {
                   1869:             $hostid = $item;
                   1870:         }
                   1871:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1872:                    $hostid.'" />';
                   1873:                    if (!$hide) {
                   1874:                        $result .= $hostid.' '.$servers{$hostid};
                   1875:                    }
                   1876:                    $result .= "\n";
                   1877:     } elsif ($default) {
                   1878:         $result .= '<input type="hidden" name="'.$name.
                   1879:                    '" value="default" />';
                   1880:                    if (!$hide) {
                   1881:                        $result .= &mt('default');
                   1882:                    }
                   1883:                    $result .= "\n";
1.33      matthew  1884:     }
1.586     raeburn  1885:     return ($result,$numlib);
1.33      matthew  1886: }
1.112     bowersj2 1887: 
                   1888: =pod
                   1889: 
1.534     albertel 1890: =back 
                   1891: 
1.112     bowersj2 1892: =cut
1.87      matthew  1893: 
                   1894: ###############################################################
1.112     bowersj2 1895: ##                  Decoding User Agent                      ##
1.87      matthew  1896: ###############################################################
                   1897: 
                   1898: =pod
                   1899: 
1.112     bowersj2 1900: =head1 Decoding the User Agent
                   1901: 
                   1902: =over 4
                   1903: 
                   1904: =item * &decode_user_agent()
1.87      matthew  1905: 
                   1906: Inputs: $r
                   1907: 
                   1908: Outputs:
                   1909: 
                   1910: =over 4
                   1911: 
1.112     bowersj2 1912: =item * $httpbrowser
1.87      matthew  1913: 
1.112     bowersj2 1914: =item * $clientbrowser
1.87      matthew  1915: 
1.112     bowersj2 1916: =item * $clientversion
1.87      matthew  1917: 
1.112     bowersj2 1918: =item * $clientmathml
1.87      matthew  1919: 
1.112     bowersj2 1920: =item * $clientunicode
1.87      matthew  1921: 
1.112     bowersj2 1922: =item * $clientos
1.87      matthew  1923: 
                   1924: =back
                   1925: 
1.157     matthew  1926: =back 
                   1927: 
1.87      matthew  1928: =cut
                   1929: 
                   1930: ###############################################################
                   1931: ###############################################################
                   1932: sub decode_user_agent {
1.247     albertel 1933:     my ($r)=@_;
1.87      matthew  1934:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1935:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1936:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1937:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1938:     my $clientbrowser='unknown';
                   1939:     my $clientversion='0';
                   1940:     my $clientmathml='';
                   1941:     my $clientunicode='0';
                   1942:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1943:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1944: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1945: 	    $clientbrowser=$bname;
                   1946:             $httpbrowser=~/$vreg/i;
                   1947: 	    $clientversion=$1;
                   1948:             $clientmathml=($clientversion>=$minv);
                   1949:             $clientunicode=($clientversion>=$univ);
                   1950: 	}
                   1951:     }
                   1952:     my $clientos='unknown';
                   1953:     if (($httpbrowser=~/linux/i) ||
                   1954:         ($httpbrowser=~/unix/i) ||
                   1955:         ($httpbrowser=~/ux/i) ||
                   1956:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1957:     if (($httpbrowser=~/vax/i) ||
                   1958:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1959:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1960:     if (($httpbrowser=~/mac/i) ||
                   1961:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1962:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1963:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1964:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1965:             $clientunicode,$clientos,);
                   1966: }
                   1967: 
1.32      matthew  1968: ###############################################################
                   1969: ##    Authentication changing form generation subroutines    ##
                   1970: ###############################################################
                   1971: ##
                   1972: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1973: ## hash, and have reasonable default values.
                   1974: ##
                   1975: ##    formname = the name given in the <form> tag.
1.35      matthew  1976: #-------------------------------------------
                   1977: 
1.45      matthew  1978: =pod
                   1979: 
1.112     bowersj2 1980: =head1 Authentication Routines
                   1981: 
                   1982: =over 4
                   1983: 
1.648     raeburn  1984: =item * &authform_xxxxxx()
1.35      matthew  1985: 
                   1986: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1987: handle some of the conveniences required for authentication forms.  
                   1988: This is not an optimal method, but it works.  
                   1989: 
                   1990: =over 4
                   1991: 
1.112     bowersj2 1992: =item * authform_header
1.35      matthew  1993: 
1.112     bowersj2 1994: =item * authform_authorwarning
1.35      matthew  1995: 
1.112     bowersj2 1996: =item * authform_nochange
1.35      matthew  1997: 
1.112     bowersj2 1998: =item * authform_kerberos
1.35      matthew  1999: 
1.112     bowersj2 2000: =item * authform_internal
1.35      matthew  2001: 
1.112     bowersj2 2002: =item * authform_filesystem
1.35      matthew  2003: 
                   2004: =back
                   2005: 
1.648     raeburn  2006: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2007: 
1.35      matthew  2008: =cut
                   2009: 
                   2010: #-------------------------------------------
1.32      matthew  2011: sub authform_header{  
                   2012:     my %in = (
                   2013:         formname => 'cu',
1.80      albertel 2014:         kerb_def_dom => '',
1.32      matthew  2015:         @_,
                   2016:     );
                   2017:     $in{'formname'} = 'document.' . $in{'formname'};
                   2018:     my $result='';
1.80      albertel 2019: 
                   2020: #---------------------------------------------- Code for upper case translation
                   2021:     my $Javascript_toUpperCase;
                   2022:     unless ($in{kerb_def_dom}) {
                   2023:         $Javascript_toUpperCase =<<"END";
                   2024:         switch (choice) {
                   2025:            case 'krb': currentform.elements[choicearg].value =
                   2026:                currentform.elements[choicearg].value.toUpperCase();
                   2027:                break;
                   2028:            default:
                   2029:         }
                   2030: END
                   2031:     } else {
                   2032:         $Javascript_toUpperCase = "";
                   2033:     }
                   2034: 
1.165     raeburn  2035:     my $radioval = "'nochange'";
1.591     raeburn  2036:     if (defined($in{'curr_authtype'})) {
                   2037:         if ($in{'curr_authtype'} ne '') {
                   2038:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2039:         }
1.174     matthew  2040:     }
1.165     raeburn  2041:     my $argfield = 'null';
1.591     raeburn  2042:     if (defined($in{'mode'})) {
1.165     raeburn  2043:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2044:             if (defined($in{'curr_autharg'})) {
                   2045:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2046:                     $argfield = "'$in{'curr_autharg'}'";
                   2047:                 }
                   2048:             }
                   2049:         }
                   2050:     }
                   2051: 
1.32      matthew  2052:     $result.=<<"END";
                   2053: var current = new Object();
1.165     raeburn  2054: current.radiovalue = $radioval;
                   2055: current.argfield = $argfield;
1.32      matthew  2056: 
                   2057: function changed_radio(choice,currentform) {
                   2058:     var choicearg = choice + 'arg';
                   2059:     // If a radio button in changed, we need to change the argfield
                   2060:     if (current.radiovalue != choice) {
                   2061:         current.radiovalue = choice;
                   2062:         if (current.argfield != null) {
                   2063:             currentform.elements[current.argfield].value = '';
                   2064:         }
                   2065:         if (choice == 'nochange') {
                   2066:             current.argfield = null;
                   2067:         } else {
                   2068:             current.argfield = choicearg;
                   2069:             switch(choice) {
                   2070:                 case 'krb': 
                   2071:                     currentform.elements[current.argfield].value = 
                   2072:                         "$in{'kerb_def_dom'}";
                   2073:                 break;
                   2074:               default:
                   2075:                 break;
                   2076:             }
                   2077:         }
                   2078:     }
                   2079:     return;
                   2080: }
1.22      www      2081: 
1.32      matthew  2082: function changed_text(choice,currentform) {
                   2083:     var choicearg = choice + 'arg';
                   2084:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2085:         $Javascript_toUpperCase
1.32      matthew  2086:         // clear old field
                   2087:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2088:             currentform.elements[current.argfield].value = '';
                   2089:         }
                   2090:         current.argfield = choicearg;
                   2091:     }
                   2092:     set_auth_radio_buttons(choice,currentform);
                   2093:     return;
1.20      www      2094: }
1.32      matthew  2095: 
                   2096: function set_auth_radio_buttons(newvalue,currentform) {
                   2097:     var i=0;
                   2098:     while (i < currentform.login.length) {
                   2099:         if (currentform.login[i].value == newvalue) { break; }
                   2100:         i++;
                   2101:     }
                   2102:     if (i == currentform.login.length) {
                   2103:         return;
                   2104:     }
                   2105:     current.radiovalue = newvalue;
                   2106:     currentform.login[i].checked = true;
                   2107:     return;
                   2108: }
                   2109: END
                   2110:     return $result;
                   2111: }
                   2112: 
                   2113: sub authform_authorwarning{
                   2114:     my $result='';
1.144     matthew  2115:     $result='<i>'.
                   2116:         &mt('As a general rule, only authors or co-authors should be '.
                   2117:             'filesystem authenticated '.
                   2118:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2119:     return $result;
                   2120: }
                   2121: 
                   2122: sub authform_nochange{  
                   2123:     my %in = (
                   2124:               formname => 'document.cu',
                   2125:               kerb_def_dom => 'MSU.EDU',
                   2126:               @_,
                   2127:           );
1.586     raeburn  2128:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2129:     my $result;
                   2130:     if (keys(%can_assign) == 0) {
                   2131:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2132:     } else {
                   2133:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2134:                   '<input type="radio" name="login" value="nochange" '.
                   2135:                   'checked="checked" onclick="'.
1.281     albertel 2136:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2137: 	    '</label>';
1.586     raeburn  2138:     }
1.32      matthew  2139:     return $result;
                   2140: }
                   2141: 
1.591     raeburn  2142: sub authform_kerberos {
1.32      matthew  2143:     my %in = (
                   2144:               formname => 'document.cu',
                   2145:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2146:               kerb_def_auth => 'krb4',
1.32      matthew  2147:               @_,
                   2148:               );
1.586     raeburn  2149:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2150:         $autharg,$jscall);
                   2151:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2152:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2153:        $check5 = ' checked="checked"';
1.80      albertel 2154:     } else {
1.772     bisitz   2155:        $check4 = ' checked="checked"';
1.80      albertel 2156:     }
1.165     raeburn  2157:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2158:     if (defined($in{'curr_authtype'})) {
                   2159:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2160:             $krbcheck = ' checked="checked"';
1.623     raeburn  2161:             if (defined($in{'mode'})) {
                   2162:                 if ($in{'mode'} eq 'modifyuser') {
                   2163:                     $krbcheck = '';
                   2164:                 }
                   2165:             }
1.591     raeburn  2166:             if (defined($in{'curr_kerb_ver'})) {
                   2167:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2168:                     $check5 = ' checked="checked"';
1.591     raeburn  2169:                     $check4 = '';
                   2170:                 } else {
1.772     bisitz   2171:                     $check4 = ' checked="checked"';
1.591     raeburn  2172:                     $check5 = '';
                   2173:                 }
1.586     raeburn  2174:             }
1.591     raeburn  2175:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2176:                 $krbarg = $in{'curr_autharg'};
                   2177:             }
1.586     raeburn  2178:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2179:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2180:                     $result = 
                   2181:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2182:         $in{'curr_autharg'},$krbver);
                   2183:                 } else {
                   2184:                     $result =
                   2185:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2186:                 }
                   2187:                 return $result; 
                   2188:             }
                   2189:         }
                   2190:     } else {
                   2191:         if ($authnum == 1) {
1.784     bisitz   2192:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2193:         }
                   2194:     }
1.586     raeburn  2195:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2196:         return;
1.587     raeburn  2197:     } elsif ($authtype eq '') {
1.591     raeburn  2198:         if (defined($in{'mode'})) {
1.587     raeburn  2199:             if ($in{'mode'} eq 'modifycourse') {
                   2200:                 if ($authnum == 1) {
1.784     bisitz   2201:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2202:                 }
                   2203:             }
                   2204:         }
1.586     raeburn  2205:     }
                   2206:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2207:     if ($authtype eq '') {
                   2208:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2209:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2210:                     $krbcheck.' />';
                   2211:     }
                   2212:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2213:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2214:          $in{'curr_authtype'} eq 'krb5') ||
                   2215:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2216:          $in{'curr_authtype'} eq 'krb4')) {
                   2217:         $result .= &mt
1.144     matthew  2218:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2219:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2220:          '<label>'.$authtype,
1.281     albertel 2221:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2222:              'value="'.$krbarg.'" '.
1.144     matthew  2223:              'onchange="'.$jscall.'" />',
1.281     albertel 2224:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2225:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2226: 	 '</label>');
1.586     raeburn  2227:     } elsif ($can_assign{'krb4'}) {
                   2228:         $result .= &mt
                   2229:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2230:          '[_3] Version 4 [_4]',
                   2231:          '<label>'.$authtype,
                   2232:          '</label><input type="text" size="10" name="krbarg" '.
                   2233:              'value="'.$krbarg.'" '.
                   2234:              'onchange="'.$jscall.'" />',
                   2235:          '<label><input type="hidden" name="krbver" value="4" />',
                   2236:          '</label>');
                   2237:     } elsif ($can_assign{'krb5'}) {
                   2238:         $result .= &mt
                   2239:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2240:          '[_3] Version 5 [_4]',
                   2241:          '<label>'.$authtype,
                   2242:          '</label><input type="text" size="10" name="krbarg" '.
                   2243:              'value="'.$krbarg.'" '.
                   2244:              'onchange="'.$jscall.'" />',
                   2245:          '<label><input type="hidden" name="krbver" value="5" />',
                   2246:          '</label>');
                   2247:     }
1.32      matthew  2248:     return $result;
                   2249: }
                   2250: 
                   2251: sub authform_internal{  
1.586     raeburn  2252:     my %in = (
1.32      matthew  2253:                 formname => 'document.cu',
                   2254:                 kerb_def_dom => 'MSU.EDU',
                   2255:                 @_,
                   2256:                 );
1.586     raeburn  2257:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2258:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2259:     if (defined($in{'curr_authtype'})) {
                   2260:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2261:             if ($can_assign{'int'}) {
1.772     bisitz   2262:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2263:                 if (defined($in{'mode'})) {
                   2264:                     if ($in{'mode'} eq 'modifyuser') {
                   2265:                         $intcheck = '';
                   2266:                     }
                   2267:                 }
1.591     raeburn  2268:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2269:                     $intarg = $in{'curr_autharg'};
                   2270:                 }
                   2271:             } else {
                   2272:                 $result = &mt('Currently internally authenticated.');
                   2273:                 return $result;
1.165     raeburn  2274:             }
                   2275:         }
1.586     raeburn  2276:     } else {
                   2277:         if ($authnum == 1) {
1.784     bisitz   2278:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2279:         }
                   2280:     }
                   2281:     if (!$can_assign{'int'}) {
                   2282:         return;
1.587     raeburn  2283:     } elsif ($authtype eq '') {
1.591     raeburn  2284:         if (defined($in{'mode'})) {
1.587     raeburn  2285:             if ($in{'mode'} eq 'modifycourse') {
                   2286:                 if ($authnum == 1) {
1.784     bisitz   2287:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2288:                 }
                   2289:             }
                   2290:         }
1.165     raeburn  2291:     }
1.586     raeburn  2292:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2293:     if ($authtype eq '') {
                   2294:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2295:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2296:     }
1.605     bisitz   2297:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2298:                $intarg.'" onchange="'.$jscall.'" />';
                   2299:     $result = &mt
1.144     matthew  2300:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2301:          '<label>'.$authtype,'</label>'.$autharg);
1.620     www      2302:     $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2303:     return $result;
                   2304: }
                   2305: 
                   2306: sub authform_local{  
                   2307:     my %in = (
                   2308:               formname => 'document.cu',
                   2309:               kerb_def_dom => 'MSU.EDU',
                   2310:               @_,
                   2311:               );
1.586     raeburn  2312:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2313:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2314:     if (defined($in{'curr_authtype'})) {
                   2315:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2316:             if ($can_assign{'loc'}) {
1.772     bisitz   2317:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2318:                 if (defined($in{'mode'})) {
                   2319:                     if ($in{'mode'} eq 'modifyuser') {
                   2320:                         $loccheck = '';
                   2321:                     }
                   2322:                 }
1.591     raeburn  2323:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2324:                     $locarg = $in{'curr_autharg'};
                   2325:                 }
                   2326:             } else {
                   2327:                 $result = &mt('Currently using local (institutional) authentication.');
                   2328:                 return $result;
1.165     raeburn  2329:             }
                   2330:         }
1.586     raeburn  2331:     } else {
                   2332:         if ($authnum == 1) {
1.784     bisitz   2333:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2334:         }
                   2335:     }
                   2336:     if (!$can_assign{'loc'}) {
                   2337:         return;
1.587     raeburn  2338:     } elsif ($authtype eq '') {
1.591     raeburn  2339:         if (defined($in{'mode'})) {
1.587     raeburn  2340:             if ($in{'mode'} eq 'modifycourse') {
                   2341:                 if ($authnum == 1) {
1.784     bisitz   2342:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2343:                 }
                   2344:             }
                   2345:         }
1.165     raeburn  2346:     }
1.586     raeburn  2347:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2348:     if ($authtype eq '') {
                   2349:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2350:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2351:                     $jscall.'" />';
                   2352:     }
                   2353:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2354:                $locarg.'" onchange="'.$jscall.'" />';
                   2355:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2356:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2357:     return $result;
                   2358: }
                   2359: 
                   2360: sub authform_filesystem{  
                   2361:     my %in = (
                   2362:               formname => 'document.cu',
                   2363:               kerb_def_dom => 'MSU.EDU',
                   2364:               @_,
                   2365:               );
1.586     raeburn  2366:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2367:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2368:     if (defined($in{'curr_authtype'})) {
                   2369:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2370:             if ($can_assign{'fsys'}) {
1.772     bisitz   2371:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2372:                 if (defined($in{'mode'})) {
                   2373:                     if ($in{'mode'} eq 'modifyuser') {
                   2374:                         $fsyscheck = '';
                   2375:                     }
                   2376:                 }
1.586     raeburn  2377:             } else {
                   2378:                 $result = &mt('Currently Filesystem Authenticated.');
                   2379:                 return $result;
                   2380:             }           
                   2381:         }
                   2382:     } else {
                   2383:         if ($authnum == 1) {
1.784     bisitz   2384:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2385:         }
                   2386:     }
                   2387:     if (!$can_assign{'fsys'}) {
                   2388:         return;
1.587     raeburn  2389:     } elsif ($authtype eq '') {
1.591     raeburn  2390:         if (defined($in{'mode'})) {
1.587     raeburn  2391:             if ($in{'mode'} eq 'modifycourse') {
                   2392:                 if ($authnum == 1) {
1.784     bisitz   2393:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2394:                 }
                   2395:             }
                   2396:         }
1.586     raeburn  2397:     }
                   2398:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2399:     if ($authtype eq '') {
                   2400:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2401:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2402:                     $jscall.'" />';
                   2403:     }
                   2404:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2405:                ' onchange="'.$jscall.'" />';
                   2406:     $result = &mt
1.144     matthew  2407:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2408:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2409:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2410:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2411:                   'onchange="'.$jscall.'" />');
1.32      matthew  2412:     return $result;
                   2413: }
                   2414: 
1.586     raeburn  2415: sub get_assignable_auth {
                   2416:     my ($dom) = @_;
                   2417:     if ($dom eq '') {
                   2418:         $dom = $env{'request.role.domain'};
                   2419:     }
                   2420:     my %can_assign = (
                   2421:                           krb4 => 1,
                   2422:                           krb5 => 1,
                   2423:                           int  => 1,
                   2424:                           loc  => 1,
                   2425:                      );
                   2426:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2427:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2428:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2429:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2430:             my $context;
                   2431:             if ($env{'request.role'} =~ /^au/) {
                   2432:                 $context = 'author';
                   2433:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2434:                 $context = 'domain';
                   2435:             } elsif ($env{'request.course.id'}) {
                   2436:                 $context = 'course';
                   2437:             }
                   2438:             if ($context) {
                   2439:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2440:                    %can_assign = %{$authhash->{$context}}; 
                   2441:                 }
                   2442:             }
                   2443:         }
                   2444:     }
                   2445:     my $authnum = 0;
                   2446:     foreach my $key (keys(%can_assign)) {
                   2447:         if ($can_assign{$key}) {
                   2448:             $authnum ++;
                   2449:         }
                   2450:     }
                   2451:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2452:         $authnum --;
                   2453:     }
                   2454:     return ($authnum,%can_assign);
                   2455: }
                   2456: 
1.80      albertel 2457: ###############################################################
                   2458: ##    Get Kerberos Defaults for Domain                 ##
                   2459: ###############################################################
                   2460: ##
                   2461: ## Returns default kerberos version and an associated argument
                   2462: ## as listed in file domain.tab. If not listed, provides
                   2463: ## appropriate default domain and kerberos version.
                   2464: ##
                   2465: #-------------------------------------------
                   2466: 
                   2467: =pod
                   2468: 
1.648     raeburn  2469: =item * &get_kerberos_defaults()
1.80      albertel 2470: 
                   2471: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2472: version and domain. If not found, it defaults to version 4 and the 
                   2473: domain of the server.
1.80      albertel 2474: 
1.648     raeburn  2475: =over 4
                   2476: 
1.80      albertel 2477: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2478: 
1.648     raeburn  2479: =back
                   2480: 
                   2481: =back
                   2482: 
1.80      albertel 2483: =cut
                   2484: 
                   2485: #-------------------------------------------
                   2486: sub get_kerberos_defaults {
                   2487:     my $domain=shift;
1.641     raeburn  2488:     my ($krbdef,$krbdefdom);
                   2489:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2490:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2491:         $krbdef = $domdefaults{'auth_def'};
                   2492:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2493:     } else {
1.80      albertel 2494:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2495:         my $krbdefdom=$1;
                   2496:         $krbdefdom=~tr/a-z/A-Z/;
                   2497:         $krbdef = "krb4";
                   2498:     }
                   2499:     return ($krbdef,$krbdefdom);
                   2500: }
1.112     bowersj2 2501: 
1.32      matthew  2502: 
1.46      matthew  2503: ###############################################################
                   2504: ##                Thesaurus Functions                        ##
                   2505: ###############################################################
1.20      www      2506: 
1.46      matthew  2507: =pod
1.20      www      2508: 
1.112     bowersj2 2509: =head1 Thesaurus Functions
                   2510: 
                   2511: =over 4
                   2512: 
1.648     raeburn  2513: =item * &initialize_keywords()
1.46      matthew  2514: 
                   2515: Initializes the package variable %Keywords if it is empty.  Uses the
                   2516: package variable $thesaurus_db_file.
                   2517: 
                   2518: =cut
                   2519: 
                   2520: ###################################################
                   2521: 
                   2522: sub initialize_keywords {
                   2523:     return 1 if (scalar keys(%Keywords));
                   2524:     # If we are here, %Keywords is empty, so fill it up
                   2525:     #   Make sure the file we need exists...
                   2526:     if (! -e $thesaurus_db_file) {
                   2527:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2528:                                  " failed because it does not exist");
                   2529:         return 0;
                   2530:     }
                   2531:     #   Set up the hash as a database
                   2532:     my %thesaurus_db;
                   2533:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2534:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2535:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2536:                                  $thesaurus_db_file);
                   2537:         return 0;
                   2538:     } 
                   2539:     #  Get the average number of appearances of a word.
                   2540:     my $avecount = $thesaurus_db{'average.count'};
                   2541:     #  Put keywords (those that appear > average) into %Keywords
                   2542:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2543:         my ($count,undef) = split /:/,$data;
                   2544:         $Keywords{$word}++ if ($count > $avecount);
                   2545:     }
                   2546:     untie %thesaurus_db;
                   2547:     # Remove special values from %Keywords.
1.356     albertel 2548:     foreach my $value ('total.count','average.count') {
                   2549:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2550:   }
1.46      matthew  2551:     return 1;
                   2552: }
                   2553: 
                   2554: ###################################################
                   2555: 
                   2556: =pod
                   2557: 
1.648     raeburn  2558: =item * &keyword($word)
1.46      matthew  2559: 
                   2560: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2561: than the average number of times in the thesaurus database.  Calls 
                   2562: &initialize_keywords
                   2563: 
                   2564: =cut
                   2565: 
                   2566: ###################################################
1.20      www      2567: 
                   2568: sub keyword {
1.46      matthew  2569:     return if (!&initialize_keywords());
                   2570:     my $word=lc(shift());
                   2571:     $word=~s/\W//g;
                   2572:     return exists($Keywords{$word});
1.20      www      2573: }
1.46      matthew  2574: 
                   2575: ###############################################################
                   2576: 
                   2577: =pod 
1.20      www      2578: 
1.648     raeburn  2579: =item * &get_related_words()
1.46      matthew  2580: 
1.160     matthew  2581: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2582: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2583: will be returned.  The order of the words returned is determined by the
                   2584: database which holds them.
                   2585: 
                   2586: Uses global $thesaurus_db_file.
                   2587: 
                   2588: =cut
                   2589: 
                   2590: ###############################################################
                   2591: sub get_related_words {
                   2592:     my $keyword = shift;
                   2593:     my %thesaurus_db;
                   2594:     if (! -e $thesaurus_db_file) {
                   2595:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2596:                                  "failed because the file does not exist");
                   2597:         return ();
                   2598:     }
                   2599:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2600:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2601:         return ();
                   2602:     } 
                   2603:     my @Words=();
1.429     www      2604:     my $count=0;
1.46      matthew  2605:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2606: 	# The first element is the number of times
                   2607: 	# the word appears.  We do not need it now.
1.429     www      2608: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2609: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2610: 	my $threshold=$mostfrequentcount/10;
                   2611:         foreach my $possibleword (@RelatedWords) {
                   2612:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2613:             if ($wordcount>$threshold) {
                   2614: 		push(@Words,$word);
                   2615:                 $count++;
                   2616:                 if ($count>10) { last; }
                   2617: 	    }
1.20      www      2618:         }
                   2619:     }
1.46      matthew  2620:     untie %thesaurus_db;
                   2621:     return @Words;
1.14      harris41 2622: }
1.46      matthew  2623: 
1.112     bowersj2 2624: =pod
                   2625: 
                   2626: =back
                   2627: 
                   2628: =cut
1.61      www      2629: 
                   2630: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2631: =pod
                   2632: 
1.112     bowersj2 2633: =head1 User Name Functions
                   2634: 
                   2635: =over 4
                   2636: 
1.648     raeburn  2637: =item * &plainname($uname,$udom,$first)
1.81      albertel 2638: 
1.112     bowersj2 2639: Takes a users logon name and returns it as a string in
1.226     albertel 2640: "first middle last generation" form 
                   2641: if $first is set to 'lastname' then it returns it as
                   2642: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2643: 
                   2644: =cut
1.61      www      2645: 
1.295     www      2646: 
1.81      albertel 2647: ###############################################################
1.61      www      2648: sub plainname {
1.226     albertel 2649:     my ($uname,$udom,$first)=@_;
1.537     albertel 2650:     return if (!defined($uname) || !defined($udom));
1.295     www      2651:     my %names=&getnames($uname,$udom);
1.226     albertel 2652:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2653: 					  $names{'middlename'},
                   2654: 					  $names{'lastname'},
                   2655: 					  $names{'generation'},$first);
                   2656:     $name=~s/^\s+//;
1.62      www      2657:     $name=~s/\s+$//;
                   2658:     $name=~s/\s+/ /g;
1.353     albertel 2659:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2660:     return $name;
1.61      www      2661: }
1.66      www      2662: 
                   2663: # -------------------------------------------------------------------- Nickname
1.81      albertel 2664: =pod
                   2665: 
1.648     raeburn  2666: =item * &nickname($uname,$udom)
1.81      albertel 2667: 
                   2668: Gets a users name and returns it as a string as
                   2669: 
                   2670: "&quot;nickname&quot;"
1.66      www      2671: 
1.81      albertel 2672: if the user has a nickname or
                   2673: 
                   2674: "first middle last generation"
                   2675: 
                   2676: if the user does not
                   2677: 
                   2678: =cut
1.66      www      2679: 
                   2680: sub nickname {
                   2681:     my ($uname,$udom)=@_;
1.537     albertel 2682:     return if (!defined($uname) || !defined($udom));
1.295     www      2683:     my %names=&getnames($uname,$udom);
1.68      albertel 2684:     my $name=$names{'nickname'};
1.66      www      2685:     if ($name) {
                   2686:        $name='&quot;'.$name.'&quot;'; 
                   2687:     } else {
                   2688:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2689: 	     $names{'lastname'}.' '.$names{'generation'};
                   2690:        $name=~s/\s+$//;
                   2691:        $name=~s/\s+/ /g;
                   2692:     }
                   2693:     return $name;
                   2694: }
                   2695: 
1.295     www      2696: sub getnames {
                   2697:     my ($uname,$udom)=@_;
1.537     albertel 2698:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2699:     if ($udom eq 'public' && $uname eq 'public') {
                   2700: 	return ('lastname' => &mt('Public'));
                   2701:     }
1.295     www      2702:     my $id=$uname.':'.$udom;
                   2703:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2704:     if ($cached) {
                   2705: 	return %{$names};
                   2706:     } else {
                   2707: 	my %loadnames=&Apache::lonnet::get('environment',
                   2708:                     ['firstname','middlename','lastname','generation','nickname'],
                   2709: 					 $udom,$uname);
                   2710: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2711: 	return %loadnames;
                   2712:     }
                   2713: }
1.61      www      2714: 
1.542     raeburn  2715: # -------------------------------------------------------------------- getemails
1.648     raeburn  2716: 
1.542     raeburn  2717: =pod
                   2718: 
1.648     raeburn  2719: =item * &getemails($uname,$udom)
1.542     raeburn  2720: 
                   2721: Gets a user's email information and returns it as a hash with keys:
                   2722: notification, critnotification, permanentemail
                   2723: 
                   2724: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2725: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2726:  
1.648     raeburn  2727: 
1.542     raeburn  2728: =cut
                   2729: 
1.648     raeburn  2730: 
1.466     albertel 2731: sub getemails {
                   2732:     my ($uname,$udom)=@_;
                   2733:     if ($udom eq 'public' && $uname eq 'public') {
                   2734: 	return;
                   2735:     }
1.467     www      2736:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2737:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2738:     my $id=$uname.':'.$udom;
                   2739:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2740:     if ($cached) {
                   2741: 	return %{$names};
                   2742:     } else {
                   2743: 	my %loadnames=&Apache::lonnet::get('environment',
                   2744:                     			   ['notification','critnotification',
                   2745: 					    'permanentemail'],
                   2746: 					   $udom,$uname);
                   2747: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2748: 	return %loadnames;
                   2749:     }
                   2750: }
                   2751: 
1.551     albertel 2752: sub flush_email_cache {
                   2753:     my ($uname,$udom)=@_;
                   2754:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2755:     if (!$uname) { $uname=$env{'user.name'};   }
                   2756:     return if ($udom eq 'public' && $uname eq 'public');
                   2757:     my $id=$uname.':'.$udom;
                   2758:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2759: }
                   2760: 
1.728     raeburn  2761: # -------------------------------------------------------------------- getlangs
                   2762: 
                   2763: =pod
                   2764: 
                   2765: =item * &getlangs($uname,$udom)
                   2766: 
                   2767: Gets a user's language preference and returns it as a hash with key:
                   2768: language.
                   2769: 
                   2770: =cut
                   2771: 
                   2772: 
                   2773: sub getlangs {
                   2774:     my ($uname,$udom) = @_;
                   2775:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2776:     if (!$uname) { $uname=$env{'user.name'};   }
                   2777:     my $id=$uname.':'.$udom;
                   2778:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2779:     if ($cached) {
                   2780:         return %{$langs};
                   2781:     } else {
                   2782:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2783:                                            $udom,$uname);
                   2784:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2785:         return %loadlangs;
                   2786:     }
                   2787: }
                   2788: 
                   2789: sub flush_langs_cache {
                   2790:     my ($uname,$udom)=@_;
                   2791:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2792:     if (!$uname) { $uname=$env{'user.name'};   }
                   2793:     return if ($udom eq 'public' && $uname eq 'public');
                   2794:     my $id=$uname.':'.$udom;
                   2795:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2796: }
                   2797: 
1.61      www      2798: # ------------------------------------------------------------------ Screenname
1.81      albertel 2799: 
                   2800: =pod
                   2801: 
1.648     raeburn  2802: =item * &screenname($uname,$udom)
1.81      albertel 2803: 
                   2804: Gets a users screenname and returns it as a string
                   2805: 
                   2806: =cut
1.61      www      2807: 
                   2808: sub screenname {
                   2809:     my ($uname,$udom)=@_;
1.258     albertel 2810:     if ($uname eq $env{'user.name'} &&
                   2811: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2812:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2813:     return $names{'screenname'};
1.62      www      2814: }
                   2815: 
1.212     albertel 2816: 
1.802     bisitz   2817: # ------------------------------------------------------------- Confirm Wrapper
                   2818: =pod
                   2819: 
                   2820: =item confirmwrapper
                   2821: 
                   2822: Wrap messages about completion of operation in box
                   2823: 
                   2824: =cut
                   2825: 
                   2826: sub confirmwrapper {
                   2827:     my ($message)=@_;
                   2828:     if ($message) {
                   2829:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2830:                .$message."\n"
                   2831:                .'</div>'."\n";
                   2832:     } else {
                   2833:         return $message;
                   2834:     }
                   2835: }
                   2836: 
1.62      www      2837: # ------------------------------------------------------------- Message Wrapper
                   2838: 
                   2839: sub messagewrapper {
1.369     www      2840:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2841:     return 
1.441     albertel 2842:         '<a href="/adm/email?compose=individual&amp;'.
                   2843:         'recname='.$username.'&amp;recdom='.$domain.
                   2844: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2845:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2846: }
1.802     bisitz   2847: 
1.74      www      2848: # --------------------------------------------------------------- Notes Wrapper
                   2849: 
                   2850: sub noteswrapper {
                   2851:     my ($link,$un,$do)=@_;
                   2852:     return 
                   2853: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2854: }
1.802     bisitz   2855: 
1.62      www      2856: # ------------------------------------------------------------- Aboutme Wrapper
                   2857: 
                   2858: sub aboutmewrapper {
1.166     www      2859:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2860:     if (!defined($username)  && !defined($domain)) {
                   2861:         return;
                   2862:     }
1.205     www      2863:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756     weissno  2864: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2865: }
                   2866: 
                   2867: # ------------------------------------------------------------ Syllabus Wrapper
                   2868: 
                   2869: sub syllabuswrapper {
1.707     bisitz   2870:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2871:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2872: }
1.14      harris41 2873: 
1.802     bisitz   2874: # -----------------------------------------------------------------------------
                   2875: 
1.208     matthew  2876: sub track_student_link {
1.268     albertel 2877:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2878:     my $link ="/adm/trackstudent?";
1.208     matthew  2879:     my $title = 'View recent activity';
                   2880:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2881:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2882:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2883:         $title .= ' of this student';
1.268     albertel 2884:     } 
1.208     matthew  2885:     if (defined($target) && $target !~ /^\s*$/) {
                   2886:         $target = qq{target="$target"};
                   2887:     } else {
                   2888:         $target = '';
                   2889:     }
1.268     albertel 2890:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2891:     $title = &mt($title);
                   2892:     $linktext = &mt($linktext);
1.448     albertel 2893:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2894: 	&help_open_topic('View_recent_activity');
1.208     matthew  2895: }
                   2896: 
1.781     raeburn  2897: sub slot_reservations_link {
                   2898:     my ($linktext,$sname,$sdom,$target) = @_;
                   2899:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   2900:     my $title = 'View slot reservation history';
                   2901:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2902:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   2903:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   2904:         $title .= ' of this student';
                   2905:     }
                   2906:     if (defined($target) && $target !~ /^\s*$/) {
                   2907:         $target = qq{target="$target"};
                   2908:     } else {
                   2909:         $target = '';
                   2910:     }
                   2911:     $title = &mt($title);
                   2912:     $linktext = &mt($linktext);
                   2913:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2914: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   2915: 
                   2916: }
                   2917: 
1.508     www      2918: # ===================================================== Display a student photo
                   2919: 
                   2920: 
1.509     albertel 2921: sub student_image_tag {
1.508     www      2922:     my ($domain,$user)=@_;
                   2923:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2924:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2925: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2926:     } else {
                   2927: 	return '';
                   2928:     }
                   2929: }
                   2930: 
1.112     bowersj2 2931: =pod
                   2932: 
                   2933: =back
                   2934: 
                   2935: =head1 Access .tab File Data
                   2936: 
                   2937: =over 4
                   2938: 
1.648     raeburn  2939: =item * &languageids() 
1.112     bowersj2 2940: 
                   2941: returns list of all language ids
                   2942: 
                   2943: =cut
                   2944: 
1.14      harris41 2945: sub languageids {
1.16      harris41 2946:     return sort(keys(%language));
1.14      harris41 2947: }
                   2948: 
1.112     bowersj2 2949: =pod
                   2950: 
1.648     raeburn  2951: =item * &languagedescription() 
1.112     bowersj2 2952: 
                   2953: returns description of a specified language id
                   2954: 
                   2955: =cut
                   2956: 
1.14      harris41 2957: sub languagedescription {
1.125     www      2958:     my $code=shift;
                   2959:     return  ($supported_language{$code}?'* ':'').
                   2960:             $language{$code}.
1.126     www      2961: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2962: }
                   2963: 
                   2964: sub plainlanguagedescription {
                   2965:     my $code=shift;
                   2966:     return $language{$code};
                   2967: }
                   2968: 
                   2969: sub supportedlanguagecode {
                   2970:     my $code=shift;
                   2971:     return $supported_language{$code};
1.97      www      2972: }
                   2973: 
1.112     bowersj2 2974: =pod
                   2975: 
1.648     raeburn  2976: =item * &copyrightids() 
1.112     bowersj2 2977: 
                   2978: returns list of all copyrights
                   2979: 
                   2980: =cut
                   2981: 
                   2982: sub copyrightids {
                   2983:     return sort(keys(%cprtag));
                   2984: }
                   2985: 
                   2986: =pod
                   2987: 
1.648     raeburn  2988: =item * &copyrightdescription() 
1.112     bowersj2 2989: 
                   2990: returns description of a specified copyright id
                   2991: 
                   2992: =cut
                   2993: 
                   2994: sub copyrightdescription {
1.166     www      2995:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2996: }
1.197     matthew  2997: 
                   2998: =pod
                   2999: 
1.648     raeburn  3000: =item * &source_copyrightids() 
1.192     taceyjo1 3001: 
                   3002: returns list of all source copyrights
                   3003: 
                   3004: =cut
                   3005: 
                   3006: sub source_copyrightids {
                   3007:     return sort(keys(%scprtag));
                   3008: }
                   3009: 
                   3010: =pod
                   3011: 
1.648     raeburn  3012: =item * &source_copyrightdescription() 
1.192     taceyjo1 3013: 
                   3014: returns description of a specified source copyright id
                   3015: 
                   3016: =cut
                   3017: 
                   3018: sub source_copyrightdescription {
                   3019:     return &mt($scprtag{shift(@_)});
                   3020: }
1.112     bowersj2 3021: 
                   3022: =pod
                   3023: 
1.648     raeburn  3024: =item * &filecategories() 
1.112     bowersj2 3025: 
                   3026: returns list of all file categories
                   3027: 
                   3028: =cut
                   3029: 
                   3030: sub filecategories {
                   3031:     return sort(keys(%category_extensions));
                   3032: }
                   3033: 
                   3034: =pod
                   3035: 
1.648     raeburn  3036: =item * &filecategorytypes() 
1.112     bowersj2 3037: 
                   3038: returns list of file types belonging to a given file
                   3039: category
                   3040: 
                   3041: =cut
                   3042: 
                   3043: sub filecategorytypes {
1.356     albertel 3044:     my ($cat) = @_;
                   3045:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3046: }
                   3047: 
                   3048: =pod
                   3049: 
1.648     raeburn  3050: =item * &fileembstyle() 
1.112     bowersj2 3051: 
                   3052: returns embedding style for a specified file type
                   3053: 
                   3054: =cut
                   3055: 
                   3056: sub fileembstyle {
                   3057:     return $fe{lc(shift(@_))};
1.169     www      3058: }
                   3059: 
1.351     www      3060: sub filemimetype {
                   3061:     return $fm{lc(shift(@_))};
                   3062: }
                   3063: 
1.169     www      3064: 
                   3065: sub filecategoryselect {
                   3066:     my ($name,$value)=@_;
1.189     matthew  3067:     return &select_form($value,$name,
1.169     www      3068: 			'' => &mt('Any category'),
                   3069: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3070: }
                   3071: 
                   3072: =pod
                   3073: 
1.648     raeburn  3074: =item * &filedescription() 
1.112     bowersj2 3075: 
                   3076: returns description for a specified file type
                   3077: 
                   3078: =cut
                   3079: 
                   3080: sub filedescription {
1.188     matthew  3081:     my $file_description = $fd{lc(shift())};
                   3082:     $file_description =~ s:([\[\]]):~$1:g;
                   3083:     return &mt($file_description);
1.112     bowersj2 3084: }
                   3085: 
                   3086: =pod
                   3087: 
1.648     raeburn  3088: =item * &filedescriptionex() 
1.112     bowersj2 3089: 
                   3090: returns description for a specified file type with
                   3091: extra formatting
                   3092: 
                   3093: =cut
                   3094: 
                   3095: sub filedescriptionex {
                   3096:     my $ex=shift;
1.188     matthew  3097:     my $file_description = $fd{lc($ex)};
                   3098:     $file_description =~ s:([\[\]]):~$1:g;
                   3099:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3100: }
                   3101: 
                   3102: # End of .tab access
                   3103: =pod
                   3104: 
                   3105: =back
                   3106: 
                   3107: =cut
                   3108: 
                   3109: # ------------------------------------------------------------------ File Types
                   3110: sub fileextensions {
                   3111:     return sort(keys(%fe));
                   3112: }
                   3113: 
1.97      www      3114: # ----------------------------------------------------------- Display Languages
                   3115: # returns a hash with all desired display languages
                   3116: #
                   3117: 
                   3118: sub display_languages {
                   3119:     my %languages=();
1.695     raeburn  3120:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3121: 	$languages{$lang}=1;
1.97      www      3122:     }
                   3123:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3124:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3125: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3126: 	    $languages{$lang}=1;
1.97      www      3127:         }
                   3128:     }
                   3129:     return %languages;
1.14      harris41 3130: }
                   3131: 
1.582     albertel 3132: sub languages {
                   3133:     my ($possible_langs) = @_;
1.695     raeburn  3134:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3135:     if (!ref($possible_langs)) {
                   3136: 	if( wantarray ) {
                   3137: 	    return @preferred_langs;
                   3138: 	} else {
                   3139: 	    return $preferred_langs[0];
                   3140: 	}
                   3141:     }
                   3142:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3143:     my @preferred_possibilities;
                   3144:     foreach my $preferred_lang (@preferred_langs) {
                   3145: 	if (exists($possibilities{$preferred_lang})) {
                   3146: 	    push(@preferred_possibilities, $preferred_lang);
                   3147: 	}
                   3148:     }
                   3149:     if( wantarray ) {
                   3150: 	return @preferred_possibilities;
                   3151:     }
                   3152:     return $preferred_possibilities[0];
                   3153: }
                   3154: 
1.742     raeburn  3155: sub user_lang {
                   3156:     my ($touname,$toudom,$fromcid) = @_;
                   3157:     my @userlangs;
                   3158:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3159:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3160:                     $env{'course.'.$fromcid.'.languages'}));
                   3161:     } else {
                   3162:         my %langhash = &getlangs($touname,$toudom);
                   3163:         if ($langhash{'languages'} ne '') {
                   3164:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3165:         } else {
                   3166:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3167:             if ($domdefs{'lang_def'} ne '') {
                   3168:                 @userlangs = ($domdefs{'lang_def'});
                   3169:             }
                   3170:         }
                   3171:     }
                   3172:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3173:     my $user_lh = Apache::localize->get_handle(@languages);
                   3174:     return $user_lh;
                   3175: }
                   3176: 
                   3177: 
1.112     bowersj2 3178: ###############################################################
                   3179: ##               Student Answer Attempts                     ##
                   3180: ###############################################################
                   3181: 
                   3182: =pod
                   3183: 
                   3184: =head1 Alternate Problem Views
                   3185: 
                   3186: =over 4
                   3187: 
1.648     raeburn  3188: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3189:     $getattempt, $regexp, $gradesub)
                   3190: 
                   3191: Return string with previous attempt on problem. Arguments:
                   3192: 
                   3193: =over 4
                   3194: 
                   3195: =item * $symb: Problem, including path
                   3196: 
                   3197: =item * $username: username of the desired student
                   3198: 
                   3199: =item * $domain: domain of the desired student
1.14      harris41 3200: 
1.112     bowersj2 3201: =item * $course: Course ID
1.14      harris41 3202: 
1.112     bowersj2 3203: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3204:     something
1.14      harris41 3205: 
1.112     bowersj2 3206: =item * $regexp: if string matches this regexp, the string will be
                   3207:     sent to $gradesub
1.14      harris41 3208: 
1.112     bowersj2 3209: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3210: 
1.112     bowersj2 3211: =back
1.14      harris41 3212: 
1.112     bowersj2 3213: The output string is a table containing all desired attempts, if any.
1.16      harris41 3214: 
1.112     bowersj2 3215: =cut
1.1       albertel 3216: 
                   3217: sub get_previous_attempt {
1.43      ng       3218:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3219:   my $prevattempts='';
1.43      ng       3220:   no strict 'refs';
1.1       albertel 3221:   if ($symb) {
1.3       albertel 3222:     my (%returnhash)=
                   3223:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3224:     if ($returnhash{'version'}) {
                   3225:       my %lasthash=();
                   3226:       my $version;
                   3227:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3228:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3229: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3230:         }
1.1       albertel 3231:       }
1.596     albertel 3232:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3233:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3234:       foreach my $key (sort(keys(%lasthash))) {
                   3235: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3236: 	if ($#parts > 0) {
1.31      albertel 3237: 	  my $data=$parts[-1];
                   3238: 	  pop(@parts);
1.596     albertel 3239: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3240: 	} else {
1.41      ng       3241: 	  if ($#parts == 0) {
                   3242: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3243: 	  } else {
                   3244: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3245: 	  }
1.31      albertel 3246: 	}
1.16      harris41 3247:       }
1.596     albertel 3248:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3249:       if ($getattempt eq '') {
                   3250: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3251: 	  $prevattempts.=&start_data_table_row().
                   3252: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3253: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3254: 		my $value = &format_previous_attempt_value($key,
                   3255: 							   $returnhash{$version.':'.$key});
                   3256: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3257: 	    }
1.596     albertel 3258: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3259: 	 }
1.1       albertel 3260:       }
1.596     albertel 3261:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3262:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3263: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3264: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3265: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3266:       }
1.596     albertel 3267:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3268:     } else {
1.596     albertel 3269:       $prevattempts=
                   3270: 	  &start_data_table().&start_data_table_row().
                   3271: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3272: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3273:     }
                   3274:   } else {
1.596     albertel 3275:     $prevattempts=
                   3276: 	  &start_data_table().&start_data_table_row().
                   3277: 	  '<td>'.&mt('No data.').'</td>'.
                   3278: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3279:   }
1.10      albertel 3280: }
                   3281: 
1.581     albertel 3282: sub format_previous_attempt_value {
                   3283:     my ($key,$value) = @_;
                   3284:     if ($key =~ /timestamp/) {
                   3285: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3286:     } elsif (ref($value) eq 'ARRAY') {
                   3287: 	$value = '('.join(', ', @{ $value }).')';
                   3288:     } else {
                   3289: 	$value = &unescape($value);
                   3290:     }
                   3291:     return $value;
                   3292: }
                   3293: 
                   3294: 
1.107     albertel 3295: sub relative_to_absolute {
                   3296:     my ($url,$output)=@_;
                   3297:     my $parser=HTML::TokeParser->new(\$output);
                   3298:     my $token;
                   3299:     my $thisdir=$url;
                   3300:     my @rlinks=();
                   3301:     while ($token=$parser->get_token) {
                   3302: 	if ($token->[0] eq 'S') {
                   3303: 	    if ($token->[1] eq 'a') {
                   3304: 		if ($token->[2]->{'href'}) {
                   3305: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3306: 		}
                   3307: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3308: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3309: 	    } elsif ($token->[1] eq 'base') {
                   3310: 		$thisdir=$token->[2]->{'href'};
                   3311: 	    }
                   3312: 	}
                   3313:     }
                   3314:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3315:     foreach my $link (@rlinks) {
1.726     raeburn  3316: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3317: 		($link=~/^\//) ||
                   3318: 		($link=~/^javascript:/i) ||
                   3319: 		($link=~/^mailto:/i) ||
                   3320: 		($link=~/^\#/)) {
                   3321: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3322: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3323: 	}
                   3324:     }
                   3325: # -------------------------------------------------- Deal with Applet codebases
                   3326:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3327:     return $output;
                   3328: }
                   3329: 
1.112     bowersj2 3330: =pod
                   3331: 
1.648     raeburn  3332: =item * &get_student_view()
1.112     bowersj2 3333: 
                   3334: show a snapshot of what student was looking at
                   3335: 
                   3336: =cut
                   3337: 
1.10      albertel 3338: sub get_student_view {
1.186     albertel 3339:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3340:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3341:   my (%form);
1.10      albertel 3342:   my @elements=('symb','courseid','domain','username');
                   3343:   foreach my $element (@elements) {
1.186     albertel 3344:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3345:   }
1.186     albertel 3346:   if (defined($moreenv)) {
                   3347:       %form=(%form,%{$moreenv});
                   3348:   }
1.236     albertel 3349:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3350:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3351:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3352:   $userview=~s/\<body[^\>]*\>//gi;
                   3353:   $userview=~s/\<\/body\>//gi;
                   3354:   $userview=~s/\<html\>//gi;
                   3355:   $userview=~s/\<\/html\>//gi;
                   3356:   $userview=~s/\<head\>//gi;
                   3357:   $userview=~s/\<\/head\>//gi;
                   3358:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3359:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3360:   if (wantarray) {
                   3361:      return ($userview,$response);
                   3362:   } else {
                   3363:      return $userview;
                   3364:   }
                   3365: }
                   3366: 
                   3367: sub get_student_view_with_retries {
                   3368:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3369: 
                   3370:     my $ok = 0;                 # True if we got a good response.
                   3371:     my $content;
                   3372:     my $response;
                   3373: 
                   3374:     # Try to get the student_view done. within the retries count:
                   3375:     
                   3376:     do {
                   3377:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3378:          $ok      = $response->is_success;
                   3379:          if (!$ok) {
                   3380:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3381:          }
                   3382:          $retries--;
                   3383:     } while (!$ok && ($retries > 0));
                   3384:     
                   3385:     if (!$ok) {
                   3386:        $content = '';          # On error return an empty content.
                   3387:     }
1.651     www      3388:     if (wantarray) {
                   3389:        return ($content, $response);
                   3390:     } else {
                   3391:        return $content;
                   3392:     }
1.11      albertel 3393: }
                   3394: 
1.112     bowersj2 3395: =pod
                   3396: 
1.648     raeburn  3397: =item * &get_student_answers() 
1.112     bowersj2 3398: 
                   3399: show a snapshot of how student was answering problem
                   3400: 
                   3401: =cut
                   3402: 
1.11      albertel 3403: sub get_student_answers {
1.100     sakharuk 3404:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3405:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3406:   my (%moreenv);
1.11      albertel 3407:   my @elements=('symb','courseid','domain','username');
                   3408:   foreach my $element (@elements) {
1.186     albertel 3409:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3410:   }
1.186     albertel 3411:   $moreenv{'grade_target'}='answer';
                   3412:   %moreenv=(%form,%moreenv);
1.497     raeburn  3413:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3414:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3415:   return $userview;
1.1       albertel 3416: }
1.116     albertel 3417: 
                   3418: =pod
                   3419: 
                   3420: =item * &submlink()
                   3421: 
1.242     albertel 3422: Inputs: $text $uname $udom $symb $target
1.116     albertel 3423: 
                   3424: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3425: 
                   3426: =cut
                   3427: 
                   3428: ###############################################
                   3429: sub submlink {
1.242     albertel 3430:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3431:     if (!($uname && $udom)) {
                   3432: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3433: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3434: 	if (!$symb) { $symb=$cursymb; }
                   3435:     }
1.254     matthew  3436:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3437:     $symb=&escape($symb);
1.242     albertel 3438:     if ($target) { $target="target=\"$target\""; }
                   3439:     return '<a href="/adm/grades?&command=submission&'.
                   3440: 	'symb='.$symb.'&student='.$uname.
                   3441: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3442: }
                   3443: ##############################################
                   3444: 
                   3445: =pod
                   3446: 
                   3447: =item * &pgrdlink()
                   3448: 
                   3449: Inputs: $text $uname $udom $symb $target
                   3450: 
                   3451: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3452: 
                   3453: =cut
                   3454: 
                   3455: ###############################################
                   3456: sub pgrdlink {
                   3457:     my $link=&submlink(@_);
                   3458:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3459:     return $link;
                   3460: }
                   3461: ##############################################
                   3462: 
                   3463: =pod
                   3464: 
                   3465: =item * &pprmlink()
                   3466: 
                   3467: Inputs: $text $uname $udom $symb $target
                   3468: 
                   3469: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3470: student and a specific resource
1.242     albertel 3471: 
                   3472: =cut
                   3473: 
                   3474: ###############################################
                   3475: sub pprmlink {
                   3476:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3477:     if (!($uname && $udom)) {
                   3478: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3479: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3480: 	if (!$symb) { $symb=$cursymb; }
                   3481:     }
1.254     matthew  3482:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3483:     $symb=&escape($symb);
1.242     albertel 3484:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3485:     return '<a href="/adm/parmset?command=set&amp;'.
                   3486: 	'symb='.$symb.'&amp;uname='.$uname.
                   3487: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3488: }
                   3489: ##############################################
1.37      matthew  3490: 
1.112     bowersj2 3491: =pod
                   3492: 
                   3493: =back
                   3494: 
                   3495: =cut
                   3496: 
1.37      matthew  3497: ###############################################
1.51      www      3498: 
                   3499: 
                   3500: sub timehash {
1.687     raeburn  3501:     my ($thistime) = @_;
                   3502:     my $timezone = &Apache::lonlocal::gettimezone();
                   3503:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3504:                      ->set_time_zone($timezone);
                   3505:     my $wday = $dt->day_of_week();
                   3506:     if ($wday == 7) { $wday = 0; }
                   3507:     return ( 'second' => $dt->second(),
                   3508:              'minute' => $dt->minute(),
                   3509:              'hour'   => $dt->hour(),
                   3510:              'day'     => $dt->day_of_month(),
                   3511:              'month'   => $dt->month(),
                   3512:              'year'    => $dt->year(),
                   3513:              'weekday' => $wday,
                   3514:              'dayyear' => $dt->day_of_year(),
                   3515:              'dlsav'   => $dt->is_dst() );
1.51      www      3516: }
                   3517: 
1.370     www      3518: sub utc_string {
                   3519:     my ($date)=@_;
1.371     www      3520:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3521: }
                   3522: 
1.51      www      3523: sub maketime {
                   3524:     my %th=@_;
1.687     raeburn  3525:     my ($epoch_time,$timezone,$dt);
                   3526:     $timezone = &Apache::lonlocal::gettimezone();
                   3527:     eval {
                   3528:         $dt = DateTime->new( year   => $th{'year'},
                   3529:                              month  => $th{'month'},
                   3530:                              day    => $th{'day'},
                   3531:                              hour   => $th{'hour'},
                   3532:                              minute => $th{'minute'},
                   3533:                              second => $th{'second'},
                   3534:                              time_zone => $timezone,
                   3535:                          );
                   3536:     };
                   3537:     if (!$@) {
                   3538:         $epoch_time = $dt->epoch;
                   3539:         if ($epoch_time) {
                   3540:             return $epoch_time;
                   3541:         }
                   3542:     }
1.51      www      3543:     return POSIX::mktime(
                   3544:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3545:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3546: }
                   3547: 
                   3548: #########################################
1.51      www      3549: 
                   3550: sub findallcourses {
1.482     raeburn  3551:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3552:     my %roles;
                   3553:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3554:     my %courses;
1.51      www      3555:     my $now=time;
1.482     raeburn  3556:     if (!defined($uname)) {
                   3557:         $uname = $env{'user.name'};
                   3558:     }
                   3559:     if (!defined($udom)) {
                   3560:         $udom = $env{'user.domain'};
                   3561:     }
                   3562:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3563:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3564:         if (!%roles) {
                   3565:             %roles = (
                   3566:                        cc => 1,
                   3567:                        in => 1,
                   3568:                        ep => 1,
                   3569:                        ta => 1,
                   3570:                        cr => 1,
                   3571:                        st => 1,
                   3572:              );
                   3573:         }
                   3574:         foreach my $entry (keys(%roleshash)) {
                   3575:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3576:             if ($trole =~ /^cr/) { 
                   3577:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3578:             } else {
                   3579:                 next if (!exists($roles{$trole}));
                   3580:             }
                   3581:             if ($tend) {
                   3582:                 next if ($tend < $now);
                   3583:             }
                   3584:             if ($tstart) {
                   3585:                 next if ($tstart > $now);
                   3586:             }
                   3587:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3588:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3589:             if ($secpart eq '') {
                   3590:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3591:                 $sec = 'none';
                   3592:                 $realsec = '';
                   3593:             } else {
                   3594:                 $cnum = $cnumpart;
                   3595:                 ($sec,$role) = split(/_/,$secpart);
                   3596:                 $realsec = $sec;
1.490     raeburn  3597:             }
1.482     raeburn  3598:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3599:         }
                   3600:     } else {
                   3601:         foreach my $key (keys(%env)) {
1.483     albertel 3602: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3603:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3604: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3605: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3606: 	        next if (%roles && !exists($roles{$role}));
                   3607: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3608:                 my $active=1;
                   3609:                 if ($starttime) {
                   3610: 		    if ($now<$starttime) { $active=0; }
                   3611:                 }
                   3612:                 if ($endtime) {
                   3613:                     if ($now>$endtime) { $active=0; }
                   3614:                 }
                   3615:                 if ($active) {
                   3616:                     if ($sec eq '') {
                   3617:                         $sec = 'none';
                   3618:                     }
                   3619:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3620:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3621:                 }
                   3622:             }
1.51      www      3623:         }
                   3624:     }
1.474     raeburn  3625:     return %courses;
1.51      www      3626: }
1.37      matthew  3627: 
1.54      www      3628: ###############################################
1.474     raeburn  3629: 
                   3630: sub blockcheck {
1.482     raeburn  3631:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3632: 
                   3633:     if (!defined($udom)) {
                   3634:         $udom = $env{'user.domain'};
                   3635:     }
                   3636:     if (!defined($uname)) {
                   3637:         $uname = $env{'user.name'};
                   3638:     }
                   3639: 
                   3640:     # If uname and udom are for a course, check for blocks in the course.
                   3641: 
                   3642:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3643:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3644:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3645:         return ($startblock,$endblock);
                   3646:     }
1.474     raeburn  3647: 
1.502     raeburn  3648:     my $startblock = 0;
                   3649:     my $endblock = 0;
1.482     raeburn  3650:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3651: 
1.490     raeburn  3652:     # If uname is for a user, and activity is course-specific, i.e.,
                   3653:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3654: 
1.490     raeburn  3655:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3656:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3657:         foreach my $key (keys(%live_courses)) {
                   3658:             if ($key ne $env{'request.course.id'}) {
                   3659:                 delete($live_courses{$key});
                   3660:             }
                   3661:         }
                   3662:     }
                   3663: 
                   3664:     my $otheruser = 0;
                   3665:     my %own_courses;
                   3666:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3667:         # Resource belongs to user other than current user.
                   3668:         $otheruser = 1;
                   3669:         # Gather courses for current user
                   3670:         %own_courses = 
                   3671:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3672:     }
                   3673: 
                   3674:     # Gather active course roles - course coordinator, instructor, 
                   3675:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3676: 
                   3677:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3678:         my ($cdom,$cnum);
                   3679:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3680:             $cdom = $env{'course.'.$course.'.domain'};
                   3681:             $cnum = $env{'course.'.$course.'.num'};
                   3682:         } else {
1.490     raeburn  3683:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3684:         }
                   3685:         my $no_ownblock = 0;
                   3686:         my $no_userblock = 0;
1.533     raeburn  3687:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3688:             # Check if current user has 'evb' priv for this
                   3689:             if (defined($own_courses{$course})) {
                   3690:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3691:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3692:                     if ($sec ne 'none') {
                   3693:                         $checkrole .= '/'.$sec;
                   3694:                     }
                   3695:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3696:                         $no_ownblock = 1;
                   3697:                         last;
                   3698:                     }
                   3699:                 }
                   3700:             }
                   3701:             # if they have 'evb' priv and are currently not playing student
                   3702:             next if (($no_ownblock) &&
                   3703:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3704:         }
1.474     raeburn  3705:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3706:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3707:             if ($sec ne 'none') {
1.482     raeburn  3708:                 $checkrole .= '/'.$sec;
1.474     raeburn  3709:             }
1.490     raeburn  3710:             if ($otheruser) {
                   3711:                 # Resource belongs to user other than current user.
                   3712:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3713:                 my ($trole,$tdom,$tnum,$tsec);
                   3714:                 my $entry = $live_courses{$course}{$sec};
                   3715:                 if ($entry =~ /^cr/) {
                   3716:                     ($trole,$tdom,$tnum,$tsec) = 
                   3717:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3718:                 } else {
                   3719:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3720:                 }
                   3721:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3722:                 $area = '/'.$tdom.'/'.$tnum;
                   3723:                 $trest = $tnum;
                   3724:                 if ($tsec ne '') {
                   3725:                     $area .= '/'.$tsec;
                   3726:                     $trest .= '/'.$tsec;
                   3727:                 }
                   3728:                 $spec = $trole.'.'.$area;
                   3729:                 if ($trole =~ /^cr/) {
                   3730:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3731:                                                       $tdom,$spec,$trest,$area);
                   3732:                 } else {
                   3733:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3734:                                                        $tdom,$spec,$trest,$area);
                   3735:                 }
                   3736:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3737:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3738:                     if ($1) {
                   3739:                         $no_userblock = 1;
                   3740:                         last;
                   3741:                     }
                   3742:                 }
1.490     raeburn  3743:             } else {
                   3744:                 # Resource belongs to current user
                   3745:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3746:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3747:                     $no_ownblock = 1;
                   3748:                     last;
                   3749:                 }
1.474     raeburn  3750:             }
                   3751:         }
                   3752:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3753:         next if (($no_ownblock) &&
1.491     albertel 3754:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3755:         next if ($no_userblock);
1.474     raeburn  3756: 
1.490     raeburn  3757:         # Retrieve blocking times and identity of blocker for course
                   3758:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3759:         
                   3760:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3761:         if (($start != 0) && 
                   3762:             (($startblock == 0) || ($startblock > $start))) {
                   3763:             $startblock = $start;
                   3764:         }
                   3765:         if (($end != 0)  &&
                   3766:             (($endblock == 0) || ($endblock < $end))) {
                   3767:             $endblock = $end;
                   3768:         }
1.490     raeburn  3769:     }
                   3770:     return ($startblock,$endblock);
                   3771: }
                   3772: 
                   3773: sub get_blocks {
                   3774:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3775:     my $startblock = 0;
                   3776:     my $endblock = 0;
                   3777:     my $course = $cdom.'_'.$cnum;
                   3778:     $setters->{$course} = {};
                   3779:     $setters->{$course}{'staff'} = [];
                   3780:     $setters->{$course}{'times'} = [];
                   3781:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3782:     foreach my $record (keys(%records)) {
                   3783:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3784:         if ($start <= time && $end >= time) {
                   3785:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3786:                 &parse_block_record($records{$record});
                   3787:             if ($blocks->{$activity} eq 'on') {
                   3788:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3789:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3790:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3791:                     $startblock = $start;
1.490     raeburn  3792:                 }
1.491     albertel 3793:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3794:                     $endblock = $end;
1.474     raeburn  3795:                 }
                   3796:             }
                   3797:         }
                   3798:     }
                   3799:     return ($startblock,$endblock);
                   3800: }
                   3801: 
                   3802: sub parse_block_record {
                   3803:     my ($record) = @_;
                   3804:     my ($setuname,$setudom,$title,$blocks);
                   3805:     if (ref($record) eq 'HASH') {
                   3806:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3807:         $title = &unescape($record->{'event'});
                   3808:         $blocks = $record->{'blocks'};
                   3809:     } else {
                   3810:         my @data = split(/:/,$record,3);
                   3811:         if (scalar(@data) eq 2) {
                   3812:             $title = $data[1];
                   3813:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3814:         } else {
                   3815:             ($setuname,$setudom,$title) = @data;
                   3816:         }
                   3817:         $blocks = { 'com' => 'on' };
                   3818:     }
                   3819:     return ($setuname,$setudom,$title,$blocks);
                   3820: }
                   3821: 
                   3822: sub build_block_table {
                   3823:     my ($startblock,$endblock,$setters) = @_;
                   3824:     my %lt = &Apache::lonlocal::texthash(
                   3825:         'cacb' => 'Currently active communication blocks',
                   3826:         'cour' => 'Course',
                   3827:         'dura' => 'Duration',
                   3828:         'blse' => 'Block set by'
                   3829:     );
                   3830:     my $output;
1.476     raeburn  3831:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3832:     $output .= &start_data_table();
                   3833:     $output .= '
                   3834: <tr>
                   3835:  <th>'.$lt{'cour'}.'</th>
                   3836:  <th>'.$lt{'dura'}.'</th>
                   3837:  <th>'.$lt{'blse'}.'</th>
                   3838: </tr>
                   3839: ';
                   3840:     foreach my $course (keys(%{$setters})) {
                   3841:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3842:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3843:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3844:             my $fullname = &plainname($uname,$udom);
                   3845:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3846:                 && $env{'user.name'} ne 'public' 
                   3847:                 && $env{'user.domain'} ne 'public') {
                   3848:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3849:             }
1.474     raeburn  3850:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3851:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3852:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3853:             $output .= &Apache::loncommon::start_data_table_row().
                   3854:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3855:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3856:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3857:                         &Apache::loncommon::end_data_table_row();
                   3858:         }
                   3859:     }
                   3860:     $output .= &end_data_table();
                   3861: }
                   3862: 
1.490     raeburn  3863: sub blocking_status {
                   3864:     my ($activity,$uname,$udom) = @_;
                   3865:     my %setters;
                   3866:     my ($blocked,$output,$ownitem,$is_course);
                   3867:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3868:     if ($startblock && $endblock) {
                   3869:         $blocked = 1;
                   3870:         if (wantarray) {
                   3871:             my $category;
                   3872:             if ($activity eq 'boards') {
                   3873:                 $category = 'Discussion posts in this course';
                   3874:             } elsif ($activity eq 'blogs') {
                   3875:                 $category = 'Blogs';
                   3876:             } elsif ($activity eq 'port') {
                   3877:                 if (defined($uname) && defined($udom)) {
                   3878:                     if ($uname eq $env{'user.name'} &&
                   3879:                         $udom eq $env{'user.domain'}) {
                   3880:                         $ownitem = 1;
                   3881:                     }
                   3882:                 }
                   3883:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3884:                 if ($ownitem) { 
                   3885:                     $category = 'Your portfolio files';  
                   3886:                 } elsif ($is_course) {
                   3887:                     my $coursedesc;
                   3888:                     foreach my $course (keys(%setters)) {
                   3889:                         my %courseinfo =
                   3890:                              &Apache::lonnet::coursedescription($course);
                   3891:                         $coursedesc = $courseinfo{'description'};
                   3892:                     }
1.764     weissno  3893:                     $category = "Group portfolio in the course '$coursedesc'";
1.490     raeburn  3894:                 } else {
                   3895:                     $category = 'Portfolio files belonging to ';
                   3896:                     if ($env{'user.name'} eq 'public' && 
                   3897:                         $env{'user.domain'} eq 'public') {
                   3898:                         $category .= &plainname($uname,$udom);
                   3899:                     } else {
                   3900:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3901:                     }
                   3902:                 }
                   3903:             } elsif ($activity eq 'groups') {
                   3904:                 $category = 'Groups in this course';
                   3905:             }
                   3906:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3907:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3908:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3909:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3910:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3911:             }
                   3912:         }
                   3913:     }
                   3914:     if (wantarray) {
                   3915:         return ($blocked,$output);
                   3916:     } else {
                   3917:         return $blocked;
                   3918:     }
                   3919: }
                   3920: 
1.60      matthew  3921: ###############################################
                   3922: 
1.682     raeburn  3923: sub check_ip_acc {
                   3924:     my ($acc)=@_;
                   3925:     &Apache::lonxml::debug("acc is $acc");
                   3926:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3927:         return 1;
                   3928:     }
                   3929:     my $allowed=0;
                   3930:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3931: 
                   3932:     my $name;
                   3933:     foreach my $pattern (split(',',$acc)) {
                   3934:         $pattern =~ s/^\s*//;
                   3935:         $pattern =~ s/\s*$//;
                   3936:         if ($pattern =~ /\*$/) {
                   3937:             #35.8.*
                   3938:             $pattern=~s/\*//;
                   3939:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3940:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3941:             #35.8.3.[34-56]
                   3942:             my $low=$2;
                   3943:             my $high=$3;
                   3944:             $pattern=$1;
                   3945:             if ($ip =~ /^\Q$pattern\E/) {
                   3946:                 my $last=(split(/\./,$ip))[3];
                   3947:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3948:             }
                   3949:         } elsif ($pattern =~ /^\*/) {
                   3950:             #*.msu.edu
                   3951:             $pattern=~s/\*//;
                   3952:             if (!defined($name)) {
                   3953:                 use Socket;
                   3954:                 my $netaddr=inet_aton($ip);
                   3955:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3956:             }
                   3957:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3958:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3959:             #127.0.0.1
                   3960:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3961:         } else {
                   3962:             #some.name.com
                   3963:             if (!defined($name)) {
                   3964:                 use Socket;
                   3965:                 my $netaddr=inet_aton($ip);
                   3966:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3967:             }
                   3968:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3969:         }
                   3970:         if ($allowed) { last; }
                   3971:     }
                   3972:     return $allowed;
                   3973: }
                   3974: 
                   3975: ###############################################
                   3976: 
1.60      matthew  3977: =pod
                   3978: 
1.112     bowersj2 3979: =head1 Domain Template Functions
                   3980: 
                   3981: =over 4
                   3982: 
                   3983: =item * &determinedomain()
1.60      matthew  3984: 
                   3985: Inputs: $domain (usually will be undef)
                   3986: 
1.63      www      3987: Returns: Determines which domain should be used for designs
1.60      matthew  3988: 
                   3989: =cut
1.54      www      3990: 
1.60      matthew  3991: ###############################################
1.63      www      3992: sub determinedomain {
                   3993:     my $domain=shift;
1.531     albertel 3994:     if (! $domain) {
1.60      matthew  3995:         # Determine domain if we have not been given one
                   3996:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 3997:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   3998:         if ($env{'request.role.domain'}) { 
                   3999:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4000:         }
                   4001:     }
1.63      www      4002:     return $domain;
                   4003: }
                   4004: ###############################################
1.517     raeburn  4005: 
1.518     albertel 4006: sub devalidate_domconfig_cache {
                   4007:     my ($udom)=@_;
                   4008:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4009: }
                   4010: 
                   4011: # ---------------------- Get domain configuration for a domain
                   4012: sub get_domainconf {
                   4013:     my ($udom) = @_;
                   4014:     my $cachetime=1800;
                   4015:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4016:     if (defined($cached)) { return %{$result}; }
                   4017: 
                   4018:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4019: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4020:     my (%designhash,%legacy);
1.518     albertel 4021:     if (keys(%domconfig) > 0) {
                   4022:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4023:             if (keys(%{$domconfig{'login'}})) {
                   4024:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4025:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4026:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4027:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4028:                                 $domconfig{'login'}{$key}{$img};
                   4029:                         }
                   4030:                     } else {
                   4031:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4032:                     }
1.632     raeburn  4033:                 }
                   4034:             } else {
                   4035:                 $legacy{'login'} = 1;
1.518     albertel 4036:             }
1.632     raeburn  4037:         } else {
                   4038:             $legacy{'login'} = 1;
1.518     albertel 4039:         }
                   4040:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4041:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4042:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4043:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4044:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4045:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4046:                         }
1.518     albertel 4047:                     }
                   4048:                 }
1.632     raeburn  4049:             } else {
                   4050:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4051:             }
1.632     raeburn  4052:         } else {
                   4053:             $legacy{'rolecolors'} = 1;
1.518     albertel 4054:         }
1.632     raeburn  4055:         if (keys(%legacy) > 0) {
                   4056:             my %legacyhash = &get_legacy_domconf($udom);
                   4057:             foreach my $item (keys(%legacyhash)) {
                   4058:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4059:                     if ($legacy{'login'}) { 
                   4060:                         $designhash{$item} = $legacyhash{$item};
                   4061:                     }
                   4062:                 } else {
                   4063:                     if ($legacy{'rolecolors'}) {
                   4064:                         $designhash{$item} = $legacyhash{$item};
                   4065:                     }
1.518     albertel 4066:                 }
                   4067:             }
                   4068:         }
1.632     raeburn  4069:     } else {
                   4070:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4071:     }
                   4072:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4073: 				  $cachetime);
                   4074:     return %designhash;
                   4075: }
                   4076: 
1.632     raeburn  4077: sub get_legacy_domconf {
                   4078:     my ($udom) = @_;
                   4079:     my %legacyhash;
                   4080:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4081:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4082:     if (-e $designfile) {
                   4083:         if ( open (my $fh,"<$designfile") ) {
                   4084:             while (my $line = <$fh>) {
                   4085:                 next if ($line =~ /^\#/);
                   4086:                 chomp($line);
                   4087:                 my ($key,$val)=(split(/\=/,$line));
                   4088:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4089:             }
                   4090:             close($fh);
                   4091:         }
                   4092:     }
                   4093:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4094:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4095:     }
                   4096:     return %legacyhash;
                   4097: }
                   4098: 
1.63      www      4099: =pod
                   4100: 
1.112     bowersj2 4101: =item * &domainlogo()
1.63      www      4102: 
                   4103: Inputs: $domain (usually will be undef)
                   4104: 
                   4105: Returns: A link to a domain logo, if the domain logo exists.
                   4106: If the domain logo does not exist, a description of the domain.
                   4107: 
                   4108: =cut
1.112     bowersj2 4109: 
1.63      www      4110: ###############################################
                   4111: sub domainlogo {
1.517     raeburn  4112:     my $domain = &determinedomain(shift);
1.518     albertel 4113:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4114:     # See if there is a logo
                   4115:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4116:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4117:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4118: 	    if ($imgsrc =~ m{^/res/}) {
                   4119: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4120: 		&Apache::lonnet::repcopy($local_name);
                   4121: 	    }
                   4122: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4123:         } 
                   4124:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4125:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4126:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4127:     } else {
1.60      matthew  4128:         return '';
1.59      www      4129:     }
                   4130: }
1.63      www      4131: ##############################################
                   4132: 
                   4133: =pod
                   4134: 
1.112     bowersj2 4135: =item * &designparm()
1.63      www      4136: 
                   4137: Inputs: $which parameter; $domain (usually will be undef)
                   4138: 
                   4139: Returns: value of designparamter $which
                   4140: 
                   4141: =cut
1.112     bowersj2 4142: 
1.397     albertel 4143: 
1.400     albertel 4144: ##############################################
1.397     albertel 4145: sub designparm {
                   4146:     my ($which,$domain)=@_;
                   4147:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4148:         return $env{'environment.color.'.$which};
1.96      www      4149:     }
1.63      www      4150:     $domain=&determinedomain($domain);
1.518     albertel 4151:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4152:     my $output;
1.517     raeburn  4153:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4154:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4155:     } else {
1.520     raeburn  4156:         $output = $defaultdesign{$which};
                   4157:     }
                   4158:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4159:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4160:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4161:             if ($output =~ m{^/res/}) {
                   4162:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4163:                 &Apache::lonnet::repcopy($local_name);
                   4164:             }
1.520     raeburn  4165:             $output = &lonhttpdurl($output);
                   4166:         }
1.63      www      4167:     }
1.520     raeburn  4168:     return $output;
1.63      www      4169: }
1.59      www      4170: 
1.60      matthew  4171: ###############################################
                   4172: ###############################################
                   4173: 
                   4174: =pod
                   4175: 
1.112     bowersj2 4176: =back
                   4177: 
1.549     albertel 4178: =head1 HTML Helpers
1.112     bowersj2 4179: 
                   4180: =over 4
                   4181: 
                   4182: =item * &bodytag()
1.60      matthew  4183: 
                   4184: Returns a uniform header for LON-CAPA web pages.
                   4185: 
                   4186: Inputs: 
                   4187: 
1.112     bowersj2 4188: =over 4
                   4189: 
                   4190: =item * $title, A title to be displayed on the page.
                   4191: 
                   4192: =item * $function, the current role (can be undef).
                   4193: 
                   4194: =item * $addentries, extra parameters for the <body> tag.
                   4195: 
                   4196: =item * $bodyonly, if defined, only return the <body> tag.
                   4197: 
                   4198: =item * $domain, if defined, force a given domain.
                   4199: 
                   4200: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4201:             text interface only)
1.60      matthew  4202: 
1.326     albertel 4203: =item * $customtitle, alternate text to use instead of $title
                   4204:                       in the title box that appears, this text
                   4205:                       is not auto translated like the $title is
1.309     albertel 4206: 
1.814     bisitz   4207: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4208:                      navigational links
1.317     albertel 4209: 
1.338     albertel 4210: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4211: 
1.361     albertel 4212: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4213:          'Switch To Inline Menu' link
                   4214: 
1.460     albertel 4215: =item * $args, optional argument valid values are
                   4216:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4217:             inherit_jsmath -> when creating popup window in a page,
                   4218:                               should it have jsmath forced on by the
                   4219:                               current page
1.460     albertel 4220: 
1.112     bowersj2 4221: =back
                   4222: 
1.60      matthew  4223: Returns: A uniform header for LON-CAPA web pages.  
                   4224: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4225: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4226: other decorations will be returned.
                   4227: 
                   4228: =cut
                   4229: 
1.54      www      4230: sub bodytag {
1.309     albertel 4231:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.816     bisitz   4232:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4233: 
1.460     albertel 4234:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4235: 
1.183     matthew  4236:     $function = &get_users_function() if (!$function);
1.339     albertel 4237:     my $img =    &designparm($function.'.img',$domain);
                   4238:     my $font =   &designparm($function.'.font',$domain);
                   4239:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4240: 
1.803     bisitz   4241:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4242: 		   'bgcolor' => $pgbg,
1.339     albertel 4243: 		   'text'    => $font,
                   4244:                    'alink'   => &designparm($function.'.alink',$domain),
                   4245: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4246: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4247:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4248: 
1.63      www      4249:  # role and realm
1.378     raeburn  4250:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4251:     if ($role  eq 'ca') {
1.479     albertel 4252:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4253:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4254:     } 
1.55      www      4255: # realm
1.258     albertel 4256:     if ($env{'request.course.id'}) {
1.378     raeburn  4257:         if ($env{'request.role'} !~ /^cr/) {
                   4258:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4259:         }
1.359     albertel 4260: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4261:     } else {
                   4262:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4263:     }
1.433     albertel 4264: 
1.359     albertel 4265:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4266: # Set messages
1.60      matthew  4267:     my $messages=&domainlogo($domain);
1.330     albertel 4268: 
1.438     albertel 4269:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4270: 
1.101     www      4271: # construct main body tag
1.359     albertel 4272:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4273: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4274: 
1.530     albertel 4275:     if ($bodyonly) {
1.60      matthew  4276:         return $bodytag;
1.798     tempelho 4277:     } 
1.359     albertel 4278: 
1.410     albertel 4279:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4280:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4281: 	undef($role);
1.434     albertel 4282:     } else {
                   4283: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4284:     }
1.359     albertel 4285:     
                   4286:     my $roleinfo=(<<ENDROLE);
                   4287: <td class="LC_title_bar_who">
                   4288: <div class="LC_title_bar_name">
1.410     albertel 4289:     $name
1.361     albertel 4290:     &nbsp;
1.359     albertel 4291: </div>
                   4292: <div class="LC_title_bar_role">
1.361     albertel 4293: $role&nbsp;
1.359     albertel 4294: </div>
                   4295: <div class="LC_title_bar_realm">
1.361     albertel 4296: $realm&nbsp;
1.359     albertel 4297: </div>
1.206     albertel 4298: </td>
                   4299: ENDROLE
1.235     raeburn  4300: 
1.762     bisitz   4301:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4302:     if ($customtitle) {
                   4303:         $titleinfo = $customtitle;
                   4304:     }
                   4305:     #
                   4306:     # Extra info if you are the DC
                   4307:     my $dc_info = '';
                   4308:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4309:                         $env{'course.'.$env{'request.course.id'}.
                   4310:                                  '.domain'}.'/'})) {
                   4311:         my $cid = $env{'request.course.id'};
                   4312:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4313:         $dc_info =~ s/\s+$//;
1.359     albertel 4314:         $dc_info = '('.$dc_info.')';
                   4315:     }
                   4316: 
1.644     www      4317:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4318:         # No Remote
1.258     albertel 4319: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4320: 	    $forcereg=1;
                   4321: 	}
                   4322: 
                   4323: 	if (!$customtitle && $env{'request.state'} eq 'construct') {
                   4324: 	    # this is for resources; directories have customtitle, and crumbs
                   4325:             # and select recent are created in lonpubdir.pm  
1.229     albertel 4326: 	    my ($uname,$thisdisfn)=
1.258     albertel 4327: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 4328: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4329: 	    $formaction=~s/\/+/\//g;
                   4330: 
1.359     albertel 4331: 	    my $parentpath = '';
                   4332: 	    my $lastitem = '';
                   4333: 	    if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4334: 		$parentpath = $1;
                   4335: 		$lastitem = $2;
                   4336: 	    } else {
                   4337: 		$lastitem = $thisdisfn;
                   4338: 	    }
                   4339: 	    $titleinfo = 
1.640     bisitz   4340: 		&Apache::loncommon::help_open_menu('','',3,'Authoring')
                   4341: 		.'<b>'.&mt('Construction Space').'</b>:&nbsp;'
                   4342: 		.'<form name="dirs" method="post" action="'.$formaction
1.359     albertel 4343: 		.'" target="_top"><tt><b>'
1.705     tempelho 4344: 		.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359     albertel 4345: 		.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4346: 		.'</form>'
                   4347: 		.&Apache::lonmenu::constspaceform();
1.235     raeburn  4348:         }
1.359     albertel 4349: 
1.816     bisitz   4350:         my $titletable = '<table id="LC_title_bar">'
                   4351:                         ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
                   4352:                         .'</tr></table>';
                   4353: 
1.814     bisitz   4354: 	if ($no_nav_bar) {
1.359     albertel 4355: 	    $bodytag .= $titletable;
                   4356: 	} else {
1.813     bisitz   4357:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
                   4358:             <em>$realm</em> $dc_info</div>|;
1.359     albertel 4359: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4360:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4361: 							  $titletable);
1.272     raeburn  4362:             } else {
1.336     albertel 4363:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4364: 		    $titletable;
1.272     raeburn  4365:             }
1.235     raeburn  4366:         }
                   4367:         return $bodytag;
1.94      www      4368:     }
1.95      www      4369: 
1.93      www      4370: #
1.95      www      4371: # Top frame rendering, Remote is up
1.93      www      4372: #
1.359     albertel 4373: 
1.517     raeburn  4374:     my $imgsrc = $img;
                   4375:     if ($img =~ /^\/adm/) {
1.575     albertel 4376:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4377:     }
                   4378:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4379: 
1.305     www      4380:     # Explicit link to get inline menu
1.361     albertel 4381:     my $menu= ($no_inline_link?''
                   4382: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4383:     #
1.94      www      4384:     return(<<ENDBODY);
1.60      matthew  4385: $bodytag
1.359     albertel 4386: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4387: <tr><td>$upperleft</td>
                   4388:     <td>$messages&nbsp;</td>
1.54      www      4389: </tr>
1.359     albertel 4390: <tr><td>$titleinfo $dc_info $menu</td>
                   4391: $roleinfo
1.368     albertel 4392: </tr>
1.356     albertel 4393: </table>
1.54      www      4394: ENDBODY
1.182     matthew  4395: }
                   4396: 
1.330     albertel 4397: sub make_attr_string {
                   4398:     my ($register,$attr_ref) = @_;
                   4399: 
                   4400:     if ($attr_ref && !ref($attr_ref)) {
                   4401: 	die("addentries Must be a hash ref ".
                   4402: 	    join(':',caller(1))." ".
                   4403: 	    join(':',caller(0))." ");
                   4404:     }
                   4405: 
                   4406:     if ($register) {
1.339     albertel 4407: 	my ($on_load,$on_unload);
                   4408: 	foreach my $key (keys(%{$attr_ref})) {
                   4409: 	    if      (lc($key) eq 'onload') {
                   4410: 		$on_load.=$attr_ref->{$key}.';';
                   4411: 		delete($attr_ref->{$key});
                   4412: 
                   4413: 	    } elsif (lc($key) eq 'onunload') {
                   4414: 		$on_unload.=$attr_ref->{$key}.';';
                   4415: 		delete($attr_ref->{$key});
                   4416: 	    }
                   4417: 	}
                   4418: 	$attr_ref->{'onload'}  =
                   4419: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4420: 	$attr_ref->{'onunload'}=
                   4421: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4422:     }
                   4423: 
                   4424: # Accessibility font enhance
                   4425:     if ($env{'browser.fontenhance'} eq 'on') {
                   4426: 	my $style;
                   4427: 	foreach my $key (keys(%{$attr_ref})) {
                   4428: 	    if (lc($key) eq 'style') {
                   4429: 		$style.=$attr_ref->{$key}.';';
                   4430: 		delete($attr_ref->{$key});
                   4431: 	    }
                   4432: 	}
                   4433: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4434:     }
1.339     albertel 4435: 
1.330     albertel 4436:     my $attr_string;
                   4437:     foreach my $attr (keys(%$attr_ref)) {
                   4438: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4439:     }
                   4440:     return $attr_string;
                   4441: }
                   4442: 
                   4443: 
1.182     matthew  4444: ###############################################
1.251     albertel 4445: ###############################################
                   4446: 
                   4447: =pod
                   4448: 
                   4449: =item * &endbodytag()
                   4450: 
                   4451: Returns a uniform footer for LON-CAPA web pages.
                   4452: 
1.635     raeburn  4453: Inputs: 1 - optional reference to an args hash
                   4454: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4455: a 'Continue' link is not displayed if the page contains an
                   4456: internal redirect in the <head></head> section,
                   4457: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4458: 
                   4459: =cut
                   4460: 
                   4461: sub endbodytag {
1.635     raeburn  4462:     my ($args) = @_;
1.251     albertel 4463:     my $endbodytag='</body>';
1.269     albertel 4464:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4465:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4466:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4467: 	    $endbodytag=
                   4468: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4469: 	        &mt('Continue').'</a>'.
                   4470: 	        $endbodytag;
                   4471:         }
1.315     albertel 4472:     }
1.251     albertel 4473:     return $endbodytag;
                   4474: }
                   4475: 
1.352     albertel 4476: =pod
                   4477: 
                   4478: =item * &standard_css()
                   4479: 
                   4480: Returns a style sheet
                   4481: 
                   4482: Inputs: (all optional)
                   4483:             domain         -> force to color decorate a page for a specific
                   4484:                                domain
                   4485:             function       -> force usage of a specific rolish color scheme
                   4486:             bgcolor        -> override the default page bgcolor
                   4487: 
                   4488: =cut
                   4489: 
1.343     albertel 4490: sub standard_css {
1.345     albertel 4491:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4492:     $function  = &get_users_function() if (!$function);
                   4493:     my $img    = &designparm($function.'.img',   $domain);
                   4494:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4495:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4496:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4497: #second colour for later usage
1.345     albertel 4498:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4499:     my $pgbg_or_bgcolor =
                   4500: 	         $bgcolor ||
1.352     albertel 4501: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4502:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4503:     my $alink  = &designparm($function.'.alink', $domain);
                   4504:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4505:     my $link   = &designparm($function.'.link',  $domain);
                   4506: 
1.704     muellerd 4507:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4508:     my $bgcol = &designparm('login.bgcol',$domain);
                   4509:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4510: 
1.602     albertel 4511:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4512:     my $mono                 = 'monospace';
1.352     albertel 4513:     my $data_table_head      = $tabbg;
                   4514:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4515:     my $data_table_dark      = '#DDDDDD';
                   4516:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4517:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4518:     my $mail_new             = '#FFBB77';
                   4519:     my $mail_new_hover       = '#DD9955';
                   4520:     my $mail_read            = '#BBBB77';
                   4521:     my $mail_read_hover      = '#999944';
                   4522:     my $mail_replied         = '#AAAA88';
                   4523:     my $mail_replied_hover   = '#888855';
                   4524:     my $mail_other           = '#99BBBB';
                   4525:     my $mail_other_hover     = '#669999';
1.391     albertel 4526:     my $table_header         = '#DDDDDD';
1.489     raeburn  4527:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4528:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4529: 
1.608     albertel 4530:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4531: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4532: 	                                                 : '0 3px 0 4px';
1.448     albertel 4533: 
1.523     albertel 4534: 
1.343     albertel 4535:     return <<END;
1.795     www      4536: body {
                   4537:    font-family: $sans;
                   4538:    line-height:130%;
                   4539:    font-size:0.83em;
                   4540:    color:$font;
                   4541: }
                   4542: 
                   4543: a:link, a:visited { 
                   4544:   font-size:100%; 
                   4545: }
                   4546: 
                   4547: a:focus { 
                   4548:   color: red;
                   4549:   background: yellow 
                   4550: }
1.698     harmsja  4551: 
1.795     www      4552: form, .inline { 
                   4553:    display: inline; 
                   4554: }
1.721     harmsja  4555: 
1.795     www      4556: .LC_right {
                   4557:    text-align:right;
                   4558: }
                   4559: 
                   4560: .LC_middle {
                   4561:    vertical-align:middle;
                   4562: }
1.721     harmsja  4563: 
                   4564: /* just for tests */
1.754     droeschl 4565: .LC_400Box {width:400px; }
1.721     harmsja  4566: /* end */
                   4567: 
1.778     bisitz   4568: .LC_filename {
                   4569:   font-family: $mono;
                   4570:   white-space:pre;
                   4571: }
                   4572: 
                   4573: .LC_fileicon {
                   4574:   border: none;
                   4575:   height: 1.3em;
                   4576:   vertical-align: text-bottom;
                   4577:   margin-right: 0.3em;
                   4578:   text-decoration:none;
                   4579: }
                   4580: 
1.350     albertel 4581: .LC_error {
                   4582:   color: red;
                   4583:   font-size: larger;
                   4584: }
1.795     www      4585: 
1.457     albertel 4586: .LC_warning,
                   4587: .LC_diff_removed {
1.733     bisitz   4588:   color: red;
1.394     albertel 4589: }
1.532     albertel 4590: 
                   4591: .LC_info,
1.457     albertel 4592: .LC_success,
                   4593: .LC_diff_added {
1.350     albertel 4594:   color: green;
                   4595: }
1.795     www      4596: 
1.802     bisitz   4597: div.LC_confirm_box {
                   4598:   background-color: #FAFAFA;
                   4599:   border: 1px solid $lg_border_color;
                   4600:   margin-right: 0;
                   4601:   padding: 5px;
                   4602: }
                   4603: 
                   4604: div.LC_confirm_box .LC_error img,
                   4605: div.LC_confirm_box .LC_success img {
                   4606:   vertical-align: middle;
                   4607: }
                   4608: 
1.440     albertel 4609: .LC_icon {
1.771     droeschl 4610:   border: none;
1.790     droeschl 4611:   vertical-align: middle;
1.771     droeschl 4612: }
                   4613: 
1.543     albertel 4614: .LC_docs_spacer {
                   4615:   width: 25px;
                   4616:   height: 1px;
1.771     droeschl 4617:   border: none;
1.543     albertel 4618: }
1.346     albertel 4619: 
1.532     albertel 4620: .LC_internal_info {
1.735     bisitz   4621:   color: #999999;
1.532     albertel 4622: }
                   4623: 
1.794     www      4624: .LC_discussion {
                   4625:    background: $tabbg;
                   4626:    border: 1px solid black;
                   4627:    margin: 2px;
                   4628: }
                   4629: 
                   4630: .LC_disc_action_links_bar {
                   4631:    background: $tabbg;
                   4632:    font-family: $sans;
1.803     bisitz   4633:    border: none;
1.795     www      4634:    margin: 4px;
1.794     www      4635: }
                   4636: 
                   4637: .LC_disc_action_left {
                   4638:    text-align: left;
                   4639: }
                   4640: 
                   4641: .LC_disc_action_right {
                   4642:    text-align: right;
                   4643: }
                   4644: 
                   4645: .LC_disc_new_item {
                   4646:    background: white;
                   4647:    border: 2px solid red;
                   4648:    margin: 2px;
                   4649: }
                   4650: 
                   4651: .LC_disc_old_item {
                   4652:    background: white;
                   4653:    border: 1px solid black;
                   4654:    margin: 2px;
                   4655: }
                   4656: 
1.458     albertel 4657: table.LC_pastsubmission {
                   4658:   border: 1px solid black;
                   4659:   margin: 2px;
                   4660: }
                   4661: 
1.795     www      4662: table#LC_top_nav,
                   4663: table#LC_menubuttons,
                   4664: table#LC_nav_location {
1.345     albertel 4665:   width: 100%;
                   4666:   background: $pgbg;
1.392     albertel 4667:   border: 2px;
1.402     albertel 4668:   border-collapse: separate;
1.803     bisitz   4669:   padding: 0;
1.345     albertel 4670: }
1.392     albertel 4671: 
1.801     tempelho 4672: table#LC_title_bar a {
                   4673:   color: $fontmenu;
                   4674: }
1.808     droeschl 4675:     
1.807     droeschl 4676: table#LC_title_bar {
1.819     tempelho 4677:   clear: both;
1.807     droeschl 4678:   /*display: none;*/
                   4679: }
                   4680: 
1.795     www      4681: table#LC_title_bar,
                   4682: table.LC_breadcrumbs,
1.393     albertel 4683: table#LC_title_bar.LC_with_remote {
1.359     albertel 4684:   width: 100%;
1.392     albertel 4685:   border-color: $pgbg;
                   4686:   border-style: solid;
                   4687:   border-width: $border;
1.379     albertel 4688:   background: $pgbg;
1.801     tempelho 4689:   color: $fontmenu;
1.379     albertel 4690:   font-family: $sans;
1.392     albertel 4691:   border-collapse: collapse;
1.803     bisitz   4692:   padding: 0;
1.819     tempelho 4693:   margin: 0;
1.359     albertel 4694: }
1.795     www      4695: 
1.409     albertel 4696: table.LC_docs_path {
                   4697:   width: 100%;
                   4698:   border: 0;
                   4699:   background: $pgbg;
                   4700:   font-family: $sans;
                   4701:   border-collapse: collapse;
1.803     bisitz   4702:   padding: 0;
1.409     albertel 4703: }
                   4704: 
1.359     albertel 4705: table#LC_title_bar td {
                   4706:   background: $tabbg;
                   4707: }
1.795     www      4708: 
1.773     ehlerst  4709: table#LC_title_bar .LC_title_bar_who {
1.359     albertel 4710:   background: $tabbg;
1.801     tempelho 4711:   color: $fontmenu;
1.427     albertel 4712:   font: small $sans;
1.359     albertel 4713:   text-align: right;
1.803     bisitz   4714:   margin: 0;
1.773     ehlerst  4715: }
1.795     www      4716: 
1.819     tempelho 4717: table#LC_title_bar div.LC_title_bar_name {
1.803     bisitz   4718:   margin: 0;
1.773     ehlerst  4719: }
1.795     www      4720: 
1.819     tempelho 4721: table#LC_title_bar div.LC_title_bar_role {
1.803     bisitz   4722:   margin: 0;
1.773     ehlerst  4723: }
1.795     www      4724: 
1.819     tempelho 4725: table#LC_title_bar div.LC_title_bar_realm {
1.803     bisitz   4726:   margin: 0;
1.359     albertel 4727: }
1.795     www      4728: 
1.469     banghart 4729: span.LC_metadata {
1.795     www      4730:   font-family: $sans;
1.469     banghart 4731: }
1.359     albertel 4732: 
1.706     harmsja  4733: table#LC_menubuttons img{
1.803     bisitz   4734:   border: none;
1.346     albertel 4735: }
1.795     www      4736: 
1.345     albertel 4737: table#LC_top_nav td {
                   4738:   background: $tabbg;
1.803     bisitz   4739:   border: none;
1.407     albertel 4740:   font-size: small;
1.706     harmsja  4741:   vertical-align:top;
                   4742:   padding:2px 5px 2px 5px;
1.345     albertel 4743: }
1.795     www      4744: 
                   4745: table#LC_top_nav td a,
                   4746: div#LC_top_nav a {
1.345     albertel 4747:   color: $font;
                   4748:   font-family: $sans;
                   4749: }
1.795     www      4750: 
1.364     albertel 4751: table#LC_top_nav td.LC_top_nav_logo {
                   4752:   background: $tabbg;
1.432     albertel 4753:   text-align: left;
1.408     albertel 4754:   white-space: nowrap;
1.432     albertel 4755:   width: 31px;
1.408     albertel 4756: }
1.795     www      4757: 
1.408     albertel 4758: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4759:   border: none;
1.408     albertel 4760:   vertical-align: bottom;
1.364     albertel 4761: }
1.795     www      4762: 
1.777     tempelho 4763: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4764: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4765:   width: 2.0em;
                   4766: }
1.795     www      4767: 
1.442     albertel 4768: table#LC_top_nav td.LC_top_nav_login {
                   4769:   width: 4.0em;
                   4770:   text-align: center;
                   4771: }
1.795     www      4772: 
                   4773: table.LC_breadcrumbs td,
                   4774: table.LC_docs_path td  {
1.357     albertel 4775:   background: $tabbg;
1.801     tempelho 4776:   color: $fontmenu;
1.357     albertel 4777:   font-family: $sans;
1.358     albertel 4778:   font-size: smaller;
1.357     albertel 4779: }
1.795     www      4780: 
1.777     tempelho 4781: table.LC_breadcrumbs td.LC_breadcrumbs_component,
                   4782: table.LC_docs_path td.LC_docs_path_component {
1.779     bisitz   4783:   background: $tabbg;
1.801     tempelho 4784:   color: $fontmenu;
1.777     tempelho 4785:   font-family: $sans;
1.779     bisitz   4786:   font-size: larger;
                   4787:   text-align: right;
1.777     tempelho 4788: }
1.795     www      4789: 
1.383     albertel 4790: td.LC_table_cell_checkbox {
                   4791:   text-align: center;
                   4792: }
1.795     www      4793: 
1.779     bisitz   4794: table#LC_mainmenu td.LC_mainmenu_column {
                   4795:     vertical-align: top;
1.777     tempelho 4796: }
1.522     albertel 4797: 
1.795     www      4798: .LC_fontsize_small {
1.705     tempelho 4799:  font-size: 70%;
                   4800: }
                   4801: 
1.819     tempelho 4802: #LC_head_subbox {
                   4803:  clear:both;
                   4804:  background: $sidebg;
                   4805:  border-bottom: 1px solid #999999;
                   4806:  height: 32px;
                   4807:  line-height: 32px; 
                   4808:  margin: 0 0 10px;
                   4809:  padding: 0;
                   4810: }
                   4811: 
1.795     www      4812: .LC_fontsize_medium {
1.705     tempelho 4813:  font-size: 85%;
                   4814: }
                   4815: 
1.795     www      4816: .LC_fontsize_large {
1.705     tempelho 4817:  font-size: 120%;
                   4818: }
                   4819: 
1.346     albertel 4820: .LC_menubuttons_inline_text {
                   4821:   color: $font;
                   4822:   font-family: $sans;
1.698     harmsja  4823:   font-size: 90%;
1.701     harmsja  4824:   padding-left:3px;
1.346     albertel 4825: }
                   4826: 
1.526     www      4827: .LC_menubuttons_link {
                   4828:   text-decoration: none;
                   4829: }
1.795     www      4830: 
1.522     albertel 4831: .LC_menubuttons_category {
1.521     www      4832:   color: $font;
1.526     www      4833:   background: $pgbg;
1.521     www      4834:   font-family: $sans;
                   4835:   font-size: larger;
                   4836:   font-weight: bold;
                   4837: }
                   4838: 
1.346     albertel 4839: td.LC_menubuttons_text {
1.779     bisitz   4840:  	color: $font;
1.346     albertel 4841: }
1.706     harmsja  4842: 
1.346     albertel 4843: .LC_current_location {
                   4844:   font-family: $sans;
                   4845:   background: $tabbg;
                   4846: }
1.795     www      4847: 
1.346     albertel 4848: .LC_new_mail {
                   4849:   font-family: $sans;
1.634     www      4850:   background: $tabbg;
1.346     albertel 4851:   font-weight: bold;
                   4852: }
1.347     albertel 4853: 
1.527     www      4854: .LC_preferences_labeltext {
                   4855:   font-family: $sans;
                   4856:   text-align: right;
                   4857: }
                   4858: 
1.666     raeburn  4859: .LC_roleslog_note {
1.701     harmsja  4860:   font-size: small;
1.666     raeburn  4861: }
                   4862: 
1.715     raeburn  4863: .LC_mail_functions {
                   4864:     font-weight: bold;
                   4865: }
                   4866: 
1.795     www      4867: table.LC_data_table,
                   4868: table.LC_mail_list {
1.347     albertel 4869:   border: 1px solid #000000;
1.402     albertel 4870:   border-collapse: separate;
1.426     albertel 4871:   border-spacing: 1px;
1.610     albertel 4872:   background: $pgbg;
1.347     albertel 4873: }
1.795     www      4874: 
1.422     albertel 4875: .LC_data_table_dense {
                   4876:   font-size: small;
                   4877: }
1.795     www      4878: 
1.507     raeburn  4879: table.LC_nested_outer {
                   4880:   border: 1px solid #000000;
1.589     raeburn  4881:   border-collapse: collapse;
1.803     bisitz   4882:   border-spacing: 0;
1.507     raeburn  4883:   width: 100%;
                   4884: }
1.795     www      4885: 
1.507     raeburn  4886: table.LC_nested {
1.803     bisitz   4887:   border: none;
1.589     raeburn  4888:   border-collapse: collapse;
1.803     bisitz   4889:   border-spacing: 0;
1.507     raeburn  4890:   width: 100%;
                   4891: }
1.795     www      4892: 
                   4893: table.LC_data_table tr th, 
                   4894: table.LC_calendar tr th, 
                   4895: table.LC_mail_list tr th,
1.523     albertel 4896: table.LC_prior_tries tr th {
1.349     albertel 4897:   font-weight: bold;
                   4898:   background-color: $data_table_head;
1.801     tempelho 4899:   color:$fontmenu;
1.701     harmsja  4900:   font-size:90%;
1.347     albertel 4901: }
1.795     www      4902: 
1.711     raeburn  4903: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4904:   background-color: #CCCCCC;
1.711     raeburn  4905:   font-weight: bold;
                   4906:   text-align: left;
                   4907: }
1.795     www      4908: 
1.779     bisitz   4909: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4910: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4911:   background-color: $data_table_light;
1.425     albertel 4912:   padding: 2px;
1.347     albertel 4913: }
1.795     www      4914: 
1.610     albertel 4915: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4916: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4917:   background-color: $data_table_dark;
1.709     bisitz   4918:   padding: 2px;
1.347     albertel 4919: }
1.795     www      4920: 
1.425     albertel 4921: table.LC_data_table tr.LC_data_table_highlight td {
                   4922:   background-color: $data_table_darker;
                   4923: }
1.795     www      4924: 
1.639     raeburn  4925: table.LC_data_table tr td.LC_leftcol_header {
                   4926:   background-color: $data_table_head;
                   4927:   font-weight: bold;
                   4928: }
1.795     www      4929: 
1.451     albertel 4930: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4931: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4932:   background-color: #FFFFFF;
1.421     albertel 4933:   font-weight: bold;
                   4934:   font-style: italic;
                   4935:   text-align: center;
                   4936:   padding: 8px;
1.347     albertel 4937: }
1.795     www      4938: 
1.507     raeburn  4939: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4940:   padding: 4ex
                   4941: }
1.795     www      4942: 
1.507     raeburn  4943: table.LC_nested_outer tr th {
                   4944:   font-weight: bold;
1.801     tempelho 4945:   color:$fontmenu;
1.507     raeburn  4946:   background-color: $data_table_head;
1.701     harmsja  4947:   font-size: small;
1.507     raeburn  4948:   border-bottom: 1px solid #000000;
                   4949: }
1.795     www      4950: 
1.507     raeburn  4951: table.LC_nested_outer tr td.LC_subheader {
                   4952:   background-color: $data_table_head;
                   4953:   font-weight: bold;
                   4954:   font-size: small;
                   4955:   border-bottom: 1px solid #000000;
                   4956:   text-align: right;
1.451     albertel 4957: }
1.795     www      4958: 
1.507     raeburn  4959: table.LC_nested tr.LC_info_row td {
1.735     bisitz   4960:   background-color: #CCCCCC;
1.451     albertel 4961:   font-weight: bold;
                   4962:   font-size: small;
1.507     raeburn  4963:   text-align: center;
                   4964: }
1.795     www      4965: 
1.589     raeburn  4966: table.LC_nested tr.LC_info_row td.LC_left_item,
                   4967: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  4968:   text-align: left;
1.451     albertel 4969: }
1.795     www      4970: 
1.507     raeburn  4971: table.LC_nested td {
1.735     bisitz   4972:   background-color: #FFFFFF;
1.451     albertel 4973:   font-size: small;
1.507     raeburn  4974: }
1.795     www      4975: 
1.507     raeburn  4976: table.LC_nested_outer tr th.LC_right_item,
                   4977: table.LC_nested tr.LC_info_row td.LC_right_item,
                   4978: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   4979: table.LC_nested tr td.LC_right_item {
1.451     albertel 4980:   text-align: right;
                   4981: }
                   4982: 
1.507     raeburn  4983: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   4984:   background-color: #EEEEEE;
1.451     albertel 4985: }
                   4986: 
1.473     raeburn  4987: table.LC_createuser {
                   4988: }
                   4989: 
                   4990: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  4991:   font-size: small;
1.473     raeburn  4992: }
                   4993: 
                   4994: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   4995:   background-color: #CCCCCC;
1.473     raeburn  4996:   font-weight: bold;
                   4997:   text-align: center;
                   4998: }
                   4999: 
1.349     albertel 5000: table.LC_calendar {
                   5001:   border: 1px solid #000000;
                   5002:   border-collapse: collapse;
                   5003: }
1.795     www      5004: 
1.349     albertel 5005: table.LC_calendar_pickdate {
                   5006:   font-size: xx-small;
                   5007: }
1.795     www      5008: 
1.349     albertel 5009: table.LC_calendar tr td {
                   5010:   border: 1px solid #000000;
                   5011:   vertical-align: top;
                   5012: }
1.795     www      5013: 
1.349     albertel 5014: table.LC_calendar tr td.LC_calendar_day_empty {
                   5015:   background-color: $data_table_dark;
                   5016: }
1.795     www      5017: 
1.779     bisitz   5018: table.LC_calendar tr td.LC_calendar_day_current {
                   5019:   background-color: $data_table_highlight;
1.777     tempelho 5020: }
1.795     www      5021: 
1.349     albertel 5022: table.LC_mail_list tr.LC_mail_new {
                   5023:   background-color: $mail_new;
                   5024: }
1.795     www      5025: 
1.349     albertel 5026: table.LC_mail_list tr.LC_mail_new:hover {
                   5027:   background-color: $mail_new_hover;
                   5028: }
1.795     www      5029: 
                   5030: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5031: }
1.795     www      5032: 
                   5033: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5034: }
1.795     www      5035: 
1.349     albertel 5036: table.LC_mail_list tr.LC_mail_read {
                   5037:   background-color: $mail_read;
                   5038: }
1.795     www      5039: 
1.349     albertel 5040: table.LC_mail_list tr.LC_mail_read:hover {
                   5041:   background-color: $mail_read_hover;
                   5042: }
1.795     www      5043: 
1.349     albertel 5044: table.LC_mail_list tr.LC_mail_replied {
                   5045:   background-color: $mail_replied;
                   5046: }
1.795     www      5047: 
1.349     albertel 5048: table.LC_mail_list tr.LC_mail_replied:hover {
                   5049:   background-color: $mail_replied_hover;
                   5050: }
1.795     www      5051: 
1.349     albertel 5052: table.LC_mail_list tr.LC_mail_other {
                   5053:   background-color: $mail_other;
                   5054: }
1.795     www      5055: 
1.349     albertel 5056: table.LC_mail_list tr.LC_mail_other:hover {
                   5057:   background-color: $mail_other_hover;
                   5058: }
1.494     raeburn  5059: 
1.777     tempelho 5060: table.LC_data_table tr > td.LC_browser_file,
                   5061: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5062:   background: #CCFF88;
                   5063: }
1.795     www      5064: 
1.777     tempelho 5065: table.LC_data_table tr > td.LC_browser_file_locked,
                   5066: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5067:   background: #FFAA99;
1.387     albertel 5068: }
1.795     www      5069: 
1.777     tempelho 5070: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5071:   background: #AAAAAA;
                   5072: }
1.795     www      5073: 
1.777     tempelho 5074: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5075: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5076:   background: #FFFF77;
1.777     tempelho 5077: }
1.795     www      5078: 
1.696     bisitz   5079: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5080:   background: #CCCCFF;
1.387     albertel 5081: }
1.696     bisitz   5082: 
1.707     bisitz   5083: table.LC_data_table tr > td.LC_roles_is {
                   5084: /*  background: #77FF77; */
                   5085: }
1.795     www      5086: 
1.707     bisitz   5087: table.LC_data_table tr > td.LC_roles_future {
                   5088:   background: #FFFF77;
                   5089: }
1.795     www      5090: 
1.707     bisitz   5091: table.LC_data_table tr > td.LC_roles_will {
                   5092:   background: #FFAA77;
                   5093: }
1.795     www      5094: 
1.707     bisitz   5095: table.LC_data_table tr > td.LC_roles_expired {
                   5096:   background: #FF7777;
                   5097: }
1.795     www      5098: 
1.707     bisitz   5099: table.LC_data_table tr > td.LC_roles_will_not {
                   5100:   background: #AAFF77;
                   5101: }
1.795     www      5102: 
1.707     bisitz   5103: table.LC_data_table tr > td.LC_roles_selected {
                   5104:   background: #11CC55;
                   5105: }
                   5106: 
1.388     albertel 5107: span.LC_current_location {
1.701     harmsja  5108:   font-size:larger;
1.388     albertel 5109:   background: $pgbg;
                   5110: }
1.387     albertel 5111: 
1.395     albertel 5112: span.LC_parm_menu_item {
                   5113:   font-size: larger;
                   5114:   font-family: $sans;
                   5115: }
1.795     www      5116: 
1.395     albertel 5117: span.LC_parm_scope_all {
                   5118:   color: red;
                   5119: }
1.795     www      5120: 
1.395     albertel 5121: span.LC_parm_scope_folder {
                   5122:   color: green;
                   5123: }
1.795     www      5124: 
1.395     albertel 5125: span.LC_parm_scope_resource {
                   5126:   color: orange;
                   5127: }
1.795     www      5128: 
1.395     albertel 5129: span.LC_parm_part {
                   5130:   color: blue;
                   5131: }
1.795     www      5132: 
1.395     albertel 5133: span.LC_parm_folder, span.LC_parm_symb {
                   5134:   font-size: x-small;
                   5135:   font-family: $mono;
                   5136:   color: #AAAAAA;
                   5137: }
                   5138: 
1.795     www      5139: td.LC_parm_overview_level_menu,
                   5140: td.LC_parm_overview_map_menu,
                   5141: td.LC_parm_overview_parm_selectors,
                   5142: td.LC_parm_overview_restrictions  {
1.396     albertel 5143:   border: 1px solid black;
                   5144:   border-collapse: collapse;
                   5145: }
1.795     www      5146: 
1.396     albertel 5147: table.LC_parm_overview_restrictions td {
                   5148:   border-width: 1px 4px 1px 4px;
                   5149:   border-style: solid;
                   5150:   border-color: $pgbg;
                   5151:   text-align: center;
                   5152: }
1.795     www      5153: 
1.396     albertel 5154: table.LC_parm_overview_restrictions th {
                   5155:   background: $tabbg;
                   5156:   border-width: 1px 4px 1px 4px;
                   5157:   border-style: solid;
                   5158:   border-color: $pgbg;
                   5159: }
1.795     www      5160: 
1.398     albertel 5161: table#LC_helpmenu {
1.803     bisitz   5162:   border: none;
1.398     albertel 5163:   height: 55px;
1.803     bisitz   5164:   border-spacing: 0;
1.398     albertel 5165: }
                   5166: 
                   5167: table#LC_helpmenu fieldset legend {
                   5168:   font-size: larger;
                   5169:   font-weight: bold;
                   5170: }
1.795     www      5171: 
1.397     albertel 5172: table#LC_helpmenu_links {
                   5173:   width: 100%;
                   5174:   border: 1px solid black;
                   5175:   background: $pgbg;
1.803     bisitz   5176:   padding: 0;
1.397     albertel 5177:   border-spacing: 1px;
                   5178: }
1.795     www      5179: 
1.397     albertel 5180: table#LC_helpmenu_links tr td {
                   5181:   padding: 1px;
                   5182:   background: $tabbg;
1.399     albertel 5183:   text-align: center;
                   5184:   font-weight: bold;
1.397     albertel 5185: }
1.396     albertel 5186: 
1.795     www      5187: table#LC_helpmenu_links a:link,
                   5188: table#LC_helpmenu_links a:visited,
1.397     albertel 5189: table#LC_helpmenu_links a:active {
                   5190:   text-decoration: none;
                   5191:   color: $font;
                   5192: }
1.795     www      5193: 
1.397     albertel 5194: table#LC_helpmenu_links a:hover {
                   5195:   text-decoration: underline;
                   5196:   color: $vlink;
                   5197: }
1.396     albertel 5198: 
1.417     albertel 5199: .LC_chrt_popup_exists {
                   5200:   border: 1px solid #339933;
                   5201:   margin: -1px;
                   5202: }
1.795     www      5203: 
1.417     albertel 5204: .LC_chrt_popup_up {
                   5205:   border: 1px solid yellow;
                   5206:   margin: -1px;
                   5207: }
1.795     www      5208: 
1.417     albertel 5209: .LC_chrt_popup {
                   5210:   border: 1px solid #8888FF;
                   5211:   background: #CCCCFF;
                   5212: }
1.795     www      5213: 
1.421     albertel 5214: table.LC_pick_box {
                   5215:   border-collapse: separate;
                   5216:   background: white;
                   5217:   border: 1px solid black;
                   5218:   border-spacing: 1px;
                   5219: }
1.795     www      5220: 
1.421     albertel 5221: table.LC_pick_box td.LC_pick_box_title {
                   5222:   background: $tabbg;
                   5223:   font-weight: bold;
                   5224:   text-align: right;
1.740     bisitz   5225:   vertical-align: top;
1.421     albertel 5226:   width: 184px;
                   5227:   padding: 8px;
                   5228: }
1.795     www      5229: 
1.645     raeburn  5230: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   5231:   background: $tabbg;
                   5232:   font-weight: bold;
                   5233:   text-align: right;
                   5234:   width: 350px;
                   5235:   padding: 8px;
                   5236: }
                   5237: 
1.579     raeburn  5238: table.LC_pick_box td.LC_pick_box_value {
                   5239:   text-align: left;
                   5240:   padding: 8px;
                   5241: }
1.795     www      5242: 
1.579     raeburn  5243: table.LC_pick_box td.LC_pick_box_select {
                   5244:   text-align: left;
                   5245:   padding: 8px;
                   5246: }
1.795     www      5247: 
1.424     albertel 5248: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5249:   padding: 0;
1.421     albertel 5250:   height: 1px;
                   5251:   background: black;
                   5252: }
1.795     www      5253: 
1.421     albertel 5254: table.LC_pick_box td.LC_pick_box_submit {
                   5255:   text-align: right;
                   5256: }
1.795     www      5257: 
1.579     raeburn  5258: table.LC_pick_box td.LC_evenrow_value {
                   5259:   text-align: left;
                   5260:   padding: 8px;
                   5261:   background-color: $data_table_light;
                   5262: }
1.795     www      5263: 
1.579     raeburn  5264: table.LC_pick_box td.LC_oddrow_value {
                   5265:   text-align: left;
                   5266:   padding: 8px;
                   5267:   background-color: $data_table_light;
                   5268: }
1.795     www      5269: 
1.579     raeburn  5270: table.LC_helpform_receipt {
                   5271:   width: 620px;
                   5272:   border-collapse: separate;
                   5273:   background: white;
                   5274:   border: 1px solid black;
                   5275:   border-spacing: 1px;
                   5276: }
1.795     www      5277: 
1.579     raeburn  5278: table.LC_helpform_receipt td.LC_pick_box_title {
                   5279:   background: $tabbg;
                   5280:   font-weight: bold;
                   5281:   text-align: right;
                   5282:   width: 184px;
                   5283:   padding: 8px;
                   5284: }
1.795     www      5285: 
1.579     raeburn  5286: table.LC_helpform_receipt td.LC_evenrow_value {
                   5287:   text-align: left;
                   5288:   padding: 8px;
                   5289:   background-color: $data_table_light;
                   5290: }
1.795     www      5291: 
1.579     raeburn  5292: table.LC_helpform_receipt td.LC_oddrow_value {
                   5293:   text-align: left;
                   5294:   padding: 8px;
                   5295:   background-color: $data_table_light;
                   5296: }
1.795     www      5297: 
1.579     raeburn  5298: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5299:   padding: 0;
1.579     raeburn  5300:   height: 1px;
                   5301:   background: black;
                   5302: }
1.795     www      5303: 
1.579     raeburn  5304: span.LC_helpform_receipt_cat {
                   5305:   font-weight: bold;
                   5306: }
1.795     www      5307: 
1.424     albertel 5308: table.LC_group_priv_box {
                   5309:   background: white;
                   5310:   border: 1px solid black;
                   5311:   border-spacing: 1px;
                   5312: }
1.795     www      5313: 
1.424     albertel 5314: table.LC_group_priv_box td.LC_pick_box_title {
                   5315:   background: $tabbg;
                   5316:   font-weight: bold;
                   5317:   text-align: right;
                   5318:   width: 184px;
                   5319: }
1.795     www      5320: 
1.424     albertel 5321: table.LC_group_priv_box td.LC_groups_fixed {
                   5322:   background: $data_table_light;
                   5323:   text-align: center;
                   5324: }
1.795     www      5325: 
1.424     albertel 5326: table.LC_group_priv_box td.LC_groups_optional {
                   5327:   background: $data_table_dark;
                   5328:   text-align: center;
                   5329: }
1.795     www      5330: 
1.424     albertel 5331: table.LC_group_priv_box td.LC_groups_functionality {
                   5332:   background: $data_table_darker;
                   5333:   text-align: center;
                   5334:   font-weight: bold;
                   5335: }
1.795     www      5336: 
1.424     albertel 5337: table.LC_group_priv td {
                   5338:   text-align: left;
1.803     bisitz   5339:   padding: 0;
1.424     albertel 5340: }
                   5341: 
1.421     albertel 5342: table.LC_notify_front_page {
                   5343:   background: white;
                   5344:   border: 1px solid black;
                   5345:   padding: 8px;
                   5346: }
1.795     www      5347: 
1.421     albertel 5348: table.LC_notify_front_page td {
                   5349:   padding: 8px;
                   5350: }
1.795     www      5351: 
1.424     albertel 5352: .LC_navbuttons {
                   5353:   margin: 2ex 0ex 2ex 0ex;
                   5354: }
1.795     www      5355: 
1.423     albertel 5356: .LC_topic_bar {
                   5357:   font-family: $sans;
                   5358:   font-weight: bold;
                   5359:   width: 100%;
                   5360:   background: $tabbg;
                   5361:   vertical-align: middle;
                   5362:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5363:   padding: 3px;
1.423     albertel 5364: }
1.795     www      5365: 
1.423     albertel 5366: .LC_topic_bar span {
                   5367:   vertical-align: middle;
                   5368: }
1.795     www      5369: 
1.423     albertel 5370: .LC_topic_bar img {
                   5371:   vertical-align: bottom;
                   5372: }
1.795     www      5373: 
1.423     albertel 5374: table.LC_course_group_status {
                   5375:   margin: 20px;
                   5376: }
1.795     www      5377: 
1.423     albertel 5378: table.LC_status_selector td {
                   5379:   vertical-align: top;
                   5380:   text-align: center;
1.424     albertel 5381:   padding: 4px;
                   5382: }
1.795     www      5383: 
1.599     albertel 5384: div.LC_feedback_link {
1.616     albertel 5385:   clear: both;
1.599     albertel 5386:   background: white;
1.779     bisitz   5387:   width: 100%;
1.489     raeburn  5388: }
1.795     www      5389: 
1.489     raeburn  5390: span.LC_feedback_link {
1.599     albertel 5391:   background: $feedback_link_bg;
                   5392:   font-size: larger;
                   5393: }
1.795     www      5394: 
1.599     albertel 5395: span.LC_message_link {
                   5396:   background: $feedback_link_bg;
                   5397:   font-size: larger;
                   5398:   position: absolute;
                   5399:   right: 1em;
1.489     raeburn  5400: }
1.421     albertel 5401: 
1.515     albertel 5402: table.LC_prior_tries {
1.524     albertel 5403:   border: 1px solid #000000;
                   5404:   border-collapse: separate;
                   5405:   border-spacing: 1px;
1.515     albertel 5406: }
1.523     albertel 5407: 
1.515     albertel 5408: table.LC_prior_tries td {
1.524     albertel 5409:   padding: 2px;
1.515     albertel 5410: }
1.523     albertel 5411: 
                   5412: .LC_answer_correct {
1.795     www      5413:   background: lightgreen;
                   5414:   font-family: $sans;
                   5415:   color: darkgreen;
                   5416:   padding: 6px;
1.523     albertel 5417: }
1.795     www      5418: 
1.523     albertel 5419: .LC_answer_charged_try {
1.797     www      5420:   background: #FFAAAA;
1.795     www      5421:   font-family: $sans;
                   5422:   color: darkred;
                   5423:   padding: 6px;
1.523     albertel 5424: }
1.795     www      5425: 
1.779     bisitz   5426: .LC_answer_not_charged_try,
1.523     albertel 5427: .LC_answer_no_grade,
                   5428: .LC_answer_late {
1.795     www      5429:   background: lightyellow;
                   5430:   font-family: $sans;
1.523     albertel 5431:   color: black;
1.795     www      5432:   padding: 6px;
1.523     albertel 5433: }
1.795     www      5434: 
1.523     albertel 5435: .LC_answer_previous {
1.795     www      5436:   background: lightblue;
                   5437:   font-family: $sans;
                   5438:   color: darkblue;
                   5439:   padding: 6px;
1.523     albertel 5440: }
1.795     www      5441: 
1.779     bisitz   5442: .LC_answer_no_message {
1.777     tempelho 5443:   background: #FFFFFF;
1.795     www      5444:   font-family: $sans;
1.777     tempelho 5445:   color: black;
1.795     www      5446:   padding: 6px;
1.779     bisitz   5447: }
1.795     www      5448: 
1.779     bisitz   5449: .LC_answer_unknown {
                   5450:   background: orange;
1.795     www      5451:   font-family: $sans;
1.779     bisitz   5452:   color: black;
1.795     www      5453:   padding: 6px;
1.777     tempelho 5454: }
1.795     www      5455: 
1.529     albertel 5456: span.LC_prior_numerical,
                   5457: span.LC_prior_string,
                   5458: span.LC_prior_custom,
                   5459: span.LC_prior_reaction,
                   5460: span.LC_prior_math {
1.523     albertel 5461:   font-family: monospace;
                   5462:   white-space: pre;
                   5463: }
                   5464: 
1.525     albertel 5465: span.LC_prior_string {
                   5466:   font-family: monospace;
                   5467:   white-space: pre;
                   5468: }
                   5469: 
1.523     albertel 5470: table.LC_prior_option {
                   5471:   width: 100%;
                   5472:   border-collapse: collapse;
                   5473: }
1.795     www      5474: 
                   5475: table.LC_prior_rank, 
                   5476: table.LC_prior_match {
1.528     albertel 5477:   border-collapse: collapse;
                   5478: }
1.795     www      5479: 
1.528     albertel 5480: table.LC_prior_option tr td,
                   5481: table.LC_prior_rank tr td,
                   5482: table.LC_prior_match tr td {
1.524     albertel 5483:   border: 1px solid #000000;
1.515     albertel 5484: }
                   5485: 
1.770     droeschl 5486: td.LC_nobreak,
1.519     raeburn  5487: span.LC_nobreak {
1.544     albertel 5488:   white-space: nowrap;
1.519     raeburn  5489: }
                   5490: 
1.576     raeburn  5491: span.LC_cusr_emph {
                   5492:   font-style: italic;
                   5493: }
                   5494: 
1.633     raeburn  5495: span.LC_cusr_subheading {
                   5496:   font-weight: normal;
                   5497:   font-size: 85%;
                   5498: }
                   5499: 
1.545     albertel 5500: table.LC_docs_documents {
                   5501:   background: #BBBBBB;
1.803     bisitz   5502:   border-width: 0;
1.545     albertel 5503:   border-collapse: collapse;
                   5504: }
1.795     www      5505: 
1.777     tempelho 5506: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5507:   border: 2px solid black;
                   5508:   padding: 4px;
1.777     tempelho 5509: }
1.795     www      5510: 
1.545     albertel 5511: .LC_docs_entry_move {
1.803     bisitz   5512:   border: none;
1.545     albertel 5513:   border-collapse: collapse;
1.544     albertel 5514: }
                   5515: 
1.545     albertel 5516: .LC_docs_entry_move td {
                   5517:   border: 2px solid #BBBBBB;
                   5518:   background: #DDDDDD;
                   5519: }
                   5520: 
                   5521: .LC_docs_editor td.LC_docs_entry_commands {
                   5522:   background: #DDDDDD;
                   5523:   font-size: x-small;
                   5524: }
1.795     www      5525: 
1.544     albertel 5526: .LC_docs_copy {
1.545     albertel 5527:   color: #000099;
1.544     albertel 5528: }
1.795     www      5529: 
1.544     albertel 5530: .LC_docs_cut {
1.545     albertel 5531:   color: #550044;
1.544     albertel 5532: }
1.795     www      5533: 
1.544     albertel 5534: .LC_docs_rename {
1.545     albertel 5535:   color: #009900;
1.544     albertel 5536: }
1.795     www      5537: 
1.544     albertel 5538: .LC_docs_remove {
1.545     albertel 5539:   color: #990000;
                   5540: }
                   5541: 
1.547     albertel 5542: .LC_docs_reinit_warn,
                   5543: .LC_docs_ext_edit {
                   5544:   font-size: x-small;
                   5545: }
                   5546: 
1.545     albertel 5547: .LC_docs_editor td.LC_docs_entry_title,
                   5548: .LC_docs_editor td.LC_docs_entry_icon {
                   5549:   background: #FFFFBB;
                   5550: }
1.795     www      5551: 
1.545     albertel 5552: .LC_docs_editor td.LC_docs_entry_parameter {
                   5553:   background: #BBBBFF;
                   5554:   font-size: x-small;
                   5555:   white-space: nowrap;
                   5556: }
                   5557: 
                   5558: table.LC_docs_adddocs td,
                   5559: table.LC_docs_adddocs th {
                   5560:   border: 1px solid #BBBBBB;
                   5561:   padding: 4px;
                   5562:   background: #DDDDDD;
1.543     albertel 5563: }
                   5564: 
1.584     albertel 5565: table.LC_sty_begin {
                   5566:   background: #BBFFBB;
                   5567: }
1.795     www      5568: 
1.584     albertel 5569: table.LC_sty_end {
                   5570:   background: #FFBBBB;
                   5571: }
                   5572: 
1.589     raeburn  5573: table.LC_double_column {
1.803     bisitz   5574:   border-width: 0;
1.589     raeburn  5575:   border-collapse: collapse;
                   5576:   width: 100%;
                   5577:   padding: 2px;
                   5578: }
                   5579: 
                   5580: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5581:   top: 2px;
1.589     raeburn  5582:   left: 2px;
                   5583:   width: 47%;
                   5584:   vertical-align: top;
                   5585: }
                   5586: 
                   5587: table.LC_double_column tr td.LC_right_col {
                   5588:   top: 2px;
1.779     bisitz   5589:   right: 2px;
1.589     raeburn  5590:   width: 47%;
                   5591:   vertical-align: top;
                   5592: }
                   5593: 
1.594     raeburn  5594: span.LC_role_level {
                   5595:   font-weight: bold;
                   5596: }
                   5597: 
1.591     raeburn  5598: div.LC_left_float {
                   5599:   float: left;
                   5600:   padding-right: 5%;
1.597     albertel 5601:   padding-bottom: 4px;
1.591     raeburn  5602: }
                   5603: 
                   5604: div.LC_clear_float_header {
1.597     albertel 5605:   padding-bottom: 2px;
1.591     raeburn  5606: }
                   5607: 
                   5608: div.LC_clear_float_footer {
1.597     albertel 5609:   padding-top: 10px;
1.591     raeburn  5610:   clear: both;
                   5611: }
                   5612: 
1.597     albertel 5613: div.LC_grade_show_user {
                   5614:   margin-top: 20px;
                   5615:   border: 1px solid black;
                   5616: }
1.795     www      5617: 
1.597     albertel 5618: div.LC_grade_user_name {
                   5619:   background: #DDDDEE;
                   5620:   border-bottom: 1px solid black;
1.705     tempelho 5621:   font-weight: bold;
                   5622:   font-size: large;
1.597     albertel 5623: }
1.795     www      5624: 
1.597     albertel 5625: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5626:   background: #DDEEDD;
                   5627: }
                   5628: 
                   5629: div.LC_grade_show_problem,
                   5630: div.LC_grade_submissions,
                   5631: div.LC_grade_message_center,
                   5632: div.LC_grade_info_links,
                   5633: div.LC_grade_assign {
                   5634:   margin: 5px;
                   5635:   width: 99%;
                   5636:   background: #FFFFFF;
                   5637: }
1.795     www      5638: 
1.597     albertel 5639: div.LC_grade_show_problem_header,
                   5640: div.LC_grade_submissions_header,
                   5641: div.LC_grade_message_center_header,
                   5642: div.LC_grade_assign_header {
1.705     tempelho 5643:   font-weight: bold;
                   5644:   font-size: large;
1.597     albertel 5645: }
1.795     www      5646: 
1.597     albertel 5647: div.LC_grade_show_problem_problem,
                   5648: div.LC_grade_submissions_body,
                   5649: div.LC_grade_message_center_body,
                   5650: div.LC_grade_assign_body {
                   5651:   border: 1px solid black;
                   5652:   width: 99%;
                   5653:   background: #FFFFFF;
                   5654: }
1.795     www      5655: 
1.598     albertel 5656: span.LC_grade_check_note {
1.705     tempelho 5657:   font-weight: normal;
                   5658:   font-size: medium;
1.598     albertel 5659:   display: inline;
                   5660:   position: absolute;
                   5661:   right: 1em;
                   5662: }
1.597     albertel 5663: 
1.613     albertel 5664: table.LC_scantron_action {
                   5665:   width: 100%;
                   5666: }
1.795     www      5667: 
1.613     albertel 5668: table.LC_scantron_action tr th {
1.698     harmsja  5669:   font-weight:bold;
                   5670:   font-style:normal;
1.613     albertel 5671: }
1.795     www      5672: 
1.779     bisitz   5673: .LC_edit_problem_header,
1.614     albertel 5674: div.LC_edit_problem_footer {
1.705     tempelho 5675:   font-weight: normal;
                   5676:   font-size:  medium;
1.602     albertel 5677:   margin: 2px;
1.600     albertel 5678: }
1.795     www      5679: 
1.600     albertel 5680: div.LC_edit_problem_header,
1.602     albertel 5681: div.LC_edit_problem_header div,
1.614     albertel 5682: div.LC_edit_problem_footer,
                   5683: div.LC_edit_problem_footer div,
1.602     albertel 5684: div.LC_edit_problem_editxml_header,
                   5685: div.LC_edit_problem_editxml_header div {
1.600     albertel 5686:   margin-top: 5px;
                   5687: }
1.795     www      5688: 
1.602     albertel 5689: div.LC_edit_problem_header_edit_row {
                   5690:   background: $tabbg;
                   5691:   padding: 3px;
                   5692:   margin-bottom: 5px;
                   5693: }
1.795     www      5694: 
1.600     albertel 5695: div.LC_edit_problem_header_title {
1.705     tempelho 5696:   font-weight: bold;
                   5697:   font-size: larger;
1.602     albertel 5698:   background: $tabbg;
                   5699:   padding: 3px;
                   5700: }
1.795     www      5701: 
1.602     albertel 5702: table.LC_edit_problem_header_title {
1.705     tempelho 5703:   font-size: larger;
                   5704:   font-weight:  bold;
1.602     albertel 5705:   width: 100%;
                   5706:   border-color: $pgbg;
                   5707:   border-style: solid;
                   5708:   border-width: $border;
1.600     albertel 5709:   background: $tabbg;
1.602     albertel 5710:   border-collapse: collapse;
1.803     bisitz   5711:   padding: 0;
1.602     albertel 5712: }
                   5713: 
                   5714: div.LC_edit_problem_discards {
                   5715:   float: left;
                   5716:   padding-bottom: 5px;
                   5717: }
1.795     www      5718: 
1.602     albertel 5719: div.LC_edit_problem_saves {
                   5720:   float: right;
                   5721:   padding-bottom: 5px;
1.600     albertel 5722: }
1.795     www      5723: 
1.600     albertel 5724: hr.LC_edit_problem_divide {
1.602     albertel 5725:   clear: both;
1.600     albertel 5726:   color: $tabbg;
                   5727:   background-color: $tabbg;
                   5728:   height: 3px;
1.803     bisitz   5729:   border: none;
1.600     albertel 5730: }
1.795     www      5731: 
1.679     riegler  5732: img.stift{
1.803     bisitz   5733:   border-width: 0;
                   5734:   vertical-align: middle;
1.677     riegler  5735: }
1.680     riegler  5736: 
1.681     riegler  5737: table#LC_mainmenu{
                   5738:  margin-top:10px;
                   5739:  width:80%;
                   5740: }
                   5741: 
1.680     riegler  5742: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5743:   vertical-align: top;
                   5744:   width: 45%;
                   5745: }
1.795     www      5746: 
1.779     bisitz   5747: .LC_mainmenu_fieldset_category {
                   5748:   color: $font;
                   5749:   background: $pgbg;
                   5750:   font-family: $sans;
                   5751:   font-size: small;
                   5752:   font-weight: bold;
1.777     tempelho 5753: }
1.795     www      5754: 
1.716     raeburn  5755: div.LC_createcourse {
                   5756:     margin: 10px 10px 10px 10px;
                   5757: }
                   5758: 
1.693     droeschl 5759: /* ---- Remove when done ----
                   5760: # The following styles is part of the redesign of LON-CAPA and are
                   5761: # subject to change during this project.
                   5762: # Don't rely on their current functionality as they might be 
                   5763: # changed or removed.
                   5764: # --------------------------*/
                   5765: 
1.698     harmsja  5766: a:hover,
1.721     harmsja  5767: ol.LC_smallMenu a:hover,
                   5768: ol#LC_MenuBreadcrumbs a:hover,
                   5769: ol#LC_PathBreadcrumbs a:hover,
                   5770: ul#LC_TabMainMenuContent a:hover,
                   5771: .LC_FormSectionClearButton input:hover
1.795     www      5772: ul.LC_TabContent   li:hover a {
1.698     harmsja  5773: 	color:#BF2317;
                   5774:         text-decoration:none;
1.693     droeschl 5775: }
                   5776: 
1.779     bisitz   5777: h1 {
1.813     bisitz   5778: 	padding: 0;
1.693     droeschl 5779: 	line-height:130%;
                   5780: }
1.698     harmsja  5781: 
1.795     www      5782: h2,h3,h4,h5,h6 {
1.803     bisitz   5783: 	margin: 5px 0 5px 0;
                   5784: 	padding: 0;
1.721     harmsja  5785: 	line-height:130%;
1.693     droeschl 5786: }
1.795     www      5787: 
                   5788: .LC_hcell {
1.698     harmsja  5789:         padding:3px 15px 3px 15px;
1.803     bisitz   5790:         margin: 0;
1.703     harmsja  5791: 	background-color:$tabbg;
1.801     tempelho 5792: 	color:$fontmenu;
1.779     bisitz   5793: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5794: }
1.795     www      5795: 
1.721     harmsja  5796: .LC_noBorder {
1.803     bisitz   5797:         border: 0;
1.698     harmsja  5798: }
1.693     droeschl 5799: 
                   5800: 
1.698     harmsja  5801: /* Main Header with discription of Person, Course, etc. */
1.693     droeschl 5802: 
1.761     tempelho 5803: .LC_Right {
                   5804:         float: right;
1.803     bisitz   5805:         margin: 0;
                   5806:         padding: 0;
1.761     tempelho 5807: }
                   5808: 
1.721     harmsja  5809: .LC_FormSectionClearButton input {
1.779     bisitz   5810:         background-color:transparent;
1.803     bisitz   5811:         border: none;
1.698     harmsja  5812:         cursor:pointer;
                   5813:         text-decoration:underline;
1.693     droeschl 5814: }
1.763     bisitz   5815: 
                   5816: .LC_help_open_topic {
                   5817:         color: #FFFFFF;
                   5818:         background-color: #EEEEFF;
                   5819:         margin: 1px;
                   5820:         padding: 4px;
                   5821:         border: 1px solid #000033;
                   5822:         white-space: nowrap;
1.783     amueller 5823: /*		vertical-align: middle; */
1.759     neumanie 5824: }
1.693     droeschl 5825: 
1.698     harmsja  5826: dl,ul,div,fieldset {
1.803     bisitz   5827: 	margin: 10px 10px 10px 0;
1.806     bisitz   5828: /*	overflow: hidden; */
1.693     droeschl 5829: }
1.795     www      5830: 
1.813     bisitz   5831: #LC_nav_bar {
1.807     droeschl 5832:     float: left;
                   5833:     margin: 0;
                   5834: }
                   5835: 
1.813     bisitz   5836: #LC_nav_bar em{
1.807     droeschl 5837:     font-weight: bold;
                   5838:     font-style: normal;
                   5839: }
                   5840: 
                   5841: ol.LC_smallMenu {
                   5842:     float: right;
                   5843: }
                   5844: 
1.721     harmsja  5845: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.803     bisitz   5846: 	margin: 0;
1.693     droeschl 5847: }
                   5848: 
1.721     harmsja  5849: ol.LC_smallMenu li {
1.693     droeschl 5850: 	display: inline;
1.803     bisitz   5851: 	padding: 5px 5px 0 10px;
1.693     droeschl 5852: 	vertical-align: top;
                   5853: }
                   5854: 
1.721     harmsja  5855: ol.LC_smallMenu li img {
1.693     droeschl 5856: 	vertical-align: bottom;
                   5857: }
                   5858: 
1.721     harmsja  5859: ol.LC_smallMenu a {
1.693     droeschl 5860: 	font-size: 90%;
                   5861: 	color: RGB(80, 80, 80);
                   5862: 	text-decoration: none;
                   5863: }
1.795     www      5864: 
1.808     droeschl 5865: ul#LC_TabMainMenuContent {
1.807     droeschl 5866:     clear: both;
1.808     droeschl 5867:     color: $fontmenu;
                   5868:     background: $tabbg;
                   5869:     list-style: none;
                   5870:     padding: 0;
                   5871:     margin: 0;
                   5872:     float:left;
                   5873:     width: 100%;
                   5874: }
                   5875: 
                   5876: ul#LC_TabMainMenuContent li {
                   5877:     float: left;
                   5878:     font-weight: bold;
                   5879:     line-height: 1.8em;
                   5880:     padding: 0 0.8em; 
                   5881:     border-right: 1px solid black;
                   5882:     display: inline;
                   5883:     vertical-align: middle;
1.807     droeschl 5884: }
                   5885: 
1.795     www      5886: ul.LC_TabContent ,
1.741     harmsja  5887: ul.LC_TabContentBigger {
1.721     harmsja  5888: 	display:block;
                   5889: 	list-style:none;
1.803     bisitz   5890: 	margin: 0;
                   5891: 	padding: 0;
1.693     droeschl 5892: }
                   5893: 
1.795     www      5894: ul.LC_TabContent li,
                   5895: ul.LC_TabContentBigger li {
1.693     droeschl 5896: 	display: inline;
1.741     harmsja  5897: 	border-right: solid 1px $lg_border_color;
                   5898: 	float:left;
                   5899: 	line-height:140%;
                   5900: 	white-space:nowrap;
                   5901: }
1.795     www      5902: 
1.808     droeschl 5903: ul#LC_TabMainMenuContent li a {
                   5904:     color: $fontmenu;
1.693     droeschl 5905: 	text-decoration: none;
                   5906: }
1.795     www      5907: 
1.721     harmsja  5908: ul.LC_TabContent {
1.741     harmsja  5909: 	min-height:1.6em;
1.721     harmsja  5910: }
1.795     www      5911: 
                   5912: ul.LC_TabContent li {
1.741     harmsja  5913: 	vertical-align:middle;
1.803     bisitz   5914: 	padding: 0 10px 0 10px;
1.745     ehlerst  5915: 	background-color:$tabbg;
                   5916: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5917: }
1.795     www      5918: 
                   5919: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5920: 	color:rgb(47,47,47);
                   5921: 	text-decoration:none;
                   5922: 	font-size:95%;
                   5923: 	font-weight:bold;
1.761     tempelho 5924: 	padding-right: 16px;
1.721     harmsja  5925: }
1.795     www      5926: 
                   5927: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5928:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745     ehlerst  5929: 	border-bottom:solid 1px #FFFFFF;
1.761     tempelho 5930: 	padding-right: 16px;
1.744     ehlerst  5931: }
1.795     www      5932: 
                   5933: ul.LC_TabContentBigger li {
1.741     harmsja  5934: 	vertical-align:bottom;
                   5935: 	border-top:solid 1px $lg_border_color;
                   5936: 	border-left:solid 1px $lg_border_color;
                   5937: 	padding:5px 10px 5px 10px;
                   5938: 	margin-left:2px;
                   5939: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
                   5940: }
1.795     www      5941: 
                   5942: ul.LC_TabContentBigger li:hover, 
                   5943: ul.LC_TabContentBigger li.active {
1.744     ehlerst  5944: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
                   5945: }
1.795     www      5946: 
                   5947: ul.LC_TabContentBigger li, 
                   5948: ul.LC_TabContentBigger li a {
1.741     harmsja  5949: 	font-size:110%;
                   5950: 	font-weight:bold;
                   5951: }
1.693     droeschl 5952: 
1.795     www      5953: ol#LC_MenuBreadcrumbs, 
                   5954: ol#LC_PathBreadcrumbs, 
                   5955: ul.LC_CourseBreadcrumbs {
1.693     droeschl 5956: 	padding-left: 10px;
1.819     tempelho 5957: 	margin: 0;
1.693     droeschl 5958: 	list-style-position: inside;
                   5959: }
                   5960: 
1.795     www      5961: ol#LC_MenuBreadcrumbs li, 
                   5962: ol#LC_PathBreadcrumbs li, 
                   5963: ul.LC_CourseBreadcrumbs li {
1.693     droeschl 5964: 	display: inline;
1.803     bisitz   5965: 	padding: 0 0 0 10px;
1.693     droeschl 5966: 	overflow:hidden;
                   5967: }
                   5968: 
1.783     amueller 5969: ol#LC_MenuBreadcrumbs li a, ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 5970: 	text-decoration: none;
                   5971: 	font-size:90%;
                   5972: }
1.795     www      5973: 
                   5974: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  5975: 	text-decoration:none;
                   5976: 	font-size:100%;
                   5977: 	font-weight:bold;
1.693     droeschl 5978: }
1.795     www      5979: 
                   5980: .LC_BoxPadding {
1.786     neumanie 5981: 	padding: 10px;
                   5982: }
1.795     www      5983: 
                   5984: .LC_ContentBoxSpecial {
1.701     harmsja  5985: 	border: solid 1px $lg_border_color;
1.746     neumanie 5986: }
1.795     www      5987: 
                   5988: .LC_ContentBoxSpecialContactInfo {
1.746     neumanie 5989: 	border: solid 1px $lg_border_color;
                   5990: 	max-width:25%;
                   5991: 	min-width:25%;
1.698     harmsja  5992: }
1.795     www      5993: 
                   5994: .LC_AboutMe_Image {
1.747     neumanie 5995: 	float:left;
                   5996: 	margin-right:10px;
                   5997: }
1.795     www      5998: 
                   5999: .LC_Clear_AboutMe_Image {
1.747     neumanie 6000: 	clear:left;
                   6001: }
1.795     www      6002: 
1.721     harmsja  6003: dl.LC_ListStyleClean dt {
1.693     droeschl 6004: 	padding-right: 5px;
                   6005: 	display: table-header-group;
                   6006: }
                   6007: 
1.721     harmsja  6008: dl.LC_ListStyleClean dd {
1.693     droeschl 6009: 	display: table-row;
                   6010: }
                   6011: 
1.721     harmsja  6012: .LC_ListStyleClean,
                   6013: .LC_ListStyleSimple,
                   6014: .LC_ListStyleNormal,
1.777     tempelho 6015: .LC_ListStyle_Border,
1.795     www      6016: .LC_ListStyleSpecial {
1.693     droeschl 6017: 	/*display:block;	*/
                   6018: 	list-style-position: inside;
                   6019: 	list-style-type: none;
                   6020: 	overflow: hidden;
1.803     bisitz   6021: 	padding: 0;
1.693     droeschl 6022: }
                   6023: 
1.721     harmsja  6024: .LC_ListStyleSimple li,
                   6025: .LC_ListStyleSimple dd,
                   6026: .LC_ListStyleNormal li,
                   6027: .LC_ListStyleNormal dd,
                   6028: .LC_ListStyleSpecial li,
1.795     www      6029: .LC_ListStyleSpecial dd {
1.803     bisitz   6030: 	margin: 0;
1.693     droeschl 6031: 	padding: 5px 5px 5px 10px;
                   6032: 	clear: both;
                   6033: }
                   6034: 
1.721     harmsja  6035: .LC_ListStyleClean li,
                   6036: .LC_ListStyleClean dd {
1.803     bisitz   6037: 	padding-top: 0;
                   6038: 	padding-bottom: 0;
1.693     droeschl 6039: }
                   6040: 
1.721     harmsja  6041: .LC_ListStyleSimple dd,
1.795     www      6042: .LC_ListStyleSimple li {
1.698     harmsja  6043: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6044: }
                   6045: 
1.721     harmsja  6046: .LC_ListStyleSpecial li,
                   6047: .LC_ListStyleSpecial dd {
1.693     droeschl 6048: 	list-style-type: none;
                   6049: 	background-color: RGB(220, 220, 220);
                   6050: 	margin-bottom: 4px;
                   6051: }
                   6052: 
1.721     harmsja  6053: table.LC_SimpleTable {
1.698     harmsja  6054: 	margin:5px;
                   6055: 	border:solid 1px $lg_border_color;
1.795     www      6056: }
1.693     droeschl 6057: 
1.721     harmsja  6058: table.LC_SimpleTable tr {
1.803     bisitz   6059: 	padding: 0;
1.698     harmsja  6060: 	border:solid 1px $lg_border_color;
1.693     droeschl 6061: }
1.795     www      6062: 
                   6063: table.LC_SimpleTable thead {
1.698     harmsja  6064: 	 background:rgb(220,220,220);
1.693     droeschl 6065: }
                   6066: 
1.721     harmsja  6067: div.LC_columnSection {
1.693     droeschl 6068: 	display: block;
                   6069: 	clear: both;
                   6070: 	overflow: hidden;
1.803     bisitz   6071: 	margin: 0;
1.693     droeschl 6072: }
                   6073: 
1.721     harmsja  6074: div.LC_columnSection>* {
1.693     droeschl 6075: 	float: left;
1.803     bisitz   6076: 	margin: 10px 20px 10px 0;
1.747     neumanie 6077: 	overflow:hidden;
1.693     droeschl 6078: }
1.721     harmsja  6079: 
1.795     www      6080: .ContentBoxSpecialTemplate {
1.747     neumanie 6081:         border: solid 1px $lg_border_color;
1.719     ehlerst  6082: }
1.795     www      6083: 
1.719     ehlerst  6084: .ContentBoxTemplate {
                   6085:         padding:10px;
                   6086: }
                   6087: 
1.721     harmsja  6088: div.LC_columnSection > .ContentBoxTemplate,
1.795     www      6089: div.LC_columnSection > .ContentBoxSpecialTemplate {
1.719     ehlerst  6090:         width: 600px;
                   6091: }
1.753     droeschl 6092: 
1.795     www      6093: .clear {
1.720     ehlerst  6094: 	clear: both;
1.803     bisitz   6095: 	line-height: 0;
                   6096: 	font-size: 0;
                   6097: 	height: 0;
1.720     ehlerst  6098: }
1.693     droeschl 6099: 
1.694     tempelho 6100: .LC_loginpage_container {
                   6101: 	text-align:left;
                   6102: 	margin : 0 auto;
1.785     tempelho 6103: 	width:90%;
1.694     tempelho 6104: 	padding: 10px;
                   6105: 	height: auto;
1.712     muellerd 6106: 	background-color:#FFFFFF;
1.694     tempelho 6107: 	border:1px solid #CCCCCC;
                   6108: }
                   6109: 
                   6110: 
                   6111: .LC_loginpage_loginContainer {
                   6112: 	float:left;
1.712     muellerd 6113: 	width: 182px;
1.785     tempelho 6114: 	padding: 2px;
1.712     muellerd 6115: 	border:1px solid #CCCCCC;
                   6116: 	background-color:$loginbg;
1.694     tempelho 6117: }
                   6118: 
1.795     www      6119: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6120: 	margin-top: 0;
1.712     muellerd 6121: 	display:block;
                   6122: 	background:$bgcol;
                   6123: 	color:$textcol;
                   6124: 	padding-left:5px;
                   6125: }
1.785     tempelho 6126: 
1.694     tempelho 6127: .LC_loginpage_loginInfo {
                   6128: 	float:left;
1.785     tempelho 6129: 	width:182px;
1.694     tempelho 6130: 	border:1px solid #CCCCCC;
1.785     tempelho 6131: 	padding:2px;
1.712     muellerd 6132: }
                   6133: 
1.694     tempelho 6134: .LC_loginpage_space {
1.754     droeschl 6135: 	clear: both;
                   6136: 	margin-bottom: 20px;
1.694     tempelho 6137: 	border-bottom: 1px solid #CCCCCC;
                   6138: }
                   6139: 
1.785     tempelho 6140: .LC_loginpage_floatLeft {
                   6141: 	float: left;
                   6142: 	width: 200px;
                   6143: 	margin: 0;
                   6144: }
                   6145: 
1.795     www      6146: table em {
1.754     droeschl 6147: 	font-weight: bold;
                   6148: 	font-style: normal;
1.748     schulted 6149: }
1.795     www      6150: 
1.779     bisitz   6151: table.LC_tableBrowseRes,
1.795     www      6152: table.LC_tableOfContent {
1.769     schulted 6153:         border:none;
                   6154: 	border-spacing: 1;
1.754     droeschl 6155: 	padding: 3px;
                   6156: 	background-color: #FFFFFF;
                   6157: 	font-size: 90%;
1.753     droeschl 6158: }
1.789     droeschl 6159: 
                   6160: table.LC_tableOfContent{
                   6161:     border-collapse: collapse;
                   6162: }
                   6163: 
1.771     droeschl 6164: table.LC_tableBrowseRes a,
1.768     schulted 6165: table.LC_tableOfContent a {
1.771     droeschl 6166:         background-color: transparent;
1.753     droeschl 6167: 	text-decoration: none;
                   6168: }
                   6169: 
1.771     droeschl 6170: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6171: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6172: 	background-color: #EEEEEE;
1.753     droeschl 6173: }
                   6174: 
1.795     www      6175: table.LC_tableOfContent img {
1.753     droeschl 6176: 	border: none;
                   6177: 	height: 1.3em;
                   6178: 	vertical-align: text-bottom;
                   6179: 	margin-right: 0.3em;
                   6180: }
1.757     schulted 6181: 
1.795     www      6182: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6183: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6184: }
                   6185: 
1.795     www      6186: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6187: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6188: }
                   6189: 
1.795     www      6190: a#LC_content_toolbar_closenav {
1.774     ehlerst  6191: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6192: }
                   6193: 
1.795     www      6194: a#LC_content_toolbar_everything {
1.774     ehlerst  6195: 	background-image:url(/res/adm/pages/show-all.gif);
                   6196: }
                   6197: 
1.795     www      6198: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6199: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6200: }
                   6201: 
1.795     www      6202: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6203: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6204: }
                   6205: 
1.795     www      6206: a#LC_content_toolbar_changefolder {
1.757     schulted 6207: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6208: }
                   6209: 
1.795     www      6210: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6211: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6212: }
                   6213: 
1.795     www      6214: ul#LC_toolbar li a:hover {
1.757     schulted 6215: 	background-position: bottom center;
                   6216: }
                   6217: 
1.795     www      6218: ul#LC_toolbar {
1.803     bisitz   6219: 	padding: 0;
1.757     schulted 6220: 	margin: 2px;
                   6221: 	list-style:none;
                   6222: 	position:relative;
                   6223: 	background-color:white;
                   6224: }
                   6225: 
1.795     www      6226: ul#LC_toolbar li {
1.757     schulted 6227: 	border:1px solid white;
1.803     bisitz   6228: 	padding: 0;
1.757     schulted 6229: 	margin: 0;
1.795     www      6230:         float: left;
1.767     droeschl 6231: 	display:inline;
1.757     schulted 6232: 	vertical-align:middle;
1.795     www      6233: } 
1.757     schulted 6234: 
1.783     amueller 6235: 
1.795     www      6236: a.LC_toolbarItem {
1.767     droeschl 6237: 	display:block;
1.803     bisitz   6238: 	padding: 0;
                   6239: 	margin: 0;
1.757     schulted 6240: 	height: 32px;
                   6241: 	width: 32px;
1.779     bisitz   6242: 	color:white;
1.803     bisitz   6243: 	border: none;
1.757     schulted 6244: 	background-repeat:no-repeat;
                   6245: 	background-color:transparent;
                   6246: }
                   6247: 
1.782     bisitz   6248: ul.LC_functionslist li {
                   6249:   float: left;
                   6250:   white-space: nowrap;
                   6251:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6252:   margin: 0 15px 15px 10px;
1.782     bisitz   6253: }
                   6254: 
1.757     schulted 6255: 
1.343     albertel 6256: END
                   6257: }
                   6258: 
1.306     albertel 6259: =pod
                   6260: 
                   6261: =item * &headtag()
                   6262: 
                   6263: Returns a uniform footer for LON-CAPA web pages.
                   6264: 
1.307     albertel 6265: Inputs: $title - optional title for the head
                   6266:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6267:         $args - optional arguments
1.319     albertel 6268:             force_register - if is true call registerurl so the remote is 
                   6269:                              informed
1.415     albertel 6270:             redirect       -> array ref of
                   6271:                                    1- seconds before redirect occurs
                   6272:                                    2- url to redirect to
                   6273:                                    3- whether the side effect should occur
1.315     albertel 6274:                            (side effect of setting 
                   6275:                                $env{'internal.head.redirect'} to the url 
                   6276:                                redirected too)
1.352     albertel 6277:             domain         -> force to color decorate a page for a specific
                   6278:                                domain
                   6279:             function       -> force usage of a specific rolish color scheme
                   6280:             bgcolor        -> override the default page bgcolor
1.460     albertel 6281:             no_auto_mt_title
                   6282:                            -> prevent &mt()ing the title arg
1.464     albertel 6283: 
1.306     albertel 6284: =cut
                   6285: 
                   6286: sub headtag {
1.313     albertel 6287:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6288:     
1.363     albertel 6289:     my $function = $args->{'function'} || &get_users_function();
                   6290:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6291:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6292:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6293: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6294: 		   #time(),
1.418     albertel 6295: 		   $env{'environment.color.timestamp'},
1.363     albertel 6296: 		   $function,$domain,$bgcolor);
                   6297: 
1.369     www      6298:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6299: 
1.308     albertel 6300:     my $result =
                   6301: 	'<head>'.
1.461     albertel 6302: 	&font_settings();
1.319     albertel 6303: 
1.461     albertel 6304:     if (!$args->{'frameset'}) {
                   6305: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6306:     }
1.319     albertel 6307:     if ($args->{'force_register'}) {
                   6308: 	$result .= &Apache::lonmenu::registerurl(1);
                   6309:     }
1.436     albertel 6310:     if (!$args->{'no_nav_bar'} 
                   6311: 	&& !$args->{'only_body'}
                   6312: 	&& !$args->{'frameset'}) {
                   6313: 	$result .= &help_menu_js();
                   6314:     }
1.319     albertel 6315: 
1.314     albertel 6316:     if (ref($args->{'redirect'})) {
1.414     albertel 6317: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6318: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6319: 	if (!$inhibit_continue) {
                   6320: 	    $env{'internal.head.redirect'} = $url;
                   6321: 	}
1.313     albertel 6322: 	$result.=<<ADDMETA
                   6323: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6324: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6325: ADDMETA
                   6326:     }
1.306     albertel 6327:     if (!defined($title)) {
                   6328: 	$title = 'The LearningOnline Network with CAPA';
                   6329:     }
1.460     albertel 6330:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6331:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6332: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6333: 	.$head_extra;
1.306     albertel 6334:     return $result;
                   6335: }
                   6336: 
                   6337: =pod
                   6338: 
1.340     albertel 6339: =item * &font_settings()
                   6340: 
                   6341: Returns neccessary <meta> to set the proper encoding
                   6342: 
                   6343: Inputs: none
                   6344: 
                   6345: =cut
                   6346: 
                   6347: sub font_settings {
                   6348:     my $headerstring='';
1.647     www      6349:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6350: 	$headerstring.=
                   6351: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6352:     }
                   6353:     return $headerstring;
                   6354: }
                   6355: 
1.341     albertel 6356: =pod
                   6357: 
                   6358: =item * &xml_begin()
                   6359: 
                   6360: Returns the needed doctype and <html>
                   6361: 
                   6362: Inputs: none
                   6363: 
                   6364: =cut
                   6365: 
                   6366: sub xml_begin {
                   6367:     my $output='';
                   6368: 
1.592     albertel 6369:     if ($env{'internal.start_page'}==1) {
                   6370: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6371:     }
1.342     albertel 6372: 
1.341     albertel 6373:     if ($env{'browser.mathml'}) {
                   6374: 	$output='<?xml version="1.0"?>'
                   6375:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6376: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6377:             
                   6378: #	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
                   6379: 	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
                   6380:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6381: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6382:     } else {
                   6383: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   6384:     }
                   6385:     return $output;
                   6386: }
1.340     albertel 6387: 
                   6388: =pod
                   6389: 
1.306     albertel 6390: =item * &endheadtag()
                   6391: 
                   6392: Returns a uniform </head> for LON-CAPA web pages.
                   6393: 
                   6394: Inputs: none
                   6395: 
                   6396: =cut
                   6397: 
                   6398: sub endheadtag {
                   6399:     return '</head>';
                   6400: }
                   6401: 
                   6402: =pod
                   6403: 
                   6404: =item * &head()
                   6405: 
                   6406: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6407: 
1.648     raeburn  6408: Inputs:
                   6409: 
                   6410: =over 4
                   6411: 
                   6412: $title - optional title for the page
                   6413: 
                   6414: $head_extra - optional extra HTML to put inside the <head>
                   6415: 
                   6416: =back
1.405     albertel 6417: 
1.306     albertel 6418: =cut
                   6419: 
                   6420: sub head {
1.325     albertel 6421:     my ($title,$head_extra,$args) = @_;
                   6422:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6423: }
                   6424: 
                   6425: =pod
                   6426: 
                   6427: =item * &start_page()
                   6428: 
                   6429: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6430: 
1.648     raeburn  6431: Inputs:
                   6432: 
                   6433: =over 4
                   6434: 
                   6435: $title - optional title for the page
                   6436: 
                   6437: $head_extra - optional extra HTML to incude inside the <head>
                   6438: 
                   6439: $args - additional optional args supported are:
                   6440: 
                   6441: =over 8
                   6442: 
                   6443:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6444:                                     arg on
1.814     bisitz   6445:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6446:              add_entries    -> additional attributes to add to the  <body>
                   6447:              domain         -> force to color decorate a page for a 
1.317     albertel 6448:                                     specific domain
1.648     raeburn  6449:              function       -> force usage of a specific rolish color
1.317     albertel 6450:                                     scheme
1.648     raeburn  6451:              redirect       -> see &headtag()
                   6452:              bgcolor        -> override the default page bg color
                   6453:              js_ready       -> return a string ready for being used in 
1.317     albertel 6454:                                     a javascript writeln
1.648     raeburn  6455:              html_encode    -> return a string ready for being used in 
1.320     albertel 6456:                                     a html attribute
1.648     raeburn  6457:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6458:                                     $forcereg arg
1.648     raeburn  6459:              body_title     -> alternate text to use instead of $title
1.326     albertel 6460:                                     in the title box that appears, this text
                   6461:                                     is not auto translated like the $title is
1.648     raeburn  6462:              frameset       -> if true will start with a <frameset>
1.330     albertel 6463:                                     rather than <body>
1.648     raeburn  6464:              skip_phases    -> hash ref of 
1.338     albertel 6465:                                     head -> skip the <html><head> generation
                   6466:                                     body -> skip all <body> generation
1.648     raeburn  6467:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6468:                                     'Switch To Inline Menu' link
1.648     raeburn  6469:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6470:              inherit_jsmath -> when creating popup window in a page,
                   6471:                                     should it have jsmath forced on by the
                   6472:                                     current page
1.361     albertel 6473: 
1.648     raeburn  6474: =back
1.460     albertel 6475: 
1.648     raeburn  6476: =back
1.562     albertel 6477: 
1.306     albertel 6478: =cut
                   6479: 
                   6480: sub start_page {
1.309     albertel 6481:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6482:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6483:     my %head_args;
1.352     albertel 6484:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6485: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6486: 		     'no_auto_mt_title') {
1.319     albertel 6487: 	if (defined($args->{$arg})) {
1.324     raeburn  6488: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6489: 	}
1.313     albertel 6490:     }
1.319     albertel 6491: 
1.315     albertel 6492:     $env{'internal.start_page'}++;
1.338     albertel 6493:     my $result;
                   6494:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6495: 	$result.=
1.341     albertel 6496: 	    &xml_begin().
1.338     albertel 6497: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6498:     }
                   6499:     
                   6500:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6501: 	if ($args->{'frameset'}) {
                   6502: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6503: 						$args->{'add_entries'});
                   6504: 	    $result .= "\n<frameset $attr_string>\n";
                   6505: 	} else {
                   6506: 	    $result .=
                   6507: 		&bodytag($title, 
                   6508: 			 $args->{'function'},       $args->{'add_entries'},
                   6509: 			 $args->{'only_body'},      $args->{'domain'},
                   6510: 			 $args->{'force_register'}, $args->{'body_title'},
                   6511: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.816     bisitz   6512: 			 $args->{'no_inline_link'},
1.460     albertel 6513: 			 $args);
1.338     albertel 6514: 	}
1.330     albertel 6515:     }
1.338     albertel 6516: 
1.315     albertel 6517:     if ($args->{'js_ready'}) {
1.713     kaisler  6518: 		$result = &js_ready($result);
1.315     albertel 6519:     }
1.320     albertel 6520:     if ($args->{'html_encode'}) {
1.713     kaisler  6521: 		$result = &html_encode($result);
                   6522:     }
                   6523: 
1.813     bisitz   6524:     # Preparation for new and consistent functionlist at top of screen
                   6525:     # if ($args->{'functionlist'}) {
                   6526:     #            $result .= &build_functionlist();
                   6527:     #}
                   6528: 
                   6529:     # Don't add anything more if only_body wanted
                   6530:     return $result if $args->{'only_body'};
                   6531: 
                   6532:     #Breadcrumbs
1.758     kaisler  6533:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6534: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6535: 		#if any br links exists, add them to the breadcrumbs
                   6536: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6537: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6538: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6539: 			}
                   6540: 		}
                   6541: 
                   6542: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6543: 		if(exists($args->{'bread_crumbs_component'})){
                   6544: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6545: 		}else{
                   6546: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6547: 		}
1.320     albertel 6548:     }
1.315     albertel 6549:     return $result;
1.306     albertel 6550: }
                   6551: 
1.330     albertel 6552: 
1.306     albertel 6553: =pod
                   6554: 
                   6555: =item * &head()
                   6556: 
                   6557: Returns a complete </body></html> section for LON-CAPA web pages.
                   6558: 
1.315     albertel 6559: Inputs:         $args - additional optional args supported are:
                   6560:                  js_ready     -> return a string ready for being used in 
                   6561:                                  a javascript writeln
1.320     albertel 6562:                  html_encode  -> return a string ready for being used in 
                   6563:                                  a html attribute
1.330     albertel 6564:                  frameset     -> if true will start with a <frameset>
                   6565:                                  rather than <body>
1.493     albertel 6566:                  dicsussion   -> if true will get discussion from
                   6567:                                   lonxml::xmlend
                   6568:                                  (you can pass the target and parser arguments
                   6569:                                   through optional 'target' and 'parser' args
                   6570:                                   to this routine)
1.306     albertel 6571: 
                   6572: =cut
                   6573: 
                   6574: sub end_page {
1.315     albertel 6575:     my ($args) = @_;
                   6576:     $env{'internal.end_page'}++;
1.330     albertel 6577:     my $result;
1.335     albertel 6578:     if ($args->{'discussion'}) {
                   6579: 	my ($target,$parser);
                   6580: 	if (ref($args->{'discussion'})) {
                   6581: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6582: 				$args->{'discussion'}{'parser'});
                   6583: 	}
                   6584: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6585:     }
                   6586: 
1.330     albertel 6587:     if ($args->{'frameset'}) {
                   6588: 	$result .= '</frameset>';
                   6589:     } else {
1.635     raeburn  6590: 	$result .= &endbodytag($args);
1.330     albertel 6591:     }
                   6592:     $result .= "\n</html>";
                   6593: 
1.315     albertel 6594:     if ($args->{'js_ready'}) {
1.317     albertel 6595: 	$result = &js_ready($result);
1.315     albertel 6596:     }
1.335     albertel 6597: 
1.320     albertel 6598:     if ($args->{'html_encode'}) {
                   6599: 	$result = &html_encode($result);
                   6600:     }
1.335     albertel 6601: 
1.315     albertel 6602:     return $result;
                   6603: }
                   6604: 
1.320     albertel 6605: sub html_encode {
                   6606:     my ($result) = @_;
                   6607: 
1.322     albertel 6608:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6609:     
                   6610:     return $result;
                   6611: }
1.317     albertel 6612: sub js_ready {
                   6613:     my ($result) = @_;
                   6614: 
1.323     albertel 6615:     $result =~ s/[\n\r]/ /xmsg;
                   6616:     $result =~ s/\\/\\\\/xmsg;
                   6617:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6618:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6619:     
                   6620:     return $result;
                   6621: }
                   6622: 
1.315     albertel 6623: sub validate_page {
                   6624:     if (  exists($env{'internal.start_page'})
1.316     albertel 6625: 	  &&     $env{'internal.start_page'} > 1) {
                   6626: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6627: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6628: 				 $ENV{'request.filename'});
1.315     albertel 6629:     }
                   6630:     if (  exists($env{'internal.end_page'})
1.316     albertel 6631: 	  &&     $env{'internal.end_page'} > 1) {
                   6632: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6633: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6634: 				 $env{'request.filename'});
1.315     albertel 6635:     }
                   6636:     if (     exists($env{'internal.start_page'})
                   6637: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6638: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6639: 				 $env{'request.filename'});
1.315     albertel 6640:     }
                   6641:     if (   ! exists($env{'internal.start_page'})
                   6642: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6643: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6644: 				 $env{'request.filename'});
1.315     albertel 6645:     }
1.306     albertel 6646: }
1.315     albertel 6647: 
1.318     albertel 6648: sub simple_error_page {
                   6649:     my ($r,$title,$msg) = @_;
                   6650:     my $page =
                   6651: 	&Apache::loncommon::start_page($title).
                   6652: 	&mt($msg).
                   6653: 	&Apache::loncommon::end_page();
                   6654:     if (ref($r)) {
                   6655: 	$r->print($page);
1.327     albertel 6656: 	return;
1.318     albertel 6657:     }
                   6658:     return $page;
                   6659: }
1.347     albertel 6660: 
                   6661: {
1.610     albertel 6662:     my @row_count;
1.347     albertel 6663:     sub start_data_table {
1.422     albertel 6664: 	my ($add_class) = @_;
                   6665: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6666: 	unshift(@row_count,0);
1.422     albertel 6667: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6668:     }
                   6669: 
                   6670:     sub end_data_table {
1.610     albertel 6671: 	shift(@row_count);
1.389     albertel 6672: 	return '</table>'."\n";;
1.347     albertel 6673:     }
                   6674: 
                   6675:     sub start_data_table_row {
1.422     albertel 6676: 	my ($add_class) = @_;
1.610     albertel 6677: 	$row_count[0]++;
                   6678: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6679: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6680: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6681:     }
1.471     banghart 6682:     
                   6683:     sub continue_data_table_row {
                   6684: 	my ($add_class) = @_;
1.610     albertel 6685: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6686: 	$css_class = (join(' ',$css_class,$add_class));
                   6687: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6688:     }
1.347     albertel 6689: 
                   6690:     sub end_data_table_row {
1.389     albertel 6691: 	return '</tr>'."\n";;
1.347     albertel 6692:     }
1.367     www      6693: 
1.421     albertel 6694:     sub start_data_table_empty_row {
1.707     bisitz   6695: #	$row_count[0]++;
1.421     albertel 6696: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6697:     }
                   6698: 
                   6699:     sub end_data_table_empty_row {
                   6700: 	return '</tr>'."\n";;
                   6701:     }
                   6702: 
1.367     www      6703:     sub start_data_table_header_row {
1.389     albertel 6704: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6705:     }
                   6706: 
                   6707:     sub end_data_table_header_row {
1.389     albertel 6708: 	return '</tr>'."\n";;
1.367     www      6709:     }
1.347     albertel 6710: }
                   6711: 
1.548     albertel 6712: =pod
                   6713: 
                   6714: =item * &inhibit_menu_check($arg)
                   6715: 
                   6716: Checks for a inhibitmenu state and generates output to preserve it
                   6717: 
                   6718: Inputs:         $arg - can be any of
                   6719:                      - undef - in which case the return value is a string 
                   6720:                                to add  into arguments list of a uri
                   6721:                      - 'input' - in which case the return value is a HTML
                   6722:                                  <form> <input> field of type hidden to
                   6723:                                  preserve the value
                   6724:                      - a url - in which case the return value is the url with
                   6725:                                the neccesary cgi args added to preserve the
                   6726:                                inhibitmenu state
                   6727:                      - a ref to a url - no return value, but the string is
                   6728:                                         updated to include the neccessary cgi
                   6729:                                         args to preserve the inhibitmenu state
                   6730: 
                   6731: =cut
                   6732: 
                   6733: sub inhibit_menu_check {
                   6734:     my ($arg) = @_;
                   6735:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6736:     if ($arg eq 'input') {
                   6737: 	if ($env{'form.inhibitmenu'}) {
                   6738: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6739: 	} else {
                   6740: 	    return
                   6741: 	}
                   6742:     }
                   6743:     if ($env{'form.inhibitmenu'}) {
                   6744: 	if (ref($arg)) {
                   6745: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6746: 	} elsif ($arg eq '') {
                   6747: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6748: 	} else {
                   6749: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6750: 	}
                   6751:     }
                   6752:     if (!ref($arg)) {
                   6753: 	return $arg;
                   6754:     }
                   6755: }
                   6756: 
1.251     albertel 6757: ###############################################
1.182     matthew  6758: 
                   6759: =pod
                   6760: 
1.549     albertel 6761: =back
                   6762: 
                   6763: =head1 User Information Routines
                   6764: 
                   6765: =over 4
                   6766: 
1.405     albertel 6767: =item * &get_users_function()
1.182     matthew  6768: 
                   6769: Used by &bodytag to determine the current users primary role.
                   6770: Returns either 'student','coordinator','admin', or 'author'.
                   6771: 
                   6772: =cut
                   6773: 
                   6774: ###############################################
                   6775: sub get_users_function {
1.815     tempelho 6776:     my $function = 'norole';
1.818     tempelho 6777:     if ($env{'request.role'}=~/^(st)/) {
                   6778:         $function='student';
                   6779:     }
1.258     albertel 6780:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6781:         $function='coordinator';
                   6782:     }
1.258     albertel 6783:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6784:         $function='admin';
                   6785:     }
1.258     albertel 6786:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  6787:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6788:         $function='author';
                   6789:     }
                   6790:     return $function;
1.54      www      6791: }
1.99      www      6792: 
                   6793: ###############################################
                   6794: 
1.233     raeburn  6795: =pod
                   6796: 
1.542     raeburn  6797: =item * &check_user_status()
1.274     raeburn  6798: 
                   6799: Determines current status of supplied role for a
                   6800: specific user. Roles can be active, previous or future.
                   6801: 
                   6802: Inputs: 
                   6803: user's domain, user's username, course's domain,
1.375     raeburn  6804: course's number, optional section ID.
1.274     raeburn  6805: 
                   6806: Outputs:
                   6807: role status: active, previous or future. 
                   6808: 
                   6809: =cut
                   6810: 
                   6811: sub check_user_status {
1.412     raeburn  6812:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6813:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6814:     my @uroles = keys %userinfo;
                   6815:     my $srchstr;
                   6816:     my $active_chk = 'none';
1.412     raeburn  6817:     my $now = time;
1.274     raeburn  6818:     if (@uroles > 0) {
1.412     raeburn  6819:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6820:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6821:         } else {
1.412     raeburn  6822:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6823:         }
                   6824:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6825:             my $role_end = 0;
                   6826:             my $role_start = 0;
                   6827:             $active_chk = 'active';
1.412     raeburn  6828:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6829:                 $role_end = $1;
                   6830:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6831:                     $role_start = $1;
1.274     raeburn  6832:                 }
                   6833:             }
                   6834:             if ($role_start > 0) {
1.412     raeburn  6835:                 if ($now < $role_start) {
1.274     raeburn  6836:                     $active_chk = 'future';
                   6837:                 }
                   6838:             }
                   6839:             if ($role_end > 0) {
1.412     raeburn  6840:                 if ($now > $role_end) {
1.274     raeburn  6841:                     $active_chk = 'previous';
                   6842:                 }
                   6843:             }
                   6844:         }
                   6845:     }
                   6846:     return $active_chk;
                   6847: }
                   6848: 
                   6849: ###############################################
                   6850: 
                   6851: =pod
                   6852: 
1.405     albertel 6853: =item * &get_sections()
1.233     raeburn  6854: 
                   6855: Determines all the sections for a course including
                   6856: sections with students and sections containing other roles.
1.419     raeburn  6857: Incoming parameters: 
                   6858: 
                   6859: 1. domain
                   6860: 2. course number 
                   6861: 3. reference to array containing roles for which sections should 
                   6862: be gathered (optional).
                   6863: 4. reference to array containing status types for which sections 
                   6864: should be gathered (optional).
                   6865: 
                   6866: If the third argument is undefined, sections are gathered for any role. 
                   6867: If the fourth argument is undefined, sections are gathered for any status.
                   6868: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6869:  
1.374     raeburn  6870: Returns section hash (keys are section IDs, values are
                   6871: number of users in each section), subject to the
1.419     raeburn  6872: optional roles filter, optional status filter 
1.233     raeburn  6873: 
                   6874: =cut
                   6875: 
                   6876: ###############################################
                   6877: sub get_sections {
1.419     raeburn  6878:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6879:     if (!defined($cdom) || !defined($cnum)) {
                   6880:         my $cid =  $env{'request.course.id'};
                   6881: 
                   6882: 	return if (!defined($cid));
                   6883: 
                   6884:         $cdom = $env{'course.'.$cid.'.domain'};
                   6885:         $cnum = $env{'course.'.$cid.'.num'};
                   6886:     }
                   6887: 
                   6888:     my %sectioncount;
1.419     raeburn  6889:     my $now = time;
1.240     albertel 6890: 
1.366     albertel 6891:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6892: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6893: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6894: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6895:         my $start_index = &Apache::loncoursedata::CL_START();
                   6896:         my $end_index = &Apache::loncoursedata::CL_END();
                   6897:         my $status;
1.366     albertel 6898: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6899: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6900: 				                     $data->[$status_index],
                   6901:                                                      $data->[$start_index],
                   6902:                                                      $data->[$end_index]);
                   6903:             if ($stu_status eq 'Active') {
                   6904:                 $status = 'active';
                   6905:             } elsif ($end < $now) {
                   6906:                 $status = 'previous';
                   6907:             } elsif ($start > $now) {
                   6908:                 $status = 'future';
                   6909:             } 
                   6910: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6911:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6912:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6913: 		    $sectioncount{$section}++;
                   6914:                 }
1.240     albertel 6915: 	    }
                   6916: 	}
                   6917:     }
                   6918:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6919:     foreach my $user (sort(keys(%courseroles))) {
                   6920: 	if ($user !~ /^(\w{2})/) { next; }
                   6921: 	my ($role) = ($user =~ /^(\w{2})/);
                   6922: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6923: 	my ($section,$status);
1.240     albertel 6924: 	if ($role eq 'cr' &&
                   6925: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6926: 	    $section=$1;
                   6927: 	}
                   6928: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6929: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  6930:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   6931:         if ($end == -1 && $start == -1) {
                   6932:             next; #deleted role
                   6933:         }
                   6934:         if (!defined($possible_status)) { 
                   6935:             $sectioncount{$section}++;
                   6936:         } else {
                   6937:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   6938:                 $status = 'active';
                   6939:             } elsif ($end < $now) {
                   6940:                 $status = 'future';
                   6941:             } elsif ($start > $now) {
                   6942:                 $status = 'previous';
                   6943:             }
                   6944:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   6945:                 $sectioncount{$section}++;
                   6946:             }
                   6947:         }
1.233     raeburn  6948:     }
1.366     albertel 6949:     return %sectioncount;
1.233     raeburn  6950: }
                   6951: 
1.274     raeburn  6952: ###############################################
1.294     raeburn  6953: 
                   6954: =pod
1.405     albertel 6955: 
                   6956: =item * &get_course_users()
                   6957: 
1.275     raeburn  6958: Retrieves usernames:domains for users in the specified course
                   6959: with specific role(s), and access status. 
                   6960: 
                   6961: Incoming parameters:
1.277     albertel 6962: 1. course domain
                   6963: 2. course number
                   6964: 3. access status: users must have - either active, 
1.275     raeburn  6965: previous, future, or all.
1.277     albertel 6966: 4. reference to array of permissible roles
1.288     raeburn  6967: 5. reference to array of section restrictions (optional)
                   6968: 6. reference to results object (hash of hashes).
                   6969: 7. reference to optional userdata hash
1.609     raeburn  6970: 8. reference to optional statushash
1.630     raeburn  6971: 9. flag if privileged users (except those set to unhide in
                   6972:    course settings) should be excluded    
1.609     raeburn  6973: Keys of top level results hash are roles.
1.275     raeburn  6974: Keys of inner hashes are username:domain, with 
                   6975: values set to access type.
1.288     raeburn  6976: Optional userdata hash returns an array with arguments in the 
                   6977: same order as loncoursedata::get_classlist() for student data.
                   6978: 
1.609     raeburn  6979: Optional statushash returns
                   6980: 
1.288     raeburn  6981: Entries for end, start, section and status are blank because
                   6982: of the possibility of multiple values for non-student roles.
                   6983: 
1.275     raeburn  6984: =cut
1.405     albertel 6985: 
1.275     raeburn  6986: ###############################################
1.405     albertel 6987: 
1.275     raeburn  6988: sub get_course_users {
1.630     raeburn  6989:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  6990:     my %idx = ();
1.419     raeburn  6991:     my %seclists;
1.288     raeburn  6992: 
                   6993:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   6994:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   6995:     $idx{end} = &Apache::loncoursedata::CL_END();
                   6996:     $idx{start} = &Apache::loncoursedata::CL_START();
                   6997:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   6998:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   6999:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7000:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7001: 
1.290     albertel 7002:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7003:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7004:         my $now = time;
1.277     albertel 7005:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7006:             my $match = 0;
1.412     raeburn  7007:             my $secmatch = 0;
1.419     raeburn  7008:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7009:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7010:             if ($section eq '') {
                   7011:                 $section = 'none';
                   7012:             }
1.291     albertel 7013:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7014:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7015:                     $secmatch = 1;
                   7016:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7017:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7018:                         $secmatch = 1;
                   7019:                     }
                   7020:                 } else {  
1.419     raeburn  7021: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7022: 		        $secmatch = 1;
                   7023:                     }
1.290     albertel 7024: 		}
1.412     raeburn  7025:                 if (!$secmatch) {
                   7026:                     next;
                   7027:                 }
1.419     raeburn  7028:             }
1.275     raeburn  7029:             if (defined($$types{'active'})) {
1.288     raeburn  7030:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7031:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7032:                     $match = 1;
1.275     raeburn  7033:                 }
                   7034:             }
                   7035:             if (defined($$types{'previous'})) {
1.609     raeburn  7036:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7037:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7038:                     $match = 1;
1.275     raeburn  7039:                 }
                   7040:             }
                   7041:             if (defined($$types{'future'})) {
1.609     raeburn  7042:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7043:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7044:                     $match = 1;
1.275     raeburn  7045:                 }
                   7046:             }
1.609     raeburn  7047:             if ($match) {
                   7048:                 push(@{$seclists{$student}},$section);
                   7049:                 if (ref($userdata) eq 'HASH') {
                   7050:                     $$userdata{$student} = $$classlist{$student};
                   7051:                 }
                   7052:                 if (ref($statushash) eq 'HASH') {
                   7053:                     $statushash->{$student}{'st'}{$section} = $status;
                   7054:                 }
1.288     raeburn  7055:             }
1.275     raeburn  7056:         }
                   7057:     }
1.412     raeburn  7058:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7059:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7060:         my $now = time;
1.609     raeburn  7061:         my %displaystatus = ( previous => 'Expired',
                   7062:                               active   => 'Active',
                   7063:                               future   => 'Future',
                   7064:                             );
1.630     raeburn  7065:         my %nothide;
                   7066:         if ($hidepriv) {
                   7067:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7068:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7069:                 if ($user !~ /:/) {
                   7070:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7071:                 } else {
                   7072:                     $nothide{$user} = 1;
                   7073:                 }
                   7074:             }
                   7075:         }
1.439     raeburn  7076:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7077:             my $match = 0;
1.412     raeburn  7078:             my $secmatch = 0;
1.439     raeburn  7079:             my $status;
1.412     raeburn  7080:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7081:             $user =~ s/:$//;
1.439     raeburn  7082:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7083:             if ($end == -1 || $start == -1) {
                   7084:                 next;
                   7085:             }
                   7086:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7087:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7088:                 my ($uname,$udom) = split(/:/,$user);
                   7089:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7090:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7091:                         $secmatch = 1;
                   7092:                     } elsif ($usec eq '') {
1.420     albertel 7093:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7094:                             $secmatch = 1;
                   7095:                         }
                   7096:                     } else {
                   7097:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7098:                             $secmatch = 1;
                   7099:                         }
                   7100:                     }
                   7101:                     if (!$secmatch) {
                   7102:                         next;
                   7103:                     }
1.288     raeburn  7104:                 }
1.419     raeburn  7105:                 if ($usec eq '') {
                   7106:                     $usec = 'none';
                   7107:                 }
1.275     raeburn  7108:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7109:                     if ($hidepriv) {
                   7110:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7111:                             (!$nothide{$uname.':'.$udom})) {
                   7112:                             next;
                   7113:                         }
                   7114:                     }
1.503     raeburn  7115:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7116:                         $status = 'previous';
                   7117:                     } elsif ($start > $now) {
                   7118:                         $status = 'future';
                   7119:                     } else {
                   7120:                         $status = 'active';
                   7121:                     }
1.277     albertel 7122:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7123:                         if ($status eq $type) {
1.420     albertel 7124:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7125:                                 push(@{$$users{$role}{$user}},$type);
                   7126:                             }
1.288     raeburn  7127:                             $match = 1;
                   7128:                         }
                   7129:                     }
1.419     raeburn  7130:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7131:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7132: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7133:                         }
1.420     albertel 7134:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7135:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7136:                         }
1.609     raeburn  7137:                         if (ref($statushash) eq 'HASH') {
                   7138:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7139:                         }
1.275     raeburn  7140:                     }
                   7141:                 }
                   7142:             }
                   7143:         }
1.290     albertel 7144:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7145:             if ((defined($cdom)) && (defined($cnum))) {
                   7146:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7147:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7148:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7149:                     next if ($owner eq '');
                   7150:                     my ($ownername,$ownerdom);
                   7151:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7152:                         $ownername = $1;
                   7153:                         $ownerdom = $2;
                   7154:                     } else {
                   7155:                         $ownername = $owner;
                   7156:                         $ownerdom = $cdom;
                   7157:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7158:                     }
                   7159:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7160:                     if (defined($userdata) && 
1.609     raeburn  7161: 			!exists($$userdata{$owner})) {
                   7162: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7163:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7164:                             push(@{$seclists{$owner}},'none');
                   7165:                         }
                   7166:                         if (ref($statushash) eq 'HASH') {
                   7167:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7168:                         }
1.290     albertel 7169: 		    }
1.279     raeburn  7170:                 }
                   7171:             }
                   7172:         }
1.419     raeburn  7173:         foreach my $user (keys(%seclists)) {
                   7174:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7175:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7176:         }
1.275     raeburn  7177:     }
                   7178:     return;
                   7179: }
                   7180: 
1.288     raeburn  7181: sub get_user_info {
                   7182:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7183:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7184: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7185:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7186:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7187:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7188:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7189:     return;
                   7190: }
1.275     raeburn  7191: 
1.472     raeburn  7192: ###############################################
                   7193: 
                   7194: =pod
                   7195: 
                   7196: =item * &get_user_quota()
                   7197: 
                   7198: Retrieves quota assigned for storage of portfolio files for a user  
                   7199: 
                   7200: Incoming parameters:
                   7201: 1. user's username
                   7202: 2. user's domain
                   7203: 
                   7204: Returns:
1.536     raeburn  7205: 1. Disk quota (in Mb) assigned to student.
                   7206: 2. (Optional) Type of setting: custom or default
                   7207:    (individually assigned or default for user's 
                   7208:    institutional status).
                   7209: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7210:    or student - types as defined in localenroll::inst_usertypes 
                   7211:    for user's domain, which determines default quota for user.
                   7212: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7213: 
                   7214: If a value has been stored in the user's environment, 
1.536     raeburn  7215: it will return that, otherwise it returns the maximal default
                   7216: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7217: 
                   7218: =cut
                   7219: 
                   7220: ###############################################
                   7221: 
                   7222: 
                   7223: sub get_user_quota {
                   7224:     my ($uname,$udom) = @_;
1.536     raeburn  7225:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7226:     if (!defined($udom)) {
                   7227:         $udom = $env{'user.domain'};
                   7228:     }
                   7229:     if (!defined($uname)) {
                   7230:         $uname = $env{'user.name'};
                   7231:     }
                   7232:     if (($udom eq '' || $uname eq '') ||
                   7233:         ($udom eq 'public') && ($uname eq 'public')) {
                   7234:         $quota = 0;
1.536     raeburn  7235:         $quotatype = 'default';
                   7236:         $defquota = 0; 
1.472     raeburn  7237:     } else {
1.536     raeburn  7238:         my $inststatus;
1.472     raeburn  7239:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7240:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7241:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7242:         } else {
1.536     raeburn  7243:             my %userenv = 
                   7244:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7245:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7246:             my ($tmp) = keys(%userenv);
                   7247:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7248:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7249:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7250:             } else {
                   7251:                 undef(%userenv);
                   7252:             }
                   7253:         }
1.536     raeburn  7254:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7255:         if ($quota eq '') {
1.536     raeburn  7256:             $quota = $defquota;
                   7257:             $quotatype = 'default';
                   7258:         } else {
                   7259:             $quotatype = 'custom';
1.472     raeburn  7260:         }
                   7261:     }
1.536     raeburn  7262:     if (wantarray) {
                   7263:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7264:     } else {
                   7265:         return $quota;
                   7266:     }
1.472     raeburn  7267: }
                   7268: 
                   7269: ###############################################
                   7270: 
                   7271: =pod
                   7272: 
                   7273: =item * &default_quota()
                   7274: 
1.536     raeburn  7275: Retrieves default quota assigned for storage of user portfolio files,
                   7276: given an (optional) user's institutional status.
1.472     raeburn  7277: 
                   7278: Incoming parameters:
                   7279: 1. domain
1.536     raeburn  7280: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7281:    status types (e.g., faculty, staff, student etc.)
                   7282:    which apply to the user for whom the default is being retrieved.
                   7283:    If the institutional status string in undefined, the domain
                   7284:    default quota will be returned. 
1.472     raeburn  7285: 
                   7286: Returns:
                   7287: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7288: 2. (Optional) institutional type which determined the value of the
                   7289:    default quota.
1.472     raeburn  7290: 
                   7291: If a value has been stored in the domain's configuration db,
                   7292: it will return that, otherwise it returns 20 (for backwards 
                   7293: compatibility with domains which have not set up a configuration
                   7294: db file; the original statically defined portfolio quota was 20 Mb). 
                   7295: 
1.536     raeburn  7296: If the user's status includes multiple types (e.g., staff and student),
                   7297: the largest default quota which applies to the user determines the
                   7298: default quota returned.
                   7299: 
1.780     raeburn  7300: =back
                   7301: 
1.472     raeburn  7302: =cut
                   7303: 
                   7304: ###############################################
                   7305: 
                   7306: 
                   7307: sub default_quota {
1.536     raeburn  7308:     my ($udom,$inststatus) = @_;
                   7309:     my ($defquota,$settingstatus);
                   7310:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7311:                                             ['quotas'],$udom);
                   7312:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7313:         if ($inststatus ne '') {
1.765     raeburn  7314:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7315:             foreach my $item (@statuses) {
1.711     raeburn  7316:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7317:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7318:                         if ($defquota eq '') {
                   7319:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7320:                             $settingstatus = $item;
                   7321:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7322:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7323:                             $settingstatus = $item;
                   7324:                         }
                   7325:                     }
                   7326:                 } else {
                   7327:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7328:                         if ($defquota eq '') {
                   7329:                             $defquota = $quotahash{'quotas'}{$item};
                   7330:                             $settingstatus = $item;
                   7331:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7332:                             $defquota = $quotahash{'quotas'}{$item};
                   7333:                             $settingstatus = $item;
                   7334:                         }
1.536     raeburn  7335:                     }
                   7336:                 }
                   7337:             }
                   7338:         }
                   7339:         if ($defquota eq '') {
1.711     raeburn  7340:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7341:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7342:             } else {
                   7343:                 $defquota = $quotahash{'quotas'}{'default'};
                   7344:             }
1.536     raeburn  7345:             $settingstatus = 'default';
                   7346:         }
                   7347:     } else {
                   7348:         $settingstatus = 'default';
                   7349:         $defquota = 20;
                   7350:     }
                   7351:     if (wantarray) {
                   7352:         return ($defquota,$settingstatus);
1.472     raeburn  7353:     } else {
1.536     raeburn  7354:         return $defquota;
1.472     raeburn  7355:     }
                   7356: }
                   7357: 
1.384     raeburn  7358: sub get_secgrprole_info {
                   7359:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7360:     my %sections_count = &get_sections($cdom,$cnum);
                   7361:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7362:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7363:     my @groups = sort(keys(%curr_groups));
                   7364:     my $allroles = [];
                   7365:     my $rolehash;
                   7366:     my $accesshash = {
                   7367:                      active => 'Currently has access',
                   7368:                      future => 'Will have future access',
                   7369:                      previous => 'Previously had access',
                   7370:                   };
                   7371:     if ($needroles) {
                   7372:         $rolehash = {'all' => 'all'};
1.385     albertel 7373:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7374: 	if (&Apache::lonnet::error(%user_roles)) {
                   7375: 	    undef(%user_roles);
                   7376: 	}
                   7377:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7378:             my ($role)=split(/\:/,$item,2);
                   7379:             if ($role eq 'cr') { next; }
                   7380:             if ($role =~ /^cr/) {
                   7381:                 $$rolehash{$role} = (split('/',$role))[3];
                   7382:             } else {
                   7383:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7384:             }
                   7385:         }
                   7386:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7387:             push(@{$allroles},$key);
                   7388:         }
                   7389:         push (@{$allroles},'st');
                   7390:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7391:     }
                   7392:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7393: }
                   7394: 
1.555     raeburn  7395: sub user_picker {
1.627     raeburn  7396:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7397:     my $currdom = $dom;
                   7398:     my %curr_selected = (
                   7399:                         srchin => 'dom',
1.580     raeburn  7400:                         srchby => 'lastname',
1.555     raeburn  7401:                       );
                   7402:     my $srchterm;
1.625     raeburn  7403:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7404:         if ($srch->{'srchby'} ne '') {
                   7405:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7406:         }
                   7407:         if ($srch->{'srchin'} ne '') {
                   7408:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7409:         }
                   7410:         if ($srch->{'srchtype'} ne '') {
                   7411:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7412:         }
                   7413:         if ($srch->{'srchdomain'} ne '') {
                   7414:             $currdom = $srch->{'srchdomain'};
                   7415:         }
                   7416:         $srchterm = $srch->{'srchterm'};
                   7417:     }
                   7418:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7419:                     'usr'       => 'Search criteria',
1.563     raeburn  7420:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7421:                     'uname'     => 'username',
                   7422:                     'lastname'  => 'last name',
1.555     raeburn  7423:                     'lastfirst' => 'last name, first name',
1.558     albertel 7424:                     'crs'       => 'in this course',
1.576     raeburn  7425:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7426:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7427:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7428:                     'exact'     => 'is',
                   7429:                     'contains'  => 'contains',
1.569     raeburn  7430:                     'begins'    => 'begins with',
1.571     raeburn  7431:                     'youm'      => "You must include some text to search for.",
                   7432:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7433:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7434:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7435:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7436:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7437:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7438:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7439:                                        );
1.563     raeburn  7440:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7441:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7442: 
                   7443:     my @srchins = ('crs','dom','alc','instd');
                   7444: 
                   7445:     foreach my $option (@srchins) {
                   7446:         # FIXME 'alc' option unavailable until 
                   7447:         #       loncreateuser::print_user_query_page()
                   7448:         #       has been completed.
                   7449:         next if ($option eq 'alc');
                   7450:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7451:         if ($curr_selected{'srchin'} eq $option) {
                   7452:             $srchinsel .= ' 
                   7453:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7454:         } else {
                   7455:             $srchinsel .= '
                   7456:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7457:         }
1.555     raeburn  7458:     }
1.563     raeburn  7459:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7460: 
                   7461:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7462:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7463:         if ($curr_selected{'srchby'} eq $option) {
                   7464:             $srchbysel .= '
                   7465:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7466:         } else {
                   7467:             $srchbysel .= '
                   7468:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7469:          }
                   7470:     }
                   7471:     $srchbysel .= "\n  </select>\n";
                   7472: 
                   7473:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7474:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7475:         if ($curr_selected{'srchtype'} eq $option) {
                   7476:             $srchtypesel .= '
                   7477:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7478:         } else {
                   7479:             $srchtypesel .= '
                   7480:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7481:         }
                   7482:     }
                   7483:     $srchtypesel .= "\n  </select>\n";
                   7484: 
1.558     albertel 7485:     my ($newuserscript,$new_user_create);
1.556     raeburn  7486: 
                   7487:     if ($forcenewuser) {
1.576     raeburn  7488:         if (ref($srch) eq 'HASH') {
                   7489:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7490:                 if ($cancreate) {
                   7491:                     $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
                   7492:                 } else {
1.799     bisitz   7493:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7494:                     my %usertypetext = (
                   7495:                         official   => 'institutional',
                   7496:                         unofficial => 'non-institutional',
                   7497:                     );
1.799     bisitz   7498:                     $new_user_create = '<p class="LC_warning">'
                   7499:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7500:                                       .' '
                   7501:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7502:                                           ,'<a href="'.$helplink.'">','</a>')
                   7503:                                       .'</p><br />';
1.627     raeburn  7504:                 }
1.576     raeburn  7505:             }
                   7506:         }
                   7507: 
1.556     raeburn  7508:         $newuserscript = <<"ENDSCRIPT";
                   7509: 
1.570     raeburn  7510: function setSearch(createnew,callingForm) {
1.556     raeburn  7511:     if (createnew == 1) {
1.570     raeburn  7512:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7513:             if (callingForm.srchby.options[i].value == 'uname') {
                   7514:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7515:             }
                   7516:         }
1.570     raeburn  7517:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7518:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7519: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7520:             }
                   7521:         }
1.570     raeburn  7522:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7523:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7524:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7525:             }
                   7526:         }
1.570     raeburn  7527:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7528:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7529:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7530:             }
                   7531:         }
                   7532:     }
                   7533: }
                   7534: ENDSCRIPT
1.558     albertel 7535: 
1.556     raeburn  7536:     }
                   7537: 
1.555     raeburn  7538:     my $output = <<"END_BLOCK";
1.556     raeburn  7539: <script type="text/javascript">
1.570     raeburn  7540: function validateEntry(callingForm) {
1.558     albertel 7541: 
1.556     raeburn  7542:     var checkok = 1;
1.558     albertel 7543:     var srchin;
1.570     raeburn  7544:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7545: 	if ( callingForm.srchin[i].checked ) {
                   7546: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7547: 	}
                   7548:     }
                   7549: 
1.570     raeburn  7550:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7551:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7552:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7553:     var srchterm =  callingForm.srchterm.value;
                   7554:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7555:     var msg = "";
                   7556: 
                   7557:     if (srchterm == "") {
                   7558:         checkok = 0;
1.571     raeburn  7559:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7560:     }
                   7561: 
1.569     raeburn  7562:     if (srchtype== 'begins') {
                   7563:         if (srchterm.length < 2) {
                   7564:             checkok = 0;
1.571     raeburn  7565:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7566:         }
                   7567:     }
                   7568: 
1.556     raeburn  7569:     if (srchtype== 'contains') {
                   7570:         if (srchterm.length < 3) {
                   7571:             checkok = 0;
1.571     raeburn  7572:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7573:         }
                   7574:     }
                   7575:     if (srchin == 'instd') {
                   7576:         if (srchdomain == '') {
                   7577:             checkok = 0;
1.571     raeburn  7578:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7579:         }
                   7580:     }
                   7581:     if (srchin == 'dom') {
                   7582:         if (srchdomain == '') {
                   7583:             checkok = 0;
1.571     raeburn  7584:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7585:         }
                   7586:     }
                   7587:     if (srchby == 'lastfirst') {
                   7588:         if (srchterm.indexOf(",") == -1) {
                   7589:             checkok = 0;
1.571     raeburn  7590:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7591:         }
                   7592:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7593:             checkok = 0;
1.571     raeburn  7594:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7595:         }
                   7596:     }
                   7597:     if (checkok == 0) {
1.571     raeburn  7598:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7599:         return;
                   7600:     }
                   7601:     if (checkok == 1) {
1.570     raeburn  7602:         callingForm.submit();
1.556     raeburn  7603:     }
                   7604: }
                   7605: 
                   7606: $newuserscript
                   7607: 
                   7608: </script>
1.558     albertel 7609: 
                   7610: $new_user_create
                   7611: 
1.555     raeburn  7612: <table>
1.558     albertel 7613:  <tr>
1.573     raeburn  7614:   <td>$lt{'doma'}:</td>
                   7615:   <td>$domform</td>
                   7616:   </td>
                   7617:  </tr>
                   7618:  <tr>
                   7619:   <td>$lt{'usr'}:</td>
1.563     raeburn  7620:   <td>$srchbysel
                   7621:       $srchtypesel 
                   7622:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 7623:       $srchinsel 
1.563     raeburn  7624:   </td>
                   7625:  </tr>
1.555     raeburn  7626: </table>
                   7627: <br />
                   7628: END_BLOCK
1.558     albertel 7629: 
1.555     raeburn  7630:     return $output;
                   7631: }
                   7632: 
1.612     raeburn  7633: sub user_rule_check {
1.615     raeburn  7634:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7635:     my $response;
                   7636:     if (ref($usershash) eq 'HASH') {
                   7637:         foreach my $user (keys(%{$usershash})) {
                   7638:             my ($uname,$udom) = split(/:/,$user);
                   7639:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7640:             my ($id,$newuser);
1.612     raeburn  7641:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7642:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7643:                 $id = $usershash->{$user}->{'id'};
                   7644:             }
                   7645:             my $inst_response;
                   7646:             if (ref($checks) eq 'HASH') {
                   7647:                 if (defined($checks->{'username'})) {
1.615     raeburn  7648:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7649:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7650:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7651:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7652:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7653:                 }
1.615     raeburn  7654:             } else {
                   7655:                 ($inst_response,%{$inst_results->{$user}}) =
                   7656:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7657:                 return;
1.612     raeburn  7658:             }
1.615     raeburn  7659:             if (!$got_rules->{$udom}) {
1.612     raeburn  7660:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7661:                                                   ['usercreation'],$udom);
                   7662:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7663:                     foreach my $item ('username','id') {
1.612     raeburn  7664:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7665:                             $$curr_rules{$udom}{$item} = 
                   7666:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7667:                         }
                   7668:                     }
                   7669:                 }
1.615     raeburn  7670:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7671:             }
1.612     raeburn  7672:             foreach my $item (keys(%{$checks})) {
                   7673:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7674:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7675:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7676:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7677:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7678:                                 if ($rule_check{$rule}) {
                   7679:                                     $$rulematch{$user}{$item} = $rule;
                   7680:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7681:                                         if (ref($inst_results) eq 'HASH') {
                   7682:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7683:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7684:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7685:                                                 }
1.612     raeburn  7686:                                             }
                   7687:                                         }
1.615     raeburn  7688:                                     }
                   7689:                                     last;
1.585     raeburn  7690:                                 }
                   7691:                             }
                   7692:                         }
                   7693:                     }
                   7694:                 }
                   7695:             }
                   7696:         }
                   7697:     }
1.612     raeburn  7698:     return;
                   7699: }
                   7700: 
                   7701: sub user_rule_formats {
                   7702:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7703:     my %text = ( 
                   7704:                  'username' => 'Usernames',
                   7705:                  'id'       => 'IDs',
                   7706:                );
                   7707:     my $output;
                   7708:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7709:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7710:         if (@{$ruleorder} > 0) {
                   7711:             $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
                   7712:             foreach my $rule (@{$ruleorder}) {
                   7713:                 if (ref($curr_rules) eq 'ARRAY') {
                   7714:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7715:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7716:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7717:                                         $rules->{$rule}{'desc'}.'</li>';
                   7718:                         }
                   7719:                     }
                   7720:                 }
                   7721:             }
                   7722:             $output .= '</ul>';
                   7723:         }
                   7724:     }
                   7725:     return $output;
                   7726: }
                   7727: 
                   7728: sub instrule_disallow_msg {
1.615     raeburn  7729:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7730:     my $response;
                   7731:     my %text = (
                   7732:                   item   => 'username',
                   7733:                   items  => 'usernames',
                   7734:                   match  => 'matches',
                   7735:                   do     => 'does',
                   7736:                   action => 'a username',
                   7737:                   one    => 'one',
                   7738:                );
                   7739:     if ($count > 1) {
                   7740:         $text{'item'} = 'usernames';
                   7741:         $text{'match'} ='match';
                   7742:         $text{'do'} = 'do';
                   7743:         $text{'action'} = 'usernames',
                   7744:         $text{'one'} = 'ones';
                   7745:     }
                   7746:     if ($checkitem eq 'id') {
                   7747:         $text{'items'} = 'IDs';
                   7748:         $text{'item'} = 'ID';
                   7749:         $text{'action'} = 'an ID';
1.615     raeburn  7750:         if ($count > 1) {
                   7751:             $text{'item'} = 'IDs';
                   7752:             $text{'action'} = 'IDs';
                   7753:         }
1.612     raeburn  7754:     }
1.674     bisitz   7755:     $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615     raeburn  7756:     if ($mode eq 'upload') {
                   7757:         if ($checkitem eq 'username') {
                   7758:             $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7759:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7760:             $response .= &mt("Either upload a file which includes $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615     raeburn  7761:         }
1.669     raeburn  7762:     } elsif ($mode eq 'selfcreate') {
                   7763:         if ($checkitem eq 'id') {
                   7764:             $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
                   7765:         }
1.615     raeburn  7766:     } else {
                   7767:         if ($checkitem eq 'username') {
                   7768:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7769:         } elsif ($checkitem eq 'id') {
                   7770:             $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
                   7771:         }
1.612     raeburn  7772:     }
                   7773:     return $response;
1.585     raeburn  7774: }
                   7775: 
1.624     raeburn  7776: sub personal_data_fieldtitles {
                   7777:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7778:                         id => 'Student/Employee ID',
                   7779:                         permanentemail => 'E-mail address',
                   7780:                         lastname => 'Last Name',
                   7781:                         firstname => 'First Name',
                   7782:                         middlename => 'Middle Name',
                   7783:                         generation => 'Generation',
                   7784:                         gen => 'Generation',
1.765     raeburn  7785:                         inststatus => 'Affiliation',
1.624     raeburn  7786:                    );
                   7787:     return %fieldtitles;
                   7788: }
                   7789: 
1.642     raeburn  7790: sub sorted_inst_types {
                   7791:     my ($dom) = @_;
                   7792:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7793:     my $othertitle = &mt('All users');
                   7794:     if ($env{'request.course.id'}) {
1.668     raeburn  7795:         $othertitle  = &mt('Any users');
1.642     raeburn  7796:     }
                   7797:     my @types;
                   7798:     if (ref($order) eq 'ARRAY') {
                   7799:         @types = @{$order};
                   7800:     }
                   7801:     if (@types == 0) {
                   7802:         if (ref($usertypes) eq 'HASH') {
                   7803:             @types = sort(keys(%{$usertypes}));
                   7804:         }
                   7805:     }
                   7806:     if (keys(%{$usertypes}) > 0) {
                   7807:         $othertitle = &mt('Other users');
                   7808:     }
                   7809:     return ($othertitle,$usertypes,\@types);
                   7810: }
                   7811: 
1.645     raeburn  7812: sub get_institutional_codes {
                   7813:     my ($settings,$allcourses,$LC_code) = @_;
                   7814: # Get complete list of course sections to update
                   7815:     my @currsections = ();
                   7816:     my @currxlists = ();
                   7817:     my $coursecode = $$settings{'internal.coursecode'};
                   7818: 
                   7819:     if ($$settings{'internal.sectionnums'} ne '') {
                   7820:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7821:     }
                   7822: 
                   7823:     if ($$settings{'internal.crosslistings'} ne '') {
                   7824:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7825:     }
                   7826: 
                   7827:     if (@currxlists > 0) {
                   7828:         foreach (@currxlists) {
                   7829:             if (m/^([^:]+):(\w*)$/) {
                   7830:                 unless (grep/^$1$/,@{$allcourses}) {
                   7831:                     push @{$allcourses},$1;
                   7832:                     $$LC_code{$1} = $2;
                   7833:                 }
                   7834:             }
                   7835:         }
                   7836:     }
                   7837:  
                   7838:     if (@currsections > 0) {
                   7839:         foreach (@currsections) {
                   7840:             if (m/^(\w+):(\w*)$/) {
                   7841:                 my $sec = $coursecode.$1;
                   7842:                 my $lc_sec = $2;
                   7843:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7844:                     push @{$allcourses},$sec;
                   7845:                     $$LC_code{$sec} = $lc_sec;
                   7846:                 }
                   7847:             }
                   7848:         }
                   7849:     }
                   7850:     return;
                   7851: }
                   7852: 
1.112     bowersj2 7853: =pod
                   7854: 
1.780     raeburn  7855: =head1 Slot Helpers
                   7856: 
                   7857: =over 4
                   7858: 
                   7859: =item * sorted_slots()
                   7860: 
                   7861: Sorts an array of slot names in order of slot start time (earliest first). 
                   7862: 
                   7863: Inputs:
                   7864: 
                   7865: =over 4
                   7866: 
                   7867: slotsarr  - Reference to array of unsorted slot names.
                   7868: 
                   7869: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7870: 
1.549     albertel 7871: =back
                   7872: 
1.780     raeburn  7873: Returns:
                   7874: 
                   7875: =over 4
                   7876: 
                   7877: sorted   - An array of slot names sorted by the start time of the slot.
                   7878: 
                   7879: =back
                   7880: 
                   7881: =back
                   7882: 
                   7883: =cut
                   7884: 
                   7885: 
                   7886: sub sorted_slots {
                   7887:     my ($slotsarr,$slots) = @_;
                   7888:     my @sorted;
                   7889:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7890:         @sorted =
                   7891:             sort {
                   7892:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7893:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7894:                      }
                   7895:                      if (ref($slots->{$a})) { return -1;}
                   7896:                      if (ref($slots->{$b})) { return 1;}
                   7897:                      return 0;
                   7898:                  } @{$slotsarr};
                   7899:     }
                   7900:     return @sorted;
                   7901: }
                   7902: 
                   7903: 
                   7904: =pod
                   7905: 
1.549     albertel 7906: =head1 HTTP Helpers
                   7907: 
                   7908: =over 4
                   7909: 
1.648     raeburn  7910: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7911: 
1.258     albertel 7912: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 7913: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 7914: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7915: 
                   7916: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7917: $possible_names is an ref to an array of form element names.  As an example:
                   7918: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7919: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7920: 
                   7921: =cut
1.1       albertel 7922: 
1.6       albertel 7923: sub get_unprocessed_cgi {
1.25      albertel 7924:   my ($query,$possible_names)= @_;
1.26      matthew  7925:   # $Apache::lonxml::debug=1;
1.356     albertel 7926:   foreach my $pair (split(/&/,$query)) {
                   7927:     my ($name, $value) = split(/=/,$pair);
1.369     www      7928:     $name = &unescape($name);
1.25      albertel 7929:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   7930:       $value =~ tr/+/ /;
                   7931:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 7932:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 7933:     }
1.16      harris41 7934:   }
1.6       albertel 7935: }
                   7936: 
1.112     bowersj2 7937: =pod
                   7938: 
1.648     raeburn  7939: =item * &cacheheader() 
1.112     bowersj2 7940: 
                   7941: returns cache-controlling header code
                   7942: 
                   7943: =cut
                   7944: 
1.7       albertel 7945: sub cacheheader {
1.258     albertel 7946:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 7947:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   7948:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 7949:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   7950:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 7951:     return $output;
1.7       albertel 7952: }
                   7953: 
1.112     bowersj2 7954: =pod
                   7955: 
1.648     raeburn  7956: =item * &no_cache($r) 
1.112     bowersj2 7957: 
                   7958: specifies header code to not have cache
                   7959: 
                   7960: =cut
                   7961: 
1.9       albertel 7962: sub no_cache {
1.216     albertel 7963:     my ($r) = @_;
                   7964:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 7965: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 7966:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   7967:     $r->no_cache(1);
                   7968:     $r->header_out("Expires" => $date);
                   7969:     $r->header_out("Pragma" => "no-cache");
1.123     www      7970: }
                   7971: 
                   7972: sub content_type {
1.181     albertel 7973:     my ($r,$type,$charset) = @_;
1.299     foxr     7974:     if ($r) {
                   7975: 	#  Note that printout.pl calls this with undef for $r.
                   7976: 	&no_cache($r);
                   7977:     }
1.258     albertel 7978:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 7979:     unless ($charset) {
                   7980: 	$charset=&Apache::lonlocal::current_encoding;
                   7981:     }
                   7982:     if ($charset) { $type.='; charset='.$charset; }
                   7983:     if ($r) {
                   7984: 	$r->content_type($type);
                   7985:     } else {
                   7986: 	print("Content-type: $type\n\n");
                   7987:     }
1.9       albertel 7988: }
1.25      albertel 7989: 
1.112     bowersj2 7990: =pod
                   7991: 
1.648     raeburn  7992: =item * &add_to_env($name,$value) 
1.112     bowersj2 7993: 
1.258     albertel 7994: adds $name to the %env hash with value
1.112     bowersj2 7995: $value, if $name already exists, the entry is converted to an array
                   7996: reference and $value is added to the array.
                   7997: 
                   7998: =cut
                   7999: 
1.25      albertel 8000: sub add_to_env {
                   8001:   my ($name,$value)=@_;
1.258     albertel 8002:   if (defined($env{$name})) {
                   8003:     if (ref($env{$name})) {
1.25      albertel 8004:       #already have multiple values
1.258     albertel 8005:       push(@{ $env{$name} },$value);
1.25      albertel 8006:     } else {
                   8007:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8008:       my $first=$env{$name};
                   8009:       undef($env{$name});
                   8010:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8011:     }
                   8012:   } else {
1.258     albertel 8013:     $env{$name}=$value;
1.25      albertel 8014:   }
1.31      albertel 8015: }
1.149     albertel 8016: 
                   8017: =pod
                   8018: 
1.648     raeburn  8019: =item * &get_env_multiple($name) 
1.149     albertel 8020: 
1.258     albertel 8021: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8022: values may be defined and end up as an array ref.
                   8023: 
                   8024: returns an array of values
                   8025: 
                   8026: =cut
                   8027: 
                   8028: sub get_env_multiple {
                   8029:     my ($name) = @_;
                   8030:     my @values;
1.258     albertel 8031:     if (defined($env{$name})) {
1.149     albertel 8032:         # exists is it an array
1.258     albertel 8033:         if (ref($env{$name})) {
                   8034:             @values=@{ $env{$name} };
1.149     albertel 8035:         } else {
1.258     albertel 8036:             $values[0]=$env{$name};
1.149     albertel 8037:         }
                   8038:     }
                   8039:     return(@values);
                   8040: }
                   8041: 
1.660     raeburn  8042: sub ask_for_embedded_content {
                   8043:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8044:     my $upload_output = '
                   8045:    <form name="upload_embedded" action="'.$actionurl.'"
                   8046:                   method="post" enctype="multipart/form-data">';
                   8047:     $upload_output .= $state;
1.661     raeburn  8048:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8049: 
                   8050:     my $num = 0;
                   8051:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8052:         $upload_output .= &start_data_table_row().
                   8053:             '<td>'.$embed_file.'</td><td>';
                   8054:         if ($args->{'ignore_remote_references'}
                   8055:             && $embed_file =~ m{^\w+://}) {
                   8056:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8057:         } elsif ($args->{'error_on_invalid_names'}
                   8058:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8059: 
                   8060:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8061: 
                   8062:         } else {
                   8063:             $upload_output .='
1.661     raeburn  8064:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8065:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8066:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8067:             $upload_output .=
                   8068:                 "\n\t\t".
                   8069:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8070:                 $attrib.'" />';
                   8071:             if (exists($$codebase{$embed_file})) {
                   8072:                 $upload_output .=
                   8073:                     "\n\t\t".
                   8074:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8075:                     &escape($$codebase{$embed_file}).'" />';
                   8076:             }
                   8077:         }
                   8078:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8079:         $num++;
                   8080:     }
                   8081:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8082:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8083:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8084:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8085:    </form>';
                   8086:     return $upload_output;
                   8087: }
                   8088: 
1.661     raeburn  8089: sub upload_embedded {
                   8090:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8091:         $current_disk_usage) = @_;
                   8092:     my $output;
                   8093:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8094:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8095:         my $orig_uploaded_filename =
                   8096:             $env{'form.embedded_item_'.$i.'.filename'};
                   8097: 
                   8098:         $env{'form.embedded_orig_'.$i} =
                   8099:             &unescape($env{'form.embedded_orig_'.$i});
                   8100:         my ($path,$fname) =
                   8101:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8102:         # no path, whole string is fname
                   8103:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8104: 
                   8105:         $path = $env{'form.currentpath'}.$path;
                   8106:         $fname = &Apache::lonnet::clean_filename($fname);
                   8107:         # See if there is anything left
                   8108:         next if ($fname eq '');
                   8109: 
                   8110:         # Check if file already exists as a file or directory.
                   8111:         my ($state,$msg);
                   8112:         if ($context eq 'portfolio') {
                   8113:             my $port_path = $dirpath;
                   8114:             if ($group ne '') {
                   8115:                 $port_path = "groups/$group/$port_path";
                   8116:             }
                   8117:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8118:                                               $dir_root,$port_path,$disk_quota,
                   8119:                                               $current_disk_usage,$uname,$udom);
                   8120:             if ($state eq 'will_exceed_quota'
                   8121:                 || $state eq 'file_locked'
                   8122:                 || $state eq 'file_exists' ) {
                   8123:                 $output .= $msg;
                   8124:                 next;
                   8125:             }
                   8126:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8127:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8128:             if ($state eq 'exists') {
                   8129:                 $output .= $msg;
                   8130:                 next;
                   8131:             }
                   8132:         }
                   8133:         # Check if extension is valid
                   8134:         if (($fname =~ /\.(\w+)$/) &&
                   8135:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8136:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8137:             next;
                   8138:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8139:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8140:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8141:             next;
                   8142:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8143:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8144:             next;
                   8145:         }
                   8146: 
                   8147:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8148:         if ($context eq 'portfolio') {
                   8149:             my $result=
                   8150:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8151:                                                 $dirpath.$path);
                   8152:             if ($result !~ m|^/uploaded/|) {
                   8153:                 $output .= '<span class="LC_error">'
                   8154:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8155:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8156:                       .'</span><br />';
                   8157:                 next;
                   8158:             } else {
                   8159:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8160:                            $path.$fname.'</span>').'</p>';     
                   8161:             }
                   8162:         } else {
                   8163: # Save the file
                   8164:             my $target = $env{'form.embedded_item_'.$i};
                   8165:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8166:             my $dest = $fullpath.$fname;
                   8167:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8168:             my @parts=split(/\//,$fullpath);
                   8169:             my $count;
                   8170:             my $filepath = $dir_root;
                   8171:             for ($count=4;$count<=$#parts;$count++) {
                   8172:                 $filepath .= "/$parts[$count]";
                   8173:                 if ((-e $filepath)!=1) {
                   8174:                     mkdir($filepath,0770);
                   8175:                 }
                   8176:             }
                   8177:             my $fh;
                   8178:             if (!open($fh,'>'.$dest)) {
                   8179:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8180:                 $output .= '<span class="LC_error">'.
                   8181:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8182:                            '</span><br />';
                   8183:             } else {
                   8184:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8185:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8186:                     $output .= '<span class="LC_error">'.
                   8187:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8188:                               '</span><br />';
                   8189:                 } else {
                   8190:                     if ($context eq 'testbank') {
                   8191:                         $output .= &mt('Embedded file uploaded successfully:').
                   8192:                                    '&nbsp;<a href="'.$url.'">'.
                   8193:                                    $orig_uploaded_filename.'</a><br />';
                   8194:                     } else {
1.705     tempelho 8195:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8196:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8197:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8198:                     }
                   8199:                 }
                   8200:                 close($fh);
                   8201:             }
                   8202:         }
                   8203:     }
                   8204:     return $output;
                   8205: }
                   8206: 
                   8207: sub check_for_existing {
                   8208:     my ($path,$fname,$element) = @_;
                   8209:     my ($state,$msg);
                   8210:     if (-d $path.'/'.$fname) {
                   8211:         $state = 'exists';
                   8212:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8213:     } elsif (-e $path.'/'.$fname) {
                   8214:         $state = 'exists';
                   8215:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8216:     }
                   8217:     if ($state eq 'exists') {
                   8218:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8219:     }
                   8220:     return ($state,$msg);
                   8221: }
                   8222: 
                   8223: sub check_for_upload {
                   8224:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8225:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8226:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8227:     my $getpropath = 1;
                   8228:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8229:                                             $getpropath);
                   8230:     my $found_file = 0;
                   8231:     my $locked_file = 0;
                   8232:     foreach my $line (@dir_list) {
                   8233:         my ($file_name)=split(/\&/,$line,2);
                   8234:         if ($file_name eq $fname){
                   8235:             $file_name = $path.$file_name;
                   8236:             if ($group ne '') {
                   8237:                 $file_name = $group.$file_name;
                   8238:             }
                   8239:             $found_file = 1;
                   8240:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8241:                 $locked_file = 1;
                   8242:             }
                   8243:         }
                   8244:     }
                   8245:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8246:         my $msg = '<span class="LC_error">'.
                   8247:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8248:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8249:         return ('will_exceed_quota',$msg);
                   8250:     } elsif ($found_file) {
                   8251:         if ($locked_file) {
                   8252:             my $msg = '<span class="LC_error">';
                   8253:             $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
                   8254:             $msg .= '</span><br />';
                   8255:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8256:             return ('file_locked',$msg);
                   8257:         } else {
                   8258:             my $msg = '<span class="LC_error">';
                   8259:             $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
                   8260:             $msg .= '</span>';
                   8261:             $msg .= '<br />';
                   8262:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8263:             return ('file_exists',$msg);
                   8264:         }
                   8265:     }
                   8266: }
                   8267: 
1.31      albertel 8268: 
1.41      ng       8269: =pod
1.45      matthew  8270: 
1.464     albertel 8271: =back
1.41      ng       8272: 
1.112     bowersj2 8273: =head1 CSV Upload/Handling functions
1.38      albertel 8274: 
1.41      ng       8275: =over 4
                   8276: 
1.648     raeburn  8277: =item * &upfile_store($r)
1.41      ng       8278: 
                   8279: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8280: needs $env{'form.upfile'}
1.41      ng       8281: returns $datatoken to be put into hidden field
                   8282: 
                   8283: =cut
1.31      albertel 8284: 
                   8285: sub upfile_store {
                   8286:     my $r=shift;
1.258     albertel 8287:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8288:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8289:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8290:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8291: 
1.258     albertel 8292:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8293: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8294:     {
1.158     raeburn  8295:         my $datafile = $r->dir_config('lonDaemons').
                   8296:                            '/tmp/'.$datatoken.'.tmp';
                   8297:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8298:             print $fh $env{'form.upfile'};
1.158     raeburn  8299:             close($fh);
                   8300:         }
1.31      albertel 8301:     }
                   8302:     return $datatoken;
                   8303: }
                   8304: 
1.56      matthew  8305: =pod
                   8306: 
1.648     raeburn  8307: =item * &load_tmp_file($r)
1.41      ng       8308: 
                   8309: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8310: needs $env{'form.datatoken'},
                   8311: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8312: 
                   8313: =cut
1.31      albertel 8314: 
                   8315: sub load_tmp_file {
                   8316:     my $r=shift;
                   8317:     my @studentdata=();
                   8318:     {
1.158     raeburn  8319:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8320:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8321:         if ( open(my $fh,"<$studentfile") ) {
                   8322:             @studentdata=<$fh>;
                   8323:             close($fh);
                   8324:         }
1.31      albertel 8325:     }
1.258     albertel 8326:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8327: }
                   8328: 
1.56      matthew  8329: =pod
                   8330: 
1.648     raeburn  8331: =item * &upfile_record_sep()
1.41      ng       8332: 
                   8333: Separate uploaded file into records
                   8334: returns array of records,
1.258     albertel 8335: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8336: 
                   8337: =cut
1.31      albertel 8338: 
                   8339: sub upfile_record_sep {
1.258     albertel 8340:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8341:     } else {
1.248     albertel 8342: 	my @records;
1.258     albertel 8343: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8344: 	    if ($line=~/^\s*$/) { next; }
                   8345: 	    push(@records,$line);
                   8346: 	}
                   8347: 	return @records;
1.31      albertel 8348:     }
                   8349: }
                   8350: 
1.56      matthew  8351: =pod
                   8352: 
1.648     raeburn  8353: =item * &record_sep($record)
1.41      ng       8354: 
1.258     albertel 8355: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8356: 
                   8357: =cut
                   8358: 
1.263     www      8359: sub takeleft {
                   8360:     my $index=shift;
                   8361:     return substr('0000'.$index,-4,4);
                   8362: }
                   8363: 
1.31      albertel 8364: sub record_sep {
                   8365:     my $record=shift;
                   8366:     my %components=();
1.258     albertel 8367:     if ($env{'form.upfiletype'} eq 'xml') {
                   8368:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8369:         my $i=0;
1.356     albertel 8370:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8371:             $field=~s/^(\"|\')//;
                   8372:             $field=~s/(\"|\')$//;
1.263     www      8373:             $components{&takeleft($i)}=$field;
1.31      albertel 8374:             $i++;
                   8375:         }
1.258     albertel 8376:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8377:         my $i=0;
1.356     albertel 8378:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8379:             $field=~s/^(\"|\')//;
                   8380:             $field=~s/(\"|\')$//;
1.263     www      8381:             $components{&takeleft($i)}=$field;
1.31      albertel 8382:             $i++;
                   8383:         }
                   8384:     } else {
1.561     www      8385:         my $separator=',';
1.480     banghart 8386:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8387:             $separator=';';
1.480     banghart 8388:         }
1.31      albertel 8389:         my $i=0;
1.561     www      8390: # the character we are looking for to indicate the end of a quote or a record 
                   8391:         my $looking_for=$separator;
                   8392: # do not add the characters to the fields
                   8393:         my $ignore=0;
                   8394: # we just encountered a separator (or the beginning of the record)
                   8395:         my $just_found_separator=1;
                   8396: # store the field we are working on here
                   8397:         my $field='';
                   8398: # work our way through all characters in record
                   8399:         foreach my $character ($record=~/(.)/g) {
                   8400:             if ($character eq $looking_for) {
                   8401:                if ($character ne $separator) {
                   8402: # Found the end of a quote, again looking for separator
                   8403:                   $looking_for=$separator;
                   8404:                   $ignore=1;
                   8405:                } else {
                   8406: # Found a separator, store away what we got
                   8407:                   $components{&takeleft($i)}=$field;
                   8408: 	          $i++;
                   8409:                   $just_found_separator=1;
                   8410:                   $ignore=0;
                   8411:                   $field='';
                   8412:                }
                   8413:                next;
                   8414:             }
                   8415: # single or double quotation marks after a separator indicate beginning of a quote
                   8416: # we are now looking for the end of the quote and need to ignore separators
                   8417:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8418:                $looking_for=$character;
                   8419:                next;
                   8420:             }
                   8421: # ignore would be true after we reached the end of a quote
                   8422:             if ($ignore) { next; }
                   8423:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8424:             $field.=$character;
                   8425:             $just_found_separator=0; 
1.31      albertel 8426:         }
1.561     www      8427: # catch the very last entry, since we never encountered the separator
                   8428:         $components{&takeleft($i)}=$field;
1.31      albertel 8429:     }
                   8430:     return %components;
                   8431: }
                   8432: 
1.144     matthew  8433: ######################################################
                   8434: ######################################################
                   8435: 
1.56      matthew  8436: =pod
                   8437: 
1.648     raeburn  8438: =item * &upfile_select_html()
1.41      ng       8439: 
1.144     matthew  8440: Return HTML code to select a file from the users machine and specify 
                   8441: the file type.
1.41      ng       8442: 
                   8443: =cut
                   8444: 
1.144     matthew  8445: ######################################################
                   8446: ######################################################
1.31      albertel 8447: sub upfile_select_html {
1.144     matthew  8448:     my %Types = (
                   8449:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8450:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8451:                  space => &mt('Space separated'),
                   8452:                  tab   => &mt('Tabulator separated'),
                   8453: #                 xml   => &mt('HTML/XML'),
                   8454:                  );
                   8455:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8456:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8457:     foreach my $type (sort(keys(%Types))) {
                   8458:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8459:     }
                   8460:     $Str .= "</select>\n";
                   8461:     return $Str;
1.31      albertel 8462: }
                   8463: 
1.301     albertel 8464: sub get_samples {
                   8465:     my ($records,$toget) = @_;
                   8466:     my @samples=({});
                   8467:     my $got=0;
                   8468:     foreach my $rec (@$records) {
                   8469: 	my %temp = &record_sep($rec);
                   8470: 	if (! grep(/\S/, values(%temp))) { next; }
                   8471: 	if (%temp) {
                   8472: 	    $samples[$got]=\%temp;
                   8473: 	    $got++;
                   8474: 	    if ($got == $toget) { last; }
                   8475: 	}
                   8476:     }
                   8477:     return \@samples;
                   8478: }
                   8479: 
1.144     matthew  8480: ######################################################
                   8481: ######################################################
                   8482: 
1.56      matthew  8483: =pod
                   8484: 
1.648     raeburn  8485: =item * &csv_print_samples($r,$records)
1.41      ng       8486: 
                   8487: Prints a table of sample values from each column uploaded $r is an
                   8488: Apache Request ref, $records is an arrayref from
                   8489: &Apache::loncommon::upfile_record_sep
                   8490: 
                   8491: =cut
                   8492: 
1.144     matthew  8493: ######################################################
                   8494: ######################################################
1.31      albertel 8495: sub csv_print_samples {
                   8496:     my ($r,$records) = @_;
1.662     bisitz   8497:     my $samples = &get_samples($records,5);
1.301     albertel 8498: 
1.594     raeburn  8499:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8500:               &start_data_table_header_row());
1.356     albertel 8501:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   8502:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  8503:     $r->print(&end_data_table_header_row());
1.301     albertel 8504:     foreach my $hash (@$samples) {
1.594     raeburn  8505: 	$r->print(&start_data_table_row());
1.356     albertel 8506: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8507: 	    $r->print('<td>');
1.356     albertel 8508: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8509: 	    $r->print('</td>');
                   8510: 	}
1.594     raeburn  8511: 	$r->print(&end_data_table_row());
1.31      albertel 8512:     }
1.594     raeburn  8513:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8514: }
                   8515: 
1.144     matthew  8516: ######################################################
                   8517: ######################################################
                   8518: 
1.56      matthew  8519: =pod
                   8520: 
1.648     raeburn  8521: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8522: 
                   8523: Prints a table to create associations between values and table columns.
1.144     matthew  8524: 
1.41      ng       8525: $r is an Apache Request ref,
                   8526: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8527: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8528: 
                   8529: =cut
                   8530: 
1.144     matthew  8531: ######################################################
                   8532: ######################################################
1.31      albertel 8533: sub csv_print_select_table {
                   8534:     my ($r,$records,$d) = @_;
1.301     albertel 8535:     my $i=0;
                   8536:     my $samples = &get_samples($records,1);
1.144     matthew  8537:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8538: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8539:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8540:               '<th>'.&mt('Column').'</th>'.
                   8541:               &end_data_table_header_row()."\n");
1.356     albertel 8542:     foreach my $array_ref (@$d) {
                   8543: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8544: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8545: 
                   8546: 	$r->print('<td><select name=f'.$i.
1.32      matthew  8547: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8548: 	$r->print('<option value="none"></option>');
1.356     albertel 8549: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8550: 	    $r->print('<option value="'.$sample.'"'.
                   8551:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8552:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8553: 	}
1.594     raeburn  8554: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8555: 	$i++;
                   8556:     }
1.594     raeburn  8557:     $r->print(&end_data_table());
1.31      albertel 8558:     $i--;
                   8559:     return $i;
                   8560: }
1.56      matthew  8561: 
1.144     matthew  8562: ######################################################
                   8563: ######################################################
                   8564: 
1.56      matthew  8565: =pod
1.31      albertel 8566: 
1.648     raeburn  8567: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8568: 
                   8569: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8570: 
                   8571: $r is an Apache Request ref,
                   8572: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8573: $d is an array of 2 element arrays (internal name, displayed name)
                   8574: 
                   8575: =cut
                   8576: 
1.144     matthew  8577: ######################################################
                   8578: ######################################################
1.31      albertel 8579: sub csv_samples_select_table {
                   8580:     my ($r,$records,$d) = @_;
                   8581:     my $i=0;
1.144     matthew  8582:     #
1.662     bisitz   8583:     my $max_samples = 5;
                   8584:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8585:     $r->print(&start_data_table().
                   8586:               &start_data_table_header_row().'<th>'.
                   8587:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8588:               &end_data_table_header_row());
1.301     albertel 8589: 
                   8590:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8591: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8592: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8593: 	foreach my $option (@$d) {
                   8594: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8595: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8596:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8597:                       $display.'</option>');
1.31      albertel 8598: 	}
                   8599: 	$r->print('</select></td><td>');
1.662     bisitz   8600: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8601: 	    if (defined($samples->[$line]{$key})) { 
                   8602: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8603: 	    }
                   8604: 	}
1.594     raeburn  8605: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8606: 	$i++;
                   8607:     }
1.594     raeburn  8608:     $r->print(&end_data_table());
1.31      albertel 8609:     $i--;
                   8610:     return($i);
1.115     matthew  8611: }
                   8612: 
1.144     matthew  8613: ######################################################
                   8614: ######################################################
                   8615: 
1.115     matthew  8616: =pod
                   8617: 
1.648     raeburn  8618: =item * &clean_excel_name($name)
1.115     matthew  8619: 
                   8620: Returns a replacement for $name which does not contain any illegal characters.
                   8621: 
                   8622: =cut
                   8623: 
1.144     matthew  8624: ######################################################
                   8625: ######################################################
1.115     matthew  8626: sub clean_excel_name {
                   8627:     my ($name) = @_;
                   8628:     $name =~ s/[:\*\?\/\\]//g;
                   8629:     if (length($name) > 31) {
                   8630:         $name = substr($name,0,31);
                   8631:     }
                   8632:     return $name;
1.25      albertel 8633: }
1.84      albertel 8634: 
1.85      albertel 8635: =pod
                   8636: 
1.648     raeburn  8637: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8638: 
                   8639: Returns either 1 or undef
                   8640: 
                   8641: 1 if the part is to be hidden, undef if it is to be shown
                   8642: 
                   8643: Arguments are:
                   8644: 
                   8645: $id the id of the part to be checked
                   8646: $symb, optional the symb of the resource to check
                   8647: $udom, optional the domain of the user to check for
                   8648: $uname, optional the username of the user to check for
                   8649: 
                   8650: =cut
1.84      albertel 8651: 
                   8652: sub check_if_partid_hidden {
                   8653:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8654:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8655: 					 $symb,$udom,$uname);
1.141     albertel 8656:     my $truth=1;
                   8657:     #if the string starts with !, then the list is the list to show not hide
                   8658:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8659:     my @hiddenlist=split(/,/,$hiddenparts);
                   8660:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8661: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8662:     }
1.141     albertel 8663:     return !$truth;
1.84      albertel 8664: }
1.127     matthew  8665: 
1.138     matthew  8666: 
                   8667: ############################################################
                   8668: ############################################################
                   8669: 
                   8670: =pod
                   8671: 
1.157     matthew  8672: =back 
                   8673: 
1.138     matthew  8674: =head1 cgi-bin script and graphing routines
                   8675: 
1.157     matthew  8676: =over 4
                   8677: 
1.648     raeburn  8678: =item * &get_cgi_id()
1.138     matthew  8679: 
                   8680: Inputs: none
                   8681: 
                   8682: Returns an id which can be used to pass environment variables
                   8683: to various cgi-bin scripts.  These environment variables will
                   8684: be removed from the users environment after a given time by
                   8685: the routine &Apache::lonnet::transfer_profile_to_env.
                   8686: 
                   8687: =cut
                   8688: 
                   8689: ############################################################
                   8690: ############################################################
1.152     albertel 8691: my $uniq=0;
1.136     matthew  8692: sub get_cgi_id {
1.154     albertel 8693:     $uniq=($uniq+1)%100000;
1.280     albertel 8694:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8695: }
                   8696: 
1.127     matthew  8697: ############################################################
                   8698: ############################################################
                   8699: 
                   8700: =pod
                   8701: 
1.648     raeburn  8702: =item * &DrawBarGraph()
1.127     matthew  8703: 
1.138     matthew  8704: Facilitates the plotting of data in a (stacked) bar graph.
                   8705: Puts plot definition data into the users environment in order for 
                   8706: graph.png to plot it.  Returns an <img> tag for the plot.
                   8707: The bars on the plot are labeled '1','2',...,'n'.
                   8708: 
                   8709: Inputs:
                   8710: 
                   8711: =over 4
                   8712: 
                   8713: =item $Title: string, the title of the plot
                   8714: 
                   8715: =item $xlabel: string, text describing the X-axis of the plot
                   8716: 
                   8717: =item $ylabel: string, text describing the Y-axis of the plot
                   8718: 
                   8719: =item $Max: scalar, the maximum Y value to use in the plot
                   8720: If $Max is < any data point, the graph will not be rendered.
                   8721: 
1.140     matthew  8722: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8723: they are plotted.  If undefined, default values will be used.
                   8724: 
1.178     matthew  8725: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8726: 
1.138     matthew  8727: =item @Values: An array of array references.  Each array reference holds data
                   8728: to be plotted in a stacked bar chart.
                   8729: 
1.239     matthew  8730: =item If the final element of @Values is a hash reference the key/value
                   8731: pairs will be added to the graph definition.
                   8732: 
1.138     matthew  8733: =back
                   8734: 
                   8735: Returns:
                   8736: 
                   8737: An <img> tag which references graph.png and the appropriate identifying
                   8738: information for the plot.
                   8739: 
1.127     matthew  8740: =cut
                   8741: 
                   8742: ############################################################
                   8743: ############################################################
1.134     matthew  8744: sub DrawBarGraph {
1.178     matthew  8745:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8746:     #
                   8747:     if (! defined($colors)) {
                   8748:         $colors = ['#33ff00', 
                   8749:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8750:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8751:                   ]; 
                   8752:     }
1.228     matthew  8753:     my $extra_settings = {};
                   8754:     if (ref($Values[-1]) eq 'HASH') {
                   8755:         $extra_settings = pop(@Values);
                   8756:     }
1.127     matthew  8757:     #
1.136     matthew  8758:     my $identifier = &get_cgi_id();
                   8759:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8760:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8761:         return '';
                   8762:     }
1.225     matthew  8763:     #
                   8764:     my @Labels;
                   8765:     if (defined($labels)) {
                   8766:         @Labels = @$labels;
                   8767:     } else {
                   8768:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8769:             push (@Labels,$i+1);
                   8770:         }
                   8771:     }
                   8772:     #
1.129     matthew  8773:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8774:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8775:     my %ValuesHash;
                   8776:     my $NumSets=1;
                   8777:     foreach my $array (@Values) {
                   8778:         next if (! ref($array));
1.136     matthew  8779:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8780:             join(',',@$array);
1.129     matthew  8781:     }
1.127     matthew  8782:     #
1.136     matthew  8783:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8784:     if ($NumBars < 3) {
                   8785:         $width = 120+$NumBars*32;
1.220     matthew  8786:         $xskip = 1;
1.225     matthew  8787:         $bar_width = 30;
                   8788:     } elsif ($NumBars < 5) {
                   8789:         $width = 120+$NumBars*20;
                   8790:         $xskip = 1;
                   8791:         $bar_width = 20;
1.220     matthew  8792:     } elsif ($NumBars < 10) {
1.136     matthew  8793:         $width = 120+$NumBars*15;
                   8794:         $xskip = 1;
                   8795:         $bar_width = 15;
                   8796:     } elsif ($NumBars <= 25) {
                   8797:         $width = 120+$NumBars*11;
                   8798:         $xskip = 5;
                   8799:         $bar_width = 8;
                   8800:     } elsif ($NumBars <= 50) {
                   8801:         $width = 120+$NumBars*8;
                   8802:         $xskip = 5;
                   8803:         $bar_width = 4;
                   8804:     } else {
                   8805:         $width = 120+$NumBars*8;
                   8806:         $xskip = 5;
                   8807:         $bar_width = 4;
                   8808:     }
                   8809:     #
1.137     matthew  8810:     $Max = 1 if ($Max < 1);
                   8811:     if ( int($Max) < $Max ) {
                   8812:         $Max++;
                   8813:         $Max = int($Max);
                   8814:     }
1.127     matthew  8815:     $Title  = '' if (! defined($Title));
                   8816:     $xlabel = '' if (! defined($xlabel));
                   8817:     $ylabel = '' if (! defined($ylabel));
1.369     www      8818:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8819:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8820:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8821:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8822:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8823:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8824:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8825:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8826:     $ValuesHash{$id.'.height'}   = $height;
                   8827:     $ValuesHash{$id.'.width'}    = $width;
                   8828:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8829:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8830:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8831:     #
1.228     matthew  8832:     # Deal with other parameters
                   8833:     while (my ($key,$value) = each(%$extra_settings)) {
                   8834:         $ValuesHash{$id.'.'.$key} = $value;
                   8835:     }
                   8836:     #
1.646     raeburn  8837:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8838:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8839: }
                   8840: 
                   8841: ############################################################
                   8842: ############################################################
                   8843: 
                   8844: =pod
                   8845: 
1.648     raeburn  8846: =item * &DrawXYGraph()
1.137     matthew  8847: 
1.138     matthew  8848: Facilitates the plotting of data in an XY graph.
                   8849: Puts plot definition data into the users environment in order for 
                   8850: graph.png to plot it.  Returns an <img> tag for the plot.
                   8851: 
                   8852: Inputs:
                   8853: 
                   8854: =over 4
                   8855: 
                   8856: =item $Title: string, the title of the plot
                   8857: 
                   8858: =item $xlabel: string, text describing the X-axis of the plot
                   8859: 
                   8860: =item $ylabel: string, text describing the Y-axis of the plot
                   8861: 
                   8862: =item $Max: scalar, the maximum Y value to use in the plot
                   8863: If $Max is < any data point, the graph will not be rendered.
                   8864: 
                   8865: =item $colors: Array ref containing the hex color codes for the data to be 
                   8866: plotted in.  If undefined, default values will be used.
                   8867: 
                   8868: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8869: 
                   8870: =item $Ydata: Array ref containing Array refs.  
1.185     www      8871: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8872: 
                   8873: =item %Values: hash indicating or overriding any default values which are 
                   8874: passed to graph.png.  
                   8875: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8876: 
                   8877: =back
                   8878: 
                   8879: Returns:
                   8880: 
                   8881: An <img> tag which references graph.png and the appropriate identifying
                   8882: information for the plot.
                   8883: 
1.137     matthew  8884: =cut
                   8885: 
                   8886: ############################################################
                   8887: ############################################################
                   8888: sub DrawXYGraph {
                   8889:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8890:     #
                   8891:     # Create the identifier for the graph
                   8892:     my $identifier = &get_cgi_id();
                   8893:     my $id = 'cgi.'.$identifier;
                   8894:     #
                   8895:     $Title  = '' if (! defined($Title));
                   8896:     $xlabel = '' if (! defined($xlabel));
                   8897:     $ylabel = '' if (! defined($ylabel));
                   8898:     my %ValuesHash = 
                   8899:         (
1.369     www      8900:          $id.'.title'  => &escape($Title),
                   8901:          $id.'.xlabel' => &escape($xlabel),
                   8902:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8903:          $id.'.y_max_value'=> $Max,
                   8904:          $id.'.labels'     => join(',',@$Xlabels),
                   8905:          $id.'.PlotType'   => 'XY',
                   8906:          );
                   8907:     #
                   8908:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8909:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8910:     }
                   8911:     #
                   8912:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   8913:         return '';
                   8914:     }
                   8915:     my $NumSets=1;
1.138     matthew  8916:     foreach my $array (@{$Ydata}){
1.137     matthew  8917:         next if (! ref($array));
                   8918:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8919:     }
1.138     matthew  8920:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8921:     #
                   8922:     # Deal with other parameters
                   8923:     while (my ($key,$value) = each(%Values)) {
                   8924:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8925:     }
                   8926:     #
1.646     raeburn  8927:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  8928:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8929: }
                   8930: 
                   8931: ############################################################
                   8932: ############################################################
                   8933: 
                   8934: =pod
                   8935: 
1.648     raeburn  8936: =item * &DrawXYYGraph()
1.138     matthew  8937: 
                   8938: Facilitates the plotting of data in an XY graph with two Y axes.
                   8939: Puts plot definition data into the users environment in order for 
                   8940: graph.png to plot it.  Returns an <img> tag for the plot.
                   8941: 
                   8942: Inputs:
                   8943: 
                   8944: =over 4
                   8945: 
                   8946: =item $Title: string, the title of the plot
                   8947: 
                   8948: =item $xlabel: string, text describing the X-axis of the plot
                   8949: 
                   8950: =item $ylabel: string, text describing the Y-axis of the plot
                   8951: 
                   8952: =item $colors: Array ref containing the hex color codes for the data to be 
                   8953: plotted in.  If undefined, default values will be used.
                   8954: 
                   8955: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8956: 
                   8957: =item $Ydata1: The first data set
                   8958: 
                   8959: =item $Min1: The minimum value of the left Y-axis
                   8960: 
                   8961: =item $Max1: The maximum value of the left Y-axis
                   8962: 
                   8963: =item $Ydata2: The second data set
                   8964: 
                   8965: =item $Min2: The minimum value of the right Y-axis
                   8966: 
                   8967: =item $Max2: The maximum value of the left Y-axis
                   8968: 
                   8969: =item %Values: hash indicating or overriding any default values which are 
                   8970: passed to graph.png.  
                   8971: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8972: 
                   8973: =back
                   8974: 
                   8975: Returns:
                   8976: 
                   8977: An <img> tag which references graph.png and the appropriate identifying
                   8978: information for the plot.
1.136     matthew  8979: 
                   8980: =cut
                   8981: 
                   8982: ############################################################
                   8983: ############################################################
1.137     matthew  8984: sub DrawXYYGraph {
                   8985:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   8986:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  8987:     #
                   8988:     # Create the identifier for the graph
                   8989:     my $identifier = &get_cgi_id();
                   8990:     my $id = 'cgi.'.$identifier;
                   8991:     #
                   8992:     $Title  = '' if (! defined($Title));
                   8993:     $xlabel = '' if (! defined($xlabel));
                   8994:     $ylabel = '' if (! defined($ylabel));
                   8995:     my %ValuesHash = 
                   8996:         (
1.369     www      8997:          $id.'.title'  => &escape($Title),
                   8998:          $id.'.xlabel' => &escape($xlabel),
                   8999:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9000:          $id.'.labels' => join(',',@$Xlabels),
                   9001:          $id.'.PlotType' => 'XY',
                   9002:          $id.'.NumSets' => 2,
1.137     matthew  9003:          $id.'.two_axes' => 1,
                   9004:          $id.'.y1_max_value' => $Max1,
                   9005:          $id.'.y1_min_value' => $Min1,
                   9006:          $id.'.y2_max_value' => $Max2,
                   9007:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9008:          );
                   9009:     #
1.137     matthew  9010:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9011:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9012:     }
                   9013:     #
                   9014:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9015:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9016:         return '';
                   9017:     }
                   9018:     my $NumSets=1;
1.137     matthew  9019:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9020:         next if (! ref($array));
                   9021:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9022:     }
                   9023:     #
                   9024:     # Deal with other parameters
                   9025:     while (my ($key,$value) = each(%Values)) {
                   9026:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9027:     }
                   9028:     #
1.646     raeburn  9029:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9030:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9031: }
                   9032: 
                   9033: ############################################################
                   9034: ############################################################
                   9035: 
                   9036: =pod
                   9037: 
1.157     matthew  9038: =back 
                   9039: 
1.139     matthew  9040: =head1 Statistics helper routines?  
                   9041: 
                   9042: Bad place for them but what the hell.
                   9043: 
1.157     matthew  9044: =over 4
                   9045: 
1.648     raeburn  9046: =item * &chartlink()
1.139     matthew  9047: 
                   9048: Returns a link to the chart for a specific student.  
                   9049: 
                   9050: Inputs:
                   9051: 
                   9052: =over 4
                   9053: 
                   9054: =item $linktext: The text of the link
                   9055: 
                   9056: =item $sname: The students username
                   9057: 
                   9058: =item $sdomain: The students domain
                   9059: 
                   9060: =back
                   9061: 
1.157     matthew  9062: =back
                   9063: 
1.139     matthew  9064: =cut
                   9065: 
                   9066: ############################################################
                   9067: ############################################################
                   9068: sub chartlink {
                   9069:     my ($linktext, $sname, $sdomain) = @_;
                   9070:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9071:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9072:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9073:        '">'.$linktext.'</a>';
1.153     matthew  9074: }
                   9075: 
                   9076: #######################################################
                   9077: #######################################################
                   9078: 
                   9079: =pod
                   9080: 
                   9081: =head1 Course Environment Routines
1.157     matthew  9082: 
                   9083: =over 4
1.153     matthew  9084: 
1.648     raeburn  9085: =item * &restore_course_settings()
1.153     matthew  9086: 
1.648     raeburn  9087: =item * &store_course_settings()
1.153     matthew  9088: 
                   9089: Restores/Store indicated form parameters from the course environment.
                   9090: Will not overwrite existing values of the form parameters.
                   9091: 
                   9092: Inputs: 
                   9093: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9094: 
                   9095: a hash ref describing the data to be stored.  For example:
                   9096:    
                   9097: %Save_Parameters = ('Status' => 'scalar',
                   9098:     'chartoutputmode' => 'scalar',
                   9099:     'chartoutputdata' => 'scalar',
                   9100:     'Section' => 'array',
1.373     raeburn  9101:     'Group' => 'array',
1.153     matthew  9102:     'StudentData' => 'array',
                   9103:     'Maps' => 'array');
                   9104: 
                   9105: Returns: both routines return nothing
                   9106: 
1.631     raeburn  9107: =back
                   9108: 
1.153     matthew  9109: =cut
                   9110: 
                   9111: #######################################################
                   9112: #######################################################
                   9113: sub store_course_settings {
1.496     albertel 9114:     return &store_settings($env{'request.course.id'},@_);
                   9115: }
                   9116: 
                   9117: sub store_settings {
1.153     matthew  9118:     # save to the environment
                   9119:     # appenv the same items, just to be safe
1.300     albertel 9120:     my $udom  = $env{'user.domain'};
                   9121:     my $uname = $env{'user.name'};
1.496     albertel 9122:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9123:     my %SaveHash;
                   9124:     my %AppHash;
                   9125:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9126:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9127:         my $envname = 'environment.'.$basename;
1.258     albertel 9128:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9129:             # Save this value away
                   9130:             if ($type eq 'scalar' &&
1.258     albertel 9131:                 (! exists($env{$envname}) || 
                   9132:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9133:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9134:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9135:             } elsif ($type eq 'array') {
                   9136:                 my $stored_form;
1.258     albertel 9137:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9138:                     $stored_form = join(',',
                   9139:                                         map {
1.369     www      9140:                                             &escape($_);
1.258     albertel 9141:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9142:                 } else {
                   9143:                     $stored_form = 
1.369     www      9144:                         &escape($env{'form.'.$setting});
1.153     matthew  9145:                 }
                   9146:                 # Determine if the array contents are the same.
1.258     albertel 9147:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9148:                     $SaveHash{$basename} = $stored_form;
                   9149:                     $AppHash{$envname}   = $stored_form;
                   9150:                 }
                   9151:             }
                   9152:         }
                   9153:     }
                   9154:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9155:                                           $udom,$uname);
1.153     matthew  9156:     if ($put_result !~ /^(ok|delayed)/) {
                   9157:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9158:                                  'got error:'.$put_result);
                   9159:     }
                   9160:     # Make sure these settings stick around in this session, too
1.646     raeburn  9161:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9162:     return;
                   9163: }
                   9164: 
                   9165: sub restore_course_settings {
1.499     albertel 9166:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9167: }
                   9168: 
                   9169: sub restore_settings {
                   9170:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9171:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9172:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9173:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9174:             '.'.$setting;
1.258     albertel 9175:         if (exists($env{$envname})) {
1.153     matthew  9176:             if ($type eq 'scalar') {
1.258     albertel 9177:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9178:             } elsif ($type eq 'array') {
1.258     albertel 9179:                 $env{'form.'.$setting} = [ 
1.153     matthew  9180:                                            map { 
1.369     www      9181:                                                &unescape($_); 
1.258     albertel 9182:                                            } split(',',$env{$envname})
1.153     matthew  9183:                                            ];
                   9184:             }
                   9185:         }
                   9186:     }
1.127     matthew  9187: }
                   9188: 
1.618     raeburn  9189: #######################################################
                   9190: #######################################################
                   9191: 
                   9192: =pod
                   9193: 
                   9194: =head1 Domain E-mail Routines  
                   9195: 
                   9196: =over 4
                   9197: 
1.648     raeburn  9198: =item * &build_recipient_list()
1.618     raeburn  9199: 
1.766     raeburn  9200: Build recipient lists for four types of e-mail:
                   9201: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
                   9202: (d) Help requests, generated by
                   9203: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618     raeburn  9204: 
                   9205: Inputs:
1.619     raeburn  9206: defmail (scalar - email address of default recipient), 
1.618     raeburn  9207: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9208: defdom (domain for which to retrieve configuration settings),
                   9209: origmail (scalar - email address of recipient from loncapa.conf, 
                   9210: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9211: 
1.655     raeburn  9212: Returns: comma separated list of addresses to which to send e-mail.
                   9213: 
                   9214: =back
1.618     raeburn  9215: 
                   9216: =cut
                   9217: 
                   9218: ############################################################
                   9219: ############################################################
                   9220: sub build_recipient_list {
1.619     raeburn  9221:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9222:     my @recipients;
                   9223:     my $otheremails;
                   9224:     my %domconfig =
                   9225:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9226:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9227:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9228:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9229:                 my @contacts = ('adminemail','supportemail');
                   9230:                 foreach my $item (@contacts) {
                   9231:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9232:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9233:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9234:                             push(@recipients,$addr);
                   9235:                         }
1.619     raeburn  9236:                     }
1.766     raeburn  9237:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9238:                 }
                   9239:             }
1.766     raeburn  9240:         } elsif ($origmail ne '') {
                   9241:             push(@recipients,$origmail);
1.618     raeburn  9242:         }
1.619     raeburn  9243:     } elsif ($origmail ne '') {
                   9244:         push(@recipients,$origmail);
1.618     raeburn  9245:     }
1.688     raeburn  9246:     if (defined($defmail)) {
                   9247:         if ($defmail ne '') {
                   9248:             push(@recipients,$defmail);
                   9249:         }
1.618     raeburn  9250:     }
                   9251:     if ($otheremails) {
1.619     raeburn  9252:         my @others;
                   9253:         if ($otheremails =~ /,/) {
                   9254:             @others = split(/,/,$otheremails);
1.618     raeburn  9255:         } else {
1.619     raeburn  9256:             push(@others,$otheremails);
                   9257:         }
                   9258:         foreach my $addr (@others) {
                   9259:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9260:                 push(@recipients,$addr);
                   9261:             }
1.618     raeburn  9262:         }
                   9263:     }
1.619     raeburn  9264:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9265:     return $recipientlist;
                   9266: }
                   9267: 
1.127     matthew  9268: ############################################################
                   9269: ############################################################
1.154     albertel 9270: 
1.655     raeburn  9271: =pod
                   9272: 
                   9273: =head1 Course Catalog Routines
                   9274: 
                   9275: =over 4
                   9276: 
                   9277: =item * &gather_categories()
                   9278: 
                   9279: Converts category definitions - keys of categories hash stored in  
                   9280: coursecategories in configuration.db on the primary library server in a 
                   9281: domain - to an array.  Also generates javascript and idx hash used to 
                   9282: generate Domain Coordinator interface for editing Course Categories.
                   9283: 
                   9284: Inputs:
1.663     raeburn  9285: 
1.655     raeburn  9286: categories (reference to hash of category definitions).
1.663     raeburn  9287: 
1.655     raeburn  9288: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9289:       categories and subcategories).
1.663     raeburn  9290: 
1.655     raeburn  9291: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9292:       editing Course Categories).
1.663     raeburn  9293: 
1.655     raeburn  9294: jsarray (reference to array of categories used to create Javascript arrays for
                   9295:          Domain Coordinator interface for editing Course Categories).
                   9296: 
                   9297: Returns: nothing
                   9298: 
                   9299: Side effects: populates cats, idx and jsarray. 
                   9300: 
                   9301: =cut
                   9302: 
                   9303: sub gather_categories {
                   9304:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9305:     my %counters;
                   9306:     my $num = 0;
                   9307:     foreach my $item (keys(%{$categories})) {
                   9308:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9309:         if ($container eq '' && $depth == 0) {
                   9310:             $cats->[$depth][$categories->{$item}] = $cat;
                   9311:         } else {
                   9312:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9313:         }
                   9314:         my ($escitem,$tail) = split(/:/,$item,2);
                   9315:         if ($counters{$tail} eq '') {
                   9316:             $counters{$tail} = $num;
                   9317:             $num ++;
                   9318:         }
                   9319:         if (ref($idx) eq 'HASH') {
                   9320:             $idx->{$item} = $counters{$tail};
                   9321:         }
                   9322:         if (ref($jsarray) eq 'ARRAY') {
                   9323:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9324:         }
                   9325:     }
                   9326:     return;
                   9327: }
                   9328: 
                   9329: =pod
                   9330: 
                   9331: =item * &extract_categories()
                   9332: 
                   9333: Used to generate breadcrumb trails for course categories.
                   9334: 
                   9335: Inputs:
1.663     raeburn  9336: 
1.655     raeburn  9337: categories (reference to hash of category definitions).
1.663     raeburn  9338: 
1.655     raeburn  9339: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9340:       categories and subcategories).
1.663     raeburn  9341: 
1.655     raeburn  9342: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9343: 
1.655     raeburn  9344: allitems (reference to hash - key is category key 
                   9345:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9346: 
1.655     raeburn  9347: idx (reference to hash of counters used in Domain Coordinator interface for
                   9348:       editing Course Categories).
1.663     raeburn  9349: 
1.655     raeburn  9350: jsarray (reference to array of categories used to create Javascript arrays for
                   9351:          Domain Coordinator interface for editing Course Categories).
                   9352: 
1.665     raeburn  9353: subcats (reference to hash of arrays containing all subcategories within each 
                   9354:          category, -recursive)
                   9355: 
1.655     raeburn  9356: Returns: nothing
                   9357: 
                   9358: Side effects: populates trails and allitems hash references.
                   9359: 
                   9360: =cut
                   9361: 
                   9362: sub extract_categories {
1.665     raeburn  9363:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9364:     if (ref($categories) eq 'HASH') {
                   9365:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9366:         if (ref($cats->[0]) eq 'ARRAY') {
                   9367:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9368:                 my $name = $cats->[0][$i];
                   9369:                 my $item = &escape($name).'::0';
                   9370:                 my $trailstr;
                   9371:                 if ($name eq 'instcode') {
                   9372:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9373:                 } else {
                   9374:                     $trailstr = $name;
                   9375:                 }
                   9376:                 if ($allitems->{$item} eq '') {
                   9377:                     push(@{$trails},$trailstr);
                   9378:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9379:                 }
                   9380:                 my @parents = ($name);
                   9381:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9382:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9383:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9384:                         if (ref($subcats) eq 'HASH') {
                   9385:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9386:                         }
                   9387:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9388:                     }
                   9389:                 } else {
                   9390:                     if (ref($subcats) eq 'HASH') {
                   9391:                         $subcats->{$item} = [];
1.655     raeburn  9392:                     }
                   9393:                 }
                   9394:             }
                   9395:         }
                   9396:     }
                   9397:     return;
                   9398: }
                   9399: 
                   9400: =pod
                   9401: 
                   9402: =item *&recurse_categories()
                   9403: 
                   9404: Recursively used to generate breadcrumb trails for course categories.
                   9405: 
                   9406: Inputs:
1.663     raeburn  9407: 
1.655     raeburn  9408: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9409:       categories and subcategories).
1.663     raeburn  9410: 
1.655     raeburn  9411: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9412: 
                   9413: category (current course category, for which breadcrumb trail is being generated).
                   9414: 
                   9415: trails (reference to array of breadcrumb trails for each category).
                   9416: 
1.655     raeburn  9417: allitems (reference to hash - key is category key
                   9418:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9419: 
1.655     raeburn  9420: parents (array containing containers directories for current category, 
                   9421:          back to top level). 
                   9422: 
                   9423: Returns: nothing
                   9424: 
                   9425: Side effects: populates trails and allitems hash references
                   9426: 
                   9427: =cut
                   9428: 
                   9429: sub recurse_categories {
1.665     raeburn  9430:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9431:     my $shallower = $depth - 1;
                   9432:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9433:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9434:             my $name = $cats->[$depth]{$category}[$k];
                   9435:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9436:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9437:             if ($allitems->{$item} eq '') {
                   9438:                 push(@{$trails},$trailstr);
                   9439:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9440:             }
                   9441:             my $deeper = $depth+1;
                   9442:             push(@{$parents},$category);
1.665     raeburn  9443:             if (ref($subcats) eq 'HASH') {
                   9444:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9445:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9446:                     my $higher;
                   9447:                     if ($j > 0) {
                   9448:                         $higher = &escape($parents->[$j]).':'.
                   9449:                                   &escape($parents->[$j-1]).':'.$j;
                   9450:                     } else {
                   9451:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9452:                     }
                   9453:                     push(@{$subcats->{$higher}},$subcat);
                   9454:                 }
                   9455:             }
                   9456:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9457:                                 $subcats);
1.655     raeburn  9458:             pop(@{$parents});
                   9459:         }
                   9460:     } else {
                   9461:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9462:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9463:         if ($allitems->{$item} eq '') {
                   9464:             push(@{$trails},$trailstr);
                   9465:             $allitems->{$item} = scalar(@{$trails})-1;
                   9466:         }
                   9467:     }
                   9468:     return;
                   9469: }
                   9470: 
1.663     raeburn  9471: =pod
                   9472: 
                   9473: =item *&assign_categories_table()
                   9474: 
                   9475: Create a datatable for display of hierarchical categories in a domain,
                   9476: with checkboxes to allow a course to be categorized. 
                   9477: 
                   9478: Inputs:
                   9479: 
                   9480: cathash - reference to hash of categories defined for the domain (from
                   9481:           configuration.db)
                   9482: 
                   9483: currcat - scalar with an & separated list of categories assigned to a course. 
                   9484: 
                   9485: Returns: $output (markup to be displayed) 
                   9486: 
                   9487: =cut
                   9488: 
                   9489: sub assign_categories_table {
                   9490:     my ($cathash,$currcat) = @_;
                   9491:     my $output;
                   9492:     if (ref($cathash) eq 'HASH') {
                   9493:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9494:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9495:         $maxdepth = scalar(@cats);
                   9496:         if (@cats > 0) {
                   9497:             my $itemcount = 0;
                   9498:             if (ref($cats[0]) eq 'ARRAY') {
                   9499:                 $output = &Apache::loncommon::start_data_table();
                   9500:                 my @currcategories;
                   9501:                 if ($currcat ne '') {
                   9502:                     @currcategories = split('&',$currcat);
                   9503:                 }
                   9504:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9505:                     my $parent = $cats[0][$i];
                   9506:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9507:                     next if ($parent eq 'instcode');
                   9508:                     my $item = &escape($parent).'::0';
                   9509:                     my $checked = '';
                   9510:                     if (@currcategories > 0) {
                   9511:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9512:                             $checked = ' checked="checked"';
1.663     raeburn  9513:                         }
                   9514:                     }
1.675     raeburn  9515:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9516:                                '<input type="checkbox" name="usecategory" value="'.
                   9517:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9518:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9519:                     my $depth = 1;
                   9520:                     push(@path,$parent);
                   9521:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9522:                     pop(@path);
                   9523:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9524:                     $itemcount ++;
                   9525:                 }
                   9526:                 $output .= &Apache::loncommon::end_data_table();
                   9527:             }
                   9528:         }
                   9529:     }
                   9530:     return $output;
                   9531: }
                   9532: 
                   9533: =pod
                   9534: 
                   9535: =item *&assign_category_rows()
                   9536: 
                   9537: Create a datatable row for display of nested categories in a domain,
                   9538: with checkboxes to allow a course to be categorized,called recursively.
                   9539: 
                   9540: Inputs:
                   9541: 
                   9542: itemcount - track row number for alternating colors
                   9543: 
                   9544: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9545:       categories and subcategories.
                   9546: 
                   9547: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9548: 
                   9549: parent - parent of current category item
                   9550: 
                   9551: path - Array containing all categories back up through the hierarchy from the
                   9552:        current category to the top level.
                   9553: 
                   9554: currcategories - reference to array of current categories assigned to the course
                   9555: 
                   9556: Returns: $output (markup to be displayed).
                   9557: 
                   9558: =cut
                   9559: 
                   9560: sub assign_category_rows {
                   9561:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9562:     my ($text,$name,$item,$chgstr);
                   9563:     if (ref($cats) eq 'ARRAY') {
                   9564:         my $maxdepth = scalar(@{$cats});
                   9565:         if (ref($cats->[$depth]) eq 'HASH') {
                   9566:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9567:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9568:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9569:                 $text .= '<td><table class="LC_datatable">';
                   9570:                 for (my $j=0; $j<$numchildren; $j++) {
                   9571:                     $name = $cats->[$depth]{$parent}[$j];
                   9572:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9573:                     my $deeper = $depth+1;
                   9574:                     my $checked = '';
                   9575:                     if (ref($currcategories) eq 'ARRAY') {
                   9576:                         if (@{$currcategories} > 0) {
                   9577:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9578:                                 $checked = ' checked="checked"';
1.663     raeburn  9579:                             }
                   9580:                         }
                   9581:                     }
1.664     raeburn  9582:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9583:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9584:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9585:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9586:                              '</td><td>';
1.663     raeburn  9587:                     if (ref($path) eq 'ARRAY') {
                   9588:                         push(@{$path},$name);
                   9589:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9590:                         pop(@{$path});
                   9591:                     }
                   9592:                     $text .= '</td></tr>';
                   9593:                 }
                   9594:                 $text .= '</table></td>';
                   9595:             }
                   9596:         }
                   9597:     }
                   9598:     return $text;
                   9599: }
                   9600: 
1.655     raeburn  9601: ############################################################
                   9602: ############################################################
                   9603: 
                   9604: 
1.443     albertel 9605: sub commit_customrole {
1.664     raeburn  9606:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9607:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9608:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9609:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9610:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9611:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9612:                  '</b><br />';
                   9613:     return $output;
                   9614: }
                   9615: 
                   9616: sub commit_standardrole {
1.541     raeburn  9617:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9618:     my ($output,$logmsg,$linefeed);
                   9619:     if ($context eq 'auto') {
                   9620:         $linefeed = "\n";
                   9621:     } else {
                   9622:         $linefeed = "<br />\n";
                   9623:     }  
1.443     albertel 9624:     if ($three eq 'st') {
1.541     raeburn  9625:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9626:                                          $one,$two,$sec,$context);
                   9627:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9628:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9629:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9630:         } else {
1.541     raeburn  9631:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9632:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9633:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9634:             if ($context eq 'auto') {
                   9635:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9636:             } else {
                   9637:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9638:                &mt('Add to classlist').': <b>ok</b>';
                   9639:             }
                   9640:             $output .= $linefeed;
1.443     albertel 9641:         }
                   9642:     } else {
                   9643:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9644:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9645:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9646:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9647:         if ($context eq 'auto') {
                   9648:             $output .= $result.$linefeed;
                   9649:         } else {
                   9650:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9651:         }
1.443     albertel 9652:     }
                   9653:     return $output;
                   9654: }
                   9655: 
                   9656: sub commit_studentrole {
1.541     raeburn  9657:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9658:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9659:     if ($context eq 'auto') {
                   9660:         $linefeed = "\n";
                   9661:     } else {
                   9662:         $linefeed = '<br />'."\n";
                   9663:     }
1.443     albertel 9664:     if (defined($one) && defined($two)) {
                   9665:         my $cid=$one.'_'.$two;
                   9666:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9667:         my $secchange = 0;
                   9668:         my $expire_role_result;
                   9669:         my $modify_section_result;
1.628     raeburn  9670:         if ($oldsec ne '-1') { 
                   9671:             if ($oldsec ne $sec) {
1.443     albertel 9672:                 $secchange = 1;
1.628     raeburn  9673:                 my $now = time;
1.443     albertel 9674:                 my $uurl='/'.$cid;
                   9675:                 $uurl=~s/\_/\//g;
                   9676:                 if ($oldsec) {
                   9677:                     $uurl.='/'.$oldsec;
                   9678:                 }
1.626     raeburn  9679:                 $oldsecurl = $uurl;
1.628     raeburn  9680:                 $expire_role_result = 
1.652     raeburn  9681:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9682:                 if ($env{'request.course.sec'} ne '') { 
                   9683:                     if ($expire_role_result eq 'refused') {
                   9684:                         my @roles = ('st');
                   9685:                         my @statuses = ('previous');
                   9686:                         my @roledoms = ($one);
                   9687:                         my $withsec = 1;
                   9688:                         my %roleshash = 
                   9689:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9690:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9691:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9692:                             my ($oldstart,$oldend) = 
                   9693:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9694:                             if ($oldend > 0 && $oldend <= $now) {
                   9695:                                 $expire_role_result = 'ok';
                   9696:                             }
                   9697:                         }
                   9698:                     }
                   9699:                 }
1.443     albertel 9700:                 $result = $expire_role_result;
                   9701:             }
                   9702:         }
                   9703:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9704:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9705:             if ($modify_section_result =~ /^ok/) {
                   9706:                 if ($secchange == 1) {
1.628     raeburn  9707:                     if ($sec eq '') {
                   9708:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9709:                     } else {
                   9710:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9711:                     }
1.443     albertel 9712:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9713:                     if ($sec eq '') {
                   9714:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9715:                     } else {
                   9716:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9717:                     }
1.443     albertel 9718:                 } else {
1.628     raeburn  9719:                     if ($sec eq '') {
                   9720:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9721:                     } else {
                   9722:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9723:                     }
1.443     albertel 9724:                 }
                   9725:             } else {
1.628     raeburn  9726:                 if ($secchange) {       
                   9727:                     $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9728:                 } else {
                   9729:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9730:                 }
1.443     albertel 9731:             }
                   9732:             $result = $modify_section_result;
                   9733:         } elsif ($secchange == 1) {
1.628     raeburn  9734:             if ($oldsec eq '') {
                   9735:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9736:             } else {
                   9737:                 $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
                   9738:             }
1.626     raeburn  9739:             if ($expire_role_result eq 'refused') {
                   9740:                 my $newsecurl = '/'.$cid;
                   9741:                 $newsecurl =~ s/\_/\//g;
                   9742:                 if ($sec ne '') {
                   9743:                     $newsecurl.='/'.$sec;
                   9744:                 }
                   9745:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9746:                     if ($sec eq '') {
                   9747:                         $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
                   9748:                     } else {
                   9749:                         $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
                   9750:                     }
                   9751:                 }
                   9752:             }
1.443     albertel 9753:         }
                   9754:     } else {
1.626     raeburn  9755:         $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443     albertel 9756:         $result = "error: incomplete course id\n";
                   9757:     }
                   9758:     return $result;
                   9759: }
                   9760: 
                   9761: ############################################################
                   9762: ############################################################
                   9763: 
1.566     albertel 9764: sub check_clone {
1.578     raeburn  9765:     my ($args,$linefeed) = @_;
1.566     albertel 9766:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9767:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9768:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9769:     my $clonemsg;
                   9770:     my $can_clone = 0;
                   9771: 
                   9772:     if ($clonehome eq 'no_host') {
1.578     raeburn  9773:         $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});     
1.566     albertel 9774:     } else {
                   9775: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 9776: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 9777: 	    $can_clone = 1;
                   9778: 	} else {
                   9779: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9780: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9781: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9782:             if (grep(/^\*$/,@cloners)) {
                   9783:                 $can_clone = 1;
                   9784:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9785:                 $can_clone = 1;
                   9786:             } else {
                   9787: 	        my %roleshash =
                   9788: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9789: 					 $args->{'ccdomain'},
                   9790:                                          'userroles',['active'],['cc'],
                   9791: 					 [$args->{'clonedomain'}]);
                   9792: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9793: 		    $can_clone = 1;
                   9794: 	        } else {
                   9795:                     $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   9796: 	        }
1.566     albertel 9797: 	    }
1.578     raeburn  9798:         }
1.566     albertel 9799:     }
                   9800:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9801: }
                   9802: 
1.444     albertel 9803: sub construct_course {
1.541     raeburn  9804:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 9805:     my $outcome;
1.541     raeburn  9806:     my $linefeed =  '<br />'."\n";
                   9807:     if ($context eq 'auto') {
                   9808:         $linefeed = "\n";
                   9809:     }
1.566     albertel 9810: 
                   9811: #
                   9812: # Are we cloning?
                   9813: #
                   9814:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9815:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9816: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9817: 	if ($context ne 'auto') {
1.578     raeburn  9818:             if ($clonemsg ne '') {
                   9819: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9820:             }
1.566     albertel 9821: 	}
                   9822: 	$outcome .= $clonemsg.$linefeed;
                   9823: 
                   9824:         if (!$can_clone) {
                   9825: 	    return (0,$outcome);
                   9826: 	}
                   9827:     }
                   9828: 
1.444     albertel 9829: #
                   9830: # Open course
                   9831: #
                   9832:     my $crstype = lc($args->{'crstype'});
                   9833:     my %cenv=();
                   9834:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9835:                                              $args->{'cdescr'},
                   9836:                                              $args->{'curl'},
                   9837:                                              $args->{'course_home'},
                   9838:                                              $args->{'nonstandard'},
                   9839:                                              $args->{'crscode'},
                   9840:                                              $args->{'ccuname'}.':'.
                   9841:                                              $args->{'ccdomain'},
                   9842:                                              $args->{'crstype'});
                   9843: 
                   9844:     # Note: The testing routines depend on this being output; see 
                   9845:     # Utils::Course. This needs to at least be output as a comment
                   9846:     # if anyone ever decides to not show this, and Utils::Course::new
                   9847:     # will need to be suitably modified.
1.541     raeburn  9848:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9849: #
                   9850: # Check if created correctly
                   9851: #
1.479     albertel 9852:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9853:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9854:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9855: 
1.444     albertel 9856: #
1.566     albertel 9857: # Do the cloning
                   9858: #   
                   9859:     if ($can_clone && $cloneid) {
                   9860: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9861: 	if ($context ne 'auto') {
                   9862: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9863: 	}
                   9864: 	$outcome .= $clonemsg.$linefeed;
                   9865: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9866: # Copy all files
1.637     www      9867: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9868: # Restore URL
1.566     albertel 9869: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9870: # Restore title
1.566     albertel 9871: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9872: # Mark as cloned
1.566     albertel 9873: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9874: # Need to clone grading mode
                   9875:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9876:         $cenv{'grading'}=$newenv{'grading'};
                   9877: # Do not clone these environment entries
                   9878:         &Apache::lonnet::del('environment',
                   9879:                   ['default_enrollment_start_date',
                   9880:                    'default_enrollment_end_date',
                   9881:                    'question.email',
                   9882:                    'policy.email',
                   9883:                    'comment.email',
                   9884:                    'pch.users.denied',
1.725     raeburn  9885:                    'plc.users.denied',
                   9886:                    'hidefromcat',
                   9887:                    'categories'],
1.638     www      9888:                    $$crsudom,$$crsunum);
1.444     albertel 9889:     }
1.566     albertel 9890: 
1.444     albertel 9891: #
                   9892: # Set environment (will override cloned, if existing)
                   9893: #
                   9894:     my @sections = ();
                   9895:     my @xlists = ();
                   9896:     if ($args->{'crstype'}) {
                   9897:         $cenv{'type'}=$args->{'crstype'};
                   9898:     }
                   9899:     if ($args->{'crsid'}) {
                   9900:         $cenv{'courseid'}=$args->{'crsid'};
                   9901:     }
                   9902:     if ($args->{'crscode'}) {
                   9903:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9904:     }
                   9905:     if ($args->{'crsquota'} ne '') {
                   9906:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9907:     } else {
                   9908:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   9909:     }
                   9910:     if ($args->{'ccuname'}) {
                   9911:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   9912:                                         ':'.$args->{'ccdomain'};
                   9913:     } else {
                   9914:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   9915:     }
                   9916:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   9917:     if ($args->{'crssections'}) {
                   9918:         $cenv{'internal.sectionnums'} = '';
                   9919:         if ($args->{'crssections'} =~ m/,/) {
                   9920:             @sections = split/,/,$args->{'crssections'};
                   9921:         } else {
                   9922:             $sections[0] = $args->{'crssections'};
                   9923:         }
                   9924:         if (@sections > 0) {
                   9925:             foreach my $item (@sections) {
                   9926:                 my ($sec,$gp) = split/:/,$item;
                   9927:                 my $class = $args->{'crscode'}.$sec;
                   9928:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   9929:                 $cenv{'internal.sectionnums'} .= $item.',';
                   9930:                 unless ($addcheck eq 'ok') {
                   9931:                     push @badclasses, $class;
                   9932:                 }
                   9933:             }
                   9934:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   9935:         }
                   9936:     }
                   9937: # do not hide course coordinator from staff listing, 
                   9938: # even if privileged
                   9939:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9940: # add crosslistings
                   9941:     if ($args->{'crsxlist'}) {
                   9942:         $cenv{'internal.crosslistings'}='';
                   9943:         if ($args->{'crsxlist'} =~ m/,/) {
                   9944:             @xlists = split/,/,$args->{'crsxlist'};
                   9945:         } else {
                   9946:             $xlists[0] = $args->{'crsxlist'};
                   9947:         }
                   9948:         if (@xlists > 0) {
                   9949:             foreach my $item (@xlists) {
                   9950:                 my ($xl,$gp) = split/:/,$item;
                   9951:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   9952:                 $cenv{'internal.crosslistings'} .= $item.',';
                   9953:                 unless ($addcheck eq 'ok') {
                   9954:                     push @badclasses, $xl;
                   9955:                 }
                   9956:             }
                   9957:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   9958:         }
                   9959:     }
                   9960:     if ($args->{'autoadds'}) {
                   9961:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   9962:     }
                   9963:     if ($args->{'autodrops'}) {
                   9964:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   9965:     }
                   9966: # check for notification of enrollment changes
                   9967:     my @notified = ();
                   9968:     if ($args->{'notify_owner'}) {
                   9969:         if ($args->{'ccuname'} ne '') {
                   9970:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   9971:         }
                   9972:     }
                   9973:     if ($args->{'notify_dc'}) {
                   9974:         if ($uname ne '') { 
1.630     raeburn  9975:             push(@notified,$uname.':'.$udom);
1.444     albertel 9976:         }
                   9977:     }
                   9978:     if (@notified > 0) {
                   9979:         my $notifylist;
                   9980:         if (@notified > 1) {
                   9981:             $notifylist = join(',',@notified);
                   9982:         } else {
                   9983:             $notifylist = $notified[0];
                   9984:         }
                   9985:         $cenv{'internal.notifylist'} = $notifylist;
                   9986:     }
                   9987:     if (@badclasses > 0) {
                   9988:         my %lt=&Apache::lonlocal::texthash(
                   9989:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.  However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
                   9990:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   9991:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   9992:         );
1.541     raeburn  9993:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   9994:                            ' ('.$lt{'adby'}.')';
                   9995:         if ($context eq 'auto') {
                   9996:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 9997:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  9998:             foreach my $item (@badclasses) {
                   9999:                 if ($context eq 'auto') {
                   10000:                     $outcome .= " - $item\n";
                   10001:                 } else {
                   10002:                     $outcome .= "<li>$item</li>\n";
                   10003:                 }
                   10004:             }
                   10005:             if ($context eq 'auto') {
                   10006:                 $outcome .= $linefeed;
                   10007:             } else {
1.566     albertel 10008:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10009:             }
                   10010:         } 
1.444     albertel 10011:     }
                   10012:     if ($args->{'no_end_date'}) {
                   10013:         $args->{'endaccess'} = 0;
                   10014:     }
                   10015:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10016:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10017:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10018:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10019:     if ($args->{'showphotos'}) {
                   10020:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10021:     }
                   10022:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10023:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10024:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10025:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10026:             my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student'); 
                   10027:             if ($context eq 'auto') {
                   10028:                 $outcome .= $krb_msg;
                   10029:             } else {
1.566     albertel 10030:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10031:             }
                   10032:             $outcome .= $linefeed;
1.444     albertel 10033:         }
                   10034:     }
                   10035:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10036:        if ($args->{'setpolicy'}) {
                   10037:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10038:        }
                   10039:        if ($args->{'setcontent'}) {
                   10040:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10041:        }
                   10042:     }
                   10043:     if ($args->{'reshome'}) {
                   10044: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10045: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10046:     }
                   10047: #
                   10048: # course has keyed access
                   10049: #
                   10050:     if ($args->{'setkeys'}) {
                   10051:        $cenv{'keyaccess'}='yes';
                   10052:     }
                   10053: # if specified, key authority is not course, but user
                   10054: # only active if keyaccess is yes
                   10055:     if ($args->{'keyauth'}) {
1.487     albertel 10056: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10057: 	$user = &LONCAPA::clean_username($user);
                   10058: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10059: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10060: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10061: 	}
                   10062:     }
                   10063: 
                   10064:     if ($args->{'disresdis'}) {
                   10065:         $cenv{'pch.roles.denied'}='st';
                   10066:     }
                   10067:     if ($args->{'disablechat'}) {
                   10068:         $cenv{'plc.roles.denied'}='st';
                   10069:     }
                   10070: 
                   10071:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10072:     # course
                   10073:     $cenv{'course.helper.not.run'} = 1;
                   10074:     #
                   10075:     # Use new Randomseed
                   10076:     #
                   10077:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10078:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10079:     #
                   10080:     # The encryption code and receipt prefix for this course
                   10081:     #
                   10082:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10083:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10084:     #
                   10085:     # By default, use standard grading
                   10086:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10087: 
1.541     raeburn  10088:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10089:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10090: #
                   10091: # Open all assignments
                   10092: #
                   10093:     if ($args->{'openall'}) {
                   10094:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10095:        my %storecontent = ($storeunder         => time,
                   10096:                            $storeunder.'.type' => 'date_start');
                   10097:        
                   10098:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10099:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10100:    }
                   10101: #
                   10102: # Set first page
                   10103: #
                   10104:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10105: 	    || ($cloneid)) {
1.445     albertel 10106: 	use LONCAPA::map;
1.444     albertel 10107: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10108: 
                   10109: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10110:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10111: 
1.444     albertel 10112:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10113:         my $title; my $url;
                   10114:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10115: 	    $title=&mt('Syllabus');
1.444     albertel 10116:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10117:         } else {
1.690     bisitz   10118:             $title=&mt('Navigate Contents');
1.444     albertel 10119:             $url='/adm/navmaps';
                   10120:         }
1.445     albertel 10121: 
                   10122:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10123: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10124: 
                   10125: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10126:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10127:     }
1.566     albertel 10128: 
                   10129:     return (1,$outcome);
1.444     albertel 10130: }
                   10131: 
                   10132: ############################################################
                   10133: ############################################################
                   10134: 
1.378     raeburn  10135: sub course_type {
                   10136:     my ($cid) = @_;
                   10137:     if (!defined($cid)) {
                   10138:         $cid = $env{'request.course.id'};
                   10139:     }
1.404     albertel 10140:     if (defined($env{'course.'.$cid.'.type'})) {
                   10141:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10142:     } else {
                   10143:         return 'Course';
1.377     raeburn  10144:     }
                   10145: }
1.156     albertel 10146: 
1.406     raeburn  10147: sub group_term {
                   10148:     my $crstype = &course_type();
                   10149:     my %names = (
                   10150:                   'Course' => 'group',
                   10151:                   'Group' => 'team',
                   10152:                 );
                   10153:     return $names{$crstype};
                   10154: }
                   10155: 
1.156     albertel 10156: sub icon {
                   10157:     my ($file)=@_;
1.505     albertel 10158:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10159:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10160:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10161:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10162: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10163: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10164: 	            $curfext.".gif") {
                   10165: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10166: 		$curfext.".gif";
                   10167: 	}
                   10168:     }
1.249     albertel 10169:     return &lonhttpdurl($iconname);
1.154     albertel 10170: } 
1.84      albertel 10171: 
1.575     albertel 10172: sub lonhttpdurl {
1.692     www      10173: #
                   10174: # Had been used for "small fry" static images on separate port 8080.
                   10175: # Modify here if lightweight http functionality desired again.
                   10176: # Currently eliminated due to increasing firewall issues.
                   10177: #
1.575     albertel 10178:     my ($url)=@_;
1.692     www      10179:     return $url;
1.215     albertel 10180: }
                   10181: 
1.213     albertel 10182: sub connection_aborted {
                   10183:     my ($r)=@_;
                   10184:     $r->print(" ");$r->rflush();
                   10185:     my $c = $r->connection;
                   10186:     return $c->aborted();
                   10187: }
                   10188: 
1.221     foxr     10189: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10190: #    strings as 'strings'.
                   10191: sub escape_single {
1.221     foxr     10192:     my ($input) = @_;
1.223     albertel 10193:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10194:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10195:     return $input;
                   10196: }
1.223     albertel 10197: 
1.222     foxr     10198: #  Same as escape_single, but escape's "'s  This 
                   10199: #  can be used for  "strings"
                   10200: sub escape_double {
                   10201:     my ($input) = @_;
                   10202:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10203:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10204:     return $input;
                   10205: }
1.223     albertel 10206:  
1.222     foxr     10207: #   Escapes the last element of a full URL.
                   10208: sub escape_url {
                   10209:     my ($url)   = @_;
1.238     raeburn  10210:     my @urlslices = split(/\//, $url,-1);
1.369     www      10211:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10212:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10213: }
1.462     albertel 10214: 
1.820   ! raeburn  10215: sub compare_arrays {
        !          10216:     my ($arrayref1,$arrayref2) = @_;
        !          10217:     my (@difference,%count);
        !          10218:     @difference = ();
        !          10219:     %count = ();
        !          10220:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
        !          10221:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
        !          10222:         foreach my $element (keys(%count)) {
        !          10223:             if ($count{$element} == 1) {
        !          10224:                 push(@difference,$element);
        !          10225:             }
        !          10226:         }
        !          10227:     }
        !          10228:     return @difference;
        !          10229: }
        !          10230: 
1.817     bisitz   10231: # -------------------------------------------------------- Initialize user login
1.462     albertel 10232: sub init_user_environment {
1.463     albertel 10233:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10234:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10235: 
                   10236:     my $public=($username eq 'public' && $domain eq 'public');
                   10237: 
                   10238: # See if old ID present, if so, remove
                   10239: 
                   10240:     my ($filename,$cookie,$userroles);
                   10241:     my $now=time;
                   10242: 
                   10243:     if ($public) {
                   10244: 	my $max_public=100;
                   10245: 	my $oldest;
                   10246: 	my $oldest_time=0;
                   10247: 	for(my $next=1;$next<=$max_public;$next++) {
                   10248: 	    if (-e $lonids."/publicuser_$next.id") {
                   10249: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10250: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10251: 		    $oldest_time=$mtime;
                   10252: 		    $oldest=$next;
                   10253: 		}
                   10254: 	    } else {
                   10255: 		$cookie="publicuser_$next";
                   10256: 		last;
                   10257: 	    }
                   10258: 	}
                   10259: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10260:     } else {
1.463     albertel 10261: 	# if this isn't a robot, kill any existing non-robot sessions
                   10262: 	if (!$args->{'robot'}) {
                   10263: 	    opendir(DIR,$lonids);
                   10264: 	    while ($filename=readdir(DIR)) {
                   10265: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10266: 		    unlink($lonids.'/'.$filename);
                   10267: 		}
1.462     albertel 10268: 	    }
1.463     albertel 10269: 	    closedir(DIR);
1.462     albertel 10270: 	}
                   10271: # Give them a new cookie
1.463     albertel 10272: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10273: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10274: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10275:     
                   10276: # Initialize roles
                   10277: 
                   10278: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10279:     }
                   10280: # ------------------------------------ Check browser type and MathML capability
                   10281: 
                   10282:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10283:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10284: 
                   10285: # ------------------------------------------------------------- Get environment
                   10286: 
                   10287:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10288:     my ($tmp) = keys(%userenv);
                   10289:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10290: 	# default remote control to off
                   10291: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10292:     } else {
                   10293: 	undef(%userenv);
                   10294:     }
                   10295:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10296: 	$form->{'interface'}=$userenv{'interface'};
                   10297:     }
                   10298:     $env{'environment.remote'}=$userenv{'remote'};
                   10299:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10300: 
                   10301: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10302:     foreach my $option ('interface','localpath','localres') {
                   10303:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10304:     }
                   10305: # --------------------------------------------------------- Write first profile
                   10306: 
                   10307:     {
                   10308: 	my %initial_env = 
                   10309: 	    ("user.name"          => $username,
                   10310: 	     "user.domain"        => $domain,
                   10311: 	     "user.home"          => $authhost,
                   10312: 	     "browser.type"       => $clientbrowser,
                   10313: 	     "browser.version"    => $clientversion,
                   10314: 	     "browser.mathml"     => $clientmathml,
                   10315: 	     "browser.unicode"    => $clientunicode,
                   10316: 	     "browser.os"         => $clientos,
                   10317: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10318: 	     "request.course.fn"  => '',
                   10319: 	     "request.course.uri" => '',
                   10320: 	     "request.course.sec" => '',
                   10321: 	     "request.role"       => 'cm',
                   10322: 	     "request.role.adv"   => $env{'user.adv'},
                   10323: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10324: 
                   10325:         if ($form->{'localpath'}) {
                   10326: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10327: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10328:         }
                   10329: 	
                   10330: 	if ($public) {
                   10331: 	    $initial_env{"environment.remote"} = "off";
                   10332: 	}
                   10333: 	if ($form->{'interface'}) {
                   10334: 	    $form->{'interface'}=~s/\W//gs;
                   10335: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10336: 	    $env{'browser.interface'}=$form->{'interface'};
                   10337: 	}
                   10338: 
1.724     raeburn  10339:         foreach my $tool ('aboutme','blog','portfolio') {
                   10340:             $userenv{'availabletools.'.$tool} = 
                   10341:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10342:         }
                   10343: 
1.765     raeburn  10344:         foreach my $crstype ('official','unofficial') {
                   10345:             $userenv{'canrequest.'.$crstype} =
                   10346:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10347:                                                   'reload','requestcourses');
                   10348:         }
                   10349: 
1.462     albertel 10350: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10351: 	
                   10352: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10353: 		 &GDBM_WRCREAT(),0640)) {
                   10354: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10355: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10356: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10357: 	    if (ref($args->{'extra_env'})) {
                   10358: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10359: 	    }
1.462     albertel 10360: 	    untie(%disk_env);
                   10361: 	} else {
1.705     tempelho 10362: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10363: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10364: 	    return 'error: '.$!;
                   10365: 	}
                   10366:     }
                   10367:     $env{'request.role'}='cm';
                   10368:     $env{'request.role.adv'}=$env{'user.adv'};
                   10369:     $env{'browser.type'}=$clientbrowser;
                   10370: 
                   10371:     return $cookie;
                   10372: 
                   10373: }
                   10374: 
                   10375: sub _add_to_env {
                   10376:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10377:     if (ref($env_data) eq 'HASH') {
                   10378:         while (my ($key,$value) = each(%$env_data)) {
                   10379: 	    $idf->{$prefix.$key} = $value;
                   10380: 	    $env{$prefix.$key}   = $value;
                   10381:         }
1.462     albertel 10382:     }
                   10383: }
                   10384: 
1.685     tempelho 10385: # --- Get the symbolic name of a problem and the url
                   10386: sub get_symb {
                   10387:     my ($request,$silent) = @_;
1.726     raeburn  10388:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10389:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10390:     if ($symb eq '') {
                   10391:         if (!$silent) {
                   10392:             $request->print("Unable to handle ambiguous references:$url:.");
                   10393:             return ();
                   10394:         }
                   10395:     }
                   10396:     &Apache::lonenc::check_decrypt(\$symb);
                   10397:     return ($symb);
                   10398: }
                   10399: 
                   10400: # --------------------------------------------------------------Get annotation
                   10401: 
                   10402: sub get_annotation {
                   10403:     my ($symb,$enc) = @_;
                   10404: 
                   10405:     my $key = $symb;
                   10406:     if (!$enc) {
                   10407:         $key =
                   10408:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10409:     }
                   10410:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10411:     return $annotation{$key};
                   10412: }
                   10413: 
                   10414: sub clean_symb {
1.731     raeburn  10415:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10416: 
                   10417:     &Apache::lonenc::check_decrypt(\$symb);
                   10418:     my $enc = $env{'request.enc'};
1.731     raeburn  10419:     if ($delete_enc) {
1.730     raeburn  10420:         delete($env{'request.enc'});
                   10421:     }
1.685     tempelho 10422: 
                   10423:     return ($symb,$enc);
                   10424: }
1.462     albertel 10425: 
1.41      ng       10426: =pod
                   10427: 
                   10428: =back
                   10429: 
1.112     bowersj2 10430: =cut
1.41      ng       10431: 
1.112     bowersj2 10432: 1;
                   10433: __END__;
1.41      ng       10434: 

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