File:  [LON-CAPA] / loncom / interface / loncommon.pm
Revision 1.824: download - view: text, annotated - select for diffs
Fri May 22 17:57:19 2009 UTC (15 years ago) by bisitz
Branches: MAIN
CVS tags: HEAD
XHTML:
- Properly exclude javascript code from being interpreted as HTML code
- Added alt attributes to <img> tags
- Lower case attributes (onclick)
- Added dummy action to <form>

- Added error style to lonroles error message

    1: # The LearningOnline Network with CAPA
    2: # a pile of common routines
    3: #
    4: # $Id: loncommon.pm,v 1.824 2009/05/22 17:57:19 bisitz Exp $
    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: #
   28: 
   29: # Makes a table out of the previous attempts
   30: # Inputs result_from_symbread, user, domain, course_id
   31: # Reads in non-network-related .tab files
   32: 
   33: # POD header:
   34: 
   35: =pod
   36: 
   37: =head1 NAME
   38: 
   39: Apache::loncommon - pile of common routines
   40: 
   41: =head1 SYNOPSIS
   42: 
   43: Common routines for manipulating connections, student answers,
   44:     domains, common Javascript fragments, etc.
   45: 
   46: =head1 OVERVIEW
   47: 
   48: A collection of commonly used subroutines that don't have a natural
   49: home anywhere else. This collection helps remove
   50: redundancy from other modules and increase efficiency of memory usage.
   51: 
   52: =cut 
   53: 
   54: # End of POD header
   55: package Apache::loncommon;
   56: 
   57: use strict;
   58: use Apache::lonnet;
   59: use GDBM_File;
   60: use POSIX qw(strftime mktime);
   61: use Apache::lonmenu();
   62: use Apache::lonenc();
   63: use Apache::lonlocal;
   64: use Apache::lonnet();
   65: use HTML::Entities;
   66: use Apache::lonhtmlcommon();
   67: use Apache::loncoursedata();
   68: use Apache::lontexconvert();
   69: use Apache::lonclonecourse();
   70: use LONCAPA qw(:DEFAULT :match);
   71: use DateTime::TimeZone;
   72: use DateTime::Locale::Catalog;
   73: 
   74: # ---------------------------------------------- Designs
   75: use vars qw(%defaultdesign);
   76: 
   77: my $readit;
   78: 
   79: 
   80: ##
   81: ## Global Variables
   82: ##
   83: 
   84: 
   85: # ----------------------------------------------- SSI with retries:
   86: #
   87: 
   88: =pod
   89: 
   90: =head1 Server Side include with retries:
   91: 
   92: =over 4
   93: 
   94: =item * &ssi_with_retries(resource,retries form)
   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:
  101: 
  102: =over 4
  103: 
  104: resource   - Identifies the resource to insert.
  105: 
  106: retries    - Count of the number of retries allowed.
  107: 
  108: form       - Hash that identifies the rendering options.
  109: 
  110: =back
  111: 
  112: Returns:
  113: 
  114: =over 4
  115: 
  116: content    - The content of the response.  If retries were exhausted this is empty.
  117: 
  118: response   - The response from the last attempt (which may or may not have been successful.
  119: 
  120: =back
  121: 
  122: =back
  123: 
  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;
  139:         if (!$ok) {
  140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
  141:         }
  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: 
  154: # ----------------------------------------------- Filetypes/Languages/Copyright
  155: my %language;
  156: my %supported_language;
  157: my %cprtag;
  158: my %scprtag;
  159: my %fe; my %fd; my %fm;
  160: my %category_extensions;
  161: 
  162: # ---------------------------------------------- Thesaurus variables
  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.
  168: 
  169: my %Keywords;
  170: my $thesaurus_db_file;
  171: 
  172: #
  173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
  174: # thesaurus.tab, and filecategories.tab.
  175: #
  176: BEGIN {
  177:     # Variable initialization
  178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
  179:     #
  180:     unless ($readit) {
  181: # ------------------------------------------------------------------- languages
  182:     {
  183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
  184:                                    '/language.tab';
  185:         if ( open(my $fh,"<$langtabfile") ) {
  186:             while (my $line = <$fh>) {
  187:                 next if ($line=~/^\#/);
  188:                 chomp($line);
  189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
  190:                 $language{$key}=$val.' - '.$enc;
  191:                 if ($sup) {
  192:                     $supported_language{$key}=$sup;
  193:                 }
  194:             }
  195:             close($fh);
  196:         }
  197:     }
  198: # ------------------------------------------------------------------ copyrights
  199:     {
  200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
  201:                                   '/copyright.tab';
  202:         if ( open (my $fh,"<$copyrightfile") ) {
  203:             while (my $line = <$fh>) {
  204:                 next if ($line=~/^\#/);
  205:                 chomp($line);
  206:                 my ($key,$val)=(split(/\s+/,$line,2));
  207:                 $cprtag{$key}=$val;
  208:             }
  209:             close($fh);
  210:         }
  211:     }
  212: # ----------------------------------------------------------- source copyrights
  213:     {
  214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
  215:                                   '/source_copyright.tab';
  216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
  217:             while (my $line = <$fh>) {
  218:                 next if ($line =~ /^\#/);
  219:                 chomp($line);
  220:                 my ($key,$val)=(split(/\s+/,$line,2));
  221:                 $scprtag{$key}=$val;
  222:             }
  223:             close($fh);
  224:         }
  225:     }
  226: 
  227: # -------------------------------------------------------------- default domain designs
  228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
  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);
  238:     }
  239: 
  240: # ------------------------------------------------------------- file categories
  241:     {
  242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
  243:                                   '/filecategories.tab';
  244:         if ( open (my $fh,"<$categoryfile") ) {
  245: 	    while (my $line = <$fh>) {
  246: 		next if ($line =~ /^\#/);
  247: 		chomp($line);
  248:                 my ($extension,$category)=(split(/\s+/,$line,2));
  249:                 push @{$category_extensions{lc($category)}},$extension;
  250:             }
  251:             close($fh);
  252:         }
  253: 
  254:     }
  255: # ------------------------------------------------------------------ file types
  256:     {
  257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
  258:                '/filetypes.tab';
  259:         if ( open (my $fh,"<$typesfile") ) {
  260:             while (my $line = <$fh>) {
  261: 		next if ($line =~ /^\#/);
  262: 		chomp($line);
  263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
  264:                 if ($descr ne '') {
  265:                     $fe{$ending}=lc($emb);
  266:                     $fd{$ending}=$descr;
  267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
  268:                 }
  269:             }
  270:             close($fh);
  271:         }
  272:     }
  273:     &Apache::lonnet::logthis(
  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
  275:     $readit=1;
  276:     }  # end of unless($readit) 
  277:     
  278: }
  279: 
  280: ###############################################################
  281: ##           HTML and Javascript Helper Functions            ##
  282: ###############################################################
  283: 
  284: =pod 
  285: 
  286: =head1 HTML and Javascript Functions
  287: 
  288: =over 4
  289: 
  290: =item * &browser_and_searcher_javascript()
  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.
  296: 
  297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
  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
  305: with the given extension.  Can be a comma separated list.
  306: 
  307: Specifying 'omit' will restrict the browser to NOT displaying files
  308: with the given extension.  Can be a comma separated list.
  309: 
  310: =item * &opensearcher(formname,elementname) [javascript]
  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.
  316: 
  317: =cut
  318: 
  319: sub browser_and_searcher_javascript {
  320:     my ($mode)=@_;
  321:     if (!defined($mode)) { $mode='edit'; }
  322:     my $resurl=&escape_single(&lastresurl());
  323:     return <<END;
  324: // <!-- BEGIN LON-CAPA Internal
  325:     var editbrowser = null;
  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
  327:         var url = '$resurl/?';
  328:         if (editbrowser == null) {
  329:             url += 'launch=1&';
  330:         }
  331:         url += 'catalogmode=interactive&';
  332:         url += 'mode=$mode&';
  333:         url += 'inhibitmenu=yes&';
  334:         url += 'form=' + formname + '&';
  335:         if (only != null) {
  336:             url += 'only=' + only + '&';
  337:         } else {
  338:             url += 'only=&';
  339: 	}
  340:         if (omit != null) {
  341:             url += 'omit=' + omit + '&';
  342:         } else {
  343:             url += 'omit=&';
  344: 	}
  345:         if (titleelement != null) {
  346:             url += 'titleelement=' + titleelement + '&';
  347:         } else {
  348: 	    url += 'titleelement=&';
  349: 	}
  350:         url += 'element=' + elementname + '';
  351:         var title = 'Browser';
  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
  353:         options += ',width=700,height=600';
  354:         editbrowser = open(url,title,options,'1');
  355:         editbrowser.focus();
  356:     }
  357:     var editsearcher;
  358:     function opensearcher(formname,elementname,titleelement) {
  359:         var url = '/adm/searchcat?';
  360:         if (editsearcher == null) {
  361:             url += 'launch=1&';
  362:         }
  363:         url += 'catalogmode=interactive&';
  364:         url += 'mode=$mode&';
  365:         url += 'form=' + formname + '&';
  366:         if (titleelement != null) {
  367:             url += 'titleelement=' + titleelement + '&';
  368:         } else {
  369: 	    url += 'titleelement=&';
  370: 	}
  371:         url += 'element=' + elementname + '';
  372:         var title = 'Search';
  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
  374:         options += ',width=700,height=600';
  375:         editsearcher = open(url,title,options,'1');
  376:         editsearcher.focus();
  377:     }
  378: // END LON-CAPA Internal -->
  379: END
  380: }
  381: 
  382: sub lastresurl {
  383:     if ($env{'environment.lastresurl'}) {
  384: 	return $env{'environment.lastresurl'}
  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});
  395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
  396:     return 1;
  397: }
  398: 
  399: sub studentbrowser_javascript {
  400:    unless (
  401:             (($env{'request.course.id'}) && 
  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
  403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
  404: 					  '/'.$env{'request.course.sec'})
  405: 	      ))
  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
  407:           ) { return ''; }  
  408:    return (<<'ENDSTDBRW');
  409: <script type="text/javascript" language="Javascript">
  410: // <![CDATA[
  411:     var stdeditbrowser;
  412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
  413:         var url = '/adm/pickstudent?';
  414:         var filter;
  415: 	if (!ignorefilter) {
  416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
  417: 	}
  418:         if (filter != null) {
  419:            if (filter != '') {
  420:                url += 'filter='+filter+'&';
  421: 	   }
  422:         }
  423:         url += 'form=' + formname + '&unameelement='+uname+
  424:                                     '&udomelement='+udom;
  425: 	if (roleflag) { url+="&roles=1"; }
  426:         if (courseadvonly) { url+="&courseadvonly=1"; }
  427:         var title = 'Student_Browser';
  428:         var options = 'scrollbars=1,resizable=1,menubar=0';
  429:         options += ',width=700,height=600';
  430:         stdeditbrowser = open(url,title,options,'1');
  431:         stdeditbrowser.focus();
  432:     }
  433: // ]]>
  434: </script>
  435: ENDSTDBRW
  436: }
  437: 
  438: sub selectstudent_link {
  439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
  440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
  441:    if ($env{'request.course.id'}) {  
  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
  443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
  444: 					'/'.$env{'request.course.sec'})) {
  445: 	   return '';
  446:        }
  447:        if ($courseadvonly)  {
  448:            $callargs .= ",'',1,1";
  449:        }
  450:        return '<span class="LC_nobreak">'.
  451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
  452:               &mt('Select User').'</a></span>';
  453:    }
  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
  455:        $callargs .= ",1"; 
  456:        return '<span class="LC_nobreak">'.
  457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
  458:               &mt('Select User').'</a></span>';
  459:    }
  460:    return '';
  461: }
  462: 
  463: sub authorbrowser_javascript {
  464:     return <<"ENDAUTHORBRW";
  465: <script type="text/javascript" language="JavaScript">
  466: // <![CDATA[
  467: var stdeditbrowser;
  468: 
  469: function openauthorbrowser(formname,udom) {
  470:     var url = '/adm/pickauthor?';
  471:     url += 'form='+formname+'&roledom='+udom;
  472:     var title = 'Author_Browser';
  473:     var options = 'scrollbars=1,resizable=1,menubar=0';
  474:     options += ',width=700,height=600';
  475:     stdeditbrowser = open(url,title,options,'1');
  476:     stdeditbrowser.focus();
  477: }
  478: 
  479: // ]]>
  480: </script>
  481: ENDAUTHORBRW
  482: }
  483: 
  484: sub coursebrowser_javascript {
  485:     my ($domainfilter,$sec_element,$formname)=@_;
  486:     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');
  487:    my $output = '
  488: <script type="text/javascript" language="JavaScript">
  489: // <![CDATA[
  490:     var stdeditbrowser;'."\n";
  491:    $output .= <<"ENDSTDBRW";
  492:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
  493:         var url = '/adm/pickcourse?';
  494:         var domainfilter = '';
  495:         var formid = getFormIdByName(formname);
  496:         if (formid > -1) {
  497:             var domid = getIndexByName(formid,udom);
  498:             if (domid > -1) {
  499:                 if (document.forms[formid].elements[domid].type == 'select-one') {
  500:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
  501:                 }
  502:                 if (document.forms[formid].elements[domid].type == 'hidden') {
  503:                     domainfilter=document.forms[formid].elements[domid].value;
  504:                 }
  505:             }
  506:         }
  507:         if (domainfilter != null) {
  508:            if (domainfilter != '') {
  509:                url += 'domainfilter='+domainfilter+'&';
  510: 	   }
  511:         }
  512:         url += 'form=' + formname + '&cnumelement='+uname+
  513: 	                            '&cdomelement='+udom+
  514:                                     '&cnameelement='+desc;
  515:         if (extra_element !=null && extra_element != '') {
  516:             if (formname == 'rolechoice' || formname == 'studentform') {
  517:                 url += '&roleelement='+extra_element;
  518:                 if (domainfilter == null || domainfilter == '') {
  519:                     url += '&domainfilter='+extra_element;
  520:                 }
  521:             }
  522:             else {
  523:                 if (formname == 'portform') {
  524:                     url += '&setroles='+extra_element;
  525:                 } else {
  526:                     if (formname == 'rules') {
  527:                         url += '&fixeddom='+extra_element; 
  528:                     }
  529:                 }
  530:             }     
  531:         }
  532:         if (multflag !=null && multflag != '') {
  533:             url += '&multiple='+multflag;
  534:         }
  535:         if (crstype == 'Course/Group') {
  536:             if (formname == 'cu') {
  537:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
  538:                 if (crstype == "") {
  539:                     alert("$crs_or_grp_alert");
  540:                     return;
  541:                 }
  542:             }
  543:         }
  544:         if (crstype !=null && crstype != '') {
  545:             url += '&type='+crstype;
  546:         }
  547:         var title = 'Course_Browser';
  548:         var options = 'scrollbars=1,resizable=1,menubar=0';
  549:         options += ',width=700,height=600';
  550:         stdeditbrowser = open(url,title,options,'1');
  551:         stdeditbrowser.focus();
  552:     }
  553: 
  554:     function getFormIdByName(formname) {
  555:         for (var i=0;i<document.forms.length;i++) {
  556:             if (document.forms[i].name == formname) {
  557:                 return i;
  558:             }
  559:         }
  560:         return -1; 
  561:     }
  562: 
  563:     function getIndexByName(formid,item) {
  564:         for (var i=0;i<document.forms[formid].elements.length;i++) {
  565:             if (document.forms[formid].elements[i].name == item) {
  566:                 return i;
  567:             }
  568:         }
  569:         return -1;
  570:     }
  571: ENDSTDBRW
  572:     if ($sec_element ne '') {
  573:         $output .= &setsec_javascript($sec_element,$formname);
  574:     }
  575:     $output .= '
  576: // ]]>
  577: </script>';
  578:     return $output;
  579: }
  580: 
  581: sub setsec_javascript {
  582:     my ($sec_element,$formname) = @_;
  583:     my $setsections = qq|
  584: function setSect(sectionlist) {
  585:     var sectionsArray = new Array();
  586:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
  587:         sectionsArray = sectionlist.split(",");
  588:     }
  589:     var numSections = sectionsArray.length;
  590:     document.$formname.$sec_element.length = 0;
  591:     if (numSections == 0) {
  592:         document.$formname.$sec_element.multiple=false;
  593:         document.$formname.$sec_element.size=1;
  594:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
  595:     } else {
  596:         if (numSections == 1) {
  597:             document.$formname.$sec_element.multiple=false;
  598:             document.$formname.$sec_element.size=1;
  599:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
  600:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
  601:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
  602:         } else {
  603:             for (var i=0; i<numSections; i++) {
  604:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
  605:             }
  606:             document.$formname.$sec_element.multiple=true
  607:             if (numSections < 3) {
  608:                 document.$formname.$sec_element.size=numSections;
  609:             } else {
  610:                 document.$formname.$sec_element.size=3;
  611:             }
  612:             document.$formname.$sec_element.options[0].selected = false
  613:         }
  614:     }
  615: }
  616: |;
  617:     return $setsections;
  618: }
  619: 
  620: 
  621: sub selectcourse_link {
  622:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
  623:    return '<span class="LC_nobreak">'
  624:          ."<a href='"
  625:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
  626:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
  627:          .'","'.$multflag.'","'.$selecttype.'");'
  628:          ."'>".&mt('Select Course').'</a>'
  629:          .'</span>';
  630: }
  631: 
  632: sub selectauthor_link {
  633:    my ($form,$udom)=@_;
  634:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
  635:           &mt('Select Author').'</a>';
  636: }
  637: 
  638: sub check_uncheck_jscript {
  639:     my $jscript = <<"ENDSCRT";
  640: function checkAll(field) {
  641:     if (field.length > 0) {
  642:         for (i = 0; i < field.length; i++) {
  643:             field[i].checked = true ;
  644:         }
  645:     } else {
  646:         field.checked = true
  647:     }
  648: }
  649:  
  650: function uncheckAll(field) {
  651:     if (field.length > 0) {
  652:         for (i = 0; i < field.length; i++) {
  653:             field[i].checked = false ;
  654:         }
  655:     } else {
  656:         field.checked = false ;
  657:     }
  658: }
  659: ENDSCRT
  660:     return $jscript;
  661: }
  662: 
  663: sub select_timezone {
  664:    my ($name,$selected,$onchange,$includeempty)=@_;
  665:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
  666:    if ($includeempty) {
  667:        $output .= '<option value=""';
  668:        if (($selected eq '') || ($selected eq 'local')) {
  669:            $output .= ' selected="selected" ';
  670:        }
  671:        $output .= '> </option>';
  672:    }
  673:    my @timezones = DateTime::TimeZone->all_names;
  674:    foreach my $tzone (@timezones) {
  675:        $output.= '<option value="'.$tzone.'"';
  676:        if ($tzone eq $selected) {
  677:            $output.=' selected="selected"';
  678:        }
  679:        $output.=">$tzone</option>\n";
  680:    }
  681:    $output.="</select>";
  682:    return $output;
  683: }
  684: 
  685: sub select_datelocale {
  686:     my ($name,$selected,$onchange,$includeempty)=@_;
  687:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
  688:     if ($includeempty) {
  689:         $output .= '<option value=""';
  690:         if ($selected eq '') {
  691:             $output .= ' selected="selected" ';
  692:         }
  693:         $output .= '> </option>';
  694:     }
  695:     my (@possibles,%locale_names);
  696:     my @locales = DateTime::Locale::Catalog::Locales;
  697:     foreach my $locale (@locales) {
  698:         if (ref($locale) eq 'HASH') {
  699:             my $id = $locale->{'id'};
  700:             if ($id ne '') {
  701:                 my $en_terr = $locale->{'en_territory'};
  702:                 my $native_terr = $locale->{'native_territory'};
  703:                 my @languages = &Apache::lonlocal::preferred_languages();
  704:                 if (grep(/^en$/,@languages) || !@languages) {
  705:                     if ($en_terr ne '') {
  706:                         $locale_names{$id} = '('.$en_terr.')';
  707:                     } elsif ($native_terr ne '') {
  708:                         $locale_names{$id} = $native_terr;
  709:                     }
  710:                 } else {
  711:                     if ($native_terr ne '') {
  712:                         $locale_names{$id} = $native_terr.' ';
  713:                     } elsif ($en_terr ne '') {
  714:                         $locale_names{$id} = '('.$en_terr.')';
  715:                     }
  716:                 }
  717:                 push (@possibles,$id);
  718:             }
  719:         }
  720:     }
  721:     foreach my $item (sort(@possibles)) {
  722:         $output.= '<option value="'.$item.'"';
  723:         if ($item eq $selected) {
  724:             $output.=' selected="selected"';
  725:         }
  726:         $output.=">$item";
  727:         if ($locale_names{$item} ne '') {
  728:             $output.="  $locale_names{$item}</option>\n";
  729:         }
  730:         $output.="</option>\n";
  731:     }
  732:     $output.="</select>";
  733:     return $output;
  734: }
  735: 
  736: sub select_language {
  737:     my ($name,$selected,$includeempty) = @_;
  738:     my %langchoices;
  739:     if ($includeempty) {
  740:         %langchoices = ('' => 'No language preference');
  741:     }
  742:     foreach my $id (&languageids()) {
  743:         my $code = &supportedlanguagecode($id);
  744:         if ($code) {
  745:             $langchoices{$code} = &plainlanguagedescription($id);
  746:         }
  747:     }
  748:     return &select_form($selected,$name,%langchoices);
  749: }
  750: 
  751: =pod
  752: 
  753: =item * &linked_select_forms(...)
  754: 
  755: linked_select_forms returns a string containing a <script></script> block
  756: and html for two <select> menus.  The select menus will be linked in that
  757: changing the value of the first menu will result in new values being placed
  758: in the second menu.  The values in the select menu will appear in alphabetical
  759: order unless a defined order is provided.
  760: 
  761: linked_select_forms takes the following ordered inputs:
  762: 
  763: =over 4
  764: 
  765: =item * $formname, the name of the <form> tag
  766: 
  767: =item * $middletext, the text which appears between the <select> tags
  768: 
  769: =item * $firstdefault, the default value for the first menu
  770: 
  771: =item * $firstselectname, the name of the first <select> tag
  772: 
  773: =item * $secondselectname, the name of the second <select> tag
  774: 
  775: =item * $hashref, a reference to a hash containing the data for the menus.
  776: 
  777: =item * $menuorder, the order of values in the first menu
  778: 
  779: =back 
  780: 
  781: Below is an example of such a hash.  Only the 'text', 'default', and 
  782: 'select2' keys must appear as stated.  keys(%menu) are the possible 
  783: values for the first select menu.  The text that coincides with the 
  784: first menu value is given in $menu{$choice1}->{'text'}.  The values 
  785: and text for the second menu are given in the hash pointed to by 
  786: $menu{$choice1}->{'select2'}.  
  787: 
  788:  my %menu = ( A1 => { text =>"Choice A1" ,
  789:                        default => "B3",
  790:                        select2 => { 
  791:                            B1 => "Choice B1",
  792:                            B2 => "Choice B2",
  793:                            B3 => "Choice B3",
  794:                            B4 => "Choice B4"
  795:                            },
  796:                        order => ['B4','B3','B1','B2'],
  797:                    },
  798:                A2 => { text =>"Choice A2" ,
  799:                        default => "C2",
  800:                        select2 => { 
  801:                            C1 => "Choice C1",
  802:                            C2 => "Choice C2",
  803:                            C3 => "Choice C3"
  804:                            },
  805:                        order => ['C2','C1','C3'],
  806:                    },
  807:                A3 => { text =>"Choice A3" ,
  808:                        default => "D6",
  809:                        select2 => { 
  810:                            D1 => "Choice D1",
  811:                            D2 => "Choice D2",
  812:                            D3 => "Choice D3",
  813:                            D4 => "Choice D4",
  814:                            D5 => "Choice D5",
  815:                            D6 => "Choice D6",
  816:                            D7 => "Choice D7"
  817:                            },
  818:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
  819:                    }
  820:                );
  821: 
  822: =cut
  823: 
  824: sub linked_select_forms {
  825:     my ($formname,
  826:         $middletext,
  827:         $firstdefault,
  828:         $firstselectname,
  829:         $secondselectname, 
  830:         $hashref,
  831:         $menuorder,
  832:         ) = @_;
  833:     my $second = "document.$formname.$secondselectname";
  834:     my $first = "document.$formname.$firstselectname";
  835:     # output the javascript to do the changing
  836:     my $result = '';
  837:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
  838:     $result.="// <![CDATA[\n";
  839:     $result.="var select2data = new Object();\n";
  840:     $" = '","';
  841:     my $debug = '';
  842:     foreach my $s1 (sort(keys(%$hashref))) {
  843:         $result.="select2data.d_$s1 = new Object();\n";        
  844:         $result.="select2data.d_$s1.def = new String('".
  845:             $hashref->{$s1}->{'default'}."');\n";
  846:         $result.="select2data.d_$s1.values = new Array(";
  847:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
  848:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
  849:             @s2values = @{$hashref->{$s1}->{'order'}};
  850:         }
  851:         $result.="\"@s2values\");\n";
  852:         $result.="select2data.d_$s1.texts = new Array(";        
  853:         my @s2texts;
  854:         foreach my $value (@s2values) {
  855:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
  856:         }
  857:         $result.="\"@s2texts\");\n";
  858:     }
  859:     $"=' ';
  860:     $result.= <<"END";
  861: 
  862: function select1_changed() {
  863:     // Determine new choice
  864:     var newvalue = "d_" + $first.value;
  865:     // update select2
  866:     var values     = select2data[newvalue].values;
  867:     var texts      = select2data[newvalue].texts;
  868:     var select2def = select2data[newvalue].def;
  869:     var i;
  870:     // out with the old
  871:     for (i = 0; i < $second.options.length; i++) {
  872:         $second.options[i] = null;
  873:     }
  874:     // in with the nuclear
  875:     for (i=0;i<values.length; i++) {
  876:         $second.options[i] = new Option(values[i]);
  877:         $second.options[i].value = values[i];
  878:         $second.options[i].text = texts[i];
  879:         if (values[i] == select2def) {
  880:             $second.options[i].selected = true;
  881:         }
  882:     }
  883: }
  884: // ]]>
  885: </script>
  886: END
  887:     # output the initial values for the selection lists
  888:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
  889:     my @order = sort(keys(%{$hashref}));
  890:     if (ref($menuorder) eq 'ARRAY') {
  891:         @order = @{$menuorder};
  892:     }
  893:     foreach my $value (@order) {
  894:         $result.="    <option value=\"$value\" ";
  895:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
  896:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
  897:     }
  898:     $result .= "</select>\n";
  899:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
  900:     $result .= $middletext;
  901:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
  902:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
  903:     
  904:     my @secondorder = sort(keys(%select2));
  905:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
  906:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
  907:     }
  908:     foreach my $value (@secondorder) {
  909:         $result.="    <option value=\"$value\" ";        
  910:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
  911:         $result.=">".&mt($select2{$value})."</option>\n";
  912:     }
  913:     $result .= "</select>\n";
  914:     #    return $debug;
  915:     return $result;
  916: }   #  end of sub linked_select_forms {
  917: 
  918: =pod
  919: 
  920: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
  921: 
  922: Returns a string corresponding to an HTML link to the given help
  923: $topic, where $topic corresponds to the name of a .tex file in
  924: /home/httpd/html/adm/help/tex, with underscores replaced by
  925: spaces. 
  926: 
  927: $text will optionally be linked to the same topic, allowing you to
  928: link text in addition to the graphic. If you do not want to link
  929: text, but wish to specify one of the later parameters, pass an
  930: empty string. 
  931: 
  932: $stayOnPage is a value that will be interpreted as a boolean. If true,
  933: the link will not open a new window. If false, the link will open
  934: a new window using Javascript. (Default is false.) 
  935: 
  936: $width and $height are optional numerical parameters that will
  937: override the width and height of the popped up window, which may
  938: be useful for certain help topics with big pictures included. 
  939: 
  940: =cut
  941: 
  942: sub help_open_topic {
  943:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
  944:     $text = "" if (not defined $text);
  945:     $stayOnPage = 0 if (not defined $stayOnPage);
  946:     $width = 350 if (not defined $width);
  947:     $height = 400 if (not defined $height);
  948:     my $filename = $topic;
  949:     $filename =~ s/ /_/g;
  950: 
  951:     my $template = "";
  952:     my $link;
  953:     
  954:     $topic=~s/\W/\_/g;
  955: 
  956:     if (!$stayOnPage) {
  957: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
  958:     } else {
  959: 	$link = "/adm/help/${filename}.hlp";
  960:     }
  961: 
  962:     # Add the text
  963:     if ($text ne "") {	
  964: 	$template.='<span class="LC_help_open_topic">'
  965:                   .'<a target="_top" href="'.$link.'">'
  966:                   .$text.'</a>';
  967:     }
  968: 
  969:     # (Always) Add the graphic
  970:     my $title = &mt('Online Help');
  971:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
  972:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
  973:               .'<img src="'.$helpicon.'" border="0"'
  974:               .' alt="'.&mt('Help: [_1]',$topic).'"'
  975:               .' title="'.$title.'"' 
  976:               .' /></a>';
  977:     if ($text ne "") {	
  978:         $template.='</span>';
  979:     }
  980:     return $template;
  981: 
  982: }
  983: 
  984: # This is a quicky function for Latex cheatsheet editing, since it 
  985: # appears in at least four places
  986: sub helpLatexCheatsheet {
  987:     my ($topic,$text,$not_author) = @_;
  988:     my $out;
  989:     my $addOther = '';
  990:     if ($topic) {
  991: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
  992: 							       undef, undef, 600).
  993: 								   '</span> ';
  994:     }
  995:     $out = '<span>' # Start cheatsheet
  996: 	  .$addOther
  997:           .'<span>'
  998: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
  999: 					       undef,undef,600)
 1000: 	  .'</span> <span>'
 1001: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
 1002: 					       undef,undef,600)
 1003: 	  .'</span>';
 1004:     unless ($not_author) {
 1005:         $out .= ' <span>'
 1006: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
 1007: 	                                            undef,undef,600)
 1008: 	       .'</span>';
 1009:     }
 1010:     $out .= '</span>'; # End cheatsheet
 1011:     return $out;
 1012: }
 1013: 
 1014: sub general_help {
 1015:     my $helptopic='Student_Intro';
 1016:     if ($env{'request.role'}=~/^(ca|au)/) {
 1017: 	$helptopic='Authoring_Intro';
 1018:     } elsif ($env{'request.role'}=~/^cc/) {
 1019: 	$helptopic='Course_Coordination_Intro';
 1020:     } elsif ($env{'request.role'}=~/^dc/) {
 1021:         $helptopic='Domain_Coordination_Intro';
 1022:     }
 1023:     return $helptopic;
 1024: }
 1025: 
 1026: sub update_help_link {
 1027:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
 1028:     my $origurl = $ENV{'REQUEST_URI'};
 1029:     $origurl=~s|^/~|/priv/|;
 1030:     my $timestamp = time;
 1031:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
 1032:         $$datum = &escape($$datum);
 1033:     }
 1034: 
 1035:     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";
 1036:     my $output .= <<"ENDOUTPUT";
 1037: <script type="text/javascript">
 1038: // <![CDATA[
 1039: banner_link = '$banner_link';
 1040: // ]]>
 1041: </script>
 1042: ENDOUTPUT
 1043:     return $output;
 1044: }
 1045: 
 1046: # now just updates the help link and generates a blue icon
 1047: sub help_open_menu {
 1048:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
 1049: 	= @_;    
 1050:     $stayOnPage = 0 if (not defined $stayOnPage);
 1051:     # only use pop-up help (stayOnPage == 0)
 1052:     # if environment.remote is on (using remote control UI)
 1053:     if ($env{'environment.remote'} eq 'off' ) {
 1054:         $stayOnPage=1;
 1055:     }
 1056:     my $output;
 1057:     if ($component_help) {
 1058: 	if (!$text) {
 1059: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
 1060: 				       $width,$height);
 1061: 	} else {
 1062: 	    my $help_text;
 1063: 	    $help_text=&unescape($topic);
 1064: 	    $output='<table><tr><td>'.
 1065: 		&help_open_topic($component_help,$help_text,$stayOnPage,
 1066: 				 $width,$height).'</td></tr></table>';
 1067: 	}
 1068:     }
 1069:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
 1070:     return $output.$banner_link;
 1071: }
 1072: 
 1073: sub top_nav_help {
 1074:     my ($text) = @_;
 1075:     $text = &mt($text);
 1076:     my $stay_on_page = 
 1077: 	($env{'environment.remote'} eq 'off' );
 1078:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
 1079: 	                     : "javascript:helpMenu('open')";
 1080:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
 1081: 
 1082:     my $title = &mt('Get help');
 1083: 
 1084:     return <<"END";
 1085: $banner_link
 1086:  <a href="$link" title="$title">$text</a>
 1087: END
 1088: }
 1089: 
 1090: sub help_menu_js {
 1091:     my ($text) = @_;
 1092: 
 1093:     my $stayOnPage = 
 1094: 	($env{'environment.remote'} eq 'off' );
 1095: 
 1096:     my $width = 620;
 1097:     my $height = 600;
 1098:     my $helptopic=&general_help();
 1099:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
 1100:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
 1101:     my $start_page =
 1102:         &Apache::loncommon::start_page('Help Menu', undef,
 1103: 				       {'frameset'    => 1,
 1104: 					'js_ready'    => 1,
 1105: 					'add_entries' => {
 1106: 					    'border' => '0',
 1107: 					    'rows'   => "110,*",},});
 1108:     my $end_page =
 1109:         &Apache::loncommon::end_page({'frameset' => 1,
 1110: 				      'js_ready' => 1,});
 1111: 
 1112:     my $template .= <<"ENDTEMPLATE";
 1113: <script type="text/javascript">
 1114: // <!-- BEGIN LON-CAPA Internal
 1115: // <![CDATA[
 1116: var banner_link = '';
 1117: function helpMenu(target) {
 1118:     var caller = this;
 1119:     if (target == 'open') {
 1120:         var newWindow = null;
 1121:         try {
 1122:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
 1123:         }
 1124:         catch(error) {
 1125:             writeHelp(caller);
 1126:             return;
 1127:         }
 1128:         if (newWindow) {
 1129:             caller = newWindow;
 1130:         }
 1131:     }
 1132:     writeHelp(caller);
 1133:     return;
 1134: }
 1135: function writeHelp(caller) {
 1136:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
 1137:     caller.document.close()
 1138:     caller.focus()
 1139: }
 1140: // ]]>
 1141: // END LON-CAPA Internal -->
 1142: </script>
 1143: ENDTEMPLATE
 1144:     return $template;
 1145: }
 1146: 
 1147: sub help_open_bug {
 1148:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
 1149:     unless ($env{'user.adv'}) { return ''; }
 1150:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
 1151:     $text = "" if (not defined $text);
 1152:     $stayOnPage = 0 if (not defined $stayOnPage);
 1153:     if ($env{'environment.remote'} eq 'off' ) {
 1154: 	$stayOnPage=1;
 1155:     }
 1156:     $width = 600 if (not defined $width);
 1157:     $height = 600 if (not defined $height);
 1158: 
 1159:     $topic=~s/\W+/\+/g;
 1160:     my $link='';
 1161:     my $template='';
 1162:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
 1163: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
 1164:     if (!$stayOnPage)
 1165:     {
 1166: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
 1167:     }
 1168:     else
 1169:     {
 1170: 	$link = $url;
 1171:     }
 1172:     # Add the text
 1173:     if ($text ne "")
 1174:     {
 1175: 	$template .= 
 1176:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
 1177:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
 1178:     }
 1179: 
 1180:     # Add the graphic
 1181:     my $title = &mt('Report a Bug');
 1182:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
 1183:     $template .= <<"ENDTEMPLATE";
 1184:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
 1185: ENDTEMPLATE
 1186:     if ($text ne '') { $template.='</td></tr></table>' };
 1187:     return $template;
 1188: 
 1189: }
 1190: 
 1191: sub help_open_faq {
 1192:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
 1193:     unless ($env{'user.adv'}) { return ''; }
 1194:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
 1195:     $text = "" if (not defined $text);
 1196:     $stayOnPage = 0 if (not defined $stayOnPage);
 1197:     if ($env{'environment.remote'} eq 'off' ) {
 1198: 	$stayOnPage=1;
 1199:     }
 1200:     $width = 350 if (not defined $width);
 1201:     $height = 400 if (not defined $height);
 1202: 
 1203:     $topic=~s/\W+/\+/g;
 1204:     my $link='';
 1205:     my $template='';
 1206:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
 1207:     if (!$stayOnPage)
 1208:     {
 1209: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
 1210:     }
 1211:     else
 1212:     {
 1213: 	$link = $url;
 1214:     }
 1215: 
 1216:     # Add the text
 1217:     if ($text ne "")
 1218:     {
 1219: 	$template .= 
 1220:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
 1221:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
 1222:     }
 1223: 
 1224:     # Add the graphic
 1225:     my $title = &mt('View the FAQ');
 1226:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
 1227:     $template .= <<"ENDTEMPLATE";
 1228:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
 1229: ENDTEMPLATE
 1230:     if ($text ne '') { $template.='</td></tr></table>' };
 1231:     return $template;
 1232: 
 1233: }
 1234: 
 1235: ###############################################################
 1236: ###############################################################
 1237: 
 1238: =pod
 1239: 
 1240: =item * &change_content_javascript():
 1241: 
 1242: This and the next function allow you to create small sections of an
 1243: otherwise static HTML page that you can update on the fly with
 1244: Javascript, even in Netscape 4.
 1245: 
 1246: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
 1247: must be written to the HTML page once. It will prove the Javascript
 1248: function "change(name, content)". Calling the change function with the
 1249: name of the section 
 1250: you want to update, matching the name passed to C<changable_area>, and
 1251: the new content you want to put in there, will put the content into
 1252: that area.
 1253: 
 1254: B<Note>: Netscape 4 only reserves enough space for the changable area
 1255: to contain room for the original contents. You need to "make space"
 1256: for whatever changes you wish to make, and be B<sure> to check your
 1257: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
 1258: it's adequate for updating a one-line status display, but little more.
 1259: This script will set the space to 100% width, so you only need to
 1260: worry about height in Netscape 4.
 1261: 
 1262: Modern browsers are much less limiting, and if you can commit to the
 1263: user not using Netscape 4, this feature may be used freely with
 1264: pretty much any HTML.
 1265: 
 1266: =cut
 1267: 
 1268: sub change_content_javascript {
 1269:     # If we're on Netscape 4, we need to use Layer-based code
 1270:     if ($env{'browser.type'} eq 'netscape' &&
 1271: 	$env{'browser.version'} =~ /^4\./) {
 1272: 	return (<<NETSCAPE4);
 1273: 	function change(name, content) {
 1274: 	    doc = document.layers[name+"___escape"].layers[0].document;
 1275: 	    doc.open();
 1276: 	    doc.write(content);
 1277: 	    doc.close();
 1278: 	}
 1279: NETSCAPE4
 1280:     } else {
 1281: 	# Otherwise, we need to use semi-standards-compliant code
 1282: 	# (technically, "innerHTML" isn't standard but the equivalent
 1283: 	# is really scary, and every useful browser supports it
 1284: 	return (<<DOMBASED);
 1285: 	function change(name, content) {
 1286: 	    element = document.getElementById(name);
 1287: 	    element.innerHTML = content;
 1288: 	}
 1289: DOMBASED
 1290:     }
 1291: }
 1292: 
 1293: =pod
 1294: 
 1295: =item * &changable_area($name,$origContent):
 1296: 
 1297: This provides a "changable area" that can be modified on the fly via
 1298: the Javascript code provided in C<change_content_javascript>. $name is
 1299: the name you will use to reference the area later; do not repeat the
 1300: same name on a given HTML page more then once. $origContent is what
 1301: the area will originally contain, which can be left blank.
 1302: 
 1303: =cut
 1304: 
 1305: sub changable_area {
 1306:     my ($name, $origContent) = @_;
 1307: 
 1308:     if ($env{'browser.type'} eq 'netscape' &&
 1309: 	$env{'browser.version'} =~ /^4\./) {
 1310: 	# If this is netscape 4, we need to use the Layer tag
 1311: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
 1312:     } else {
 1313: 	return "<span id='$name'>$origContent</span>";
 1314:     }
 1315: }
 1316: 
 1317: =pod
 1318: 
 1319: =item * &viewport_geometry_js 
 1320: 
 1321: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
 1322: 
 1323: =cut
 1324: 
 1325: 
 1326: sub viewport_geometry_js { 
 1327:     return <<"GEOMETRY";
 1328: var Geometry = {};
 1329: function init_geometry() {
 1330:     if (Geometry.init) { return };
 1331:     Geometry.init=1;
 1332:     if (window.innerHeight) {
 1333:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
 1334:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
 1335:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
 1336:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
 1337:     }
 1338:     else if (document.documentElement && document.documentElement.clientHeight) {
 1339:         Geometry.getViewportHeight =
 1340:             function() { return document.documentElement.clientHeight; };
 1341:         Geometry.getViewportWidth =
 1342:             function() { return document.documentElement.clientWidth; };
 1343: 
 1344:         Geometry.getHorizontalScroll =
 1345:             function() { return document.documentElement.scrollLeft; };
 1346:         Geometry.getVerticalScroll =
 1347:             function() { return document.documentElement.scrollTop; };
 1348:     }
 1349:     else if (document.body.clientHeight) {
 1350:         Geometry.getViewportHeight =
 1351:             function() { return document.body.clientHeight; };
 1352:         Geometry.getViewportWidth =
 1353:             function() { return document.body.clientWidth; };
 1354:         Geometry.getHorizontalScroll =
 1355:             function() { return document.body.scrollLeft; };
 1356:         Geometry.getVerticalScroll =
 1357:             function() { return document.body.scrollTop; };
 1358:     }
 1359: }
 1360: 
 1361: GEOMETRY
 1362: }
 1363: 
 1364: =pod
 1365: 
 1366: =item * &viewport_size_js()
 1367: 
 1368: 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. 
 1369: 
 1370: =cut
 1371: 
 1372: sub viewport_size_js {
 1373:     my $geometry = &viewport_geometry_js();
 1374:     return <<"DIMS";
 1375: 
 1376: $geometry
 1377: 
 1378: function getViewportDims(width,height) {
 1379:     init_geometry();
 1380:     width.value = Geometry.getViewportWidth();
 1381:     height.value = Geometry.getViewportHeight();
 1382:     return;
 1383: }
 1384: 
 1385: DIMS
 1386: }
 1387: 
 1388: =pod
 1389: 
 1390: =item * &resize_textarea_js()
 1391: 
 1392: emits the needed javascript to resize a textarea to be as big as possible
 1393: 
 1394: creates a function resize_textrea that takes two IDs first should be
 1395: the id of the element to resize, second should be the id of a div that
 1396: surrounds everything that comes after the textarea, this routine needs
 1397: to be attached to the <body> for the onload and onresize events.
 1398: 
 1399: =back
 1400: 
 1401: =cut
 1402: 
 1403: sub resize_textarea_js {
 1404:     my $geometry = &viewport_geometry_js();
 1405:     return <<"RESIZE";
 1406:     <script type="text/javascript">
 1407: // <![CDATA[
 1408: $geometry
 1409: 
 1410: function getX(element) {
 1411:     var x = 0;
 1412:     while (element) {
 1413: 	x += element.offsetLeft;
 1414: 	element = element.offsetParent;
 1415:     }
 1416:     return x;
 1417: }
 1418: function getY(element) {
 1419:     var y = 0;
 1420:     while (element) {
 1421: 	y += element.offsetTop;
 1422: 	element = element.offsetParent;
 1423:     }
 1424:     return y;
 1425: }
 1426: 
 1427: 
 1428: function resize_textarea(textarea_id,bottom_id) {
 1429:     init_geometry();
 1430:     var textarea        = document.getElementById(textarea_id);
 1431:     //alert(textarea);
 1432: 
 1433:     var textarea_top    = getY(textarea);
 1434:     var textarea_height = textarea.offsetHeight;
 1435:     var bottom          = document.getElementById(bottom_id);
 1436:     var bottom_top      = getY(bottom);
 1437:     var bottom_height   = bottom.offsetHeight;
 1438:     var window_height   = Geometry.getViewportHeight();
 1439:     var fudge           = 23;
 1440:     var new_height      = window_height-fudge-textarea_top-bottom_height;
 1441:     if (new_height < 300) {
 1442: 	new_height = 300;
 1443:     }
 1444:     textarea.style.height=new_height+'px';
 1445: }
 1446: // ]]>
 1447: </script>
 1448: RESIZE
 1449: 
 1450: }
 1451: 
 1452: =pod
 1453: 
 1454: =head1 Excel and CSV file utility routines
 1455: 
 1456: =over 4
 1457: 
 1458: =cut
 1459: 
 1460: ###############################################################
 1461: ###############################################################
 1462: 
 1463: =pod
 1464: 
 1465: =item * &csv_translate($text) 
 1466: 
 1467: Translate $text to allow it to be output as a 'comma separated values' 
 1468: format.
 1469: 
 1470: =cut
 1471: 
 1472: ###############################################################
 1473: ###############################################################
 1474: sub csv_translate {
 1475:     my $text = shift;
 1476:     $text =~ s/\"/\"\"/g;
 1477:     $text =~ s/\n/ /g;
 1478:     return $text;
 1479: }
 1480: 
 1481: ###############################################################
 1482: ###############################################################
 1483: 
 1484: =pod
 1485: 
 1486: =item * &define_excel_formats()
 1487: 
 1488: Define some commonly used Excel cell formats.
 1489: 
 1490: Currently supported formats:
 1491: 
 1492: =over 4
 1493: 
 1494: =item header
 1495: 
 1496: =item bold
 1497: 
 1498: =item h1
 1499: 
 1500: =item h2
 1501: 
 1502: =item h3
 1503: 
 1504: =item h4
 1505: 
 1506: =item i
 1507: 
 1508: =item date
 1509: 
 1510: =back
 1511: 
 1512: Inputs: $workbook
 1513: 
 1514: Returns: $format, a hash reference.
 1515: 
 1516: =cut
 1517: 
 1518: ###############################################################
 1519: ###############################################################
 1520: sub define_excel_formats {
 1521:     my ($workbook) = @_;
 1522:     my $format;
 1523:     $format->{'header'} = $workbook->add_format(bold      => 1, 
 1524:                                                 bottom    => 1,
 1525:                                                 align     => 'center');
 1526:     $format->{'bold'} = $workbook->add_format(bold=>1);
 1527:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
 1528:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
 1529:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
 1530:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
 1531:     $format->{'i'}    = $workbook->add_format(italic=>1);
 1532:     $format->{'date'} = $workbook->add_format(num_format=>
 1533:                                             'mm/dd/yyyy hh:mm:ss');
 1534:     return $format;
 1535: }
 1536: 
 1537: ###############################################################
 1538: ###############################################################
 1539: 
 1540: =pod
 1541: 
 1542: =item * &create_workbook()
 1543: 
 1544: Create an Excel worksheet.  If it fails, output message on the
 1545: request object and return undefs.
 1546: 
 1547: Inputs: Apache request object
 1548: 
 1549: Returns (undef) on failure, 
 1550:     Excel worksheet object, scalar with filename, and formats 
 1551:     from &Apache::loncommon::define_excel_formats on success
 1552: 
 1553: =cut
 1554: 
 1555: ###############################################################
 1556: ###############################################################
 1557: sub create_workbook {
 1558:     my ($r) = @_;
 1559:         #
 1560:     # Create the excel spreadsheet
 1561:     my $filename = '/prtspool/'.
 1562:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
 1563:         time.'_'.rand(1000000000).'.xls';
 1564:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
 1565:     if (! defined($workbook)) {
 1566:         $r->log_error("Error creating excel spreadsheet $filename: $!");
 1567:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
 1568:                             "This error has been logged.  ".
 1569:                             "Please alert your LON-CAPA administrator").
 1570:                   '</p>');
 1571:         return (undef);
 1572:     }
 1573:     #
 1574:     $workbook->set_tempdir('/home/httpd/perl/tmp');
 1575:     #
 1576:     my $format = &Apache::loncommon::define_excel_formats($workbook);
 1577:     return ($workbook,$filename,$format);
 1578: }
 1579: 
 1580: ###############################################################
 1581: ###############################################################
 1582: 
 1583: =pod
 1584: 
 1585: =item * &create_text_file()
 1586: 
 1587: Create a file to write to and eventually make available to the user.
 1588: If file creation fails, outputs an error message on the request object and 
 1589: return undefs.
 1590: 
 1591: Inputs: Apache request object, and file suffix
 1592: 
 1593: Returns (undef) on failure, 
 1594:     Filehandle and filename on success.
 1595: 
 1596: =cut
 1597: 
 1598: ###############################################################
 1599: ###############################################################
 1600: sub create_text_file {
 1601:     my ($r,$suffix) = @_;
 1602:     if (! defined($suffix)) { $suffix = 'txt'; };
 1603:     my $fh;
 1604:     my $filename = '/prtspool/'.
 1605:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
 1606:         time.'_'.rand(1000000000).'.'.$suffix;
 1607:     $fh = Apache::File->new('>/home/httpd'.$filename);
 1608:     if (! defined($fh)) {
 1609:         $r->log_error("Couldn't open $filename for output $!");
 1610:         $r->print(&mt('Problems occurred in creating the output file. '
 1611:                      .'This error has been logged. '
 1612:                      .'Please alert your LON-CAPA administrator.'));
 1613:     }
 1614:     return ($fh,$filename)
 1615: }
 1616: 
 1617: 
 1618: =pod 
 1619: 
 1620: =back
 1621: 
 1622: =cut
 1623: 
 1624: ###############################################################
 1625: ##        Home server <option> list generating code          ##
 1626: ###############################################################
 1627: 
 1628: # ------------------------------------------
 1629: 
 1630: sub domain_select {
 1631:     my ($name,$value,$multiple)=@_;
 1632:     my %domains=map { 
 1633: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
 1634:     } &Apache::lonnet::all_domains();
 1635:     if ($multiple) {
 1636: 	$domains{''}=&mt('Any domain');
 1637: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
 1638: 	return &multiple_select_form($name,$value,4,\%domains);
 1639:     } else {
 1640: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
 1641: 	return &select_form($name,$value,%domains);
 1642:     }
 1643: }
 1644: 
 1645: #-------------------------------------------
 1646: 
 1647: =pod
 1648: 
 1649: =head1 Routines for form select boxes
 1650: 
 1651: =over 4
 1652: 
 1653: =item * &multiple_select_form($name,$value,$size,$hash,$order)
 1654: 
 1655: Returns a string containing a <select> element int multiple mode
 1656: 
 1657: 
 1658: Args:
 1659:   $name - name of the <select> element
 1660:   $value - scalar or array ref of values that should already be selected
 1661:   $size - number of rows long the select element is
 1662:   $hash - the elements should be 'option' => 'shown text'
 1663:           (shown text should already have been &mt())
 1664:   $order - (optional) array ref of the order to show the elements in
 1665: 
 1666: =cut
 1667: 
 1668: #-------------------------------------------
 1669: sub multiple_select_form {
 1670:     my ($name,$value,$size,$hash,$order)=@_;
 1671:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
 1672:     my $output='';
 1673:     if (! defined($size)) {
 1674:         $size = 4;
 1675:         if (scalar(keys(%$hash))<4) {
 1676:             $size = scalar(keys(%$hash));
 1677:         }
 1678:     }
 1679:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
 1680:     my @order;
 1681:     if (ref($order) eq 'ARRAY')  {
 1682:         @order = @{$order};
 1683:     } else {
 1684:         @order = sort(keys(%$hash));
 1685:     }
 1686:     if (exists($$hash{'select_form_order'})) {
 1687:         @order = @{$$hash{'select_form_order'}};
 1688:     }
 1689:         
 1690:     foreach my $key (@order) {
 1691:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
 1692:         $output.='selected="selected" ' if ($selected{$key});
 1693:         $output.='>'.$hash->{$key}."</option>\n";
 1694:     }
 1695:     $output.="</select>\n";
 1696:     return $output;
 1697: }
 1698: 
 1699: #-------------------------------------------
 1700: 
 1701: =pod
 1702: 
 1703: =item * &select_form($defdom,$name,%hash)
 1704: 
 1705: Returns a string containing a <select name='$name' size='1'> form to 
 1706: allow a user to select options from a hash option_name => displayed text.  
 1707: See lonrights.pm for an example invocation and use.
 1708: 
 1709: =cut
 1710: 
 1711: #-------------------------------------------
 1712: sub select_form {
 1713:     my ($def,$name,%hash) = @_;
 1714:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
 1715:     my @keys;
 1716:     if (exists($hash{'select_form_order'})) {
 1717: 	@keys=@{$hash{'select_form_order'}};
 1718:     } else {
 1719: 	@keys=sort(keys(%hash));
 1720:     }
 1721:     foreach my $key (@keys) {
 1722:         $selectform.=
 1723: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
 1724:             ($key eq $def ? 'selected="selected" ' : '').
 1725:                 ">".&mt($hash{$key})."</option>\n";
 1726:     }
 1727:     $selectform.="</select>";
 1728:     return $selectform;
 1729: }
 1730: 
 1731: # For display filters
 1732: 
 1733: sub display_filter {
 1734:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
 1735:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
 1736:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
 1737: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
 1738: 							   (&mt('all'),10,20,50,100,1000,10000))).
 1739: 	   '</label></span> <span class="LC_nobreak">'.
 1740:            &mt('Filter [_1]',
 1741: 	   &select_form($env{'form.displayfilter'},
 1742: 			'displayfilter',
 1743: 			('currentfolder' => 'Current folder/page',
 1744: 			 'containing' => 'Containing phrase',
 1745: 			 'none' => 'None'))).
 1746: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
 1747: }
 1748: 
 1749: sub gradeleveldescription {
 1750:     my $gradelevel=shift;
 1751:     my %gradelevels=(0 => 'Not specified',
 1752: 		     1 => 'Grade 1',
 1753: 		     2 => 'Grade 2',
 1754: 		     3 => 'Grade 3',
 1755: 		     4 => 'Grade 4',
 1756: 		     5 => 'Grade 5',
 1757: 		     6 => 'Grade 6',
 1758: 		     7 => 'Grade 7',
 1759: 		     8 => 'Grade 8',
 1760: 		     9 => 'Grade 9',
 1761: 		     10 => 'Grade 10',
 1762: 		     11 => 'Grade 11',
 1763: 		     12 => 'Grade 12',
 1764: 		     13 => 'Grade 13',
 1765: 		     14 => '100 Level',
 1766: 		     15 => '200 Level',
 1767: 		     16 => '300 Level',
 1768: 		     17 => '400 Level',
 1769: 		     18 => 'Graduate Level');
 1770:     return &mt($gradelevels{$gradelevel});
 1771: }
 1772: 
 1773: sub select_level_form {
 1774:     my ($deflevel,$name)=@_;
 1775:     unless ($deflevel) { $deflevel=0; }
 1776:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
 1777:     for (my $i=0; $i<=18; $i++) {
 1778:         $selectform.="<option value=\"$i\" ".
 1779:             ($i==$deflevel ? 'selected="selected" ' : '').
 1780:                 ">".&gradeleveldescription($i)."</option>\n";
 1781:     }
 1782:     $selectform.="</select>";
 1783:     return $selectform;
 1784: }
 1785: 
 1786: #-------------------------------------------
 1787: 
 1788: =pod
 1789: 
 1790: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
 1791: 
 1792: Returns a string containing a <select name='$name' size='1'> form to 
 1793: allow a user to select the domain to preform an operation in.  
 1794: See loncreateuser.pm for an example invocation and use.
 1795: 
 1796: If the $includeempty flag is set, it also includes an empty choice ("no domain
 1797: selected");
 1798: 
 1799: If the $showdomdesc flag is set, the domain name is followed by the domain description.
 1800: 
 1801: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.  
 1802: 
 1803: =cut
 1804: 
 1805: #-------------------------------------------
 1806: sub select_dom_form {
 1807:     my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
 1808:     my $onchange;
 1809:     if ($autosubmit) {
 1810:         $onchange = ' onchange="this.form.submit()"';
 1811:     }
 1812:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
 1813:     if ($includeempty) { @domains=('',@domains); }
 1814:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
 1815:     foreach my $dom (@domains) {
 1816:         $selectdomain.="<option value=\"$dom\" ".
 1817:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
 1818:         if ($showdomdesc) {
 1819:             if ($dom ne '') {
 1820:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
 1821:                 if ($domdesc ne '') {
 1822:                     $selectdomain .= ' ('.$domdesc.')';
 1823:                 }
 1824:             } 
 1825:         }
 1826:         $selectdomain .= "</option>\n";
 1827:     }
 1828:     $selectdomain.="</select>";
 1829:     return $selectdomain;
 1830: }
 1831: 
 1832: #-------------------------------------------
 1833: 
 1834: =pod
 1835: 
 1836: =item * &home_server_form_item($domain,$name,$defaultflag)
 1837: 
 1838: input: 4 arguments (two required, two optional) - 
 1839:     $domain - domain of new user
 1840:     $name - name of form element
 1841:     $default - Value of 'default' causes a default item to be first 
 1842:                             option, and selected by default. 
 1843:     $hide - Value of 'hide' causes hiding of the name of the server, 
 1844:                             if 1 server found, or default, if 0 found.
 1845: output: returns 2 items: 
 1846: (a) form element which contains either:
 1847:    (i) <select name="$name">
 1848:         <option value="$hostid1">$hostid $servers{$hostid}</option>
 1849:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
 1850:        </select>
 1851:        form item if there are multiple library servers in $domain, or
 1852:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
 1853:        if there is only one library server in $domain.
 1854: 
 1855: (b) number of library servers found.
 1856: 
 1857: See loncreateuser.pm for example of use.
 1858: 
 1859: =cut
 1860: 
 1861: #-------------------------------------------
 1862: sub home_server_form_item {
 1863:     my ($domain,$name,$default,$hide) = @_;
 1864:     my %servers = &Apache::lonnet::get_servers($domain,'library');
 1865:     my $result;
 1866:     my $numlib = keys(%servers);
 1867:     if ($numlib > 1) {
 1868:         $result .= '<select name="'.$name.'" />'."\n";
 1869:         if ($default) {
 1870:             $result .= '<option value="default" selected="selected">'.&mt('default').
 1871:                        '</option>'."\n";
 1872:         }
 1873:         foreach my $hostid (sort(keys(%servers))) {
 1874:             $result.= '<option value="'.$hostid.'">'.
 1875: 	              $hostid.' '.$servers{$hostid}."</option>\n";
 1876:         }
 1877:         $result .= '</select>'."\n";
 1878:     } elsif ($numlib == 1) {
 1879:         my $hostid;
 1880:         foreach my $item (keys(%servers)) {
 1881:             $hostid = $item;
 1882:         }
 1883:         $result .= '<input type="hidden" name="'.$name.'" value="'.
 1884:                    $hostid.'" />';
 1885:                    if (!$hide) {
 1886:                        $result .= $hostid.' '.$servers{$hostid};
 1887:                    }
 1888:                    $result .= "\n";
 1889:     } elsif ($default) {
 1890:         $result .= '<input type="hidden" name="'.$name.
 1891:                    '" value="default" />';
 1892:                    if (!$hide) {
 1893:                        $result .= &mt('default');
 1894:                    }
 1895:                    $result .= "\n";
 1896:     }
 1897:     return ($result,$numlib);
 1898: }
 1899: 
 1900: =pod
 1901: 
 1902: =back 
 1903: 
 1904: =cut
 1905: 
 1906: ###############################################################
 1907: ##                  Decoding User Agent                      ##
 1908: ###############################################################
 1909: 
 1910: =pod
 1911: 
 1912: =head1 Decoding the User Agent
 1913: 
 1914: =over 4
 1915: 
 1916: =item * &decode_user_agent()
 1917: 
 1918: Inputs: $r
 1919: 
 1920: Outputs:
 1921: 
 1922: =over 4
 1923: 
 1924: =item * $httpbrowser
 1925: 
 1926: =item * $clientbrowser
 1927: 
 1928: =item * $clientversion
 1929: 
 1930: =item * $clientmathml
 1931: 
 1932: =item * $clientunicode
 1933: 
 1934: =item * $clientos
 1935: 
 1936: =back
 1937: 
 1938: =back 
 1939: 
 1940: =cut
 1941: 
 1942: ###############################################################
 1943: ###############################################################
 1944: sub decode_user_agent {
 1945:     my ($r)=@_;
 1946:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
 1947:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
 1948:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
 1949:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
 1950:     my $clientbrowser='unknown';
 1951:     my $clientversion='0';
 1952:     my $clientmathml='';
 1953:     my $clientunicode='0';
 1954:     for (my $i=0;$i<=$#browsertype;$i++) {
 1955:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
 1956: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
 1957: 	    $clientbrowser=$bname;
 1958:             $httpbrowser=~/$vreg/i;
 1959: 	    $clientversion=$1;
 1960:             $clientmathml=($clientversion>=$minv);
 1961:             $clientunicode=($clientversion>=$univ);
 1962: 	}
 1963:     }
 1964:     my $clientos='unknown';
 1965:     if (($httpbrowser=~/linux/i) ||
 1966:         ($httpbrowser=~/unix/i) ||
 1967:         ($httpbrowser=~/ux/i) ||
 1968:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
 1969:     if (($httpbrowser=~/vax/i) ||
 1970:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
 1971:     if ($httpbrowser=~/next/i) { $clientos='next'; }
 1972:     if (($httpbrowser=~/mac/i) ||
 1973:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
 1974:     if ($httpbrowser=~/win/i) { $clientos='win'; }
 1975:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
 1976:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
 1977:             $clientunicode,$clientos,);
 1978: }
 1979: 
 1980: ###############################################################
 1981: ##    Authentication changing form generation subroutines    ##
 1982: ###############################################################
 1983: ##
 1984: ## All of the authform_xxxxxxx subroutines take their inputs in a
 1985: ## hash, and have reasonable default values.
 1986: ##
 1987: ##    formname = the name given in the <form> tag.
 1988: #-------------------------------------------
 1989: 
 1990: =pod
 1991: 
 1992: =head1 Authentication Routines
 1993: 
 1994: =over 4
 1995: 
 1996: =item * &authform_xxxxxx()
 1997: 
 1998: The authform_xxxxxx subroutines provide javascript and html forms which 
 1999: handle some of the conveniences required for authentication forms.  
 2000: This is not an optimal method, but it works.  
 2001: 
 2002: =over 4
 2003: 
 2004: =item * authform_header
 2005: 
 2006: =item * authform_authorwarning
 2007: 
 2008: =item * authform_nochange
 2009: 
 2010: =item * authform_kerberos
 2011: 
 2012: =item * authform_internal
 2013: 
 2014: =item * authform_filesystem
 2015: 
 2016: =back
 2017: 
 2018: See loncreateuser.pm for invocation and use examples.
 2019: 
 2020: =cut
 2021: 
 2022: #-------------------------------------------
 2023: sub authform_header{  
 2024:     my %in = (
 2025:         formname => 'cu',
 2026:         kerb_def_dom => '',
 2027:         @_,
 2028:     );
 2029:     $in{'formname'} = 'document.' . $in{'formname'};
 2030:     my $result='';
 2031: 
 2032: #---------------------------------------------- Code for upper case translation
 2033:     my $Javascript_toUpperCase;
 2034:     unless ($in{kerb_def_dom}) {
 2035:         $Javascript_toUpperCase =<<"END";
 2036:         switch (choice) {
 2037:            case 'krb': currentform.elements[choicearg].value =
 2038:                currentform.elements[choicearg].value.toUpperCase();
 2039:                break;
 2040:            default:
 2041:         }
 2042: END
 2043:     } else {
 2044:         $Javascript_toUpperCase = "";
 2045:     }
 2046: 
 2047:     my $radioval = "'nochange'";
 2048:     if (defined($in{'curr_authtype'})) {
 2049:         if ($in{'curr_authtype'} ne '') {
 2050:             $radioval = "'".$in{'curr_authtype'}."arg'";
 2051:         }
 2052:     }
 2053:     my $argfield = 'null';
 2054:     if (defined($in{'mode'})) {
 2055:         if ($in{'mode'} eq 'modifycourse')  {
 2056:             if (defined($in{'curr_autharg'})) {
 2057:                 if ($in{'curr_autharg'} ne '') {
 2058:                     $argfield = "'$in{'curr_autharg'}'";
 2059:                 }
 2060:             }
 2061:         }
 2062:     }
 2063: 
 2064:     $result.=<<"END";
 2065: var current = new Object();
 2066: current.radiovalue = $radioval;
 2067: current.argfield = $argfield;
 2068: 
 2069: function changed_radio(choice,currentform) {
 2070:     var choicearg = choice + 'arg';
 2071:     // If a radio button in changed, we need to change the argfield
 2072:     if (current.radiovalue != choice) {
 2073:         current.radiovalue = choice;
 2074:         if (current.argfield != null) {
 2075:             currentform.elements[current.argfield].value = '';
 2076:         }
 2077:         if (choice == 'nochange') {
 2078:             current.argfield = null;
 2079:         } else {
 2080:             current.argfield = choicearg;
 2081:             switch(choice) {
 2082:                 case 'krb': 
 2083:                     currentform.elements[current.argfield].value = 
 2084:                         "$in{'kerb_def_dom'}";
 2085:                 break;
 2086:               default:
 2087:                 break;
 2088:             }
 2089:         }
 2090:     }
 2091:     return;
 2092: }
 2093: 
 2094: function changed_text(choice,currentform) {
 2095:     var choicearg = choice + 'arg';
 2096:     if (currentform.elements[choicearg].value !='') {
 2097:         $Javascript_toUpperCase
 2098:         // clear old field
 2099:         if ((current.argfield != choicearg) && (current.argfield != null)) {
 2100:             currentform.elements[current.argfield].value = '';
 2101:         }
 2102:         current.argfield = choicearg;
 2103:     }
 2104:     set_auth_radio_buttons(choice,currentform);
 2105:     return;
 2106: }
 2107: 
 2108: function set_auth_radio_buttons(newvalue,currentform) {
 2109:     var i=0;
 2110:     while (i < currentform.login.length) {
 2111:         if (currentform.login[i].value == newvalue) { break; }
 2112:         i++;
 2113:     }
 2114:     if (i == currentform.login.length) {
 2115:         return;
 2116:     }
 2117:     current.radiovalue = newvalue;
 2118:     currentform.login[i].checked = true;
 2119:     return;
 2120: }
 2121: END
 2122:     return $result;
 2123: }
 2124: 
 2125: sub authform_authorwarning{
 2126:     my $result='';
 2127:     $result='<i>'.
 2128:         &mt('As a general rule, only authors or co-authors should be '.
 2129:             'filesystem authenticated '.
 2130:             '(which allows access to the server filesystem).')."</i>\n";
 2131:     return $result;
 2132: }
 2133: 
 2134: sub authform_nochange{  
 2135:     my %in = (
 2136:               formname => 'document.cu',
 2137:               kerb_def_dom => 'MSU.EDU',
 2138:               @_,
 2139:           );
 2140:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
 2141:     my $result;
 2142:     if (keys(%can_assign) == 0) {
 2143:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
 2144:     } else {
 2145:         $result = '<label>'.&mt('[_1] Do not change login data',
 2146:                   '<input type="radio" name="login" value="nochange" '.
 2147:                   'checked="checked" onclick="'.
 2148:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
 2149: 	    '</label>';
 2150:     }
 2151:     return $result;
 2152: }
 2153: 
 2154: sub authform_kerberos {
 2155:     my %in = (
 2156:               formname => 'document.cu',
 2157:               kerb_def_dom => 'MSU.EDU',
 2158:               kerb_def_auth => 'krb4',
 2159:               @_,
 2160:               );
 2161:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
 2162:         $autharg,$jscall);
 2163:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
 2164:     if ($in{'kerb_def_auth'} eq 'krb5') {
 2165:        $check5 = ' checked="checked"';
 2166:     } else {
 2167:        $check4 = ' checked="checked"';
 2168:     }
 2169:     $krbarg = $in{'kerb_def_dom'};
 2170:     if (defined($in{'curr_authtype'})) {
 2171:         if ($in{'curr_authtype'} eq 'krb') {
 2172:             $krbcheck = ' checked="checked"';
 2173:             if (defined($in{'mode'})) {
 2174:                 if ($in{'mode'} eq 'modifyuser') {
 2175:                     $krbcheck = '';
 2176:                 }
 2177:             }
 2178:             if (defined($in{'curr_kerb_ver'})) {
 2179:                 if ($in{'curr_krb_ver'} eq '5') {
 2180:                     $check5 = ' checked="checked"';
 2181:                     $check4 = '';
 2182:                 } else {
 2183:                     $check4 = ' checked="checked"';
 2184:                     $check5 = '';
 2185:                 }
 2186:             }
 2187:             if (defined($in{'curr_autharg'})) {
 2188:                 $krbarg = $in{'curr_autharg'};
 2189:             }
 2190:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
 2191:                 if (defined($in{'curr_autharg'})) {
 2192:                     $result = 
 2193:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
 2194:         $in{'curr_autharg'},$krbver);
 2195:                 } else {
 2196:                     $result =
 2197:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
 2198:                 }
 2199:                 return $result; 
 2200:             }
 2201:         }
 2202:     } else {
 2203:         if ($authnum == 1) {
 2204:             $authtype = '<input type="hidden" name="login" value="krb" />';
 2205:         }
 2206:     }
 2207:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
 2208:         return;
 2209:     } elsif ($authtype eq '') {
 2210:         if (defined($in{'mode'})) {
 2211:             if ($in{'mode'} eq 'modifycourse') {
 2212:                 if ($authnum == 1) {
 2213:                     $authtype = '<input type="hidden" name="login" value="krb" />';
 2214:                 }
 2215:             }
 2216:         }
 2217:     }
 2218:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
 2219:     if ($authtype eq '') {
 2220:         $authtype = '<input type="radio" name="login" value="krb" '.
 2221:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
 2222:                     $krbcheck.' />';
 2223:     }
 2224:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
 2225:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
 2226:          $in{'curr_authtype'} eq 'krb5') ||
 2227:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
 2228:          $in{'curr_authtype'} eq 'krb4')) {
 2229:         $result .= &mt
 2230:         ('[_1] Kerberos authenticated with domain [_2] '.
 2231:          '[_3] Version 4 [_4] Version 5 [_5]',
 2232:          '<label>'.$authtype,
 2233:          '</label><input type="text" size="10" name="krbarg" '.
 2234:              'value="'.$krbarg.'" '.
 2235:              'onchange="'.$jscall.'" />',
 2236:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
 2237:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
 2238: 	 '</label>');
 2239:     } elsif ($can_assign{'krb4'}) {
 2240:         $result .= &mt
 2241:         ('[_1] Kerberos authenticated with domain [_2] '.
 2242:          '[_3] Version 4 [_4]',
 2243:          '<label>'.$authtype,
 2244:          '</label><input type="text" size="10" name="krbarg" '.
 2245:              'value="'.$krbarg.'" '.
 2246:              'onchange="'.$jscall.'" />',
 2247:          '<label><input type="hidden" name="krbver" value="4" />',
 2248:          '</label>');
 2249:     } elsif ($can_assign{'krb5'}) {
 2250:         $result .= &mt
 2251:         ('[_1] Kerberos authenticated with domain [_2] '.
 2252:          '[_3] Version 5 [_4]',
 2253:          '<label>'.$authtype,
 2254:          '</label><input type="text" size="10" name="krbarg" '.
 2255:              'value="'.$krbarg.'" '.
 2256:              'onchange="'.$jscall.'" />',
 2257:          '<label><input type="hidden" name="krbver" value="5" />',
 2258:          '</label>');
 2259:     }
 2260:     return $result;
 2261: }
 2262: 
 2263: sub authform_internal{  
 2264:     my %in = (
 2265:                 formname => 'document.cu',
 2266:                 kerb_def_dom => 'MSU.EDU',
 2267:                 @_,
 2268:                 );
 2269:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
 2270:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
 2271:     if (defined($in{'curr_authtype'})) {
 2272:         if ($in{'curr_authtype'} eq 'int') {
 2273:             if ($can_assign{'int'}) {
 2274:                 $intcheck = 'checked="checked" ';
 2275:                 if (defined($in{'mode'})) {
 2276:                     if ($in{'mode'} eq 'modifyuser') {
 2277:                         $intcheck = '';
 2278:                     }
 2279:                 }
 2280:                 if (defined($in{'curr_autharg'})) {
 2281:                     $intarg = $in{'curr_autharg'};
 2282:                 }
 2283:             } else {
 2284:                 $result = &mt('Currently internally authenticated.');
 2285:                 return $result;
 2286:             }
 2287:         }
 2288:     } else {
 2289:         if ($authnum == 1) {
 2290:             $authtype = '<input type="hidden" name="login" value="int" />';
 2291:         }
 2292:     }
 2293:     if (!$can_assign{'int'}) {
 2294:         return;
 2295:     } elsif ($authtype eq '') {
 2296:         if (defined($in{'mode'})) {
 2297:             if ($in{'mode'} eq 'modifycourse') {
 2298:                 if ($authnum == 1) {
 2299:                     $authtype = '<input type="hidden" name="login" value="int" />';
 2300:                 }
 2301:             }
 2302:         }
 2303:     }
 2304:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
 2305:     if ($authtype eq '') {
 2306:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
 2307:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
 2308:     }
 2309:     $autharg = '<input type="password" size="10" name="intarg" value="'.
 2310:                $intarg.'" onchange="'.$jscall.'" />';
 2311:     $result = &mt
 2312:         ('[_1] Internally authenticated (with initial password [_2])',
 2313:          '<label>'.$authtype,'</label>'.$autharg);
 2314:     $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>';
 2315:     return $result;
 2316: }
 2317: 
 2318: sub authform_local{  
 2319:     my %in = (
 2320:               formname => 'document.cu',
 2321:               kerb_def_dom => 'MSU.EDU',
 2322:               @_,
 2323:               );
 2324:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
 2325:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
 2326:     if (defined($in{'curr_authtype'})) {
 2327:         if ($in{'curr_authtype'} eq 'loc') {
 2328:             if ($can_assign{'loc'}) {
 2329:                 $loccheck = 'checked="checked" ';
 2330:                 if (defined($in{'mode'})) {
 2331:                     if ($in{'mode'} eq 'modifyuser') {
 2332:                         $loccheck = '';
 2333:                     }
 2334:                 }
 2335:                 if (defined($in{'curr_autharg'})) {
 2336:                     $locarg = $in{'curr_autharg'};
 2337:                 }
 2338:             } else {
 2339:                 $result = &mt('Currently using local (institutional) authentication.');
 2340:                 return $result;
 2341:             }
 2342:         }
 2343:     } else {
 2344:         if ($authnum == 1) {
 2345:             $authtype = '<input type="hidden" name="login" value="loc" />';
 2346:         }
 2347:     }
 2348:     if (!$can_assign{'loc'}) {
 2349:         return;
 2350:     } elsif ($authtype eq '') {
 2351:         if (defined($in{'mode'})) {
 2352:             if ($in{'mode'} eq 'modifycourse') {
 2353:                 if ($authnum == 1) {
 2354:                     $authtype = '<input type="hidden" name="login" value="loc" />';
 2355:                 }
 2356:             }
 2357:         }
 2358:     }
 2359:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
 2360:     if ($authtype eq '') {
 2361:         $authtype = '<input type="radio" name="login" value="loc" '.
 2362:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
 2363:                     $jscall.'" />';
 2364:     }
 2365:     $autharg = '<input type="text" size="10" name="locarg" value="'.
 2366:                $locarg.'" onchange="'.$jscall.'" />';
 2367:     $result = &mt('[_1] Local Authentication with argument [_2]',
 2368:                   '<label>'.$authtype,'</label>'.$autharg);
 2369:     return $result;
 2370: }
 2371: 
 2372: sub authform_filesystem{  
 2373:     my %in = (
 2374:               formname => 'document.cu',
 2375:               kerb_def_dom => 'MSU.EDU',
 2376:               @_,
 2377:               );
 2378:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
 2379:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
 2380:     if (defined($in{'curr_authtype'})) {
 2381:         if ($in{'curr_authtype'} eq 'fsys') {
 2382:             if ($can_assign{'fsys'}) {
 2383:                 $fsyscheck = 'checked="checked" ';
 2384:                 if (defined($in{'mode'})) {
 2385:                     if ($in{'mode'} eq 'modifyuser') {
 2386:                         $fsyscheck = '';
 2387:                     }
 2388:                 }
 2389:             } else {
 2390:                 $result = &mt('Currently Filesystem Authenticated.');
 2391:                 return $result;
 2392:             }           
 2393:         }
 2394:     } else {
 2395:         if ($authnum == 1) {
 2396:             $authtype = '<input type="hidden" name="login" value="fsys" />';
 2397:         }
 2398:     }
 2399:     if (!$can_assign{'fsys'}) {
 2400:         return;
 2401:     } elsif ($authtype eq '') {
 2402:         if (defined($in{'mode'})) {
 2403:             if ($in{'mode'} eq 'modifycourse') {
 2404:                 if ($authnum == 1) {
 2405:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
 2406:                 }
 2407:             }
 2408:         }
 2409:     }
 2410:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
 2411:     if ($authtype eq '') {
 2412:         $authtype = '<input type="radio" name="login" value="fsys" '.
 2413:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
 2414:                     $jscall.'" />';
 2415:     }
 2416:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
 2417:                ' onchange="'.$jscall.'" />';
 2418:     $result = &mt
 2419:         ('[_1] Filesystem Authenticated (with initial password [_2])',
 2420:          '<label><input type="radio" name="login" value="fsys" '.
 2421:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
 2422:          '</label><input type="password" size="10" name="fsysarg" value="" '.
 2423:                   'onchange="'.$jscall.'" />');
 2424:     return $result;
 2425: }
 2426: 
 2427: sub get_assignable_auth {
 2428:     my ($dom) = @_;
 2429:     if ($dom eq '') {
 2430:         $dom = $env{'request.role.domain'};
 2431:     }
 2432:     my %can_assign = (
 2433:                           krb4 => 1,
 2434:                           krb5 => 1,
 2435:                           int  => 1,
 2436:                           loc  => 1,
 2437:                      );
 2438:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
 2439:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
 2440:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
 2441:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
 2442:             my $context;
 2443:             if ($env{'request.role'} =~ /^au/) {
 2444:                 $context = 'author';
 2445:             } elsif ($env{'request.role'} =~ /^dc/) {
 2446:                 $context = 'domain';
 2447:             } elsif ($env{'request.course.id'}) {
 2448:                 $context = 'course';
 2449:             }
 2450:             if ($context) {
 2451:                 if (ref($authhash->{$context}) eq 'HASH') {
 2452:                    %can_assign = %{$authhash->{$context}}; 
 2453:                 }
 2454:             }
 2455:         }
 2456:     }
 2457:     my $authnum = 0;
 2458:     foreach my $key (keys(%can_assign)) {
 2459:         if ($can_assign{$key}) {
 2460:             $authnum ++;
 2461:         }
 2462:     }
 2463:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
 2464:         $authnum --;
 2465:     }
 2466:     return ($authnum,%can_assign);
 2467: }
 2468: 
 2469: ###############################################################
 2470: ##    Get Kerberos Defaults for Domain                 ##
 2471: ###############################################################
 2472: ##
 2473: ## Returns default kerberos version and an associated argument
 2474: ## as listed in file domain.tab. If not listed, provides
 2475: ## appropriate default domain and kerberos version.
 2476: ##
 2477: #-------------------------------------------
 2478: 
 2479: =pod
 2480: 
 2481: =item * &get_kerberos_defaults()
 2482: 
 2483: get_kerberos_defaults($target_domain) returns the default kerberos
 2484: version and domain. If not found, it defaults to version 4 and the 
 2485: domain of the server.
 2486: 
 2487: =over 4
 2488: 
 2489: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
 2490: 
 2491: =back
 2492: 
 2493: =back
 2494: 
 2495: =cut
 2496: 
 2497: #-------------------------------------------
 2498: sub get_kerberos_defaults {
 2499:     my $domain=shift;
 2500:     my ($krbdef,$krbdefdom);
 2501:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
 2502:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
 2503:         $krbdef = $domdefaults{'auth_def'};
 2504:         $krbdefdom = $domdefaults{'auth_arg_def'};
 2505:     } else {
 2506:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
 2507:         my $krbdefdom=$1;
 2508:         $krbdefdom=~tr/a-z/A-Z/;
 2509:         $krbdef = "krb4";
 2510:     }
 2511:     return ($krbdef,$krbdefdom);
 2512: }
 2513: 
 2514: 
 2515: ###############################################################
 2516: ##                Thesaurus Functions                        ##
 2517: ###############################################################
 2518: 
 2519: =pod
 2520: 
 2521: =head1 Thesaurus Functions
 2522: 
 2523: =over 4
 2524: 
 2525: =item * &initialize_keywords()
 2526: 
 2527: Initializes the package variable %Keywords if it is empty.  Uses the
 2528: package variable $thesaurus_db_file.
 2529: 
 2530: =cut
 2531: 
 2532: ###################################################
 2533: 
 2534: sub initialize_keywords {
 2535:     return 1 if (scalar keys(%Keywords));
 2536:     # If we are here, %Keywords is empty, so fill it up
 2537:     #   Make sure the file we need exists...
 2538:     if (! -e $thesaurus_db_file) {
 2539:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
 2540:                                  " failed because it does not exist");
 2541:         return 0;
 2542:     }
 2543:     #   Set up the hash as a database
 2544:     my %thesaurus_db;
 2545:     if (! tie(%thesaurus_db,'GDBM_File',
 2546:               $thesaurus_db_file,&GDBM_READER(),0640)){
 2547:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
 2548:                                  $thesaurus_db_file);
 2549:         return 0;
 2550:     } 
 2551:     #  Get the average number of appearances of a word.
 2552:     my $avecount = $thesaurus_db{'average.count'};
 2553:     #  Put keywords (those that appear > average) into %Keywords
 2554:     while (my ($word,$data)=each (%thesaurus_db)) {
 2555:         my ($count,undef) = split /:/,$data;
 2556:         $Keywords{$word}++ if ($count > $avecount);
 2557:     }
 2558:     untie %thesaurus_db;
 2559:     # Remove special values from %Keywords.
 2560:     foreach my $value ('total.count','average.count') {
 2561:         delete($Keywords{$value}) if (exists($Keywords{$value}));
 2562:   }
 2563:     return 1;
 2564: }
 2565: 
 2566: ###################################################
 2567: 
 2568: =pod
 2569: 
 2570: =item * &keyword($word)
 2571: 
 2572: Returns true if $word is a keyword.  A keyword is a word that appears more 
 2573: than the average number of times in the thesaurus database.  Calls 
 2574: &initialize_keywords
 2575: 
 2576: =cut
 2577: 
 2578: ###################################################
 2579: 
 2580: sub keyword {
 2581:     return if (!&initialize_keywords());
 2582:     my $word=lc(shift());
 2583:     $word=~s/\W//g;
 2584:     return exists($Keywords{$word});
 2585: }
 2586: 
 2587: ###############################################################
 2588: 
 2589: =pod 
 2590: 
 2591: =item * &get_related_words()
 2592: 
 2593: Look up a word in the thesaurus.  Takes a scalar argument and returns
 2594: an array of words.  If the keyword is not in the thesaurus, an empty array
 2595: will be returned.  The order of the words returned is determined by the
 2596: database which holds them.
 2597: 
 2598: Uses global $thesaurus_db_file.
 2599: 
 2600: =cut
 2601: 
 2602: ###############################################################
 2603: sub get_related_words {
 2604:     my $keyword = shift;
 2605:     my %thesaurus_db;
 2606:     if (! -e $thesaurus_db_file) {
 2607:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
 2608:                                  "failed because the file does not exist");
 2609:         return ();
 2610:     }
 2611:     if (! tie(%thesaurus_db,'GDBM_File',
 2612:               $thesaurus_db_file,&GDBM_READER(),0640)){
 2613:         return ();
 2614:     } 
 2615:     my @Words=();
 2616:     my $count=0;
 2617:     if (exists($thesaurus_db{$keyword})) {
 2618: 	# The first element is the number of times
 2619: 	# the word appears.  We do not need it now.
 2620: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
 2621: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
 2622: 	my $threshold=$mostfrequentcount/10;
 2623:         foreach my $possibleword (@RelatedWords) {
 2624:             my ($word,$wordcount)=split(/\,/,$possibleword);
 2625:             if ($wordcount>$threshold) {
 2626: 		push(@Words,$word);
 2627:                 $count++;
 2628:                 if ($count>10) { last; }
 2629: 	    }
 2630:         }
 2631:     }
 2632:     untie %thesaurus_db;
 2633:     return @Words;
 2634: }
 2635: 
 2636: =pod
 2637: 
 2638: =back
 2639: 
 2640: =cut
 2641: 
 2642: # -------------------------------------------------------------- Plaintext name
 2643: =pod
 2644: 
 2645: =head1 User Name Functions
 2646: 
 2647: =over 4
 2648: 
 2649: =item * &plainname($uname,$udom,$first)
 2650: 
 2651: Takes a users logon name and returns it as a string in
 2652: "first middle last generation" form 
 2653: if $first is set to 'lastname' then it returns it as
 2654: 'lastname generation, firstname middlename' if their is a lastname
 2655: 
 2656: =cut
 2657: 
 2658: 
 2659: ###############################################################
 2660: sub plainname {
 2661:     my ($uname,$udom,$first)=@_;
 2662:     return if (!defined($uname) || !defined($udom));
 2663:     my %names=&getnames($uname,$udom);
 2664:     my $name=&Apache::lonnet::format_name($names{'firstname'},
 2665: 					  $names{'middlename'},
 2666: 					  $names{'lastname'},
 2667: 					  $names{'generation'},$first);
 2668:     $name=~s/^\s+//;
 2669:     $name=~s/\s+$//;
 2670:     $name=~s/\s+/ /g;
 2671:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
 2672:     return $name;
 2673: }
 2674: 
 2675: # -------------------------------------------------------------------- Nickname
 2676: =pod
 2677: 
 2678: =item * &nickname($uname,$udom)
 2679: 
 2680: Gets a users name and returns it as a string as
 2681: 
 2682: "&quot;nickname&quot;"
 2683: 
 2684: if the user has a nickname or
 2685: 
 2686: "first middle last generation"
 2687: 
 2688: if the user does not
 2689: 
 2690: =cut
 2691: 
 2692: sub nickname {
 2693:     my ($uname,$udom)=@_;
 2694:     return if (!defined($uname) || !defined($udom));
 2695:     my %names=&getnames($uname,$udom);
 2696:     my $name=$names{'nickname'};
 2697:     if ($name) {
 2698:        $name='&quot;'.$name.'&quot;'; 
 2699:     } else {
 2700:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
 2701: 	     $names{'lastname'}.' '.$names{'generation'};
 2702:        $name=~s/\s+$//;
 2703:        $name=~s/\s+/ /g;
 2704:     }
 2705:     return $name;
 2706: }
 2707: 
 2708: sub getnames {
 2709:     my ($uname,$udom)=@_;
 2710:     return if (!defined($uname) || !defined($udom));
 2711:     if ($udom eq 'public' && $uname eq 'public') {
 2712: 	return ('lastname' => &mt('Public'));
 2713:     }
 2714:     my $id=$uname.':'.$udom;
 2715:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
 2716:     if ($cached) {
 2717: 	return %{$names};
 2718:     } else {
 2719: 	my %loadnames=&Apache::lonnet::get('environment',
 2720:                     ['firstname','middlename','lastname','generation','nickname'],
 2721: 					 $udom,$uname);
 2722: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
 2723: 	return %loadnames;
 2724:     }
 2725: }
 2726: 
 2727: # -------------------------------------------------------------------- getemails
 2728: 
 2729: =pod
 2730: 
 2731: =item * &getemails($uname,$udom)
 2732: 
 2733: Gets a user's email information and returns it as a hash with keys:
 2734: notification, critnotification, permanentemail
 2735: 
 2736: For notification and critnotification, values are comma-separated lists 
 2737: of e-mail addresses; for permanentemail, value is a single e-mail address.
 2738:  
 2739: 
 2740: =cut
 2741: 
 2742: 
 2743: sub getemails {
 2744:     my ($uname,$udom)=@_;
 2745:     if ($udom eq 'public' && $uname eq 'public') {
 2746: 	return;
 2747:     }
 2748:     if (!$udom) { $udom=$env{'user.domain'}; }
 2749:     if (!$uname) { $uname=$env{'user.name'}; }
 2750:     my $id=$uname.':'.$udom;
 2751:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
 2752:     if ($cached) {
 2753: 	return %{$names};
 2754:     } else {
 2755: 	my %loadnames=&Apache::lonnet::get('environment',
 2756:                     			   ['notification','critnotification',
 2757: 					    'permanentemail'],
 2758: 					   $udom,$uname);
 2759: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
 2760: 	return %loadnames;
 2761:     }
 2762: }
 2763: 
 2764: sub flush_email_cache {
 2765:     my ($uname,$udom)=@_;
 2766:     if (!$udom)  { $udom =$env{'user.domain'}; }
 2767:     if (!$uname) { $uname=$env{'user.name'};   }
 2768:     return if ($udom eq 'public' && $uname eq 'public');
 2769:     my $id=$uname.':'.$udom;
 2770:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
 2771: }
 2772: 
 2773: # -------------------------------------------------------------------- getlangs
 2774: 
 2775: =pod
 2776: 
 2777: =item * &getlangs($uname,$udom)
 2778: 
 2779: Gets a user's language preference and returns it as a hash with key:
 2780: language.
 2781: 
 2782: =cut
 2783: 
 2784: 
 2785: sub getlangs {
 2786:     my ($uname,$udom) = @_;
 2787:     if (!$udom)  { $udom =$env{'user.domain'}; }
 2788:     if (!$uname) { $uname=$env{'user.name'};   }
 2789:     my $id=$uname.':'.$udom;
 2790:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
 2791:     if ($cached) {
 2792:         return %{$langs};
 2793:     } else {
 2794:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
 2795:                                            $udom,$uname);
 2796:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
 2797:         return %loadlangs;
 2798:     }
 2799: }
 2800: 
 2801: sub flush_langs_cache {
 2802:     my ($uname,$udom)=@_;
 2803:     if (!$udom)  { $udom =$env{'user.domain'}; }
 2804:     if (!$uname) { $uname=$env{'user.name'};   }
 2805:     return if ($udom eq 'public' && $uname eq 'public');
 2806:     my $id=$uname.':'.$udom;
 2807:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
 2808: }
 2809: 
 2810: # ------------------------------------------------------------------ Screenname
 2811: 
 2812: =pod
 2813: 
 2814: =item * &screenname($uname,$udom)
 2815: 
 2816: Gets a users screenname and returns it as a string
 2817: 
 2818: =cut
 2819: 
 2820: sub screenname {
 2821:     my ($uname,$udom)=@_;
 2822:     if ($uname eq $env{'user.name'} &&
 2823: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
 2824:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
 2825:     return $names{'screenname'};
 2826: }
 2827: 
 2828: 
 2829: # ------------------------------------------------------------- Confirm Wrapper
 2830: =pod
 2831: 
 2832: =item confirmwrapper
 2833: 
 2834: Wrap messages about completion of operation in box
 2835: 
 2836: =cut
 2837: 
 2838: sub confirmwrapper {
 2839:     my ($message)=@_;
 2840:     if ($message) {
 2841:         return "\n".'<div class="LC_confirm_box">'."\n"
 2842:                .$message."\n"
 2843:                .'</div>'."\n";
 2844:     } else {
 2845:         return $message;
 2846:     }
 2847: }
 2848: 
 2849: # ------------------------------------------------------------- Message Wrapper
 2850: 
 2851: sub messagewrapper {
 2852:     my ($link,$username,$domain,$subject,$text)=@_;
 2853:     return 
 2854:         '<a href="/adm/email?compose=individual&amp;'.
 2855:         'recname='.$username.'&amp;recdom='.$domain.
 2856: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
 2857:         'title="'.&mt('Send message').'">'.$link.'</a>';
 2858: }
 2859: 
 2860: # --------------------------------------------------------------- Notes Wrapper
 2861: 
 2862: sub noteswrapper {
 2863:     my ($link,$un,$do)=@_;
 2864:     return 
 2865: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
 2866: }
 2867: 
 2868: # ------------------------------------------------------------- Aboutme Wrapper
 2869: 
 2870: sub aboutmewrapper {
 2871:     my ($link,$username,$domain,$target)=@_;
 2872:     if (!defined($username)  && !defined($domain)) {
 2873:         return;
 2874:     }
 2875:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
 2876: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
 2877: }
 2878: 
 2879: # ------------------------------------------------------------ Syllabus Wrapper
 2880: 
 2881: sub syllabuswrapper {
 2882:     my ($linktext,$coursedir,$domain)=@_;
 2883:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
 2884: }
 2885: 
 2886: # -----------------------------------------------------------------------------
 2887: 
 2888: sub track_student_link {
 2889:     my ($linktext,$sname,$sdom,$target,$start) = @_;
 2890:     my $link ="/adm/trackstudent?";
 2891:     my $title = 'View recent activity';
 2892:     if (defined($sname) && $sname !~ /^\s*$/ &&
 2893:         defined($sdom)  && $sdom  !~ /^\s*$/) {
 2894:         $link .= "selected_student=$sname:$sdom";
 2895:         $title .= ' of this student';
 2896:     } 
 2897:     if (defined($target) && $target !~ /^\s*$/) {
 2898:         $target = qq{target="$target"};
 2899:     } else {
 2900:         $target = '';
 2901:     }
 2902:     if ($start) { $link.='&amp;start='.$start; }
 2903:     $title = &mt($title);
 2904:     $linktext = &mt($linktext);
 2905:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
 2906: 	&help_open_topic('View_recent_activity');
 2907: }
 2908: 
 2909: sub slot_reservations_link {
 2910:     my ($linktext,$sname,$sdom,$target) = @_;
 2911:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
 2912:     my $title = 'View slot reservation history';
 2913:     if (defined($sname) && $sname !~ /^\s*$/ &&
 2914:         defined($sdom)  && $sdom  !~ /^\s*$/) {
 2915:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
 2916:         $title .= ' of this student';
 2917:     }
 2918:     if (defined($target) && $target !~ /^\s*$/) {
 2919:         $target = qq{target="$target"};
 2920:     } else {
 2921:         $target = '';
 2922:     }
 2923:     $title = &mt($title);
 2924:     $linktext = &mt($linktext);
 2925:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
 2926: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
 2927: 
 2928: }
 2929: 
 2930: # ===================================================== Display a student photo
 2931: 
 2932: 
 2933: sub student_image_tag {
 2934:     my ($domain,$user)=@_;
 2935:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
 2936:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
 2937: 	return '<img src="'.$imgsrc.'" align="right" />';
 2938:     } else {
 2939: 	return '';
 2940:     }
 2941: }
 2942: 
 2943: =pod
 2944: 
 2945: =back
 2946: 
 2947: =head1 Access .tab File Data
 2948: 
 2949: =over 4
 2950: 
 2951: =item * &languageids() 
 2952: 
 2953: returns list of all language ids
 2954: 
 2955: =cut
 2956: 
 2957: sub languageids {
 2958:     return sort(keys(%language));
 2959: }
 2960: 
 2961: =pod
 2962: 
 2963: =item * &languagedescription() 
 2964: 
 2965: returns description of a specified language id
 2966: 
 2967: =cut
 2968: 
 2969: sub languagedescription {
 2970:     my $code=shift;
 2971:     return  ($supported_language{$code}?'* ':'').
 2972:             $language{$code}.
 2973: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
 2974: }
 2975: 
 2976: sub plainlanguagedescription {
 2977:     my $code=shift;
 2978:     return $language{$code};
 2979: }
 2980: 
 2981: sub supportedlanguagecode {
 2982:     my $code=shift;
 2983:     return $supported_language{$code};
 2984: }
 2985: 
 2986: =pod
 2987: 
 2988: =item * &copyrightids() 
 2989: 
 2990: returns list of all copyrights
 2991: 
 2992: =cut
 2993: 
 2994: sub copyrightids {
 2995:     return sort(keys(%cprtag));
 2996: }
 2997: 
 2998: =pod
 2999: 
 3000: =item * &copyrightdescription() 
 3001: 
 3002: returns description of a specified copyright id
 3003: 
 3004: =cut
 3005: 
 3006: sub copyrightdescription {
 3007:     return &mt($cprtag{shift(@_)});
 3008: }
 3009: 
 3010: =pod
 3011: 
 3012: =item * &source_copyrightids() 
 3013: 
 3014: returns list of all source copyrights
 3015: 
 3016: =cut
 3017: 
 3018: sub source_copyrightids {
 3019:     return sort(keys(%scprtag));
 3020: }
 3021: 
 3022: =pod
 3023: 
 3024: =item * &source_copyrightdescription() 
 3025: 
 3026: returns description of a specified source copyright id
 3027: 
 3028: =cut
 3029: 
 3030: sub source_copyrightdescription {
 3031:     return &mt($scprtag{shift(@_)});
 3032: }
 3033: 
 3034: =pod
 3035: 
 3036: =item * &filecategories() 
 3037: 
 3038: returns list of all file categories
 3039: 
 3040: =cut
 3041: 
 3042: sub filecategories {
 3043:     return sort(keys(%category_extensions));
 3044: }
 3045: 
 3046: =pod
 3047: 
 3048: =item * &filecategorytypes() 
 3049: 
 3050: returns list of file types belonging to a given file
 3051: category
 3052: 
 3053: =cut
 3054: 
 3055: sub filecategorytypes {
 3056:     my ($cat) = @_;
 3057:     return @{$category_extensions{lc($cat)}};
 3058: }
 3059: 
 3060: =pod
 3061: 
 3062: =item * &fileembstyle() 
 3063: 
 3064: returns embedding style for a specified file type
 3065: 
 3066: =cut
 3067: 
 3068: sub fileembstyle {
 3069:     return $fe{lc(shift(@_))};
 3070: }
 3071: 
 3072: sub filemimetype {
 3073:     return $fm{lc(shift(@_))};
 3074: }
 3075: 
 3076: 
 3077: sub filecategoryselect {
 3078:     my ($name,$value)=@_;
 3079:     return &select_form($value,$name,
 3080: 			'' => &mt('Any category'),
 3081: 			map { $_,$_ } sort(keys(%category_extensions)));
 3082: }
 3083: 
 3084: =pod
 3085: 
 3086: =item * &filedescription() 
 3087: 
 3088: returns description for a specified file type
 3089: 
 3090: =cut
 3091: 
 3092: sub filedescription {
 3093:     my $file_description = $fd{lc(shift())};
 3094:     $file_description =~ s:([\[\]]):~$1:g;
 3095:     return &mt($file_description);
 3096: }
 3097: 
 3098: =pod
 3099: 
 3100: =item * &filedescriptionex() 
 3101: 
 3102: returns description for a specified file type with
 3103: extra formatting
 3104: 
 3105: =cut
 3106: 
 3107: sub filedescriptionex {
 3108:     my $ex=shift;
 3109:     my $file_description = $fd{lc($ex)};
 3110:     $file_description =~ s:([\[\]]):~$1:g;
 3111:     return '.'.$ex.' '.&mt($file_description);
 3112: }
 3113: 
 3114: # End of .tab access
 3115: =pod
 3116: 
 3117: =back
 3118: 
 3119: =cut
 3120: 
 3121: # ------------------------------------------------------------------ File Types
 3122: sub fileextensions {
 3123:     return sort(keys(%fe));
 3124: }
 3125: 
 3126: # ----------------------------------------------------------- Display Languages
 3127: # returns a hash with all desired display languages
 3128: #
 3129: 
 3130: sub display_languages {
 3131:     my %languages=();
 3132:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
 3133: 	$languages{$lang}=1;
 3134:     }
 3135:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
 3136:     if ($env{'form.displaylanguage'}) {
 3137: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
 3138: 	    $languages{$lang}=1;
 3139:         }
 3140:     }
 3141:     return %languages;
 3142: }
 3143: 
 3144: sub languages {
 3145:     my ($possible_langs) = @_;
 3146:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
 3147:     if (!ref($possible_langs)) {
 3148: 	if( wantarray ) {
 3149: 	    return @preferred_langs;
 3150: 	} else {
 3151: 	    return $preferred_langs[0];
 3152: 	}
 3153:     }
 3154:     my %possibilities = map { $_ => 1 } (@$possible_langs);
 3155:     my @preferred_possibilities;
 3156:     foreach my $preferred_lang (@preferred_langs) {
 3157: 	if (exists($possibilities{$preferred_lang})) {
 3158: 	    push(@preferred_possibilities, $preferred_lang);
 3159: 	}
 3160:     }
 3161:     if( wantarray ) {
 3162: 	return @preferred_possibilities;
 3163:     }
 3164:     return $preferred_possibilities[0];
 3165: }
 3166: 
 3167: sub user_lang {
 3168:     my ($touname,$toudom,$fromcid) = @_;
 3169:     my @userlangs;
 3170:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
 3171:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
 3172:                     $env{'course.'.$fromcid.'.languages'}));
 3173:     } else {
 3174:         my %langhash = &getlangs($touname,$toudom);
 3175:         if ($langhash{'languages'} ne '') {
 3176:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
 3177:         } else {
 3178:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
 3179:             if ($domdefs{'lang_def'} ne '') {
 3180:                 @userlangs = ($domdefs{'lang_def'});
 3181:             }
 3182:         }
 3183:     }
 3184:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
 3185:     my $user_lh = Apache::localize->get_handle(@languages);
 3186:     return $user_lh;
 3187: }
 3188: 
 3189: 
 3190: ###############################################################
 3191: ##               Student Answer Attempts                     ##
 3192: ###############################################################
 3193: 
 3194: =pod
 3195: 
 3196: =head1 Alternate Problem Views
 3197: 
 3198: =over 4
 3199: 
 3200: =item * &get_previous_attempt($symb, $username, $domain, $course,
 3201:     $getattempt, $regexp, $gradesub)
 3202: 
 3203: Return string with previous attempt on problem. Arguments:
 3204: 
 3205: =over 4
 3206: 
 3207: =item * $symb: Problem, including path
 3208: 
 3209: =item * $username: username of the desired student
 3210: 
 3211: =item * $domain: domain of the desired student
 3212: 
 3213: =item * $course: Course ID
 3214: 
 3215: =item * $getattempt: Leave blank for all attempts, otherwise put
 3216:     something
 3217: 
 3218: =item * $regexp: if string matches this regexp, the string will be
 3219:     sent to $gradesub
 3220: 
 3221: =item * $gradesub: routine that processes the string if it matches $regexp
 3222: 
 3223: =back
 3224: 
 3225: The output string is a table containing all desired attempts, if any.
 3226: 
 3227: =cut
 3228: 
 3229: sub get_previous_attempt {
 3230:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
 3231:   my $prevattempts='';
 3232:   no strict 'refs';
 3233:   if ($symb) {
 3234:     my (%returnhash)=
 3235:       &Apache::lonnet::restore($symb,$course,$domain,$username);
 3236:     if ($returnhash{'version'}) {
 3237:       my %lasthash=();
 3238:       my $version;
 3239:       for ($version=1;$version<=$returnhash{'version'};$version++) {
 3240:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
 3241: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
 3242:         }
 3243:       }
 3244:       $prevattempts=&start_data_table().&start_data_table_header_row();
 3245:       $prevattempts.='<th>'.&mt('History').'</th>';
 3246:       foreach my $key (sort(keys(%lasthash))) {
 3247: 	my ($ign,@parts) = split(/\./,$key);
 3248: 	if ($#parts > 0) {
 3249: 	  my $data=$parts[-1];
 3250: 	  pop(@parts);
 3251: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
 3252: 	} else {
 3253: 	  if ($#parts == 0) {
 3254: 	    $prevattempts.='<th>'.$parts[0].'</th>';
 3255: 	  } else {
 3256: 	    $prevattempts.='<th>'.$ign.'</th>';
 3257: 	  }
 3258: 	}
 3259:       }
 3260:       $prevattempts.=&end_data_table_header_row();
 3261:       if ($getattempt eq '') {
 3262: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
 3263: 	  $prevattempts.=&start_data_table_row().
 3264: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
 3265: 	    foreach my $key (sort(keys(%lasthash))) {
 3266: 		my $value = &format_previous_attempt_value($key,
 3267: 							   $returnhash{$version.':'.$key});
 3268: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
 3269: 	    }
 3270: 	  $prevattempts.=&end_data_table_row();
 3271: 	 }
 3272:       }
 3273:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
 3274:       foreach my $key (sort(keys(%lasthash))) {
 3275: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
 3276: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
 3277: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
 3278:       }
 3279:       $prevattempts.= &end_data_table_row().&end_data_table();
 3280:     } else {
 3281:       $prevattempts=
 3282: 	  &start_data_table().&start_data_table_row().
 3283: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
 3284: 	  &end_data_table_row().&end_data_table();
 3285:     }
 3286:   } else {
 3287:     $prevattempts=
 3288: 	  &start_data_table().&start_data_table_row().
 3289: 	  '<td>'.&mt('No data.').'</td>'.
 3290: 	  &end_data_table_row().&end_data_table();
 3291:   }
 3292: }
 3293: 
 3294: sub format_previous_attempt_value {
 3295:     my ($key,$value) = @_;
 3296:     if ($key =~ /timestamp/) {
 3297: 	$value = &Apache::lonlocal::locallocaltime($value);
 3298:     } elsif (ref($value) eq 'ARRAY') {
 3299: 	$value = '('.join(', ', @{ $value }).')';
 3300:     } else {
 3301: 	$value = &unescape($value);
 3302:     }
 3303:     return $value;
 3304: }
 3305: 
 3306: 
 3307: sub relative_to_absolute {
 3308:     my ($url,$output)=@_;
 3309:     my $parser=HTML::TokeParser->new(\$output);
 3310:     my $token;
 3311:     my $thisdir=$url;
 3312:     my @rlinks=();
 3313:     while ($token=$parser->get_token) {
 3314: 	if ($token->[0] eq 'S') {
 3315: 	    if ($token->[1] eq 'a') {
 3316: 		if ($token->[2]->{'href'}) {
 3317: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
 3318: 		}
 3319: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
 3320: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
 3321: 	    } elsif ($token->[1] eq 'base') {
 3322: 		$thisdir=$token->[2]->{'href'};
 3323: 	    }
 3324: 	}
 3325:     }
 3326:     $thisdir=~s-/[^/]*$--;
 3327:     foreach my $link (@rlinks) {
 3328: 	unless (($link=~/^https?\:\/\//i) ||
 3329: 		($link=~/^\//) ||
 3330: 		($link=~/^javascript:/i) ||
 3331: 		($link=~/^mailto:/i) ||
 3332: 		($link=~/^\#/)) {
 3333: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
 3334: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
 3335: 	}
 3336:     }
 3337: # -------------------------------------------------- Deal with Applet codebases
 3338:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
 3339:     return $output;
 3340: }
 3341: 
 3342: =pod
 3343: 
 3344: =item * &get_student_view()
 3345: 
 3346: show a snapshot of what student was looking at
 3347: 
 3348: =cut
 3349: 
 3350: sub get_student_view {
 3351:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
 3352:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
 3353:   my (%form);
 3354:   my @elements=('symb','courseid','domain','username');
 3355:   foreach my $element (@elements) {
 3356:       $form{'grade_'.$element}=eval '$'.$element #'
 3357:   }
 3358:   if (defined($moreenv)) {
 3359:       %form=(%form,%{$moreenv});
 3360:   }
 3361:   if (defined($target)) { $form{'grade_target'} = $target; }
 3362:   $feedurl=&Apache::lonnet::clutter($feedurl);
 3363:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
 3364:   $userview=~s/\<body[^\>]*\>//gi;
 3365:   $userview=~s/\<\/body\>//gi;
 3366:   $userview=~s/\<html\>//gi;
 3367:   $userview=~s/\<\/html\>//gi;
 3368:   $userview=~s/\<head\>//gi;
 3369:   $userview=~s/\<\/head\>//gi;
 3370:   $userview=~s/action\s*\=/would_be_action\=/gi;
 3371:   $userview=&relative_to_absolute($feedurl,$userview);
 3372:   if (wantarray) {
 3373:      return ($userview,$response);
 3374:   } else {
 3375:      return $userview;
 3376:   }
 3377: }
 3378: 
 3379: sub get_student_view_with_retries {
 3380:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
 3381: 
 3382:     my $ok = 0;                 # True if we got a good response.
 3383:     my $content;
 3384:     my $response;
 3385: 
 3386:     # Try to get the student_view done. within the retries count:
 3387:     
 3388:     do {
 3389:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
 3390:          $ok      = $response->is_success;
 3391:          if (!$ok) {
 3392:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
 3393:          }
 3394:          $retries--;
 3395:     } while (!$ok && ($retries > 0));
 3396:     
 3397:     if (!$ok) {
 3398:        $content = '';          # On error return an empty content.
 3399:     }
 3400:     if (wantarray) {
 3401:        return ($content, $response);
 3402:     } else {
 3403:        return $content;
 3404:     }
 3405: }
 3406: 
 3407: =pod
 3408: 
 3409: =item * &get_student_answers() 
 3410: 
 3411: show a snapshot of how student was answering problem
 3412: 
 3413: =cut
 3414: 
 3415: sub get_student_answers {
 3416:   my ($symb,$username,$domain,$courseid,%form) = @_;
 3417:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
 3418:   my (%moreenv);
 3419:   my @elements=('symb','courseid','domain','username');
 3420:   foreach my $element (@elements) {
 3421:     $moreenv{'grade_'.$element}=eval '$'.$element #'
 3422:   }
 3423:   $moreenv{'grade_target'}='answer';
 3424:   %moreenv=(%form,%moreenv);
 3425:   $feedurl = &Apache::lonnet::clutter($feedurl);
 3426:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
 3427:   return $userview;
 3428: }
 3429: 
 3430: =pod
 3431: 
 3432: =item * &submlink()
 3433: 
 3434: Inputs: $text $uname $udom $symb $target
 3435: 
 3436: Returns: A link to grades.pm such as to see the SUBM view of a student
 3437: 
 3438: =cut
 3439: 
 3440: ###############################################
 3441: sub submlink {
 3442:     my ($text,$uname,$udom,$symb,$target)=@_;
 3443:     if (!($uname && $udom)) {
 3444: 	(my $cursymb, my $courseid,$udom,$uname)=
 3445: 	    &Apache::lonnet::whichuser($symb);
 3446: 	if (!$symb) { $symb=$cursymb; }
 3447:     }
 3448:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
 3449:     $symb=&escape($symb);
 3450:     if ($target) { $target="target=\"$target\""; }
 3451:     return '<a href="/adm/grades?&command=submission&'.
 3452: 	'symb='.$symb.'&student='.$uname.
 3453: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
 3454: }
 3455: ##############################################
 3456: 
 3457: =pod
 3458: 
 3459: =item * &pgrdlink()
 3460: 
 3461: Inputs: $text $uname $udom $symb $target
 3462: 
 3463: Returns: A link to grades.pm such as to see the PGRD view of a student
 3464: 
 3465: =cut
 3466: 
 3467: ###############################################
 3468: sub pgrdlink {
 3469:     my $link=&submlink(@_);
 3470:     $link=~s/(&command=submission)/$1&showgrading=yes/;
 3471:     return $link;
 3472: }
 3473: ##############################################
 3474: 
 3475: =pod
 3476: 
 3477: =item * &pprmlink()
 3478: 
 3479: Inputs: $text $uname $udom $symb $target
 3480: 
 3481: Returns: A link to parmset.pm such as to see the PPRM view of a
 3482: student and a specific resource
 3483: 
 3484: =cut
 3485: 
 3486: ###############################################
 3487: sub pprmlink {
 3488:     my ($text,$uname,$udom,$symb,$target)=@_;
 3489:     if (!($uname && $udom)) {
 3490: 	(my $cursymb, my $courseid,$udom,$uname)=
 3491: 	    &Apache::lonnet::whichuser($symb);
 3492: 	if (!$symb) { $symb=$cursymb; }
 3493:     }
 3494:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
 3495:     $symb=&escape($symb);
 3496:     if ($target) { $target="target=\"$target\""; }
 3497:     return '<a href="/adm/parmset?command=set&amp;'.
 3498: 	'symb='.$symb.'&amp;uname='.$uname.
 3499: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
 3500: }
 3501: ##############################################
 3502: 
 3503: =pod
 3504: 
 3505: =back
 3506: 
 3507: =cut
 3508: 
 3509: ###############################################
 3510: 
 3511: 
 3512: sub timehash {
 3513:     my ($thistime) = @_;
 3514:     my $timezone = &Apache::lonlocal::gettimezone();
 3515:     my $dt = DateTime->from_epoch(epoch => $thistime)
 3516:                      ->set_time_zone($timezone);
 3517:     my $wday = $dt->day_of_week();
 3518:     if ($wday == 7) { $wday = 0; }
 3519:     return ( 'second' => $dt->second(),
 3520:              'minute' => $dt->minute(),
 3521:              'hour'   => $dt->hour(),
 3522:              'day'     => $dt->day_of_month(),
 3523:              'month'   => $dt->month(),
 3524:              'year'    => $dt->year(),
 3525:              'weekday' => $wday,
 3526:              'dayyear' => $dt->day_of_year(),
 3527:              'dlsav'   => $dt->is_dst() );
 3528: }
 3529: 
 3530: sub utc_string {
 3531:     my ($date)=@_;
 3532:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
 3533: }
 3534: 
 3535: sub maketime {
 3536:     my %th=@_;
 3537:     my ($epoch_time,$timezone,$dt);
 3538:     $timezone = &Apache::lonlocal::gettimezone();
 3539:     eval {
 3540:         $dt = DateTime->new( year   => $th{'year'},
 3541:                              month  => $th{'month'},
 3542:                              day    => $th{'day'},
 3543:                              hour   => $th{'hour'},
 3544:                              minute => $th{'minute'},
 3545:                              second => $th{'second'},
 3546:                              time_zone => $timezone,
 3547:                          );
 3548:     };
 3549:     if (!$@) {
 3550:         $epoch_time = $dt->epoch;
 3551:         if ($epoch_time) {
 3552:             return $epoch_time;
 3553:         }
 3554:     }
 3555:     return POSIX::mktime(
 3556:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
 3557:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
 3558: }
 3559: 
 3560: #########################################
 3561: 
 3562: sub findallcourses {
 3563:     my ($roles,$uname,$udom) = @_;
 3564:     my %roles;
 3565:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
 3566:     my %courses;
 3567:     my $now=time;
 3568:     if (!defined($uname)) {
 3569:         $uname = $env{'user.name'};
 3570:     }
 3571:     if (!defined($udom)) {
 3572:         $udom = $env{'user.domain'};
 3573:     }
 3574:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
 3575:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
 3576:         if (!%roles) {
 3577:             %roles = (
 3578:                        cc => 1,
 3579:                        in => 1,
 3580:                        ep => 1,
 3581:                        ta => 1,
 3582:                        cr => 1,
 3583:                        st => 1,
 3584:              );
 3585:         }
 3586:         foreach my $entry (keys(%roleshash)) {
 3587:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
 3588:             if ($trole =~ /^cr/) { 
 3589:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
 3590:             } else {
 3591:                 next if (!exists($roles{$trole}));
 3592:             }
 3593:             if ($tend) {
 3594:                 next if ($tend < $now);
 3595:             }
 3596:             if ($tstart) {
 3597:                 next if ($tstart > $now);
 3598:             }
 3599:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
 3600:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
 3601:             if ($secpart eq '') {
 3602:                 ($cnum,$role) = split(/_/,$cnumpart); 
 3603:                 $sec = 'none';
 3604:                 $realsec = '';
 3605:             } else {
 3606:                 $cnum = $cnumpart;
 3607:                 ($sec,$role) = split(/_/,$secpart);
 3608:                 $realsec = $sec;
 3609:             }
 3610:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
 3611:         }
 3612:     } else {
 3613:         foreach my $key (keys(%env)) {
 3614: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
 3615:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
 3616: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
 3617: 	        next if ($role eq 'ca' || $role eq 'aa');
 3618: 	        next if (%roles && !exists($roles{$role}));
 3619: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
 3620:                 my $active=1;
 3621:                 if ($starttime) {
 3622: 		    if ($now<$starttime) { $active=0; }
 3623:                 }
 3624:                 if ($endtime) {
 3625:                     if ($now>$endtime) { $active=0; }
 3626:                 }
 3627:                 if ($active) {
 3628:                     if ($sec eq '') {
 3629:                         $sec = 'none';
 3630:                     }
 3631:                     $courses{$cdom.'_'.$cnum}{$sec} = 
 3632:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
 3633:                 }
 3634:             }
 3635:         }
 3636:     }
 3637:     return %courses;
 3638: }
 3639: 
 3640: ###############################################
 3641: 
 3642: sub blockcheck {
 3643:     my ($setters,$activity,$uname,$udom) = @_;
 3644: 
 3645:     if (!defined($udom)) {
 3646:         $udom = $env{'user.domain'};
 3647:     }
 3648:     if (!defined($uname)) {
 3649:         $uname = $env{'user.name'};
 3650:     }
 3651: 
 3652:     # If uname and udom are for a course, check for blocks in the course.
 3653: 
 3654:     if (&Apache::lonnet::is_course($udom,$uname)) {
 3655:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
 3656:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
 3657:         return ($startblock,$endblock);
 3658:     }
 3659: 
 3660:     my $startblock = 0;
 3661:     my $endblock = 0;
 3662:     my %live_courses = &findallcourses(undef,$uname,$udom);
 3663: 
 3664:     # If uname is for a user, and activity is course-specific, i.e.,
 3665:     # boards, chat or groups, check for blocking in current course only.
 3666: 
 3667:     if (($activity eq 'boards' || $activity eq 'chat' ||
 3668:          $activity eq 'groups') && ($env{'request.course.id'})) {
 3669:         foreach my $key (keys(%live_courses)) {
 3670:             if ($key ne $env{'request.course.id'}) {
 3671:                 delete($live_courses{$key});
 3672:             }
 3673:         }
 3674:     }
 3675: 
 3676:     my $otheruser = 0;
 3677:     my %own_courses;
 3678:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
 3679:         # Resource belongs to user other than current user.
 3680:         $otheruser = 1;
 3681:         # Gather courses for current user
 3682:         %own_courses = 
 3683:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
 3684:     }
 3685: 
 3686:     # Gather active course roles - course coordinator, instructor, 
 3687:     # exam proctor, ta, student, or custom role.
 3688: 
 3689:     foreach my $course (keys(%live_courses)) {
 3690:         my ($cdom,$cnum);
 3691:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
 3692:             $cdom = $env{'course.'.$course.'.domain'};
 3693:             $cnum = $env{'course.'.$course.'.num'};
 3694:         } else {
 3695:             ($cdom,$cnum) = split(/_/,$course); 
 3696:         }
 3697:         my $no_ownblock = 0;
 3698:         my $no_userblock = 0;
 3699:         if ($otheruser && $activity ne 'com') {
 3700:             # Check if current user has 'evb' priv for this
 3701:             if (defined($own_courses{$course})) {
 3702:                 foreach my $sec (keys(%{$own_courses{$course}})) {
 3703:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
 3704:                     if ($sec ne 'none') {
 3705:                         $checkrole .= '/'.$sec;
 3706:                     }
 3707:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
 3708:                         $no_ownblock = 1;
 3709:                         last;
 3710:                     }
 3711:                 }
 3712:             }
 3713:             # if they have 'evb' priv and are currently not playing student
 3714:             next if (($no_ownblock) &&
 3715:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
 3716:         }
 3717:         foreach my $sec (keys(%{$live_courses{$course}})) {
 3718:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
 3719:             if ($sec ne 'none') {
 3720:                 $checkrole .= '/'.$sec;
 3721:             }
 3722:             if ($otheruser) {
 3723:                 # Resource belongs to user other than current user.
 3724:                 # Assemble privs for that user, and check for 'evb' priv.
 3725:                 my ($trole,$tdom,$tnum,$tsec);
 3726:                 my $entry = $live_courses{$course}{$sec};
 3727:                 if ($entry =~ /^cr/) {
 3728:                     ($trole,$tdom,$tnum,$tsec) = 
 3729:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
 3730:                 } else {
 3731:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
 3732:                 }
 3733:                 my ($spec,$area,$trest,%allroles,%userroles);
 3734:                 $area = '/'.$tdom.'/'.$tnum;
 3735:                 $trest = $tnum;
 3736:                 if ($tsec ne '') {
 3737:                     $area .= '/'.$tsec;
 3738:                     $trest .= '/'.$tsec;
 3739:                 }
 3740:                 $spec = $trole.'.'.$area;
 3741:                 if ($trole =~ /^cr/) {
 3742:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
 3743:                                                       $tdom,$spec,$trest,$area);
 3744:                 } else {
 3745:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
 3746:                                                        $tdom,$spec,$trest,$area);
 3747:                 }
 3748:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
 3749:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
 3750:                     if ($1) {
 3751:                         $no_userblock = 1;
 3752:                         last;
 3753:                     }
 3754:                 }
 3755:             } else {
 3756:                 # Resource belongs to current user
 3757:                 # Check for 'evb' priv via lonnet::allowed().
 3758:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
 3759:                     $no_ownblock = 1;
 3760:                     last;
 3761:                 }
 3762:             }
 3763:         }
 3764:         # if they have the evb priv and are currently not playing student
 3765:         next if (($no_ownblock) &&
 3766:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
 3767:         next if ($no_userblock);
 3768: 
 3769:         # Retrieve blocking times and identity of blocker for course
 3770:         # of specified user, unless user has 'evb' privilege.
 3771:         
 3772:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
 3773:         if (($start != 0) && 
 3774:             (($startblock == 0) || ($startblock > $start))) {
 3775:             $startblock = $start;
 3776:         }
 3777:         if (($end != 0)  &&
 3778:             (($endblock == 0) || ($endblock < $end))) {
 3779:             $endblock = $end;
 3780:         }
 3781:     }
 3782:     return ($startblock,$endblock);
 3783: }
 3784: 
 3785: sub get_blocks {
 3786:     my ($setters,$activity,$cdom,$cnum) = @_;
 3787:     my $startblock = 0;
 3788:     my $endblock = 0;
 3789:     my $course = $cdom.'_'.$cnum;
 3790:     $setters->{$course} = {};
 3791:     $setters->{$course}{'staff'} = [];
 3792:     $setters->{$course}{'times'} = [];
 3793:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
 3794:     foreach my $record (keys(%records)) {
 3795:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
 3796:         if ($start <= time && $end >= time) {
 3797:             my ($staff_name,$staff_dom,$title,$blocks) =
 3798:                 &parse_block_record($records{$record});
 3799:             if ($blocks->{$activity} eq 'on') {
 3800:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
 3801:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
 3802:                 if ( ($startblock == 0) || ($startblock > $start) ) {
 3803:                     $startblock = $start;
 3804:                 }
 3805:                 if ( ($endblock == 0) || ($endblock < $end) ) {
 3806:                     $endblock = $end;
 3807:                 }
 3808:             }
 3809:         }
 3810:     }
 3811:     return ($startblock,$endblock);
 3812: }
 3813: 
 3814: sub parse_block_record {
 3815:     my ($record) = @_;
 3816:     my ($setuname,$setudom,$title,$blocks);
 3817:     if (ref($record) eq 'HASH') {
 3818:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
 3819:         $title = &unescape($record->{'event'});
 3820:         $blocks = $record->{'blocks'};
 3821:     } else {
 3822:         my @data = split(/:/,$record,3);
 3823:         if (scalar(@data) eq 2) {
 3824:             $title = $data[1];
 3825:             ($setuname,$setudom) = split(/@/,$data[0]);
 3826:         } else {
 3827:             ($setuname,$setudom,$title) = @data;
 3828:         }
 3829:         $blocks = { 'com' => 'on' };
 3830:     }
 3831:     return ($setuname,$setudom,$title,$blocks);
 3832: }
 3833: 
 3834: sub build_block_table {
 3835:     my ($startblock,$endblock,$setters) = @_;
 3836:     my %lt = &Apache::lonlocal::texthash(
 3837:         'cacb' => 'Currently active communication blocks',
 3838:         'cour' => 'Course',
 3839:         'dura' => 'Duration',
 3840:         'blse' => 'Block set by'
 3841:     );
 3842:     my $output;
 3843:     $output = '<br />'.$lt{'cacb'}.':<br />';
 3844:     $output .= &start_data_table();
 3845:     $output .= '
 3846: <tr>
 3847:  <th>'.$lt{'cour'}.'</th>
 3848:  <th>'.$lt{'dura'}.'</th>
 3849:  <th>'.$lt{'blse'}.'</th>
 3850: </tr>
 3851: ';
 3852:     foreach my $course (keys(%{$setters})) {
 3853:         my %courseinfo=&Apache::lonnet::coursedescription($course);
 3854:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
 3855:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
 3856:             my $fullname = &plainname($uname,$udom);
 3857:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
 3858:                 && $env{'user.name'} ne 'public' 
 3859:                 && $env{'user.domain'} ne 'public') {
 3860:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
 3861:             }
 3862:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
 3863:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
 3864:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
 3865:             $output .= &Apache::loncommon::start_data_table_row().
 3866:                        '<td>'.$courseinfo{'description'}.'</td>'.
 3867:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
 3868:                        '<td>'.$fullname.'</td>'.
 3869:                         &Apache::loncommon::end_data_table_row();
 3870:         }
 3871:     }
 3872:     $output .= &end_data_table();
 3873: }
 3874: 
 3875: sub blocking_status {
 3876:     my ($activity,$uname,$udom) = @_;
 3877:     my %setters;
 3878:     my ($blocked,$output,$ownitem,$is_course);
 3879:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
 3880:     if ($startblock && $endblock) {
 3881:         $blocked = 1;
 3882:         if (wantarray) {
 3883:             my $category;
 3884:             if ($activity eq 'boards') {
 3885:                 $category = 'Discussion posts in this course';
 3886:             } elsif ($activity eq 'blogs') {
 3887:                 $category = 'Blogs';
 3888:             } elsif ($activity eq 'port') {
 3889:                 if (defined($uname) && defined($udom)) {
 3890:                     if ($uname eq $env{'user.name'} &&
 3891:                         $udom eq $env{'user.domain'}) {
 3892:                         $ownitem = 1;
 3893:                     }
 3894:                 }
 3895:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
 3896:                 if ($ownitem) { 
 3897:                     $category = 'Your portfolio files';  
 3898:                 } elsif ($is_course) {
 3899:                     my $coursedesc;
 3900:                     foreach my $course (keys(%setters)) {
 3901:                         my %courseinfo =
 3902:                              &Apache::lonnet::coursedescription($course);
 3903:                         $coursedesc = $courseinfo{'description'};
 3904:                     }
 3905:                     $category = "Group portfolio in the course '$coursedesc'";
 3906:                 } else {
 3907:                     $category = 'Portfolio files belonging to ';
 3908:                     if ($env{'user.name'} eq 'public' && 
 3909:                         $env{'user.domain'} eq 'public') {
 3910:                         $category .= &plainname($uname,$udom);
 3911:                     } else {
 3912:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
 3913:                     }
 3914:                 }
 3915:             } elsif ($activity eq 'groups') {
 3916:                 $category = 'Groups in this course';
 3917:             }
 3918:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
 3919:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
 3920:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
 3921:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
 3922:                 $output .= &build_block_table($startblock,$endblock,\%setters);
 3923:             }
 3924:         }
 3925:     }
 3926:     if (wantarray) {
 3927:         return ($blocked,$output);
 3928:     } else {
 3929:         return $blocked;
 3930:     }
 3931: }
 3932: 
 3933: ###############################################
 3934: 
 3935: sub check_ip_acc {
 3936:     my ($acc)=@_;
 3937:     &Apache::lonxml::debug("acc is $acc");
 3938:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
 3939:         return 1;
 3940:     }
 3941:     my $allowed=0;
 3942:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
 3943: 
 3944:     my $name;
 3945:     foreach my $pattern (split(',',$acc)) {
 3946:         $pattern =~ s/^\s*//;
 3947:         $pattern =~ s/\s*$//;
 3948:         if ($pattern =~ /\*$/) {
 3949:             #35.8.*
 3950:             $pattern=~s/\*//;
 3951:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
 3952:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
 3953:             #35.8.3.[34-56]
 3954:             my $low=$2;
 3955:             my $high=$3;
 3956:             $pattern=$1;
 3957:             if ($ip =~ /^\Q$pattern\E/) {
 3958:                 my $last=(split(/\./,$ip))[3];
 3959:                 if ($last <=$high && $last >=$low) { $allowed=1; }
 3960:             }
 3961:         } elsif ($pattern =~ /^\*/) {
 3962:             #*.msu.edu
 3963:             $pattern=~s/\*//;
 3964:             if (!defined($name)) {
 3965:                 use Socket;
 3966:                 my $netaddr=inet_aton($ip);
 3967:                 ($name)=gethostbyaddr($netaddr,AF_INET);
 3968:             }
 3969:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
 3970:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
 3971:             #127.0.0.1
 3972:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
 3973:         } else {
 3974:             #some.name.com
 3975:             if (!defined($name)) {
 3976:                 use Socket;
 3977:                 my $netaddr=inet_aton($ip);
 3978:                 ($name)=gethostbyaddr($netaddr,AF_INET);
 3979:             }
 3980:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
 3981:         }
 3982:         if ($allowed) { last; }
 3983:     }
 3984:     return $allowed;
 3985: }
 3986: 
 3987: ###############################################
 3988: 
 3989: =pod
 3990: 
 3991: =head1 Domain Template Functions
 3992: 
 3993: =over 4
 3994: 
 3995: =item * &determinedomain()
 3996: 
 3997: Inputs: $domain (usually will be undef)
 3998: 
 3999: Returns: Determines which domain should be used for designs
 4000: 
 4001: =cut
 4002: 
 4003: ###############################################
 4004: sub determinedomain {
 4005:     my $domain=shift;
 4006:     if (! $domain) {
 4007:         # Determine domain if we have not been given one
 4008:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
 4009:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
 4010:         if ($env{'request.role.domain'}) { 
 4011:             $domain=$env{'request.role.domain'}; 
 4012:         }
 4013:     }
 4014:     return $domain;
 4015: }
 4016: ###############################################
 4017: 
 4018: sub devalidate_domconfig_cache {
 4019:     my ($udom)=@_;
 4020:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
 4021: }
 4022: 
 4023: # ---------------------- Get domain configuration for a domain
 4024: sub get_domainconf {
 4025:     my ($udom) = @_;
 4026:     my $cachetime=1800;
 4027:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
 4028:     if (defined($cached)) { return %{$result}; }
 4029: 
 4030:     my %domconfig = &Apache::lonnet::get_dom('configuration',
 4031: 					     ['login','rolecolors'],$udom);
 4032:     my (%designhash,%legacy);
 4033:     if (keys(%domconfig) > 0) {
 4034:         if (ref($domconfig{'login'}) eq 'HASH') {
 4035:             if (keys(%{$domconfig{'login'}})) {
 4036:                 foreach my $key (keys(%{$domconfig{'login'}})) {
 4037:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
 4038:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
 4039:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
 4040:                                 $domconfig{'login'}{$key}{$img};
 4041:                         }
 4042:                     } else {
 4043:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
 4044:                     }
 4045:                 }
 4046:             } else {
 4047:                 $legacy{'login'} = 1;
 4048:             }
 4049:         } else {
 4050:             $legacy{'login'} = 1;
 4051:         }
 4052:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
 4053:             if (keys(%{$domconfig{'rolecolors'}})) {
 4054:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
 4055:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
 4056:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
 4057:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
 4058:                         }
 4059:                     }
 4060:                 }
 4061:             } else {
 4062:                 $legacy{'rolecolors'} = 1;
 4063:             }
 4064:         } else {
 4065:             $legacy{'rolecolors'} = 1;
 4066:         }
 4067:         if (keys(%legacy) > 0) {
 4068:             my %legacyhash = &get_legacy_domconf($udom);
 4069:             foreach my $item (keys(%legacyhash)) {
 4070:                 if ($item =~ /^\Q$udom\E\.login/) {
 4071:                     if ($legacy{'login'}) { 
 4072:                         $designhash{$item} = $legacyhash{$item};
 4073:                     }
 4074:                 } else {
 4075:                     if ($legacy{'rolecolors'}) {
 4076:                         $designhash{$item} = $legacyhash{$item};
 4077:                     }
 4078:                 }
 4079:             }
 4080:         }
 4081:     } else {
 4082:         %designhash = &get_legacy_domconf($udom); 
 4083:     }
 4084:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
 4085: 				  $cachetime);
 4086:     return %designhash;
 4087: }
 4088: 
 4089: sub get_legacy_domconf {
 4090:     my ($udom) = @_;
 4091:     my %legacyhash;
 4092:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
 4093:     my $designfile =  $designdir.'/'.$udom.'.tab';
 4094:     if (-e $designfile) {
 4095:         if ( open (my $fh,"<$designfile") ) {
 4096:             while (my $line = <$fh>) {
 4097:                 next if ($line =~ /^\#/);
 4098:                 chomp($line);
 4099:                 my ($key,$val)=(split(/\=/,$line));
 4100:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
 4101:             }
 4102:             close($fh);
 4103:         }
 4104:     }
 4105:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
 4106:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
 4107:     }
 4108:     return %legacyhash;
 4109: }
 4110: 
 4111: =pod
 4112: 
 4113: =item * &domainlogo()
 4114: 
 4115: Inputs: $domain (usually will be undef)
 4116: 
 4117: Returns: A link to a domain logo, if the domain logo exists.
 4118: If the domain logo does not exist, a description of the domain.
 4119: 
 4120: =cut
 4121: 
 4122: ###############################################
 4123: sub domainlogo {
 4124:     my $domain = &determinedomain(shift);
 4125:     my %designhash = &get_domainconf($domain);    
 4126:     # See if there is a logo
 4127:     if ($designhash{$domain.'.login.domlogo'} ne '') {
 4128:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
 4129:         if ($imgsrc =~ m{^/(adm|res)/}) {
 4130: 	    if ($imgsrc =~ m{^/res/}) {
 4131: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
 4132: 		&Apache::lonnet::repcopy($local_name);
 4133: 	    }
 4134: 	   $imgsrc = &lonhttpdurl($imgsrc);
 4135:         } 
 4136:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
 4137:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
 4138:         return &Apache::lonnet::domain($domain,'description');
 4139:     } else {
 4140:         return '';
 4141:     }
 4142: }
 4143: ##############################################
 4144: 
 4145: =pod
 4146: 
 4147: =item * &designparm()
 4148: 
 4149: Inputs: $which parameter; $domain (usually will be undef)
 4150: 
 4151: Returns: value of designparamter $which
 4152: 
 4153: =cut
 4154: 
 4155: 
 4156: ##############################################
 4157: sub designparm {
 4158:     my ($which,$domain)=@_;
 4159:     if (exists($env{'environment.color.'.$which})) {
 4160:         return $env{'environment.color.'.$which};
 4161:     }
 4162:     $domain=&determinedomain($domain);
 4163:     my %domdesign = &get_domainconf($domain);
 4164:     my $output;
 4165:     if ($domdesign{$domain.'.'.$which} ne '') {
 4166:         $output = $domdesign{$domain.'.'.$which};
 4167:     } else {
 4168:         $output = $defaultdesign{$which};
 4169:     }
 4170:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
 4171:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
 4172:         if ($output =~ m{^/(adm|res)/}) {
 4173:             if ($output =~ m{^/res/}) {
 4174:                 my $local_name = &Apache::lonnet::filelocation('',$output);
 4175:                 &Apache::lonnet::repcopy($local_name);
 4176:             }
 4177:             $output = &lonhttpdurl($output);
 4178:         }
 4179:     }
 4180:     return $output;
 4181: }
 4182: 
 4183: ##############################################
 4184: =pod
 4185: 
 4186: =item * &head_subbox()
 4187: 
 4188: Inputs: $content (contains HTML code with page functions, etc.)
 4189: 
 4190: Returns: HTML div with $content
 4191:          To be included in page header
 4192: 
 4193: =cut
 4194: 
 4195: sub head_subbox {
 4196:     my ($content)=@_;
 4197:     my $output =
 4198:         '<div id="LC_head_subbox2">' #FIXME: solve conflicts with lonhtmlcommon:breadcrumbs LC_head_subbox
 4199:        .$content
 4200:        .'</div>'
 4201: }
 4202: 
 4203: ##############################################
 4204: =pod
 4205: 
 4206: =item * &CSTR_pageheader()
 4207: 
 4208: Inputs: ./.
 4209: 
 4210: Returns: HTML div with CSTR path and recent box
 4211:          To be included on Construction Space pages
 4212: 
 4213: =cut
 4214: 
 4215: sub CSTR_pageheader {
 4216:     # this is for resources; directories have customtitle, and crumbs
 4217:             # and select recent are created in lonpubdir.pm  
 4218:     my ($uname,$thisdisfn)=
 4219:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
 4220:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
 4221:     $formaction=~s/\/+/\//g;
 4222: 
 4223:     my $parentpath = '';
 4224:     my $lastitem = '';
 4225:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
 4226:         $parentpath = $1;
 4227:         $lastitem = $2;
 4228:     } else {
 4229:         $lastitem = $thisdisfn;
 4230:     }
 4231:     return
 4232:          '<div>'
 4233:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
 4234:         .'<b>'.&mt('Construction Space:').'</b> '
 4235:         .'<form name="dirs" method="post" action="'.$formaction
 4236:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
 4237:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
 4238:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
 4239:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
 4240:         .'</form>'
 4241:         .&Apache::lonmenu::constspaceform()
 4242:         .'</div>';
 4243: }
 4244: 
 4245: ###############################################
 4246: ###############################################
 4247: 
 4248: =pod
 4249: 
 4250: =back
 4251: 
 4252: =head1 HTML Helpers
 4253: 
 4254: =over 4
 4255: 
 4256: =item * &bodytag()
 4257: 
 4258: Returns a uniform header for LON-CAPA web pages.
 4259: 
 4260: Inputs: 
 4261: 
 4262: =over 4
 4263: 
 4264: =item * $title, A title to be displayed on the page.
 4265: 
 4266: =item * $function, the current role (can be undef).
 4267: 
 4268: =item * $addentries, extra parameters for the <body> tag.
 4269: 
 4270: =item * $bodyonly, if defined, only return the <body> tag.
 4271: 
 4272: =item * $domain, if defined, force a given domain.
 4273: 
 4274: =item * $forcereg, if page should register as content page (relevant for 
 4275:             text interface only)
 4276: 
 4277: =item * $customtitle, alternate text to use instead of $title
 4278:                       in the title box that appears, this text
 4279:                       is not auto translated like the $title is
 4280: 
 4281: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
 4282:                      navigational links
 4283: 
 4284: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
 4285: 
 4286: =item * $no_inline_link, if true and in remote mode, don't show the 
 4287:          'Switch To Inline Menu' link
 4288: 
 4289: =item * $args, optional argument valid values are
 4290:             no_auto_mt_title -> prevents &mt()ing the title arg
 4291:             inherit_jsmath -> when creating popup window in a page,
 4292:                               should it have jsmath forced on by the
 4293:                               current page
 4294: 
 4295: =back
 4296: 
 4297: Returns: A uniform header for LON-CAPA web pages.  
 4298: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
 4299: If $bodyonly is undef or zero, an html string containing a <body> tag and 
 4300: other decorations will be returned.
 4301: 
 4302: =cut
 4303: 
 4304: sub bodytag {
 4305:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
 4306:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
 4307: 
 4308:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
 4309: 
 4310:     $function = &get_users_function() if (!$function);
 4311:     my $img =    &designparm($function.'.img',$domain);
 4312:     my $font =   &designparm($function.'.font',$domain);
 4313:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
 4314: 
 4315:     my %design = ( 'style'   => 'margin-top: 0',
 4316: 		   'bgcolor' => $pgbg,
 4317: 		   'text'    => $font,
 4318:                    'alink'   => &designparm($function.'.alink',$domain),
 4319: 		   'vlink'   => &designparm($function.'.vlink',$domain),
 4320: 		   'link'    => &designparm($function.'.link',$domain),);
 4321:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
 4322: 
 4323:  # role and realm
 4324:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
 4325:     if ($role  eq 'ca') {
 4326:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
 4327:         $realm = &plainname($rname,$rdom);
 4328:     } 
 4329: # realm
 4330:     if ($env{'request.course.id'}) {
 4331:         if ($env{'request.role'} !~ /^cr/) {
 4332:             $role = &Apache::lonnet::plaintext($role,&course_type());
 4333:         }
 4334: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
 4335:     } else {
 4336:         $role = &Apache::lonnet::plaintext($role);
 4337:     }
 4338: 
 4339:     if (!$realm) { $realm='&nbsp;'; }
 4340: # Set messages
 4341:     my $messages=&domainlogo($domain);
 4342: 
 4343:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
 4344: 
 4345: # construct main body tag
 4346:     my $bodytag = "<body $extra_body_attr>".
 4347: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
 4348: 
 4349:     if ($bodyonly) {
 4350:         return $bodytag;
 4351:     } 
 4352: 
 4353:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
 4354:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
 4355: 	undef($role);
 4356:     } else {
 4357: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
 4358:     }
 4359:     
 4360:     my $roleinfo=(<<ENDROLE);
 4361: <td class="LC_title_bar_who">
 4362: <div class="LC_title_bar_name">
 4363:     $name
 4364:     &nbsp;
 4365: </div>
 4366: <div class="LC_title_bar_role">
 4367: $role&nbsp;
 4368: </div>
 4369: <div class="LC_title_bar_realm">
 4370: $realm&nbsp;
 4371: </div>
 4372: </td>
 4373: ENDROLE
 4374: 
 4375:     my $titleinfo = '<h1>'.$title.'</h1>';
 4376:     if ($customtitle) {
 4377:         $titleinfo = $customtitle;
 4378:     }
 4379:     #
 4380:     # Extra info if you are the DC
 4381:     my $dc_info = '';
 4382:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
 4383:                         $env{'course.'.$env{'request.course.id'}.
 4384:                                  '.domain'}.'/'})) {
 4385:         my $cid = $env{'request.course.id'};
 4386:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
 4387:         $dc_info =~ s/\s+$//;
 4388:         $dc_info = '('.$dc_info.')';
 4389:     }
 4390: 
 4391:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
 4392:         # No Remote
 4393: 	if ($env{'request.state'} eq 'construct') {
 4394: 	    $forcereg=1;
 4395: 	}
 4396: 
 4397:     if (!$customtitle && $env{'request.state'} eq 'construct') {
 4398:         $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
 4399:     }
 4400: 
 4401:         my $titletable = '<table id="LC_title_bar">'
 4402:                         ."<tr><td> $titleinfo $dc_info</td>".$roleinfo
 4403:                         .'</tr></table>';
 4404: 
 4405: 	if ($no_nav_bar) {
 4406: 	    $bodytag .= $titletable;
 4407: 	} else {
 4408:         $bodytag .= qq|<div id="LC_nav_bar">$name ($role)<br />
 4409:             <em>$realm</em> $dc_info</div>|;
 4410: 	    if ($env{'request.state'} eq 'construct') {
 4411:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
 4412: 							  $titletable);
 4413:             } else {
 4414:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
 4415: 		    $titletable;
 4416:             }
 4417:         }
 4418:         return $bodytag;
 4419:     }
 4420: 
 4421: #
 4422: # Top frame rendering, Remote is up
 4423: #
 4424: 
 4425:     my $imgsrc = $img;
 4426:     if ($img =~ /^\/adm/) {
 4427:         $imgsrc = &lonhttpdurl($img);
 4428:     }
 4429:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
 4430: 
 4431:     # Explicit link to get inline menu
 4432:     my $menu= ($no_inline_link?''
 4433: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
 4434:     #
 4435:     return(<<ENDBODY);
 4436: $bodytag
 4437: <table id="LC_title_bar" class="LC_with_remote">
 4438: <tr><td>$upperleft</td>
 4439:     <td>$messages&nbsp;</td>
 4440: </tr>
 4441: <tr><td>$titleinfo $dc_info $menu</td>
 4442: $roleinfo
 4443: </tr>
 4444: </table>
 4445: ENDBODY
 4446: }
 4447: 
 4448: sub make_attr_string {
 4449:     my ($register,$attr_ref) = @_;
 4450: 
 4451:     if ($attr_ref && !ref($attr_ref)) {
 4452: 	die("addentries Must be a hash ref ".
 4453: 	    join(':',caller(1))." ".
 4454: 	    join(':',caller(0))." ");
 4455:     }
 4456: 
 4457:     if ($register) {
 4458: 	my ($on_load,$on_unload);
 4459: 	foreach my $key (keys(%{$attr_ref})) {
 4460: 	    if      (lc($key) eq 'onload') {
 4461: 		$on_load.=$attr_ref->{$key}.';';
 4462: 		delete($attr_ref->{$key});
 4463: 
 4464: 	    } elsif (lc($key) eq 'onunload') {
 4465: 		$on_unload.=$attr_ref->{$key}.';';
 4466: 		delete($attr_ref->{$key});
 4467: 	    }
 4468: 	}
 4469: 	$attr_ref->{'onload'}  =
 4470: 	    &Apache::lonmenu::loadevents().  $on_load;
 4471: 	$attr_ref->{'onunload'}=
 4472: 	    &Apache::lonmenu::unloadevents().$on_unload;
 4473:     }
 4474: 
 4475: # Accessibility font enhance
 4476:     if ($env{'browser.fontenhance'} eq 'on') {
 4477: 	my $style;
 4478: 	foreach my $key (keys(%{$attr_ref})) {
 4479: 	    if (lc($key) eq 'style') {
 4480: 		$style.=$attr_ref->{$key}.';';
 4481: 		delete($attr_ref->{$key});
 4482: 	    }
 4483: 	}
 4484: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
 4485:     }
 4486: 
 4487:     my $attr_string;
 4488:     foreach my $attr (keys(%$attr_ref)) {
 4489: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
 4490:     }
 4491:     return $attr_string;
 4492: }
 4493: 
 4494: 
 4495: ###############################################
 4496: ###############################################
 4497: 
 4498: =pod
 4499: 
 4500: =item * &endbodytag()
 4501: 
 4502: Returns a uniform footer for LON-CAPA web pages.
 4503: 
 4504: Inputs: 1 - optional reference to an args hash
 4505: If in the hash, key for noredirectlink has a value which evaluates to true,
 4506: a 'Continue' link is not displayed if the page contains an
 4507: internal redirect in the <head></head> section,
 4508: i.e., $env{'internal.head.redirect'} exists   
 4509: 
 4510: =cut
 4511: 
 4512: sub endbodytag {
 4513:     my ($args) = @_;
 4514:     my $endbodytag='</body>';
 4515:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
 4516:     if ( exists( $env{'internal.head.redirect'} ) ) {
 4517:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
 4518: 	    $endbodytag=
 4519: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
 4520: 	        &mt('Continue').'</a>'.
 4521: 	        $endbodytag;
 4522:         }
 4523:     }
 4524:     return $endbodytag;
 4525: }
 4526: 
 4527: =pod
 4528: 
 4529: =item * &standard_css()
 4530: 
 4531: Returns a style sheet
 4532: 
 4533: Inputs: (all optional)
 4534:             domain         -> force to color decorate a page for a specific
 4535:                                domain
 4536:             function       -> force usage of a specific rolish color scheme
 4537:             bgcolor        -> override the default page bgcolor
 4538: 
 4539: =cut
 4540: 
 4541: sub standard_css {
 4542:     my ($function,$domain,$bgcolor) = @_;
 4543:     $function  = &get_users_function() if (!$function);
 4544:     my $img    = &designparm($function.'.img',   $domain);
 4545:     my $tabbg  = &designparm($function.'.tabbg', $domain);
 4546:     my $font   = &designparm($function.'.font',  $domain);
 4547:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
 4548: #second colour for later usage
 4549:     my $sidebg = &designparm($function.'.sidebg',$domain);
 4550:     my $pgbg_or_bgcolor =
 4551: 	         $bgcolor ||
 4552: 	         &designparm($function.'.pgbg',  $domain);
 4553:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
 4554:     my $alink  = &designparm($function.'.alink', $domain);
 4555:     my $vlink  = &designparm($function.'.vlink', $domain);
 4556:     my $link   = &designparm($function.'.link',  $domain);
 4557: 
 4558:     my $loginbg = &designparm('login.sidebg',$domain);
 4559:     my $bgcol = &designparm('login.bgcol',$domain);
 4560:     my $textcol = &designparm('login.textcol',$domain);
 4561: 
 4562:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
 4563:     my $mono                 = 'monospace';
 4564:     my $data_table_head      = $tabbg;
 4565:     my $data_table_light     = '#EEEEEE';
 4566:     my $data_table_dark      = '#DDDDDD';
 4567:     my $data_table_darker    = '#CCCCCC';
 4568:     my $data_table_highlight = '#FFFF00';
 4569:     my $mail_new             = '#FFBB77';
 4570:     my $mail_new_hover       = '#DD9955';
 4571:     my $mail_read            = '#BBBB77';
 4572:     my $mail_read_hover      = '#999944';
 4573:     my $mail_replied         = '#AAAA88';
 4574:     my $mail_replied_hover   = '#888855';
 4575:     my $mail_other           = '#99BBBB';
 4576:     my $mail_other_hover     = '#669999';
 4577:     my $table_header         = '#DDDDDD';
 4578:     my $feedback_link_bg     = '#BBBBBB';
 4579:     my $lg_border_color	     = '#C8C8C8';
 4580: 
 4581:     my $border = ($env{'browser.type'} eq 'explorer' ||
 4582: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
 4583: 	                                                 : '0 3px 0 4px';
 4584: 
 4585: 
 4586:     return <<END;
 4587: body {
 4588:    font-family: $sans;
 4589:    line-height:130%;
 4590:    font-size:0.83em;
 4591:    color:$font;
 4592: }
 4593: 
 4594: a:link, a:visited { 
 4595:   font-size:100%; 
 4596: }
 4597: 
 4598: a:focus { 
 4599:   color: red;
 4600:   background: yellow 
 4601: }
 4602: 
 4603: form, .inline { 
 4604:    display: inline; 
 4605: }
 4606: 
 4607: .LC_right {
 4608:    text-align:right;
 4609: }
 4610: 
 4611: .LC_middle {
 4612:    vertical-align:middle;
 4613: }
 4614: 
 4615: /* just for tests */
 4616: .LC_400Box {width:400px; }
 4617: /* end */
 4618: 
 4619: .LC_filename {
 4620:   font-family: $mono;
 4621:   white-space:pre;
 4622: }
 4623: 
 4624: .LC_fileicon {
 4625:   border: none;
 4626:   height: 1.3em;
 4627:   vertical-align: text-bottom;
 4628:   margin-right: 0.3em;
 4629:   text-decoration:none;
 4630: }
 4631: 
 4632: .LC_error {
 4633:   color: red;
 4634:   font-size: larger;
 4635: }
 4636: 
 4637: .LC_warning,
 4638: .LC_diff_removed {
 4639:   color: red;
 4640: }
 4641: 
 4642: .LC_info,
 4643: .LC_success,
 4644: .LC_diff_added {
 4645:   color: green;
 4646: }
 4647: 
 4648: div.LC_confirm_box {
 4649:   background-color: #FAFAFA;
 4650:   border: 1px solid $lg_border_color;
 4651:   margin-right: 0;
 4652:   padding: 5px;
 4653: }
 4654: 
 4655: div.LC_confirm_box .LC_error img,
 4656: div.LC_confirm_box .LC_success img {
 4657:   vertical-align: middle;
 4658: }
 4659: 
 4660: .LC_icon {
 4661:   border: none;
 4662:   vertical-align: middle;
 4663: }
 4664: 
 4665: .LC_docs_spacer {
 4666:   width: 25px;
 4667:   height: 1px;
 4668:   border: none;
 4669: }
 4670: 
 4671: .LC_internal_info {
 4672:   color: #999999;
 4673: }
 4674: 
 4675: .LC_discussion {
 4676:    background: $tabbg;
 4677:    border: 1px solid black;
 4678:    margin: 2px;
 4679: }
 4680: 
 4681: .LC_disc_action_links_bar {
 4682:    background: $tabbg;
 4683:    font-family: $sans;
 4684:    border: none;
 4685:    margin: 4px;
 4686: }
 4687: 
 4688: .LC_disc_action_left {
 4689:    text-align: left;
 4690: }
 4691: 
 4692: .LC_disc_action_right {
 4693:    text-align: right;
 4694: }
 4695: 
 4696: .LC_disc_new_item {
 4697:    background: white;
 4698:    border: 2px solid red;
 4699:    margin: 2px;
 4700: }
 4701: 
 4702: .LC_disc_old_item {
 4703:    background: white;
 4704:    border: 1px solid black;
 4705:    margin: 2px;
 4706: }
 4707: 
 4708: table.LC_pastsubmission {
 4709:   border: 1px solid black;
 4710:   margin: 2px;
 4711: }
 4712: 
 4713: table#LC_top_nav,
 4714: table#LC_menubuttons,
 4715: table#LC_nav_location {
 4716:   width: 100%;
 4717:   background: $pgbg;
 4718:   border: 2px;
 4719:   border-collapse: separate;
 4720:   padding: 0;
 4721: }
 4722: 
 4723: table#LC_title_bar a {
 4724:   color: $fontmenu;
 4725: }
 4726:     
 4727: table#LC_title_bar {
 4728:   clear: both;
 4729:   /*display: none;*/
 4730: }
 4731: 
 4732: table#LC_title_bar,
 4733: table.LC_breadcrumbs,
 4734: table#LC_title_bar.LC_with_remote {
 4735:   width: 100%;
 4736:   border-color: $pgbg;
 4737:   border-style: solid;
 4738:   border-width: $border;
 4739:   background: $pgbg;
 4740:   color: $fontmenu;
 4741:   font-family: $sans;
 4742:   border-collapse: collapse;
 4743:   padding: 0;
 4744:   margin: 0;
 4745: }
 4746: 
 4747: table.LC_docs_path {
 4748:   width: 100%;
 4749:   border: 0;
 4750:   background: $pgbg;
 4751:   font-family: $sans;
 4752:   border-collapse: collapse;
 4753:   padding: 0;
 4754: }
 4755: 
 4756: table#LC_title_bar td {
 4757:   background: $tabbg;
 4758: }
 4759: 
 4760: table#LC_title_bar .LC_title_bar_who {
 4761:   background: $tabbg;
 4762:   color: $fontmenu;
 4763:   font: small $sans;
 4764:   text-align: right;
 4765:   margin: 0;
 4766: }
 4767: 
 4768: table#LC_title_bar div.LC_title_bar_name {
 4769:   margin: 0;
 4770: }
 4771: 
 4772: table#LC_title_bar div.LC_title_bar_role {
 4773:   margin: 0;
 4774: }
 4775: 
 4776: table#LC_title_bar div.LC_title_bar_realm {
 4777:   margin: 0;
 4778: }
 4779: 
 4780: span.LC_metadata {
 4781:   font-family: $sans;
 4782: }
 4783: 
 4784: table#LC_menubuttons img{
 4785:   border: none;
 4786: }
 4787: 
 4788: table#LC_top_nav td {
 4789:   background: $tabbg;
 4790:   border: none;
 4791:   font-size: small;
 4792:   vertical-align:top;
 4793:   padding:2px 5px 2px 5px;
 4794: }
 4795: 
 4796: table#LC_top_nav td a,
 4797: div#LC_top_nav a {
 4798:   color: $font;
 4799:   font-family: $sans;
 4800: }
 4801: 
 4802: table#LC_top_nav td.LC_top_nav_logo {
 4803:   background: $tabbg;
 4804:   text-align: left;
 4805:   white-space: nowrap;
 4806:   width: 31px;
 4807: }
 4808: 
 4809: table#LC_top_nav td.LC_top_nav_logo img {
 4810:   border: none;
 4811:   vertical-align: bottom;
 4812: }
 4813: 
 4814: table#LC_top_nav td.LC_top_nav_exit,
 4815: table#LC_top_nav td.LC_top_nav_help {
 4816:   width: 2.0em;
 4817: }
 4818: 
 4819: table#LC_top_nav td.LC_top_nav_login {
 4820:   width: 4.0em;
 4821:   text-align: center;
 4822: }
 4823: 
 4824: table.LC_breadcrumbs td,
 4825: table.LC_docs_path td  {
 4826:   background: $tabbg;
 4827:   color: $fontmenu;
 4828:   font-family: $sans;
 4829:   font-size: smaller;
 4830: }
 4831: 
 4832: table.LC_breadcrumbs td.LC_breadcrumbs_component,
 4833: table.LC_docs_path td.LC_docs_path_component {
 4834:   background: $tabbg;
 4835:   color: $fontmenu;
 4836:   font-family: $sans;
 4837:   font-size: larger;
 4838:   text-align: right;
 4839: }
 4840: 
 4841: td.LC_table_cell_checkbox {
 4842:   text-align: center;
 4843: }
 4844: 
 4845: table#LC_mainmenu td.LC_mainmenu_column {
 4846:     vertical-align: top;
 4847: }
 4848: 
 4849: .LC_fontsize_small {
 4850:  font-size: 70%;
 4851: }
 4852: 
 4853: #LC_head_subbox {
 4854:  clear:both;
 4855:  background: $sidebg;
 4856:  border-bottom: 1px solid $lg_border_color;
 4857:  height: 32px;
 4858:  line-height: 32px; 
 4859:  margin: 0;
 4860:  padding: 0;
 4861: }
 4862: 
 4863: #LC_head_subbox2 { /* FIXME: replace by LC_head_subbox once lonhtmlcommon::breadcrumbs has been fixed */
 4864:  clear:both;
 4865:  background: #F8F8F8; /* $sidebg; */
 4866:  border-bottom: 1px solid $lg_border_color;
 4867:  margin: 0 0 10px 0;
 4868:  padding: 5px;
 4869: }
 4870: 
 4871: .LC_fontsize_medium {
 4872:  font-size: 85%;
 4873: }
 4874: 
 4875: .LC_fontsize_large {
 4876:  font-size: 120%;
 4877: }
 4878: 
 4879: .LC_menubuttons_inline_text {
 4880:   color: $font;
 4881:   font-family: $sans;
 4882:   font-size: 90%;
 4883:   padding-left:3px;
 4884: }
 4885: 
 4886: .LC_menubuttons_link {
 4887:   text-decoration: none;
 4888: }
 4889: 
 4890: .LC_menubuttons_category {
 4891:   color: $font;
 4892:   background: $pgbg;
 4893:   font-family: $sans;
 4894:   font-size: larger;
 4895:   font-weight: bold;
 4896: }
 4897: 
 4898: td.LC_menubuttons_text {
 4899:  	color: $font;
 4900: }
 4901: 
 4902: .LC_current_location {
 4903:   font-family: $sans;
 4904:   background: $tabbg;
 4905: }
 4906: 
 4907: .LC_new_mail {
 4908:   font-family: $sans;
 4909:   background: $tabbg;
 4910:   font-weight: bold;
 4911: }
 4912: 
 4913: .LC_preferences_labeltext {
 4914:   font-family: $sans;
 4915:   text-align: right;
 4916: }
 4917: 
 4918: .LC_roleslog_note {
 4919:   font-size: small;
 4920: }
 4921: 
 4922: .LC_mail_functions {
 4923:     font-weight: bold;
 4924: }
 4925: 
 4926: table.LC_data_table,
 4927: table.LC_mail_list {
 4928:   border: 1px solid #000000;
 4929:   border-collapse: separate;
 4930:   border-spacing: 1px;
 4931:   background: $pgbg;
 4932: }
 4933: 
 4934: .LC_data_table_dense {
 4935:   font-size: small;
 4936: }
 4937: 
 4938: table.LC_nested_outer {
 4939:   border: 1px solid #000000;
 4940:   border-collapse: collapse;
 4941:   border-spacing: 0;
 4942:   width: 100%;
 4943: }
 4944: 
 4945: table.LC_nested {
 4946:   border: none;
 4947:   border-collapse: collapse;
 4948:   border-spacing: 0;
 4949:   width: 100%;
 4950: }
 4951: 
 4952: table.LC_data_table tr th, 
 4953: table.LC_calendar tr th, 
 4954: table.LC_mail_list tr th,
 4955: table.LC_prior_tries tr th {
 4956:   font-weight: bold;
 4957:   background-color: $data_table_head;
 4958:   color:$fontmenu;
 4959:   font-size:90%;
 4960: }
 4961: 
 4962: table.LC_data_table tr.LC_info_row > td {
 4963:   background-color: #CCCCCC;
 4964:   font-weight: bold;
 4965:   text-align: left;
 4966: }
 4967: 
 4968: table.LC_data_table tr.LC_odd_row > td,
 4969: table.LC_pick_box tr > td.LC_odd_row {
 4970:   background-color: $data_table_light;
 4971:   padding: 2px;
 4972: }
 4973: 
 4974: table.LC_data_table tr.LC_even_row > td,
 4975: table.LC_pick_box tr > td.LC_even_row {
 4976:   background-color: $data_table_dark;
 4977:   padding: 2px;
 4978: }
 4979: 
 4980: table.LC_data_table tr.LC_data_table_highlight td {
 4981:   background-color: $data_table_darker;
 4982: }
 4983: 
 4984: table.LC_data_table tr td.LC_leftcol_header {
 4985:   background-color: $data_table_head;
 4986:   font-weight: bold;
 4987: }
 4988: 
 4989: table.LC_data_table tr.LC_empty_row td,
 4990: table.LC_nested tr.LC_empty_row td {
 4991:   background-color: #FFFFFF;
 4992:   font-weight: bold;
 4993:   font-style: italic;
 4994:   text-align: center;
 4995:   padding: 8px;
 4996: }
 4997: 
 4998: table.LC_nested tr.LC_empty_row td {
 4999:   padding: 4ex
 5000: }
 5001: 
 5002: table.LC_nested_outer tr th {
 5003:   font-weight: bold;
 5004:   color:$fontmenu;
 5005:   background-color: $data_table_head;
 5006:   font-size: small;
 5007:   border-bottom: 1px solid #000000;
 5008: }
 5009: 
 5010: table.LC_nested_outer tr td.LC_subheader {
 5011:   background-color: $data_table_head;
 5012:   font-weight: bold;
 5013:   font-size: small;
 5014:   border-bottom: 1px solid #000000;
 5015:   text-align: right;
 5016: }
 5017: 
 5018: table.LC_nested tr.LC_info_row td {
 5019:   background-color: #CCCCCC;
 5020:   font-weight: bold;
 5021:   font-size: small;
 5022:   text-align: center;
 5023: }
 5024: 
 5025: table.LC_nested tr.LC_info_row td.LC_left_item,
 5026: table.LC_nested_outer tr th.LC_left_item {
 5027:   text-align: left;
 5028: }
 5029: 
 5030: table.LC_nested td {
 5031:   background-color: #FFFFFF;
 5032:   font-size: small;
 5033: }
 5034: 
 5035: table.LC_nested_outer tr th.LC_right_item,
 5036: table.LC_nested tr.LC_info_row td.LC_right_item,
 5037: table.LC_nested tr.LC_odd_row td.LC_right_item,
 5038: table.LC_nested tr td.LC_right_item {
 5039:   text-align: right;
 5040: }
 5041: 
 5042: table.LC_nested tr.LC_odd_row td {
 5043:   background-color: #EEEEEE;
 5044: }
 5045: 
 5046: table.LC_createuser {
 5047: }
 5048: 
 5049: table.LC_createuser tr.LC_section_row td {
 5050:   font-size: small;
 5051: }
 5052: 
 5053: table.LC_createuser tr.LC_info_row td  {
 5054:   background-color: #CCCCCC;
 5055:   font-weight: bold;
 5056:   text-align: center;
 5057: }
 5058: 
 5059: table.LC_calendar {
 5060:   border: 1px solid #000000;
 5061:   border-collapse: collapse;
 5062: }
 5063: 
 5064: table.LC_calendar_pickdate {
 5065:   font-size: xx-small;
 5066: }
 5067: 
 5068: table.LC_calendar tr td {
 5069:   border: 1px solid #000000;
 5070:   vertical-align: top;
 5071: }
 5072: 
 5073: table.LC_calendar tr td.LC_calendar_day_empty {
 5074:   background-color: $data_table_dark;
 5075: }
 5076: 
 5077: table.LC_calendar tr td.LC_calendar_day_current {
 5078:   background-color: $data_table_highlight;
 5079: }
 5080: 
 5081: table.LC_mail_list tr.LC_mail_new {
 5082:   background-color: $mail_new;
 5083: }
 5084: 
 5085: table.LC_mail_list tr.LC_mail_new:hover {
 5086:   background-color: $mail_new_hover;
 5087: }
 5088: 
 5089: table.LC_mail_list tr.LC_mail_even {
 5090: }
 5091: 
 5092: table.LC_mail_list tr.LC_mail_odd {
 5093: }
 5094: 
 5095: table.LC_mail_list tr.LC_mail_read {
 5096:   background-color: $mail_read;
 5097: }
 5098: 
 5099: table.LC_mail_list tr.LC_mail_read:hover {
 5100:   background-color: $mail_read_hover;
 5101: }
 5102: 
 5103: table.LC_mail_list tr.LC_mail_replied {
 5104:   background-color: $mail_replied;
 5105: }
 5106: 
 5107: table.LC_mail_list tr.LC_mail_replied:hover {
 5108:   background-color: $mail_replied_hover;
 5109: }
 5110: 
 5111: table.LC_mail_list tr.LC_mail_other {
 5112:   background-color: $mail_other;
 5113: }
 5114: 
 5115: table.LC_mail_list tr.LC_mail_other:hover {
 5116:   background-color: $mail_other_hover;
 5117: }
 5118: 
 5119: table.LC_data_table tr > td.LC_browser_file,
 5120: table.LC_data_table tr > td.LC_browser_file_published {
 5121:   background: #CCFF88;
 5122: }
 5123: 
 5124: table.LC_data_table tr > td.LC_browser_file_locked,
 5125: table.LC_data_table tr > td.LC_browser_file_unpublished {
 5126:   background: #FFAA99;
 5127: }
 5128: 
 5129: table.LC_data_table tr > td.LC_browser_file_obsolete {
 5130:   background: #AAAAAA;
 5131: }
 5132: 
 5133: table.LC_data_table tr > td.LC_browser_file_modified,
 5134: table.LC_data_table tr > td.LC_browser_file_metamodified {
 5135:   background: #FFFF77;
 5136: }
 5137: 
 5138: table.LC_data_table tr.LC_browser_folder > td {
 5139:   background: #CCCCFF;
 5140: }
 5141: 
 5142: table.LC_data_table tr > td.LC_roles_is {
 5143: /*  background: #77FF77; */
 5144: }
 5145: 
 5146: table.LC_data_table tr > td.LC_roles_future {
 5147:   background: #FFFF77;
 5148: }
 5149: 
 5150: table.LC_data_table tr > td.LC_roles_will {
 5151:   background: #FFAA77;
 5152: }
 5153: 
 5154: table.LC_data_table tr > td.LC_roles_expired {
 5155:   background: #FF7777;
 5156: }
 5157: 
 5158: table.LC_data_table tr > td.LC_roles_will_not {
 5159:   background: #AAFF77;
 5160: }
 5161: 
 5162: table.LC_data_table tr > td.LC_roles_selected {
 5163:   background: #11CC55;
 5164: }
 5165: 
 5166: span.LC_current_location {
 5167:   font-size:larger;
 5168:   background: $pgbg;
 5169: }
 5170: 
 5171: span.LC_parm_menu_item {
 5172:   font-size: larger;
 5173:   font-family: $sans;
 5174: }
 5175: 
 5176: span.LC_parm_scope_all {
 5177:   color: red;
 5178: }
 5179: 
 5180: span.LC_parm_scope_folder {
 5181:   color: green;
 5182: }
 5183: 
 5184: span.LC_parm_scope_resource {
 5185:   color: orange;
 5186: }
 5187: 
 5188: span.LC_parm_part {
 5189:   color: blue;
 5190: }
 5191: 
 5192: span.LC_parm_folder, span.LC_parm_symb {
 5193:   font-size: x-small;
 5194:   font-family: $mono;
 5195:   color: #AAAAAA;
 5196: }
 5197: 
 5198: td.LC_parm_overview_level_menu,
 5199: td.LC_parm_overview_map_menu,
 5200: td.LC_parm_overview_parm_selectors,
 5201: td.LC_parm_overview_restrictions  {
 5202:   border: 1px solid black;
 5203:   border-collapse: collapse;
 5204: }
 5205: 
 5206: table.LC_parm_overview_restrictions td {
 5207:   border-width: 1px 4px 1px 4px;
 5208:   border-style: solid;
 5209:   border-color: $pgbg;
 5210:   text-align: center;
 5211: }
 5212: 
 5213: table.LC_parm_overview_restrictions th {
 5214:   background: $tabbg;
 5215:   border-width: 1px 4px 1px 4px;
 5216:   border-style: solid;
 5217:   border-color: $pgbg;
 5218: }
 5219: 
 5220: table#LC_helpmenu {
 5221:   border: none;
 5222:   height: 55px;
 5223:   border-spacing: 0;
 5224: }
 5225: 
 5226: table#LC_helpmenu fieldset legend {
 5227:   font-size: larger;
 5228:   font-weight: bold;
 5229: }
 5230: 
 5231: table#LC_helpmenu_links {
 5232:   width: 100%;
 5233:   border: 1px solid black;
 5234:   background: $pgbg;
 5235:   padding: 0;
 5236:   border-spacing: 1px;
 5237: }
 5238: 
 5239: table#LC_helpmenu_links tr td {
 5240:   padding: 1px;
 5241:   background: $tabbg;
 5242:   text-align: center;
 5243:   font-weight: bold;
 5244: }
 5245: 
 5246: table#LC_helpmenu_links a:link,
 5247: table#LC_helpmenu_links a:visited,
 5248: table#LC_helpmenu_links a:active {
 5249:   text-decoration: none;
 5250:   color: $font;
 5251: }
 5252: 
 5253: table#LC_helpmenu_links a:hover {
 5254:   text-decoration: underline;
 5255:   color: $vlink;
 5256: }
 5257: 
 5258: .LC_chrt_popup_exists {
 5259:   border: 1px solid #339933;
 5260:   margin: -1px;
 5261: }
 5262: 
 5263: .LC_chrt_popup_up {
 5264:   border: 1px solid yellow;
 5265:   margin: -1px;
 5266: }
 5267: 
 5268: .LC_chrt_popup {
 5269:   border: 1px solid #8888FF;
 5270:   background: #CCCCFF;
 5271: }
 5272: 
 5273: table.LC_pick_box {
 5274:   border-collapse: separate;
 5275:   background: white;
 5276:   border: 1px solid black;
 5277:   border-spacing: 1px;
 5278: }
 5279: 
 5280: table.LC_pick_box td.LC_pick_box_title {
 5281:   background: $tabbg;
 5282:   font-weight: bold;
 5283:   text-align: right;
 5284:   vertical-align: top;
 5285:   width: 184px;
 5286:   padding: 8px;
 5287: }
 5288: 
 5289: table.LC_pick_box td.LC_selfenroll_pick_box_title {
 5290:   background: $tabbg;
 5291:   font-weight: bold;
 5292:   text-align: right;
 5293:   width: 350px;
 5294:   padding: 8px;
 5295: }
 5296: 
 5297: table.LC_pick_box td.LC_pick_box_value {
 5298:   text-align: left;
 5299:   padding: 8px;
 5300: }
 5301: 
 5302: table.LC_pick_box td.LC_pick_box_select {
 5303:   text-align: left;
 5304:   padding: 8px;
 5305: }
 5306: 
 5307: table.LC_pick_box td.LC_pick_box_separator {
 5308:   padding: 0;
 5309:   height: 1px;
 5310:   background: black;
 5311: }
 5312: 
 5313: table.LC_pick_box td.LC_pick_box_submit {
 5314:   text-align: right;
 5315: }
 5316: 
 5317: table.LC_pick_box td.LC_evenrow_value {
 5318:   text-align: left;
 5319:   padding: 8px;
 5320:   background-color: $data_table_light;
 5321: }
 5322: 
 5323: table.LC_pick_box td.LC_oddrow_value {
 5324:   text-align: left;
 5325:   padding: 8px;
 5326:   background-color: $data_table_light;
 5327: }
 5328: 
 5329: table.LC_helpform_receipt {
 5330:   width: 620px;
 5331:   border-collapse: separate;
 5332:   background: white;
 5333:   border: 1px solid black;
 5334:   border-spacing: 1px;
 5335: }
 5336: 
 5337: table.LC_helpform_receipt td.LC_pick_box_title {
 5338:   background: $tabbg;
 5339:   font-weight: bold;
 5340:   text-align: right;
 5341:   width: 184px;
 5342:   padding: 8px;
 5343: }
 5344: 
 5345: table.LC_helpform_receipt td.LC_evenrow_value {
 5346:   text-align: left;
 5347:   padding: 8px;
 5348:   background-color: $data_table_light;
 5349: }
 5350: 
 5351: table.LC_helpform_receipt td.LC_oddrow_value {
 5352:   text-align: left;
 5353:   padding: 8px;
 5354:   background-color: $data_table_light;
 5355: }
 5356: 
 5357: table.LC_helpform_receipt td.LC_pick_box_separator {
 5358:   padding: 0;
 5359:   height: 1px;
 5360:   background: black;
 5361: }
 5362: 
 5363: span.LC_helpform_receipt_cat {
 5364:   font-weight: bold;
 5365: }
 5366: 
 5367: table.LC_group_priv_box {
 5368:   background: white;
 5369:   border: 1px solid black;
 5370:   border-spacing: 1px;
 5371: }
 5372: 
 5373: table.LC_group_priv_box td.LC_pick_box_title {
 5374:   background: $tabbg;
 5375:   font-weight: bold;
 5376:   text-align: right;
 5377:   width: 184px;
 5378: }
 5379: 
 5380: table.LC_group_priv_box td.LC_groups_fixed {
 5381:   background: $data_table_light;
 5382:   text-align: center;
 5383: }
 5384: 
 5385: table.LC_group_priv_box td.LC_groups_optional {
 5386:   background: $data_table_dark;
 5387:   text-align: center;
 5388: }
 5389: 
 5390: table.LC_group_priv_box td.LC_groups_functionality {
 5391:   background: $data_table_darker;
 5392:   text-align: center;
 5393:   font-weight: bold;
 5394: }
 5395: 
 5396: table.LC_group_priv td {
 5397:   text-align: left;
 5398:   padding: 0;
 5399: }
 5400: 
 5401: table.LC_notify_front_page {
 5402:   background: white;
 5403:   border: 1px solid black;
 5404:   padding: 8px;
 5405: }
 5406: 
 5407: table.LC_notify_front_page td {
 5408:   padding: 8px;
 5409: }
 5410: 
 5411: .LC_navbuttons {
 5412:   margin: 2ex 0ex 2ex 0ex;
 5413: }
 5414: 
 5415: .LC_topic_bar {
 5416:   font-family: $sans;
 5417:   font-weight: bold;
 5418:   width: 100%;
 5419:   background: $tabbg;
 5420:   vertical-align: middle;
 5421:   margin: 2ex 0ex 2ex 0ex;
 5422:   padding: 3px;
 5423: }
 5424: 
 5425: .LC_topic_bar span {
 5426:   vertical-align: middle;
 5427: }
 5428: 
 5429: .LC_topic_bar img {
 5430:   vertical-align: bottom;
 5431: }
 5432: 
 5433: table.LC_course_group_status {
 5434:   margin: 20px;
 5435: }
 5436: 
 5437: table.LC_status_selector td {
 5438:   vertical-align: top;
 5439:   text-align: center;
 5440:   padding: 4px;
 5441: }
 5442: 
 5443: div.LC_feedback_link {
 5444:   clear: both;
 5445:   background: white;
 5446:   width: 100%;
 5447: }
 5448: 
 5449: span.LC_feedback_link {
 5450:   background: $feedback_link_bg;
 5451:   font-size: larger;
 5452: }
 5453: 
 5454: span.LC_message_link {
 5455:   background: $feedback_link_bg;
 5456:   font-size: larger;
 5457:   position: absolute;
 5458:   right: 1em;
 5459: }
 5460: 
 5461: table.LC_prior_tries {
 5462:   border: 1px solid #000000;
 5463:   border-collapse: separate;
 5464:   border-spacing: 1px;
 5465: }
 5466: 
 5467: table.LC_prior_tries td {
 5468:   padding: 2px;
 5469: }
 5470: 
 5471: .LC_answer_correct {
 5472:   background: lightgreen;
 5473:   font-family: $sans;
 5474:   color: darkgreen;
 5475:   padding: 6px;
 5476: }
 5477: 
 5478: .LC_answer_charged_try {
 5479:   background: #FFAAAA;
 5480:   font-family: $sans;
 5481:   color: darkred;
 5482:   padding: 6px;
 5483: }
 5484: 
 5485: .LC_answer_not_charged_try,
 5486: .LC_answer_no_grade,
 5487: .LC_answer_late {
 5488:   background: lightyellow;
 5489:   font-family: $sans;
 5490:   color: black;
 5491:   padding: 6px;
 5492: }
 5493: 
 5494: .LC_answer_previous {
 5495:   background: lightblue;
 5496:   font-family: $sans;
 5497:   color: darkblue;
 5498:   padding: 6px;
 5499: }
 5500: 
 5501: .LC_answer_no_message {
 5502:   background: #FFFFFF;
 5503:   font-family: $sans;
 5504:   color: black;
 5505:   padding: 6px;
 5506: }
 5507: 
 5508: .LC_answer_unknown {
 5509:   background: orange;
 5510:   font-family: $sans;
 5511:   color: black;
 5512:   padding: 6px;
 5513: }
 5514: 
 5515: span.LC_prior_numerical,
 5516: span.LC_prior_string,
 5517: span.LC_prior_custom,
 5518: span.LC_prior_reaction,
 5519: span.LC_prior_math {
 5520:   font-family: monospace;
 5521:   white-space: pre;
 5522: }
 5523: 
 5524: span.LC_prior_string {
 5525:   font-family: monospace;
 5526:   white-space: pre;
 5527: }
 5528: 
 5529: table.LC_prior_option {
 5530:   width: 100%;
 5531:   border-collapse: collapse;
 5532: }
 5533: 
 5534: table.LC_prior_rank, 
 5535: table.LC_prior_match {
 5536:   border-collapse: collapse;
 5537: }
 5538: 
 5539: table.LC_prior_option tr td,
 5540: table.LC_prior_rank tr td,
 5541: table.LC_prior_match tr td {
 5542:   border: 1px solid #000000;
 5543: }
 5544: 
 5545: td.LC_nobreak,
 5546: span.LC_nobreak {
 5547:   white-space: nowrap;
 5548: }
 5549: 
 5550: span.LC_cusr_emph {
 5551:   font-style: italic;
 5552: }
 5553: 
 5554: span.LC_cusr_subheading {
 5555:   font-weight: normal;
 5556:   font-size: 85%;
 5557: }
 5558: 
 5559: table.LC_docs_documents {
 5560:   background: #BBBBBB;
 5561:   border-width: 0;
 5562:   border-collapse: collapse;
 5563: }
 5564: 
 5565: table.LC_docs_documents td.LC_docs_document {
 5566:   border: 2px solid black;
 5567:   padding: 4px;
 5568: }
 5569: 
 5570: .LC_docs_entry_move {
 5571:   border: none;
 5572:   border-collapse: collapse;
 5573: }
 5574: 
 5575: .LC_docs_entry_move td {
 5576:   border: 2px solid #BBBBBB;
 5577:   background: #DDDDDD;
 5578: }
 5579: 
 5580: .LC_docs_editor td.LC_docs_entry_commands {
 5581:   background: #DDDDDD;
 5582:   font-size: x-small;
 5583: }
 5584: 
 5585: .LC_docs_copy {
 5586:   color: #000099;
 5587: }
 5588: 
 5589: .LC_docs_cut {
 5590:   color: #550044;
 5591: }
 5592: 
 5593: .LC_docs_rename {
 5594:   color: #009900;
 5595: }
 5596: 
 5597: .LC_docs_remove {
 5598:   color: #990000;
 5599: }
 5600: 
 5601: .LC_docs_reinit_warn,
 5602: .LC_docs_ext_edit {
 5603:   font-size: x-small;
 5604: }
 5605: 
 5606: .LC_docs_editor td.LC_docs_entry_title,
 5607: .LC_docs_editor td.LC_docs_entry_icon {
 5608:   background: #FFFFBB;
 5609: }
 5610: 
 5611: .LC_docs_editor td.LC_docs_entry_parameter {
 5612:   background: #BBBBFF;
 5613:   font-size: x-small;
 5614:   white-space: nowrap;
 5615: }
 5616: 
 5617: table.LC_docs_adddocs td,
 5618: table.LC_docs_adddocs th {
 5619:   border: 1px solid #BBBBBB;
 5620:   padding: 4px;
 5621:   background: #DDDDDD;
 5622: }
 5623: 
 5624: table.LC_sty_begin {
 5625:   background: #BBFFBB;
 5626: }
 5627: 
 5628: table.LC_sty_end {
 5629:   background: #FFBBBB;
 5630: }
 5631: 
 5632: table.LC_double_column {
 5633:   border-width: 0;
 5634:   border-collapse: collapse;
 5635:   width: 100%;
 5636:   padding: 2px;
 5637: }
 5638: 
 5639: table.LC_double_column tr td.LC_left_col {
 5640:   top: 2px;
 5641:   left: 2px;
 5642:   width: 47%;
 5643:   vertical-align: top;
 5644: }
 5645: 
 5646: table.LC_double_column tr td.LC_right_col {
 5647:   top: 2px;
 5648:   right: 2px;
 5649:   width: 47%;
 5650:   vertical-align: top;
 5651: }
 5652: 
 5653: span.LC_role_level {
 5654:   font-weight: bold;
 5655: }
 5656: 
 5657: div.LC_left_float {
 5658:   float: left;
 5659:   padding-right: 5%;
 5660:   padding-bottom: 4px;
 5661: }
 5662: 
 5663: div.LC_clear_float_header {
 5664:   padding-bottom: 2px;
 5665: }
 5666: 
 5667: div.LC_clear_float_footer {
 5668:   padding-top: 10px;
 5669:   clear: both;
 5670: }
 5671: 
 5672: div.LC_grade_show_user {
 5673:   margin-top: 20px;
 5674:   border: 1px solid black;
 5675: }
 5676: 
 5677: div.LC_grade_user_name {
 5678:   background: #DDDDEE;
 5679:   border-bottom: 1px solid black;
 5680:   font-weight: bold;
 5681:   font-size: large;
 5682: }
 5683: 
 5684: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
 5685:   background: #DDEEDD;
 5686: }
 5687: 
 5688: div.LC_grade_show_problem,
 5689: div.LC_grade_submissions,
 5690: div.LC_grade_message_center,
 5691: div.LC_grade_info_links,
 5692: div.LC_grade_assign {
 5693:   margin: 5px;
 5694:   width: 99%;
 5695:   background: #FFFFFF;
 5696: }
 5697: 
 5698: div.LC_grade_show_problem_header,
 5699: div.LC_grade_submissions_header,
 5700: div.LC_grade_message_center_header,
 5701: div.LC_grade_assign_header {
 5702:   font-weight: bold;
 5703:   font-size: large;
 5704: }
 5705: 
 5706: div.LC_grade_show_problem_problem,
 5707: div.LC_grade_submissions_body,
 5708: div.LC_grade_message_center_body,
 5709: div.LC_grade_assign_body {
 5710:   border: 1px solid black;
 5711:   width: 99%;
 5712:   background: #FFFFFF;
 5713: }
 5714: 
 5715: span.LC_grade_check_note {
 5716:   font-weight: normal;
 5717:   font-size: medium;
 5718:   display: inline;
 5719:   position: absolute;
 5720:   right: 1em;
 5721: }
 5722: 
 5723: table.LC_scantron_action {
 5724:   width: 100%;
 5725: }
 5726: 
 5727: table.LC_scantron_action tr th {
 5728:   font-weight:bold;
 5729:   font-style:normal;
 5730: }
 5731: 
 5732: .LC_edit_problem_header,
 5733: div.LC_edit_problem_footer {
 5734:   font-weight: normal;
 5735:   font-size:  medium;
 5736:   margin: 2px;
 5737: }
 5738: 
 5739: div.LC_edit_problem_header,
 5740: div.LC_edit_problem_header div,
 5741: div.LC_edit_problem_footer,
 5742: div.LC_edit_problem_footer div,
 5743: div.LC_edit_problem_editxml_header,
 5744: div.LC_edit_problem_editxml_header div {
 5745:   margin-top: 5px;
 5746: }
 5747: 
 5748: div.LC_edit_problem_header_edit_row {
 5749:   background: $tabbg;
 5750:   padding: 3px;
 5751:   margin-bottom: 5px;
 5752: }
 5753: 
 5754: div.LC_edit_problem_header_title {
 5755:   font-weight: bold;
 5756:   font-size: larger;
 5757:   background: $tabbg;
 5758:   padding: 3px;
 5759: }
 5760: 
 5761: table.LC_edit_problem_header_title {
 5762:   font-size: larger;
 5763:   font-weight:  bold;
 5764:   width: 100%;
 5765:   border-color: $pgbg;
 5766:   border-style: solid;
 5767:   border-width: $border;
 5768:   background: $tabbg;
 5769:   border-collapse: collapse;
 5770:   padding: 0;
 5771: }
 5772: 
 5773: div.LC_edit_problem_discards {
 5774:   float: left;
 5775:   padding-bottom: 5px;
 5776: }
 5777: 
 5778: div.LC_edit_problem_saves {
 5779:   float: right;
 5780:   padding-bottom: 5px;
 5781: }
 5782: 
 5783: hr.LC_edit_problem_divide {
 5784:   clear: both;
 5785:   color: $tabbg;
 5786:   background-color: $tabbg;
 5787:   height: 3px;
 5788:   border: none;
 5789: }
 5790: 
 5791: img.stift{
 5792:   border-width: 0;
 5793:   vertical-align: middle;
 5794: }
 5795: 
 5796: table#LC_mainmenu{
 5797:  margin-top:10px;
 5798:  width:80%;
 5799: }
 5800: 
 5801: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
 5802:   vertical-align: top;
 5803:   width: 45%;
 5804: }
 5805: 
 5806: .LC_mainmenu_fieldset_category {
 5807:   color: $font;
 5808:   background: $pgbg;
 5809:   font-family: $sans;
 5810:   font-size: small;
 5811:   font-weight: bold;
 5812: }
 5813: 
 5814: div.LC_createcourse {
 5815:     margin: 10px 10px 10px 10px;
 5816: }
 5817: 
 5818: /* ---- Remove when done ----
 5819: # The following styles is part of the redesign of LON-CAPA and are
 5820: # subject to change during this project.
 5821: # Don't rely on their current functionality as they might be 
 5822: # changed or removed.
 5823: # --------------------------*/
 5824: 
 5825: a:hover,
 5826: ol.LC_smallMenu a:hover,
 5827: ol#LC_MenuBreadcrumbs a:hover,
 5828: ol#LC_PathBreadcrumbs a:hover,
 5829: ul#LC_TabMainMenuContent a:hover,
 5830: .LC_FormSectionClearButton input:hover
 5831: ul.LC_TabContent   li:hover a {
 5832: 	color:#BF2317;
 5833:         text-decoration:none;
 5834: }
 5835: 
 5836: h1 {
 5837: 	padding: 0;
 5838: 	line-height:130%;
 5839: }
 5840: 
 5841: h2,h3,h4,h5,h6 {
 5842: 	margin: 5px 0 5px 0;
 5843: 	padding: 0;
 5844: 	line-height:130%;
 5845: }
 5846: 
 5847: .LC_hcell {
 5848:         padding:3px 15px 3px 15px;
 5849:         margin: 0;
 5850: 	background-color:$tabbg;
 5851: 	color:$fontmenu;
 5852: 	border-bottom:solid 1px $lg_border_color;
 5853: }
 5854: 
 5855: .LC_noBorder {
 5856:         border: 0;
 5857: }
 5858: 
 5859: 
 5860: /* Main Header with discription of Person, Course, etc. */
 5861: 
 5862: .LC_Right {
 5863:         float: right;
 5864:         margin: 0;
 5865:         padding: 0;
 5866: }
 5867: 
 5868: .LC_FormSectionClearButton input {
 5869:         background-color:transparent;
 5870:         border: none;
 5871:         cursor:pointer;
 5872:         text-decoration:underline;
 5873: }
 5874: 
 5875: .LC_help_open_topic {
 5876:         color: #FFFFFF;
 5877:         background-color: #EEEEFF;
 5878:         margin: 1px;
 5879:         padding: 4px;
 5880:         border: 1px solid #000033;
 5881:         white-space: nowrap;
 5882: /*		vertical-align: middle; */
 5883: }
 5884: 
 5885: dl,ul,div,fieldset {
 5886: 	margin: 10px 10px 10px 0;
 5887: /*	overflow: hidden; */
 5888: }
 5889: 
 5890: #LC_nav_bar {
 5891:     float: left;
 5892:     margin: 0;
 5893: }
 5894: 
 5895: #LC_nav_bar em{
 5896:     font-weight: bold;
 5897:     font-style: normal;
 5898: }
 5899: 
 5900: ol.LC_smallMenu {
 5901:     float: right;
 5902: }
 5903: 
 5904: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
 5905: 	margin: 0;
 5906: }
 5907: 
 5908: ol.LC_smallMenu li {
 5909: 	display: inline;
 5910: 	padding: 5px 5px 0 10px;
 5911: 	vertical-align: top;
 5912: }
 5913: 
 5914: ol.LC_smallMenu li img {
 5915: 	vertical-align: bottom;
 5916: }
 5917: 
 5918: ol.LC_smallMenu a {
 5919: 	font-size: 90%;
 5920: 	color: RGB(80, 80, 80);
 5921: 	text-decoration: none;
 5922: }
 5923: 
 5924: ul#LC_TabMainMenuContent {
 5925:     clear: both;
 5926:     color: $fontmenu;
 5927:     background: $tabbg;
 5928:     list-style: none;
 5929:     padding: 0;
 5930:     margin: 0;
 5931:     float:left;
 5932:     width: 100%;
 5933: }
 5934: 
 5935: ul#LC_TabMainMenuContent li {
 5936:     float: left;
 5937:     font-weight: bold;
 5938:     line-height: 1.8em;
 5939:     padding: 0 0.8em; 
 5940:     border-right: 1px solid black;
 5941:     display: inline;
 5942:     vertical-align: middle;
 5943: }
 5944: 
 5945: ul.LC_TabContent ,
 5946: ul.LC_TabContentBigger {
 5947: 	display:block;
 5948: 	list-style:none;
 5949: 	margin: 0;
 5950: 	padding: 0;
 5951: }
 5952: 
 5953: ul.LC_TabContent li,
 5954: ul.LC_TabContentBigger li {
 5955: 	display: inline;
 5956: 	border-right: solid 1px $lg_border_color;
 5957: 	float:left;
 5958: 	line-height:140%;
 5959: 	white-space:nowrap;
 5960: }
 5961: 
 5962: ul#LC_TabMainMenuContent li a {
 5963:     color: $fontmenu;
 5964: 	text-decoration: none;
 5965: }
 5966: 
 5967: ul.LC_TabContent {
 5968: 	min-height:1.6em;
 5969: }
 5970: 
 5971: ul.LC_TabContent li {
 5972: 	vertical-align:middle;
 5973: 	padding: 0 10px 0 10px;
 5974: 	background-color:$tabbg;
 5975: 	border-bottom:solid 1px $lg_border_color;
 5976: }
 5977: 
 5978: ul.LC_TabContent li a, ul.LC_TabContent li {
 5979: 	color:rgb(47,47,47);
 5980: 	text-decoration:none;
 5981: 	font-size:95%;
 5982: 	font-weight:bold;
 5983: 	padding-right: 16px;
 5984: }
 5985: 
 5986: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
 5987:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
 5988: 	border-bottom:solid 1px #FFFFFF;
 5989: 	padding-right: 16px;
 5990: }
 5991: 
 5992: ul.LC_TabContentBigger li {
 5993: 	vertical-align:bottom;
 5994: 	border-top:solid 1px $lg_border_color;
 5995: 	border-left:solid 1px $lg_border_color;
 5996: 	padding:5px 10px 5px 10px;
 5997: 	margin-left:2px;
 5998: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
 5999: }
 6000: 
 6001: ul.LC_TabContentBigger li:hover, 
 6002: ul.LC_TabContentBigger li.active {
 6003: 	background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
 6004: }
 6005: 
 6006: ul.LC_TabContentBigger li, 
 6007: ul.LC_TabContentBigger li a {
 6008: 	font-size:110%;
 6009: 	font-weight:bold;
 6010: }
 6011: 
 6012: ol#LC_MenuBreadcrumbs, 
 6013: ol#LC_PathBreadcrumbs, 
 6014: ul#LC_CourseBreadcrumbs {
 6015: 	padding-left: 10px;
 6016: 	margin: 0;
 6017: 	list-style-position: inside;
 6018: }
 6019: 
 6020: ol#LC_MenuBreadcrumbs li, 
 6021: ol#LC_PathBreadcrumbs li, 
 6022: ul#LC_CourseBreadcrumbs li {
 6023: 	display: inline;
 6024: 	padding: 0 0 0 10px;
 6025: 	overflow:hidden;
 6026: }
 6027: 
 6028: ol#LC_MenuBreadcrumbs li a,
 6029: ul#LC_CourseBreadcrumbs li a {
 6030: 	text-decoration: none;
 6031: 	font-size:90%;
 6032: }
 6033: 
 6034: ol#LC_PathBreadcrumbs li a {
 6035: 	text-decoration:none;
 6036: 	font-size:100%;
 6037: 	font-weight:bold;
 6038: }
 6039: 
 6040: .LC_BoxPadding {
 6041: 	padding: 10px;
 6042: }
 6043: 
 6044: .LC_ContentBoxSpecial {
 6045: 	border: solid 1px $lg_border_color;
 6046: }
 6047: 
 6048: .LC_ContentBoxSpecialContactInfo {
 6049: 	border: solid 1px $lg_border_color;
 6050: 	max-width:25%;
 6051: 	min-width:25%;
 6052: }
 6053: 
 6054: .LC_AboutMe_Image {
 6055: 	float:left;
 6056: 	margin-right:10px;
 6057: }
 6058: 
 6059: .LC_Clear_AboutMe_Image {
 6060: 	clear:left;
 6061: }
 6062: 
 6063: dl.LC_ListStyleClean dt {
 6064: 	padding-right: 5px;
 6065: 	display: table-header-group;
 6066: }
 6067: 
 6068: dl.LC_ListStyleClean dd {
 6069: 	display: table-row;
 6070: }
 6071: 
 6072: .LC_ListStyleClean,
 6073: .LC_ListStyleSimple,
 6074: .LC_ListStyleNormal,
 6075: .LC_ListStyle_Border,
 6076: .LC_ListStyleSpecial {
 6077: 	/*display:block;	*/
 6078: 	list-style-position: inside;
 6079: 	list-style-type: none;
 6080: 	overflow: hidden;
 6081: 	padding: 0;
 6082: }
 6083: 
 6084: .LC_ListStyleSimple li,
 6085: .LC_ListStyleSimple dd,
 6086: .LC_ListStyleNormal li,
 6087: .LC_ListStyleNormal dd,
 6088: .LC_ListStyleSpecial li,
 6089: .LC_ListStyleSpecial dd {
 6090: 	margin: 0;
 6091: 	padding: 5px 5px 5px 10px;
 6092: 	clear: both;
 6093: }
 6094: 
 6095: .LC_ListStyleClean li,
 6096: .LC_ListStyleClean dd {
 6097: 	padding-top: 0;
 6098: 	padding-bottom: 0;
 6099: }
 6100: 
 6101: .LC_ListStyleSimple dd,
 6102: .LC_ListStyleSimple li {
 6103: 	border-bottom: solid 1px $lg_border_color;
 6104: }
 6105: 
 6106: .LC_ListStyleSpecial li,
 6107: .LC_ListStyleSpecial dd {
 6108: 	list-style-type: none;
 6109: 	background-color: RGB(220, 220, 220);
 6110: 	margin-bottom: 4px;
 6111: }
 6112: 
 6113: table.LC_SimpleTable {
 6114: 	margin:5px;
 6115: 	border:solid 1px $lg_border_color;
 6116: }
 6117: 
 6118: table.LC_SimpleTable tr {
 6119: 	padding: 0;
 6120: 	border:solid 1px $lg_border_color;
 6121: }
 6122: 
 6123: table.LC_SimpleTable thead {
 6124: 	 background:rgb(220,220,220);
 6125: }
 6126: 
 6127: div.LC_columnSection {
 6128: 	display: block;
 6129: 	clear: both;
 6130: 	overflow: hidden;
 6131: 	margin: 0;
 6132: }
 6133: 
 6134: div.LC_columnSection>* {
 6135: 	float: left;
 6136: 	margin: 10px 20px 10px 0;
 6137: 	overflow:hidden;
 6138: }
 6139: 
 6140: .ContentBoxSpecialTemplate {
 6141:         border: solid 1px $lg_border_color;
 6142: }
 6143: 
 6144: .ContentBoxTemplate {
 6145:         padding:10px;
 6146: }
 6147: 
 6148: div.LC_columnSection > .ContentBoxTemplate,
 6149: div.LC_columnSection > .ContentBoxSpecialTemplate {
 6150:         width: 600px;
 6151: }
 6152: 
 6153: .clear {
 6154: 	clear: both;
 6155: 	line-height: 0;
 6156: 	font-size: 0;
 6157: 	height: 0;
 6158: }
 6159: 
 6160: .LC_loginpage_container {
 6161: 	text-align:left;
 6162: 	margin : 0 auto;
 6163: 	width:90%;
 6164: 	padding: 10px;
 6165: 	height: auto;
 6166: 	background-color:#FFFFFF;
 6167: 	border:1px solid #CCCCCC;
 6168: }
 6169: 
 6170: 
 6171: .LC_loginpage_loginContainer {
 6172: 	float:left;
 6173: 	width: 182px;
 6174: 	padding: 2px;
 6175: 	border:1px solid #CCCCCC;
 6176: 	background-color:$loginbg;
 6177: }
 6178: 
 6179: .LC_loginpage_loginContainer h2 {
 6180: 	margin-top: 0;
 6181: 	display:block;
 6182: 	background:$bgcol;
 6183: 	color:$textcol;
 6184: 	padding-left:5px;
 6185: }
 6186: 
 6187: .LC_loginpage_loginInfo {
 6188: 	float:left;
 6189: 	width:182px;
 6190: 	border:1px solid #CCCCCC;
 6191: 	padding:2px;
 6192: }
 6193: 
 6194: .LC_loginpage_space {
 6195: 	clear: both;
 6196: 	margin-bottom: 20px;
 6197: 	border-bottom: 1px solid #CCCCCC;
 6198: }
 6199: 
 6200: .LC_loginpage_floatLeft {
 6201: 	float: left;
 6202: 	width: 200px;
 6203: 	margin: 0;
 6204: }
 6205: 
 6206: table em {
 6207: 	font-weight: bold;
 6208: 	font-style: normal;
 6209: }
 6210: 
 6211: table.LC_tableBrowseRes,
 6212: table.LC_tableOfContent {
 6213:         border:none;
 6214: 	border-spacing: 1;
 6215: 	padding: 3px;
 6216: 	background-color: #FFFFFF;
 6217: 	font-size: 90%;
 6218: }
 6219: 
 6220: table.LC_tableOfContent{
 6221:     border-collapse: collapse;
 6222: }
 6223: 
 6224: table.LC_tableBrowseRes a,
 6225: table.LC_tableOfContent a {
 6226:         background-color: transparent;
 6227: 	text-decoration: none;
 6228: }
 6229: 
 6230: table.LC_tableBrowseRes tr.LC_trOdd,
 6231: table.LC_tableOfContent tr.LC_trOdd{
 6232: 	background-color: #EEEEEE;
 6233: }
 6234: 
 6235: table.LC_tableOfContent img {
 6236: 	border: none;
 6237: 	height: 1.3em;
 6238: 	vertical-align: text-bottom;
 6239: 	margin-right: 0.3em;
 6240: }
 6241: 
 6242: a#LC_content_toolbar_firsthomework {
 6243: 	background-image:url(/res/adm/pages/open-first-problem.gif);
 6244: }
 6245: 
 6246: a#LC_content_toolbar_launchnav {
 6247: 	background-image:url(/res/adm/pages/start-navigation.gif);
 6248: }
 6249: 
 6250: a#LC_content_toolbar_closenav {
 6251: 	background-image:url(/res/adm/pages/close-navigation.gif);
 6252: }
 6253: 
 6254: a#LC_content_toolbar_everything {
 6255: 	background-image:url(/res/adm/pages/show-all.gif);
 6256: }
 6257: 
 6258: a#LC_content_toolbar_uncompleted {
 6259: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
 6260: }
 6261: 
 6262: #LC_content_toolbar_clearbubbles {
 6263: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
 6264: }
 6265: 
 6266: a#LC_content_toolbar_changefolder {
 6267: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
 6268: }
 6269: 
 6270: a#LC_content_toolbar_changefolder_toggled {
 6271: 	background-image:url(/res/adm/pages/open-all-folders.gif);
 6272: }
 6273: 
 6274: ul#LC_toolbar li a:hover {
 6275: 	background-position: bottom center;
 6276: }
 6277: 
 6278: ul#LC_toolbar {
 6279: 	padding: 0;
 6280: 	margin: 2px;
 6281: 	list-style:none;
 6282: 	position:relative;
 6283: 	background-color:white;
 6284: }
 6285: 
 6286: ul#LC_toolbar li {
 6287: 	border:1px solid white;
 6288: 	padding: 0;
 6289: 	margin: 0;
 6290:         float: left;
 6291: 	display:inline;
 6292: 	vertical-align:middle;
 6293: } 
 6294: 
 6295: 
 6296: a.LC_toolbarItem {
 6297: 	display:block;
 6298: 	padding: 0;
 6299: 	margin: 0;
 6300: 	height: 32px;
 6301: 	width: 32px;
 6302: 	color:white;
 6303: 	border: none;
 6304: 	background-repeat:no-repeat;
 6305: 	background-color:transparent;
 6306: }
 6307: 
 6308: ul.LC_functionslist li {
 6309:   float: left;
 6310:   white-space: nowrap;
 6311:   height: 35px; /* at least as high as heighest list item */
 6312:   margin: 0 15px 15px 10px;
 6313: }
 6314: 
 6315: 
 6316: END
 6317: }
 6318: 
 6319: =pod
 6320: 
 6321: =item * &headtag()
 6322: 
 6323: Returns a uniform footer for LON-CAPA web pages.
 6324: 
 6325: Inputs: $title - optional title for the head
 6326:         $head_extra - optional extra HTML to put inside the <head>
 6327:         $args - optional arguments
 6328:             force_register - if is true call registerurl so the remote is 
 6329:                              informed
 6330:             redirect       -> array ref of
 6331:                                    1- seconds before redirect occurs
 6332:                                    2- url to redirect to
 6333:                                    3- whether the side effect should occur
 6334:                            (side effect of setting 
 6335:                                $env{'internal.head.redirect'} to the url 
 6336:                                redirected too)
 6337:             domain         -> force to color decorate a page for a specific
 6338:                                domain
 6339:             function       -> force usage of a specific rolish color scheme
 6340:             bgcolor        -> override the default page bgcolor
 6341:             no_auto_mt_title
 6342:                            -> prevent &mt()ing the title arg
 6343: 
 6344: =cut
 6345: 
 6346: sub headtag {
 6347:     my ($title,$head_extra,$args) = @_;
 6348:     
 6349:     my $function = $args->{'function'} || &get_users_function();
 6350:     my $domain   = $args->{'domain'}   || &determinedomain();
 6351:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
 6352:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
 6353: 		   $Apache::lonnet::perlvar{'lonVersion'},
 6354: 		   #time(),
 6355: 		   $env{'environment.color.timestamp'},
 6356: 		   $function,$domain,$bgcolor);
 6357: 
 6358:     $url = '/adm/css/'.&escape($url).'.css';
 6359: 
 6360:     my $result =
 6361: 	'<head>'.
 6362: 	&font_settings();
 6363: 
 6364:     if (!$args->{'frameset'}) {
 6365: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
 6366:     }
 6367:     if ($args->{'force_register'}) {
 6368: 	$result .= &Apache::lonmenu::registerurl(1);
 6369:     }
 6370:     if (!$args->{'no_nav_bar'} 
 6371: 	&& !$args->{'only_body'}
 6372: 	&& !$args->{'frameset'}) {
 6373: 	$result .= &help_menu_js();
 6374:     }
 6375: 
 6376:     if (ref($args->{'redirect'})) {
 6377: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
 6378: 	$url = &Apache::lonenc::check_encrypt($url);
 6379: 	if (!$inhibit_continue) {
 6380: 	    $env{'internal.head.redirect'} = $url;
 6381: 	}
 6382: 	$result.=<<ADDMETA
 6383: <meta http-equiv="pragma" content="no-cache" />
 6384: <meta http-equiv="Refresh" content="$time; url=$url" />
 6385: ADDMETA
 6386:     }
 6387:     if (!defined($title)) {
 6388: 	$title = 'The LearningOnline Network with CAPA';
 6389:     }
 6390:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
 6391:     $result .= '<title> LON-CAPA '.$title.'</title>'
 6392: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
 6393: 	.$head_extra;
 6394:     return $result;
 6395: }
 6396: 
 6397: =pod
 6398: 
 6399: =item * &font_settings()
 6400: 
 6401: Returns neccessary <meta> to set the proper encoding
 6402: 
 6403: Inputs: none
 6404: 
 6405: =cut
 6406: 
 6407: sub font_settings {
 6408:     my $headerstring='';
 6409:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
 6410: 	$headerstring.=
 6411: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
 6412:     }
 6413:     return $headerstring;
 6414: }
 6415: 
 6416: =pod
 6417: 
 6418: =item * &xml_begin()
 6419: 
 6420: Returns the needed doctype and <html>
 6421: 
 6422: Inputs: none
 6423: 
 6424: =cut
 6425: 
 6426: sub xml_begin {
 6427:     my $output='';
 6428: 
 6429:     if ($env{'internal.start_page'}==1) {
 6430: 	&Apache::lonhtmlcommon::init_htmlareafields();
 6431:     }
 6432: 
 6433:     if ($env{'browser.mathml'}) {
 6434: 	$output='<?xml version="1.0"?>'
 6435:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
 6436: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
 6437:             
 6438: #	    .'<!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">] >'
 6439: 	    .'<!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">'
 6440:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
 6441: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
 6442:     } else {
 6443: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
 6444:     }
 6445:     return $output;
 6446: }
 6447: 
 6448: =pod
 6449: 
 6450: =item * &endheadtag()
 6451: 
 6452: Returns a uniform </head> for LON-CAPA web pages.
 6453: 
 6454: Inputs: none
 6455: 
 6456: =cut
 6457: 
 6458: sub endheadtag {
 6459:     return '</head>';
 6460: }
 6461: 
 6462: =pod
 6463: 
 6464: =item * &head()
 6465: 
 6466: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
 6467: 
 6468: Inputs:
 6469: 
 6470: =over 4
 6471: 
 6472: $title - optional title for the page
 6473: 
 6474: $head_extra - optional extra HTML to put inside the <head>
 6475: 
 6476: =back
 6477: 
 6478: =cut
 6479: 
 6480: sub head {
 6481:     my ($title,$head_extra,$args) = @_;
 6482:     return &headtag($title,$head_extra,$args).&endheadtag();
 6483: }
 6484: 
 6485: =pod
 6486: 
 6487: =item * &start_page()
 6488: 
 6489: Returns a complete <html> .. <body> section for LON-CAPA web pages.
 6490: 
 6491: Inputs:
 6492: 
 6493: =over 4
 6494: 
 6495: $title - optional title for the page
 6496: 
 6497: $head_extra - optional extra HTML to incude inside the <head>
 6498: 
 6499: $args - additional optional args supported are:
 6500: 
 6501: =over 8
 6502: 
 6503:              only_body      -> is true will set &bodytag() onlybodytag
 6504:                                     arg on
 6505:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
 6506:              add_entries    -> additional attributes to add to the  <body>
 6507:              domain         -> force to color decorate a page for a 
 6508:                                     specific domain
 6509:              function       -> force usage of a specific rolish color
 6510:                                     scheme
 6511:              redirect       -> see &headtag()
 6512:              bgcolor        -> override the default page bg color
 6513:              js_ready       -> return a string ready for being used in 
 6514:                                     a javascript writeln
 6515:              html_encode    -> return a string ready for being used in 
 6516:                                     a html attribute
 6517:              force_register -> if is true will turn on the &bodytag()
 6518:                                     $forcereg arg
 6519:              body_title     -> alternate text to use instead of $title
 6520:                                     in the title box that appears, this text
 6521:                                     is not auto translated like the $title is
 6522:              frameset       -> if true will start with a <frameset>
 6523:                                     rather than <body>
 6524:              skip_phases    -> hash ref of 
 6525:                                     head -> skip the <html><head> generation
 6526:                                     body -> skip all <body> generation
 6527:              no_inline_link -> if true and in remote mode, don't show the 
 6528:                                     'Switch To Inline Menu' link
 6529:              no_auto_mt_title -> prevent &mt()ing the title arg
 6530:              inherit_jsmath -> when creating popup window in a page,
 6531:                                     should it have jsmath forced on by the
 6532:                                     current page
 6533: 
 6534: =back
 6535: 
 6536: =back
 6537: 
 6538: =cut
 6539: 
 6540: sub start_page {
 6541:     my ($title,$head_extra,$args) = @_;
 6542:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
 6543:     my %head_args;
 6544:     foreach my $arg ('redirect','force_register','domain','function',
 6545: 		     'bgcolor','frameset','no_nav_bar','only_body',
 6546: 		     'no_auto_mt_title') {
 6547: 	if (defined($args->{$arg})) {
 6548: 	    $head_args{$arg} = $args->{$arg};
 6549: 	}
 6550:     }
 6551: 
 6552:     $env{'internal.start_page'}++;
 6553:     my $result;
 6554:     if (! exists($args->{'skip_phases'}{'head'}) ) {
 6555: 	$result.=
 6556: 	    &xml_begin().
 6557: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
 6558:     }
 6559:     
 6560:     if (! exists($args->{'skip_phases'}{'body'}) ) {
 6561: 	if ($args->{'frameset'}) {
 6562: 	    my $attr_string = &make_attr_string($args->{'force_register'},
 6563: 						$args->{'add_entries'});
 6564: 	    $result .= "\n<frameset $attr_string>\n";
 6565: 	} else {
 6566: 	    $result .=
 6567: 		&bodytag($title, 
 6568: 			 $args->{'function'},       $args->{'add_entries'},
 6569: 			 $args->{'only_body'},      $args->{'domain'},
 6570: 			 $args->{'force_register'}, $args->{'body_title'},
 6571: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
 6572: 			 $args->{'no_inline_link'},
 6573: 			 $args);
 6574: 	}
 6575:     }
 6576: 
 6577:     if ($args->{'js_ready'}) {
 6578: 		$result = &js_ready($result);
 6579:     }
 6580:     if ($args->{'html_encode'}) {
 6581: 		$result = &html_encode($result);
 6582:     }
 6583: 
 6584:     # Preparation for new and consistent functionlist at top of screen
 6585:     # if ($args->{'functionlist'}) {
 6586:     #            $result .= &build_functionlist();
 6587:     #}
 6588: 
 6589:     # Don't add anything more if only_body wanted
 6590:     return $result if $args->{'only_body'};
 6591: 
 6592:     #Breadcrumbs
 6593:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
 6594: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
 6595: 		#if any br links exists, add them to the breadcrumbs
 6596: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
 6597: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
 6598: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
 6599: 			}
 6600: 		}
 6601: 
 6602: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
 6603: 		if(exists($args->{'bread_crumbs_component'})){
 6604: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
 6605: 		}else{
 6606: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
 6607: 		}
 6608:     }
 6609:     return $result;
 6610: }
 6611: 
 6612: 
 6613: =pod
 6614: 
 6615: =item * &head()
 6616: 
 6617: Returns a complete </body></html> section for LON-CAPA web pages.
 6618: 
 6619: Inputs:         $args - additional optional args supported are:
 6620:                  js_ready     -> return a string ready for being used in 
 6621:                                  a javascript writeln
 6622:                  html_encode  -> return a string ready for being used in 
 6623:                                  a html attribute
 6624:                  frameset     -> if true will start with a <frameset>
 6625:                                  rather than <body>
 6626:                  dicsussion   -> if true will get discussion from
 6627:                                   lonxml::xmlend
 6628:                                  (you can pass the target and parser arguments
 6629:                                   through optional 'target' and 'parser' args
 6630:                                   to this routine)
 6631: 
 6632: =cut
 6633: 
 6634: sub end_page {
 6635:     my ($args) = @_;
 6636:     $env{'internal.end_page'}++;
 6637:     my $result;
 6638:     if ($args->{'discussion'}) {
 6639: 	my ($target,$parser);
 6640: 	if (ref($args->{'discussion'})) {
 6641: 	    ($target,$parser) =($args->{'discussion'}{'target'},
 6642: 				$args->{'discussion'}{'parser'});
 6643: 	}
 6644: 	$result .= &Apache::lonxml::xmlend($target,$parser);
 6645:     }
 6646: 
 6647:     if ($args->{'frameset'}) {
 6648: 	$result .= '</frameset>';
 6649:     } else {
 6650: 	$result .= &endbodytag($args);
 6651:     }
 6652:     $result .= "\n</html>";
 6653: 
 6654:     if ($args->{'js_ready'}) {
 6655: 	$result = &js_ready($result);
 6656:     }
 6657: 
 6658:     if ($args->{'html_encode'}) {
 6659: 	$result = &html_encode($result);
 6660:     }
 6661: 
 6662:     return $result;
 6663: }
 6664: 
 6665: sub html_encode {
 6666:     my ($result) = @_;
 6667: 
 6668:     $result = &HTML::Entities::encode($result,'<>&"');
 6669:     
 6670:     return $result;
 6671: }
 6672: sub js_ready {
 6673:     my ($result) = @_;
 6674: 
 6675:     $result =~ s/[\n\r]/ /xmsg;
 6676:     $result =~ s/\\/\\\\/xmsg;
 6677:     $result =~ s/'/\\'/xmsg;
 6678:     $result =~ s{</}{<\\/}xmsg;
 6679:     
 6680:     return $result;
 6681: }
 6682: 
 6683: sub validate_page {
 6684:     if (  exists($env{'internal.start_page'})
 6685: 	  &&     $env{'internal.start_page'} > 1) {
 6686: 	&Apache::lonnet::logthis('start_page called multiple times '.
 6687: 				 $env{'internal.start_page'}.' '.
 6688: 				 $ENV{'request.filename'});
 6689:     }
 6690:     if (  exists($env{'internal.end_page'})
 6691: 	  &&     $env{'internal.end_page'} > 1) {
 6692: 	&Apache::lonnet::logthis('end_page called multiple times '.
 6693: 				 $env{'internal.end_page'}.' '.
 6694: 				 $env{'request.filename'});
 6695:     }
 6696:     if (     exists($env{'internal.start_page'})
 6697: 	&& ! exists($env{'internal.end_page'})) {
 6698: 	&Apache::lonnet::logthis('start_page called without end_page '.
 6699: 				 $env{'request.filename'});
 6700:     }
 6701:     if (   ! exists($env{'internal.start_page'})
 6702: 	&&   exists($env{'internal.end_page'})) {
 6703: 	&Apache::lonnet::logthis('end_page called without start_page'.
 6704: 				 $env{'request.filename'});
 6705:     }
 6706: }
 6707: 
 6708: sub simple_error_page {
 6709:     my ($r,$title,$msg) = @_;
 6710:     my $page =
 6711: 	&Apache::loncommon::start_page($title).
 6712: 	&mt($msg).
 6713: 	&Apache::loncommon::end_page();
 6714:     if (ref($r)) {
 6715: 	$r->print($page);
 6716: 	return;
 6717:     }
 6718:     return $page;
 6719: }
 6720: 
 6721: {
 6722:     my @row_count;
 6723:     sub start_data_table {
 6724: 	my ($add_class) = @_;
 6725: 	my $css_class = (join(' ','LC_data_table',$add_class));
 6726: 	unshift(@row_count,0);
 6727: 	return '<table class="'.$css_class.'">'."\n";
 6728:     }
 6729: 
 6730:     sub end_data_table {
 6731: 	shift(@row_count);
 6732: 	return '</table>'."\n";;
 6733:     }
 6734: 
 6735:     sub start_data_table_row {
 6736: 	my ($add_class) = @_;
 6737: 	$row_count[0]++;
 6738: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
 6739: 	$css_class = (join(' ',$css_class,$add_class));
 6740: 	return  '<tr class="'.$css_class.'">'."\n";;
 6741:     }
 6742:     
 6743:     sub continue_data_table_row {
 6744: 	my ($add_class) = @_;
 6745: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
 6746: 	$css_class = (join(' ',$css_class,$add_class));
 6747: 	return  '<tr class="'.$css_class.'">'."\n";;
 6748:     }
 6749: 
 6750:     sub end_data_table_row {
 6751: 	return '</tr>'."\n";;
 6752:     }
 6753: 
 6754:     sub start_data_table_empty_row {
 6755: #	$row_count[0]++;
 6756: 	return  '<tr class="LC_empty_row" >'."\n";;
 6757:     }
 6758: 
 6759:     sub end_data_table_empty_row {
 6760: 	return '</tr>'."\n";;
 6761:     }
 6762: 
 6763:     sub start_data_table_header_row {
 6764: 	return  '<tr class="LC_header_row">'."\n";;
 6765:     }
 6766: 
 6767:     sub end_data_table_header_row {
 6768: 	return '</tr>'."\n";;
 6769:     }
 6770: }
 6771: 
 6772: =pod
 6773: 
 6774: =item * &inhibit_menu_check($arg)
 6775: 
 6776: Checks for a inhibitmenu state and generates output to preserve it
 6777: 
 6778: Inputs:         $arg - can be any of
 6779:                      - undef - in which case the return value is a string 
 6780:                                to add  into arguments list of a uri
 6781:                      - 'input' - in which case the return value is a HTML
 6782:                                  <form> <input> field of type hidden to
 6783:                                  preserve the value
 6784:                      - a url - in which case the return value is the url with
 6785:                                the neccesary cgi args added to preserve the
 6786:                                inhibitmenu state
 6787:                      - a ref to a url - no return value, but the string is
 6788:                                         updated to include the neccessary cgi
 6789:                                         args to preserve the inhibitmenu state
 6790: 
 6791: =cut
 6792: 
 6793: sub inhibit_menu_check {
 6794:     my ($arg) = @_;
 6795:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
 6796:     if ($arg eq 'input') {
 6797: 	if ($env{'form.inhibitmenu'}) {
 6798: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
 6799: 	} else {
 6800: 	    return
 6801: 	}
 6802:     }
 6803:     if ($env{'form.inhibitmenu'}) {
 6804: 	if (ref($arg)) {
 6805: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
 6806: 	} elsif ($arg eq '') {
 6807: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
 6808: 	} else {
 6809: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
 6810: 	}
 6811:     }
 6812:     if (!ref($arg)) {
 6813: 	return $arg;
 6814:     }
 6815: }
 6816: 
 6817: ###############################################
 6818: 
 6819: =pod
 6820: 
 6821: =back
 6822: 
 6823: =head1 User Information Routines
 6824: 
 6825: =over 4
 6826: 
 6827: =item * &get_users_function()
 6828: 
 6829: Used by &bodytag to determine the current users primary role.
 6830: Returns either 'student','coordinator','admin', or 'author'.
 6831: 
 6832: =cut
 6833: 
 6834: ###############################################
 6835: sub get_users_function {
 6836:     my $function = 'norole';
 6837:     if ($env{'request.role'}=~/^(st)/) {
 6838:         $function='student';
 6839:     }
 6840:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
 6841:         $function='coordinator';
 6842:     }
 6843:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
 6844:         $function='admin';
 6845:     }
 6846:     if (($env{'request.role'}=~/^(au|ca)/) ||
 6847:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
 6848:         $function='author';
 6849:     }
 6850:     return $function;
 6851: }
 6852: 
 6853: ###############################################
 6854: 
 6855: =pod
 6856: 
 6857: =item * &show_course()
 6858: 
 6859: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
 6860: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
 6861: 
 6862: Inputs:
 6863: None
 6864: 
 6865: Outputs:
 6866: Scalar: 1 if 'Course' to be used, 0 otherwise.
 6867: 
 6868: =cut
 6869: 
 6870: ###############################################
 6871: sub show_course {
 6872:     my $course = !$env{'user.adv'};
 6873:     if (!$env{'user.adv'}) {
 6874:         foreach my $env (keys(%env)) {
 6875:             next if ($env !~ m/^user\.priv\./);
 6876:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
 6877:                 $course = 0;
 6878:                 last;
 6879:             }
 6880:         }
 6881:     }
 6882:     return $course;
 6883: }
 6884: 
 6885: ###############################################
 6886: 
 6887: =pod
 6888: 
 6889: =item * &check_user_status()
 6890: 
 6891: Determines current status of supplied role for a
 6892: specific user. Roles can be active, previous or future.
 6893: 
 6894: Inputs: 
 6895: user's domain, user's username, course's domain,
 6896: course's number, optional section ID.
 6897: 
 6898: Outputs:
 6899: role status: active, previous or future. 
 6900: 
 6901: =cut
 6902: 
 6903: sub check_user_status {
 6904:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
 6905:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
 6906:     my @uroles = keys %userinfo;
 6907:     my $srchstr;
 6908:     my $active_chk = 'none';
 6909:     my $now = time;
 6910:     if (@uroles > 0) {
 6911:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
 6912:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
 6913:         } else {
 6914:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
 6915:         }
 6916:         if (grep/^\Q$srchstr\E$/,@uroles) {
 6917:             my $role_end = 0;
 6918:             my $role_start = 0;
 6919:             $active_chk = 'active';
 6920:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
 6921:                 $role_end = $1;
 6922:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
 6923:                     $role_start = $1;
 6924:                 }
 6925:             }
 6926:             if ($role_start > 0) {
 6927:                 if ($now < $role_start) {
 6928:                     $active_chk = 'future';
 6929:                 }
 6930:             }
 6931:             if ($role_end > 0) {
 6932:                 if ($now > $role_end) {
 6933:                     $active_chk = 'previous';
 6934:                 }
 6935:             }
 6936:         }
 6937:     }
 6938:     return $active_chk;
 6939: }
 6940: 
 6941: ###############################################
 6942: 
 6943: =pod
 6944: 
 6945: =item * &get_sections()
 6946: 
 6947: Determines all the sections for a course including
 6948: sections with students and sections containing other roles.
 6949: Incoming parameters: 
 6950: 
 6951: 1. domain
 6952: 2. course number 
 6953: 3. reference to array containing roles for which sections should 
 6954: be gathered (optional).
 6955: 4. reference to array containing status types for which sections 
 6956: should be gathered (optional).
 6957: 
 6958: If the third argument is undefined, sections are gathered for any role. 
 6959: If the fourth argument is undefined, sections are gathered for any status.
 6960: Permissible values are 'active' or 'future' or 'previous'.
 6961:  
 6962: Returns section hash (keys are section IDs, values are
 6963: number of users in each section), subject to the
 6964: optional roles filter, optional status filter 
 6965: 
 6966: =cut
 6967: 
 6968: ###############################################
 6969: sub get_sections {
 6970:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
 6971:     if (!defined($cdom) || !defined($cnum)) {
 6972:         my $cid =  $env{'request.course.id'};
 6973: 
 6974: 	return if (!defined($cid));
 6975: 
 6976:         $cdom = $env{'course.'.$cid.'.domain'};
 6977:         $cnum = $env{'course.'.$cid.'.num'};
 6978:     }
 6979: 
 6980:     my %sectioncount;
 6981:     my $now = time;
 6982: 
 6983:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
 6984: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
 6985: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
 6986: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
 6987:         my $start_index = &Apache::loncoursedata::CL_START();
 6988:         my $end_index = &Apache::loncoursedata::CL_END();
 6989:         my $status;
 6990: 	while (my ($student,$data) = each(%$classlist)) {
 6991: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
 6992: 				                     $data->[$status_index],
 6993:                                                      $data->[$start_index],
 6994:                                                      $data->[$end_index]);
 6995:             if ($stu_status eq 'Active') {
 6996:                 $status = 'active';
 6997:             } elsif ($end < $now) {
 6998:                 $status = 'previous';
 6999:             } elsif ($start > $now) {
 7000:                 $status = 'future';
 7001:             } 
 7002: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
 7003:                 if ((!defined($possible_status)) || (($status ne '') && 
 7004:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
 7005: 		    $sectioncount{$section}++;
 7006:                 }
 7007: 	    }
 7008: 	}
 7009:     }
 7010:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
 7011:     foreach my $user (sort(keys(%courseroles))) {
 7012: 	if ($user !~ /^(\w{2})/) { next; }
 7013: 	my ($role) = ($user =~ /^(\w{2})/);
 7014: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
 7015: 	my ($section,$status);
 7016: 	if ($role eq 'cr' &&
 7017: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
 7018: 	    $section=$1;
 7019: 	}
 7020: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
 7021: 	if (!defined($section) || $section eq '-1') { next; }
 7022:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
 7023:         if ($end == -1 && $start == -1) {
 7024:             next; #deleted role
 7025:         }
 7026:         if (!defined($possible_status)) { 
 7027:             $sectioncount{$section}++;
 7028:         } else {
 7029:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
 7030:                 $status = 'active';
 7031:             } elsif ($end < $now) {
 7032:                 $status = 'future';
 7033:             } elsif ($start > $now) {
 7034:                 $status = 'previous';
 7035:             }
 7036:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
 7037:                 $sectioncount{$section}++;
 7038:             }
 7039:         }
 7040:     }
 7041:     return %sectioncount;
 7042: }
 7043: 
 7044: ###############################################
 7045: 
 7046: =pod
 7047: 
 7048: =item * &get_course_users()
 7049: 
 7050: Retrieves usernames:domains for users in the specified course
 7051: with specific role(s), and access status. 
 7052: 
 7053: Incoming parameters:
 7054: 1. course domain
 7055: 2. course number
 7056: 3. access status: users must have - either active, 
 7057: previous, future, or all.
 7058: 4. reference to array of permissible roles
 7059: 5. reference to array of section restrictions (optional)
 7060: 6. reference to results object (hash of hashes).
 7061: 7. reference to optional userdata hash
 7062: 8. reference to optional statushash
 7063: 9. flag if privileged users (except those set to unhide in
 7064:    course settings) should be excluded    
 7065: Keys of top level results hash are roles.
 7066: Keys of inner hashes are username:domain, with 
 7067: values set to access type.
 7068: Optional userdata hash returns an array with arguments in the 
 7069: same order as loncoursedata::get_classlist() for student data.
 7070: 
 7071: Optional statushash returns
 7072: 
 7073: Entries for end, start, section and status are blank because
 7074: of the possibility of multiple values for non-student roles.
 7075: 
 7076: =cut
 7077: 
 7078: ###############################################
 7079: 
 7080: sub get_course_users {
 7081:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
 7082:     my %idx = ();
 7083:     my %seclists;
 7084: 
 7085:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
 7086:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
 7087:     $idx{end} = &Apache::loncoursedata::CL_END();
 7088:     $idx{start} = &Apache::loncoursedata::CL_START();
 7089:     $idx{id} = &Apache::loncoursedata::CL_ID();
 7090:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
 7091:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
 7092:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
 7093: 
 7094:     if (grep(/^st$/,@{$roles})) {
 7095:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
 7096:         my $now = time;
 7097:         foreach my $student (keys(%{$classlist})) {
 7098:             my $match = 0;
 7099:             my $secmatch = 0;
 7100:             my $section = $$classlist{$student}[$idx{section}];
 7101:             my $status = $$classlist{$student}[$idx{status}];
 7102:             if ($section eq '') {
 7103:                 $section = 'none';
 7104:             }
 7105:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
 7106:                 if (grep(/^all$/,@{$sections})) {
 7107:                     $secmatch = 1;
 7108:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
 7109:                     if (grep(/^none$/,@{$sections})) {
 7110:                         $secmatch = 1;
 7111:                     }
 7112:                 } else {  
 7113: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
 7114: 		        $secmatch = 1;
 7115:                     }
 7116: 		}
 7117:                 if (!$secmatch) {
 7118:                     next;
 7119:                 }
 7120:             }
 7121:             if (defined($$types{'active'})) {
 7122:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
 7123:                     push(@{$$users{st}{$student}},'active');
 7124:                     $match = 1;
 7125:                 }
 7126:             }
 7127:             if (defined($$types{'previous'})) {
 7128:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
 7129:                     push(@{$$users{st}{$student}},'previous');
 7130:                     $match = 1;
 7131:                 }
 7132:             }
 7133:             if (defined($$types{'future'})) {
 7134:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
 7135:                     push(@{$$users{st}{$student}},'future');
 7136:                     $match = 1;
 7137:                 }
 7138:             }
 7139:             if ($match) {
 7140:                 push(@{$seclists{$student}},$section);
 7141:                 if (ref($userdata) eq 'HASH') {
 7142:                     $$userdata{$student} = $$classlist{$student};
 7143:                 }
 7144:                 if (ref($statushash) eq 'HASH') {
 7145:                     $statushash->{$student}{'st'}{$section} = $status;
 7146:                 }
 7147:             }
 7148:         }
 7149:     }
 7150:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
 7151:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
 7152:         my $now = time;
 7153:         my %displaystatus = ( previous => 'Expired',
 7154:                               active   => 'Active',
 7155:                               future   => 'Future',
 7156:                             );
 7157:         my %nothide;
 7158:         if ($hidepriv) {
 7159:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
 7160:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
 7161:                 if ($user !~ /:/) {
 7162:                     $nothide{join(':',split(/[\@]/,$user))}=1;
 7163:                 } else {
 7164:                     $nothide{$user} = 1;
 7165:                 }
 7166:             }
 7167:         }
 7168:         foreach my $person (sort(keys(%coursepersonnel))) {
 7169:             my $match = 0;
 7170:             my $secmatch = 0;
 7171:             my $status;
 7172:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
 7173:             $user =~ s/:$//;
 7174:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
 7175:             if ($end == -1 || $start == -1) {
 7176:                 next;
 7177:             }
 7178:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
 7179:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
 7180:                 my ($uname,$udom) = split(/:/,$user);
 7181:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
 7182:                     if (grep(/^all$/,@{$sections})) {
 7183:                         $secmatch = 1;
 7184:                     } elsif ($usec eq '') {
 7185:                         if (grep(/^none$/,@{$sections})) {
 7186:                             $secmatch = 1;
 7187:                         }
 7188:                     } else {
 7189:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
 7190:                             $secmatch = 1;
 7191:                         }
 7192:                     }
 7193:                     if (!$secmatch) {
 7194:                         next;
 7195:                     }
 7196:                 }
 7197:                 if ($usec eq '') {
 7198:                     $usec = 'none';
 7199:                 }
 7200:                 if ($uname ne '' && $udom ne '') {
 7201:                     if ($hidepriv) {
 7202:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
 7203:                             (!$nothide{$uname.':'.$udom})) {
 7204:                             next;
 7205:                         }
 7206:                     }
 7207:                     if ($end > 0 && $end < $now) {
 7208:                         $status = 'previous';
 7209:                     } elsif ($start > $now) {
 7210:                         $status = 'future';
 7211:                     } else {
 7212:                         $status = 'active';
 7213:                     }
 7214:                     foreach my $type (keys(%{$types})) { 
 7215:                         if ($status eq $type) {
 7216:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
 7217:                                 push(@{$$users{$role}{$user}},$type);
 7218:                             }
 7219:                             $match = 1;
 7220:                         }
 7221:                     }
 7222:                     if (($match) && (ref($userdata) eq 'HASH')) {
 7223:                         if (!exists($$userdata{$uname.':'.$udom})) {
 7224: 			    &get_user_info($udom,$uname,\%idx,$userdata);
 7225:                         }
 7226:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
 7227:                             push(@{$seclists{$uname.':'.$udom}},$usec);
 7228:                         }
 7229:                         if (ref($statushash) eq 'HASH') {
 7230:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
 7231:                         }
 7232:                     }
 7233:                 }
 7234:             }
 7235:         }
 7236:         if (grep(/^ow$/,@{$roles})) {
 7237:             if ((defined($cdom)) && (defined($cnum))) {
 7238:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
 7239:                 if ( defined($csettings{'internal.courseowner'}) ) {
 7240:                     my $owner = $csettings{'internal.courseowner'};
 7241:                     next if ($owner eq '');
 7242:                     my ($ownername,$ownerdom);
 7243:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
 7244:                         $ownername = $1;
 7245:                         $ownerdom = $2;
 7246:                     } else {
 7247:                         $ownername = $owner;
 7248:                         $ownerdom = $cdom;
 7249:                         $owner = $ownername.':'.$ownerdom;
 7250:                     }
 7251:                     @{$$users{'ow'}{$owner}} = 'any';
 7252:                     if (defined($userdata) && 
 7253: 			!exists($$userdata{$owner})) {
 7254: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
 7255:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
 7256:                             push(@{$seclists{$owner}},'none');
 7257:                         }
 7258:                         if (ref($statushash) eq 'HASH') {
 7259:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
 7260:                         }
 7261: 		    }
 7262:                 }
 7263:             }
 7264:         }
 7265:         foreach my $user (keys(%seclists)) {
 7266:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
 7267:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
 7268:         }
 7269:     }
 7270:     return;
 7271: }
 7272: 
 7273: sub get_user_info {
 7274:     my ($udom,$uname,$idx,$userdata) = @_;
 7275:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
 7276: 	&plainname($uname,$udom,'lastname');
 7277:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
 7278:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
 7279:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
 7280:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
 7281:     return;
 7282: }
 7283: 
 7284: ###############################################
 7285: 
 7286: =pod
 7287: 
 7288: =item * &get_user_quota()
 7289: 
 7290: Retrieves quota assigned for storage of portfolio files for a user  
 7291: 
 7292: Incoming parameters:
 7293: 1. user's username
 7294: 2. user's domain
 7295: 
 7296: Returns:
 7297: 1. Disk quota (in Mb) assigned to student.
 7298: 2. (Optional) Type of setting: custom or default
 7299:    (individually assigned or default for user's 
 7300:    institutional status).
 7301: 3. (Optional) - User's institutional status (e.g., faculty, staff
 7302:    or student - types as defined in localenroll::inst_usertypes 
 7303:    for user's domain, which determines default quota for user.
 7304: 4. (Optional) - Default quota which would apply to the user.
 7305: 
 7306: If a value has been stored in the user's environment, 
 7307: it will return that, otherwise it returns the maximal default
 7308: defined for the user's instituional status(es) in the domain.
 7309: 
 7310: =cut
 7311: 
 7312: ###############################################
 7313: 
 7314: 
 7315: sub get_user_quota {
 7316:     my ($uname,$udom) = @_;
 7317:     my ($quota,$quotatype,$settingstatus,$defquota);
 7318:     if (!defined($udom)) {
 7319:         $udom = $env{'user.domain'};
 7320:     }
 7321:     if (!defined($uname)) {
 7322:         $uname = $env{'user.name'};
 7323:     }
 7324:     if (($udom eq '' || $uname eq '') ||
 7325:         ($udom eq 'public') && ($uname eq 'public')) {
 7326:         $quota = 0;
 7327:         $quotatype = 'default';
 7328:         $defquota = 0; 
 7329:     } else {
 7330:         my $inststatus;
 7331:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
 7332:             $quota = $env{'environment.portfolioquota'};
 7333:             $inststatus = $env{'environment.inststatus'};
 7334:         } else {
 7335:             my %userenv = 
 7336:                 &Apache::lonnet::get('environment',['portfolioquota',
 7337:                                      'inststatus'],$udom,$uname);
 7338:             my ($tmp) = keys(%userenv);
 7339:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
 7340:                 $quota = $userenv{'portfolioquota'};
 7341:                 $inststatus = $userenv{'inststatus'};
 7342:             } else {
 7343:                 undef(%userenv);
 7344:             }
 7345:         }
 7346:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
 7347:         if ($quota eq '') {
 7348:             $quota = $defquota;
 7349:             $quotatype = 'default';
 7350:         } else {
 7351:             $quotatype = 'custom';
 7352:         }
 7353:     }
 7354:     if (wantarray) {
 7355:         return ($quota,$quotatype,$settingstatus,$defquota);
 7356:     } else {
 7357:         return $quota;
 7358:     }
 7359: }
 7360: 
 7361: ###############################################
 7362: 
 7363: =pod
 7364: 
 7365: =item * &default_quota()
 7366: 
 7367: Retrieves default quota assigned for storage of user portfolio files,
 7368: given an (optional) user's institutional status.
 7369: 
 7370: Incoming parameters:
 7371: 1. domain
 7372: 2. (Optional) institutional status(es).  This is a : separated list of 
 7373:    status types (e.g., faculty, staff, student etc.)
 7374:    which apply to the user for whom the default is being retrieved.
 7375:    If the institutional status string in undefined, the domain
 7376:    default quota will be returned. 
 7377: 
 7378: Returns:
 7379: 1. Default disk quota (in Mb) for user portfolios in the domain.
 7380: 2. (Optional) institutional type which determined the value of the
 7381:    default quota.
 7382: 
 7383: If a value has been stored in the domain's configuration db,
 7384: it will return that, otherwise it returns 20 (for backwards 
 7385: compatibility with domains which have not set up a configuration
 7386: db file; the original statically defined portfolio quota was 20 Mb). 
 7387: 
 7388: If the user's status includes multiple types (e.g., staff and student),
 7389: the largest default quota which applies to the user determines the
 7390: default quota returned.
 7391: 
 7392: =back
 7393: 
 7394: =cut
 7395: 
 7396: ###############################################
 7397: 
 7398: 
 7399: sub default_quota {
 7400:     my ($udom,$inststatus) = @_;
 7401:     my ($defquota,$settingstatus);
 7402:     my %quotahash = &Apache::lonnet::get_dom('configuration',
 7403:                                             ['quotas'],$udom);
 7404:     if (ref($quotahash{'quotas'}) eq 'HASH') {
 7405:         if ($inststatus ne '') {
 7406:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
 7407:             foreach my $item (@statuses) {
 7408:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
 7409:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
 7410:                         if ($defquota eq '') {
 7411:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
 7412:                             $settingstatus = $item;
 7413:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
 7414:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
 7415:                             $settingstatus = $item;
 7416:                         }
 7417:                     }
 7418:                 } else {
 7419:                     if ($quotahash{'quotas'}{$item} ne '') {
 7420:                         if ($defquota eq '') {
 7421:                             $defquota = $quotahash{'quotas'}{$item};
 7422:                             $settingstatus = $item;
 7423:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
 7424:                             $defquota = $quotahash{'quotas'}{$item};
 7425:                             $settingstatus = $item;
 7426:                         }
 7427:                     }
 7428:                 }
 7429:             }
 7430:         }
 7431:         if ($defquota eq '') {
 7432:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
 7433:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
 7434:             } else {
 7435:                 $defquota = $quotahash{'quotas'}{'default'};
 7436:             }
 7437:             $settingstatus = 'default';
 7438:         }
 7439:     } else {
 7440:         $settingstatus = 'default';
 7441:         $defquota = 20;
 7442:     }
 7443:     if (wantarray) {
 7444:         return ($defquota,$settingstatus);
 7445:     } else {
 7446:         return $defquota;
 7447:     }
 7448: }
 7449: 
 7450: sub get_secgrprole_info {
 7451:     my ($cdom,$cnum,$needroles,$type)  = @_;
 7452:     my %sections_count = &get_sections($cdom,$cnum);
 7453:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
 7454:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
 7455:     my @groups = sort(keys(%curr_groups));
 7456:     my $allroles = [];
 7457:     my $rolehash;
 7458:     my $accesshash = {
 7459:                      active => 'Currently has access',
 7460:                      future => 'Will have future access',
 7461:                      previous => 'Previously had access',
 7462:                   };
 7463:     if ($needroles) {
 7464:         $rolehash = {'all' => 'all'};
 7465:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
 7466: 	if (&Apache::lonnet::error(%user_roles)) {
 7467: 	    undef(%user_roles);
 7468: 	}
 7469:         foreach my $item (keys(%user_roles)) {
 7470:             my ($role)=split(/\:/,$item,2);
 7471:             if ($role eq 'cr') { next; }
 7472:             if ($role =~ /^cr/) {
 7473:                 $$rolehash{$role} = (split('/',$role))[3];
 7474:             } else {
 7475:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
 7476:             }
 7477:         }
 7478:         foreach my $key (sort(keys(%{$rolehash}))) {
 7479:             push(@{$allroles},$key);
 7480:         }
 7481:         push (@{$allroles},'st');
 7482:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
 7483:     }
 7484:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
 7485: }
 7486: 
 7487: sub user_picker {
 7488:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
 7489:     my $currdom = $dom;
 7490:     my %curr_selected = (
 7491:                         srchin => 'dom',
 7492:                         srchby => 'lastname',
 7493:                       );
 7494:     my $srchterm;
 7495:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
 7496:         if ($srch->{'srchby'} ne '') {
 7497:             $curr_selected{'srchby'} = $srch->{'srchby'};
 7498:         }
 7499:         if ($srch->{'srchin'} ne '') {
 7500:             $curr_selected{'srchin'} = $srch->{'srchin'};
 7501:         }
 7502:         if ($srch->{'srchtype'} ne '') {
 7503:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
 7504:         }
 7505:         if ($srch->{'srchdomain'} ne '') {
 7506:             $currdom = $srch->{'srchdomain'};
 7507:         }
 7508:         $srchterm = $srch->{'srchterm'};
 7509:     }
 7510:     my %lt=&Apache::lonlocal::texthash(
 7511:                     'usr'       => 'Search criteria',
 7512:                     'doma'      => 'Domain/institution to search',
 7513:                     'uname'     => 'username',
 7514:                     'lastname'  => 'last name',
 7515:                     'lastfirst' => 'last name, first name',
 7516:                     'crs'       => 'in this course',
 7517:                     'dom'       => 'in selected LON-CAPA domain', 
 7518:                     'alc'       => 'all LON-CAPA',
 7519:                     'instd'     => 'in institutional directory for selected domain',
 7520:                     'exact'     => 'is',
 7521:                     'contains'  => 'contains',
 7522:                     'begins'    => 'begins with',
 7523:                     'youm'      => "You must include some text to search for.",
 7524:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
 7525:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
 7526:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
 7527:                     'ymcd'      => "You must choose a domain when using a domain search.",
 7528:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
 7529:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
 7530:                      'thfo'     => "The following need to be corrected before the search can be run:",
 7531:                                        );
 7532:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
 7533:     my $srchinsel = ' <select name="srchin">';
 7534: 
 7535:     my @srchins = ('crs','dom','alc','instd');
 7536: 
 7537:     foreach my $option (@srchins) {
 7538:         # FIXME 'alc' option unavailable until 
 7539:         #       loncreateuser::print_user_query_page()
 7540:         #       has been completed.
 7541:         next if ($option eq 'alc');
 7542:         next if ($option eq 'crs' && !$env{'request.course.id'});
 7543:         if ($curr_selected{'srchin'} eq $option) {
 7544:             $srchinsel .= ' 
 7545:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
 7546:         } else {
 7547:             $srchinsel .= '
 7548:    <option value="'.$option.'">'.$lt{$option}.'</option>';
 7549:         }
 7550:     }
 7551:     $srchinsel .= "\n  </select>\n";
 7552: 
 7553:     my $srchbysel =  ' <select name="srchby">';
 7554:     foreach my $option ('lastname','lastfirst','uname') {
 7555:         if ($curr_selected{'srchby'} eq $option) {
 7556:             $srchbysel .= '
 7557:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
 7558:         } else {
 7559:             $srchbysel .= '
 7560:    <option value="'.$option.'">'.$lt{$option}.'</option>';
 7561:          }
 7562:     }
 7563:     $srchbysel .= "\n  </select>\n";
 7564: 
 7565:     my $srchtypesel = ' <select name="srchtype">';
 7566:     foreach my $option ('begins','contains','exact') {
 7567:         if ($curr_selected{'srchtype'} eq $option) {
 7568:             $srchtypesel .= '
 7569:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
 7570:         } else {
 7571:             $srchtypesel .= '
 7572:    <option value="'.$option.'">'.$lt{$option}.'</option>';
 7573:         }
 7574:     }
 7575:     $srchtypesel .= "\n  </select>\n";
 7576: 
 7577:     my ($newuserscript,$new_user_create);
 7578: 
 7579:     if ($forcenewuser) {
 7580:         if (ref($srch) eq 'HASH') {
 7581:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
 7582:                 if ($cancreate) {
 7583:                     $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>';
 7584:                 } else {
 7585:                     my $helplink = 'javascript:helpMenu('."'display'".')';
 7586:                     my %usertypetext = (
 7587:                         official   => 'institutional',
 7588:                         unofficial => 'non-institutional',
 7589:                     );
 7590:                     $new_user_create = '<p class="LC_warning">'
 7591:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
 7592:                                       .' '
 7593:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
 7594:                                           ,'<a href="'.$helplink.'">','</a>')
 7595:                                       .'</p><br />';
 7596:                 }
 7597:             }
 7598:         }
 7599: 
 7600:         $newuserscript = <<"ENDSCRIPT";
 7601: 
 7602: function setSearch(createnew,callingForm) {
 7603:     if (createnew == 1) {
 7604:         for (var i=0; i<callingForm.srchby.length; i++) {
 7605:             if (callingForm.srchby.options[i].value == 'uname') {
 7606:                 callingForm.srchby.selectedIndex = i;
 7607:             }
 7608:         }
 7609:         for (var i=0; i<callingForm.srchin.length; i++) {
 7610:             if ( callingForm.srchin.options[i].value == 'dom') {
 7611: 		callingForm.srchin.selectedIndex = i;
 7612:             }
 7613:         }
 7614:         for (var i=0; i<callingForm.srchtype.length; i++) {
 7615:             if (callingForm.srchtype.options[i].value == 'exact') {
 7616:                 callingForm.srchtype.selectedIndex = i;
 7617:             }
 7618:         }
 7619:         for (var i=0; i<callingForm.srchdomain.length; i++) {
 7620:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
 7621:                 callingForm.srchdomain.selectedIndex = i;
 7622:             }
 7623:         }
 7624:     }
 7625: }
 7626: ENDSCRIPT
 7627: 
 7628:     }
 7629: 
 7630:     my $output = <<"END_BLOCK";
 7631: <script type="text/javascript">
 7632: // <![CDATA[
 7633: function validateEntry(callingForm) {
 7634: 
 7635:     var checkok = 1;
 7636:     var srchin;
 7637:     for (var i=0; i<callingForm.srchin.length; i++) {
 7638: 	if ( callingForm.srchin[i].checked ) {
 7639: 	    srchin = callingForm.srchin[i].value;
 7640: 	}
 7641:     }
 7642: 
 7643:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
 7644:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
 7645:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
 7646:     var srchterm =  callingForm.srchterm.value;
 7647:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
 7648:     var msg = "";
 7649: 
 7650:     if (srchterm == "") {
 7651:         checkok = 0;
 7652:         msg += "$lt{'youm'}\\n";
 7653:     }
 7654: 
 7655:     if (srchtype== 'begins') {
 7656:         if (srchterm.length < 2) {
 7657:             checkok = 0;
 7658:             msg += "$lt{'thte'}\\n";
 7659:         }
 7660:     }
 7661: 
 7662:     if (srchtype== 'contains') {
 7663:         if (srchterm.length < 3) {
 7664:             checkok = 0;
 7665:             msg += "$lt{'thet'}\\n";
 7666:         }
 7667:     }
 7668:     if (srchin == 'instd') {
 7669:         if (srchdomain == '') {
 7670:             checkok = 0;
 7671:             msg += "$lt{'yomc'}\\n";
 7672:         }
 7673:     }
 7674:     if (srchin == 'dom') {
 7675:         if (srchdomain == '') {
 7676:             checkok = 0;
 7677:             msg += "$lt{'ymcd'}\\n";
 7678:         }
 7679:     }
 7680:     if (srchby == 'lastfirst') {
 7681:         if (srchterm.indexOf(",") == -1) {
 7682:             checkok = 0;
 7683:             msg += "$lt{'whus'}\\n";
 7684:         }
 7685:         if (srchterm.indexOf(",") == srchterm.length -1) {
 7686:             checkok = 0;
 7687:             msg += "$lt{'whse'}\\n";
 7688:         }
 7689:     }
 7690:     if (checkok == 0) {
 7691:         alert("$lt{'thfo'}\\n"+msg);
 7692:         return;
 7693:     }
 7694:     if (checkok == 1) {
 7695:         callingForm.submit();
 7696:     }
 7697: }
 7698: 
 7699: $newuserscript
 7700: 
 7701: // ]]>
 7702: </script>
 7703: 
 7704: $new_user_create
 7705: 
 7706: <table>
 7707:  <tr>
 7708:   <td>$lt{'doma'}:</td>
 7709:   <td>$domform</td>
 7710:   </td>
 7711:  </tr>
 7712:  <tr>
 7713:   <td>$lt{'usr'}:</td>
 7714:   <td>$srchbysel
 7715:       $srchtypesel 
 7716:       <input type="text" size="15" name="srchterm" value="$srchterm" />
 7717:       $srchinsel 
 7718:   </td>
 7719:  </tr>
 7720: </table>
 7721: <br />
 7722: END_BLOCK
 7723: 
 7724:     return $output;
 7725: }
 7726: 
 7727: sub user_rule_check {
 7728:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
 7729:     my $response;
 7730:     if (ref($usershash) eq 'HASH') {
 7731:         foreach my $user (keys(%{$usershash})) {
 7732:             my ($uname,$udom) = split(/:/,$user);
 7733:             next if ($udom eq '' || $uname eq '');
 7734:             my ($id,$newuser);
 7735:             if (ref($usershash->{$user}) eq 'HASH') {
 7736:                 $newuser = $usershash->{$user}->{'newuser'};
 7737:                 $id = $usershash->{$user}->{'id'};
 7738:             }
 7739:             my $inst_response;
 7740:             if (ref($checks) eq 'HASH') {
 7741:                 if (defined($checks->{'username'})) {
 7742:                     ($inst_response,%{$inst_results->{$user}}) = 
 7743:                         &Apache::lonnet::get_instuser($udom,$uname);
 7744:                 } elsif (defined($checks->{'id'})) {
 7745:                     ($inst_response,%{$inst_results->{$user}}) =
 7746:                         &Apache::lonnet::get_instuser($udom,undef,$id);
 7747:                 }
 7748:             } else {
 7749:                 ($inst_response,%{$inst_results->{$user}}) =
 7750:                     &Apache::lonnet::get_instuser($udom,$uname);
 7751:                 return;
 7752:             }
 7753:             if (!$got_rules->{$udom}) {
 7754:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
 7755:                                                   ['usercreation'],$udom);
 7756:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
 7757:                     foreach my $item ('username','id') {
 7758:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
 7759:                             $$curr_rules{$udom}{$item} = 
 7760:                                 $domconfig{'usercreation'}{$item.'_rule'};
 7761:                         }
 7762:                     }
 7763:                 }
 7764:                 $got_rules->{$udom} = 1;  
 7765:             }
 7766:             foreach my $item (keys(%{$checks})) {
 7767:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
 7768:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
 7769:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
 7770:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
 7771:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
 7772:                                 if ($rule_check{$rule}) {
 7773:                                     $$rulematch{$user}{$item} = $rule;
 7774:                                     if ($inst_response eq 'ok') {
 7775:                                         if (ref($inst_results) eq 'HASH') {
 7776:                                             if (ref($inst_results->{$user}) eq 'HASH') {
 7777:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
 7778:                                                     $$alerts{$item}{$udom}{$uname} = 1;
 7779:                                                 }
 7780:                                             }
 7781:                                         }
 7782:                                     }
 7783:                                     last;
 7784:                                 }
 7785:                             }
 7786:                         }
 7787:                     }
 7788:                 }
 7789:             }
 7790:         }
 7791:     }
 7792:     return;
 7793: }
 7794: 
 7795: sub user_rule_formats {
 7796:     my ($domain,$domdesc,$curr_rules,$check) = @_;
 7797:     my %text = ( 
 7798:                  'username' => 'Usernames',
 7799:                  'id'       => 'IDs',
 7800:                );
 7801:     my $output;
 7802:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
 7803:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
 7804:         if (@{$ruleorder} > 0) {
 7805:             $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>';
 7806:             foreach my $rule (@{$ruleorder}) {
 7807:                 if (ref($curr_rules) eq 'ARRAY') {
 7808:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
 7809:                         if (ref($rules->{$rule}) eq 'HASH') {
 7810:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
 7811:                                         $rules->{$rule}{'desc'}.'</li>';
 7812:                         }
 7813:                     }
 7814:                 }
 7815:             }
 7816:             $output .= '</ul>';
 7817:         }
 7818:     }
 7819:     return $output;
 7820: }
 7821: 
 7822: sub instrule_disallow_msg {
 7823:     my ($checkitem,$domdesc,$count,$mode) = @_;
 7824:     my $response;
 7825:     my %text = (
 7826:                   item   => 'username',
 7827:                   items  => 'usernames',
 7828:                   match  => 'matches',
 7829:                   do     => 'does',
 7830:                   action => 'a username',
 7831:                   one    => 'one',
 7832:                );
 7833:     if ($count > 1) {
 7834:         $text{'item'} = 'usernames';
 7835:         $text{'match'} ='match';
 7836:         $text{'do'} = 'do';
 7837:         $text{'action'} = 'usernames',
 7838:         $text{'one'} = 'ones';
 7839:     }
 7840:     if ($checkitem eq 'id') {
 7841:         $text{'items'} = 'IDs';
 7842:         $text{'item'} = 'ID';
 7843:         $text{'action'} = 'an ID';
 7844:         if ($count > 1) {
 7845:             $text{'item'} = 'IDs';
 7846:             $text{'action'} = 'IDs';
 7847:         }
 7848:     }
 7849:     $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 />';
 7850:     if ($mode eq 'upload') {
 7851:         if ($checkitem eq 'username') {
 7852:             $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'}.");
 7853:         } elsif ($checkitem eq 'id') {
 7854:             $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.");
 7855:         }
 7856:     } elsif ($mode eq 'selfcreate') {
 7857:         if ($checkitem eq 'id') {
 7858:             $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.");
 7859:         }
 7860:     } else {
 7861:         if ($checkitem eq 'username') {
 7862:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
 7863:         } elsif ($checkitem eq 'id') {
 7864:             $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.");
 7865:         }
 7866:     }
 7867:     return $response;
 7868: }
 7869: 
 7870: sub personal_data_fieldtitles {
 7871:     my %fieldtitles = &Apache::lonlocal::texthash (
 7872:                         id => 'Student/Employee ID',
 7873:                         permanentemail => 'E-mail address',
 7874:                         lastname => 'Last Name',
 7875:                         firstname => 'First Name',
 7876:                         middlename => 'Middle Name',
 7877:                         generation => 'Generation',
 7878:                         gen => 'Generation',
 7879:                         inststatus => 'Affiliation',
 7880:                    );
 7881:     return %fieldtitles;
 7882: }
 7883: 
 7884: sub sorted_inst_types {
 7885:     my ($dom) = @_;
 7886:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
 7887:     my $othertitle = &mt('All users');
 7888:     if ($env{'request.course.id'}) {
 7889:         $othertitle  = &mt('Any users');
 7890:     }
 7891:     my @types;
 7892:     if (ref($order) eq 'ARRAY') {
 7893:         @types = @{$order};
 7894:     }
 7895:     if (@types == 0) {
 7896:         if (ref($usertypes) eq 'HASH') {
 7897:             @types = sort(keys(%{$usertypes}));
 7898:         }
 7899:     }
 7900:     if (keys(%{$usertypes}) > 0) {
 7901:         $othertitle = &mt('Other users');
 7902:     }
 7903:     return ($othertitle,$usertypes,\@types);
 7904: }
 7905: 
 7906: sub get_institutional_codes {
 7907:     my ($settings,$allcourses,$LC_code) = @_;
 7908: # Get complete list of course sections to update
 7909:     my @currsections = ();
 7910:     my @currxlists = ();
 7911:     my $coursecode = $$settings{'internal.coursecode'};
 7912: 
 7913:     if ($$settings{'internal.sectionnums'} ne '') {
 7914:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
 7915:     }
 7916: 
 7917:     if ($$settings{'internal.crosslistings'} ne '') {
 7918:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
 7919:     }
 7920: 
 7921:     if (@currxlists > 0) {
 7922:         foreach (@currxlists) {
 7923:             if (m/^([^:]+):(\w*)$/) {
 7924:                 unless (grep/^$1$/,@{$allcourses}) {
 7925:                     push @{$allcourses},$1;
 7926:                     $$LC_code{$1} = $2;
 7927:                 }
 7928:             }
 7929:         }
 7930:     }
 7931:  
 7932:     if (@currsections > 0) {
 7933:         foreach (@currsections) {
 7934:             if (m/^(\w+):(\w*)$/) {
 7935:                 my $sec = $coursecode.$1;
 7936:                 my $lc_sec = $2;
 7937:                 unless (grep/^$sec$/,@{$allcourses}) {
 7938:                     push @{$allcourses},$sec;
 7939:                     $$LC_code{$sec} = $lc_sec;
 7940:                 }
 7941:             }
 7942:         }
 7943:     }
 7944:     return;
 7945: }
 7946: 
 7947: =pod
 7948: 
 7949: =head1 Slot Helpers
 7950: 
 7951: =over 4
 7952: 
 7953: =item * sorted_slots()
 7954: 
 7955: Sorts an array of slot names in order of slot start time (earliest first). 
 7956: 
 7957: Inputs:
 7958: 
 7959: =over 4
 7960: 
 7961: slotsarr  - Reference to array of unsorted slot names.
 7962: 
 7963: slots     - Reference to hash of hash, where outer hash keys are slot names.
 7964: 
 7965: =back
 7966: 
 7967: Returns:
 7968: 
 7969: =over 4
 7970: 
 7971: sorted   - An array of slot names sorted by the start time of the slot.
 7972: 
 7973: =back
 7974: 
 7975: =back
 7976: 
 7977: =cut
 7978: 
 7979: 
 7980: sub sorted_slots {
 7981:     my ($slotsarr,$slots) = @_;
 7982:     my @sorted;
 7983:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
 7984:         @sorted =
 7985:             sort {
 7986:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
 7987:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
 7988:                      }
 7989:                      if (ref($slots->{$a})) { return -1;}
 7990:                      if (ref($slots->{$b})) { return 1;}
 7991:                      return 0;
 7992:                  } @{$slotsarr};
 7993:     }
 7994:     return @sorted;
 7995: }
 7996: 
 7997: 
 7998: =pod
 7999: 
 8000: =head1 HTTP Helpers
 8001: 
 8002: =over 4
 8003: 
 8004: =item * &get_unprocessed_cgi($query,$possible_names)
 8005: 
 8006: Modify the %env hash to contain unprocessed CGI form parameters held in
 8007: $query.  The parameters listed in $possible_names (an array reference),
 8008: will be set in $env{'form.name'} if they do not already exist.
 8009: 
 8010: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
 8011: $possible_names is an ref to an array of form element names.  As an example:
 8012: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
 8013: will result in $env{'form.uname'} and $env{'form.udom'} being set.
 8014: 
 8015: =cut
 8016: 
 8017: sub get_unprocessed_cgi {
 8018:   my ($query,$possible_names)= @_;
 8019:   # $Apache::lonxml::debug=1;
 8020:   foreach my $pair (split(/&/,$query)) {
 8021:     my ($name, $value) = split(/=/,$pair);
 8022:     $name = &unescape($name);
 8023:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
 8024:       $value =~ tr/+/ /;
 8025:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
 8026:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
 8027:     }
 8028:   }
 8029: }
 8030: 
 8031: =pod
 8032: 
 8033: =item * &cacheheader() 
 8034: 
 8035: returns cache-controlling header code
 8036: 
 8037: =cut
 8038: 
 8039: sub cacheheader {
 8040:     unless ($env{'request.method'} eq 'GET') { return ''; }
 8041:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
 8042:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
 8043:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
 8044:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
 8045:     return $output;
 8046: }
 8047: 
 8048: =pod
 8049: 
 8050: =item * &no_cache($r) 
 8051: 
 8052: specifies header code to not have cache
 8053: 
 8054: =cut
 8055: 
 8056: sub no_cache {
 8057:     my ($r) = @_;
 8058:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
 8059: 	$env{'request.method'} ne 'GET') { return ''; }
 8060:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
 8061:     $r->no_cache(1);
 8062:     $r->header_out("Expires" => $date);
 8063:     $r->header_out("Pragma" => "no-cache");
 8064: }
 8065: 
 8066: sub content_type {
 8067:     my ($r,$type,$charset) = @_;
 8068:     if ($r) {
 8069: 	#  Note that printout.pl calls this with undef for $r.
 8070: 	&no_cache($r);
 8071:     }
 8072:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
 8073:     unless ($charset) {
 8074: 	$charset=&Apache::lonlocal::current_encoding;
 8075:     }
 8076:     if ($charset) { $type.='; charset='.$charset; }
 8077:     if ($r) {
 8078: 	$r->content_type($type);
 8079:     } else {
 8080: 	print("Content-type: $type\n\n");
 8081:     }
 8082: }
 8083: 
 8084: =pod
 8085: 
 8086: =item * &add_to_env($name,$value) 
 8087: 
 8088: adds $name to the %env hash with value
 8089: $value, if $name already exists, the entry is converted to an array
 8090: reference and $value is added to the array.
 8091: 
 8092: =cut
 8093: 
 8094: sub add_to_env {
 8095:   my ($name,$value)=@_;
 8096:   if (defined($env{$name})) {
 8097:     if (ref($env{$name})) {
 8098:       #already have multiple values
 8099:       push(@{ $env{$name} },$value);
 8100:     } else {
 8101:       #first time seeing multiple values, convert hash entry to an arrayref
 8102:       my $first=$env{$name};
 8103:       undef($env{$name});
 8104:       push(@{ $env{$name} },$first,$value);
 8105:     }
 8106:   } else {
 8107:     $env{$name}=$value;
 8108:   }
 8109: }
 8110: 
 8111: =pod
 8112: 
 8113: =item * &get_env_multiple($name) 
 8114: 
 8115: gets $name from the %env hash, it seemlessly handles the cases where multiple
 8116: values may be defined and end up as an array ref.
 8117: 
 8118: returns an array of values
 8119: 
 8120: =cut
 8121: 
 8122: sub get_env_multiple {
 8123:     my ($name) = @_;
 8124:     my @values;
 8125:     if (defined($env{$name})) {
 8126:         # exists is it an array
 8127:         if (ref($env{$name})) {
 8128:             @values=@{ $env{$name} };
 8129:         } else {
 8130:             $values[0]=$env{$name};
 8131:         }
 8132:     }
 8133:     return(@values);
 8134: }
 8135: 
 8136: sub ask_for_embedded_content {
 8137:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
 8138:     my $upload_output = '
 8139:    <form name="upload_embedded" action="'.$actionurl.'"
 8140:                   method="post" enctype="multipart/form-data">';
 8141:     $upload_output .= $state;
 8142:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
 8143: 
 8144:     my $num = 0;
 8145:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
 8146:         $upload_output .= &start_data_table_row().
 8147:             '<td>'.$embed_file.'</td><td>';
 8148:         if ($args->{'ignore_remote_references'}
 8149:             && $embed_file =~ m{^\w+://}) {
 8150:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
 8151:         } elsif ($args->{'error_on_invalid_names'}
 8152:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
 8153: 
 8154:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
 8155: 
 8156:         } else {
 8157:             $upload_output .='
 8158:            <input name="embedded_item_'.$num.'" type="file" value="" />
 8159:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
 8160:             my $attrib = join(':',@{$$allfiles{$embed_file}});
 8161:             $upload_output .=
 8162:                 "\n\t\t".
 8163:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
 8164:                 $attrib.'" />';
 8165:             if (exists($$codebase{$embed_file})) {
 8166:                 $upload_output .=
 8167:                     "\n\t\t".
 8168:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
 8169:                     &escape($$codebase{$embed_file}).'" />';
 8170:             }
 8171:         }
 8172:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
 8173:         $num++;
 8174:     }
 8175:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
 8176:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
 8177:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
 8178:    '.&mt('(only files for which a location has been provided will be uploaded)').'
 8179:    </form>';
 8180:     return $upload_output;
 8181: }
 8182: 
 8183: sub upload_embedded {
 8184:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
 8185:         $current_disk_usage) = @_;
 8186:     my $output;
 8187:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
 8188:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
 8189:         my $orig_uploaded_filename =
 8190:             $env{'form.embedded_item_'.$i.'.filename'};
 8191: 
 8192:         $env{'form.embedded_orig_'.$i} =
 8193:             &unescape($env{'form.embedded_orig_'.$i});
 8194:         my ($path,$fname) =
 8195:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
 8196:         # no path, whole string is fname
 8197:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
 8198: 
 8199:         $path = $env{'form.currentpath'}.$path;
 8200:         $fname = &Apache::lonnet::clean_filename($fname);
 8201:         # See if there is anything left
 8202:         next if ($fname eq '');
 8203: 
 8204:         # Check if file already exists as a file or directory.
 8205:         my ($state,$msg);
 8206:         if ($context eq 'portfolio') {
 8207:             my $port_path = $dirpath;
 8208:             if ($group ne '') {
 8209:                 $port_path = "groups/$group/$port_path";
 8210:             }
 8211:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
 8212:                                               $dir_root,$port_path,$disk_quota,
 8213:                                               $current_disk_usage,$uname,$udom);
 8214:             if ($state eq 'will_exceed_quota'
 8215:                 || $state eq 'file_locked'
 8216:                 || $state eq 'file_exists' ) {
 8217:                 $output .= $msg;
 8218:                 next;
 8219:             }
 8220:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
 8221:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
 8222:             if ($state eq 'exists') {
 8223:                 $output .= $msg;
 8224:                 next;
 8225:             }
 8226:         }
 8227:         # Check if extension is valid
 8228:         if (($fname =~ /\.(\w+)$/) &&
 8229:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
 8230:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
 8231:             next;
 8232:         } elsif (($fname =~ /\.(\w+)$/) &&
 8233:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
 8234:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
 8235:             next;
 8236:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
 8237:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
 8238:             next;
 8239:         }
 8240: 
 8241:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
 8242:         if ($context eq 'portfolio') {
 8243:             my $result=
 8244:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
 8245:                                                 $dirpath.$path);
 8246:             if ($result !~ m|^/uploaded/|) {
 8247:                 $output .= '<span class="LC_error">'
 8248:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
 8249:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
 8250:                       .'</span><br />';
 8251:                 next;
 8252:             } else {
 8253:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
 8254:                            $path.$fname.'</span>').'</p>';     
 8255:             }
 8256:         } else {
 8257: # Save the file
 8258:             my $target = $env{'form.embedded_item_'.$i};
 8259:             my $fullpath = $dir_root.$dirpath.'/'.$path;
 8260:             my $dest = $fullpath.$fname;
 8261:             my $url = $url_root.$dirpath.'/'.$path.$fname;
 8262:             my @parts=split(/\//,$fullpath);
 8263:             my $count;
 8264:             my $filepath = $dir_root;
 8265:             for ($count=4;$count<=$#parts;$count++) {
 8266:                 $filepath .= "/$parts[$count]";
 8267:                 if ((-e $filepath)!=1) {
 8268:                     mkdir($filepath,0770);
 8269:                 }
 8270:             }
 8271:             my $fh;
 8272:             if (!open($fh,'>'.$dest)) {
 8273:                 &Apache::lonnet::logthis('Failed to create '.$dest);
 8274:                 $output .= '<span class="LC_error">'.
 8275:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
 8276:                            '</span><br />';
 8277:             } else {
 8278:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
 8279:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
 8280:                     $output .= '<span class="LC_error">'.
 8281:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
 8282:                               '</span><br />';
 8283:                 } else {
 8284:                     if ($context eq 'testbank') {
 8285:                         $output .= &mt('Embedded file uploaded successfully:').
 8286:                                    '&nbsp;<a href="'.$url.'">'.
 8287:                                    $orig_uploaded_filename.'</a><br />';
 8288:                     } else {
 8289:                         $output .= '<span class=\"LC_fontsize_large\">'.
 8290:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
 8291:                                    $orig_uploaded_filename.'</a>').'</span><br />';
 8292:                     }
 8293:                 }
 8294:                 close($fh);
 8295:             }
 8296:         }
 8297:     }
 8298:     return $output;
 8299: }
 8300: 
 8301: sub check_for_existing {
 8302:     my ($path,$fname,$element) = @_;
 8303:     my ($state,$msg);
 8304:     if (-d $path.'/'.$fname) {
 8305:         $state = 'exists';
 8306:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
 8307:     } elsif (-e $path.'/'.$fname) {
 8308:         $state = 'exists';
 8309:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
 8310:     }
 8311:     if ($state eq 'exists') {
 8312:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
 8313:     }
 8314:     return ($state,$msg);
 8315: }
 8316: 
 8317: sub check_for_upload {
 8318:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
 8319:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
 8320:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
 8321:     my $getpropath = 1;
 8322:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
 8323:                                             $getpropath);
 8324:     my $found_file = 0;
 8325:     my $locked_file = 0;
 8326:     foreach my $line (@dir_list) {
 8327:         my ($file_name)=split(/\&/,$line,2);
 8328:         if ($file_name eq $fname){
 8329:             $file_name = $path.$file_name;
 8330:             if ($group ne '') {
 8331:                 $file_name = $group.$file_name;
 8332:             }
 8333:             $found_file = 1;
 8334:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
 8335:                 $locked_file = 1;
 8336:             }
 8337:         }
 8338:     }
 8339:     if (($current_disk_usage + $filesize) > $disk_quota){
 8340:         my $msg = '<span class="LC_error">'.
 8341:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
 8342:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
 8343:         return ('will_exceed_quota',$msg);
 8344:     } elsif ($found_file) {
 8345:         if ($locked_file) {
 8346:             my $msg = '<span class="LC_error">';
 8347:             $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>');
 8348:             $msg .= '</span><br />';
 8349:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
 8350:             return ('file_locked',$msg);
 8351:         } else {
 8352:             my $msg = '<span class="LC_error">';
 8353:             $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'});
 8354:             $msg .= '</span>';
 8355:             $msg .= '<br />';
 8356:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
 8357:             return ('file_exists',$msg);
 8358:         }
 8359:     }
 8360: }
 8361: 
 8362: 
 8363: =pod
 8364: 
 8365: =back
 8366: 
 8367: =head1 CSV Upload/Handling functions
 8368: 
 8369: =over 4
 8370: 
 8371: =item * &upfile_store($r)
 8372: 
 8373: Store uploaded file, $r should be the HTTP Request object,
 8374: needs $env{'form.upfile'}
 8375: returns $datatoken to be put into hidden field
 8376: 
 8377: =cut
 8378: 
 8379: sub upfile_store {
 8380:     my $r=shift;
 8381:     $env{'form.upfile'}=~s/\r/\n/gs;
 8382:     $env{'form.upfile'}=~s/\f/\n/gs;
 8383:     $env{'form.upfile'}=~s/\n+/\n/gs;
 8384:     $env{'form.upfile'}=~s/\n+$//gs;
 8385: 
 8386:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
 8387: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
 8388:     {
 8389:         my $datafile = $r->dir_config('lonDaemons').
 8390:                            '/tmp/'.$datatoken.'.tmp';
 8391:         if ( open(my $fh,">$datafile") ) {
 8392:             print $fh $env{'form.upfile'};
 8393:             close($fh);
 8394:         }
 8395:     }
 8396:     return $datatoken;
 8397: }
 8398: 
 8399: =pod
 8400: 
 8401: =item * &load_tmp_file($r)
 8402: 
 8403: Load uploaded file from tmp, $r should be the HTTP Request object,
 8404: needs $env{'form.datatoken'},
 8405: sets $env{'form.upfile'} to the contents of the file
 8406: 
 8407: =cut
 8408: 
 8409: sub load_tmp_file {
 8410:     my $r=shift;
 8411:     my @studentdata=();
 8412:     {
 8413:         my $studentfile = $r->dir_config('lonDaemons').
 8414:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
 8415:         if ( open(my $fh,"<$studentfile") ) {
 8416:             @studentdata=<$fh>;
 8417:             close($fh);
 8418:         }
 8419:     }
 8420:     $env{'form.upfile'}=join('',@studentdata);
 8421: }
 8422: 
 8423: =pod
 8424: 
 8425: =item * &upfile_record_sep()
 8426: 
 8427: Separate uploaded file into records
 8428: returns array of records,
 8429: needs $env{'form.upfile'} and $env{'form.upfiletype'}
 8430: 
 8431: =cut
 8432: 
 8433: sub upfile_record_sep {
 8434:     if ($env{'form.upfiletype'} eq 'xml') {
 8435:     } else {
 8436: 	my @records;
 8437: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
 8438: 	    if ($line=~/^\s*$/) { next; }
 8439: 	    push(@records,$line);
 8440: 	}
 8441: 	return @records;
 8442:     }
 8443: }
 8444: 
 8445: =pod
 8446: 
 8447: =item * &record_sep($record)
 8448: 
 8449: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
 8450: 
 8451: =cut
 8452: 
 8453: sub takeleft {
 8454:     my $index=shift;
 8455:     return substr('0000'.$index,-4,4);
 8456: }
 8457: 
 8458: sub record_sep {
 8459:     my $record=shift;
 8460:     my %components=();
 8461:     if ($env{'form.upfiletype'} eq 'xml') {
 8462:     } elsif ($env{'form.upfiletype'} eq 'space') {
 8463:         my $i=0;
 8464:         foreach my $field (split(/\s+/,$record)) {
 8465:             $field=~s/^(\"|\')//;
 8466:             $field=~s/(\"|\')$//;
 8467:             $components{&takeleft($i)}=$field;
 8468:             $i++;
 8469:         }
 8470:     } elsif ($env{'form.upfiletype'} eq 'tab') {
 8471:         my $i=0;
 8472:         foreach my $field (split(/\t/,$record)) {
 8473:             $field=~s/^(\"|\')//;
 8474:             $field=~s/(\"|\')$//;
 8475:             $components{&takeleft($i)}=$field;
 8476:             $i++;
 8477:         }
 8478:     } else {
 8479:         my $separator=',';
 8480:         if ($env{'form.upfiletype'} eq 'semisv') {
 8481:             $separator=';';
 8482:         }
 8483:         my $i=0;
 8484: # the character we are looking for to indicate the end of a quote or a record 
 8485:         my $looking_for=$separator;
 8486: # do not add the characters to the fields
 8487:         my $ignore=0;
 8488: # we just encountered a separator (or the beginning of the record)
 8489:         my $just_found_separator=1;
 8490: # store the field we are working on here
 8491:         my $field='';
 8492: # work our way through all characters in record
 8493:         foreach my $character ($record=~/(.)/g) {
 8494:             if ($character eq $looking_for) {
 8495:                if ($character ne $separator) {
 8496: # Found the end of a quote, again looking for separator
 8497:                   $looking_for=$separator;
 8498:                   $ignore=1;
 8499:                } else {
 8500: # Found a separator, store away what we got
 8501:                   $components{&takeleft($i)}=$field;
 8502: 	          $i++;
 8503:                   $just_found_separator=1;
 8504:                   $ignore=0;
 8505:                   $field='';
 8506:                }
 8507:                next;
 8508:             }
 8509: # single or double quotation marks after a separator indicate beginning of a quote
 8510: # we are now looking for the end of the quote and need to ignore separators
 8511:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
 8512:                $looking_for=$character;
 8513:                next;
 8514:             }
 8515: # ignore would be true after we reached the end of a quote
 8516:             if ($ignore) { next; }
 8517:             if (($just_found_separator) && ($character=~/\s/)) { next; }
 8518:             $field.=$character;
 8519:             $just_found_separator=0; 
 8520:         }
 8521: # catch the very last entry, since we never encountered the separator
 8522:         $components{&takeleft($i)}=$field;
 8523:     }
 8524:     return %components;
 8525: }
 8526: 
 8527: ######################################################
 8528: ######################################################
 8529: 
 8530: =pod
 8531: 
 8532: =item * &upfile_select_html()
 8533: 
 8534: Return HTML code to select a file from the users machine and specify 
 8535: the file type.
 8536: 
 8537: =cut
 8538: 
 8539: ######################################################
 8540: ######################################################
 8541: sub upfile_select_html {
 8542:     my %Types = (
 8543:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
 8544:                  semisv => &mt('Semicolon separated values'),
 8545:                  space => &mt('Space separated'),
 8546:                  tab   => &mt('Tabulator separated'),
 8547: #                 xml   => &mt('HTML/XML'),
 8548:                  );
 8549:     my $Str = '<input type="file" name="upfile" size="50" />'.
 8550:         '<br />'.&mt('Type').': <select name="upfiletype">';
 8551:     foreach my $type (sort(keys(%Types))) {
 8552:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
 8553:     }
 8554:     $Str .= "</select>\n";
 8555:     return $Str;
 8556: }
 8557: 
 8558: sub get_samples {
 8559:     my ($records,$toget) = @_;
 8560:     my @samples=({});
 8561:     my $got=0;
 8562:     foreach my $rec (@$records) {
 8563: 	my %temp = &record_sep($rec);
 8564: 	if (! grep(/\S/, values(%temp))) { next; }
 8565: 	if (%temp) {
 8566: 	    $samples[$got]=\%temp;
 8567: 	    $got++;
 8568: 	    if ($got == $toget) { last; }
 8569: 	}
 8570:     }
 8571:     return \@samples;
 8572: }
 8573: 
 8574: ######################################################
 8575: ######################################################
 8576: 
 8577: =pod
 8578: 
 8579: =item * &csv_print_samples($r,$records)
 8580: 
 8581: Prints a table of sample values from each column uploaded $r is an
 8582: Apache Request ref, $records is an arrayref from
 8583: &Apache::loncommon::upfile_record_sep
 8584: 
 8585: =cut
 8586: 
 8587: ######################################################
 8588: ######################################################
 8589: sub csv_print_samples {
 8590:     my ($r,$records) = @_;
 8591:     my $samples = &get_samples($records,5);
 8592: 
 8593:     $r->print(&mt('Samples').'<br />'.&start_data_table().
 8594:               &start_data_table_header_row());
 8595:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
 8596:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
 8597:     $r->print(&end_data_table_header_row());
 8598:     foreach my $hash (@$samples) {
 8599: 	$r->print(&start_data_table_row());
 8600: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
 8601: 	    $r->print('<td>');
 8602: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
 8603: 	    $r->print('</td>');
 8604: 	}
 8605: 	$r->print(&end_data_table_row());
 8606:     }
 8607:     $r->print(&end_data_table().'<br />'."\n");
 8608: }
 8609: 
 8610: ######################################################
 8611: ######################################################
 8612: 
 8613: =pod
 8614: 
 8615: =item * &csv_print_select_table($r,$records,$d)
 8616: 
 8617: Prints a table to create associations between values and table columns.
 8618: 
 8619: $r is an Apache Request ref,
 8620: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
 8621: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
 8622: 
 8623: =cut
 8624: 
 8625: ######################################################
 8626: ######################################################
 8627: sub csv_print_select_table {
 8628:     my ($r,$records,$d) = @_;
 8629:     my $i=0;
 8630:     my $samples = &get_samples($records,1);
 8631:     $r->print(&mt('Associate columns with student attributes.')."\n".
 8632: 	      &start_data_table().&start_data_table_header_row().
 8633:               '<th>'.&mt('Attribute').'</th>'.
 8634:               '<th>'.&mt('Column').'</th>'.
 8635:               &end_data_table_header_row()."\n");
 8636:     foreach my $array_ref (@$d) {
 8637: 	my ($value,$display,$defaultcol)=@{ $array_ref };
 8638: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
 8639: 
 8640: 	$r->print('<td><select name=f'.$i.
 8641: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
 8642: 	$r->print('<option value="none"></option>');
 8643: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
 8644: 	    $r->print('<option value="'.$sample.'"'.
 8645:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
 8646:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
 8647: 	}
 8648: 	$r->print('</select></td>'.&end_data_table_row()."\n");
 8649: 	$i++;
 8650:     }
 8651:     $r->print(&end_data_table());
 8652:     $i--;
 8653:     return $i;
 8654: }
 8655: 
 8656: ######################################################
 8657: ######################################################
 8658: 
 8659: =pod
 8660: 
 8661: =item * &csv_samples_select_table($r,$records,$d)
 8662: 
 8663: Prints a table of sample values from the upload and can make associate samples to internal names.
 8664: 
 8665: $r is an Apache Request ref,
 8666: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
 8667: $d is an array of 2 element arrays (internal name, displayed name)
 8668: 
 8669: =cut
 8670: 
 8671: ######################################################
 8672: ######################################################
 8673: sub csv_samples_select_table {
 8674:     my ($r,$records,$d) = @_;
 8675:     my $i=0;
 8676:     #
 8677:     my $max_samples = 5;
 8678:     my $samples = &get_samples($records,$max_samples);
 8679:     $r->print(&start_data_table().
 8680:               &start_data_table_header_row().'<th>'.
 8681:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
 8682:               &end_data_table_header_row());
 8683: 
 8684:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
 8685: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
 8686: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
 8687: 	foreach my $option (@$d) {
 8688: 	    my ($value,$display,$defaultcol)=@{ $option };
 8689: 	    $r->print('<option value="'.$value.'"'.
 8690:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
 8691:                       $display.'</option>');
 8692: 	}
 8693: 	$r->print('</select></td><td>');
 8694: 	foreach my $line (0..($max_samples-1)) {
 8695: 	    if (defined($samples->[$line]{$key})) { 
 8696: 		$r->print($samples->[$line]{$key}."<br />\n"); 
 8697: 	    }
 8698: 	}
 8699: 	$r->print('</td>'.&end_data_table_row());
 8700: 	$i++;
 8701:     }
 8702:     $r->print(&end_data_table());
 8703:     $i--;
 8704:     return($i);
 8705: }
 8706: 
 8707: ######################################################
 8708: ######################################################
 8709: 
 8710: =pod
 8711: 
 8712: =item * &clean_excel_name($name)
 8713: 
 8714: Returns a replacement for $name which does not contain any illegal characters.
 8715: 
 8716: =cut
 8717: 
 8718: ######################################################
 8719: ######################################################
 8720: sub clean_excel_name {
 8721:     my ($name) = @_;
 8722:     $name =~ s/[:\*\?\/\\]//g;
 8723:     if (length($name) > 31) {
 8724:         $name = substr($name,0,31);
 8725:     }
 8726:     return $name;
 8727: }
 8728: 
 8729: =pod
 8730: 
 8731: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
 8732: 
 8733: Returns either 1 or undef
 8734: 
 8735: 1 if the part is to be hidden, undef if it is to be shown
 8736: 
 8737: Arguments are:
 8738: 
 8739: $id the id of the part to be checked
 8740: $symb, optional the symb of the resource to check
 8741: $udom, optional the domain of the user to check for
 8742: $uname, optional the username of the user to check for
 8743: 
 8744: =cut
 8745: 
 8746: sub check_if_partid_hidden {
 8747:     my ($id,$symb,$udom,$uname) = @_;
 8748:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
 8749: 					 $symb,$udom,$uname);
 8750:     my $truth=1;
 8751:     #if the string starts with !, then the list is the list to show not hide
 8752:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
 8753:     my @hiddenlist=split(/,/,$hiddenparts);
 8754:     foreach my $checkid (@hiddenlist) {
 8755: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
 8756:     }
 8757:     return !$truth;
 8758: }
 8759: 
 8760: 
 8761: ############################################################
 8762: ############################################################
 8763: 
 8764: =pod
 8765: 
 8766: =back 
 8767: 
 8768: =head1 cgi-bin script and graphing routines
 8769: 
 8770: =over 4
 8771: 
 8772: =item * &get_cgi_id()
 8773: 
 8774: Inputs: none
 8775: 
 8776: Returns an id which can be used to pass environment variables
 8777: to various cgi-bin scripts.  These environment variables will
 8778: be removed from the users environment after a given time by
 8779: the routine &Apache::lonnet::transfer_profile_to_env.
 8780: 
 8781: =cut
 8782: 
 8783: ############################################################
 8784: ############################################################
 8785: my $uniq=0;
 8786: sub get_cgi_id {
 8787:     $uniq=($uniq+1)%100000;
 8788:     return (time.'_'.$$.'_'.$uniq);
 8789: }
 8790: 
 8791: ############################################################
 8792: ############################################################
 8793: 
 8794: =pod
 8795: 
 8796: =item * &DrawBarGraph()
 8797: 
 8798: Facilitates the plotting of data in a (stacked) bar graph.
 8799: Puts plot definition data into the users environment in order for 
 8800: graph.png to plot it.  Returns an <img> tag for the plot.
 8801: The bars on the plot are labeled '1','2',...,'n'.
 8802: 
 8803: Inputs:
 8804: 
 8805: =over 4
 8806: 
 8807: =item $Title: string, the title of the plot
 8808: 
 8809: =item $xlabel: string, text describing the X-axis of the plot
 8810: 
 8811: =item $ylabel: string, text describing the Y-axis of the plot
 8812: 
 8813: =item $Max: scalar, the maximum Y value to use in the plot
 8814: If $Max is < any data point, the graph will not be rendered.
 8815: 
 8816: =item $colors: array ref holding the colors to be used for the data sets when
 8817: they are plotted.  If undefined, default values will be used.
 8818: 
 8819: =item $labels: array ref holding the labels to use on the x-axis for the bars.
 8820: 
 8821: =item @Values: An array of array references.  Each array reference holds data
 8822: to be plotted in a stacked bar chart.
 8823: 
 8824: =item If the final element of @Values is a hash reference the key/value
 8825: pairs will be added to the graph definition.
 8826: 
 8827: =back
 8828: 
 8829: Returns:
 8830: 
 8831: An <img> tag which references graph.png and the appropriate identifying
 8832: information for the plot.
 8833: 
 8834: =cut
 8835: 
 8836: ############################################################
 8837: ############################################################
 8838: sub DrawBarGraph {
 8839:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
 8840:     #
 8841:     if (! defined($colors)) {
 8842:         $colors = ['#33ff00', 
 8843:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
 8844:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
 8845:                   ]; 
 8846:     }
 8847:     my $extra_settings = {};
 8848:     if (ref($Values[-1]) eq 'HASH') {
 8849:         $extra_settings = pop(@Values);
 8850:     }
 8851:     #
 8852:     my $identifier = &get_cgi_id();
 8853:     my $id = 'cgi.'.$identifier;        
 8854:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
 8855:         return '';
 8856:     }
 8857:     #
 8858:     my @Labels;
 8859:     if (defined($labels)) {
 8860:         @Labels = @$labels;
 8861:     } else {
 8862:         for (my $i=0;$i<@{$Values[0]};$i++) {
 8863:             push (@Labels,$i+1);
 8864:         }
 8865:     }
 8866:     #
 8867:     my $NumBars = scalar(@{$Values[0]});
 8868:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
 8869:     my %ValuesHash;
 8870:     my $NumSets=1;
 8871:     foreach my $array (@Values) {
 8872:         next if (! ref($array));
 8873:         $ValuesHash{$id.'.data.'.$NumSets++} = 
 8874:             join(',',@$array);
 8875:     }
 8876:     #
 8877:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
 8878:     if ($NumBars < 3) {
 8879:         $width = 120+$NumBars*32;
 8880:         $xskip = 1;
 8881:         $bar_width = 30;
 8882:     } elsif ($NumBars < 5) {
 8883:         $width = 120+$NumBars*20;
 8884:         $xskip = 1;
 8885:         $bar_width = 20;
 8886:     } elsif ($NumBars < 10) {
 8887:         $width = 120+$NumBars*15;
 8888:         $xskip = 1;
 8889:         $bar_width = 15;
 8890:     } elsif ($NumBars <= 25) {
 8891:         $width = 120+$NumBars*11;
 8892:         $xskip = 5;
 8893:         $bar_width = 8;
 8894:     } elsif ($NumBars <= 50) {
 8895:         $width = 120+$NumBars*8;
 8896:         $xskip = 5;
 8897:         $bar_width = 4;
 8898:     } else {
 8899:         $width = 120+$NumBars*8;
 8900:         $xskip = 5;
 8901:         $bar_width = 4;
 8902:     }
 8903:     #
 8904:     $Max = 1 if ($Max < 1);
 8905:     if ( int($Max) < $Max ) {
 8906:         $Max++;
 8907:         $Max = int($Max);
 8908:     }
 8909:     $Title  = '' if (! defined($Title));
 8910:     $xlabel = '' if (! defined($xlabel));
 8911:     $ylabel = '' if (! defined($ylabel));
 8912:     $ValuesHash{$id.'.title'}    = &escape($Title);
 8913:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
 8914:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
 8915:     $ValuesHash{$id.'.y_max_value'} = $Max;
 8916:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
 8917:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
 8918:     $ValuesHash{$id.'.PlotType'} = 'bar';
 8919:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
 8920:     $ValuesHash{$id.'.height'}   = $height;
 8921:     $ValuesHash{$id.'.width'}    = $width;
 8922:     $ValuesHash{$id.'.xskip'}    = $xskip;
 8923:     $ValuesHash{$id.'.bar_width'} = $bar_width;
 8924:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
 8925:     #
 8926:     # Deal with other parameters
 8927:     while (my ($key,$value) = each(%$extra_settings)) {
 8928:         $ValuesHash{$id.'.'.$key} = $value;
 8929:     }
 8930:     #
 8931:     &Apache::lonnet::appenv(\%ValuesHash);
 8932:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 8933: }
 8934: 
 8935: ############################################################
 8936: ############################################################
 8937: 
 8938: =pod
 8939: 
 8940: =item * &DrawXYGraph()
 8941: 
 8942: Facilitates the plotting of data in an XY graph.
 8943: Puts plot definition data into the users environment in order for 
 8944: graph.png to plot it.  Returns an <img> tag for the plot.
 8945: 
 8946: Inputs:
 8947: 
 8948: =over 4
 8949: 
 8950: =item $Title: string, the title of the plot
 8951: 
 8952: =item $xlabel: string, text describing the X-axis of the plot
 8953: 
 8954: =item $ylabel: string, text describing the Y-axis of the plot
 8955: 
 8956: =item $Max: scalar, the maximum Y value to use in the plot
 8957: If $Max is < any data point, the graph will not be rendered.
 8958: 
 8959: =item $colors: Array ref containing the hex color codes for the data to be 
 8960: plotted in.  If undefined, default values will be used.
 8961: 
 8962: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
 8963: 
 8964: =item $Ydata: Array ref containing Array refs.  
 8965: Each of the contained arrays will be plotted as a separate curve.
 8966: 
 8967: =item %Values: hash indicating or overriding any default values which are 
 8968: passed to graph.png.  
 8969: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
 8970: 
 8971: =back
 8972: 
 8973: Returns:
 8974: 
 8975: An <img> tag which references graph.png and the appropriate identifying
 8976: information for the plot.
 8977: 
 8978: =cut
 8979: 
 8980: ############################################################
 8981: ############################################################
 8982: sub DrawXYGraph {
 8983:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
 8984:     #
 8985:     # Create the identifier for the graph
 8986:     my $identifier = &get_cgi_id();
 8987:     my $id = 'cgi.'.$identifier;
 8988:     #
 8989:     $Title  = '' if (! defined($Title));
 8990:     $xlabel = '' if (! defined($xlabel));
 8991:     $ylabel = '' if (! defined($ylabel));
 8992:     my %ValuesHash = 
 8993:         (
 8994:          $id.'.title'  => &escape($Title),
 8995:          $id.'.xlabel' => &escape($xlabel),
 8996:          $id.'.ylabel' => &escape($ylabel),
 8997:          $id.'.y_max_value'=> $Max,
 8998:          $id.'.labels'     => join(',',@$Xlabels),
 8999:          $id.'.PlotType'   => 'XY',
 9000:          );
 9001:     #
 9002:     if (defined($colors) && ref($colors) eq 'ARRAY') {
 9003:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
 9004:     }
 9005:     #
 9006:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
 9007:         return '';
 9008:     }
 9009:     my $NumSets=1;
 9010:     foreach my $array (@{$Ydata}){
 9011:         next if (! ref($array));
 9012:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
 9013:     }
 9014:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
 9015:     #
 9016:     # Deal with other parameters
 9017:     while (my ($key,$value) = each(%Values)) {
 9018:         $ValuesHash{$id.'.'.$key} = $value;
 9019:     }
 9020:     #
 9021:     &Apache::lonnet::appenv(\%ValuesHash);
 9022:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 9023: }
 9024: 
 9025: ############################################################
 9026: ############################################################
 9027: 
 9028: =pod
 9029: 
 9030: =item * &DrawXYYGraph()
 9031: 
 9032: Facilitates the plotting of data in an XY graph with two Y axes.
 9033: Puts plot definition data into the users environment in order for 
 9034: graph.png to plot it.  Returns an <img> tag for the plot.
 9035: 
 9036: Inputs:
 9037: 
 9038: =over 4
 9039: 
 9040: =item $Title: string, the title of the plot
 9041: 
 9042: =item $xlabel: string, text describing the X-axis of the plot
 9043: 
 9044: =item $ylabel: string, text describing the Y-axis of the plot
 9045: 
 9046: =item $colors: Array ref containing the hex color codes for the data to be 
 9047: plotted in.  If undefined, default values will be used.
 9048: 
 9049: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
 9050: 
 9051: =item $Ydata1: The first data set
 9052: 
 9053: =item $Min1: The minimum value of the left Y-axis
 9054: 
 9055: =item $Max1: The maximum value of the left Y-axis
 9056: 
 9057: =item $Ydata2: The second data set
 9058: 
 9059: =item $Min2: The minimum value of the right Y-axis
 9060: 
 9061: =item $Max2: The maximum value of the left Y-axis
 9062: 
 9063: =item %Values: hash indicating or overriding any default values which are 
 9064: passed to graph.png.  
 9065: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
 9066: 
 9067: =back
 9068: 
 9069: Returns:
 9070: 
 9071: An <img> tag which references graph.png and the appropriate identifying
 9072: information for the plot.
 9073: 
 9074: =cut
 9075: 
 9076: ############################################################
 9077: ############################################################
 9078: sub DrawXYYGraph {
 9079:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
 9080:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
 9081:     #
 9082:     # Create the identifier for the graph
 9083:     my $identifier = &get_cgi_id();
 9084:     my $id = 'cgi.'.$identifier;
 9085:     #
 9086:     $Title  = '' if (! defined($Title));
 9087:     $xlabel = '' if (! defined($xlabel));
 9088:     $ylabel = '' if (! defined($ylabel));
 9089:     my %ValuesHash = 
 9090:         (
 9091:          $id.'.title'  => &escape($Title),
 9092:          $id.'.xlabel' => &escape($xlabel),
 9093:          $id.'.ylabel' => &escape($ylabel),
 9094:          $id.'.labels' => join(',',@$Xlabels),
 9095:          $id.'.PlotType' => 'XY',
 9096:          $id.'.NumSets' => 2,
 9097:          $id.'.two_axes' => 1,
 9098:          $id.'.y1_max_value' => $Max1,
 9099:          $id.'.y1_min_value' => $Min1,
 9100:          $id.'.y2_max_value' => $Max2,
 9101:          $id.'.y2_min_value' => $Min2,
 9102:          );
 9103:     #
 9104:     if (defined($colors) && ref($colors) eq 'ARRAY') {
 9105:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
 9106:     }
 9107:     #
 9108:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
 9109:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
 9110:         return '';
 9111:     }
 9112:     my $NumSets=1;
 9113:     foreach my $array ($Ydata1,$Ydata2){
 9114:         next if (! ref($array));
 9115:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
 9116:     }
 9117:     #
 9118:     # Deal with other parameters
 9119:     while (my ($key,$value) = each(%Values)) {
 9120:         $ValuesHash{$id.'.'.$key} = $value;
 9121:     }
 9122:     #
 9123:     &Apache::lonnet::appenv(\%ValuesHash);
 9124:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
 9125: }
 9126: 
 9127: ############################################################
 9128: ############################################################
 9129: 
 9130: =pod
 9131: 
 9132: =back 
 9133: 
 9134: =head1 Statistics helper routines?  
 9135: 
 9136: Bad place for them but what the hell.
 9137: 
 9138: =over 4
 9139: 
 9140: =item * &chartlink()
 9141: 
 9142: Returns a link to the chart for a specific student.  
 9143: 
 9144: Inputs:
 9145: 
 9146: =over 4
 9147: 
 9148: =item $linktext: The text of the link
 9149: 
 9150: =item $sname: The students username
 9151: 
 9152: =item $sdomain: The students domain
 9153: 
 9154: =back
 9155: 
 9156: =back
 9157: 
 9158: =cut
 9159: 
 9160: ############################################################
 9161: ############################################################
 9162: sub chartlink {
 9163:     my ($linktext, $sname, $sdomain) = @_;
 9164:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
 9165:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
 9166:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
 9167:        '">'.$linktext.'</a>';
 9168: }
 9169: 
 9170: #######################################################
 9171: #######################################################
 9172: 
 9173: =pod
 9174: 
 9175: =head1 Course Environment Routines
 9176: 
 9177: =over 4
 9178: 
 9179: =item * &restore_course_settings()
 9180: 
 9181: =item * &store_course_settings()
 9182: 
 9183: Restores/Store indicated form parameters from the course environment.
 9184: Will not overwrite existing values of the form parameters.
 9185: 
 9186: Inputs: 
 9187: a scalar describing the data (e.g. 'chart', 'problem_analysis')
 9188: 
 9189: a hash ref describing the data to be stored.  For example:
 9190:    
 9191: %Save_Parameters = ('Status' => 'scalar',
 9192:     'chartoutputmode' => 'scalar',
 9193:     'chartoutputdata' => 'scalar',
 9194:     'Section' => 'array',
 9195:     'Group' => 'array',
 9196:     'StudentData' => 'array',
 9197:     'Maps' => 'array');
 9198: 
 9199: Returns: both routines return nothing
 9200: 
 9201: =back
 9202: 
 9203: =cut
 9204: 
 9205: #######################################################
 9206: #######################################################
 9207: sub store_course_settings {
 9208:     return &store_settings($env{'request.course.id'},@_);
 9209: }
 9210: 
 9211: sub store_settings {
 9212:     # save to the environment
 9213:     # appenv the same items, just to be safe
 9214:     my $udom  = $env{'user.domain'};
 9215:     my $uname = $env{'user.name'};
 9216:     my ($context,$prefix,$Settings) = @_;
 9217:     my %SaveHash;
 9218:     my %AppHash;
 9219:     while (my ($setting,$type) = each(%$Settings)) {
 9220:         my $basename = join('.','internal',$context,$prefix,$setting);
 9221:         my $envname = 'environment.'.$basename;
 9222:         if (exists($env{'form.'.$setting})) {
 9223:             # Save this value away
 9224:             if ($type eq 'scalar' &&
 9225:                 (! exists($env{$envname}) || 
 9226:                  $env{$envname} ne $env{'form.'.$setting})) {
 9227:                 $SaveHash{$basename} = $env{'form.'.$setting};
 9228:                 $AppHash{$envname}   = $env{'form.'.$setting};
 9229:             } elsif ($type eq 'array') {
 9230:                 my $stored_form;
 9231:                 if (ref($env{'form.'.$setting})) {
 9232:                     $stored_form = join(',',
 9233:                                         map {
 9234:                                             &escape($_);
 9235:                                         } sort(@{$env{'form.'.$setting}}));
 9236:                 } else {
 9237:                     $stored_form = 
 9238:                         &escape($env{'form.'.$setting});
 9239:                 }
 9240:                 # Determine if the array contents are the same.
 9241:                 if ($stored_form ne $env{$envname}) {
 9242:                     $SaveHash{$basename} = $stored_form;
 9243:                     $AppHash{$envname}   = $stored_form;
 9244:                 }
 9245:             }
 9246:         }
 9247:     }
 9248:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
 9249:                                           $udom,$uname);
 9250:     if ($put_result !~ /^(ok|delayed)/) {
 9251:         &Apache::lonnet::logthis('unable to save form parameters, '.
 9252:                                  'got error:'.$put_result);
 9253:     }
 9254:     # Make sure these settings stick around in this session, too
 9255:     &Apache::lonnet::appenv(\%AppHash);
 9256:     return;
 9257: }
 9258: 
 9259: sub restore_course_settings {
 9260:     return &restore_settings($env{'request.course.id'},@_);
 9261: }
 9262: 
 9263: sub restore_settings {
 9264:     my ($context,$prefix,$Settings) = @_;
 9265:     while (my ($setting,$type) = each(%$Settings)) {
 9266:         next if (exists($env{'form.'.$setting}));
 9267:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
 9268:             '.'.$setting;
 9269:         if (exists($env{$envname})) {
 9270:             if ($type eq 'scalar') {
 9271:                 $env{'form.'.$setting} = $env{$envname};
 9272:             } elsif ($type eq 'array') {
 9273:                 $env{'form.'.$setting} = [ 
 9274:                                            map { 
 9275:                                                &unescape($_); 
 9276:                                            } split(',',$env{$envname})
 9277:                                            ];
 9278:             }
 9279:         }
 9280:     }
 9281: }
 9282: 
 9283: #######################################################
 9284: #######################################################
 9285: 
 9286: =pod
 9287: 
 9288: =head1 Domain E-mail Routines  
 9289: 
 9290: =over 4
 9291: 
 9292: =item * &build_recipient_list()
 9293: 
 9294: Build recipient lists for four types of e-mail:
 9295: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
 9296: (d) Help requests, generated by
 9297: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
 9298: 
 9299: Inputs:
 9300: defmail (scalar - email address of default recipient), 
 9301: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
 9302: defdom (domain for which to retrieve configuration settings),
 9303: origmail (scalar - email address of recipient from loncapa.conf, 
 9304: i.e., predates configuration by DC via domainprefs.pm 
 9305: 
 9306: Returns: comma separated list of addresses to which to send e-mail.
 9307: 
 9308: =back
 9309: 
 9310: =cut
 9311: 
 9312: ############################################################
 9313: ############################################################
 9314: sub build_recipient_list {
 9315:     my ($defmail,$mailing,$defdom,$origmail) = @_;
 9316:     my @recipients;
 9317:     my $otheremails;
 9318:     my %domconfig =
 9319:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
 9320:     if (ref($domconfig{'contacts'}) eq 'HASH') {
 9321:         if (exists($domconfig{'contacts'}{$mailing})) {
 9322:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
 9323:                 my @contacts = ('adminemail','supportemail');
 9324:                 foreach my $item (@contacts) {
 9325:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
 9326:                         my $addr = $domconfig{'contacts'}{$item}; 
 9327:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
 9328:                             push(@recipients,$addr);
 9329:                         }
 9330:                     }
 9331:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
 9332:                 }
 9333:             }
 9334:         } elsif ($origmail ne '') {
 9335:             push(@recipients,$origmail);
 9336:         }
 9337:     } elsif ($origmail ne '') {
 9338:         push(@recipients,$origmail);
 9339:     }
 9340:     if (defined($defmail)) {
 9341:         if ($defmail ne '') {
 9342:             push(@recipients,$defmail);
 9343:         }
 9344:     }
 9345:     if ($otheremails) {
 9346:         my @others;
 9347:         if ($otheremails =~ /,/) {
 9348:             @others = split(/,/,$otheremails);
 9349:         } else {
 9350:             push(@others,$otheremails);
 9351:         }
 9352:         foreach my $addr (@others) {
 9353:             if (!grep(/^\Q$addr\E$/,@recipients)) {
 9354:                 push(@recipients,$addr);
 9355:             }
 9356:         }
 9357:     }
 9358:     my $recipientlist = join(',',@recipients); 
 9359:     return $recipientlist;
 9360: }
 9361: 
 9362: ############################################################
 9363: ############################################################
 9364: 
 9365: =pod
 9366: 
 9367: =head1 Course Catalog Routines
 9368: 
 9369: =over 4
 9370: 
 9371: =item * &gather_categories()
 9372: 
 9373: Converts category definitions - keys of categories hash stored in  
 9374: coursecategories in configuration.db on the primary library server in a 
 9375: domain - to an array.  Also generates javascript and idx hash used to 
 9376: generate Domain Coordinator interface for editing Course Categories.
 9377: 
 9378: Inputs:
 9379: 
 9380: categories (reference to hash of category definitions).
 9381: 
 9382: cats (reference to array of arrays/hashes which encapsulates hierarchy of
 9383:       categories and subcategories).
 9384: 
 9385: idx (reference to hash of counters used in Domain Coordinator interface for 
 9386:       editing Course Categories).
 9387: 
 9388: jsarray (reference to array of categories used to create Javascript arrays for
 9389:          Domain Coordinator interface for editing Course Categories).
 9390: 
 9391: Returns: nothing
 9392: 
 9393: Side effects: populates cats, idx and jsarray. 
 9394: 
 9395: =cut
 9396: 
 9397: sub gather_categories {
 9398:     my ($categories,$cats,$idx,$jsarray) = @_;
 9399:     my %counters;
 9400:     my $num = 0;
 9401:     foreach my $item (keys(%{$categories})) {
 9402:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
 9403:         if ($container eq '' && $depth == 0) {
 9404:             $cats->[$depth][$categories->{$item}] = $cat;
 9405:         } else {
 9406:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
 9407:         }
 9408:         my ($escitem,$tail) = split(/:/,$item,2);
 9409:         if ($counters{$tail} eq '') {
 9410:             $counters{$tail} = $num;
 9411:             $num ++;
 9412:         }
 9413:         if (ref($idx) eq 'HASH') {
 9414:             $idx->{$item} = $counters{$tail};
 9415:         }
 9416:         if (ref($jsarray) eq 'ARRAY') {
 9417:             push(@{$jsarray->[$counters{$tail}]},$item);
 9418:         }
 9419:     }
 9420:     return;
 9421: }
 9422: 
 9423: =pod
 9424: 
 9425: =item * &extract_categories()
 9426: 
 9427: Used to generate breadcrumb trails for course categories.
 9428: 
 9429: Inputs:
 9430: 
 9431: categories (reference to hash of category definitions).
 9432: 
 9433: cats (reference to array of arrays/hashes which encapsulates hierarchy of
 9434:       categories and subcategories).
 9435: 
 9436: trails (reference to array of breacrumb trails for each category).
 9437: 
 9438: allitems (reference to hash - key is category key 
 9439:          (format: escaped(name):escaped(parent category):depth in hierarchy).
 9440: 
 9441: idx (reference to hash of counters used in Domain Coordinator interface for
 9442:       editing Course Categories).
 9443: 
 9444: jsarray (reference to array of categories used to create Javascript arrays for
 9445:          Domain Coordinator interface for editing Course Categories).
 9446: 
 9447: subcats (reference to hash of arrays containing all subcategories within each 
 9448:          category, -recursive)
 9449: 
 9450: Returns: nothing
 9451: 
 9452: Side effects: populates trails and allitems hash references.
 9453: 
 9454: =cut
 9455: 
 9456: sub extract_categories {
 9457:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
 9458:     if (ref($categories) eq 'HASH') {
 9459:         &gather_categories($categories,$cats,$idx,$jsarray);
 9460:         if (ref($cats->[0]) eq 'ARRAY') {
 9461:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
 9462:                 my $name = $cats->[0][$i];
 9463:                 my $item = &escape($name).'::0';
 9464:                 my $trailstr;
 9465:                 if ($name eq 'instcode') {
 9466:                     $trailstr = &mt('Official courses (with institutional codes)');
 9467:                 } else {
 9468:                     $trailstr = $name;
 9469:                 }
 9470:                 if ($allitems->{$item} eq '') {
 9471:                     push(@{$trails},$trailstr);
 9472:                     $allitems->{$item} = scalar(@{$trails})-1;
 9473:                 }
 9474:                 my @parents = ($name);
 9475:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
 9476:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
 9477:                         my $category = $cats->[1]{$name}[$j];
 9478:                         if (ref($subcats) eq 'HASH') {
 9479:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
 9480:                         }
 9481:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
 9482:                     }
 9483:                 } else {
 9484:                     if (ref($subcats) eq 'HASH') {
 9485:                         $subcats->{$item} = [];
 9486:                     }
 9487:                 }
 9488:             }
 9489:         }
 9490:     }
 9491:     return;
 9492: }
 9493: 
 9494: =pod
 9495: 
 9496: =item *&recurse_categories()
 9497: 
 9498: Recursively used to generate breadcrumb trails for course categories.
 9499: 
 9500: Inputs:
 9501: 
 9502: cats (reference to array of arrays/hashes which encapsulates hierarchy of
 9503:       categories and subcategories).
 9504: 
 9505: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
 9506: 
 9507: category (current course category, for which breadcrumb trail is being generated).
 9508: 
 9509: trails (reference to array of breadcrumb trails for each category).
 9510: 
 9511: allitems (reference to hash - key is category key
 9512:          (format: escaped(name):escaped(parent category):depth in hierarchy).
 9513: 
 9514: parents (array containing containers directories for current category, 
 9515:          back to top level). 
 9516: 
 9517: Returns: nothing
 9518: 
 9519: Side effects: populates trails and allitems hash references
 9520: 
 9521: =cut
 9522: 
 9523: sub recurse_categories {
 9524:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
 9525:     my $shallower = $depth - 1;
 9526:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
 9527:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
 9528:             my $name = $cats->[$depth]{$category}[$k];
 9529:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
 9530:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
 9531:             if ($allitems->{$item} eq '') {
 9532:                 push(@{$trails},$trailstr);
 9533:                 $allitems->{$item} = scalar(@{$trails})-1;
 9534:             }
 9535:             my $deeper = $depth+1;
 9536:             push(@{$parents},$category);
 9537:             if (ref($subcats) eq 'HASH') {
 9538:                 my $subcat = &escape($name).':'.$category.':'.$depth;
 9539:                 for (my $j=@{$parents}; $j>=0; $j--) {
 9540:                     my $higher;
 9541:                     if ($j > 0) {
 9542:                         $higher = &escape($parents->[$j]).':'.
 9543:                                   &escape($parents->[$j-1]).':'.$j;
 9544:                     } else {
 9545:                         $higher = &escape($parents->[$j]).'::'.$j;
 9546:                     }
 9547:                     push(@{$subcats->{$higher}},$subcat);
 9548:                 }
 9549:             }
 9550:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
 9551:                                 $subcats);
 9552:             pop(@{$parents});
 9553:         }
 9554:     } else {
 9555:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
 9556:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
 9557:         if ($allitems->{$item} eq '') {
 9558:             push(@{$trails},$trailstr);
 9559:             $allitems->{$item} = scalar(@{$trails})-1;
 9560:         }
 9561:     }
 9562:     return;
 9563: }
 9564: 
 9565: =pod
 9566: 
 9567: =item *&assign_categories_table()
 9568: 
 9569: Create a datatable for display of hierarchical categories in a domain,
 9570: with checkboxes to allow a course to be categorized. 
 9571: 
 9572: Inputs:
 9573: 
 9574: cathash - reference to hash of categories defined for the domain (from
 9575:           configuration.db)
 9576: 
 9577: currcat - scalar with an & separated list of categories assigned to a course. 
 9578: 
 9579: Returns: $output (markup to be displayed) 
 9580: 
 9581: =cut
 9582: 
 9583: sub assign_categories_table {
 9584:     my ($cathash,$currcat) = @_;
 9585:     my $output;
 9586:     if (ref($cathash) eq 'HASH') {
 9587:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
 9588:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
 9589:         $maxdepth = scalar(@cats);
 9590:         if (@cats > 0) {
 9591:             my $itemcount = 0;
 9592:             if (ref($cats[0]) eq 'ARRAY') {
 9593:                 $output = &Apache::loncommon::start_data_table();
 9594:                 my @currcategories;
 9595:                 if ($currcat ne '') {
 9596:                     @currcategories = split('&',$currcat);
 9597:                 }
 9598:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
 9599:                     my $parent = $cats[0][$i];
 9600:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
 9601:                     next if ($parent eq 'instcode');
 9602:                     my $item = &escape($parent).'::0';
 9603:                     my $checked = '';
 9604:                     if (@currcategories > 0) {
 9605:                         if (grep(/^\Q$item\E$/,@currcategories)) {
 9606:                             $checked = ' checked="checked"';
 9607:                         }
 9608:                     }
 9609:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
 9610:                                '<input type="checkbox" name="usecategory" value="'.
 9611:                                $item.'"'.$checked.' />'.$parent.'</span>'.
 9612:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
 9613:                     my $depth = 1;
 9614:                     push(@path,$parent);
 9615:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
 9616:                     pop(@path);
 9617:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
 9618:                     $itemcount ++;
 9619:                 }
 9620:                 $output .= &Apache::loncommon::end_data_table();
 9621:             }
 9622:         }
 9623:     }
 9624:     return $output;
 9625: }
 9626: 
 9627: =pod
 9628: 
 9629: =item *&assign_category_rows()
 9630: 
 9631: Create a datatable row for display of nested categories in a domain,
 9632: with checkboxes to allow a course to be categorized,called recursively.
 9633: 
 9634: Inputs:
 9635: 
 9636: itemcount - track row number for alternating colors
 9637: 
 9638: cats - reference to array of arrays/hashes which encapsulates hierarchy of
 9639:       categories and subcategories.
 9640: 
 9641: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
 9642: 
 9643: parent - parent of current category item
 9644: 
 9645: path - Array containing all categories back up through the hierarchy from the
 9646:        current category to the top level.
 9647: 
 9648: currcategories - reference to array of current categories assigned to the course
 9649: 
 9650: Returns: $output (markup to be displayed).
 9651: 
 9652: =cut
 9653: 
 9654: sub assign_category_rows {
 9655:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
 9656:     my ($text,$name,$item,$chgstr);
 9657:     if (ref($cats) eq 'ARRAY') {
 9658:         my $maxdepth = scalar(@{$cats});
 9659:         if (ref($cats->[$depth]) eq 'HASH') {
 9660:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
 9661:                 my $numchildren = @{$cats->[$depth]{$parent}};
 9662:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
 9663:                 $text .= '<td><table class="LC_datatable">';
 9664:                 for (my $j=0; $j<$numchildren; $j++) {
 9665:                     $name = $cats->[$depth]{$parent}[$j];
 9666:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
 9667:                     my $deeper = $depth+1;
 9668:                     my $checked = '';
 9669:                     if (ref($currcategories) eq 'ARRAY') {
 9670:                         if (@{$currcategories} > 0) {
 9671:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
 9672:                                 $checked = ' checked="checked"';
 9673:                             }
 9674:                         }
 9675:                     }
 9676:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
 9677:                              '<input type="checkbox" name="usecategory" value="'.
 9678:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
 9679:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
 9680:                              '</td><td>';
 9681:                     if (ref($path) eq 'ARRAY') {
 9682:                         push(@{$path},$name);
 9683:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
 9684:                         pop(@{$path});
 9685:                     }
 9686:                     $text .= '</td></tr>';
 9687:                 }
 9688:                 $text .= '</table></td>';
 9689:             }
 9690:         }
 9691:     }
 9692:     return $text;
 9693: }
 9694: 
 9695: ############################################################
 9696: ############################################################
 9697: 
 9698: 
 9699: sub commit_customrole {
 9700:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
 9701:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
 9702:                          ($start?', '.&mt('starting').' '.localtime($start):'').
 9703:                          ($end?', ending '.localtime($end):'').': <b>'.
 9704:               &Apache::lonnet::assigncustomrole(
 9705:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
 9706:                  '</b><br />';
 9707:     return $output;
 9708: }
 9709: 
 9710: sub commit_standardrole {
 9711:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
 9712:     my ($output,$logmsg,$linefeed);
 9713:     if ($context eq 'auto') {
 9714:         $linefeed = "\n";
 9715:     } else {
 9716:         $linefeed = "<br />\n";
 9717:     }  
 9718:     if ($three eq 'st') {
 9719:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
 9720:                                          $one,$two,$sec,$context);
 9721:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
 9722:             ($result eq 'unknown_course') || ($result eq 'refused')) {
 9723:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
 9724:         } else {
 9725:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
 9726:                ($start?', '.&mt('starting').' '.localtime($start):'').
 9727:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
 9728:             if ($context eq 'auto') {
 9729:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
 9730:             } else {
 9731:                $output .= '<b>'.$result.'</b>'.$linefeed.
 9732:                &mt('Add to classlist').': <b>ok</b>';
 9733:             }
 9734:             $output .= $linefeed;
 9735:         }
 9736:     } else {
 9737:         $output = &mt('Assigning').' '.$three.' in '.$url.
 9738:                ($start?', '.&mt('starting').' '.localtime($start):'').
 9739:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
 9740:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
 9741:         if ($context eq 'auto') {
 9742:             $output .= $result.$linefeed;
 9743:         } else {
 9744:             $output .= '<b>'.$result.'</b>'.$linefeed;
 9745:         }
 9746:     }
 9747:     return $output;
 9748: }
 9749: 
 9750: sub commit_studentrole {
 9751:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
 9752:     my ($result,$linefeed,$oldsecurl,$newsecurl);
 9753:     if ($context eq 'auto') {
 9754:         $linefeed = "\n";
 9755:     } else {
 9756:         $linefeed = '<br />'."\n";
 9757:     }
 9758:     if (defined($one) && defined($two)) {
 9759:         my $cid=$one.'_'.$two;
 9760:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
 9761:         my $secchange = 0;
 9762:         my $expire_role_result;
 9763:         my $modify_section_result;
 9764:         if ($oldsec ne '-1') { 
 9765:             if ($oldsec ne $sec) {
 9766:                 $secchange = 1;
 9767:                 my $now = time;
 9768:                 my $uurl='/'.$cid;
 9769:                 $uurl=~s/\_/\//g;
 9770:                 if ($oldsec) {
 9771:                     $uurl.='/'.$oldsec;
 9772:                 }
 9773:                 $oldsecurl = $uurl;
 9774:                 $expire_role_result = 
 9775:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
 9776:                 if ($env{'request.course.sec'} ne '') { 
 9777:                     if ($expire_role_result eq 'refused') {
 9778:                         my @roles = ('st');
 9779:                         my @statuses = ('previous');
 9780:                         my @roledoms = ($one);
 9781:                         my $withsec = 1;
 9782:                         my %roleshash = 
 9783:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
 9784:                                               \@statuses,\@roles,\@roledoms,$withsec);
 9785:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
 9786:                             my ($oldstart,$oldend) = 
 9787:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
 9788:                             if ($oldend > 0 && $oldend <= $now) {
 9789:                                 $expire_role_result = 'ok';
 9790:                             }
 9791:                         }
 9792:                     }
 9793:                 }
 9794:                 $result = $expire_role_result;
 9795:             }
 9796:         }
 9797:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
 9798:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
 9799:             if ($modify_section_result =~ /^ok/) {
 9800:                 if ($secchange == 1) {
 9801:                     if ($sec eq '') {
 9802:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
 9803:                     } else {
 9804:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
 9805:                     }
 9806:                 } elsif ($oldsec eq '-1') {
 9807:                     if ($sec eq '') {
 9808:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
 9809:                     } else {
 9810:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
 9811:                     }
 9812:                 } else {
 9813:                     if ($sec eq '') {
 9814:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
 9815:                     } else {
 9816:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
 9817:                     }
 9818:                 }
 9819:             } else {
 9820:                 if ($secchange) {       
 9821:                     $$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;
 9822:                 } else {
 9823:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
 9824:                 }
 9825:             }
 9826:             $result = $modify_section_result;
 9827:         } elsif ($secchange == 1) {
 9828:             if ($oldsec eq '') {
 9829:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
 9830:             } else {
 9831:                 $$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;
 9832:             }
 9833:             if ($expire_role_result eq 'refused') {
 9834:                 my $newsecurl = '/'.$cid;
 9835:                 $newsecurl =~ s/\_/\//g;
 9836:                 if ($sec ne '') {
 9837:                     $newsecurl.='/'.$sec;
 9838:                 }
 9839:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
 9840:                     if ($sec eq '') {
 9841:                         $$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;
 9842:                     } else {
 9843:                         $$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;
 9844:                     }
 9845:                 }
 9846:             }
 9847:         }
 9848:     } else {
 9849:         $$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;
 9850:         $result = "error: incomplete course id\n";
 9851:     }
 9852:     return $result;
 9853: }
 9854: 
 9855: ############################################################
 9856: ############################################################
 9857: 
 9858: sub check_clone {
 9859:     my ($args,$linefeed) = @_;
 9860:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
 9861:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
 9862:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
 9863:     my $clonemsg;
 9864:     my $can_clone = 0;
 9865: 
 9866:     if ($clonehome eq 'no_host') {
 9867:         $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'});     
 9868:     } else {
 9869: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
 9870: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
 9871: 	    $can_clone = 1;
 9872: 	} else {
 9873: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
 9874: 						 $args->{'clonedomain'},$args->{'clonecourse'});
 9875: 	    my @cloners = split(/,/,$clonehash{'cloners'});
 9876:             if (grep(/^\*$/,@cloners)) {
 9877:                 $can_clone = 1;
 9878:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
 9879:                 $can_clone = 1;
 9880:             } else {
 9881: 	        my %roleshash =
 9882: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
 9883: 					 $args->{'ccdomain'},
 9884:                                          'userroles',['active'],['cc'],
 9885: 					 [$args->{'clonedomain'}]);
 9886: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
 9887: 		    $can_clone = 1;
 9888: 	        } else {
 9889:                     $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'});
 9890: 	        }
 9891: 	    }
 9892:         }
 9893:     }
 9894:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
 9895: }
 9896: 
 9897: sub construct_course {
 9898:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
 9899:     my $outcome;
 9900:     my $linefeed =  '<br />'."\n";
 9901:     if ($context eq 'auto') {
 9902:         $linefeed = "\n";
 9903:     }
 9904: 
 9905: #
 9906: # Are we cloning?
 9907: #
 9908:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
 9909:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
 9910: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
 9911: 	if ($context ne 'auto') {
 9912:             if ($clonemsg ne '') {
 9913: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
 9914:             }
 9915: 	}
 9916: 	$outcome .= $clonemsg.$linefeed;
 9917: 
 9918:         if (!$can_clone) {
 9919: 	    return (0,$outcome);
 9920: 	}
 9921:     }
 9922: 
 9923: #
 9924: # Open course
 9925: #
 9926:     my $crstype = lc($args->{'crstype'});
 9927:     my %cenv=();
 9928:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
 9929:                                              $args->{'cdescr'},
 9930:                                              $args->{'curl'},
 9931:                                              $args->{'course_home'},
 9932:                                              $args->{'nonstandard'},
 9933:                                              $args->{'crscode'},
 9934:                                              $args->{'ccuname'}.':'.
 9935:                                              $args->{'ccdomain'},
 9936:                                              $args->{'crstype'});
 9937: 
 9938:     # Note: The testing routines depend on this being output; see 
 9939:     # Utils::Course. This needs to at least be output as a comment
 9940:     # if anyone ever decides to not show this, and Utils::Course::new
 9941:     # will need to be suitably modified.
 9942:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
 9943: #
 9944: # Check if created correctly
 9945: #
 9946:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
 9947:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
 9948:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
 9949: 
 9950: #
 9951: # Do the cloning
 9952: #   
 9953:     if ($can_clone && $cloneid) {
 9954: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
 9955: 	if ($context ne 'auto') {
 9956: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
 9957: 	}
 9958: 	$outcome .= $clonemsg.$linefeed;
 9959: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
 9960: # Copy all files
 9961: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
 9962: # Restore URL
 9963: 	$cenv{'url'}=$oldcenv{'url'};
 9964: # Restore title
 9965: 	$cenv{'description'}=$oldcenv{'description'};
 9966: # Mark as cloned
 9967: 	$cenv{'clonedfrom'}=$cloneid;
 9968: # Need to clone grading mode
 9969:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
 9970:         $cenv{'grading'}=$newenv{'grading'};
 9971: # Do not clone these environment entries
 9972:         &Apache::lonnet::del('environment',
 9973:                   ['default_enrollment_start_date',
 9974:                    'default_enrollment_end_date',
 9975:                    'question.email',
 9976:                    'policy.email',
 9977:                    'comment.email',
 9978:                    'pch.users.denied',
 9979:                    'plc.users.denied',
 9980:                    'hidefromcat',
 9981:                    'categories'],
 9982:                    $$crsudom,$$crsunum);
 9983:     }
 9984: 
 9985: #
 9986: # Set environment (will override cloned, if existing)
 9987: #
 9988:     my @sections = ();
 9989:     my @xlists = ();
 9990:     if ($args->{'crstype'}) {
 9991:         $cenv{'type'}=$args->{'crstype'};
 9992:     }
 9993:     if ($args->{'crsid'}) {
 9994:         $cenv{'courseid'}=$args->{'crsid'};
 9995:     }
 9996:     if ($args->{'crscode'}) {
 9997:         $cenv{'internal.coursecode'}=$args->{'crscode'};
 9998:     }
 9999:     if ($args->{'crsquota'} ne '') {
10000:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
10001:     } else {
10002:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
10003:     }
10004:     if ($args->{'ccuname'}) {
10005:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
10006:                                         ':'.$args->{'ccdomain'};
10007:     } else {
10008:         $cenv{'internal.courseowner'} = $args->{'curruser'};
10009:     }
10010:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
10011:     if ($args->{'crssections'}) {
10012:         $cenv{'internal.sectionnums'} = '';
10013:         if ($args->{'crssections'} =~ m/,/) {
10014:             @sections = split/,/,$args->{'crssections'};
10015:         } else {
10016:             $sections[0] = $args->{'crssections'};
10017:         }
10018:         if (@sections > 0) {
10019:             foreach my $item (@sections) {
10020:                 my ($sec,$gp) = split/:/,$item;
10021:                 my $class = $args->{'crscode'}.$sec;
10022:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
10023:                 $cenv{'internal.sectionnums'} .= $item.',';
10024:                 unless ($addcheck eq 'ok') {
10025:                     push @badclasses, $class;
10026:                 }
10027:             }
10028:             $cenv{'internal.sectionnums'} =~ s/,$//;
10029:         }
10030:     }
10031: # do not hide course coordinator from staff listing, 
10032: # even if privileged
10033:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10034: # add crosslistings
10035:     if ($args->{'crsxlist'}) {
10036:         $cenv{'internal.crosslistings'}='';
10037:         if ($args->{'crsxlist'} =~ m/,/) {
10038:             @xlists = split/,/,$args->{'crsxlist'};
10039:         } else {
10040:             $xlists[0] = $args->{'crsxlist'};
10041:         }
10042:         if (@xlists > 0) {
10043:             foreach my $item (@xlists) {
10044:                 my ($xl,$gp) = split/:/,$item;
10045:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
10046:                 $cenv{'internal.crosslistings'} .= $item.',';
10047:                 unless ($addcheck eq 'ok') {
10048:                     push @badclasses, $xl;
10049:                 }
10050:             }
10051:             $cenv{'internal.crosslistings'} =~ s/,$//;
10052:         }
10053:     }
10054:     if ($args->{'autoadds'}) {
10055:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
10056:     }
10057:     if ($args->{'autodrops'}) {
10058:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
10059:     }
10060: # check for notification of enrollment changes
10061:     my @notified = ();
10062:     if ($args->{'notify_owner'}) {
10063:         if ($args->{'ccuname'} ne '') {
10064:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
10065:         }
10066:     }
10067:     if ($args->{'notify_dc'}) {
10068:         if ($uname ne '') { 
10069:             push(@notified,$uname.':'.$udom);
10070:         }
10071:     }
10072:     if (@notified > 0) {
10073:         my $notifylist;
10074:         if (@notified > 1) {
10075:             $notifylist = join(',',@notified);
10076:         } else {
10077:             $notifylist = $notified[0];
10078:         }
10079:         $cenv{'internal.notifylist'} = $notifylist;
10080:     }
10081:     if (@badclasses > 0) {
10082:         my %lt=&Apache::lonlocal::texthash(
10083:                 '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',
10084:                 'dnhr' => 'does not have rights to access enrollment in these classes',
10085:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
10086:         );
10087:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
10088:                            ' ('.$lt{'adby'}.')';
10089:         if ($context eq 'auto') {
10090:             $outcome .= $badclass_msg.$linefeed;
10091:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
10092:             foreach my $item (@badclasses) {
10093:                 if ($context eq 'auto') {
10094:                     $outcome .= " - $item\n";
10095:                 } else {
10096:                     $outcome .= "<li>$item</li>\n";
10097:                 }
10098:             }
10099:             if ($context eq 'auto') {
10100:                 $outcome .= $linefeed;
10101:             } else {
10102:                 $outcome .= "</ul><br /><br /></div>\n";
10103:             }
10104:         } 
10105:     }
10106:     if ($args->{'no_end_date'}) {
10107:         $args->{'endaccess'} = 0;
10108:     }
10109:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
10110:     $cenv{'internal.autoend'}=$args->{'enrollend'};
10111:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
10112:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
10113:     if ($args->{'showphotos'}) {
10114:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
10115:     }
10116:     $cenv{'internal.authtype'} = $args->{'authtype'};
10117:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
10118:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
10119:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
10120:             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'); 
10121:             if ($context eq 'auto') {
10122:                 $outcome .= $krb_msg;
10123:             } else {
10124:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
10125:             }
10126:             $outcome .= $linefeed;
10127:         }
10128:     }
10129:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
10130:        if ($args->{'setpolicy'}) {
10131:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10132:        }
10133:        if ($args->{'setcontent'}) {
10134:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
10135:        }
10136:     }
10137:     if ($args->{'reshome'}) {
10138: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
10139: 	$cenv{'reshome'}=~s/\/+$/\//;
10140:     }
10141: #
10142: # course has keyed access
10143: #
10144:     if ($args->{'setkeys'}) {
10145:        $cenv{'keyaccess'}='yes';
10146:     }
10147: # if specified, key authority is not course, but user
10148: # only active if keyaccess is yes
10149:     if ($args->{'keyauth'}) {
10150: 	my ($user,$domain) = split(':',$args->{'keyauth'});
10151: 	$user = &LONCAPA::clean_username($user);
10152: 	$domain = &LONCAPA::clean_username($domain);
10153: 	if ($user ne '' && $domain ne '') {
10154: 	    $cenv{'keyauth'}=$user.':'.$domain;
10155: 	}
10156:     }
10157: 
10158:     if ($args->{'disresdis'}) {
10159:         $cenv{'pch.roles.denied'}='st';
10160:     }
10161:     if ($args->{'disablechat'}) {
10162:         $cenv{'plc.roles.denied'}='st';
10163:     }
10164: 
10165:     # Record we've not yet viewed the Course Initialization Helper for this 
10166:     # course
10167:     $cenv{'course.helper.not.run'} = 1;
10168:     #
10169:     # Use new Randomseed
10170:     #
10171:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
10172:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
10173:     #
10174:     # The encryption code and receipt prefix for this course
10175:     #
10176:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
10177:     $cenv{'internal.encpref'}=100+int(9*rand(99));
10178:     #
10179:     # By default, use standard grading
10180:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
10181: 
10182:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
10183:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
10184: #
10185: # Open all assignments
10186: #
10187:     if ($args->{'openall'}) {
10188:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
10189:        my %storecontent = ($storeunder         => time,
10190:                            $storeunder.'.type' => 'date_start');
10191:        
10192:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
10193:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
10194:    }
10195: #
10196: # Set first page
10197: #
10198:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
10199: 	    || ($cloneid)) {
10200: 	use LONCAPA::map;
10201: 	$outcome .= &mt('Setting first resource').': ';
10202: 
10203: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
10204:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
10205: 
10206:         $outcome .= ($fatal?$errtext:'read ok').' - ';
10207:         my $title; my $url;
10208:         if ($args->{'firstres'} eq 'syl') {
10209: 	    $title=&mt('Syllabus');
10210:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
10211:         } else {
10212:             $title=&mt('Navigate Contents');
10213:             $url='/adm/navmaps';
10214:         }
10215: 
10216:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
10217: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
10218: 
10219: 	if ($errtext) { $fatal=2; }
10220:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
10221:     }
10222: 
10223:     return (1,$outcome);
10224: }
10225: 
10226: ############################################################
10227: ############################################################
10228: 
10229: sub course_type {
10230:     my ($cid) = @_;
10231:     if (!defined($cid)) {
10232:         $cid = $env{'request.course.id'};
10233:     }
10234:     if (defined($env{'course.'.$cid.'.type'})) {
10235:         return $env{'course.'.$cid.'.type'};
10236:     } else {
10237:         return 'Course';
10238:     }
10239: }
10240: 
10241: sub group_term {
10242:     my $crstype = &course_type();
10243:     my %names = (
10244:                   'Course' => 'group',
10245:                   'Group' => 'team',
10246:                 );
10247:     return $names{$crstype};
10248: }
10249: 
10250: sub icon {
10251:     my ($file)=@_;
10252:     my $curfext = lc((split(/\./,$file))[-1]);
10253:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
10254:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
10255:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
10256: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
10257: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10258: 	            $curfext.".gif") {
10259: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
10260: 		$curfext.".gif";
10261: 	}
10262:     }
10263:     return &lonhttpdurl($iconname);
10264: } 
10265: 
10266: sub lonhttpdurl {
10267: #
10268: # Had been used for "small fry" static images on separate port 8080.
10269: # Modify here if lightweight http functionality desired again.
10270: # Currently eliminated due to increasing firewall issues.
10271: #
10272:     my ($url)=@_;
10273:     return $url;
10274: }
10275: 
10276: sub connection_aborted {
10277:     my ($r)=@_;
10278:     $r->print(" ");$r->rflush();
10279:     my $c = $r->connection;
10280:     return $c->aborted();
10281: }
10282: 
10283: #    Escapes strings that may have embedded 's that will be put into
10284: #    strings as 'strings'.
10285: sub escape_single {
10286:     my ($input) = @_;
10287:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
10288:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
10289:     return $input;
10290: }
10291: 
10292: #  Same as escape_single, but escape's "'s  This 
10293: #  can be used for  "strings"
10294: sub escape_double {
10295:     my ($input) = @_;
10296:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
10297:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
10298:     return $input;
10299: }
10300:  
10301: #   Escapes the last element of a full URL.
10302: sub escape_url {
10303:     my ($url)   = @_;
10304:     my @urlslices = split(/\//, $url,-1);
10305:     my $lastitem = &escape(pop(@urlslices));
10306:     return join('/',@urlslices).'/'.$lastitem;
10307: }
10308: 
10309: sub compare_arrays {
10310:     my ($arrayref1,$arrayref2) = @_;
10311:     my (@difference,%count);
10312:     @difference = ();
10313:     %count = ();
10314:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
10315:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
10316:         foreach my $element (keys(%count)) {
10317:             if ($count{$element} == 1) {
10318:                 push(@difference,$element);
10319:             }
10320:         }
10321:     }
10322:     return @difference;
10323: }
10324: 
10325: # -------------------------------------------------------- Initialize user login
10326: sub init_user_environment {
10327:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
10328:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
10329: 
10330:     my $public=($username eq 'public' && $domain eq 'public');
10331: 
10332: # See if old ID present, if so, remove
10333: 
10334:     my ($filename,$cookie,$userroles);
10335:     my $now=time;
10336: 
10337:     if ($public) {
10338: 	my $max_public=100;
10339: 	my $oldest;
10340: 	my $oldest_time=0;
10341: 	for(my $next=1;$next<=$max_public;$next++) {
10342: 	    if (-e $lonids."/publicuser_$next.id") {
10343: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
10344: 		if ($mtime<$oldest_time || !$oldest_time) {
10345: 		    $oldest_time=$mtime;
10346: 		    $oldest=$next;
10347: 		}
10348: 	    } else {
10349: 		$cookie="publicuser_$next";
10350: 		last;
10351: 	    }
10352: 	}
10353: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
10354:     } else {
10355: 	# if this isn't a robot, kill any existing non-robot sessions
10356: 	if (!$args->{'robot'}) {
10357: 	    opendir(DIR,$lonids);
10358: 	    while ($filename=readdir(DIR)) {
10359: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
10360: 		    unlink($lonids.'/'.$filename);
10361: 		}
10362: 	    }
10363: 	    closedir(DIR);
10364: 	}
10365: # Give them a new cookie
10366: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
10367: 		                   : $now.$$.int(rand(10000)));
10368: 	$cookie="$username\_$id\_$domain\_$authhost";
10369:     
10370: # Initialize roles
10371: 
10372: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
10373:     }
10374: # ------------------------------------ Check browser type and MathML capability
10375: 
10376:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
10377:         $clientunicode,$clientos) = &decode_user_agent($r);
10378: 
10379: # ------------------------------------------------------------- Get environment
10380: 
10381:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
10382:     my ($tmp) = keys(%userenv);
10383:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
10384: 	# default remote control to off
10385: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
10386:     } else {
10387: 	undef(%userenv);
10388:     }
10389:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
10390: 	$form->{'interface'}=$userenv{'interface'};
10391:     }
10392:     $env{'environment.remote'}=$userenv{'remote'};
10393:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
10394: 
10395: # --------------- Do not trust query string to be put directly into environment
10396:     foreach my $option ('interface','localpath','localres') {
10397:         $form->{$option}=~s/[\n\r\=]//gs;
10398:     }
10399: # --------------------------------------------------------- Write first profile
10400: 
10401:     {
10402: 	my %initial_env = 
10403: 	    ("user.name"          => $username,
10404: 	     "user.domain"        => $domain,
10405: 	     "user.home"          => $authhost,
10406: 	     "browser.type"       => $clientbrowser,
10407: 	     "browser.version"    => $clientversion,
10408: 	     "browser.mathml"     => $clientmathml,
10409: 	     "browser.unicode"    => $clientunicode,
10410: 	     "browser.os"         => $clientos,
10411: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
10412: 	     "request.course.fn"  => '',
10413: 	     "request.course.uri" => '',
10414: 	     "request.course.sec" => '',
10415: 	     "request.role"       => 'cm',
10416: 	     "request.role.adv"   => $env{'user.adv'},
10417: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
10418: 
10419:         if ($form->{'localpath'}) {
10420: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
10421: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
10422:         }
10423: 	
10424: 	if ($public) {
10425: 	    $initial_env{"environment.remote"} = "off";
10426: 	}
10427: 	if ($form->{'interface'}) {
10428: 	    $form->{'interface'}=~s/\W//gs;
10429: 	    $initial_env{"browser.interface"} = $form->{'interface'};
10430: 	    $env{'browser.interface'}=$form->{'interface'};
10431: 	}
10432: 
10433:         foreach my $tool ('aboutme','blog','portfolio') {
10434:             $userenv{'availabletools.'.$tool} = 
10435:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10436:         }
10437: 
10438:         foreach my $crstype ('official','unofficial') {
10439:             $userenv{'canrequest.'.$crstype} =
10440:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
10441:                                                   'reload','requestcourses');
10442:         }
10443: 
10444: 	$env{'user.environment'} = "$lonids/$cookie.id";
10445: 	
10446: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10447: 		 &GDBM_WRCREAT(),0640)) {
10448: 	    &_add_to_env(\%disk_env,\%initial_env);
10449: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
10450: 	    &_add_to_env(\%disk_env,$userroles);
10451: 	    if (ref($args->{'extra_env'})) {
10452: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
10453: 	    }
10454: 	    untie(%disk_env);
10455: 	} else {
10456: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10457: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
10458: 	    return 'error: '.$!;
10459: 	}
10460:     }
10461:     $env{'request.role'}='cm';
10462:     $env{'request.role.adv'}=$env{'user.adv'};
10463:     $env{'browser.type'}=$clientbrowser;
10464: 
10465:     return $cookie;
10466: 
10467: }
10468: 
10469: sub _add_to_env {
10470:     my ($idf,$env_data,$prefix) = @_;
10471:     if (ref($env_data) eq 'HASH') {
10472:         while (my ($key,$value) = each(%$env_data)) {
10473: 	    $idf->{$prefix.$key} = $value;
10474: 	    $env{$prefix.$key}   = $value;
10475:         }
10476:     }
10477: }
10478: 
10479: # --- Get the symbolic name of a problem and the url
10480: sub get_symb {
10481:     my ($request,$silent) = @_;
10482:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
10483:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10484:     if ($symb eq '') {
10485:         if (!$silent) {
10486:             $request->print("Unable to handle ambiguous references:$url:.");
10487:             return ();
10488:         }
10489:     }
10490:     &Apache::lonenc::check_decrypt(\$symb);
10491:     return ($symb);
10492: }
10493: 
10494: # --------------------------------------------------------------Get annotation
10495: 
10496: sub get_annotation {
10497:     my ($symb,$enc) = @_;
10498: 
10499:     my $key = $symb;
10500:     if (!$enc) {
10501:         $key =
10502:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10503:     }
10504:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10505:     return $annotation{$key};
10506: }
10507: 
10508: sub clean_symb {
10509:     my ($symb,$delete_enc) = @_;
10510: 
10511:     &Apache::lonenc::check_decrypt(\$symb);
10512:     my $enc = $env{'request.enc'};
10513:     if ($delete_enc) {
10514:         delete($env{'request.enc'});
10515:     }
10516: 
10517:     return ($symb,$enc);
10518: }
10519: 
10520: =pod
10521: 
10522: =back
10523: 
10524: =cut
10525: 
10526: 1;
10527: __END__;
10528: 

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